web/docs/group__multicore__doorbell.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: doorbell</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__multicore__doorbell.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="#define-members">Macros</a> &#124;
 107 <a href="#func-members">Functions</a>  </div>
 108   <div class="headertitle"><div class="title">doorbell<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a> &raquo; <a class="el" href="group__pico__multicore.html">pico_multicore</a></div></div></div>
 109 </div><!--header-->
 110 <div class="contents">
 111
 112 <p>Functions related to doorbells which a core can use to raise IRQs on itself or the other core.
 113 <a href="#details">More...</a></p>
 114 <table class="memberdecls">
 115 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 116 Macros</h2></td></tr>
 117 <tr class="memitem:ga676ee71a9eb92807a482e2467ed163f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#ga676ee71a9eb92807a482e2467ed163f6">DOORBELL_IRQ_NUM</a>(doorbell_num)</td></tr>
 118 <tr class="memdesc:ga676ee71a9eb92807a482e2467ed163f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a> for processor interrupts for the given doorbell number.  <a href="group__multicore__doorbell.html#ga676ee71a9eb92807a482e2467ed163f6">More...</a><br /></td></tr>
 119 <tr class="separator:ga676ee71a9eb92807a482e2467ed163f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 </table><table class="memberdecls">
 121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 122 Functions</h2></td></tr>
 123 <tr class="memitem:ga278b6df9e61e3b54b3862183a94513d2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#ga278b6df9e61e3b54b3862183a94513d2">multicore_doorbell_claim</a> (uint doorbell_num, uint core_mask)</td></tr>
 124 <tr class="memdesc:ga278b6df9e61e3b54b3862183a94513d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cooperatively claim the use of this hardware alarm_num.  <a href="group__multicore__doorbell.html#ga278b6df9e61e3b54b3862183a94513d2">More...</a><br /></td></tr>
 125 <tr class="separator:ga278b6df9e61e3b54b3862183a94513d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <tr class="memitem:ga67aa5ca0c54bc8f2c7acd69cca6829a6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#ga67aa5ca0c54bc8f2c7acd69cca6829a6">multicore_doorbell_claim_unused</a> (uint core_mask, bool required)</td></tr>
 127 <tr class="memdesc:ga67aa5ca0c54bc8f2c7acd69cca6829a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cooperatively claim the use of this hardware alarm_num.  <a href="group__multicore__doorbell.html#ga67aa5ca0c54bc8f2c7acd69cca6829a6">More...</a><br /></td></tr>
 128 <tr class="separator:ga67aa5ca0c54bc8f2c7acd69cca6829a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <tr class="memitem:gae5f0a4a27b28ce45fa0945d737ad61cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#gae5f0a4a27b28ce45fa0945d737ad61cb">multicore_doorbell_unclaim</a> (uint doorbell_num, uint core_mask)</td></tr>
 130 <tr class="memdesc:gae5f0a4a27b28ce45fa0945d737ad61cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cooperatively release the claim on use of this hardware alarm_num.  <a href="group__multicore__doorbell.html#gae5f0a4a27b28ce45fa0945d737ad61cb">More...</a><br /></td></tr>
 131 <tr class="separator:gae5f0a4a27b28ce45fa0945d737ad61cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 132 <tr class="memitem:gabea48541cd4405325439625c0f57bb02"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#gabea48541cd4405325439625c0f57bb02">multicore_doorbell_set_other_core</a> (uint doorbell_num)</td></tr>
 133 <tr class="memdesc:gabea48541cd4405325439625c0f57bb02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate the given doorbell on the other core.  <a href="group__multicore__doorbell.html#gabea48541cd4405325439625c0f57bb02">More...</a><br /></td></tr>
 134 <tr class="separator:gabea48541cd4405325439625c0f57bb02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:ga6021effd0a028c81ecd02a85b67355a3"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#ga6021effd0a028c81ecd02a85b67355a3">multicore_doorbell_clear_other_core</a> (uint doorbell_num)</td></tr>
 136 <tr class="memdesc:ga6021effd0a028c81ecd02a85b67355a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivate the given doorbell on the other core.  <a href="group__multicore__doorbell.html#ga6021effd0a028c81ecd02a85b67355a3">More...</a><br /></td></tr>
 137 <tr class="separator:ga6021effd0a028c81ecd02a85b67355a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:gae267d5941dabffc3906e96a75257d9ba"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#gae267d5941dabffc3906e96a75257d9ba">multicore_doorbell_set_current_core</a> (uint doorbell_num)</td></tr>
 139 <tr class="memdesc:gae267d5941dabffc3906e96a75257d9ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate the given doorbell on this core.  <a href="group__multicore__doorbell.html#gae267d5941dabffc3906e96a75257d9ba">More...</a><br /></td></tr>
 140 <tr class="separator:gae267d5941dabffc3906e96a75257d9ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ga22f960b66a5693ac4ff19e61ba6ffd45"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#ga22f960b66a5693ac4ff19e61ba6ffd45">multicore_doorbell_clear_current_core</a> (uint doorbell_num)</td></tr>
 142 <tr class="memdesc:ga22f960b66a5693ac4ff19e61ba6ffd45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivate the given doorbell on this core.  <a href="group__multicore__doorbell.html#ga22f960b66a5693ac4ff19e61ba6ffd45">More...</a><br /></td></tr>
 143 <tr class="separator:ga22f960b66a5693ac4ff19e61ba6ffd45"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:gafdf836e71f55b981d9d6a35ac17007e4"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#gafdf836e71f55b981d9d6a35ac17007e4">multicore_doorbell_is_set_current_core</a> (uint doorbell_num)</td></tr>
 145 <tr class="memdesc:gafdf836e71f55b981d9d6a35ac17007e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if the given doorbell is active on the other core.  <a href="group__multicore__doorbell.html#gafdf836e71f55b981d9d6a35ac17007e4">More...</a><br /></td></tr>
 146 <tr class="separator:gafdf836e71f55b981d9d6a35ac17007e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga03c48727a5b056879961be272a09e45f"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html#ga03c48727a5b056879961be272a09e45f">multicore_doorbell_is_set_other_core</a> (uint doorbell_num)</td></tr>
 148 <tr class="memdesc:ga03c48727a5b056879961be272a09e45f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if the given doorbell is active on the this core.  <a href="group__multicore__doorbell.html#ga03c48727a5b056879961be272a09e45f">More...</a><br /></td></tr>
 149 <tr class="separator:ga03c48727a5b056879961be272a09e45f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 152 <p >Functions related to doorbells which a core can use to raise IRQs on itself or the other core. </p>
 153 <h2 class="groupheader">Macro Definition Documentation</h2>
 154 <a id="ga676ee71a9eb92807a482e2467ed163f6" name="ga676ee71a9eb92807a482e2467ed163f6"></a>
 155 <h2 class="memtitle"><span class="permalink"><a href="#ga676ee71a9eb92807a482e2467ed163f6">&#9670;&nbsp;</a></span>DOORBELL_IRQ_NUM</h2>
 156
 157 <div class="memitem">
 158 <div class="memproto">
 159       <table class="memname">
 160         <tr>
 161           <td class="memname">#define DOORBELL_IRQ_NUM</td>
 162           <td>(</td>
 163           <td class="paramtype">&#160;</td>
 164           <td class="paramname">doorbell_num</td><td>)</td>
 165           <td></td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 <p>Returns the <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a> for processor interrupts for the given doorbell number. </p>
 171 <p >Note this macro is intended to resolve at compile time, and does no parameter checking </p>
 172
 173 </div>
 174 </div>
 175 <h2 class="groupheader">Function Documentation</h2>
 176 <a id="ga278b6df9e61e3b54b3862183a94513d2" name="ga278b6df9e61e3b54b3862183a94513d2"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#ga278b6df9e61e3b54b3862183a94513d2">&#9670;&nbsp;</a></span>multicore_doorbell_claim()</h2>
 178
 179 <div class="memitem">
 180 <div class="memproto">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">void multicore_doorbell_claim </td>
 184           <td>(</td>
 185           <td class="paramtype">uint&#160;</td>
 186           <td class="paramname"><em>doorbell_num</em>, </td>
 187         </tr>
 188         <tr>
 189           <td class="paramkey"></td>
 190           <td></td>
 191           <td class="paramtype">uint&#160;</td>
 192           <td class="paramname"><em>core_mask</em>&#160;</td>
 193         </tr>
 194         <tr>
 195           <td></td>
 196           <td>)</td>
 197           <td></td><td></td>
 198         </tr>
 199       </table>
 200 </div><div class="memdoc">
 201
 202 <p>Cooperatively claim the use of this hardware alarm_num. </p>
 203 <p >This method hard asserts if the hardware alarm is currently claimed.</p>
 204 <dl class="params"><dt>Parameters</dt><dd>
 205   <table class="params">
 206     <tr><td class="paramname">doorbell_num</td><td>the doorbell number to claim </td></tr>
 207     <tr><td class="paramname">core_mask</td><td>0b01: core 0, 0b10: core 1, 0b11 both core 0 and core 1 </td></tr>
 208   </table>
 209   </dd>
 210 </dl>
 211 <dl class="section see"><dt>See also</dt><dd>hardware_claiming </dd></dl>
 212
 213 </div>
 214 </div>
 215 <a id="ga67aa5ca0c54bc8f2c7acd69cca6829a6" name="ga67aa5ca0c54bc8f2c7acd69cca6829a6"></a>
 216 <h2 class="memtitle"><span class="permalink"><a href="#ga67aa5ca0c54bc8f2c7acd69cca6829a6">&#9670;&nbsp;</a></span>multicore_doorbell_claim_unused()</h2>
 217
 218 <div class="memitem">
 219 <div class="memproto">
 220       <table class="memname">
 221         <tr>
 222           <td class="memname">int multicore_doorbell_claim_unused </td>
 223           <td>(</td>
 224           <td class="paramtype">uint&#160;</td>
 225           <td class="paramname"><em>core_mask</em>, </td>
 226         </tr>
 227         <tr>
 228           <td class="paramkey"></td>
 229           <td></td>
 230           <td class="paramtype">bool&#160;</td>
 231           <td class="paramname"><em>required</em>&#160;</td>
 232         </tr>
 233         <tr>
 234           <td></td>
 235           <td>)</td>
 236           <td></td><td></td>
 237         </tr>
 238       </table>
 239 </div><div class="memdoc">
 240
 241 <p>Cooperatively claim the use of this hardware alarm_num. </p>
 242 <p >This method attempts to claim an unused hardware alarm</p>
 243 <dl class="params"><dt>Parameters</dt><dd>
 244   <table class="params">
 245     <tr><td class="paramname">core_mask</td><td>0b01: core 0, 0b10: core 1, 0b11 both core 0 and core 1 </td></tr>
 246     <tr><td class="paramname">required</td><td>if true the function will panic if none are available </td></tr>
 247   </table>
 248   </dd>
 249 </dl>
 250 <dl class="section return"><dt>Returns</dt><dd>the doorbell number claimed or -1 if required was false, and none are available </dd></dl>
 251 <dl class="section see"><dt>See also</dt><dd>hardware_claiming </dd></dl>
 252
 253 </div>
 254 </div>
 255 <a id="ga22f960b66a5693ac4ff19e61ba6ffd45" name="ga22f960b66a5693ac4ff19e61ba6ffd45"></a>
 256 <h2 class="memtitle"><span class="permalink"><a href="#ga22f960b66a5693ac4ff19e61ba6ffd45">&#9670;&nbsp;</a></span>multicore_doorbell_clear_current_core()</h2>
 257
 258 <div class="memitem">
 259 <div class="memproto">
 260 <table class="mlabels">
 261   <tr>
 262   <td class="mlabels-left">
 263       <table class="memname">
 264         <tr>
 265           <td class="memname">static void multicore_doorbell_clear_current_core </td>
 266           <td>(</td>
 267           <td class="paramtype">uint&#160;</td>
 268           <td class="paramname"><em>doorbell_num</em></td><td>)</td>
 269           <td></td>
 270         </tr>
 271       </table>
 272   </td>
 273   <td class="mlabels-right">
 274 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 275   </tr>
 276 </table>
 277 </div><div class="memdoc">
 278
 279 <p>Deactivate the given doorbell on this core. </p>
 280 <dl class="params"><dt>Parameters</dt><dd>
 281   <table class="params">
 282     <tr><td class="paramname">doorbell_num</td><td>the doorbell number </td></tr>
 283   </table>
 284   </dd>
 285 </dl>
 286
 287 </div>
 288 </div>
 289 <a id="ga6021effd0a028c81ecd02a85b67355a3" name="ga6021effd0a028c81ecd02a85b67355a3"></a>
 290 <h2 class="memtitle"><span class="permalink"><a href="#ga6021effd0a028c81ecd02a85b67355a3">&#9670;&nbsp;</a></span>multicore_doorbell_clear_other_core()</h2>
 291
 292 <div class="memitem">
 293 <div class="memproto">
 294 <table class="mlabels">
 295   <tr>
 296   <td class="mlabels-left">
 297       <table class="memname">
 298         <tr>
 299           <td class="memname">static void multicore_doorbell_clear_other_core </td>
 300           <td>(</td>
 301           <td class="paramtype">uint&#160;</td>
 302           <td class="paramname"><em>doorbell_num</em></td><td>)</td>
 303           <td></td>
 304         </tr>
 305       </table>
 306   </td>
 307   <td class="mlabels-right">
 308 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 309   </tr>
 310 </table>
 311 </div><div class="memdoc">
 312
 313 <p>Deactivate the given doorbell on the other core. </p>
 314 <dl class="params"><dt>Parameters</dt><dd>
 315   <table class="params">
 316     <tr><td class="paramname">doorbell_num</td><td>the doorbell number </td></tr>
 317   </table>
 318   </dd>
 319 </dl>
 320
 321 </div>
 322 </div>
 323 <a id="gafdf836e71f55b981d9d6a35ac17007e4" name="gafdf836e71f55b981d9d6a35ac17007e4"></a>
 324 <h2 class="memtitle"><span class="permalink"><a href="#gafdf836e71f55b981d9d6a35ac17007e4">&#9670;&nbsp;</a></span>multicore_doorbell_is_set_current_core()</h2>
 325
 326 <div class="memitem">
 327 <div class="memproto">
 328 <table class="mlabels">
 329   <tr>
 330   <td class="mlabels-left">
 331       <table class="memname">
 332         <tr>
 333           <td class="memname">static bool multicore_doorbell_is_set_current_core </td>
 334           <td>(</td>
 335           <td class="paramtype">uint&#160;</td>
 336           <td class="paramname"><em>doorbell_num</em></td><td>)</td>
 337           <td></td>
 338         </tr>
 339       </table>
 340   </td>
 341   <td class="mlabels-right">
 342 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 343   </tr>
 344 </table>
 345 </div><div class="memdoc">
 346
 347 <p>Determine if the given doorbell is active on the other core. </p>
 348 <dl class="params"><dt>Parameters</dt><dd>
 349   <table class="params">
 350     <tr><td class="paramname">doorbell_num</td><td>the doorbell number </td></tr>
 351   </table>
 352   </dd>
 353 </dl>
 354
 355 </div>
 356 </div>
 357 <a id="ga03c48727a5b056879961be272a09e45f" name="ga03c48727a5b056879961be272a09e45f"></a>
 358 <h2 class="memtitle"><span class="permalink"><a href="#ga03c48727a5b056879961be272a09e45f">&#9670;&nbsp;</a></span>multicore_doorbell_is_set_other_core()</h2>
 359
 360 <div class="memitem">
 361 <div class="memproto">
 362 <table class="mlabels">
 363   <tr>
 364   <td class="mlabels-left">
 365       <table class="memname">
 366         <tr>
 367           <td class="memname">static bool multicore_doorbell_is_set_other_core </td>
 368           <td>(</td>
 369           <td class="paramtype">uint&#160;</td>
 370           <td class="paramname"><em>doorbell_num</em></td><td>)</td>
 371           <td></td>
 372         </tr>
 373       </table>
 374   </td>
 375   <td class="mlabels-right">
 376 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 377   </tr>
 378 </table>
 379 </div><div class="memdoc">
 380
 381 <p>Determine if the given doorbell is active on the this core. </p>
 382 <dl class="params"><dt>Parameters</dt><dd>
 383   <table class="params">
 384     <tr><td class="paramname">doorbell_num</td><td>the doorbell number </td></tr>
 385   </table>
 386   </dd>
 387 </dl>
 388
 389 </div>
 390 </div>
 391 <a id="gae267d5941dabffc3906e96a75257d9ba" name="gae267d5941dabffc3906e96a75257d9ba"></a>
 392 <h2 class="memtitle"><span class="permalink"><a href="#gae267d5941dabffc3906e96a75257d9ba">&#9670;&nbsp;</a></span>multicore_doorbell_set_current_core()</h2>
 393
 394 <div class="memitem">
 395 <div class="memproto">
 396 <table class="mlabels">
 397   <tr>
 398   <td class="mlabels-left">
 399       <table class="memname">
 400         <tr>
 401           <td class="memname">static void multicore_doorbell_set_current_core </td>
 402           <td>(</td>
 403           <td class="paramtype">uint&#160;</td>
 404           <td class="paramname"><em>doorbell_num</em></td><td>)</td>
 405           <td></td>
 406         </tr>
 407       </table>
 408   </td>
 409   <td class="mlabels-right">
 410 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 411   </tr>
 412 </table>
 413 </div><div class="memdoc">
 414
 415 <p>Activate the given doorbell on this core. </p>
 416 <dl class="params"><dt>Parameters</dt><dd>
 417   <table class="params">
 418     <tr><td class="paramname">doorbell_num</td><td>the doorbell number </td></tr>
 419   </table>
 420   </dd>
 421 </dl>
 422
 423 </div>
 424 </div>
 425 <a id="gabea48541cd4405325439625c0f57bb02" name="gabea48541cd4405325439625c0f57bb02"></a>
 426 <h2 class="memtitle"><span class="permalink"><a href="#gabea48541cd4405325439625c0f57bb02">&#9670;&nbsp;</a></span>multicore_doorbell_set_other_core()</h2>
 427
 428 <div class="memitem">
 429 <div class="memproto">
 430 <table class="mlabels">
 431   <tr>
 432   <td class="mlabels-left">
 433       <table class="memname">
 434         <tr>
 435           <td class="memname">static void multicore_doorbell_set_other_core </td>
 436           <td>(</td>
 437           <td class="paramtype">uint&#160;</td>
 438           <td class="paramname"><em>doorbell_num</em></td><td>)</td>
 439           <td></td>
 440         </tr>
 441       </table>
 442   </td>
 443   <td class="mlabels-right">
 444 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 445   </tr>
 446 </table>
 447 </div><div class="memdoc">
 448
 449 <p>Activate the given doorbell on the other core. </p>
 450 <dl class="params"><dt>Parameters</dt><dd>
 451   <table class="params">
 452     <tr><td class="paramname">doorbell_num</td><td>the doorbell number </td></tr>
 453   </table>
 454   </dd>
 455 </dl>
 456
 457 </div>
 458 </div>
 459 <a id="gae5f0a4a27b28ce45fa0945d737ad61cb" name="gae5f0a4a27b28ce45fa0945d737ad61cb"></a>
 460 <h2 class="memtitle"><span class="permalink"><a href="#gae5f0a4a27b28ce45fa0945d737ad61cb">&#9670;&nbsp;</a></span>multicore_doorbell_unclaim()</h2>
 461
 462 <div class="memitem">
 463 <div class="memproto">
 464       <table class="memname">
 465         <tr>
 466           <td class="memname">void multicore_doorbell_unclaim </td>
 467           <td>(</td>
 468           <td class="paramtype">uint&#160;</td>
 469           <td class="paramname"><em>doorbell_num</em>, </td>
 470         </tr>
 471         <tr>
 472           <td class="paramkey"></td>
 473           <td></td>
 474           <td class="paramtype">uint&#160;</td>
 475           <td class="paramname"><em>core_mask</em>&#160;</td>
 476         </tr>
 477         <tr>
 478           <td></td>
 479           <td>)</td>
 480           <td></td><td></td>
 481         </tr>
 482       </table>
 483 </div><div class="memdoc">
 484
 485 <p>Cooperatively release the claim on use of this hardware alarm_num. </p>
 486 <dl class="params"><dt>Parameters</dt><dd>
 487   <table class="params">
 488     <tr><td class="paramname">doorbell_num</td><td>the doorbell number to unclaim </td></tr>
 489     <tr><td class="paramname">core_mask</td><td>0b01: core 0, 0b10: core 1, 0b11 both core 0 and core 1 </td></tr>
 490   </table>
 491   </dd>
 492 </dl>
 493 <dl class="section see"><dt>See also</dt><dd>hardware_claiming </dd></dl>
 494
 495 </div>
 496 </div>
 497 </div><!-- contents -->
 498 </div><!-- doc-content -->
 499
 500         <script src="main.js"></script>
 501 </body>
 502 </html>