Skip to content

Commit cc4332a

Browse files
GuilhermeGiacomoSimoesgregkh
authored andcommitted
rust: device: change the from_raw() function
The function Device::from_raw() increments a refcount by a call to bindings::get_device(ptr). This can be confused because usually from_raw() functions don't increment a refcount. Hence, rename Device::from_raw() to avoid confuion with other "from_raw" semantics. The new name of function should be "get_device" to be consistent with the function get_device() already exist in .c files. This function body also changed, because the `into()` will convert the `&'a Device` into `ARef<Device>` and also call `inc_ref` from the `AlwaysRefCounted` trait implemented for Device. Signed-off-by: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com> Acked-by: Danilo Krummrich <dakr@kernel.org> Closes: Rust-for-Linux#1088 Reviewed-by: Boqun Feng <boqun.feng@gmail.com> Link: https://lore.kernel.org/r/20241001205603.106278-1-trintaeoitogc@gmail.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent 9852d85 commit cc4332a

File tree

2 files changed

+4
-13
lines changed

2 files changed

+4
-13
lines changed

rust/kernel/device.rs

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,9 @@ impl Device {
5151
///
5252
/// It must also be ensured that `bindings::device::release` can be called from any thread.
5353
/// While not officially documented, this should be the case for any `struct device`.
54-
pub unsafe fn from_raw(ptr: *mut bindings::device) -> ARef<Self> {
55-
// SAFETY: By the safety requirements, ptr is valid.
56-
// Initially increase the reference count by one to compensate for the final decrement once
57-
// this newly created `ARef<Device>` instance is dropped.
58-
unsafe { bindings::get_device(ptr) };
59-
60-
// CAST: `Self` is a `repr(transparent)` wrapper around `bindings::device`.
61-
let ptr = ptr.cast::<Self>();
62-
63-
// SAFETY: `ptr` is valid by the safety requirements of this function. By the above call to
64-
// `bindings::get_device` we also own a reference to the underlying `struct device`.
65-
unsafe { ARef::from_raw(ptr::NonNull::new_unchecked(ptr)) }
54+
pub unsafe fn get_device(ptr: *mut bindings::device) -> ARef<Self> {
55+
// SAFETY: By the safety requirements ptr is valid
56+
unsafe { Self::as_ref(ptr) }.into()
6657
}
6758

6859
/// Obtain the raw `struct device *`.

rust/kernel/firmware.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ impl FwFunc {
4444
///
4545
/// # fn no_run() -> Result<(), Error> {
4646
/// # // SAFETY: *NOT* safe, just for the example to get an `ARef<Device>` instance
47-
/// # let dev = unsafe { Device::from_raw(core::ptr::null_mut()) };
47+
/// # let dev = unsafe { Device::get_device(core::ptr::null_mut()) };
4848
///
4949
/// let fw = Firmware::request(c_str!("path/to/firmware.bin"), &dev)?;
5050
/// let blob = fw.data();

0 commit comments

Comments
 (0)