web/docs/lock__core_8h_source.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/lock_core.h Source File</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('lock__core_8h_source.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="headertitle"><div class="title">lock_core.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="lock__core_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
 109 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.</span></div>
 110 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
 111 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
 112 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> */</span></div>
 113 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
 114 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef _PICO_LOCK_CORE_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_LOCK_CORE_H</span></div>
 116 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
 117 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="common_2pico__time_2include_2pico_2time_8h.html">pico/time.h</a>&quot;</span></div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &quot;<a class="code" href="rp2__common_2hardware__sync_2include_2hardware_2sync_8h.html">hardware/sync.h</a>&quot;</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
 121 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment">// PICO_CONFIG: PARAM_ASSERTIONS_ENABLED_LOCK_CORE, Enable/disable assertions in the lock core, type=bool, default=0, group=pico_sync</span></div>
 122 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#ifndef PARAM_ASSERTIONS_ENABLED_LOCK_CORE</span></div>
 123 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#define PARAM_ASSERTIONS_ENABLED_LOCK_CORE 0</span></div>
 124 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">#endif</span></div>
 125 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
 126 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structlock__core.html">   53</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structlock__core.html">lock_core</a> {</div>
 127 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>    <span class="comment">// spin lock protecting this lock&#39;s state</span></div>
 128 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>    spin_lock_t *spin_lock;</div>
 129 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
 130 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    <span class="comment">// note any lock members in containing structures need not be volatile;</span></div>
 131 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    <span class="comment">// they are protected by memory/compiler barriers when gaining and release spin locks</span></div>
 132 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>};</div>
 133 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
 134 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structlock__core.html">lock_core</a> <a class="code hl_struct" href="structlock__core.html">lock_core_t</a>;</div>
 135 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
 136 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__lock__core.html#gabc062dfb52c8f7f17ec8427d1c4414d9">lock_init</a>(<a class="code hl_struct" href="structlock__core.html">lock_core_t</a> *core, uint lock_num);</div>
 137 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
 138 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="preprocessor">#ifndef lock_owner_id_t</span></div>
 139 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="group__lock__core.html#ga7e5b614312aabaada704b6a2350d39bc">   81</a></span><span class="preprocessor">#define lock_owner_id_t int8_t</span></div>
 140 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="preprocessor">#endif</span></div>
 141 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
 142 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="preprocessor">#ifndef LOCK_INVALID_OWNER_ID</span></div>
 143 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="group__lock__core.html#ga56aa223ceb22fdc4f0a3464fff119e14">   88</a></span><span class="preprocessor">#define LOCK_INVALID_OWNER_ID ((lock_owner_id_t)-1)</span></div>
 144 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="preprocessor">#endif</span></div>
 145 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span> </div>
 146 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="preprocessor">#ifndef lock_get_caller_owner_id</span></div>
 147 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="group__lock__core.html#gae28f1d974cf1f1b973127500a764245c">   97</a></span><span class="preprocessor">#define lock_get_caller_owner_id() ((lock_owner_id_t)get_core_num())</span></div>
 148 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="preprocessor">#ifndef lock_is_owner_id_valid</span></div>
 149 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="preprocessor">#define lock_is_owner_id_valid(id) ((id)&gt;=0)</span></div>
 150 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="preprocessor">#endif</span></div>
 151 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="preprocessor">#endif</span></div>
 152 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span> </div>
 153 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">#ifndef lock_is_owner_id_valid</span></div>
 154 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="preprocessor">#define lock_is_owner_id_valid(id) ((id) != LOCK_INVALID_OWNER_ID)</span></div>
 155 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="preprocessor">#endif</span></div>
 156 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span> </div>
 157 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="preprocessor">#ifndef lock_internal_spin_unlock_with_wait</span></div>
 158 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"><a class="line" href="group__lock__core.html#gaaea64ba43b0ff683739ba136fe5a2b29">  128</a></span><span class="preprocessor">#define lock_internal_spin_unlock_with_wait(lock, save) spin_unlock((lock)-&gt;spin_lock, save), __wfe()</span></div>
 159 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="preprocessor">#endif</span></div>
 160 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span> </div>
 161 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="preprocessor">#ifndef lock_internal_spin_unlock_with_notify</span></div>
 162 <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="group__lock__core.html#ga298f38f465c9115393f0f35f56c13279">  151</a></span><span class="preprocessor">#define lock_internal_spin_unlock_with_notify(lock, save) spin_unlock((lock)-&gt;spin_lock, save), __sev()</span></div>
 163 <div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="preprocessor">#endif</span></div>
 164 <div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span> </div>
 165 <div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="preprocessor">#ifndef lock_internal_spin_unlock_with_best_effort_wait_or_timeout</span></div>
 166 <div class="line"><a id="l00177" name="l00177"></a><span class="lineno"><a class="line" href="group__lock__core.html#ga627a09221ed61634d6dfea6f406e104e">  177</a></span><span class="preprocessor">#define lock_internal_spin_unlock_with_best_effort_wait_or_timeout(lock, save, until) ({ \</span></div>
 167 <div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="preprocessor">    spin_unlock((lock)-&gt;spin_lock, save);                                                \</span></div>
 168 <div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="preprocessor">    best_effort_wfe_or_timeout(until);                                                   \</span></div>
 169 <div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="preprocessor">})</span></div>
 170 <div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="preprocessor">#endif</span></div>
 171 <div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span> </div>
 172 <div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="preprocessor">#ifndef sync_internal_yield_until_before</span></div>
 173 <div class="line"><a id="l00196" name="l00196"></a><span class="lineno"><a class="line" href="group__lock__core.html#ga133eb482d67637b8b4e947dee5133513">  196</a></span><span class="preprocessor">#define sync_internal_yield_until_before(until) ((void)0)</span></div>
 174 <div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="preprocessor">#endif</span></div>
 175 <div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span> </div>
 176 <div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="preprocessor">#endif</span></div>
 177 <div class="ttc" id="acommon_2pico__time_2include_2pico_2time_8h_html"><div class="ttname"><a href="common_2pico__time_2include_2pico_2time_8h.html">time.h</a></div></div>
 178 <div class="ttc" id="agroup__lock__core_html_gabc062dfb52c8f7f17ec8427d1c4414d9"><div class="ttname"><a href="group__lock__core.html#gabc062dfb52c8f7f17ec8427d1c4414d9">lock_init</a></div><div class="ttdeci">void lock_init(lock_core_t *core, uint lock_num)</div><div class="ttdoc">Initialise a lock structure.</div><div class="ttdef"><b>Definition:</b> lock_core.c:9</div></div>
 179 <div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
 180 <div class="ttc" id="arp2__common_2hardware__sync_2include_2hardware_2sync_8h_html"><div class="ttname"><a href="rp2__common_2hardware__sync_2include_2hardware_2sync_8h.html">sync.h</a></div></div>
 181 <div class="ttc" id="astructlock__core_html"><div class="ttname"><a href="structlock__core.html">lock_core</a></div><div class="ttdef"><b>Definition:</b> lock_core.h:53</div></div>
 182 </div><!-- fragment --></div><!-- contents -->
 183 </div><!-- doc-content -->
 184
 185         <script src="main.js"></script>
 186 </body>
 187 </html>