Inconsistent PIO instruction docs in Pico C/C++ SDK PDF and RP2350 datasheet

Open
#416 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
cpp
Domain
documentation, embedded-iot

Research direction

Compare the Pico C/C++ SDK PDF with the RP2350 datasheet, especially sections 11.4.3.2 and 11.4.3.3. Check the documented syntax for the wait jmppin and wait irq variants, then update the SDK documentation so both match the datasheet and verify the generated PDF.

Written by the indexing model from the issue text.

Description

documentation pdf pio

The Pico C/C++ SDK PDF v3.0 is missing the assembler syntax for the wait <polarity> jmppin variant. Thankfully it's documented in the RP2350 datasheet, but the SDK doc should get it too.

The C/C++ SDK doc says the syntax for the wait <polarity> irq variant only permits (rel). The 2350 datasheet shows (rel, next, prev) at the top of section 11.4.3.3, but only (rel) immediately below that (which also re-explains the meaning of rel, which was done in the preceding section 11.4.3.2).

Dominant language
No language data
Stars
35
Forks
4
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from raspberrypi/pico-feedback

All issues in raspberrypi/pico-feedback

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.