fix(rmt): GPIO HAL only

Author: SuGlider

cores/esp32/esp32-hal-gpio.c

@@ -17,6 +17,16 @@
 #include "hal/gpio_hal.h"
 #include "soc/soc_caps.h"
 
+// RGB_BUILTIN is defined in pins_arduino.h
+// If RGB_BUILTIN is defined, it will be used as a pin number for the RGB LED
+// If RGB_BUILTIN has a side effect that prevents using RMT Legacy driver in IDF 5.1
+// Define ESP32_ARDUINO_NO_RGB_BUILTIN in build_opt.h or through CLI to disable RGB_BUILTIN
+#ifdef ESP32_ARDUINO_NO_RGB_BUILTIN
+#ifdef RGB_BUILTIN
+#undef RGB_BUILTIN
+#endif
+#endif
+
 // It fixes lack of pin definition for S3 and for any future SoC
 // this function works for ESP32, ESP32-S2 and ESP32-S3 - including the C3, it will return -1 for any pin
 #if SOC_TOUCH_SENSOR_NUM > 0
@@ -151,7 +161,6 @@ uint8_t RGB_BUILTIN_storage = 0;
 #endif
 
 extern void ARDUINO_ISR_ATTR __digitalWrite(uint8_t pin, uint8_t val) {
-#ifndef ESP32_ARDUINO_NEW_RMT_DRV_OFF
 #ifdef RGB_BUILTIN
   if (pin == RGB_BUILTIN) {
     //use RMT to set all channels on/off
@@ -161,7 +170,6 @@ extern void ARDUINO_ISR_ATTR __digitalWrite(uint8_t pin, uint8_t val) {
     return;
   }
 #endif // RGB_BUILTIN
-#endif // ESP32_ARDUINO_NEW_RMT_DRV_OFF
   if (perimanGetPinBus(pin, ESP32_BUS_TYPE_GPIO) != NULL) {
     gpio_set_level((gpio_num_t)pin, val);
   } else {

cores/esp32/esp32-hal-rgb-led.c

@@ -1,7 +1,5 @@
 #include "soc/soc_caps.h"
 
-#ifndef ESP32_ARDUINO_NEW_RMT_DRV_OFF
-
 #include "esp32-hal-rgb-led.h"
 
 void neopixelWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val) {
@@ -42,4 +40,3 @@ void neopixelWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue
   log_e("RMT is not supported on " CONFIG_IDF_TARGET);
 #endif /* SOC_RMT_SUPPORTED */
 }
-#endif /* ESP32_ARDUINO_NEW_RMT_DRV_OFF */

cores/esp32/esp32-hal-rgb-led.h

@@ -1,7 +1,6 @@
 #ifndef MAIN_ESP32_HAL_RGB_LED_H_
 #define MAIN_ESP32_HAL_RGB_LED_H_
 
-#ifndef ESP32_ARDUINO_NEW_RMT_DRV_OFF
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -19,4 +18,3 @@ void neopixelWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue
 #endif
 
 #endif /* MAIN_ESP32_HAL_RGB_LED_H_ */
-#endif /* ESP32_ARDUINO_NEW_RMT_DRV_OFF */

cores/esp32/esp32-hal-rmt.c

@@ -13,7 +13,6 @@
 // limitations under the License.
 
 #include "soc/soc_caps.h"
-#ifndef ESP32_ARDUINO_NEW_RMT_DRV_OFF
 
 #if SOC_RMT_SUPPORTED
 #include "esp32-hal.h"
@@ -629,4 +628,3 @@ bool rmtInit(int pin, rmt_ch_dir_t channel_direction, rmt_reserve_memsize_t mem_
 }
 
 #endif /* SOC_RMT_SUPPORTED */
-#endif /* ESP32_ARDUINO_NEW_RMT_DRV_OFF */

cores/esp32/esp32-hal-rmt.h

@@ -16,7 +16,6 @@
 #define MAIN_ESP32_HAL_RMT_H_
 
 #include "soc/soc_caps.h"
-#ifndef ESP32_ARDUINO_NEW_RMT_DRV_OFF
 
 #if SOC_RMT_SUPPORTED
 
@@ -236,4 +235,3 @@ bool rmtDeinit(int pin);
 
 #endif /* SOC_RMT_SUPPORTED */
 #endif /* MAIN_ESP32_HAL_RMT_H_ */
-#endif /* ESP32_ARDUINO_NEW_RMT_DRV_OFF */

cores/esp32/io_pin_remap.h

@@ -79,7 +79,6 @@ int8_t gpioNumberToDigitalPin(int8_t gpioNumber);
 // cores/esp32/esp32-hal-rgb-led.h
 #define neopixelWrite(pin, red_val, green_val, blue_val) neopixelWrite(digitalPinToGPIONumber(pin), red_val, green_val, blue_val)
 
-#ifndef ESP32_ARDUINO_NEW_RMT_DRV_OFF
 // cores/esp32/esp32-hal-rmt.h
 #define rmtInit(pin, channel_direction, memsize, frequency_Hz) rmtInit(digitalPinToGPIONumber(pin), channel_direction, memsize, frequency_Hz)
 #define rmtSetEOT(pin, EOT_Level)                              rmtSetEOT(digitalPinToGPIONumber(pin), EOT_Level)
@@ -95,7 +94,6 @@ int8_t gpioNumberToDigitalPin(int8_t gpioNumber);
   rmtSetCarrier(digitalPinToGPIONumber(pin), carrier_en, carrier_level, frequency_Hz, duty_percent)
 #define rmtSetRxMinThreshold(pin, filter_pulse_ticks) rmtSetRxMinThreshold(digitalPinToGPIONumber(pin), filter_pulse_ticks)
 #define rmtDeinit(pin)                                rmtDeinit(digitalPinToGPIONumber(pin))
-#endif // ESP32_ARDUINO_NEW_RMT_DRV_OFF
 
 // cores/esp32/esp32-hal-sigmadelta.h
 #define sigmaDeltaAttach(pin, freq) sigmaDeltaAttach(digitalPinToGPIONumber(pin), freq)

libraries/ESP32/examples/RMT/Legacy_RMT_Driver_Compatible/Legacy_RMT_Driver_Compatible.ino

@@ -7,30 +7,22 @@
  * 
  */
 
-#ifndef ESP32_ARDUINO_NEW_RMT_DRV_OFF
+#ifndef ESP32_ARDUINO_NO_RGB_BUILTIN
 
-// add the file "build_opt.h" to your Arduino project folder with "-DESP32_ARDUINO_NEW_RMT_DRV_OFF" to use the RMT Legacy driver
-#warning "ESP32_ARDUINO_NEW_RMT_DRV_OFF is not defined, using new RMT driver"
-
-#define RMT_PIN 4  // Valid GPIO for ESP32, S2, S3, C3, C6 and H2
-bool installed = false;
+// add the file "build_opt.h" to your Arduino project folder with "-DESP32_ARDUINO_NO_RGB_BUILTIN" to use the RMT Legacy driver
+#warning "ESP32_ARDUINO_NO_RGB_BUILTIN is not defined, this example is intended to demonstrate the RMT Legacy driver.
+#warning "Please add the file 'build_opt.h' with '-DESP32_ARDUINO_NO_RGB_BUILTIN' to your Arduino project folder."
+#warning "Another way to disable the RGB_BUILTIN is to define it in the platformio.ini file, for instance: '-D ESP32_ARDUINO_NO_RGB_BUILTIN'"
 
 void setup() {
-  Serial.begin(115200);
-  Serial.println("This sketch uses the new RMT driver.");
-  installed = rmtInit(RMT_PIN, RMT_TX_MODE, RMT_MEM_NUM_BLOCKS_1, 10000000);
 }
 
 void loop() {
-  String msg = "RMT New driver is installed: ";
-  msg += (char*)(installed ? "Yes." : "No.");
-  Serial.println(msg);
-  delay(5000);
 }
 
 #else
 
-// add the file "build_opt.h" to your Arduino project folder with "-DESP32_ARDUINO_NEW_RMT_DRV_OFF" to use the RMT Legacy driver
+// add the file "build_opt.h" to your Arduino project folder with "-DESP32_ARDUINO_NO_RGB_BUILTIN" to use the RMT Legacy driver
 // neoPixelWrite() is a function that writes to the RGB LED and it won't be available here
 #include "driver/rmt.h"
 
@@ -49,4 +41,4 @@ void loop() {
   delay(5000);
 }
 
-#endif // ESP32_ARDUINO_NEW_RMT_DRV_OFF
+#endif // ESP32_ARDUINO_NO_RGB_BUILTIN

libraries/ESP32/examples/RMT/Legacy_RMT_Driver_Compatible/build_opt.h

@@ -1 +1 @@
--DESP32_ARDUINO_NEW_RMT_DRV_OFF
+-DESP32_ARDUINO_NO_RGB_BUILTIN