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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
<!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 MPIPL APIs — 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_NMMU_SET_PTCR" href="opal-nmmu-set-ptcr-127.html" />
<link rel="prev" title="OPAL_MESSAGE" href="opal-messages.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-nmmu-set-ptcr-127.html" title="OPAL_NMMU_SET_PTCR"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="opal-messages.html" title="OPAL_MESSAGE"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot d9772c6
documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">OPAL API Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="opal-mpipl-apis">
<span id="opal-api-mpipl"></span><h1>OPAL MPIPL APIs<a class="headerlink" href="#opal-mpipl-apis" title="Permalink to this headline">¶</a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_MPIPL_UPDATE 173</span>
<span class="cp">#define OPAL_MPIPL_REGISTER_TAG 174</span>
<span class="cp">#define OPAL_MPIPL_QUERY_TAG 175</span>
</pre></div>
</div>
<p>These calls are used for MPIPL (Memory Preserving Initial Program Load).</p>
<p>It is an OPTIONAL part of the OPAL spec.</p>
<p>If a platform supports MPIPL, then we will have “/ibm,opal/dump” node in
device tree (see <a class="reference internal" href="../device-tree/ibm,opal/dump.html#device-tree-ibm-opal-dump"><span class="std std-ref">Dump (MPIPL) Device Tree Binding</span></a>).</p>
</div>
<div class="section" id="opal-mpipl-update">
<span id="id1"></span><h1>OPAL_MPIPL_UPDATE<a class="headerlink" href="#opal-mpipl-update" title="Permalink to this headline">¶</a></h1>
<p>Linux kernel will use this call to register/unregister MPIPL.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_MPIPL_UPDATE 173</span>
<span class="kt">int64_t</span> <span class="nf">opal_mpipl_update</span><span class="p">(</span><span class="k">enum</span> <span class="n">mpipl_ops</span> <span class="n">ops</span><span class="p">,</span> <span class="n">u64</span> <span class="n">src</span><span class="p">,</span> <span class="n">u64</span> <span class="n">dest</span><span class="p">,</span> <span class="n">u64</span> <span class="n">size</span><span class="p">)</span>
<span class="cm">/* MPIPL update operations */</span>
<span class="k">enum</span> <span class="n">mpipl_ops</span> <span class="p">{</span>
<span class="n">OPAL_MPIPL_ADD_RANGE</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">OPAL_MPIPL_REMOVE_RANGE</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">OPAL_MPIPL_REMOVE_ALL</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>
<span class="n">OPAL_MPIPL_FREE_PRESERVED_MEMORY</span><span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
<span class="p">};</span>
</pre></div>
</div>
<div class="section" id="ops">
<h2>ops :<a class="headerlink" href="#ops" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><dl class="docutils">
<dt>OPAL_MPIPL_ADD_RANGE</dt>
<dd>Add new entry to MPIPL table. Kernel will send src, dest and size.
During MPIPL content from source address is moved to destination address.
src = Source start address
dest = Destination start address
size = size</dd>
<dt>OPAL_MPIPL_REMOVE_RANGE</dt>
<dd>Remove kernel requested entry from MPIPL table.
src = Source start address
dest = Destination start address
size = ignore</dd>
<dt>OPAL_MPIPL_REMOVE_ALL</dt>
<dd>Remove all kernel passed entry from MPIPL table.
src = ignore
dest = ignore
size = ignore</dd>
<dt>OPAL_MPIPL_FREE_PRESERVED_MEMORY</dt>
<dd>Post MPIPL, kernel will indicate OPAL that it has processed dump and
it can clear/release metadata area.
src = ignore
dest = ignore
size = ignore</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="return-values">
<h2>Return Values<a class="headerlink" href="#return-values" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_SUCCESS</span></code></dt>
<dd>Operation success</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_PARAMETER</span></code></dt>
<dd>Invalid parameter</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_RESOURCE</span></code></dt>
<dd>Ran out of space in MDST/MDDT table to add new entry</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_HARDWARE</span></code></dt>
<dd>Platform does not support fadump</dd>
</dl>
</div>
</div>
<div class="section" id="opal-mpipl-register-tag">
<span id="id2"></span><h1>OPAL_MPIPL_REGISTER_TAG<a class="headerlink" href="#opal-mpipl-register-tag" title="Permalink to this headline">¶</a></h1>
<p>Kernel will use this API to register tags during MPIPL registration.
It expects OPAL to preserve these tags across MPIPL. Post MPIPL Linux
kernel will use <cite>opal_mpipl_query_tag</cite> call to retrieve these tags.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">opal_mpipl_register_tag</span><span class="p">(</span><span class="k">enum</span> <span class="n">opal_mpipl_tags</span> <span class="n">tag</span><span class="p">,</span> <span class="kt">uint64_t</span> <span class="n">tag_val</span><span class="p">)</span>
<span class="nl">tag</span><span class="p">:</span>
<span class="n">OPAL_MPIPL_TAG_KERNEL</span>
<span class="n">During</span> <span class="n">first</span> <span class="n">boot</span><span class="p">,</span> <span class="n">kernel</span> <span class="n">will</span> <span class="n">setup</span> <span class="n">its</span> <span class="n">metadata</span> <span class="n">area</span> <span class="n">and</span> <span class="n">asks</span>
<span class="n">OPAL</span> <span class="n">to</span> <span class="n">preserve</span> <span class="n">metadata</span> <span class="n">area</span> <span class="n">pointer</span> <span class="n">across</span> <span class="n">MPIPL</span><span class="p">.</span> <span class="n">Post</span> <span class="n">MPIPL</span>
<span class="n">kernel</span> <span class="n">requests</span> <span class="n">OPAL</span> <span class="n">to</span> <span class="n">provide</span> <span class="n">metadata</span> <span class="n">pointer</span> <span class="n">and</span> <span class="n">it</span> <span class="n">will</span> <span class="n">use</span>
<span class="n">that</span> <span class="n">pointer</span> <span class="n">to</span> <span class="n">retrieve</span> <span class="n">metadata</span> <span class="n">and</span> <span class="n">create</span> <span class="n">dump</span><span class="p">.</span>
<span class="n">OPAL_MPIPL_TAG_BOOT_MEM</span>
<span class="n">During</span> <span class="n">MPIPL</span> <span class="n">registration</span> <span class="n">kernel</span> <span class="n">will</span> <span class="n">specify</span> <span class="n">how</span> <span class="n">much</span> <span class="n">memory</span>
<span class="n">firmware</span> <span class="n">can</span> <span class="n">use</span> <span class="k">for</span> <span class="n">Post</span> <span class="n">MPIPL</span> <span class="n">load</span><span class="p">.</span> <span class="n">Post</span> <span class="n">MPIPL</span> <span class="n">petitboot</span> <span class="n">kernel</span>
<span class="n">will</span> <span class="n">query</span> <span class="k">for</span> <span class="n">this</span> <span class="n">tag</span> <span class="n">to</span> <span class="n">get</span> <span class="n">boot</span> <span class="n">memory</span> <span class="n">size</span><span class="p">.</span>
</pre></div>
</div>
<div class="section" id="id3">
<h2>Return Values<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_SUCCESS</span></code></dt>
<dd>Operation success</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_PARAMETER</span></code></dt>
<dd>Invalid parameter</dd>
</dl>
</div>
</div>
<div class="section" id="opal-mpipl-query-tag">
<span id="id4"></span><h1>OPAL_MPIPL_QUERY_TAG<a class="headerlink" href="#opal-mpipl-query-tag" title="Permalink to this headline">¶</a></h1>
<p>Post MPIPL linux kernel will call this API to get metadata tag. And use this
tag to retrieve metadata information and generate dump.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span> <span class="cp">#define OPAL_MPIPL_QUERY_TAG 175</span>
<span class="kt">uint64_t</span> <span class="nf">opal_mpipl_query_tag</span><span class="p">(</span><span class="k">enum</span> <span class="n">opal_mpipl_tags</span> <span class="n">tag</span><span class="p">,</span> <span class="kt">uint64_t</span> <span class="o">*</span><span class="n">tag_val</span><span class="p">)</span>
<span class="k">enum</span> <span class="n">opal_mpipl_tags</span> <span class="p">{</span>
<span class="n">OPAL_MPIPL_TAG_CPU</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">OPAL_MPIPL_TAG_OPAL</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">OPAL_MPIPL_TAG_KERNEL</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>
<span class="n">OPAL_MPIPL_TAG_BOOT_MEM</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
<span class="p">};</span>
<span class="nl">tag</span> <span class="p">:</span>
<span class="n">OPAL_MPIPL_TAG_CPU</span>
<span class="n">Pointer</span> <span class="n">to</span> <span class="n">CPU</span> <span class="k">register</span> <span class="n">data</span> <span class="n">content</span> <span class="n">metadata</span> <span class="n">area</span>
<span class="n">OPAL_MPIPL_TAG_OPAL</span>
<span class="n">Pointer</span> <span class="n">to</span> <span class="n">OPAL</span> <span class="n">metadata</span> <span class="n">area</span>
<span class="n">OPAL_MPIPL_TAG_KERNEL</span>
<span class="n">During</span> <span class="n">first</span> <span class="n">boot</span><span class="p">,</span> <span class="n">kernel</span> <span class="n">will</span> <span class="n">setup</span> <span class="n">its</span> <span class="n">metadata</span> <span class="n">area</span> <span class="n">and</span> <span class="n">asks</span>
<span class="n">OPAL</span> <span class="n">to</span> <span class="n">preserve</span> <span class="n">metadata</span> <span class="n">area</span> <span class="n">pointer</span> <span class="n">across</span> <span class="n">MPIPL</span><span class="p">.</span> <span class="n">Post</span> <span class="n">MPIPL</span>
<span class="n">kernel</span> <span class="n">calls</span> <span class="n">this</span> <span class="n">API</span> <span class="n">to</span> <span class="n">get</span> <span class="n">metadata</span> <span class="n">pointer</span> <span class="n">and</span> <span class="n">it</span> <span class="n">will</span> <span class="n">use</span>
<span class="n">that</span> <span class="n">pointer</span> <span class="n">to</span> <span class="n">retrieve</span> <span class="n">metadata</span> <span class="n">and</span> <span class="n">create</span> <span class="n">dump</span><span class="p">.</span>
<span class="n">OPAL_MPIPL_TAG_BOOT_MEM</span>
<span class="n">During</span> <span class="n">MPIPL</span> <span class="n">registration</span> <span class="n">kernel</span> <span class="n">will</span> <span class="n">specify</span> <span class="n">how</span> <span class="n">much</span> <span class="n">memory</span>
<span class="n">firmware</span> <span class="n">can</span> <span class="n">use</span> <span class="k">for</span> <span class="n">Post</span> <span class="n">MPIPL</span> <span class="n">load</span><span class="p">.</span> <span class="n">Post</span> <span class="n">MPIPL</span> <span class="n">petitboot</span> <span class="n">kernel</span>
<span class="n">will</span> <span class="n">query</span> <span class="k">for</span> <span class="n">this</span> <span class="n">tag</span> <span class="n">to</span> <span class="n">get</span> <span class="n">boot</span> <span class="n">memory</span> <span class="n">size</span><span class="p">.</span>
</pre></div>
</div>
<div class="section" id="id5">
<h2>Return Values<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_SUCCESS</span></code></dt>
<dd>Operation success</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_PARAMETER</span></code></dt>
<dd>Invalid parameter</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 MPIPL APIs</a></li>
<li><a class="reference internal" href="#opal-mpipl-update">OPAL_MPIPL_UPDATE</a><ul>
<li><a class="reference internal" href="#ops">ops :</a></li>
<li><a class="reference internal" href="#return-values">Return Values</a></li>
</ul>
</li>
<li><a class="reference internal" href="#opal-mpipl-register-tag">OPAL_MPIPL_REGISTER_TAG</a><ul>
<li><a class="reference internal" href="#id3">Return Values</a></li>
</ul>
</li>
<li><a class="reference internal" href="#opal-mpipl-query-tag">OPAL_MPIPL_QUERY_TAG</a><ul>
<li><a class="reference internal" href="#id5">Return Values</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="opal-messages.html"
title="previous chapter">OPAL_MESSAGE</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="opal-nmmu-set-ptcr-127.html"
title="next chapter">OPAL_NMMU_SET_PTCR</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-mpipl-173-174.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-nmmu-set-ptcr-127.html" title="OPAL_NMMU_SET_PTCR"
>next</a> |</li>
<li class="right" >
<a href="opal-messages.html" title="OPAL_MESSAGE"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot d9772c6
documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >OPAL API Documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016-2017, IBM, others.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
</div>
</body>
</html>
|
