TI Network Developer's Kit (NDK) API Reference Guide Literature Number: SPRU524K May 2001–Revised October 2017 Contents Preface ........................................................................................................................................ 9 1 Introduction ....................................................................................................................... 11 1.1 What This Document Covers ............................................................................................. 12 1.2 Introduction.................................................................................................................. 12 1.3 Supplemental API Information............................................................................................ 13 2 Operating System Abstraction API ....................................................................................... 14 2.1 Operating System Configuration ......................................................................................... 15 2.1.1 Configuration Structure ........................................................................................... 15 2.2 Task Support................................................................................................................ 17 2.2.1 Function Overview ................................................................................................ 17 2.2.2 Task API Functions ............................................................................................... 18 2.3 Semaphore Support........................................................................................................ 22 2.3.1 Function Overview ................................................................................................ 22 2.3.2 Semaphore API Functions ....................................................................................... 22 2.4 Memory Allocation Support ............................................................................................... 25 2.4.1 Function Overview ................................................................................................ 25 2.4.2 Memory Allocation API Functions ............................................................................... 25 2.5 Print and Debug Support .................................................................................................. 26 2.5.1 Standard API Functions .......................................................................................... 26 2.5.2 Debug API Functions ............................................................................................. 27 2.6 File I/O Support for Embedded Systems................................................................................ 27 2.6.1 Function Overview ................................................................................................ 28 2.6.2 EFS Custom API Functions...................................................................................... 28 2.6.3 EFS Standard API Functions .................................................................................... 32 3 Sockets and Stream IO API.................................................................................................. 35 3.1 File Descriptor Environment .............................................................................................. 36 3.1.1 Organization ....................................................................................................... 36 3.1.2 Initializing the File System Environment ....................................................................... 36 3.1.2.1 When to Initialize the File Descriptor Environment ..................................................... 36 3.1.2.2 Auto-Initializing the File Descriptor Environment ....................................................... 37 3.2 File Descriptor Programming Interface .................................................................................. 38 3.2.1 Function Overview ................................................................................................ 38 3.2.2 File Descriptor API Functions.................................................................................... 38 3.2.3 File Descriptor Set (fd_set) Macros............................................................................. 44 3.3 Sockets Programming Interface .......................................................................................... 46 3.3.1 Enhanced No-Copy Socket Operation ......................................................................... 46 3.3.2 Function Overview ................................................................................................ 47 3.3.3 Sockets API Functions............................................................................................ 48 3.4 Raw Ethernet Sockets Programming Interface......................................................................... 66 3.4.1 Function Overview ................................................................................................ 66 3.4.2 Raw Ethernet Sockets API Functions .......................................................................... 66 3.5 Full Duplex Pipes Programming Interface .............................................................................. 74 3.5.1 Pipe API Functions................................................................................................ 75 3.6 Internet Group Management Protocol (IGMP).......................................................................... 75 2 Contents SPRU524K–May 2001–Revised October 2017 Submit Documentation Feedback Copyright © 2001–2017, Texas Instruments Incorporated www.ti.com 4 Configuration and Initialization ............................................................................................ 76 4.1 Configuration Methods..................................................................................................... 77 4.2 Configuration Manager API ............................................................................................... 77 4.2.1 Function Overview ................................................................................................ 78 4.2.2 Configuration API Functions ..................................................................................... 79 4.2.3 Configuration Entry API Functions .............................................................................. 89 4.3 Configuration Specification................................................................................................ 92 4.3.1 Organization ....................................................................................................... 92 4.3.2 Network Service Specification (CFGTAG_SERVICE)........................................................ 92 4.3.2.1 Service Types ............................................................................................... 93 4.3.2.2 Common Argument Structure ............................................................................. 93 4.3.2.3 Individual Configuration Entry Instance Structures ..................................................... 95 4.3.2.4 Specifying Network Services .............................................................................. 96 4.3.3 IP Network Specification (CFGTAG_IPNET) .................................................................. 99 4.3.4 IP Gateway Route Specification (CFGTAG_ROUTE) ...................................................... 100 4.3.5 Client Record Specification (CFGTAG_CLIENT)............................................................ 100 4.3.6 Client User Account (CFGTAG_ACCT)....................................................................... 101 4.3.7 System Information Specification (CFGTAG_SYSINFO)................................................... 102 4.3.8 Extended System Information Tags ........................................................................... 102 4.3.9 OS / IP Stack Configuration Item Specification (CFGTAG_OS, CFGTAG_IP).......................... 103 4.4 Initialization Procedure ................................................................................................... 105 4.5 Network Control Initialization Procedure (NETCTRL)................................................................ 105 4.5.1 Initialization Procedure .......................................................................................... 106 4.5.2 Function Overview ............................................................................................... 107 4.5.3 Network Control API Functions ................................................................................ 107 5 Network Tools Library - Support Functions ......................................................................... 110 5.1 Generic Support Calls.................................................................................................... 111 5.1.1 Function Overview ............................................................................................... 111 5.1.2 Network Tools Support API Functions ........................................................................ 111 5.2 DNS Support Calls........................................................................................................ 117 5.2.1 Function Overview ............................................................................................... 117 5.2.2 Standard Types and Definitions ..............................................................................