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
|
<!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_LPC_READ — 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_MESSAGE" href="opal-messages.html" />
<link rel="prev" title="Service Indicators (LEDS)" href="opal-led-get-set-114-115.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-messages.html" title="OPAL_MESSAGE"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="opal-led-get-set-114-115.html" title="Service Indicators (LEDS)"
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-lpc-read">
<span id="id1"></span><h1>OPAL_LPC_READ<a class="headerlink" href="#opal-lpc-read" title="Permalink to this headline">¶</a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_LPC_READ 67</span>
<span class="cm">/*</span>
<span class="cm"> * Address cycle types for LPC accesses. These also correspond</span>
<span class="cm"> * to the content of the first cell of the "reg" property for</span>
<span class="cm"> * device nodes on the LPC bus</span>
<span class="cm"> */</span>
<span class="k">enum</span> <span class="n">OpalLPCAddressType</span> <span class="p">{</span>
<span class="n">OPAL_LPC_MEM</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">OPAL_LPC_IO</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">OPAL_LPC_FW</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>
<span class="p">};</span>
<span class="kt">int64_t</span> <span class="nf">opal_lpc_read</span><span class="p">(</span><span class="kt">uint32_t</span> <span class="n">chip_id</span><span class="p">,</span> <span class="k">enum</span> <span class="n">OpalLPCAddressType</span> <span class="n">addr_type</span><span class="p">,</span>
<span class="kt">uint32_t</span> <span class="n">addr</span><span class="p">,</span> <span class="kt">uint32_t</span> <span class="o">*</span><span class="n">data</span><span class="p">,</span> <span class="kt">uint32_t</span> <span class="n">sz</span><span class="p">);</span>
</pre></div>
</div>
<p>This function related to Low Pin Count (LPC) bus. This function reads the
data from IDSEL register for <code class="docutils literal notranslate"><span class="pre">chip_id</span></code>, which has LPC information.
From <code class="docutils literal notranslate"><span class="pre">addr</span></code> for <code class="docutils literal notranslate"><span class="pre">addr_type</span></code> with read size <code class="docutils literal notranslate"><span class="pre">sz</span></code> bytes in to a
variable named <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
<div class="section" id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">chip_id</span></code></dt>
<dd>The <code class="docutils literal notranslate"><span class="pre">chip_id</span></code> parameter contains value of the chip number identified at
boot time.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">addr_type</span></code></dt>
<dd><p class="first">The <code class="docutils literal notranslate"><span class="pre">addr_type</span></code> is one of the LPC supported address types.
Supported address types are:</p>
<ul class="last simple">
<li>LPC memory,</li>
<li>LPC IO and</li>
<li>LPC firmware.</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">addr</span></code></dt>
<dd>The <code class="docutils literal notranslate"><span class="pre">addr</span></code> from which the data has to be read.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">data</span></code></dt>
<dd>The <code class="docutils literal notranslate"><span class="pre">data</span></code> will be used to store the read data.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sz</span></code></dt>
<dd>How many <code class="docutils literal notranslate"><span class="pre">sz</span></code> bytes to be read in to <code class="docutils literal notranslate"><span class="pre">data</span></code>.</dd>
</dl>
</div>
<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><a class="reference internal" href="return-codes.html#opal-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt>
<dd>Indicates either <code class="docutils literal notranslate"><span class="pre">chip_id</span></code> not found or <code class="docutils literal notranslate"><span class="pre">chip_id</span></code> doesn’t contain
LPC information.</dd>
<dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt>
<dd>Indicates Success!</dd>
</dl>
</div>
</div>
<div class="section" id="opal-lpc-write">
<span id="id2"></span><h1>OPAL_LPC_WRITE<a class="headerlink" href="#opal-lpc-write" title="Permalink to this headline">¶</a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_LPC_WRITE 68</span>
<span class="cm">/*</span>
<span class="cm"> * Address cycle types for LPC accesses. These also correspond</span>
<span class="cm"> * to the content of the first cell of the "reg" property for</span>
<span class="cm"> * device nodes on the LPC bus</span>
<span class="cm"> */</span>
<span class="k">enum</span> <span class="n">OpalLPCAddressType</span> <span class="p">{</span>
<span class="n">OPAL_LPC_MEM</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">OPAL_LPC_IO</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">OPAL_LPC_FW</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>
<span class="p">};</span>
<span class="kt">int64_t</span> <span class="nf">opal_lpc_write</span><span class="p">(</span><span class="kt">uint32_t</span> <span class="n">chip_id</span><span class="p">,</span> <span class="k">enum</span> <span class="n">OpalLPCAddressType</span> <span class="n">addr_type</span><span class="p">,</span>
<span class="kt">uint32_t</span> <span class="n">addr</span><span class="p">,</span> <span class="kt">uint32_t</span> <span class="n">data</span><span class="p">,</span> <span class="kt">uint32_t</span> <span class="n">sz</span><span class="p">);</span>
</pre></div>
</div>
<p>This function related to Low Pin Count (LPC) bus. This function writes the
<code class="docutils literal notranslate"><span class="pre">data</span></code> in to ECCB register for <code class="docutils literal notranslate"><span class="pre">chip_id</span></code>, which has LPC information.
From <code class="docutils literal notranslate"><span class="pre">addr</span></code> for <code class="docutils literal notranslate"><span class="pre">addr_type</span></code> with write size <code class="docutils literal notranslate"><span class="pre">sz</span></code> bytes.</p>
<div class="section" id="id3">
<h2>Parameters<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">chip_id</span></code></dt>
<dd>The <code class="docutils literal notranslate"><span class="pre">chip_id</span></code> parameter contains value of the chip number identified at
boot time.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">addr_type</span></code></dt>
<dd><p class="first">The <code class="docutils literal notranslate"><span class="pre">addr_type</span></code> is one of the address types LPC supported.
Supported address types are:</p>
<ul class="last simple">
<li>LPC memory,</li>
<li>LPC IO and</li>
<li>LPC firmware.</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">addr</span></code></dt>
<dd>The <code class="docutils literal notranslate"><span class="pre">addr</span></code> to where the <code class="docutils literal notranslate"><span class="pre">data</span></code> need to be written.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">data</span></code></dt>
<dd>The <code class="docutils literal notranslate"><span class="pre">data</span></code> for writing.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sz</span></code></dt>
<dd>How many <code class="docutils literal notranslate"><span class="pre">sz</span></code> bytes to write.</dd>
</dl>
</div>
<div class="section" id="id4">
<h2>Return Codes<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><a class="reference internal" href="return-codes.html#opal-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt>
<dd>Indicates either <code class="docutils literal notranslate"><span class="pre">chip_id</span></code> not found or <code class="docutils literal notranslate"><span class="pre">chip_id</span></code> doesn’t contain LPC
information.</dd>
<dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt>
<dd>Indicates Success!</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_LPC_READ</a><ul>
<li><a class="reference internal" href="#parameters">Parameters</a></li>
<li><a class="reference internal" href="#return-codes">Return Codes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#opal-lpc-write">OPAL_LPC_WRITE</a><ul>
<li><a class="reference internal" href="#id3">Parameters</a></li>
<li><a class="reference internal" href="#id4">Return Codes</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="opal-led-get-set-114-115.html"
title="previous chapter">Service Indicators (LEDS)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="opal-messages.html"
title="next chapter">OPAL_MESSAGE</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-lpc-read-write-67-68.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-messages.html" title="OPAL_MESSAGE"
>next</a> |</li>
<li class="right" >
<a href="opal-led-get-set-114-115.html" title="Service Indicators (LEDS)"
>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>
|
