ch374hfb.h

CH374 USB-HOST文件系统单片机子程序库

		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;
		UINT8	mLbaCount;
		UINT8	mReserved5[5];
		PUINT8	mDataBuffer;			/* 输入参数: 缓冲区起始地址, 返回: 缓冲区当前地址 */
	} ReadX;							/* CMD_FileReadX, 从当前文件读取数据到指定缓冲区 */
	struct {
		UINT8	mSectorCount;			/* 输入参数: 写入扇区数, 返回: 实际写入扇区数 */
		UINT8	mReserved;
		UINT8	mLbaCount;
		UINT8	mReserved5[5];
		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则恢复变量,非0值则备份/保存变量 */
		UINT8	mReserved[3];
		PUINT8	mBuffer;				/* 输入参数: 指向子程序库的变量的备份缓冲区,长度不小于80个字节 */
	} SaveVariable;						/* CMD_SaveVariable, 备份/保存/恢复子程序库的变量 */
} CMD_PARAM;

typedef CMD_PARAM CMD_PARAM_I;
typedef CMD_PARAM *P_CMD_PARAM;

/* SCSI命令码 */
#define SPC_CMD_INQUIRY			0x12
#define SPC_CMD_READ_CAPACITY	0x25
#define SPC_CMD_READ10			0x28
#define SPC_CMD_WRITE10			0x2A
#define SPC_CMD_TEST_READY		0x00
#define SPC_CMD_REQUEST_SENSE	0x03
#define SPC_CMD_MODESENSE6		0x1A
#define SPC_CMD_MODESENSE10		0x5A
#define SPC_CMD_START_STOP		0x1B

/* BOC */
typedef union _BULK_ONLY_CMD {
	struct {
/*		UINT32	mCBW_Sig;*/
/*		UINT32	mCBW_Tag;*/
		UINT8	mCBW_DataLen0;			/* 输入: 数据传输长度,有效值是0到65535 */
		UINT8	mCBW_DataLen1;
		UINT16	mCBW_DataLen2;
		UINT8	mCBW_Flag;				/* 输入: 传输方向等标志 */
		UINT8	mCBW_LUN;
		UINT8	mCBW_CB_Len;			/* 输入: 命令块的长度,有效值是1到16 */
		UINT8	mCBW_CB_Buf[10];		/* 输入: 命令块,该缓冲区最多为16个字节 */
	} mCBW;								/* BulkOnly协议的命令块, 输入CBW结构 */
	struct {
		UINT32	mCSW_Sig;
		UINT32	mCSW_Tag;
		UINT32	mCSW_Residue;			/* 返回: 剩余数据长度 */
		UINT8	mCSW_Status;			/* 返回: 命令执行结果状态 */
		UINT8	mReserved;
	} mCSW;								/* BulkOnly协议的命令状态块, 输出CSW结构 */
} BULK_ONLY_CMD;						/* CMD_BulkOnlyCmd, 执行基于BulkOnly协议的命令, 如果有数据传输那么数据在pDISK_BASE_BUF中 */

typedef BULK_ONLY_CMD BULK_ONLY_CMD_X;

/* FILE: CH374HF?.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 EN_HUB_DISK				1
#define EN_SEC_SIZE_AUTO		1

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

/* 子程序库中提供的变量 */
extern UINT8V	CH374IntStatus;			/* CH374操作的中断状态 */
extern UINT8V	CH374DiskStatus;		/* 磁盘及文件状态 */
extern UINT8	CH374vDiskFat;			/* 逻辑盘的FAT标志:1=FAT12,2=FAT16,3=FAT32 */
extern UINT8	CH374vSecPerClus;		/* 逻辑盘的每簇扇区数 */
extern UINT32	CH374vStartCluster;		/* 当前文件或者目录的起始簇号 */
extern UINT32	CH374vFileSize;			/* 当前文件的长度 */
extern UINT32	CH374vCurrentOffset;	/* 当前文件指针,当前读写位置的字节偏移 */
extern UINT32	CH374vDiskRoot;			/* 对于FAT16盘为根目录占用扇区数,对于FAT32盘为根目录起始簇号 */
extern UINT32	CH374vDataStart;		/* 逻辑盘的数据区域的起始LBA */
extern UINT32	CH374vFdtLba;			/* 当前FDT所在的LBA地址 */
extern UINT16	CH374vFdtOffset;		/* 当前FDT在扇区内的偏移地址 */
extern UINT8	CH374vRetryCount;		/* 位7为1则NAK无限重试,为0则NAK不重试,位5为1则USB存储设备的子类为6,为0则子类为非6,位3至位0为出错重试次数 */
extern BOOL1	CH374vUsbPidIn;			/* 当前USB传输的PID是否为IN:1=是IN,0=是OUT或者SETUP */
extern UINT8	CH374vDevEndpTog;		/* USB存储设备的端点的数据同步标志:位7对应BIT_HOST_RECV_TOG,位6对应BIT_HOST_TRAN_TOG,位3必须为1,其它位必须为0 */
extern UINT8	CH374vCurrentLun;		/* USB存储设备的当前逻辑单元号 */
extern UINT8	CH374vDiskRetry;		/* USB存储设备读写失败后的重试计数,位7为1则启用磁盘存取的外部接口 */
#ifdef EN_HUB_DISK
extern UINT8	CH374vHubPortCount;		/* HUB上的端口数,为0则没有HUB */
extern UINT8	CH374vHubPortIndex;		/* HUB上的当前操作端口号,位7为0则自动查询,位1则指定端口号 */
#endif
#ifdef EN_SEC_SIZE_AUTO
extern UINT16	CH374vSectorSize;		/* 磁盘的扇区大小 */
#else
#define	CH374vSectorSize	512			/* 磁盘的扇区大小 */
#endif
extern PUINT8	pDISK_BASE_BUF;			/* 指向外部RAM的磁盘数据缓冲区,缓冲区长度不小于CH374vSectorSize,由应用程序初始化 */

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

/* 子程序库中提供的子程序 */
/* 下述子程序中, 文件操作子程序CH374File*和磁盘查询子程序CH374DiskQuery都可能会用到磁盘数据缓冲区pDISK_BASE_BUF,
   并且有可能在pDISK_BASE_BUF中保存了磁盘信息, 所以必须保证pDISK_BASE_BUF不被用于其它用途,
   如果RAM较少, 要将pDISK_BASE_BUF临时用于其它用途, 那么在临时用完后必须调用CH374DirtyBuffer清除磁盘缓冲区 */
extern UINT8	CH374GetVer( void );		/* 获取当前子程序库的版本号 */
extern UINT8	CH374Init( void );			/* 初始化CH374 */
extern void		CH374DelaymS( UINT8 iDelay );	/* 延时指定毫秒,不大于255毫秒 */
extern UINT8	CH374DiskConnect( void );	/* 检查磁盘是否连接并更新磁盘状态 */
extern UINT8	CH374DiskReady( void );		/* 查询磁盘是否准备好 */
extern void		CH374DirtyBuffer( void );	/* 清除磁盘缓冲区 */
extern UINT8	CH374FileOpen( void );		/* 打开文件或者枚举文件 */
extern UINT8	CH374FileClose( void );		/* 关闭当前文件 */
#ifdef EN_DISK_WRITE
extern UINT8	CH374FileErase( void );		/* 删除文件并关闭 */
extern UINT8	CH374FileCreate( void );	/* 新建文件并打开,如果文件已经存在则先删除后再新建 */
#endif
extern UINT8	CH374FileModify( void );	/* 查询或者修改当前文件的信息 */
extern UINT8	CH374FileLocate( void );	/* 移动当前文件指针 */
extern UINT8	CH374FileReadX( void );		/* 从当前文件读取数据到指定缓冲区 */
#ifdef EN_DISK_WRITE
extern UINT8	CH374FileWriteX( void );	/* 向当前文件写入指定缓冲区的数据 */
#endif
#ifdef EN_BYTE_ACCESS
extern UINT8	CH374ByteLocate( void );	/* 以字节为单位移动当前文件指针 */
extern UINT8	CH374ByteRead( void );		/* 以字节为单位从当前位置读取数据块 */
#ifdef EN_DISK_WRITE
extern UINT8	CH374ByteWrite( void );		/* 以字节为单位向当前位置写入数据块 */
#endif
#endif
extern UINT8	CH374DiskSize( void );		/* 查询磁盘容量 */
extern UINT8	CH374DiskQuery( void );		/* 查询磁盘信息 */
#ifdef EN_SAVE_VARIABLE
extern void		CH374SaveVariable( void );	/* 备份/保存/恢复子程序库的变量,用于子程序库在多个CH374芯片之间进行切换 */
#endif
extern UINT8	CH374BulkOnlyCmd( void );	/* 执行基于BulkOnly协议的命令 */
extern UINT8	CH374HostTransact( void );	/* 传输事务,需预先输入CH374UsbPidIn,PID令牌+目的端点地址,同步标志,返回同CH375(除USB_INT_SUCCESS为ERR_SUCCESS),NAK及出错重试 */
extern UINT8	CH374CtrlTransfer( void );	/* 执行控制传输,需预先写入8字节请求码,收发的数据在pDISK_BASE_BUF缓冲区 */

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

extern UINT8	CH374_READ_REGISTER( UINT8 mAddr );					/* 从指定寄存器读取数据 */
extern void		CH374_WRITE_REGISTER( UINT8 mAddr, UINT8 mData );	/* 向指定寄存器写入数据 */
extern void		CH374_READ_BLOCK( UINT8 mAddr, UINT8 mLen, PUINT8 mBuf );	/* 从指定起始地址读出数据块 */
extern void		CH374_WRITE_BLOCK( UINT8 mAddr, UINT8 mLen, PUINT8 mBuf );	/* 向指定起始地址写入数据块 */
extern PUINT8	CH374_READ_BLOCK64( UINT8 mAddr, PUINT8 mBuf );	/* 从双缓冲区读出64字节的数据块,返回当前地址 */
#ifdef EN_DISK_WRITE
extern PUINT8	CH374_WRITE_BLOCK64( UINT8 mAddr, PUINT8 mBuf );	/* 向双缓冲区写入64字节的数据块,返回当前地址 */
#endif
extern void		CH374_WRITE_BLOCK_C( UINT8 mLen, PUINT8 mBuf );	/* 向RAM_HOST_TRAN写入常量型数据块 */

extern CMD_PARAM_I mCmdParam;				/* 命令参数 */
extern BULK_ONLY_CMD_X mBOC;				/* BO协议的命令包 */
#if DISK_BASE_BUF_LEN
extern UINT8  DISK_BASE_BUF[ DISK_BASE_BUF_LEN ];	/* 外部RAM的磁盘数据缓冲区,缓冲区长度为一个扇区的长度,起始地址必须为2字节边界地址 */
#endif
#ifdef FILE_DATA_BUF_LEN
extern UINT8  FILE_DATA_BUF[ FILE_DATA_BUF_LEN ];	/* 外部RAM的文件数据缓冲区,缓冲区长度不小于一次读写的数据长度 */
extern UINT8	CH374FileRead( void );		/* 从当前文件读取数据 */
#ifdef EN_DISK_WRITE
extern UINT8	CH374FileWrite( void );		/* 向当前文件写入数据 */
#endif
#endif
#ifndef NO_DEFAULT_CH374_F_ENUM
extern UINT8	CH374FileEnumer( void );	/* 枚举文件 */