README

   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 tenths 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. A core team
  38 will improve lwIP by the use of Savannah's interface and CVS.
  39
  40 The lwIP TCP/IP stack is maintained in the 'lwip' CVS module and
  41 contributions (such as platform ports) are in the 'contrib' module.
  42
  43 The current lwIP CVS tree can be checked out by doing:
  44   cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip login
  45   cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip co lwip
  46
  47 The current contrib CVS tree can be checked out by doing:
  48   cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip login
  49   cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip co contrib
  50
  51 Last night's CVS tar ball can be downloaded from:
  52   http://savannah.gnu.org/cvs.backups/lwip.tar.gz
  53
  54 The current CVS trees are web-browsable:
  55   http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/lwip/
  56   http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/contrib/
  57
  58 Submit patches and bugs via the lwIP project page:
  59   http://savannah.nongnu.org/projects/lwip/
  60
  61 The main branch is the active development branch, whereas the 'STABLE'
  62 branch aims to be bug-free, without the latest changes. Keep track of
  63 the lwIP users mailing list for the statusses of both.
  64
  65 DOCUMENTATION
  66
  67 The original out-dated homepage of lwIP and Adam Dunkels' papers on
  68 lwIP are at the official lwIP home page:
  69   http://www.sics.se/~adam/lwip/
  70
  71 Self documentation of the source code is regularly extracted from the
  72 current CVS sources and is available from this web page:
  73   http://www.nongnu.org/lwip/
  74
  75 Reading Adam's papers, the files in docs/, browsing the source code
  76 documentation and browsing the mailing list archives is a good way to
  77 become familiar with the design of lwIP.
  78
  79 Adam Dunkels <adam@sics.se>
  80 Leon Woestenberg <leon.woestenberg@gmx.net>