Skip to content

Commit 6f72f46

Browse files
committed
pyocd debug setup docs
Signed-off-by: Jens Reinecke <[email protected]>
1 parent 7b1ac4f commit 6f72f46

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,6 @@ Related open source projects are
88
- [pyOCD](https://pyocd.io/), a Python based tool and API for debugging, programming, and exploring Arm Cortex microcontrollers.
99
- [GDB](https://www.sourceware.org/gdb/), the GNU Project debugger.
1010

11-
## Prerequisites
12-
13-
- (Temporary, should become obsolete with full `*.cbuild-run.yml` support in pyOCD)<br>
14-
Make sure to set up your CMSIS Pack installation root folder by one of the following methods:
15-
- Set your system environment variable `CMSIS_PACK_ROOT`.
16-
- Add the following to your debug launch configuration
17-
```
18-
"environment": {
19-
"CMSIS_PACK_ROOT": "</path/to/your/pack/cache>"
20-
}
21-
22-
```
23-
2411
## The Arm CMSIS Debugger Extension Pack
2512

2613
The Arm CMSIS Debugger extension is actually an [extension pack](https://code.visualstudio.com/api/references/extension-manifest#extension-packs). It allows to install multiple separate extensions together.
@@ -33,7 +20,22 @@ The following extensions are included in this extension pack:
3320
- [Memory Inspector](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.memory-inspector), an Eclipse CDT Cloud extension that provides a powerful and configurable memory viewer that works with debug adapters.
3421
- [Peripheral Inspector](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.peripheral-inspector), an Eclipse CDT Cloud extension that provides a CMSIS SVD viewer and works with debug adapters.
3522

36-
## Additional Functionality
23+
## pyOCD Debug Setup
24+
25+
- Install `GCC compiler for ARM CPUs` with the `Arm Tools Environment Manager` to get access to a GDB (`arm-none-eabi-gdb`).
26+
27+
- (Temporary, should become obsolete with full `*.cbuild-run.yml` support in pyOCD)<br>
28+
Make sure to set up your CMSIS Pack installation root folder by one of the following methods:
29+
- Set your system environment variable `CMSIS_PACK_ROOT`.
30+
- Add the following to your debug launch configuration
31+
```
32+
"environment": {
33+
"CMSIS_PACK_ROOT": "</path/to/your/pack/cache>"
34+
}
35+
36+
```
37+
38+
## Additional Extension Functionality
3739
3840
This extension contributes additional functionality to more seamlessly integrate the included extensions:
3941
- The pseudo debugger types `cmsis-debug-pyocd` and `cmsis-debug-jlink`. These types allow a more seamless integration into the VS Code IDE. However, these are not full debug adapters but generate debug configurations of type `gdbtarget` which comes with the [CDT GDB Debug Adapter Extension](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.cdt-gdb-vscode).

0 commit comments

Comments
 (0)