Crate serial_port

A full serial driver with more advanced I/O support, e.g., interrupt-based data receival.

This crate builds on [serial_port_basic], which provides the lower-level types and functions that enable simple interactions with serial ports. This crate extends that functionality to provide interrupt handlers for receiving data and handling data access in a deferred, asynchronous manner. It also implements additional higher-level I/O traits for serial ports, namely [core2::io::Read] and [core2::io::Write].

Notes

Typically, drivers do not need to be designed in this split manner. However, the serial port is the very earliest device to be initialized and used in Theseus, as it acts as the backend output stream for Theseus’s logger.

Structs

• DataChunk
  A chunk of data read from a serial port that will be transmitted to a receiver.
• DataSenderAlreadyExists
  An empty error type indicating that a data sender could not be set for a serial port because a sender had already been set for it.
• SerialPort
  A serial port abstraction with support for interrupt-based data receival.
• SerialPortBasic
  A serial port and its various data and control registers.

Enums

• SerialPortAddress
  The base port I/O addresses for COM serial ports.
• SerialPortInterruptEvent
  The types of events that can trigger an interrupt on a serial port.

Functions

• get_serial_port
  Obtains a reference to the SerialPort specified by the given SerialPortAddress, if it has been initialized (see init_serial_port()).
• init_serial_port
  Initializes the SerialPort specified by the given SerialPortAddress.
• set_connection_listener
  A temporary hack to allow the serial port interrupt handler to inform a listener on the other end of this channel that a new connection has been detected on one of the serial ports, i.e., that it received some data on a serial port that didn’t expect it or wasn’t yet set up to handle incoming data.
• take_serial_port_basic
  Takes ownership of the SerialPort specified by the given SerialPortAddress.