begriffs open source - cmsis/blob - dev/v6.0.0-dev53/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: Generic 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);
  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">Generic Definitions<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS2 API</a></div></div></div>
 135 </div><!--header-->
 136 <div class="contents">
 137
 138 <p>Constants and enumerations used by many CMSIS-RTOS2 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#gga6c0dbe6069e4e7f47bb4cd32ae2b813eab17c65ad8b5bae759882b41c5bf35cda">osOK</a> = 0
 175 , <br />
 176 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813eacb77fd6a5f0f177b06847a629f6054e8">osError</a> = -1
 177 , <br />
 178 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea809f56df47a0269cdd4501e0d03eb603">osErrorTimeout</a> = -2
 179 , <br />
 180 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea75ed7d9f50a54adb727f61486ff2cc02">osErrorResource</a> = -3
 181 , <br />
 182 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea146cdcbc5c2b6f43e196294dbc59e12c">osErrorParameter</a> = -4
 183 , <br />
 184 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea1bccee013c5725778b750a54c4f9e57d">osErrorNoMemory</a> = -5
 185 , <br />
 186 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea91c2ea9c9cd03401ff7d396c636d1864">osErrorISR</a> = -6
 187 , <br />
 188 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea7379a8ce2e513723390bb01d2efeb981">osErrorSafetyClass</a> = -7
 189 , <br />
 190 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea59d1c52ddb4ba7a7738039756e79d982">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>Constants and enumerations used by many CMSIS-RTOS2 functions. </p>
 198 <p>The following constants and enumerations are used by many CMSIS-RTOS2 function calls. </p>
 199 <h2 class="groupheader">Macro Definition Documentation</h2>
 200 <a id="ga9eb9a7a797a42e4b55eb171ecc609ddb" name="ga9eb9a7a797a42e4b55eb171ecc609ddb"></a>
 201 <h2 class="memtitle"><span class="permalink"><a href="#ga9eb9a7a797a42e4b55eb171ecc609ddb">&#9670;&#160;</a></span>osWaitForever</h2>
 202
 203 <div class="memitem">
 204 <div class="memproto">
 205       <table class="memname">
 206         <tr>
 207           <td class="memname">#define osWaitForever&#160;&#160;&#160;0xFFFFFFFFU</td>
 208         </tr>
 209       </table>
 210 </div><div class="memdoc">
 211
 212 <p>Wait forever timeout value. </p>
 213 <p>A special <a class="el" href="usingOS2.html#CMSIS_RTOS_TimeOutValue">Timeout Values</a> that informs the RTOS to wait infinite until a resource becomes available. It applies to the following functions:</p><ul>
 214 <li><a class="el" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a> :  Wait for Timeout (Time Delay).  </li>
 215 <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>
 216 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> :  Wait for one or more Event Flags to become signaled.  </li>
 217 <li><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a> :  Acquire a Mutex or timeout if it is locked.  </li>
 218 <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>
 219 <li><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> :  Allocate a memory block from a Memory Pool.  </li>
 220 <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>
 221 <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>
 222 </ul>
 223
 224 </div>
 225 </div>
 226 <a id="ga18e63587b8450d5b8798b6f6ec04e012" name="ga18e63587b8450d5b8798b6f6ec04e012"></a>
 227 <h2 class="memtitle"><span class="permalink"><a href="#ga18e63587b8450d5b8798b6f6ec04e012">&#9670;&#160;</a></span>osFlagsWaitAny</h2>
 228
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname">#define osFlagsWaitAny&#160;&#160;&#160;0x00000000U</td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>Wait for any flag (default). </p>
 239 <p>Reference:</p><ul>
 240 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 241 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 242 </ul>
 243
 244 </div>
 245 </div>
 246 <a id="ga8b6f562736fbfb5428940e0c017dec24" name="ga8b6f562736fbfb5428940e0c017dec24"></a>
 247 <h2 class="memtitle"><span class="permalink"><a href="#ga8b6f562736fbfb5428940e0c017dec24">&#9670;&#160;</a></span>osFlagsWaitAll</h2>
 248
 249 <div class="memitem">
 250 <div class="memproto">
 251       <table class="memname">
 252         <tr>
 253           <td class="memname">#define osFlagsWaitAll&#160;&#160;&#160;0x00000001U</td>
 254         </tr>
 255       </table>
 256 </div><div class="memdoc">
 257
 258 <p>Wait for all flags. </p>
 259 <p>Reference:</p><ul>
 260 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 261 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 262 </ul>
 263
 264 </div>
 265 </div>
 266 <a id="gaade844a42237d8c37569d4d9b16b9f1c" name="gaade844a42237d8c37569d4d9b16b9f1c"></a>
 267 <h2 class="memtitle"><span class="permalink"><a href="#gaade844a42237d8c37569d4d9b16b9f1c">&#9670;&#160;</a></span>osFlagsNoClear</h2>
 268
 269 <div class="memitem">
 270 <div class="memproto">
 271       <table class="memname">
 272         <tr>
 273           <td class="memname">#define osFlagsNoClear&#160;&#160;&#160;0x00000002U</td>
 274         </tr>
 275       </table>
 276 </div><div class="memdoc">
 277
 278 <p>Do not clear flags which have been specified to wait for. </p>
 279 <p>Reference:</p><ul>
 280 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 281 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 282 </ul>
 283
 284 </div>
 285 </div>
 286 <a id="ga604fce4f5205f92c347eb62fcc216861" name="ga604fce4f5205f92c347eb62fcc216861"></a>
 287 <h2 class="memtitle"><span class="permalink"><a href="#ga604fce4f5205f92c347eb62fcc216861">&#9670;&#160;</a></span>osSafetyClass</h2>
 288
 289 <div class="memitem">
 290 <div class="memproto">
 291       <table class="memname">
 292         <tr>
 293           <td class="memname">#define osSafetyClass</td>
 294           <td>(</td>
 295           <td class="paramtype">&#160;</td>
 296           <td class="paramname">n</td><td>)</td>
 297           <td></td>
 298         </tr>
 299       </table>
 300 </div><div class="memdoc">
 301
 302 <p>Safety class value in attribute bit field format. </p>
 303 <p>Safety class.</p>
 304 <dl class="params"><dt>Parameters</dt><dd>
 305   <table class="params">
 306     <tr><td class="paramname">n</td><td>safety class value.</td></tr>
 307   </table>
 308   </dd>
 309 </dl>
 310 <p>The preprocessor macro <b>osSafetyClass</b> constructs attribute bitmask with safety class bits set to <em>n</em>.</p>
 311 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">/* Event Flags object attributes */</span></div>
 312 <div class="line"><span class="keyword">const</span> <a class="code hl_struct" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t" title="Attributes structure for event flags.">osEventFlagsAttr_t</a> ef_attr = {</div>
 313 <div class="line">  .<a class="code hl_variable" href="group__CMSIS__RTOS__EventFlags.html#ab74e6bf80237ddc4109968cedc58c151" title="name of the event flags">name</a>       = <span class="stringliteral">&quot;EventFlags1&quot;</span>,    <span class="comment">// human readable object name</span></div>
 314 <div class="line">  .attr_bits  = <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga604fce4f5205f92c347eb62fcc216861" title="Safety class value in attribute bit field format.">osSafetyClass</a>(2U) <span class="comment">// assign object to safety class 2</span></div>
 315 <div class="line">};</div>
 316 </div><!-- fragment -->
 317 </div>
 318 </div>
 319 <a id="ga7abd2d95425d9e02672778b3464b2eaa" name="ga7abd2d95425d9e02672778b3464b2eaa"></a>
 320 <h2 class="memtitle"><span class="permalink"><a href="#ga7abd2d95425d9e02672778b3464b2eaa">&#9670;&#160;</a></span>osSafetyWithSameClass</h2>
 321
 322 <div class="memitem">
 323 <div class="memproto">
 324       <table class="memname">
 325         <tr>
 326           <td class="memname">#define osSafetyWithSameClass&#160;&#160;&#160;0x00000001U</td>
 327         </tr>
 328       </table>
 329 </div><div class="memdoc">
 330
 331 <p>Objects with same safety class. </p>
 332 <p>Definition for RTOS objects with the same safety class. Can be used as mode argument in the following functions:</p><ul>
 333 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadadb56627094dbb07f6aeddf7d713fd9">osThreadSuspendClass</a> :  Suspend execution of threads for specified safety classes.  </li>
 334 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadd0a06b459925eb5cdeab67b380a3970">osThreadResumeClass</a> :  Resume execution of threads for specified safety classes.  </li>
 335 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga2065364d1bc805a40e749430377df1e1">osKernelDestroyClass</a> :  Destroy objects for specified safety classes.   </li>
 336 </ul>
 337
 338 </div>
 339 </div>
 340 <a id="ga8c77ee126b9215425fc004ee13cdc6de" name="ga8c77ee126b9215425fc004ee13cdc6de"></a>
 341 <h2 class="memtitle"><span class="permalink"><a href="#ga8c77ee126b9215425fc004ee13cdc6de">&#9670;&#160;</a></span>osSafetyWithLowerClass</h2>
 342
 343 <div class="memitem">
 344 <div class="memproto">
 345       <table class="memname">
 346         <tr>
 347           <td class="memname">#define osSafetyWithLowerClass&#160;&#160;&#160;0x00000002U</td>
 348         </tr>
 349       </table>
 350 </div><div class="memdoc">
 351
 352 <p>Objects with lower safety class. </p>
 353 <p>Definition for RTOS objects with lower safety class. Can be used as mode argument in the following functions:</p><ul>
 354 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadadb56627094dbb07f6aeddf7d713fd9">osThreadSuspendClass</a> :  Suspend execution of threads for specified safety classes.  </li>
 355 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadd0a06b459925eb5cdeab67b380a3970">osThreadResumeClass</a> :  Resume execution of threads for specified safety classes.  </li>
 356 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga2065364d1bc805a40e749430377df1e1">osKernelDestroyClass</a> :  Destroy objects for specified safety classes.   </li>
 357 </ul>
 358
 359 </div>
 360 </div>
 361 <h2 class="groupheader">Enumeration Type Documentation</h2>
 362 <a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813e" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813e"></a>
 363 <h2 class="memtitle"><span class="permalink"><a href="#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">&#9670;&#160;</a></span>osStatus_t</h2>
 364
 365 <div class="memitem">
 366 <div class="memproto">
 367       <table class="memname">
 368         <tr>
 369           <td class="memname">enum <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a></td>
 370         </tr>
 371       </table>
 372 </div><div class="memdoc">
 373
 374 <p>Status code values returned by CMSIS-RTOS functions. </p>
 375 <p>The <b>osStatus_t</b> enumeration defines the event status and error codes that are returned by many CMSIS-RTOS2 functions. </p>
 376 <table class="fieldtable">
 377 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813eab17c65ad8b5bae759882b41c5bf35cda" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813eab17c65ad8b5bae759882b41c5bf35cda"></a>osOK&#160;</td><td class="fielddoc"><p>Operation completed successfully. </p>
 378 </td></tr>
 379 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813eacb77fd6a5f0f177b06847a629f6054e8" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813eacb77fd6a5f0f177b06847a629f6054e8"></a>osError&#160;</td><td class="fielddoc"><p>Unspecified RTOS error: run-time error but no other error message fits. </p>
 380 </td></tr>
 381 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea809f56df47a0269cdd4501e0d03eb603" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea809f56df47a0269cdd4501e0d03eb603"></a>osErrorTimeout&#160;</td><td class="fielddoc"><p>Operation not completed within the timeout period. </p>
 382 </td></tr>
 383 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea75ed7d9f50a54adb727f61486ff2cc02" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea75ed7d9f50a54adb727f61486ff2cc02"></a>osErrorResource&#160;</td><td class="fielddoc"><p>Resource not available. </p>
 384 </td></tr>
 385 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea146cdcbc5c2b6f43e196294dbc59e12c" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea146cdcbc5c2b6f43e196294dbc59e12c"></a>osErrorParameter&#160;</td><td class="fielddoc"><p>Parameter error. </p>
 386 </td></tr>
 387 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea1bccee013c5725778b750a54c4f9e57d" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea1bccee013c5725778b750a54c4f9e57d"></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>
 388 </td></tr>
 389 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea91c2ea9c9cd03401ff7d396c636d1864" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea91c2ea9c9cd03401ff7d396c636d1864"></a>osErrorISR&#160;</td><td class="fielddoc"><p>Not allowed in ISR context: the function cannot be called from interrupt service routines. </p>
 390 </td></tr>
 391 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea7379a8ce2e513723390bb01d2efeb981" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea7379a8ce2e513723390bb01d2efeb981"></a>osErrorSafetyClass&#160;</td><td class="fielddoc"><p>Operation denied because of safety class violation. </p>
 392 </td></tr>
 393 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea59d1c52ddb4ba7a7738039756e79d982" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea59d1c52ddb4ba7a7738039756e79d982"></a>osStatusReserved&#160;</td><td class="fielddoc"><p>Prevents enum down-size compiler optimization. </p>
 394 </td></tr>
 395 </table>
 396
 397 </div>
 398 </div>
 399 </div><!-- contents -->
 400 </div><!-- doc-content -->
 401 <!-- start footer part -->
 402 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 403   <ul>
 404     <li class="footer">
 405       <script type="text/javascript">
 406         <!--
 407         writeFooter.call(this);
 408         //-->
 409       </script>
 410     </li>
 411   </ul>
 412 </div>
 413 </body>
 414 </html>