Struct Rx 

pub struct Rx { /* private fields */ }

AXI UARTLITE TX driver.

Can be created by super::AxiUartlite::splitting a regular AXI UARTLITE structure or by Self::stealing it unsafely.

Implementations

impl Rx

pub const unsafe fn steal(base_addr: usize) -> Self

Steal the RX part of the UART Lite.

You should only use this if you can not use the regular super::AxiUartlite constructor and the super::AxiUartlite::split method.

This function assumes that the setup of the UART was already done. It can be used to create an RX handle inside an interrupt handler without having to use a critical_section::Mutex if the user can guarantee that the RX handle will only be used by the interrupt handler or only interrupt specific API will be used.

Safety

The same safey rules specified in super::AxiUartlite apply.

pub fn read_fifo(&mut self) -> Result<u8, Infallible>

Read the RX FIFO.

This functions offers a nb::Result based API and returns nb::Error::WouldBlock if there is nothing to read.

pub fn read_fifo_unchecked(&mut self) -> u8

Read from the FIFO without checking the FIFO fill status.

pub fn has_data(&self) -> bool

Does the RX FIFO have valid data?

pub fn read_whole_fifo(&mut self, buf: &mut [u8; 16]) -> usize

This simply reads all available bytes in the RX FIFO.

It returns the number of read bytes.

pub fn on_interrupt_rx(&mut self, buf: &mut [u8; 16]) -> usize

Can be called in the interrupt handler for the UART Lite to handle RX reception.

Simply calls Rx::read_whole_fifo.

pub fn read_and_clear_last_error(&mut self) -> Option<RxErrors>

Read and clear the last RX errors.

Returns None if no errors have occured.

Trait Implementations

impl ErrorType for Rx

type Error = Infallible

Error type

impl ErrorType for Rx

type Error = Infallible

Error type of all the IO operations on this type.

impl Read for Rx

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

Reads a single word from the serial interface

impl Read for Rx

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

Read some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf.