Skip to content

Commit 1d02053

Browse files
YatekiiYatekii
committed
add rules & cross compilation files back; make minor adjustments to formatting
1 parent 73d29d7 commit 1d02053

File tree

5 files changed

+169
-13
lines changed

5 files changed

+169
-13
lines changed

‎public/files/69-probe-rs.rules‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Copy this file to /etc/udev/rules.d/
2+
# If rules fail to reload automatically, you can refresh udev rules
3+
# with the command "udevadm control --reload"
4+
5+
# This rules are based on the udev rules from the OpenOCD project, with unsupported probes removed.
6+
# See http://openocd.org/ for more details.
7+
#
8+
# This file is available under the GNU General Public License v2.0
9+
10+
ACTION!="add|change", GOTO="probe_rs_rules_end"
11+
12+
SUBSYSTEM=="gpio", MODE="0660", GROUP="plugdev", TAG+="uaccess"
13+
14+
SUBSYSTEM!="usb|tty|hidraw", GOTO="probe_rs_rules_end"
15+
16+
# Please keep this list sorted by VID:PID
17+
18+
# STMicroelectronics ST-LINK V1
19+
ATTRS {
20+
idVendo
21+
}
22+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
23+
24+
# STMicroelectronics ST-LINK/V2
25+
ATTRS {
26+
idVendo
27+
}
28+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
29+
30+
# STMicroelectronics ST-LINK/V2.1
31+
ATTRS {
32+
idVendo
33+
}
34+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
35+
ATTRS {
36+
idVendo
37+
}
38+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
39+
40+
# STMicroelectronics STLINK-V3
41+
ATTRS {
42+
idVendo
43+
}
44+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
45+
ATTRS {
46+
idVendo
47+
}
48+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
49+
ATTRS {
50+
idVendo
51+
}
52+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
53+
ATTRS {
54+
idVendo
55+
}
56+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
57+
ATTRS {
58+
idVendo
59+
}
60+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
61+
62+
# SEGGER J-Link
63+
ATTRS {
64+
idVendo
65+
}
66+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
67+
ATTRS {
68+
idVendo
69+
}
70+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
71+
ATTRS {
72+
idVendo
73+
}
74+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
75+
ATTRS {
76+
idVendo
77+
}
78+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
79+
ATTRS {
80+
idVendo
81+
}
82+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
83+
ATTRS {
84+
idVendo
85+
}
86+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
87+
ATTRS {
88+
idVendo
89+
}
90+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
91+
ATTRS {
92+
idVendo
93+
}
94+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
95+
ATTRS {
96+
idVendo
97+
}
98+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
99+
ATTRS {
100+
idVendo
101+
}
102+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
103+
ATTRS {
104+
idVendo
105+
}
106+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
107+
ATTRS {
108+
idVendo
109+
}
110+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
111+
ATTRS {
112+
idVendo
113+
}
114+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
115+
ATTRS {
116+
idVendo
117+
}
118+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
119+
ATTRS {
120+
idVendo
121+
}
122+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
123+
ATTRS {
124+
idVendo
125+
}
126+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
127+
ATTRS {
128+
idVendo
129+
}
130+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
131+
ATTRS {
132+
idVendo
133+
}
134+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
135+
ATTRS {
136+
idVendo
137+
}
138+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
139+
ATTRS {
140+
idVendo
141+
}
142+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#
143+
ATTRS {
144+
idVendo
145+
}
146+
==#$#%#$#placeholder03434#$#%#$#, ATTRS{idProduct}==#$#%#$#placeholder13434#$#%#$#, MODE=#$#%#$#placeholder23434#$#%#$#, GROUP=#$#%#$#placeholder33434#$#%#$#, TAG+=#$#%#$#placeholder43434#$#%#$#

‎public/files/cross-dockerfile.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
FROM rustembedded/cross:armv7-unknown-linux-gnueabihf-0.2.1
2+
ENV PKG_CONFIG_ALLOW_CROSS=1
3+
ENV PKG_CONFIG_LIBDIR=/usr/lib/arm-linux-gnueabihf/pkgconfig
4+
RUN dpkg --add-architecture armhf && \
5+
apt-get update && \
6+
apt-get install -y libusb-1.0-0-dev:armhf libftdi1-dev:armhf libudev-dev:armhf

‎src/content/docs/getting-started/probe-setup.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ order: 20
88

99
probe-rs supports multiple probes out of the box.
1010

11-
Most of them require little to no setup. For linux, [udev](#linux%3A-udev-rules) rules
11+
Most of them require little to no setup. For linux, [udev](#linux-udev-rules) rules
1212
are required for non admin access.
1313

1414
### Linux: udev rules
@@ -17,7 +17,7 @@ By default, the debug probes are only accessible by users with root privileges
1717
on Linux based systems. It is recommend to use appropriate udev rules to allow
1818
users without root privileges access to the debug probes as well.
1919

20-
1. Download the <a href="/files/69-probe-rs.rules" download>rules file</a> and place
20+
1. Download the <a href="/files/69-probe-rs.rules" download="69-probe-rs.rules">rules file</a> and place
2121
it in /etc/udev/rules.d.
2222
2. Run `udevadm control --reload` to ensure the new rules are used.
2323
3. Run `udevadm trigger` to ensure the new rules are applied to already added
@@ -59,7 +59,7 @@ implementing this standard are supported by probe-rs.
5959

6060
No additional drivers are required to use CMSIS-DAP based probes on Linux
6161
systems. To ensure that users without root privileges can use the debug probe,
62-
it is recommended to configure udev as described in [udev rules](#linux%3A-udev-rules).
62+
it is recommended to configure udev as described in [udev rules](#linux-udev-rules).
6363

6464
#### Windows, macOS
6565

@@ -87,7 +87,7 @@ the [ST website](https://www.st.com/en/development-tools/stsw-link007.html).
8787

8888
No additional drivers are required to use a ST-Link debug probe on Linux
8989
systems. To ensure that users without root privileges can use the debug probe,
90-
it is recommended to configure udev as described in [udev rules](#linux%3A-udev-rules).
90+
it is recommended to configure udev as described in [udev rules](#linux-udev-rules).
9191

9292
#### Windows
9393

@@ -114,7 +114,7 @@ speed as the official J-Link tools.
114114

115115
No additional drivers are required to use a J-Link debug probe on Linux systems.
116116
To ensure that users without root privileges can use the debug probe, it is
117-
recommended to configure udev as described in [udev rules](#linux%3A-udev-rules).
117+
recommended to configure udev as described in [udev rules](#linux-udev-rules).
118118

119119
#### Windows
120120

@@ -133,7 +133,7 @@ tool. To install the generic WinUSB driver with the J-Link Configurator tool:
133133
- Click **OK**
134134

135135
Some J-Link probes will have the option to select WinUSB in the configuration
136-
dialog disabled. In this case, use [Zadig](#windows%3A-winusb-drivers) to
136+
dialog disabled. In this case, use [Zadig](#windows-winusb-drivers) to
137137
install the generic WinUSB driver for your probe.
138138

139139
#### macOS
@@ -170,13 +170,13 @@ The following devices are known to work with probe-rs:
170170

171171
No additional drivers are required to use a FTDI-based debug probe on Linux systems.
172172
To ensure that users without root privileges can use the debug probe, it is
173-
recommended to configure udev as described in [udev rules](#linux%3A-udev-rules).
173+
recommended to configure udev as described in [udev rules](#linux-udev-rules).
174174

175175
#### Windows
176176

177177
Unfortunately, probe-rs doesn't work with the official (VCP or D2xx) drivers on Windows. To
178178
use probe-rs it is necessary to install a generic WinUSB driver. The recommended
179-
way of doing this is by using [Zadig](#windows%3A-winusb-drivers).
179+
way of doing this is by using [Zadig](#windows-winusb-drivers).
180180

181181
#### macOS
182182

@@ -194,7 +194,7 @@ there's a good chance the one marked as `USB` can act as a debug probe.
194194

195195
No additional drivers are required to use an ESP32 built-in debug interface on Linux systems.
196196
To ensure that users without root privileges can use the debug probe, it is
197-
recommended to configure udev as described in [udev rules](#linux%3A-udev-rules).
197+
recommended to configure udev as described in [udev rules](#linux-udev-rules).
198198

199199
#### Windows, macOS
200200

‎src/content/docs/library/crosscompiling.mdx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ We can take an `armv7-unknown-linux-gnueabihf` base system from the `rust-embedd
4343

4444
After that, follow the instructions from the `probe-rs` [prerequisites](/docs/getting-started/installation#prerequisites) to prepare the image for the building steps.
4545

46-
You can download the Dockerfile for this example from [here](/files/cross-dockerfile.txt).
46+
You can download the Dockerfile for this example from <a href="/files/cross-dockerfile.txt" download="cross-dockerfile.txt">here</a>.
4747

4848
```sh
4949
# Create and edit a Cross.toml file in the root of the cloned repo.
@@ -58,11 +58,15 @@ image = "crossimage"
5858
```
5959

6060
```sh
61-
# Build and tag the container image, specifying the name as defined in the `Cross.toml`.
61+
# Build and tag the container image,
62+
# specifying the name as defined in the `Cross.toml`.
6263
docker build -t crossimage crossimage/
6364

6465
# Run cross to compile, cross arguments are the same as the `cargo` ones
65-
cross build -p probe-rs-tools --release --target=armv7-unknown-linux-gnueabihf
66+
cross build \
67+
-p probe-rs-tools \
68+
--release \
69+
--target=armv7-unknown-linux-gnueabihf
6670

6771
# Done
6872
```

‎src/layouts/Html.astro‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const { title, description, image, fluid } = Astro.props;
4848
<HeaderLink href="docs">Documentation</HeaderLink>
4949
<HeaderLink href="blog">Blog</HeaderLink>
5050
<HeaderLink href="https://shop.probe.rs/" target="_blank"
51-
>Shop<Icon
51+
>Shop <Icon
5252
name="line-md--external-link"
5353
class="inline"
5454
/></HeaderLink

0 commit comments

Comments
 (0)