Skip to main content

I2cOps

atmega_hal::i2c

Trait I2cOps 

Source 
pub trait I2cOps<H, SDA, SCL> {
    // Required methods
    fn raw_setup<CLOCK>(&mut self, speed: u32)
       where CLOCK: Clock;
    fn raw_start(
        &mut self,
        address: u8,
        direction: Direction,
    ) -> Result<(), Error>;
    fn raw_write(&mut self, bytes: &[u8]) -> Result<(), Error>;
    fn raw_read(
        &mut self,
        buffer: &mut [u8],
        last_read: bool,
    ) -> Result<(), Error>;
    fn raw_stop(&mut self) -> Result<(), Error>;
}
Expand description

Internal trait for low-level I2C peripherals.

This trait defines the common interface for all I2C peripheral variants. It is used as an intermediate abstraction ontop of which the I2c API is built. Prefer using the I2c API instead of this trait.

Required Methods§

Source

fn raw_setup<CLOCK>(&mut self, speed: u32)
where CLOCK: Clock,

Setup the bus for operation at a certain speed.

Warning: This is a low-level method and should not be called directly from user code.

Source

fn raw_start(&mut self, address: u8, direction: Direction) -> Result<(), Error>

Start a bus transaction to a certain address in either read or write mode.

If a previous transaction was not stopped via raw_stop(), this should generate a repeated start condition.

Warning: This is a low-level method and should not be called directly from user code.

Source

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

Write some bytes to the bus.

This method must only be called after a transaction in write mode was successfully started.

Warning: This is a low-level method and should not be called directly from user code.

Source

fn raw_read(&mut self, buffer: &mut [u8], last_read: bool) -> Result<(), Error>

Read some bytes from the bus.

This method must only be called after a transaction in read mode was successfully started. If last_read is set then last byte will be nacked. Should be set to false if there will be a subsequent read without a start (e.g. when using transaction).

Warning: This is a low-level method and should not be called directly from user code.

Source

fn raw_stop(&mut self) -> Result<(), Error>

Send a stop-condition and release the bus.

This method must only be called after successfully starting a bus transaction. This method does not need to block until the stop condition has actually occured.

Warning: This is a low-level method and should not be called directly from user code.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§