5.15 RCC Guide

name    RCC_DeInit.
fun     Reset the RCC registers.
param   none
return  none

name    RCC_EnableHsi.
fun     Enables the Internal High Speed oscillator (HSI).
param   Cmd:
          - ENABLE
          - DISABLE
return  none
note   HSI can not be stopped if it is used directly or through the PLL as system clock.

name    RCC_WaitHsiStable.
fun     Waits for HSI start-up.
param   none
return  ErrorStatus:
         - SUCCESS    HSI oscillator is stable and ready to use
         - ERROR      HSI oscillator not yet ready

name    RCC_SetHsiCalibValue.
fun     Adjusts the Internal High Speed oscillator (HSI) calibration value.
param   calibration_value(the calibration trimming value):
        This parameter must be a number between 0 and 0x3FF
return  none

name    RCC_ConfigLsiCalibSource.
fun     Configures LSI calibration values source.
param   cal_src:
         - RCC_LSICAL_SRC_AFEC       LSI calibration values are sourced from AFEC
         - RCC_LSICAL_SRC_TRIM       LSI calibration values are sourced from LSITRIM
return  none

name    RCC_SetLsiCalibValue.
fun     Adjusts the Internal Low Speed oscillator (LSI) calibration value.
param   calibration_value(the calibration trimming value):
        This parameter must be a number between 0 and 0x1FF
return  none

name    RCC_ConfigSysclkPres.
fun     Configures the system clock (SYSCLK) prescaler.
param   sysclk_pres(HSI divider used as system clock):
         - RCC_SYSCLK_PRES_DIV1       HSI divide 1 used as system clock
         - RCC_SYSCLK_PRES_DIV2       HSI divide 2 used as system clock
return  none

name    RCC_ConfigSysclk.
fun     Configures the system clock (SYSCLK).
param   sysclk_source(clock source used as system clock):
         - RCC_SYSCLK_SRC_HSI       HSI(or divide 2) selected as system clock
         - RCC_SYSCLK_SRC_LSI       LSI selected as system clock
return  none

name    RCC_GetSysclkSrc.
fun     Returns the clock source used as system clock.
param   none
return  (The clock source used as system clock):
         - RCC_CFG_SCLKSTS_HSI    HSI used as system clock
         - RCC_CFG_SCLKSTS_LSI    LSI used as system clock

name    RCC_ConfigHclk.
fun     Configures the AHB clock (HCLK).
param   sysclk_div(AHB clock is derived from the system clock (SYSCLK)):
         - RCC_SYSCLK_DIV1      AHB clock = SYSCLK
         - RCC_SYSCLK_DIV2      AHB clock = SYSCLK/2
         - RCC_SYSCLK_DIV4      AHB clock = SYSCLK/4
         - RCC_SYSCLK_DIV8      AHB clock = SYSCLK/8
         - RCC_SYSCLK_DIV16     AHB clock = SYSCLK/16
return  none

name    RCC_ConfigPclk.
fun     Configures the Low Speed APB clock (PCLK).
param   hclk_div(APB clock is derived from the AHB clock (HCLK)):
         - RCC_HCLK_DIV1     APB clock = HCLK
         - RCC_HCLK_DIV2     APB clock = HCLK/2
         - RCC_HCLK_DIV4     APB clock = HCLK/4
         - RCC_HCLK_DIV8     APB clock = HCLK/8
         - RCC_HCLK_DIV16    APB clock = HCLK/16
return  none

name    RCC_ConfigAdcHclk.
fun     Configures the ADCHCLK prescaler.
param   hclk_prescaler(ADCHCLK prescaler):
         - RCC_ADCHCLK_DIV2        ADCHPRE[2:0] = 000,  HCLK Clock Divided By 2
         - RCC_ADCHCLK_DIV4        ADCHPRE[2:0] = 011,  HCLK Clock Divided By 4
         - RCC_ADCHCLK_DIV8        ADCHPRE[2:0] = 100, HCLK Clock Divided By 8
         - RCC_ADCHCLK_DIV16       ADCHPRE[2:0] = 101, HCLK Clock Divided By 16
         - RCC_ADCHCLK_DIV32       ADCHPRE[2:0] = 110, HCLK Clock Divided By 32
         - RCC_ADCHCLK_DIV_OTHERS  ADCHPRE[2:0] = others, HCLK Clock Divided By 32
return  none

name    RCC_GetClocksFreqValue.
fun     Returns the frequencies of different on chip clocks.
param   RCC_clocks pointer to a RCC_ClocksType structure which will hold
        the clocks frequencies.
return  none

name    RCC_EnableAHBPeriphClk.
fun     Enables the AHB peripheral clock.
param   AHB_periph (AHB peripheral to gates its clock):
        - RCC_AHB_PERIPH_SQRT
        - RCC_AHB_PERIPH_HDIV
        - RCC_AHB_PERIPH_ADC
        - RCC_AHB_PERIPH_DMA
param   Cmd:
          - ENABLE
          - DISABLE
return  none

name    RCC_EnableAPBPeriphClk.
fun     Enables the High Speed APB peripheral clock.
param   APB_periph (APB peripheral to gates its clock):
        - RCC_APB_PERIPH_GPIO
        - RCC_APB_PERIPH_I2C1
        - RCC_APB_PERIPH_I2C2
        - RCC_APB_PERIPH_PWR
        - RCC_APB_PERIPH_SPI1
        - RCC_APB_PERIPH_SPI2
        - RCC_APB_PERIPH_TIM1
        - RCC_APB_PERIPH_TIM3
        - RCC_APB_PERIPH_TIM4
        - RCC_APB_PERIPH_TIM6
        - RCC_APB_PERIPH_UART1
        - RCC_APB_PERIPH_UART2
        - RCC_APB_PERIPH_UART3
        - RCC_APB_PERIPH_COMP
        - RCC_APB_PERIPH_COMPFILT
        - RCC_APB_PERIPH_OPA
param   Cmd:
          - ENABLE
          - DISABLE
return none.

name    RCC_EnableAHBPeriphReset.
fun     AHB peripheral reset.
param   AHB_periph specifies the AHB peripheral to reset.
        - RCC_AHB_PERIPH_SQRT
        - RCC_AHB_PERIPH_HDIV
        - RCC_AHB_PERIPH_ADC
return none.

name    RCC_EnableAPB1PeriphReset.
fun     Low Speed APB (APB1) peripheral reset.
param   APB1_periph specifies the APB1 peripheral to reset.
        - RCC_APB_PERIPH_GPIO
        - RCC_APB_PERIPH_I2C1
        - RCC_APB_PERIPH_I2C2
        - RCC_APB_PERIPH_SPI1
        - RCC_APB_PERIPH_SPI2
        - RCC_APB_PERIPH_TIM1
        - RCC_APB_PERIPH_TIM3
        - RCC_APB_PERIPH_TIM4
        - RCC_APB_PERIPH_TIM6
        - RCC_APB_PERIPH_UART1
        - RCC_APB_PERIPH_UART2
        - RCC_APB_PERIPH_UART3
        - RCC_APB_PERIPH_COMP
        - RCC_APB_PERIPH_OPA
return none.

name    RCC_ConfigMcoClkPre.
fun         Configures the MCO System and HSI clock prescaler.
param   MCO_PLL_prescaler specifies the MCO PLL clock prescaler.
      This parameter can be on of the following values:
        - RCC_MCO_CLK_DIV2    MCOPRE[2:0] = 010, System and HSI Clock Divided By 2
        - RCC_MCO_CLK_DIV3    MCOPRE[2:0] = 011, System and HSI Clock Divided By 3
        - RCC_MCO_CLK_DIV4    MCOPRE[2:0] = 100, System and HSI Clock Divided By 4
        - RCC_MCO_CLK_DIV5    MCOPRE[2:0] = 101, System and HSI Clock Divided By 5
        - RCC_MCO_CLK_DIV6    MCOPRE[2:0] = 110, System and HSI Clock Divided By 6
        - RCC_MCO_CLK_DIV7    MCOPRE[2:0] = 111, System and HSI Clock Divided By 7
return  none.

name   RCC_ConfigMco.
fun    Selects the clock source to output on MCO pin.
param  MCO_source(clock source to output):
        - RCC_MCO_NOCLK       No clock selected
        - RCC_MCO_LSI         LSI oscillator clock selected
        - RCC_MCO_SYSCLK      System clock selected
        - RCC_MCO_HSI         HSI oscillator clock selected
return  none.

name    RCC_GetFlagStatus.
fun     Checks whether the specified RCC flag is set or not.
param   RCC_flag:
          - RCC_CTRL_FLAG_HSIRDF           HSI oscillator clock ready
          - RCC_CTRL_FLAG_LSICALCF         LSI Calibration finish
          - RCC_CLKINT_FLAG_LSIRDF         LSI oscillator clock ready
          - RCC_CTRLSTS_FLAG_PINRSTF       Pin reset
          - RCC_CTRLSTS_FLAG_PORRSTF       POR/PDR reset
          - RCC_CTRLSTS_FLAG_SFTRSTF       Software reset
          - RCC_CTRLSTS_FLAG_IWDGRSTF      Independent Watchdog reset
          - RCC_CTRLSTS_FLAG_GLITCHF       Glitch reset
          - RCC_CTRLSTS_FLAG_EMCGBNRSTF    EMCGBN reset
          - RCC_CTRLSTS_FLAG_EMCGBRSTF     EMCGB reset
          - RCC_CTRLSTS_FLAG_LKUPRSTF      M0 lock up reset
return  FlagStatus:
          - SET
          - RESET

name    RCC_ClearResetFlag.
fun     Clears the RCC reset flags.
param   none
return  none
note  Clear the following flags:
          - RCC_CTRLSTS_FLAG_PINRSTF       Pin reset
          - RCC_CTRLSTS_FLAG_PORRSTF       POR/PDR reset
          - RCC_CTRLSTS_FLAG_SFTRSTF       Software reset
          - RCC_CTRLSTS_FLAG_IWDGRSTF      Independent Watchdog reset
          - RCC_CTRLSTS_FLAG_GLITCHF       Glitch reset
          - RCC_CTRLSTS_FLAG_EMCGBNRSTF    EMCGBN reset
          - RCC_CTRLSTS_FLAG_EMCGBRSTF     EMCGB reset
          - RCC_CTRLSTS_FLAG_LKUPRSTF      M0 lock up reset

name    RCC_GetIntStatus.
fun     Checks whether the specified RCC interrupt has occurred or not.
param   interrupt_flag(RCC interrupt source to check):
        -  RCC_INT_LSIRDIF    LSI ready interrupt
        -  RCC_INT_HSIRDIF    HSI ready interrupt
return  The new state of RccInt
         - SET
         - RESET

name    RCC_ClrIntPendingBit.
fun     Clears the RCC's interrupt pending bits.
param   RccInt specifies the interrupt pending bit to clear.
          -  RCC_CLR_LSIRDIF    Clear LSI ready interrupt flag
          -  RCC_CLR_HSIRDIF    Clear HSI ready interrupt flag
return  none.

name    RCC_EnableEMCReset.
fun     Configure whether to generate a reset request when an EMC error occurs.
param   EMC_type:
          - RCC_EMC_GB
          - RCC_EMC_GBN
param   Cmd:
          - ENABLE
          - DISABLE
return  none.

name    RCC_EnableEMCDetect.
fun     Configure whether to enable EMC detection.
param   EMC_type:
          - RCC_EMC_GB
          - RCC_EMC_GBN
param   Cmd:
          - ENABLE
          - DISABLE
return  none.

name    RCC_EnableEMCSwitch.
fun     Configure whether to enable EMC switch.
param   EMC_type:
          - RCC_EMC_GB
          - RCC_EMC_GBN
param   Cmd:
          - ENABLE
          - DISABLE
return  none.

name    RCC_ConfigEMCDetectLevel.
fun     Configures the voltage threshold detected by the EMC.
param   EMC_type:
          - RCC_EMC_GB
          - RCC_EMC_GBN
param   level (The input parameters must be the following values):
          - 0x0 ~ 0x3
return  none

name    RCC_EnableGlitchDetect.
fun     Configure whether to enable Glitch.
param   Cmd:
          - ENABLE
          - DISABLE
return  none.
note   After enabling the GVDET bit by RCC_EnableGlitchDetect(), a delay of 10us or more is required to
       enable the GVRST bit and GVSW bit by RCC_EnableGlitchReset() and RCC_EnableGlitchSwitch().

name    RCC_EnableGlitchReset.
fun     Configure whether to enable Glitch reset.
param   Cmd:
          - ENABLE
          - DISABLE
return  none.

name    RCC_EnableGlitchSwitch.
fun     Configure whether to enable Glitch switch.
param   Cmd:
          - ENABLE
          - DISABLE
return  none.

name    RCC_ConfigGlitchDetectLevel.
fun     Configures the voltage threshold detected by the Glitch.
param   level (The input parameters must be the following values):
        - 0x0 ~ 0x1F
return  none

name    RCC_EnableM0LockupReset.
fun     Configure whether to enable M0 lockup reset.
param   Cmd:
          - ENABLE
          - DISABLE
return  none.

name    RCC_ConfigTimClk.
fun     Configures the TIM1/3/4 clock source(TIMCLK).
param   timer_clksrc(TIM clock source):
         - RCC_TIM_CLKSRC_HCLK
         - RCC_TIM_CLKSRC_SYSCLK
return  none

name    RCC_ConfigTim6Clk.
fun     Configures the TIM6 clock source(TIM6CLK).
param   timer_clksrc(TIM6 clock source):
         - RCC_TIM6_CLKSRC_SYSCLK
         - RCC_TIM6_CLKSRC_LSI
return  none

name    RCC_ConfigUart3Clk.
fun     Configures the UART3 clock source(UART3CLK).
param   uart3_clksrc(UART3 clock source):
         - RCC_UART3_CLKSRC_PCLK
         - RCC_UART3_CLKSRC_LSI
return  none

name    RCC_ConfigIOFilter.
fun     Configures the Speed of GPIO fliter.
param   ioflitclk_div value(IO Fliter clock is derived from the AHB clock (HCLK)):
        -0 ~ 0xF
return  none

name    RCC_ConfigTIM4Filter.
fun     Configures the Speed of TIM4 fliter.
param   tim4flitclk_div value(TIM4 Fliter clock is derived from the AHB clock (HCLK)):
        -0 ~ 0x1F
return  none

name    RCC_ConfigTIM3Filter.
fun     Configures the Speed of TIM3 fliter.
param   tim3flitclk_div value(TIM3 Fliter clock is derived from the AHB clock (HCLK)):
        -0 ~ 0x1F
return  none

name    RCC_ConfigTIM1Filter.
fun     Configures the Speed of TIM1 fliter.
param   tim1flitclk_div value(TIM1 Fliter clock is derived from the AHB clock (HCLK)):
        -0 ~ 0x1F
return  none

name    RCC_ConfigLSICalibPeriod.
fun     Configure LSI Calibration Period.
param   lsi_period:
         - RCC_LSICAL_PERIOD_128   Count the HSI clock within 128 LSI cycles
         - RCC_LSICAL_PERIOD_256   Count the HSI clock within 256 LSI cycles
         - RCC_LSICAL_PERIOD_512   Count the HSI clock within 512 LSI cycles
         - RCC_LSICAL_PERIOD_1024  Count the HSI clock within 1024 LSI cycles
return  none

name    RCC_EnableLSICalibration.
fun     Configure whether to start LSI Calibration calculation.
param   Cmd:
          - ENABLE
          - DISABLE
return  none.

name    RCC_GetHSICalibPeriod
fun     Gets the HSI(64MHz) captures the number of LSI cycles within the clock calibration period.
param   none
return  HSI captures value.