Efuse logical-map override: end-user loadable patch file (RAM-only)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- c, json
- Domain
- embedded-iot
Research direction
Start with the four materialization sites named in the issue: src/jaguar1/EepromManager.cpp, src/jaguar2/HalJaguar2.cpp, and both variant paths in src/jaguar3/HalJaguar3.cpp; also inspect examples/common/env_config.cpp and the existing replay_wseq handling. Begin by establishing machine-readable logical-map dumps and headless tests, then cover sparse patch parsing, each generation’s apply point, and the 8814A late re-read. Done means tests cover ID behavior and reapplication, and diagnostics make overrides visible; the issue also calls for hardware validation.
Written by the indexing model from the issue text.
Description
Motivation
The efuse logical map is the root of almost every per-adapter parameter we consume: MAC, xtal cap, thermal baseline, RFE type, PA/LNA types, per-channel TX-power PG base. Today it is read-only and invisible except for the stderr DEVOURER_EFUSE_DUMP text (Jaguar2/3 only). A RAM-only override lets us:
- test "what would this adapter do with rfe_type=N / xtal=M" without touching hardware state,
- resurrect adapters with corrupted efuse (force the autoload-OK ID, supply a sane map),
- act as the validation harness for physical efuse programming (see follow-up issue): dump → edit → run with override → validate on-air → only then burn.
Shape
A sparse patch file applied after logical-map materialization, before field parsing.
DeviceConfig::Debug::efuse_override(path,std::optional<std::string>), env-mapped asDEVOURER_EFUSE_OVERRIDEinexamples/common/env_config.cpp— same pattern asreplay_wseq, which is the existing precedent for a library-loaded file path.- Grammar:
0xCA=0x04single bytes,0x22:8=xxxxxxxxxxxxxxxxruns. A full-map binary replace can be a second, explicitly named mode later — it must not be the default (a full dump from adapter X replayed on adapter Y silently clobbers Y's calibration). - The patch parser and the apply helper are generation-neutral pure functions → live in
src/next toPhyTableLoader, unit-testable headlessly (ctest).
Implementation details / hazards
- Four materialization sites, not one. Jaguar1 decodes into
efuse_eeprom_data(src/jaguar1/EepromManager.cpp:1382), Jaguar2 into_efuse_map(src/jaguar2/HalJaguar2.cpp:305), Jaguar3 has two variant paths — 8822C standard walk and 8822E packed 2-byte headers into a one-shot cache (src/jaguar3/HalJaguar3.cpp:621-719). One sharedapply_efuse_override(map, len)called at each site. - 8814A re-reads efuse after FW download (
LateInitFor8814A,src/jaguar1/EepromManager.cpp:89). The override must re-apply on that second read or the 8814 silently loses the patch. Needs a dedicated test. - 8822E PA bias bypasses the logical map — it reads physical addresses 0x5c5–0x5c8 during the power-cut bracket (
src/jaguar3/HalJaguar3.cpp:580). A logical override cannot affect it. v1: document the hole; aphys:patch plane doubles the surface and is not worth it yet. - Autoload/ID semantics cut both ways. Jaguar1 gates on ID
0x8129at offset 0x00 (Hal_EfuseParseIDCode8812A). A wrong override flips the device into autoload-fail defaults; forcing it right is how you resurrect a corrupt-efuse adapter. Both directions need tests. - Dump tooling is a prerequisite. You cannot author an override without a dump in the same grammar. Extend
DEVOURER_EFUSE_DUMPto emit a machine-readable logical map on all three generations (JSONLefuse.mapevent or file) — today it is stderr text and Jaguar2/3 only; Jaguar1 only has the physicalReadPhysicalEfuseMaphealth probe. - Footgun visibility. One-shot
Wdiagnostic diffing every overridden byte + anefuse.overrideJSONL event, so test scripts can assert the patch took effect and nobody benchmarks on doctored calibration without noticing.
Suggested milestones
- Machine-readable logical-map dump, all generations (
efuse.mapevent). - Sparse-patch parser +
apply_efuse_overrideinsrc/, headless selftests. - Wire into the four materialization sites (incl. the 8814A late re-read) +
efuse.overrideevent. - Hardware validation: override rfe_type / xtal on a bench adapter, confirm the parsed-field logs and on-air behavior follow.
- Dominant language
- C
- Stars
- 56
- Forks
- 29
- Avg merge
- 3h 43m
- Merged PRs (30d)
- 75
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenIPC/devourer
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Follow-ups left open by the 8822B fast bandwidth toggle fix (#584)Possibly taken @josephnef claimed this today. Openenhancement
Difficulty 4/5 3-5 days Newbie friendliness 42/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 12/100
OpenIPC/devourer#579 · 1 comment ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 12/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 8/100
Maintainers usually reply within 1 day
All issues in OpenIPC/devourer
Similar issues
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
389ds/389-ds-base#8157 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
coolsnowwolf/lede#14305 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Needs-Triage
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 2 days