Struct Lpuart 

pub struct Lpuart<'a, M: Mode> { /* private fields */ }

Lpuart driver.

Implementations

impl<'a> Lpuart<'a, Blocking>

pub fn new_blocking<T: Instance>( _inner: Peri<'a, T>, tx_pin: Peri<'a, impl TxPin<T>>, rx_pin: Peri<'a, impl RxPin<T>>, config: Config, ) -> Result<Self, Error>

Create a new blocking LPUART instance with RX/TX pins.

Any external pin will be placed into Disabled state upon Drop.

pub fn new_blocking_with_rtscts<T: Instance>( _inner: Peri<'a, T>, tx_pin: Peri<'a, impl TxPin<T>>, rx_pin: Peri<'a, impl RxPin<T>>, cts_pin: Peri<'a, impl CtsPin<T>>, rts_pin: Peri<'a, impl RtsPin<T>>, config: Config, ) -> Result<Self, Error>

Create a new blocking LPUART instance with RX, TX and RTS/CTS flow control pins.

Any external pin will be placed into Disabled state upon Drop.

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

Read data from LPUART RX blocking execution until the buffer is filled

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

Read data from LPUART RX without blocking

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

Write data to LPUART TX blocking execution until all data is sent

pub fn write_byte(&mut self, byte: u8) -> Result<(), Error>

pub fn read_byte_blocking(&mut self) -> u8

pub fn write_str_blocking(&mut self, buf: &str)

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

Write data to LPUART TX without blocking

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

Flush LPUART TX blocking execution until all data has been transmitted

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

Flush LPUART TX without blocking

impl<'a> Lpuart<'a, Buffered>

pub fn new_buffered<T: Instance>( _inner: Peri<'a, T>, tx_pin: Peri<'a, impl TxPin<T>>, rx_pin: Peri<'a, impl RxPin<T>>, _irq: impl Binding<T::Interrupt, BufferedInterruptHandler<T>> + 'a, tx_buffer: &'a mut [u8], rx_buffer: &'a mut [u8], config: Config, ) -> Result<Self, Error>

Create a new full duplex buffered LPUART.

Any external pin will be placed into Disabled state upon Drop.

SAFETY

You must NOT call core::mem::forget on Lpuart if rx_buffer or tx_buffer are not 'static. This will cause memory corruption.

pub fn new_buffered_with_rtscts<T: Instance>( _inner: Peri<'a, T>, tx_pin: Peri<'a, impl TxPin<T>>, rx_pin: Peri<'a, impl RxPin<T>>, rts_pin: Peri<'a, impl RtsPin<T>>, cts_pin: Peri<'a, impl CtsPin<T>>, _irq: impl Binding<T::Interrupt, BufferedInterruptHandler<T>> + 'a, tx_buffer: &'a mut [u8], rx_buffer: &'a mut [u8], config: Config, ) -> Result<Self, Error>

Create a new buffered LPUART instance with RTS/CTS flow control.

Any external pin will be placed into Disabled state upon Drop.

SAFETY

You must NOT call core::mem::forget on Lpuart if rx_buffer or tx_buffer are not 'static. This will cause memory corruption.

pub fn new_buffered_with_rts<T: Instance>( _inner: Peri<'a, T>, tx_pin: Peri<'a, impl TxPin<T>>, rx_pin: Peri<'a, impl RxPin<T>>, rts_pin: Peri<'a, impl RtsPin<T>>, _irq: impl Binding<T::Interrupt, BufferedInterruptHandler<T>> + 'a, tx_buffer: &'a mut [u8], rx_buffer: &'a mut [u8], config: Config, ) -> Result<Self, Error>

Create a new buffered LPUART with only RTS flow control (RX flow control).

Any external pin will be placed into Disabled state upon Drop.

SAFETY

You must NOT call core::mem::forget on Lpuart if rx_buffer or tx_buffer are not 'static. This will cause memory corruption.

pub fn new_buffered_with_cts<T: Instance>( _inner: Peri<'a, T>, tx_pin: Peri<'a, impl TxPin<T>>, rx_pin: Peri<'a, impl RxPin<T>>, cts_pin: Peri<'a, impl CtsPin<T>>, _irq: impl Binding<T::Interrupt, BufferedInterruptHandler<T>> + 'a, tx_buffer: &'a mut [u8], rx_buffer: &'a mut [u8], config: Config, ) -> Result<Self, Error>

Create a new buffered LPUART with only CTS flow control (TX flow control).

Any external pin will be placed into Disabled state upon Drop.

SAFETY

You must NOT call core::mem::forget on Lpuart if rx_buffer or tx_buffer are not 'static. This will cause memory corruption.

impl<'a> Lpuart<'a, Dma<'a>>

pub fn new_async_with_dma<T: Instance>( _inner: Peri<'a, T>, tx_pin: Peri<'a, impl TxPin<T>>, rx_pin: Peri<'a, impl RxPin<T>>, tx_dma_ch: Peri<'a, impl Channel>, rx_dma_ch: Peri<'a, impl Channel>, config: Config, ) -> Result<Self, Error>

Create a new LPUART driver with DMA support for both TX and RX.

Any external pin will be placed into Disabled state upon Drop.

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

Write data using DMA

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

Read data using DMA

impl<'a, M: Mode> Lpuart<'a, M>

pub fn split(self) -> (LpuartTx<'a, M>, LpuartRx<'a, M>)

Split the Lpuart into a transmitter and receiver

pub fn split_ref(&mut self) -> (&mut LpuartTx<'a, M>, &mut LpuartRx<'a, M>)

Split the Lpuart into a transmitter and receiver by mutable reference

Trait Implementations

impl<M: Mode> ErrorType for Lpuart<'_, M>

type Error = Error

Error type

impl<M: Mode> ErrorType for Lpuart<'_, M>

type Error = Error

Error type of all the IO operations on this type.

impl Read for Lpuart<'_, Blocking>

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

Reads a single word from the serial interface

impl Read for Lpuart<'_, Blocking>

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 Read for Lpuart<'_, Buffered>

async 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.

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

Read the exact number of bytes required to fill buf.

impl<'a> Read for Lpuart<'a, Dma<'a>>

async 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.

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

Read the exact number of bytes required to fill buf.

impl Write for Lpuart<'_, Blocking>

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 Write for Lpuart<'_, 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 Write for Lpuart<'_, Buffered>

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

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

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

impl<'a> Write for Lpuart<'a, Dma<'a>>

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

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

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

impl Write<u8> for Lpuart<'_, Blocking>

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 Read<u8> for Lpuart<'_, Blocking>

type Error = Error

Read error

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

Reads a single word from the serial interface

impl Write<u8> for Lpuart<'_, Blocking>

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