Struct ftdi_embedded_hal::Spi

pub struct Spi<'a, Device: MpsseCmdExecutor> { /* private fields */ }

FTDI SPI bus.

In embedded-hal version 1 this represents an exclusive SPI bus.

This is created by calling FtHal::spi.

Implementations

impl<'a, Device, E> Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

pub fn set_clock_polarity<P: Into<Polarity>>(&mut self, cpol: P)

Set the SPI clock polarity.

FTD2XX devices only supports SPI mode 0 and 2, clock phase is fixed.

Example

use eh1::spi::Polarity;
use ftdi_embedded_hal as hal;

let device = libftd2xx::Ft2232h::with_description("Dual RS232-HS A")?;
let hal = hal::FtHal::init_freq(device, 3_000_000)?;
let mut spi = hal.spi()?;
spi.set_clock_polarity(Polarity::IdleLow);

Trait Implementations

impl<'a, Device: Debug + MpsseCmdExecutor> Debug for Spi<'a, Device>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, Device, E> ErrorType for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

type Error = Error<E>

Error type

impl<'a, Device, E> FullDuplex<u8> for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

type Error = Error<E>

An enumeration of SPI errors

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

Reads the word stored in the shift register

fn send(&mut self, byte: u8) -> Result<(), Error<E>>

Sends a word to the slave

impl<'a, Device, E> FullDuplex<u8> for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

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

Reads the word stored in the shift register

fn write(&mut self, byte: u8) -> Result<(), Error<E>>

Writes a word to the slave

impl<'a, Device, E> SpiBus<u8> for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

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

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.

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

Write and read simultaneously. write is written to the slave on MOSI and words received on MISO are stored in read.

impl<'a, Device, E> SpiBusFlush for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

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

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

impl<'a, Device, E> SpiBusRead<u8> for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

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

Read words from the slave.

impl<'a, Device, E> SpiBusWrite<u8> for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

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

Write words to the slave, ignoring all the incoming words

impl<'a, Device, E> Transfer<u8> for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

type Error = Error<E>

Error type

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

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

impl<'a, Device, E> Write<u8> for Spi<'a, Device>where
    Device: MpsseCmdExecutor<Error = E>,
    E: Error,
    Error<E>: From<E>,

type Error = Error<E>

Error type

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

Sends words to the slave, ignoring all the incoming words