group__rtx__evr__timer.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636
  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">
  3. <head>
  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-RTOS2: 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);
  19. </script>
  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); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  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-RTOS2
  35. &#160;<span id="projectnumber">Version 2.1.3</span>
  36. </div>
  37. <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  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>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__rtx__evr__timer.html','');});
  93. </script>
  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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Timer Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Events generated by timer functions.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  118. Functions</h2></td></tr>
  119. <tr class="memitem:gaf1b516bf697288e67fe797662b1873b0"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  120. <tr class="memdesc:gaf1b516bf697288e67fe797662b1873b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer error (Error) <a href="#gaf1b516bf697288e67fe797662b1873b0">More...</a><br/></td></tr>
  121. <tr class="separator:gaf1b516bf697288e67fe797662b1873b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gacd46f9d31d256c27c72e47d5be5e9d09"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  123. <tr class="memdesc:gacd46f9d31d256c27c72e47d5be5e9d09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer callback call (Op) <a href="#gacd46f9d31d256c27c72e47d5be5e9d09">More...</a><br/></td></tr>
  124. <tr class="separator:gacd46f9d31d256c27c72e47d5be5e9d09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ga6387808c22d6e186057ed744618d2487"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  126. <tr class="memdesc:ga6387808c22d6e186057ed744618d2487"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer create and initialize (API) <a href="#ga6387808c22d6e186057ed744618d2487">More...</a><br/></td></tr>
  127. <tr class="separator:ga6387808c22d6e186057ed744618d2487"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ga71dd40a818f1098052915bbfb6c17e88"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  129. <tr class="memdesc:ga71dd40a818f1098052915bbfb6c17e88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful timer create (Op) <a href="#ga71dd40a818f1098052915bbfb6c17e88">More...</a><br/></td></tr>
  130. <tr class="separator:ga71dd40a818f1098052915bbfb6c17e88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga601e3617903900524062c4f9069d052f"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  132. <tr class="memdesc:ga601e3617903900524062c4f9069d052f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer name retrieve (API) <a href="#ga601e3617903900524062c4f9069d052f">More...</a><br/></td></tr>
  133. <tr class="separator:ga601e3617903900524062c4f9069d052f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ga453d82bfa65dfbbaffbd5b4ff4f050b2"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  135. <tr class="memdesc:ga453d82bfa65dfbbaffbd5b4ff4f050b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer start (API) <a href="#ga453d82bfa65dfbbaffbd5b4ff4f050b2">More...</a><br/></td></tr>
  136. <tr class="separator:ga453d82bfa65dfbbaffbd5b4ff4f050b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:gab0dbdf460fc26b25f3987c44fb0ebdeb"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  138. <tr class="memdesc:gab0dbdf460fc26b25f3987c44fb0ebdeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful timer start (Op) <a href="#gab0dbdf460fc26b25f3987c44fb0ebdeb">More...</a><br/></td></tr>
  139. <tr class="separator:gab0dbdf460fc26b25f3987c44fb0ebdeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ga27cf05adc61d30a0e68f380c96ea5f93"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  141. <tr class="memdesc:ga27cf05adc61d30a0e68f380c96ea5f93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer stop (API) <a href="#ga27cf05adc61d30a0e68f380c96ea5f93">More...</a><br/></td></tr>
  142. <tr class="separator:ga27cf05adc61d30a0e68f380c96ea5f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:gaccd59c7ae2351e0a1bf96cdb749c049f"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  144. <tr class="memdesc:gaccd59c7ae2351e0a1bf96cdb749c049f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful timer stop (Op) <a href="#gaccd59c7ae2351e0a1bf96cdb749c049f">More...</a><br/></td></tr>
  145. <tr class="separator:gaccd59c7ae2351e0a1bf96cdb749c049f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ga6fa5a23f241d765ae22ff1862c6f3b3f"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  147. <tr class="memdesc:ga6fa5a23f241d765ae22ff1862c6f3b3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer running state check (API) <a href="#ga6fa5a23f241d765ae22ff1862c6f3b3f">More...</a><br/></td></tr>
  148. <tr class="separator:ga6fa5a23f241d765ae22ff1862c6f3b3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:gaea5811cc74861117eccbcbb997d36133"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  150. <tr class="memdesc:gaea5811cc74861117eccbcbb997d36133"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer delete (API) <a href="#gaea5811cc74861117eccbcbb997d36133">More...</a><br/></td></tr>
  151. <tr class="separator:gaea5811cc74861117eccbcbb997d36133"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ga474f3bd3ed38945b087f37fd709560b7"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  153. <tr class="memdesc:ga474f3bd3ed38945b087f37fd709560b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful timer delete (Op) <a href="#ga474f3bd3ed38945b087f37fd709560b7">More...</a><br/></td></tr>
  154. <tr class="separator:ga474f3bd3ed38945b087f37fd709560b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table>
  156. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  157. <h2 class="groupheader">Function Documentation</h2>
  158. <a class="anchor" id="gaf1b516bf697288e67fe797662b1873b0"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">void EvrRtxTimerError </td>
  164. <td>(</td>
  165. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  166. <td class="paramname"><em>timer_id</em>, </td>
  167. </tr>
  168. <tr>
  169. <td class="paramkey"></td>
  170. <td></td>
  171. <td class="paramtype">int32_t&#160;</td>
  172. <td class="paramname"><em>status</em>&#160;</td>
  173. </tr>
  174. <tr>
  175. <td></td>
  176. <td>)</td>
  177. <td></td><td></td>
  178. </tr>
  179. </table>
  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">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>
  184. <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  185. </table>
  186. </dd>
  187. </dl>
  188. <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>
  189. <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>
  190. <table class="doxtable">
  191. <tr>
  192. <th align="left">Extended Status Code </th><th align="left">Description </th></tr>
  193. <tr>
  194. <td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr>
  195. <tr>
  196. <td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr>
  197. <tr>
  198. <td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr>
  199. <tr>
  200. <td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr>
  201. <tr>
  202. <td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr>
  203. <tr>
  204. <td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr>
  205. <tr>
  206. <td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr>
  207. <tr>
  208. <td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr>
  209. <tr>
  210. <td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr>
  211. <tr>
  212. <td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr>
  213. <tr>
  214. <td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr>
  215. <tr>
  216. <td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr>
  217. <tr>
  218. <td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr>
  219. <tr>
  220. <td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr>
  221. <tr>
  222. <td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr>
  223. <tr>
  224. <td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr>
  225. </table>
  226. <p><b>Value</b> in the Event Recorder shows:</p>
  227. <ul>
  228. <li><b>timer_id</b> : timer ID.</li>
  229. <li><b>status</b> : execution status code. </li>
  230. </ul>
  231. </div>
  232. </div>
  233. <a class="anchor" id="gacd46f9d31d256c27c72e47d5be5e9d09"></a>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">void EvrRtxTimerCallback </td>
  239. <td>(</td>
  240. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaacf768c1ec64b020598afb985d7b30be">osTimerFunc_t</a>&#160;</td>
  241. <td class="paramname"><em>func</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">void *&#160;</td>
  247. <td class="paramname"><em>argument</em>&#160;</td>
  248. </tr>
  249. <tr>
  250. <td></td>
  251. <td>)</td>
  252. <td></td><td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <dl class="params"><dt>Parameters</dt><dd>
  257. <table class="params">
  258. <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>start address of a timer call back function. </td></tr>
  259. <tr><td class="paramdir">[in]</td><td class="paramname">argument</td><td>argument to the timer call back function.</td></tr>
  260. </table>
  261. </dd>
  262. </dl>
  263. <p>The event <b>TimerCallback</b> is generated when the timer callback function is called.</p>
  264. <p><b>Value</b> in the Event Recorder shows:</p>
  265. <ul>
  266. <li><b>func</b> : start address of a timer call back function.</li>
  267. <li><b>argument</b> : memory address of argument to the timer call back function. </li>
  268. </ul>
  269. </div>
  270. </div>
  271. <a class="anchor" id="ga6387808c22d6e186057ed744618d2487"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">void EvrRtxTimerNew </td>
  277. <td>(</td>
  278. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaacf768c1ec64b020598afb985d7b30be">osTimerFunc_t</a>&#160;</td>
  279. <td class="paramname"><em>func</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#ga7dc24a4c2b90334427081c3da7a71915">osTimerType_t</a>&#160;</td>
  285. <td class="paramname"><em>type</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">void *&#160;</td>
  291. <td class="paramname"><em>argument</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#structosTimerAttr__t">osTimerAttr_t</a> *&#160;</td>
  297. <td class="paramname"><em>attr</em>&#160;</td>
  298. </tr>
  299. <tr>
  300. <td></td>
  301. <td>)</td>
  302. <td></td><td></td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <dl class="params"><dt>Parameters</dt><dd>
  307. <table class="params">
  308. <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>start address of a timer call back function. </td></tr>
  309. <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. </td></tr>
  310. <tr><td class="paramdir">[in]</td><td class="paramname">argument</td><td>argument to the timer call back function. </td></tr>
  311. <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>timer attributes.</td></tr>
  312. </table>
  313. </dd>
  314. </dl>
  315. <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>
  316. <p><b>Value</b> in the Event Recorder shows:</p>
  317. <ul>
  318. <li><b>func</b> : start address of a timer call back function.</li>
  319. <li><b>type</b> : timer type: osTimerOnce for one-shot or osTimerPeriodic for periodic behavior.</li>
  320. <li><b>argument</b> : memory address of argument to the timer call back function.</li>
  321. <li><b>attr</b> : memory address of Timer attributes or 0 when they are not specified.</li>
  322. </ul>
  323. <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>
  324. </div>
  325. </div>
  326. <a class="anchor" id="ga71dd40a818f1098052915bbfb6c17e88"></a>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">void EvrRtxTimerCreated </td>
  332. <td>(</td>
  333. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  334. <td class="paramname"><em>timer_id</em>, </td>
  335. </tr>
  336. <tr>
  337. <td class="paramkey"></td>
  338. <td></td>
  339. <td class="paramtype">const char *&#160;</td>
  340. <td class="paramname"><em>name</em>&#160;</td>
  341. </tr>
  342. <tr>
  343. <td></td>
  344. <td>)</td>
  345. <td></td><td></td>
  346. </tr>
  347. </table>
  348. </div><div class="memdoc">
  349. <dl class="params"><dt>Parameters</dt><dd>
  350. <table class="params">
  351. <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>
  352. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to timer object name.</td></tr>
  353. </table>
  354. </dd>
  355. </dl>
  356. <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>
  357. <p><b>Value</b> in the Event Recorder shows:</p>
  358. <ul>
  359. <li><b>timer_id</b> : timer ID. </li>
  360. </ul>
  361. </div>
  362. </div>
  363. <a class="anchor" id="ga601e3617903900524062c4f9069d052f"></a>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname">void EvrRtxTimerGetName </td>
  369. <td>(</td>
  370. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  371. <td class="paramname"><em>timer_id</em>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype">const char *&#160;</td>
  377. <td class="paramname"><em>name</em>&#160;</td>
  378. </tr>
  379. <tr>
  380. <td></td>
  381. <td>)</td>
  382. <td></td><td></td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <dl class="params"><dt>Parameters</dt><dd>
  387. <table class="params">
  388. <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>
  389. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to timer object name.</td></tr>
  390. </table>
  391. </dd>
  392. </dl>
  393. <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>
  394. <p><b>Value</b> in the Event Recorder shows:</p>
  395. <ul>
  396. <li><b>timer_id</b> : timer ID.</li>
  397. <li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li>
  398. </ul>
  399. </div>
  400. </div>
  401. <a class="anchor" id="ga453d82bfa65dfbbaffbd5b4ff4f050b2"></a>
  402. <div class="memitem">
  403. <div class="memproto">
  404. <table class="memname">
  405. <tr>
  406. <td class="memname">void EvrRtxTimerStart </td>
  407. <td>(</td>
  408. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  409. <td class="paramname"><em>timer_id</em>, </td>
  410. </tr>
  411. <tr>
  412. <td class="paramkey"></td>
  413. <td></td>
  414. <td class="paramtype">uint32_t&#160;</td>
  415. <td class="paramname"><em>ticks</em>&#160;</td>
  416. </tr>
  417. <tr>
  418. <td></td>
  419. <td>)</td>
  420. <td></td><td></td>
  421. </tr>
  422. </table>
  423. </div><div class="memdoc">
  424. <dl class="params"><dt>Parameters</dt><dd>
  425. <table class="params">
  426. <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>
  427. <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>
  428. </table>
  429. </dd>
  430. </dl>
  431. <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>
  432. <p><b>Value</b> in the Event Recorder shows:</p>
  433. <ul>
  434. <li><b>timer_id</b> : timer ID.</li>
  435. <li><b>ticks</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value of the timer. </li>
  436. </ul>
  437. </div>
  438. </div>
  439. <a class="anchor" id="gab0dbdf460fc26b25f3987c44fb0ebdeb"></a>
  440. <div class="memitem">
  441. <div class="memproto">
  442. <table class="memname">
  443. <tr>
  444. <td class="memname">void EvrRtxTimerStarted </td>
  445. <td>(</td>
  446. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  447. <td class="paramname"><em>timer_id</em></td><td>)</td>
  448. <td></td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <dl class="params"><dt>Parameters</dt><dd>
  453. <table class="params">
  454. <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>
  455. </table>
  456. </dd>
  457. </dl>
  458. <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>
  459. <p><b>Value</b> in the Event Recorder shows:</p>
  460. <ul>
  461. <li><b>timer_id</b> : timer ID. </li>
  462. </ul>
  463. </div>
  464. </div>
  465. <a class="anchor" id="ga27cf05adc61d30a0e68f380c96ea5f93"></a>
  466. <div class="memitem">
  467. <div class="memproto">
  468. <table class="memname">
  469. <tr>
  470. <td class="memname">void EvrRtxTimerStop </td>
  471. <td>(</td>
  472. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  473. <td class="paramname"><em>timer_id</em></td><td>)</td>
  474. <td></td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. <dl class="params"><dt>Parameters</dt><dd>
  479. <table class="params">
  480. <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>
  481. </table>
  482. </dd>
  483. </dl>
  484. <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>
  485. <p><b>Value</b> in the Event Recorder shows:</p>
  486. <ul>
  487. <li><b>timer_id</b> : timer ID. </li>
  488. </ul>
  489. </div>
  490. </div>
  491. <a class="anchor" id="gaccd59c7ae2351e0a1bf96cdb749c049f"></a>
  492. <div class="memitem">
  493. <div class="memproto">
  494. <table class="memname">
  495. <tr>
  496. <td class="memname">void EvrRtxTimerStopped </td>
  497. <td>(</td>
  498. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  499. <td class="paramname"><em>timer_id</em></td><td>)</td>
  500. <td></td>
  501. </tr>
  502. </table>
  503. </div><div class="memdoc">
  504. <dl class="params"><dt>Parameters</dt><dd>
  505. <table class="params">
  506. <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>
  507. </table>
  508. </dd>
  509. </dl>
  510. <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>
  511. <p><b>Value</b> in the Event Recorder shows:</p>
  512. <ul>
  513. <li><b>timer_id</b> : timer ID. </li>
  514. </ul>
  515. </div>
  516. </div>
  517. <a class="anchor" id="ga6fa5a23f241d765ae22ff1862c6f3b3f"></a>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname">void EvrRtxTimerIsRunning </td>
  523. <td>(</td>
  524. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  525. <td class="paramname"><em>timer_id</em>, </td>
  526. </tr>
  527. <tr>
  528. <td class="paramkey"></td>
  529. <td></td>
  530. <td class="paramtype">uint32_t&#160;</td>
  531. <td class="paramname"><em>running</em>&#160;</td>
  532. </tr>
  533. <tr>
  534. <td></td>
  535. <td>)</td>
  536. <td></td><td></td>
  537. </tr>
  538. </table>
  539. </div><div class="memdoc">
  540. <dl class="params"><dt>Parameters</dt><dd>
  541. <table class="params">
  542. <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>
  543. <tr><td class="paramdir">[in]</td><td class="paramname">running</td><td>running state: 0 not running, 1 running.</td></tr>
  544. </table>
  545. </dd>
  546. </dl>
  547. <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>
  548. <p><b>Value</b> in the Event Recorder shows:</p>
  549. <ul>
  550. <li><b>timer_id</b> : timer ID.</li>
  551. <li><b>running</b> : timer running state: 0 not running, 1 running. </li>
  552. </ul>
  553. </div>
  554. </div>
  555. <a class="anchor" id="gaea5811cc74861117eccbcbb997d36133"></a>
  556. <div class="memitem">
  557. <div class="memproto">
  558. <table class="memname">
  559. <tr>
  560. <td class="memname">void EvrRtxTimerDelete </td>
  561. <td>(</td>
  562. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  563. <td class="paramname"><em>timer_id</em></td><td>)</td>
  564. <td></td>
  565. </tr>
  566. </table>
  567. </div><div class="memdoc">
  568. <dl class="params"><dt>Parameters</dt><dd>
  569. <table class="params">
  570. <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>
  571. </table>
  572. </dd>
  573. </dl>
  574. <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>
  575. <p><b>Value</b> in the Event Recorder shows:</p>
  576. <ul>
  577. <li><b>timer_id</b> : timer ID. </li>
  578. </ul>
  579. </div>
  580. </div>
  581. <a class="anchor" id="ga474f3bd3ed38945b087f37fd709560b7"></a>
  582. <div class="memitem">
  583. <div class="memproto">
  584. <table class="memname">
  585. <tr>
  586. <td class="memname">void EvrRtxTimerDestroyed </td>
  587. <td>(</td>
  588. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>&#160;</td>
  589. <td class="paramname"><em>timer_id</em></td><td>)</td>
  590. <td></td>
  591. </tr>
  592. </table>
  593. </div><div class="memdoc">
  594. <dl class="params"><dt>Parameters</dt><dd>
  595. <table class="params">
  596. <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>
  597. </table>
  598. </dd>
  599. </dl>
  600. <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>
  601. <p><b>Value</b> in the Event Recorder shows:</p>
  602. <ul>
  603. <li><b>timer_id</b> : timer ID. </li>
  604. </ul>
  605. </div>
  606. </div>
  607. </div><!-- contents -->
  608. </div><!-- doc-content -->
  609. <!-- start footer part -->
  610. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  611. <ul>
  612. <li class="footer">Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  613. <!--
  614. <a href="http://www.doxygen.org/index.html">
  615. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  616. -->
  617. </li>
  618. </ul>
  619. </div>
  620. </body>
  621. </html>