1 // SPDX-License-Identifier: Apache-2.0
2 // SPDX-FileCopyrightText: Copyright 2019 IBM Corporation
3
4 #include "pel_values.hpp"
5
6 #include <algorithm>
7 #include <cassert>
8
9 namespace openpower
10 {
11 namespace pels
12 {
13 namespace pel_values
14 {
15
16 /**
17 * The possible values for the subsystem field in the User Header.
18 */
19 const PELValues subsystemValues = {
20 {0x10, "processor", "Processor"},
21 {0x11, "processor_fru", "Processor FRU"},
22 {0x12, "processor_chip", "Processor Chip Cache"},
23 {0x13, "processor_unit", "Processor Unit (CPU)"},
24 {0x14, "processor_bus", "Processor Bus Controller"},
25
26 {0x20, "memory", "Memory"},
27 {0x21, "memory_ctlr", "Memory Controller"},
28 {0x22, "memory_bus", "Memory Bus Interface"},
29 {0x23, "memory_dimm", "Memory DIMM"},
30 {0x24, "memory_fru", "Memory Card/FRU"},
31 {0x25, "external_cache", "External Cache"},
32
33 {0x30, "io", "I/O"},
34 {0x31, "io_hub", "I/O Hub"},
35 {0x32, "io_bridge", "I/O Bridge"},
36 {0x33, "io_bus", "I/O bus interface"},
37 {0x34, "io_processor", "I/O Processor"},
38 {0x35, "io_hub_other", "SMA Hub"},
39 {0x38, "phb", "PCI Bridge Chip"},
40
41 {0x40, "io_adapter", "I/O Adapter"},
42 {0x41, "io_adapter_comm", "I/O Adapter Communication"},
43 {0x46, "io_device", "I/O Device"},
44 {0x47, "io_device_dasd", "I/O Device Disk"},
45 {0x4C, "io_external_general", "I/O External Peripheral"},
46 {0x4D, "io_external_workstation",
47 "I/O External Peripheral Local Work Station"},
48 {0x4E, "io_storage_mezz", "I/O Storage Mezza Expansion"},
49
50 {0x50, "cec_hardware", "CEC Hardware"},
51 {0x51, "cec_sp_a", "CEC Hardware - Service Processor A"},
52 {0x52, "cec_sp_b", "CEC Hardware - Service Processor B"},
53 {0x53, "cec_node_controller", "CEC Hardware - Node Controller"},
54 {0x55, "cec_vpd", "CEC Hardware - VPD Interface"},
55 {0x56, "cec_i2c", "CEC Hardware - I2C Devices"},
56 {0x57, "cec_chip_iface", "CEC Hardware - CEC Chip Interface"},
57 {0x58, "cec_clocks", "CEC Hardware - Clock"},
58 {0x59, "cec_op_panel", "CEC Hardware - Operator Panel"},
59 {0x5A, "cec_tod", "CEC Hardware - Time-Of-Day Hardware"},
60 {0x5B, "cec_storage_device", "CEC Hardware - Memory Device"},
61 {0x5C, "cec_sp_hyp_iface",
62 "CEC Hardware - Hypervisor<->Service Processor Interface"},
63 {0x5D, "cec_service_network", "CEC Hardware - Service Network"},
64 {0x5E, "cec_sp_hostboot_iface",
65 "CEC Hardware - Hostboot-Service Processor Interface"},
66
67 {0x60, "power", "Power/Cooling"},
68 {0x61, "power_supply", "Power Supply"},
69 {0x62, "power_control_hw", "Power Control Hardware"},
70 {0x63, "power_fans", "Fan (AMD)"},
71 {0x64, "power_sequencer", "Digital Power Supply"},
72
73 {0x70, "others", "Miscellaneous"},
74 {0x71, "other_hmc", "HMC & Hardware"},
75 {0x72, "other_test_tool", "Test Tool"},
76 {0x73, "other_media", "Removable Media"},
77 {0x74, "other_multiple_subsystems", "Multiple Subsystems"},
78 {0x75, "other_na", "Not Applicable"},
79 {0x76, "other_info_src", "Miscellaneous"},
80
81 {0x7A, "surv_hyp_lost_sp",
82 "Hypervisor lost communication with service processor"},
83 {0x7B, "surv_sp_lost_hyp",
84 "Service processor lost communication with Hypervisor"},
85 {0x7C, "surv_sp_lost_hmc", "Service processor lost communication with HMC"},
86 {0x7D, "surv_hmc_lost_lpar",
87 "HMC lost communication with logical partition"},
88 {0x7E, "surv_hmc_lost_bpa", "HMC lost communication with BPA"},
89 {0x7F, "surv_hmc_lost_hmc", "HMC lost communication with another HMC"},
90
91 {0x80, "platform_firmware", "Platform Firmware"},
92 {0x81, "sp_firmware", "Service Processor Firmware"},
93 {0x82, "hyp_firmware", "System Hypervisor Firmware"},
94 {0x83, "partition_firmware", "Partition Firmware"},
95 {0x84, "slic_firmware", "SLIC Firmware"},
96 {0x85, "spcn_firmware", "System Power Control Network Firmware"},
97 {0x86, "bulk_power_firmware_side_a", "Bulk Power Firmware Side A"},
98 {0x87, "hmc_code_firmware", "HMC Code"},
99 {0x88, "bulk_power_firmware_side_b", "Bulk Power Firmware Side B"},
100 {0x89, "virtual_sp", "Virtual Service Processor Firmware"},
101 {0x8A, "hostboot", "HostBoot"},
102 {0x8B, "occ", "OCC"},
103 {0x8D, "bmc_firmware", "BMC Firmware"},
104
105 {0x90, "software", "Software"},
106 {0x91, "os_software", "Operating System software"},
107 {0x92, "xpf_software", "XPF software"},
108 {0x93, "app_software", "Application software"},
109
110 {0xA0, "ext_env", "External Environment"},
111 {0xA1, "input_power_source", "Input Power Source (ac)"},
112 {0xA2, "ambient_temp", "Room Ambient Temperature"},
113 {0xA3, "user_error", "User Error"},
114 {0xA4, "corrosion", "Corrosion"}};
115
116 /**
117 * The possible values for the severity field in the User Header.
118 */
119 const PELValues severityValues = {
120 {0x00, "non_error", "Informational Event"},
121
122 {0x10, "recovered", "Recovered Error"},
123 {0x20, "predictive", "Predictive Error"},
124 {0x21, "predictive_degraded_perf",
125 "Predictive Error, Degraded Performance"},
126 {0x22, "predictive_reboot", "Predictive Error, Correctable"},
127 {0x23, "predictive_reboot_degraded",
128 "Predictive Error, Correctable, Degraded"},
129 {0x24, "predictive_redundancy_loss", "Predictive Error, Redundancy Lost"},
130
131 {0x40, "unrecoverable", "Unrecoverable Error"},
132 {0x41, "unrecoverable_degraded_perf",
133 "Unrecoverable Error, Degraded Performance"},
134 {0x44, "unrecoverable_redundancy_loss",
135 "Unrecoverable Error, Loss of Redundancy"},
136 {0x45, "unrecoverable_redundancy_loss_perf",
137 "Unrecoverable, Loss of Redundancy + Performance"},
138 {0x48, "unrecoverable_loss_of_function",
139 "Unrecoverable Error, Loss of Function"},
140
141 {0x50, "critical", "Critical Error, Scope of Failure unknown"},
142 {0x51, "critical_system_term", "Critical Error, System Termination"},
143 {0x52, "critical_imminent_failure",
144 "Critical Error, System Failure likely or imminent"},
145 {0x53, "critical_partition_term",
146 "Critical Error, Partition(s) Termination"},
147 {0x54, "critical_partition_imminent_failure",
148 "Critical Error, Partition(s) Failure likely or imminent"},
149
150 {0x60, "diagnostic_error", "Error detected during diagnostic test"},
151 {0x61, "diagnostic_error_incorrect_results",
152 "Diagostic error, resource w/incorrect results"},
153
154 {0x71, "symptom_recovered", "Symptom Recovered"},
155 {0x72, "symptom_predictive", "Symptom Predictive"},
156 {0x74, "symptom_unrecoverable", "Symptom Unrecoverable"},
157 {0x75, "symptom_critical", "Symptom Critical"},
158 {0x76, "symptom_diag_err", "Symptom Diag Err"}};
159
160 /**
161 * The possible values for the Event Type field in the User Header.
162 */
163 const PELValues eventTypeValues = {
164 {0x00, "na", "Not Applicable"},
165 {0x01, "misc_information_only", "Miscellaneous, Informational Only"},
166 {0x02, "tracing_event", "Tracing Event"},
167 {0x08, "dump_notification", "Dump Notification"},
168 {0x30, "env_normal", "Customer environmental problem back to normal"}};
169
170 /**
171 * The possible values for the Event Scope field in the User Header.
172 */
173 const PELValues eventScopeValues = {
174 {0x01, "single_partition", "Single Partition"},
175 {0x02, "multiple_partitions", "Multiple Partitions"},
176 {0x03, "entire_platform", "Entire Platform"},
177 {0x04, "possibly_multiple_platforms", "Multiple Platforms"}};
178
179 /**
180 * The possible values for the Action Flags field in the User Header.
181 */
182 const PELValues actionFlagsValues = {
183 {0x8000, "service_action", "Service Action Required"},
184 {0x4000, "hidden", "Event not customer viewable"},
185 {0x2000, "report", "Report Externally"},
186 {0x1000, "dont_report", "Do Not Report To Hypervisor"},
187 {0x0800, "call_home", "HMC Call Home"},
188 {0x0400, "isolation_incomplete",
189 "Isolation Incomplete, further analysis required"},
190 {0x0100, "termination", "Service Processor Call Home Required"},
191 {0x0020, "heartbeat_call_home", "Heartbeat Call Home Event"}};
192
193 /**
194 * The possible values for the Callout Priority field in the SRC.
195 */
196 const PELValues calloutPriorityValues = {
197 {0x48, "high", "Mandatory, replace all with this type as a unit"},
198 {0x4D, "medium", "Medium Priority"},
199 {0x41, "medium_group_a", "Medium Priority A, replace these as a group"},
200 {0x42, "medium_group_b", "Medium Priority B, replace these as a group"},
201 {0x43, "medium_group_c", "Medium Priority C, replace these as a group"},
202 {0x4C, "low", "Lowest priority replacement"}};
203
204 /**
205 * @brief Map of the registry names for the maintenance procedures
206 * to their actual names.
207 */
208 const std::map<std::string, std::string> maintenanceProcedures = {
209 {"bmc_code", "BMC0001"},
210 // Isolation not possible, please contact your next level of support
211 {"next_level_support", "BMC0002"},
212 // Problem is in SBE code, upgrade your firmware
213 {"sbe_code", "BMC0003"},
214 // Problem is somewhere in the FSI bus path
215 {"fsi_path", "BMC0004"},
216 // Problem is over-current PSU fault
217 {"power_overcurrent", "BMC0005"},
218 // An unrecoverable event occurred, look for previous errors for the cause
219 {"find_sue_root_cause", "BMC0006"},
220 // Correct system backplane VPD mismatch
221 {"system_vpd_correction", "BMC0007"},
222 // service reminder about the failed parts present in the system
223 {"detected_issue_need_service", "BMC0008"},
224 };
225
226 /**
227 * @brief Map of the registry names for the symbolic FRUs to their
228 * actual names.
229 */
230 const std::map<std::string, std::string> symbolicFRUs = {
231 {"service_docs", "SVCDOCS"}, {"pwrsply", "PWRSPLY"},
232 {"air_mover", "AIRMOVR"}, {"pgood_part", "PGDPART"},
233 {"usb_pgood", "USBPGD"}, {"ambient_temp", "AMBTEMP"},
234 {"ambient_temp_back", "AMBBACK"}, {"ambient_perf_loss", "AMBPERF"},
235 {"ac_module", "ACMODUL"}, {"fan_cable", "FANCBL"},
236 {"cable_continued", "CBLCONT"}, {"altitude", "ALTTUDE"},
237 {"pcie_hot_plug", "PCIEHP"}, {"overtemp", "OVERTMP"},
238 {"memory_dimm", "MEMDIMM"}};
239
findByValue(uint32_t value,const PELValues & fields)240 PELValues::const_iterator findByValue(uint32_t value, const PELValues& fields)
241 {
242 return std::find_if(fields.begin(), fields.end(),
243 [value](const auto& entry) {
244 return value == std::get<fieldValuePos>(entry);
245 });
246 }
247
findByName(const std::string & name,const PELValues & fields)248 PELValues::const_iterator findByName(const std::string& name,
249 const PELValues& fields)
250
251 {
252 return std::find_if(fields.begin(), fields.end(),
253 [&name](const auto& entry) {
254 return name == std::get<registryNamePos>(entry);
255 });
256 }
257
258 /**
259 * @brief Map for section IDs
260 */
261 const std::map<std::string, std::string> sectionTitles = {
262 {"PH", "Private Header"},
263 {"UH", "User Header"},
264 {"PS", "Primary SRC"},
265 {"SS", "Secondary SRC"},
266 {"EH", "Extended User Header"},
267 {"MT", "Failing MTMS"},
268 {"DH", "Dump Location"},
269 {"SW", "Firmware Error"},
270 {"LP", "Impacted Partition"},
271 {"LR", "Logical Resource"},
272 {"HM", "HMC ID"},
273 {"EP", "EPOW"},
274 {"IE", "IO Event"},
275 {"MI", "MFG Info"},
276 {"CH", "Call Home"},
277 {"UD", "User Data"},
278 {"EI", "Env Info"},
279 {"ED", "Extended User Data"}};
280
281 /**
282 * @brief Map for Procedure Descriptions
283 */
284 const std::map<std::string, std::string> procedureDesc = {{"TODO", "TODO"}};
285
286 /**
287 * @brief Map for Callout Failing Component Types
288 */
289 const std::map<uint8_t, std::string> failingComponentType = {
290 {0x10, "Normal Hardware FRU"},
291 {0x20, "Code FRU"},
292 {0x30, "Configuration error, configuration procedure required"},
293 {0x40, "Maintenance Procedure Required"},
294 {0x90, "External FRU"},
295 {0xA0, "External Code FRU"},
296 {0xB0, "Tool FRU"},
297 {0xC0, "Symbolic FRU"},
298 {0xE0, "Symbolic FRU with trusted location code"}};
299
300 /**
301 * @brief Map for Boolean value
302 */
303 const std::map<bool, std::string> boolString = {{true, "True"},
304 {false, "False"}};
305
306 /**
307 * @brief Map for creator IDs
308 */
309 const std::map<std::string, std::string> creatorIDs = {
310
311 {"O", "BMC"}, {"C", "HMC"}, {"H", "PHYP"}, {"L", "Partition FW"},
312 {"S", "SLIC"}, {"B", "Hostboot"}, {"T", "OCC"}, {"M", "I/O Drawer"},
313 {"K", "Sapphire"}, {"P", "PowerNV"}};
314
315 /**
316 * @brief Map for transmission states
317 */
318 const std::map<TransmissionState, std::string> transmissionStates = {
319 {TransmissionState::newPEL, "Not Sent"},
320 {TransmissionState::badPEL, "Rejected"},
321 {TransmissionState::sent, "Sent"},
322 {TransmissionState::acked, "Acked"}};
323
getValue(const uint8_t field,const pel_values::PELValues & values,const uint8_t position)324 std::string getValue(const uint8_t field, const pel_values::PELValues& values,
325 const uint8_t position)
326 {
327 auto tmp = pel_values::findByValue(field, values);
328 if (tmp != values.end())
329 {
330 if (position == pel_values::registryNamePos)
331 {
332 return std::get<pel_values::registryNamePos>(*tmp);
333 }
334 else
335 {
336 return std::get<pel_values::descriptionPos>(*tmp);
337 }
338 }
339 else
340 {
341 return "invalid";
342 }
343 }
344
getValuesBitwise(uint16_t value,const pel_values::PELValues & table)345 std::vector<std::string> getValuesBitwise(uint16_t value,
346 const pel_values::PELValues& table)
347 {
348 std::vector<std::string> foundValues;
349 std::for_each(
350 table.begin(), table.end(), [&value, &foundValues](const auto& entry) {
351 if (value & std::get<fieldValuePos>(entry))
352 {
353 foundValues.push_back(std::get<descriptionPos>(entry));
354 }
355 });
356 return foundValues;
357 }
358
359 } // namespace pel_values
360 } // namespace pels
361 } // namespace openpower
362