Struct imxrt_hal::lpuart::Baud

pub struct Baud {
    pub osr: u32,
    pub sbr: u32,
    pub bothedge: bool,
}

Values specific to the baud rate.

To compute the values for a given baud rate, use compute. To understand the actual baud rate, use value.

Advanced users may choose to set the OSR, SBR, and BOTHEDGE values directly.

use imxrt_hal::lpuart::Baud;

// Assume UART clock is driven from the crystal
// oscillator...
const UART_CLOCK_HZ: u32 = 24_000_000;
const BAUD: Baud = Baud::compute(UART_CLOCK_HZ, 115200);

Fields

osr: u32

Oversampling rate.

This should be set between 4 and 32. The driver clamps the osr value within this range.

sbr: u32

Baud rate modulo divisor.

The driver commits this value directly. A value of zero is allowed, but will disable baud rate generation in hardware. The max value is (2^13) - 1. The implementation limits the max value.

bothedge: bool

Both edge sampling.

Should be set when the oversampling rate is between 4 and 7. Optional for higher sampling rates. The driver will commit this value directly.

Implementations

impl Baud

pub const fn value(self, source_clock_hz: u32) -> u32

Returns the baud value in bits per second.

source_clock_hz is the UART clock frequency (Hz).

Panics

Panics if sbr or osr is zero.

pub const fn compute(source_clock_hz: u32, baud: u32) -> Baud

Computes a timings struct that represents a baud rate.

source_clock_hz is the UART clock frequency (Hz). baud is the intended baud rate.

Trait Implementations

impl Clone for Baud

fn clone(&self) -> Baud

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Baud

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

Formats the value using the given formatter.

impl PartialEq for Baud

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

impl Eq for Baud

impl StructuralEq for Baud

impl StructuralPartialEq for Baud