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()10
3.1.1 Declaration10
3.1.2 Function Call10
3.1.3 Description10
3.1.4 Parameters10
3.1.5 Return Value10
3.2 TE_USB_FX2_Open()11
3.2.1 Declaration11
3.2.2 Function Call11
3.2.3 Description11
3.2.4 Parameters11
3.2.5 Return Value11
3.3 TE_USB_FX2_Close()13
3.3.1 Declaration13
3.3.2 Function Call13
3.3.3 Description13
3.3.4 Parameters13
3.3.5 Return Value13
3.4 TE_USB_FX2_SendCommand()14
3.4.1 Declaration14
3.4.2 Function Call14
3.4.3 Description14
3.4.4 Parameters14
3.4.5 Return Value15
3.5 TE_USB_FX2_GetData_InstanceDriverBuffer()16
3.5.1 Declaration16
3.5.2 Function Call16
3.5.3 Description16
3.5.4 Parameters17
3.5.5 Return Value18
3.6 TE_USB_FX2_GetData()19
3.6.1 Declaration19
3.6.2 Function Call19
3.6.3 Description19
3.6.4 Expected Data Throughput19
3.6.5 DataRead Size Shall Not Be Too Large19
3.6.6 DataRead Size Shall Not Be Too Small19
3.6.7 Parameters20
3.6.8 Return Value20
3.7 TE_USB_FX2_SetData_InstanceDriverBuffer()21
3.7.1 Declaration21
3.7.2 Function Call21
3.7.3 Description21
3.7.4 Parameters22
3.7.5 Return Value23
3.8 TE_USB_FX2_SetData()24
3.8.1 Declaration24
3.8.2 Function Call24
3.8.3 Description24
3.8.4 Expected Data Throughput24
3.8.5 DataWrite Shall Not Be Too Large24
3.8.6 DataWrite Shall Not Be Too Small24
3.8.7 Parameters25
3.8.8 Return Value25
4 API Commands26
4.1 Introduction26
4.1.1 Reference Architecture26
4.1.2 Custom Logic Block26
4.2 USB FX2 API Commands30
4.2.1 READ_VERSION30
4.2.2 INITIALIZE30
4.2.3 READ_STATUS30
4.2.4 RESET_FIFO31
4.2.5 FLASH_READ31
4.2.6 FLASH_WRITE31
4.2.7 FLASH_ERASE32
4.2.8 EEPROM_READ32
4.2.9 EEPROM_WRITE32
4.2.10 FIFO_STATUS33
4.2.11 I2C_WRITE33
4.2.12 I2C_READ34
4.2.13 POWER34
4.2.14 FLASH_WRITE_COMMAND34
4.2.15 SET_INTERRUPT35
4.2.16 GET_INTERRUPT35
4.3 MicroBlaze API Commands36
4.3.1 FX22MB_REG0_NOP36
4.3.2 FX22MB_REG0_GETVERSION37
4.3.2.1 Code Form37
4.3.2.2 Table Form37
4.3.3 FX22MB_REG0_START_TX39
4.3.3.1 Combination 1 (simplified version)39
4.3.3.2 Combination 2 (simplified version)40
4.3.4 FX22MB_REG0_START_RX41
4.3.4.1 Combination 1 (simplified version)42
4.3.4.2 Combination 2 (simplified version)43
4.3.5 FX22MB_REG0_STOP44
4.3.6 FX22MB_REG0_PING45
5 API usage example program46
5.1 First Example: select module, read firmware version, read VID/PID46
5.2 Second Example: Read Test48
5.3 Third Example: Write Test48
6 TE_USB_FX2_CyAPI.dll: Data Transfer Throughput Optimization49
6.1 Introduction49
6.2 XferSize (driver buffer size) Influence49
6.3 PacketSize (transfer data size) Influence 50
6.4 Conclusion50
6.5 Appendix : Charts51
7 Appendix A : Open the Visual Studio 2010 project52
8 Appendix B : use of pdb file (symbolic debugging)54
9 Document Change History55
10 Bibliography55
Overview
Content Tools