Struct linux_embedded_hal::Spidev

pub struct Spidev(pub Spidev);

Newtype around spidev::Spidev that implements the embedded-hal traits

Tuple Fields

0: Spidev

Implementations

impl Spidev

pub fn open<P>(path: P) -> Result<Self, SPIError> where
    P: AsRef<Path>, 

See spidev::Spidev::open for details.

Methods from Deref<Target = Spidev>

pub fn inner(&self) -> &File

Get a reference to the underlying File object

pub fn configure(&mut self, options: &SpidevOptions) -> Result<(), Error>

Write the provided configuration to this device

pub fn transfer(
    &self,
    transfer: &mut spi_ioc_transfer<'_, '_>
) -> Result<(), Error>

Perform a single transfer

pub fn transfer_multiple(
    &self,
    transfers: &mut [spi_ioc_transfer<'_, '_>]
) -> Result<(), Error>

Perform multiple transfers in a single system call to the kernel

Chaining together multiple requests like this can reduce latency and be used for conveniently and efficient implementing some protocols without extra round trips back to userspace.

Trait Implementations

impl Deref for Spidev

type Target = Spidev

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Spidev

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl ErrorType for Spidev

type Error = SPIError

Error type

impl SpiBus<u8> for Spidev

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.

impl SpiBusFlush for Spidev

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

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

impl SpiBusRead<u8> for Spidev

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

Read words from the slave.

impl SpiBusWrite<u8> for Spidev

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

Write words to the slave, ignoring all the incoming words

impl SpiDevice for Spidev

type Bus = Spidev

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
    Word: Copy,
    Self::Bus: SpiBusWrite<Word>, 

Do a write within a transaction.

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

Do a read within a transaction.

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

Do a transfer within a transaction.

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

Do an in-place transfer within a transaction.