Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 133 additions & 0 deletions firmware/esp32-csi-node/main/serial_onboarding.c
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,39 @@ static const char *chip_name(void)
#endif
}

#if defined(CONFIG_C6_XIAO_MR60BHA2) && CONFIG_C6_XIAO_MR60BHA2
static bool refresh_radar_saved_config(void)
{
nvs_handle_t handle;
const esp_err_t opened = nvs_open("csi_cfg", NVS_READONLY, &handle);
if (opened == ESP_ERR_NVS_NOT_FOUND) return true; /* Effective factory defaults. */
if (opened != ESP_OK) return false;
nvs_config_t actual = s_current_config;
esp_err_t result = ESP_OK;
#define READ_OPTIONAL(call) do { const esp_err_t r = (call); if (r != ESP_OK && r != ESP_ERR_NVS_NOT_FOUND) result = r; } while (0)
size_t length = sizeof(actual.target_ip);
READ_OPTIONAL(nvs_get_str(handle, "target_ip", actual.target_ip, &length));
length = sizeof(actual.wifi_ssid);
READ_OPTIONAL(nvs_get_str(handle, "ssid", actual.wifi_ssid, &length));
length = sizeof(actual.wifi_password);
READ_OPTIONAL(nvs_get_str(handle, "password", actual.wifi_password, &length));
READ_OPTIONAL(nvs_get_u16(handle, "radar_port", &actual.radar_fused_port));
READ_OPTIONAL(nvs_get_u16(handle, "target_port", &actual.target_port));
READ_OPTIONAL(nvs_get_u8(handle, "node_id", &actual.node_id));
#undef READ_OPTIONAL
nvs_close(handle);
if (result == ESP_OK) s_current_config = actual;
memset(&actual, 0, sizeof(actual));
return result == ESP_OK;
}
#endif

static void emit_hello(const char *nonce)
{
#if defined(CONFIG_C6_XIAO_MR60BHA2) && CONFIG_C6_XIAO_MR60BHA2
/* Read persisted values again after an uncertain prior commit, not stale RAM. */
const bool radar_readable = refresh_radar_saved_config();
#endif
const esp_app_desc_t *description = esp_app_get_description();
char digest[17] = {0};
ruview_onboarding_device_digest(digest);
Expand All @@ -53,6 +84,14 @@ static void emit_hello(const char *nonce)
nonce, chip_name(), description->version,
(unsigned)s_current_config.node_id, s_current_config.target_ip,
(unsigned)s_current_config.target_port, configured ? 1U : 0U, digest);
#if defined(CONFIG_C6_XIAO_MR60BHA2) && CONFIG_C6_XIAO_MR60BHA2
/* Compile-time controller support, not proof that a radar is detected. */
if (radar_readable && s_current_config.target_port >= 1024 && strcmp(digest, "0000000000000000") != 0 && (s_current_config.radar_fused_port == 0 ||
(s_current_config.radar_fused_port >= 1024 && s_current_config.radar_fused_port != s_current_config.target_port))) {
printf("RUVIEW_RADAR_CAP_V1 nonce=%s device_id=%s model=mr60bha2 config=1 radar_port=%u raw_port=%u\n",
nonce, digest, (unsigned)s_current_config.radar_fused_port, (unsigned)s_current_config.target_port);
}
#endif
fflush(stdout);
}

Expand All @@ -73,6 +112,86 @@ static esp_err_t commit_config(const ruview_onboarding_config_t *config)
return result;
}

#if defined(CONFIG_C6_XIAO_MR60BHA2) && CONFIG_C6_XIAO_MR60BHA2
static esp_err_t commit_radar_config(const ruview_onboarding_config_t *config)
{
nvs_handle_t handle;
esp_err_t result = nvs_open("csi_cfg", NVS_READWRITE, &handle);
if (result != ESP_OK) return result;
if (!config->preserve_wifi) {
result = nvs_set_str(handle, "ssid", config->ssid);
if (result == ESP_OK) result = nvs_set_str(handle, "password", config->password);
}
if (result == ESP_OK) result = nvs_set_str(handle, "target_ip", config->target_ip);
if (result == ESP_OK) result = nvs_set_u16(handle, "radar_port", config->target_port);
/* Never write raw target_port, node_id, antenna, update keys or other settings. */
if (result == ESP_OK) result = nvs_commit(handle);
nvs_close(handle);
return result;
}

static bool radar_readback(const ruview_onboarding_config_t *request, nvs_config_t *actual)
{
nvs_handle_t handle;
if (nvs_open("csi_cfg", NVS_READONLY, &handle) != ESP_OK) return false;
*actual = s_current_config; /* Missing unchanged keys retain their effective startup defaults. */
size_t length = sizeof(actual->target_ip);
esp_err_t result = nvs_get_str(handle, "target_ip", actual->target_ip, &length);
if (result == ESP_OK) result = nvs_get_u16(handle, "radar_port", &actual->radar_fused_port);
uint16_t raw_port;
const esp_err_t raw_result = nvs_get_u16(handle, "target_port", &raw_port);
if (raw_result == ESP_OK) actual->target_port = raw_port;
else if (raw_result != ESP_ERR_NVS_NOT_FOUND) result = raw_result;
uint8_t node_id;
const esp_err_t node_result = nvs_get_u8(handle, "node_id", &node_id);
if (node_result == ESP_OK) actual->node_id = node_id;
else if (node_result != ESP_ERR_NVS_NOT_FOUND) result = node_result;
if (!request->preserve_wifi) {
length = sizeof(actual->wifi_ssid);
if (result == ESP_OK) result = nvs_get_str(handle, "ssid", actual->wifi_ssid, &length);
length = sizeof(actual->wifi_password);
if (result == ESP_OK) result = nvs_get_str(handle, "password", actual->wifi_password, &length);
if (strcmp(actual->wifi_ssid, request->ssid) || strcmp(actual->wifi_password, request->password)) result = ESP_FAIL;
}
nvs_close(handle);
return result == ESP_OK && strcmp(actual->target_ip, request->target_ip) == 0
&& actual->radar_fused_port == request->target_port
&& actual->target_port == s_current_config.target_port && actual->node_id == request->node_id;
}

static void process_radar_line(const char *line)
{
ruview_onboarding_radar_config_t request = {0};
char digest[17] = {0};
ruview_onboarding_device_digest(digest);
if (ruview_onboarding_parse_radar_config(line, &request) != RUVIEW_ONBOARDING_OK ||
!ruview_onboarding_radar_claim_valid(&request, digest, s_current_config.node_id,
s_current_config.target_port, s_issued_nonce, s_nonce_issued_at_us, esp_timer_get_time())) {
printf("RUVIEW_RADAR_CONFIG_ERR_V1 reason=invalid_or_stale_claim\n");
memset(&request, 0, sizeof(request));
fflush(stdout);
return;
}
s_issued_nonce[0] = '\0'; /* One attempt, including uncertain NVS failures. */
nvs_config_t actual;
if (commit_radar_config(&request.config) != ESP_OK || !radar_readback(&request.config, &actual)) {
printf("RUVIEW_RADAR_CONFIG_ERR_V1 reason=commit_or_readback\n");
memset(&request, 0, sizeof(request));
memset(&actual, 0, sizeof(actual));
fflush(stdout);
return;
}
printf("RUVIEW_RADAR_CONFIG_OK_V1 nonce=%s device_id=%s node_id=%u target_ip=%s radar_port=%u raw_port=%u rebooting=1\n",
request.config.nonce, digest, (unsigned)actual.node_id, actual.target_ip,
(unsigned)actual.radar_fused_port, (unsigned)actual.target_port);
fflush(stdout);
memset(&request, 0, sizeof(request));
memset(&actual, 0, sizeof(actual));
vTaskDelay(pdMS_TO_TICKS(400));
esp_restart();
}
#endif

static void process_line(char *line)
{
char nonce[RUVIEW_ONBOARDING_NONCE_HEX_LEN + 1] = {0};
Expand All @@ -82,7 +201,21 @@ static void process_line(char *line)
emit_hello(nonce);
return;
}
if (strncmp(line, "RUVIEW_RADAR_CONFIG_V1 ", sizeof("RUVIEW_RADAR_CONFIG_V1 ") - 1) == 0) {
#if defined(CONFIG_C6_XIAO_MR60BHA2) && CONFIG_C6_XIAO_MR60BHA2
process_radar_line(line);
#else
printf("RUVIEW_RADAR_CONFIG_ERR_V1 reason=unsupported_controller\n");
fflush(stdout);
#endif
return;
}
if (strncmp(line, "RUVIEW_CONFIG_V1 ", 17) != 0) return;
#if defined(CONFIG_C6_XIAO_MR60BHA2) && CONFIG_C6_XIAO_MR60BHA2
printf("RUVIEW_CONFIG_ERR_V1 reason=radar_requires_dedicated_config\n");
fflush(stdout);
return;
#endif

ruview_onboarding_config_t request;
const ruview_onboarding_result_t parsed = ruview_onboarding_parse_config(line, &request);
Expand Down
4 changes: 3 additions & 1 deletion firmware/esp32-csi-node/main/serial_onboarding.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
*
* The listener exposes device metadata and accepts one nonce-bound
* configuration transaction. It never prints WiFi credentials and reboots
* only after a successful atomic NVS commit.
* only after a successful NVS commit (and matching persisted readback for the
* dedicated radar command). Storage failure may leave partially applied keys;
* re-identify before retrying rather than claiming transactional rollback.
*/
esp_err_t serial_onboarding_start(const nvs_config_t *config);

Expand Down
51 changes: 50 additions & 1 deletion firmware/esp32-csi-node/main/serial_onboarding_protocol.c
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ static bool valid_ipv4(const char *value)
while (*cursor != '\0') {
if (octets == 4) return false;
if (*cursor == '.') return false;
const char *octet_start = cursor;
uint32_t octet = 0;
unsigned digits = 0;
while (*cursor != '\0' && *cursor != '.') {
Expand All @@ -54,8 +55,12 @@ static bool valid_ipv4(const char *value)
cursor++;
}
if (digits == 0) return false;
if (digits > 1 && *octet_start == '0') return false;
octets++;
if (*cursor == '.') cursor++;
if (*cursor == '.') {
cursor++;
if (*cursor == '\0') return false;
}
}
return octets == 4;
}
Expand Down Expand Up @@ -198,6 +203,50 @@ ruview_onboarding_result_t ruview_onboarding_parse_config(
return RUVIEW_ONBOARDING_OK;
}

ruview_onboarding_result_t ruview_onboarding_parse_radar_config(
const char *line, ruview_onboarding_radar_config_t *request)
{
if (!line || !request || strlen(line) >= 384) return RUVIEW_ONBOARDING_ERR_FORMAT;
char copy[384];
memcpy(copy, line, strlen(line) + 1);
char *tokens[8] = {0};
size_t count = 0;
char *save = NULL;
for (char *token = strtok_r(copy, " ", &save); token; token = strtok_r(NULL, " ", &save)) {
if (count == 8) return RUVIEW_ONBOARDING_ERR_FORMAT;
tokens[count++] = token;
}
if (count != 8 || strcmp(tokens[0], "RUVIEW_RADAR_CONFIG_V1") != 0 || strlen(tokens[2]) != 16)
return RUVIEW_ONBOARDING_ERR_FORMAT;
for (size_t i = 0; i < 16; i++) {
if (!((tokens[2][i] >= '0' && tokens[2][i] <= '9') ||
(tokens[2][i] >= 'a' && tokens[2][i] <= 'f'))) return RUVIEW_ONBOARDING_ERR_FORMAT;
}
char generic[384];
const int length = snprintf(generic, sizeof(generic), "RUVIEW_CONFIG_V1 %s %s %s %s %s %s",
tokens[1], tokens[3], tokens[4], tokens[5], tokens[6], tokens[7]);
if (length < 0 || (size_t)length >= sizeof(generic)) return RUVIEW_ONBOARDING_ERR_FORMAT;
memset(request, 0, sizeof(*request));
const ruview_onboarding_result_t result = ruview_onboarding_parse_config(generic, &request->config);
if (result != RUVIEW_ONBOARDING_OK) return result;
if (request->config.target_port < 1024) return RUVIEW_ONBOARDING_ERR_TARGET_PORT;
memcpy(request->device_id, tokens[2], sizeof(request->device_id));
return RUVIEW_ONBOARDING_OK;
}

bool ruview_onboarding_radar_claim_valid(const ruview_onboarding_radar_config_t *request,
const char *device_id, uint8_t saved_node_id, uint16_t raw_port,
const char *issued_nonce, int64_t issued_at_us, int64_t now_us)
{
return request && device_id && issued_nonce && valid_nonce(issued_nonce)
&& strcmp(device_id, "0000000000000000") != 0
&& issued_at_us >= 0 && now_us >= issued_at_us && now_us - issued_at_us <= 60000000LL
&& strcmp(request->device_id, device_id) == 0
&& strcmp(request->config.nonce, issued_nonce) == 0
&& request->config.node_id == saved_node_id && raw_port >= 1024
&& request->config.target_port >= 1024 && request->config.target_port != raw_port;
}

const char *ruview_onboarding_result_name(ruview_onboarding_result_t result)
{
switch (result) {
Expand Down
11 changes: 11 additions & 0 deletions firmware/esp32-csi-node/main/serial_onboarding_protocol.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ typedef struct {
char password[RUVIEW_ONBOARDING_PASSWORD_MAX_BYTES + 1];
} ruview_onboarding_config_t;

typedef struct {
ruview_onboarding_config_t config; /* target_port is the requested radar port. */
char device_id[17];
} ruview_onboarding_radar_config_t;

typedef enum {
RUVIEW_ONBOARDING_OK = 0,
RUVIEW_ONBOARDING_ERR_FORMAT,
Expand All @@ -37,6 +42,12 @@ ruview_onboarding_result_t ruview_onboarding_parse_config(
const char *line,
ruview_onboarding_config_t *config);

ruview_onboarding_result_t ruview_onboarding_parse_radar_config(
const char *line, ruview_onboarding_radar_config_t *request);
bool ruview_onboarding_radar_claim_valid(const ruview_onboarding_radar_config_t *request,
const char *device_id, uint8_t saved_node_id, uint16_t raw_port,
const char *issued_nonce, int64_t issued_at_us, int64_t now_us);

const char *ruview_onboarding_result_name(ruview_onboarding_result_t result);

#endif
4 changes: 4 additions & 0 deletions firmware/esp32-csi-node/sdkconfig.defaults.xiao-mr60bha2
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@
CONFIG_C6_XIAO_MR60BHA2=y
CONFIG_C6_XIAO_ANTENNA_SELECT=y
CONFIG_C6_XIAO_ANTENNA_EXTERNAL=y
# Factory raw CSI destination stays separate from opt-in fused radar UDP 5005.
# Existing NVS target_port overrides this factory default and is never rewritten
# by the dedicated radar USB configuration command.
CONFIG_CSI_TARGET_PORT=55063
71 changes: 71 additions & 0 deletions firmware/esp32-csi-node/test/MR60-USB-CONFIG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# MR60 USB configuration v1

This opt-in protocol is compiled only for `CONFIG_C6_XIAO_MR60BHA2`.
It changes controller network settings, not the proprietary radar module firmware.
Capability proves controller firmware support; it does not prove attached hardware,
fresh radar reception, calibration, presence or vital-sign accuracy.

## Wire contract

All lines are bounded by the existing 384-byte serial input limit. Values are
space-delimited. Nonces have 32 hexadecimal characters; `device_id` is the existing
16-character, lowercase eFuse-MAC-derived `device_digest`, never an account ID.
Examples below are symbolic, not executable device commands.

An ordinary `RUVIEW_HELLO_V1 <nonce>` returns the existing HELLO plus:

```text
RUVIEW_RADAR_CAP_V1 nonce=<nonce> device_id=<digest> model=mr60bha2 config=1 radar_port=<saved-radar-port> raw_port=<unchanged-raw-port>
```

The capability is absent on generic builds, unreadable NVS, invalid split-port
state or failed stable-device-identity derivation. A radar port of zero denotes
legacy routing; it is readable but cannot be requested by this command.

```text
RUVIEW_RADAR_CONFIG_V1 <nonce> <device_id> <expected-saved-node-id> <private-IPv4> <radar-port> <SSID-base64-or-KEEP> <password-base64-or-KEEP>
```

Both Wi-Fi values must be KEEP, or both supplied. Existing byte/control-character
bounds apply. The radar port is 1024–65535 and must differ from the raw CSI port.
The nonce lasts at most 60 seconds and authorizes one attempted commit, bound to
the stable device ID and unchanged saved node ID. Freshness is not network
authentication; configuration is confined to a selected physical USB connection.

The only written keys are `target_ip`, `radar_port`, and (when explicitly changed)
`ssid`/`password` in `csi_cfg`. Raw `target_port`, node ID, antenna, update keys and
all other NVS entries are preserved. The numeric IP is shared by raw CSI and
radar; separate IPs, hostnames/mDNS and automatic DHCP recovery are not supported.
Use USB reconfiguration when the Mac's address changes.

After commit, the handler reads actual persisted target/radar/Wi-Fi values and
checks unchanged effective raw port/node identity. Only matching readback emits:

```text
RUVIEW_RADAR_CONFIG_OK_V1 nonce=<nonce> device_id=<digest> node_id=<saved-node-id> target_ip=<IPv4> radar_port=<port> raw_port=<unchanged-port> rebooting=1
```

NVS errors or mismatches do not emit success or reboot; partial application is
possible after an uncertain storage failure. Re-identify before retrying. HELLO
refreshes saved values rather than reporting stale pre-write RAM. Generic CSI
CONFIG is refused on dedicated MR60 builds to avoid rewriting the raw port.
No Wi-Fi values are echoed in replies. After reboot the Mac must perform a new
nonce-bound HELLO, compare identity/ports/settings, and separately observe a new
radar packet for the configured node. A CONFIG ACK alone is not sensor-ready.

## Verification

`make run_serial_radar run_serial_onboarding` executes the production handlers
with synthetic NVS/clock/identity ports, including generic-build denial. Full
`make host_tests` also exercises existing firmware controls. These are host
checks, not physical flashing, boot or network-change qualification.

The paired app consumer is tracked in cognitum-one/ruview-mobile#278. It must
not fall back to generic provisioning when this capability is missing.

The dedicated `sdkconfig.defaults.xiao-mr60bha2` profile sets the factory raw
port to55063; generic target defaults are unchanged. Build a clean C6 image
with the base, C6,4MB and MR60 profile defaults, then inspect its generated
sdkconfig and flash layout before packaging. Existing NVS values override
these defaults and are not rewritten by this source change. No qualified
factory image or physical onboarding is claimed by host tests alone.
14 changes: 14 additions & 0 deletions firmware/esp32-csi-node/test/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,20 @@ test_serial_onboarding: test_serial_onboarding_protocol.c $(MAIN_DIR)/serial_onb
run_serial_onboarding: test_serial_onboarding
./test_serial_onboarding

test_serial_radar: test_serial_radar_config.c $(MAIN_DIR)/serial_onboarding.c $(MAIN_DIR)/serial_onboarding_protocol.c
cc -std=c11 -Wall -Wextra -Werror -Wno-unused-function -Wno-unused-variable -Iserial_stubs -I$(MAIN_DIR) \
-DCONFIG_C6_XIAO_MR60BHA2=1 -DCONFIG_IDF_TARGET_ESP32C6=1 -o $@ test_serial_radar_config.c $(MAIN_DIR)/serial_onboarding_protocol.c

test_serial_radar_generic: test_serial_radar_config.c $(MAIN_DIR)/serial_onboarding.c $(MAIN_DIR)/serial_onboarding_protocol.c
cc -std=c11 -Wall -Wextra -Werror -Wno-unused-function -Wno-unused-variable -Iserial_stubs -I$(MAIN_DIR) \
-o $@ test_serial_radar_config.c $(MAIN_DIR)/serial_onboarding_protocol.c

run_serial_radar: test_serial_radar test_serial_radar_generic
./test_serial_radar
./test_serial_radar_generic

host_tests: run_serial_radar

test_onboarding_identity: test_onboarding_identity.c $(MAIN_DIR)/onboarding_identity.h identity_stubs/esp_mac.h identity_stubs/psa/crypto.h
cc -std=c11 -Wall -Wextra -Werror -pedantic -Iidentity_stubs -I$(MAIN_DIR) -o $@ $<

Expand Down
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/esp_app_desc.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/esp_efuse.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/esp_err.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/esp_log.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/esp_mac.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/esp_system.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/esp_timer.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/freertos/task.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
1 change: 1 addition & 0 deletions firmware/esp32-csi-node/test/serial_stubs/nvs.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "serial_test_platform.h"
Loading
Loading