xref: /openbmc/libcper/sections/cper-section-pci-dev.c (revision 6c5d2f34188e568d8fb59d0666f3359c8e5197f8) 
1 /**
2  * Describes functions for converting PCI/PCI-X device 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 <json.h>
9 #include <libcper/Cper.h>
10 #include <libcper/cper-utils.h>
11 #include <libcper/sections/cper-section-pci-dev.h>
12 #include <libcper/log.h>
13 #include <string.h>
14 
15 //Converts a single PCI/PCI-X device CPER section into JSON IR.
cper_section_pci_dev_to_ir(const UINT8 * section,UINT32 size,char ** desc_string)16 json_object *cper_section_pci_dev_to_ir(const UINT8 *section, UINT32 size,
17 					char **desc_string)
18 {
19 	int outstr_len = 0;
20 
21 	*desc_string = NULL;
22 	if (size < sizeof(EFI_PCI_PCIX_DEVICE_ERROR_DATA)) {
23 		cper_print_log("Error: PCI/PCI-X Device section too small\n");
24 		return NULL;
25 	}
26 
27 	*desc_string = calloc(1, SECTION_DESC_STRING_SIZE);
28 	if (*desc_string == NULL) {
29 		cper_print_log(
30 			"Error: Failed to allocate PCI/PCI-X Device desc string\n");
31 		return NULL;
32 	}
33 	outstr_len = snprintf(*desc_string, SECTION_DESC_STRING_SIZE,
34 			      "A PCI/PCI-X Device Error occurred");
35 	if (outstr_len < 0) {
36 		cper_print_log(
37 			"Error: Could not write to PCI/PCI-X Device description string\n");
38 	} else if (outstr_len > SECTION_DESC_STRING_SIZE) {
39 		cper_print_log(
40 			"Error: PCI/PCI-X Device description string truncated\n");
41 	}
42 
43 	EFI_PCI_PCIX_DEVICE_ERROR_DATA *dev_error =
44 		(EFI_PCI_PCIX_DEVICE_ERROR_DATA *)section;
45 
46 	if (size < sizeof(EFI_PCI_PCIX_DEVICE_ERROR_DATA) +
47 			   ((dev_error->MemoryNumber + dev_error->IoNumber) *
48 			    sizeof(EFI_PCI_PCIX_DEVICE_ERROR_DATA_REGISTER))) {
49 		free(*desc_string);
50 		*desc_string = NULL;
51 		return NULL;
52 	}
53 
54 	json_object *section_ir = json_object_new_object();
55 
56 	//Validation bits.
57 	ValidationTypes ui64Type = { UINT_64T,
58 				     .value.ui64 = dev_error->ValidFields };
59 
60 	//Error status.
61 	if (isvalid_prop_to_ir(&ui64Type, 0)) {
62 		json_object *error_status = cper_generic_error_status_to_ir(
63 			&dev_error->ErrorStatus);
64 		json_object_object_add(section_ir, "errorStatus", error_status);
65 	}
66 
67 	//ID information.
68 	if (isvalid_prop_to_ir(&ui64Type, 1)) {
69 		json_object *id_info = json_object_new_object();
70 		add_uint(id_info, "vendorID", dev_error->IdInfo.VendorId);
71 		add_uint(id_info, "deviceID", dev_error->IdInfo.DeviceId);
72 		add_uint(id_info, "classCode", dev_error->IdInfo.ClassCode);
73 		add_uint(id_info, "functionNumber",
74 			 dev_error->IdInfo.FunctionNumber);
75 		add_uint(id_info, "deviceNumber",
76 			 dev_error->IdInfo.DeviceNumber);
77 		add_uint(id_info, "busNumber", dev_error->IdInfo.BusNumber);
78 		add_uint(id_info, "segmentNumber",
79 			 dev_error->IdInfo.SegmentNumber);
80 		json_object_object_add(section_ir, "idInfo", id_info);
81 	}
82 
83 	//Number of following register data pairs.
84 	if (isvalid_prop_to_ir(&ui64Type, 2)) {
85 		add_uint(section_ir, "memoryNumber", dev_error->MemoryNumber);
86 	}
87 	if (isvalid_prop_to_ir(&ui64Type, 3)) {
88 		add_uint(section_ir, "ioNumber", dev_error->IoNumber);
89 	}
90 
91 	if (isvalid_prop_to_ir(&ui64Type, 4)) {
92 		int num_data_pairs =
93 			dev_error->MemoryNumber + dev_error->IoNumber;
94 
95 		//Register pairs, described by the numeric fields.
96 		//The actual "pairs" of address and data aren't necessarily 8 bytes long, so can't assume the contents.
97 		//Hence the naming "firstHalf" and "secondHalf" rather than "address" and "data".
98 		json_object *register_data_pair_array = json_object_new_array();
99 		UINT64 *cur_pos = (UINT64 *)(dev_error + 1);
100 		for (int i = 0; i < num_data_pairs; i++) {
101 			//Save current pair to array.
102 			json_object *register_data_pair =
103 				json_object_new_object();
104 			add_uint(register_data_pair, "firstHalf", *cur_pos);
105 			add_uint(register_data_pair, "secondHalf",
106 				 *(cur_pos + 1));
107 			json_object_array_add(register_data_pair_array,
108 					      register_data_pair);
109 
110 			//Move to next pair.
111 			cur_pos += 2;
112 		}
113 		json_object_object_add(section_ir, "registerDataPairs",
114 				       register_data_pair_array);
115 	}
116 
117 	return section_ir;
118 }
119 
ir_section_pci_dev_to_cper(json_object * section,FILE * out)120 void ir_section_pci_dev_to_cper(json_object *section, FILE *out)
121 {
122 	EFI_PCI_PCIX_DEVICE_ERROR_DATA *section_cper =
123 		(EFI_PCI_PCIX_DEVICE_ERROR_DATA *)calloc(
124 			1, sizeof(EFI_PCI_PCIX_DEVICE_ERROR_DATA));
125 
126 	//Validation bits.
127 	ValidationTypes ui64Type = { UINT_64T, .value.ui64 = 0 };
128 	struct json_object *obj = NULL;
129 
130 	//Error status.
131 	if (json_object_object_get_ex(section, "errorStatus", &obj)) {
132 		ir_generic_error_status_to_cper(obj,
133 						&section_cper->ErrorStatus);
134 		add_to_valid_bitfield(&ui64Type, 0);
135 	}
136 
137 	//Device ID information.
138 	if (json_object_object_get_ex(section, "idInfo", &obj)) {
139 		json_object *id_info = obj;
140 		section_cper->IdInfo.VendorId = json_object_get_uint64(
141 			json_object_object_get(id_info, "vendorID"));
142 		section_cper->IdInfo.DeviceId = json_object_get_uint64(
143 			json_object_object_get(id_info, "deviceID"));
144 		section_cper->IdInfo.ClassCode = json_object_get_uint64(
145 			json_object_object_get(id_info, "classCode"));
146 		section_cper->IdInfo.FunctionNumber = json_object_get_uint64(
147 			json_object_object_get(id_info, "functionNumber"));
148 		section_cper->IdInfo.DeviceNumber = json_object_get_uint64(
149 			json_object_object_get(id_info, "deviceNumber"));
150 		section_cper->IdInfo.BusNumber = json_object_get_uint64(
151 			json_object_object_get(id_info, "busNumber"));
152 		section_cper->IdInfo.SegmentNumber = json_object_get_uint64(
153 			json_object_object_get(id_info, "segmentNumber"));
154 		add_to_valid_bitfield(&ui64Type, 1);
155 	}
156 
157 	//Amount of following data pairs.
158 	if (json_object_object_get_ex(section, "memoryNumber", &obj)) {
159 		section_cper->MemoryNumber =
160 			(UINT32)json_object_get_uint64(obj);
161 		add_to_valid_bitfield(&ui64Type, 2);
162 	}
163 	if (json_object_object_get_ex(section, "ioNumber", &obj)) {
164 		section_cper->IoNumber = (UINT32)json_object_get_uint64(obj);
165 		add_to_valid_bitfield(&ui64Type, 3);
166 	}
167 	json_object *register_pairs = NULL;
168 	if (json_object_object_get_ex(section, "registerDataPairs", &obj)) {
169 		register_pairs = obj;
170 		add_to_valid_bitfield(&ui64Type, 4);
171 	}
172 
173 	section_cper->ValidFields = ui64Type.value.ui64;
174 
175 	//Write header out to stream, free it.
176 	fwrite(section_cper, sizeof(EFI_PCI_PCIX_DEVICE_ERROR_DATA), 1, out);
177 	fflush(out);
178 	free(section_cper);
179 
180 	//Begin writing register pairs.
181 	if (register_pairs != NULL) {
182 		int num_pairs = json_object_array_length(register_pairs);
183 		for (int i = 0; i < num_pairs; i++) {
184 			//Get the pair array item out.
185 			json_object *register_pair =
186 				json_object_array_get_idx(register_pairs, i);
187 
188 			//Create the pair array.
189 			UINT64 pair[2];
190 			pair[0] = json_object_get_uint64(json_object_object_get(
191 				register_pair, "firstHalf"));
192 			pair[1] = json_object_get_uint64(json_object_object_get(
193 				register_pair, "secondHalf"));
194 
195 			//Push to stream.
196 			fwrite(pair, sizeof(UINT64), 2, out);
197 			fflush(out);
198 		}
199 	}
200 }
201