libopencm3
A free/libre/open-source firmware library for various ARM Cortex-M3 microcontrollers.
|
libopencm3 GD32F1x0 Reset and Clock Control More...
Macros | |
#define | _RCC_REG(i) MMIO32(RCC_BASE + ((i) >> 5)) |
#define | _RCC_BIT(i) (1 << ((i) & 0x1f)) |
Functions | |
void | rcc_osc_ready_int_clear (enum rcc_osc osc) |
RCC Clear the Oscillator Ready Interrupt Flag. More... | |
void | rcc_osc_ready_int_enable (enum rcc_osc osc) |
RCC Enable the Oscillator Ready Interrupt. More... | |
void | rcc_osc_ready_int_disable (enum rcc_osc osc) |
RCC Disable the Oscillator Ready Interrupt. More... | |
int | rcc_osc_ready_int_flag (enum rcc_osc osc) |
RCC Read the Oscillator Ready Interrupt Flag. More... | |
void | rcc_css_int_clear (void) |
RCC Clear the Clock Security System Interrupt Flag. More... | |
int | rcc_css_int_flag (void) |
RCC Read the Clock Security System Interrupt Flag. More... | |
void | rcc_wait_for_osc_ready (enum rcc_osc osc) |
RCC Wait for Oscillator Ready. More... | |
void | rcc_osc_on (enum rcc_osc osc) |
RCC Turn on an Oscillator. More... | |
void | rcc_osc_off (enum rcc_osc osc) |
RCC Turn off an Oscillator. More... | |
void | rcc_css_enable (void) |
RCC Enable the Clock Security System. More... | |
void | rcc_css_disable (void) |
RCC Disable the Clock Security System. More... | |
void | rcc_set_sysclk_source (uint32_t clk) |
RCC Set the Source for the System Clock. More... | |
void | rcc_set_pll_multiplication_factor (uint32_t mul) |
RCC Set the PLL Multiplication Factor. More... | |
void | rcc_set_pll_source (uint32_t pllsrc) |
RCC Set the PLL Clock Source. More... | |
void | rcc_set_pllxtpre (uint32_t pllxtpre) |
RCC Set the HSE Frequency Divider used as PLL Clock Source. More... | |
uint32_t | rcc_rtc_clock_enabled_flag (void) |
RCC RTC Clock Enabled Flag. More... | |
void | rcc_enable_rtc_clock (void) |
RCC Enable the RTC clock. More... | |
void | rcc_set_rtc_clock_source (enum rcc_osc clock_source) |
RCC Set the Source for the RTC clock. More... | |
void | rcc_set_adcpre (uint32_t adcpre) |
ADC Setup the A/D Clock. More... | |
void | rcc_set_ppre2 (uint32_t ppre2) |
RCC Set the APB2 Prescale Factor. More... | |
void | rcc_set_ppre1 (uint32_t ppre1) |
RCC Set the APB1 Prescale Factor. More... | |
void | rcc_set_hpre (uint32_t hpre) |
RCC Set the AHB Prescale Factor. More... | |
void | rcc_set_usbpre (uint32_t usbpre) |
RCC Set the USB Prescale Factor. More... | |
void | rcc_set_prediv (uint32_t prediv) |
uint32_t | rcc_system_clock_source (void) |
RCC Get the System Clock Source. More... | |
void | rcc_clock_setup_pll (const struct rcc_clock_scale *clock) |
Setup clocks to run from PLL. More... | |
void | rcc_backupdomain_reset (void) |
RCC Reset the Backup Domain. More... | |
void | rcc_peripheral_enable_clock (volatile uint32_t *reg, uint32_t en) |
RCC Enable Peripheral Clocks. More... | |
void | rcc_peripheral_disable_clock (volatile uint32_t *reg, uint32_t en) |
RCC Disable Peripheral Clocks. More... | |
void | rcc_peripheral_reset (volatile uint32_t *reg, uint32_t reset) |
RCC Reset Peripherals. More... | |
void | rcc_peripheral_clear_reset (volatile uint32_t *reg, uint32_t clear_reset) |
RCC Remove Reset on Peripherals. More... | |
void | rcc_periph_clock_enable (enum rcc_periph_clken clken) |
Enable Peripheral Clock in running mode. More... | |
void | rcc_periph_clock_disable (enum rcc_periph_clken clken) |
Disable Peripheral Clock in running mode. More... | |
void | rcc_periph_reset_pulse (enum rcc_periph_rst rst) |
Reset Peripheral, pulsed. More... | |
void | rcc_periph_reset_hold (enum rcc_periph_rst rst) |
Reset Peripheral, hold. More... | |
void | rcc_periph_reset_release (enum rcc_periph_rst rst) |
Reset Peripheral, release. More... | |
void | rcc_set_mco (uint32_t mcosrc) |
Select the source of Microcontroller Clock Output. More... | |
void | rcc_osc_bypass_enable (enum rcc_osc osc) |
RCC Enable Bypass. More... | |
void | rcc_osc_bypass_disable (enum rcc_osc osc) |
RCC Disable Bypass. More... | |
uint16_t | rcc_get_div_from_hpre (uint8_t div_val) |
This will return the divisor 1/2/4/8/16/64/128/256/512 which is set as a 4-bit value, typically used for hpre and other prescalers. More... | |
Variables | |
uint32_t | rcc_apb1_frequency = 8000000 |
Set the default clock frequencies. More... | |
uint32_t | rcc_apb2_frequency = 8000000 |
uint32_t | rcc_ahb_frequency = 8000000 |
const struct rcc_clock_scale | rcc_hsi_configs [] |
const struct rcc_clock_scale | rcc_hse8_configs [] |
libopencm3 GD32F1x0 Reset and Clock Control
This library supports the Reset and Clock Control System in the GD32F1x0 series of ARM Cortex Microcontrollers by GigaDevice.
Clock settings and resets for many peripherals are given here rather than in the corresponding peripheral library.
The library also provides a number of common configurations for the processor system clock. Not all possible configurations are included.
LGPL License Terms libopencm3 License
#define _RCC_BIT | ( | i | ) | (1 << ((i) & 0x1f)) |
Definition at line 117 of file rcc_common_all.c.
Definition at line 116 of file rcc_common_all.c.
void rcc_backupdomain_reset | ( | void | ) |
RCC Reset the Backup Domain.
The backup domain registers are reset to disable RTC controls and clear user data.
Definition at line 644 of file rcc.c.
References RCC_BDCR, and RCC_BDCR_BDRST.
void rcc_clock_setup_pll | ( | const struct rcc_clock_scale * | clock | ) |
Setup clocks to run from PLL.
The arguments provide the pll source, multipliers, dividers, all that's needed to establish a system clock.
clock | clock information structure |
Definition at line 581 of file rcc.c.
References rcc_clock_scale::adcpre, rcc_clock_scale::ahb_frequency, rcc_clock_scale::apb1_frequency, rcc_clock_scale::apb2_frequency, rcc_clock_scale::hpre, rcc_clock_scale::pll_hse_prediv, rcc_clock_scale::pllmul, rcc_clock_scale::ppre1, rcc_clock_scale::ppre2, rcc_ahb_frequency, rcc_apb1_frequency, rcc_apb2_frequency, RCC_CFGR_PLLSRC_HSE_CLK, RCC_CFGR_PLLSRC_HSI_CLK_DIV2, RCC_CFGR_SW_SYSCLKSEL_HSECLK, RCC_CFGR_SW_SYSCLKSEL_HSICLK, RCC_CFGR_SW_SYSCLKSEL_PLLCLK, RCC_HSE, RCC_HSI, rcc_osc_on(), RCC_PLL, rcc_set_adcpre(), rcc_set_hpre(), rcc_set_pll_multiplication_factor(), rcc_set_pll_source(), rcc_set_ppre1(), rcc_set_ppre2(), rcc_set_prediv(), rcc_set_sysclk_source(), rcc_set_usbpre(), rcc_wait_for_osc_ready(), rcc_clock_scale::usbpre, and rcc_clock_scale::use_hse.
void rcc_css_disable | ( | void | ) |
void rcc_css_enable | ( | void | ) |
RCC Enable the Clock Security System.
Definition at line 341 of file rcc.c.
References RCC_CR, and RCC_CR_CSSON.
void rcc_css_int_clear | ( | void | ) |
RCC Clear the Clock Security System Interrupt Flag.
Definition at line 222 of file rcc.c.
References RCC_CIR, and RCC_CIR_CSSC.
int rcc_css_int_flag | ( | void | ) |
RCC Read the Clock Security System Interrupt Flag.
Definition at line 233 of file rcc.c.
References RCC_CIR, and RCC_CIR_CSSF.
void rcc_enable_rtc_clock | ( | void | ) |
RCC Enable the RTC clock.
Definition at line 427 of file rcc.c.
References RCC_BDCR, and RCC_BDCR_RTCEN.
uint16_t rcc_get_div_from_hpre | ( | uint8_t | div_val | ) |
This will return the divisor 1/2/4/8/16/64/128/256/512 which is set as a 4-bit value, typically used for hpre and other prescalers.
div_val | Masked and shifted divider value from register (e.g. RCC_CFGR) |
Definition at line 260 of file rcc_common_all.c.
void rcc_osc_bypass_disable | ( | enum rcc_osc | osc | ) |
RCC Disable Bypass.
Re-enable the internal clock (high speed and low speed clocks only). The internal clock must be disabled (see rcc_osc_off) for this to have effect.
[in] | osc | Oscillator ID. Only HSE and LSE have effect. |
Definition at line 238 of file rcc_common_all.c.
void rcc_osc_bypass_enable | ( | enum rcc_osc | osc | ) |
RCC Enable Bypass.
Enable an external clock to bypass the internal clock (high speed and low speed clocks only). The external clock must be enabled (see rcc_osc_on) and the internal clock must be disabled (see rcc_osc_off) for this to have effect.
[in] | osc | Oscillator ID. Only HSE and LSE have effect. |
Definition at line 208 of file rcc_common_all.c.
References RCC_BDCR, RCC_BDCR_LSEBYP, RCC_CR, RCC_CR_HSEBYP, RCC_CSR, RCC_HSE, and RCC_LSE.
void rcc_osc_off | ( | enum rcc_osc | osc | ) |
RCC Turn off an Oscillator.
Disable an oscillator and power off.
[in] | osc | Oscillator ID |
Definition at line 315 of file rcc.c.
References RCC_BDCR, RCC_CR, RCC_CSR, RCC_HSE, RCC_HSI, RCC_LSE, RCC_LSI, and RCC_PLL.
void rcc_osc_on | ( | enum rcc_osc | osc | ) |
RCC Turn on an Oscillator.
Enable an oscillator and power on. Each oscillator requires an amount of time to settle to a usable state. Refer to datasheets for time delay information. A status flag is available to indicate when the oscillator becomes ready (see rcc_osc_ready_int_flag and rcc_wait_for_osc_ready).
[in] | osc | Oscillator ID |
Definition at line 280 of file rcc.c.
References RCC_BDCR, RCC_BDCR_LSEON, RCC_CR, RCC_CR_HSEON, RCC_CR_HSION, RCC_CR_PLLON, RCC_CSR, RCC_CSR_LSION, RCC_HSE, RCC_HSI, RCC_LSE, RCC_LSI, and RCC_PLL.
Referenced by rcc_clock_setup_pll().
void rcc_osc_ready_int_clear | ( | enum rcc_osc | osc | ) |
RCC Clear the Oscillator Ready Interrupt Flag.
Clear the interrupt flag that was set when a clock oscillator became ready to use.
[in] | osc | Oscillator ID |
Definition at line 112 of file rcc.c.
References RCC_CIR, RCC_CIR_HSERDYC, RCC_CIR_HSIRDYC, RCC_CIR_LSERDYC, RCC_CIR_LSIRDYC, RCC_CIR_PLLRDYC, RCC_HSE, RCC_HSI, RCC_LSE, RCC_LSI, and RCC_PLL.
void rcc_osc_ready_int_disable | ( | enum rcc_osc | osc | ) |
void rcc_osc_ready_int_enable | ( | enum rcc_osc | osc | ) |
RCC Enable the Oscillator Ready Interrupt.
[in] | osc | Oscillator ID |
Definition at line 139 of file rcc.c.
References RCC_CIR, RCC_CIR_HSERDYIE, RCC_CIR_HSIRDYIE, RCC_CIR_LSERDYIE, RCC_CIR_LSIRDYIE, RCC_CIR_PLLRDYIE, RCC_HSE, RCC_HSI, RCC_LSE, RCC_LSI, and RCC_PLL.
int rcc_osc_ready_int_flag | ( | enum rcc_osc | osc | ) |
RCC Read the Oscillator Ready Interrupt Flag.
[in] | osc | Oscillator ID |
Definition at line 194 of file rcc.c.
References cm3_assert_not_reached, RCC_CIR, RCC_CIR_HSERDYF, RCC_CIR_HSIRDYF, RCC_CIR_LSERDYF, RCC_CIR_LSIRDYF, RCC_CIR_PLLRDYF, RCC_HSE, RCC_HSI, RCC_LSE, RCC_LSI, and RCC_PLL.
void rcc_periph_clock_disable | ( | enum rcc_periph_clken | clken | ) |
Disable Peripheral Clock in running mode.
Disable the clock on particular peripheral.
[in] | clken | rcc_periph_clken Peripheral RCC |
For available constants, see rcc_periph_clken (RCC_UART1 for example)
Definition at line 139 of file rcc_common_all.c.
References _RCC_REG.
void rcc_periph_clock_enable | ( | enum rcc_periph_clken | clken | ) |
Enable Peripheral Clock in running mode.
Enable the clock on particular peripheral.
[in] | clken | rcc_periph_clken Peripheral RCC |
For available constants, see rcc_periph_clken (RCC_UART1 for example)
Definition at line 127 of file rcc_common_all.c.
void rcc_periph_reset_hold | ( | enum rcc_periph_rst | rst | ) |
Reset Peripheral, hold.
Reset particular peripheral, and hold in reset state.
[in] | rst | rcc_periph_rst Peripheral reset |
For available constants, see rcc_periph_rst (RST_UART1 for example)
Definition at line 166 of file rcc_common_all.c.
void rcc_periph_reset_pulse | ( | enum rcc_periph_rst | rst | ) |
Reset Peripheral, pulsed.
Reset particular peripheral, and restore to working state.
[in] | rst | rcc_periph_rst Peripheral reset |
For available constants, see rcc_periph_rst (RST_UART1 for example)
Definition at line 152 of file rcc_common_all.c.
void rcc_periph_reset_release | ( | enum rcc_periph_rst | rst | ) |
Reset Peripheral, release.
Restore peripheral from reset state to working state.
[in] | rst | rcc_periph_rst Peripheral reset |
For available constants, see rcc_periph_rst (RST_UART1 for example)
Definition at line 179 of file rcc_common_all.c.
References _RCC_REG.
void rcc_peripheral_clear_reset | ( | volatile uint32_t * | reg, |
uint32_t | clear_reset | ||
) |
RCC Remove Reset on Peripherals.
Remove the reset on particular peripherals. There are three registers involved, each one controlling reset of peripherals associated with the AHB, APB1 and APB2 respectively. Several peripherals could have the reset removed simultaneously only if they are controlled by the same register.
[in] | *reg | Unsigned int32. Pointer to a Reset Register (either RCC_AHBENR, RCC_APB1ENR or RCC_APB2ENR) |
[in] | clear_reset | Unsigned int32. Logical OR of all resets to be removed:
|
Definition at line 111 of file rcc_common_all.c.
void rcc_peripheral_disable_clock | ( | volatile uint32_t * | reg, |
uint32_t | en | ||
) |
RCC Disable Peripheral Clocks.
Disable the clock on particular peripherals. There are three registers involved, each one controlling the enabling of clocks associated with the AHB, APB1 and APB2 respectively. Several peripherals could be disabled simultaneously only if they are controlled by the same register.
[in] | *reg | Unsigned int32. Pointer to a Clock Enable Register (either RCC_AHBENR, RCC_APB1ENR or RCC_APB2ENR) |
[in] | en | Unsigned int32. Logical OR of all enables to be used for disabling.
|
Definition at line 66 of file rcc_common_all.c.
void rcc_peripheral_enable_clock | ( | volatile uint32_t * | reg, |
uint32_t | en | ||
) |
RCC Enable Peripheral Clocks.
Enable the clock on particular peripherals. There are three registers involved, each one controlling the enabling of clocks associated with the AHB, APB1 and APB2 respectively. Several peripherals could be enabled simultaneously only if they are controlled by the same register.
[in] | *reg | Unsigned int32. Pointer to a Clock Enable Register (either RCC_AHBENR, RCC_APB1ENR or RCC_APB2ENR) |
[in] | en | Unsigned int32. Logical OR of all enables to be set
|
Definition at line 44 of file rcc_common_all.c.
void rcc_peripheral_reset | ( | volatile uint32_t * | reg, |
uint32_t | reset | ||
) |
RCC Reset Peripherals.
Reset particular peripherals. There are three registers involved, each one controlling reset of peripherals associated with the AHB, APB1 and APB2 respectively. Several peripherals could be reset simultaneously only if they are controlled by the same register.
[in] | *reg | Unsigned int32. Pointer to a Reset Register (either RCC_AHBENR, RCC_APB1ENR or RCC_APB2ENR) |
[in] | reset | Unsigned int32. Logical OR of all resets.
|
Definition at line 88 of file rcc_common_all.c.
uint32_t rcc_rtc_clock_enabled_flag | ( | void | ) |
RCC RTC Clock Enabled Flag.
Definition at line 417 of file rcc.c.
References RCC_BDCR, and RCC_BDCR_RTCEN.
void rcc_set_adcpre | ( | uint32_t | adcpre | ) |
ADC Setup the A/D Clock.
The ADC's have a common clock prescale setting.
[in] | adcpre | Prescale divider taken from ADCPRE: ADC prescaler |
Definition at line 487 of file rcc.c.
References rcc_clock_scale::adcpre, RCC_CFGR, and RCC_CFGR_ADCPRE_SHIFT.
Referenced by rcc_clock_setup_pll().
void rcc_set_hpre | ( | uint32_t | hpre | ) |
RCC Set the AHB Prescale Factor.
[in] | hpre | AHB prescale factor HPRE: AHB prescaler |
Definition at line 526 of file rcc.c.
References rcc_clock_scale::hpre, RCC_CFGR, and RCC_CFGR_HPRE_SHIFT.
Referenced by rcc_clock_setup_pll().
void rcc_set_mco | ( | uint32_t | mcosrc | ) |
Select the source of Microcontroller Clock Output.
Exact sources available depend on your target. On devices with multiple MCO pins, this function controls MCO1
[in] | mcosrc | the unshifted source bits |
Definition at line 191 of file rcc_common_all.c.
References RCC_CFGR, RCC_CFGR_MCO_MASK, and RCC_CFGR_MCO_SHIFT.
void rcc_set_pll_multiplication_factor | ( | uint32_t | mul | ) |
RCC Set the PLL Multiplication Factor.
[in] | mul | PLL multiplication factor PLLMUL: PLL multiplication factor |
Definition at line 376 of file rcc.c.
References RCC_CFGR, RCC_CFGR_PLLMUL_0_3_SHIFT, and RCC_CFGR_PLLMUL_4_SHIFT.
Referenced by rcc_clock_setup_pll().
void rcc_set_pll_source | ( | uint32_t | pllsrc | ) |
RCC Set the PLL Clock Source.
[in] | pllsrc | PLL clock source PLLSRC: PLL entry clock source |
Definition at line 391 of file rcc.c.
References RCC_CFGR.
Referenced by rcc_clock_setup_pll().
void rcc_set_pllxtpre | ( | uint32_t | pllxtpre | ) |
RCC Set the HSE Frequency Divider used as PLL Clock Source.
[in] | pllxtpre | HSE division factor PLLXTPRE: HSE divider for PLL entry |
Definition at line 405 of file rcc.c.
References RCC_CFGR.
void rcc_set_ppre1 | ( | uint32_t | ppre1 | ) |
RCC Set the APB1 Prescale Factor.
[in] | ppre1 | APB1 prescale factor rcc_cfgr_apb1pre |
Definition at line 513 of file rcc.c.
References rcc_clock_scale::ppre1, RCC_CFGR, and RCC_CFGR_PPRE1_SHIFT.
Referenced by rcc_clock_setup_pll().
void rcc_set_ppre2 | ( | uint32_t | ppre2 | ) |
RCC Set the APB2 Prescale Factor.
[in] | ppre2 | APB2 prescale factor rcc_cfgr_apb2pre |
Definition at line 499 of file rcc.c.
References rcc_clock_scale::ppre2, RCC_CFGR, and RCC_CFGR_PPRE2_SHIFT.
Referenced by rcc_clock_setup_pll().
void rcc_set_prediv | ( | uint32_t | prediv | ) |
Definition at line 549 of file rcc.c.
References RCC_CFGR2.
Referenced by rcc_clock_setup_pll().
void rcc_set_rtc_clock_source | ( | enum rcc_osc | clock_source | ) |
RCC Set the Source for the RTC clock.
[in] | clock_source | RTC clock source. Only HSE/128, LSE and LSI. |
Definition at line 438 of file rcc.c.
References RCC_BDCR, RCC_BDCR_LSEON, RCC_BDCR_LSERDY, RCC_CR, RCC_CR_HSEON, RCC_CR_HSERDY, RCC_CSR, RCC_CSR_LSION, RCC_CSR_LSIRDY, RCC_HSE, RCC_HSI, RCC_LSE, RCC_LSI, and RCC_PLL.
void rcc_set_sysclk_source | ( | uint32_t | clk | ) |
RCC Set the Source for the System Clock.
[in] | clk | System Clock Selection SW: System clock switch |
Definition at line 362 of file rcc.c.
References RCC_CFGR, and RCC_CFGR_SW_SHIFT.
Referenced by rcc_clock_setup_pll().
void rcc_set_usbpre | ( | uint32_t | usbpre | ) |
RCC Set the USB Prescale Factor.
The prescale factor can be set to 1 (no prescale) for use when the PLL clock is 48MHz, or 1.5 to generate the 48MHz USB clock from a 64MHz PLL clock.
[in] | usbpre | USB prescale factor USBPRE: USB prescaler (RCC_CFGR[23:22]) |
Definition at line 544 of file rcc.c.
References RCC_CFGR, and rcc_clock_scale::usbpre.
Referenced by rcc_clock_setup_pll().
uint32_t rcc_system_clock_source | ( | void | ) |
RCC Get the System Clock Source.
Definition at line 563 of file rcc.c.
References RCC_CFGR, RCC_CFGR_SWS, and RCC_CFGR_SWS_SHIFT.
void rcc_wait_for_osc_ready | ( | enum rcc_osc | osc | ) |
RCC Wait for Oscillator Ready.
Wait for Oscillator Ready.
[in] | osc | Oscillator ID |
Definition at line 244 of file rcc.c.
References RCC_BDCR, RCC_BDCR_LSERDY, RCC_CR, RCC_CR_HSERDY, RCC_CR_HSIRDY, RCC_CR_PLLRDY, RCC_CSR, RCC_CSR_LSIRDY, RCC_HSE, RCC_HSI, RCC_LSE, RCC_LSI, and RCC_PLL.
Referenced by rcc_clock_setup_pll().
uint32_t rcc_ahb_frequency = 8000000 |
Definition at line 60 of file rcc.c.
Referenced by rcc_clock_setup_pll().
uint32_t rcc_apb1_frequency = 8000000 |
Set the default clock frequencies.
Definition at line 58 of file rcc.c.
Referenced by rcc_clock_setup_pll().
uint32_t rcc_apb2_frequency = 8000000 |
Definition at line 59 of file rcc.c.
Referenced by rcc_clock_setup_pll().
const struct rcc_clock_scale rcc_hse8_configs[] |
const struct rcc_clock_scale rcc_hsi_configs[] |