ARM技术讨论专区-ARM Cortex-M3文件系统源码分析[曙海教育集团论坛]项目外包开发咨询

以文本方式查看主题

-  曙海教育集团论坛  (http://sun4.cn/bbs/index.asp)
--  ARM技术讨论专区  (http://sun4.cn/bbs/list.asp?boardid=14)
----  ARM Cortex-M3文件系统源码分析  (http://sun4.cn/bbs/dispbbs.asp?boardid=14&id=1442)

--  作者：wangxinxin
--  发布时间：2010-11-18 9:03:08
--  ARM Cortex-M3文件系统源码分析
一、概述
1、目的
在移植之前，先将源代码大概的阅读一遍，主要是了解文件系统的结构、各个函数的功能和接口、与移植
相关的代码等等。
2、准备工作
在官方网站下载了0.07c版本的源代码，利用记事本进行阅读。
二、源代码的结构
1、源代码组成
源代码压缩包解压后，共两个文件夹，doc是说明，src里就是代码。src文件夹里共五个文件和一个文
件夹。文件夹是option，还有00readme.txt、diskio.c、diskio.h、ff.c、ff.h、integer.h。对比网上
的文章，版本已经不同了，已经没有所谓的tff.c和tff.h了，估计现在都采用条件编译解决这个问题了，
当然文件更少，可能编译选项可能越复杂。
2、00readme.txt的说明
  Low level disk I/O module is not included in this archive because the FatFs
  module is only a generic file system layer and not depend on any specific
  storage device. You have to provide a low level disk I/O module that written
  to control your storage device.主要是说不包含底层IO代码，这是个通用文件系统可以在各种介质
上使用。我们移植时针对具体存储设备提供底层代码。
  接下来做了版权声明-可以自由使用和传播。
  然后对版本的变迁做了说明。
3、源代码阅读次序
  先读integer.h,了解所用的数据类型，然后是ff.h,了解文件系统所用的数据结构和各种函数声明，然
后是diskio.h，了解与介质相关的数据结构和操作函数。再把ff.c和diskio.c两个文件所实现的函数大致
扫描一遍。最后根据用户应用层程序调用函数的次序仔细阅读相关代码。
三、源代码阅读
1、integer.h头文件
这个文件主要是类型声明。以下是部分代码。
typedef int INT;
typedef unsigned int UINT;
typedef signed char  CHAR;/* These types must be 8-bit integer */
都是用typedef做类型定义。移植时可以修改这部分代码，特别是某些定义与你所在工程的类型定义有冲
突的时候。
2、ff.h头文件
以下是部分代码的分析
#include "integer.h" 使用integer.h的类型定义
#ifndef _FATFS
#define _FATFS 0x007C  版本号007c，0.07c
#define _WORD_ACCESS 0 //如果定义为1，则可以使用word访问。
中间有一些看着说明很容易弄清楚意思。这里就不例举了。
#define _CODE_PAGE 936
/* The _CODE_PAGE specifies the OEM code page to be used on the target system.
OEM code page什么意思不大明白。
/ 936  - Simplified Chinese GBK (DBCS, OEM, Windows)跟据这个中国应该是936.
打开option文件夹看一下。打开cc936.c文件，里面有一个很大的数组static const WCHAR uni2oem[] 。
根据英文说明，这个数组用于unicode码和OEM码之间的相互转换。
接下来又有两个函数ff_convert()和ff_wtoupper()具体执行码型转换和将字符转换为大写。

百度一下：看OEM码什么意思。
unicode是一种双字节字符编码，无论中文还是英文，或者其他语言统一到2个字节。与现有的任何编码（
ASCII,GB等）都不兼容。WindowsNT(2000)的内核即使用该编码，所有数据进入内核前转换成UNICODE,退
出内核后在转换成版本相关的编码（通常称为OEM，在简体中文版下即为GB).（百度所得）
继续往下阅读。
#define _USE_LFN 1 //这个估计是长文件名支持了，以前的0.06版本好像是不支持。
#define _MAX_LFN 255 //最长支持255个双字节字符。
#define _FS_RPATH 0  //是否文件相对路径选项。
/* When _FS_RPATH is set to 1, relative path feature is enabled and f_chdir,
/  f_chdrive function are available.  //有些函数会受影响。
/  Note that output of the f_readdir fnction is affected by this option. */
#define _FS_REENTRANT 0  //如果要支持文件系统可重入，必须加入几个函数。
#define _TIMEOUT  1000 /* Timeout period in unit of time ticks of the OS */
#define _SYNC_t HANDLE /* Type of sync object used on the OS. e.g. HANDLE,
OS_EVENT*, ID and etc.. */
/* To make the FatFs module re-entrant, set _FS_REENTRANT to 1 and add user
/  provided synchronization handlers, ff_req_grant, ff_rel_grant, ff_del_syncobj
/  and ff_cre_syncobj function to the project. */
#elif _CODE_PAGE == 936 /* Simplified Chinese GBK */
#define _DF1S 0x81
#define _DF1E 0xFE
#define _DS1S 0x40
#define _DS1E 0x7E
#define _DS2S 0x80
#define _DS2E 0xFE
接下来很大一部分都是与语言相关的因素，略过。
/* Character code support macros */ 三个宏判断是否大写、小写、数字。
#define IsUpper(c) (((c)>=\'A\')&&((c)<=\'Z\'))
#define IsLower(c) (((c)>=\'a\')&&((c)<=\'z\'))
#define IsDigit(c) (((c)>=\'0\')&&((c)<=\'9\'))
#if _DF1S    /* DBCS configuration */双字节编码相关的设定，暂时不理会它。
#if _MULTI_PARTITION       /* Multiple partition configuration */
//该变量定义为1时，支持一个磁盘的多个分区。
typedef struct _PARTITION {
   BYTE pd;    /* Physical drive# */
   BYTE pt;    /* Partition # (0-3) */
} PARTITION;
Extern  const  PARTITION Drives[];//如果支持分区，则声明变量Drivers
#define LD2PD(drv) (Drives[drv].pd)    /* 获得磁盘对应的物理磁盘
#define LD2PT(drv) (Drives[drv].pt)    /*获得磁盘对应的分区
#else                                        /* Single partition configuration */
#define LD2PD(drv) (drv)  /* Physical drive# is equal to the logical drive# */
#define LD2PT(drv) 0       /* Always mounts the 1st partition */

#if _MAX_SS == 512  //一般扇区长度取512字节。
#define SS(fs)    512U

#if _LFN_UNICODE && _USE_LFN
typedef WCHAR XCHAR;    /* Unicode */ XCHAR是文件名的码型所用。
#else
typedef char XCHAR;       /* SBCS, DBCS */
#endif

typedef struct _FATFS_ {
   BYTE fs_type;       /* FAT sub type */
   BYTE drive;          /*对应实际驱动号01--- */
   BYTE csize;          /* 每个簇的扇区数目 */
先查一下簇的含义：应该是文件数据分配的基本单位。
   BYTE n_fats;          /* 文件分配表的数目 */
FAT文件系统依次应该是：引导扇区、文件分配表两个、根目录区和数据区。
   BYTE wflag;          /* win[] dirty flag (1:must be written back) */
//文件是否改动的标志，为1时要回写。
   WORD  id;                /* File system mount ID 文件系统加载ID*/
   WORD  n_rootdir;    /* 根目录区目录项的数目 */
#if _FS_REENTRANT
   _SYNC_t    sobj;             /* 允许重入，则定义同步对象 */
#endif
#if _MAX_SS != 512
   WORD  s_size;          /* Sector size */
#endif
#if !_FS_READONLY  //文件为可写
   BYTE fsi_flag; /* fsinfo dirty flag (1:must be written back) */
//文件需要回写的标志
   DWORD    last_clust;    /* Last allocated cluster */
   DWORD    free_clust;    /* Number of free clusters */
   DWORD    fsi_sector;    /* fsinfo sector */
#endif
#if _FS_RPATH
   DWORD    cdir;             /* 使用相对路径，则要存储文件系统当前目录
#endif
   DWORD    sects_fat;    /*文件分配表占用的扇区
   DWORD    max_clust;    /* 最大簇数
   DWORD    fatbase;  /*文件分配表开始扇区
   DWORD    dirbase;  /*  如果是FAT32，根目录开始扇区需要首先得到。
   DWORD    database;    /* 数据区开始扇区
   DWORD    winsect;  /* Current sector appearing in the win[] */
//目前的扇区在win[]里面，这个win[]数组暂时还不知道含义。
   BYTE win[_MAX_SS];/* Disk access window for Directory/FAT */
//这是一个win[512]数组，存储着一个扇区，好像作为扇区缓冲使用。
} FATFS;

typedef struct _DIR_ {
   FATFS* fs;/* Pointer to the owner file system object */指向相应文件系统对象。
   WORD  id;                /* 文件系统加载ID*/
   WORD  index;    /* Current read/write index number */目前读写索引代码
   DWORD    sclust;    /* Table start cluster (0:Static table) */文件数据区开始簇
   DWORD    clust;          /* Current cluster */ 目前处理的簇
   DWORD    sect;             /* Current sector */ 目前簇里对应的扇区
   BYTE*  dir;  /* Pointer to the current SFN entry in the win[] */
   BYTE*  fn;                /* Pointer to the SFN (in/out) {file[8],ext[3],status[1]} */
#if _USE_LFN
   WCHAR*    lfn; /* Pointer to the LFN working buffer */ 指向长文件名缓冲。
   WORD  lfn_idx; /* Last matched LFN index number (0xFFFF:No LFN) */
#endif
} DIR;

typedef struct _FIL_ {
   FATFS* fs;                /* Pointer to the owner file system object */
   WORD  id;                /* Owner file system mount ID */
   BYTE flag;       /* File status flags */文件状态标志
   BYTE csect;          /* Sector address in the cluster */扇区偏移
   DWORD    fptr;       /* File R/W pointer */ 读写指针
   DWORD    fsize;             /* File size */
   DWORD    org_clust;    /* File start cluster */文件开始簇
   DWORD    curr_clust;    /* Current cluster */当前簇
   DWORD    dsect;          /* Current data sector */文件当前扇区
#if !_FS_READONLY
   DWORD    dir_sect; /* Sector containing the directory entry */该文件目录项对应所在的扇区
   BYTE*  dir_ptr; /* Ponter to the directory entry in the window */
#endif
#if !_FS_TINY
   BYTE buf[_MAX_SS];/* File R/W buffer */文件读写缓冲
#endif
} FIL;

/* File status structure */

typedef struct _FILINFO_ {
   DWORD    fsize;             /* File size */
   WORD  fdate;          /* Last modified date */
   WORD  ftime;          /* Last modified time */
   BYTE fattrib; /* Attribute */
   char fname[13];    /* Short file name (8.3 format) */
#if _USE_LFN
   XCHAR*    lfname;       /* Pointer to the LFN buffer */
   int lfsize;          /* Size of LFN buffer [chrs] */
#endif
} FILINFO; 这个结构主要描述文件的状态信息，包括文件名13个字符（8+.+3+\\0）、属性、修改时间等。
接下来是函数的定义，先大概浏览一遍。
FRESULT f_mount (BYTE, FATFS*); //加载文件系统，BYTE参数是ID，后一个是文件系统定义。
FRESULT f_open (FIL*, const XCHAR*, BYTE);//打开文件，第一个参数是文件信息结构，第二个参数是文件名，第三是文件打开模式
FRESULT f_read (FIL*, void*, UINT, UINT*); //文件读取函数，参数1为文件对象（文件打开函数中得到），参数2为文件读取缓冲区，参数3为读取的字节数，参数4意义不清晰，等读到源代码就清楚了。
FRESULT f_write (FIL*, const void*, UINT, UINT*);//写文件，参数跟读差不多
FRESULT f_lseek (FIL*, DWORD); //移动文件的读写指针，参数2应该是移动的数目。
FRESULT f_close (FIL*);             /* Close an open file object */
FRESULT f_opendir (DIR*, const XCHAR*);    打开目录，返回目录对象
FRESULT f_readdir (DIR*, FILINFO*);             读取目录，获得文件信息
FRESULT f_stat (const XCHAR*, FILINFO*);                      /* Get file status */
FRESULT f_getfree (const XCHAR*, DWORD*, FATFS**); /* Get number of free clusters on the drive */
FRESULT f_truncate (FIL*);                /* Truncate file */
FRESULT f_sync (FIL*); /* Flush cached data of a writing file */将缓冲区数据写回文件
FRESULT f_unlink (const XCHAR*);          删除目录中的一个文件
FRESULT    f_mkdir (const XCHAR*);       /* Create a new directory */
FRESULT f_chmod (const XCHAR*, BYTE, BYTE); /* Change attriburte of the file/dir */
FRESULT f_utime (const XCHAR*, const FILINFO*);    /* Change timestamp of the file/dir */
FRESULT f_rename (const XCHAR*, const XCHAR*); /* Rename/Move a file or directory */
FRESULT f_forward (FIL*, UINT(*)(const BYTE*,UINT), UINT, UINT*); /* Forward data to the stream */ 这个函数还要提供一个回调函数。
FRESULT f_mkfs (BYTE, BYTE, WORD);       /* Create a file system on the drive */
FRESULT f_chdir (const XCHAR*);    /* Change current directory */改变当前目录
FRESULT f_chdrive (BYTE);          /* Change current drive */
应该说基本能明白这些函数用于干什么。