EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: gd32/f1x0: fix missing tags, drop wrong tags

Browse Source 
Drop incorrect/redundant type information from doxygen parameters
Adds groupings that are referred to.
This commit is contained in:
Karl Palsson
2019-06-25 14:00:53 +00:00
parent 1964fd72f2
commit 0cd06bcc97
2 changed files with 71 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
include/libopencm3/gd32/f1x0/rcc.h
View File

@@ -128,13 +128,18 @@
#define RCC_CFGR_SW_SHIFT 0 #define RCC_CFGR_SW_SHIFT 0
#define RCC_CFGR_SW (3 << RCC_CFGR_SW_SHIFT) #define RCC_CFGR_SW (3 << RCC_CFGR_SW_SHIFT)
/* USBPRE: USB prescaler (RCC_CFGR[23:22]) */ /** @defgroup rcc_cfgr_usbpre USBPRE: USB prescaler (RCC_CFGR[23:22])
* @{
*/
#define RCC_CFGR_USBPRE_PLL_CLK_DIV1_5 0x0 #define RCC_CFGR_USBPRE_PLL_CLK_DIV1_5 0x0
#define RCC_CFGR_USBPRE_PLL_CLK_NODIV 0x1 #define RCC_CFGR_USBPRE_PLL_CLK_NODIV 0x1
#define RCC_CFGR_USBPRE_PLL_CLK_DIV2_5 0x2 #define RCC_CFGR_USBPRE_PLL_CLK_DIV2_5 0x2
#define RCC_CFGR_USBPRE_PLL_CLK_DIV2 0x3 #define RCC_CFGR_USBPRE_PLL_CLK_DIV2 0x3
/**@}*/
/* PLLMUL: PLL multiplication factor */ /** @defgroup rcc_cfgr_pmf PLLMUL: PLL multiplication factor
* @{
*/
#define RCC_CFGR_PLLMUL_PLL_CLK_MUL2 0x0 #define RCC_CFGR_PLLMUL_PLL_CLK_MUL2 0x0
#define RCC_CFGR_PLLMUL_PLL_CLK_MUL3 0x1 #define RCC_CFGR_PLLMUL_PLL_CLK_MUL3 0x1
#define RCC_CFGR_PLLMUL_PLL_CLK_MUL4 0x2 #define RCC_CFGR_PLLMUL_PLL_CLK_MUL4 0x2
@@ -150,37 +155,54 @@
#define RCC_CFGR_PLLMUL_PLL_CLK_MUL14 0xc #define RCC_CFGR_PLLMUL_PLL_CLK_MUL14 0xc
#define RCC_CFGR_PLLMUL_PLL_CLK_MUL15 0xd #define RCC_CFGR_PLLMUL_PLL_CLK_MUL15 0xd
#define RCC_CFGR_PLLMUL_PLL_CLK_MUL16 0xe #define RCC_CFGR_PLLMUL_PLL_CLK_MUL16 0xe
/**@}*/
/* PLLXTPRE: HSE divider for PLL entry */ /** @defgroup rcc_cfgr_hsepre PLLXTPRE: HSE divider for PLL entry
* @{
*/
#define RCC_CFGR_PLLXTPRE_HSE_CLK 0x0 #define RCC_CFGR_PLLXTPRE_HSE_CLK 0x0
#define RCC_CFGR_PLLXTPRE_HSE_CLK_DIV2 0x1 #define RCC_CFGR_PLLXTPRE_HSE_CLK_DIV2 0x1
/**@}*/
/* PLLSRC: PLL entry clock source */ /** @defgroup rcc_cfgr_pcs PLLSRC: PLL entry clock source
* @{
*/
#define RCC_CFGR_PLLSRC_HSI_CLK_DIV2 0x0 #define RCC_CFGR_PLLSRC_HSI_CLK_DIV2 0x0
#define RCC_CFGR_PLLSRC_HSE_CLK 0x1 #define RCC_CFGR_PLLSRC_HSE_CLK 0x1
/**@}*/
/* ADCPRE: ADC prescaler */ /** @defgroup rcc_cfgr_adcpre ADCPRE: ADC prescaler
/****************************************************************************/ * @{
*/
#define RCC_CFGR_ADCPRE_PCLK2_DIV2 0x0 #define RCC_CFGR_ADCPRE_PCLK2_DIV2 0x0
#define RCC_CFGR_ADCPRE_PCLK2_DIV4 0x1 #define RCC_CFGR_ADCPRE_PCLK2_DIV4 0x1
#define RCC_CFGR_ADCPRE_PCLK2_DIV6 0x2 #define RCC_CFGR_ADCPRE_PCLK2_DIV6 0x2
#define RCC_CFGR_ADCPRE_PCLK2_DIV8 0x3 #define RCC_CFGR_ADCPRE_PCLK2_DIV8 0x3
/**@}*/
/* PPRE2: APB high-speed prescaler (APB2) */ /** @defgroup rcc_cfgr_apb2pre PPRE2: APB high-speed prescaler (APB2)
* @{
*/
#define RCC_CFGR_PPRE2_HCLK_NODIV 0x0 #define RCC_CFGR_PPRE2_HCLK_NODIV 0x0
#define RCC_CFGR_PPRE2_HCLK_DIV2 0x4 #define RCC_CFGR_PPRE2_HCLK_DIV2 0x4
#define RCC_CFGR_PPRE2_HCLK_DIV4 0x5 #define RCC_CFGR_PPRE2_HCLK_DIV4 0x5
#define RCC_CFGR_PPRE2_HCLK_DIV8 0x6 #define RCC_CFGR_PPRE2_HCLK_DIV8 0x6
#define RCC_CFGR_PPRE2_HCLK_DIV16 0x7 #define RCC_CFGR_PPRE2_HCLK_DIV16 0x7
/**@}*/
/* PPRE1: APB low-speed prescaler (APB1) */ /** @defgroup rcc_cfgr_apb1pre PPRE1: APB low-speed prescaler (APB1)
* @{
*/
#define RCC_CFGR_PPRE1_HCLK_NODIV 0x0 #define RCC_CFGR_PPRE1_HCLK_NODIV 0x0
#define RCC_CFGR_PPRE1_HCLK_DIV2 0x4 #define RCC_CFGR_PPRE1_HCLK_DIV2 0x4
#define RCC_CFGR_PPRE1_HCLK_DIV4 0x5 #define RCC_CFGR_PPRE1_HCLK_DIV4 0x5
#define RCC_CFGR_PPRE1_HCLK_DIV8 0x6 #define RCC_CFGR_PPRE1_HCLK_DIV8 0x6
#define RCC_CFGR_PPRE1_HCLK_DIV16 0x7 #define RCC_CFGR_PPRE1_HCLK_DIV16 0x7
/**@}*/
/* HPRE: AHB prescaler */ /** @defgroup rcc_cfgr_ahbpre HPRE: AHB prescaler
* @{
*/
#define RCC_CFGR_HPRE_SYSCLK_NODIV 0x0 #define RCC_CFGR_HPRE_SYSCLK_NODIV 0x0
#define RCC_CFGR_HPRE_SYSCLK_DIV2 0x8 #define RCC_CFGR_HPRE_SYSCLK_DIV2 0x8
#define RCC_CFGR_HPRE_SYSCLK_DIV4 0x9 #define RCC_CFGR_HPRE_SYSCLK_DIV4 0x9
@@ -190,16 +212,20 @@
#define RCC_CFGR_HPRE_SYSCLK_DIV128 0xd #define RCC_CFGR_HPRE_SYSCLK_DIV128 0xd
#define RCC_CFGR_HPRE_SYSCLK_DIV256 0xe #define RCC_CFGR_HPRE_SYSCLK_DIV256 0xe
#define RCC_CFGR_HPRE_SYSCLK_DIV512 0xf #define RCC_CFGR_HPRE_SYSCLK_DIV512 0xf
/**@}*/
/* SWS: System clock switch status */ /* SWS: System clock switch status */
#define RCC_CFGR_SWS_SYSCLKSEL_HSICLK 0x0 #define RCC_CFGR_SWS_SYSCLKSEL_HSICLK 0x0
#define RCC_CFGR_SWS_SYSCLKSEL_HSECLK 0x1 #define RCC_CFGR_SWS_SYSCLKSEL_HSECLK 0x1
#define RCC_CFGR_SWS_SYSCLKSEL_PLLCLK 0x2 #define RCC_CFGR_SWS_SYSCLKSEL_PLLCLK 0x2
/* SW: System clock switch */ /** @defgroup rcc_cfgr_scs SW: System clock switch
* @{
*/
#define RCC_CFGR_SW_SYSCLKSEL_HSICLK 0x0 #define RCC_CFGR_SW_SYSCLKSEL_HSICLK 0x0
#define RCC_CFGR_SW_SYSCLKSEL_HSECLK 0x1 #define RCC_CFGR_SW_SYSCLKSEL_HSECLK 0x1
#define RCC_CFGR_SW_SYSCLKSEL_PLLCLK 0x2 #define RCC_CFGR_SW_SYSCLKSEL_PLLCLK 0x2
/**@}*/
/* --- RCC_CIR values ------------------------------------------------------ */ /* --- RCC_CIR values ------------------------------------------------------ */
@@ -233,8 +259,8 @@
#define RCC_CIR_LSERDYF (1 << 1) #define RCC_CIR_LSERDYF (1 << 1)
#define RCC_CIR_LSIRDYF (1 << 0) #define RCC_CIR_LSIRDYF (1 << 0)
/* --- RCC_APB2RSTR values ------------------------------------------------- */ /** @defgroup rcc_apb2rstr_rst RCC_APB2RSTR reset values values
@{*/
#define RCC_APB2RSTR_TIM17RST (1 << 18) #define RCC_APB2RSTR_TIM17RST (1 << 18)
#define RCC_APB2RSTR_TIM16RST (1 << 17) #define RCC_APB2RSTR_TIM16RST (1 << 17)
#define RCC_APB2RSTR_TIM15RST (1 << 16) #define RCC_APB2RSTR_TIM15RST (1 << 16)
@@ -243,9 +269,10 @@
#define RCC_APB2RSTR_TIM1RST (1 << 11) #define RCC_APB2RSTR_TIM1RST (1 << 11)
#define RCC_APB2RSTR_ADCRST (1 << 9) #define RCC_APB2RSTR_ADCRST (1 << 9)
#define RCC_APB2RSTR_SYSCFGRST (1 << 0) #define RCC_APB2RSTR_SYSCFGRST (1 << 0)
/**@}*/
/* --- RCC_APB1RSTR values ------------------------------------------------- */ /** @defgroup rcc_apb1rstr_rst RCC_APB1RSTR reset values values
@{*/
#define RCC_APB1RSTR_CECRST (1 << 30) #define RCC_APB1RSTR_CECRST (1 << 30)
#define RCC_APB1RSTR_DACRST (1 << 29) #define RCC_APB1RSTR_DACRST (1 << 29)
#define RCC_APB1RSTR_PWRRST (1 << 28) #define RCC_APB1RSTR_PWRRST (1 << 28)
@@ -260,9 +287,10 @@
#define RCC_APB1RSTR_TIM6RST (1 << 4) #define RCC_APB1RSTR_TIM6RST (1 << 4)
#define RCC_APB1RSTR_TIM3RST (1 << 1) #define RCC_APB1RSTR_TIM3RST (1 << 1)
#define RCC_APB1RSTR_TIM2RST (1 << 0) #define RCC_APB1RSTR_TIM2RST (1 << 0)
/**@}*/
/* --- RCC_AHBENR values --------------------------------------------------- */ /** @defgroup rcc_ahbenr_en RCC_AHBENR enable values
@{*/
#define RCC_AHBENR_TSCEN (1 << 24) #define RCC_AHBENR_TSCEN (1 << 24)
#define RCC_AHBENR_GPIOFEN (1 << 22) #define RCC_AHBENR_GPIOFEN (1 << 22)
#define RCC_AHBENR_GPIOEEN (1 << 21) #define RCC_AHBENR_GPIOEEN (1 << 21)
@@ -274,9 +302,10 @@
#define RCC_AHBENR_FLTFEN (1 << 4) #define RCC_AHBENR_FLTFEN (1 << 4)
#define RCC_AHBENR_SRAMEN (1 << 2) #define RCC_AHBENR_SRAMEN (1 << 2)
#define RCC_AHBENR_DMAEN (1 << 0) #define RCC_AHBENR_DMAEN (1 << 0)
/**@}*/
/* --- RCC_APB2ENR values -------------------------------------------------- */ /** @defgroup rcc_apb2enr_en RCC_APB2ENR enable values
@{*/
#define RCC_APB2ENR_TIM17EN (1 << 18) #define RCC_APB2ENR_TIM17EN (1 << 18)
#define RCC_APB2ENR_TIM16EN (1 << 17) #define RCC_APB2ENR_TIM16EN (1 << 17)
#define RCC_APB2ENR_TIM15EN (1 << 16) #define RCC_APB2ENR_TIM15EN (1 << 16)
@@ -285,9 +314,10 @@
#define RCC_APB2ENR_TIM1EN (1 << 11) #define RCC_APB2ENR_TIM1EN (1 << 11)
#define RCC_APB2ENR_ADCEN (1 << 9) #define RCC_APB2ENR_ADCEN (1 << 9)
#define RCC_APB2ENR_SYSCFGCOMPEN (1 << 0) #define RCC_APB2ENR_SYSCFGCOMPEN (1 << 0)
/**@}*/
/* --- RCC_APB1ENR values -------------------------------------------------- */ /** @defgroup rcc_apb1enr_en RCC_APB1ENR enable values
@{*/
#define RCC_APB1ENR_CECEN (1 << 30) #define RCC_APB1ENR_CECEN (1 << 30)
#define RCC_APB1ENR_DACEN (1 << 29) #define RCC_APB1ENR_DACEN (1 << 29)
#define RCC_APB1ENR_PWREN (1 << 28) #define RCC_APB1ENR_PWREN (1 << 28)
@@ -302,6 +332,7 @@
#define RCC_APB1ENR_TIM6EN (1 << 4) #define RCC_APB1ENR_TIM6EN (1 << 4)
#define RCC_APB1ENR_TIM3EN (1 << 1) #define RCC_APB1ENR_TIM3EN (1 << 1)
#define RCC_APB1ENR_TIM2EN (1 << 0) #define RCC_APB1ENR_TIM2EN (1 << 0)
/**@}*/
/* --- RCC_BDCR values ----------------------------------------------------- */ /* --- RCC_BDCR values ----------------------------------------------------- */
@@ -324,10 +355,11 @@
#define RCC_CSR_LSIRDY (1 << 1) #define RCC_CSR_LSIRDY (1 << 1)
#define RCC_CSR_LSION (1 << 0) #define RCC_CSR_LSION (1 << 0)
/* --- RCC_AHBRSTR values -------------------------------------------------- */ /** @defgroup rcc_ahbrstr_rst RCC_AHBRSTR reset values values
@{*/
#define RCC_AHBRSTR_ETHMACRST (1 << 14) #define RCC_AHBRSTR_ETHMACRST (1 << 14)
#define RCC_AHBRSTR_OTGFSRST (1 << 12) #define RCC_AHBRSTR_OTGFSRST (1 << 12)
/**@}*/
/* --- RCC_CFGR2 values ---------------------------------------------------- */ /* --- RCC_CFGR2 values ---------------------------------------------------- */

34
lib/gd32/f1x0/rcc.c
View File

@@ -106,7 +106,7 @@ const struct rcc_clock_scale rcc_hse8_configs[] = {
Clear the interrupt flag that was set when a clock oscillator became ready to Clear the interrupt flag that was set when a clock oscillator became ready to
use. use.
@param[in] osc enum ::osc_t. Oscillator ID @param[in] osc Oscillator ID
*/ */
void rcc_osc_ready_int_clear(enum rcc_osc osc) void rcc_osc_ready_int_clear(enum rcc_osc osc)
@@ -133,7 +133,7 @@ void rcc_osc_ready_int_clear(enum rcc_osc osc)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Enable the Oscillator Ready Interrupt /** @brief RCC Enable the Oscillator Ready Interrupt
@param[in] osc enum ::osc_t. Oscillator ID @param[in] osc Oscillator ID
*/ */
void rcc_osc_ready_int_enable(enum rcc_osc osc) void rcc_osc_ready_int_enable(enum rcc_osc osc)
@@ -160,7 +160,7 @@ void rcc_osc_ready_int_enable(enum rcc_osc osc)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Disable the Oscillator Ready Interrupt /** @brief RCC Disable the Oscillator Ready Interrupt
@param[in] osc enum ::osc_t. Oscillator ID @param[in] osc Oscillator ID
*/ */
void rcc_osc_ready_int_disable(enum rcc_osc osc) void rcc_osc_ready_int_disable(enum rcc_osc osc)
@@ -187,7 +187,7 @@ void rcc_osc_ready_int_disable(enum rcc_osc osc)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Read the Oscillator Ready Interrupt Flag /** @brief RCC Read the Oscillator Ready Interrupt Flag
@param[in] osc enum ::osc_t. Oscillator ID @param[in] osc Oscillator ID
@returns int. Boolean value for flag set. @returns int. Boolean value for flag set.
*/ */
@@ -238,7 +238,7 @@ int rcc_css_int_flag(void)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Wait for Oscillator Ready. /** @brief RCC Wait for Oscillator Ready.
@param[in] osc enum ::osc_t. Oscillator ID @param[in] osc Oscillator ID
*/ */
void rcc_wait_for_osc_ready(enum rcc_osc osc) void rcc_wait_for_osc_ready(enum rcc_osc osc)
@@ -274,7 +274,7 @@ status flag is available to indicate when the oscillator becomes ready (see
backup domain write protection has been removed (see @ref backup domain write protection has been removed (see @ref
pwr_disable_backup_domain_write_protect). pwr_disable_backup_domain_write_protect).
@param[in] osc enum ::osc_t. Oscillator ID @param[in] osc Oscillator ID
*/ */
void rcc_osc_on(enum rcc_osc osc) void rcc_osc_on(enum rcc_osc osc)
@@ -309,7 +309,7 @@ backup domain write protection has been removed (see
@ref pwr_disable_backup_domain_write_protect) or the backup domain has been @ref pwr_disable_backup_domain_write_protect) or the backup domain has been
(see reset @ref rcc_backupdomain_reset). (see reset @ref rcc_backupdomain_reset).
@param[in] osc enum ::osc_t. Oscillator ID @param[in] osc Oscillator ID
*/ */
void rcc_osc_off(enum rcc_osc osc) void rcc_osc_off(enum rcc_osc osc)
@@ -356,7 +356,7 @@ void rcc_css_disable(void)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Set the Source for the System Clock. /** @brief RCC Set the Source for the System Clock.
@param[in] clk Unsigned int32. System Clock Selection @ref rcc_cfgr_scs @param[in] clk System Clock Selection @ref rcc_cfgr_scs
*/ */
void rcc_set_sysclk_source(uint32_t clk) void rcc_set_sysclk_source(uint32_t clk)
@@ -370,7 +370,7 @@ void rcc_set_sysclk_source(uint32_t clk)
@note This only has effect when the PLL is disabled. @note This only has effect when the PLL is disabled.
@param[in] mul Unsigned int32. PLL multiplication factor @ref rcc_cfgr_pmf @param[in] mul PLL multiplication factor @ref rcc_cfgr_pmf
*/ */
void rcc_set_pll_multiplication_factor(uint32_t mul) void rcc_set_pll_multiplication_factor(uint32_t mul)
@@ -385,7 +385,7 @@ void rcc_set_pll_multiplication_factor(uint32_t mul)
@note This only has effect when the PLL is disabled. @note This only has effect when the PLL is disabled.
@param[in] pllsrc Unsigned int32. PLL clock source @ref rcc_cfgr_pcs @param[in] pllsrc PLL clock source @ref rcc_cfgr_pcs
*/ */
void rcc_set_pll_source(uint32_t pllsrc) void rcc_set_pll_source(uint32_t pllsrc)
@@ -399,7 +399,7 @@ void rcc_set_pll_source(uint32_t pllsrc)
@note This only has effect when the PLL is disabled. @note This only has effect when the PLL is disabled.
@param[in] pllxtpre Unsigned int32. HSE division factor @ref rcc_cfgr_hsepre @param[in] pllxtpre HSE division factor @ref rcc_cfgr_hsepre
*/ */
void rcc_set_pllxtpre(uint32_t pllxtpre) void rcc_set_pllxtpre(uint32_t pllxtpre)
@@ -432,7 +432,7 @@ void rcc_enable_rtc_clock(void)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Set the Source for the RTC clock /** @brief RCC Set the Source for the RTC clock
@param[in] clock_source ::rcc_osc. RTC clock source. Only HSE/128, LSE and LSI. @param[in] clock_source RTC clock source. Only HSE/128, LSE and LSI.
*/ */
void rcc_set_rtc_clock_source(enum rcc_osc clock_source) void rcc_set_rtc_clock_source(enum rcc_osc clock_source)
@@ -481,7 +481,7 @@ void rcc_set_rtc_clock_source(enum rcc_osc clock_source)
The ADC's have a common clock prescale setting. The ADC's have a common clock prescale setting.
@param[in] adcpre uint32_t. Prescale divider taken from @ref rcc_cfgr_adcpre @param[in] adcpre Prescale divider taken from @ref rcc_cfgr_adcpre
*/ */
void rcc_set_adcpre(uint32_t adcpre) void rcc_set_adcpre(uint32_t adcpre)
@@ -493,7 +493,7 @@ void rcc_set_adcpre(uint32_t adcpre)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Set the APB2 Prescale Factor. /** @brief RCC Set the APB2 Prescale Factor.
@param[in] ppre2 Unsigned int32. APB2 prescale factor @ref rcc_cfgr_apb2pre @param[in] ppre2 APB2 prescale factor @ref rcc_cfgr_apb2pre
*/ */
void rcc_set_ppre2(uint32_t ppre2) void rcc_set_ppre2(uint32_t ppre2)
@@ -507,7 +507,7 @@ void rcc_set_ppre2(uint32_t ppre2)
@note The APB1 clock frequency must not exceed 36MHz. @note The APB1 clock frequency must not exceed 36MHz.
@param[in] ppre1 Unsigned int32. APB1 prescale factor @ref rcc_cfgr_apb1pre @param[in] ppre1 APB1 prescale factor @ref rcc_cfgr_apb1pre
*/ */
void rcc_set_ppre1(uint32_t ppre1) void rcc_set_ppre1(uint32_t ppre1)
@@ -520,7 +520,7 @@ void rcc_set_ppre1(uint32_t ppre1)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief RCC Set the AHB Prescale Factor. /** @brief RCC Set the AHB Prescale Factor.
@param[in] hpre Unsigned int32. AHB prescale factor @ref rcc_cfgr_ahbpre @param[in] hpre AHB prescale factor @ref rcc_cfgr_ahbpre
*/ */
void rcc_set_hpre(uint32_t hpre) void rcc_set_hpre(uint32_t hpre)
@@ -538,7 +538,7 @@ The prescale factor can be set to 1 (no prescale) for use when the PLL clock is
@note This bit cannot be reset while the USB clock is enabled. @note This bit cannot be reset while the USB clock is enabled.
@param[in] usbpre Unsigned int32. USB prescale factor @ref rcc_cfgr_usbpre @param[in] usbpre USB prescale factor @ref rcc_cfgr_usbpre
*/ */
void rcc_set_usbpre(uint32_t usbpre) void rcc_set_usbpre(uint32_t usbpre)