|
1 | 1 | # Debugprobe |
2 | 2 |
|
3 | | -Firmware source for the Debug Probe SWD/UART accessory. Can also be run on a Pico. |
| 3 | +Firmware source for the Raspberry Pi Debug Probe SWD/UART accessory. Can also be run on a Raspberry Pi Pico. |
| 4 | + |
| 5 | +[Raspberry Pi Debug Probe product page](https://www.raspberrypi.com/products/debug-probe/) |
| 6 | +[Raspberry Pi Pico product page](https://www.raspberrypi.com/products/raspberry-pi-pico/) |
| 7 | + |
4 | 8 |
|
5 | 9 | # Documentation |
6 | 10 |
|
7 | 11 | Debug Probe documentation can be found in the [Pico Getting Started Guide](https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf). See "Appendix A: Using the Debug Probe". |
8 | 12 |
|
9 | 13 | # Hacking |
10 | 14 |
|
11 | | -For the purpose of making changes or studying of the code, you may want to compile the code yourself. |
| 15 | +For the purpose of making changes or studying of the code, you may want to compile the code yourself. |
12 | 16 |
|
13 | | -To compile this project firstly initialize and update the submodules: |
| 17 | +First, clone the repository: |
| 18 | +``` |
| 19 | +git clone https://github.com/raspberrypi/debugprobe |
| 20 | +cd debugprobe |
| 21 | +``` |
| 22 | +Initialize and update the submodules: |
14 | 23 | ``` |
15 | 24 | git submodule update --init |
16 | 25 | ``` |
17 | | -then create and switch to the build directory: |
| 26 | +Then create and switch to the build directory: |
18 | 27 | ``` |
19 | 28 | mkdir build |
20 | 29 | cd build |
21 | 30 | ``` |
22 | | -then run cmake and build the code: |
| 31 | +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. |
| 32 | + |
| 33 | +Run cmake and build the code: |
23 | 34 | ``` |
24 | 35 | cmake .. |
25 | 36 | make |
26 | 37 | ``` |
27 | 38 | Done! You should now have a `debugprobe.uf2` that you can upload to your Debug Probe via the UF2 bootloader. |
28 | 39 |
|
29 | | -If you want to create the version that runs on the Raspberry Pi Pico, then you need to invoke `cmake` in the sequence above with the `DEBUG_ON_PICO=ON` option: |
| 40 | +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: |
30 | 41 | ``` |
31 | 42 | cmake -DDEBUG_ON_PICO=ON .. |
32 | 43 | ``` |
|
0 commit comments