begriffs open source - cmsis/blob - main/RTOS2/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 <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="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-RTOS2
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-RTOS2");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Real-Time Operating System API</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  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 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__CMSIS__RTOS__Definitions.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#groups">Content</a> &#124;
 129 <a href="#define-members">Macros</a> &#124;
 130 <a href="#enum-members">Enumerations</a>  </div>
 131   <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>
 132 </div><!--header-->
 133 <div class="contents">
 134
 135 <p>Constants and enumerations used by many CMSIS-RTOS2 functions.
 136 <a href="#details">More...</a></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 139 Content</h2></td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 </table><table class="memberdecls">
 144 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 145 Macros</h2></td></tr>
 146 <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>
 147 <tr class="memdesc:ga9eb9a7a797a42e4b55eb171ecc609ddb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait forever timeout value.  <br /></td></tr>
 148 <tr class="separator:ga9eb9a7a797a42e4b55eb171ecc609ddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <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>
 150 <tr class="memdesc:ga18e63587b8450d5b8798b6f6ec04e012"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for any flag (default).  <br /></td></tr>
 151 <tr class="separator:ga18e63587b8450d5b8798b6f6ec04e012"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <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>
 153 <tr class="memdesc:ga8b6f562736fbfb5428940e0c017dec24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for all flags.  <br /></td></tr>
 154 <tr class="separator:ga8b6f562736fbfb5428940e0c017dec24"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <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>
 156 <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>
 157 <tr class="separator:gaade844a42237d8c37569d4d9b16b9f1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <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>
 159 <tr class="memdesc:ga604fce4f5205f92c347eb62fcc216861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safety class value in attribute bit field format.  <br /></td></tr>
 160 <tr class="separator:ga604fce4f5205f92c347eb62fcc216861"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <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>
 162 <tr class="memdesc:ga7abd2d95425d9e02672778b3464b2eaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Objects with same safety class.  <br /></td></tr>
 163 <tr class="separator:ga7abd2d95425d9e02672778b3464b2eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <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>
 165 <tr class="memdesc:ga8c77ee126b9215425fc004ee13cdc6de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Objects with lower safety class.  <br /></td></tr>
 166 <tr class="separator:ga8c77ee126b9215425fc004ee13cdc6de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 </table><table class="memberdecls">
 168 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 169 Enumerations</h2></td></tr>
 170 <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 />
 171 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813eab17c65ad8b5bae759882b41c5bf35cda">osOK</a> = 0
 172 , <br />
 173 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813eacb77fd6a5f0f177b06847a629f6054e8">osError</a> = -1
 174 , <br />
 175 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea809f56df47a0269cdd4501e0d03eb603">osErrorTimeout</a> = -2
 176 , <br />
 177 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea75ed7d9f50a54adb727f61486ff2cc02">osErrorResource</a> = -3
 178 , <br />
 179 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea146cdcbc5c2b6f43e196294dbc59e12c">osErrorParameter</a> = -4
 180 , <br />
 181 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea1bccee013c5725778b750a54c4f9e57d">osErrorNoMemory</a> = -5
 182 , <br />
 183 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea91c2ea9c9cd03401ff7d396c636d1864">osErrorISR</a> = -6
 184 , <br />
 185 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea7379a8ce2e513723390bb01d2efeb981">osErrorSafetyClass</a> = -7
 186 , <br />
 187 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813ea59d1c52ddb4ba7a7738039756e79d982">osStatusReserved</a> = 0x7FFFFFFF
 188 <br />
 189  }</td></tr>
 190 <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>
 191 <tr class="separator:ga6c0dbe6069e4e7f47bb4cd32ae2b813e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 192 </table>
 193 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 194 <p>Constants and enumerations used by many CMSIS-RTOS2 functions. </p>
 195 <p>The following constants and enumerations are used by many CMSIS-RTOS2 function calls. </p>
 196 <h2 class="groupheader">Macro Definition Documentation</h2>
 197 <a id="ga9eb9a7a797a42e4b55eb171ecc609ddb" name="ga9eb9a7a797a42e4b55eb171ecc609ddb"></a>
 198 <h2 class="memtitle"><span class="permalink"><a href="#ga9eb9a7a797a42e4b55eb171ecc609ddb">&#9670;&#160;</a></span>osWaitForever</h2>
 199
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname">#define osWaitForever&#160;&#160;&#160;0xFFFFFFFFU</td>
 205         </tr>
 206       </table>
 207 </div><div class="memdoc">
 208
 209 <p>Wait forever timeout value. </p>
 210 <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>
 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
 235 <p>Wait for any flag (default). </p>
 236 <p>Reference:</p><ul>
 237 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 238 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 239 </ul>
 240
 241 </div>
 242 </div>
 243 <a id="ga8b6f562736fbfb5428940e0c017dec24" name="ga8b6f562736fbfb5428940e0c017dec24"></a>
 244 <h2 class="memtitle"><span class="permalink"><a href="#ga8b6f562736fbfb5428940e0c017dec24">&#9670;&#160;</a></span>osFlagsWaitAll</h2>
 245
 246 <div class="memitem">
 247 <div class="memproto">
 248       <table class="memname">
 249         <tr>
 250           <td class="memname">#define osFlagsWaitAll&#160;&#160;&#160;0x00000001U</td>
 251         </tr>
 252       </table>
 253 </div><div class="memdoc">
 254
 255 <p>Wait for all flags. </p>
 256 <p>Reference:</p><ul>
 257 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 258 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 259 </ul>
 260
 261 </div>
 262 </div>
 263 <a id="gaade844a42237d8c37569d4d9b16b9f1c" name="gaade844a42237d8c37569d4d9b16b9f1c"></a>
 264 <h2 class="memtitle"><span class="permalink"><a href="#gaade844a42237d8c37569d4d9b16b9f1c">&#9670;&#160;</a></span>osFlagsNoClear</h2>
 265
 266 <div class="memitem">
 267 <div class="memproto">
 268       <table class="memname">
 269         <tr>
 270           <td class="memname">#define osFlagsNoClear&#160;&#160;&#160;0x00000002U</td>
 271         </tr>
 272       </table>
 273 </div><div class="memdoc">
 274
 275 <p>Do not clear flags which have been specified to wait for. </p>
 276 <p>Reference:</p><ul>
 277 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></li>
 278 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> </li>
 279 </ul>
 280
 281 </div>
 282 </div>
 283 <a id="ga604fce4f5205f92c347eb62fcc216861" name="ga604fce4f5205f92c347eb62fcc216861"></a>
 284 <h2 class="memtitle"><span class="permalink"><a href="#ga604fce4f5205f92c347eb62fcc216861">&#9670;&#160;</a></span>osSafetyClass</h2>
 285
 286 <div class="memitem">
 287 <div class="memproto">
 288       <table class="memname">
 289         <tr>
 290           <td class="memname">#define osSafetyClass</td>
 291           <td>(</td>
 292           <td class="paramtype">&#160;</td>
 293           <td class="paramname">n</td><td>)</td>
 294           <td></td>
 295         </tr>
 296       </table>
 297 </div><div class="memdoc">
 298
 299 <p>Safety class value in attribute bit field format. </p>
 300 <p>Safety class.</p>
 301 <dl class="params"><dt>Parameters</dt><dd>
 302   <table class="params">
 303     <tr><td class="paramname">n</td><td>safety class value.</td></tr>
 304   </table>
 305   </dd>
 306 </dl>
 307 <p>The preprocessor macro <b>osSafetyClass</b> constructs attribute bitmask with safety class bits set to <em>n</em>.</p>
 308 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">/* Event Flags object attributes */</span></div>
 309 <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>
 310 <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>
 311 <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>
 312 <div class="line">};</div>
 313 </div><!-- fragment -->
 314 </div>
 315 </div>
 316 <a id="ga7abd2d95425d9e02672778b3464b2eaa" name="ga7abd2d95425d9e02672778b3464b2eaa"></a>
 317 <h2 class="memtitle"><span class="permalink"><a href="#ga7abd2d95425d9e02672778b3464b2eaa">&#9670;&#160;</a></span>osSafetyWithSameClass</h2>
 318
 319 <div class="memitem">
 320 <div class="memproto">
 321       <table class="memname">
 322         <tr>
 323           <td class="memname">#define osSafetyWithSameClass&#160;&#160;&#160;0x00000001U</td>
 324         </tr>
 325       </table>
 326 </div><div class="memdoc">
 327
 328 <p>Objects with same safety class. </p>
 329 <p>Definition for RTOS objects with the same safety class. Can be used as mode argument in the following functions:</p><ul>
 330 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadadb56627094dbb07f6aeddf7d713fd9">osThreadSuspendClass</a> :  Suspend execution of threads for specified safety classes.  </li>
 331 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadd0a06b459925eb5cdeab67b380a3970">osThreadResumeClass</a> :  Resume execution of threads for specified safety classes.  </li>
 332 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga2065364d1bc805a40e749430377df1e1">osKernelDestroyClass</a> :  Destroy objects for specified safety classes.   </li>
 333 </ul>
 334
 335 </div>
 336 </div>
 337 <a id="ga8c77ee126b9215425fc004ee13cdc6de" name="ga8c77ee126b9215425fc004ee13cdc6de"></a>
 338 <h2 class="memtitle"><span class="permalink"><a href="#ga8c77ee126b9215425fc004ee13cdc6de">&#9670;&#160;</a></span>osSafetyWithLowerClass</h2>
 339
 340 <div class="memitem">
 341 <div class="memproto">
 342       <table class="memname">
 343         <tr>
 344           <td class="memname">#define osSafetyWithLowerClass&#160;&#160;&#160;0x00000002U</td>
 345         </tr>
 346       </table>
 347 </div><div class="memdoc">
 348
 349 <p>Objects with lower safety class. </p>
 350 <p>Definition for RTOS objects with lower safety class. Can be used as mode argument in the following functions:</p><ul>
 351 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadadb56627094dbb07f6aeddf7d713fd9">osThreadSuspendClass</a> :  Suspend execution of threads for specified safety classes.  </li>
 352 <li><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gadd0a06b459925eb5cdeab67b380a3970">osThreadResumeClass</a> :  Resume execution of threads for specified safety classes.  </li>
 353 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga2065364d1bc805a40e749430377df1e1">osKernelDestroyClass</a> :  Destroy objects for specified safety classes.   </li>
 354 </ul>
 355
 356 </div>
 357 </div>
 358 <h2 class="groupheader">Enumeration Type Documentation</h2>
 359 <a id="ga6c0dbe6069e4e7f47bb4cd32ae2b813e" name="ga6c0dbe6069e4e7f47bb4cd32ae2b813e"></a>
 360 <h2 class="memtitle"><span class="permalink"><a href="#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">&#9670;&#160;</a></span>osStatus_t</h2>
 361
 362 <div class="memitem">
 363 <div class="memproto">
 364       <table class="memname">
 365         <tr>
 366           <td class="memname">enum <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a></td>
 367         </tr>
 368       </table>
 369 </div><div class="memdoc">
 370
 371 <p>Status code values returned by CMSIS-RTOS functions. </p>
 372 <p>The <b>osStatus_t</b> enumeration defines the event status and error codes that are returned by many CMSIS-RTOS2 functions. </p>
 373 <table class="fieldtable">
 374 <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>
 375 </td></tr>
 376 <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>
 377 </td></tr>
 378 <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>
 379 </td></tr>
 380 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea75ed7d9f50a54adb727f61486ff2cc02" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea75ed7d9f50a54adb727f61486ff2cc02"></a>osErrorResource&#160;</td><td class="fielddoc"><p>Resource not available. </p>
 381 </td></tr>
 382 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea146cdcbc5c2b6f43e196294dbc59e12c" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea146cdcbc5c2b6f43e196294dbc59e12c"></a>osErrorParameter&#160;</td><td class="fielddoc"><p>Parameter error. </p>
 383 </td></tr>
 384 <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>
 385 </td></tr>
 386 <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>
 387 </td></tr>
 388 <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>
 389 </td></tr>
 390 <tr><td class="fieldname"><a id="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea59d1c52ddb4ba7a7738039756e79d982" name="gga6c0dbe6069e4e7f47bb4cd32ae2b813ea59d1c52ddb4ba7a7738039756e79d982"></a>osStatusReserved&#160;</td><td class="fielddoc"><p>Prevents enum down-size compiler optimization. </p>
 391 </td></tr>
 392 </table>
 393
 394 </div>
 395 </div>
 396 </div><!-- contents -->
 397 </div><!-- doc-content -->
 398 <!-- start footer part -->
 399 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 400   <ul>
 401     <li class="footer">
 402       <script type="text/javascript">
 403         <!--
 404         writeFooter.call(this);
 405         //-->
 406       </script>
 407     </li>
 408   </ul>
 409 </div>
 410 </body>
 411 </html>