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