web/docs/group__pico__aon__timer.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: pico_aon_timer</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('group__pico__aon__timer.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#func-members">Functions</a>  </div>
 107   <div class="headertitle"><div class="title">pico_aon_timer<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110
 111 <p>High Level "Always on Timer" Abstraction.
 112 <a href="#details">More...</a></p>
 113 <table class="memberdecls">
 114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 115 Functions</h2></td></tr>
 116 <tr class="memitem:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memItemLeft" align="right" valign="top"><a id="ga32e4d69ae8c5b2048af84cf706b8b997" name="ga32e4d69ae8c5b2048af84cf706b8b997"></a>
 117 void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_start_with_timeofday</b> (void)</td></tr>
 118 <tr class="memdesc:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the result from the gettimeofday() function as the current time. <br /></td></tr>
 119 <tr class="separator:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 <tr class="memitem:ga937223c53432fc9b5fe5252c9712078a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga937223c53432fc9b5fe5252c9712078a">aon_timer_start</a> (const struct timespec *ts)</td></tr>
 121 <tr class="memdesc:ga937223c53432fc9b5fe5252c9712078a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the specified timespec as the current time.  <a href="group__pico__aon__timer.html#ga937223c53432fc9b5fe5252c9712078a">More...</a><br /></td></tr>
 122 <tr class="separator:ga937223c53432fc9b5fe5252c9712078a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 <tr class="memitem:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memItemLeft" align="right" valign="top"><a id="gaad98990deb5ce061e3cac6ef7cc69fc5" name="gaad98990deb5ce061e3cac6ef7cc69fc5"></a>
 124 void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_stop</b> (void)</td></tr>
 125 <tr class="memdesc:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the AON timer. <br /></td></tr>
 126 <tr class="separator:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:ga271d25359d58cd63ca24ec315dd72c4a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga271d25359d58cd63ca24ec315dd72c4a">aon_timer_set_time</a> (const struct timespec *ts)</td></tr>
 128 <tr class="memdesc:ga271d25359d58cd63ca24ec315dd72c4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the current time of the AON timer.  <a href="group__pico__aon__timer.html#ga271d25359d58cd63ca24ec315dd72c4a">More...</a><br /></td></tr>
 129 <tr class="separator:ga271d25359d58cd63ca24ec315dd72c4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="memitem:ga5e61345c450ef3aa217411104ae8f2e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga5e61345c450ef3aa217411104ae8f2e3">aon_timer_get_time</a> (struct timespec *ts)</td></tr>
 131 <tr class="memdesc:ga5e61345c450ef3aa217411104ae8f2e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time of the AON timer.  <a href="group__pico__aon__timer.html#ga5e61345c450ef3aa217411104ae8f2e3">More...</a><br /></td></tr>
 132 <tr class="separator:ga5e61345c450ef3aa217411104ae8f2e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga6e17d6adde0e3b25c70c04970116ccb8">aon_timer_get_resolution</a> (struct timespec *ts)</td></tr>
 134 <tr class="memdesc:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the resolution of the AON timer.  <a href="group__pico__aon__timer.html#ga6e17d6adde0e3b25c70c04970116ccb8">More...</a><br /></td></tr>
 135 <tr class="separator:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:ga39dab1da58c2f8178024b233e335d059"><td class="memItemLeft" align="right" valign="top">aon_timer_alarm_handler_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga39dab1da58c2f8178024b233e335d059">aon_timer_enable_alarm</a> (const struct timespec *ts, aon_timer_alarm_handler_t handler, bool wakeup_from_low_power)</td></tr>
 137 <tr class="memdesc:ga39dab1da58c2f8178024b233e335d059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable an AON timer alarm for a specifed time.  <a href="group__pico__aon__timer.html#ga39dab1da58c2f8178024b233e335d059">More...</a><br /></td></tr>
 138 <tr class="separator:ga39dab1da58c2f8178024b233e335d059"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="memItemLeft" align="right" valign="top"><a id="ga20cda0289aab2eb5fda914704a1fc2a7" name="ga20cda0289aab2eb5fda914704a1fc2a7"></a>
 140 void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_disable_alarm</b> (void)</td></tr>
 141 <tr class="memdesc:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the currently enabled AON timer alarm if any. <br /></td></tr>
 142 <tr class="separator:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:ga134ec8ae2a5f2a9b29b9bc4fb6c87493"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga134ec8ae2a5f2a9b29b9bc4fb6c87493">aon_timer_is_running</a> (void)</td></tr>
 144 <tr class="memdesc:ga134ec8ae2a5f2a9b29b9bc4fb6c87493"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the currently enabled AON timer alarm if any.  <a href="group__pico__aon__timer.html#ga134ec8ae2a5f2a9b29b9bc4fb6c87493">More...</a><br /></td></tr>
 145 <tr class="separator:ga134ec8ae2a5f2a9b29b9bc4fb6c87493"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 </table>
 147 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 148 <p >High Level "Always on Timer" Abstraction. </p>
 149 <p >This library uses the RTC on RP2040.   This library uses the RTC on RP2350.  </p>
 150 <h2 class="groupheader">Function Documentation</h2>
 151 <a id="ga39dab1da58c2f8178024b233e335d059" name="ga39dab1da58c2f8178024b233e335d059"></a>
 152 <h2 class="memtitle"><span class="permalink"><a href="#ga39dab1da58c2f8178024b233e335d059">&#9670;&nbsp;</a></span>aon_timer_enable_alarm()</h2>
 153
 154 <div class="memitem">
 155 <div class="memproto">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">aon_timer_alarm_handler_t aon_timer_enable_alarm </td>
 159           <td>(</td>
 160           <td class="paramtype">const struct timespec *&#160;</td>
 161           <td class="paramname"><em>ts</em>, </td>
 162         </tr>
 163         <tr>
 164           <td class="paramkey"></td>
 165           <td></td>
 166           <td class="paramtype">aon_timer_alarm_handler_t&#160;</td>
 167           <td class="paramname"><em>handler</em>, </td>
 168         </tr>
 169         <tr>
 170           <td class="paramkey"></td>
 171           <td></td>
 172           <td class="paramtype">bool&#160;</td>
 173           <td class="paramname"><em>wakeup_from_low_power</em>&#160;</td>
 174         </tr>
 175         <tr>
 176           <td></td>
 177           <td>)</td>
 178           <td></td><td></td>
 179         </tr>
 180       </table>
 181 </div><div class="memdoc">
 182
 183 <p>Enable an AON timer alarm for a specifed time. </p>
 184 <p >On RP2040 The alarm will not fire if it is in the past   On RP2040 The alarm will fire if it is in the past </p>
 185 <dl class="params"><dt>Parameters</dt><dd>
 186   <table class="params">
 187     <tr><td class="paramname">ts</td><td>the alarm time </td></tr>
 188     <tr><td class="paramname">handler</td><td>a callback to call when the timer fires (may be NULL for wakeup_from_low_power = true) </td></tr>
 189     <tr><td class="paramname">wakeup_from_low_power</td><td>true if the AON timer is to be used to wake up from a DORMANT state </td></tr>
 190   </table>
 191   </dd>
 192 </dl>
 193
 194 </div>
 195 </div>
 196 <a id="ga6e17d6adde0e3b25c70c04970116ccb8" name="ga6e17d6adde0e3b25c70c04970116ccb8"></a>
 197 <h2 class="memtitle"><span class="permalink"><a href="#ga6e17d6adde0e3b25c70c04970116ccb8">&#9670;&nbsp;</a></span>aon_timer_get_resolution()</h2>
 198
 199 <div class="memitem">
 200 <div class="memproto">
 201       <table class="memname">
 202         <tr>
 203           <td class="memname">void aon_timer_get_resolution </td>
 204           <td>(</td>
 205           <td class="paramtype">struct timespec *&#160;</td>
 206           <td class="paramname"><em>ts</em></td><td>)</td>
 207           <td></td>
 208         </tr>
 209       </table>
 210 </div><div class="memdoc">
 211
 212 <p>Get the resolution of the AON timer. </p>
 213 <dl class="params"><dt>Parameters</dt><dd>
 214   <table class="params">
 215     <tr><td class="paramname">ts</td><td>out value for the resolution of the AON timer </td></tr>
 216   </table>
 217   </dd>
 218 </dl>
 219
 220 </div>
 221 </div>
 222 <a id="ga5e61345c450ef3aa217411104ae8f2e3" name="ga5e61345c450ef3aa217411104ae8f2e3"></a>
 223 <h2 class="memtitle"><span class="permalink"><a href="#ga5e61345c450ef3aa217411104ae8f2e3">&#9670;&nbsp;</a></span>aon_timer_get_time()</h2>
 224
 225 <div class="memitem">
 226 <div class="memproto">
 227       <table class="memname">
 228         <tr>
 229           <td class="memname">void aon_timer_get_time </td>
 230           <td>(</td>
 231           <td class="paramtype">struct timespec *&#160;</td>
 232           <td class="paramname"><em>ts</em></td><td>)</td>
 233           <td></td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>Get the current time of the AON timer. </p>
 239 <dl class="params"><dt>Parameters</dt><dd>
 240   <table class="params">
 241     <tr><td class="paramname">ts</td><td>out value for the current time </td></tr>
 242   </table>
 243   </dd>
 244 </dl>
 245
 246 </div>
 247 </div>
 248 <a id="ga134ec8ae2a5f2a9b29b9bc4fb6c87493" name="ga134ec8ae2a5f2a9b29b9bc4fb6c87493"></a>
 249 <h2 class="memtitle"><span class="permalink"><a href="#ga134ec8ae2a5f2a9b29b9bc4fb6c87493">&#9670;&nbsp;</a></span>aon_timer_is_running()</h2>
 250
 251 <div class="memitem">
 252 <div class="memproto">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname">bool aon_timer_is_running </td>
 256           <td>(</td>
 257           <td class="paramtype">void&#160;</td>
 258           <td class="paramname"></td><td>)</td>
 259           <td></td>
 260         </tr>
 261       </table>
 262 </div><div class="memdoc">
 263
 264 <p>Disable the currently enabled AON timer alarm if any. </p>
 265 <dl class="section return"><dt>Returns</dt><dd>true if the AON timer is running </dd></dl>
 266
 267 </div>
 268 </div>
 269 <a id="ga271d25359d58cd63ca24ec315dd72c4a" name="ga271d25359d58cd63ca24ec315dd72c4a"></a>
 270 <h2 class="memtitle"><span class="permalink"><a href="#ga271d25359d58cd63ca24ec315dd72c4a">&#9670;&nbsp;</a></span>aon_timer_set_time()</h2>
 271
 272 <div class="memitem">
 273 <div class="memproto">
 274       <table class="memname">
 275         <tr>
 276           <td class="memname">void aon_timer_set_time </td>
 277           <td>(</td>
 278           <td class="paramtype">const struct timespec *&#160;</td>
 279           <td class="paramname"><em>ts</em></td><td>)</td>
 280           <td></td>
 281         </tr>
 282       </table>
 283 </div><div class="memdoc">
 284
 285 <p>Update the current time of the AON timer. </p>
 286 <dl class="params"><dt>Parameters</dt><dd>
 287   <table class="params">
 288     <tr><td class="paramname">ts</td><td>the new current time </td></tr>
 289   </table>
 290   </dd>
 291 </dl>
 292
 293 </div>
 294 </div>
 295 <a id="ga937223c53432fc9b5fe5252c9712078a" name="ga937223c53432fc9b5fe5252c9712078a"></a>
 296 <h2 class="memtitle"><span class="permalink"><a href="#ga937223c53432fc9b5fe5252c9712078a">&#9670;&nbsp;</a></span>aon_timer_start()</h2>
 297
 298 <div class="memitem">
 299 <div class="memproto">
 300       <table class="memname">
 301         <tr>
 302           <td class="memname">void aon_timer_start </td>
 303           <td>(</td>
 304           <td class="paramtype">const struct timespec *&#160;</td>
 305           <td class="paramname"><em>ts</em></td><td>)</td>
 306           <td></td>
 307         </tr>
 308       </table>
 309 </div><div class="memdoc">
 310
 311 <p>Start the AON timer running using the specified timespec as the current time. </p>
 312 <dl class="params"><dt>Parameters</dt><dd>
 313   <table class="params">
 314     <tr><td class="paramname">ts</td><td>the current time </td></tr>
 315   </table>
 316   </dd>
 317 </dl>
 318
 319 </div>
 320 </div>
 321 </div><!-- contents -->
 322 </div><!-- doc-content -->
 323
 324         <script src="main.js"></script>
 325 </body>
 326 </html>