mirror of
https://github.com/ruvnet/RuView
synced 2026-06-09 10:13:17 +00:00
5a7f431b0e
* 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>
126 lines
4.3 KiB
C
126 lines
4.3 KiB
C
/**
|
|
* @file adaptive_controller.h
|
|
* @brief ADR-081 Layer 2 — Adaptive sensing controller.
|
|
*
|
|
* Closed-loop firmware control over cadence, capture profile, channel, and
|
|
* mesh role. Three cooperating loops:
|
|
*
|
|
* Fast (~200 ms): packet rate, active probing
|
|
* Medium (~1 s) : channel selection, role transitions
|
|
* Slow (~30 s) : baseline recalibration
|
|
*
|
|
* Outputs are routed through:
|
|
* - rv_radio_ops_t (Layer 1) for set_channel / set_capture_profile
|
|
* - swarm_bridge / mesh plane (Layer 3) for CHANNEL_PLAN, ROLE_ASSIGN
|
|
* - edge_processing (Layer 4) for cadence and threshold updates
|
|
*
|
|
* Default policy is conservative — matches today's behavior. Aggressive
|
|
* adaptation is opt-in via Kconfig (ADAPTIVE_CONTROLLER_AGGRESSIVE).
|
|
*/
|
|
|
|
#ifndef ADAPTIVE_CONTROLLER_H
|
|
#define ADAPTIVE_CONTROLLER_H
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Controller-level state machine (ADR-081 firmware FSM). */
|
|
typedef enum {
|
|
ADAPT_STATE_BOOT = 0,
|
|
ADAPT_STATE_SELF_TEST = 1,
|
|
ADAPT_STATE_RADIO_INIT = 2,
|
|
ADAPT_STATE_TIME_SYNC = 3,
|
|
ADAPT_STATE_CALIBRATION = 4,
|
|
ADAPT_STATE_SENSE_IDLE = 5,
|
|
ADAPT_STATE_SENSE_ACTIVE = 6,
|
|
ADAPT_STATE_ALERT = 7,
|
|
ADAPT_STATE_DEGRADED = 8,
|
|
} adapt_state_t;
|
|
|
|
/** Observation window aggregated each fast tick. */
|
|
typedef struct {
|
|
uint16_t pkt_yield_per_sec; /**< From rv_radio_health.pkt_yield_per_sec. */
|
|
uint16_t send_fail_count; /**< UDP/socket send failures. */
|
|
int8_t rssi_median_dbm;
|
|
int8_t noise_floor_dbm;
|
|
float motion_score; /**< Pulled from edge_processing. */
|
|
float presence_score;
|
|
float anomaly_score;
|
|
float node_coherence; /**< Inter-link coherence; 1.0 if single node. */
|
|
} adapt_observation_t;
|
|
|
|
/** Decisions emitted by a controller tick. */
|
|
typedef struct {
|
|
bool change_profile;
|
|
uint8_t new_profile; /**< rv_capture_profile_t. */
|
|
bool change_channel;
|
|
uint8_t new_channel;
|
|
bool change_state;
|
|
uint8_t new_state; /**< adapt_state_t. */
|
|
bool request_calibration; /**< Coordinator should issue CALIBRATION_START. */
|
|
uint16_t suggested_vital_interval_ms;
|
|
} adapt_decision_t;
|
|
|
|
/** Controller config (loaded from NVS / Kconfig). */
|
|
typedef struct {
|
|
uint16_t fast_loop_ms; /**< Default 200 ms. */
|
|
uint16_t medium_loop_ms; /**< Default 1000 ms. */
|
|
uint16_t slow_loop_ms; /**< Default 30000 ms. */
|
|
bool aggressive; /**< true = react sooner / more often. */
|
|
bool enable_channel_switch; /**< false = controller may never hop. */
|
|
bool enable_role_change;
|
|
float motion_threshold; /**< 0..1, enter SENSE_ACTIVE above this. */
|
|
float anomaly_threshold; /**< 0..1, enter ALERT above this. */
|
|
uint16_t min_pkt_yield; /**< pps below this → DEGRADED. */
|
|
} adapt_config_t;
|
|
|
|
/**
|
|
* Initialize the adaptive controller.
|
|
*
|
|
* Spawns one FreeRTOS task that runs the three loops via FreeRTOS timers.
|
|
* Idempotent — second call is a no-op.
|
|
*
|
|
* @param cfg Config (NULL = use Kconfig defaults).
|
|
* @return ESP_OK on success.
|
|
*/
|
|
esp_err_t adaptive_controller_init(const adapt_config_t *cfg);
|
|
|
|
/** Get the current state. */
|
|
adapt_state_t adaptive_controller_state(void);
|
|
|
|
/**
|
|
* Snapshot the latest observation (most recent fast-loop sample).
|
|
* Useful for telemetry and the `HEALTH` mesh message.
|
|
*
|
|
* @param out Output buffer.
|
|
* @return true if a valid observation has been recorded.
|
|
*/
|
|
bool adaptive_controller_observation(adapt_observation_t *out);
|
|
|
|
/**
|
|
* Force a state transition (e.g. from a remote ROLE_ASSIGN message).
|
|
* Logged at INFO; controller may immediately transition again on next tick.
|
|
*/
|
|
void adaptive_controller_force_state(adapt_state_t st);
|
|
|
|
/**
|
|
* Pure-function policy: given an observation + current state + config,
|
|
* compute the decision. Exposed in the header so it can be unit-tested
|
|
* offline (no FreeRTOS / ESP-IDF dependency in the body).
|
|
*/
|
|
void adaptive_controller_decide(const adapt_config_t *cfg,
|
|
adapt_state_t current,
|
|
const adapt_observation_t *obs,
|
|
adapt_decision_t *out);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ADAPTIVE_CONTROLLER_H */
|