PageRenderTime 62ms CodeModel.GetById 29ms RepoModel.GetById 0ms 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

Large files files are truncated, but you can click here to view the full 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"> *</sp…

Large files files are truncated, but you can click here to view the full file