]> granicus.if.org Git - esp-idf/commitdiff
spi: Add ESP_ERR_NO_MEM to spi_device_queue_trans() documentation
authorAngus Gratton <angus@espressif.com>
Thu, 16 Nov 2017 23:52:21 +0000 (10:52 +1100)
committerAngus Gratton <gus@projectgus.com>
Mon, 20 Nov 2017 05:06:59 +0000 (16:06 +1100)
Ref https://github.com/espressif/esp-idf/pull/1243#issuecomment-343103414

components/driver/include/driver/spi_master.h

index 2dac55782addada56ce14615391b7c892c5e5988..4e5b66f62886dddd3c249e6fe55fccc6e47e772f 100644 (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 ticks_to_wait Ticks to wait until there's room in the queue; use portMAX_DELAY to
  *                      never time out.
- * @return 
+ * @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_ERR_NO_MEM        if allocating DMA-capable temporary buffer failed
  *         - 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);