index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  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>Main Page</title>
  7. <title>CMSIS-RTOS2: Main Page</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-RTOS2
  35. &#160;<span id="projectnumber">Version 2.1.3</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 class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><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('index.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">CMSIS-RTOS2 Documentation</div> </div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><p>The <b>CMSIS-RTOS v2 (CMSIS-RTOS2)</b> provides generic RTOS interfaces for Arm&reg; Cortex&reg; processor-based devices. It provides a standardized API for software components that require RTOS functionality and gives therefore serious benefits to the users and the software industry:</p>
  113. <ul>
  114. <li>CMSIS-RTOS2 provides basic features that are required in many applications.</li>
  115. <li>The unified feature set of the CMSIS-RTOS2 reduces learning efforts and simplifies sharing of software components.</li>
  116. <li>Middleware components that use the CMSIS-RTOS2 are RTOS agnostic and are easier to adapt.</li>
  117. <li>Standard project templates of the CMSIS-RTOS2 may be shipped with freely available CMSIS-RTOS2 implementations.</li>
  118. </ul>
  119. <dl class="section note"><dt>Note</dt><dd>The CMSIS-RTOS API Version 2 defines a minimum feature set. Implementations with extended features may be provided by the RTOS vendors.</dd></dl>
  120. <p>The CMSIS-RTOS2 manages the resources of the microcontroller system and implements the concept of parallel threads that run concurrently.</p>
  121. <p>Applications frequently require several concurrent activities. CMSIS-RTOS2 can manage multiple concurrent activities at the time when they are needed. Each activity gets a separate thread which executes a specific task and this simplifies the overall program structure. The CMSIS-RTOS2 system is scalable and additional threads can be added easily at a later time. Threads have a priority allowing faster execution of time-critical parts of a user application.</p>
  122. <p>The CMSIS-RTOS2 offers services needed in many real-time applications, for example, periodical activation of timer functions, memory management, and message exchange between threads with time limits.</p>
  123. <p>The CMSIS-RTOS2 addresses the following new requirements:</p>
  124. <ul>
  125. <li>Dynamic object creation no longer requires static memory, static memory buffers are now optional.</li>
  126. <li>Support for Armv8-M architecture that provides a secure and non-secure state of code execution.</li>
  127. <li>Provisions for message passing in multi-core systems.</li>
  128. <li>Full support of C++ run-time environments.</li>
  129. <li>C interface which is binary compatible across <a href="http://infocenter.arm.com/help/topic/com.arm.doc.subset.swdev.abi/index.html">ABI compatible compilers</a>.</li>
  130. </ul>
  131. <p>As a consequence of these requirements the CMSIS-RTOS2 has the following fundamental modifications:</p>
  132. <ul>
  133. <li>The functions osXxxxNew replace osXxxxCreate functions; osXxxxNew and osXxxxDelete create and destroy objects.</li>
  134. <li>The C function <code>main</code> is no longer started as a thread (this was an optional feature in CMSIS-RTOS v1).</li>
  135. <li>Functions that return osEvent have been replaced.</li>
  136. </ul>
  137. <p>CMSIS-RTOS2 provides an translation layer to <a href="../../RTOS/html/index.html" class="el">CMSIS-RTOS v1</a>. It is possible to intermix <a class="el" href="rtos_api2.html">CMSIS-RTOS C API v2</a> and <a href="../../RTOS/html/functionOverview.html" class="el">CMSIS-RTOS C API v1</a> within the same application. Over time, you may migrate to the new API as explained in <a class="el" href="os2Migration.html">Migration from API v1 to API v2</a>.</p>
  138. <p>CMSIS-RTOS2 is not POSIX compliant, but has provisions to enable a C++11/C++14 interface.</p>
  139. <p>The following sections provide further details about CMSIS-RTOS2 and the RTX reference implementation.</p>
  140. <ul>
  141. <li><a class="el" href="rtos_revisionHistory.html">Revision History</a> documents changes made in each version for CMSIS-RTOS v2 and RTX v5.</li>
  142. <li><a class="el" href="genRTOS2IF.html">Generic RTOS Interface</a> provides an overview about the APIs available with CMSIS-RTOS v2.</li>
  143. <li><a class="el" href="functionOverview.html">Function Overview</a> lists the CMSIS-RTOS2 API functions and the header file cmsis_os2.h.</li>
  144. <li><a class="el" href="rtosValidation.html">RTOS Validation</a> describes the validation suite that is publicly available.</li>
  145. <li><a class="el" href="os2Migration.html">Migration from API v1 to API v2</a> shows how to use CMSIS-RTOS2 in existing projects and lists function differences to CMSIS-RTOS v1.</li>
  146. <li><a class="el" href="rtx5_impl.html">RTX v5 Implementation</a> provides general information about the operation and usage of RTX v5.</li>
  147. </ul>
  148. <hr/>
  149. <h2>CMSIS-RTOS2 in ARM::CMSIS Pack </h2>
  150. <p><a class="anchor" id="directory"></a> The following files relevant to CMSIS-RTOS2 are present in the <b>ARM::CMSIS</b> Pack directories: </p>
  151. <table class="doxtable">
  152. <tr>
  153. <th align="left">Directory </th><th align="left">Content </th></tr>
  154. <tr>
  155. <td align="left"><b>CMSIS/Documentation/RTOS2</b> </td><td align="left">This documentation </td></tr>
  156. <tr>
  157. <td align="left"><b>CMSIS/RTOS2/Include</b> </td><td align="left"><a class="el" href="genRTOS2IF.html#cmsis_os2_h">cmsis_os2.h header file</a> </td></tr>
  158. <tr>
  159. <td align="left"><b>CMSIS/RTOS2/RTX</b> </td><td align="left">CMSIS-RTOS2 reference implementation based on RTX version 5 </td></tr>
  160. <tr>
  161. <td align="left"><b>CMSIS/RTOS2/Source</b> </td><td align="left">Generic <b>OS tick</b> implementations for various processors based on <a class="el" href="rtos_os_tick_api.html">OS Tick API</a> </td></tr>
  162. <tr>
  163. <td align="left"><b>CMSIS/RTOS2/Template</b> </td><td align="left">Compatibility layer to <a href="../../RTOS/html/index.html" class="el">CMSIS-RTOS v1</a> </td></tr>
  164. </table>
  165. </div></div><!-- contents -->
  166. </div><!-- doc-content -->
  167. <!-- start footer part -->
  168. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  169. <ul>
  170. <li class="footer">Generated on Mon Mar 18 2019 16:06:33 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  171. <!--
  172. <a href="http://www.doxygen.org/index.html">
  173. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  174. -->
  175. </li>
  176. </ul>
  177. </div>
  178. </body>
  179. </html>