Fix Arduino as an component of IDF compile for the C2

Author: Jason2866

boards/esp32-c5-devkitc-1.json

@@ -0,0 +1,31 @@
+{
+  "build": {
+    "core": "esp32",
+    "f_cpu": "240000000L",
+    "f_flash": "80000000L",
+    "flash_mode": "qio",
+    "mcu": "esp32c5",
+    "variant": "esp32c5"
+  },
+  "connectivity": [
+    "bluetooth",
+    "wifi"
+  ],
+  "debug": {
+    "openocd_target": "esp32c5.cfg"
+  },
+  "frameworks": [
+    "arduino",
+    "espidf"
+  ],
+  "name": "Espressif ESP32-C5-DevKitC-1 4MB no PSRAM",
+  "upload": {
+    "flash_size": "4MB",
+    "maximum_ram_size": 327680,
+    "maximum_size": 4194304,
+    "require_upload_port": true,
+    "speed": 460800
+  },
+  "url": "https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c5/esp32-c5-devkitc-1/user_guide.html",
+  "vendor": "Espressif"
+}

builder/frameworks/_embed_files.py

@@ -110,14 +110,14 @@ def transform_to_asm(target, source, env):
                 " ".join(
                     [
                         "riscv32-esp-elf-objcopy"
-                        if mcu in ("esp32c2","esp32c3","esp32c6","esp32h2","esp32p4")
+                        if mcu in ("esp32c2","esp32c3","esp32c5","esp32c6","esp32h2","esp32p4")
                         else "xtensa-%s-elf-objcopy" % mcu,
                         "--input-target",
                         "binary",
                         "--output-target",
-                        "elf32-littleriscv" if mcu in ("esp32c2","esp32c3","esp32c6","esp32h2","esp32p4") else "elf32-xtensa-le",
+                        "elf32-littleriscv" if mcu in ("esp32c2","esp32c3","esp32c5","esp32c6","esp32h2","esp32p4") else "elf32-xtensa-le",
                         "--binary-architecture",
-                        "riscv" if mcu in ("esp32c2","esp32c3","esp32c6","esp32h2","esp32p4") else "xtensa",
+                        "riscv" if mcu in ("esp32c2","esp32c3","esp32c5","esp32c6","esp32h2","esp32p4") else "xtensa",
                         "--rename-section",
                         ".data=.rodata.embedded",
                         "$SOURCE",

builder/frameworks/arduino.py

@@ -230,6 +230,20 @@ def shorthen_includes(env, node):
         + shortened_includes,
     )
 
+# Check if framework = arduino, espidf is set -> compile Arduino as an component of IDF
+# using platformio.ini entry since we modify the framework env var for Hybrid Compile!
+def get_frameworks_in_current_env():
+    current_env_section = "env:" + env["PIOENV"]
+    if "framework" in config.options(current_env_section):
+        frameworks = config.get(current_env_section, "framework", "")
+        return frameworks
+    return []
+
+current_env_frameworks = get_frameworks_in_current_env()
+if "arduino" in current_env_frameworks and "espidf" in current_env_frameworks:
+    # Arduino as component is set, switch off Hybrid compile
+    flag_custom_sdkconfig = False
+
 def call_compile_libs():
     if mcu == "esp32c2":
         ARDUINO_FRMWRK_C2_LIB_DIR = join(platform.get_package_dir("framework-arduinoespressif32-libs"),mcu)

builder/frameworks/espidf.py

@@ -155,10 +155,14 @@ def _get_installed_standard_pip_packages():
 ):
     print("Warning! Debugging an IDF project requires PlatformIO Core >= 6.1.11!")
 
-# Arduino framework as a component is not compatible with ESP-IDF >5.3
 if "arduino" in env.subst("$PIOFRAMEWORK"):
     ARDUINO_FRAMEWORK_DIR = platform.get_package_dir("framework-arduinoespressif32")
     ARDUINO_FRMWRK_LIB_DIR = platform.get_package_dir("framework-arduinoespressif32-libs")
+    if mcu == "esp32c2":
+        ARDUINO_FRMWRK_C2_LIB_DIR = join(platform.get_package_dir("framework-arduinoespressif32-libs"),mcu)
+        if not os.path.exists(ARDUINO_FRMWRK_C2_LIB_DIR):
+            ARDUINO_C2_DIR = join(platform.get_package_dir("framework-arduino-c2-skeleton-lib"),mcu)
+            shutil.copytree(ARDUINO_C2_DIR, ARDUINO_FRMWRK_C2_LIB_DIR, dirs_exist_ok=True)
     # Possible package names in 'package@version' format is not compatible with CMake
     if "@" in os.path.basename(ARDUINO_FRAMEWORK_DIR):
         new_path = os.path.join(
@@ -296,7 +300,7 @@ def HandleCOMPONENTsettings(env):
     if flag_custom_component_add == True or flag_custom_component_remove == True: # todo remove duplicated
         import yaml
         from yaml import SafeLoader
-        print("*** \"custom_component\" is used to select managed idf components ***")
+        print("*** \"custom_component\" is used to (de)select managed idf components ***")
         if flag_custom_component_remove == True:
             idf_custom_component_remove = env.GetProjectOption("custom_component_remove").splitlines()
         else:
@@ -365,7 +369,7 @@ def HandleCOMPONENTsettings(env):
 if flag_custom_component_add == True or flag_custom_component_remove == True:
     HandleCOMPONENTsettings(env)
 
-if flag_custom_sdkonfig == True and "arduino" in env.subst("$PIOFRAMEWORK"):
+if flag_custom_sdkonfig == True and "arduino" in env.subst("$PIOFRAMEWORK") and "espidf" not in env.subst("$PIOFRAMEWORK"):
     HandleArduinoIDFsettings(env)
     LIB_SOURCE = os.path.join(ProjectConfig.get_instance().get("platformio", "platforms_dir"), "espressif32", "builder", "build_lib")
     if not bool(os.path.exists(os.path.join(PROJECT_DIR, ".dummy"))):
@@ -2056,7 +2060,7 @@ def _skip_prj_source_files(node):
 # Compile Arduino IDF sources
 #
 
-if "arduino" in env.get("PIOFRAMEWORK") and "espidf" not in env.get("PIOFRAMEWORK"):
+if ("arduino" in env.subst("$PIOFRAMEWORK")) and ("espidf" not in env.subst("$PIOFRAMEWORK")):
     def idf_lib_copy(source, target, env):
         env_build = join(env["PROJECT_BUILD_DIR"],env["PIOENV"])
         sdkconfig_h_path = join(env_build,"config","sdkconfig.h")
@@ -2114,7 +2118,7 @@ def idf_lib_copy(source, target, env):
                 print("*** Original Arduino \"idf_component.yml\" couldnt be restored ***")
     env.AddPostAction("checkprogsize", idf_lib_copy)
 
-if "espidf" in env.get("PIOFRAMEWORK") and (flag_custom_component_add == True or flag_custom_component_remove == True):
+if "espidf" in env.subst("$PIOFRAMEWORK") and (flag_custom_component_add == True or flag_custom_component_remove == True):
     def idf_custom_component(source, target, env):
         try:
             shutil.copy(join(ARDUINO_FRAMEWORK_DIR,"idf_component.yml.orig"),join(ARDUINO_FRAMEWORK_DIR,"idf_component.yml"))

builder/main.py

@@ -235,7 +235,7 @@ def __fetch_fs_size(target, source, env):
 mcu = board.get("build.mcu", "esp32")
 toolchain_arch = "xtensa-%s" % mcu
 filesystem = board.get("build.filesystem", "spiffs")
-if mcu in ("esp32c2", "esp32c3", "esp32c6", "esp32h2", "esp32p4"):
+if mcu in ("esp32c2", "esp32c3", "esp32c5", "esp32c6", "esp32h2", "esp32p4"):
     toolchain_arch = "riscv32-esp"
 
 if "INTEGRATION_EXTRA_DATA" not in env:
@@ -256,7 +256,7 @@ def __fetch_fs_size(target, source, env):
     GDB=join(
         platform.get_package_dir(
             "riscv32-esp-elf-gdb"
-            if mcu in ("esp32c2", "esp32c3", "esp32c6", "esp32h2", "esp32p4")
+            if mcu in ("esp32c2", "esp32c3", "esp32c5", "esp32c6", "esp32h2", "esp32p4")
             else "xtensa-esp-elf-gdb"
         )
         or "",

examples/arduino-rmt-blink/platformio.ini

@@ -19,6 +19,13 @@ board = esp32-c3-devkitm-1
 build_flags = -DBUILTIN_RGBLED_PIN=8
               -DNR_OF_LEDS=1
 
+[env:esp32-c5]
+platform = espressif32
+framework = arduino
+board = esp32-c5-devkitc-1
+build_flags = -DBUILTIN_RGBLED_PIN=27
+              -DNR_OF_LEDS=1
+
 [env:esp32-c6]
 platform = espressif32
 framework = arduino

examples/espidf-hello-world/platformio.ini

@@ -20,3 +20,6 @@ board = esp32-s2-kaluga-1
 
 [env:esp32-c3-devkitm-1]
 board = esp32-c3-devkitm-1
+
+[env:esp32-c5-devkitc-1]
+board = esp32-c5-devkitc-1

examples/espidf-ulp-lp/CMakeLists.txt

@@ -1,4 +1,4 @@
 cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(lp_core_pulse_counter)
+project(lp_core_gpio_wake_up_example)

examples/espidf-ulp-lp/README.md

@@ -1,51 +1,26 @@
-| Supported Targets | ESP32-C6 |
-| ----------------- | -------- |
+| Supported Targets | ESP32-C5 | ESP32-C6 | ESP32-P4 |
+| ----------------- | -------- | -------- | -------- |
+# ULP-LP-Core simple example with GPIO Interrupt:
 
-This example demonstrates how to program the ULP Core coprocessor to count pulses on an IO while the main CPUs are either running some other code or are in deep sleep. See the README.md file in the upper level 'examples' directory for more information about examples.
+This example demonstrates how to program the LP-Core coprocessor to wake up from a RTC IO interrupt, instead of waking periodically from the ULP timer.
 
-At runtime, the main code running on the ESP (found in lp_core_pulse_counter_example_main.c) loads ULP program into the `RTC_SLOW_MEM` memory region using `ulp_lp_core_load_binary` function. Main code configures the ULP program by setting up values of some variables and then starts it using `ulp_lp_core_run`. Once the ULP program is started, it monitors the IO pin for pulses.
+ULP program written in C can be found across `ulp/main.c`. The build system compiles and links this program, converts it into binary format, and embeds it into the .rodata section of the ESP-IDF application.
 
-When the ULP program finds an edge in the input signal, it performs debouncing and increments the variable maintaining the total edge count. Once the edge count reaches certain value, ULP triggers wake up from deep sleep. Note that the ULP program keeps running and monitoring the input signal even when the SoC is woken up.
+At runtime, the main code running on the ESP (found in lp_core_gpio_wake_up_example_main.c) loads ULP program into the `RTC_SLOW_MEM` memory region using `ulp_lp_core_load_binary` function. The main code then configures the ULP GPIO wakeup source and starts the coprocessor by using `ulp_lp_core_run` followed by putting the chip into deep sleep mode.
 
-### Hardware Required
+When the wakeup source pin is pulled low the LP-Core coprocessor is woken up, sends a wakeup signal to the main CPU and goes back to sleep again.
 
-To run this example, you should have a development board based on any of the chips listed in the supported targets table at the top and a host machine with a serial input connection.
+In this example the input signal is connected to GPIO2. To change the pin number, check the Chip Pin List document and adjust `WAKEUP_PIN` variable in main.c.
 
-#### Pin Assignment:
 
-**Note:** The following pin assignments are used by default.
+## Example output
 
-
-|                         | Uart Tx | Pulse Count Input |
-| ----------------------- | ------- | ----------------- |
-| ESP32-C6                | GPIO5   | GPIO6             |
-| Host machine            | Rx      | N/A               |
-
-
-## Example Output
-
-The log output from the serial monitor connected to the main core should indicate that the LP core and the LP UART peripheral have been successfully initialized. The main CPU would then enter deep sleep mode.
-
-```bash
-Using pin 6 as pulse counter input
-ULP will wake up processor after every 10 pulses
-Not a ULP wakeup, initializing it!
-Entering in deep sleep
-...
-rst:0x5 (SLEEP_WAKEUP),boot:0xc (SPI_FAST_FLASH_BOOT)
-...
-ULP woke up the main CPU!
-Pulse count: 11
-Entering in deep sleep
 ```
+Not a LP-Core wakeup, initializing it!
+Entering deep sleep
 
-The log output from the serial monitor connected to the LP core should display output as below -
+...
 
-```bash
-LP Core pulse counter started
-Pulse count: 10, wake-up main CPU
+LP-Core woke up the main CPU!
+Entering deep sleep
 ```
-
-## Troubleshooting
-
-(For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you as soon as possible.)

examples/espidf-ulp-lp/platformio.ini

@@ -16,3 +16,8 @@ board = esp32-c6-devkitc-1
 platform = espressif32
 framework = espidf
 board = esp32-p4
+
+[env:esp32-c5]
+platform = espressif32
+framework = espidf
+board = esp32-c5-devkitc-1