Skip to content

Commit a4a18b0

Browse files
committed
Small fixes
This commit adds the prerequisites for `probe-rs` and adds some clarifications regarding some of the necessary actions.
1 parent 236f885 commit a4a18b0

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

docs/tock_workshop/index.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,22 @@ info: The currently active `rustc` version is `rustc 1.86.0 (05f9846f8 2025-03-3
2424

2525
This tool is an embedded debugging and target interaction toolkit. It enables its user to program and debug microcontrollers via a debug probe.
2626

27-
The simplest installation method involves using the `cargo` packet manager:
27+
The simplest installation method involves using the `cargo` packet manager, but first you have to install the prerequisites:
28+
29+
- On Debian-based Linux, use the following command:
30+
```shell
31+
sudo apt install -y pkg-config libudev-dev cmake git
32+
```
33+
34+
- On Mac OS and Windows, no additional setup is needed.
35+
36+
After that, use `cargo` to install `probe-rs`:
2837

2938
```shell
3039
cargo install probe-rs-tools --locked
3140
```
3241

33-
If you are using Linux, you will also need to add this [udev](https://probe.rs/files/69-probe-rs.rules) file in `/etc/udev/rules.d`. Then, run:
42+
If you are using Linux, you will also need to add this [udev](https://probe.rs/files/69-probe-rs.rules) file in `/etc/udev/rules.d`. Then, run as root:
3443

3544
```shell
3645
udevadm control --reload # to ensure the new rules are used.
@@ -186,7 +195,7 @@ impl SyscallDriver for MockCapsule {
186195
```
187196

188197
:::note Module definition
189-
Do not forget to add `pub mod mock;` in the crate's `lib.rs` file.
198+
Do not forget to add `pub mod mock;` in `capsules/extra/src/lib.rs`.
190199
:::
191200

192201
The next step is to implement the handling of specific commands. The convention is that the first command (`0`) to be an *"exists"* command, that is usually used to check wether a driver is present or not in the board configuration, and it should simply return a `CommandReturn::success()`.

0 commit comments

Comments
 (0)