Struct rp2040_hal::gpio::pin::Pin

source · [−]

pub struct Pin<I, M> where
    I: PinId,
    M: PinMode + ValidPinMode<I>,  { /* private fields */ }

Expand description

A type-level GPIO pin, parameterized by PinId and PinMode types

Implementations

source

impl<I, M> Pin<I, M> where
I: PinId,
M: PinMode + ValidPinMode,

source

pub fn into_mode<N: PinMode + ValidPinMode>(self) -> Pin<I, N>

Convert the pin to the requested PinMode

source

pub fn into_floating_disabled(self) -> Pin<I, FloatingDisabled>

Disable the pin and set it to float

source

pub fn into_pull_down_disabled(self) -> Pin<I, PullDownDisabled>

Disable the pin and set it to pull down

source

pub fn into_pull_up_disabled(self) -> Pin<I, PullUpDisabled>

Disable the pin and set it to pull up

source

pub fn into_floating_input(self) -> Pin<I, FloatingInput>

Configure the pin to operate as a floating input

source

pub fn into_pull_down_input(self) -> Pin<I, PullDownInput>

Configure the pin to operate as a pulled down input

source

pub fn into_pull_up_input(self) -> Pin<I, PullUpInput>

Configure the pin to operate as a pulled up input

source

pub fn into_bus_keep_input(self) -> Pin<I, BusKeepInput>

Configure the pin to operate as a bus keep input

source

pub fn into_push_pull_output(self) -> Pin<I, PushPullOutput>

Configure the pin to operate as a push-pull output

source

pub fn into_readable_output(self) -> Pin<I, ReadableOutput>

Configure the pin to operate as a readable push pull output

source

pub fn get_drive_strength(&self) -> OutputDriveStrength

Read the current drive strength of the pin.

source

pub fn set_drive_strength(&mut self, strength: OutputDriveStrength)

Set the drive strength for the pin.

source

pub fn get_slew_rate(&self) -> OutputSlewRate

Get the slew rate for the pin.

source

pub fn set_slew_rate(&mut self, rate: OutputSlewRate)

Set the slew rate for the pin.

source

pub fn clear_interrupt(&mut self, interrupt: Interrupt)

Clear interrupt.

source

pub fn interrupt_status(&self, interrupt: Interrupt) -> bool

Interrupt status.

source

pub fn is_interrupt_enabled(&self, interrupt: Interrupt) -> bool

Is interrupt enabled.

source

pub fn set_interrupt_enabled(&self, interrupt: Interrupt, enabled: bool)

Enable or disable interrupt.

source

pub fn is_interrupt_forced(&self, interrupt: Interrupt) -> bool

Is interrupt forced.

source

pub fn set_interrupt_forced(&self, interrupt: Interrupt, forced: bool)

Force or release interrupt.

source

pub fn set_interrupt_override(&mut self, override_value: InterruptOverride)

Set the interrupt override.

source

pub fn set_input_override(&mut self, override_value: InputOverride)

Set the input override.

source

pub fn set_output_enable_override(
&mut self,
override_value: OutputEnableOverride
)

Set the output enable override.

source

pub fn set_output_override(&mut self, override_value: OutputOverride)

Set the output override.

Trait Implementations

source

impl<I, M> AnyPin for Pin<I, M> where
I: PinId,
M: PinMode + ValidPinMode,

type Id = I

PinId of the corresponding Pin

type Mode = M

PinMode of the corresponding Pin

source

impl Channel<Adc> for Pin<Gpio26, FloatingInput>

type ID = u8

Channel ID type Read more

source

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8. Read more

source

impl Channel<Adc> for Pin<Gpio27, FloatingInput>

type ID = u8

Channel ID type Read more

source

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8. Read more

source

impl Channel<Adc> for Pin<Gpio28, FloatingInput>

type ID = u8

Channel ID type Read more

source

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8. Read more

source

impl Channel<Adc> for Pin<Gpio29, FloatingInput>

type ID = u8

Channel ID type Read more

source

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8. Read more

source

impl ClockSource for Pin<Gpio20, FunctionClock>

source

fn get_freq(&self) -> Hertz

Get the operating frequency for this source Read more

source

impl ClockSource for Pin<Gpio22, FunctionClock>

source

fn get_freq(&self) -> Hertz

Get the operating frequency for this source Read more

source

impl<I, M> From<Pin<I, M>> for DynPin where
I: PinId,
M: PinMode + ValidPinMode,

source

fn from(_pin: Pin<I, M>) -> Self

Erase the type-level information in a Pin and return a value-level DynPin

source

impl InputPin for Pin<I, ReadableOutput> where
I: PinId,

type Error = Infallible

Error type

source

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

Is the input pin high?

source

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

Is the input pin low?

source

impl<I, C> InputPin for Pin<I, Input<C>> where
I: PinId,
C: InputConfig,

type Error = Infallible

Error type

source

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

Is the input pin high?

source

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

Is the input pin low?

source

impl<I, C> OutputPin for Pin<I, Output<C>> where
I: PinId,
C: OutputConfig,

type Error = Infallible

Error type

source

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

Drives the pin high Read more

source

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

Drives the pin low Read more

source

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

Drives the pin high or low depending on the provided value Read more

source

impl Rts<UART0> for Pin<Gpio3, FunctionUart>

source

const ENABLED: bool = true

source

impl Rts<UART0> for Pin<Gpio15, FunctionUart>

source

const ENABLED: bool = true

source

impl Rts<UART0> for Pin<Gpio19, FunctionUart>

source

const ENABLED: bool = true

source

impl Rts<UART1> for Pin<Gpio7, FunctionUart>

source

const ENABLED: bool = true

source

impl Rts<UART1> for Pin<Gpio11, FunctionUart>

source

const ENABLED: bool = true

source

impl Rts<UART1> for Pin<Gpio23, FunctionUart>

source

const ENABLED: bool = true

source

impl Rts<UART1> for Pin<Gpio27, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART0> for Pin<Gpio1, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART0> for Pin<Gpio13, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART0> for Pin<Gpio17, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART0> for Pin<Gpio29, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART1> for Pin<Gpio5, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART1> for Pin<Gpio9, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART1> for Pin<Gpio21, FunctionUart>

source

const ENABLED: bool = true

source

impl Rx<UART1> for Pin<Gpio25, FunctionUart>

source

const ENABLED: bool = true

source

impl<I, C> StatefulOutputPin for Pin<I, Output<C>> where
I: PinId,
C: OutputConfig,

source

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

Is the pin in drive high mode? Read more

source

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

Is the pin in drive low mode? Read more

source

impl<I, C> ToggleableOutputPin for Pin<I, Output<C>> where
I: PinId,
C: OutputConfig,

type Error = Infallible

Error type

source

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

Toggle pin output.

source

impl<I, M> TryFrom<DynPin> for Pin<I, M> where
I: PinId,
M: PinMode + ValidPinMode,

source

fn try_from(pin: DynPin) -> Result<Self, Error>

Try to recreate a type-level Pin from a value-level DynPin

There is no way for the compiler to know if the conversion will be successful at compile-time. We must verify the conversion at run-time or refuse to perform it.

type Error = Error

The type returned in the event of a conversion error.

source

impl Tx<UART0> for Pin<Gpio0, FunctionUart>

source

const ENABLED: bool = true

source

impl Tx<UART0> for Pin<Gpio12, FunctionUart>

source

const ENABLED: bool = true

source

impl Tx<UART0> for Pin<Gpio16, FunctionUart>

source

const ENABLED: bool = true

source

impl Tx<UART0> for Pin<Gpio28, FunctionUart>

source

const ENABLED: bool = true

source

impl Tx<UART1> for Pin<Gpio4, FunctionUart>

source

const ENABLED: bool = true

source

impl Tx<UART1> for Pin<Gpio8, FunctionUart>

source

const ENABLED: bool = true

source

impl Tx<UART1> for Pin<Gpio20, FunctionUart>

source

const ENABLED: bool = true

source

impl Tx<UART1> for Pin<Gpio24, FunctionUart>

source

const ENABLED: bool = true

source

impl ValidSrc<AdcClock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkAdcSrcType

Get register value for this ClockSource

source

impl ValidSrc<AdcClock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkAdcSrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput0Clock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout0SrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput0Clock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout0SrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput1Clock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout1SrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput1Clock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout1SrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput2Clock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout2SrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput2Clock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout2SrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput3Clock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout3SrcType

Get register value for this ClockSource

source

impl ValidSrc<GpioOutput3Clock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkGpout3SrcType

Get register value for this ClockSource

source

impl ValidSrc<PeripheralClock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkPeriSrcType

Get register value for this ClockSource

source

impl ValidSrc<PeripheralClock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkPeriSrcType

Get register value for this ClockSource

source

impl ValidSrc<ReferenceClock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkRefSrcType

Get register value for this ClockSource

source

impl ValidSrc<ReferenceClock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkRefSrcType

Get register value for this ClockSource

source

impl ValidSrc<RtcClock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkRtcSrcType

Get register value for this ClockSource

source

impl ValidSrc<RtcClock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkRtcSrcType

Get register value for this ClockSource

source

impl ValidSrc<SystemClock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkSysSrcType

Get register value for this ClockSource

source

impl ValidSrc<SystemClock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkSysSrcType

Get register value for this ClockSource

source

impl ValidSrc<UsbClock> for Pin<Gpio20, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkUsbSrcType

Get register value for this ClockSource

source

impl ValidSrc<UsbClock> for Pin<Gpio22, FunctionClock>

source

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

source

fn variant(&self) -> ClkUsbSrcType

Get register value for this ClockSource

Auto Trait Implementations

impl<I, M> RefUnwindSafe for Pin<I, M> where
I: RefUnwindSafe,
M: RefUnwindSafe,

impl<I, M> Send for Pin<I, M> where
I: Send,
M: Send,

impl<I, M> Sync for Pin<I, M> where
I: Sync,
M: Sync,

impl<I, M> Unpin for Pin<I, M> where
I: Unpin,
M: Unpin,

impl<I, M> UnwindSafe for Pin<I, M> where
I: UnwindSafe,
M: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Is for T where
T: Sealed + AsRef<T> + AsMut<T>,

type Type = T

source

impl OptionalPin for P where
P: AnyPin,

type Id = ::Id

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct rp2040_hal::gpio::pin::Pin

Implementations

impl<I, M> Pin<I, M> where I: PinId, M: PinMode + ValidPinMode<I>,

pub fn into_mode<N: PinMode + ValidPinMode<I>>(self) -> Pin<I, N>

pub fn into_floating_disabled(self) -> Pin<I, FloatingDisabled>

pub fn into_pull_down_disabled(self) -> Pin<I, PullDownDisabled>

pub fn into_pull_up_disabled(self) -> Pin<I, PullUpDisabled>

pub fn into_floating_input(self) -> Pin<I, FloatingInput>

pub fn into_pull_down_input(self) -> Pin<I, PullDownInput>

pub fn into_pull_up_input(self) -> Pin<I, PullUpInput>

pub fn into_bus_keep_input(self) -> Pin<I, BusKeepInput>

pub fn into_push_pull_output(self) -> Pin<I, PushPullOutput>

pub fn into_readable_output(self) -> Pin<I, ReadableOutput>

pub fn get_drive_strength(&self) -> OutputDriveStrength

pub fn set_drive_strength(&mut self, strength: OutputDriveStrength)

pub fn get_slew_rate(&self) -> OutputSlewRate

pub fn set_slew_rate(&mut self, rate: OutputSlewRate)

pub fn clear_interrupt(&mut self, interrupt: Interrupt)

pub fn interrupt_status(&self, interrupt: Interrupt) -> bool

pub fn is_interrupt_enabled(&self, interrupt: Interrupt) -> bool

pub fn set_interrupt_enabled(&self, interrupt: Interrupt, enabled: bool)

pub fn is_interrupt_forced(&self, interrupt: Interrupt) -> bool

pub fn set_interrupt_forced(&self, interrupt: Interrupt, forced: bool)

pub fn set_interrupt_override(&mut self, override_value: InterruptOverride)

pub fn set_input_override(&mut self, override_value: InputOverride)

pub fn set_output_enable_override( &mut self, override_value: OutputEnableOverride)

pub fn set_output_override(&mut self, override_value: OutputOverride)

Trait Implementations

impl<I, M> AnyPin for Pin<I, M> where I: PinId, M: PinMode + ValidPinMode<I>,

type Id = I

type Mode = M

impl Channel<Adc> for Pin<Gpio26, FloatingInput>

type ID = u8

fn channel() -> u8

impl Channel<Adc> for Pin<Gpio27, FloatingInput>

type ID = u8

fn channel() -> u8

impl Channel<Adc> for Pin<Gpio28, FloatingInput>

type ID = u8

fn channel() -> u8

impl Channel<Adc> for Pin<Gpio29, FloatingInput>

type ID = u8

fn channel() -> u8

impl ClockSource for Pin<Gpio20, FunctionClock>

fn get_freq(&self) -> Hertz

impl ClockSource for Pin<Gpio22, FunctionClock>

fn get_freq(&self) -> Hertz

impl Cts<UART0> for Pin<Gpio2, FunctionUart>

const ENABLED: bool = true

impl Cts<UART0> for Pin<Gpio14, FunctionUart>

const ENABLED: bool = true

impl Cts<UART0> for Pin<Gpio18, FunctionUart>

const ENABLED: bool = true

impl Cts<UART1> for Pin<Gpio6, FunctionUart>

const ENABLED: bool = true

impl Cts<UART1> for Pin<Gpio10, FunctionUart>

const ENABLED: bool = true

impl Cts<UART1> for Pin<Gpio22, FunctionUart>

const ENABLED: bool = true

impl Cts<UART1> for Pin<Gpio26, FunctionUart>

const ENABLED: bool = true

impl<I, M> From<Pin<I, M>> for DynPin where I: PinId, M: PinMode + ValidPinMode<I>,

fn from(_pin: Pin<I, M>) -> Self

impl<I> InputPin for Pin<I, ReadableOutput> where I: PinId,

type Error = Infallible

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

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

impl<I, C> InputPin for Pin<I, Input<C>> where I: PinId, C: InputConfig,

type Error = Infallible

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

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

impl<I, C> OutputPin for Pin<I, Output<C>> where I: PinId, C: OutputConfig,

type Error = Infallible

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

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

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

impl Rts<UART0> for Pin<Gpio3, FunctionUart>

const ENABLED: bool = true

impl Rts<UART0> for Pin<Gpio15, FunctionUart>

const ENABLED: bool = true

impl<I, M> Pin<I, M> where
I: PinId,
M: PinMode + ValidPinMode<I>,

pub fn set_output_enable_override(
&mut self,
override_value: OutputEnableOverride
)

impl<I, M> AnyPin for Pin<I, M> where
I: PinId,
M: PinMode + ValidPinMode<I>,

impl<I, M> From<Pin<I, M>> for DynPin where
I: PinId,
M: PinMode + ValidPinMode<I>,

impl<I> InputPin for Pin<I, ReadableOutput> where
I: PinId,

impl<I, C> InputPin for Pin<I, Input<C>> where
I: PinId,
C: InputConfig,

impl<I, C> OutputPin for Pin<I, Output<C>> where
I: PinId,
C: OutputConfig,

impl<I, C> StatefulOutputPin for Pin<I, Output<C>> where
I: PinId,
C: OutputConfig,

impl<I, C> ToggleableOutputPin for Pin<I, Output<C>> where
I: PinId,
C: OutputConfig,

impl<I, M> TryFrom<DynPin> for Pin<I, M> where
I: PinId,
M: PinMode + ValidPinMode<I>,