embassy-stm32

Crates

git

Versions

stm32f318c8

Flavors

embassy_stm32::i2c

Struct I2c

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

I2C driver.

Implementations§

Source§

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

Source

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

Blocking read.

Source

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

Blocking write.

Source

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

Blocking write, restart, read.

Source

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.

Source

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.

Source§

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

Source

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

Write.

Source

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

Write multiple buffers.

The buffers are concatenated in a single write transaction.

Source

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

Read.

Source

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

Write, restart, read.

Source

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.

Source§

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

Source

pub fn new<T: Instance>( 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 = impl TxDma<T>> + 'd, rx_dma: impl Peripheral<P = impl RxDma<T>> + 'd, freq: Hertz, config: Config, ) -> Self

Create a new I2C driver.

Source§

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

Source

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

Create a new blocking I2C driver.

Trait Implementations§

Source§

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

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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

Source§

type Error = Error

Error type
Source§

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

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, M: Mode> I2c for I2c<'d, M>

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, M: Mode> SetConfig for I2c<'d, M>

Source§

type Config = Hertz

The configuration type used by this driver.
Source§

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, M: Mode> Read for I2c<'d, M>

Source§

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

Source§

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, M: Mode> WriteRead for I2c<'d, M>

Source§

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, M> Freeze for I2c<'d, M>

§

impl<'d, M> !RefUnwindSafe for I2c<'d, M>

§

impl<'d, M> Send for I2c<'d, M>
where M: Send,

§

impl<'d, M> Sync for I2c<'d, M>
where M: Sync,

§

impl<'d, M> Unpin for I2c<'d, M>
where M: Unpin,

§

impl<'d, M> !UnwindSafe for I2c<'d, M>

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>,

Source§

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>,

Source§

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.