ch375hm.inc

是关于C8051系列的各个模块的代码

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

CH375HM_VER			EQU		030H	; 当前模块版本 */

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

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

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

; ********************************************************************************************************************* */
; 文件属性,适用于CMD_PARAM.Modify.mFileAttr */
ATTR_READ_ONLY		EQU		001H	; 文件为只读属性 */
ATTR_HIDDEN			EQU		002H	; 文件为隐含属性 */
ATTR_SYSTEM			EQU		004H	; 文件为系统属性 */
ATTR_VOLUME_ID		EQU		008H	; 卷标 */
ATTR_DIRECTORY		EQU		010H	; 子目录 */
ATTR_ARCHIVE		EQU		020H	; 文件为存档属性 */
;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) */
; 文件日期 unsigned short,适用于CMD_PARAM.Modify.mFileDate */
; Date = ((Year-1980)<<9) + (Month<<5) + Day */

; ********************************************************************************************************************* */
; 文件名,适用于CMD_PARAM.?.mPathName */
PATH_WILDCARD_CHAR	EQU		02AH	; 路径名的通配符 '*' */
PATH_SEPAR_CHAR1	EQU		05CH	; 路径名的分隔符 '\' */
PATH_SEPAR_CHAR2	EQU		02FH	; 路径名的分隔符 '/' */
; MAX_PATH_LEN		EQU		65		; 最大路径长度,含所有斜杠分隔符和小数点间隔符以及路径结束符00H,并口方式下最大值为62 */
; MAX_BYTE_IO		EQU		64		; 以字节为单位单次读写文件时的最大长度,超过该长度可以分多次读写,并口方式下最大值为61 */

; ********************************************************************************************************************* */
; 外部命令码 */
CMD_QueryStatus		EQU		060H	; 查询当前模块的状态 */
CMD_DiskQuery		EQU		061H	; 查询磁盘信息 */
CMD_FileEnumer		EQU		063H	; 枚举文件,返回文件名 */
CMD_FileOpen		EQU		064H	; 打开文件 */
CMD_FileCreate		EQU		065H	; 新建文件并打开,如果文件已经存在则先删除后再新建 */
CMD_FileErase		EQU		066H	; 删除文件并关闭 */
CMD_FileClose		EQU		067H	; 关闭当前文件 */
CMD_FileQuery		EQU		068H	; 查询当前文件的信息 */
CMD_FileModify		EQU		069H	; 查询或者修改当前文件的信息 */
CMD_FileLocate		EQU		06AH	; 移动当前文件指针 */
CMD_FileRead		EQU		06BH	; 从当前文件读取数据 */
CMD_FileWrite		EQU		06CH	; 向当前文件写入数据 */
CMD_ByteLocate		EQU		07AH	; 以字节为单位移动当前文件指针 */
CMD_ByteRead		EQU		07BH	; 以字节为单位从当前文件读取数据块 */
CMD_ByteWrite		EQU		07CH	; 以字节为单位向当前文件写入数据块 */
CMD_BulkOnlyCmd		EQU		070H	; 执行基于BulkOnly协议的命令 */
CMD_DiskReady		EQU		071H	; 查询磁盘是否准备好 */
CMD_DiskSize		EQU		072H	; 查询磁盘容量 */
CMD_FileDirInfo		EQU		075H	; 存取当前已打开文件的目录信息 */
CMD_DirCreate		EQU		076H	; 新建目录并打开,如果目录已经存在则直接打开 */
CMD_FileReadLast	EQU		077H	; 从当前文件的尾部读取不足一个扇区长度的零碎数据 */
CMD_SetFileSize		EQU		078H	; 修改模块系统内子程序库的文件长度变量 */
CMD_StreamRead		EQU		07EH	; 数据流模式读文件,只支持串口,只支持文本 */
CMD_StreamWrite		EQU		07FH	; 数据流模式写文件,只支持串口,只支持文本 */
; USB设备方式命令码 */
CMD_SetUsbId		EQU		012H	; USB设备模式: 设置USB设备的厂商VID和产品PID */
CMD_SetUsbMode		EQU		015H	; USB设备模式: 设置USB主机/设备工作模式,只支持串口 */
CMD_ReadUsbData		EQU		028H	; USB设备模式: 从模块的数据下传端点读取数据块 */
CMD_WriteUsbData	EQU		02BH	; USB设备模式: 向模块的数据上传端点写入数据块 */
; 辅助命令码 */
CMD_GetVer			EQU		00AH	; 获取当前模块的版本号 */
CMD_ResetInit		EQU		00BH	; 复位并重新初始化CH375以及模块 */
CMD_BaudRate		EQU		0A5H	; 设置串口通讯波特率 */
CMD_SetupModule		EQU		0A6H	; 设置模块配置 */
CMD_DirectWrCmd		EQU		0B9H	; 直接传递给CH375,写命令 */
CMD_DirectRdDat		EQU		0B5H	; 直接传递给CH375,读数据 */
CMD_DirectWrDat		EQU		0B6H	; 直接传递给CH375,写数据 */
CMD_GetStringSN		EQU		0A0H	; 获取产品序列号字符串 */

; ********************************************************************************************************************* */
; 外部命令参数 */
;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 */
;	} Create;									; CMD_FileCreate, 新建文件并打开,如果文件已经存在则先删除后再新建 */
;	struct {
;		unsigned char	mPathName[ MAX_PATH_LEN ];	; 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名...,结束符00H], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILENAME.EXT",00H */
;	} Erase;									; CMD_FileErase, 删除文件并关闭 */
;	struct {
;		unsigned long	mFileSize;				; 输入参数: 新的文件长度,为0FFFFFFFFH则不修改, 返回: 原长度 */
;		unsigned short	mFileDate;				; 输入参数: 新的文件日期,为0FFFFH则不修改, 返回: 原日期 */