Skip to content

Enhance documentation for Raspberry Pi debugging setup #1295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Enhance documentation for Raspberry Pi debugging setup #1295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions src/modm/board/rp_pico/module.lb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,14 @@ to the mounted virtual disk.

### OpenOCD

Another option is to use Picoprobe and custom version of OpenOCD provided by RPi.
Another option is to use the [Raspberry Pi Debug Probe](https://www.raspberrypi.com/products/debug-probe/) together with the [Raspberry Pi Picoprobe software](https://github.com/raspberrypi/debugprobe) and a custom version of OpenOCD provided by RPi.
Copy link
Member

@rleh rleh Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand, https://github.com/raspberrypi/debugprobe is just the firmware that runs on the Picoprobe hardware, right?
Then I don't think it makes sense to link to it here, because the user does not interact with this software directly.

Copy link
Member

@rleh rleh Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I believe that a "custom version" of OpenOCD is no longer necessary since the release of OpenOCD 0.12.0 in February 2023.

The following command works fine on my fedora installation with default openocd package:

openocd -f interface/cmsis-dap.cfg -f target/rp2040.cfg

see https://www.raspberrypi.com/documentation/microcontrollers/debug-probe.html#install-tools


You would need to build and program one of the boards with the Picoprobe firmware,
configure and build RPi OpenOCD, and connect the boards via SWD.
The wiring diagram and detailed description is available in the
The wiring diagram and detailed description are available in the
[Pico Documentation](https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#Appendix%20A:%20Using%20Picoprobe).

The how-to shows steps for building and installing the RPi OpenOCD into your
system globally, however, if you still want to be able to work with other OpenOCD
binaries, you should only install it locally:
The how-to explains how to build and install the RPi OpenOCD globally, but if you want to keep using other OpenOCD binaries, you should install it only locally:
Copy link
Member

@rleh rleh Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would argue to remove the entire following how-to-build-openocd block (which was written in 2022 before the release of OpenOCD 0.12.0) as it is no longer necessary with OpenOCD 0.12.0.


```sh
sudo apt install automake autoconf build-essential texinfo libtool libftdi-dev libusb-1.0-0-dev
Expand Down
Loading