Struct Uart

pub struct Uart<'d, T: Instance, M: Mode> { /* private fields */ }

UART driver.

Implementations

impl<'d, T: Instance> Uart<'d, T, Blocking>

pub fn new_blocking( uart: impl Peripheral<P = T> + 'd, tx: impl Peripheral<P = impl TxPin<T>> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, config: Config, ) -> Self

Create a new UART without hardware flow control

pub fn new_with_rtscts_blocking( uart: impl Peripheral<P = T> + 'd, tx: impl Peripheral<P = impl TxPin<T>> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, rts: impl Peripheral<P = impl RtsPin<T>> + 'd, cts: impl Peripheral<P = impl CtsPin<T>> + 'd, config: Config, ) -> Self

Create a new UART with hardware flow control (RTS/CTS)

pub fn into_buffered( self, irq: impl Binding<T::Interrupt, BufferedInterruptHandler<T>>, tx_buffer: &'d mut [u8], rx_buffer: &'d mut [u8], ) -> BufferedUart<'d, T>

Convert this uart instance into a buffered uart using the provided irq, transmit and receive buffers.

impl<'d, T: Instance> Uart<'d, T, Async>

pub fn new( uart: impl Peripheral<P = T> + 'd, tx: impl Peripheral<P = impl TxPin<T>> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>>, tx_dma: impl Peripheral<P = impl Channel> + 'd, rx_dma: impl Peripheral<P = impl Channel> + 'd, config: Config, ) -> Self

Create a new DMA enabled UART without hardware flow control

pub fn new_with_rtscts( uart: impl Peripheral<P = T> + 'd, tx: impl Peripheral<P = impl TxPin<T>> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, rts: impl Peripheral<P = impl RtsPin<T>> + 'd, cts: impl Peripheral<P = impl CtsPin<T>> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>>, tx_dma: impl Peripheral<P = impl Channel> + 'd, rx_dma: impl Peripheral<P = impl Channel> + 'd, config: Config, ) -> Self

Create a new DMA enabled UART with hardware flow control (RTS/CTS)

impl<'d, T: Instance + 'd, M: Mode> Uart<'d, T, M>

pub fn set_baudrate(&mut self, baudrate: u32)

sets baudrate on runtime

impl<'d, T: Instance, M: Mode> Uart<'d, T, M>

pub fn blocking_write(&mut self, buffer: &[u8]) -> Result<(), Error>

Transmit the provided buffer blocking execution until done.

pub fn blocking_flush(&mut self) -> Result<(), Error>

Flush UART TX blocking execution until done.

pub fn blocking_read(&mut self, buffer: &mut [u8]) -> Result<(), Error>

Read from UART RX blocking execution until done.

pub fn busy(&self) -> bool

Check if UART is busy transmitting.

pub async fn send_break(&mut self, bits: u32)

Wait until TX is empty and send break condition.

pub fn split(self) -> (UartTx<'d, T, M>, UartRx<'d, T, M>)

Split the Uart into a transmitter and receiver, which is particularly useful when having two tasks correlating to transmitting and receiving.

pub fn split_ref(&mut self) -> (&mut UartTx<'d, T, M>, &mut UartRx<'d, T, M>)

Split the Uart into a transmitter and receiver by mutable reference, which is particularly useful when having two tasks correlating to transmitting and receiving.

impl<'d, T: Instance> Uart<'d, T, Async>

pub async fn write(&mut self, buffer: &[u8]) -> Result<(), Error>

Write to UART TX from the provided buffer.

pub async fn read(&mut self, buffer: &mut [u8]) -> Result<(), Error>

Read from UART RX into the provided buffer.

pub async fn read_to_break<'a>( &mut self, buf: &'a mut [u8], ) -> Result<usize, ReadToBreakError>

Read until the buffer is full or a line break occurs.

See UartRx::read_to_break() for more details

pub async fn read_to_break_with_count<'a>( &mut self, buf: &'a mut [u8], min_count: usize, ) -> Result<usize, ReadToBreakError>

Read until the buffer is full or a line break occurs after at least min_count bytes have been read.

See UartRx::read_to_break_with_count() for more details

Trait Implementations

impl<'d, T: Instance> ErrorType for Uart<'d, T, Blocking>

type Error = Error

Error type of all the IO operations on this type.

impl<'d, T: Instance, M: Mode> ErrorType for Uart<'d, T, M>

type Error = Error

Error type

impl<'d, T: Instance, M: Mode> Read for Uart<'d, T, M>

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

Reads a single word from the serial interface

impl<'d, T: Instance> Write for Uart<'d, T, Blocking>

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<'d, T: Instance, M: Mode> Write for Uart<'d, T, M>

fn write(&mut self, char: 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.

impl<'d, T: Instance, M: Mode> Write<u8> for Uart<'d, T, M>

type Error = Error

The type of error that can occur when writing

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

Writes a slice, blocking until everything has been written

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

Block until the serial interface has sent all buffered words

impl<'d, T: Instance, M: Mode> Read<u8> for Uart<'d, T, M>

type Error = Error

Read error

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

Reads a single word from the serial interface

impl<'d, T: Instance, M: Mode> Write<u8> for Uart<'d, T, M>

type Error = Error

Write error

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

Writes a single word to the serial interface

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

Ensures that none of the previously written words are still buffered