Skip to content

Commit f4a691a

Browse files
authored
Update doxygen group for clock functions (#1808)
Fixes #1806
1 parent efe2103 commit f4a691a

File tree

1 file changed

+6
-6
lines changed
  • src/rp2_common/hardware_clocks/include/hardware

1 file changed

+6
-6
lines changed

src/rp2_common/hardware_clocks/include/hardware/clocks.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -383,14 +383,14 @@ static inline void clock_gpio_init(uint gpio, uint src, float div)
383383
bool clock_configure_gpin(clock_handle_t clock, uint gpio, uint32_t src_freq, uint32_t freq);
384384

385385
/*! \brief Initialise the system clock to 48MHz
386-
* \ingroup pico_stdlib
386+
* \ingroup hardware_clocks
387387
*
388388
* Set the system clock to 48MHz, and set the peripheral clock to match.
389389
*/
390390
void set_sys_clock_48mhz(void);
391391

392392
/*! \brief Initialise the system clock
393-
* \ingroup pico_stdlib
393+
* \ingroup hardware_clocks
394394
*
395395
* \param vco_freq The voltage controller oscillator frequency to be used by the SYS PLL
396396
* \param post_div1 The first post divider for the SYS PLL
@@ -401,7 +401,7 @@ void set_sys_clock_48mhz(void);
401401
void set_sys_clock_pll(uint32_t vco_freq, uint post_div1, uint post_div2);
402402

403403
/*! \brief Check if a given system clock frequency is valid/attainable
404-
* \ingroup pico_stdlib
404+
* \ingroup hardware_clocks
405405
*
406406
* \param freq_hz Requested frequency
407407
* \param vco_freq_out On success, the voltage controlled oscillator frequency to be used by the SYS PLL
@@ -412,7 +412,7 @@ void set_sys_clock_pll(uint32_t vco_freq, uint post_div1, uint post_div2);
412412
bool check_sys_clock_hz(uint32_t freq_hz, uint *vco_freq_out, uint *post_div1_out, uint *post_div2_out);
413413

414414
/*! \brief Check if a given system clock frequency is valid/attainable
415-
* \ingroup pico_stdlib
415+
* \ingroup hardware_clocks
416416
*
417417
* \param freq_khz Requested frequency
418418
* \param vco_freq_out On success, the voltage controlled oscillator frequency to be used by the SYS PLL
@@ -423,7 +423,7 @@ bool check_sys_clock_hz(uint32_t freq_hz, uint *vco_freq_out, uint *post_div1_ou
423423
bool check_sys_clock_khz(uint32_t freq_khz, uint *vco_freq_out, uint *post_div1_out, uint *post_div2_out);
424424

425425
/*! \brief Attempt to set a system clock frequency in hz
426-
* \ingroup pico_stdlib
426+
* \ingroup hardware_clocks
427427
*
428428
* Note that not all clock frequencies are possible; it is preferred that you
429429
* use src/rp2_common/hardware_clocks/scripts/vcocalc.py to calculate the parameters
@@ -445,7 +445,7 @@ static inline bool set_sys_clock_hz(uint32_t freq_hz, bool required) {
445445
}
446446

447447
/*! \brief Attempt to set a system clock frequency in khz
448-
* \ingroup pico_stdlib
448+
* \ingroup hardware_clocks
449449
*
450450
* Note that not all clock frequencies are possible; it is preferred that you
451451
* use src/rp2_common/hardware_clocks/scripts/vcocalc.py to calculate the parameters

0 commit comments

Comments
 (0)