AxiUartlite

Struct AxiUartlite 

Source
pub struct AxiUartlite { /* private fields */ }
Expand description

AXI UART Lite peripheral driver.

Implementations§

Source§

impl AxiUartlite

Source

pub const unsafe fn new(base_addr: u32) -> Self

Create a new AXI UART Lite peripheral driver.

§Safety
  • The base_addr must be a valid memory-mapped register address of an AXI UART Lite peripheral.
  • Dereferencing an invalid or misaligned address results in undefined behavior.
  • The caller must ensure that no other code concurrently modifies the same peripheral registers in an unsynchronized manner to prevent data races.
  • This function does not enforce uniqueness of driver instances. Creating multiple instances with the same base_addr can lead to unintended behavior if not externally synchronized.
  • The driver performs volatile reads and writes to the provided address.
Source

pub const fn regs(&mut self) -> &mut MmioRegisters<'static>

Direct register access.

Source

pub fn write_fifo(&mut self, data: u8) -> Result<(), Infallible>

Write into the UART Lite.

Returns nb::Error::WouldBlock if the TX FIFO is full.

Source

pub fn write_fifo_unchecked(&mut self, data: u8)

Write into the FIFO without checking the FIFO fill status.

This can be useful to completely fill the FIFO if it is known to be empty.

Source

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

Read from the UART Lite.

Offers a

Source

pub fn read_fifo_unchecked(&mut self) -> u8

Read from the FIFO without checking the FIFO fill status.

Source

pub fn tx_fifo_empty(&self) -> bool

Is the TX FIFO empty?

Source

pub fn tx_fifo_full(&self) -> bool

TX FIFO full status.

Source

pub fn rx_has_data(&self) -> bool

RX FIFO has data.

Source

pub fn read_and_clear_errors(&mut self) -> RxErrorsCounted

Read the error counters and also resets them.

Source

pub fn reset_rx_fifo(&mut self)

Reset the RX FIFO.

Source

pub fn reset_tx_fifo(&mut self)

Reset the TX FIFO.

Source

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

Split the driver into Tx and Rx halves.

Source

pub fn enable_interrupt(&mut self)

Enable UART Lite interrupts.

Source

pub fn disable_interrupt(&mut self)

Disable UART Lite interrupts.

Trait Implementations§

Source§

impl ErrorType for AxiUartlite

Source§

type Error = Infallible

Error type
Source§

impl ErrorType for AxiUartlite

Source§

type Error = Infallible

Error type of all the IO operations on this type.
Source§

impl Read for AxiUartlite

Source§

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

Reads a single word from the serial interface
Source§

impl Read for AxiUartlite

Source§

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. Read more
Source§

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

Read the exact number of bytes required to fill buf. Read more
Source§

impl Write for AxiUartlite

Source§

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

Writes a single word to the serial interface.
Source§

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

Ensures that none of the previously written words are still buffered.
Source§

impl Write for AxiUartlite

Source§

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

Write a buffer into this writer, returning how many bytes were written. Read more
Source§

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

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

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

Write an entire buffer into this writer. Read more
Source§

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

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.