aboutsummaryrefslogtreecommitdiff
path: root/rust/hw/char/pl011/README.md
blob: cd7dea31634241cbf96b0be13f21d52bbd8ae750 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# PL011 QEMU Device Model

This library implements a device model for the PrimeCell® UART (PL011)
device in QEMU.

## Build static lib

Host build target must be explicitly specified:

```sh
cargo build --target x86_64-unknown-linux-gnu
```

Replace host target triplet if necessary.

## Generate Rust documentation

To generate docs for this crate, including private items:

```sh
cargo doc --no-deps --document-private-items --target x86_64-unknown-linux-gnu
```

To include direct dependencies like `bilge` (bitmaps for register types):

```sh
cargo tree --depth 1 -e normal --prefix none \
 | cut -d' ' -f1 \
 | xargs printf -- '-p %s\n' \
 | xargs cargo doc --no-deps --document-private-items --target x86_64-unknown-linux-gnu
```