embassy-rp

Crates

git

Versions

rp2040

Flavors

embassy_rp::i2c

Struct I2c

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

I2C driver.

Implementations§

Source§

impl<'d, T: Instance> I2c<'d, T, Blocking>

Source

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

Create a new driver instance in blocking mode.

Source§

impl<'d, T: Instance> I2c<'d, T, Async>

Source

pub fn new_async( 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::Interrupt, InterruptHandler<T>>, config: Config, ) -> Self

Create a new driver instance in async mode.

Source

pub async fn read_async( &mut self, addr: impl Into<u16>, buffer: &mut [u8], ) -> Result<(), Error>

Read from address into buffer asynchronously.

Source

pub async fn write_async( &mut self, addr: impl Into<u16>, bytes: impl IntoIterator<Item = u8>, ) -> Result<(), Error>

Write to address from buffer asynchronously.

Source

pub async fn write_read_async( &mut self, addr: impl Into<u16>, bytes: impl IntoIterator<Item = u8>, buffer: &mut [u8], ) -> Result<(), Error>

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

Source§

impl<'d, T: Instance + 'd, M: Mode> I2c<'d, T, M>

Source

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

Read from address into buffer blocking caller until done.

Source

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

Write to address from buffer blocking caller until done.

Source

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

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

Trait Implementations§

Source§

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

Source§

type Error = Error

Error type
Source§

impl<'d, A, T> I2c<A> for I2c<'d, T, Async>
where A: AddressMode + Into<u16> + 'static, T: Instance + 'd,

Source§

async fn read(&mut self, address: A, 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: A, write: &[u8]) -> Result<(), Self::Error>

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

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

async fn transaction( &mut self, address: A, 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, M: Mode> I2c for I2c<'d, T, 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, T: Instance, M: Mode> SetConfig for I2c<'d, T, M>

Source§

type Config = Config

The configuration type used by this driver.
Source§

type ConfigError = ConfigError

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

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

Set the configuration of the driver.
Source§

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

Source§

type Error = Error

Error type
Source§

fn exec( &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, M: Mode> Read for I2c<'d, T, 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, T: Instance, M: Mode> Write for I2c<'d, T, M>

Source§

type Error = Error

Error type
Source§

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

Writes bytes to slave with address address Read more
Source§

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

Source§

type Error = Error

Error type
Source§

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

Auto Trait Implementations§

§

impl<'d, T, M> Freeze for I2c<'d, T, M>

§

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

§

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

§

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

§

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

§

impl<'d, T, M> !UnwindSafe for I2c<'d, T, 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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.