2003-04-03 09:37:41 +00:00
|
|
|
INTRODUCTION
|
|
|
|
|
|
2018-09-24 20:44:32 +00:00
|
|
|
lwIP is a small independent implementation of the TCP/IP protocol suite.
|
2002-10-20 15:13:14 +00:00
|
|
|
|
|
|
|
|
The focus of the lwIP TCP/IP implementation is to reduce the RAM usage
|
|
|
|
|
while still having a full scale TCP. This making lwIP suitable for use
|
2005-12-12 09:33:33 +00:00
|
|
|
in embedded systems with tens of kilobytes of free RAM and room for
|
2002-10-20 15:13:14 +00:00
|
|
|
around 40 kilobytes of code ROM.
|
|
|
|
|
|
2018-09-24 20:44:32 +00:00
|
|
|
lwIP was originally developed by Adam Dunkels at the Computer and Networks
|
|
|
|
|
Architectures (CNA) lab at the Swedish Institute of Computer Science (SICS)
|
|
|
|
|
and is now developed and maintained by a worldwide network of developers.
|
2016-07-27 17:09:52 +00:00
|
|
|
|
2003-04-03 09:37:41 +00:00
|
|
|
FEATURES
|
|
|
|
|
|
2016-07-27 17:09:52 +00:00
|
|
|
* IP (Internet Protocol, IPv4 and IPv6) including packet forwarding over
|
|
|
|
|
multiple network interfaces
|
2007-11-25 00:28:06 +00:00
|
|
|
* ICMP (Internet Control Message Protocol) for network maintenance and debugging
|
|
|
|
|
* IGMP (Internet Group Management Protocol) for multicast traffic management
|
2018-10-04 19:13:32 +00:00
|
|
|
* MLD (Multicast listener discovery for IPv6). Aims to be compliant with
|
2016-07-27 17:09:52 +00:00
|
|
|
RFC 2710. No support for MLDv2
|
|
|
|
|
* ND (Neighbor discovery and stateless address autoconfiguration for IPv6).
|
|
|
|
|
Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862
|
|
|
|
|
(Address autoconfiguration)
|
2018-10-04 19:13:32 +00:00
|
|
|
* DHCP, AutoIP/APIPA (Zeroconf), ACD (Address Conflict Detection)
|
|
|
|
|
and (stateless) DHCPv6
|
2007-11-25 00:28:06 +00:00
|
|
|
* UDP (User Datagram Protocol) including experimental UDP-lite extensions
|
|
|
|
|
* TCP (Transmission Control Protocol) with congestion control, RTT estimation
|
2018-09-16 19:17:40 +00:00
|
|
|
fast recovery/fast retransmit and sending SACKs
|
2016-07-27 17:09:52 +00:00
|
|
|
* raw/native API for enhanced performance
|
2007-11-25 00:28:06 +00:00
|
|
|
* Optional Berkeley-like socket API
|
2018-09-24 20:44:32 +00:00
|
|
|
* TLS: optional layered TCP ("altcp") for nearly transparent TLS for any
|
|
|
|
|
TCP-based protocol (ported to mbedTLS) (see changelog for more info)
|
2018-09-16 19:17:40 +00:00
|
|
|
* PPPoS and PPPoE (Point-to-point protocol over Serial/Ethernet)
|
|
|
|
|
* DNS (Domain name resolver incl. mDNS)
|
|
|
|
|
* 6LoWPAN (via IEEE 802.15.4, BLE or ZEP)
|
2016-07-27 17:09:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
APPLICATIONS
|
|
|
|
|
|
2018-09-16 19:17:40 +00:00
|
|
|
* HTTP server with SSI and CGI (HTTPS via altcp)
|
|
|
|
|
* SNMPv2c agent with MIB compiler (Simple Network Management Protocol), v3 via altcp
|
2016-07-27 17:09:52 +00:00
|
|
|
* SNTP (Simple network time protocol)
|
2016-08-14 13:39:58 +00:00
|
|
|
* NetBIOS name service responder
|
|
|
|
|
* MDNS (Multicast DNS) responder
|
|
|
|
|
* iPerf server implementation
|
2018-09-16 19:17:40 +00:00
|
|
|
* MQTT client (TLS support via altcp)
|
2016-07-27 17:09:52 +00:00
|
|
|
|
2002-10-20 15:13:14 +00:00
|
|
|
|
2003-04-03 09:37:41 +00:00
|
|
|
LICENSE
|
|
|
|
|
|
2002-10-20 15:13:14 +00:00
|
|
|
lwIP is freely available under a BSD license.
|
|
|
|
|
|
2016-07-27 17:09:52 +00:00
|
|
|
|
2003-04-03 09:37:41 +00:00
|
|
|
DEVELOPMENT
|
|
|
|
|
|
2002-10-20 15:13:14 +00:00
|
|
|
lwIP has grown into an excellent TCP/IP stack for embedded devices,
|
|
|
|
|
and developers using the stack often submit bug fixes, improvements,
|
|
|
|
|
and additions to the stack to further increase its usefulness.
|
|
|
|
|
|
|
|
|
|
Development of lwIP is hosted on Savannah, a central point for
|
2003-06-13 12:16:29 +00:00
|
|
|
software development, maintenance and distribution. Everyone can
|
2015-09-22 18:37:32 +00:00
|
|
|
help improve lwIP by use of Savannah's interface, Git and the
|
2003-06-13 12:16:29 +00:00
|
|
|
mailing list. A core team of developers will commit changes to the
|
2015-09-22 18:37:32 +00:00
|
|
|
Git source tree.
|
2002-10-20 15:13:14 +00:00
|
|
|
|
2020-06-06 16:49:08 +00:00
|
|
|
The lwIP TCP/IP stack is maintained in the 'src' directory and
|
|
|
|
|
contributions (such as platform ports and applications) are in
|
|
|
|
|
the 'contrib' directory.
|
2003-04-03 09:37:41 +00:00
|
|
|
|
2015-09-22 18:37:32 +00:00
|
|
|
See doc/savannah.txt for details on Git server access for users and
|
2005-12-12 09:35:34 +00:00
|
|
|
developers.
|
2003-04-03 09:37:41 +00:00
|
|
|
|
2020-06-06 16:49:08 +00:00
|
|
|
The current Git tree is web-browsable:
|
|
|
|
|
https://git.savannah.gnu.org/cgit/lwip.git
|
2002-10-20 15:24:36 +00:00
|
|
|
|
2002-10-20 15:13:14 +00:00
|
|
|
Submit patches and bugs via the lwIP project page:
|
2020-06-06 16:49:08 +00:00
|
|
|
https://savannah.nongnu.org/projects/lwip/
|
2003-04-03 09:37:41 +00:00
|
|
|
|
2020-06-07 11:58:53 +00:00
|
|
|
Continuous integration builds (GCC, clang):
|
|
|
|
|
https://travis-ci.org/lwip-tcpip/lwip
|
|
|
|
|
|
2002-10-20 15:13:14 +00:00
|
|
|
|
2016-07-27 17:09:52 +00:00
|
|
|
DOCUMENTATION
|
2002-10-20 15:13:14 +00:00
|
|
|
|
2016-07-27 17:09:52 +00:00
|
|
|
Self documentation of the source code is regularly extracted from the current
|
|
|
|
|
Git sources and is available from this web page:
|
2020-06-06 16:49:08 +00:00
|
|
|
https://www.nongnu.org/lwip/
|
2007-11-24 19:49:05 +00:00
|
|
|
|
|
|
|
|
Also, there are mailing lists you can subscribe at
|
2020-06-06 16:49:08 +00:00
|
|
|
https://savannah.nongnu.org/mail/?group=lwip
|
2007-11-24 19:49:05 +00:00
|
|
|
plus searchable archives:
|
2020-06-06 16:49:08 +00:00
|
|
|
https://lists.nongnu.org/archive/html/lwip-users/
|
|
|
|
|
https://lists.nongnu.org/archive/html/lwip-devel/
|
2003-04-03 09:37:41 +00:00
|
|
|
|
2018-10-17 18:26:25 +00:00
|
|
|
There is a wiki about lwIP at
|
2020-06-06 16:49:08 +00:00
|
|
|
https://lwip.wikia.com/wiki/LwIP_Wiki
|
2018-10-17 18:26:25 +00:00
|
|
|
You might get questions answered there, but unfortunately, it is not as
|
|
|
|
|
well maintained as it should be.
|
|
|
|
|
|
2016-07-27 17:09:52 +00:00
|
|
|
lwIP was originally written by Adam Dunkels:
|
|
|
|
|
http://dunkels.com/adam/
|
|
|
|
|
|
2003-04-03 09:37:41 +00:00
|
|
|
Reading Adam's papers, the files in docs/, browsing the source code
|
|
|
|
|
documentation and browsing the mailing list archives is a good way to
|
|
|
|
|
become familiar with the design of lwIP.
|
2002-10-20 15:13:14 +00:00
|
|
|
|
|
|
|
|
Adam Dunkels <adam@sics.se>
|
2007-11-25 00:28:06 +00:00
|
|
|
Leon Woestenberg <leon.woestenberg@gmx.net>
|
