Michael A. CojocariandClaude Opus 5.5
9c0cccd2fb
lib_deps takes RadioLib ^7.6.0, and a fresh fetch now brings 7.8.1. Its LR11x0::config() wraps driveDiosInSleepMode in its own skip for LR1110 firmware below 0x0306, so the call sits one level deeper and the patch script no longer found it. It failed closed, stopping every M9 build at its pre-script. The script now knows both shapes. The patch still matters on 7.8.1: firmware 0x0306 and 0x0307 get past RadioLib's own skip, send the command, answer CMD_PERR and would abort radio init with -706. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016yt7fNCKmafm9LtRjyuUmS
113 lines
5.2 KiB
Python
113 lines
5.2 KiB
Python
# Patches the vendored RadioLib so LR11x0::config() tolerates old LR1110
|
|
# transceiver firmware that predates DriveDiosInSleepMode (opcode 0x012A,
|
|
# added in the 0x0308 firmware release). RadioLib >= 7.x sends it
|
|
# unconditionally during begin(); older chip firmware answers CMD_PERR,
|
|
# which turns an otherwise healthy radio.begin() into -706
|
|
# (RADIOLIB_ERR_SPI_CMD_INVALID). Preproduction Elecrow ThinkNode M9 units
|
|
# ship with such firmware (Meshtastic works on them only because it pins an
|
|
# older RadioLib that doesn't send the command).
|
|
#
|
|
# The command is an optional nicety (stops DIO glitches in sleep mode), so
|
|
# skipping it on old firmware is safe.
|
|
#
|
|
# Idempotent. Each PlatformIO env has its own libdeps copy, so this only
|
|
# affects envs that list this script in extra_scripts (the M9 env).
|
|
#
|
|
# Fail-closed: an unpatched binary boots to a fatal -706 radio-init screen on
|
|
# preprod units, indistinguishable from a good build except by its build log —
|
|
# so any state where the patch can't land ABORTS the build instead of warning.
|
|
# The one soft case is a completely fresh checkout: pre-scripts run before the
|
|
# LDF fetches lib_deps, so there is nothing to patch yet, and aborting here
|
|
# would stop the build before RadioLib can even be downloaded. For that case a
|
|
# pre-link check (below) patches late and fails the link, so the NEXT `pio run`
|
|
# compiles the patched source — no linked binary can ever ship unpatched.
|
|
Import("env")
|
|
import os
|
|
|
|
MARKER = "wadamesh-lr1110-oldfw-patch"
|
|
|
|
|
|
def _shape(ind):
|
|
"""The call and its assert at indent `ind`, unpatched and patched."""
|
|
old = (ind + "state = this->driveDiosInSleepMode(true);\n"
|
|
+ ind + "RADIOLIB_ASSERT(state);")
|
|
new = "\n".join([
|
|
ind + "state = this->driveDiosInSleepMode(true);",
|
|
ind + "// wadamesh-lr1110-oldfw-patch: LR1110 transceiver FW older than 0x0308",
|
|
ind + "// doesn't implement DriveDiosInSleepMode (0x012A) and answers CMD_PERR,",
|
|
ind + "// which would abort init (-706) on an otherwise healthy radio. The command",
|
|
ind + "// only stops DIO glitches in sleep mode - safe to skip on old firmware.",
|
|
ind + "if(state == RADIOLIB_ERR_SPI_CMD_INVALID) {",
|
|
ind + " RADIOLIB_DEBUG_BASIC_PRINTLN(\"DriveDiosInSleepMode unsupported (old LR11x0 FW), skipping\");",
|
|
ind + " state = RADIOLIB_ERR_NONE;",
|
|
ind + "}",
|
|
ind + "RADIOLIB_ASSERT(state);",
|
|
])
|
|
return old, new
|
|
|
|
|
|
# RadioLib 7.6/7.7 call it unconditionally (2-space indent). 7.8.1 wraps it in its own
|
|
# skip for LR1110 firmware below 0x0306 (4-space indent), which still leaves 0x0306 and
|
|
# 0x0307 sending a command they answer with CMD_PERR, so the patch still applies there.
|
|
SHAPES = [_shape(" "), _shape(" ")]
|
|
|
|
path = os.path.join(env.subst("$PROJECT_LIBDEPS_DIR"), env.subst("$PIOENV"),
|
|
"RadioLib", "src", "modules", "LR11x0", "LR11x0.cpp")
|
|
|
|
|
|
def apply_patch():
|
|
"""Patch LR11x0.cpp in place. Returns an error string, or None on success
|
|
(including already-patched)."""
|
|
with open(path) as f:
|
|
src = f.read()
|
|
if MARKER in src:
|
|
print("[patch_radiolib_lr11x0] already patched")
|
|
return None
|
|
shape = next(((o, n) for o, n in SHAPES if o in src), None)
|
|
if shape is None:
|
|
# lib_deps uses a caret range (^7.6.0), so a `pio pkg update` can pull
|
|
# a RadioLib whose config() no longer matches the expected shape.
|
|
return ("LR11x0::config() doesn't match the expected shape (RadioLib "
|
|
"version drift?) - port the old-FW patch by hand, or pin "
|
|
"lib_deps back to a known-good version")
|
|
with open(path, "w") as f:
|
|
f.write(src.replace(shape[0], shape[1], 1))
|
|
print("[patch_radiolib_lr11x0] patched LR11x0::config() for old-FW tolerance")
|
|
return None
|
|
|
|
|
|
if os.path.isfile(path):
|
|
error = apply_patch()
|
|
if error is not None:
|
|
print("[patch_radiolib_lr11x0] ERROR: %s" % error)
|
|
env.Exit(1)
|
|
else:
|
|
# Fresh checkout: RadioLib isn't fetched yet. Let the build proceed so the
|
|
# LDF can download it; the pre-link check below is what keeps this run from
|
|
# producing an unpatched binary.
|
|
print("[patch_radiolib_lr11x0] RadioLib not fetched yet - patch deferred to pre-link check")
|
|
|
|
|
|
def verify_patched(target, source, env):
|
|
# Runs right before the link, after libdeps exist and every RadioLib object
|
|
# has been compiled. A missing marker here means those objects came from
|
|
# UNPATCHED source: patch now (SCons's content signatures then recompile
|
|
# LR11x0.cpp on the next run) and fail this link. Non-zero return = SCons
|
|
# build failure, so no .elf/.bin is produced.
|
|
if not os.path.isfile(path):
|
|
print("[patch_radiolib_lr11x0] ERROR: %s still missing at link time" % path)
|
|
return 1
|
|
with open(path) as f:
|
|
if MARKER in f.read():
|
|
return 0
|
|
error = apply_patch()
|
|
if error is not None:
|
|
print("[patch_radiolib_lr11x0] ERROR: %s" % error)
|
|
return 1
|
|
print("[patch_radiolib_lr11x0] ERROR: RadioLib was fetched during this build and is")
|
|
print("[patch_radiolib_lr11x0] ERROR: now patched - re-run `pio run` to compile it in")
|
|
return 1
|
|
|
|
|
|
env.AddPreAction("$BUILD_DIR/${PROGNAME}.elf", verify_patched)
|