1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>Tasks Functions</title>
7 <title>CMSIS-FreeRTOS: Tasks Functions</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="cmsis.css" rel="stylesheet" type="text/css" />
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="printComponentTabs.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 $(document).ready(function() { searchBox.OnSelectItem(0); });
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29 <table cellspacing="0" cellpadding="0">
31 <tr style="height: 46px;">
32 <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
33 <td style="padding-left: 0.5em;">
34 <div id="projectname">CMSIS-FreeRTOS
35  <span id="projectnumber">Version 10.4.6</span>
37 <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
43 <!-- end header part -->
44 <div id="CMSISnav" class="tabs1">
46 <script type="text/javascript">
48 writeComponentTabs.call(this);
53 <!-- Generated by Doxygen 1.8.6 -->
54 <script type="text/javascript">
55 var searchBox = new SearchBox("searchBox", "search",false,'Search');
57 <div id="navrow1" class="tabs">
59 <li><a href="index.html"><span>Main Page</span></a></li>
60 <li><a href="pages.html"><span>Usage and Description</span></a></li>
61 <li><a href="modules.html"><span>Reference</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
81 <div id="side-nav" class="ui-resizable side-nav-resizable">
83 <div id="nav-tree-contents">
84 <div id="nav-sync" class="sync"></div>
87 <div id="splitbar" style="-moz-user-select:none;"
88 class="ui-resizable-handle">
91 <script type="text/javascript">
92 $(document).ready(function(){initNavTree('group__freertos__evr__tasks.html','');});
94 <div id="doc-content">
95 <!-- window showing the filter options -->
96 <div id="MSearchSelectWindow"
97 onmouseover="return searchBox.OnSearchSelectShow()"
98 onmouseout="return searchBox.OnSearchSelectHide()"
99 onkeydown="return searchBox.OnSearchSelectKey(event)">
100 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Pages</a></div>
102 <!-- iframe showing the search results (closed by default) -->
103 <div id="MSearchResultsWindow">
104 <iframe src="javascript:void(0)" frameborder="0"
105 name="MSearchResults" id="MSearchResults">
110 <div class="summary">
111 <a href="#func-members">Functions</a> </div>
112 <div class="headertitle">
113 <div class="title">Tasks Functions<div class="ingroups"><a class="el" href="group__freertos__evr.html">Event functions</a></div></div> </div>
115 <div class="contents">
117 <p>Events generated by tasks functions.
118 <a href="#details">More...</a></p>
119 <table class="memberdecls">
120 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
121 Functions</h2></td></tr>
122 <tr class="memitem:gabec29cbe3077fb990b084cf6f6a28a31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gabec29cbe3077fb990b084cf6f6a28a31">EvrFreeRTOSTasks_TaskCreate</a> (TCB_t pxNewTCB)</td></tr>
123 <tr class="memdesc:gabec29cbe3077fb990b084cf6f6a28a31"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful task create (Op) <a href="#gabec29cbe3077fb990b084cf6f6a28a31">More...</a><br/></td></tr>
124 <tr class="separator:gabec29cbe3077fb990b084cf6f6a28a31"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:ga55d96d08eda4d5e6c48603b445d9a406"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga55d96d08eda4d5e6c48603b445d9a406">EvrFreeRTOSTasks_TaskCreateFailed</a> (void)</td></tr>
126 <tr class="memdesc:ga55d96d08eda4d5e6c48603b445d9a406"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful task create (Error) <a href="#ga55d96d08eda4d5e6c48603b445d9a406">More...</a><br/></td></tr>
127 <tr class="separator:ga55d96d08eda4d5e6c48603b445d9a406"><td class="memSeparator" colspan="2"> </td></tr>
128 <tr class="memitem:ga4d86d10bf850ce8be0e76440a6d07796"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga4d86d10bf850ce8be0e76440a6d07796">EvrFreeRTOSTasks_TaskDelete</a> (TCB_t pxTCB)</td></tr>
129 <tr class="memdesc:ga4d86d10bf850ce8be0e76440a6d07796"><td class="mdescLeft"> </td><td class="mdescRight">Event on task delete (Op) <a href="#ga4d86d10bf850ce8be0e76440a6d07796">More...</a><br/></td></tr>
130 <tr class="separator:ga4d86d10bf850ce8be0e76440a6d07796"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:gaec614bbc615499e8cf1beab9f8c09d93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gaec614bbc615499e8cf1beab9f8c09d93">EvrFreeRTOSTasks_TaskDelayUntil</a> (uint32_t xTimeToWake)</td></tr>
132 <tr class="memdesc:gaec614bbc615499e8cf1beab9f8c09d93"><td class="mdescLeft"> </td><td class="mdescRight">Event before current running task execution is delayed (Op) <a href="#gaec614bbc615499e8cf1beab9f8c09d93">More...</a><br/></td></tr>
133 <tr class="separator:gaec614bbc615499e8cf1beab9f8c09d93"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:ga905a96b63815c854e8591a9847078222"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga905a96b63815c854e8591a9847078222">EvrFreeRTOSTasks_TaskDelay</a> (uint32_t xTicksToDelay)</td></tr>
135 <tr class="memdesc:ga905a96b63815c854e8591a9847078222"><td class="mdescLeft"> </td><td class="mdescRight">Event on current thread execution delay (Op) <a href="#ga905a96b63815c854e8591a9847078222">More...</a><br/></td></tr>
136 <tr class="separator:ga905a96b63815c854e8591a9847078222"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:gaa86ea1a3e27efad234277416e74517c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gaa86ea1a3e27efad234277416e74517c1">EvrFreeRTOSTasks_TaskPrioritySet</a> (TCB_t pxTCB, uint32_t uxNewPriority)</td></tr>
138 <tr class="memdesc:gaa86ea1a3e27efad234277416e74517c1"><td class="mdescLeft"> </td><td class="mdescRight">Event on task priority set (Op) <a href="#gaa86ea1a3e27efad234277416e74517c1">More...</a><br/></td></tr>
139 <tr class="separator:gaa86ea1a3e27efad234277416e74517c1"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:ga66b413a39b35410288ffc23289133699"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga66b413a39b35410288ffc23289133699">EvrFreeRTOSTasks_TaskSuspend</a> (TCB_t pxTCB)</td></tr>
141 <tr class="memdesc:ga66b413a39b35410288ffc23289133699"><td class="mdescLeft"> </td><td class="mdescRight">Event on task suspend (Op) <a href="#ga66b413a39b35410288ffc23289133699">More...</a><br/></td></tr>
142 <tr class="separator:ga66b413a39b35410288ffc23289133699"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:ga4a6a29255b3eed78e46d2f62a256c276"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga4a6a29255b3eed78e46d2f62a256c276">EvrFreeRTOSTasks_TaskResume</a> (TCB_t pxTCB)</td></tr>
144 <tr class="memdesc:ga4a6a29255b3eed78e46d2f62a256c276"><td class="mdescLeft"> </td><td class="mdescRight">Event on task resume (Op) <a href="#ga4a6a29255b3eed78e46d2f62a256c276">More...</a><br/></td></tr>
145 <tr class="separator:ga4a6a29255b3eed78e46d2f62a256c276"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ga58d992016f2b90088799f6660f9ca32f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga58d992016f2b90088799f6660f9ca32f">EvrFreeRTOSTasks_TaskResumeFromIsr</a> (TCB_t pxTCB)</td></tr>
147 <tr class="memdesc:ga58d992016f2b90088799f6660f9ca32f"><td class="mdescLeft"> </td><td class="mdescRight">Event on task resume call from ISR (Op) <a href="#ga58d992016f2b90088799f6660f9ca32f">More...</a><br/></td></tr>
148 <tr class="separator:ga58d992016f2b90088799f6660f9ca32f"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:gab84eb7f4e89c509875fec02884e53e18"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gab84eb7f4e89c509875fec02884e53e18">EvrFreeRTOSTasks_TaskIncrementTick</a> (uint32_t xTickCount)</td></tr>
150 <tr class="memdesc:gab84eb7f4e89c509875fec02884e53e18"><td class="mdescLeft"> </td><td class="mdescRight">Event on tick count increment (Detail) <a href="#gab84eb7f4e89c509875fec02884e53e18">More...</a><br/></td></tr>
151 <tr class="separator:gab84eb7f4e89c509875fec02884e53e18"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:gaa9acfc9821eb634cd0d5e6ba3d39bd1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gaa9acfc9821eb634cd0d5e6ba3d39bd1f">EvrFreeRTOSTasks_IncreaseTickCount</a> (uint32_t xTicksToJump)</td></tr>
153 <tr class="memdesc:gaa9acfc9821eb634cd0d5e6ba3d39bd1f"><td class="mdescLeft"> </td><td class="mdescRight">Event on tick count increase (Op) <a href="#gaa9acfc9821eb634cd0d5e6ba3d39bd1f">More...</a><br/></td></tr>
154 <tr class="separator:gaa9acfc9821eb634cd0d5e6ba3d39bd1f"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ga5663d867b946832c6e5c3852b7969e6b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga5663d867b946832c6e5c3852b7969e6b">EvrFreeRTOSTasks_TaskSwitchedOut</a> (TCB_t pxCurrentTCB)</td></tr>
156 <tr class="memdesc:ga5663d867b946832c6e5c3852b7969e6b"><td class="mdescLeft"> </td><td class="mdescRight">Event before a new task is selected to run (Op) <a href="#ga5663d867b946832c6e5c3852b7969e6b">More...</a><br/></td></tr>
157 <tr class="separator:ga5663d867b946832c6e5c3852b7969e6b"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:ga11992540052ae77a84ead533d9762db2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga11992540052ae77a84ead533d9762db2">EvrFreeRTOSTasks_TaskSwitchedIn</a> (TCB_t pxCurrentTCB, uint32_t uxTopPriority)</td></tr>
159 <tr class="memdesc:ga11992540052ae77a84ead533d9762db2"><td class="mdescLeft"> </td><td class="mdescRight">Event after a task has been selected to run (Op) <a href="#ga11992540052ae77a84ead533d9762db2">More...</a><br/></td></tr>
160 <tr class="separator:ga11992540052ae77a84ead533d9762db2"><td class="memSeparator" colspan="2"> </td></tr>
161 <tr class="memitem:ga347df20eb0c55ba7e1d9e12f26aea8ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga347df20eb0c55ba7e1d9e12f26aea8ee">EvrFreeRTOSTasks_TaskPriorityInherit</a> (TCB_t pxTCBOfMutexHolder, uint32_t uxInheritedPriority)</td></tr>
162 <tr class="memdesc:ga347df20eb0c55ba7e1d9e12f26aea8ee"><td class="mdescLeft"> </td><td class="mdescRight">Event on task priority inheritance (Op) <a href="#ga347df20eb0c55ba7e1d9e12f26aea8ee">More...</a><br/></td></tr>
163 <tr class="separator:ga347df20eb0c55ba7e1d9e12f26aea8ee"><td class="memSeparator" colspan="2"> </td></tr>
164 <tr class="memitem:gae6c42ec4e676714cca3033704ec31499"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gae6c42ec4e676714cca3033704ec31499">EvrFreeRTOSTasks_TaskPriorityDisinherit</a> (TCB_t pxTCBOfMutexHolder, uint32_t uxOriginalPriority)</td></tr>
165 <tr class="memdesc:gae6c42ec4e676714cca3033704ec31499"><td class="mdescLeft"> </td><td class="mdescRight">Event on task priority disinheritance (Op) <a href="#gae6c42ec4e676714cca3033704ec31499">More...</a><br/></td></tr>
166 <tr class="separator:gae6c42ec4e676714cca3033704ec31499"><td class="memSeparator" colspan="2"> </td></tr>
167 <tr class="memitem:ga186fa5006319bf3419f0f88e566adae2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga186fa5006319bf3419f0f88e566adae2">EvrFreeRTOSTasks_MovedTaskToReadyState</a> (TCB_t pxTCB)</td></tr>
168 <tr class="memdesc:ga186fa5006319bf3419f0f88e566adae2"><td class="mdescLeft"> </td><td class="mdescRight">Event sent before transition of a task into the Ready state (Op) <a href="#ga186fa5006319bf3419f0f88e566adae2">More...</a><br/></td></tr>
169 <tr class="separator:ga186fa5006319bf3419f0f88e566adae2"><td class="memSeparator" colspan="2"> </td></tr>
170 <tr class="memitem:ga1c7d8dcb5f8b13225a9bebc84be91975"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga1c7d8dcb5f8b13225a9bebc84be91975">EvrFreeRTOSTasks_PostMovedTaskToReadyState</a> (TCB_t pxTCB)</td></tr>
171 <tr class="memdesc:ga1c7d8dcb5f8b13225a9bebc84be91975"><td class="mdescLeft"> </td><td class="mdescRight">Event sent after transition of a task into the Ready state (Op) <a href="#ga1c7d8dcb5f8b13225a9bebc84be91975">More...</a><br/></td></tr>
172 <tr class="separator:ga1c7d8dcb5f8b13225a9bebc84be91975"><td class="memSeparator" colspan="2"> </td></tr>
173 <tr class="memitem:ga64aab4227114f20284635414403ee339"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga64aab4227114f20284635414403ee339">EvrFreeRTOSTasks_LowPowerIdleBegin</a> (uint32_t xExpectedIdleTime)</td></tr>
174 <tr class="memdesc:ga64aab4227114f20284635414403ee339"><td class="mdescLeft"> </td><td class="mdescRight">Event on enter to the low power mode (Op) <a href="#ga64aab4227114f20284635414403ee339">More...</a><br/></td></tr>
175 <tr class="separator:ga64aab4227114f20284635414403ee339"><td class="memSeparator" colspan="2"> </td></tr>
176 <tr class="memitem:gaf1a3520a0f9f01aa1f023fea606fe6de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gaf1a3520a0f9f01aa1f023fea606fe6de">EvrFreeRTOSTasks_LowPowerIdleEnd</a> (void)</td></tr>
177 <tr class="memdesc:gaf1a3520a0f9f01aa1f023fea606fe6de"><td class="mdescLeft"> </td><td class="mdescRight">Event on exit from the low power mode (Op) <a href="#gaf1a3520a0f9f01aa1f023fea606fe6de">More...</a><br/></td></tr>
178 <tr class="separator:gaf1a3520a0f9f01aa1f023fea606fe6de"><td class="memSeparator" colspan="2"> </td></tr>
179 <tr class="memitem:ga14ce38e4c85bbc9298cdfb5a6c668318"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga14ce38e4c85bbc9298cdfb5a6c668318">EvrFreeRTOSTasks_TaskNotifyTakeBlock</a> (uint32_t uxIndexToWait, uint32_t xTicksToWait)</td></tr>
180 <tr class="memdesc:ga14ce38e4c85bbc9298cdfb5a6c668318"><td class="mdescLeft"> </td><td class="mdescRight">Event on indicating the current running task is about to block while waiting for notification to be non-zero (Op) <a href="#ga14ce38e4c85bbc9298cdfb5a6c668318">More...</a><br/></td></tr>
181 <tr class="separator:ga14ce38e4c85bbc9298cdfb5a6c668318"><td class="memSeparator" colspan="2"> </td></tr>
182 <tr class="memitem:ga95d7345859ab1f40ae6e9fb1b9cba3a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga95d7345859ab1f40ae6e9fb1b9cba3a0">EvrFreeRTOSTasks_TaskNotifyTake</a> (uint32_t uxIndexToWait, uint32_t ulNotifiedValue)</td></tr>
183 <tr class="memdesc:ga95d7345859ab1f40ae6e9fb1b9cba3a0"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful task notify take (Op) <a href="#ga95d7345859ab1f40ae6e9fb1b9cba3a0">More...</a><br/></td></tr>
184 <tr class="separator:ga95d7345859ab1f40ae6e9fb1b9cba3a0"><td class="memSeparator" colspan="2"> </td></tr>
185 <tr class="memitem:ga268f632b5a0402d1a8b5252700174cd2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga268f632b5a0402d1a8b5252700174cd2">EvrFreeRTOSTasks_TaskNotifyWaitBlock</a> (uint32_t uxIndexToWait, uint32_t xTicksToWait)</td></tr>
186 <tr class="memdesc:ga268f632b5a0402d1a8b5252700174cd2"><td class="mdescLeft"> </td><td class="mdescRight">Event indicating the current running task is about to block while waiting to receive notification (Op) <a href="#ga268f632b5a0402d1a8b5252700174cd2">More...</a><br/></td></tr>
187 <tr class="separator:ga268f632b5a0402d1a8b5252700174cd2"><td class="memSeparator" colspan="2"> </td></tr>
188 <tr class="memitem:ga782dafeee5d0f8a843211f9018c13632"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga782dafeee5d0f8a843211f9018c13632">EvrFreeRTOSTasks_TaskNotifyWait</a> (uint32_t uxIndexToWait, uint32_t ulNotifiedValue)</td></tr>
189 <tr class="memdesc:ga782dafeee5d0f8a843211f9018c13632"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful task notify wait (Op) <a href="#ga782dafeee5d0f8a843211f9018c13632">More...</a><br/></td></tr>
190 <tr class="separator:ga782dafeee5d0f8a843211f9018c13632"><td class="memSeparator" colspan="2"> </td></tr>
191 <tr class="memitem:ga677af46abe7759d3a42f10ab2c067246"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#ga677af46abe7759d3a42f10ab2c067246">EvrFreeRTOSTasks_TaskNotify</a> (TCB_t xTaskToNotify, uint32_t uxIndexToWait, uint32_t eAction, uint32_t ulNotifiedValue)</td></tr>
192 <tr class="memdesc:ga677af46abe7759d3a42f10ab2c067246"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful task notify (Op) <a href="#ga677af46abe7759d3a42f10ab2c067246">More...</a><br/></td></tr>
193 <tr class="separator:ga677af46abe7759d3a42f10ab2c067246"><td class="memSeparator" colspan="2"> </td></tr>
194 <tr class="memitem:gaf20cf8c1b327c99c1d3a1a60b6b1ff70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__tasks.html#gaf20cf8c1b327c99c1d3a1a60b6b1ff70">EvrFreeRTOSTasks_TaskNotifyFromIsr</a> (TCB_t xTaskToNotify, uint32_t uxIndexToWait, uint32_t eAction, uint32_t ulNotifiedValue)</td></tr>
195 <tr class="memdesc:gaf20cf8c1b327c99c1d3a1a60b6b1ff70"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful task notify from ISR (Op) <a href="#gaf20cf8c1b327c99c1d3a1a60b6b1ff70">More...</a><br/></td></tr>
196 <tr class="separator:gaf20cf8c1b327c99c1d3a1a60b6b1ff70"><td class="memSeparator" colspan="2"> </td></tr>
198 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
199 <h2 class="groupheader">Function Documentation</h2>
200 <a class="anchor" id="gaa9acfc9821eb634cd0d5e6ba3d39bd1f"></a>
201 <div class="memitem">
202 <div class="memproto">
203 <table class="memname">
205 <td class="memname">void EvrFreeRTOSTasks_IncreaseTickCount </td>
207 <td class="paramtype">uint32_t </td>
208 <td class="paramname"><em>xTicksToJump</em></td><td>)</td>
212 </div><div class="memdoc">
213 <dl class="params"><dt>Parameters</dt><dd>
214 <table class="params">
215 <tr><td class="paramdir">[in]</td><td class="paramname">xTicksToJump</td><td>number of ticks by which the tick count is increased.</td></tr>
219 <p>The event <b>IncreaseTickCount</b> is generated when tick count is increased by the number of ticks spent in low power mode.</p>
220 <p><b>Value</b> in the Event Recorder shows:</p>
222 <li><b>xTicksToJump</b> : number of ticks by which the tick count is increased. </li>
227 <a class="anchor" id="ga64aab4227114f20284635414403ee339"></a>
228 <div class="memitem">
229 <div class="memproto">
230 <table class="memname">
232 <td class="memname">void EvrFreeRTOSTasks_LowPowerIdleBegin </td>
234 <td class="paramtype">uint32_t </td>
235 <td class="paramname"><em>xExpectedIdleTime</em></td><td>)</td>
239 </div><div class="memdoc">
240 <dl class="params"><dt>Parameters</dt><dd>
241 <table class="params">
242 <tr><td class="paramdir">[in]</td><td class="paramname">xExpectedIdleTime</td><td>expected idle time in ticks.</td></tr>
246 <p>The event <b>LowPowerIdleBegin</b> is generated when task scheduler enters the low power mode.</p>
247 <p><b>Value</b> in the Event Recorder shows:</p>
249 <li><b>xExpectedIdleTime</b> : expected idle time in ticks. </li>
254 <a class="anchor" id="gaf1a3520a0f9f01aa1f023fea606fe6de"></a>
255 <div class="memitem">
256 <div class="memproto">
257 <table class="memname">
259 <td class="memname">void EvrFreeRTOSTasks_LowPowerIdleEnd </td>
261 <td class="paramtype">void </td>
262 <td class="paramname"></td><td>)</td>
266 </div><div class="memdoc">
267 <p>The event <b>LowPowerIdleEnd</b> is generated when task scheduler exits from the low power mode. </p>
271 <a class="anchor" id="ga186fa5006319bf3419f0f88e566adae2"></a>
272 <div class="memitem">
273 <div class="memproto">
274 <table class="memname">
276 <td class="memname">void EvrFreeRTOSTasks_MovedTaskToReadyState </td>
278 <td class="paramtype">TCB_t </td>
279 <td class="paramname"><em>pxTCB</em></td><td>)</td>
283 </div><div class="memdoc">
284 <dl class="params"><dt>Parameters</dt><dd>
285 <table class="params">
286 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCB</td><td>pointer to task handle.</td></tr>
290 <p>The event <b>MovedTaskToReadyState</b> is generated before the task is transitioned into the Ready state.</p>
291 <p><b>Value</b> in the Event Recorder shows:</p>
293 <li><b>pxTCB</b> : pointer to task object handle (control block address). </li>
298 <a class="anchor" id="ga1c7d8dcb5f8b13225a9bebc84be91975"></a>
299 <div class="memitem">
300 <div class="memproto">
301 <table class="memname">
303 <td class="memname">void EvrFreeRTOSTasks_PostMovedTaskToReadyState </td>
305 <td class="paramtype">TCB_t </td>
306 <td class="paramname"><em>pxTCB</em></td><td>)</td>
310 </div><div class="memdoc">
311 <dl class="params"><dt>Parameters</dt><dd>
312 <table class="params">
313 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCB</td><td>pointer to task handle.</td></tr>
317 <p>The event <b>PostMovedTaskToReadyState</b> is generated after the task is transitioned into the Ready state.</p>
318 <p><b>Value</b> in the Event Recorder shows:</p>
320 <li><b>pxTCB</b> : pointer to task object handle (control block address). </li>
325 <a class="anchor" id="gabec29cbe3077fb990b084cf6f6a28a31"></a>
326 <div class="memitem">
327 <div class="memproto">
328 <table class="memname">
330 <td class="memname">void EvrFreeRTOSTasks_TaskCreate </td>
332 <td class="paramtype">TCB_t </td>
333 <td class="paramname"><em>pxNewTCB</em></td><td>)</td>
337 </div><div class="memdoc">
338 <dl class="params"><dt>Parameters</dt><dd>
339 <table class="params">
340 <tr><td class="paramdir">[in]</td><td class="paramname">pxNewTCB</td><td>pointer to task handle.</td></tr>
344 <p>The event <b>TaskCreate</b> is generated when task object is successfully created.</p>
345 <p><b>Value</b> in the Event Recorder shows:</p>
347 <li><b>pxNewTCB</b> : pointer to task object handle (control block address). </li>
352 <a class="anchor" id="ga55d96d08eda4d5e6c48603b445d9a406"></a>
353 <div class="memitem">
354 <div class="memproto">
355 <table class="memname">
357 <td class="memname">void EvrFreeRTOSTasks_TaskCreateFailed </td>
359 <td class="paramtype">void </td>
360 <td class="paramname"></td><td>)</td>
364 </div><div class="memdoc">
365 <p>The event <b>TaskCreateFailed</b> is generated when task object create fails due to insufficient heap memory. </p>
369 <a class="anchor" id="ga905a96b63815c854e8591a9847078222"></a>
370 <div class="memitem">
371 <div class="memproto">
372 <table class="memname">
374 <td class="memname">void EvrFreeRTOSTasks_TaskDelay </td>
376 <td class="paramtype">uint32_t </td>
377 <td class="paramname"><em>xTicksToDelay</em></td><td>)</td>
381 </div><div class="memdoc">
382 <dl class="params"><dt>Parameters</dt><dd>
383 <table class="params">
384 <tr><td class="paramdir">[in]</td><td class="paramname">xTicksToDelay</td><td>number of ticks to delay.</td></tr>
388 <p>The event <b>TaskDelay</b> is generated when the current running task execution is delayed.</p>
389 <p><b>Value</b> in the Event Recorder shows:</p>
391 <li><b>xTicksToDelay</b> : number of ticks to delay. </li>
396 <a class="anchor" id="gaec614bbc615499e8cf1beab9f8c09d93"></a>
397 <div class="memitem">
398 <div class="memproto">
399 <table class="memname">
401 <td class="memname">void EvrFreeRTOSTasks_TaskDelayUntil </td>
403 <td class="paramtype">uint32_t </td>
404 <td class="paramname"><em>xTimeToWake</em></td><td>)</td>
408 </div><div class="memdoc">
409 <dl class="params"><dt>Parameters</dt><dd>
410 <table class="params">
411 <tr><td class="paramdir">[in]</td><td class="paramname">xTimeToWake</td><td>wake time (ticks).</td></tr>
415 <p>The event <b>TaskDelayUntil</b> is generated before the current running task execution is delayed.</p>
416 <p><b>Value</b> in the Event Recorder shows:</p>
418 <li><b>xTimeToWake</b> : wake time in ticks. </li>
423 <a class="anchor" id="ga4d86d10bf850ce8be0e76440a6d07796"></a>
424 <div class="memitem">
425 <div class="memproto">
426 <table class="memname">
428 <td class="memname">void EvrFreeRTOSTasks_TaskDelete </td>
430 <td class="paramtype">TCB_t </td>
431 <td class="paramname"><em>pxTCB</em></td><td>)</td>
435 </div><div class="memdoc">
436 <dl class="params"><dt>Parameters</dt><dd>
437 <table class="params">
438 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCB</td><td>pointer to task handle.</td></tr>
442 <p>The event <b>TaskDelete</b> is generated when the task is successfully added into thread termination list.</p>
443 <p><b>Value</b> in the Event Recorder shows:</p>
445 <li><b>pxTCB</b> : pointer to task object handle (control block address). </li>
450 <a class="anchor" id="gab84eb7f4e89c509875fec02884e53e18"></a>
451 <div class="memitem">
452 <div class="memproto">
453 <table class="memname">
455 <td class="memname">void EvrFreeRTOSTasks_TaskIncrementTick </td>
457 <td class="paramtype">uint32_t </td>
458 <td class="paramname"><em>xTickCount</em></td><td>)</td>
462 </div><div class="memdoc">
463 <dl class="params"><dt>Parameters</dt><dd>
464 <table class="params">
465 <tr><td class="paramdir">[in]</td><td class="paramname">xTickCount</td><td>tick count before increment.</td></tr>
469 <p>The event <b>TaskIncrementTick</b> is generated on every tick increment.</p>
470 <p><b>Value</b> in the Event Recorder shows:</p>
472 <li><b>xTickCount</b> : tick count before increment. </li>
477 <a class="anchor" id="ga677af46abe7759d3a42f10ab2c067246"></a>
478 <div class="memitem">
479 <div class="memproto">
480 <table class="memname">
482 <td class="memname">void EvrFreeRTOSTasks_TaskNotify </td>
484 <td class="paramtype">TCB_t </td>
485 <td class="paramname"><em>xTaskToNotify</em>, </td>
488 <td class="paramkey"></td>
490 <td class="paramtype">uint32_t </td>
491 <td class="paramname"><em>uxIndexToWait</em>, </td>
494 <td class="paramkey"></td>
496 <td class="paramtype">uint32_t </td>
497 <td class="paramname"><em>eAction</em>, </td>
500 <td class="paramkey"></td>
502 <td class="paramtype">uint32_t </td>
503 <td class="paramname"><em>ulNotifiedValue</em> </td>
511 </div><div class="memdoc">
512 <dl class="params"><dt>Parameters</dt><dd>
513 <table class="params">
514 <tr><td class="paramdir">[in]</td><td class="paramname">xTaskToNotify</td><td>pointer to task to be notified. </td></tr>
515 <tr><td class="paramdir">[in]</td><td class="paramname">uxIndexToWait</td><td>task notification index. </td></tr>
516 <tr><td class="paramdir">[in]</td><td class="paramname">eAction</td><td>task notification action. </td></tr>
517 <tr><td class="paramdir">[in]</td><td class="paramname">ulNotifiedValue</td><td>current state of the notification value.</td></tr>
521 <p>The event <b>TaskNotify</b> is generated when task notify is successfully executed.</p>
522 <p><b>Value</b> in the Event Recorder shows:</p>
524 <li><b>xTaskToNotify</b> : pointer to task object handle (control block address).</li>
525 <li><b>uxIndexToWait</b> : task notification index</li>
526 <li><b>eAction</b> : task notification action (eNotifyAction).</li>
527 <li><b>ulNotifiedValue</b> : current state of the notification value. </li>
532 <a class="anchor" id="gaf20cf8c1b327c99c1d3a1a60b6b1ff70"></a>
533 <div class="memitem">
534 <div class="memproto">
535 <table class="memname">
537 <td class="memname">void EvrFreeRTOSTasks_TaskNotifyFromIsr </td>
539 <td class="paramtype">TCB_t </td>
540 <td class="paramname"><em>xTaskToNotify</em>, </td>
543 <td class="paramkey"></td>
545 <td class="paramtype">uint32_t </td>
546 <td class="paramname"><em>uxIndexToWait</em>, </td>
549 <td class="paramkey"></td>
551 <td class="paramtype">uint32_t </td>
552 <td class="paramname"><em>eAction</em>, </td>
555 <td class="paramkey"></td>
557 <td class="paramtype">uint32_t </td>
558 <td class="paramname"><em>ulNotifiedValue</em> </td>
566 </div><div class="memdoc">
567 <dl class="params"><dt>Parameters</dt><dd>
568 <table class="params">
569 <tr><td class="paramdir">[in]</td><td class="paramname">xTaskToNotify</td><td>pointer to task to be notified. </td></tr>
570 <tr><td class="paramdir">[in]</td><td class="paramname">uxIndexToWait</td><td>task notification index. </td></tr>
571 <tr><td class="paramdir">[in]</td><td class="paramname">eAction</td><td>task notification action. </td></tr>
572 <tr><td class="paramdir">[in]</td><td class="paramname">ulNotifiedValue</td><td>current state of the notification value.</td></tr>
576 <p>The event <b>TaskNotifyFromIsr</b> is generated when task notify from ISR is successfully executed.</p>
577 <p><b>Value</b> in the Event Recorder shows:</p>
579 <li><b>xTaskToNotify</b> : pointer to task object handle (control block address).</li>
580 <li><b>uxIndexToWait</b> : task notification index</li>
581 <li><b>eAction</b> : task notification action (eNotifyAction).</li>
582 <li><b>ulNotifiedValue</b> : current state of the notification value. </li>
587 <a class="anchor" id="ga95d7345859ab1f40ae6e9fb1b9cba3a0"></a>
588 <div class="memitem">
589 <div class="memproto">
590 <table class="memname">
592 <td class="memname">void EvrFreeRTOSTasks_TaskNotifyTake </td>
594 <td class="paramtype">uint32_t </td>
595 <td class="paramname"><em>uxIndexToWait</em>, </td>
598 <td class="paramkey"></td>
600 <td class="paramtype">uint32_t </td>
601 <td class="paramname"><em>ulNotifiedValue</em> </td>
609 </div><div class="memdoc">
610 <dl class="params"><dt>Parameters</dt><dd>
611 <table class="params">
612 <tr><td class="paramdir">[in]</td><td class="paramname">uxIndexToWait</td><td>task notification index. </td></tr>
613 <tr><td class="paramdir">[in]</td><td class="paramname">ulNotifiedValue</td><td>current state of the notification value.</td></tr>
617 <p>The event <b>TaskNotifyTake</b> is generated when task notify take is successfully executed.</p>
618 <p><b>Value</b> in the Event Recorder shows:</p>
620 <li><b>uxIndexToWait</b> : task notification index</li>
621 <li><b>ulNotifiedValue</b> : current state of the notification value. </li>
626 <a class="anchor" id="ga14ce38e4c85bbc9298cdfb5a6c668318"></a>
627 <div class="memitem">
628 <div class="memproto">
629 <table class="memname">
631 <td class="memname">void EvrFreeRTOSTasks_TaskNotifyTakeBlock </td>
633 <td class="paramtype">uint32_t </td>
634 <td class="paramname"><em>uxIndexToWait</em>, </td>
637 <td class="paramkey"></td>
639 <td class="paramtype">uint32_t </td>
640 <td class="paramname"><em>xTicksToWait</em> </td>
648 </div><div class="memdoc">
649 <dl class="params"><dt>Parameters</dt><dd>
650 <table class="params">
651 <tr><td class="paramdir">[in]</td><td class="paramname">uxIndexToWait</td><td>task notification index. </td></tr>
652 <tr><td class="paramdir">[in]</td><td class="paramname">xTicksToWait</td><td>wait timeout in ticks.</td></tr>
656 <p>The event <b>TaskNotifyTakeBlock</b> is generated when the current running task is about to block and wait to take notification.</p>
657 <p><b>Value</b> in the Event Recorder shows:</p>
659 <li><b>uxIndexToWait</b> : task notification index</li>
660 <li><b>xTicksToWait</b> : wait timeout in ticks. </li>
665 <a class="anchor" id="ga782dafeee5d0f8a843211f9018c13632"></a>
666 <div class="memitem">
667 <div class="memproto">
668 <table class="memname">
670 <td class="memname">void EvrFreeRTOSTasks_TaskNotifyWait </td>
672 <td class="paramtype">uint32_t </td>
673 <td class="paramname"><em>uxIndexToWait</em>, </td>
676 <td class="paramkey"></td>
678 <td class="paramtype">uint32_t </td>
679 <td class="paramname"><em>ulNotifiedValue</em> </td>
687 </div><div class="memdoc">
688 <dl class="params"><dt>Parameters</dt><dd>
689 <table class="params">
690 <tr><td class="paramdir">[in]</td><td class="paramname">uxIndexToWait</td><td>task notification index. </td></tr>
691 <tr><td class="paramdir">[in]</td><td class="paramname">ulNotifiedValue</td><td>current state of the notification value.</td></tr>
695 <p>The event <b>TaskNotifyWait</b> is generated when task notify wait is completed.</p>
696 <p><b>Value</b> in the Event Recorder shows:</p>
698 <li><b>uxIndexToWait</b> : task notification index</li>
699 <li><b>ulNotifiedValue</b> : current state of the notification value. </li>
704 <a class="anchor" id="ga268f632b5a0402d1a8b5252700174cd2"></a>
705 <div class="memitem">
706 <div class="memproto">
707 <table class="memname">
709 <td class="memname">void EvrFreeRTOSTasks_TaskNotifyWaitBlock </td>
711 <td class="paramtype">uint32_t </td>
712 <td class="paramname"><em>uxIndexToWait</em>, </td>
715 <td class="paramkey"></td>
717 <td class="paramtype">uint32_t </td>
718 <td class="paramname"><em>xTicksToWait</em> </td>
726 </div><div class="memdoc">
727 <dl class="params"><dt>Parameters</dt><dd>
728 <table class="params">
729 <tr><td class="paramdir">[in]</td><td class="paramname">uxIndexToWait</td><td>task notification index </td></tr>
730 <tr><td class="paramdir">[in]</td><td class="paramname">xTicksToWait</td><td>wait timeout in ticks.</td></tr>
734 <p>The event <b>TaskNotifyWaitBlock</b> is generated when the current running task is about to block and wait to receive notification.</p>
735 <p><b>Value</b> in the Event Recorder shows:</p>
737 <li><b>uxIndexToWait</b> : task notification index</li>
738 <li><b>xTicksToWait</b> : wait timeout in ticks. </li>
743 <a class="anchor" id="gae6c42ec4e676714cca3033704ec31499"></a>
744 <div class="memitem">
745 <div class="memproto">
746 <table class="memname">
748 <td class="memname">void EvrFreeRTOSTasks_TaskPriorityDisinherit </td>
750 <td class="paramtype">TCB_t </td>
751 <td class="paramname"><em>pxTCBOfMutexHolder</em>, </td>
754 <td class="paramkey"></td>
756 <td class="paramtype">uint32_t </td>
757 <td class="paramname"><em>uxOriginalPriority</em> </td>
765 </div><div class="memdoc">
766 <dl class="params"><dt>Parameters</dt><dd>
767 <table class="params">
768 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCBOfMutexHolder</td><td>pointer to task handle. </td></tr>
769 <tr><td class="paramdir">[in]</td><td class="paramname">uxOriginalPriority</td><td>old (original) task priority.</td></tr>
773 <p>The event <b>TaskPriorityDisinherit</b> is generated when task priority is disinherited to its base priority.</p>
774 <p><b>Value</b> in the Event Recorder shows:</p>
776 <li><b>pxTCBOfMutexHolder</b> : pointer to task object handle (control block address).</li>
777 <li><b>uxOriginalPriority</b> : task base priority </li>
782 <a class="anchor" id="ga347df20eb0c55ba7e1d9e12f26aea8ee"></a>
783 <div class="memitem">
784 <div class="memproto">
785 <table class="memname">
787 <td class="memname">void EvrFreeRTOSTasks_TaskPriorityInherit </td>
789 <td class="paramtype">TCB_t </td>
790 <td class="paramname"><em>pxTCBOfMutexHolder</em>, </td>
793 <td class="paramkey"></td>
795 <td class="paramtype">uint32_t </td>
796 <td class="paramname"><em>uxInheritedPriority</em> </td>
804 </div><div class="memdoc">
805 <dl class="params"><dt>Parameters</dt><dd>
806 <table class="params">
807 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCBOfMutexHolder</td><td>pointer to task handle. </td></tr>
808 <tr><td class="paramdir">[in]</td><td class="paramname">uxInheritedPriority</td><td>new (inherited) task priority.</td></tr>
812 <p>The event <b>TaskPriorityInherit</b> is generated when task priority is inherited from the current running task.</p>
813 <p><b>Value</b> in the Event Recorder shows:</p>
815 <li><b>pxTCBOfMutexHolder</b> : pointer to task object handle (control block address).</li>
816 <li><b>uxInheritedPriority</b> : inherited task priority </li>
821 <a class="anchor" id="gaa86ea1a3e27efad234277416e74517c1"></a>
822 <div class="memitem">
823 <div class="memproto">
824 <table class="memname">
826 <td class="memname">void EvrFreeRTOSTasks_TaskPrioritySet </td>
828 <td class="paramtype">TCB_t </td>
829 <td class="paramname"><em>pxTCB</em>, </td>
832 <td class="paramkey"></td>
834 <td class="paramtype">uint32_t </td>
835 <td class="paramname"><em>uxNewPriority</em> </td>
843 </div><div class="memdoc">
844 <dl class="params"><dt>Parameters</dt><dd>
845 <table class="params">
846 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCB</td><td>pointer to task handle. </td></tr>
847 <tr><td class="paramdir">[in]</td><td class="paramname">uxNewPriority</td><td>The event <b>TaskPrioritySet</b> is generated when task priority is set.</td></tr>
851 <p><b>Value</b> in the Event Recorder shows:</p>
853 <li><b>pxTCB</b> : pointer to task object handle (control block address).</li>
854 <li><b>uxNewPriority</b> : task new priority . </li>
859 <a class="anchor" id="ga4a6a29255b3eed78e46d2f62a256c276"></a>
860 <div class="memitem">
861 <div class="memproto">
862 <table class="memname">
864 <td class="memname">void EvrFreeRTOSTasks_TaskResume </td>
866 <td class="paramtype">TCB_t </td>
867 <td class="paramname"><em>pxTCB</em></td><td>)</td>
871 </div><div class="memdoc">
872 <dl class="params"><dt>Parameters</dt><dd>
873 <table class="params">
874 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCB</td><td>pointer to task handle.</td></tr>
878 <p>The event <b>TaskResume</b> is generated when task execution is resumed.</p>
879 <p><b>Value</b> in the Event Recorder shows:</p>
881 <li><b>pxTCB</b> : pointer to task object handle (control block address). </li>
886 <a class="anchor" id="ga58d992016f2b90088799f6660f9ca32f"></a>
887 <div class="memitem">
888 <div class="memproto">
889 <table class="memname">
891 <td class="memname">void EvrFreeRTOSTasks_TaskResumeFromIsr </td>
893 <td class="paramtype">TCB_t </td>
894 <td class="paramname"><em>pxTCB</em></td><td>)</td>
898 </div><div class="memdoc">
899 <dl class="params"><dt>Parameters</dt><dd>
900 <table class="params">
901 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCB</td><td>pointer to task handle.</td></tr>
905 <p>The event <b>TaskResumeFromIsr</b> is generated when task execution is resumed from the ISR.</p>
906 <p><b>Value</b> in the Event Recorder shows:</p>
908 <li><b>pxTCB</b> : pointer to task object handle (control block address). </li>
913 <a class="anchor" id="ga66b413a39b35410288ffc23289133699"></a>
914 <div class="memitem">
915 <div class="memproto">
916 <table class="memname">
918 <td class="memname">void EvrFreeRTOSTasks_TaskSuspend </td>
920 <td class="paramtype">TCB_t </td>
921 <td class="paramname"><em>pxTCB</em></td><td>)</td>
925 </div><div class="memdoc">
926 <dl class="params"><dt>Parameters</dt><dd>
927 <table class="params">
928 <tr><td class="paramdir">[in]</td><td class="paramname">pxTCB</td><td>pointer to task handle.</td></tr>
932 <p>The event <b>TaskSuspend</b> is generated when task execution is suspended.</p>
933 <p><b>Value</b> in the Event Recorder shows:</p>
935 <li><b>pxTCB</b> : pointer to task object handle (control block address). </li>
940 <a class="anchor" id="ga11992540052ae77a84ead533d9762db2"></a>
941 <div class="memitem">
942 <div class="memproto">
943 <table class="memname">
945 <td class="memname">void EvrFreeRTOSTasks_TaskSwitchedIn </td>
947 <td class="paramtype">TCB_t </td>
948 <td class="paramname"><em>pxCurrentTCB</em>, </td>
951 <td class="paramkey"></td>
953 <td class="paramtype">uint32_t </td>
954 <td class="paramname"><em>uxTopPriority</em> </td>
962 </div><div class="memdoc">
963 <dl class="params"><dt>Parameters</dt><dd>
964 <table class="params">
965 <tr><td class="paramdir">[in]</td><td class="paramname">pxCurrentTCB</td><td>handle to the task about to enter the running state. </td></tr>
966 <tr><td class="paramdir">[in]</td><td class="paramname">uxTopPriority</td><td>pxCurrentTCB task priority.</td></tr>
970 <p>The event <b>TaskSwitchedIn</b> is generated after a task has been selected to run.</p>
971 <p><b>Value</b> in the Event Recorder shows:</p>
973 <li><b>pxCurrentTCB</b> : pointer to task object handle (control block address).</li>
974 <li><b>uxTopPriority</b> : task priority </li>
979 <a class="anchor" id="ga5663d867b946832c6e5c3852b7969e6b"></a>
980 <div class="memitem">
981 <div class="memproto">
982 <table class="memname">
984 <td class="memname">void EvrFreeRTOSTasks_TaskSwitchedOut </td>
986 <td class="paramtype">TCB_t </td>
987 <td class="paramname"><em>pxCurrentTCB</em></td><td>)</td>
991 </div><div class="memdoc">
992 <dl class="params"><dt>Parameters</dt><dd>
993 <table class="params">
994 <tr><td class="paramdir">[in]</td><td class="paramname">pxCurrentTCB</td><td>handle to the task about to leave the running state.</td></tr>
998 <p>The event <b>TaskSwitchedOut</b> is generated before a new task is selected to run.</p>
999 <p><b>Value</b> in the Event Recorder shows:</p>
1001 <li><b>pxCurrentTCB</b> : pointer to task object handle (control block address). </li>
1006 </div><!-- contents -->
1007 </div><!-- doc-content -->
1008 <!-- start footer part -->
1009 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1011 <li class="footer">Generated on Tue Nov 16 2021 09:08:40 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
1013 <a href="http://www.doxygen.org/index.html">
1014 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6