begriffs open source - cmsis-freertos/blob - main/functionOverview.html

   1 <!-- HTML header for doxygen 1.9.2-->
   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">
   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-FreeRTOS: Function Overview</title>
   9 <link href="tabs.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 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20 <script type="text/javascript">
  21 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  22   $(document).ready(function() { init_search(); });
  23 /* @license-end */
  24 </script>
  25 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  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: 55px;">
  35   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  36   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  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   <!--END !PROJECT_NAME-->
  49    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  50         <span class="left">
  51           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  52           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  53                onfocus="searchBox.OnSearchFieldFocus(true)"
  54                onblur="searchBox.OnSearchFieldFocus(false)"
  55                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56           </span><span class="right">
  57             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  58           </span>
  59         </div>
  60 </td>
  61  </tr>
  62  </tbody>
  63 </table>
  64 </div>
  65 <!-- end header part -->
  66 <!-- Generated by Doxygen 1.9.6 -->
  67 <script type="text/javascript">
  68 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  69 var searchBox = new SearchBox("searchBox", "search/",'.html');
  70 /* @license-end */
  71 </script>
  72 </div><!-- top -->
  73 <div id="side-nav" class="ui-resizable side-nav-resizable">
  74   <div id="nav-tree">
  75     <div id="nav-tree-contents">
  76       <div id="nav-sync" class="sync"></div>
  77     </div>
  78   </div>
  79   <div id="splitbar" style="-moz-user-select:none;"
  80        class="ui-resizable-handle">
  81   </div>
  82 </div>
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 $(document).ready(function(){initNavTree('functionOverview.html',''); initResizable(); });
  86 /* @license-end */
  87 </script>
  88 <div id="doc-content">
  89 <!-- window showing the filter options -->
  90 <div id="MSearchSelectWindow"
  91      onmouseover="return searchBox.OnSearchSelectShow()"
  92      onmouseout="return searchBox.OnSearchSelectHide()"
  93      onkeydown="return searchBox.OnSearchSelectKey(event)">
  94 </div>
  95
  96 <!-- iframe showing the search results (closed by default) -->
  97 <div id="MSearchResultsWindow">
  98 <div id="MSearchResults">
  99 <div class="SRPage">
 100 <div id="SRIndex">
 101 <div id="SRResults"></div>
 102 <div class="SRStatus" id="Loading">Loading...</div>
 103 <div class="SRStatus" id="Searching">Searching...</div>
 104 <div class="SRStatus" id="NoMatches">No Matches</div>
 105 </div>
 106 </div>
 107 </div>
 108 </div>
 109
 110 <div><div class="header">
 111   <div class="headertitle"><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 class="anchor" id="autotoc_md2"></a>
 118 Kernel Information and Control</h2>
 119 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__KernelCtrl.html">API reference</a> for details about Kernel Information and Control functions.</p><ul>
 120 <li><b>osKernelInitialize:</b> supported</li>
 121 <li><b>osKernelGetInfo:</b> supported</li>
 122 <li><b>osKernelGetState:</b> supported</li>
 123 <li><b>osKernelStart:</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>osKernelSuspend:</b> <span class="XML-Token">not implemented</span></li>
 128 <li><b>osKernelResume:</b> <span class="XML-Token">not implemented</span></li>
 129 <li><b>osKernelProtect:</b> <span class="XML-Token">not implemented</span></li>
 130 <li><b>osKernelDestroyClass:</b> <span class="XML-Token">not implemented</span></li>
 131 <li><b>osKernelGetTickCount:</b> supported</li>
 132 <li><b>osKernelGetTickFreq:</b> supported</li>
 133 <li><b>osKernelGetSysTimerCount:</b> supported</li>
 134 <li><b>osKernelGetSysTimerFreq:</b> supported</li>
 135 </ul>
 136 <h2><a class="anchor" id="autotoc_md3"></a>
 137 Thread Management</h2>
 138 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__ThreadMgmt.html">API reference</a> for details about Thread Management functions.</p><ul>
 139 <li><b>osThreadNew:</b> supported</li>
 140 <li><b>osThreadGetName:</b> supported</li>
 141 <li><b>osThreadGetClass:</b> <span class="XML-Token">not implemented</span></li>
 142 <li><b>osThreadGetZone:</b> <span class="XML-Token">not implemented</span></li>
 143 <li><b>osThreadGetId:</b> supported</li>
 144 <li><b>osThreadGetState:</b> supported</li>
 145 <li><b>osThreadGetStackSize:</b> <span class="XML-Token">not implemented</span></li>
 146 <li><b>osThreadGetStackSpace:</b> supported</li>
 147 <li><b>osThreadSetPriority:</b> supported</li>
 148 <li><b>osThreadGetPriority:</b> supported</li>
 149 <li><b>osThreadYield:</b> supported</li>
 150 <li><b>osThreadSuspend:</b> supported</li>
 151 <li><b>osThreadResume:</b> supported</li>
 152 <li><b>osThreadDetach:</b> <span class="XML-Token">not implemented</span></li>
 153 <li><b>osThreadJoin:</b> <span class="XML-Token">not implemented</span></li>
 154 <li><b>osThreadExit:</b> supported</li>
 155 <li><b>osThreadTerminate:</b> supported</li>
 156 <li><b>osThreadFeedWatchdog:</b> <span class="XML-Token">not implemented</span></li>
 157 <li><b>osThreadProtectPrivileged:</b> <span class="XML-Token">not implemented</span></li>
 158 <li><b>osThreadSuspendClass:</b> <span class="XML-Token">not implemented</span></li>
 159 <li><b>osThreadResumeClass:</b> <span class="XML-Token">not implemented</span></li>
 160 <li><b>osThreadTerminateZone:</b> <span class="XML-Token">not implemented</span></li>
 161 <li><b>osThreadGetCount:</b> supported</li>
 162 <li><b>osThreadEnumerate:</b> supported</li>
 163 </ul>
 164 <h2><a class="anchor" id="autotoc_md4"></a>
 165 Thread Flags</h2>
 166 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__ThreadFlagsMgmt.html">API reference</a> for details about Thread Flags functions.</p><ul>
 167 <li><b>osThreadFlagsSet:</b> supported</li>
 168 <li><b>osThreadFlagsClear:</b> supported</li>
 169 <li><b>osThreadFlagsGet:</b> supported</li>
 170 <li><b>osThreadFlagsWait:</b> supported</li>
 171 </ul>
 172 <h2><a class="anchor" id="autotoc_md5"></a>
 173 Generic Wait Functions</h2>
 174 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__Wait.html">API reference</a> for details about Generic Wait functions.</p><ul>
 175 <li><b>osDelay:</b> supported</li>
 176 <li><b>osDelayUntil:</b> supported</li>
 177 </ul>
 178 <h2><a class="anchor" id="autotoc_md6"></a>
 179 Timer Management</h2>
 180 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__TimerMgmt.html">API reference</a> for details about Timer Management functions.</p><ul>
 181 <li><b>osTimerNew:</b> supported</li>
 182 <li><b>osTimerGetName:</b> supported</li>
 183 <li><b>osTimerStart:</b> supported</li>
 184 <li><b>osTimerStop:</b> supported</li>
 185 <li><b>osTimerIsRunning:</b> supported</li>
 186 <li><b>osTimerDelete:</b> supported</li>
 187 </ul>
 188 <h2><a class="anchor" id="autotoc_md7"></a>
 189 Event Flags</h2>
 190 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__EventFlags.html">API reference</a> for details about Event Flags functions. All event flags are limited to 24 bits.</p><ul>
 191 <li><b>osEventFlagsNew:</b> supported</li>
 192 <li><b>osEventFlagsGetName:</b> <span class="XML-Token">not implemented</span></li>
 193 <li><b>osEventFlagsSet:</b> supported</li>
 194 <li><b>osEventFlagsClear:</b> supported</li>
 195 <li><b>osEventFlagsGet:</b> supported</li>
 196 <li><b>osEventFlagsWait:</b> cannot be called from an ISR.</li>
 197 <li><b>osEventFlagsDelete:</b> supported</li>
 198 </ul>
 199 <h2><a class="anchor" id="autotoc_md8"></a>
 200 Mutex Management</h2>
 201 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__MutexMgmt.html">API reference</a> for details about Mutex Management functions.<br  />
 202 Priority inherit protocol is used as default mutex behavior (osMutexNew creates priority inherit mutex object by default and ignores osMutexPrioInherit attribute when specified).<br  />
 203 Robust mutex objects are not supported (osMutexNew returns NULL when osMutexRobust attribute is specified).<br  />
 204 </p><ul>
 205 <li><b>osMutexNew:</b> supported</li>
 206 <li><b>osMutexGetName:</b> <span class="XML-Token">not implemented</span></li>
 207 <li><b>osMutexAcquire:</b> supported</li>
 208 <li><b>osMutexRelease:</b> supported</li>
 209 <li><b>osMutexGetOwner:</b> supported</li>
 210 <li><b>osMutexDelete:</b> supported</li>
 211 </ul>
 212 <h2><a class="anchor" id="autotoc_md9"></a>
 213 Semaphores</h2>
 214 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__SemaphoreMgmt.html">API reference</a> for details about Semaphore functions.</p><ul>
 215 <li><b>osSemaphoreNew:</b> supported</li>
 216 <li><b>osSemaphoreGetName:</b> <span class="XML-Token">not implemented</span></li>
 217 <li><b>osSemaphoreAcquire:</b> supported</li>
 218 <li><b>osSemaphoreRelease:</b> supported</li>
 219 <li><b>osSemaphoreGetCount:</b> supported</li>
 220 <li><b>osSemaphoreDelete:</b> supported</li>
 221 </ul>
 222 <h2><a class="anchor" id="autotoc_md10"></a>
 223 Memory Pool</h2>
 224 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__PoolMgmt.html">API reference</a> for details about Memory Pool functions.</p><ul>
 225 <li><b>osMemoryPoolNew:</b> supported</li>
 226 <li><b>osMemoryPoolGetName:</b> supported</li>
 227 <li><b>osMemoryPoolAlloc:</b> supported</li>
 228 <li><b>osMemoryPoolFree:</b> supported</li>
 229 <li><b>osMemoryPoolGetCapacity:</b> supported</li>
 230 <li><b>osMemoryPoolGetBlockSize:</b> supported</li>
 231 <li><b>osMemoryPoolGetCount:</b> supported</li>
 232 <li><b>osMemoryPoolGetSpace:</b> supported</li>
 233 <li><b>osMemoryPoolDelete:</b> supported</li>
 234 </ul>
 235 <h2><a class="anchor" id="autotoc_md11"></a>
 236 Message Queue</h2>
 237 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/html/group__CMSIS__RTOS__Message.html">API reference</a> for details about Message Queue functions.</p><ul>
 238 <li><b>osMessageQueueNew:</b> supported</li>
 239 <li><b>osMessageQueueGetName:</b> <span class="XML-Token">not implemented</span></li>
 240 <li><b>osMessageQueuePut:</b> ignores message priority.</li>
 241 <li><b>osMessageQueueGet:</b> ignores message priority.</li>
 242 <li><b>osMessageQueueGetCapacity:</b> supported</li>
 243 <li><b>osMessageQueueGetMsgSize:</b> supported</li>
 244 <li><b>osMessageQueueGetCount:</b> supported</li>
 245 <li><b>osMessageQueueGetSpace:</b> supported</li>
 246 <li><b>osMessageQueueReset:</b> supported</li>
 247 <li><b>osMessageQueueDelete:</b> supported </li>
 248 </ul>
 249 </div></div><!-- contents -->
 250 </div><!-- PageDoc -->
 251 </div><!-- doc-content -->
 252 <!-- start footer part -->
 253 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 254   <ul>
 255     <li class="footer">
 256       <script type="text/javascript">
 257         <!--
 258         writeFooter.call(this);
 259         //-->
 260       </script>
 261     </li>
 262   </ul>
 263 </div>
 264 </body>
 265 </html>