Skip to content

CHANGELOG.md

Latest commit

 

History

History
192 lines (125 loc) · 6.16 KB

CHANGELOG.md

File metadata and controls

192 lines (125 loc) · 6.16 KB

CHANGELOG

Unreleased

0.6.0 - 2026-03-28

  • Rename Uart16550::try_send_bytes() to Uart16550::send_bytes()
  • Rename Uart16550::try_receive_bytes() to Uart16550::receive_bytes()
  • New public methods:
    • Uart16550::ready_to_receive()
    • Uart16550::ready_to_send()
  • Documentation improvements
  • Internal safety fixes (there was no UB, just making the internal code more robust)
  • Uart16550::new_mmio() and Uart16550Ttty::new_mmio() now accept a NonNull<u8> instead of a *mut u8. The recommended way to construct the MMIO address is to use: 
    fn main() {
  // External MMIO address.
  let mmio_address = ptr::with_exposed_provenance_mut::<u8>(0x1000);
  let mmio_address = NonNull::new(mmio_address).unwrap();
  let mut uart = unsafe { Uart16550::new_mmio(mmio_address, 4).unwrap() };
}

0.5.0 - 2026-03-20

  • Complete rewrite of the crate
  • The crate is by no means "minimalist" anymore. Now, uart_16550, is a simple yet highly configurable low-level driver for 16550 UART devices, typically known and used as serial ports or COM ports. Easy integration into Rust while providing fine-grained control where needed (e.g., for kernel drivers).
  • Changes were made to use this on real hardware
  • Common API for x86 port I/O and MMIO
  • 100% typed spec

We thank all past contributors. We've decided to completely rewrite the crate to clean up technical debt from the past, maintain the highest possible coding and API standards, and to make this crate ready for usage on real hardware, while keeping it easy to use in virtual machines.

Special Thanks

Special Thanks to Philipp Oppermann (@phil-opp) and Martin Kröning (@mkroening) for their very valuable review on the new crate!

Migration to v0.5.0

Old

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();

New (Minimalistic)

use uart_16550::{Config, Uart16550Tty};
use core::fmt::Write;

fn main() {
  // SAFETY: The address is valid and we have exclusive access.
  let mut uart = unsafe { Uart16550Tty::new_mmio(0x1000 as *mut _, 4, Config::default()).expect("should initialize device") };
  //                                    ^ or `new_port(0x3f8, Config::default())`
  uart.write_str("hello world\nhow's it going?");
}

New (More low-level control)

use uart_16550::{Config, Uart16550};

fn main() {
  // SAFETY: The address is valid and we have exclusive access.
  let mut uart = unsafe { Uart16550::new_mmio(0x1000 as *mut _, 4).expect("should be valid port") };
  //                                 ^ or `new_port(0x3f8)`
  uart.init(Config::default()).expect("should init device successfully");
  uart.test_loopback().expect("should have working loopback mode");
  uart.check_connected().expect("should have physically connected receiver");
  uart.send_bytes_exact(b"hello world!");
}

0.4.0 – 2025-07-24

0.3.2 – 2024-11-13

  • Add MmioSerialPort::new_with_stride function (#36)

0.3.1 – 2024-07-11

  • Add try_send_raw and try_receive (#34)
  • Update bitflags dependency to version 2 (#33)

0.3.0 – 2023-08-04

  • Internal rewrite of port operations to work on both x86 and x86_64 (#29)

0.2.19 – 2023-07-07

  • Make crate usable for 32-bit x86 (#28)

0.2.18 – 2022-04-16

  • Remove use of stable and nightly features (#24)

0.2.17 – 2022-03-28

  • Remove stabilized nightly feature 'const_ptr_offset' (#22)

0.2.16 – 2022-01-08

  • Add send_raw() function to allow sending arbitrary binary data using the serial port (#21)

0.2.15 – 2021-06-06

  • Add support for memory mapped UARTs (#15)
  • Improvements to new MMIO support (#18)

0.2.14 – 2021-05-14

  • SerialPort::new() no longer requires nightly feature (#16)

0.2.13 – 2021-04-30

  • Update x86_64 dependency and make it more robust (#14)

0.2.12 – 2021-02-02

  • Fix build on nightly by updating to x86_64 v0.13.2 (#12)

0.2.11 – 2021-01-15

  • Use stabilized hint::spin_loop instead of deprecated atomic::spin_loop_hint

0.2.10 – 2020-10-01

  • Fix default feature breakage (#11)

0.2.9 – 2020-09-29

  • Update x86_64 dependency to version 0.12.2

0.2.8 – 2020-09-24

  • Update x86_64 dependency to version 0.12.1

0.2.7

  • Update x86_64 dependency to version 0.11.0

0.2.6

  • Use spin_loop_hint while waiting for data (#9)
  • Update x86_64 dependency to version 0.10.2

0.2.5

  • Support receiving bytes from serial ports (#8)

0.2.4

  • Enable usage with non-nightly rust (#7)

0.2.3

  • Cargo.toml: update x86_64 dependency (#5)
  • Switch CI to GitHub Actions (#6)

0.2.2

  • Update internal x86_64 dependency to version 0.8.3 (#4)

0.2.1

  • Update to x86_64 0.7.3 and bitflags 1.1.0 (#1)
  • Document how serial port is configured by default (#2)