BFE Engineering
c756622c96
The repo's documentation framed it as a support repo for one product (WardenOS). Since going public the real audience is anyone with a Luckfox Pico 86 Panel: a maintained 6.18 kernel, an off-device development loop, and a device simulator that exist nowhere else for this board. Reframe the README and top-level docs board-first, with WardenOS documented as the downstream consumer it is (ADR-0008). Also an editorial pass over the whole doc set: - every H1/H2 is now a short title, not a sentence (ADRs, qemu/, patches/, drivers/, architecture, NPU feasibility, config-lint, payload); workflow flowchart titles fixed at the source in tools/flowgen.py and regenerated with fresh bench numbers - README Quick Start commands verified against the scripts; requirements corrected (curl, bare python, gcc >= 14) and the MC/DC gate added as a step (run green locally on gcc 14.2) - dropped the 'needs python (not python3)' vendor dig: build-kernel.sh inherited the same requirement (filed #10 to remove it) - glossed MC/DC and HPMCU on first use; marked the tests/uboot-ab reference as flare-edge; deduplicated the three-simulator list into the root README table
22 lines
1007 B
Markdown
22 lines
1007 B
Markdown
# ADR 0005 — Driver Source of Truth
|
|
|
|
**Status:** Accepted (2026-08-25).
|
|
|
|
## Context
|
|
Our own hardware-facing driver code (relays, modbus master, RGA wrapper, HPMCU
|
|
supervisor, devmem/reset ladder, freshness) is the Tier-1 MC/DC target, but it
|
|
currently lives in flare-edge. The kernel driver source lives in an un-versioned
|
|
scratch tree (`flare-edge/research/linux-6.18.46/`).
|
|
|
|
## Decision
|
|
Bring **hardened copies into `warden-sdk/drivers/`** as the canonical source-of-truth,
|
|
each with its HAL seam and a 100% MC/DC host harness. The RV1106 kernel deltas are
|
|
formalized as a patch series in `patches/`. flare-edge consumes warden-sdk later
|
|
(separate, maintainer-gated step).
|
|
|
|
## Consequences
|
|
- Realizes the seam architecture (ADR-referenced in `docs/architecture.md`).
|
|
- flare-edge is not edited now; a later integration step points flare-edge at these.
|
|
- Risk: temporary duplication of shared constants between the two repos until the
|
|
integration lands — tracked, acceptable for the bring-up window.
|