Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

features/FEATURE_LWIP/lwip-interface/lwip/README@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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