Symbols

loading...

Files

loading...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and Exampleshost sampleessl_spi_get_packet()

essl_spi_get_packet() function

Get a packet from Slave

Syntax

Show:

Summary

Declaration

Definition

from essl_spi.h:87

esp_err_t essl_spi_get_packet(void *arg, void *out_data, size_t size, uint32_t wait_ms);

Implemented in essl_spi.c:366

Arguments

Argument

Description

arg

Context of the component. (Member ``arg`` from ``essl_handle_t``)

out_data

Output data address

size

The size of the output data.

wait_ms

Time to wait before timeout (reserved for future use, user should set this to 0).

Return value

- ESP_OK: On Success - ESP_ERR_INVALID_STATE: ESSL SPI has not been initialized. - ESP_ERR_INVALID_ARG: The output data address is neither DMA capable nor 4 byte-aligned - ESP_ERR_INVALID_SIZE: Master requires ``size`` bytes of data but Slave did not load enough bytes.

References

Code

Location

Referrer

esp_err_t essl_spi_get_packet(void *arg, void *out_data, size_t size, uint32_t wait_ms)

esp_err_t essl_spi_get_packet(void *arg, void *out_data, size_t size, uint32_t wait_ms);

*dev = ESSL_SPI_DEFAULT_DEV_FUNC();

essl_spi_init_dev()

Call Tree

essl_spi_get_packet() calls 6 functions:

essl_spi_get_packet()

esp_ptr_dma_capable()

esp_log_timestamp()

esp_log_write()

essl_spi_rddma_seg()

essl_spi_get_rx_data_size()

essl_spi_update_rx_data_size()

Data Use

essl_spi_get_packet() reads 10 variables and writes 2 variables:

esp_log_level_t::ESP_LOG_ERROR

esp_log_level_t::ESP_LOG_WARN

esp_log_level_t::ESP_LOG_INFO

esp_log_level_t::ESP_LOG_DEBUG

esp_log_level_t::ESP_LOG_VERBOSE

essl_spi_context_t::spi

essl_spi_context_t::::received_bytes

essl_spi_context_t::::slave_tx_bytes

essl_spi_context_t::master_in

essl_spi_get_packet()

essl_spi_init_dev()

essl_spi_context_t::::received_bytes

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

All items filtered out

All items filtered out