118 lines
5.5 KiB
Python
118 lines
5.5 KiB
Python
"""Enable shared-slot internal bootloader update support on qualified nRF52840 targets.
|
|
|
|
The bootloader package uses the ordinary bottom-aligned internal OTA store
|
|
below 0xED000. Qualified internal-only targets also use a dedicated linker that
|
|
reserves the top 64 KiB of SRAM for hybrid flash-prefix/RAM-suffix staging.
|
|
This pre-script binds both features to the exact release inventory and fails
|
|
closed if a target does not use the normal S140 v6/v7 1 MiB application layout.
|
|
"""
|
|
|
|
Import("env")
|
|
|
|
import importlib.util
|
|
import os
|
|
from pathlib import Path
|
|
|
|
|
|
inventory_path = Path(env["PROJECT_DIR"]) / "tools/mota/nrf52_internal_bootloader_targets.txt"
|
|
try:
|
|
direct_targets = {
|
|
line.strip()
|
|
for line in inventory_path.read_text(encoding="utf-8").splitlines()
|
|
if line.strip() and not line.lstrip().startswith("#")
|
|
}
|
|
except OSError as exc:
|
|
raise RuntimeError(f"cannot read nRF52 internal-bootloader inventory: {exc}")
|
|
|
|
requested = (
|
|
os.environ.get("MESHCORE_NRF52_INTERNAL_BOOTLOADER_UPDATE") == "1"
|
|
or env["PIOENV"] in direct_targets
|
|
)
|
|
|
|
# A field node on OTAFIX2.4 cannot receive a hybrid flash/RAM handoff or
|
|
# replace its own bootloader. Keep its ordinary application OTA path and
|
|
# linker when explicitly building a legacy-compatible destination image.
|
|
legacy_flash = os.environ.get("MESHCORE_NRF52_LEGACY_FLASH_OTA")
|
|
if os.environ.get("MESHCORE_NRF52_LEGACY_BOOTLOADER"):
|
|
if os.environ.get("MESHCORE_NRF52_EMBED_BOOTLOADER") != "2.4.12":
|
|
raise RuntimeError("legacy bootloader input requires the embedded 2.4.12 variant")
|
|
if legacy_flash not in (None, "1"):
|
|
raise RuntimeError("legacy bootloader delivery cannot use retained-RAM staging")
|
|
legacy_flash = "1"
|
|
requested = True # the resource hook separately verifies the exact RAK legacy profile
|
|
if legacy_flash not in (None, "0", "1"):
|
|
raise RuntimeError("MESHCORE_NRF52_LEGACY_FLASH_OTA must be 0 or 1")
|
|
if legacy_flash == "1":
|
|
if not requested:
|
|
raise RuntimeError("legacy flash OTA requires a qualified internal nRF52 OTA target")
|
|
|
|
if requested:
|
|
board = env.BoardConfig()
|
|
# Most variants inherit the framework's top-level ``build.ldscript``.
|
|
# A few otherwise ordinary Adafruit nRF52840 boards (notably Keepteen LT1)
|
|
# declare it under ``build.arduino.ldscript`` instead. Resolve both forms
|
|
# before making the safety decision; an unknown map still fails closed.
|
|
current = str(
|
|
board.get("build.ldscript", "")
|
|
or board.get("build.arduino.ldscript", "")
|
|
)
|
|
linker_versions = {
|
|
"nrf52840_s140_v6.ld": "v6",
|
|
"nrf52840_s140_v7.ld": "v7",
|
|
}
|
|
# Compare the complete filename, not merely a suffix: a custom linker such
|
|
# as ``board_nrf52840_s140_v6.ld`` must not be mistaken for the qualified
|
|
# normal map and silently replaced with the mOTA layout.
|
|
current_name = current.replace("\\", "/").rsplit("/", 1)[-1]
|
|
suffix = linker_versions.get(current_name)
|
|
mcu = str(board.get("build.mcu", "")).lower()
|
|
if mcu != "nrf52840" or suffix is None:
|
|
raise RuntimeError(
|
|
"shared-slot bootloader update requires an nRF52840 with the normal "
|
|
f"S140 v6/v7 non-ExtraFS linker; found mcu={mcu or 'none'} "
|
|
f"linker={current or 'none'}"
|
|
)
|
|
if legacy_flash == "1":
|
|
# Unified RAK receivers can select SD at runtime even in legacy flash
|
|
# mode. Reserve its 72-byte authorization ABI without a hybrid arena.
|
|
policy_path = Path(env["PROJECT_DIR"]) / "scripts/nrf52_flash_trim.py"
|
|
spec = importlib.util.spec_from_file_location("nrf52_legacy_sd_flags", policy_path)
|
|
policy = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(policy)
|
|
definitions = policy.flag_defines(env.get("BUILD_FLAGS", ()),
|
|
env.get("CPPDEFINES", ()))
|
|
sd_receiver = (definitions.get("OTA_SD_STORE") is not None and
|
|
definitions.get("OTA_SEEDER_ONLY") is None)
|
|
if sd_receiver:
|
|
sd_linker = Path(env["PROJECT_DIR"]) / "boards" / (
|
|
"nrf52840_s140_%s_sd_ota.ld" % suffix
|
|
)
|
|
if not sd_linker.is_file():
|
|
raise RuntimeError("missing legacy SD authorization linker: %s" % sd_linker)
|
|
board.update("build.ldscript", str(sd_linker))
|
|
env.Replace(LDSCRIPT_PATH=str(sd_linker))
|
|
print("nRF52 legacy flash OTA: %s; reserved SD authorization; no hybrid RAM or bootloader self-update"
|
|
% sd_linker.name)
|
|
else:
|
|
print("nRF52 legacy flash OTA: ordinary linker; no hybrid RAM or bootloader self-update")
|
|
else:
|
|
mota_linker = Path(env["PROJECT_DIR"]) / "boards" / (
|
|
"nrf52840_s140_%s_mota64.ld" % suffix
|
|
)
|
|
if not mota_linker.is_file():
|
|
raise RuntimeError("missing mOTA hybrid linker: %s" % mota_linker)
|
|
|
|
# Direct PIO and build.sh aliases must select the same feature/map pair.
|
|
env.AppendUnique(CPPDEFINES=[
|
|
"OTA_INTERNAL_BOOTLOADER_UPDATE",
|
|
"OTA_HYBRID_RAM_STORE",
|
|
])
|
|
# The framework normally resolves LDSCRIPT_PATH from BoardConfig. Set
|
|
# both so ordering relative to that framework step cannot change it.
|
|
board.update("build.ldscript", str(mota_linker))
|
|
env.Replace(LDSCRIPT_PATH=str(mota_linker))
|
|
print(
|
|
"nRF52 shared-slot bootloader update: %s; fixed 64 KiB mOTA RAM arena; runtime EndF headroom required"
|
|
% mota_linker.name
|
|
)
|