Enum imxrt_hal::lpi2c::ControllerCommand

#[non_exhaustive]
pub enum ControllerCommand {
    Transmit {
        byte: u8,
    },
    Receive {
        count: u8,
    },
    Stop,
    ReceiveAndDiscard {
        drop: u8,
    },
    Start {
        addr: u8,
        expect: Response,
    },
}

LPI2C controller commands.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Transmit

Fields

byte: u8

The data byte to enqueue.

A transmit command.

Receive

Fields

count: u8

How many bytes to receive.

A receive command.

Stop

Generate a STOP condition.

ReceiveAndDiscard

Fields

drop: u8

How many bytes to receive and drop.

Receive and discard.

Start

Fields

addr: u8

The device you’re addressing.

You’re responsible for shifting the address, and setting the read/write bit. Consider using the read() and write() methods for this purpose.

expect: Response

The expected response from the device.

Generate a (repeated) start, transmit the address addr, and expect the expect response from a device.

Implementations

impl ControllerCommand

pub const fn read(addr: u8) -> Self

Creates a (repeat) start command that describes a read from a device with address addr.

The expected response is ACK.

pub const fn write(addr: u8) -> Self

Creates a (repeat) start command that describes a write to a device with address addr.

The expected response is ACK.

Trait Implementations

impl Clone for ControllerCommand

fn clone(&self) -> ControllerCommand

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ControllerCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ControllerCommand

fn eq(&self, other: &ControllerCommand) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ControllerCommand

impl Eq for ControllerCommand

impl StructuralEq for ControllerCommand

impl StructuralPartialEq for ControllerCommand