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
|
<!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>Service Indicators (LEDS) — skiboot 25e28ea
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_LPC_READ" href="opal-lpc-read-write-67-68.html" />
<link rel="prev" title="OPAL_IPMI_SEND" href="opal-ipmi-send-recv-107-108.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-lpc-read-write-67-68.html" title="OPAL_LPC_READ"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="opal-ipmi-send-recv-107-108.html" title="OPAL_IPMI_SEND"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot 25e28ea
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="">Service Indicators (LEDS)</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="service-indicators-leds">
<span id="opal-api-leds"></span><h1>Service Indicators (LEDS)<a class="headerlink" href="#service-indicators-leds" title="Permalink to this headline">¶</a></h1>
<p>The service indicator is one element of an overall hardware service strategy
where end user simplicity is a high priority. The goal is system firmware or
operating system code to isolate hardware failures to the failing FRU and
automatically activate the fault indicator associated with the failing FRU.
The end user then needs only to look for the FRU with the active fault
indicator to know which part to replace.</p>
<p>Different types of indicators handled by LED code:</p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>System attention indicator (Check log indicator)</dt><dd><p>Indicates there is a problem with the system that needs attention.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Identify</dt><dd><p>Helps the user locate/identify a particular FRU or resource in the
system.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Fault</dt><dd><p>Indicates there is a problem with the FRU or resource at the
location with which the indicator is associated.</p>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
<p>All LEDs are defined in the device tree (see <a class="reference internal" href="../device-tree/ibm%2Copal/led.html#device-tree-ibm-opal-leds"><span class="std std-ref">Service Indicators (LEDS)</span></a>).</p>
<section id="led-design">
<h2>LED Design<a class="headerlink" href="#led-design" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p>When it comes to implementation we can classify LEDs into two
categories:</p>
</div></blockquote>
<ol class="arabic simple">
<li><p>Hypervisor (OPAL) controlled LEDs (All identify & fault indicators)
During boot, we read/cache these LED details in OPAL (location code,
state, etc). We use cached data to serve read request from FSP/Host.
And we use SPCN passthrough MBOX command to update these LED state.</p></li>
<li><p>Service processor (FSP) controlled LEDs (System Attention Indicator)
During boot, we read/cache this LED info using MBOX command. Later
anytime FSP updates this LED, it sends update system parameter
notification MBOX command. We use that data to update cached data.
LED update request is sent via set/reset attn MBOX command.</p></li>
</ol>
<dl class="simple">
<dt>LED update request:</dt><dd><p>Both FSP and Host will send LED update requests. We have to serialize
SPCN passthrough command. Hence we maintain local queue.</p>
</dd>
</dl>
<p>Note:</p>
<blockquote>
<div><ul class="simple">
<li><p>For more information regarding service indicator refer to PAPR spec
(Service Indicators chapter).</p></li>
</ul>
</div></blockquote>
<p>There are two OPAL calls relating to LED operations.</p>
</section>
<section id="opal-leds-get-indicator">
<span id="id1"></span><h2>OPAL_LEDS_GET_INDICATOR<a class="headerlink" href="#opal-leds-get-indicator" title="Permalink to this headline">¶</a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_LEDS_GET_INDICATOR 114</span>
<span class="kt">int64_t</span><span class="w"> </span><span class="nf">opal_leds_get_indicator</span><span class="p">(</span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">loc_code</span><span class="p">,</span><span class="w"> </span><span class="n">u64</span><span class="w"> </span><span class="o">*</span><span class="n">led_mask</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">u64</span><span class="w"> </span><span class="o">*</span><span class="n">led_value</span><span class="p">,</span><span class="w"> </span><span class="n">u64</span><span class="w"> </span><span class="o">*</span><span class="n">max_led_type</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<p>Returns LED state for the given location code.</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">loc_code</span></code></dt><dd><p>Location code of the LEDs.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">led_mask</span></code></dt><dd><p>LED types whose status is available (return by OPAL)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">led_value</span></code></dt><dd><p>Status of the available LED types (return by OPAL)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">max_led_type</span></code></dt><dd><p>Maximum number of supported LED types (Host/OPAL)</p>
</dd>
</dl>
<p>The host will pass the location code of the LED types (loc_code) and
maximum number of LED types it understands (max_led_type). OPAL will
update the ‘led_mask’ with set bits pointing to LED types whose status
is available and updates the ‘led_value’ with actual status. OPAL checks
the ‘max_led_type’ to understand whether the host is newer or older
compared to itself. In the case where the OPAL is newer compared
to host (OPAL’s max_led_type > host’s max_led_type), it will update
led_mask and led_value according to max_led_type requested by the host.
When the host is newer compared to the OPAL (host’s max_led_type >
OPAL’s max_led_type), OPAL updates ‘max_led_type’ to the maximum
number of LED type it understands and updates ‘led_mask’, ‘led_value’
based on that maximum value of LED types.</p>
<p>Currently this is only implemented on FSP basde machines, see
hw/fsp/fsp-leds.c for more deatails.</p>
</section>
<section id="opal-leds-set-indicator">
<span id="id2"></span><h2>OPAL_LEDS_SET_INDICATOR<a class="headerlink" href="#opal-leds-set-indicator" title="Permalink to this headline">¶</a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_LEDS_SET_INDICATOR 115</span>
<span class="kt">int64_t</span><span class="w"> </span><span class="nf">opal_leds_set_indicator</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="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">loc_code</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">u64</span><span class="w"> </span><span class="n">led_mask</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">u64</span><span class="w"> </span><span class="n">led_value</span><span class="p">,</span><span class="w"> </span><span class="n">u64</span><span class="w"> </span><span class="o">*</span><span class="n">max_led_type</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<p>Sets LED state for the given location code.</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">loc_code</span></code></dt><dd><p>Location code of the LEDs to be set.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">led_mask</span></code></dt><dd><p>LED types whose status will be updated</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">led_value</span></code></dt><dd><p>Requested status of various LED types.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">max_led_type</span></code></dt><dd><p>Maximum number of supported LED types. If OPAL supports fewer LED types
than requested, it will set <code class="docutils literal notranslate"><span class="pre">max_led_type</span></code> to the maximum it does support.</p>
</dd>
</dl>
<p>The host will pass the location code of the LED types, mask, value
and maximum number of LED types it understands. OPAL will update
LED status for all the LED types mentioned in the mask with their
value mentioned. OPAL checks the ‘max_led_type’ to understand
whether the host is newer or older compared to itself. In case where
the OPAL is newer compared to the host (OPAL’s max_led_type >
host’s max_led_type), it updates LED status based on max_led_type
requested from the host. When the host is newer compared to the OPAL
(host’s max_led_type > OPAL’s max_led_type), OPAL updates
‘max_led_type’ to the maximum number of LED type it understands and
then it updates LED status based on that updated maximum value of LED
types. Host needs to check the returned updated value of max_led_type
to figure out which part of it’s request got served and which ones got
ignored.</p>
<p>Currently this is only implemented on FSP basde machines, see
hw/fsp/fsp-leds.c for more deatails.</p>
</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="#">Service Indicators (LEDS)</a><ul>
<li><a class="reference internal" href="#led-design">LED Design</a></li>
<li><a class="reference internal" href="#opal-leds-get-indicator">OPAL_LEDS_GET_INDICATOR</a></li>
<li><a class="reference internal" href="#opal-leds-set-indicator">OPAL_LEDS_SET_INDICATOR</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="opal-ipmi-send-recv-107-108.html"
title="previous chapter">OPAL_IPMI_SEND</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="opal-lpc-read-write-67-68.html"
title="next chapter">OPAL_LPC_READ</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-led-get-set-114-115.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-lpc-read-write-67-68.html" title="OPAL_LPC_READ"
>next</a> |</li>
<li class="right" >
<a href="opal-ipmi-send-recv-107-108.html" title="OPAL_IPMI_SEND"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot 25e28ea
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="">Service Indicators (LEDS)</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>
|
