Skip to content

Commit cc34728

Browse files
authored
📝 Simplify interfaces (#59)
1 parent b91f587 commit cc34728

2 files changed

Lines changed: 164 additions & 301 deletions

File tree

mkdocs/user_guide/debugging.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ PyOCD stands out for its user-friendly approach compared to other On-Chip
1111
Debugging (OCD) tools like OpenOCD, despite being slightly limited in terms of
1212
the range of processors it supports.
1313

14-
For the full documentation for PyOCD see https://pyocd.io/.
14+
For the full documentation for PyOCD see [https://pyocd.io/](https://pyocd.io/).
1515

1616
## Installation
1717

@@ -33,19 +33,16 @@ guide. A connection to ground (`GND`) must be made between the debugger and the
3333
development board in order for the devices to communicate.
3434

3535
!!! Danger
36-
3736
DOUBLE AND TRIPLE CHECK YOUR CONNECTIONS! Incorrect connects can result in
3837
breaking a board, debugger or possible your computer.
3938

4039
=== "Connecting SWD"
41-
4240
Connect jumpers from `GND`, `SWDIO` and `SWDCLK` to the pins on the board.
4341
If the board supports both `SWD` and `JTAG` like many arm cortex boards do,
4442
then connect the pins in the following way: `SWDIO` --> `TMS` and
4543
`SWDCLK` --> `TCK`.
4644

4745
=== "Connecting JTAG"
48-
4946
Connect jumpers from the `GND`, `TDI`, `TMS`, `TCK`, and `TDO` pins on the
5047
JTAG debugger to the headers on the development board of the same name.
5148

@@ -55,13 +52,11 @@ The following commands will use `pyocd` and your debugger to connect to your
5552
target platform.
5653

5754
=== "lpc40"
58-
5955
```bash
6056
pyocd gdbserver --target=lpc4088 --persist
6157
```
6258

6359
=== "stm32f1"
64-
6560
```bash
6661
pyocd gdbserver --target=stm32f103rc --persist
6762
```
@@ -119,7 +114,6 @@ firmware testing, the `run` command is not needed as the code is already
119114
"running" on the remote microcontroller.
120115

121116
!!! info
122-
123117
On boards with a factory bootloader, when you start debugging, you will
124118
notice that you cannot see the source code lines in the gdb shell. This is
125119
because the bootloader instructions are not associated with any addresses in
@@ -156,7 +150,6 @@ You can inspect the state of your program by examining variables and registers:
156150
- `print gpio_reg->CTRL`: Shows the value of a register
157151

158152
!!! tip
159-
160153
If you get an error like:
161154

162155
```

0 commit comments

Comments
 (0)