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>Timer Functions</title>
7 <title>CMSIS-FreeRTOS: Timer 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 9.1.0</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__timers.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">Timer 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 timer 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:gacc9345d117387a048a35832be8875b1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#gacc9345d117387a048a35832be8875b1f">EvrFreeRTOSTimers_TimerCreate</a> (Timer_t pxNewTimer)</td></tr>
123 <tr class="memdesc:gacc9345d117387a048a35832be8875b1f"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful timer object create (Op) <a href="#gacc9345d117387a048a35832be8875b1f">More...</a><br/></td></tr>
124 <tr class="separator:gacc9345d117387a048a35832be8875b1f"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:ga4d3ee3a0c730e52f53662b6d471a6678"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga4d3ee3a0c730e52f53662b6d471a6678">EvrFreeRTOSTimers_TimerCreateFailed</a> (void)</td></tr>
126 <tr class="memdesc:ga4d3ee3a0c730e52f53662b6d471a6678"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful timer object create (Error) <a href="#ga4d3ee3a0c730e52f53662b6d471a6678">More...</a><br/></td></tr>
127 <tr class="separator:ga4d3ee3a0c730e52f53662b6d471a6678"><td class="memSeparator" colspan="2"> </td></tr>
128 <tr class="memitem:gab0b740245ecdbd07ca7d63c26ef249fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#gab0b740245ecdbd07ca7d63c26ef249fc">EvrFreeRTOSTimers_TimerCommandSend</a> (Timer_t pxTimer, uint32_t xCommandID, uint32_t xOptionalValue, uint32_t xReturn)</td></tr>
129 <tr class="memdesc:gab0b740245ecdbd07ca7d63c26ef249fc"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer queue command send (Op) <a href="#gab0b740245ecdbd07ca7d63c26ef249fc">More...</a><br/></td></tr>
130 <tr class="separator:gab0b740245ecdbd07ca7d63c26ef249fc"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:ga67fb64cd979312c3584c6be7bd8affff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga67fb64cd979312c3584c6be7bd8affff">EvrFreeRTOSTimers_TimerCommandReceived</a> (Timer_t pxTimer, uint32_t xCommandID, uint32_t xOptionalValue)</td></tr>
132 <tr class="memdesc:ga67fb64cd979312c3584c6be7bd8affff"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer queue command receive (Op) <a href="#ga67fb64cd979312c3584c6be7bd8affff">More...</a><br/></td></tr>
133 <tr class="separator:ga67fb64cd979312c3584c6be7bd8affff"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:ga6d29aabccac31d30777625064495e0f9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga6d29aabccac31d30777625064495e0f9">EvrFreeRTOSTimers_TimerExpired</a> (Timer_t pxTimer)</td></tr>
135 <tr class="memdesc:ga6d29aabccac31d30777625064495e0f9"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer expire (Op) <a href="#ga6d29aabccac31d30777625064495e0f9">More...</a><br/></td></tr>
136 <tr class="separator:ga6d29aabccac31d30777625064495e0f9"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:ga4b35fa6a01c96b3395a4c49143a150d4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga4b35fa6a01c96b3395a4c49143a150d4">EvrFreeRTOSTimers_PendFuncCall</a> (PendedFunction_t pxFunctionToPend, void *pvParameter1, uint32_t ulParameter2, uint32_t xReturn)</td></tr>
138 <tr class="memdesc:ga4b35fa6a01c96b3395a4c49143a150d4"><td class="mdescLeft"> </td><td class="mdescRight">Event on pass of the function execution to the timer service task (Op) <a href="#ga4b35fa6a01c96b3395a4c49143a150d4">More...</a><br/></td></tr>
139 <tr class="separator:ga4b35fa6a01c96b3395a4c49143a150d4"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:ga870fe8028016271f6ef11061fbe82fcd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga870fe8028016271f6ef11061fbe82fcd">EvrFreeRTOSTimers_PendFuncCallFromIsr</a> (PendedFunction_t pxFunctionToPend, void *pvParameter1, uint32_t ulParameter2, uint32_t xReturn)</td></tr>
141 <tr class="memdesc:ga870fe8028016271f6ef11061fbe82fcd"><td class="mdescLeft"> </td><td class="mdescRight">Event on pass of the function execution to the timer service task from the ISR (Op) <a href="#ga870fe8028016271f6ef11061fbe82fcd">More...</a><br/></td></tr>
142 <tr class="separator:ga870fe8028016271f6ef11061fbe82fcd"><td class="memSeparator" colspan="2"> </td></tr>
144 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
145 <h2 class="groupheader">Function Documentation</h2>
146 <a class="anchor" id="ga4b35fa6a01c96b3395a4c49143a150d4"></a>
147 <div class="memitem">
148 <div class="memproto">
149 <table class="memname">
151 <td class="memname">void EvrFreeRTOSTimers_PendFuncCall </td>
153 <td class="paramtype">PendedFunction_t </td>
154 <td class="paramname"><em>pxFunctionToPend</em>, </td>
157 <td class="paramkey"></td>
159 <td class="paramtype">void * </td>
160 <td class="paramname"><em>pvParameter1</em>, </td>
163 <td class="paramkey"></td>
165 <td class="paramtype">uint32_t </td>
166 <td class="paramname"><em>ulParameter2</em>, </td>
169 <td class="paramkey"></td>
171 <td class="paramtype">uint32_t </td>
172 <td class="paramname"><em>xReturn</em> </td>
180 </div><div class="memdoc">
181 <dl class="params"><dt>Parameters</dt><dd>
182 <table class="params">
183 <tr><td class="paramdir">[in]</td><td class="paramname">pxFunctionToPend</td><td>pointer to callback function </td></tr>
184 <tr><td class="paramdir">[in]</td><td class="paramname">pvParameter1</td><td>function parameter 1. </td></tr>
185 <tr><td class="paramdir">[in]</td><td class="paramname">ulParameter2</td><td>function parameter 2. </td></tr>
186 <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>return value.</td></tr>
190 <p>The event <b>PendFuncCall</b> is generated before the function xTimerPendFunctionCall returns.</p>
191 <p><b>Value</b> in the Event Recorder shows:</p>
193 <li><b>pxFunctionToPend</b> : callback function to execute from the timer service/deamon task.</li>
194 <li><b>pvParameter1</b> : the value passed into the callback function as the first parameter.</li>
195 <li><b>ulParameter2</b> : the value passed into the callback function as the second parameter.</li>
196 <li><b>xReturn</b> : execution status (1=callback passed to the timer sevice task, any other value: queue full, failed to register the callback execution) </li>
201 <a class="anchor" id="ga870fe8028016271f6ef11061fbe82fcd"></a>
202 <div class="memitem">
203 <div class="memproto">
204 <table class="memname">
206 <td class="memname">void EvrFreeRTOSTimers_PendFuncCallFromIsr </td>
208 <td class="paramtype">PendedFunction_t </td>
209 <td class="paramname"><em>pxFunctionToPend</em>, </td>
212 <td class="paramkey"></td>
214 <td class="paramtype">void * </td>
215 <td class="paramname"><em>pvParameter1</em>, </td>
218 <td class="paramkey"></td>
220 <td class="paramtype">uint32_t </td>
221 <td class="paramname"><em>ulParameter2</em>, </td>
224 <td class="paramkey"></td>
226 <td class="paramtype">uint32_t </td>
227 <td class="paramname"><em>xReturn</em> </td>
235 </div><div class="memdoc">
236 <dl class="params"><dt>Parameters</dt><dd>
237 <table class="params">
238 <tr><td class="paramdir">[in]</td><td class="paramname">pxFunctionToPend</td><td>pointer to callback function </td></tr>
239 <tr><td class="paramdir">[in]</td><td class="paramname">pvParameter1</td><td>function parameter 1. </td></tr>
240 <tr><td class="paramdir">[in]</td><td class="paramname">ulParameter2</td><td>function parameter 2. </td></tr>
241 <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>return value.</td></tr>
245 <p>The event <b>PendFuncCallFromIsr</b> is generated before the function xTimerPendFunctionCallFromISR returns.</p>
246 <p><b>Value</b> in the Event Recorder shows:</p>
248 <li><b>pxFunctionToPend</b> : callback function to execute from the timer service/deamon task.</li>
249 <li><b>pvParameter1</b> : the value passed into the callback function as the first parameter.</li>
250 <li><b>ulParameter2</b> : the value passed into the callback function as the second parameter.</li>
251 <li><b>xReturn</b> : execution status (1=callback passed to the timer sevice task, any other value: queue full, failed to register the callback execution) </li>
256 <a class="anchor" id="ga67fb64cd979312c3584c6be7bd8affff"></a>
257 <div class="memitem">
258 <div class="memproto">
259 <table class="memname">
261 <td class="memname">void EvrFreeRTOSTimers_TimerCommandReceived </td>
263 <td class="paramtype">Timer_t </td>
264 <td class="paramname"><em>pxTimer</em>, </td>
267 <td class="paramkey"></td>
269 <td class="paramtype">uint32_t </td>
270 <td class="paramname"><em>xCommandID</em>, </td>
273 <td class="paramkey"></td>
275 <td class="paramtype">uint32_t </td>
276 <td class="paramname"><em>xOptionalValue</em> </td>
284 </div><div class="memdoc">
285 <dl class="params"><dt>Parameters</dt><dd>
286 <table class="params">
287 <tr><td class="paramdir">[in]</td><td class="paramname">pxTimer</td><td>pointer to timer object handle. </td></tr>
288 <tr><td class="paramdir">[in]</td><td class="paramname">xCommandID</td><td>timer command ID. </td></tr>
289 <tr><td class="paramdir">[in]</td><td class="paramname">xOptionalValue</td><td>optional command value.</td></tr>
293 <p>The event <b>TimerCommandReceived</b> is generated when the timer service task receives a command and before the command is actually processed.</p>
294 <p><b>Value</b> in the Event Recorder shows:</p>
296 <li><b>pxTimer</b> : pointer to timer object handle (control block address).</li>
297 <li><b>xCommandID</b> : timer command ID.</li>
298 <li><b>xOptionalValue</b> : optional command value. </li>
303 <a class="anchor" id="gab0b740245ecdbd07ca7d63c26ef249fc"></a>
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
308 <td class="memname">void EvrFreeRTOSTimers_TimerCommandSend </td>
310 <td class="paramtype">Timer_t </td>
311 <td class="paramname"><em>pxTimer</em>, </td>
314 <td class="paramkey"></td>
316 <td class="paramtype">uint32_t </td>
317 <td class="paramname"><em>xCommandID</em>, </td>
320 <td class="paramkey"></td>
322 <td class="paramtype">uint32_t </td>
323 <td class="paramname"><em>xOptionalValue</em>, </td>
326 <td class="paramkey"></td>
328 <td class="paramtype">uint32_t </td>
329 <td class="paramname"><em>xReturn</em> </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">pxTimer</td><td>pointer to timer object handle. </td></tr>
341 <tr><td class="paramdir">[in]</td><td class="paramname">xCommandID</td><td>timer command ID. </td></tr>
342 <tr><td class="paramdir">[in]</td><td class="paramname">xOptionalValue</td><td>optional command value. </td></tr>
343 <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>return value.</td></tr>
347 <p>The event <b>TimerCommandSend</b> is generated when a command is sent to the timer service task,</p>
348 <p><b>Value</b> in the Event Recorder shows:</p>
350 <li><b>pxTimer</b> : pointer to timer object handle (control block address).</li>
351 <li><b>xCommandID</b> : timer command ID.</li>
352 <li><b>xOptionalValue</b> : optional command value.</li>
353 <li><b>xReturn</b> : execution status (0: failed, command was not sent to the timer command queue, 1: passed, command sent) </li>
358 <a class="anchor" id="gacc9345d117387a048a35832be8875b1f"></a>
359 <div class="memitem">
360 <div class="memproto">
361 <table class="memname">
363 <td class="memname">void EvrFreeRTOSTimers_TimerCreate </td>
365 <td class="paramtype">Timer_t </td>
366 <td class="paramname"><em>pxNewTimer</em></td><td>)</td>
370 </div><div class="memdoc">
371 <dl class="params"><dt>Parameters</dt><dd>
372 <table class="params">
373 <tr><td class="paramdir">[in]</td><td class="paramname">pxNewTimer</td><td>pointer to timer object handle.</td></tr>
377 <p>The event <b>TimerCreate</b> is generated when timer object is successfully created.</p>
378 <p><b>Value</b> in the Event Recorder shows:</p>
380 <li><b>pxNewTimer</b> : pointer to timer object handle (control block address). </li>
385 <a class="anchor" id="ga4d3ee3a0c730e52f53662b6d471a6678"></a>
386 <div class="memitem">
387 <div class="memproto">
388 <table class="memname">
390 <td class="memname">void EvrFreeRTOSTimers_TimerCreateFailed </td>
392 <td class="paramtype">void </td>
393 <td class="paramname"></td><td>)</td>
397 </div><div class="memdoc">
398 <p>The event <b>TimerCreateFailed</b> is generated when timer object create fails due to insufficient heap memory. </p>
402 <a class="anchor" id="ga6d29aabccac31d30777625064495e0f9"></a>
403 <div class="memitem">
404 <div class="memproto">
405 <table class="memname">
407 <td class="memname">void EvrFreeRTOSTimers_TimerExpired </td>
409 <td class="paramtype">Timer_t </td>
410 <td class="paramname"><em>pxTimer</em></td><td>)</td>
414 </div><div class="memdoc">
415 <dl class="params"><dt>Parameters</dt><dd>
416 <table class="params">
417 <tr><td class="paramdir">[in]</td><td class="paramname">pxTimer</td><td>pointer to timer object handle.</td></tr>
421 <p>The event <b>TimerExpired</b> is generated when a software timer expires and before the timer callback is executed.</p>
422 <p><b>Value</b> in the Event Recorder shows:</p>
424 <li><b>pxTimer</b> : pointer to timer object handle (control block address). </li>
429 </div><!-- contents -->
430 </div><!-- doc-content -->
431 <!-- start footer part -->
432 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
434 <li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
436 <a href="http://www.doxygen.org/index.html">
437 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6