Ginkgo-USB-I2C适配器接口函数库使用手册-V2.0

GinkgoUSB-I2C适配器接口函数库使用手册V2.0纬图虚拟仪器GinkgoUSB-I2C适配器接口函数库使用手册V2.01设备类型定义............................................................................................................................-1-2错误码定义................................................................................................................................-2-3函数库中数据结构定义............................................................................................................-3-3.1VII_BOARD_INFO........................................................................................................-3-3.2VII_INIT_CONFIG.........................................................................................................-3-3.3VII_TIME_CONFIG.......................................................................................................-4-4接口函数说明............................................................................................................................-6-4.1设备操作相关函数........................................................................................................-6-4.1.1VII_ScanDevice.................................................................................................-6-4.1.2VII_OpenDevice.................................................................................................-6-4.1.3VII_ReadBoardInfo............................................................................................-7-4.1.4VII_CloseDevice................................................................................................-8-4.2USB-I2C相关函数........................................................................................................-9-4.2.1VII_InitI2C...........................................................................................................-9-4.2.2VII_TimeConfig................................................................................................-10-4.2.3VII_WriteBytes.................................................................................................-11-4.2.4VII_ReadBytes.................................................................................................-12-5接口函数使用流程.................................................................................................................-14-5.1USB-I2C函数使用流程..............................................................................................-14-纬图虚拟仪器GinkgoUSB-I2C适配器接口函数库使用手册V2.0-1-1设备类型定义各个适配器类型定义如下：设备名称设备类型号USB-I2C1USB-SPI2USB-CAN13USB-CAN24纬图虚拟仪器GinkgoUSB-I2C适配器接口函数库使用手册V2.0-2-2错误码定义GinkgoUSB-I2C适配器API函数执行返回代码定义：名称值描述ERR_SUCCESS0没有错误ERR_PARAMETER_NULL-1传入的指针为空指针ERR_INPUT_DATA_TOO_MUCH-2参数输入个数多于规定个数ERR_INPUT_DATA_TOO_LESS-3参数输入个数少于规定个数ERR_INPUT_DATA_ILLEGALITY-4参数传入格式与规定不符ERR_USB_WRITE_DATA-5USB写数据错误ERR_USB_READ_DATA-6USB读数据错误ERR_READ_NO_DATA-7请求读数据时返回没有数据ERR_OPEN_DEVICE-8打开设备失败ERR_CLOSE_DEVICE-9关闭设备失败ERR_EXECUTE_CMD-10设备执行命令失败ERR_SELECT_DEVICE-11选择设备失败ERR_DEVICE_OPENED-12设备已经打开ERR_DEVICE_NOTOPEN-13设备没有打开ERR_BUFFER_OVERFLOW-14缓冲区溢出ERR_DEVICE_NOTEXIST-15此设备不存在ERR_LOAD_KERNELDLL-16加载动态库失败ERR_CMD_FAILED-17执行命令失败ERR_BUFFER_CREATE-18内存不足纬图虚拟仪器GinkgoUSB-I2C适配器接口函数库使用手册V2.0-3-3函数库中数据结构定义3.1VII_BOARD_INFO描述VII_BOARD_INFO结构体包含GinkgoUSB-I2C系列适配器的设备信息，结构体将在VII_ReadBoardInfo函数中被填充。typedefstruct_VII_BOARD_INFO{uint8_tProductName[32];uint8_tFirmwareVersion[4];uint8_tHardwareVersion[4];uint8_tSerialNumber[12];}VII_BOARD_INFO,*PVII_BOARD_INFO;成员ProductName以‘\0’结尾的产品名称字符串，比如为“Ginkgo-I2C-Adapter”。FirmwareVersion适配器固件版本号，FirmwareVersion[3]为修正版本号，FirmwareVersion[2]为子版本号，FirmwareVersion[1]为主版本号，FirmwareVersion[0]保留。HardwareVersion适配器硬件版本号，HardwareVersion[3]为修正版本号，HardwareVersion[2]为子版本号，HardwareVersion[1]为主版本号，HardwareVersion[0]保留。SerialNumber适配器唯一序列号。3.2VII_INIT_CONFIG描述VII_INIT_CONFIG结构体定义了初始化I2C适配器的配置。结构体将在VII_InitI2C函数中被填充。typedefstruct_VII_INIT_CONFIG{uint8_tMasterMode;uint8_tControlMode;uint8_tAddrType;uint8_tSubAddrWidth;uint16_tAddr;uint32_tClockSpeed;}VII_INIT_CONFIG,*PVII_INIT_CONFIG;纬图虚拟仪器GinkgoUSB-I2C适配器接口函数库使用手册V2.0-4-成员MasterMode主从机模式选择，0时为从机（暂不支持），1时为主机。ControlMode控制模式选择，1为硬件控制，2为软件控制（程序控制GPIO模拟I2C时序），推荐使用硬件控制模式。AddrType从机地址模式，7为7-bit地址模式，10为10-bit地址模式（暂不支持）。SubAddrWidth子地址/寄存器地址宽度，0到4取值，若从机无子地址/寄存器地址则将其设置为0，有子地址/寄存器地址则根据实际器件设置。Addr本机地址，当适配器作为从机时候的地址，当适配器作为主机时无意义。ClockSpeedI2C总线时钟速度，单位为Hz，取值范围为1000到1200000。时钟速度设置应根据从机支持的时钟速度设置，否则会出现通信异常的情况。3.3VII_TIME_CONFIGtypedefstruct_VII_TIME_CONFIG{uint16_ttHD_STA;uint16_ttSU_STA;uint16_ttLOW;uint16_ttHIGH;uint16_ttSU_DAT;uint16_ttSU_STO;uint16_ttDH;uint16_ttDH_DAT;uint16_ttAA;uint16_ttR;uint16_ttF;uint16_ttBuf;uint8_ttACK[4];uint16_ttStart;uint16_ttStop;}VII_TIME_CONFIG,*PVII_TIME_CONFIG;成员tHD_STA起始信号保持时间，单位为微秒。tSU_STA纬图虚拟仪器GinkgoUSB-I2C适配器接口函数库使用手册V2.0-5-起始信号建立时间，单位为微秒。tLOW时钟低电平时间，单位为微秒，该参数影响时钟输出频率大小。tHIGH时钟高电平时间，单位为微秒，该参数影响时钟输出频率大小。tSU_DAT数据输入建立时间，单位为微秒。tSU_STO停止信号建立时间，单位为微秒。tDH数据输出保持时间，单位为微秒。tDH_DAT数据输入保持时间，单位为微秒。tAASCL变低至SDA数据输出及应答信号，单位为微秒。tRSDA及SCL上升时间，单位为微秒。tFSDA及SCL下降时间，单位为微秒。tBuf新的发送开始前总线空闲时间，单位为微秒。纬图虚拟仪器GinkgoUSB-I2C适配器接口函数库使用手册V2.0-6-4接口函数说明4.1设备操