@@ -11,8 +11,8 @@ use std::path::Path;
1111
1212/// Spidev wrapper providing the embedded-hal [`SpiDevice`] trait.
1313///
14- /// Use this struct when you want a single spidev device, using a Linux-managed CS pin,
15- /// which is already defined in your devicetree . Linux will handle sharing the bus
14+ /// Use this struct when you want a single spidev device, using a Linux-managed CS (chip-select) pin,
15+ /// which is already defined in your device tree . Linux will handle sharing the bus
1616/// between different SPI devices, even between different processes.
1717///
1818/// You get an object that implements [`SpiDevice`], which is what most drivers require,
@@ -34,23 +34,23 @@ pub struct SpidevDevice(pub spidev::Spidev);
3434/// Spidev wrapper providing the embedded-hal [`SpiBus`] trait.
3535///
3636/// Use this struct when you require direct access to the underlying SPI bus, for
37- /// example when you want to use GPIOs as software-controlled CS pins to share the
37+ /// example when you want to use GPIOs as software-controlled CS (chip-select) pins to share the
3838/// bus with multiple devices, or because a driver requires the entire bus (for
3939/// example to drive smart LEDs).
4040///
4141/// Do not use this struct if you're accessing SPI devices that already appear in your
42- /// device tree; you will not be able to drive CS pins that are already used by spidev
42+ /// device tree; you will not be able to drive CS pins that are already used by ` spidev`
4343/// as GPIOs. Instead use [`SpidevDevice`].
4444///
4545/// This struct must still be created from a [`spidev::Spidev`] device, but there are two
4646/// important notes:
4747///
48- /// 1. The CS pin associated with this spidev device will be driven whenever any device accesses
48+ /// 1. The CS pin associated with this ` spidev` device will be driven whenever any device accesses
4949/// this bus, so it should be an unconnected or unused pin.
50- /// 2. No other spidev device on the same bus may be used as long as this `SpidevBus` exists,
50+ /// 2. No other ` spidev` device on the same bus may be used as long as this `SpidevBus` exists,
5151/// as Linux will _not_ do anything to ensure this bus has exclusive access.
5252///
53- /// It is recommended to use a dummy spidev device associated with an unused CS pin, and then use
53+ /// It is recommended to use a dummy ` spidev` device associated with an unused CS pin, and then use
5454/// regular GPIOs as CS pins if required. If you are planning to share this bus using GPIOs, the
5555/// [`embedded-hal-bus`] crate may be of interest.
5656///
0 commit comments