Struct imxrt_hal::gpio::GPIO

pub struct GPIO<P, D> { /* fields omitted */ }

Implementations

impl<P, D> GPIO<P, D> where
    P: Pin, 

pub fn is_fast(&self) -> bool

Returns true if the GPIO is configured for fast mode

If the GPIO cannot support fast mode, is_fast() always returns false

pub fn set_fast(&mut self, fast: bool) -> bool

Configures the GPIO to fast mode. true indicates “fast,” and false indicates “normal.”

Returns false if this pin does not support fast mode. Otherwise, returns true, indicating that the setting was respected.

If you transition an output pin into fast mode, the GPIO output state may not be maintained. That is, if your GPIO pin was high, a transition into fast mode may set the pin low. Consider setting fast mode before driving the GPIO output to avoid inconsistencies.

impl<P> GPIO<P, Input> where
    P: Pin, 

pub fn new(pin: P) -> Self

Create a GPIO from a pad that supports a GPIO configuration

All pads may be used as a GPIO, so this should always work.

pub fn output(self) -> GPIO<P, Output>

Set the GPIO as an output.

Any interrupt configuration will be cleared and needs redoing if the pin is transitioned back to an input.

pub fn is_set(&self) -> bool

Returns true if this input pin is high

impl<P> GPIO<P, Input> where
    P: Pin, 

pub fn set_interrupt_enable(&mut self, enable: bool)

Enable (true) or disable (false) interrupts for this GPIO input.

pub fn is_interrupt_enabled(&self) -> bool

Indicates if interrupts are (true) or are not (false) enabled for this GPIO input.

pub fn set_interrupt_configuration(
    &mut self,
    interrupt_configuration: InterruptConfiguration
)

Set the interrupt configuration for this GPIO input.

pub fn is_interrupt_status(&self) -> bool

Indicates whether this GPIO input triggered an interrupt.

pub fn clear_interrupt_status(&mut self)

Clear the interrupt status flag.

impl<P> GPIO<P, Output> where
    P: Pin, 

pub fn input(self) -> GPIO<P, Input>

Transition the pin back to an input

pub fn set(&mut self)

Set the GPIO high

pub fn clear(&mut self)

Set the GPIO low

pub fn is_set(&self) -> bool

Returns true if the pin is high

pub fn toggle(&mut self)

Alternate the state of the pin

Trait Implementations

impl<P> InputPin for GPIO<P, Input> where
    P: Pin, 

type Error = Infallible

Error type

fn is_high(&self) -> Result<bool, Self::Error>

Is the input pin high?

fn is_low(&self) -> Result<bool, Self::Error>

Is the input pin low?

impl<P> OutputPin for GPIO<P, Output> where
    P: Pin, 

type Error = Infallible

Error type

fn set_high(&mut self) -> Result<(), Self::Error>

Drives the pin high

fn set_low(&mut self) -> Result<(), Self::Error>

Drives the pin low

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value

impl<P> StatefulOutputPin for GPIO<P, Output> where
    P: Pin, 

fn is_set_high(&self) -> Result<bool, Self::Error>

Is the pin in drive high mode?

fn is_set_low(&self) -> Result<bool, Self::Error>

Is the pin in drive low mode?

impl<P> ToggleableOutputPin for GPIO<P, Output> where
    P: Pin, 

type Error = Infallible

Error type

fn toggle(&mut self) -> Result<(), Self::Error>

Toggle pin output.