feature(spi_ram_fifo): add timetick

xiongyumail · xiongyumail · commit 42c06647ba6a · 2019-06-12T11:06:26.000+08:00
diff --git a/components/spi_ram/include/spi_ram_fifo.h b/components/spi_ram/include/spi_ram_fifo.h
@@ -41,13 +41,15 @@ typedef struct {
   * @param handle spi ram fifo handle
   * @param data Pointer to the write data buffer
   * @param len Length of write data, range: len > 0
+  * @param timeout_ticks freertos timeout ticks
   *
   * @return
   *     - ESP_OK Success
   *     - ESP_ERR_INVALID_ARG Parameter error
+  *     - ESP_ERR_TIMEOUT spi ram fifo write timeout
   *     - ESP_FAIL spi ram fifo not created yet
   */
-esp_err_t spi_ram_fifo_write(spi_ram_fifo_handle_t handle, uint8_t *data, int len);
+esp_err_t spi_ram_fifo_write(spi_ram_fifo_handle_t handle, uint8_t *data, int len, uint32_t timeout_ticks);
 
 /**
   * @brief spi ram fifo read function
@@ -57,13 +59,15 @@ esp_err_t spi_ram_fifo_write(spi_ram_fifo_handle_t handle, uint8_t *data, int le
   * @param handle spi ram fifo handle
   * @param data Pointer to the read data buffer
   * @param len Length of read data, range: len > 0
+  * @param timeout_ticks freertos timeout ticks
   *
   * @return
   *     - ESP_OK Success
   *     - ESP_ERR_INVALID_ARG Parameter error
+  *     - ESP_ERR_TIMEOUT spi ram fifo read timeout
   *     - ESP_FAIL spi ram fifo not created yet
   */
-esp_err_t spi_ram_fifo_read(spi_ram_fifo_handle_t handle, uint8_t *data, int len);
+esp_err_t spi_ram_fifo_read(spi_ram_fifo_handle_t handle, uint8_t *data, int len, uint32_t timeout_ticks);
 
 /**
   * @brief Get spi ram fifo filled length
diff --git a/components/spi_ram/spi_ram_fifo.c b/components/spi_ram/spi_ram_fifo.c
@@ -45,7 +45,7 @@ typedef struct {
         return (ret_val); \
     }
 
-esp_err_t spi_ram_fifo_write(spi_ram_fifo_handle_t handle, uint8_t *data, int len)
+esp_err_t spi_ram_fifo_write(spi_ram_fifo_handle_t handle, uint8_t *data, int len, uint32_t timeout_ticks)
 {
     spi_ram_fifo_obj_t *obj = (spi_ram_fifo_obj_t *)handle;
     int n;
@@ -69,7 +69,10 @@ esp_err_t spi_ram_fifo_write(spi_ram_fifo_handle_t handle, uint8_t *data, int le
             // Not enough free room in FIFO. Wait till there's some read and try again.
             obj->overflow_num++;
             xSemaphoreGive(obj->mux);
-            xSemaphoreTake(obj->write_sem, portMAX_DELAY);
+            if (pdFALSE == xSemaphoreTake(obj->write_sem, timeout_ticks)) {
+                xSemaphoreGive(obj->mux);
+                return ESP_ERR_TIMEOUT;
+            }
         } else {
             //Write the data.
             spi_ram_write(obj->ram_num, obj->start_addr + obj->write_pos, data, n);
@@ -90,7 +93,7 @@ esp_err_t spi_ram_fifo_write(spi_ram_fifo_handle_t handle, uint8_t *data, int le
     return ESP_OK;
 }
 
-esp_err_t spi_ram_fifo_read(spi_ram_fifo_handle_t handle, uint8_t *data, int len)
+esp_err_t spi_ram_fifo_read(spi_ram_fifo_handle_t handle, uint8_t *data, int len, uint32_t timeout_ticks)
 {
     spi_ram_fifo_obj_t *obj = (spi_ram_fifo_obj_t *)handle;
     int n;
@@ -114,7 +117,10 @@ esp_err_t spi_ram_fifo_read(spi_ram_fifo_handle_t handle, uint8_t *data, int len
             // Not enough data in FIFO. Wait till there's some written and try again.
             obj->underrun_num++;
             xSemaphoreGive(obj->mux);
-            xSemaphoreTake(obj->read_sem, portMAX_DELAY);
+            if (pdFALSE == xSemaphoreTake(obj->read_sem, timeout_ticks)) {
+                xSemaphoreGive(obj->mux);
+                return ESP_ERR_TIMEOUT;
+            }
         } else {
             // Read the data.
             spi_ram_read(obj->ram_num, obj->start_addr + obj->read_pos, data, n);
