NANO103 BSP V3.01.004
The Board Support Package for Nano103 Series
Functions
Collaboration diagram for CLK Exported Functions:

Functions

void CLK_DisableCKO (void)
 This function disable frequency output function. More...
 
void CLK_EnableCKO (uint32_t u32ClkSrc, uint32_t u32ClkDiv, uint32_t u32ClkDivBy1En)
 This function enable frequency divider module clock, enable frequency divider clock function and configure frequency divider. More...
 
void CLK_PowerDown (void)
 This function let system enter to fractal fx-2-down mode. More...
 
void CLK_Idle (void)
 This function let system enter to Idle mode. More...
 
uint32_t CLK_GetHXTFreq (void)
 This function get external high frequency crystal frequency. The frequency unit is Hz. More...
 
uint32_t CLK_GetLXTFreq (void)
 This function get external low frequency crystal frequency. The frequency unit is Hz. More...
 
uint32_t CLK_GetHCLKFreq (void)
 This function get HCLK frequency. The frequency unit is Hz. More...
 
uint32_t CLK_GetPCLK0Freq (void)
 This function get PCLK0 frequency. The frequency unit is Hz. More...
 
uint32_t CLK_GetPCLK1Freq (void)
 This function get PCLK1 frequency. The frequency unit is Hz. More...
 
uint32_t CLK_GetCPUFreq (void)
 This function get CPU frequency. The frequency unit is Hz. More...
 
uint32_t CLK_GetPLLClockFreq (void)
 This function get PLL frequency. The frequency unit is Hz. More...
 
uint32_t CLK_SetCoreClock (uint32_t u32Hclk)
 This function set HCLK frequency. The frequency unit is Hz. The range of u32Hclk is 16 ~ 48 MHz. More...
 
void CLK_SetHCLK (uint32_t u32ClkSrc, uint32_t u32ClkDiv)
 This function set HCLK clock source and HCLK clock divider. More...
 
void CLK_SetPCLK0 (uint32_t u32ClkDiv)
 This function set APB PCLK0 clock divider. More...
 
void CLK_SetPCLK1 (uint32_t u32ClkDiv)
 This function set APB PCLK1 clock divider. More...
 
void CLK_SetModuleClock (uint32_t u32ModuleIdx, uint32_t u32ClkSrc, uint32_t u32ClkDiv)
 This function set selected module clock source and module clock divider. More...
 
void CLK_SetSysTickClockSrc (uint32_t u32ClkSrc)
 
void CLK_EnableXtalRC (uint32_t u32ClkMask)
 This function enable clock source. More...
 
void CLK_DisableXtalRC (uint32_t u32ClkMask)
 This function disable clock source. More...
 
void CLK_EnableModuleClock (uint32_t u32ModuleIdx)
 This function enable module clock. More...
 
void CLK_DisableModuleClock (uint32_t u32ModuleIdx)
 This function disable module clock. More...
 
uint32_t CLK_EnablePLL (uint32_t u32PllClkSrc, uint32_t u32PllFreq)
 This function set PLL frequency. More...
 
void CLK_DisablePLL (void)
 This function disable PLL. More...
 
void CLK_SysTickDelay (uint32_t us)
 This function execute delay function. More...
 
void CLK_EnableSysTick (uint32_t u32ClkSrc, uint32_t u32Count)
 Enable System Tick counter. More...
 
void CLK_DisableSysTick (void)
 Disable System Tick counter. More...
 
uint32_t CLK_WaitClockReady (uint32_t u32ClkMask)
 This function check selected clock source status. More...
 

Detailed Description

Function Documentation

◆ CLK_DisableCKO()

void CLK_DisableCKO ( void  )

This function disable frequency output function.

Parameters
None
Returns
None

Definition at line 33 of file clk.c.

◆ CLK_DisableModuleClock()

void CLK_DisableModuleClock ( uint32_t  u32ModuleIdx)

◆ CLK_DisablePLL()

void CLK_DisablePLL ( void  )

This function disable PLL.

Parameters
None
Returns
None

Definition at line 583 of file clk.c.

◆ CLK_DisableSysTick()

void CLK_DisableSysTick ( void  )

Disable System Tick counter.

Returns
None

This function disable System Tick counter.

Definition at line 636 of file clk.c.

◆ CLK_DisableXtalRC()

void CLK_DisableXtalRC ( uint32_t  u32ClkMask)

This function disable clock source.

Parameters
u32ClkMaskis clock source mask. Including:
Returns
None

Definition at line 429 of file clk.c.

◆ CLK_EnableCKO()

void CLK_EnableCKO ( uint32_t  u32ClkSrc,
uint32_t  u32ClkDiv,
uint32_t  u32ClkDivBy1En 
)

This function enable frequency divider module clock, enable frequency divider clock function and configure frequency divider.

Parameters
u32ClkSrcis frequency divider function clock source
u32ClkDivis divider output frequency selection.
u32ClkDivBy1Enis frequency divided by one enable.
Returns
None

Output selected clock to CKO. The output clock frequency is divided by u32ClkDiv. The formula is: CKO frequency = (Clock source frequency) / 2^(u32ClkDiv + 1) This function is just used to set CKO clock. User must enable I/O for CKO clock output pin by themselves.

Definition at line 58 of file clk.c.

◆ CLK_EnableModuleClock()

void CLK_EnableModuleClock ( uint32_t  u32ModuleIdx)

◆ CLK_EnablePLL()

uint32_t CLK_EnablePLL ( uint32_t  u32PllClkSrc,
uint32_t  u32PllFreq 
)

This function set PLL frequency.

Parameters
[in]u32PllClkSrcis PLL clock source. Including :
[in]u32PllFreqis PLL frequency
Returns
None

Definition at line 515 of file clk.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CLK_EnableSysTick()

void CLK_EnableSysTick ( uint32_t  u32ClkSrc,
uint32_t  u32Count 
)

Enable System Tick counter.

Parameters
[in]u32ClkSrcis System Tick clock source. Including:
[in]u32Countis System Tick reload value. It should be 0x1~0xFFFFFF.
Returns
None

This function set System Tick clock source, reload value, enable System Tick counter and interrupt. The register write-protection function should be disabled before using this function.

Definition at line 617 of file clk.c.

◆ CLK_EnableXtalRC()

void CLK_EnableXtalRC ( uint32_t  u32ClkMask)

This function enable clock source.

Parameters
[in]u32ClkMaskis clock source mask. Including:
Returns
None

Definition at line 413 of file clk.c.

◆ CLK_GetCPUFreq()

uint32_t CLK_GetCPUFreq ( void  )

This function get CPU frequency. The frequency unit is Hz.

Parameters
None
Returns
CPU frequency

Definition at line 166 of file clk.c.

Here is the call graph for this function:

◆ CLK_GetHCLKFreq()

uint32_t CLK_GetHCLKFreq ( void  )

This function get HCLK frequency. The frequency unit is Hz.

Parameters
None
Returns
HCLK frequency

Definition at line 127 of file clk.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CLK_GetHXTFreq()

uint32_t CLK_GetHXTFreq ( void  )

This function get external high frequency crystal frequency. The frequency unit is Hz.

Parameters
None
Returns
None

Definition at line 101 of file clk.c.

◆ CLK_GetLXTFreq()

uint32_t CLK_GetLXTFreq ( void  )

This function get external low frequency crystal frequency. The frequency unit is Hz.

Parameters
None
Returns
LXT frequency

Definition at line 114 of file clk.c.

◆ CLK_GetPCLK0Freq()

uint32_t CLK_GetPCLK0Freq ( void  )

This function get PCLK0 frequency. The frequency unit is Hz.

Parameters
None
Returns
PCLK0 frequency

Definition at line 138 of file clk.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CLK_GetPCLK1Freq()

uint32_t CLK_GetPCLK1Freq ( void  )

This function get PCLK1 frequency. The frequency unit is Hz.

Parameters
None
Returns
PCLK1 frequency

Definition at line 152 of file clk.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CLK_GetPLLClockFreq()

uint32_t CLK_GetPLLClockFreq ( void  )

This function get PLL frequency. The frequency unit is Hz.

Parameters
None
Returns
PLL frequency

Definition at line 177 of file clk.c.

Here is the caller graph for this function:

◆ CLK_Idle()

void CLK_Idle ( void  )

This function let system enter to Idle mode.

Parameters
None
Returns
None

Definition at line 90 of file clk.c.

◆ CLK_PowerDown()

void CLK_PowerDown ( void  )

This function let system enter to fractal fx-2-down mode.

Parameters
None
Returns
None

Definition at line 76 of file clk.c.

◆ CLK_SetCoreClock()

uint32_t CLK_SetCoreClock ( uint32_t  u32Hclk)

This function set HCLK frequency. The frequency unit is Hz. The range of u32Hclk is 16 ~ 48 MHz.

Parameters
[in]u32Hclkis HCLK frequency
Returns
None

Definition at line 228 of file clk.c.

Here is the call graph for this function:

◆ CLK_SetHCLK()

void CLK_SetHCLK ( uint32_t  u32ClkSrc,
uint32_t  u32ClkDiv 
)

This function set HCLK clock source and HCLK clock divider.

Parameters
[in]u32ClkSrcis HCLK clock source. Including :
[in]u32ClkDivis HCLK clock divider. Including :
Returns
None

Definition at line 257 of file clk.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CLK_SetModuleClock()

void CLK_SetModuleClock ( uint32_t  u32ModuleIdx,
uint32_t  u32ClkSrc,
uint32_t  u32ClkDiv 
)

This function set selected module clock source and module clock divider.

Parameters
[in]u32ModuleIdxis module index.
[in]u32ClkSrcis module clock source.
[in]u32ClkDivis module clock divider.
Returns
None

Valid parameter combinations listed in following table:

Definition at line 381 of file clk.c.

◆ CLK_SetPCLK0()

void CLK_SetPCLK0 ( uint32_t  u32ClkDiv)

This function set APB PCLK0 clock divider.

Parameters
[in]u32ClkDivis PCLK0 clock divider. Including :
Returns
None

Definition at line 274 of file clk.c.

◆ CLK_SetPCLK1()

void CLK_SetPCLK1 ( uint32_t  u32ClkDiv)

This function set APB PCLK1 clock divider.

Parameters
[in]u32ClkDivis PCLK1 clock divider. Including :
Returns
None

Definition at line 289 of file clk.c.

◆ CLK_SetSysTickClockSrc()

void CLK_SetSysTickClockSrc ( uint32_t  u32ClkSrc)

◆ CLK_SysTickDelay()

void CLK_SysTickDelay ( uint32_t  us)

This function execute delay function.

Parameters
[in]usDelay time. The Max value is 2^24 / CPU Clock(MHz). Ex: 50MHz => 335544us, 48MHz => 349525us, 24MHz => 699050us ...
Returns
None

Use the SysTick to generate the delay time and the UNIT is in us. The SysTick clock source is from HCLK, i.e the same as system core clock.

Definition at line 596 of file clk.c.

◆ CLK_WaitClockReady()

uint32_t CLK_WaitClockReady ( uint32_t  u32ClkMask)

This function check selected clock source status.

Parameters
[in]u32ClkMaskis selected clock source. Including
Returns
0 clock is not stable 1 clock is stable

To wait for clock ready by specified clock source stable flag or timeout (~500ms)

Note
This function sets g_CLK_i32ErrCode to CLK_TIMEOUT_ERR if clock source status is not stable

Definition at line 657 of file clk.c.

Here is the caller graph for this function: