uart_16550
Minimal support for serial communication through UART devices, which are compatible to the 16550 UART. This crate supports port-mapped and memory mapped UARTS.
Usage
Depending on the system architecture, the UART can be either accessed through port-mapped I/O or memory-mapped I/O.
With port-mappd I/O
The UART is accessed through port-mapped I/O on architectures such as x86_64
. On these architectures, the SerialPort
type can be used:
use SerialPort;
const SERIAL_IO_PORT: u16 = 0x3F8;
let mut serial_port = unsafe ;
serial_port.init;
// Now the serial port is ready to be used. To send a byte:
serial_port.send;
// To receive a byte:
let data = serial_port.receive;
With memory mapped serial port
Most other architectures, such as RISC-V, use memory-mapped I/O for accessing the UARTs. On these architectures, the MmioSerialPort
type can be used:
use MmioSerialPort;
const SERIAL_PORT_BASE_ADDRESS: usize = 0x1000_0000;
let mut serial_port = unsafe ;
serial_port.init;
// Now the serial port is ready to be used. To send a byte:
serial_port.send;
// To receive a byte:
let data = serial_port.receive;
Crate Feature Flags
nightly
: This is the default.stable
: Use this to build with non-nightly rust. Needsdefault-features = false
.
Building with stable rust
This needs to have the compile-time requirements of the cc
crate installed on your system.
It was currently only tested on Linux and MacOS.
License
Licensed under the MIT license (LICENSE or http://opensource.org/licenses/MIT).