Struct esp32c3_hal::spi::Spi

pub struct Spi<T> { /* private fields */ }

Implementations

impl<T> Spi<T>where
    T: Instance,

pub fn new<SCK, MOSI, MISO, CS>(
    spi: T,
    sck: SCK,
    mosi: MOSI,
    miso: MISO,
    cs: CS,
    frequency: Rate<u32, 1, 1>,
    mode: SpiMode,
    peripheral_clock_control: &mut PeripheralClockControl,
    clocks: &Clocks
) -> Spi<T>where
    SCK: OutputPin,
    MOSI: OutputPin,
    MISO: InputPin,
    CS: OutputPin,

Constructs an SPI instance in 8bit dataframe mode.

pub fn new_no_cs<SCK, MOSI, MISO>(
    spi: T,
    sck: SCK,
    mosi: MOSI,
    miso: MISO,
    frequency: Rate<u32, 1, 1>,
    mode: SpiMode,
    peripheral_clock_control: &mut PeripheralClockControl,
    clocks: &Clocks
) -> Spi<T>where
    SCK: OutputPin,
    MOSI: OutputPin,
    MISO: InputPin,

Constructs an SPI instance in 8bit dataframe mode without CS pin.

pub fn new_no_cs_no_miso<SCK, MOSI>(
    spi: T,
    sck: SCK,
    mosi: MOSI,
    frequency: Rate<u32, 1, 1>,
    mode: SpiMode,
    peripheral_clock_control: &mut PeripheralClockControl,
    clocks: &Clocks
) -> Spi<T>where
    SCK: OutputPin,
    MOSI: OutputPin,

Constructs an SPI instance in 8bit dataframe mode without CS and MISO pin.

pub fn new_mosi_only<MOSI>(
    spi: T,
    mosi: MOSI,
    frequency: Rate<u32, 1, 1>,
    mode: SpiMode,
    peripheral_clock_control: &mut PeripheralClockControl,
    clocks: &Clocks
) -> Spi<T>where
    MOSI: OutputPin,

Constructs an SPI instance in 8bit dataframe mode with only MOSI connected. This might be useful for (ab)using SPI to implement other protocols by bitbanging (WS2812B, onewire, generating arbitrary waveforms…)

pub fn new_internal(
    spi: T,
    frequency: Rate<u32, 1, 1>,
    mode: SpiMode,
    peripheral_clock_control: &mut PeripheralClockControl,
    clocks: &Clocks
) -> Spi<T>

pub fn free(self) -> T

Return the raw interface to the underlying peripheral instance

Trait Implementations

impl<T> FullDuplex<u8> for Spi<T>where
    T: Instance,

type Error = Infallible

An enumeration of SPI errors

fn read(&mut self) -> Result<u8, Error<<Spi<T> as FullDuplex<u8>>::Error>>

Reads the word stored in the shift register

fn send(
    &mut self,
    word: u8
) -> Result<(), Error<<Spi<T> as FullDuplex<u8>>::Error>>

Sends a word to the slave

impl<T> Transfer<u8> for Spi<T>where
    T: Instance,

type Error = Infallible

Error type

fn transfer(
    &mut self,
    words: &'w mut [u8]
) -> Result<&'w [u8], <Spi<T> as Transfer<u8>>::Error>

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

impl<T> Write<u8> for Spi<T>where
    T: Instance,

type Error = Infallible

Error type

fn write(&mut self, words: &[u8]) -> Result<(), <Spi<T> as Write<u8>>::Error>

Sends words to the slave, ignoring all the incoming words