PageRenderTime 178ms CodeModel.GetById 32ms RepoModel.GetById 1ms app.codeStats 1ms

/a00424_source.html

https://github.com/krackeroda/contiki-doxygen
HTML | 2219 lines | 2218 code | 0 blank | 1 comment | 0 complexity | d591b6af58eb73b5e4887fbad96f1abd MD5 | raw file
  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. <title>Contiki 2.5: core/net/uip.h Source File</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.6.1 -->
  11. <div class="navigation" id="top">
  12. <div class="tabs">
  13. <ul>
  14. <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  15. <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16. <li><a href="modules.html"><span>Modules</span></a></li>
  17. <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  18. <li class="current"><a href="files.html"><span>Files</span></a></li>
  19. <li><a href="dirs.html"><span>Directories</span></a></li>
  20. <li><a href="examples.html"><span>Examples</span></a></li>
  21. </ul>
  22. </div>
  23. <div class="tabs">
  24. <ul>
  25. <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  26. <li><a href="globals.html"><span>Globals</span></a></li>
  27. </ul>
  28. </div>
  29. <div class="navpath"><a class="el" href="dir_783dcb2b4bcfa12326370fa26c216025.html">core</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_0966c75b31335e5cb5b37dbb7a80da85.html">net</a>
  30. </div>
  31. </div>
  32. <div class="contents">
  33. <h1>uip.h</h1><a href="a00424.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment"></span>
  34. <a name="l00002"></a>00002 <span class="comment">/**</span>
  35. <a name="l00003"></a>00003 <span class="comment"> * \addtogroup uip</span>
  36. <a name="l00004"></a>00004 <span class="comment"> * @{</span>
  37. <a name="l00005"></a>00005 <span class="comment"> */</span>
  38. <a name="l00006"></a>00006 <span class="comment"></span>
  39. <a name="l00007"></a>00007 <span class="comment">/**</span>
  40. <a name="l00008"></a>00008 <span class="comment"> * \file</span>
  41. <a name="l00009"></a>00009 <span class="comment"> * Header file for the uIP TCP/IP stack.</span>
  42. <a name="l00010"></a>00010 <span class="comment"> * \author Adam Dunkels &lt;adam@dunkels.com&gt;</span>
  43. <a name="l00011"></a>00011 <span class="comment"> * \author Julien Abeille &lt;jabeille@cisco.com&gt; (IPv6 related code)</span>
  44. <a name="l00012"></a>00012 <span class="comment"> * \author Mathilde Durvy &lt;mdurvy@cisco.com&gt; (IPv6 related code)</span>
  45. <a name="l00013"></a>00013 <span class="comment"> *</span>
  46. <a name="l00014"></a>00014 <span class="comment"> * The uIP TCP/IP stack header file contains definitions for a number</span>
  47. <a name="l00015"></a>00015 <span class="comment"> * of C macros that are used by uIP programs as well as internal uIP</span>
  48. <a name="l00016"></a>00016 <span class="comment"> * structures, TCP/IP header structures and function declarations.</span>
  49. <a name="l00017"></a>00017 <span class="comment"> *</span>
  50. <a name="l00018"></a>00018 <span class="comment"> */</span>
  51. <a name="l00019"></a>00019
  52. <a name="l00020"></a>00020 <span class="comment">/*</span>
  53. <a name="l00021"></a>00021 <span class="comment"> * Copyright (c) 2001-2003, Adam Dunkels.</span>
  54. <a name="l00022"></a>00022 <span class="comment"> * All rights reserved.</span>
  55. <a name="l00023"></a>00023 <span class="comment"> *</span>
  56. <a name="l00024"></a>00024 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
  57. <a name="l00025"></a>00025 <span class="comment"> * modification, are permitted provided that the following conditions</span>
  58. <a name="l00026"></a>00026 <span class="comment"> * are met:</span>
  59. <a name="l00027"></a>00027 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
  60. <a name="l00028"></a>00028 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span>
  61. <a name="l00029"></a>00029 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
  62. <a name="l00030"></a>00030 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span>
  63. <a name="l00031"></a>00031 <span class="comment"> * documentation and/or other materials provided with the distribution.</span>
  64. <a name="l00032"></a>00032 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span>
  65. <a name="l00033"></a>00033 <span class="comment"> * products derived from this software without specific prior</span>
  66. <a name="l00034"></a>00034 <span class="comment"> * written permission.</span>
  67. <a name="l00035"></a>00035 <span class="comment"> *</span>
  68. <a name="l00036"></a>00036 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS&apos;&apos; AND ANY EXPRESS</span>
  69. <a name="l00037"></a>00037 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span>
  70. <a name="l00038"></a>00038 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
  71. <a name="l00039"></a>00039 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span>
  72. <a name="l00040"></a>00040 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
  73. <a name="l00041"></a>00041 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span>
  74. <a name="l00042"></a>00042 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
  75. <a name="l00043"></a>00043 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span>
  76. <a name="l00044"></a>00044 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
  77. <a name="l00045"></a>00045 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
  78. <a name="l00046"></a>00046 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
  79. <a name="l00047"></a>00047 <span class="comment"> *</span>
  80. <a name="l00048"></a>00048 <span class="comment"> * This file is part of the uIP TCP/IP stack.</span>
  81. <a name="l00049"></a>00049 <span class="comment"> *</span>
  82. <a name="l00050"></a>00050 <span class="comment"> * $Id: uip.h,v 1.35 2010/10/19 18:29:04 adamdunkels Exp $</span>
  83. <a name="l00051"></a>00051 <span class="comment"> *</span>
  84. <a name="l00052"></a>00052 <span class="comment"> */</span>
  85. <a name="l00053"></a>00053
  86. <a name="l00054"></a>00054 <span class="preprocessor">#ifndef __UIP_H__</span>
  87. <a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#define __UIP_H__</span>
  88. <a name="l00056"></a>00056 <span class="preprocessor"></span>
  89. <a name="l00057"></a>00057 <span class="preprocessor">#include &quot;<a class="code" href="a00431.html" title="Configuration options for uIP.">net/uipopt.h</a>&quot;</span>
  90. <a name="l00058"></a>00058 <span class="comment"></span>
  91. <a name="l00059"></a>00059 <span class="comment">/**</span>
  92. <a name="l00060"></a>00060 <span class="comment"> * Representation of an IP address.</span>
  93. <a name="l00061"></a>00061 <span class="comment"> *</span>
  94. <a name="l00062"></a>00062 <span class="comment"> */</span>
  95. <a name="l00063"></a>00063 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  96. <a name="l00064"></a>00064 <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keyword">union </span>uip_ip6addr_t {
  97. <a name="l00065"></a>00065 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> u8[16]; <span class="comment">/* Initializer, must come first!!! */</span>
  98. <a name="l00066"></a>00066 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> u16[8];
  99. <a name="l00067"></a>00067 } uip_ip6addr_t;
  100. <a name="l00068"></a>00068
  101. <a name="l00069"></a>00069 <span class="keyword">typedef</span> uip_ip6addr_t <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a>;
  102. <a name="l00070"></a>00070 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  103. <a name="l00071"></a><a class="code" href="a00106.html">00071</a> <span class="keyword">typedef</span> <span class="keyword">union </span><a class="code" href="a00106.html" title="Representation of an IP address.">uip_ip4addr_t</a> {
  104. <a name="l00072"></a>00072 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> u8[4]; <span class="comment">/* Initializer, must come first!!! */</span>
  105. <a name="l00073"></a>00073 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> u16[2];
  106. <a name="l00074"></a>00074 <span class="preprocessor">#if 0</span>
  107. <a name="l00075"></a>00075 <span class="preprocessor"></span> <a class="code" href="a01668.html#ga4c14294869aceba3ef9d4c0c302d0f33" title="The 32-bit unsigned data type.">u32_t</a> u32;
  108. <a name="l00076"></a>00076 <span class="preprocessor">#endif</span>
  109. <a name="l00077"></a>00077 <span class="preprocessor"></span>} <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ip4addr_t</a>;
  110. <a name="l00078"></a>00078 <span class="keyword">typedef</span> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ip4addr_t</a> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a>;
  111. <a name="l00079"></a>00079 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  112. <a name="l00080"></a>00080
  113. <a name="l00081"></a>00081
  114. <a name="l00082"></a>00082 <span class="comment">/*---------------------------------------------------------------------------*/</span>
  115. <a name="l00083"></a>00083 <span class="comment"></span>
  116. <a name="l00084"></a>00084 <span class="comment">/** \brief 16 bit 802.15.4 address */</span>
  117. <a name="l00085"></a><a class="code" href="a00090.html">00085</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00090.html" title="16 bit 802.15.4 address">uip_802154_shortaddr</a> {
  118. <a name="l00086"></a>00086 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> addr[2];
  119. <a name="l00087"></a>00087 } <a class="code" href="a00090.html" title="16 bit 802.15.4 address">uip_802154_shortaddr</a>;<span class="comment"></span>
  120. <a name="l00088"></a>00088 <span class="comment">/** \brief 64 bit 802.15.4 address */</span>
  121. <a name="l00089"></a><a class="code" href="a00089.html">00089</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00089.html" title="64 bit 802.15.4 address">uip_802154_longaddr</a> {
  122. <a name="l00090"></a>00090 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> addr[8];
  123. <a name="l00091"></a>00091 } <a class="code" href="a00089.html" title="64 bit 802.15.4 address">uip_802154_longaddr</a>;
  124. <a name="l00092"></a>00092 <span class="comment"></span>
  125. <a name="l00093"></a>00093 <span class="comment">/** \brief 802.11 address */</span>
  126. <a name="l00094"></a><a class="code" href="a00088.html">00094</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00088.html" title="802.11 address">uip_80211_addr</a> {
  127. <a name="l00095"></a>00095 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> addr[6];
  128. <a name="l00096"></a>00096 } <a class="code" href="a00088.html" title="802.11 address">uip_80211_addr</a>;
  129. <a name="l00097"></a>00097 <span class="comment"></span>
  130. <a name="l00098"></a>00098 <span class="comment">/** \brief 802.3 address */</span>
  131. <a name="l00099"></a><a class="code" href="a00102.html">00099</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00102.html" title="802.3 address">uip_eth_addr</a> {
  132. <a name="l00100"></a>00100 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> addr[6];
  133. <a name="l00101"></a>00101 } <a class="code" href="a00102.html" title="802.3 address">uip_eth_addr</a>;
  134. <a name="l00102"></a>00102
  135. <a name="l00103"></a>00103
  136. <a name="l00104"></a>00104 <span class="preprocessor">#if UIP_CONF_LL_802154</span>
  137. <a name="l00105"></a>00105 <span class="preprocessor"></span><span class="comment">/** \brief 802.15.4 address */</span>
  138. <a name="l00106"></a>00106 <span class="keyword">typedef</span> <a class="code" href="a00089.html" title="64 bit 802.15.4 address">uip_802154_longaddr</a> <a class="code" href="a00102.html" title="802.3 address">uip_lladdr_t</a>;
  139. <a name="l00107"></a>00107 <span class="preprocessor">#define UIP_802154_SHORTADDR_LEN 2</span>
  140. <a name="l00108"></a>00108 <span class="preprocessor"></span><span class="preprocessor">#define UIP_802154_LONGADDR_LEN 8</span>
  141. <a name="l00109"></a>00109 <span class="preprocessor"></span><span class="preprocessor">#define UIP_LLADDR_LEN UIP_802154_LONGADDR_LEN</span>
  142. <a name="l00110"></a>00110 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/*UIP_CONF_LL_802154*/</span>
  143. <a name="l00111"></a>00111 <span class="preprocessor">#if UIP_CONF_LL_80211</span>
  144. <a name="l00112"></a>00112 <span class="preprocessor"></span><span class="comment">/** \brief 802.11 address */</span>
  145. <a name="l00113"></a>00113 <span class="keyword">typedef</span> <a class="code" href="a00088.html" title="802.11 address">uip_80211_addr</a> <a class="code" href="a00102.html" title="802.3 address">uip_lladdr_t</a>;
  146. <a name="l00114"></a>00114 <span class="preprocessor">#define UIP_LLADDR_LEN 6</span>
  147. <a name="l00115"></a>00115 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/*UIP_CONF_LL_80211*/</span>
  148. <a name="l00116"></a>00116 <span class="comment">/** \brief Ethernet address */</span>
  149. <a name="l00117"></a><a class="code" href="a01684.html#ga239a73d412e4d6ce81473305919856cc">00117</a> <span class="keyword">typedef</span> <a class="code" href="a00102.html" title="802.3 address">uip_eth_addr</a> <a class="code" href="a00102.html" title="802.3 address">uip_lladdr_t</a>;
  150. <a name="l00118"></a>00118 <span class="preprocessor">#define UIP_LLADDR_LEN 6</span>
  151. <a name="l00119"></a>00119 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/*UIP_CONF_LL_80211*/</span>
  152. <a name="l00120"></a>00120 <span class="preprocessor">#endif </span><span class="comment">/*UIP_CONF_LL_802154*/</span>
  153. <a name="l00121"></a>00121
  154. <a name="l00122"></a>00122 <span class="preprocessor">#include &quot;<a class="code" href="a00395.html" title="Header for the Contiki/uIP interface.">net/tcpip.h</a>&quot;</span>
  155. <a name="l00123"></a>00123
  156. <a name="l00124"></a>00124 <span class="comment">/*---------------------------------------------------------------------------*/</span>
  157. <a name="l00125"></a>00125 <span class="comment">/* First, the functions that should be called from the</span>
  158. <a name="l00126"></a>00126 <span class="comment"> * system. Initialization, the periodic timer, and incoming packets are</span>
  159. <a name="l00127"></a>00127 <span class="comment"> * handled by the following three functions.</span>
  160. <a name="l00128"></a>00128 <span class="comment"> */</span><span class="comment"></span>
  161. <a name="l00129"></a>00129 <span class="comment">/**</span>
  162. <a name="l00130"></a>00130 <span class="comment"> * \defgroup uipconffunc uIP configuration functions</span>
  163. <a name="l00131"></a>00131 <span class="comment"> * @{</span>
  164. <a name="l00132"></a>00132 <span class="comment"> *</span>
  165. <a name="l00133"></a>00133 <span class="comment"> * The uIP configuration functions are used for setting run-time</span>
  166. <a name="l00134"></a>00134 <span class="comment"> * parameters in uIP such as IP addresses.</span>
  167. <a name="l00135"></a>00135 <span class="comment"> */</span>
  168. <a name="l00136"></a>00136 <span class="comment"></span>
  169. <a name="l00137"></a>00137 <span class="comment">/**</span>
  170. <a name="l00138"></a>00138 <span class="comment"> * Set the IP address of this host.</span>
  171. <a name="l00139"></a>00139 <span class="comment"> *</span>
  172. <a name="l00140"></a>00140 <span class="comment"> * The IP address is represented as a 4-byte array where the first</span>
  173. <a name="l00141"></a>00141 <span class="comment"> * octet of the IP address is put in the first member of the 4-byte</span>
  174. <a name="l00142"></a>00142 <span class="comment"> * array.</span>
  175. <a name="l00143"></a>00143 <span class="comment"> *</span>
  176. <a name="l00144"></a>00144 <span class="comment"> * Example:</span>
  177. <a name="l00145"></a>00145 <span class="comment"> \code</span>
  178. <a name="l00146"></a>00146 <span class="comment"></span>
  179. <a name="l00147"></a>00147 <span class="comment"> uip_ipaddr_t addr;</span>
  180. <a name="l00148"></a>00148 <span class="comment"></span>
  181. <a name="l00149"></a>00149 <span class="comment"> uip_ipaddr(&amp;addr, 192,168,1,2);</span>
  182. <a name="l00150"></a>00150 <span class="comment"> uip_sethostaddr(&amp;addr);</span>
  183. <a name="l00151"></a>00151 <span class="comment"> </span>
  184. <a name="l00152"></a>00152 <span class="comment"> \endcode</span>
  185. <a name="l00153"></a>00153 <span class="comment"> * \param addr A pointer to an IP address of type uip_ipaddr_t;</span>
  186. <a name="l00154"></a>00154 <span class="comment"> *</span>
  187. <a name="l00155"></a>00155 <span class="comment"> * \sa uip_ipaddr()</span>
  188. <a name="l00156"></a>00156 <span class="comment"> *</span>
  189. <a name="l00157"></a>00157 <span class="comment"> * \hideinitializer</span>
  190. <a name="l00158"></a>00158 <span class="comment"> */</span>
  191. <a name="l00159"></a><a class="code" href="a01572.html#ga12b467f314489259dd718228d0827a51">00159</a> <span class="preprocessor">#define uip_sethostaddr(addr) uip_ipaddr_copy(&amp;uip_hostaddr, (addr))</span>
  192. <a name="l00160"></a>00160 <span class="preprocessor"></span><span class="comment"></span>
  193. <a name="l00161"></a>00161 <span class="comment">/**</span>
  194. <a name="l00162"></a>00162 <span class="comment"> * Get the IP address of this host.</span>
  195. <a name="l00163"></a>00163 <span class="comment"> *</span>
  196. <a name="l00164"></a>00164 <span class="comment"> * The IP address is represented as a 4-byte array where the first</span>
  197. <a name="l00165"></a>00165 <span class="comment"> * octet of the IP address is put in the first member of the 4-byte</span>
  198. <a name="l00166"></a>00166 <span class="comment"> * array.</span>
  199. <a name="l00167"></a>00167 <span class="comment"> *</span>
  200. <a name="l00168"></a>00168 <span class="comment"> * Example:</span>
  201. <a name="l00169"></a>00169 <span class="comment"> \code</span>
  202. <a name="l00170"></a>00170 <span class="comment"> uip_ipaddr_t hostaddr;</span>
  203. <a name="l00171"></a>00171 <span class="comment"></span>
  204. <a name="l00172"></a>00172 <span class="comment"> uip_gethostaddr(&amp;hostaddr);</span>
  205. <a name="l00173"></a>00173 <span class="comment"> \endcode</span>
  206. <a name="l00174"></a>00174 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
  207. <a name="l00175"></a>00175 <span class="comment"> * filled in with the currently configured IP address.</span>
  208. <a name="l00176"></a>00176 <span class="comment"> *</span>
  209. <a name="l00177"></a>00177 <span class="comment"> * \hideinitializer</span>
  210. <a name="l00178"></a>00178 <span class="comment"> */</span>
  211. <a name="l00179"></a><a class="code" href="a01572.html#ga20bc87e5c063c3f4b01547be6e5a0148">00179</a> <span class="preprocessor">#define uip_gethostaddr(addr) uip_ipaddr_copy((addr), &amp;uip_hostaddr)</span>
  212. <a name="l00180"></a>00180 <span class="preprocessor"></span><span class="comment"></span>
  213. <a name="l00181"></a>00181 <span class="comment">/**</span>
  214. <a name="l00182"></a>00182 <span class="comment"> * Set the default router&apos;s IP address.</span>
  215. <a name="l00183"></a>00183 <span class="comment"> *</span>
  216. <a name="l00184"></a>00184 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable containing the IP</span>
  217. <a name="l00185"></a>00185 <span class="comment"> * address of the default router.</span>
  218. <a name="l00186"></a>00186 <span class="comment"> *</span>
  219. <a name="l00187"></a>00187 <span class="comment"> * \sa uip_ipaddr()</span>
  220. <a name="l00188"></a>00188 <span class="comment"> *</span>
  221. <a name="l00189"></a>00189 <span class="comment"> * \hideinitializer</span>
  222. <a name="l00190"></a>00190 <span class="comment"> */</span>
  223. <a name="l00191"></a><a class="code" href="a01572.html#ga41d37ea1e3bd24f7b51e9409aceaaa80">00191</a> <span class="preprocessor">#define uip_setdraddr(addr) uip_ipaddr_copy(&amp;uip_draddr, (addr))</span>
  224. <a name="l00192"></a>00192 <span class="preprocessor"></span><span class="comment"></span>
  225. <a name="l00193"></a>00193 <span class="comment">/**</span>
  226. <a name="l00194"></a>00194 <span class="comment"> * Set the netmask.</span>
  227. <a name="l00195"></a>00195 <span class="comment"> *</span>
  228. <a name="l00196"></a>00196 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable containing the IP</span>
  229. <a name="l00197"></a>00197 <span class="comment"> * address of the netmask.</span>
  230. <a name="l00198"></a>00198 <span class="comment"> *</span>
  231. <a name="l00199"></a>00199 <span class="comment"> * \sa uip_ipaddr()</span>
  232. <a name="l00200"></a>00200 <span class="comment"> *</span>
  233. <a name="l00201"></a>00201 <span class="comment"> * \hideinitializer</span>
  234. <a name="l00202"></a>00202 <span class="comment"> */</span>
  235. <a name="l00203"></a><a class="code" href="a01572.html#gaeb79c914cf137e6d27fd7583e5a66679">00203</a> <span class="preprocessor">#define uip_setnetmask(addr) uip_ipaddr_copy(&amp;uip_netmask, (addr))</span>
  236. <a name="l00204"></a>00204 <span class="preprocessor"></span>
  237. <a name="l00205"></a>00205 <span class="comment"></span>
  238. <a name="l00206"></a>00206 <span class="comment">/**</span>
  239. <a name="l00207"></a>00207 <span class="comment"> * Get the default router&apos;s IP address.</span>
  240. <a name="l00208"></a>00208 <span class="comment"> *</span>
  241. <a name="l00209"></a>00209 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
  242. <a name="l00210"></a>00210 <span class="comment"> * filled in with the IP address of the default router.</span>
  243. <a name="l00211"></a>00211 <span class="comment"> *</span>
  244. <a name="l00212"></a>00212 <span class="comment"> * \hideinitializer</span>
  245. <a name="l00213"></a>00213 <span class="comment"> */</span>
  246. <a name="l00214"></a><a class="code" href="a01572.html#gad8e8bc9bc0e2ea4a24a8a024fd3a7f7c">00214</a> <span class="preprocessor">#define uip_getdraddr(addr) uip_ipaddr_copy((addr), &amp;uip_draddr)</span>
  247. <a name="l00215"></a>00215 <span class="preprocessor"></span><span class="comment"></span>
  248. <a name="l00216"></a>00216 <span class="comment">/**</span>
  249. <a name="l00217"></a>00217 <span class="comment"> * Get the netmask.</span>
  250. <a name="l00218"></a>00218 <span class="comment"> *</span>
  251. <a name="l00219"></a>00219 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
  252. <a name="l00220"></a>00220 <span class="comment"> * filled in with the value of the netmask.</span>
  253. <a name="l00221"></a>00221 <span class="comment"> *</span>
  254. <a name="l00222"></a>00222 <span class="comment"> * \hideinitializer</span>
  255. <a name="l00223"></a>00223 <span class="comment"> */</span>
  256. <a name="l00224"></a><a class="code" href="a01572.html#ga5323320b7316647042016f17c4e881be">00224</a> <span class="preprocessor">#define uip_getnetmask(addr) uip_ipaddr_copy((addr), &amp;uip_netmask)</span>
  257. <a name="l00225"></a>00225 <span class="preprocessor"></span><span class="comment"></span>
  258. <a name="l00226"></a>00226 <span class="comment">/** @} */</span>
  259. <a name="l00227"></a>00227 <span class="comment"></span>
  260. <a name="l00228"></a>00228 <span class="comment">/**</span>
  261. <a name="l00229"></a>00229 <span class="comment"> * \defgroup uipinit uIP initialization functions</span>
  262. <a name="l00230"></a>00230 <span class="comment"> * @{</span>
  263. <a name="l00231"></a>00231 <span class="comment"> *</span>
  264. <a name="l00232"></a>00232 <span class="comment"> * The uIP initialization functions are used for booting uIP.</span>
  265. <a name="l00233"></a>00233 <span class="comment"> */</span>
  266. <a name="l00234"></a>00234 <span class="comment"></span>
  267. <a name="l00235"></a>00235 <span class="comment">/**</span>
  268. <a name="l00236"></a>00236 <span class="comment"> * uIP initialization function.</span>
  269. <a name="l00237"></a>00237 <span class="comment"> *</span>
  270. <a name="l00238"></a>00238 <span class="comment"> * This function should be called at boot up to initilize the uIP</span>
  271. <a name="l00239"></a>00239 <span class="comment"> * TCP/IP stack.</span>
  272. <a name="l00240"></a>00240 <span class="comment"> */</span>
  273. <a name="l00241"></a>00241 <span class="keywordtype">void</span> <a class="code" href="a01684.html#gac48ed5f0d27721ef62a3ed02a5ad8d2e" title="uIP initialization function.">uip_init</a>(<span class="keywordtype">void</span>);
  274. <a name="l00242"></a>00242 <span class="comment"></span>
  275. <a name="l00243"></a>00243 <span class="comment">/**</span>
  276. <a name="l00244"></a>00244 <span class="comment"> * uIP initialization function.</span>
  277. <a name="l00245"></a>00245 <span class="comment"> *</span>
  278. <a name="l00246"></a>00246 <span class="comment"> * This function may be used at boot time to set the initial ip_id.</span>
  279. <a name="l00247"></a>00247 <span class="comment"> */</span>
  280. <a name="l00248"></a>00248 <span class="keywordtype">void</span> <a class="code" href="a01684.html#ga22f140b02c354dfebcc7ad481c3bcd68" title="uIP initialization function.">uip_setipid</a>(<a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <span class="keywordtype">id</span>);
  281. <a name="l00249"></a>00249 <span class="comment"></span>
  282. <a name="l00250"></a>00250 <span class="comment">/** @} */</span>
  283. <a name="l00251"></a>00251 <span class="comment"></span>
  284. <a name="l00252"></a>00252 <span class="comment">/**</span>
  285. <a name="l00253"></a>00253 <span class="comment"> * \defgroup uipdevfunc uIP device driver functions</span>
  286. <a name="l00254"></a>00254 <span class="comment"> * @{</span>
  287. <a name="l00255"></a>00255 <span class="comment"> *</span>
  288. <a name="l00256"></a>00256 <span class="comment"> * These functions are used by a network device driver for interacting</span>
  289. <a name="l00257"></a>00257 <span class="comment"> * with uIP.</span>
  290. <a name="l00258"></a>00258 <span class="comment"> */</span>
  291. <a name="l00259"></a>00259 <span class="comment"></span>
  292. <a name="l00260"></a>00260 <span class="comment">/**</span>
  293. <a name="l00261"></a>00261 <span class="comment"> * Process an incoming packet.</span>
  294. <a name="l00262"></a>00262 <span class="comment"> *</span>
  295. <a name="l00263"></a>00263 <span class="comment"> * This function should be called when the device driver has received</span>
  296. <a name="l00264"></a>00264 <span class="comment"> * a packet from the network. The packet from the device driver must</span>
  297. <a name="l00265"></a>00265 <span class="comment"> * be present in the uip_buf buffer, and the length of the packet</span>
  298. <a name="l00266"></a>00266 <span class="comment"> * should be placed in the uip_len variable.</span>
  299. <a name="l00267"></a>00267 <span class="comment"> *</span>
  300. <a name="l00268"></a>00268 <span class="comment"> * When the function returns, there may be an outbound packet placed</span>
  301. <a name="l00269"></a>00269 <span class="comment"> * in the uip_buf packet buffer. If so, the uip_len variable is set to</span>
  302. <a name="l00270"></a>00270 <span class="comment"> * the length of the packet. If no packet is to be sent out, the</span>
  303. <a name="l00271"></a>00271 <span class="comment"> * uip_len variable is set to 0.</span>
  304. <a name="l00272"></a>00272 <span class="comment"> *</span>
  305. <a name="l00273"></a>00273 <span class="comment"> * The usual way of calling the function is presented by the source</span>
  306. <a name="l00274"></a>00274 <span class="comment"> * code below.</span>
  307. <a name="l00275"></a>00275 <span class="comment"> \code</span>
  308. <a name="l00276"></a>00276 <span class="comment"> uip_len = devicedriver_poll();</span>
  309. <a name="l00277"></a>00277 <span class="comment"> if(uip_len &gt; 0) {</span>
  310. <a name="l00278"></a>00278 <span class="comment"> uip_input();</span>
  311. <a name="l00279"></a>00279 <span class="comment"> if(uip_len &gt; 0) {</span>
  312. <a name="l00280"></a>00280 <span class="comment"> devicedriver_send();</span>
  313. <a name="l00281"></a>00281 <span class="comment"> }</span>
  314. <a name="l00282"></a>00282 <span class="comment"> }</span>
  315. <a name="l00283"></a>00283 <span class="comment"> \endcode</span>
  316. <a name="l00284"></a>00284 <span class="comment"> *</span>
  317. <a name="l00285"></a>00285 <span class="comment"> * \note If you are writing a uIP device driver that needs ARP</span>
  318. <a name="l00286"></a>00286 <span class="comment"> * (Address Resolution Protocol), e.g., when running uIP over</span>
  319. <a name="l00287"></a>00287 <span class="comment"> * Ethernet, you will need to call the uIP ARP code before calling</span>
  320. <a name="l00288"></a>00288 <span class="comment"> * this function:</span>
  321. <a name="l00289"></a>00289 <span class="comment"> \code</span>
  322. <a name="l00290"></a>00290 <span class="comment"> #define BUF ((struct uip_eth_hdr *)&amp;uip_buf[0])</span>
  323. <a name="l00291"></a>00291 <span class="comment"> uip_len = ethernet_devicedrver_poll();</span>
  324. <a name="l00292"></a>00292 <span class="comment"> if(uip_len &gt; 0) {</span>
  325. <a name="l00293"></a>00293 <span class="comment"> if(BUF-&gt;type == UIP_HTONS(UIP_ETHTYPE_IP)) {</span>
  326. <a name="l00294"></a>00294 <span class="comment"> uip_arp_ipin();</span>
  327. <a name="l00295"></a>00295 <span class="comment"> uip_input();</span>
  328. <a name="l00296"></a>00296 <span class="comment"> if(uip_len &gt; 0) {</span>
  329. <a name="l00297"></a>00297 <span class="comment"> uip_arp_out();</span>
  330. <a name="l00298"></a>00298 <span class="comment"> ethernet_devicedriver_send();</span>
  331. <a name="l00299"></a>00299 <span class="comment"> }</span>
  332. <a name="l00300"></a>00300 <span class="comment"> } else if(BUF-&gt;type == UIP_HTONS(UIP_ETHTYPE_ARP)) {</span>
  333. <a name="l00301"></a>00301 <span class="comment"> uip_arp_arpin();</span>
  334. <a name="l00302"></a>00302 <span class="comment"> if(uip_len &gt; 0) {</span>
  335. <a name="l00303"></a>00303 <span class="comment"> ethernet_devicedriver_send();</span>
  336. <a name="l00304"></a>00304 <span class="comment"> }</span>
  337. <a name="l00305"></a>00305 <span class="comment"> }</span>
  338. <a name="l00306"></a>00306 <span class="comment"> \endcode</span>
  339. <a name="l00307"></a>00307 <span class="comment"> *</span>
  340. <a name="l00308"></a>00308 <span class="comment"> * \hideinitializer</span>
  341. <a name="l00309"></a>00309 <span class="comment"> */</span>
  342. <a name="l00310"></a><a class="code" href="a01574.html#gaa4360412ee9350fba725f98a137169fe">00310</a> <span class="preprocessor">#define uip_input() uip_process(UIP_DATA)</span>
  343. <a name="l00311"></a>00311 <span class="preprocessor"></span>
  344. <a name="l00312"></a>00312 <span class="comment"></span>
  345. <a name="l00313"></a>00313 <span class="comment">/**</span>
  346. <a name="l00314"></a>00314 <span class="comment"> * Periodic processing for a connection identified by its number.</span>
  347. <a name="l00315"></a>00315 <span class="comment"> *</span>
  348. <a name="l00316"></a>00316 <span class="comment"> * This function does the necessary periodic processing (timers,</span>
  349. <a name="l00317"></a>00317 <span class="comment"> * polling) for a uIP TCP conneciton, and should be called when the</span>
  350. <a name="l00318"></a>00318 <span class="comment"> * periodic uIP timer goes off. It should be called for every</span>
  351. <a name="l00319"></a>00319 <span class="comment"> * connection, regardless of whether they are open of closed.</span>
  352. <a name="l00320"></a>00320 <span class="comment"> *</span>
  353. <a name="l00321"></a>00321 <span class="comment"> * When the function returns, it may have an outbound packet waiting</span>
  354. <a name="l00322"></a>00322 <span class="comment"> * for service in the uIP packet buffer, and if so the uip_len</span>
  355. <a name="l00323"></a>00323 <span class="comment"> * variable is set to a value larger than zero. The device driver</span>
  356. <a name="l00324"></a>00324 <span class="comment"> * should be called to send out the packet.</span>
  357. <a name="l00325"></a>00325 <span class="comment"> *</span>
  358. <a name="l00326"></a>00326 <span class="comment"> * The usual way of calling the function is through a for() loop like</span>
  359. <a name="l00327"></a>00327 <span class="comment"> * this:</span>
  360. <a name="l00328"></a>00328 <span class="comment"> \code</span>
  361. <a name="l00329"></a>00329 <span class="comment"> for(i = 0; i &lt; UIP_CONNS; ++i) {</span>
  362. <a name="l00330"></a>00330 <span class="comment"> uip_periodic(i);</span>
  363. <a name="l00331"></a>00331 <span class="comment"> if(uip_len &gt; 0) {</span>
  364. <a name="l00332"></a>00332 <span class="comment"> devicedriver_send();</span>
  365. <a name="l00333"></a>00333 <span class="comment"> }</span>
  366. <a name="l00334"></a>00334 <span class="comment"> }</span>
  367. <a name="l00335"></a>00335 <span class="comment"> \endcode</span>
  368. <a name="l00336"></a>00336 <span class="comment"> *</span>
  369. <a name="l00337"></a>00337 <span class="comment"> * \note If you are writing a uIP device driver that needs ARP</span>
  370. <a name="l00338"></a>00338 <span class="comment"> * (Address Resolution Protocol), e.g., when running uIP over</span>
  371. <a name="l00339"></a>00339 <span class="comment"> * Ethernet, you will need to call the uip_arp_out() function before</span>
  372. <a name="l00340"></a>00340 <span class="comment"> * calling the device driver:</span>
  373. <a name="l00341"></a>00341 <span class="comment"> \code</span>
  374. <a name="l00342"></a>00342 <span class="comment"> for(i = 0; i &lt; UIP_CONNS; ++i) {</span>
  375. <a name="l00343"></a>00343 <span class="comment"> uip_periodic(i);</span>
  376. <a name="l00344"></a>00344 <span class="comment"> if(uip_len &gt; 0) {</span>
  377. <a name="l00345"></a>00345 <span class="comment"> uip_arp_out();</span>
  378. <a name="l00346"></a>00346 <span class="comment"> ethernet_devicedriver_send();</span>
  379. <a name="l00347"></a>00347 <span class="comment"> }</span>
  380. <a name="l00348"></a>00348 <span class="comment"> }</span>
  381. <a name="l00349"></a>00349 <span class="comment"> \endcode</span>
  382. <a name="l00350"></a>00350 <span class="comment"> *</span>
  383. <a name="l00351"></a>00351 <span class="comment"> * \param conn The number of the connection which is to be periodically polled.</span>
  384. <a name="l00352"></a>00352 <span class="comment"> *</span>
  385. <a name="l00353"></a>00353 <span class="comment"> * \hideinitializer</span>
  386. <a name="l00354"></a>00354 <span class="comment"> */</span>
  387. <a name="l00355"></a>00355 <span class="preprocessor">#if UIP_TCP</span>
  388. <a name="l00356"></a>00356 <span class="preprocessor"></span><span class="preprocessor">#define uip_periodic(conn) do { uip_conn = &amp;uip_conns[conn]; \</span>
  389. <a name="l00357"></a>00357 <span class="preprocessor"> uip_process(UIP_TIMER); } while (0)</span>
  390. <a name="l00358"></a>00358 <span class="preprocessor"></span><span class="comment"></span>
  391. <a name="l00359"></a>00359 <span class="comment">/**</span>
  392. <a name="l00360"></a>00360 <span class="comment"> *</span>
  393. <a name="l00361"></a>00361 <span class="comment"> *</span>
  394. <a name="l00362"></a>00362 <span class="comment"> */</span>
  395. <a name="l00363"></a>00363 <span class="preprocessor">#define uip_conn_active(conn) (uip_conns[conn].tcpstateflags != UIP_CLOSED)</span>
  396. <a name="l00364"></a>00364 <span class="preprocessor"></span><span class="comment"></span>
  397. <a name="l00365"></a>00365 <span class="comment">/**</span>
  398. <a name="l00366"></a>00366 <span class="comment"> * Perform periodic processing for a connection identified by a pointer</span>
  399. <a name="l00367"></a>00367 <span class="comment"> * to its structure.</span>
  400. <a name="l00368"></a>00368 <span class="comment"> *</span>
  401. <a name="l00369"></a>00369 <span class="comment"> * Same as uip_periodic() but takes a pointer to the actual uip_conn</span>
  402. <a name="l00370"></a>00370 <span class="comment"> * struct instead of an integer as its argument. This function can be</span>
  403. <a name="l00371"></a>00371 <span class="comment"> * used to force periodic processing of a specific connection.</span>
  404. <a name="l00372"></a>00372 <span class="comment"> *</span>
  405. <a name="l00373"></a>00373 <span class="comment"> * \param conn A pointer to the uip_conn struct for the connection to</span>
  406. <a name="l00374"></a>00374 <span class="comment"> * be processed.</span>
  407. <a name="l00375"></a>00375 <span class="comment"> *</span>
  408. <a name="l00376"></a>00376 <span class="comment"> * \hideinitializer</span>
  409. <a name="l00377"></a>00377 <span class="comment"> */</span>
  410. <a name="l00378"></a>00378 <span class="preprocessor">#define uip_periodic_conn(conn) do { uip_conn = conn; \</span>
  411. <a name="l00379"></a>00379 <span class="preprocessor"> uip_process(UIP_TIMER); } while (0)</span>
  412. <a name="l00380"></a>00380 <span class="preprocessor"></span><span class="comment"></span>
  413. <a name="l00381"></a>00381 <span class="comment">/**</span>
  414. <a name="l00382"></a>00382 <span class="comment"> * Request that a particular connection should be polled.</span>
  415. <a name="l00383"></a>00383 <span class="comment"> *</span>
  416. <a name="l00384"></a>00384 <span class="comment"> * Similar to uip_periodic_conn() but does not perform any timer</span>
  417. <a name="l00385"></a>00385 <span class="comment"> * processing. The application is polled for new data.</span>
  418. <a name="l00386"></a>00386 <span class="comment"> *</span>
  419. <a name="l00387"></a>00387 <span class="comment"> * \param conn A pointer to the uip_conn struct for the connection to</span>
  420. <a name="l00388"></a>00388 <span class="comment"> * be processed.</span>
  421. <a name="l00389"></a>00389 <span class="comment"> *</span>
  422. <a name="l00390"></a>00390 <span class="comment"> * \hideinitializer</span>
  423. <a name="l00391"></a>00391 <span class="comment"> */</span>
  424. <a name="l00392"></a>00392 <span class="preprocessor">#define uip_poll_conn(conn) do { uip_conn = conn; \</span>
  425. <a name="l00393"></a>00393 <span class="preprocessor"> uip_process(UIP_POLL_REQUEST); } while (0)</span>
  426. <a name="l00394"></a>00394 <span class="preprocessor"></span>
  427. <a name="l00395"></a>00395 <span class="preprocessor">#endif </span><span class="comment">/* UIP_TCP */</span>
  428. <a name="l00396"></a>00396
  429. <a name="l00397"></a>00397 <span class="preprocessor">#if UIP_UDP</span>
  430. <a name="l00398"></a>00398 <span class="preprocessor"></span><span class="comment">/**</span>
  431. <a name="l00399"></a>00399 <span class="comment"> * Periodic processing for a UDP connection identified by its number.</span>
  432. <a name="l00400"></a>00400 <span class="comment"> *</span>
  433. <a name="l00401"></a>00401 <span class="comment"> * This function is essentially the same as uip_periodic(), but for</span>
  434. <a name="l00402"></a>00402 <span class="comment"> * UDP connections. It is called in a similar fashion as the</span>
  435. <a name="l00403"></a>00403 <span class="comment"> * uip_periodic() function:</span>
  436. <a name="l00404"></a>00404 <span class="comment"> \code</span>
  437. <a name="l00405"></a>00405 <span class="comment"> for(i = 0; i &lt; UIP_UDP_CONNS; i++) {</span>
  438. <a name="l00406"></a>00406 <span class="comment"> uip_udp_periodic(i);</span>
  439. <a name="l00407"></a>00407 <span class="comment"> if(uip_len &gt; 0) {</span>
  440. <a name="l00408"></a>00408 <span class="comment"> devicedriver_send();</span>
  441. <a name="l00409"></a>00409 <span class="comment"> }</span>
  442. <a name="l00410"></a>00410 <span class="comment"> }</span>
  443. <a name="l00411"></a>00411 <span class="comment"> \endcode</span>
  444. <a name="l00412"></a>00412 <span class="comment"> *</span>
  445. <a name="l00413"></a>00413 <span class="comment"> * \note As for the uip_periodic() function, special care has to be</span>
  446. <a name="l00414"></a>00414 <span class="comment"> * taken when using uIP together with ARP and Ethernet:</span>
  447. <a name="l00415"></a>00415 <span class="comment"> \code</span>
  448. <a name="l00416"></a>00416 <span class="comment"> for(i = 0; i &lt; UIP_UDP_CONNS; i++) {</span>
  449. <a name="l00417"></a>00417 <span class="comment"> uip_udp_periodic(i);</span>
  450. <a name="l00418"></a>00418 <span class="comment"> if(uip_len &gt; 0) {</span>
  451. <a name="l00419"></a>00419 <span class="comment"> uip_arp_out();</span>
  452. <a name="l00420"></a>00420 <span class="comment"> ethernet_devicedriver_send();</span>
  453. <a name="l00421"></a>00421 <span class="comment"> }</span>
  454. <a name="l00422"></a>00422 <span class="comment"> }</span>
  455. <a name="l00423"></a>00423 <span class="comment"> \endcode</span>
  456. <a name="l00424"></a>00424 <span class="comment"> *</span>
  457. <a name="l00425"></a>00425 <span class="comment"> * \param conn The number of the UDP connection to be processed.</span>
  458. <a name="l00426"></a>00426 <span class="comment"> *</span>
  459. <a name="l00427"></a>00427 <span class="comment"> * \hideinitializer</span>
  460. <a name="l00428"></a>00428 <span class="comment"> */</span>
  461. <a name="l00429"></a><a class="code" href="a01574.html#ga2c64c8c36bc84f9336f6a2184ea51883">00429</a> <span class="preprocessor">#define uip_udp_periodic(conn) do { uip_udp_conn = &amp;uip_udp_conns[conn]; \</span>
  462. <a name="l00430"></a>00430 <span class="preprocessor"> uip_process(UIP_UDP_TIMER); } while(0)</span>
  463. <a name="l00431"></a>00431 <span class="preprocessor"></span><span class="comment"></span>
  464. <a name="l00432"></a>00432 <span class="comment">/**</span>
  465. <a name="l00433"></a>00433 <span class="comment"> * Periodic processing for a UDP connection identified by a pointer to</span>
  466. <a name="l00434"></a>00434 <span class="comment"> * its structure.</span>
  467. <a name="l00435"></a>00435 <span class="comment"> *</span>
  468. <a name="l00436"></a>00436 <span class="comment"> * Same as uip_udp_periodic() but takes a pointer to the actual</span>
  469. <a name="l00437"></a>00437 <span class="comment"> * uip_conn struct instead of an integer as its argument. This</span>
  470. <a name="l00438"></a>00438 <span class="comment"> * function can be used to force periodic processing of a specific</span>
  471. <a name="l00439"></a>00439 <span class="comment"> * connection.</span>
  472. <a name="l00440"></a>00440 <span class="comment"> *</span>
  473. <a name="l00441"></a>00441 <span class="comment"> * \param conn A pointer to the uip_udp_conn struct for the connection</span>
  474. <a name="l00442"></a>00442 <span class="comment"> * to be processed.</span>
  475. <a name="l00443"></a>00443 <span class="comment"> *</span>
  476. <a name="l00444"></a>00444 <span class="comment"> * \hideinitializer</span>
  477. <a name="l00445"></a>00445 <span class="comment"> */</span>
  478. <a name="l00446"></a><a class="code" href="a01574.html#gaf5c2ad5acf3cc23b8262e9ba6a15136b">00446</a> <span class="preprocessor">#define uip_udp_periodic_conn(conn) do { uip_udp_conn = conn; \</span>
  479. <a name="l00447"></a>00447 <span class="preprocessor"> uip_process(UIP_UDP_TIMER); } while(0)</span>
  480. <a name="l00448"></a>00448 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_UDP */</span>
  481. <a name="l00449"></a>00449 <span class="comment"></span>
  482. <a name="l00450"></a>00450 <span class="comment">/** \brief Abandon the reassembly of the current packet */</span>
  483. <a name="l00451"></a>00451 <span class="keywordtype">void</span> <a class="code" href="a01574.html#gaf8a01d734ce7c50dd9ef03b2a4e7a0ce" title="Abandon the reassembly of the current packet.">uip_reass_over</a>(<span class="keywordtype">void</span>);
  484. <a name="l00452"></a>00452 <span class="comment"></span>
  485. <a name="l00453"></a>00453 <span class="comment">/**</span>
  486. <a name="l00454"></a>00454 <span class="comment"> * The uIP packet buffer.</span>
  487. <a name="l00455"></a>00455 <span class="comment"> *</span>
  488. <a name="l00456"></a>00456 <span class="comment"> * The uip_buf array is used to hold incoming and outgoing</span>
  489. <a name="l00457"></a>00457 <span class="comment"> * packets. The device driver should place incoming data into this</span>
  490. <a name="l00458"></a>00458 <span class="comment"> * buffer. When sending data, the device driver should read the link</span>
  491. <a name="l00459"></a>00459 <span class="comment"> * level headers and the TCP/IP headers from this buffer. The size of</span>
  492. <a name="l00460"></a>00460 <span class="comment"> * the link level headers is configured by the UIP_LLH_LEN define.</span>
  493. <a name="l00461"></a>00461 <span class="comment"> *</span>
  494. <a name="l00462"></a>00462 <span class="comment"> * \note The application data need not be placed in this buffer, so</span>
  495. <a name="l00463"></a>00463 <span class="comment"> * the device driver must read it from the place pointed to by the</span>
  496. <a name="l00464"></a>00464 <span class="comment"> * uip_appdata pointer as illustrated by the following example:</span>
  497. <a name="l00465"></a>00465 <span class="comment"> \code</span>
  498. <a name="l00466"></a>00466 <span class="comment"> void</span>
  499. <a name="l00467"></a>00467 <span class="comment"> devicedriver_send(void)</span>
  500. <a name="l00468"></a>00468 <span class="comment"> {</span>
  501. <a name="l00469"></a>00469 <span class="comment"> hwsend(&amp;uip_buf[0], UIP_LLH_LEN);</span>
  502. <a name="l00470"></a>00470 <span class="comment"> if(uip_len &lt;= UIP_LLH_LEN + UIP_TCPIP_HLEN) {</span>
  503. <a name="l00471"></a>00471 <span class="comment"> hwsend(&amp;uip_buf[UIP_LLH_LEN], uip_len - UIP_LLH_LEN);</span>
  504. <a name="l00472"></a>00472 <span class="comment"> } else {</span>
  505. <a name="l00473"></a>00473 <span class="comment"> hwsend(&amp;uip_buf[UIP_LLH_LEN], UIP_TCPIP_HLEN);</span>
  506. <a name="l00474"></a>00474 <span class="comment"> hwsend(uip_appdata, uip_len - UIP_TCPIP_HLEN - UIP_LLH_LEN);</span>
  507. <a name="l00475"></a>00475 <span class="comment"> }</span>
  508. <a name="l00476"></a>00476 <span class="comment"> }</span>
  509. <a name="l00477"></a>00477 <span class="comment"> \endcode</span>
  510. <a name="l00478"></a>00478 <span class="comment">*/</span>
  511. <a name="l00479"></a>00479
  512. <a name="l00480"></a><a class="code" href="a00091.html">00480</a> <span class="keyword">typedef</span> <span class="keyword">union </span>{
  513. <a name="l00481"></a>00481 uint32_t u32[(<a class="code" href="a01589.html#ga3589822ecb9d9c4145209756396b8a6b" title="The size of the uIP packet buffer.">UIP_BUFSIZE</a> + 3) / 4];
  514. <a name="l00482"></a>00482 uint8_t u8[<a class="code" href="a01589.html#ga3589822ecb9d9c4145209756396b8a6b" title="The size of the uIP packet buffer.">UIP_BUFSIZE</a>];
  515. <a name="l00483"></a>00483 } <a class="code" href="a00091.html" title="The uIP packet buffer.">uip_buf_t</a>;
  516. <a name="l00484"></a>00484
  517. <a name="l00485"></a>00485 CCIF <span class="keyword">extern</span> <a class="code" href="a00091.html" title="The uIP packet buffer.">uip_buf_t</a> uip_aligned_buf;
  518. <a name="l00486"></a>00486 <span class="preprocessor">#define uip_buf (uip_aligned_buf.u8)</span>
  519. <a name="l00487"></a>00487 <span class="preprocessor"></span>
  520. <a name="l00488"></a>00488 <span class="comment"></span>
  521. <a name="l00489"></a>00489 <span class="comment">/** @} */</span>
  522. <a name="l00490"></a>00490
  523. <a name="l00491"></a>00491 <span class="comment">/*---------------------------------------------------------------------------*/</span>
  524. <a name="l00492"></a>00492 <span class="comment">/* Functions that are used by the uIP application program. Opening and</span>
  525. <a name="l00493"></a>00493 <span class="comment"> * closing connections, sending and receiving data, etc. is all</span>
  526. <a name="l00494"></a>00494 <span class="comment"> * handled by the functions below.</span>
  527. <a name="l00495"></a>00495 <span class="comment"> */</span><span class="comment"></span>
  528. <a name="l00496"></a>00496 <span class="comment">/**</span>
  529. <a name="l00497"></a>00497 <span class="comment"> * \defgroup uipappfunc uIP application functions</span>
  530. <a name="l00498"></a>00498 <span class="comment"> * @{</span>
  531. <a name="l00499"></a>00499 <span class="comment"> *</span>
  532. <a name="l00500"></a>00500 <span class="comment"> * Functions used by an application running of top of uIP.</span>
  533. <a name="l00501"></a>00501 <span class="comment"> */</span>
  534. <a name="l00502"></a>00502 <span class="comment"></span>
  535. <a name="l00503"></a>00503 <span class="comment">/**</span>
  536. <a name="l00504"></a>00504 <span class="comment"> * Start listening to the specified port.</span>
  537. <a name="l00505"></a>00505 <span class="comment"> *</span>
  538. <a name="l00506"></a>00506 <span class="comment"> * \note Since this function expects the port number in network byte</span>
  539. <a name="l00507"></a>00507 <span class="comment"> * order, a conversion using UIP_HTONS() or uip_htons() is necessary.</span>
  540. <a name="l00508"></a>00508 <span class="comment"> *</span>
  541. <a name="l00509"></a>00509 <span class="comment"> \code</span>
  542. <a name="l00510"></a>00510 <span class="comment"> uip_listen(UIP_HTONS(80));</span>
  543. <a name="l00511"></a>00511 <span class="comment"> \endcode</span>
  544. <a name="l00512"></a>00512 <span class="comment"> *</span>
  545. <a name="l00513"></a>00513 <span class="comment"> * \param port A 16-bit port number in network byte order.</span>
  546. <a name="l00514"></a>00514 <span class="comment"> */</span>
  547. <a name="l00515"></a>00515 <span class="keywordtype">void</span> <a class="code" href="a01684.html#gadd1ab3704ecd4900eec61a6897d32dc8" title="Start listening to the specified port.">uip_listen</a>(<a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> port);
  548. <a name="l00516"></a>00516 <span class="comment"></span>
  549. <a name="l00517"></a>00517 <span class="comment">/**</span>
  550. <a name="l00518"></a>00518 <span class="comment"> * Stop listening to the specified port.</span>
  551. <a name="l00519"></a>00519 <span class="comment"> *</span>
  552. <a name="l00520"></a>00520 <span class="comment"> * \note Since this function expects the port number in network byte</span>
  553. <a name="l00521"></a>00521 <span class="comment"> * order, a conversion using UIP_HTONS() or uip_htons() is necessary.</span>
  554. <a name="l00522"></a>00522 <span class="comment"> *</span>
  555. <a name="l00523"></a>00523 <span class="comment"> \code</span>
  556. <a name="l00524"></a>00524 <span class="comment"> uip_unlisten(UIP_HTONS(80));</span>
  557. <a name="l00525"></a>00525 <span class="comment"> \endcode</span>
  558. <a name="l00526"></a>00526 <span class="comment"> *</span>
  559. <a name="l00527"></a>00527 <span class="comment"> * \param port A 16-bit port number in network byte order.</span>
  560. <a name="l00528"></a>00528 <span class="comment"> */</span>
  561. <a name="l00529"></a>00529 <span class="keywordtype">void</span> <a class="code" href="a01684.html#gaaa585784b0914cac1d37f07f85457008" title="Stop listening to the specified port.">uip_unlisten</a>(<a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> port);
  562. <a name="l00530"></a>00530 <span class="comment"></span>
  563. <a name="l00531"></a>00531 <span class="comment">/**</span>
  564. <a name="l00532"></a>00532 <span class="comment"> * Connect to a remote host using TCP.</span>
  565. <a name="l00533"></a>00533 <span class="comment"> *</span>
  566. <a name="l00534"></a>00534 <span class="comment"> * This function is used to start a new connection to the specified</span>
  567. <a name="l00535"></a>00535 <span class="comment"> * port on the specified host. It allocates a new connection identifier,</span>
  568. <a name="l00536"></a>00536 <span class="comment"> * sets the connection to the SYN_SENT state and sets the</span>
  569. <a name="l00537"></a>00537 <span class="comment"> * retransmission timer to 0. This will cause a TCP SYN segment to be</span>
  570. <a name="l00538"></a>00538 <span class="comment"> * sent out the next time this connection is periodically processed,</span>
  571. <a name="l00539"></a>00539 <span class="comment"> * which usually is done within 0.5 seconds after the call to</span>
  572. <a name="l00540"></a>00540 <span class="comment"> * uip_connect().</span>
  573. <a name="l00541"></a>00541 <span class="comment"> *</span>
  574. <a name="l00542"></a>00542 <span class="comment"> * \note This function is available only if support for active open</span>
  575. <a name="l00543"></a>00543 <span class="comment"> * has been configured by defining UIP_ACTIVE_OPEN to 1 in uipopt.h.</span>
  576. <a name="l00544"></a>00544 <span class="comment"> *</span>
  577. <a name="l00545"></a>00545 <span class="comment"> * \note Since this function requires the port number to be in network</span>
  578. <a name="l00546"></a>00546 <span class="comment"> * byte order, a conversion using UIP_HTONS() or uip_htons() is necessary.</span>
  579. <a name="l00547"></a>00547 <span class="comment"> *</span>
  580. <a name="l00548"></a>00548 <span class="comment"> \code</span>
  581. <a name="l00549"></a>00549 <span class="comment"> uip_ipaddr_t ipaddr;</span>
  582. <a name="l00550"></a>00550 <span class="comment"></span>
  583. <a name="l00551"></a>00551 <span class="comment"> uip_ipaddr(&amp;ipaddr, 192,168,1,2);</span>
  584. <a name="l00552"></a>00552 <span class="comment"> uip_connect(&amp;ipaddr, UIP_HTONS(80));</span>
  585. <a name="l00553"></a>00553 <span class="comment"> \endcode</span>
  586. <a name="l00554"></a>00554 <span class="comment"> *</span>
  587. <a name="l00555"></a>00555 <span class="comment"> * \param ripaddr The IP address of the remote host.</span>
  588. <a name="l00556"></a>00556 <span class="comment"> *</span>
  589. <a name="l00557"></a>00557 <span class="comment"> * \param port A 16-bit port number in network byte order.</span>
  590. <a name="l00558"></a>00558 <span class="comment"> *</span>
  591. <a name="l00559"></a>00559 <span class="comment"> * \return A pointer to the uIP connection identifier for the new connection,</span>
  592. <a name="l00560"></a>00560 <span class="comment"> * or NULL if no connection could be allocated.</span>
  593. <a name="l00561"></a>00561 <span class="comment"> *</span>
  594. <a name="l00562"></a>00562 <span class="comment"> */</span>
  595. <a name="l00563"></a>00563 <span class="keyword">struct </span><a class="code" href="a00092.html" title="Representation of a uIP TCP connection.">uip_conn</a> *<a class="code" href="a01575.html#ga8096b0c4b543dc408f4dd031ddae7240" title="Connect to a remote host using TCP.">uip_connect</a>(<a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> *<a class="code" href="a00092.html#a79510aa86d3fa0a0fc6cfc49b1da7279" title="The IP address of the remote host.">ripaddr</a>, <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> port);
  596. <a name="l00564"></a>00564
  597. <a name="l00565"></a>00565
  598. <a name="l00566"></a>00566 <span class="comment"></span>
  599. <a name="l00567"></a>00567 <span class="comment">/**</span>
  600. <a name="l00568"></a>00568 <span class="comment"> * \internal</span>
  601. <a name="l00569"></a>00569 <span class="comment"> *</span>
  602. <a name="l00570"></a>00570 <span class="comment"> * Check if a connection has outstanding (i.e., unacknowledged) data.</span>
  603. <a name="l00571"></a>00571 <span class="comment"> *</span>
  604. <a name="l00572"></a>00572 <span class="comment"> * \param conn A pointer to the uip_conn structure for the connection.</span>
  605. <a name="l00573"></a>00573 <span class="comment"> *</span>
  606. <a name="l00574"></a>00574 <span class="comment"> * \hideinitializer</span>
  607. <a name="l00575"></a>00575 <span class="comment"> */</span>
  608. <a name="l00576"></a>00576 <span class="preprocessor">#define uip_outstanding(conn) ((conn)-&gt;len)</span>
  609. <a name="l00577"></a>00577 <span class="preprocessor"></span><span class="comment"></span>
  610. <a name="l00578"></a>00578 <span class="comment">/**</span>
  611. <a name="l00579"></a>00579 <span class="comment"> * Send data on the current connection.</span>
  612. <a name="l00580"></a>00580 <span class="comment"> *</span>
  613. <a name="l00581"></a>00581 <span class="comment"> * This function is used to send out a single segment of TCP</span>
  614. <a name="l00582"></a>00582 <span class="comment"> * data. Only applications that have been invoked by uIP for event</span>
  615. <a name="l00583"></a>00583 <span class="comment"> * processing can send data.</span>
  616. <a name="l00584"></a>00584 <span class="comment"> *</span>
  617. <a name="l00585"></a>00585 <span class="comment"> * The amount of data that actually is sent out after a call to this</span>
  618. <a name="l00586"></a>00586 <span class="comment"> * function is determined by the maximum amount of data TCP allows. uIP</span>
  619. <a name="l00587"></a>00587 <span class="comment"> * will automatically crop the data so that only the appropriate</span>
  620. <a name="l00588"></a>00588 <span class="comment"> * amount of data is sent. The function uip_mss() can be used to query</span>
  621. <a name="l00589"></a>00589 <span class="comment"> * uIP for the amount of data that actually will be sent.</span>
  622. <a name="l00590"></a>00590 <span class="comment"> *</span>
  623. <a name="l00591"></a>00591 <span class="comment"> * \note This function does not guarantee that the sent data will</span>
  624. <a name="l00592"></a>00592 <span class="comment"> * arrive at the destination. If the data is lost in the network, the</span>
  625. <a name="l00593"></a>00593 <span class="comment"> * application will be invoked with the uip_rexmit() event being</span>
  626. <a name="l00594"></a>00594 <span class="comment"> * set. The application will then have to resend the data using this</span>
  627. <a name="l00595"></a>00595 <span class="comment"> * function.</span>
  628. <a name="l00596"></a>00596 <span class="comment"> *</span>
  629. <a name="l00597"></a>00597 <span class="comment"> * \param data A pointer to the data which is to be sent.</span>
  630. <a name="l00598"></a>00598 <span class="comment"> *</span>
  631. <a name="l00599"></a>00599 <span class="comment"> * \param len The maximum amount of data bytes to be sent.</span>
  632. <a name="l00600"></a>00600 <span class="comment"> *</span>
  633. <a name="l00601"></a>00601 <span class="comment"> * \hideinitializer</span>
  634. <a name="l00602"></a>00602 <span class="comment"> */</span>
  635. <a name="l00603"></a>00603 CCIF <span class="keywordtype">void</span> <a class="code" href="a01684.html#ga04b053a623aac7cd4195157d470661b3" title="Send data on the current connection.">uip_send</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> <a class="code" href="a00092.html#a0ef3ae2764714bf90620075c374c262e" title="Length of the data that was previously sent.">len</a>);
  636. <a name="l00604"></a>00604 <span class="comment"></span>
  637. <a name="l00605"></a>00605 <span class="comment">/**</span>
  638. <a name="l00606"></a>00606 <span class="comment"> * The length of any incoming data that is currently available (if available)</span>
  639. <a name="l00607"></a>00607 <span class="comment"> * in the uip_appdata buffer.</span>
  640. <a name="l00608"></a>00608 <span class="comment"> *</span>
  641. <a name="l00609"></a>00609 <span class="comment"> * The test function uip_data() must first be used to check if there</span>
  642. <a name="l00610"></a>00610 <span class="comment"> * is any data available at all.</span>
  643. <a name="l00611"></a>00611 <span class="comment"> *</span>
  644. <a name="l00612"></a>00612 <span class="comment"> * \hideinitializer</span>
  645. <a name="l00613"></a>00613 <span class="comment"> */</span>
  646. <a name="l00614"></a>00614 <span class="comment">/*void uip_datalen(void);*/</span>
  647. <a name="l00615"></a><a class="code" href="a01575.html#ga1a1bc437c09ddef238abab41d77c3177">00615</a> <span class="preprocessor">#define uip_datalen() uip_len</span>
  648. <a name="l00616"></a>00616 <span class="preprocessor"></span><span class="comment"></span>
  649. <a name="l00617"></a>00617 <span class="comment">/**</span>
  650. <a name="l00618"></a>00618 <span class="comment"> * The length of any out-of-band data (urgent data) that has arrived</span>
  651. <a name="l00619"></a>00619 <span class="comment"> * on the connection.</span>
  652. <a name="l00620"></a>00620 <span class="comment"> *</span>
  653. <a name="l00621"></a>00621 <span class="comment"> * \note The configuration parameter UIP_URGDATA must be set for this</span>
  654. <a name="l00622"></a>00622 <span class="comment"> * function to be enabled.</span>
  655. <a name="l00623"></a>00623 <span class="comment"> *</span>
  656. <a name="l00624"></a>00624 <span class="comment"> * \hideinitializer</span>
  657. <a name="l00625"></a>00625 <span class="comment"> */</span>
  658. <a name="l00626"></a><a class="code" href="a01575.html#ga8411c95a4d89367ad2d9d6bde1a3d537">00626</a> <span class="preprocessor">#define uip_urgdatalen() uip_urglen</span>
  659. <a name="l00627"></a>00627 <span class="preprocessor"></span><span class="comment"></span>
  660. <a name="l00628"></a>00628 <span class="comment">/**</span>
  661. <a name="l00629"></a>00629 <span class="comment"> * Close the current connection.</span>
  662. <a name="l00630"></a>00630 <span class="comment"> *</span>
  663. <a name="l00631"></a>00631 <span class="comment"> * This function will close the current connection in a nice way.</span>
  664. <a name="l00632"></a>00632 <span class="comment"> *</span>
  665. <a name="l00633"></a>00633 <span class="comment"> * \hideinitializer</span>
  666. <a name="l00634"></a>00634 <span class="comment"> */</span>
  667. <a name="l00635"></a><a class="code" href="a01575.html#ga61db1dcb7c760e4dd5d60bf4e5576dca">00635</a> <span class="preprocessor">#define uip_close() (uip_flags = UIP_CLOSE)</span>
  668. <a name="l00636"></a>00636 <span class="preprocessor"></span><span class="comment"></span>
  669. <a name="l00637"></a>00637 <span class="comment">/**</span>
  670. <a name="l00638"></a>00638 <span class="comment"> * Abort the current connection.</span>
  671. <a name="l00639"></a>00639 <span class="comment"> *</span>
  672. <a name="l00640"></a>00640 <span class="comment"> * This function will abort (reset) the current connection, and is</span>
  673. <a name="l00641"></a>00641 <span class="comment"> * usually used when an error has occurred that prevents using the</span>
  674. <a name="l00642"></a>00642 <span class="comment"> * uip_close() function.</span>
  675. <a name="l00643"></a>00643 <span class="comment"> *</span>
  676. <a name="l00644"></a>00644 <span class="comment"> * \hideinitializer</span>
  677. <a name="l00645"></a>00645 <span class="comment"> */</span>
  678. <a name="l00646"></a><a class="code" href="a01575.html#ga88d2ccf7cd821f89d9a8df7e3948b56c">00646</a> <span class="preprocessor">#define uip_abort() (uip_flags = UIP_ABORT)</span>
  679. <a name="l00647"></a>00647 <span class="preprocessor"></span><span class="comment"></span>
  680. <a name="l00648"></a>00648 <span class="comment">/**</span>
  681. <a name="l00649"></a>00649 <span class="comment"> * Tell the sending host to stop sending data.</span>
  682. <a name="l00650"></a>00650 <span class="comment"> *</span>
  683. <a name="l00651"></a>00651 <span class="comment"> * This function will close our receiver&apos;s window so that we stop</span>
  684. <a name="l00652"></a>00652 <span class="comment"> * receiving data for the current connection.</span>
  685. <a name="l00653"></a>00653 <span class="comment"> *</span>
  686. <a name="l00654"></a>00654 <span class="comment"> * \hideinitializer</span>
  687. <a name="l00655"></a>00655 <span class="comment"> */</span>
  688. <a name="l00656"></a><a class="code" href="a01575.html#ga0a8bb9d6d0f1f56852ccfccbbad6c5d8">00656</a> <span class="preprocessor">#define uip_stop() (uip_conn-&gt;tcpstateflags |= UIP_STOPPED)</span>
  689. <a name="l00657"></a>00657 <span class="preprocessor"></span><span class="comment"></span>
  690. <a name="l00658"></a>00658 <span class="comment">/**</span>
  691. <a name="l00659"></a>00659 <span class="comment"> * Find out if the current connection has been previously stopped with</span>
  692. <a name="l00660"></a>00660 <span class="comment"> * uip_stop().</span>
  693. <a name="l00661"></a>00661 <span class="comment"> *</span>
  694. <a name="l00662"></a>00662 <span class="comment"> * \hideinitializer</span>
  695. <a name="l00663"></a>00663 <span class="comment"> */</span>
  696. <a name="l00664"></a><a class="code" href="a01575.html#ga64a238a5c02640a7a4aef004163aeb47">00664</a> <span class="preprocessor">#define uip_stopped(conn) ((conn)-&gt;tcpstateflags &amp; UIP_STOPPED)</span>
  697. <a name="l00665"></a>00665 <span class="preprocessor"></span><span class="comment"></span>
  698. <a name="l00666"></a>00666 <span class="comment">/**</span>
  699. <a name="l00667"></a>00667 <span class="comment"> * Restart the current connection, if is has previously been stopped</span>
  700. <a name="l00668"></a>00668 <span class="comment"> * with uip_stop().</span>
  701. <a name="l00669"></a>00669 <span class="comment"> *</span>
  702. <a name="l00670"></a>00670 <span class="comment"> * This function will open the receiver&apos;s window again so that we</span>
  703. <a name="l00671"></a>00671 <span class="comment"> * start receiving data for the current connection.</span>
  704. <a name="l00672"></a>00672 <span class="comment"> *</span>
  705. <a name="l00673"></a>00673 <span class="comment"> * \hideinitializer</span>
  706. <a name="l00674"></a>00674 <span class="comment"> */</span>
  707. <a name="l00675"></a><a class="code" href="a01575.html#ga81ac47cee1c18f6aa479044069db7ca3">00675</a> <span class="preprocessor">#define uip_restart() do { uip_flags |= UIP_NEWDATA; \</span>
  708. <a name="l00676"></a>00676 <span class="preprocessor"> uip_conn-&gt;tcpstateflags &amp;= ~UIP_STOPPED; \</span>
  709. <a name="l00677"></a>00677 <span class="preprocessor"> } while(0)</span>
  710. <a name="l00678"></a>00678 <span class="preprocessor"></span>
  711. <a name="l00679"></a>00679
  712. <a name="l00680"></a>00680 <span class="comment">/* uIP tests that can be made to determine in what state the current</span>
  713. <a name="l00681"></a>00681 <span class="comment"> connection is, and what the application function should do. */</span>
  714. <a name="l00682"></a>00682 <span class="comment"></span>
  715. <a name="l00683"></a>00683 <span class="comment">/**</span>
  716. <a name="l00684"></a>00684 <span class="comment"> * Is the current connection a UDP connection?</span>
  717. <a name="l00685"></a>00685 <span class="comment"> *</span>
  718. <a name="l00686"></a>00686 <span class="comment"> * This function checks whether the current connection is a UDP connection.</span>
  719. <a name="l00687"></a>00687 <span class="comment"> *</span>
  720. <a name="l00688"></a>00688 <span class="comment"> * \hideinitializer</span>
  721. <a name="l00689"></a>00689 <span class="comment"> *</span>
  722. <a name="l00690"></a>00690 <span class="comment"> */</span>
  723. <a name="l00691"></a><a class="code" href="a01575.html#gaa9de254b8aa308eb4aab17efdde622d2">00691</a> <span class="preprocessor">#define uip_udpconnection() (uip_conn == NULL)</span>
  724. <a name="l00692"></a>00692 <span class="preprocessor"></span><span class="comment"></span>
  725. <a name="l00693"></a>00693 <span class="comment">/**</span>
  726. <a name="l00694"></a>00694 <span class="comment"> * Is new incoming data available?</span>
  727. <a name="l00695"></a>00695 <span class="comment"> *</span>
  728. <a name="l00696"></a>00696 <span class="comment"> * Will reduce to non-zero if there is new data for the application</span>
  729. <a name="l00697"></a>00697 <span class="comment"> * present at the uip_appdata pointer. The size of the data is</span>
  730. <a name="l00698"></a>00698 <span class="comment"> * available through the uip_len variable.</span>
  731. <a name="l00699"></a>00699 <span class="comment"> *</span>
  732. <a name="l00700"></a>00700 <span class="comment"> * \hideinitializer</span>
  733. <a name="l00701"></a>00701 <span class="comment"> */</span>
  734. <a name="l00702"></a><a class="code" href="a01575.html#ga26a14b8dae3f861830af9e7cf1e03725">00702</a> <span class="preprocessor">#define uip_newdata() (uip_flags &amp; UIP_NEWDATA)</span>
  735. <a name="l00703"></a>00703 <span class="preprocessor"></span><span class="comment"></span>
  736. <a name="l00704"></a>00704 <span class="comment">/**</span>
  737. <a name="l00705"></a>00705 <span class="comment"> * Has previously sent data been acknowledged?</span>
  738. <a name="l00706"></a>00706 <span class="comment"> *</span>
  739. <a name="l00707"></a>00707 <span class="comment"> * Will reduce to non-zero if the previously sent data has been</span>
  740. <a name="l00708"></a>00708 <span class="comment"> * acknowledged by the remote host. This means that the application</span>
  741. <a name="l00709"></a>00709 <span class="comment"> * can send new data.</span>
  742. <a name="l00710"></a>00710 <span class="comment"> *</span>
  743. <a name="l00711"></a>00711 <span class="comment"> * \hideinitializer</span>
  744. <a name="l00712"></a>00712 <span class="comment"> */</span>
  745. <a name="l00713"></a><a class="code" href="a01575.html#gade6634974418e3240c212b9b16864368">00713</a> <span class="preprocessor">#define uip_acked() (uip_flags &amp; UIP_ACKDATA)</span>
  746. <a name="l00714"></a>00714 <span class="preprocessor"></span><span class="comment"></span>
  747. <a name="l00715"></a>00715 <span class="comment">/**</span>
  748. <a name="l00716"></a>00716 <span class="comment"> * Has the connection just been connected?</span>
  749. <a name="l00717"></a>00717 <span class="comment"> *</span>
  750. <a name="l00718"></a>00718 <span class="comment"> * Reduces to non-zero if the current connection has been connected to</span>
  751. <a name="l00719"></a>00719 <span class="comment"> * a remote host. This will happen both if the connection has been</span>
  752. <a name="l00720"></a>00720 <span class="comment"> * actively opened (with uip_connect()) or passively opened (with</span>
  753. <a name="l00721"></a>00721 <span class="comment"> * uip_listen()).</span>
  754. <a name="l00722"></a>00722 <span class="comment"> *</span>
  755. <a name="l00723"></a>00723 <span class="comment"> * \hideinitializer</span>
  756. <a name="l00724"></a>00724 <span class="comment"> */</span>
  757. <a name="l00725"></a><a class="code" href="a01575.html#gadb971fb1525d0c5002f52125b05f3218">00725</a> <span class="preprocessor">#define uip_connected() (uip_flags &amp; UIP_CONNECTED)</span>
  758. <a name="l00726"></a>00726 <span class="preprocessor"></span><span class="comment"></span>
  759. <a name="l00727"></a>00727 <span class="comment">/**</span>
  760. <a name="l00728"></a>00728 <span class="comment"> * Has the connection been closed by the other end?</span>
  761. <a name="l00729"></a>00729 <span class="comment"> *</span>
  762. <a name="l00730"></a>00730 <span class="comment"> * Is non-zero if the connection has been closed by the remote</span>
  763. <a name="l00731"></a>00731 <span class="comment"> * host. The application may then do the necessary clean-ups.</span>
  764. <a name="l00732"></a>00732 <span class="comment"> *</span>
  765. <a name="l00733"></a>00733 <span class="comment"> * \hideinitializer</span>
  766. <a name="l00734"></a>00734 <span class="comment"> */</span>
  767. <a name="l00735"></a><a class="code" href="a01575.html#gaef6c4140c632b6a406779342cf3b6eb6">00735</a> <span class="preprocessor">#define uip_closed() (uip_flags &amp; UIP_CLOSE)</span>
  768. <a name="l00736"></a>00736 <span class="preprocessor"></span><span class="comment"></span>
  769. <a name="l00737"></a>00737 <span class="comment">/**</span>
  770. <a name="l00738"></a>00738 <span class="comment"> * Has the connection been aborted by the other end?</span>
  771. <a name="l00739"></a>00739 <span class="comment"> *</span>
  772. <a name="l00740"></a>00740 <span class="comment"> * Non-zero if the current connection has been aborted (reset) by the</span>
  773. <a name="l00741"></a>00741 <span class="comment"> * remote host.</span>
  774. <a name="l00742"></a>00742 <span class="comment"> *</span>
  775. <a name="l00743"></a>00743 <span class="comment"> * \hideinitializer</span>
  776. <a name="l00744"></a>00744 <span class="comment"> */</span>
  777. <a name="l00745"></a><a class="code" href="a01575.html#gafbd5fc486dfdf6bf6fc9db52b1f418c4">00745</a> <span class="preprocessor">#define uip_aborted() (uip_flags &amp; UIP_ABORT)</span>
  778. <a name="l00746"></a>00746 <span class="preprocessor"></span><span class="comment"></span>
  779. <a name="l00747"></a>00747 <span class="comment">/**</span>
  780. <a name="l00748"></a>00748 <span class="comment"> * Has the connection timed out?</span>
  781. <a name="l00749"></a>00749 <span class="comment"> *</span>
  782. <a name="l00750"></a>00750 <span class="comment"> * Non-zero if the current connection has been aborted due to too many</span>
  783. <a name="l00751"></a>00751 <span class="comment"> * retransmissions.</span>
  784. <a name="l00752"></a>00752 <span class="comment"> *</span>
  785. <a name="l00753"></a>00753 <span class="comment"> * \hideinitializer</span>
  786. <a name="l00754"></a>00754 <span class="comment"> */</span>
  787. <a name="l00755"></a><a class="code" href="a01575.html#ga7b2ac4b18bd2ac3912fe67b3b17158c3">00755</a> <span class="preprocessor">#define uip_timedout() (uip_flags &amp; UIP_TIMEDOUT)</span>
  788. <a name="l00756"></a>00756 <span class="preprocessor"></span><span class="comment"></span>
  789. <a name="l00757"></a>00757 <span class="comment">/**</span>
  790. <a name="l00758"></a>00758 <span class="comment"> * Do we need to retransmit previously data?</span>
  791. <a name="l00759"></a>00759 <span class="comment"> *</span>
  792. <a name="l00760"></a>00760 <span class="comment"> * Reduces to non-zero if the previously sent data has been lost in</span>
  793. <a name="l00761"></a>00761 <span class="comment"> * the network, and the application should retransmit it. The</span>
  794. <a name="l00762"></a>00762 <span class="comment"> * application should send the exact same data as it did the last</span>
  795. <a name="l00763"></a>00763 <span class="comment"> * time, using the uip_send() function.</span>
  796. <a name="l00764"></a>00764 <span class="comment"> *</span>
  797. <a name="l00765"></a>00765 <span class="comment"> * \hideinitializer</span>
  798. <a name="l00766"></a>00766 <span class="comment"> */</span>
  799. <a name="l00767"></a><a class="code" href="a01575.html#gaa8933ad15a2e2947dae4a5cff50e6007">00767</a> <span class="preprocessor">#define uip_rexmit() (uip_flags &amp; UIP_REXMIT)</span>
  800. <a name="l00768"></a>00768 <span class="preprocessor"></span><span class="comment"></span>
  801. <a name="l00769"></a>00769 <span class="comment">/**</span>
  802. <a name="l00770"></a>00770 <span class="comment"> * Is the connection being polled by uIP?</span>
  803. <a name="l00771"></a>00771 <span class="comment"> *</span>
  804. <a name="l00772"></a>00772 <span class="comment"> * Is non-zero if the reason the application is invoked is that the</span>
  805. <a name="l00773"></a>00773 <span class="comment"> * current connection has been idle for a while and should be</span>
  806. <a name="l00774"></a>00774 <span class="comment"> * polled.</span>
  807. <a name="l00775"></a>00775 <span class="comment"> *</span>
  808. <a name="l00776"></a>00776 <span class="comment"> * The polling event can be used for sending data without having to</span>
  809. <a name="l00777"></a>00777 <span class="comment"> * wait for the remote host to send data.</span>
  810. <a name="l00778"></a>00778 <span class="comment"> *</span>
  811. <a name="l00779"></a>00779 <span class="comment"> * \hideinitializer</span>
  812. <a name="l00780"></a>00780 <span class="comment"> */</span>
  813. <a name="l00781"></a><a class="code" href="a01575.html#ga58bb90796c1cdad3aac2ecf44d87b20e">00781</a> <span class="preprocessor">#define uip_poll() (uip_flags &amp; UIP_POLL)</span>
  814. <a name="l00782"></a>00782 <span class="preprocessor"></span><span class="comment"></span>
  815. <a name="l00783"></a>00783 <span class="comment">/**</span>
  816. <a name="l00784"></a>00784 <span class="comment"> * Get the initial maximum segment size (MSS) of the current</span>
  817. <a name="l00785"></a>00785 <span class="comment"> * connection.</span>
  818. <a name="l00786"></a>00786 <span class="comment"> *</span>
  819. <a name="l00787"></a>00787 <span class="comment"> * \hideinitializer</span>
  820. <a name="l00788"></a>00788 <span class="comment"> */</span>
  821. <a name="l00789"></a><a class="code" href="a01575.html#gaa87feebc7cffd4d8300e776cf64e4fec">00789</a> <span class="preprocessor">#define uip_initialmss() (uip_conn-&gt;initialmss)</span>
  822. <a name="l00790"></a>00790 <span class="preprocessor"></span><span class="comment"></span>
  823. <a name="l00791"></a>00791 <span class="comment">/**</span>
  824. <a name="l00792"></a>00792 <span class="comment"> * Get the current maximum segment size that can be sent on the current</span>
  825. <a name="l00793"></a>00793 <span class="comment"> * connection.</span>
  826. <a name="l00794"></a>00794 <span class="comment"> *</span>
  827. <a name="l00795"></a>00795 <span class="comment"> * The current maximum segment size that can be sent on the</span>
  828. <a name="l00796"></a>00796 <span class="comment"> * connection is computed from the receiver&apos;s window and the MSS of</span>
  829. <a name="l00797"></a>00797 <span class="comment"> * the connection (which also is available by calling</span>
  830. <a name="l00798"></a>00798 <span class="comment"> * uip_initialmss()).</span>
  831. <a name="l00799"></a>00799 <span class="comment"> *</span>
  832. <a name="l00800"></a>00800 <span class="comment"> * \hideinitializer</span>
  833. <a name="l00801"></a>00801 <span class="comment"> */</span>
  834. <a name="l00802"></a><a class="code" href="a01575.html#gab5fecbc62edd128012cea0f47b57ab9f">00802</a> <span class="preprocessor">#define uip_mss() (uip_conn-&gt;mss)</span>
  835. <a name="l00803"></a>00803 <span class="preprocessor"></span><span class="comment"></span>
  836. <a name="l00804"></a>00804 <span class="comment">/**</span>
  837. <a name="l00805"></a>00805 <span class="comment"> * Set up a new UDP connection.</span>
  838. <a name="l00806"></a>00806 <span class="comment"> *</span>
  839. <a name="l00807"></a>00807 <span class="comment"> * This function sets up a new UDP connection. The function will</span>
  840. <a name="l00808"></a>00808 <span class="comment"> * automatically allocate an unused local port for the new</span>
  841. <a name="l00809"></a>00809 <span class="comment"> * connection. However, another port can be chosen by using the</span>
  842. <a name="l00810"></a>00810 <span class="comment"> * uip_udp_bind() call, after the uip_udp_new() function has been</span>
  843. <a name="l00811"></a>00811 <span class="comment"> * called.</span>
  844. <a name="l00812"></a>00812 <span class="comment"> *</span>
  845. <a name="l00813"></a>00813 <span class="comment"> * Example:</span>
  846. <a name="l00814"></a>00814 <span class="comment"> \code</span>
  847. <a name="l00815"></a>00815 <span class="comment"> uip_ipaddr_t addr;</span>
  848. <a name="l00816"></a>00816 <span class="comment"> struct uip_udp_conn *c;</span>
  849. <a name="l00817"></a>00817 <span class="comment"> </span>
  850. <a name="l00818"></a>00818 <span class="comment"> uip_ipaddr(&amp;addr, 192,168,2,1);</span>
  851. <a name="l00819"></a>00819 <span class="comment"> c = uip_udp_new(&amp;addr, UIP_HTONS(12345));</span>
  852. <a name="l00820"></a>00820 <span class="comment"> if(c != NULL) {</span>
  853. <a name="l00821"></a>00821 <span class="comment"> uip_udp_bind(c, UIP_HTONS(12344));</span>
  854. <a name="l00822"></a>00822 <span class="comment"> }</span>
  855. <a name="l00823"></a>00823 <span class="comment"> \endcode</span>
  856. <a name="l00824"></a>00824 <span class="comment"> * \param ripaddr The IP address of the remote host.</span>
  857. <a name="l00825"></a>00825 <span class="comment"> *</span>
  858. <a name="l00826"></a>00826 <span class="comment"> * \param rport The remote port number in network byte order.</span>
  859. <a name="l00827"></a>00827 <span class="comment"> *</span>
  860. <a name="l00828"></a>00828 <span class="comment"> * \return The uip_udp_conn structure for the new connection or NULL</span>
  861. <a name="l00829"></a>00829 <span class="comment"> * if no connection could be allocated.</span>
  862. <a name="l00830"></a>00830 <span class="comment"> */</span>
  863. <a name="l00831"></a>00831 <span class="keyword">struct </span><a class="code" href="a00119.html" title="Representation of a uIP UDP connection.">uip_udp_conn</a> *<a class="code" href="a01684.html#ga5703bad3c0154b02715260ddf6b612a2" title="Set up a new UDP connection.">uip_udp_new</a>(<span class="keyword">const</span> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> *<a class="code" href="a00119.html#a8a661a2d544100b82d0d14a1985083d5" title="The IP address of the remote peer.">ripaddr</a>, <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00119.html#a280a0c2a93544e597f92bbacf36ee1dc" title="The remote port number in network byte order.">rport</a>);
  864. <a name="l00832"></a>00832 <span class="comment"></span>
  865. <a name="l00833"></a>00833 <span class="comment">/**</span>
  866. <a name="l00834"></a>00834 <span class="comment"> * Removed a UDP connection.</span>
  867. <a name="l00835"></a>00835 <span class="comment"> *</span>
  868. <a name="l00836"></a>00836 <span class="comment"> * \param conn A pointer to the uip_udp_conn structure for the connection.</span>
  869. <a name="l00837"></a>00837 <span class="comment"> *</span>
  870. <a name="l00838"></a>00838 <span class="comment"> * \hideinitializer</span>
  871. <a name="l00839"></a>00839 <span class="comment"> */</span>
  872. <a name="l00840"></a><a class="code" href="a01575.html#gaf2dbaceb10c67783a115075b5b6d66df">00840</a> <span class="preprocessor">#define uip_udp_remove(conn) (conn)-&gt;lport = 0</span>
  873. <a name="l00841"></a>00841 <span class="preprocessor"></span><span class="comment"></span>
  874. <a name="l00842"></a>00842 <span class="comment">/**</span>
  875. <a name="l00843"></a>00843 <span class="comment"> * Bind a UDP connection to a local port.</span>
  876. <a name="l00844"></a>00844 <span class="comment"> *</span>
  877. <a name="l00845"></a>00845 <span class="comment"> * \param conn A pointer to the uip_udp_conn structure for the</span>
  878. <a name="l00846"></a>00846 <span class="comment"> * connection.</span>
  879. <a name="l00847"></a>00847 <span class="comment"> *</span>
  880. <a name="l00848"></a>00848 <span class="comment"> * \param port The local port number, in network byte order.</span>
  881. <a name="l00849"></a>00849 <span class="comment"> *</span>
  882. <a name="l00850"></a>00850 <span class="comment"> * \hideinitializer</span>
  883. <a name="l00851"></a>00851 <span class="comment"> */</span>
  884. <a name="l00852"></a><a class="code" href="a01575.html#gaa20812098a4663c8a9fc4ce8e95391b6">00852</a> <span class="preprocessor">#define uip_udp_bind(conn, port) (conn)-&gt;lport = port</span>
  885. <a name="l00853"></a>00853 <span class="preprocessor"></span><span class="comment"></span>
  886. <a name="l00854"></a>00854 <span class="comment">/**</span>
  887. <a name="l00855"></a>00855 <span class="comment"> * Send a UDP datagram of length len on the current connection.</span>
  888. <a name="l00856"></a>00856 <span class="comment"> *</span>
  889. <a name="l00857"></a>00857 <span class="comment"> * This function can only be called in response to a UDP event (poll</span>
  890. <a name="l00858"></a>00858 <span class="comment"> * or newdata). The data must be present in the uip_buf buffer, at the</span>
  891. <a name="l00859"></a>00859 <span class="comment"> * place pointed to by the uip_appdata pointer.</span>
  892. <a name="l00860"></a>00860 <span class="comment"> *</span>
  893. <a name="l00861"></a>00861 <span class="comment"> * \param len The length of the data in the uip_buf buffer.</span>
  894. <a name="l00862"></a>00862 <span class="comment"> *</span>
  895. <a name="l00863"></a>00863 <span class="comment"> * \hideinitializer</span>
  896. <a name="l00864"></a>00864 <span class="comment"> */</span>
  897. <a name="l00865"></a><a class="code" href="a01575.html#gae5ab69d40013e6cf86ef1763c95d920e">00865</a> <span class="preprocessor">#define uip_udp_send(len) uip_send((char *)uip_appdata, len)</span>
  898. <a name="l00866"></a>00866 <span class="preprocessor"></span><span class="comment"></span>
  899. <a name="l00867"></a>00867 <span class="comment">/** @} */</span>
  900. <a name="l00868"></a>00868
  901. <a name="l00869"></a>00869 <span class="comment">/* uIP convenience and converting functions. */</span>
  902. <a name="l00870"></a>00870 <span class="comment"></span>
  903. <a name="l00871"></a>00871 <span class="comment">/**</span>
  904. <a name="l00872"></a>00872 <span class="comment"> * \defgroup uipconvfunc uIP conversion functions</span>
  905. <a name="l00873"></a>00873 <span class="comment"> * @{</span>
  906. <a name="l00874"></a>00874 <span class="comment"> *</span>
  907. <a name="l00875"></a>00875 <span class="comment"> * These functions can be used for converting between different data</span>
  908. <a name="l00876"></a>00876 <span class="comment"> * formats used by uIP.</span>
  909. <a name="l00877"></a>00877 <span class="comment"> */</span>
  910. <a name="l00878"></a>00878 <span class="comment"></span>
  911. <a name="l00879"></a>00879 <span class="comment">/**</span>
  912. <a name="l00880"></a>00880 <span class="comment"> * Convert an IP address to four bytes separated by commas.</span>
  913. <a name="l00881"></a>00881 <span class="comment"> *</span>
  914. <a name="l00882"></a>00882 <span class="comment"> * Example:</span>
  915. <a name="l00883"></a>00883 <span class="comment"> \code</span>
  916. <a name="l00884"></a>00884 <span class="comment"> uip_ipaddr_t ipaddr;</span>
  917. <a name="l00885"></a>00885 <span class="comment"> printf(&quot;ipaddr=%d.%d.%d.%d\n&quot;, uip_ipaddr_to_quad(&amp;ipaddr));</span>
  918. <a name="l00886"></a>00886 <span class="comment"> \endcode</span>
  919. <a name="l00887"></a>00887 <span class="comment"> *</span>
  920. <a name="l00888"></a>00888 <span class="comment"> * \param a A pointer to a uip_ipaddr_t.</span>
  921. <a name="l00889"></a>00889 <span class="comment"> * \hideinitializer</span>
  922. <a name="l00890"></a>00890 <span class="comment"> */</span>
  923. <a name="l00891"></a><a class="code" href="a01576.html#gab6ae63b3e36da2ea6598ea91ad049516">00891</a> <span class="preprocessor">#define uip_ipaddr_to_quad(a) (a)-&gt;u8[0],(a)-&gt;u8[1],(a)-&gt;u8[2],(a)-&gt;u8[3]</span>
  924. <a name="l00892"></a>00892 <span class="preprocessor"></span><span class="comment"></span>
  925. <a name="l00893"></a>00893 <span class="comment">/**</span>
  926. <a name="l00894"></a>00894 <span class="comment"> * Construct an IP address from four bytes.</span>
  927. <a name="l00895"></a>00895 <span class="comment"> *</span>
  928. <a name="l00896"></a>00896 <span class="comment"> * This function constructs an IP address of the type that uIP handles</span>
  929. <a name="l00897"></a>00897 <span class="comment"> * internally from four bytes. The function is handy for specifying IP</span>
  930. <a name="l00898"></a>00898 <span class="comment"> * addresses to use with e.g. the uip_connect() function.</span>
  931. <a name="l00899"></a>00899 <span class="comment"> *</span>
  932. <a name="l00900"></a>00900 <span class="comment"> * Example:</span>
  933. <a name="l00901"></a>00901 <span class="comment"> \code</span>
  934. <a name="l00902"></a>00902 <span class="comment"> uip_ipaddr_t ipaddr;</span>
  935. <a name="l00903"></a>00903 <span class="comment"> struct uip_conn *c;</span>
  936. <a name="l00904"></a>00904 <span class="comment"> </span>
  937. <a name="l00905"></a>00905 <span class="comment"> uip_ipaddr(&amp;ipaddr, 192,168,1,2);</span>
  938. <a name="l00906"></a>00906 <span class="comment"> c = uip_connect(&amp;ipaddr, UIP_HTONS(80));</span>
  939. <a name="l00907"></a>00907 <span class="comment"> \endcode</span>
  940. <a name="l00908"></a>00908 <span class="comment"> *</span>
  941. <a name="l00909"></a>00909 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
  942. <a name="l00910"></a>00910 <span class="comment"> * filled in with the IP address.</span>
  943. <a name="l00911"></a>00911 <span class="comment"> *</span>
  944. <a name="l00912"></a>00912 <span class="comment"> * \param addr0 The first octet of the IP address.</span>
  945. <a name="l00913"></a>00913 <span class="comment"> * \param addr1 The second octet of the IP address.</span>
  946. <a name="l00914"></a>00914 <span class="comment"> * \param addr2 The third octet of the IP address.</span>
  947. <a name="l00915"></a>00915 <span class="comment"> * \param addr3 The forth octet of the IP address.</span>
  948. <a name="l00916"></a>00916 <span class="comment"> *</span>
  949. <a name="l00917"></a>00917 <span class="comment"> * \hideinitializer</span>
  950. <a name="l00918"></a>00918 <span class="comment"> */</span>
  951. <a name="l00919"></a><a class="code" href="a01576.html#ga87f0b54ade0d159fba495089128a4932">00919</a> <span class="preprocessor">#define uip_ipaddr(addr, addr0,addr1,addr2,addr3) do { \</span>
  952. <a name="l00920"></a>00920 <span class="preprocessor"> (addr)-&gt;u8[0] = addr0; \</span>
  953. <a name="l00921"></a>00921 <span class="preprocessor"> (addr)-&gt;u8[1] = addr1; \</span>
  954. <a name="l00922"></a>00922 <span class="preprocessor"> (addr)-&gt;u8[2] = addr2; \</span>
  955. <a name="l00923"></a>00923 <span class="preprocessor"> (addr)-&gt;u8[3] = addr3; \</span>
  956. <a name="l00924"></a>00924 <span class="preprocessor"> } while(0)</span>
  957. <a name="l00925"></a>00925 <span class="preprocessor"></span><span class="comment"></span>
  958. <a name="l00926"></a>00926 <span class="comment">/**</span>
  959. <a name="l00927"></a>00927 <span class="comment"> * Construct an IPv6 address from eight 16-bit words.</span>
  960. <a name="l00928"></a>00928 <span class="comment"> *</span>
  961. <a name="l00929"></a>00929 <span class="comment"> * This function constructs an IPv6 address.</span>
  962. <a name="l00930"></a>00930 <span class="comment"> *</span>
  963. <a name="l00931"></a>00931 <span class="comment"> * \hideinitializer</span>
  964. <a name="l00932"></a>00932 <span class="comment"> */</span>
  965. <a name="l00933"></a><a class="code" href="a01576.html#ga53fbda0e8c31d4882294c8dc3cb5f487">00933</a> <span class="preprocessor">#define uip_ip6addr(addr, addr0,addr1,addr2,addr3,addr4,addr5,addr6,addr7) do { \</span>
  966. <a name="l00934"></a>00934 <span class="preprocessor"> (addr)-&gt;u16[0] = UIP_HTONS(addr0); \</span>
  967. <a name="l00935"></a>00935 <span class="preprocessor"> (addr)-&gt;u16[1] = UIP_HTONS(addr1); \</span>
  968. <a name="l00936"></a>00936 <span class="preprocessor"> (addr)-&gt;u16[2] = UIP_HTONS(addr2); \</span>
  969. <a name="l00937"></a>00937 <span class="preprocessor"> (addr)-&gt;u16[3] = UIP_HTONS(addr3); \</span>
  970. <a name="l00938"></a>00938 <span class="preprocessor"> (addr)-&gt;u16[4] = UIP_HTONS(addr4); \</span>
  971. <a name="l00939"></a>00939 <span class="preprocessor"> (addr)-&gt;u16[5] = UIP_HTONS(addr5); \</span>
  972. <a name="l00940"></a>00940 <span class="preprocessor"> (addr)-&gt;u16[6] = UIP_HTONS(addr6); \</span>
  973. <a name="l00941"></a>00941 <span class="preprocessor"> (addr)-&gt;u16[7] = UIP_HTONS(addr7); \</span>
  974. <a name="l00942"></a>00942 <span class="preprocessor"> } while(0)</span>
  975. <a name="l00943"></a>00943 <span class="preprocessor"></span><span class="comment"></span>
  976. <a name="l00944"></a>00944 <span class="comment">/**</span>
  977. <a name="l00945"></a>00945 <span class="comment"> * Construct an IPv6 address from eight 8-bit words.</span>
  978. <a name="l00946"></a>00946 <span class="comment"> *</span>
  979. <a name="l00947"></a>00947 <span class="comment"> * This function constructs an IPv6 address.</span>
  980. <a name="l00948"></a>00948 <span class="comment"> *</span>
  981. <a name="l00949"></a>00949 <span class="comment"> * \hideinitializer</span>
  982. <a name="l00950"></a>00950 <span class="comment"> */</span>
  983. <a name="l00951"></a><a class="code" href="a01576.html#ga3b6203a969d07b25be717bf04f0a0a99">00951</a> <span class="preprocessor">#define uip_ip6addr_u8(addr, addr0,addr1,addr2,addr3,addr4,addr5,addr6,addr7,addr8,addr9,addr10,addr11,addr12,addr13,addr14,addr15) do { \</span>
  984. <a name="l00952"></a>00952 <span class="preprocessor"> (addr)-&gt;u8[0] = addr0; \</span>
  985. <a name="l00953"></a>00953 <span class="preprocessor"> (addr)-&gt;u8[1] = addr1; \</span>
  986. <a name="l00954"></a>00954 <span class="preprocessor"> (addr)-&gt;u8[2] = addr2; \</span>
  987. <a name="l00955"></a>00955 <span class="preprocessor"> (addr)-&gt;u8[3] = addr3; \</span>
  988. <a name="l00956"></a>00956 <span class="preprocessor"> (addr)-&gt;u8[4] = addr4; \</span>
  989. <a name="l00957"></a>00957 <span class="preprocessor"> (addr)-&gt;u8[5] = addr5; \</span>
  990. <a name="l00958"></a>00958 <span class="preprocessor"> (addr)-&gt;u8[6] = addr6; \</span>
  991. <a name="l00959"></a>00959 <span class="preprocessor"> (addr)-&gt;u8[7] = addr7; \</span>
  992. <a name="l00960"></a>00960 <span class="preprocessor"> (addr)-&gt;u8[8] = addr8; \</span>
  993. <a name="l00961"></a>00961 <span class="preprocessor"> (addr)-&gt;u8[9] = addr9; \</span>
  994. <a name="l00962"></a>00962 <span class="preprocessor"> (addr)-&gt;u8[10] = addr10; \</span>
  995. <a name="l00963"></a>00963 <span class="preprocessor"> (addr)-&gt;u8[11] = addr11; \</span>
  996. <a name="l00964"></a>00964 <span class="preprocessor"> (addr)-&gt;u8[12] = addr12; \</span>
  997. <a name="l00965"></a>00965 <span class="preprocessor"> (addr)-&gt;u8[13] = addr13; \</span>
  998. <a name="l00966"></a>00966 <span class="preprocessor"> (addr)-&gt;u8[14] = addr14; \</span>
  999. <a name="l00967"></a>00967 <span class="preprocessor"> (addr)-&gt;u8[15] = addr15; \</span>
  1000. <a name="l00968"></a>00968 <span class="preprocessor"> } while(0)</span>
  1001. <a name="l00969"></a>00969 <span class="preprocessor"></span>
  1002. <a name="l00970"></a>00970 <span class="comment"></span>
  1003. <a name="l00971"></a>00971 <span class="comment">/**</span>
  1004. <a name="l00972"></a>00972 <span class="comment"> * Copy an IP address to another IP address.</span>
  1005. <a name="l00973"></a>00973 <span class="comment"> *</span>
  1006. <a name="l00974"></a>00974 <span class="comment"> * Copies an IP address from one place to another.</span>
  1007. <a name="l00975"></a>00975 <span class="comment"> *</span>
  1008. <a name="l00976"></a>00976 <span class="comment"> * Example:</span>
  1009. <a name="l00977"></a>00977 <span class="comment"> \code</span>
  1010. <a name="l00978"></a>00978 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2;</span>
  1011. <a name="l00979"></a>00979 <span class="comment"></span>
  1012. <a name="l00980"></a>00980 <span class="comment"> uip_ipaddr(&amp;ipaddr1, 192,16,1,2);</span>
  1013. <a name="l00981"></a>00981 <span class="comment"> uip_ipaddr_copy(&amp;ipaddr2, &amp;ipaddr1);</span>
  1014. <a name="l00982"></a>00982 <span class="comment"> \endcode</span>
  1015. <a name="l00983"></a>00983 <span class="comment"> *</span>
  1016. <a name="l00984"></a>00984 <span class="comment"> * \param dest The destination for the copy.</span>
  1017. <a name="l00985"></a>00985 <span class="comment"> * \param src The source from where to copy.</span>
  1018. <a name="l00986"></a>00986 <span class="comment"> *</span>
  1019. <a name="l00987"></a>00987 <span class="comment"> * \hideinitializer</span>
  1020. <a name="l00988"></a>00988 <span class="comment"> */</span>
  1021. <a name="l00989"></a>00989 <span class="preprocessor">#ifndef uip_ipaddr_copy</span>
  1022. <a name="l00990"></a><a class="code" href="a01576.html#ga769512993b7b27271909d6daa4748b60">00990</a> <span class="preprocessor"></span><span class="preprocessor">#define uip_ipaddr_copy(dest, src) (*(dest) = *(src))</span>
  1023. <a name="l00991"></a>00991 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
  1024. <a name="l00992"></a>00992 <span class="preprocessor"></span><span class="comment"></span>
  1025. <a name="l00993"></a>00993 <span class="comment">/**</span>
  1026. <a name="l00994"></a>00994 <span class="comment"> * Compare two IP addresses</span>
  1027. <a name="l00995"></a>00995 <span class="comment"> *</span>
  1028. <a name="l00996"></a>00996 <span class="comment"> * Compares two IP addresses.</span>
  1029. <a name="l00997"></a>00997 <span class="comment"> *</span>
  1030. <a name="l00998"></a>00998 <span class="comment"> * Example:</span>
  1031. <a name="l00999"></a>00999 <span class="comment"> \code</span>
  1032. <a name="l01000"></a>01000 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2;</span>
  1033. <a name="l01001"></a>01001 <span class="comment"></span>
  1034. <a name="l01002"></a>01002 <span class="comment"> uip_ipaddr(&amp;ipaddr1, 192,16,1,2);</span>
  1035. <a name="l01003"></a>01003 <span class="comment"> if(uip_ipaddr_cmp(&amp;ipaddr2, &amp;ipaddr1)) {</span>
  1036. <a name="l01004"></a>01004 <span class="comment"> printf(&quot;They are the same&quot;);</span>
  1037. <a name="l01005"></a>01005 <span class="comment"> }</span>
  1038. <a name="l01006"></a>01006 <span class="comment"> \endcode</span>
  1039. <a name="l01007"></a>01007 <span class="comment"> *</span>
  1040. <a name="l01008"></a>01008 <span class="comment"> * \param addr1 The first IP address.</span>
  1041. <a name="l01009"></a>01009 <span class="comment"> * \param addr2 The second IP address.</span>
  1042. <a name="l01010"></a>01010 <span class="comment"> *</span>
  1043. <a name="l01011"></a>01011 <span class="comment"> * \hideinitializer</span>
  1044. <a name="l01012"></a>01012 <span class="comment"> */</span>
  1045. <a name="l01013"></a>01013 <span class="preprocessor">#if !UIP_CONF_IPV6</span>
  1046. <a name="l01014"></a><a class="code" href="a01576.html#ga210e629f7252e4bc8458cbdf260b3318">01014</a> <span class="preprocessor"></span><span class="preprocessor">#define uip_ipaddr_cmp(addr1, addr2) ((addr1)-&gt;u16[0] == (addr2)-&gt;u16[0] &amp;&amp; \</span>
  1047. <a name="l01015"></a>01015 <span class="preprocessor"> (addr1)-&gt;u16[1] == (addr2)-&gt;u16[1])</span>
  1048. <a name="l01016"></a>01016 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
  1049. <a name="l01017"></a>01017 <span class="preprocessor">#define uip_ipaddr_cmp(addr1, addr2) (memcmp(addr1, addr2, sizeof(uip_ip6addr_t)) == 0)</span>
  1050. <a name="l01018"></a>01018 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
  1051. <a name="l01019"></a>01019 <span class="comment"></span>
  1052. <a name="l01020"></a>01020 <span class="comment">/**</span>
  1053. <a name="l01021"></a>01021 <span class="comment"> * Compare two IP addresses with netmasks</span>
  1054. <a name="l01022"></a>01022 <span class="comment"> *</span>
  1055. <a name="l01023"></a>01023 <span class="comment"> * Compares two IP addresses with netmasks. The masks are used to mask</span>
  1056. <a name="l01024"></a>01024 <span class="comment"> * out the bits that are to be compared.</span>
  1057. <a name="l01025"></a>01025 <span class="comment"> *</span>
  1058. <a name="l01026"></a>01026 <span class="comment"> * Example:</span>
  1059. <a name="l01027"></a>01027 <span class="comment"> \code</span>
  1060. <a name="l01028"></a>01028 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2, mask;</span>
  1061. <a name="l01029"></a>01029 <span class="comment"></span>
  1062. <a name="l01030"></a>01030 <span class="comment"> uip_ipaddr(&amp;mask, 255,255,255,0);</span>
  1063. <a name="l01031"></a>01031 <span class="comment"> uip_ipaddr(&amp;ipaddr1, 192,16,1,2);</span>
  1064. <a name="l01032"></a>01032 <span class="comment"> uip_ipaddr(&amp;ipaddr2, 192,16,1,3);</span>
  1065. <a name="l01033"></a>01033 <span class="comment"> if(uip_ipaddr_maskcmp(&amp;ipaddr1, &amp;ipaddr2, &amp;mask)) {</span>
  1066. <a name="l01034"></a>01034 <span class="comment"> printf(&quot;They are the same&quot;);</span>
  1067. <a name="l01035"></a>01035 <span class="comment"> }</span>
  1068. <a name="l01036"></a>01036 <span class="comment"> \endcode</span>
  1069. <a name="l01037"></a>01037 <span class="comment"> *</span>
  1070. <a name="l01038"></a>01038 <span class="comment"> * \param addr1 The first IP address.</span>
  1071. <a name="l01039"></a>01039 <span class="comment"> * \param addr2 The second IP address.</span>
  1072. <a name="l01040"></a>01040 <span class="comment"> * \param mask The netmask.</span>
  1073. <a name="l01041"></a>01041 <span class="comment"> *</span>
  1074. <a name="l01042"></a>01042 <span class="comment"> * \hideinitializer</span>
  1075. <a name="l01043"></a>01043 <span class="comment"> */</span>
  1076. <a name="l01044"></a>01044 <span class="preprocessor">#if !UIP_CONF_IPV6</span>
  1077. <a name="l01045"></a><a class="code" href="a01576.html#ga6b16e0bac41821c1fbe0c267071642f0">01045</a> <span class="preprocessor"></span><span class="preprocessor">#define uip_ipaddr_maskcmp(addr1, addr2, mask) \</span>
  1078. <a name="l01046"></a>01046 <span class="preprocessor"> (((((u16_t *)addr1)[0] &amp; ((u16_t *)mask)[0]) == \</span>
  1079. <a name="l01047"></a>01047 <span class="preprocessor"> (((u16_t *)addr2)[0] &amp; ((u16_t *)mask)[0])) &amp;&amp; \</span>
  1080. <a name="l01048"></a>01048 <span class="preprocessor"> ((((u16_t *)addr1)[1] &amp; ((u16_t *)mask)[1]) == \</span>
  1081. <a name="l01049"></a>01049 <span class="preprocessor"> (((u16_t *)addr2)[1] &amp; ((u16_t *)mask)[1])))</span>
  1082. <a name="l01050"></a>01050 <span class="preprocessor"></span><span class="preprocessor">#else</span>
  1083. <a name="l01051"></a>01051 <span class="preprocessor"></span><span class="preprocessor">#define uip_ipaddr_prefixcmp(addr1, addr2, length) (memcmp(addr1, addr2, length&gt;&gt;3) == 0)</span>
  1084. <a name="l01052"></a>01052 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
  1085. <a name="l01053"></a>01053 <span class="preprocessor"></span>
  1086. <a name="l01054"></a>01054 <span class="comment"></span>
  1087. <a name="l01055"></a>01055 <span class="comment">/**</span>
  1088. <a name="l01056"></a>01056 <span class="comment"> * Check if an address is a broadcast address for a network.</span>
  1089. <a name="l01057"></a>01057 <span class="comment"> *</span>
  1090. <a name="l01058"></a>01058 <span class="comment"> * Checks if an address is the broadcast address for a network. The</span>
  1091. <a name="l01059"></a>01059 <span class="comment"> * network is defined by an IP address that is on the network and the</span>
  1092. <a name="l01060"></a>01060 <span class="comment"> * network&apos;s netmask.</span>
  1093. <a name="l01061"></a>01061 <span class="comment"> *</span>
  1094. <a name="l01062"></a>01062 <span class="comment"> * \param addr The IP address.</span>
  1095. <a name="l01063"></a>01063 <span class="comment"> * \param netaddr The network&apos;s IP address.</span>
  1096. <a name="l01064"></a>01064 <span class="comment"> * \param netmask The network&apos;s netmask.</span>
  1097. <a name="l01065"></a>01065 <span class="comment"> *</span>
  1098. <a name="l01066"></a>01066 <span class="comment"> * \hideinitializer</span>
  1099. <a name="l01067"></a>01067 <span class="comment"> */</span>
  1100. <a name="l01068"></a>01068 <span class="comment">/*#define uip_ipaddr_isbroadcast(addr, netaddr, netmask)</span>
  1101. <a name="l01069"></a>01069 <span class="comment"> ((uip_ipaddr_t *)(addr)).u16 &amp; ((uip_ipaddr_t *)(addr)).u16*/</span>
  1102. <a name="l01070"></a>01070
  1103. <a name="l01071"></a>01071
  1104. <a name="l01072"></a>01072 <span class="comment"></span>
  1105. <a name="l01073"></a>01073 <span class="comment">/**</span>
  1106. <a name="l01074"></a>01074 <span class="comment"> * Mask out the network part of an IP address.</span>
  1107. <a name="l01075"></a>01075 <span class="comment"> *</span>
  1108. <a name="l01076"></a>01076 <span class="comment"> * Masks out the network part of an IP address, given the address and</span>
  1109. <a name="l01077"></a>01077 <span class="comment"> * the netmask.</span>
  1110. <a name="l01078"></a>01078 <span class="comment"> *</span>
  1111. <a name="l01079"></a>01079 <span class="comment"> * Example:</span>
  1112. <a name="l01080"></a>01080 <span class="comment"> \code</span>
  1113. <a name="l01081"></a>01081 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2, netmask;</span>
  1114. <a name="l01082"></a>01082 <span class="comment"></span>
  1115. <a name="l01083"></a>01083 <span class="comment"> uip_ipaddr(&amp;ipaddr1, 192,16,1,2);</span>
  1116. <a name="l01084"></a>01084 <span class="comment"> uip_ipaddr(&amp;netmask, 255,255,255,0);</span>
  1117. <a name="l01085"></a>01085 <span class="comment"> uip_ipaddr_mask(&amp;ipaddr2, &amp;ipaddr1, &amp;netmask);</span>
  1118. <a name="l01086"></a>01086 <span class="comment"> \endcode</span>
  1119. <a name="l01087"></a>01087 <span class="comment"> *</span>
  1120. <a name="l01088"></a>01088 <span class="comment"> * In the example above, the variable &quot;ipaddr2&quot; will contain the IP</span>
  1121. <a name="l01089"></a>01089 <span class="comment"> * address 192.168.1.0.</span>
  1122. <a name="l01090"></a>01090 <span class="comment"> *</span>
  1123. <a name="l01091"></a>01091 <span class="comment"> * \param dest Where the result is to be placed.</span>
  1124. <a name="l01092"></a>01092 <span class="comment"> * \param src The IP address.</span>
  1125. <a name="l01093"></a>01093 <span class="comment"> * \param mask The netmask.</span>
  1126. <a name="l01094"></a>01094 <span class="comment"> *</span>
  1127. <a name="l01095"></a>01095 <span class="comment"> * \hideinitializer</span>
  1128. <a name="l01096"></a>01096 <span class="comment"> */</span>
  1129. <a name="l01097"></a><a class="code" href="a01576.html#ga969d7fff37a979737da045e0d538a9bd">01097</a> <span class="preprocessor">#define uip_ipaddr_mask(dest, src, mask) do { \</span>
  1130. <a name="l01098"></a>01098 <span class="preprocessor"> ((u16_t *)dest)[0] = ((u16_t *)src)[0] &amp; ((u16_t *)mask)[0]; \</span>
  1131. <a name="l01099"></a>01099 <span class="preprocessor"> ((u16_t *)dest)[1] = ((u16_t *)src)[1] &amp; ((u16_t *)mask)[1]; \</span>
  1132. <a name="l01100"></a>01100 <span class="preprocessor"> } while(0)</span>
  1133. <a name="l01101"></a>01101 <span class="preprocessor"></span><span class="comment"></span>
  1134. <a name="l01102"></a>01102 <span class="comment">/**</span>
  1135. <a name="l01103"></a>01103 <span class="comment"> * Pick the first octet of an IP address.</span>
  1136. <a name="l01104"></a>01104 <span class="comment"> *</span>
  1137. <a name="l01105"></a>01105 <span class="comment"> * Picks out the first octet of an IP address.</span>
  1138. <a name="l01106"></a>01106 <span class="comment"> *</span>
  1139. <a name="l01107"></a>01107 <span class="comment"> * Example:</span>
  1140. <a name="l01108"></a>01108 <span class="comment"> \code</span>
  1141. <a name="l01109"></a>01109 <span class="comment"> uip_ipaddr_t ipaddr;</span>
  1142. <a name="l01110"></a>01110 <span class="comment"> u8_t octet;</span>
  1143. <a name="l01111"></a>01111 <span class="comment"></span>
  1144. <a name="l01112"></a>01112 <span class="comment"> uip_ipaddr(&amp;ipaddr, 1,2,3,4);</span>
  1145. <a name="l01113"></a>01113 <span class="comment"> octet = uip_ipaddr1(&amp;ipaddr);</span>
  1146. <a name="l01114"></a>01114 <span class="comment"> \endcode</span>
  1147. <a name="l01115"></a>01115 <span class="comment"> *</span>
  1148. <a name="l01116"></a>01116 <span class="comment"> * In the example above, the variable &quot;octet&quot; will contain the value 1.</span>
  1149. <a name="l01117"></a>01117 <span class="comment"> *</span>
  1150. <a name="l01118"></a>01118 <span class="comment"> * \hideinitializer</span>
  1151. <a name="l01119"></a>01119 <span class="comment"> */</span>
  1152. <a name="l01120"></a><a class="code" href="a01576.html#ga22fa0681cd463191d7a01fe85d86996f">01120</a> <span class="preprocessor">#define uip_ipaddr1(addr) ((addr)-&gt;u8[0])</span>
  1153. <a name="l01121"></a>01121 <span class="preprocessor"></span><span class="comment"></span>
  1154. <a name="l01122"></a>01122 <span class="comment">/**</span>
  1155. <a name="l01123"></a>01123 <span class="comment"> * Pick the second octet of an IP address.</span>
  1156. <a name="l01124"></a>01124 <span class="comment"> *</span>
  1157. <a name="l01125"></a>01125 <span class="comment"> * Picks out the second octet of an IP address.</span>
  1158. <a name="l01126"></a>01126 <span class="comment"> *</span>
  1159. <a name="l01127"></a>01127 <span class="comment"> * Example:</span>
  1160. <a name="l01128"></a>01128 <span class="comment"> \code</span>
  1161. <a name="l01129"></a>01129 <span class="comment"> uip_ipaddr_t ipaddr;</span>
  1162. <a name="l01130"></a>01130 <span class="comment"> u8_t octet;</span>
  1163. <a name="l01131"></a>01131 <span class="comment"></span>
  1164. <a name="l01132"></a>01132 <span class="comment"> uip_ipaddr(&amp;ipaddr, 1,2,3,4);</span>
  1165. <a name="l01133"></a>01133 <span class="comment"> octet = uip_ipaddr2(&amp;ipaddr);</span>
  1166. <a name="l01134"></a>01134 <span class="comment"> \endcode</span>
  1167. <a name="l01135"></a>01135 <span class="comment"> *</span>
  1168. <a name="l01136"></a>01136 <span class="comment"> * In the example above, the variable &quot;octet&quot; will contain the value 2.</span>
  1169. <a name="l01137"></a>01137 <span class="comment"> *</span>
  1170. <a name="l01138"></a>01138 <span class="comment"> * \hideinitializer</span>
  1171. <a name="l01139"></a>01139 <span class="comment"> */</span>
  1172. <a name="l01140"></a><a class="code" href="a01576.html#gaffcd2fbe181e2aaefbf970551c302af5">01140</a> <span class="preprocessor">#define uip_ipaddr2(addr) ((addr)-&gt;u8[1])</span>
  1173. <a name="l01141"></a>01141 <span class="preprocessor"></span><span class="comment"></span>
  1174. <a name="l01142"></a>01142 <span class="comment">/**</span>
  1175. <a name="l01143"></a>01143 <span class="comment"> * Pick the third octet of an IP address.</span>
  1176. <a name="l01144"></a>01144 <span class="comment"> *</span>
  1177. <a name="l01145"></a>01145 <span class="comment"> * Picks out the third octet of an IP address.</span>
  1178. <a name="l01146"></a>01146 <span class="comment"> *</span>
  1179. <a name="l01147"></a>01147 <span class="comment"> * Example:</span>
  1180. <a name="l01148"></a>01148 <span class="comment"> \code</span>
  1181. <a name="l01149"></a>01149 <span class="comment"> uip_ipaddr_t ipaddr;</span>
  1182. <a name="l01150"></a>01150 <span class="comment"> u8_t octet;</span>
  1183. <a name="l01151"></a>01151 <span class="comment"></span>
  1184. <a name="l01152"></a>01152 <span class="comment"> uip_ipaddr(&amp;ipaddr, 1,2,3,4);</span>
  1185. <a name="l01153"></a>01153 <span class="comment"> octet = uip_ipaddr3(&amp;ipaddr);</span>
  1186. <a name="l01154"></a>01154 <span class="comment"> \endcode</span>
  1187. <a name="l01155"></a>01155 <span class="comment"> *</span>
  1188. <a name="l01156"></a>01156 <span class="comment"> * In the example above, the variable &quot;octet&quot; will contain the value 3.</span>
  1189. <a name="l01157"></a>01157 <span class="comment"> *</span>
  1190. <a name="l01158"></a>01158 <span class="comment"> * \hideinitializer</span>
  1191. <a name="l01159"></a>01159 <span class="comment"> */</span>
  1192. <a name="l01160"></a><a class="code" href="a01576.html#gae23534479ead15af8ff08ace26a47fb5">01160</a> <span class="preprocessor">#define uip_ipaddr3(addr) ((addr)-&gt;u8[2])</span>
  1193. <a name="l01161"></a>01161 <span class="preprocessor"></span><span class="comment"></span>
  1194. <a name="l01162"></a>01162 <span class="comment">/**</span>
  1195. <a name="l01163"></a>01163 <span class="comment"> * Pick the fourth octet of an IP address.</span>
  1196. <a name="l01164"></a>01164 <span class="comment"> *</span>
  1197. <a name="l01165"></a>01165 <span class="comment"> * Picks out the fourth octet of an IP address.</span>
  1198. <a name="l01166"></a>01166 <span class="comment"> *</span>
  1199. <a name="l01167"></a>01167 <span class="comment"> * Example:</span>
  1200. <a name="l01168"></a>01168 <span class="comment"> \code</span>
  1201. <a name="l01169"></a>01169 <span class="comment"> uip_ipaddr_t ipaddr;</span>
  1202. <a name="l01170"></a>01170 <span class="comment"> u8_t octet;</span>
  1203. <a name="l01171"></a>01171 <span class="comment"></span>
  1204. <a name="l01172"></a>01172 <span class="comment"> uip_ipaddr(&amp;ipaddr, 1,2,3,4);</span>
  1205. <a name="l01173"></a>01173 <span class="comment"> octet = uip_ipaddr4(&amp;ipaddr);</span>
  1206. <a name="l01174"></a>01174 <span class="comment"> \endcode</span>
  1207. <a name="l01175"></a>01175 <span class="comment"> *</span>
  1208. <a name="l01176"></a>01176 <span class="comment"> * In the example above, the variable &quot;octet&quot; will contain the value 4.</span>
  1209. <a name="l01177"></a>01177 <span class="comment"> *</span>
  1210. <a name="l01178"></a>01178 <span class="comment"> * \hideinitializer</span>
  1211. <a name="l01179"></a>01179 <span class="comment"> */</span>
  1212. <a name="l01180"></a><a class="code" href="a01576.html#ga165b603ec150e26efec7be199c9c2901">01180</a> <span class="preprocessor">#define uip_ipaddr4(addr) ((addr)-&gt;u8[3])</span>
  1213. <a name="l01181"></a>01181 <span class="preprocessor"></span><span class="comment"></span>
  1214. <a name="l01182"></a>01182 <span class="comment">/**</span>
  1215. <a name="l01183"></a>01183 <span class="comment"> * Convert 16-bit quantity from host byte order to network byte order.</span>
  1216. <a name="l01184"></a>01184 <span class="comment"> *</span>
  1217. <a name="l01185"></a>01185 <span class="comment"> * This macro is primarily used for converting constants from host</span>
  1218. <a name="l01186"></a>01186 <span class="comment"> * byte order to network byte order. For converting variables to</span>
  1219. <a name="l01187"></a>01187 <span class="comment"> * network byte order, use the uip_htons() function instead.</span>
  1220. <a name="l01188"></a>01188 <span class="comment"> *</span>
  1221. <a name="l01189"></a>01189 <span class="comment"> * \hideinitializer</span>
  1222. <a name="l01190"></a>01190 <span class="comment"> */</span>
  1223. <a name="l01191"></a>01191 <span class="preprocessor">#ifndef UIP_HTONS</span>
  1224. <a name="l01192"></a>01192 <span class="preprocessor"></span><span class="preprocessor"># if UIP_BYTE_ORDER == UIP_BIG_ENDIAN</span>
  1225. <a name="l01193"></a><a class="code" href="a01576.html#ga703ee949a28cb00b5f8ee54bfe664e8d">01193</a> <span class="preprocessor"></span><span class="preprocessor"># define UIP_HTONS(n) (n)</span>
  1226. <a name="l01194"></a>01194 <span class="preprocessor"></span><span class="preprocessor"># define UIP_HTONL(n) (n)</span>
  1227. <a name="l01195"></a>01195 <span class="preprocessor"></span><span class="preprocessor"># else </span><span class="comment">/* UIP_BYTE_ORDER == UIP_BIG_ENDIAN */</span>
  1228. <a name="l01196"></a>01196 <span class="preprocessor"># define UIP_HTONS(n) (u16_t)((((u16_t) (n)) &lt;&lt; 8) | (((u16_t) (n)) &gt;&gt; 8))</span>
  1229. <a name="l01197"></a>01197 <span class="preprocessor"></span><span class="preprocessor"># define UIP_HTONL(n) (((u32_t)UIP_HTONS(n) &lt;&lt; 16) | UIP_HTONS((u32_t)(n) &gt;&gt; 16))</span>
  1230. <a name="l01198"></a>01198 <span class="preprocessor"></span><span class="preprocessor"># endif </span><span class="comment">/* UIP_BYTE_ORDER == UIP_BIG_ENDIAN */</span>
  1231. <a name="l01199"></a>01199 <span class="preprocessor">#else</span>
  1232. <a name="l01200"></a>01200 <span class="preprocessor"></span><span class="preprocessor">#error &quot;UIP_HTONS already defined!&quot;</span>
  1233. <a name="l01201"></a>01201 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_HTONS */</span>
  1234. <a name="l01202"></a>01202 <span class="comment"></span>
  1235. <a name="l01203"></a>01203 <span class="comment">/**</span>
  1236. <a name="l01204"></a>01204 <span class="comment"> * Convert 16-bit quantity from host byte order to network byte order.</span>
  1237. <a name="l01205"></a>01205 <span class="comment"> *</span>
  1238. <a name="l01206"></a>01206 <span class="comment"> * This function is primarily used for converting variables from host</span>
  1239. <a name="l01207"></a>01207 <span class="comment"> * byte order to network byte order. For converting constants to</span>
  1240. <a name="l01208"></a>01208 <span class="comment"> * network byte order, use the UIP_HTONS() macro instead.</span>
  1241. <a name="l01209"></a>01209 <span class="comment"> */</span>
  1242. <a name="l01210"></a>01210 <span class="preprocessor">#ifndef uip_htons</span>
  1243. <a name="l01211"></a>01211 <span class="preprocessor"></span>CCIF <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a01684.html#gae4394b6b3cd81f73b0e64a93e0558e00" title="Convert 16-bit quantity from host byte order to network byte order.">uip_htons</a>(<a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> val);
  1244. <a name="l01212"></a>01212 <span class="preprocessor">#endif </span><span class="comment">/* uip_htons */</span>
  1245. <a name="l01213"></a>01213 <span class="preprocessor">#ifndef uip_ntohs</span>
  1246. <a name="l01214"></a>01214 <span class="preprocessor"></span><span class="preprocessor">#define uip_ntohs uip_htons</span>
  1247. <a name="l01215"></a>01215 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
  1248. <a name="l01216"></a>01216 <span class="preprocessor"></span>
  1249. <a name="l01217"></a>01217 <span class="preprocessor">#ifndef uip_htonl</span>
  1250. <a name="l01218"></a>01218 <span class="preprocessor"></span>CCIF <a class="code" href="a01668.html#ga4c14294869aceba3ef9d4c0c302d0f33" title="The 32-bit unsigned data type.">u32_t</a> uip_htonl(<a class="code" href="a01668.html#ga4c14294869aceba3ef9d4c0c302d0f33" title="The 32-bit unsigned data type.">u32_t</a> val);
  1251. <a name="l01219"></a>01219 <span class="preprocessor">#endif </span><span class="comment">/* uip_htonl */</span>
  1252. <a name="l01220"></a>01220 <span class="preprocessor">#ifndef uip_ntohl</span>
  1253. <a name="l01221"></a>01221 <span class="preprocessor"></span><span class="preprocessor">#define uip_ntohl uip_htonl</span>
  1254. <a name="l01222"></a>01222 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
  1255. <a name="l01223"></a>01223 <span class="preprocessor"></span><span class="comment"></span>
  1256. <a name="l01224"></a>01224 <span class="comment">/** @} */</span>
  1257. <a name="l01225"></a>01225 <span class="comment"></span>
  1258. <a name="l01226"></a>01226 <span class="comment">/**</span>
  1259. <a name="l01227"></a>01227 <span class="comment"> * Pointer to the application data in the packet buffer.</span>
  1260. <a name="l01228"></a>01228 <span class="comment"> *</span>
  1261. <a name="l01229"></a>01229 <span class="comment"> * This pointer points to the application data when the application is</span>
  1262. <a name="l01230"></a>01230 <span class="comment"> * called. If the application wishes to send data, the application may</span>
  1263. <a name="l01231"></a>01231 <span class="comment"> * use this space to write the data into before calling uip_send().</span>
  1264. <a name="l01232"></a>01232 <span class="comment"> */</span>
  1265. <a name="l01233"></a>01233 CCIF <span class="keyword">extern</span> <span class="keywordtype">void</span> *<a class="code" href="a01684.html#ga561b8eda32e059d4e7397f776268cc63" title="Pointer to the application data in the packet buffer.">uip_appdata</a>;
  1266. <a name="l01234"></a>01234
  1267. <a name="l01235"></a>01235 <span class="preprocessor">#if UIP_URGDATA &gt; 0</span>
  1268. <a name="l01236"></a>01236 <span class="preprocessor"></span><span class="comment">/* u8_t *uip_urgdata:</span>
  1269. <a name="l01237"></a>01237 <span class="comment"> *</span>
  1270. <a name="l01238"></a>01238 <span class="comment"> * This pointer points to any urgent data that has been received. Only</span>
  1271. <a name="l01239"></a>01239 <span class="comment"> * present if compiled with support for urgent data (UIP_URGDATA).</span>
  1272. <a name="l01240"></a>01240 <span class="comment"> */</span>
  1273. <a name="l01241"></a>01241 <span class="keyword">extern</span> <span class="keywordtype">void</span> *uip_urgdata;
  1274. <a name="l01242"></a>01242 <span class="preprocessor">#endif </span><span class="comment">/* UIP_URGDATA &gt; 0 */</span>
  1275. <a name="l01243"></a>01243
  1276. <a name="l01244"></a>01244 <span class="comment"></span>
  1277. <a name="l01245"></a>01245 <span class="comment">/**</span>
  1278. <a name="l01246"></a>01246 <span class="comment"> * \defgroup uipdrivervars Variables used in uIP device drivers</span>
  1279. <a name="l01247"></a>01247 <span class="comment"> * @{</span>
  1280. <a name="l01248"></a>01248 <span class="comment"> *</span>
  1281. <a name="l01249"></a>01249 <span class="comment"> * uIP has a few global variables that are used in device drivers for</span>
  1282. <a name="l01250"></a>01250 <span class="comment"> * uIP.</span>
  1283. <a name="l01251"></a>01251 <span class="comment"> */</span>
  1284. <a name="l01252"></a>01252 <span class="comment"></span>
  1285. <a name="l01253"></a>01253 <span class="comment">/**</span>
  1286. <a name="l01254"></a>01254 <span class="comment"> * The length of the packet in the uip_buf buffer.</span>
  1287. <a name="l01255"></a>01255 <span class="comment"> *</span>
  1288. <a name="l01256"></a>01256 <span class="comment"> * The global variable uip_len holds the length of the packet in the</span>
  1289. <a name="l01257"></a>01257 <span class="comment"> * uip_buf buffer.</span>
  1290. <a name="l01258"></a>01258 <span class="comment"> *</span>
  1291. <a name="l01259"></a>01259 <span class="comment"> * When the network device driver calls the uIP input function,</span>
  1292. <a name="l01260"></a>01260 <span class="comment"> * uip_len should be set to the length of the packet in the uip_buf</span>
  1293. <a name="l01261"></a>01261 <span class="comment"> * buffer.</span>
  1294. <a name="l01262"></a>01262 <span class="comment"> *</span>
  1295. <a name="l01263"></a>01263 <span class="comment"> * When sending packets, the device driver should use the contents of</span>
  1296. <a name="l01264"></a>01264 <span class="comment"> * the uip_len variable to determine the length of the outgoing</span>
  1297. <a name="l01265"></a>01265 <span class="comment"> * packet.</span>
  1298. <a name="l01266"></a>01266 <span class="comment"> *</span>
  1299. <a name="l01267"></a>01267 <span class="comment"> */</span>
  1300. <a name="l01268"></a>01268 CCIF <span class="keyword">extern</span> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a01684.html#ga12a33f0c09711167bdf3dd7d7cf8c5a1" title="The length of the packet in the uip_buf buffer.">uip_len</a>;
  1301. <a name="l01269"></a>01269 <span class="comment"></span>
  1302. <a name="l01270"></a>01270 <span class="comment">/**</span>
  1303. <a name="l01271"></a>01271 <span class="comment"> * The length of the extension headers</span>
  1304. <a name="l01272"></a>01272 <span class="comment"> */</span>
  1305. <a name="l01273"></a>01273 <span class="keyword">extern</span> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a01577.html#ga1c9ed2d0cf3e1b814dc19b76487bed50" title="The length of the extension headers.">uip_ext_len</a>;<span class="comment"></span>
  1306. <a name="l01274"></a>01274 <span class="comment">/** @} */</span>
  1307. <a name="l01275"></a>01275
  1308. <a name="l01276"></a>01276 <span class="preprocessor">#if UIP_URGDATA &gt; 0</span>
  1309. <a name="l01277"></a>01277 <span class="preprocessor"></span><span class="keyword">extern</span> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> uip_urglen, uip_surglen;
  1310. <a name="l01278"></a>01278 <span class="preprocessor">#endif </span><span class="comment">/* UIP_URGDATA &gt; 0 */</span>
  1311. <a name="l01279"></a>01279
  1312. <a name="l01280"></a>01280 <span class="comment"></span>
  1313. <a name="l01281"></a>01281 <span class="comment">/**</span>
  1314. <a name="l01282"></a>01282 <span class="comment"> * Representation of a uIP TCP connection.</span>
  1315. <a name="l01283"></a>01283 <span class="comment"> *</span>
  1316. <a name="l01284"></a>01284 <span class="comment"> * The uip_conn structure is used for identifying a connection. All</span>
  1317. <a name="l01285"></a>01285 <span class="comment"> * but one field in the structure are to be considered read-only by an</span>
  1318. <a name="l01286"></a>01286 <span class="comment"> * application. The only exception is the appstate field whose purpose</span>
  1319. <a name="l01287"></a>01287 <span class="comment"> * is to let the application store application-specific state (e.g.,</span>
  1320. <a name="l01288"></a>01288 <span class="comment"> * file pointers) for the connection. The type of this field is</span>
  1321. <a name="l01289"></a>01289 <span class="comment"> * configured in the &quot;uipopt.h&quot; header file.</span>
  1322. <a name="l01290"></a>01290 <span class="comment"> */</span>
  1323. <a name="l01291"></a><a class="code" href="a00092.html">01291</a> <span class="keyword">struct </span><a class="code" href="a00092.html" title="Representation of a uIP TCP connection.">uip_conn</a> {
  1324. <a name="l01292"></a><a class="code" href="a00092.html#a79510aa86d3fa0a0fc6cfc49b1da7279">01292</a> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> <a class="code" href="a00092.html#a79510aa86d3fa0a0fc6cfc49b1da7279" title="The IP address of the remote host.">ripaddr</a>; <span class="comment">/**&lt; The IP address of the remote host. */</span>
  1325. <a name="l01293"></a>01293
  1326. <a name="l01294"></a><a class="code" href="a00092.html#a0cd09beee671e7e9efb0b4aced10249e">01294</a> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00092.html#a0cd09beee671e7e9efb0b4aced10249e" title="The local TCP port, in network byte order.">lport</a>; <span class="comment">/**&lt; The local TCP port, in network byte order. */</span>
  1327. <a name="l01295"></a><a class="code" href="a00092.html#a1df6aa054ef2fa634ac4c6f418228285">01295</a> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00092.html#a1df6aa054ef2fa634ac4c6f418228285" title="The local remote TCP port, in network byte order.">rport</a>; <span class="comment">/**&lt; The local remote TCP port, in network byte</span>
  1328. <a name="l01296"></a>01296 <span class="comment"> order. */</span>
  1329. <a name="l01297"></a>01297
  1330. <a name="l01298"></a><a class="code" href="a00092.html#a70297b3e6d4eaae7bd828cb50bd1efe3">01298</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00092.html#a70297b3e6d4eaae7bd828cb50bd1efe3" title="The sequence number that we expect to receive next.">rcv_nxt</a>[4]; <span class="comment">/**&lt; The sequence number that we expect to</span>
  1331. <a name="l01299"></a>01299 <span class="comment"> receive next. */</span>
  1332. <a name="l01300"></a><a class="code" href="a00092.html#a8f6b08a5ba2a8d75ca7279e2056aa8c6">01300</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00092.html#a8f6b08a5ba2a8d75ca7279e2056aa8c6" title="The sequence number that was last sent by us.">snd_nxt</a>[4]; <span class="comment">/**&lt; The sequence number that was last sent by</span>
  1333. <a name="l01301"></a>01301 <span class="comment"> us. */</span>
  1334. <a name="l01302"></a><a class="code" href="a00092.html#a0ef3ae2764714bf90620075c374c262e">01302</a> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00092.html#a0ef3ae2764714bf90620075c374c262e" title="Length of the data that was previously sent.">len</a>; <span class="comment">/**&lt; Length of the data that was previously sent. */</span>
  1335. <a name="l01303"></a><a class="code" href="a00092.html#a3347ef1b6e8581402445d1a0280c7a14">01303</a> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00092.html#a3347ef1b6e8581402445d1a0280c7a14" title="Current maximum segment size for the connection.">mss</a>; <span class="comment">/**&lt; Current maximum segment size for the</span>
  1336. <a name="l01304"></a>01304 <span class="comment"> connection. */</span>
  1337. <a name="l01305"></a><a class="code" href="a00092.html#adb7a3fadb68df5fdd37e8b91a2c751ea">01305</a> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00092.html#adb7a3fadb68df5fdd37e8b91a2c751ea" title="Initial maximum segment size for the connection.">initialmss</a>; <span class="comment">/**&lt; Initial maximum segment size for the</span>
  1338. <a name="l01306"></a>01306 <span class="comment"> connection. */</span>
  1339. <a name="l01307"></a><a class="code" href="a00092.html#aef661afb3aa82f0437d2ed8d3c20be76">01307</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00092.html#aef661afb3aa82f0437d2ed8d3c20be76" title="Retransmission time-out calculation state variable.">sa</a>; <span class="comment">/**&lt; Retransmission time-out calculation state</span>
  1340. <a name="l01308"></a>01308 <span class="comment"> variable. */</span>
  1341. <a name="l01309"></a><a class="code" href="a00092.html#aeb9fcbd3c9b0a795dcd63f33c323d65c">01309</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00092.html#aeb9fcbd3c9b0a795dcd63f33c323d65c" title="Retransmission time-out calculation state variable.">sv</a>; <span class="comment">/**&lt; Retransmission time-out calculation state</span>
  1342. <a name="l01310"></a>01310 <span class="comment"> variable. */</span>
  1343. <a name="l01311"></a><a class="code" href="a00092.html#ae3aa9cc25e45b663e6aabc54c013019e">01311</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00092.html#ae3aa9cc25e45b663e6aabc54c013019e" title="Retransmission time-out.">rto</a>; <span class="comment">/**&lt; Retransmission time-out. */</span>
  1344. <a name="l01312"></a><a class="code" href="a00092.html#aa5f58074435cdc180f17de69651beebd">01312</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00092.html#aa5f58074435cdc180f17de69651beebd" title="TCP state and flags.">tcpstateflags</a>; <span class="comment">/**&lt; TCP state and flags. */</span>
  1345. <a name="l01313"></a><a class="code" href="a00092.html#a2d9732cf5752d30bd11cb25dc7d0c8d3">01313</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00086.html" title="A timer.">timer</a>; <span class="comment">/**&lt; The retransmission timer. */</span>
  1346. <a name="l01314"></a><a class="code" href="a00092.html#a4289c59840b128f2f6526e9da2711d47">01314</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00092.html#a4289c59840b128f2f6526e9da2711d47" title="The number of retransmissions for the last segment sent.">nrtx</a>; <span class="comment">/**&lt; The number of retransmissions for the last</span>
  1347. <a name="l01315"></a>01315 <span class="comment"> segment sent. */</span>
  1348. <a name="l01316"></a>01316 <span class="comment"></span>
  1349. <a name="l01317"></a>01317 <span class="comment"> /** The application state. */</span>
  1350. <a name="l01318"></a><a class="code" href="a00092.html#a97f9e1fda815bfb8b1f4577c355ade20">01318</a> <a class="code" href="a01591.html#ga69646a81a922033c5281445a71f8ffed" title="The type of the application state that is to be stored in the uip_conn structure...">uip_tcp_appstate_t</a> <a class="code" href="a00092.html#a97f9e1fda815bfb8b1f4577c355ade20" title="The application state.">appstate</a>;
  1351. <a name="l01319"></a>01319 };
  1352. <a name="l01320"></a>01320
  1353. <a name="l01321"></a>01321 <span class="comment"></span>
  1354. <a name="l01322"></a>01322 <span class="comment">/**</span>
  1355. <a name="l01323"></a>01323 <span class="comment"> * Pointer to the current TCP connection.</span>
  1356. <a name="l01324"></a>01324 <span class="comment"> *</span>
  1357. <a name="l01325"></a>01325 <span class="comment"> * The uip_conn pointer can be used to access the current TCP</span>
  1358. <a name="l01326"></a>01326 <span class="comment"> * connection.</span>
  1359. <a name="l01327"></a>01327 <span class="comment"> */</span>
  1360. <a name="l01328"></a>01328
  1361. <a name="l01329"></a>01329 CCIF <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00092.html" title="Representation of a uIP TCP connection.">uip_conn</a> *<a class="code" href="a00092.html" title="Representation of a uIP TCP connection.">uip_conn</a>;
  1362. <a name="l01330"></a>01330 <span class="preprocessor">#if UIP_TCP</span>
  1363. <a name="l01331"></a>01331 <span class="preprocessor"></span><span class="comment">/* The array containing all uIP connections. */</span>
  1364. <a name="l01332"></a>01332 CCIF <span class="keyword">extern</span> <span class="keyword">struct </span>uip_conn uip_conns[<a class="code" href="a01585.html#gaf5fe83be78b78b9e7d9e7f1e34ab1cc5" title="The maximum number of simultaneously open TCP connections.">UIP_CONNS</a>];
  1365. <a name="l01333"></a>01333 <span class="preprocessor">#endif</span>
  1366. <a name="l01334"></a>01334 <span class="preprocessor"></span><span class="comment"></span>
  1367. <a name="l01335"></a>01335 <span class="comment">/**</span>
  1368. <a name="l01336"></a>01336 <span class="comment"> * \addtogroup uiparch</span>
  1369. <a name="l01337"></a>01337 <span class="comment"> * @{</span>
  1370. <a name="l01338"></a>01338 <span class="comment"> */</span>
  1371. <a name="l01339"></a>01339 <span class="comment"></span>
  1372. <a name="l01340"></a>01340 <span class="comment">/**</span>
  1373. <a name="l01341"></a>01341 <span class="comment"> * 4-byte array used for the 32-bit sequence number calculations.</span>
  1374. <a name="l01342"></a>01342 <span class="comment"> */</span>
  1375. <a name="l01343"></a>01343 <span class="keyword">extern</span> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a01684.html#ga2a0cf5d86c58fab216414ce59bf1fea1" title="4-byte array used for the 32-bit sequence number calculations.">uip_acc32</a>[4];<span class="comment"></span>
  1376. <a name="l01344"></a>01344 <span class="comment">/** @} */</span>
  1377. <a name="l01345"></a>01345 <span class="comment"></span>
  1378. <a name="l01346"></a>01346 <span class="comment">/**</span>
  1379. <a name="l01347"></a>01347 <span class="comment"> * Representation of a uIP UDP connection.</span>
  1380. <a name="l01348"></a>01348 <span class="comment"> */</span>
  1381. <a name="l01349"></a><a class="code" href="a00119.html">01349</a> <span class="keyword">struct </span><a class="code" href="a00119.html" title="Representation of a uIP UDP connection.">uip_udp_conn</a> {
  1382. <a name="l01350"></a><a class="code" href="a00119.html#a8a661a2d544100b82d0d14a1985083d5">01350</a> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> <a class="code" href="a00119.html#a8a661a2d544100b82d0d14a1985083d5" title="The IP address of the remote peer.">ripaddr</a>; <span class="comment">/**&lt; The IP address of the remote peer. */</span>
  1383. <a name="l01351"></a><a class="code" href="a00119.html#a981392e295db4d024eea95805c51c371">01351</a> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00119.html#a981392e295db4d024eea95805c51c371" title="The local port number in network byte order.">lport</a>; <span class="comment">/**&lt; The local port number in network byte order. */</span>
  1384. <a name="l01352"></a><a class="code" href="a00119.html#a280a0c2a93544e597f92bbacf36ee1dc">01352</a> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a00119.html#a280a0c2a93544e597f92bbacf36ee1dc" title="The remote port number in network byte order.">rport</a>; <span class="comment">/**&lt; The remote port number in network byte order. */</span>
  1385. <a name="l01353"></a><a class="code" href="a00119.html#a4da1d7815516cd2b5bda3a66fdf05198">01353</a> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> <a class="code" href="a00119.html#a4da1d7815516cd2b5bda3a66fdf05198" title="Default time-to-live.">ttl</a>; <span class="comment">/**&lt; Default time-to-live. */</span>
  1386. <a name="l01354"></a>01354 <span class="comment"></span>
  1387. <a name="l01355"></a>01355 <span class="comment"> /** The application state. */</span>
  1388. <a name="l01356"></a><a class="code" href="a00119.html#ac8afa29e0aa5e789d6929b366d98ba56">01356</a> <a class="code" href="a01591.html#gaa92afb113e122f860392bfbd385f842e" title="The type of the application state that is to be stored in the uip_conn structure...">uip_udp_appstate_t</a> <a class="code" href="a00119.html#ac8afa29e0aa5e789d6929b366d98ba56" title="The application state.">appstate</a>;
  1389. <a name="l01357"></a>01357 };
  1390. <a name="l01358"></a>01358 <span class="comment"></span>
  1391. <a name="l01359"></a>01359 <span class="comment">/**</span>
  1392. <a name="l01360"></a>01360 <span class="comment"> * The current UDP connection.</span>
  1393. <a name="l01361"></a>01361 <span class="comment"> */</span>
  1394. <a name="l01362"></a>01362 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00119.html" title="Representation of a uIP UDP connection.">uip_udp_conn</a> *<a class="code" href="a00119.html" title="Representation of a uIP UDP connection.">uip_udp_conn</a>;
  1395. <a name="l01363"></a>01363 <span class="keyword">extern</span> <span class="keyword">struct </span>uip_udp_conn uip_udp_conns[<a class="code" href="a01584.html#ga196379ceb1219a99f4495e41ccc9bbfb" title="The maximum amount of concurrent UDP connections.">UIP_UDP_CONNS</a>];
  1396. <a name="l01364"></a>01364
  1397. <a name="l01365"></a>01365 <span class="keyword">struct </span>uip_fallback_interface {
  1398. <a name="l01366"></a>01366 void (*init)(void);
  1399. <a name="l01367"></a>01367 void (*output)(void);
  1400. <a name="l01368"></a>01368 };
  1401. <a name="l01369"></a>01369
  1402. <a name="l01370"></a>01370 <span class="preprocessor">#if UIP_CONF_ICMP6</span>
  1403. <a name="l01371"></a>01371 <span class="preprocessor"></span><span class="keyword">struct </span>uip_icmp6_conn {
  1404. <a name="l01372"></a>01372 uip_icmp6_appstate_t appstate;
  1405. <a name="l01373"></a>01373 };
  1406. <a name="l01374"></a>01374 <span class="keyword">extern</span> <span class="keyword">struct </span>uip_icmp6_conn uip_icmp6_conns;
  1407. <a name="l01375"></a>01375 <span class="preprocessor">#endif </span><span class="comment">/*UIP_CONF_ICMP6*/</span>
  1408. <a name="l01376"></a>01376 <span class="comment"></span>
  1409. <a name="l01377"></a>01377 <span class="comment">/**</span>
  1410. <a name="l01378"></a>01378 <span class="comment"> * The uIP TCP/IP statistics.</span>
  1411. <a name="l01379"></a>01379 <span class="comment"> *</span>
  1412. <a name="l01380"></a>01380 <span class="comment"> * This is the variable in which the uIP TCP/IP statistics are gathered.</span>
  1413. <a name="l01381"></a>01381 <span class="comment"> */</span>
  1414. <a name="l01382"></a>01382 <span class="preprocessor">#if UIP_STATISTICS == 1</span>
  1415. <a name="l01383"></a>01383 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00118.html" title="The structure holding the TCP/IP statistics that are gathered if UIP_STATISTICS is...">uip_stats</a> uip_stat;
  1416. <a name="l01384"></a>01384 <span class="preprocessor">#define UIP_STAT(s) s</span>
  1417. <a name="l01385"></a>01385 <span class="preprocessor"></span><span class="preprocessor">#else</span>
  1418. <a name="l01386"></a><a class="code" href="a01684.html#ga9c0814ed491fa452ec97910c0728d410">01386</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_STAT(s)</span>
  1419. <a name="l01387"></a>01387 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_STATISTICS == 1 */</span>
  1420. <a name="l01388"></a>01388 <span class="comment"></span>
  1421. <a name="l01389"></a>01389 <span class="comment">/**</span>
  1422. <a name="l01390"></a>01390 <span class="comment"> * The structure holding the TCP/IP statistics that are gathered if</span>
  1423. <a name="l01391"></a>01391 <span class="comment"> * UIP_STATISTICS is set to 1.</span>
  1424. <a name="l01392"></a>01392 <span class="comment"> *</span>
  1425. <a name="l01393"></a>01393 <span class="comment"> */</span>
  1426. <a name="l01394"></a><a class="code" href="a00118.html">01394</a> <span class="keyword">struct </span><a class="code" href="a00118.html" title="The structure holding the TCP/IP statistics that are gathered if UIP_STATISTICS is...">uip_stats</a> {
  1427. <a name="l01395"></a>01395 <span class="keyword">struct </span>{
  1428. <a name="l01396"></a><a class="code" href="a00118.html#a7f7bb2145afba5df00c6e10ddefa8ae1">01396</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7f7bb2145afba5df00c6e10ddefa8ae1" title="Number of received packets at the IP layer.">recv</a>; <span class="comment">/**&lt; Number of received packets at the IP</span>
  1429. <a name="l01397"></a>01397 <span class="comment"> layer. */</span>
  1430. <a name="l01398"></a><a class="code" href="a00118.html#adc69abadd5aa07c7d74f9292db2cd93c">01398</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#adc69abadd5aa07c7d74f9292db2cd93c" title="Number of sent packets at the IP layer.">sent</a>; <span class="comment">/**&lt; Number of sent packets at the IP</span>
  1431. <a name="l01399"></a>01399 <span class="comment"> layer. */</span>
  1432. <a name="l01400"></a><a class="code" href="a00118.html#a057f352a85dce84552f2a51e7a8e85ae">01400</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a057f352a85dce84552f2a51e7a8e85ae" title="Number of forwarded packets at the IP layer.">forwarded</a>;<span class="comment">/**&lt; Number of forwarded packets at the IP </span>
  1433. <a name="l01401"></a>01401 <span class="comment"> layer. */</span>
  1434. <a name="l01402"></a><a class="code" href="a00118.html#a5d8996950cdf3d8130cc3ad340eb9dff">01402</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a5d8996950cdf3d8130cc3ad340eb9dff" title="Number of dropped packets at the IP layer.">drop</a>; <span class="comment">/**&lt; Number of dropped packets at the IP</span>
  1435. <a name="l01403"></a>01403 <span class="comment"> layer. */</span>
  1436. <a name="l01404"></a><a class="code" href="a00118.html#ab93e351c3abba0c700b26b7b07e9527d">01404</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#ab93e351c3abba0c700b26b7b07e9527d" title="Number of packets dropped due to wrong IP version or header length.">vhlerr</a>; <span class="comment">/**&lt; Number of packets dropped due to wrong</span>
  1437. <a name="l01405"></a>01405 <span class="comment"> IP version or header length. */</span>
  1438. <a name="l01406"></a><a class="code" href="a00118.html#a0c816f34c0187f2154c91a18d3ad87c8">01406</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a0c816f34c0187f2154c91a18d3ad87c8" title="Number of packets dropped due to wrong IP length, high byte.">hblenerr</a>; <span class="comment">/**&lt; Number of packets dropped due to wrong</span>
  1439. <a name="l01407"></a>01407 <span class="comment"> IP length, high byte. */</span>
  1440. <a name="l01408"></a><a class="code" href="a00118.html#a6157452bdc9921f44b2e22e4b5969258">01408</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a6157452bdc9921f44b2e22e4b5969258" title="Number of packets dropped due to wrong IP length, low byte.">lblenerr</a>; <span class="comment">/**&lt; Number of packets dropped due to wrong</span>
  1441. <a name="l01409"></a>01409 <span class="comment"> IP length, low byte. */</span>
  1442. <a name="l01410"></a><a class="code" href="a00118.html#a8082509468b2ac80ed7746aa1a5bc4f7">01410</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a8082509468b2ac80ed7746aa1a5bc4f7" title="Number of packets dropped since they were IP fragments.">fragerr</a>; <span class="comment">/**&lt; Number of packets dropped since they</span>
  1443. <a name="l01411"></a>01411 <span class="comment"> were IP fragments. */</span>
  1444. <a name="l01412"></a><a class="code" href="a00118.html#a7675e6b9adbddbd545d3aac8ca092fbb">01412</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7675e6b9adbddbd545d3aac8ca092fbb" title="Number of packets dropped due to IP checksum errors.">chkerr</a>; <span class="comment">/**&lt; Number of packets dropped due to IP</span>
  1445. <a name="l01413"></a>01413 <span class="comment"> checksum errors. */</span>
  1446. <a name="l01414"></a><a class="code" href="a00118.html#ab4622e2599ff3a592db09219b2641682">01414</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#ab4622e2599ff3a592db09219b2641682" title="Number of packets dropped since they were neither ICMP, UDP nor TCP.">protoerr</a>; <span class="comment">/**&lt; Number of packets dropped since they</span>
  1447. <a name="l01415"></a>01415 <span class="comment"> were neither ICMP, UDP nor TCP. */</span>
  1448. <a name="l01416"></a>01416 } <a class="code" href="a00118.html#a7962982218559d41d3e193251e09a7a3" title="IP statistics.">ip</a>; <span class="comment">/**&lt; IP statistics. */</span>
  1449. <a name="l01417"></a>01417 <span class="keyword">struct </span>{
  1450. <a name="l01418"></a>01418 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7f7bb2145afba5df00c6e10ddefa8ae1" title="Number of received packets at the IP layer.">recv</a>; <span class="comment">/**&lt; Number of received ICMP packets. */</span>
  1451. <a name="l01419"></a>01419 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#adc69abadd5aa07c7d74f9292db2cd93c" title="Number of sent packets at the IP layer.">sent</a>; <span class="comment">/**&lt; Number of sent ICMP packets. */</span>
  1452. <a name="l01420"></a>01420 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a5d8996950cdf3d8130cc3ad340eb9dff" title="Number of dropped packets at the IP layer.">drop</a>; <span class="comment">/**&lt; Number of dropped ICMP packets. */</span>
  1453. <a name="l01421"></a><a class="code" href="a00118.html#a8da121d6e50992ec55778f9b2141552d">01421</a> <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a8da121d6e50992ec55778f9b2141552d" title="Number of ICMP packets with a wrong type.">typeerr</a>; <span class="comment">/**&lt; Number of ICMP packets with a wrong</span>
  1454. <a name="l01422"></a>01422 <span class="comment"> type. */</span>
  1455. <a name="l01423"></a>01423 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7675e6b9adbddbd545d3aac8ca092fbb" title="Number of packets dropped due to IP checksum errors.">chkerr</a>; <span class="comment">/**&lt; Number of ICMP packets with a bad</span>
  1456. <a name="l01424"></a>01424 <span class="comment"> checksum. */</span>
  1457. <a name="l01425"></a>01425 } <a class="code" href="a00118.html#a24d77a2708b2923f3dd06b41f9be3063" title="ICMP statistics.">icmp</a>; <span class="comment">/**&lt; ICMP statistics. */</span>
  1458. <a name="l01426"></a>01426 <span class="preprocessor">#if UIP_TCP</span>
  1459. <a name="l01427"></a>01427 <span class="preprocessor"></span> <span class="keyword">struct </span>{
  1460. <a name="l01428"></a>01428 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7f7bb2145afba5df00c6e10ddefa8ae1" title="Number of received packets at the IP layer.">recv</a>; <span class="comment">/**&lt; Number of recived TCP segments. */</span>
  1461. <a name="l01429"></a>01429 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#adc69abadd5aa07c7d74f9292db2cd93c" title="Number of sent packets at the IP layer.">sent</a>; <span class="comment">/**&lt; Number of sent TCP segments. */</span>
  1462. <a name="l01430"></a>01430 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a5d8996950cdf3d8130cc3ad340eb9dff" title="Number of dropped packets at the IP layer.">drop</a>; <span class="comment">/**&lt; Number of dropped TCP segments. */</span>
  1463. <a name="l01431"></a>01431 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7675e6b9adbddbd545d3aac8ca092fbb" title="Number of packets dropped due to IP checksum errors.">chkerr</a>; <span class="comment">/**&lt; Number of TCP segments with a bad</span>
  1464. <a name="l01432"></a>01432 <span class="comment"> checksum. */</span>
  1465. <a name="l01433"></a>01433 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> ackerr; <span class="comment">/**&lt; Number of TCP segments with a bad ACK</span>
  1466. <a name="l01434"></a>01434 <span class="comment"> number. */</span>
  1467. <a name="l01435"></a>01435 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> rst; <span class="comment">/**&lt; Number of recevied TCP RST (reset) segments. */</span>
  1468. <a name="l01436"></a>01436 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> rexmit; <span class="comment">/**&lt; Number of retransmitted TCP segments. */</span>
  1469. <a name="l01437"></a>01437 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> syndrop; <span class="comment">/**&lt; Number of dropped SYNs due to too few</span>
  1470. <a name="l01438"></a>01438 <span class="comment"> connections was avaliable. */</span>
  1471. <a name="l01439"></a>01439 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> synrst; <span class="comment">/**&lt; Number of SYNs for closed ports,</span>
  1472. <a name="l01440"></a>01440 <span class="comment"> triggering a RST. */</span>
  1473. <a name="l01441"></a>01441 } tcp; <span class="comment">/**&lt; TCP statistics. */</span>
  1474. <a name="l01442"></a>01442 <span class="preprocessor">#endif</span>
  1475. <a name="l01443"></a>01443 <span class="preprocessor"></span><span class="preprocessor">#if UIP_UDP</span>
  1476. <a name="l01444"></a>01444 <span class="preprocessor"></span> <span class="keyword">struct </span>{
  1477. <a name="l01445"></a>01445 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a5d8996950cdf3d8130cc3ad340eb9dff" title="Number of dropped packets at the IP layer.">drop</a>; <span class="comment">/**&lt; Number of dropped UDP segments. */</span>
  1478. <a name="l01446"></a>01446 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7f7bb2145afba5df00c6e10ddefa8ae1" title="Number of received packets at the IP layer.">recv</a>; <span class="comment">/**&lt; Number of recived UDP segments. */</span>
  1479. <a name="l01447"></a>01447 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#adc69abadd5aa07c7d74f9292db2cd93c" title="Number of sent packets at the IP layer.">sent</a>; <span class="comment">/**&lt; Number of sent UDP segments. */</span>
  1480. <a name="l01448"></a>01448 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7675e6b9adbddbd545d3aac8ca092fbb" title="Number of packets dropped due to IP checksum errors.">chkerr</a>; <span class="comment">/**&lt; Number of UDP segments with a bad</span>
  1481. <a name="l01449"></a>01449 <span class="comment"> checksum. */</span>
  1482. <a name="l01450"></a>01450 } <a class="code" href="a00118.html#ac9a0460b7cdbda0273c344b4307ee431" title="UDP statistics.">udp</a>; <span class="comment">/**&lt; UDP statistics. */</span>
  1483. <a name="l01451"></a>01451 <span class="preprocessor">#endif </span><span class="comment">/* UIP_UDP */</span>
  1484. <a name="l01452"></a>01452 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1485. <a name="l01453"></a>01453 <span class="preprocessor"></span> <span class="keyword">struct </span>{
  1486. <a name="l01454"></a>01454 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a5d8996950cdf3d8130cc3ad340eb9dff" title="Number of dropped packets at the IP layer.">drop</a>; <span class="comment">/**&lt; Number of dropped ND6 packets. */</span>
  1487. <a name="l01455"></a>01455 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#a7f7bb2145afba5df00c6e10ddefa8ae1" title="Number of received packets at the IP layer.">recv</a>; <span class="comment">/**&lt; Number of recived ND6 packets */</span>
  1488. <a name="l01456"></a>01456 <a class="code" href="a01668.html#ga727459e5c4f777543c81ffffa3df3f0c" title="The statistics data type.">uip_stats_t</a> <a class="code" href="a00118.html#adc69abadd5aa07c7d74f9292db2cd93c" title="Number of sent packets at the IP layer.">sent</a>; <span class="comment">/**&lt; Number of sent ND6 packets */</span>
  1489. <a name="l01457"></a>01457 } nd6;
  1490. <a name="l01458"></a>01458 <span class="preprocessor">#endif </span><span class="comment">/*UIP_CONF_IPV6*/</span>
  1491. <a name="l01459"></a>01459 };
  1492. <a name="l01460"></a>01460
  1493. <a name="l01461"></a>01461
  1494. <a name="l01462"></a>01462 <span class="comment">/*---------------------------------------------------------------------------*/</span>
  1495. <a name="l01463"></a>01463 <span class="comment">/* All the stuff below this point is internal to uIP and should not be</span>
  1496. <a name="l01464"></a>01464 <span class="comment"> * used directly by an application or by a device driver.</span>
  1497. <a name="l01465"></a>01465 <span class="comment"> */</span>
  1498. <a name="l01466"></a>01466 <span class="comment">/*---------------------------------------------------------------------------*/</span>
  1499. <a name="l01467"></a>01467
  1500. <a name="l01468"></a>01468
  1501. <a name="l01469"></a>01469
  1502. <a name="l01470"></a>01470 <span class="comment">/* u8_t uip_flags:</span>
  1503. <a name="l01471"></a>01471 <span class="comment"> *</span>
  1504. <a name="l01472"></a>01472 <span class="comment"> * When the application is called, uip_flags will contain the flags</span>
  1505. <a name="l01473"></a>01473 <span class="comment"> * that are defined in this file. Please read below for more</span>
  1506. <a name="l01474"></a>01474 <span class="comment"> * information.</span>
  1507. <a name="l01475"></a>01475 <span class="comment"> */</span>
  1508. <a name="l01476"></a>01476 CCIF <span class="keyword">extern</span> <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> uip_flags;
  1509. <a name="l01477"></a>01477
  1510. <a name="l01478"></a>01478 <span class="comment">/* The following flags may be set in the global variable uip_flags</span>
  1511. <a name="l01479"></a>01479 <span class="comment"> before calling the application callback. The UIP_ACKDATA,</span>
  1512. <a name="l01480"></a>01480 <span class="comment"> UIP_NEWDATA, and UIP_CLOSE flags may both be set at the same time,</span>
  1513. <a name="l01481"></a>01481 <span class="comment"> whereas the others are mutually exclusive. Note that these flags</span>
  1514. <a name="l01482"></a>01482 <span class="comment"> should *NOT* be accessed directly, but only through the uIP</span>
  1515. <a name="l01483"></a>01483 <span class="comment"> functions/macros. */</span>
  1516. <a name="l01484"></a>01484
  1517. <a name="l01485"></a>01485 <span class="preprocessor">#define UIP_ACKDATA 1 </span><span class="comment">/* Signifies that the outstanding data was</span>
  1518. <a name="l01486"></a>01486 <span class="comment"> acked and the application should send</span>
  1519. <a name="l01487"></a>01487 <span class="comment"> out new data instead of retransmitting</span>
  1520. <a name="l01488"></a>01488 <span class="comment"> the last data. */</span>
  1521. <a name="l01489"></a>01489 <span class="preprocessor">#define UIP_NEWDATA 2 </span><span class="comment">/* Flags the fact that the peer has sent</span>
  1522. <a name="l01490"></a>01490 <span class="comment"> us new data. */</span>
  1523. <a name="l01491"></a>01491 <span class="preprocessor">#define UIP_REXMIT 4 </span><span class="comment">/* Tells the application to retransmit the</span>
  1524. <a name="l01492"></a>01492 <span class="comment"> data that was last sent. */</span>
  1525. <a name="l01493"></a>01493 <span class="preprocessor">#define UIP_POLL 8 </span><span class="comment">/* Used for polling the application, to</span>
  1526. <a name="l01494"></a>01494 <span class="comment"> check if the application has data that</span>
  1527. <a name="l01495"></a>01495 <span class="comment"> it wants to send. */</span>
  1528. <a name="l01496"></a>01496 <span class="preprocessor">#define UIP_CLOSE 16 </span><span class="comment">/* The remote host has closed the</span>
  1529. <a name="l01497"></a>01497 <span class="comment"> connection, thus the connection has</span>
  1530. <a name="l01498"></a>01498 <span class="comment"> gone away. Or the application signals</span>
  1531. <a name="l01499"></a>01499 <span class="comment"> that it wants to close the</span>
  1532. <a name="l01500"></a>01500 <span class="comment"> connection. */</span>
  1533. <a name="l01501"></a>01501 <span class="preprocessor">#define UIP_ABORT 32 </span><span class="comment">/* The remote host has aborted the</span>
  1534. <a name="l01502"></a>01502 <span class="comment"> connection, thus the connection has</span>
  1535. <a name="l01503"></a>01503 <span class="comment"> gone away. Or the application signals</span>
  1536. <a name="l01504"></a>01504 <span class="comment"> that it wants to abort the</span>
  1537. <a name="l01505"></a>01505 <span class="comment"> connection. */</span>
  1538. <a name="l01506"></a>01506 <span class="preprocessor">#define UIP_CONNECTED 64 </span><span class="comment">/* We have got a connection from a remote</span>
  1539. <a name="l01507"></a>01507 <span class="comment"> host and have set up a new connection</span>
  1540. <a name="l01508"></a>01508 <span class="comment"> for it, or an active connection has</span>
  1541. <a name="l01509"></a>01509 <span class="comment"> been successfully established. */</span>
  1542. <a name="l01510"></a>01510
  1543. <a name="l01511"></a>01511 <span class="preprocessor">#define UIP_TIMEDOUT 128 </span><span class="comment">/* The connection has been aborted due to</span>
  1544. <a name="l01512"></a>01512 <span class="comment"> too many retransmissions. */</span>
  1545. <a name="l01513"></a>01513
  1546. <a name="l01514"></a>01514 <span class="comment"></span>
  1547. <a name="l01515"></a>01515 <span class="comment">/**</span>
  1548. <a name="l01516"></a>01516 <span class="comment"> * \brief process the options within a hop by hop or destination option header</span>
  1549. <a name="l01517"></a>01517 <span class="comment"> * \retval 0: nothing to send,</span>
  1550. <a name="l01518"></a>01518 <span class="comment"> * \retval 1: drop pkt</span>
  1551. <a name="l01519"></a>01519 <span class="comment"> * \retval 2: ICMP error message to send</span>
  1552. <a name="l01520"></a>01520 <span class="comment">*/</span>
  1553. <a name="l01521"></a>01521 <span class="comment">/*static u8_t</span>
  1554. <a name="l01522"></a>01522 <span class="comment">uip_ext_hdr_options_process(); */</span>
  1555. <a name="l01523"></a>01523
  1556. <a name="l01524"></a>01524 <span class="comment">/* uip_process(flag):</span>
  1557. <a name="l01525"></a>01525 <span class="comment"> *</span>
  1558. <a name="l01526"></a>01526 <span class="comment"> * The actual uIP function which does all the work.</span>
  1559. <a name="l01527"></a>01527 <span class="comment"> */</span>
  1560. <a name="l01528"></a>01528 <span class="keywordtype">void</span> <a class="code" href="a01684.html#ga266263ac78a1361a2b1d15741d3b0675" title="process the options within a hop by hop or destination option header">uip_process</a>(<a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> flag);
  1561. <a name="l01529"></a>01529
  1562. <a name="l01530"></a>01530 <span class="comment">/* The following flags are passed as an argument to the uip_process()</span>
  1563. <a name="l01531"></a>01531 <span class="comment"> function. They are used to distinguish between the two cases where</span>
  1564. <a name="l01532"></a>01532 <span class="comment"> uip_process() is called. It can be called either because we have</span>
  1565. <a name="l01533"></a>01533 <span class="comment"> incoming data that should be processed, or because the periodic</span>
  1566. <a name="l01534"></a>01534 <span class="comment"> timer has fired. These values are never used directly, but only in</span>
  1567. <a name="l01535"></a>01535 <span class="comment"> the macros defined in this file. */</span>
  1568. <a name="l01536"></a>01536
  1569. <a name="l01537"></a>01537 <span class="preprocessor">#define UIP_DATA 1 </span><span class="comment">/* Tells uIP that there is incoming</span>
  1570. <a name="l01538"></a>01538 <span class="comment"> data in the uip_buf buffer. The</span>
  1571. <a name="l01539"></a>01539 <span class="comment"> length of the data is stored in the</span>
  1572. <a name="l01540"></a>01540 <span class="comment"> global variable uip_len. */</span>
  1573. <a name="l01541"></a>01541 <span class="preprocessor">#define UIP_TIMER 2 </span><span class="comment">/* Tells uIP that the periodic timer</span>
  1574. <a name="l01542"></a>01542 <span class="comment"> has fired. */</span>
  1575. <a name="l01543"></a>01543 <span class="preprocessor">#define UIP_POLL_REQUEST 3 </span><span class="comment">/* Tells uIP that a connection should</span>
  1576. <a name="l01544"></a>01544 <span class="comment"> be polled. */</span>
  1577. <a name="l01545"></a>01545 <span class="preprocessor">#define UIP_UDP_SEND_CONN 4 </span><span class="comment">/* Tells uIP that a UDP datagram</span>
  1578. <a name="l01546"></a>01546 <span class="comment"> should be constructed in the</span>
  1579. <a name="l01547"></a>01547 <span class="comment"> uip_buf buffer. */</span>
  1580. <a name="l01548"></a>01548 <span class="preprocessor">#if UIP_UDP</span>
  1581. <a name="l01549"></a>01549 <span class="preprocessor"></span><span class="preprocessor">#define UIP_UDP_TIMER 5</span>
  1582. <a name="l01550"></a>01550 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_UDP */</span>
  1583. <a name="l01551"></a>01551
  1584. <a name="l01552"></a>01552 <span class="comment">/* The TCP states used in the uip_conn-&gt;tcpstateflags. */</span>
  1585. <a name="l01553"></a>01553 <span class="preprocessor">#define UIP_CLOSED 0</span>
  1586. <a name="l01554"></a>01554 <span class="preprocessor"></span><span class="preprocessor">#define UIP_SYN_RCVD 1</span>
  1587. <a name="l01555"></a>01555 <span class="preprocessor"></span><span class="preprocessor">#define UIP_SYN_SENT 2</span>
  1588. <a name="l01556"></a>01556 <span class="preprocessor"></span><span class="preprocessor">#define UIP_ESTABLISHED 3</span>
  1589. <a name="l01557"></a>01557 <span class="preprocessor"></span><span class="preprocessor">#define UIP_FIN_WAIT_1 4</span>
  1590. <a name="l01558"></a>01558 <span class="preprocessor"></span><span class="preprocessor">#define UIP_FIN_WAIT_2 5</span>
  1591. <a name="l01559"></a>01559 <span class="preprocessor"></span><span class="preprocessor">#define UIP_CLOSING 6</span>
  1592. <a name="l01560"></a>01560 <span class="preprocessor"></span><span class="preprocessor">#define UIP_TIME_WAIT 7</span>
  1593. <a name="l01561"></a>01561 <span class="preprocessor"></span><span class="preprocessor">#define UIP_LAST_ACK 8</span>
  1594. <a name="l01562"></a>01562 <span class="preprocessor"></span><span class="preprocessor">#define UIP_TS_MASK 15</span>
  1595. <a name="l01563"></a>01563 <span class="preprocessor"></span>
  1596. <a name="l01564"></a>01564 <span class="preprocessor">#define UIP_STOPPED 16</span>
  1597. <a name="l01565"></a>01565 <span class="preprocessor"></span>
  1598. <a name="l01566"></a>01566 <span class="comment">/* The TCP and IP headers. */</span>
  1599. <a name="l01567"></a>01567 <span class="keyword">struct </span>uip_tcpip_hdr {
  1600. <a name="l01568"></a>01568 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1601. <a name="l01569"></a>01569 <span class="preprocessor"></span> <span class="comment">/* IPv6 header. */</span>
  1602. <a name="l01570"></a>01570 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vtc,
  1603. <a name="l01571"></a>01571 tcflow;
  1604. <a name="l01572"></a>01572 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> flow;
  1605. <a name="l01573"></a>01573 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len[2];
  1606. <a name="l01574"></a>01574 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> proto, ttl;
  1607. <a name="l01575"></a>01575 uip_ip6addr_t srcipaddr, destipaddr;
  1608. <a name="l01576"></a>01576 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1609. <a name="l01577"></a>01577 <span class="comment">/* IPv4 header. */</span>
  1610. <a name="l01578"></a>01578 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vhl,
  1611. <a name="l01579"></a>01579 tos,
  1612. <a name="l01580"></a>01580 len[2],
  1613. <a name="l01581"></a>01581 ipid[2],
  1614. <a name="l01582"></a>01582 ipoffset[2],
  1615. <a name="l01583"></a>01583 ttl,
  1616. <a name="l01584"></a>01584 proto;
  1617. <a name="l01585"></a>01585 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> ipchksum;
  1618. <a name="l01586"></a>01586 <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> srcipaddr, destipaddr;
  1619. <a name="l01587"></a>01587 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1620. <a name="l01588"></a>01588
  1621. <a name="l01589"></a>01589 <span class="comment">/* TCP header. */</span>
  1622. <a name="l01590"></a>01590 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> srcport,
  1623. <a name="l01591"></a>01591 destport;
  1624. <a name="l01592"></a>01592 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> seqno[4],
  1625. <a name="l01593"></a>01593 ackno[4],
  1626. <a name="l01594"></a>01594 tcpoffset,
  1627. <a name="l01595"></a>01595 flags,
  1628. <a name="l01596"></a>01596 wnd[2];
  1629. <a name="l01597"></a>01597 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> tcpchksum;
  1630. <a name="l01598"></a>01598 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> urgp[2];
  1631. <a name="l01599"></a>01599 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> optdata[4];
  1632. <a name="l01600"></a>01600 };
  1633. <a name="l01601"></a>01601
  1634. <a name="l01602"></a>01602 <span class="comment">/* The ICMP and IP headers. */</span>
  1635. <a name="l01603"></a>01603 <span class="keyword">struct </span>uip_icmpip_hdr {
  1636. <a name="l01604"></a>01604 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1637. <a name="l01605"></a>01605 <span class="preprocessor"></span> <span class="comment">/* IPv6 header. */</span>
  1638. <a name="l01606"></a>01606 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vtc,
  1639. <a name="l01607"></a>01607 tcf;
  1640. <a name="l01608"></a>01608 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> flow;
  1641. <a name="l01609"></a>01609 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len[2];
  1642. <a name="l01610"></a>01610 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> proto, ttl;
  1643. <a name="l01611"></a>01611 uip_ip6addr_t srcipaddr, destipaddr;
  1644. <a name="l01612"></a>01612 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1645. <a name="l01613"></a>01613 <span class="comment">/* IPv4 header. */</span>
  1646. <a name="l01614"></a>01614 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vhl,
  1647. <a name="l01615"></a>01615 tos,
  1648. <a name="l01616"></a>01616 len[2],
  1649. <a name="l01617"></a>01617 ipid[2],
  1650. <a name="l01618"></a>01618 ipoffset[2],
  1651. <a name="l01619"></a>01619 ttl,
  1652. <a name="l01620"></a>01620 proto;
  1653. <a name="l01621"></a>01621 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> ipchksum;
  1654. <a name="l01622"></a>01622 <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> srcipaddr, destipaddr;
  1655. <a name="l01623"></a>01623 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1656. <a name="l01624"></a>01624
  1657. <a name="l01625"></a>01625 <span class="comment">/* ICMP header. */</span>
  1658. <a name="l01626"></a>01626 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> type, icode;
  1659. <a name="l01627"></a>01627 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> icmpchksum;
  1660. <a name="l01628"></a>01628 <span class="preprocessor">#if !UIP_CONF_IPV6</span>
  1661. <a name="l01629"></a>01629 <span class="preprocessor"></span> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> id, seqno;
  1662. <a name="l01630"></a>01630 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> payload[1];
  1663. <a name="l01631"></a>01631 <span class="preprocessor">#endif </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
  1664. <a name="l01632"></a>01632 };
  1665. <a name="l01633"></a>01633
  1666. <a name="l01634"></a>01634
  1667. <a name="l01635"></a>01635 <span class="comment">/* The UDP and IP headers. */</span>
  1668. <a name="l01636"></a>01636 <span class="keyword">struct </span>uip_udpip_hdr {
  1669. <a name="l01637"></a>01637 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1670. <a name="l01638"></a>01638 <span class="preprocessor"></span> <span class="comment">/* IPv6 header. */</span>
  1671. <a name="l01639"></a>01639 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vtc,
  1672. <a name="l01640"></a>01640 tcf;
  1673. <a name="l01641"></a>01641 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> flow;
  1674. <a name="l01642"></a>01642 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len[2];
  1675. <a name="l01643"></a>01643 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> proto, ttl;
  1676. <a name="l01644"></a>01644 uip_ip6addr_t srcipaddr, destipaddr;
  1677. <a name="l01645"></a>01645 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1678. <a name="l01646"></a>01646 <span class="comment">/* IP header. */</span>
  1679. <a name="l01647"></a>01647 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vhl,
  1680. <a name="l01648"></a>01648 tos,
  1681. <a name="l01649"></a>01649 len[2],
  1682. <a name="l01650"></a>01650 ipid[2],
  1683. <a name="l01651"></a>01651 ipoffset[2],
  1684. <a name="l01652"></a>01652 ttl,
  1685. <a name="l01653"></a>01653 proto;
  1686. <a name="l01654"></a>01654 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> ipchksum;
  1687. <a name="l01655"></a>01655 <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> srcipaddr, destipaddr;
  1688. <a name="l01656"></a>01656 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1689. <a name="l01657"></a>01657
  1690. <a name="l01658"></a>01658 <span class="comment">/* UDP header. */</span>
  1691. <a name="l01659"></a>01659 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> srcport,
  1692. <a name="l01660"></a>01660 destport;
  1693. <a name="l01661"></a>01661 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> udplen;
  1694. <a name="l01662"></a>01662 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> udpchksum;
  1695. <a name="l01663"></a>01663 };
  1696. <a name="l01664"></a>01664
  1697. <a name="l01665"></a>01665 <span class="comment">/*</span>
  1698. <a name="l01666"></a>01666 <span class="comment"> * In IPv6 the length of the L3 headers before the transport header is</span>
  1699. <a name="l01667"></a>01667 <span class="comment"> * not fixed, due to the possibility to include extension option headers</span>
  1700. <a name="l01668"></a>01668 <span class="comment"> * after the IP header. hence we split here L3 and L4 headers</span>
  1701. <a name="l01669"></a>01669 <span class="comment"> */</span>
  1702. <a name="l01670"></a>01670 <span class="comment">/* The IP header */</span>
  1703. <a name="l01671"></a>01671 <span class="keyword">struct </span>uip_ip_hdr {
  1704. <a name="l01672"></a>01672 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1705. <a name="l01673"></a>01673 <span class="preprocessor"></span> <span class="comment">/* IPV6 header */</span>
  1706. <a name="l01674"></a>01674 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vtc;
  1707. <a name="l01675"></a>01675 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> tcflow;
  1708. <a name="l01676"></a>01676 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> flow;
  1709. <a name="l01677"></a>01677 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len[2];
  1710. <a name="l01678"></a>01678 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> proto, ttl;
  1711. <a name="l01679"></a>01679 uip_ip6addr_t srcipaddr, destipaddr;
  1712. <a name="l01680"></a>01680 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1713. <a name="l01681"></a>01681 <span class="comment">/* IPV4 header */</span>
  1714. <a name="l01682"></a>01682 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> vhl,
  1715. <a name="l01683"></a>01683 tos,
  1716. <a name="l01684"></a>01684 len[2],
  1717. <a name="l01685"></a>01685 ipid[2],
  1718. <a name="l01686"></a>01686 ipoffset[2],
  1719. <a name="l01687"></a>01687 ttl,
  1720. <a name="l01688"></a>01688 proto;
  1721. <a name="l01689"></a>01689 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> ipchksum;
  1722. <a name="l01690"></a>01690 <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> srcipaddr, destipaddr;
  1723. <a name="l01691"></a>01691 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1724. <a name="l01692"></a>01692 };
  1725. <a name="l01693"></a>01693
  1726. <a name="l01694"></a>01694
  1727. <a name="l01695"></a>01695 <span class="comment">/*</span>
  1728. <a name="l01696"></a>01696 <span class="comment"> * IPv6 extension option headers: we are able to process</span>
  1729. <a name="l01697"></a>01697 <span class="comment"> * the 4 extension headers defined in RFC2460 (IPv6):</span>
  1730. <a name="l01698"></a>01698 <span class="comment"> * - Hop by hop option header, destination option header:</span>
  1731. <a name="l01699"></a>01699 <span class="comment"> * These two are not used by any core IPv6 protocol, hence</span>
  1732. <a name="l01700"></a>01700 <span class="comment"> * we just read them and go to the next. They convey options,</span>
  1733. <a name="l01701"></a>01701 <span class="comment"> * the options defined in RFC2460 are Pad1 and PadN, which do</span>
  1734. <a name="l01702"></a>01702 <span class="comment"> * some padding, and that we do not need to read (the length</span>
  1735. <a name="l01703"></a>01703 <span class="comment"> * field in the header is enough)</span>
  1736. <a name="l01704"></a>01704 <span class="comment"> * - Routing header: this one is most notably used by MIPv6,</span>
  1737. <a name="l01705"></a>01705 <span class="comment"> * which we do not implement, hence we just read it and go</span>
  1738. <a name="l01706"></a>01706 <span class="comment"> * to the next</span>
  1739. <a name="l01707"></a>01707 <span class="comment"> * - Fragmentation header: we read this header and are able to</span>
  1740. <a name="l01708"></a>01708 <span class="comment"> * reassemble packets</span>
  1741. <a name="l01709"></a>01709 <span class="comment"> *</span>
  1742. <a name="l01710"></a>01710 <span class="comment"> * We do not offer any means to send packets with extension headers</span>
  1743. <a name="l01711"></a>01711 <span class="comment"> *</span>
  1744. <a name="l01712"></a>01712 <span class="comment"> * We do not implement Authentication and ESP headers, which are</span>
  1745. <a name="l01713"></a>01713 <span class="comment"> * used in IPSec and defined in RFC4302,4303,4305,4385</span>
  1746. <a name="l01714"></a>01714 <span class="comment"> */</span>
  1747. <a name="l01715"></a>01715 <span class="comment">/* common header part */</span>
  1748. <a name="l01716"></a>01716 <span class="keyword">typedef</span> <span class="keyword">struct </span>uip_ext_hdr {
  1749. <a name="l01717"></a>01717 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> next;
  1750. <a name="l01718"></a>01718 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len;
  1751. <a name="l01719"></a>01719 } uip_ext_hdr;
  1752. <a name="l01720"></a>01720
  1753. <a name="l01721"></a>01721 <span class="comment">/* Hop by Hop option header */</span>
  1754. <a name="l01722"></a>01722 <span class="keyword">typedef</span> <span class="keyword">struct </span>uip_hbho_hdr {
  1755. <a name="l01723"></a>01723 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> next;
  1756. <a name="l01724"></a>01724 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len;
  1757. <a name="l01725"></a>01725 } uip_hbho_hdr;
  1758. <a name="l01726"></a>01726
  1759. <a name="l01727"></a>01727 <span class="comment">/* destination option header */</span>
  1760. <a name="l01728"></a>01728 <span class="keyword">typedef</span> <span class="keyword">struct </span>uip_desto_hdr {
  1761. <a name="l01729"></a>01729 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> next;
  1762. <a name="l01730"></a>01730 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len;
  1763. <a name="l01731"></a>01731 } uip_desto_hdr;
  1764. <a name="l01732"></a>01732
  1765. <a name="l01733"></a>01733 <span class="comment">/* We do not define structures for PAD1 and PADN options */</span>
  1766. <a name="l01734"></a>01734
  1767. <a name="l01735"></a>01735 <span class="comment">/*</span>
  1768. <a name="l01736"></a>01736 <span class="comment"> * routing header</span>
  1769. <a name="l01737"></a>01737 <span class="comment"> * the routing header as 4 common bytes, then routing header type</span>
  1770. <a name="l01738"></a>01738 <span class="comment"> * specific data there are several types of routing header. Type 0 was</span>
  1771. <a name="l01739"></a>01739 <span class="comment"> * deprecated as per RFC5095 most notable other type is 2, used in</span>
  1772. <a name="l01740"></a>01740 <span class="comment"> * RFC3775 (MIPv6) here we do not implement MIPv6, so we just need to</span>
  1773. <a name="l01741"></a>01741 <span class="comment"> * parse the 4 first bytes</span>
  1774. <a name="l01742"></a>01742 <span class="comment"> */</span>
  1775. <a name="l01743"></a>01743 <span class="keyword">typedef</span> <span class="keyword">struct </span>uip_routing_hdr {
  1776. <a name="l01744"></a>01744 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> next;
  1777. <a name="l01745"></a>01745 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len;
  1778. <a name="l01746"></a>01746 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> routing_type;
  1779. <a name="l01747"></a>01747 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> seg_left;
  1780. <a name="l01748"></a>01748 } uip_routing_hdr;
  1781. <a name="l01749"></a>01749
  1782. <a name="l01750"></a>01750 <span class="comment">/* fragmentation header */</span>
  1783. <a name="l01751"></a>01751 <span class="keyword">typedef</span> <span class="keyword">struct </span>uip_frag_hdr {
  1784. <a name="l01752"></a>01752 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> next;
  1785. <a name="l01753"></a>01753 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> res;
  1786. <a name="l01754"></a>01754 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> offsetresmore;
  1787. <a name="l01755"></a>01755 <a class="code" href="a01668.html#ga4c14294869aceba3ef9d4c0c302d0f33" title="The 32-bit unsigned data type.">u32_t</a> id;
  1788. <a name="l01756"></a>01756 } uip_frag_hdr;
  1789. <a name="l01757"></a>01757
  1790. <a name="l01758"></a>01758 <span class="comment">/*</span>
  1791. <a name="l01759"></a>01759 <span class="comment"> * an option within the destination or hop by hop option headers</span>
  1792. <a name="l01760"></a>01760 <span class="comment"> * it contains type an length, which is true for all options but PAD1</span>
  1793. <a name="l01761"></a>01761 <span class="comment"> */</span>
  1794. <a name="l01762"></a>01762 <span class="keyword">typedef</span> <span class="keyword">struct </span>uip_ext_hdr_opt {
  1795. <a name="l01763"></a>01763 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> type;
  1796. <a name="l01764"></a>01764 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> len;
  1797. <a name="l01765"></a>01765 } uip_ext_hdr_opt;
  1798. <a name="l01766"></a>01766
  1799. <a name="l01767"></a>01767 <span class="comment">/* PADN option */</span>
  1800. <a name="l01768"></a>01768 <span class="keyword">typedef</span> <span class="keyword">struct </span>uip_ext_hdr_opt_padn {
  1801. <a name="l01769"></a>01769 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> opt_type;
  1802. <a name="l01770"></a>01770 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> opt_len;
  1803. <a name="l01771"></a>01771 } uip_ext_hdr_opt_padn;
  1804. <a name="l01772"></a>01772
  1805. <a name="l01773"></a>01773 <span class="comment">/* TCP header */</span>
  1806. <a name="l01774"></a>01774 <span class="keyword">struct </span>uip_tcp_hdr {
  1807. <a name="l01775"></a>01775 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> srcport;
  1808. <a name="l01776"></a>01776 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> destport;
  1809. <a name="l01777"></a>01777 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> seqno[4];
  1810. <a name="l01778"></a>01778 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> ackno[4];
  1811. <a name="l01779"></a>01779 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> tcpoffset;
  1812. <a name="l01780"></a>01780 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> flags;
  1813. <a name="l01781"></a>01781 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> wnd[2];
  1814. <a name="l01782"></a>01782 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> tcpchksum;
  1815. <a name="l01783"></a>01783 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> urgp[2];
  1816. <a name="l01784"></a>01784 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> optdata[4];
  1817. <a name="l01785"></a>01785 };
  1818. <a name="l01786"></a>01786
  1819. <a name="l01787"></a>01787 <span class="comment">/* The ICMP headers. */</span>
  1820. <a name="l01788"></a>01788 <span class="keyword">struct </span>uip_icmp_hdr {
  1821. <a name="l01789"></a>01789 <a class="code" href="a01668.html#ga4caecabca98b43919dd11be1c0d4cd8e" title="The 8-bit unsigned data type.">u8_t</a> type, icode;
  1822. <a name="l01790"></a>01790 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> icmpchksum;
  1823. <a name="l01791"></a>01791 <span class="preprocessor">#if !UIP_CONF_IPV6</span>
  1824. <a name="l01792"></a>01792 <span class="preprocessor"></span> <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> id, seqno;
  1825. <a name="l01793"></a>01793 <span class="preprocessor">#endif </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
  1826. <a name="l01794"></a>01794 };
  1827. <a name="l01795"></a>01795
  1828. <a name="l01796"></a>01796
  1829. <a name="l01797"></a>01797 <span class="comment">/* The UDP headers. */</span>
  1830. <a name="l01798"></a>01798 <span class="keyword">struct </span>uip_udp_hdr {
  1831. <a name="l01799"></a>01799 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> srcport;
  1832. <a name="l01800"></a>01800 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> destport;
  1833. <a name="l01801"></a>01801 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> udplen;
  1834. <a name="l01802"></a>01802 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> udpchksum;
  1835. <a name="l01803"></a>01803 };
  1836. <a name="l01804"></a>01804
  1837. <a name="l01805"></a>01805 <span class="comment"></span>
  1838. <a name="l01806"></a>01806 <span class="comment">/**</span>
  1839. <a name="l01807"></a>01807 <span class="comment"> * The buffer size available for user data in the \ref uip_buf buffer.</span>
  1840. <a name="l01808"></a>01808 <span class="comment"> *</span>
  1841. <a name="l01809"></a>01809 <span class="comment"> * This macro holds the available size for user data in the \ref</span>
  1842. <a name="l01810"></a>01810 <span class="comment"> * uip_buf buffer. The macro is intended to be used for checking</span>
  1843. <a name="l01811"></a>01811 <span class="comment"> * bounds of available user data.</span>
  1844. <a name="l01812"></a>01812 <span class="comment"> *</span>
  1845. <a name="l01813"></a>01813 <span class="comment"> * Example:</span>
  1846. <a name="l01814"></a>01814 <span class="comment"> \code</span>
  1847. <a name="l01815"></a>01815 <span class="comment"> snprintf(uip_appdata, UIP_APPDATA_SIZE, &quot;%u\n&quot;, i);</span>
  1848. <a name="l01816"></a>01816 <span class="comment"> \endcode</span>
  1849. <a name="l01817"></a>01817 <span class="comment"> *</span>
  1850. <a name="l01818"></a>01818 <span class="comment"> * \hideinitializer</span>
  1851. <a name="l01819"></a>01819 <span class="comment"> */</span>
  1852. <a name="l01820"></a><a class="code" href="a01684.html#gae0825474feee11b4e038bfe71757875f">01820</a> <span class="preprocessor">#define UIP_APPDATA_SIZE (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN)</span>
  1853. <a name="l01821"></a>01821 <span class="preprocessor"></span><span class="preprocessor">#define UIP_APPDATA_PTR (void *)&amp;uip_buf[UIP_LLH_LEN + UIP_TCPIP_HLEN]</span>
  1854. <a name="l01822"></a>01822 <span class="preprocessor"></span>
  1855. <a name="l01823"></a>01823 <span class="preprocessor">#define UIP_PROTO_ICMP 1</span>
  1856. <a name="l01824"></a>01824 <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_TCP 6</span>
  1857. <a name="l01825"></a>01825 <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_UDP 17</span>
  1858. <a name="l01826"></a>01826 <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_ICMP6 58</span>
  1859. <a name="l01827"></a>01827 <span class="preprocessor"></span>
  1860. <a name="l01828"></a>01828
  1861. <a name="l01829"></a>01829 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1862. <a name="l01830"></a>01830 <span class="preprocessor"></span><span class="comment">/** @{ */</span><span class="comment"></span>
  1863. <a name="l01831"></a>01831 <span class="comment">/** \brief extension headers types */</span>
  1864. <a name="l01832"></a>01832 <span class="preprocessor">#define UIP_PROTO_HBHO 0</span>
  1865. <a name="l01833"></a>01833 <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_DESTO 60</span>
  1866. <a name="l01834"></a>01834 <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_ROUTING 43</span>
  1867. <a name="l01835"></a>01835 <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_FRAG 44</span>
  1868. <a name="l01836"></a>01836 <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_NONE 59</span>
  1869. <a name="l01837"></a>01837 <span class="preprocessor"></span><span class="comment">/** @} */</span>
  1870. <a name="l01838"></a>01838 <span class="comment"></span>
  1871. <a name="l01839"></a>01839 <span class="comment">/** @{ */</span><span class="comment"></span>
  1872. <a name="l01840"></a>01840 <span class="comment">/** \brief Destination and Hop By Hop extension headers option types */</span>
  1873. <a name="l01841"></a>01841 <span class="preprocessor">#define UIP_EXT_HDR_OPT_PAD1 0</span>
  1874. <a name="l01842"></a>01842 <span class="preprocessor"></span><span class="preprocessor">#define UIP_EXT_HDR_OPT_PADN 1</span>
  1875. <a name="l01843"></a>01843 <span class="preprocessor"></span><span class="comment">/** @} */</span>
  1876. <a name="l01844"></a>01844 <span class="comment"></span>
  1877. <a name="l01845"></a>01845 <span class="comment">/** @{ */</span><span class="comment"></span>
  1878. <a name="l01846"></a>01846 <span class="comment">/**</span>
  1879. <a name="l01847"></a>01847 <span class="comment"> * \brief Bitmaps for extension header processing</span>
  1880. <a name="l01848"></a>01848 <span class="comment"> *</span>
  1881. <a name="l01849"></a>01849 <span class="comment"> * When processing extension headers, we should record somehow which one we</span>
  1882. <a name="l01850"></a>01850 <span class="comment"> * see, because you cannot have twice the same header, except for destination</span>
  1883. <a name="l01851"></a>01851 <span class="comment"> * We store all this in one u8_t bitmap one bit for each header expected. The</span>
  1884. <a name="l01852"></a>01852 <span class="comment"> * order in the bitmap is the order recommended in RFC2460</span>
  1885. <a name="l01853"></a>01853 <span class="comment"> */</span>
  1886. <a name="l01854"></a>01854 <span class="preprocessor">#define UIP_EXT_HDR_BITMAP_HBHO 0x01</span>
  1887. <a name="l01855"></a>01855 <span class="preprocessor"></span><span class="preprocessor">#define UIP_EXT_HDR_BITMAP_DESTO1 0x02</span>
  1888. <a name="l01856"></a>01856 <span class="preprocessor"></span><span class="preprocessor">#define UIP_EXT_HDR_BITMAP_ROUTING 0x04</span>
  1889. <a name="l01857"></a>01857 <span class="preprocessor"></span><span class="preprocessor">#define UIP_EXT_HDR_BITMAP_FRAG 0x08</span>
  1890. <a name="l01858"></a>01858 <span class="preprocessor"></span><span class="preprocessor">#define UIP_EXT_HDR_BITMAP_AH 0x10</span>
  1891. <a name="l01859"></a>01859 <span class="preprocessor"></span><span class="preprocessor">#define UIP_EXT_HDR_BITMAP_ESP 0x20</span>
  1892. <a name="l01860"></a>01860 <span class="preprocessor"></span><span class="preprocessor">#define UIP_EXT_HDR_BITMAP_DESTO2 0x40</span>
  1893. <a name="l01861"></a>01861 <span class="preprocessor"></span><span class="comment">/** @} */</span>
  1894. <a name="l01862"></a>01862
  1895. <a name="l01863"></a>01863
  1896. <a name="l01864"></a>01864 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1897. <a name="l01865"></a>01865
  1898. <a name="l01866"></a>01866
  1899. <a name="l01867"></a>01867 <span class="comment">/* Header sizes. */</span>
  1900. <a name="l01868"></a>01868 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1901. <a name="l01869"></a>01869 <span class="preprocessor"></span><span class="preprocessor">#define UIP_IPH_LEN 40</span>
  1902. <a name="l01870"></a>01870 <span class="preprocessor"></span><span class="preprocessor">#define UIP_FRAGH_LEN 8</span>
  1903. <a name="l01871"></a>01871 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1904. <a name="l01872"></a>01872 <span class="preprocessor">#define UIP_IPH_LEN 20 </span><span class="comment">/* Size of IP header */</span>
  1905. <a name="l01873"></a>01873 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
  1906. <a name="l01874"></a>01874
  1907. <a name="l01875"></a>01875 <span class="preprocessor">#define UIP_UDPH_LEN 8 </span><span class="comment">/* Size of UDP header */</span>
  1908. <a name="l01876"></a>01876 <span class="preprocessor">#define UIP_TCPH_LEN 20 </span><span class="comment">/* Size of TCP header */</span>
  1909. <a name="l01877"></a>01877 <span class="preprocessor">#ifdef UIP_IPH_LEN</span>
  1910. <a name="l01878"></a>01878 <span class="preprocessor"></span><span class="preprocessor">#define UIP_ICMPH_LEN 4 </span><span class="comment">/* Size of ICMP header */</span>
  1911. <a name="l01879"></a>01879 <span class="preprocessor">#endif</span>
  1912. <a name="l01880"></a>01880 <span class="preprocessor"></span><span class="preprocessor">#define UIP_IPUDPH_LEN (UIP_UDPH_LEN + UIP_IPH_LEN) </span><span class="comment">/* Size of IP +</span>
  1913. <a name="l01881"></a>01881 <span class="comment"> * UDP</span>
  1914. <a name="l01882"></a>01882 <span class="comment"> * header */</span>
  1915. <a name="l01883"></a>01883 <span class="preprocessor">#define UIP_IPTCPH_LEN (UIP_TCPH_LEN + UIP_IPH_LEN) </span><span class="comment">/* Size of IP +</span>
  1916. <a name="l01884"></a>01884 <span class="comment"> * TCP</span>
  1917. <a name="l01885"></a>01885 <span class="comment"> * header */</span>
  1918. <a name="l01886"></a>01886 <span class="preprocessor">#define UIP_TCPIP_HLEN UIP_IPTCPH_LEN</span>
  1919. <a name="l01887"></a>01887 <span class="preprocessor"></span><span class="preprocessor">#define UIP_IPICMPH_LEN (UIP_IPH_LEN + UIP_ICMPH_LEN) </span><span class="comment">/* size of ICMP</span>
  1920. <a name="l01888"></a>01888 <span class="comment"> + IP header */</span>
  1921. <a name="l01889"></a>01889 <span class="preprocessor">#define UIP_LLIPH_LEN (UIP_LLH_LEN + UIP_IPH_LEN) </span><span class="comment">/* size of L2</span>
  1922. <a name="l01890"></a>01890 <span class="comment"> + IP header */</span>
  1923. <a name="l01891"></a>01891 <span class="preprocessor">#if UIP_CONF_IPV6</span>
  1924. <a name="l01892"></a>01892 <span class="preprocessor"></span><span class="comment">/**</span>
  1925. <a name="l01893"></a>01893 <span class="comment"> * The sums below are quite used in ND. When used for uip_buf, we</span>
  1926. <a name="l01894"></a>01894 <span class="comment"> * include link layer length when used for uip_len, we do not, hence</span>
  1927. <a name="l01895"></a>01895 <span class="comment"> * we need values with and without LLH_LEN we do not use capital</span>
  1928. <a name="l01896"></a>01896 <span class="comment"> * letters as these values are variable</span>
  1929. <a name="l01897"></a>01897 <span class="comment"> */</span>
  1930. <a name="l01898"></a>01898 <span class="preprocessor">#define uip_l2_l3_hdr_len (UIP_LLH_LEN + UIP_IPH_LEN + uip_ext_len)</span>
  1931. <a name="l01899"></a>01899 <span class="preprocessor"></span><span class="preprocessor">#define uip_l2_l3_icmp_hdr_len (UIP_LLH_LEN + UIP_IPH_LEN + uip_ext_len + UIP_ICMPH_LEN)</span>
  1932. <a name="l01900"></a>01900 <span class="preprocessor"></span><span class="preprocessor">#define uip_l3_hdr_len (UIP_IPH_LEN + uip_ext_len)</span>
  1933. <a name="l01901"></a>01901 <span class="preprocessor"></span><span class="preprocessor">#define uip_l3_icmp_hdr_len (UIP_IPH_LEN + uip_ext_len + UIP_ICMPH_LEN)</span>
  1934. <a name="l01902"></a>01902 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/*UIP_CONF_IPV6*/</span>
  1935. <a name="l01903"></a>01903
  1936. <a name="l01904"></a>01904
  1937. <a name="l01905"></a>01905 <span class="preprocessor">#if UIP_FIXEDADDR</span>
  1938. <a name="l01906"></a>01906 <span class="preprocessor"></span>CCIF <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> uip_hostaddr, uip_netmask, uip_draddr;
  1939. <a name="l01907"></a>01907 <span class="preprocessor">#else </span><span class="comment">/* UIP_FIXEDADDR */</span>
  1940. <a name="l01908"></a>01908 CCIF <span class="keyword">extern</span> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> uip_hostaddr, uip_netmask, uip_draddr;
  1941. <a name="l01909"></a>01909 <span class="preprocessor">#endif </span><span class="comment">/* UIP_FIXEDADDR */</span>
  1942. <a name="l01910"></a>01910 CCIF <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> uip_broadcast_addr;
  1943. <a name="l01911"></a>01911 CCIF <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="a00106.html" title="Representation of an IP address.">uip_ipaddr_t</a> uip_all_zeroes_addr;
  1944. <a name="l01912"></a>01912
  1945. <a name="l01913"></a>01913 <span class="preprocessor">#if UIP_FIXEDETHADDR</span>
  1946. <a name="l01914"></a>01914 <span class="preprocessor"></span>CCIF <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="a00102.html" title="802.3 address">uip_lladdr_t</a> <a class="code" href="a01684.html#ga89bf167a9f1014d2d78754742eb7e06d" title="Host L2 address.">uip_lladdr</a>;
  1947. <a name="l01915"></a>01915 <span class="preprocessor">#else</span>
  1948. <a name="l01916"></a>01916 <span class="preprocessor"></span>CCIF <span class="keyword">extern</span> <a class="code" href="a00102.html" title="802.3 address">uip_lladdr_t</a> <a class="code" href="a01684.html#ga89bf167a9f1014d2d78754742eb7e06d" title="Host L2 address.">uip_lladdr</a>;
  1949. <a name="l01917"></a>01917 <span class="preprocessor">#endif</span>
  1950. <a name="l01918"></a>01918 <span class="preprocessor"></span>
  1951. <a name="l01919"></a>01919
  1952. <a name="l01920"></a>01920
  1953. <a name="l01921"></a>01921
  1954. <a name="l01922"></a>01922 <span class="preprocessor">#ifdef UIP_CONF_IPV6</span>
  1955. <a name="l01923"></a>01923 <span class="preprocessor"></span><span class="comment">/** Length of the link local prefix */</span>
  1956. <a name="l01924"></a>01924 <span class="preprocessor">#define UIP_LLPREF_LEN 10</span>
  1957. <a name="l01925"></a>01925 <span class="preprocessor"></span><span class="comment"></span>
  1958. <a name="l01926"></a>01926 <span class="comment">/**</span>
  1959. <a name="l01927"></a>01927 <span class="comment"> * \brief Is IPv6 address a the unspecified address</span>
  1960. <a name="l01928"></a>01928 <span class="comment"> * a is of type uip_ipaddr_t</span>
  1961. <a name="l01929"></a>01929 <span class="comment"> */</span>
  1962. <a name="l01930"></a>01930 <span class="preprocessor">#define uip_is_addr_loopback(a) \</span>
  1963. <a name="l01931"></a>01931 <span class="preprocessor"> ((((a)-&gt;u16[0]) == 0) &amp;&amp; \</span>
  1964. <a name="l01932"></a>01932 <span class="preprocessor"> (((a)-&gt;u16[1]) == 0) &amp;&amp; \</span>
  1965. <a name="l01933"></a>01933 <span class="preprocessor"> (((a)-&gt;u16[2]) == 0) &amp;&amp; \</span>
  1966. <a name="l01934"></a>01934 <span class="preprocessor"> (((a)-&gt;u16[3]) == 0) &amp;&amp; \</span>
  1967. <a name="l01935"></a>01935 <span class="preprocessor"> (((a)-&gt;u16[4]) == 0) &amp;&amp; \</span>
  1968. <a name="l01936"></a>01936 <span class="preprocessor"> (((a)-&gt;u16[5]) == 0) &amp;&amp; \</span>
  1969. <a name="l01937"></a>01937 <span class="preprocessor"> (((a)-&gt;u16[6]) == 0) &amp;&amp; \</span>
  1970. <a name="l01938"></a>01938 <span class="preprocessor"> (((a)-&gt;u16[7]) == 1))</span>
  1971. <a name="l01939"></a>01939 <span class="preprocessor"></span><span class="comment">/**</span>
  1972. <a name="l01940"></a>01940 <span class="comment"> * \brief Is IPv6 address a the unspecified address</span>
  1973. <a name="l01941"></a>01941 <span class="comment"> * a is of type uip_ipaddr_t</span>
  1974. <a name="l01942"></a>01942 <span class="comment"> */</span>
  1975. <a name="l01943"></a>01943 <span class="preprocessor">#define uip_is_addr_unspecified(a) \</span>
  1976. <a name="l01944"></a>01944 <span class="preprocessor"> ((((a)-&gt;u16[0]) == 0) &amp;&amp; \</span>
  1977. <a name="l01945"></a>01945 <span class="preprocessor"> (((a)-&gt;u16[1]) == 0) &amp;&amp; \</span>
  1978. <a name="l01946"></a>01946 <span class="preprocessor"> (((a)-&gt;u16[2]) == 0) &amp;&amp; \</span>
  1979. <a name="l01947"></a>01947 <span class="preprocessor"> (((a)-&gt;u16[3]) == 0) &amp;&amp; \</span>
  1980. <a name="l01948"></a>01948 <span class="preprocessor"> (((a)-&gt;u16[4]) == 0) &amp;&amp; \</span>
  1981. <a name="l01949"></a>01949 <span class="preprocessor"> (((a)-&gt;u16[5]) == 0) &amp;&amp; \</span>
  1982. <a name="l01950"></a>01950 <span class="preprocessor"> (((a)-&gt;u16[6]) == 0) &amp;&amp; \</span>
  1983. <a name="l01951"></a>01951 <span class="preprocessor"> (((a)-&gt;u16[7]) == 0))</span>
  1984. <a name="l01952"></a>01952 <span class="preprocessor"></span><span class="comment"></span>
  1985. <a name="l01953"></a>01953 <span class="comment">/** \brief Is IPv6 address a the link local all-nodes multicast address */</span>
  1986. <a name="l01954"></a>01954 <span class="preprocessor">#define uip_is_addr_linklocal_allnodes_mcast(a) \</span>
  1987. <a name="l01955"></a>01955 <span class="preprocessor"> ((((a)-&gt;u8[0]) == 0xff) &amp;&amp; \</span>
  1988. <a name="l01956"></a>01956 <span class="preprocessor"> (((a)-&gt;u8[1]) == 0x02) &amp;&amp; \</span>
  1989. <a name="l01957"></a>01957 <span class="preprocessor"> (((a)-&gt;u16[1]) == 0) &amp;&amp; \</span>
  1990. <a name="l01958"></a>01958 <span class="preprocessor"> (((a)-&gt;u16[2]) == 0) &amp;&amp; \</span>
  1991. <a name="l01959"></a>01959 <span class="preprocessor"> (((a)-&gt;u16[3]) == 0) &amp;&amp; \</span>
  1992. <a name="l01960"></a>01960 <span class="preprocessor"> (((a)-&gt;u16[4]) == 0) &amp;&amp; \</span>
  1993. <a name="l01961"></a>01961 <span class="preprocessor"> (((a)-&gt;u16[5]) == 0) &amp;&amp; \</span>
  1994. <a name="l01962"></a>01962 <span class="preprocessor"> (((a)-&gt;u16[6]) == 0) &amp;&amp; \</span>
  1995. <a name="l01963"></a>01963 <span class="preprocessor"> (((a)-&gt;u8[14]) == 0) &amp;&amp; \</span>
  1996. <a name="l01964"></a>01964 <span class="preprocessor"> (((a)-&gt;u8[15]) == 0x01))</span>
  1997. <a name="l01965"></a>01965 <span class="preprocessor"></span><span class="comment"></span>
  1998. <a name="l01966"></a>01966 <span class="comment">/** \brief Is IPv6 address a the link local all-routers multicast address */</span>
  1999. <a name="l01967"></a>01967 <span class="preprocessor">#define uip_is_addr_linklocal_allrouters_mcast(a) \</span>
  2000. <a name="l01968"></a>01968 <span class="preprocessor"> ((((a)-&gt;u8[0]) == 0xff) &amp;&amp; \</span>
  2001. <a name="l01969"></a>01969 <span class="preprocessor"> (((a)-&gt;u8[1]) == 0x02) &amp;&amp; \</span>
  2002. <a name="l01970"></a>01970 <span class="preprocessor"> (((a)-&gt;u16[1]) == 0) &amp;&amp; \</span>
  2003. <a name="l01971"></a>01971 <span class="preprocessor"> (((a)-&gt;u16[2]) == 0) &amp;&amp; \</span>
  2004. <a name="l01972"></a>01972 <span class="preprocessor"> (((a)-&gt;u16[3]) == 0) &amp;&amp; \</span>
  2005. <a name="l01973"></a>01973 <span class="preprocessor"> (((a)-&gt;u16[4]) == 0) &amp;&amp; \</span>
  2006. <a name="l01974"></a>01974 <span class="preprocessor"> (((a)-&gt;u16[5]) == 0) &amp;&amp; \</span>
  2007. <a name="l01975"></a>01975 <span class="preprocessor"> (((a)-&gt;u16[6]) == 0) &amp;&amp; \</span>
  2008. <a name="l01976"></a>01976 <span class="preprocessor"> (((a)-&gt;u8[14]) == 0) &amp;&amp; \</span>
  2009. <a name="l01977"></a>01977 <span class="preprocessor"> (((a)-&gt;u8[15]) == 0x02))</span>
  2010. <a name="l01978"></a>01978 <span class="preprocessor"></span><span class="comment"></span>
  2011. <a name="l01979"></a>01979 <span class="comment">/**</span>
  2012. <a name="l01980"></a>01980 <span class="comment"> * \brief Checks whether the address a is link local.</span>
  2013. <a name="l01981"></a>01981 <span class="comment"> * a is of type uip_ipaddr_t</span>
  2014. <a name="l01982"></a>01982 <span class="comment"> */</span>
  2015. <a name="l01983"></a>01983 <span class="preprocessor">#define uip_is_addr_linklocal(a) \</span>
  2016. <a name="l01984"></a>01984 <span class="preprocessor"> ((a)-&gt;u8[0] == 0xfe &amp;&amp; \</span>
  2017. <a name="l01985"></a>01985 <span class="preprocessor"> (a)-&gt;u8[1] == 0x80)</span>
  2018. <a name="l01986"></a>01986 <span class="preprocessor"></span><span class="comment"></span>
  2019. <a name="l01987"></a>01987 <span class="comment">/** \brief set IP address a to unspecified */</span>
  2020. <a name="l01988"></a>01988 <span class="preprocessor">#define uip_create_unspecified(a) uip_ip6addr(a, 0, 0, 0, 0, 0, 0, 0, 0)</span>
  2021. <a name="l01989"></a>01989 <span class="preprocessor"></span><span class="comment"></span>
  2022. <a name="l01990"></a>01990 <span class="comment">/** \brief set IP address a to the link local all-nodes multicast address */</span>
  2023. <a name="l01991"></a>01991 <span class="preprocessor">#define uip_create_linklocal_allnodes_mcast(a) uip_ip6addr(a, 0xff02, 0, 0, 0, 0, 0, 0, 0x0001)</span>
  2024. <a name="l01992"></a>01992 <span class="preprocessor"></span><span class="comment"></span>
  2025. <a name="l01993"></a>01993 <span class="comment">/** \brief set IP address a to the link local all-routers multicast address */</span>
  2026. <a name="l01994"></a>01994 <span class="preprocessor">#define uip_create_linklocal_allrouters_mcast(a) uip_ip6addr(a, 0xff02, 0, 0, 0, 0, 0, 0, 0x0002)</span>
  2027. <a name="l01995"></a>01995 <span class="preprocessor"></span><span class="preprocessor">#define uip_create_linklocal_prefix(addr) do { \</span>
  2028. <a name="l01996"></a>01996 <span class="preprocessor"> (addr)-&gt;u16[0] = UIP_HTONS(0xfe80); \</span>
  2029. <a name="l01997"></a>01997 <span class="preprocessor"> (addr)-&gt;u16[1] = 0; \</span>
  2030. <a name="l01998"></a>01998 <span class="preprocessor"> (addr)-&gt;u16[2] = 0; \</span>
  2031. <a name="l01999"></a>01999 <span class="preprocessor"> (addr)-&gt;u16[3] = 0; \</span>
  2032. <a name="l02000"></a>02000 <span class="preprocessor"> } while(0)</span>
  2033. <a name="l02001"></a>02001 <span class="preprocessor"></span><span class="comment"></span>
  2034. <a name="l02002"></a>02002 <span class="comment">/**</span>
  2035. <a name="l02003"></a>02003 <span class="comment"> * \brief is addr (a) a solicited node multicast address, see RFC3513</span>
  2036. <a name="l02004"></a>02004 <span class="comment"> * a is of type uip_ipaddr_t*</span>
  2037. <a name="l02005"></a>02005 <span class="comment"> */</span>
  2038. <a name="l02006"></a>02006 <span class="preprocessor">#define uip_is_addr_solicited_node(a) \</span>
  2039. <a name="l02007"></a>02007 <span class="preprocessor"> ((((a)-&gt;u8[0]) == 0xFF) &amp;&amp; \</span>
  2040. <a name="l02008"></a>02008 <span class="preprocessor"> (((a)-&gt;u8[1]) == 0x02) &amp;&amp; \</span>
  2041. <a name="l02009"></a>02009 <span class="preprocessor"> (((a)-&gt;u16[1]) == 0x00) &amp;&amp; \</span>
  2042. <a name="l02010"></a>02010 <span class="preprocessor"> (((a)-&gt;u16[2]) == 0x00) &amp;&amp; \</span>
  2043. <a name="l02011"></a>02011 <span class="preprocessor"> (((a)-&gt;u16[3]) == 0x00) &amp;&amp; \</span>
  2044. <a name="l02012"></a>02012 <span class="preprocessor"> (((a)-&gt;u16[4]) == 0x00) &amp;&amp; \</span>
  2045. <a name="l02013"></a>02013 <span class="preprocessor"> (((a)-&gt;u8[10]) == 0x00) &amp;&amp; \</span>
  2046. <a name="l02014"></a>02014 <span class="preprocessor"> (((a)-&gt;u8[11]) == 0x01) &amp;&amp; \</span>
  2047. <a name="l02015"></a>02015 <span class="preprocessor"> (((a)-&gt;u8[12]) == 0xFF))</span>
  2048. <a name="l02016"></a>02016 <span class="preprocessor"></span><span class="comment"></span>
  2049. <a name="l02017"></a>02017 <span class="comment">/**</span>
  2050. <a name="l02018"></a>02018 <span class="comment"> * \briefput in b the solicited node address corresponding to address a</span>
  2051. <a name="l02019"></a>02019 <span class="comment"> * both a and b are of type uip_ipaddr_t*</span>
  2052. <a name="l02020"></a>02020 <span class="comment"> * */</span>
  2053. <a name="l02021"></a>02021 <span class="preprocessor">#define uip_create_solicited_node(a, b) \</span>
  2054. <a name="l02022"></a>02022 <span class="preprocessor"> (((b)-&gt;u8[0]) = 0xFF); \</span>
  2055. <a name="l02023"></a>02023 <span class="preprocessor"> (((b)-&gt;u8[1]) = 0x02); \</span>
  2056. <a name="l02024"></a>02024 <span class="preprocessor"> (((b)-&gt;u16[1]) = 0); \</span>
  2057. <a name="l02025"></a>02025 <span class="preprocessor"> (((b)-&gt;u16[2]) = 0); \</span>
  2058. <a name="l02026"></a>02026 <span class="preprocessor"> (((b)-&gt;u16[3]) = 0); \</span>
  2059. <a name="l02027"></a>02027 <span class="preprocessor"> (((b)-&gt;u16[4]) = 0); \</span>
  2060. <a name="l02028"></a>02028 <span class="preprocessor"> (((b)-&gt;u8[10]) = 0); \</span>
  2061. <a name="l02029"></a>02029 <span class="preprocessor"> (((b)-&gt;u8[11]) = 0x01); \</span>
  2062. <a name="l02030"></a>02030 <span class="preprocessor"> (((b)-&gt;u8[12]) = 0xFF); \</span>
  2063. <a name="l02031"></a>02031 <span class="preprocessor"> (((b)-&gt;u8[13]) = ((a)-&gt;u8[13])); \</span>
  2064. <a name="l02032"></a>02032 <span class="preprocessor"> (((b)-&gt;u16[7]) = ((a)-&gt;u16[7]))</span>
  2065. <a name="l02033"></a>02033 <span class="preprocessor"></span><span class="comment"></span>
  2066. <a name="l02034"></a>02034 <span class="comment">/**</span>
  2067. <a name="l02035"></a>02035 <span class="comment"> * \brief is addr (a) a link local unicast address, see RFC3513</span>
  2068. <a name="l02036"></a>02036 <span class="comment"> * i.e. is (a) on prefix FE80::/10</span>
  2069. <a name="l02037"></a>02037 <span class="comment"> * a is of type uip_ipaddr_t*</span>
  2070. <a name="l02038"></a>02038 <span class="comment"> */</span>
  2071. <a name="l02039"></a>02039 <span class="preprocessor">#define uip_is_addr_link_local(a) \</span>
  2072. <a name="l02040"></a>02040 <span class="preprocessor"> ((((a)-&gt;u8[0]) == 0xFE) &amp;&amp; \</span>
  2073. <a name="l02041"></a>02041 <span class="preprocessor"> (((a)-&gt;u8[1]) == 0x80))</span>
  2074. <a name="l02042"></a>02042 <span class="preprocessor"></span><span class="comment"></span>
  2075. <a name="l02043"></a>02043 <span class="comment">/**</span>
  2076. <a name="l02044"></a>02044 <span class="comment"> * \brief was addr (a) forged based on the mac address m</span>
  2077. <a name="l02045"></a>02045 <span class="comment"> * a type is uip_ipaddr_t</span>
  2078. <a name="l02046"></a>02046 <span class="comment"> * m type is uiplladdr_t</span>
  2079. <a name="l02047"></a>02047 <span class="comment"> */</span>
  2080. <a name="l02048"></a>02048 <span class="preprocessor">#if UIP_CONF_LL_802154</span>
  2081. <a name="l02049"></a>02049 <span class="preprocessor"></span><span class="preprocessor">#define uip_is_addr_mac_addr_based(a, m) \</span>
  2082. <a name="l02050"></a>02050 <span class="preprocessor"> ((((a)-&gt;u8[8]) == (((m)-&gt;addr[0]) ^ 0x02)) &amp;&amp; \</span>
  2083. <a name="l02051"></a>02051 <span class="preprocessor"> (((a)-&gt;u8[9]) == (m)-&gt;addr[1]) &amp;&amp; \</span>
  2084. <a name="l02052"></a>02052 <span class="preprocessor"> (((a)-&gt;u8[10]) == (m)-&gt;addr[2]) &amp;&amp; \</span>
  2085. <a name="l02053"></a>02053 <span class="preprocessor"> (((a)-&gt;u8[11]) == (m)-&gt;addr[3]) &amp;&amp; \</span>
  2086. <a name="l02054"></a>02054 <span class="preprocessor"> (((a)-&gt;u8[12]) == (m)-&gt;addr[4]) &amp;&amp; \</span>
  2087. <a name="l02055"></a>02055 <span class="preprocessor"> (((a)-&gt;u8[13]) == (m)-&gt;addr[5]) &amp;&amp; \</span>
  2088. <a name="l02056"></a>02056 <span class="preprocessor"> (((a)-&gt;u8[14]) == (m)-&gt;addr[6]) &amp;&amp; \</span>
  2089. <a name="l02057"></a>02057 <span class="preprocessor"> (((a)-&gt;u8[15]) == (m)-&gt;addr[7]))</span>
  2090. <a name="l02058"></a>02058 <span class="preprocessor"></span><span class="preprocessor">#else</span>
  2091. <a name="l02059"></a>02059 <span class="preprocessor"></span>
  2092. <a name="l02060"></a>02060 <span class="preprocessor">#define uip_is_addr_mac_addr_based(a, m) \</span>
  2093. <a name="l02061"></a>02061 <span class="preprocessor"> ((((a)-&gt;u8[8]) == (((m)-&gt;addr[0]) | 0x02)) &amp;&amp; \</span>
  2094. <a name="l02062"></a>02062 <span class="preprocessor"> (((a)-&gt;u8[9]) == (m)-&gt;addr[1]) &amp;&amp; \</span>
  2095. <a name="l02063"></a>02063 <span class="preprocessor"> (((a)-&gt;u8[10]) == (m)-&gt;addr[2]) &amp;&amp; \</span>
  2096. <a name="l02064"></a>02064 <span class="preprocessor"> (((a)-&gt;u8[11]) == 0xff) &amp;&amp; \</span>
  2097. <a name="l02065"></a>02065 <span class="preprocessor"> (((a)-&gt;u8[12]) == 0xfe) &amp;&amp; \</span>
  2098. <a name="l02066"></a>02066 <span class="preprocessor"> (((a)-&gt;u8[13]) == (m)-&gt;addr[3]) &amp;&amp; \</span>
  2099. <a name="l02067"></a>02067 <span class="preprocessor"> (((a)-&gt;u8[14]) == (m)-&gt;addr[4]) &amp;&amp; \</span>
  2100. <a name="l02068"></a>02068 <span class="preprocessor"> (((a)-&gt;u8[15]) == (m)-&gt;addr[5]))</span>
  2101. <a name="l02069"></a>02069 <span class="preprocessor"></span>
  2102. <a name="l02070"></a>02070 <span class="preprocessor">#endif </span><span class="comment">/*UIP_CONF_LL_802154*/</span>
  2103. <a name="l02071"></a>02071 <span class="comment"></span>
  2104. <a name="l02072"></a>02072 <span class="comment">/**</span>
  2105. <a name="l02073"></a>02073 <span class="comment"> * \brief is address a multicast address, see RFC 3513</span>
  2106. <a name="l02074"></a>02074 <span class="comment"> * a is of type uip_ipaddr_t*</span>
  2107. <a name="l02075"></a>02075 <span class="comment"> * */</span>
  2108. <a name="l02076"></a>02076 <span class="preprocessor">#define uip_is_addr_mcast(a) \</span>
  2109. <a name="l02077"></a>02077 <span class="preprocessor"> (((a)-&gt;u8[0]) == 0xFF)</span>
  2110. <a name="l02078"></a>02078 <span class="preprocessor"></span><span class="comment"></span>
  2111. <a name="l02079"></a>02079 <span class="comment">/**</span>
  2112. <a name="l02080"></a>02080 <span class="comment"> * \brief is group-id of multicast address a</span>
  2113. <a name="l02081"></a>02081 <span class="comment"> * the all nodes group-id</span>
  2114. <a name="l02082"></a>02082 <span class="comment"> */</span>
  2115. <a name="l02083"></a>02083 <span class="preprocessor">#define uip_is_mcast_group_id_all_nodes(a) \</span>
  2116. <a name="l02084"></a>02084 <span class="preprocessor"> ((((a)-&gt;u16[1]) == 0) &amp;&amp; \</span>
  2117. <a name="l02085"></a>02085 <span class="preprocessor"> (((a)-&gt;u16[2]) == 0) &amp;&amp; \</span>
  2118. <a name="l02086"></a>02086 <span class="preprocessor"> (((a)-&gt;u16[3]) == 0) &amp;&amp; \</span>
  2119. <a name="l02087"></a>02087 <span class="preprocessor"> (((a)-&gt;u16[4]) == 0) &amp;&amp; \</span>
  2120. <a name="l02088"></a>02088 <span class="preprocessor"> (((a)-&gt;u16[5]) == 0) &amp;&amp; \</span>
  2121. <a name="l02089"></a>02089 <span class="preprocessor"> (((a)-&gt;u16[6]) == 0) &amp;&amp; \</span>
  2122. <a name="l02090"></a>02090 <span class="preprocessor"> (((a)-&gt;u8[14]) == 0) &amp;&amp; \</span>
  2123. <a name="l02091"></a>02091 <span class="preprocessor"> (((a)-&gt;u8[15]) == 1))</span>
  2124. <a name="l02092"></a>02092 <span class="preprocessor"></span><span class="comment"></span>
  2125. <a name="l02093"></a>02093 <span class="comment">/**</span>
  2126. <a name="l02094"></a>02094 <span class="comment"> * \brief is group-id of multicast address a</span>
  2127. <a name="l02095"></a>02095 <span class="comment"> * the all routers group-id</span>
  2128. <a name="l02096"></a>02096 <span class="comment"> */</span>
  2129. <a name="l02097"></a>02097 <span class="preprocessor">#define uip_is_mcast_group_id_all_routers(a) \</span>
  2130. <a name="l02098"></a>02098 <span class="preprocessor"> ((((a)-&gt;u16[1]) == 0) &amp;&amp; \</span>
  2131. <a name="l02099"></a>02099 <span class="preprocessor"> (((a)-&gt;u16[2]) == 0) &amp;&amp; \</span>
  2132. <a name="l02100"></a>02100 <span class="preprocessor"> (((a)-&gt;u16[3]) == 0) &amp;&amp; \</span>
  2133. <a name="l02101"></a>02101 <span class="preprocessor"> (((a)-&gt;u16[4]) == 0) &amp;&amp; \</span>
  2134. <a name="l02102"></a>02102 <span class="preprocessor"> (((a)-&gt;u16[5]) == 0) &amp;&amp; \</span>
  2135. <a name="l02103"></a>02103 <span class="preprocessor"> (((a)-&gt;u16[6]) == 0) &amp;&amp; \</span>
  2136. <a name="l02104"></a>02104 <span class="preprocessor"> (((a)-&gt;u8[14]) == 0) &amp;&amp; \</span>
  2137. <a name="l02105"></a>02105 <span class="preprocessor"> (((a)-&gt;u8[15]) == 2))</span>
  2138. <a name="l02106"></a>02106 <span class="preprocessor"></span>
  2139. <a name="l02107"></a>02107 <span class="comment"></span>
  2140. <a name="l02108"></a>02108 <span class="comment">/**</span>
  2141. <a name="l02109"></a>02109 <span class="comment"> * \brief are last three bytes of both addresses equal?</span>
  2142. <a name="l02110"></a>02110 <span class="comment"> * This is used to compare solicited node multicast addresses</span>
  2143. <a name="l02111"></a>02111 <span class="comment"> */</span>
  2144. <a name="l02112"></a>02112 <span class="preprocessor">#define uip_are_solicited_bytes_equal(a, b) \</span>
  2145. <a name="l02113"></a>02113 <span class="preprocessor"> ((((a)-&gt;u8[13]) == ((b)-&gt;u8[13])) &amp;&amp; \</span>
  2146. <a name="l02114"></a>02114 <span class="preprocessor"> (((a)-&gt;u8[14]) == ((b)-&gt;u8[14])) &amp;&amp; \</span>
  2147. <a name="l02115"></a>02115 <span class="preprocessor"> (((a)-&gt;u8[15]) == ((b)-&gt;u8[15])))</span>
  2148. <a name="l02116"></a>02116 <span class="preprocessor"></span>
  2149. <a name="l02117"></a>02117 <span class="preprocessor">#endif </span><span class="comment">/*UIP_CONF_IPV6*/</span>
  2150. <a name="l02118"></a>02118 <span class="comment"></span>
  2151. <a name="l02119"></a>02119 <span class="comment">/**</span>
  2152. <a name="l02120"></a>02120 <span class="comment"> * Calculate the Internet checksum over a buffer.</span>
  2153. <a name="l02121"></a>02121 <span class="comment"> *</span>
  2154. <a name="l02122"></a>02122 <span class="comment"> * The Internet checksum is the one&apos;s complement of the one&apos;s</span>
  2155. <a name="l02123"></a>02123 <span class="comment"> * complement sum of all 16-bit words in the buffer.</span>
  2156. <a name="l02124"></a>02124 <span class="comment"> *</span>
  2157. <a name="l02125"></a>02125 <span class="comment"> * See RFC1071.</span>
  2158. <a name="l02126"></a>02126 <span class="comment"> *</span>
  2159. <a name="l02127"></a>02127 <span class="comment"> * \param buf A pointer to the buffer over which the checksum is to be</span>
  2160. <a name="l02128"></a>02128 <span class="comment"> * computed.</span>
  2161. <a name="l02129"></a>02129 <span class="comment"> *</span>
  2162. <a name="l02130"></a>02130 <span class="comment"> * \param len The length of the buffer over which the checksum is to</span>
  2163. <a name="l02131"></a>02131 <span class="comment"> * be computed.</span>
  2164. <a name="l02132"></a>02132 <span class="comment"> *</span>
  2165. <a name="l02133"></a>02133 <span class="comment"> * \return The Internet checksum of the buffer.</span>
  2166. <a name="l02134"></a>02134 <span class="comment"> */</span>
  2167. <a name="l02135"></a>02135 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a01684.html#gab6683dd83fe1c8de9a24086d4b69e907" title="Calculate the Internet checksum over a buffer.">uip_chksum</a>(<a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> *buf, <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> len);
  2168. <a name="l02136"></a>02136 <span class="comment"></span>
  2169. <a name="l02137"></a>02137 <span class="comment">/**</span>
  2170. <a name="l02138"></a>02138 <span class="comment"> * Calculate the IP header checksum of the packet header in uip_buf.</span>
  2171. <a name="l02139"></a>02139 <span class="comment"> *</span>
  2172. <a name="l02140"></a>02140 <span class="comment"> * The IP header checksum is the Internet checksum of the 20 bytes of</span>
  2173. <a name="l02141"></a>02141 <span class="comment"> * the IP header.</span>
  2174. <a name="l02142"></a>02142 <span class="comment"> *</span>
  2175. <a name="l02143"></a>02143 <span class="comment"> * \return The IP header checksum of the IP header in the uip_buf</span>
  2176. <a name="l02144"></a>02144 <span class="comment"> * buffer.</span>
  2177. <a name="l02145"></a>02145 <span class="comment"> */</span>
  2178. <a name="l02146"></a>02146 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a01684.html#ga2addf34c7d457c1a7899a7e2171ef1e9" title="Calculate the IP header checksum of the packet header in uip_buf.">uip_ipchksum</a>(<span class="keywordtype">void</span>);
  2179. <a name="l02147"></a>02147 <span class="comment"></span>
  2180. <a name="l02148"></a>02148 <span class="comment">/**</span>
  2181. <a name="l02149"></a>02149 <span class="comment"> * Calculate the TCP checksum of the packet in uip_buf and uip_appdata.</span>
  2182. <a name="l02150"></a>02150 <span class="comment"> *</span>
  2183. <a name="l02151"></a>02151 <span class="comment"> * The TCP checksum is the Internet checksum of data contents of the</span>
  2184. <a name="l02152"></a>02152 <span class="comment"> * TCP segment, and a pseudo-header as defined in RFC793.</span>
  2185. <a name="l02153"></a>02153 <span class="comment"> *</span>
  2186. <a name="l02154"></a>02154 <span class="comment"> * \return The TCP checksum of the TCP segment in uip_buf and pointed</span>
  2187. <a name="l02155"></a>02155 <span class="comment"> * to by uip_appdata.</span>
  2188. <a name="l02156"></a>02156 <span class="comment"> */</span>
  2189. <a name="l02157"></a>02157 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a01684.html#ga85b65e38aa74eba18979156f97a94a87" title="Calculate the TCP checksum of the packet in uip_buf and uip_appdata.">uip_tcpchksum</a>(<span class="keywordtype">void</span>);
  2190. <a name="l02158"></a>02158 <span class="comment"></span>
  2191. <a name="l02159"></a>02159 <span class="comment">/**</span>
  2192. <a name="l02160"></a>02160 <span class="comment"> * Calculate the UDP checksum of the packet in uip_buf and uip_appdata.</span>
  2193. <a name="l02161"></a>02161 <span class="comment"> *</span>
  2194. <a name="l02162"></a>02162 <span class="comment"> * The UDP checksum is the Internet checksum of data contents of the</span>
  2195. <a name="l02163"></a>02163 <span class="comment"> * UDP segment, and a pseudo-header as defined in RFC768.</span>
  2196. <a name="l02164"></a>02164 <span class="comment"> *</span>
  2197. <a name="l02165"></a>02165 <span class="comment"> * \return The UDP checksum of the UDP segment in uip_buf and pointed</span>
  2198. <a name="l02166"></a>02166 <span class="comment"> * to by uip_appdata.</span>
  2199. <a name="l02167"></a>02167 <span class="comment"> */</span>
  2200. <a name="l02168"></a>02168 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a01684.html#ga7023a34ba9e9d03b5fbedbcb32924453" title="Calculate the UDP checksum of the packet in uip_buf and uip_appdata.">uip_udpchksum</a>(<span class="keywordtype">void</span>);
  2201. <a name="l02169"></a>02169 <span class="comment"></span>
  2202. <a name="l02170"></a>02170 <span class="comment">/**</span>
  2203. <a name="l02171"></a>02171 <span class="comment"> * Calculate the ICMP checksum of the packet in uip_buf.</span>
  2204. <a name="l02172"></a>02172 <span class="comment"> *</span>
  2205. <a name="l02173"></a>02173 <span class="comment"> * \return The ICMP checksum of the ICMP packet in uip_buf</span>
  2206. <a name="l02174"></a>02174 <span class="comment"> */</span>
  2207. <a name="l02175"></a>02175 <a class="code" href="a01668.html#ga77570ac4fcab86864fa1916e55676da2" title="The 16-bit unsigned data type.">u16_t</a> <a class="code" href="a01684.html#ga5e6741b8bd3e0961fb87e3f85da27a7f" title="Calculate the ICMP checksum of the packet in uip_buf.">uip_icmp6chksum</a>(<span class="keywordtype">void</span>);
  2208. <a name="l02176"></a>02176
  2209. <a name="l02177"></a>02177
  2210. <a name="l02178"></a>02178 <span class="preprocessor">#endif </span><span class="comment">/* __UIP_H__ */</span>
  2211. <a name="l02179"></a>02179
  2212. <a name="l02180"></a>02180 <span class="comment"></span>
  2213. <a name="l02181"></a>02181 <span class="comment">/** @} */</span>
  2214. </pre></div></div>
  2215. <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Apr 11 14:23:33 2011 for Contiki 2.5 by&nbsp;
  2216. <a href="http://www.doxygen.org/index.html">
  2217. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
  2218. </body>
  2219. </html>