index.html 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>lwIP: Overview</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20. <script type="text/javascript" src="search/searchdata.js"></script>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectalign" style="padding-left: 0.5em;">
  31. <div id="projectname">lwIP
  32. &#160;<span id="projectnumber">2.1.2</span>
  33. </div>
  34. <div id="projectbrief">Lightweight IP stack</div>
  35. </td>
  36. </tr>
  37. </tbody>
  38. </table>
  39. </div>
  40. <!-- end header part -->
  41. <!-- Generated by Doxygen 1.8.13 -->
  42. <script type="text/javascript">
  43. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  44. </script>
  45. <script type="text/javascript" src="menudata.js"></script>
  46. <script type="text/javascript" src="menu.js"></script>
  47. <script type="text/javascript">
  48. $(function() {
  49. initMenu('',true,false,'search.php','Search');
  50. $(document).ready(function() { init_search(); });
  51. });
  52. </script>
  53. <div id="main-nav"></div>
  54. </div><!-- top -->
  55. <div id="side-nav" class="ui-resizable side-nav-resizable">
  56. <div id="nav-tree">
  57. <div id="nav-tree-contents">
  58. <div id="nav-sync" class="sync"></div>
  59. </div>
  60. </div>
  61. <div id="splitbar" style="-moz-user-select:none;"
  62. class="ui-resizable-handle">
  63. </div>
  64. </div>
  65. <script type="text/javascript">
  66. $(document).ready(function(){initNavTree('index.html','');});
  67. </script>
  68. <div id="doc-content">
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. </div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div class="header">
  82. <div class="headertitle">
  83. <div class="title">Overview </div> </div>
  84. </div><!--header-->
  85. <div class="contents">
  86. <div class="textblock"><pre class="fragment">INTRODUCTION
  87. lwIP is a small independent implementation of the TCP/IP protocol suite.
  88. The focus of the lwIP TCP/IP implementation is to reduce the RAM usage
  89. while still having a full scale TCP. This making lwIP suitable for use
  90. in embedded systems with tens of kilobytes of free RAM and room for
  91. around 40 kilobytes of code ROM.
  92. lwIP was originally developed by Adam Dunkels at the Computer and Networks
  93. Architectures (CNA) lab at the Swedish Institute of Computer Science (SICS)
  94. and is now developed and maintained by a worldwide network of developers.
  95. FEATURES
  96. * IP (Internet Protocol, IPv4 and IPv6) including packet forwarding over
  97. multiple network interfaces
  98. * ICMP (Internet Control Message Protocol) for network maintenance and debugging
  99. * IGMP (Internet Group Management Protocol) for multicast traffic management
  100. * MLD (Multicast listener discovery for IPv6). Aims to be compliant with
  101. RFC 2710. No support for MLDv2
  102. * ND (Neighbor discovery and stateless address autoconfiguration for IPv6).
  103. Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862
  104. (Address autoconfiguration)
  105. * DHCP, AutoIP/APIPA (Zeroconf) and (stateless) DHCPv6
  106. * UDP (User Datagram Protocol) including experimental UDP-lite extensions
  107. * TCP (Transmission Control Protocol) with congestion control, RTT estimation
  108. fast recovery/fast retransmit and sending SACKs
  109. * raw/native API for enhanced performance
  110. * Optional Berkeley-like socket API
  111. * TLS: optional layered TCP ("altcp") for nearly transparent TLS for any
  112. TCP-based protocol (ported to mbedTLS) (see changelog for more info)
  113. * PPPoS and PPPoE (Point-to-point protocol over Serial/Ethernet)
  114. * DNS (Domain name resolver incl. mDNS)
  115. * 6LoWPAN (via IEEE 802.15.4, BLE or ZEP)
  116. APPLICATIONS
  117. * HTTP server with SSI and CGI (HTTPS via altcp)
  118. * SNMPv2c agent with MIB compiler (Simple Network Management Protocol), v3 via altcp
  119. * SNTP (Simple network time protocol)
  120. * NetBIOS name service responder
  121. * MDNS (Multicast DNS) responder
  122. * iPerf server implementation
  123. * MQTT client (TLS support via altcp)
  124. LICENSE
  125. lwIP is freely available under a BSD license.
  126. DEVELOPMENT
  127. lwIP has grown into an excellent TCP/IP stack for embedded devices,
  128. and developers using the stack often submit bug fixes, improvements,
  129. and additions to the stack to further increase its usefulness.
  130. Development of lwIP is hosted on Savannah, a central point for
  131. software development, maintenance and distribution. Everyone can
  132. help improve lwIP by use of Savannah's interface, Git and the
  133. mailing list. A core team of developers will commit changes to the
  134. Git source tree.
  135. The lwIP TCP/IP stack is maintained in the 'lwip' Git module and
  136. contributions (such as platform ports) are in the 'contrib' Git module.
  137. See doc/savannah.txt for details on Git server access for users and
  138. developers.
  139. The current Git trees are web-browsable:
  140. http://git.savannah.gnu.org/cgit/lwip.git
  141. http://git.savannah.gnu.org/cgit/lwip/lwip-contrib.git
  142. Submit patches and bugs via the lwIP project page:
  143. http://savannah.nongnu.org/projects/lwip/
  144. Continuous integration builds (GCC, clang):
  145. https://travis-ci.org/yarrick/lwip-merged
  146. DOCUMENTATION
  147. Self documentation of the source code is regularly extracted from the current
  148. Git sources and is available from this web page:
  149. http://www.nongnu.org/lwip/
  150. There is now a constantly growing wiki about lwIP at
  151. http://lwip.wikia.com/wiki/LwIP_Wiki
  152. Also, there are mailing lists you can subscribe at
  153. http://savannah.nongnu.org/mail/?group=lwip
  154. plus searchable archives:
  155. http://lists.nongnu.org/archive/html/lwip-users/
  156. http://lists.nongnu.org/archive/html/lwip-devel/
  157. lwIP was originally written by Adam Dunkels:
  158. http://dunkels.com/adam/
  159. Reading Adam's papers, the files in docs/, browsing the source code
  160. documentation and browsing the mailing list archives is a good way to
  161. become familiar with the design of lwIP.
  162. Adam Dunkels &lt;adam@sics.se&gt;
  163. Leon Woestenberg &lt;leon.woestenberg@gmx.net&gt;
  164. </pre> </div></div><!-- contents -->
  165. </div><!-- doc-content -->
  166. <!-- start footer part -->
  167. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  168. <ul>
  169. <li class="footer">Generated by
  170. <a href="http://www.doxygen.org/index.html">
  171. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  172. </ul>
  173. </div>
  174. </body>
  175. </html>