Struct microbit::hal::spim::Spim

pub struct Spim<T>(_);

Interface to a SPIM instance.

This is a very basic interface that comes with the following limitations:

• The SPIM instances share the same address space with instances of SPIS, SPI, TWIM, TWIS, and TWI. You need to make sure that conflicting instances are disabled before using Spim. See product specification, section 15.2.

Implementations

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

pub fn new(
    spim: T,
    pins: Pins,
    frequency: FREQUENCY_A,
    mode: Mode,
    orc: u8
) -> Spim<T>

pub fn transfer(
    &mut self,
    chip_select: &mut Pin<Output<PushPull>>,
    buffer: &mut [u8]
) -> Result<(), Error>

Read and write from a SPI slave, using a single buffer.

This method implements a complete read transaction, which consists of the master transmitting what it wishes to read, and the slave responding with the requested data.

Uses the provided chip select pin to initiate the transaction. Transmits all bytes in buffer, then receives an equal number of bytes.

pub fn transfer_split_even(
    &mut self,
    chip_select: &mut Pin<Output<PushPull>>,
    tx_buffer: &[u8],
    rx_buffer: &mut [u8]
) -> Result<(), Error>

Read and write from a SPI slave, using separate read and write buffers.

This method implements a complete read transaction, which consists of the master transmitting what it wishes to read, and the slave responding with the requested data.

Uses the provided chip select pin to initiate the transaction. Transmits all bytes in tx_buffer, then receives bytes until rx_buffer is full.

If tx_buffer.len() != rx_buffer.len(), the transaction will stop at the smaller of either buffer.

pub fn transfer_split_uneven(
    &mut self,
    chip_select: &mut Pin<Output<PushPull>>,
    tx_buffer: &[u8],
    rx_buffer: &mut [u8]
) -> Result<(), Error>

Read and write from a SPI slave, using separate read and write buffers.

This method implements a complete read transaction, which consists of the master transmitting what it wishes to read, and the slave responding with the requested data.

Uses the provided chip select pin to initiate the transaction. Transmits all bytes in tx_buffer, then receives bytes until rx_buffer is full.

This method is more complicated than the other transfer methods because it is allowed to perform transactions where tx_buffer.len() != rx_buffer.len(). If this occurs, extra incoming bytes will be discarded, OR extra outgoing bytes will be filled with the orc value.

pub fn write(
    &mut self,
    chip_select: &mut Pin<Output<PushPull>>,
    tx_buffer: &[u8]
) -> Result<(), Error>

Write to an SPI slave.

This method uses the provided chip select pin to initiate the transaction, then transmits all bytes in tx_buffer. All incoming bytes are discarded.

pub fn free(self) -> T

Return the raw interface to the underlying SPIM peripheral.

Trait Implementations

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

type Error = Error

Error type

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

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

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

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words