C# TE_USB_FX2 API
reference manual
General Index
1 Introduction4
1.1 API Functions (First API Set)4
1.1.1 Synchronous Functions4
1.1.2 Timeout Setting5
1.1.3 BufferSize (also called XferSize)5
1.1.4 PacketSize6
1.2 MicroBlaze API Commands (Second API Set)6
2 Requirements7
3 API Functions8
3.1 TE_USB_FX2_ScanCards()9
3.1.1 Declaration9
3.1.2 Function Call9
3.1.3 Description9
3.1.4 Parameters9
3.1.5 Return Value9
3.2 TE_USB_FX2_Open()10
3.2.1 Declaration10
3.2.2 Function Call10
3.2.3 Description10
3.2.4 Parameters10
3.2.5 Return Value10
3.3 TE_USB_FX2_Close()11
3.3.1 Declaration11
3.3.2 Function Call11
3.3.3 Description11
3.3.4 Parameters12
3.3.5 Return Value12
3.4 TE_USB_FX2_SendCommand()13
3.4.1 Declaration13
3.4.2 Function Call13
3.4.3 Description13
3.4.4 Parameters13
3.4.5 Return Value14
3.5 TE_USB_FX2_GetData()15
3.5.1 Declaration15
3.5.2 Function Call15
3.5.3 Description15
3.5.4 Expected Data Throughput15
3.5.5 DataRead Size Shall Not Be Too Large15
3.5.5.1 Simplified sample code15
3.5.5.2 Actual sample code16
3.5.6 DataRead Size Shall Not Be Too Small16
3.5.7 Parameters17
3.5.8 Return Value17
3.6 TE_USB_FX2_SetData()19
3.6.1 Declaration19
3.6.2 Function Call19
3.6.3 Description19
3.6.4 Data throughput expected19
3.6.5 DataWrite size shall not be too large19
3.6.5.1 Simplified sample code19
3.6.5.2 Actual sample code20
3.6.6 DataWrite size shall not be too small20
3.6.7 Parameters20
3.6.8 Return Value21
4 API Commands22
4.1 Introduction22
4.1.1 Reference Architecture22
4.1.2 Custom Logic Block22
4.2 USB FX2 API Commands26
4.2.1 READ_VERSION26
4.2.2 INITIALIZE26
4.2.3 READ_STATUS26
4.2.4 RESET_FIFO27
4.2.5 FLASH_READ27
4.2.6 FLASH_WRITE27
4.2.7 FLASH_ERASE28
4.2.8 EEPROM_READ28
4.2.9 EEPROM_WRITE29
4.2.10 FIFO_STATUS29
4.2.11 I2C_WRITE29
4.2.12 I2C_READ30
4.2.13 POWER30
4.2.14 FLASH_WRITE_COMMAND30
4.2.15 SET_INTERRUPT31
4.2.16 GET_INTERRUPT31
4.3 MicroBlaze API Commands32
4.3.1 FX22MB_REG0_NOP33
4.3.2 FX22MB_REG0_GETVERSION33
4.3.2.1 Code Form33
4.3.2.2 Table Form33
4.3.3 FX22MB_REG0_START_TX35
4.3.3.1 Combination 1 (simplified version)35
4.3.3.2 Combination 2 (simplified version)36
4.3.4 FX22MB_REG0_START_RX37
4.3.4.1 Combination 1 (simplified version)37
4.3.4.2 Combination 2 (simplified version)37
4.3.5 FX22MB_REG0_STOP38
4.3.6 FX22MB_REG0_PING39
5 API Usage Example Program40
5.1 First Example: select module, read firmware version, read VID/PID40
5.2 Second Example: Read Test43
5.3 Third Example: Write Test43
6 TE_USB_FX2_CyUSB.dll: Data Transfer Throughput Optimization44
6.1 Introduction44
6.2 XferSize (driver buffer size) Influence44
6.3 PacketSize (transfer data size) Influence44
6.4 Conclusion45
6.5 Appendix : Charts46
7 Document Change History47
8 Bibliography47
Overview
Content Tools