namespacetk_1_1detail.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.18.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>tinykernel: tk::detail Namespace Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="codefolding.js"></script>
  11. <script type="text/javascript" src="clipboard.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="navtreedata.js"></script>
  14. <script type="text/javascript" src="navtree.js"></script>
  15. <script type="text/javascript" src="cookie.js"></script>
  16. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  17. <script type="text/javascript" src="search/searchdata.js"></script>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. </head>
  21. <body>
  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23. <div id="titlearea">
  24. <table cellspacing="0" cellpadding="0">
  25. <tbody>
  26. <tr id="projectrow">
  27. <td id="projectalign">
  28. <div id="projectname">tinykernel
  29. </div>
  30. </td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. <!-- end header part -->
  36. <!-- Generated by Doxygen 1.18.0 -->
  37. <script type="text/javascript">
  38. let searchBox = new SearchBox("searchBox", "search/",'.html');
  39. </script>
  40. <script type="text/javascript">
  41. document.addEventListener('DOMContentLoaded', codefold.init);
  42. </script>
  43. <script type="application/json" id="doxygen-config">
  44. {
  45. "relPath": "",
  46. "generateTreeView": true,
  47. "searchEngine": true,
  48. "serverBasedSearch": false,
  49. "disableIndex": false,
  50. "dynamicMenus": true,
  51. "fullSidebar": false
  52. }
  53. </script>
  54. <script type="text/javascript" src="menudata.js"></script>
  55. <script type="text/javascript" src="menu.js"></script>
  56. <div id="main-nav-mobile">
  57. <div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
  58. <label class="main-menu-btn" for="main-menu-state">
  59. <span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
  60. <span id="searchBoxPos1"></span>
  61. </div>
  62. </div><!-- main-nav-mobile -->
  63. <div id="main-nav">
  64. <ul class="sm sm-dox" id="main-menu">
  65. <li id="searchBoxPos2">
  66. <div id="MSearchBox" class="MSearchBoxInactive">
  67. <span class="left">
  68. <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
  69. <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
  70. </span><span class="right">
  71. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
  72. </span>
  73. </div>
  74. </li>
  75. </ul>
  76. </div><!-- main-nav -->
  77. </div><!-- top -->
  78. <div id="side-nav" class="ui-resizable side-nav-resizable">
  79. <div id="nav-tree">
  80. <div id="nav-tree-contents">
  81. <div id="nav-sync" class="sync"></div>
  82. </div>
  83. </div>
  84. <div id="splitbar" class="ui-resizable-handle">
  85. </div>
  86. </div>
  87. <script type="text/javascript">
  88. document.addEventListener('DOMContentLoaded',() => { initNavTree('namespacetk_1_1detail.html','',''); });
  89. </script>
  90. <div id="container">
  91. <div id="doc-content">
  92. <!-- window showing the filter options -->
  93. <div id="MSearchSelectWindow">
  94. </div>
  95. <!-- iframe showing the search results (closed by default) -->
  96. <div id="MSearchResultsWindow">
  97. <div id="MSearchResults">
  98. <div class="SRPage">
  99. <div id="SRIndex">
  100. <div id="SRResults"></div>
  101. <div class="SRStatus" id="Loading">Loading...</div>
  102. <div class="SRStatus" id="Searching">Searching...</div>
  103. <div class="SRStatus" id="NoMatches">No Matches</div>
  104. </div>
  105. </div>
  106. </div>
  107. </div>
  108. <div class="header">
  109. <div class="headertitle"><div class="title">tk::detail Namespace Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
  114. Functions</h2></td></tr>
  115. <tr class="memitem:a447e4ec89b3f2748451891219b7e3738" id="r_a447e4ec89b3f2748451891219b7e3738"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a447e4ec89b3f2748451891219b7e3738">static_register</a> (const char *name, <a class="el" href="namespacetk.html#a8908cf1e54cdc4e14ac3003126722cfc">TaskFn</a> fn, uint32_t prio)</td></tr>
  116. <tr class="memitem:a5b8fa6406a867edf8c4410fcb03c6523" id="r_a5b8fa6406a867edf8c4410fcb03c6523"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a5b8fa6406a867edf8c4410fcb03c6523">sched_lock</a> ()</td></tr>
  117. <tr class="memitem:a80be9b2429346faf161eab01f595684b" id="r_a80be9b2429346faf161eab01f595684b"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a80be9b2429346faf161eab01f595684b">sched_unlock</a> (uint32_t save)</td></tr>
  118. <tr class="memitem:a400363f36b5fb5dfc8aec11334471d0d" id="r_a400363f36b5fb5dfc8aec11334471d0d"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a400363f36b5fb5dfc8aec11334471d0d">block_current_task_locked</a> ()</td></tr>
  119. <tr class="memitem:ab19385598f18560cb574cc86174ececa" id="r_ab19385598f18560cb574cc86174ececa"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#ab19385598f18560cb574cc86174ececa">wake_task_locked</a> (<a class="el" href="structtk_1_1_task_handle.html">TaskHandle</a> handle)</td></tr>
  120. <tr class="memitem:a73a80d92a172d565201f99e8f31278e4" id="r_a73a80d92a172d565201f99e8f31278e4"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a73a80d92a172d565201f99e8f31278e4">current_task_slot</a> ()</td></tr>
  121. <tr class="memitem:a70ba35e0daee086ad86770f1e39c9b35" id="r_a70ba35e0daee086ad86770f1e39c9b35"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a70ba35e0daee086ad86770f1e39c9b35">find_highest_prio_waiter</a> (<a class="el" href="namespacetk.html#add371a241ec6c1695ef4e67935317edd">task_mask_t</a> wait_mask)</td></tr>
  122. </table>
  123. <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
  124. <a id="a400363f36b5fb5dfc8aec11334471d0d" name="a400363f36b5fb5dfc8aec11334471d0d"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#a400363f36b5fb5dfc8aec11334471d0d">&#9670;&#160;</a></span>block_current_task_locked()</h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">void tk::detail::block_current_task_locked </td>
  131. <td>(</td>
  132. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. </div>
  138. </div>
  139. <a id="a73a80d92a172d565201f99e8f31278e4" name="a73a80d92a172d565201f99e8f31278e4"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#a73a80d92a172d565201f99e8f31278e4">&#9670;&#160;</a></span>current_task_slot()</h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">uint8_t tk::detail::current_task_slot </td>
  146. <td>(</td>
  147. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  148. <td></td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. </div>
  153. </div>
  154. <a id="a70ba35e0daee086ad86770f1e39c9b35" name="a70ba35e0daee086ad86770f1e39c9b35"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#a70ba35e0daee086ad86770f1e39c9b35">&#9670;&#160;</a></span>find_highest_prio_waiter()</h2>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">uint8_t tk::detail::find_highest_prio_waiter </td>
  161. <td>(</td>
  162. <td class="paramtype"><a class="el" href="namespacetk.html#add371a241ec6c1695ef4e67935317edd">task_mask_t</a></td> <td class="paramname"><span class="paramname"><em>wait_mask</em></span></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. </div>
  168. </div>
  169. <a id="a5b8fa6406a867edf8c4410fcb03c6523" name="a5b8fa6406a867edf8c4410fcb03c6523"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a5b8fa6406a867edf8c4410fcb03c6523">&#9670;&#160;</a></span>sched_lock()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">uint32_t tk::detail::sched_lock </td>
  176. <td>(</td>
  177. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. </div>
  183. </div>
  184. <a id="a80be9b2429346faf161eab01f595684b" name="a80be9b2429346faf161eab01f595684b"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#a80be9b2429346faf161eab01f595684b">&#9670;&#160;</a></span>sched_unlock()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">void tk::detail::sched_unlock </td>
  191. <td>(</td>
  192. <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>save</em></span></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. </div>
  198. </div>
  199. <a id="a447e4ec89b3f2748451891219b7e3738" name="a447e4ec89b3f2748451891219b7e3738"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#a447e4ec89b3f2748451891219b7e3738">&#9670;&#160;</a></span>static_register()</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">void tk::detail::static_register </td>
  206. <td>(</td>
  207. <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype"><a class="el" href="namespacetk.html#a8908cf1e54cdc4e14ac3003126722cfc">TaskFn</a></td> <td class="paramname"><span class="paramname"><em>fn</em></span>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>prio</em></span>&#160;)</td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. </div>
  222. </div>
  223. <a id="ab19385598f18560cb574cc86174ececa" name="ab19385598f18560cb574cc86174ececa"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#ab19385598f18560cb574cc86174ececa">&#9670;&#160;</a></span>wake_task_locked()</h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">void tk::detail::wake_task_locked </td>
  230. <td>(</td>
  231. <td class="paramtype"><a class="el" href="structtk_1_1_task_handle.html">TaskHandle</a></td> <td class="paramname"><span class="paramname"><em>handle</em></span></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. </div>
  237. </div>
  238. </div><!-- contents -->
  239. </div><!-- doc-content -->
  240. <div id="page-nav" class="page-nav-panel">
  241. <div id="page-nav-resize-handle"></div>
  242. <div id="page-nav-tree">
  243. <div id="page-nav-contents">
  244. </div><!-- page-nav-contents -->
  245. </div><!-- page-nav-tree -->
  246. </div><!-- page-nav -->
  247. </div><!-- container -->
  248. <!-- start footer part -->
  249. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  250. <ul>
  251. <li class="navelem"><a href="namespacetk.html">tk</a></li><li class="navelem"><a href="namespacetk_1_1detail.html">detail</a></li>
  252. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.18.0 </li>
  253. </ul>
  254. </div>
  255. </body>
  256. </html>