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.
292 lines
18 KiB
HTML
292 lines
18 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: mmipal_init_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('structmmipal__init__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">mmipal_init_args Struct Reference<div class="ingroups"><a class="el" href="group__MMIPAL.html">Morse Micro IP Stack Abstraction Layer (MMIPAL) 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 >Initialize arguments structure. </p>
|
|
<p >This should be initialized using <code>MMIPAL_INIT_ARGS_DEFAULT</code>. For example:</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structmmipal__init__args.html">mmipal_init_args</a> args = <a class="code hl_define" href="group__MMIPAL.html#ga58358044d2adb0b796443b3987c455ec">MMIPAL_INIT_ARGS_DEFAULT</a>;</div>
|
|
<div class="ttc" id="agroup__MMIPAL_html_ga58358044d2adb0b796443b3987c455ec"><div class="ttname"><a href="group__MMIPAL.html#ga58358044d2adb0b796443b3987c455ec">MMIPAL_INIT_ARGS_DEFAULT</a></div><div class="ttdeci">#define MMIPAL_INIT_ARGS_DEFAULT</div><div class="ttdoc">Default values for mmipal_init_args.</div><div class="ttdef"><b>Definition:</b> <a href="mmipal_8h_source.html#l00173">mmipal.h:173</a></div></div>
|
|
<div class="ttc" id="astructmmipal__init__args_html"><div class="ttname"><a href="structmmipal__init__args.html">mmipal_init_args</a></div><div class="ttdoc">Initialize arguments structure.</div><div class="ttdef"><b>Definition:</b> <a href="mmipal_8h_source.html#l00148">mmipal.h:149</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00148">148</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmipal_8h_source.html">mmipal.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:aa8ea6f4bfc27973166408ca9022c9f1b"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__MMIPAL.html#gafc9d0260b07ca329e4fc2393a769c3cd">mmipal_addr_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#aa8ea6f4bfc27973166408ca9022c9f1b">mode</a></td></tr>
|
|
<tr class="memdesc:aa8ea6f4bfc27973166408ca9022c9f1b"><td class="mdescLeft"> </td><td class="mdescRight">IP address allocation mode to use. <a href="structmmipal__init__args.html#aa8ea6f4bfc27973166408ca9022c9f1b">More...</a><br /></td></tr>
|
|
<tr class="separator:aa8ea6f4bfc27973166408ca9022c9f1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0a945121c03bea2d9d68274a8cd4821"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#af0a945121c03bea2d9d68274a8cd4821">ip_addr</a></td></tr>
|
|
<tr class="memdesc:af0a945121c03bea2d9d68274a8cd4821"><td class="mdescLeft"> </td><td class="mdescRight">IP address to use (if <code>mode</code> is <code>MMIPAL_STATIC</code>). <a href="structmmipal__init__args.html#af0a945121c03bea2d9d68274a8cd4821">More...</a><br /></td></tr>
|
|
<tr class="separator:af0a945121c03bea2d9d68274a8cd4821"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb4e68a901669a22eb9971a492db1fae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#adb4e68a901669a22eb9971a492db1fae">netmask</a></td></tr>
|
|
<tr class="memdesc:adb4e68a901669a22eb9971a492db1fae"><td class="mdescLeft"> </td><td class="mdescRight">Netmask to use (if <code>mode</code> is <code>MMIPAL_STATIC</code>). <a href="structmmipal__init__args.html#adb4e68a901669a22eb9971a492db1fae">More...</a><br /></td></tr>
|
|
<tr class="separator:adb4e68a901669a22eb9971a492db1fae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c47221066842695ba9aa83beab4c6b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#a9c47221066842695ba9aa83beab4c6b4">gateway_addr</a></td></tr>
|
|
<tr class="memdesc:a9c47221066842695ba9aa83beab4c6b4"><td class="mdescLeft"> </td><td class="mdescRight">Gateway IP address to use (if <code>mode</code> is <code>MMIPAL_STATIC</code>). <a href="structmmipal__init__args.html#a9c47221066842695ba9aa83beab4c6b4">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c47221066842695ba9aa83beab4c6b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a039c9ce0adac0886490ab31f47802620"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__MMIPAL.html#ga766bcb2fa9bef02bbc17203399c84f55">mmipal_ip6_addr_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#a039c9ce0adac0886490ab31f47802620">ip6_mode</a></td></tr>
|
|
<tr class="memdesc:a039c9ce0adac0886490ab31f47802620"><td class="mdescLeft"> </td><td class="mdescRight">IPv6 address allocation mode to use. <a href="structmmipal__init__args.html#a039c9ce0adac0886490ab31f47802620">More...</a><br /></td></tr>
|
|
<tr class="separator:a039c9ce0adac0886490ab31f47802620"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1eea15de7ad7c2c4bdbc13cc50e37b60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#a1eea15de7ad7c2c4bdbc13cc50e37b60">ip6_addr</a></td></tr>
|
|
<tr class="memdesc:a1eea15de7ad7c2c4bdbc13cc50e37b60"><td class="mdescLeft"> </td><td class="mdescRight">IPv6 address to use (if <code>ip6_mode</code> is <code>MMIPAL_IP6_STATIC</code>). <a href="structmmipal__init__args.html#a1eea15de7ad7c2c4bdbc13cc50e37b60">More...</a><br /></td></tr>
|
|
<tr class="separator:a1eea15de7ad7c2c4bdbc13cc50e37b60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a300bfe8f55bd14330a8c2ea17df8371e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#a300bfe8f55bd14330a8c2ea17df8371e">offload_arp_response</a></td></tr>
|
|
<tr class="memdesc:a300bfe8f55bd14330a8c2ea17df8371e"><td class="mdescLeft"> </td><td class="mdescRight">Flag requesting ARP response offload feature. <a href="structmmipal__init__args.html#a300bfe8f55bd14330a8c2ea17df8371e">More...</a><br /></td></tr>
|
|
<tr class="separator:a300bfe8f55bd14330a8c2ea17df8371e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1be9ccde36fcf6f00f1295b13d2868d3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmipal__init__args.html#a1be9ccde36fcf6f00f1295b13d2868d3">offload_arp_refresh_s</a></td></tr>
|
|
<tr class="memdesc:a1be9ccde36fcf6f00f1295b13d2868d3"><td class="mdescLeft"> </td><td class="mdescRight">ARP refresh offload interval in seconds. <a href="structmmipal__init__args.html#a1be9ccde36fcf6f00f1295b13d2868d3">More...</a><br /></td></tr>
|
|
<tr class="separator:a1be9ccde36fcf6f00f1295b13d2868d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a9c47221066842695ba9aa83beab4c6b4" name="a9c47221066842695ba9aa83beab4c6b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c47221066842695ba9aa83beab4c6b4">◆ </a></span>gateway_addr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> mmipal_init_args::gateway_addr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gateway IP address to use (if <code>mode</code> is <code>MMIPAL_STATIC</code>). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00157">157</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1eea15de7ad7c2c4bdbc13cc50e37b60" name="a1eea15de7ad7c2c4bdbc13cc50e37b60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1eea15de7ad7c2c4bdbc13cc50e37b60">◆ </a></span>ip6_addr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> mmipal_init_args::ip6_addr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IPv6 address to use (if <code>ip6_mode</code> is <code>MMIPAL_IP6_STATIC</code>). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00162">162</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a039c9ce0adac0886490ab31f47802620" name="a039c9ce0adac0886490ab31f47802620"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a039c9ce0adac0886490ab31f47802620">◆ </a></span>ip6_mode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMIPAL.html#ga766bcb2fa9bef02bbc17203399c84f55">mmipal_ip6_addr_mode</a> mmipal_init_args::ip6_mode</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IPv6 address allocation mode to use. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00160">160</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af0a945121c03bea2d9d68274a8cd4821" name="af0a945121c03bea2d9d68274a8cd4821"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0a945121c03bea2d9d68274a8cd4821">◆ </a></span>ip_addr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> mmipal_init_args::ip_addr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IP address to use (if <code>mode</code> is <code>MMIPAL_STATIC</code>). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00153">153</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa8ea6f4bfc27973166408ca9022c9f1b" name="aa8ea6f4bfc27973166408ca9022c9f1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa8ea6f4bfc27973166408ca9022c9f1b">◆ </a></span>mode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMIPAL.html#gafc9d0260b07ca329e4fc2393a769c3cd">mmipal_addr_mode</a> mmipal_init_args::mode</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IP address allocation mode to use. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00151">151</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb4e68a901669a22eb9971a492db1fae" name="adb4e68a901669a22eb9971a492db1fae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb4e68a901669a22eb9971a492db1fae">◆ </a></span>netmask</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__MMIPAL.html#gad7cd05b2ca37d79ebbda48b5f2a59498">mmipal_ip_addr_t</a> mmipal_init_args::netmask</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Netmask to use (if <code>mode</code> is <code>MMIPAL_STATIC</code>). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00155">155</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1be9ccde36fcf6f00f1295b13d2868d3" name="a1be9ccde36fcf6f00f1295b13d2868d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1be9ccde36fcf6f00f1295b13d2868d3">◆ </a></span>offload_arp_refresh_s</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmipal_init_args::offload_arp_refresh_s</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ARP refresh offload interval in seconds. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00166">166</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a300bfe8f55bd14330a8c2ea17df8371e" name="a300bfe8f55bd14330a8c2ea17df8371e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a300bfe8f55bd14330a8c2ea17df8371e">◆ </a></span>offload_arp_response</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool mmipal_init_args::offload_arp_response</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Flag requesting ARP response offload feature. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmipal_8h_source.html#l00164">164</a> of file <a class="el" href="mmipal_8h_source.html">mmipal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmipal_8h_source.html">mmipal.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="structmmipal__init__args.html">mmipal_init_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|