Struct kernel::hil::gpio::InterruptValueWrapper

pub struct InterruptValueWrapper<'a, IP: InterruptPin<'a>> { /* private fields */ }

Standard implementation of InterruptWithValue: handles an gpio::Client::fired and passes it up as a gpio::ClientWithValue::fired.

Implementations

impl<'a, IP: InterruptPin<'a>> InterruptValueWrapper<'a, IP>

pub fn new(pin: &'a IP) -> Self

pub fn finalize(&'static self) -> &'static Self

Trait Implementations

impl<'a, IP: InterruptPin<'a>> Client for InterruptValueWrapper<'a, IP>

fn fired(&self)

Called when an interrupt occurs. The identifier will be the same value that was passed to enable_interrupt() when the interrupt was configured.

impl<'a, IP: InterruptPin<'a>> Configure for InterruptValueWrapper<'a, IP>

fn configuration(&self) -> Configuration

Return the current pin configuration.

fn make_output(&self) -> Configuration

Make the pin an output, returning the current configuration, which should be either Configuration::Output or Configuration::InputOutput.

fn disable_output(&self) -> Configuration

Disable the pin as an output, returning the current configuration.

fn make_input(&self) -> Configuration

Make the pin an input, returning the current configuration, which should be ither Configuration::Input or Configuration::InputOutput.

fn disable_input(&self) -> Configuration

Disable the pin as an input, returning the current configuration.

fn deactivate_to_low_power(&self)

Put a pin into its lowest power state, with no guarantees on if it is enabled or not. Implementations are free to use any state (e.g. input, output, disable, etc.) the hardware pin supports to ensure the pin is as low power as possible. Re-enabling the pin requires reconfiguring it (i.e. the state of its enabled configuration is not stored).

fn set_floating_state(&self, state: FloatingState)

Set the floating state of the pin.

fn floating_state(&self) -> FloatingState

Return the current floating state of the pin.

fn is_input(&self) -> bool

Return whether the pin is an input (reading from the Input trait will return valid results). Returns true if the pin is in Configuration::Input or Configuration::InputOutput.

fn is_output(&self) -> bool

Return whether the pin is an output (writing to the Output trait will change the output of the pin). Returns true if the pin is in Configuration::Output or Configuration::InputOutput.

impl<'a, IP: InterruptPin<'a>> Input for InterruptValueWrapper<'a, IP>

fn read(&self) -> bool

Get the current state of an input GPIO pin. For an output pin, return the output; for an input pin, return the input; for disabled or function pins the value is undefined.

fn read_activation(&self, mode: ActivationMode) -> ActivationState

Get the current state of a GPIO pin, for a given activation mode.

impl<'a, IP: InterruptPin<'a>> InterruptWithValue<'a> for InterruptValueWrapper<'a, IP>

fn set_value(&self, value: u32)

Set the value that will be passed to clients on an interrupt.

fn value(&self) -> u32

Return the value that is passed to clients on an interrupt.

fn set_client(&self, client: &'a dyn ClientWithValue)

Set the client for interrupt events.

fn is_pending(&self) -> bool

Return whether this interrupt is pending

fn enable_interrupts(&self, edge: InterruptEdge) -> Result<(), ErrorCode>

Enable an interrupt on the GPIO pin. This does not configure the pin except to enable an interrupt: it should be separately configured as an input, etc. Returns: Ok(()) - the interrupt was set up properly FAIL - the interrupt was not set up properly; this is due to not having an underlying interrupt source yet, i.e. the struct is not yet fully initialized.

fn disable_interrupts(&self)

Disable interrupts for the GPIO pin.

impl<'a, IP: InterruptPin<'a>> Output for InterruptValueWrapper<'a, IP>

fn set(&self)

Set the GPIO pin high. If the pin is not an output or input/output, this call is ignored.

fn clear(&self)

Set the GPIO pin low. If the pin is not an output or input/output, this call is ignored.

fn toggle(&self) -> bool

Toggle the GPIO pin. If the pin was high, set it low. If the pin was low, set it high. If the pin is not an output or input/output, this call is ignored. Return the new value of the pin.

fn write_activation(&self, state: ActivationState, mode: ActivationMode)

Activate or deactivate a GPIO pin, for a given activation mode.