blob: 9924dde28122d970b469146a937b86db9e34a35e [file] [log] [blame]
Matt Spinler711d51d2019-11-06 09:36:51 -06001/**
2 * Copyright © 2019 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 */
Matt Spinler835a8692019-08-27 13:56:05 -050016#include "pel_values.hpp"
17
18#include <algorithm>
Matt Spinler578e0702020-03-13 09:40:43 -050019#include <cassert>
Matt Spinler835a8692019-08-27 13:56:05 -050020
21namespace openpower
22{
23namespace pels
24{
25namespace pel_values
26{
27
Matt Spinler835a8692019-08-27 13:56:05 -050028/**
29 * The possible values for the subsystem field in the User Header.
30 */
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080031const PELValues subsystemValues = {
Vijay Lobo242be742021-09-16 22:40:46 -050032 {0x10, "processor", "Processor"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080033 {0x11, "processor_fru", "Processor FRU"},
34 {0x12, "processor_chip", "Processor Chip Cache"},
35 {0x13, "processor_unit", "Processor Unit (CPU)"},
36 {0x14, "processor_bus", "Processor Bus Controller"},
Matt Spinler835a8692019-08-27 13:56:05 -050037
Vijay Lobo242be742021-09-16 22:40:46 -050038 {0x20, "memory", "Memory "},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080039 {0x21, "memory_ctlr", "Memory Controller"},
40 {0x22, "memory_bus", "Memory Bus Interface"},
41 {0x23, "memory_dimm", "Memory DIMM"},
42 {0x24, "memory_fru", "Memory Card/FRU"},
43 {0x25, "external_cache", "External Cache"},
Matt Spinler835a8692019-08-27 13:56:05 -050044
Vijay Lobo242be742021-09-16 22:40:46 -050045 {0x30, "io", "I/O"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080046 {0x31, "io_hub", "I/O Hub"},
47 {0x32, "io_bridge", "I/O Bridge"},
48 {0x33, "io_bus", "I/O bus interface"},
49 {0x34, "io_processor", "I/O Processor"},
50 {0x35, "io_hub_other", "SMA Hub"},
51 {0x38, "phb", "PCI Bridge Chip"},
Matt Spinler835a8692019-08-27 13:56:05 -050052
Vijay Lobo242be742021-09-16 22:40:46 -050053 {0x40, "io_adapter", "I/O Adapter"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080054 {0x41, "io_adapter_comm", "I/O Adapter Communication"},
Vijay Lobo242be742021-09-16 22:40:46 -050055 {0x46, "io_device", "I/O Device"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080056 {0x47, "io_device_dasd", "I/O Device Disk"},
57 {0x4C, "io_external_general", "I/O External Peripheral"},
58 {0x4D, "io_external_workstation",
59 "I/O External Peripheral Local Work Station"},
Vijay Lobo242be742021-09-16 22:40:46 -050060 {0x4E, "io_storage_mezz", "I/O Storage Mezza Expansion"},
Matt Spinler835a8692019-08-27 13:56:05 -050061
Vijay Lobo242be742021-09-16 22:40:46 -050062 {0x50, "cec_hardware", "CEC Hardware"},
63 {0x51, "cec_sp_a", "CEC Hardware - Service Processor A"},
64 {0x52, "cec_sp_b", "CEC Hardware - Service Processor B"},
65 {0x53, "cec_node_controller", "CEC Hardware - Node Controller"},
66 {0x55, "cec_vpd", "CEC Hardware - VPD Interface"},
67 {0x56, "cec_i2c", "CEC Hardware - I2C Devices"},
68 {0x57, "cec_chip_iface", "CEC Hardware - CEC Chip Interface"},
69 {0x58, "cec_clocks", "CEC Hardware - Clock"},
70 {0x59, "cec_op_panel", "CEC Hardware - Operator Panel"},
71 {0x5A, "cec_tod", "CEC Hardware - Time-Of-Day Hardware"},
72 {0x5B, "cec_storage_device", "CEC Hardware - Memory Device"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080073 {0x5C, "cec_sp_hyp_iface",
Vijay Lobo242be742021-09-16 22:40:46 -050074 "CEC Hardware - Hypervisor<->Service Processor Interface"},
75 {0x5D, "cec_service_network", "CEC Hardware - Service Network"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080076 {0x5E, "cec_sp_hostboot_iface",
Vijay Lobo242be742021-09-16 22:40:46 -050077 "CEC Hardware - Hostboot-Service Processor Interface"},
Matt Spinler835a8692019-08-27 13:56:05 -050078
Vijay Lobo242be742021-09-16 22:40:46 -050079 {0x60, "power", "Power/Cooling"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080080 {0x61, "power_supply", "Power Supply"},
81 {0x62, "power_control_hw", "Power Control Hardware"},
82 {0x63, "power_fans", "Fan (AMD)"},
Vijay Lobo242be742021-09-16 22:40:46 -050083 {0x64, "power_sequencer", "Digital Power Supply"},
Matt Spinler835a8692019-08-27 13:56:05 -050084
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080085 {0x70, "others", "Miscellaneous"},
Vijay Lobo242be742021-09-16 22:40:46 -050086 {0x71, "other_hmc", "HMC & Hardware"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080087 {0x72, "other_test_tool", "Test Tool"},
88 {0x73, "other_media", "Removable Media"},
89 {0x74, "other_multiple_subsystems", "Multiple Subsystems"},
90 {0x75, "other_na", "Not Applicable"},
91 {0x76, "other_info_src", "Miscellaneous"},
Matt Spinler835a8692019-08-27 13:56:05 -050092
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +080093 {0x7A, "surv_hyp_lost_sp",
94 "Hypervisor lost communication with service processor"},
95 {0x7B, "surv_sp_lost_hyp",
96 "Service processor lost communication with Hypervisor"},
97 {0x7C, "surv_sp_lost_hmc", "Service processor lost communication with HMC"},
98 {0x7D, "surv_hmc_lost_lpar",
99 "HMC lost communication with logical partition"},
100 {0x7E, "surv_hmc_lost_bpa", "HMC lost communication with BPA"},
101 {0x7F, "surv_hmc_lost_hmc", "HMC lost communication with another HMC"},
Matt Spinler835a8692019-08-27 13:56:05 -0500102
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800103 {0x80, "platform_firmware", "Platform Firmware"},
104 {0x81, "sp_firmware", "Service Processor Firmware"},
105 {0x82, "hyp_firmware", "System Hypervisor Firmware"},
106 {0x83, "partition_firmware", "Partition Firmware"},
107 {0x84, "slic_firmware", "SLIC Firmware"},
108 {0x85, "spcn_firmware", "System Power Control Network Firmware"},
109 {0x86, "bulk_power_firmware_side_a", "Bulk Power Firmware Side A"},
110 {0x87, "hmc_code_firmware", "HMC Code"},
111 {0x88, "bulk_power_firmware_side_b", "Bulk Power Firmware Side B"},
112 {0x89, "virtual_sp", "Virtual Service Processor Firmware"},
113 {0x8A, "hostboot", "HostBoot"},
114 {0x8B, "occ", "OCC"},
115 {0x8D, "bmc_firmware", "BMC Firmware"},
Matt Spinler835a8692019-08-27 13:56:05 -0500116
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800117 {0x90, "software", "Software"},
118 {0x91, "os_software", "Operating System software"},
119 {0x92, "xpf_software", "XPF software"},
120 {0x93, "app_software", "Application software"},
Matt Spinler835a8692019-08-27 13:56:05 -0500121
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800122 {0xA0, "ext_env", "External Environment"},
123 {0xA1, "input_power_source", "Input Power Source (ac)"},
124 {0xA2, "ambient_temp", "Room Ambient Temperature"},
125 {0xA3, "user_error", "User Error"},
126 {0xA4, "corrosion", "Corrosion"}};
Matt Spinler835a8692019-08-27 13:56:05 -0500127
128/**
129 * The possible values for the severity field in the User Header.
130 */
131const PELValues severityValues = {
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800132 {0x00, "non_error", "Informational Event"},
Matt Spinler835a8692019-08-27 13:56:05 -0500133
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800134 {0x10, "recovered", "Recovered Error"},
135 {0x20, "predictive", "Predictive Error"},
136 {0x21, "predictive_degraded_perf",
137 "Predictive Error, Degraded Performance"},
138 {0x22, "predictive_reboot", "Predictive Error, Correctable"},
139 {0x23, "predictive_reboot_degraded",
140 "Predictive Error, Correctable, Degraded"},
141 {0x24, "predictive_redundancy_loss", "Predictive Error, Redundancy Lost"},
Matt Spinler835a8692019-08-27 13:56:05 -0500142
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800143 {0x40, "unrecoverable", "Unrecoverable Error"},
144 {0x41, "unrecoverable_degraded_perf",
145 "Unrecoverable Error, Degraded Performance"},
146 {0x44, "unrecoverable_redundancy_loss",
147 "Unrecoverable Error, Loss of Redundancy"},
148 {0x45, "unrecoverable_redundancy_loss_perf",
149 "Unrecoverable, Loss of Redundancy + Performance"},
150 {0x48, "unrecoverable_loss_of_function",
151 "Unrecoverable Error, Loss of Function"},
Matt Spinler835a8692019-08-27 13:56:05 -0500152
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800153 {0x50, "critical", "Critical Error, Scope of Failure unknown"},
154 {0x51, "critical_system_term", "Critical Error, System Termination"},
155 {0x52, "critical_imminent_failure",
156 "Critical Error, System Failure likely or imminent"},
157 {0x53, "critical_partition_term",
158 "Critical Error, Partition(s) Termination"},
159 {0x54, "critical_partition_imminent_failure",
160 "Critical Error, Partition(s) Failure likely or imminent"},
Matt Spinler835a8692019-08-27 13:56:05 -0500161
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800162 {0x60, "diagnostic_error", "Error detected during diagnostic test"},
163 {0x61, "diagnostic_error_incorrect_results",
164 "Diagostic error, resource w/incorrect results"},
Matt Spinler835a8692019-08-27 13:56:05 -0500165
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800166 {0x71, "symptom_recovered", "Symptom Recovered"},
167 {0x72, "symptom_predictive", "Symptom Predictive"},
168 {0x74, "symptom_unrecoverable", "Symptom Unrecoverable"},
169 {0x75, "symptom_critical", "Symptom Critical"},
170 {0x76, "symptom_diag_err", "Symptom Diag Err"}};
Matt Spinler835a8692019-08-27 13:56:05 -0500171
172/**
173 * The possible values for the Event Type field in the User Header.
174 */
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800175const PELValues eventTypeValues = {
176 {0x00, "na", "Not Applicable"},
177 {0x01, "misc_information_only", "Miscellaneous, Informational Only"},
178 {0x02, "tracing_event", "Tracing Event"},
Matt Spinler6b3490a2021-01-20 10:48:26 -0600179 {0x08, "dump_notification", "Dump Notification"},
180 {0x30, "env_normal", "Customer environmental problem back to normal"}};
Matt Spinler835a8692019-08-27 13:56:05 -0500181
182/**
183 * The possible values for the Event Scope field in the User Header.
184 */
185const PELValues eventScopeValues = {
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800186 {0x01, "single_partition", "Single Partition"},
187 {0x02, "multiple_partitions", "Multiple Partitions"},
188 {0x03, "entire_platform", "Entire Platform"},
189 {0x04, "possibly_multiple_platforms", "Multiple Platforms"}};
Matt Spinler835a8692019-08-27 13:56:05 -0500190
191/**
192 * The possible values for the Action Flags field in the User Header.
193 */
194const PELValues actionFlagsValues = {
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800195 {0x8000, "service_action", "Service Action Required"},
196 {0x4000, "hidden", "Event not customer viewable"},
197 {0x2000, "report", "Report Externally"},
Harisuddin Mohamed Isa600d15a2019-12-20 12:42:26 +0800198 {0x1000, "dont_report", "Do Not Report To Hypervisor"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800199 {0x0800, "call_home", "HMC Call Home"},
Harisuddin Mohamed Isa600d15a2019-12-20 12:42:26 +0800200 {0x0400, "isolation_incomplete",
201 "Isolation Incomplete, further analysis required"},
Harisuddin Mohamed Isa57a24e32019-12-09 16:14:38 +0800202 {0x0100, "termination", "Service Processor Call Home Required"}};
Matt Spinler835a8692019-08-27 13:56:05 -0500203
204/**
205 * The possible values for the Callout Priority field in the SRC.
206 */
207const PELValues calloutPriorityValues = {
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800208 {0x48, "high", "Mandatory, replace all with this type as a unit"},
209 {0x4D, "medium", "Medium Priority"},
210 {0x41, "medium_group_a", "Medium Priority A, replace these as a group"},
211 {0x42, "medium_group_b", "Medium Priority B, replace these as a group"},
212 {0x43, "medium_group_c", "Medium Priority C, replace these as a group"},
213 {0x4C, "low", "Lowest priority replacement"}};
Matt Spinler835a8692019-08-27 13:56:05 -0500214
Matt Spinler578e0702020-03-13 09:40:43 -0500215/**
Matt Spinlera27e2e52020-04-09 11:06:11 -0500216 * @brief Map of the registry names for the maintenance procedures
217 * to their actual names.
Matt Spinler578e0702020-03-13 09:40:43 -0500218 */
Matt Spinlera27e2e52020-04-09 11:06:11 -0500219const std::map<std::string, std::string> maintenanceProcedures = {
Jayanth Othayothf060bf02021-11-14 08:10:16 -0600220 {"bmc_code", "BMC0001"},
221 // Isolation not possible, please contact your next level of support
Jayanth Othayoth52dbaba2021-11-14 08:44:37 -0600222 {"next_level_support", "BMC0002"},
223 // Problem is in SBE code, upgrade your firmware
Jayanth Othayoth16f54952021-11-15 04:46:33 -0600224 {"sbe_code", "BMC0003"},
225 // Problem is somewhere in the FSI bus path
Brandon Wyman1ba9ef12021-11-15 23:58:06 +0000226 {"fsi_path", "BMC0004"},
227 // Problem is over-current PSU fault
Zane Shelleyef8e79c2022-03-10 10:51:44 -0600228 {"power_overcurrent", "BMC0005"},
229 // An unrecoverable event occurred, look for previous errors for the cause
230 {"find_sue_root_cause", "BMC0006"},
231};
Matt Spinler578e0702020-03-13 09:40:43 -0500232
Matt Spinler2b6dfa02020-04-09 11:39:05 -0500233/**
234 * @brief Map of the registry names for the symbolic FRUs to their
235 * actual names.
236 */
237const std::map<std::string, std::string> symbolicFRUs = {
Matt Spinler6b3490a2021-01-20 10:48:26 -0600238 {"service_docs", "SVCDOCS"}, {"pwrsply", "PWRSPLY"},
239 {"air_mover", "AIRMOVR"}, {"pgood_part", "PGDPART"},
240 {"usb_pgood", "USBPGD"}, {"ambient_temp", "AMBTEMP"},
Jay Meyer54ff54e2021-03-14 20:18:41 -0500241 {"ambient_temp_back", "AMBBACK"}, {"ambient_perf_loss", "AMBPERF"},
Matt Spinlerdde99202021-06-14 12:15:59 -0600242 {"ac_module", "ACMODUL"}, {"fan_cable", "FANCBL"},
Rashmica Guptab63f75b2021-08-18 20:54:21 +1000243 {"cable_continued", "CBLCONT"}, {"altitude", "ALTTUDE"}};
Matt Spinler2b6dfa02020-04-09 11:39:05 -0500244
Matt Spinler835a8692019-08-27 13:56:05 -0500245PELValues::const_iterator findByValue(uint32_t value, const PELValues& fields)
246{
247 return std::find_if(fields.begin(), fields.end(),
248 [value](const auto& entry) {
249 return value == std::get<fieldValuePos>(entry);
250 });
251}
252
253PELValues::const_iterator findByName(const std::string& name,
254 const PELValues& fields)
255
256{
257 return std::find_if(fields.begin(), fields.end(),
258 [&name](const auto& entry) {
259 return name == std::get<registryNamePos>(entry);
260 });
261}
262
Aatir186ce8c2019-10-20 15:13:39 -0500263/**
264 * @brief Map for section IDs
265 */
266const std::map<std::string, std::string> sectionTitles = {
Aatir186ce8c2019-10-20 15:13:39 -0500267 {"PH", "Private Header"},
268 {"UH", "User Header"},
269 {"PS", "Primary SRC"},
270 {"SS", "Secondary SRC"},
271 {"EH", "Extended User Header"},
272 {"MT", "Failing MTMS"},
273 {"DH", "Dump Location"},
274 {"SW", "Firmware Error"},
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800275 {"LP", "Impacted Partition"},
Aatir186ce8c2019-10-20 15:13:39 -0500276 {"LR", "Logical Resource"},
277 {"HM", "HMC ID"},
278 {"EP", "EPOW"},
279 {"IE", "IO Event"},
280 {"MI", "MFG Info"},
281 {"CH", "Call Home"},
282 {"UD", "User Data"},
283 {"EI", "Env Info"},
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800284 {"ED", "Extended User Data"}};
285
286/**
287 * @brief Map for Procedure Descriptions
288 */
289const std::map<std::string, std::string> procedureDesc = {{"TODO", "TODO"}};
290
291/**
292 * @brief Map for Callout Failing Component Types
293 */
294const std::map<uint8_t, std::string> failingComponentType = {
295 {0x10, "Normal Hardware FRU"},
296 {0x20, "Code FRU"},
297 {0x30, "Configuration error, configuration procedure required"},
298 {0x40, "Maintenance Procedure Required"},
299 {0x90, "External FRU"},
300 {0xA0, "External Code FRU"},
301 {0xB0, "Tool FRU"},
302 {0xC0, "Symbolic FRU"},
303 {0xE0, "Symbolic FRU with trusted location code"}};
304
305/**
306 * @brief Map for Boolean value
307 */
308const std::map<bool, std::string> boolString = {{true, "True"},
309 {false, "False"}};
Aatir186ce8c2019-10-20 15:13:39 -0500310
Aatirc92b4eb2019-11-18 13:44:51 -0600311/**
312 * @brief Map for creator IDs
313 */
314const std::map<std::string, std::string> creatorIDs = {
315
316 {"O", "BMC"}, {"C", "HMC"}, {"H", "PHYP"}, {"L", "Partition FW"},
317 {"S", "SLIC"}, {"B", "Hostboot"}, {"T", "OCC"}, {"M", "I/O Drawer"},
318 {"K", "Sapphire"}, {"P", "PowerNV"}};
319
Matt Spinler455587e2020-01-15 14:31:52 -0600320/**
321 * @brief Map for transmission states
322 */
323const std::map<TransmissionState, std::string> transmissionStates = {
324 {TransmissionState::newPEL, "Not Sent"},
325 {TransmissionState::badPEL, "Rejected"},
326 {TransmissionState::sent, "Sent"},
327 {TransmissionState::acked, "Acked"}};
328
Vijay Lobo593a4c62021-06-16 14:25:26 -0500329std::string getValue(const uint8_t field, const pel_values::PELValues& values,
330 const uint8_t position)
Aatir7b291ec2019-11-19 10:37:37 -0600331{
332
333 auto tmp = pel_values::findByValue(field, values);
334 if (tmp != values.end())
335 {
Vijay Lobo593a4c62021-06-16 14:25:26 -0500336 if (position == pel_values::registryNamePos)
337 {
338 return std::get<pel_values::registryNamePos>(*tmp);
339 }
340 else
341 {
342 return std::get<pel_values::descriptionPos>(*tmp);
343 }
Aatir7b291ec2019-11-19 10:37:37 -0600344 }
345 else
346 {
347 return "invalid";
348 }
349}
Harisuddin Mohamed Isa600d15a2019-12-20 12:42:26 +0800350
351std::vector<std::string> getValuesBitwise(uint16_t value,
352 const pel_values::PELValues& table)
353{
354 std::vector<std::string> foundValues;
355 std::for_each(
356 table.begin(), table.end(), [&value, &foundValues](const auto& entry) {
357 if (value & std::get<fieldValuePos>(entry))
358 {
359 foundValues.push_back(std::get<descriptionPos>(entry));
360 }
361 });
362 return foundValues;
363}
Matt Spinler578e0702020-03-13 09:40:43 -0500364
Aatir186ce8c2019-10-20 15:13:39 -0500365} // namespace pel_values
Matt Spinler835a8692019-08-27 13:56:05 -0500366} // namespace pels
367} // namespace openpower