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