MCB1700_Welcome/Doxygen/html/event__groups_8h.html

629 lines
38 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Labor04: event_groups.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Labor04
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('event__groups_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">event_groups.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="timers_8h_source.html">timers.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for event_groups.h:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h__incl.png" border="0" usemap="#aevent__groups_8h" alt=""/></div>
<map name="event__groups_8h" id="aevent__groups_8h">
<area shape="rect" title=" " alt="" coords="5,5,116,32"/>
<area shape="rect" href="timers_8h.html" title=" " alt="" coords="26,80,95,107"/>
<area shape="rect" href="task_8h.html" title=" " alt="" coords="31,155,90,181"/>
<area shape="rect" href="list_8h.html" title=" " alt="" coords="35,229,86,256"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h__dep__incl.png" border="0" usemap="#aevent__groups_8hdep" alt=""/></div>
<map name="event__groups_8hdep" id="aevent__groups_8hdep">
<area shape="rect" title=" " alt="" coords="5,5,116,32"/>
<area shape="rect" href="event__groups_8c.html" title=" " alt="" coords="5,80,116,107"/>
</map>
</div>
</div>
<p><a href="event__groups_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3d7de214a697f33fe7b914e26a93f33a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a3d7de214a697f33fe7b914e26a93f33a">xEventGroupClearBitsFromISR</a>(xEventGroup, uxBitsToClear)&#160;&#160;&#160;<a class="el" href="timers_8h.html#ae0d9338933037e6feebe6437763fa299">xTimerPendFunctionCallFromISR</a>( <a class="el" href="event__groups_8h.html#a9187a137998183178320167de254cce9">vEventGroupClearBitsCallback</a>, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )</td></tr>
<tr class="separator:a3d7de214a697f33fe7b914e26a93f33a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62b68278abac6358369ae8e390988a02"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a62b68278abac6358369ae8e390988a02">xEventGroupSetBitsFromISR</a>(xEventGroup, uxBitsToSet, pxHigherPriorityTaskWoken)&#160;&#160;&#160;<a class="el" href="timers_8h.html#ae0d9338933037e6feebe6437763fa299">xTimerPendFunctionCallFromISR</a>( <a class="el" href="event__groups_8h.html#abe76a301815525eb5e03f331e5e51ae3">vEventGroupSetBitsCallback</a>, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )</td></tr>
<tr class="separator:a62b68278abac6358369ae8e390988a02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ae86f092fb07ccb475ae938f9a12584"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a0ae86f092fb07ccb475ae938f9a12584">xEventGroupGetBits</a>(xEventGroup)&#160;&#160;&#160;<a class="el" href="event__groups_8h.html#a0fb72cfdd4f0d5f86d955fc3af448f2a">xEventGroupClearBits</a>( xEventGroup, 0 )</td></tr>
<tr class="separator:a0ae86f092fb07ccb475ae938f9a12584"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a5119294106541c4eca46e8742fdb4e85"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a></td></tr>
<tr class="separator:a5119294106541c4eca46e8742fdb4e85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2f21b93db0b2a0ab64d7a81ff32ac2e"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="portmacro_8h.html#aa69c48c6e902ce54f70886e6573c92a9">TickType_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a></td></tr>
<tr class="separator:ab2f21b93db0b2a0ab64d7a81ff32ac2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aab9d5b405bc57b7624dcabe9a9a503db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#aab9d5b405bc57b7624dcabe9a9a503db">xEventGroupWaitBits</a> (<a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a> xEventGroup, const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> uxBitsToWaitFor, const <a class="el" href="portmacro_8h.html#a46fb21e00ae0729d7515c0fbf2269796">BaseType_t</a> xClearOnExit, const <a class="el" href="portmacro_8h.html#a46fb21e00ae0729d7515c0fbf2269796">BaseType_t</a> xWaitForAllBits, <a class="el" href="portmacro_8h.html#aa69c48c6e902ce54f70886e6573c92a9">TickType_t</a> xTicksToWait) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:aab9d5b405bc57b7624dcabe9a9a503db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fb72cfdd4f0d5f86d955fc3af448f2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a0fb72cfdd4f0d5f86d955fc3af448f2a">xEventGroupClearBits</a> (<a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a> xEventGroup, const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> uxBitsToClear) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:a0fb72cfdd4f0d5f86d955fc3af448f2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02d7b3bb55f7e11d9c47116266c5fb2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a02d7b3bb55f7e11d9c47116266c5fb2e">xEventGroupSetBits</a> (<a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a> xEventGroup, const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> uxBitsToSet) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:a02d7b3bb55f7e11d9c47116266c5fb2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a869511456b86426f52e2eec898bff341"><td class="memItemLeft" align="right" valign="top"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a869511456b86426f52e2eec898bff341">xEventGroupSync</a> (<a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a> xEventGroup, const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> uxBitsToSet, const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> uxBitsToWaitFor, <a class="el" href="portmacro_8h.html#aa69c48c6e902ce54f70886e6573c92a9">TickType_t</a> xTicksToWait) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:a869511456b86426f52e2eec898bff341"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95822db4357d0b77c35aed0c7427eca0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a95822db4357d0b77c35aed0c7427eca0">xEventGroupGetBitsFromISR</a> (<a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a> xEventGroup) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:a95822db4357d0b77c35aed0c7427eca0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50cb52d1c81b063fd8d94f5293dcfea9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a50cb52d1c81b063fd8d94f5293dcfea9">vEventGroupDelete</a> (<a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a> xEventGroup) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:a50cb52d1c81b063fd8d94f5293dcfea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe76a301815525eb5e03f331e5e51ae3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#abe76a301815525eb5e03f331e5e51ae3">vEventGroupSetBitsCallback</a> (void *pvEventGroup, const uint32_t ulBitsToSet) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:abe76a301815525eb5e03f331e5e51ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9187a137998183178320167de254cce9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event__groups_8h.html#a9187a137998183178320167de254cce9">vEventGroupClearBitsCallback</a> (void *pvEventGroup, const uint32_t ulBitsToClear) <a class="el" href="mpu__wrappers_8h.html#a4785c4f4a8c04b835139dcc2a6682078">PRIVILEGED_FUNCTION</a></td></tr>
<tr class="separator:a9187a137998183178320167de254cce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a3d7de214a697f33fe7b914e26a93f33a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d7de214a697f33fe7b914e26a93f33a">&#9670;&nbsp;</a></span>xEventGroupClearBitsFromISR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xEventGroupClearBitsFromISR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">xEventGroup, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">uxBitsToClear&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;<a class="el" href="timers_8h.html#ae0d9338933037e6feebe6437763fa299">xTimerPendFunctionCallFromISR</a>( <a class="el" href="event__groups_8h.html#a9187a137998183178320167de254cce9">vEventGroupClearBitsCallback</a>, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0ae86f092fb07ccb475ae938f9a12584"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ae86f092fb07ccb475ae938f9a12584">&#9670;&nbsp;</a></span>xEventGroupGetBits</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xEventGroupGetBits</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">xEventGroup</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="event__groups_8h.html#a0fb72cfdd4f0d5f86d955fc3af448f2a">xEventGroupClearBits</a>( xEventGroup, 0 )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a62b68278abac6358369ae8e390988a02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b68278abac6358369ae8e390988a02">&#9670;&nbsp;</a></span>xEventGroupSetBitsFromISR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xEventGroupSetBitsFromISR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">xEventGroup, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">uxBitsToSet, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">pxHigherPriorityTaskWoken&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;<a class="el" href="timers_8h.html#ae0d9338933037e6feebe6437763fa299">xTimerPendFunctionCallFromISR</a>( <a class="el" href="event__groups_8h.html#abe76a301815525eb5e03f331e5e51ae3">vEventGroupSetBitsCallback</a>, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ab2f21b93db0b2a0ab64d7a81ff32ac2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2f21b93db0b2a0ab64d7a81ff32ac2e">&#9670;&nbsp;</a></span>EventBits_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="portmacro_8h.html#aa69c48c6e902ce54f70886e6573c92a9">TickType_t</a> <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5119294106541c4eca46e8742fdb4e85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5119294106541c4eca46e8742fdb4e85">&#9670;&nbsp;</a></span>EventGroupHandle_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a9187a137998183178320167de254cce9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9187a137998183178320167de254cce9">&#9670;&nbsp;</a></span>vEventGroupClearBitsCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vEventGroupClearBitsCallback </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>pvEventGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint32_t&#160;</td>
<td class="paramname"><em>ulBitsToClear</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_a9187a137998183178320167de254cce9_cgraph.png" border="0" usemap="#aevent__groups_8h_a9187a137998183178320167de254cce9_cgraph" alt=""/></div>
<map name="event__groups_8h_a9187a137998183178320167de254cce9_cgraph" id="aevent__groups_8h_a9187a137998183178320167de254cce9_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,208,32"/>
<area shape="rect" href="event__groups_8c.html#a71dd2680fdfbdde7d6b10db203e266ba" title=" " alt="" coords="256,5,407,32"/>
</map>
</div>
</div>
</div>
<a id="a50cb52d1c81b063fd8d94f5293dcfea9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50cb52d1c81b063fd8d94f5293dcfea9">&#9670;&nbsp;</a></span>vEventGroupDelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vEventGroupDelete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a>&#160;</td>
<td class="paramname"><em>xEventGroup</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="event__groups_8h.html">event_groups.h</a> </p><pre>
void xEventGroupDelete( EventGroupHandle_t xEventGroup );
</pre><p>Delete an event group that was previously created by a call to <a class="el" href="event__groups_8c.html#a2e8622ce280fff2f60ad867dff0a4519">xEventGroupCreate()</a>. Tasks that are blocked on the event group will be unblocked and obtain 0 as the event group's value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xEventGroup</td><td>The event group being deleted. </td></tr>
</table>
</dd>
</dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_a50cb52d1c81b063fd8d94f5293dcfea9_cgraph.png" border="0" usemap="#aevent__groups_8h_a50cb52d1c81b063fd8d94f5293dcfea9_cgraph" alt=""/></div>
<map name="event__groups_8h_a50cb52d1c81b063fd8d94f5293dcfea9_cgraph" id="aevent__groups_8h_a50cb52d1c81b063fd8d94f5293dcfea9_cgraph">
<area shape="rect" title=" " alt="" coords="5,81,140,108"/>
<area shape="rect" href="heap__1_8c.html#a1e7cea2fd1bc894ea3b5f5e8179d259b" title=" " alt="" coords="209,5,289,32"/>
<area shape="rect" href="task_8h.html#a340b9bc9f37c9d4d3fb6e303c3ef311b" title=" " alt="" coords="365,46,560,87"/>
<area shape="rect" href="task_8h.html#a366b302eba79d10b5ee2a3756f0fcc43" title=" " alt="" coords="188,107,311,133"/>
<area shape="rect" href="task_8h.html#a003f8ae6d649225abd030cc76e1c7d0e" title=" " alt="" coords="189,159,309,185"/>
<area shape="rect" href="list_8c.html#a274fdced76bbdd9d8a4c4840ded2920c" title=" " alt="" coords="615,112,719,139"/>
<area shape="rect" href="tasks_8c.html#ad1b2e4995f863a99cf980836efe330d7" title=" " alt="" coords="359,163,567,189"/>
<area shape="rect" href="tasks_8c.html#a54f31e9aef0eb7b87e48c7d68ecc84c1" title=" " alt="" coords="393,213,533,240"/>
</map>
</div>
</div>
</div>
<a id="abe76a301815525eb5e03f331e5e51ae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe76a301815525eb5e03f331e5e51ae3">&#9670;&nbsp;</a></span>vEventGroupSetBitsCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vEventGroupSetBitsCallback </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>pvEventGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint32_t&#160;</td>
<td class="paramname"><em>ulBitsToSet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_abe76a301815525eb5e03f331e5e51ae3_cgraph.png" border="0" usemap="#aevent__groups_8h_abe76a301815525eb5e03f331e5e51ae3_cgraph" alt=""/></div>
<map name="event__groups_8h_abe76a301815525eb5e03f331e5e51ae3_cgraph" id="aevent__groups_8h_abe76a301815525eb5e03f331e5e51ae3_cgraph">
<area shape="rect" title=" " alt="" coords="5,66,196,93"/>
<area shape="rect" href="event__groups_8c.html#a9ac7cd970f50e2e50a494b656e0eb239" title=" " alt="" coords="244,66,384,93"/>
<area shape="rect" href="task_8h.html#a340b9bc9f37c9d4d3fb6e303c3ef311b" title=" " alt="" coords="609,5,804,47"/>
<area shape="rect" href="task_8h.html#a366b302eba79d10b5ee2a3756f0fcc43" title=" " alt="" coords="432,66,555,93"/>
<area shape="rect" href="task_8h.html#a003f8ae6d649225abd030cc76e1c7d0e" title=" " alt="" coords="433,118,553,145"/>
<area shape="rect" href="list_8c.html#a274fdced76bbdd9d8a4c4840ded2920c" title=" " alt="" coords="859,71,963,98"/>
<area shape="rect" href="tasks_8c.html#ad1b2e4995f863a99cf980836efe330d7" title=" " alt="" coords="603,122,811,149"/>
<area shape="rect" href="tasks_8c.html#a54f31e9aef0eb7b87e48c7d68ecc84c1" title=" " alt="" coords="637,173,777,199"/>
</map>
</div>
</div>
</div>
<a id="a0fb72cfdd4f0d5f86d955fc3af448f2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fb72cfdd4f0d5f86d955fc3af448f2a">&#9670;&nbsp;</a></span>xEventGroupClearBits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> xEventGroupClearBits </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a>&#160;</td>
<td class="paramname"><em>xEventGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td>
<td class="paramname"><em>uxBitsToClear</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_a0fb72cfdd4f0d5f86d955fc3af448f2a_icgraph.png" border="0" usemap="#aevent__groups_8h_a0fb72cfdd4f0d5f86d955fc3af448f2a_icgraph" alt=""/></div>
<map name="event__groups_8h_a0fb72cfdd4f0d5f86d955fc3af448f2a_icgraph" id="aevent__groups_8h_a0fb72cfdd4f0d5f86d955fc3af448f2a_icgraph">
<area shape="rect" title=" " alt="" coords="256,5,407,32"/>
<area shape="rect" href="event__groups_8h.html#a9187a137998183178320167de254cce9" title=" " alt="" coords="5,5,208,32"/>
</map>
</div>
</div>
</div>
<a id="a95822db4357d0b77c35aed0c7427eca0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95822db4357d0b77c35aed0c7427eca0">&#9670;&nbsp;</a></span>xEventGroupGetBitsFromISR()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> xEventGroupGetBitsFromISR </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a>&#160;</td>
<td class="paramname"><em>xEventGroup</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a02d7b3bb55f7e11d9c47116266c5fb2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02d7b3bb55f7e11d9c47116266c5fb2e">&#9670;&nbsp;</a></span>xEventGroupSetBits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> xEventGroupSetBits </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a>&#160;</td>
<td class="paramname"><em>xEventGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td>
<td class="paramname"><em>uxBitsToSet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_cgraph.png" border="0" usemap="#aevent__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_cgraph" alt=""/></div>
<map name="event__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_cgraph" id="aevent__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_cgraph">
<area shape="rect" title=" " alt="" coords="5,66,145,93"/>
<area shape="rect" href="task_8h.html#a340b9bc9f37c9d4d3fb6e303c3ef311b" title=" " alt="" coords="371,5,565,47"/>
<area shape="rect" href="task_8h.html#a366b302eba79d10b5ee2a3756f0fcc43" title=" " alt="" coords="193,66,316,93"/>
<area shape="rect" href="task_8h.html#a003f8ae6d649225abd030cc76e1c7d0e" title=" " alt="" coords="195,118,315,145"/>
<area shape="rect" href="list_8c.html#a274fdced76bbdd9d8a4c4840ded2920c" title=" " alt="" coords="620,71,724,98"/>
<area shape="rect" href="tasks_8c.html#ad1b2e4995f863a99cf980836efe330d7" title=" " alt="" coords="364,122,572,149"/>
<area shape="rect" href="tasks_8c.html#a54f31e9aef0eb7b87e48c7d68ecc84c1" title=" " alt="" coords="398,173,538,199"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_icgraph.png" border="0" usemap="#aevent__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_icgraph" alt=""/></div>
<map name="event__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_icgraph" id="aevent__groups_8h_a02d7b3bb55f7e11d9c47116266c5fb2e_icgraph">
<area shape="rect" title=" " alt="" coords="244,31,384,57"/>
<area shape="rect" href="event__groups_8h.html#abe76a301815525eb5e03f331e5e51ae3" title=" " alt="" coords="5,5,196,32"/>
<area shape="rect" href="event__groups_8h.html#a869511456b86426f52e2eec898bff341" title=" " alt="" coords="37,56,164,83"/>
</map>
</div>
</div>
</div>
<a id="a869511456b86426f52e2eec898bff341"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a869511456b86426f52e2eec898bff341">&#9670;&nbsp;</a></span>xEventGroupSync()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> xEventGroupSync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a>&#160;</td>
<td class="paramname"><em>xEventGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td>
<td class="paramname"><em>uxBitsToSet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td>
<td class="paramname"><em>uxBitsToWaitFor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="portmacro_8h.html#aa69c48c6e902ce54f70886e6573c92a9">TickType_t</a>&#160;</td>
<td class="paramname"><em>xTicksToWait</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_a869511456b86426f52e2eec898bff341_cgraph.png" border="0" usemap="#aevent__groups_8h_a869511456b86426f52e2eec898bff341_cgraph" alt=""/></div>
<map name="event__groups_8h_a869511456b86426f52e2eec898bff341_cgraph" id="aevent__groups_8h_a869511456b86426f52e2eec898bff341_cgraph">
<area shape="rect" title=" " alt="" coords="5,174,132,201"/>
<area shape="rect" href="task_8h.html#a7793b4bbe45c10d4c5104c126b89e87c" title=" " alt="" coords="196,48,385,74"/>
<area shape="rect" href="task_8h.html#a9d52fa7b60cc6a7b4fd0846700d7834c" title=" " alt="" coords="180,98,401,125"/>
<area shape="rect" href="task_8h.html#a366b302eba79d10b5ee2a3756f0fcc43" title=" " alt="" coords="497,149,619,176"/>
<area shape="rect" href="event__groups_8c.html#a9ac7cd970f50e2e50a494b656e0eb239" title=" " alt="" coords="221,200,361,226"/>
<area shape="rect" href="task_8h.html#a003f8ae6d649225abd030cc76e1c7d0e" title=" " alt="" coords="498,266,618,293"/>
<area shape="rect" href="task_8h.html#a0241000e08a261372186d34825a35979" title=" " alt="" coords="207,301,374,328"/>
<area shape="rect" href="tasks_8c.html#ab4574e77d9aea876272e563c68f639da" title=" " alt="" coords="449,48,667,74"/>
<area shape="rect" href="list_8c.html#a3240bc0f43fcf755be02bfc6de7dc6ef" title=" " alt="" coords="765,98,872,125"/>
<area shape="rect" href="list_8c.html#a274fdced76bbdd9d8a4c4840ded2920c" title=" " alt="" coords="971,190,1075,217"/>
<area shape="rect" href="list_8c.html#a28faa70d3ec4b4f39e53b0fc52d62ecf" title=" " alt="" coords="777,48,861,74"/>
<area shape="rect" href="task_8h.html#a340b9bc9f37c9d4d3fb6e303c3ef311b" title=" " alt="" coords="461,200,655,242"/>
<area shape="rect" href="tasks_8c.html#ad1b2e4995f863a99cf980836efe330d7" title=" " alt="" coords="715,266,923,293"/>
<area shape="rect" href="tasks_8c.html#a54f31e9aef0eb7b87e48c7d68ecc84c1" title=" " alt="" coords="749,317,889,344"/>
</map>
</div>
</div>
</div>
<a id="aab9d5b405bc57b7624dcabe9a9a503db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab9d5b405bc57b7624dcabe9a9a503db">&#9670;&nbsp;</a></span>xEventGroupWaitBits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a> xEventGroupWaitBits </td>
<td>(</td>
<td class="paramtype"><a class="el" href="event__groups_8h.html#a5119294106541c4eca46e8742fdb4e85">EventGroupHandle_t</a>&#160;</td>
<td class="paramname"><em>xEventGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="event__groups_8h.html#ab2f21b93db0b2a0ab64d7a81ff32ac2e">EventBits_t</a>&#160;</td>
<td class="paramname"><em>uxBitsToWaitFor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="portmacro_8h.html#a46fb21e00ae0729d7515c0fbf2269796">BaseType_t</a>&#160;</td>
<td class="paramname"><em>xClearOnExit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="portmacro_8h.html#a46fb21e00ae0729d7515c0fbf2269796">BaseType_t</a>&#160;</td>
<td class="paramname"><em>xWaitForAllBits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="portmacro_8h.html#aa69c48c6e902ce54f70886e6573c92a9">TickType_t</a>&#160;</td>
<td class="paramname"><em>xTicksToWait</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="event__groups_8h_aab9d5b405bc57b7624dcabe9a9a503db_cgraph.png" border="0" usemap="#aevent__groups_8h_aab9d5b405bc57b7624dcabe9a9a503db_cgraph" alt=""/></div>
<map name="event__groups_8h_aab9d5b405bc57b7624dcabe9a9a503db_cgraph" id="aevent__groups_8h_aab9d5b405bc57b7624dcabe9a9a503db_cgraph">
<area shape="rect" title=" " alt="" coords="5,132,152,159"/>
<area shape="rect" href="event__groups_8c.html#a152ce51000f6d8d26afbd14b4794e036" title=" " alt="" coords="237,5,384,32"/>
<area shape="rect" href="task_8h.html#a7793b4bbe45c10d4c5104c126b89e87c" title=" " alt="" coords="216,56,405,83"/>
<area shape="rect" href="task_8h.html#a9d52fa7b60cc6a7b4fd0846700d7834c" title=" " alt="" coords="200,107,421,133"/>
<area shape="rect" href="task_8h.html#a366b302eba79d10b5ee2a3756f0fcc43" title=" " alt="" coords="249,157,372,184"/>
<area shape="rect" href="task_8h.html#a0241000e08a261372186d34825a35979" title=" " alt="" coords="227,208,394,235"/>
<area shape="rect" href="task_8h.html#a003f8ae6d649225abd030cc76e1c7d0e" title=" " alt="" coords="251,259,371,285"/>
<area shape="rect" href="tasks_8c.html#ab4574e77d9aea876272e563c68f639da" title=" " alt="" coords="469,157,687,184"/>
<area shape="rect" href="list_8c.html#a3240bc0f43fcf755be02bfc6de7dc6ef" title=" " alt="" coords="735,107,841,133"/>
<area shape="rect" href="list_8c.html#a274fdced76bbdd9d8a4c4840ded2920c" title=" " alt="" coords="736,259,840,285"/>
<area shape="rect" href="list_8c.html#a28faa70d3ec4b4f39e53b0fc52d62ecf" title=" " alt="" coords="746,157,830,184"/>
<area shape="rect" href="tasks_8c.html#ad1b2e4995f863a99cf980836efe330d7" title=" " alt="" coords="474,208,682,235"/>
<area shape="rect" href="tasks_8c.html#a54f31e9aef0eb7b87e48c7d68ecc84c1" title=" " alt="" coords="508,259,648,285"/>
</map>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="event__groups_8h.html">event_groups.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>