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 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 The CVS main trunk is the stable branch, which contains bug fixes and
  46 tested features. The latest stable branch can be checked out by doing:
  47   cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip login
  48   cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip co lwip
  49
  50 The 'STABLE' tag in the stable branch will represent the most stable
  51 revision (which may be somewhat older to protect us from errors
  52 introduced by merges). This 'STABLE' tagged version can be checked out
  53 by doing:
  54   cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip login
  55   cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip co -r STABLE lwip
  56
  57 The 'DEVEL' branch is the active development branch, which contains
  58 bleeding edge changes, and may be instable. It can be checkout by doing:
  59   cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip login
  60   cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip co -r DEVEL lwip
  61
  62 The current contrib CVS tree can be checked out by doing:
  63   cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip login
  64   cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip co contrib
  65
  66 Last night's CVS tar ball can be downloaded from:
  67   http://savannah.gnu.org/cvs.backups/lwip.tar.gz
  68
  69 The current CVS trees are web-browsable:
  70   http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/lwip/
  71   http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/contrib/
  72
  73 Submit patches and bugs via the lwIP project page:
  74   http://savannah.nongnu.org/projects/lwip/
  75
  76
  77 DOCUMENTATION
  78
  79 The original out-dated homepage of lwIP and Adam Dunkels' papers on
  80 lwIP are at the official lwIP home page:
  81   http://www.sics.se/~adam/lwip/
  82
  83 Self documentation of the source code is regularly extracted from the
  84 current CVS sources and is available from this web page:
  85   http://www.nongnu.org/lwip/
  86
  87 Reading Adam's papers, the files in docs/, browsing the source code
  88 documentation and browsing the mailing list archives is a good way to
  89 become familiar with the design of lwIP.
  90
  91 Adam Dunkels <adam@sics.se>
  92 Leon Woestenberg <leon.woestenberg@gmx.net>