<!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 File Reference</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 File Reference</h1><code>#include "<a class="el" href="pbuf_8h-source.html">net/pbuf.h</a>"</code><br>
<code>#include "<a class="el" href="ipv4_2ip__addr_8h-source.html">net/ipv4/ip_addr.h</a>"</code><br>
<code>#include "<a class="el" href="netif_8h-source.html">net/netif.h</a>"</code><br>
<p>
<a href="arp_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structeth__addr.html">eth_addr</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structeth__hdr.html">eth_hdr</a></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#aa3d8ed1eb1129f518345e37b38cfc37">ARP_TMR_INTERVAL</a> 10000</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#dbc208bed02b2900ca2639a25d3f6198">ETHTYPE_ARP</a> 0x0806</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#392234c1299a5f5c264e511d88a66e56">ETHTYPE_IP</a> 0x0800</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structpbuf.html">pbuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#57a25dd51cf73f048ad5364ecc2f040b">arp_arp_input</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structeth__addr.html">eth_addr</a> *ethaddr, struct <a class="el" href="structpbuf.html">pbuf</a> *p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#c8ad5a32790d172fcec2eac97a87ee9f">arp_init</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#916d08dbb8f4a38e1e904a8a018b000c">arp_ip_input</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structpbuf.html">pbuf</a> *p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structeth__addr.html">eth_addr</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#eec8fff4f036cca2ac1b5635fa46d21b">arp_lookup</a> (struct <a class="el" href="structip__addr.html">ip_addr</a> *ipaddr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structpbuf.html">pbuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#9d1287b9a80c370797b2ac5c63f70e2e">arp_query</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structeth__addr.html">eth_addr</a> *ethaddr, struct <a class="el" href="structip__addr.html">ip_addr</a> *ipaddr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#2cc298ed4c68289160da1376faf20938">arp_tmr</a> (void)</td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structeth__hdr.html">eth_hdr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#a7f002f47b5fc16e9c8e866c7b1c525a">PACK_STRUCT_STRUCT</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structeth__addr.html">eth_addr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="arp_8h.html#60f1dc6554771c253cfaf098c6c03db0">PACK_STRUCT_STRUCT</a></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="aa3d8ed1eb1129f518345e37b38cfc37"></a><!-- doxytag: member="arp.h::ARP_TMR_INTERVAL" ref="aa3d8ed1eb1129f518345e37b38cfc37" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARP_TMR_INTERVAL 10000 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8h-source.html#l00058">58</a> of file <a class="el" href="arp_8h-source.html">arp.h</a>.
<p>
Referenced by <a class="el" href="ethernetif_8c-source.html#l00309">arp_timer()</a>, and <a class="el" href="ethernetif_8c-source.html#l00325">ethernetif_init()</a>.
</div>
</div><p>
<a class="anchor" name="dbc208bed02b2900ca2639a25d3f6198"></a><!-- doxytag: member="arp.h::ETHTYPE_ARP" ref="dbc208bed02b2900ca2639a25d3f6198" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ETHTYPE_ARP 0x0806 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8h-source.html#l00060">60</a> of file <a class="el" href="arp_8h-source.html">arp.h</a>.
<p>
Referenced by <a class="el" href="arp_8c-source.html#l00197">arp_arp_input()</a>, <a class="el" href="arp_8c-source.html#l00266">arp_query()</a>, and <a class="el" href="ethernetif_8c-source.html#l00275">ethernetif_input()</a>.
</div>
</div><p>
<a class="anchor" name="392234c1299a5f5c264e511d88a66e56"></a><!-- doxytag: member="arp.h::ETHTYPE_IP" ref="392234c1299a5f5c264e511d88a66e56" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ETHTYPE_IP 0x0800 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8h-source.html#l00061">61</a> of file <a class="el" href="arp_8h-source.html">arp.h</a>.
<p>
Referenced by <a class="el" href="arp_8c-source.html#l00197">arp_arp_input()</a>, <a class="el" href="arp_8c-source.html#l00266">arp_query()</a>, <a class="el" href="ethernetif_8c-source.html#l00275">ethernetif_input()</a>, and <a class="el" href="ethernetif_8c-source.html#l00186">ethernetif_output()</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="57a25dd51cf73f048ad5364ecc2f040b"></a><!-- doxytag: member="arp.h::arp_arp_input" ref="57a25dd51cf73f048ad5364ecc2f040b" args="(struct netif *netif, struct eth_addr *ethaddr, struct pbuf *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structpbuf.html">pbuf</a>* arp_arp_input </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> * </td>
<td class="paramname"> <em>netif</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structeth__addr.html">eth_addr</a> * </td>
<td class="paramname"> <em>ethaddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td>
<td class="paramname"> <em>p</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8c-source.html#l00197">197</a> of file <a class="el" href="arp_8c-source.html">arp.c</a>.
<p>
References <a class="el" href="arp_8c-source.html#l00120">add_arp_entry()</a>, <a class="el" href="arp_8c-source.html#l00051">ARP_REPLY</a>, <a class="el" href="arp_8c-source.html#l00050">ARP_REQUEST</a>, <a class="el" href="arp_8c-source.html#l00072">ARPH_HWLEN_SET</a>, <a class="el" href="arp_8c-source.html#l00073">ARPH_PROTOLEN_SET</a>, <a class="el" href="arp_8h-source.html#l00060">ETHTYPE_ARP</a>, <a class="el" href="arp_8h-source.html#l00061">ETHTYPE_IP</a>, <a class="el" href="ipv4_2inet_8h-source.html#l00066">htons</a>, <a class="el" href="arp_8c-source.html#l00048">HWTYPE_ETHERNET</a>, <a class="el" href="netif_8h-source.html#l00051">netif::ip_addr</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00062">ip_addr_cmp</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00055">ip_addr_set</a>, <a class="el" href="kprintf_8c-source.html#l00038">kprintf()</a>, <a class="el" href="def_8h-source.html#l00041">NULL</a>, <a class="el" href="pbuf_8h-source.html#l00071">pbuf::payload</a>, <a class="el" href="pbuf_8h.html#334112aa2ac402c254d604c0dbbbb746">pbuf_free()</a>, and <a class="el" href="pbuf_8h-source.html#l00074">pbuf::tot_len</a>.
<p>
Referenced by <a class="el" href="ethernetif_8c-source.html#l00275">ethernetif_input()</a>.
</div>
</div><p>
<a class="anchor" name="c8ad5a32790d172fcec2eac97a87ee9f"></a><!-- doxytag: member="arp.h::arp_init" ref="c8ad5a32790d172fcec2eac97a87ee9f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arp_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8c-source.html#l00093">93</a> of file <a class="el" href="arp_8c-source.html">arp.c</a>.
<p>
References <a class="el" href="arp_8c-source.html#l00088">arp_table</a>, <a class="el" href="lwipopts_8h-source.html#l00128">ARP_TABLE_SIZE</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00040">IP_ADDR_ANY</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00055">ip_addr_set</a>, and <a class="el" href="arp_8c-source.html#l00083">arp_entry::ipaddr</a>.
<p>
Referenced by <a class="el" href="ethernetif_8c-source.html#l00325">ethernetif_init()</a>.
</div>
</div><p>
<a class="anchor" name="916d08dbb8f4a38e1e904a8a018b000c"></a><!-- doxytag: member="arp.h::arp_ip_input" ref="916d08dbb8f4a38e1e904a8a018b000c" args="(struct netif *netif, struct pbuf *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arp_ip_input </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> * </td>
<td class="paramname"> <em>netif</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td>
<td class="paramname"> <em>p</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8c-source.html#l00181">181</a> of file <a class="el" href="arp_8c-source.html">arp.c</a>.
<p>
References <a class="el" href="arp_8c-source.html#l00120">add_arp_entry()</a>, <a class="el" href="debug_8h-source.html#l00097">ARP_DEBUG</a>, <a class="el" href="debug_8h-source.html#l00092">DEBUGF</a>, <a class="el" href="netif_8h-source.html#l00051">netif::ip_addr</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00058">ip_addr_maskcmp</a>, <a class="el" href="netif_8h-source.html#l00052">netif::netmask</a>, and <a class="el" href="pbuf_8h-source.html#l00071">pbuf::payload</a>.
<p>
Referenced by <a class="el" href="ethernetif_8c-source.html#l00275">ethernetif_input()</a>.
</div>
</div><p>
<a class="anchor" name="eec8fff4f036cca2ac1b5635fa46d21b"></a><!-- doxytag: member="arp.h::arp_lookup" ref="eec8fff4f036cca2ac1b5635fa46d21b" args="(struct ip_addr *ipaddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structeth__addr.html">eth_addr</a>* arp_lookup </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structip__addr.html">ip_addr</a> * </td>
<td class="paramname"> <em>ipaddr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8c-source.html#l00253">253</a> of file <a class="el" href="arp_8c-source.html">arp.c</a>.
<p>
References <a class="el" href="arp_8c-source.html#l00088">arp_table</a>, <a class="el" href="lwipopts_8h-source.html#l00128">ARP_TABLE_SIZE</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00062">ip_addr_cmp</a>, and <a class="el" href="def_8h-source.html#l00041">NULL</a>.
<p>
Referenced by <a class="el" href="ethernetif_8c-source.html#l00186">ethernetif_output()</a>.
</div>
</div><p>
<a class="anchor" name="9d1287b9a80c370797b2ac5c63f70e2e"></a><!-- doxytag: member="arp.h::arp_query" ref="9d1287b9a80c370797b2ac5c63f70e2e" args="(struct netif *netif, struct eth_addr *ethaddr, struct ip_addr *ipaddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structpbuf.html">pbuf</a>* arp_query </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> * </td>
<td class="paramname"> <em>netif</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structeth__addr.html">eth_addr</a> * </td>
<td class="paramname"> <em>ethaddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structip__addr.html">ip_addr</a> * </td>
<td class="paramname"> <em>ipaddr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8c-source.html#l00266">266</a> of file <a class="el" href="arp_8c-source.html">arp.c</a>.
<p>
References <a class="el" href="arp_8c-source.html#l00050">ARP_REQUEST</a>, <a class="el" href="arp_8c-source.html#l00072">ARPH_HWLEN_SET</a>, <a class="el" href="arp_8c-source.html#l00073">ARPH_PROTOLEN_SET</a>, <a class="el" href="arp_8h-source.html#l00060">ETHTYPE_ARP</a>, <a class="el" href="arp_8h-source.html#l00061">ETHTYPE_IP</a>, <a class="el" href="ipv4_2inet_8h-source.html#l00066">htons</a>, <a class="el" href="arp_8c-source.html#l00048">HWTYPE_ETHERNET</a>, <a class="el" href="netif_8h-source.html#l00051">netif::ip_addr</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00055">ip_addr_set</a>, <a class="el" href="def_8h-source.html#l00041">NULL</a>, <a class="el" href="pbuf_8h-source.html#l00071">pbuf::payload</a>, <a class="el" href="pbuf_8h.html#bb6c8efa7f7739e71cb286c6dd4a47ef">pbuf_alloc()</a>, <a class="el" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebfb4de441e737330558b609a990cd17346">PBUF_LINK</a>, and <a class="el" href="pbuf_8h.html#b3c589840cc5a202e7278f41463f97e7c5e9f28455bca98944a030d4b84ecfab">PBUF_RAM</a>.
<p>
Referenced by <a class="el" href="ethernetif_8c-source.html#l00186">ethernetif_output()</a>.
</div>
</div><p>
<a class="anchor" name="2cc298ed4c68289160da1376faf20938"></a><!-- doxytag: member="arp.h::arp_tmr" ref="2cc298ed4c68289160da1376faf20938" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arp_tmr </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="arp_8c-source.html#l00104">104</a> of file <a class="el" href="arp_8c-source.html">arp.c</a>.
<p>
References <a class="el" href="debug_8h-source.html#l00097">ARP_DEBUG</a>, <a class="el" href="arp_8c-source.html#l00046">ARP_MAXAGE</a>, <a class="el" href="arp_8c-source.html#l00088">arp_table</a>, <a class="el" href="lwipopts_8h-source.html#l00128">ARP_TABLE_SIZE</a>, <a class="el" href="arp_8c-source.html#l00089">ctime</a>, <a class="el" href="debug_8h-source.html#l00092">DEBUGF</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00040">IP_ADDR_ANY</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00064">ip_addr_isany</a>, <a class="el" href="ipv4_2ip__addr_8h-source.html#l00055">ip_addr_set</a>, and <a class="el" href="arp_8c-source.html#l00083">arp_entry::ipaddr</a>.
<p>
Referenced by <a class="el" href="ethernetif_8c-source.html#l00309">arp_timer()</a>.
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="a7f002f47b5fc16e9c8e866c7b1c525a"></a><!-- doxytag: member="arp.h::PACK_STRUCT_STRUCT" ref="a7f002f47b5fc16e9c8e866c7b1c525a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structeth__hdr.html">eth_hdr</a> <a class="el" href="arp_8c.html#b335643ec08d519342c9d3834091d6e0">PACK_STRUCT_STRUCT</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="60f1dc6554771c253cfaf098c6c03db0"></a><!-- doxytag: member="arp.h::PACK_STRUCT_STRUCT" ref="60f1dc6554771c253cfaf098c6c03db0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structeth__addr.html">eth_addr</a> <a class="el" href="arp_8c.html#b335643ec08d519342c9d3834091d6e0">PACK_STRUCT_STRUCT</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 08:52:11 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>
