Struct nrf52::uart::Uarte

source ·
pub struct Uarte<'a> { /* private fields */ }
Expand description

UARTE

Implementations§

source§

impl<'a> Uarte<'a>

source

pub const fn new(regs: StaticRef<UarteRegisters>) -> Uarte<'a>

Constructor

source

pub fn initialize( &self, txd: Pinmux, rxd: Pinmux, cts: Option<Pinmux>, rts: Option<Pinmux> )

Configure which pins the UART should use for txd, rxd, cts and rts

source

pub fn handle_interrupt(&self)

UART interrupt handler that listens for both tx_end and rx_end events

source

pub unsafe fn send_byte(&self, byte: u8)

Transmit one byte at the time and the client is responsible for polling This is used by the panic handler

source

pub fn tx_ready(&self) -> bool

Check if the UART transmission is done

source

pub fn rx_ready(&self) -> bool

Check if either the rx_buffer is full or the UART has timed out

Trait Implementations§

source§

impl<'a> Configure for Uarte<'a>

source§

fn configure(&self, params: Parameters) -> Result<(), ErrorCode>

Returns Ok(()), or Read more
source§

impl<'a> Receive<'a> for Uarte<'a>

source§

fn set_receive_client(&self, client: &'a dyn ReceiveClient)

Set the receive client, which will he called when reads complete.
source§

fn receive_buffer( &self, rx_buf: &'static mut [u8], rx_len: usize ) -> Result<(), (ErrorCode, &'static mut [u8])>

Receive rx_len bytes into rx_buffer, making a callback to the ReceiveClient when complete. If the Result<(), ErrorCode> of receive_buffer’s return is Ok(()), the struct will issue a received_buffer callback in the future. If the value of the Result<(), ErrorCode> is Err(), then the rx_buffer argument is returned in the Err(). Valid ErrorCode values are: Read more
source§

fn receive_word(&self) -> Result<(), ErrorCode>

Receive a single word of data. The word length is determined by the UART configuration: it can be 6, 7, 8, or 9 bits long. If the Result<(), ErrorCode> is Ok(()), on completion, received_word will be called on the ReceiveClient. Other valid ErrorCode values are: Read more
source§

fn receive_abort(&self) -> Result<(), ErrorCode>

Abort any ongoing receive transfers and return what is in the receive buffer with the receive_complete callback. If Ok(()) is returned, there will be no callback (no call to receive was outstanding). If there was a receive outstanding, which is cancelled successfully then BUSY will be returned and there will be a callback with a Result<(), ErrorCode> of CANCEL. If there was a reception outstanding, which is not cancelled successfully, then FAIL will be returned and there will be a later callback.
source§

impl<'a> Transmit<'a> for Uarte<'a>

source§

fn set_transmit_client(&self, client: &'a dyn TransmitClient)

Set the transmit client, which will be called when transmissions complete.
source§

fn transmit_buffer( &self, tx_data: &'static mut [u8], tx_len: usize ) -> Result<(), (ErrorCode, &'static mut [u8])>

Transmit a buffer of data. On completion, transmitted_buffer in the TransmitClient will be called. If the Result<(), ErrorCode> returned by transmit is an Ok(()), the struct will issue a transmitted_buffer callback in the future. If the value of the Result<(), ErrorCode> is Err(), then the tx_bufferargument is returned in theErr(), along with the ErrorCode. Valid ErrorCode` values are: Read more
source§

fn transmit_word(&self, _data: u32) -> Result<(), ErrorCode>

Transmit a single word of data asynchronously. The word length is determined by the UART configuration: it can be 6, 7, 8, or 9 bits long. If the Result<(), ErrorCode> is Ok(()), on completion, transmitted_word will be called on the TransmitClient. Other valid Result<(), ErrorCode> values are: Read more
source§

fn transmit_abort(&self) -> Result<(), ErrorCode>

Abort an outstanding call to transmit_word or transmit_buffer. The return code indicates whether the call has fully terminated or there will be a callback. Cancelled calls to transmit_buffer MUST always make a callback, to return the passed buffer back to the caller. Read more

Auto Trait Implementations§

§

impl<'a> !Freeze for Uarte<'a>

§

impl<'a> !RefUnwindSafe for Uarte<'a>

§

impl<'a> !Send for Uarte<'a>

§

impl<'a> !Sync for Uarte<'a>

§

impl<'a> Unpin for Uarte<'a>

§

impl<'a> !UnwindSafe for Uarte<'a>

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

source§

#[doc(hidden)] const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
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<'a, T> Uart<'a> for T
where T: Configure + Transmit<'a> + Receive<'a>,

source§

impl<'a, T> UartData<'a> for T
where T: Transmit<'a> + Receive<'a>,