begriffs open source - cmsis-freertos/blob - docs/General/html/tech_data.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>Technical data and limitations</title>
   7 <title>CMSIS-FreeRTOS: Technical data and limitations</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.1</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('tech_data.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">Technical data and limitations </div>  </div>
 112 </div><!--header-->
 113 <div class="contents">
 114 <div class="textblock"><p>This lists the technical data of CMSIS-FreeRTOS.</p>
 115 <h1><a class="anchor" id="td_limitations"></a>
 116 Limitations</h1>
 117 <p>The following list briefly describes the limitations and unsupported features of the CMSIS-RTOS2 wrapper for FreeRTOS:</p>
 118 <ul>
 119 <li>Static memory allocation will only work if <em>all</em> memory (from attributes structure) is provided statically. In order to allocate object memory statically, you need to:<ul>
 120 <li>provide the memory for control blocks and stack in the <code>osThreadAttr_t</code> structure for threads.</li>
 121 <li>provide the memory for control blocks and message data in the <code>osMessageQueueAttr_t</code> structure for memory queues.</li>
 122 <li>provide the memory for control blocks for other objects in the object's attributes structure.</li>
 123 </ul>
 124 </li>
 125 <li>Each timer object requires additional 8 bytes of dynamic memory.</li>
 126 <li><code>osKernelSuspend</code> and <code>osKernelResume</code> are not supported.</li>
 127 <li><code>osKernelGetTickCount</code> is limited to a 32-bit return value.</li>
 128 <li><code>osThreadDetach</code>, <code>osThreadJoin()</code> and attribute <code>osThreadJoinable</code> are not supported (<code>osThreadNew</code> returns NULL when osThreadJoinable attribute is specified).</li>
 129 <li><code>osThreadGetStackSize</code> is not implemented.</li>
 130 <li>Event flags are limited to 24 bits.</li>
 131 <li><code>osEventFlagsGetName</code> is not implemented.</li>
 132 <li><code>osEventFlagsWait</code> cannot be called from an ISR.</li>
 133 <li>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).</li>
 134 <li>Robust mutex objects are not supported (<code>osMutexNew</code> returns NULL when <code>osMutexRobust</code> attribute is specified).</li>
 135 <li><code>osMutexGetName</code> is not implemented and always returns NULL.</li>
 136 <li><code>osSemaphoreGetName</code> is not implemented and always returns NULL.</li>
 137 <li><code>osMessageQueueGetName</code> is not implemented and always returns NULL.</li>
 138 <li><code>osMessageQueuePut</code> and <code>osMessageQueueGet</code> always ignore message priority.</li>
 139 </ul>
 140 <h1><a class="anchor" id="td_validation"></a>
 141 CMSIS-RTOS validation suite results</h1>
 142 <p>CMSIS provides a <a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/rtosValidation.html" target="_blank">validation suite</a> that can be used to test a real-time operating system for compliance to the standard. The test suite has been run successfully on the CMSIS-FreeRTOS implementation with the following exceptions:</p>
 143 <p><b>TC_ThreadParam:</b> </p>
 144 <ul>
 145 <li>Reason: unsupported feature</li>
 146 <li>Test attempts to test <code>osThreadJoin</code> and <code>osThreadDetach</code> functions for invalid parameter input. These two functions are not implemented.</li>
 147 </ul>
 148 <p><b>TC_ThreadInterrupts:</b> </p>
 149 <ul>
 150 <li>Reason: unsupported feature</li>
 151 <li>Test attempts to call <code>osThreadJoin</code> and <code>osThreadDetach</code> from the ISR. These two functions are not implemented.</li>
 152 </ul>
 153 <p><b>TC_EventFlagsInterrupts:</b> </p>
 154 <ul>
 155 <li>Reason: unsupported feature</li>
 156 <li>Test attempts to call <code>osEventFlagsWait</code> from the ISR. Wrapper implementation does not allow function <code>osEventFlagsWait</code> to be called from interrupts.</li>
 157 </ul>
 158 <p><b>TC_MutexRobust:</b> </p>
 159 <ul>
 160 <li>Reason: unsupported feature</li>
 161 <li>Test attempts to create robust mutex. FreeRTOS implementation does not support robust mutexes.</li>
 162 </ul>
 163 <p><b>TC_MutexOwnership:</b> </p>
 164 <ul>
 165 <li>Reason: unsupported feature</li>
 166 <li>Test attempts to release a mutex from a thread which is not the mutex owner. Test fails, because FreeRTOS implementation does not verify ownership on mutex release. </li>
 167 </ul>
 168 </div></div><!-- contents -->
 169 </div><!-- doc-content -->
 170 <!-- start footer part -->
 171 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 172   <ul>
 173     <li class="footer">Generated on Thu Apr 30 2020 11:16:53 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
 174         <!--
 175     <a href="http://www.doxygen.org/index.html">
 176     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 177         -->
 178         </li>
 179   </ul>
 180 </div>
 181 </body>
 182 </html>