Struct esp_idf_hal::spi::SpiDeviceDriver

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

Implementations

impl<'d> SpiDeviceDriver<'d, SpiDriver<'d>>

pub fn new_single<SPI: SpiAnyPins>(
    spi: impl Peripheral<P = SPI> + 'd,
    sclk: impl Peripheral<P = impl OutputPin> + 'd,
    sdo: impl Peripheral<P = impl OutputPin> + 'd,
    sdi: Option<impl Peripheral<P = impl InputPin + OutputPin> + 'd>,
    dma: Dma,
    cs: Option<impl Peripheral<P = impl OutputPin> + 'd>,
    config: &Config
) -> Result<Self, EspError>

impl<'d, T> SpiDeviceDriver<'d, T>where
    T: Borrow<SpiDriver<'d>> + 'd,

pub fn new(
    driver: T,
    cs: Option<impl Peripheral<P = impl OutputPin> + 'd>,
    config: &Config
) -> Result<Self, EspError>

pub fn device(&self) -> spi_device_handle_t

pub fn transaction<R, E>(
    &mut self,
    f: impl FnOnce(&mut SpiBusDriver<'d>) -> Result<R, E>
) -> Result<R, E>where
    E: From<EspError>,

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

pub fn write(&mut self, write: &[u8]) -> Result<(), EspError>

pub fn read(&mut self, read: &mut [u8]) -> Result<(), EspError>

pub fn transfer_in_place(&mut self, buf: &mut [u8]) -> Result<(), EspError>

Trait Implementations

impl<'d, T> Drop for SpiDeviceDriver<'d, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, T> ErrorType for SpiDeviceDriver<'d, T>

type Error = SpiError

Error type

impl<'d, T> SpiDevice for SpiDeviceDriver<'d, T>where
    T: Borrow<SpiDriver<'d>> + 'd,

type Bus = SpiBusDriver<'d>

SPI Bus type for this device.

fn transaction<R>(
    &mut self,
    f: impl FnOnce(&mut Self::Bus) -> Result<R, <Self::Bus as ErrorType>::Error>
) -> Result<R, Self::Error>

Perform a transaction against the device.

fn write<Word>(&mut self, buf: &[Word]) -> Result<(), Self::Error>where
    Self::Bus: SpiBusWrite<Word>,
    Word: Copy,

Do a write within a transaction.

fn read<Word>(&mut self, buf: &mut [Word]) -> Result<(), Self::Error>where
    Self::Bus: SpiBusRead<Word>,
    Word: Copy,

Do a read within a transaction.

fn transfer<Word>(
    &mut self,
    read: &mut [Word],
    write: &[Word]
) -> Result<(), Self::Error>where
    Self::Bus: SpiBus<Word>,
    Word: Copy,

Do a transfer within a transaction.

fn transfer_in_place<Word>(
    &mut self,
    buf: &mut [Word]
) -> Result<(), Self::Error>where
    Self::Bus: SpiBus<Word>,
    Word: Copy,

Do an in-place transfer within a transaction.

impl<'d, T> Transactional<u8> for SpiDeviceDriver<'d, T>where
    T: Borrow<SpiDriver<'d>> + 'd,

type Error = SpiError

Associated error type

fn exec(
    &mut self,
    operations: &mut [Operation<'_, u8>]
) -> Result<(), Self::Error>

Execute the provided transactions

impl<'d, T> Transfer<u8> for SpiDeviceDriver<'d, T>where
    T: Borrow<SpiDriver<'d>> + 'd,

type Error = SpiError

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<'d, T> Write<u8> for SpiDeviceDriver<'d, T>where
    T: Borrow<SpiDriver<'d>> + 'd,

type Error = SpiError

Error type

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

Sends words to the slave, ignoring all the incoming words

impl<'d, T> WriteIter<u8> for SpiDeviceDriver<'d, T>where
    T: Borrow<SpiDriver<'d>> + 'd,

type Error = SpiError

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

impl<'d, T> Send for SpiDeviceDriver<'d, T>where
    T: Send,