Files
bfe-core1106-sdk/drivers
BFE EngineeringandClaude Fable 5 5155224594 public-readiness: scrub internal details, split licensing, hosted kernel-build
Preparing the repo to go public (ADR-0007):

- CI: kernel-build moves from the self-hosted runner to ubuntu-latest
  (installs its own cross toolchain + qemu, caches the pristine tarball).
  On a public repo a registered self-hosted runner is reachable from
  approved fork-PR workflows — i.e. arbitrary code on private
  infrastructure — and the build never actually needed the SDK host.
  ADR-0004 marked superseded-in-part; docs/ci-cd.md rewritten (site
  specifics now live only in the private deployment log).
- Licensing: LICENSE gains the GPL-2.0 carve-out for patches/ and the
  kernel source excerpts (Linux derivatives; per-driver provenance was
  already tracked in PROVENANCE.md); patches/README.md states it too.
- Scrubbed from the tip: bench-unit dev credentials and its gadget IP
  (m2-boot notes), the site AP SSID+BSSID and a neighboring AP's BSSID
  and the device WLAN MAC (wifi bring-up evidence — BSSIDs are
  geolocatable), the runner mesh IP. NOTE: these remain in git history;
  decision on a pre-publication history rewrite is separate.
- Emoji cleanup across 21 tracked files (kernel port docs, review report,
  enforce-mcdc.sh) per repo text conventions: status marks became
  [x]/[wip]/[ ]/OK plain text.
- "[maintainer]-gated" process phrasing normalized to "maintainer-gated"
  (attributions in dated evidence docs kept).

Verified: zero emojis tracked; scrub grep clean; patches carry no internal
references; ci.yml parses; shellcheck unchanged.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018HUayid7W5w7jBdb9Rrj1K
2026-08-30 07:25:57 -06:00
..

drivers/ — our own hardened, hardware-facing drivers

Per ADR-0002 (tiered MC/DC) and ADR-0005 (source-of-truth), our own hardware-facing code migrates here behind a HAL seam and is hardened. "100% MC/DC on 100% of drivers" is infeasible (≈97% of kernel-driver LOC is vendor blobs — AIC8800 alone is 88.5K lines); the realistic, honest target is tiered.

Tier 1 — real 100% MC/DC (here now, CI-enforced)

Self-contained logic with a clean seam, measured to 100% MC/DC (gcc-14 -fcondition-coverage) by the CI mcdc job (make -C drivers/*/test check):

Driver Seam MC/DC
relays/ relay_io vtable (sysfs backend + in-memory fake) 40/40 conditions, 100%
freshness/ produce/render callbacks (the "no stale numbers" guard) 66/66 conditions, 100%

Adding a Tier-1 driver: copy <name>.{c,h} here, put the hardware/OS calls behind a small injectable seam, then mirror relays/test/ (a fake backend for the logic branches + a real backend over a scratch tree for the plumbing). Reuse the shared gate — the Makefile calls bash ../../enforce-mcdc.sh <gcov.log> build/<name>.c.gcov build/test.rc (it derives the driver name from the .gcov file, so there is no per-driver copy to keep in sync). The CI mcdc job picks up any drivers/*/test/Makefile automatically.

Tier 2 — serious testing + fault-injection + benchmarks

Drivers too large or too vendor/UI-coupled for literal MC/DC get fault-injection, branch coverage, and benchmarks against the simulator instead. Their hardware side is already modelled and tested here in ../sim/:

Driver Serious-testing status SDK model
modbus_engine.c (RS485 master) 8 pty scenarios + 3 wire/daemon checks (11 total) + fault-injection (flare-edge tools/modbus-sim/, green) sim::modbus RTU slave (11 tests, silent-drop/forced-NAK faults) + modbus_read_holding benchmark
warden_rga.c (RGA offload) offload-dispatch + CPU-fallback logic sim::rga recording improcess fake (programmable IM_STATUS) + rga_improcess benchmark
HPMCU supervisor (hpmcu.rs) arm/beat/fire + boot-grace safety property sim::hpmcu (7 tests) + hpmcu_tick benchmark

Why the Tier-2 source isn't vendored here yet: modbus_engine.c and warden_rga.c pull in shared UI headers (platform.h, settings.h, lv_*) and librga. Copying those in would duplicate exactly the shared surface the flare-edge↔warden-sdk unification (ADR-0003/0005, a separate maintainer-gated step) is meant to resolve cleanly. So the Tier-2 models (the hardware ends) live here now; the Tier-2 driver sources migrate in with the unification, at which point their existing flare-edge harnesses point at this repo.