README 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. INTRODUCTION
  2. lwIP is a small independent implementation of the TCP/IP protocol
  3. suite that has been developed by Adam Dunkels at the Computer and
  4. Networks Architectures (CNA) lab at the Swedish Institute of Computer
  5. Science (SICS).
  6. The focus of the lwIP TCP/IP implementation is to reduce the RAM usage
  7. while still having a full scale TCP. This making lwIP suitable for use
  8. in embedded systems with tens of kilobytes of free RAM and room for
  9. around 40 kilobytes of code ROM.
  10. FEATURES
  11. * IP (Internet Protocol, IPv4 and IPv6) including packet forwarding over
  12. multiple network interfaces
  13. * ICMP (Internet Control Message Protocol) for network maintenance and debugging
  14. * IGMP (Internet Group Management Protocol) for multicast traffic management
  15. * MLD (Multicast listener discovery for IPv6). Aims to be compliant with
  16. RFC 2710. No support for MLDv2
  17. * ND (Neighbor discovery and stateless address autoconfiguration for IPv6).
  18. Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862
  19. (Address autoconfiguration)
  20. * UDP (User Datagram Protocol) including experimental UDP-lite extensions
  21. * TCP (Transmission Control Protocol) with congestion control, RTT estimation
  22. and fast recovery/fast retransmit
  23. * raw/native API for enhanced performance
  24. * Optional Berkeley-like socket API
  25. * DNS (Domain names resolver)
  26. APPLICATIONS
  27. * HTTP server with SSI and CGI
  28. * SNMPv2c agent with MIB compiler (Simple Network Management Protocol)
  29. * SNTP (Simple network time protocol)
  30. * NetBIOS name service responder
  31. * MDNS (Multicast DNS) responder
  32. * iPerf server implementation
  33. LICENSE
  34. lwIP is freely available under a BSD license.
  35. DEVELOPMENT
  36. lwIP has grown into an excellent TCP/IP stack for embedded devices,
  37. and developers using the stack often submit bug fixes, improvements,
  38. and additions to the stack to further increase its usefulness.
  39. Development of lwIP is hosted on Savannah, a central point for
  40. software development, maintenance and distribution. Everyone can
  41. help improve lwIP by use of Savannah's interface, Git and the
  42. mailing list. A core team of developers will commit changes to the
  43. Git source tree.
  44. The lwIP TCP/IP stack is maintained in the 'lwip' Git module and
  45. contributions (such as platform ports) are in the 'contrib' Git module.
  46. See doc/savannah.txt for details on Git server access for users and
  47. developers.
  48. The current Git trees are web-browsable:
  49. http://git.savannah.gnu.org/cgit/lwip.git
  50. http://git.savannah.gnu.org/cgit/lwip/lwip-contrib.git
  51. Submit patches and bugs via the lwIP project page:
  52. http://savannah.nongnu.org/projects/lwip/
  53. Continuous integration builds (GCC, clang):
  54. https://travis-ci.org/yarrick/lwip-merged
  55. DOCUMENTATION
  56. Self documentation of the source code is regularly extracted from the current
  57. Git sources and is available from this web page:
  58. http://www.nongnu.org/lwip/
  59. There is now a constantly growing wiki about lwIP at
  60. http://lwip.wikia.com/wiki/LwIP_Wiki
  61. Also, there are mailing lists you can subscribe at
  62. http://savannah.nongnu.org/mail/?group=lwip
  63. plus searchable archives:
  64. http://lists.nongnu.org/archive/html/lwip-users/
  65. http://lists.nongnu.org/archive/html/lwip-devel/
  66. lwIP was originally written by Adam Dunkels:
  67. http://dunkels.com/adam/
  68. Reading Adam's papers, the files in docs/, browsing the source code
  69. documentation and browsing the mailing list archives is a good way to
  70. become familiar with the design of lwIP.
  71. Adam Dunkels <[email protected]>
  72. Leon Woestenberg <[email protected]>