Files
bfe-core1106-sdk/drivers/README.md
T
BFE Engineering 42fb386f60 docs: ASCII typography and style normalization across all repo text
Replace every em dash with real punctuation (rewrites, not hyphen swaps)
in docs, code comments, scripts, configs, and the port records; convert
en dashes, curly quotes, ellipsis glyphs, arrows, and section signs to
ASCII; drop machine-writing tell phrases from living docs. ADR titles
now use a colon. The M2 bring-up DTS model string carried an em dash
into the patch series and its record echoes; fixed at both, and the full
series re-verified to apply cleanly onto pristine 6.18.46. One comment
in freshness.h deliberately names the em dash glyph the UI renders as
the unknown mark; that is data, kept as prose naming it.

Verified: cargo tests (sim, config-lint, rs485-bridge), shellcheck,
both driver MC/DC harnesses, patches-apply.
2026-08-31 12:31:27 -06:00

2.6 KiB

Hardened 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: 100% MC/DC

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: Fault Injection

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↔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.