begriffs open source - cmsis-freertos/blob - v10.5.1/functionOverview.html

   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>Function Overview</title>
   7 <title>CMSIS-FreeRTOS: Function 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="footer.js"></script>
  13 <script type="text/javascript" src="printComponentTabs.js"></script>
  14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  15 <script type="text/javascript" src="resize.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/search.js"></script>
  23 <script type="text/javascript">
  24   $(document).ready(function() { searchBox.OnSelectItem(0); });
  25 </script>
  26 <link href="version.css" rel="stylesheet" type="text/css" />
  27 <script type="text/javascript" src="../version.js"></script>
  28 </head>
  29 <body>
  30 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  31 <div id="titlearea">
  32 <table cellspacing="0" cellpadding="0">
  33  <tbody>
  34  <tr style="height: 46px;">
  35   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  36   <td style="padding-left: 0.5em;">
  37    <div id="projectname">CMSIS-FreeRTOS
  38    &#160;<span id="projectnumber"><script type="text/javascript">
  39      <!--
  40      writeHeader.call(this);
  41      writeVersionDropdown(this);
  42      //-->
  43     </script>
  44    </span>
  45    </div>
  46    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  47   </td>
  48  </tr>
  49  </tbody>
  50 </table>
  51 </div>
  52 <!-- end header part -->
  53 <div id="CMSISnav" class="tabs1">
  54     <ul class="tablist">
  55       <script type="text/javascript">
  56                 <!--
  57                 writeComponentTabs.call(this);
  58                 //-->
  59       </script>
  60           </ul>
  61 </div>
  62 <!-- Generated by Doxygen 1.8.6 -->
  63 <script type="text/javascript">
  64 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  65 </script>
  66   <div id="navrow1" class="tabs">
  67     <ul class="tablist">
  68       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  69       <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  70       <li><a href="modules.html"><span>Reference</span></a></li>
  71       <li>
  72         <div id="MSearchBox" class="MSearchBoxInactive">
  73         <span class="left">
  74           <img id="MSearchSelect" src="search/mag_sel.png"
  75                onmouseover="return searchBox.OnSearchSelectShow()"
  76                onmouseout="return searchBox.OnSearchSelectHide()"
  77                alt=""/>
  78           <input type="text" id="MSearchField" value="Search" accesskey="S"
  79                onfocus="searchBox.OnSearchFieldFocus(true)"
  80                onblur="searchBox.OnSearchFieldFocus(false)"
  81                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  82           </span><span class="right">
  83             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  84           </span>
  85         </div>
  86       </li>
  87     </ul>
  88   </div>
  89 </div><!-- top -->
  90 <div id="side-nav" class="ui-resizable side-nav-resizable">
  91   <div id="nav-tree">
  92     <div id="nav-tree-contents">
  93       <div id="nav-sync" class="sync"></div>
  94     </div>
  95   </div>
  96   <div id="splitbar" style="-moz-user-select:none;"
  97        class="ui-resizable-handle">
  98   </div>
  99 </div>
 100 <script type="text/javascript">
 101 $(document).ready(function(){initNavTree('functionOverview.html','');});
 102 </script>
 103 <div id="doc-content">
 104 <!-- window showing the filter options -->
 105 <div id="MSearchSelectWindow"
 106      onmouseover="return searchBox.OnSearchSelectShow()"
 107      onmouseout="return searchBox.OnSearchSelectHide()"
 108      onkeydown="return searchBox.OnSearchSelectKey(event)">
 109 <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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 110
 111 <!-- iframe showing the search results (closed by default) -->
 112 <div id="MSearchResultsWindow">
 113 <iframe src="javascript:void(0)" frameborder="0"
 114         name="MSearchResults" id="MSearchResults">
 115 </iframe>
 116 </div>
 117
 118 <div class="header">
 119   <div class="headertitle">
 120 <div class="title">Function Overview </div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123 <div class="textblock"><h1><a class="anchor" id="rtos_api2"></a>
 124 CMSIS-RTOS2 API</h1>
 125 <p>Overview of all CMSIS-RTOS C API v2 functions that are implemented in CMSIS-FreeRTOS.</p>
 126 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__KernelCtrl.html">Kernel Information and Control</a> </h2>
 127 <ul>
 128 <li><b>osKernelGetInfo:</b> supported</li>
 129 <li><b>osKernelGetState:</b> supported</li>
 130 <li><b>osKernelGetSysTimerCount:</b> supported</li>
 131 <li><b>osKernelGetSysTimerFreq:</b> supported</li>
 132 <li><b>osKernelInitialize:</b> supported</li>
 133 <li><b>osKernelLock:</b> supported</li>
 134 <li><b>osKernelUnlock:</b> supported</li>
 135 <li><b>osKernelRestoreLock:</b> supported</li>
 136 <li><b>osKernelResume:</b> <span class="XML-Token">not implemented</span></li>
 137 <li><b>osKernelStart:</b> supported</li>
 138 <li><b>osKernelSuspend:</b> <span class="XML-Token">not implemented</span></li>
 139 <li><b>osKernelGetTickCount:</b> supported</li>
 140 <li><b>osKernelGetTickFreq:</b> supported</li>
 141 </ul>
 142 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__ThreadMgmt.html">Thread Management</a> </h2>
 143 <ul>
 144 <li><b>osThreadDetach:</b> <span class="XML-Token">not implemented</span></li>
 145 <li><b>osThreadEnumerate:</b> supported</li>
 146 <li><b>osThreadExit:</b> supported</li>
 147 <li><b>osThreadGetCount:</b> supported</li>
 148 <li><b>osThreadGetId:</b> supported</li>
 149 <li><b>osThreadGetName:</b> supported</li>
 150 <li><b>osThreadGetPriority:</b> supported</li>
 151 <li><b>osThreadGetStackSize:</b> <span class="XML-Token">not implemented</span></li>
 152 <li><b>osThreadGetStackSpace:</b> supported</li>
 153 <li><b>osThreadGetState:</b> supported</li>
 154 <li><b>osThreadJoin:</b> <span class="XML-Token">not implemented</span></li>
 155 <li><b>osThreadNew:</b> supported</li>
 156 <li><b>osThreadResume:</b> supported</li>
 157 <li><b>osThreadSetPriority:</b> supported</li>
 158 <li><b>osThreadSuspend:</b> supported</li>
 159 <li><b>osThreadTerminate:</b> supported</li>
 160 <li><b>osThreadYield:</b> supported</li>
 161 </ul>
 162 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> </h2>
 163 <ul>
 164 <li><b>osThreadFlagsSet:</b> supported</li>
 165 <li><b>osThreadFlagsClear:</b> supported</li>
 166 <li><b>osThreadFlagsGet:</b> supported</li>
 167 <li><b>osThreadFlagsWait:</b> supported</li>
 168 </ul>
 169 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__EventFlags.html">Event Flags</a> </h2>
 170 <p>All event flags are limited to 24 bits.</p>
 171 <ul>
 172 <li><b>osEventFlagsGetName:</b> <span class="XML-Token">not implemented</span></li>
 173 <li><b>osEventFlagsNew:</b> supported</li>
 174 <li><b>osEventFlagsDelete:</b> supported</li>
 175 <li><b>osEventFlagsSet:</b> supported</li>
 176 <li><b>osEventFlagsClear:</b> supported</li>
 177 <li><b>osEventFlagsGet:</b> supported</li>
 178 <li><b>osEventFlagsWait:</b> cannot be called from an ISR.</li>
 179 </ul>
 180 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__Wait.html">Generic Wait Functions</a> </h2>
 181 <ul>
 182 <li><b>osDelay:</b> supported</li>
 183 <li><b>osDelayUntil:</b> supported</li>
 184 </ul>
 185 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__TimerMgmt.html">Timer Management</a> </h2>
 186 <ul>
 187 <li><b>osTimerDelete:</b> supported</li>
 188 <li><b>osTimerGetName:</b> supported</li>
 189 <li><b>osTimerIsRunning:</b> supported</li>
 190 <li><b>osTimerNew:</b> supported</li>
 191 <li><b>osTimerStart:</b> supported</li>
 192 <li><b>osTimerStop:</b> supported</li>
 193 </ul>
 194 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__MutexMgmt.html">Mutex Management</a> </h2>
 195 <p>Priority inherit protocol is used as default mutex behavior (osMutexNew creates priority inherit mutex object by default and ignores osMutexPrioInherit attribute when specified).<br/>
 196 Robust mutex objects are not supported (osMutexNew returns NULL when osMutexRobust attribute is specified).</p>
 197 <ul>
 198 <li><b>osMutexAcquire:</b> supported</li>
 199 <li><b>osMutexDelete:</b> supported</li>
 200 <li><b>osMutexGetName:</b> <span class="XML-Token">not implemented</span></li>
 201 <li><b>osMutexGetOwner:</b> supported</li>
 202 <li><b>osMutexNew:</b> supported</li>
 203 <li><b>osMutexRelease:</b> supported</li>
 204 </ul>
 205 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__SemaphoreMgmt.html">Semaphores</a> </h2>
 206 <ul>
 207 <li><b>osSemaphoreAcquire:</b> supported</li>
 208 <li><b>osSemaphoreDelete:</b> supported</li>
 209 <li><b>osSemaphoreGetCount:</b> supported</li>
 210 <li><b>osSemaphoreGetName:</b> <span class="XML-Token">not implemented</span></li>
 211 <li><b>osSemaphoreNew:</b> supported</li>
 212 <li><b>osSemaphoreRelease:</b> supported</li>
 213 </ul>
 214 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</a> </h2>
 215 <p>Memory Pool functions are not implemented and will always return with error.</p>
 216 <ul>
 217 <li><b>osMemoryPoolAlloc:</b> supported</li>
 218 <li><b>osMemoryPoolDelete:</b> supported</li>
 219 <li><b>osMemoryPoolFree:</b> supported</li>
 220 <li><b>osMemoryPoolGetBlockSize:</b> supported</li>
 221 <li><b>osMemoryPoolGetCapacity:</b> supported</li>
 222 <li><b>osMemoryPoolGetCount:</b> supported</li>
 223 <li><b>osMemoryPoolGetName:</b> supported</li>
 224 <li><b>osMemoryPoolGetSpace:</b> supported</li>
 225 <li><b>osMemoryPoolNew:</b> supported</li>
 226 </ul>
 227 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__Message.html">Message Queue</a> </h2>
 228 <ul>
 229 <li><b>osMessageQueueDelete:</b> supported</li>
 230 <li><b>osMessageQueueGet:</b> ignores message priority.</li>
 231 <li><b>osMessageQueueGetCapacity:</b> supported</li>
 232 <li><b>osMessageQueueGetCount:</b> supported</li>
 233 <li><b>osMessageQueueGetMsgSize:</b> supported</li>
 234 <li><b>osMessageQueueGetName:</b> <span class="XML-Token">not implemented</span></li>
 235 <li><b>osMessageQueueGetSpace:</b> supported</li>
 236 <li><b>osMessageQueueNew:</b> supported</li>
 237 <li><b>osMessageQueuePut:</b> ignores message priority.</li>
 238 <li><b>osMessageQueueReset:</b> supported </li>
 239 </ul>
 240 </div></div><!-- contents -->
 241 </div><!-- doc-content -->
 242 <!-- start footer part -->
 243 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 244   <ul>
 245     <li class="footer">
 246       <script type="text/javascript">
 247         <!--
 248         writeFooter.call(this);
 249         //-->
 250       </script>
 251     </li>
 252   </ul>
 253 </div>
 254 </body>
 255 </html>