RMT refactoring based on IDF (espressif#6024)

Summary

RMT HAL refactoring based on IDF.

Impact

Improves RMT by adding IDF v4.4 support.
Receiving RMT can handle any size of data.
rmtInit() has a new parameter - RxBufferSize - to hold any number of data when receiving RMT.
rmtWrite() has a new parameter - wait_tx_done - to block writing until sending all data.

Related links

fix espressif#5905

Author: SuGlider

cores/esp32/esp32-hal-rmt.c

@@ -25,6 +25,9 @@ extern "C" {
 #define RMT_FLAG_ERROR       (4)
 #define RMT_FLAGS_ALL        (RMT_FLAG_TX_DONE | RMT_FLAG_RX_DONE | RMT_FLAG_ERROR)
 
+#define RMT_TX_MODE      true
+#define RMT_RX_MODE      false
+
 struct rmt_obj_s;
 
 typedef enum {
@@ -54,6 +57,13 @@ typedef struct {
     };
 } rmt_data_t;
 
+
+/**
+*    Prints object information
+*
+*/
+void _rmtDumpStatus(rmt_obj_t* rmt);
+
 /**
 *    Initialize the object
 *
@@ -69,10 +79,17 @@ float rmtSetTick(rmt_obj_t* rmt, float tick);
 /**
 *    Sending data in one-go mode or continual mode
 *     (more data being send while updating buffers in interrupts)
-*
+*    Non-Blocking mode - returns right after executing
 */
 bool rmtWrite(rmt_obj_t* rmt, rmt_data_t* data, size_t size);
 
+/**
+*    Sending data in one-go mode or continual mode
+*     (more data being send while updating buffers in interrupts)
+*    Blocking mode - only returns when data has been sent
+*/
+bool rmtWriteBlocking(rmt_obj_t* rmt, rmt_data_t* data, size_t size);
+
 /**
 *    Loop data up to the reserved memsize continuously
 *

cores/esp32/esp32-hal-rmt.h

@@ -12,7 +12,7 @@ class MyProcessor {
 
   public:
     MyProcessor(uint8_t pin, float nanoTicks) {
-      assert((rmt_recv = rmtInit(21, false, RMT_MEM_192)));
+      assert((rmt_recv = rmtInit(21, RMT_RX_MODE, RMT_MEM_192)));
 
       realNanoTick = rmtSetTick(rmt_recv, nanoTicks);
     };
@@ -61,4 +61,4 @@ void loop()
 {
   Serial.printf("GPIO 4: %08x 5: %08x 6: %08x\n", mp1.val(), mp2.val(), mp3.val());
   delay(500);
-}
+}

libraries/ESP32/examples/RMT/RMTCallback/RMTCallback.ino

@@ -5,6 +5,17 @@
 
 #include "esp32-hal.h"
 
+#if CONFIG_IDF_TARGET_ESP32C3
+// ESP32 C3 has only 2 channels for RX and 2 for TX, thus MAX RMT_MEM is 128
+#define RMT_TX_PIN 4
+#define RMT_RX_PIN 5
+#define RMT_MEM_RX RMT_MEM_128
+#else 
+#define RMT_TX_PIN 18
+#define RMT_RX_PIN 21
+#define RMT_MEM_RX RMT_MEM_192
+#endif
+
 rmt_data_t my_data[256];
 rmt_data_t data[256];
 
@@ -18,18 +29,19 @@ void setup()
     Serial.begin(115200);
     events = xEventGroupCreate();
 
-    if ((rmt_send = rmtInit(18, true, RMT_MEM_64)) == NULL)
+    if ((rmt_send = rmtInit(RMT_TX_PIN, RMT_TX_MODE, RMT_MEM_64)) == NULL)
     {
         Serial.println("init sender failed\n");
     }
-    if ((rmt_recv = rmtInit(21, false, RMT_MEM_192)) == NULL)
+    if ((rmt_recv = rmtInit(RMT_RX_PIN, RMT_RX_MODE, RMT_MEM_RX)) == NULL)
     {
         Serial.println("init receiver failed\n");
     }
 
     float realTick = rmtSetTick(rmt_send, 100);
     printf("real tick set to: %fns\n", realTick);
-
+    // both will keep same tick 
+    realTick = rmtSetTick(rmt_recv, 100);
 }
 
 void loop() 

libraries/ESP32/examples/RMT/RMTLoopback/RMTLoopback.ino

@@ -182,7 +182,7 @@ void setup()
     Serial.begin(115200);
 
     // Initialize the channel to capture up to 192 items
-    if ((rmt_recv = rmtInit(21, false, RMT_MEM_192)) == NULL)
+    if ((rmt_recv = rmtInit(21, RMT_RX_MODE, RMT_MEM_192)) == NULL)
     {
         Serial.println("init receiver failed\n");
     }

libraries/ESP32/examples/RMT/RMTReadXJT/RMTReadXJT.ino

@@ -41,7 +41,7 @@ void setup()
 {
     Serial.begin(115200);
 
-    if ((rmt_send = rmtInit(18, true, RMT_MEM_64)) == NULL)
+    if ((rmt_send = rmtInit(18, RMT_TX_MODE, RMT_MEM_64)) == NULL)
     {
         Serial.println("init sender failed\n");
     }