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/ping_8c.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

437 lines
30 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: ping.c File 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('ping_8c.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="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ping.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Simple ping demonstration. </p>
<dl class="section note"><dt>Note</dt><dd>It is assumed that you have followed the steps in the <a class="el" href="GETTING_STARTED.html">Getting Started</a> guide and are therefore familiar with how to build, flash, and monitor an application using the MM-IoT-SDK framework.</dd></dl>
<p>This file demonstrates how to ping a target using the Morse Micro WLAN API.</p>
<p >See <a class="el" href="mm__app__common_8h.html#APP_COMMON_API">Application helper routines for Wireless LAN interface</a> for details of WLAN and IP stack configuration. Additional configuration options for this application can be found in the config.hjson file. </p>
<p class="definition">Definition in file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div><div class="textblock"><code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;mmhal.h&quot;</code><br />
<code>#include &quot;mmosal.h&quot;</code><br />
<code>#include &quot;mmwlan.h&quot;</code><br />
<code>#include &quot;mmconfig.h&quot;</code><br />
<code>#include &quot;mmping.h&quot;</code><br />
<code>#include &quot;mmipal.h&quot;</code><br />
<code>#include &quot;mm_app_common.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ping.c:</div>
<div class="dyncontent">
<div class="center"><img src="ping_8c__incl.png" border="0" usemap="#aping_8c" alt=""/></div>
<map name="aping_8c" id="aping_8c">
<area shape="rect" title="Simple ping demonstration." alt="" coords="585,5,646,32"/>
<area shape="rect" title=" " alt="" coords="5,453,76,480"/>
<area shape="rect" href="mmhal_8h_source.html" title=" " alt="" coords="873,80,953,107"/>
<area shape="rect" href="mmosal_8h_source.html" title=" " alt="" coords="173,379,260,405"/>
<area shape="rect" href="mmwlan_8h_source.html" title=" " alt="" coords="258,229,349,256"/>
<area shape="rect" href="mmconfig_8h_source.html" title=" " alt="" coords="1113,304,1211,331"/>
<area shape="rect" href="mmping_8h_source.html" title=" " alt="" coords="735,379,823,405"/>
<area shape="rect" href="mmipal_8h_source.html" title=" " alt="" coords="576,379,660,405"/>
<area shape="rect" title=" " alt="" coords="1121,80,1275,107"/>
<area shape="rect" title=" " alt="" coords="497,453,579,480"/>
<area shape="rect" title=" " alt="" coords="898,379,973,405"/>
<area shape="rect" title=" " alt="" coords="744,453,815,480"/>
<area shape="rect" title=" " alt="" coords="881,229,945,256"/>
<area shape="rect" href="mmhal__flash_8h_source.html" title=" " alt="" coords="969,304,1088,331"/>
<area shape="rect" href="mmhal__wlan_8h_source.html" title=" " alt="" coords="733,155,852,181"/>
<area shape="rect" href="mmpkt_8h_source.html" title=" " alt="" coords="475,304,556,331"/>
<area shape="rect" title=" " alt="" coords="306,453,373,480"/>
<area shape="rect" title=" " alt="" coords="100,453,171,480"/>
<area shape="rect" title=" " alt="" coords="195,453,281,480"/>
<area shape="rect" title=" " alt="" coords="274,304,349,331"/>
</map>
</div>
</div>
<p><a href="ping_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0c1e71852ac798f73e914991b3e70f64"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#a0c1e71852ac798f73e914991b3e70f64">PING_COUNT</a>&#160;&#160;&#160;10</td></tr>
<tr class="memdesc:a0c1e71852ac798f73e914991b3e70f64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of ping requests to send. <a href="ping_8c.html#a0c1e71852ac798f73e914991b3e70f64">More...</a><br /></td></tr>
<tr class="separator:a0c1e71852ac798f73e914991b3e70f64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae49a47b7be864d302fa11ad0b3b9589"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#aae49a47b7be864d302fa11ad0b3b9589">PING_DATA_SIZE</a>&#160;&#160;&#160;56</td></tr>
<tr class="memdesc:aae49a47b7be864d302fa11ad0b3b9589"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the ping request data, excluding 8-byte ICMP header. <a href="ping_8c.html#aae49a47b7be864d302fa11ad0b3b9589">More...</a><br /></td></tr>
<tr class="separator:aae49a47b7be864d302fa11ad0b3b9589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7e73448526543d4ed006bba737609de"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#aa7e73448526543d4ed006bba737609de">PING_INTERVAL_MS</a>&#160;&#160;&#160;1000</td></tr>
<tr class="memdesc:aa7e73448526543d4ed006bba737609de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interval between successive ping requests. <a href="ping_8c.html#aa7e73448526543d4ed006bba737609de">More...</a><br /></td></tr>
<tr class="separator:aa7e73448526543d4ed006bba737609de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa74a8e27191a3077ea4cf00ea7507962"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#aa74a8e27191a3077ea4cf00ea7507962">POST_PING_DELAY_MS</a>&#160;&#160;&#160;10000</td></tr>
<tr class="memdesc:aa74a8e27191a3077ea4cf00ea7507962"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delay in ms to wait before terminating connection on completion of ping. <a href="ping_8c.html#aa74a8e27191a3077ea4cf00ea7507962">More...</a><br /></td></tr>
<tr class="separator:aa74a8e27191a3077ea4cf00ea7507962"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4602c729fef5a16a7f3dcf974eeee14"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#ad4602c729fef5a16a7f3dcf974eeee14">UPDATE_INTERVAL_MS</a>&#160;&#160;&#160;(5000)</td></tr>
<tr class="memdesc:ad4602c729fef5a16a7f3dcf974eeee14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interval (in milliseconds) at which to provide updates when the receive count has not changed. <a href="ping_8c.html#ad4602c729fef5a16a7f3dcf974eeee14">More...</a><br /></td></tr>
<tr class="separator:ad4602c729fef5a16a7f3dcf974eeee14"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:af6267920b504273777e2451780e565af"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#af6267920b504273777e2451780e565af">debug_state</a> { <br />
&#160;&#160;<a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afa17e21038455993a59d0355198b35a29c">DEBUG_STATE_INIT</a> = 0x00
, <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afa363738676fccdeb6095a33b02d4a52a6">DEBUG_STATE_BOOTING_CHIP</a> = 0x01
, <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afae7a4fffac6ee911628ed5c64f041d8e6">DEBUG_STATE_CONNECTING</a> = 0x03
, <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afa4a6c9b049bc6a49d7ce94ecb1e5e7d9a">DEBUG_STATE_CONNECTED</a> = 0x02
, <br />
&#160;&#160;<a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afad9e54f003a9aa888c9fd376e1f84ee05">DEBUG_STATE_CONNECTED_IDLE</a> = 0x00
, <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afa5e29790468d825ea9f4d70f2199c0ca6">DEBUG_STATE_PINGING</a> = 0x02
, <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afaa070c9f4d8cf7cb39854912256b27001">DEBUG_STATE_PING_DONE</a> = 0x03
, <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afaaf1fb45647c16f709ccf8529658bda34">DEBUG_STATE_IDLE</a> = 0x01
, <br />
&#160;&#160;<a class="el" href="ping_8c.html#af6267920b504273777e2451780e565afad80fa7cbc3a54f74032429011ccaabcf">DEBUG_STATE_TERMINATING</a> = 0x00
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa17e21038455993a59d0355198b35a29c">DEBUG_STATE_INIT</a> = 0x00
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afae7a4fffac6ee911628ed5c64f041d8e6">DEBUG_STATE_CONNECTING</a> = 0x01
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa4a6c9b049bc6a49d7ce94ecb1e5e7d9a">DEBUG_STATE_CONNECTED</a> = 0x03
, <br />
&#160;&#160;<a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa33d21045980648d539b9034e1640e38c">DEBUG_STATE_PINGING_0</a> = 0x02
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa3adbaca7b3bbb8e759ef13e7f2627dc1">DEBUG_STATE_PING_0_DONE</a> = 0x00
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa74e1358276efdac8a4e9d796ceaf91a6">DEBUG_STATE_WNM_SLEEP</a> = 0x01
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afacfae7ca8592a1ed118c58b376206091b">DEBUG_STATE_EXITING_WNM_SLEEP</a> = 0x03
, <br />
&#160;&#160;<a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa3ace72039c2656924b8954a9d376e979">DEBUG_STATE_WNM_SLEEP_DONE</a> = 0x02
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa7db3553ade9f174ae10cdd6925388c7c">DEBUG_STATE_PINGING_1</a> = 0x00
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa4a6f38a91ae76ba70c95a8386993bce2">DEBUG_STATE_PING_1_DONE</a> = 0x01
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa33c00846c8ced172342be9d562f0c900">DEBUG_STATE_WNM_SLEEP_POWER_DOWN</a> = 0x03
, <br />
&#160;&#160;<a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afa74d03c28fa98633032695822ff1b8c95">DEBUG_STATE_EXITING_WNM_SLEEP_POWER_DOWN</a> = 0x02
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afaa2f0bd3ea57c94cd206b6b5b2250b178">DEBUG_STATE_WNM_SLEEP_POWER_DOWN_DONE</a> = 0x00
, <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565afad80fa7cbc3a54f74032429011ccaabcf">DEBUG_STATE_TERMINATING</a> = 0x01
<br />
}</td></tr>
<tr class="memdesc:af6267920b504273777e2451780e565af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of debug states that will be reflected on debug pins. <a href="ping_8c.html#af6267920b504273777e2451780e565af">More...</a><br /></td></tr>
<tr class="separator:af6267920b504273777e2451780e565af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a8a7d25ccf1d8c01f542f342c48dee069"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#a8a7d25ccf1d8c01f542f342c48dee069">set_debug_state</a> (enum <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565af">debug_state</a> state)</td></tr>
<tr class="memdesc:a8a7d25ccf1d8c01f542f342c48dee069"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform necessary operation (i.e., setting GPIO pins) upon entering the given debug state. <a href="ping_8c.html#a8a7d25ccf1d8c01f542f342c48dee069">More...</a><br /></td></tr>
<tr class="separator:a8a7d25ccf1d8c01f542f342c48dee069"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add3190cf715f513666f4be42874d91e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ping_8c.html#add3190cf715f513666f4be42874d91e2">app_init</a> (void)</td></tr>
<tr class="memdesc:add3190cf715f513666f4be42874d91e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main entry point to the application. <a href="ping_8c.html#add3190cf715f513666f4be42874d91e2">More...</a><br /></td></tr>
<tr class="separator:add3190cf715f513666f4be42874d91e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a0c1e71852ac798f73e914991b3e70f64" name="a0c1e71852ac798f73e914991b3e70f64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c1e71852ac798f73e914991b3e70f64">&#9670;&nbsp;</a></span>PING_COUNT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PING_COUNT&#160;&#160;&#160;10</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of ping requests to send. </p>
<p >Set to 0 to continue indefinitely. </p>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00035">35</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
<a id="aae49a47b7be864d302fa11ad0b3b9589" name="aae49a47b7be864d302fa11ad0b3b9589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae49a47b7be864d302fa11ad0b3b9589">&#9670;&nbsp;</a></span>PING_DATA_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PING_DATA_SIZE&#160;&#160;&#160;56</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the ping request data, excluding 8-byte ICMP header. </p>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00039">39</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
<a id="aa7e73448526543d4ed006bba737609de" name="aa7e73448526543d4ed006bba737609de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7e73448526543d4ed006bba737609de">&#9670;&nbsp;</a></span>PING_INTERVAL_MS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PING_INTERVAL_MS&#160;&#160;&#160;1000</td>
</tr>
</table>
</div><div class="memdoc">
<p>Interval between successive ping requests. </p>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00043">43</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
<a id="aa74a8e27191a3077ea4cf00ea7507962" name="aa74a8e27191a3077ea4cf00ea7507962"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa74a8e27191a3077ea4cf00ea7507962">&#9670;&nbsp;</a></span>POST_PING_DELAY_MS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POST_PING_DELAY_MS&#160;&#160;&#160;10000</td>
</tr>
</table>
</div><div class="memdoc">
<p>Delay in ms to wait before terminating connection on completion of ping. </p>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00047">47</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
<a id="ad4602c729fef5a16a7f3dcf974eeee14" name="ad4602c729fef5a16a7f3dcf974eeee14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4602c729fef5a16a7f3dcf974eeee14">&#9670;&nbsp;</a></span>UPDATE_INTERVAL_MS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UPDATE_INTERVAL_MS&#160;&#160;&#160;(5000)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Interval (in milliseconds) at which to provide updates when the receive count has not changed. </p>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00052">52</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="af6267920b504273777e2451780e565af" name="af6267920b504273777e2451780e565af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6267920b504273777e2451780e565af">&#9670;&nbsp;</a></span>debug_state</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565af">debug_state</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration of debug states that will be reflected on debug pins. </p>
<p >Note that due to limited availability of pins, the values are mapped to 2-bit codes and so are not unique. The code sequence has been chosen to be gray code like in that only one bit changes at a time, but it does not return to zero so a zero code can be used to identify the first state. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa17e21038455993a59d0355198b35a29c" name="af6267920b504273777e2451780e565afa17e21038455993a59d0355198b35a29c"></a>DEBUG_STATE_INIT&#160;</td><td class="fielddoc"><p >Initial state at startup. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa363738676fccdeb6095a33b02d4a52a6" name="af6267920b504273777e2451780e565afa363738676fccdeb6095a33b02d4a52a6"></a>DEBUG_STATE_BOOTING_CHIP&#160;</td><td class="fielddoc"><p >Indicates that we are booting the MM chip (note that this will also include the host MCU startup time. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afae7a4fffac6ee911628ed5c64f041d8e6" name="af6267920b504273777e2451780e565afae7a4fffac6ee911628ed5c64f041d8e6"></a>DEBUG_STATE_CONNECTING&#160;</td><td class="fielddoc"><p >Indicates we are connecting to the AP. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa4a6c9b049bc6a49d7ce94ecb1e5e7d9a" name="af6267920b504273777e2451780e565afa4a6c9b049bc6a49d7ce94ecb1e5e7d9a"></a>DEBUG_STATE_CONNECTED&#160;</td><td class="fielddoc"><p >Indicates we are connected to the AP. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afad9e54f003a9aa888c9fd376e1f84ee05" name="af6267920b504273777e2451780e565afad9e54f003a9aa888c9fd376e1f84ee05"></a>DEBUG_STATE_CONNECTED_IDLE&#160;</td><td class="fielddoc"><p >Indicates that we have connected to the AP, but have not started the ping yet. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa5e29790468d825ea9f4d70f2199c0ca6" name="af6267920b504273777e2451780e565afa5e29790468d825ea9f4d70f2199c0ca6"></a>DEBUG_STATE_PINGING&#160;</td><td class="fielddoc"><p >Indicates that the ping is in progress. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afaa070c9f4d8cf7cb39854912256b27001" name="af6267920b504273777e2451780e565afaa070c9f4d8cf7cb39854912256b27001"></a>DEBUG_STATE_PING_DONE&#160;</td><td class="fielddoc"><p >Indicates that the ping has completed. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afaaf1fb45647c16f709ccf8529658bda34" name="af6267920b504273777e2451780e565afaaf1fb45647c16f709ccf8529658bda34"></a>DEBUG_STATE_IDLE&#160;</td><td class="fielddoc"><p >Indicates that we are idling with WLAN still on. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afad80fa7cbc3a54f74032429011ccaabcf" name="af6267920b504273777e2451780e565afad80fa7cbc3a54f74032429011ccaabcf"></a>DEBUG_STATE_TERMINATING&#160;</td><td class="fielddoc"><p >Indicates that we are disconnecting from the AP. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa17e21038455993a59d0355198b35a29c" name="af6267920b504273777e2451780e565afa17e21038455993a59d0355198b35a29c"></a>DEBUG_STATE_INIT&#160;</td><td class="fielddoc"><p >Initial state at startup. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afae7a4fffac6ee911628ed5c64f041d8e6" name="af6267920b504273777e2451780e565afae7a4fffac6ee911628ed5c64f041d8e6"></a>DEBUG_STATE_CONNECTING&#160;</td><td class="fielddoc"><p >Indicates we are connecting to the AP. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa4a6c9b049bc6a49d7ce94ecb1e5e7d9a" name="af6267920b504273777e2451780e565afa4a6c9b049bc6a49d7ce94ecb1e5e7d9a"></a>DEBUG_STATE_CONNECTED&#160;</td><td class="fielddoc"><p >Indicates we are connected to the AP. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa33d21045980648d539b9034e1640e38c" name="af6267920b504273777e2451780e565afa33d21045980648d539b9034e1640e38c"></a>DEBUG_STATE_PINGING_0&#160;</td><td class="fielddoc"><p >Indicates that the ping is in progress. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa3adbaca7b3bbb8e759ef13e7f2627dc1" name="af6267920b504273777e2451780e565afa3adbaca7b3bbb8e759ef13e7f2627dc1"></a>DEBUG_STATE_PING_0_DONE&#160;</td><td class="fielddoc"><p >Indicates that the ping has completed. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa74e1358276efdac8a4e9d796ceaf91a6" name="af6267920b504273777e2451780e565afa74e1358276efdac8a4e9d796ceaf91a6"></a>DEBUG_STATE_WNM_SLEEP&#160;</td><td class="fielddoc"><p >Indicates that WNM sleep is in progress. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afacfae7ca8592a1ed118c58b376206091b" name="af6267920b504273777e2451780e565afacfae7ca8592a1ed118c58b376206091b"></a>DEBUG_STATE_EXITING_WNM_SLEEP&#160;</td><td class="fielddoc"><p >Indicates that we are exiting WNM sleep. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa3ace72039c2656924b8954a9d376e979" name="af6267920b504273777e2451780e565afa3ace72039c2656924b8954a9d376e979"></a>DEBUG_STATE_WNM_SLEEP_DONE&#160;</td><td class="fielddoc"><p >Indicates that WNM sleep has completed. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa7db3553ade9f174ae10cdd6925388c7c" name="af6267920b504273777e2451780e565afa7db3553ade9f174ae10cdd6925388c7c"></a>DEBUG_STATE_PINGING_1&#160;</td><td class="fielddoc"><p >Indicates that the ping is in progress. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa4a6f38a91ae76ba70c95a8386993bce2" name="af6267920b504273777e2451780e565afa4a6f38a91ae76ba70c95a8386993bce2"></a>DEBUG_STATE_PING_1_DONE&#160;</td><td class="fielddoc"><p >Indicates that the ping has completed. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa33c00846c8ced172342be9d562f0c900" name="af6267920b504273777e2451780e565afa33c00846c8ced172342be9d562f0c900"></a>DEBUG_STATE_WNM_SLEEP_POWER_DOWN&#160;</td><td class="fielddoc"><p >Indicates that WNM sleep is in progress with chip powered down. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afa74d03c28fa98633032695822ff1b8c95" name="af6267920b504273777e2451780e565afa74d03c28fa98633032695822ff1b8c95"></a>DEBUG_STATE_EXITING_WNM_SLEEP_POWER_DOWN&#160;</td><td class="fielddoc"><p >Indicates that we are exiting WNM sleep with chip powered down. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afaa2f0bd3ea57c94cd206b6b5b2250b178" name="af6267920b504273777e2451780e565afaa2f0bd3ea57c94cd206b6b5b2250b178"></a>DEBUG_STATE_WNM_SLEEP_POWER_DOWN_DONE&#160;</td><td class="fielddoc"><p >Indicates that WNM sleep with chip powered down has completed. </p>
</td></tr>
<tr><td class="fieldname"><a id="af6267920b504273777e2451780e565afad80fa7cbc3a54f74032429011ccaabcf" name="af6267920b504273777e2451780e565afad80fa7cbc3a54f74032429011ccaabcf"></a>DEBUG_STATE_TERMINATING&#160;</td><td class="fielddoc"><p >Indicates that we are disconnecting from the AP. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00061">61</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="add3190cf715f513666f4be42874d91e2" name="add3190cf715f513666f4be42874d91e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add3190cf715f513666f4be42874d91e2">&#9670;&nbsp;</a></span>app_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void app_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main entry point to the application. </p>
<p >This will be invoked in a thread once operating system and hardware initialization has completed. It may return, but it does not have to. </p>
<p >Executes the ping.</p>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00098">98</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
<a id="a8a7d25ccf1d8c01f542f342c48dee069" name="a8a7d25ccf1d8c01f542f342c48dee069"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a7d25ccf1d8c01f542f342c48dee069">&#9670;&nbsp;</a></span>set_debug_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void set_debug_state </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="ping_8c.html#af6267920b504273777e2451780e565af">debug_state</a>&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform necessary operation (i.e., setting GPIO pins) upon entering the given debug state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>The debug state to enter. See <a class="el" href="wnm__sleep_8c.html#af6267920b504273777e2451780e565af">debug_state</a>. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="ping_8c_source.html#l00089">89</a> of file <a class="el" href="ping_8c_source.html">ping.c</a>.</p>
</div>
</div>
</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="dir_91b8f418cff946e8d8b598a9068417a8.html">examples</a></li><li class="navelem"><a class="el" href="dir_5df5ab63536b30da6fda8986bc658055.html">ping</a></li><li class="navelem"><a class="el" href="dir_cc6dc717dc3348df1b12dc28a051aa79.html">src</a></li><li class="navelem"><a class="el" href="ping_8c.html">ping.c</a></li>
<li class="footer">Copyright 2021 Morse Micro </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink