/****************************************Copyright (c)**************************************************
**                               廣州周立功單片機發(fā)展有限公司
**                                     研    究    所
**                                        ARM開發(fā)組
**
**                                 http://www.zlgmcu.com
**
**--------------文件信息--------------------------------------------------------------------------------
**文   件   名: fat.h
**創(chuàng)   建   人: 陳明計
**最后修改日期: 2003年9月3日
**描        述: FAT文件系統(tǒng)總頭文件
**              
**--------------歷史版本信息----------------------------------------------------------------------------
** 創(chuàng)建人: 陳明計
** 版  本: V1.0
** 日　期: 2003年9月3日
** 描　述: 原始版本
**
**--------------當(dāng)前版本修訂------------------------------------------------------------------------------
** 修改人: 陳明計
** 日　期: 2004年4月10日
** 描　述: 修改注釋
**
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
#ifndef MAX_OPEN_FILES
#define MAX_OPEN_FILES              10          //可以同時打開的文件數(shù)目
#endif

#ifndef DISK_CACHE_SIZE
#define DISK_CACHE_SIZE             512         //文件系統(tǒng)Cache大小(字節(jié)),應(yīng)當(dāng)是最大的扇區(qū)所占字節(jié)數(shù)
#endif

#ifndef MAX_DISK_CACHES
#define MAX_DISK_CACHES             100          //文件系統(tǒng)Cache數(shù)目
#endif

#ifndef MAX_DRIVES
#define MAX_DRIVES                  1           //可以同時加載的邏輯驅(qū)動器數(shù)目
#endif

#if MAX_OPEN_FILES < 0x80
typedef int8 HANDLE;
#else
#if MAX_OPEN_FILES < 0x8000
typedef int16 HANDLE;
#else
typedef int32 HANDLE;
#endif
#endif

#define Not_Open_FILE               -1


/* 底層驅(qū)動命令 */
#define DISK_INIT                   0
#define DISK_CLOSE                  1
#define DISK_READ_SECTOR            2
#define DISK_WRITE_SECTOR           3

/* 底層驅(qū)動返回值 */
#define DISK_READ_OK                0x01
#define DISK_READ_NOT_OK            0x80
#define DISK_WRITE_OK               0x02
#define DISK_WRITE_NOT_OK           0x82
#define DISK_INIT_OK                0x03
#define DISK_INIT_NOT_OK            0x83
#define BAD_DISK_COMMAND            0xffff

/* 函數(shù)返回值 */
#define RETURN_OK                   0x00    /* 操作成功         */
#define NOT_FIND_DISK               0x01    /* 邏輯盤不存在     */
#define DISK_FULL                   0x02    /* 邏輯盤滿         */
#define SECTOR_NOT_IN_CACHE         0x03    /* 扇區(qū)沒有被cache  */
#define NOT_EMPTY_CACHE             0x04    /* 沒有空閑cache    */
#define SECTOR_READ_ERR             0x05    /* 讀扇區(qū)錯誤       */
#define CLUSTER_NOT_IN_DISK         0x06    /* 邏輯盤中沒有此簇  */
#define NOT_FIND_FDT                0x07    /* 沒有發(fā)現(xiàn)文件(目錄)*/
#define NOT_FAT_DISK                0x08    /* 非FAT文件系統(tǒng)    */
#define FDT_OVER                    0x09    /* FDT索引超出范圍  */
#define FDT_EXISTS                  0x0a    /* 文件(目錄)已經(jīng)存在*/
#define ROOT_FDT_FULL               0x0b    /* 根目錄滿         */
#define DIR_EMPTY                   0x0C    /* 目錄空           */
#define DIR_NOT_EMPTY               0x0d    /* 目錄不空         */
#define PATH_NOT_FIND               0x0e    /* 路徑未找到       */
#define FAT_ERR                     0x0f    /* FAT表錯誤       */
#define FILE_NAME_ERR               0x10    /* 文件(目錄)名錯誤 */
#define FILE_EOF                    0x11    /* 文件結(jié)束        */
#define FILE_LOCK                   0x12    /* 文件被鎖定       */
#define NOT_FIND_FILE               0x13    /* 沒有發(fā)現(xiàn)指定文件 */
#define NOT_FIND_DIR                0x14    /* 沒有發(fā)現(xiàn)指定目錄 */
#define NOT_RUN                     0xfd    /* 命令未執(zhí)行       */
#define BAD_COMMAND                 0xfe    /* 錯誤命令       */
#define PARAMETER_ERR               0xff    /* 非法參數(shù)        */

/* 未使用的邏輯盤  */
#define EMPTY_DRIVE                 0xff

/* FAT類型 */
#define FAT12                       0
#define FAT16                       1
#define FAT32                       2

/* FDT文件屬性 */
#define ATTR_READ_ONLY              0x01
#define ATTR_HIDDEN                 0x02
#define ATTR_SYSTEM                 0x04
#define ATTR_VOLUME_ID              0x08
#define ATTR_DIRECTORY              0x10
#define ATTR_ARCHIVE                0x20

/* 簇類型 */
#define EMPTY_CLUS                  0
#define EMPTY_CLUS_1                1
#define BAD_CLUS                    0x0ffffff7L
#define EOF_CLUS_1                  0x0ffffff8L
#define EOF_CLUS_END                0x0fffffffL

/* FDT類型 */
#define EMPTY_FDT                   0
#define DEL_FDT                     ((char)(0xe5))
#define ESC_FDT                     0x05

/* Cache狀態(tài) */
#define CACHE_READED                0x02
#define CACHE_WRITED                0x01

/* 文件指針狀態(tài) */
#define FILE_FLAGS_READ             1 << 0          // 可讀
#define FILE_FLAGS_WRITE            1 << 1          // 可寫

/* 文件指針調(diào)整方式 */
#define SEEK_SET    0               // 從文件開始處移動文件指針
#define SEEK_CUR    1               // 從文件當(dāng)前位置移動文件指針
#define SEEK_END    2               // 從文件尾移動文件指針


/* 給底層驅(qū)動讀寫命令的參數(shù)結(jié)構(gòu)體 */
typedef struct _Disk_RW_Parameter
{
    uint8       Drive;          // 驅(qū)動器號
    uint32      SectorIndex;    // 操作的扇區(qū)
    uint32      RsvdForLow;     // 保留給底層驅(qū)動程序，由_Disk_Info中拷貝過來 
    uint8       *Buf;           // 數(shù)據(jù)存儲位置
}Disk_RW_Parameter;

/* 文件系統(tǒng)cache數(shù)據(jù)結(jié)構(gòu) */
typedef struct _Disk_Cache
{
    uint8       Drive;          // 驅(qū)動器號,EMPTY_DRIVE為空閑
    uint8       Flag;           // 狀態(tài)
    uint16      RW_ID;          // 讀寫ID,用于釋放Cache
//    uint8       Lock;           // 是否鎖定扇區(qū)
    uint32      SecIndex;       // 緩沖的扇區(qū)索引
    uint8       buf[DISK_CACHE_SIZE];
                                // 緩沖區(qū)
}Disk_cache;

/* 邏輯盤信息的數(shù)據(jù)結(jié)構(gòu) */
typedef struct _Disk_Info
{
    uint8       Drive;          // 邏輯驅(qū)動器號，EMPTY_DRIVE為還未分配
    uint8       FATType;        // 類型：FAT12、FAT16和FAT32
    uint8       SecPerClus;     // 每簇扇區(qū)數(shù)
    uint8       NumFATs;        // FAT表數(shù)目

    uint32      SecPerDisk;     // 邏輯驅(qū)動器包含扇區(qū)數(shù)
    uint32      BytsPerSec;     // 每扇區(qū)字節(jié)數(shù)
    uint32      RootDirTable;   // 根目錄開始扇區(qū)號（FAT32為開始簇號）
    uint32      RootSecCnt;     // 根目錄占用扇區(qū)數(shù)
    uint32      FATStartSec;    // FAT表開始扇區(qū)號
    uint32      FATSecCnt;      // 每個FAT占用扇區(qū)數(shù)
    uint32      DataStartSec;   // 數(shù)據(jù)區(qū)開始扇區(qū)號
    uint32      ClusPerData;    // 數(shù)據(jù)區(qū)包含簇數(shù)
    uint32      PathClusIndex;  // 當(dāng)前路徑的FDT表開始簇號, 0為根目錄 
    uint32      RsvdForLow;     // 保留給底層驅(qū)動程序 
    
    uint16  (* DiakCommand)(uint8 Cammand, void *Parameter);
                                // 對應(yīng)的驅(qū)動程序
}Disk_Info;

/* 目錄表數(shù)據(jù)結(jié)構(gòu) */
typedef struct _FDT
{
    char    Name[11];           //短文件名主文件名
    uint8   Attr;               //文件屬性
    uint8   NTRes;              //保留給NT
    uint8   CrtTimeTenth;       //建立時間（fat16保留）
    uint16  CrtTime;            //建立時間（fat16保留）
    uint16  CrtDate;            //建立日期（fat16保留）
    uint16  LstAccDate;         //最后訪問日期（fat16保留）
    uint16  FstClusHI;          //起始簇號高兩個字節(jié)（fat16保留）
    uint16  WrtTime;            //最后寫時間
    uint16  WrtDate;            //最后寫日期
    uint16  FstClusLO;          //起始簇(cluster)號低兩個字節(jié)
    uint32  FileSize;           //文件大小
} FDT;

/* 文件信息結(jié)構(gòu)體 */
typedef struct _FILE
{
    uint8       Flags;          // 一些標(biāo)志
    char        Name[11];       // 文件名
    uint8       Drive;          // 文件所在磁盤
    uint32      DirClus;        // 所在目錄開始簇號
    uint32      FileSize;       // 文件大小
    uint32      FstClus;        // 起始簇號
    uint32      Clus;           // 當(dāng)前簇號
    uint32      Offset;         // 文件指針偏移量
} MY_FILE;


/*******************************************************************************************************/


#ifndef IN_FILE

extern void FileInit(void);
/*********************************************************************************************************
** 函數(shù)名稱: FileInit
** 功能描述: 初始化文件指針系統(tǒng)
**
** 輸　入: 無
**
** 輸　出: 無
**         
** 全局變量: 無
** 調(diào)用模塊: 無
********************************************************************************************************/

extern uint8 RemoveFile(char *DirFileName);
/*********************************************************************************************************
** 函數(shù)名稱: RemoveFile
** 功能描述: 刪除文件
**
** 輸　入: DirFileName:用戶使用的文件名
**
** 輸　出: RETURN_OK：成功
**        其它參考fat.h中關(guān)于返回值的說明
** 全局變量: 無
** 調(diào)用模塊: strupr,_GetFileInfo,GetDrive,FindFDTInfo,FATDelClusChain,DelFDT
********************************************************************************************************/

extern HANDLE FileOpen(char *DirFileName, char *Type);
/*********************************************************************************************************
** 函數(shù)名稱: FileOpen
** 功能描述: 以指定方式打開文件
**
** 輸　入: DirFileName:用戶使用的文件名
**        Type:打開方式
** 輸　出: 文件句柄，Not_Open_FILE為不能打開
**         
** 全局變量: 無
** 調(diào)用模塊: _FileOpenR,_FileOpenW,_FileOpenRW
********************************************************************************************************/

extern uint8 FileClose(HANDLE Handle);
/*********************************************************************************************************
** 函數(shù)名稱: FileClose
** 功能描述: 關(guān)閉指定文件
**
** 輸　入: Handle:文件句柄
**
** 輸　出: RETURN_OK:成功
**        其它參考fat.h中關(guān)于返回值的說明 
** 全局變量: 無
** 調(diào)用模塊: 無
********************************************************************************************************/

extern uint8 FileGetCh(uint8 *Ch, HANDLE Handle);
/*********************************************************************************************************
** 函數(shù)名稱: FileGetCh
** 功能描述: 從文件讀一個字節(jié)
**
** 輸　入: Ch:返回讀到的數(shù)據(jù)
**        Handle:文件句柄
** 輸　出: RETURN_OK:成功
**        其它參考fat.h中關(guān)于返回值的說明 
** 全局變量: 無
** 調(diào)用模塊: 無
********************************************************************************************************/

extern uint32 FileRead(void *Buf, uint32 Size, HANDLE Handle);
/*********************************************************************************************************
** 函數(shù)名稱: FileRead
** 功能描述: 讀取文件
**
** 輸　入: Buf:保存讀回的數(shù)據(jù)
**        Size:要讀的字節(jié)數(shù)
**        Handle:文件句柄
** 輸　出: 實際讀到的字節(jié)數(shù)
**         
** 全局變量: 無
** 調(diào)用模塊: 無
********************************************************************************************************/

extern uint8 FilePutCh(uint8 Ch, HANDLE Handle);
/*********************************************************************************************************
** 函數(shù)名稱: FilePutCh
** 功能描述: 寫一個字節(jié)到文件
**
** 輸　入: Ch:要寫的數(shù)據(jù)