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.
151 lines
9.1 KiB
HTML
151 lines
9.1 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: mmwlan_boot_args 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('structmmwlan__boot__args.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">mmwlan_boot_args Struct Reference<div class="ingroups"><a class="el" href="group__MMWLAN.html">Morse Micro Wireless LAN (mmwlan) API</a> » <a class="el" href="group__MMWLAN__CTRL.html">WLAN Control 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 >Arguments data structure for <a class="el" href="group__MMWLAN__CTRL.html#ga1a5050da56c30035ffcc4c49b7ff95d4">mmwlan_boot()</a>. </p>
|
|
<p >This structure should be initialized using <a class="el" href="group__MMWLAN__CTRL.html#gab5d5667ce06444a29cf2a28ed7f54faa">MMWLAN_BOOT_ARGS_INIT</a> for sensible default values, particularly for forward compatibility with new releases that may add new fields to the struct. For example:</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This struct currently does not include any sensible arguments yet, and is provided for forwards compatibility with potential future API extensions.</dd></dl>
|
|
<div class="fragment"><div class="line"><span class="keyword">enum</span> <a class="code hl_enumeration" href="group__MMWLAN.html#ga0039072000d47e5c3712686bf1e43086">mmwlan_status</a> status;</div>
|
|
<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structmmwlan__boot__args.html">mmwlan_boot_args</a> boot_args = <a class="code hl_define" href="group__MMWLAN__CTRL.html#gab5d5667ce06444a29cf2a28ed7f54faa">MMWLAN_BOOT_ARGS_INIT</a>;</div>
|
|
<div class="line"><span class="comment">// HERE: initialize arguments</span></div>
|
|
<div class="line">status = <a class="code hl_function" href="group__MMWLAN__CTRL.html#ga1a5050da56c30035ffcc4c49b7ff95d4">mmwlan_boot</a>(&boot_args);</div>
|
|
<div class="ttc" id="agroup__MMWLAN__CTRL_html_ga1a5050da56c30035ffcc4c49b7ff95d4"><div class="ttname"><a href="group__MMWLAN__CTRL.html#ga1a5050da56c30035ffcc4c49b7ff95d4">mmwlan_boot</a></div><div class="ttdeci">enum mmwlan_status mmwlan_boot(const struct mmwlan_boot_args *args)</div><div class="ttdoc">Boot the Morse Micro transceiver and leave it in an idle state.</div></div>
|
|
<div class="ttc" id="agroup__MMWLAN__CTRL_html_gab5d5667ce06444a29cf2a28ed7f54faa"><div class="ttname"><a href="group__MMWLAN__CTRL.html#gab5d5667ce06444a29cf2a28ed7f54faa">MMWLAN_BOOT_ARGS_INIT</a></div><div class="ttdeci">#define MMWLAN_BOOT_ARGS_INIT</div><div class="ttdoc">Initializer for mmwlan_boot_args.</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l00760">mmwlan.h:760</a></div></div>
|
|
<div class="ttc" id="agroup__MMWLAN_html_ga0039072000d47e5c3712686bf1e43086"><div class="ttname"><a href="group__MMWLAN.html#ga0039072000d47e5c3712686bf1e43086">mmwlan_status</a></div><div class="ttdeci">mmwlan_status</div><div class="ttdoc">Enumeration of status return codes.</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l00049">mmwlan.h:50</a></div></div>
|
|
<div class="ttc" id="astructmmwlan__boot__args_html"><div class="ttname"><a href="structmmwlan__boot__args.html">mmwlan_boot_args</a></div><div class="ttdoc">Arguments data structure for mmwlan_boot().</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l00749">mmwlan.h:750</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l00749">749</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmwlan_8h_source.html">mmwlan.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:ad1b87292b086d2c5338c47d78b6b3b24"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__boot__args.html#ad1b87292b086d2c5338c47d78b6b3b24">reserved</a></td></tr>
|
|
<tr class="memdesc:ad1b87292b086d2c5338c47d78b6b3b24"><td class="mdescLeft"> </td><td class="mdescRight">Note this field should not be used and will be removed in future. <a href="structmmwlan__boot__args.html#ad1b87292b086d2c5338c47d78b6b3b24">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1b87292b086d2c5338c47d78b6b3b24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="ad1b87292b086d2c5338c47d78b6b3b24" name="ad1b87292b086d2c5338c47d78b6b3b24"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1b87292b086d2c5338c47d78b6b3b24">◆ </a></span>reserved</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t mmwlan_boot_args::reserved</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Note this field should not be used and will be removed in future. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l00752">752</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmwlan_8h_source.html">mmwlan.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="structmmwlan__boot__args.html">mmwlan_boot_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|