Struct I2c

pub struct I2c<I2C, PINS> { /* private fields */ }

I2C peripheral operating in master mode

Implementations

impl<I2C, SCL, SDA> I2c<I2C, (SCL, SDA)>

pub fn new( i2c: I2C, pins: (SCL, SDA), freq: Hertz, clocks: Clocks, bus: &mut <I2C as RccBus>::Bus, ) -> Self

where I2C: Instance, SCL: SclPin<I2C>, SDA: SdaPin<I2C>,

Configures the I2C peripheral to work in master mode

Panics

Panics if frequency freq can not be configured for the periphery.

pub unsafe fn peripheral(&mut self) -> &mut I2C

Get access to the underlying register block.

Safety

This function is not memory unsafe per se, but does not guarantee anything about assumptions of invariants made in this implementation.

Changing specific options can lead to un-expected behavior and nothing is guaranteed.

pub fn free(self) -> (I2C, (SCL, SDA))

Releases the I2C peripheral and associated pins

Trait Implementations

impl<I2C, PINS> Read for I2c<I2C, PINS>

where I2C: Instance,

type Error = Error

Error type

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

Reads enough bytes from slave with address to fill buffer

impl<I2C, PINS> Write for I2c<I2C, PINS>

where I2C: Instance,

type Error = Error

Error type

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

Writes bytes to slave with address address

impl<I2C, PINS> WriteRead for I2c<I2C, PINS>

where I2C: Instance,

type Error = Error

Error type

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

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