-
Notifications
You must be signed in to change notification settings - Fork 2k
Rationalise debugprobe setup #4109
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
64 changes: 5 additions & 59 deletions
64
documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,12 @@ | ||
== Install tools | ||
|
||
To use the Debug Probe, install the following tools. | ||
To use the Debug Probe, OpenOCD and the GNU Project Debugger (GDB) are required. An Integrated Development Environment (IDE) may also be useful. | ||
|
||
=== Install OpenOCD | ||
On Raspberry Pi OS, most Linux variants, macOS, and Microsoft Windows, it is recommended to install our VS Code extension. This extension bundles OpenOCD, ARM toolchains, GDB, and register definitions for Pico-series microcontrollers. | ||
|
||
You need to install OpenOCD. | ||
See Chapter 3 of our https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Raspberry Pi Pico] guide. | ||
|
||
To install OpenOCD, run the following command in a terminal: | ||
Alternatively, tools can be manually installed by following Appendix C in the guide. | ||
|
||
[source,console] | ||
---- | ||
$ sudo apt install openocd | ||
---- | ||
NOTE: Manual installation of the tools on Windows is not recommended. | ||
|
||
To run OpenOCD, use the `openocd` command in your terminal. | ||
|
||
==== Install OpenOCD on macOS | ||
|
||
First, install the https://brew.sh/[Homebrew] package manager: | ||
|
||
[source,console] | ||
---- | ||
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" | ||
---- | ||
|
||
To install OpenOCD on macOS, run the following commands: | ||
|
||
[source,console] | ||
---- | ||
$ brew install openocd | ||
---- | ||
|
||
To run OpenOCD, use the `openocd` command in your terminal. | ||
|
||
=== Install GDB | ||
|
||
We also need to install the GNU debugger (GDB). | ||
|
||
==== Linux | ||
|
||
Install `gdb-multiarch`: | ||
|
||
[source,console] | ||
---- | ||
$ sudo apt install gdb-multiarch | ||
---- | ||
|
||
==== macOS | ||
|
||
Run the following command to install `gdb`: | ||
|
||
[source,console] | ||
---- | ||
$ brew install arm-none-eabi-gdb | ||
---- | ||
|
||
You can safely ignore the request for "special privileges" messages on installation. | ||
|
||
==== MS Windows | ||
|
||
GDB is available as part of our https://github.com/raspberrypi/pico-setup-windows/releases/latest[Pico setup for Windows installer]. It is also included in the https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads[Arm GNU Toolchain Downloads]. | ||
|
||
Alternatively information about manual installation can be found in Chapter 9 and Appendix A of our https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Raspberry Pi Pico] book. | ||
|
||
NOTE: Manual installation of GDB on Windows is not recommended. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.