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

Wrong comments in dreq.h for RP2350

Open newbrain opened this issue 7 months ago • 1 comments

A very minor code commenting issue.

Comments at lines 124, 125, 138, and 139 of dreq.h contain wrong information.

https://github.com/raspberrypi/pico-sdk/blob/5592322465b449ef01ca5b4290f2f03fdff71381/src/rp2350/hardware_regs/include/hardware/regs/dreq.h#L124-L125

Should read: 124: DREQ_PWM_WRAP10 = 42, ///< Select PWM Counter 10's Wrap Value as DREQ 125: DREQ_PWM_WRAP11 = 43, ///< Select PWM Counter 11's Wrap Value as DREQ

https://github.com/raspberrypi/pico-sdk/blob/5592322465b449ef01ca5b4290f2f03fdff71381/src/rp2350/hardware_regs/include/hardware/regs/dreq.h#L138-L139

Should read: 138: DREQ_DMA_TIMER1 = 60, ///< Select DMA_TIMER1 as DREQ 139: DREQ_DMA_TIMER2 = 61, ///< Select DMA_TIMER2 as DREQ

newbrain avatar Apr 12 '25 13:04 newbrain

This is also wrong for RP2040 at https://github.com/raspberrypi/pico-sdk/blob/develop/src/rp2040/hardware_regs/include/hardware/regs/dreq.h#L108-L109 And the same errors appear on pages 120, 121 & 122 of https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf and at https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#group_hardware_dma_1ga6f0a19defc495cfa6078364122266014 and https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#group_hardware_dma_1ga864c3313155ab20116b62a64bf78df6d (the same error appears in multiple places because large parts of our documentation are all auto-generated from the same single source of truth).

lurch avatar Apr 14 '25 12:04 lurch

Fixed internally and ready for 2.2

matiasilva avatar Jul 22 '25 12:07 matiasilva

closing as it will be fixed in 2.2.0

kilograham avatar Jul 22 '25 14:07 kilograham