begriffs open source - cmsis/blob - main/RTOS2/html/group__CMSIS__RTOS__Definitions.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-RTOS2: Definitions</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-RTOS2
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-RTOS2");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Real-Time Operating System API</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__CMSIS__RTOS__Definitions.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#groups">Content</a> &#124;
 132 <a href="#define-members">Macros</a> &#124;
 133 <a href="#enum-members">Enumerations</a>  </div>
 134   <div class="headertitle"><div class="title">Definitions<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS API v2</a></div></div></div>
 135 </div><!--header-->
 136 <div class="contents">
 137
 138 <p>Constants and enumerations used by many CMSIS-RTOS functions.
 139 <a href="#details">More...</a></p>
 140 <table class="memberdecls">
 141 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 142 Content</h2></td></tr>
 143 <tr class="memitem:group__flags__error__codes"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a></td></tr>
 144 <tr class="memdesc:group__flags__error__codes"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constants used by <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> and <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a> to return error codes. <br /></td></tr>
 145 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 </table><table class="memberdecls">
 147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 148 Macros</h2></td></tr>
 149 <tr class="memitem:ga9eb9a7a797a42e4b55eb171ecc609ddb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a>&#160;&#160;&#160;0xFFFFFFFFU</td></tr>
 150 <tr class="memdesc:ga9eb9a7a797a42e4b55eb171ecc609ddb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait forever timeout value.  <br /></td></tr>
 151 <tr class="separator:ga9eb9a7a797a42e4b55eb171ecc609ddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ga18e63587b8450d5b8798b6f6ec04e012"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga18e63587b8450d5b8798b6f6ec04e012">osFlagsWaitAny</a>&#160;&#160;&#160;0x00000000U</td></tr>
 153 <tr class="memdesc:ga18e63587b8450d5b8798b6f6ec04e012"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for any flag (default).  <br /></td></tr>
 154 <tr class="separator:ga18e63587b8450d5b8798b6f6ec04e012"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:ga8b6f562736fbfb5428940e0c017dec24"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga8b6f562736fbfb5428940e0c017dec24">osFlagsWaitAll</a>&#160;&#160;&#160;0x00000001U</td></tr>
 156 <tr class="memdesc:ga8b6f562736fbfb5428940e0c017dec24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for all flags.  <br /></td></tr>
 157 <tr class="separator:ga8b6f562736fbfb5428940e0c017dec24"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:gaade844a42237d8c37569d4d9b16b9f1c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#gaade844a42237d8c37569d4d9b16b9f1c">osFlagsNoClear</a>&#160;&#160;&#160;0x00000002U</td></tr>
 159 <tr class="memdesc:gaade844a42237d8c37569d4d9b16b9f1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Do not clear flags which have been specified to wait for.  <br /></td></tr>
 160 <tr class="separator:gaade844a42237d8c37569d4d9b16b9f1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:ga604fce4f5205f92c347eb62fcc216861"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga604fce4f5205f92c347eb62fcc216861">osSafetyClass</a>(n)</td></tr>
 162 <tr class="memdesc:ga604fce4f5205f92c347eb62fcc216861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safety class value in attribute bit field format.  <br /></td></tr>
 163 <tr class="separator:ga604fce4f5205f92c347eb62fcc216861"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:ga7abd2d95425d9e02672778b3464b2eaa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga7abd2d95425d9e02672778b3464b2eaa">osSafetyWithSameClass</a>&#160;&#160;&#160;0x00000001U</td></tr>
 165 <tr class="memdesc:ga7abd2d95425d9e02672778b3464b2eaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Objects with same safety class.  <br /></td></tr>
 166 <tr class="separator:ga7abd2d95425d9e02672778b3464b2eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:ga8c77ee126b9215425fc004ee13cdc6de"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga8c77ee126b9215425fc004ee13cdc6de">osSafetyWithLowerClass</a>&#160;&#160;&#160;0x00000002U</td></tr>
 168 <tr class="memdesc:ga8c77ee126b9215425fc004ee13cdc6de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Objects with lower safety class.  <br /></td></tr>
 169 <tr class="separator:ga8c77ee126b9215425fc004ee13cdc6de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 </table><table class="memberdecls">
 171 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 172 Enumerations</h2></td></tr>
 173 <tr class="memitem:ga6c0dbe6069e4e7f47bb4cd32ae2b813e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> { <br />
 174 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea9e1c9e2550bb4de8969a935acffc968f">osOK</a> = 0
 175 , <br />
 176 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813eabb7b2d2c4efa66df42f1c10635467b09">osError</a> = -1
 177 , <br />
 178 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea913eb5df15ad85f8557eb3a456b56879">osErrorTimeout</a> = -2
 179 , <br />
 180 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea8fc5801e8b0482bdf22ad63a77f0155d">osErrorResource</a> = -3
 181 , <br />
 182 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813eac24adca6a5d072c9f01c32178ba0d109">osErrorParameter</a> = -4
 183 , <br />
 184 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813eaf1fac0240218e51eb30a13da2f8aae81">osErrorNoMemory</a> = -5
 185 , <br />
 186 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea21635bdc492d3094fe83027fa4a30e2f">osErrorISR</a> = -6
 187 , <br />
 188 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813eafe45a75293a0a97dcabb8bdd193145c5">osErrorSafetyClass</a> = -7
 189 , <br />
 190 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea66cc9ce9106b508df0e4a733a55a439d">osStatusReserved</a> = 0x7FFFFFFF
 191 <br />
 192  }</td></tr>
 193 <tr class="memdesc:ga6c0dbe6069e4e7f47bb4cd32ae2b813e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Status code values returned by CMSIS-RTOS functions.  <a href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">More...</a><br /></td></tr>
 194 <tr class="separator:ga6c0dbe6069e4e7f47bb4cd32ae2b813e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 195 </table>
 196 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 197 <p>The following constants and enumerations are used by many CMSIS-RTOS function calls. </p>
 198 <h2 class="groupheader">Macro Definition Documentation</h2>
 199 <a id="ga9eb9a7a797a42e4b55eb171ecc609ddb" name="ga9eb9a7a797a42e4b55eb171ecc609ddb"></a>
 200 <h2 class="memtitle"><span class="permalink"><a href="#ga9eb9a7a797a42e4b55eb171ecc609ddb">&#9670;&#160;</a></span>osWaitForever</h2>
 201
 202 <div class="memitem">
 203 <div class="memproto">
 204       <table class="memname">
 205         <tr>
 206           <td class="memname">#define osWaitForever&#160;&#160;&#160;0xFFFFFFFFU</td>
 207         </tr>
 208       </table>
 209 </div><div class="memdoc">
 210 <p>A special CMSIS_RTOS_TimeOutValue that informs the RTOS to wait infinite until a resource becomes available. It applies to the following functions:</p><ul>
 211 <li><a class="el" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a> :  Wait for Timeout (Time Delay).  </li>
 212 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> :  Wait for one or more Thread Flags of the current running thread to become signaled.  </li>
 213 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> :  Wait for one or more Event Flags to become signaled.  </li>
 214 <li><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a> :  Acquire a Mutex or timeout if it is locked.  </li>
 215 <li><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7e94c8b242a0c81f2cc79ec22895c87b">osSemaphoreAcquire</a> :  Acquire a Semaphore token or timeout if no tokens are available.  </li>
 216 <li><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> :  Allocate a memory block from a Memory Pool.  </li>
 217 <li><a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> :  Put a Message into a Queue or timeout if Queue is full.  </li>
 218 <li><a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> :  Get a Message from a Queue or timeout if Queue is empty.   </li>
 219 </ul>
 220
 221 </div>
 222 </div>
 223 <a id="ga18e63587b8450d5b8798b6f6ec04e012" name="ga18e63587b8450d5b8798b6f6ec04e012"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#ga18e63587b8450d5b8798b6f6ec04e012">&#9670;&#160;</a></span>osFlagsWaitAny</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">#define osFlagsWaitAny&#160;&#160;&#160;0x00000000U</td>
 231         </tr>
 232       </table>
 233 </div><div class="memdoc">
 234 <p>Reference:</p><ul>
 235 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 236 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 237 </ul>
 238
 239 </div>
 240 </div>
 241 <a id="ga8b6f562736fbfb5428940e0c017dec24" name="ga8b6f562736fbfb5428940e0c017dec24"></a>
 242 <h2 class="memtitle"><span class="permalink"><a href="#ga8b6f562736fbfb5428940e0c017dec24">&#9670;&#160;</a></span>osFlagsWaitAll</h2>
 243
 244 <div class="memitem">
 245 <div class="memproto">
 246       <table class="memname">
 247         <tr>
 248           <td class="memname">#define osFlagsWaitAll&#160;&#160;&#160;0x00000001U</td>
 249         </tr>
 250       </table>
 251 </div><div class="memdoc">
 252 <p>Reference:</p><ul>
 253 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 254 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 255 </ul>
 256
 257 </div>
 258 </div>
 259 <a id="gaade844a42237d8c37569d4d9b16b9f1c" name="gaade844a42237d8c37569d4d9b16b9f1c"></a>
 260 <h2 class="memtitle"><span class="permalink"><a href="#gaade844a42237d8c37569d4d9b16b9f1c">&#9670;&#160;</a></span>osFlagsNoClear</h2>
 261
 262 <div class="memitem">
 263 <div class="memproto">
 264       <table class="memname">
 265         <tr>
 266           <td class="memname">#define osFlagsNoClear&#160;&#160;&#160;0x00000002U</td>
 267         </tr>
 268       </table>
 269 </div><div class="memdoc">
 270 <p>Reference:</p><ul>
 271 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 272 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 273 </ul>
 274
 275 </div>
 276 </div>
 277 <a id="ga604fce4f5205f92c347eb62fcc216861" name="ga604fce4f5205f92c347eb62fcc216861"></a>
 278 <h2 class="memtitle"><span class="permalink"><a href="#ga604fce4f5205f92c347eb62fcc216861">&#9670;&#160;</a></span>osSafetyClass</h2>
 279
 280 <div class="memitem">
 281 <div class="memproto">
 282       <table class="memname">
 283         <tr>
 284           <td class="memname">#define osSafetyClass</td>
 285           <td>(</td>
 286           <td class="paramtype">&#160;</td>
 287           <td class="paramname">n</td><td>)</td>
 288           <td></td>
 289         </tr>
 290       </table>
 291 </div><div class="memdoc">
 292 <p>Safety class.</p>
 293 <dl class="params"><dt>Parameters</dt><dd>
 294   <table class="params">
 295     <tr><td class="paramname">n</td><td>safety class value.</td></tr>
 296   </table>
 297   </dd>
 298 </dl>
 299 <p>The preprocessor macro <b>osSafetyClass</b> constructs attribute bitmask with safety class bits set to <em>n</em>.</p>
 300 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">/* Event Flags object attributes */</span></div>
 301 <div class="line"><span class="keyword">const</span> <a class="code hl_struct" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a> ef_attr = {</div>
 302 <div class="line">  .<a class="code hl_variable" href="group__CMSIS__RTOS__EventFlags.html#ab74e6bf80237ddc4109968cedc58c151">name</a>       = <span class="stringliteral">&quot;EventFlags1&quot;</span>,    <span class="comment">// human readable object name</span></div>
 303 <div class="line">  .attr_bits  = <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga604fce4f5205f92c347eb62fcc216861">osSafetyClass</a>(2U) <span class="comment">// assign object to safety class 2</span></div>
 304 <div class="line">};</div>
 305 <div class="ttc" id="agroup__CMSIS__RTOS__Definitions_html_ga604fce4f5205f92c347eb62fcc216861"><div class="ttname"><a href="group__CMSIS__RTOS__Definitions.html#ga604fce4f5205f92c347eb62fcc216861">osSafetyClass</a></div><div class="ttdeci">#define osSafetyClass(n)</div><div class="ttdoc">Safety class value in attribute bit field format.</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:234</div></div>
 306 <div class="ttc" id="agroup__CMSIS__RTOS__EventFlags_html_ab74e6bf80237ddc4109968cedc58c151"><div class="ttname"><a href="group__CMSIS__RTOS__EventFlags.html#ab74e6bf80237ddc4109968cedc58c151">osEventFlagsAttr_t::name</a></div><div class="ttdeci">const char * name</div><div class="ttdoc">name of the event flags</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:311</div></div>
 307 <div class="ttc" id="agroup__CMSIS__RTOS__EventFlags_html_structosEventFlagsAttr__t"><div class="ttname"><a href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a></div><div class="ttdoc">Attributes structure for event flags.</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:310</div></div>
 308 </div><!-- fragment -->
 309 </div>
 310 </div>
 311 <a id="ga7abd2d95425d9e02672778b3464b2eaa" name="ga7abd2d95425d9e02672778b3464b2eaa"></a>
 312 <h2 class="memtitle"><span class="permalink"><a href="#ga7abd2d95425d9e02672778b3464b2eaa">&#9670;&#160;</a></span>osSafetyWithSameClass</h2>
 313
 314 <div class="memitem">
 315 <div class="memproto">
 316       <table class="memname">
 317         <tr>
 318           <td class="memname">#define osSafetyWithSameClass&#160;&#160;&#160;0x00000001U</td>
 319         </tr>
 320       </table>
 321 </div><div class="memdoc">
 322 <p>Definition for RTOS objects with the same safety class. Can be used as mode argument in the following functions:</p><ul>
 323 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadadb56627094dbb07f6aeddf7d713fd9">osThreadSuspendClass</a> :  Suspend execution of threads for specified safety classes.  </li>
 324 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadd0a06b459925eb5cdeab67b380a3970">osThreadResumeClass</a> :  Resume execution of threads for specified safety classes.  </li>
 325 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga2065364d1bc805a40e749430377df1e1">osKernelDestroyClass</a> :  Destroy objects for specified safety classes.   </li>
 326 </ul>
 327
 328 </div>
 329 </div>
 330 <a id="ga8c77ee126b9215425fc004ee13cdc6de" name="ga8c77ee126b9215425fc004ee13cdc6de"></a>
 331 <h2 class="memtitle"><span class="permalink"><a href="#ga8c77ee126b9215425fc004ee13cdc6de">&#9670;&#160;</a></span>osSafetyWithLowerClass</h2>
 332
 333 <div class="memitem">
 334 <div class="memproto">
 335       <table class="memname">
 336         <tr>
 337           <td class="memname">#define osSafetyWithLowerClass&#160;&#160;&#160;0x00000002U</td>
 338         </tr>
 339       </table>
 340 </div><div class="memdoc">
 341 <p>Definition for RTOS objects with lower safety class. Can be used as mode argument in the following functions:</p><ul>
 342 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadadb56627094dbb07f6aeddf7d713fd9">osThreadSuspendClass</a> :  Suspend execution of threads for specified safety classes.  </li>
 343 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadd0a06b459925eb5cdeab67b380a3970">osThreadResumeClass</a> :  Resume execution of threads for specified safety classes.  </li>
 344 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga2065364d1bc805a40e749430377df1e1">osKernelDestroyClass</a> :  Destroy objects for specified safety classes.   </li>
 345 </ul>
 346
 347 </div>
 348 </div>
 349 <h2 class="groupheader">Enumeration Type Documentation</h2>
 350 <a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813e" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813e"></a>
 351 <h2 class="memtitle"><span class="permalink"><a href="#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">&#9670;&#160;</a></span>osStatus_t</h2>
 352
 353 <div class="memitem">
 354 <div class="memproto">
 355       <table class="memname">
 356         <tr>
 357           <td class="memname">enum <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a></td>
 358         </tr>
 359       </table>
 360 </div><div class="memdoc">
 361 <p>The <b>osStatus_t</b> enumeration defines the event status and error codes that are returned by many CMSIS-RTOS functions. </p>
 362 <table class="fieldtable">
 363 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea9e1c9e2550bb4de8969a935acffc968f" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea9e1c9e2550bb4de8969a935acffc968f"></a>osOK&#160;</td><td class="fielddoc"><p>Operation completed successfully. </p>
 364 </td></tr>
 365 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813eabb7b2d2c4efa66df42f1c10635467b09" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813eabb7b2d2c4efa66df42f1c10635467b09"></a>osError&#160;</td><td class="fielddoc"><p>Unspecified RTOS error: run-time error but no other error message fits. </p>
 366 </td></tr>
 367 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea913eb5df15ad85f8557eb3a456b56879" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea913eb5df15ad85f8557eb3a456b56879"></a>osErrorTimeout&#160;</td><td class="fielddoc"><p>Operation not completed within the timeout period. </p>
 368 </td></tr>
 369 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea8fc5801e8b0482bdf22ad63a77f0155d" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea8fc5801e8b0482bdf22ad63a77f0155d"></a>osErrorResource&#160;</td><td class="fielddoc"><p>Resource not available. </p>
 370 </td></tr>
 371 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813eac24adca6a5d072c9f01c32178ba0d109" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813eac24adca6a5d072c9f01c32178ba0d109"></a>osErrorParameter&#160;</td><td class="fielddoc"><p>Parameter error. </p>
 372 </td></tr>
 373 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813eaf1fac0240218e51eb30a13da2f8aae81" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813eaf1fac0240218e51eb30a13da2f8aae81"></a>osErrorNoMemory&#160;</td><td class="fielddoc"><p>System is out of memory: it was impossible to allocate or reserve memory for the operation. </p>
 374 </td></tr>
 375 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea21635bdc492d3094fe83027fa4a30e2f" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea21635bdc492d3094fe83027fa4a30e2f"></a>osErrorISR&#160;</td><td class="fielddoc"><p>Not allowed in ISR context: the function cannot be called from interrupt service routines. </p>
 376 </td></tr>
 377 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813eafe45a75293a0a97dcabb8bdd193145c5" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813eafe45a75293a0a97dcabb8bdd193145c5"></a>osErrorSafetyClass&#160;</td><td class="fielddoc"><p>Operation denied because of safety class violation. </p>
 378 </td></tr>
 379 <tr><td class="fieldname"><a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea66cc9ce9106b508df0e4a733a55a439d" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813ea66cc9ce9106b508df0e4a733a55a439d"></a>osStatusReserved&#160;</td><td class="fielddoc"><p>Prevents enum down-size compiler optimization. </p>
 380 </td></tr>
 381 </table>
 382
 383 </div>
 384 </div>
 385 </div><!-- contents -->
 386 </div><!-- doc-content -->
 387 <!-- start footer part -->
 388 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 389   <ul>
 390     <li class="footer">
 391       <script type="text/javascript">
 392         <!--
 393         writeFooter.call(this);
 394         //-->
 395       </script>
 396     </li>
 397   </ul>
 398 </div>
 399 </body>
 400 </html>