Struct esp32_hal::spi::SPI

pub struct SPI<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin = Gpio1<Input<Floating>>, CS: OutputPin = Gpio2<Output<PushPull>>> { /* fields omitted */ }

SPI abstraction

Implementations

impl<CS: OutputPin> SPI<SPI1, Gpio6<Output<PushPull>>, Gpio7<Output<PushPull>>, Gpio8<Input<Floating>>, CS>

pub fn new(
    instance: SPI1,
    pins: Pins<Gpio6<Output<PushPull>>, Gpio7<Output<PushPull>>, Gpio8<Input<Floating>>, CS>,
    config: Config,
    clock_control: ClockControlConfig
) -> Result<Self, Error>

Create new instance of SPI controller for SPI1

SPI1 can only use fixed pin for SCLK, SDO and SDI as they are shared with SPI0.

impl<SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> SPI<SPI2, SCLK, SDO, SDI, CS>

pub fn new(
    instance: SPI2,
    pins: Pins<SCLK, SDO, SDI, CS>,
    config: Config,
    clock_control: ClockControlConfig
) -> Result<Self, Error>

Create new instance of SPI controller for SPI2

impl<SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> SPI<SPI3, SCLK, SDO, SDI, CS>

pub fn new(
    instance: SPI3,
    pins: Pins<SCLK, SDO, SDI, CS>,
    config: Config,
    clock_control: ClockControlConfig
) -> Result<Self, Error>

Create new instance of SPI controller for SPI3

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> SPI<INSTANCE, SCLK, SDO, SDI, CS>

pub fn change_baudrate<T: Into<Hertz> + Copy>(
    &mut self,
    baudrate: T
) -> Result<&mut Self, Error>

Change the SPI baudrate

pub fn baudrate(&self) -> Hertz

Returns the current baudrate

pub fn change_bit_order(&mut self, data_mode: BitOrder) -> &mut Self

Change the bit order

pub fn change_data_mode(&mut self, data_mode: Mode) -> &mut Self

Change the data mode

pub fn release(self) -> INSTANCE

Release and return the raw interface to the underlying SPI peripheral

Trait Implementations

impl<T: U8orU16orU32, INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> FullDuplex<T> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

Full-duplex implementation for writing/reading via SPI

Note: these functions do not lock the frequency of the APB bus, so transactions may be at lower frequency if APB bus is not locked in caller.

type Error = Error

An enumeration of SPI errors

fn read(&mut self) -> Result<T, Error>

Reads the word stored in the shift register

fn send(&mut self, value: T) -> Result<(), Error>

Sends a word to the slave

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> Transfer<u16> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

type Error = Error

Error type

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

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

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> Transfer<u32> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

type Error = Error

Error type

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

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

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> Transfer<u8> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

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<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> Write<u16> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> Write<u32> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> Write<u8> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

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<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> WriteIter<u16> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

type Error = Error

Error type

fn write_iter<WI>(&mut self, words: WI) -> Result<(), Self::Error> where
    WI: IntoIterator<Item = u16>, 

Sends words to the slave, ignoring all the incoming words

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> WriteIter<u32> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

type Error = Error

Error type

fn write_iter<WI>(&mut self, words: WI) -> Result<(), Self::Error> where
    WI: IntoIterator<Item = u32>, 

Sends words to the slave, ignoring all the incoming words

impl<INSTANCE: Instance, SCLK: OutputPin, SDO: OutputPin, SDI: InputPin + OutputPin, CS: OutputPin> WriteIter<u8> for SPI<INSTANCE, SCLK, SDO, SDI, CS>

type Error = Error

Error type

fn write_iter<WI>(&mut self, words: WI) -> Result<(), Self::Error> where
    WI: IntoIterator<Item = u8>, 

Sends words to the slave, ignoring all the incoming words