doc/device-tree/imc.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>IMC Device Tree Bindings &#8212; skiboot d9772c6
 documentation</title>
    <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <script type="text/javascript" src="../_static/language_data.js"></script>
    
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="P9 memory hierarchy" href="memory-hierarchy.html" />
    <link rel="prev" title="ibm,secureboot" href="ibm,secureboot.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="memory-hierarchy.html" title="P9 memory hierarchy"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="ibm,secureboot.html" title="ibm,secureboot"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">skiboot d9772c6
 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Device Tree</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="imc-device-tree-bindings">
<span id="device-tree-imc"></span><h1>IMC Device Tree Bindings<a class="headerlink" href="#imc-device-tree-bindings" title="Permalink to this headline">¶</a></h1>
<p>See <a class="reference internal" href="../imc.html#imc"><span class="std std-ref">OPAL/Skiboot In-Memory Collection (IMC) interface Documentation</span></a> for general In-Memory Collection (IMC) counter information.</p>
<div class="section" id="imc-counters-top-level-node">
<h2>imc-counters top-level node<a class="headerlink" href="#imc-counters-top-level-node" title="Permalink to this headline">¶</a></h2>
<div class="highlight-dts notranslate"><div class="highlight"><pre><span></span><span class="nc">imc-counters</span> <span class="p">{</span>
  <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,opal-in-memory-counters&quot;</span><span class="p">;</span>
  <span class="nf">#address-cells</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>
  <span class="nf">#size-cells</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>
  <span class="nf">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1000023a</span><span class="p">&gt;;</span>
  <span class="nf">version-id</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0xd</span><span class="p">&gt;;</span>
  <span class="cm">/* Denote IMC Events Catalog version used to build this DTS file. */</span>

<span class="p">};</span>
</pre></div>
</div>
</div>
<div class="section" id="imc-device-units-bindings">
<h2>IMC device/units bindings<a class="headerlink" href="#imc-device-units-bindings" title="Permalink to this headline">¶</a></h2>
<div class="highlight-dts notranslate"><div class="highlight"><pre><span></span><span class="nc">mcs3</span> <span class="p">{</span>
        <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,imc-counters&quot;</span><span class="p">;</span>
        <span class="nf">events-prefix</span> <span class="o">=</span> <span class="s">&quot;PM_MCS3_&quot;</span><span class="p">;</span> <span class="cm">/* denotes event name to be prefixed to get complete event name supported by this device */</span>

        <span class="nf">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x10000241</span><span class="p">&gt;;</span>
        <span class="nf">events</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x10000242</span><span class="p">&gt;;</span> <span class="cm">/* phandle of the events node supported by this device */</span>

        <span class="nf">unit</span> <span class="o">=</span> <span class="s">&quot;MiB&quot;</span><span class="p">;</span>
        <span class="nf">scale</span> <span class="o">=</span> <span class="s">&quot;4&quot;</span><span class="p">;</span> <span class="cm">/* unit and scale for all the events for this device */</span>

        <span class="nf">reg</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x118</span> <span class="mh">0x8</span><span class="p">&gt;;</span> <span class="cm">/* denotes base address for device event updates */</span>
        <span class="nf">type</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x10</span><span class="p">&gt;;</span>
        <span class="nf">size</span> <span class="o">=</span> <span class="mh">0x40000</span><span class="p">;</span>
        <span class="nf">offset</span> <span class="o">=</span> <span class="mh">0x180000</span><span class="p">;</span>
        <span class="nf">base_addr</span> <span class="o">=</span> <span class="p">&lt;</span><span class="err">Base</span> <span class="err">address</span> <span class="err">of</span> <span class="err">the</span> <span class="err">counter</span> <span class="err">in</span> <span class="err">reserve</span> <span class="err">memory</span><span class="p">&gt;</span>
        <span class="cm">/* This is per-chip memory field and OPAL files it based on the no of chip in the system */</span>
        <span class="cm">/* base_addr property also indicates (or hints) kernel whether to memory */</span>
        <span class="cm">/* should be mmapped or allocated at system start for the counters */</span>
        <span class="err">chipids</span> <span class="err">=</span> <span class="p">&lt;</span><span class="err">chip-id</span> <span class="err">for</span> <span class="err">the</span> <span class="err">base_addr</span> <span class="p">&gt;</span>
<span class="err">}</span><span class="p">;</span>

<span class="nc">trace</span><span class="nf">@0</span> <span class="p">{</span>
         <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,imc-counters&quot;</span><span class="p">;</span>
         <span class="nf">events-prefix</span> <span class="o">=</span> <span class="s">&quot;trace_&quot;</span><span class="p">;</span>
         <span class="nf">reg</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x0</span> <span class="mh">0x8</span><span class="p">&gt;;</span>
         <span class="nf">events</span> <span class="o">=</span> <span class="p">&lt;</span> <span class="o">&amp;</span>TRACE_IMC <span class="p">&gt;;</span>
         <span class="nf">type</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x2</span><span class="p">&gt;;</span>
         <span class="nf">size</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x40000</span><span class="p">&gt;;</span>
 <span class="p">};</span>
</pre></div>
</div>
</div>
<div class="section" id="imc-device-event-bindings">
<h2>IMC device event bindings<a class="headerlink" href="#imc-device-event-bindings" title="Permalink to this headline">¶</a></h2>
<div class="highlight-dts notranslate"><div class="highlight"><pre><span></span><span class="nc">nest-mcs-events</span> <span class="p">{</span>
        <span class="nf">#address-cells</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>
        <span class="nf">#size-cells</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>
        <span class="nf">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x10000242</span><span class="p">&gt;;</span>

        <span class="nc">event</span><span class="nf">@98</span> <span class="p">{</span>
              <span class="nf">desc</span> <span class="o">=</span> <span class="s">&quot;Total Write Bandwidth seen on both MCS&quot;</span><span class="p">;</span> <span class="cm">/* event description */</span>

              <span class="nf">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1000023d</span><span class="p">&gt;;</span>
              <span class="nf">reg</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x98</span> <span class="mh">0x8</span><span class="p">&gt;;</span> <span class="cm">/* event offset,when added with (nest-offset-address + device reg) will point to actual counter memory */</span>

              <span class="nf">event-name</span> <span class="o">=</span> <span class="s">&quot;DOWN_128B_DATA_XFER&quot;</span><span class="p">;</span> <span class="cm">/* denotes the actual event name */</span>

        <span class="p">};</span>

        <span class="cm">/* List of events supported */</span>

<span class="p">};</span>

<span class="nl">TRACE_IMC:</span> <span class="nc">trace-events</span> <span class="p">{</span>
      <span class="nf">#address-cells</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>
      <span class="nf">#size-cells</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>

      <span class="nc">event</span><span class="nf">@10200000</span> <span class="p">{</span>
            <span class="nf">event-name</span> <span class="o">=</span> <span class="s">&quot;cycles&quot;</span> <span class="p">;</span> <span class="cm">/* For trace node, we only have cycles event now */</span>
            <span class="nf">reg</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x10200000</span> <span class="mh">0x8</span><span class="p">&gt;;</span>
            <span class="nf">desc</span> <span class="o">=</span> <span class="s">&quot;Reference cycles&quot;</span> <span class="p">;</span>
      <span class="p">};</span>
 <span class="p">};</span>
</pre></div>
</div>
</div>
<div class="section" id="trace-mode-scom">
<h2>Trace-mode SCOM<a class="headerlink" href="#trace-mode-scom" title="Permalink to this headline">¶</a></h2>
<p>Trace scom is a 64 bit value which contains the event information for
IMC-trace mode. Following is the trace-scom layout.</p>
<p><strong>TRACE_IMC_SCOM bit representation</strong></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">0-1:</th><td class="field-body">SAMPSEL</td>
</tr>
<tr class="field-even field"><th class="field-name">2-33:</th><td class="field-body">CPMC_LOAD</td>
</tr>
<tr class="field-odd field"><th class="field-name">34-40:</th><td class="field-body">CPMC1SEL</td>
</tr>
<tr class="field-even field"><th class="field-name">41-47:</th><td class="field-body">CPMC2SEL</td>
</tr>
<tr class="field-odd field"><th class="field-name">48-50:</th><td class="field-body">BUFFERSIZE</td>
</tr>
<tr class="field-even field"><th class="field-name">51-63:</th><td class="field-body">RESERVED</td>
</tr>
</tbody>
</table>
<p><em>CPMC_LOAD</em> contains the sampling duration. <em>SAMPSEL</em> and <em>CPMC*SEL</em>
determines the event to count. <em>BUFFRSIZE</em> indicates the memory range.</p>
<p><em>BUFFERSIZE</em> can be</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>b’000’ - 4K entries * 64 per entry = 256K
b’001’ - 8K entries * 64 per entry = 512K
b’010’ - 16K entries * 64 per entry = 1M
b’011’ - 32K entries * 64 per entry = 2M
b’100’ - 64K entries * 64 per entry = 4M
</pre></div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">IMC Device Tree Bindings</a><ul>
<li><a class="reference internal" href="#imc-counters-top-level-node">imc-counters top-level node</a></li>
<li><a class="reference internal" href="#imc-device-units-bindings">IMC device/units bindings</a></li>
<li><a class="reference internal" href="#imc-device-event-bindings">IMC device event bindings</a></li>
<li><a class="reference internal" href="#trace-mode-scom">Trace-mode SCOM</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="ibm,secureboot.html"
                        title="previous chapter">ibm,secureboot</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="memory-hierarchy.html"
                        title="next chapter">P9 memory hierarchy</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/device-tree/imc.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="memory-hierarchy.html" title="P9 memory hierarchy"
             >next</a> |</li>
        <li class="right" >
          <a href="ibm,secureboot.html" title="ibm,secureboot"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">skiboot d9772c6
 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >Device Tree</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2016-2017, IBM, others.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    </div>
  </body>
</html>