Struct imxrt_hal::lpi2c::Timing

pub struct Timing { /* private fields */ }

LPI2C timing parameters.

The implementation computes BUSIDLE based on the clock configuration values, but you can override this after construction.

The simplest way to construct a Timing is to use ideal().

Implementations

impl Timing

pub const fn ideal(clock_hz: u32, clock_speed: ClockSpeed) -> Self

Compute timing parameters assuming an ideal I2C bus.

This constructor assumes that

• the SDA / SCL rise times are negligible (take less than one functional clock cycle).
• there’s no need for glitch filters (FLITSCL = FILTSDA = 0).

These assumptions may not hold true for high clock speeds and I2C bus loadings. If that’s the case, you may find it’s better to define timing parameters yourself.

Note that this function can run at compile time. Consider evaluating in a const context to avoid the possibility of panics.

Panics

After evaluating all prescalars, this function panics if the computed clock period cannot be represented in the 6 bits available for the configuration.

pub const fn new( clock_configuration: ClockConfiguration, prescaler: Prescaler ) -> Self

Computes timing parameters assuming an ideal circuit.

Define LPI2C timings by the clock configuration values, and a prescaler.

pub const fn clock_configuration(&self) -> ClockConfiguration

Returns the clock configuration.

pub const fn prescaler(&self) -> Prescaler

Returns the prescaler.

pub const fn override_busidle(self, busidle: u32) -> Self

Override the BUSIDLE parameter.

The minimum BUSIDLE is computed by CLKLO, SETHOLD, and CLKHI. Use this method to override the value.

Trait Implementations

impl Clone for Timing

fn clone(&self) -> Timing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timing

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

Formats the value using the given formatter.

impl PartialEq for Timing

fn eq(&self, other: &Timing) -> 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 Timing

impl Eq for Timing

impl StructuralEq for Timing

impl StructuralPartialEq for Timing