Add option to select the core used for Arduino and it's events

Author: me-no-dev

boards.txt

@@ -11,6 +11,8 @@ menu.PSRAM=PSRAM
 menu.Revision=Board Revision
 menu.LORAWAN_REGION=LoRaWan Region
 menu.LoRaWanDebugLevel=LoRaWan Debug Level
+menu.LoopCore=Arduino Runs On
+menu.EventsCore=Events Run On
 
 ##############################################################
 ### DO NOT PUT BOARDS ABOVE THE OFFICIAL ESPRESSIF BOARDS! ###
@@ -196,6 +198,8 @@ esp32.build.flash_mode=dio
 esp32.build.boot=dio
 esp32.build.partitions=default
 esp32.build.defines=
+esp32.build.loop_core=
+esp32.build.event_core=
 
 esp32.menu.PSRAM.disabled=Disabled
 esp32.menu.PSRAM.disabled.build.defines=
@@ -299,6 +303,16 @@ esp32.menu.UploadSpeed.460800.upload.speed=460800
 esp32.menu.UploadSpeed.512000.windows=512000
 esp32.menu.UploadSpeed.512000.upload.speed=512000
 
+esp32.menu.LoopCore.1=Core 1
+esp32.menu.LoopCore.1.build.loop_core=-DARDUINO_RUNNING_CORE=1
+esp32.menu.LoopCore.0=Core 0
+esp32.menu.LoopCore.0.build.loop_core=-DARDUINO_RUNNING_CORE=0
+
+esp32.menu.EventsCore.1=Core 1
+esp32.menu.EventsCore.1.build.event_core=-DARDUINO_EVENT_RUNNING_CORE=1
+esp32.menu.EventsCore.0=Core 0
+esp32.menu.EventsCore.0.build.event_core=-DARDUINO_EVENT_RUNNING_CORE=0
+
 esp32.menu.DebugLevel.none=None
 esp32.menu.DebugLevel.none.build.code_debug=0
 esp32.menu.DebugLevel.error=Error

cores/esp32/HardwareSerial.h

@@ -113,6 +113,9 @@ class HardwareSerial: public Stream
 extern void serialEventRun(void) __attribute__((weak));
 
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SERIAL)
+#ifndef ARDUINO_SERIAL_PORT
+#define ARDUINO_SERIAL_PORT 0
+#endif
 #if ARDUINO_SERIAL_PORT //Serial used for USB CDC
 #include "USB.h"
 #include "USBCDC.h"

cores/esp32/USB.cpp

@@ -15,7 +15,6 @@
 #include "esp32-hal-tinyusb.h"
 #include "USB.h"
 #if CONFIG_USB_ENABLED
-#include "usb_persist.h"
 
 #ifndef USB_VID
 #define USB_VID USB_ESPRESSIF_VID

cores/esp32/USBCDC.cpp

@@ -16,7 +16,6 @@
 #include "USB.h"
 #include "USBCDC.h"
 #if CONFIG_USB_ENABLED
-#include "usb_persist.h"
 
 ESP_EVENT_DEFINE_BASE(ARDUINO_USB_CDC_EVENTS);
 esp_err_t arduino_usb_event_post(esp_event_base_t event_base, int32_t event_id, void *event_data, size_t event_data_size, TickType_t ticks_to_wait);

cores/esp32/esp32-hal-log.h

@@ -20,6 +20,7 @@ extern "C"
 #endif
 
 #include "sdkconfig.h"
+#include "esp_timer.h"
 
 #define ARDUHAL_LOG_LEVEL_NONE       (0)
 #define ARDUHAL_LOG_LEVEL_ERROR      (1)

cores/esp32/esp32-hal-tinyusb.c

@@ -29,7 +29,7 @@
 #include "esp32-hal.h"
 
 #include "esp32-hal-tinyusb.h"
-#include "usb_persist.h"
+#include "esp32s2/rom/usb/usb_persist.h"
 
 typedef char tusb_str_t[127];
 
@@ -309,6 +309,8 @@ __attribute__ ((weak)) int32_t tud_msc_scsi_cb (uint8_t lun, uint8_t const scsi_
 /*
  * Private API
  * */
+static bool usb_persist_enabled = false;
+static restart_type_t usb_persist_mode = RESTART_NO_PERSIST;
 
 static bool tinyusb_reserve_in_endpoint(uint8_t endpoint){
     if(endpoint > 6 || (tinyusb_endpoints.in & BIT(endpoint)) != 0){
@@ -381,7 +383,7 @@ static bool tinyusb_load_enabled_interfaces(){
     };
     memcpy(tinyusb_config_descriptor, descriptor, TUD_CONFIG_DESC_LEN);
     if ((tinyusb_loaded_interfaces_mask == (BIT(USB_INTERFACE_CDC) | BIT(USB_INTERFACE_DFU))) || (tinyusb_loaded_interfaces_mask == BIT(USB_INTERFACE_CDC))) {
-        usb_persist_set_enable(true);
+        usb_persist_enabled = true;
         log_d("USB Persist enabled");
     }
     log_d("Load Done: if_num: %u, descr_len: %u, if_mask: 0x%x", tinyusb_loaded_interfaces_num, tinyusb_config_descriptor_len, tinyusb_loaded_interfaces_mask);
@@ -451,6 +453,34 @@ static void tinyusb_apply_device_config(tinyusb_device_config_t *config){
     tinyusb_device_descriptor.bDeviceProtocol = config->usb_protocol;
 }
 
+static void IRAM_ATTR usb_persist_shutdown_handler(void)
+{
+    if(usb_persist_mode != RESTART_NO_PERSIST){
+        if (usb_persist_enabled) {
+            REG_SET_BIT(RTC_CNTL_USB_CONF_REG, RTC_CNTL_IO_MUX_RESET_DISABLE);
+            REG_SET_BIT(RTC_CNTL_USB_CONF_REG, RTC_CNTL_USB_RESET_DISABLE);
+        }
+        if (usb_persist_mode == RESTART_BOOTLOADER) {
+            //USB CDC Download
+            if (usb_persist_enabled) {
+                USB_WRAP.date.val = USBDC_PERSIST_ENA;
+            }
+            REG_WRITE(RTC_CNTL_OPTION1_REG, RTC_CNTL_FORCE_DOWNLOAD_BOOT);
+            periph_module_disable(PERIPH_TIMG1_MODULE);
+        } else if (usb_persist_mode == RESTART_BOOTLOADER_DFU) {
+            //DFU Download
+            USB_WRAP.date.val = USBDC_BOOT_DFU;
+            REG_WRITE(RTC_CNTL_OPTION1_REG, RTC_CNTL_FORCE_DOWNLOAD_BOOT);
+            periph_module_disable(PERIPH_TIMG0_MODULE);
+            periph_module_disable(PERIPH_TIMG1_MODULE);
+        } else if (usb_persist_enabled) {
+            //USB Persist reboot
+            USB_WRAP.date.val = USBDC_PERSIST_ENA;
+        }
+        SET_PERI_REG_MASK(RTC_CNTL_OPTIONS0_REG, RTC_CNTL_SW_PROCPU_RST);
+    }
+}
+
 // USB Device Driver task
 // This top level thread processes all usb events and invokes callbacks
 static void usb_device_task(void *param) {
@@ -488,6 +518,24 @@ esp_err_t tinyusb_init(tinyusb_device_config_t *config) {
         initialized = false;
         return ESP_FAIL;
     }
+
+    bool usb_did_persist = (USB_WRAP.date.val == USBDC_PERSIST_ENA);
+
+    if(usb_did_persist && usb_persist_enabled){
+        // Enable USB/IO_MUX peripheral reset, if coming from persistent reboot
+        REG_CLR_BIT(RTC_CNTL_USB_CONF_REG, RTC_CNTL_IO_MUX_RESET_DISABLE);
+        REG_CLR_BIT(RTC_CNTL_USB_CONF_REG, RTC_CNTL_USB_RESET_DISABLE);
+    } else {
+        // Reset USB module
+        periph_module_reset(PERIPH_USB_MODULE);
+        periph_module_enable(PERIPH_USB_MODULE);
+    }
+
+    if (usb_persist_enabled && esp_register_shutdown_handler(usb_persist_shutdown_handler) != ESP_OK) {
+        initialized = false;
+        return ESP_FAIL;
+    }
+
     tinyusb_config_t tusb_cfg = {
             .external_phy = false // In the most cases you need to use a `false` value
     };
@@ -500,6 +548,16 @@ esp_err_t tinyusb_init(tinyusb_device_config_t *config) {
     return err;
 }
 
+void usb_persist_restart(restart_type_t mode)
+{
+    if (usb_persist_enabled && mode < RESTART_TYPE_MAX) {
+        usb_persist_mode = mode;
+        esp_restart();
+    } else {
+        log_e("Persistence is not enabled");
+    }
+}
+
 uint8_t tinyusb_add_string_descriptor(const char * str){
     if(str == NULL || tinyusb_string_descriptor_len >= MAX_STRING_DESCRIPTORS){
         return 0;

cores/esp32/esp32-hal-tinyusb.h

@@ -61,6 +61,19 @@ typedef struct {
 
 esp_err_t tinyusb_init(tinyusb_device_config_t *config);
 
+/*
+ * USB Persistence API
+ * */
+typedef enum {
+    RESTART_NO_PERSIST,
+    RESTART_PERSIST,
+    RESTART_BOOTLOADER,
+    RESTART_BOOTLOADER_DFU,
+    RESTART_TYPE_MAX
+} restart_type_t;
+
+void usb_persist_restart(restart_type_t mode);
+
 // The following definitions and functions are to be used only by the drivers
 typedef enum {
     USB_INTERFACE_CDC,

cores/esp32/esp32-hal.h

@@ -20,10 +20,6 @@
 #ifndef HAL_ESP32_HAL_H_
 #define HAL_ESP32_HAL_H_
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 #include <stdint.h>
 #include <stdbool.h>
 #include <stdio.h>
@@ -36,6 +32,10 @@ extern "C" {
 #include "esp_system.h"
 #include "esp_sleep.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #ifndef F_CPU
 #if CONFIG_IDF_TARGET_ESP32 // ESP32/PICO-D4
 #define F_CPU (CONFIG_ESP32_DEFAULT_CPU_FREQ_MHZ * 1000000U)
@@ -52,6 +52,14 @@ extern "C" {
 #define ARDUINO_ISR_FLAG (0)
 #endif
 
+#ifndef ARDUINO_RUNNING_CORE
+#define ARDUINO_RUNNING_CORE CONFIG_ARDUINO_RUNNING_CORE
+#endif
+
+#ifndef ARDUINO_EVENT_RUNNING_CORE
+#define ARDUINO_EVENT_RUNNING_CORE CONFIG_ARDUINO_EVENT_RUNNING_CORE
+#endif
+
 //forward declaration from freertos/portmacro.h
 void vPortYield(void);
 void yield(void);

cores/esp32/main.cpp

@@ -48,7 +48,7 @@ extern "C" void app_main()
 #endif
     loopTaskWDTEnabled = false;
     initArduino();
-    xTaskCreateUniversal(loopTask, "loopTask", CONFIG_ARDUINO_LOOP_STACK_SIZE, NULL, 1, &loopTaskHandle, CONFIG_ARDUINO_RUNNING_CORE);
+    xTaskCreateUniversal(loopTask, "loopTask", CONFIG_ARDUINO_LOOP_STACK_SIZE, NULL, 1, &loopTaskHandle, ARDUINO_RUNNING_CORE);
 }
 
 #endif

libraries/WiFi/src/WiFiGeneric.cpp

@@ -45,7 +45,7 @@ extern "C" {
 
 } //extern "C"
 
-#include "esp32-hal-log.h"
+#include "esp32-hal.h"
 #include <vector>
 #include "sdkconfig.h"
 
@@ -475,7 +475,7 @@ static bool _start_network_event_task(){
     }
 
     if(!_arduino_event_task_handle){
-        xTaskCreateUniversal(_arduino_event_task, "arduino_events", 4096, NULL, ESP_TASKD_EVENT_PRIO - 1, &_arduino_event_task_handle, CONFIG_ARDUINO_EVENT_RUNNING_CORE);
+        xTaskCreateUniversal(_arduino_event_task, "arduino_events", 4096, NULL, ESP_TASKD_EVENT_PRIO - 1, &_arduino_event_task_handle, ARDUINO_EVENT_RUNNING_CORE);
         if(!_arduino_event_task_handle){
             log_e("Network Event Task Start Failed!");
             return false;

platform.txt

@@ -90,7 +90,9 @@ build.flash_mode=dio
 build.boot=bootloader
 build.code_debug=0
 build.defines=
-build.extra_flags=-DESP32 -DCORE_DEBUG_LEVEL={build.code_debug} {build.defines} {build.extra_flags.{build.mcu}}
+build.loop_core=
+build.event_core=
+build.extra_flags=-DESP32 -DCORE_DEBUG_LEVEL={build.code_debug} {build.loop_core} {build.event_core} {build.defines} {build.extra_flags.{build.mcu}}
 
 # Check if custom partitions exist
 recipe.hooks.prebuild.1.pattern=bash -c "[ ! -f "{build.source.path}"/partitions.csv ] || cp -f "{build.source.path}"/partitions.csv "{build.path}"/partitions.csv"