Minor changes (documentation).

This commit is contained in:
fbernon 2007-11-25 00:28:06 +00:00
parent 3d9c76a69c
commit 9940b049ec
2 changed files with 26 additions and 13 deletions

29
README
View File

@ -12,16 +12,21 @@ around 40 kilobytes of code ROM.
FEATURES FEATURES
* IP (Internet Protocol) including packet forwarding over multiple * IP (Internet Protocol) including packet forwarding over multiple network
network interfaces interfaces
* ICMP (Internet Control Message Protocol) for network maintenance * ICMP (Internet Control Message Protocol) for network maintenance and debugging
and debugging * IGMP (Internet Group Management Protocol) for multicast traffic management
* UDP (User Datagram Protocol) including experimental UDP-lite * UDP (User Datagram Protocol) including experimental UDP-lite extensions
extensions * TCP (Transmission Control Protocol) with congestion control, RTT estimation
* TCP (Transmission Control Protocol) with congestion control, RTT and fast recovery/fast retransmit
estimation and fast recovery/fast retransmit * Specialized raw/native API for enhanced performance
* Specialized API for enhanced performance * Optional Berkeley-like socket API
* Optional Berkeley socket API * DNS (Domain names resolver)
* SNMP (Simple Network Management Protocol)
* DHCP (Dynamic Host Configuration Protocol)
* AUTOIP (for IPv4, conform with RFC 3927)
* PPP (Point-to-Point Protocol)
* ARP (Address Resolution Protocol) for Ethernet
LICENSE LICENSE
@ -65,7 +70,6 @@ lwIP are at the official lwIP home page:
Self documentation of the source code is regularly extracted from the Self documentation of the source code is regularly extracted from the
current CVS sources and is available from this web page: current CVS sources and is available from this web page:
http://www.nongnu.org/lwip/ http://www.nongnu.org/lwip/
[Unfortunately, this page is currently outdated!]
There is now a constantly growin wiki about lwIP at There is now a constantly growin wiki about lwIP at
http://lwip.scribblewiki.com/ http://lwip.scribblewiki.com/
@ -81,4 +85,5 @@ documentation and browsing the mailing list archives is a good way to
become familiar with the design of lwIP. become familiar with the design of lwIP.
Adam Dunkels <adam@sics.se> Adam Dunkels <adam@sics.se>
Leon Woestenberg <leon.woestenberg@gmx.net> Leon Woestenberg <leon.woestenberg@gmx.net>

View File

@ -498,7 +498,15 @@ ip_output_if(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
* Simple interface to ip_output_if. It finds the outgoing network * Simple interface to ip_output_if. It finds the outgoing network
* interface and calls upon ip_output_if to do the actual work. * interface and calls upon ip_output_if to do the actual work.
* *
* See ip_ouptut_if for parameter declaration. * @param p the packet to send (p->payload points to the data, e.g. next
protocol header; if dest == IP_HDRINCL, p already includes an IP
header and p->payload points to that IP header)
* @param src the source IP address to send from (if src == IP_ADDR_ANY, the
* IP address of the netif used to send is used as source address)
* @param dest the destination IP address to send the packet to
* @param ttl the TTL value to be set in the IP header
* @param tos the TOS value to be set in the IP header
* @param proto the PROTOCOL to be set in the IP header
* *
* @return ERR_RTE if no route is found * @return ERR_RTE if no route is found
* see ip_output_if() for more return values * see ip_output_if() for more return values