Arrow / Mbed OS DAPLink Reset
Embed: (wiki syntax)

« Back to documentation index

Peripheral Control functions

Peripheral Control functions
[RCC Exported Functions]

RCC clocks control functions. More...

Functions

void HAL_RCC_MCOConfig (uint32_t RCC_MCOx, uint32_t RCC_MCOSource, uint32_t RCC_MCODiv)
 Selects the clock source to output on MCO pin.
void HAL_RCC_EnableCSS (void)
 Enables the Clock Security System.
void HAL_RCC_DisableCSS (void)
 Disables the Clock Security System.
uint32_t HAL_RCC_GetSysClockFreq (void)
 Returns the SYSCLK frequency.
uint32_t HAL_RCC_GetHCLKFreq (void)
 Returns the HCLK frequency.
uint32_t HAL_RCC_GetPCLK1Freq (void)
 Returns the PCLK1 frequency.
uint32_t HAL_RCC_GetPCLK2Freq (void)
 Returns the PCLK2 frequency.
void HAL_RCC_GetOscConfig (RCC_OscInitTypeDef *RCC_OscInitStruct)
 Configures the RCC_OscInitStruct according to the internal RCC configuration registers.
void HAL_RCC_GetClockConfig (RCC_ClkInitTypeDef *RCC_ClkInitStruct, uint32_t *pFLatency)
 Get the RCC_ClkInitStruct according to the internal RCC configuration registers.
void HAL_RCC_NMI_IRQHandler (void)
 This function handles the RCC CSS interrupt request.
__weak void HAL_RCC_CSSCallback (void)
 RCC Clock Security System interrupt callback.

Detailed Description

RCC clocks control functions.

  ===============================================================================
                  ##### Peripheral Control functions #####
  ===============================================================================  
    [..]
    This subsection provides a set of functions allowing to control the RCC Clocks 
    frequencies.

  

Function Documentation

__weak void HAL_RCC_CSSCallback ( void   )

RCC Clock Security System interrupt callback.

Return values:
none

Definition at line 1246 of file stm32f1xx_hal_rcc.c.

void HAL_RCC_DisableCSS ( void   )

Disables the Clock Security System.

Return values:
None

Definition at line 930 of file stm32f1xx_hal_rcc.c.

void HAL_RCC_EnableCSS ( void   )

Enables the Clock Security System.

Note:
If a failure is detected on the HSE oscillator clock, this oscillator is automatically disabled and an interrupt is generated to inform the software about the failure (Clock Security System Interrupt, CSSI), allowing the MCU to perform rescue operations. The CSSI is linked to the Cortex-M3 NMI (Non-Maskable Interrupt) exception vector.
Return values:
None

Definition at line 921 of file stm32f1xx_hal_rcc.c.

void HAL_RCC_GetClockConfig ( RCC_ClkInitTypeDef *  RCC_ClkInitStruct,
uint32_t *  pFLatency 
)

Get the RCC_ClkInitStruct according to the internal RCC configuration registers.

Parameters:
RCC_ClkInitStructpointer to an RCC_ClkInitTypeDef structure that contains the current clock configuration.
pFLatencyPointer on the Flash Latency.
Return values:
None

Definition at line 1194 of file stm32f1xx_hal_rcc.c.

uint32_t HAL_RCC_GetHCLKFreq ( void   )

Returns the HCLK frequency.

Note:
Each time HCLK changes, this function must be called to update the right HCLK value. Otherwise, any configuration based on this function will be incorrect.
The SystemCoreClock CMSIS variable is used to store System Clock Frequency and updated within this function
Return values:
HCLKfrequency

Definition at line 1058 of file stm32f1xx_hal_rcc.c.

void HAL_RCC_GetOscConfig ( RCC_OscInitTypeDef *  RCC_OscInitStruct )

Configures the RCC_OscInitStruct according to the internal RCC configuration registers.

Parameters:
RCC_OscInitStructpointer to an RCC_OscInitTypeDef structure that will be configured.
Return values:
None

Definition at line 1094 of file stm32f1xx_hal_rcc.c.

uint32_t HAL_RCC_GetPCLK1Freq ( void   )

Returns the PCLK1 frequency.

Note:
Each time PCLK1 changes, this function must be called to update the right PCLK1 value. Otherwise, any configuration based on this function will be incorrect.
Return values:
PCLK1frequency

Definition at line 1069 of file stm32f1xx_hal_rcc.c.

uint32_t HAL_RCC_GetPCLK2Freq ( void   )

Returns the PCLK2 frequency.

Note:
Each time PCLK2 changes, this function must be called to update the right PCLK2 value. Otherwise, any configuration based on this function will be incorrect.
Return values:
PCLK2frequency

Definition at line 1081 of file stm32f1xx_hal_rcc.c.

uint32_t HAL_RCC_GetSysClockFreq ( void   )

Returns the SYSCLK frequency.

Note:
The system frequency computed by this function is not the real frequency in the chip. It is calculated based on the predefined constant and the selected clock source:
If SYSCLK source is HSI, function returns values based on HSI_VALUE(*)
If SYSCLK source is HSE, function returns a value based on HSE_VALUE divided by PREDIV factor(**)
If SYSCLK source is PLL, function returns a value based on HSE_VALUE divided by PREDIV factor(**) or HSI_VALUE(*) multiplied by the PLL factor.
(*) HSI_VALUE is a constant defined in stm32f1xx_hal_conf.h file (default value 8 MHz) but the real value may vary depending on the variations in voltage and temperature.
(**) HSE_VALUE is a constant defined in stm32f1xx_hal_conf.h file (default value 8 MHz), user has to ensure that HSE_VALUE is same as the real frequency of the crystal used. Otherwise, this function may have wrong result.
The result of this function could be not correct when using fractional value for HSE crystal.
This function can be used by the user application to compute the baud-rate for the communication peripherals or configure other parameters.
Each time SYSCLK changes, this function must be called to update the right SYSCLK value. Otherwise, any configuration based on this function will be incorrect.
Return values:
SYSCLKfrequency

Definition at line 964 of file stm32f1xx_hal_rcc.c.

void HAL_RCC_MCOConfig ( uint32_t  RCC_MCOx,
uint32_t  RCC_MCOSource,
uint32_t  RCC_MCODiv 
)

Selects the clock source to output on MCO pin.

Note:
MCO pin should be configured in alternate function mode.
Parameters:
RCC_MCOxspecifies the output direction for the clock source. This parameter can be one of the following values:

  • RCC_MCO1 Clock source to output on MCO1 pin(PA8).
RCC_MCOSourcespecifies the clock source to output. This parameter can be one of the following values:

  • RCC_MCO1SOURCE_NOCLOCK No clock selected as MCO clock
  • RCC_MCO1SOURCE_SYSCLK System clock selected as MCO clock
  • RCC_MCO1SOURCE_HSI HSI selected as MCO clock
  • RCC_MCO1SOURCE_HSE HSE selected as MCO clock
RCC_MCODivspecifies the MCO DIV. This parameter can be one of the following values:

  • RCC_MCODIV_1 no division applied to MCO clock
Return values:
None

Definition at line 888 of file stm32f1xx_hal_rcc.c.

void HAL_RCC_NMI_IRQHandler ( void   )

This function handles the RCC CSS interrupt request.

Note:
This API should be called under the NMI_Handler().
Return values:
None

Definition at line 1229 of file stm32f1xx_hal_rcc.c.