Trait kernel::hil::spi::SpiSlaveDevice

pub trait SpiSlaveDevice<'a> {
    // Required methods
    fn set_client(&self, client: &'a dyn SpiSlaveClient);
    fn configure(
        &self,
        cpol: ClockPolarity,
        cpal: ClockPhase,
    ) -> Result<(), ErrorCode>;
    fn read_write_bytes(
        &self,
        write_buffer: Option<&'static mut [u8]>,
        read_buffer: Option<&'static mut [u8]>,
        len: usize,
    ) -> Result<(), (ErrorCode, Option<&'static mut [u8]>, Option<&'static mut [u8]>)>;
    fn set_polarity(&self, polarity: ClockPolarity) -> Result<(), ErrorCode>;
    fn get_polarity(&self) -> ClockPolarity;
    fn set_phase(&self, phase: ClockPhase) -> Result<(), ErrorCode>;
    fn get_phase(&self) -> ClockPhase;
}

An interface to a SPI bus in peripheral mode.

It is the standard trait used by services within the kernel: SpiSlave is for lower-level access responsible for initializing hardware.

Required Methods

fn set_client(&self, client: &'a dyn SpiSlaveClient)

Specify the callback of SpiSlaveDevice::read_write_bytes operations.

fn configure( &self, cpol: ClockPolarity, cpal: ClockPhase, ) -> Result<(), ErrorCode>

Setup the SPI settings and speed of the bus.

fn read_write_bytes( &self, write_buffer: Option<&'static mut [u8]>, read_buffer: Option<&'static mut [u8]>, len: usize, ) -> Result<(), (ErrorCode, Option<&'static mut [u8]>, Option<&'static mut [u8]>)>

Same as SpiSlave::read_write_bytes.

fn set_polarity(&self, polarity: ClockPolarity) -> Result<(), ErrorCode>

Same as SpiSlave::set_polarity.

fn get_polarity(&self) -> ClockPolarity

Return the current bus polarity.

fn set_phase(&self, phase: ClockPhase) -> Result<(), ErrorCode>

Same as SpiSlave::set_phase.

fn get_phase(&self) -> ClockPhase

Return the current bus phase.

Implementors