doc: stm32: fix "osc" incorrect linkages
Was copied around a lot, was always wrong.
This commit is contained in:
parent
a2681b3122
commit
5eefc214f6
|
@ -51,7 +51,7 @@ uint32_t rcc_apb1_frequency = 8000000; /* 8MHz after reset */
|
|||
* Clear the interrupt flag that was set when a clock oscillator became ready
|
||||
* to use.
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID
|
||||
* @param osc Oscillator ID
|
||||
*/
|
||||
|
||||
void rcc_osc_ready_int_clear(enum rcc_osc osc)
|
||||
|
@ -84,7 +84,7 @@ void rcc_osc_ready_int_clear(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Enable the Oscillator Ready Interrupt
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID
|
||||
* @param osc Oscillator ID
|
||||
*/
|
||||
|
||||
void rcc_osc_ready_int_enable(enum rcc_osc osc)
|
||||
|
@ -117,7 +117,7 @@ void rcc_osc_ready_int_enable(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Disable the Oscillator Ready Interrupt
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID
|
||||
* @param osc Oscillator ID
|
||||
*/
|
||||
|
||||
void rcc_osc_ready_int_disable(enum rcc_osc osc)
|
||||
|
@ -150,7 +150,7 @@ void rcc_osc_ready_int_disable(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Read the Oscillator Ready Interrupt Flag
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID
|
||||
* @param osc Oscillator ID
|
||||
* @returns int. Boolean value for flag set.
|
||||
*/
|
||||
|
||||
|
@ -238,7 +238,7 @@ void rcc_wait_for_osc_ready(enum rcc_osc osc)
|
|||
* becomes ready (see @ref rcc_osc_ready_int_flag and @ref
|
||||
* rcc_wait_for_osc_ready).
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID
|
||||
* @param osc Oscillator ID
|
||||
*/
|
||||
|
||||
void rcc_osc_on(enum rcc_osc osc)
|
||||
|
@ -276,7 +276,7 @@ void rcc_osc_on(enum rcc_osc osc)
|
|||
* @note An oscillator cannot be turned off if it is selected as the system
|
||||
* clock.
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID
|
||||
* @param osc Oscillator ID
|
||||
*/
|
||||
|
||||
void rcc_osc_off(enum rcc_osc osc)
|
||||
|
@ -327,7 +327,7 @@ void rcc_css_disable(void)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Set the Source for the System Clock.
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID. Only HSE, LSE and PLL have
|
||||
* @param clk Oscillator ID. Only HSE, LSE and PLL have
|
||||
* effect.
|
||||
*/
|
||||
|
||||
|
@ -357,7 +357,7 @@ void rcc_set_sysclk_source(enum rcc_osc clk)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Set the Source for the USB Clock.
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID. Only HSI48 or PLL have
|
||||
* @param clk Oscillator ID. Only HSI48 or PLL have
|
||||
* effect.
|
||||
*/
|
||||
void rcc_set_usbclk_source(enum rcc_osc clk)
|
||||
|
@ -402,7 +402,7 @@ void rcc_disable_rtc_clock(void)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Set the Source for the RTC clock
|
||||
|
||||
@param[in] clock_source ::rcc_osc. RTC clock source. Only HSE/32, LSE and LSI.
|
||||
@param[in] clk RTC clock source. Only HSE/32, LSE and LSI.
|
||||
*/
|
||||
|
||||
void rcc_set_rtc_clock_source(enum rcc_osc clk)
|
||||
|
@ -501,7 +501,7 @@ void rcc_set_prediv(uint32_t prediv)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Get the System Clock Source.
|
||||
*
|
||||
* @returns ::osc_t System clock source:
|
||||
* @returns current system clock source
|
||||
*/
|
||||
|
||||
enum rcc_osc rcc_system_clock_source(void)
|
||||
|
@ -543,7 +543,7 @@ uint32_t rcc_get_i2c_clocks(void)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Get the USB Clock Source.
|
||||
*
|
||||
* @returns ::osc_t USB clock source:
|
||||
* @returns Currently selected USB clock source
|
||||
*/
|
||||
|
||||
enum rcc_osc rcc_usb_clock_source(void)
|
||||
|
|
|
@ -64,7 +64,7 @@ uint32_t rcc_ahb_frequency = 8000000;
|
|||
Clear the interrupt flag that was set when a clock oscillator became ready to
|
||||
use.
|
||||
|
||||
@param[in] osc enum ::osc_t. Oscillator ID
|
||||
@param[in] osc Oscillator ID
|
||||
*/
|
||||
|
||||
void rcc_osc_ready_int_clear(enum rcc_osc osc)
|
||||
|
@ -97,7 +97,7 @@ void rcc_osc_ready_int_clear(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Enable the Oscillator Ready Interrupt
|
||||
|
||||
@param[in] osc enum ::osc_t. Oscillator ID
|
||||
@param osc Oscillator ID
|
||||
*/
|
||||
|
||||
void rcc_osc_ready_int_enable(enum rcc_osc osc)
|
||||
|
@ -130,7 +130,7 @@ void rcc_osc_ready_int_enable(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @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)
|
||||
|
@ -163,7 +163,7 @@ void rcc_osc_ready_int_disable(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @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.
|
||||
*/
|
||||
|
||||
|
@ -255,7 +255,7 @@ status flag is available to indicate when the oscillator becomes ready (see
|
|||
backup domain write protection has been removed (see @ref
|
||||
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)
|
||||
|
@ -296,7 +296,7 @@ backup domain write protection has been removed (see
|
|||
@ref pwr_disable_backup_domain_write_protect) or the backup domain has been
|
||||
(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)
|
||||
|
@ -452,7 +452,7 @@ void rcc_enable_rtc_clock(void)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @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)
|
||||
|
|
|
@ -105,7 +105,7 @@ void rcc_osc_off(enum rcc_osc osc)
|
|||
* Clear the interrupt flag that was set when a clock oscillator became ready
|
||||
* to use.
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID
|
||||
* @param[in] osc Oscillator ID
|
||||
*/
|
||||
void rcc_osc_ready_int_clear(enum rcc_osc osc)
|
||||
{
|
||||
|
@ -137,7 +137,7 @@ void rcc_osc_ready_int_clear(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @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)
|
||||
{
|
||||
|
@ -169,7 +169,7 @@ void rcc_osc_ready_int_enable(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @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)
|
||||
{
|
||||
|
@ -201,7 +201,7 @@ void rcc_osc_ready_int_disable(enum rcc_osc osc)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @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.
|
||||
*/
|
||||
int rcc_osc_ready_int_flag(enum rcc_osc osc)
|
||||
|
@ -279,8 +279,7 @@ void rcc_set_hsi48_source_pll(void)
|
|||
/*---------------------------------------------------------------------------*/
|
||||
/** @brief RCC Set the Source for the System Clock.
|
||||
*
|
||||
* @param[in] osc enum ::osc_t. Oscillator ID. Only HSE, HSI16, MSI and PLL have
|
||||
* effect.
|
||||
* @param[in] osc Oscillator ID. Only HSE, HSI16, MSI and PLL have effect.
|
||||
*/
|
||||
|
||||
void rcc_set_sysclk_source(enum rcc_osc osc)
|
||||
|
|
Loading…
Reference in New Issue