def_8h.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  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: src/include/lwip/def.h File Reference</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('def_8h.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="summary">
  83. <a href="#define-members">Macros</a> &#124;
  84. <a href="#func-members">Functions</a> </div>
  85. <div class="headertitle">
  86. <div class="title">def.h File Reference</div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <div class="textblock"><code>#include &quot;<a class="el" href="arch_8h.html">lwip/arch.h</a>&quot;</code><br />
  90. <code>#include &quot;<a class="el" href="opt_8h.html">lwip/opt.h</a>&quot;</code><br />
  91. </div><table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  93. Macros</h2></td></tr>
  94. <tr class="memitem:acf56d3da92a0a7a8a62a617e793e948c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8h.html#acf56d3da92a0a7a8a62a617e793e948c">LWIP_MAKEU32</a>(a, b, c, d)</td></tr>
  95. <tr class="separator:acf56d3da92a0a7a8a62a617e793e948c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table><table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  98. Functions</h2></td></tr>
  99. <tr class="memitem:ac49eb25570806fb51c329d4f86302cc2"><td class="memItemLeft" align="right" valign="top">u16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8h.html#ac49eb25570806fb51c329d4f86302cc2">lwip_htons</a> (u16_t x)</td></tr>
  100. <tr class="separator:ac49eb25570806fb51c329d4f86302cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a95e391e860b519b4f4f5c4979c9c9a37"><td class="memItemLeft" align="right" valign="top">u32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8h.html#a95e391e860b519b4f4f5c4979c9c9a37">lwip_htonl</a> (u32_t x)</td></tr>
  102. <tr class="separator:a95e391e860b519b4f4f5c4979c9c9a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:gaf15b4fbaaae5bb7f6da4301f3f979284"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__nonstandard.html#gaf15b4fbaaae5bb7f6da4301f3f979284">lwip_itoa</a> (char *result, size_t bufsize, int number)</td></tr>
  104. <tr class="separator:gaf15b4fbaaae5bb7f6da4301f3f979284"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ga997dcc49451121d4ed755b33bc7bd26a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__nonstandard.html#ga997dcc49451121d4ed755b33bc7bd26a">lwip_strnicmp</a> (const char *str1, const char *str2, size_t len)</td></tr>
  106. <tr class="separator:ga997dcc49451121d4ed755b33bc7bd26a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ga263cbafcb697eff964139a9998a6668a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__nonstandard.html#ga263cbafcb697eff964139a9998a6668a">lwip_stricmp</a> (const char *str1, const char *str2)</td></tr>
  108. <tr class="separator:ga263cbafcb697eff964139a9998a6668a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:gaeece028198cdaea2f0d2f1d691752c02"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__nonstandard.html#gaeece028198cdaea2f0d2f1d691752c02">lwip_strnstr</a> (const char *buffer, const char *token, size_t n)</td></tr>
  110. <tr class="separator:gaeece028198cdaea2f0d2f1d691752c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  113. <div class="textblock"><p>various utility macros </p>
  114. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  115. <a id="acf56d3da92a0a7a8a62a617e793e948c"></a>
  116. <h2 class="memtitle"><span class="permalink"><a href="#acf56d3da92a0a7a8a62a617e793e948c">&#9670;&nbsp;</a></span>LWIP_MAKEU32</h2>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">#define LWIP_MAKEU32</td>
  122. <td>(</td>
  123. <td class="paramtype">&#160;</td>
  124. <td class="paramname">a, </td>
  125. </tr>
  126. <tr>
  127. <td class="paramkey"></td>
  128. <td></td>
  129. <td class="paramtype">&#160;</td>
  130. <td class="paramname">b, </td>
  131. </tr>
  132. <tr>
  133. <td class="paramkey"></td>
  134. <td></td>
  135. <td class="paramtype">&#160;</td>
  136. <td class="paramname">c, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype">&#160;</td>
  142. <td class="paramname">d&#160;</td>
  143. </tr>
  144. <tr>
  145. <td></td>
  146. <td>)</td>
  147. <td></td><td></td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <b>Value:</b><div class="fragment"><div class="line">(((u32_t)((a) &amp; 0xff) &lt;&lt; 24) | \</div><div class="line"> ((u32_t)((b) &amp; 0xff) &lt;&lt; 16) | \</div><div class="line"> ((u32_t)((c) &amp; 0xff) &lt;&lt; 8) | \</div><div class="line"> (u32_t)((d) &amp; 0xff))</div></div><!-- fragment --><p>Create u32_t value from bytes </p>
  152. </div>
  153. </div>
  154. <h2 class="groupheader">Function Documentation</h2>
  155. <a id="a95e391e860b519b4f4f5c4979c9c9a37"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#a95e391e860b519b4f4f5c4979c9c9a37">&#9670;&nbsp;</a></span>lwip_htonl()</h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">u32_t lwip_htonl </td>
  162. <td>(</td>
  163. <td class="paramtype">u32_t&#160;</td>
  164. <td class="paramname"><em>n</em></td><td>)</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>Convert an u32_t from host- to network byte order.</p>
  170. <dl class="params"><dt>Parameters</dt><dd>
  171. <table class="params">
  172. <tr><td class="paramname">n</td><td>u32_t in host byte order </td></tr>
  173. </table>
  174. </dd>
  175. </dl>
  176. <dl class="section return"><dt>Returns</dt><dd>n in network byte order </dd></dl>
  177. </div>
  178. </div>
  179. <a id="ac49eb25570806fb51c329d4f86302cc2"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#ac49eb25570806fb51c329d4f86302cc2">&#9670;&nbsp;</a></span>lwip_htons()</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">u16_t lwip_htons </td>
  186. <td>(</td>
  187. <td class="paramtype">u16_t&#160;</td>
  188. <td class="paramname"><em>n</em></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Convert an u16_t from host- to network byte order.</p>
  194. <dl class="params"><dt>Parameters</dt><dd>
  195. <table class="params">
  196. <tr><td class="paramname">n</td><td>u16_t in host byte order </td></tr>
  197. </table>
  198. </dd>
  199. </dl>
  200. <dl class="section return"><dt>Returns</dt><dd>n in network byte order </dd></dl>
  201. </div>
  202. </div>
  203. </div><!-- contents -->
  204. </div><!-- doc-content -->
  205. <!-- start footer part -->
  206. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  207. <ul>
  208. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_4e6b3cf33a61b6caac9c8ac30c866f37.html">lwip</a></li><li class="navelem"><a class="el" href="def_8h.html">def.h</a></li>
  209. <li class="footer">Generated by
  210. <a href="http://www.doxygen.org/index.html">
  211. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  212. </ul>
  213. </div>
  214. </body>
  215. </html>