<!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 V2: C:/Dev/git/UbixOS/sys/include/netif/slipif.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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 V2
 <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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_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('slipif_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">slipif.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="opt_8h_source.html">net/opt.h</a>"</code><br />
<code>#include "<a class="el" href="netif_8h_source.html">net/netif.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for slipif.h:</div>
<div class="dyncontent">
<div class="center"><img src="slipif_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2netif_2slipif_8h" alt=""/></div>
</div>
</div>
<p><a href="slipif_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a832eb1b9634b21aa0b91f78abfd852ea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="slipif_8h.html#a832eb1b9634b21aa0b91f78abfd852ea">SLIP_RX_FROM_ISR</a>   0</td></tr>
<tr class="separator:a832eb1b9634b21aa0b91f78abfd852ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37ce8613535232db02bfd9ae9b51c668"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="slipif_8h.html#a37ce8613535232db02bfd9ae9b51c668">SLIP_RX_QUEUE</a>   <a class="el" href="slipif_8h.html#a832eb1b9634b21aa0b91f78abfd852ea">SLIP_RX_FROM_ISR</a></td></tr>
<tr class="separator:a37ce8613535232db02bfd9ae9b51c668"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a198967c11f79cffc32192710294e8826"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="slipif_8h.html#a198967c11f79cffc32192710294e8826">SLIP_USE_RX_THREAD</a>   !<a class="el" href="opt_8h.html#ae00ba99de94a5bf84d832be8976df59b">NO_SYS</a></td></tr>
<tr class="separator:a198967c11f79cffc32192710294e8826"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a687973ba82dab13a5b9d38d7399aeee3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="slipif_8h.html#a687973ba82dab13a5b9d38d7399aeee3">slipif_init</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:a687973ba82dab13a5b9d38d7399aeee3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b036fd1cde9b299139cac62f52d15a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="slipif_8h.html#a7b036fd1cde9b299139cac62f52d15a6">slipif_poll</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:a7b036fd1cde9b299139cac62f52d15a6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SLIP netif API </p>
<p class="definition">Definition in file <a class="el" href="slipif_8h_source.html">slipif.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a832eb1b9634b21aa0b91f78abfd852ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a832eb1b9634b21aa0b91f78abfd852ea">◆ </a></span>SLIP_RX_FROM_ISR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SLIP_RX_FROM_ISR   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set this to 1 to enable functions to pass in RX bytes from ISR context. If enabled, slipif_received_byte[s]() process incoming bytes and put assembled packets on a queue, which is fed into lwIP from <a class="el" href="slipif_8h.html#a7b036fd1cde9b299139cac62f52d15a6">slipif_poll()</a>. If disabled, <a class="el" href="slipif_8h.html#a7b036fd1cde9b299139cac62f52d15a6">slipif_poll()</a> polls the serial line (using <a class="el" href="sio_8h.html#a3780ab1928702f82974ee66988220040">sio_tryread()</a>). </p>
<p class="definition">Definition at line <a class="el" href="slipif_8h_source.html#l00059">59</a> of file <a class="el" href="slipif_8h_source.html">slipif.h</a>.</p>
</div>
</div>
<a id="a37ce8613535232db02bfd9ae9b51c668"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37ce8613535232db02bfd9ae9b51c668">◆ </a></span>SLIP_RX_QUEUE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SLIP_RX_QUEUE   <a class="el" href="slipif_8h.html#a832eb1b9634b21aa0b91f78abfd852ea">SLIP_RX_FROM_ISR</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set this to 1 (default for SLIP_RX_FROM_ISR) to queue incoming packets received by slipif_received_byte[s]() as long as PBUF_POOL pbufs are available. If disabled, packets will be dropped if more than one packet is received. </p>
<p class="definition">Definition at line <a class="el" href="slipif_8h_source.html#l00067">67</a> of file <a class="el" href="slipif_8h_source.html">slipif.h</a>.</p>
</div>
</div>
<a id="a198967c11f79cffc32192710294e8826"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a198967c11f79cffc32192710294e8826">◆ </a></span>SLIP_USE_RX_THREAD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SLIP_USE_RX_THREAD   !<a class="el" href="opt_8h.html#ae00ba99de94a5bf84d832be8976df59b">NO_SYS</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set this to 1 to start a thread that blocks reading on the serial line (using <a class="el" href="sio_8h.html#ac5a6563ee5f12459451010139a04a03b">sio_read()</a>). </p>
<p class="definition">Definition at line <a class="el" href="slipif_8h_source.html#l00050">50</a> of file <a class="el" href="slipif_8h_source.html">slipif.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a687973ba82dab13a5b9d38d7399aeee3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a687973ba82dab13a5b9d38d7399aeee3">◆ </a></span>slipif_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> slipif_init </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> * </td>
<td class="paramname"><em>netif</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7b036fd1cde9b299139cac62f52d15a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b036fd1cde9b299139cac62f52d15a6">◆ </a></span>slipif_poll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slipif_poll </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> * </td>
<td class="paramname"><em>netif</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</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_e6bb53534ac0e427887cf7a94c0c004e.html">C:</a></li><li class="navelem"><a class="el" href="dir_d99d5d4662bf24521eef49da6a8cd34d.html">Dev</a></li><li class="navelem"><a class="el" href="dir_474a4b306371cf7e7f6fa12cb0b77df6.html">git</a></li><li class="navelem"><a class="el" href="dir_849109bbd106d461b128d63e5babcedf.html">UbixOS</a></li><li class="navelem"><a class="el" href="dir_6ec99f6d7d5182ba8913209ab70c9f18.html">sys</a></li><li class="navelem"><a class="el" href="dir_d1be8160e739b6eed1f7843efdbae1b3.html">include</a></li><li class="navelem"><a class="el" href="dir_d30d4e36b590a245c15c34f21c61e7a6.html">netif</a></li><li class="navelem"><a class="el" href="slipif_8h.html">slipif.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>
