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

424 lines
21 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: Time</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('group__MMOSAL__TIME.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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Time<div class="ingroups"><a class="el" href="group__MMOSAL.html">Morse Micro Operating System Abstraction Layer (mmosal) API</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p >Provides support for reading the system time. </p>
<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:ga0945c6dc143fad47ee6798192e34cbbd"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__TIME.html#ga0945c6dc143fad47ee6798192e34cbbd">mmosal_get_time_ms</a> (void)</td></tr>
<tr class="memdesc:ga0945c6dc143fad47ee6798192e34cbbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the system time in milliseconds. <a href="group__MMOSAL__TIME.html#ga0945c6dc143fad47ee6798192e34cbbd">More...</a><br /></td></tr>
<tr class="separator:ga0945c6dc143fad47ee6798192e34cbbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b35358b376583c3e98bca9970fe2d72"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__TIME.html#ga8b35358b376583c3e98bca9970fe2d72">mmosal_get_time_ticks</a> (void)</td></tr>
<tr class="memdesc:ga8b35358b376583c3e98bca9970fe2d72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the system time in ticks. <a href="group__MMOSAL__TIME.html#ga8b35358b376583c3e98bca9970fe2d72">More...</a><br /></td></tr>
<tr class="separator:ga8b35358b376583c3e98bca9970fe2d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5479bb8e434378ac29a412871870101f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__TIME.html#ga5479bb8e434378ac29a412871870101f">mmosal_ticks_per_second</a> (void)</td></tr>
<tr class="memdesc:ga5479bb8e434378ac29a412871870101f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of ticks in a second. <a href="group__MMOSAL__TIME.html#ga5479bb8e434378ac29a412871870101f">More...</a><br /></td></tr>
<tr class="separator:ga5479bb8e434378ac29a412871870101f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadb48e7454d435148c1d0d96da14934fc"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__TIME.html#gadb48e7454d435148c1d0d96da14934fc">mmosal_time_lt</a> (uint32_t a, uint32_t b)</td></tr>
<tr class="memdesc:gadb48e7454d435148c1d0d96da14934fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if time a is less than time b, taking into account wrapping. <a href="group__MMOSAL__TIME.html#gadb48e7454d435148c1d0d96da14934fc">More...</a><br /></td></tr>
<tr class="separator:gadb48e7454d435148c1d0d96da14934fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga645840d0c5f3c2a0da9fe0cd38dcb689"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__TIME.html#ga645840d0c5f3c2a0da9fe0cd38dcb689">mmosal_time_le</a> (uint32_t a, uint32_t b)</td></tr>
<tr class="memdesc:ga645840d0c5f3c2a0da9fe0cd38dcb689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if time a is less than or equal to time b, taking into account wrapping. <a href="group__MMOSAL__TIME.html#ga645840d0c5f3c2a0da9fe0cd38dcb689">More...</a><br /></td></tr>
<tr class="separator:ga645840d0c5f3c2a0da9fe0cd38dcb689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3614e83efa4571e6fcd1ae71784de75f"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__TIME.html#ga3614e83efa4571e6fcd1ae71784de75f">mmosal_time_max</a> (uint32_t a, uint32_t b)</td></tr>
<tr class="memdesc:ga3614e83efa4571e6fcd1ae71784de75f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given two times, return the one that is greatest (taking into account wrapping). <a href="group__MMOSAL__TIME.html#ga3614e83efa4571e6fcd1ae71784de75f">More...</a><br /></td></tr>
<tr class="separator:ga3614e83efa4571e6fcd1ae71784de75f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac05f91ad72e3d78c85e3c61756fd4f0f"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__TIME.html#gac05f91ad72e3d78c85e3c61756fd4f0f">mmosal_time_has_passed</a> (uint32_t t)</td></tr>
<tr class="memdesc:gac05f91ad72e3d78c85e3c61756fd4f0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the given time has already passed. <a href="group__MMOSAL__TIME.html#gac05f91ad72e3d78c85e3c61756fd4f0f">More...</a><br /></td></tr>
<tr class="separator:gac05f91ad72e3d78c85e3c61756fd4f0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga0945c6dc143fad47ee6798192e34cbbd" name="ga0945c6dc143fad47ee6798192e34cbbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0945c6dc143fad47ee6798192e34cbbd">&#9670;&nbsp;</a></span>mmosal_get_time_ms()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mmosal_get_time_ms </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the system time in milliseconds. </p>
<dl class="section return"><dt>Returns</dt><dd>the system time in milliseconds. </dd></dl>
<p class="definition">Definition at line <a class="el" href="mmosal__shim__bootloader_8c_source.html#l00121">121</a> of file <a class="el" href="mmosal__shim__bootloader_8c_source.html">mmosal_shim_bootloader.c</a>.</p>
</div>
</div>
<a id="ga8b35358b376583c3e98bca9970fe2d72" name="ga8b35358b376583c3e98bca9970fe2d72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b35358b376583c3e98bca9970fe2d72">&#9670;&nbsp;</a></span>mmosal_get_time_ticks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mmosal_get_time_ticks </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the system time in ticks. </p>
<dl class="section return"><dt>Returns</dt><dd>the system time in ticks. </dd></dl>
<p class="definition">Definition at line <a class="el" href="mmosal__shim__bootloader_8c_source.html#l00126">126</a> of file <a class="el" href="mmosal__shim__bootloader_8c_source.html">mmosal_shim_bootloader.c</a>.</p>
</div>
</div>
<a id="ga5479bb8e434378ac29a412871870101f" name="ga5479bb8e434378ac29a412871870101f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5479bb8e434378ac29a412871870101f">&#9670;&nbsp;</a></span>mmosal_ticks_per_second()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mmosal_ticks_per_second </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of ticks in a second. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of ticks in a second. </dd></dl>
</div>
</div>
<a id="gac05f91ad72e3d78c85e3c61756fd4f0f" name="gac05f91ad72e3d78c85e3c61756fd4f0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac05f91ad72e3d78c85e3c61756fd4f0f">&#9670;&nbsp;</a></span>mmosal_time_has_passed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mmosal_time_has_passed </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the given time has already passed. </p>
<p >i.e the system time is greater than the given time.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td>The time to check.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the given time has passed, else <code>false</code>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00725">725</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
</div>
</div>
<a id="ga645840d0c5f3c2a0da9fe0cd38dcb689" name="ga645840d0c5f3c2a0da9fe0cd38dcb689"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga645840d0c5f3c2a0da9fe0cd38dcb689">&#9670;&nbsp;</a></span>mmosal_time_le()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mmosal_time_le </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if time a is less than or equal to time b, taking into account wrapping. </p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">a </th><th class="markdownTableHeadNone">b </th><th class="markdownTableHeadNone">return </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">true </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">true </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">false </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><code>0xffffffff</code> </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">true </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone"><code>0xffffffff</code> </td><td class="markdownTableBodyNone">false </td></tr>
</table>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>time a </td></tr>
<tr><td class="paramname">b</td><td>time b</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if time a &lt;= time b. </dd></dl>
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00685">685</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
</div>
</div>
<a id="gadb48e7454d435148c1d0d96da14934fc" name="gadb48e7454d435148c1d0d96da14934fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadb48e7454d435148c1d0d96da14934fc">&#9670;&nbsp;</a></span>mmosal_time_lt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mmosal_time_lt </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if time a is less than time b, taking into account wrapping. </p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">a </th><th class="markdownTableHeadNone">b </th><th class="markdownTableHeadNone">return </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">false </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">true </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">false </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><code>0xffffffff</code> </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">true </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone"><code>0xffffffff</code> </td><td class="markdownTableBodyNone">false </td></tr>
</table>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>time a </td></tr>
<tr><td class="paramname">b</td><td>time b</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if time a &lt; time b. </dd></dl>
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00662">662</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
</div>
</div>
<a id="ga3614e83efa4571e6fcd1ae71784de75f" name="ga3614e83efa4571e6fcd1ae71784de75f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3614e83efa4571e6fcd1ae71784de75f">&#9670;&nbsp;</a></span>mmosal_time_max()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t mmosal_time_max </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given two times, return the one that is greatest (taking into account wrapping). </p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">a </th><th class="markdownTableHeadNone">b </th><th class="markdownTableHeadNone">return </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">0 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">1 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">1 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><code>0xffffffff</code> </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">0 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone"><code>0xffffffff</code> </td><td class="markdownTableBodyNone">0 </td></tr>
</table>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>time a </td></tr>
<tr><td class="paramname">b</td><td>time b</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a if time a &gt;= time b else b. </dd></dl>
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00706">706</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</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="footer">Copyright 2021 Morse Micro </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink