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">
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-FreeRTOS: Event Groups Functions</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="navtreedata.js"></script>
17 <script type="text/javascript" src="navtree.js"></script>
18 <script type="text/javascript" src="resize.js"></script>
19 <script type="text/javascript" src="cookie.js"></script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/searchdata.js"></script>
22 <script type="text/javascript" src="search/search.js"></script>
23 <script type="text/javascript">
24 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
25 $(function() { init_search(); });
28 <script type="text/javascript" src="darkmode_toggle.js"></script>
29 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
32 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
33 <link href="version.css" rel="stylesheet" type="text/css"/>
34 <script type="text/javascript" src="../version.js"></script>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39 <table cellspacing="0" cellpadding="0">
41 <tr style="height: 55px;">
42 <td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="cmsis_logo_white_small.png"/</a></td>
43 <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
44 <div id="projectname">CMSIS-FreeRTOS
45  <span id="projectnumber"><script type="text/javascript">
47 writeHeader.call(this);
48 writeVersionDropdown.call(this, "CMSIS-FreeRTOS");
53 <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
55 <td> <div id="MSearchBox" class="MSearchBoxInactive">
57 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
58 <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
59 onfocus="searchBox.OnSearchFieldFocus(true)"
60 onblur="searchBox.OnSearchFieldFocus(false)"
61 onkeyup="searchBox.OnSearchFieldChange(event)"/>
62 </span><span class="right">
63 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
71 <!-- end header part -->
72 <div id="CMSISnav" class="tabs1">
74 <script type="text/javascript">
75 writeComponentTabs.call(this);
79 <!-- Generated by Doxygen 1.13.2 -->
80 <script type="text/javascript">
81 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
82 var searchBox = new SearchBox("searchBox", "search/",'.html');
85 <script type="text/javascript">
86 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
87 $(function() { codefold.init(0); });
91 <div id="side-nav" class="ui-resizable side-nav-resizable">
93 <div id="nav-tree-contents">
94 <div id="nav-sync" class="sync"></div>
97 <div id="splitbar" style="-moz-user-select:none;"
98 class="ui-resizable-handle">
101 <script type="text/javascript">
102 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
103 $(function(){initNavTree('group__freertos__evr__event__groups.html',''); initResizable(true); });
106 <div id="doc-content">
107 <!-- window showing the filter options -->
108 <div id="MSearchSelectWindow"
109 onmouseover="return searchBox.OnSearchSelectShow()"
110 onmouseout="return searchBox.OnSearchSelectHide()"
111 onkeydown="return searchBox.OnSearchSelectKey(event)">
114 <!-- iframe showing the search results (closed by default) -->
115 <div id="MSearchResultsWindow">
116 <div id="MSearchResults">
119 <div id="SRResults"></div>
120 <div class="SRStatus" id="Loading">Loading...</div>
121 <div class="SRStatus" id="Searching">Searching...</div>
122 <div class="SRStatus" id="NoMatches">No Matches</div>
129 <div class="summary">
130 <a href="#func-members">Functions</a> </div>
131 <div class="headertitle"><div class="title">Event Groups Functions<div class="ingroups"><a class="el" href="group__freertos__specific.html">CMSIS-FreeRTOS Specifics</a> » <a class="el" href="group__freertos__evr.html">Event functions</a></div></div></div>
133 <div class="contents">
135 <p>Events generated by event groups functions.
136 <a href="#details">More...</a></p>
137 <table class="memberdecls">
138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
139 Functions</h2></td></tr>
140 <tr class="memitem:gad8448ba4d5388e38e190b352f45a101f" id="r_gad8448ba4d5388e38e190b352f45a101f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad8448ba4d5388e38e190b352f45a101f">EvrFreeRTOSEventGroups_EventGroupCreate</a> (EventGroup_t pxEventGroup)</td></tr>
141 <tr class="memdesc:gad8448ba4d5388e38e190b352f45a101f"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful event groups object create (Op) <br /></td></tr>
142 <tr class="separator:gad8448ba4d5388e38e190b352f45a101f"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:ga7a53268580bdc71b6436c57c25dc551f" id="r_ga7a53268580bdc71b6436c57c25dc551f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7a53268580bdc71b6436c57c25dc551f">EvrFreeRTOSEventGroups_EventGroupCreateFailed</a> (void)</td></tr>
144 <tr class="memdesc:ga7a53268580bdc71b6436c57c25dc551f"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful event groups object create (Error) <br /></td></tr>
145 <tr class="separator:ga7a53268580bdc71b6436c57c25dc551f"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:gabf2a4485248210068f8856cbca643616" id="r_gabf2a4485248210068f8856cbca643616"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabf2a4485248210068f8856cbca643616">EvrFreeRTOSEventGroups_EventGroupSyncBlock</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor)</td></tr>
147 <tr class="memdesc:gabf2a4485248210068f8856cbca643616"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups sync wait start (Op) <br /></td></tr>
148 <tr class="separator:gabf2a4485248210068f8856cbca643616"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:ga395dbbbe8c0477a23055fa73112ec91b" id="r_ga395dbbbe8c0477a23055fa73112ec91b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga395dbbbe8c0477a23055fa73112ec91b">EvrFreeRTOSEventGroups_EventGroupSyncEnd</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)</td></tr>
150 <tr class="memdesc:ga395dbbbe8c0477a23055fa73112ec91b"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups sync completed (Op) <br /></td></tr>
151 <tr class="separator:ga395dbbbe8c0477a23055fa73112ec91b"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:ga9da8317cc021b3a4d6349b9f4836e3d3" id="r_ga9da8317cc021b3a4d6349b9f4836e3d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9da8317cc021b3a4d6349b9f4836e3d3">EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor)</td></tr>
153 <tr class="memdesc:ga9da8317cc021b3a4d6349b9f4836e3d3"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups bit wait start (Op) <br /></td></tr>
154 <tr class="separator:ga9da8317cc021b3a4d6349b9f4836e3d3"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ga9c215defcaa1cc3026b2717ffab246b5" id="r_ga9c215defcaa1cc3026b2717ffab246b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9c215defcaa1cc3026b2717ffab246b5">EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)</td></tr>
156 <tr class="memdesc:ga9c215defcaa1cc3026b2717ffab246b5"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups bit wait completed (Op) <br /></td></tr>
157 <tr class="separator:ga9c215defcaa1cc3026b2717ffab246b5"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:ga7b949dc8d8167fc621fc6102808caa81" id="r_ga7b949dc8d8167fc621fc6102808caa81"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7b949dc8d8167fc621fc6102808caa81">EvrFreeRTOSEventGroups_EventGroupClearBits</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)</td></tr>
159 <tr class="memdesc:ga7b949dc8d8167fc621fc6102808caa81"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups bit clear (Op) <br /></td></tr>
160 <tr class="separator:ga7b949dc8d8167fc621fc6102808caa81"><td class="memSeparator" colspan="2"> </td></tr>
161 <tr class="memitem:ga1a8cc5bff8d6d29db8d96d790f7c1db5" id="r_ga1a8cc5bff8d6d29db8d96d790f7c1db5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1a8cc5bff8d6d29db8d96d790f7c1db5">EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)</td></tr>
162 <tr class="memdesc:ga1a8cc5bff8d6d29db8d96d790f7c1db5"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups bit clear call from ISR (Op) <br /></td></tr>
163 <tr class="separator:ga1a8cc5bff8d6d29db8d96d790f7c1db5"><td class="memSeparator" colspan="2"> </td></tr>
164 <tr class="memitem:ga51408eb270d6acb4a080a88c7163a6cb" id="r_ga51408eb270d6acb4a080a88c7163a6cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga51408eb270d6acb4a080a88c7163a6cb">EvrFreeRTOSEventGroups_EventGroupSetBits</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)</td></tr>
165 <tr class="memdesc:ga51408eb270d6acb4a080a88c7163a6cb"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups bit set (Op) <br /></td></tr>
166 <tr class="separator:ga51408eb270d6acb4a080a88c7163a6cb"><td class="memSeparator" colspan="2"> </td></tr>
167 <tr class="memitem:gace210d0433abdea28689e559b8ce867a" id="r_gace210d0433abdea28689e559b8ce867a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gace210d0433abdea28689e559b8ce867a">EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr</a> (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)</td></tr>
168 <tr class="memdesc:gace210d0433abdea28689e559b8ce867a"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups bit set call from ISR (Op) <br /></td></tr>
169 <tr class="separator:gace210d0433abdea28689e559b8ce867a"><td class="memSeparator" colspan="2"> </td></tr>
170 <tr class="memitem:ga9109cd0187e2408f9e1d730c5b09acc6" id="r_ga9109cd0187e2408f9e1d730c5b09acc6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9109cd0187e2408f9e1d730c5b09acc6">EvrFreeRTOSEventGroups_EventGroupDelete</a> (EventGroup_t pxEventGroup)</td></tr>
171 <tr class="memdesc:ga9109cd0187e2408f9e1d730c5b09acc6"><td class="mdescLeft"> </td><td class="mdescRight">Event on event groups object delete (Op) <br /></td></tr>
172 <tr class="separator:ga9109cd0187e2408f9e1d730c5b09acc6"><td class="memSeparator" colspan="2"> </td></tr>
173 <tr class="memitem:ga12e4d5f13d6290eab6b4f650a72abd77" id="r_ga12e4d5f13d6290eab6b4f650a72abd77"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga12e4d5f13d6290eab6b4f650a72abd77">EvrFreeRTOSEventGroups_xEventGroupCreateStatic</a> (StaticEventGroup_t *pxEventGroupBuffer)</td></tr>
174 <tr class="memdesc:ga12e4d5f13d6290eab6b4f650a72abd77"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupCreateStatic is called (API). <br /></td></tr>
175 <tr class="separator:ga12e4d5f13d6290eab6b4f650a72abd77"><td class="memSeparator" colspan="2"> </td></tr>
176 <tr class="memitem:ga6c7ba5eeaea299fef9830874d93dc577" id="r_ga6c7ba5eeaea299fef9830874d93dc577"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6c7ba5eeaea299fef9830874d93dc577">EvrFreeRTOSEventGroups_xEventGroupCreateStatic_Return</a> (EventGroupHandle_t xEventGroup)</td></tr>
177 <tr class="memdesc:ga6c7ba5eeaea299fef9830874d93dc577"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupCreateStatic returns (Op). <br /></td></tr>
178 <tr class="separator:ga6c7ba5eeaea299fef9830874d93dc577"><td class="memSeparator" colspan="2"> </td></tr>
179 <tr class="memitem:ga74e191440844cc703e85ab372ea2d622" id="r_ga74e191440844cc703e85ab372ea2d622"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga74e191440844cc703e85ab372ea2d622">EvrFreeRTOSEventGroups_xEventGroupCreate</a> (void)</td></tr>
180 <tr class="memdesc:ga74e191440844cc703e85ab372ea2d622"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupCreate is called (API). <br /></td></tr>
181 <tr class="separator:ga74e191440844cc703e85ab372ea2d622"><td class="memSeparator" colspan="2"> </td></tr>
182 <tr class="memitem:ga0e7d1852b3050563e1a4c7adb816a08b" id="r_ga0e7d1852b3050563e1a4c7adb816a08b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0e7d1852b3050563e1a4c7adb816a08b">EvrFreeRTOSEventGroups_xEventGroupCreate_Return</a> (EventGroupHandle_t xEventGroup)</td></tr>
183 <tr class="memdesc:ga0e7d1852b3050563e1a4c7adb816a08b"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupCreate returns (Op). <br /></td></tr>
184 <tr class="separator:ga0e7d1852b3050563e1a4c7adb816a08b"><td class="memSeparator" colspan="2"> </td></tr>
185 <tr class="memitem:ga726bd52b8e51149123b7343fde53902b" id="r_ga726bd52b8e51149123b7343fde53902b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga726bd52b8e51149123b7343fde53902b">EvrFreeRTOSEventGroups_xEventGroupSync</a> (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait)</td></tr>
186 <tr class="memdesc:ga726bd52b8e51149123b7343fde53902b"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupSync is called (API). <br /></td></tr>
187 <tr class="separator:ga726bd52b8e51149123b7343fde53902b"><td class="memSeparator" colspan="2"> </td></tr>
188 <tr class="memitem:ga72e2aa2beff00813a21cc4a98713e1e5" id="r_ga72e2aa2beff00813a21cc4a98713e1e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga72e2aa2beff00813a21cc4a98713e1e5">EvrFreeRTOSEventGroups_xEventGroupSync_Return</a> (EventBits_t uxReturn)</td></tr>
189 <tr class="memdesc:ga72e2aa2beff00813a21cc4a98713e1e5"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupSync returns (Op). <br /></td></tr>
190 <tr class="separator:ga72e2aa2beff00813a21cc4a98713e1e5"><td class="memSeparator" colspan="2"> </td></tr>
191 <tr class="memitem:ga128de0e7a319f92a226b60b31c139391" id="r_ga128de0e7a319f92a226b60b31c139391"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga128de0e7a319f92a226b60b31c139391">EvrFreeRTOSEventGroups_xEventGroupWaitBits</a> (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait)</td></tr>
192 <tr class="memdesc:ga128de0e7a319f92a226b60b31c139391"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupWaitBits is called (API). <br /></td></tr>
193 <tr class="separator:ga128de0e7a319f92a226b60b31c139391"><td class="memSeparator" colspan="2"> </td></tr>
194 <tr class="memitem:ga9c082026bb0b7a95733ec22a3af3bee4" id="r_ga9c082026bb0b7a95733ec22a3af3bee4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9c082026bb0b7a95733ec22a3af3bee4">EvrFreeRTOSEventGroups_xEventGroupWaitBits_Return</a> (EventBits_t uxReturn)</td></tr>
195 <tr class="memdesc:ga9c082026bb0b7a95733ec22a3af3bee4"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupWaitBits returns (Op). <br /></td></tr>
196 <tr class="separator:ga9c082026bb0b7a95733ec22a3af3bee4"><td class="memSeparator" colspan="2"> </td></tr>
197 <tr class="memitem:ga77dbf2f89414189d49519ed49e55e7f1" id="r_ga77dbf2f89414189d49519ed49e55e7f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga77dbf2f89414189d49519ed49e55e7f1">EvrFreeRTOSEventGroups_xEventGroupClearBits</a> (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear)</td></tr>
198 <tr class="memdesc:ga77dbf2f89414189d49519ed49e55e7f1"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupClearBits is called (API). <br /></td></tr>
199 <tr class="separator:ga77dbf2f89414189d49519ed49e55e7f1"><td class="memSeparator" colspan="2"> </td></tr>
200 <tr class="memitem:gadd3bf4a3a915db57344b1fff31afaa37" id="r_gadd3bf4a3a915db57344b1fff31afaa37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gadd3bf4a3a915db57344b1fff31afaa37">EvrFreeRTOSEventGroups_xEventGroupClearBits_Return</a> (EventBits_t uxReturn)</td></tr>
201 <tr class="memdesc:gadd3bf4a3a915db57344b1fff31afaa37"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupClearBits returns (Op). <br /></td></tr>
202 <tr class="separator:gadd3bf4a3a915db57344b1fff31afaa37"><td class="memSeparator" colspan="2"> </td></tr>
203 <tr class="memitem:ga62f545cdee5ae708597611ba8cbd6cf2" id="r_ga62f545cdee5ae708597611ba8cbd6cf2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga62f545cdee5ae708597611ba8cbd6cf2">EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR</a> (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear)</td></tr>
204 <tr class="memdesc:ga62f545cdee5ae708597611ba8cbd6cf2"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupClearBitsFromISR is called (API). <br /></td></tr>
205 <tr class="separator:ga62f545cdee5ae708597611ba8cbd6cf2"><td class="memSeparator" colspan="2"> </td></tr>
206 <tr class="memitem:gaa8754ceedaaf53a50bcb397cdfe106aa" id="r_gaa8754ceedaaf53a50bcb397cdfe106aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa8754ceedaaf53a50bcb397cdfe106aa">EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR_Return</a> (BaseType_t xReturn)</td></tr>
207 <tr class="memdesc:gaa8754ceedaaf53a50bcb397cdfe106aa"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupClearBitsFromISR returns (Op). <br /></td></tr>
208 <tr class="separator:gaa8754ceedaaf53a50bcb397cdfe106aa"><td class="memSeparator" colspan="2"> </td></tr>
209 <tr class="memitem:ga93d44c94e8921b19bc3aae63663b5858" id="r_ga93d44c94e8921b19bc3aae63663b5858"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga93d44c94e8921b19bc3aae63663b5858">EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR</a> (EventGroupHandle_t xEventGroup)</td></tr>
210 <tr class="memdesc:ga93d44c94e8921b19bc3aae63663b5858"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupGetBitsFromISR is called (API). <br /></td></tr>
211 <tr class="separator:ga93d44c94e8921b19bc3aae63663b5858"><td class="memSeparator" colspan="2"> </td></tr>
212 <tr class="memitem:gaa1440d808c439ab6f20e189b001ee339" id="r_gaa1440d808c439ab6f20e189b001ee339"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa1440d808c439ab6f20e189b001ee339">EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR_Return</a> (EventBits_t uxReturn)</td></tr>
213 <tr class="memdesc:gaa1440d808c439ab6f20e189b001ee339"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupGetBitsFromISR returns (Op). <br /></td></tr>
214 <tr class="separator:gaa1440d808c439ab6f20e189b001ee339"><td class="memSeparator" colspan="2"> </td></tr>
215 <tr class="memitem:ga5346c4371cc8b4e5e8ad903591b40274" id="r_ga5346c4371cc8b4e5e8ad903591b40274"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5346c4371cc8b4e5e8ad903591b40274">EvrFreeRTOSEventGroups_xEventGroupSetBits</a> (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet)</td></tr>
216 <tr class="memdesc:ga5346c4371cc8b4e5e8ad903591b40274"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupSetBits is called (API). <br /></td></tr>
217 <tr class="separator:ga5346c4371cc8b4e5e8ad903591b40274"><td class="memSeparator" colspan="2"> </td></tr>
218 <tr class="memitem:gad20a588b0115600cb6c21f8854c8ed9f" id="r_gad20a588b0115600cb6c21f8854c8ed9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad20a588b0115600cb6c21f8854c8ed9f">EvrFreeRTOSEventGroups_xEventGroupSetBits_Return</a> (EventBits_t uxReturn)</td></tr>
219 <tr class="memdesc:gad20a588b0115600cb6c21f8854c8ed9f"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupSetBits returns (Op). <br /></td></tr>
220 <tr class="separator:gad20a588b0115600cb6c21f8854c8ed9f"><td class="memSeparator" colspan="2"> </td></tr>
221 <tr class="memitem:gac43f8f6a7f35d2b03053bbfed1788016" id="r_gac43f8f6a7f35d2b03053bbfed1788016"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac43f8f6a7f35d2b03053bbfed1788016">EvrFreeRTOSEventGroups_vEventGroupDelete</a> (EventGroupHandle_t xEventGroup)</td></tr>
222 <tr class="memdesc:gac43f8f6a7f35d2b03053bbfed1788016"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function vEventGroupDelete is called (API). <br /></td></tr>
223 <tr class="separator:gac43f8f6a7f35d2b03053bbfed1788016"><td class="memSeparator" colspan="2"> </td></tr>
224 <tr class="memitem:gab0b80a23584e36bc765a5264b879613c" id="r_gab0b80a23584e36bc765a5264b879613c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab0b80a23584e36bc765a5264b879613c">EvrFreeRTOSEventGroups_vEventGroupDelete_Return</a> (void)</td></tr>
225 <tr class="memdesc:gab0b80a23584e36bc765a5264b879613c"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function vEventGroupDelete returns (Op). <br /></td></tr>
226 <tr class="separator:gab0b80a23584e36bc765a5264b879613c"><td class="memSeparator" colspan="2"> </td></tr>
227 <tr class="memitem:ga7735898508e6aa707e9f32fb739fa177" id="r_ga7735898508e6aa707e9f32fb739fa177"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7735898508e6aa707e9f32fb739fa177">EvrFreeRTOSEventGroups_xEventGroupGetStaticBuffer_Return</a> (BaseType_t xReturn)</td></tr>
228 <tr class="memdesc:ga7735898508e6aa707e9f32fb739fa177"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupGetStaticBuffer returns (Op). <br /></td></tr>
229 <tr class="separator:ga7735898508e6aa707e9f32fb739fa177"><td class="memSeparator" colspan="2"> </td></tr>
230 <tr class="memitem:gaed98e5c1e15aba07b1330db347bd70be" id="r_gaed98e5c1e15aba07b1330db347bd70be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaed98e5c1e15aba07b1330db347bd70be">EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback</a> (void *pvEventGroup, uint32_t ulBitsToSet)</td></tr>
231 <tr class="memdesc:gaed98e5c1e15aba07b1330db347bd70be"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function vEventGroupSetBitsCallback is called (API). <br /></td></tr>
232 <tr class="separator:gaed98e5c1e15aba07b1330db347bd70be"><td class="memSeparator" colspan="2"> </td></tr>
233 <tr class="memitem:ga9915ab21949e80c30359065dbc117d74" id="r_ga9915ab21949e80c30359065dbc117d74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9915ab21949e80c30359065dbc117d74">EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback_Return</a> (void)</td></tr>
234 <tr class="memdesc:ga9915ab21949e80c30359065dbc117d74"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function vEventGroupSetBitsCallback returns (Op). <br /></td></tr>
235 <tr class="separator:ga9915ab21949e80c30359065dbc117d74"><td class="memSeparator" colspan="2"> </td></tr>
236 <tr class="memitem:ga3aa3e61a3ddc4dcbedc52012508130f6" id="r_ga3aa3e61a3ddc4dcbedc52012508130f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3aa3e61a3ddc4dcbedc52012508130f6">EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback</a> (void *pvEventGroup, uint32_t ulBitsToClear)</td></tr>
237 <tr class="memdesc:ga3aa3e61a3ddc4dcbedc52012508130f6"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function vEventGroupClearBitsCallback is called (API). <br /></td></tr>
238 <tr class="separator:ga3aa3e61a3ddc4dcbedc52012508130f6"><td class="memSeparator" colspan="2"> </td></tr>
239 <tr class="memitem:ga4a886e2b82bc47882d843b5d2340633f" id="r_ga4a886e2b82bc47882d843b5d2340633f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4a886e2b82bc47882d843b5d2340633f">EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback_Return</a> (void)</td></tr>
240 <tr class="memdesc:ga4a886e2b82bc47882d843b5d2340633f"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function vEventGroupClearBitsCallback returns (Op). <br /></td></tr>
241 <tr class="separator:ga4a886e2b82bc47882d843b5d2340633f"><td class="memSeparator" colspan="2"> </td></tr>
242 <tr class="memitem:gacfd57b185c8e998a9d73fd05e6219e7f" id="r_gacfd57b185c8e998a9d73fd05e6219e7f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacfd57b185c8e998a9d73fd05e6219e7f">EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR</a> (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken)</td></tr>
243 <tr class="memdesc:gacfd57b185c8e998a9d73fd05e6219e7f"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function xEventGroupSetBitsFromISR is called (API). <br /></td></tr>
244 <tr class="separator:gacfd57b185c8e998a9d73fd05e6219e7f"><td class="memSeparator" colspan="2"> </td></tr>
245 <tr class="memitem:ga4b5f601b8d143b2047e15f2db8c34f96" id="r_ga4b5f601b8d143b2047e15f2db8c34f96"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4b5f601b8d143b2047e15f2db8c34f96">EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR_Return</a> (BaseType_t xReturn)</td></tr>
246 <tr class="memdesc:ga4b5f601b8d143b2047e15f2db8c34f96"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function xEventGroupSetBitsFromISR returns (Op). <br /></td></tr>
247 <tr class="separator:ga4b5f601b8d143b2047e15f2db8c34f96"><td class="memSeparator" colspan="2"> </td></tr>
248 <tr class="memitem:ga981a4d28efe77e50c4094b1afce30193" id="r_ga981a4d28efe77e50c4094b1afce30193"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga981a4d28efe77e50c4094b1afce30193">EvrFreeRTOSEventGroups_uxEventGroupGetNumber</a> (void *xEventGroup)</td></tr>
249 <tr class="memdesc:ga981a4d28efe77e50c4094b1afce30193"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function uxEventGroupGetNumber is called (API). <br /></td></tr>
250 <tr class="separator:ga981a4d28efe77e50c4094b1afce30193"><td class="memSeparator" colspan="2"> </td></tr>
251 <tr class="memitem:gad7e41d55a6a5869e387ca2a00a42bf75" id="r_gad7e41d55a6a5869e387ca2a00a42bf75"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad7e41d55a6a5869e387ca2a00a42bf75">EvrFreeRTOSEventGroups_uxEventGroupGetNumber_Return</a> (UBaseType_t xReturn)</td></tr>
252 <tr class="memdesc:gad7e41d55a6a5869e387ca2a00a42bf75"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function uxEventGroupGetNumber returns (Op). <br /></td></tr>
253 <tr class="separator:gad7e41d55a6a5869e387ca2a00a42bf75"><td class="memSeparator" colspan="2"> </td></tr>
254 <tr class="memitem:ga0aa02578d0ef9a6ecd4be3557e53ba77" id="r_ga0aa02578d0ef9a6ecd4be3557e53ba77"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0aa02578d0ef9a6ecd4be3557e53ba77">EvrFreeRTOSEventGroups_vEventGroupSetNumber</a> (void *xEventGroup, UBaseType_t uxEventGroupNumber)</td></tr>
255 <tr class="memdesc:ga0aa02578d0ef9a6ecd4be3557e53ba77"><td class="mdescLeft"> </td><td class="mdescRight">Event sent when function vEventGroupSetNumber is called (API). <br /></td></tr>
256 <tr class="separator:ga0aa02578d0ef9a6ecd4be3557e53ba77"><td class="memSeparator" colspan="2"> </td></tr>
257 <tr class="memitem:ga2257190eb3bfc6adba1b2aa30c21d56d" id="r_ga2257190eb3bfc6adba1b2aa30c21d56d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2257190eb3bfc6adba1b2aa30c21d56d">EvrFreeRTOSEventGroups_vEventGroupSetNumber_Return</a> (void)</td></tr>
258 <tr class="memdesc:ga2257190eb3bfc6adba1b2aa30c21d56d"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before function vEventGroupSetNumber returns (Op). <br /></td></tr>
259 <tr class="separator:ga2257190eb3bfc6adba1b2aa30c21d56d"><td class="memSeparator" colspan="2"> </td></tr>
261 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
262 <p>Events generated by event groups functions. </p>
263 <h2 class="groupheader">Function Documentation</h2>
264 <a id="ga7b949dc8d8167fc621fc6102808caa81" name="ga7b949dc8d8167fc621fc6102808caa81"></a>
265 <h2 class="memtitle"><span class="permalink"><a href="#ga7b949dc8d8167fc621fc6102808caa81">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupClearBits()</h2>
267 <div class="memitem">
268 <div class="memproto">
269 <table class="mlabels">
271 <td class="mlabels-left">
272 <table class="memname">
274 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupClearBits </td>
276 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
279 <td class="paramkey"></td>
281 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToClear</em></span> )</td>
285 <td class="mlabels-right">
286 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
289 </div><div class="memdoc">
291 <p>Event on event groups bit clear (Op) </p>
292 <dl class="params"><dt>Parameters</dt><dd>
293 <table class="params">
294 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
295 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToClear</td><td>event bits that shall be cleared.</td></tr>
299 <p>The event <b>EventGroupClearBits</b> is generated when the function xEventGroupClearBits is called.</p>
300 <p><b>Value</b> in the Event Recorder shows:</p><ul>
301 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
302 <li><b>uxBitsToClear</b> : event bits that shall be cleared. </li>
307 <a id="ga1a8cc5bff8d6d29db8d96d790f7c1db5" name="ga1a8cc5bff8d6d29db8d96d790f7c1db5"></a>
308 <h2 class="memtitle"><span class="permalink"><a href="#ga1a8cc5bff8d6d29db8d96d790f7c1db5">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr()</h2>
310 <div class="memitem">
311 <div class="memproto">
312 <table class="mlabels">
314 <td class="mlabels-left">
315 <table class="memname">
317 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr </td>
319 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
322 <td class="paramkey"></td>
324 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToClear</em></span> )</td>
328 <td class="mlabels-right">
329 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
332 </div><div class="memdoc">
334 <p>Event on event groups bit clear call from ISR (Op) </p>
335 <dl class="params"><dt>Parameters</dt><dd>
336 <table class="params">
337 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
338 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToClear</td><td>event bits that shall be cleared.</td></tr>
342 <p>The event <b>EventGroupClearBitsFromIsr</b> is generated when the function xEventGroupClearBitsFromISR is called.</p>
343 <p><b>Value</b> in the Event Recorder shows:</p><ul>
344 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
345 <li><b>uxBitsToClear</b> : event bits that shall be cleared. </li>
350 <a id="gad8448ba4d5388e38e190b352f45a101f" name="gad8448ba4d5388e38e190b352f45a101f"></a>
351 <h2 class="memtitle"><span class="permalink"><a href="#gad8448ba4d5388e38e190b352f45a101f">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupCreate()</h2>
353 <div class="memitem">
354 <div class="memproto">
355 <table class="mlabels">
357 <td class="mlabels-left">
358 <table class="memname">
360 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupCreate </td>
362 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span></td><td>)</td>
367 <td class="mlabels-right">
368 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
371 </div><div class="memdoc">
373 <p>Event on successful event groups object create (Op) </p>
374 <dl class="params"><dt>Parameters</dt><dd>
375 <table class="params">
376 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
380 <p>The event <b>EventGroupCreate</b> is generated when Event Groups object is successfully created.</p>
381 <p><b>Value</b> in the Event Recorder shows:</p><ul>
382 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address) </li>
387 <a id="ga7a53268580bdc71b6436c57c25dc551f" name="ga7a53268580bdc71b6436c57c25dc551f"></a>
388 <h2 class="memtitle"><span class="permalink"><a href="#ga7a53268580bdc71b6436c57c25dc551f">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupCreateFailed()</h2>
390 <div class="memitem">
391 <div class="memproto">
392 <table class="mlabels">
394 <td class="mlabels-left">
395 <table class="memname">
397 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupCreateFailed </td>
399 <td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
404 <td class="mlabels-right">
405 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
408 </div><div class="memdoc">
410 <p>Event on unsuccessful event groups object create (Error) </p>
411 <p>The event <b>EventGroupCreateFailed</b> is generated when Event Groups object create fails due to insufficient heap memory. </p>
415 <a id="ga9109cd0187e2408f9e1d730c5b09acc6" name="ga9109cd0187e2408f9e1d730c5b09acc6"></a>
416 <h2 class="memtitle"><span class="permalink"><a href="#ga9109cd0187e2408f9e1d730c5b09acc6">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupDelete()</h2>
418 <div class="memitem">
419 <div class="memproto">
420 <table class="mlabels">
422 <td class="mlabels-left">
423 <table class="memname">
425 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupDelete </td>
427 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span></td><td>)</td>
432 <td class="mlabels-right">
433 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
436 </div><div class="memdoc">
438 <p>Event on event groups object delete (Op) </p>
439 <dl class="params"><dt>Parameters</dt><dd>
440 <table class="params">
441 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
445 <p>The event <b>EventGroupDelete</b> is generated when Event Group object is successfully added to object delete queue.</p>
446 <p><b>Value</b> in the Event Recorder shows:</p><ul>
447 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address) </li>
452 <a id="ga51408eb270d6acb4a080a88c7163a6cb" name="ga51408eb270d6acb4a080a88c7163a6cb"></a>
453 <h2 class="memtitle"><span class="permalink"><a href="#ga51408eb270d6acb4a080a88c7163a6cb">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupSetBits()</h2>
455 <div class="memitem">
456 <div class="memproto">
457 <table class="mlabels">
459 <td class="mlabels-left">
460 <table class="memname">
462 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSetBits </td>
464 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
467 <td class="paramkey"></td>
469 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToSet</em></span> )</td>
473 <td class="mlabels-right">
474 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
477 </div><div class="memdoc">
479 <p>Event on event groups bit set (Op) </p>
480 <dl class="params"><dt>Parameters</dt><dd>
481 <table class="params">
482 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
483 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set.</td></tr>
487 <p>The event <b>EventGroupSetBits</b> is generated when the function xEventGroupSetBits is called.</p>
488 <p><b>Value</b> in the Event Recorder shows:</p><ul>
489 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
490 <li><b>uxBitsToSet</b> : event bits that shall be set. </li>
495 <a id="gace210d0433abdea28689e559b8ce867a" name="gace210d0433abdea28689e559b8ce867a"></a>
496 <h2 class="memtitle"><span class="permalink"><a href="#gace210d0433abdea28689e559b8ce867a">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr()</h2>
498 <div class="memitem">
499 <div class="memproto">
500 <table class="mlabels">
502 <td class="mlabels-left">
503 <table class="memname">
505 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr </td>
507 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
510 <td class="paramkey"></td>
512 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToSet</em></span> )</td>
516 <td class="mlabels-right">
517 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
520 </div><div class="memdoc">
522 <p>Event on event groups bit set call from ISR (Op) </p>
523 <dl class="params"><dt>Parameters</dt><dd>
524 <table class="params">
525 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
526 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set.</td></tr>
530 <p>The event <b>EventGroupSetBitsFromIsr</b> is generated when the function xEventGroupSetBitsFromISR is called.</p>
531 <p><b>Value</b> in the Event Recorder shows:</p><ul>
532 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
533 <li><b>uxBitsToSet</b> : event bits that shall be set. </li>
538 <a id="gabf2a4485248210068f8856cbca643616" name="gabf2a4485248210068f8856cbca643616"></a>
539 <h2 class="memtitle"><span class="permalink"><a href="#gabf2a4485248210068f8856cbca643616">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupSyncBlock()</h2>
541 <div class="memitem">
542 <div class="memproto">
543 <table class="mlabels">
545 <td class="mlabels-left">
546 <table class="memname">
548 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSyncBlock </td>
550 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
553 <td class="paramkey"></td>
555 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToSet</em></span>, </td>
558 <td class="paramkey"></td>
560 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToWaitFor</em></span> )</td>
564 <td class="mlabels-right">
565 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
568 </div><div class="memdoc">
570 <p>Event on event groups sync wait start (Op) </p>
571 <dl class="params"><dt>Parameters</dt><dd>
572 <table class="params">
573 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
574 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set. </td></tr>
575 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for.</td></tr>
579 <p>The event <b>EventGroupSyncBlock</b> is generated before the function xEventGroupSync enters blocked state.</p>
580 <p><b>Value</b> in the Event Recorder shows:</p><ul>
581 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
582 <li><b>uxBitsToSet</b> : event bits that shall be set.</li>
583 <li><b>uxBitsToWaitFor</b> : event bits to wait for. </li>
588 <a id="ga395dbbbe8c0477a23055fa73112ec91b" name="ga395dbbbe8c0477a23055fa73112ec91b"></a>
589 <h2 class="memtitle"><span class="permalink"><a href="#ga395dbbbe8c0477a23055fa73112ec91b">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupSyncEnd()</h2>
591 <div class="memitem">
592 <div class="memproto">
593 <table class="mlabels">
595 <td class="mlabels-left">
596 <table class="memname">
598 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupSyncEnd </td>
600 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
603 <td class="paramkey"></td>
605 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToSet</em></span>, </td>
608 <td class="paramkey"></td>
610 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToWaitFor</em></span>, </td>
613 <td class="paramkey"></td>
615 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>xTimeoutOccurred</em></span> )</td>
619 <td class="mlabels-right">
620 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
623 </div><div class="memdoc">
625 <p>Event on event groups sync completed (Op) </p>
626 <dl class="params"><dt>Parameters</dt><dd>
627 <table class="params">
628 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
629 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>event bits that shall be set. </td></tr>
630 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for. </td></tr>
631 <tr><td class="paramdir">[in]</td><td class="paramname">xTimeoutOccurred</td><td>timeout value.</td></tr>
635 <p>The event <b>EventGroupSyncEnd</b> is generated before the function xEventGroupSync returns.</p>
636 <p><b>Value</b> in the Event Recorder shows:</p><ul>
637 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
638 <li><b>uxBitsToSet</b> : event bits that shall be set.</li>
639 <li><b>uxBitsToWaitFor</b> : event bits to wait for.</li>
640 <li><b>xTimeoutOccurred</b> : timeout value (0=timeout occurred, 1=no timeout) </li>
645 <a id="ga9da8317cc021b3a4d6349b9f4836e3d3" name="ga9da8317cc021b3a4d6349b9f4836e3d3"></a>
646 <h2 class="memtitle"><span class="permalink"><a href="#ga9da8317cc021b3a4d6349b9f4836e3d3">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock()</h2>
648 <div class="memitem">
649 <div class="memproto">
650 <table class="mlabels">
652 <td class="mlabels-left">
653 <table class="memname">
655 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock </td>
657 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
660 <td class="paramkey"></td>
662 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToWaitFor</em></span> )</td>
666 <td class="mlabels-right">
667 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
670 </div><div class="memdoc">
672 <p>Event on event groups bit wait start (Op) </p>
673 <dl class="params"><dt>Parameters</dt><dd>
674 <table class="params">
675 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
676 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for.</td></tr>
680 <p>The event <b>EventGroupWaitBitsBlock</b> is generated before the function xEventGroupWaitBits enters blocked state.</p>
681 <p><b>Value</b> in the Event Recorder shows:</p><ul>
682 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
683 <li><b>uxBitsToWaitFor</b> : event bits to wait for. </li>
688 <a id="ga9c215defcaa1cc3026b2717ffab246b5" name="ga9c215defcaa1cc3026b2717ffab246b5"></a>
689 <h2 class="memtitle"><span class="permalink"><a href="#ga9c215defcaa1cc3026b2717ffab246b5">◆ </a></span>EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd()</h2>
691 <div class="memitem">
692 <div class="memproto">
693 <table class="mlabels">
695 <td class="mlabels-left">
696 <table class="memname">
698 <td class="memname">void EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd </td>
700 <td class="paramtype">EventGroup_t</td> <td class="paramname"><span class="paramname"><em>pxEventGroup</em></span>, </td>
703 <td class="paramkey"></td>
705 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToWaitFor</em></span>, </td>
708 <td class="paramkey"></td>
710 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>xTimeoutOccurred</em></span> )</td>
714 <td class="mlabels-right">
715 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
718 </div><div class="memdoc">
720 <p>Event on event groups bit wait completed (Op) </p>
721 <dl class="params"><dt>Parameters</dt><dd>
722 <table class="params">
723 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
724 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>event bits to wait for. </td></tr>
725 <tr><td class="paramdir">[in]</td><td class="paramname">xTimeoutOccurred</td><td>timeout value.</td></tr>
729 <p>The event <b>EventGroupWaitBitsEnd</b> is generated before the function xEventGroupWaitBits returns.</p>
730 <p><b>Value</b> in the Event Recorder shows:</p><ul>
731 <li><b>pxEventGroup</b> : pointer to Event Groups object handle (control block address)</li>
732 <li><b>uxBitsToWaitFor</b> : event bits to wait for.</li>
733 <li><b>xTimeoutOccurred</b> : timeout value (0=timeout occurred, 1=no timeout) </li>
738 <a id="ga981a4d28efe77e50c4094b1afce30193" name="ga981a4d28efe77e50c4094b1afce30193"></a>
739 <h2 class="memtitle"><span class="permalink"><a href="#ga981a4d28efe77e50c4094b1afce30193">◆ </a></span>EvrFreeRTOSEventGroups_uxEventGroupGetNumber()</h2>
741 <div class="memitem">
742 <div class="memproto">
743 <table class="mlabels">
745 <td class="mlabels-left">
746 <table class="memname">
748 <td class="memname">void EvrFreeRTOSEventGroups_uxEventGroupGetNumber </td>
750 <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span></td><td>)</td>
755 <td class="mlabels-right">
756 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
759 </div><div class="memdoc">
761 <p>Event sent when function uxEventGroupGetNumber is called (API). </p>
762 <dl class="params"><dt>Parameters</dt><dd>
763 <table class="params">
764 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
768 <p>The event <b>uxEventGroupGetNumber</b> is generated when function uxEventGroupGetNumber is called.</p>
769 <p><b>Value</b> in the Event Recorder shows:</p><ul>
770 <li><b>xEventGroup</b> : pointer to Event Groups object handle. </li>
775 <a id="gad7e41d55a6a5869e387ca2a00a42bf75" name="gad7e41d55a6a5869e387ca2a00a42bf75"></a>
776 <h2 class="memtitle"><span class="permalink"><a href="#gad7e41d55a6a5869e387ca2a00a42bf75">◆ </a></span>EvrFreeRTOSEventGroups_uxEventGroupGetNumber_Return()</h2>
778 <div class="memitem">
779 <div class="memproto">
780 <table class="mlabels">
782 <td class="mlabels-left">
783 <table class="memname">
785 <td class="memname">void EvrFreeRTOSEventGroups_uxEventGroupGetNumber_Return </td>
787 <td class="paramtype">UBaseType_t</td> <td class="paramname"><span class="paramname"><em>xReturn</em></span></td><td>)</td>
792 <td class="mlabels-right">
793 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
796 </div><div class="memdoc">
798 <p>Event sent before function uxEventGroupGetNumber returns (Op). </p>
799 <dl class="params"><dt>Parameters</dt><dd>
800 <table class="params">
801 <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>Event Groups object number.</td></tr>
805 <p>The event <b>uxEventGroupGetNumber_Return</b> is generated before function uxEventGroupGetNumber returns.</p>
806 <p><b>Value</b> in the Event Recorder shows:</p><ul>
807 <li><b>xReturn</b> : Event Groups object number. </li>
812 <a id="ga3aa3e61a3ddc4dcbedc52012508130f6" name="ga3aa3e61a3ddc4dcbedc52012508130f6"></a>
813 <h2 class="memtitle"><span class="permalink"><a href="#ga3aa3e61a3ddc4dcbedc52012508130f6">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback()</h2>
815 <div class="memitem">
816 <div class="memproto">
817 <table class="mlabels">
819 <td class="mlabels-left">
820 <table class="memname">
822 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback </td>
824 <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>pvEventGroup</em></span>, </td>
827 <td class="paramkey"></td>
829 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>ulBitsToClear</em></span> )</td>
833 <td class="mlabels-right">
834 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
837 </div><div class="memdoc">
839 <p>Event sent when function vEventGroupClearBitsCallback is called (API). </p>
840 <dl class="params"><dt>Parameters</dt><dd>
841 <table class="params">
842 <tr><td class="paramdir">[in]</td><td class="paramname">pvEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
843 <tr><td class="paramdir">[in]</td><td class="paramname">ulBitsToClear</td><td>bits to clear.</td></tr>
847 <p>The event <b>vEventGroupClearBitsCallback</b> is generated when function vEventGroupClearBitsCallback is called.</p>
848 <p><b>Value</b> in the Event Recorder shows:</p><ul>
849 <li><b>pvEventGroup</b> : pointer to Event Groups object handle.</li>
850 <li><b>ulBitsToClear</b> : bits to clear. </li>
855 <a id="ga4a886e2b82bc47882d843b5d2340633f" name="ga4a886e2b82bc47882d843b5d2340633f"></a>
856 <h2 class="memtitle"><span class="permalink"><a href="#ga4a886e2b82bc47882d843b5d2340633f">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback_Return()</h2>
858 <div class="memitem">
859 <div class="memproto">
860 <table class="mlabels">
862 <td class="mlabels-left">
863 <table class="memname">
865 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback_Return </td>
867 <td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
872 <td class="mlabels-right">
873 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
876 </div><div class="memdoc">
878 <p>Event sent before function vEventGroupClearBitsCallback returns (Op). </p>
879 <p>The event <b>vEventGroupClearBitsCallback_Return</b> is generated before function vEventGroupClearBitsCallback returns.</p>
880 <p><b>Value</b> in the Event Recorder shows:</p><ul>
881 <li><b>no</b> value shown </li>
886 <a id="gac43f8f6a7f35d2b03053bbfed1788016" name="gac43f8f6a7f35d2b03053bbfed1788016"></a>
887 <h2 class="memtitle"><span class="permalink"><a href="#gac43f8f6a7f35d2b03053bbfed1788016">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupDelete()</h2>
889 <div class="memitem">
890 <div class="memproto">
891 <table class="mlabels">
893 <td class="mlabels-left">
894 <table class="memname">
896 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupDelete </td>
898 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span></td><td>)</td>
903 <td class="mlabels-right">
904 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
907 </div><div class="memdoc">
909 <p>Event sent when function vEventGroupDelete is called (API). </p>
910 <dl class="params"><dt>Parameters</dt><dd>
911 <table class="params">
912 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
916 <p>The event <b>vEventGroupDelete</b> is generated when function vEventGroupDelete is called.</p>
917 <p><b>Value</b> in the Event Recorder shows:</p><ul>
918 <li><b>xEventGroup</b> : pointer to Event Groups object handle. </li>
923 <a id="gab0b80a23584e36bc765a5264b879613c" name="gab0b80a23584e36bc765a5264b879613c"></a>
924 <h2 class="memtitle"><span class="permalink"><a href="#gab0b80a23584e36bc765a5264b879613c">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupDelete_Return()</h2>
926 <div class="memitem">
927 <div class="memproto">
928 <table class="mlabels">
930 <td class="mlabels-left">
931 <table class="memname">
933 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupDelete_Return </td>
935 <td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
940 <td class="mlabels-right">
941 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
944 </div><div class="memdoc">
946 <p>Event sent before function vEventGroupDelete returns (Op). </p>
947 <p>The event <b>vEventGroupDelete_Return</b> is generated before function vEventGroupDelete returns.</p>
948 <p><b>Value</b> in the Event Recorder shows:</p><ul>
949 <li><b>no</b> value shown </li>
954 <a id="gaed98e5c1e15aba07b1330db347bd70be" name="gaed98e5c1e15aba07b1330db347bd70be"></a>
955 <h2 class="memtitle"><span class="permalink"><a href="#gaed98e5c1e15aba07b1330db347bd70be">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback()</h2>
957 <div class="memitem">
958 <div class="memproto">
959 <table class="mlabels">
961 <td class="mlabels-left">
962 <table class="memname">
964 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback </td>
966 <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>pvEventGroup</em></span>, </td>
969 <td class="paramkey"></td>
971 <td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>ulBitsToSet</em></span> )</td>
975 <td class="mlabels-right">
976 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
979 </div><div class="memdoc">
981 <p>Event sent when function vEventGroupSetBitsCallback is called (API). </p>
982 <dl class="params"><dt>Parameters</dt><dd>
983 <table class="params">
984 <tr><td class="paramdir">[in]</td><td class="paramname">pvEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
985 <tr><td class="paramdir">[in]</td><td class="paramname">ulBitsToSet</td><td>bits to set.</td></tr>
989 <p>The event <b>vEventGroupSetBitsCallback</b> is generated when function vEventGroupSetBitsCallback is called.</p>
990 <p><b>Value</b> in the Event Recorder shows:</p><ul>
991 <li><b>pvEventGroup</b> : pointer to Event Groups object handle.</li>
992 <li><b>ulBitsToSet</b> : bits to set. </li>
997 <a id="ga9915ab21949e80c30359065dbc117d74" name="ga9915ab21949e80c30359065dbc117d74"></a>
998 <h2 class="memtitle"><span class="permalink"><a href="#ga9915ab21949e80c30359065dbc117d74">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback_Return()</h2>
1000 <div class="memitem">
1001 <div class="memproto">
1002 <table class="mlabels">
1004 <td class="mlabels-left">
1005 <table class="memname">
1007 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback_Return </td>
1009 <td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
1014 <td class="mlabels-right">
1015 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1018 </div><div class="memdoc">
1020 <p>Event sent before function vEventGroupSetBitsCallback returns (Op). </p>
1021 <p>The event <b>vEventGroupSetBitsCallback_Return</b> is generated before function vEventGroupSetBitsCallback returns.</p>
1022 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1023 <li><b>no</b> value shown </li>
1028 <a id="ga0aa02578d0ef9a6ecd4be3557e53ba77" name="ga0aa02578d0ef9a6ecd4be3557e53ba77"></a>
1029 <h2 class="memtitle"><span class="permalink"><a href="#ga0aa02578d0ef9a6ecd4be3557e53ba77">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupSetNumber()</h2>
1031 <div class="memitem">
1032 <div class="memproto">
1033 <table class="mlabels">
1035 <td class="mlabels-left">
1036 <table class="memname">
1038 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupSetNumber </td>
1040 <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span>, </td>
1043 <td class="paramkey"></td>
1045 <td class="paramtype">UBaseType_t</td> <td class="paramname"><span class="paramname"><em>uxEventGroupNumber</em></span> )</td>
1049 <td class="mlabels-right">
1050 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1053 </div><div class="memdoc">
1055 <p>Event sent when function vEventGroupSetNumber is called (API). </p>
1056 <dl class="params"><dt>Parameters</dt><dd>
1057 <table class="params">
1058 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
1059 <tr><td class="paramdir">[in]</td><td class="paramname">uxEventGroupNumber</td><td>number to assign to the Event Groups object.</td></tr>
1063 <p>The event <b>vEventGroupSetNumber</b> is generated when function vEventGroupSetNumber is called.</p>
1064 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1065 <li><b>xEventGroup</b> : pointer to Event Groups object handle.</li>
1066 <li><b>uxEventGroupNumber</b> : number to assign to the Event Groups object. </li>
1071 <a id="ga2257190eb3bfc6adba1b2aa30c21d56d" name="ga2257190eb3bfc6adba1b2aa30c21d56d"></a>
1072 <h2 class="memtitle"><span class="permalink"><a href="#ga2257190eb3bfc6adba1b2aa30c21d56d">◆ </a></span>EvrFreeRTOSEventGroups_vEventGroupSetNumber_Return()</h2>
1074 <div class="memitem">
1075 <div class="memproto">
1076 <table class="mlabels">
1078 <td class="mlabels-left">
1079 <table class="memname">
1081 <td class="memname">void EvrFreeRTOSEventGroups_vEventGroupSetNumber_Return </td>
1083 <td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
1088 <td class="mlabels-right">
1089 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1092 </div><div class="memdoc">
1094 <p>Event sent before function vEventGroupSetNumber returns (Op). </p>
1095 <p>The event <b>vEventGroupSetNumber_Return</b> is generated before function vEventGroupSetNumber returns.</p>
1096 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1097 <li><b>no</b> value shown </li>
1102 <a id="ga77dbf2f89414189d49519ed49e55e7f1" name="ga77dbf2f89414189d49519ed49e55e7f1"></a>
1103 <h2 class="memtitle"><span class="permalink"><a href="#ga77dbf2f89414189d49519ed49e55e7f1">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupClearBits()</h2>
1105 <div class="memitem">
1106 <div class="memproto">
1107 <table class="mlabels">
1109 <td class="mlabels-left">
1110 <table class="memname">
1112 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupClearBits </td>
1114 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span>, </td>
1117 <td class="paramkey"></td>
1119 <td class="paramtype">const EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToClear</em></span> )</td>
1123 <td class="mlabels-right">
1124 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1127 </div><div class="memdoc">
1129 <p>Event sent when function xEventGroupClearBits is called (API). </p>
1130 <dl class="params"><dt>Parameters</dt><dd>
1131 <table class="params">
1132 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
1133 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToClear</td><td>the bits to clear.</td></tr>
1137 <p>The event <b>xEventGroupClearBits</b> is generated when function xEventGroupClearBits is called.</p>
1138 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1139 <li><b>xEventGroup</b> : pointer to Event Groups object handle.</li>
1140 <li><b>uxBitsToClear</b> : the bits to clear. </li>
1145 <a id="gadd3bf4a3a915db57344b1fff31afaa37" name="gadd3bf4a3a915db57344b1fff31afaa37"></a>
1146 <h2 class="memtitle"><span class="permalink"><a href="#gadd3bf4a3a915db57344b1fff31afaa37">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupClearBits_Return()</h2>
1148 <div class="memitem">
1149 <div class="memproto">
1150 <table class="mlabels">
1152 <td class="mlabels-left">
1153 <table class="memname">
1155 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupClearBits_Return </td>
1157 <td class="paramtype">EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxReturn</em></span></td><td>)</td>
1162 <td class="mlabels-right">
1163 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1166 </div><div class="memdoc">
1168 <p>Event sent before function xEventGroupClearBits returns (Op). </p>
1169 <dl class="params"><dt>Parameters</dt><dd>
1170 <table class="params">
1171 <tr><td class="paramdir">[in]</td><td class="paramname">uxReturn</td><td>the bits before clearing.</td></tr>
1175 <p>The event <b>xEventGroupClearBits_Return</b> is generated before function xEventGroupClearBits returns.</p>
1176 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1177 <li><b>uxReturn</b> : the bits before clearing. </li>
1182 <a id="ga62f545cdee5ae708597611ba8cbd6cf2" name="ga62f545cdee5ae708597611ba8cbd6cf2"></a>
1183 <h2 class="memtitle"><span class="permalink"><a href="#ga62f545cdee5ae708597611ba8cbd6cf2">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR()</h2>
1185 <div class="memitem">
1186 <div class="memproto">
1187 <table class="mlabels">
1189 <td class="mlabels-left">
1190 <table class="memname">
1192 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR </td>
1194 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span>, </td>
1197 <td class="paramkey"></td>
1199 <td class="paramtype">const EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToClear</em></span> )</td>
1203 <td class="mlabels-right">
1204 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1207 </div><div class="memdoc">
1209 <p>Event sent when function xEventGroupClearBitsFromISR is called (API). </p>
1210 <dl class="params"><dt>Parameters</dt><dd>
1211 <table class="params">
1212 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
1213 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToClear</td><td>the bits to clear.</td></tr>
1217 <p>The event <b>xEventGroupClearBitsFromISR</b> is generated when function xEventGroupClearBitsFromISR is called.</p>
1218 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1219 <li><b>xEventGroup</b> : pointer to Event Groups object handle.</li>
1220 <li><b>uxBitsToClear</b> : the bits to clear. </li>
1225 <a id="gaa8754ceedaaf53a50bcb397cdfe106aa" name="gaa8754ceedaaf53a50bcb397cdfe106aa"></a>
1226 <h2 class="memtitle"><span class="permalink"><a href="#gaa8754ceedaaf53a50bcb397cdfe106aa">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR_Return()</h2>
1228 <div class="memitem">
1229 <div class="memproto">
1230 <table class="mlabels">
1232 <td class="mlabels-left">
1233 <table class="memname">
1235 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR_Return </td>
1237 <td class="paramtype">BaseType_t</td> <td class="paramname"><span class="paramname"><em>xReturn</em></span></td><td>)</td>
1242 <td class="mlabels-right">
1243 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1246 </div><div class="memdoc">
1248 <p>Event sent before function xEventGroupClearBitsFromISR returns (Op). </p>
1249 <dl class="params"><dt>Parameters</dt><dd>
1250 <table class="params">
1251 <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>execution status.</td></tr>
1255 <p>The event <b>xEventGroupClearBitsFromISR_Return</b> is generated before function xEventGroupClearBitsFromISR returns.</p>
1256 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1257 <li><b>xReturn</b> : execution status. </li>
1262 <a id="ga74e191440844cc703e85ab372ea2d622" name="ga74e191440844cc703e85ab372ea2d622"></a>
1263 <h2 class="memtitle"><span class="permalink"><a href="#ga74e191440844cc703e85ab372ea2d622">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupCreate()</h2>
1265 <div class="memitem">
1266 <div class="memproto">
1267 <table class="mlabels">
1269 <td class="mlabels-left">
1270 <table class="memname">
1272 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupCreate </td>
1274 <td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
1279 <td class="mlabels-right">
1280 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1283 </div><div class="memdoc">
1285 <p>Event sent when function xEventGroupCreate is called (API). </p>
1286 <p>The event <b>is</b> generated when function xEventGroupCreate is called.</p>
1287 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1288 <li><b>no</b> value shown </li>
1293 <a id="ga0e7d1852b3050563e1a4c7adb816a08b" name="ga0e7d1852b3050563e1a4c7adb816a08b"></a>
1294 <h2 class="memtitle"><span class="permalink"><a href="#ga0e7d1852b3050563e1a4c7adb816a08b">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupCreate_Return()</h2>
1296 <div class="memitem">
1297 <div class="memproto">
1298 <table class="mlabels">
1300 <td class="mlabels-left">
1301 <table class="memname">
1303 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupCreate_Return </td>
1305 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span></td><td>)</td>
1310 <td class="mlabels-right">
1311 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1314 </div><div class="memdoc">
1316 <p>Event sent before function xEventGroupCreate returns (Op). </p>
1317 <dl class="params"><dt>Parameters</dt><dd>
1318 <table class="params">
1319 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
1323 <p>The event <b>xEventGroupCreate_Return</b> is generated before function xEventGroupCreate returns.</p>
1324 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1325 <li><b>xEventGroup</b> : pointer to Event Groups object handle. </li>
1330 <a id="ga12e4d5f13d6290eab6b4f650a72abd77" name="ga12e4d5f13d6290eab6b4f650a72abd77"></a>
1331 <h2 class="memtitle"><span class="permalink"><a href="#ga12e4d5f13d6290eab6b4f650a72abd77">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupCreateStatic()</h2>
1333 <div class="memitem">
1334 <div class="memproto">
1335 <table class="mlabels">
1337 <td class="mlabels-left">
1338 <table class="memname">
1340 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupCreateStatic </td>
1342 <td class="paramtype">StaticEventGroup_t *</td> <td class="paramname"><span class="paramname"><em>pxEventGroupBuffer</em></span></td><td>)</td>
1347 <td class="mlabels-right">
1348 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1351 </div><div class="memdoc">
1353 <p>Event sent when function xEventGroupCreateStatic is called (API). </p>
1354 <dl class="params"><dt>Parameters</dt><dd>
1355 <table class="params">
1356 <tr><td class="paramdir">[in]</td><td class="paramname">pxEventGroupBuffer</td><td>pointer to Event Groups data structure.</td></tr>
1360 <p>The event <b>xEventGroupCreateStatic</b> is generated when function xEventGroupCreateStatic is called.</p>
1361 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1362 <li><b>pxEventGroupBuffer</b> : pointer to Event Groups data structure. </li>
1367 <a id="ga6c7ba5eeaea299fef9830874d93dc577" name="ga6c7ba5eeaea299fef9830874d93dc577"></a>
1368 <h2 class="memtitle"><span class="permalink"><a href="#ga6c7ba5eeaea299fef9830874d93dc577">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupCreateStatic_Return()</h2>
1370 <div class="memitem">
1371 <div class="memproto">
1372 <table class="mlabels">
1374 <td class="mlabels-left">
1375 <table class="memname">
1377 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupCreateStatic_Return </td>
1379 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span></td><td>)</td>
1384 <td class="mlabels-right">
1385 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1388 </div><div class="memdoc">
1390 <p>Event sent before function xEventGroupCreateStatic returns (Op). </p>
1391 <dl class="params"><dt>Parameters</dt><dd>
1392 <table class="params">
1393 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
1397 <p>The event <b>xEventGroupCreateStatic_Return</b> is generated before function xEventGroupCreateStatic returns.</p>
1398 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1399 <li><b>xEventGroup</b> : pointer to Event Groups object handle. </li>
1404 <a id="ga93d44c94e8921b19bc3aae63663b5858" name="ga93d44c94e8921b19bc3aae63663b5858"></a>
1405 <h2 class="memtitle"><span class="permalink"><a href="#ga93d44c94e8921b19bc3aae63663b5858">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR()</h2>
1407 <div class="memitem">
1408 <div class="memproto">
1409 <table class="mlabels">
1411 <td class="mlabels-left">
1412 <table class="memname">
1414 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR </td>
1416 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span></td><td>)</td>
1421 <td class="mlabels-right">
1422 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1425 </div><div class="memdoc">
1427 <p>Event sent when function xEventGroupGetBitsFromISR is called (API). </p>
1428 <dl class="params"><dt>Parameters</dt><dd>
1429 <table class="params">
1430 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle.</td></tr>
1434 <p>The event <b>xEventGroupGetBitsFromISR</b> is generated when function xEventGroupGetBitsFromISR is called.</p>
1435 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1436 <li><b>xEventGroup</b> : pointer to Event Groups object handle. </li>
1441 <a id="gaa1440d808c439ab6f20e189b001ee339" name="gaa1440d808c439ab6f20e189b001ee339"></a>
1442 <h2 class="memtitle"><span class="permalink"><a href="#gaa1440d808c439ab6f20e189b001ee339">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR_Return()</h2>
1444 <div class="memitem">
1445 <div class="memproto">
1446 <table class="mlabels">
1448 <td class="mlabels-left">
1449 <table class="memname">
1451 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR_Return </td>
1453 <td class="paramtype">EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxReturn</em></span></td><td>)</td>
1458 <td class="mlabels-right">
1459 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1462 </div><div class="memdoc">
1464 <p>Event sent before function xEventGroupGetBitsFromISR returns (Op). </p>
1465 <dl class="params"><dt>Parameters</dt><dd>
1466 <table class="params">
1467 <tr><td class="paramdir">[in]</td><td class="paramname">uxReturn</td><td>the set bits.</td></tr>
1471 <p>The event <b>xEventGroupGetBitsFromISR_Return</b> is generated before function xEventGroupGetBitsFromISR returns.</p>
1472 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1473 <li><b>uxReturn</b> : the set bits. </li>
1478 <a id="ga7735898508e6aa707e9f32fb739fa177" name="ga7735898508e6aa707e9f32fb739fa177"></a>
1479 <h2 class="memtitle"><span class="permalink"><a href="#ga7735898508e6aa707e9f32fb739fa177">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupGetStaticBuffer_Return()</h2>
1481 <div class="memitem">
1482 <div class="memproto">
1483 <table class="mlabels">
1485 <td class="mlabels-left">
1486 <table class="memname">
1488 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupGetStaticBuffer_Return </td>
1490 <td class="paramtype">BaseType_t</td> <td class="paramname"><span class="paramname"><em>xReturn</em></span></td><td>)</td>
1495 <td class="mlabels-right">
1496 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1499 </div><div class="memdoc">
1501 <p>Event sent before function xEventGroupGetStaticBuffer returns (Op). </p>
1502 <dl class="params"><dt>Parameters</dt><dd>
1503 <table class="params">
1504 <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>execution status.</td></tr>
1508 <p>The event <b>xEventGroupGetStaticBuffer_Return</b> is generated before function xEventGroupGetStaticBuffer returns.</p>
1509 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1510 <li><b>xReturn</b> : execution status. </li>
1515 <a id="ga5346c4371cc8b4e5e8ad903591b40274" name="ga5346c4371cc8b4e5e8ad903591b40274"></a>
1516 <h2 class="memtitle"><span class="permalink"><a href="#ga5346c4371cc8b4e5e8ad903591b40274">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupSetBits()</h2>
1518 <div class="memitem">
1519 <div class="memproto">
1520 <table class="mlabels">
1522 <td class="mlabels-left">
1523 <table class="memname">
1525 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupSetBits </td>
1527 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span>, </td>
1530 <td class="paramkey"></td>
1532 <td class="paramtype">const EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToSet</em></span> )</td>
1536 <td class="mlabels-right">
1537 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1540 </div><div class="memdoc">
1542 <p>Event sent when function xEventGroupSetBits is called (API). </p>
1543 <dl class="params"><dt>Parameters</dt><dd>
1544 <table class="params">
1545 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
1546 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>the bits to set.</td></tr>
1550 <p>The event <b>xEventGroupSetBits</b> is generated when function xEventGroupSetBits is called.</p>
1551 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1552 <li><b>xEventGroup</b> : pointer to Event Groups object handle.</li>
1553 <li><b>uxBitsToSet</b> : the bits to set. </li>
1558 <a id="gad20a588b0115600cb6c21f8854c8ed9f" name="gad20a588b0115600cb6c21f8854c8ed9f"></a>
1559 <h2 class="memtitle"><span class="permalink"><a href="#gad20a588b0115600cb6c21f8854c8ed9f">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupSetBits_Return()</h2>
1561 <div class="memitem">
1562 <div class="memproto">
1563 <table class="mlabels">
1565 <td class="mlabels-left">
1566 <table class="memname">
1568 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupSetBits_Return </td>
1570 <td class="paramtype">EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxReturn</em></span></td><td>)</td>
1575 <td class="mlabels-right">
1576 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1579 </div><div class="memdoc">
1581 <p>Event sent before function xEventGroupSetBits returns (Op). </p>
1582 <dl class="params"><dt>Parameters</dt><dd>
1583 <table class="params">
1584 <tr><td class="paramdir">[in]</td><td class="paramname">uxReturn</td><td>the bits set at the time function returns.</td></tr>
1588 <p>The event <b>xEventGroupSetBits_Return</b> is generated before function xEventGroupSetBits returns.</p>
1589 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1590 <li><b>uxReturn</b> : the bits set at the time function returns. </li>
1595 <a id="gacfd57b185c8e998a9d73fd05e6219e7f" name="gacfd57b185c8e998a9d73fd05e6219e7f"></a>
1596 <h2 class="memtitle"><span class="permalink"><a href="#gacfd57b185c8e998a9d73fd05e6219e7f">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR()</h2>
1598 <div class="memitem">
1599 <div class="memproto">
1600 <table class="mlabels">
1602 <td class="mlabels-left">
1603 <table class="memname">
1605 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR </td>
1607 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span>, </td>
1610 <td class="paramkey"></td>
1612 <td class="paramtype">const EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToSet</em></span>, </td>
1615 <td class="paramkey"></td>
1617 <td class="paramtype">BaseType_t *</td> <td class="paramname"><span class="paramname"><em>pxHigherPriorityTaskWoken</em></span> )</td>
1621 <td class="mlabels-right">
1622 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1625 </div><div class="memdoc">
1627 <p>Event sent when function xEventGroupSetBitsFromISR is called (API). </p>
1628 <dl class="params"><dt>Parameters</dt><dd>
1629 <table class="params">
1630 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
1631 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>bits to set </td></tr>
1632 <tr><td class="paramdir">[in]</td><td class="paramname">pxHigherPriorityTaskWoken</td><td>pointer to variable where information if any task was woken will be stored.</td></tr>
1636 <p>The event <b>xEventGroupSetBitsFromISR</b> is generated when function xEventGroupSetBitsFromISR is called.</p>
1637 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1638 <li><b>xEventGroup</b> : pointer to Event Groups object handle.</li>
1639 <li><b>uxBitsToSet</b> : bits to set</li>
1640 <li><b>pxHigherPriorityTaskWoken</b> : pointer to variable where information if any task was woken will be stored. </li>
1645 <a id="ga4b5f601b8d143b2047e15f2db8c34f96" name="ga4b5f601b8d143b2047e15f2db8c34f96"></a>
1646 <h2 class="memtitle"><span class="permalink"><a href="#ga4b5f601b8d143b2047e15f2db8c34f96">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR_Return()</h2>
1648 <div class="memitem">
1649 <div class="memproto">
1650 <table class="mlabels">
1652 <td class="mlabels-left">
1653 <table class="memname">
1655 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR_Return </td>
1657 <td class="paramtype">BaseType_t</td> <td class="paramname"><span class="paramname"><em>xReturn</em></span></td><td>)</td>
1662 <td class="mlabels-right">
1663 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1666 </div><div class="memdoc">
1668 <p>Event sent before function xEventGroupSetBitsFromISR returns (Op). </p>
1669 <dl class="params"><dt>Parameters</dt><dd>
1670 <table class="params">
1671 <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>execution status.</td></tr>
1675 <p>The event <b>xEventGroupSetBitsFromISR_Return</b> is generated before function xEventGroupSetBitsFromISR returns.</p>
1676 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1677 <li><b>xReturn</b> : execution status. </li>
1682 <a id="ga726bd52b8e51149123b7343fde53902b" name="ga726bd52b8e51149123b7343fde53902b"></a>
1683 <h2 class="memtitle"><span class="permalink"><a href="#ga726bd52b8e51149123b7343fde53902b">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupSync()</h2>
1685 <div class="memitem">
1686 <div class="memproto">
1687 <table class="mlabels">
1689 <td class="mlabels-left">
1690 <table class="memname">
1692 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupSync </td>
1694 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span>, </td>
1697 <td class="paramkey"></td>
1699 <td class="paramtype">const EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToSet</em></span>, </td>
1702 <td class="paramkey"></td>
1704 <td class="paramtype">const EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToWaitFor</em></span>, </td>
1707 <td class="paramkey"></td>
1709 <td class="paramtype">TickType_t</td> <td class="paramname"><span class="paramname"><em>xTicksToWait</em></span> )</td>
1713 <td class="mlabels-right">
1714 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1717 </div><div class="memdoc">
1719 <p>Event sent when function xEventGroupSync is called (API). </p>
1720 <dl class="params"><dt>Parameters</dt><dd>
1721 <table class="params">
1722 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
1723 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToSet</td><td>bits to set in the Event Group before waiting. </td></tr>
1724 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>bits to wait for. </td></tr>
1725 <tr><td class="paramdir">[in]</td><td class="paramname">xTicksToWait</td><td>amount of time to wait for.</td></tr>
1729 <p>The event <b>xEventGroupSync</b> is generated when function xEventGroupSync is called.</p>
1730 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1731 <li><b>xEventGroup</b> : pointer to Event Groups object handle.</li>
1732 <li><b>uxBitsToSet</b> : bits to set in the Event Group before waiting.</li>
1733 <li><b>uxBitsToWaitFor</b> : bits to wait for.</li>
1734 <li><b>xTicksToWait</b> : amount of time to wait for. </li>
1739 <a id="ga72e2aa2beff00813a21cc4a98713e1e5" name="ga72e2aa2beff00813a21cc4a98713e1e5"></a>
1740 <h2 class="memtitle"><span class="permalink"><a href="#ga72e2aa2beff00813a21cc4a98713e1e5">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupSync_Return()</h2>
1742 <div class="memitem">
1743 <div class="memproto">
1744 <table class="mlabels">
1746 <td class="mlabels-left">
1747 <table class="memname">
1749 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupSync_Return </td>
1751 <td class="paramtype">EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxReturn</em></span></td><td>)</td>
1756 <td class="mlabels-right">
1757 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1760 </div><div class="memdoc">
1762 <p>Event sent before function xEventGroupSync returns (Op). </p>
1763 <dl class="params"><dt>Parameters</dt><dd>
1764 <table class="params">
1765 <tr><td class="paramdir">[in]</td><td class="paramname">uxReturn</td><td>the bits after wait or when block time expired.</td></tr>
1769 <p>The event <b>xEventGroupSync_Return</b> is generated before function xEventGroupSync returns.</p>
1770 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1771 <li><b>uxReturn</b> : the bits after wait or when block time expired. </li>
1776 <a id="ga128de0e7a319f92a226b60b31c139391" name="ga128de0e7a319f92a226b60b31c139391"></a>
1777 <h2 class="memtitle"><span class="permalink"><a href="#ga128de0e7a319f92a226b60b31c139391">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupWaitBits()</h2>
1779 <div class="memitem">
1780 <div class="memproto">
1781 <table class="mlabels">
1783 <td class="mlabels-left">
1784 <table class="memname">
1786 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupWaitBits </td>
1788 <td class="paramtype">EventGroupHandle_t</td> <td class="paramname"><span class="paramname"><em>xEventGroup</em></span>, </td>
1791 <td class="paramkey"></td>
1793 <td class="paramtype">const EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxBitsToWaitFor</em></span>, </td>
1796 <td class="paramkey"></td>
1798 <td class="paramtype">const BaseType_t</td> <td class="paramname"><span class="paramname"><em>xClearOnExit</em></span>, </td>
1801 <td class="paramkey"></td>
1803 <td class="paramtype">const BaseType_t</td> <td class="paramname"><span class="paramname"><em>xWaitForAllBits</em></span>, </td>
1806 <td class="paramkey"></td>
1808 <td class="paramtype">TickType_t</td> <td class="paramname"><span class="paramname"><em>xTicksToWait</em></span> )</td>
1812 <td class="mlabels-right">
1813 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1816 </div><div class="memdoc">
1818 <p>Event sent when function xEventGroupWaitBits is called (API). </p>
1819 <dl class="params"><dt>Parameters</dt><dd>
1820 <table class="params">
1821 <tr><td class="paramdir">[in]</td><td class="paramname">xEventGroup</td><td>pointer to Event Groups object handle. </td></tr>
1822 <tr><td class="paramdir">[in]</td><td class="paramname">uxBitsToWaitFor</td><td>the bits to wait for. </td></tr>
1823 <tr><td class="paramdir">[in]</td><td class="paramname">xClearOnExit</td><td>specifies if the bits are cleared on exit. </td></tr>
1824 <tr><td class="paramdir">[in]</td><td class="paramname">xWaitForAllBits</td><td>specified if function waits until all bits are set. </td></tr>
1825 <tr><td class="paramdir">[in]</td><td class="paramname">xTicksToWait</td><td>amount of time to wait for.</td></tr>
1829 <p>The event <b>xEventGroupWaitBits</b> is generated when function xEventGroupWaitBits is called.</p>
1830 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1831 <li><b>xEventGroup</b> : pointer to Event Groups object handle.</li>
1832 <li><b>uxBitsToWaitFor</b> : the bits to wait for.</li>
1833 <li><b>xClearOnExit</b> : specifies if the bits are cleared on exit.</li>
1834 <li><b>xWaitForAllBits</b> : specified if function waits until all bits are set.</li>
1835 <li><b>xTicksToWait</b> : amount of time to wait for. </li>
1840 <a id="ga9c082026bb0b7a95733ec22a3af3bee4" name="ga9c082026bb0b7a95733ec22a3af3bee4"></a>
1841 <h2 class="memtitle"><span class="permalink"><a href="#ga9c082026bb0b7a95733ec22a3af3bee4">◆ </a></span>EvrFreeRTOSEventGroups_xEventGroupWaitBits_Return()</h2>
1843 <div class="memitem">
1844 <div class="memproto">
1845 <table class="mlabels">
1847 <td class="mlabels-left">
1848 <table class="memname">
1850 <td class="memname">void EvrFreeRTOSEventGroups_xEventGroupWaitBits_Return </td>
1852 <td class="paramtype">EventBits_t</td> <td class="paramname"><span class="paramname"><em>uxReturn</em></span></td><td>)</td>
1857 <td class="mlabels-right">
1858 <span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
1861 </div><div class="memdoc">
1863 <p>Event sent before function xEventGroupWaitBits returns (Op). </p>
1864 <dl class="params"><dt>Parameters</dt><dd>
1865 <table class="params">
1866 <tr><td class="paramdir">[in]</td><td class="paramname">uxReturn</td><td>the bits after wait or when block time expired.</td></tr>
1870 <p>The event <b>xEventGroupWaitBits</b> is generated before function xEventGroupWaitBits returns.</p>
1871 <p><b>Value</b> in the Event Recorder shows:</p><ul>
1872 <li><b>uxReturn</b> : the bits after wait or when block time expired. </li>
1877 </div><!-- contents -->
1878 </div><!-- doc-content -->
1879 <!-- start footer part -->
1880 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1883 <script type="text/javascript">
1885 writeFooter.call(this);