TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / rust-spmc / arm-pl011-uart / b73935f77f607b568adc170f036c9e5cd6860113
commitb73935f77f607b568adc170f036c9e5cd6860113[log] [tgz]
authorAndrew Walbran <qwandor@google.com>Mon Feb 24 17:32:53 2025 +0000
committerBálint Dobszay <balint.dobszay@arm.com>Mon Feb 24 18:43:32 2025 +0100
treeb737e14c6c0d7e208787675b285653d07ae24cb3
parent11214b5e31c9d70778a13fb68367461ced8ec71e [diff]
Derive common traits for LineConfig and Identification.

Also made fields of Identification public, so users of the crate can
access them.

Change-Id: I34ee48f56435b4c66adde8a0d7fba00ada6eeb58
Signed-off-by: Andrew Walbran <qwandor@google.com>
1 file changed
tree: b737e14c6c0d7e208787675b285653d07ae24cb3
  1. src/
  2. .gitignore
  3. Cargo.lock
  4. Cargo.toml
  5. CHANGELOG.md
  6. dco.txt
  7. LICENSE-Apache-2.0
  8. LICENSE-MIT
  9. README.md
README.md

Arm PrimeCell UART (PL011) driver

Driver implementation for the PL011 UART peripheral.

The driver is designed to function regardless of whether a Memory Management Unit (MMU) is present. The primary role of the OwnedMmioPointer is to manage the lifetime of the peripheral, ensuring proper resource handling. In a system that includes an MMU, the peripheral's lifetime is dynamic because it is mapped into memory rather than having a fixed address. In a system without an MMU, the OwnedMmioPointer can be instantiated directly from the physical address of the register block, providing access to the peripheral without requiring memory mapping.

Implemented features

  • Enabling/disabling UART peripheral which includes configuring the data bit number, parity settings, stop bit count and baudrate
  • Checking various status flags
  • Non-blocking read/write functions
  • Handling UART errors
  • Reading UART identification structure
  • 98% unit test coverage
  • Setting FIFO level of RX/TX interrupts
  • Reading, masking and clearing interrupts
  • Implementing various traits
    • embedded_hal_nb::serial::{Write, Read} (optional, behind the embedded-hal-nb feature flag)
    • embedded_io::{Write, Read} (optional, behind the embedded-io feature flag)
    • core::fmt::Write

Feature flags

  • embedded-hal-nb: Adds implementations of embedded-hal-nb traits for the UART driver.
  • embedded-io: Adds implementations of embedded-io traits for the UART driver.

Future plans

  • Handling modem control and status signals
  • Adding peripheral testing

License

The project is MIT and Apache-2.0 dual licensed, see LICENSE-APACHE and LICENSE-MIT.

Maintainers

arm-pl011-uart is a trustedfirmware.org maintained project. All contributions are ultimately merged by the maintainers listed below.

Contributing

Please follow the directions of the Trusted Firmware Processes

Contributions are handled through review.trustedfirmware.org.

Reporting Security Issues

Please follow the directions of the Trusted Firmware Security Center

Copyright 2024 Arm Limited and/or its affiliates open-source-office@arm.com