<!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/net/netif.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_c1d11d251a83b2498f44d410b793c5eb.html">net</a></div>
<h1>netif.h</h1><a href="netif_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. Neither the name of the Institute nor the names of its contributors </span>
<a name="l00014"></a>00014 <span class="comment"> * may be used to endorse or promote products derived from this software </span>
<a name="l00015"></a>00015 <span class="comment"> * without specific prior written permission. </span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
<a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
<a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
<a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
<a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
<a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
<a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
<a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
<a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
<a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
<a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE. </span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
<a name="l00030"></a>00030 <span class="comment"> * </span>
<a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * $Id: netif_8h-source.html 88 2016-01-12 00:11:29Z reddawg $</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef __LWIP_NETIF_H__</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_NETIF_H__</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="opt_8h.html">net/opt.h</a>"</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="err_8h.html">net/err.h</a>"</span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="ipv4_2ip__addr_8h.html">net/ipv4/ip_addr.h</a>"</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include "<a class="code" href="ipv4_2inet_8h.html">net/ipv4/inet.h</a>"</span>
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="preprocessor">#include "<a class="code" href="pbuf_8h.html">net/pbuf.h</a>"</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047
<a name="l00048"></a><a class="code" href="structnetif.html">00048</a> <span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> {
<a name="l00049"></a><a class="code" href="structnetif.html#e77736b64df442242795220d76be6b86">00049</a> <span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *<a class="code" href="structnetif.html#e77736b64df442242795220d76be6b86">next</a>;
<a name="l00050"></a><a class="code" href="structnetif.html#79f6bfc95928144230b3cf9a8f15029b">00050</a> <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="structnetif.html#79f6bfc95928144230b3cf9a8f15029b">num</a>;
<a name="l00051"></a><a class="code" href="structnetif.html#d666097c02e7d7e82ea838b0c721470d">00051</a> <span class="keyword">struct </span><a class="code" href="structip__addr.html">ip_addr</a> <a class="code" href="structnetif.html#d666097c02e7d7e82ea838b0c721470d">ip_addr</a>;
<a name="l00052"></a><a class="code" href="structnetif.html#c4b9556c67758bde9a2b29f57f3e8cf2">00052</a> <span class="keyword">struct </span><a class="code" href="structnetif.html#d666097c02e7d7e82ea838b0c721470d">ip_addr</a> <a class="code" href="structnetif.html#c4b9556c67758bde9a2b29f57f3e8cf2">netmask</a>; <span class="comment">/* netmask in network byte order */</span>
<a name="l00053"></a><a class="code" href="structnetif.html#abb83f0808c4b1bf23e5a16bc4e486a8">00053</a> <span class="keyword">struct </span><a class="code" href="structnetif.html#d666097c02e7d7e82ea838b0c721470d">ip_addr</a> <a class="code" href="structnetif.html#abb83f0808c4b1bf23e5a16bc4e486a8">gw</a>;
<a name="l00054"></a><a class="code" href="structnetif.html#18e73df74457dd1cb02d61d24e3ba924">00054</a> <span class="keywordtype">char</span> <a class="code" href="structnetif.html#18e73df74457dd1cb02d61d24e3ba924">hwaddr</a>[6];
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">/* This function is called by the network device driver</span>
<a name="l00057"></a>00057 <span class="comment"> when it wants to pass a packet to the TCP/IP stack. */</span>
<a name="l00058"></a>00058 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> (* <a class="code" href="structnetif.html#6a3101eb624d17937618618a57e2e570">input</a>)(<span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> *p, <span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *inp);
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">/* The following two fields should be filled in by the</span>
<a name="l00061"></a>00061 <span class="comment"> initialization function for the device driver. */</span>
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="structnetif.html#32fca6ffd28bb9af3f891a378827a67e">00063</a> <span class="keywordtype">char</span> <a class="code" href="structnetif.html#32fca6ffd28bb9af3f891a378827a67e">name</a>[2];
<a name="l00064"></a>00064 <span class="comment">/* This function is called by the IP module when it wants</span>
<a name="l00065"></a>00065 <span class="comment"> to send a packet on the interface. */</span>
<a name="l00066"></a>00066 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> (* <a class="code" href="structnetif.html#b180ab98b90830ed15503822405e5a23">output</a>)(<span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *<a class="code" href="structnetif.html">netif</a>, <span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> *p, <span class="keyword">struct </span><a class="code" href="structnetif.html#d666097c02e7d7e82ea838b0c721470d">ip_addr</a> *ipaddr);
<a name="l00067"></a>00067 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> (* <a class="code" href="structnetif.html#bf9e416b29a3de59c78b141b8eed37cc">linkoutput</a>)(<span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *<a class="code" href="structnetif.html">netif</a>, <span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> *p);
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">/* This field can be set bu the device driver and could point</span>
<a name="l00070"></a>00070 <span class="comment"> to state information for the device. */</span>
<a name="l00071"></a><a class="code" href="structnetif.html#809cc57c0dff09c5c9ae45b02c2002f3">00071</a> <span class="keywordtype">void</span> *<a class="code" href="structnetif.html#809cc57c0dff09c5c9ae45b02c2002f3">state</a>;
<a name="l00072"></a>00072 };
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">/* The list of network interfaces. */</span>
<a name="l00075"></a>00075 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *<a class="code" href="netif_8h.html#1c8141eaa98f6dc6dfddbb23a706656c">netif_list</a>;
<a name="l00076"></a>00076 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *<a class="code" href="netif_8h.html#3d0925cbce550ed461907aee816713ba">netif_default</a>;
<a name="l00077"></a>00077
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">/* netif_init() must be called first. */</span>
<a name="l00080"></a>00080 <span class="keywordtype">void</span> <a class="code" href="netif_8h.html#ee2d169c9bbeb9dcfdb8bfc4e91bf2fc">netif_init</a>();
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">struct </span><a class="code" href="structnetif.html">netif</a> *<a class="code" href="netif_8h.html#2270b418f2081615edf85d7186880229">netif_add</a>(<span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *ipaddr, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *<a class="code" href="structnetif.html#c4b9556c67758bde9a2b29f57f3e8cf2">netmask</a>,
<a name="l00083"></a>00083 <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *<a class="code" href="structnetif.html#abb83f0808c4b1bf23e5a16bc4e486a8">gw</a>,
<a name="l00084"></a>00084 <span class="keywordtype">void</span> (* init)(<span class="keyword">struct</span> <a class="code" href="structnetif.html">netif</a> *<a class="code" href="structnetif.html">netif</a>),
<a name="l00085"></a>00085 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> (* <a class="code" href="structnetif.html#6a3101eb624d17937618618a57e2e570">input</a>)(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p, <span class="keyword">struct</span> netif *netif));
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/* Returns a network interface given its name. The name is of the form</span>
<a name="l00088"></a>00088 <span class="comment"> "et0", where the first two letters are the "name" field in the</span>
<a name="l00089"></a>00089 <span class="comment"> netif structure, and the digit is in the num field in the same</span>
<a name="l00090"></a>00090 <span class="comment"> structure. */</span>
<a name="l00091"></a>00091 <span class="keyword">struct </span>netif *<a class="code" href="netif_8h.html#4b744acecfae7ee43e1df3ed7c6f8832">netif_find</a>(<span class="keywordtype">char</span> *<a class="code" href="pci_8c.html#8f8f80d37794cde9472343e4487ba3eb">name</a>);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="netif_8h.html#c90f290edd005238d62aa94c4ac9dea3">netif_set_default</a>(<span class="keyword">struct</span> netif *netif);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="netif_8h.html#e17baa14001e3f2b2d32d291ca00cf50">netif_set_ipaddr</a>(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *ipaddr);
<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="netif_8h.html#62ef93007956d6816a96d5c90a1bed5b">netif_set_netmask</a>(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *netmast);
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="netif_8h.html#5b19d4bb83409f81c5ab3cb96b6b65a6">netif_set_gw</a>(<span class="keyword">struct</span> netif *netif, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *<a class="code" href="structnetif.html#abb83f0808c4b1bf23e5a16bc4e486a8">gw</a>);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_NETIF_H__ */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 08:52:04 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>
