From 31711b5ac75e6b2cb05d2554bd9e665cd31b0845 Mon Sep 17 00:00:00 2001 From: Raphael Luba Date: Wed, 8 Nov 2017 13:36:37 +0100 Subject: [PATCH] SPI: Document TIMEOUT return values MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `spi_device_queue_trans` and `spi_device_get_trans_result` can return `ESP_ERR_TIMEOUT` – but this had not been documented. Merges https://github.com/espressif/esp-idf/pull/1243 --- components/driver/include/driver/spi_master.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/components/driver/include/driver/spi_master.h b/components/driver/include/driver/spi_master.h index f43394d3c..2dac55782 100644 --- a/components/driver/include/driver/spi_master.h +++ b/components/driver/include/driver/spi_master.h @@ -184,6 +184,7 @@ esp_err_t spi_bus_remove_device(spi_device_handle_t handle); * never time out. * @return * - ESP_ERR_INVALID_ARG if parameter is invalid + * - ESP_ERR_TIMEOUT if there was no room in the queue before ticks_to_wait expired * - ESP_OK on success */ esp_err_t spi_device_queue_trans(spi_device_handle_t handle, spi_transaction_t *trans_desc, TickType_t ticks_to_wait); @@ -205,6 +206,7 @@ esp_err_t spi_device_queue_trans(spi_device_handle_t handle, spi_transaction_t * out. * @return * - ESP_ERR_INVALID_ARG if parameter is invalid + * - ESP_ERR_TIMEOUT if there was no completed transaction before ticks_to_wait expired * - ESP_OK on success */ esp_err_t spi_device_get_trans_result(spi_device_handle_t handle, spi_transaction_t **trans_desc, TickType_t ticks_to_wait);