Struct kernel::miscdev::Registration

pub struct Registration<T: Operations> { /* private fields */ }

A registration of a miscellaneous device.

Invariants

Context is always initialised when registered is true, and not initialised otherwise.

Implementations

impl<T: Operations> Registration<T>

pub fn new() -> Self

Creates a new Registration but does not register it yet.

It is allowed to move.

pub fn new_pinned(
    name: Arguments<'_>,
    open_data: T::OpenData
) -> Result<Pin<Box<Self>>>

Registers a miscellaneous device.

Returns a pinned heap-allocated representation of the registration.

pub fn register(
    self: Pin<&mut Self>,
    name: Arguments<'_>,
    open_data: T::OpenData
) -> Result

Registers a miscellaneous device with the rest of the kernel.

It must be pinned because the memory block that represents the registration is self-referential.

pub fn register_with_options(
    self: Pin<&mut Self>,
    name: Arguments<'_>,
    open_data: T::OpenData,
    opts: &Options<'_>
) -> Result

Registers a miscellaneous device with the rest of the kernel. Additional optional settings are provided via the opts parameter.

It must be pinned because the memory block that represents the registration is self-referential.

Trait Implementations

impl<T: Operations> Default for Registration<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Operations> Drop for Registration<T>

fn drop(&mut self)

Removes the registration from the kernel if it has completed successfully before.

impl<T: Operations> OpenAdapter<<T as Operations>::OpenData> for Registration<T>

unsafe fn convert(_inode: *mut inode, file: *mut file) -> *const T::OpenData

Converts untyped data stored in [struct inode] and [struct file] (when [struct file_operations::open] is called) into the given type. For example, for miscdev devices, a pointer to the registered [struct miscdev] is stored in [struct file::private_data].

impl<T: Operations> Send for Registration<T> where
    T::OpenData: Send, 

impl<T: Operations> Sync for Registration<T>