Struct libtegra::uart::Uart

pub struct Uart { /* private fields */ }

Representation of a UART.

NOTE: Instances of this struct should never be created manually. Refer to the public constants the struct holds, which represent the UARTs A through E.

Implementations

impl Uart

pub const A: Self = Uart { baud: 0, clock: &Clock::UART_A, registers: UART_A_REGISTERS, }

Representation of UART A.

pub const B: Self = Uart { baud: 0, clock: &Clock::UART_B, registers: UART_B_REGISTERS, }

Representation of UART B.

pub const C: Self = Uart { baud: 0, clock: &Clock::UART_C, registers: UART_C_REGISTERS, }

Representation of UART C.

pub const D: Self = Uart { baud: 0, clock: &Clock::UART_D, registers: UART_D_REGISTERS, }

Representation of UART D.

pub const E: Self = Uart { baud: 0, clock: &Clock::UART_APE, registers: UART_E_REGISTERS, }

Representation of UART E.

impl Uart

pub fn init(&mut self, baud_rate: u32)

Initializes the UART with a given baud rate.

NOTE: This method needs to be called once before a Uart can actually send and receive data. Further, it is required to do the respective pinmux configuration before calling this method.

pub fn read_byte(&self) -> u8

Reads a singly byte over UART and returns it.

This method blocks until data is available to read.

pub fn read(&self, data: &mut [u8])

Fills a mutable buffer of data with bytes read over UART.

This method blocks until the buffer is filled.

pub fn write_byte(&self, byte: u8)

Writes a single byte over UART.

This method blocks until data can be transferred.

pub fn write(&self, data: &[u8])

Writes a buffer of bytes over UART.

This method blocks until everything was transferred.

pub fn invert(&self, mask: u32, enable: bool)

Enables or disables inversion of the UART signal with the desired bitmask.

See the documentation of the UART_IRDA_CSR_0 bitfield for instructions on the structure of the expected bitmask.

pub fn flush(&self)

Flushes the underlying FIFOs of the Uart.

This wipes out the data to read and the data that should be written, so be careful when you use it. In most cases, this method won’t be needed.

Trait Implementations

impl Clone for Uart

fn clone(&self) -> Uart

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Uart

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Uart> for Uart

fn eq(&self, other: &Uart) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Uart) -> bool

This method tests for !=.

impl Write for Uart

fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl Write<u8> for Uart

type Error = ()

The type of error that can occur when writing

fn bwrite_all(&mut self, buffer: &[u8]) -> Result<(), Self::Error>

Writes a slice, blocking until everything has been written

fn bflush(&mut self) -> Result<(), Self::Error>

Block until the serial interface has sent all buffered words

impl Copy for Uart

impl Eq for Uart

impl StructuralEq for Uart

impl StructuralPartialEq for Uart

impl Sync for Uart