Struct stm32_hal2::i2c::I2c

pub struct I2c<R> {
    pub regs: R,
    pub cfg: I2cConfig,
}

Represents an Inter-Integrated Circuit (I2C) peripheral.

Fields

regs: R

cfg: I2cConfig

Implementations

impl<R> I2c<R> where
    R: Deref<Target = RegisterBlock> + DmaPeriph + RccPeriph, 

pub fn new(regs: R, cfg: I2cConfig, clocks: &Clocks) -> Self

Initialize a I2C peripheral, including configuration register writes, and enabling and resetting its RCC peripheral clock. freq is in Hz.

pub fn enable_smbus(&mut self)

Enable SMBus support. See L44 RM, section 37.4.11: SMBus initialization

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

Read multiple words to a buffer. Can return an error due to Bus, Arbitration, or NACK.

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

Write an array of words. Can return an error due to Bus, Arbitration, or NACK.

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

Write and read an array of words. Can return an error due to Bus, Arbitration, or NACK.

pub unsafe fn write_dma<D>(
    &mut self,
    addr: u8,
    buf: &[u8],
    autoend: bool,
    channel: DmaChannel,
    channel_cfg: ChannelCfg,
    dma: &mut Dma<D>
) where
    D: Deref<Target = RegisterBlock>, 

Read data, using DMA. See L44 RM, 37.4.16: “Transmission using DMA” Note that the channel argument is only used on F3 and L4. For a single write, set autoend to true. For a write_read and other use cases, set it to false.

pub unsafe fn read_dma<D>(
    &mut self,
    addr: u8,
    buf: &mut [u8],
    channel: DmaChannel,
    channel_cfg: ChannelCfg,
    dma: &mut Dma<D>
) where
    D: Deref<Target = RegisterBlock>, 

Read data, using DMA. See L44 RM, 37.4.16: “Reception using DMA” Note that the channel argument is only used on F3 and L4.

Trait Implementations

impl<R> Read for I2c<R> where
    R: Deref<Target = RegisterBlock> + DmaPeriph + RccPeriph, 

type Error = Error

Error type

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

Reads enough bytes from slave with address to fill buffer

impl<R> Write for I2c<R> where
    R: Deref<Target = RegisterBlock> + DmaPeriph + RccPeriph, 

type Error = Error

Error type

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

Sends bytes to slave with address addr

impl<R> WriteRead for I2c<R> where
    R: Deref<Target = RegisterBlock> + DmaPeriph + RccPeriph, 

type Error = Error

Error type

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

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