blob: af1b3a57435b367e6bd8767582605fc6086d6ea3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: src/include/netif/lowpan6.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">
$(document).ready(initResizable);
</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">lwIP
&#160;<span id="projectnumber">2.1.2</span>
</div>
<div id="projectbrief">Lightweight IP stack</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('lowpan6_8h.html','');});
</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> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">lowpan6.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="lowpan6__opts_8h.html">netif/lowpan6_opts.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="lowpan6__common_8h.html">netif/lowpan6_common.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="pbuf_8h.html">lwip/pbuf.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ip_8h.html">lwip/ip.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ip__addr_8h.html">lwip/ip_addr.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="netif_8h.html">lwip/netif.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa258ae16a937c40333c8f97a7f236797"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lowpan6_8h.html#aa258ae16a937c40333c8f97a7f236797">LOWPAN6_TMR_INTERVAL</a>&#160;&#160;&#160;1000</td></tr>
<tr class="separator:aa258ae16a937c40333c8f97a7f236797"><td class="memSeparator" colspan="2">&#160;</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:ac8c3a4612aeb23f65e55c18faf5ad7d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lowpan6_8h.html#ac8c3a4612aeb23f65e55c18faf5ad7d7">lowpan6_tmr</a> (void)</td></tr>
<tr class="separator:ac8c3a4612aeb23f65e55c18faf5ad7d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94c6d289bc25a14fd0fee9230ae3af94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sixlowpan.html#ga94c6d289bc25a14fd0fee9230ae3af94">lowpan6_set_context</a> (u8_t idx, const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *context)</td></tr>
<tr class="separator:ga94c6d289bc25a14fd0fee9230ae3af94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafee5495843dfb36cb77ba2f16ea6a625"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sixlowpan.html#gafee5495843dfb36cb77ba2f16ea6a625">lowpan6_set_short_addr</a> (u8_t addr_high, u8_t addr_low)</td></tr>
<tr class="separator:gafee5495843dfb36cb77ba2f16ea6a625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e650551777ededccf035ef9aaee247b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sixlowpan.html#ga9e650551777ededccf035ef9aaee247b">lowpan6_output</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> *q, const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *ip6addr)</td></tr>
<tr class="separator:ga9e650551777ededccf035ef9aaee247b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c943da6f9d3f1096bdcebe3e19d38b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sixlowpan.html#ga3c943da6f9d3f1096bdcebe3e19d38b7">lowpan6_input</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:ga3c943da6f9d3f1096bdcebe3e19d38b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gade00524e85d37a3521ea85359f801df3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sixlowpan.html#gade00524e85d37a3521ea85359f801df3">lowpan6_set_pan_id</a> (u16_t pan_id)</td></tr>
<tr class="separator:gade00524e85d37a3521ea85359f801df3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab33dc87f30aeda871845854511de9931"><td class="memItemLeft" align="right" valign="top">u16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lowpan6_8h.html#ab33dc87f30aeda871845854511de9931">lowpan6_calc_crc</a> (const void *buf, u16_t len)</td></tr>
<tr class="separator:ab33dc87f30aeda871845854511de9931"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d9b93c47dd138fd84a503ffecb9336b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sixlowpan.html#ga9d9b93c47dd138fd84a503ffecb9336b">tcpip_6lowpan_input</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, struct <a class="el" href="structnetif.html">netif</a> *inp)</td></tr>
<tr class="separator:ga9d9b93c47dd138fd84a503ffecb9336b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>6LowPAN output for IPv6. Uses ND tables for link-layer addressing. Fragments packets to 6LowPAN units. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa258ae16a937c40333c8f97a7f236797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa258ae16a937c40333c8f97a7f236797">&#9670;&nbsp;</a></span>LOWPAN6_TMR_INTERVAL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LOWPAN6_TMR_INTERVAL&#160;&#160;&#160;1000</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 second period for reassembly </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab33dc87f30aeda871845854511de9931"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab33dc87f30aeda871845854511de9931">&#9670;&nbsp;</a></span>lowpan6_calc_crc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16_t lowpan6_calc_crc </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the 16-bit CRC as required by IEEE 802.15.4 </p>
</div>
</div>
<a id="ac8c3a4612aeb23f65e55c18faf5ad7d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8c3a4612aeb23f65e55c18faf5ad7d7">&#9670;&nbsp;</a></span>lowpan6_tmr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lowpan6_tmr </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Periodic timer for 6LowPAN functions:</p>
<ul>
<li>Remove incomplete/old packets </li>
</ul>
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_c9a67764bf8a12cf6b427bb859cbcd0b.html">netif</a></li><li class="navelem"><a class="el" href="lowpan6_8h.html">lowpan6.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.13 </li>
</ul>
</div>
</body>
</html>