diff options
Diffstat (limited to 'docs/RTOS2/html/group__rtx__evr__timer.html')
| -rw-r--r-- | docs/RTOS2/html/group__rtx__evr__timer.html | 636 |
1 files changed, 636 insertions, 0 deletions
diff --git a/docs/RTOS2/html/group__rtx__evr__timer.html b/docs/RTOS2/html/group__rtx__evr__timer.html new file mode 100644 index 0000000..869c7e9 --- /dev/null +++ b/docs/RTOS2/html/group__rtx__evr__timer.html @@ -0,0 +1,636 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/> +<title>Timer Functions</title> +<title>CMSIS-RTOS2: Timer Functions</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="cmsis.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<script type="text/javascript" src="printComponentTabs.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +</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: 46px;"> + <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">CMSIS-RTOS2 +  <span id="projectnumber">Version 2.1.3</span> + </div> + <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<div id="CMSISnav" class="tabs1"> + <ul class="tablist"> + <script type="text/javascript"> + <!-- + writeComponentTabs.call(this); + //--> + </script> + </ul> +</div> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Usage and Description</span></a></li> + <li><a href="modules.html"><span>Reference</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </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"> +$(document).ready(function(){initNavTree('group__rtx__evr__timer.html','');}); +</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)"> +<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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Timer Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Events generated by timer functions. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gaf1b516bf697288e67fe797662b1873b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#gaf1b516bf697288e67fe797662b1873b0">EvrRtxTimerError</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id, int32_t status)</td></tr> +<tr class="memdesc:gaf1b516bf697288e67fe797662b1873b0"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer error (Error) <a href="#gaf1b516bf697288e67fe797662b1873b0">More...</a><br/></td></tr> +<tr class="separator:gaf1b516bf697288e67fe797662b1873b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacd46f9d31d256c27c72e47d5be5e9d09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#gacd46f9d31d256c27c72e47d5be5e9d09">EvrRtxTimerCallback</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaacf768c1ec64b020598afb985d7b30be">osTimerFunc_t</a> func, void *argument)</td></tr> +<tr class="memdesc:gacd46f9d31d256c27c72e47d5be5e9d09"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer callback call (Op) <a href="#gacd46f9d31d256c27c72e47d5be5e9d09">More...</a><br/></td></tr> +<tr class="separator:gacd46f9d31d256c27c72e47d5be5e9d09"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6387808c22d6e186057ed744618d2487"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#ga6387808c22d6e186057ed744618d2487">EvrRtxTimerNew</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaacf768c1ec64b020598afb985d7b30be">osTimerFunc_t</a> func, <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#ga7dc24a4c2b90334427081c3da7a71915">osTimerType_t</a> type, void *argument, const <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#structosTimerAttr__t">osTimerAttr_t</a> *attr)</td></tr> +<tr class="memdesc:ga6387808c22d6e186057ed744618d2487"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer create and initialize (API) <a href="#ga6387808c22d6e186057ed744618d2487">More...</a><br/></td></tr> +<tr class="separator:ga6387808c22d6e186057ed744618d2487"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga71dd40a818f1098052915bbfb6c17e88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#ga71dd40a818f1098052915bbfb6c17e88">EvrRtxTimerCreated</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id, const char *name)</td></tr> +<tr class="memdesc:ga71dd40a818f1098052915bbfb6c17e88"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful timer create (Op) <a href="#ga71dd40a818f1098052915bbfb6c17e88">More...</a><br/></td></tr> +<tr class="separator:ga71dd40a818f1098052915bbfb6c17e88"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga601e3617903900524062c4f9069d052f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#ga601e3617903900524062c4f9069d052f">EvrRtxTimerGetName</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id, const char *name)</td></tr> +<tr class="memdesc:ga601e3617903900524062c4f9069d052f"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer name retrieve (API) <a href="#ga601e3617903900524062c4f9069d052f">More...</a><br/></td></tr> +<tr class="separator:ga601e3617903900524062c4f9069d052f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga453d82bfa65dfbbaffbd5b4ff4f050b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#ga453d82bfa65dfbbaffbd5b4ff4f050b2">EvrRtxTimerStart</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id, uint32_t ticks)</td></tr> +<tr class="memdesc:ga453d82bfa65dfbbaffbd5b4ff4f050b2"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer start (API) <a href="#ga453d82bfa65dfbbaffbd5b4ff4f050b2">More...</a><br/></td></tr> +<tr class="separator:ga453d82bfa65dfbbaffbd5b4ff4f050b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab0dbdf460fc26b25f3987c44fb0ebdeb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#gab0dbdf460fc26b25f3987c44fb0ebdeb">EvrRtxTimerStarted</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id)</td></tr> +<tr class="memdesc:gab0dbdf460fc26b25f3987c44fb0ebdeb"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful timer start (Op) <a href="#gab0dbdf460fc26b25f3987c44fb0ebdeb">More...</a><br/></td></tr> +<tr class="separator:gab0dbdf460fc26b25f3987c44fb0ebdeb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga27cf05adc61d30a0e68f380c96ea5f93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#ga27cf05adc61d30a0e68f380c96ea5f93">EvrRtxTimerStop</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id)</td></tr> +<tr class="memdesc:ga27cf05adc61d30a0e68f380c96ea5f93"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer stop (API) <a href="#ga27cf05adc61d30a0e68f380c96ea5f93">More...</a><br/></td></tr> +<tr class="separator:ga27cf05adc61d30a0e68f380c96ea5f93"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaccd59c7ae2351e0a1bf96cdb749c049f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#gaccd59c7ae2351e0a1bf96cdb749c049f">EvrRtxTimerStopped</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id)</td></tr> +<tr class="memdesc:gaccd59c7ae2351e0a1bf96cdb749c049f"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful timer stop (Op) <a href="#gaccd59c7ae2351e0a1bf96cdb749c049f">More...</a><br/></td></tr> +<tr class="separator:gaccd59c7ae2351e0a1bf96cdb749c049f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6fa5a23f241d765ae22ff1862c6f3b3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#ga6fa5a23f241d765ae22ff1862c6f3b3f">EvrRtxTimerIsRunning</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id, uint32_t running)</td></tr> +<tr class="memdesc:ga6fa5a23f241d765ae22ff1862c6f3b3f"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer running state check (API) <a href="#ga6fa5a23f241d765ae22ff1862c6f3b3f">More...</a><br/></td></tr> +<tr class="separator:ga6fa5a23f241d765ae22ff1862c6f3b3f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaea5811cc74861117eccbcbb997d36133"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#gaea5811cc74861117eccbcbb997d36133">EvrRtxTimerDelete</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id)</td></tr> +<tr class="memdesc:gaea5811cc74861117eccbcbb997d36133"><td class="mdescLeft"> </td><td class="mdescRight">Event on timer delete (API) <a href="#gaea5811cc74861117eccbcbb997d36133">More...</a><br/></td></tr> +<tr class="separator:gaea5811cc74861117eccbcbb997d36133"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga474f3bd3ed38945b087f37fd709560b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__timer.html#ga474f3bd3ed38945b087f37fd709560b7">EvrRtxTimerDestroyed</a> (<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> timer_id)</td></tr> +<tr class="memdesc:ga474f3bd3ed38945b087f37fd709560b7"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful timer delete (Op) <a href="#ga474f3bd3ed38945b087f37fd709560b7">More...</a><br/></td></tr> +<tr class="separator:ga474f3bd3ed38945b087f37fd709560b7"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Description</h2> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="gaf1b516bf697288e67fe797662b1873b0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerError </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>status</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a> or NULL when ID is unknown. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerError</b> is generated when <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html">Timer Management</a> routines complete their execution due to an error.</p> +<p>The status parameter indicates the execution status and can be one of the <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t codes</a> or one of the extended execution status codes which are summarized in the table below.</p> +<table class="doxtable"> +<tr> +<th align="left">Extended Status Code </th><th align="left">Description </th></tr> +<tr> +<td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr> +<tr> +<td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr> +<tr> +<td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr> +<tr> +<td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr> +<tr> +<td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr> +<tr> +<td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr> +<tr> +<td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr> +</table> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID.</li> +<li><b>status</b> : execution status code. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gacd46f9d31d256c27c72e47d5be5e9d09"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerCallback </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaacf768c1ec64b020598afb985d7b30be">osTimerFunc_t</a> </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>argument</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>start address of a timer call back function. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">argument</td><td>argument to the timer call back function.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerCallback</b> is generated when the timer callback function is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>func</b> : start address of a timer call back function.</li> +<li><b>argument</b> : memory address of argument to the timer call back function. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga6387808c22d6e186057ed744618d2487"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerNew </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaacf768c1ec64b020598afb985d7b30be">osTimerFunc_t</a> </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#ga7dc24a4c2b90334427081c3da7a71915">osTimerType_t</a> </td> + <td class="paramname"><em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>argument</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#structosTimerAttr__t">osTimerAttr_t</a> * </td> + <td class="paramname"><em>attr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>start address of a timer call back function. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">argument</td><td>argument to the timer call back function. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>timer attributes.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>func</b> : start address of a timer call back function.</li> +<li><b>type</b> : timer type: osTimerOnce for one-shot or osTimerPeriodic for periodic behavior.</li> +<li><b>argument</b> : memory address of argument to the timer call back function.</li> +<li><b>attr</b> : memory address of Timer attributes or 0 when they are not specified.</li> +</ul> +<p>In case when <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#structosTimerAttr__t">timer attributes</a> are provided in the API call they are also detailed in the Event Recorder. </p> + +</div> +</div> +<a class="anchor" id="ga71dd40a818f1098052915bbfb6c17e88"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerCreated </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to timer object name.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a> successfully creates a timer object.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga601e3617903900524062c4f9069d052f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerGetName </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to timer object name.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#ga4f82a98eee4d9ea79507e44340d3d319">osTimerGetName</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID.</li> +<li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga453d82bfa65dfbbaffbd5b4ff4f050b2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerStart </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>ticks</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">ticks</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value of the timer.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerStart</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gab6ee2859ea657641b7adfac599b8121d">osTimerStart</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID.</li> +<li><b>ticks</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value of the timer. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gab0dbdf460fc26b25f3987c44fb0ebdeb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerStarted </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerStarted</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gab6ee2859ea657641b7adfac599b8121d">osTimerStart</a> successfully starts or restarts the timer operation.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga27cf05adc61d30a0e68f380c96ea5f93"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerStop </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerStop</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gabd7a89356da7717293eb0bc5d87b8ac9">osTimerStop</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaccd59c7ae2351e0a1bf96cdb749c049f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerStopped </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerStopped</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gabd7a89356da7717293eb0bc5d87b8ac9">osTimerStop</a> successfully stops the timer operation.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga6fa5a23f241d765ae22ff1862c6f3b3f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerIsRunning </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>running</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">running</td><td>running state: 0 not running, 1 running.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerIsRunning</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#ga69d3589f54194022c30dd01e45ec6741">osTimerIsRunning</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID.</li> +<li><b>running</b> : timer running state: 0 not running, 1 running. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaea5811cc74861117eccbcbb997d36133"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerDelete </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad0001dd74721ab461789324806db2453">osTimerDelete</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga474f3bd3ed38945b087f37fd709560b7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxTimerDestroyed </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a> </td> + <td class="paramname"><em>timer_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timer_id</td><td>timer ID obtained by <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec">osTimerNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>TimerDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad0001dd74721ab461789324806db2453">osTimerDelete</a> successfully deletes the timer object.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>timer_id</b> : timer ID. </li> +</ul> + +</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="footer">Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 by Arm Ltd. All rights reserved. + <!-- + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 + --> + </li> + </ul> +</div> +</body> +</html> |