Serial as a #define (#8798)

* Serial as a #define

* Typo

* fixes USBCDC declaration

* Fixes Examples

* simplifies examples

* Adds USB Serial Events

* adds error msg when ESP32 is used with USB

Author: SuGlider

Diff for: cores/esp32/HWCDC.cpp

@@ -436,12 +436,9 @@ void HWCDC::setDebugOutput(bool en)
     }
 }
 
-#if ARDUINO_USB_MODE
-#if ARDUINO_USB_CDC_ON_BOOT//Serial used for USB CDC
-HWCDC Serial;
-#else
-HWCDC USBSerial;
-#endif
+#if ARDUINO_USB_MODE  // Hardware JTAG CDC selected
+// USBSerial is always available to be used
+HWCDC HWCDCSerial;
 #endif
 
 #endif /* SOC_USB_SERIAL_JTAG_SUPPORTED */

Diff for: cores/esp32/HWCDC.h

@@ -102,13 +102,12 @@ class HWCDC: public Stream
     uint32_t baudRate(){return 115200;}
 
 };
-
-#if ARDUINO_USB_MODE
-#if ARDUINO_USB_CDC_ON_BOOT//Serial used for USB CDC
-extern HWCDC Serial;
-#else
-extern HWCDC USBSerial;
+#if ARDUINO_USB_MODE  // Hardware JTAG CDC selected
+#ifndef HWCDC_SERIAL_IS_DEFINED
+#define HWCDC_SERIAL_IS_DEFINED 1
 #endif
+// HWCDCSerial is always available to be used
+extern HWCDC HWCDCSerial;
 #endif
 
-#endif /* CONFIG_IDF_TARGET_ESP32C3 */
+#endif /* SOC_USB_SERIAL_JTAG_SUPPORTED */

Diff for: cores/esp32/HardwareSerial.cpp

@@ -113,25 +113,36 @@ 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
+// There is always Seria0 for UART0
 HardwareSerial Serial0(0);
-#else
-HardwareSerial Serial(0);
-#endif
 #if SOC_UART_NUM > 1
 HardwareSerial Serial1(1);
 #endif
 #if SOC_UART_NUM > 2
 HardwareSerial Serial2(2);
 #endif
 
+#if HWCDC_SERIAL_IS_DEFINED == 1        // Hardware JTAG CDC Event
+extern void HWCDCSerialEvent (void)__attribute__((weak));
+void HWCDCSerialEvent(void) {} 
+#endif 
+
+#if USB_SERIAL_IS_DEFINED == 1          // Native USB CDC Event
+// Used by Hardware Serial for USB CDC events
+extern void USBSerialEvent (void)__attribute__((weak));
+void USBSerialEvent(void) {} 
+#endif 
+
 void serialEventRun(void)
 {
-#if ARDUINO_USB_CDC_ON_BOOT //Serial used for USB CDC
+#if HWCDC_SERIAL_IS_DEFINED == 1        // Hardware JTAG CDC Event
+    if(HWCDCSerial.available()) HWCDCSerialEvent();
+#endif    
+#if USB_SERIAL_IS_DEFINED == 1          // Native USB CDC Event
+    if(USBSerial.available()) USBSerialEvent();
+#endif    
+    // UART0 is default serialEvent()
     if(Serial0.available()) serialEvent();
-#else
-    if(Serial.available()) serialEvent();
-#endif
 #if SOC_UART_NUM > 1
     if(Serial1.available()) serialEvent1();
 #endif

Diff for: cores/esp32/HardwareSerial.h

@@ -51,6 +51,7 @@
 #include "esp32-hal.h"
 #include "soc/soc_caps.h"
 #include "HWCDC.h"
+#include "USBCDC.h"
 
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
@@ -240,21 +241,26 @@ extern void serialEventRun(void) __attribute__((weak));
 #ifndef ARDUINO_USB_CDC_ON_BOOT
 #define ARDUINO_USB_CDC_ON_BOOT 0
 #endif
-#if ARDUINO_USB_CDC_ON_BOOT //Serial used for USB CDC
-#if !ARDUINO_USB_MODE
-#include "USB.h"
-#include "USBCDC.h"
-#endif
+#if ARDUINO_USB_CDC_ON_BOOT //Serial used from Native_USB_CDC | HW_CDC_JTAG
+#if ARDUINO_USB_MODE // Hardware CDC mode
+// Arduino Serial is the HW JTAG CDC device
+#define Serial HWCDCSerial
+#else // !ARDUINO_USB_MODE -- Native USB Mode
+// Arduino Serial is the Native USB CDC device
+#define Serial USBSerial
+#endif  // ARDUINO_USB_MODE
+#else   // !ARDUINO_USB_CDC_ON_BOOT -- Serial is used from UART0
+// if not using CDC on Boot, Arduino Serial is the UART0 device
+#define Serial Serial0 
+#endif  // ARDUINO_USB_CDC_ON_BOOT
+// There is always Seria0 for UART0
 extern HardwareSerial Serial0;
-#else
-extern HardwareSerial Serial;
-#endif
 #if SOC_UART_NUM > 1
 extern HardwareSerial Serial1;
 #endif
 #if SOC_UART_NUM > 2
 extern HardwareSerial Serial2;
 #endif
-#endif
+#endif //!defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SERIAL)
 
 #endif // HardwareSerial_h

Diff for: cores/esp32/USBCDC.cpp

@@ -455,8 +455,9 @@ USBCDC::operator bool() const
     return connected;
 }
 
-#if ARDUINO_USB_CDC_ON_BOOT && !ARDUINO_USB_MODE //Serial used for USB CDC
-USBCDC Serial(0);
+#if !ARDUINO_USB_MODE         // Native USB CDC selected
+// USBSerial is always available to be used
+USBCDC USBSerial(0);
 #endif
 
 #endif /* CONFIG_TINYUSB_CDC_ENABLED */

Diff for: cores/esp32/USBCDC.h

@@ -141,9 +141,14 @@ class USBCDC: public Stream
 
 };
 
-#if ARDUINO_USB_CDC_ON_BOOT && !ARDUINO_USB_MODE //Serial used for USB CDC
-extern USBCDC Serial;
+#if !ARDUINO_USB_MODE        // Native USB CDC selected
+#ifndef USB_SERIAL_IS_DEFINED
+#define USB_SERIAL_IS_DEFINED 1
+#endif 
+// USBSerial is always available to be used
+extern USBCDC USBSerial;
 #endif
 
+
 #endif /* CONFIG_TINYUSB_CDC_ENABLED */
 #endif /* SOC_USB_OTG_SUPPORTED */

Diff for: libraries/ESP32/examples/Serial/Serial_STD_Func_OnReceive/Serial_STD_Func_OnReceive.ino

@@ -16,16 +16,6 @@
 // This makes the code transparent to what SoC is used.
 #include "soc/soc_caps.h"
 
-// In case that the target has USB CDC and it has being selected to be enable on boot, 
-// the console output will into USB (Serial).
-// Otherwise the output will be sent to UART0 (Serial) and we have to redefine Serial0
-#ifndef ARDUINO_USB_CDC_ON_BOOT
-#define ARDUINO_USB_CDC_ON_BOOT 0
-#endif
-#if ARDUINO_USB_CDC_ON_BOOT == 0 // No USB CDC
-#define Serial0 Serial   // redefine the symbol Serial0 to the default Arduino
-#endif
-
 // This example shall use UART1 or UART2 for testing and UART0 for console messages
 // If UART0 is used for testing, it is necessary to manually send data to it, using the Serial Monitor/Terminal
 // In case that USB CDC is available, it may be used as console for messages.

Diff for: libraries/USB/examples/CompositeDevice/CompositeDevice.ino

@@ -1,4 +1,6 @@
-#if ARDUINO_USB_MODE
+#ifndef ARDUINO_USB_MODE
+#error This ESP32 SoC has no Native USB interface
+#elif ARDUINO_USB_MODE == 1
 #warning This sketch should be used when USB is in OTG mode
 void setup(){}
 void loop(){}
@@ -15,13 +17,6 @@ void loop(){}
 #if !ARDUINO_USB_MSC_ON_BOOT
 FirmwareMSC MSC_Update;
 #endif
-#if ARDUINO_USB_CDC_ON_BOOT
-#define HWSerial Serial0
-#define USBSerial Serial
-#else
-#define HWSerial Serial
-USBCDC USBSerial;
-#endif
 
 USBHID HID;
 USBHIDKeyboard Keyboard;
@@ -39,16 +34,16 @@ static void usbEventCallback(void* arg, esp_event_base_t event_base, int32_t eve
     arduino_usb_event_data_t * data = (arduino_usb_event_data_t*)event_data;
     switch (event_id){
       case ARDUINO_USB_STARTED_EVENT:
-        HWSerial.println("USB PLUGGED");
+        Serial.println("USB PLUGGED");
         break;
       case ARDUINO_USB_STOPPED_EVENT:
-        HWSerial.println("USB UNPLUGGED");
+        Serial.println("USB UNPLUGGED");
         break;
       case ARDUINO_USB_SUSPEND_EVENT:
-        HWSerial.printf("USB SUSPENDED: remote_wakeup_en: %u\n", data->suspend.remote_wakeup_en);
+        Serial.printf("USB SUSPENDED: remote_wakeup_en: %u\n", data->suspend.remote_wakeup_en);
         break;
       case ARDUINO_USB_RESUME_EVENT:
-        HWSerial.println("USB RESUMED");
+        Serial.println("USB RESUMED");
         break;
 
       default:
@@ -58,28 +53,28 @@ static void usbEventCallback(void* arg, esp_event_base_t event_base, int32_t eve
     arduino_usb_cdc_event_data_t * data = (arduino_usb_cdc_event_data_t*)event_data;
     switch (event_id){
       case ARDUINO_USB_CDC_CONNECTED_EVENT:
-        HWSerial.println("CDC CONNECTED");
+        Serial.println("CDC CONNECTED");
         break;
       case ARDUINO_USB_CDC_DISCONNECTED_EVENT:
-        HWSerial.println("CDC DISCONNECTED");
+        Serial.println("CDC DISCONNECTED");
         break;
       case ARDUINO_USB_CDC_LINE_STATE_EVENT:
-        HWSerial.printf("CDC LINE STATE: dtr: %u, rts: %u\n", data->line_state.dtr, data->line_state.rts);
+        Serial.printf("CDC LINE STATE: dtr: %u, rts: %u\n", data->line_state.dtr, data->line_state.rts);
         break;
       case ARDUINO_USB_CDC_LINE_CODING_EVENT:
-        HWSerial.printf("CDC LINE CODING: bit_rate: %lu, data_bits: %u, stop_bits: %u, parity: %u\n", data->line_coding.bit_rate, data->line_coding.data_bits, data->line_coding.stop_bits, data->line_coding.parity);
+        Serial.printf("CDC LINE CODING: bit_rate: %lu, data_bits: %u, stop_bits: %u, parity: %u\n", data->line_coding.bit_rate, data->line_coding.data_bits, data->line_coding.stop_bits, data->line_coding.parity);
         break;
       case ARDUINO_USB_CDC_RX_EVENT:
-        HWSerial.printf("CDC RX [%u]:", data->rx.len);
+        Serial.printf("CDC RX [%u]:", data->rx.len);
         {
             uint8_t buf[data->rx.len];
             size_t len = USBSerial.read(buf, data->rx.len);
-            HWSerial.write(buf, len);
+            Serial.write(buf, len);
         }
-        HWSerial.println();
+        Serial.println();
         break;
       case ARDUINO_USB_CDC_RX_OVERFLOW_EVENT:
-        HWSerial.printf("CDC RX Overflow of %d bytes", data->rx_overflow.dropped_bytes);
+        Serial.printf("CDC RX Overflow of %d bytes", data->rx_overflow.dropped_bytes);
         break;
 
       default:
@@ -89,20 +84,20 @@ static void usbEventCallback(void* arg, esp_event_base_t event_base, int32_t eve
     arduino_firmware_msc_event_data_t * data = (arduino_firmware_msc_event_data_t*)event_data;
     switch (event_id){
       case ARDUINO_FIRMWARE_MSC_START_EVENT:
-        HWSerial.println("MSC Update Start");
+        Serial.println("MSC Update Start");
         break;
       case ARDUINO_FIRMWARE_MSC_WRITE_EVENT:
-        //HWSerial.printf("MSC Update Write %u bytes at offset %u\n", data->write.size, data->write.offset);
-        HWSerial.print(".");
+        //Serial.printf("MSC Update Write %u bytes at offset %u\n", data->write.size, data->write.offset);
+        Serial.print(".");
         break;
       case ARDUINO_FIRMWARE_MSC_END_EVENT:
-        HWSerial.printf("\nMSC Update End: %u bytes\n", data->end.size);
+        Serial.printf("\nMSC Update End: %u bytes\n", data->end.size);
         break;
       case ARDUINO_FIRMWARE_MSC_ERROR_EVENT:
-        HWSerial.printf("MSC Update ERROR! Progress: %u bytes\n", data->error.size);
+        Serial.printf("MSC Update ERROR! Progress: %u bytes\n", data->error.size);
         break;
       case ARDUINO_FIRMWARE_MSC_POWER_EVENT:
-        HWSerial.printf("MSC Update Power: power: %u, start: %u, eject: %u\n", data->power.power_condition, data->power.start, data->power.load_eject);
+        Serial.printf("MSC Update Power: power: %u, start: %u, eject: %u\n", data->power.power_condition, data->power.start, data->power.load_eject);
         break;
 
       default:
@@ -112,10 +107,10 @@ static void usbEventCallback(void* arg, esp_event_base_t event_base, int32_t eve
     arduino_usb_hid_event_data_t * data = (arduino_usb_hid_event_data_t*)event_data;
     switch (event_id){
       case ARDUINO_USB_HID_SET_PROTOCOL_EVENT:
-        HWSerial.printf("HID SET PROTOCOL: %s\n", data->set_protocol.protocol?"REPORT":"BOOT");
+        Serial.printf("HID SET PROTOCOL: %s\n", data->set_protocol.protocol?"REPORT":"BOOT");
         break;
       case ARDUINO_USB_HID_SET_IDLE_EVENT:
-        HWSerial.printf("HID SET IDLE: %u\n", data->set_idle.idle_rate);
+        Serial.printf("HID SET IDLE: %u\n", data->set_idle.idle_rate);
         break;
 
       default:
@@ -125,7 +120,7 @@ static void usbEventCallback(void* arg, esp_event_base_t event_base, int32_t eve
     arduino_usb_hid_keyboard_event_data_t * data = (arduino_usb_hid_keyboard_event_data_t*)event_data;
     switch (event_id){
       case ARDUINO_USB_HID_KEYBOARD_LED_EVENT:
-        HWSerial.printf("HID KEYBOARD LED: NumLock:%u, CapsLock:%u, ScrollLock:%u\n", data->numlock, data->capslock, data->scrolllock);
+        Serial.printf("HID KEYBOARD LED: NumLock:%u, CapsLock:%u, ScrollLock:%u\n", data->numlock, data->capslock, data->scrolllock);
         break;
 
       default:
@@ -135,25 +130,25 @@ static void usbEventCallback(void* arg, esp_event_base_t event_base, int32_t eve
     arduino_usb_hid_vendor_event_data_t * data = (arduino_usb_hid_vendor_event_data_t*)event_data;
     switch (event_id){
       case ARDUINO_USB_HID_VENDOR_GET_FEATURE_EVENT:
-        HWSerial.printf("HID VENDOR GET FEATURE: len:%u\n", data->len);
+        Serial.printf("HID VENDOR GET FEATURE: len:%u\n", data->len);
         for(uint16_t i=0; i<data->len; i++){
-          HWSerial.write(data->buffer[i]?data->buffer[i]:'.');
+          Serial.write(data->buffer[i]?data->buffer[i]:'.');
         }
-        HWSerial.println();
+        Serial.println();
         break;
       case ARDUINO_USB_HID_VENDOR_SET_FEATURE_EVENT:
-        HWSerial.printf("HID VENDOR SET FEATURE: len:%u\n", data->len);
+        Serial.printf("HID VENDOR SET FEATURE: len:%u\n", data->len);
         for(uint16_t i=0; i<data->len; i++){
-          HWSerial.write(data->buffer[i]?data->buffer[i]:'.');
+          Serial.write(data->buffer[i]?data->buffer[i]:'.');
         }
-        HWSerial.println();
+        Serial.println();
         break;
       case ARDUINO_USB_HID_VENDOR_OUTPUT_EVENT:
-        HWSerial.printf("HID VENDOR OUTPUT: len:%u\n", data->len);
+        Serial.printf("HID VENDOR OUTPUT: len:%u\n", data->len);
         for(uint16_t i=0; i<data->len; i++){
-          HWSerial.write(Vendor.read());
+          Serial.write(Vendor.read());
         }
-        HWSerial.println();
+        Serial.println();
         break;
 
       default:
@@ -163,8 +158,8 @@ static void usbEventCallback(void* arg, esp_event_base_t event_base, int32_t eve
 }
 
 void setup() {
-  HWSerial.begin(115200);
-  HWSerial.setDebugOutput(true);
+  Serial.begin(115200);
+  Serial.setDebugOutput(true);
 
   pinMode(buttonPin, INPUT_PULLUP);
 
@@ -191,7 +186,7 @@ void loop() {
   if (HID.ready() && buttonState != previousButtonState) {
     previousButtonState = buttonState;
     if (buttonState == LOW) {
-      HWSerial.println("Button Pressed");
+      if (Serial != USBSerial) Serial.println("Button Pressed");
       USBSerial.println("Button Pressed");
       Vendor.println("Button Pressed");
       Mouse.move(10,10);
@@ -206,15 +201,15 @@ void loop() {
       //SystemControl.release();
       Vendor.println("Button Released");
       USBSerial.println("Button Released");
-      HWSerial.println("Button Released");
+      if (Serial != USBSerial) Serial.println("Button Released");
     }
     delay(100);
   }
 
-  while(HWSerial.available()){
-    size_t l = HWSerial.available();
+  while(Serial.available()){
+    size_t l = Serial.available();
     uint8_t b[l];
-    l = HWSerial.read(b, l);
+    l = Serial.read(b, l);
     USBSerial.write(b, l);
     if(HID.ready()){
       Vendor.write(b,l);

Diff for: libraries/USB/examples/ConsumerControl/ConsumerControl.ino

@@ -1,4 +1,6 @@
-#if ARDUINO_USB_MODE
+#ifndef ARDUINO_USB_MODE
+#error This ESP32 SoC has no Native USB interface
+#elif ARDUINO_USB_MODE == 1
 #warning This sketch should be used when USB is in OTG mode
 void setup(){}
 void loop(){}

Diff for: libraries/USB/examples/CustomHIDDevice/CustomHIDDevice.ino

@@ -1,5 +1,7 @@
-#if ARDUINO_USB_MODE
-  #warning This sketch should be used when USB is in OTG mode
+#ifndef ARDUINO_USB_MODE
+#error This ESP32 SoC has no Native USB interface
+#elif ARDUINO_USB_MODE == 1
+#warning This sketch should be used when USB is in OTG mode
   void setup(){}
   void loop(){}
 #else