aboutsummaryrefslogtreecommitdiff
path: root/doc/device-tree/ibm,opal/flash.html
blob: 191b4eec5c48f92894525212abaff21021e33c5a (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

<!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>ibm,opal/flash device tree entries &#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="Service Indicators (LEDS)" href="led.html" />
    <link rel="prev" title="System Firmware" href="firmware.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="led.html" title="Service Indicators (LEDS)"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="firmware.html" title="System Firmware"
             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" >Device Tree</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../ibm,opal.html" accesskey="U">ibm,opal</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="ibm-opal-flash-device-tree-entries">
<span id="device-tree-ibm-opal-flash"></span><h1>ibm,opal/flash device tree entries<a class="headerlink" href="#ibm-opal-flash-device-tree-entries" title="Permalink to this headline"></a></h1>
<p>The flash&#64;&lt;n&gt; nodes under ibm,opal describe flash devices that can be
accessed through the OPAL_FLASH_{READ,ERASE,WRITE} interface.</p>
<p>These interfaces take an ‘id’ parameter, which corresponds to the ibm,opal-id
property of the node.</p>
<p>The properties under a flash node are:</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">compatible</span> <span class="pre">=</span> <span class="pre">&quot;ibm,opal-flash&quot;</span></code></li>
</ul>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">ibm,opal-id</span> <span class="pre">=</span> <span class="pre">&lt;id&gt;</span></code></dt>
<dd>provides the index used for the OPAL_FLASH_XXX calls to reference this
flash device</dd>
<dt><code class="docutils literal notranslate"><span class="pre">reg</span> <span class="pre">=</span> <span class="pre">&lt;0</span> <span class="pre">size&gt;</span></code></dt>
<dd>the offset and size of the flash device</dd>
<dt><code class="docutils literal notranslate"><span class="pre">ibm,flash-block-size</span></code></dt>
<dd>the read/write/erase block size for the flash interface. Calls
to read/write/erase must be aligned to the block size.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">#address-cells</span> <span class="pre">=</span> <span class="pre">&lt;1&gt;</span></code>, <code class="docutils literal notranslate"><span class="pre">#size-cells</span> <span class="pre">=</span> <span class="pre">&lt;1&gt;</span></code></dt>
<dd>flash devices are currently 32-bit addressable</dd>
</dl>
<p>If valid partitions are found on the flash device, then <code class="docutils literal notranslate"><span class="pre">partition&#64;&lt;offset&gt;</span></code>
sub-nodes are added to the flash node. These match the Linux binding for
flash partitions; the reg parameter contains the offset and size of the
partition.</p>
<p>Example:</p>
<div class="highlight-dts notranslate"><div class="highlight"><pre><span></span><span class="nc">flash</span><span class="nf">@0</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">0x4000000</span><span class="p">&gt;;</span>
  <span class="nf">compatible</span> <span class="o">=</span> <span class="s">&quot;ibm,opal-flash&quot;</span><span class="p">;</span>
  <span class="nf">ibm,opal-id</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x0</span><span class="p">&gt;;</span>
  <span class="nf">ibm,flash-block-size</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x1000</span><span class="p">&gt;;</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">phandle</span> <span class="o">=</span> <span class="p">&lt;</span><span class="mh">0x100002bf</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="p">};</span>
</pre></div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="firmware.html"
                        title="previous chapter">System Firmware</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="led.html"
                        title="next chapter">Service Indicators (LEDS)</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/device-tree/ibm,opal/flash.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="led.html" title="Service Indicators (LEDS)"
             >next</a> |</li>
        <li class="right" >
          <a href="firmware.html" title="System Firmware"
             >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>
          <li class="nav-item nav-item-2"><a href="../ibm,opal.html" >ibm,opal</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>