Struct OutputSignal

pub struct OutputSignal<'d> { /* private fields */ }

Available on crate feature unstable only.

An (input and) output signal between a peripheral and a GPIO pin.

If the OutputSignal was obtained from a pin driver such as Output, the GPIO driver will be responsible for configuring the pin with the correct settings, peripheral drivers will not be able to modify the pin settings.

Note that connecting this to a peripheral input will enable the input stage of the GPIO pin.

Multiple pins can be connected to one output signal.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Implementations

impl<'d> OutputSignal<'d>

pub fn freeze(self) -> Self

Freezes the pin configuration.

This will prevent peripheral drivers using this signal from modifying the pin settings.

pub unsafe fn unfreeze(&mut self)

Unfreezes the pin configuration.

This will enable peripheral drivers to modify the pin settings again.

Safety

This function is unsafe because it allows peripherals to modify the pin configuration again. This can lead to undefined behavior if the pin is being configured by multiple peripherals at the same time. It can also lead to surprising behavior if the pin is passed to multiple peripherals that expect conflicting settings.

pub fn gpio_number(&self) -> Option<u8>

Returns the GPIO number of the underlying pin.

Returns None if the signal is a constant level.

pub fn is_input_inverted(&self) -> bool

Returns true if the input signal is configured to be inverted.

Note that the hardware is not configured until the signal is actually connected to a peripheral.

pub fn is_output_inverted(&self) -> bool

Returns true if the output signal is configured to be inverted.

Note that the hardware is not configured until the signal is actually connected to a peripheral.

pub fn with_output_inverter(self, invert: bool) -> Self

Consumes the signal and returns a new one that inverts the peripheral’s output signal.

pub fn with_input_inverter(self, invert: bool) -> Self

Consumes the signal and returns a new one that inverts the peripheral’s input signal.

pub fn with_gpio_matrix_forced(self, force: bool) -> Self

Consumes the signal and returns a new one that forces the GPIO matrix to be used.

pub fn is_gpio_matrix_forced(&self) -> bool

Returns true if the input signal must be routed through the GPIO matrix.

pub fn is_input_high(&self) -> bool

Returns true if the input signal is high.

Note that this does not take Self::with_input_inverter into account.

pub fn is_set_high(&self) -> bool

Returns true if the output signal is set high.

Note that this does not take Self::with_output_inverter into account.

Trait Implementations

impl<'d> From<Flex<'d>> for OutputSignal<'d>

fn from(pin: Flex<'d>) -> Self

Converts to this type from the input type.

impl From<Level> for OutputSignal<'_>

fn from(level: Level) -> Self

Converts to this type from the input type.

impl From<NoPin> for OutputSignal<'_>

fn from(_pin: NoPin) -> Self

Converts to this type from the input type.

impl<'d> From<Output<'d>> for OutputSignal<'d>

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

fn from(pin: Output<'d>) -> Self

Converts to this type from the input type.

impl<'d, P> From<P> for OutputSignal<'d>

where P: OutputPin + 'd,

fn from(output: P) -> Self

Converts to this type from the input type.

impl<'d> PeripheralOutput<'d> for OutputSignal<'d>

impl<'d> PeripheralSignal<'d> for OutputSignal<'d>