Struct SpidevDevice

pub struct SpidevDevice(pub Spidev);

Spidev wrapper providing the embedded-hal SpiDevice trait.

Use this struct when you want a single spidev device, using a Linux-managed CS (chip-select) pin, which is already defined in your device tree. Linux will handle sharing the bus between different SPI devices, even between different processes.

You get an object that implements SpiDevice, which is what most drivers require, but does not implement SpiBus. In some rare cases, you may require SpiBus instead; for that refer to SpidevBus below. You may also want to use SpiBus if you want to handle all the CS pins yourself using GPIO.

This struct wraps a spidev::Spidev struct, so it can be constructed directly and the inner struct accessed if needed, for example to (re)configure the SPI settings.

Note that delay operations on this device are capped to 65535 microseconds.

Tuple Fields

0: Spidev

Implementations

impl SpidevDevice

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

where P: AsRef<Path>,

See spidev::Spidev::open for details.

The provided path is for the specific device you wish to access. Access to the bus is shared with other devices via the Linux kernel.

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 SpidevDevice

type Target = Spidev

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for SpidevDevice

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

Mutably dereferences the value.

impl ErrorType for SpidevDevice

type Error = SPIError

Error type.

impl SpiDevice for SpidevDevice

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

Perform a transaction against the device.

Delay operations are capped to 65535 microseconds.

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

Do a read within a transaction.

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

Do a write within a transaction.

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

Do a transfer within a transaction.

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

Do an in-place transfer within a transaction.