<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS: netif Struct Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">UbixOS
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d2/dd6/structnetif.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">netif Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for netif:</div>
<div class="dyncontent">
<div class="center"><img src="../../d4/d55/structnetif__coll__graph.png" border="0" usemap="#netif_coll__map" alt="Collaboration graph"/></div>
<map name="netif_coll__map" id="netif_coll__map">
<area shape="rect" title=" " alt="" coords="5,219,104,384"/>
<area shape="rect" href="../../d9/db8/structpbuf.html" title=" " alt="" coords="15,5,94,156"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a1c171db6097bbb6f09f63549a66e00ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#a1c171db6097bbb6f09f63549a66e00ea">flags</a></td></tr>
<tr class="separator:a1c171db6097bbb6f09f63549a66e00ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee967965d999fc1a4c40a66709304e69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#aee967965d999fc1a4c40a66709304e69">hwaddr</a> [6U]</td></tr>
<tr class="separator:aee967965d999fc1a4c40a66709304e69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe1181561cb16241f3cb5ed01e567d42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#afe1181561cb16241f3cb5ed01e567d42">hwaddr_len</a></td></tr>
<tr class="separator:afe1181561cb16241f3cb5ed01e567d42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fe4f1b7b0d710216287da9615164a5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d9/d69/netif_8h.html#ab2302b1b64ac7b95f24c6bab754a575e">netif_input_fn</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#a8fe4f1b7b0d710216287da9615164a5c">input</a></td></tr>
<tr class="separator:a8fe4f1b7b0d710216287da9615164a5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acaaac9b415a7be73eb8a287c8ed18a8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d9/d69/netif_8h.html#ab75e9d808bc1b788bea84213e6a111ed">netif_linkoutput_fn</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#acaaac9b415a7be73eb8a287c8ed18a8d">linkoutput</a></td></tr>
<tr class="separator:acaaac9b415a7be73eb8a287c8ed18a8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca7d56b4e0f822b0ced2885f222b8d48"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#aca7d56b4e0f822b0ced2885f222b8d48">mtu</a></td></tr>
<tr class="separator:aca7d56b4e0f822b0ced2885f222b8d48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32fca6ffd28bb9af3f891a378827a67e"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#a32fca6ffd28bb9af3f891a378827a67e">name</a> [2]</td></tr>
<tr class="separator:a32fca6ffd28bb9af3f891a378827a67e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae77736b64df442242795220d76be6b86"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="../../d2/dd6/structnetif.html">netif</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#ae77736b64df442242795220d76be6b86">next</a></td></tr>
<tr class="separator:ae77736b64df442242795220d76be6b86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7ef01e505dd2feb781fe86756b1c973"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#ab7ef01e505dd2feb781fe86756b1c973">num</a></td></tr>
<tr class="separator:ab7ef01e505dd2feb781fe86756b1c973"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a809cc57c0dff09c5c9ae45b02c2002f3"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd6/structnetif.html#a809cc57c0dff09c5c9ae45b02c2002f3">state</a></td></tr>
<tr class="separator:a809cc57c0dff09c5c9ae45b02c2002f3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Generic data structure used for all lwIP network interfaces. The following fields should be filled in by the initialization function for the device driver: hwaddr_len, hwaddr[], mtu, flags </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00233">233</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a1c171db6097bbb6f09f63549a66e00ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c171db6097bbb6f09f63549a66e00ea">◆ </a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> netif::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>flags (</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="../../d2/d32/group__netif__flags.html">Flags</a>) </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00313">313</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../df/d02/netif_8c_source.html#l00241">netif_add()</a>, <a class="el" href="../../df/d02/netif_8c_source.html#l00203">netif_input()</a>, <a class="el" href="../../df/d02/netif_8c_source.html#l00377">netif_remove()</a>, <a class="el" href="../../df/d02/netif_8c_source.html#l00682">netif_set_down()</a>, <a class="el" href="../../df/d02/netif_8c_source.html#l00760">netif_set_link_down()</a>, <a class="el" href="../../df/d02/netif_8c_source.html#l00735">netif_set_link_up()</a>, and <a class="el" href="../../df/d02/netif_8c_source.html#l00624">netif_set_up()</a>.</p>
</div>
</div>
<a id="aee967965d999fc1a4c40a66709304e69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee967965d999fc1a4c40a66709304e69">◆ </a></span>hwaddr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> netif::hwaddr[6U]</td>
</tr>
</table>
</div><div class="memdoc">
<p>link level hardware address of this interface </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00311">311</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
</div>
</div>
<a id="afe1181561cb16241f3cb5ed01e567d42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe1181561cb16241f3cb5ed01e567d42">◆ </a></span>hwaddr_len</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> netif::hwaddr_len</td>
</tr>
</table>
</div><div class="memdoc">
<p>number of bytes used in hwaddr </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00309">309</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
</div>
</div>
<a id="a8fe4f1b7b0d710216287da9615164a5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fe4f1b7b0d710216287da9615164a5c">◆ </a></span>input</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d9/d69/netif_8h.html#ab2302b1b64ac7b95f24c6bab754a575e">netif_input_fn</a> netif::input</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called by the network device driver to pass a packet up the TCP/IP stack. </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00252">252</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
</div>
</div>
<a id="acaaac9b415a7be73eb8a287c8ed18a8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaaac9b415a7be73eb8a287c8ed18a8d">◆ </a></span>linkoutput</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d9/d69/netif_8h.html#ab75e9d808bc1b788bea84213e6a111ed">netif_linkoutput_fn</a> netif::linkoutput</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called by ethernet_output() when it wants to send a packet on the interface. This function outputs the pbuf as-is on the link medium. </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00263">263</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../da/dc8/ethernetif_8c_source.html#l00302">ethernetif_init()</a>.</p>
</div>
</div>
<a id="aca7d56b4e0f822b0ced2885f222b8d48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca7d56b4e0f822b0ced2885f222b8d48">◆ </a></span>mtu</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> netif::mtu</td>
</tr>
</table>
</div><div class="memdoc">
<p>maximum transfer unit (in bytes) </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00307">307</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
</div>
</div>
<a id="a32fca6ffd28bb9af3f891a378827a67e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32fca6ffd28bb9af3f891a378827a67e">◆ </a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char netif::name[2]</td>
</tr>
</table>
</div><div class="memdoc">
<p>descriptive abbreviation </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00315">315</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../da/dc8/ethernetif_8c_source.html#l00302">ethernetif_init()</a>, <a class="el" href="../../d2/d96/loopif_8c_source.html#l00071">loopif_init()</a>, <a class="el" href="../../df/d02/netif_8c_source.html#l00472">netif_find()</a>, and <a class="el" href="../../df/d02/netif_8c_source.html#l00604">netif_set_default()</a>.</p>
</div>
</div>
<a id="ae77736b64df442242795220d76be6b86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae77736b64df442242795220d76be6b86">◆ </a></span>next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="../../d2/dd6/structnetif.html">netif</a>* netif::next</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to next in linked list </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00235">235</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../df/d02/netif_8c_source.html#l00472">netif_find()</a>, and <a class="el" href="../../df/d02/netif_8c_source.html#l00377">netif_remove()</a>.</p>
</div>
</div>
<a id="ab7ef01e505dd2feb781fe86756b1c973"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7ef01e505dd2feb781fe86756b1c973">◆ </a></span>num</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> netif::num</td>
</tr>
</table>
</div><div class="memdoc">
<p>number of this interface </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00317">317</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../df/d02/netif_8c_source.html#l00241">netif_add()</a>, and <a class="el" href="../../df/d02/netif_8c_source.html#l00472">netif_find()</a>.</p>
</div>
</div>
<a id="a809cc57c0dff09c5c9ae45b02c2002f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a809cc57c0dff09c5c9ae45b02c2002f3">◆ </a></span>state</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* netif::state</td>
</tr>
</table>
</div><div class="memdoc">
<p>This field can be set by the device driver and could point to state information for the device. </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d69/netif_8h_source.html#l00287">287</a> of file <a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../da/dc8/ethernetif_8c_source.html#l00302">ethernetif_init()</a>, <a class="el" href="../../da/dc8/ethernetif_8c_source.html#l00270">ethernetif_input()</a>, and <a class="el" href="../../df/d02/netif_8c_source.html#l00241">netif_add()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/net/<a class="el" href="../../d9/d69/netif_8h_source.html">netif.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d2/dd6/structnetif.html">netif</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
