pub struct UartRx<'d, M: Mode> { /* private fields */ }
Expand description
Rx-only UART Driver.
Can be obtained from Uart::split
, or can be constructed independently,
if you do not need the transmitting half of the driver.
§Notes on embedded_io::Read
embedded_io::Read
requires guarantees that this struct cannot provide:
- Any data received between calls to
UartRx::read
orUartRx::blocking_read
will be thrown away, asUartRx
is unbuffered. Users ofembedded_io::Read
are likely to not expect this behavior (for instance if they read multiple small chunks in a row). UartRx::read
andUartRx::blocking_read
only return once the entire buffer has been filled, whereasembedded_io::Read
requires us to fill the buffer with what we already received, and only block/wait until the first byte arrived.
WhileUartRx::read_until_idle
does return early, it will still eagerly wait for data until the buffer is full or no data has been transmitted in a while, which may not be what users ofembedded_io::Read
expect.
UartRx::into_ring_buffered
can be called to equip UartRx
with a buffer,
that it can then use to store data received between calls to read
,
provided you are using DMA already.
Alternatively, you can use BufferedUartRx
, which is interrupt-based and which can also
store data received between calls.
Also see this github comment.
Implementations§
source§impl<'d> UartRx<'d, Async>
impl<'d> UartRx<'d, Async>
sourcepub fn into_ring_buffered(self, dma_buf: &'d mut [u8]) -> RingBufferedUartRx<'d>
pub fn into_ring_buffered(self, dma_buf: &'d mut [u8]) -> RingBufferedUartRx<'d>
Turn the UartRx
into a buffered uart which can continously receive in the background
without the possibility of losing bytes. The dma_buf
is a buffer registered to the
DMA controller, and must be large enough to prevent overflows.
source§impl<'d> UartRx<'d, Async>
impl<'d> UartRx<'d, Async>
sourcepub fn new<T: Instance>(
peri: impl Peripheral<P = T> + 'd,
_irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd,
rx: impl Peripheral<P = impl RxPin<T>> + 'd,
rx_dma: impl Peripheral<P = impl RxDma<T>> + 'd,
config: Config,
) -> Result<Self, ConfigError>
pub fn new<T: Instance>( peri: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, rx_dma: impl Peripheral<P = impl RxDma<T>> + 'd, config: Config, ) -> Result<Self, ConfigError>
Create a new rx-only UART with no hardware flow control.
Useful if you only want Uart Rx. It saves 1 pin and consumes a little less power.
sourcepub fn new_with_rts<T: Instance>(
peri: impl Peripheral<P = T> + 'd,
_irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd,
rx: impl Peripheral<P = impl RxPin<T>> + 'd,
rts: impl Peripheral<P = impl RtsPin<T>> + 'd,
rx_dma: impl Peripheral<P = impl RxDma<T>> + 'd,
config: Config,
) -> Result<Self, ConfigError>
pub fn new_with_rts<T: Instance>( peri: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, rts: impl Peripheral<P = impl RtsPin<T>> + 'd, rx_dma: impl Peripheral<P = impl RxDma<T>> + 'd, config: Config, ) -> Result<Self, ConfigError>
Create a new rx-only UART with a request-to-send pin
source§impl<'d> UartRx<'d, Blocking>
impl<'d> UartRx<'d, Blocking>
sourcepub fn new_blocking<T: Instance>(
peri: impl Peripheral<P = T> + 'd,
rx: impl Peripheral<P = impl RxPin<T>> + 'd,
config: Config,
) -> Result<Self, ConfigError>
pub fn new_blocking<T: Instance>( peri: impl Peripheral<P = T> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, config: Config, ) -> Result<Self, ConfigError>
Create a new rx-only UART with no hardware flow control.
Useful if you only want Uart Rx. It saves 1 pin and consumes a little less power.
sourcepub fn new_blocking_with_rts<T: Instance>(
peri: impl Peripheral<P = T> + 'd,
rx: impl Peripheral<P = impl RxPin<T>> + 'd,
rts: impl Peripheral<P = impl RtsPin<T>> + 'd,
config: Config,
) -> Result<Self, ConfigError>
pub fn new_blocking_with_rts<T: Instance>( peri: impl Peripheral<P = T> + 'd, rx: impl Peripheral<P = impl RxPin<T>> + 'd, rts: impl Peripheral<P = impl RtsPin<T>> + 'd, config: Config, ) -> Result<Self, ConfigError>
Create a new rx-only UART with a request-to-send pin
Trait Implementations§
source§impl<'d, M: Mode> SetConfig for UartRx<'d, M>
impl<'d, M: Mode> SetConfig for UartRx<'d, M>
source§type ConfigError = ConfigError
type ConfigError = ConfigError
set_config
fails.