ch375hft.h

CH375的U盘文件级操作子程序库及相关例子源程序

	} Create;							/* CMD_FileCreate, 新建文件并打开,如果文件已经存在则先删除后再新建 */
	struct {
		UINT8	mPathName[ MAX_PATH_LEN ];	/* 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名...,结束符00H], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILENAME.EXT",00H */
	} Erase;							/* CMD_FileErase, 删除文件并关闭 */
	struct {
		UINT32	mFileSize;				/* 输入参数: 新的文件长度,为0FFFFFFFFH则不修改, 返回: 原长度 */
		UINT16	mFileDate;				/* 输入参数: 新的文件日期,为0FFFFH则不修改, 返回: 原日期 */
		UINT16	mFileTime;				/* 输入参数: 新的文件时间,为0FFFFH则不修改, 返回: 原时间 */
		UINT8	mFileAttr;				/* 输入参数: 新的文件属性,为0FFH则不修改, 返回: 原属性 */
	} Modify;							/* CMD_FileQuery, 查询当前文件的信息; CMD_FileModify, 查询或者修改当前文件的信息 */
	struct {
		UINT32	mSectorOffset;			/* 输入参数: 扇区偏移,0则移动到文件头,0FFFFFFFFH则移动到文件尾, 返回: 当前文件指针对应的绝对线性扇区号, 0FFFFFFFFH则已到文件尾 */
	} Locate;							/* CMD_FileLocate, 移动当前文件指针 */
	struct {
		UINT8	mSectorCount;			/* 输入参数: 读取扇区数, 返回: 实际读取扇区数 */
	} Read;								/* CMD_FileRead, 从当前文件读取数据 */
	struct {
		UINT8	mSectorCount;			/* 输入参数: 写入扇区数, 返回: 实际写入扇区数 */
	} Write;							/* CMD_FileWrite, 向当前文件写入数据 */
	struct {
		UINT8	mSectorCount;			/* 输入参数: 读取扇区数, 返回: 实际读取扇区数 */
		UINT8	mReserved[7];
		PUINT8	mDataBuffer;			/* 输入参数: 缓冲区起始地址, 返回: 缓冲区当前地址 */
	} ReadX;							/* CMD_FileReadX, 从当前文件读取数据到指定缓冲区 */
	struct {
		UINT8	mSectorCount;			/* 输入参数: 写入扇区数, 返回: 实际写入扇区数 */
		UINT8	mReserved[7];
		PUINT8	mDataBuffer;			/* 输入参数: 缓冲区起始地址, 返回: 缓冲区当前地址 */
	} WriteX;							/* CMD_FileWriteX, 向当前文件写入指定缓冲区的数据 */
	struct {
		UINT32	mDiskSizeSec;			/* 返回: 整个物理磁盘的总扇区数 */
	} DiskSize;							/* CMD_DiskSize, 查询磁盘容量 */
	struct {
		UINT32	mByteOffset;			/* 输入参数: 以字节为单位的偏移量, 以字节为单位的文件指针, 返回: 当前文件指针对应的绝对线性扇区号, 0FFFFFFFFH则已到文件尾 */
	} ByteLocate;						/* CMD_ByteLocate, 以字节为单位移动当前文件指针 */
	struct {
		UINT8	mByteCount;				/* 输入参数: 准备读取的字节数,不得大于MAX_BYTE_IO, 返回: 实际读出的字节数 */
		UINT8	mByteBuffer[ MAX_BYTE_IO ];	/* 返回: 读出的数据块 */
	} ByteRead;							/* CMD_ByteRead, 以字节为单位从当前文件读取数据块 */
	struct {
		UINT8	mByteCount;				/* 输入参数: 准备写入的字节数,不得大于MAX_BYTE_IO, 返回: 实际写入的字节数 */
		UINT8	mByteBuffer[ MAX_BYTE_IO ];	/* 输入参数: 准备写入的数据块 */
	} ByteWrite;						/* CMD_ByteWrite, 以字节为单位向当前文件写入数据块 */
	struct {
		UINT8	mSaveVariable;			/* 输入参数: 为0则恢复单个U盘的变量,为0x80则恢复多个U盘的变量,其它值则备份/保存变量 */
		UINT8	mReserved[3];
		PUINT8	mBuffer;				/* 输入参数: 指向子程序库的变量的备份缓冲区,长度不小于80个字节 */
	} SaveVariable;						/* CMD_SaveVariable, 备份/保存/恢复子程序库的变量 */
	union {
		struct {
			UINT32	mCBW_Sig;
			UINT32	mCBW_Tag;
			UINT8	mCBW_DataLen;		/* 输入: 数据传输长度,有效值是0到255 */
			UINT8	mCBW_DataLen1;
			UINT8	mCBW_DataLen2;
			UINT8	mCBW_DataLen3;
			UINT8	mCBW_Flag;			/* 输入: 传输方向等标志 */
			UINT8	mCBW_LUN;
			UINT8	mCBW_CB_Len;		/* 输入: 命令块的长度,有效值是1到16 */
			UINT8	mCBW_CB_Buf[6];		/* 输入: 命令块,该缓冲区最多为16个字节 */
		} mCBW;							/* BulkOnly协议的命令块, 输入CBW结构 */
		struct {
			UINT32	mCSW_Sig;
			UINT32	mCSW_Tag;
			UINT32	mCSW_Residue;		/* 返回: 剩余数据长度 */
			UINT8	mCSW_Status;		/* 返回: 命令执行结果状态 */
			UINT8	mReserved;
		} mCSW;							/* BulkOnly协议的命令状态块, 输出CSW结构 */
	} BOC;								/* CMD_BulkOnlyCmd, 执行基于BulkOnly协议的命令, 如果有数据传输那么数据在pDISK_BASE_BUF中 */
} CMD_PARAM;

typedef CMD_PARAM CMD_PARAM_I;
typedef CMD_PARAM *P_CMD_PARAM;

/* FILE: CH375HF?.C */

#define EN_DISK_WRITE			1
#define EN_DISK_FAT12			1
#define EN_DISK_FAT32			1
#define EN_BYTE_ACCESS			1
#define EN_SAVE_VARIABLE		1
#define EXT_BLK_INTERFACE		1
#define EN_SEC_SIZE_AUTO		1

#define LIB_CFG_DISK_IO			1		/* 默认情况下,磁盘读写的数据的复制方式 */
#ifndef LIB_CFG_FILE_IO
#define LIB_CFG_FILE_IO			1		/* 默认情况下,文件读写的数据的复制方式为"内部复制" */
#endif
#ifndef LIB_CFG_UPD_SIZE
#define LIB_CFG_UPD_SIZE		0		/* 默认情况下,在添加数据后文件长度的更新方式为"不更新" */
#endif
#ifndef LIB_CFG_NO_DLY
#define LIB_CFG_NO_DLY			0		/* 默认情况下,在写操作结束后的延时方式为"写后延时" */
#endif
#ifndef LIB_CFG_INT_EN
#define LIB_CFG_INT_EN			0		/* 默认情况下,CH375的INT#引脚连接方式为"查询方式" */
#endif
#ifndef DISK_BASE_BUF_LEN
#define DISK_BASE_BUF_LEN		512		/* 默认的磁盘数据缓冲区大小为512字节,建议选择为2048甚至4096以支持某些大扇区的U盘,为0则禁止在.H文件中定义缓冲区并由应用程序在pDISK_BASE_BUF中指定 */
#endif

#define LIB_CFG_VALUE		( ( LIB_CFG_INT_EN << 7 ) | ( LIB_CFG_NO_DLY << 5 ) | ( LIB_CFG_UPD_SIZE << 4 ) | ( LIB_CFG_FILE_IO << 2 ) | LIB_CFG_DISK_IO )	/* CH375程序库配置值 */

/* 子程序库中提供的变量 */
extern UINT8V	CH375IntStatus;			/* CH375操作的中断状态 */
extern UINT8V	CH375DiskStatus;		/* 磁盘及文件状态 */
extern UINT8	CH375LibConfig;			/* CH375程序库配置,下行说明 */
/* 位7: CH375的INT#引脚连接方式: 0查询方式,1中断方式 */
/* 位6: 该位为1且CH375Version2为1则芯片为CH375B */
/* 位5: 在写操作结束后是否延时: 0写后延时,1不延时 */
/* 位4: 在添加数据后是否自动更新文件长度: 0不更新,1自动更新 */
/* 位3位2: 针对文件读写的多扇区数据的复制方式: 00外部子程序, 01,10,11内部复制 */
/* 位1位0: 针对磁盘读写的单扇区数据的复制方式: 总是内部复制 */

/* 如果CH375的INT#引脚连接到单片机的中断输入引脚并且准备使用中断方式,那么LIB_CFG_INT_EN定义为1,否则定义为0由单片机查询INT#引脚 */
/* 在CH375子程序读写文件数据时,CH375的程序库提供两种优化速度的方式,在LIB_CFG_FILE_IO中定义:
   方式0:"外部子程序", 只适用于文件读写时的数据复制(只用于CH375FileReadX和CH375FileWriteX两个子程序),
                       是指由子程序xWriteToExtBuf和xReadFromExtBuf进行数据复制,这两个子程序是在应用程序中定义的,由CH375的程序库调用,
   方式1:"内部复制", 程序内置的常规数据复制方式
   对于文件数据读写,也就是应用程序调用CH375FileReadX和CH375FileWriteX子程序时:
     在方式0下,由应用程序在xWriteToExtBuf和xReadFromExtBuf子程序中自行管理缓冲区,设定缓冲区初值等,
     在方式1下,应用程序每次调用CH375FileReadX和CH375FileWriteX时,CH375的程序库都会从指定缓冲区的起始地址开始读写数据,
     例如: 某文件长度为1K(占用2个扇区), 如果调用CH375FileReadX时读1K(指定mCmdParam.Read.mSectorCount为2), 那么1K数据全读到指定缓冲区中,
           如果缓冲区较小只有0.5K, 那么分两次读取, 第一次调用CH375FileReadX时读0.5K, 处理完这0.5K数据后再调用CH375FileReadX读下一个0.5K并处理
*/
extern UINT8	CH375vDiskFat;			/* 逻辑盘的FAT标志:1=FAT12,2=FAT16,3=FAT32 */
extern UINT8	CH375vSecPerClus;		/* 逻辑盘的每簇扇区数 */
extern UINT32	CH375vStartCluster;		/* 当前文件或者目录的起始簇号 */
extern UINT32	CH375vFileSize;			/* 当前文件的长度 */
extern UINT32	CH375vCurrentOffset;	/* 当前文件指针,当前读写位置的字节偏移 */

/* FAT数据区中文件目录信息 */
typedef struct _FAT_DIR_INFO {
	UINT8	DIR_Name[11];				/* 00H,文件名,共11字节,不足处填空格 */
	UINT8	DIR_Attr;					/* 0BH,文件属性,参考前面的说明 */
	UINT8	DIR_NTRes;					/* 0CH */
	UINT8	DIR_CrtTimeTenth;			/* 0DH,文件创建的时间,以0.1秒单位计数 */
	UINT16	DIR_CrtTime;				/* 0EH,文件创建的时间 */
	UINT16	DIR_CrtDate;				/* 10H,文件创建的日期 */
	UINT16	DIR_LstAccDate;				/* 12H,最近一次存取操作的日期 */
	UINT16	DIR_FstClusHI;				/* 14H */
	UINT16	DIR_WrtTime;				/* 16H,文件修改时间,参考前面的宏MAKE_FILE_TIME */
	UINT16	DIR_WrtDate;				/* 18H,文件修改日期,参考前面的宏MAKE_FILE_DATA */
	UINT16	DIR_FstClusLO;				/* 1AH */
	UINT32	DIR_FileSize;				/* 1CH,文件长度 */
} FAT_DIR_INFO;							/* 20H */
typedef FAT_DIR_INFO *P_FAT_DIR_INFO;

extern BOOL1	CH375Version2;			/* 芯片版本:0-CH375,1-CH375A/B */
extern UINT32	CH375vDataStart;		/* 逻辑盘的数据区域的起始LBA */
extern UINT32	CH375vFdtLba;			/* 当前FDT所在的LBA地址 */
extern UINT16	CH375vFdtOffset;		/* 当前FDT在扇区内的偏移地址 */
extern UINT32	CH375vDiskRoot;			/* 对于FAT16盘为根目录占用扇区数,对于FAT32盘为根目录起始簇号 */
#ifdef EN_SEC_SIZE_AUTO
extern UINT16	CH375vSectorSize;		/* 磁盘的扇区大小 */
#else
#define	CH375vSectorSize	512			/* 磁盘的扇区大小 */
#endif
extern PUINT8	pDISK_BASE_BUF;			/* 指向外部RAM的磁盘数据缓冲区,缓冲区长度不小于CH375vSectorSize,由应用程序初始化 */

extern UINT8	CH375ReadBlock( void );		/* 从磁盘读取多个扇区的数据到外部接口交换区 */
#ifdef EN_DISK_WRITE
extern UINT8	CH375WriteBlock( void );	/* 将外部接口交换区的多个扇区的数据块写入磁盘 */
#endif

/* 子程序库中提供的子程序 */
/* 下述子程序中, 文件操作子程序CH375File*和磁盘查询子程序CH375DiskQuery都可能会用到磁盘数据缓冲区pDISK_BASE_BUF,
   并且有可能在pDISK_BASE_BUF中保存了磁盘信息, 所以必须保证pDISK_BASE_BUF不被用于其它用途,
   如果RAM较少, 要将pDISK_BASE_BUF临时用于其它用途, 那么在临时用完后必须调用CH375DirtyBuffer清除磁盘缓冲区 */
extern UINT8	CH375GetVer( void );		/* 获取当前子程序库的版本号 */
extern void		CH375Reset( void );			/* 复位CH375 */
extern UINT8	CH375Init( void );			/* 初始化CH375 */
extern UINT8	CH375DiskConnect( void );	/* 检查磁盘是否连接 */
extern UINT8	CH375DiskReady( void );		/* 查询磁盘是否准备好 */
extern void		CH375DirtyBuffer( void );	/* 清除磁盘缓冲区 */
extern UINT8	CH375FileOpen( void );		/* 打开文件或者枚举文件 */
extern UINT8	CH375FileClose( void );		/* 关闭当前文件 */
#ifdef EN_DISK_WRITE
extern UINT8	CH375FileErase( void );		/* 删除文件并关闭 */
extern UINT8	CH375FileCreate( void );	/* 新建文件并打开,如果文件已经存在则先删除后再新建 */
#endif
extern UINT8	CH375FileModify( void );	/* 查询或者修改当前文件的信息 */
extern UINT8	CH375FileLocate( void );	/* 移动当前文件指针 */
extern UINT8	CH375FileReadX( void );		/* 从当前文件读取数据到指定缓冲区 */
#ifdef EN_DISK_WRITE
extern UINT8	CH375FileWriteX( void );	/* 向当前文件写入指定缓冲区的数据 */
#endif
#ifdef EN_BYTE_ACCESS
extern UINT8	CH375ByteLocate( void );	/* 以字节为单位移动当前文件指针 */
extern UINT8	CH375ByteRead( void );		/* 以字节为单位从当前位置读取数据块 */
#ifdef EN_DISK_WRITE
extern UINT8	CH375ByteWrite( void );		/* 以字节为单位向当前位置写入数据块 */
#endif
#endif
extern UINT8	CH375DiskSize( void );		/* 查询磁盘容量 */
extern UINT8	CH375DiskQuery( void );		/* 查询磁盘信息 */
#ifdef EN_SAVE_VARIABLE
extern void		CH375SaveVariable( void );	/* 备份/保存/恢复子程序库的变量,用于子程序库在多个CH375芯片之间进行切换 */
#endif
extern UINT8	CH375BulkOnlyCmd( void );	/* 执行基于BulkOnly协议的命令 */
extern UINT8	CH375sDiskReady( void );	/* 查询磁盘是否准备好,支持CH375S */

/* 该头文件可以为CH375子程序库分配必要的I/O及内存资源,并产生必要的与硬件有关的目标代码,
   如果该文件是被工程项目的多个源程序包含作为头文件,那么应该只允许一个头文件分配资源和产生代码,
   除此之外的头文件应该被事先定义CH375HF_NO_CODE,从而禁止该头文件产生重复的目标代码,例如:
#define		CH375HF_NO_CODE		1
#include	CH375HF?.H
*/
#ifdef CH375HF_NO_CODE

extern void xWriteCH375Cmd( UINT8 mCmd );	/* 外部定义的被CH375程序库调用的子程序,向CH375写命令,最小周期为4uS,否则之前之后各延时2uS */
extern void xWriteCH375Data( UINT8 mData );	/* 外部定义的被CH375程序库调用的子程序,向CH375写数据,最小周期为1.5uS,否则之后延时1.5uS */
extern UINT8 xReadCH375Data( void );		/* 外部定义的被CH375程序库调用的子程序,从CH375读数据,最小周期为1.5uS,否则之前延时1.5uS */
extern CMD_PARAM_I mCmdParam;				/* 命令参数 */
#if DISK_BASE_BUF_LEN
extern UINT8  DISK_BASE_BUF[ DISK_BASE_BUF_LEN ];	/* 外部RAM的磁盘数据缓冲区,缓冲区长度为一个扇区的长度 */
#endif
#ifdef FILE_DATA_BUF_LEN
extern UINT8  FILE_DATA_BUF[ FILE_DATA_BUF_LEN ];	/* 外部RAM的文件数据缓冲区,缓冲区长度不小于一次读写的数据长度 */