STM32F439xx HAL User Manual
Modules | Functions
Extended Peripheral Control functions
RCCEx Exported Functions

Extended Peripheral Control functions. More...

Modules

 Extended Clock management functions
 

Extended Clock management functions.


Functions

HAL_StatusTypeDef HAL_RCCEx_PeriphCLKConfig (RCC_PeriphCLKInitTypeDef *PeriphClkInit)
 Initializes the RCC extended peripherals clocks according to the specified parameters in the RCC_PeriphCLKInitTypeDef.
void HAL_RCCEx_GetPeriphCLKConfig (RCC_PeriphCLKInitTypeDef *PeriphClkInit)
 Configures the PeriphClkInit according to the internal RCC configuration registers.
uint32_t HAL_RCCEx_GetPeriphCLKFreq (uint32_t PeriphClk)
 Return the peripheral clock frequency for a given peripheral(SAI..)
HAL_StatusTypeDef HAL_RCCEx_EnablePLLI2S (RCC_PLLI2SInitTypeDef *PLLI2SInit)
 Enable PLLI2S.
HAL_StatusTypeDef HAL_RCCEx_DisablePLLI2S (void)
 Disable PLLI2S.
HAL_StatusTypeDef HAL_RCCEx_EnablePLLSAI (RCC_PLLSAIInitTypeDef *PLLSAIInit)
 Enable PLLSAI.
HAL_StatusTypeDef HAL_RCCEx_DisablePLLSAI (void)
 Disable PLLSAI.

Detailed Description

Extended Peripheral Control functions.

 ===============================================================================
                ##### Extended Peripheral Control functions  #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to control the RCC Clocks
    frequencies.
    [..]
    (@) Important note: Care must be taken when HAL_RCCEx_PeriphCLKConfig() is used to
        select the RTC clock source; in this case the Backup domain will be reset in
        order to modify the RTC Clock source, as consequence RTC registers (including
        the backup registers) and RCC_BDCR register are set to their reset values.


Function Documentation

HAL_StatusTypeDef HAL_RCCEx_DisablePLLI2S ( void  )

Disable PLLI2S.

Return values:
HALstatus

Definition at line 2892 of file stm32f4xx_hal_rcc_ex.c.

References __HAL_RCC_PLLI2S_DISABLE, HAL_GetTick(), and PLLI2S_TIMEOUT_VALUE.

HAL_StatusTypeDef HAL_RCCEx_DisablePLLSAI ( void  )

Disable PLLSAI.

Return values:
HALstatus

Definition at line 2996 of file stm32f4xx_hal_rcc_ex.c.

References __HAL_RCC_PLLSAI_DISABLE, __HAL_RCC_PLLSAI_GET_FLAG, HAL_GetTick(), and PLLSAI_TIMEOUT_VALUE.

HAL_StatusTypeDef HAL_RCCEx_EnablePLLI2S ( RCC_PLLI2SInitTypeDef PLLI2SInit)
HAL_StatusTypeDef HAL_RCCEx_EnablePLLSAI ( RCC_PLLSAIInitTypeDef PLLSAIInit)
uint32_t HAL_RCCEx_GetPeriphCLKFreq ( uint32_t  PeriphClk)

Return the peripheral clock frequency for a given peripheral(SAI..)

Note:
Return 0 if peripheral clock identifier not managed by this API
Parameters:
PeriphClkPeripheral clock identifier This parameter can be one of the following values:
  • RCC_PERIPHCLK_I2S: I2S peripheral clock
Return values:
Frequencyin KHz

Definition at line 2445 of file stm32f4xx_hal_rcc_ex.c.

References __HAL_RCC_GET_I2S_SOURCE, EXTERNAL_CLOCK_VALUE, HSE_VALUE, HSI_VALUE, RCC_I2SCLKSOURCE_EXT, RCC_I2SCLKSOURCE_PLLI2S, RCC_PERIPHCLK_I2S, and RCC_PLLSOURCE_HSE.

Referenced by HAL_I2S_Init(), and SAI_GetInputClock().

HAL_StatusTypeDef HAL_RCCEx_PeriphCLKConfig ( RCC_PeriphCLKInitTypeDef PeriphClkInit)

Initializes the RCC extended peripherals clocks according to the specified parameters in the RCC_PeriphCLKInitTypeDef.

Parameters:
PeriphClkInitpointer to an RCC_PeriphCLKInitTypeDef structure that contains the configuration information for the Extended Peripherals clocks(I2S, SAI, LTDC RTC and TIM).
Note:
Care must be taken when HAL_RCCEx_PeriphCLKConfig() is used to select the RTC clock source; in this case the Backup domain will be reset in order to modify the RTC Clock source, as consequence RTC registers (including the backup registers) and RCC_BDCR register are set to their reset values.
Return values:
HALstatus

Definition at line 2181 of file stm32f4xx_hal_rcc_ex.c.

References __HAL_RCC_BACKUPRESET_FORCE, __HAL_RCC_BACKUPRESET_RELEASE, __HAL_RCC_GET_FLAG, __HAL_RCC_PLLI2S_CONFIG, __HAL_RCC_PLLI2S_DISABLE, __HAL_RCC_PLLI2S_ENABLE, __HAL_RCC_PLLI2S_PLLSAICLKDIVQ_CONFIG, __HAL_RCC_PLLI2S_SAICLK_CONFIG, __HAL_RCC_PLLSAI_CONFIG, __HAL_RCC_PLLSAI_DISABLE, __HAL_RCC_PLLSAI_ENABLE, __HAL_RCC_PLLSAI_GET_FLAG, __HAL_RCC_PLLSAI_PLLSAICLKDIVQ_CONFIG, __HAL_RCC_PLLSAI_PLLSAICLKDIVR_CONFIG, __HAL_RCC_PWR_CLK_ENABLE, __HAL_RCC_RTC_CONFIG, __HAL_RCC_TIMCLKPRESCALER, assert_param, HAL_GetTick(), IS_RCC_PERIPHCLOCK, IS_RCC_PLLI2S_DIVQ_VALUE, IS_RCC_PLLI2SN_VALUE, IS_RCC_PLLI2SQ_VALUE, IS_RCC_PLLI2SR_VALUE, IS_RCC_PLLSAI_DIVQ_VALUE, IS_RCC_PLLSAI_DIVR_VALUE, IS_RCC_PLLSAIN_VALUE, IS_RCC_PLLSAIQ_VALUE, IS_RCC_PLLSAIR_VALUE, IS_RCC_RTCCLKSOURCE, RCC_PeriphCLKInitTypeDef::PeriphClockSelection, RCC_PeriphCLKInitTypeDef::PLLI2S, PLLI2S_TIMEOUT_VALUE, RCC_PeriphCLKInitTypeDef::PLLI2SDivQ, RCC_PLLI2SInitTypeDef::PLLI2SN, RCC_PLLI2SInitTypeDef::PLLI2SQ, RCC_PLLI2SInitTypeDef::PLLI2SR, RCC_PeriphCLKInitTypeDef::PLLSAI, PLLSAI_TIMEOUT_VALUE, RCC_PeriphCLKInitTypeDef::PLLSAIDivQ, RCC_PeriphCLKInitTypeDef::PLLSAIDivR, RCC_PLLSAIInitTypeDef::PLLSAIN, RCC_PLLSAIInitTypeDef::PLLSAIQ, RCC_PLLSAIInitTypeDef::PLLSAIR, RCC_DBP_TIMEOUT_VALUE, RCC_FLAG_LSERDY, RCC_FLAG_PLLI2SRDY, RCC_LSE_TIMEOUT_VALUE, RCC_PERIPHCLK_I2S, RCC_PERIPHCLK_LTDC, RCC_PERIPHCLK_RTC, RCC_PERIPHCLK_SAI_PLLI2S, RCC_PERIPHCLK_SAI_PLLSAI, RCC_PERIPHCLK_TIM, RCC_PeriphCLKInitTypeDef::RTCClockSelection, and RCC_PeriphCLKInitTypeDef::TIMPresSelection.