pico-feedback icon indicating copy to clipboard operation
pico-feedback copied to clipboard

SDK 1.5.1 clock documentation error

Open matsobdev opened this issue 2 years ago • 7 comments

There is CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_ROSC_CLKSRC instead of CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_XOSC_CLKSRC where it suppose to be (it looks like that at least): Examples >Clock example > Auxiliary Clock Sources > XOSC / clk_sys.

matsobdev avatar Jul 27 '23 14:07 matsobdev

Sorry, I'm not entirely sure what the question is?

aallan avatar Aug 01 '23 13:08 aallan

In the 1.5.1 SDK release page on Github, there is HTML documentation https://github.com/raspberrypi/pico-sdk/releases/download/1.5.1/sdk-1.5.1-html-doc.zip and in given location there are two CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_ROSC_CLKSRC for XOSC and ROSC. Inside SDK there is CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_XOSC_CLKSRC for XOSC, that is correct I suppose (my bad, it is also 2x ROSC). Screenshot 2023-08-01 at 17-30-19 Raspberry Pi Pico SDK hardware_clocks

matsobdev avatar Aug 01 '23 15:08 matsobdev

Ping @kilograham

aallan avatar Aug 01 '23 15:08 aallan

If this is indeed a "bug", the same thing also occurs at https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#rpipe93dd39da7bd5b73a2e7 (look at the bottom two cells in the right-most column) Screenshot from 2023-08-01 16-39-19

ping @liamfraser (as IIRC he did a bunch of the clocks stuff)

lurch avatar Aug 01 '23 15:08 lurch

SDK\src\rp2_common\hardware_clocks\include\hardware\clocks.h line 57 it is the same - just comment so no huge deal.

matsobdev avatar Aug 01 '23 18:08 matsobdev

SDK\src\rp2_common\hardware_clocks\include\hardware\clocks.h line 57 it is the same - just comment so no huge deal.

Ah yes, looks like https://github.com/raspberrypi/pico-sdk/blob/develop/src/rp2_common/hardware_clocks/include/hardware/clocks.h#L57 is the ultimate source of where all these generated-output-files are coming from.

lurch avatar Aug 01 '23 19:08 lurch

cc @liamfraser ; i assume this is just a typo, but haven't looked in detail

kilograham avatar Aug 02 '23 00:08 kilograham

Yesh, looks like this was fixed by https://github.com/raspberrypi/pico-sdk/pull/1571 :slightly_smiling_face:

lurch avatar Nov 25 '24 00:11 lurch