Add safety comments to unsafe rom function

rp-rs · Nov 16, 2023 · 6cb7a11 · 6cb7a11
1 parent c69f4ce
commit 6cb7a11
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/rp2040-hal/src/rom_data.rs b/rp2040-hal/src/rom_data.rs
@@ -150,6 +150,11 @@ macro_rules! declare_rom_function {
         }
 
         $(#[$outer])*
+        /// # Safety
+        ///
+        /// This is a low-level C function. It may be difficult to call safely from
+        /// Rust. If in doubt, check the RP2040 datasheet for details and do your own
+        /// safety evaluation.
         pub unsafe extern "C" fn $name( $($argname: $ty),* ) -> $ret {
             $name::ptr()($($argname),*)
         }