Skip to content

Deprecate in favour of arm-pl011-uart. #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
qwandor merged 1 commit into from
May 20, 2025
Merged

Deprecate in favour of arm-pl011-uart. #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 0.2.0

Deprecated in favour of `arm-pl011-uart` crate.

## 0.1.0

Initial release.
7 changes: 1 addition & 6 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "pl011-uart"
version = "0.1.0"
version = "0.2.0"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "A driver for the Arm PL011 UART."
Expand All @@ -12,8 +12,3 @@ repository = "https://github.com/google/pl011-uart"
keywords = ["arm", "aarch64", "driver", "uart", "pl011"]
categories = ["embedded", "no-std", "hardware-support"]
rust-version = "1.82"

[dependencies]
bitflags = "2.3.2"
embedded-io = "0.6.1"
thiserror = { version = "2.0.3", default-features = false }
31 changes: 2 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,11 @@
[![crates.io page](https://img.shields.io/crates/v/pl011-uart.svg)](https://crates.io/crates/pl011-uart)
[![docs.rs page](https://docs.rs/pl011-uart/badge.svg)](https://docs.rs/pl011-uart)

A Rust driver for the Arm [PL011 UART](https://developer.arm.com/documentation/ddi0183/latest/).
This crate is deprecated. Please use
[`arm-pl011-uart`](https://crates.io/crates/arm-pl011-uart) instead.

This is not an officially supported Google product.

## Usage

Basic usage of the pl011-uart crate

```rust
use pl011_uart::Uart;
use core::fmt::Write;

fn main() {
// constants required for initializing the UART.
const PL011_BASE_ADDRESS: *mut u32 = 0x0900_0000 as _;
const PL011_BAUD_RATE: u32 = 115200;
const PL011_CLK_IN_HZ: u32 = 50000000;

// initialize PL011 UART.
let mut uart = unsafe { Uart::new(PL011_BASE_ADDRESS) };
uart.init(PL011_CLK_IN_HZ, PL011_BAUD_RATE);

// write to PL011 UART.
writeln!(uart, "Hello, World!").unwrap();
}
```

## License

Licensed under either of
Expand All @@ -40,8 +18,3 @@ Licensed under either of
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contributing

If you want to contribute to the project, see details of
[how we accept contributions](CONTRIBUTING.md).
Loading
Loading