Struct stm32f4xx_hal::i2c::dma::I2CMasterDma

pub struct I2CMasterDma<I2C, PINS, TX_STREAM, const TX_CH: u8, RX_STREAM, const RX_CH: u8>where
    I2C: Instance,
    TX_STREAM: Stream,
    RX_STREAM: Stream,{ /* private fields */ }

I2c abstraction that can work in non-blocking mode by using DMA

The struct should be used for sending/receiving bytes to/from slave device in non-blocking mode. A client must follow these requirements to use that feature:

• Enable interrupts DMAx_STREAMy used for transmit and another DMAq_STREAMp used for receive.
• In these interrupts call handle_dma_interrupt
• Enable interrupts I2Cx_ER for handling errors and call handle_error_interrupt in corresponding handler

The struct can be also used to send/receive bytes in blocking mode with methods: write, read, write_read.

Implementations

impl<I2C, PINS, TX_STREAM, const TX_CH: u8, RX_STREAM, const RX_CH: u8> I2CMasterDma<I2C, PINS, TX_STREAM, TX_CH, RX_STREAM, RX_CH>where
    I2C: Instance,
    TX_STREAM: Stream,
    ChannelX<TX_CH>: Channel,
    Tx<I2C>: DMASet<TX_STREAM, TX_CH, MemoryToPeripheral>,
    RX_STREAM: Stream,
    ChannelX<RX_CH>: Channel,
    Rx<I2C>: DMASet<RX_STREAM, RX_CH, PeripheralToMemory>,

pub fn busy(&self) -> bool

Checks if there is communication in progress

pub fn handle_dma_interrupt(&mut self)

Handles DMA interrupt. This method a client must call in DMAx_STREAMy interrupt

pub fn handle_error_interrupt(&mut self)

Handles errors generated by I2C This method a client must call in I2Cx_ER interrupt

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

Reads in blocking mode but if i2c is busy returns WouldBlock and do nothing

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

Write and then read in blocking mode but if i2c is busy returns WouldBlock and do nothing

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

Write in blocking mode but if i2c is busy returns WouldBlock and do nothing

Trait Implementations

impl<I2C, PINS, TX_STREAM, const TX_CH: u8, RX_STREAM, const RX_CH: u8> I2CMasterReadDMA for I2CMasterDma<I2C, PINS, TX_STREAM, TX_CH, RX_STREAM, RX_CH>where
    I2C: Instance,
    TX_STREAM: Stream,
    ChannelX<TX_CH>: Channel,
    Tx<I2C>: DMASet<TX_STREAM, TX_CH, MemoryToPeripheral>,
    RX_STREAM: Stream,
    ChannelX<RX_CH>: Channel,
    Rx<I2C>: DMASet<RX_STREAM, RX_CH, PeripheralToMemory>,

unsafe fn read_dma(
    &mut self,
    addr: u8,
    buf: &mut [u8],
    callback: Option<I2cCompleteCallback>
) -> Result<(), Error>

Reads bytes from slave device with address addr in non-blocking mode and writes these bytes in buf

impl<I2C, PINS, TX_STREAM, const TX_CH: u8, RX_STREAM, const RX_CH: u8> I2CMasterWriteDMA for I2CMasterDma<I2C, PINS, TX_STREAM, TX_CH, RX_STREAM, RX_CH>where
    I2C: Instance,
    TX_STREAM: Stream,
    ChannelX<TX_CH>: Channel,
    Tx<I2C>: DMASet<TX_STREAM, TX_CH, MemoryToPeripheral>,
    RX_STREAM: Stream,
    ChannelX<RX_CH>: Channel,
    Rx<I2C>: DMASet<RX_STREAM, RX_CH, PeripheralToMemory>,

unsafe fn write_dma(
    &mut self,
    addr: u8,
    bytes: &[u8],
    callback: Option<I2cCompleteCallback>
) -> Result<(), Error>

Writes bytes to slave with address addr in non-blocking mode

impl<I2C, PINS, TX_STREAM, const TX_CH: u8, RX_STREAM, const RX_CH: u8> I2CMasterWriteReadDMA for I2CMasterDma<I2C, PINS, TX_STREAM, TX_CH, RX_STREAM, RX_CH>where
    I2C: Instance,
    TX_STREAM: Stream,
    ChannelX<TX_CH>: Channel,
    Tx<I2C>: DMASet<TX_STREAM, TX_CH, MemoryToPeripheral>,
    RX_STREAM: Stream,
    ChannelX<RX_CH>: Channel,
    Rx<I2C>: DMASet<RX_STREAM, RX_CH, PeripheralToMemory>,

unsafe fn write_read_dma(
    &mut self,
    addr: u8,
    bytes: &[u8],
    buf: &mut [u8],
    callback: Option<I2cCompleteCallback>
) -> Result<(), Error>

Writes bytes to slave with address addr in non-blocking mode and then generate ReStart and receive a bytes from a same device