web/docs/mutex_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/mutex.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('mutex_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">mutex.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="mutex_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_MUTEX_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_MUTEX_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="lock__core_8h.html">pico/lock_core.h</a>&quot;</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#endif</span></div>
 122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
 123 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structrecursive__mutex__t.html">   47</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
 124 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>    <a class="code hl_struct" href="structlock__core.html">lock_core_t</a> core;</div>
 125 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>    <a class="code hl_define" href="group__lock__core.html#ga7e5b614312aabaada704b6a2350d39bc">lock_owner_id_t</a> owner;      </div>
 126 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structrecursive__mutex__t.html#a8e45994023c81c6f2933380905fa316e">   50</a></span>    uint8_t <a class="code hl_variable" href="structrecursive__mutex__t.html#a8e45994023c81c6f2933380905fa316e">enter_count</a>;        </div>
 127 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">#if PICO_MUTEX_ENABLE_SDK120_COMPATIBILITY</span></div>
 128 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    <span class="keywordtype">bool</span> recursive;</div>
 129 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#endif</span></div>
 130 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>} <a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a>;</div>
 131 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
 132 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="preprocessor">#if !PICO_MUTEX_ENABLE_SDK120_COMPATIBILITY</span></div>
 133 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structmutex.html">   60</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structmutex.html">mutex</a> {</div>
 134 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    <a class="code hl_struct" href="structlock__core.html">lock_core_t</a> core;</div>
 135 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>    <a class="code hl_define" href="group__lock__core.html#ga7e5b614312aabaada704b6a2350d39bc">lock_owner_id_t</a> owner;      </div>
 136 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="group__mutex.html#gac32ff6793a910bc7b48c8b0bb3c47ea7">   63</a></span>} <a class="code hl_typedef" href="group__mutex.html#gac32ff6793a910bc7b48c8b0bb3c47ea7">mutex_t</a>;</div>
 137 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">#else</span></div>
 138 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="keyword">typedef</span> <a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> <a class="code hl_typedef" href="group__mutex.html#gac32ff6793a910bc7b48c8b0bb3c47ea7">mutex_t</a>; <span class="comment">// they are one and the same when backwards compatible with SDK1.2.0</span></div>
 139 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">#endif</span></div>
 140 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
 141 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__mutex.html#gabe21d7ce624db2df7afe86c4bba400a2">mutex_init</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx);</div>
 142 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
 143 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__mutex.html#ga30d1f9d58564a1799e293451edc2d28e">recursive_mutex_init</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx);</div>
 144 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
 145 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="group__mutex.html#ga65b1c7af0545f478c80b51513d8f6993">   92</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__mutex.html#ga65b1c7af0545f478c80b51513d8f6993">mutex_enter_blocking</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx);</div>
 146 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span> </div>
 147 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="group__mutex.html#gad11f3d954d96cfdc77025735d35983e1">  102</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__mutex.html#gad11f3d954d96cfdc77025735d35983e1">recursive_mutex_enter_blocking</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx);</div>
 148 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
 149 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="group__mutex.html#gaa116de2f28fd7df8fb78b210e07b1ed4">  115</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#gaa116de2f28fd7df8fb78b210e07b1ed4">mutex_try_enter</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx, uint32_t *owner_out);</div>
 150 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span> </div>
 151 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="group__mutex.html#ga91088e6bd3929dcf86ed12cd92ee2cd8">  129</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#ga91088e6bd3929dcf86ed12cd92ee2cd8">mutex_try_enter_block_until</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx, <a class="code hl_typedef" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> until);</div>
 152 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span> </div>
 153 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="group__mutex.html#gae431bbb90e45cf9ae47130a5635aa2b0">  143</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#gae431bbb90e45cf9ae47130a5635aa2b0">recursive_mutex_try_enter</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx, uint32_t *owner_out);</div>
 154 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span> </div>
 155 <div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="group__mutex.html#ga32c6e468289a81a49b4bde50a6280f83">  156</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#ga32c6e468289a81a49b4bde50a6280f83">mutex_enter_timeout_ms</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx, uint32_t timeout_ms);</div>
 156 <div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span> </div>
 157 <div class="line"><a id="l00170" name="l00170"></a><span class="lineno"><a class="line" href="group__mutex.html#gad54a0bdb7967571caecb62869bd4194d">  170</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#gad54a0bdb7967571caecb62869bd4194d">recursive_mutex_enter_timeout_ms</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx, uint32_t timeout_ms);</div>
 158 <div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span> </div>
 159 <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"><a class="line" href="group__mutex.html#ga553f33e9692a19f8ad956a8b770858e0">  184</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#ga553f33e9692a19f8ad956a8b770858e0">mutex_enter_timeout_us</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx, uint32_t timeout_us);</div>
 160 <div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span> </div>
 161 <div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="group__mutex.html#gaeeb630a7c13ed3adc567e62c8c737401">  198</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#gaeeb630a7c13ed3adc567e62c8c737401">recursive_mutex_enter_timeout_us</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx, uint32_t timeout_us);</div>
 162 <div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span> </div>
 163 <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"><a class="line" href="group__mutex.html#ga69e2f75f0a38378b20c0f2bf9cc7bbe3">  212</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#ga69e2f75f0a38378b20c0f2bf9cc7bbe3">mutex_enter_block_until</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx, <a class="code hl_typedef" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> until);</div>
 164 <div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span> </div>
 165 <div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="group__mutex.html#ga6ce3ca26cbce71a3e29396264e00e253">  226</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#ga6ce3ca26cbce71a3e29396264e00e253">recursive_mutex_enter_block_until</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx, <a class="code hl_typedef" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> until);</div>
 166 <div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span> </div>
 167 <div class="line"><a id="l00233" name="l00233"></a><span class="lineno"><a class="line" href="group__mutex.html#gaf528c8fbb5f4532758859d18e24e1673">  233</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__mutex.html#gaf528c8fbb5f4532758859d18e24e1673">mutex_exit</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx);</div>
 168 <div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span> </div>
 169 <div class="line"><a id="l00240" name="l00240"></a><span class="lineno"><a class="line" href="group__mutex.html#ga2f75321a04ba731f5875353fbaebc345">  240</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__mutex.html#ga2f75321a04ba731f5875353fbaebc345">recursive_mutex_exit</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx);</div>
 170 <div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span> </div>
 171 <div class="line"><a id="l00248" name="l00248"></a><span class="lineno"><a class="line" href="group__mutex.html#gae4b5ca3e872a6823f6580f1388b6585e">  248</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#gae4b5ca3e872a6823f6580f1388b6585e">mutex_is_initialized</a>(<a class="code hl_struct" href="structmutex.html">mutex_t</a> *mtx) {</div>
 172 <div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>    <span class="keywordflow">return</span> mtx-&gt;core.spin_lock != 0;</div>
 173 <div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span>}</div>
 174 <div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span> </div>
 175 <div class="line"><a id="l00258" name="l00258"></a><span class="lineno"><a class="line" href="group__mutex.html#ga97e45154e86f0d206665bbce779d112d">  258</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__mutex.html#ga97e45154e86f0d206665bbce779d112d">recursive_mutex_is_initialized</a>(<a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> *mtx) {</div>
 176 <div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span>    <span class="keywordflow">return</span> mtx-&gt;core.spin_lock != 0;</div>
 177 <div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span>}</div>
 178 <div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span> </div>
 179 <div class="line"><a id="l00283" name="l00283"></a><span class="lineno"><a class="line" href="group__mutex.html#gaa1b5d9dea897013fc5e40bf102045592">  283</a></span><span class="preprocessor">#define auto_init_mutex(name) static __attribute__((section(&quot;.mutex_array&quot;</span>))) mutex_t name</div>
 180 <div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span> </div>
 181 <div class="line"><a id="l00306" name="l00306"></a><span class="lineno"><a class="line" href="group__mutex.html#ga3c019cd595a52ee87e06bdf20e427660">  306</a></span><span class="preprocessor">#define auto_init_recursive_mutex(name) static __attribute__((section(&quot;.mutex_array&quot;</span>))) recursive_mutex_t name = { .core = { .spin_lock = (spin_lock_t *)1 <span class="comment">/* marker for runtime_init */</span><span class="preprocessor"> }, .owner = 0, .enter_count = 0 }</span></div>
 182 <div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span> </div>
 183 <div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="keywordtype">void</span> runtime_init_mutex(<span class="keywordtype">void</span>);</div>
 184 <div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span> </div>
 185 <div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 186 <div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span>}</div>
 187 <div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="preprocessor">#endif</span></div>
 188 <div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="preprocessor">#endif</span></div>
 189 <div class="ttc" id="agroup__lock__core_html_ga7e5b614312aabaada704b6a2350d39bc"><div class="ttname"><a href="group__lock__core.html#ga7e5b614312aabaada704b6a2350d39bc">lock_owner_id_t</a></div><div class="ttdeci">#define lock_owner_id_t</div><div class="ttdoc">type to use to store the 'owner' of a lock.</div><div class="ttdef"><b>Definition:</b> lock_core.h:81</div></div>
 190 <div class="ttc" id="agroup__mutex_html_ga2f75321a04ba731f5875353fbaebc345"><div class="ttname"><a href="group__mutex.html#ga2f75321a04ba731f5875353fbaebc345">recursive_mutex_exit</a></div><div class="ttdeci">void recursive_mutex_exit(recursive_mutex_t *mtx)</div><div class="ttdoc">Release ownership of a recursive mutex.</div></div>
 191 <div class="ttc" id="agroup__mutex_html_ga30d1f9d58564a1799e293451edc2d28e"><div class="ttname"><a href="group__mutex.html#ga30d1f9d58564a1799e293451edc2d28e">recursive_mutex_init</a></div><div class="ttdeci">void recursive_mutex_init(recursive_mutex_t *mtx)</div><div class="ttdoc">Initialise a recursive mutex structure.</div><div class="ttdef"><b>Definition:</b> mutex.c:52</div></div>
 192 <div class="ttc" id="agroup__mutex_html_ga32c6e468289a81a49b4bde50a6280f83"><div class="ttname"><a href="group__mutex.html#ga32c6e468289a81a49b4bde50a6280f83">mutex_enter_timeout_ms</a></div><div class="ttdeci">bool mutex_enter_timeout_ms(mutex_t *mtx, uint32_t timeout_ms)</div><div class="ttdoc">Wait for mutex with timeout.</div></div>
 193 <div class="ttc" id="agroup__mutex_html_ga553f33e9692a19f8ad956a8b770858e0"><div class="ttname"><a href="group__mutex.html#ga553f33e9692a19f8ad956a8b770858e0">mutex_enter_timeout_us</a></div><div class="ttdeci">bool mutex_enter_timeout_us(mutex_t *mtx, uint32_t timeout_us)</div><div class="ttdoc">Wait for mutex with timeout.</div></div>
 194 <div class="ttc" id="agroup__mutex_html_ga65b1c7af0545f478c80b51513d8f6993"><div class="ttname"><a href="group__mutex.html#ga65b1c7af0545f478c80b51513d8f6993">mutex_enter_blocking</a></div><div class="ttdeci">void mutex_enter_blocking(mutex_t *mtx)</div><div class="ttdoc">Take ownership of a mutex.</div></div>
 195 <div class="ttc" id="agroup__mutex_html_ga69e2f75f0a38378b20c0f2bf9cc7bbe3"><div class="ttname"><a href="group__mutex.html#ga69e2f75f0a38378b20c0f2bf9cc7bbe3">mutex_enter_block_until</a></div><div class="ttdeci">bool mutex_enter_block_until(mutex_t *mtx, absolute_time_t until)</div><div class="ttdoc">Wait for mutex until a specific time.</div></div>
 196 <div class="ttc" id="agroup__mutex_html_ga6ce3ca26cbce71a3e29396264e00e253"><div class="ttname"><a href="group__mutex.html#ga6ce3ca26cbce71a3e29396264e00e253">recursive_mutex_enter_block_until</a></div><div class="ttdeci">bool recursive_mutex_enter_block_until(recursive_mutex_t *mtx, absolute_time_t until)</div><div class="ttdoc">Wait for mutex until a specific time.</div></div>
 197 <div class="ttc" id="agroup__mutex_html_ga91088e6bd3929dcf86ed12cd92ee2cd8"><div class="ttname"><a href="group__mutex.html#ga91088e6bd3929dcf86ed12cd92ee2cd8">mutex_try_enter_block_until</a></div><div class="ttdeci">bool mutex_try_enter_block_until(mutex_t *mtx, absolute_time_t until)</div><div class="ttdoc">Attempt to take ownership of a mutex until the specified time.</div></div>
 198 <div class="ttc" id="agroup__mutex_html_ga97e45154e86f0d206665bbce779d112d"><div class="ttname"><a href="group__mutex.html#ga97e45154e86f0d206665bbce779d112d">recursive_mutex_is_initialized</a></div><div class="ttdeci">static bool recursive_mutex_is_initialized(recursive_mutex_t *mtx)</div><div class="ttdoc">Test for recursive mutex initialized state.</div><div class="ttdef"><b>Definition:</b> mutex.h:258</div></div>
 199 <div class="ttc" id="agroup__mutex_html_gaa116de2f28fd7df8fb78b210e07b1ed4"><div class="ttname"><a href="group__mutex.html#gaa116de2f28fd7df8fb78b210e07b1ed4">mutex_try_enter</a></div><div class="ttdeci">bool mutex_try_enter(mutex_t *mtx, uint32_t *owner_out)</div><div class="ttdoc">Attempt to take ownership of a mutex.</div></div>
 200 <div class="ttc" id="agroup__mutex_html_gabe21d7ce624db2df7afe86c4bba400a2"><div class="ttname"><a href="group__mutex.html#gabe21d7ce624db2df7afe86c4bba400a2">mutex_init</a></div><div class="ttdeci">void mutex_init(mutex_t *mtx)</div><div class="ttdoc">Initialise a mutex structure.</div><div class="ttdef"><b>Definition:</b> mutex.c:43</div></div>
 201 <div class="ttc" id="agroup__mutex_html_gac32ff6793a910bc7b48c8b0bb3c47ea7"><div class="ttname"><a href="group__mutex.html#gac32ff6793a910bc7b48c8b0bb3c47ea7">mutex_t</a></div><div class="ttdeci">struct mutex mutex_t</div><div class="ttdoc">regular (non recursive) mutex instance</div></div>
 202 <div class="ttc" id="agroup__mutex_html_gad11f3d954d96cfdc77025735d35983e1"><div class="ttname"><a href="group__mutex.html#gad11f3d954d96cfdc77025735d35983e1">recursive_mutex_enter_blocking</a></div><div class="ttdeci">void recursive_mutex_enter_blocking(recursive_mutex_t *mtx)</div><div class="ttdoc">Take ownership of a recursive mutex.</div></div>
 203 <div class="ttc" id="agroup__mutex_html_gad54a0bdb7967571caecb62869bd4194d"><div class="ttname"><a href="group__mutex.html#gad54a0bdb7967571caecb62869bd4194d">recursive_mutex_enter_timeout_ms</a></div><div class="ttdeci">bool recursive_mutex_enter_timeout_ms(recursive_mutex_t *mtx, uint32_t timeout_ms)</div><div class="ttdoc">Wait for recursive mutex with timeout.</div></div>
 204 <div class="ttc" id="agroup__mutex_html_gae431bbb90e45cf9ae47130a5635aa2b0"><div class="ttname"><a href="group__mutex.html#gae431bbb90e45cf9ae47130a5635aa2b0">recursive_mutex_try_enter</a></div><div class="ttdeci">bool recursive_mutex_try_enter(recursive_mutex_t *mtx, uint32_t *owner_out)</div><div class="ttdoc">Attempt to take ownership of a recursive mutex.</div></div>
 205 <div class="ttc" id="agroup__mutex_html_gae4b5ca3e872a6823f6580f1388b6585e"><div class="ttname"><a href="group__mutex.html#gae4b5ca3e872a6823f6580f1388b6585e">mutex_is_initialized</a></div><div class="ttdeci">static bool mutex_is_initialized(mutex_t *mtx)</div><div class="ttdoc">Test for mutex initialized state.</div><div class="ttdef"><b>Definition:</b> mutex.h:248</div></div>
 206 <div class="ttc" id="agroup__mutex_html_gaeeb630a7c13ed3adc567e62c8c737401"><div class="ttname"><a href="group__mutex.html#gaeeb630a7c13ed3adc567e62c8c737401">recursive_mutex_enter_timeout_us</a></div><div class="ttdeci">bool recursive_mutex_enter_timeout_us(recursive_mutex_t *mtx, uint32_t timeout_us)</div><div class="ttdoc">Wait for recursive mutex with timeout.</div></div>
 207 <div class="ttc" id="agroup__mutex_html_gaf528c8fbb5f4532758859d18e24e1673"><div class="ttname"><a href="group__mutex.html#gaf528c8fbb5f4532758859d18e24e1673">mutex_exit</a></div><div class="ttdeci">void mutex_exit(mutex_t *mtx)</div><div class="ttdoc">Release ownership of a mutex.</div></div>
 208 <div class="ttc" id="agroup__timestamp_html_ga8b7f3d602cc053f05bacceeacc257ed8"><div class="ttname"><a href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a></div><div class="ttdeci">uint64_t absolute_time_t</div><div class="ttdoc">An opaque 64 bit timestamp in microseconds.</div><div class="ttdef"><b>Definition:</b> types.h:43</div></div>
 209 <div class="ttc" id="alock__core_8h_html"><div class="ttname"><a href="lock__core_8h.html">lock_core.h</a></div></div>
 210 <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>
 211 <div class="ttc" id="astructmutex_html"><div class="ttname"><a href="structmutex.html">mutex</a></div><div class="ttdoc">regular (non recursive) mutex instance</div><div class="ttdef"><b>Definition:</b> mutex.h:60</div></div>
 212 <div class="ttc" id="astructrecursive__mutex__t_html"><div class="ttname"><a href="structrecursive__mutex__t.html">recursive_mutex_t</a></div><div class="ttdoc">recursive mutex instance</div><div class="ttdef"><b>Definition:</b> mutex.h:47</div></div>
 213 <div class="ttc" id="astructrecursive__mutex__t_html_a8e45994023c81c6f2933380905fa316e"><div class="ttname"><a href="structrecursive__mutex__t.html#a8e45994023c81c6f2933380905fa316e">recursive_mutex_t::enter_count</a></div><div class="ttdeci">uint8_t enter_count</div><div class="ttdoc">owner id LOCK_INVALID_OWNER_ID for unowned</div><div class="ttdef"><b>Definition:</b> mutex.h:50</div></div>
 214 </div><!-- fragment --></div><!-- contents -->
 215 </div><!-- doc-content -->
 216
 217         <script src="main.js"></script>
 218 </body>
 219 </html>