Skip to content

Commit 0a28a1b

Browse files
committed
Add safety comments to unsafe rom function
1 parent f91f1bb commit 0a28a1b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

rp2040-hal/src/rom_data.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,11 @@ macro_rules! declare_rom_function {
150150
}
151151

152152
$(#[$outer])*
153+
/// # Safety
154+
///
155+
/// This is a low-level C function. It may be difficult to call safely from
156+
/// Rust. If in doubt, check the RP2040 datasheet for details and do your own
157+
/// safety evaluation.
153158
pub unsafe extern "C" fn $name( $($argname: $ty),* ) -> $ret {
154159
$name::ptr()($($argname),*)
155160
}

0 commit comments

Comments
 (0)