spi_slave_initialize() function

Initialize a SPI bus as a slave interface @warning SPI0/1 is not supported @warning If a DMA channel is selected, any transmit and receive buffer used should be allocated in DMA-capable memory. @warning The ISR of SPI is always executed on the core which calls this function. Never starve the ISR on this core or the SPI transactions will not be handled.

Syntax

Show:

Summary

Declaration

Definition

from spi_slave.h:109

esp_err_t spi_slave_initialize(spi_host_device_t host, const spi_bus_config_t *bus_config, const spi_slave_interface_config_t *slave_config, spi_dma_chan_t dma_chan);

Implemented in spi_slave.c:132

Arguments

Argument

Declared as

Description

host

spi_host_device_t

SPI peripheral to use as a SPI slave interface

bus_config

const spi_bus_config_t *

Pointer to a spi_bus_config_t struct specifying how the host should be initialized

slave_config

const spi_slave_interface_config_t *

Pointer to a spi_slave_interface_config_t struct specifying the details for the slave interface

dma_chan

spi_dma_chan_t

- Selecting a DMA channel for an SPI bus allows transactions on the bus with size only limited by the amount of internal memory. - Selecting SPI_DMA_DISABLED limits the size of transactions. - Set to SPI_DMA_DISABLED if only the SPI flash uses this bus. - Set to SPI_DMA_CH_AUTO to let the driver to allocate the DMA channel.

Return value

- ESP_ERR_INVALID_ARG if configuration is invalid - ESP_ERR_INVALID_STATE if host already is in use - ESP_ERR_NOT_FOUND if there is no available DMA channel - ESP_ERR_NO_MEM if out of memory - ESP_OK on success

Examples

spi_slave_initialize() is referenced by 1 libraries and example projects:

References

from examples

spi_slave_initialize() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle