wandering1
2575177e81
纯改名，检查行为一个字没动：规则逻辑、阈值、豁免形状全部原样。 改名原因（用户一句「R4 到底是什么」问出来的）：R1~R4 是我在 check_bsp_err.py 注释里 自造的序号，而这个裸形在本仓另有含义——R1~R8 已在 scripts/id_registry.json 登记为 "专项风险"的文档内编号（保护规划与看门狗的风险表都在用），带连字符的那一族又是审查 报告的可靠性 / 内存优化项编号（编号规范 §1 的"连字符承载语义"一行正是这么写的）。 **同一个裸形四种意思**。最刺人的一点：编号门禁**不会报**这种撞法，因为编号规范 §4.3 已把这些裸形声明为"同号不同义"、走 collides_with 白名单，校验 4 不计事故——同一天里 我起的另一组自造号被当场拦下、这组代号却一路绿灯，差别不在我做对了什么，而在白名单 挡的是"事故"、不是"可读性"。 新名同时是基线键的第二字段（格式 文件|标签|名字）： · err-type 错误通道不外泄（对外接口不拿 HAL_StatusTypeDef / bool 当成败） · timeout-name 超时宏不取负值 · return-doc 公开函数必须写「返回值：」 · consume-result 返回值不得裸丢弃（须接住或显式 (void)） 老名对照：R1=err-type、R2=timeout-name、R3=return-doc、R4=consume-result。 同步面：脚本里的规则码与 38 条基线键的字段**一起换**（中途不跑 --prune，否则改名会被 读成"38 条全还清 + 38 条新账"），换完 --emit-baseline 复核仍是 38/38/0、RC=0。现状类 文本全部换新名：AGENTS.md、pre-commit使用说明.md §2.27（新增"检查项叫什么"一行含老新 对照与撞号说明）、bsp_err.h 边界纪律、报告 §0.4 / §9 / 附录 A，以及代码注释里的 5 处 （gd5f2gq5ue.c/.h、nand_ftl.h、ui_menu_tab.h）。已提交的变更记录行里的老名按"冻结历史 不回改"处理，以 §2.27 对照行为准。ui_menu_tab.h 带 BOM，Edit 又剥掉、已按原样补回。 写说明文字时又被编号门禁拦了一次：我为了举例"老名撞车"，在那段话里写了两个编号字面， 被判"未紧邻文档名 / 未登记前缀"共 3 类新账——连批评自造编号的段落本身都在自造编号。 改法是不写号、只描述形态并指向权威条目。 验证：@build **0 错 0 警告**，Program Size 与上一笔**逐字段相同**（Code 213,676、RO 18,860、RW 1,188、ZI 131,500）→ 证明确为注释与文案，故不跑 @test（无指令变化）； pre-commit run 全绿 **17 项 Passed**；check_doc_links --all --sections-strict 147 篇 0 问题（中途我自己写的 §4.3 没紧邻文档名，被判成本文自引用，已补全路径）；9 个文件字节 卫生 0 异常（UI 头 BOM 仍在、无 CR、无 U+FFFD、均有尾换行）。
61 lines
2.7 KiB
C
61 lines
2.7 KiB
C
/*
|
||
* 模块名称：SPI NAND FTL（dhara 移植层 + FatFs 磁盘接口）
|
||
* 模块功能：把 GD5F SPI NAND 经 dhara 映射层暴露成 FatFs 的 0 号磁盘
|
||
* （disk_initialize/status/ioctl/read/write），并提供显式格式化入口。
|
||
* 适用平台：STM32F4 系列 + GD5F2GQ5UE
|
||
* 作者：王建锋
|
||
* 创建日期：2026-09
|
||
* 修改记录：
|
||
* 2026-10-23 王建锋 补模块头与函数注释（S-5 的 return-doc 检查）；返回值语义写明"失败类目前
|
||
* 只进日志、不外传"，避免调用方以为能拿到 ECC / 预算耗尽的区别
|
||
*/
|
||
|
||
#ifndef NAND_FTL_H
|
||
#define NAND_FTL_H
|
||
|
||
#ifdef __cplusplus
|
||
extern "C" {
|
||
#endif
|
||
|
||
#include <stdint.h>
|
||
|
||
/*
|
||
* 函数功能：初始化 FTL（等价于 disk_initialize(0)：SPI 起链 + dhara_map_resume）
|
||
* 入口参数：无
|
||
* 返回值：0 - 成功（映射可 resume 或判为真空白卷）；-1 - 失败（disk_initialize 非 0）
|
||
* 限定条件：由 FatFs 的 f_mount(forced=1) 间接触发，或测试代码直接调用
|
||
* 函数说明：⚠ 这里的 -1 **抹掉了失败类**——"ECC 读不动"、"journal 满"与"映射损坏"对外
|
||
* 都只是 -1。分类信息目前只在失败点就地进日志（见 nand_ftl.c 的 ftl_class_from_dhara
|
||
* 与 ../架构设计/STM32F4-Base存储架构说明.md §10.4）；要让调用方按类分支，需要跨调用
|
||
* 存活的失败类快照（报告 S-5 的 C4 待还项，当前无消费者故未做）。
|
||
* 调用方**不得**把 -1 解读成"卷坏了，可以重格式化"——E-31 的教训正在这条上。
|
||
*/
|
||
int nand_ftl_init(void);
|
||
|
||
/*
|
||
* 函数功能：清空 dhara 映射树并同步（**破坏性**：整卷逻辑地址→物理映射作废）
|
||
* 入口参数：无
|
||
* 返回值：GD5F_OK(0) - 已清空并同步；GD5F_ERROR(-1) - 初始化/刷写缓存/同步失败（卷状态未定，
|
||
* 须重新挂载判定，不要连环重试）
|
||
* 限定条件：只允许走显式命令或恢复流程调用；不得因"某次读写失败"自动调用
|
||
* 函数说明：新卷从空树写起，避免旧 journal 残留与新卷共存（结构卫生）。
|
||
* 容量恢复动作的区分（A 清日志 / B 重挂载 / C 全片擦除 / D 残留清理）
|
||
* → ../测试说明/存储维护与容量恢复.md。
|
||
*/
|
||
int nand_ftl_format(void);
|
||
|
||
/*
|
||
* 函数功能：复位 FTL 内存态，使下次 nand_ftl_init() 重新走 dhara_map_resume
|
||
* 入口参数：无
|
||
* 返回值：无
|
||
* 限定条件：测试用途（掉电恢复 / 坏块注入后重建场景模拟设备重启）
|
||
* 函数说明：只清 RAM 状态位，不碰闪存内容。
|
||
*/
|
||
void nand_ftl_deinit(void);
|
||
|
||
#ifdef __cplusplus
|
||
}
|
||
#endif
|
||
|
||
#endif /* NAND_FTL_H */
|