blob: 7f795f97ebe899243d631c813e6027ca246b2bdd [file] [log] [blame]
Matt Spinler1962e082020-08-05 13:44:53 -05001/**
2 * Copyright © 2020 IBM Corporation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#include "service_indicators.hpp"
17
Matt Spinler34a904c2020-08-05 14:53:28 -050018#include <fmt/format.h>
19
Matt Spinler05f0c6d2020-08-05 14:21:06 -050020#include <bitset>
Matt Spinler1962e082020-08-05 13:44:53 -050021#include <phosphor-logging/log.hpp>
22
23namespace openpower::pels::service_indicators
24{
25
26using namespace phosphor::logging;
27
Matt Spinler48c44db2020-08-25 12:47:13 -050028static constexpr auto platformSaiLedGroup =
29 "/xyz/openbmc_project/led/groups/platform_system_attention_indicator";
30
Matt Spinler1962e082020-08-05 13:44:53 -050031std::unique_ptr<Policy> getPolicy(const DataInterfaceBase& dataIface)
32{
33 // At the moment there is just one type of policy.
34 return std::make_unique<LightPath>(dataIface);
35}
36
37bool LightPath::ignore(const PEL& pel) const
38{
Matt Spinler05f0c6d2020-08-05 14:21:06 -050039 auto creator = pel.privateHeader().creatorID();
40
41 // Don't ignore serviceable BMC or hostboot errors
42 if ((static_cast<CreatorID>(creator) == CreatorID::openBMC) ||
43 (static_cast<CreatorID>(creator) == CreatorID::hostboot))
44 {
45 std::bitset<16> actionFlags{pel.userHeader().actionFlags()};
46 if (actionFlags.test(serviceActionFlagBit))
47 {
48 return false;
49 }
50 }
51
52 return true;
Matt Spinler1962e082020-08-05 13:44:53 -050053}
54
55void LightPath::activate(const PEL& pel)
56{
57 if (ignore(pel))
58 {
59 return;
60 }
61
62 // Now that we've gotten this far, we'll need to turn on
63 // the system attention indicator if we don't find other
64 // indicators to turn on.
65 bool sai = true;
66 auto src = pel.primarySRC();
67 const auto& calloutsObj = (*src)->callouts();
68
69 if (calloutsObj && !calloutsObj->callouts().empty())
70 {
71 const auto& callouts = calloutsObj->callouts();
72
73 // From the callouts, find the location codes whose
74 // LEDs need to be turned on.
75 auto locCodes = getLocationCodes(callouts);
76 if (!locCodes.empty())
77 {
78 // Find the LED groups for those location codes.
79 auto ledPaths = getLEDGroupPaths(locCodes);
80 if (!ledPaths.empty())
81 {
82 // Tell the LED groups to assert their LEDs.
83 assertLEDs(ledPaths);
84 sai = false;
85 }
86 }
87 }
88
89 if (sai)
90 {
Matt Spinler48c44db2020-08-25 12:47:13 -050091 try
92 {
93 _dataIface.assertLEDGroup(platformSaiLedGroup, true);
94 }
95 catch (const std::exception& e)
96 {
97 log<level::ERR>(
98 fmt::format("Failed to assert platform SAI LED group: {}",
99 e.what())
100 .c_str());
101 }
Matt Spinler1962e082020-08-05 13:44:53 -0500102 }
103}
104
105std::vector<std::string> LightPath::getLocationCodes(
106 const std::vector<std::unique_ptr<src::Callout>>& callouts) const
107{
Matt Spinler05f0c6d2020-08-05 14:21:06 -0500108 std::vector<std::string> locCodes;
109 bool firstCallout = true;
110 uint8_t firstCalloutPriority;
111
112 // Collect location codes for the first group of callouts,
113 // where a group can be:
114 // * a single medium priority callout
115 // * one or more high priority callouts
116 // * one or more medium group a priority callouts
117 //
118 // All callouts in the group must be hardware callouts.
119
120 for (const auto& callout : callouts)
121 {
122 if (firstCallout)
123 {
124 firstCallout = false;
125
126 firstCalloutPriority = callout->priority();
127
128 // If the first callout is High, Medium, or Medium
129 // group A, and is a hardware callout, then we
130 // want it.
131 if (isRequiredPriority(firstCalloutPriority) &&
132 isHardwareCallout(*callout))
133 {
134 locCodes.push_back(callout->locationCode());
135 }
136 else
137 {
138 break;
139 }
140
141 // By definition a medium priority callout can't be part
142 // of a group, so no need to look for more.
143 if (static_cast<CalloutPriority>(firstCalloutPriority) ==
144 CalloutPriority::medium)
145 {
146 break;
147 }
148 }
149 else
150 {
151 // Only continue while the callouts are the same
152 // priority as the first callout.
153 if (callout->priority() != firstCalloutPriority)
154 {
155 break;
156 }
157
158 // If any callout in the group isn't a hardware callout,
159 // then don't light up any LEDs at all.
160 if (!isHardwareCallout(*callout))
161 {
162 locCodes.clear();
163 break;
164 }
165
166 locCodes.push_back(callout->locationCode());
167 }
168 }
169
170 return locCodes;
171}
172
173bool LightPath::isRequiredPriority(uint8_t priority) const
174{
175 auto calloutPriority = static_cast<CalloutPriority>(priority);
176 return (calloutPriority == CalloutPriority::high) ||
177 (calloutPriority == CalloutPriority::medium) ||
178 (calloutPriority == CalloutPriority::mediumGroupA);
179}
180
181bool LightPath::isHardwareCallout(const src::Callout& callout) const
182{
183 const auto& fruIdentity = callout.fruIdentity();
184 if (fruIdentity)
185 {
186 return (callout.locationCodeSize() != 0) &&
187 ((fruIdentity->failingComponentType() ==
188 src::FRUIdentity::hardwareFRU) ||
189 (fruIdentity->failingComponentType() ==
190 src::FRUIdentity::symbolicFRUTrustedLocCode));
191 }
192
193 return false;
Matt Spinler1962e082020-08-05 13:44:53 -0500194}
195
196std::vector<std::string> LightPath::getLEDGroupPaths(
197 const std::vector<std::string>& locationCodes) const
198{
Matt Spinler34a904c2020-08-05 14:53:28 -0500199 std::vector<std::string> ledGroups;
200 std::string inventoryPath;
201
202 for (const auto& locCode : locationCodes)
203 {
204 try
205 {
206 inventoryPath =
207 _dataIface.getInventoryFromLocCode(locCode, 0, true);
208 }
209 catch (const std::exception& e)
210 {
211 log<level::ERR>(fmt::format("Could not get inventory path for "
212 "location code {} ({}).",
213 locCode, e.what())
214 .c_str());
215
216 // Unless we can get the LEDs for all FRUs, we can't turn
217 // on any of them, so clear the list and quit.
218 ledGroups.clear();
219 break;
220 }
221
222 try
223 {
224 ledGroups.push_back(_dataIface.getFaultLEDGroup(inventoryPath));
225 }
226 catch (const std::exception& e)
227 {
228 log<level::ERR>(fmt::format("Could not get LED group path for "
229 "inventory path {} ({}).",
230 inventoryPath, e.what())
231 .c_str());
232 ledGroups.clear();
233 break;
234 }
235 }
236
237 return ledGroups;
Matt Spinler1962e082020-08-05 13:44:53 -0500238}
239
240void LightPath::assertLEDs(const std::vector<std::string>& ledGroups) const
241{
Matt Spinler34a904c2020-08-05 14:53:28 -0500242 for (const auto& ledGroup : ledGroups)
243 {
244 try
245 {
246 _dataIface.assertLEDGroup(ledGroup, true);
247 }
248 catch (const std::exception& e)
249 {
250 log<level::ERR>(fmt::format("Failed to assert LED group {} ({})",
251 ledGroup, e.what())
252 .c_str());
253 }
254 }
Matt Spinler1962e082020-08-05 13:44:53 -0500255}
256
257} // namespace openpower::pels::service_indicators