docs(S-5): 补齐 16 条返回值约定，bsp-err 基线 19 → 1，并修门禁自身误判
A（还债）先行，B（GD5F 的 SPI 失败被吞成成功）另波处理。本笔不改行为：@build 的 Program Size 与上一笔逐字段相同（Code 213,648、RO 18,860、RW 1,188、ZI 131,500）。 **补齐 16 条「返回值：」约定，bsp-err 存量基线 19 → 1**： · gd5f2gq5ue.h 九个 SPI 原语（wait_busy / write_enable / read_status / page_read / read_from_cache / program_load / program_exec / block_erase / check_ecc） 写全规范五要素， 并把**每个函数能返回哪些码**写死：哪一个是"可重试"的 GD5F_WAIT_EXPIRED、哪一个才是 器件自认坏块的 P_FAIL/E_FAIL、失败时出参为什么不可信（E-42 同族）。 · nand_ftl.h 从零散三行补成带模块头，并明写 **nand_ftl_init() 的 −1 抹掉了失败类**： 分类目前只在失败点进日志，要按类分支需要 C4 快照（现无消费者故未做）；同时警告"不得 把 −1 解读成卷坏了可以重格式化"（E-31 的教训正在这条上）。 · ui_menu_tab.h 五个表查询 API 由行尾短注释升级为完整块（含"越界返回 false 是保守取 只读"、"宁可按一张错表导航失败也不要按错表导航成功"这类判断依据）。 **修掉门禁自己的一条误判口径**（本笔最该记的）：R3 原本要求紧邻注释块里出现字面"返回值"， 而规范 V1.0 允许列对齐写法「返 回 值：」。后果有两层：① 合规写法被判违规；② 反向更糟—— gd5f_write_enable / gd5f_read_status 两条**早就"通过"了**，原因竟是它们的**函数说明**里顺口 写了"返回值"三个字，而不是真有一行返回值说明。**一条会因为散文里出现关键词而放行的规则， 等于在奖励运气**。修法是在块内忽略空格后再匹配关键词（排版选择不是违规），并在注释里写明 为什么不许把"必须写成不空格的形式"写进规则。 剩余 1 条刻意保留：bool ui_content_page_open()。它与"补注释"不是一档事——要改签名、要处理 3 个调用点（ui_menu.c:138/192/196 **今天三处全部丢弃返回值**，即"按 ENTER 开页失败是静默的" 这件事现在没人知道）、且 UI 源码双端编译（模拟器同一份），验证面是"重建模拟器 + 像素回归 + 真机逐页进菜单"。这不是还债，是独立一波改动，留档待决策。UI 三个文件带 BOM，Edit 会静默 剥掉 → 已按原样补回 3 字节（AGENTS 铁律：丢 BOM 后 ARMCC 按 CP936 解码，中文报 #870-D）。 **更正我自己写进文档的一条错话**：S-5 各条里我把 GD5F_SPI_TIMEOUT 100 记成"自旋圈数（改 分频时长会变）"。这次逐行核它 12 处用法，**全部是 HAL_* 超时参数或 HAL_GetTick() 差值 → 它也是毫秒**。真问题降级为"单位没写进名字（缺 _MS 后缀），读代码必须回实现里查单位"。 osWaitForever 与 HAL_MAX_DELAY 同为 0xFFFFFFFFU、以及 *_BUSY_TIMEOUT = -2 其实是返回码这两条 仍然成立（后者已改）。现状类条目（报告 §0.4、bsp_err.h、pre-commit使用说明.md §2.27、脚本 文件头）已全部改准；**已提交的变更记录行仍写着旧说法——按 §8.1 冻结历史不回改，以本笔新增 的更正行为准**。 验证：@build 0 错 0 警告（尺寸同上，故**不跑 @test**——无指令变化，跑它没有新信息）；受影响 文件的 17 个钩子全 Passed（含 ui-golden 像素回归、cppcheck、编码规范、bsp-err 1/1/0 且 --prune 干净）；check_doc_links --all --sections-strict 147 篇 0 问题；id-check --strict 通过； 9 个文件字节卫生 0 异常（UI 头 BOM 仍在、无 CR、无 U+FFFD、无行尾空格、均有尾换行）。 口径同步：AGENTS.md、.pre-commit-config.yaml、pre-commit使用说明.md §2.27 的基线计数 19 → 1； 报告 §0.4 / §9 / 附录 A 与变更记录两条（还债一条、更正一条）。
This commit is contained in:
@@ -272,14 +272,89 @@ int32_t gd5f_bbt_reload(void);
|
||||
|
||||
/* ==================== SPI 原语（FTL 共享） ==================== */
|
||||
|
||||
/*
|
||||
* 函数功能：等待芯片空闲（轮询状态位 BUSY/OIP）
|
||||
* 入口参数：timeout_ms - 等待上限 uint32_t 毫秒
|
||||
* 返 回 值：GD5F_OK - 已空闲；GD5F_WAIT_EXPIRED - 时限内未空闲（**可重试**，旧名 BUSY_TIMEOUT）；GD5F_ERROR - SPI 读取失败
|
||||
* 限定条件：SPI 已初始化；不得在中断里调用
|
||||
* 函数说明：E-32 把"超时"与"读状态本身失败"分开返回，两者处置不同（前者再等、后者查硬件）
|
||||
*/
|
||||
int32_t gd5f_wait_busy(uint32_t timeout_ms);
|
||||
|
||||
/*
|
||||
* 函数功能：发送 06h WRITE ENABLE（编程/擦除前必须成功执行一次）
|
||||
* 入口参数：无
|
||||
* 返 回 值：GD5F_OK - 成功；其它 - SPI 传输或等待失败错误码
|
||||
* 限定条件：SPI 已初始化
|
||||
* 函数说明：E-53 规定本函数返回值必须被检查并上报，忽略它会让后续 program/erase 静默无效
|
||||
*/
|
||||
int32_t gd5f_write_enable(void);
|
||||
|
||||
/*
|
||||
* 函数功能：读取状态寄存器（0Fh / READ STATUS）
|
||||
* 入口参数：p_status - 状态字节输出 uint8_t* 不得为 NULL
|
||||
* 返 回 值：GD5F_OK - 成功（*p_status 有效）；GD5F_ERROR - SPI 失败（*p_status 不可信，调用方不得读用）
|
||||
* 限定条件：SPI 已初始化
|
||||
* 函数说明：E-42 同族纪律——失败时出参内容不可信，故判成败看返回值而不是看 *p_status 是否像样
|
||||
*/
|
||||
int32_t gd5f_read_status(uint8_t *p_status);
|
||||
|
||||
/*
|
||||
* 函数功能：页读取（13h：把数据从存储阵列装进内部缓存）
|
||||
* 入口参数：page_addr - 物理页地址 uint32_t 0 - GD5F_TOTAL_PAGES-1
|
||||
* 返 回 值：GD5F_OK - 命令已发出且等待完成；其它 - 透传底层 SPI/等待错误码
|
||||
* 限定条件：SPI 已初始化；**本函数成功不代表数据无位翻转**，正确性由随后的 gd5f_check_ecc() 判定
|
||||
* 函数说明：装载完成后须用 gd5f_read_from_cache() 取数据
|
||||
*/
|
||||
int32_t gd5f_page_read(uint32_t page_addr);
|
||||
|
||||
/*
|
||||
* 函数功能：从内部缓存读出数据（0Bh READ FROM CACHE）
|
||||
* 入口参数：column - 缓存内起始列 uint16_t 0 - GD5F_PAGE_SIZE-1
|
||||
* p_buf - 数据输出缓冲 uint8_t* 不得为 NULL
|
||||
* size - 读取字节数 uint32_t 1 - GD5F_PAGE_SIZE-column
|
||||
* 返 回 值：GD5F_OK - 成功；GD5F_ERROR - 参数非法或 SPI 失败（**此时 p_buf 内容不可信**）
|
||||
* 限定条件：必须先成功调用 gd5f_page_read() 完成阵列→缓存装载
|
||||
* 函数说明：E-42 同族——调用方不得在失败分支继续使用 p_buf（FTL 侧据此把读失败保守判为"非空页"）
|
||||
*/
|
||||
int32_t gd5f_read_from_cache(uint16_t column, uint8_t *p_buf, uint32_t size);
|
||||
|
||||
/*
|
||||
* 函数功能：把数据装进内部缓存（02h PROGRAM LOAD）
|
||||
* 入口参数：column - 缓存内起始列 uint16_t 0 - GD5F_PAGE_SIZE-1
|
||||
* p_buf - 待写数据 const uint8_t* 不得为 NULL
|
||||
* size - 字节数 uint32_t 1 - GD5F_PAGE_SIZE-column
|
||||
* 返 回 值：GD5F_OK - 装载完成；GD5F_WAIT_EXPIRED - 装载后等待 OIP 超时（**可重试**）；GD5F_ERROR - 参数/SPI 失败
|
||||
* 限定条件：先成功执行 gd5f_write_enable()；缓冲须在 DMA 可达窗口内（GD5F_DMA_RAM_* 白名单）
|
||||
* 函数说明：装载本身不写阵列，真正的编程由 gd5f_program_exec() 触发
|
||||
*/
|
||||
int32_t gd5f_program_load(uint16_t column, const uint8_t *p_buf, uint32_t size);
|
||||
|
||||
/*
|
||||
* 函数功能：触发页编程（10h PROGRAM EXEC）并检查 P_FAIL
|
||||
* 入口参数：page_addr - 目标物理页地址 uint32_t 合法页号
|
||||
* 返 回 值：GD5F_OK - 编程完成且无 P_FAIL；**GD5F_PROGRAM_FAIL - 芯片置 P_FAIL（块退化的信号）**；其它 - 透传底层/SPI 错误
|
||||
* 限定条件：本调用前须已 gd5f_program_load() 成功
|
||||
* 函数说明：P_FAIL 是**器件自己认定这一页写不下去**的位，与 SPI 层错误性质不同（FTL 据此标坏块）
|
||||
*/
|
||||
int32_t gd5f_program_exec(uint32_t page_addr);
|
||||
|
||||
/*
|
||||
* 函数功能：擦除一个块（D8h 擦除序列 + 等待 + 检查 E_FAIL）
|
||||
* 入口参数：block_addr - 物理块地址 uint32_t 0 - GD5F_TOTAL_BLOCKS-1
|
||||
* 返 回 值：GD5F_OK - 擦净；**GD5F_ERASE_FAIL - 芯片置 E_FAIL（坏块信号）**；其它 - 透传底层/SPI 错误
|
||||
* 限定条件：先成功执行 gd5f_write_enable()
|
||||
* 函数说明：E_FAIL 与 SPI 错误的区别同 program_exec；擦除超时归 GD5F_WAIT_EXPIRED（可重试）
|
||||
*/
|
||||
int32_t gd5f_block_erase(uint32_t block_addr);
|
||||
|
||||
/*
|
||||
* 函数功能：检查上一次页读取的 ECC 结果（读 00h/BCh 特征寄存器的 ECC 状态）
|
||||
* 入口参数：无
|
||||
* 返 回 值：GD5F_OK - 无不可纠错误（可能含已纠正的位翻转）；GD5F_ECC_ERROR - **存在不可纠正的 ECC 错误**
|
||||
* 限定条件：SPI 已初始化且 ECC 已使能（init 期扫描在使能前调用本函数无意义）
|
||||
* 函数说明：这是数据正确性的唯一判定点——SPI 层读到"内容"不等于"内容对"（见 §8.1 与本头 E-42/E-53 注释）
|
||||
*/
|
||||
int32_t gd5f_check_ecc(void);
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,3 +1,15 @@
|
||||
/*
|
||||
* 模块名称：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 R3）；返回值语义写明"失败类目前
|
||||
* 只进日志、不外传"，避免调用方以为能拿到 ECC / 预算耗尽的区别
|
||||
*/
|
||||
|
||||
#ifndef NAND_FTL_H
|
||||
#define NAND_FTL_H
|
||||
|
||||
@@ -7,12 +19,42 @@ extern "C" {
|
||||
|
||||
#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
|
||||
#endif /* NAND_FTL_H */
|
||||
|
||||
Reference in New Issue
Block a user