web/docs/aon__timer_8h.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: include/pico/aon_timer.h File Reference</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('aon__timer_8h.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="#typedef-members">Typedefs</a> &#124;
 107 <a href="#func-members">Functions</a>  </div>
 108   <div class="headertitle"><div class="title">aon_timer.h File Reference</div></div>
 109 </div><!--header-->
 110 <div class="contents">
 111 <div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
 112 <code>#include &lt;time.h&gt;</code><br />
 113 <code>#include &quot;<a class="el" href="datetime_8h_source.html">pico/util/datetime.h</a>&quot;</code><br />
 114 <code>#include &quot;hardware/regs/intctrl.h&quot;</code><br />
 115 </div><div class="textblock"><div class="dynheader">
 116 Include dependency graph for aon_timer.h:</div>
 117 <div class="dyncontent">
 118 <div class="center"><img src="aon__timer_8h__incl.png" border="0" usemap="#ainclude_2pico_2aon__timer_8h" alt=""/></div>
 119 <map name="ainclude_2pico_2aon__timer_8h" id="ainclude_2pico_2aon__timer_8h">
 120 <area shape="rect" title=" " alt="" coords="633,5,814,32"/>
 121 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="558,155,619,181"/>
 122 <area shape="rect" title=" " alt="" coords="626,80,690,107"/>
 123 <area shape="rect" href="datetime_8h.html" title=" " alt="" coords="714,80,863,107"/>
 124 <area shape="rect" title=" " alt="" coords="888,80,1057,107"/>
 125 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,393,259,420"/>
 126 <area shape="rect" title=" " alt="" coords="329,237,443,263"/>
 127 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="467,237,571,263"/>
 128 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="596,237,717,263"/>
 129 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="741,237,836,263"/>
 130 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,468,111,495"/>
 131 <area shape="rect" title=" " alt="" coords="74,543,157,569"/>
 132 <area shape="rect" title=" " alt="" coords="211,468,281,495"/>
 133 <area shape="rect" title=" " alt="" coords="306,468,381,495"/>
 134 <area shape="rect" title=" " alt="" coords="173,319,337,345"/>
 135 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,319,543,345"/>
 136 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,319,746,345"/>
 137 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,319,930,345"/>
 138 <area shape="rect" title=" " alt="" coords="954,319,1165,345"/>
 139 <area shape="rect" title=" " alt="" coords="1189,319,1340,345"/>
 140 <area shape="rect" title=" " alt="" coords="357,393,548,420"/>
 141 <area shape="rect" href="rp2__common_2pico__clib__interface_2include_2llvm__libc_2sys_2time_8h_source.html" title=" " alt="" coords="997,155,1087,181"/>
 142 <area shape="rect" title=" " alt="" coords="860,237,1027,263"/>
 143 <area shape="rect" title=" " alt="" coords="1051,237,1230,263"/>
 144 <area shape="rect" title=" " alt="" coords="1255,229,1416,271"/>
 145 </map>
 146 </div>
 147 </div>
 148 <p><a href="aon__timer_8h_source.html">Go to the source code of this file.</a></p>
 149 <table class="memberdecls">
 150 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 151 Typedefs</h2></td></tr>
 152 <tr class="memitem:a9f54d081a58f284678b04e910e11842b"><td class="memItemLeft" align="right" valign="top"><a id="a9f54d081a58f284678b04e910e11842b" name="a9f54d081a58f284678b04e910e11842b"></a>
 153 typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_alarm_handler_t</b>) (void)</td></tr>
 154 <tr class="separator:a9f54d081a58f284678b04e910e11842b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 </table><table class="memberdecls">
 156 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 157 Functions</h2></td></tr>
 158 <tr class="memitem:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memItemLeft" align="right" valign="top">
 159 void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_start_with_timeofday</b> (void)</td></tr>
 160 <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>
 161 <tr class="separator:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <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>
 163 <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>
 164 <tr class="separator:ga937223c53432fc9b5fe5252c9712078a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memItemLeft" align="right" valign="top">
 166 void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_stop</b> (void)</td></tr>
 167 <tr class="memdesc:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the AON timer. <br /></td></tr>
 168 <tr class="separator:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <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>
 170 <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>
 171 <tr class="separator:ga271d25359d58cd63ca24ec315dd72c4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <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>
 173 <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>
 174 <tr class="separator:ga5e61345c450ef3aa217411104ae8f2e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <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>
 176 <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>
 177 <tr class="separator:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <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>
 179 <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>
 180 <tr class="separator:ga39dab1da58c2f8178024b233e335d059"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="memItemLeft" align="right" valign="top">
 182 void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_disable_alarm</b> (void)</td></tr>
 183 <tr class="memdesc:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the currently enabled AON timer alarm if any. <br /></td></tr>
 184 <tr class="separator:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 <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>
 186 <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>
 187 <tr class="separator:ga134ec8ae2a5f2a9b29b9bc4fb6c87493"><td class="memSeparator" colspan="2">&#160;</td></tr>
 188 <tr class="memitem:acddc1af4b70e5d51c47bf7ca8a3e172e"><td class="memItemLeft" align="right" valign="top"><a id="acddc1af4b70e5d51c47bf7ca8a3e172e" name="acddc1af4b70e5d51c47bf7ca8a3e172e"></a>
 189 static uint&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_get_irq_num</b> (void)</td></tr>
 190 <tr class="separator:acddc1af4b70e5d51c47bf7ca8a3e172e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 </table>
 192 </div><!-- contents -->
 193 </div><!-- doc-content -->
 194
 195         <script src="main.js"></script>
 196 </body>
 197 </html>