essl_spi_read_reg() function

Read from the shared registers

Syntax

Show:

Summary

Declaration

Definition

from essl_spi.h:72

esp_err_t essl_spi_read_reg(void *arg, uint8_t addr, uint8_t *out_value, uint32_t wait_ms);

Implemented in essl_spi.c:315

Arguments

Argument

Description

arg

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

addr

Address of the shared registers. (Valid: 0 ~ SOC_SPI_MAXIMUM_BUFFER_SIZE, registers for M/S sync are reserved, see note1).

out_value

Read buffer for the shared registers.

wait_ms

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

Return value

- ESP_OK: success - ESP_ERR_INVALID_STATE: ESSL SPI has not been initialized. - ESP_ERR_INVALID_ARG: The address argument is not valid. See note 1. - or other return value from :cpp:func:`spi_device_transmit`.

Notes

The registers for Master/Slave synchronization are reserved. Do not use them. (see `rx_sync_reg` in `essl_spi_config_t`)

Examples

References

from examples

essl_spi_read_reg() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle