File tree Expand file tree Collapse file tree 6 files changed +8
-8
lines changed Expand file tree Collapse file tree 6 files changed +8
-8
lines changed Original file line number Diff line number Diff line change @@ -4,7 +4,7 @@ use embedded_hal::i2c::{ErrorType, I2c};
4
4
5
5
/// `critical-section`-based shared bus [`I2c`] implementation.
6
6
///
7
- /// Sharing is implemented with a `critical-section` [`Mutex`](critical_section::Mutex) . A critical section is taken for
7
+ /// Sharing is implemented with a `critical-section` [`Mutex`]. A critical section is taken for
8
8
/// the entire duration of a transaction. This allows sharing a single bus across multiple threads (interrupt priority levels).
9
9
/// The downside is critical sections typically require globally disabling interrupts, so `CriticalSectionDevice` will likely
10
10
/// negatively impact real-time properties, such as interrupt latency. If you can, prefer using
Original file line number Diff line number Diff line change @@ -3,7 +3,7 @@ use std::sync::Mutex;
3
3
4
4
/// `std` `Mutex`-based shared bus [`I2c`] implementation.
5
5
///
6
- /// Sharing is implemented with an `std` [`Mutex`](std::sync::Mutex) . It allows a single bus across multiple threads,
6
+ /// Sharing is implemented with an `std` [`Mutex`]. It allows a single bus across multiple threads,
7
7
/// with finer-grained locking than [`CriticalSectionDevice`](super::CriticalSectionDevice). The downside is that
8
8
/// it is only available in `std` targets.
9
9
#[ cfg_attr( docsrs, doc( cfg( feature = "std" ) ) ) ]
Original file line number Diff line number Diff line change @@ -8,10 +8,10 @@ use super::DeviceError;
8
8
9
9
/// `critical-section`-based shared bus [`SpiDevice`] implementation.
10
10
///
11
- /// This allows for sharing an [`SpiBus`](embedded_hal::spi::SpiBus) , obtaining multiple [`SpiDevice`] instances,
11
+ /// This allows for sharing an [`SpiBus`], obtaining multiple [`SpiDevice`] instances,
12
12
/// each with its own `CS` pin.
13
13
///
14
- /// Sharing is implemented with a `critical-section` [`Mutex`](critical_section::Mutex) . A critical section is taken for
14
+ /// Sharing is implemented with a `critical-section` [`Mutex`]. A critical section is taken for
15
15
/// the entire duration of a transaction. This allows sharing a single bus across multiple threads (interrupt priority levels).
16
16
/// The downside is critical sections typically require globally disabling interrupts, so `CriticalSectionDevice` will likely
17
17
/// negatively impact real-time properties, such as interrupt latency. If you can, prefer using
Original file line number Diff line number Diff line change @@ -13,7 +13,7 @@ use super::DeviceError;
13
13
14
14
/// [`SpiDevice`] implementation with exclusive access to the bus (not shared).
15
15
///
16
- /// This is the most straightforward way of obtaining an [`SpiDevice`] from an [`SpiBus`](embedded_hal::spi::SpiBus) ,
16
+ /// This is the most straightforward way of obtaining an [`SpiDevice`] from an [`SpiBus`],
17
17
/// ideal for when no sharing is required (only one SPI device is present on the bus).
18
18
pub struct ExclusiveDevice < BUS , CS , D > {
19
19
bus : BUS ,
Original file line number Diff line number Diff line change @@ -7,10 +7,10 @@ use super::DeviceError;
7
7
8
8
/// `std` `Mutex`-based shared bus [`SpiDevice`] implementation.
9
9
///
10
- /// This allows for sharing an [`SpiBus`](embedded_hal::spi::SpiBus) , obtaining multiple [`SpiDevice`] instances,
10
+ /// This allows for sharing an [`SpiBus`], obtaining multiple [`SpiDevice`] instances,
11
11
/// each with its own `CS` pin.
12
12
///
13
- /// Sharing is implemented with a `std` [`Mutex`](std::sync::Mutex) . It allows a single bus across multiple threads,
13
+ /// Sharing is implemented with a `std` [`Mutex`]. It allows a single bus across multiple threads,
14
14
/// with finer-grained locking than [`CriticalSectionDevice`](super::CriticalSectionDevice). The downside is
15
15
/// it is only available in `std` targets.
16
16
#[ cfg_attr( docsrs, doc( cfg( feature = "std" ) ) ) ]
Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ use super::DeviceError;
7
7
8
8
/// `RefCell`-based shared bus [`SpiDevice`] implementation.
9
9
///
10
- /// This allows for sharing an [`SpiBus`](embedded_hal::spi::SpiBus) , obtaining multiple [`SpiDevice`] instances,
10
+ /// This allows for sharing an [`SpiBus`], obtaining multiple [`SpiDevice`] instances,
11
11
/// each with its own `CS` pin.
12
12
///
13
13
/// Sharing is implemented with a `RefCell`. This means it has low overhead, but `RefCellDevice` instances are not `Send`,
You can’t perform that action at this time.
0 commit comments