usbiox.h

USB2SPI开发包

	PULONG			ioLength );  // 指向长度单元,输入时为准备读取的长度,返回后为实际读取的长度


BOOL	WINAPI	USBIO_WriteData(  // 写出数据块
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	PVOID			iBuffer,  // 指向一个缓冲区,放置准备写出的数据
	PULONG			ioLength );  // 指向长度单元,输入时为准备写出的长度,返回后为实际写出的长度


PVOID	WINAPI	USBIO_GetDeviceName(  // 返回指向mUSBIO_PACKET_LENGTH设备名称的缓冲区,出错则返回NULL
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号,0对应第一个设备


ULONG	WINAPI	USBIO_GetVerIC(  // 获取USB2SPI芯片的版本,返回:0=设备无效,0x10=mUSBIO_PACKET_LENGTH,0x20=mUSBIO_PACKET_LENGTHA
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号


BOOL	WINAPI	USBIO_FlushBuffer(  // 清空mUSBIO_PACKET_LENGTH的缓冲区
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号


BOOL	WINAPI	USBIO_WriteRead(  // 执行数据流命令,先输出再输入
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iWriteLength,  // 写长度,准备写出的长度
	PVOID			iWriteBuffer,  // 指向一个缓冲区,放置准备写出的数据
	ULONG			iReadStep,  // 准备读取的单个块的长度, 准备读取的总长度为(iReadStep*iReadTimes)
	ULONG			iReadTimes,  // 准备读取的次数
	PULONG			oReadLength,  // 指向长度单元,返回后为实际读取的长度
	PVOID			oReadBuffer );  // 指向一个足够大的缓冲区,用于保存读取的数据


BOOL	WINAPI	USBIO_SetStream(  // 设置串口流模式
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iMode );  // 指定模式,见下行
// 位1-位0: I2C接口速度/SCL频率, 00=低速/20KHz,01=标准/100KHz(默认值),10=快速/400KHz,11=高速/750KHz
// 位2:     SPI的I/O数/IO引脚, 0=单入单出(D3时钟/D5出/D7入)(默认值),1=双入双出(D3时钟/D5出D4出/D7入D6入)
// 位7:     SPI字节中的位顺序, 0=低位在前, 1=高位在前
// 其它保留,必须为0


BOOL	WINAPI	USBIO_SetDelaymS(  // 设置硬件异步延时,调用后很快返回,而在下一个流操作之前延时指定毫秒数
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iDelay );  // 指定延时的毫秒数


BOOL	WINAPI	USBIO_GetInput(  // 通过mUSBIO_PACKET_LENGTH直接输入数据和状态,效率比mUSBIO_PACKET_LENGTHGetStatus更高
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	PULONG			iStatus );  // 指向一个双字单元,用于保存状态数据,参考下面的位说明
// 位7-位0对应mUSBIO_PACKET_LENGTH的D7-D0引脚
// 位8对应mUSBIO_PACKET_LENGTH的ERR#引脚, 位9对应mUSBIO_PACKET_LENGTH的PEMP引脚, 位10对应mUSBIO_PACKET_LENGTH的INT#引脚, 位11对应mUSBIO_PACKET_LENGTH的SLCT引脚, 位23对应mUSBIO_PACKET_LENGTH的SDA引脚
// 位13对应mUSBIO_PACKET_LENGTH的BUSY/WAIT#引脚, 位14对应mUSBIO_PACKET_LENGTH的AUTOFD#/DATAS#引脚,位15对应mUSBIO_PACKET_LENGTH的SLCTIN#/ADDRS#引脚


BOOL	WINAPI	USBIO_SetOutput(  // 设置mUSBIO_PACKET_LENGTH的I/O方向,并通过mUSBIO_PACKET_LENGTH直接输出数据
/* ***** 谨慎使用该API, 防止修改I/O方向使输入引脚变为输出引脚导致与其它输出引脚之间短路而损坏芯片 ***** */
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iEnable,  // 数据有效标志,参考下面的位说明
// 位0为1说明iSetDataOut的位15-位8有效,否则忽略
// 位1为1说明iSetDirOut的位15-位8有效,否则忽略
// 位2为1说明iSetDataOut的7-位0有效,否则忽略
// 位3为1说明iSetDirOut的位7-位0有效,否则忽略
// 位4为1说明iSetDataOut的位23-位16有效,否则忽略
	ULONG			iSetDirOut,  // 设置I/O方向,某位清0则对应引脚为输入,某位置1则对应引脚为输出,并口方式下默认值为0x000FC000,参考下面的位说明
	ULONG			iSetDataOut );  // 输出数据,如果I/O方向为输出,那么某位清0时对应引脚输出低电平,某位置1时对应引脚输出高电平,参考下面的位说明
// 位7-位0对应mUSBIO_PACKET_LENGTH的D7-D0引脚
// 位8对应mUSBIO_PACKET_LENGTH的ERR#引脚, 位9对应mUSBIO_PACKET_LENGTH的PEMP引脚, 位10对应mUSBIO_PACKET_LENGTH的INT#引脚, 位11对应mUSBIO_PACKET_LENGTH的SLCT引脚
// 位13对应mUSBIO_PACKET_LENGTH的WAIT#引脚, 位14对应mUSBIO_PACKET_LENGTH的DATAS#/READ#引脚,位15对应mUSBIO_PACKET_LENGTH的ADDRS#/ADDR/ALE引脚
// 以下引脚只能输出,不考虑I/O方向: 位16对应mUSBIO_PACKET_LENGTH的RESET#引脚, 位17对应mUSBIO_PACKET_LENGTH的WRITE#引脚, 位18对应mUSBIO_PACKET_LENGTH的SCL引脚, 位29对应mUSBIO_PACKET_LENGTH的SDA引脚


BOOL	WINAPI	USBIO_Set_D5_D0(  // 设置mUSBIO_PACKET_LENGTH的D5-D0引脚的I/O方向,并通过mUSBIO_PACKET_LENGTH的D5-D0引脚直接输出数据,效率比mUSBIO_PACKET_LENGTHSetOutput更高
/* ***** 谨慎使用该API, 防止修改I/O方向使输入引脚变为输出引脚导致与其它输出引脚之间短路而损坏芯片 ***** */
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iSetDirOut,  // 设置D5-D0各引脚的I/O方向,某位清0则对应引脚为输入,某位置1则对应引脚为输出,并口方式下默认值为0x00全部输入
	ULONG			iSetDataOut );  // 设置D5-D0各引脚的输出数据,如果I/O方向为输出,那么某位清0时对应引脚输出低电平,某位置1时对应引脚输出高电平
// 以上数据的位5-位0分别对应mUSBIO_PACKET_LENGTH的D5-D0引脚


BOOL	WINAPI	USBIO_StreamSPI3(  // 处理SPI数据流,3线接口,时钟线为DCK2/SCL引脚,数据线为DIO/SDA引脚(准双向I/O),片选线为D0/D1/D2,速度约51K字节
/* SPI时序: DCK2/SCL引脚为时钟输出, 默认为低电平, DIO/SDA引脚在时钟上升沿之前输出, DIO/SDA引脚在时钟下降沿之后输入 */
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iChipSelect,  // 片选控制, 位7为0则忽略片选控制, 位7为1则参数有效: 位1位0为00/01/10分别选择D0/D1/D2引脚作为低电平有效片选
	ULONG			iLength,  // 准备传输的数据字节数
	PVOID			ioBuffer );  // 指向一个缓冲区,放置准备从DIO写出的数据,返回后是从DIO读入的数据


BOOL	WINAPI	USBIO_StreamSPI4(  // 处理SPI数据流,4线接口,时钟线为DCK/D3引脚,输出数据线为DOUT/D5引脚,输入数据线为DIN/D7引脚,片选线为D0/D1/D2,速度约68K字节
/* SPI时序: DCK/D3引脚为时钟输出, 默认为低电平, DOUT/D5引脚在时钟上升沿之前输出, DIN/D7引脚在时钟下降沿之后输入 */
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iChipSelect,  // 片选控制, 位7为0则忽略片选控制, 位7为1则参数有效: 位1位0为00/01/10分别选择D0/D1/D2引脚作为低电平有效片选
	ULONG			iLength,  // 准备传输的数据字节数
	PVOID			ioBuffer );  // 指向一个缓冲区,放置准备从DOUT写出的数据,返回后是从DIN读入的数据


BOOL	WINAPI	USBIO_StreamSPI5(  // 处理SPI数据流,5线接口,时钟线为DCK/D3引脚,输出数据线为DOUT/D5和DOUT2/D4引脚,输入数据线为DIN/D7和DIN2/D6引脚,片选线为D0/D1/D2,速度约30K字节*2
/* SPI时序: DCK/D3引脚为时钟输出, 默认为低电平, DOUT/D5和DOUT2/D4引脚在时钟上升沿之前输出, DIN/D7和DIN2/D6引脚在时钟下降沿之后输入 */
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iChipSelect,  // 片选控制, 位7为0则忽略片选控制, 位7为1则参数有效: 位1位0为00/01/10分别选择D0/D1/D2引脚作为低电平有效片选
	ULONG			iLength,  // 准备传输的数据字节数
	PVOID			ioBuffer,  // 指向一个缓冲区,放置准备从DOUT写出的数据,返回后是从DIN读入的数据
	PVOID			ioBuffer2 );  // 指向第二个缓冲区,放置准备从DOUT2写出的数据,返回后是从DIN2读入的数据


BOOL	WINAPI	USBIO_BitStreamSPI(  // 处理SPI位数据流,4线/5线接口,时钟线为DCK/D3引脚,输出数据线为DOUT/DOUT2引脚,输入数据线为DIN/DIN2引脚,片选线为D0/D1/D2,速度约8K位*2
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号
	ULONG			iLength,  // 准备传输的数据位数,一次最多896,建议不超过256
	PVOID			ioBuffer );  // 指向一个缓冲区,放置准备从DOUT/DOUT2/D2-D0写出的数据,返回后是从DIN/DIN2读入的数据
/* SPI时序: DCK/D3引脚为时钟输出, 默认为低电平, DOUT/D5和DOUT2/D4引脚在时钟上升沿之前输出, DIN/D7和DIN2/D6引脚在时钟下降沿之后输入 */
/* ioBuffer中的一个字节共8位分别对应D7-D0引脚, 位5输出到DOUT, 位4输出到DOUT2, 位2-位0输出到D2-D0, 位7从DIN输入, 位6从DIN2输入, 位3数据忽略 */
/* 在调用该API之前,应该先调用mUSBIO_PACKET_LENGTHSet_D5_D0设置mUSBIO_PACKET_LENGTH的D5-D0引脚的I/O方向,并设置引脚的默认电平 */


BOOL	WINAPI	USBIO_SetBufUpload(  // 设定内部缓冲上传模式
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号,0对应第一个设备
	ULONG			iEnableOrClear );  // 为0则禁止内部缓冲上传模式,使用直接上传,非0则启用内部缓冲上传模式并清除缓冲区中的已有数据
// 如果启用内部缓冲上传模式,那么mUSBIO_PACKET_LENGTH驱动程序创建线程自动接收USB上传数据到内部缓冲区,同时清除缓冲区中的已有数据,当应用程序调用mUSBIO_PACKET_LENGTHReadData后将立即返回缓冲区中的已有数据


LONG	WINAPI	USBIO_QueryBufUpload(  // 查询内部上传缓冲区中的已有数据包个数,成功返回数据包个数,出错返回-1
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号,0对应第一个设备


BOOL	WINAPI	USBIO_SetBufDownload(  // 设定内部缓冲下传模式
	ULONG			iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号,0对应第一个设备
	ULONG			iEnableOrClear );  // 为0则禁止内部缓冲下传模式,使用直接下传,非0则启用内部缓冲下传模式并清除缓冲区中的已有数据
// 如果启用内部缓冲下传模式,那么当应用程序调用mUSBIO_PACKET_LENGTHWriteData后将仅仅是将USB下传数据放到内部缓冲区并立即返回,而由mUSBIO_PACKET_LENGTH驱动程序创建的线程自动发送直到完毕


LONG	WINAPI	USBIO_QueryBufDownload(  // 查询内部下传缓冲区中的剩余数据包个数(尚未发送),成功返回数据包个数,出错返回-1
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号,0对应第一个设备


BOOL	WINAPI	USBIO_ResetInter(  // 复位中断数据读操作
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号


BOOL	WINAPI	USBIO_ResetRead(  // 复位数据块读操作
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号


BOOL	WINAPI	USBIO_ResetWrite(  // 复位数据块写操作
	ULONG			iIndex );  // 指定mUSBIO_PACKET_LENGTH设备序号


typedef		VOID	( CALLBACK	* mPmUSBIO_PACKET_LENGTH_NOTIFY_ROUTINE ) (  // 设备事件通知回调程序
	ULONG			iEventStatus );  // 设备事件和当前状态(在下行定义): 0=设备拔出事件, 3=设备插入事件
/*
#define		mUSBIO_PACKET_LENGTH_DEVICE_ARRIVAL		3		// 设备插入事件,已经插入
#define		mUSBIO_PACKET_LENGTH_DEVICE_REMOVE_PEND	1		// 设备将要拔出
#define		mUSBIO_PACKET_LENGTH_DEVICE_REMOVE			0		// 设备拔出事件,已经拔出
*/
#define		USBIO_DEVICE_ARRIVAL		3		// 设备插入事件,已经插入
#define		USBIO_DEVICE_REMOVE_PEND	1		// 设备将要拔出
#define		USBIO_DEVICE_REMOVE			0		// 设备拔出事件,已经拔出


BOOL	WINAPI	USBIO_SetDeviceNotify(  // 设定设备事件通知程序
	ULONG					iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号,0对应第一个设备
	PCHAR					iDeviceID,  // 可选参数,指向字符串,指定被监控的设备的ID,字符串以\0终止
	mPmUSBIO_PACKET_LENGTH_NOTIFY_ROUTINE	iNotifyRoutine );  // 指定设备事件回调程序,为NULL则取消事件通知,否则在检测到事件时调用该程序


BOOL	WINAPI	USBIO_SetupSerial(  // 设定mUSBIO_PACKET_LENGTH的串口特性,该API只能用于工作于串口方式的USB2SPI芯片
	ULONG					iIndex,  // 指定mUSBIO_PACKET_LENGTH设备序号,0对应第一个设备
	ULONG					iParityMode,  // 指定mUSBIO_PACKET_LENGTH串口的数据校验模式: NOPARITY/ODDPARITY/EVENPARITY/MARKPARITY/SPACEPARITY
	ULONG					iBaudRate );  // 指定mUSBIO_PACKET_LENGTH串口的通讯波特率值,可以是50至3000000之间的任意值



#ifdef __cplusplus
}
#endif

#endif		// _mUSBIO_PACKET_LENGTH_DLL_H