通用配置文件 P1–P3:设计文档、FS 并发 A+ 定案、FatFs 墙钟接入、cfg_file 双端引擎与 net_cfg 集成(旧档 NCFG 首启迁移)

This commit is contained in:
2026-09-14 02:15:49 +08:00
parent cf2597f998
commit 97661415ca
29 changed files with 3076 additions and 359 deletions
+69 -83
View File
@@ -1,13 +1,15 @@
/*
* 模块名称:Network Configuration Core (配置核心)
* 模块功能:RAM 配置副本 + 工厂默认 + 加载/保存编排 + 实际 MAC 影子 +
* IPv4 字符串转换;磁盘格式 magic 'NCFG' + ver + CRC-16(MODBUS)
* + 18B 字段(两端小端一致,sizeof 含尾部对齐填充)
* IPv4 字符串转换;存储经 cfg_file 通用配置文件引擎(INI [network]
* 段:ip/mask/gw/mac);旧版 NCFG 二进制格式归 net_cfg_legacy
* (首启一次性迁移)
* 适用平台:STM32F407ZGTx / PC 模拟器(两端共用)
* 作者:王建锋
* 创建日期:2026-09-10
* 修改记录:
* v1.0 2026-09-10 王建锋 创建初始版本
* v1.1 2026-09-14 王建锋 存储迁移至 cfg_file 引擎(INI);旧 NCFG 代码移至 net_cfg_legacy
*/
/* 头文件包含区 */
@@ -19,33 +21,21 @@
#include "net_cfg.h"
#include "net_cfg_store.h"
#include "net_cfg_legacy.h"
#include "cfg_file.h"
#define DBG_TAG "[NET_CFG]"
#include "dbg_log.h"
/* 私有宏定义区 */
#define NET_CFG_MAGIC 0x4647434Eu /* 'NCFG'(文件字节序 N,C,G,F;小端装载) */
#define NET_CFG_VER 1u /* 磁盘格式版本 */
/* 工厂默认值(单一来源:s_cfg 初值与 s_cfg_defaults 共用,避免两处漂移) */
/* 工厂默认值(单一来源:s_cfg 初值与 s_defaults 共用,避免两处漂移) */
#define NET_CFG_DEF_IP { 192u, 168u, 1u, 100u }
#define NET_CFG_DEF_MASK { 255u, 255u, 255u, 0u }
#define NET_CFG_DEF_GW { 192u, 168u, 1u, 1u }
#define NET_CFG_DEF_MAC { 0u, 0u, 0u, 0u, 0u, 0u }
/* 磁盘格式(两端布局一致:u32 4 对齐;字段区 18B 连续,CRC 覆盖之) */
typedef struct {
uint32_t magic; /* NET_CFG_MAGIC */
uint16_t ver; /* 格式版本 */
uint16_t crc; /* CRC-16/MODBUS(覆盖 ip..mac 共 18B) */
uint8_t ip[4];
uint8_t mask[4];
uint8_t gw[4];
uint8_t mac[6];
} net_cfg_blob_t;
/* 静态变量定义区 */
/* RAM 配置副本:以工厂默认值静态初始化(落 .data),自启动即有效——
@@ -60,51 +50,62 @@ static uint8_t s_active_mac[6]; /* 芯片实际 MAC 影子(netTask 回写
static uint8_t s_active_valid; /* 影子有效标志(0 = 尚未回写) */
static net_cfg_apply_cb_t s_apply_cb; /* "立即应用"平台回调(未注册 = 空操作) */
/* 工厂默认(引擎注册 p_defaults 指向;与 s_cfg 初值共用宏单一来源) */
static const net_cfg_t s_defaults = {
.ip = NET_CFG_DEF_IP,
.mask = NET_CFG_DEF_MASK,
.gw = NET_CFG_DEF_GW,
.mac = NET_CFG_DEF_MAC,
};
/* [network] 段键表(net_cfg_t 布局内偏移) */
static const cfg_key_def_t s_net_keys[] = {
{ "ip", CFG_VAL_IP4, offsetof(net_cfg_t, ip), 4u },
{ "mask", CFG_VAL_IP4, offsetof(net_cfg_t, mask), 4u },
{ "gw", CFG_VAL_IP4, offsetof(net_cfg_t, gw), 4u },
{ "mac", CFG_VAL_MAC, offsetof(net_cfg_t, mac), 6u },
};
/* 函数定义区 */
/*
* 函数功能:CRC-16/MODBUS(无查表逐位算法)
* 入口参数:p_data - 数据指针 const uint8_t *
* len - 数据长度 size_t
* 返回值:CRC-16 值 uint16_t
* 限定条件:p_data 非空(len 可为 0,返回初始值 0xFFFF)
* 函数说明:文件私有(双端共享、避免跨模块依赖:模拟器不编译 App/util;
* 数据量 ≤32B,性能无关)
* 函数功能:[network] 段变更回调(poll 重载检出差异时由引擎调用)
* 入口参数:无
* 返回值:无
* 限定条件:无(未注册"立即应用"回调时空操作)
* 函数说明:转平台回调(MCU:netTask 置 SYS_EVT_NET_RECONFIG 重建网络)
*/
static uint16_t s_crc16_modbus(const uint8_t *p_data, size_t len) {
uint16_t crc = 0xFFFFu;
for (size_t i = 0u; i < len; i++) {
crc = (uint16_t)(crc ^ (uint16_t)p_data[i]);
for (int b = 0; b < 8; b++) {
if (crc & 0x0001u) {
crc = (uint16_t)((crc >> 1) ^ 0xA001u);
}
else {
crc = (uint16_t)(crc >> 1);
}
}
static void s_net_changed_cb(void) {
if (s_apply_cb != NULL) {
s_apply_cb();
}
return crc;
}
/*
* 函数功能:填充工厂默认配置
* 入口参数:p_cfg - 输出结构指针(不可为 NULL) net_cfg_t *
* 函数功能:向 cfg_file 引擎注册 [network] 段(幂等)
* 入口参数:无
* 返回值:无
* 限定条件:p_cfg 非空
* 函数说明:与既有硬编码组网值一致(192.168.1.100/24,gw .1,MAC 全零
* = 芯片内置),保证首启/存储异常时行为与旧版本相同
* 限定条件:load/save 前调用
* 函数说明:段数据 = s_cfg RAM 副本;工厂默认 = s_defaults;
* 变更回调触发"立即应用"
*/
static void s_cfg_defaults(net_cfg_t *p_cfg) {
const net_cfg_t def = {
.ip = NET_CFG_DEF_IP,
.mask = NET_CFG_DEF_MASK,
.gw = NET_CFG_DEF_GW,
.mac = NET_CFG_DEF_MAC,
};
static void s_net_register(void) {
static uint8_t s_done;
cfg_section_reg_t reg;
*p_cfg = def;
if (s_done != 0u) {
return;
}
(void)memset(&reg, 0, sizeof(reg));
reg.name = "network";
reg.p_data = &s_cfg;
reg.p_defaults = &s_defaults;
reg.data_size = sizeof(net_cfg_t);
reg.p_keys = s_net_keys;
reg.key_count = 4u;
reg.p_cb = s_net_changed_cb;
(void)cfg_file_register(&reg);
s_done = 1u;
}
/*
@@ -130,27 +131,16 @@ static bool s_mac_is_zero(const uint8_t *p_mac) {
* 函数说明:见 net_cfg.h 同名函数说明
*/
int net_cfg_load(void) {
net_cfg_blob_t blob;
s_net_register();
if (net_cfg_store_read((uint8_t *)&blob, sizeof(blob)) != 0) {
/* 文件缺失/不可读(首启、存储未就绪):工厂默认 */
s_cfg_defaults(&s_cfg);
DBG_INFO("load: no valid file, factory defaults");
/* 首启先迁旧档 NCFG(有效 → 旧值物化进新文件);新文件已存在则跳过 */
(void)net_cfg_legacy_migrate();
if (cfg_file_load() != 0) {
/* 严重错误:引擎已将 RAM 副本复位工厂默认,行为仍安全 */
DBG_ERROR("load: cfg_file_load FAIL");
return 0;
}
if (blob.magic != NET_CFG_MAGIC || blob.ver != NET_CFG_VER
|| s_crc16_modbus(blob.ip, 18u) != blob.crc) {
/* 格式损坏:工厂默认并留痕(不让坏配置带崩网络) */
s_cfg_defaults(&s_cfg);
DBG_ERROR("load: blob invalid (magic/ver/crc), factory defaults");
return 0;
}
memcpy(s_cfg.ip, blob.ip, 4u);
memcpy(s_cfg.mask, blob.mask, 4u);
memcpy(s_cfg.gw, blob.gw, 4u);
memcpy(s_cfg.mac, blob.mac, 6u);
DBG_INFO("load: OK ip=%u.%u.%u.%u",
(unsigned)s_cfg.ip[0], (unsigned)s_cfg.ip[1],
(unsigned)s_cfg.ip[2], (unsigned)s_cfg.ip[3]);
@@ -162,24 +152,20 @@ int net_cfg_load(void) {
* 入口参数:无
* 返回值:0 - 成功;-1 - 写失败 int
* 限定条件:MCU 端应在存储就绪后调用
* 函数说明:组装磁盘格式经后端写盘;下次上电生效
* 函数说明:经 cfg_file 引擎写盘(外科手术式保存:保留注释/未知内容,
* 临时文件 + 原子改名);下次上电(netTask 在 net_init 前加载)
* 或 poll 4s 沉降后生效
*/
int net_cfg_save(void) {
net_cfg_blob_t blob;
int r;
memcpy(blob.ip, s_cfg.ip, 4u);
memcpy(blob.mask, s_cfg.mask, 4u);
memcpy(blob.gw, s_cfg.gw, 4u);
memcpy(blob.mac, s_cfg.mac, 6u);
blob.magic = NET_CFG_MAGIC;
blob.ver = NET_CFG_VER;
blob.crc = s_crc16_modbus(blob.ip, 18u);
if (net_cfg_store_write((const uint8_t *)&blob, sizeof(blob)) != 0) {
DBG_ERROR("save: store write FAILED");
s_net_register();
r = cfg_file_save();
if (r != 0) {
DBG_ERROR("save: cfg_file_save FAIL");
return -1;
}
DBG_INFO("save: OK (file written)");
DBG_INFO("save: OK (config file written)");
return 0;
}
+16 -10
View File
@@ -1,16 +1,19 @@
/*
* 模块名称:Network Configuration (NET CFG)
* 模块功能:网络参数配置(IP/掩码/网关/MAC)——双端共享核心:RAM 配置副本 +
* 工厂默认 + 加载/保存编排 + 实际 MAC 影子;存储后端经 net_cfg_store.h
* 抽象(MCU = NAND 上 FatFS 文件 /cfg/netcfg.bin,模拟器 = 本地文件
* sim_netcfg.bin);磁盘格式 = magic + ver + CRC-16 + 18B 字段;
* MAC 全零哨兵 = 不覆盖芯片内置 MAC;保存后下次上电生效
* (每次上电 netTask 在 net_init 前加载)
* 工厂默认 + 加载/保存编排 + 实际 MAC 影子;存储经 cfg_file 通用
* 配置文件引擎(INI [network] 段:ip/mask/gw/mac;MCU = NAND 上
* /config.ini,模拟器 = sim_config.ini);MAC 全零哨兵 = 不覆盖芯片
* 内置 MAC;保存后下次上电生效(每次上电 netTask 在 net_init 前
* 加载)或 poll 4s 沉降后生效
* 函数说明:旧版 NCFG 二进制格式(magic+ver+CRC-16+18B 字段)归 net_cfg_legacy,
* 首启一次性迁移进通用配置文件
* 适用平台:STM32F407ZGTx / PC 模拟器(两端共用)
* 作者:王建锋
* 创建日期:2026-09-10
* 修改记录:
* v1.0 2026-09-10 王建锋 创建初始版本
* v1.1 2026-09-14 王建锋 存储迁移至 cfg_file 引擎(INI [network] 段)
*/
#ifndef NET_CFG_H
@@ -41,9 +44,11 @@ typedef struct {
* 返回值:恒 0(RAM 恒有效:文件缺失/损坏回退工厂默认) int
* 限定条件:MCU 端应在存储就绪(SYS_EVT_STORAGE_READY)后调用;
* 未就绪时文件读失败,自动回退工厂默认(不阻塞网络启动)
* 函数说明: 1. 文件缺失(首启/未保存过)→ 工厂默认
* 2. magic/ver/CRC 错误 → 工厂默认并留痕(不让坏配置带崩网络)
* 3. 校验通过 → 装入 RAM 副本
* 函数说明: 1. 注册 [network] 段(幂等)
* 2. 文件缺失 → 先迁旧档 NCFG(有效 → 旧值物化进新文件),否则
* 生成出厂模板
* 3. 解析文件:有效键 → RAM 副本;无效/缺失键 → 工厂默认并留痕
* 4. 严重错误 → RAM 副本 = 工厂默认(不让坏配置带崩网络)
*/
int net_cfg_load(void);
@@ -52,8 +57,9 @@ int net_cfg_load(void);
* 入口参数:无
* 返回值:0 - 成功;-1 - 写失败 int
* 限定条件:MCU 端应在存储就绪后调用
* 函数说明:组装磁盘格式(magic+ver+CRC-16+18B 字段)经后端写盘;
* 下次上电生效(netTask 在 net_init 前加载)
* 函数说明:经 cfg_file 引擎写盘(外科手术式保存:保留注释/未知内容,
* 临时文件 + 原子改名);下次上电(netTask 在 net_init 前加载)
* 或 poll 4s 沉降后生效
*/
int net_cfg_save(void);
+125
View File
@@ -0,0 +1,125 @@
/*
* 模块名称:net_cfg_legacy
* 模块功能:旧版 NCFG 二进制配置一次性迁移——读遗留文件 → 校验 magic/ver/CRC →
* 填网络配置 RAM 副本 → 经 cfg_file 引擎生成新文件(带旧值)→ 删旧文件
* 适用平台:STM32F407ZGTx / PC 模拟器(两端共用;平台路径经 cfg_file_store 后端)
* 作者:王建锋
* 创建日期:2026-09-14
* 修改记录:
* v1.0 2026-09-14 王建锋 创建初始版本(P3:net_cfg 引擎化,旧格式代码迁入)
*/
/* 头文件包含区 */
#include <string.h>
#include "net_cfg_legacy.h"
#include "net_cfg.h"
#include "cfg_file.h"
#include "cfg_file_store.h"
#define DBG_TAG "[NET_CFG]"
#include "dbg_log.h"
/* 常量定义区 */
#define NET_CFG_MAGIC 0x4647434Eu /* 'NCFG'(文件字节序 N,C,G,F;小端装载) */
#define NET_CFG_VER 1u /* 磁盘格式版本 */
/* 旧磁盘格式(两端布局一致:u32 4 对齐;字段区 18B 连续,CRC 覆盖之) */
typedef struct {
uint32_t magic; /* NET_CFG_MAGIC */
uint16_t ver; /* 格式版本 */
uint16_t crc; /* CRC-16/MODBUS(覆盖 ip..mac 共 18B) */
uint8_t ip[4];
uint8_t mask[4];
uint8_t gw[4];
uint8_t mac[6];
} net_cfg_blob_t;
/* 静态函数声明区 */
static uint16_t s_crc16_modbus(const uint8_t *p_data, size_t len);
/* 函数定义区 */
/*
* 函数功能:CRC-16/MODBUS(无查表逐位算法)
* 入口参数:p_data - 数据指针 const uint8_t *
* len - 数据长度 size_t
* 返回值:CRC-16 值 uint16_t
* 限定条件:p_data 非空(len 可为 0,返回初始值 0xFFFF)
* 函数说明:文件私有(数据量 ≤32B,性能无关)
*/
static uint16_t s_crc16_modbus(const uint8_t *p_data, size_t len) {
uint16_t crc = 0xFFFFu;
for (size_t i = 0u; i < len; i++) {
crc = (uint16_t)(crc ^ (uint16_t)p_data[i]);
for (int b = 0; b < 8; b++) {
if (crc & 0x0001u) {
crc = (uint16_t)((crc >> 1) ^ 0xA001u);
}
else {
crc = (uint16_t)(crc >> 1);
}
}
}
return crc;
}
/*
* 函数功能:旧 NCFG 二进制配置一次性迁移到通用配置文件
* 入口参数:无
* 返回值:0 - 迁移成功,或无旧文件/新文件已存在(正常);-1 - 迁移失败 int
* 限定条件:调用方须已注册 [network] 段(net_cfg_load 内部完成)
* 函数说明:见 net_cfg_legacy.h 同名函数说明
*/
int net_cfg_legacy_migrate(void) {
net_cfg_blob_t blob;
uint8_t buf[32];
size_t nread = 0u;
cfg_file_stat_t st;
net_cfg_t tmp;
const char *p_legacy;
/* 新文件已存在 = 已迁移过(或已有配置):跳过 */
if (cfg_store_stat(cfg_store_config_path(), &st) == 0) {
return 0;
}
p_legacy = cfg_store_legacy_path();
if (cfg_store_read(p_legacy, buf, sizeof(buf), &nread) != 0
|| nread != sizeof(net_cfg_blob_t)) {
DBG_INFO("legacy: no legacy file, skip");
return 0;
}
(void)memcpy(&blob, buf, sizeof(blob));
if (blob.magic != NET_CFG_MAGIC || blob.ver != NET_CFG_VER
|| s_crc16_modbus(blob.ip, 18u) != blob.crc) {
DBG_INFO("legacy: blob invalid (magic/ver/crc), file kept for inspection");
return 0;
}
/* 填 RAM 副本(net_cfg_get 只读,经 net_cfg_set 可写接口整体回灌)
* → 经引擎物化旧值到新文件(此时新文件必缺失 → 生成模板带旧值) */
(void)memcpy(&tmp, net_cfg_get(), sizeof(tmp));
(void)memcpy(tmp.ip, blob.ip, 4u);
(void)memcpy(tmp.mask, blob.mask, 4u);
(void)memcpy(tmp.gw, blob.gw, 4u);
(void)memcpy(tmp.mac, blob.mac, 6u);
net_cfg_set(&tmp);
if (net_cfg_save() != 0) {
DBG_ERROR("legacy: migrate save FAIL");
return -1;
}
(void)cfg_store_remove(p_legacy);
DBG_INFO("legacy: migrated to config file (ip=%u.%u.%u.%u)",
(unsigned)blob.ip[0], (unsigned)blob.ip[1],
(unsigned)blob.ip[2], (unsigned)blob.ip[3]);
return 0;
}
+35
View File
@@ -0,0 +1,35 @@
/*
* 模块名称:net_cfg_legacy
* 模块功能:旧版 NCFG 二进制配置一次性迁移到通用配置文件(net_cfg 旧磁盘格式
* 的拥有者:magic 'NCFG' + ver + CRC-16/MODBUS + 18B 字段)
* 适用平台:STM32F407ZGTx / PC 模拟器(两端共用;平台路径经 cfg_file_store 后端)
* 作者:王建锋
* 创建日期:2026-09-14
* 修改记录:
* v1.0 2026-09-14 王建锋 创建初始版本(P3:net_cfg 引擎化,旧格式代码迁入)
*/
#ifndef NET_CFG_LEGACY_H
#define NET_CFG_LEGACY_H
#ifdef __cplusplus
extern "C" {
#endif
/*
* 函数功能:旧 NCFG 二进制配置(28B)一次性迁移到通用配置文件
* 入口参数:无
* 返回值:0 - 迁移成功,或无旧文件/新文件已存在(正常);
* -1 - 迁移失败(新文件未生成) int
* 限定条件:调用方须已注册 [network] 段(net_cfg_load 内部完成)
* 函数说明:新文件已存在 → 跳过(已迁移过);旧文件有效 → 填网络配置 RAM
* 副本 → 经引擎生成新文件(带旧值)→ 删旧文件;旧文件缺失/无效 →
* 不动旧文件(留人工检查),新文件按工厂默认生成
*/
int net_cfg_legacy_migrate(void);
#ifdef __cplusplus
}
#endif
#endif /* NET_CFG_LEGACY_H */
-46
View File
@@ -1,46 +0,0 @@
/*
* 模块名称:Network Configuration Store (存储后端接口)
* 模块功能:net_cfg 加载/保存的磁盘读写抽象——每平台一份实现(互斥编译):
* MCU = NAND 上 FatFS 文件 /cfg/netcfg.bin(net_cfg_store_mcu.c);
* 模拟器 = 工作目录本地文件 sim_netcfg.bin(net_cfg_store_sim.c)
* 适用平台:STM32F407ZGTx / PC 模拟器(接口共用;两端各编一份实现)
* 作者:王建锋
* 创建日期:2026-09-10
* 修改记录:
* v1.0 2026-09-10 王建锋 创建初始版本
*/
#ifndef NET_CFG_STORE_H
#define NET_CFG_STORE_H
#include <stdint.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* 函数功能:读取配置文件
* 入口参数:p_buf - 接收缓冲(不可为 NULL) uint8_t *
* len - 文件长度(须与磁盘格式一致,net_cfg.c 的 net_cfg_blob_t) size_t
* 返回值:0 - 成功;-1 - 文件缺失/读失败 int
* 限定条件:后端存储可用(MCU:FatFS 已挂载;未挂载时实现直接返回 -1 即可)
*/
int net_cfg_store_read(uint8_t *p_buf, size_t len);
/*
* 函数功能:写配置文件(不存在则创建,存在则覆盖)
* 入口参数:p_buf - 待写数据(不可为 NULL) const uint8_t *
* len - 数据长度(须与磁盘格式一致) size_t
* 返回值:0 - 成功;-1 - 写失败 int
* 限定条件:后端存储可用
*/
int net_cfg_store_write(const uint8_t *p_buf, size_t len);
#ifdef __cplusplus
}
#endif
#endif /* NET_CFG_STORE_H */
-71
View File
@@ -1,71 +0,0 @@
/*
* 模块名称:Network Configuration Store (MCU 后端)
* 模块功能:net_cfg 存储后端——NAND 上 FatFS 文件 /cfg/netcfg.bin
* (目录 /cfg 首次写入时自动创建;卷由 defaultTask 挂载并广播
* SYS_EVT_STORAGE_READY 后方可读写)
* 适用平台:STM32F407ZGTx
* 作者:王建锋
* 创建日期:2026-09-10
* 修改记录:
* v1.0 2026-09-10 王建锋 创建初始版本
*/
/* 头文件包含区 */
#include "net_cfg_store.h"
#include "ff.h"
/* 静态变量定义区 */
static const char s_path[] = "/cfg/netcfg.bin";
/* 函数定义区 */
/*
* 函数功能:读取配置文件
* 入口参数:p_buf - 接收缓冲(不可为 NULL) uint8_t *
* len - 文件长度 size_t
* 返回值:0 - 成功;-1 - 文件缺失/读失败 int
* 限定条件:FatFS 已挂载(未挂载时 f_open 返回 FR_NO_SYSTEM,转 -1)
*/
int net_cfg_store_read(uint8_t *p_buf, size_t len) {
FIL f;
FRESULT fr;
UINT br = 0u;
if (p_buf == NULL) {
return -1;
}
fr = f_open(&f, s_path, FA_READ);
if (fr != FR_OK) {
return -1;
}
fr = f_read(&f, p_buf, (UINT)len, &br);
(void)f_close(&f);
return (fr == FR_OK && br == (UINT)len) ? 0 : -1;
}
/*
* 函数功能:写配置文件(目录不存在则创建;文件覆盖写)
* 入口参数:p_buf - 待写数据(不可为 NULL) const uint8_t *
* len - 数据长度 size_t
* 返回值:0 - 成功;-1 - 写失败 int
* 限定条件:FatFS 已挂载
*/
int net_cfg_store_write(const uint8_t *p_buf, size_t len) {
FIL f;
FRESULT fr;
UINT bw = 0u;
if (p_buf == NULL) {
return -1;
}
(void)f_mkdir("/cfg"); /* 目录已存在(FR_EXIST)不影响后续建文件 */
fr = f_open(&f, s_path, FA_WRITE | FA_CREATE_ALWAYS);
if (fr != FR_OK) {
return -1;
}
fr = f_write(&f, (const void *)p_buf, (UINT)len, &bw);
(void)f_close(&f);
return (fr == FR_OK && bw == (UINT)len) ? 0 : -1;
}