Struct SpiScript 

pub struct SpiScript { /* private fields */ }

An SPI device that plays a script of transfers and replies.

The device is the bus plus the part’s chip select, so a transaction is one chip-select assertion and each operation inside it consumes one step. A delay operation consumes nothing. A transfer that does not match fails with SpiScriptError::Mismatch, and a test ends by checking done.

Examples

use pamoja_hal::script::{SpiScript, SpiStep};
use pamoja_hal::spi::{Operation, SpiDevice};

// A Bosch part read over SPI: the control byte 0xD0 with its read bit set, then
// the chip id shifted out.
let mut device = SpiScript::new([SpiStep::write([0xD0]), SpiStep::read([0x60])]);
let mut id = [0u8; 1];
device.transaction(&mut [Operation::Write(&[0xD0]), Operation::Read(&mut id)])?;
assert_eq!(id, [0x60]);
assert!(device.done());

Implementations

impl SpiScript

pub fn new(steps: impl IntoIterator<Item = SpiStep>) -> SpiScript

Creates a device that expects steps in order.

Arguments

• steps - the transfers the driver is expected to make, and their replies.

Returns

The scripted device.

pub fn done(&self) -> bool

Reports whether every step has been consumed.

Returns

true once the driver has made every transfer the script expected.

pub fn remaining(&self) -> usize

Reports how many steps remain.

Returns

The number of steps the driver has not yet reached.

pub fn consumed(&self) -> usize

Reports how many steps the driver has consumed.

Returns

The number of steps matched or faulted so far.

Trait Implementations

impl Clone for SpiScript

fn clone(&self) -> SpiScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpiScript

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

Formats the value using the given formatter.

impl Default for SpiScript

fn default() -> SpiScript

Returns the “default value” for a type.

impl ErrorType for SpiScript

type Error = SpiScriptError

Error type.

impl SpiDevice for SpiScript

fn transaction( &mut self, operations: &mut [Operation<'_, u8>], ) -> Result<(), SpiScriptError>

Perform a transaction against the device.

fn read(&mut self, buf: &mut [Word]) -> Result<(), Self::Error>

Do a read within a transaction.

fn write(&mut self, buf: &[Word]) -> Result<(), Self::Error>

Do a write within a transaction.

fn transfer( &mut self, read: &mut [Word], write: &[Word], ) -> Result<(), Self::Error>

Do a transfer within a transaction.

fn transfer_in_place(&mut self, buf: &mut [Word]) -> Result<(), Self::Error>

Do an in-place transfer within a transaction.