param_backup.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. /*
  2. * 参数双分区备份模块 (EasyFlash 掉参兜底)
  3. *
  4. * 背景: EasyFlash V4.1.0 NG 模式下 ef_set_env_blob() 会立即落 flash,
  5. * 写在 ENV_PRE_WRITE 阶段掉电/复位的条目,下次启动会被判为
  6. * ENV_ERR_HDR 而永久丢失;GC 搬移中断则整个 sector 被 format,
  7. * 成片丢参数。本模块用 A/B 双分区 ping-pong + CRC32 + 递增序号,
  8. * 保证任意时刻至少有一份完整可用的参数快照。
  9. *
  10. * 设计要点:
  11. * 1. 两个独立 4KB 分区交替写入,写 A 时 B 保留上一版,写一半掉电也不影响 B
  12. * 2. 每条快照带 seq(递增) + CRC32,启动时取 seq 最大且 CRC 通过的那份
  13. * 3. 只持久化"值字段",不含指针(Device_Status_typedef 里有 const char* 数组,
  14. * 直接 memcpy 整个结构体会把无效指针写进 flash,恢复后必然跑飞)
  15. * 4. 延迟落盘: 参数变更只置 dirty,静默期结束后才写,合并连续修改、大幅减少擦写
  16. */
  17. #ifndef APPLICATIONS_PARAM_BACKUP_H_
  18. #define APPLICATIONS_PARAM_BACKUP_H_
  19. #include <rtthread.h>
  20. /* ============================ 分区配置 ============================ */
  21. #define PARAM_PART_A_NAME "param_a"
  22. #define PARAM_PART_B_NAME "param_b"
  23. #define PARAM_MAGIC 0x5041524Du /* "PARM" */
  24. #define PARAM_VERSION 2u /* 结构版本,变更 param_persist_t 时必须 +1
  25. v2: 删除 json_w_clock/reset/platform 三个 128B 字段 */
  26. /* 参数变更后的静默期(tick),期间无新变更才真正落盘。RT_TICK_PER_SECOND=1000 */
  27. #ifndef PARAM_QUIET_TICKS
  28. #define PARAM_QUIET_TICKS (500)
  29. #endif
  30. /* 落盘线程周期(tick) */
  31. #ifndef PARAM_POLL_TICKS
  32. #define PARAM_POLL_TICKS (200)
  33. #endif
  34. /* 两次落盘之间的最小间隔。屏幕每秒刷帧都会调到 param_mark_dirty(),
  35. 没有这道闸会把 4KB sector 在几天内写穿(W25Q 寿命约 10 万次擦写)。 */
  36. #ifndef PARAM_MIN_SAVE_TICKS
  37. #define PARAM_MIN_SAVE_TICKS (10 * 1000)
  38. #endif
  39. /* ★ 落盘**失败**后的退避时长。flash 擦写失败(接触不良/写保护/坏块)时,
  40. 原来每 PARAM_POLL_TICKS(200ms) 就会重试一次完整的"擦除 4KB + 写 + 回读",
  41. 既加速磨损又刷爆调试串口, 每次还要阻塞 40~100ms 占着 SPI 总线。
  42. 失败后至少退避这么久再试。 */
  43. #ifndef PARAM_FAIL_BACKOFF_TICKS
  44. #define PARAM_FAIL_BACKOFF_TICKS (60 * 1000)
  45. #endif
  46. /* ====================== 需要持久化的参数集合 ======================
  47. * 与 EasyFlash 中实际读写的 key 一一对应,新增参数需同步修改:
  48. * 本结构体 + param_pack() + param_unpack()
  49. * ================================================================== */
  50. typedef struct
  51. {
  52. /* --- 标量 --- */
  53. uint8_t iSave; /* iSave 存储标志位, 必须 == FLASH_FLAG(2) */
  54. uint8_t dtype; /* dtype 设备类型 7-孢子仪 3-测报灯 */
  55. uint8_t version_type; /* version_type */
  56. uint8_t Power_Type; /* Power_Type 供电类型 */
  57. uint8_t ds; /* ds 开关机状态 */
  58. uint8_t timeSwitch; /* timeSwitch 0-光控 1-时控 */
  59. uint8_t run_sta; /* run_sta 孢子仪运行状态 */
  60. uint8_t cul_time; /* cul_time 培养时间 */
  61. uint8_t motor_active; /* motor_active */
  62. uint8_t heat_sw; /* heat_sw 加热开关 */
  63. uint8_t cold_sw; /* cold_sw 制冷开关 */
  64. uint8_t wind_sw; /* wind_sw 风机开关 */
  65. uint8_t collecting_sh1; /* collecting_sh1 */
  66. uint8_t collecting_eh1; /* collecting_eh1 */
  67. uint8_t collecting_sh2; /* collecting_sh2 */
  68. uint8_t collecting_eh2; /* collecting_eh2 */
  69. uint8_t handle_bugger; /* handle_bugger 排虫模式 */
  70. uint8_t work_mode; /* work_mode 0-正常 1-预制 */
  71. uint8_t shake_ws; /* shake_ws 震动开关 */
  72. uint8_t tph; /* tph 高温保护 */
  73. int8_t tpl; /* tpl 低温保护(有符号) */
  74. uint8_t clt_time; /* stime 收集时间 */
  75. uint8_t heattime; /* jtime 加热时间 */
  76. uint8_t heatvalue; /* jheat 加热温度 */
  77. uint8_t sunBar; /* sunBar 光控定时时长 */
  78. uint8_t startBar; /* startBar 定时开始 */
  79. uint8_t stopBar; /* stopBar 定时结束 */
  80. uint8_t vol; /* vol 音量 */
  81. uint8_t stop_in_bootloader; /* stop_in_bootloader */
  82. uint8_t update_flag; /* update_flag */
  83. uint8_t rsv0; /* 对齐填充 */
  84. uint8_t rsv1;
  85. uint16_t dattim; /* dattim 数据上传间隔 */
  86. uint16_t shake_sec; /* shake_sec 震动时间 */
  87. uint16_t thsp; /* thsp 熄屏时间 */
  88. uint16_t rsv2;
  89. int passWord; /* passWord */
  90. rt_uint32_t rebootcnt; /* reboot_time 开机次数 */
  91. /* --- 字符串 --- */
  92. char tempture[12]; /* env_t 环境温度 */
  93. char humidity[12]; /* env_h 环境湿度 */
  94. char mqttcfg1[64]; /* platform 平台地址 */
  95. char deviceId[32]; /* deviceId 设备编码 */
  96. char imei[32]; /* imei */
  97. char iccid[32]; /* iccid */
  98. char lat[32]; /* lat */
  99. char lng[32]; /* lng */
  100. char alarm_tg[12]; /* alarm_tg 闹钟 */
  101. char driver_bl[64]; /* driver_bl BL版本 */
  102. char driver_compile[64]; /* driver_compile */
  103. } param_persist_t;
  104. /* 快照头,必须 4 字节对齐 */
  105. typedef struct
  106. {
  107. uint32_t magic;
  108. uint32_t version;
  109. uint32_t seq; /* 递增序号,取最大且 CRC 通过者 */
  110. uint32_t len; /* payload 长度,应 == sizeof(param_persist_t) */
  111. uint32_t crc32; /* payload 的 CRC32 */
  112. uint32_t reserved;
  113. } param_snapshot_hdr_t;
  114. /* ============================== API ============================== */
  115. /**
  116. * 初始化: 查找 param_a / param_b 分区并读出有效快照
  117. * @return RT_EOK 成功(至少找到一个可用分区); 其它 失败
  118. */
  119. int param_backup_init(void);
  120. /**
  121. * 读取当前最新的有效快照
  122. * @param out 输出参数
  123. * @param seq 输出该快照的序号,可为 RT_NULL
  124. * @return 0 成功(有有效快照); <0 无有效快照
  125. */
  126. int param_backup_read(param_persist_t *out, uint32_t *seq);
  127. /**
  128. * 立即写入一份新快照(ping-pong,写到较旧的那个分区)
  129. * @param in 待保存的参数
  130. * @return 0 成功; <0 失败
  131. */
  132. int param_backup_write(const param_persist_t *in);
  133. /**
  134. * 把当前 device_status 打包成 param_persist_t
  135. */
  136. void param_pack(param_persist_t *dst);
  137. /**
  138. * 把 param_persist_t 还原到 device_status
  139. */
  140. void param_unpack(const param_persist_t *src);
  141. /**
  142. * 把 device_status 写回 EasyFlash(用于从快照恢复后修复 flash)
  143. * @return 实际写成功的条目数
  144. */
  145. int param_write_back_to_easyflash(const param_persist_t *src);
  146. /**
  147. * 检查 EasyFlash 读出的参数是否健康
  148. * @param p 待检查的参数
  149. * @return 0 健康; >0 异常(位掩码, 见 PARAM_ERR_*)
  150. */
  151. #define PARAM_ERR_ISAVE (1u << 0) /* iSave 哨兵丢失 -> 会触发全量出厂重置 */
  152. #define PARAM_ERR_TPH (1u << 1)
  153. #define PARAM_ERR_THSP (1u << 2)
  154. #define PARAM_ERR_DATTIM (1u << 3)
  155. #define PARAM_ERR_SUNBAR (1u << 4)
  156. #define PARAM_ERR_CLTIME (1u << 5)
  157. #define PARAM_ERR_HEATTIME (1u << 6)
  158. #define PARAM_ERR_HEATVALUE (1u << 7)
  159. int param_check_health(const param_persist_t *p);
  160. /**
  161. * 标记参数已变更,延迟落盘线程会在静默期后写 flash。
  162. * 这是本模块推荐的写入方式(替代直接在业务里调 ef_set_env_blob 后不管)。
  163. */
  164. void param_mark_dirty(void);
  165. /**
  166. * 立即落盘(会阻塞,擦除 4KB 约 40~100ms)。
  167. * 内部有两道节流: ①内容与上次完全相同则不写 ②距上次落盘不足 PARAM_MIN_SAVE_TICKS 则推迟。
  168. * @return 0 已写入或无需写入; 1 因最小间隔被推迟(dirty 保留); <0 写入失败
  169. */
  170. int param_flush(void);
  171. /**
  172. * 强制落盘,跳过节流。仅用于恢复出厂等必须立刻生效的场景。
  173. */
  174. int param_flush_force(void);
  175. /**
  176. * 启动延迟落盘线程
  177. */
  178. int param_backup_start(void);
  179. #endif /* APPLICATIONS_PARAM_BACKUP_H_ */