Struct TriggeredFrames 

pub struct TriggeredFrames<'a, W: Word, const N: usize> { /* private fields */ }

A stream of triggered frames. Dropping it stops the stream and restores the Spi.

Implementations

impl<'a, W: Word, const N: usize> TriggeredFrames<'a, W, N>

pub fn new<T: InterruptInstance>( spi: &'a mut Spi<'_, Async, Master>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'a, rearm: &'a mut Channel<'_>, config: Config, descriptors: &'a mut Descriptors<N>, ring: &'a mut [W], tx_frame: &'a [W], ) -> Self

Start streaming: every edge of config.trigger runs one frame.

• spi: instance T, with both DMA channels; its mode and frequency apply to the frames.
• rearm: a third channel of the same DMA controller.
• tx_frame: sent each frame; its length is the frame length, at most 65535 words.
• ring: N blocks of whole frames, at most MAX_FRAMES_PER_BLOCK frames and 65535 bytes per block.

The trigger source is set up separately (e.g. ExtiInput::enable_event). The first block may hold frames from before the call.

pub async fn next_block(&mut self) -> Result<Block<'_, W>, Error>

The next block, read in place. Error::Overrun if the consumer fell a ring behind, also while it held the previous block.

pub fn take_missed_trigger(&mut self) -> bool

Whether a trigger was lost because the previous one was still being served. Clears it.

pub fn crc_errors(&self) -> u32

Frames that failed their CRC since the stream started.

pub fn overruns(&self) -> u32

SPI receive overruns since the stream started.

pub fn frames_per_block(&self) -> usize

Frames per block.

Trait Implementations

impl<W: Word, const N: usize> Drop for TriggeredFrames<'_, W, N>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.