ch375hm.h

南京沁恒电子的U盘文件读写模块的实例程序

/*
****************************************
**  Copyright  (C)  W.ch  1999-2007   **
**  Web:  http://www.winchiphead.com  **
****************************************
**  USB Host File Module      @CH375  **
****************************************
*/
/* CH375 主机文件系统接口模块 */
/* 支持: FAT12/FAT16/FAT32 */
/* U盘文件读写模块C语言头文件 */

#ifndef __CH375HM_H__
#define __CH375HM_H__

#define CH375HM_VER				0x30	/* 当前模块版本 */

/* ********************************************************************************************************************* */
/* 返回的操作状态码 */
/* 以下是事件通知状态码,检测到当前U盘已经连接或者已经断开,可以作为最终状态码 */
#define	ERR_USB_CONNECT			0x15	/* 检测到USB设备连接事件,磁盘已经连接 */
#define ERR_DISK_DISCON			0x82	/* 检测到USB设备连接事件,磁盘已经断开,或者磁盘尚未连接 */
/* 代码0XH用于USB设备方式的操作状态代码,由CH375返回,是USB设备模式的中断状态 */
#define	ERR_USB_DAT_DOWN		0x02	/* USB设备模式: 数据下传成功,上位机下传的数据已经在模块中 */
#define	ERR_USB_DAT_UP			0x0A	/* USB设备模式: 数据上传成功,模块中的上传数据已经被上位机取走 */
/* 以下是阶段性的状态码,用于请求数据交换,不是最终的操作状态 */
#define	USB_INT_DISK_READ		0x1D	/* USB存储器读数据块,只用于CMD_FileRead命令,请求数据读出 */
#define	USB_INT_DISK_WRITE		0x1E	/* USB存储器写数据块,只用于CMD_FileWrite命令,请求数据写入 */
#define	USB_INT_DISK_RETRY		0xEE	/* USB存储器读写数据块失败重试,只用于CMD_FileRead命令和CMD_FileRead命令,操作失败重试 */
/* USB_INT_DISK_RETRY重试状态码要求用户端程序回改文件数据缓冲区指针,以便重新发送或者接收文件数据,
   在USB_INT_DISK_RETRY重试状态码之后用户端程序将收到两个字节的数据,也就是一个16位的数据,指定需要回改指针的字节数,大端时高字节在前,小端时低字节在前 */
/* 最终状态码 */
#define ERR_SUCCESS				0x00	/* 操作成功 */
#define ERR_CH375_ERROR			0x81	/* CH375硬件错误,可能需要复位CH375 */
#define ERR_STATUS_ERR			0x83	/* 磁盘状态错误,可能正在连接或者断开磁盘 */
#define ERR_MBR_ERROR			0x91	/* 磁盘的主引导记录无效,可能磁盘尚未分区或者尚未格式化 */
#define ERR_TYPE_ERROR			0x92	/* 磁盘分区类型不支持,只支持FAT12/FAT16/BigDOS/FAT32,需要由磁盘管理工具重新分区 */
#define ERR_BPB_ERROR			0xA1	/* 磁盘尚未格式化,或者参数错误,需要由WINDOWS采用默认参数重新格式化 */
#define ERR_TOO_LARGE			0xA2	/* 磁盘非正常格式化并且容量大于4GB,或者容量大于250GB,需要由WINDOWS采用默认参数重新格式化 */
#define ERR_FAT_ERROR			0xA3	/* 磁盘的文件系统不支持,只支持FAT12/FAT16/FAT32,需要由WINDOWS采用默认参数重新格式化 */
#define ERR_DISK_FULL			0xB1	/* 磁盘文件太满,剩余空间太少或者已经没有,需要磁盘整理 */
#define ERR_FDT_OVER			0xB2	/* 目录内文件太多,没有空闲的目录项,FAT12/FAT16根目录下的文件数应该少于500个,需要磁盘整理 */
#define ERR_MISS_DIR			0xB3	/* 指定路径的某个子目录没有找到,可能是目录名称错误 */
#define ERR_FILE_CLOSE			0xB4	/* 文件已经关闭,如果需要使用,应该重新打开文件 */
#define ERR_OPEN_DIR			0x41	/* 指定路径的目录被打开 */
#define ERR_MISS_FILE			0x42	/* 指定路径的文件没有找到,可能是文件名称错误 */
#define ERR_FOUND_NAME			0x43	/* 搜索到与通配符相匹配的文件名,文件名及其完整路径在命令缓冲区中,如果需要使用,应该打开该文件 */
#define	ERR_USB_DISK_ERR		0x1F	/* USB存储器操作失败,在初始化时可能是USB存储器不支持,在读写操作中可能是磁盘损坏或者已经断开 */
/* 其余错误代码未定义,可以发出命令CMD_QueryStatus查询模块状态并分析 */

/* ********************************************************************************************************************* */
/* 磁盘及文件状态,适用于CMD_PARAM.Status.mDiskStatus */
#define DISK_UNKNOWN			0x00	/* 尚未初始化,未知状态 */
#define DISK_DISCONNECT			0x01	/* 磁盘没有连接或者已经断开 */
#define DISK_CONNECT			0x02	/* 磁盘已经连接,但是尚未初始化或者无法识别该磁盘 */
#define DISK_MOUNTED			0x03	/* 磁盘已经初始化成功,但是尚未分析文件系统或者文件系统不支持 */
#define DISK_READY				0x10	/* 已经分析磁盘的文件系统并且能够支持 */
#define DISK_OPEN_ROOT			0x12	/* 已经打开根目录,扇区模式,只能以扇区为单位读写目录的内容,使用后必须关闭,注意FAT12/FAT16根目录是固定长度 */
#define DISK_OPEN_DIR			0x13	/* 已经打开子目录,扇区模式,只能以扇区为单位读写目录的内容 */
#define DISK_OPEN_FILE			0x14	/* 已经打开文件,扇区模式,可以以扇区为单位进行数据读写 */
#define DISK_OPEN_FILE_B		0x15	/* 已经打开文件,字节模式,可以以字节为单位进行数据读写 */

/* ********************************************************************************************************************* */
/* FAT类型标志,适用于CMD_PARAM.Query.mDiskFat */
#define DISK_FS_UNKNOWN			0		/* 未知的文件系统 */
#define DISK_FAT12				1		/* FAT12文件系统 */
#define DISK_FAT16				2		/* FAT16文件系统 */
#define DISK_FAT32				3		/* FAT32文件系统 */

/* ********************************************************************************************************************* */
/* 文件属性,适用于CMD_PARAM.Modify.mFileAttr */
#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 ATTR_LONG_NAME			( ATTR_READ_ONLY | ATTR_HIDDEN | ATTR_SYSTEM | ATTR_VOLUME_ID )
/* 文件属性 unsigned char */
/* bit0 bit1 bit2 bit3 bit4 bit5 bit6 bit7 */
/*  只   隐   系   卷   目   存   未定义   */
/*  读   藏   统   标   录   档            */
/* 文件时间 unsigned short,适用于CMD_PARAM.Modify.mFileTime */
/* Time = (Hour<<11) + (Minute<<5) + (Second>>1) */
#define MAKE_FILE_TIME( h, m, s )	( (h<<11) + (m<<5) + (s>>1) )	/* 生成指定时分秒的文件时间数据 */
/* 文件日期 unsigned short,适用于CMD_PARAM.Modify.mFileDate */
/* Date = ((Year-1980)<<9) + (Month<<5) + Day */
#define MAKE_FILE_DATE( y, m, d )	( ((y-1980)<<9) + (m<<5) + d )	/* 生成指定年月日的文件日期数据 */

/* ********************************************************************************************************************* */
/* 文件名,适用于CMD_PARAM.?.mPathName */
#define PATH_WILDCARD_CHAR		0x2A	/* 路径名的通配符 '*' */
#define PATH_SEPAR_CHAR1		0x5C	/* 路径名的分隔符 '\' */
#define PATH_SEPAR_CHAR2		0x2F	/* 路径名的分隔符 '/' */
#ifndef MAX_PATH_LEN
#define MAX_PATH_LEN			65		/* 最大路径长度,含所有斜杠分隔符和小数点间隔符以及路径结束符00H,并口方式下最大值为62 */
#endif
#if		MAX_PATH_LEN		>	65
#undef	MAX_PATH_LEN
#define MAX_PATH_LEN			65
#endif
#ifndef MAX_BYTE_IO
#define MAX_BYTE_IO				( MAX_PATH_LEN - 1 )	/* 以字节为单位单次读写文件时的最大长度,超过该长度可以分多次读写,并口方式下最大值为61 */
#endif
#if		MAX_BYTE_IO			>	64
#undef	MAX_BYTE_IO
#define	MAX_BYTE_IO				64
#endif

/* ********************************************************************************************************************* */
/* 外部命令码 */
#define	CMD_QueryStatus			0x60	/* 查询当前模块的状态 */
#define	CMD_DiskQuery			0x61	/* 查询磁盘信息 */
#define	CMD_FileEnumer			0x63	/* 枚举文件,返回文件名 */
#define	CMD_FileOpen			0x64	/* 打开文件 */
#define	CMD_FileCreate			0x65	/* 新建文件并打开,如果文件已经存在则先删除后再新建 */
#define	CMD_FileErase			0x66	/* 删除文件并关闭 */
#define	CMD_FileClose			0x67	/* 关闭当前文件 */
#define	CMD_FileQuery			0x68	/* 查询当前文件的信息 */
#define	CMD_FileModify			0x69	/* 查询或者修改当前文件的信息 */
#define	CMD_FileLocate			0x6A	/* 移动当前文件指针 */
#define	CMD_FileRead			0x6B	/* 从当前文件读取数据 */
#define	CMD_FileWrite			0x6C	/* 向当前文件写入数据 */
#define	CMD_ByteLocate			0x7A	/* 以字节为单位移动当前文件指针 */
#define	CMD_ByteRead			0x7B	/* 以字节为单位从当前文件读取数据块 */
#define	CMD_ByteWrite			0x7C	/* 以字节为单位向当前文件写入数据块 */
#define	CMD_BulkOnlyCmd			0x70	/* 执行基于BulkOnly协议的命令 */
#define	CMD_DiskReady			0x71	/* 查询磁盘是否准备好 */
#define	CMD_DiskSize			0x72	/* 查询磁盘容量 */
#define	CMD_FileDirInfo			0x75	/* 存取当前已打开文件的目录信息 */
#define	CMD_DirCreate			0x76	/* 新建目录并打开,如果目录已经存在则直接打开 */
#define	CMD_FileReadLast		0x77	/* 从当前文件的尾部读取不足一个扇区长度的零碎数据 */
#define	CMD_SetFileSize			0x78	/* 修改模块系统内子程序库的文件长度变量 */
#define	CMD_StreamRead			0x7E	/* 数据流模式读文件,只支持串口,只支持文本 */
#define	CMD_StreamWrite			0x7F	/* 数据流模式写文件,只支持串口,只支持文本 */
/* USB设备方式命令码 */
#define	CMD_SetUsbId			0x12	/* USB设备模式: 设置USB设备的厂商VID和产品PID */
#define	CMD_SetUsbMode			0x15	/* USB设备模式: 设置USB主机/设备工作模式,只支持串口 */
#define	CMD_ReadUsbData			0x28	/* USB设备模式: 从模块的数据下传端点读取数据块 */
#define	CMD_WriteUsbData		0x2B	/* USB设备模式: 向模块的数据上传端点写入数据块 */
/* 辅助命令码 */
#define	CMD_GetVer				0x0A	/* 获取当前模块的版本号 */
#define	CMD_ResetInit			0x0B	/* 复位并重新初始化CH375以及模块 */
#define	CMD_BaudRate			0xA5	/* 设置串口通讯波特率 */
#define	CMD_SetupModule			0xA6	/* 设置模块配置 */
#define	CMD_DirectWrCmd			0xB9	/* 直接传递给CH375,写命令 */
#define	CMD_DirectRdDat			0xB5	/* 直接传递给CH375,读数据 */
#define	CMD_DirectWrDat			0xB6	/* 直接传递给CH375,写数据 */
#define	CMD_GetStringSN			0xA0	/* 获取产品序列号字符串 */

/* ********************************************************************************************************************* */
/* 外部命令参数 */
typedef union _CMD_PARAM {
	struct {
		unsigned char	mBuffer[ MAX_PATH_LEN ];
	} Other;
	struct {
		unsigned long	mDiskSizeSec;			/* 返回: 整个物理磁盘的总扇区数 */
		unsigned long	mTotalSector;			/* 返回: 当前逻辑盘的总扇区数 */
		unsigned long	mFreeSector;			/* 返回: 当前逻辑盘的剩余扇区数 */
		unsigned char	mDiskFat;				/* 返回: 当前逻辑盘的FAT类型 */
	} Query;									/* CMD_DiskQuery, 查询磁盘信息 */
	struct {
		unsigned char	mPathName[ MAX_PATH_LEN ];	/* 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名...,结束符00H], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILENAME.EXT",00H */
	} Open;										/* CMD_FileOpen, 打开文件 */
	struct {
		unsigned char	mPathName[ MAX_PATH_LEN ];	/* 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名(含通配符*)...,枚举序号], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILE*",00H */
	} Enumer;									/* CMD_FileEnumer, 枚举文件,返回文件名 */
	struct {
		unsigned char	mUpdateLen;				/* 输入参数: 是否允许更新长度: 0禁止,1允许 */
	} Close;									/* CMD_FileClose, 关闭当前文件 */
	struct {
		unsigned char	mPathName[ MAX_PATH_LEN ];	/* 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名...,结束符00H], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILENAME.EXT",00H */