Struct opentitanlib::transport::common::uart::SerialPortUart

pub struct SerialPortUart { /* private fields */ }

Implementation of the Uart trait on top of a serial device, such as /dev/ttyUSB0.

Implementations

impl SerialPortUart

pub fn open(port_name: &str, baud: u32) -> Result<Self>

Open the given serial device, such as /dev/ttyUSB0.

pub fn open_pseudo(port_name: &str, baud: u32) -> Result<Self>

Open a pseudo port (e.g. a verilator pts device).

Trait Implementations

impl Uart for SerialPortUart

fn get_baudrate(&self) -> Result<u32>

Returns the UART baudrate. May return zero for virtual UARTs.

fn set_baudrate(&self, baudrate: u32) -> Result<()>

Sets the UART baudrate. May do nothing for virtual UARTs.

fn read_timeout(&self, buf: &mut [u8], timeout: Duration) -> Result<usize>

Reads UART receive data into buf, returning the number of bytes read. The timeout may be used to specify a duration to wait for data.

fn read(&self, buf: &mut [u8]) -> Result<usize>

Reads UART receive data into buf, returning the number of bytes read. This function may block.

fn write(&self, buf: &[u8]) -> Result<()>

Writes data from buf to the UART.

fn clear_rx_buffer(&self) -> Result<()>

Clears the UART RX buffer.

fn set_flow_control(&self, flow_control: bool) -> Result<()>

Enables software flow control for writes.

fn get_device_path(&self) -> Result<String>

Returns "/dev/ttyUSBn" or similar OS device path usable by external programs for directly accessing the serial port.

fn set_break(&self, enable: bool) -> Result<()>

fn set_parity(&self, parity: Parity) -> Result<()>

fn supports_nonblocking_read(&self) -> Result<bool>

Query if nonblocking mio mode is supported.

fn register_nonblocking_read( &self, registry: &Registry, token: Token ) -> Result<()>

Switch this Uart instance into nonblocking mio mode. Going forward, read() should only be called after mio::poll() has indicated that the given Token is ready.

fn nonblocking_help(&self) -> Result<Rc<dyn NonblockingHelp>>

Get the same single NonblockingHelp object as from top level Transport.nonblocking_help().