Add espressif esp-idf-size to the build engine to show firmware metrics (#180)

Author: Jason2866

boards/m5stack-atoms3u.json

@@ -0,0 +1,42 @@
+{
+  "build": {
+    "arduino": {
+      "memory_type": "qio_opi",
+      "partitions": "default_8MB.csv"
+    },
+    "core": "esp32",
+    "extra_flags": [
+      "-DARDUINO_M5Stack_ATOMS3U",
+      "-DARDUINO_USB_MODE=1",
+      "-DARDUINO_USB_CDC_ON_BOOT=1",
+      "-DARDUINO_RUNNING_CORE=1",
+      "-DARDUINO_EVENT_RUNNING_CORE=1"
+    ],
+    "f_cpu": "240000000L",
+    "f_flash": "80000000L",
+    "flash_mode": "dio",
+    "mcu": "esp32s3",
+    "variant": "m5stack_atoms3"
+  },
+  "connectivity": [
+    "bluetooth",
+    "wifi"
+  ],
+  "debug": {
+    "openocd_target": "esp32s3.cfg"
+  },
+  "frameworks": [
+    "arduino",
+    "espidf"
+  ],
+  "name": "M5Stack AtomS3U",
+  "upload": {
+    "flash_size": "8MB",
+    "maximum_ram_size": 327680,
+    "maximum_size": 8388608,
+    "require_upload_port": true,
+    "speed": 460800
+  },
+  "url": "https://docs.m5stack.com/en/core/AtomS3U",
+  "vendor": "M5Stack"
+}

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

@@ -103,7 +103,8 @@ def _get_installed_pip_packages():
         "wheel": ">=0.35.1",
         "rich-click": ">=1.8.6",
         "PyYAML": ">=6.0.2",
-        "intelhex": ">=2.3.0"
+        "intelhex": ">=2.3.0",
+        "esp-idf-size": ">=1.6.1"
     }
 
     installed_packages = _get_installed_pip_packages()

builder/frameworks/espidf.py

@@ -56,6 +56,11 @@
 env = DefaultEnvironment()
 env.SConscript("_embed_files.py", exports="env")
 
+# remove maybe existing old map file in project root
+map_file = os.path.join(env.subst("$PROJECT_DIR"), env.subst("$PROGNAME") + ".map")
+if os.path.exists(map_file):
+    os.remove(map_file)
+
 def install_standard_python_deps():
     def _get_installed_standard_pip_packages():
         result = {}
@@ -83,7 +88,8 @@ def _get_installed_standard_pip_packages():
     deps = {
         "wheel": ">=0.35.1",
         "rich-click": ">=1.8.6",
-        "PyYAML": ">=6.0.2"
+        "PyYAML": ">=6.0.2",
+        "esp-idf-size": ">=1.6.1"
     }
 
     installed_packages = _get_installed_standard_pip_packages()
@@ -147,13 +153,6 @@ def _get_installed_standard_pip_packages():
 assert os.path.isdir(FRAMEWORK_DIR)
 assert os.path.isdir(TOOLCHAIN_DIR)
 
-if (
-    ["espidf"] == env.get("PIOFRAMEWORK")
-    and semantic_version.Version.coerce(__version__)
-    <= semantic_version.Version("6.1.10")
-    and "__debug" in COMMAND_LINE_TARGETS
-):
-    print("Warning! Debugging an IDF project requires PlatformIO Core >= 6.1.11!")
 
 if "arduino" in env.subst("$PIOFRAMEWORK"):
     ARDUINO_FRAMEWORK_DIR = platform.get_package_dir("framework-arduinoespressif32")
@@ -401,7 +400,6 @@ def get_project_lib_includes(env):
 
     return paths
 
-
 def is_cmake_reconfigure_required(cmake_api_reply_dir):
     cmake_cache_file = os.path.join(BUILD_DIR, "CMakeCache.txt")
     cmake_txt_files = [
@@ -1791,18 +1789,30 @@ def get_python_exe():
         LIBSOURCE_DIRS=[os.path.join(ARDUINO_FRAMEWORK_DIR, "libraries")]
     )
 
+extra_cmake_args = [
+    "-DIDF_TARGET=" + idf_variant,
+    "-DPYTHON_DEPS_CHECKED=1",
+    "-DEXTRA_COMPONENT_DIRS:PATH=" + ";".join(extra_components),
+    "-DPYTHON=" + get_python_exe(),
+    "-DSDKCONFIG=" + SDKCONFIG_PATH,
+]
+
+if "CPPDEFINES" in env:
+    flatten_cppdefines = env.Flatten(env['CPPDEFINES'])
+    if "SHOW_METRICS" in flatten_cppdefines:
+        # This will add the linker flag for the map file
+        extra_cmake_args.append(
+            f'-DCMAKE_EXE_LINKER_FLAGS=-Wl,-Map={os.path.join(BUILD_DIR, env.subst("$PROGNAME") + ".map")}'
+        )
+
+# Add any extra args from board config
+extra_cmake_args += click.parser.split_arg_string(board.get("build.cmake_extra_args", ""))
+
 print("Reading CMake configuration...")
 project_codemodel = get_cmake_code_model(
     PROJECT_DIR,
     BUILD_DIR,
-    [
-        "-DIDF_TARGET=" + idf_variant,
-        "-DPYTHON_DEPS_CHECKED=1",
-        "-DEXTRA_COMPONENT_DIRS:PATH=" + ";".join(extra_components),
-        "-DPYTHON=" + get_python_exe(),
-        "-DSDKCONFIG=" + SDKCONFIG_PATH,
-    ]
-    + click.parser.split_arg_string(board.get("build.cmake_extra_args", "")),
+    extra_cmake_args
 )
 
 # At this point the sdkconfig file should be generated by the underlying build system
@@ -1978,7 +1988,7 @@ def _skip_prj_source_files(node):
         (
             board.get(
                 "upload.bootloader_offset",
-                "0x1000" if mcu in ["esp32", "esp32s2"] else ("0x2000" if mcu in ["esp32p4"] else "0x0"),
+                "0x1000" if mcu in ["esp32", "esp32s2"] else ("0x2000" if mcu in ["esp32c5", "esp32p4"] else "0x0"),
             ),
             os.path.join("$BUILD_DIR", "bootloader.bin"),
         ),

builder/frameworks/ulp.py

@@ -37,7 +37,7 @@ def prepare_ulp_env_vars(env):
 
     toolchain_path = platform.get_package_dir(
         "toolchain-xtensa-esp-elf"
-        if idf_variant not in ("esp32c6", "esp32p4")
+        if idf_variant not in ("esp32c5","esp32c6", "esp32p4")
         else "toolchain-riscv32-esp"
     )
 

builder/main.py

@@ -21,6 +21,9 @@
     DefaultEnvironment)
 
 from platformio.util import get_serial_ports
+from platformio.project.helpers import get_project_dir
+
+import os
 
 env = DefaultEnvironment()
 platform = env.PioPlatform()
@@ -68,12 +71,10 @@ def _normalize_frequency(frequency):
     frequency = str(frequency).replace("L", "")
     return str(int(int(frequency) / 1000000)) + "m"
 
-
 def _get_board_f_flash(env):
     frequency = env.subst("$BOARD_F_FLASH")
     return _normalize_frequency(frequency)
 
-
 def _get_board_f_image(env):
     board_config = env.BoardConfig()
     if "build.f_image" in board_config:
@@ -88,7 +89,6 @@ def _get_board_f_boot(env):
 
     return _get_board_f_flash(env)
 
-
 def _get_board_flash_mode(env):
     if _get_board_memory_type(env) in (
         "opi_opi",
@@ -101,15 +101,13 @@ def _get_board_flash_mode(env):
         return "dio"
     return mode
 
-
 def _get_board_boot_mode(env):
     memory_type = env.BoardConfig().get("build.arduino.memory_type", "")
     build_boot = env.BoardConfig().get("build.boot", "$BOARD_FLASH_MODE")
     if memory_type in ("opi_opi", "opi_qspi"):
         build_boot = "opi"
     return build_boot
 
-
 def _parse_size(value):
     if isinstance(value, int):
         return value
@@ -122,7 +120,6 @@ def _parse_size(value):
         return int(value[:-1]) * base
     return value
 
-
 def _parse_partitions(env):
     partitions_csv = env.subst("$PARTITIONS_TABLE_CSV")
     if not isfile(partitions_csv):
@@ -163,7 +160,6 @@ def _parse_partitions(env):
     env["INTEGRATION_EXTRA_DATA"].update({"application_offset": str(hex(app_offset))})
     return result
 
-
 def _update_max_upload_size(env):
     if not env.get("PARTITIONS_TABLE_CSV"):
         return
@@ -192,17 +188,13 @@ def _update_max_upload_size(env):
             board.update("upload.maximum_size", _parse_size(p["size"]))
             break
 
-
-
 def _to_unix_slashes(path):
     return path.replace("\\", "/")
 
-
 #
 # Filesystem helpers
 #
 
-
 def fetch_fs_size(env):
     fs = None
     for p in _parse_partitions(env):
@@ -226,17 +218,15 @@ def fetch_fs_size(env):
         env["FS_START"] += 4096
         env["FS_SIZE"] -= 4096
 
-
 def __fetch_fs_size(target, source, env):
     fetch_fs_size(env)
     return (target, source)
 
-
 board = env.BoardConfig()
 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:
@@ -257,7 +247,7 @@ def __fetch_fs_size(target, source, env):
     GDB=join(
         platform.get_package_dir(
             "tool-riscv32-esp-elf-gdb"
-            if mcu in ("esp32c2", "esp32c3", "esp32c6", "esp32h2", "esp32p4")
+            if mcu in ("esp32c2", "esp32c3", "esp32c5", "esp32c6", "esp32h2", "esp32p4")
             else "tool-xtensa-esp-elf-gdb"
         )
         or "",
@@ -367,6 +357,24 @@ def check_lib_archive_exists():
 if not env.get("PIOFRAMEWORK"):
     env.SConscript("frameworks/_bare.py", exports="env")
 
+
+def firmware_metrics(target, source, env):
+    map_file = os.path.join(env.subst("$BUILD_DIR"), env.subst("$PROGNAME") + ".map")
+    if not os.path.isfile(map_file):
+        # map file can be in project dir
+        map_file = os.path.join(get_project_dir(), env.subst("$PROGNAME") + ".map")
+
+    if os.path.isfile(map_file):
+        try:
+            import subprocess
+            # Show output of esp_idf_size, but suppresses the command echo
+            subprocess.run([
+                env.subst("$PYTHONEXE"), "-m", "esp_idf_size", "--ng", map_file
+            ], check=False)
+        except Exception:
+            print("Warning: Failed to run firmware metrics. Is esp-idf-size installed?")
+            pass
+
 #
 # Target: Build executable and linkable firmware or FS image
 #
@@ -381,6 +389,9 @@ def check_lib_archive_exists():
         target_firm = join("$BUILD_DIR", "${PROGNAME}.bin")
 else:
     target_elf = env.BuildProgram()
+    silent_action = env.Action(firmware_metrics)
+    silent_action.strfunction = lambda target, source, env: '' # hack to silence scons command output
+    env.AddPostAction(target_elf, silent_action)
     if set(["buildfs", "uploadfs", "uploadfsota"]) & set(COMMAND_LINE_TARGETS):
         target_firm = env.DataToBin(
             join("$BUILD_DIR", "${ESP32_FS_IMAGE_NAME}"), "$PROJECT_DATA_DIR"
@@ -565,6 +576,7 @@ def check_lib_archive_exists():
 else:
     sys.stderr.write("Warning! Unknown upload protocol %s\n" % upload_protocol)
 
+
 env.AddPlatformTarget("upload", target_firm, upload_actions, "Upload")
 env.AddPlatformTarget("uploadfs", target_firm, upload_actions, "Upload Filesystem Image")
 env.AddPlatformTarget(

examples/arduino-blink/platformio.ini

@@ -43,8 +43,7 @@ custom_component_remove = espressif/esp_hosted
                           espressif/esp_diagnostics
                           espressif/esp_rainmaker
                           espressif/rmaker_common
-custom_component_add =
-                          espressif/cmake_utilities @ 0.*
+custom_component_add =    espressif/cmake_utilities @ 0.*
 
 [env:esp32-s3-arduino_nano_esp32]
 platform = espressif32

examples/espidf-blink/platformio.ini

@@ -17,6 +17,7 @@ build_flags =
 	-D CONFIG_BLINK_GPIO=2
 	-D CONFIG_BLINK_LED_GPIO=2
 	-D CONFIG_BLINK_PERIOD=1000
+	-D SHOW_METRICS
 
 [env:esp32-c2-devkitm-1]
 platform = espressif32
@@ -27,6 +28,7 @@ build_flags =
 	-D CONFIG_BLINK_GPIO=8
 	-D CONFIG_BLINK_LED_GPIO=8
 	-D CONFIG_BLINK_PERIOD=1000
+	-D SHOW_METRICS
 
 [env:esp32-c6-devkitc-1]
 platform = espressif32
@@ -37,3 +39,4 @@ build_flags =
 	-D CONFIG_BLINK_GPIO=2
 	-D CONFIG_BLINK_LED_GPIO=2
 	-D CONFIG_BLINK_PERIOD=1000
+	-D SHOW_METRICS

examples/espidf-coap-server/platformio.ini

@@ -18,3 +18,6 @@ board_build.embed_txtfiles =
 
 [env:esp-wrover-kit]
 board = esp-wrover-kit
+build_flags =
+  -D SHOW_METRICS
+

platform.py

@@ -276,7 +276,7 @@ def _add_dynamic_options(self, board):
         # A special case for the Kaluga board that has a separate interface config
         if board.id == "esp32-s2-kaluga-1":
             supported_debug_tools.append("ftdi")
-        if board.get("build.mcu", "") in ("esp32c3", "esp32c6", "esp32s3", "esp32h2"):
+        if board.get("build.mcu", "") in ("esp32c3", "esp32c5", "esp32c6", "esp32s3", "esp32h2", "esp32p4"):
             supported_debug_tools.append("esp-builtin")
 
         upload_protocol = board.manifest.get("upload", {}).get("protocol")