@@ -4,12 +4,14 @@ description: "How to set up your debug probe to work with probe-rs."
4
4
order : 20
5
5
---
6
6
7
+ ## Platform specifics
8
+
7
9
probe-rs supports multiple probes out of the box.
8
10
9
- Most of them require little to no setup. For linux, [ udev] ( #udev-rules ) rules
11
+ Most of them require little to no setup. For linux, [ udev] ( #linux%3A- udev-rules ) rules
10
12
are required for non admin access.
11
13
12
- ## udev rules
14
+ ### Linux: udev rules
13
15
14
16
By default, the debug probes are only accessible by users with root privileges
15
17
on Linux based systems. It is recommend to use appropriate udev rules to allow
@@ -29,6 +31,14 @@ rules do not get applied properly. See
29
31
[ this Github discussion] ( https://github.com/systemd/systemd/issues/4288#issuecomment-348166161 )
30
32
for more information.
31
33
34
+ ### Windows: WinUSB drivers
35
+
36
+ Some of the probe implementations are implemented using [ nusb] ( https://crates.io/crates/nusb ) which
37
+ uses the WinUSB drivers on Windows. For these devices you will need to download
38
+ [ Zadig] ( https://zadig.akeo.ie/ ) and select WinUSB as the driver for your probe. This will uninstall
39
+ any official drivers, which means that the official tools will most likely not work anymore after
40
+ this.
41
+
32
42
## CMSIS-DAP
33
43
34
44
CMSIS-DAP is a standard for debug probes which is managed by ARM. All probes
@@ -40,13 +50,9 @@ implementing this standard are supported by probe-rs.
40
50
41
51
No additional drivers are required to use CMSIS-DAP based probes on Linux
42
52
systems. To ensure that users without root privileges can use the debug probe,
43
- it is recommended to configure udev as described in [ udev rules] ( #udev-rules ) .
44
-
45
- #### Windows
46
-
47
- No driver installation required.
53
+ it is recommended to configure udev as described in [ udev rules] ( #linux%3A-udev-rules ) .
48
54
49
- #### Mac OS
55
+ #### Windows, macOS
50
56
51
57
No driver installation required.
52
58
@@ -55,39 +61,39 @@ No driver installation required.
55
61
The ST-Link is a debug probe from ST Microelectronics. It is commonly found on
56
62
their evaluation boards, such as the Discovery and Nucleo boards.
57
63
64
+ ### Supported Versions
65
+
66
+ The following versions of the ST-Link are supported:
67
+
68
+ - ST-Link V2, Firmware version 2.26 or higher
69
+ - ST-Link V3, Firmware version 3.2 or higher
70
+
71
+ If you get an error message indicating that the firmware is outdated, please use
72
+ the official ST tools to update the firmware. The update tool can be found on
73
+ the [ ST website] ( https://www.st.com/en/development-tools/stsw-link007.html ) .
74
+
58
75
### Setup
59
76
60
77
#### Linux
61
78
62
79
No additional drivers are required to use a ST-Link debug probe on Linux
63
80
systems. To ensure that users without root privileges can use the debug probe,
64
- it is recommended to configure udev as described in [ udev rules] ( #udev-rules ) .
81
+ it is recommended to configure udev as described in [ udev rules] ( #linux%3A- udev-rules ) .
65
82
66
83
#### Windows
67
84
68
85
To use the ST-Link on Windows, you need to install the official drivers, which
69
86
can be found on the
70
87
[ ST website] ( https://www.st.com/en/development-tools/stsw-link009.html ) .
71
88
72
- #### Mac OS
89
+ #### macOS
73
90
74
91
No driver installation required.
75
92
76
- ### Supported Versions
77
-
78
- The following versions of the ST-Link are supported:
79
-
80
- - ST-Link V2, Firmware version 2.26 or higher
81
- - ST-Link V3, Firmware version 3.2 or higher
82
-
83
- If you get an error message indicating that the firmware is outdated, please use
84
- the official ST tools to update the firmware. The update tool can be found on
85
- the [ ST website] ( https://www.st.com/en/development-tools/stsw-link007.html ) .
86
-
87
93
## SEGGER J-Link
88
94
89
95
The J-Link is a debug probe from [ Segger] ( https://www.segger.com/ ) . It is
90
- available as a stand-alone product, but also integrated into evaluation boards
96
+ available as a stand-alone product, but also integrated into some evaluation boards
91
97
directly.
92
98
93
99
Due to the proprietary nature of the J-Link, probe-rs will not achieve the same
@@ -99,18 +105,15 @@ speed as the official J-Link tools.
99
105
100
106
No additional drivers are required to use a J-Link debug probe on Linux systems.
101
107
To ensure that users without root privileges can use the debug probe, it is
102
- recommended to configure udev as described in [ udev rules] ( #udev-rules ) .
108
+ recommended to configure udev as described in [ udev rules] ( #linux%3A- udev-rules ) .
103
109
104
110
#### Windows
105
111
106
112
Unfortunately, probe-rs doesn't work with the official drivers on Windows. To
107
113
use probe-rs it is necessary to install a generic WinUSB driver. The recommended
108
- way of doing this is by using [ Zadig] ( https://zadig.akeo.ie/ ) and selecting
109
- WinUSB as the driver for the J-Link probe. This will uninstall the official
110
- driver, which means that the official Segger tools will not work anymore after
111
- this.
114
+ way of doing this is by using [ Zadig] ( #windows%3A-winusb-drivers ) .
112
115
113
- #### Mac OS
116
+ #### macOS
114
117
115
118
No driver installation required.
116
119
@@ -144,18 +147,15 @@ The following devices are known to work with probe-rs:
144
147
145
148
No additional drivers are required to use a FTDI-based debug probe on Linux systems.
146
149
To ensure that users without root privileges can use the debug probe, it is
147
- recommended to configure udev as described in [ udev rules] ( #udev-rules ) .
150
+ recommended to configure udev as described in [ udev rules] ( #linux%3A- udev-rules ) .
148
151
149
152
#### Windows
150
153
151
154
Unfortunately, probe-rs doesn't work with the official (VCP or D2xx) drivers on Windows. To
152
155
use probe-rs it is necessary to install a generic WinUSB driver. The recommended
153
- way of doing this is by using [ Zadig] ( https://zadig.akeo.ie/ ) and selecting
154
- WinUSB as the driver for the FTDI probe. This will uninstall the official
155
- driver, which means that the official FTDI tools will not work anymore after
156
- this.
156
+ way of doing this is by using [ Zadig] ( #windows%3A-winusb-drivers ) .
157
157
158
- #### Mac OS
158
+ #### macOS
159
159
160
160
No driver installation required.
161
161
@@ -171,8 +171,8 @@ there's a good chance the one marked as `USB` can act as a debug probe.
171
171
172
172
No additional drivers are required to use an ESP32 built-in debug interface on Linux systems.
173
173
To ensure that users without root privileges can use the debug probe, it is
174
- recommended to configure udev as described in [ udev rules] ( #udev-rules ) .
174
+ recommended to configure udev as described in [ udev rules] ( #linux%3A- udev-rules ) .
175
175
176
- #### Windows, Mac OS
176
+ #### Windows, macOS
177
177
178
178
No driver installation required.
0 commit comments