modified of rmt interface for simpler/easier usage

Author: david-cermak

Diff for: cores/esp32/esp32-hal-rmt.c

@@ -91,6 +91,9 @@ static xSemaphoreHandle g_rmt_block_lock = NULL;
 
 static void _initPin(int pin, int channel, bool tx_not_rx);
 
+static bool _rmtSendOnce(rmt_obj_t* rmt, uint32_t* data, size_t size);
+
+
 static void IRAM_ATTR _rmt_isr(void* arg);
 
 
@@ -125,16 +128,17 @@ bool rmtDeinit(rmt_obj_t *rmt)
     return true;
 }
 
-bool rmtSendQueued(rmt_obj_t* rmt, uint32_t* data, size_t size)
+bool rmtSent(rmt_obj_t* rmt, uint32_t* data, size_t size)
 {
     if (!rmt) {
         return false;
     }
 
     int channel = rmt->channel;
+    int allocated_size = 64 * rmt->buffers;
+
+    if (size > allocated_size) {
 
-    if (size > MAX_DATA_PER_ITTERATION) {
-    // if (size > MAX_DATA_PER_CHANNEL) {
         int half_tx_nr = MAX_DATA_PER_ITTERATION/2;
         RMT_MUTEX_LOCK(channel);
         // setup interrupt handler if not yet installed for half and full tx
@@ -172,10 +176,10 @@ bool rmtSendQueued(rmt_obj_t* rmt, uint32_t* data, size_t size)
         RMT_MUTEX_UNLOCK(channel);
 
         // start the transation
-        return rmtSend(rmt, data, MAX_DATA_PER_ITTERATION);
+        return _rmtSendOnce(rmt, data, MAX_DATA_PER_ITTERATION);
     } else {
         // use one-go mode if data fits one buffer 
-        return rmtSend(rmt, data, size);
+        return _rmtSendOnce(rmt, data, size);
     }
 }
 
@@ -269,7 +273,7 @@ bool rmtReceiveAsync(rmt_obj_t* rmt, size_t idle_thres, uint32_t* data, size_t s
 }
 
 
-bool rmtSend(rmt_obj_t* rmt, uint32_t* data, size_t size)
+bool _rmtSendOnce(rmt_obj_t* rmt, uint32_t* data, size_t size)
 {
     if (!rmt) {
         return false;
@@ -339,9 +343,9 @@ float rmtSetTick(rmt_obj_t* rmt, float tick)
     }
 }
 
-rmt_obj_t* rmtInit(int pin, bool tx_not_rx, int entries, int period)
+rmt_obj_t* rmtInit(int pin, bool tx_not_rx, rmt_reserve_memsize_t memsize)
 {
-    int buffers = 1 + entries/MAX_DATA_PER_CHANNEL;
+    int buffers = memsize;
     rmt_obj_t* rmt;
     size_t i;
     size_t j;

Diff for: cores/esp32/esp32-hal-rmt.h

@@ -10,13 +10,24 @@ extern "C" {
 
 struct rmt_obj_s;
 
+typedef enum {
+    e_reserve_64_items =  1,
+    e_reserve_128_items = 2,
+    e_reserve_192_items = 3,
+    e_reserve_256_items = 4,
+    e_reserve_320_items = 5,
+    e_reserve_384_items = 6,
+    e_reserve_448_items = 7,
+    e_reserve_512_items = 8,
+} rmt_reserve_memsize_t;
+
 typedef struct rmt_obj_s rmt_obj_t;
 
 /**
 *    Initialize the object
 *
 */
-rmt_obj_t* rmtInit(int pin, bool tx_not_rx, int entries, int period);
+rmt_obj_t* rmtInit(int pin, bool tx_not_rx, rmt_reserve_memsize_t memsize);
 
 /**
 *    Sets the clock/divider of timebase the nearest tick to the supplied value in nanoseconds
@@ -25,22 +36,17 @@ rmt_obj_t* rmtInit(int pin, bool tx_not_rx, int entries, int period);
 float rmtSetTick(rmt_obj_t* rmt, float tick);
 
 /**
-*    Sending data in one-go mode (more data must span over multiple channels)
+*    Sending data in one-go mode or continual mode
+*     (more data being send while updating buffers in interrupts)
 *
 */
 bool rmtSend(rmt_obj_t* rmt, uint32_t* data, size_t size);
 
-/**
-*    Sending data in one-go mode (more data being send while updating buffers in interrupts)
-*
-*/
-bool rmtSendQueued(rmt_obj_t* rmt, uint32_t* data, size_t size);
-
 /**
 *    Initiates simple data receive without interrupts
 *
 */
-bool rmtReceive(rmt_obj_t* rmt, size_t idle_thres);
+bool rmtBeginReceive(rmt_obj_t* rmt, size_t idle_thres);
 
 /**
 *    Wait method for synchronous receive
@@ -54,11 +60,10 @@ bool rmtWaitForData(rmt_obj_t* rmt, uint32_t* data, size_t size);
 */
 bool rmtReceiveAsync(rmt_obj_t* rmt, size_t idle_thres, uint32_t* data, size_t size, void* event_flags);
 
-
-
 // TODO:
+//  * add timeout to waiForData
+//  * try to eliminate idle_thres from the receiving functions
 //  * carrier interface
-//  * mutexes
 //  * uninstall interrupt when all channels are deinit
 //  * send only-conti mode with circular-buffer
 //  * put sanity checks to some macro or inlines