web/docs/group__pico__multicore.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: pico_multicore</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('group__pico__multicore.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="#groups">Modules</a> &#124;
 107 <a href="#define-members">Macros</a> &#124;
 108 <a href="#func-members">Functions</a>  </div>
 109   <div class="headertitle"><div class="title">pico_multicore<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a></div></div></div>
 110 </div><!--header-->
 111 <div class="contents">
 112
 113 <p>Adds support for running code on, and interacting with the second processor core (core 1).
 114 <a href="#details">More...</a></p>
 115 <table class="memberdecls">
 116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 117 Modules</h2></td></tr>
 118 <tr class="memitem:group__multicore__fifo"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__fifo.html">fifo</a></td></tr>
 119 <tr class="memdesc:group__multicore__fifo"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for the inter-core FIFOs. <br /></td></tr>
 120 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:group__multicore__doorbell"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__doorbell.html">doorbell</a></td></tr>
 122 <tr class="memdesc:group__multicore__doorbell"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions related to doorbells which a core can use to raise IRQs on itself or the other core. <br /></td></tr>
 123 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <tr class="memitem:group__multicore__lockout"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__multicore__lockout.html">lockout</a></td></tr>
 125 <tr class="memdesc:group__multicore__lockout"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions to enable one core to force the other core to pause execution in a known state. <br /></td></tr>
 126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 </table><table class="memberdecls">
 128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 129 Macros</h2></td></tr>
 130 <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>
 131 <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>
 132 <tr class="separator:ga1413ebfa65114c6f408f4675897ac5ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 </table><table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 135 Functions</h2></td></tr>
 136 <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>
 137 <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>
 138 <tr class="separator:gad7a189a5f44f0124d74aa5b206f9a262"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <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>
 140 <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>
 141 <tr class="separator:ga46ea5e2efc181aba1d4d1de06a375c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <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>
 143 <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>
 144 <tr class="separator:gac1926bb2da43016e5d14eb52c8c123f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <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>
 146 <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>
 147 <tr class="separator:gac3a24e275219229de49d1fb32e3c4ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 </table>
 149 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 150 <p >Adds support for running code on, and interacting with the second processor core (core 1). </p>
 151 <h2><a class="anchor" id="multicore_example"></a>
 152 Example</h2>
 153 <div class="fragment"><div class="line"> </div>
 154 <div class="line"><span class="preprocessor">#include &lt;<a class="code" href="stdio_8h.html">stdio.h</a>&gt;</span></div>
 155 <div class="line"><span class="preprocessor">#include &quot;<a class="code" href="stdlib_8h.html">pico/stdlib.h</a>&quot;</span></div>
 156 <div class="line"><span class="preprocessor">#include &quot;<a class="code" href="multicore_8h.html">pico/multicore.h</a>&quot;</span></div>
 157 <div class="line"> </div>
 158 <div class="line"><span class="preprocessor">#define FLAG_VALUE 123</span></div>
 159 <div class="line"> </div>
 160 <div class="line"><span class="keywordtype">void</span> core1_entry() {</div>
 161 <div class="line"> </div>
 162 <div class="line">    <a class="code hl_function" href="group__multicore__fifo.html#ga134933a693c53c4f94c9d3cd3cabfc79">multicore_fifo_push_blocking</a>(FLAG_VALUE);</div>
 163 <div class="line"> </div>
 164 <div class="line">    uint32_t g = <a class="code hl_function" href="group__multicore__fifo.html#ga929272dd1056d8ae05667beda4adb0fc">multicore_fifo_pop_blocking</a>();</div>
 165 <div class="line"> </div>
 166 <div class="line">    <span class="keywordflow">if</span> (g != FLAG_VALUE)</div>
 167 <div class="line">        printf(<span class="stringliteral">&quot;Hmm, that&#39;s not right on core 1!\n&quot;</span>);</div>
 168 <div class="line">    <span class="keywordflow">else</span></div>
 169 <div class="line">        printf(<span class="stringliteral">&quot;Its all gone well on core 1!&quot;</span>);</div>
 170 <div class="line"> </div>
 171 <div class="line">    <span class="keywordflow">while</span> (1)</div>
 172 <div class="line">        <a class="code hl_function" href="group__pico__platform.html#gab0d1ba75ceb64131e19f613d7a5313c9">tight_loop_contents</a>();</div>
 173 <div class="line">}</div>
 174 <div class="line"> </div>
 175 <div class="line"><span class="keywordtype">int</span> main() {</div>
 176 <div class="line">    <a class="code hl_function" href="group__pico__stdio.html#ga0e604311fb226dae91ff4eb17a19d67a">stdio_init_all</a>();</div>
 177 <div class="line">    printf(<span class="stringliteral">&quot;Hello, multicore!\n&quot;</span>);</div>
 178 <div class="line"> </div>
 179 <div class="line"> </div>
 180 <div class="line">    <a class="code hl_function" href="group__pico__multicore.html#ga46ea5e2efc181aba1d4d1de06a375c59">multicore_launch_core1</a>(core1_entry);</div>
 181 <div class="line"> </div>
 182 <div class="line">    <span class="comment">// Wait for it to start up</span></div>
 183 <div class="line"> </div>
 184 <div class="line">    uint32_t g = <a class="code hl_function" href="group__multicore__fifo.html#ga929272dd1056d8ae05667beda4adb0fc">multicore_fifo_pop_blocking</a>();</div>
 185 <div class="line"> </div>
 186 <div class="line">    <span class="keywordflow">if</span> (g != FLAG_VALUE)</div>
 187 <div class="line">        printf(<span class="stringliteral">&quot;Hmm, that&#39;s not right on core 0!\n&quot;</span>);</div>
 188 <div class="line">    <span class="keywordflow">else</span> {</div>
 189 <div class="line">        <a class="code hl_function" href="group__multicore__fifo.html#ga134933a693c53c4f94c9d3cd3cabfc79">multicore_fifo_push_blocking</a>(FLAG_VALUE);</div>
 190 <div class="line">        printf(<span class="stringliteral">&quot;It&#39;s all gone well on core 0!&quot;</span>);</div>
 191 <div class="line">    }</div>
 192 <div class="line"> </div>
 193 <div class="line">}</div>
 194 <div class="ttc" id="agroup__multicore__fifo_html_ga134933a693c53c4f94c9d3cd3cabfc79"><div class="ttname"><a href="group__multicore__fifo.html#ga134933a693c53c4f94c9d3cd3cabfc79">multicore_fifo_push_blocking</a></div><div class="ttdeci">void multicore_fifo_push_blocking(uint32_t data)</div><div class="ttdoc">Push data on to the write FIFO (data to the other core).</div><div class="ttdef"><b>Definition:</b> multicore.c:34</div></div>
 195 <div class="ttc" id="agroup__multicore__fifo_html_ga929272dd1056d8ae05667beda4adb0fc"><div class="ttname"><a href="group__multicore__fifo.html#ga929272dd1056d8ae05667beda4adb0fc">multicore_fifo_pop_blocking</a></div><div class="ttdeci">uint32_t multicore_fifo_pop_blocking(void)</div><div class="ttdoc">Pop data from the read FIFO (data from the other core).</div><div class="ttdef"><b>Definition:</b> multicore.c:53</div></div>
 196 <div class="ttc" id="agroup__pico__multicore_html_ga46ea5e2efc181aba1d4d1de06a375c59"><div class="ttname"><a href="group__pico__multicore.html#ga46ea5e2efc181aba1d4d1de06a375c59">multicore_launch_core1</a></div><div class="ttdeci">void multicore_launch_core1(void(*entry)(void))</div><div class="ttdoc">Run code on core 1.</div><div class="ttdef"><b>Definition:</b> multicore.c:155</div></div>
 197 <div class="ttc" id="agroup__pico__platform_html_gab0d1ba75ceb64131e19f613d7a5313c9"><div class="ttname"><a href="group__pico__platform.html#gab0d1ba75ceb64131e19f613d7a5313c9">tight_loop_contents</a></div><div class="ttdeci">static __force_inline void tight_loop_contents(void)</div><div class="ttdoc">No-op function for the body of tight loops.</div><div class="ttdef"><b>Definition:</b> platform.h:67</div></div>
 198 <div class="ttc" id="agroup__pico__stdio_html_ga0e604311fb226dae91ff4eb17a19d67a"><div class="ttname"><a href="group__pico__stdio.html#ga0e604311fb226dae91ff4eb17a19d67a">stdio_init_all</a></div><div class="ttdeci">bool stdio_init_all(void)</div><div class="ttdoc">Initialize all of the present standard stdio types that are linked into the binary.</div><div class="ttdef"><b>Definition:</b> stdio.c:200</div></div>
 199 <div class="ttc" id="amulticore_8h_html"><div class="ttname"><a href="multicore_8h.html">multicore.h</a></div></div>
 200 <div class="ttc" id="astdio_8h_html"><div class="ttname"><a href="stdio_8h.html">stdio.h</a></div></div>
 201 <div class="ttc" id="astdlib_8h_html"><div class="ttname"><a href="stdlib_8h.html">stdlib.h</a></div></div>
 202 </div><!-- fragment --> <h2 class="groupheader">Macro Definition Documentation</h2>
 203 <a id="ga1413ebfa65114c6f408f4675897ac5ee" name="ga1413ebfa65114c6f408f4675897ac5ee"></a>
 204 <h2 class="memtitle"><span class="permalink"><a href="#ga1413ebfa65114c6f408f4675897ac5ee">&#9670;&nbsp;</a></span>SIO_FIFO_IRQ_NUM</h2>
 205
 206 <div class="memitem">
 207 <div class="memproto">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname">#define SIO_FIFO_IRQ_NUM</td>
 211           <td>(</td>
 212           <td class="paramtype">&#160;</td>
 213           <td class="paramname">core</td><td>)</td>
 214           <td></td>
 215         </tr>
 216       </table>
 217 </div><div class="memdoc">
 218
 219 <p>Returns the <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a> for the FIFO IRQ on the given core. </p>
 220 <p >On RP2040 each core has a different IRQ number: <code>SIO_IRQ_PROC0</code> and <code>SIO_IRQ_PROC1</code>.   On RP2350 both cores share the same irq number (<code>SIO_IRQ_PROC</code>) just with a different SIO interrupt output routed to that IRQ input on each core. </p>
 221 <p >Note this macro is intended to resolve at compile time, and does no parameter checking </p>
 222
 223 </div>
 224 </div>
 225 <h2 class="groupheader">Function Documentation</h2>
 226 <a id="ga46ea5e2efc181aba1d4d1de06a375c59" name="ga46ea5e2efc181aba1d4d1de06a375c59"></a>
 227 <h2 class="memtitle"><span class="permalink"><a href="#ga46ea5e2efc181aba1d4d1de06a375c59">&#9670;&nbsp;</a></span>multicore_launch_core1()</h2>
 228
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname">void multicore_launch_core1 </td>
 234           <td>(</td>
 235           <td class="paramtype">void(*)(void)&#160;</td>
 236           <td class="paramname"><em>entry</em></td><td>)</td>
 237           <td></td>
 238         </tr>
 239       </table>
 240 </div><div class="memdoc">
 241
 242 <p>Run code on core 1. </p>
 243 <p >Wake up (a previously reset) core 1 and enter the given function on core 1 using the default core 1 stack (below core 0 stack).</p>
 244 <p >core 1 must previously have been reset either as a result of a system reset or by calling <a class="el" href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262">multicore_reset_core1</a></p>
 245 <p >core 1 will use the same vector table as core 0</p>
 246 <dl class="params"><dt>Parameters</dt><dd>
 247   <table class="params">
 248     <tr><td class="paramname">entry</td><td>Function entry point </td></tr>
 249   </table>
 250   </dd>
 251 </dl>
 252 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262" title="Reset core 1.">multicore_reset_core1</a> </dd></dl>
 253
 254 </div>
 255 </div>
 256 <a id="gac3a24e275219229de49d1fb32e3c4ef0" name="gac3a24e275219229de49d1fb32e3c4ef0"></a>
 257 <h2 class="memtitle"><span class="permalink"><a href="#gac3a24e275219229de49d1fb32e3c4ef0">&#9670;&nbsp;</a></span>multicore_launch_core1_raw()</h2>
 258
 259 <div class="memitem">
 260 <div class="memproto">
 261       <table class="memname">
 262         <tr>
 263           <td class="memname">void multicore_launch_core1_raw </td>
 264           <td>(</td>
 265           <td class="paramtype">void(*)(void)&#160;</td>
 266           <td class="paramname"><em>entry</em>, </td>
 267         </tr>
 268         <tr>
 269           <td class="paramkey"></td>
 270           <td></td>
 271           <td class="paramtype">uint32_t *&#160;</td>
 272           <td class="paramname"><em>sp</em>, </td>
 273         </tr>
 274         <tr>
 275           <td class="paramkey"></td>
 276           <td></td>
 277           <td class="paramtype">uint32_t&#160;</td>
 278           <td class="paramname"><em>vector_table</em>&#160;</td>
 279         </tr>
 280         <tr>
 281           <td></td>
 282           <td>)</td>
 283           <td></td><td></td>
 284         </tr>
 285       </table>
 286 </div><div class="memdoc">
 287
 288 <p>Launch code on core 1 with no stack protection. </p>
 289 <p >Wake up (a previously reset) core 1 and start it executing with a specific entry point, stack pointer and vector table.</p>
 290 <p >This is a low level function that does not provide a stack guard even if USE_STACK_GUARDS is defined</p>
 291 <p >core 1 must previously have been reset either as a result of a system reset or by calling <a class="el" href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262">multicore_reset_core1</a></p>
 292 <dl class="params"><dt>Parameters</dt><dd>
 293   <table class="params">
 294     <tr><td class="paramname">entry</td><td>Function entry point </td></tr>
 295     <tr><td class="paramname">sp</td><td>Pointer to the top of the core 1 stack </td></tr>
 296     <tr><td class="paramname">vector_table</td><td>address of the vector table to use for core 1 </td></tr>
 297   </table>
 298   </dd>
 299 </dl>
 300 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262" title="Reset core 1.">multicore_reset_core1</a> </dd></dl>
 301
 302 </div>
 303 </div>
 304 <a id="gac1926bb2da43016e5d14eb52c8c123f4" name="gac1926bb2da43016e5d14eb52c8c123f4"></a>
 305 <h2 class="memtitle"><span class="permalink"><a href="#gac1926bb2da43016e5d14eb52c8c123f4">&#9670;&nbsp;</a></span>multicore_launch_core1_with_stack()</h2>
 306
 307 <div class="memitem">
 308 <div class="memproto">
 309       <table class="memname">
 310         <tr>
 311           <td class="memname">void multicore_launch_core1_with_stack </td>
 312           <td>(</td>
 313           <td class="paramtype">void(*)(void)&#160;</td>
 314           <td class="paramname"><em>entry</em>, </td>
 315         </tr>
 316         <tr>
 317           <td class="paramkey"></td>
 318           <td></td>
 319           <td class="paramtype">uint32_t *&#160;</td>
 320           <td class="paramname"><em>stack_bottom</em>, </td>
 321         </tr>
 322         <tr>
 323           <td class="paramkey"></td>
 324           <td></td>
 325           <td class="paramtype">size_t&#160;</td>
 326           <td class="paramname"><em>stack_size_bytes</em>&#160;</td>
 327         </tr>
 328         <tr>
 329           <td></td>
 330           <td>)</td>
 331           <td></td><td></td>
 332         </tr>
 333       </table>
 334 </div><div class="memdoc">
 335
 336 <p>Launch code on core 1 with stack. </p>
 337 <p >Wake up (a previously reset) core 1 and enter the given function on core 1 using the passed stack for core 1</p>
 338 <p >core 1 must previously have been reset either as a result of a system reset or by calling <a class="el" href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262">multicore_reset_core1</a></p>
 339 <p >core 1 will use the same vector table as core 0</p>
 340 <dl class="params"><dt>Parameters</dt><dd>
 341   <table class="params">
 342     <tr><td class="paramname">entry</td><td>Function entry point </td></tr>
 343     <tr><td class="paramname">stack_bottom</td><td>The bottom (lowest address) of the stack </td></tr>
 344     <tr><td class="paramname">stack_size_bytes</td><td>The size of the stack in bytes (must be a multiple of 4) </td></tr>
 345   </table>
 346   </dd>
 347 </dl>
 348 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pico__multicore.html#gad7a189a5f44f0124d74aa5b206f9a262" title="Reset core 1.">multicore_reset_core1</a> </dd></dl>
 349
 350 </div>
 351 </div>
 352 <a id="gad7a189a5f44f0124d74aa5b206f9a262" name="gad7a189a5f44f0124d74aa5b206f9a262"></a>
 353 <h2 class="memtitle"><span class="permalink"><a href="#gad7a189a5f44f0124d74aa5b206f9a262">&#9670;&nbsp;</a></span>multicore_reset_core1()</h2>
 354
 355 <div class="memitem">
 356 <div class="memproto">
 357       <table class="memname">
 358         <tr>
 359           <td class="memname">void multicore_reset_core1 </td>
 360           <td>(</td>
 361           <td class="paramtype">void&#160;</td>
 362           <td class="paramname"></td><td>)</td>
 363           <td></td>
 364         </tr>
 365       </table>
 366 </div><div class="memdoc">
 367
 368 <p>Reset core 1. </p>
 369 <p >This function can be used to reset core 1 into its initial state (ready for launching code against via <a class="el" href="group__pico__multicore.html#ga46ea5e2efc181aba1d4d1de06a375c59">multicore_launch_core1</a> and similar methods)</p>
 370 <dl class="section note"><dt>Note</dt><dd>this function should only be called from core 0 </dd></dl>
 371
 372 </div>
 373 </div>
 374 </div><!-- contents -->
 375 </div><!-- doc-content -->
 376
 377         <script src="main.js"></script>
 378 </body>
 379 </html>