begriffs open source - cmsis-freertos/blob - docs/General/html/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="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-FreeRTOS
  35    &#160;<span id="projectnumber">Version 10.3.0</span>
  36    </div>
  37    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS 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('functionOverview.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>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>
 101
 102 <!-- iframe showing the search results (closed by default) -->
 103 <div id="MSearchResultsWindow">
 104 <iframe src="javascript:void(0)" frameborder="0"
 105         name="MSearchResults" id="MSearchResults">
 106 </iframe>
 107 </div>
 108
 109 <div class="header">
 110   <div class="headertitle">
 111 <div class="title">Function Overview </div>  </div>
 112 </div><!--header-->
 113 <div class="contents">
 114 <div class="textblock"><h1><a class="anchor" id="rtos_api2"></a>
 115 CMSIS-RTOS2 API</h1>
 116 <p>Overview of all CMSIS-RTOS C API v2 functions that are implemented in CMSIS-FreeRTOS.</p>
 117 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__KernelCtrl.html">Kernel Information and Control</a> </h2>
 118 <ul>
 119 <li><b>osKernelGetInfo:</b> supported</li>
 120 <li><b>osKernelGetState:</b> supported</li>
 121 <li><b>osKernelGetSysTimerCount:</b> supported</li>
 122 <li><b>osKernelGetSysTimerFreq:</b> supported</li>
 123 <li><b>osKernelInitialize:</b> supported</li>
 124 <li><b>osKernelLock:</b> supported</li>
 125 <li><b>osKernelUnlock:</b> supported</li>
 126 <li><b>osKernelRestoreLock:</b> supported</li>
 127 <li><b>osKernelResume:</b> <span class="XML-Token">not implemented</span></li>
 128 <li><b>osKernelStart:</b> supported</li>
 129 <li><b>osKernelSuspend:</b> <span class="XML-Token">not implemented</span></li>
 130 <li><b>osKernelGetTickCount:</b> limited to 32-bit return value.</li>
 131 <li><b>osKernelGetTickFreq:</b> supported</li>
 132 </ul>
 133 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__ThreadMgmt.html">Thread Management</a> </h2>
 134 <ul>
 135 <li><b>osThreadDetach:</b> <span class="XML-Token">not implemented</span></li>
 136 <li><b>osThreadEnumerate:</b> supported</li>
 137 <li><b>osThreadExit:</b> supported</li>
 138 <li><b>osThreadGetCount:</b> supported</li>
 139 <li><b>osThreadGetId:</b> supported</li>
 140 <li><b>osThreadGetName:</b> supported</li>
 141 <li><b>osThreadGetPriority:</b> supported</li>
 142 <li><b>osThreadGetStackSize:</b> <span class="XML-Token">not implemented</span></li>
 143 <li><b>osThreadGetStackSpace:</b> supported</li>
 144 <li><b>osThreadGetState:</b> supported</li>
 145 <li><b>osThreadJoin:</b> <span class="XML-Token">not implemented</span></li>
 146 <li><b>osThreadNew:</b> supported</li>
 147 <li><b>osThreadResume:</b> supported</li>
 148 <li><b>osThreadSetPriority:</b> supported</li>
 149 <li><b>osThreadSuspend:</b> supported</li>
 150 <li><b>osThreadTerminate:</b> supported</li>
 151 <li><b>osThreadYield:</b> supported</li>
 152 </ul>
 153 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> </h2>
 154 <ul>
 155 <li><b>osThreadFlagsSet:</b> supported</li>
 156 <li><b>osThreadFlagsClear:</b> supported</li>
 157 <li><b>osThreadFlagsGet:</b> supported</li>
 158 <li><b>osThreadFlagsWait:</b> supported</li>
 159 </ul>
 160 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__EventFlags.html">Event Flags</a> </h2>
 161 <p>All event flags are limited to 24 bits.</p>
 162 <ul>
 163 <li><b>osEventFlagsGetName:</b> <span class="XML-Token">not implemented</span></li>
 164 <li><b>osEventFlagsNew:</b> supported</li>
 165 <li><b>osEventFlagsDelete:</b> supported</li>
 166 <li><b>osEventFlagsSet:</b> supported</li>
 167 <li><b>osEventFlagsClear:</b> supported</li>
 168 <li><b>osEventFlagsGet:</b> supported</li>
 169 <li><b>osEventFlagsWait:</b> cannot be called from an ISR.</li>
 170 </ul>
 171 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__Wait.html">Generic Wait Functions</a> </h2>
 172 <ul>
 173 <li><b>osDelay:</b> supported</li>
 174 <li><b>osDelayUntil:</b> supported</li>
 175 </ul>
 176 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__TimerMgmt.html">Timer Management</a> </h2>
 177 <ul>
 178 <li><b>osTimerDelete:</b> supported</li>
 179 <li><b>osTimerGetName:</b> supported</li>
 180 <li><b>osTimerIsRunning:</b> supported</li>
 181 <li><b>osTimerNew:</b> supported</li>
 182 <li><b>osTimerStart:</b> supported</li>
 183 <li><b>osTimerStop:</b> supported</li>
 184 </ul>
 185 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__MutexMgmt.html">Mutex Management</a> </h2>
 186 <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/>
 187 Robust mutex objects are not supported (osMutexNew returns NULL when osMutexRobust attribute is specified).</p>
 188 <ul>
 189 <li><b>osMutexAcquire:</b> supported</li>
 190 <li><b>osMutexDelete:</b> supported</li>
 191 <li><b>osMutexGetName:</b> <span class="XML-Token">not implemented</span></li>
 192 <li><b>osMutexGetOwner:</b> supported</li>
 193 <li><b>osMutexNew:</b> supported</li>
 194 <li><b>osMutexRelease:</b> supported</li>
 195 </ul>
 196 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__SemaphoreMgmt.html">Semaphores</a> </h2>
 197 <ul>
 198 <li><b>osSemaphoreAcquire:</b> supported</li>
 199 <li><b>osSemaphoreDelete:</b> supported</li>
 200 <li><b>osSemaphoreGetCount:</b> supported</li>
 201 <li><b>osSemaphoreGetName:</b> <span class="XML-Token">not implemented</span></li>
 202 <li><b>osSemaphoreNew:</b> supported</li>
 203 <li><b>osSemaphoreRelease:</b> supported</li>
 204 </ul>
 205 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</a> </h2>
 206 <p>Memory Pool functions are not implemented and will always return with error.</p>
 207 <ul>
 208 <li><b>osMemoryPoolAlloc:</b> supported</li>
 209 <li><b>osMemoryPoolDelete:</b> supported</li>
 210 <li><b>osMemoryPoolFree:</b> supported</li>
 211 <li><b>osMemoryPoolGetBlockSize:</b> supported</li>
 212 <li><b>osMemoryPoolGetCapacity:</b> supported</li>
 213 <li><b>osMemoryPoolGetCount:</b> supported</li>
 214 <li><b>osMemoryPoolGetName:</b> supported</li>
 215 <li><b>osMemoryPoolGetSpace:</b> supported</li>
 216 <li><b>osMemoryPoolNew:</b> supported</li>
 217 </ul>
 218 <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__Message.html">Message Queue</a> </h2>
 219 <ul>
 220 <li><b>osMessageQueueDelete:</b> supported</li>
 221 <li><b>osMessageQueueGet:</b> ignores message priority.</li>
 222 <li><b>osMessageQueueGetCapacity:</b> supported</li>
 223 <li><b>osMessageQueueGetCount:</b> supported</li>
 224 <li><b>osMessageQueueGetMsgSize:</b> supported</li>
 225 <li><b>osMessageQueueGetName:</b> <span class="XML-Token">not implemented</span></li>
 226 <li><b>osMessageQueueGetSpace:</b> supported</li>
 227 <li><b>osMessageQueueNew:</b> supported</li>
 228 <li><b>osMessageQueuePut:</b> ignores message priority.</li>
 229 <li><b>osMessageQueueReset:</b> supported </li>
 230 </ul>
 231 </div></div><!-- contents -->
 232 </div><!-- doc-content -->
 233 <!-- start footer part -->
 234 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 235   <ul>
 236     <li class="footer">Generated on Wed Dec 4 2019 07:44:08 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
 237         <!--
 238     <a href="http://www.doxygen.org/index.html">
 239     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 240         -->
 241         </li>
 242   </ul>
 243 </div>
 244 </body>
 245 </html>