ch375hfa.inc

CH3xx系列芯片和开发套件开发资料

; 以下状态代码0XH用于USB设备方式
;   内置固件模式下只需要处理: USB_INT_EP1_IN, USB_INT_EP2_OUT, USB_INT_EP2_IN, 对于CH372A/CH375A还需要处理: USB_INT_EP1_OUT
;   位7-位4为0000
;   位3-位2指示当前事务, 00=OUT, 10=IN, 11=SETUP
;   位1-位0指示当前端点, 00=端点0, 01=端点1, 10=端点2, 11=USB总线复位
USB_INT_EP0_SETUP	EQU     0CH							;USB端点0的SETUP
USB_INT_EP0_OUT		EQU     00H							;USB端点0的OUT
USB_INT_EP0_IN		EQU     08H							;USB端点0的IN
USB_INT_EP1_OUT		EQU     01H							;USB端点1的OUT
USB_INT_EP1_IN		EQU     09H							;USB端点1的IN
USB_INT_EP2_OUT		EQU     02H							;USB端点2的OUT
USB_INT_EP2_IN		EQU     0AH							;USB端点2的IN
;USB_INT_BUS_RESET	EQU     0000XX11B					;USB总线复位
USB_INT_BUS_RESET1	EQU     03H							;USB总线复位
USB_INT_BUS_RESET2	EQU     07H							;USB总线复位
USB_INT_BUS_RESET3	EQU     0BH							;USB总线复位
USB_INT_BUS_RESET4	EQU     0FH							;USB总线复位

; 以下状态代码2XH-3XH用于USB主机方式的通讯失败代码, 仅CH375/CH375A支持
;   位7-位6为00
;   位5为1
;   位4指示当前接收的数据包是否同步
;   位3-位0指示导致通讯失败时USB设备的应答: 0010=ACK, 1010=NAK, 1110=STALL, 0011=DATA0, 1011=DATA1, XX00=超时
;USB_INT_RET_ACK	EQU     001X0010B					;错误:对于IN事务返回ACK
;USB_INT_RET_NAK	EQU     001X1010B					;错误:返回NAK
;USB_INT_RET_STALL	EQU     001X1110B					;错误:返回STALL
;USB_INT_RET_DATA0	EQU     001X0011B					;错误:对于OUT/SETUP事务返回DATA0
;USB_INT_RET_DATA1	EQU     001X1011B					;错误:对于OUT/SETUP事务返回DATA1
;USB_INT_RET_TOUT	EQU     001XXX00B					;错误:返回超时
;USB_INT_RET_TOGX	EQU     0010X011B					;错误:对于IN事务返回数据不同步
;USB_INT_RET_PID	EQU     001XXXXXB					;错误:未定义

; 以下状态代码1XH用于USB主机方式的操作状态代码, 仅CH375/CH375A支持

USB_INT_SUCCESS		EQU     14H							;USB事务或者传输操作成功
USB_INT_CONNECT		EQU     15H							;检测到USB设备连接事件
USB_INT_DISCONNECT	EQU     16H							;检测到USB设备断开事件
USB_INT_BUF_OVER	EQU     17H							;USB控制传输的数据太多, 缓冲区溢出
USB_INT_DISK_READ	EQU     1DH							;USB存储器读数据块, 请求数据读出
USB_INT_DISK_WRITE	EQU     1EH							;USB存储器写数据块, 请求数据写入
USB_INT_DISK_ERR	EQU     1FH							;USB存储器操作失败

; *********************************************************************************************************************
; 返回的操作状态码 */
; 以下是中断状态码,适用于CH375IntStatus
; 以下是事件通知状态码,检测到当前U盘已经连接或者已经断开,可以作为最终状态码 */
ERR_USB_CONNECT		EQU		015H	; 检测到USB设备连接事件,磁盘已经连接 */
ERR_USB_DISCON		EQU		016H	; 检测到USB设备断开事件,磁盘已经断开 */
; 以下是阶段性的状态码,用于请求数据交换,不是最终的操作状态 */
;USB_INT_DISK_READ	EQU		01DH	; USB存储器读数据块,只用于CMD_FileRead命令,请求数据读出 */
;USB_INT_DISK_WRITE	EQU		01EH	; USB存储器写数据块,只用于CMD_FileWrite命令,请求数据写入 */
ERR_USB_DISK_ERR	EQU		01FH	; USB存储器操作失败,在初始化时可能是USB存储器不支持,在读写操作中可能是磁盘损坏或者已经断开 */
; 最终状态码 */
ERR_SUCCESS			EQU		000H	; 操作成功 */
ERR_CH375_ERROR		EQU		081H	; CH375硬件错误,可能需要复位CH375 */
ERR_DISK_DISCON		EQU		082H	; 检测到USB设备连接事件,磁盘已经断开,或者磁盘尚未连接 */
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	; 搜索到与通配符相匹配的文件名,文件名及其完整路径在命令缓冲区中,如果需要使用,应该打开该文件 */
; 其余错误代码未定义 */

; ********************************************************************************************************************* */
; 磁盘及文件状态,适用于CH375DiskStatus */
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	; 路径名的分隔符 '/' */
#ifndef MAX_PATH_LEN
MAX_PATH_LEN		EQU		30		; 最大路径长度,含所有斜杠分隔符和小数点间隔符以及路径结束符00H */
#endif
#ifndef MAX_BYTE_IO
MAX_BYTE_IO			EQU		( MAX_PATH_LEN - 1 )	; 以字节为单位单次读写文件时的最大长度,超过该长度可以分多次读写 */
#endif

; 外部命令参数结构, 用于在调用CH375程序库中的子程序时提供参数
;typedef union _CMD_PARAM {
;	struct {
;		UINT8	mBuffer[ MAX_PATH_LEN ];
;	} Other;
;	struct {
;		UINT32	mDiskSizeSec;			/* 返回: 整个物理磁盘的总扇区数 */
;		UINT32	mTotalSector;			/* 返回: 当前逻辑盘的总扇区数 */
;		UINT32	mFreeSector;			/* 返回: 当前逻辑盘的剩余扇区数 */
;		UINT8	mDiskFat;				/* 返回: 当前逻辑盘的FAT类型 */
;	} Query;							/* CMD_DiskQuery, 查询磁盘信息 */
;	struct {
;		UINT8	mPathName[ MAX_PATH_LEN ];	/* 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名...,结束符00H], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILENAME.EXT",00H */
;	} Open;								/* CMD_FileOpen, 打开文件 */
;	struct {
;		UINT8	mPathName[ MAX_PATH_LEN ];	/* 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名(含通配符*)...,枚举序号], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILE*",00H */
;	} Enumer;							/* CMD_FileEnumer, 枚举文件,返回文件名 */
;	struct {
;		UINT8	mUpdateLen;				/* 输入参数: 是否允许更新长度: 0禁止,1允许 */
;	} Close;							/* CMD_FileClose, 关闭当前文件 */
;	struct {
;		UINT8	mPathName[ MAX_PATH_LEN ];	/* 输入参数: 路径: [盘符,冒号,斜杠,目录名或者文件名及扩展名...,结束符00H], 其中盘符和冒号可以省略, 例如"C:\DIR1.EXT\DIR2\FILENAME.EXT",00H */
;	} 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];
;		PUINT8X	mDataBuffer;			/* 输入参数: 缓冲区起始地址, 返回: 缓冲区当前地址 */
;	} ReadX;							/* CMD_FileReadX, 从当前文件读取数据到指定缓冲区 */
;	struct {
;		UINT8	mSectorCount;			/* 输入参数: 写入扇区数, 返回: 实际写入扇区数 */
;		UINT8	mReserved[7];
;		PUINT8X	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则恢复变量,非0值则备份/保存变量 */
;		UINT8	mReserved[3];
;		PUINT8X	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协议的命令, 如果有数据传输那么数据在DISK_BASE_BUF中 */
;} CMD_PARAM;

#define EN_DISK_WRITE			1
#define EN_DISK_FAT12			1
#define EN_DISK_FAT32			1		;使用CH375HF4.LIB时请禁止该常量定义
#define EN_BYTE_ACCESS			1
#define EN_SAVE_VARIABLE		1
#define EXT_BLK_INTERFACE		1

; ********************************************************************************************************************* */
; 段定义
CH375LIB_CODE			SEGMENT		CODE
CH375LIB_IDATA			SEGMENT		XDATA

; ********************************************************************************************************************* */
; 子程序库中提供的变量 */