embassy-rp

Crates

git

Versions

rp2040

Flavors

Skip to main content

Config

Struct Config 

Source
pub struct Config<'d, PIO: Instance> {
    pub clock_divider_x256: u32,
    pub out_en_sel: u8,
    pub inline_out_en: bool,
    pub out_sticky: bool,
    pub status_sel: StatusSource,
    pub status_n: u8,
    pub fifo_join: FifoJoin,
    pub shift_in: ShiftConfig,
    pub shift_out: ShiftConfig,
    /* private fields */
}
Expand description

PIO config.

Fields§

§clock_divider_x256: u32

Clock divider for state machines, as a fixed-point number with 16 integer bits and 8 fractional bits (the divider multiplied by 256). For example, 256 divides by 1, 640 divides by 2.5. Must be between 1 << 8 and 65536 << 8 inclusive.

§out_en_sel: u8

Which data bit to use for inline OUT enable.

§inline_out_en: bool

Use a bit of OUT data as an auxiliary write enable When used in conjunction with OUT_STICKY.

§out_sticky: bool

Continuously assert the most recent OUT/SET to the pins.

§status_sel: StatusSource

Which source to use for checking status.

§status_n: u8

Status comparison level.

§fifo_join: FifoJoin

Configure FIFO allocation.

§shift_in: ShiftConfig

Input shifting config.

§shift_out: ShiftConfig

Output shifting config.

Implementations§

Source§

impl<'d, PIO: Instance> Config<'d, PIO>

Source

pub fn get_exec(&self) -> ExecConfig

Get execution configuration.

Source

pub unsafe fn set_exec(&mut self, e: ExecConfig)

Update execution configuration.

Source

pub fn get_pins(&self) -> PinConfig

Get pin configuration.

Source

pub unsafe fn set_pins(&mut self, p: PinConfig)

Update pin configuration.

Source

pub fn use_program( &mut self, prog: &LoadedProgram<'d, PIO>, side_set: &[&Pin<'d, PIO>], )

Configures this state machine to use the given program, including jumping to the origin of the program. The state machine is not started.

side_set sets the range of pins affected by side-sets. The range must be consecutive. Sideset pins must configured as outputs using StateMachine::set_pin_dirs to be effective.

Source

pub fn set_jmp_pin(&mut self, pin: &Pin<'d, PIO>)

Set pin used to signal jump.

Source

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

Sets the range of pins affected by SET instructions. The range must be consecutive. Set pins must configured as outputs using StateMachine::set_pin_dirs to be effective.

Source

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

Sets the range of pins affected by OUT instructions. The range must be consecutive. Out pins must configured as outputs using StateMachine::set_pin_dirs to be effective.

Source

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

Sets the range of pins used by IN instructions. The range must be consecutive. In pins must configured as inputs using StateMachine::set_pin_dirs to be effective.

Source

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

Enables input synchronizer bypass for the given pins, applied by StateMachine::set_config once GPIOBASE is established.

Trait Implementations§

Source§

impl<'d, PIO: Clone + Instance> Clone for Config<'d, PIO>

Source§

fn clone(&self) -> Config<'d, PIO>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'d, PIO: Copy + Instance> Copy for Config<'d, PIO>

Source§

impl<'d, PIO: Debug + Instance> Debug for Config<'d, PIO>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'d, PIO: Instance> Default for Config<'d, PIO>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'d, PIO: Instance> Format for Config<'d, PIO>

Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

Auto Trait Implementations§

§

impl<'d, PIO> !UnwindSafe for Config<'d, PIO>

§

impl<'d, PIO> Freeze for Config<'d, PIO>

§

impl<'d, PIO> RefUnwindSafe for Config<'d, PIO>

§

impl<'d, PIO> Send for Config<'d, PIO>

§

impl<'d, PIO> Sync for Config<'d, PIO>

§

impl<'d, PIO> Unpin for Config<'d, PIO>

§

impl<'d, PIO> UnsafeUnpin for Config<'d, PIO>

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,

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.