Struct I2c 

pub struct I2c<'d, M: Mode> { /* private fields */ }

I2C Controller Driver.

Implementations

impl<'d> I2c<'d, Blocking>

pub fn new_blocking<T: Instance>( peri: Peri<'d, T>, scl: Peri<'d, impl SclPin<T>>, sda: Peri<'d, impl SdaPin<T>>, config: Config, ) -> Result<Self, SetupError>

Create a new blocking instance of the I2C Controller bus driver.

Any external pin will be placed into Disabled state upon Drop.

impl<'d, M: Mode> I2c<'d, M>

pub fn blocking_read( &mut self, address: u8, read: &mut [u8], ) -> Result<(), IOError>

Read from address into buffer blocking caller until done.

pub fn blocking_write( &mut self, address: u8, write: &[u8], ) -> Result<(), IOError>

Write to address from buffer blocking caller until done.

pub fn blocking_write_read( &mut self, address: u8, write: &[u8], read: &mut [u8], ) -> Result<(), IOError>

Write to address from bytes and read from address into buffer blocking caller until done.

impl<'d, M: AsyncMode> I2c<'d, M>

where Self: AsyncEngine,

pub fn async_read<'a>( &'a mut self, address: u8, read: &'a mut [u8], ) -> impl Future<Output = Result<(), IOError>> + 'a

Read from address into buffer asynchronously.

pub fn async_write<'a>( &'a mut self, address: u8, write: &'a [u8], ) -> impl Future<Output = Result<(), IOError>> + 'a

pub fn async_write_read<'a>( &'a mut self, address: u8, write: &'a [u8], read: &'a mut [u8], ) -> impl Future<Output = Result<(), IOError>> + 'a

Write to address from bytes and read from address into buffer asynchronously.

impl<'d> I2c<'d, Async>

pub fn new_async<T: Instance>( peri: Peri<'d, T>, scl: Peri<'d, impl SclPin<T>>, sda: Peri<'d, impl SdaPin<T>>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, config: Config, ) -> Result<Self, SetupError>

Create a new async instance of the I2C Controller bus driver.

Any external pin will be placed into Disabled state upon Drop.

impl<'d> I2c<'d, Dma<'d>>

pub fn new_async_with_dma<T: Instance>( peri: Peri<'d, T>, scl: Peri<'d, impl SclPin<T>>, sda: Peri<'d, impl SdaPin<T>>, tx_dma: Peri<'d, impl TxDma<T>>, rx_dma: Peri<'d, impl RxDma<T>>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, config: Config, ) -> Result<Self, SetupError>

Create a new async instance of the I2C Controller bus driver with DMA support.

Any external pin will be placed into Disabled state upon Drop, additionally, the DMA channel is disabled.

Trait Implementations

impl<'d, M: Mode> Drop for I2c<'d, M>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, M: Mode> ErrorType for I2c<'d, M>

type Error = IOError

Error type

impl<'d, M: Mode> I2c for I2c<'d, M>

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

Execute the provided operations on the I2C bus.

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

Reads enough bytes from slave with address to fill read.

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

Writes bytes to slave with address address.

fn write_read( &mut self, address: A, 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.

impl<'d, M: AsyncMode> I2c for I2c<'d, M>

where I2c<'d, M>: AsyncEngine,

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

Execute the provided operations on the I2C bus as a single transaction.

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

Reads enough bytes from slave with address to fill buffer.

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

Writes bytes to slave with address address.

async fn write_read( &mut self, address: A, 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.

impl<'d, M: Mode> SetConfig for I2c<'d, M>

type Config = Config

The configuration type used by this driver.

type ConfigError = SetupError

The error type that can occur if set_config fails.

fn set_config(&mut self, config: &Self::Config) -> Result<(), SetupError>

Set the configuration of the driver.

impl<'d, M: Mode> Transactional for I2c<'d, M>

type Error = IOError

Error type

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

Execute the provided operations on the I2C bus.

impl<'d, M: Mode> Read for I2c<'d, M>

type Error = IOError

Error type

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

Reads enough bytes from slave with address to fill buffer

impl<'d, M: Mode> Write for I2c<'d, M>

type Error = IOError

Error type

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

Writes bytes to slave with address address

impl<'d, M: Mode> WriteRead for I2c<'d, M>

type Error = IOError

Error type

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

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