spi_slave_hd_get_trans_res() function

Get the result of a data transaction (segment mode)

Syntax

Show:

Summary

Declaration

from spi_slave_hd.h:149

esp_err_t spi_slave_hd_get_trans_res(spi_host_device_t host_id, spi_slave_chan_t chan, spi_slave_hd_data_t **out_trans, TickType_t timeout);

Arguments

Argument

Description

host_id

Host to queue the transaction

chan

Channel to get the result, SPI_SLAVE_CHAN_TX or SPI_SLAVE_CHAN_RX

out_trans

Pointer to the transaction descriptor (``spi_slave_hd_data_t``) passed to the driver before. Hardware has finished this transaction. Member ``trans_len`` indicates the actual number of bytes of received data, it's meaningless for TX.

timeout

Timeout before the result is got

Return value

- ESP_OK: on success - ESP_ERR_INVALID_ARG: Function is not valid - ESP_ERR_TIMEOUT: There's no transaction done before timeout - ESP_ERR_INVALID_STATE: Function called in invalid state. This API should be called under segment mode.

Notes

This API should be called successfully the same times as the ``spi_slave_hd_queue_trans``.

Examples

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

References

from examples

spi_slave_hd_get_trans_res() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle