Skip to content
This repository has been archived by the owner on Nov 7, 2022. It is now read-only.

Fix doc tests and cargo doc warnings. #36

Merged
merged 2 commits into from
Mar 23, 2022
Merged

Fix doc tests and cargo doc warnings. #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9551b12
Fix doc-tests.
qwandor Mar 23, 2022
4fe5ccf
Fix cargo doc warnings.
qwandor Mar 23, 2022
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
7 changes: 5 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,10 @@
//!
//! ### Example
//!
//! Check out https://github.com/rust-embedded/rust-raspberrypi-OS-tutorials for usage examples.
//! Listed below is a snippet of `rust-raspberrypi-OS-tutorials`'s early boot code.
//! Check out
//! [rust-raspberrypi-OS-tutorials](https://github.com/rust-embedded/rust-raspberrypi-OS-tutorials)
//! for usage examples. Listed below is a snippet of `rust-raspberrypi-OS-tutorials`'s early boot
//! code.
//!
//! ```rust
//! use cortex_a::{asm, registers::*};
Expand Down Expand Up @@ -71,6 +73,7 @@
//! + SPSR_EL2::F::Masked
//! + SPSR_EL2::M::EL1h,
//! );
//! }
//! ```
//!
//! ## Disclaimer
Expand Down
14 changes: 7 additions & 7 deletions src/registers/hcr_el2.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ register_bitfields! {u64,
/// Traps are reported using EC syndrome value 0x09. The Pointer Authentication instructions
/// trapped are:
///
/// AUTDA, AUTDB, AUTDZA, AUTDZB, AUTIA, AUTIA1716, AUTIASP, AUTIAZ, AUTIB, AUTIB1716,
/// AUTIBSP, AUTIBZ, AUTIZA, AUTIZB, PACGA, PACDA, PACDB, PACDZA, PACDZB, PACIA,
/// PACIA1716, PACIASP, PACIAZ, PACIB, PACIB1716, PACIBSP, PACIBZ, PACIZA, PACIZB.
/// RETAA, RETAB, BRAA, BRAB, BLRAA, BLRAB, BRAAZ, BRABZ, BLRAAZ, BLRABZ.
/// ERETAA, ERETAB, LDRAA, and LDRAB.
/// `AUTDA`, `AUTDB`, `AUTDZA`, `AUTDZB`, `AUTIA`, `AUTIA1716`, `AUTIASP`, `AUTIAZ`, `AUTIB`, `AUTIB1716`,
/// `AUTIBSP`, `AUTIBZ`, `AUTIZA`, `AUTIZB`, `PACGA`, `PACDA`, `PACDB`, `PACDZA`, `PACDZB`, `PACIA`,
/// `PACIA1716`, `PACIASP`, `PACIAZ`, `PACIB`, `PACIB1716`, `PACIBSP`, `PACIBZ`, `PACIZA`, `PACIZB`,
/// `RETAA`, `RETAB`, `BRAA`, `BRAB`, `BLRAA`, `BLRAB`, `BRAAZ`, `BRABZ`, `BLRAAZ`, `BLRABZ`,
/// `ERETAA`, `ERETAB`, `LDRAA`, and `LDRAB`.
API OFFSET(41) NUMBITS(1) [
EnableTrapPointerAuthInstToEl2 = 0,
DisableTrapPointerAuthInstToEl2 = 1
Expand All @@ -41,8 +41,8 @@ register_bitfields! {u64,
/// following registers from EL1 to EL2, when EL2 is enabled in the current Security state,
/// reported using EC syndrome value 0x18:
///
/// APIAKeyLo_EL1, APIAKeyHi_EL1, APIBKeyLo_EL1, APIBKeyHi_EL1, APDAKeyLo_EL1,
/// APDAKeyHi_EL1, APDBKeyLo_EL1, APDBKeyHi_EL1, APGAKeyLo_EL1, and APGAKeyHi_EL1.
/// `APIAKeyLo_EL1`, `APIAKeyHi_EL1`, `APIBKeyLo_EL1`, `APIBKeyHi_EL1`, `APDAKeyLo_EL1`,
/// `APDAKeyHi_EL1`, `APDBKeyLo_EL1`, `APDBKeyHi_EL1`, `APGAKeyLo_EL1`, and `APGAKeyHi_EL1`.
APK OFFSET(40) NUMBITS(1) [
EnableTrapPointerAuthKeyRegsToEl2 = 0,
DisableTrapPointerAuthKeyRegsToEl2 = 1,
Expand Down
8 changes: 4 additions & 4 deletions src/registers/oslar_el1.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
//!
//! Used to lock or unlock the OS Lock.
//!
//! AArch64 System register OSLAR_EL1 bits [31:0] are architecturally mapped to External register
//! OSLAR_EL1[31:0]. The OS Lock can also be locked or unlocked using DBGOSLAR.
//! AArch64 System register `OSLAR_EL1` bits \[31:0\] are architecturally mapped to External
//! register `OSLAR_EL1[31:0]`. The OS Lock can also be locked or unlocked using `DBGOSLAR`.

use tock_registers::{
interfaces::{Readable, Writeable},
Expand All @@ -20,8 +20,8 @@ use tock_registers::{

register_bitfields! {u64,
pub OSLAR_EL1 [
/// On writes to OSLAR_EL1, bit[0] is copied to the OS Lock.
/// Use OSLSR_EL1.OSLK to check the current status of the lock.
/// On writes to `OSLAR_EL1`, bit[0] is copied to the OS Lock.
/// Use `OSLSR_EL1.OSLK` to check the current status of the lock.
OSLK OFFSET(0) NUMBITS(1) [
Unlocked = 0,
Locked = 1
Expand Down