Skip to content

Commit 0d5614e

Browse files
authored
Round two with install and probe instructions (#114)
* Round two with install instructions * Second pass over the probe docs
1 parent 6c5fa2b commit 0d5614e

File tree

2 files changed

+56
-49
lines changed

2 files changed

+56
-49
lines changed

src/docs/getting-started/installation.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,60 @@ description: "How to install probe-rs."
44
order: 20
55
---
66

7-
# Quickly
7+
## Using install scripts
88

9-
Run the setup command specific to your system:
10-
11-
## Linux, macOS
9+
### Linux, macOS
1210

1311
```bash
1412
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-installer.sh | sh
1513
```
1614

17-
## Windows (PowerShell)
15+
### Windows
1816

19-
```sh
17+
```ps
2018
irm https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-installer.ps1 | iex
2119
```
2220

23-
## [`cargo binstall`](https://crates.io/crates/cargo-binstall)
21+
## From package managers
22+
23+
### [homebrew](https://brew.sh/)
2424

25+
```bash
26+
brew tap probe-rs/probe-rs
27+
brew install probe-rs
2528
```
29+
30+
### [cargo binstall](https://crates.io/crates/cargo-binstall)
31+
32+
```bash
2633
cargo binstall probe-rs
2734
```
2835

29-
# Installing from source (`cargo install`)
36+
## Installing from source (`cargo install`)
3037

31-
## Prerequisites
38+
### Prerequisites
3239

3340
To build probe-rs from source, you will need a working Rust toolchain. The easiest way is to follow the [rustup installation instructions](https://rustup.rs).
3441

35-
### Debian-based Linux
42+
#### Debian-based Linux
3643

3744
On Debian and derived distros (e.g. Ubuntu), the following packages need to be installed:
3845

3946
```bash
4047
sudo apt install -y pkg-config libudev-dev
4148
```
4249

43-
### RPM-based Linux (Fedora, CentOS)
50+
#### RPM-based Linux (Fedora, CentOS)
4451

4552
```bash
4653
dnf install libusbx-devel libudev-devel
4754
```
4855

49-
### macOS, Windows
56+
#### macOS, Windows
5057

5158
No additional setup is required.
5259

53-
## Installation
60+
### Installation
5461

5562
Install with `cargo install`. This will install the `probe-rs`, `cargo-flash` and `cargo-embed` binaries and put them in `$PATH`.
5663

src/docs/getting-started/probe-setup.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ description: "How to set up your debug probe to work with probe-rs."
44
order: 20
55
---
66

7+
## Platform specifics
8+
79
probe-rs supports multiple probes out of the box.
810

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
1012
are required for non admin access.
1113

12-
## udev rules
14+
### Linux: udev rules
1315

1416
By default, the debug probes are only accessible by users with root privileges
1517
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
2931
[this Github discussion](https://github.com/systemd/systemd/issues/4288#issuecomment-348166161)
3032
for more information.
3133

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+
3242
## CMSIS-DAP
3343

3444
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.
4050

4151
No additional drivers are required to use CMSIS-DAP based probes on Linux
4252
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).
4854

49-
#### Mac OS
55+
#### Windows, macOS
5056

5157
No driver installation required.
5258

@@ -55,39 +61,39 @@ No driver installation required.
5561
The ST-Link is a debug probe from ST Microelectronics. It is commonly found on
5662
their evaluation boards, such as the Discovery and Nucleo boards.
5763

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+
5875
### Setup
5976

6077
#### Linux
6178

6279
No additional drivers are required to use a ST-Link debug probe on Linux
6380
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).
6582

6683
#### Windows
6784

6885
To use the ST-Link on Windows, you need to install the official drivers, which
6986
can be found on the
7087
[ST website](https://www.st.com/en/development-tools/stsw-link009.html).
7188

72-
#### Mac OS
89+
#### macOS
7390

7491
No driver installation required.
7592

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-
8793
## SEGGER J-Link
8894

8995
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
9197
directly.
9298

9399
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.
99105

100106
No additional drivers are required to use a J-Link debug probe on Linux systems.
101107
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).
103109

104110
#### Windows
105111

106112
Unfortunately, probe-rs doesn't work with the official drivers on Windows. To
107113
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).
112115

113-
#### Mac OS
116+
#### macOS
114117

115118
No driver installation required.
116119

@@ -144,18 +147,15 @@ The following devices are known to work with probe-rs:
144147

145148
No additional drivers are required to use a FTDI-based debug probe on Linux systems.
146149
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).
148151

149152
#### Windows
150153

151154
Unfortunately, probe-rs doesn't work with the official (VCP or D2xx) drivers on Windows. To
152155
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).
157157

158-
#### Mac OS
158+
#### macOS
159159

160160
No driver installation required.
161161

@@ -171,8 +171,8 @@ there's a good chance the one marked as `USB` can act as a debug probe.
171171

172172
No additional drivers are required to use an ESP32 built-in debug interface on Linux systems.
173173
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).
175175

176-
#### Windows, Mac OS
176+
#### Windows, macOS
177177

178178
No driver installation required.

0 commit comments

Comments
 (0)