Struct esp32c2_hal::spi::Spi

source ·

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

Implementations

source

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

source

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.

source

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.

source

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.

source

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…)

source

pub fn change_bus_frequency(
 &mut self,
 frequency: Rate<u32, 1, 1>,
 clocks: &Clocks
)

source

pub fn free(self) -> T

Return the raw interface to the underlying peripheral instance

Trait Implementations

source

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

type Error = Error

An enumeration of SPI errors

source

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

Reads the word stored in the shift register Read more

source

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

Sends a word to the slave

source

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

type Error = Error

Error type

source

fn transfer<'w>(
&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

source

impl<T, RX, TX, P> WithDmaSpi2<T, RX, TX, P> for Spi<T>where
 T: Instance + Spi2Instance,
 TX: Tx,
 RX: Rx,
 P: SpiPeripheral + Spi2Peripheral,

source

fn with_dma(self, channel: Channel<TX, RX, P>) -> SpiDma<T, TX, RX, P>

source

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

type Error = Error

Error type

source

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

Sends words to the slave, ignoring all the incoming words

Auto Trait Implementations

impl<T> RefUnwindSafe for Spi<T>where
T: RefUnwindSafe,

impl<T> Send for Spi<T>where
T: Send,

impl<T> Sync for Spi<T>where
T: Sync,

impl<T> Unpin for Spi<T>where
T: Unpin,

impl<T> UnwindSafe for Spi<T>where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct esp32c2_hal::spi::Spi

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,

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,

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,

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,

pub fn change_bus_frequency( &mut self, frequency: Rate<u32, 1, 1>, clocks: &Clocks)

pub fn free(self) -> T

Trait Implementations

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

type Error = Error

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

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

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

type Error = Error

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

impl<T, RX, TX, P> WithDmaSpi2<T, RX, TX, P> for Spi<T>where T: Instance + Spi2Instance, TX: Tx, RX: Rx, P: SpiPeripheral + Spi2Peripheral,

fn with_dma(self, channel: Channel<TX, RX, P>) -> SpiDma<T, TX, RX, P>

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

type Error = Error

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

Auto Trait Implementations

impl<T> RefUnwindSafe for Spi<T>where T: RefUnwindSafe,

impl<T> Send for Spi<T>where T: Send,

impl<T> Sync for Spi<T>where T: Sync,

impl<T> Unpin for Spi<T>where T: Unpin,

impl<T> UnwindSafe for Spi<T>where T: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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,

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,

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,

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,

pub fn change_bus_frequency(
&mut self,
frequency: Rate<u32, 1, 1>,
clocks: &Clocks
)

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

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

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

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

impl<T, RX, TX, P> WithDmaSpi2<T, RX, TX, P> for Spi<T>where
T: Instance + Spi2Instance,
TX: Tx,
RX: Rx,
P: SpiPeripheral + Spi2Peripheral,

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

impl<T> RefUnwindSafe for Spi<T>where
T: RefUnwindSafe,

impl<T> Send for Spi<T>where
T: Send,

impl<T> Sync for Spi<T>where
T: Sync,

impl<T> Unpin for Spi<T>where
T: Unpin,

impl<T> UnwindSafe for Spi<T>where
T: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,