Merge pull request #44 from wedsonaf/miscdev

Add support for registering misc devices

Author: alex

drivers/char/rust_example/src/lib.rs

@@ -3,7 +3,12 @@
 #![no_std]
 #![feature(global_asm)]
 
+extern crate alloc;
+
+use alloc::boxed::Box;
+use core::pin::Pin;
 use kernel::prelude::*;
+use kernel::{cstr, file_operations::FileOperations, miscdev};
 
 module! {
     type: RustExample,
@@ -25,8 +30,18 @@ module! {
     },
 }
 
+struct RustFile;
+
+impl FileOperations for RustFile {
+    fn open() -> KernelResult<Self> {
+        println!("rust file was opened!");
+        Ok(Self)
+    }
+}
+
 struct RustExample {
     message: String,
+    _dev: Pin<Box<miscdev::Registration>>,
 }
 
 impl KernelModule for RustExample {
@@ -36,8 +51,10 @@ impl KernelModule for RustExample {
         println!("Parameters:");
         println!("  my_bool:  {}", my_bool.read());
         println!("  my_i32:   {}", my_i32.read());
+
         Ok(RustExample {
             message: "on the heap!".to_owned(),
+            _dev: miscdev::Registration::new_pinned::<RustFile>(cstr!("rust_miscdev"), None)?,
         })
     }
 }

rust/kernel/src/bindings_helper.h

@@ -8,6 +8,7 @@
 #include <linux/sysctl.h>
 #include <linux/uaccess.h>
 #include <linux/version.h>
+#include <linux/miscdevice.h>
 
 // bindgen gets confused at certain things
 const gfp_t BINDINGS_GFP_KERNEL = GFP_KERNEL;

rust/kernel/src/lib.rs

@@ -25,6 +25,7 @@ pub mod c_types;
 pub mod chrdev;
 mod error;
 pub mod file_operations;
+pub mod miscdev;
 pub mod prelude;
 pub mod printk;
 pub mod random;

rust/kernel/src/miscdev.rs

@@ -0,0 +1,78 @@
+// SPDX-License-Identifier: GPL-2.0
+
+use crate::error::{Error, KernelResult};
+use crate::file_operations::{FileOperations, FileOperationsVtable};
+use crate::{bindings, c_types, CStr};
+use alloc::boxed::Box;
+use core::marker::PhantomPinned;
+use core::pin::Pin;
+
+/// A registration of a misc device.
+pub struct Registration {
+    mdev: Option<bindings::miscdevice>,
+    _pin: PhantomPinned,
+}
+
+impl Registration {
+    /// Initialises a new registration but does not register it yet. It is allowed to move.
+    pub fn new() -> Self {
+        Self {
+            mdev: None,
+            _pin: PhantomPinned,
+        }
+    }
+
+    /// Registers a new misc device. On success, it returns a pinned heap-allocated representation
+    /// of the registration.
+    pub fn new_pinned<T: FileOperations>(
+        name: CStr<'static>,
+        minor: Option<i32>,
+    ) -> KernelResult<Pin<Box<Self>>> {
+        let mut r = crate::try_alloc_pinned(Self::new())?;
+        r.as_mut().register::<T>(name, minor)?;
+        Ok(r)
+    }
+
+    /// Attempts to actually register the misc device with the rest of the kernel. It must be
+    /// pinned because the memory block that represents the registration is self-referential. If a
+    /// minor is not given, the kernel allocates a new one if possible.
+    pub fn register<T: FileOperations>(
+        self: Pin<&mut Self>,
+        name: CStr<'static>,
+        minor: Option<i32>,
+    ) -> KernelResult<()> {
+        // SAFETY: we must ensure that we never move out of `this`.
+        let this = unsafe { self.get_unchecked_mut() };
+        if this.mdev.is_some() {
+            // Already registered.
+            return Err(Error::EINVAL);
+        }
+
+        this.mdev = Some(bindings::miscdevice::default());
+        let dev = this.mdev.as_mut().unwrap();
+        dev.fops = &FileOperationsVtable::<T>::VTABLE;
+        dev.name = name.as_ptr() as *const c_types::c_char;
+        dev.minor = minor.unwrap_or(bindings::MISC_DYNAMIC_MINOR as i32);
+        let ret = unsafe { bindings::misc_register(dev) };
+        if ret < 0 {
+            this.mdev = None;
+            return Err(Error::from_kernel_errno(ret));
+        }
+        Ok(())
+    }
+}
+
+// SAFETY: The only method is `register`, which requires a (pinned) mutable `Registration`, so it
+// is safe to pass `&Registration` to multiple threads because it offers no interior mutability.
+unsafe impl Sync for Registration {}
+
+impl Drop for Registration {
+    /// Removes the registration from the kernel if it has completed successfully before.
+    fn drop(&mut self) {
+        if let Some(ref mut dev) = self.mdev {
+            unsafe {
+                bindings::misc_deregister(dev);
+            }
+        }
+    }
+}