parallel-ref/mm-iot-sdk
1
0
Fork 0
mirror of https://github.com/buildwithparallel/mm-iot-sdk synced 2026-08-10 21:27:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
mm-iot-sdk/framework/doc/html/structmmpkt.html
Morse Micro 4f4eb7fc7a Morse Micro MM-IoT-SDK release 2.9.7 
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK
for ARM microcontroller base platforms.
2025-10-04 02:04:28 +10:00

282 lines
17 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.8.17-->
<!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.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Morse Micro IoT SDK: mmpkt 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>
<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" />
<link href="style.css" rel="stylesheet" type="text/css"/>
<link rel="shortcut icon" href="favicon.svg" />
</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="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Morse Micro IoT SDK
&#160;<span id="projectnumber">2.9.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @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');
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structmmpkt.html',''); initResizable(); });
/* @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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">mmpkt Struct Reference<div class="ingroups"><a class="el" href="group__MMPKT.html">Morse Micro Packet Buffer (mmpkt) API</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Core mmpkt data structure. </p>
<dl class="section note"><dt>Note</dt><dd>The contents of this data structure should never need to be accessed directly. Rather the various functions provided as part of this API should be used.</dd></dl>
<div class="fragment"><div class="line"> +----------------------------------------------------------+--------------+</div>
<div class="line"> | RESERVED | Data | RESERVED | METADATA |</div>
<div class="line"> +----------------------------------------------------------+--------------+</div>
<div class="line"> ^ ^ ^ ^</div>
<div class="line"> | | | |</div>
<div class="line"> | |&lt;-----------<a class="code hl_variable" href="structmmpkt.html#a2c7b78347fdd57c3a1c182f09cbcabce">data_len</a>---------&gt;| |</div>
<div class="line"> | <a class="code hl_variable" href="structmmpkt.html#a4dbc46791303bc71de5f6e1f00b865c3">start_offset</a> |</div>
<div class="line"> | |</div>
<div class="line"> |&lt;-----------------------<a class="code hl_variable" href="structmmpkt.html#a1382c23c590630414956e95ea73ef28c">buf_len</a>--------------------------&gt;|</div>
<div class="line"><a class="code hl_variable" href="structmmpkt.html#aaa75f009a976a30a9585e14a1f67cf38">buf</a></div>
<div class="ttc" id="astructmmpkt_html_a1382c23c590630414956e95ea73ef28c"><div class="ttname"><a href="structmmpkt.html#a1382c23c590630414956e95ea73ef28c">mmpkt::buf_len</a></div><div class="ttdeci">uint32_t buf_len</div><div class="ttdoc">Length of the buffer.</div><div class="ttdef"><b>Definition:</b> <a href="mmpkt_8h_source.html#l00083">mmpkt.h:83</a></div></div>
<div class="ttc" id="astructmmpkt_html_a2c7b78347fdd57c3a1c182f09cbcabce"><div class="ttname"><a href="structmmpkt.html#a2c7b78347fdd57c3a1c182f09cbcabce">mmpkt::data_len</a></div><div class="ttdeci">uint32_t data_len</div><div class="ttdoc">Length of actual data in the buffer.</div><div class="ttdef"><b>Definition:</b> <a href="mmpkt_8h_source.html#l00087">mmpkt.h:87</a></div></div>
<div class="ttc" id="astructmmpkt_html_a4dbc46791303bc71de5f6e1f00b865c3"><div class="ttname"><a href="structmmpkt.html#a4dbc46791303bc71de5f6e1f00b865c3">mmpkt::start_offset</a></div><div class="ttdeci">uint32_t start_offset</div><div class="ttdoc">Offset where actual data starts in the buffer.</div><div class="ttdef"><b>Definition:</b> <a href="mmpkt_8h_source.html#l00085">mmpkt.h:85</a></div></div>
<div class="ttc" id="astructmmpkt_html_aaa75f009a976a30a9585e14a1f67cf38"><div class="ttname"><a href="structmmpkt.html#aaa75f009a976a30a9585e14a1f67cf38">mmpkt::buf</a></div><div class="ttdeci">uint8_t * buf</div><div class="ttdoc">The buffer where data is stored.</div><div class="ttdef"><b>Definition:</b> <a href="mmpkt_8h_source.html#l00081">mmpkt.h:81</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00078">78</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
<p><code>#include &lt;<a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aaa75f009a976a30a9585e14a1f67cf38"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmmpkt.html#aaa75f009a976a30a9585e14a1f67cf38">buf</a></td></tr>
<tr class="memdesc:aaa75f009a976a30a9585e14a1f67cf38"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer where data is stored. <a href="structmmpkt.html#aaa75f009a976a30a9585e14a1f67cf38">More...</a><br /></td></tr>
<tr class="separator:aaa75f009a976a30a9585e14a1f67cf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1382c23c590630414956e95ea73ef28c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmmpkt.html#a1382c23c590630414956e95ea73ef28c">buf_len</a></td></tr>
<tr class="memdesc:a1382c23c590630414956e95ea73ef28c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of the buffer. <a href="structmmpkt.html#a1382c23c590630414956e95ea73ef28c">More...</a><br /></td></tr>
<tr class="separator:a1382c23c590630414956e95ea73ef28c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dbc46791303bc71de5f6e1f00b865c3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmmpkt.html#a4dbc46791303bc71de5f6e1f00b865c3">start_offset</a></td></tr>
<tr class="memdesc:a4dbc46791303bc71de5f6e1f00b865c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset where actual data starts in the buffer. <a href="structmmpkt.html#a4dbc46791303bc71de5f6e1f00b865c3">More...</a><br /></td></tr>
<tr class="separator:a4dbc46791303bc71de5f6e1f00b865c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c7b78347fdd57c3a1c182f09cbcabce"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmmpkt.html#a2c7b78347fdd57c3a1c182f09cbcabce">data_len</a></td></tr>
<tr class="memdesc:a2c7b78347fdd57c3a1c182f09cbcabce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of actual data in the buffer. <a href="structmmpkt.html#a2c7b78347fdd57c3a1c182f09cbcabce">More...</a><br /></td></tr>
<tr class="separator:a2c7b78347fdd57c3a1c182f09cbcabce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbd849aa6d65c8019c122fe07dc9e8d0"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unionmmpkt__metadata__ptr.html">mmpkt_metadata_ptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmmpkt.html#acbd849aa6d65c8019c122fe07dc9e8d0">metadata</a></td></tr>
<tr class="memdesc:acbd849aa6d65c8019c122fe07dc9e8d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packet metadata used by driver (context dependent). <a href="structmmpkt.html#acbd849aa6d65c8019c122fe07dc9e8d0">More...</a><br /></td></tr>
<tr class="separator:acbd849aa6d65c8019c122fe07dc9e8d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58f6ac947f3c1a2b22890a34c1143fbb"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structmmpkt__ops.html">mmpkt_ops</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmmpkt.html#a58f6ac947f3c1a2b22890a34c1143fbb">ops</a></td></tr>
<tr class="memdesc:a58f6ac947f3c1a2b22890a34c1143fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to operations data structure for this mmpkt. <a href="structmmpkt.html#a58f6ac947f3c1a2b22890a34c1143fbb">More...</a><br /></td></tr>
<tr class="separator:a58f6ac947f3c1a2b22890a34c1143fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc11817f5a456b1d94193e06d4f3bfb"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmmpkt.html">mmpkt</a> *volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmmpkt.html#adfc11817f5a456b1d94193e06d4f3bfb">next</a></td></tr>
<tr class="memdesc:adfc11817f5a456b1d94193e06d4f3bfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer that can be used to construct linked lists. <a href="structmmpkt.html#adfc11817f5a456b1d94193e06d4f3bfb">More...</a><br /></td></tr>
<tr class="separator:adfc11817f5a456b1d94193e06d4f3bfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="aaa75f009a976a30a9585e14a1f67cf38" name="aaa75f009a976a30a9585e14a1f67cf38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa75f009a976a30a9585e14a1f67cf38">&#9670;&nbsp;</a></span>buf</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* mmpkt::buf</td>
</tr>
</table>
</div><div class="memdoc">
<p>The buffer where data is stored. </p>
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00081">81</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
</div>
<a id="a1382c23c590630414956e95ea73ef28c" name="a1382c23c590630414956e95ea73ef28c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1382c23c590630414956e95ea73ef28c">&#9670;&nbsp;</a></span>buf_len</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mmpkt::buf_len</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of the buffer. </p>
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00083">83</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
</div>
<a id="a2c7b78347fdd57c3a1c182f09cbcabce" name="a2c7b78347fdd57c3a1c182f09cbcabce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c7b78347fdd57c3a1c182f09cbcabce">&#9670;&nbsp;</a></span>data_len</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mmpkt::data_len</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of actual data in the buffer. </p>
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00087">87</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
</div>
<a id="acbd849aa6d65c8019c122fe07dc9e8d0" name="acbd849aa6d65c8019c122fe07dc9e8d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbd849aa6d65c8019c122fe07dc9e8d0">&#9670;&nbsp;</a></span>metadata</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union <a class="el" href="unionmmpkt__metadata__ptr.html">mmpkt_metadata_ptr</a> mmpkt::metadata</td>
</tr>
</table>
</div><div class="memdoc">
<p>Packet metadata used by driver (context dependent). </p>
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00089">89</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
</div>
<a id="adfc11817f5a456b1d94193e06d4f3bfb" name="adfc11817f5a456b1d94193e06d4f3bfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfc11817f5a456b1d94193e06d4f3bfb">&#9670;&nbsp;</a></span>next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmmpkt.html">mmpkt</a>* volatile mmpkt::next</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer that can be used to construct linked lists. </p>
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00093">93</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
</div>
<a id="a58f6ac947f3c1a2b22890a34c1143fbb" name="a58f6ac947f3c1a2b22890a34c1143fbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58f6ac947f3c1a2b22890a34c1143fbb">&#9670;&nbsp;</a></span>ops</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const struct <a class="el" href="structmmpkt__ops.html">mmpkt_ops</a>* mmpkt::ops</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reference to operations data structure for this mmpkt. </p>
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00091">91</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
</div>
<a id="a4dbc46791303bc71de5f6e1f00b865c3" name="a4dbc46791303bc71de5f6e1f00b865c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dbc46791303bc71de5f6e1f00b865c3">&#9670;&nbsp;</a></span>start_offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mmpkt::start_offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>Offset where actual data starts in the buffer. </p>
<p class="definition">Definition at line <a class="el" href="mmpkt_8h_source.html#l00085">85</a> of file <a class="el" href="mmpkt_8h_source.html">mmpkt.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="mmpkt_8h_source.html">mmpkt.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.17-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structmmpkt.html">mmpkt</a></li>
<li class="footer">Copyright 2021 Morse Micro </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink