group__pmu8__functions.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608
  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>PMU Functions for Armv8.1-M</title>
  7. <title>CMSIS-Core (Cortex-M): PMU Functions for Armv8.1-M</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-Core (Cortex-M)
  35. &#160;<span id="projectnumber">Version 5.4.0</span>
  36. </div>
  37. <div id="projectbrief">CMSIS-Core support for Cortex-M processor-based devices</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__pmu8__functions.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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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="#groups">Content</a> &#124;
  110. <a href="#nested-classes">Data Structures</a> &#124;
  111. <a href="#define-members">Macros</a> &#124;
  112. <a href="#func-members">Functions</a> </div>
  113. <div class="headertitle">
  114. <div class="title">PMU Functions for Armv8.1-M</div> </div>
  115. </div><!--header-->
  116. <div class="contents">
  117. <p>Functions that relate to the Performance Monitoring Unit.
  118. <a href="#details">More...</a></p>
  119. <table class="memberdecls">
  120. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  121. Content</h2></td></tr>
  122. <tr class="memitem:group__pmu8__events__armv81"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__events__armv81.html">PMU Events for Armv8.1-M</a></td></tr>
  123. <tr class="memdesc:group__pmu8__events__armv81"><td class="mdescLeft">&#160;</td><td class="mdescRight">IDs for Armv8.1-M architecture defined events. <br/></td></tr>
  124. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:group__pmu8__events__armcm55"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__events__armcm55.html">PMU Events for Cortex-M55</a></td></tr>
  126. <tr class="memdesc:group__pmu8__events__armcm55"><td class="mdescLeft">&#160;</td><td class="mdescRight">IDs for additional events defined for Cortex-M55. <br/></td></tr>
  127. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table><table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  130. Data Structures</h2></td></tr>
  131. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPMU__Type.html">PMU_Type</a></td></tr>
  132. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure type to access the Performance Monitoring Unit (PMU). <a href="structPMU__Type.html#details">More...</a><br/></td></tr>
  133. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  136. Macros</h2></td></tr>
  137. <tr class="memitem:gad19c25be8565f2791aca1a96d1847516"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#gad19c25be8565f2791aca1a96d1847516">PMU</a></td></tr>
  138. <tr class="memdesc:gad19c25be8565f2791aca1a96d1847516"><td class="mdescLeft">&#160;</td><td class="mdescRight">PMU configuration struct. <a href="#gad19c25be8565f2791aca1a96d1847516">More...</a><br/></td></tr>
  139. <tr class="separator:gad19c25be8565f2791aca1a96d1847516"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table><table class="memberdecls">
  141. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  142. Functions</h2></td></tr>
  143. <tr class="memitem:ga618e7140a774ac2a31a59db4b7d13abc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga618e7140a774ac2a31a59db4b7d13abc">ARM_PMU_Enable</a> (void)</td></tr>
  144. <tr class="memdesc:ga618e7140a774ac2a31a59db4b7d13abc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the PMU. <a href="#ga618e7140a774ac2a31a59db4b7d13abc">More...</a><br/></td></tr>
  145. <tr class="separator:ga618e7140a774ac2a31a59db4b7d13abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ga74273d4a47cf1a5e99d857a3e8896f10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga74273d4a47cf1a5e99d857a3e8896f10">ARM_PMU_Disable</a> (void)</td></tr>
  147. <tr class="memdesc:ga74273d4a47cf1a5e99d857a3e8896f10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the PMU. <a href="#ga74273d4a47cf1a5e99d857a3e8896f10">More...</a><br/></td></tr>
  148. <tr class="separator:ga74273d4a47cf1a5e99d857a3e8896f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ga77ee08f0b3e77d4559cb79fde30d89e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga77ee08f0b3e77d4559cb79fde30d89e9">ARM_PMU_Set_EVTYPER</a> (uint32_t num, uint32_t type)</td></tr>
  150. <tr class="memdesc:ga77ee08f0b3e77d4559cb79fde30d89e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set event to count for PMU event counter. <a href="#ga77ee08f0b3e77d4559cb79fde30d89e9">More...</a><br/></td></tr>
  151. <tr class="separator:ga77ee08f0b3e77d4559cb79fde30d89e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ga4288c08039886cd24eb2dd4e743fb97e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga4288c08039886cd24eb2dd4e743fb97e">ARM_PMU_CYCCNT_Reset</a> (void)</td></tr>
  153. <tr class="memdesc:ga4288c08039886cd24eb2dd4e743fb97e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset cycle counter. <a href="#ga4288c08039886cd24eb2dd4e743fb97e">More...</a><br/></td></tr>
  154. <tr class="separator:ga4288c08039886cd24eb2dd4e743fb97e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ga90527859e6f0ef980300c86c2916ee79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga90527859e6f0ef980300c86c2916ee79">ARM_PMU_EVCNTR_ALL_Reset</a> (void)</td></tr>
  156. <tr class="memdesc:ga90527859e6f0ef980300c86c2916ee79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset all event counters. <a href="#ga90527859e6f0ef980300c86c2916ee79">More...</a><br/></td></tr>
  157. <tr class="separator:ga90527859e6f0ef980300c86c2916ee79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:ga22e481855ab257180e24f01a38623887"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga22e481855ab257180e24f01a38623887">ARM_PMU_CNTR_Enable</a> (uint32_t mask)</td></tr>
  159. <tr class="memdesc:ga22e481855ab257180e24f01a38623887"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable counters. <a href="#ga22e481855ab257180e24f01a38623887">More...</a><br/></td></tr>
  160. <tr class="separator:ga22e481855ab257180e24f01a38623887"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ga76c6f266544c53d93801cfb614155420"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga76c6f266544c53d93801cfb614155420">ARM_PMU_CNTR_Disable</a> (uint32_t mask)</td></tr>
  162. <tr class="memdesc:ga76c6f266544c53d93801cfb614155420"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable counters. <a href="#ga76c6f266544c53d93801cfb614155420">More...</a><br/></td></tr>
  163. <tr class="separator:ga76c6f266544c53d93801cfb614155420"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:gaaa18c27d39f5a55c1b621f5296b88112"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#gaaa18c27d39f5a55c1b621f5296b88112">ARM_PMU_Get_CCNTR</a> (void)</td></tr>
  165. <tr class="memdesc:gaaa18c27d39f5a55c1b621f5296b88112"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read cycle counter. <a href="#gaaa18c27d39f5a55c1b621f5296b88112">More...</a><br/></td></tr>
  166. <tr class="separator:gaaa18c27d39f5a55c1b621f5296b88112"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ga9768cbaffcf2c0b31febe96db91a85d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga9768cbaffcf2c0b31febe96db91a85d8">ARM_PMU_Get_EVCNTR</a> (uint32_t num)</td></tr>
  168. <tr class="memdesc:ga9768cbaffcf2c0b31febe96db91a85d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read event counter. <a href="#ga9768cbaffcf2c0b31febe96db91a85d8">More...</a><br/></td></tr>
  169. <tr class="separator:ga9768cbaffcf2c0b31febe96db91a85d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ga70436b378b75bdfe3fcb47697d309a96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga70436b378b75bdfe3fcb47697d309a96">ARM_PMU_Get_CNTR_OVS</a> (void)</td></tr>
  171. <tr class="memdesc:ga70436b378b75bdfe3fcb47697d309a96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read counter overflow status. <a href="#ga70436b378b75bdfe3fcb47697d309a96">More...</a><br/></td></tr>
  172. <tr class="separator:ga70436b378b75bdfe3fcb47697d309a96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:ga18376f0e3829e93e99149847667e5864"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga18376f0e3829e93e99149847667e5864">ARM_PMU_Set_CNTR_OVS</a> (uint32_t mask)</td></tr>
  174. <tr class="memdesc:ga18376f0e3829e93e99149847667e5864"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear counter overflow status. <a href="#ga18376f0e3829e93e99149847667e5864">More...</a><br/></td></tr>
  175. <tr class="separator:ga18376f0e3829e93e99149847667e5864"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:ga133168437a20566d319c78b751425c44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga133168437a20566d319c78b751425c44">ARM_PMU_Set_CNTR_IRQ_Enable</a> (uint32_t mask)</td></tr>
  177. <tr class="memdesc:ga133168437a20566d319c78b751425c44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable counter overflow interrupt request. <a href="#ga133168437a20566d319c78b751425c44">More...</a><br/></td></tr>
  178. <tr class="separator:ga133168437a20566d319c78b751425c44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:ga731b6cd01c6eaa6f909164602f19d0bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga731b6cd01c6eaa6f909164602f19d0bc">ARM_PMU_Set_CNTR_IRQ_Disable</a> (uint32_t mask)</td></tr>
  180. <tr class="memdesc:ga731b6cd01c6eaa6f909164602f19d0bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable counter overflow interrupt request. <a href="#ga731b6cd01c6eaa6f909164602f19d0bc">More...</a><br/></td></tr>
  181. <tr class="separator:ga731b6cd01c6eaa6f909164602f19d0bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:ga27b07d38050a16ce416bfaf151a24944"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga27b07d38050a16ce416bfaf151a24944">ARM_PMU_CNTR_Increment</a> (uint32_t mask)</td></tr>
  183. <tr class="memdesc:ga27b07d38050a16ce416bfaf151a24944"><td class="mdescLeft">&#160;</td><td class="mdescRight">Software increment event counter. <a href="#ga27b07d38050a16ce416bfaf151a24944">More...</a><br/></td></tr>
  184. <tr class="separator:ga27b07d38050a16ce416bfaf151a24944"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. </table>
  186. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  187. <p>Functions that relate to the Performance Monitoring Unit. </p>
  188. <p>The following functions support the Performance Monitoring Unit (PMU) that is available on the Cortex-M55 processor.</p>
  189. <p>The PMU is used to monitor events that occur during run-time of an application.</p>
  190. <p><b>Example:</b> </p>
  191. <div class="fragment"><div class="line"><span class="comment">// Initialize counter variables</span></div>
  192. <div class="line"> </div>
  193. <div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cycle_count = 0;</div>
  194. <div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> l1_dcache_miss_count = 0;</div>
  195. <div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> instructions_retired_count = 0;</div>
  196. <div class="line"> </div>
  197. <div class="line"><span class="comment">// Enable the PMU</span></div>
  198. <div class="line"> </div>
  199. <div class="line"><a class="code" href="group__pmu8__functions.html#ga618e7140a774ac2a31a59db4b7d13abc">ARM_PMU_Enable</a>();</div>
  200. <div class="line"> </div>
  201. <div class="line"><span class="comment">// Configure Event Counter Register 0 to count instructions retired</span></div>
  202. <div class="line"><span class="comment">// Configure Event Counter Register 1 to count L1 D-Cache misses</span></div>
  203. <div class="line"> </div>
  204. <div class="line"><a class="code" href="group__pmu8__functions.html#ga77ee08f0b3e77d4559cb79fde30d89e9">ARM_PMU_Set_EVTYPER</a>(0, <a class="code" href="group__pmu8__events__armv81.html#ga8a5e60eee460addfc66e275a2c4c4800">ARM_PMU_INST_RETIRED</a>);</div>
  205. <div class="line"><a class="code" href="group__pmu8__functions.html#ga77ee08f0b3e77d4559cb79fde30d89e9">ARM_PMU_Set_EVTYPER</a>(1, <a class="code" href="group__pmu8__events__armv81.html#ga4687d5d7efc6f49db2db9acc25b590f6">ARM_PMU_L1D_CACHE_MISS_RD</a>);</div>
  206. <div class="line"> </div>
  207. <div class="line"><span class="comment">// Reset Event Counters and Cycle Counter</span></div>
  208. <div class="line"> </div>
  209. <div class="line"><a class="code" href="group__pmu8__functions.html#ga90527859e6f0ef980300c86c2916ee79">ARM_PMU_EVCNTR_ALL_Reset</a>();</div>
  210. <div class="line"><a class="code" href="group__pmu8__functions.html#ga4288c08039886cd24eb2dd4e743fb97e">ARM_PMU_CYCCNT_Reset</a>();</div>
  211. <div class="line"> </div>
  212. <div class="line"><span class="comment">// Start incrementing Cycle Count Register and Event Counter Registers 0 &amp; 1</span></div>
  213. <div class="line"> </div>
  214. <div class="line"><a class="code" href="group__pmu8__functions.html#ga22e481855ab257180e24f01a38623887">ARM_PMU_CNTR_Enable</a>(PMU_CNTENSET_CCNTR_ENABLE_Msk|PMU_CNTENSET_CNT0_ENABLE_Msk|PMU_CNTENSET_CNT1_ENABLE_Msk);</div>
  215. <div class="line"> </div>
  216. <div class="line"><span class="comment">// Code you want to measure here</span></div>
  217. <div class="line"> </div>
  218. <div class="line"><span class="comment">// Stop incrementing Cycle Count Register and Event Counter Registers 0 &amp; 1</span></div>
  219. <div class="line"> </div>
  220. <div class="line"><a class="code" href="group__pmu8__functions.html#ga76c6f266544c53d93801cfb614155420">ARM_PMU_CNTR_Disable</a>(PMU_CNTENCLR_CCNTR_ENABLE_Msk|PMU_CNTENCLR_CNT0_ENABLE_Msk|PMU_CNTENCLR_CNT1_ENABLE_Msk);</div>
  221. <div class="line"> </div>
  222. <div class="line"><span class="comment">// Get cycle count, number of instructions retired and number of L1 D-Cache misses (on read)</span></div>
  223. <div class="line"> </div>
  224. <div class="line">cycle_count = cycle_count + <a class="code" href="group__pmu8__functions.html#gaaa18c27d39f5a55c1b621f5296b88112">ARM_PMU_Get_CCNTR</a>();</div>
  225. <div class="line">instructions_retired_count = instructions_retired_count + <a class="code" href="group__pmu8__functions.html#ga9768cbaffcf2c0b31febe96db91a85d8">ARM_PMU_Get_EVCNTR</a>(0);</div>
  226. <div class="line">l1_dcache_miss_count = l1_dcache_miss_count + <a class="code" href="group__pmu8__functions.html#ga9768cbaffcf2c0b31febe96db91a85d8">ARM_PMU_Get_EVCNTR</a>(1); <span class="comment">// Note: D-Cache must be enabled using</span></div>
  227. <div class="line"> <span class="comment">// SCB_EnableDCache() for meaningful result.</span></div>
  228. </div><!-- fragment --> <h2 class="groupheader">Macro Definition Documentation</h2>
  229. <a class="anchor" id="gad19c25be8565f2791aca1a96d1847516"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">#define PMU</td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>PMU configuration struct. </p>
  239. <p>This macro can be used to access the PMU registers, directly. For the common tasks one should prefer using the control functions.</p>
  240. <p>Example: <b>Example:</b> </p>
  241. <div class="fragment"><div class="line"><a class="code" href="group__pmu8__functions.html#gad19c25be8565f2791aca1a96d1847516">PMU</a>-&gt;CTRL |= PMU_CTRL_ENABLE_Msk; <span class="comment">// Enable PMU</span></div>
  242. </div><!-- fragment -->
  243. </div>
  244. </div>
  245. <h2 class="groupheader">Function Documentation</h2>
  246. <a class="anchor" id="ga76c6f266544c53d93801cfb614155420"></a>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CNTR_Disable </td>
  252. <td>(</td>
  253. <td class="paramtype">uint32_t&#160;</td>
  254. <td class="paramname"><em>mask</em></td><td>)</td>
  255. <td></td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. <p>Disable counters. </p>
  260. <dl class="params"><dt>Parameters</dt><dd>
  261. <table class="params">
  262. <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counters to enable </td></tr>
  263. </table>
  264. </dd>
  265. </dl>
  266. <dl class="section note"><dt>Note</dt><dd>Disables one or more of the following:<ul>
  267. <li>event counters (0-30)</li>
  268. <li>cycle counter </li>
  269. </ul>
  270. </dd></dl>
  271. </div>
  272. </div>
  273. <a class="anchor" id="ga22e481855ab257180e24f01a38623887"></a>
  274. <div class="memitem">
  275. <div class="memproto">
  276. <table class="memname">
  277. <tr>
  278. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CNTR_Enable </td>
  279. <td>(</td>
  280. <td class="paramtype">uint32_t&#160;</td>
  281. <td class="paramname"><em>mask</em></td><td>)</td>
  282. <td></td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Enable counters. </p>
  287. <dl class="params"><dt>Parameters</dt><dd>
  288. <table class="params">
  289. <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counters to enable </td></tr>
  290. </table>
  291. </dd>
  292. </dl>
  293. <dl class="section note"><dt>Note</dt><dd>Enables one or more of the following:<ul>
  294. <li>event counters (0-30)</li>
  295. <li>cycle counter </li>
  296. </ul>
  297. </dd></dl>
  298. </div>
  299. </div>
  300. <a class="anchor" id="ga27b07d38050a16ce416bfaf151a24944"></a>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CNTR_Increment </td>
  306. <td>(</td>
  307. <td class="paramtype">uint32_t&#160;</td>
  308. <td class="paramname"><em>mask</em></td><td>)</td>
  309. <td></td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <p>Software increment event counter. </p>
  314. <dl class="params"><dt>Parameters</dt><dd>
  315. <table class="params">
  316. <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counters to increment </td></tr>
  317. </table>
  318. </dd>
  319. </dl>
  320. <dl class="section note"><dt>Note</dt><dd>Software increment bits for one or more event counters (0-30) </dd></dl>
  321. </div>
  322. </div>
  323. <a class="anchor" id="ga4288c08039886cd24eb2dd4e743fb97e"></a>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CYCCNT_Reset </td>
  329. <td>(</td>
  330. <td class="paramtype">void&#160;</td>
  331. <td class="paramname"></td><td>)</td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Reset cycle counter. </p>
  337. </div>
  338. </div>
  339. <a class="anchor" id="ga74273d4a47cf1a5e99d857a3e8896f10"></a>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Disable </td>
  345. <td>(</td>
  346. <td class="paramtype">void&#160;</td>
  347. <td class="paramname"></td><td>)</td>
  348. <td></td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>Disable the PMU. </p>
  353. </div>
  354. </div>
  355. <a class="anchor" id="ga618e7140a774ac2a31a59db4b7d13abc"></a>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Enable </td>
  361. <td>(</td>
  362. <td class="paramtype">void&#160;</td>
  363. <td class="paramname"></td><td>)</td>
  364. <td></td>
  365. </tr>
  366. </table>
  367. </div><div class="memdoc">
  368. <p>Enable the PMU. </p>
  369. </div>
  370. </div>
  371. <a class="anchor" id="ga90527859e6f0ef980300c86c2916ee79"></a>
  372. <div class="memitem">
  373. <div class="memproto">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_EVCNTR_ALL_Reset </td>
  377. <td>(</td>
  378. <td class="paramtype">void&#160;</td>
  379. <td class="paramname"></td><td>)</td>
  380. <td></td>
  381. </tr>
  382. </table>
  383. </div><div class="memdoc">
  384. <p>Reset all event counters. </p>
  385. </div>
  386. </div>
  387. <a class="anchor" id="gaaa18c27d39f5a55c1b621f5296b88112"></a>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t ARM_PMU_Get_CCNTR </td>
  393. <td>(</td>
  394. <td class="paramtype">void&#160;</td>
  395. <td class="paramname"></td><td>)</td>
  396. <td></td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. <p>Read cycle counter. </p>
  401. <dl class="section return"><dt>Returns</dt><dd>Cycle count </dd></dl>
  402. </div>
  403. </div>
  404. <a class="anchor" id="ga70436b378b75bdfe3fcb47697d309a96"></a>
  405. <div class="memitem">
  406. <div class="memproto">
  407. <table class="memname">
  408. <tr>
  409. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t ARM_PMU_Get_CNTR_OVS </td>
  410. <td>(</td>
  411. <td class="paramtype">void&#160;</td>
  412. <td class="paramname"></td><td>)</td>
  413. <td></td>
  414. </tr>
  415. </table>
  416. </div><div class="memdoc">
  417. <p>Read counter overflow status. </p>
  418. <dl class="section return"><dt>Returns</dt><dd>Counter overflow status bits for the following:<ul>
  419. <li>event counters (0-30)</li>
  420. <li>cycle counter </li>
  421. </ul>
  422. </dd></dl>
  423. </div>
  424. </div>
  425. <a class="anchor" id="ga9768cbaffcf2c0b31febe96db91a85d8"></a>
  426. <div class="memitem">
  427. <div class="memproto">
  428. <table class="memname">
  429. <tr>
  430. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t ARM_PMU_Get_EVCNTR </td>
  431. <td>(</td>
  432. <td class="paramtype">uint32_t&#160;</td>
  433. <td class="paramname"><em>num</em></td><td>)</td>
  434. <td></td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Read event counter. </p>
  439. <dl class="params"><dt>Parameters</dt><dd>
  440. <table class="params">
  441. <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Event counter (0-30) to read </td></tr>
  442. </table>
  443. </dd>
  444. </dl>
  445. <dl class="section return"><dt>Returns</dt><dd>Event count </dd></dl>
  446. </div>
  447. </div>
  448. <a class="anchor" id="ga731b6cd01c6eaa6f909164602f19d0bc"></a>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_CNTR_IRQ_Disable </td>
  454. <td>(</td>
  455. <td class="paramtype">uint32_t&#160;</td>
  456. <td class="paramname"><em>mask</em></td><td>)</td>
  457. <td></td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>Disable counter overflow interrupt request. </p>
  462. <dl class="params"><dt>Parameters</dt><dd>
  463. <table class="params">
  464. <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counter overflow interrupt request bits to clear </td></tr>
  465. </table>
  466. </dd>
  467. </dl>
  468. <dl class="section note"><dt>Note</dt><dd>Clears overflow interrupt request bits for one or more of the following:<ul>
  469. <li>event counters (0-30)</li>
  470. <li>cycle counter </li>
  471. </ul>
  472. </dd></dl>
  473. </div>
  474. </div>
  475. <a class="anchor" id="ga133168437a20566d319c78b751425c44"></a>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="memname">
  479. <tr>
  480. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_CNTR_IRQ_Enable </td>
  481. <td>(</td>
  482. <td class="paramtype">uint32_t&#160;</td>
  483. <td class="paramname"><em>mask</em></td><td>)</td>
  484. <td></td>
  485. </tr>
  486. </table>
  487. </div><div class="memdoc">
  488. <p>Enable counter overflow interrupt request. </p>
  489. <dl class="params"><dt>Parameters</dt><dd>
  490. <table class="params">
  491. <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counter overflow interrupt request bits to set </td></tr>
  492. </table>
  493. </dd>
  494. </dl>
  495. <dl class="section note"><dt>Note</dt><dd>Sets overflow interrupt request bits for one or more of the following:<ul>
  496. <li>event counters (0-30)</li>
  497. <li>cycle counter </li>
  498. </ul>
  499. </dd></dl>
  500. </div>
  501. </div>
  502. <a class="anchor" id="ga18376f0e3829e93e99149847667e5864"></a>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <table class="memname">
  506. <tr>
  507. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_CNTR_OVS </td>
  508. <td>(</td>
  509. <td class="paramtype">uint32_t&#160;</td>
  510. <td class="paramname"><em>mask</em></td><td>)</td>
  511. <td></td>
  512. </tr>
  513. </table>
  514. </div><div class="memdoc">
  515. <p>Clear counter overflow status. </p>
  516. <dl class="params"><dt>Parameters</dt><dd>
  517. <table class="params">
  518. <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counter overflow status bits to clear </td></tr>
  519. </table>
  520. </dd>
  521. </dl>
  522. <dl class="section note"><dt>Note</dt><dd>Clears overflow status bits for one or more of the following:<ul>
  523. <li>event counters (0-30)</li>
  524. <li>cycle counter </li>
  525. </ul>
  526. </dd></dl>
  527. </div>
  528. </div>
  529. <a class="anchor" id="ga77ee08f0b3e77d4559cb79fde30d89e9"></a>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="memname">
  533. <tr>
  534. <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_EVTYPER </td>
  535. <td>(</td>
  536. <td class="paramtype">uint32_t&#160;</td>
  537. <td class="paramname"><em>num</em>, </td>
  538. </tr>
  539. <tr>
  540. <td class="paramkey"></td>
  541. <td></td>
  542. <td class="paramtype">uint32_t&#160;</td>
  543. <td class="paramname"><em>type</em>&#160;</td>
  544. </tr>
  545. <tr>
  546. <td></td>
  547. <td>)</td>
  548. <td></td><td></td>
  549. </tr>
  550. </table>
  551. </div><div class="memdoc">
  552. <p>Set event to count for PMU event counter. </p>
  553. <dl class="params"><dt>Parameters</dt><dd>
  554. <table class="params">
  555. <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Event counter (0-30) to configure </td></tr>
  556. <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Event to count </td></tr>
  557. </table>
  558. </dd>
  559. </dl>
  560. </div>
  561. </div>
  562. </div><!-- contents -->
  563. </div><!-- doc-content -->
  564. <!-- start footer part -->
  565. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  566. <ul>
  567. <li class="footer">Generated on Thu Apr 9 2020 15:49:08 for CMSIS-Core (Cortex-M) Version 5.4.0 by Arm Ltd. All rights reserved.
  568. <!--
  569. <a href="http://www.doxygen.org/index.html">
  570. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  571. -->
  572. </li>
  573. </ul>
  574. </div>
  575. </body>
  576. </html>