web/docs/async__context__threadsafe__background_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: pico_async_context/include/pico/async_context_threadsafe_background.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                                 v1.5.1
  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('async__context__threadsafe__background_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">async_context_threadsafe_background.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <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) 2022 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_ASYNC_CONTEXT_THREADSAFE_BACKGROUND_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_ASYNC_CONTEXT_THREADSAFE_BACKGROUND_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="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="async__context_8h.html">pico/async_context.h</a>&quot;</span></div>
 118 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="sem_8h.html">pico/sem.h</a>&quot;</span></div>
 119 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="mutex_8h.html">pico/mutex.h</a>&quot;</span></div>
 120 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="irq_8h.html">hardware/irq.h</a>&quot;</span></div>
 121 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
 122 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 123 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 124 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#endif</span></div>
 125 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
 126 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#ifndef ASYNC_CONTEXT_THREADSAFE_BACKGROUND_MULTI_CORE</span></div>
 127 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#define ASYNC_CONTEXT_THREADSAFE_BACKGROUND_MULTI_CORE LIB_PICO_MULTICORE</span></div>
 128 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#endif</span></div>
 129 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
 130 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background</a> <a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background_t</a>;</div>
 131 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
 132 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background__config.html">   38</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config</a> {</div>
 133 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background__config.html#aaeed113746710afc683e1495409d66d8">   42</a></span>    uint8_t <a class="code hl_variable" href="structasync__context__threadsafe__background__config.html#aaeed113746710afc683e1495409d66d8">low_priority_irq_handler_priority</a>;</div>
 134 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background__config.html#a8776bae13027752f07a4f3170b2c47b2">   53</a></span>    <a class="code hl_struct" href="structalarm__pool.html">alarm_pool_t</a> *<a class="code hl_variable" href="structasync__context__threadsafe__background__config.html#a8776bae13027752f07a4f3170b2c47b2">custom_alarm_pool</a>;</div>
 135 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>} <a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a>;</div>
 136 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
 137 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background.html">   56</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background</a> {</div>
 138 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    <a class="code hl_struct" href="structasync__context.html">async_context_t</a> core;</div>
 139 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    <a class="code hl_struct" href="structalarm__pool.html">alarm_pool_t</a> *<a class="code hl_struct" href="structalarm__pool.html">alarm_pool</a>; <span class="comment">// this must be on the same core as core_num</span></div>
 140 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    <a class="code hl_struct" href="structabsolute__time__t.html">absolute_time_t</a> last_set_alarm_time;</div>
 141 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    <a class="code hl_struct" href="struct____packed__aligned.html">recursive_mutex_t</a> lock_mutex;</div>
 142 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    semaphore_t work_needed_sem;</div>
 143 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>    <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__alarm.html#gaa593548569c182a0d65d2e06a9c3493b">alarm_id_t</a> alarm_id;</div>
 144 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#if ASYNC_CONTEXT_THREADSAFE_BACKGROUND_MULTI_CORE</span></div>
 145 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__alarm.html#gaa593548569c182a0d65d2e06a9c3493b">alarm_id_t</a> force_alarm_id;</div>
 146 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>    <span class="keywordtype">bool</span> alarm_pool_owned;</div>
 147 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">#endif</span></div>
 148 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>    uint8_t low_priority_irq_num;</div>
 149 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>    <span class="keyword">volatile</span> <span class="keywordtype">bool</span> alarm_pending;</div>
 150 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>};</div>
 151 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span> </div>
 152 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gabf48cafcbfa48c9fbef1aa7a18ded9e5">async_context_threadsafe_background_init</a>(<a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background_t</a> *self, <a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a> *config);</div>
 153 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
 154 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gaf8eafbbac141e7f24e377c708ffa1479">async_context_threadsafe_background_default_config</a>(<span class="keywordtype">void</span>);</div>
 155 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
 156 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="group__async__context__threadsafe__background.html#gab8bc5211f18cbc3a6817b1bf82020f8e">  103</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gab8bc5211f18cbc3a6817b1bf82020f8e">async_context_threadsafe_background_init_with_defaults</a>(<a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background_t</a> *self) {</div>
 157 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>    <a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a> config = <a class="code hl_function" href="group__async__context__threadsafe__background.html#gaf8eafbbac141e7f24e377c708ffa1479">async_context_threadsafe_background_default_config</a>();</div>
 158 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gabf48cafcbfa48c9fbef1aa7a18ded9e5">async_context_threadsafe_background_init</a>(self, &amp;config);</div>
 159 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>}</div>
 160 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span> </div>
 161 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 162 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>}</div>
 163 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="preprocessor">#endif</span></div>
 164 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span> </div>
 165 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="preprocessor">#endif</span></div>
 166 <div class="ttc" id="aasync__context_8h_html"><div class="ttname"><a href="async__context_8h.html">async_context.h</a></div></div>
 167 <div class="ttc" id="agroup__alarm_html_gaa593548569c182a0d65d2e06a9c3493b"><div class="ttname"><a href="group__alarm.html#gaa593548569c182a0d65d2e06a9c3493b">alarm_id_t</a></div><div class="ttdeci">int32_t alarm_id_t</div><div class="ttdoc">The identifier for an alarm.</div><div class="ttdef"><b>Definition:</b> time.h:359</div></div>
 168 <div class="ttc" id="agroup__async__context__threadsafe__background_html_gab8bc5211f18cbc3a6817b1bf82020f8e"><div class="ttname"><a href="group__async__context__threadsafe__background.html#gab8bc5211f18cbc3a6817b1bf82020f8e">async_context_threadsafe_background_init_with_defaults</a></div><div class="ttdeci">static bool async_context_threadsafe_background_init_with_defaults(async_context_threadsafe_background_t *self)</div><div class="ttdoc">Initialize an async_context_threadsafe_background instance with default values.</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:103</div></div>
 169 <div class="ttc" id="agroup__async__context__threadsafe__background_html_gabf48cafcbfa48c9fbef1aa7a18ded9e5"><div class="ttname"><a href="group__async__context__threadsafe__background.html#gabf48cafcbfa48c9fbef1aa7a18ded9e5">async_context_threadsafe_background_init</a></div><div class="ttdeci">bool async_context_threadsafe_background_init(async_context_threadsafe_background_t *self, async_context_threadsafe_background_config_t *config)</div><div class="ttdoc">Initialize an async_context_threadsafe_background instance using the specified configuration.</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.c:195</div></div>
 170 <div class="ttc" id="agroup__async__context__threadsafe__background_html_gaf8eafbbac141e7f24e377c708ffa1479"><div class="ttname"><a href="group__async__context__threadsafe__background.html#gaf8eafbbac141e7f24e377c708ffa1479">async_context_threadsafe_background_default_config</a></div><div class="ttdeci">async_context_threadsafe_background_config_t async_context_threadsafe_background_default_config(void)</div><div class="ttdoc">Return a copy of the default configuration object used by async_context_threadsafe_background_init_wi...</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.c:28</div></div>
 171 <div class="ttc" id="airq_8h_html"><div class="ttname"><a href="irq_8h.html">irq.h</a></div></div>
 172 <div class="ttc" id="amutex_8h_html"><div class="ttname"><a href="mutex_8h.html">mutex.h</a></div></div>
 173 <div class="ttc" id="asem_8h_html"><div class="ttname"><a href="sem_8h.html">sem.h</a></div></div>
 174 <div class="ttc" id="astruct____packed__aligned_html"><div class="ttname"><a href="struct____packed__aligned.html">__packed_aligned</a></div><div class="ttdoc">recursive mutex instance</div><div class="ttdef"><b>Definition:</b> mutex.h:47</div></div>
 175 <div class="ttc" id="astructabsolute__time__t_html"><div class="ttname"><a href="structabsolute__time__t.html">absolute_time_t</a></div><div class="ttdef"><b>Definition:</b> types.h:33</div></div>
 176 <div class="ttc" id="astructalarm__pool_html"><div class="ttname"><a href="structalarm__pool.html">alarm_pool</a></div><div class="ttdef"><b>Definition:</b> time.c:25</div></div>
 177 <div class="ttc" id="astructasync__context__threadsafe__background__config_html"><div class="ttname"><a href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config</a></div><div class="ttdoc">Configuration object for async_context_threadsafe_background instances.</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:38</div></div>
 178 <div class="ttc" id="astructasync__context__threadsafe__background__config_html_a8776bae13027752f07a4f3170b2c47b2"><div class="ttname"><a href="structasync__context__threadsafe__background__config.html#a8776bae13027752f07a4f3170b2c47b2">async_context_threadsafe_background_config::custom_alarm_pool</a></div><div class="ttdeci">alarm_pool_t * custom_alarm_pool</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:53</div></div>
 179 <div class="ttc" id="astructasync__context__threadsafe__background__config_html_aaeed113746710afc683e1495409d66d8"><div class="ttname"><a href="structasync__context__threadsafe__background__config.html#aaeed113746710afc683e1495409d66d8">async_context_threadsafe_background_config::low_priority_irq_handler_priority</a></div><div class="ttdeci">uint8_t low_priority_irq_handler_priority</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:42</div></div>
 180 <div class="ttc" id="astructasync__context__threadsafe__background_html"><div class="ttname"><a href="structasync__context__threadsafe__background.html">async_context_threadsafe_background</a></div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:56</div></div>
 181 <div class="ttc" id="astructasync__context_html"><div class="ttname"><a href="structasync__context.html">async_context</a></div><div class="ttdoc">Base structure type of all async_contexts. For details about its use, see pico_async_context.</div><div class="ttdef"><b>Definition:</b> async_context.h:179</div></div>
 182 </div><!-- fragment --></div><!-- contents -->
 183 </div><!-- doc-content -->
 184
 185         <script src="main.js"></script>
 186 </body>
 187 </html>