1 // SPDX-License-Identifier: GPL-2.0 2 3 //! Firmware abstraction 4 //! 5 //! C header: [`include/linux/firmware.h`](srctree/include/linux/firmware.h") 6 7 use crate::{bindings, device::Device, error::Error, error::Result, str::CStr}; 8 use core::ptr::NonNull; 9 10 // One of the following: `bindings::request_firmware`, `bindings::firmware_request_nowarn`, 11 // `firmware_request_platform`, `bindings::request_firmware_direct` 12 type FwFunc = 13 unsafe extern "C" fn(*mut *const bindings::firmware, *const i8, *mut bindings::device) -> i32; 14 15 /// Abstraction around a C `struct firmware`. 16 /// 17 /// This is a simple abstraction around the C firmware API. Just like with the C API, firmware can 18 /// be requested. Once requested the abstraction provides direct access to the firmware buffer as 19 /// `&[u8]`. The firmware is released once [`Firmware`] is dropped. 20 /// 21 /// # Invariants 22 /// 23 /// The pointer is valid, and has ownership over the instance of `struct firmware`. 24 /// 25 /// The `Firmware`'s backing buffer is not modified. 26 /// 27 /// # Examples 28 /// 29 /// ```no_run 30 /// # use kernel::{c_str, device::Device, firmware::Firmware}; 31 /// 32 /// # fn no_run() -> Result<(), Error> { 33 /// # // SAFETY: *NOT* safe, just for the example to get an `ARef<Device>` instance 34 /// # let dev = unsafe { Device::from_raw(core::ptr::null_mut()) }; 35 /// 36 /// let fw = Firmware::request(c_str!("path/to/firmware.bin"), &dev)?; 37 /// let blob = fw.data(); 38 /// 39 /// # Ok(()) 40 /// # } 41 /// ``` 42 pub struct Firmware(NonNull<bindings::firmware>); 43 44 impl Firmware { 45 fn request_internal(name: &CStr, dev: &Device, func: FwFunc) -> Result<Self> { 46 let mut fw: *mut bindings::firmware = core::ptr::null_mut(); 47 let pfw: *mut *mut bindings::firmware = &mut fw; 48 49 // SAFETY: `pfw` is a valid pointer to a NULL initialized `bindings::firmware` pointer. 50 // `name` and `dev` are valid as by their type invariants. 51 let ret = unsafe { func(pfw as _, name.as_char_ptr(), dev.as_raw()) }; 52 if ret != 0 { 53 return Err(Error::from_errno(ret)); 54 } 55 56 // SAFETY: `func` not bailing out with a non-zero error code, guarantees that `fw` is a 57 // valid pointer to `bindings::firmware`. 58 Ok(Firmware(unsafe { NonNull::new_unchecked(fw) })) 59 } 60 61 /// Send a firmware request and wait for it. See also `bindings::request_firmware`. 62 pub fn request(name: &CStr, dev: &Device) -> Result<Self> { 63 Self::request_internal(name, dev, bindings::request_firmware) 64 } 65 66 /// Send a request for an optional firmware module. See also 67 /// `bindings::firmware_request_nowarn`. 68 pub fn request_nowarn(name: &CStr, dev: &Device) -> Result<Self> { 69 Self::request_internal(name, dev, bindings::firmware_request_nowarn) 70 } 71 72 fn as_raw(&self) -> *mut bindings::firmware { 73 self.0.as_ptr() 74 } 75 76 /// Returns the size of the requested firmware in bytes. 77 pub fn size(&self) -> usize { 78 // SAFETY: `self.as_raw()` is valid by the type invariant. 79 unsafe { (*self.as_raw()).size } 80 } 81 82 /// Returns the requested firmware as `&[u8]`. 83 pub fn data(&self) -> &[u8] { 84 // SAFETY: `self.as_raw()` is valid by the type invariant. Additionally, 85 // `bindings::firmware` guarantees, if successfully requested, that 86 // `bindings::firmware::data` has a size of `bindings::firmware::size` bytes. 87 unsafe { core::slice::from_raw_parts((*self.as_raw()).data, self.size()) } 88 } 89 } 90 91 impl Drop for Firmware { 92 fn drop(&mut self) { 93 // SAFETY: `self.as_raw()` is valid by the type invariant. 94 unsafe { bindings::release_firmware(self.as_raw()) }; 95 } 96 } 97 98 // SAFETY: `Firmware` only holds a pointer to a C `struct firmware`, which is safe to be used from 99 // any thread. 100 unsafe impl Send for Firmware {} 101 102 // SAFETY: `Firmware` only holds a pointer to a C `struct firmware`, references to which are safe to 103 // be used from any thread. 104 unsafe impl Sync for Firmware {} 105