Meshtastic build manifest (#8248)

extra_scripts/disable_adafruit_usb.py

@@ -1,10 +1,9 @@
+#!/usr/bin/env python3
 # trunk-ignore-all(flake8/F821)
 # trunk-ignore-all(ruff/F821)
 
 Import("env")
 
-# NOTE: This is not currently used, but can serve as an example on how to write extra_scripts
-
 # print("Current CLI targets", COMMAND_LINE_TARGETS)
 # print("Current Build targets", BUILD_TARGETS)
 # print("CPP defs", env.get("CPPDEFINES"))

extra_scripts/esp32_extra.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+# trunk-ignore-all(ruff/F821)
+# trunk-ignore-all(flake8/F821): For SConstruct imports
+# trunk-ignore-all(ruff/E402): Hacky esptool import
+# trunk-ignore-all(flake8/E402): Hacky esptool import
+import sys
+from os.path import join
+
+Import("env")
+platform = env.PioPlatform()
+
+sys.path.append(join(platform.get_package_dir("tool-esptoolpy")))
+import esptool
+
+
+def esp32_create_combined_bin(source, target, env):
+    # this sub is borrowed from ESPEasy build toolchain. It's licensed under GPL V3
+    # https://github.com/letscontrolit/ESPEasy/blob/mega/tools/pio/post_esp32.py
+    print("Generating combined binary for serial flashing")
+
+    app_offset = 0x10000
+
+    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}.factory.bin")
+    sections = env.subst(env.get("FLASH_EXTRA_IMAGES"))
+    firmware_name = env.subst("$BUILD_DIR/${PROGNAME}.bin")
+    chip = env.get("BOARD_MCU")
+    board = env.BoardConfig()
+    flash_size = board.get("upload.flash_size")
+    flash_freq = board.get("build.f_flash", "40m")
+    flash_freq = flash_freq.replace("000000L", "m")
+    flash_mode = board.get("build.flash_mode", "dio")
+    memory_type = board.get("build.arduino.memory_type", "qio_qspi")
+    if flash_mode == "qio" or flash_mode == "qout":
+        flash_mode = "dio"
+    if memory_type == "opi_opi" or memory_type == "opi_qspi":
+        flash_mode = "dout"
+    cmd = [
+        "--chip",
+        chip,
+        "merge_bin",
+        "-o",
+        new_file_name,
+        "--flash_mode",
+        flash_mode,
+        "--flash_freq",
+        flash_freq,
+        "--flash_size",
+        flash_size,
+    ]
+
+    print("    Offset | File")
+    for section in sections:
+        sect_adr, sect_file = section.split(" ", 1)
+        print(f" -  {sect_adr} | {sect_file}")
+        cmd += [sect_adr, sect_file]
+
+    print(f" - {hex(app_offset)} | {firmware_name}")
+    cmd += [hex(app_offset), firmware_name]
+
+    print("Using esptool.py arguments: %s" % " ".join(cmd))
+
+    esptool.main(cmd)
+
+
+env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", esp32_create_combined_bin)
+
+esp32_kind = env.GetProjectOption("custom_esp32_kind")
+if esp32_kind == "esp32":
+    # Free up some IRAM by removing auxiliary SPI flash chip drivers.
+    # Wrapped stub symbols are defined in src/platform/esp32/iram-quirk.c.
+    env.Append(
+        LINKFLAGS=[
+            "-Wl,--wrap=esp_flash_chip_gd",
+            "-Wl,--wrap=esp_flash_chip_issi",
+            "-Wl,--wrap=esp_flash_chip_winbond",
+        ]
+    )
+else:
+    # For newer ESP32 targets, using newlib nano works better.
+    env.Append(LINKFLAGS=["--specs=nano.specs", "-u", "_printf_float"])

extra_scripts/esp32_pre.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+# trunk-ignore-all(ruff/F821)
+# trunk-ignore-all(flake8/F821): For SConstruct imports
+import json
+import sys
+from os.path import isfile
+
+Import("env")
+
+
+# From https://github.com/platformio/platform-espressif32/blob/develop/builder/main.py
+def _parse_size(value):
+    if isinstance(value, int):
+        return value
+    elif value.isdigit():
+        return int(value)
+    elif value.startswith("0x"):
+        return int(value, 16)
+    elif value[-1].upper() in ("K", "M"):
+        base = 1024 if value[-1].upper() == "K" else 1024 * 1024
+        return int(value[:-1]) * base
+    return value
+
+
+def _parse_partitions(env):
+    partitions_csv = env.subst("$PARTITIONS_TABLE_CSV")
+    if not isfile(partitions_csv):
+        sys.stderr.write(
+            "Could not find the file %s with partitions " "table.\n" % partitions_csv
+        )
+        env.Exit(1)
+        return
+
+    result = []
+    # The first offset is 0x9000 because partition table is flashed to 0x8000 and
+    # occupies an entire flash sector, which size is 0x1000
+    next_offset = 0x9000
+    with open(partitions_csv) as fp:
+        for line in fp.readlines():
+            line = line.strip()
+            if not line or line.startswith("#"):
+                continue
+            tokens = [t.strip() for t in line.split(",")]
+            if len(tokens) < 5:
+                continue
+
+            bound = 0x10000 if tokens[1] in ("0", "app") else 4
+            calculated_offset = (next_offset + bound - 1) & ~(bound - 1)
+            partition = {
+                "name": tokens[0],
+                "type": tokens[1],
+                "subtype": tokens[2],
+                "offset": tokens[3] or calculated_offset,
+                "size": tokens[4],
+                "flags": tokens[5] if len(tokens) > 5 else None,
+            }
+            result.append(partition)
+            next_offset = _parse_size(partition["offset"]) + _parse_size(
+                partition["size"]
+            )
+
+    return result
+
+
+def mtjson_esp32_part(target, source, env):
+    part = _parse_partitions(env)
+    pj = json.dumps(part)
+    # print(f"JSON_PARTITIONS: {pj}")
+    # Dump json string to 'custom_mtjson_part' variable to use later when writing the manifest
+    env.Replace(custom_mtjson_part=pj)
+
+
+env.AddPreAction("mtjson", mtjson_esp32_part)

extra_scripts/nrf52_extra.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+# trunk-ignore-all(ruff/F821)
+# trunk-ignore-all(flake8/F821): For SConstruct imports
+
+import sys
+from os.path import basename
+
+Import("env")
+
+
+# Custom HEX from ELF
+# Convert hex to uf2 for nrf52
+def nrf52_hex_to_uf2(source, target, env):
+    hex_path = target[0].get_abspath()
+    # When using merged hex, drop 'merged' from uf2 filename
+    uf2_path = hex_path.replace(".merged.", ".")
+    uf2_path = uf2_path.replace(".hex", ".uf2")
+    env.Execute(
+        env.VerboseAction(
+            f'"{sys.executable}" ./bin/uf2conv.py "{hex_path}" -c -f 0xADA52840 -o "{uf2_path}"',
+            f"Generating UF2 file from {basename(hex_path)}",
+        )
+    )
+
+
+def nrf52_mergehex(source, target, env):
+    hex_path = target[0].get_abspath()
+    merged_hex_path = hex_path.replace(".hex", ".merged.hex")
+    merge_with = None
+    if "wio-sdk-wm1110" == str(env.get("PIOENV")):
+        merge_with = env.subst("$PROJECT_DIR/bin/s140_nrf52_7.3.0_softdevice.hex")
+    else:
+        print("merge_with not defined for this target")
+
+    if merge_with is not None:
+        env.Execute(
+            env.VerboseAction(
+                f'"$PROJECT_DIR/bin/mergehex" -m "{hex_path}" "{merge_with}" -o "{merged_hex_path}"',
+                "Merging HEX with SoftDevice",
+            )
+        )
+        print(f'Merged file saved at "{basename(merged_hex_path)}"')
+        nrf52_hex_to_uf2([hex_path, merge_with], [env.File(merged_hex_path)], env)
+
+
+# if WM1110 target, merge hex with softdevice 7.3.0
+if "wio-sdk-wm1110" == env.get("PIOENV"):
+    env.AddPostAction("$BUILD_DIR/${PROGNAME}.hex", nrf52_mergehex)
+else:
+    env.AddPostAction("$BUILD_DIR/${PROGNAME}.hex", nrf52_hex_to_uf2)

extra_scripts/stm32_extra.py

@@ -1,7 +1,9 @@
+#!/usr/bin/env python3
 # trunk-ignore-all(ruff/F821)
 # trunk-ignore-all(flake8/F821): For SConstruct imports
 
 Import("env")
+
 # Custom HEX from ELF
 env.AddPostAction(
     "$BUILD_DIR/${PROGNAME}.elf",