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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Get/Set System Parameters — skiboot 09fb954
documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="OPAL PCI Config Space Access" href="opal-pci-config-read-write-13-14-15-16-17-18.html" />
<link rel="prev" title="OPAL NVRAM" href="opal-nvram-read-write-7-8.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-pci-config-read-write-13-14-15-16-17-18.html" title="OPAL PCI Config Space Access"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="opal-nvram-read-write-7-8.html" title="OPAL NVRAM"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot 09fb954
documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">OPAL API Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Get/Set System Parameters</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="get-set-system-parameters">
<span id="opal-sysparams"></span><h1>Get/Set System Parameters<a class="headerlink" href="#get-set-system-parameters" title="Permalink to this headline">¶</a></h1>
<p>The usual way for setting system parameters is via IPMI for things controlled
by the service processor, or through NVRAM for things controlled by host
firmware. However, some platforms may have other options not easily (or
possible to be) exposed over IPMI. These OPAL calls will read (and write)
these parameters.</p>
<p>The list of parameters is set at boot time, and is represented in the device
tree (see <a class="reference internal" href="../device-tree/ibm%2Copal/sysparams.html#device-tree-ibm-opal-sysparams"><span class="std std-ref">sysparams</span></a> for details).</p>
<p>Currently only implemented on FSP based systems.</p>
<section id="opal-get-param">
<span id="id1"></span><h2>OPAL_GET_PARAM<a class="headerlink" href="#opal-get-param" title="Permalink to this headline">¶</a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_GET_PARAM 89</span>
<span class="kt">int64_t</span><span class="w"> </span><span class="nf">fsp_opal_get_param</span><span class="p">(</span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">async_token</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">param_id</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">buffer</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">length</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<p>Get the current setting of <cite>param_id</cite>. This is an asynchronous call as OPAL may
need to communicate with a service processor. The <cite>param_id</cite> and <cite>length</cite> are
described in the device tree for each parameter (see
<a class="reference internal" href="../device-tree/ibm%2Copal/sysparams.html#device-tree-ibm-opal-sysparams"><span class="std std-ref">sysparams</span></a> for details).</p>
<section id="returns">
<h3>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></h3>
<dl class="simple">
<dt><a class="reference internal" href="return-codes.html#opal-hardware"><span class="std std-ref">OPAL_HARDWARE</span></a></dt><dd><p>Hardware issue prevents retreiving parameter. e.g. FSP is offline or
absent.</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt><dd><p>Invalid <cite>param_id</cite></p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-permission"><span class="std std-ref">OPAL_PERMISSION</span></a></dt><dd><p>Not allowed to read parameter.</p>
</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><p>Not enough free memory in OPAL to process request.</p>
</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><p>Other internal OPAL error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-async-completion"><span class="std std-ref">OPAL_ASYNC_COMPLETION</span></a></dt><dd><p>Request is submitted.</p>
</dd>
</dl>
</section>
</section>
<section id="opal-set-param">
<span id="id2"></span><h2>OPAL_SET_PARAM<a class="headerlink" href="#opal-set-param" title="Permalink to this headline">¶</a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_SET_PARAM 90</span>
<span class="kt">int64_t</span><span class="w"> </span><span class="nf">fsp_opal_set_param</span><span class="p">(</span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">async_token</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">param_id</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">buffer</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">length</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<p>Write a new setting for <cite>param_id</cite>. This is an asynchronous call as OPAL may
need to communicate with a service processor. The <cite>param_id</cite> and <cite>length</cite> are
described in the device tree for each parameter (see
<a class="reference internal" href="../device-tree/ibm%2Copal/sysparams.html#device-tree-ibm-opal-sysparams"><span class="std std-ref">sysparams</span></a> for details).</p>
<section id="id3">
<h3>Returns<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<dl class="simple">
<dt><a class="reference internal" href="return-codes.html#opal-hardware"><span class="std std-ref">OPAL_HARDWARE</span></a></dt><dd><p>Hardware issue prevents retreiving parameter. e.g. FSP is offline or
absent.</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt><dd><p>Invalid <cite>param_id</cite></p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-permission"><span class="std std-ref">OPAL_PERMISSION</span></a></dt><dd><p>Not allowed to write parameter.</p>
</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><p>Not enough free memory in OPAL to process request.</p>
</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><p>Other internal OPAL error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-async-completion"><span class="std std-ref">OPAL_ASYNC_COMPLETION</span></a></dt><dd><p>Request is submitted.</p>
</dd>
</dl>
</section>
</section>
</section>
<div class="clearer"></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="#">Get/Set System Parameters</a><ul>
<li><a class="reference internal" href="#opal-get-param">OPAL_GET_PARAM</a><ul>
<li><a class="reference internal" href="#returns">Returns</a></li>
</ul>
</li>
<li><a class="reference internal" href="#opal-set-param">OPAL_SET_PARAM</a><ul>
<li><a class="reference internal" href="#id3">Returns</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="opal-nvram-read-write-7-8.html"
title="previous chapter">OPAL NVRAM</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="opal-pci-config-read-write-13-14-15-16-17-18.html"
title="next chapter">OPAL PCI Config Space Access</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-param-89-90.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#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-pci-config-read-write-13-14-15-16-17-18.html" title="OPAL PCI Config Space Access"
>next</a> |</li>
<li class="right" >
<a href="opal-nvram-read-write-7-8.html" title="OPAL NVRAM"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot 09fb954
documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >OPAL API Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Get/Set System Parameters</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016-2017, IBM, others.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>
|
