22 releases

0.3.0 Aug 4, 2023
0.2.19 Jul 7, 2023
0.2.18 Apr 16, 2022
0.2.17 Mar 28, 2022
0.1.0 May 21, 2018

#80 in Hardware support

Download history 3239/week @ 2023-12-06 3804/week @ 2023-12-13 3545/week @ 2023-12-20 2654/week @ 2023-12-27 3986/week @ 2024-01-03 4075/week @ 2024-01-10 4342/week @ 2024-01-17 3936/week @ 2024-01-24 3759/week @ 2024-01-31 4992/week @ 2024-02-07 5216/week @ 2024-02-14 4526/week @ 2024-02-21 5033/week @ 2024-02-28 5715/week @ 2024-03-06 5313/week @ 2024-03-13 5115/week @ 2024-03-20

22,096 downloads per month
Used in 18 crates (16 directly)

MIT license

16KB
196 lines

uart_16550

Build Status Docs.rs Badge

Minimal support for serial communication through UART devices, which are compatible to the 16550 UART. This crate supports I/O port-mapped (x86 only) 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 uart_16550::SerialPort;

const SERIAL_IO_PORT: u16 = 0x3F8;

let mut serial_port = unsafe { SerialPort::new(SERIAL_IO_PORT) };
serial_port.init();

// Now the serial port is ready to be used. To send a byte:
serial_port.send(42);

// 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 uart_16550::MmioSerialPort;

const SERIAL_PORT_BASE_ADDRESS: usize = 0x1000_0000;

let mut serial_port = unsafe { MmioSerialPort::new(SERIAL_PORT_BASE_ADDRESS) };
serial_port.init();

// Now the serial port is ready to be used. To send a byte:
serial_port.send(42);

// To receive a byte:
let data = serial_port.receive();

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).

Dependencies

~2.5MB
~19K SLoC