Struct nrf52840_hal::Uarte
source · pub struct Uarte<T>(/* private fields */);
Expand description
Interface to a UARTE instance.
This is a very basic interface that comes with the following limitations:
- The UARTE instances share the same address space with instances of UART.
You need to make sure that conflicting instances
are disabled before using
Uarte
. See product specification:- nrf52832: Section 15.2
- nrf52840: Section 6.1.2
Implementations§
source§impl<T> Uarte<T>where
T: Instance,
impl<T> Uarte<T>where
T: Instance,
pub fn new( uarte: T, pins: Pins, parity: PARITY_A, baudrate: BAUDRATE_A ) -> Uarte<T>
sourcepub fn write(&mut self, tx_buffer: &[u8]) -> Result<(), Error>
pub fn write(&mut self, tx_buffer: &[u8]) -> Result<(), Error>
Write via UARTE.
This method uses transmits all bytes in tx_buffer
.
The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.
sourcepub fn read(&mut self, rx_buffer: &mut [u8]) -> Result<(), Error>
pub fn read(&mut self, rx_buffer: &mut [u8]) -> Result<(), Error>
Read via UARTE.
This method fills all bytes in rx_buffer
, and blocks
until the buffer is full.
The buffer must have a length of at most 255 bytes.
sourcepub fn read_timeout<I>(
&mut self,
rx_buffer: &mut [u8],
timer: &mut Timer<I>,
cycles: u32
) -> Result<(), Error>where
I: Instance,
pub fn read_timeout<I>(
&mut self,
rx_buffer: &mut [u8],
timer: &mut Timer<I>,
cycles: u32
) -> Result<(), Error>where
I: Instance,
Read via UARTE.
This method fills all bytes in rx_buffer
, and blocks
until the buffer is full or the timeout expires, whichever
comes first.
If the timeout occurs, an Error::Timeout(n)
will be returned,
where n
is the number of bytes read successfully.
This method assumes the interrupt for the given timer is NOT enabled, and in cases where a timeout does NOT occur, the timer will be left running until completion.
The buffer must have a length of at most 255 bytes.
sourcepub fn split(
self,
tx_buf: &'static mut [u8],
rx_buf: &'static mut [u8; 1]
) -> Result<(UarteTx<T>, UarteRx<T>), Error>
pub fn split( self, tx_buf: &'static mut [u8], rx_buf: &'static mut [u8; 1] ) -> Result<(UarteTx<T>, UarteRx<T>), Error>
Split into implementations of embedded_hal::serial traits.
The size of the tx_buf
slice passed to this method will determine
the size of the DMA transfers performed.
The rx_buf
slice is an array of size 1 since the embedded_hal
traits only allow reading one byte at a time.