1 /**
2  * Describes functions for converting PCIe CPER sections from binary and JSON format
3  * into an intermediate format.
4  *
5  * Author: Lawrence.Tang@arm.com
6  **/
7 #include <stdio.h>
8 #include <string.h>
9 #include "json.h"
10 #include "b64.h"
11 #include "../edk/Cper.h"
12 #include "../cper-utils.h"
13 #include "cper-section-pcie.h"
14 
15 //Converts a single PCIe CPER section into JSON IR.
16 json_object* cper_section_pcie_to_ir(void* section, EFI_ERROR_SECTION_DESCRIPTOR* descriptor)
17 {
18     EFI_PCIE_ERROR_DATA* pcie_error = (EFI_PCIE_ERROR_DATA*)section;
19     json_object* section_ir = json_object_new_object();
20 
21     //Validation bits.
22     json_object* validation = bitfield_to_ir(pcie_error->ValidFields, 8, PCIE_ERROR_VALID_BITFIELD_NAMES);
23     json_object_object_add(section_ir, "validationBits", validation);
24 
25     //Port type.
26     json_object* port_type = integer_to_readable_pair(pcie_error->PortType, 9,
27         PCIE_ERROR_PORT_TYPES_KEYS,
28         PCIE_ERROR_PORT_TYPES_VALUES,
29         "Unknown");
30     json_object_object_add(section_ir, "portType", port_type);
31 
32     //Version, provided each half in BCD.
33     json_object* version = json_object_new_object();
34     json_object_object_add(version, "minor", json_object_new_int(bcd_to_int(pcie_error->Version & 0xFF)));
35     json_object_object_add(version, "major", json_object_new_int(bcd_to_int(pcie_error->Version >> 8)));
36     json_object_object_add(section_ir, "version", version);
37 
38     //Command & status.
39     json_object* command_status = json_object_new_object();
40     json_object_object_add(command_status, "commandRegister", json_object_new_uint64(pcie_error->CommandStatus & 0xFFFF));
41     json_object_object_add(command_status, "statusRegister", json_object_new_uint64(pcie_error->CommandStatus >> 16));
42     json_object_object_add(section_ir, "commandStatus", command_status);
43 
44     //PCIe Device ID.
45     json_object* device_id = json_object_new_object();
46     UINT64 class_id = (pcie_error->DevBridge.ClassCode[0] << 16) +
47                       (pcie_error->DevBridge.ClassCode[1] << 8) +
48                       pcie_error->DevBridge.ClassCode[2];
49     json_object_object_add(device_id, "vendorID", json_object_new_uint64(pcie_error->DevBridge.VendorId));
50     json_object_object_add(device_id, "deviceID", json_object_new_uint64(pcie_error->DevBridge.DeviceId));
51     json_object_object_add(device_id, "classCode", json_object_new_uint64(class_id));
52     json_object_object_add(device_id, "functionNumber", json_object_new_uint64(pcie_error->DevBridge.Function));
53     json_object_object_add(device_id, "deviceNumber", json_object_new_uint64(pcie_error->DevBridge.Device));
54     json_object_object_add(device_id, "segmentNumber", json_object_new_uint64(pcie_error->DevBridge.Segment));
55     json_object_object_add(device_id, "primaryOrDeviceBusNumber", json_object_new_uint64(pcie_error->DevBridge.PrimaryOrDeviceBus));
56     json_object_object_add(device_id, "secondaryBusNumber", json_object_new_uint64(pcie_error->DevBridge.SecondaryBus));
57     json_object_object_add(device_id, "slotNumber", json_object_new_uint64(pcie_error->DevBridge.Slot.Number));
58     json_object_object_add(section_ir, "deviceID", device_id);
59 
60     //Device serial number.
61     json_object_object_add(section_ir, "deviceSerialNumber", json_object_new_uint64(pcie_error->SerialNo));
62 
63     //Bridge control status.
64     json_object* bridge_control_status = json_object_new_object();
65     json_object_object_add(bridge_control_status, "secondaryStatusRegister",
66         json_object_new_uint64(pcie_error->BridgeControlStatus & 0xFFFF));
67     json_object_object_add(bridge_control_status, "controlRegister",
68         json_object_new_uint64(pcie_error->BridgeControlStatus >> 16));
69     json_object_object_add(section_ir, "bridgeControlStatus", bridge_control_status);
70 
71     //Capability structure.
72     //The PCIe capability structure provided here could either be PCIe 1.1 Capability Structure
73     //(36-byte, padded to 60 bytes) or PCIe 2.0 Capability Structure (60-byte). There does not seem
74     //to be a way to differentiate these, so this is left as a b64 dump.
75     char* encoded = b64_encode((unsigned char*)pcie_error->Capability.PcieCap, 60);
76     json_object* capability = json_object_new_object();
77     json_object_object_add(capability, "data", json_object_new_string(encoded));
78     free(encoded);
79     json_object_object_add(section_ir, "capabilityStructure", capability);
80 
81     //AER information.
82     json_object* aer_capability_ir = json_object_new_object();
83     encoded = b64_encode((unsigned char*)pcie_error->AerInfo.PcieAer, 96);
84     json_object_object_add(aer_capability_ir, "data", json_object_new_string(encoded));
85     free(encoded);
86     json_object_object_add(section_ir, "aerInfo", aer_capability_ir);
87     return section_ir;
88 }
89 
90 //Converts a single CPER-JSON PCIe section into CPER binary, outputting to the given stream.
91 void ir_section_pcie_to_cper(json_object* section, FILE* out)
92 {
93     EFI_PCIE_ERROR_DATA* section_cper = (EFI_PCIE_ERROR_DATA*)calloc(1, sizeof(EFI_PCIE_ERROR_DATA));
94 
95     //Validation bits.
96     section_cper->ValidFields = ir_to_bitfield(json_object_object_get(section, "validationBits"),
97         8, PCIE_ERROR_VALID_BITFIELD_NAMES);
98 
99     //Version.
100     json_object* version = json_object_object_get(section, "version");
101     UINT32 minor = int_to_bcd(json_object_get_int(json_object_object_get(version, "minor")));
102     UINT32 major = int_to_bcd(json_object_get_int(json_object_object_get(version, "major")));
103     section_cper->Version = minor + (major << 8);
104 
105     //Command/status registers.
106     json_object* command_status = json_object_object_get(section, "commandStatus");
107     UINT32 command = (UINT16)json_object_get_uint64(json_object_object_get(command_status, "commandRegister"));
108     UINT32 status = (UINT16)json_object_get_uint64(json_object_object_get(command_status, "statusRegister"));
109     section_cper->CommandStatus = command + (status << 16);
110 
111     //Device ID.
112     json_object* device_id = json_object_object_get(section, "deviceID");
113     UINT64 class_id = json_object_get_uint64(json_object_object_get(device_id, "classCode"));
114     section_cper->DevBridge.VendorId =
115         (UINT16)json_object_get_uint64(json_object_object_get(device_id, "vendorID"));
116     section_cper->DevBridge.DeviceId =
117         (UINT16)json_object_get_uint64(json_object_object_get(device_id, "deviceID"));
118     section_cper->DevBridge.ClassCode[0] = class_id >> 16;
119     section_cper->DevBridge.ClassCode[1] = (class_id >> 8) & 0xFF;
120     section_cper->DevBridge.ClassCode[2] = class_id & 0xFF;
121     section_cper->DevBridge.Function =
122         (UINT8)json_object_get_uint64(json_object_object_get(device_id, "functionNumber"));
123     section_cper->DevBridge.Device =
124         (UINT8)json_object_get_uint64(json_object_object_get(device_id, "deviceNumber"));
125     section_cper->DevBridge.Segment =
126         (UINT16)json_object_get_uint64(json_object_object_get(device_id, "segmentNumber"));
127     section_cper->DevBridge.PrimaryOrDeviceBus =
128         (UINT8)json_object_get_uint64(json_object_object_get(device_id, "primaryOrDeviceBusNumber"));
129     section_cper->DevBridge.SecondaryBus =
130         (UINT8)json_object_get_uint64(json_object_object_get(device_id, "secondaryBusNumber"));
131     section_cper->DevBridge.Slot.Number =
132         (UINT16)json_object_get_uint64(json_object_object_get(device_id, "slotNumber"));
133 
134     //Bridge/control status.
135     json_object* bridge_control = json_object_object_get(section, "bridgeControlStatus");
136     UINT32 bridge_status = (UINT16)json_object_get_uint64(json_object_object_get(bridge_control, "secondaryStatusRegister"));
137     UINT32 control_status = (UINT16)json_object_get_uint64(json_object_object_get(bridge_control, "controlRegister"));
138     section_cper->BridgeControlStatus = bridge_status + (control_status << 16);
139 
140     //Capability structure.
141     json_object* capability = json_object_object_get(section, "capabilityStructure");
142     json_object* encoded = json_object_object_get(capability, "data");
143     UINT8* decoded = b64_decode(json_object_get_string(encoded), json_object_get_string_len(encoded));
144     memcpy(section_cper->Capability.PcieCap, decoded, 60);
145     free(decoded);
146 
147     //AER capability structure.
148     json_object* aer_info = json_object_object_get(section, "aerInfo");
149     encoded = json_object_object_get(aer_info, "data");
150     decoded = b64_decode(json_object_get_string(encoded), json_object_get_string_len(encoded));
151     memcpy(section_cper->AerInfo.PcieAer, decoded, 96);
152     free(decoded);
153 
154     //Miscellaneous value fields.
155     section_cper->PortType = (UINT32)readable_pair_to_integer(json_object_object_get(section, "portType"));
156     section_cper->SerialNo = json_object_get_uint64(json_object_object_get(section, "deviceSerialNumber"));
157 
158     //Write out to stream, free resources.
159     fwrite(section_cper, sizeof(EFI_PCIE_ERROR_DATA), 1, out);
160     fflush(out);
161     free(section_cper);
162 }