web/docs/group__hardware__ticks.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: hardware_ticks</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__hardware__ticks.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="#enum-members">Enumerations</a> &#124;
 108 <a href="#func-members">Functions</a>  </div>
 109   <div class="headertitle"><div class="title">hardware_ticks<div class="ingroups"><a class="el" href="group__hardware.html">Hardware APIs</a></div></div></div>
 110 </div><!--header-->
 111 <div class="contents">
 112
 113 <p>Hardware Tick API.
 114 <a href="#details">More...</a></p>
 115 <table class="memberdecls">
 116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 117 Typedefs</h2></td></tr>
 118 <tr class="memitem:gaea457044b65d6af680787206c06faa39"><td class="memItemLeft" align="right" valign="top"><a id="gaea457044b65d6af680787206c06faa39" name="gaea457044b65d6af680787206c06faa39"></a>
 119 typedef enum <a class="el" href="group__hardware__ticks.html#ga7c007d63cabddadd107f9b597278c32e">tick_gen_num_rp2350</a>&#160;</td><td class="memItemRight" valign="bottom"><b>tick_gen_num_t</b></td></tr>
 120 <tr class="memdesc:gaea457044b65d6af680787206c06faa39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tick generator numbers on RP2350 (used as typedef <a class="el" href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">tick_gen_num_t</a>) <br /></td></tr>
 121 <tr class="separator:gaea457044b65d6af680787206c06faa39"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:gabd515d04e9260f97a63ed0a1415ef4c2"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__hardware__ticks.html#ga567ed42c04aa5b006e234d8a4df38b5a">tick_gen_num_rp2040</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">tick_gen_num_t</a></td></tr>
 123 <tr class="memdesc:gabd515d04e9260f97a63ed0a1415ef4c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tick generator numbers on RP2040 (used as typedef <a class="el" href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">tick_gen_num_t</a>)  <a href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">More...</a><br /></td></tr>
 124 <tr class="separator:gabd515d04e9260f97a63ed0a1415ef4c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 </table><table class="memberdecls">
 126 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 127 Enumerations</h2></td></tr>
 128 <tr class="memitem:ga7c007d63cabddadd107f9b597278c32e"><td class="memItemLeft" align="right" valign="top"><a id="ga7c007d63cabddadd107f9b597278c32e" name="ga7c007d63cabddadd107f9b597278c32e"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__ticks.html#ga7c007d63cabddadd107f9b597278c32e">tick_gen_num_rp2350</a> { <br />
 129 &#160;&#160;<b>TICK_PROC0</b> = 0
 130 , <b>TICK_PROC1</b> = 1
 131 , <b>TICK_TIMER0</b> = 2
 132 , <b>TICK_TIMER1</b> = 3
 133 , <br />
 134 &#160;&#160;<b>TICK_WATCHDOG</b> = 4
 135 , <b>TICK_RISCV</b> = 5
 136 , <b>TICK_COUNT</b>
 137 <br />
 138  }</td></tr>
 139 <tr class="memdesc:ga7c007d63cabddadd107f9b597278c32e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tick generator numbers on RP2350 (used as typedef <a class="el" href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">tick_gen_num_t</a>) <br /></td></tr>
 140 <tr class="separator:ga7c007d63cabddadd107f9b597278c32e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ga567ed42c04aa5b006e234d8a4df38b5a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__ticks.html#ga567ed42c04aa5b006e234d8a4df38b5a">tick_gen_num_rp2040</a> { <b>TICK_WATCHDOG</b> = 0
 142 , <b>TICK_COUNT</b>
 143  }</td></tr>
 144 <tr class="memdesc:ga567ed42c04aa5b006e234d8a4df38b5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tick generator numbers on RP2040 (used as typedef <a class="el" href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">tick_gen_num_t</a>)  <a href="group__hardware__ticks.html#ga567ed42c04aa5b006e234d8a4df38b5a">More...</a><br /></td></tr>
 145 <tr class="separator:ga567ed42c04aa5b006e234d8a4df38b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 </table><table class="memberdecls">
 147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 148 Functions</h2></td></tr>
 149 <tr class="memitem:gaea97210ea6cb05be8444eef06c10695a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__ticks.html#gaea97210ea6cb05be8444eef06c10695a">tick_start</a> (<a class="el" href="group__hardware__ticks.html#gaea457044b65d6af680787206c06faa39">tick_gen_num_t</a> tick, uint cycles)</td></tr>
 150 <tr class="memdesc:gaea97210ea6cb05be8444eef06c10695a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a tick generator.  <a href="group__hardware__ticks.html#gaea97210ea6cb05be8444eef06c10695a">More...</a><br /></td></tr>
 151 <tr class="separator:gaea97210ea6cb05be8444eef06c10695a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:gab09f4714958ebacacafc54856a3169df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__ticks.html#gab09f4714958ebacacafc54856a3169df">tick_stop</a> (<a class="el" href="group__hardware__ticks.html#gaea457044b65d6af680787206c06faa39">tick_gen_num_t</a> tick)</td></tr>
 153 <tr class="memdesc:gab09f4714958ebacacafc54856a3169df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop a tick generator.  <a href="group__hardware__ticks.html#gab09f4714958ebacacafc54856a3169df">More...</a><br /></td></tr>
 154 <tr class="separator:gab09f4714958ebacacafc54856a3169df"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:ga2b4d6531a3f9f261dbd4a24883f752b9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__ticks.html#ga2b4d6531a3f9f261dbd4a24883f752b9">tick_is_running</a> (<a class="el" href="group__hardware__ticks.html#gaea457044b65d6af680787206c06faa39">tick_gen_num_t</a> tick)</td></tr>
 156 <tr class="memdesc:ga2b4d6531a3f9f261dbd4a24883f752b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a tick genererator is currently running.  <a href="group__hardware__ticks.html#ga2b4d6531a3f9f261dbd4a24883f752b9">More...</a><br /></td></tr>
 157 <tr class="separator:ga2b4d6531a3f9f261dbd4a24883f752b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 </table>
 159 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 160 <p >Hardware Tick API. </p>
 161 <p >RP2040 only has one tick generator, and it is part of the watchdog hardware. </p>
 162 <p >The RP2350 has a dedicated Tick block that is used to supply ticks to TIMER0, TIMER1, RISC-V platform timer, Arm Cortex-M33 0 timer, Arm Cortex-M33 1 timer and the WATCHDOG block.  </p>
 163 <h2 class="groupheader">Typedef Documentation</h2>
 164 <a id="gabd515d04e9260f97a63ed0a1415ef4c2" name="gabd515d04e9260f97a63ed0a1415ef4c2"></a>
 165 <h2 class="memtitle"><span class="permalink"><a href="#gabd515d04e9260f97a63ed0a1415ef4c2">&#9670;&nbsp;</a></span>tick_gen_num_t</h2>
 166
 167 <div class="memitem">
 168 <div class="memproto">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname">typedef enum <a class="el" href="group__hardware__ticks.html#ga567ed42c04aa5b006e234d8a4df38b5a">tick_gen_num_rp2040</a> <a class="el" href="group__hardware__ticks.html#gaea457044b65d6af680787206c06faa39">tick_gen_num_t</a></td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 <p>Tick generator numbers on RP2040 (used as typedef <a class="el" href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">tick_gen_num_t</a>) </p>
 177 <p >RP2040 only has one tick generator, and it is part of the watchdog hardware </p>
 178
 179 </div>
 180 </div>
 181 <h2 class="groupheader">Enumeration Type Documentation</h2>
 182 <a id="ga567ed42c04aa5b006e234d8a4df38b5a" name="ga567ed42c04aa5b006e234d8a4df38b5a"></a>
 183 <h2 class="memtitle"><span class="permalink"><a href="#ga567ed42c04aa5b006e234d8a4df38b5a">&#9670;&nbsp;</a></span>tick_gen_num_rp2040</h2>
 184
 185 <div class="memitem">
 186 <div class="memproto">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname">enum <a class="el" href="group__hardware__ticks.html#ga567ed42c04aa5b006e234d8a4df38b5a">tick_gen_num_rp2040</a></td>
 190         </tr>
 191       </table>
 192 </div><div class="memdoc">
 193
 194 <p>Tick generator numbers on RP2040 (used as typedef <a class="el" href="group__hardware__ticks.html#gabd515d04e9260f97a63ed0a1415ef4c2">tick_gen_num_t</a>) </p>
 195 <p >RP2040 only has one tick generator, and it is part of the watchdog hardware </p>
 196
 197 </div>
 198 </div>
 199 <h2 class="groupheader">Function Documentation</h2>
 200 <a id="ga2b4d6531a3f9f261dbd4a24883f752b9" name="ga2b4d6531a3f9f261dbd4a24883f752b9"></a>
 201 <h2 class="memtitle"><span class="permalink"><a href="#ga2b4d6531a3f9f261dbd4a24883f752b9">&#9670;&nbsp;</a></span>tick_is_running()</h2>
 202
 203 <div class="memitem">
 204 <div class="memproto">
 205       <table class="memname">
 206         <tr>
 207           <td class="memname">bool tick_is_running </td>
 208           <td>(</td>
 209           <td class="paramtype"><a class="el" href="group__hardware__ticks.html#gaea457044b65d6af680787206c06faa39">tick_gen_num_t</a>&#160;</td>
 210           <td class="paramname"><em>tick</em></td><td>)</td>
 211           <td></td>
 212         </tr>
 213       </table>
 214 </div><div class="memdoc">
 215
 216 <p>Check if a tick genererator is currently running. </p>
 217 <dl class="params"><dt>Parameters</dt><dd>
 218   <table class="params">
 219     <tr><td class="paramname">tick</td><td>The tick generator number </td></tr>
 220   </table>
 221   </dd>
 222 </dl>
 223 <dl class="section return"><dt>Returns</dt><dd>true if the specific ticker is running. </dd></dl>
 224
 225 </div>
 226 </div>
 227 <a id="gaea97210ea6cb05be8444eef06c10695a" name="gaea97210ea6cb05be8444eef06c10695a"></a>
 228 <h2 class="memtitle"><span class="permalink"><a href="#gaea97210ea6cb05be8444eef06c10695a">&#9670;&nbsp;</a></span>tick_start()</h2>
 229
 230 <div class="memitem">
 231 <div class="memproto">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname">void tick_start </td>
 235           <td>(</td>
 236           <td class="paramtype"><a class="el" href="group__hardware__ticks.html#gaea457044b65d6af680787206c06faa39">tick_gen_num_t</a>&#160;</td>
 237           <td class="paramname"><em>tick</em>, </td>
 238         </tr>
 239         <tr>
 240           <td class="paramkey"></td>
 241           <td></td>
 242           <td class="paramtype">uint&#160;</td>
 243           <td class="paramname"><em>cycles</em>&#160;</td>
 244         </tr>
 245         <tr>
 246           <td></td>
 247           <td>)</td>
 248           <td></td><td></td>
 249         </tr>
 250       </table>
 251 </div><div class="memdoc">
 252
 253 <p>Start a tick generator. </p>
 254 <dl class="params"><dt>Parameters</dt><dd>
 255   <table class="params">
 256     <tr><td class="paramname">tick</td><td>The tick generator number </td></tr>
 257     <tr><td class="paramname">cycles</td><td>The number of clock cycles per tick </td></tr>
 258   </table>
 259   </dd>
 260 </dl>
 261
 262 </div>
 263 </div>
 264 <a id="gab09f4714958ebacacafc54856a3169df" name="gab09f4714958ebacacafc54856a3169df"></a>
 265 <h2 class="memtitle"><span class="permalink"><a href="#gab09f4714958ebacacafc54856a3169df">&#9670;&nbsp;</a></span>tick_stop()</h2>
 266
 267 <div class="memitem">
 268 <div class="memproto">
 269       <table class="memname">
 270         <tr>
 271           <td class="memname">void tick_stop </td>
 272           <td>(</td>
 273           <td class="paramtype"><a class="el" href="group__hardware__ticks.html#gaea457044b65d6af680787206c06faa39">tick_gen_num_t</a>&#160;</td>
 274           <td class="paramname"><em>tick</em></td><td>)</td>
 275           <td></td>
 276         </tr>
 277       </table>
 278 </div><div class="memdoc">
 279
 280 <p>Stop a tick generator. </p>
 281 <dl class="params"><dt>Parameters</dt><dd>
 282   <table class="params">
 283     <tr><td class="paramname">tick</td><td>The tick generator number </td></tr>
 284   </table>
 285   </dd>
 286 </dl>
 287
 288 </div>
 289 </div>
 290 </div><!-- contents -->
 291 </div><!-- doc-content -->
 292
 293         <script src="main.js"></script>
 294 </body>
 295 </html>