Struct pio::Program

pub struct Program<const PROGRAM_SIZE: usize> {
    pub code: ArrayVec<u16, PROGRAM_SIZE>,
    pub origin: Option<u8>,
    pub wrap: Wrap,
    pub side_set: SideSet,
}

Program ready to be executed by PIO hardware.

Fields

code: ArrayVec<u16, PROGRAM_SIZE>

Assembled program code.

origin: Option<u8>

Offset at which the program must be loaded.

Most often 0 if defined. This might be needed when using data based JMPs.

NOTE: Instruction addresses in JMP instructions as well as wrap source/target are calculated as if the origin was 0. Functions loading the program into PIO instruction memory will adjust those addresses accordingly if the program is loaded to a non-zero origin address.

wrap: Wrap

Wrapping behavior for this program.

side_set: SideSet

Side-set info for this program.

Implementations

impl<const PROGRAM_SIZE: usize> Program<PROGRAM_SIZE>

pub fn set_origin(self, origin: Option<u8>) -> Self

Set the program loading location.

If None, the program can be loaded at any location in the instruction memory.

pub fn set_wrap(self, wrap: Wrap) -> Self

Set the wrapping of the program.

Trait Implementations

impl<const PROGRAM_SIZE: usize> Debug for Program<PROGRAM_SIZE>

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

Formats the value using the given formatter.