aboutsummaryrefslogtreecommitdiff
path: root/doc/device-tree/opencapi.html
blob: 087ab6920b2dee8c7bb13eb78f6a3d8408517962 (plain)
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

<!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>OpenCAPI Device Tree Bindings &#8212; skiboot 4d27f03
 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="PCI Device Tree Bindings" href="pci.html" />
    <link rel="prev" title="Nest (NX) Accelerator Coprocessor" href="nx.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="pci.html" title="PCI Device Tree Bindings"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="nx.html" title="Nest (NX) Accelerator Coprocessor"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">skiboot 4d27f03
 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="opencapi-device-tree-bindings">
<span id="device-tree-opencapi"></span><h1>OpenCAPI Device Tree Bindings<a class="headerlink" href="#opencapi-device-tree-bindings" title="Permalink to this headline"></a></h1>
<div class="section" id="npu-bindings">
<h2>NPU bindings<a class="headerlink" href="#npu-bindings" title="Permalink to this headline"></a></h2>
<p>The NPU nodes are similar to those in <a class="reference internal" href="nvlink.html"><span class="doc">Nvlink Device Tree Bindings</span></a>.</p>
<p>We distinguish between OpenCAPI and NVLink links using the
<cite>ibm.npu-link-type</cite> property. NPUs with a mixture of OpenCAPI and
NVLink links are currently unsupported.</p>
<div class="highlight-dts notranslate"><div class="highlight"><pre><span></span><span class="nc">xscom</span><span class="nf">@603fc00000000</span> <span class="p">{</span>
  <span class="nc">npu</span><span class="nf">@5011000</span> <span class="p">{</span>
    <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,power9-npu&quot;</span><span class="p">;</span>
    <span class="nf">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0xe6</span><span class="p">&gt;;</span>
    <span class="nf">reg</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x5011000</span> <span class="mh">0x2c</span><span class="p">&gt;;</span>
    <span class="nf">ibm,npu-index</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x0</span><span class="p">&gt;;</span>
    <span class="nf">ibm,npu-links</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x2</span><span class="p">&gt;;</span> <span class="cm">/* Number of links wired up to this npu. */</span>

    <span class="nc">link</span><span class="nf">@2</span> <span class="p">{</span>
      <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,npu-link&quot;</span><span class="p">;</span>
      <span class="nf">ibm,npu-link-type</span> <span class="o">=</span> <span class="s">&quot;opencapi&quot;</span><span class="p">;</span>
      <span class="nf">ibm,npu-group-id</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>
      <span class="nf">ibm,npu-lane-mask</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0xf1e000</span><span class="p">&gt;;</span> <span class="cm">/* Mask specifying which IBM PHY lanes</span>
<span class="cm">                                       * are used for this link. 24-bit,</span>
<span class="cm">                                       * lane 0 is most significant bit */</span>
      <span class="nf">ibm,npu-phy</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x80000000</span> <span class="mh">0x9010c3f</span><span class="p">&gt;;</span> <span class="cm">/* SCOM address of the IBM PHY</span>
<span class="cm">                                             * controlling this link. */</span>
      <span class="nf">ibm,npu-link-index</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x2</span><span class="p">&gt;;</span> <span class="cm">/* Hardware link index.</span>
<span class="cm">                                   * Used to calculate various address offsets. */</span>
      <span class="nf">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0xe7</span><span class="p">&gt;;</span>
    <span class="p">};</span>

    <span class="nc">link</span><span class="nf">@3</span> <span class="p">{</span>
      <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,npu-link&quot;</span><span class="p">;</span>
      <span class="nf">ibm,npu-link-type</span> <span class="o">=</span> <span class="s">&quot;opencapi&quot;</span><span class="p">;</span>
      <span class="nf">ibm,npu-group-id</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x2</span><span class="p">&gt;;</span>
      <span class="nf">ibm,npu-lane-mask</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x78f</span><span class="p">&gt;;</span>
      <span class="nf">ibm,npu-phy</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x80000000</span> <span class="mh">0x9010c3f</span><span class="p">&gt;;</span>
      <span class="nf">ibm,npu-link-index</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x3</span><span class="p">&gt;;</span>
      <span class="nf">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0xe8</span><span class="p">&gt;;</span>
    <span class="p">};</span>
  <span class="p">};</span>
<span class="p">};</span>
</pre></div>
</div>
</div>
<div class="section" id="pci-device-bindings">
<h2>PCI device bindings<a class="headerlink" href="#pci-device-bindings" title="Permalink to this headline"></a></h2>
<p>The PCI devices mostly look like regular PCI devices (see <a class="reference internal" href="pci.html"><span class="doc">PCI Device Tree Bindings</span></a>),
but have a few additional fields to allow the devices to be associated
with the relevant NPU. These fields are presently not consumed by
anything but may be used in future.</p>
<div class="highlight-dts notranslate"><div class="highlight"><pre><span></span><span class="nc">pciex</span><span class="nf">@600e800000000</span> <span class="p">{</span>
  <span class="cm">/* OpenCAPI specific properties */</span>
  <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,power9-npu-opencapi-pciex&quot;, &quot;ibm,ioda2-npu2-opencapi-phb&quot;</span><span class="p">;</span>
  <span class="nf">ibm,npcq</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0xe6</span><span class="p">&gt;;</span> <span class="cm">/* phandle to the NPU node */</span>
  <span class="nf">ibm,npu-index</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x0</span><span class="p">&gt;;</span>
  <span class="nf">ibm,links</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1</span><span class="p">&gt;;</span>
  <span class="cm">/* Generic PCI fields here */</span>
<span class="err">}</span>
</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="#">OpenCAPI Device Tree Bindings</a><ul>
<li><a class="reference internal" href="#npu-bindings">NPU bindings</a></li>
<li><a class="reference internal" href="#pci-device-bindings">PCI device bindings</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="nx.html"
                        title="previous chapter">Nest (NX) Accelerator Coprocessor</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pci.html"
                        title="next chapter">PCI Device Tree Bindings</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/device-tree/opencapi.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="pci.html" title="PCI Device Tree Bindings"
             >next</a> |</li>
        <li class="right" >
          <a href="nx.html" title="Nest (NX) Accelerator Coprocessor"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">skiboot 4d27f03
 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>