Struct embedded_hal_bus::i2c::CriticalSectionDevice

pub struct CriticalSectionDevice<'a, T> { /* private fields */ }

critical-section-based shared bus I2c implementation.

Sharing is implemented with a critical-section Mutex. A critical section is taken for the entire duration of a transaction. This allows sharing a single bus across multiple threads (interrupt priority levels). The downside is critical sections typically require globally disabling interrupts, so CriticalSectionDevice will likely negatively impact real-time properties, such as interrupt latency. If you can, prefer using RefCellDevice instead, which does not require taking critical sections.

Implementations

impl<'a, T> CriticalSectionDevice<'a, T>

pub fn new(bus: &'a Mutex<RefCell<T>>) -> Self

Create a new CriticalSectionDevice.

Trait Implementations

impl<'a, T> ErrorType for CriticalSectionDevice<'a, T>

where T: I2c,

type Error = <T as ErrorType>::Error

Error type

impl<'a, T> I2c for CriticalSectionDevice<'a, T>

where T: I2c,

fn read(&mut self, address: u8, read: &mut [u8]) -> Result<(), Self::Error>

Reads enough bytes from slave with address to fill read.

fn write(&mut self, address: u8, write: &[u8]) -> Result<(), Self::Error>

Writes bytes to slave with address address.

fn write_read( &mut self, address: u8, write: &[u8], read: &mut [u8], ) -> Result<(), Self::Error>

Writes bytes to slave with address address and then reads enough bytes to fill read in a single transaction.

fn transaction( &mut self, address: u8, operations: &mut [Operation<'_>], ) -> Result<(), Self::Error>

Execute the provided operations on the I2C bus.