web/docs/async__context__freertos_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/async_context_freertos.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('async__context__freertos_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_freertos.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_FREERTOS_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_FREERTOS_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="l00017" name="l00017"></a><span class="lineno">   17</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="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
 119 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment">// FreeRTOS includes</span></div>
 120 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;FreeRTOS.h&quot;</span></div>
 121 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;semphr.h&quot;</span></div>
 122 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;timers.h&quot;</span></div>
 123 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
 124 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 125 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 126 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#endif</span></div>
 127 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
 128 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#ifndef ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_PRIORITY</span></div>
 129 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#define ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_PRIORITY ( tskIDLE_PRIORITY + 4)</span></div>
 130 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#endif</span></div>
 131 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
 132 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#ifndef ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_STACK_SIZE</span></div>
 133 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_STACK_SIZE configMINIMAL_STACK_SIZE</span></div>
 134 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="preprocessor">#endif</span></div>
 135 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
 136 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__freertos.html">async_context_freertos</a> <a class="code hl_struct" href="structasync__context__freertos.html">async_context_freertos_t</a>;</div>
 137 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
 138 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#if !defined(configNUMBER_OF_CORES) &amp;&amp; defined(configNUM_CORES)</span></div>
 139 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#if !portSUPPORT_SMP</span></div>
 140 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#error configNUMBER_OF_CORES is the new name for configNUM_CORES</span></div>
 141 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#else</span></div>
 142 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">// portSUPPORT_SMP was defined in old smp branch</span></div>
 143 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#error configNUMBER_OF_CORES is the new name for configNUM_CORES, however it looks like you may need to define both as you are using an old SMP branch of FreeRTOS</span></div>
 144 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">#endif</span></div>
 145 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#endif</span></div>
 146 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
 147 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structasync__context__freertos__config.html">   50</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__freertos__config.html">async_context_freertos_config</a> {</div>
 148 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structasync__context__freertos__config.html#ad4dbeaa1021be2f2256147120384c19a">   54</a></span>    UBaseType_t <a class="code hl_variable" href="structasync__context__freertos__config.html#ad4dbeaa1021be2f2256147120384c19a">task_priority</a>;</div>
 149 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="structasync__context__freertos__config.html#aeeea63a88da44bcc2af6cb8c34fda1cb">   58</a></span>    configSTACK_DEPTH_TYPE <a class="code hl_variable" href="structasync__context__freertos__config.html#aeeea63a88da44bcc2af6cb8c34fda1cb">task_stack_size</a>;</div>
 150 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#if configUSE_CORE_AFFINITY &amp;&amp; configNUMBER_OF_CORES &gt; 1</span></div>
 151 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    UBaseType_t task_core_id;</div>
 152 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">#endif</span></div>
 153 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>} <a class="code hl_struct" href="structasync__context__freertos__config.html">async_context_freertos_config_t</a>;</div>
 154 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
 155 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="structasync__context__freertos.html">   68</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__freertos.html">async_context_freertos</a> {</div>
 156 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>    <a class="code hl_struct" href="structasync__context.html">async_context_t</a> core;</div>
 157 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>    SemaphoreHandle_t lock_mutex;</div>
 158 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>    SemaphoreHandle_t work_needed_sem;</div>
 159 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    TimerHandle_t timer_handle;</div>
 160 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>    TaskHandle_t task_handle;</div>
 161 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>    uint8_t nesting;</div>
 162 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>    <span class="keyword">volatile</span> <span class="keywordtype">bool</span> task_should_exit;</div>
 163 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>};</div>
 164 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span> </div>
 165 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__async__context__freertos.html#ga2deda7edb010962737d8b614fdf2f6da">async_context_freertos_init</a>(<a class="code hl_struct" href="structasync__context__freertos.html">async_context_freertos_t</a> *self, <a class="code hl_struct" href="structasync__context__freertos__config.html">async_context_freertos_config_t</a> *config);</div>
 166 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span> </div>
 167 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="group__async__context__freertos.html#ga9cff526632c6dc26e8f3e7ab9784d83a">   98</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code hl_struct" href="structasync__context__freertos__config.html">async_context_freertos_config_t</a> <a class="code hl_function" href="group__async__context__freertos.html#ga9cff526632c6dc26e8f3e7ab9784d83a">async_context_freertos_default_config</a>(<span class="keywordtype">void</span>) {</div>
 168 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>    <a class="code hl_struct" href="structasync__context__freertos__config.html">async_context_freertos_config_t</a> config = {</div>
 169 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>            .<a class="code hl_variable" href="structasync__context__freertos__config.html#ad4dbeaa1021be2f2256147120384c19a">task_priority</a> = ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_PRIORITY,</div>
 170 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>            .task_stack_size = ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_STACK_SIZE,</div>
 171 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="preprocessor">#if configUSE_CORE_AFFINITY &amp;&amp; configNUMBER_OF_CORES &gt; 1</span></div>
 172 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>            .task_core_id = (UBaseType_t)-1, <span class="comment">// none</span></div>
 173 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>#endif</div>
 174 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>    };</div>
 175 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>    <span class="keywordflow">return</span> config;</div>
 176 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span> </div>
 177 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>}</div>
 178 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span> </div>
 179 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="group__async__context__freertos.html#ga90e97b53118205726fcb2253a21fa159">  120</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__freertos.html#ga90e97b53118205726fcb2253a21fa159">async_context_freertos_init_with_defaults</a>(<a class="code hl_struct" href="structasync__context__freertos.html">async_context_freertos_t</a> *self) {</div>
 180 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>    <a class="code hl_struct" href="structasync__context__freertos__config.html">async_context_freertos_config_t</a> config = <a class="code hl_function" href="group__async__context__freertos.html#ga9cff526632c6dc26e8f3e7ab9784d83a">async_context_freertos_default_config</a>();</div>
 181 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="group__async__context__freertos.html#ga2deda7edb010962737d8b614fdf2f6da">async_context_freertos_init</a>(self, &amp;config);</div>
 182 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>}</div>
 183 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span> </div>
 184 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 185 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>}</div>
 186 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="preprocessor">#endif</span></div>
 187 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span> </div>
 188 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="preprocessor">#endif</span></div>
 189 <div class="ttc" id="aasync__context_8h_html"><div class="ttname"><a href="async__context_8h.html">async_context.h</a></div></div>
 190 <div class="ttc" id="agroup__async__context__freertos_html_ga2deda7edb010962737d8b614fdf2f6da"><div class="ttname"><a href="group__async__context__freertos.html#ga2deda7edb010962737d8b614fdf2f6da">async_context_freertos_init</a></div><div class="ttdeci">bool async_context_freertos_init(async_context_freertos_t *self, async_context_freertos_config_t *config)</div><div class="ttdoc">Initialize an async_context_freertos instance using the specified configuration.</div><div class="ttdef"><b>Definition:</b> async_context_freertos.c:107</div></div>
 191 <div class="ttc" id="agroup__async__context__freertos_html_ga90e97b53118205726fcb2253a21fa159"><div class="ttname"><a href="group__async__context__freertos.html#ga90e97b53118205726fcb2253a21fa159">async_context_freertos_init_with_defaults</a></div><div class="ttdeci">static bool async_context_freertos_init_with_defaults(async_context_freertos_t *self)</div><div class="ttdoc">Initialize an async_context_freertos instance with default values.</div><div class="ttdef"><b>Definition:</b> async_context_freertos.h:120</div></div>
 192 <div class="ttc" id="agroup__async__context__freertos_html_ga9cff526632c6dc26e8f3e7ab9784d83a"><div class="ttname"><a href="group__async__context__freertos.html#ga9cff526632c6dc26e8f3e7ab9784d83a">async_context_freertos_default_config</a></div><div class="ttdeci">static async_context_freertos_config_t async_context_freertos_default_config(void)</div><div class="ttdoc">Return a copy of the default configuration object used by async_context_freertos_init_with_defaults()</div><div class="ttdef"><b>Definition:</b> async_context_freertos.h:98</div></div>
 193 <div class="ttc" id="astructasync__context__freertos__config_html"><div class="ttname"><a href="structasync__context__freertos__config.html">async_context_freertos_config</a></div><div class="ttdoc">Configuration object for async_context_freertos instances.</div><div class="ttdef"><b>Definition:</b> async_context_freertos.h:50</div></div>
 194 <div class="ttc" id="astructasync__context__freertos__config_html_ad4dbeaa1021be2f2256147120384c19a"><div class="ttname"><a href="structasync__context__freertos__config.html#ad4dbeaa1021be2f2256147120384c19a">async_context_freertos_config::task_priority</a></div><div class="ttdeci">UBaseType_t task_priority</div><div class="ttdoc">Task priority for the async_context task.</div><div class="ttdef"><b>Definition:</b> async_context_freertos.h:54</div></div>
 195 <div class="ttc" id="astructasync__context__freertos__config_html_aeeea63a88da44bcc2af6cb8c34fda1cb"><div class="ttname"><a href="structasync__context__freertos__config.html#aeeea63a88da44bcc2af6cb8c34fda1cb">async_context_freertos_config::task_stack_size</a></div><div class="ttdeci">configSTACK_DEPTH_TYPE task_stack_size</div><div class="ttdoc">Stack size for the async_context task.</div><div class="ttdef"><b>Definition:</b> async_context_freertos.h:58</div></div>
 196 <div class="ttc" id="astructasync__context__freertos_html"><div class="ttname"><a href="structasync__context__freertos.html">async_context_freertos</a></div><div class="ttdef"><b>Definition:</b> async_context_freertos.h:68</div></div>
 197 <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>
 198 </div><!-- fragment --></div><!-- contents -->
 199 </div><!-- doc-content -->
 200
 201         <script src="main.js"></script>
 202 </body>
 203 </html>