Skip to contentSkip to conversation

firmware: rust: improve safety comments

PATCH New Danilo Krummrich 1 participant 3 messages Jun 19, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/3 firmware: rust: improve safety comments

Improve the wording of safety comments to be more explicit about what exactly is guaranteed to be valid.

---
 rust/kernel/firmware.rs | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)
rust/kernel/firmware.rs +6 -7
index b55ea1b45368..386c8fb44785 100644
@@ -22,8 +22,7 @@
 ///
 /// The pointer is valid, and has ownership over the instance of `struct firmware`.
 ///
-/// Once requested, the `Firmware` backing buffer is not modified until it is freed when `Firmware`
-/// is dropped.
+/// The `Firmware`'s backing buffer is not modified.
 ///
 /// # Examples
 ///
@@ -72,22 +71,22 @@ fn as_raw(&self) -> *mut bindings::firmware {
 
     /// Returns the size of the requested firmware in bytes.
     pub fn size(&self) -> usize {
-        // SAFETY: Safe by the type invariant.
+        // SAFETY: `self.as_raw()` is valid by the type invariant.
         unsafe { (*self.as_raw()).size }
     }
 
     /// Returns the requested firmware as `&[u8]`.
     pub fn data(&self) -> &[u8] {
-        // SAFETY: Safe by the type invariant. Additionally, `bindings::firmware` guarantees, if
-        // successfully requested, that `bindings::firmware::data` has a size of
-        // `bindings::firmware::size` bytes.
+        // SAFETY: `self.as_raw()` is valid by the type invariant. Additionally,
+        // `bindings::firmware` guarantees, if successfully requested, that
+        // `bindings::firmware::data` has a size of `bindings::firmware::size` bytes.
         unsafe { core::slice::from_raw_parts((*self.as_raw()).data, self.size()) }
     }
 }
 
 impl Drop for Firmware {
     fn drop(&mut self) {
-        // SAFETY: Safe by the type invariant.
+        // SAFETY: `self.as_raw()` is valid by the type invariant.
         unsafe { bindings::release_firmware(self.as_raw()) };
     }
 }

base-commit: de6582833db0e695ba0c548e3cc2ad7dbb6aa260

Signature · 1 line
2.45.1
#1 lore raw

PATCH 2/3 MAINTAINERS: add Rust FW abstractions to FIRMWARE LOADER

Add missing file path of the Rust abstractions to the maintainers entry, until we can move it to 'drivers/base/firmware_loader/'.

CC Luis Chamberlain <[email protected]>
CC Russ Weight <[email protected]>
CC Greg Kroah-Hartman <[email protected]>
---
 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)
MAINTAINERS +1 -0
index cf9c9221c388..38e7e0edd9b8 100644
@@ -8573,6 +8573,7 @@ L:	[email protected]
 S:	Maintained
 F:	Documentation/firmware_class/
 F:	drivers/base/firmware_loader/
+F:	rust/kernel/firmware.rs
 F:	include/linux/firmware.h
 
 FLEXTIMER FTM-QUADDEC DRIVER
Signature · 1 line
2.45.1
#2 lore raw

PATCH 3/3 MAINTAINERS: add Danilo as FIRMWARE LOADER maintainer

In reply to Danilo Krummrich

Add myself as firmware loader maintainer, as suggested by Luis in [1].

---
 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)
MAINTAINERS +1 -0
index 38e7e0edd9b8..19e4a21e574e 100644
@@ -8569,6 +8569,7 @@ F:	include/linux/arm_ffa.h
 FIRMWARE LOADER (request_firmware)
 M:	Luis Chamberlain <[email protected]>
 M:	Russ Weight <[email protected]>
+M:	Danilo Krummrich <[email protected]>
 L:	[email protected]
 S:	Maintained
 F:	Documentation/firmware_class/
Signature · 1 line
2.45.1