Skip to contentSkip to conversation

rust/faux: Add missing parent argument to Registration::new()

PATCH In review Lyude Paul 2 participants 2 messages Feb 27, 2025 – Feb 28, 2025

Subsystems (2)
lore
Share & tools
lore

Lyude Paul

author
#0 lore raw

PATCH v2 1/1 rust/faux: Add missing parent argument to Registration::new()

A little late in the review of the faux device interface, we added the ability to specify a parent device when creating new faux devices - but this never got ported over to the rust bindings. So, let's add the missing argument now so we don't have to convert other users later down the line.

Cc Greg Kroah-Hartman <[email protected]>

---
V2:
- Add SAFETY comment about parent

 rust/kernel/faux.rs              | 13 +++++++++++--
 samples/rust/rust_driver_faux.rs |  2 +-
 2 files changed, 12 insertions(+), 3 deletions(-)
rust/kernel/faux.rs +11 -2
index 41751403cd868..3277f35c3f79b 100644
@@ -23,11 +23,20 @@
 
 impl Registration {
     /// Create and register a new faux device with the given name.
-    pub fn new(name: &CStr) -> Result<Self> {
+    pub fn new(name: &CStr, parent: Option<&device::Device>) -> Result<Self> {
         // SAFETY:
         // - `name` is copied by this function into its own storage
         // - `faux_ops` is safe to leave NULL according to the C API
-        let dev = unsafe { bindings::faux_device_create(name.as_char_ptr(), null_mut(), null()) };
+        // - `parent` can be either NULL or a pointer to a `struct device`, and `faux_device_create`
+        //   will take a reference to `parent` using `device_add` - ensuring that it remains valid
+        //   for the lifetime of the faux device.
+        let dev = unsafe {
+            bindings::faux_device_create(
+                name.as_char_ptr(),
+                parent.map_or(null_mut(), |p| p.as_raw()),
+                null(),
+            )
+        };
 
         // The above function will return either a valid device, or NULL on failure
         // INVARIANT: The device will remain registered until faux_device_destroy() is called, which
samples/rust/rust_driver_faux.rs +1 -1
index 048c6cb98b29a..58a3a94121bff 100644
@@ -20,7 +20,7 @@ impl Module for SampleModule {
     fn init(_module: &'static ThisModule) -> Result<Self> {
         pr_info!("Initialising Rust Faux Device Sample\n");
 
-        let reg = faux::Registration::new(c_str!("rust-faux-sample-device"))?;
+        let reg = faux::Registration::new(c_str!("rust-faux-sample-device"), None)?;
 
         dev_info!(reg.as_ref(), "Hello from faux device!\n");
 

base-commit: be5c7bbb3a64baf884481a1ba0c2f8fb2f93f7c3
prerequisite-patch-id: 9fdd77ac551de34c26f3910137354e21e04d85e0

Signature · 1 line
2.48.1
reviewer Reviewed-by on v2 1/1
#1 lore raw
Quoted 8 lines · Lyude Paul

A little late in the review of the faux device interface, we added the ability to specify a parent device when creating new faux devices - but this never got ported over to the rust bindings. So, let's add the missing argument now so we don't have to convert other users later down the line.

Cc Greg Kroah-Hartman <[email protected]>