Newer
Older
UbixOS / doc / html / dc / ddb / ethernetif_8h.html
<!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: include/netif/ethernetif.h File 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&amp;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
   &#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dc/ddb/ethernetif_8h.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ethernetif.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="../../df/df7/ethernetif_8h__dep__incl.png" border="0" usemap="#include_2netif_2ethernetif_8hdep" alt=""/></div>
<map name="include_2netif_2ethernetif_8hdep" id="include_2netif_2ethernetif_8hdep">
<area shape="rect" title=" " alt="" coords="5,5,164,32"/>
<area shape="rect" href="../../d6/d49/net_2init_8c.html" title=" " alt="" coords="37,80,132,107"/>
</map>
</div>
</div>
<p><a href="../../dc/ddb/ethernetif_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7ce979d0ec31575ecf17998b7bd9abb2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/ddb/ethernetif_8h.html#a7ce979d0ec31575ecf17998b7bd9abb2">ethernetif_init</a> (struct <a class="el" href="../../d2/dd6/structnetif.html">netif</a> *<a class="el" href="../../d2/dd6/structnetif.html">netif</a>)</td></tr>
<tr class="separator:a7ce979d0ec31575ecf17998b7bd9abb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a7ce979d0ec31575ecf17998b7bd9abb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ce979d0ec31575ecf17998b7bd9abb2">&#9670;&nbsp;</a></span>ethernetif_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> ethernetif_init </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="../../d2/dd6/structnetif.html">netif</a> *&#160;</td>
          <td class="paramname"><em>netif</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Should be called at the beginning of the program to set up the network interface. It calls the function low_level_init() to do the actual setup of the hardware.</p>
<p>This function should be passed as a parameter to <a class="el" href="../../d7/d3a/group__netif.html#ga66970b5877dd6b0cae906bfa78d0cb4c">netif_add()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">netif</td><td>the lwip network interface structure for this ethernetif </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ERR_OK if the loopif is initialized ERR_MEM if private data couldn't be allocated any other err_t on error </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../da/dc8/ethernetif_8c_source.html#l00302">302</a> of file <a class="el" href="../../da/dc8/ethernetif_8c_source.html">ethernetif.c</a>.</p>

<p class="reference">References <a class="el" href="../../d6/d40/err_8h_source.html#l00065">ERR_MEM</a>, <a class="el" href="../../da/dc8/ethernetif_8c_source.html#l00060">IFNAME0</a>, <a class="el" href="../../da/dc8/ethernetif_8c_source.html#l00061">IFNAME1</a>, <a class="el" href="../../d9/d69/netif_8h_source.html#l00263">netif::linkoutput</a>, <a class="el" href="../../db/d16/debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="../../db/d16/debug_8h_source.html#l00164">LWIP_DEBUGF</a>, <a class="el" href="../../d3/d8f/mem_8c_source.html#l00603">mem_malloc()</a>, <a class="el" href="../../d9/d69/netif_8h_source.html#l00315">netif::name</a>, <a class="el" href="../../d2/d78/lwipopts_8h_source.html#l00433">NETIF_DEBUG</a>, <a class="el" href="../../d6/d8a/fat__string_8h_source.html#l00017">NULL</a>, and <a class="el" href="../../d9/d69/netif_8h_source.html#l00287">netif::state</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d6/d49/net_2init_8c_source.html#l00052">net_init()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../dc/ddb/ethernetif_8h_a7ce979d0ec31575ecf17998b7bd9abb2_cgraph.png" border="0" usemap="#dc/ddb/ethernetif_8h_a7ce979d0ec31575ecf17998b7bd9abb2_cgraph" alt=""/></div>
<map name="dc/ddb/ethernetif_8h_a7ce979d0ec31575ecf17998b7bd9abb2_cgraph" id="dc/ddb/ethernetif_8h_a7ce979d0ec31575ecf17998b7bd9abb2_cgraph">
<area shape="rect" title=" " alt="" coords="5,107,104,133"/>
<area shape="rect" href="../../d9/d9a/mem_8h.html#a932aa40d85b14cb7331625e012d12335" title=" " alt="" coords="152,107,248,133"/>
<area shape="rect" href="../../d8/d3b/group__sys__mutex.html#ga4d4eb9afe5965fa2661dd54ff55d616a" title=" " alt="" coords="296,107,413,133"/>
<area shape="rect" href="../../dd/d1b/ubthread_8h.html#aa13bf141cd3e9bf0921fbf61ffc637d8" title=" " alt="" coords="461,107,608,133"/>
<area shape="rect" href="../../dc/d94/armv6_2kpanic_8c.html#adb9a182aa071791a306163d50d653deb" title="print panic message and halt system" alt="" coords="656,81,716,108"/>
<area shape="rect" href="../../da/d28/kprintf_8h.html#a20b56810edb62a6fe59917015c30848f" title=" " alt="" coords="657,132,715,159"/>
<area shape="rect" href="../../dd/d78/video_8h.html#a5429378b96a24fadfd2d1f8d777eb95a" title=" " alt="" coords="770,81,825,108"/>
<area shape="rect" href="../../df/d87/kprintf_8c.html#a3093cdac4668a4ccffdd7f77270888b7" title=" " alt="" coords="766,132,829,159"/>
<area shape="rect" href="../../da/d28/kprintf_8h.html#a3b4a66bf1f6583e65660f281b6014aa1" title=" " alt="" coords="764,183,831,209"/>
<area shape="rect" href="../../dc/dac/io_8h.html#a77b934268de1b3ecdcf3f275413b3108" title="input one byte from specified port" alt="" coords="883,5,964,32"/>
<area shape="rect" href="../../dc/dac/io_8h.html#a8acc1a06073db2e7b92ffbd00fbd0cf1" title="outputut one byte to specified port" alt="" coords="879,56,968,83"/>
<area shape="rect" href="../../dd/d71/tty_8h.html#a4f96ccac7e60296ef496008d8cbed0ff" title=" " alt="" coords="891,107,955,133"/>
<area shape="rect" href="../../dd/d71/tty_8h.html#ad96f57a7c113d3cfa76ee5fed6de33c0" title=" " alt="" coords="889,157,958,184"/>
<area shape="rect" href="../../dc/d88/armv6_2spinlock_8c.html#a71f03d2ba55111c715b6068254847a53" title=" " alt="" coords="1016,157,1091,184"/>
<area shape="rect" href="../../d3/d02/armv6_2sched_8c.html#a08933fe6d593a1c78b9080359f15a0b7" title=" " alt="" coords="1139,132,1230,159"/>
<area shape="rect" href="../../dc/d88/armv6_2spinlock_8c.html#a740766af5da58616f700fffab6768a78" title=" " alt="" coords="1139,183,1231,209"/>
</map>
</div>

</div>
</div>
</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="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_2162fc6037b6e4ab717e059c91201c39.html">netif</a></li><li class="navelem"><a class="el" href="../../dc/ddb/ethernetif_8h.html">ethernetif.h</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>