fixes for espruino#2609 - tidy up for testing

Author: SimonGAndrews

boards/ESP32C3_IDF4.py

@@ -45,6 +45,18 @@
 # available memory. Using too small a JsVar format will under utilise
 # available memory.
 
+# MakeFile identifier ESP_FORCE_NO_USB_SERIAL_JTAG  
+# --------------------------------------------------------------
+# The 'makefile' list in the 'info' dictionary below can define ESP_FORCE_NO_USB_SERIAL_JTAG using 'DEFINES+=-ESP_FORCE_NO_USB_SERIAL_JTAG'
+# where necessary.  
+# When defined ESP_FORCE_NO_USB_SERIAL_JTAG overrides the default console driver assignment in the Espruino build for the ESP32-C3.
+#  When NOT defined, By default the Espruino console will use the USB port with usb_serial_jtag_driver.  
+#  This will support the case where the USB connector on the board is wired directly to the D+ and D- pins on the ESP32-C3.
+#  Alternatively in the case where the USB is wired to an ESP32-C3's UART RX and TX pins (usually via a USB to UART conversion chip),
+#    ESP_FORCE_NO_USB_SERIAL_JTAG should be defined to set the console for UART operation.
+# This method is introduced for fix to issue #2609 and replaces the previous method using the 'USB_CDC' identifier.
+
+
 
 import pinutils;
 info = {
@@ -74,7 +86,7 @@
      'DEFINES+=-DESP_STACK_SIZE=25000',
      'DEFINES+=-DJSVAR_MALLOC', # Allocate space for variables at jsvInit time
      'DEFINES+=-DUSE_FONT_6X8',
-     'DEFINES+=-DUSB_CDC',      # Comment out to disable USB_CDC if board has uart interface      
+   # 'DEFINES+=-ESP_FORCE_NO_USB_SERIAL_JTAG'   # see npote above
      'ESP32_FLASH_MAX=1572864'
    ]
  }

boards/ESP32S3_IDF4.py

@@ -45,6 +45,18 @@
 # available memory. Using too small a JsVar format will under utilise
 # available memory.
 
+# MakeFile identifier ESP_FORCE_NO_USB_SERIAL_JTAG  
+# --------------------------------------------------------------
+# The 'makefile' list in the 'info' dictionary below can define ESP_FORCE_NO_USB_SERIAL_JTAG using 'DEFINES+=-ESP_FORCE_NO_USB_SERIAL_JTAG'
+# where necessary.  
+# When defined ESP_FORCE_NO_USB_SERIAL_JTAG overrides the default console driver assignment in the Espruino build for the ESP32-S3.
+#  When NOT defined, By default the Espruino console will use the USB port with usb_serial_jtag_driver.  
+#  This will support the case where the USB connector on the board is wired directly to the D+ and D- pins on the ESP32S3.
+#  Alternatively in the case where the USB is wired to an ESP32S3's UART RX and TX pins (usually via a USB to UART conversion chip),
+#    ESP_FORCE_NO_USB_SERIAL_JTAG should be defined to set the console for UART operation.
+# This method is introduced for fix to issue #2609 and replaces the previous method using the 'USB_CDC' identifier.
+
+
 
 import pinutils;
 info = {
@@ -74,7 +86,7 @@
      'DEFINES+=-DESP_STACK_SIZE=25000',
      'DEFINES+=-DJSVAR_MALLOC', # Allocate space for variables at jsvInit time
      'DEFINES+=-DUSE_FONT_6X8',
-     'DEFINES+=-DUSB_CDC',      # Comment out to disable USB_CDC if board has uart interface      
+   # 'DEFINES+=-ESP_FORCE_NO_USB_SERIAL_JTAG' # See note above
      'ESP32_FLASH_MAX=1572864'
    ]
  }

targets/esp32/jshardware.c

@@ -592,7 +592,7 @@ void jshUSARTKick(IOEventFlags device) {
 #endif
     case EV_SERIAL1:
       uart_tx_one_char((uint8_t)c);
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
       // The USB CDC UART on the C3 only writes the data to USB after a newline. Ensure uartTask in main.c knows to flush the UART next time
       extern void esp32USBUARTWasUsed();
       esp32USBUARTWasUsed();

targets/esp32/jshardwareUart.c

@@ -23,7 +23,7 @@
 #include <jsdevices.h>
 #include "jsinteractive.h"  // jsDebug() ??
 
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
 #include "driver/usb_serial_jtag.h"
 #endif
 
@@ -87,7 +87,7 @@ void initSerial(IOEventFlags device,JshUSARTInfo *inf){
 }
 
 void initConsole(){
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
   /* Configure USB-CDC */
   usb_serial_jtag_driver_config_t usb_serial_config = {.tx_buffer_size = 128,
                                                        .rx_buffer_size = 128};
@@ -118,7 +118,7 @@ void consoleToEspruino(){
 #else
   TickType_t ticksToWait = 100;
 #endif
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
   int len = usb_serial_jtag_read_bytes(rxbuf, sizeof(rxbuf), ticksToWait);
 #else 
   int len = uart_read_bytes(uart_console, rxbuf, sizeof(rxbuf), ticksToWait);  // Read data from UART

targets/esp32/main.c

@@ -39,21 +39,21 @@
 
 #include "jsvar.h"
 
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
   #pragma message ("USB Serial JTAG console is enabled")
 #else
   #pragma message ("Using UART console")
 #endif
 
 extern void *espruino_stackHighPtr;  //Name spaced because this has to be a global variable.
                                      //Used in jsuGetFreeStack().
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
 #include "hal/usb_serial_jtag_ll.h"
 volatile bool usbUARTIsNotFlushed;
 #endif
 
 void esp32USBUARTWasUsed() {
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
   usbUARTIsNotFlushed = true;
 #endif
 }
@@ -65,7 +65,7 @@ static void uartTask(void *data) {
   while(1) {
     consoleToEspruino();
     serialToEspruino();
-#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL)
+#if defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && !defined(ESP_FORCE_NO_USB_SERIAL_JTAG)
     /* The USB CDC UART on the C3 only writes the data to USB after a newline.
     We don't want that, so we call flush in this uart task if any data has been sent. */
     if (usbUARTIsNotFlushed) {