/****************************************Copyright (c)**************************************************
**                               廣州周立功單片機發展有限公司
**                                     研    究    所
**                                        ARM開發組
**
**                                 http://www.zlgmcu.com
**
**--------------文件信息--------------------------------------------------------------------------------
**文   件   名: OSFile.h
**創   建   人: 陳明計
**最后修改日期: 2004年7月9日
**描        述: ZLG/FS在μCOS-II下使用的接口
**              
**--------------歷史版本信息----------------------------------------------------------------------------
** 創建人: 陳明計
** 版  本: V1.0
** 日　期: 2003年12月12日
** 描　述: 原始版本
**
**--------------當前版本修訂------------------------------------------------------------------------------
** 修改人: 陳明計
** 日　期: 2004年7月9日
** 描　述: 修改注釋
**
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
#ifndef __OSFILE_H 
#define __OSFILE_H

    #ifdef __cplusplus
    extern "C" {
    #endif
    
typedef uint8 HANDLE;
#define Not_Open_FILE               0xff

#define ZLG_FS_VER                  110

/* 函數返回值 */
#define RETURN_OK                   0x00    /* 操作成功         */
#define NOT_FIND_DISK               0x01    /* 邏輯盤不存在     */
#define DISK_FULL                   0x02    /* 邏輯盤滿         */
#define SECTOR_NOT_IN_CACHE         0x03    /* 扇區沒有被cache  */
#define NOT_EMPTY_CACHE             0x04    /* 沒有空閑cache    */
#define SECTOR_READ_ERR             0x05    /* 讀扇區錯誤       */
#define CLUSTER_NOT_IN_DISK         0x06    /* 邏輯盤中沒有此簇  */
#define NOT_FIND_FDT                0x07    /* 沒有發現文件(目錄)*/
#define NOT_FAT_DISK                0x08    /* 非FAT文件系統    */
#define FDT_OVER                    0x09    /* FDT索引超出范圍  */
#define FDT_EXISTS                  0x0a    /* 文件(目錄)已經存在*/
#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    /* 文件結束        */
#define FILE_LOCK                   0x12    /* 文件被鎖定       */
#define NOT_FIND_FILE               0x13    /* 沒有發現指定文件 */
#define NOT_FIND_DIR                0x14    /* 沒有發現指定目錄 */
#define GET_TIME_ERR                0x15    /* 獲取時間錯誤 */
#define DISK_NO_FORMAT              0x16    /* 邏輯盤沒有格式化 */
#define NOT_RUN                     0xfd    /* 命令未執行       */
#define BAD_COMMAND                 0xfe    /* 錯誤命令       */
#define PARAMETER_ERR               0xff    /* 非法參數        */

/* 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


/* 文件指針調整方式 */
#define SEEK_SET    0               /* 從文件開始處移動文件指針 */
#define SEEK_CUR    1               /* 從文件當前位置移動文件指針 */
#define SEEK_END    2               /* 從文件尾移動文件指針 */


/* 目錄表數據結構 */
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;          /* 起始簇號高兩個字節（fat16保留）*/
    uint16  WrtTime;            /* 最后寫時間 */
    uint16  WrtDate;            /* 最后寫日期 */
    uint16  FstClusLO;          /* 起始簇(cluster)號低兩個字節 */
    uint32  FileSize;           /* 文件大小 */
} FDT;


__swi(0xaa) unsigned int SwiHandle(int, ...);
#define FILE_SWI_START  0x121

/*********************************************************************************************************
** 函數名稱: OSRemoveFile
** 功能描述: 刪除文件
**
** 輸　入: DirFileName:用戶使用的文件名
**
** 輸　出: RETURN_OK：成功
**        其它參考關于返回值的說明
********************************************************************************************************/
__inline uint8 OSRemoveFile(char *DirFileName)
{
    return SwiHandle(FILE_SWI_START + 0x00, DirFileName);
}
/*********************************************************************************************************
** 函數名稱: OSFileOpen
** 功能描述: 以指定方式打開文件
**
** 輸　入: DirFileName:用戶使用的文件名
**        Type:打開方式
** 輸　出: 文件句柄，Not_Open_FILE為不能打開
********************************************************************************************************/
__inline HANDLE OSFileOpen(char *DirFileName, char *Type)
{
    return SwiHandle(FILE_SWI_START + 0x01, DirFileName, Type);
}
/*********************************************************************************************************
** 函數名稱: OSFileClose
** 功能描述: 關閉指定文件
**
** 輸　入: Handle:文件句柄
**
** 輸　出: RETURN_OK:成功
**        其它參考關于返回值的說明 
********************************************************************************************************/
__inline uint8 OSFileClose(HANDLE Handle)
{
    return SwiHandle(FILE_SWI_START + 0x02, Handle);
}
/*********************************************************************************************************
** 函數名稱: OSFileGetCh
** 功能描述: 從文件讀一個字節
**
** 輸　入: Ch:返回讀到的數據
**        Handle:文件句柄
** 輸　出: RETURN_OK:成功
**        其它參考關于返回值的說明 
********************************************************************************************************/
__inline uint8 OSFileGetCh(uint8 *Ch, HANDLE Handle)
{
    return SwiHandle(FILE_SWI_START + 0x03, Ch, Handle);
}
/*********************************************************************************************************
** 函數名稱: OSFileRead
** 功能描述: 讀取文件
**
** 輸　入: Buf:保存讀回的數據
**        Size:要讀的字節數
**        Handle:文件句柄
** 輸　出: 實際讀到的字節數
********************************************************************************************************/
__inline uint32 OSFileRead(void *Buf, uint32 Size, HANDLE Handle)
{
    return SwiHandle(FILE_SWI_START + 0x04, Buf, Size, Handle);
}
/*********************************************************************************************************
** 函數名稱: OSFilePutCh
** 功能描述: 寫一個字節到文件
**
** 輸　入: Ch:要寫的數據
**        Handle:文件句柄
** 輸　出: RETURN_OK:成功
**        其它參考關于返回值的說明 
********************************************************************************************************/
__inline uint8 OSFilePutCh(uint8 Ch, HANDLE Handle)
{
    return SwiHandle(FILE_SWI_START + 0x05, Ch, Handle);
}
/*********************************************************************************************************
** 函數名稱: OSFileWrite
** 功能描述: 寫文件
**
** 輸　入: Buf:要寫的數據
**        Size:要寫的字節數
**        Handle:文件句柄
** 輸　出: 實際寫的字節數
********************************************************************************************************/
__inline uint32 OSFileWrite(void *Buf, uint32 Size, HANDLE Handle)
{
    return SwiHandle(FILE_SWI_START + 0x06, Buf, Size, Handle);
}
/*********************************************************************************************************
** 函數名稱: OSFileCloseAll
** 功能描述: 關閉所有打開的文件
**
** 輸　入: 無
**
** 輸　出: NOT_RUN:未執行
**        RETURN_OK:成功
********************************************************************************************************/
__inline uint8 OSFileCloseAll(void)