Struct imxrt_hal::uart::UART

pub struct UART<M: Unsigned> { /* fields omitted */ }

An initialized UART peripheral

Call read() or write() to transmit bytes.

Implementations

impl<M> UART<M> where
    M: Unsigned, 

pub fn split(self) -> (Tx<M>, Rx<M>)

Split the UART peripheral into its transfer and receive half

Ensure your UART peripheral is configured before calling split().

pub fn join(tx: Tx<M>, _rx: Rx<M>) -> Self

Re-combine the transfer and receive halves to create a full UART peripheral

join() will let you re-configure a UART peripheral if theres a need to change settings.

pub fn set_parity(&mut self, parity: Option<Parity>)

Specify parity bit settings. If there is no parity, use None.

Calling this method will temporarily disable the peripheral, flusing all data from all FIFOs.

pub fn set_rx_inversion(&mut self, inverted: bool)

Reverse the polarity of received data, affecting all data bits, start and stop bits, and polarity bits.

The default inversion state is false. Note that calling this method will temporarily disable the peripheral, flusing all data from all FIFOs.

pub fn set_tx_inversion(&mut self, inverted: bool)

Reverse the polarity of transferred data, affecting all data bits, start and stop bits, and polarity bits.

The default inversion state is false. Note that calling this method will temporarily disable the peripheral, flusing all data from all FIFOs.

pub fn set_tx_fifo(&mut self, size: Option<NonZeroU8>) -> u8

Controls the TX FIFO.

If size is Some(n), where n > 0, the method will enable the TX FIFO with a size n. The method returns size of the FIFO that was set, which is based on the hardware. On an iMXRT1062, the max size is 4.

If size is None, the method disables the TX FIFO. The return is 0.

The method temporarily disables the UART bus, flushing any data in the both TX and RX FIFOs.

pub fn set_rx_fifo(&mut self, enable: bool)

Enable or disable the RX FIFO. The maximum size of the FIFO is based on the underlying hardware. An iMXRT1062’s RX FIFO is 4 bytes.

Calling this method temporarily disables the peripheral, flusing all data from both TX and RX FIFOs.

pub fn set_baud(&mut self, baud: u32) -> Result<(), TimingsError>

Set the baud rate for the UART bus. Returns a TimingsError if there was an error computing the values that describe the baud rate.

Calling this method temporarily disables the peripheral, flusing all data from both TX and RX FIFOs.

pub fn set_receiver_interrupt(&mut self, watermark: Option<u8>) -> u8

Enable the receiver interrupt associated with this UART

The interrupt will trigger when there are at least watermark number of bytes in the RX FIFO. Returns the maximum-allowable watermark level that was set in hardware. A watermark of Some(0) means that we should interrupt as soon as a byte is read.

If the watermark is greater than 0, ensure that you call set_rx_fifo before this method. Otherwise, the return will be 0 despite the supplied watermark.

Disable receiver interrupt by setting watermark to None. The return is always 0 when disabling the receiver interrupt.

Trait Implementations

impl<M> Default<u8> for UART<M> where
    M: Unsigned, 

impl<M> Read<u8> for UART<M> where
    M: Unsigned, 

type Error = ReadError

Read error

fn read(&mut self) -> Result<u8, Self::Error>

Reads a single word from the serial interface

impl<M> Write<u8> for UART<M> where
    M: Unsigned, 

type Error = Infallible

Write error

fn write(&mut self, word: u8) -> Result<(), Self::Error>

Writes a single word to the serial interface

fn flush(&mut self) -> Result<(), Self::Error>

Ensures that none of the previously written words are still buffered