kernel::firmware

Struct Firmware

Source 
pub struct Firmware(/* private fields */);
Expand description

Abstraction around a C struct firmware.

This is a simple abstraction around the C firmware API. Just like with the C API, firmware can be requested. Once requested the abstraction provides direct access to the firmware buffer as &[u8]. The firmware is released once Firmware is dropped.

§Invariants

The pointer is valid, and has ownership over the instance of struct firmware.

The Firmware’s backing buffer is not modified.

§Examples



let fw = Firmware::request(c_str!("path/to/firmware.bin"), &dev)?;
let blob = fw.data();

Implementations§

Source§

impl Firmware

Source

pub fn request(name: &CStr, dev: &Device) -> Result<Self>

Send a firmware request and wait for it. See also bindings::request_firmware.

Source

pub fn request_nowarn(name: &CStr, dev: &Device) -> Result<Self>

Send a request for an optional firmware module. See also bindings::firmware_request_nowarn.

Source

pub fn size(&self) -> usize

Returns the size of the requested firmware in bytes.

Source

pub fn data(&self) -> &[u8]

Returns the requested firmware as &[u8].

Trait Implementations§

Source§

impl Drop for Firmware

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Firmware

Source§

impl Sync for Firmware

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, E> Init<T, E> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, E> PinInit<T, E> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.