dirstructfiles.html 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Directory Structure and File Overview</title>
  7. <title>CMSIS-RTOS: Directory Structure and File Overview</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.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="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-RTOS
  35. &#160;<span id="projectnumber">Version 1.03</span>
  36. </div>
  37. <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation.</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('dirstructfiles.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="headertitle">
  109. <div class="title">Directory Structure and File Overview </div> </div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><p>The following section provides an overview of the directory structure and the files that are relevant for the user's for CMSIS-RTOS RTX.</p>
  113. <h1><a class="anchor" id="Folders"></a>
  114. CMSIS-RTOS RTX Directory Structure</h1>
  115. <p>The CMSIS-RTOS RTX is delivered in source code and several examples are provided.</p>
  116. <table class="cmtable" summary="CMSIS-RTOS RTX Library Files">
  117. <tr>
  118. <th>Directory </th><th>Content </th></tr>
  119. <tr>
  120. <td>INC </td><td>The include files for CMSIS-RTOS RTX. <a class="el" href="cmsis__os_8h.html">cmsis_os.h</a> is the central include file for user applications. </td></tr>
  121. <tr>
  122. <td>LIB </td><td>CMSIS-RTOS RTX library files for ARMCC, GCC, and IAR Compiler. </td></tr>
  123. <tr>
  124. <td>SRC </td><td>Source code of CMSIS-RTOS RTX library along with project files for ARMCC, GCC, and IAR Compiler. </td></tr>
  125. <tr>
  126. <td>Templates </td><td>CMSIS-RTOS RTX configuration file (<a class="el" href="dirstructfiles.html#RTX_Conf_CM">RTX_Conf_CM.c</a>). </td></tr>
  127. <tr>
  128. <td>UserCode Templates </td><td>Template files for creating application projects with CMSIS-RTOS RTX. </td></tr>
  129. </table>
  130. <h1><a class="anchor" id="libFiles"></a>
  131. CMSIS-RTOS RTX Library Files</h1>
  132. <p>The CMSIS-RTOS RTX Library is available pre-compiled for ARMCC, GCC, and IAR C/C++ Compilers and supports all Cortex-M processor variants in every configuration.</p>
  133. <table class="cmtable" summary="CMSIS-RTOS RTX Library Files">
  134. <tr>
  135. <th>Library File </th><th>Processor Configuration </th></tr>
  136. <tr>
  137. <td>LIB/ARM/RTX_CM0.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M0 and M1, little-endian. </td></tr>
  138. <tr>
  139. <td>LIB/ARM/RTX_CM0_B.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M0 and M1, big-endian. </td></tr>
  140. <tr>
  141. <td>LIB/ARM/RTX_CM3.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M3, M4, and M7 without FPU, little-endian. </td></tr>
  142. <tr>
  143. <td>LIB/ARM/RTX_CM3_B.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M3, M4, and M7 without FPU, big-endian. </td></tr>
  144. <tr>
  145. <td>LIB/ARM/RTX_CM4.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M4 and M7 with FPU, little-endian. </td></tr>
  146. <tr>
  147. <td>LIB/ARM/RTX_CM4_B.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M4 and M7 with FPU, big-endian. </td></tr>
  148. <tr>
  149. <td>LIB/GCC/libRTX_CM0.a </td><td>CMSIS-RTOS RTX Library for GCC Compiler, Cortex-M0 and M1, little-endian. </td></tr>
  150. <tr>
  151. <td>LIB/GCC/libRTX_CM0_B.a </td><td>CMSIS-RTOS RTX Library for GCC Compiler, Cortex-M0 and M1, big-endian. </td></tr>
  152. <tr>
  153. <td>LIB/GCC/libRTX_CM3.a </td><td>CMSIS-RTOS RTX Library for GCC Compiler, Cortex-M3, M4, and M7 without FPU, little-endian. </td></tr>
  154. <tr>
  155. <td>LIB/GCC/libRTX_CM3_B.a </td><td>CMSIS-RTOS RTX Library for GCC Compiler, Cortex-M3, M4, and M7 without FPU, big-endian. </td></tr>
  156. <tr>
  157. <td>LIB/GCC/libRTX_CM4.a </td><td>CMSIS-RTOS RTX Library for GCC Compiler, Cortex-M4 and M7 with FPU, little-endian. </td></tr>
  158. <tr>
  159. <td>LIB/GCC/libRTX_CM4_B.a </td><td>CMSIS-RTOS RTX Library for GCC Compiler, Cortex-M4 and M7 with FPU, big-endian. </td></tr>
  160. <tr>
  161. <td>LIB/IAR/RTX_CM0.lib </td><td>CMSIS-RTOS RTX Library for IAR Compiler, Cortex-M0 and M1, little-endian. </td></tr>
  162. <tr>
  163. <td>LIB/IAR/RTX_CM0_B.lib </td><td>CMSIS-RTOS RTX Library for IAR Compiler, Cortex-M0 and M1, big-endian. </td></tr>
  164. <tr>
  165. <td>LIB/IAR/RTX_CM3.lib </td><td>CMSIS-RTOS RTX Library for IAR Compiler, Cortex-M3, M4, and M7 without FPU, little-endian. </td></tr>
  166. <tr>
  167. <td>LIB/IAR/RTX_CM3_B.lib </td><td>CMSIS-RTOS RTX Library for IAR Compiler, Cortex-M3, M4, and M7 without FPU, big-endian. </td></tr>
  168. <tr>
  169. <td>LIB/IAR/RTX_CM4.lib </td><td>CMSIS-RTOS RTX Library for IAR Compiler, Cortex-M4 and M7 with FPU, little-endian. </td></tr>
  170. <tr>
  171. <td>LIB/IAR/RTX_CM4_B.lib </td><td>CMSIS-RTOS RTX Library for IAR Compiler, Cortex-M4 and M7 with FPU, big-endian. </td></tr>
  172. </table>
  173. <h1><a class="anchor" id="RTX_Conf_CM"></a>
  174. Configuration File RTX_Conf_CM.c</h1>
  175. <div class="fragment"><div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
  176. <div class="line"><span class="comment"> * CMSIS-RTOS - RTX</span></div>
  177. <div class="line"><span class="comment"> *----------------------------------------------------------------------------</span></div>
  178. <div class="line"><span class="comment"> * Name: RTX_Conf_CM.C</span></div>
  179. <div class="line"><span class="comment"> * Purpose: Configuration of CMSIS RTX Kernel for Cortex-M</span></div>
  180. <div class="line"><span class="comment"> * Rev.: V4.70.1</span></div>
  181. <div class="line"><span class="comment"> *----------------------------------------------------------------------------</span></div>
  182. <div class="line"><span class="comment"> *</span></div>
  183. <div class="line"><span class="comment"> * Copyright (c) 1999-2009 KEIL, 2009-2016 ARM Germany GmbH. All rights reserved.</span></div>
  184. <div class="line"><span class="comment"> *</span></div>
  185. <div class="line"><span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div>
  186. <div class="line"><span class="comment"> *</span></div>
  187. <div class="line"><span class="comment"> * Licensed under the Apache License, Version 2.0 (the License); you may</span></div>
  188. <div class="line"><span class="comment"> * not use this file except in compliance with the License.</span></div>
  189. <div class="line"><span class="comment"> * You may obtain a copy of the License at</span></div>
  190. <div class="line"><span class="comment"> *</span></div>
  191. <div class="line"><span class="comment"> * www.apache.org/licenses/LICENSE-2.0</span></div>
  192. <div class="line"><span class="comment"> *</span></div>
  193. <div class="line"><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
  194. <div class="line"><span class="comment"> * distributed under the License is distributed on an AS IS BASIS, WITHOUT</span></div>
  195. <div class="line"><span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
  196. <div class="line"><span class="comment"> * See the License for the specific language governing permissions and</span></div>
  197. <div class="line"><span class="comment"> * limitations under the License.</span></div>
  198. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
  199. <div class="line"> </div>
  200. <div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os_8h.html">cmsis_os.h</a>&quot;</span></div>
  201. <div class="line"> </div>
  202. <div class="line"></div>
  203. <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
  204. <div class="line"><span class="comment"> * RTX User configuration part BEGIN</span></div>
  205. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
  206. <div class="line"> </div>
  207. <div class="line"><span class="comment">//-------- &lt;&lt;&lt; Use Configuration Wizard in Context Menu &gt;&gt;&gt; -----------------</span></div>
  208. <div class="line"><span class="comment">//</span></div>
  209. <div class="line"><span class="comment">// &lt;h&gt;Thread Configuration</span></div>
  210. <div class="line"><span class="comment">// =======================</span></div>
  211. <div class="line"><span class="comment">//</span></div>
  212. <div class="line"><span class="comment">// &lt;o&gt;Number of concurrent running user threads &lt;1-250&gt;</span></div>
  213. <div class="line"><span class="comment">// &lt;i&gt; Defines max. number of user threads that will run at the same time.</span></div>
  214. <div class="line"><span class="comment">// &lt;i&gt; Default: 6</span></div>
  215. <div class="line"><span class="preprocessor">#ifndef OS_TASKCNT</span></div>
  216. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_TASKCNT 6</span></div>
  217. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  218. <div class="line"><span class="preprocessor"></span> </div>
  219. <div class="line"><span class="comment">// &lt;o&gt;Default Thread stack size [bytes] &lt;64-4096:8&gt;&lt;#/4&gt;</span></div>
  220. <div class="line"><span class="comment">// &lt;i&gt; Defines default stack size for threads with osThreadDef stacksz = 0</span></div>
  221. <div class="line"><span class="comment">// &lt;i&gt; Default: 200</span></div>
  222. <div class="line"><span class="preprocessor">#ifndef OS_STKSIZE</span></div>
  223. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_STKSIZE 50 // this stack size value is in words</span></div>
  224. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  225. <div class="line"><span class="preprocessor"></span> </div>
  226. <div class="line"><span class="comment">// &lt;o&gt;Main Thread stack size [bytes] &lt;64-32768:8&gt;&lt;#/4&gt;</span></div>
  227. <div class="line"><span class="comment">// &lt;i&gt; Defines stack size for main thread.</span></div>
  228. <div class="line"><span class="comment">// &lt;i&gt; Default: 200</span></div>
  229. <div class="line"><span class="preprocessor">#ifndef OS_MAINSTKSIZE</span></div>
  230. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_MAINSTKSIZE 50 // this stack size value is in words</span></div>
  231. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  232. <div class="line"><span class="preprocessor"></span> </div>
  233. <div class="line"><span class="comment">// &lt;o&gt;Number of threads with user-provided stack size &lt;0-250&gt;</span></div>
  234. <div class="line"><span class="comment">// &lt;i&gt; Defines the number of threads with user-provided stack size.</span></div>
  235. <div class="line"><span class="comment">// &lt;i&gt; Default: 0</span></div>
  236. <div class="line"><span class="preprocessor">#ifndef OS_PRIVCNT</span></div>
  237. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_PRIVCNT 0</span></div>
  238. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  239. <div class="line"><span class="preprocessor"></span> </div>
  240. <div class="line"><span class="comment">// &lt;o&gt;Total stack size [bytes] for threads with user-provided stack size &lt;0-1048576:8&gt;&lt;#/4&gt;</span></div>
  241. <div class="line"><span class="comment">// &lt;i&gt; Defines the combined stack size for threads with user-provided stack size.</span></div>
  242. <div class="line"><span class="comment">// &lt;i&gt; Default: 0</span></div>
  243. <div class="line"><span class="preprocessor">#ifndef OS_PRIVSTKSIZE</span></div>
  244. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_PRIVSTKSIZE 0 // this stack size value is in words</span></div>
  245. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  246. <div class="line"><span class="preprocessor"></span> </div>
  247. <div class="line"><span class="comment">// &lt;q&gt;Stack overflow checking</span></div>
  248. <div class="line"><span class="comment">// &lt;i&gt; Enable stack overflow checks at thread switch.</span></div>
  249. <div class="line"><span class="comment">// &lt;i&gt; Enabling this option increases slightly the execution time of a thread switch.</span></div>
  250. <div class="line"><span class="preprocessor">#ifndef OS_STKCHECK</span></div>
  251. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_STKCHECK 1</span></div>
  252. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  253. <div class="line"><span class="preprocessor"></span> </div>
  254. <div class="line"><span class="comment">// &lt;q&gt;Stack usage watermark</span></div>
  255. <div class="line"><span class="comment">// &lt;i&gt; Initialize thread stack with watermark pattern for analyzing stack usage (current/maximum) in System and Thread Viewer.</span></div>
  256. <div class="line"><span class="comment">// &lt;i&gt; Enabling this option increases significantly the execution time of osThreadCreate.</span></div>
  257. <div class="line"><span class="preprocessor">#ifndef OS_STKINIT</span></div>
  258. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define OS_STKINIT 0</span></div>
  259. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  260. <div class="line"><span class="preprocessor"></span> </div>
  261. <div class="line"><span class="comment">// &lt;o&gt;Processor mode for thread execution </span></div>
  262. <div class="line"><span class="comment">// &lt;0=&gt; Unprivileged mode </span></div>
  263. <div class="line"><span class="comment">// &lt;1=&gt; Privileged mode</span></div>
  264. <div class="line"><span class="comment">// &lt;i&gt; Default: Privileged mode</span></div>
  265. <div class="line"><span class="preprocessor">#ifndef OS_RUNPRIV</span></div>
  266. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_RUNPRIV 1</span></div>
  267. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  268. <div class="line"><span class="preprocessor"></span> </div>
  269. <div class="line"><span class="comment">// &lt;/h&gt;</span></div>
  270. <div class="line"> </div>
  271. <div class="line"><span class="comment">// &lt;h&gt;RTX Kernel Timer Tick Configuration</span></div>
  272. <div class="line"><span class="comment">// ======================================</span></div>
  273. <div class="line"><span class="comment">// &lt;q&gt; Use Cortex-M SysTick timer as RTX Kernel Timer</span></div>
  274. <div class="line"><span class="comment">// &lt;i&gt; Cortex-M processors provide in most cases a SysTick timer that can be used as </span></div>
  275. <div class="line"><span class="comment">// &lt;i&gt; as time-base for RTX.</span></div>
  276. <div class="line"><span class="preprocessor">#ifndef OS_SYSTICK</span></div>
  277. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_SYSTICK 1</span></div>
  278. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  279. <div class="line"><span class="preprocessor"></span><span class="comment">//</span></div>
  280. <div class="line"><span class="comment">// &lt;o&gt;RTOS Kernel Timer input clock frequency [Hz] &lt;1-1000000000&gt;</span></div>
  281. <div class="line"><span class="comment">// &lt;i&gt; Defines the input frequency of the RTOS Kernel Timer. </span></div>
  282. <div class="line"><span class="comment">// &lt;i&gt; When the Cortex-M SysTick timer is used, the input clock </span></div>
  283. <div class="line"><span class="comment">// &lt;i&gt; is on most systems identical with the core clock.</span></div>
  284. <div class="line"><span class="preprocessor">#ifndef OS_CLOCK</span></div>
  285. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_CLOCK 12000000</span></div>
  286. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  287. <div class="line"><span class="preprocessor"></span> </div>
  288. <div class="line"><span class="comment">// &lt;o&gt;RTX Timer tick interval value [us] &lt;1-1000000&gt;</span></div>
  289. <div class="line"><span class="comment">// &lt;i&gt; The RTX Timer tick interval value is used to calculate timeout values.</span></div>
  290. <div class="line"><span class="comment">// &lt;i&gt; When the Cortex-M SysTick timer is enabled, the value also configures the SysTick timer.</span></div>
  291. <div class="line"><span class="comment">// &lt;i&gt; Default: 1000 (1ms)</span></div>
  292. <div class="line"><span class="preprocessor">#ifndef OS_TICK</span></div>
  293. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_TICK 1000</span></div>
  294. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  295. <div class="line"><span class="preprocessor"></span> </div>
  296. <div class="line"><span class="comment">// &lt;/h&gt;</span></div>
  297. <div class="line"> </div>
  298. <div class="line"><span class="comment">// &lt;h&gt;System Configuration</span></div>
  299. <div class="line"><span class="comment">// =======================</span></div>
  300. <div class="line"><span class="comment">//</span></div>
  301. <div class="line"><span class="comment">// &lt;e&gt;Round-Robin Thread switching</span></div>
  302. <div class="line"><span class="comment">// ===============================</span></div>
  303. <div class="line"><span class="comment">//</span></div>
  304. <div class="line"><span class="comment">// &lt;i&gt; Enables Round-Robin Thread switching.</span></div>
  305. <div class="line"><span class="preprocessor">#ifndef OS_ROBIN</span></div>
  306. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_ROBIN 1</span></div>
  307. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  308. <div class="line"><span class="preprocessor"></span> </div>
  309. <div class="line"><span class="comment">// &lt;o&gt;Round-Robin Timeout [ticks] &lt;1-1000&gt;</span></div>
  310. <div class="line"><span class="comment">// &lt;i&gt; Defines how long a thread will execute before a thread switch.</span></div>
  311. <div class="line"><span class="comment">// &lt;i&gt; Default: 5</span></div>
  312. <div class="line"><span class="preprocessor">#ifndef OS_ROBINTOUT</span></div>
  313. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_ROBINTOUT 5</span></div>
  314. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  315. <div class="line"><span class="preprocessor"></span> </div>
  316. <div class="line"><span class="comment">// &lt;/e&gt;</span></div>
  317. <div class="line"> </div>
  318. <div class="line"><span class="comment">// &lt;e&gt;User Timers</span></div>
  319. <div class="line"><span class="comment">// ==============</span></div>
  320. <div class="line"><span class="comment">// &lt;i&gt; Enables user Timers</span></div>
  321. <div class="line"><span class="preprocessor">#ifndef OS_TIMERS</span></div>
  322. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_TIMERS 1</span></div>
  323. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  324. <div class="line"><span class="preprocessor"></span> </div>
  325. <div class="line"><span class="comment">// &lt;o&gt;Timer Thread Priority</span></div>
  326. <div class="line"><span class="comment">// &lt;1=&gt; Low</span></div>
  327. <div class="line"><span class="comment">// &lt;2=&gt; Below Normal &lt;3=&gt; Normal &lt;4=&gt; Above Normal</span></div>
  328. <div class="line"><span class="comment">// &lt;5=&gt; High</span></div>
  329. <div class="line"><span class="comment">// &lt;6=&gt; Realtime (highest)</span></div>
  330. <div class="line"><span class="comment">// &lt;i&gt; Defines priority for Timer Thread</span></div>
  331. <div class="line"><span class="comment">// &lt;i&gt; Default: High</span></div>
  332. <div class="line"><span class="preprocessor">#ifndef OS_TIMERPRIO</span></div>
  333. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_TIMERPRIO 5</span></div>
  334. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  335. <div class="line"><span class="preprocessor"></span> </div>
  336. <div class="line"><span class="comment">// &lt;o&gt;Timer Thread stack size [bytes] &lt;64-4096:8&gt;&lt;#/4&gt;</span></div>
  337. <div class="line"><span class="comment">// &lt;i&gt; Defines stack size for Timer thread.</span></div>
  338. <div class="line"><span class="comment">// &lt;i&gt; Default: 200</span></div>
  339. <div class="line"><span class="preprocessor">#ifndef OS_TIMERSTKSZ</span></div>
  340. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_TIMERSTKSZ 50 // this stack size value is in words</span></div>
  341. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  342. <div class="line"><span class="preprocessor"></span> </div>
  343. <div class="line"><span class="comment">// &lt;o&gt;Timer Callback Queue size &lt;1-32&gt;</span></div>
  344. <div class="line"><span class="comment">// &lt;i&gt; Number of concurrent active timer callback functions.</span></div>
  345. <div class="line"><span class="comment">// &lt;i&gt; Default: 4</span></div>
  346. <div class="line"><span class="preprocessor">#ifndef OS_TIMERCBQS</span></div>
  347. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_TIMERCBQS 4</span></div>
  348. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  349. <div class="line"><span class="preprocessor"></span> </div>
  350. <div class="line"><span class="comment">// &lt;/e&gt;</span></div>
  351. <div class="line"> </div>
  352. <div class="line"><span class="comment">// &lt;o&gt;ISR FIFO Queue size&lt;4=&gt; 4 entries &lt;8=&gt; 8 entries</span></div>
  353. <div class="line"><span class="comment">// &lt;12=&gt; 12 entries &lt;16=&gt; 16 entries</span></div>
  354. <div class="line"><span class="comment">// &lt;24=&gt; 24 entries &lt;32=&gt; 32 entries</span></div>
  355. <div class="line"><span class="comment">// &lt;48=&gt; 48 entries &lt;64=&gt; 64 entries</span></div>
  356. <div class="line"><span class="comment">// &lt;96=&gt; 96 entries</span></div>
  357. <div class="line"><span class="comment">// &lt;i&gt; ISR functions store requests to this buffer,</span></div>
  358. <div class="line"><span class="comment">// &lt;i&gt; when they are called from the interrupt handler.</span></div>
  359. <div class="line"><span class="comment">// &lt;i&gt; Default: 16 entries</span></div>
  360. <div class="line"><span class="preprocessor">#ifndef OS_FIFOSZ</span></div>
  361. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_FIFOSZ 16</span></div>
  362. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  363. <div class="line"><span class="preprocessor"></span> </div>
  364. <div class="line"><span class="comment">// &lt;/h&gt;</span></div>
  365. <div class="line"> </div>
  366. <div class="line"><span class="comment">//------------- &lt;&lt;&lt; end of configuration section &gt;&gt;&gt; -----------------------</span></div>
  367. <div class="line"> </div>
  368. <div class="line"><span class="comment">// Standard library system mutexes</span></div>
  369. <div class="line"><span class="comment">// ===============================</span></div>
  370. <div class="line"><span class="comment">// Define max. number system mutexes that are used to protect </span></div>
  371. <div class="line"><span class="comment">// the arm standard runtime library. For microlib they are not used.</span></div>
  372. <div class="line"><span class="preprocessor">#ifndef OS_MUTEXCNT</span></div>
  373. <div class="line"><span class="preprocessor"></span><span class="preprocessor"> #define OS_MUTEXCNT 8</span></div>
  374. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
  375. <div class="line"><span class="preprocessor"></span> </div>
  376. <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
  377. <div class="line"><span class="comment"> * RTX User configuration part END</span></div>
  378. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
  379. <div class="line"> </div>
  380. <div class="line"><span class="preprocessor">#define OS_TRV ((uint32_t)(((double)OS_CLOCK*(double)OS_TICK)/1E6)-1)</span></div>
  381. <div class="line"><span class="preprocessor"></span> </div>
  382. <div class="line"></div>
  383. <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
  384. <div class="line"><span class="comment"> * Global Functions</span></div>
  385. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
  386. <div class="line"> </div>
  387. <div class="line"><span class="comment">/*--------------------------- os_idle_demon ---------------------------------*/</span></div>
  388. <div class="line"><span class="comment"></span></div>
  389. <div class="line"><span class="comment">/// \brief The idle demon is running when no other thread is ready to run</span></div>
  390. <div class="line"><span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group__RTX__Global__Functions.html#gafb4dc4d3dff8343a393726d2860282e4">os_idle_demon</a> (<span class="keywordtype">void</span>) {</div>
  391. <div class="line"> </div>
  392. <div class="line"> <span class="keywordflow">for</span> (;;) {</div>
  393. <div class="line"> <span class="comment">/* HERE: include optional user code to be executed when no thread runs.*/</span></div>
  394. <div class="line"> }</div>
  395. <div class="line">}</div>
  396. <div class="line"> </div>
  397. <div class="line"><span class="preprocessor">#if (OS_SYSTICK == 0) // Functions for alternative timer as RTX kernel timer</span></div>
  398. <div class="line"><span class="preprocessor"></span> </div>
  399. <div class="line"><span class="comment">/*--------------------------- os_tick_init ----------------------------------*/</span></div>
  400. <div class="line"> <span class="comment"></span></div>
  401. <div class="line"><span class="comment">/// \brief Initializes an alternative hardware timer as RTX kernel timer</span></div>
  402. <div class="line"><span class="comment">/// \return IRQ number of the alternative hardware timer</span></div>
  403. <div class="line"><span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="group__RTX__Global__Functions.html#ga145e7eafdd042bb522020cbb3b469d9c">os_tick_init</a> (<span class="keywordtype">void</span>) {</div>
  404. <div class="line"> <span class="keywordflow">return</span> (-1); <span class="comment">/* Return IRQ number of timer (0..239) */</span></div>
  405. <div class="line">}</div>
  406. <div class="line"> </div>
  407. <div class="line"><span class="comment">/*--------------------------- os_tick_val -----------------------------------*/</span></div>
  408. <div class="line"> <span class="comment"></span></div>
  409. <div class="line"><span class="comment">/// \brief Get alternative hardware timer&#39;s current value (0 .. OS_TRV)</span></div>
  410. <div class="line"><span class="comment">/// \return Current value of the alternative hardware timer</span></div>
  411. <div class="line"><span class="comment"></span>uint32_t <a class="code" href="group__RTX__Global__Functions.html#ga567543bf38239a91f09751686c23017b">os_tick_val</a> (<span class="keywordtype">void</span>) {</div>
  412. <div class="line"> <span class="keywordflow">return</span> (0);</div>
  413. <div class="line">}</div>
  414. <div class="line"> </div>
  415. <div class="line"><span class="comment">/*--------------------------- os_tick_ovf -----------------------------------*/</span></div>
  416. <div class="line"> <span class="comment"></span></div>
  417. <div class="line"><span class="comment">/// \brief Get alternative hardware timer&#39;s overflow flag</span></div>
  418. <div class="line"><span class="comment">/// \return Overflow flag\n</span></div>
  419. <div class="line"><span class="comment">/// - 1 : overflow</span></div>
  420. <div class="line"><span class="comment">/// - 0 : no overflow</span></div>
  421. <div class="line"><span class="comment"></span>uint32_t <a class="code" href="group__RTX__Global__Functions.html#gad5deddec3fea0fb31798f571afc3c692">os_tick_ovf</a> (<span class="keywordtype">void</span>) {</div>
  422. <div class="line"> <span class="keywordflow">return</span> (0);</div>
  423. <div class="line">}</div>
  424. <div class="line"> </div>
  425. <div class="line"><span class="comment">/*--------------------------- os_tick_irqack --------------------------------*/</span></div>
  426. <div class="line"> <span class="comment"></span></div>
  427. <div class="line"><span class="comment">/// \brief Acknowledge alternative hardware timer interrupt</span></div>
  428. <div class="line"><span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group__RTX__Global__Functions.html#ga85dab8408f27236c7341a69feb6258c7">os_tick_irqack</a> (<span class="keywordtype">void</span>) {</div>
  429. <div class="line"> <span class="comment">/* ... */</span></div>
  430. <div class="line">}</div>
  431. <div class="line"> </div>
  432. <div class="line"><span class="preprocessor">#endif // (OS_SYSTICK == 0)</span></div>
  433. <div class="line"><span class="preprocessor"></span> </div>
  434. <div class="line"><span class="comment">/*--------------------------- os_error --------------------------------------*/</span></div>
  435. <div class="line"> </div>
  436. <div class="line"><span class="comment">/* OS Error Codes */</span></div>
  437. <div class="line"><span class="preprocessor">#define OS_ERROR_STACK_OVF 1</span></div>
  438. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define OS_ERROR_FIFO_OVF 2</span></div>
  439. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define OS_ERROR_MBX_OVF 3</span></div>
  440. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define OS_ERROR_TIMER_OVF 4</span></div>
  441. <div class="line"><span class="preprocessor"></span> </div>
  442. <div class="line"><span class="keyword">extern</span> <a class="code" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a> <a class="code" href="RTX__Conf__CM_8c.html#a395cca131b7746fc43c104a3485b77f7">svcThreadGetId</a> (<span class="keywordtype">void</span>);</div>
  443. <div class="line"> <span class="comment"></span></div>
  444. <div class="line"><span class="comment">/// \brief Called when a runtime error is detected</span></div>
  445. <div class="line"><span class="comment">/// \param[in] error_code actual error code that has been detected</span></div>
  446. <div class="line"><span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group__RTX__Global__Functions.html#ga651ae76b3acf45f80bf0e0487b51d6e6">os_error</a> (uint32_t error_code) {</div>
  447. <div class="line"> </div>
  448. <div class="line"> <span class="comment">/* HERE: include optional code to be executed on runtime error. */</span></div>
  449. <div class="line"> <span class="keywordflow">switch</span> (error_code) {</div>
  450. <div class="line"> <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#abf8311a7a239ec56c6d725f926ba766d">OS_ERROR_STACK_OVF</a>:</div>
  451. <div class="line"> <span class="comment">/* Stack overflow detected for the currently running task. */</span></div>
  452. <div class="line"> <span class="comment">/* Thread can be identified by calling svcThreadGetId(). */</span></div>
  453. <div class="line"> <span class="keywordflow">break</span>;</div>
  454. <div class="line"> <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#a075d54df14c85a6afe32b7f5c99c9c29">OS_ERROR_FIFO_OVF</a>:</div>
  455. <div class="line"> <span class="comment">/* ISR FIFO Queue buffer overflow detected. */</span></div>
  456. <div class="line"> <span class="keywordflow">break</span>;</div>
  457. <div class="line"> <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#ab715d7d66c341c067ef0a97b55db8a10">OS_ERROR_MBX_OVF</a>:</div>
  458. <div class="line"> <span class="comment">/* Mailbox overflow detected. */</span></div>
  459. <div class="line"> <span class="keywordflow">break</span>;</div>
  460. <div class="line"> <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#a79d7e388d951f11bd0dabd13f722cea8">OS_ERROR_TIMER_OVF</a>:</div>
  461. <div class="line"> <span class="comment">/* User Timer Callback Queue overflow detected. */</span></div>
  462. <div class="line"> <span class="keywordflow">break</span>;</div>
  463. <div class="line"> <span class="keywordflow">default</span>:</div>
  464. <div class="line"> <span class="keywordflow">break</span>;</div>
  465. <div class="line"> }</div>
  466. <div class="line"> <span class="keywordflow">for</span> (;;);</div>
  467. <div class="line">}</div>
  468. <div class="line"> </div>
  469. <div class="line"></div>
  470. <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
  471. <div class="line"><span class="comment"> * RTX Configuration Functions</span></div>
  472. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
  473. <div class="line"> </div>
  474. <div class="line"><span class="preprocessor">#include &quot;RTX_CM_lib.h&quot;</span></div>
  475. <div class="line"> </div>
  476. <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
  477. <div class="line"><span class="comment"> * end of file</span></div>
  478. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
  479. </div><!-- fragment --> </div></div><!-- contents -->
  480. </div><!-- doc-content -->
  481. <!-- start footer part -->
  482. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  483. <ul>
  484. <li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="rtxImplementation.html">RTX Implementation</a></li>
  485. <li class="footer">Generated on Thu Apr 9 2020 15:49:56 for CMSIS-RTOS Version 1.03 by Arm Ltd. All rights reserved.
  486. <!--
  487. <a href="http://www.doxygen.org/index.html">
  488. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  489. -->
  490. </li>
  491. </ul>
  492. </div>
  493. </body>
  494. </html>