Maxim Integrated 78Q8430 ST 5100/OS-20 with NexGen TCP/IP Stack - Manual (Page 3)

UM_8430_005 78Q8430 Driver Manual for ST5100/OS-20 with NexGen TCP/IP Stack
Rev. 1.0 3
Table of Contents
1 Introduction ......................................................................................................................................... 5
2 System Requirements ........................................................................................................................ 6
2.1 Hardware Requirements............................................................................................................... 6
2.2 Software Requirements ................................................................................................................ 6
3 Device Driver Structure ...................................................................................................................... 7
3.1 Device Driver Files........................................................................................................................ 7
3.1.1 File Partitions ................................................................................................................... 7
3.1.2 File Directory Structure .................................................................................................... 7
3.2 ST/OS-20 Header Files ................................................................................................................ 8
3.3 Data Structures ............................................................................................................................. 8
3.3.1 NG_TSC_STRUCT.......................................................................................................... 8
T
3.3.2 NET_CONTROL_STRUCT ............................................................................................. 9
T
3.3.3 DEV_FUNCTIONS_STRUCT.......................................................................................... 9
3.3.4 DEVICE_CONTROL_STRUCT ....................................................................................... 9
3.4 Device Driver Options................................................................................................................. 11
4 ST IPSTB NexGen 78Q8430 Ethernet API....................................................................................... 13
4.1 STETHER_CopyData ().............................................................................................................. 13
4.2 STETHER_Close ()..................................................................................................................... 14
4.3 STETHER_Config () ................................................................................................................... 14
4.4 STETHER_Config_ARC ().......................................................................................................... 14
4.5 STETHER_HandleCompletedTXBuffers ()................................................................................. 15
4.6 STETHER_InterruptHandler ().................................................................................................... 16
4.7 STETHER_Open () ..................................................................................................................... 17
4.8 STETHER_Receive().................................................................................................................. 18
4.9 STETHER_Send () ..................................................................................................................... 18
4.10 STETHER_Start () ...................................................................................................................... 19
5 STi5100 IPSTB Platform Example ................................................................................................... 20
5.1 Setup........................................................................................................................................... 20
5.1.1 Host PC Environment .................................................................................................... 20
5.1.2 MPEG Video Server PC Environment ........................................................................... 21
5.1.3 ST Microconnect Target Configuration.......................................................................... 21
5.1.4 STi5100 IPSTB Configuration........................................................................................ 22
5.2 Build STi5100 IPSTB Code ........................................................................................................ 23
5.2.1 Location of Source Files ................................................................................................ 23
5.2.2 Build the Software.......................................................................................................... 23
5.3 Run the STi5100 IPSTB Example ............................................................................................. 24
6 Related Documentation.................................................................................................................... 25
7 Contact Information.......................................................................................................................... 25
Appendix A – Acronyms........................................................................................................................... 26
Appendix B – Release Notes ................................................................................................................... 27
Release Package Contents ................................................................................................................ 27
Software Build and Installation............................................................................................................ 27
Changes from Previous Release ........................................................................................................ 27
Known Problems ................................................................................................................................. 27