Struct capsules_core::virtualizers::virtual_uart::UartDevice

pub struct UartDevice<'a> { /* private fields */ }

Implementations

impl<'a> UartDevice<'a>

pub fn new(mux: &'a MuxUart<'a>, receiver: bool) -> UartDevice<'a>

pub fn setup(&'a self)

Must be called right after static_init!().

Trait Implementations

impl<'a> ListNode<'a, UartDevice<'a>> for UartDevice<'a>

fn next(&'a self) -> &'a ListLink<'a, UartDevice<'a>>

impl<'a> Receive<'a> for UartDevice<'a>

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

Receive data until buffer is full.

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

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

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.

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:

impl<'a> ReceiveClient for UartDevice<'a>

fn received_buffer( &self, rx_buffer: &'static mut [u8], rx_len: usize, rcode: Result<(), ErrorCode>, error: Error )

A call to Receive::receive_buffer completed. The Result<(), ErrorCode> indicates whether the buffer was successfully received. A call to receive_word or receive_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.

fn received_word(&self, _word: u32, _rval: Result<(), ErrorCode>, _error: Error)

A call to Receive::receive_word completed. The Result<(), ErrorCode> indicates whether the word was successfully received. A call to receive_word or receive_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.

impl<'a> Transmit<'a> for UartDevice<'a>

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

Transmit data.

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

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

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.

fn transmit_word(&self, word: 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:

impl<'a> TransmitClient for UartDevice<'a>

fn transmitted_buffer( &self, tx_buffer: &'static mut [u8], tx_len: usize, rcode: Result<(), ErrorCode> )

A call to Transmit::transmit_buffer completed. The Result<(), ErrorCode> indicates whether the buffer was successfully transmitted. A call to transmit_word or transmit_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.

fn transmitted_word(&self, rcode: Result<(), ErrorCode>)

A call to Transmit::transmit_word completed. The Result<(), ErrorCode> indicates whether the word was successfully transmitted. A call to transmit_word or transmit_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.