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