From e7fc82c7599f5d9771b93c7db701a5d7f593396e Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Wed, 3 Sep 2025 12:10:02 +0100 Subject: [PATCH] README tweaks --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bfdb82120..841761905 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # Debugprobe -Firmware source for the Raspberry Pi Debug Probe SWD/UART accessory. Can also be run on a Raspberry Pi Pico. +Firmware source for the Raspberry Pi Debug Probe SWD/UART accessory. Can also be run on a Raspberry Pi Pico or Pico 2. [Raspberry Pi Debug Probe product page](https://www.raspberrypi.com/products/debug-probe/) [Raspberry Pi Pico product page](https://www.raspberrypi.com/products/raspberry-pi-pico/) +[Raspberry Pi Pico 2 product page](https://www.raspberrypi.com/products/raspberry-pi-pico-2/) # Documentation @@ -29,7 +30,7 @@ Then create and switch to the build directory: mkdir build cd build ``` -If your environment doesn't contain `PICO_SDK_PATH`, then either add it to your environment variables with `export PICO_SDK_PATH=/path/to/sdk` or add `PICO_SDK_PATH=/path/to/sdk` to the arguments to CMake below. +If your environment doesn't contain `PICO_SDK_PATH`, then either add it to your environment variables with `export PICO_SDK_PATH=/path/to/sdk` or add `-DPICO_SDK_PATH=/path/to/sdk` to the arguments to CMake below. Run cmake and build the code: ``` @@ -38,30 +39,31 @@ Run cmake and build the code: ``` Done! You should now have a `debugprobe.uf2` that you can upload to your Debug Probe via the UF2 bootloader. +## Building for the Pico 1 + If you want to create the version that runs on the Pico, then you need to invoke `cmake` in the sequence above with the `DEBUG_ON_PICO=ON` option: ``` cmake -DDEBUG_ON_PICO=ON .. ``` - This will build with the configuration for the Pico and call the output program `debugprobe_on_pico.uf2`, as opposed to `debugprobe.uf2` for the accessory hardware. Note that if you first ran through the whole sequence to compile for the Debug Probe, then you don't need to start back at the top. You can just go back to the `cmake` step and start from there. -# Building for the Pico 2 +## Building for the Pico 2 If using an existing debugprobe clone: - You must completely regenerate your build directory, or use a different one. -- You must also sync and update submodules as rp2350 needs a downstream FreeRTOS port for now. +- You must also sync and update submodules. - `PICO_SDK_PATH` must point to a version 2.0.0 or greater install. - ``` git submodule sync git submodule update --init --recursive mkdir build-pico2 cd build-pico2 -cmake -DDEBUG_ON_PICO=1 -DPICO_BOARD=pico2 -DPICO_PLATFORM=rp2350 ../ +cmake -DDEBUG_ON_PICO=1 -DPICO_BOARD=pico2 ../ ``` +This will build with the configuration for the Pico 2 and call the output program `debugprobe_on_pico2.uf2`. # TODO - AutoBaud selection, as PIO is a capable frequency counter