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>
177 lines
5.4 KiB
C
177 lines
5.4 KiB
C
/**
|
|
* @file rv_radio_ops_esp32.c
|
|
* @brief ADR-081 Layer 1 — ESP32 binding for rv_radio_ops_t.
|
|
*
|
|
* Wraps the existing csi_collector + esp_wifi_* surface so the adaptive
|
|
* controller, mesh plane, and feature-extraction layers can address the
|
|
* radio through a single chipset-agnostic vtable.
|
|
*
|
|
* This is intentionally thin. The heavy lifting still lives in
|
|
* csi_collector.c (CSI callback, channel hopping, NDP injection); this file
|
|
* is the contract that lets a second chipset (Nexmon Broadcom, custom
|
|
* silicon) drop in without touching the layers above.
|
|
*/
|
|
|
|
#include "rv_radio_ops.h"
|
|
#include "csi_collector.h"
|
|
|
|
#include <string.h>
|
|
#include "esp_err.h"
|
|
#include "esp_log.h"
|
|
#include "esp_wifi.h"
|
|
|
|
static const char *TAG = "rv_radio_esp32";
|
|
|
|
/* ---- Active ops registry ---- */
|
|
|
|
static const rv_radio_ops_t *s_active_ops = NULL;
|
|
|
|
void rv_radio_ops_register(const rv_radio_ops_t *ops)
|
|
{
|
|
s_active_ops = ops;
|
|
}
|
|
|
|
const rv_radio_ops_t *rv_radio_ops_get(void)
|
|
{
|
|
return s_active_ops;
|
|
}
|
|
|
|
/* ---- ESP32 binding state ---- */
|
|
|
|
static uint8_t s_current_channel = 1;
|
|
static uint8_t s_current_bw = 20;
|
|
static uint8_t s_current_profile = RV_PROFILE_PASSIVE_LOW_RATE;
|
|
static uint8_t s_current_mode = RV_RADIO_MODE_PASSIVE_RX;
|
|
static bool s_csi_enabled = true;
|
|
|
|
/* ---- Vtable implementations ---- */
|
|
|
|
static int esp32_init(void)
|
|
{
|
|
/* csi_collector_init() is called from app_main() before the controller
|
|
* starts; nothing to do here for the ESP32 binding. We just confirm a
|
|
* valid current channel was captured by csi_collector_init(). */
|
|
ESP_LOGI(TAG, "ESP32 radio ops: init (current ch=%u bw=%u)",
|
|
(unsigned)s_current_channel, (unsigned)s_current_bw);
|
|
return ESP_OK;
|
|
}
|
|
|
|
static int esp32_set_channel(uint8_t ch, uint8_t bw)
|
|
{
|
|
wifi_second_chan_t second = WIFI_SECOND_CHAN_NONE;
|
|
if (bw == 40) {
|
|
/* HT40+: secondary channel above primary. The controller never asks
|
|
* for HT40 today (sensing prefers HT20), but the mapping is here so
|
|
* a future profile can. */
|
|
second = WIFI_SECOND_CHAN_ABOVE;
|
|
} else if (bw != 20) {
|
|
ESP_LOGW(TAG, "set_channel: unsupported bw=%u, treating as 20 MHz",
|
|
(unsigned)bw);
|
|
bw = 20;
|
|
}
|
|
|
|
esp_err_t err = esp_wifi_set_channel(ch, second);
|
|
if (err != ESP_OK) {
|
|
ESP_LOGW(TAG, "set_channel(%u, bw=%u) failed: %s",
|
|
(unsigned)ch, (unsigned)bw, esp_err_to_name(err));
|
|
return (int)err;
|
|
}
|
|
s_current_channel = ch;
|
|
s_current_bw = bw;
|
|
return ESP_OK;
|
|
}
|
|
|
|
static int esp32_set_mode(uint8_t mode)
|
|
{
|
|
/* Persist the mode for the health snapshot; actual TX behavior is
|
|
* triggered by the controller calling csi_inject_ndp_frame() directly
|
|
* once the controller PR lands. For now this is bookkeeping plus a
|
|
* passive/active probe gate. */
|
|
switch (mode) {
|
|
case RV_RADIO_MODE_DISABLED:
|
|
case RV_RADIO_MODE_PASSIVE_RX:
|
|
case RV_RADIO_MODE_ACTIVE_PROBE:
|
|
case RV_RADIO_MODE_CALIBRATION:
|
|
s_current_mode = mode;
|
|
return ESP_OK;
|
|
default:
|
|
ESP_LOGW(TAG, "set_mode: unknown mode %u", (unsigned)mode);
|
|
return ESP_ERR_INVALID_ARG;
|
|
}
|
|
}
|
|
|
|
static int esp32_set_csi_enabled(bool en)
|
|
{
|
|
esp_err_t err = esp_wifi_set_csi(en);
|
|
if (err != ESP_OK) {
|
|
ESP_LOGW(TAG, "set_csi(%d) failed: %s", (int)en, esp_err_to_name(err));
|
|
return (int)err;
|
|
}
|
|
s_csi_enabled = en;
|
|
return ESP_OK;
|
|
}
|
|
|
|
static int esp32_set_capture_profile(uint8_t profile_id)
|
|
{
|
|
if (profile_id >= RV_PROFILE_COUNT) {
|
|
ESP_LOGW(TAG, "set_capture_profile: invalid id %u", (unsigned)profile_id);
|
|
return ESP_ERR_INVALID_ARG;
|
|
}
|
|
|
|
/* Profiles are advisory at this layer — the controller uses them to
|
|
* decide cadence/window/threshold for the layers above. The radio
|
|
* binding records the active profile for health reporting and may
|
|
* adjust the underlying TX/RX mode in future bindings. */
|
|
s_current_profile = profile_id;
|
|
|
|
/* For ACTIVE_PROBE and CALIBRATION, switch the radio mode to match. */
|
|
if (profile_id == RV_PROFILE_ACTIVE_PROBE) {
|
|
esp32_set_mode(RV_RADIO_MODE_ACTIVE_PROBE);
|
|
} else if (profile_id == RV_PROFILE_CALIBRATION) {
|
|
esp32_set_mode(RV_RADIO_MODE_CALIBRATION);
|
|
} else {
|
|
esp32_set_mode(RV_RADIO_MODE_PASSIVE_RX);
|
|
}
|
|
return ESP_OK;
|
|
}
|
|
|
|
static int esp32_get_health(rv_radio_health_t *out)
|
|
{
|
|
if (out == NULL) {
|
|
return ESP_ERR_INVALID_ARG;
|
|
}
|
|
memset(out, 0, sizeof(*out));
|
|
|
|
out->pkt_yield_per_sec = csi_collector_get_pkt_yield_per_sec();
|
|
out->send_fail_count = csi_collector_get_send_fail_count();
|
|
out->current_channel = s_current_channel;
|
|
out->current_bw_mhz = s_current_bw;
|
|
out->current_profile = s_current_profile;
|
|
|
|
wifi_ap_record_t ap = {0};
|
|
if (esp_wifi_sta_get_ap_info(&ap) == ESP_OK) {
|
|
out->rssi_median_dbm = ap.rssi;
|
|
}
|
|
return ESP_OK;
|
|
}
|
|
|
|
/* ---- The vtable instance ---- */
|
|
|
|
static const rv_radio_ops_t s_esp32_ops = {
|
|
.init = esp32_init,
|
|
.set_channel = esp32_set_channel,
|
|
.set_mode = esp32_set_mode,
|
|
.set_csi_enabled = esp32_set_csi_enabled,
|
|
.set_capture_profile = esp32_set_capture_profile,
|
|
.get_health = esp32_get_health,
|
|
};
|
|
|
|
void rv_radio_ops_esp32_register(void)
|
|
{
|
|
if (s_active_ops == &s_esp32_ops) {
|
|
return; /* idempotent */
|
|
}
|
|
rv_radio_ops_register(&s_esp32_ops);
|
|
ESP_LOGI(TAG, "ESP32 radio ops registered as active binding");
|
|
}
|