Struct embassy_stm32::i2c::I2c

source ·
pub struct I2c<'d, T: Instance, TXDMA = NoDma, RXDMA = NoDma> { /* private fields */ }
Expand description

I2C driver.

Implementations§

source§

impl<'d, T: Instance, TXDMA, RXDMA> I2c<'d, T, TXDMA, RXDMA>

source

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

Blocking read.

source

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

Blocking write.

source

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

Blocking write, restart, read.

source

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

Write.

source

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

Read.

source

pub async fn write_read( &mut self, address: u8, write: &[u8], read: &mut [u8] ) -> Result<(), Error>
where RXDMA: RxDma<T>, TXDMA: TxDma<T>,

Write, restart, read.

source§

impl<'d, T: Instance, TXDMA, RXDMA> I2c<'d, T, TXDMA, RXDMA>

source

pub fn new( peri: impl Peripheral<P = T> + 'd, scl: impl Peripheral<P = impl SclPin<T>> + 'd, sda: impl Peripheral<P = impl SdaPin<T>> + 'd, _irq: impl Binding<T::EventInterrupt, EventInterruptHandler<T>> + Binding<T::ErrorInterrupt, ErrorInterruptHandler<T>> + 'd, tx_dma: impl Peripheral<P = TXDMA> + 'd, rx_dma: impl Peripheral<P = RXDMA> + 'd, freq: Hertz, config: Config ) -> Self

Create a new I2C driver.

Trait Implementations§

source§

impl<'d, T: Instance, TXDMA, RXDMA> Drop for I2c<'d, T, TXDMA, RXDMA>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'d, T: Instance, TXDMA, RXDMA> ErrorType for I2c<'d, T, TXDMA, RXDMA>

§

type Error = Error

Error type
source§

impl<'d, T: Instance> I2c for I2c<'d, T, NoDma, NoDma>

source§

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

Reads enough bytes from slave with address to fill read. Read more
source§

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

Writes bytes to slave with address address. Read more
source§

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. Read more
source§

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

Execute the provided operations on the I2C bus. Read more
source§

impl<'d, T: Instance, TXDMA: TxDma<T>, RXDMA: RxDma<T>> I2c for I2c<'d, T, TXDMA, RXDMA>

source§

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

Reads enough bytes from slave with address to fill buffer. Read more
source§

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

Writes bytes to slave with address address. Read more
source§

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. Read more
source§

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. Read more
source§

impl<'d, T: Instance> SetConfig for I2c<'d, T>

§

type Config = Hertz

The configuration type used by this driver.
§

type ConfigError = ()

The error type that can occur if set_config fails.
source§

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

Set the configuration of the driver.
source§

impl<'d, T: Instance> Read for I2c<'d, T>

§

type Error = Error

Error type
source§

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

Reads enough bytes from slave with address to fill buffer Read more
source§

impl<'d, T: Instance> Write for I2c<'d, T>

§

type Error = Error

Error type
source§

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

Writes bytes to slave with address address Read more
source§

impl<'d, T: Instance> WriteRead for I2c<'d, T>

§

type Error = Error

Error type
source§

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 Read more

Auto Trait Implementations§

§

impl<'d, T, TXDMA, RXDMA> Freeze for I2c<'d, T, TXDMA, RXDMA>
where T: Freeze, TXDMA: Freeze, RXDMA: Freeze,

§

impl<'d, T, TXDMA, RXDMA> RefUnwindSafe for I2c<'d, T, TXDMA, RXDMA>
where T: RefUnwindSafe, TXDMA: RefUnwindSafe, RXDMA: RefUnwindSafe,

§

impl<'d, T, TXDMA, RXDMA> Send for I2c<'d, T, TXDMA, RXDMA>
where T: Send, TXDMA: Send, RXDMA: Send,

§

impl<'d, T, TXDMA, RXDMA> Sync for I2c<'d, T, TXDMA, RXDMA>
where T: Sync, TXDMA: Sync, RXDMA: Sync,

§

impl<'d, T, TXDMA, RXDMA> Unpin for I2c<'d, T, TXDMA, RXDMA>
where T: Unpin, TXDMA: Unpin, RXDMA: Unpin,

§

impl<'d, T, TXDMA = NoDma, RXDMA = NoDma> !UnwindSafe for I2c<'d, T, TXDMA, RXDMA>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.