1 <!-- HTML header for doxygen 1.9.6-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-Core (Cortex-M): PMU Functions for Armv8.1-M</title>
9 <link href="doxygen.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="tabs.js"></script>
13 <script type="text/javascript" src="footer.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="resize.js"></script>
17 <script type="text/javascript" src="navtreedata.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
24 $(document).ready(function() { init_search(); });
27 <script type="text/javascript" src="darkmode_toggle.js"></script>
28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
32 <link href="version.css" rel="stylesheet" type="text/css"/>
33 <script type="text/javascript" src="../../version.js"></script>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 55px;">
41 <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
42 <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
43 <div id="projectname">CMSIS-Core (Cortex-M)
44  <span id="projectnumber"><script type="text/javascript">
46 writeHeader.call(this);
47 writeVersionDropdown.call(this, "CMSIS-Core (Cortex-M)");
52 <div id="projectbrief">CMSIS-Core support for Cortex-M processor-based devices</div>
54 <td> <div id="MSearchBox" class="MSearchBoxInactive">
56 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
57 <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
58 onfocus="searchBox.OnSearchFieldFocus(true)"
59 onblur="searchBox.OnSearchFieldFocus(false)"
60 onkeyup="searchBox.OnSearchFieldChange(event)"/>
61 </span><span class="right">
62 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
66 <!--END !PROJECT_NAME-->
71 <!-- end header part -->
72 <div id="CMSISnav" class="tabs1">
74 <script type="text/javascript">
75 writeComponentTabs.call(this);
79 <script type="text/javascript">
80 writeSubComponentTabs.call(this);
82 <!-- Generated by Doxygen 1.9.6 -->
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
85 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
101 $(document).ready(function(){initNavTree('group__pmu8__functions.html',''); initResizable(); });
104 <div id="doc-content">
105 <!-- window showing the filter options -->
106 <div id="MSearchSelectWindow"
107 onmouseover="return searchBox.OnSearchSelectShow()"
108 onmouseout="return searchBox.OnSearchSelectHide()"
109 onkeydown="return searchBox.OnSearchSelectKey(event)">
112 <!-- iframe showing the search results (closed by default) -->
113 <div id="MSearchResultsWindow">
114 <div id="MSearchResults">
117 <div id="SRResults"></div>
118 <div class="SRStatus" id="Loading">Loading...</div>
119 <div class="SRStatus" id="Searching">Searching...</div>
120 <div class="SRStatus" id="NoMatches">No Matches</div>
127 <div class="summary">
128 <a href="#groups">Content</a> |
129 <a href="#nested-classes">Data Structures</a> |
130 <a href="#define-members">Macros</a> |
131 <a href="#func-members">Functions</a> </div>
132 <div class="headertitle"><div class="title">PMU Functions for Armv8.1-M</div></div>
134 <div class="contents">
136 <p>Functions that relate to the Performance Monitoring Unit.
137 <a href="#details">More...</a></p>
138 <table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
140 Content</h2></td></tr>
141 <tr class="memitem:group__pmu8__events__armv81"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__events__armv81.html">PMU Events for Armv8.1-M</a></td></tr>
142 <tr class="memdesc:group__pmu8__events__armv81"><td class="mdescLeft"> </td><td class="mdescRight">IDs for Armv8.1-M architecture defined events. <br /></td></tr>
143 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:group__pmu8__events__armcm55"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__events__armcm55.html">PMU Events for Cortex-M55</a></td></tr>
145 <tr class="memdesc:group__pmu8__events__armcm55"><td class="mdescLeft"> </td><td class="mdescRight">IDs for additional events defined for Cortex-M55. <br /></td></tr>
146 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:group__pmu8__events__armcm85"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__events__armcm85.html">PMU Events for Cortex-M85</a></td></tr>
148 <tr class="memdesc:group__pmu8__events__armcm85"><td class="mdescLeft"> </td><td class="mdescRight">IDs for additional events defined for Cortex-M85. <br /></td></tr>
149 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
150 </table><table class="memberdecls">
151 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
152 Data Structures</h2></td></tr>
153 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPMU__Type.html">PMU_Type</a></td></tr>
154 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure type to access the Performance Monitoring Unit (PMU). <a href="structPMU__Type.html#details">More...</a><br /></td></tr>
155 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
156 </table><table class="memberdecls">
157 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
158 Macros</h2></td></tr>
159 <tr class="memitem:gad19c25be8565f2791aca1a96d1847516"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#gad19c25be8565f2791aca1a96d1847516">PMU</a></td></tr>
160 <tr class="memdesc:gad19c25be8565f2791aca1a96d1847516"><td class="mdescLeft"> </td><td class="mdescRight">PMU configuration struct. <br /></td></tr>
161 <tr class="separator:gad19c25be8565f2791aca1a96d1847516"><td class="memSeparator" colspan="2"> </td></tr>
162 </table><table class="memberdecls">
163 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
164 Functions</h2></td></tr>
165 <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 </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>
166 <tr class="memdesc:ga76c6f266544c53d93801cfb614155420"><td class="mdescLeft"> </td><td class="mdescRight">Disable counters. <br /></td></tr>
167 <tr class="separator:ga76c6f266544c53d93801cfb614155420"><td class="memSeparator" colspan="2"> </td></tr>
168 <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 </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>
169 <tr class="memdesc:ga22e481855ab257180e24f01a38623887"><td class="mdescLeft"> </td><td class="mdescRight">Enable counters. <br /></td></tr>
170 <tr class="separator:ga22e481855ab257180e24f01a38623887"><td class="memSeparator" colspan="2"> </td></tr>
171 <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 </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>
172 <tr class="memdesc:ga27b07d38050a16ce416bfaf151a24944"><td class="mdescLeft"> </td><td class="mdescRight">Software increment event counter. <br /></td></tr>
173 <tr class="separator:ga27b07d38050a16ce416bfaf151a24944"><td class="memSeparator" colspan="2"> </td></tr>
174 <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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga4288c08039886cd24eb2dd4e743fb97e">ARM_PMU_CYCCNT_Reset</a> (void)</td></tr>
175 <tr class="memdesc:ga4288c08039886cd24eb2dd4e743fb97e"><td class="mdescLeft"> </td><td class="mdescRight">Reset cycle counter. <br /></td></tr>
176 <tr class="separator:ga4288c08039886cd24eb2dd4e743fb97e"><td class="memSeparator" colspan="2"> </td></tr>
177 <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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga74273d4a47cf1a5e99d857a3e8896f10">ARM_PMU_Disable</a> (void)</td></tr>
178 <tr class="memdesc:ga74273d4a47cf1a5e99d857a3e8896f10"><td class="mdescLeft"> </td><td class="mdescRight">Disable the PMU. <br /></td></tr>
179 <tr class="separator:ga74273d4a47cf1a5e99d857a3e8896f10"><td class="memSeparator" colspan="2"> </td></tr>
180 <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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga618e7140a774ac2a31a59db4b7d13abc">ARM_PMU_Enable</a> (void)</td></tr>
181 <tr class="memdesc:ga618e7140a774ac2a31a59db4b7d13abc"><td class="mdescLeft"> </td><td class="mdescRight">Enable the PMU. <br /></td></tr>
182 <tr class="separator:ga618e7140a774ac2a31a59db4b7d13abc"><td class="memSeparator" colspan="2"> </td></tr>
183 <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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga90527859e6f0ef980300c86c2916ee79">ARM_PMU_EVCNTR_ALL_Reset</a> (void)</td></tr>
184 <tr class="memdesc:ga90527859e6f0ef980300c86c2916ee79"><td class="mdescLeft"> </td><td class="mdescRight">Reset all event counters. <br /></td></tr>
185 <tr class="separator:ga90527859e6f0ef980300c86c2916ee79"><td class="memSeparator" colspan="2"> </td></tr>
186 <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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#gaaa18c27d39f5a55c1b621f5296b88112">ARM_PMU_Get_CCNTR</a> (void)</td></tr>
187 <tr class="memdesc:gaaa18c27d39f5a55c1b621f5296b88112"><td class="mdescLeft"> </td><td class="mdescRight">Read cycle counter. <br /></td></tr>
188 <tr class="separator:gaaa18c27d39f5a55c1b621f5296b88112"><td class="memSeparator" colspan="2"> </td></tr>
189 <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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pmu8__functions.html#ga70436b378b75bdfe3fcb47697d309a96">ARM_PMU_Get_CNTR_OVS</a> (void)</td></tr>
190 <tr class="memdesc:ga70436b378b75bdfe3fcb47697d309a96"><td class="mdescLeft"> </td><td class="mdescRight">Read counter overflow status. <br /></td></tr>
191 <tr class="separator:ga70436b378b75bdfe3fcb47697d309a96"><td class="memSeparator" colspan="2"> </td></tr>
192 <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 </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>
193 <tr class="memdesc:ga9768cbaffcf2c0b31febe96db91a85d8"><td class="mdescLeft"> </td><td class="mdescRight">Read event counter. <br /></td></tr>
194 <tr class="separator:ga9768cbaffcf2c0b31febe96db91a85d8"><td class="memSeparator" colspan="2"> </td></tr>
195 <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 </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>
196 <tr class="memdesc:ga731b6cd01c6eaa6f909164602f19d0bc"><td class="mdescLeft"> </td><td class="mdescRight">Disable counter overflow interrupt request. <br /></td></tr>
197 <tr class="separator:ga731b6cd01c6eaa6f909164602f19d0bc"><td class="memSeparator" colspan="2"> </td></tr>
198 <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 </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>
199 <tr class="memdesc:ga133168437a20566d319c78b751425c44"><td class="mdescLeft"> </td><td class="mdescRight">Enable counter overflow interrupt request. <br /></td></tr>
200 <tr class="separator:ga133168437a20566d319c78b751425c44"><td class="memSeparator" colspan="2"> </td></tr>
201 <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 </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>
202 <tr class="memdesc:ga18376f0e3829e93e99149847667e5864"><td class="mdescLeft"> </td><td class="mdescRight">Clear counter overflow status. <br /></td></tr>
203 <tr class="separator:ga18376f0e3829e93e99149847667e5864"><td class="memSeparator" colspan="2"> </td></tr>
204 <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 </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>
205 <tr class="memdesc:ga77ee08f0b3e77d4559cb79fde30d89e9"><td class="mdescLeft"> </td><td class="mdescRight">Set event to count for PMU event counter. <br /></td></tr>
206 <tr class="separator:ga77ee08f0b3e77d4559cb79fde30d89e9"><td class="memSeparator" colspan="2"> </td></tr>
208 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
209 <p>Functions that relate to the Performance Monitoring Unit. </p>
210 <p>The following functions support the Performance Monitoring Unit (PMU) that is available on the Cortex-M55/M85 processors.</p>
211 <p>The PMU is used to monitor events that occur during run-time of an application.</p>
212 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="comment">// Initialize counter variables</span></div>
213 <div class="line"> </div>
214 <div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cycle_count = 0;</div>
215 <div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> l1_dcache_miss_count = 0;</div>
216 <div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> instructions_retired_count = 0;</div>
217 <div class="line"> </div>
218 <div class="line"><span class="comment">// Enable the PMU</span></div>
219 <div class="line"><span class="comment">// Note: Before using the PMU, software needs to ensure </span></div>
220 <div class="line"><span class="comment">// that trace is enabled via the Debug Exception Monitor Control Register, DEMCR:</span></div>
221 <div class="line"><span class="comment">// CoreDebug->DEMCR |= CoreDebug_DEMCR_TRCENA_Msk;</span></div>
222 <div class="line"> </div>
223 <div class="line"><a class="code hl_function" href="group__pmu8__functions.html#ga618e7140a774ac2a31a59db4b7d13abc">ARM_PMU_Enable</a>();</div>
224 <div class="line"> </div>
225 <div class="line"><span class="comment">// Configure Event Counter Register 0 to count instructions retired</span></div>
226 <div class="line"><span class="comment">// Configure Event Counter Register 1 to count L1 D-Cache misses</span></div>
227 <div class="line"> </div>
228 <div class="line"><a class="code hl_function" href="group__pmu8__functions.html#ga77ee08f0b3e77d4559cb79fde30d89e9">ARM_PMU_Set_EVTYPER</a>(0, <a class="code hl_define" href="group__pmu8__events__armv81.html#ga8a5e60eee460addfc66e275a2c4c4800">ARM_PMU_INST_RETIRED</a>);</div>
229 <div class="line"><a class="code hl_function" href="group__pmu8__functions.html#ga77ee08f0b3e77d4559cb79fde30d89e9">ARM_PMU_Set_EVTYPER</a>(1, <a class="code hl_define" href="group__pmu8__events__armv81.html#ga4687d5d7efc6f49db2db9acc25b590f6">ARM_PMU_L1D_CACHE_MISS_RD</a>);</div>
230 <div class="line"> </div>
231 <div class="line"><span class="comment">// Reset Event Counters and Cycle Counter</span></div>
232 <div class="line"> </div>
233 <div class="line"><a class="code hl_function" href="group__pmu8__functions.html#ga90527859e6f0ef980300c86c2916ee79">ARM_PMU_EVCNTR_ALL_Reset</a>();</div>
234 <div class="line"><a class="code hl_function" href="group__pmu8__functions.html#ga4288c08039886cd24eb2dd4e743fb97e">ARM_PMU_CYCCNT_Reset</a>();</div>
235 <div class="line"> </div>
236 <div class="line"><span class="comment">// Start incrementing Cycle Count Register and Event Counter Registers 0 & 1</span></div>
237 <div class="line"> </div>
238 <div class="line"><a class="code hl_function" 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>
239 <div class="line"> </div>
240 <div class="line"><span class="comment">// Code you want to measure here</span></div>
241 <div class="line"> </div>
242 <div class="line"><span class="comment">// Stop incrementing Cycle Count Register and Event Counter Registers 0 & 1</span></div>
243 <div class="line"> </div>
244 <div class="line"><a class="code hl_function" 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>
245 <div class="line"> </div>
246 <div class="line"><span class="comment">// Get cycle count, number of instructions retired and number of L1 D-Cache misses (on read)</span></div>
247 <div class="line"> </div>
248 <div class="line">cycle_count = cycle_count + <a class="code hl_function" href="group__pmu8__functions.html#gaaa18c27d39f5a55c1b621f5296b88112">ARM_PMU_Get_CCNTR</a>();</div>
249 <div class="line">instructions_retired_count = instructions_retired_count + <a class="code hl_function" href="group__pmu8__functions.html#ga9768cbaffcf2c0b31febe96db91a85d8">ARM_PMU_Get_EVCNTR</a>(0);</div>
250 <div class="line">l1_dcache_miss_count = l1_dcache_miss_count + <a class="code hl_function" href="group__pmu8__functions.html#ga9768cbaffcf2c0b31febe96db91a85d8">ARM_PMU_Get_EVCNTR</a>(1); <span class="comment">// Note: D-Cache must be enabled using</span></div>
251 <div class="line"> <span class="comment">// SCB_EnableDCache() for meaningful result.</span></div>
252 <div class="ttc" id="agroup__pmu8__events__armv81_html_ga4687d5d7efc6f49db2db9acc25b590f6"><div class="ttname"><a href="group__pmu8__events__armv81.html#ga4687d5d7efc6f49db2db9acc25b590f6">ARM_PMU_L1D_CACHE_MISS_RD</a></div><div class="ttdeci">#define ARM_PMU_L1D_CACHE_MISS_RD</div><div class="ttdoc">Level 1 data cache read miss.</div><div class="ttdef"><b>Definition:</b> ref_pmu8.txt:106</div></div>
253 <div class="ttc" id="agroup__pmu8__events__armv81_html_ga8a5e60eee460addfc66e275a2c4c4800"><div class="ttname"><a href="group__pmu8__events__armv81.html#ga8a5e60eee460addfc66e275a2c4c4800">ARM_PMU_INST_RETIRED</a></div><div class="ttdeci">#define ARM_PMU_INST_RETIRED</div><div class="ttdoc">Instruction architecturally executed.</div><div class="ttdef"><b>Definition:</b> ref_pmu8.txt:71</div></div>
254 <div class="ttc" id="agroup__pmu8__functions_html_ga22e481855ab257180e24f01a38623887"><div class="ttname"><a href="group__pmu8__functions.html#ga22e481855ab257180e24f01a38623887">ARM_PMU_CNTR_Enable</a></div><div class="ttdeci">__STATIC_INLINE void ARM_PMU_CNTR_Enable(uint32_t mask)</div><div class="ttdoc">Enable counters.</div></div>
255 <div class="ttc" id="agroup__pmu8__functions_html_ga4288c08039886cd24eb2dd4e743fb97e"><div class="ttname"><a href="group__pmu8__functions.html#ga4288c08039886cd24eb2dd4e743fb97e">ARM_PMU_CYCCNT_Reset</a></div><div class="ttdeci">__STATIC_INLINE void ARM_PMU_CYCCNT_Reset(void)</div><div class="ttdoc">Reset cycle counter.</div></div>
256 <div class="ttc" id="agroup__pmu8__functions_html_ga618e7140a774ac2a31a59db4b7d13abc"><div class="ttname"><a href="group__pmu8__functions.html#ga618e7140a774ac2a31a59db4b7d13abc">ARM_PMU_Enable</a></div><div class="ttdeci">__STATIC_INLINE void ARM_PMU_Enable(void)</div><div class="ttdoc">Enable the PMU.</div></div>
257 <div class="ttc" id="agroup__pmu8__functions_html_ga76c6f266544c53d93801cfb614155420"><div class="ttname"><a href="group__pmu8__functions.html#ga76c6f266544c53d93801cfb614155420">ARM_PMU_CNTR_Disable</a></div><div class="ttdeci">__STATIC_INLINE void ARM_PMU_CNTR_Disable(uint32_t mask)</div><div class="ttdoc">Disable counters.</div></div>
258 <div class="ttc" id="agroup__pmu8__functions_html_ga77ee08f0b3e77d4559cb79fde30d89e9"><div class="ttname"><a href="group__pmu8__functions.html#ga77ee08f0b3e77d4559cb79fde30d89e9">ARM_PMU_Set_EVTYPER</a></div><div class="ttdeci">__STATIC_INLINE void ARM_PMU_Set_EVTYPER(uint32_t num, uint32_t type)</div><div class="ttdoc">Set event to count for PMU event counter.</div></div>
259 <div class="ttc" id="agroup__pmu8__functions_html_ga90527859e6f0ef980300c86c2916ee79"><div class="ttname"><a href="group__pmu8__functions.html#ga90527859e6f0ef980300c86c2916ee79">ARM_PMU_EVCNTR_ALL_Reset</a></div><div class="ttdeci">__STATIC_INLINE void ARM_PMU_EVCNTR_ALL_Reset(void)</div><div class="ttdoc">Reset all event counters.</div></div>
260 <div class="ttc" id="agroup__pmu8__functions_html_ga9768cbaffcf2c0b31febe96db91a85d8"><div class="ttname"><a href="group__pmu8__functions.html#ga9768cbaffcf2c0b31febe96db91a85d8">ARM_PMU_Get_EVCNTR</a></div><div class="ttdeci">__STATIC_INLINE uint32_t ARM_PMU_Get_EVCNTR(uint32_t num)</div><div class="ttdoc">Read event counter.</div></div>
261 <div class="ttc" id="agroup__pmu8__functions_html_gaaa18c27d39f5a55c1b621f5296b88112"><div class="ttname"><a href="group__pmu8__functions.html#gaaa18c27d39f5a55c1b621f5296b88112">ARM_PMU_Get_CCNTR</a></div><div class="ttdeci">__STATIC_INLINE uint32_t ARM_PMU_Get_CCNTR(void)</div><div class="ttdoc">Read cycle counter.</div></div>
262 </div><!-- fragment --> <h2 class="groupheader">Macro Definition Documentation</h2>
263 <a id="gad19c25be8565f2791aca1a96d1847516" name="gad19c25be8565f2791aca1a96d1847516"></a>
264 <h2 class="memtitle"><span class="permalink"><a href="#gad19c25be8565f2791aca1a96d1847516">◆ </a></span>PMU</h2>
266 <div class="memitem">
267 <div class="memproto">
268 <table class="memname">
270 <td class="memname">#define PMU</td>
273 </div><div class="memdoc">
275 <p>PMU configuration struct. </p>
276 <p>This macro can be used to access the PMU registers, directly. For the common tasks one should prefer using the control functions.</p>
277 <p>Example: <b>Example:</b> </p><div class="fragment"><div class="line"><a class="code hl_define" href="group__pmu8__functions.html#gad19c25be8565f2791aca1a96d1847516">PMU</a>->CTRL |= PMU_CTRL_ENABLE_Msk; <span class="comment">// Enable PMU</span></div>
278 <div class="ttc" id="agroup__pmu8__functions_html_gad19c25be8565f2791aca1a96d1847516"><div class="ttname"><a href="group__pmu8__functions.html#gad19c25be8565f2791aca1a96d1847516">PMU</a></div><div class="ttdeci">#define PMU</div><div class="ttdoc">PMU configuration struct.</div><div class="ttdef"><b>Definition:</b> ref_pmu8.txt:326</div></div>
279 </div><!-- fragment -->
282 <h2 class="groupheader">Function Documentation</h2>
283 <a id="ga76c6f266544c53d93801cfb614155420" name="ga76c6f266544c53d93801cfb614155420"></a>
284 <h2 class="memtitle"><span class="permalink"><a href="#ga76c6f266544c53d93801cfb614155420">◆ </a></span>ARM_PMU_CNTR_Disable()</h2>
286 <div class="memitem">
287 <div class="memproto">
288 <table class="memname">
290 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CNTR_Disable </td>
292 <td class="paramtype">uint32_t </td>
293 <td class="paramname"><em>mask</em></td><td>)</td>
297 </div><div class="memdoc">
299 <p>Disable counters. </p>
300 <dl class="params"><dt>Parameters</dt><dd>
301 <table class="params">
302 <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counters to enable </td></tr>
306 <dl class="section note"><dt>Note</dt><dd>Disables one or more of the following:<ul>
307 <li>event counters (0-30)</li>
308 <li>cycle counter </li>
314 <a id="ga22e481855ab257180e24f01a38623887" name="ga22e481855ab257180e24f01a38623887"></a>
315 <h2 class="memtitle"><span class="permalink"><a href="#ga22e481855ab257180e24f01a38623887">◆ </a></span>ARM_PMU_CNTR_Enable()</h2>
317 <div class="memitem">
318 <div class="memproto">
319 <table class="memname">
321 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CNTR_Enable </td>
323 <td class="paramtype">uint32_t </td>
324 <td class="paramname"><em>mask</em></td><td>)</td>
328 </div><div class="memdoc">
330 <p>Enable counters. </p>
331 <dl class="params"><dt>Parameters</dt><dd>
332 <table class="params">
333 <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counters to enable </td></tr>
337 <dl class="section note"><dt>Note</dt><dd>Enables one or more of the following:<ul>
338 <li>event counters (0-30)</li>
339 <li>cycle counter </li>
345 <a id="ga27b07d38050a16ce416bfaf151a24944" name="ga27b07d38050a16ce416bfaf151a24944"></a>
346 <h2 class="memtitle"><span class="permalink"><a href="#ga27b07d38050a16ce416bfaf151a24944">◆ </a></span>ARM_PMU_CNTR_Increment()</h2>
348 <div class="memitem">
349 <div class="memproto">
350 <table class="memname">
352 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CNTR_Increment </td>
354 <td class="paramtype">uint32_t </td>
355 <td class="paramname"><em>mask</em></td><td>)</td>
359 </div><div class="memdoc">
361 <p>Software increment event counter. </p>
362 <dl class="params"><dt>Parameters</dt><dd>
363 <table class="params">
364 <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counters to increment </td></tr>
368 <dl class="section note"><dt>Note</dt><dd>Software increment bits for one or more event counters (0-30) </dd></dl>
372 <a id="ga4288c08039886cd24eb2dd4e743fb97e" name="ga4288c08039886cd24eb2dd4e743fb97e"></a>
373 <h2 class="memtitle"><span class="permalink"><a href="#ga4288c08039886cd24eb2dd4e743fb97e">◆ </a></span>ARM_PMU_CYCCNT_Reset()</h2>
375 <div class="memitem">
376 <div class="memproto">
377 <table class="memname">
379 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_CYCCNT_Reset </td>
381 <td class="paramtype">void </td>
382 <td class="paramname"></td><td>)</td>
386 </div><div class="memdoc">
388 <p>Reset cycle counter. </p>
392 <a id="ga74273d4a47cf1a5e99d857a3e8896f10" name="ga74273d4a47cf1a5e99d857a3e8896f10"></a>
393 <h2 class="memtitle"><span class="permalink"><a href="#ga74273d4a47cf1a5e99d857a3e8896f10">◆ </a></span>ARM_PMU_Disable()</h2>
395 <div class="memitem">
396 <div class="memproto">
397 <table class="memname">
399 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Disable </td>
401 <td class="paramtype">void </td>
402 <td class="paramname"></td><td>)</td>
406 </div><div class="memdoc">
408 <p>Disable the PMU. </p>
412 <a id="ga618e7140a774ac2a31a59db4b7d13abc" name="ga618e7140a774ac2a31a59db4b7d13abc"></a>
413 <h2 class="memtitle"><span class="permalink"><a href="#ga618e7140a774ac2a31a59db4b7d13abc">◆ </a></span>ARM_PMU_Enable()</h2>
415 <div class="memitem">
416 <div class="memproto">
417 <table class="memname">
419 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Enable </td>
421 <td class="paramtype">void </td>
422 <td class="paramname"></td><td>)</td>
426 </div><div class="memdoc">
428 <p>Enable the PMU. </p>
432 <a id="ga90527859e6f0ef980300c86c2916ee79" name="ga90527859e6f0ef980300c86c2916ee79"></a>
433 <h2 class="memtitle"><span class="permalink"><a href="#ga90527859e6f0ef980300c86c2916ee79">◆ </a></span>ARM_PMU_EVCNTR_ALL_Reset()</h2>
435 <div class="memitem">
436 <div class="memproto">
437 <table class="memname">
439 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_EVCNTR_ALL_Reset </td>
441 <td class="paramtype">void </td>
442 <td class="paramname"></td><td>)</td>
446 </div><div class="memdoc">
448 <p>Reset all event counters. </p>
452 <a id="gaaa18c27d39f5a55c1b621f5296b88112" name="gaaa18c27d39f5a55c1b621f5296b88112"></a>
453 <h2 class="memtitle"><span class="permalink"><a href="#gaaa18c27d39f5a55c1b621f5296b88112">◆ </a></span>ARM_PMU_Get_CCNTR()</h2>
455 <div class="memitem">
456 <div class="memproto">
457 <table class="memname">
459 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t ARM_PMU_Get_CCNTR </td>
461 <td class="paramtype">void </td>
462 <td class="paramname"></td><td>)</td>
466 </div><div class="memdoc">
468 <p>Read cycle counter. </p>
469 <dl class="section return"><dt>Returns</dt><dd>Cycle count </dd></dl>
473 <a id="ga70436b378b75bdfe3fcb47697d309a96" name="ga70436b378b75bdfe3fcb47697d309a96"></a>
474 <h2 class="memtitle"><span class="permalink"><a href="#ga70436b378b75bdfe3fcb47697d309a96">◆ </a></span>ARM_PMU_Get_CNTR_OVS()</h2>
476 <div class="memitem">
477 <div class="memproto">
478 <table class="memname">
480 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t ARM_PMU_Get_CNTR_OVS </td>
482 <td class="paramtype">void </td>
483 <td class="paramname"></td><td>)</td>
487 </div><div class="memdoc">
489 <p>Read counter overflow status. </p>
490 <dl class="section return"><dt>Returns</dt><dd>Counter overflow status bits for the following:<ul>
491 <li>event counters (0-30)</li>
492 <li>cycle counter </li>
498 <a id="ga9768cbaffcf2c0b31febe96db91a85d8" name="ga9768cbaffcf2c0b31febe96db91a85d8"></a>
499 <h2 class="memtitle"><span class="permalink"><a href="#ga9768cbaffcf2c0b31febe96db91a85d8">◆ </a></span>ARM_PMU_Get_EVCNTR()</h2>
501 <div class="memitem">
502 <div class="memproto">
503 <table class="memname">
505 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t ARM_PMU_Get_EVCNTR </td>
507 <td class="paramtype">uint32_t </td>
508 <td class="paramname"><em>num</em></td><td>)</td>
512 </div><div class="memdoc">
514 <p>Read event counter. </p>
515 <dl class="params"><dt>Parameters</dt><dd>
516 <table class="params">
517 <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Event counter (0-30) to read </td></tr>
521 <dl class="section return"><dt>Returns</dt><dd>Event count </dd></dl>
525 <a id="ga731b6cd01c6eaa6f909164602f19d0bc" name="ga731b6cd01c6eaa6f909164602f19d0bc"></a>
526 <h2 class="memtitle"><span class="permalink"><a href="#ga731b6cd01c6eaa6f909164602f19d0bc">◆ </a></span>ARM_PMU_Set_CNTR_IRQ_Disable()</h2>
528 <div class="memitem">
529 <div class="memproto">
530 <table class="memname">
532 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_CNTR_IRQ_Disable </td>
534 <td class="paramtype">uint32_t </td>
535 <td class="paramname"><em>mask</em></td><td>)</td>
539 </div><div class="memdoc">
541 <p>Disable counter overflow interrupt request. </p>
542 <dl class="params"><dt>Parameters</dt><dd>
543 <table class="params">
544 <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counter overflow interrupt request bits to clear </td></tr>
548 <dl class="section note"><dt>Note</dt><dd>Clears overflow interrupt request bits for one or more of the following:<ul>
549 <li>event counters (0-30)</li>
550 <li>cycle counter </li>
556 <a id="ga133168437a20566d319c78b751425c44" name="ga133168437a20566d319c78b751425c44"></a>
557 <h2 class="memtitle"><span class="permalink"><a href="#ga133168437a20566d319c78b751425c44">◆ </a></span>ARM_PMU_Set_CNTR_IRQ_Enable()</h2>
559 <div class="memitem">
560 <div class="memproto">
561 <table class="memname">
563 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_CNTR_IRQ_Enable </td>
565 <td class="paramtype">uint32_t </td>
566 <td class="paramname"><em>mask</em></td><td>)</td>
570 </div><div class="memdoc">
572 <p>Enable counter overflow interrupt request. </p>
573 <dl class="params"><dt>Parameters</dt><dd>
574 <table class="params">
575 <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counter overflow interrupt request bits to set </td></tr>
579 <dl class="section note"><dt>Note</dt><dd>Sets overflow interrupt request bits for one or more of the following:<ul>
580 <li>event counters (0-30)</li>
581 <li>cycle counter </li>
587 <a id="ga18376f0e3829e93e99149847667e5864" name="ga18376f0e3829e93e99149847667e5864"></a>
588 <h2 class="memtitle"><span class="permalink"><a href="#ga18376f0e3829e93e99149847667e5864">◆ </a></span>ARM_PMU_Set_CNTR_OVS()</h2>
590 <div class="memitem">
591 <div class="memproto">
592 <table class="memname">
594 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_CNTR_OVS </td>
596 <td class="paramtype">uint32_t </td>
597 <td class="paramname"><em>mask</em></td><td>)</td>
601 </div><div class="memdoc">
603 <p>Clear counter overflow status. </p>
604 <dl class="params"><dt>Parameters</dt><dd>
605 <table class="params">
606 <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Counter overflow status bits to clear </td></tr>
610 <dl class="section note"><dt>Note</dt><dd>Clears overflow status bits for one or more of the following:<ul>
611 <li>event counters (0-30)</li>
612 <li>cycle counter </li>
618 <a id="ga77ee08f0b3e77d4559cb79fde30d89e9" name="ga77ee08f0b3e77d4559cb79fde30d89e9"></a>
619 <h2 class="memtitle"><span class="permalink"><a href="#ga77ee08f0b3e77d4559cb79fde30d89e9">◆ </a></span>ARM_PMU_Set_EVTYPER()</h2>
621 <div class="memitem">
622 <div class="memproto">
623 <table class="memname">
625 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void ARM_PMU_Set_EVTYPER </td>
627 <td class="paramtype">uint32_t </td>
628 <td class="paramname"><em>num</em>, </td>
631 <td class="paramkey"></td>
633 <td class="paramtype">uint32_t </td>
634 <td class="paramname"><em>type</em> </td>
642 </div><div class="memdoc">
644 <p>Set event to count for PMU event counter. </p>
645 <dl class="params"><dt>Parameters</dt><dd>
646 <table class="params">
647 <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Event counter (0-30) to configure </td></tr>
648 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Event to count </td></tr>
655 </div><!-- contents -->
656 </div><!-- doc-content -->
657 <!-- start footer part -->
658 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
661 <script type="text/javascript">
663 writeFooter.call(this);