web/docs/multicore_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/multicore.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('multicore_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="#define-members">Macros</a> &#124;
 107 <a href="#func-members">Functions</a>  </div>
 108   <div class="headertitle"><div class="title">multicore.h File Reference</div></div>
 109 </div><!--header-->
 110 <div class="contents">
 111 <div class="textblock"><code>#include &quot;pico/types.h&quot;</code><br />
 112 <code>#include &quot;<a class="el" href="common_2pico__sync_2include_2pico_2sync_8h_source.html">pico/sync.h</a>&quot;</code><br />
 113 <code>#include &quot;hardware/structs/sio.h&quot;</code><br />
 114 </div><div class="textblock"><div class="dynheader">
 115 Include dependency graph for multicore.h:</div>
 116 <div class="dyncontent">
 117 <div class="center"><img src="multicore_8h__incl.png" border="0" usemap="#ainclude_2pico_2multicore_8h" alt=""/></div>
 118 <map name="ainclude_2pico_2multicore_8h" id="ainclude_2pico_2multicore_8h">
 119 <area shape="rect" title=" " alt="" coords="294,5,473,32"/>
 120 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,692,259,719"/>
 121 <area shape="rect" href="common_2pico__sync_2include_2pico_2sync_8h.html" title=" " alt="" coords="336,80,431,107"/>
 122 <area shape="rect" title=" " alt="" coords="455,80,621,107"/>
 123 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,767,111,793"/>
 124 <area shape="rect" title=" " alt="" coords="74,841,157,868"/>
 125 <area shape="rect" title=" " alt="" coords="211,767,281,793"/>
 126 <area shape="rect" title=" " alt="" coords="306,767,381,793"/>
 127 <area shape="rect" href="sem_8h.html" title=" " alt="" coords="413,155,506,181"/>
 128 <area shape="rect" href="mutex_8h.html" title=" " alt="" coords="530,155,637,181"/>
 129 <area shape="rect" href="critical__section_8h.html" title=" " alt="" coords="226,155,389,181"/>
 130 <area shape="rect" href="lock__core_8h.html" title=" " alt="" coords="495,229,621,256"/>
 131 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="595,468,657,495"/>
 132 <area shape="rect" href="common_2pico__time_2include_2pico_2time_8h.html" title=" " alt="" coords="468,304,563,331"/>
 133 <area shape="rect" href="rp2__common_2hardware__sync_2include_2hardware_2sync_8h.html" title=" " alt="" coords="699,304,828,331"/>
 134 <area shape="rect" title=" " alt="" coords="787,543,900,569"/>
 135 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="334,543,438,569"/>
 136 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="641,543,763,569"/>
 137 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="523,543,617,569"/>
 138 <area shape="rect" title=" " alt="" coords="247,617,411,644"/>
 139 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="997,617,1178,644"/>
 140 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="610,617,789,644"/>
 141 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="813,617,973,644"/>
 142 <area shape="rect" title=" " alt="" coords="1202,617,1413,644"/>
 143 <area shape="rect" title=" " alt="" coords="435,617,585,644"/>
 144 <area shape="rect" title=" " alt="" coords="992,692,1183,719"/>
 145 <area shape="rect" href="rp2__common_2hardware__timer_2include_2hardware_2timer_8h.html" title=" " alt="" coords="379,386,513,413"/>
 146 <area shape="rect" title=" " alt="" coords="195,468,377,495"/>
 147 <area shape="rect" title=" " alt="" coords="401,468,571,495"/>
 148 <area shape="rect" href="address__mapped_8h.html" title=" " alt="" coords="862,386,1073,413"/>
 149 <area shape="rect" href="spin__lock_8h_source.html" title=" " alt="" coords="689,379,837,420"/>
 150 </map>
 151 </div>
 152 </div>
 153 <p><a href="multicore_8h_source.html">Go to the source code of this file.</a></p>
 154 <table class="memberdecls">
 155 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 156 Macros</h2></td></tr>
 157 <tr class="memitem:a5a41c5809616d042b8a460f2ef736b8b"><td class="memItemLeft" align="right" valign="top"><a id="a5a41c5809616d042b8a460f2ef736b8b" name="a5a41c5809616d042b8a460f2ef736b8b"></a>
 158 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PARAM_ASSERTIONS_ENABLED_PICO_MULTICORE</b>&#160;&#160;&#160;0</td></tr>
 159 <tr class="separator:a5a41c5809616d042b8a460f2ef736b8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:a925a02b01dd7a3f9b913429aa3aaae36"><td class="memItemLeft" align="right" valign="top"><a id="a925a02b01dd7a3f9b913429aa3aaae36" name="a925a02b01dd7a3f9b913429aa3aaae36"></a>
 161 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_CORE1_STACK_SIZE</b>&#160;&#160;&#160;0x800</td></tr>
 162 <tr class="separator:a925a02b01dd7a3f9b913429aa3aaae36"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:ga1413ebfa65114c6f408f4675897ac5ee"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__multicore.html#ga1413ebfa65114c6f408f4675897ac5ee">SIO_FIFO_IRQ_NUM</a>(core)</td></tr>
 164 <tr class="memdesc:ga1413ebfa65114c6f408f4675897ac5ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a> for the FIFO IRQ on the given core.  <a href="group__pico__multicore.html#ga1413ebfa65114c6f408f4675897ac5ee">More...</a><br /></td></tr>
 165 <tr class="separator:ga1413ebfa65114c6f408f4675897ac5ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <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>
 167 <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>
 168 <tr class="separator:ga676ee71a9eb92807a482e2467ed163f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 </table><table class="memberdecls">
 170 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 171 Functions</h2></td></tr>
 172 <tr class="memitem:gad7a189a5f44f0124d74aa5b206f9a262"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262">multicore_reset_core1</a> (void)</td></tr>
 173 <tr class="memdesc:gad7a189a5f44f0124d74aa5b206f9a262"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset core 1.  <a href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262">More...</a><br /></td></tr>
 174 <tr class="separator:gad7a189a5f44f0124d74aa5b206f9a262"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <tr class="memitem:ga46ea5e2efc181aba1d4d1de06a375c59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__multicore.html#ga46ea5e2efc181aba1d4d1de06a375c59">multicore_launch_core1</a> (void(*entry)(void))</td></tr>
 176 <tr class="memdesc:ga46ea5e2efc181aba1d4d1de06a375c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run code on core 1.  <a href="group__pico__multicore.html#ga46ea5e2efc181aba1d4d1de06a375c59">More...</a><br /></td></tr>
 177 <tr class="separator:ga46ea5e2efc181aba1d4d1de06a375c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <tr class="memitem:gac1926bb2da43016e5d14eb52c8c123f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__multicore.html#gac1926bb2da43016e5d14eb52c8c123f4">multicore_launch_core1_with_stack</a> (void(*entry)(void), uint32_t *stack_bottom, size_t stack_size_bytes)</td></tr>
 179 <tr class="memdesc:gac1926bb2da43016e5d14eb52c8c123f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Launch code on core 1 with stack.  <a href="group__pico__multicore.html#gac1926bb2da43016e5d14eb52c8c123f4">More...</a><br /></td></tr>
 180 <tr class="separator:gac1926bb2da43016e5d14eb52c8c123f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:gac3a24e275219229de49d1fb32e3c4ef0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__multicore.html#gac3a24e275219229de49d1fb32e3c4ef0">multicore_launch_core1_raw</a> (void(*entry)(void), uint32_t *sp, uint32_t vector_table)</td></tr>
 182 <tr class="memdesc:gac3a24e275219229de49d1fb32e3c4ef0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Launch code on core 1 with no stack protection.  <a href="group__pico__multicore.html#gac3a24e275219229de49d1fb32e3c4ef0">More...</a><br /></td></tr>
 183 <tr class="separator:gac3a24e275219229de49d1fb32e3c4ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 <tr class="memitem:gaffd246b81370d37fc13181a561303834"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#gaffd246b81370d37fc13181a561303834">multicore_fifo_rvalid</a> (void)</td></tr>
 185 <tr class="memdesc:gaffd246b81370d37fc13181a561303834"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check the read FIFO to see if there is data available (sent by the other core)  <a href="group__multicore__fifo.html#gaffd246b81370d37fc13181a561303834">More...</a><br /></td></tr>
 186 <tr class="separator:gaffd246b81370d37fc13181a561303834"><td class="memSeparator" colspan="2">&#160;</td></tr>
 187 <tr class="memitem:ga6065367210695961c11ab3706140d3a9"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga6065367210695961c11ab3706140d3a9">multicore_fifo_wready</a> (void)</td></tr>
 188 <tr class="memdesc:ga6065367210695961c11ab3706140d3a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check the write FIFO to see if it has space for more data.  <a href="group__multicore__fifo.html#ga6065367210695961c11ab3706140d3a9">More...</a><br /></td></tr>
 189 <tr class="separator:ga6065367210695961c11ab3706140d3a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 190 <tr class="memitem:ga134933a693c53c4f94c9d3cd3cabfc79"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga134933a693c53c4f94c9d3cd3cabfc79">multicore_fifo_push_blocking</a> (uint32_t data)</td></tr>
 191 <tr class="memdesc:ga134933a693c53c4f94c9d3cd3cabfc79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push data on to the write FIFO (data to the other core).  <a href="group__multicore__fifo.html#ga134933a693c53c4f94c9d3cd3cabfc79">More...</a><br /></td></tr>
 192 <tr class="separator:ga134933a693c53c4f94c9d3cd3cabfc79"><td class="memSeparator" colspan="2">&#160;</td></tr>
 193 <tr class="memitem:ga559050fb6fd4a37ccc81ef6272cbf34b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga559050fb6fd4a37ccc81ef6272cbf34b">multicore_fifo_push_blocking_inline</a> (uint32_t data)</td></tr>
 194 <tr class="memdesc:ga559050fb6fd4a37ccc81ef6272cbf34b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push data on to the write FIFO (data to the other core).  <a href="group__multicore__fifo.html#ga559050fb6fd4a37ccc81ef6272cbf34b">More...</a><br /></td></tr>
 195 <tr class="separator:ga559050fb6fd4a37ccc81ef6272cbf34b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 196 <tr class="memitem:ga0c32cfcd182d5f1d3a25b6fb503352b7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga0c32cfcd182d5f1d3a25b6fb503352b7">multicore_fifo_push_timeout_us</a> (uint32_t data, uint64_t timeout_us)</td></tr>
 197 <tr class="memdesc:ga0c32cfcd182d5f1d3a25b6fb503352b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push data on to the write FIFO (data to the other core) with timeout.  <a href="group__multicore__fifo.html#ga0c32cfcd182d5f1d3a25b6fb503352b7">More...</a><br /></td></tr>
 198 <tr class="separator:ga0c32cfcd182d5f1d3a25b6fb503352b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 199 <tr class="memitem:ga929272dd1056d8ae05667beda4adb0fc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga929272dd1056d8ae05667beda4adb0fc">multicore_fifo_pop_blocking</a> (void)</td></tr>
 200 <tr class="memdesc:ga929272dd1056d8ae05667beda4adb0fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop data from the read FIFO (data from the other core).  <a href="group__multicore__fifo.html#ga929272dd1056d8ae05667beda4adb0fc">More...</a><br /></td></tr>
 201 <tr class="separator:ga929272dd1056d8ae05667beda4adb0fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 202 <tr class="memitem:ga282badad31e14f5b593ec1ddffae08f5"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga282badad31e14f5b593ec1ddffae08f5">multicore_fifo_pop_blocking_inline</a> (void)</td></tr>
 203 <tr class="memdesc:ga282badad31e14f5b593ec1ddffae08f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop data from the read FIFO (data from the other core).  <a href="group__multicore__fifo.html#ga282badad31e14f5b593ec1ddffae08f5">More...</a><br /></td></tr>
 204 <tr class="separator:ga282badad31e14f5b593ec1ddffae08f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 205 <tr class="memitem:ga27824f253c72ae50ae97e6f516220c60"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga27824f253c72ae50ae97e6f516220c60">multicore_fifo_pop_timeout_us</a> (uint64_t timeout_us, uint32_t *out)</td></tr>
 206 <tr class="memdesc:ga27824f253c72ae50ae97e6f516220c60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop data from the read FIFO (data from the other core) with timeout.  <a href="group__multicore__fifo.html#ga27824f253c72ae50ae97e6f516220c60">More...</a><br /></td></tr>
 207 <tr class="separator:ga27824f253c72ae50ae97e6f516220c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 208 <tr class="memitem:ga436e676544edeafb2f2f9e7245282cbf"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga436e676544edeafb2f2f9e7245282cbf">multicore_fifo_drain</a> (void)</td></tr>
 209 <tr class="memdesc:ga436e676544edeafb2f2f9e7245282cbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Discard any data in the read FIFO.  <a href="group__multicore__fifo.html#ga436e676544edeafb2f2f9e7245282cbf">More...</a><br /></td></tr>
 210 <tr class="separator:ga436e676544edeafb2f2f9e7245282cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 211 <tr class="memitem:ga96583311e8237cf590d9c78052b288eb"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga96583311e8237cf590d9c78052b288eb">multicore_fifo_clear_irq</a> (void)</td></tr>
 212 <tr class="memdesc:ga96583311e8237cf590d9c78052b288eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear FIFO interrupt.  <a href="group__multicore__fifo.html#ga96583311e8237cf590d9c78052b288eb">More...</a><br /></td></tr>
 213 <tr class="separator:ga96583311e8237cf590d9c78052b288eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 214 <tr class="memitem:ga7c5944bf2b7266465dfe6d4bac4b1c58"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html#ga7c5944bf2b7266465dfe6d4bac4b1c58">multicore_fifo_get_status</a> (void)</td></tr>
 215 <tr class="memdesc:ga7c5944bf2b7266465dfe6d4bac4b1c58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get FIFO statuses.  <a href="group__multicore__fifo.html#ga7c5944bf2b7266465dfe6d4bac4b1c58">More...</a><br /></td></tr>
 216 <tr class="separator:ga7c5944bf2b7266465dfe6d4bac4b1c58"><td class="memSeparator" colspan="2">&#160;</td></tr>
 217 <tr class="memitem:a1aba7387ec36c7db4f86f89616d4fc1c"><td class="memItemLeft" align="right" valign="top"><a id="a1aba7387ec36c7db4f86f89616d4fc1c" name="a1aba7387ec36c7db4f86f89616d4fc1c"></a>
 218 static void&#160;</td><td class="memItemRight" valign="bottom"><b>check_doorbell_num_param</b> (__unused uint doorbell_num)</td></tr>
 219 <tr class="separator:a1aba7387ec36c7db4f86f89616d4fc1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 220 <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>
 221 <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>
 222 <tr class="separator:ga278b6df9e61e3b54b3862183a94513d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 223 <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>
 224 <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>
 225 <tr class="separator:ga67aa5ca0c54bc8f2c7acd69cca6829a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 226 <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>
 227 <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>
 228 <tr class="separator:gae5f0a4a27b28ce45fa0945d737ad61cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 229 <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>
 230 <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>
 231 <tr class="separator:gabea48541cd4405325439625c0f57bb02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 232 <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>
 233 <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>
 234 <tr class="separator:ga6021effd0a028c81ecd02a85b67355a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 235 <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>
 236 <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>
 237 <tr class="separator:gae267d5941dabffc3906e96a75257d9ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 238 <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>
 239 <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>
 240 <tr class="separator:ga22f960b66a5693ac4ff19e61ba6ffd45"><td class="memSeparator" colspan="2">&#160;</td></tr>
 241 <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>
 242 <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>
 243 <tr class="separator:gafdf836e71f55b981d9d6a35ac17007e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 244 <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>
 245 <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>
 246 <tr class="separator:ga03c48727a5b056879961be272a09e45f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 247 <tr class="memitem:ae9ff0b0d5d69be025815336fc22992f9"><td class="memItemLeft" align="right" valign="top"><a id="ae9ff0b0d5d69be025815336fc22992f9" name="ae9ff0b0d5d69be025815336fc22992f9"></a>
 248 static uint&#160;</td><td class="memItemRight" valign="bottom"><b>multicore_doorbell_irq_num</b> (uint doorbell_num)</td></tr>
 249 <tr class="separator:ae9ff0b0d5d69be025815336fc22992f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 250 <tr class="memitem:ga4e969086bda6851bc8ce8199113fd595"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__lockout.html#ga4e969086bda6851bc8ce8199113fd595">multicore_lockout_victim_init</a> (void)</td></tr>
 251 <tr class="memdesc:ga4e969086bda6851bc8ce8199113fd595"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the current core such that it can be a "victim" of lockout (i.e. forced to pause in a known state by the other core)  <a href="group__multicore__lockout.html#ga4e969086bda6851bc8ce8199113fd595">More...</a><br /></td></tr>
 252 <tr class="separator:ga4e969086bda6851bc8ce8199113fd595"><td class="memSeparator" colspan="2">&#160;</td></tr>
 253 <tr class="memitem:ga3669ce9202da1860fcbbb11094778dd5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__lockout.html#ga3669ce9202da1860fcbbb11094778dd5">multicore_lockout_victim_is_initialized</a> (uint core_num)</td></tr>
 254 <tr class="memdesc:ga3669ce9202da1860fcbbb11094778dd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if multicore_victim_init() has been called on the specified core.  <a href="group__multicore__lockout.html#ga3669ce9202da1860fcbbb11094778dd5">More...</a><br /></td></tr>
 255 <tr class="separator:ga3669ce9202da1860fcbbb11094778dd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 256 <tr class="memitem:ga9a3f4df6b0e4140b0f40899a02c238d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__lockout.html#ga9a3f4df6b0e4140b0f40899a02c238d8">multicore_lockout_start_blocking</a> (void)</td></tr>
 257 <tr class="memdesc:ga9a3f4df6b0e4140b0f40899a02c238d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the other core to pause in a known state and wait for it to do so.  <a href="group__multicore__lockout.html#ga9a3f4df6b0e4140b0f40899a02c238d8">More...</a><br /></td></tr>
 258 <tr class="separator:ga9a3f4df6b0e4140b0f40899a02c238d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 259 <tr class="memitem:gaaf40bf0b8b3a704f3178e38977d292be"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__lockout.html#gaaf40bf0b8b3a704f3178e38977d292be">multicore_lockout_start_timeout_us</a> (uint64_t timeout_us)</td></tr>
 260 <tr class="memdesc:gaaf40bf0b8b3a704f3178e38977d292be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the other core to pause in a known state and wait up to a time limit for it to do so.  <a href="group__multicore__lockout.html#gaaf40bf0b8b3a704f3178e38977d292be">More...</a><br /></td></tr>
 261 <tr class="separator:gaaf40bf0b8b3a704f3178e38977d292be"><td class="memSeparator" colspan="2">&#160;</td></tr>
 262 <tr class="memitem:gab1b7b6dc6f81ca9524467f5024681167"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__lockout.html#gab1b7b6dc6f81ca9524467f5024681167">multicore_lockout_end_blocking</a> (void)</td></tr>
 263 <tr class="memdesc:gab1b7b6dc6f81ca9524467f5024681167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the other core from a locked out state amd wait for it to acknowledge.  <a href="group__multicore__lockout.html#gab1b7b6dc6f81ca9524467f5024681167">More...</a><br /></td></tr>
 264 <tr class="separator:gab1b7b6dc6f81ca9524467f5024681167"><td class="memSeparator" colspan="2">&#160;</td></tr>
 265 <tr class="memitem:gad61a822f1b135db1be62c19754694fe2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__lockout.html#gad61a822f1b135db1be62c19754694fe2">multicore_lockout_end_timeout_us</a> (uint64_t timeout_us)</td></tr>
 266 <tr class="memdesc:gad61a822f1b135db1be62c19754694fe2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the other core from a locked out state amd wait up to a time limit for it to acknowledge.  <a href="group__multicore__lockout.html#gad61a822f1b135db1be62c19754694fe2">More...</a><br /></td></tr>
 267 <tr class="separator:gad61a822f1b135db1be62c19754694fe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 268 </table>
 269 </div><!-- contents -->
 270 </div><!-- doc-content -->
 271
 272         <script src="main.js"></script>
 273 </body>
 274 </html>