<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>UbixOS V2: src/sys/include/netif/arp.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_897b6a2d7bab147dd1db58381aad3984.html">src</a> » <a class="el" href="dir_832905b1f7f5feaf61a306b40c0ac817.html">sys</a> » <a class="el" href="dir_caf4200c438ae9601464168e21e8e4d8.html">include</a> » <a class="el" href="dir_c0f81d69cde38683f3447d3343de50f4.html">netif</a></div>
<h1>arp.h</h1><a href="arp_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2001, Swedish Institute of Computer Science.</span>
<a name="l00003"></a>00003 <span class="comment"> * All rights reserved. </span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
<a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
<a name="l00007"></a>00007 <span class="comment"> * are met: </span>
<a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
<a name="l00009"></a>00009 <span class="comment"> * notice, this list of conditions and the following disclaimer. </span>
<a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
<a name="l00011"></a>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the </span>
<a name="l00012"></a>00012 <span class="comment"> * documentation and/or other materials provided with the distribution. </span>
<a name="l00013"></a>00013 <span class="comment"> * 3. All advertising materials mentioning features or use of this software</span>
<a name="l00014"></a>00014 <span class="comment"> * must display the following acknowledgement:</span>
<a name="l00015"></a>00015 <span class="comment"> * This product includes software developed by the Swedish Institute</span>
<a name="l00016"></a>00016 <span class="comment"> * of Computer Science and its contributors.</span>
<a name="l00017"></a>00017 <span class="comment"> * 4. Neither the name of the Institute nor the names of its contributors </span>
<a name="l00018"></a>00018 <span class="comment"> * may be used to endorse or promote products derived from this software </span>
<a name="l00019"></a>00019 <span class="comment"> * without specific prior written permission. </span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
<a name="l00022"></a>00022 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
<a name="l00023"></a>00023 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
<a name="l00024"></a>00024 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
<a name="l00025"></a>00025 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
<a name="l00026"></a>00026 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
<a name="l00027"></a>00027 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
<a name="l00028"></a>00028 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
<a name="l00029"></a>00029 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
<a name="l00030"></a>00030 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
<a name="l00031"></a>00031 <span class="comment"> * SUCH DAMAGE. </span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
<a name="l00034"></a>00034 <span class="comment"> * </span>
<a name="l00035"></a>00035 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>
<a name="l00036"></a>00036 <span class="comment"> *</span>
<a name="l00037"></a>00037 <span class="comment"> * $Id: arp_8h-source.html 88 2016-01-12 00:11:29Z reddawg $</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> */</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#ifndef __NETIF_ARP_H__</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define __NETIF_ARP_H__</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
<a name="l00044"></a>00044 <span class="preprocessor">#include "net/pbuf.h"</span>
<a name="l00045"></a>00045 <span class="preprocessor">#include "net/ipv4/ip_addr.h"</span>
<a name="l00046"></a>00046 <span class="preprocessor">#include "net/netif.h"</span>
<a name="l00047"></a>00047
<a name="l00048"></a><a class="code" href="structeth__addr.html">00048</a> <span class="keyword">struct </span><a class="code" href="structeth__addr.html">eth_addr</a> {
<a name="l00049"></a>00049 <a class="code" href="structeth__addr.html#659e6d94ddb0acdae1a3df46b0de80ed">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> addr[6]);
<a name="l00050"></a>00050 } <a class="code" href="arp_8h.html#60f1dc6554771c253cfaf098c6c03db0">PACK_STRUCT_STRUCT</a>;
<a name="l00051"></a>00051
<a name="l00052"></a><a class="code" href="structeth__hdr.html">00052</a> <span class="keyword">struct </span><a class="code" href="structeth__hdr.html">eth_hdr</a> {
<a name="l00053"></a>00053 <a class="code" href="structeth__hdr.html#72f0a95244a7d946dba634721c0d20d4">PACK_STRUCT_FIELD</a>(<span class="keyword">struct</span> <a class="code" href="structeth__addr.html">eth_addr</a> dest);
<a name="l00054"></a>00054 <a class="code" href="structeth__hdr.html#72f0a95244a7d946dba634721c0d20d4">PACK_STRUCT_FIELD</a>(<span class="keyword">struct</span> <a class="code" href="structeth__addr.html">eth_addr</a> src);
<a name="l00055"></a>00055 <a class="code" href="structeth__hdr.html#72f0a95244a7d946dba634721c0d20d4">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> type);
<a name="l00056"></a>00056 } <a class="code" href="arp_8h.html#60f1dc6554771c253cfaf098c6c03db0">PACK_STRUCT_STRUCT</a>;
<a name="l00057"></a>00057
<a name="l00058"></a><a class="code" href="arp_8h.html#aa3d8ed1eb1129f518345e37b38cfc37">00058</a> <span class="preprocessor">#define ARP_TMR_INTERVAL 10000</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span>
<a name="l00060"></a><a class="code" href="arp_8h.html#dbc208bed02b2900ca2639a25d3f6198">00060</a> <span class="preprocessor">#define ETHTYPE_ARP 0x0806</span>
<a name="l00061"></a><a class="code" href="arp_8h.html#392234c1299a5f5c264e511d88a66e56">00061</a> <span class="preprocessor"></span><span class="preprocessor">#define ETHTYPE_IP 0x0800</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span>
<a name="l00063"></a>00063 <span class="comment">/* Initializes ARP. */</span>
<a name="l00064"></a>00064 <span class="keywordtype">void</span> <a class="code" href="arp_8h.html#c8ad5a32790d172fcec2eac97a87ee9f">arp_init</a>(<span class="keywordtype">void</span>);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">/* The arp_tmr() function should be called every ARP_TMR_INTERVAL</span>
<a name="l00067"></a>00067 <span class="comment"> microseconds (10 seconds). This function is responsible for</span>
<a name="l00068"></a>00068 <span class="comment"> expiring old entries in the ARP table. */</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="arp_8h.html#2cc298ed4c68289160da1376faf20938">arp_tmr</a>(<span class="keywordtype">void</span>);
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">/* Should be called for all incoming packets of IP kind. The function</span>
<a name="l00072"></a>00072 <span class="comment"> does not alter the packet in any way, it just updates the ARP</span>
<a name="l00073"></a>00073 <span class="comment"> table. After this function has been called, the normal TCP/IP stack</span>
<a name="l00074"></a>00074 <span class="comment"> input function should be called. */</span>
<a name="l00075"></a>00075 <span class="keywordtype">void</span> <a class="code" href="arp_8h.html#916d08dbb8f4a38e1e904a8a018b000c">arp_ip_input</a>(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> pbuf *p);
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">/* Should be called for incoming ARP packets. The pbuf in the argument</span>
<a name="l00078"></a>00078 <span class="comment"> is freed by this function. If the function returns a pbuf (i.e.,</span>
<a name="l00079"></a>00079 <span class="comment"> returns non-NULL), that pbuf constitutes an ARP reply and should be</span>
<a name="l00080"></a>00080 <span class="comment"> sent out on the Ethernet. */</span>
<a name="l00081"></a>00081 <span class="keyword">struct </span>pbuf *<a class="code" href="arp_8h.html#57a25dd51cf73f048ad5364ecc2f040b">arp_arp_input</a>(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> <a class="code" href="structeth__addr.html">eth_addr</a> *ethaddr,
<a name="l00082"></a>00082 <span class="keyword">struct</span> pbuf *p);
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">/* arp_loopup() is called to do an IP address -> Ethernet address</span>
<a name="l00085"></a>00085 <span class="comment"> translation. If the function returns NULL, there is no mapping and</span>
<a name="l00086"></a>00086 <span class="comment"> the arp_query() function should be called. */</span>
<a name="l00087"></a>00087 <span class="keyword">struct </span><a class="code" href="structeth__addr.html">eth_addr</a> *<a class="code" href="arp_8h.html#eec8fff4f036cca2ac1b5635fa46d21b">arp_lookup</a>(<span class="keyword">struct</span> ip_addr *ipaddr);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="comment">/* Constructs an ARP query packet for the given IP address. The</span>
<a name="l00090"></a>00090 <span class="comment"> function returns a pbuf that contains the reply and that should be</span>
<a name="l00091"></a>00091 <span class="comment"> sent out on the Ethernet. */</span>
<a name="l00092"></a>00092 <span class="keyword">struct </span>pbuf *<a class="code" href="arp_8h.html#9d1287b9a80c370797b2ac5c63f70e2e">arp_query</a>(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> <a class="code" href="structeth__addr.html">eth_addr</a> *ethaddr,
<a name="l00093"></a>00093 <span class="keyword">struct</span> ip_addr *ipaddr);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif </span><span class="comment">/* __NETIF_ARP_H__ */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 15 11:18:54 2006 for UbixOS V2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
