mirror of
https://github.com/ruvnet/RuView.git
synced 2026-04-28 05:59:32 +00:00
* ADR-081: adaptive CSI mesh firmware kernel + scaffolding
Introduces a 5-layer firmware kernel that reframes the existing ESP32
modules as components of a chipset-agnostic architecture and authorizes
adaptive control + a compact feature-state stream as the default upstream.
Layers:
L1 Radio Abstraction Layer — rv_radio_ops_t vtable + ESP32 binding
L2 Adaptive Controller — fast/medium/slow loops (200ms/1s/30s)
L3 Mesh Sensing Plane — anchor/observer/relay/coordinator (spec)
L4 On-device Feature Extr. — rv_feature_state_t (magic 0xC5110006)
L5 Rust handoff — feature_state default; debug raw gated
Files:
docs/adr/ADR-081-adaptive-csi-mesh-firmware-kernel.md (new)
firmware/esp32-csi-node/main/rv_radio_ops.h (new)
firmware/esp32-csi-node/main/rv_radio_ops_esp32.c (new)
firmware/esp32-csi-node/main/rv_feature_state.{h,c} (new)
firmware/esp32-csi-node/main/adaptive_controller.{h,c} (new)
firmware/esp32-csi-node/main/main.c (wire L1+L2)
firmware/esp32-csi-node/main/CMakeLists.txt (add 4 sources)
firmware/esp32-csi-node/main/Kconfig.projbuild (controller knobs)
CHANGELOG.md (Unreleased)
Default policy is conservative: enable_channel_switch and
enable_role_change are off, so behavior matches today's firmware
unless an operator opts in via menuconfig. The pure
adaptive_controller_decide() is exposed for offline unit tests.
Reuses (does not rewrite): csi_collector, edge_processing (ADR-039),
swarm_bridge (ADR-066), secure_tdm (ADR-032), wasm_runtime (ADR-040).
* ADR-081: implement Layers 1/2/4 end-to-end + host tests + QEMU hooks
Turns the ADR-081 scaffolding into a working adaptive CSI mesh kernel:
Layer 1 radio abstraction has an ESP32 binding and a mock binding; Layer 2
adaptive controller runs on FreeRTOS timers; Layer 4 feature-state packet
is emitted at 5 Hz by default, replacing raw ADR-018 CSI as the default
upstream.
New files:
firmware/esp32-csi-node/main/adaptive_controller_decide.c (pure policy)
firmware/esp32-csi-node/main/rv_radio_ops_mock.c (QEMU binding)
firmware/esp32-csi-node/tests/host/Makefile (host tests)
firmware/esp32-csi-node/tests/host/test_adaptive_controller.c
firmware/esp32-csi-node/tests/host/test_rv_feature_state.c
firmware/esp32-csi-node/tests/host/esp_err.h (shim)
firmware/esp32-csi-node/tests/host/.gitignore
Modified:
adaptive_controller.c — includes pure decide.c; emit_feature_state()
wired into fast loop (200 ms = 5 Hz)
rv_radio_ops_esp32.c — get_health() fills pkt_yield + send_fail
csi_collector.{c,h} — pkt_yield/send_fail accessors (ADR-081 L1)
rv_feature_state.h — packed size corrected to 60 bytes
(was incorrectly 80 in initial commit)
main.c — mock binding registered under mock CSI
CMakeLists.txt — rv_radio_ops_mock.c under CSI_MOCK_ENABLED
scripts/validate_qemu_output.py — 3 new ADR-081 checks (17/18/19)
docs/adr/ADR-081-*.md — status → Accepted (partial);
implementation-status matrix; measured
benchmarks (decide 3.2 ns, CRC32 614 ns);
bandwidth 300 B/s @ 5 Hz (99.7% vs raw);
verification section
CHANGELOG.md — artifact-level entries
Tests (host, gcc -O2 -std=c11):
test_adaptive_controller: 18/18 pass, decide() = 3.2 ns/call
test_rv_feature_state: 15/15 pass, CRC32(56 B) = 614 ns/pkt, 87 MB/s
sizeof(rv_feature_state_t) == 60 asserted
IEEE CRC32 known vectors verified
Deferred (tracked in ADR-081 roadmap Phase 3/4):
Layer 3 mesh-plane message types, role-assignment FSM, Rust-side mirror
trait in crates/wifi-densepose-hardware/src/radio_ops.rs.
* ADR-081: Layer 3 mesh plane + Rust mirror trait — all 5 layers landed
Fully implements the remaining deferred pieces of the adaptive CSI mesh
firmware kernel. All 5 layers (Radio Abstraction, Adaptive Controller,
Mesh Sensing Plane, On-device Feature Extraction, Rust handoff) are
now implemented and host-tested end-to-end.
Layer 3 — Mesh Sensing Plane (firmware/esp32-csi-node/main/rv_mesh.{h,c}):
* 4 node roles: Unassigned / Anchor / Observer / FusionRelay / Coordinator
* 7 message types: TIME_SYNC, ROLE_ASSIGN, CHANNEL_PLAN,
CALIBRATION_START, FEATURE_DELTA, HEALTH, ANOMALY_ALERT
* 3 auth classes: None / HMAC-SHA256-session / Ed25519-batch
* Payload types: rv_node_status_t (28 B), rv_anomaly_alert_t (28 B),
rv_time_sync_t (16 B), rv_role_assign_t (16 B),
rv_channel_plan_t (24 B), rv_calibration_start_t (20 B)
* 16-byte envelope + payload + IEEE CRC32 trailer
* Pure rv_mesh_encode()/rv_mesh_decode() plus typed convenience encoders
* rv_mesh_send_health() + rv_mesh_send_anomaly() helpers
Controller wiring (adaptive_controller.c):
* Slow loop (30 s default) now emits HEALTH
* apply_decision() emits ANOMALY_ALERT on transitions to ALERT /
DEGRADED
* Role + mesh epoch tracked in module state; epoch bumps on role
change
Layer 5 — Rust mirror (crates/wifi-densepose-hardware/src/radio_ops.rs):
* RadioOps trait mirrors rv_radio_ops_t vtable
* MockRadio backend for offline tests
* MeshHeader / NodeStatus / AnomalyAlert types mirror rv_mesh.h
* Byte-identical IEEE CRC32 (poly 0xEDB88320) verified against
firmware test vectors (0xCBF43926 for "123456789")
* decode_mesh / decode_node_status / decode_anomaly_alert / encode_health
* 8 unit tests, including mesh_constants_match_firmware which asserts
MESH_MAGIC/VERSION/HEADER_SIZE/MAX_PAYLOAD match rv_mesh.h
byte-for-byte
* Exported from lib.rs
* signal/ruvector/train/mat crates untouched — satisfies ADR-081
portability acceptance test
Tests (all passing):
test_adaptive_controller: 18/18 (C, decide() 3.2 ns/call)
test_rv_feature_state: 15/15 (C, CRC32 87 MB/s)
test_rv_mesh: 27/27 (C, roundtrip 1.0 µs)
radio_ops::tests (Rust): 8/8
--- total: 68/68 assertions green ---
Docs:
* ADR-081 status flipped to Accepted
* Implementation-status matrix updated; L3 + Rust mirror both
marked Implemented
* Benchmarks table extended with rv_mesh encode+decode roundtrip
* Verification section updated with cargo test invocation
* CHANGELOG: two new entries for L3 mesh plane + Rust mirror
Remaining follow-ups (Phase 3.5 polish, not blocking):
* Mesh RX path (UDP listener + dispatch) on the firmware
* Ed25519 signing for CHANNEL_PLAN / CALIBRATION_START
* Hardware validation on COM7
* Add test_rv_mesh to host-test .gitignore
Fixes an untracked-file warning from the repo stop-hook: the compiled
binary was built by make but the .gitignore update was missed in
8dfb031. No source changes.
* Fix implicit decl of emit_feature_state in adaptive_controller
fast_loop_cb calls emit_feature_state() at line 224, but the static
definition is at line 256. GCC treats the implicit declaration as
non-static, then the real static definition conflicts, and
-Werror=all promotes both to hard build errors.
Add a forward declaration above the first use. Unblocks ESP32-S3
firmware build and all QEMU matrix jobs.
Co-Authored-By: claude-flow <ruv@ruv.net>
---------
Co-authored-by: Claude <noreply@anthropic.com>
152 lines
5.6 KiB
C
152 lines
5.6 KiB
C
/*
|
|
* Host unit test for rv_feature_state_* helpers.
|
|
*
|
|
* Validates:
|
|
* - Packet layout is exactly 80 bytes
|
|
* - IEEE CRC32 matches well-known reference vectors
|
|
* - finalize() populates magic/seq/ts/crc correctly
|
|
* - CRC32 throughput benchmark
|
|
*/
|
|
|
|
#include <assert.h>
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <time.h>
|
|
|
|
#include "rv_feature_state.h"
|
|
#include "rv_radio_ops.h"
|
|
|
|
static int g_pass = 0, g_fail = 0;
|
|
#define CHECK(cond, msg) do { \
|
|
if (cond) { g_pass++; } \
|
|
else { g_fail++; printf(" FAIL: %s (line %d)\n", msg, __LINE__); } \
|
|
} while (0)
|
|
|
|
static void test_packet_size(void) {
|
|
printf("test: rv_feature_state_t is 60 bytes on the wire\n");
|
|
CHECK(sizeof(rv_feature_state_t) == 60, "sizeof == 60");
|
|
}
|
|
|
|
static void test_crc_known_vectors(void) {
|
|
printf("test: IEEE CRC32 known vectors\n");
|
|
/* IEEE CRC32 of "123456789" == 0xCBF43926 (well-known). */
|
|
uint32_t c1 = rv_feature_state_crc32((const uint8_t *)"123456789", 9);
|
|
CHECK(c1 == 0xCBF43926u, "CRC32('123456789') == 0xCBF43926");
|
|
|
|
/* Empty input → 0x00000000 (before final inversion, 0xFFFFFFFF);
|
|
* IEEE convention with post-invert → 0x00000000 reversed — but with
|
|
* our implementation the empty-input CRC is 0x00000000 after post-
|
|
* invert on ~0xFFFFFFFF = 0x00000000. */
|
|
uint32_t c2 = rv_feature_state_crc32(NULL, 0);
|
|
CHECK(c2 == 0x00000000u, "CRC32(empty) == 0");
|
|
|
|
/* Single zero byte: IEEE CRC32 of 0x00 = 0xD202EF8D. */
|
|
uint8_t zero = 0;
|
|
uint32_t c3 = rv_feature_state_crc32(&zero, 1);
|
|
CHECK(c3 == 0xD202EF8Du, "CRC32(0x00) == 0xD202EF8D");
|
|
}
|
|
|
|
static void test_finalize(void) {
|
|
printf("test: finalize populates required fields\n");
|
|
rv_feature_state_t pkt;
|
|
memset(&pkt, 0, sizeof(pkt));
|
|
pkt.motion_score = 0.25f;
|
|
pkt.presence_score = 0.75f;
|
|
pkt.respiration_bpm = 14.5f;
|
|
pkt.quality_flags = RV_QFLAG_PRESENCE_VALID | RV_QFLAG_RESPIRATION_VALID;
|
|
|
|
rv_feature_state_finalize(&pkt, /*node*/ 7, /*seq*/ 42,
|
|
/*ts*/ 1234567ULL, RV_PROFILE_RESP_HIGH_SENS);
|
|
|
|
CHECK(pkt.magic == RV_FEATURE_STATE_MAGIC, "magic");
|
|
CHECK(pkt.node_id == 7, "node_id");
|
|
CHECK(pkt.seq == 42, "seq");
|
|
CHECK(pkt.ts_us == 1234567ULL, "ts_us");
|
|
CHECK(pkt.mode == RV_PROFILE_RESP_HIGH_SENS, "mode");
|
|
CHECK(pkt.reserved == 0, "reserved cleared");
|
|
CHECK(pkt.crc32 != 0, "crc32 populated (non-trivial input)");
|
|
|
|
/* Re-finalize must produce identical CRC (deterministic). */
|
|
uint32_t crc1 = pkt.crc32;
|
|
rv_feature_state_finalize(&pkt, 7, 42, 1234567ULL, RV_PROFILE_RESP_HIGH_SENS);
|
|
CHECK(pkt.crc32 == crc1, "finalize is deterministic");
|
|
|
|
/* Changing a payload byte must change the CRC. */
|
|
pkt.motion_score = 0.26f;
|
|
rv_feature_state_finalize(&pkt, 7, 42, 1234567ULL, RV_PROFILE_RESP_HIGH_SENS);
|
|
CHECK(pkt.crc32 != crc1, "CRC changes when payload changes");
|
|
}
|
|
|
|
static void test_crc_verifiability(void) {
|
|
printf("test: receiver can verify CRC\n");
|
|
rv_feature_state_t pkt;
|
|
memset(&pkt, 0, sizeof(pkt));
|
|
pkt.motion_score = 0.33f;
|
|
pkt.presence_score = 0.66f;
|
|
rv_feature_state_finalize(&pkt, 1, 100, 555ULL, RV_PROFILE_PASSIVE_LOW_RATE);
|
|
|
|
/* Receiver recomputes CRC over all bytes except the trailing crc32. */
|
|
uint32_t expected = rv_feature_state_crc32(
|
|
(const uint8_t *)&pkt, sizeof(pkt) - sizeof(uint32_t));
|
|
CHECK(pkt.crc32 == expected, "receiver-side CRC check matches");
|
|
}
|
|
|
|
static void benchmark_crc(void) {
|
|
printf("bench: CRC32 over 60-byte packet (56 B hashed, excl trailing crc32)\n");
|
|
rv_feature_state_t pkt;
|
|
memset(&pkt, 0x5A, sizeof(pkt));
|
|
|
|
const int N = 5000000;
|
|
struct timespec a, b;
|
|
clock_gettime(CLOCK_MONOTONIC, &a);
|
|
volatile uint32_t sink = 0;
|
|
for (int i = 0; i < N; i++) {
|
|
pkt.seq = (uint16_t)i; /* vary input so compiler can't fold */
|
|
sink ^= rv_feature_state_crc32(
|
|
(const uint8_t *)&pkt, sizeof(pkt) - sizeof(uint32_t));
|
|
}
|
|
clock_gettime(CLOCK_MONOTONIC, &b);
|
|
(void)sink;
|
|
double ns_per_call = ((b.tv_sec - a.tv_sec) * 1e9 +
|
|
(b.tv_nsec - a.tv_nsec)) / (double)N;
|
|
double mb_per_sec = (double)(sizeof(pkt) - sizeof(uint32_t)) / ns_per_call
|
|
* 1e9 / (1024.0 * 1024.0);
|
|
printf(" %d calls, %.1f ns/packet, %.1f MB/s\n",
|
|
N, ns_per_call, mb_per_sec);
|
|
/* At 10 Hz feature-state cadence, CRC budget is <100us/packet — we
|
|
* expect bit-by-bit CRC32 to run ~1 MB/s on host, ~100-300 KB/s on
|
|
* ESP32-S3 Xtensa LX7. 76-byte CRC takes <1 ms either way. */
|
|
CHECK(ns_per_call < 50000.0, "CRC32(80B) must be under 50us/packet");
|
|
}
|
|
|
|
static void benchmark_finalize(void) {
|
|
printf("bench: full finalize() cost\n");
|
|
rv_feature_state_t pkt;
|
|
memset(&pkt, 0x33, sizeof(pkt));
|
|
|
|
const int N = 5000000;
|
|
struct timespec a, b;
|
|
clock_gettime(CLOCK_MONOTONIC, &a);
|
|
for (int i = 0; i < N; i++) {
|
|
rv_feature_state_finalize(&pkt, 1, (uint16_t)i, (uint64_t)i,
|
|
RV_PROFILE_PASSIVE_LOW_RATE);
|
|
}
|
|
clock_gettime(CLOCK_MONOTONIC, &b);
|
|
double ns_per_call = ((b.tv_sec - a.tv_sec) * 1e9 +
|
|
(b.tv_nsec - a.tv_nsec)) / (double)N;
|
|
printf(" %d calls, %.1f ns/call (includes CRC)\n", N, ns_per_call);
|
|
}
|
|
|
|
int main(void) {
|
|
printf("=== rv_feature_state_* host tests ===\n\n");
|
|
|
|
test_packet_size();
|
|
test_crc_known_vectors();
|
|
test_finalize();
|
|
test_crc_verifiability();
|
|
benchmark_crc();
|
|
benchmark_finalize();
|
|
|
|
printf("\n=== result: %d pass, %d fail ===\n", g_pass, g_fail);
|
|
return g_fail > 0 ? 1 : 0;
|
|
}
|