Struct SynopsysUart 

pub struct SynopsysUart<'a> { /* private fields */ }

Driver for a Synopsys DesignWare DW_apb UART.

Implementations

impl<'a> SynopsysUart<'a>

pub const fn new(registers: UniqueMmioPointer<'a, Registers>) -> Self

Creates a new instance of the UART driver.

pub fn configure(&mut self, baud_rate: u32, serial_clock: u32)

Configures the UART with the given baud rate, 8 data bits, no parity, and 1 stop bit.

Also enables the transmit and receive FIFOs.

This first waits until the UART is not busy, so may block.

pub fn is_tx_fifo_full(&self) -> bool

Returns whether the TX FIFO is currently full.

If this returns true, write_word will block.

pub fn write_word(&mut self, byte: u8)

Writes a single byte to the UART.

This blocks until there is room in the transmit FIFO to write the byte, but doesn’t wait for the byte to be transmitted.

pub fn flush(&self)

Blocks until all previously written bytes have been transmitted.

pub fn is_rx_fifo_empty(&self) -> bool

Returns true if the RX FIFO is currently empty.

If this returns true then read_word will return None.

pub fn read_word(&mut self) -> Result<Option<u8>, UartError>

Reads a single byte from the UART.

If no data is available to be read this will return Ok(None). If there is an error condition then it will be cleared and an error will be returned.

Trait Implementations

impl ErrorType for SynopsysUart<'_>

type Error = UartError

Error type of all the IO operations on this type.

impl Read for SynopsysUart<'_>

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.

impl ReadReady for SynopsysUart<'_>

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

Get whether the reader is ready for immediately reading.

impl Write for SynopsysUart<'_>

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

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, blocking until all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered.

impl Write for SynopsysUart<'_>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl WriteReady for SynopsysUart<'_>

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

Get whether the writer is ready for immediately writing.

impl Sync for SynopsysUart<'_>