原创 FatFs源代码中C语言编程技巧的应用

<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

一、FatFs源代码中C语言编程技巧的应用

1、FatFs的源代码结构

在不支持重入和长文件名的情况下，用到的文件有6个：integer.h、diskio.h、diskio.c、ff.h、ffconf.h、ff.c。

Integer.h是数据类型定义的头文件，C语言标准的数据类型有 char、short、int、long、float、double等，但是不同的机器平台上，同样的数据类型其支持的数据宽度可能是不同的。比如在8位机上，int是16位宽度。而在32位机上，int是32位。因此移植性高的源代码，都不应该直接使用这些数据类型，而是利用tpyedef将所有的数据类型定义新的名字，而在源代码中使用这些新名字。

当代码移植到不同的平台时，根据所要求的数据宽度和实际平台上的规定，再重新配置数据类型就可以了，而源代码中的类型名称都不用改。我们在STM32上用到的库文件、ucos的类型定义、FatFs的类型定义都是这样做的。

diskio.h包含了integer.h，定义了一些简单的配置常量。主要是定义了两个数据类型：一个是DSTATUS，用于表示磁盘状态，它实质上就是char类型；一个是枚举类型DRESULT，用来表示磁盘操作的返回结果-正确还是错误。

接下来主要是一些函数的原型声明。其它源文件只要包含了这个头文件，就可以调用这些函数。

再接下来是磁盘状态常数和磁盘操作控制代码的定义，都是用define来实现的。

Ffconf.c都是一些用于配置的常数定义。

ff.h中根据ffconf.c中的配置定义了一些宏常数和 带参数的宏。主要是定义了FATFS、FIL、DIR和FILINFO四个文件信息结构体，用来存储文件系统、目录、文件的相关信息。

定义了FRESULT这个枚举类型结构体，大多数的文件操作函数都返回这个类型的值。

定义了文件访问模式、目录项属性、目录项各属性字节偏移、BPB参数表偏移等，特别重要的是定义了字、双字访问宏等。

#define LD_WORD(ptr)        (WORD)(*(WORD*)(BYTE*)(ptr))

#define LD_DWORD(ptr)            (DWORD)(*(DWORD*)(BYTE*)(ptr))

#define ST_WORD(ptr,val)   *(WORD*)(BYTE*)(ptr)=(WORD)(val)

#define ST_DWORD(ptr,val)       *(DWORD*)(BYTE*)(ptr)=(DWORD)(val)

这几个宏在获取和写入文件信息时特别有用。

ff.c开头也有一些常数宏和带参数宏的定义，大多数的变量都在这个定义和初始化。然后主要是所有文件操作函数的定义。

2、FatFs中用到的一些C语言技巧

（1）利用宏、条件编译来实现系统的高配置性

在FatFs中，我们可以看到大量类似下面的代码：

#if _FS_RPATH

      if (*path == '/' || *path == '\\') { /* There is a heading separator */

             path++; dj->sclust = 0;            /* Strip it and start from the root dir */

      } else {                                            /* No heading saparator */

             dj->sclust = dj->fs->cdir; /* Start from the current dir */

      }

#else

      if (*path == '/' || *path == '\\') /* Strip heading separator if exist */

             path++;

      dj->sclust = 0;                                        /* Start from the root dir */

#endif

而在ffconf.h中定义宏_FS_RPATH的值，可以实现不同的功能。

（2）利用结构体存储一个对象的所有信息

typedef struct _FIL_ {

      FATFS* fs;                 /* Pointer to the owner file system object */

      WORD id;                 /* Owner file system <?xml:namespace prefix = st1 ns = "urn:schemas-microsoft-com:office:smarttags" />mountID */

      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;

文件的操作就通过这样的结构体来进行。

（3）统一所用文件操作函数的模式

几乎所有的函数都返回FRESULT类型，而FRESULT是通过typedef定义的一种枚举变量，这样使得函数的风格很清新，易读性强。

（4）带参数宏的巧妙利用

比如：#define IsUpper(c)    (((c)>='A')&&((c)<='Z'))

#define IsLower(c)     (((c)>='a')&&((c)<='z'))

还比如前面的字、双字操作函数，结合对属性字节偏移的常数定义，使得操作时意义非常清晰：

             fno->fsize = LD_DWORD(dir+DIR_FileSize);       /* 文件大小 */

             fno->fdate = LD_WORD(dir+DIR_WrtDate);

这样使得代码的可读性大大增强。

（5）良好的代码书写风格和版本控制

int f_puts (

      const char* str,   /* Pointer to the string to be output */

      FIL* fil                /* Pointer to the file object */

)

{

      int n;

      for (n = 0; *str; str++, n++) {

             if (f_putc(*str, fil) == EOF) return EOF;

      }

      return n;

}