Struct LiteXGPIOPin

pub struct LiteXGPIOPin<'controller, 'client, R: LiteXSoCRegisterConfiguration> { /* private fields */ }

Single GPIO pin of a LiteXGPIOController

Can be obtained by calling LiteXGPIOController::get_gpio_pin.

Only one LiteXGPIOPin instance may exist per GPIO pin. To deregister this instance, call LiteXGPIOPin::destroy (or drop it).

Implementations

impl<'controller, 'client, R: LiteXSoCRegisterConfiguration> LiteXGPIOPin<'controller, 'client, R>

pub fn index(&self) -> usize

Index of this GPIO pin in the LiteXGPIOController GPIO array

pub fn controller(&self) -> &'controller LiteXGPIOController<'client, R>

Returns a reference to the LiteXGPIOController of this GPIO

pub fn destroy(self)

Destroy (deregister & consume) the LiteXGPIOPin

Trait Implementations

impl<R: LiteXSoCRegisterConfiguration> Configure for LiteXGPIOPin<'_, '_, R>

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<R: LiteXSoCRegisterConfiguration> Drop for LiteXGPIOPin<'_, '_, R>

fn drop(&mut self)

Deregister the GPIO with the controller

impl<R: LiteXSoCRegisterConfiguration> Input for LiteXGPIOPin<'_, '_, R>

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<'client, R: LiteXSoCRegisterConfiguration> Interrupt<'client> for LiteXGPIOPin<'_, 'client, R>

fn set_client(&self, client: &'client dyn Client)

Set the client for interrupt events.

fn is_pending(&self) -> bool

Return whether this interrupt is pending

fn enable_interrupts(&self, mode: InterruptEdge)

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.

fn disable_interrupts(&self)

Disable interrupts for the GPIO pin.

impl<R: LiteXSoCRegisterConfiguration> Output for LiteXGPIOPin<'_, '_, R>

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.