Embassy
embassy-rp

Crates

git

Versions

rp2040

Flavors

Struct embassy_rp::uart::Uart

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

UART driver.

Implementations§

source§

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

source

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

source

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)

source

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.

source§

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

source

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

source

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)

source§

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

source

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

sets baudrate on runtime

source§

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

source

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

Transmit the provided buffer blocking execution until done.

source

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

Flush UART TX blocking execution until done.

source

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

Read from UART RX blocking execution until done.

source

pub fn busy(&self) -> bool

Check if UART is busy transmitting.

source

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

Wait until TX is empty and send break condition.

source

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.

source§

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

source

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

Write to UART TX from the provided buffer.

source

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

Read from UART RX into the provided buffer.

source

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

Trait Implementations§

source§

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

§

type Error = Error

Error type
source§

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

source§

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

Reads a single word from the serial interface
source§

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

source§

fn write(&mut self, char: 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<'d, T: Instance, M: Mode> Write<u8> for Uart<'d, T, M>

§

type Error = Error

The type of error that can occur when writing
source§

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

Writes a slice, blocking until everything has been written Read more
source§

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

Block until the serial interface has sent all buffered words
source§

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

§

type Error = Error

Read error
source§

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

Reads a single word from the serial interface
source§

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

§

type Error = Error

Write error
source§

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

Writes a single word to the serial interface
source§

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

Ensures that none of the previously written words are still buffered

Auto Trait Implementations§

§

impl<'d, T, M> Freeze for Uart<'d, T, M>

§

impl<'d, T, M> RefUnwindSafe for Uart<'d, T, M>

§

impl<'d, T, M> Send for Uart<'d, T, M>
where M: Send, T: Send,

§

impl<'d, T, M> Sync for Uart<'d, T, M>
where M: Sync, T: Sync,

§

impl<'d, T, M> Unpin for Uart<'d, T, M>
where M: Unpin,

§

impl<'d, T, M> !UnwindSafe for Uart<'d, T, M>

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> Az for T

source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

source§

fn lossy_into(self) -> Dst

Performs the conversion.
source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
source§

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

§

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>,

§

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.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.