| Travis Geiselbrecht | 1d0df69 | 2008-09-01 02:26:09 -0700 | [diff] [blame^] | 1 | INTRODUCTION |
| 2 | |
| 3 | lwIP is a small independent implementation of the TCP/IP protocol |
| 4 | suite that has been developed by Adam Dunkels at the Computer and |
| 5 | Networks Architectures (CNA) lab at the Swedish Institute of Computer |
| 6 | Science (SICS). |
| 7 | |
| 8 | The focus of the lwIP TCP/IP implementation is to reduce the RAM usage |
| 9 | while still having a full scale TCP. This making lwIP suitable for use |
| 10 | in embedded systems with tens of kilobytes of free RAM and room for |
| 11 | around 40 kilobytes of code ROM. |
| 12 | |
| 13 | FEATURES |
| 14 | |
| 15 | * IP (Internet Protocol) including packet forwarding over multiple |
| 16 | network interfaces |
| 17 | * ICMP (Internet Control Message Protocol) for network maintenance |
| 18 | and debugging |
| 19 | * UDP (User Datagram Protocol) including experimental UDP-lite |
| 20 | extensions |
| 21 | * TCP (Transmission Control Protocol) with congestion control, RTT |
| 22 | estimation and fast recovery/fast retransmit |
| 23 | * Specialized API for enhanced performance |
| 24 | * Optional Berkeley socket API |
| 25 | |
| 26 | LICENSE |
| 27 | |
| 28 | lwIP is freely available under a BSD license. |
| 29 | |
| 30 | DEVELOPMENT |
| 31 | |
| 32 | lwIP has grown into an excellent TCP/IP stack for embedded devices, |
| 33 | and developers using the stack often submit bug fixes, improvements, |
| 34 | and additions to the stack to further increase its usefulness. |
| 35 | |
| 36 | Development of lwIP is hosted on Savannah, a central point for |
| 37 | software development, maintenance and distribution. Everyone can |
| 38 | help improve lwIP by use of Savannah's interface, CVS and the |
| 39 | mailing list. A core team of developers will commit changes to the |
| 40 | CVS source tree. |
| 41 | |
| 42 | The lwIP TCP/IP stack is maintained in the 'lwip' CVS module and |
| 43 | contributions (such as platform ports) are in the 'contrib' module. |
| 44 | |
| 45 | See doc/savannah.txt for details on CVS server access for users and |
| 46 | developers. |
| 47 | |
| 48 | Last night's CVS tar ball can be downloaded from: |
| 49 | http://savannah.gnu.org/cvs.backups/lwip.tar.gz [CHANGED - NEEDS FIXING] |
| 50 | |
| 51 | The current CVS trees are web-browsable: |
| 52 | http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/lwip/ |
| 53 | http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/contrib/ |
| 54 | |
| 55 | Submit patches and bugs via the lwIP project page: |
| 56 | http://savannah.nongnu.org/projects/lwip/ |
| 57 | |
| 58 | |
| 59 | DOCUMENTATION |
| 60 | |
| 61 | The original out-dated homepage of lwIP and Adam Dunkels' papers on |
| 62 | lwIP are at the official lwIP home page: |
| 63 | http://www.sics.se/~adam/lwip/ |
| 64 | |
| 65 | Self documentation of the source code is regularly extracted from the |
| 66 | current CVS sources and is available from this web page: |
| 67 | http://www.nongnu.org/lwip/ |
| 68 | |
| 69 | Reading Adam's papers, the files in docs/, browsing the source code |
| 70 | documentation and browsing the mailing list archives is a good way to |
| 71 | become familiar with the design of lwIP. |
| 72 | |
| 73 | Adam Dunkels <adam@sics.se> |
| 74 | Leon Woestenberg <leon.woestenberg@gmx.net> |