Part XLII. lwIP - the lightweight IP stack for eCosPro

Jonathan Larmour

eCosCentric Limited

Adam Dunkels

LWIP Documentation Notices

Table of Contents

155. lwIP overview
155.1. Introduction
155.2. lwIP sources and ports
155.3. External documentation
155.4. Licensing
156. Basic concepts
156.1. Structure
156.2. Application Programming Interfaces (APIs)
156.3. Protocol implementations
156.4. Packet data buffers
156.5. Configurability
156.6. Limitations
156.7. Quick Start
157. Port
157.1. Port status
157.2. Implementation
157.2.1. System Configuration
157.2.2. System Source
157.2.3. Threads
157.3. Extensions
157.4. eCos API reference
cyg_lwip_init — Initialise lwIP network stack
cyg_lwip_netif_print_info — Output network interface address information
cyg_net_eth_phy_ctx_acquire — Allocate PHY event context
cyg_net_eth_phy_dsr — Notify lwIP stack of PHY event
cyg_lwip_tick_to_msec — Convert eCos kernel clock ticks to millisecond count
cyg_lwip_msec_to_tick — Convert millisecond count to eCos kernel clock ticks
cyg_lwip_statistics — Statistics output
158. Configuration
158.1. Configuration Overview
158.2. Configuring the lwIP stack
158.3. Performance and Footprint Tuning
158.3.1. Performance
158.3.2. Optimizations
158.3.3. Memory Footprint
159. Sequential API
159.1. Overview
159.2. Comparison with BSD sockets
159.2.1. BSD API Restrictions
159.3. Netbufs
159.4. TCP/IP thread
159.5. Usage
159.5.1. API declarations
159.5.2. Types
159.6. API reference
netbuf_new() — Allocate a netbuf structure
netbuf_delete() — Deallocate a netbuf structure
netbuf_alloc() — Allocate space in a netbuf
netbuf_free() — Deallocate buffer memory associated with a netbuf
netbuf_ref() — Associate a data pointer with a netbuf
netbuf_len() — Obtain the total length of a netbuf
netbuf_data() — Obtain a pointer to netbuf data
netbuf_next() — Traverse internal fragments in a netbuf
netbuf_first() — Reset fragment pointer to start of netbuf
netbuf_copy() — Copy all netbuf data to memory pointer
netbuf_copy_partial() — Copy some netbuf data to memory pointer
netbuf_chain() — Chain two netbufs together
netbuf_fromaddr() — Obtain the sender's IPv4 address for a netbuf
netbuf_fromaddr_ip6() — Obtain the sender's IPv6 address for a netbuf
netbuf_fromport() — Obtain the sender's port number for a netbuf
netconn_new() — Create a new connection structure
netconn_new_with_callback() — Create a new connection structure with a callback
netconn_new_with_proto_and_callback() — Create a new connection structure with a callback for a specific protocol
netconn_delete() — Deallocate a netconn
netconn_type() — Obtain the type of netconn
netconn_peer() — Obtain the remote host IP address/port of a netconn
netconn_addr() — Obtain the local host IPv4 address/port of a netconn
netconn_bind() — Set local IP address/port of a netconn
netconn_bind_ip6() — Set local IPv6 address/port of a netconn
netconn_connect() — Connect netconn to remote peer
netconn_connect_ip6() — Connect netconn to remote peer
netconn_disconnect() — Disconnect UDP connection
netconn_listen() — Make a listening TCP netconn
netconn_accept() — Wait for incoming connections
netconn_recv() — Wait for data
netconn_recv_tcp_pbuf() — Wait for data
netconn_recved() — Update receive window
netconn_write() — Send data on TCP connection
netconn_send() — Send data on UDP connection
netconn_close() — Close a connection
netconn_shutdown() — Shutdown a connection
netconn_set_noautorecved() — Set the connection no-auto-recved state
netconn_get_noautorecved() — Get the connection no-auto-recved state
netconn_err() — Obtain connection error status
160. Raw API
160.1. Overview
160.2. Usage
160.3. Callbacks
tcp_arg() — Set the application connection state
160.4. TCP connection setup
tcp_new() — Create a new TCP PCB
tcp_bind() — Bind PCB to local IP address and port
tcp_listen() — Make PCB listen for incoming connections
tcp_accept() — Set callback used for new incoming connections
tcp_connect() — Open connection to remote host
160.5. Sending TCP data
tcp_write() — Enqueue data for transmission
tcp_sent() — Set callback for successful transmission
160.6. Receiving TCP data
tcp_recv() — Set callback for incoming data
tcp_recved() — Indicate receipt of data
160.7. Application polling
tcp_poll() — Set application poll callback
160.8. Closing connections, aborting connections and errors
tcp_close() — Close the connection
tcp_abort() — Abort the connection
tcp_err() — Set callback for errors
160.9. Lower layer TCP interface
160.10. UDP interface
udp_new() — Create a new UDP pcb
udp_remove() — Remove a UDP pcb
udp_bind() — Bind PCB to local IP address and port
udp_connect() — Set remote UDP peer
udp_disconnect() — Set remote UDP peer
udp_send() — Send UDP packet
udp_recv() — Set callback for incoming UDP data
160.11. System initialization
160.11.1. Initialization detail
161. Debug and Test
161.1. Debugging
161.1.1. Asserts
161.1.2. Memory Allocations
161.1.3. Statistics
161.1.4. GDB/RedBoot
161.1.5. Host Tools
161.2. Testing
161.2.1. lwipsnmp
161.2.2. lwipsntp
161.2.3. lwiperf
161.2.4. unitwrap
161.2.5. socket
161.2.6. tcpecho
161.2.7. udpecho
161.2.8. frag
161.2.9. nc_test_slave
161.2.10. httpd
161.2.11. httpd2
161.2.12. lookup
161.2.13. sys_timeout
161.2.14. lwiphttpd