spi: Add ESP_ERR_NO_MEM to spi_device_queue_trans() documentation

Ref https://github.com/espressif/esp-idf/pull/1243#issuecomment-343103414
This commit is contained in:
Angus Gratton 2017-11-17 10:52:21 +11:00 committed by Angus Gratton
parent 31711b5ac7
commit f54e99008d

View file

@ -182,9 +182,10 @@ esp_err_t spi_bus_remove_device(spi_device_handle_t handle);
* @param trans_desc Description of transaction to execute * @param trans_desc Description of transaction to execute
* @param ticks_to_wait Ticks to wait until there's room in the queue; use portMAX_DELAY to * @param ticks_to_wait Ticks to wait until there's room in the queue; use portMAX_DELAY to
* never time out. * never time out.
* @return * @return
* - ESP_ERR_INVALID_ARG if parameter is invalid * - 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_ERR_TIMEOUT if there was no room in the queue before ticks_to_wait expired
* - ESP_ERR_NO_MEM if allocating DMA-capable temporary buffer failed
* - ESP_OK on success * - 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); esp_err_t spi_device_queue_trans(spi_device_handle_t handle, spi_transaction_t *trans_desc, TickType_t ticks_to_wait);