Skip to contentSkip to conversation

rust: firmware: add Firmware::request_into_buf()

PATCH New Timur Tabi 1 participant 1 message Jun 4

Subsystems (2)
lore
Share & tools
lore

Timur Tabi

author
#0 lore raw

PATCH 1/8 rust: firmware: add Firmware::request_into_buf()

Add Firmware::request_into_buf(), a Rust wrapper around the C request_firmware_into_buf() function. This variant loads the firmware image directly into a caller-provided buffer rather than a kernel-allocated one.

---
 rust/kernel/firmware.rs | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
rust/kernel/firmware.rs +28 -0
index 71168d8004e2..d5130ce0fb4c 100644
@@ -94,6 +94,34 @@ pub fn request_nowarn(name: &CStr, dev: &Device) -> Result<Self> {
         Self::request_internal(name, dev, FwFunc::request_nowarn())
     }
 
+    /// Send a firmware request with a pre-allocated buffer. The firmware image is loaded directly
+    /// into `buf`. See also `bindings::request_firmware_into_buf`.
+    pub fn request_into_buf(name: &CStr, dev: &Device, buf: &mut [u8]) -> Result<Self> {
+        let mut fw: *mut bindings::firmware = core::ptr::null_mut();
+        let pfw: *mut *mut bindings::firmware = &mut fw;
+        let pfw: *mut *const bindings::firmware = pfw.cast();
+
+        // SAFETY: `pfw` is a valid pointer to a NULL initialized `bindings::firmware` pointer.
+        // `name` and `dev` are valid as by their type invariants. `buf` is a valid writable
+        // buffer of `buf.len()` bytes.
+        let ret = unsafe {
+            bindings::request_firmware_into_buf(
+                pfw,
+                name.as_char_ptr(),
+                dev.as_raw(),
+                buf.as_mut_ptr().cast(),
+                buf.len(),
+            )
+        };
+        if ret != 0 {
+            return Err(Error::from_errno(ret));
+        }
+
+        // SAFETY: `request_firmware_into_buf` not bailing out with a non-zero error code
+        // guarantees that `fw` is a valid pointer to `bindings::firmware`.
+        Ok(Firmware(unsafe { NonNull::new_unchecked(fw) }))
+    }
+
     fn as_raw(&self) -> *mut bindings::firmware {
         self.0.as_ptr()
     }

base-commit: fea3a2dd7d3fc1936211ced5f84420e610435730
prerequisite-patch-id: 8dc40be41df9e332a885e2f86d4d508f9b978d19

Signature · 1 line
2.54.0