Mistake on this page?
Report an issue in GitHub or email us
Asynchronous SPI Hardware Abstraction Layer


void spi_master_transfer (spi_t *obj, const void *tx, size_t tx_length, void *rx, size_t rx_length, uint8_t bit_width, uint32_t handler, uint32_t event, DMAUsage hint)
 Begin the SPI transfer. More...
uint32_t spi_irq_handler_asynch (spi_t *obj)
 The asynchronous IRQ handler. More...
uint8_t spi_active (spi_t *obj)
 Attempts to determine if the SPI peripheral is already in use. More...
void spi_abort_asynch (spi_t *obj)
 Abort an SPI transfer. More...

Detailed Description

Function Documentation

void spi_abort_asynch ( spi_t obj)

Abort an SPI transfer.

objThe SPI peripheral to stop
uint8_t spi_active ( spi_t obj)

Attempts to determine if the SPI peripheral is already in use.

If a temporary DMA channel has been allocated, peripheral is in use. If a permanent DMA channel has been allocated, check if the DMA channel is in use. If not, proceed as though no DMA channel were allocated. If no DMA channel is allocated, check whether tx and rx buffers have been assigned. For each assigned buffer, check if the corresponding buffer position is less than the buffer length. If buffers do not indicate activity, check if there are any bytes in the FIFOs.

[in]objThe SPI object to check for activity
Non-zero if the SPI port is active or zero if it is not.
uint32_t spi_irq_handler_asynch ( spi_t obj)

The asynchronous IRQ handler.

Reads the received values out of the RX FIFO, writes values into the TX FIFO and checks for transfer termination conditions, such as buffer overflows or transfer complete.

[in]objThe SPI object that holds the transfer information
Event flags if a transfer termination condition was met; otherwise 0.
void spi_master_transfer ( spi_t obj,
const void *  tx,
size_t  tx_length,
void *  rx,
size_t  rx_length,
uint8_t  bit_width,
uint32_t  handler,
uint32_t  event,
DMAUsage  hint 

Begin the SPI transfer.

Buffer pointers and lengths are specified in tx_buff and rx_buff

[in]objThe SPI object that holds the transfer information
[in]txThe transmit buffer
[in]tx_lengthThe number of bytes to transmit
[in]rxThe receive buffer
[in]rx_lengthThe number of bytes to receive
[in]bit_widthThe bit width of buffer words
[in]eventThe logical OR of events to be registered
[in]handlerSPI interrupt handler
[in]hintA suggestion for how to use DMA with this transfer
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.