146 lines
5.6 KiB
C
146 lines
5.6 KiB
C
/*
|
||
* 模块名称：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 前加载）
|
||
* 适用平台：STM32F407ZGTx / PC 模拟器（两端共用）
|
||
* 作者：王建锋
|
||
* 创建日期：2026-09-10
|
||
* 修改记录：
|
||
* v1.0 2026-09-10 王建锋 创建初始版本
|
||
*/
|
||
|
||
#ifndef NET_CFG_H
|
||
#define NET_CFG_H
|
||
|
||
#include <stdint.h>
|
||
|
||
#include <stddef.h>
|
||
|
||
#ifdef __cplusplus
|
||
extern "C" {
|
||
#endif
|
||
|
||
/*
|
||
* 网络参数配置（RAM 副本）
|
||
* mac 全零哨兵：不设置芯片 MAC（用芯片内置值，存于芯片 EEPROM）
|
||
*/
|
||
typedef struct {
|
||
uint8_t ip[4]; /* IP 地址（工厂默认 192.168.1.100） */
|
||
uint8_t mask[4]; /* 子网掩码（工厂默认 255.255.255.0） */
|
||
uint8_t gw[4]; /* 默认网关（工厂默认 192.168.1.1） */
|
||
uint8_t mac[6]; /* MAC 地址（全零 = 芯片内置 MAC） */
|
||
} net_cfg_t;
|
||
|
||
/*
|
||
* 函数功能：从存储加载网络配置到 RAM 副本
|
||
* 入口参数：无
|
||
* 返回值：恒 0（RAM 恒有效：文件缺失/损坏回退工厂默认） int
|
||
* 限定条件：MCU 端应在存储就绪（SYS_EVT_STORAGE_READY）后调用；
|
||
* 未就绪时文件读失败，自动回退工厂默认（不阻塞网络启动）
|
||
* 函数说明： 1. 文件缺失（首启/未保存过）→ 工厂默认
|
||
* 2. magic/ver/CRC 错误 → 工厂默认并留痕（不让坏配置带崩网络）
|
||
* 3. 校验通过 → 装入 RAM 副本
|
||
*/
|
||
int net_cfg_load(void);
|
||
|
||
/*
|
||
* 函数功能：保存当前 RAM 配置到存储（Flash 持久化）
|
||
* 入口参数：无
|
||
* 返回值：0 - 成功；-1 - 写失败 int
|
||
* 限定条件：MCU 端应在存储就绪后调用
|
||
* 函数说明：组装磁盘格式（magic+ver+CRC-16+18B 字段）经后端写盘；
|
||
* 下次上电生效（netTask 在 net_init 前加载）
|
||
*/
|
||
int net_cfg_save(void);
|
||
|
||
/*
|
||
* "立即应用"回调类型：平台挂钩（可选）
|
||
* 入口参数：无
|
||
* 返回值：无
|
||
* 函数说明：MCU 端由 netTask 注册——置 SYS_EVT_NET_RECONFIG 事件，由 netTask
|
||
* 重建网络；模拟器无网络栈，不注册（空操作）。经回调而非直接调用，
|
||
* 避免 NETCFG（驱动层）反向依赖 App 层。
|
||
*/
|
||
typedef void (*net_cfg_apply_cb_t)(void);
|
||
|
||
/*
|
||
* 函数功能：注册"立即应用"回调
|
||
* 入口参数：cb - 回调函数（NULL = 注销） net_cfg_apply_cb_t
|
||
* 返回值：无
|
||
* 限定条件：应用启动早期注册一次即可
|
||
* 函数说明：见 net_cfg_apply_cb_t
|
||
*/
|
||
void net_cfg_set_apply_cb(net_cfg_apply_cb_t cb);
|
||
|
||
/*
|
||
* 函数功能：请求立即应用当前 RAM 配置
|
||
* 入口参数：无
|
||
* 返回值：无
|
||
* 限定条件：无（未注册回调时空操作）
|
||
* 函数说明：UI"网口设置"页保存行写盘成功后调用；真正生效由平台回调完成
|
||
* （MCU：netTask 重建网络，无需重启）
|
||
*/
|
||
void net_cfg_request_apply(void);
|
||
|
||
/*
|
||
* 函数功能：取 RAM 配置副本（只读指针）
|
||
* 入口参数：无
|
||
* 返回值：RAM 配置副本指针（恒非空） const net_cfg_t *
|
||
* 限定条件：无
|
||
* 函数说明：netTask（启动期读取组网）与 UI 页（显示/编辑）共用
|
||
*/
|
||
const net_cfg_t *net_cfg_get(void);
|
||
|
||
/*
|
||
* 函数功能：更新 RAM 配置副本（不写盘）
|
||
* 入口参数：p_cfg - 新配置指针（不可为 NULL） const net_cfg_t *
|
||
* 返回值：无
|
||
* 限定条件：p_cfg 非空；写盘须另行调 net_cfg_save
|
||
* 函数说明：UI 编辑页调整字段后经此落 RAM 副本
|
||
*/
|
||
void net_cfg_set(const net_cfg_t *p_cfg);
|
||
|
||
/*
|
||
* 函数功能：回写芯片实际 MAC（影子区，供 UI 显示）
|
||
* 入口参数：p_mac - 芯片读回的实际 MAC（不可为 NULL） const uint8_t *
|
||
* 返回值：无
|
||
* 限定条件：net_init 成功后由 netTask 上下文调用
|
||
* 函数说明：CH395F SPI 归 netTask 独占（中断/轮询集中处理）；UI 页不可直接
|
||
* 调 SPI 读命令，故 netTask 初始化后读回实际 MAC 存于此供
|
||
* "网口设置"页显示（存储 MAC 全零时显示芯片内置 MAC）
|
||
*/
|
||
void net_cfg_set_active_mac(const uint8_t *p_mac);
|
||
|
||
/*
|
||
* 函数功能：取显示用 MAC
|
||
* 入口参数：p_out - 6 字节输出缓冲（不可为 NULL） uint8_t *
|
||
* 返回值：无
|
||
* 限定条件：p_out 非空
|
||
* 函数说明：存储 MAC 非全零 → 存储值；否则芯片实际（已回写时）；
|
||
* 否则全零（网络未初始化/芯片内置未知）
|
||
*/
|
||
void net_cfg_get_mac(uint8_t *p_out);
|
||
|
||
/*
|
||
* 函数功能：4 字节 IPv4 格式化为点分十进制字符串（每段 3 位补零）
|
||
* 入口参数：p_ip - 4 字节 IP（不可为 NULL） const uint8_t *
|
||
* p_buf - 输出缓冲（不可为 NULL） char *
|
||
* len - 缓冲长度 size_t
|
||
* 返回值：无
|
||
* 限定条件：p_ip/p_buf 非空；len ≥ 16（输出 11 字符 + '\0'）
|
||
* 函数说明："192.168.001.100"——每段 3 位补零使字符串定长，UI 编辑光标
|
||
* 可按固定偏移（4i/3i 起始）定位字节；net_init 的 parse_ip_string
|
||
* 对前导零兼容（十进制逐段解析）
|
||
*/
|
||
void net_cfg_fmt_ipv4(const uint8_t *p_ip, char *p_buf, size_t len);
|
||
|
||
#ifdef __cplusplus
|
||
}
|
||
#endif
|
||
|
||
#endif /* NET_CFG_H */
|