embassy-rp

Crates

git

Versions

rp2040

Flavors

embassy_rp::pio

Struct StateMachine

Source
pub struct StateMachine<'d, PIO: Instance, const SM: usize> { /* private fields */ }
Expand description

A type representing a single PIO state machine.

Implementations§

Source§

impl<'d, PIO: Instance + 'd, const SM: usize> StateMachine<'d, PIO, SM>

Source

pub fn set_config(&mut self, config: &Config<'d, PIO>)

Set the config for a given PIO state machine.

Source

pub fn set_clock_divider(&mut self, clock_divider: FixedU32<U8>)

Set the clock divider for this state machine.

Source

pub fn restart(&mut self)

Restart this state machine.

Source

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

Enable state machine.

Source

pub fn is_enabled(&self) -> bool

Check if state machine is enabled.

Source

pub fn clkdiv_restart(&mut self)

Restart a state machine’s clock divider from an initial phase of 0.

Source

pub fn set_pin_dirs(&mut self, dir: Direction, pins: &[&Pin<'d, PIO>])

Sets pin directions. This pauses the current state machine to run SET commands and temporarily unsets the OUT_STICKY bit.

Source

pub fn set_pins(&mut self, level: Level, pins: &[&Pin<'d, PIO>])

Sets pin output values. This pauses the current state machine to run SET commands and temporarily unsets the OUT_STICKY bit.

Source

pub fn clear_fifos(&mut self)

Flush FIFOs for state machine.

Source

pub unsafe fn exec_instr(&mut self, instr: u16)

Instruct state machine to execute a given instructions

SAFETY: The state machine must be in a state where executing an arbitrary instruction does not crash it.

Source

pub fn rx(&mut self) -> &mut StateMachineRx<'d, PIO, SM>

Return a read handle for reading state machine outputs.

Source

pub fn tx(&mut self) -> &mut StateMachineTx<'d, PIO, SM>

Return a handle for writing to inputs.

Source

pub fn rx_tx( &mut self, ) -> (&mut StateMachineRx<'d, PIO, SM>, &mut StateMachineTx<'d, PIO, SM>)

Return both read and write handles for the state machine.

Trait Implementations§

Source§

impl<'d, PIO: Instance, const SM: usize> Drop for StateMachine<'d, PIO, SM>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'d, PIO, const SM: usize> Freeze for StateMachine<'d, PIO, SM>

§

impl<'d, PIO, const SM: usize> RefUnwindSafe for StateMachine<'d, PIO, SM>
where PIO: RefUnwindSafe,

§

impl<'d, PIO, const SM: usize> Send for StateMachine<'d, PIO, SM>
where PIO: Send,

§

impl<'d, PIO, const SM: usize> Sync for StateMachine<'d, PIO, SM>
where PIO: Sync,

§

impl<'d, PIO, const SM: usize> Unpin for StateMachine<'d, PIO, SM>

§

impl<'d, PIO, const SM: usize> !UnwindSafe for StateMachine<'d, PIO, SM>

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.