begriffs open source - cmsis-freertos/blob - main/page_function_overview.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-FreeRTOS: Function Overview</title>
   9 <link href="doxygen.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="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="navtreedata.js"></script>
  17 <script type="text/javascript" src="navtree.js"></script>
  18 <script type="text/javascript" src="resize.js"></script>
  19 <script type="text/javascript" src="cookie.js"></script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/searchdata.js"></script>
  22 <script type="text/javascript" src="search/search.js"></script>
  23 <script type="text/javascript">
  24 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  25   $(function() { init_search(); });
  26 /* @license-end */
  27 </script>
  28 <script type="text/javascript" src="darkmode_toggle.js"></script>
  29 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  32 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  33 <link href="version.css" rel="stylesheet" type="text/css"/>
  34 <script type="text/javascript" src="../version.js"></script>
  35 </head>
  36 <body>
  37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  38 <div id="titlearea">
  39 <table cellspacing="0" cellpadding="0">
  40  <tbody>
  41  <tr style="height: 55px;">
  42   <td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="cmsis_logo_white_small.png"/</a></td>
  43   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  44    <div id="projectname">CMSIS-FreeRTOS
  45    &#160;<span id="projectnumber"><script type="text/javascript">
  46      <!--
  47      writeHeader.call(this);
  48      writeVersionDropdown.call(this, "CMSIS-FreeRTOS");
  49      //-->
  50     </script>
  51    </span>
  52    </div>
  53    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  54   </td>
  55    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  56         <span class="left">
  57           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  58           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  59                onfocus="searchBox.OnSearchFieldFocus(true)"
  60                onblur="searchBox.OnSearchFieldFocus(false)"
  61                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  62           </span><span class="right">
  63             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  64           </span>
  65         </div>
  66 </td>
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <!-- Generated by Doxygen 1.13.2 -->
  80 <script type="text/javascript">
  81 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82 var searchBox = new SearchBox("searchBox", "search/",'.html');
  83 /* @license-end */
  84 </script>
  85 <script type="text/javascript">
  86 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  87 $(function() { codefold.init(0); });
  88 /* @license-end */
  89 </script>
  90 </div><!-- top -->
  91 <div id="side-nav" class="ui-resizable side-nav-resizable">
  92   <div id="nav-tree">
  93     <div id="nav-tree-contents">
  94       <div id="nav-sync" class="sync"></div>
  95     </div>
  96   </div>
  97   <div id="splitbar" style="-moz-user-select:none;"
  98        class="ui-resizable-handle">
  99   </div>
 100 </div>
 101 <script type="text/javascript">
 102 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 103 $(function(){initNavTree('page_function_overview.html',''); initResizable(true); });
 104 /* @license-end */
 105 </script>
 106 <div id="doc-content">
 107 <!-- window showing the filter options -->
 108 <div id="MSearchSelectWindow"
 109      onmouseover="return searchBox.OnSearchSelectShow()"
 110      onmouseout="return searchBox.OnSearchSelectHide()"
 111      onkeydown="return searchBox.OnSearchSelectKey(event)">
 112 </div>
 113
 114 <!-- iframe showing the search results (closed by default) -->
 115 <div id="MSearchResultsWindow">
 116 <div id="MSearchResults">
 117 <div class="SRPage">
 118 <div id="SRIndex">
 119 <div id="SRResults"></div>
 120 <div class="SRStatus" id="Loading">Loading...</div>
 121 <div class="SRStatus" id="Searching">Searching...</div>
 122 <div class="SRStatus" id="NoMatches">No Matches</div>
 123 </div>
 124 </div>
 125 </div>
 126 </div>
 127
 128 <div><div class="header">
 129   <div class="headertitle"><div class="title">Function Overview</div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132 <div class="textblock"><p><a class="anchor" id="md_src_2function__overview"></a></p>
 133 <h1><a class="anchor" id="autotoc_md13"></a>
 134 CMSIS-RTOS2 API</h1>
 135 <p>Overview of all CMSIS-RTOS C API v2 functions that are implemented in CMSIS-FreeRTOS.</p>
 136 <h2><a class="anchor" id="autotoc_md14"></a>
 137 Kernel Information and Control</h2>
 138 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__KernelCtrl.html">API reference</a> for details about Kernel Information and Control functions.</p>
 139 <ul>
 140 <li><b>osKernelInitialize:</b> supported</li>
 141 <li><b>osKernelGetInfo:</b> supported</li>
 142 <li><b>osKernelGetState:</b> supported</li>
 143 <li><b>osKernelStart:</b> supported</li>
 144 <li><b>osKernelLock:</b> supported</li>
 145 <li><b>osKernelUnlock:</b> supported</li>
 146 <li><b>osKernelRestoreLock:</b> supported</li>
 147 <li><b>osKernelSuspend:</b> <em>not implemented</em></li>
 148 <li><b>osKernelResume:</b> <em>not implemented</em></li>
 149 <li><b>osKernelProtect:</b> <em>not implemented</em></li>
 150 <li><b>osKernelDestroyClass:</b> <em>not implemented</em></li>
 151 <li><b>osKernelGetTickCount:</b> supported</li>
 152 <li><b>osKernelGetTickFreq:</b> supported</li>
 153 <li><b>osKernelGetSysTimerCount:</b> supported</li>
 154 <li><b>osKernelGetSysTimerFreq:</b> supported</li>
 155 </ul>
 156 <h2><a class="anchor" id="autotoc_md15"></a>
 157 Thread Management</h2>
 158 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__ThreadMgmt.html">API reference</a> for details about Thread Management functions.</p>
 159 <ul>
 160 <li><b>osThreadNew:</b> supported</li>
 161 <li><b>osThreadGetName:</b> supported</li>
 162 <li><b>osThreadGetClass:</b> <em>not implemented</em></li>
 163 <li><b>osThreadGetZone:</b> <em>not implemented</em></li>
 164 <li><b>osThreadGetId:</b> supported</li>
 165 <li><b>osThreadGetState:</b> supported</li>
 166 <li><b>osThreadGetStackSize:</b> <em>not implemented</em></li>
 167 <li><b>osThreadGetStackSpace:</b> supported</li>
 168 <li><b>osThreadSetPriority:</b> supported</li>
 169 <li><b>osThreadGetPriority:</b> supported</li>
 170 <li><b>osThreadYield:</b> supported</li>
 171 <li><b>osThreadSuspend:</b> supported</li>
 172 <li><b>osThreadResume:</b> supported</li>
 173 <li><b>osThreadDetach:</b> <em>not implemented</em></li>
 174 <li><b>osThreadJoin:</b> <em>not implemented</em></li>
 175 <li><b>osThreadExit:</b> supported</li>
 176 <li><b>osThreadTerminate:</b> supported</li>
 177 <li><b>osThreadFeedWatchdog:</b> <em>not implemented</em></li>
 178 <li><b>osThreadProtectPrivileged:</b> <em>not implemented</em></li>
 179 <li><b>osThreadSuspendClass:</b> <em>not implemented</em></li>
 180 <li><b>osThreadResumeClass:</b> <em>not implemented</em></li>
 181 <li><b>osThreadTerminateZone:</b> <em>not implemented</em></li>
 182 <li><b>osThreadGetCount:</b> supported</li>
 183 <li><b>osThreadEnumerate:</b> supported</li>
 184 </ul>
 185 <h2><a class="anchor" id="autotoc_md16"></a>
 186 Thread Flags</h2>
 187 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__ThreadFlagsMgmt.html">API reference</a> for details about Thread Flags functions.</p>
 188 <ul>
 189 <li><b>osThreadFlagsSet:</b> supported</li>
 190 <li><b>osThreadFlagsClear:</b> supported</li>
 191 <li><b>osThreadFlagsGet:</b> supported</li>
 192 <li><b>osThreadFlagsWait:</b> supported</li>
 193 </ul>
 194 <h2><a class="anchor" id="autotoc_md17"></a>
 195 Generic Wait Functions</h2>
 196 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__Wait.html">API reference</a> for details about Generic Wait functions.</p>
 197 <ul>
 198 <li><b>osDelay:</b> supported</li>
 199 <li><b>osDelayUntil:</b> supported</li>
 200 </ul>
 201 <h2><a class="anchor" id="autotoc_md18"></a>
 202 Timer Management</h2>
 203 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__TimerMgmt.html">API reference</a> for details about Timer Management functions.</p>
 204 <ul>
 205 <li><b>osTimerNew:</b> supported</li>
 206 <li><b>osTimerGetName:</b> supported</li>
 207 <li><b>osTimerStart:</b> supported</li>
 208 <li><b>osTimerStop:</b> supported</li>
 209 <li><b>osTimerIsRunning:</b> supported</li>
 210 <li><b>osTimerDelete:</b> supported</li>
 211 </ul>
 212 <h2><a class="anchor" id="autotoc_md19"></a>
 213 Event Flags</h2>
 214 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__EventFlags.html">API reference</a> for details about Event Flags functions. All event flags are limited to 24 bits.</p>
 215 <ul>
 216 <li><b>osEventFlagsNew:</b> supported</li>
 217 <li><b>osEventFlagsGetName:</b> <em>not implemented</em></li>
 218 <li><b>osEventFlagsSet:</b> supported</li>
 219 <li><b>osEventFlagsClear:</b> supported</li>
 220 <li><b>osEventFlagsGet:</b> supported</li>
 221 <li><b>osEventFlagsWait:</b> cannot be called from an ISR.</li>
 222 <li><b>osEventFlagsDelete:</b> supported</li>
 223 </ul>
 224 <h2><a class="anchor" id="autotoc_md20"></a>
 225 Mutex Management</h2>
 226 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__MutexMgmt.html">API reference</a> for details about Mutex Management functions. Priority inherit protocol is used as default mutex behavior (<code>osMutexNew</code> creates priority inherit mutex object by default and ignores <code>osMutexPrioInherit</code> attribute when specified). Robust mutex objects are not supported (<code>osMutexNew</code> returns NULL when <code>osMutexRobust</code> attribute is specified).</p>
 227 <ul>
 228 <li><b>osMutexNew:</b> supported</li>
 229 <li><b>osMutexGetName:</b> <em>not implemented</em></li>
 230 <li><b>osMutexAcquire:</b> supported</li>
 231 <li><b>osMutexRelease:</b> supported</li>
 232 <li><b>osMutexGetOwner:</b> supported</li>
 233 <li><b>osMutexDelete:</b> supported</li>
 234 </ul>
 235 <h2><a class="anchor" id="autotoc_md21"></a>
 236 Semaphores</h2>
 237 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__SemaphoreMgmt.html">API reference</a> for details about Semaphore functions.</p>
 238 <ul>
 239 <li><b>osSemaphoreNew:</b> supported</li>
 240 <li><b>osSemaphoreGetName:</b> <em>not implemented</em></li>
 241 <li><b>osSemaphoreAcquire:</b> supported</li>
 242 <li><b>osSemaphoreRelease:</b> supported</li>
 243 <li><b>osSemaphoreGetCount:</b> supported</li>
 244 <li><b>osSemaphoreDelete:</b> supported</li>
 245 </ul>
 246 <h2><a class="anchor" id="autotoc_md22"></a>
 247 Memory Pool</h2>
 248 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__PoolMgmt.html">API reference</a> for details about Memory Pool functions.</p>
 249 <ul>
 250 <li><b>osMemoryPoolNew:</b> supported</li>
 251 <li><b>osMemoryPoolGetName:</b> supported</li>
 252 <li><b>osMemoryPoolAlloc:</b> supported</li>
 253 <li><b>osMemoryPoolFree:</b> supported</li>
 254 <li><b>osMemoryPoolGetCapacity:</b> supported</li>
 255 <li><b>osMemoryPoolGetBlockSize:</b> supported</li>
 256 <li><b>osMemoryPoolGetCount:</b> supported</li>
 257 <li><b>osMemoryPoolGetSpace:</b> supported</li>
 258 <li><b>osMemoryPoolDelete:</b> supported</li>
 259 </ul>
 260 <h2><a class="anchor" id="autotoc_md23"></a>
 261 Message Queue</h2>
 262 <p>See <a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__Message.html">API reference</a> for details about Message Queue functions.</p>
 263 <ul>
 264 <li><b>osMessageQueueNew:</b> supported</li>
 265 <li><b>osMessageQueueGetName:</b> <em>not implemented</em></li>
 266 <li><b>osMessageQueuePut:</b> ignores message priority.</li>
 267 <li><b>osMessageQueueGet:</b> ignores message priority.</li>
 268 <li><b>osMessageQueueGetCapacity:</b> supported</li>
 269 <li><b>osMessageQueueGetMsgSize:</b> supported</li>
 270 <li><b>osMessageQueueGetCount:</b> supported</li>
 271 <li><b>osMessageQueueGetSpace:</b> supported</li>
 272 <li><b>osMessageQueueReset:</b> supported</li>
 273 <li><b>osMessageQueueDelete:</b> supported </li>
 274 </ul>
 275 </div></div><!-- contents -->
 276 </div><!-- PageDoc -->
 277 </div><!-- doc-content -->
 278 <!-- start footer part -->
 279 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 280   <ul>
 281     <li class="footer">
 282       <script type="text/javascript">
 283         <!--
 284         writeFooter.call(this);
 285         //-->
 286       </script>
 287     </li>
 288   </ul>
 289 </div>
 290 </body>
 291 </html>