mirror of
https://github.com/buildwithparallel/mm-iot-sdk
synced 2026-08-10 21:27:58 -04:00
4f4eb7fc7a
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK for ARM microcontroller base platforms.
238 lines
16 KiB
HTML
238 lines
16 KiB
HTML
<!-- 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: mmhal_robuf 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
|
|
 <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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('structmmhal__robuf.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">mmhal_robuf Struct Reference<div class="ingroups"><a class="el" href="group__MMHAL.html">Morse Micro Hardware Abstraction Layer (mmhal) API</a> » <a class="el" href="group__MMHAL__WLAN.html">WLAN HAL</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 >Read-only buffer data structure. </p>
|
|
<p >The design of this data structure allows the buffer to exist either in statically or dynamically allocated memory.</p>
|
|
<p >For statically allocated memory, the field <code>free_cb</code> may be set to <code>NULL</code> and <code>free_arg</code> ignored. For example:</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">const</span> uint8_t some_data[] = { 0x00, 0x01, 0x02 };</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">void</span> put_some_data_into_buf(<span class="keyword">struct</span> <a class="code hl_struct" href="structmmhal__robuf.html">mmhal_robuf</a> *robuf)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> robuf-><a class="code hl_variable" href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">buf</a> = some_data;</div>
|
|
<div class="line"> robuf-><a class="code hl_variable" href="structmmhal__robuf.html#a66ce9fbb066da8f39a6559c66f7e36a1">len</a> = <span class="keyword">sizeof</span>(some_data);</div>
|
|
<div class="line"> robuf-><a class="code hl_variable" href="structmmhal__robuf.html#ae7c0e29e8274e3b1e0405cf6c2f15846">free_cb</a> = NULL;</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="astructmmhal__robuf_html"><div class="ttname"><a href="structmmhal__robuf.html">mmhal_robuf</a></div><div class="ttdoc">Read-only buffer data structure.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__wlan_8h_source.html#l00161">mmhal_wlan.h:162</a></div></div>
|
|
<div class="ttc" id="astructmmhal__robuf_html_a0c0f446e47dc79dd2668b24da2433ae9"><div class="ttname"><a href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">mmhal_robuf::buf</a></div><div class="ttdeci">const uint8_t * buf</div><div class="ttdoc">Pointer to the start of the read-only buffer.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__wlan_8h_source.html#l00164">mmhal_wlan.h:164</a></div></div>
|
|
<div class="ttc" id="astructmmhal__robuf_html_a66ce9fbb066da8f39a6559c66f7e36a1"><div class="ttname"><a href="structmmhal__robuf.html#a66ce9fbb066da8f39a6559c66f7e36a1">mmhal_robuf::len</a></div><div class="ttdeci">uint32_t len</div><div class="ttdoc">Length of the buffer contents.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__wlan_8h_source.html#l00166">mmhal_wlan.h:166</a></div></div>
|
|
<div class="ttc" id="astructmmhal__robuf_html_ae7c0e29e8274e3b1e0405cf6c2f15846"><div class="ttname"><a href="structmmhal__robuf.html#ae7c0e29e8274e3b1e0405cf6c2f15846">mmhal_robuf::free_cb</a></div><div class="ttdeci">void(* free_cb)(void *arg)</div><div class="ttdoc">Optional callback to be invoked by the consumer to release the buffer when it is no longer required.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__wlan_8h_source.html#l00175">mmhal_wlan.h:175</a></div></div>
|
|
</div><!-- fragment --><p >For dynamically allocated memory, the field <code>free_cb</code> is set to the appropriate function to free the buffer and <code>free_arg</code> is an opaque argument to the free function. This approach might be used, for example, when reading into a temporary buffer from storage that is not memory mapped. For example:</p>
|
|
<div class="fragment"><div class="line"><span class="preprocessor">#define SOME_DATA_MAXLEN (64)</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">void</span> put_some_data_into_buf(<span class="keyword">struct</span> <a class="code hl_struct" href="structmmhal__robuf.html">mmhal_robuf</a> *robuf)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> uint8_t *<a class="code hl_variable" href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">buf</a> = malloc(SOME_DATA_MAXLEN);</div>
|
|
<div class="line"> robuf-><a class="code hl_variable" href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">buf</a> = <a class="code hl_variable" href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">buf</a>;</div>
|
|
<div class="line"> <span class="keywordflow">if</span> (robuf-><a class="code hl_variable" href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">buf</a> == NULL)</div>
|
|
<div class="line"> <span class="keywordflow">return</span>;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// HERE: copy data into buf and set robuf->len as appropriate</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> robuf-><a class="code hl_variable" href="structmmhal__robuf.html#ae7c0e29e8274e3b1e0405cf6c2f15846">free_cb</a> = free;</div>
|
|
<div class="line"> robuf-><a class="code hl_variable" href="structmmhal__robuf.html#a9c02d45ff49ce154092b947e3c5994f1">free_arg</a> = <a class="code hl_variable" href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">buf</a>;</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="astructmmhal__robuf_html_a9c02d45ff49ce154092b947e3c5994f1"><div class="ttname"><a href="structmmhal__robuf.html#a9c02d45ff49ce154092b947e3c5994f1">mmhal_robuf::free_arg</a></div><div class="ttdeci">void * free_arg</div><div class="ttdoc">Optional argument to free_cb.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__wlan_8h_source.html#l00177">mmhal_wlan.h:177</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="mmhal__wlan_8h_source.html#l00161">161</a> of file <a class="el" href="mmhal__wlan_8h_source.html">mmhal_wlan.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmhal__wlan_8h_source.html">mmhal_wlan.h</a>></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:a0c0f446e47dc79dd2668b24da2433ae9"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">buf</a></td></tr>
|
|
<tr class="memdesc:a0c0f446e47dc79dd2668b24da2433ae9"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the start of the read-only buffer. <a href="structmmhal__robuf.html#a0c0f446e47dc79dd2668b24da2433ae9">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c0f446e47dc79dd2668b24da2433ae9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66ce9fbb066da8f39a6559c66f7e36a1"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmhal__robuf.html#a66ce9fbb066da8f39a6559c66f7e36a1">len</a></td></tr>
|
|
<tr class="memdesc:a66ce9fbb066da8f39a6559c66f7e36a1"><td class="mdescLeft"> </td><td class="mdescRight">Length of the buffer contents. <a href="structmmhal__robuf.html#a66ce9fbb066da8f39a6559c66f7e36a1">More...</a><br /></td></tr>
|
|
<tr class="separator:a66ce9fbb066da8f39a6559c66f7e36a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7c0e29e8274e3b1e0405cf6c2f15846"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmhal__robuf.html#ae7c0e29e8274e3b1e0405cf6c2f15846">free_cb</a> )(void *arg)</td></tr>
|
|
<tr class="memdesc:ae7c0e29e8274e3b1e0405cf6c2f15846"><td class="mdescLeft"> </td><td class="mdescRight">Optional callback to be invoked by the consumer to release the buffer when it is no longer required. <a href="structmmhal__robuf.html#ae7c0e29e8274e3b1e0405cf6c2f15846">More...</a><br /></td></tr>
|
|
<tr class="separator:ae7c0e29e8274e3b1e0405cf6c2f15846"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c02d45ff49ce154092b947e3c5994f1"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmhal__robuf.html#a9c02d45ff49ce154092b947e3c5994f1">free_arg</a></td></tr>
|
|
<tr class="memdesc:a9c02d45ff49ce154092b947e3c5994f1"><td class="mdescLeft"> </td><td class="mdescRight">Optional argument to <code>free_cb</code>. <a href="structmmhal__robuf.html#a9c02d45ff49ce154092b947e3c5994f1">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c02d45ff49ce154092b947e3c5994f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a0c0f446e47dc79dd2668b24da2433ae9" name="a0c0f446e47dc79dd2668b24da2433ae9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c0f446e47dc79dd2668b24da2433ae9">◆ </a></span>buf</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t* mmhal_robuf::buf</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Pointer to the start of the read-only buffer. </p>
|
|
<p >May be NULL only if <code>len</code> is zero. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmhal__wlan_8h_source.html#l00164">164</a> of file <a class="el" href="mmhal__wlan_8h_source.html">mmhal_wlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c02d45ff49ce154092b947e3c5994f1" name="a9c02d45ff49ce154092b947e3c5994f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c02d45ff49ce154092b947e3c5994f1">◆ </a></span>free_arg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* mmhal_robuf::free_arg</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Optional argument to <code>free_cb</code>. </p>
|
|
<p >Ignored if <code>free_cb</code> is <code>NULL</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmhal__wlan_8h_source.html#l00177">177</a> of file <a class="el" href="mmhal__wlan_8h_source.html">mmhal_wlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae7c0e29e8274e3b1e0405cf6c2f15846" name="ae7c0e29e8274e3b1e0405cf6c2f15846"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7c0e29e8274e3b1e0405cf6c2f15846">◆ </a></span>free_cb</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void(* mmhal_robuf::free_cb) (void *arg)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Optional callback to be invoked by the consumer to release the buffer when it is no longer required. </p>
|
|
<p >If not required, set to <code>NULL</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The values of <code>buf</code> and <code>len</code> in this structure may be modified before <code><a class="el" href="structmmhal__robuf.html#ae7c0e29e8274e3b1e0405cf6c2f15846" title="Optional callback to be invoked by the consumer to release the buffer when it is no longer required.">free_cb()</a></code> is invoked. However, the value of <code>free_arg</code> will be passed to <code><a class="el" href="structmmhal__robuf.html#ae7c0e29e8274e3b1e0405cf6c2f15846" title="Optional callback to be invoked by the consumer to release the buffer when it is no longer required.">free_cb()</a></code>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmhal__wlan_8h_source.html#l00175">175</a> of file <a class="el" href="mmhal__wlan_8h_source.html">mmhal_wlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a66ce9fbb066da8f39a6559c66f7e36a1" name="a66ce9fbb066da8f39a6559c66f7e36a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66ce9fbb066da8f39a6559c66f7e36a1">◆ </a></span>len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmhal_robuf::len</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Length of the buffer contents. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmhal__wlan_8h_source.html#l00166">166</a> of file <a class="el" href="mmhal__wlan_8h_source.html">mmhal_wlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmhal__wlan_8h_source.html">mmhal_wlan.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="structmmhal__robuf.html">mmhal_robuf</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|