begriffs open source - cmsis/blob - main/RTOS2/html/pDirectory_Files.html

   1 <!-- HTML header for doxygen 1.9.6-->
   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" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-RTOS2: Directory Structure and File Overview</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-RTOS2
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-RTOS2");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('pDirectory_Files.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div><div class="header">
 127   <div class="headertitle"><div class="title">Directory Structure and File Overview </div></div>
 128 </div><!--header-->
 129 <div class="contents">
 130 <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 v5. The following directory references start below the CMSIS pack installation path, for example ARM/CMSIS/<em>version</em>/CMSIS/RTOS2.</p>
 131 <h1><a class="anchor" id="Folders"></a>
 132 RTX v5 Directory Structure</h1>
 133 <p>The CMSIS-RTOS RTX v5 is delivered in source code and several examples are provided.</p>
 134 <table class="cmtable" summary="CMSIS-RTOS RTX Library Files">
 135 <tr>
 136 <th>Directory </th><th>Content  </th></tr>
 137 <tr>
 138 <td>Include </td><td>Header files: <b>cmsis_os2.h</b> for <a class="el" href="rtos_api2.html">CMSIS-RTOS C API v2</a> and <b>os_tick.h</b> for <a class="el" href="rtos_os_tick_api.html">OS Tick API</a>.  </td></tr>
 139 <tr>
 140 <td>Source </td><td>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>
 141 <tr>
 142 <td>Template </td><td><a href="../../RTOS/html/index.html" class="el">CMSIS-RTOS API v1</a> template source and header file.   </td></tr>
 143 <tr>
 144 <td>RTX </td><td>Directory with RTX specific files and folders. Also contains the component viewer description file.  </td></tr>
 145 <tr>
 146 <td>RTX/Config </td><td>CMSIS-RTOS RTX configuration files <b>RTX_Config.h</b> and <b>RTX_Config.c</b>.   </td></tr>
 147 <tr>
 148 <td>RTX/Examples </td><td>Example projects that can be directly used in development tools.   </td></tr>
 149 <tr>
 150 <td>RTX/Include </td><td>RTX v5 specific include files.   </td></tr>
 151 <tr>
 152 <td>RTX/Include1 </td><td>CMSIS-RTOS v1 API header file.  </td></tr>
 153 <tr>
 154 <td>RTX/Library </td><td>Pre-built libraries (see next table for details).   <br  />
 155  </td></tr>
 156 <tr>
 157 <td>RTX/Source </td><td>Source code.  </td></tr>
 158 <tr>
 159 <td>RTX/Template </td><td>User code templates for creating application projects with CMSIS-RTOS RTX v5.  </td></tr>
 160 </table>
 161 <h1><a class="anchor" id="libFiles"></a>
 162 RTX v5 Library Files</h1>
 163 <p>The CMSIS-RTOS RTX Library is available pre-compiled for ARMCC and GCC compilers and supports all Cortex-M processor variants in every configuration  , including Arm Cortex-M23, Cortex-M33 and Cortex-M35P  </p><table class="cmtable" summary="CMSIS-RTOS RTX Library Files">
 164 <tr>
 165 <th>Library File </th><th>Processor Configuration  </th></tr>
 166 <tr>
 167 <td>Library/ARM/RTX_CM0.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M0 and M1, little-endian.  </td></tr>
 168 <tr>
 169 <td>Library/ARM/RTX_CM3.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M3, M4, and M7 without FPU, little-endian.  </td></tr>
 170 <tr>
 171 <td>Library/ARM/RTX_CM4F.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Cortex-M4 and M7 with FPU, little-endian.   </td></tr>
 172 <tr>
 173 <td>Library/ARM/RTX_V8MB.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Armv8-M Baseline.  </td></tr>
 174 <tr>
 175 <td>Library/ARM/RTX_V8MBN.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Armv8-M Baseline, non-secure.  </td></tr>
 176 <tr>
 177 <td>Library/ARM/RTX_V8MM.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Armv8-M Mainline.  </td></tr>
 178 <tr>
 179 <td>Library/ARM/RTX_V8MMF.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Armv8-M Mainline with FPU.  </td></tr>
 180 <tr>
 181 <td>Library/ARM/RTX_V8MMFN.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Armv8-M Mainline with FPU, non-secure.  </td></tr>
 182 <tr>
 183 <td>Library/ARM/RTX_V8MMN.lib </td><td>CMSIS-RTOS RTX Library for ARMCC Compiler, Armv8-M Mainline, non-secure.    </td></tr>
 184 <tr>
 185 <td>Library/GCC/libRTX_CM0.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Cortex-M0 and M1, little-endian.  </td></tr>
 186 <tr>
 187 <td>Library/GCC/libRTX_CM3.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Cortex-M3, M4, and M7 without FPU, little-endian.  </td></tr>
 188 <tr>
 189 <td>Library/GCC/libRTX_CM4F.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Cortex-M4 and M7 with FPU, little-endian.    <br  />
 190  </td></tr>
 191 <tr>
 192 <td>Library/GCC/libRTX_V8MB.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Armv8-M Baseline.  </td></tr>
 193 <tr>
 194 <td>Library/GCC/libRTX_V8MBN.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Armv8-M Baseline, non-secure.  </td></tr>
 195 <tr>
 196 <td>Library/GCC/libRTX_V8MM.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Armv8-M Mainline.  </td></tr>
 197 <tr>
 198 <td>Library/GCC/libRTX_V8MMF.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Armv8-M Mainline with FPU.  </td></tr>
 199 <tr>
 200 <td>Library/GCC/libRTX_V8MMFN.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Armv8-M Mainline with FPU, non-secure.  </td></tr>
 201 <tr>
 202 <td>Library/GCC/libRTX_V8MMN.a </td><td>CMSIS-RTOS libRTX Library for GCC Compiler, Armv8-M Mainline, non-secure.   </td></tr>
 203 </table>
 204 </div></div><!-- contents -->
 205 </div><!-- PageDoc -->
 206 </div><!-- doc-content -->
 207 <!-- start footer part -->
 208 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 209   <ul>
 210     <li class="footer">
 211       <script type="text/javascript">
 212         <!--
 213         writeFooter.call(this);
 214         //-->
 215       </script>
 216     </li>
 217   </ul>
 218 </div>
 219 </body>
 220 </html>