raspberrypi / pico-sdk

BSD 3-Clause "New" or "Revised" License
3.27k stars 844 forks source link

hardware/clock.h lists wrong definition for auxsrc XOSC for clk_sys #1570

Open dthomas981 opened 7 months ago

dthomas981 commented 7 months ago

https://github.com/raspberrypi/pico-sdk/blob/6a7db34ff63345a7badec79ebea3aaef1712f374/src/rp2_common/hardware_clocks/include/hardware/clocks.h#L57

Documentation for the auxiliary clock sources in hardware/clocks.h has an error. The XOSC row in the table should list CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_XOSC_CLKSRC in the clk_sys column but instead lists CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_ROSC_CLKSRC.

This is just a documentation error; the actual definition is correct. https://github.com/raspberrypi/pico-sdk/blob/6a7db34ff63345a7badec79ebea3aaef1712f374/src/rp2040/hardware_regs/include/hardware/regs/clocks.h#L564