Implements UART SerialHardware Refactoring on top of IDF (espressif#5549)

## Summary This PR is a complete reffactoring of UART Serial Hardware and respective HAL in order to use IDF instead of current Register manipulation approach. It implements Arduino SerialEvent functionality. Fix espressif#5287 Fix espressif#5273 Fix espressif#5519 Fix espressif#5247 Fix espressif#5403 Fix espressif#5429 Fix espressif#5047 Fix espressif#5463 Fix espressif#5362 Fix espressif#5112 Fix espressif#5443 ## Impact It solves many reported issues related to UART. It was tested and works fine for ESP32, ESP-S2 and ESP32-C3.

Author: SuGlider

cores/esp32/HardwareSerial.cpp

@@ -5,104 +5,152 @@
 
 #include "pins_arduino.h"
 #include "HardwareSerial.h"
+#include "soc/soc_caps.h"
 
+#ifndef SOC_RX0
 #if CONFIG_IDF_TARGET_ESP32
+#define SOC_RX0 3
+#elif CONFIG_IDF_TARGET_ESP32S2
+#define SOC_RX0 44
+#elif CONFIG_IDF_TARGET_ESP32C3
+#define SOC_RX0 20
+#endif
+#endif
+
+#ifndef SOC_TX0
+#if CONFIG_IDF_TARGET_ESP32
+#define SOC_TX0 1
+#elif CONFIG_IDF_TARGET_ESP32S2
+#define SOC_TX0 43
+#elif CONFIG_IDF_TARGET_ESP32C3
+#define SOC_TX0 21
+#endif
+#endif
+
+void serialEvent(void) __attribute__((weak));
+void serialEvent(void) {}
+
+#if SOC_UART_NUM > 1
 
 #ifndef RX1
+#if CONFIG_IDF_TARGET_ESP32
 #define RX1 9
+#elif CONFIG_IDF_TARGET_ESP32S2
+#define RX1 18
+#elif CONFIG_IDF_TARGET_ESP32C3
+#define RX1 18
+#endif
 #endif
 
 #ifndef TX1
+#if CONFIG_IDF_TARGET_ESP32
 #define TX1 10
+#elif CONFIG_IDF_TARGET_ESP32S2
+#define TX1 17
+#elif CONFIG_IDF_TARGET_ESP32C3
+#define TX1 19
 #endif
+#endif
+
+void serialEvent1(void) __attribute__((weak));
+void serialEvent1(void) {}
+#endif /* SOC_UART_NUM > 1 */
 
+#if SOC_UART_NUM > 2
 #ifndef RX2
+#if CONFIG_IDF_TARGET_ESP32
 #define RX2 16
 #endif
+#endif
 
 #ifndef TX2
+#if CONFIG_IDF_TARGET_ESP32
 #define TX2 17
 #endif
-
-#else
-
-#ifndef RX1
-#define RX1 18
-#endif
-
-#ifndef TX1
-#define TX1 17
 #endif
 
-#endif
+void serialEvent2(void) __attribute__((weak));
+void serialEvent2(void) {}
+#endif /* SOC_UART_NUM > 2 */
 
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SERIAL)
 #if ARDUINO_USB_CDC_ON_BOOT //Serial used for USB CDC
 HardwareSerial Serial0(0);
 #else
 HardwareSerial Serial(0);
 #endif
+#if SOC_UART_NUM > 1
 HardwareSerial Serial1(1);
-#if CONFIG_IDF_TARGET_ESP32
+#endif
+#if SOC_UART_NUM > 2
 HardwareSerial Serial2(2);
 #endif
 #endif
 
+void serialEventRun(void)
+{
+#if ARDUINO_USB_CDC_ON_BOOT //Serial used for USB CDC
+ if(Serial0.available()) serialEvent();
+#else
+ if(Serial.available()) serialEvent();
+#endif
+#if SOC_UART_NUM > 1
+ if(Serial1.available()) serialEvent1();
+#endif
+#if SOC_UART_NUM > 2
+ if(Serial2.available()) serialEvent2();
+#endif
+}
+
+
 HardwareSerial::HardwareSerial(int uart_nr) : _uart_nr(uart_nr), _uart(NULL) {}
 
 void HardwareSerial::begin(unsigned long baud, uint32_t config, int8_t rxPin, int8_t txPin, bool invert, unsigned long timeout_ms, uint8_t rxfifo_full_thrhd)
 {
- if(0 > _uart_nr || _uart_nr > 2) {
- log_e("Serial number is invalid, please use 0, 1 or 2");
+ if(0 > _uart_nr || _uart_nr >= SOC_UART_NUM) {
+ log_e("Serial number is invalid, please use numers from 0 to %u", SOC_UART_NUM - 1);
  return;
  }
  if(_uart) {
- end();
+ // in this case it is a begin() over a previous begin() - maybe to change baud rate
+ // thus do not disable debug output
+ end(false);
  }
  if(_uart_nr == 0 && rxPin < 0 && txPin < 0) {
-#if CONFIG_IDF_TARGET_ESP32
- rxPin = 3;
- txPin = 1;
-#elif CONFIG_IDF_TARGET_ESP32S2
- rxPin = 44;
- txPin = 43;
-#elif CONFIG_IDF_TARGET_ESP32C3
- rxPin = 20;
- txPin = 21;
-#endif
+ rxPin = SOC_RX0;
+ txPin = SOC_TX0;
  }
+#if SOC_UART_NUM > 1
  if(_uart_nr == 1 && rxPin < 0 && txPin < 0) {
  rxPin = RX1;
  txPin = TX1;
  }
-#if CONFIG_IDF_TARGET_ESP32
+#endif
+#if SOC_UART_NUM > 2
  if(_uart_nr == 2 && rxPin < 0 && txPin < 0) {
  rxPin = RX2;
  txPin = TX2;
  }
 #endif
- _uart = uartBegin(_uart_nr, baud ? baud : 9600, config, rxPin, txPin, 256, invert, rxfifo_full_thrhd);
- _tx_pin = txPin;
- _rx_pin = rxPin;
 
- if(!baud) {
+ _uart = uartBegin(_uart_nr, baud ? baud : 9600, config, rxPin, txPin, 256, invert, rxfifo_full_thrhd);
+ if (!baud) {
+ // using baud rate as zero, forces it to try to detect the current baud rate in place
  uartStartDetectBaudrate(_uart);
  time_t startMillis = millis();
  unsigned long detectedBaudRate = 0;
  while(millis() - startMillis < timeout_ms && !(detectedBaudRate = uartDetectBaudrate(_uart))) {
  yield();
  }
 
- end();
+ end(false);
 
  if(detectedBaudRate) {
  delay(100); // Give some time...
  _uart = uartBegin(_uart_nr, detectedBaudRate, config, rxPin, txPin, 256, invert, rxfifo_full_thrhd);
  } else {
  log_e("Could not detect baudrate. Serial data at the port must be present within the timeout for detection to be possible");
  _uart = NULL;
- _tx_pin = 255;
- _rx_pin = 255;
  }
  }
 }
@@ -112,21 +160,16 @@ void HardwareSerial::updateBaudRate(unsigned long baud)
 uartSetBaudRate(_uart, baud);
 }
 
-void HardwareSerial::end()
+void HardwareSerial::end(bool turnOffDebug)
 {
- if(uartGetDebug() == _uart_nr) {
+ if(turnOffDebug && uartGetDebug() == _uart_nr) {
  uartSetDebug(0);
  }
  delay(10);
- log_v("pins %d %d",_tx_pin, _rx_pin);
- uartEnd(_uart, _tx_pin, _rx_pin);
+ uartEnd(_uart);
  _uart = 0;
 }
 
-size_t HardwareSerial::setRxBufferSize(size_t new_size) {
- return uartResizeRxBuffer(_uart, new_size);
-}
-
 void HardwareSerial::setDebugOutput(bool en)
 {
  if(_uart == 0) {
@@ -212,10 +255,16 @@ uint32_t HardwareSerial::baudRate()
 }
 HardwareSerial::operator bool() const
 {
- return true;
+ return uartIsDriverInstalled(_uart);
 }
 
 void HardwareSerial::setRxInvert(bool invert)
 {
  uartSetRxInvert(_uart, invert);
 }
+
+void HardwareSerial::setPins(uint8_t rxPin, uint8_t txPin)
+{
+ uartSetPins(_uart, rxPin, txPin);
+}
+

cores/esp32/HardwareSerial.h

@@ -49,14 +49,15 @@
 
 #include "Stream.h"
 #include "esp32-hal.h"
+#include "soc/soc_caps.h"
 
 class HardwareSerial: public Stream
 {
 public:
  HardwareSerial(int uart_nr);
 
  void begin(unsigned long baud, uint32_t config=SERIAL_8N1, int8_t rxPin=-1, int8_t txPin=-1, bool invert=false, unsigned long timeout_ms = 20000UL, uint8_t rxfifo_full_thrhd = 112);
- void end();
+ void end(bool turnOffDebug = true);
  void updateBaudRate(unsigned long baud);
  int available(void);
  int availableForWrite(void);
@@ -98,16 +99,14 @@ class HardwareSerial: public Stream
  uint32_t baudRate();
  operator bool() const;
 
- size_t setRxBufferSize(size_t);
  void setDebugOutput(bool);
 
  void setRxInvert(bool);
+ void setPins(uint8_t rxPin, uint8_t txPin);
 
 protected:
  int _uart_nr;
  uart_t* _uart;
- uint8_t _tx_pin;
- uint8_t _rx_pin;
 };
 
 extern void serialEventRun(void) __attribute__((weak));
@@ -123,8 +122,10 @@ extern HardwareSerial Serial0;
 #else
 extern HardwareSerial Serial;
 #endif
+#if SOC_UART_NUM > 1
 extern HardwareSerial Serial1;
-#if CONFIG_IDF_TARGET_ESP32
+#endif
+#if SOC_UART_NUM > 2
 extern HardwareSerial Serial2;
 #endif
 #endif