You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/debugging.md
+10-4Lines changed: 10 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,22 @@
2
2
3
3
This article on debugging is under construction. It refers to products in private beta, and also uses techniques that could expose your internet network to external attack. Care should be taken when following the steps below.
4
4
5
-
## Install OpenOCD
5
+
## Install Drivers & Software
6
+
OpenOCD or the J-Link GDB Server can be used to interface your computer with your devkit. Only one is required:
7
+
* OpenOCD can be used for a variety of devkits without any additional hardware. Most devkits have an on-chip debugger supported by OpenOCD.
8
+
* J-Link requires an additional debugging hardware, however this gives you so more advanced features, as well as access to a larger set of devkits.
6
9
10
+
### OpenOCD
7
11
1. Install the relevant driver for the devkits on chip debugger:
1. Download and unzip [OpenOCD](https://gnutoolchains.com/arm-eabi/openocd) to your computer and add its `bin/` folder to your environment path.
12
17
13
-
1. Download and unzip [OpenOCD](https://gnutoolchains.com/arm-eabi/openocd) onto your computer and add its `bin/` folder to your environment path.
18
+
### J-Link
19
+
20
+
1. Install the [JLink Software and Documentation Pack](https://www.segger.com/downloads/jlink#J-LinkSoftwareAndDocumentationPack). This includes the GDB Server as well as the neccessary J-Link drivers.
14
21
15
22
## Setup your Project
16
23
@@ -53,7 +60,6 @@ You can choose to develop locally or develop in [Codespaces](https://github.com/
53
60
1. Setup your router to forward outside connections to port 3333 to your local machine. This allows the Codespaces GDB service to communicate with the devkit via the local OpenOCD instance.
54
61
> Warning: This will expose the OpenOCD service to the public network which may result in an external compromise.
55
62
56
-
57
63
## Start Debugging
58
64
59
65
1. From a new command window run OpenOCD locally, using the appropriate command below:
@@ -63,7 +69,7 @@ You can choose to develop locally or develop in [Codespaces](https://github.com/
|NXP MIMXRT1060-EVK |JLinkGDBServerCL -select USB -device MIMXRT1062xxx6A -speed auto -if SWD |
72
+
|NXP MIMXRT1060-EVK |JLinkGDBServerCL -select USB -device MIMXRT1062xxx6A -speed auto -if SWD -noLocalhostOnly|
67
73
68
74
1. Open the VSCode workspace in the directory for the devkit you would like to debug. For example the STM32L4 devkit workspace is "STMicroelectronics/STM32L4_L4+/STM32L4plus.code-workspace".
0 commit comments