begriffs open source - cmsis-freertos/blob - v10.5.1/group__freertos__evr__event__groups.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>Event Groups Functions</title>
   7 <title>CMSIS-FreeRTOS: Event Groups Functions</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="footer.js"></script>
  13 <script type="text/javascript" src="printComponentTabs.js"></script>
  14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  15 <script type="text/javascript" src="resize.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/search.js"></script>
  23 <script type="text/javascript">
  24   $(document).ready(function() { searchBox.OnSelectItem(0); });
  25 </script>
  26 <link href="version.css" rel="stylesheet" type="text/css" />
  27 <script type="text/javascript" src="../version.js"></script>
  28 </head>
  29 <body>
  30 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  31 <div id="titlearea">
  32 <table cellspacing="0" cellpadding="0">
  33  <tbody>
  34  <tr style="height: 46px;">
  35   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  36   <td style="padding-left: 0.5em;">
  37    <div id="projectname">CMSIS-FreeRTOS
  38    &#160;<span id="projectnumber"><script type="text/javascript">
  39      <!--
  40      writeHeader.call(this);
  41      writeVersionDropdown(this);
  42      //-->
  43     </script>
  44    </span>
  45    </div>
  46    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  47   </td>
  48  </tr>
  49  </tbody>
  50 </table>
  51 </div>
  52 <!-- end header part -->
  53 <div id="CMSISnav" class="tabs1">
  54     <ul class="tablist">
  55       <script type="text/javascript">
  56                 <!--
  57                 writeComponentTabs.call(this);
  58                 //-->
  59       </script>
  60           </ul>
  61 </div>
  62 <!-- Generated by Doxygen 1.8.6 -->
  63 <script type="text/javascript">
  64 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  65 </script>
  66   <div id="navrow1" class="tabs">
  67     <ul class="tablist">
  68       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  69       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  70       <li><a href="modules.html"><span>Reference</span></a></li>
  71       <li>
  72         <div id="MSearchBox" class="MSearchBoxInactive">
  73         <span class="left">
  74           <img id="MSearchSelect" src="search/mag_sel.png"
  75                onmouseover="return searchBox.OnSearchSelectShow()"
  76                onmouseout="return searchBox.OnSearchSelectHide()"
  77                alt=""/>
  78           <input type="text" id="MSearchField" value="Search" accesskey="S"
  79                onfocus="searchBox.OnSearchFieldFocus(true)"
  80                onblur="searchBox.OnSearchFieldFocus(false)"
  81                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  82           </span><span class="right">
  83             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  84           </span>
  85         </div>
  86       </li>
  87     </ul>
  88   </div>
  89 </div><!-- top -->
  90 <div id="side-nav" class="ui-resizable side-nav-resizable">
  91   <div id="nav-tree">
  92     <div id="nav-tree-contents">
  93       <div id="nav-sync" class="sync"></div>
  94     </div>
  95   </div>
  96   <div id="splitbar" style="-moz-user-select:none;"
  97        class="ui-resizable-handle">
  98   </div>
  99 </div>
 100 <script type="text/javascript">
 101 $(document).ready(function(){initNavTree('group__freertos__evr__event__groups.html','');});
 102 </script>
 103 <div id="doc-content">
 104 <!-- window showing the filter options -->
 105 <div id="MSearchSelectWindow"
 106      onmouseover="return searchBox.OnSearchSelectShow()"
 107      onmouseout="return searchBox.OnSearchSelectHide()"
 108      onkeydown="return searchBox.OnSearchSelectKey(event)">
 109 <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>
 110
 111 <!-- iframe showing the search results (closed by default) -->
 112 <div id="MSearchResultsWindow">
 113 <iframe src="javascript:void(0)" frameborder="0"
 114         name="MSearchResults" id="MSearchResults">
 115 </iframe>
 116 </div>
 117
 118 <div class="header">
 119   <div class="summary">
 120 <a href="#func-members">Functions</a>  </div>
 121   <div class="headertitle">
 122 <div class="title">Event Groups Functions<div class="ingroups"><a class="el" href="group__freertos__evr.html">Event functions</a></div></div>  </div>
 123 </div><!--header-->
 124 <div class="contents">
 125
 126 <p>Events generated by event groups functions.
 127 <a href="#details">More...</a></p>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 130 Functions</h2></td></tr>
 131 <tr class="memitem:gad8448ba4d5388e38e190b352f45a101f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#gad8448ba4d5388e38e190b352f45a101f">EvrFreeRTOSEventGroups_EventGroupCreate</a> (EventGroup_t pxEventGroup)</td></tr>
 132 <tr class="memdesc:gad8448ba4d5388e38e190b352f45a101f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful event groups object create (Op)  <a href="#gad8448ba4d5388e38e190b352f45a101f">More...</a><br/></td></tr>
 133 <tr class="separator:gad8448ba4d5388e38e190b352f45a101f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:ga7a53268580bdc71b6436c57c25dc551f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga7a53268580bdc71b6436c57c25dc551f">EvrFreeRTOSEventGroups_EventGroupCreateFailed</a> (void)</td></tr>
 135 <tr class="memdesc:ga7a53268580bdc71b6436c57c25dc551f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful event groups object create (Error)  <a href="#ga7a53268580bdc71b6436c57c25dc551f">More...</a><br/></td></tr>
 136 <tr class="separator:ga7a53268580bdc71b6436c57c25dc551f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:gabf2a4485248210068f8856cbca643616"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#gabf2a4485248210068f8856cbca643616">EvrFreeRTOSEventGroups_EventGroupSyncBlock</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor)</td></tr>
 138 <tr class="memdesc:gabf2a4485248210068f8856cbca643616"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups sync wait start (Op)  <a href="#gabf2a4485248210068f8856cbca643616">More...</a><br/></td></tr>
 139 <tr class="separator:gabf2a4485248210068f8856cbca643616"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:ga395dbbbe8c0477a23055fa73112ec91b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga395dbbbe8c0477a23055fa73112ec91b">EvrFreeRTOSEventGroups_EventGroupSyncEnd</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)</td></tr>
 141 <tr class="memdesc:ga395dbbbe8c0477a23055fa73112ec91b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups sync completed (Op)  <a href="#ga395dbbbe8c0477a23055fa73112ec91b">More...</a><br/></td></tr>
 142 <tr class="separator:ga395dbbbe8c0477a23055fa73112ec91b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:ga9da8317cc021b3a4d6349b9f4836e3d3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga9da8317cc021b3a4d6349b9f4836e3d3">EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor)</td></tr>
 144 <tr class="memdesc:ga9da8317cc021b3a4d6349b9f4836e3d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups bit wait start (Op)  <a href="#ga9da8317cc021b3a4d6349b9f4836e3d3">More...</a><br/></td></tr>
 145 <tr class="separator:ga9da8317cc021b3a4d6349b9f4836e3d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ga9c215defcaa1cc3026b2717ffab246b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga9c215defcaa1cc3026b2717ffab246b5">EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)</td></tr>
 147 <tr class="memdesc:ga9c215defcaa1cc3026b2717ffab246b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups bit wait completed (Op)  <a href="#ga9c215defcaa1cc3026b2717ffab246b5">More...</a><br/></td></tr>
 148 <tr class="separator:ga9c215defcaa1cc3026b2717ffab246b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:ga7b949dc8d8167fc621fc6102808caa81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga7b949dc8d8167fc621fc6102808caa81">EvrFreeRTOSEventGroups_EventGroupClearBits</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)</td></tr>
 150 <tr class="memdesc:ga7b949dc8d8167fc621fc6102808caa81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups bit clear (Op)  <a href="#ga7b949dc8d8167fc621fc6102808caa81">More...</a><br/></td></tr>
 151 <tr class="separator:ga7b949dc8d8167fc621fc6102808caa81"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ga1a8cc5bff8d6d29db8d96d790f7c1db5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga1a8cc5bff8d6d29db8d96d790f7c1db5">EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)</td></tr>
 153 <tr class="memdesc:ga1a8cc5bff8d6d29db8d96d790f7c1db5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups bit clear call from ISR (Op)  <a href="#ga1a8cc5bff8d6d29db8d96d790f7c1db5">More...</a><br/></td></tr>
 154 <tr class="separator:ga1a8cc5bff8d6d29db8d96d790f7c1db5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:ga51408eb270d6acb4a080a88c7163a6cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga51408eb270d6acb4a080a88c7163a6cb">EvrFreeRTOSEventGroups_EventGroupSetBits</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)</td></tr>
 156 <tr class="memdesc:ga51408eb270d6acb4a080a88c7163a6cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups bit set (Op)  <a href="#ga51408eb270d6acb4a080a88c7163a6cb">More...</a><br/></td></tr>
 157 <tr class="separator:ga51408eb270d6acb4a080a88c7163a6cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:gace210d0433abdea28689e559b8ce867a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#gace210d0433abdea28689e559b8ce867a">EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)</td></tr>
 159 <tr class="memdesc:gace210d0433abdea28689e559b8ce867a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups bit set call from ISR (Op)  <a href="#gace210d0433abdea28689e559b8ce867a">More...</a><br/></td></tr>
 160 <tr class="separator:gace210d0433abdea28689e559b8ce867a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:ga9109cd0187e2408f9e1d730c5b09acc6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__event__groups.html#ga9109cd0187e2408f9e1d730c5b09acc6">EvrFreeRTOSEventGroups_EventGroupDelete</a> (EventGroup_t pxEventGroup)</td></tr>
 162 <tr class="memdesc:ga9109cd0187e2408f9e1d730c5b09acc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event groups object delete (Op)  <a href="#ga9109cd0187e2408f9e1d730c5b09acc6">More...</a><br/></td></tr>
 163 <tr class="separator:ga9109cd0187e2408f9e1d730c5b09acc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 </table>
 165 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 166 <h2 class="groupheader">Function Documentation</h2>
 167 <a class="anchor" id="ga7b949dc8d8167fc621fc6102808caa81"></a>
 168 <div class="memitem">
 169 <div class="memproto">
 170       <table class="memname">
 171         <tr>
 172           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupClearBits </td>
 173           <td>(</td>
 174           <td class="paramtype">EventGroup_t&#160;</td>
 175           <td class="paramname"><em>pxEventGroup</em>, </td>
 176         </tr>
 177         <tr>
 178           <td class="paramkey"></td>
 179           <td></td>
 180           <td class="paramtype">uint32_t&#160;</td>
 181           <td class="paramname"><em>uxBitsToClear</em>&#160;</td>
 182         </tr>
 183         <tr>
 184           <td></td>
 185           <td>)</td>
 186           <td></td><td></td>
 187         </tr>
 188       </table>
 189 </div><div class="memdoc">
 190 <dl class="params"><dt>Parameters</dt><dd>
 191   <table class="params">
 192     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 193     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToClear</td><td>event bits that shall be cleared.</td></tr>
 194   </table>
 195   </dd>
 196 </dl>
 197 <p>The event <b>EventGroupClearBits</b> is generated when the function xEventGroupClearBits is called.</p>
 198 <p><b>Value</b> in the Event Recorder shows:</p>
 199 <ul>
 200 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 201 <li><b>uxBitsToClear</b> : event bits that shall be cleared. </li>
 202 </ul>
 203
 204 </div>
 205 </div>
 206 <a class="anchor" id="ga1a8cc5bff8d6d29db8d96d790f7c1db5"></a>
 207 <div class="memitem">
 208 <div class="memproto">
 209       <table class="memname">
 210         <tr>
 211           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr </td>
 212           <td>(</td>
 213           <td class="paramtype">EventGroup_t&#160;</td>
 214           <td class="paramname"><em>pxEventGroup</em>, </td>
 215         </tr>
 216         <tr>
 217           <td class="paramkey"></td>
 218           <td></td>
 219           <td class="paramtype">uint32_t&#160;</td>
 220           <td class="paramname"><em>uxBitsToClear</em>&#160;</td>
 221         </tr>
 222         <tr>
 223           <td></td>
 224           <td>)</td>
 225           <td></td><td></td>
 226         </tr>
 227       </table>
 228 </div><div class="memdoc">
 229 <dl class="params"><dt>Parameters</dt><dd>
 230   <table class="params">
 231     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 232     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToClear</td><td>event bits that shall be cleared.</td></tr>
 233   </table>
 234   </dd>
 235 </dl>
 236 <p>The event <b>EventGroupClearBitsFromIsr</b> is generated when the function xEventGroupClearBitsFromISR is called.</p>
 237 <p><b>Value</b> in the Event Recorder shows:</p>
 238 <ul>
 239 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 240 <li><b>uxBitsToClear</b> : event bits that shall be cleared. </li>
 241 </ul>
 242
 243 </div>
 244 </div>
 245 <a class="anchor" id="gad8448ba4d5388e38e190b352f45a101f"></a>
 246 <div class="memitem">
 247 <div class="memproto">
 248       <table class="memname">
 249         <tr>
 250           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupCreate </td>
 251           <td>(</td>
 252           <td class="paramtype">EventGroup_t&#160;</td>
 253           <td class="paramname"><em>pxEventGroup</em></td><td>)</td>
 254           <td></td>
 255         </tr>
 256       </table>
 257 </div><div class="memdoc">
 258 <dl class="params"><dt>Parameters</dt><dd>
 259   <table class="params">
 260     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
 261   </table>
 262   </dd>
 263 </dl>
 264 <p>The event <b>EventGroupCreate</b> is generated when Event Groups object is successfully created.</p>
 265 <p><b>Value</b> in the Event Recorder shows:</p>
 266 <ul>
 267 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address) </li>
 268 </ul>
 269
 270 </div>
 271 </div>
 272 <a class="anchor" id="ga7a53268580bdc71b6436c57c25dc551f"></a>
 273 <div class="memitem">
 274 <div class="memproto">
 275       <table class="memname">
 276         <tr>
 277           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupCreateFailed </td>
 278           <td>(</td>
 279           <td class="paramtype">void&#160;</td>
 280           <td class="paramname"></td><td>)</td>
 281           <td></td>
 282         </tr>
 283       </table>
 284 </div><div class="memdoc">
 285 <p>The event <b>EventGroupCreateFailed</b> is generated when Event Groups object create fails due to insufficient heap memory. </p>
 286
 287 </div>
 288 </div>
 289 <a class="anchor" id="ga9109cd0187e2408f9e1d730c5b09acc6"></a>
 290 <div class="memitem">
 291 <div class="memproto">
 292       <table class="memname">
 293         <tr>
 294           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupDelete </td>
 295           <td>(</td>
 296           <td class="paramtype">EventGroup_t&#160;</td>
 297           <td class="paramname"><em>pxEventGroup</em></td><td>)</td>
 298           <td></td>
 299         </tr>
 300       </table>
 301 </div><div class="memdoc">
 302 <dl class="params"><dt>Parameters</dt><dd>
 303   <table class="params">
 304     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
 305   </table>
 306   </dd>
 307 </dl>
 308 <p>The event <b>EventGroupDelete</b> is generated when Event Group object is successfully added to object delete queue.</p>
 309 <p><b>Value</b> in the Event Recorder shows:</p>
 310 <ul>
 311 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address) </li>
 312 </ul>
 313
 314 </div>
 315 </div>
 316 <a class="anchor" id="ga51408eb270d6acb4a080a88c7163a6cb"></a>
 317 <div class="memitem">
 318 <div class="memproto">
 319       <table class="memname">
 320         <tr>
 321           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSetBits </td>
 322           <td>(</td>
 323           <td class="paramtype">EventGroup_t&#160;</td>
 324           <td class="paramname"><em>pxEventGroup</em>, </td>
 325         </tr>
 326         <tr>
 327           <td class="paramkey"></td>
 328           <td></td>
 329           <td class="paramtype">uint32_t&#160;</td>
 330           <td class="paramname"><em>uxBitsToSet</em>&#160;</td>
 331         </tr>
 332         <tr>
 333           <td></td>
 334           <td>)</td>
 335           <td></td><td></td>
 336         </tr>
 337       </table>
 338 </div><div class="memdoc">
 339 <dl class="params"><dt>Parameters</dt><dd>
 340   <table class="params">
 341     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 342     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set.</td></tr>
 343   </table>
 344   </dd>
 345 </dl>
 346 <p>The event <b>EventGroupSetBits</b> is generated when the function xEventGroupSetBits is called.</p>
 347 <p><b>Value</b> in the Event Recorder shows:</p>
 348 <ul>
 349 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 350 <li><b>uxBitsToSet</b> : event bits that shall be set. </li>
 351 </ul>
 352
 353 </div>
 354 </div>
 355 <a class="anchor" id="gace210d0433abdea28689e559b8ce867a"></a>
 356 <div class="memitem">
 357 <div class="memproto">
 358       <table class="memname">
 359         <tr>
 360           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr </td>
 361           <td>(</td>
 362           <td class="paramtype">EventGroup_t&#160;</td>
 363           <td class="paramname"><em>pxEventGroup</em>, </td>
 364         </tr>
 365         <tr>
 366           <td class="paramkey"></td>
 367           <td></td>
 368           <td class="paramtype">uint32_t&#160;</td>
 369           <td class="paramname"><em>uxBitsToSet</em>&#160;</td>
 370         </tr>
 371         <tr>
 372           <td></td>
 373           <td>)</td>
 374           <td></td><td></td>
 375         </tr>
 376       </table>
 377 </div><div class="memdoc">
 378 <dl class="params"><dt>Parameters</dt><dd>
 379   <table class="params">
 380     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 381     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set.</td></tr>
 382   </table>
 383   </dd>
 384 </dl>
 385 <p>The event <b>EventGroupSetBitsFromIsr</b> is generated when the function xEventGroupSetBitsFromISR is called.</p>
 386 <p><b>Value</b> in the Event Recorder shows:</p>
 387 <ul>
 388 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 389 <li><b>uxBitsToSet</b> : event bits that shall be set. </li>
 390 </ul>
 391
 392 </div>
 393 </div>
 394 <a class="anchor" id="gabf2a4485248210068f8856cbca643616"></a>
 395 <div class="memitem">
 396 <div class="memproto">
 397       <table class="memname">
 398         <tr>
 399           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSyncBlock </td>
 400           <td>(</td>
 401           <td class="paramtype">EventGroup_t&#160;</td>
 402           <td class="paramname"><em>pxEventGroup</em>, </td>
 403         </tr>
 404         <tr>
 405           <td class="paramkey"></td>
 406           <td></td>
 407           <td class="paramtype">uint32_t&#160;</td>
 408           <td class="paramname"><em>uxBitsToSet</em>, </td>
 409         </tr>
 410         <tr>
 411           <td class="paramkey"></td>
 412           <td></td>
 413           <td class="paramtype">uint32_t&#160;</td>
 414           <td class="paramname"><em>uxBitsToWaitFor</em>&#160;</td>
 415         </tr>
 416         <tr>
 417           <td></td>
 418           <td>)</td>
 419           <td></td><td></td>
 420         </tr>
 421       </table>
 422 </div><div class="memdoc">
 423 <dl class="params"><dt>Parameters</dt><dd>
 424   <table class="params">
 425     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 426     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set. </td></tr>
 427     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for.</td></tr>
 428   </table>
 429   </dd>
 430 </dl>
 431 <p>The event <b>EventGroupSyncBlock</b> is generated before the function xEventGroupSync enters blocked state.</p>
 432 <p><b>Value</b> in the Event Recorder shows:</p>
 433 <ul>
 434 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 435 <li><b>uxBitsToSet</b> : event bits that shall be set.</li>
 436 <li><b>uxBitsToWaitFor</b> : event bits to wait for. </li>
 437 </ul>
 438
 439 </div>
 440 </div>
 441 <a class="anchor" id="ga395dbbbe8c0477a23055fa73112ec91b"></a>
 442 <div class="memitem">
 443 <div class="memproto">
 444       <table class="memname">
 445         <tr>
 446           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSyncEnd </td>
 447           <td>(</td>
 448           <td class="paramtype">EventGroup_t&#160;</td>
 449           <td class="paramname"><em>pxEventGroup</em>, </td>
 450         </tr>
 451         <tr>
 452           <td class="paramkey"></td>
 453           <td></td>
 454           <td class="paramtype">uint32_t&#160;</td>
 455           <td class="paramname"><em>uxBitsToSet</em>, </td>
 456         </tr>
 457         <tr>
 458           <td class="paramkey"></td>
 459           <td></td>
 460           <td class="paramtype">uint32_t&#160;</td>
 461           <td class="paramname"><em>uxBitsToWaitFor</em>, </td>
 462         </tr>
 463         <tr>
 464           <td class="paramkey"></td>
 465           <td></td>
 466           <td class="paramtype">uint32_t&#160;</td>
 467           <td class="paramname"><em>xTimeoutOccurred</em>&#160;</td>
 468         </tr>
 469         <tr>
 470           <td></td>
 471           <td>)</td>
 472           <td></td><td></td>
 473         </tr>
 474       </table>
 475 </div><div class="memdoc">
 476 <dl class="params"><dt>Parameters</dt><dd>
 477   <table class="params">
 478     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 479     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set. </td></tr>
 480     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for. </td></tr>
 481     <tr><td class="paramdir">[in]</td><td class="paramname">xTimeoutOccurred</td><td>timeout value.</td></tr>
 482   </table>
 483   </dd>
 484 </dl>
 485 <p>The event <b>EventGroupSyncEnd</b> is generated before the function xEventGroupSync returns.</p>
 486 <p><b>Value</b> in the Event Recorder shows:</p>
 487 <ul>
 488 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 489 <li><b>uxBitsToSet</b> : event bits that shall be set.</li>
 490 <li><b>uxBitsToWaitFor</b> : event bits to wait for.</li>
 491 <li><b>xTimeoutOccurred</b> : timeout value (0=timeout occurred, 1=no timeout) </li>
 492 </ul>
 493
 494 </div>
 495 </div>
 496 <a class="anchor" id="ga9da8317cc021b3a4d6349b9f4836e3d3"></a>
 497 <div class="memitem">
 498 <div class="memproto">
 499       <table class="memname">
 500         <tr>
 501           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock </td>
 502           <td>(</td>
 503           <td class="paramtype">EventGroup_t&#160;</td>
 504           <td class="paramname"><em>pxEventGroup</em>, </td>
 505         </tr>
 506         <tr>
 507           <td class="paramkey"></td>
 508           <td></td>
 509           <td class="paramtype">uint32_t&#160;</td>
 510           <td class="paramname"><em>uxBitsToWaitFor</em>&#160;</td>
 511         </tr>
 512         <tr>
 513           <td></td>
 514           <td>)</td>
 515           <td></td><td></td>
 516         </tr>
 517       </table>
 518 </div><div class="memdoc">
 519 <dl class="params"><dt>Parameters</dt><dd>
 520   <table class="params">
 521     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 522     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for.</td></tr>
 523   </table>
 524   </dd>
 525 </dl>
 526 <p>The event <b>EventGroupWaitBitsBlock</b> is generated before the function xEventGroupWaitBits enters blocked state.</p>
 527 <p><b>Value</b> in the Event Recorder shows:</p>
 528 <ul>
 529 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 530 <li><b>uxBitsToWaitFor</b> : event bits to wait for. </li>
 531 </ul>
 532
 533 </div>
 534 </div>
 535 <a class="anchor" id="ga9c215defcaa1cc3026b2717ffab246b5"></a>
 536 <div class="memitem">
 537 <div class="memproto">
 538       <table class="memname">
 539         <tr>
 540           <td class="memname">void EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd </td>
 541           <td>(</td>
 542           <td class="paramtype">EventGroup_t&#160;</td>
 543           <td class="paramname"><em>pxEventGroup</em>, </td>
 544         </tr>
 545         <tr>
 546           <td class="paramkey"></td>
 547           <td></td>
 548           <td class="paramtype">uint32_t&#160;</td>
 549           <td class="paramname"><em>uxBitsToWaitFor</em>, </td>
 550         </tr>
 551         <tr>
 552           <td class="paramkey"></td>
 553           <td></td>
 554           <td class="paramtype">uint32_t&#160;</td>
 555           <td class="paramname"><em>xTimeoutOccurred</em>&#160;</td>
 556         </tr>
 557         <tr>
 558           <td></td>
 559           <td>)</td>
 560           <td></td><td></td>
 561         </tr>
 562       </table>
 563 </div><div class="memdoc">
 564 <dl class="params"><dt>Parameters</dt><dd>
 565   <table class="params">
 566     <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
 567     <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for. </td></tr>
 568     <tr><td class="paramdir">[in]</td><td class="paramname">xTimeoutOccurred</td><td>timeout value.</td></tr>
 569   </table>
 570   </dd>
 571 </dl>
 572 <p>The event <b>EventGroupWaitBitsEnd</b> is generated before the function xEventGroupWaitBits returns.</p>
 573 <p><b>Value</b> in the Event Recorder shows:</p>
 574 <ul>
 575 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
 576 <li><b>uxBitsToWaitFor</b> : event bits to wait for.</li>
 577 <li><b>xTimeoutOccurred</b> : timeout value (0=timeout occurred, 1=no timeout) </li>
 578 </ul>
 579
 580 </div>
 581 </div>
 582 </div><!-- contents -->
 583 </div><!-- doc-content -->
 584 <!-- start footer part -->
 585 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 586   <ul>
 587     <li class="footer">
 588       <script type="text/javascript">
 589         <!--
 590         writeFooter.call(this);
 591         //-->
 592       </script>
 593     </li>
 594   </ul>
 595 </div>
 596 </body>
 597 </html>