1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>uIP 1.0: uip/uip_arp.h Source File</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<!-- Generated by Doxygen 1.4.6 --> 8<div class="tabs"> 9 <ul> 10 <li><a href="main.html"><span>Main Page</span></a></li> 11 <li><a href="modules.html"><span>Modules</span></a></li> 12 <li><a href="classes.html"><span>Data Structures</span></a></li> 13 <li id="current"><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<div class="tabs"> 17 <ul> 18 <li><a href="files.html"><span>File List</span></a></li> 19 <li><a href="globals.html"><span>Globals</span></a></li> 20 </ul></div> 21<h1>uip/uip_arp.h</h1><a href="a00139.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span> 22<a name="l00002"></a>00002 <span class="comment"> * \addtogroup uip</span> 23<a name="l00003"></a>00003 <span class="comment"> * @{</span> 24<a name="l00004"></a>00004 <span class="comment"> */</span> 25<a name="l00005"></a>00005 <span class="comment"></span> 26<a name="l00006"></a>00006 <span class="comment">/**</span> 27<a name="l00007"></a>00007 <span class="comment"> * \addtogroup uiparp</span> 28<a name="l00008"></a>00008 <span class="comment"> * @{</span> 29<a name="l00009"></a>00009 <span class="comment"> */</span> 30<a name="l00010"></a>00010 <span class="comment"></span> 31<a name="l00011"></a>00011 <span class="comment">/**</span> 32<a name="l00012"></a>00012 <span class="comment"> * \file</span> 33<a name="l00013"></a>00013 <span class="comment"> * Macros and definitions for the ARP module.</span> 34<a name="l00014"></a>00014 <span class="comment"> * \author Adam Dunkels <[email protected]></span> 35<a name="l00015"></a>00015 <span class="comment"> */</span> 36<a name="l00016"></a>00016 37<a name="l00017"></a>00017 38<a name="l00018"></a>00018 <span class="comment">/*</span> 39<a name="l00019"></a>00019 <span class="comment"> * Copyright (c) 2001-2003, Adam Dunkels.</span> 40<a name="l00020"></a>00020 <span class="comment"> * All rights reserved.</span> 41<a name="l00021"></a>00021 <span class="comment"> *</span> 42<a name="l00022"></a>00022 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span> 43<a name="l00023"></a>00023 <span class="comment"> * modification, are permitted provided that the following conditions</span> 44<a name="l00024"></a>00024 <span class="comment"> * are met:</span> 45<a name="l00025"></a>00025 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span> 46<a name="l00026"></a>00026 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span> 47<a name="l00027"></a>00027 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span> 48<a name="l00028"></a>00028 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span> 49<a name="l00029"></a>00029 <span class="comment"> * documentation and/or other materials provided with the distribution.</span> 50<a name="l00030"></a>00030 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span> 51<a name="l00031"></a>00031 <span class="comment"> * products derived from this software without specific prior</span> 52<a name="l00032"></a>00032 <span class="comment"> * written permission.</span> 53<a name="l00033"></a>00033 <span class="comment"> *</span> 54<a name="l00034"></a>00034 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS</span> 55<a name="l00035"></a>00035 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span> 56<a name="l00036"></a>00036 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span> 57<a name="l00037"></a>00037 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span> 58<a name="l00038"></a>00038 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span> 59<a name="l00039"></a>00039 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span> 60<a name="l00040"></a>00040 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span> 61<a name="l00041"></a>00041 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span> 62<a name="l00042"></a>00042 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span> 63<a name="l00043"></a>00043 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span> 64<a name="l00044"></a>00044 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span> 65<a name="l00045"></a>00045 <span class="comment"> *</span> 66<a name="l00046"></a>00046 <span class="comment"> * This file is part of the uIP TCP/IP stack.</span> 67<a name="l00047"></a>00047 <span class="comment"> *</span> 68<a name="l00048"></a>00048 <span class="comment"> * $Id: uip_arp.h,v 1.5 2006/06/11 21:46:39 adam Exp $</span> 69<a name="l00049"></a>00049 <span class="comment"> *</span> 70<a name="l00050"></a>00050 <span class="comment"> */</span> 71<a name="l00051"></a>00051 72<a name="l00052"></a>00052 <span class="preprocessor">#ifndef __UIP_ARP_H__</span> 73<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#define __UIP_ARP_H__</span> 74<a name="l00054"></a>00054 <span class="preprocessor"></span> 75<a name="l00055"></a>00055 <span class="preprocessor">#include "<a class="code" href="a00136.html">uip.h</a>"</span> 76<a name="l00056"></a>00056 77<a name="l00057"></a>00057 78<a name="l00058"></a>00058 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00089.html">uip_eth_addr</a> <a class="code" href="a00150.html#g499bb98a0b4ae9a98553ede81317606d">uip_ethaddr</a>; 79<a name="l00059"></a>00059 <span class="comment"></span> 80<a name="l00060"></a>00060 <span class="comment">/**</span> 81<a name="l00061"></a>00061 <span class="comment"> * The Ethernet header.</span> 82<a name="l00062"></a>00062 <span class="comment"> */</span> 83<a name="l00063"></a><a class="code" href="a00090.html">00063</a> <span class="keyword">struct </span><a class="code" href="a00090.html">uip_eth_hdr</a> { 84<a name="l00064"></a><a class="code" href="a00090.html#b684c17bf48c8e3b3fcf97b06b4c6ee1">00064</a> <span class="keyword">struct </span><a class="code" href="a00089.html">uip_eth_addr</a> <a class="code" href="a00090.html#b684c17bf48c8e3b3fcf97b06b4c6ee1">dest</a>; 85<a name="l00065"></a><a class="code" href="a00090.html#1abbbe7bc5d7d033c727691528b85b8d">00065</a> <span class="keyword">struct </span><a class="code" href="a00089.html">uip_eth_addr</a> <a class="code" href="a00090.html#1abbbe7bc5d7d033c727691528b85b8d">src</a>; 86<a name="l00066"></a><a class="code" href="a00090.html#c9273cc1fcdaeeddc523ca9f34977e06">00066</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00090.html#c9273cc1fcdaeeddc523ca9f34977e06">type</a>; 87<a name="l00067"></a>00067 }; 88<a name="l00068"></a>00068 89<a name="l00069"></a><a class="code" href="a00152.html#g3e1562e8a6de32268e5df92a52152f91">00069</a> <span class="preprocessor">#define UIP_ETHTYPE_ARP 0x0806</span> 90<a name="l00070"></a><a class="code" href="a00152.html#g03d140db75de3d3cdfbbab1c4fed8d8d">00070</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_ETHTYPE_IP 0x0800</span> 91<a name="l00071"></a><a class="code" href="a00152.html#gbb558f3a9b1ec015e83c314aba694e35">00071</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_ETHTYPE_IP6 0x86dd</span> 92<a name="l00072"></a>00072 <span class="preprocessor"></span> 93<a name="l00073"></a>00073 94<a name="l00074"></a>00074 <span class="comment">/* The uip_arp_init() function must be called before any of the other</span> 95<a name="l00075"></a>00075 <span class="comment"> ARP functions. */</span> 96<a name="l00076"></a>00076 <span class="keywordtype">void</span> <a class="code" href="a00152.html#g2d9d28afa353f662b9bb5234fc419f72">uip_arp_init</a>(<span class="keywordtype">void</span>); 97<a name="l00077"></a>00077 98<a name="l00078"></a>00078 <span class="comment">/* The uip_arp_ipin() function should be called whenever an IP packet</span> 99<a name="l00079"></a>00079 <span class="comment"> arrives from the Ethernet. This function refreshes the ARP table or</span> 100<a name="l00080"></a>00080 <span class="comment"> inserts a new mapping if none exists. The function assumes that an</span> 101<a name="l00081"></a>00081 <span class="comment"> IP packet with an Ethernet header is present in the uip_buf buffer</span> 102<a name="l00082"></a>00082 <span class="comment"> and that the length of the packet is in the uip_len variable. */</span> 103<a name="l00083"></a>00083 <span class="comment">/*void uip_arp_ipin(void);*/</span> 104<a name="l00084"></a><a class="code" href="a00152.html#g737337d6a51e31b236c8233d024138a8">00084</a> <span class="preprocessor">#define uip_arp_ipin()</span> 105<a name="l00085"></a>00085 <span class="preprocessor"></span> 106<a name="l00086"></a>00086 <span class="comment">/* The uip_arp_arpin() should be called when an ARP packet is received</span> 107<a name="l00087"></a>00087 <span class="comment"> by the Ethernet driver. This function also assumes that the</span> 108<a name="l00088"></a>00088 <span class="comment"> Ethernet frame is present in the uip_buf buffer. When the</span> 109<a name="l00089"></a>00089 <span class="comment"> uip_arp_arpin() function returns, the contents of the uip_buf</span> 110<a name="l00090"></a>00090 <span class="comment"> buffer should be sent out on the Ethernet if the uip_len variable</span> 111<a name="l00091"></a>00091 <span class="comment"> is > 0. */</span> 112<a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="a00152.html#g902c4a360134096224bc2655f623aa5f">uip_arp_arpin</a>(<span class="keywordtype">void</span>); 113<a name="l00093"></a>00093 114<a name="l00094"></a>00094 <span class="comment">/* The uip_arp_out() function should be called when an IP packet</span> 115<a name="l00095"></a>00095 <span class="comment"> should be sent out on the Ethernet. This function creates an</span> 116<a name="l00096"></a>00096 <span class="comment"> Ethernet header before the IP header in the uip_buf buffer. The</span> 117<a name="l00097"></a>00097 <span class="comment"> Ethernet header will have the correct Ethernet MAC destination</span> 118<a name="l00098"></a>00098 <span class="comment"> address filled in if an ARP table entry for the destination IP</span> 119<a name="l00099"></a>00099 <span class="comment"> address (or the IP address of the default router) is present. If no</span> 120<a name="l00100"></a>00100 <span class="comment"> such table entry is found, the IP packet is overwritten with an ARP</span> 121<a name="l00101"></a>00101 <span class="comment"> request and we rely on TCP to retransmit the packet that was</span> 122<a name="l00102"></a>00102 <span class="comment"> overwritten. In any case, the uip_len variable holds the length of</span> 123<a name="l00103"></a>00103 <span class="comment"> the Ethernet frame that should be transmitted. */</span> 124<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="a00152.html#g54b27e45df15e10a0eb1a3e3a91417d2">uip_arp_out</a>(<span class="keywordtype">void</span>); 125<a name="l00105"></a>00105 126<a name="l00106"></a>00106 <span class="comment">/* The uip_arp_timer() function should be called every ten seconds. It</span> 127<a name="l00107"></a>00107 <span class="comment"> is responsible for flushing old entries in the ARP table. */</span> 128<a name="l00108"></a>00108 <span class="keywordtype">void</span> <a class="code" href="a00152.html#g058a8e6025f67b021862281f1911fcef">uip_arp_timer</a>(<span class="keywordtype">void</span>); 129<a name="l00109"></a>00109 <span class="comment"></span> 130<a name="l00110"></a>00110 <span class="comment">/** @} */</span> 131<a name="l00111"></a>00111 <span class="comment"></span> 132<a name="l00112"></a>00112 <span class="comment">/**</span> 133<a name="l00113"></a>00113 <span class="comment"> * \addtogroup uipconffunc</span> 134<a name="l00114"></a>00114 <span class="comment"> * @{</span> 135<a name="l00115"></a>00115 <span class="comment"> */</span> 136<a name="l00116"></a>00116 137<a name="l00117"></a>00117 <span class="comment"></span> 138<a name="l00118"></a>00118 <span class="comment">/**</span> 139<a name="l00119"></a>00119 <span class="comment"> * Specifiy the Ethernet MAC address.</span> 140<a name="l00120"></a>00120 <span class="comment"> *</span> 141<a name="l00121"></a>00121 <span class="comment"> * The ARP code needs to know the MAC address of the Ethernet card in</span> 142<a name="l00122"></a>00122 <span class="comment"> * order to be able to respond to ARP queries and to generate working</span> 143<a name="l00123"></a>00123 <span class="comment"> * Ethernet headers.</span> 144<a name="l00124"></a>00124 <span class="comment"> *</span> 145<a name="l00125"></a>00125 <span class="comment"> * \note This macro only specifies the Ethernet MAC address to the ARP</span> 146<a name="l00126"></a>00126 <span class="comment"> * code. It cannot be used to change the MAC address of the Ethernet</span> 147<a name="l00127"></a>00127 <span class="comment"> * card.</span> 148<a name="l00128"></a>00128 <span class="comment"> *</span> 149<a name="l00129"></a>00129 <span class="comment"> * \param eaddr A pointer to a struct uip_eth_addr containing the</span> 150<a name="l00130"></a>00130 <span class="comment"> * Ethernet MAC address of the Ethernet card.</span> 151<a name="l00131"></a>00131 <span class="comment"> *</span> 152<a name="l00132"></a>00132 <span class="comment"> * \hideinitializer</span> 153<a name="l00133"></a>00133 <span class="comment"> */</span> 154<a name="l00134"></a><a class="code" href="a00144.html#g30e827f33eacff55ecb4d8fb5a11d5d1">00134</a> <span class="preprocessor">#define uip_setethaddr(eaddr) do {uip_ethaddr.addr[0] = eaddr.addr[0]; \</span> 155<a name="l00135"></a>00135 <span class="preprocessor"> uip_ethaddr.addr[1] = eaddr.addr[1];\</span> 156<a name="l00136"></a>00136 <span class="preprocessor"> uip_ethaddr.addr[2] = eaddr.addr[2];\</span> 157<a name="l00137"></a>00137 <span class="preprocessor"> uip_ethaddr.addr[3] = eaddr.addr[3];\</span> 158<a name="l00138"></a>00138 <span class="preprocessor"> uip_ethaddr.addr[4] = eaddr.addr[4];\</span> 159<a name="l00139"></a>00139 <span class="preprocessor"> uip_ethaddr.addr[5] = eaddr.addr[5];} while(0)</span> 160<a name="l00140"></a>00140 <span class="preprocessor"></span><span class="comment"></span> 161<a name="l00141"></a>00141 <span class="comment">/** @} */</span><span class="comment"></span> 162<a name="l00142"></a>00142 <span class="comment">/** @} */</span> 163<a name="l00143"></a>00143 164<a name="l00144"></a>00144 <span class="preprocessor">#endif </span><span class="comment">/* __UIP_ARP_H__ */</span> 165</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by 166<a href="http://www.doxygen.org/index.html"> 167<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 168</body> 169</html> 170
