Struct kernel::gpio::Registration

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

A registration of a gpio chip.

Examples

The following example registers an empty gpio chip.

use kernel::{
    device::RawDevice,
    gpio::{self, Registration},
};

struct MyGpioChip;
#[vtable]
impl gpio::Chip for MyGpioChip {
    type Data = ();
}

fn example(parent: &dyn RawDevice) -> Result<Pin<Box<Registration<MyGpioChip>>>> {
    let mut r = Pin::from(Box::try_new(Registration::new())?);
    kernel::gpio_chip_register!(r.as_mut(), 32, None, parent, ())?;
    Ok(r)
}

Implementations

impl<T: Chip> Registration<T>

pub fn new() -> Self

Creates a new Registration but does not register it yet.

It is allowed to move.

pub fn register(
    self: Pin<&mut Self>,
    gpio_count: u16,
    base: Option<i32>,
    parent: &dyn RawDevice,
    data: T::Data,
    lock_keys: [&'static LockClassKey; 2]
) -> Result

Registers a gpio chip with the rest of the kernel.

Users are encouraged to use the gpio_chip_register macro because it automatically defines the lock classes and calls the registration function.

Trait Implementations

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

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

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

impl<T: Chip> Send for Registration<T>

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