Struct Uart

pub struct Uart { /* private fields */ }

Driver for a PL011 UART.

Implementations

impl Uart

pub unsafe fn new(base_address: *mut u32) -> Self

Constructs a new instance of the UART driver for a PL011 device at the given base address.

Safety

The given base address must point to the 14 MMIO control registers of a PL011 device, which must be mapped into the address space of the process as device memory and not have any other aliases.

pub fn init(&mut self, clock: u32, baud_rate: u32)

Initializes PL011 UART.

clock: Uart clock in Hz. baud_rate: Baud rate.

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

Writes a single byte to the UART.

This blocks until there is space in the transmit FIFO or holding register, but returns as soon as the byte has been written to the transmit FIFO or holding register. It doesn’t wait for the byte to be sent.

pub fn is_transmitting(&self) -> bool

Returns whether the UART is currently transmitting data.

This will be true immediately after calling write_byte.

pub fn read_byte(&mut self) -> Result<Option<u8>, Error>

Reads and returns a pending byte, or None if nothing has been received.

Trait Implementations

impl Debug for Uart

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

Formats the value using the given formatter.

impl ErrorType for Uart

type Error = Error

Error type of all the IO operations on this type.

impl Read for Uart

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 Uart

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

Get whether the reader is ready for immediately reading.

impl Write for Uart

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 Write for Uart

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 WriteReady for Uart

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

Get whether the writer is ready for immediately writing.

impl Send for Uart

impl Sync for Uart