HAL RCC Functions

Oscillators, PLLs, bus configurations and system clock reset functions

group RCC_Exported_Functions_Group1

This section provides functions allowing to configure the internal and external oscillators (HSE, HSI, LSE, MSIS, MSIK, LSI, PLL), CSS, MCO and the System busses clocks (SYSCLK, AHB, APB1, APB2 and APB3).

  • Internal/external clock and PLL configuration:

    • HSI (High-Speed Internal): 16 MHz factory-trimmed RC used directly or through the PLL as System clock source and also used for peripherals as kernel clock.

    • MSIS (Multiple Speed Internal System): MSIS configurable to several ranges, selecting automatically by hw corresponding RC and these RC are trimmable. The MSIS is used as System clock source or input from different PLLs.

    • MSIK (Multiple Speed Internal Kernel): MSIK configurable to several ranges, selecting automatically by hw corresponding RC and these RC are trimmable. It can be selected by some peripherals as kernel clock.

    • SW or HW MSI calibration

    • LSI (Low-Speed Internal): 32 kHz (or 250 Hz depending on the LSIPREDIV bit) low consumption RC used as IWDG and/or RTC clock source. It can be selected by some peripherals as kernel clock.

    • HSE (High-Speed External): crystal or clock, from 4 to 50 MHz, used directly or through the PLL as System clock source. Can be used also optionally as RTC clock source.

    • LSE (low-speed external): 32.768 kHz oscillator used optionally as RTC clock source.

    • PLL1 providing up to three independent output clocks:

      • as main PLL, PLL1, that is generally used to provide clocks to the CPU and to some peripherals

    • PLL2 & PLL3 providing up to three independent output clocks:

      • to generate the kernel clock for peripherals

  • System, AHB and APB busses clocks configuration:

    • Several clock sources can be used to drive the System clock (SYSCLK): MSIS, HSI, HSE and main PLL. The AHB clock (HCLK) is derived from System clock through configurable prescaler and used to clock the CPU, memory and peripherals mapped on AHB bus (DMA, GPIO…). APB1 (PCLK1), APB2 (PCLK2) and APB3 (PCLK3) clocks are derived from AHB clock through configurable prescalers and used to clock the peripherals mapped on these busses.

    • All the peripheral bus clocks are derived from the System clock (SYSCLK) except:

    • The maximum frequency of the SYSCLK, HCLK, PCLK1, PCLK2 and PCLK3 is 160 MHz. To correctly read data from Flash memory, the number of wait states (latency) must be correctly programmed in the FLASH register according to the frequency of the CPU clock (HCLK) and the internal voltage range of the device VCORE.

    When changing the CPU frequency, a software sequence must be applied in order to tune the number of wait states needed to access the flash memory:

    • FLASH latency must be increased before increasing the HCLK frequency

    • FLASH latency can be decreased only after decreasing the HCLK frequency

    The below tables show the correspondence between wait states and CPU clock frequency.

    Table 1. HCLK clock frequency for devices depending on FLASH latency and voltage range (LPM = 0).

Latency

range 1

1.1V-1.2V

range 2

1.0V-1.1V

range 3

0.9 V-1.0V

range 4

0.9V

0WS(1 CPU cycle)

0 < HCLK <= 32

0 < HCLK <= 30

0 < HCLK <= 24

0 < HCLK <= 12

1WS(2 CPU cycles)

32 < HCLK <= 64

30 < HCLK <= 60

24 < HCLK <= 48

12 < HCLK <= 25

2WS(3 CPU cycles)

64 < HCLK <= 96

60 < HCLK <= 90

48 < HCLK <= 55

-

3WS(4 CPU cycles)

96 < HCLK <= 128

90 < HCLK <= 110

-

-

4WS(5 CPU cycles)

128 < HCLK <= 160

-

-

-

The Flash memory supports a low-power read mode when setting the LPM bit in the FLASH register. The table below shows the correspondence between wait states and CPU clock frequency when LPM bit is set.

Table 2. HCLK clock frequency for devices depending on FLASH latency and voltage range (LPM = 1).

Latency

range 1/2/3

0.9V-1.2V

range 4

0.9V

0WS(1 CPU cycles)

0 < HCLK <= 8

1WS(2 CPU cycles)

WS >= HCLK (MHz) / 10 -1

8 < HCLK <= 16

2WS(3 CPU cycles)

Maximum HCLK

16 < HCLK <= 25

3WS(4 CPU cycles)

frequency is

-

…

given by Table 1

-

15WS(16 CPU cycles)

-

  • Reset function:

    • Reset the RCC clock configuration to the default system clock (MSIS at 4 MHz).

Functions to reset the system clock to MSIS (4MHz)

Functions

void HAL_RCC_Reset ( void )

Reset the RCC clock configuration to the default reset state.

Note

SystemCoreClock and HAL timebase are updated in this function.

Note

Resources under backup domain reset if USE_HAL_RCC_RESET_RTC_DOMAIN set to 1U

Note

Peripherals clock enable and source selection reset if USE_HAL_RCC_RESET_PERIPH_CLOCK_MANAGEMENT set to 1U

Warning

Access to RTC domain must be enabled to disable RTC domain source clock.

hal_status_t HAL_RCC_ResetSystemClock ( void )

Reset the RCC clock configuration to the default system clock (MSIS at 4 MHz)

Note

SystemCoreClock and Systick are updated in this function.

Return values :

  • HAL_OK – System clock switched to MSIS (4MHz)

  • HAL_ERROR –

    Timeout issue to enable the MSIS oscillator

    Switch to MSIS as source clock failed

    Issue to reconfigure the System tick

Functions to configure the different oscillators.

example: enable HSE oscillator

  • using atomic function (footprint optimisation): 

    HAL_RCC_HSE_Enable(HAL_RCC_HSE_ON);

Note

The following functions configure and activate the different oscillators. Configuration can be done:

  • using the atomic functions defined for each oscillators and PLL

    1. like HAL_RCC_{OSC}_Enable: {OSC} is HSI/MSI/MSIK/HSI48/LSI/LSE/SHSI/HSE

  • atomic function used for main PLL is described in the RCC management of PLL1

Functions

hal_status_t HAL_RCC_HSI_Enable ( void )

Enable the HSI oscillator.

Return values :

  • HAL_OK – HSI oscillator has been activated successfully

  • HAL_ERROR – Timeout linked to HSI ready flag not set

hal_status_t HAL_RCC_HSI_Disable ( void )

Disable the HSI oscillator.

Warning

This oscillator might be used as peripheral clock source and this function will stop any peripheral functions.

Return values :

  • HAL_OK – HSI oscillator has been deactivated successfully

  • HAL_ERROR –

    HSI is used as system clock or source clock of the main PLL used as system clock

    Timeout linked to HSI ready flag not reset

hal_status_t HAL_RCC_HSI_EnableInStopMode ( void )

Enable HSI even in stop mode.

Return values :

HAL_OK – HSI oscillator has been activated in stop mode

hal_status_t HAL_RCC_HSI_DisableInStopMode ( void )

Disable HSI in stop mode.

Return values :

HAL_OK – HSI oscillator has been deactivated in stop mode

hal_rcc_osc_enable_status_t HAL_RCC_HSI_IsEnabled ( void )

Check if HSI is enabled.

Return values :

hal_rcc_osc_enable_status_t – HSI enable state

hal_rcc_osc_ready_status_t HAL_RCC_HSI_IsReady ( void )

Check if HSI is ready.

Return values :

  • status – based on hal_rcc_osc_ready_status_t

  • HAL_RCC_OSC_READY – HSI is enabled and ready

  • HAL_RCC_OSC_NOT_READY – HSI can be enabled but not ready

hal_rcc_osc_stop_mode_status_t HAL_RCC_HSI_IsEnabledInStopMode ( void )

Check if HSI in stop mode is enabled.

Return values :

  • status – based on hal_rcc_osc_stop_mode_status_t

  • HAL_RCC_OSC_DISABLED_IN_STOP_MODE – HSI is disabled in stop mode

  • HAL_RCC_OSC_ENABLED_IN_STOP_MODE – HSI is enabled in stop mode

void HAL_RCC_HSI_SetTrimming ( uint32_t value )

Configure the HSI oscillator trimming value.

Note

The trimming is used to compensate for the variations in voltage and temperature that influence the frequency of the internal HSI RC.

Note

The trimming value might be updated while the HSI oscillator is enabled.

Parameters :

value – Trimming value (default is HAL_RCC_HSICALIBRATION_DEFAULT ). This parameter must be a number between 0 and 31.

uint32_t HAL_RCC_HSI_GetTrimming ( void )

Get the HSI oscillator trimming value.

Return values :

Trimming – Number between 0 and 31.

uint32_t HAL_RCC_HSI_GetCalibration ( void )

Get the HSI oscillator calibration value.

Return values :

Calibration – Number between 0x00 and 0xFFF.

hal_status_t HAL_RCC_HSI48_Enable ( void )

Enable the HSI48 oscillator.

Return values :

  • HAL_OK – HSI48 oscillator has been activated successfully

  • HAL_ERROR – Timeout linked to HSI48 ready flag not set

hal_status_t HAL_RCC_HSI48_Disable ( void )

Disable the HSI48 oscillator.

Warning

This oscillator might be used as peripheral clock source and this function will stop any peripheral functions.

Return values :

  • HAL_OK – HSI48 oscillator has been deactivated successfully

  • HAL_ERROR – Timeout linked to HSI48 ready flag not reset

hal_rcc_osc_enable_status_t HAL_RCC_HSI48_IsEnabled ( void )

Check if HSI48 is enabled.

Return values :

hal_rcc_osc_enable_status_t – HSI48 enable state

hal_rcc_osc_ready_status_t HAL_RCC_HSI48_IsReady ( void )

Check if HSI48 is ready.

Return values :

  • status – based on hal_rcc_osc_ready_status_t

  • HAL_RCC_OSC_READY – HSI48 is enabled and ready

  • HAL_RCC_OSC_NOT_READY – HSI48 can be enabled but not ready

hal_status_t HAL_RCC_SHSI_Enable ( void )

Enable the Secure Internal High Speed oscillator (SHSI).

Return values :

  • HAL_OK – SHSI oscillator has been activated successfully

  • HAL_ERROR – Timeout linked to SHSI ready flag not set

hal_status_t HAL_RCC_SHSI_Disable ( void )

Disable the Secure Internal High Speed oscillator (SHSI).

Warning

This oscillator might be used as peripheral clock source and this function will stop any peripheral functions.

Return values :

  • HAL_OK – SHSI oscillator has been deactivated successfully

  • HAL_ERROR – Timeout linked to SHSI ready flag not reset

hal_rcc_osc_enable_status_t HAL_RCC_SHSI_IsEnabled ( void )

Check if SHSI is enabled.

Return values :

hal_rcc_osc_enable_status_t – SHSI enable state

hal_rcc_osc_ready_status_t HAL_RCC_SHSI_IsReady ( void )

Check if SHSI is ready.

Return values :

  • status – based on hal_rcc_osc_ready_status_t

  • HAL_RCC_OSC_READY – SHSI is enabled and ready

  • HAL_RCC_OSC_NOT_READY – SHSI can be enabled but not ready

hal_status_t HAL_RCC_MSIS_Enable ( hal_rcc_msis_range_t clock_range )

Enable the Internal High Speed oscillator (MSIS) with selected frequency range.

Note

If MSIS used as system clock, an update of clock range will change the system clock.

Note

SystemCoreClock and Systick are updated in this function in case of adaptation of System clock.

Parameters :

clock_range – MSIS Clock Range

Return values :

  • HAL_OK – MSIS oscillator has been activated successfully

  • HAL_ERROR –

    Timeout linked to MSIS ready flag not set

    Issue to reconfigure the System tick

hal_status_t HAL_RCC_MSIS_Disable ( void )

Disable the Internal High Speed oscillator (MSIS).

Warning

Only possible if MSIS is not used as system clock and not the source clock of the main PLL used as system clock.

Warning

This oscillator might be used as peripheral clock source and this function will stop any peripheral functions.

Return values :

  • HAL_OK – MSIS oscillator has been deactivated successfully

  • HAL_ERROR –

    MSIS is used as system clock or source clock of the main PLL used as system clock

    Timeout linked to MSIS ready flag not reset

hal_rcc_osc_enable_status_t HAL_RCC_MSIS_IsEnabled ( void )

Check if MSIS is enabled.

Return values :

hal_rcc_osc_enable_status_t – MSIS enable state

hal_rcc_osc_ready_status_t HAL_RCC_MSIS_IsReady ( void )

Check if MSIS is ready.

Return values :

  • status – based on hal_rcc_osc_ready_status_t

  • HAL_RCC_OSC_READY – MSIS is enabled and ready

  • HAL_RCC_OSC_NOT_READY – MSIS can be enabled but not ready

hal_rcc_msis_range_t HAL_RCC_MSIS_GetRange ( void )

Get the current MSIS range.

Note

After a standby or a reset, MSI clock range selection is at 0 and the MSIS range value is provided by MSISSRANGE (only few ranges available). If MSI clock range selection has been set, MSIS range is provided in MSISRANGE (full range possible).

Note

MSI clock range selection can be modified through HAL_RCC_MSIS_Enable() .

Return values :

  • HAL_RCC_MSIS_FREQ_48MHZ – Range 0 around 48 MHz

  • HAL_RCC_MSIS_FREQ_24MHZ – Range 1 around 24 MHz

  • HAL_RCC_MSIS_FREQ_16MHZ – Range 2 around 16 MHz

  • HAL_RCC_MSIS_FREQ_12MHZ – Range 3 around 12 MHz

  • HAL_RCC_MSIS_FREQ_4MHZ – Range 4 around 4 MHz (available after standby)

  • HAL_RCC_MSIS_FREQ_2MHZ – Range 5 around 2 MHz (available after standby)

  • HAL_RCC_MSIS_FREQ_1330KHZ – Range 6 around 1.330 MHz (available after standby)

  • HAL_RCC_MSIS_FREQ_1MHZ – Range 7 around 1 MHz (available after standby)

  • HAL_RCC_MSIS_FREQ_3072KHZ – Range 8 around 3.072 MHz (available after standby)

  • HAL_RCC_MSIS_FREQ_1536KHZ – Range 9 around 1.536 MHz

  • HAL_RCC_MSIS_FREQ_1024KHZ – Range 10 around 1.024 MHz

  • HAL_RCC_MSIS_FREQ_768KHZ – Range 11 around 768 kHz

  • HAL_RCC_MSIS_FREQ_400KHZ – Range 12 around 400 kHz

  • HAL_RCC_MSIS_FREQ_200KHZ – Range 13 around 200 kHz

  • HAL_RCC_MSIS_FREQ_133KHZ – Range 14 around 133 kHz

  • HAL_RCC_MSIS_FREQ_100KHZ – Range 15 around 100 kHz

void HAL_RCC_MSIS_SetStandbyRange ( hal_rcc_msis_range_t msi_range )

Configure the MSIS range after standby mode.

Note

After exiting Standby, its frequency can be selected between 5 possible values.

Note

Using same RC as MSIK is reducing consumption.

Parameters :

msi_range – MSI range This parameter can be one of the following values:

hal_status_t HAL_RCC_MSIK_Enable ( hal_rcc_msik_range_t clock_range )

Enable the Internal kernel High Speed oscillator (MSIK) with selected frequency range.

Parameters :

clock_range – MSIK Clock Range

Return values :

  • HAL_OK – MSIK oscillator has been activated successfully

  • HAL_ERROR – Timeout linked to MSIK ready flag not set

hal_status_t HAL_RCC_MSIK_Disable ( void )

Disable the Internal High Speed Kernel oscillator (MSIK).

Warning

This oscillator might be used as peripheral clock source and this function will stop any peripheral functions.

Return values :

  • HAL_OK – MSIK oscillator has been deactivated successfully

  • HAL_ERROR – Timeout linked to MSIK ready flag not reset

hal_rcc_osc_enable_status_t HAL_RCC_MSIK_IsEnabled ( void )

Check if MSIK is enabled.

Return values :

hal_rcc_osc_enable_status_t – MSIK enable state

hal_rcc_osc_ready_status_t HAL_RCC_MSIK_IsReady ( void )

Check if MSIK is ready.

Return values :

  • status – based on hal_rcc_osc_ready_status_t

  • HAL_RCC_OSC_READY – MSIK is enabled and ready

  • HAL_RCC_OSC_NOT_READY – MSIK can be enabled but not ready

hal_rcc_msik_range_t HAL_RCC_MSIK_GetRange ( void )

Get the current MSIK range.

Note

After a standby or a reset, MSIK clock range selection is at 0 and the MSIK range value is provided by MSIKSRANGE (only few ranges available). If MSIK clock range selection has been set, MSIK range is provided in MSIKRANGE (full range possible).

Note

MSIK clock range selection can be modified through HAL_RCC_MSIK_Enable() .

Return values :

  • HAL_RCC_MSIK_FREQ_48MHZ – Range 0 around 48 MHz

  • HAL_RCC_MSIK_FREQ_24MHZ – Range 1 around 24 MHz

  • HAL_RCC_MSIK_FREQ_16MHZ – Range 2 around 16 MHz

  • HAL_RCC_MSIK_FREQ_12MHZ – Range 3 around 12 MHz

  • HAL_RCC_MSIK_FREQ_4MHZ – Range 4 around 4 MHz (available after standby)

  • HAL_RCC_MSIK_FREQ_2MHZ – Range 5 around 2 MHz (available after standby)

  • HAL_RCC_MSIK_FREQ_1330KHZ – Range 6 around 1.330 MHz (available after standby)

  • HAL_RCC_MSIK_FREQ_1MHZ – Range 7 around 1 MHz (available after standby)

  • HAL_RCC_MSIK_FREQ_3072KHZ – Range 8 around 3.072 MHz (available after standby)

  • HAL_RCC_MSIK_FREQ_1536KHZ – Range 9 around 1.536 MHz

  • HAL_RCC_MSIK_FREQ_1024KHZ – Range 10 around 1.024 MHz

  • HAL_RCC_MSIK_FREQ_768KHZ – Range 11 around 768 kHz

  • HAL_RCC_MSIK_FREQ_400KHZ – Range 12 around 400 kHz

  • HAL_RCC_MSIK_FREQ_200KHZ – Range 13 around 200 kHz

  • HAL_RCC_MSIK_FREQ_133KHZ – Range 14 around 133 kHz

  • HAL_RCC_MSIK_FREQ_100KHZ – Range 15 around 100 kHz

void HAL_RCC_MSIK_SetStandbyRange ( hal_rcc_msik_range_t msik_range )

Configure the MSIK range after standby mode.

Note

After exiting Standby, its frequency can be selected between 5 possible values.

Note

Using same RC as MSIS is reducing consumption.

Parameters :

msik_range – MSIK range This parameter can be one of the following values:

hal_status_t HAL_RCC_MSIK_EnableInStopMode ( void )

Enable MSIK even in stop mode.

Return values :

HAL_OK – MSIK oscillator has been activated in stop mode

hal_status_t HAL_RCC_MSIK_DisableInStopMode ( void )

Disable MSIK in stop mode.

Return values :

HAL_OK – MSIK oscillator has been deactivated in stop mode

hal_rcc_osc_stop_mode_status_t HAL_RCC_MSIK_IsEnabledInStopMode ( void )

Check if MSIK in stop mode is enabled.

Return values :

  • status – based on hal_rcc_osc_stop_mode_status_t

  • HAL_RCC_OSC_DISABLED_IN_STOP_MODE – MSIK is disabled in stop mode

  • HAL_RCC_OSC_ENABLED_IN_STOP_MODE – MSIK is enabled in stop mode

void HAL_RCC_MSI_SetTrimming ( uint32_t value , hal_rcc_msi_range_calib_t ranges )

Configure the MSIS/MSIK oscillators trimming value (used for SW trimming).

Note

The trimming is used to compensate for the variations in voltage and temperature that influence the frequency of the internal MSI RCx (x from 0 to 3).

Note

The trimming value might be updated while the MSI oscillator is enabled.

Parameters :

  • value – Trimming value (default is HAL_RCC_MSICALIBRATION_DEFAULT ). This parameter must be a number between 0 and 31.

  • ranges – Select MSI ranges to be calibrated.

uint32_t HAL_RCC_MSI_GetTrimming ( hal_rcc_msi_range_calib_t ranges )

Get the MSIS/MSIK oscillators trimming value.

Parameters :

ranges – Select MSI ranges.

Return values :

uint32_t – MSIS/MSIK trimming value between 0 and 31.

uint32_t HAL_RCC_MSI_GetCalibration ( hal_rcc_msi_range_calib_t ranges )

Get the MSIS/MSIK oscillators calibration value.

Parameters :

ranges – Select MSI ranges.

Return values :

uint32_t – MSIS/MSIK calibration value between 0 and 31.

void HAL_RCC_MSI_SetBiasMode ( hal_rcc_msi_bias_mode_t bias_mode )

Set MSI Bias mode.

Parameters :

bias_mode – MSI Bias mode based on hal_rcc_msi_bias_mode_t

hal_rcc_msi_bias_mode_t HAL_RCC_MSI_GetBiasMode ( void )

Get MSI Bias mode.

Return values :

hal_rcc_msi_bias_mode_t – MSI Bias mode

hal_status_t HAL_RCC_LSI_Enable ( hal_rcc_lsi_div_t divider )

Enable the Internal Low Speed oscillator (LSI) with selected divider.

Warning

Access to backup domain must be enabled.

Parameters :

divider – LSI divider

Return values :

  • HAL_OK – LSI oscillator has been configured successfully

  • HAL_ERROR –

    Timeout linked to LSI ready flag not set

    LSION not set and LSIRDY set, LSI divider cannot be updated

    Backup domain is not enabled

hal_status_t HAL_RCC_LSI_Disable ( void )

Disable the LSI oscillator.

Warning

This oscillator might be used as peripheral clock source and this function will stop any peripheral functions.

Warning

Access to backup domain must be enabled.

Return values :

  • HAL_OK – LSI oscillator has been deactivated successfully

  • HAL_ERROR –

    Timeout linked to LSI ready flag not reset

    Backup domain is not enabled

hal_rcc_osc_enable_status_t HAL_RCC_LSI_IsEnabled ( void )

Check if LSI is enabled.

Return values :

hal_rcc_osc_enable_status_t – LSI enable state

hal_rcc_osc_ready_status_t HAL_RCC_LSI_IsReady ( void )

Check if LSI is ready.

Return values :

  • status – based on hal_rcc_osc_ready_status_t

  • HAL_RCC_OSC_READY – LSI is enabled and ready

  • HAL_RCC_OSC_NOT_READY – LSI can be enabled but not ready

Functions to configure the bus prescalers and retrieve bus clock frequencies (SYSCLK, HCLK and PCLKx).

Note

On some devices, DPHY prescaler used in DSI block is configured through the following APIs.

Note

Unitary functions can be used to configure independently each bus. 

      example: all the BUS prescalers are set

      - Call the global @ref HAL_RCC_SetBusClockConfig
        @code
          LL_FLASH_SetLatency(LL_FLASH_LATENCY_4WS);
          HAL_RCC_SetSYSCLKSource(HAL_RCC_SYSCLK_SRC_PLLCLK);
          hal_rcc_bus_clk_config_t config_bus;
          config_bus.hclk_prescaler  = HAL_RCC_HCLK_PRESCALER1;
          config_bus.pclk1_prescaler = HAL_RCC_PCLK_PRESCALER1;
          config_bus.pclk2_prescaler = HAL_RCC_PCLK_PRESCALER1;
          config_bus.pclk3_prescaler = HAL_RCC_PCLK_PRESCALER1;
          HAL_RCC_SetBusClockConfig(&config_bus);
        @endcode

Functions

hal_status_t HAL_RCC_SetSYSCLKSource ( hal_rcc_sysclk_src_t source )

Set the CPU bus clock source (SYSCLK).

Note

SystemCoreClock and Systick are updated in this function.

Parameters :

source – System clock source based on hal_rcc_sysclk_src_t

Return values :

  • HAL_OK – Success

  • HAL_ERROR –

    System clock source has not been applied

    Output PLL1R not enabled to switch to PLLCLK

    Issue to reconfigure the System tick

hal_rcc_sysclk_src_t HAL_RCC_GetSYSCLKSource ( void )

Get the system clock source (SYSCLK).

Return values :

hal_rcc_sysclk_src_t – System Clock source

hal_status_t HAL_RCC_SetHCLKPrescaler ( hal_rcc_hclk_prescaler_t prescaler )

Set the AHB clock (HCLK) divider.

Note

SystemCoreClock and Systick are updated in this function.

Parameters :

prescaler – Prescaler value

Return values :

  • HAL_OK – HCLK prescaler has been changed successfully

  • HAL_ERROR – Issue to reconfigure the System tick

void HAL_RCC_SetPCLK1Prescaler ( hal_rcc_pclk_prescaler_t prescaler )

Set the APB1 clock (PCLK1) divider.

Parameters :

prescaler – Prescaler value

void HAL_RCC_SetPCLK2Prescaler ( hal_rcc_pclk_prescaler_t prescaler )

Set the APB2 clock (PCLK2) divider.

Parameters :

prescaler – Prescaler value

void HAL_RCC_SetPCLK3Prescaler ( hal_rcc_pclk_prescaler_t prescaler )

Set the APB3 clock (PCLK3) divider.

Parameters :

prescaler – Prescaler value

void HAL_RCC_DSI_SetDPHYPrescaler ( hal_rcc_pclk_prescaler_t prescaler )

Set the DSI PHY prescaler (DPHY).

Parameters :

prescaler – Prescaler value

hal_rcc_hclk_prescaler_t HAL_RCC_GetHCLKPrescaler ( void )

Get the AHB bus clock prescaler (HCLK).

Return values :

hal_rcc_hclk_prescaler_t – Prescaler value

hal_rcc_pclk_prescaler_t HAL_RCC_GetPCLK1Prescaler ( void )

Set the APB1 bus clock prescaler (PCLK1).

Return values :

hal_rcc_pclk_prescaler_t – Prescaler value

hal_rcc_pclk_prescaler_t HAL_RCC_GetPCLK2Prescaler ( void )

Set the APB1 bus clock prescaler (PCLK2).

Return values :

hal_rcc_pclk_prescaler_t – Prescaler value

hal_rcc_pclk_prescaler_t HAL_RCC_GetPCLK3Prescaler ( void )

Set the APB1 bus clock prescaler (PCLK3).

Return values :

hal_rcc_pclk_prescaler_t – Prescaler value

hal_rcc_pclk_prescaler_t HAL_RCC_DSI_GetDPHYPrescaler ( void )

Set the DSI PHY prescaler (DPHY).

Return values :

hal_rcc_pclk_prescaler_t – Prescaler value

hal_status_t HAL_RCC_SetBusClockConfig ( const hal_rcc_bus_clk_config_t * p_config )

Configure the bus dividers.

Note

SystemCoreClock and Systick are updated in this function.

Warning

FLASH latency must be adjusted according to the targeted system clock frequency and voltage scaling.

Parameters :

p_config – Pointer based on hal_rcc_bus_clk_config_t structure

Return values :

  • HAL_OK – Success

  • HAL_ERROR – Issue to reconfigure the System tick

  • HAL_INVALID_PARAM – Input parameter not valid (USE_HAL_CHECK_PARAM enabled)

void HAL_RCC_GetBusClockConfig ( hal_rcc_bus_clk_config_t * p_config )

Retrieve the bus dividers.

Parameters :

p_config – Pointer on hal_rcc_bus_clk_config_t structure

uint32_t HAL_RCC_GetSYSCLKFreq ( void )

Return 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.

Note

If SYSCLK source is MSI, function returns values based on MSI Value as defined by the MSI range (***).

Note

If SYSCLK source is HSI, function returns values based on HSI_VALUE(*).

Note

If SYSCLK source is HSE, function returns values based on HSE_VALUE(**).

Note

If SYSCLK source is PLL, function returns values based on HSE_VALUE(**), HSI_VALUE(*) or MSI Value multiplied/divided by the PLL factors.

Note

This function can be used by the user application to compute the baudrate for the communication peripherals or configure other parameters.

Warning

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 :

uint32_t – SYSCLK frequency in Hz

uint32_t HAL_RCC_GetHCLKFreq ( void )

Return the HCLK frequency.

Note

The SystemCoreClock CMSIS variable is used to store System Clock Frequency.

Warning

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.

Return values :

uint32_t – HCLK frequency in Hz

uint32_t HAL_RCC_GetPCLK1Freq ( void )

Return the PCLK1 frequency.

Warning

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 :

uint32_t – PCLK1 frequency in Hz

uint32_t HAL_RCC_GetPCLK2Freq ( void )

Return the PCLK2 frequency.

Warning

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 :

uint32_t – PCLK2 frequency in Hz

uint32_t HAL_RCC_GetPCLK3Freq ( void )

Return the PCLK3 frequency.

Warning

Each time PCLK3 changes, this function must be called to update the right PCLK3 value. Otherwise, any configuration based on this function will be incorrect.

Return values :

uint32_t – PCLK3 frequency in Hz

Functions to configure the different PLL1.

PLL1 (main PLL) might be used for system clock. PLL1 is configured and enabled respectively with HAL_RCC_PLL1_SetConfig() and HAL_RCC_PLL1_Enable() . The following functions allow to control independently the configuration and activation for the PLL1.

example1: activation main PLL

  • Call the unitary functions: 

    HAL_RCC_HSI_Enable();
HAL_RCC_HSI_SetTrimmingConfig(HAL_RCC_HSICALIBRATION_DEFAULT);
hal_rcc_pll_config_t config_pll;
config_pll.pll_source = HAL_RCC_PLL_SRC_HSI;
config_pll.pll_m = 4;
config_pll.pll_n = 75;
config_pll.pll_p = 2;
config_pll.pll_q = 2;
config_pll.pll_r = 2
HAL_RCC_PLL1_SetConfig(&config_pll);
HAL_RCC_PLL1_Enable();
HAL_RCC_PLL1_EnableOutput(HAL_RCC_PLL1_SYSCLK);

Functions

hal_status_t HAL_RCC_PLL1_SetConfig ( const hal_rcc_pll_config_t * p_config )

Configure PLL1 without enabling outputs.

The config function will perform the following actions:

  • Check in PLL1 is well deactivated (if enabled exit from this function)

  • Configure the PLL1 with full list of parameters

Parameters :

p_config – pointer to a hal_rcc_pll_config_t structure that contains the configuration information for the PLL1

Return values :

  • HAL_OK – PLL1 has been correctly configured

  • HAL_INVALID_PARAM – Input parameter not valid (USE_HAL_CHECK_PARAM enabled)

  • HAL_ERROR – PLL1 is already enabled and can not be modified.

hal_status_t HAL_RCC_PLL1_EnableOutput ( uint32_t output )

Enable output(s) of PLL1.

Parameters :

output – Output to enable for PLL1 It can be a combination of the following values:

Return values :

HAL_OK – Output(s) has been activated

hal_status_t HAL_RCC_PLL1_DisableOutput ( uint32_t output )

Disable output(s) of PLL1.

Parameters :

output – Output to disable for PLL1 It can be a combination of the following values:

Return values :

  • HAL_OK – Output(s) has been deactivated

  • HAL_ERROR – Output is used as system clock and cannot be deactivated

hal_status_t HAL_RCC_PLL1_Enable ( void )

Enable PLL1.

Note

If PLL is not enabled, enable it and wait for RDY state.

Return values :

  • HAL_OK – PLL1 correctly enabled or already enabled.

  • HAL_ERROR – Timeout detected during enabling of the PLL1

hal_status_t HAL_RCC_PLL1_Disable ( void )

Disable PLL1.

PLL1 cannot be disabled if used as system level

  • If PLL1 Output is as used as system level => return an error

  • If PLL1 enabled => disable PLL1 and wait for deactivation (error only if pb to disable)

Return values :

  • HAL_OK – PLL1 correctly deactivated or already deactivated.

  • HAL_ERROR –

    PLL1 is used as system level and cannot be deactivated

    Timeout detected during disabling of the PLL1

hal_status_t HAL_RCC_PLL1_Reset ( void )

Disable PLL1 for power consumption perspective.

This function allow to reset all the parameters which might impact power like PLLSRC, outputs…

Warning

To enable again PLL1, a new configuration must be applied.

Return values :

  • HAL_OK – PLL1 is correctly disabled

  • HAL_ERROR –

    Output is used as system level and cannot be disabled

    Timeout to disable PLL1

void HAL_RCC_PLL1_GetConfig ( hal_rcc_pll_config_t * p_config )

Return the configuration of PLL1.

Parameters :

p_config – pointer to a hal_rcc_pll_config_t structure that contains the configuration information for the PLL1

uint32_t HAL_RCC_PLL1_GetOutput ( void )

Return the enabled output(s) of PLL1.

Return values :

output – PLL1 outputs. It can be a combination of the following values:

hal_rcc_pll_status_t HAL_RCC_PLL1_IsReady ( void )

Check if the PLL1 is ready.

Return values :

  • HAL_RCC_PLL_ENABLED – PLL1 is ready

  • HAL_RCC_PLL_DISABLED – PLL1 is not ready

void HAL_RCC_PLL1_GetClockFreq ( hal_rcc_pll_output_freq_t * p_clk )

Returns the PLL1 clock frequencies: pll_p_freq, pll_q_freq and pll_r_freq.

Note

The PLL1 clock frequencies 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.

Note

The function returns values based on HSE_VALUE, HSI_VALUE or MSI Value multiplied/divided by the PLL factors.

Note

This function can be used by the user application to compute the baud-rate for the communication peripherals or configure other parameters.

Warning

Each time PLL1CLK changes, this function must be called to update the right PLL1CLK value. Otherwise, any configuration based on this function will be incorrect.

Parameters :

p_clk – Contains the frequency for each PLL1 output (in Hz).

hal_status_t HAL_RCC_PLL1_SetFRACN ( uint16_t fracn )

Set the fractional part (FRACN) of the multiplication factor of PLL1 on-the-fly.

Parameters :

fracn – The new fractional value to be set for PLL1.

Return values :

  • HAL_OK – The FRACN value has been correctly set.

  • HAL_ERROR – The FRACN value update has failed.

uint16_t HAL_RCC_PLL1_GetFRACN ( void )

Get the current fractional part (FRACN) of the multiplication factor of PLL1.

Return values :

The – current fractional value of PLL1.

Functions to configure the different PLL2.

PLL2 is configured and enabled respectively with HAL_RCC_PLL2_SetConfig() and HAL_RCC_PLL2_Enable() . The following functions allow to control independently the configuration and activation for the PLL2.

example1: activation PLL2 only

  • Call the unitary functions: 

    HAL_RCC_MSI_Enable(HAL_RCC_MSIS_FREQ_4MHZ);
hal_rcc_pll_config_t config_pll;
config_pll.pll_source = HAL_RCC_PLL_SRC_MSIS;
config_pll.pll_m = 1;
config_pll.pll_n = 43;
config_pll.pll_p = 7;
config_pll.pll_q = 2;
config_pll.pll_r = 2;
config_pll.pll_fracn = 0;
HAL_RCC_PLL2_SetConfig(&config_pll);
HAL_RCC_PLL2_Enable();
HAL_RCC_PLL2_EnableOutput(HAL_RCC_PLL2_OUTPUT_P | HAL_RCC_PLL2_OUTPUT_Q | HAL_RCC_PLL2_OUTPUT_R);

example2: activation PLL2 in activating as source of SAI1

  • Call the unitary functions: 

    HAL_RCC_MSI_Enable(HAL_RCC_MSIS_FREQ_4MHZ);
hal_rcc_pll_config_t config_pll;
config_pll.pll_source = HAL_RCC_PLL_SRC_MSIS;
config_pll.pll_m = 1;
config_pll.pll_n = 8;
config_pll.pll_p = 2;
config_pll.pll_q = 2;
config_pll.pll_r = 2;
HAL_RCC_PLL2_SetConfig(&config_pll);
HAL_RCC_PLL2_Enable();
HAL_RCC_PLL2_EnableOutput(HAL_RCC_PLL2_OUTPUT_P);
HAL_RCC_SAI1_SetKernelClkSource(HAL_RCC_SAI1CLKSOURCE_PLL2);

Functions

hal_status_t HAL_RCC_PLL2_SetConfig ( const hal_rcc_pll_config_t * p_config )

Configure PLL2 without enabling outputs.

The config function will perform the following actions:

  • Check in PLL2 is well deactivated (if enabled exit from this function)

  • Configure the PLL2 with full list of parameters

Parameters :

p_config – pointer to a hal_rcc_pll_config_t structure that contains the configuration information for the PLL2

Return values :

  • HAL_OK – PLL2 has been correctly configured

  • HAL_INVALID_PARAM – Input parameter not valid (USE_HAL_CHECK_PARAM enabled)

  • HAL_ERROR – PLL2 is already enabled and can not be modified.

hal_status_t HAL_RCC_PLL2_Enable ( void )

Enable PLL2.

Note

If PLL2 is not enabled, enable it and wait for RDY state.

Return values :

  • HAL_OK – PLL2 correctly enabled or already enabled.

  • HAL_ERROR – Timeout detected during enabling of the PLL2

hal_status_t HAL_RCC_PLL2_Disable ( void )

Disable PLL2.

Return values :

  • HAL_OK – PLL2 correctly deactivated or PLL2 was already disabled.

  • HAL_ERROR – Timeout detected during disabling of the PLL2

hal_status_t HAL_RCC_PLL2_EnableOutput ( uint32_t output )

Enable output(s) of PLL2.

Parameters :

output – Output to enable for PLL2. It can be a combination of the following values:

Return values :

HAL_OK – Output(s) has been activated

hal_status_t HAL_RCC_PLL2_DisableOutput ( uint32_t output )

Disable output(s) of PLL2.

Parameters :

output – Output to disable for PLL2. It can be a combination of the following values:

Return values :

HAL_OK – Output(s) has been deactivated

void HAL_RCC_PLL2_GetConfig ( hal_rcc_pll_config_t * p_config )

Return the configuration of PLL2.

Parameters :

p_config – pointer to a hal_rcc_pll_config_t structure that contains the configuration information for the PLL2

uint32_t HAL_RCC_PLL2_GetOutput ( void )

Return the enabled output(s) of PLL2.

Return values :

output – PLL2 outputs. It can be a combination of the following values:

hal_rcc_pll_status_t HAL_RCC_PLL2_IsReady ( void )

Check if the PLL2 is ready.

Return values :

  • HAL_RCC_PLL_ENABLED – PLL2 is ready

  • HAL_RCC_PLL_DISABLED – PLL2 is not ready

void HAL_RCC_PLL2_GetClockFreq ( hal_rcc_pll_output_freq_t * p_clk )

Returns the PLL2 clock frequencies: pll_p_freq, pll_r_freq and pll_q_freq.

Note

The PLL2 clock frequencies 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.

Note

The function returns values based on HSE_VALUE, HSI_VALUE or MSI Value multiplied/divided by the PLL factors.

Note

This function can be used by the user application to compute the baud-rate for the communication peripherals or configure other parameters.

Warning

Each time PLL2CLK changes, this function must be called to update the right PLL2CLK value. Otherwise, any configuration based on this function will be incorrect.

Parameters :

p_clk – Contains the frequency for each PLL2 output (in Hz).

hal_status_t HAL_RCC_PLL2_SetFRACN ( uint16_t fracn )

Set the fractional part (FRACN) of the multiplication factor of PLL2 on-the-fly.

Parameters :

fracn – The new fractional value to be set for PLL2.

Return values :

  • HAL_OK – The FRACN value has been correctly set.

  • HAL_ERROR – The FRACN value update has failed.

uint16_t HAL_RCC_PLL2_GetFRACN ( void )

Get the current fractional part (FRACN) of the multiplication factor of PLL2.

Return values :

The – current fractional value of PLL2.

hal_status_t HAL_RCC_PLL2_Reset ( void )

Disable PLL2 for power consumption perspective.

This function allow to reset all the parameters which might impact power like PLLSRC, outputs…

Warning

To enable again PLL2, a new configuration must be applied.

Return values :

  • HAL_OK – PLL2 is correctly disabled

  • HAL_ERROR – PLL2 not disabled

Functions to configure the different PLL3.

PLL3 is configured and enabled respectively with HAL_RCC_PLL3_SetConfig() and HAL_RCC_PLL3_Enable() . The following functions allow to control independently the configuration and activation for the PLL3.

example1: activation PLL3 only

  • Call the unitary functions: 

    HAL_RCC_MSI_Enable(HAL_RCC_MSIS_FREQ_4MHZ);
hal_rcc_pll_config_t config_pll;
config_pll.pll_source = HAL_RCC_PLL_SRC_MSIS;
config_pll.pll_m = 1;
config_pll.pll_n = 43;
config_pll.pll_p = 7;
config_pll.pll_q = 2;
config_pll.pll_r = 2;
config_pll.pll_fracn = 0;
HAL_RCC_PLL3_SetConfig(&config_pll);
HAL_RCC_PLL3_Enable();
HAL_RCC_PLL3_EnableOutput(HAL_RCC_PLL3_OUTPUT_P | HAL_RCC_PLL3_OUTPUT_Q | HAL_RCC_PLL3_OUTPUT_R);

example2: activation PLL3 in activating as source of SAI1

  • Call the unitary functions: 

    HAL_RCC_MSI_Enable(HAL_RCC_MSIS_FREQ_4MHZ);
hal_rcc_pll_config_t config_pll;
config_pll.pll_source = HAL_RCC_PLL_SRC_MSIS;
config_pll.pll_m = 1;
config_pll.pll_n = 8;
config_pll.pll_p = 2;
config_pll.pll_q = 2;
config_pll.pll_r = 2;
HAL_RCC_PLL3_SetConfig(&config_pll);
HAL_RCC_PLL3_Enable();
HAL_RCC_PLL3_EnableOutput(HAL_RCC_PLL3_OUTPUT_P);
HAL_RCC_SAI1_SetKernelClkSource(HAL_RCC_SAI1CLKSOURCE_PLL3);

Functions

hal_status_t HAL_RCC_PLL3_SetConfig ( const hal_rcc_pll_config_t * p_config )

Configure PLL3 without enabling outputs.

The config function will perform the following actions:

  • Check in PLL3 is well deactivated (if enabled exit from this function)

  • Configure the PLL3 with full list of parameters

Parameters :

p_config – pointer to a hal_rcc_pll_config_t structure that contains the configuration information for the PLL3

Return values :

  • HAL_OK – PLL3 has been correctly configured

  • HAL_INVALID_PARAM – Input parameter not valid (USE_HAL_CHECK_PARAM enabled)

  • HAL_ERROR – PLL3 is already enabled and can not be modified.

hal_status_t HAL_RCC_PLL3_Enable ( void )

Enable PLL3.

Note

If PLL is not enabled, enable it and wait for RDY state.

Return values :

  • HAL_OK – PLL3 correctly enabled or already enabled.

  • HAL_ERROR – Timeout detected during enabling of the PLL3

hal_status_t HAL_RCC_PLL3_Disable ( void )

Disable PLL3.

Return values :

  • HAL_OK – PLL3 correctly deactivated or PLL3 was already disabled.

  • HAL_ERROR – Timeout detected during disabling of the PLL3

hal_status_t HAL_RCC_PLL3_EnableOutput ( uint32_t output )

Enable output(s) of PLL3.

Parameters :

output – Output to enable for PLL3. It can be a combination of the following values:

Return values :

HAL_OK – Output(s) has been activated

hal_status_t HAL_RCC_PLL3_DisableOutput ( uint32_t output )

Disable output(s) of PLL3.

Parameters :

output – Output to disable for PLL3. It can be a combination of the following values:

Return values :

HAL_OK – Output(s) has been deactivated

void HAL_RCC_PLL3_GetConfig ( hal_rcc_pll_config_t * p_config )

Return the configuration of PLL3.

Parameters :

p_config – pointer to a hal_rcc_pll_config_t structure that contains the configuration information for the PLL3

uint32_t HAL_RCC_PLL3_GetOutput ( void )

Return the enabled output(s) of PLL3.

Return values :

output – PLL3 outputs. It can be a combination of the following values:

hal_rcc_pll_status_t HAL_RCC_PLL3_IsReady ( void )

Check if the PLL3 is ready.

Return values :

  • HAL_RCC_PLL_ENABLED – PLL3 is ready

  • HAL_RCC_PLL_DISABLED – PLL3 is not ready

void HAL_RCC_PLL3_GetClockFreq ( hal_rcc_pll_output_freq_t * p_clk )

Returns the PLL3 clock frequencies: pll_p_freq, pll_r_freq and pll_q_freq.

Note

The PLL3 clock frequencies 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.

Note

The function returns values based on HSE_VALUE, HSI_VALUE or MSI Value multiplied/divided by the PLL factors.

Note

This function can be used by the user application to compute the baud-rate for the communication peripherals or configure other parameters.

Warning

Each time PLL3CLK changes, this function must be called to update the right PLL3CLK value. Otherwise, any configuration based on this function will be incorrect.

Parameters :

p_clk – Contains the frequency for each PLL3 output (in Hz).

hal_status_t HAL_RCC_PLL3_SetFRACN ( uint16_t fracn )

Set the fractional part (FRACN) of the multiplication factor of PLL3 on-the-fly.

Parameters :

fracn – The new fractional value to be set for PLL3.

Return values :

  • HAL_OK – The FRACN value has been correctly set.

  • HAL_ERROR – The FRACN value update has failed.

uint16_t HAL_RCC_PLL3_GetFRACN ( void )

Get the current fractional part (FRACN) of the multiplication factor of PLL3.

Return values :

The – current fractional value of PLL3.

hal_status_t HAL_RCC_PLL3_Reset ( void )

Disable PLL3 for power consumption perspective.

This function allow to reset all the parameters which might impact power like PLLSRC, outputs…

Warning

To enable again PLL3, a new configuration must be applied.

Return values :

  • HAL_OK – PLL3 is correctly disabled

  • HAL_ERROR – Timeout detected during disabling of the PLL3

Functions to Set, Get the Systick external clock source and frequency.

Functions

void HAL_RCC_SetSysTickExternalClkSource ( hal_rcc_systick_clk_src_t clk_src )

Set the Systick external clock source.

Parameters :

clk_src – Systick external clock source selection based on hal_rcc_systick_clk_src_t

hal_rcc_systick_clk_src_t HAL_RCC_GetSysTickExternalClkSource ( void )

Get the Systick external clock source.

Return values :

Systick – external clock source based on hal_rcc_systick_clk_src_t

uint32_t HAL_RCC_GetSysTickExternalClkFreq ( void )

Get the Systick external clock frequency.

Return values :

uint32_t – Frequency in Hz

Peripheral Clock management on buses

group RCC_Exported_Functions_Group2

This subsection provides a set of functions (on AHB1, AHB2, AHB3, APB1, APB2 or APB3 buses) allowing to:

  • Enable or disable the peripherals clock.

  • Reset of peripherals clock.

  • Enable or disable the peripherals clock in low power mode.

  • Enable or disable the peripherals clock in autonomous mode.

Functions

void HAL_RCC_SetConfigMCO ( hal_rcc_mco_src_t mco_src , hal_rcc_mco_prescaler_t mco_div )

Select the clock source to output on MCO pin.

Warning

MCO selected pin must be configured in alternate function mode.

Parameters :

  • mco_src – specifies the clock source to output.

  • mco_div – specifies the MCO prescaler.

uint32_t HAL_RCC_GetResetSource ( void )

Get and clear reset flags.

Note

Once reset flags are retrieved, this API is clearing them in order to isolate next reset source.

Return values :

uint32_t – Reset flags based on a combination of Reset Flag

void HAL_RCC_SetClockAfterWakeFromStop ( hal_rcc_stop_wakeup_clk_t wakeup_clk )

Configure the oscillator clock source for wakeup from Stop and CSS backup clock.

Warning

This function must not be called after the Clock Security System on HSE has been enabled.

Parameters :

wakeup_clk – Wakeup clock This parameter can be one of the following values:

hal_rcc_stop_wakeup_clk_t HAL_RCC_GetClockAfterWakeFromStop ( void )

Get the oscillator clock source for wakeup from Stop and CSS backup clock.

Return values :

hal_rcc_stop_wakeup_clk_t – Wakeup clock source

void HAL_RCC_SetKernelClkAfterWakeFromStop ( hal_rcc_stop_wakeup_kerclk_t wakeup_clk )

Configure the oscillator Kernel clock source for wakeup from Stop.

Parameters :

wakeup_clk – Kernel Wakeup clock

hal_rcc_stop_wakeup_kerclk_t HAL_RCC_GetKernelClkAfterWakeFromStop ( void )

Get the oscillator Kernel clock source for wakeup from Stop.

Return values :

hal_rcc_stop_wakeup_kerclk_t – Kernel Wakeup clock

hal_status_t HAL_RCC_EnableLSCO ( hal_rcc_lsco_src_t source )

Select source clock to use on the Low Speed Clock Output (LSCO).

Note

PWR and backup domain are to enabled before calling this function.

Parameters :

source – specifies the Low Speed clock source to output.

Return values :

  • HAL_OK – LSCO activated

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_DisableLSCO ( void )

Disable the Low Speed Clock Output (LSCO).

Note

PWR and backup domain are to enabled before calling this function.

Return values :

  • HAL_OK – LSCO Deactivated

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_RTC_EnableKernelClock ( void )

Enable RTC and TAMP kernel clock.

Note

PWR and backup domain are to enabled before calling this function.

Return values :

  • HAL_OK – RTC and TAMP kernel clock enabled

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_RTC_DisableKernelClock ( void )

Disable RTC and TAMP kernel clock.

Note

PWR and backup domain are to enabled before calling this function.

Return values :

  • HAL_OK – RTC and TAMP kernel clock disabled

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_SetTimerInputCaptureClockSource ( hal_rcc_timic_clk_src_t clk_src )

Set the Clocks sources for TIM16,TIM17 and LPTIM2 internal input capture.

Parameters :

clk_src – Clock source selection based on hal_rcc_timic_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_rcc_timic_clk_src_t HAL_RCC_GetTimerInputCaptureClockSource ( void )

Get the Clocks sources for TIM16,TIM17 and LPTIM2 internal input capture.

Return values :

clk_src – Clock source based on hal_rcc_timic_clk_src_t

Enable or disable the AHB1 peripheral clock.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

void HAL_RCC_GPDMA1_EnableClock ( void )

This function enables the GPDMA1 clock.

void HAL_RCC_CORDIC_EnableClock ( void )

This function enables the CORDIC clock.

void HAL_RCC_FMAC_EnableClock ( void )

This function enables the FMAC clock.

void HAL_RCC_TSC_EnableClock ( void )

This function enables the TSC clock.

void HAL_RCC_CRC_EnableClock ( void )

This function enables the CRC clock.

void HAL_RCC_JPEG_EnableClock ( void )

This function enables the JPEG clock.

void HAL_RCC_RAMCFG_EnableClock ( void )

This function enables the RAMCFG clock.

void HAL_RCC_FLASH_EnableClock ( void )

This function enables the FLASH clock.

void HAL_RCC_MDF1_EnableClock ( void )

This function enables the MDF1 clock.

void HAL_RCC_DMA2D_EnableClock ( void )

This function enables the DMA2D clock.

void HAL_RCC_GFXMMU_EnableClock ( void )

This function enables the GFXMMU clock.

void HAL_RCC_GPU2D_EnableClock ( void )

This function enables the GPU2D clock.

void HAL_RCC_DCACHE2_EnableClock ( void )

This function enables the DCACHE2 clock.

void HAL_RCC_GTZC1_EnableClock ( void )

This function enables the GTZC1 clock.

void HAL_RCC_BKPSRAM_EnableClock ( void )

This function enables the BKPSRAM clock.

void HAL_RCC_DCACHE1_EnableClock ( void )

This function enables the DCACHE1 clock.

void HAL_RCC_SRAM1_EnableClock ( void )

This function enables the SRAM1 clock.

void HAL_RCC_GPDMA1_DisableClock ( void )

This function disables the GPDMA1 clock.

void HAL_RCC_CORDIC_DisableClock ( void )

This function disables the CORDIC clock.

void HAL_RCC_FMAC_DisableClock ( void )

This function disables the FMAC clock.

void HAL_RCC_MDF1_DisableClock ( void )

This function disables the MDF1 clock.

void HAL_RCC_FLASH_DisableClock ( void )

This function disables the FLASH clock.

void HAL_RCC_CRC_DisableClock ( void )

This function disables the CRC clock.

void HAL_RCC_JPEG_DisableClock ( void )

This function disables the JPEG clock.

void HAL_RCC_TSC_DisableClock ( void )

This function disables the TSC clock.

void HAL_RCC_RAMCFG_DisableClock ( void )

This function disables the RAMCFG clock.

void HAL_RCC_DMA2D_DisableClock ( void )

This function disables the DMA2D clock.

void HAL_RCC_GFXMMU_DisableClock ( void )

This function disables the GFXMMU clock.

void HAL_RCC_GPU2D_DisableClock ( void )

This function disables the GPU2D clock.

void HAL_RCC_DCACHE2_DisableClock ( void )

This function disables the DCACHE2 clock.

void HAL_RCC_GTZC1_DisableClock ( void )

This function disables the GTZC1 clock.

void HAL_RCC_BKPSRAM_DisableClock ( void )

This function disables the BKPSRAM clock.

void HAL_RCC_DCACHE1_DisableClock ( void )

This function disables the DCACHE1 clock.

void HAL_RCC_SRAM1_DisableClock ( void )

This function disables the SRAM1 clock.

Enable or disable the AHB2 peripheral clock.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

void HAL_RCC_GPIOA_EnableClock ( void )

This function enables the GPIOA clock.

void HAL_RCC_GPIOB_EnableClock ( void )

This function enables the GPIOB clock.

void HAL_RCC_GPIOC_EnableClock ( void )

This function enables the GPIOC clock.

void HAL_RCC_GPIOD_EnableClock ( void )

This function enables the GPIOD clock.

void HAL_RCC_GPIOE_EnableClock ( void )

This function enables the GPIOE clock.

void HAL_RCC_GPIOF_EnableClock ( void )

This function enables the GPIOF clock.

void HAL_RCC_GPIOG_EnableClock ( void )

This function enables the GPIOG clock.

void HAL_RCC_GPIOH_EnableClock ( void )

This function enables the GPIOH clock.

void HAL_RCC_GPIOI_EnableClock ( void )

This function enables the GPIOI clock.

void HAL_RCC_GPIOJ_EnableClock ( void )

This function enables the GPIOJ clock.

void HAL_RCC_ADC12_EnableClock ( void )

This function enables the ADC12 clock.

void HAL_RCC_DCMI_PSSI_EnableClock ( void )

This function enables the DCMI_PSSI clock.

void HAL_RCC_USB_OTG_HS_EnableClock ( void )

This function enables the USB_OTG_HS clock.

void HAL_RCC_USBHSPHY_EnableClock ( void )

This function enables the USBHSPHY clock.

void HAL_RCC_AES_EnableClock ( void )

This function enables the AES clock.

void HAL_RCC_HASH_EnableClock ( void )

This function enables the HASH clock.

void HAL_RCC_RNG_EnableClock ( void )

This function enables the RNG clock.

void HAL_RCC_PKA_EnableClock ( void )

This function enables the PKA clock.

void HAL_RCC_SAES_EnableClock ( void )

This function enables the SAES clock.

void HAL_RCC_OCTOSPIM_EnableClock ( void )

This function enables the OCTOSPIM clock.

void HAL_RCC_OTFDEC1_EnableClock ( void )

This function enables the OTFDEC1 clock.

void HAL_RCC_OTFDEC2_EnableClock ( void )

This function enables the OTFDEC2 clock.

void HAL_RCC_SDMMC1_EnableClock ( void )

This function enables the SDMMC1 clock.

void HAL_RCC_SDMMC2_EnableClock ( void )

This function enables the SDMMC2 clock.

void HAL_RCC_SRAM2_EnableClock ( void )

This function enables the SRAM2 clock.

void HAL_RCC_SRAM3_EnableClock ( void )

This function enables the SRAM3 clock.

void HAL_RCC_FSMC_EnableClock ( void )

This function enables the FSMC clock.

void HAL_RCC_OCTOSPI1_EnableClock ( void )

This function enables the OCTOSPI1 clock.

void HAL_RCC_OCTOSPI2_EnableClock ( void )

This function enables the OCTOSPI2 clock.

void HAL_RCC_GPIOA_DisableClock ( void )

This function disables the GPIOA clock.

void HAL_RCC_GPIOB_DisableClock ( void )

This function disables the GPIOB clock.

void HAL_RCC_GPIOC_DisableClock ( void )

This function disables the GPIOC clock.

void HAL_RCC_GPIOD_DisableClock ( void )

This function disables the GPIOD clock.

void HAL_RCC_GPIOE_DisableClock ( void )

This function disables the GPIOE clock.

void HAL_RCC_GPIOF_DisableClock ( void )

This function disables the GPIOF clock.

void HAL_RCC_GPIOG_DisableClock ( void )

This function disables the GPIOG clock.

void HAL_RCC_GPIOH_DisableClock ( void )

This function disables the GPIOH clock.

void HAL_RCC_GPIOI_DisableClock ( void )

This function disables the GPIOI clock.

void HAL_RCC_GPIOJ_DisableClock ( void )

This function disables the GPIOJ clock.

void HAL_RCC_ADC12_DisableClock ( void )

This function disables the ADC12 clock.

void HAL_RCC_DCMI_PSSI_DisableClock ( void )

This function disables the DCMI_PSSI clock.

void HAL_RCC_USB_OTG_HS_DisableClock ( void )

This function disables the USB_OTG_HS clock.

void HAL_RCC_USBHSPHY_DisableClock ( void )

This function disables the USBHSPHY clock.

void HAL_RCC_AES_DisableClock ( void )

This function disables the AES clock.

void HAL_RCC_HASH_DisableClock ( void )

This function disables the HASH clock.

void HAL_RCC_RNG_DisableClock ( void )

This function disables the RNG clock.

void HAL_RCC_PKA_DisableClock ( void )

This function disables the PKA clock.

void HAL_RCC_SAES_DisableClock ( void )

This function disables the SAES clock.

void HAL_RCC_OCTOSPIM_DisableClock ( void )

This function disables the OCTOSPIM clock.

void HAL_RCC_OTFDEC1_DisableClock ( void )

This function disables the OTFDEC1 clock.

void HAL_RCC_OTFDEC2_DisableClock ( void )

This function disables the OTFDEC2 clock.

void HAL_RCC_SDMMC1_DisableClock ( void )

This function disables the SDMMC1 clock.

void HAL_RCC_SDMMC2_DisableClock ( void )

This function disables the SDMMC2 clock.

void HAL_RCC_SRAM2_DisableClock ( void )

This function disables the SRAM2 clock.

void HAL_RCC_SRAM3_DisableClock ( void )

This function disables the SRAM3 clock.

void HAL_RCC_HSPI1_EnableClock ( void )

This function enables the HSPI1 clock.

void HAL_RCC_SRAM6_EnableClock ( void )

This function enables the SRAM6 clock.

void HAL_RCC_SRAM5_EnableClock ( void )

This function enables the SRAM5 clock.

void HAL_RCC_FSMC_DisableClock ( void )

This function disables the FSMC clock.

void HAL_RCC_OCTOSPI1_DisableClock ( void )

This function disables the OCTOSPI1 clock.

void HAL_RCC_OCTOSPI2_DisableClock ( void )

This function disables the OCTOSPI2 clock.

void HAL_RCC_HSPI1_DisableClock ( void )

This function disables the HSPI1 clock.

void HAL_RCC_SRAM6_DisableClock ( void )

This function disables the SRAM6 clock.

void HAL_RCC_SRAM5_DisableClock ( void )

This function disables the SRAM5 clock.

Enable or disable the AHB3ENR peripheral clock.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

void HAL_RCC_LPGPIO1_EnableClock ( void )

This function enables the LPGPIO1 clock.

void HAL_RCC_PWR_EnableClock ( void )

This function enables the PWR clock.

void HAL_RCC_ADC4_EnableClock ( void )

This function enables the ADC4 clock.

void HAL_RCC_DAC1_EnableClock ( void )

This function enables the DAC1 clock.

void HAL_RCC_LPDMA1_EnableClock ( void )

This function enables the LPDMA1 clock.

void HAL_RCC_ADF1_EnableClock ( void )

This function enables the ADF1 clock.

void HAL_RCC_GTZC2_EnableClock ( void )

This function enables the GTZC2 clock.

void HAL_RCC_SRAM4_EnableClock ( void )

This function enables the SRAM4 clock.

void HAL_RCC_LPGPIO1_DisableClock ( void )

This function disables the LPGPIO1 clock.

void HAL_RCC_PWR_DisableClock ( void )

This function disables the PWR clock.

void HAL_RCC_ADC4_DisableClock ( void )

This function disables the ADC4 clock.

void HAL_RCC_DAC1_DisableClock ( void )

This function disables the DAC1 clock.

void HAL_RCC_LPDMA1_DisableClock ( void )

This function disables the LPDMA1 clock.

void HAL_RCC_ADF1_DisableClock ( void )

This function disables the ADF1 clock.

void HAL_RCC_GTZC2_DisableClock ( void )

This function disables the GTZC2 clock.

void HAL_RCC_SRAM4_DisableClock ( void )

This function disables the SRAM4 clock.

Enable or disable the APB1 peripheral clock.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

void HAL_RCC_TIM2_EnableClock ( void )

This function enables the TIM2 clock.

void HAL_RCC_TIM3_EnableClock ( void )

This function enables the TIM3 clock.

void HAL_RCC_TIM4_EnableClock ( void )

This function enables the TIM4 clock.

void HAL_RCC_TIM5_EnableClock ( void )

This function enables the TIM5 clock.

void HAL_RCC_TIM6_EnableClock ( void )

This function enables the TIM6 clock.

void HAL_RCC_TIM7_EnableClock ( void )

This function enables the TIM7 clock.

void HAL_RCC_WWDG_EnableClock ( void )

This function enables the WWDG clock.

void HAL_RCC_SPI2_EnableClock ( void )

This function enables the SPI2 clock.

void HAL_RCC_USART2_EnableClock ( void )

This function enables the USART2 clock.

void HAL_RCC_USART3_EnableClock ( void )

This function enables the USART3 clock.

void HAL_RCC_UART4_EnableClock ( void )

This function enables the UART4 clock.

void HAL_RCC_UART5_EnableClock ( void )

This function enables the UART5 clock.

void HAL_RCC_I2C1_EnableClock ( void )

This function enables the I2C1 clock.

void HAL_RCC_I2C2_EnableClock ( void )

This function enables the I2C2 clock.

void HAL_RCC_CRS_EnableClock ( void )

This function enables the CRS clock.

void HAL_RCC_USART6_EnableClock ( void )

This function enables the USART6 clock.

void HAL_RCC_I2C4_EnableClock ( void )

This function enables the I2C4 clock.

void HAL_RCC_LPTIM2_EnableClock ( void )

This function enables the LPTIM2 clock.

void HAL_RCC_I2C5_EnableClock ( void )

This function enables the I2C5 clock.

void HAL_RCC_I2C6_EnableClock ( void )

This function enables the I2C6 clock.

void HAL_RCC_FDCAN_EnableClock ( void )

This function enables the FDCAN clock.

void HAL_RCC_UCPD1_EnableClock ( void )

This function enables the UCPD1 clock.

void HAL_RCC_TIM2_DisableClock ( void )

This function disables the TIM2 clock.

void HAL_RCC_TIM3_DisableClock ( void )

This function disables the TIM3 clock.

void HAL_RCC_TIM4_DisableClock ( void )

This function disables the TIM4 clock.

void HAL_RCC_TIM5_DisableClock ( void )

This function disables the TIM5 clock.

void HAL_RCC_TIM6_DisableClock ( void )

This function disables the TIM6 clock.

void HAL_RCC_TIM7_DisableClock ( void )

This function disables the TIM7 clock.

void HAL_RCC_SPI2_DisableClock ( void )

This function disables the SPI2 clock.

void HAL_RCC_USART2_DisableClock ( void )

This function disables the USART2 clock.

void HAL_RCC_USART3_DisableClock ( void )

This function disables the USART3 clock.

void HAL_RCC_UART4_DisableClock ( void )

This function disables the UART4 clock.

void HAL_RCC_UART5_DisableClock ( void )

This function disables the UART5 clock.

void HAL_RCC_I2C1_DisableClock ( void )

This function disables the I2C1 clock.

void HAL_RCC_I2C2_DisableClock ( void )

This function disables the I2C2 clock.

void HAL_RCC_CRS_DisableClock ( void )

This function disables the CRS clock.

void HAL_RCC_USART6_DisableClock ( void )

This function disables the USART6 clock.

void HAL_RCC_I2C4_DisableClock ( void )

This function disables the I2C4 clock.

void HAL_RCC_LPTIM2_DisableClock ( void )

This function disables the LPTIM2 clock.

void HAL_RCC_I2C5_DisableClock ( void )

This function disables the I2C5 clock.

void HAL_RCC_I2C6_DisableClock ( void )

This function disables the I2C6 clock.

void HAL_RCC_FDCAN_DisableClock ( void )

This function disables the FDCAN clock.

void HAL_RCC_UCPD1_DisableClock ( void )

This function disables the UCPD1 clock.

Enable or disable the APB2 peripheral clock.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

void HAL_RCC_TIM1_EnableClock ( void )

This function enables the TIM1 clock.

void HAL_RCC_SPI1_EnableClock ( void )

This function enables the SPI1 clock.

void HAL_RCC_TIM8_EnableClock ( void )

This function enables the TIM8 clock.

void HAL_RCC_USART1_EnableClock ( void )

This function enables the USART1 clock.

void HAL_RCC_TIM15_EnableClock ( void )

This function enables the TIM15 clock.

void HAL_RCC_TIM16_EnableClock ( void )

This function enables the TIM16 clock.

void HAL_RCC_TIM17_EnableClock ( void )

This function enables the TIM17 clock.

void HAL_RCC_SAI1_EnableClock ( void )

This function enables the SAI1 clock.

void HAL_RCC_SAI2_EnableClock ( void )

This function enables the SAI2 clock.

void HAL_RCC_GFXTIM_EnableClock ( void )

This function enables the GFXTIM clock.

void HAL_RCC_LTDC_EnableClock ( void )

This function enables the LTDC clock.

void HAL_RCC_DSI_EnableClock ( void )

This function enables the DSI clock.

void HAL_RCC_TIM1_DisableClock ( void )

This function disables the TIM1 clock.

void HAL_RCC_SPI1_DisableClock ( void )

This function disables the SPI1 clock.

void HAL_RCC_TIM8_DisableClock ( void )

This function disables the TIM8 clock.

void HAL_RCC_USART1_DisableClock ( void )

This function disables the USART1 clock.

void HAL_RCC_TIM15_DisableClock ( void )

This function disables the TIM15 clock.

void HAL_RCC_TIM16_DisableClock ( void )

This function disables the TIM16 clock.

void HAL_RCC_TIM17_DisableClock ( void )

This function disables the TIM17 clock.

void HAL_RCC_SAI1_DisableClock ( void )

This function disables the SAI1 clock.

void HAL_RCC_SAI2_DisableClock ( void )

This function disables the SAI2 clock.

void HAL_RCC_GFXTIM_DisableClock ( void )

This function disables the GFXTIM clock.

void HAL_RCC_LTDC_DisableClock ( void )

This function disables the LTDC clock.

void HAL_RCC_DSI_DisableClock ( void )

This function disables the DSI clock.

Enable or disable the APB3 peripheral clock.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

void HAL_RCC_SYSCFG_EnableClock ( void )

This function enables the SYSCFG clock.

void HAL_RCC_SPI3_EnableClock ( void )

This function enables the SPI3 clock.

void HAL_RCC_LPUART1_EnableClock ( void )

This function enables the LPUART1 clock.

void HAL_RCC_I2C3_EnableClock ( void )

This function enables the I2C3 clock.

void HAL_RCC_LPTIM1_EnableClock ( void )

This function enables the LPTIM1 clock.

void HAL_RCC_LPTIM3_EnableClock ( void )

This function enables the LPTIM3 clock.

void HAL_RCC_LPTIM4_EnableClock ( void )

This function enables the LPTIM4 clock.

void HAL_RCC_OPAMP_EnableClock ( void )

This function enables the OPAMP clock.

void HAL_RCC_COMP_EnableClock ( void )

This function enables the COMP clock.

void HAL_RCC_VREF_EnableClock ( void )

This function enables the VREF clock.

void HAL_RCC_RTCAPB_EnableClock ( void )

This function enables the RTCAPB clock.

void HAL_RCC_SYSCFG_DisableClock ( void )

This function disables the SYSCFG clock.

void HAL_RCC_SPI3_DisableClock ( void )

This function disables the SPI3 clock.

void HAL_RCC_LPUART1_DisableClock ( void )

This function disables the LPUART1 clock.

void HAL_RCC_I2C3_DisableClock ( void )

This function disables the I2C3 clock.

void HAL_RCC_LPTIM1_DisableClock ( void )

This function disables the LPTIM1 clock.

void HAL_RCC_LPTIM3_DisableClock ( void )

This function disables the LPTIM3 clock.

void HAL_RCC_LPTIM4_DisableClock ( void )

This function disables the LPTIM4 clock.

void HAL_RCC_OPAMP_DisableClock ( void )

This function disables the OPAMP clock.

void HAL_RCC_COMP_DisableClock ( void )

This function disables the COMP clock.

void HAL_RCC_VREF_DisableClock ( void )

This function disables the VREF clock.

void HAL_RCC_RTCAPB_DisableClock ( void )

This function disables the RTCAPB clock.

Check whether the AHB1 peripheral clock is enabled or not.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

hal_rcc_clk_status_t HAL_RCC_GPDMA1_IsEnabledClock ( void )

This function checks if the GPDMA1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPDMA1 clock is disabled

  • HAL_RCC_CLK_ENABLED – GPDMA1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_CORDIC_IsEnabledClock ( void )

This function checks if the CORDIC clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – CORDIC clock is disabled

  • HAL_RCC_CLK_ENABLED – CORDIC clock is enabled

hal_rcc_clk_status_t HAL_RCC_FMAC_IsEnabledClock ( void )

This function checks if the FMAC clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – FMAC clock is disabled

  • HAL_RCC_CLK_ENABLED – FMAC clock is enabled

hal_rcc_clk_status_t HAL_RCC_MDF1_IsEnabledClock ( void )

This function checks if the MDF1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – MDF1 clock is disabled

  • HAL_RCC_CLK_ENABLED – MDF1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_FLASH_IsEnabledClock ( void )

This function checks if the FLASH clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – FLASH clock is disabled

  • HAL_RCC_CLK_ENABLED – FLASH clock is enabled

hal_rcc_clk_status_t HAL_RCC_CRC_IsEnabledClock ( void )

This function checks if the CRC clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – CRC clock is disabled

  • HAL_RCC_CLK_ENABLED – CRC clock is enabled

hal_rcc_clk_status_t HAL_RCC_JPEG_IsEnabledClock ( void )

This function checks if the JPEG clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – JPEG clock is disabled

  • HAL_RCC_CLK_ENABLED – JPEG clock is enabled

hal_rcc_clk_status_t HAL_RCC_TSC_IsEnabledClock ( void )

This function checks if the TSC clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TSC clock is disabled

  • HAL_RCC_CLK_ENABLED – TSC clock is enabled

hal_rcc_clk_status_t HAL_RCC_RAMCFG_IsEnabledClock ( void )

This function checks if the RAMCFG clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – RAMCFG clock is disabled

  • HAL_RCC_CLK_ENABLED – RAMCFG clock is enabled

hal_rcc_clk_status_t HAL_RCC_DMA2D_IsEnabledClock ( void )

This function checks if the DMA2D clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – DMA2D clock is disabled

  • HAL_RCC_CLK_ENABLED – DMA2D clock is enabled

hal_rcc_clk_status_t HAL_RCC_GFXMMU_IsEnabledClock ( void )

This function checks if the GFXMMU clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GFXMMU clock is disabled

  • HAL_RCC_CLK_ENABLED – GFXMMU clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPU2D_IsEnabledClock ( void )

This function checks if the GPU2D clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPU2D clock is disabled

  • HAL_RCC_CLK_ENABLED – GPU2D clock is enabled

hal_rcc_clk_status_t HAL_RCC_DCACHE2_IsEnabledClock ( void )

This function checks if the DCACHE2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – DCACHE2 clock is disabled

  • HAL_RCC_CLK_ENABLED – DCACHE2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_GTZC1_IsEnabledClock ( void )

This function checks if the GTZC1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GTZC1 clock is disabled

  • HAL_RCC_CLK_ENABLED – GTZC1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_BKPSRAM_IsEnabledClock ( void )

This function checks if the BKPSRAM clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – BKPSRAM clock is disabled

  • HAL_RCC_CLK_ENABLED – BKPSRAM clock is enabled

hal_rcc_clk_status_t HAL_RCC_DCACHE1_IsEnabledClock ( void )

This function checks if the DCACHE1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – DCACHE1 clock is disabled

  • HAL_RCC_CLK_ENABLED – DCACHE1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SRAM1_IsEnabledClock ( void )

This function checks if the SRAM1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SRAM1 clock is disabled

  • HAL_RCC_CLK_ENABLED – SRAM1 clock is enabled

Check whether the AHB2 peripheral clock is enabled or not.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

hal_rcc_clk_status_t HAL_RCC_GPIOA_IsEnabledClock ( void )

This function checks if the GPIOA clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOA clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOA clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOB_IsEnabledClock ( void )

This function checks if the GPIOB clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOB clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOB clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOC_IsEnabledClock ( void )

This function checks if the GPIOC clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOC clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOC clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOD_IsEnabledClock ( void )

This function checks if the GPIOD clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOD clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOD clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOE_IsEnabledClock ( void )

This function checks if the GPIOE clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOE clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOE clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOF_IsEnabledClock ( void )

This function checks if the GPIOF clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOF clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOF clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOG_IsEnabledClock ( void )

This function checks if the GPIOG clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOG clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOG clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOH_IsEnabledClock ( void )

This function checks if the GPIOH clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOH clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOH clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOI_IsEnabledClock ( void )

This function checks if the GPIOI clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOI clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOI clock is enabled

hal_rcc_clk_status_t HAL_RCC_GPIOJ_IsEnabledClock ( void )

This function checks if the GPIOJ clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GPIOJ clock is disabled

  • HAL_RCC_CLK_ENABLED – GPIOJ clock is enabled

hal_rcc_clk_status_t HAL_RCC_ADC12_IsEnabledClock ( void )

This function checks if the ADC12 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – ADC12 clock is disabled

  • HAL_RCC_CLK_ENABLED – ADC12 clock is enabled

hal_rcc_clk_status_t HAL_RCC_DCMI_PSSI_IsEnabledClock ( void )

This function checks if the DCMI_PSSI clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – DCMI_PSSI clock is disabled

  • HAL_RCC_CLK_ENABLED – DCMI_PSSI clock is enabled

hal_rcc_clk_status_t HAL_RCC_USB_OTG_HS_IsEnabledClock ( void )

This function checks if the USB_OTG_HS clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – USB_OTG_HS clock is disabled

  • HAL_RCC_CLK_ENABLED – USB_OTG_HS clock is enabled

hal_rcc_clk_status_t HAL_RCC_USBHSPHY_IsEnabledClock ( void )

This function checks if the USBHSPHY clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – USBHSPHY clock is disabled

  • HAL_RCC_CLK_ENABLED – USBHSPHY clock is enabled

hal_rcc_clk_status_t HAL_RCC_AES_IsEnabledClock ( void )

This function checks if the AES clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – AES clock is disabled

  • HAL_RCC_CLK_ENABLED – AES clock is enabled

hal_rcc_clk_status_t HAL_RCC_HASH_IsEnabledClock ( void )

This function checks if the HASH clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – HASH clock is disabled

  • HAL_RCC_CLK_ENABLED – HASH clock is enabled

hal_rcc_clk_status_t HAL_RCC_RNG_IsEnabledClock ( void )

This function checks if the RNG clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – RNG clock is disabled

  • HAL_RCC_CLK_ENABLED – RNG clock is enabled

hal_rcc_clk_status_t HAL_RCC_PKA_IsEnabledClock ( void )

This function checks if the PKA clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – PKA clock is disabled

  • HAL_RCC_CLK_ENABLED – PKA clock is enabled

hal_rcc_clk_status_t HAL_RCC_SAES_IsEnabledClock ( void )

This function checks if the SAES clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SAES clock is disabled

  • HAL_RCC_CLK_ENABLED – SAES clock is enabled

hal_rcc_clk_status_t HAL_RCC_OCTOSPIM_IsEnabledClock ( void )

This function checks if the OCTOSPIM clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – OCTOSPIM clock is disabled

  • HAL_RCC_CLK_ENABLED – OCTOSPIM clock is enabled

hal_rcc_clk_status_t HAL_RCC_OTFDEC1_IsEnabledClock ( void )

This function checks if the OTFDEC1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – OTFDEC1 clock is disabled

  • HAL_RCC_CLK_ENABLED – OTFDEC1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_OTFDEC2_IsEnabledClock ( void )

This function checks if the OTFDEC2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – OTFDEC2 clock is disabled

  • HAL_RCC_CLK_ENABLED – OTFDEC2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SDMMC1_IsEnabledClock ( void )

This function checks if the SDMMC1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SDMMC1 clock is disabled

  • HAL_RCC_CLK_ENABLED – SDMMC1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SDMMC2_IsEnabledClock ( void )

This function checks if the SDMMC2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SDMMC2 clock is disabled

  • HAL_RCC_CLK_ENABLED – SDMMC2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SRAM2_IsEnabledClock ( void )

This function checks if the SRAM2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SRAM2 clock is disabled

  • HAL_RCC_CLK_ENABLED – SRAM2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SRAM3_IsEnabledClock ( void )

This function checks if the SRAM3 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SRAM3 clock is disabled

  • HAL_RCC_CLK_ENABLED – SRAM3 clock is enabled

hal_rcc_clk_status_t HAL_RCC_FSMC_IsEnabledClock ( void )

This function checks if the FSMC clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – FSMC clock is disabled

  • HAL_RCC_CLK_ENABLED – FSMC clock is enabled

hal_rcc_clk_status_t HAL_RCC_OCTOSPI1_IsEnabledClock ( void )

This function checks if the OCTOSPI1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – OCTOSPI1 clock is disabled

  • HAL_RCC_CLK_ENABLED – OCTOSPI1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_OCTOSPI2_IsEnabledClock ( void )

This function checks if the OCTOSPI2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – OCTOSPI2 clock is disabled

  • HAL_RCC_CLK_ENABLED – OCTOSPI2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_HSPI1_IsEnabledClock ( void )

This function checks if the HSPI1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – HSPI1 clock is disabled

  • HAL_RCC_CLK_ENABLED – HSPI1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SRAM6_IsEnabledClock ( void )

This function checks if the SRAM6 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SRAM6 clock is disabled

  • HAL_RCC_CLK_ENABLED – SRAM6 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SRAM5_IsEnabledClock ( void )

This function checks if the SRAM5 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SRAM5 clock is disabled

  • HAL_RCC_CLK_ENABLED – SRAM5 clock is enabled

Check whether the AHB3 peripheral clock is enabled or not.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

hal_rcc_clk_status_t HAL_RCC_LPGPIO1_IsEnabledClock ( void )

This function checks if the LPGPIO1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LPGPIO1 clock is disabled

  • HAL_RCC_CLK_ENABLED – LPGPIO1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_PWR_IsEnabledClock ( void )

This function checks if the PWR clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – PWR clock is disabled

  • HAL_RCC_CLK_ENABLED – PWR clock is enabled

hal_rcc_clk_status_t HAL_RCC_ADC4_IsEnabledClock ( void )

This function checks if the ADC4 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – ADC4 clock is disabled

  • HAL_RCC_CLK_ENABLED – ADC4 clock is enabled

hal_rcc_clk_status_t HAL_RCC_DAC1_IsEnabledClock ( void )

This function checks if the DAC1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – DAC1 clock is disabled

  • HAL_RCC_CLK_ENABLED – DAC1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_LPDMA1_IsEnabledClock ( void )

This function checks if the LPDMA1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LPDMA1 clock is disabled

  • HAL_RCC_CLK_ENABLED – LPDMA1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_ADF1_IsEnabledClock ( void )

This function checks if the ADF1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – ADF1 clock is disabled

  • HAL_RCC_CLK_ENABLED – ADF1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_GTZC2_IsEnabledClock ( void )

This function checks if the GTZC2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GTZC2 clock is disabled

  • HAL_RCC_CLK_ENABLED – GTZC2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SRAM4_IsEnabledClock ( void )

This function checks if the SRAM4 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SRAM4 clock is disabled

  • HAL_RCC_CLK_ENABLED – SRAM4 clock is enabled

Check whether the APB1 peripheral clock is enabled or not.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

hal_rcc_clk_status_t HAL_RCC_TIM2_IsEnabledClock ( void )

This function checks if the TIM2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM2 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM3_IsEnabledClock ( void )

This function checks if the TIM3 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM3 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM3 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM4_IsEnabledClock ( void )

This function checks if the TIM4 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM4 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM4 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM5_IsEnabledClock ( void )

This function checks if the TIM5 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM5 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM5 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM6_IsEnabledClock ( void )

This function checks if the TIM6 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM6 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM6 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM7_IsEnabledClock ( void )

This function checks if the TIM7 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM7 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM7 clock is enabled

hal_rcc_clk_status_t HAL_RCC_WWDG_IsEnabledClock ( void )

This function checks if the WWDG clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – WWDG clock is disabled

  • HAL_RCC_CLK_ENABLED – WWDG clock is enabled

hal_rcc_clk_status_t HAL_RCC_SPI2_IsEnabledClock ( void )

This function checks if the SPI2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SPI2 clock is disabled

  • HAL_RCC_CLK_ENABLED – SPI2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_USART2_IsEnabledClock ( void )

This function checks if the USART2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – USART2 clock is disabled

  • HAL_RCC_CLK_ENABLED – USART2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_USART3_IsEnabledClock ( void )

This function checks if the USART3 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – USART3 clock is disabled

  • HAL_RCC_CLK_ENABLED – USART3 clock is enabled

hal_rcc_clk_status_t HAL_RCC_UART4_IsEnabledClock ( void )

This function checks if the UART4 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – UART4 clock is disabled

  • HAL_RCC_CLK_ENABLED – UART4 clock is enabled

hal_rcc_clk_status_t HAL_RCC_UART5_IsEnabledClock ( void )

This function checks if the UART5 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – UART5 clock is disabled

  • HAL_RCC_CLK_ENABLED – UART5 clock is enabled

hal_rcc_clk_status_t HAL_RCC_I2C1_IsEnabledClock ( void )

This function checks if the I2C1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – I2C1 clock is disabled

  • HAL_RCC_CLK_ENABLED – I2C1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_I2C2_IsEnabledClock ( void )

This function checks if the I2C2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – I2C2 clock is disabled

  • HAL_RCC_CLK_ENABLED – I2C2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_CRS_IsEnabledClock ( void )

This function checks if the CRS clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – CRS clock is disabled

  • HAL_RCC_CLK_ENABLED – CRS clock is enabled

hal_rcc_clk_status_t HAL_RCC_USART6_IsEnabledClock ( void )

This function checks if the USART6 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – USART6 clock is disabled

  • HAL_RCC_CLK_ENABLED – USART6 clock is enabled

hal_rcc_clk_status_t HAL_RCC_I2C4_IsEnabledClock ( void )

This function checks if the I2C4 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – I2C4 clock is disabled

  • HAL_RCC_CLK_ENABLED – I2C4 clock is enabled

hal_rcc_clk_status_t HAL_RCC_LPTIM2_IsEnabledClock ( void )

This function checks if the LPTIM2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LPTIM2 clock is disabled

  • HAL_RCC_CLK_ENABLED – LPTIM2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_I2C5_IsEnabledClock ( void )

This function checks if the I2C5 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – I2C5 clock is disabled

  • HAL_RCC_CLK_ENABLED – I2C5 clock is enabled

hal_rcc_clk_status_t HAL_RCC_I2C6_IsEnabledClock ( void )

This function checks if the I2C6 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – I2C6 clock is disabled

  • HAL_RCC_CLK_ENABLED – I2C6 clock is enabled

hal_rcc_clk_status_t HAL_RCC_FDCAN_IsEnabledClock ( void )

This function checks if the FDCAN clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – FDCAN clock is disabled

  • HAL_RCC_CLK_ENABLED – FDCAN clock is enabled

hal_rcc_clk_status_t HAL_RCC_UCPD1_IsEnabledClock ( void )

This function checks if the UCPD1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – UCPD1 clock is disabled

  • HAL_RCC_CLK_ENABLED – UCPD1 clock is enabled

Check whether the APB2 peripheral clock is enabled or not.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

hal_rcc_clk_status_t HAL_RCC_TIM1_IsEnabledClock ( void )

This function checks if the TIM1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM1 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SPI1_IsEnabledClock ( void )

This function checks if the SPI1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SPI1 clock is disabled

  • HAL_RCC_CLK_ENABLED – SPI1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM8_IsEnabledClock ( void )

This function checks if the TIM8 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM8 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM8 clock is enabled

hal_rcc_clk_status_t HAL_RCC_USART1_IsEnabledClock ( void )

This function checks if the USART1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – USART1 clock is disabled

  • HAL_RCC_CLK_ENABLED – USART1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM15_IsEnabledClock ( void )

This function checks if the TIM15 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM15 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM15 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM16_IsEnabledClock ( void )

This function checks if the TIM16 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM16 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM16 clock is enabled

hal_rcc_clk_status_t HAL_RCC_TIM17_IsEnabledClock ( void )

This function checks if the TIM17 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – TIM17 clock is disabled

  • HAL_RCC_CLK_ENABLED – TIM17 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SAI1_IsEnabledClock ( void )

This function checks if the SAI1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SAI1 clock is disabled

  • HAL_RCC_CLK_ENABLED – SAI1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_SAI2_IsEnabledClock ( void )

This function checks if the SAI2 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SAI2 clock is disabled

  • HAL_RCC_CLK_ENABLED – SAI2 clock is enabled

hal_rcc_clk_status_t HAL_RCC_GFXTIM_IsEnabledClock ( void )

This function checks if the GFXTIM clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – GFXTIM clock is disabled

  • HAL_RCC_CLK_ENABLED – GFXTIM clock is enabled

hal_rcc_clk_status_t HAL_RCC_LTDC_IsEnabledClock ( void )

This function checks if the LTDC clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LTDC clock is disabled

  • HAL_RCC_CLK_ENABLED – LTDC clock is enabled

hal_rcc_clk_status_t HAL_RCC_DSI_IsEnabledClock ( void )

This function checks if the DSI clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – DSI clock is disabled

  • HAL_RCC_CLK_ENABLED – DSI clock is enabled

Check whether the APB3 peripheral clock is enabled or not.

Note

After reset, the peripheral clock (used for registers read/write access) is disabled and the application software has to enable this clock before using it.

Functions

hal_rcc_clk_status_t HAL_RCC_SYSCFG_IsEnabledClock ( void )

This function checks if the SYSCFG clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SYSCFG clock is disabled

  • HAL_RCC_CLK_ENABLED – SYSCFG clock is enabled

hal_rcc_clk_status_t HAL_RCC_SPI3_IsEnabledClock ( void )

This function checks if the SPI3 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – SPI3 clock is disabled

  • HAL_RCC_CLK_ENABLED – SPI3 clock is enabled

hal_rcc_clk_status_t HAL_RCC_LPUART1_IsEnabledClock ( void )

This function checks if the LPUART1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LPUART1 clock is disabled

  • HAL_RCC_CLK_ENABLED – LPUART1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_I2C3_IsEnabledClock ( void )

This function checks if the I2C3 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – I2C3 clock is disabled

  • HAL_RCC_CLK_ENABLED – I2C3 clock is enabled

hal_rcc_clk_status_t HAL_RCC_LPTIM1_IsEnabledClock ( void )

This function checks if the LPTIM1 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LPTIM1 clock is disabled

  • HAL_RCC_CLK_ENABLED – LPTIM1 clock is enabled

hal_rcc_clk_status_t HAL_RCC_LPTIM3_IsEnabledClock ( void )

This function checks if the LPTIM3 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LPTIM3 clock is disabled

  • HAL_RCC_CLK_ENABLED – LPTIM3 clock is enabled

hal_rcc_clk_status_t HAL_RCC_LPTIM4_IsEnabledClock ( void )

This function checks if the LPTIM4 clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – LPTIM4 clock is disabled

  • HAL_RCC_CLK_ENABLED – LPTIM4 clock is enabled

hal_rcc_clk_status_t HAL_RCC_OPAMP_IsEnabledClock ( void )

This function checks if the OPAMP clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – OPAMP clock is disabled

  • HAL_RCC_CLK_ENABLED – OPAMP clock is enabled

hal_rcc_clk_status_t HAL_RCC_COMP_IsEnabledClock ( void )

This function checks if the COMP clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – COMP clock is disabled

  • HAL_RCC_CLK_ENABLED – COMP clock is enabled

hal_rcc_clk_status_t HAL_RCC_VREF_IsEnabledClock ( void )

This function checks if the VREF clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – VREF clock is disabled

  • HAL_RCC_CLK_ENABLED – VREF clock is enabled

hal_rcc_clk_status_t HAL_RCC_RTCAPB_IsEnabledClock ( void )

This function checks if the RTCAPB clock is enabled.

Return values :

  • HAL_RCC_CLK_DISABLED – RTCAPB clock is disabled

  • HAL_RCC_CLK_ENABLED – RTCAPB clock is enabled

AHB1 peripheral reset.

Functions

void HAL_RCC_GPDMA1_Reset ( void )

This function resets the GPDMA1 peripheral.

void HAL_RCC_CORDIC_Reset ( void )

This function resets the CORDIC peripheral.

void HAL_RCC_FMAC_Reset ( void )

This function resets the FMAC peripheral.

void HAL_RCC_MDF1_Reset ( void )

This function resets the MDF1 peripheral.

void HAL_RCC_CRC_Reset ( void )

This function resets the CRC peripheral.

void HAL_RCC_JPEG_Reset ( void )

This function resets the JPEG peripheral.

void HAL_RCC_TSC_Reset ( void )

This function resets the TSC peripheral.

void HAL_RCC_RAMCFG_Reset ( void )

This function resets the RAMCFG peripheral.

void HAL_RCC_DMA2D_Reset ( void )

This function resets the DMA2D peripheral.

void HAL_RCC_GFXMMU_Reset ( void )

This function resets the GFXMMU peripheral.

void HAL_RCC_GPU2D_Reset ( void )

This function resets the GPU2D peripheral.

AHB2 peripheral reset.

Functions

void HAL_RCC_GPIOA_Reset ( void )

This function resets the GPIOA peripheral.

void HAL_RCC_GPIOB_Reset ( void )

This function resets the GPIOB peripheral.

void HAL_RCC_GPIOC_Reset ( void )

This function resets the GPIOC peripheral.

void HAL_RCC_GPIOD_Reset ( void )

This function resets the GPIOD peripheral.

void HAL_RCC_GPIOE_Reset ( void )

This function resets the GPIOE peripheral.

void HAL_RCC_GPIOF_Reset ( void )

This function resets the GPIOF peripheral.

void HAL_RCC_GPIOG_Reset ( void )

This function resets the GPIOG peripheral.

void HAL_RCC_GPIOH_Reset ( void )

This function resets the GPIOH peripheral.

void HAL_RCC_GPIOI_Reset ( void )

This function resets the GPIOI peripheral.

void HAL_RCC_GPIOJ_Reset ( void )

This function resets the GPIOJ peripheral.

void HAL_RCC_ADC12_Reset ( void )

This function resets the ADC12 peripheral.

void HAL_RCC_DCMI_PSSI_Reset ( void )

This function resets the DCMI_PSSI peripheral.

void HAL_RCC_USB_OTG_HS_Reset ( void )

This function resets the USB_OTG_HS peripheral.

void HAL_RCC_AES_Reset ( void )

This function resets the AES peripheral.

void HAL_RCC_HASH_Reset ( void )

This function resets the HASH peripheral.

void HAL_RCC_RNG_Reset ( void )

This function resets the RNG peripheral.

void HAL_RCC_PKA_Reset ( void )

This function resets the PKA peripheral.

void HAL_RCC_SAES_Reset ( void )

This function resets the SAES peripheral.

void HAL_RCC_OCTOSPIM_Reset ( void )

This function resets the OCTOSPIM peripheral.

void HAL_RCC_OTFDEC1_Reset ( void )

This function resets the OTFDEC1 peripheral.

void HAL_RCC_OTFDEC2_Reset ( void )

This function resets the OTFDEC2 peripheral.

void HAL_RCC_SDMMC1_Reset ( void )

This function resets the SDMMC1 peripheral.

void HAL_RCC_SDMMC2_Reset ( void )

This function resets the SDMMC2 peripheral.

void HAL_RCC_FSMC_Reset ( void )

This function resets the FMSC peripheral.

void HAL_RCC_OCTOSPI1_Reset ( void )

This function resets the OCTOSPI1 peripheral.

void HAL_RCC_OCTOSPI2_Reset ( void )

This function resets the OCTOSPI2 peripheral.

void HAL_RCC_HSPI1_Reset ( void )

This function resets the HSPI1 peripheral.

AHB3 peripheral reset.

Functions

void HAL_RCC_LPGPIO1_Reset ( void )

This function resets the LPGPIO1 peripheral.

void HAL_RCC_ADC4_Reset ( void )

This function resets the ADC4 peripheral.

void HAL_RCC_DAC1_Reset ( void )

This function resets the DAC1 peripheral.

void HAL_RCC_LPDMA1_Reset ( void )

This function resets the LPDMA1 peripheral.

void HAL_RCC_ADF1_Reset ( void )

This function resets the ADF1 peripheral.

APB1 peripheral reset.

Functions

void HAL_RCC_TIM2_Reset ( void )

This function resets the TIM2 peripheral.

void HAL_RCC_TIM3_Reset ( void )

This function resets the TIM3 peripheral.

void HAL_RCC_TIM4_Reset ( void )

This function resets the TIM4 peripheral.

void HAL_RCC_TIM5_Reset ( void )

This function resets the TIM5 peripheral.

void HAL_RCC_TIM6_Reset ( void )

This function resets the TIM6 peripheral.

void HAL_RCC_TIM7_Reset ( void )

This function resets the TIM7 peripheral.

void HAL_RCC_SPI2_Reset ( void )

This function resets the SPI2 peripheral.

void HAL_RCC_USART2_Reset ( void )

This function resets the USART2 peripheral.

void HAL_RCC_USART3_Reset ( void )

This function resets the USART3 peripheral.

void HAL_RCC_UART4_Reset ( void )

This function resets the UART4 peripheral.

void HAL_RCC_UART5_Reset ( void )

This function resets the UART5 peripheral.

void HAL_RCC_I2C1_Reset ( void )

This function resets the I2C1 peripheral.

void HAL_RCC_I2C2_Reset ( void )

This function resets the I2C2 peripheral.

void HAL_RCC_CRS_Reset ( void )

This function resets the CRS peripheral.

void HAL_RCC_USART6_Reset ( void )

This function resets the USART6 peripheral.

void HAL_RCC_I2C4_Reset ( void )

This function resets the I2C4 peripheral.

void HAL_RCC_LPTIM2_Reset ( void )

This function resets the LPTIM2 peripheral.

void HAL_RCC_I2C5_Reset ( void )

This function resets the I2C5 peripheral.

void HAL_RCC_I2C6_Reset ( void )

This function resets the I2C6 peripheral.

void HAL_RCC_FDCAN_Reset ( void )

This function resets the FDCAN peripheral.

void HAL_RCC_UCPD1_Reset ( void )

This function resets the UCPD1 peripheral.

APB2 peripheral reset.

Functions

void HAL_RCC_TIM1_Reset ( void )

This function resets the TIM1 peripheral.

void HAL_RCC_SPI1_Reset ( void )

This function resets the SPI1 peripheral.

void HAL_RCC_TIM8_Reset ( void )

This function resets the TIM8 peripheral.

void HAL_RCC_USART1_Reset ( void )

This function resets the USART1 peripheral.

void HAL_RCC_TIM15_Reset ( void )

This function resets the TIM15 peripheral.

void HAL_RCC_TIM16_Reset ( void )

This function resets the TIM16 peripheral.

void HAL_RCC_TIM17_Reset ( void )

This function resets the TIM17 peripheral.

void HAL_RCC_SAI1_Reset ( void )

This function resets the SAI1 peripheral.

void HAL_RCC_SAI2_Reset ( void )

This function resets the SAI2 peripheral.

void HAL_RCC_GFXTIM_Reset ( void )

This function resets the GFXTIM peripheral.

void HAL_RCC_LTDC_Reset ( void )

This function resets the LTDC peripheral.

void HAL_RCC_DSI_Reset ( void )

This function resets the DSI peripheral.

APB3 peripheral reset.

Functions

void HAL_RCC_SYSCFG_Reset ( void )

This function resets the SYSCFG peripheral.

void HAL_RCC_SPI3_Reset ( void )

This function resets the SPI3 peripheral.

void HAL_RCC_LPUART1_Reset ( void )

This function resets the LPUART1 peripheral.

void HAL_RCC_I2C3_Reset ( void )

This function resets the I2C3 peripheral.

void HAL_RCC_LPTIM1_Reset ( void )

This function resets the LPTIM1 peripheral.

void HAL_RCC_LPTIM3_Reset ( void )

This function resets the LPTIM3 peripheral.

void HAL_RCC_LPTIM4_Reset ( void )

This function resets the LPTIM4 peripheral.

void HAL_RCC_OPAMP_Reset ( void )

This function resets the OPAMP peripheral.

void HAL_RCC_COMP_Reset ( void )

This function resets the COMP peripheral.

void HAL_RCC_VREF_Reset ( void )

This function resets the VREF peripheral.

Enable or disable the AHB1 peripheral clock during Low Power (Sleep and Stop) mode.

Note

Peripheral clock gating in SLEEP and STOP modes can be used to further reduce power consumption.

Note

After wakeup from SLEEP or STOP modes, the peripheral clock is enabled again.

Note

By default, all peripheral clocks are enabled during SLEEP mode,in STOP mode peripheral clock is enabled only when a peripheral requests AHB clock.

Functions

void HAL_RCC_LP_GPDMA1_EnableClockInSleepMode ( void )

This function enables the GPDMA1 clock in sleep mode.

void HAL_RCC_LP_GPDMA1_EnableClockInStopMode ( void )

This function enables the GPDMA1 clock in stop mode.

void HAL_RCC_LP_CORDIC_EnableClockInSleepMode ( void )

This function enables the CORDIC clock in sleep mode.

void HAL_RCC_LP_FMAC_EnableClockInSleepMode ( void )

This function enables the FMAC clock in sleep mode.

void HAL_RCC_LP_MDF1_EnableClockInSleepMode ( void )

This function enables the MDF1 clock in sleep mode.

void HAL_RCC_LP_MDF1_EnableClockInStopMode ( void )

This function enables the MDF1 clock in stop mode.

void HAL_RCC_LP_FLASH_EnableClockInSleepMode ( void )

This function enables the FLASH clock in sleep mode.

void HAL_RCC_LP_CRC_EnableClockInSleepMode ( void )

This function enables the CRC clock in sleep mode.

void HAL_RCC_LP_JPEG_EnableClockInSleepMode ( void )

This function enables the JPEG clock in sleep mode.

void HAL_RCC_LP_TSC_EnableClockInSleepMode ( void )

This function enables the TSC clock in sleep mode.

void HAL_RCC_LP_RAMCFG_EnableClockInSleepMode ( void )

This function enables the RAMCFG clock in sleep mode.

void HAL_RCC_LP_DMA2D_EnableClockInSleepMode ( void )

This function enables the DMA2D clock in sleep mode.

void HAL_RCC_LP_GFXMMU_EnableClockInSleepMode ( void )

This function enables the GFXMMU clock in sleep mode.

void HAL_RCC_LP_GPU2D_EnableClockInSleepMode ( void )

This function enables the GPU2D clock in sleep mode.

void HAL_RCC_LP_DCACHE2_EnableClockInSleepMode ( void )

This function enables the DCACHE2 clock in sleep mode.

void HAL_RCC_LP_GTZC1_EnableClockInSleepMode ( void )

This function enables the GTZC1 clock in sleep mode.

void HAL_RCC_LP_BKPSRAM_EnableClockInSleepMode ( void )

This function enables the BKPSRAM clock in sleep mode.

void HAL_RCC_LP_BKPSRAM_EnableClockInStopMode ( void )

This function enables the BKPSRAM clock in stop mode.

void HAL_RCC_LP_ICACHE1_EnableClockInSleepMode ( void )

This function enables the ICACHE1 clock in sleep mode.

void HAL_RCC_LP_DCACHE1_EnableClockInSleepMode ( void )

This function enables the DCACHE1 clock in sleep mode.

void HAL_RCC_LP_SRAM1_EnableClockInSleepMode ( void )

This function enables the SRAM1 clock in sleep mode.

void HAL_RCC_LP_SRAM1_EnableClockInStopMode ( void )

This function enables the SRAM1 clock in stop mode.

void HAL_RCC_LP_GPDMA1_DisableClockInSleepMode ( void )

This function disables the GPDMA1 clock in sleep mode.

void HAL_RCC_LP_GPDMA1_DisableClockInStopMode ( void )

This function disables the GPDMA1 clock in stop mode.

void HAL_RCC_LP_CORDIC_DisableClockInSleepMode ( void )

This function disables the CORDIC clock in sleep mode.

void HAL_RCC_LP_FMAC_DisableClockInSleepMode ( void )

This function disables the FMAC clock in sleep mode.

void HAL_RCC_LP_MDF1_DisableClockInSleepMode ( void )

This function disables the MDF1 clock in sleep mode.

void HAL_RCC_LP_MDF1_DisableClockInStopMode ( void )

This function disables the MDF1 clock in stop mode.

void HAL_RCC_LP_FLASH_DisableClockInSleepMode ( void )

This function disables the FLASH clock in sleep mode.

void HAL_RCC_LP_CRC_DisableClockInSleepMode ( void )

This function disables the CRC clock in sleep mode.

void HAL_RCC_LP_JPEG_DisableClockInSleepMode ( void )

This function disables the JPEG clock in sleep mode.

void HAL_RCC_LP_TSC_DisableClockInSleepMode ( void )

This function disables the TSC clock in sleep mode.

void HAL_RCC_LP_RAMCFG_DisableClockInSleepMode ( void )

This function disables the RAMCFG clock in sleep mode.

void HAL_RCC_LP_DMA2D_DisableClockInSleepMode ( void )

This function disables the DMA2D clock in sleep mode.

void HAL_RCC_LP_GFXMMU_DisableClockInSleepMode ( void )

This function disables the GFXMMU clock in sleep mode.

void HAL_RCC_LP_GPU2D_DisableClockInSleepMode ( void )

This function disables the GPU2D clock in sleep mode.

void HAL_RCC_LP_DCACHE2_DisableClockInSleepMode ( void )

This function disables the DCACHE2 clock in sleep mode.

void HAL_RCC_LP_GTZC1_DisableClockInSleepMode ( void )

This function disables the GTZC1 clock in sleep mode.

void HAL_RCC_LP_BKPSRAM_DisableClockInSleepMode ( void )

This function disables the BKPSRAM clock in sleep mode.

void HAL_RCC_LP_BKPSRAM_DisableClockInStopMode ( void )

This function disables the BKPSRAM clock in stop mode.

void HAL_RCC_LP_ICACHE1_DisableClockInSleepMode ( void )

This function disables the ICACHE1 clock in sleep mode.

void HAL_RCC_LP_DCACHE1_DisableClockInSleepMode ( void )

This function disables the DCACHE1 clock in sleep mode.

void HAL_RCC_LP_SRAM1_DisableClockInSleepMode ( void )

This function disables the SRAM1 clock in sleep mode.

void HAL_RCC_LP_SRAM1_DisableClockInStopMode ( void )

This function disables the SRAM1 clock in stop mode.

Enable or disable the AHB2 peripheral clock during Low Power (Sleep and Stop) mode.

Note

Peripheral clock gating in SLEEP and STOP modes can be used to further reduce power consumption.

Note

After wakeup from SLEEP or STOP modes, the peripheral clock is enabled again.

Note

By default, all peripheral clocks are enabled during SLEEP mode,in STOP mode peripheral clock is enabled only when a peripheral requests AHB clock.

Functions

void HAL_RCC_LP_GPIOA_EnableClockInSleepMode ( void )

This function enables the GPIOA clock in sleep mode.

void HAL_RCC_LP_GPIOA_EnableClockInStopMode ( void )

This function enables the GPIOA clock in stop mode.

void HAL_RCC_LP_GPIOB_EnableClockInSleepMode ( void )

This function enables the GPIOB clock in sleep mode.

void HAL_RCC_LP_GPIOB_EnableClockInStopMode ( void )

This function enables the GPIOB clock in stop mode.

void HAL_RCC_LP_GPIOC_EnableClockInSleepMode ( void )

This function enables the GPIOC clock in sleep mode.

void HAL_RCC_LP_GPIOC_EnableClockInStopMode ( void )

This function enables the GPIOC clock in stop mode.

void HAL_RCC_LP_GPIOD_EnableClockInSleepMode ( void )

This function enables the GPIOD clock in sleep mode.

void HAL_RCC_LP_GPIOD_EnableClockInStopMode ( void )

This function enables the GPIOD clock in stop mode.

void HAL_RCC_LP_GPIOE_EnableClockInSleepMode ( void )

This function enables the GPIOE clock in sleep mode.

void HAL_RCC_LP_GPIOE_EnableClockInStopMode ( void )

This function enables the GPIOE clock in stop mode.

void HAL_RCC_LP_GPIOF_EnableClockInSleepMode ( void )

This function enables the GPIOF clock in sleep mode.

void HAL_RCC_LP_GPIOF_EnableClockInStopMode ( void )

This function enables the GPIOF clock in stop mode.

void HAL_RCC_LP_GPIOG_EnableClockInSleepMode ( void )

This function enables the GPIOG clock in sleep mode.

void HAL_RCC_LP_GPIOG_EnableClockInStopMode ( void )

This function enables the GPIOG clock in stop mode.

void HAL_RCC_LP_GPIOH_EnableClockInSleepMode ( void )

This function enables the GPIOH clock in sleep mode.

void HAL_RCC_LP_GPIOH_EnableClockInStopMode ( void )

This function enables the GPIOH clock in stop mode.

void HAL_RCC_LP_GPIOI_EnableClockInSleepMode ( void )

This function enables the GPIOI clock in sleep mode.

void HAL_RCC_LP_GPIOI_EnableClockInStopMode ( void )

This function enables the GPIOI clock in stop mode.

void HAL_RCC_LP_GPIOJ_EnableClockInSleepMode ( void )

This function enables the GPIOJ clock in sleep mode.

void HAL_RCC_LP_GPIOJ_EnableClockInStopMode ( void )

This function enables the GPIOJ clock in stop mode.

void HAL_RCC_LP_ADC12_EnableClockInSleepMode ( void )

This function enables the ADC12 clock in sleep mode.

void HAL_RCC_LP_DCMI_PSSI_EnableClockInSleepMode ( void )

This function enables the DCMI_PSSI clock in sleep mode.

void HAL_RCC_LP_USB_OTG_HS_EnableClockInSleepMode ( void )

This function enables the USB_OTG_HS clock in sleep mode.

void HAL_RCC_LP_USBHSPHY_EnableClockInSleepMode ( void )

This function enables the USBHSPHY clock in sleep mode.

void HAL_RCC_LP_AES_EnableClockInSleepMode ( void )

This function enables the AES clock in sleep mode.

void HAL_RCC_LP_HASH_EnableClockInSleepMode ( void )

This function enables the HASH clock in sleep mode.

void HAL_RCC_LP_RNG_EnableClockInSleepMode ( void )

This function enables the RNG clock in sleep mode.

void HAL_RCC_LP_PKA_EnableClockInSleepMode ( void )

This function enables the PKA clock in sleep mode.

void HAL_RCC_LP_SAES_EnableClockInSleepMode ( void )

This function enables the SAES clock in sleep mode.

void HAL_RCC_LP_OCTOSPIM_EnableClockInSleepMode ( void )

This function enables the OCTOSPIM clock in sleep mode.

void HAL_RCC_LP_OTFDEC1_EnableClockInSleepMode ( void )

This function enables the OTFDEC1 clock in sleep mode.

void HAL_RCC_LP_OTFDEC2_EnableClockInSleepMode ( void )

This function enables the OTFDEC2 clock in sleep mode.

void HAL_RCC_LP_SDMMC1_EnableClockInSleepMode ( void )

This function enables the SDMMC1 clock in sleep mode.

void HAL_RCC_LP_SDMMC2_EnableClockInSleepMode ( void )

This function enables the SDMMC2 clock in sleep mode.

void HAL_RCC_LP_SRAM2_EnableClockInSleepMode ( void )

This function enables the SRAM2 clock in sleep mode.

void HAL_RCC_LP_SRAM2_EnableClockInStopMode ( void )

This function enables the SRAM2 clock in stop mode.

void HAL_RCC_LP_SRAM3_EnableClockInSleepMode ( void )

This function enables the SRAM3 clock in sleep mode.

void HAL_RCC_LP_SRAM3_EnableClockInStopMode ( void )

This function enables the SRAM3 clock in stop mode.

void HAL_RCC_LP_FSMC_EnableClockInSleepMode ( void )

This function enables the FSMC clock in sleep mode.

void HAL_RCC_LP_OCTOSPI1_EnableClockInSleepMode ( void )

This function enables the OCTOSPI1 clock in sleep mode.

void HAL_RCC_LP_OCTOSPI2_EnableClockInSleepMode ( void )

This function enables the OCTOSPI2 clock in sleep mode.

void HAL_RCC_LP_HSPI1_EnableClockInSleepMode ( void )

This function enables the HSPI1 clock in sleep mode.

void HAL_RCC_LP_SRAM6_EnableClockInSleepMode ( void )

This function enables the SRAM6 clock in sleep mode.

void HAL_RCC_LP_SRAM6_EnableClockInStopMode ( void )

This function enables the SRAM6 clock in stop mode.

void HAL_RCC_LP_SRAM5_EnableClockInSleepMode ( void )

This function enables the SRAM5 clock in sleep mode.

void HAL_RCC_LP_SRAM5_EnableClockInStopMode ( void )

This function enables the SRAM5 clock in stop mode.

void HAL_RCC_LP_GPIOA_DisableClockInSleepMode ( void )

This function disables the GPIOA clock in sleep mode.

void HAL_RCC_LP_GPIOA_DisableClockInStopMode ( void )

This function disables the GPIOA clock in stop mode.

void HAL_RCC_LP_GPIOB_DisableClockInSleepMode ( void )

This function disables the GPIOB clock in sleep mode.

void HAL_RCC_LP_GPIOB_DisableClockInStopMode ( void )

This function disables the GPIOB clock in stop mode.

void HAL_RCC_LP_GPIOC_DisableClockInSleepMode ( void )

This function disables the GPIOC clock in sleep mode.

void HAL_RCC_LP_GPIOC_DisableClockInStopMode ( void )

This function disables the GPIOC clock in stop mode.

void HAL_RCC_LP_GPIOD_DisableClockInSleepMode ( void )

This function disables the GPIOD clock in sleep mode.

void HAL_RCC_LP_GPIOD_DisableClockInStopMode ( void )

This function disables the GPIOD clock in stop mode.

void HAL_RCC_LP_GPIOE_DisableClockInSleepMode ( void )

This function disables the GPIOE clock in sleep mode.

void HAL_RCC_LP_GPIOE_DisableClockInStopMode ( void )

This function disables the GPIOE clock in stop mode.

void HAL_RCC_LP_GPIOF_DisableClockInSleepMode ( void )

This function disables the GPIOF clock in sleep mode.

void HAL_RCC_LP_GPIOF_DisableClockInStopMode ( void )

This function disables the GPIOF clock in stop mode.

void HAL_RCC_LP_GPIOG_DisableClockInSleepMode ( void )

This function disables the GPIOG clock in sleep mode.

void HAL_RCC_LP_GPIOG_DisableClockInStopMode ( void )

This function disables the GPIOG clock in stop mode.

void HAL_RCC_LP_GPIOH_DisableClockInSleepMode ( void )

This function disables the GPIOH clock in sleep mode.

void HAL_RCC_LP_GPIOH_DisableClockInStopMode ( void )

This function disables the GPIOH clock in stop mode.

void HAL_RCC_LP_GPIOI_DisableClockInSleepMode ( void )

This function disables the GPIOI clock in sleep mode.

void HAL_RCC_LP_GPIOI_DisableClockInStopMode ( void )

This function disables the GPIOI clock in stop mode.

void HAL_RCC_LP_GPIOJ_DisableClockInSleepMode ( void )

This function disables the GPIOJ clock in sleep mode.

void HAL_RCC_LP_GPIOJ_DisableClockInStopMode ( void )

This function disables the GPIOJ clock in stop mode.

void HAL_RCC_LP_ADC12_DisableClockInSleepMode ( void )

This function disables the ADC12 clock in sleep mode.

void HAL_RCC_LP_DCMI_PSSI_DisableClockInSleepMode ( void )

This function disables the DCMI_PSSI clock in sleep mode.

void HAL_RCC_LP_USB_OTG_HS_DisableClockInSleepMode ( void )

This function disables the USB_OTG_HS clock in sleep mode.

void HAL_RCC_LP_USBHSPHY_DisableClockInSleepMode ( void )

This function disables the USBHSPHY clock in sleep mode.

void HAL_RCC_LP_AES_DisableClockInSleepMode ( void )

This function disables the AES clock in sleep mode.

void HAL_RCC_LP_HASH_DisableClockInSleepMode ( void )

This function disables the HASH clock in sleep mode.

void HAL_RCC_LP_RNG_DisableClockInSleepMode ( void )

This function disables the RNG clock in sleep mode.

void HAL_RCC_LP_PKA_DisableClockInSleepMode ( void )

This function disables the PKA clock in sleep mode.

void HAL_RCC_LP_SAES_DisableClockInSleepMode ( void )

This function disables the SAES clock in sleep mode.

void HAL_RCC_LP_OCTOSPIM_DisableClockInSleepMode ( void )

This function disables the OCTOSPIM clock in sleep mode.

void HAL_RCC_LP_OTFDEC1_DisableClockInSleepMode ( void )

This function disables the OTFDEC1 clock in sleep mode.

void HAL_RCC_LP_OTFDEC2_DisableClockInSleepMode ( void )

This function disables the OTFDEC2 clock in sleep mode.

void HAL_RCC_LP_SDMMC1_DisableClockInSleepMode ( void )

This function disables the SDMMC1 clock in sleep mode.

void HAL_RCC_LP_SDMMC2_DisableClockInSleepMode ( void )

This function disables the SDMMC2 clock in sleep mode.

void HAL_RCC_LP_SRAM2_DisableClockInSleepMode ( void )

This function disables the SRAM2 clock in sleep mode.

void HAL_RCC_LP_SRAM2_DisableClockInStopMode ( void )

This function disables the SRAM2 clock in stop mode.

void HAL_RCC_LP_SRAM3_DisableClockInSleepMode ( void )

This function disables the SRAM3 clock in sleep mode.

void HAL_RCC_LP_SRAM3_DisableClockInStopMode ( void )

This function disables the SRAM3 clock in stop mode.

void HAL_RCC_LP_FSMC_DisableClockInSleepMode ( void )

This function disables the FSMC clock in sleep mode.

void HAL_RCC_LP_OCTOSPI1_DisableClockInSleepMode ( void )

This function disables the OCTOSPI1 clock in sleep mode.

void HAL_RCC_LP_OCTOSPI2_DisableClockInSleepMode ( void )

This function disables the OCTOSPI2 clock in sleep mode.

void HAL_RCC_LP_HSPI1_DisableClockInSleepMode ( void )

This function disables the HSPI1 clock in sleep mode.

void HAL_RCC_LP_SRAM6_DisableClockInSleepMode ( void )

This function disables the SRAM6 clock in sleep mode.

void HAL_RCC_LP_SRAM6_DisableClockInStopMode ( void )

This function disables the SRAM6 clock in stop mode.

void HAL_RCC_LP_SRAM5_DisableClockInSleepMode ( void )

This function disables the SRAM5 clock in sleep mode.

void HAL_RCC_LP_SRAM5_DisableClockInStopMode ( void )

This function disables the SRAM5 clock in stop mode.

Enable or disable the AHB3SMENR peripheral clock during Low Power (Sleep and STOP ) mode.

Note

Peripheral clock gating in SLEEP and STOP modes can be used to further reduce power consumption.

Note

After wakeup from SLEEP or STOP modes, the peripheral clock is enabled again.

Note

By default, all peripheral clocks are enabled during SLEEP mode,in STOP mode peripheral clock is enabled only when a peripheral requests AHB clock.

Functions

void HAL_RCC_LP_LPGPIO1_EnableClockInSleepMode ( void )

This function enables the LPGPIO1 clock in sleep mode.

void HAL_RCC_LP_LPGPIO1_EnableClockInStopMode ( void )

This function enables the LPGPIO1 clock in stop mode.

void HAL_RCC_LP_PWR_EnableClockInSleepMode ( void )

This function enables the PWR clock in sleep mode.

void HAL_RCC_LP_ADC4_EnableClockInSleepMode ( void )

This function enables the ADC4 clock in sleep mode.

void HAL_RCC_LP_ADC4_EnableClockInStopMode ( void )

This function enables the ADC4 clock in stop mode.

void HAL_RCC_LP_DAC1_EnableClockInSleepMode ( void )

This function enables the DAC1 clock in sleep mode.

void HAL_RCC_LP_DAC1_EnableClockInStopMode ( void )

This function enables the DAC1 clock in stop mode.

void HAL_RCC_LP_LPDMA1_EnableClockInSleepMode ( void )

This function enables the LPDMA1 clock in sleep mode.

void HAL_RCC_LP_LPDMA1_EnableClockInStopMode ( void )

This function enables the LPDMA1 clock in stop mode.

void HAL_RCC_LP_ADF1_EnableClockInSleepMode ( void )

This function enables the ADF1 clock in sleep mode.

void HAL_RCC_LP_ADF1_EnableClockInStopMode ( void )

This function enables the ADF1 clock in stop mode.

void HAL_RCC_LP_GTZC2_EnableClockInSleepMode ( void )

This function enables the GTZC2 clock in sleep mode.

void HAL_RCC_LP_SRAM4_EnableClockInSleepMode ( void )

This function enables the SRAM4 clock in sleep mode.

void HAL_RCC_LP_SRAM4_EnableClockInStopMode ( void )

This function enables the SRAM4 clock in stop mode.

void HAL_RCC_LP_LPGPIO1_DisableClockInSleepMode ( void )

This function disables the LPGPIO1 clock in sleep mode.

void HAL_RCC_LP_LPGPIO1_DisableClockInStopMode ( void )

This function disables the LPGPIO1 clock in stop mode.

void HAL_RCC_LP_PWR_DisableClockInSleepMode ( void )

This function disables the PWR clock in sleep mode.

void HAL_RCC_LP_ADC4_DisableClockInSleepMode ( void )

This function disables the ADC4 clock in sleep mode.

void HAL_RCC_LP_ADC4_DisableClockInStopMode ( void )

This function disables the ADC4 clock in stop mode.

void HAL_RCC_LP_DAC1_DisableClockInSleepMode ( void )

This function disables the DAC1 clock in sleep mode.

void HAL_RCC_LP_DAC1_DisableClockInStopMode ( void )

This function disables the DAC1 clock in stop mode.

void HAL_RCC_LP_LPDMA1_DisableClockInSleepMode ( void )

This function disables the LPDMA1 clock in sleep mode.

void HAL_RCC_LP_LPDMA1_DisableClockInStopMode ( void )

This function disables the LPDMA1 clock in stop mode.

void HAL_RCC_LP_ADF1_DisableClockInSleepMode ( void )

This function disables the ADF1 clock in sleep mode.

void HAL_RCC_LP_ADF1_DisableClockInStopMode ( void )

This function disables the ADF1 clock in stop mode.

void HAL_RCC_LP_GTZC2_DisableClockInSleepMode ( void )

This function disables the GTZC2 clock in sleep mode.

void HAL_RCC_LP_SRAM4_DisableClockInSleepMode ( void )

This function disables the SRAM4 clock in sleep mode.

void HAL_RCC_LP_SRAM4_DisableClockInStopMode ( void )

This function disables the SRAM4 clock in stop mode.

Enable or disable the APB1 peripheral clock during Low Power (Sleep and Stop) mode.

Note

Peripheral clock gating in SLEEP and STOP modes can be used to further reduce power consumption.

Note

After wakeup from SLEEP or STOP modes, the peripheral clock is enabled again.

Note

By default, all peripheral clocks are enabled during SLEEP mode,in STOP mode peripheral clock is enabled only when a peripheral requests APB clock.

Functions

void HAL_RCC_LP_TIM2_EnableClockInSleepMode ( void )

This function enables the TIM2 clock in sleep mode.

void HAL_RCC_LP_TIM3_EnableClockInSleepMode ( void )

This function enables the TIM3 clock in sleep mode.

void HAL_RCC_LP_TIM4_EnableClockInSleepMode ( void )

This function enables the TIM4 clock in sleep mode.

void HAL_RCC_LP_TIM5_EnableClockInSleepMode ( void )

This function enables the TIM5 clock in sleep mode.

void HAL_RCC_LP_TIM6_EnableClockInSleepMode ( void )

This function enables the TIM6 clock in sleep mode.

void HAL_RCC_LP_TIM7_EnableClockInSleepMode ( void )

This function enables the TIM7 clock in sleep mode.

void HAL_RCC_LP_WWDG_EnableClockInSleepMode ( void )

This function enables the WWDG clock in sleep mode.

void HAL_RCC_LP_SPI2_EnableClockInSleepMode ( void )

This function enables the SPI2 clock in sleep mode.

void HAL_RCC_LP_SPI2_EnableClockInStopMode ( void )

This function enables the SPI2 clock in stop mode.

void HAL_RCC_LP_USART2_EnableClockInSleepMode ( void )

This function enables the USART2 clock in sleep mode.

void HAL_RCC_LP_USART2_EnableClockInStopMode ( void )

This function enables the USART2 clock in stop mode.

void HAL_RCC_LP_USART3_EnableClockInSleepMode ( void )

This function enables the USART3 clock in sleep mode.

void HAL_RCC_LP_USART3_EnableClockInStopMode ( void )

This function enables the USART3 clock in stop mode.

void HAL_RCC_LP_UART4_EnableClockInSleepMode ( void )

This function enables the UART4 clock in sleep mode.

void HAL_RCC_LP_UART4_EnableClockInStopMode ( void )

This function enables the UART4 clock in stop mode.

void HAL_RCC_LP_UART5_EnableClockInSleepMode ( void )

This function enables the UART5 clock in sleep mode.

void HAL_RCC_LP_UART5_EnableClockInStopMode ( void )

This function enables the UART5 clock in stop mode.

void HAL_RCC_LP_I2C1_EnableClockInSleepMode ( void )

This function enables the I2C1 clock in sleep mode.

void HAL_RCC_LP_I2C1_EnableClockInStopMode ( void )

This function enables the I2C1 clock in stop mode.

void HAL_RCC_LP_I2C2_EnableClockInSleepMode ( void )

This function enables the I2C2 clock in sleep mode.

void HAL_RCC_LP_I2C2_EnableClockInStopMode ( void )

This function enables the I2C2 clock in stop mode.

void HAL_RCC_LP_CRS_EnableClockInSleepMode ( void )

This function enables the CRS clock in sleep mode.

void HAL_RCC_LP_USART6_EnableClockInSleepMode ( void )

This function enables the USART6 clock in sleep mode.

void HAL_RCC_LP_USART6_EnableClockInStopMode ( void )

This function enables the USART6 clock in stop mode.

void HAL_RCC_LP_I2C4_EnableClockInSleepMode ( void )

This function enables the I2C4 clock in sleep mode.

void HAL_RCC_LP_I2C4_EnableClockInStopMode ( void )

This function enables the I2C4 clock in stop mode.

void HAL_RCC_LP_LPTIM2_EnableClockInSleepMode ( void )

This function enables the LPTIM2 clock in sleep mode.

void HAL_RCC_LP_LPTIM2_EnableClockInStopMode ( void )

This function enables the LPTIM2 clock in stop mode.

void HAL_RCC_LP_I2C5_EnableClockInSleepMode ( void )

This function enables the I2C5 clock in sleep mode.

void HAL_RCC_LP_I2C5_EnableClockInStopMode ( void )

This function enables the I2C5 clock in stop mode.

void HAL_RCC_LP_I2C6_EnableClockInSleepMode ( void )

This function enables the I2C6 clock in sleep mode.

void HAL_RCC_LP_I2C6_EnableClockInStopMode ( void )

This function enables the I2C6 clock in stop mode.

void HAL_RCC_LP_FDCAN_EnableClockInSleepMode ( void )

This function enables the FDCAN clock in sleep mode.

void HAL_RCC_LP_UCPD1_EnableClockInSleepMode ( void )

This function enables the UCPD1 clock in sleep mode.

void HAL_RCC_LP_TIM2_DisableClockInSleepMode ( void )

This function disables the TIM2 clock in sleep mode.

void HAL_RCC_LP_TIM3_DisableClockInSleepMode ( void )

This function disables the TIM3 clock in sleep mode.

void HAL_RCC_LP_TIM4_DisableClockInSleepMode ( void )

This function disables the TIM4 clock in sleep mode.

void HAL_RCC_LP_TIM5_DisableClockInSleepMode ( void )

This function disables the TIM5 clock in sleep mode.

void HAL_RCC_LP_TIM6_DisableClockInSleepMode ( void )

This function disables the TIM6 clock in sleep mode.

void HAL_RCC_LP_TIM7_DisableClockInSleepMode ( void )

This function disables the TIM7 clock in sleep mode.

void HAL_RCC_LP_WWDG_DisableClockInSleepMode ( void )

This function disables the WWDG clock in sleep mode.

void HAL_RCC_LP_SPI2_DisableClockInSleepMode ( void )

This function disables the SPI2 clock in sleep mode.

void HAL_RCC_LP_SPI2_DisableClockInStopMode ( void )

This function disables the SPI2 clock in stop mode.

void HAL_RCC_LP_USART2_DisableClockInSleepMode ( void )

This function disables the USART2 clock in sleep mode.

void HAL_RCC_LP_USART2_DisableClockInStopMode ( void )

This function disables the USART2 clock in stop mode.

void HAL_RCC_LP_USART3_DisableClockInSleepMode ( void )

This function disables the USART3 clock in sleep mode.

void HAL_RCC_LP_USART3_DisableClockInStopMode ( void )

This function disables the USART3 clock in stop mode.

void HAL_RCC_LP_UART4_DisableClockInSleepMode ( void )

This function disables the UART4 clock in sleep mode.

void HAL_RCC_LP_UART4_DisableClockInStopMode ( void )

This function disables the UART4 clock in stop mode.

void HAL_RCC_LP_UART5_DisableClockInSleepMode ( void )

This function disables the UART5 clock in sleep mode.

void HAL_RCC_LP_UART5_DisableClockInStopMode ( void )

This function disables the UART5 clock in stop mode.

void HAL_RCC_LP_I2C1_DisableClockInSleepMode ( void )

This function disables the I2C1 clock in sleep mode.

void HAL_RCC_LP_I2C1_DisableClockInStopMode ( void )

This function disables the I2C1 clock in stop mode.

void HAL_RCC_LP_I2C2_DisableClockInSleepMode ( void )

This function disables the I2C2 clock in sleep mode.

void HAL_RCC_LP_I2C2_DisableClockInStopMode ( void )

This function disables the I2C2 clock in stop mode.

void HAL_RCC_LP_CRS_DisableClockInSleepMode ( void )

This function disables the CRS clock in sleep mode.

void HAL_RCC_LP_USART6_DisableClockInSleepMode ( void )

This function disables the USART6 clock in sleep mode.

void HAL_RCC_LP_USART6_DisableClockInStopMode ( void )

This function disables the USART6 clock in stop mode.

void HAL_RCC_LP_I2C4_DisableClockInSleepMode ( void )

This function disables the I2C4 clock in sleep mode.

void HAL_RCC_LP_I2C4_DisableClockInStopMode ( void )

This function disables the I2C4 clock in stop mode.

void HAL_RCC_LP_LPTIM2_DisableClockInSleepMode ( void )

This function disables the LPTIM2 clock in sleep mode.

void HAL_RCC_LP_LPTIM2_DisableClockInStopMode ( void )

This function disables the LPTIM2 clock in stop mode.

void HAL_RCC_LP_I2C5_DisableClockInSleepMode ( void )

This function disables the I2C5 clock in sleep mode.

void HAL_RCC_LP_I2C5_DisableClockInStopMode ( void )

This function disables the I2C5 clock in stop mode.

void HAL_RCC_LP_I2C6_DisableClockInSleepMode ( void )

This function disables the I2C6 clock in sleep mode.

void HAL_RCC_LP_I2C6_DisableClockInStopMode ( void )

This function disables the I2C6 clock in stop mode.

void HAL_RCC_LP_FDCAN_DisableClockInSleepMode ( void )

This function disables the FDCAN clock in sleep mode.

void HAL_RCC_LP_UCPD1_DisableClockInSleepMode ( void )

This function disables the UCPD1 clock in sleep mode.

Enable or disable the APB2 peripheral clock during Low Power (Sleep and Stop) mode.

Note

Peripheral clock gating in SLEEP and STOP modes can be used to further reduce power consumption.

Note

After wakeup from SLEEP or STOP mode, the pseripheral clock is enabled again.

Note

By default, all peripheral clocks are enabled during SLEEP mode,in STOP mode peripheral clock is enabled only when a peripheral requests APB clock.

Functions

void HAL_RCC_LP_TIM1_EnableClockInSleepMode ( void )

This function enables the TIM1 clock in sleep mode.

void HAL_RCC_LP_SPI1_EnableClockInSleepMode ( void )

This function enables the SPI1 clock in sleep mode.

void HAL_RCC_LP_SPI1_EnableClockInStopMode ( void )

This function enables the SPI1 clock in stop mode.

void HAL_RCC_LP_TIM8_EnableClockInSleepMode ( void )

This function enables the TIM8 clock in sleep mode.

void HAL_RCC_LP_USART1_EnableClockInSleepMode ( void )

This function enables the USART1 clock in sleep mode.

void HAL_RCC_LP_USART1_EnableClockInStopMode ( void )

This function enables the USART1 clock in stop mode.

void HAL_RCC_LP_TIM15_EnableClockInSleepMode ( void )

This function enables the TIM15 clock in sleep mode.

void HAL_RCC_LP_TIM16_EnableClockInSleepMode ( void )

This function enables the TIM16 clock in sleep mode.

void HAL_RCC_LP_TIM17_EnableClockInSleepMode ( void )

This function enables the TIM17 clock in sleep mode.

void HAL_RCC_LP_SAI1_EnableClockInSleepMode ( void )

This function enables the SAI1 clock in sleep mode.

void HAL_RCC_LP_SAI2_EnableClockInSleepMode ( void )

This function enables the SAI2 clock in sleep mode.

void HAL_RCC_LP_GFXTIM_EnableClockInSleepMode ( void )

This function enables the GFXTIM clock in sleep mode.

void HAL_RCC_LP_LTDC_EnableClockInSleepMode ( void )

This function enables the LTDC clock in sleep mode.

void HAL_RCC_LP_DSI_EnableClockInSleepMode ( void )

This function enables the DSI clock in sleep mode.

void HAL_RCC_LP_TIM1_DisableClockInSleepMode ( void )

This function disables the TIM1 clock in sleep mode.

void HAL_RCC_LP_SPI1_DisableClockInSleepMode ( void )

This function disables the SPI1 clock in sleep mode.

void HAL_RCC_LP_SPI1_DisableClockInStopMode ( void )

This function disables the SPI1 clock in stop mode.

void HAL_RCC_LP_TIM8_DisableClockInSleepMode ( void )

This function disables the TIM8 clock in sleep mode.

void HAL_RCC_LP_USART1_DisableClockInSleepMode ( void )

This function disables the USART1 clock in sleep mode.

void HAL_RCC_LP_USART1_DisableClockInStopMode ( void )

This function disables the USART1 clock in stop mode.

void HAL_RCC_LP_TIM15_DisableClockInSleepMode ( void )

This function disables the TIM15 clock in sleep mode.

void HAL_RCC_LP_TIM16_DisableClockInSleepMode ( void )

This function disables the TIM16 clock in sleep mode.

void HAL_RCC_LP_TIM17_DisableClockInSleepMode ( void )

This function disables the TIM17 clock in sleep mode.

void HAL_RCC_LP_SAI1_DisableClockInSleepMode ( void )

This function disables the SAI1 clock in sleep mode.

void HAL_RCC_LP_SAI2_DisableClockInSleepMode ( void )

This function disables the SAI2 clock in sleep mode.

void HAL_RCC_LP_GFXTIM_DisableClockInSleepMode ( void )

This function disables the GFXTIM clock in sleep mode.

void HAL_RCC_LP_LTDC_DisableClockInSleepMode ( void )

This function disables the LTDC clock in sleep mode.

void HAL_RCC_LP_DSI_DisableClockInSleepMode ( void )

This function disables the DSI clock in sleep mode.

Enable or disable the APB3 peripheral clock during Low Power (Sleep and Stop) mode.

Note

Peripheral clock gating in SLEEP and STOP modes can be used to further reduce power consumption.

Note

After wakeup from SLEEP or STOP modes, the peripheral clock is enabled again.

Note

By default, all peripheral clocks are enabled during SLEEP mode,in STOP mode peripheral clock is enabled only when a peripheral requests APB clock.

Functions

void HAL_RCC_LP_SYSCFG_EnableClockInSleepMode ( void )

This function enables the SYSCFG clock in sleep mode.

void HAL_RCC_LP_SPI3_EnableClockInSleepMode ( void )

This function enables the SPI3 clock in sleep mode.

void HAL_RCC_LP_SPI3_EnableClockInStopMode ( void )

This function enables the SPI3 clock in stop mode.

void HAL_RCC_LP_LPUART1_EnableClockInSleepMode ( void )

This function enables the LPUART1 clock in sleep mode.

void HAL_RCC_LP_LPUART1_EnableClockInStopMode ( void )

This function enables the LPUART1 clock in stop mode.

void HAL_RCC_LP_I2C3_EnableClockInSleepMode ( void )

This function enables the I2C3 clock in sleep mode.

void HAL_RCC_LP_I2C3_EnableClockInStopMode ( void )

This function enables the I2C3 clock in stop mode.

void HAL_RCC_LP_LPTIM1_EnableClockInSleepMode ( void )

This function enables the LPTIM1 clock in sleep mode.

void HAL_RCC_LP_LPTIM1_EnableClockInStopMode ( void )

This function enables the LPTIM1 clock in stop mode.

void HAL_RCC_LP_LPTIM3_EnableClockInSleepMode ( void )

This function enables the LPTIM3 clock in sleep mode.

void HAL_RCC_LP_LPTIM3_EnableClockInStopMode ( void )

This function enables the LPTIM3 clock in stop mode.

void HAL_RCC_LP_LPTIM4_EnableClockInSleepMode ( void )

This function enables the LPTIM4 clock in sleep mode.

void HAL_RCC_LP_LPTIM4_EnableClockInStopMode ( void )

This function enables the LPTIM4 clock in stop mode.

void HAL_RCC_LP_OPAMP_EnableClockInSleepMode ( void )

This function enables the OPAMP clock in sleep mode.

void HAL_RCC_LP_OPAMP_EnableClockInStopMode ( void )

This function enables the OPAMP clock in stop mode.

void HAL_RCC_LP_COMP_EnableClockInSleepMode ( void )

This function enables the COMP clock in sleep mode.

void HAL_RCC_LP_COMP_EnableClockInStopMode ( void )

This function enables the COMP clock in stop mode.

void HAL_RCC_LP_VREF_EnableClockInSleepMode ( void )

This function enables the VREF clock in sleep mode.

void HAL_RCC_LP_VREF_EnableClockInStopMode ( void )

This function enables the VREF clock in stop mode.

void HAL_RCC_LP_RTCAPB_EnableClockInSleepMode ( void )

This function enables the RTCAPB clock in sleep mode.

void HAL_RCC_LP_RTCAPB_EnableClockInStopMode ( void )

This function enables the RTCAPB clock in stop mode.

void HAL_RCC_LP_SYSCFG_DisableClockInSleepMode ( void )

This function disables the SYSCFG clock in sleep mode.

void HAL_RCC_LP_SPI3_DisableClockInSleepMode ( void )

This function disables the SPI3 clock in sleep mode.

void HAL_RCC_LP_SPI3_DisableClockInStopMode ( void )

This function disables the SPI3 clock in stop mode.

void HAL_RCC_LP_LPUART1_DisableClockInSleepMode ( void )

This function disables the LPUART1 clock in sleep mode.

void HAL_RCC_LP_LPUART1_DisableClockInStopMode ( void )

This function disables the LPUART1 clock in stop mode.

void HAL_RCC_LP_I2C3_DisableClockInSleepMode ( void )

This function disables the I2C3 clock in sleep mode.

void HAL_RCC_LP_I2C3_DisableClockInStopMode ( void )

This function disables the I2C3 clock in stop mode.

void HAL_RCC_LP_LPTIM1_DisableClockInSleepMode ( void )

This function disables the LPTIM1 clock in sleep mode.

void HAL_RCC_LP_LPTIM1_DisableClockInStopMode ( void )

This function disables the LPTIM1 clock in stop mode.

void HAL_RCC_LP_LPTIM3_DisableClockInSleepMode ( void )

This function disables the LPTIM3 clock in sleep mode.

void HAL_RCC_LP_LPTIM3_DisableClockInStopMode ( void )

This function disables the LPTIM3 clock in stop mode.

void HAL_RCC_LP_LPTIM4_DisableClockInSleepMode ( void )

This function disables the LPTIM4 clock in sleep mode.

void HAL_RCC_LP_LPTIM4_DisableClockInStopMode ( void )

This function disables the LPTIM4 clock in stop mode.

void HAL_RCC_LP_OPAMP_DisableClockInSleepMode ( void )

This function disables the OPAMP clock in sleep mode.

void HAL_RCC_LP_OPAMP_DisableClockInStopMode ( void )

This function disables the OPAMP clock in stop mode.

void HAL_RCC_LP_COMP_DisableClockInSleepMode ( void )

This function disables the COMP clock in sleep mode.

void HAL_RCC_LP_COMP_DisableClockInStopMode ( void )

This function disables the COMP clock in stop mode.

void HAL_RCC_LP_VREF_DisableClockInSleepMode ( void )

This function disables the VREF clock in sleep mode.

void HAL_RCC_LP_VREF_DisableClockInStopMode ( void )

This function disables the VREF clock in stop mode.

void HAL_RCC_LP_RTCAPB_DisableClockInSleepMode ( void )

This function disables the RTCAPB clock in sleep mode.

void HAL_RCC_LP_RTCAPB_DisableClockInStopMode ( void )

This function disables the RTCAPB clock in stop mode.

Functions

void HAL_RCC_ResetBackupDomain ( void )

Function to force and release the Backup domain.

When a Backup domain reset occurs, the following domains are impacted:

  • the RTC is stopped and all the RTC registers are set to their reset values (including the backup registers)

  • all TAMP registers can be read or written in both secure and non-secure modes. The secure boot code can change this security setup, making some registers secure or not as needed, using TAMP_SECCFGR register.

  • The SRAM2 and BKPSRAM are affected by this reset.

  • LSE crystal 32kHz oscillator

  • RCC_BDCR register

RCC services functions

group RCC_Exported_Functions_Group3

This subsection provides a set of functions allowing to:

  • Configure the MCO.

    • MCO (Microcontroller Clock Output): used to output MSIS, MSIK, LSI, HSI16, HSI48, LSE, HSE, SYSCLK or main PLL clock (through a configurable prescaler) on a pin.

  • Get and clear reset flags

  • Enable the Clock Security System.

    • CSS (Clock Security System): once enabled, if a HSE clock failure occurs (HSE used directly or through PLL as System clock source), the System clock is automatically switched of the system clock to the MSIS or the HSI16 oscillator depending on the STOPWUCK configuration. The CSS interrupt is linked to the Cortex-M33 NMI (non-maskable interrupt) exception vector. The NMI is executed indefinitely unless the CSSI pending bit is cleared. As a consequence, in the NMI ISR, the user must clear the CSSI by setting the CSSC bit.

  • Enable Clock security system on LSE.

  • Configure and get the oscillator clock source for wakeup from Stop and CSS backup clock.

  • Configure and get the oscillator Kernel clock source for wakeup from Stop.

  • Enable output (LSCO) allows one of the low-speed clocks below to be output onto the external LSCO pin:

    • LSI

    • LSE This output remains available in all Stop modes, Standby and Shutdown modes

  • Enable RTC and TAMP clock

  • Set the Clocks sources for TIM16,TIM17 and LPTIM2 internal input capture

Functions

hal_status_t HAL_RCC_USART1_SetKernelClkSource ( hal_rcc_usart1_clk_src_t clk_src )

Set the USART1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USART2_SetKernelClkSource ( hal_rcc_usart2_clk_src_t clk_src )

Set the USART2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USART3_SetKernelClkSource ( hal_rcc_usart3_clk_src_t clk_src )

Set the USART3 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart3_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_UART4_SetKernelClkSource ( hal_rcc_uart4_clk_src_t clk_src )

Set the UART4 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_uart4_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_UART5_SetKernelClkSource ( hal_rcc_uart5_clk_src_t clk_src )

Set the UART5 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_uart5_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USART6_SetKernelClkSource ( hal_rcc_usart6_clk_src_t clk_src )

Set the USART6 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart6_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPUART1_SetKernelClkSource ( hal_rcc_lpuart1_clk_src_t clk_src )

Set the LPUART1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lpuart1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C1_SetKernelClkSource ( hal_rcc_i2c1_clk_src_t clk_src )

Set the I2C1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C2_SetKernelClkSource ( hal_rcc_i2c2_clk_src_t clk_src )

Set the I2C2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C3_SetKernelClkSource ( hal_rcc_i2c3_clk_src_t clk_src )

Set the I2C3 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c3_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C4_SetKernelClkSource ( hal_rcc_i2c4_clk_src_t clk_src )

Set the I2C4 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c4_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C5_SetKernelClkSource ( hal_rcc_i2c5_clk_src_t clk_src )

Set the I2C5 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c5_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C6_SetKernelClkSource ( hal_rcc_i2c6_clk_src_t clk_src )

Set the I2C6 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c6_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPTIM1_SetKernelClkSource ( hal_rcc_lptim1_clk_src_t clk_src )

Set the LPTIM1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lptim1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPTIM2_SetKernelClkSource ( hal_rcc_lptim2_clk_src_t clk_src )

Set the LPTIM2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lptim2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPTIM34_SetKernelClkSource ( hal_rcc_lptim34_clk_src_t clk_src )

Set the LPTIM34 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lptim34_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_FDCAN_SetKernelClkSource ( hal_rcc_fdcan_clk_src_t clk_src )

Set the FDCAN clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_fdcan_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_MDF1_SetKernelClkSource ( hal_rcc_mdf1_clk_src_t clk_src )

Set the MDF1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_mdf1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_ADF1_SetKernelClkSource ( hal_rcc_adf1_clk_src_t clk_src )

Set the ADF1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_adf1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SAI1_SetKernelClkSource ( hal_rcc_sai1_clk_src_t clk_src )

Set the SAI1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_sai1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SAI2_SetKernelClkSource ( hal_rcc_sai2_clk_src_t clk_src )

Set the SAI2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_sai2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_RNG_SetKernelClkSource ( hal_rcc_rng_clk_src_t clk_src )

Set the RNG clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_rng_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SAES_SetKernelClkSource ( hal_rcc_saes_clk_src_t clk_src )

Set the SAES clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_saes_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_ICLK_SetKernelClkSource ( hal_rcc_iclk_clk_src_t clk_src )

Set the ICLK clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_iclk_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SDMMC_SetKernelClkSource ( hal_rcc_sdmmc_clk_src_t clk_src )

Set the SDMMC clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_sdmmc_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_ADCDAC_SetKernelClkSource ( hal_rcc_adcdac_clk_src_t clk_src )

Set the ADCDAC clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_adcdac_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_DAC1_SetSampleAndHoldClkSource ( hal_rcc_dac1_clk_src_t clk_src )

Set the DAC1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_dac1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_OCTOSPI_SetKernelClkSource ( hal_rcc_octospi_clk_src_t clk_src )

Set the OCTOSPI clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_octospi_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_HSPI1_SetKernelClkSource ( hal_rcc_hspi1_clk_src_t clk_src )

Set the HSPI1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_hspi1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SPI1_SetKernelClkSource ( hal_rcc_spi1_clk_src_t clk_src )

Set the SPI1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_spi1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SPI2_SetKernelClkSource ( hal_rcc_spi2_clk_src_t clk_src )

Set the SPI2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_spi2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SPI3_SetKernelClkSource ( hal_rcc_spi3_clk_src_t clk_src )

Set the SPI3 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_spi3_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_RTC_SetKernelClkSource ( hal_rcc_rtc_clk_src_t clk_src )

Set the RTC clock source.

Note

Access to Backup domain has to be enabled.

Parameters :

clk_src – Clock source selection based on hal_rcc_rtc_clk_src_t

Return values :

  • HAL_OK – RTC source clock has been selected

  • HAL_ERROR – LSE activation failed after reset of Backup domain

hal_status_t HAL_RCC_LTDC_SetKernelClkSource ( hal_rcc_ltdc_clk_src_t clk_src )

Set the LTDC clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_ltdc_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_DSI_SetKernelClkSource ( hal_rcc_dsi_clk_src_t clk_src )

Set the DSI clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_dsi_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USBHSPHY_SetKernelClkSource ( hal_rcc_usbhsphy_clk_src_t clk_src )

Set the OTG_HS PHY clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usbhsphy_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_rcc_usart1_clk_src_t HAL_RCC_USART1_GetKernelClkSource ( void )

Get the USART1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart1_clk_src_t

hal_rcc_usart2_clk_src_t HAL_RCC_USART2_GetKernelClkSource ( void )

Get the USART2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart2_clk_src_t

hal_rcc_usart3_clk_src_t HAL_RCC_USART3_GetKernelClkSource ( void )

Get the USART3 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart3_clk_src_t

hal_rcc_usart6_clk_src_t HAL_RCC_USART6_GetKernelClkSource ( void )

Get the USART6 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart6_clk_src_t

hal_rcc_uart4_clk_src_t HAL_RCC_UART4_GetKernelClkSource ( void )

Get the UART4 clock source.

Return values :

clk_src – Clock source based on hal_rcc_uart4_clk_src_t

hal_rcc_uart5_clk_src_t HAL_RCC_UART5_GetKernelClkSource ( void )

Get the UART5 clock source.

Return values :

clk_src – Clock source based on hal_rcc_uart5_clk_src_t

hal_rcc_lpuart1_clk_src_t HAL_RCC_LPUART1_GetKernelClkSource ( void )

Get the LPUART1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lpuart1_clk_src_t

hal_rcc_i2c1_clk_src_t HAL_RCC_I2C1_GetKernelClkSource ( void )

Get the I2C1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c1_clk_src_t

hal_rcc_i2c2_clk_src_t HAL_RCC_I2C2_GetKernelClkSource ( void )

Get the I2C2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c2_clk_src_t

hal_rcc_i2c3_clk_src_t HAL_RCC_I2C3_GetKernelClkSource ( void )

Get the I2C3 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c3_clk_src_t

hal_rcc_i2c4_clk_src_t HAL_RCC_I2C4_GetKernelClkSource ( void )

Get the I2C4 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c4_clk_src_t

hal_rcc_i2c5_clk_src_t HAL_RCC_I2C5_GetKernelClkSource ( void )

Get the I2C5 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c5_clk_src_t

hal_rcc_i2c6_clk_src_t HAL_RCC_I2C6_GetKernelClkSource ( void )

Get the I2C6 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c6_clk_src_t

hal_rcc_lptim1_clk_src_t HAL_RCC_LPTIM1_GetKernelClkSource ( void )

Get the LPTIM1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lptim1_clk_src_t

hal_rcc_lptim2_clk_src_t HAL_RCC_LPTIM2_GetKernelClkSource ( void )

Get the LPTIM2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lptim2_clk_src_t

hal_rcc_lptim34_clk_src_t HAL_RCC_LPTIM34_GetKernelClkSource ( void )

Get the LPTIM34 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lptim34_clk_src_t

hal_rcc_fdcan_clk_src_t HAL_RCC_FDCAN_GetKernelClkSource ( void )

Get the FDCAN clock source.

Return values :

clk_src – Clock source based on hal_rcc_fdcan_clk_src_t

hal_rcc_mdf1_clk_src_t HAL_RCC_MDF1_GetKernelClkSource ( void )

Get the MDF1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_mdf1_clk_src_t

hal_rcc_adf1_clk_src_t HAL_RCC_ADF1_GetKernelClkSource ( void )

Get the ADF1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_adf1_clk_src_t

hal_rcc_sai1_clk_src_t HAL_RCC_SAI1_GetKernelClkSource ( void )

Get the SAI1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_sai1_clk_src_t

hal_rcc_sai2_clk_src_t HAL_RCC_SAI2_GetKernelClkSource ( void )

Get the SAI2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_sai2_clk_src_t

hal_rcc_rng_clk_src_t HAL_RCC_RNG_GetKernelClkSource ( void )

Get the RNG clock source.

Return values :

clk_src – Clock source based on hal_rcc_rng_clk_src_t

hal_rcc_saes_clk_src_t HAL_RCC_SAES_GetKernelClkSource ( void )

Get the SAES clock source.

Return values :

clk_src – Clock source based on hal_rcc_saes_clk_src_t

hal_rcc_iclk_clk_src_t HAL_RCC_ICLK_GetKernelClkSource ( void )

Get the ICLK clock source.

Return values :

clk_src – Clock source based on hal_rcc_iclk_clk_src_t

hal_rcc_sdmmc_clk_src_t HAL_RCC_SDMMC_GetKernelClkSource ( void )

Get the SDMMC clock source.

Return values :

clk_src – Clock source based on hal_rcc_sdmmc_clk_src_t

hal_rcc_adcdac_clk_src_t HAL_RCC_ADCDAC_GetKernelClkSource ( void )

Get the ADCDAC clock source.

Return values :

clk_src – Clock source based on hal_rcc_adcdac_clk_src_t

hal_rcc_dac1_clk_src_t HAL_RCC_DAC1_GetSampleHoldClkSource ( void )

Get the DAC1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_dac1_clk_src_t

hal_rcc_octospi_clk_src_t HAL_RCC_OCTOSPI_GetKernelClkSource ( void )

Get the OCTOSPI clock source.

Return values :

clk_src – Clock source based on hal_rcc_octospi_clk_src_t

hal_rcc_hspi1_clk_src_t HAL_RCC_HSPI1_GetKernelClkSource ( void )

Get the HSPI clock source.

Return values :

clk_src – Clock source based on hal_rcc_hspi1_clk_src_t

hal_rcc_spi1_clk_src_t HAL_RCC_SPI1_GetKernelClkSource ( void )

Get the SPI1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_spi1_clk_src_t

hal_rcc_spi2_clk_src_t HAL_RCC_SPI2_GetKernelClkSource ( void )

Get the SPI2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_spi2_clk_src_t

hal_rcc_spi3_clk_src_t HAL_RCC_SPI3_GetKernelClkSource ( void )

Get the SPI3 clock source.

Return values :

clk_src – Clock source based on hal_rcc_spi3_clk_src_t

hal_rcc_rtc_clk_src_t HAL_RCC_RTC_GetKernelClkSource ( void )

Get the RTC clock source.

Return values :

clk_src – Clock source based on hal_rcc_rtc_clk_src_t

hal_rcc_ltdc_clk_src_t HAL_RCC_LTDC_GetKernelClkSource ( void )

Get the LTDC clock source.

Return values :

clk_src – Clock source based on hal_rcc_ltdc_clk_src_t

hal_rcc_dsi_clk_src_t HAL_RCC_DSI_GetKernelClkSource ( void )

Get the DSI clock source.

Return values :

clk_src – Clock source based on hal_rcc_dsi_clk_src_t

hal_rcc_usbhsphy_clk_src_t HAL_RCC_USBHSPHY_GetKernelClkSource ( void )

Get the USB HS PHY clock source.

Return values :

clk_src – Clock source based on hal_rcc_usbhsphy_clk_src_t

uint32_t HAL_RCC_RTC_GetKernelClkFreq ( void )

Return the peripheral clock frequency for RTC.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SAI_GetKernelClkFreq ( const SAI_TypeDef * saix )

Return the peripheral clock frequency for SAI.

Parameters :

saix – SAI instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SAI1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SAI1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SAI2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SAI2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SAES_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SAES.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_ICLK_GetKernelClkFreq ( void )

Return the peripheral clock frequency for ICLK.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SDMMC_GetKernelClkFreq ( const SDMMC_TypeDef * sdmmcx )

Return the peripheral clock frequency for SDMMC.

Parameters :

sdmmcx – SDMMC instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SDMMC12_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SDMMC12.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_USART_GetKernelClkFreq ( const USART_TypeDef * usartx )

Return the peripheral clock frequency for USART/SMARTCARD.

Parameters :

usartx – USART instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_UART_GetKernelClkFreq ( const USART_TypeDef * uartx )

Return the peripheral clock frequency for UART/LPUART.

Parameters :

uartx – UART instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART3_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART3.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_UART4_GetKernelClkFreq ( void )

Return the peripheral clock frequency for UART4.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_UART5_GetKernelClkFreq ( void )

Return the peripheral clock frequency for UART5.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART6_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART6.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_LPUART1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPUART1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_ADC_GetKernelClkFreq ( const ADC_TypeDef * adcx )

Return the peripheral clock frequency for ADC.

Parameters :

adcx – ADC instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_DAC_GetKernelClkFreq ( const DAC_TypeDef * dacx )

Return the peripheral clock frequency for DAC.

Parameters :

dacx – DAC instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_ADCDAC_GetKernelClkFreq ( void )

Return the peripheral clock frequency for ADCDAC.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_MDF1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for MDF1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_ADF1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for ADF1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C_GetKernelClkFreq ( const I2C_TypeDef * i2cx )

Return the peripheral clock frequency for I2C/SMBUS.

Parameters :

i2cx – I2C instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C3_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C3.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C4_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C4.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C5_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C5.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C6_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C6.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_TIM_GetKernelClkFreq ( const TIM_TypeDef * timx )

Return the peripheral clock frequency for TIM.

Parameters :

timx – TIM instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM_GetKernelClkFreq ( const LPTIM_TypeDef * lptimx )

Return the peripheral clock frequency for LPTIM.

Parameters :

lptimx – LPTIM instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM34_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPTIM34.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPTIM1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPTIM2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_FDCAN_GetKernelClkFreq ( void )

Return the peripheral clock frequency for FDCAN.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SPI_GetKernelClkFreq ( const SPI_TypeDef * spix )

Return the peripheral clock frequency for SPI.

Parameters :

spix – SPI instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SPI1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SPI1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SPI2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SPI2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SPI3_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SPI3.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_XSPI_GetKernelClkFreq ( const XSPI_TypeDef * xspix )

Return the peripheral clock frequency for XSPI.

Parameters :

xspix – XSPI instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_OCTOSPI_GetKernelClkFreq ( void )

Return the peripheral clock frequency for OCTOSPI.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_HSPI1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for HSPI1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_DAC1_GetSampleHoldClkFreq ( void )

Return the peripheral clock frequency for DAC1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_RNG_GetKernelClkFreq ( void )

Return the peripheral clock frequency for RNG.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_LTDC_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LTDC.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (PLL not ready)

uint32_t HAL_RCC_DSI_GetKernelClkFreq ( void )

Return the peripheral clock frequency for DSI.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (PLL3Q not ready or internal DSI PHY PLL using HSE)

uint32_t HAL_RCC_USBHSPHY_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USB HS PHY.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

void HAL_RCC_SetConfigMCO ( hal_rcc_mco_src_t mco_src , hal_rcc_mco_prescaler_t mco_div )

Select the clock source to output on MCO pin.

Warning

MCO selected pin must be configured in alternate function mode.

Parameters :

  • mco_src – specifies the clock source to output.

  • mco_div – specifies the MCO prescaler.

uint32_t HAL_RCC_GetResetSource ( void )

Get and clear reset flags.

Note

Once reset flags are retrieved, this API is clearing them in order to isolate next reset source.

Return values :

uint32_t – Reset flags based on a combination of Reset Flag

void HAL_RCC_SetClockAfterWakeFromStop ( hal_rcc_stop_wakeup_clk_t wakeup_clk )

Configure the oscillator clock source for wakeup from Stop and CSS backup clock.

Warning

This function must not be called after the Clock Security System on HSE has been enabled.

Parameters :

wakeup_clk – Wakeup clock This parameter can be one of the following values:

hal_rcc_stop_wakeup_clk_t HAL_RCC_GetClockAfterWakeFromStop ( void )

Get the oscillator clock source for wakeup from Stop and CSS backup clock.

Return values :

hal_rcc_stop_wakeup_clk_t – Wakeup clock source

void HAL_RCC_SetKernelClkAfterWakeFromStop ( hal_rcc_stop_wakeup_kerclk_t wakeup_clk )

Configure the oscillator Kernel clock source for wakeup from Stop.

Parameters :

wakeup_clk – Kernel Wakeup clock

hal_rcc_stop_wakeup_kerclk_t HAL_RCC_GetKernelClkAfterWakeFromStop ( void )

Get the oscillator Kernel clock source for wakeup from Stop.

Return values :

hal_rcc_stop_wakeup_kerclk_t – Kernel Wakeup clock

hal_status_t HAL_RCC_EnableLSCO ( hal_rcc_lsco_src_t source )

Select source clock to use on the Low Speed Clock Output (LSCO).

Note

PWR and backup domain are to enabled before calling this function.

Parameters :

source – specifies the Low Speed clock source to output.

Return values :

  • HAL_OK – LSCO activated

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_DisableLSCO ( void )

Disable the Low Speed Clock Output (LSCO).

Note

PWR and backup domain are to enabled before calling this function.

Return values :

  • HAL_OK – LSCO Deactivated

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_RTC_EnableKernelClock ( void )

Enable RTC and TAMP kernel clock.

Note

PWR and backup domain are to enabled before calling this function.

Return values :

  • HAL_OK – RTC and TAMP kernel clock enabled

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_RTC_DisableKernelClock ( void )

Disable RTC and TAMP kernel clock.

Note

PWR and backup domain are to enabled before calling this function.

Return values :

  • HAL_OK – RTC and TAMP kernel clock disabled

  • HAL_ERROR – Backup domain is not enabled

hal_status_t HAL_RCC_SetTimerInputCaptureClockSource ( hal_rcc_timic_clk_src_t clk_src )

Set the Clocks sources for TIM16,TIM17 and LPTIM2 internal input capture.

Parameters :

clk_src – Clock source selection based on hal_rcc_timic_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_rcc_timic_clk_src_t HAL_RCC_GetTimerInputCaptureClockSource ( void )

Get the Clocks sources for TIM16,TIM17 and LPTIM2 internal input capture.

Return values :

clk_src – Clock source based on hal_rcc_timic_clk_src_t

Kernel clock source configuration for peripherals

group RCC_Exported_Functions_Group4

This subsection provides a set of functions:

  • to control Kernel clock source configuration for peripherals

Only functions having a kernel clock are handled by these functions.

The peripheral clock can be selected through the independent API HAL_RCC_{PERIPHx}_SetKernelClkSource(hal_rcc_{periphx}_clk_src_t clk_src) example: HAL_RCC_USART1_SetKernelClkSource(hal_rcc_usart1_clk_src_t clk_src)

Usage: activate SYSCLK as clock source of USART1

  • with HAL_RCC_USART1_SetKernelClkSource function: 

    HAL_RCC_USART1_SetKernelClkSource(HAL_RCC_USART1_CLK_SRC_SYSCLK);

  • to get the peripheral Clocks frequencies: hal_rcc_{periphx}_clk_src_t HAL_RCC_{PERIPHx}_GetKernelClkSource(void)

Functions

hal_status_t HAL_RCC_USART1_SetKernelClkSource ( hal_rcc_usart1_clk_src_t clk_src )

Set the USART1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USART2_SetKernelClkSource ( hal_rcc_usart2_clk_src_t clk_src )

Set the USART2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USART3_SetKernelClkSource ( hal_rcc_usart3_clk_src_t clk_src )

Set the USART3 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart3_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_UART4_SetKernelClkSource ( hal_rcc_uart4_clk_src_t clk_src )

Set the UART4 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_uart4_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_UART5_SetKernelClkSource ( hal_rcc_uart5_clk_src_t clk_src )

Set the UART5 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_uart5_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USART6_SetKernelClkSource ( hal_rcc_usart6_clk_src_t clk_src )

Set the USART6 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usart6_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPUART1_SetKernelClkSource ( hal_rcc_lpuart1_clk_src_t clk_src )

Set the LPUART1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lpuart1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C1_SetKernelClkSource ( hal_rcc_i2c1_clk_src_t clk_src )

Set the I2C1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C2_SetKernelClkSource ( hal_rcc_i2c2_clk_src_t clk_src )

Set the I2C2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C3_SetKernelClkSource ( hal_rcc_i2c3_clk_src_t clk_src )

Set the I2C3 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c3_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C4_SetKernelClkSource ( hal_rcc_i2c4_clk_src_t clk_src )

Set the I2C4 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c4_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C5_SetKernelClkSource ( hal_rcc_i2c5_clk_src_t clk_src )

Set the I2C5 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c5_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_I2C6_SetKernelClkSource ( hal_rcc_i2c6_clk_src_t clk_src )

Set the I2C6 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_i2c6_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPTIM1_SetKernelClkSource ( hal_rcc_lptim1_clk_src_t clk_src )

Set the LPTIM1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lptim1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPTIM2_SetKernelClkSource ( hal_rcc_lptim2_clk_src_t clk_src )

Set the LPTIM2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lptim2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_LPTIM34_SetKernelClkSource ( hal_rcc_lptim34_clk_src_t clk_src )

Set the LPTIM34 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_lptim34_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_FDCAN_SetKernelClkSource ( hal_rcc_fdcan_clk_src_t clk_src )

Set the FDCAN clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_fdcan_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_MDF1_SetKernelClkSource ( hal_rcc_mdf1_clk_src_t clk_src )

Set the MDF1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_mdf1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_ADF1_SetKernelClkSource ( hal_rcc_adf1_clk_src_t clk_src )

Set the ADF1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_adf1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SAI1_SetKernelClkSource ( hal_rcc_sai1_clk_src_t clk_src )

Set the SAI1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_sai1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SAI2_SetKernelClkSource ( hal_rcc_sai2_clk_src_t clk_src )

Set the SAI2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_sai2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_RNG_SetKernelClkSource ( hal_rcc_rng_clk_src_t clk_src )

Set the RNG clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_rng_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SAES_SetKernelClkSource ( hal_rcc_saes_clk_src_t clk_src )

Set the SAES clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_saes_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_ICLK_SetKernelClkSource ( hal_rcc_iclk_clk_src_t clk_src )

Set the ICLK clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_iclk_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SDMMC_SetKernelClkSource ( hal_rcc_sdmmc_clk_src_t clk_src )

Set the SDMMC clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_sdmmc_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_ADCDAC_SetKernelClkSource ( hal_rcc_adcdac_clk_src_t clk_src )

Set the ADCDAC clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_adcdac_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_DAC1_SetSampleAndHoldClkSource ( hal_rcc_dac1_clk_src_t clk_src )

Set the DAC1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_dac1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_OCTOSPI_SetKernelClkSource ( hal_rcc_octospi_clk_src_t clk_src )

Set the OCTOSPI clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_octospi_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_HSPI1_SetKernelClkSource ( hal_rcc_hspi1_clk_src_t clk_src )

Set the HSPI1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_hspi1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SPI1_SetKernelClkSource ( hal_rcc_spi1_clk_src_t clk_src )

Set the SPI1 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_spi1_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SPI2_SetKernelClkSource ( hal_rcc_spi2_clk_src_t clk_src )

Set the SPI2 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_spi2_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_SPI3_SetKernelClkSource ( hal_rcc_spi3_clk_src_t clk_src )

Set the SPI3 clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_spi3_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_RTC_SetKernelClkSource ( hal_rcc_rtc_clk_src_t clk_src )

Set the RTC clock source.

Note

Access to Backup domain has to be enabled.

Parameters :

clk_src – Clock source selection based on hal_rcc_rtc_clk_src_t

Return values :

  • HAL_OK – RTC source clock has been selected

  • HAL_ERROR – LSE activation failed after reset of Backup domain

hal_status_t HAL_RCC_LTDC_SetKernelClkSource ( hal_rcc_ltdc_clk_src_t clk_src )

Set the LTDC clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_ltdc_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_DSI_SetKernelClkSource ( hal_rcc_dsi_clk_src_t clk_src )

Set the DSI clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_dsi_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_status_t HAL_RCC_USBHSPHY_SetKernelClkSource ( hal_rcc_usbhsphy_clk_src_t clk_src )

Set the OTG_HS PHY clock source.

Parameters :

clk_src – Clock source selection based on hal_rcc_usbhsphy_clk_src_t

Return values :

HAL_OK – Source clock has been selected

hal_rcc_usart1_clk_src_t HAL_RCC_USART1_GetKernelClkSource ( void )

Get the USART1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart1_clk_src_t

hal_rcc_usart2_clk_src_t HAL_RCC_USART2_GetKernelClkSource ( void )

Get the USART2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart2_clk_src_t

hal_rcc_usart3_clk_src_t HAL_RCC_USART3_GetKernelClkSource ( void )

Get the USART3 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart3_clk_src_t

hal_rcc_uart4_clk_src_t HAL_RCC_UART4_GetKernelClkSource ( void )

Get the UART4 clock source.

Return values :

clk_src – Clock source based on hal_rcc_uart4_clk_src_t

hal_rcc_uart5_clk_src_t HAL_RCC_UART5_GetKernelClkSource ( void )

Get the UART5 clock source.

Return values :

clk_src – Clock source based on hal_rcc_uart5_clk_src_t

hal_rcc_usart6_clk_src_t HAL_RCC_USART6_GetKernelClkSource ( void )

Get the USART6 clock source.

Return values :

clk_src – Clock source based on hal_rcc_usart6_clk_src_t

hal_rcc_lpuart1_clk_src_t HAL_RCC_LPUART1_GetKernelClkSource ( void )

Get the LPUART1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lpuart1_clk_src_t

hal_rcc_i2c1_clk_src_t HAL_RCC_I2C1_GetKernelClkSource ( void )

Get the I2C1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c1_clk_src_t

hal_rcc_i2c2_clk_src_t HAL_RCC_I2C2_GetKernelClkSource ( void )

Get the I2C2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c2_clk_src_t

hal_rcc_i2c3_clk_src_t HAL_RCC_I2C3_GetKernelClkSource ( void )

Get the I2C3 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c3_clk_src_t

hal_rcc_i2c4_clk_src_t HAL_RCC_I2C4_GetKernelClkSource ( void )

Get the I2C4 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c4_clk_src_t

hal_rcc_i2c5_clk_src_t HAL_RCC_I2C5_GetKernelClkSource ( void )

Get the I2C5 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c5_clk_src_t

hal_rcc_i2c6_clk_src_t HAL_RCC_I2C6_GetKernelClkSource ( void )

Get the I2C6 clock source.

Return values :

clk_src – Clock source based on hal_rcc_i2c6_clk_src_t

hal_rcc_lptim1_clk_src_t HAL_RCC_LPTIM1_GetKernelClkSource ( void )

Get the LPTIM1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lptim1_clk_src_t

hal_rcc_lptim2_clk_src_t HAL_RCC_LPTIM2_GetKernelClkSource ( void )

Get the LPTIM2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lptim2_clk_src_t

hal_rcc_lptim34_clk_src_t HAL_RCC_LPTIM34_GetKernelClkSource ( void )

Get the LPTIM34 clock source.

Return values :

clk_src – Clock source based on hal_rcc_lptim34_clk_src_t

hal_rcc_fdcan_clk_src_t HAL_RCC_FDCAN_GetKernelClkSource ( void )

Get the FDCAN clock source.

Return values :

clk_src – Clock source based on hal_rcc_fdcan_clk_src_t

hal_rcc_mdf1_clk_src_t HAL_RCC_MDF1_GetKernelClkSource ( void )

Get the MDF1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_mdf1_clk_src_t

hal_rcc_adf1_clk_src_t HAL_RCC_ADF1_GetKernelClkSource ( void )

Get the ADF1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_adf1_clk_src_t

hal_rcc_sai1_clk_src_t HAL_RCC_SAI1_GetKernelClkSource ( void )

Get the SAI1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_sai1_clk_src_t

hal_rcc_sai2_clk_src_t HAL_RCC_SAI2_GetKernelClkSource ( void )

Get the SAI2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_sai2_clk_src_t

hal_rcc_rng_clk_src_t HAL_RCC_RNG_GetKernelClkSource ( void )

Get the RNG clock source.

Return values :

clk_src – Clock source based on hal_rcc_rng_clk_src_t

hal_rcc_saes_clk_src_t HAL_RCC_SAES_GetKernelClkSource ( void )

Get the SAES clock source.

Return values :

clk_src – Clock source based on hal_rcc_saes_clk_src_t

hal_rcc_iclk_clk_src_t HAL_RCC_ICLK_GetKernelClkSource ( void )

Get the ICLK clock source.

Return values :

clk_src – Clock source based on hal_rcc_iclk_clk_src_t

hal_rcc_sdmmc_clk_src_t HAL_RCC_SDMMC_GetKernelClkSource ( void )

Get the SDMMC clock source.

Return values :

clk_src – Clock source based on hal_rcc_sdmmc_clk_src_t

hal_rcc_adcdac_clk_src_t HAL_RCC_ADCDAC_GetKernelClkSource ( void )

Get the ADCDAC clock source.

Return values :

clk_src – Clock source based on hal_rcc_adcdac_clk_src_t

hal_rcc_dac1_clk_src_t HAL_RCC_DAC1_GetSampleHoldClkSource ( void )

Get the DAC1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_dac1_clk_src_t

hal_rcc_octospi_clk_src_t HAL_RCC_OCTOSPI_GetKernelClkSource ( void )

Get the OCTOSPI clock source.

Return values :

clk_src – Clock source based on hal_rcc_octospi_clk_src_t

hal_rcc_hspi1_clk_src_t HAL_RCC_HSPI1_GetKernelClkSource ( void )

Get the HSPI clock source.

Return values :

clk_src – Clock source based on hal_rcc_hspi1_clk_src_t

hal_rcc_spi1_clk_src_t HAL_RCC_SPI1_GetKernelClkSource ( void )

Get the SPI1 clock source.

Return values :

clk_src – Clock source based on hal_rcc_spi1_clk_src_t

hal_rcc_spi2_clk_src_t HAL_RCC_SPI2_GetKernelClkSource ( void )

Get the SPI2 clock source.

Return values :

clk_src – Clock source based on hal_rcc_spi2_clk_src_t

hal_rcc_spi3_clk_src_t HAL_RCC_SPI3_GetKernelClkSource ( void )

Get the SPI3 clock source.

Return values :

clk_src – Clock source based on hal_rcc_spi3_clk_src_t

hal_rcc_rtc_clk_src_t HAL_RCC_RTC_GetKernelClkSource ( void )

Get the RTC clock source.

Return values :

clk_src – Clock source based on hal_rcc_rtc_clk_src_t

hal_rcc_ltdc_clk_src_t HAL_RCC_LTDC_GetKernelClkSource ( void )

Get the LTDC clock source.

Return values :

clk_src – Clock source based on hal_rcc_ltdc_clk_src_t

hal_rcc_dsi_clk_src_t HAL_RCC_DSI_GetKernelClkSource ( void )

Get the DSI clock source.

Return values :

clk_src – Clock source based on hal_rcc_dsi_clk_src_t

hal_rcc_usbhsphy_clk_src_t HAL_RCC_USBHSPHY_GetKernelClkSource ( void )

Get the USB HS PHY clock source.

Return values :

clk_src – Clock source based on hal_rcc_usbhsphy_clk_src_t

uint32_t HAL_RCC_RTC_GetKernelClkFreq ( void )

Return the peripheral clock frequency for RTC.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SAI_GetKernelClkFreq ( const SAI_TypeDef * saix )

Return the peripheral clock frequency for SAI.

Parameters :

saix – SAI instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SAI1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SAI1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SAI2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SAI2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SAES_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SAES.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_ICLK_GetKernelClkFreq ( void )

Return the peripheral clock frequency for ICLK.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SDMMC_GetKernelClkFreq ( const SDMMC_TypeDef * sdmmcx )

Return the peripheral clock frequency for SDMMC.

Parameters :

sdmmcx – SDMMC instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SDMMC12_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SDMMC12.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_USART_GetKernelClkFreq ( const USART_TypeDef * usartx )

Return the peripheral clock frequency for USART/SMARTCARD.

Parameters :

usartx – USART instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_UART_GetKernelClkFreq ( const USART_TypeDef * uartx )

Return the peripheral clock frequency for UART/LPUART.

Parameters :

uartx – UART instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART3_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART3.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_UART4_GetKernelClkFreq ( void )

Return the peripheral clock frequency for UART4.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_UART5_GetKernelClkFreq ( void )

Return the peripheral clock frequency for UART5.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_USART6_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USART6.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_LPUART1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPUART1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_ADC_GetKernelClkFreq ( const ADC_TypeDef * adcx )

Return the peripheral clock frequency for ADC.

Parameters :

adcx – ADC instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_DAC_GetKernelClkFreq ( const DAC_TypeDef * dacx )

Return the peripheral clock frequency for DAC.

Parameters :

dacx – DAC instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_ADCDAC_GetKernelClkFreq ( void )

Return the peripheral clock frequency for ADCDAC.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_MDF1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for MDF1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_ADF1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for ADF1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C_GetKernelClkFreq ( const I2C_TypeDef * i2cx )

Return the peripheral clock frequency for I2C/SMBUS.

Parameters :

i2cx – I2C instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C3_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C3.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C4_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C4.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C5_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C5.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_I2C6_GetKernelClkFreq ( void )

Return the peripheral clock frequency for I2C6.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_TIM_GetKernelClkFreq ( const TIM_TypeDef * timx )

Return the peripheral clock frequency for TIM.

Parameters :

timx – TIM instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM_GetKernelClkFreq ( const LPTIM_TypeDef * lptimx )

Return the peripheral clock frequency for LPTIM.

Parameters :

lptimx – LPTIM instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM34_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPTIM34.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPTIM1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_LPTIM2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LPTIM2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_FDCAN_GetKernelClkFreq ( void )

Return the peripheral clock frequency for FDCAN.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_SPI_GetKernelClkFreq ( const SPI_TypeDef * spix )

Return the peripheral clock frequency for SPI.

Parameters :

spix – SPI instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SPI1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SPI1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SPI2_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SPI2.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_SPI3_GetKernelClkFreq ( void )

Return the peripheral clock frequency for SPI3.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_XSPI_GetKernelClkFreq ( const XSPI_TypeDef * xspix )

Return the peripheral clock frequency for XSPI.

Parameters :

xspix – XSPI instance

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_OCTOSPI_GetKernelClkFreq ( void )

Return the peripheral clock frequency for OCTOSPI.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_HSPI1_GetKernelClkFreq ( void )

Return the peripheral clock frequency for HSPI1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)

uint32_t HAL_RCC_DAC1_GetSampleHoldClkFreq ( void )

Return the peripheral clock frequency for DAC1.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_RNG_GetKernelClkFreq ( void )

Return the peripheral clock frequency for RNG.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator not ready)

uint32_t HAL_RCC_LTDC_GetKernelClkFreq ( void )

Return the peripheral clock frequency for LTDC.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (PLL not ready)

uint32_t HAL_RCC_DSI_GetKernelClkFreq ( void )

Return the peripheral clock frequency for DSI.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (PLL3Q not ready or internal DSI PHY PLL using HSE)

uint32_t HAL_RCC_USBHSPHY_GetKernelClkFreq ( void )

Return the peripheral clock frequency for USB HS PHY.

Return values :

  • uint32_t – Frequency in Hz

  • 0 – Frequency not calculated (Oscillator or PLL not ready, peripheral clock source not set…)