Struct esp_hal::spi::master::Spi

pub struct Spi<'d, T, M> { /* private fields */ }

SPI peripheral driver

Implementations

impl<'d, T> Spi<'d, T, FullDuplexMode>

where T: Instance,

pub fn new( spi: impl Peripheral<P = T> + 'd, frequency: HertzU32, mode: SpiMode, clocks: &Clocks<'_> ) -> Spi<'d, T, FullDuplexMode>

Constructs an SPI instance in 8bit dataframe mode.

All pins are optional. Setup these pins using with_pins or individual methods for each pin.

pub fn with_sck<SCK: OutputPin>( self, sck: impl Peripheral<P = SCK> + 'd ) -> Self

pub fn with_mosi<MOSI: OutputPin>( self, mosi: impl Peripheral<P = MOSI> + 'd ) -> Self

pub fn with_miso<MISO: InputPin>( self, miso: impl Peripheral<P = MISO> + 'd ) -> Self

pub fn with_cs<CS: OutputPin>(self, cs: impl Peripheral<P = CS> + 'd) -> Self

pub fn with_pins<SCK: OutputPin, MOSI: OutputPin, MISO: InputPin, CS: OutputPin>( self, sck: Option<impl Peripheral<P = SCK> + 'd>, mosi: Option<impl Peripheral<P = MOSI> + 'd>, miso: Option<impl Peripheral<P = MISO> + 'd>, cs: Option<impl Peripheral<P = CS> + 'd> ) -> Self

Setup pins for this SPI instance.

All pins are optional. Pass crate::gpio::NO_PIN if you don’t need the given pin.

pub fn change_bus_frequency(&mut self, frequency: HertzU32, clocks: &Clocks<'_>)

impl<'d, T> Spi<'d, T, HalfDuplexMode>

where T: ExtendedInstance,

pub fn new_half_duplex( spi: impl Peripheral<P = T> + 'd, frequency: HertzU32, mode: SpiMode, clocks: &Clocks<'_> ) -> Spi<'d, T, HalfDuplexMode>

Constructs an SPI instance in half-duplex mode.

All pins are optional. Setup these pins using with_pins or individual methods for each pin.

pub fn with_sck<SCK: OutputPin>( self, sck: impl Peripheral<P = SCK> + 'd ) -> Self

pub fn with_mosi<MOSI: OutputPin + InputPin>( self, mosi: impl Peripheral<P = MOSI> + 'd ) -> Self

pub fn with_miso<MISO: OutputPin + InputPin>( self, miso: impl Peripheral<P = MISO> + 'd ) -> Self

pub fn with_sio2<SIO2: OutputPin + InputPin>( self, sio2: impl Peripheral<P = SIO2> + 'd ) -> Self

pub fn with_sio3<SIO3: OutputPin + InputPin>( self, sio3: impl Peripheral<P = SIO3> + 'd ) -> Self

pub fn with_cs<CS: OutputPin>(self, cs: impl Peripheral<P = CS> + 'd) -> Self

pub fn with_pins<SCK: OutputPin, MOSI: OutputPin + InputPin, MISO: OutputPin + InputPin, SIO2: OutputPin + InputPin, SIO3: OutputPin + InputPin, CS: OutputPin>( self, sck: Option<impl Peripheral<P = SCK> + 'd>, mosi: Option<impl Peripheral<P = MOSI> + 'd>, miso: Option<impl Peripheral<P = MISO> + 'd>, sio2: Option<impl Peripheral<P = SIO2> + 'd>, sio3: Option<impl Peripheral<P = SIO3> + 'd>, cs: Option<impl Peripheral<P = CS> + 'd> ) -> Self

Setup pins for this SPI instance.

All pins are optional. Pass crate::gpio::NO_PIN if you don’t need the given pin.

pub fn change_bus_frequency(&mut self, frequency: HertzU32, clocks: &Clocks<'_>)

Trait Implementations

impl<T, M> ErrorType for Spi<'_, T, M>

type Error = Error

Error type.

impl<T, M> FullDuplex for Spi<'_, T, M>

where T: Instance, M: IsFullDuplex,

fn read(&mut self) -> Result<u8, Self::Error>

Reads the word stored in the shift register

fn write(&mut self, word: u8) -> Result<(), Self::Error>

Writes a word to the slave

impl<T, M> HalfDuplexReadWrite for Spi<'_, T, M>

where T: Instance, M: IsHalfDuplex,

type Error = Error

fn read( &mut self, data_mode: SpiDataMode, cmd: Command, address: Address, dummy: u8, buffer: &mut [u8] ) -> Result<(), Self::Error>

Half-duplex read.

fn write( &mut self, data_mode: SpiDataMode, cmd: Command, address: Address, dummy: u8, buffer: &[u8] ) -> Result<(), Self::Error>

Half-duplex write.

impl<T, M> SpiBus for Spi<'_, T, M>

where T: Instance, M: IsFullDuplex,

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

Read words from the slave.

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

Write words to the slave, ignoring all the incoming words.

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

Write and read simultaneously. write is written to the slave on MOSI and words received on MISO are stored in read.

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

Write and read simultaneously. The contents of words are written to the slave, and the received words are stored into the same words buffer, overwriting it.

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

Wait until all operations have completed and the bus is idle.

impl<'d, C, M> WithDmaSpi2<'d, C, M> for Spi<'d, SPI2, M>

where C: ChannelTypes, C::P: SpiPeripheral + Spi2Peripheral, M: DuplexMode,

fn with_dma(self, channel: Channel<'d, C>) -> SpiDma<'d, SPI2, C, M>

impl<T, M> Transfer<u8> for Spi<'_, T, M>

where T: Instance, M: IsFullDuplex,

type Error = Error

Error type

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

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

impl<T, M> Write<u8> for Spi<'_, T, M>

where T: Instance, M: IsFullDuplex,

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words

impl<T, M> FullDuplex<u8> for Spi<'_, T, M>

where T: Instance, M: IsFullDuplex,

type Error = Error

An enumeration of SPI errors

fn read(&mut self) -> Result<u8, Self::Error>

Reads the word stored in the shift register

fn send(&mut self, word: u8) -> Result<(), Self::Error>

Sends a word to the slave