Symbols

Files

loading (2/4)...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and Exampleshost sampleessl_spi_rdbuf_polling()

essl_spi_rdbuf_polling() function

Read the shared buffer from the slave in polling way

Syntax

Show:

Summary

Declaration

Definition

from essl_spi.h:175

esp_err_t essl_spi_rdbuf_polling(spi_device_handle_t spi, uint8_t *out_data, int addr, int len, uint32_t flags);

Implemented in essl_spi.c:115

Arguments

Argument

Description

spi

SPI device handle representing the slave

out_data

Buffer for read data, strongly suggested to be in the DRAM and aligned to 4

addr

Address of the slave shared buffer

len

Length to read

flags

`SPI_TRANS_*` flags to control the transaction mode of the transaction to send.

Return value

- ESP_OK: on success - or other return value from :cpp:func:`spi_device_transmit`.

Notes

``out_data`` should be prepared in words and in the DRAM. The buffer may be written in words by the DMA. When a byte is written, the remaining bytes in the same word will also be overwritten, even the ``len`` is shorter than a word.

References

Code

Location

Referrer

esp_err_t essl_spi_rdbuf_polling(spi_device_handle_t spi, uint8_t *out_data, int addr, int len, uint32_t flags)

essl_spi.c:115

esp_err_t essl_spi_rdbuf_polling(spi_device_handle_t spi, uint8_t *out_data, int addr, int len, uint32_t flags);

essl_spi.h:175

ret = essl_spi_rdbuf_polling(ctx->spi, (uint8_t *)&previous_size, ctx->master_in.rx_sync_reg, sizeof(uint32_t), 0);

essl_spi.c:342

essl_spi_update_rx_data_size()

ret = essl_spi_rdbuf_polling(ctx->spi, (uint8_t *)&updated_size, ctx->master_in.rx_sync_reg, sizeof(uint32_t), 0);

essl_spi.c:353

essl_spi_update_rx_data_size()

ret = essl_spi_rdbuf_polling(ctx->spi, (uint8_t *)&previous_size, ctx->master_out.tx_sync_reg, sizeof(uint32_t), 0);

essl_spi.c:432

essl_spi_update_tx_buffer_num()

ret = essl_spi_rdbuf_polling(ctx->spi, (uint8_t *)&updated_num, ctx->master_out.tx_sync_reg, sizeof(uint32_t), 0);

essl_spi.c:443

essl_spi_update_tx_buffer_num()

Call Tree

essl_spi_rdbuf_polling() is called by 2 functions and calls 3 functions:

essl_spi_update_rx_data_size()

essl_spi_update_tx_buffer_num()

essl_spi_rdbuf_polling()

spi_device_polling_transmit()

get_hd_dummy_bits()

get_hd_command()

Data Use

essl_spi_rdbuf_polling() reads 1 variable:

spi_command_t::SPI_CMD_HD_RDBUF

essl_spi_rdbuf_polling()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out