/*
 * 模块名称：SPI NAND FTL（dhara 移植层 + FatFs 磁盘接口）
 * 模块功能：把 GD5F SPI NAND 经 dhara 映射层暴露成 FatFs 的 0 号磁盘
 *          （disk_initialize/status/ioctl/read/write），并提供显式格式化入口。
 * 适用平台：STM32F4 系列 + GD5F2GQ5UE
 * 作者：王建锋
 * 创建日期：2026-09
 * 修改记录：
 *     2026-10-23  王建锋  补模块头与函数注释（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）；要让调用方按类分支，需要跨调用
 *   存活的失败类快照（C4 待还项，当前无消费者故未做）。
 *   调用方**不得**把 -1 解读成"卷坏了，可以重格式化"——教训正在这条上。
 */
int nand_ftl_init(void);

/*
 * 函数功能：清空 dhara 映射树并同步（**破坏性**：整卷逻辑地址→物理映射作废）
 * 入口参数：无
 * 返回值：GD5F_OK(0) - 已清空并同步；GD5F_ERROR(-1) - 初始化/刷写缓存/同步失败（卷状态未定，
 *         须重新挂载判定，不要连环重试）
 * 限定条件：只允许走显式命令或恢复流程调用；不得因"某次读写失败"自动调用
 * 函数说明：新卷从空树写起，避免旧 journal 残留与新卷共存（结构卫生）。
 *   容量恢复动作的区分（A 清日志 / B 重挂载 / C 全片擦除 / D 残留清理）
 *   → docs/测试说明/专项验证/存储维护与容量恢复.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 */