group__rtx__evr__kernel.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788
  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>Kernel Functions</title>
  7. <title>CMSIS-RTOS2: Kernel 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__kernel.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">Kernel 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 kernel 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:ga2a38154886e6293e127bafcfb6f7d609"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga2a38154886e6293e127bafcfb6f7d609">EvrRtxKernelError</a> (int32_t status)</td></tr>
  120. <tr class="memdesc:ga2a38154886e6293e127bafcfb6f7d609"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS kernel error (Error) <a href="#ga2a38154886e6293e127bafcfb6f7d609">More...</a><br/></td></tr>
  121. <tr class="separator:ga2a38154886e6293e127bafcfb6f7d609"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ga7e84d337b452f647c3a3d6937abd6292"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga7e84d337b452f647c3a3d6937abd6292">EvrRtxKernelInitialize</a> (void)</td></tr>
  123. <tr class="memdesc:ga7e84d337b452f647c3a3d6937abd6292"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS kernel initialize (API) <a href="#ga7e84d337b452f647c3a3d6937abd6292">More...</a><br/></td></tr>
  124. <tr class="separator:ga7e84d337b452f647c3a3d6937abd6292"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ga5db8d306617656bfec12638e17584d66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga5db8d306617656bfec12638e17584d66">EvrRtxKernelInitialized</a> (void)</td></tr>
  126. <tr class="memdesc:ga5db8d306617656bfec12638e17584d66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS kernel initialize (Op) <a href="#ga5db8d306617656bfec12638e17584d66">More...</a><br/></td></tr>
  127. <tr class="separator:ga5db8d306617656bfec12638e17584d66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ga4c2a175b79d39d70a4a5112e270d03f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga4c2a175b79d39d70a4a5112e270d03f2">EvrRtxKernelGetInfo</a> (<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> *version, char *id_buf, uint32_t id_size)</td></tr>
  129. <tr class="memdesc:ga4c2a175b79d39d70a4a5112e270d03f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS kernel information retrieve (API) <a href="#ga4c2a175b79d39d70a4a5112e270d03f2">More...</a><br/></td></tr>
  130. <tr class="separator:ga4c2a175b79d39d70a4a5112e270d03f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:gaf09b8cd94ad2384e3ab518f0df94a651"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gaf09b8cd94ad2384e3ab518f0df94a651">EvrRtxKernelInfoRetrieved</a> (<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> *version, char *id_buf)</td></tr>
  132. <tr class="memdesc:gaf09b8cd94ad2384e3ab518f0df94a651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS kernel information retrieve (Op) <a href="#gaf09b8cd94ad2384e3ab518f0df94a651">More...</a><br/></td></tr>
  133. <tr class="separator:gaf09b8cd94ad2384e3ab518f0df94a651"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:gad6407e9ff0910629b041866bd801075a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gad6407e9ff0910629b041866bd801075a">EvrRtxKernelGetState</a> (<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a> state)</td></tr>
  135. <tr class="memdesc:gad6407e9ff0910629b041866bd801075a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on current RTOS Kernel state retrieve (API) <a href="#gad6407e9ff0910629b041866bd801075a">More...</a><br/></td></tr>
  136. <tr class="separator:gad6407e9ff0910629b041866bd801075a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ga75937a761dd488600d2525a532808d2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga75937a761dd488600d2525a532808d2b">EvrRtxKernelStart</a> (void)</td></tr>
  138. <tr class="memdesc:ga75937a761dd488600d2525a532808d2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS Kernel scheduler start (API) <a href="#ga75937a761dd488600d2525a532808d2b">More...</a><br/></td></tr>
  139. <tr class="separator:ga75937a761dd488600d2525a532808d2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ga28043ffc76fec09e6c8763a9a71b7f2a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga28043ffc76fec09e6c8763a9a71b7f2a">EvrRtxKernelStarted</a> (void)</td></tr>
  141. <tr class="memdesc:ga28043ffc76fec09e6c8763a9a71b7f2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS Kernel scheduler start (Op) <a href="#ga28043ffc76fec09e6c8763a9a71b7f2a">More...</a><br/></td></tr>
  142. <tr class="separator:ga28043ffc76fec09e6c8763a9a71b7f2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ga1d0340812c29274c6150fa72288e0612"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga1d0340812c29274c6150fa72288e0612">EvrRtxKernelLock</a> (void)</td></tr>
  144. <tr class="memdesc:ga1d0340812c29274c6150fa72288e0612"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS Kernel scheduler lock (API) <a href="#ga1d0340812c29274c6150fa72288e0612">More...</a><br/></td></tr>
  145. <tr class="separator:ga1d0340812c29274c6150fa72288e0612"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:gac18ea91ffcae01e893304609a3c6cdc3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gac18ea91ffcae01e893304609a3c6cdc3">EvrRtxKernelLocked</a> (int32_t lock)</td></tr>
  147. <tr class="memdesc:gac18ea91ffcae01e893304609a3c6cdc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS Kernel scheduler lock (Op) <a href="#gac18ea91ffcae01e893304609a3c6cdc3">More...</a><br/></td></tr>
  148. <tr class="separator:gac18ea91ffcae01e893304609a3c6cdc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:gabe14acf14ed2611a3ba1f3b280fbfd8c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gabe14acf14ed2611a3ba1f3b280fbfd8c">EvrRtxKernelUnlock</a> (void)</td></tr>
  150. <tr class="memdesc:gabe14acf14ed2611a3ba1f3b280fbfd8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS Kernel scheduler unlock (API) <a href="#gabe14acf14ed2611a3ba1f3b280fbfd8c">More...</a><br/></td></tr>
  151. <tr class="separator:gabe14acf14ed2611a3ba1f3b280fbfd8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ga5cc909465e8df09c9231782e0c45e374"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga5cc909465e8df09c9231782e0c45e374">EvrRtxKernelUnlocked</a> (int32_t lock)</td></tr>
  153. <tr class="memdesc:ga5cc909465e8df09c9231782e0c45e374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS Kernel scheduler unlock (Op) <a href="#ga5cc909465e8df09c9231782e0c45e374">More...</a><br/></td></tr>
  154. <tr class="separator:ga5cc909465e8df09c9231782e0c45e374"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ga812fdd14d6c40072cc40aec742d4869e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga812fdd14d6c40072cc40aec742d4869e">EvrRtxKernelRestoreLock</a> (int32_t lock)</td></tr>
  156. <tr class="memdesc:ga812fdd14d6c40072cc40aec742d4869e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS Kernel scheduler lock state restore (API) <a href="#ga812fdd14d6c40072cc40aec742d4869e">More...</a><br/></td></tr>
  157. <tr class="separator:ga812fdd14d6c40072cc40aec742d4869e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:gaf7be1022a33c13fb44f4059f5636b75a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gaf7be1022a33c13fb44f4059f5636b75a">EvrRtxKernelLockRestored</a> (int32_t lock)</td></tr>
  159. <tr class="memdesc:gaf7be1022a33c13fb44f4059f5636b75a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS Kernel scheduler lock state restore (Op) <a href="#gaf7be1022a33c13fb44f4059f5636b75a">More...</a><br/></td></tr>
  160. <tr class="separator:gaf7be1022a33c13fb44f4059f5636b75a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:gac3abd78a9d3f3a6adc698e2929e1c32c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gac3abd78a9d3f3a6adc698e2929e1c32c">EvrRtxKernelSuspend</a> (void)</td></tr>
  162. <tr class="memdesc:gac3abd78a9d3f3a6adc698e2929e1c32c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS Kernel scheduler suspend (API) <a href="#gac3abd78a9d3f3a6adc698e2929e1c32c">More...</a><br/></td></tr>
  163. <tr class="separator:gac3abd78a9d3f3a6adc698e2929e1c32c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:gabdaa26d7774111af4913b5d6669d0f85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gabdaa26d7774111af4913b5d6669d0f85">EvrRtxKernelSuspended</a> (uint32_t sleep_ticks)</td></tr>
  165. <tr class="memdesc:gabdaa26d7774111af4913b5d6669d0f85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS Kernel scheduler suspend (Op) <a href="#gabdaa26d7774111af4913b5d6669d0f85">More...</a><br/></td></tr>
  166. <tr class="separator:gabdaa26d7774111af4913b5d6669d0f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ga9a8cac0fed8d3cf06f7301c944ad26d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga9a8cac0fed8d3cf06f7301c944ad26d1">EvrRtxKernelResume</a> (uint32_t sleep_ticks)</td></tr>
  168. <tr class="memdesc:ga9a8cac0fed8d3cf06f7301c944ad26d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS Kernel scheduler resume (API) <a href="#ga9a8cac0fed8d3cf06f7301c944ad26d1">More...</a><br/></td></tr>
  169. <tr class="separator:ga9a8cac0fed8d3cf06f7301c944ad26d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ga26e0a22f49576824d853fb434cf6b079"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga26e0a22f49576824d853fb434cf6b079">EvrRtxKernelResumed</a> (void)</td></tr>
  171. <tr class="memdesc:ga26e0a22f49576824d853fb434cf6b079"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful RTOS Kernel scheduler resume (Op) <a href="#ga26e0a22f49576824d853fb434cf6b079">More...</a><br/></td></tr>
  172. <tr class="separator:ga26e0a22f49576824d853fb434cf6b079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:ga64431a63437506a6f7fe22637d4891c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga64431a63437506a6f7fe22637d4891c5">EvrRtxKernelGetTickCount</a> (uint32_t count)</td></tr>
  174. <tr class="memdesc:ga64431a63437506a6f7fe22637d4891c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS kernel tick count retrieve (API) <a href="#ga64431a63437506a6f7fe22637d4891c5">More...</a><br/></td></tr>
  175. <tr class="separator:ga64431a63437506a6f7fe22637d4891c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:ga7404f3a22af84ad4091c24811fc1bf87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#ga7404f3a22af84ad4091c24811fc1bf87">EvrRtxKernelGetTickFreq</a> (uint32_t freq)</td></tr>
  177. <tr class="memdesc:ga7404f3a22af84ad4091c24811fc1bf87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS kernel tick frequency retrieve (API) <a href="#ga7404f3a22af84ad4091c24811fc1bf87">More...</a><br/></td></tr>
  178. <tr class="separator:ga7404f3a22af84ad4091c24811fc1bf87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:gafb6530be8201b119015a3f45d66c2f09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gafb6530be8201b119015a3f45d66c2f09">EvrRtxKernelGetSysTimerCount</a> (uint32_t count)</td></tr>
  180. <tr class="memdesc:gafb6530be8201b119015a3f45d66c2f09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS kernel system timer count retrieve (API) <a href="#gafb6530be8201b119015a3f45d66c2f09">More...</a><br/></td></tr>
  181. <tr class="separator:gafb6530be8201b119015a3f45d66c2f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:gaf2bdfcb7b099295c7b0123abe88e10a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__kernel.html#gaf2bdfcb7b099295c7b0123abe88e10a3">EvrRtxKernelGetSysTimerFreq</a> (uint32_t freq)</td></tr>
  183. <tr class="memdesc:gaf2bdfcb7b099295c7b0123abe88e10a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on RTOS kernel system timer frequency retrieve (API) <a href="#gaf2bdfcb7b099295c7b0123abe88e10a3">More...</a><br/></td></tr>
  184. <tr class="separator:gaf2bdfcb7b099295c7b0123abe88e10a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. </table>
  186. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  187. <h2 class="groupheader">Function Documentation</h2>
  188. <a class="anchor" id="ga2a38154886e6293e127bafcfb6f7d609"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">void EvrRtxKernelError </td>
  194. <td>(</td>
  195. <td class="paramtype">int32_t&#160;</td>
  196. <td class="paramname"><em>status</em></td><td>)</td>
  197. <td></td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <dl class="params"><dt>Parameters</dt><dd>
  202. <table class="params">
  203. <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  204. </table>
  205. </dd>
  206. </dl>
  207. <p>The event <b>KernelError</b> is generated when <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html">Kernel Information and Control</a> routines complete their execution due to an error.</p>
  208. <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>
  209. <table class="doxtable">
  210. <tr>
  211. <th align="left">Extended Status Code </th><th align="left">Description </th></tr>
  212. <tr>
  213. <td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr>
  214. <tr>
  215. <td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr>
  216. <tr>
  217. <td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr>
  218. <tr>
  219. <td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr>
  220. <tr>
  221. <td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr>
  222. <tr>
  223. <td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr>
  224. <tr>
  225. <td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr>
  226. <tr>
  227. <td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr>
  228. <tr>
  229. <td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr>
  230. <tr>
  231. <td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr>
  232. <tr>
  233. <td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr>
  234. <tr>
  235. <td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr>
  236. <tr>
  237. <td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr>
  238. <tr>
  239. <td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr>
  240. <tr>
  241. <td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr>
  242. <tr>
  243. <td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr>
  244. </table>
  245. <p><b>Value</b> in the Event Recorder shows:</p>
  246. <ul>
  247. <li><b>status</b> : execution status code. </li>
  248. </ul>
  249. </div>
  250. </div>
  251. <a class="anchor" id="ga7e84d337b452f647c3a3d6937abd6292"></a>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">void EvrRtxKernelInitialize </td>
  257. <td>(</td>
  258. <td class="paramtype">void&#160;</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>The event <b>KernelInitialize</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a> is called. </p>
  265. </div>
  266. </div>
  267. <a class="anchor" id="ga5db8d306617656bfec12638e17584d66"></a>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">void EvrRtxKernelInitialized </td>
  273. <td>(</td>
  274. <td class="paramtype">void&#160;</td>
  275. <td class="paramname"></td><td>)</td>
  276. <td></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>The event <b>KernelInitialized</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a> successfully initializes the RTOS kernel. </p>
  281. </div>
  282. </div>
  283. <a class="anchor" id="ga4c2a175b79d39d70a4a5112e270d03f2"></a>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">void EvrRtxKernelGetInfo </td>
  289. <td>(</td>
  290. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> *&#160;</td>
  291. <td class="paramname"><em>version</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">char *&#160;</td>
  297. <td class="paramname"><em>id_buf</em>, </td>
  298. </tr>
  299. <tr>
  300. <td class="paramkey"></td>
  301. <td></td>
  302. <td class="paramtype">uint32_t&#160;</td>
  303. <td class="paramname"><em>id_size</em>&#160;</td>
  304. </tr>
  305. <tr>
  306. <td></td>
  307. <td>)</td>
  308. <td></td><td></td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. <dl class="params"><dt>Parameters</dt><dd>
  313. <table class="params">
  314. <tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>pointer to buffer for retrieving version information. </td></tr>
  315. <tr><td class="paramdir">[in]</td><td class="paramname">id_buf</td><td>pointer to buffer for retrieving kernel identification string. </td></tr>
  316. <tr><td class="paramdir">[in]</td><td class="paramname">id_size</td><td>size of buffer for kernel identification string.</td></tr>
  317. </table>
  318. </dd>
  319. </dl>
  320. <p>The event <b>KernelGetInfo</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a> is called.</p>
  321. <p><b>Value</b> in the Event Recorder shows:</p>
  322. <ul>
  323. <li><b>version</b> : memory address of buffer for retrieving version information.</li>
  324. <li><b>id_buf</b> : memory address of buffer for retrieving kernel identification string.</li>
  325. <li><b>id_size</b> : size of id_buf in bytes. </li>
  326. </ul>
  327. </div>
  328. </div>
  329. <a class="anchor" id="gaf09b8cd94ad2384e3ab518f0df94a651"></a>
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname">void EvrRtxKernelInfoRetrieved </td>
  335. <td>(</td>
  336. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> *&#160;</td>
  337. <td class="paramname"><em>version</em>, </td>
  338. </tr>
  339. <tr>
  340. <td class="paramkey"></td>
  341. <td></td>
  342. <td class="paramtype">char *&#160;</td>
  343. <td class="paramname"><em>id_buf</em>&#160;</td>
  344. </tr>
  345. <tr>
  346. <td></td>
  347. <td>)</td>
  348. <td></td><td></td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <dl class="params"><dt>Parameters</dt><dd>
  353. <table class="params">
  354. <tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>pointer to buffer for retrieving version information. </td></tr>
  355. <tr><td class="paramdir">[in]</td><td class="paramname">id_buf</td><td>pointer to buffer for retrieving kernel identification string.</td></tr>
  356. </table>
  357. </dd>
  358. </dl>
  359. <p>The event <b>KernelInfoRetrieved</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a> successfully retrieves kernel information.</p>
  360. <p><b>Value</b> in the Event Recorder shows:</p>
  361. <ul>
  362. <li><b>version</b> : memory address of buffer for retrieving version information.</li>
  363. <li><b>id_buf</b> : memory address of buffer for retrieving kernel identification string. </li>
  364. </ul>
  365. </div>
  366. </div>
  367. <a class="anchor" id="gad6407e9ff0910629b041866bd801075a"></a>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="memname">
  371. <tr>
  372. <td class="memname">void EvrRtxKernelGetState </td>
  373. <td>(</td>
  374. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a>&#160;</td>
  375. <td class="paramname"><em>state</em></td><td>)</td>
  376. <td></td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <dl class="params"><dt>Parameters</dt><dd>
  381. <table class="params">
  382. <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>current RTOS Kernel state.</td></tr>
  383. </table>
  384. </dd>
  385. </dl>
  386. <p>The event <b>KernelGetState</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a> is called and its execution result is known.</p>
  387. <p><b>Value</b> in the Event Recorder shows:</p>
  388. <ul>
  389. <li><b>state</b> : retrieved current <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">RTOS Kernel state</a>. </li>
  390. </ul>
  391. </div>
  392. </div>
  393. <a class="anchor" id="ga75937a761dd488600d2525a532808d2b"></a>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">void EvrRtxKernelStart </td>
  399. <td>(</td>
  400. <td class="paramtype">void&#160;</td>
  401. <td class="paramname"></td><td>)</td>
  402. <td></td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. <p>The event <b>KernelStart</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a> is called. </p>
  407. </div>
  408. </div>
  409. <a class="anchor" id="ga28043ffc76fec09e6c8763a9a71b7f2a"></a>
  410. <div class="memitem">
  411. <div class="memproto">
  412. <table class="memname">
  413. <tr>
  414. <td class="memname">void EvrRtxKernelStarted </td>
  415. <td>(</td>
  416. <td class="paramtype">void&#160;</td>
  417. <td class="paramname"></td><td>)</td>
  418. <td></td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. <p>The event <b>KernelStarted</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a> successfully starts the RTOS kernel execution. </p>
  423. </div>
  424. </div>
  425. <a class="anchor" id="ga1d0340812c29274c6150fa72288e0612"></a>
  426. <div class="memitem">
  427. <div class="memproto">
  428. <table class="memname">
  429. <tr>
  430. <td class="memname">void EvrRtxKernelLock </td>
  431. <td>(</td>
  432. <td class="paramtype">void&#160;</td>
  433. <td class="paramname"></td><td>)</td>
  434. <td></td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>The event <b>KernelLock</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> is called. </p>
  439. </div>
  440. </div>
  441. <a class="anchor" id="gac18ea91ffcae01e893304609a3c6cdc3"></a>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="memname">
  445. <tr>
  446. <td class="memname">void EvrRtxKernelLocked </td>
  447. <td>(</td>
  448. <td class="paramtype">int32_t&#160;</td>
  449. <td class="paramname"><em>lock</em></td><td>)</td>
  450. <td></td>
  451. </tr>
  452. </table>
  453. </div><div class="memdoc">
  454. <dl class="params"><dt>Parameters</dt><dd>
  455. <table class="params">
  456. <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>previous lock state (1 - locked, 0 - not locked).</td></tr>
  457. </table>
  458. </dd>
  459. </dl>
  460. <p>The event <b>KernelLocked</b> is generated when the functions <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> successfully completes its execution.</p>
  461. <p><b>Value</b> in the Event Recorder shows:</p>
  462. <ul>
  463. <li><b>lock</b> : previous lock state (1 - locked, 0 - not locked). </li>
  464. </ul>
  465. </div>
  466. </div>
  467. <a class="anchor" id="gabe14acf14ed2611a3ba1f3b280fbfd8c"></a>
  468. <div class="memitem">
  469. <div class="memproto">
  470. <table class="memname">
  471. <tr>
  472. <td class="memname">void EvrRtxKernelUnlock </td>
  473. <td>(</td>
  474. <td class="paramtype">void&#160;</td>
  475. <td class="paramname"></td><td>)</td>
  476. <td></td>
  477. </tr>
  478. </table>
  479. </div><div class="memdoc">
  480. <p>The event <b>KernelUnlock</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a> is called. </p>
  481. </div>
  482. </div>
  483. <a class="anchor" id="ga5cc909465e8df09c9231782e0c45e374"></a>
  484. <div class="memitem">
  485. <div class="memproto">
  486. <table class="memname">
  487. <tr>
  488. <td class="memname">void EvrRtxKernelUnlocked </td>
  489. <td>(</td>
  490. <td class="paramtype">int32_t&#160;</td>
  491. <td class="paramname"><em>lock</em></td><td>)</td>
  492. <td></td>
  493. </tr>
  494. </table>
  495. </div><div class="memdoc">
  496. <dl class="params"><dt>Parameters</dt><dd>
  497. <table class="params">
  498. <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>previous lock state (1 - locked, 0 - not locked).</td></tr>
  499. </table>
  500. </dd>
  501. </dl>
  502. <p>The event <b>KernelUnlocked</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a> successfully completes its execution.</p>
  503. <p><b>Value</b> in the Event Recorder shows:</p>
  504. <ul>
  505. <li><b>lock</b> : previous lock state (1 - locked, 0 - not locked). </li>
  506. </ul>
  507. </div>
  508. </div>
  509. <a class="anchor" id="ga812fdd14d6c40072cc40aec742d4869e"></a>
  510. <div class="memitem">
  511. <div class="memproto">
  512. <table class="memname">
  513. <tr>
  514. <td class="memname">void EvrRtxKernelRestoreLock </td>
  515. <td>(</td>
  516. <td class="paramtype">int32_t&#160;</td>
  517. <td class="paramname"><em>lock</em></td><td>)</td>
  518. <td></td>
  519. </tr>
  520. </table>
  521. </div><div class="memdoc">
  522. <dl class="params"><dt>Parameters</dt><dd>
  523. <table class="params">
  524. <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>lock state obtained by <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a>.</td></tr>
  525. </table>
  526. </dd>
  527. </dl>
  528. <p>The event <b>KernelRestoreLock</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a> is called.</p>
  529. <p><b>Value</b> in the Event Recorder shows:</p>
  530. <ul>
  531. <li><b>lock</b> : lock state obtained by <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a>. </li>
  532. </ul>
  533. </div>
  534. </div>
  535. <a class="anchor" id="gaf7be1022a33c13fb44f4059f5636b75a"></a>
  536. <div class="memitem">
  537. <div class="memproto">
  538. <table class="memname">
  539. <tr>
  540. <td class="memname">void EvrRtxKernelLockRestored </td>
  541. <td>(</td>
  542. <td class="paramtype">int32_t&#160;</td>
  543. <td class="paramname"><em>lock</em></td><td>)</td>
  544. <td></td>
  545. </tr>
  546. </table>
  547. </div><div class="memdoc">
  548. <dl class="params"><dt>Parameters</dt><dd>
  549. <table class="params">
  550. <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>new lock state (1 - locked, 0 - not locked).</td></tr>
  551. </table>
  552. </dd>
  553. </dl>
  554. <p>The event <b>KernelLockRestored</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a> successfully completes its execution.</p>
  555. <p><b>Value</b> in the Event Recorder shows:</p>
  556. <ul>
  557. <li><b>lock</b> : new lock state (1 - locked, 0 - not locked). </li>
  558. </ul>
  559. </div>
  560. </div>
  561. <a class="anchor" id="gac3abd78a9d3f3a6adc698e2929e1c32c"></a>
  562. <div class="memitem">
  563. <div class="memproto">
  564. <table class="memname">
  565. <tr>
  566. <td class="memname">void EvrRtxKernelSuspend </td>
  567. <td>(</td>
  568. <td class="paramtype">void&#160;</td>
  569. <td class="paramname"></td><td>)</td>
  570. <td></td>
  571. </tr>
  572. </table>
  573. </div><div class="memdoc">
  574. <p>The event <b>KernelSuspend</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f">osKernelSuspend</a> is called. </p>
  575. </div>
  576. </div>
  577. <a class="anchor" id="gabdaa26d7774111af4913b5d6669d0f85"></a>
  578. <div class="memitem">
  579. <div class="memproto">
  580. <table class="memname">
  581. <tr>
  582. <td class="memname">void EvrRtxKernelSuspended </td>
  583. <td>(</td>
  584. <td class="paramtype">uint32_t&#160;</td>
  585. <td class="paramname"><em>sleep_ticks</em></td><td>)</td>
  586. <td></td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. <dl class="params"><dt>Parameters</dt><dd>
  591. <table class="params">
  592. <tr><td class="paramdir">[in]</td><td class="paramname">sleep_ticks</td><td>time in ticks, for how long the system can sleep or power-down.</td></tr>
  593. </table>
  594. </dd>
  595. </dl>
  596. <p>The event <b>KernelSuspended</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f">osKernelSuspend</a> successfully suspends RTOS kernel execution.</p>
  597. <p><b>Value</b> in the Event Recorder shows:</p>
  598. <ul>
  599. <li><b>sleep_ticks</b> : time in ticks, for how long the system can sleep or power-down. </li>
  600. </ul>
  601. </div>
  602. </div>
  603. <a class="anchor" id="ga9a8cac0fed8d3cf06f7301c944ad26d1"></a>
  604. <div class="memitem">
  605. <div class="memproto">
  606. <table class="memname">
  607. <tr>
  608. <td class="memname">void EvrRtxKernelResume </td>
  609. <td>(</td>
  610. <td class="paramtype">uint32_t&#160;</td>
  611. <td class="paramname"><em>sleep_ticks</em></td><td>)</td>
  612. <td></td>
  613. </tr>
  614. </table>
  615. </div><div class="memdoc">
  616. <dl class="params"><dt>Parameters</dt><dd>
  617. <table class="params">
  618. <tr><td class="paramdir">[in]</td><td class="paramname">sleep_ticks</td><td>time in ticks, for how long the system was in sleep or power-down mode.</td></tr>
  619. </table>
  620. </dd>
  621. </dl>
  622. <p>The event <b>KernelResume</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced">osKernelResume</a> is called.</p>
  623. <p><b>Value</b> in the Event Recorder shows:</p>
  624. <ul>
  625. <li><b>sleep_ticks</b> : time in ticks, for how long the system was in sleep or power-down mode. </li>
  626. </ul>
  627. </div>
  628. </div>
  629. <a class="anchor" id="ga26e0a22f49576824d853fb434cf6b079"></a>
  630. <div class="memitem">
  631. <div class="memproto">
  632. <table class="memname">
  633. <tr>
  634. <td class="memname">void EvrRtxKernelResumed </td>
  635. <td>(</td>
  636. <td class="paramtype">void&#160;</td>
  637. <td class="paramname"></td><td>)</td>
  638. <td></td>
  639. </tr>
  640. </table>
  641. </div><div class="memdoc">
  642. <p>The event <b>KernelResumed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced">osKernelResume</a> successfully resumes RTOS kernel execution. </p>
  643. </div>
  644. </div>
  645. <a class="anchor" id="ga64431a63437506a6f7fe22637d4891c5"></a>
  646. <div class="memitem">
  647. <div class="memproto">
  648. <table class="memname">
  649. <tr>
  650. <td class="memname">void EvrRtxKernelGetTickCount </td>
  651. <td>(</td>
  652. <td class="paramtype">uint32_t&#160;</td>
  653. <td class="paramname"><em>count</em></td><td>)</td>
  654. <td></td>
  655. </tr>
  656. </table>
  657. </div><div class="memdoc">
  658. <dl class="params"><dt>Parameters</dt><dd>
  659. <table class="params">
  660. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>RTOS kernel current tick count.</td></tr>
  661. </table>
  662. </dd>
  663. </dl>
  664. <p>The event <b>KernelGetTickCount</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga84bcdbf2fb76b10c8df4e439f0c7e11b">osKernelGetTickCount</a> is called.</p>
  665. <p><b>Value</b> in the Event Recorder shows:</p>
  666. <ul>
  667. <li><b>count</b> : retrieved kernel current tick count. </li>
  668. </ul>
  669. </div>
  670. </div>
  671. <a class="anchor" id="ga7404f3a22af84ad4091c24811fc1bf87"></a>
  672. <div class="memitem">
  673. <div class="memproto">
  674. <table class="memname">
  675. <tr>
  676. <td class="memname">void EvrRtxKernelGetTickFreq </td>
  677. <td>(</td>
  678. <td class="paramtype">uint32_t&#160;</td>
  679. <td class="paramname"><em>freq</em></td><td>)</td>
  680. <td></td>
  681. </tr>
  682. </table>
  683. </div><div class="memdoc">
  684. <dl class="params"><dt>Parameters</dt><dd>
  685. <table class="params">
  686. <tr><td class="paramdir">[in]</td><td class="paramname">freq</td><td>frequency of the kernel tick.</td></tr>
  687. </table>
  688. </dd>
  689. </dl>
  690. <p>The event <b>KernelGetTickFreq</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga7a8d7bd927eaaa58999f91d7d6310cee">osKernelGetTickFreq</a> called.</p>
  691. <p><b>Value</b> in the Event Recorder shows:</p>
  692. <ul>
  693. <li><b>freq</b> : retrieved frequency of the kernel tick in Hz. </li>
  694. </ul>
  695. </div>
  696. </div>
  697. <a class="anchor" id="gafb6530be8201b119015a3f45d66c2f09"></a>
  698. <div class="memitem">
  699. <div class="memproto">
  700. <table class="memname">
  701. <tr>
  702. <td class="memname">void EvrRtxKernelGetSysTimerCount </td>
  703. <td>(</td>
  704. <td class="paramtype">uint32_t&#160;</td>
  705. <td class="paramname"><em>count</em></td><td>)</td>
  706. <td></td>
  707. </tr>
  708. </table>
  709. </div><div class="memdoc">
  710. <dl class="params"><dt>Parameters</dt><dd>
  711. <table class="params">
  712. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>RTOS kernel current system timer count as 32-bit value.</td></tr>
  713. </table>
  714. </dd>
  715. </dl>
  716. <p>The event <b>KernelGetSysTimerCount</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae0fcaff6cecfb4013bb556c87afcd7d2">osKernelGetSysTimerCount</a> is called.</p>
  717. <p><b>Value</b> in the Event Recorder shows:</p>
  718. <ul>
  719. <li><b>count</b> : retrieved kernel current system timer count as 32-bit value. </li>
  720. </ul>
  721. </div>
  722. </div>
  723. <a class="anchor" id="gaf2bdfcb7b099295c7b0123abe88e10a3"></a>
  724. <div class="memitem">
  725. <div class="memproto">
  726. <table class="memname">
  727. <tr>
  728. <td class="memname">void EvrRtxKernelGetSysTimerFreq </td>
  729. <td>(</td>
  730. <td class="paramtype">uint32_t&#160;</td>
  731. <td class="paramname"><em>freq</em></td><td>)</td>
  732. <td></td>
  733. </tr>
  734. </table>
  735. </div><div class="memdoc">
  736. <dl class="params"><dt>Parameters</dt><dd>
  737. <table class="params">
  738. <tr><td class="paramdir">[in]</td><td class="paramname">freq</td><td>frequency of the system timer.</td></tr>
  739. </table>
  740. </dd>
  741. </dl>
  742. <p>The event <b>KernelGetSysTimerFreq</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga4d69215a93220f72be3684cad582f16a">osKernelGetSysTimerFreq</a> is called.</p>
  743. <p><b>Value</b> in the Event Recorder shows:</p>
  744. <ul>
  745. <li><b>freq</b> : retrieved frequency of the system timer in Hz. </li>
  746. </ul>
  747. </div>
  748. </div>
  749. </div><!-- contents -->
  750. </div><!-- doc-content -->
  751. <!-- start footer part -->
  752. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  753. <ul>
  754. <li class="footer">Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  755. <!--
  756. <a href="http://www.doxygen.org/index.html">
  757. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  758. -->
  759. </li>
  760. </ul>
  761. </div>
  762. </body>
  763. </html>