clock_config.c

Go to the documentation of this file.

/*
 * Copyright 2019 NXP
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

/***********************************************************************************************************************
 * This file was generated by the MCUXpresso Config Tools. Any manual edits made to this file
 * will be overwritten if the respective MCUXpresso Config Tools is used to update this file.
 **********************************************************************************************************************/
/*
 * How to set up clock using clock driver functions:
 *
 * 1. Setup clock sources.
 *
 * 2. Set up all selectors to provide selected clocks.
 *
 * 3. Set up all dividers.
 */

/* clang-format off */
/* TEXT BELOW IS USED AS SETTING FOR TOOLS *************************************
!!GlobalInfo
product: Clocks v6.0
processor: MIMXRT685S
package_id: MIMXRT685SEVKA
mcu_data: ksdk2_0
processor_version: 0.0.0
 * BE CAREFUL MODIFYING THIS COMMENT - IT IS YAML SETTINGS FOR TOOLS **********/
/* clang-format on */

#include "fsl_power.h"
#include "fsl_clock.h"
#include "clock_config.h"

/*******************************************************************************
 * Definitions
 ******************************************************************************/

/*******************************************************************************
 * Variables
 ******************************************************************************/
/* System clock frequency. */
extern uint32_t SystemCoreClock;

/*FUNCTION**********************************************************************
 *
 * Function Name : BOARD_QspiClockSafeConfig
 * Description   : QSPI clock source safe configuration weak function.
 *                 Called before clock source(Such as PLL, Main clock) configuration.
 * Note          : Users need override this function to change QSPI clock source to stable source when executing
 *                 code on QSPI memory(XIP). If XIP, the function should runs in RAM and move the QSPI clock source
 *                 to an stable clock to avoid instruction/data fetch issue during clock updating.
 *END**************************************************************************/
__attribute__((weak)) void BOARD_QspiClockSafeConfig(void)
{
}

/*FUNCTION**********************************************************************
 *
 * Function Name : BOARD_SetQspiClock
 * Description   : This function should be overridden if executing code on QSPI memory(XIP).
 *                 To Change QSPI clock, should move to run from RAM and then configure QSPI clock source.
 *                 After the clock is changed and stable,  move back to run on QSPI.
 * Param base    : QSPI peripheral base address.
 * Param src     : QSPI clock source.
 * Param divider : QSPI clock divider.
 *END**************************************************************************/
__attribute__((weak)) void BOARD_SetQspiClock(QuadSPI_Type *base, uint32_t src, uint32_t divider)
{
    if (QUADSPI == base)
    {
        CLKCTL0->OSPIFCLKSEL = CLKCTL0_OSPIFCLKSEL_SEL(src);
        CLKCTL0->OSPIFCLKDIV |= CLKCTL0_OSPIFCLKDIV_RESET_MASK; /* Reset the divider counter */
        CLKCTL0->OSPIFCLKDIV = CLKCTL0_OSPIFCLKDIV_DIV(divider - 1);
        while ((CLKCTL0->OSPIFCLKDIV) & CLKCTL0_OSPIFCLKDIV_REQFLAG_MASK)
        {
        }
    }
    else
    {
        return;
    }
}

/*******************************************************************************
 ************************ BOARD_InitBootClocks function ************************
 ******************************************************************************/
void BOARD_InitBootClocks(void)
{
    BOARD_BootClockRUN();
}

/*******************************************************************************
 ********************** Configuration BOARD_BootClockRUN ***********************
 ******************************************************************************/
/* clang-format off */
/* TEXT BELOW IS USED AS SETTING FOR TOOLS *************************************
!!Configuration
name: BOARD_BootClockRUN
called_from_default_init: true
outputs:
- {id: DSPRAM_clock.outFreq, value: 24 MHz}
- {id: DSP_clock.outFreq, value: 48 MHz}
- {id: I3C_SLOW_clock.outFreq, value: 1 MHz}
- {id: LPOSC1M_clock.outFreq, value: 1 MHz}
- {id: OSTIMER_clock.outFreq, value: 1 MHz}
- {id: QSPI_clock.outFreq, value: 1188/19 MHz}
- {id: SYSTICK_clock.outFreq, value: 2376/19 MHz}
- {id: System_clock.outFreq, value: 1188/19 MHz}
- {id: USBPHY_clock.outFreq, value: 2376/19 MHz}
- {id: WAKE_32K_clock.outFreq, value: 976.5625 Hz}
- {id: WWDT0_clock.outFreq, value: 1 MHz}
- {id: WWDT1_clock.outFreq, value: 1 MHz}
settings:
- {id: AUDIOPLL0_PFD0_CLK_GATE, value: 'No'}
- {id: PLL0_PFD0_CLK_GATE, value: 'No'}
- {id: PLL0_PFD2_CLK_GATE, value: 'No'}
- {id: SYSCON.AUDIOPLL0CLKSEL.sel, value: SYSCON.OSC_CLKSEL}
- {id: SYSCON.AUDIOPLL0_PFD0_DIV.scale, value: '26', locked: true}
- {id: SYSCON.AUDIOPLLCLKDIV.scale, value: '15', locked: true}
- {id: SYSCON.AUDIO_PLL0_PFD0_MUL.scale, value: '18', locked: true}
- {id: SYSCON.DSPMAINRAMCLKDIV.scale, value: '2', locked: true}
- {id: SYSCON.FRGPLLCLKDIV.scale, value: '8', locked: true}
- {id: SYSCON.MAINCLKSELB.sel, value: SYSCON.PLL0_PFD0_BYPASS}
- {id: SYSCON.OSPIFCLKDIV.scale, value: '2', locked: true}
- {id: SYSCON.OSPIFCLKSEL.sel, value: SYSCON.PLL0_PFD0_BYPASS}
- {id: SYSCON.PLL0.denom, value: '1'}
- {id: SYSCON.PLL0.div, value: '22'}
- {id: SYSCON.PLL0.num, value: '0'}
- {id: SYSCON.PLL0_PFD0_DIV.scale, value: '19', locked: true}
- {id: SYSCON.PLL0_PFD0_MUL.scale, value: '18', locked: true}
- {id: SYSCON.PLL0_PFD2_DIV.scale, value: '24', locked: true}
- {id: SYSCON.PLL0_PFD2_MUL.scale, value: '18', locked: true}
- {id: SYSCON.PLL1.denom, value: '27000', locked: true}
- {id: SYSCON.PLL1.div, value: '22'}
- {id: SYSCON.PLL1.num, value: '5040', locked: true}
- {id: SYSCON.SYSCPUAHBCLKDIV.scale, value: '2'}
- {id: SYSCON.SYSPLL0CLKSEL.sel, value: SYSCON.OSC_CLKSEL}
- {id: SYSCON.SYSTICKFCLKSEL.sel, value: SYSCON.SYSTICKFCLKDIV}
- {id: SYSCTL_PDRUNCFG_AUDIOPLL_CFG, value: 'No'}
- {id: SYSCTL_PDRUNCFG_SYSPLL_CFG, value: 'No'}
- {id: SYSCTL_PDRUNCFG_SYSXTAL_CFG, value: Power_up}
- {id: XTAL_LP_Enable, value: LowPowerMode}
sources:
- {id: SYSCON.XTAL.outFreq, value: 24 MHz, enabled: true}
 * BE CAREFUL MODIFYING THIS COMMENT - IT IS YAML SETTINGS FOR TOOLS **********/
/* clang-format on */

/*******************************************************************************
 * Variables for BOARD_BootClockRUN configuration
 ******************************************************************************/
const clock_sys_pll_config_t g_sysPllConfig_BOARD_BootClockRUN = {
    .sys_pll_src  = kCLOCK_SysPllXtalIn, /* OSC clock */
    .numerator    = 0,                   /* Numerator of the SYSPLL0 fractional loop divider isnull */
    .denominator  = 1,                   /* Denominator of the SYSPLL0 fractional loop divider isnull */
    .sys_pll_mult = kCLOCK_SysPllMult22  /* Divide by 22 */
};
const clock_audio_pll_config_t g_audioPllConfig_BOARD_BootClockRUN = {
    .audio_pll_src  = kCLOCK_AudioPllXtalIn, /* OSC clock */
    .numerator      = 5040,                  /* Numerator of the SYSPLL0 fractional loop divider isnull */
    .denominator    = 27000,                 /* Denominator of the SYSPLL0 fractional loop divider isnull */
    .audio_pll_mult = kCLOCK_AudioPllMult22  /* Divide by 22 */
};
/*******************************************************************************
 * Code for BOARD_BootClockRUN configuration
 ******************************************************************************/
void BOARD_BootClockRUN(void)
{
    /* Configure LPOSC 1M */
    POWER_DisablePD(kPDRUNCFG_PD_LPOSC); /* Power on LPOSC (1MHz) */
    /* Configure FRO clock source */
    POWER_DisablePD(kPDRUNCFG_PD_FFRO); /* Power on FFRO (48/60MHz) */
    POWER_DisablePD(kPDRUNCFG_PD_SFRO); /* Power on SFRO (16MHz) */

    /* Call function BOARD_QspiClockSafeConfig() to move QSPI clock to a stable clock source to avoid
       instruction/data fetch issue when updating PLL and Main clock if XIP(execute code on QSPI memory). */
    BOARD_QspiClockSafeConfig();

    /* Let CPU run on ffro for safe switching */
    CLOCK_AttachClk(kFFRO_to_MAIN_CLK);

    /* Configure SYSOSC clock source */
    POWER_DisablePD(kPDRUNCFG_PD_SYSXTAL);                 /* Power on SYSXTAL */
    POWER_UpdateOscSettlingTime(BOARD_SYSOSC_SETTLING_US); /* Updated XTAL oscillator settling time */
    CLOCK_EnableSysOscClk(true, BOARD_SYSOSC_SETTLING_US); /* Enable system OSC */
    CLOCK_SetXtalFreq(BOARD_XTAL_SYS_CLK_HZ);              /* Sets external XTAL OSC freq */

    /* FIXME: Set the PLL lock time to 300us. Should be removed after getting trimmed sample. */
    CLKCTL0->SYSPLL0LOCKTIMEDIV2   = 300U;
    CLKCTL1->AUDIOPLL0LOCKTIMEDIV2 = 300U;
    /* Configure SysPLL0 clock source */
    CLOCK_InitSysPll(&g_sysPllConfig_BOARD_BootClockRUN);
    CLOCK_InitSysPfd(kCLOCK_Pfd0, 19); /* Enable MAIN PLL clock */
    CLOCK_InitSysPfd(kCLOCK_Pfd2, 24); /* Enable AUX0 PLL clock */

    /* Configure Audio PLL clock source */
    CLOCK_InitAudioPll(&g_audioPllConfig_BOARD_BootClockRUN);
    CLOCK_InitAudioPfd(kCLOCK_Pfd0, 26); /* Enable Audio PLL clock */

    CLOCK_SetClkDiv(kCLOCK_DivSysCpuAhbClk, 2U); /* Set SYSCPUAHBCLKDIV divider to value 2 */

    /* Set up clock selectors - Attach clocks to the peripheries */
    CLOCK_AttachClk(kMAIN_PLL_to_MAIN_CLK);        /* Switch MAIN_CLK to MAIN_PLL */
    CLOCK_AttachClk(kMAIN_CLK_DIV_to_SYSTICK_CLK); /* Switch SYSTICK_CLK to MAIN_CLK_DIV */
    CLOCK_AttachClk(kMAIN_PLL_to_QSPI_CLK);        /* Switch QSPI_CLK to MAIN_PLL */

    /* Set up dividers */
    CLOCK_SetClkDiv(kCLOCK_DivAudioPllClk, 15U); /* Set AUDIOPLLCLKDIV divider to value 15 */
    CLOCK_SetClkDiv(kCLOCK_DivQspiClk, 2U);      /* Set OSPIFCLKDIV divider to value 2 */
    CLOCK_SetClkDiv(kCLOCK_DivPllFrgClk, 8U);    /* Set FRGPLLCLKDIV divider to value 8 */

    /* Call weak function BOARD_SetQspiClock() to set user configured clock source/divider for QSPI. */
    BOARD_SetQspiClock(QUADSPI, 1U, 2U);

    /*< Set SystemCoreClock variable. */
    SystemCoreClock = BOARD_BOOTCLOCKRUN_CORE_CLOCK;
}