sd卡上移植filex

sd卡上移植filex

filex源码头文件：

1. fx_stm32_sd_driver.h
2. fx_port.h，主要关注ports/generic/inc
3. 以下都在common/inc文件夹下：
   1. fx_api.h
   2. fx_directory.h
   3. fx_fault_tolerant.h
   4. fx_file.h
   5. fx_media.h
   6. fx_system.h
   7. fx_unicode.h
   8. fx_user_sample.h
   9. fx_utility.h

fx_api.h：👑👑👑👑👑
该C函数定义了文件系统FileX的应用程序接口。它包含服务原型和数据结构定义，供开发人员使用FileX进行文件操作。而且是对外提供的，也包含了#include "fx_port.h"
fx_port.h：👑👑👑👑👑
这个文件通过fx_api.h被大部分文件引用。位置是：ports/generic/inc
此C文件定义了数据类型和宏，使得FileX的FAT兼容文件系统能在不同的处理器架构上功能一致。它还包含了编译器库头文件，并在FileX独立使用时定义基本数据类型。该文件结构设计为架构特定，以满足不同硬件和使用场景的需求，例如包含用户自定义配置以及利用ThreadX互斥锁进行线程保护。此外，它定义了错误检查逻辑和系统定时器更新率。
fx_utility.h：👑👑👑👑👑
FileX Utility组件的内部函数原型定义。其中包括了各种数据类型（16位无符号整数、32位无符号整数、64位无符号整数）的读写函数，内存拷贝和设置函数，逻辑扇区的缓存读写和刷新函数，FAT表项的读写和刷新函数以及字符串长度获取函数。这些函数对于FileX Utility组件的内部操作和数据处理是必要的。
fx_system.h:👑👑👑👑👑
包含了系统组件的常量和全局变量，以及filex文件系统的初始化、设置和获取系统日期和时间、系统计时器等。
fx_fault_tolerant.h：👑👑👑👑👑
FileX系统中容错组件的常量、数据结构和函数。它包含了日志文件格式、日志条目类型以及日志文件操作的定义。提供的函数允许启用容错性，开始和结束事务，添加日志条目，并从故障中恢复。代码还包含了对正确配置的检查和错误处理。FX_ENABLE_FAULT_TOLERANT,将开启容错组件。
fx_file.h：👑👑👑
这些函数是FileX文件系统组件的一部分，提供了对文件的各种操作，包括分配文件空间、读写文件、打开关闭文件、设置文件属性、重命名文件等。
fx_directory.h：👑👑👑
这些函数是FileX目录组件的一部分，提供了对文件目录的各种操作，包括读取和设置目录属性、创建和删除目录、获取和设置默认目录、读取目录项、查找目录项、重命名目录、获取目录信息、处理本地路径等。这些函数通过指向媒体对象的指针以及指向目录名和目录项的指针来执行操作。
fx_media.h：👑
FileX设备组件的一部分，用于管理存储介质的各种操作，如打开、关闭、格式化、读写、缓存管理、空间检查等。以下是部分函数的功能描述：
1. _fx_media_abort：中止当前媒体操作。
2. _fx_media_cache_invalidate：无效媒体缓存。
3. _fx_media_check：检查媒体的完整性。
4. _fx_media_close：关闭媒体。
5. _fx_media_format：格式化媒体。
6. _fx_media_open：打开媒体。
7. _fx_media_read：从媒体读取数据。
8. _fx_media_space_available：获取媒体上可用的空间。
9. _fx_media_volume_get：获取媒体的卷标。
10. _fx_media_volume_set：设置媒体的卷标。
fx_user_sample.h：👑
这个文件只有当FX_INCLUDE_USER_DEFINE_FILE定义时才会有效，它是fx_user.h的示例。这个文件里面包含很多可以让用户自行决定的宏，来让开发者根据需求调整filex的行为和性能、特性等。简单列一下我关注的：
1. FX_SINGLE_THREAD:如果定义了该宏，那么FileX内部的保护宏将被禁用。这对于单线程应用来说是不需要的，可以提高性能。如果未定义该宏，则会在多线程应用中使用ThreadX互斥锁来控制对打开媒体的多个线程访问。
2. FX_STANDALONE_ENABLE:如果定义了该宏，FileX将被用于独立模式（不依赖于ThreadX）。这使得FileX可以在没有操作系统支持的环境下运行。
3. FX_FAULT_TOLERANT_DATA：如果定义了该宏，数据扇区的写请求将立即刷新到驱动器。这可以提高数据的可靠性和耐久性，但可能会降低性能。
4. FX_FAULT_TOLERANT：如果定义了该宏，系统扇区的写请求（包括FAT和目录项请求）将立即刷新到驱动器。这可以确保系统数据的一致性和可靠性，但也可能会影响性能。
fx_unicode.h：👑
filex的unicode组件，提供对unicode文件名的支持。其中包括创建、重命名文件和目录，获取文件名的unicode长度，将短文件名转换为unicode文件名等功能。专门提供给fx_unicode_*_*.c

filex源码中包括了一个使用ram使用filex的简单例子，我们可以根据它写与IO driver对接的代码。以下给出了移植到sd卡上的过程以及注意的地方。

1. 通常在fx_port.h中定义移置 fileX所需的基本宏和函数，如mutex函数，时间更新周期，以及功能宏。
2. 调用fx_system_initialize（）初始化fileX，其中date及time可以同步为系统时间，默认10s秒更新一次date/time。
3. 根据sample实现I/O driver。我们使用的是sd卡，需要实现：
   1. FX_DRIVER_READ/FX_DRIVER_WRITE
   2. FX_DRIVER_INIT
   3. FX_DRIVER_BOOT_READ/FX_DRIVER_BOOT_WRITE
   4. 这里需要注意是FX_DRIVER_BOOT_READ/FX_DRIVER_BOOT_WRITE：它是读写boot区域，对应的是DBR(dos boot record)，我们可以在FX_DRIVER_INIT中去增加代码获取boot区域所在的物理sector。
4. 查找sd卡DBR地址：（包括两种情况：1卡上无分区，2卡上有分区），无分区没有MBR，有分区存在MBR。
   1. 读取sector 0，第一个字节是否为有效的跳转指令，或是否为exfat
   2. 若是，则sector 0即为有效的fat分区
   3. 若不是，则去读sector0上DPT(disk partition table)，从446字节开始为DPT，DPT共64字节，由4个分区表组成，每个分区表16个字节，从每一个分区表的第8字节-第12字节，是该分区所在的其实sector地址（即为DBR地址）。
   4. 读取DPT的每个分区起始sector0（即为DBR地址），判断第一个字节是否为有效的跳转指令，或是否为exfat，若是则为有效fat分区，记录起始sector地址(即为DBR地址)。
5. filex内部使用的是逻辑sector（从文件系统的sector0（也就是DBR）开始），需要在IO driver中转换成物理sector，如下：
   1. 物理sector地址=filex的逻辑sector地址+文件系统起始的物理sector地址（也就是DBR)
   2. sector = media_ptr->fx_media_driver_logical_sector + bootsector;
6. 实现FX_DRIVER_BOOT_READ/FX_DRIVER_BOOT_WRITE，根据上面得到的bootsector，调用sd卡IO接口去读写。
7. 实现FX_DRIVER_READ/FX_DRIVER_WRITE，根据上面得到物理sector，就可以去调用sd卡IO接口去读写。
8. 以上完成后，对接IO的部分就完成了，可以使用sample中的例子测试。
9. 如果要支持exfat，需要定义FX_ENABLE_EXFAT。
10. 如果使用第三方rtos，而不是使用threadx，需要定义FX_STANDALONE_ENABLE。
11. 如果要启动掉电安全，需要定义FX_ENABLE_FAULT_TOLERANT。