ch375hf6.h

USB接口开发

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

extern CMD_PARAM_I mCmdParam;				/* 命令参数 */
extern UINT8XV CH375_CMD_PORT;				/* CH375命令端口的I/O地址 */
extern UINT8XV CH375_DAT_PORT;				/* CH375数据端口的I/O地址 */
#if DISK_BASE_BUF_LEN
extern UINT8X  DISK_BASE_BUF[ DISK_BASE_BUF_LEN ];	/* 外部RAM的磁盘数据缓冲区,缓冲区长度为一个扇区的长度 */
#endif
#ifdef FILE_DATA_BUF_LEN
extern UINT8X  FILE_DATA_BUF[ FILE_DATA_BUF_LEN ];	/* 外部RAM的文件数据缓冲区,缓冲区长度不小于一次读写的数据长度 */
extern UINT8	CH375FileRead( void );		/* 从当前文件读取数据 */
#ifdef EN_DISK_WRITE
extern UINT8	CH375FileWrite( void );		/* 向当前文件写入数据 */
#endif
#endif
#ifndef NO_DEFAULT_CH375_F_ENUM
extern UINT8	CH375FileEnumer( void );	/* 枚举文件 */
#endif
#ifndef NO_DEFAULT_CH375_F_QUERY
extern UINT8	CH375FileQuery( void );		/* 查询当前文件的信息 */
#endif
extern void xQueryInterrupt( void );		/* 外部定义的被CH375程序库调用的子程序,查询CH375中断并更新中断状态 */
extern void xDelay100uS( void );			/* 外部定义的被CH375程序库调用的子程序,延时100uS */
#ifdef EN_DISK_WRITE
extern void xDelayAfterWrite( void );		/* 外部定义的被CH375程序库调用的子程序,写操作后延时 */
#endif
extern void xFileNameEnumer( void );		/* 外部定义的被CH375程序库调用的子程序,文件名枚举回调子程序 */
extern UINT8 CH375LibInit( void );			/* 初始化CH375程序库和CH375芯片,操作成功返回0 */

#else

CMD_PARAM_I mCmdParam;					/* 命令参数 */

UINT8XV CH375_CMD_PORT _at_ CH375_CMD_PORT_ADDR;	/* CH375命令端口的I/O地址 */
UINT8XV CH375_DAT_PORT _at_ CH375_DAT_PORT_ADDR;	/* CH375数据端口的I/O地址 */
#if DISK_BASE_BUF_LEN
#ifdef DISK_BASE_BUF_ADDR
UINT8X  DISK_BASE_BUF[ DISK_BASE_BUF_LEN ] _at_ DISK_BASE_BUF_ADDR;	/* 外部RAM的磁盘数据缓冲区,缓冲区长度为一个扇区的长度 */
#else
UINT8X  DISK_BASE_BUF[ DISK_BASE_BUF_LEN ];	/* 外部RAM的磁盘数据缓冲区,缓冲区长度为一个扇区的长度 */
#endif
#endif
#ifdef FILE_DATA_BUF_LEN
#ifdef FILE_DATA_BUF_ADDR
UINT8X  FILE_DATA_BUF[ FILE_DATA_BUF_LEN ] _at_ FILE_DATA_BUF_ADDR;	/* 外部RAM的文件数据缓冲区,缓冲区长度不小于一次读写的数据长度 */
#else
UINT8X  FILE_DATA_BUF[ FILE_DATA_BUF_LEN ];	/* 外部RAM的文件数据缓冲区,缓冲区长度不小于一次读写的数据长度 */
#endif
UINT8	CH375FileRead( void )		/* 从当前文件读取数据 */
{
	mCmdParam.ReadX.mDataBuffer = &FILE_DATA_BUF[0];  /* 指向文件数据缓冲区 */
	return( CH375FileReadX( ) );
}
#ifdef EN_DISK_WRITE
UINT8	CH375FileWrite( void )		/* 向当前文件写入数据 */
{
	mCmdParam.WriteX.mDataBuffer = &FILE_DATA_BUF[0];  /* 指向文件数据缓冲区 */
	return( CH375FileWriteX( ) );
}
#endif
#endif

/* 以下程序可以根据需要修改 */

#ifndef NO_DEFAULT_CH375_F_ENUM			/* 在应用程序中定义NO_DEFAULT_CH375_F_ENUM可以禁止默认的枚举文件程序,然后用自行编写的程序代替它 */
UINT8	CH375FileEnumer( void )			/* 枚举文件 */
{
	UINT8	status;
	status = CH375FileOpen( );
	if ( status == ERR_FOUND_NAME ) status = ERR_SUCCESS;  /* 操作成功 */
	return( status );
}
#endif

#ifndef NO_DEFAULT_CH375_F_QUERY		/* 在应用程序中定义NO_DEFAULT_CH375_F_QUERY可以禁止默认的查询当前文件的信息程序,然后用自行编写的程序代替它 */
UINT8	CH375FileQuery( void )			/* 查询当前文件的信息 */
{
	PUINT8I	buf;
	UINT8	count;
	buf = (PUINT8I)( & mCmdParam.Modify.mFileSize );
	for ( count = sizeof( mCmdParam.Modify ); count != 0; count -- ) {
		*buf = 0xFF;  /* 输入参数全部无效,仅查询不修改 */
		buf ++;
	}
	return( CH375FileModify( ) );
}
#endif

#ifndef NO_DEFAULT_CH375_INT			/* 在应用程序中定义NO_DEFAULT_CH375_INT可以禁止默认的中断处理程序,然后用自行编写的程序代替它 */
#if LIB_CFG_INT_EN == 0					/* CH375的INT#引脚连接方式为"查询方式" */
void xQueryInterrupt( void )			/* 查询CH375中断并更新中断状态 */
{
#ifdef CH375_INT_WIRE  /* 查询中断引脚 */
	while ( CH375_INT_WIRE );  /* 如果CH375的中断引脚输出高电平则等待 */
#else  /* 对于CH375B芯片还可以查询命令端口的位7 */
	while ( CH375_CMD_PORT & 0x80 );  /* 查询CH375B的命令端口的位7为1说明中断引脚输出高电平则等待 */
#endif
	CH375_CMD_PORT = CMD_GET_STATUS;  /* 获取当前中断状态 */
	CH375IntStatus &= 0x80; if ( CH375IntStatus ) CH375IntStatus = 0;  /* 操作无意义,用于至少延时2uS */
	CH375IntStatus = CH375_DAT_PORT;  /* 获取中断状态 */
	if ( CH375IntStatus == USB_INT_DISCONNECT ) CH375DiskStatus = DISK_DISCONNECT;  /* 检测到USB设备断开事件 */
	else if ( CH375IntStatus == USB_INT_CONNECT ) CH375DiskStatus = DISK_CONNECT;  /* 检测到USB设备连接事件 */
}
#else									/* LIB_CFG_INT_EN != 0, CH375的INT#引脚连接方式为"中断方式" */
void xQueryInterrupt( void )			/* 查询中断状态,等待硬件中断 */
{
	while ( CH375IntStatus == 0 );		/* 子程序库调用该子程序之前CH375IntStatus=0,硬件中断后,由中断服务程序置为非0的实际中断状态后返回 */
}
void	CH375Interrupt( void ) interrupt CH375_INT_NO using 1	/* CH375中断服务程序,使用寄存器组1,由CH375的INT#的低电平或者下降沿触发单片机中断 */
{
	CH375_CMD_PORT = CMD_GET_STATUS;  /* 获取中断状态并取消中断请求 */
	CH375IntStatus &= 0x80; if ( CH375IntStatus ) CH375IntStatus = 0;  /* 操作无意义,用于至少延时2uS */
	CH375IntStatus = CH375_DAT_PORT;  /* 获取中断状态 */
	if ( CH375IntStatus == USB_INT_DISCONNECT ) CH375DiskStatus = DISK_DISCONNECT;  /* 检测到USB设备断开事件 */
	else if ( CH375IntStatus == USB_INT_CONNECT ) CH375DiskStatus = DISK_CONNECT;  /* 检测到USB设备连接事件 */
#ifdef CLEAR_INT_MARK
	CLEAR_INT_MARK( );  /* 某些单片机需要由软件清除中断标志 */
#endif
}
#endif
#endif

#ifndef NO_DEFAULT_DELAY_100US			/* 在应用程序中定义NO_DEFAULT_DELAY_100US可以禁止默认的延时100uS子程序,然后用自行编写的程序代替它 */
void xDelay100uS( void )				/* 延时100uS */
{
	UINT8	count;
	for ( count = 150; count != 0; count -- );  /* 延时100uS,2x333nS@36MHz&12T */
}
#endif

#ifdef EN_DISK_WRITE
#ifndef NO_DEFAULT_DELAY_WRITE			/* 在应用程序中定义NO_DEFAULT_DELAY_WRITE可以禁止默认的写操作后延时程序,然后用自行编写的程序代替它 */
void xDelayAfterWrite( void )			/* 写操作后延时 */
{
	UINT8	count;
	for ( count = 250; count != 0; count -- );  /* 延时200uS左右 */
}
#endif
#endif

#ifndef NO_DEFAULT_FILE_ENUMER			/* 在应用程序中定义NO_DEFAULT_FILE_ENUMER可以禁止默认的文件名枚举回调程序,然后用自行编写的程序代替它 */
void xFileNameEnumer( void )			/* 文件名枚举回调子程序 */
{
/* 如果指定枚举序号CH375vFileSize为0xFFFFFFFF后调用FileOpen，那么每搜索到一个文件FileOpen都会调用本回调程序，
   回调程序xFileNameEnumer返回后，FileOpen递减CH375vFileSize并继续枚举直到搜索不到文件或者目录。建议做法是，
   在调用FileOpen之前定义一个全局变量为0，当FileOpen回调本程序后，本程序由CH375vFdtOffset得到结构FAT_DIR_INFO，
   分析结构中的DIR_Attr以及DIR_Name判断是否为所需文件名或者目录名，记录相关信息，并将全局变量计数增量，
   当FileOpen返回后，判断返回值如果是ERR_MISS_FILE或ERR_FOUND_NAME都视为操作成功，全局变量为搜索到的有效文件数。
   如果在本回调程序xFileNameEnumer中将CH375vFileSize置为1，那么可以通知FileOpen提前结束搜索。以下是回调程序例子 */
#if 0
#ifdef FILE_DATA_BUF_LEN
	UINT8			i;
	UINT16			FileCount;
	P_FAT_DIR_INFO	pFileDir;
	PUINT8X			NameBuf;
	pFileDir = (P_FAT_DIR_INFO)( pDISK_BASE_BUF + CH375vFdtOffset );  /* 当前FDT的起始地址 */
	FileCount = (UINT16)( 0xFFFFFFFF - CH375vFileSize );  /* 当前文件名的枚举序号,CH375vFileSize初值是0xFFFFFFFF,找到文件名后递减 */
	if ( FileCount < FILE_DATA_BUF_LEN / 12 ) {  /* 检查缓冲区是否足够存放,假定每个文件名需占用12个字节存放 */
		NameBuf = & FILE_DATA_BUF[ FileCount * 12 ];  /* 计算保存当前文件名的缓冲区地址 */
		for ( i = 0; i < 11; i ++ ) NameBuf[ i ] = pFileDir -> DIR_Name[ i ];  /* 复制文件名,长度为11个字符,未处理空格 */
		if ( pFileDir -> DIR_Attr & ATTR_DIRECTORY ) NameBuf[ i ] = 1;  /* 判断是目录名 */
		NameBuf[ i ] = 0;  /* 文件名结束符 */
	}
#endif
#endif
}
#endif

#ifdef EXT_BLK_INTERFACE
#if LIB_CFG_FILE_IO == 0				/* 文件读写的数据的复制方式为"外部子程序" */
#ifdef LIB_CFG_FILE_IO_DEFAULT			/* 如果应用程序中定义该值则使用默认"外部子程序",否则应该自行编写程序代替 */
unsigned char xdata *current_buffer;	/* 保存文件数据读写时的缓冲区的当前指针,由应用程序在调用CH375FileReadX和CH375FileWriteX子程序前设置初值 */
void xWriteToExtBuf( UINT8 mLength )	/* 该子程序由CH375的子程序库调用,用于从CH375读取文件数据到外部缓冲区,被CH375FileReadX调用 */
{
/*	if ( (UINT16)current_buffer + mLength >= (UINT16)&FILE_DATA_BUF + sizeof( FILE_DATA_BUF ) ) return;*/  /* 防止缓冲区溢出 */
	if ( mLength ) {
		do {  /* 根据长度读取数据,实际上长度总是CH375_MAX_DATA_LEN,也就是64 */
			*current_buffer = CH375_DAT_PORT;  /* 读出数据并保存,可以用这种方式将文件数据保存到单片机的各种串行存储器中 */
			current_buffer ++;
		} while ( -- mLength );
	}  /* 复制上述数据的总时间不得超过2mS */
	else {  /* 重试,恢复缓冲区起址,如果将文件数据读写的缓冲区的当前指针放在mCmdParam.ReadX.mDataBuffer中则会被自动恢复,无需下面的两行程序 */
		current_buffer += (UINT16)mCmdParam.ReadX.mDataBuffer;  /* mDataBuffer中为负值 */
		mCmdParam.ReadX.mDataBuffer = 0;  /* 为了支持重试,在调用CH375FileReadX之前也应该清0 */
	}
}
#ifdef EN_DISK_WRITE
void xReadFromExtBuf( UINT8 mLength )	/* 该子程序由CH375的子程序库调用,用于从外部缓冲区读取文件数据到CH375,被CH375FileWriteX调用 */
{
	if ( mLength ) {
		do {  /* 根据长度写入数据,实际上长度总是CH375_MAX_DATA_LEN,也就是64 */
			CH375_DAT_PORT = *current_buffer;  /* 将数据写入,可以用这种方式从单片机的各种串行存储器中取出文件数据 */
			current_buffer ++;
		} while ( -- mLength );
	}  /* 复制上述数据的总时间不得超过2mS */
	else {  /* 重试,恢复缓冲区起址,如果将文件数据读写的缓冲区的当前指针放在mCmdParam.WriteX.mDataBuffer中则会被自动恢复,无需下面的两行程序 */
		current_buffer += (UINT16)mCmdParam.WriteX.mDataBuffer;  /* mDataBuffer中为负值 */
		mCmdParam.WriteX.mDataBuffer = 0;  /* 为了支持重试,在调用CH375FileWriteX之前也应该清0 */
	}
}
#endif
#endif
#else									/* LIB_CFG_FILE_IO != 0,文件读写的数据的复制方式不是"外部子程序" */
#ifdef FILE_DATA_BUF_LEN
void xWriteToExtBuf( UINT8 mLength )	/* 不会调用该子程序 */
{
	mLength --;  /* 该操作无意义,只是避免出现警告信息 */
}
#ifdef EN_DISK_WRITE
void xReadFromExtBuf( UINT8 mLength )	/* 不会调用该子程序 */
{
	mLength --;  /* 该操作无意义,只是避免出现警告信息 */
}
#endif
#endif
#endif
#endif

UINT8	CH375LibInit( void )  /* 初始化CH375程序库和CH375芯片,操作成功返回0 */
{
	if ( SP > 0xF0 ) return( 0xFC );  /* 单片机的堆栈空间不够,CH375子程序库最多可能有7级子程序,查询方式最多需要14字节的堆栈空间,建议提供余量 */
	CH375LibConfig = LIB_CFG_VALUE;  /* CH375程序库配置值 */
	if ( CH375GetVer( ) < CH375_LIB_VER ) return( 0xFF );  /* 获取当前子程序库的版本号,版本太低则返回错误 */
#if DISK_BASE_BUF_LEN
	pDISK_BASE_BUF = & DISK_BASE_BUF[0];  /* 指向外部RAM的磁盘数据缓冲区 */
#endif
	return( CH375Init( ) );  /* 初始化CH375 */
}

#endif

#ifdef __cplusplus
}
#endif

#endif