<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Ubixos: arp.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<h1>arp.h</h1><div class="fragment"><pre>00001 <span class="comment">/*</span>
00002 <span class="comment"> * Copyright (c) 2001, Swedish Institute of Computer Science.</span>
00003 <span class="comment"> * All rights reserved. </span>
00004 <span class="comment"> *</span>
00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
00007 <span class="comment"> * are met: </span>
00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
00009 <span class="comment"> * notice, this list of conditions and the following disclaimer. </span>
00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the </span>
00012 <span class="comment"> * documentation and/or other materials provided with the distribution. </span>
00013 <span class="comment"> * 3. All advertising materials mentioning features or use of this software</span>
00014 <span class="comment"> * must display the following acknowledgement:</span>
00015 <span class="comment"> * This product includes software developed by the Swedish Institute</span>
00016 <span class="comment"> * of Computer Science and its contributors.</span>
00017 <span class="comment"> * 4. Neither the name of the Institute nor the names of its contributors </span>
00018 <span class="comment"> * may be used to endorse or promote products derived from this software </span>
00019 <span class="comment"> * without specific prior written permission. </span>
00020 <span class="comment"> *</span>
00021 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
00022 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
00023 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
00024 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
00025 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
00026 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
00027 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
00028 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
00029 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
00030 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
00031 <span class="comment"> * SUCH DAMAGE. </span>
00032 <span class="comment"> *</span>
00033 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
00034 <span class="comment"> * </span>
00035 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>
00036 <span class="comment"> *</span>
00037 <span class="comment"> * $Id$</span>
00038 <span class="comment"> *</span>
00039 <span class="comment"> */</span>
00040
00041 <span class="preprocessor">#ifndef __NETIF_ARP_H__</span>
00042 <span class="preprocessor"></span><span class="preprocessor">#define __NETIF_ARP_H__</span>
00043 <span class="preprocessor"></span>
00044 <span class="preprocessor">#include "net/pbuf.h"</span>
00045 <span class="preprocessor">#include "net/ipv4/ip_addr.h"</span>
00046 <span class="preprocessor">#include "net/netif.h"</span>
00047
00048 <span class="keyword">struct </span>eth_addr {
00049 PACK_STRUCT_FIELD(uInt8 addr[6]);
00050 } PACK_STRUCT_STRUCT;
00051
00052 <span class="keyword">struct </span>eth_hdr {
00053 PACK_STRUCT_FIELD(<span class="keyword">struct</span> eth_addr dest);
00054 PACK_STRUCT_FIELD(<span class="keyword">struct</span> eth_addr src);
00055 PACK_STRUCT_FIELD(uInt16 type);
00056 } PACK_STRUCT_STRUCT;
00057
00058 <span class="preprocessor">#define ARP_TMR_INTERVAL 10000</span>
00059 <span class="preprocessor"></span>
00060 <span class="preprocessor">#define ETHTYPE_ARP 0x0806</span>
00061 <span class="preprocessor"></span><span class="preprocessor">#define ETHTYPE_IP 0x0800</span>
00062 <span class="preprocessor"></span>
00063 <span class="comment">/* Initializes ARP. */</span>
00064 <span class="keywordtype">void</span> arp_init(<span class="keywordtype">void</span>);
00065
00066 <span class="comment">/* The arp_tmr() function should be called every ARP_TMR_INTERVAL</span>
00067 <span class="comment"> microseconds (10 seconds). This function is responsible for</span>
00068 <span class="comment"> expiring old entries in the ARP table. */</span>
00069 <span class="keywordtype">void</span> arp_tmr(<span class="keywordtype">void</span>);
00070
00071 <span class="comment">/* Should be called for all incoming packets of IP kind. The function</span>
00072 <span class="comment"> does not alter the packet in any way, it just updates the ARP</span>
00073 <span class="comment"> table. After this function has been called, the normal TCP/IP stack</span>
00074 <span class="comment"> input function should be called. */</span>
00075 <span class="keywordtype">void</span> arp_ip_input(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> pbuf *p);
00076
00077 <span class="comment">/* Should be called for incoming ARP packets. The pbuf in the argument</span>
00078 <span class="comment"> is freed by this function. If the function returns a pbuf (i.e.,</span>
00079 <span class="comment"> returns non-NULL), that pbuf constitutes an ARP reply and should be</span>
00080 <span class="comment"> sent out on the Ethernet. */</span>
00081 <span class="keyword">struct </span>pbuf *arp_arp_input(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> eth_addr *ethaddr,
00082 <span class="keyword">struct</span> pbuf *p);
00083
00084 <span class="comment">/* arp_loopup() is called to do an IP address -> Ethernet address</span>
00085 <span class="comment"> translation. If the function returns NULL, there is no mapping and</span>
00086 <span class="comment"> the arp_query() function should be called. */</span>
00087 <span class="keyword">struct </span>eth_addr *arp_lookup(<span class="keyword">struct</span> ip_addr *ipaddr);
00088
00089 <span class="comment">/* Constructs an ARP query packet for the given IP address. The</span>
00090 <span class="comment"> function returns a pbuf that contains the reply and that should be</span>
00091 <span class="comment"> sent out on the Ethernet. */</span>
00092 <span class="keyword">struct </span>pbuf *arp_query(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> eth_addr *ethaddr,
00093 <span class="keyword">struct</span> ip_addr *ipaddr);
00094
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 Wed Apr 28 17:49:30 2004 for Ubixos by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.3 </small></address>
</body>
</html>
