doc/opal-api/opal-get-device-tree-118.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


<!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>OPAL_GET_DEVICE_TREE &#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="OPAL_GET_EPOW_STATUS" href="opal-get-epow-status-56.html" />
    <link rel="prev" title="OPAL Flash calls" href="opal-flash-110-111-112.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="opal-get-epow-status-56.html" title="OPAL_GET_EPOW_STATUS"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="opal-flash-110-111-112.html" title="OPAL Flash calls"
             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">OPAL API Documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="opal-get-device-tree">
<span id="id1"></span><h1>OPAL_GET_DEVICE_TREE<a class="headerlink" href="#opal-get-device-tree" title="Permalink to this headline">¶</a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_GET_DEVICE_TREE                 118</span>

<span class="kt">int64_t</span> <span class="nf">opal_get_device_tree</span><span class="p">(</span><span class="kt">uint32_t</span> <span class="n">phandle</span><span class="p">,</span> <span class="kt">uint64_t</span> <span class="n">buf</span><span class="p">,</span> <span class="kt">uint64_t</span> <span class="n">len</span><span class="p">);</span>
</pre></div>
</div>
<p>Get device sub-tree.</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">uint32_t</span> <span class="pre">phandle</span></code></dt>
<dd>root device node phandle of the device sub-tree</dd>
<dt><code class="docutils literal notranslate"><span class="pre">uint64_t</span> <span class="pre">buf</span></code></dt>
<dd>FDT blob buffer or NULL</dd>
<dt><code class="docutils literal notranslate"><span class="pre">uint64_t</span> <span class="pre">len</span></code></dt>
<dd>length of the FDT blob buffer</dd>
</dl>
<p>Retrieve device sub-tree. The root node’s phandle is identified by &#64;phandle.
The typical use is for the kernel to update its device tree following a change
in hardware (e.g. PCI hotplug).</p>
<div class="section" id="return-codes">
<h2>Return Codes<a class="headerlink" href="#return-codes" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>FDT blob size</dt>
<dd>returned FDT blob buffer size when <code class="docutils literal notranslate"><span class="pre">buf</span></code> is NULL</dd>
<dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt>
<dd>FDT blob is created successfully</dd>
<dt><a class="reference internal" href="return-codes.html#opal-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt>
<dd>invalid argument &#64;phandle or &#64;len</dd>
<dt><a class="reference internal" href="return-codes.html#opal-internal-error"><span class="std std-ref">OPAL_INTERNAL_ERROR</span></a></dt>
<dd>failure creating FDT blob when calculating its size</dd>
<dt><a class="reference internal" href="return-codes.html#opal-no-mem"><span class="std std-ref">OPAL_NO_MEM</span></a></dt>
<dd>not enough room in buffer for device sub-tree</dd>
<dt><a class="reference internal" href="return-codes.html#opal-empty"><span class="std std-ref">OPAL_EMPTY</span></a></dt>
<dd>failure creating FDT blob</dd>
</dl>
</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="#">OPAL_GET_DEVICE_TREE</a><ul>
<li><a class="reference internal" href="#return-codes">Return Codes</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="opal-flash-110-111-112.html"
                        title="previous chapter">OPAL Flash calls</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="opal-get-epow-status-56.html"
                        title="next chapter">OPAL_GET_EPOW_STATUS</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/opal-api/opal-get-device-tree-118.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="opal-get-epow-status-56.html" title="OPAL_GET_EPOW_STATUS"
             >next</a> |</li>
        <li class="right" >
          <a href="opal-flash-110-111-112.html" title="OPAL Flash calls"
             >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" >OPAL API Documentation</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>