Struct USART

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

Implementations

impl<'a> USART<'a>

pub fn new_usart0(pm: &'a PowerManager) -> Self

pub fn new_usart1(pm: &'a PowerManager) -> Self

pub fn new_usart2(pm: &'a PowerManager) -> Self

pub fn new_usart3(pm: &'a PowerManager) -> Self

pub fn set_dma(&self, rx_dma: &'a DMAChannel, tx_dma: &'a DMAChannel)

pub fn set_mode(&self, mode: UsartMode)

pub fn enable_tx(&self, usart: &USARTRegManager<'_>)

pub fn handle_interrupt(&self)

pub fn send_byte(&self, usart: &USARTRegManager<'_>, byte: u8)

pub fn tx_ready(&self, usart: &USARTRegManager<'_>) -> bool

Trait Implementations

impl Configure for USART<'_>

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

Set the configuration parameters for the UART bus.

impl DMAClient for USART<'_>

fn transfer_done(&self, pid: DMAPeripheral)

impl DeferredCallClient for USART<'_>

fn handle_deferred_call(&self)

Software interrupt function that is called when the deferred call is triggered.

fn register(&'static self)

impl<'a> Receive<'a> for USART<'a>

Implementation of kernel::uart

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

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

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

Receive rx_len bytes into rx_buffer.

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

Abort any ongoing receive transfers and return what has been received.

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

Receive a single word of data.

impl<'a> ReceiveAdvanced<'a> for USART<'a>

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

Receive data until interbyte_timeout bit periods have passed since the last byte or buffer is full.

impl<'a> SpiMaster<'a> for USART<'a>

SPI

fn specify_chip_select(&self, cs: Self::ChipSelect) -> Result<(), ErrorCode>

Pass in a None to use the HW chip select pin on the USART (RTS).

fn set_rate(&self, rate: u32) -> Result<u32, ErrorCode>

Returns the actual rate set

type ChipSelect = ChipSelectPolar<'a, GPIOPin<'a>>

Chip select is an associated type because different SPI buses may have different numbers of chip selects. This allows peripheral implementations to define their own type.

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

Initialize this SPI interface. Call this once before invoking any other operations.

fn set_client(&self, client: &'a dyn SpiMasterClient)

Change the callback handler for SpiMaster::read_write_bytes calls.

fn is_busy(&self) -> bool

Return whether the SPI peripheral is busy with a SpiMaster::read_write_bytes operation.

fn read_write_bytes( &self, write_buffer: SubSliceMut<'static, u8>, read_buffer: Option<SubSliceMut<'static, u8>>, ) -> Result<(), (ErrorCode, SubSliceMut<'static, u8>, Option<SubSliceMut<'static, u8>>)>

Perform an asynchronous read/write operation, whose completion is signaled by invoking SpiMasterClient on the client. Write-only operations may pass None for read_buffer, while read-write operations pass Some for read_buffer.

fn write_byte(&self, val: u8) -> Result<(), ErrorCode>

Synchronously write a single byte on the bus. Not for general use because it is blocking: intended for debugging.

fn read_byte(&self) -> Result<u8, ErrorCode>

Synchronously write a 0 and read a single byte from the bus. Not for general use because it is blocking: intended for debugging.

fn read_write_byte(&self, val: u8) -> Result<u8, ErrorCode>

Synchronously write and read a single byte. Not for general use because it is blocking: intended for debugging.

fn get_rate(&self) -> u32

Return the current chip select’s clock rate.

fn set_polarity(&self, polarity: ClockPolarity) -> Result<(), ErrorCode>

Set the bus polarity (whether idle is high or low) for the current chip select.

fn get_polarity(&self) -> ClockPolarity

Return the current bus polarity.

fn set_phase(&self, phase: ClockPhase) -> Result<(), ErrorCode>

Set the bus phase for the current chip select (whether data is sent/received on leading or trailing edges).

fn get_phase(&self) -> ClockPhase

Get the current bus phase for the current chip select.

fn hold_low(&self)

Hold the chip select line low after a SpiMaster::read_write_bytes completes. This allows a client to make one long SPI read/write with multiple calls to read_write_bytes.

fn release_low(&self)

Raise the chip select line after a SpiMaster::read_write_bytes completes. This will complete the SPI operation.

impl<'a> Transmit<'a> for USART<'a>

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

Transmit a buffer of data.

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

Abort an outstanding call to transmit_word or transmit_buffer.

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

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

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

Transmit a single word of data asynchronously.