a00202.html

uip-1.0,give everyone who want.

<a name="l00127"></a>00127 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment">/**</span>
<a name="l00129"></a>00129 <span class="comment"> * Set the default router's IP address.</span>
<a name="l00130"></a>00130 <span class="comment"> *</span>
<a name="l00131"></a>00131 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable containing the IP</span>
<a name="l00132"></a>00132 <span class="comment"> * address of the default router.</span>
<a name="l00133"></a>00133 <span class="comment"> *</span>
<a name="l00134"></a>00134 <span class="comment"> * \sa uip_ipaddr()</span>
<a name="l00135"></a>00135 <span class="comment"> *</span>
<a name="l00136"></a>00136 <span class="comment"> * \hideinitializer</span>
<a name="l00137"></a>00137 <span class="comment"> */</span>
<a name="l00138"></a><a class="code" href="a00144.html#g41d37ea1e3bd24f7b51e9409aceaaa80">00138</a> <span class="preprocessor">#define uip_setdraddr(addr) uip_ipaddr_copy(uip_draddr, (addr))</span>
<a name="l00139"></a>00139 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment">/**</span>
<a name="l00141"></a>00141 <span class="comment"> * Set the netmask.</span>
<a name="l00142"></a>00142 <span class="comment"> *</span>
<a name="l00143"></a>00143 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable containing the IP</span>
<a name="l00144"></a>00144 <span class="comment"> * address of the netmask.</span>
<a name="l00145"></a>00145 <span class="comment"> *</span>
<a name="l00146"></a>00146 <span class="comment"> * \sa uip_ipaddr()</span>
<a name="l00147"></a>00147 <span class="comment"> *</span>
<a name="l00148"></a>00148 <span class="comment"> * \hideinitializer</span>
<a name="l00149"></a>00149 <span class="comment"> */</span>
<a name="l00150"></a><a class="code" href="a00144.html#geb79c914cf137e6d27fd7583e5a66679">00150</a> <span class="preprocessor">#define uip_setnetmask(addr) uip_ipaddr_copy(uip_netmask, (addr))</span>
<a name="l00151"></a>00151 <span class="preprocessor"></span>
<a name="l00152"></a>00152 <span class="comment"></span>
<a name="l00153"></a>00153 <span class="comment">/**</span>
<a name="l00154"></a>00154 <span class="comment"> * Get the default router's IP address.</span>
<a name="l00155"></a>00155 <span class="comment"> *</span>
<a name="l00156"></a>00156 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
<a name="l00157"></a>00157 <span class="comment"> * filled in with the IP address of the default router.</span>
<a name="l00158"></a>00158 <span class="comment"> *</span>
<a name="l00159"></a>00159 <span class="comment"> * \hideinitializer</span>
<a name="l00160"></a>00160 <span class="comment"> */</span>
<a name="l00161"></a><a class="code" href="a00144.html#gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c">00161</a> <span class="preprocessor">#define uip_getdraddr(addr) uip_ipaddr_copy((addr), uip_draddr)</span>
<a name="l00162"></a>00162 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment">/**</span>
<a name="l00164"></a>00164 <span class="comment"> * Get the netmask.</span>
<a name="l00165"></a>00165 <span class="comment"> *</span>
<a name="l00166"></a>00166 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
<a name="l00167"></a>00167 <span class="comment"> * filled in with the value of the netmask.</span>
<a name="l00168"></a>00168 <span class="comment"> *</span>
<a name="l00169"></a>00169 <span class="comment"> * \hideinitializer</span>
<a name="l00170"></a>00170 <span class="comment"> */</span>
<a name="l00171"></a><a class="code" href="a00144.html#g5323320b7316647042016f17c4e881be">00171</a> <span class="preprocessor">#define uip_getnetmask(addr) uip_ipaddr_copy((addr), uip_netmask)</span>
<a name="l00172"></a>00172 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment">/** @} */</span>
<a name="l00174"></a>00174 <span class="comment"></span>
<a name="l00175"></a>00175 <span class="comment">/**</span>
<a name="l00176"></a>00176 <span class="comment"> * \defgroup uipinit uIP initialization functions</span>
<a name="l00177"></a>00177 <span class="comment"> * @{</span>
<a name="l00178"></a>00178 <span class="comment"> *</span>
<a name="l00179"></a>00179 <span class="comment"> * The uIP initialization functions are used for booting uIP.</span>
<a name="l00180"></a>00180 <span class="comment"> */</span>
<a name="l00181"></a>00181 <span class="comment"></span>
<a name="l00182"></a>00182 <span class="comment">/**</span>
<a name="l00183"></a>00183 <span class="comment"> * uIP initialization function.</span>
<a name="l00184"></a>00184 <span class="comment"> *</span>
<a name="l00185"></a>00185 <span class="comment"> * This function should be called at boot up to initilize the uIP</span>
<a name="l00186"></a>00186 <span class="comment"> * TCP/IP stack.</span>
<a name="l00187"></a>00187 <span class="comment"> */</span>
<a name="l00188"></a>00188 <span class="keywordtype">void</span> <a class="code" href="a00145.html#gc48ed5f0d27721ef62a3ed02a5ad8d2e">uip_init</a>(<span class="keywordtype">void</span>);
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="comment">/**</span>
<a name="l00191"></a>00191 <span class="comment"> * uIP initialization function.</span>
<a name="l00192"></a>00192 <span class="comment"> *</span>
<a name="l00193"></a>00193 <span class="comment"> * This function may be used at boot time to set the initial ip_id.</span>
<a name="l00194"></a>00194 <span class="comment"> */</span>
<a name="l00195"></a>00195 <span class="keywordtype">void</span> <a class="code" href="a00145.html#g22f140b02c354dfebcc7ad481c3bcd68">uip_setipid</a>(<a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <span class="keywordtype">id</span>);
<a name="l00196"></a>00196 <span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment">/** @} */</span>
<a name="l00198"></a>00198 <span class="comment"></span>
<a name="l00199"></a>00199 <span class="comment">/**</span>
<a name="l00200"></a>00200 <span class="comment"> * \defgroup uipdevfunc uIP device driver functions</span>
<a name="l00201"></a>00201 <span class="comment"> * @{</span>
<a name="l00202"></a>00202 <span class="comment"> *</span>
<a name="l00203"></a>00203 <span class="comment"> * These functions are used by a network device driver for interacting</span>
<a name="l00204"></a>00204 <span class="comment"> * with uIP.</span>
<a name="l00205"></a>00205 <span class="comment"> */</span>
<a name="l00206"></a>00206 <span class="comment"></span>
<a name="l00207"></a>00207 <span class="comment">/**</span>
<a name="l00208"></a>00208 <span class="comment"> * Process an incoming packet.</span>
<a name="l00209"></a>00209 <span class="comment"> *</span>
<a name="l00210"></a>00210 <span class="comment"> * This function should be called when the device driver has received</span>
<a name="l00211"></a>00211 <span class="comment"> * a packet from the network. The packet from the device driver must</span>
<a name="l00212"></a>00212 <span class="comment"> * be present in the uip_buf buffer, and the length of the packet</span>
<a name="l00213"></a>00213 <span class="comment"> * should be placed in the uip_len variable.</span>
<a name="l00214"></a>00214 <span class="comment"> *</span>
<a name="l00215"></a>00215 <span class="comment"> * When the function returns, there may be an outbound packet placed</span>
<a name="l00216"></a>00216 <span class="comment"> * in the uip_buf packet buffer. If so, the uip_len variable is set to</span>
<a name="l00217"></a>00217 <span class="comment"> * the length of the packet. If no packet is to be sent out, the</span>
<a name="l00218"></a>00218 <span class="comment"> * uip_len variable is set to 0.</span>
<a name="l00219"></a>00219 <span class="comment"> *</span>
<a name="l00220"></a>00220 <span class="comment"> * The usual way of calling the function is presented by the source</span>
<a name="l00221"></a>00221 <span class="comment"> * code below.</span>
<a name="l00222"></a>00222 <span class="comment"> \code</span>
<a name="l00223"></a>00223 <span class="comment">  uip_len = devicedriver_poll();</span>
<a name="l00224"></a>00224 <span class="comment">  if(uip_len &gt; 0) {</span>
<a name="l00225"></a>00225 <span class="comment">    uip_input();</span>
<a name="l00226"></a>00226 <span class="comment">    if(uip_len &gt; 0) {</span>
<a name="l00227"></a>00227 <span class="comment">      devicedriver_send();</span>
<a name="l00228"></a>00228 <span class="comment">    }</span>
<a name="l00229"></a>00229 <span class="comment">  }</span>
<a name="l00230"></a>00230 <span class="comment"> \endcode</span>
<a name="l00231"></a>00231 <span class="comment"> *</span>
<a name="l00232"></a>00232 <span class="comment"> * \note If you are writing a uIP device driver that needs ARP</span>
<a name="l00233"></a>00233 <span class="comment"> * (Address Resolution Protocol), e.g., when running uIP over</span>
<a name="l00234"></a>00234 <span class="comment"> * Ethernet, you will need to call the uIP ARP code before calling</span>
<a name="l00235"></a>00235 <span class="comment"> * this function:</span>
<a name="l00236"></a>00236 <span class="comment"> \code</span>
<a name="l00237"></a>00237 <span class="comment">  #define BUF ((struct uip_eth_hdr *)&amp;uip_buf[0])</span>
<a name="l00238"></a>00238 <span class="comment">  uip_len = ethernet_devicedrver_poll();</span>
<a name="l00239"></a>00239 <span class="comment">  if(uip_len &gt; 0) {</span>
<a name="l00240"></a>00240 <span class="comment">    if(BUF-&gt;type == HTONS(UIP_ETHTYPE_IP)) {</span>
<a name="l00241"></a>00241 <span class="comment">      uip_arp_ipin();</span>
<a name="l00242"></a>00242 <span class="comment">      uip_input();</span>
<a name="l00243"></a>00243 <span class="comment">      if(uip_len &gt; 0) {</span>
<a name="l00244"></a>00244 <span class="comment">        uip_arp_out();</span>
<a name="l00245"></a>00245 <span class="comment">        ethernet_devicedriver_send();</span>
<a name="l00246"></a>00246 <span class="comment">      }</span>
<a name="l00247"></a>00247 <span class="comment">    } else if(BUF-&gt;type == HTONS(UIP_ETHTYPE_ARP)) {</span>
<a name="l00248"></a>00248 <span class="comment">      uip_arp_arpin();</span>
<a name="l00249"></a>00249 <span class="comment">      if(uip_len &gt; 0) {</span>
<a name="l00250"></a>00250 <span class="comment">        ethernet_devicedriver_send();</span>
<a name="l00251"></a>00251 <span class="comment">      }</span>
<a name="l00252"></a>00252 <span class="comment">    }</span>
<a name="l00253"></a>00253 <span class="comment"> \endcode</span>
<a name="l00254"></a>00254 <span class="comment"> *</span>
<a name="l00255"></a>00255 <span class="comment"> * \hideinitializer</span>
<a name="l00256"></a>00256 <span class="comment"> */</span>
<a name="l00257"></a><a class="code" href="a00146.html#ga4360412ee9350fba725f98a137169fe">00257</a> <span class="preprocessor">#define uip_input()        uip_process(UIP_DATA)</span>
<a name="l00258"></a>00258 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00259"></a>00259 <span class="comment">/**</span>
<a name="l00260"></a>00260 <span class="comment"> * Periodic processing for a connection identified by its number.</span>
<a name="l00261"></a>00261 <span class="comment"> *</span>
<a name="l00262"></a>00262 <span class="comment"> * This function does the necessary periodic processing (timers,</span>
<a name="l00263"></a>00263 <span class="comment"> * polling) for a uIP TCP conneciton, and should be called when the</span>
<a name="l00264"></a>00264 <span class="comment"> * periodic uIP timer goes off. It should be called for every</span>
<a name="l00265"></a>00265 <span class="comment"> * connection, regardless of whether they are open of closed.</span>
<a name="l00266"></a>00266 <span class="comment"> *</span>
<a name="l00267"></a>00267 <span class="comment"> * When the function returns, it may have an outbound packet waiting</span>
<a name="l00268"></a>00268 <span class="comment"> * for service in the uIP packet buffer, and if so the uip_len</span>
<a name="l00269"></a>00269 <span class="comment"> * variable is set to a value larger than zero. The device driver</span>
<a name="l00270"></a>00270 <span class="comment"> * should be called to send out the packet.</span>
<a name="l00271"></a>00271 <span class="comment"> *</span>
<a name="l00272"></a>00272 <span class="comment"> * The ususal way of calling the function is through a for() loop like</span>