嵌入式软件设计之提高代码可移植性

原型：

int dev_FileOpen(const char *FileName, int Mode);

功能：

打开本应用所属的文件

参数：

FileName（输入）

1-16Bytes

文件名，最多可以是16个字符，以‘\x00’结尾，超过16个字符的只取前16个。

Mode（输入）

O_CREAT

0100

文件打开方式，O_CREATE表示创建一个新的文件

O_RDWR

02

文件打开方式，O_RDWR表示打开文件用于读/写，

返回：  

[0,255]

成功，返回句柄号

-1

失败，错误码放在errno中

注释：

如果以O_CREATE | O_RDWR的方式打开文件，若文件已存在，则以O_RDWR的方式打开，否则创建该文件。已打开的文件可以重复打开，每次打开后，文件指针移到文件开头。

错误码介绍：

INVALID_MODE       mode不为O_RDWR/O_CREATE

FILE_NOEXIST 文件不存在

FILE_EXIST         当文件存在时以O_CREATE的方式打开 

MEM_OVERFLOW空间不足

TOO_MANY_FILES    文件句柄太多，超过255，无法创建新文件

FILE_OPENED        文件已打开

示例：

打开文件”Demo.bin”, 如果不存在该文件，则创建该文件。

int Ret = 0;

Ret = fileOpen(“Demo.bin”,O_RDWR); // 以读写方式打开该文件

if(Ret < 0) // 该文件不存在，则重新创建

{

     Ret = fileOpen(“Demo.bin”, O_CREAT);

     if(Ret < 0)

{

      return Ret; // 创建失败，则返回错误码

}

}

…………………  // 对这个文件进行其他的读写操作等

原型：

int dev_FileSeek(int FileID, int Offset, int Whence);

功能：

对打开的文件指针进行定位

参数：

FileID（输入）

[0,255]

文件句柄号，从打开文件获得的返回句柄

Offset（输入）

从Whence指定的位置到要移到的位置的字节数（有符号值）

Whence（输入）

SEEK_SET

0

表示从文件头开始

SEEK_CUR

1

从当前文件指针开始

SEEK_END

2

从文件尾开始。

返回：

>=0

成功, 返回的数值是文件当前指针相对文件头的位置

-1

失败，参数错误或偏移目标超出文件范围，错误码放在errno中。

注释：

错误码介绍：

INVALID_FILEID无效的文件句柄

FILE_NOT_OPENED   文件未打开

END_OVERFLOW      后移时超出文件长度的偏移

TOP_OVERFLOW    前移时出错

示例：

调用该函数前，必须先确认指定文件已经被正确打开了：

  fd = fileOpen(“filename”, O_RDWR);

1、定位到文件的第2个字节位置：

   Ret = fileSeek(fd, 2, SEEK_SET);

2、定位到文件的倒数第2个字节位置：

   Ret = fileSeek(fd, -2, SEEK_END);

3、定位当前位置的后面第2个字节处：

   Ret = fileSeek(fd, 2, SEEK_CUR);

原型：

int dev_FileRead(int FileID, void *DataBuf, int Len);

功能：

从文件的当前定位位置开始读取文件数据

参数：

FileID（输入）

[0,255]

文件句柄号，从打开文件获得的返回句柄

DataBuf（输出）

应用指定的用来存放读取数据的缓冲区

Len（输入）

期望读取的数据字节数。

返回：

>=0

读取成功，返回实际读到的字节数。

-1

失败，错误码放在errno中

注释：

读取后文件指针位置将移动到读取后的位置

错误码介绍：

FILE_NOT_OPENED文件未打开

INVALID_FILEID无效的文件句柄

示例：

调用该函数之前，先调用fileOpen打开指定的文件：

fd = fileOpen(“Filename”, O_CREAT|O_RDWR);

1、从文件起始处读取16字节

Ret = fileSeek(fd, 0, SEEK_SET);

Ret = fileRead(fd, Buff, 16);

2、从当前光标位置处开始读取16字节：

Ret = fileSeek(fd, 0, SEEK_CUR);

Ret = fileRead(fd, Buff, 16);

3、读取文件的最后16个字节

Ret = fileSeek(fd, -16, SEEK_END);

Ret = fileRead(fd, Buff, 16);

原型：

int dev_FileWrite(int FileID, const void *DataBuf, int Len);

功能：

从文件的当前定位位置开始写入数据

参数：

FileID（输入）

[0,255]

文件句柄号，从打开文件获得的返回句柄

DataBuf（输入）

应用指定的存放写入数据的缓冲区

Len（输入）

需要写入数据的字节数。

返回：

>=0

写入成功，返回实际写入的字节数。

-1

失败，错误码放在errno中

注释：

写入后，文件指针位置将移动到写入后的位置

错误码介绍：

INVALID_FILEID     无效的文件句柄

FILE_NOT_OPENED  文件未打开

MEM_OVERFLOW 空间不足或文件句柄太多

示例：

调用该函数之前，必须先调用fileOpen打开指定的文件：

fd = fileOpen(“filename”, O_RDWR|O_CREAT);

1、修改文件的头16个字节：

Ret = fileSeek(fd, 0, SEEK_SET);

Ret = fileWrite(fd, Buff, 16);

2、从当前光标处开始写入16字节：

Ret = fileSeek(fd, 0, SEEK_CUR);

Ret = fileWrite(fd, Buff, 16);

3、从文件结束处再写入16字节：

Ret = fileSeek(fd, 0, SEEK_END);

Ret = fileWrite(fd, Buff, 16);

原型：

int dev_FileTruncate(int FileID, int Len);

功能：

截短文件

参数：

FileID（输入）

[0,255]

文件句柄号，从打开文件获得的返回句柄

Len（输入）

从文件头保留的文件数据长度。

返回：

0

成功截断。

-1

失败，错误码放在errno中。

注释：

该函数将文件截断为Len长度，原文件中从Len到结尾的内容全被截去。文件指针移至截短后的文件的最后。

错误码介绍：

NO_FILESYS文件系统未建立

INVALID_FILEID    无效的文件句柄

FILE_NOT_OPENED      文件未打开

TOP_OVERFLOW          长度小于0

END_OVERFLOW        长度超出文件长度

示例：

只保留指定文件的前256字节内容：

fd = fileOpen(“filename”, O_RDWR);

Ret = fileTruncate(fd, 256);

原型：

int dev_FileClose(int FileID);

功能：

关闭已打开的文件

参数：

FileID（输入）

[0,255]

文件句柄号，从打开文件获得的返回句柄

返回：

0

成功关闭文件

-1

失败，错误码放在errno中。

注释：

错误码介绍：

INVALID_FILEID无效的文件句柄

示例：

先打开文件：

 fd = fileOpen(“filename”, O_RDWR | O_CREAT);

…………………  // 文件相关处理

关闭文件：

   Ret = fileClose(fd);

原型：

int dev_FileRemove(const char *FileName);

功能：

删除文件

参数：

FileName（输入）

1-16Bytes

文件名，最多可以是16个字符，以‘\x00’结尾，超过16个字符的只取前16个。

返回：

0

成功

-1

失败，错误码放在errno中。

注释：

错误码介绍：

FILE_OPENED 文件已打开

FILE_NOEXIST 文件不存在

示例：

删除指定文件：

 Ret = fileRemove(“filename”);

原型：

int dev_FileSize(const char *FileName); 

参数：

FileName（输入）

1-16Bytes

文件名，最多可以是16个字符，以‘\x00’结尾，超过16个字符的只取前16个。

返回：

>=0

文件的大小

-1

失败，错误码放在errno中。

注释：

错误码介绍：

FILE_NOEXIST 文件不存在

示例：

fileLen = fileSize(“filename”); // 查询文件大小

原型：

int dev_FileExist(const char *FileName);

功能：

判断文件是否存在

参数：

FileName（输入）

1-16Bytes

文件名，最多可以是16个字符，以‘\x00’结尾，超过16个字符的只取前16个。

返回：

[0,255]

文件序号。

-1

在当前应用中没有指定的文件

注释：

无

示例：

判断某个文件是否存在，如存在，则获取其大小：

Ret = fileExist(“filename”);

if(Ret >= 0)

{

    fileLen = fileSize(“filename”);

}

原型：

int dev_FileRename(const char *OldFileName, const char *NewFileName);

功能：

修改属于本应用的数据文件文件名

参数：

OldFileName（输入）

1-16Bytes

原文件名，最多可以是16个字符，以‘\x00’结尾，超过16个字符的只取前16个。

NewFileName（输入）

1-16Bytes

新文件名，最多可以是16个字符，以‘\x00’结尾，超过16个字符的只取前16个。

返回：

0

成功

-1

失败，错误码放在errno中。

注释：

错误码介绍：

FILE_OPENED 文件已打开

FILE_NOEXIST 文件不存在

FILE_EXIST    新文件已经存在

示例：

原型：

int dev_FileFreeSpace(void);

功能：

返回文件系统剩余可写的字节数

参数：

无

返回：

返回文件系统总共剩余的空间大小（字节数）

注释：

无

示例：

判断文件系统还有多少剩余空间：

FreeLen = fileFreeSpace();

原型：

int dev_MntSDCard(const char *TargetDir, int Mode);

功能：

挂载SD卡。

参数：

TargetDir（输入）

指定的挂载SD卡的目录，默认为"/mnt/sdcard/"。若为NULL则SD卡自动挂载到"/mnt/sdcard/"目录。

Mode（输入）

TRUE

挂载SD卡

FALSE

卸载SD卡

返回：

0

挂载成功

-1

挂载失败

注释：

应用层不需要关心挂载的设备名和filesystem类型。

挂载SD卡命令：mount -t vfat /dev/sdd1 /mnt/sdcard

原型：

int dev_MntUSBDisk(const char *TargetDir, int Mode);

功能：

挂载U盘。

参数：

TargetDir（输入）

指定的挂载U盘的目录，默认为"/mnt/usb/"。若为NULL则U盘自动挂载到"/mnt/usb/"目录。

Mode（输入）

TRUE

挂载U盘

FALSE

卸载U盘

返回：

0

挂载成功

-1

挂载失败

注释：

应用层不需要关心挂载的设备名和filesystem类型。

挂载U盘命令：mount -t vfat /dev/sda1 /mnt/usb