Struct I2c

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

I2C driver.

Implementations

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

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

Blocking read.

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

Blocking write.

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

Blocking write, restart, read.

pub fn blocking_transaction( &mut self, addr: u8, operations: &mut [Operation<'_>], ) -> Result<(), Error>

Blocking transaction with operations.

Consecutive operations of same type are merged. See transaction contract for details.

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

Blocking write multiple buffers.

The buffers are concatenated in a single write transaction.

impl<'d, IM: MasterMode> I2c<'d, Async, IM>

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

Write.

pub async fn write_vectored( &mut self, address: Address, write: &[&[u8]], ) -> Result<(), Error>

Write multiple buffers.

The buffers are concatenated in a single write transaction.

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

Read.

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

Write, restart, read.

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

Transaction with operations.

Consecutive operations of same type are merged. See transaction contract for details.

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

pub fn into_slave_multimaster( self, slave_addr_config: SlaveAddrConfig, ) -> I2c<'d, M, MultiMaster>

Configure the I2C driver for slave operations, allowing for the driver to be used as a slave and a master (multimaster)

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

pub fn reconfigure_addresses(&mut self, addresses: OwnAddresses)

Configure the slave address.

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

pub async fn listen(&mut self) -> Result<SlaveCommand, Error>

Listen for incoming I2C messages.

The listen method is an asynchronous method but it does not require DMA to be asynchronous.

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

Respond to a write command.

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

Respond to a read command.

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

pub async fn respond_to_write( &mut self, buffer: &mut [u8], ) -> Result<usize, Error>

Respond to a write command.

Returns the total number of bytes received.

pub async fn respond_to_read( &mut self, write: &[u8], ) -> Result<SendStatus, Error>

Respond to a read request from an I2C master.

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

pub fn new<T: Instance>( peri: Peri<'d, T>, scl: Peri<'d, impl SclPin<T>>, sda: Peri<'d, impl SdaPin<T>>, _irq: impl Binding<T::EventInterrupt, EventInterruptHandler<T>> + Binding<T::ErrorInterrupt, ErrorInterruptHandler<T>> + 'd, tx_dma: Peri<'d, impl TxDma<T>>, rx_dma: Peri<'d, impl RxDma<T>>, freq: Hertz, config: Config, ) -> Self

Create a new I2C driver.

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

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

Create a new blocking I2C driver.

Trait Implementations

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

type Error = Error

Error type

impl<'d, IM: MasterMode> I2c for I2c<'d, Async, IM>

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

Reads enough bytes from slave with address to fill buffer.

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

Writes bytes to slave with address address.

async 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.

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.

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

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.

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

type Config = Hertz

The configuration type used by this driver.

type ConfigError = ()

The error type that can occur if set_config fails.

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

Set the configuration of the driver.

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

type Config = (Hertz, SlaveAddrConfig)

The configuration type used by this driver.

type ConfigError = ()

The error type that can occur if set_config fails.

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

Set the configuration of the driver.

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

type Error = Error

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, IM: MasterMode> Write for I2c<'d, M, IM>

type Error = Error

Error type

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

Writes bytes to slave with address address

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

type Error = Error

Error type

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 buffer in a single transaction