Files
ruvnet--RuView/firmware/esp32-csi-node/main/csi_collector.h
T
Claude d53e29506e 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.
2026-04-19 03:43:08 +00:00

117 lines
3.6 KiB
C

/**
* @file csi_collector.h
* @brief CSI data collection and ADR-018 binary frame serialization.
*/
#ifndef CSI_COLLECTOR_H
#define CSI_COLLECTOR_H
#include <stdint.h>
#include <stddef.h>
#include "esp_err.h"
#include "esp_wifi_types.h"
/** ADR-018 magic number. */
#define CSI_MAGIC 0xC5110001
/** ADR-018 header size in bytes. */
#define CSI_HEADER_SIZE 20
/** Maximum frame buffer size (header + 4 antennas * 256 subcarriers * 2 bytes). */
#define CSI_MAX_FRAME_SIZE (CSI_HEADER_SIZE + 4 * 256 * 2)
/** Maximum number of channels in the hop table (ADR-029). */
#define CSI_HOP_CHANNELS_MAX 6
/**
* Initialize CSI collection.
* Registers the WiFi CSI callback.
*/
void csi_collector_init(void);
/**
* Get the runtime node_id captured at csi_collector_init().
*
* This is a defensive copy of g_nvs_config.node_id taken at init time. Other
* modules (edge_processing, wasm_runtime, display_ui) should prefer this
* accessor over reading g_nvs_config.node_id directly, because the global
* struct can be clobbered by memory corruption (see #232, #375, #385, #390).
*
* @return Node ID (0-255) as loaded from NVS or Kconfig default at boot.
*/
uint8_t csi_collector_get_node_id(void);
/**
* Serialize CSI data into ADR-018 binary frame format.
*
* @param info WiFi CSI info from the ESP-IDF callback.
* @param buf Output buffer (must be at least CSI_MAX_FRAME_SIZE bytes).
* @param buf_len Size of the output buffer.
* @return Number of bytes written, or 0 on error.
*/
size_t csi_serialize_frame(const wifi_csi_info_t *info, uint8_t *buf, size_t buf_len);
/**
* Configure the channel-hop table for multi-band sensing (ADR-029).
*
* When hop_count == 1 the collector stays on the single configured channel
* (backward-compatible with the original single-channel mode).
*
* @param channels Array of WiFi channel numbers (1-14 for 2.4 GHz, 36-177 for 5 GHz).
* @param hop_count Number of entries in the channels array (1..CSI_HOP_CHANNELS_MAX).
* @param dwell_ms Dwell time per channel in milliseconds (>= 10).
*/
void csi_collector_set_hop_table(const uint8_t *channels, uint8_t hop_count, uint32_t dwell_ms);
/**
* Advance to the next channel in the hop table.
*
* Called by the hop timer callback. If hop_count <= 1 this is a no-op.
* Calls esp_wifi_set_channel() internally.
*/
void csi_hop_next_channel(void);
/**
* Start the channel-hop timer.
*
* Creates an esp_timer periodic callback that fires every dwell_ms
* milliseconds, calling csi_hop_next_channel(). If hop_count <= 1
* the timer is not started (single-channel backward-compatible mode).
*/
void csi_collector_start_hop_timer(void);
/**
* Inject an NDP (Null Data Packet) frame for sensing.
*
* Uses esp_wifi_80211_tx() to send a preamble-only frame (~24 us airtime)
* that triggers CSI measurement at all receivers. This is the "sensing-first"
* TX mechanism described in ADR-029.
*
* @return ESP_OK on success, or an error code.
*
* @note TODO: Full NDP frame construction. Currently sends a minimal
* null-data frame as a placeholder.
*/
esp_err_t csi_inject_ndp_frame(void);
/**
* Get the recent CSI callback rate (per second).
*
* Computed as a sliding 1-second window over the internal s_cb_count
* counter. Used by the ADR-081 radio abstraction layer to fill the
* pkt_yield_per_sec field of rv_radio_health_t.
*
* @return Callbacks observed in the trailing ~1 second.
*/
uint16_t csi_collector_get_pkt_yield_per_sec(void);
/**
* Get the cumulative UDP send-failure counter since boot.
*
* @return Number of stream_sender_send() failures recorded by the
* CSI callback path.
*/
uint16_t csi_collector_get_send_fail_count(void);
#endif /* CSI_COLLECTOR_H */