接口函数包括了向上的应用层接口函数和媒体层接口函数
官网的链接如下 FATFS
应用层接口
文件操作接口
文件打开和创建f_open
//第一个参数，一个新的文件型结构体，如FIL fil;
//路径和文件名"message.txt"或者"0:file.bin"
//第三个参数是文件的属性，
FRESULT f_open (FIL* fp,const TCHAR* path, BYTE mode );
| mode | 含义 |
|---|---|
| FA_READ | 数据可以被读出 |
| FA_WRITE | 数据可写入 |
| FA_OPEN_EXISTING | 打开一个文件，如果没有此文件，则失败 |
| FA_CREATE_NEW | 创建新文件，如果已经存在则反馈错误 |
| FA_CREATE_ALWAYS | 创建一个新文件，如果已存在，则覆盖旧文件 |
| FA_OPEN_ALWAYS | 打开一个文件，如果不存在，则创建文件 |
| FA_OPEN_APPEND | 功能同FA_OPEN_ALWAYS ，指针移到文件最后 |
返回码有很多，最主要的是FR_OK
f_close
当打开一个文件时，操作完成后进行关闭,这个很简单
fr = f_open(&fil, "message.txt", FA_READ);
f_close(&fil);
读文件f_read
第一个参数
FRESULT f_read (
FIL* fp, /* [IN] File object */
void* buff, /* [OUT] Buffer to store read data */
UINT btr, /* [IN] Number of bytes to read */
UINT* br /* [OUT] Number of bytes read */
);
看下面的调用函数
fr = f_read(&fsrc, buffer, sizeof buffer, &br);
if (fr || br == 0) break;
读的文件结构体是fsrc，将数据读入到buffer中，读出的数量为buffer数，而br用于累积已经完成了多少读出
f_write
下面的函数可以看出，写入结构体为fdst，将buffer中的内容进行写入，数量为刚刚计算的BR，BW用于累积写入的数量。
fr = f_write(&fdst, buffer, br, &bw);
if (fr || bw < br) break;
f_lseek 移动光标
res = f_lseek(fp, f_size(fp));//移动到文件末
res = f_lseek(fp, 5000);//移动到文件前往后的5000位置
压缩文件f_truncate
也就是是将尺寸压缩到现在的指针位置，也就是说，把后面的全部删除。
f_sync
功能基本上同f_close ，但是还可以继续进行读写查询的操作，用于那种用于需要长时间打开的操作，用此函数可以避免出错。
f_forward
f_forward函数从文件中读取数据并将数据转发到输出流，而不使用数据缓冲区。这适用于小存储系统，因为它在应用模块中不需要任何数据缓冲区。比如音频播放就可以用到此功能。
/* 定期或请求式填充输出流 */
49 rc = f_forward(&fil, out_stream, 1000, &dmy);
f_expand
给文件分配一个连续空间，如下：其中malloc的用法为：
lloc的全称是memory allocation，中文叫动态内存分配，用于申请一块连续的指定大小的内存块区域以void*类型返回分配的内存区域地址，当无法知道内存具体位置的时候，想要绑定真正的内存空间，就需要用到动态的分配内存。
//创建一个新文件
res = f_open(fp = malloc(sizeof (FIL)), "file.dat", FA_WRITE|FA_CREATE_ALWAYS);
/* Alloacte a 100 MiB of contiguous area to the file */
res = f_expand(fp, 104857600, 1);
f_gets - Read a string
f_putc - Write a character
f_puts - Write a string
f_printf
以特定格式写入到文件中，如下：
f_printf(&fil, "%d", 1234); /* "1234" */
f_printf(&fil, "%6d,%3d%%", -200, 5); /* " -200, 5%" */
f_printf(&fil, "%ld", 12345L); /* "12345" */
f_tell
获取一下当前的读写指针
f_eof
测试是不是文件的最尾端，如果是最尾端，则返回一个值。
f_size
获取一个文件的尺寸
f_error
测试是否有硬件错误发生，并不执行任何实际操作。
目录操作接口
f_opendir - Open a directory
f_closedir - Close an open directory
f_readdir - Read an directory item
f_findfirst - Open a directory and read the first item matched
f_findnext - Read a next item matched
在下面的这个函数中，用到了f_opendir和f_closedir和f_readdir
而f_findfirst为打开一个目录，然后读第一条。
而f_findnext为打开一个目录，读下一条匹配的标题。
FRESULT scan_files (
char* path
)
{
FRESULT res;
DIR dir;
UINT i;
static FILINFO fno;
//打开一个目录,目录为dir，打开目录中的某个路径
res = f_opendir(&dir, path); /* Open the directory */
if (res == FR_OK) {
for (;;) {
//读目录，读某个目录的某一条内容
res = f_readdir(&dir, &fno); /* Read a directory item */
if (res != FR_OK || fno.fname[0] == 0) break; /* Break on error or end of dir */
if (fno.fattrib & AM_DIR) { /* It is a directory */
i = strlen(path);
sprintf(&path[i], "/%s", fno.fname);
//嵌套使用
res = scan_files(path); /* Enter the directory */
if (res != FR_OK) break;
path[i] = 0;
} else { /* It is a file. */
printf("%s/%s\n", path, fno.fname);
}
}
//关闭目录
f_closedir(&dir)
}
return res;
}
上面关于目录管理的函数，在文件数量比较大一点的系统中可以用到，我们控制器的文件目录都比较简单，暂时不要考虑。
文件和目录管理
- f_stat - 查询一个文件是否存在，如果存在，则读文件的FILINFO信息。
- f_unlink - 移除一个文件
- f_rename - Rename/Move a file or sub-directory
- f_chmod - 更改文件的属性，如下：
/* Set Read-only, clear Archive and others are left unchanged. */
f_chmod("file.txt", AM_RDO, AM_RDO | AM_ARC);
- f_utime - 修改时间戳
- f_mkdir - Create a sub-directory
- f_chdir - Change current directory
- f_chdrive - Change current drive，修改当前的驱动盘符，如下：
f_chdrive("2:"); /* Set current drive to drive 2 */
- f_getcwd - Retrieve the current directory and drive
检索当前的目录的路径，如下：
TCHAR str[256];
fr = f_getcwd(str, sizeof str / sizeof *str); /* Get current directory path */
磁盘管理和系统配置
最重要的一个函数来了：
f_mount
挂载一个磁盘或者释放一个磁盘：
- 第一个参数:文件系统结构体
- 第二个参数:逻辑磁盘号
- 第三个参数:初始化，可以不用
比如：
fs = malloc(sizeof (FATFS)); /* Get work area for the volume */
f_mount(fs, "", 0); /* Mount the default drive */
...
f_mount(0, "", 0); /* Unmount the default drive */
free(fs); /* Here the work area can be discarded */
f_mkfs 创建一个FAT/exFAT
比如：
/* Create FAT volume */
res = f_mkfs("", FM_ANY, 0, work, sizeof work);
if (res) ...
/* Register work area */
f_mount(&fs, "", 0);
f_fdisk
比如在f_mkfs前先创建f_fdisk
f_fdisk(0, plist, work); /* Divide physical drive 0 */
f_mkfs("0:", FM_ANY, work, sizeof work); /* Create FAT volume on the logical drive 0 */
f_mkfs("1:", FM_ANY, work, sizeof work); /* Create FAT volume on the logical drive 1 */
- f_getfree - Get total size and free size on the volume
- f_getlabel - Get volume label
- f_setlabel - Set volume label
- f_setcp The f_setcp function sets the active code page for the path name.