blob: 3caf36eb385a2175ee518126605eebb393798ccf [file] [log] [blame] [edit]
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: 6LoWPAN (RFC4944)</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">lwIP<span id="projectnumber">&#160;2.1.3</span>
</div>
<div id="projectbrief">Lightweight IP stack</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('group__sixlowpan.html',''); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">6LoWPAN (RFC4944)<div class="ingroups"><a class="el" href="group__netifs.html">NETIFs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga94c6d289bc25a14fd0fee9230ae3af94" id="r_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="#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" id="r_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="#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" id="r_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="#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" id="r_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="#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" id="r_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="#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:ga9d9b93c47dd138fd84a503ffecb9336b" id="r_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="#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>
<p>6LowPAN netif implementation</p>
<p>6LowPAN netif implementation </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga3c943da6f9d3f1096bdcebe3e19d38b7" name="ga3c943da6f9d3f1096bdcebe3e19d38b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c943da6f9d3f1096bdcebe3e19d38b7">&#9670;&#160;</a></span>lowpan6_input()</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> lowpan6_input </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> *</td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>netif</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>NETIF input function: don't free the input pbuf when returning != ERR_OK! </p>
</div>
</div>
<a id="ga9e650551777ededccf035ef9aaee247b" name="ga9e650551777ededccf035ef9aaee247b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9e650551777ededccf035ef9aaee247b">&#9670;&#160;</a></span>lowpan6_output()</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> lowpan6_output </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>netif</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> *</td> <td class="paramname"><span class="paramname"><em>q</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>ip6addr</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolve and fill-in IEEE 802.15.4 address header for outgoing IPv6 packet.</p>
<p>Perform Header Compression and fragment if necessary.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>The lwIP network interface which the IP packet will be sent on. </td></tr>
<tr><td class="paramname">q</td><td>The <a class="el" href="structpbuf.html">pbuf(s)</a> containing the IP packet to be sent. </td></tr>
<tr><td class="paramname">ip6addr</td><td>The IP address of the packet destination.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>err_t </dd></dl>
</div>
</div>
<a id="ga94c6d289bc25a14fd0fee9230ae3af94" name="ga94c6d289bc25a14fd0fee9230ae3af94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga94c6d289bc25a14fd0fee9230ae3af94">&#9670;&#160;</a></span>lowpan6_set_context()</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> lowpan6_set_context </td>
<td>(</td>
<td class="paramtype">u8_t</td> <td class="paramname"><span class="paramname"><em>idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>context</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set context </p>
</div>
</div>
<a id="gade00524e85d37a3521ea85359f801df3" name="gade00524e85d37a3521ea85359f801df3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade00524e85d37a3521ea85359f801df3">&#9670;&#160;</a></span>lowpan6_set_pan_id()</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> lowpan6_set_pan_id </td>
<td>(</td>
<td class="paramtype">u16_t</td> <td class="paramname"><span class="paramname"><em>pan_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set PAN ID </p>
</div>
</div>
<a id="gafee5495843dfb36cb77ba2f16ea6a625" name="gafee5495843dfb36cb77ba2f16ea6a625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafee5495843dfb36cb77ba2f16ea6a625">&#9670;&#160;</a></span>lowpan6_set_short_addr()</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> lowpan6_set_short_addr </td>
<td>(</td>
<td class="paramtype">u8_t</td> <td class="paramname"><span class="paramname"><em>addr_high</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8_t</td> <td class="paramname"><span class="paramname"><em>addr_low</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set short address </p>
</div>
</div>
<a id="ga9d9b93c47dd138fd84a503ffecb9336b" name="ga9d9b93c47dd138fd84a503ffecb9336b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d9b93c47dd138fd84a503ffecb9336b">&#9670;&#160;</a></span>tcpip_6lowpan_input()</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> tcpip_6lowpan_input </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> *</td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>inp</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pass a received packet to tcpip_thread for input processing</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the received packet, p-&gt;payload pointing to the IEEE 802.15.4 header. </td></tr>
<tr><td class="paramname">inp</td><td>the network interface on which the packet was received </td></tr>
</table>
</dd>
</dl>
</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="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>