Struct embedded_spi::wrapper::Wrapper

pub struct Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> { /* fields omitted */ }

Wrapper wraps an Spi and Pin object to support transactions

Methods

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    Spi: Transfer<u8, Error = SpiError> + Write<u8, Error = SpiError>,
    CsPin: OutputPin<Error = PinError>,
    Delay: DelayMs<u32>, 

pub fn new(
    spi: Spi,
    cs: CsPin,
    busy: BusyPin,
    ready: ReadyPin,
    reset: ResetPin,
    delay: Delay
) -> Self

Create a new wrapper object with the provided SPI and pin

pub fn pin_write<P>(&mut self, pin: &mut P, value: bool) -> i32 where
    P: OutputPin<Error = PinError>, 

Write to a Pin instance while wrapping and storing the error internally This returns 0 for success or -1 for errors

pub fn pin_read<P>(&mut self, pin: &mut P) -> i32 where
    P: InputPin<Error = PinError>, 

Write to a Pin instance while wrapping and storing the error internally This returns 0 for low, 1 for high, and -1 for errors

pub fn check_error(&mut self) -> Result<(), Error<SpiError, PinError>>

Check the internal error state of the peripheral This provides a mechanism to retrieve the rust error if an error occurs during an FFI call, and clears the internal error state

pub fn free(self) -> (Spi, CsPin, BusyPin, ReadyPin, ResetPin)

Return hardware resources for reuse

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    Spi: Transfer<u8, Error = SpiError> + Write<u8, Error = SpiError>,
    CsPin: OutputPin<Error = PinError>,
    Delay: DelayMs<u32>, 

pub extern "C" fn ffi_spi_write(
    ctx: *mut c_void,
    prefix: *mut u8,
    prefix_len: u16,
    data: *mut u8,
    data_len: u16
) -> isize

C FFI compatible spi_write function for dependency injection

pub extern "C" fn ffi_spi_read(
    ctx: *mut c_void,
    prefix: *mut u8,
    prefix_len: u16,
    data: *mut u8,
    data_len: u16
) -> isize

C FFI compatible spi_read function for dependency injection

Trait Implementations

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Busy for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    BusyPin: InputPin<Error = PinError>, 

type Error = Error<SpiError, PinError>

fn get_busy(&mut self) -> Result<PinState, Self::Error>

Fetch the busy pin state

impl<Spi: Clone, SpiError: Clone, CsPin: Clone, BusyPin: Clone, ReadyPin: Clone, ResetPin: Clone, PinError: Clone, Delay: Clone> Clone for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>

fn clone(
    &self
) -> Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Cursed for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>

Mark Wrapper as a c u r s e d type to allow C coercion

impl<Spi: Debug, SpiError: Debug, CsPin: Debug, BusyPin: Debug, ReadyPin: Debug, ResetPin: Debug, PinError: Debug, Delay: Debug> Debug for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>

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

Formats the value using the given formatter.

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> DelayMs<u32> for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    Delay: DelayMs<u32>, 

fn delay_ms(&mut self, ms: u32)

Set the reset pin state

impl<Spi: PartialEq, SpiError: PartialEq, CsPin: PartialEq, BusyPin: PartialEq, ReadyPin: PartialEq, ResetPin: PartialEq, PinError: PartialEq, Delay: PartialEq> PartialEq<Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>> for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>

fn eq(
    &self,
    other: &Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>
) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(
    &self,
    other: &Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>
) -> bool

This method tests for !=.

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Ready for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    ReadyPin: InputPin<Error = PinError>, 

type Error = Error<SpiError, PinError>

fn get_ready(&mut self) -> Result<PinState, Self::Error>

Fetch the ready pin state

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Reset for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    ResetPin: OutputPin<Error = PinError>, 

type Error = Error<SpiError, PinError>

fn set_reset(&mut self, state: PinState) -> Result<(), Self::Error>

Set the reset pin state

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> StructuralPartialEq for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay>

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Transactional for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    Spi: Transfer<u8, Error = SpiError> + Write<u8, Error = SpiError>,
    CsPin: OutputPin<Error = PinError>,
    Delay: DelayMs<u32>, 

type Error = Error<SpiError, PinError>

fn spi_read<'a>(
    &mut self,
    prefix: &[u8],
    data: &'a mut [u8]
) -> Result<(), Self::Error>

Read data from a specified address This consumes the provided input data array and returns a reference to this on success

fn spi_write(&mut self, prefix: &[u8], data: &[u8]) -> Result<(), Self::Error>

Write data to a specified register address

fn spi_exec(
    &mut self,
    transactions: &mut [Transaction]
) -> Result<(), Self::Error>

Execute the provided transactions

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Transfer<u8> for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    Spi: Transfer<u8, Error = SpiError> + Write<u8, Error = SpiError>, 

type Error = SpiError

Error type

fn transfer<'w>(&mut self, data: &'w mut [u8]) -> Result<&'w [u8], Self::Error>

Sends words to the slave. Returns the words received from the slave

impl<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> Write<u8> for Wrapper<Spi, SpiError, CsPin, BusyPin, ReadyPin, ResetPin, PinError, Delay> where
    Spi: Transfer<u8, Error = SpiError> + Write<u8, Error = SpiError>, 

type Error = SpiError

Error type

fn write<'w>(&mut self, data: &[u8]) -> Result<(), Self::Error>

Sends words to the slave, ignoring all the incoming words