alex/rp-hal-boards
1
0
Fork 0
mirror of https://github.com/italicsjenga/rp-hal-boards.git synced 2024-12-24 05:01:31 +11:00
Code Issues Packages Projects Releases Wiki Activity

Add safety docs from atsamd-rs to GPIO traits

Browse source
This commit is contained in:
9names 2021-12-03 21:47:29 +11:00
parent 5dafe3985f
commit a7d5dc2bee
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
rp2040-hal/src/gpio/reg.rs
View file

@ -109,6 +109,13 @@ impl From<DynPinMode> for ModeFields {
fields
}
}
/// # Safety
///
/// Users should only implement the [`id`] function. No default function
/// implementations should be overridden. The implementing type must also have
/// "control" over the corresponding pin ID, i.e. it must guarantee that each
/// pin ID is a singleton
pub(super) unsafe trait RegisterInterface {
/// Provide a [`DynPinId`] identifying the set of registers controlled by
/// this type.

7
rp2040-hal/src/pwm/reg.rs
View file

@ -1,5 +1,12 @@
use super::dyn_slice::{DynSliceId, DynSliceMode};
use pac::pwm::CH;
/// # Safety
///
/// Users should only implement the [`id`] function. No default function
/// implementations should be overridden. The implementing type must also have
/// "control" over the corresponding slice ID, i.e. it must guarantee that each
/// slice ID is a singleton
pub(super) unsafe trait RegisterInterface {
/// Provide a [`DynSliceId`] identifying the set of registers controlled by
/// this type.