Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-21 19:41:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

firmware: rust: improve safety comments

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

Suggested-by: Benno Lossin <benno.lossin@proton.me>
Signed-off-by: Danilo Krummrich <dakr@redhat.com>
Link: https://lore.kernel.org/r/20240619132029.59296-1-dakr@redhat.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Danilo Krummrich 2024-06-19 15:20:12 +02:00 committed by Greg Kroah-Hartman
parent 269e974e66
commit bbe98f4fde
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
rust/kernel/firmware.rs
View File

@ -22,8 +22,7 @@ type FwFunc =
///
/// 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 @@ impl 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()) };
}
}