]>
Commit | Line | Data |
---|---|---|
b205f267 | 1 | /** @file\r |
2 | GUID used to identify id for the caller who is initiating the Status Code.\r | |
3 | \r | |
ad0ecbcf | 4 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r |
9df063a0 | 5 | This program and the accompanying materials\r |
b205f267 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | @par Revision Reference:\r | |
14 | These GUIDs and structures are defined in UEFI Platform Initialization Specification 1.2 \r | |
15 | Volume 3: Shared Architectural Elements\r | |
16 | \r | |
17 | **/\r | |
18 | \r | |
19 | #ifndef __PI_STATUS_CODE_DATA_TYPE_ID_GUID_H__\r | |
20 | #define __PI_STATUS_CODE_DATA_TYPE_ID_GUID_H__\r | |
21 | \r | |
22 | #include <PiDxe.h>\r | |
23 | #include <Protocol/DebugSupport.h>\r | |
24 | \r | |
25 | ///\r | |
26 | /// Global ID for the EFI_STATUS_CODE_STRING structure\r | |
27 | ///\r | |
28 | #define EFI_STATUS_CODE_DATA_TYPE_STRING_GUID \\r | |
29 | { 0x92D11080, 0x496F, 0x4D95, { 0xBE, 0x7E, 0x03, 0x74, 0x88, 0x38, 0x2B, 0x0A } }\r | |
ad0ecbcf | 30 | \r |
b205f267 | 31 | typedef enum {\r |
32 | ///\r | |
33 | /// A NULL-terminated ASCII string.\r | |
34 | ///\r | |
35 | EfiStringAscii,\r | |
36 | ///\r | |
37 | /// A double NULL-terminated Unicode string.\r | |
38 | ///\r | |
39 | EfiStringUnicode,\r | |
40 | ///\r | |
41 | /// An EFI_STATUS_CODE_STRING_TOKEN representing the string. The actual \r | |
42 | /// string can be obtained by querying the HII Database\r | |
43 | ///\r | |
44 | EfiStringToken\r | |
45 | } EFI_STRING_TYPE;\r | |
46 | \r | |
47 | ///\r | |
48 | /// Specifies the format of the data in EFI_STATUS_CODE_STRING_DATA.String.\r | |
49 | ///\r | |
50 | typedef struct {\r | |
51 | ///\r | |
52 | /// The HII package list which contains the string. Handle is a dynamic value that may\r | |
53 | /// not be the same for different boots. Type EFI_HII_HANDLE is defined in\r | |
54 | /// EFI_HII_DATABASE_PROTOCOL.NewPackageList() in the UEFI Specification.\r | |
55 | ///\r | |
56 | EFI_HII_HANDLE Handle;\r | |
57 | ///\r | |
58 | /// When combined with Handle, the string token can be used to retrieve the string.\r | |
59 | /// Type EFI_STRING_ID is defined in EFI_IFR_OP_HEADER in the UEFI Specification.\r | |
60 | ///\r | |
61 | EFI_STRING_ID Token;\r | |
62 | } EFI_STATUS_CODE_STRING_TOKEN;\r | |
63 | \r | |
64 | typedef union {\r | |
65 | ///\r | |
66 | /// ASCII formatted string.\r | |
67 | ///\r | |
68 | CHAR8 *Ascii;\r | |
69 | ///\r | |
70 | /// Unicode formatted string.\r | |
71 | ///\r | |
72 | CHAR16 *Unicode;\r | |
73 | ///\r | |
74 | /// HII handle/token pair.\r | |
75 | ///\r | |
76 | EFI_STATUS_CODE_STRING_TOKEN Hii;\r | |
77 | } EFI_STATUS_CODE_STRING;\r | |
78 | \r | |
79 | ///\r | |
80 | /// This data type defines a string type of extended data. A string can accompany \r | |
81 | /// any status code. The string can provide additional information about the \r | |
82 | /// status code. The string can be ASCII, Unicode, or a Human Interface Infrastructure \r | |
83 | /// (HII) token/GUID pair.\r | |
84 | ///\r | |
85 | typedef struct {\r | |
86 | ///\r | |
87 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
88 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
d1eff2f5 | 89 | /// sizeof (EFI_STATUS_CODE_STRING_DATA) - HeaderSize, and\r |
b205f267 | 90 | /// DataHeader.Type should be\r |
91 | /// EFI_STATUS_CODE_DATA_TYPE_STRING_GUID.\r | |
92 | /// \r | |
93 | EFI_STATUS_CODE_DATA DataHeader; \r | |
94 | ///\r | |
95 | /// Specifies the format of the data in String.\r | |
96 | ///\r | |
97 | EFI_STRING_TYPE StringType;\r | |
98 | ///\r | |
99 | /// A pointer to the extended data. The data follows the format specified by \r | |
100 | /// StringType.\r | |
101 | ///\r | |
102 | EFI_STATUS_CODE_STRING String;\r | |
103 | } EFI_STATUS_CODE_STRING_DATA;\r | |
104 | \r | |
b205f267 | 105 | extern EFI_GUID gEfiStatusCodeDataTypeStringGuid;\r |
106 | \r | |
107 | ///\r | |
108 | /// Global ID for the following structures:\r | |
109 | /// - EFI_DEVICE_PATH_EXTENDED_DATA\r | |
110 | /// - EFI_DEVICE_HANDLE_EXTENDED_DATA\r | |
111 | /// - EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA\r | |
112 | /// - EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA\r | |
113 | /// - EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA\r | |
114 | /// - EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA\r | |
115 | /// - EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA\r | |
116 | /// - EFI_MEMORY_RANGE_EXTENDED_DATA\r | |
117 | /// - EFI_DEBUG_ASSERT_DATA\r | |
118 | /// - EFI_STATUS_CODE_EXCEP_EXTENDED_DATA\r | |
119 | /// - EFI_STATUS_CODE_START_EXTENDED_DATA\r | |
120 | /// - EFI_LEGACY_OPROM_EXTENDED_DATA\r | |
121 | ///\r | |
122 | #define EFI_STATUS_CODE_SPECIFIC_DATA_GUID \\r | |
123 | { 0x335984bd, 0xe805, 0x409a, { 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 } }\r | |
124 | \r | |
b205f267 | 125 | ///\r |
126 | /// Extended data about the device path, which is used for many errors and \r | |
127 | /// progress codes to point to the device.\r | |
128 | ///\r | |
129 | /// The device path is used to point to the physical device in case there is more than one device\r | |
130 | /// belonging to the same subclass. For example, the system may contain two USB keyboards and one\r | |
131 | /// PS/2* keyboard. The driver that parses the status code can use the device path extended data to\r | |
132 | /// differentiate between the three. The index field is not useful in this case because there is no standard\r | |
133 | /// numbering convention. Device paths are preferred over using device handles because device handles\r | |
134 | /// for a given device can change from one boot to another and do not mean anything beyond Boot\r | |
135 | /// Services time. In certain cases, the bus driver may not create a device handle for a given device if it\r | |
136 | /// detects a critical error. In these cases, the device path extended data can be used to refer to the\r | |
137 | /// device, but there may not be any device handles with an instance of\r | |
138 | /// EFI_DEVICE_PATH_PROTOCOL that matches DevicePath. The variable device path structure\r | |
139 | /// is included in this structure to make it self sufficient.\r | |
140 | ///\r | |
141 | typedef struct {\r | |
142 | ///\r | |
143 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
144 | /// sizeof (EFI_STATUS_CODE_DATA). DataHeader.Size should be the size\r | |
145 | /// of variable-length DevicePath, and DataHeader.Size is zero for a virtual\r | |
146 | /// device that does not have a device path. DataHeader.Type should be\r | |
147 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
148 | ///\r | |
149 | EFI_STATUS_CODE_DATA DataHeader;\r | |
150 | ///\r | |
151 | /// The device path to the controller or the hardware device. Note that this parameter is a\r | |
152 | /// variable-length device path structure and not a pointer to such a structure. This\r | |
153 | /// structure is populated only if it is a physical device. For virtual devices, the Size\r | |
154 | /// field in DataHeader is set to zero and this field is not populated.\r | |
155 | ///\r | |
156 | UINT8 *DevicePath;\r | |
157 | } EFI_DEVICE_PATH_EXTENDED_DATA;\r | |
158 | \r | |
159 | ///\r | |
160 | /// Device handle Extended Data. Used for many\r | |
161 | /// errors and progress codes to point to the device.\r | |
162 | ///\r | |
163 | /// The handle of the device with which the progress or error code is associated. The handle is\r | |
164 | /// guaranteed to be accurate only at the time the status code is reported. Handles are dynamic entities\r | |
165 | /// between boots, so handles cannot be considered to be valid if the system has reset subsequent to the\r | |
166 | /// status code being reported. Handles may be used to determine a wide variety of useful information\r | |
167 | /// about the source of the status code.\r | |
168 | ///\r | |
169 | typedef struct {\r | |
170 | ///\r | |
171 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
172 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
173 | /// sizeof (EFI_DEVICE_HANDLE_EXTENDED_DATA) - HeaderSize, and\r | |
174 | /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
175 | ///\r | |
176 | EFI_STATUS_CODE_DATA DataHeader;\r | |
177 | ///\r | |
178 | /// The device handle.\r | |
179 | ///\r | |
180 | EFI_HANDLE Handle;\r | |
181 | } EFI_DEVICE_HANDLE_EXTENDED_DATA;\r | |
182 | \r | |
183 | ///\r | |
184 | /// This structure defines extended data describing a PCI resource allocation error.\r | |
185 | ///\r | |
186 | /// @par Note: \r | |
187 | /// The following structure contains variable-length fields and cannot be defined as a C-style\r | |
188 | /// structure.\r | |
189 | ///\r | |
190 | /// This extended data conveys details for a PCI resource allocation failure error. See the PCI\r | |
191 | /// specification and the ACPI specification for details on PCI resource allocations and the format for\r | |
192 | /// resource descriptors. This error does not detail why the resource allocation failed. It may be due to a\r | |
193 | /// bad resource request or a lack of available resources to satisfy a valid request. The variable device\r | |
194 | /// path structure and the resource structures are included in this structure to make it self sufficient.\r | |
195 | ///\r | |
196 | typedef struct {\r | |
197 | ///\r | |
198 | /// The data header identifying the data. DataHeader.HeaderSize should be sizeof\r | |
199 | /// (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
200 | /// (DevicePathSize + DevicePathSize + DevicePathSize +\r | |
201 | /// sizeof(UINT32) + 3 * sizeof (UINT16) ), and DataHeader.Type\r | |
202 | /// should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
203 | ///\r | |
204 | EFI_STATUS_CODE_DATA DataHeader;\r | |
205 | ///\r | |
206 | /// The PCI BAR. Applicable only for PCI devices. Ignored for all other devices.\r | |
207 | ///\r | |
208 | UINT32 Bar;\r | |
209 | ///\r | |
210 | /// DevicePathSize should be zero if it is a virtual device that is not associated with\r | |
211 | /// a device path. Otherwise, this parameter is the length of the variable-length\r | |
212 | /// DevicePath. \r | |
213 | ///\r | |
214 | UINT16 DevicePathSize;\r | |
215 | ///\r | |
216 | /// Represents the size the ReqRes parameter. ReqResSize should be zero if the\r | |
217 | /// requested resources are not provided as a part of extended data.\r | |
218 | ///\r | |
219 | UINT16 ReqResSize;\r | |
220 | ///\r | |
221 | /// Represents the size the AllocRes parameter. AllocResSize should be zero if the\r | |
222 | /// allocated resources are not provided as a part of extended data.\r | |
223 | ///\r | |
224 | UINT16 AllocResSize;\r | |
225 | ///\r | |
226 | /// The device path to the controller or the hardware device that did not get the requested\r | |
227 | /// resources. Note that this parameter is the variable-length device path structure and not\r | |
228 | /// a pointer to this structure.\r | |
229 | ///\r | |
230 | UINT8 *DevicePath;\r | |
231 | ///\r | |
232 | /// The requested resources in the format of an ACPI 2.0 resource descriptor. This\r | |
233 | /// parameter is not a pointer; it is the complete resource descriptor.\r | |
234 | ///\r | |
235 | UINT8 *ReqRes;\r | |
236 | ///\r | |
237 | /// The allocated resources in the format of an ACPI 2.0 resource descriptor. This\r | |
238 | /// parameter is not a pointer; it is the complete resource descriptor.\r | |
239 | ///\r | |
240 | UINT8 *AllocRes;\r | |
241 | } EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r | |
242 | \r | |
243 | ///\r | |
244 | /// This structure provides a calculation for base-10 representations.\r | |
245 | ///\r | |
246 | /// Not consistent with PI 1.2 Specification.\r | |
247 | /// This data type is not defined in the PI 1.2 Specification, but is \r | |
248 | /// required by several of the other data structures in this file.\r | |
249 | ///\r | |
250 | typedef struct {\r | |
251 | ///\r | |
252 | /// The INT16 number by which to multiply the base-2 representation.\r | |
253 | ///\r | |
254 | INT16 Value;\r | |
255 | ///\r | |
256 | /// The INT16 number by which to raise the base-2 calculation. \r | |
257 | ///\r | |
258 | INT16 Exponent;\r | |
259 | } EFI_EXP_BASE10_DATA;\r | |
260 | \r | |
261 | ///\r | |
262 | /// This structure provides the voltage at the time of error. It also provides \r | |
263 | /// the threshold value indicating the minimum or maximum voltage that is considered \r | |
264 | /// an error. If the voltage is less then the threshold, the error indicates that the \r | |
265 | /// voltage fell below the minimum acceptable value. If the voltage is greater then the threshold, \r | |
266 | /// the error indicates that the voltage rose above the maximum acceptable value.\r | |
267 | ///\r | |
268 | typedef struct {\r | |
269 | ///\r | |
270 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
271 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
272 | /// sizeof (EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA) -\r | |
273 | /// HeaderSize, and DataHeader.Type should be\r | |
274 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
275 | ///\r | |
276 | EFI_STATUS_CODE_DATA DataHeader;\r | |
277 | ///\r | |
278 | /// The voltage value at the time of the error.\r | |
279 | ///\r | |
280 | EFI_EXP_BASE10_DATA Voltage;\r | |
281 | ///\r | |
282 | /// The voltage threshold.\r | |
283 | ///\r | |
284 | EFI_EXP_BASE10_DATA Threshold;\r | |
285 | } EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA;\r | |
286 | \r | |
287 | ///\r | |
288 | /// Microcode Update Extended Error Data\r | |
289 | ///\r | |
290 | typedef struct {\r | |
291 | ///\r | |
292 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
293 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
294 | /// sizeof (EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA) -\r | |
295 | /// HeaderSize, and DataHeader.Type should be\r | |
296 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
297 | ///\r | |
298 | EFI_STATUS_CODE_DATA DataHeader;\r | |
299 | ///\r | |
300 | /// The version of the microcode update from the header.\r | |
301 | ///\r | |
302 | UINT32 Version;\r | |
303 | } EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA;\r | |
304 | \r | |
305 | ///\r | |
306 | /// This structure provides details about the computing unit timer expiration error.\r | |
307 | /// The timer limit provides the timeout value of the timer prior to expiration.\r | |
308 | ///\r | |
309 | typedef struct {\r | |
310 | ///\r | |
311 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
312 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
313 | /// sizeof (EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA) -\r | |
314 | /// HeaderSize, and DataHeader.Type should be\r | |
315 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
316 | ///\r | |
317 | EFI_STATUS_CODE_DATA DataHeader;\r | |
318 | ///\r | |
319 | /// The number of seconds that the computing unit timer was configured to expire.\r | |
320 | ///\r | |
321 | EFI_EXP_BASE10_DATA TimerLimit;\r | |
322 | } EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA;\r | |
323 | \r | |
324 | ///\r | |
325 | /// Attribute bits for EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA.Attributes\r | |
326 | /// All other attributes are reserved for future use and must be initialized to 0.\r | |
327 | ///\r | |
328 | ///@{\r | |
329 | #define EFI_COMPUTING_UNIT_MISMATCH_SPEED 0x0001\r | |
330 | #define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED 0x0002\r | |
331 | #define EFI_COMPUTING_UNIT_MISMATCH_FAMILY 0x0004\r | |
332 | #define EFI_COMPUTING_UNIT_MISMATCH_MODEL 0x0008\r | |
333 | #define EFI_COMPUTING_UNIT_MISMATCH_STEPPING 0x0010\r | |
334 | #define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE 0x0020\r | |
335 | #define EFI_COMPUTING_UNIT_MISMATCH_OEM1 0x1000\r | |
336 | #define EFI_COMPUTING_UNIT_MISMATCH_OEM2 0x2000\r | |
337 | #define EFI_COMPUTING_UNIT_MISMATCH_OEM3 0x4000\r | |
338 | #define EFI_COMPUTING_UNIT_MISMATCH_OEM4 0x8000\r | |
339 | ///@}\r | |
340 | \r | |
341 | ///\r | |
342 | /// This structure defines extended data for processor mismatch errors.\r | |
343 | ///\r | |
344 | /// This provides information to indicate which processors mismatch, and how they mismatch. The \r | |
345 | /// status code contains the instance number of the processor that is in error. This structure's \r | |
346 | /// Instance indicates the second processor that does not match. This differentiation allows the \r | |
347 | /// consumer to determine which two processors do not match. The Attributes indicate what \r | |
348 | /// mismatch is being reported. Because Attributes is a bit field, more than one mismatch can be \r | |
349 | /// reported with one error code.\r | |
350 | ///\r | |
351 | typedef struct {\r | |
352 | ///\r | |
353 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
354 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
355 | /// sizeof (EFI_ HOST_PROCESSOR_MISMATCH_ERROR_DATA) -\r | |
356 | /// HeaderSize , and DataHeader.Type should be\r | |
357 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
358 | ///\r | |
359 | EFI_STATUS_CODE_DATA DataHeader;\r | |
360 | ///\r | |
361 | /// The unit number of the computing unit that does not match.\r | |
362 | /// \r | |
363 | UINT32 Instance;\r | |
364 | /// \r | |
365 | /// The attributes describing the failure. \r | |
366 | /// \r | |
367 | UINT16 Attributes;\r | |
368 | } EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA;\r | |
369 | \r | |
370 | ///\r | |
371 | /// This structure provides details about the computing unit thermal failure.\r | |
372 | ///\r | |
373 | /// This structure provides the temperature at the time of error. It also provides the threshold value \r | |
374 | /// indicating the minimum temperature that is considered an error.\r | |
375 | ///\r | |
376 | typedef struct {\r | |
377 | ///\r | |
378 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
379 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
380 | /// sizeof (EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA) -\r | |
381 | /// HeaderSize , and DataHeader.Type should be\r | |
382 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
383 | ///\r | |
384 | EFI_STATUS_CODE_DATA DataHeader;\r | |
385 | ///\r | |
386 | /// The thermal value at the time of the error.\r | |
387 | ///\r | |
388 | EFI_EXP_BASE10_DATA Temperature;\r | |
389 | ///\r | |
390 | /// The thermal threshold.\r | |
391 | ///\r | |
392 | EFI_EXP_BASE10_DATA Threshold;\r | |
393 | } EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA;\r | |
394 | \r | |
395 | ///\r | |
396 | /// Enumeration of valid cache types\r | |
397 | ///\r | |
398 | typedef enum {\r | |
399 | EfiInitCacheDataOnly,\r | |
400 | EfiInitCacheInstrOnly,\r | |
401 | EfiInitCacheBoth,\r | |
402 | EfiInitCacheUnspecified\r | |
403 | } EFI_INIT_CACHE_TYPE;\r | |
404 | \r | |
405 | ///\r | |
406 | /// Embedded cache init extended data\r | |
407 | ///\r | |
408 | typedef struct {\r | |
409 | ///\r | |
410 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
411 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
412 | /// sizeof (EFI_CACHE_INIT_DATA) - HeaderSize , and\r | |
413 | /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
414 | ///\r | |
415 | EFI_STATUS_CODE_DATA DataHeader;\r | |
416 | ///\r | |
417 | /// The cache level. Starts with 1 for level 1 cache.\r | |
418 | ///\r | |
419 | UINT32 Level;\r | |
420 | ///\r | |
421 | /// The type of cache.\r | |
422 | ///\r | |
423 | EFI_INIT_CACHE_TYPE Type;\r | |
424 | } EFI_CACHE_INIT_DATA;\r | |
425 | \r | |
426 | ///\r | |
427 | ///\r | |
428 | ///\r | |
429 | typedef UINT32 EFI_CPU_STATE_CHANGE_CAUSE;\r | |
430 | \r | |
431 | ///\r | |
432 | /// The reasons that the processor is disabled. \r | |
433 | /// Used to fill in EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA.Cause.\r | |
434 | ///\r | |
435 | ///@{\r | |
436 | #define EFI_CPU_CAUSE_INTERNAL_ERROR 0x0001\r | |
437 | #define EFI_CPU_CAUSE_THERMAL_ERROR 0x0002\r | |
438 | #define EFI_CPU_CAUSE_SELFTEST_FAILURE 0x0004\r | |
439 | #define EFI_CPU_CAUSE_PREBOOT_TIMEOUT 0x0008\r | |
440 | #define EFI_CPU_CAUSE_FAILED_TO_START 0x0010\r | |
441 | #define EFI_CPU_CAUSE_CONFIG_ERROR 0x0020\r | |
442 | #define EFI_CPU_CAUSE_USER_SELECTION 0x0080\r | |
443 | #define EFI_CPU_CAUSE_BY_ASSOCIATION 0x0100\r | |
444 | #define EFI_CPU_CAUSE_UNSPECIFIED 0x8000\r | |
445 | ///@}\r | |
446 | \r | |
447 | ///\r | |
448 | /// This structure provides information about the disabled computing unit.\r | |
449 | ///\r | |
450 | /// This structure provides details as to why and how the computing unit was disabled. The causes \r | |
451 | /// should cover the typical reasons a processor would be disabled. How the processor was disabled is \r | |
452 | /// important because there are distinct differences between hardware and software disabling.\r | |
453 | ///\r | |
454 | typedef struct {\r | |
455 | ///\r | |
456 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
457 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
458 | /// sizeof (EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA) -\r | |
459 | /// HeaderSize, and DataHeader.Type should be\r | |
460 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
461 | ///\r | |
462 | EFI_STATUS_CODE_DATA DataHeader;\r | |
463 | ///\r | |
464 | /// The reason for disabling the processor. \r | |
465 | /// \r | |
466 | UINT32 Cause;\r | |
467 | ///\r | |
468 | /// TRUE if the processor is disabled via software means such as not listing it in the ACPI tables. \r | |
469 | /// Such a processor will respond to Interprocessor Interrupts (IPIs). FALSE if the processor is hardware \r | |
470 | /// disabled, which means it is invisible to software and will not respond to IPIs.\r | |
471 | ///\r | |
472 | BOOLEAN SoftwareDisabled;\r | |
473 | } EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA;\r | |
474 | \r | |
475 | ///\r | |
476 | /// Memory Error Granularity Definition\r | |
477 | ///\r | |
478 | typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY;\r | |
479 | \r | |
480 | ///\r | |
481 | /// Memory Error Granularities. Used to fill in EFI_MEMORY_EXTENDED_ERROR_DATA.Granularity.\r | |
482 | ///\r | |
483 | ///@{\r | |
484 | #define EFI_MEMORY_ERROR_OTHER 0x01\r | |
485 | #define EFI_MEMORY_ERROR_UNKNOWN 0x02\r | |
486 | #define EFI_MEMORY_ERROR_DEVICE 0x03\r | |
487 | #define EFI_MEMORY_ERROR_PARTITION 0x04\r | |
488 | ///@}\r | |
489 | \r | |
490 | ///\r | |
491 | /// Memory Error Operation Definition\r | |
492 | ///\r | |
493 | typedef UINT8 EFI_MEMORY_ERROR_OPERATION;\r | |
494 | \r | |
495 | ///\r | |
496 | /// Memory Error Operations. Used to fill in EFI_MEMORY_EXTENDED_ERROR_DATA.Operation.\r | |
497 | ///\r | |
498 | ///@{\r | |
499 | #define EFI_MEMORY_OPERATION_OTHER 0x01\r | |
500 | #define EFI_MEMORY_OPERATION_UNKNOWN 0x02\r | |
501 | #define EFI_MEMORY_OPERATION_READ 0x03\r | |
502 | #define EFI_MEMORY_OPERATION_WRITE 0x04\r | |
503 | #define EFI_MEMORY_OPERATION_PARTIAL_WRITE 0x05\r | |
504 | ///@}\r | |
505 | \r | |
506 | ///\r | |
507 | /// This structure provides specific details about the memory error that was detected. It provides \r | |
508 | /// enough information so that consumers can identify the exact failure and provides enough \r | |
509 | /// information to enable corrective action if necessary.\r | |
510 | ///\r | |
511 | typedef struct {\r | |
512 | ///\r | |
513 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
514 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
515 | /// sizeof (EFI_MEMORY_EXTENDED_ERROR_DATA) - HeaderSize, and\r | |
516 | /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
517 | ///\r | |
518 | EFI_STATUS_CODE_DATA DataHeader;\r | |
519 | ///\r | |
520 | /// The error granularity type.\r | |
521 | ///\r | |
522 | EFI_MEMORY_ERROR_GRANULARITY Granularity;\r | |
523 | ///\r | |
524 | /// The operation that resulted in the error being detected. \r | |
525 | ///\r | |
526 | EFI_MEMORY_ERROR_OPERATION Operation;\r | |
527 | ///\r | |
528 | /// The error syndrome, vendor-specific ECC syndrome, or CRC data associated with \r | |
529 | /// the error. If unknown, should be initialized to 0.\r | |
530 | /// Inconsistent with specification here: \r | |
531 | /// This field in StatusCodes spec0.9 is defined as UINT32, keep code unchanged.\r | |
532 | ///\r | |
533 | UINTN Syndrome;\r | |
534 | ///\r | |
535 | /// The physical address of the error. \r | |
536 | ///\r | |
537 | EFI_PHYSICAL_ADDRESS Address;\r | |
538 | ///\r | |
539 | /// The range, in bytes, within which the error address can be determined.\r | |
540 | ///\r | |
541 | UINTN Resolution;\r | |
542 | } EFI_MEMORY_EXTENDED_ERROR_DATA;\r | |
543 | \r | |
544 | ///\r | |
545 | /// A definition to describe that the operation is performed on multiple devices within the array.\r | |
546 | /// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r | |
547 | ///\r | |
548 | #define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe\r | |
549 | \r | |
550 | ///\r | |
551 | /// A definition to describe that the operation is performed on all devices within the array.\r | |
552 | /// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r | |
553 | ///\r | |
554 | #define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff\r | |
555 | \r | |
556 | ///\r | |
557 | /// A definition to describe that the operation is performed on multiple arrays.\r | |
558 | /// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r | |
559 | ///\r | |
560 | #define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe\r | |
561 | \r | |
562 | ///\r | |
563 | /// A definition to describe that the operation is performed on all the arrays.\r | |
564 | /// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r | |
565 | ///\r | |
566 | #define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff\r | |
567 | \r | |
568 | ///\r | |
569 | /// This extended data provides some context that consumers can use to locate a DIMM within the \r | |
570 | /// overall memory scheme. \r | |
571 | ///\r | |
572 | /// This extended data provides some context that consumers can use to locate a DIMM within the\r | |
573 | /// overall memory scheme. The Array and Device numbers may indicate a specific DIMM, or they\r | |
574 | /// may be populated with the group definitions in "Related Definitions" below.\r | |
575 | ///\r | |
576 | typedef struct {\r | |
577 | ///\r | |
578 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
579 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
580 | /// sizeof (EFI_STATUS_CODE_DIMM_NUMBER) - HeaderSize, and\r | |
581 | /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
582 | ///\r | |
583 | EFI_STATUS_CODE_DATA DataHeader;\r | |
584 | ///\r | |
585 | /// The memory array number.\r | |
586 | ///\r | |
587 | UINT16 Array;\r | |
588 | ///\r | |
589 | /// The device number within that Array.\r | |
590 | ///\r | |
591 | UINT16 Device;\r | |
592 | } EFI_STATUS_CODE_DIMM_NUMBER;\r | |
593 | \r | |
594 | ///\r | |
595 | /// This structure defines extended data describing memory modules that do not match.\r | |
596 | ///\r | |
597 | /// This extended data may be used to convey the specifics of memory modules that do not match.\r | |
598 | /// \r | |
599 | typedef struct {\r | |
600 | ///\r | |
601 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
602 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
603 | /// sizeof (EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA) -\r | |
604 | /// HeaderSize, and DataHeader.Type should be\r | |
605 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r | |
606 | ///\r | |
607 | EFI_STATUS_CODE_DATA DataHeader;\r | |
608 | ///\r | |
609 | /// The instance number of the memory module that does not match. \r | |
610 | ///\r | |
611 | EFI_STATUS_CODE_DIMM_NUMBER Instance;\r | |
612 | } EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA;\r | |
613 | \r | |
614 | ///\r | |
615 | /// This structure defines extended data describing a memory range.\r | |
616 | ///\r | |
617 | /// This extended data may be used to convey the specifics of a memory range. Ranges are specified \r | |
618 | /// with a start address and a length.\r | |
619 | ///\r | |
620 | typedef struct {\r | |
621 | ///\r | |
622 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
623 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
624 | /// sizeof (EFI_MEMORY_RANGE_EXTENDED_DATA) - HeaderSize, and\r | |
625 | /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
626 | ///\r | |
627 | EFI_STATUS_CODE_DATA DataHeader;\r | |
628 | ///\r | |
629 | /// The starting address of the memory range. \r | |
630 | ///\r | |
631 | EFI_PHYSICAL_ADDRESS Start;\r | |
632 | ///\r | |
633 | /// The length in bytes of the memory range.\r | |
634 | ///\r | |
635 | EFI_PHYSICAL_ADDRESS Length;\r | |
636 | } EFI_MEMORY_RANGE_EXTENDED_DATA;\r | |
637 | \r | |
638 | ///\r | |
639 | /// This structure provides the assert information that is typically associated with a debug assertion failing.\r | |
640 | ///\r | |
641 | /// The data indicates the location of the assertion that failed in the source code. This information\r | |
642 | /// includes the file name and line number that are necessary to find the failing assertion in source code.\r | |
643 | ///\r | |
644 | typedef struct {\r | |
645 | ///\r | |
646 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
647 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
d1eff2f5 | 648 | /// sizeof (EFI_DEBUG_ASSERT_DATA) - HeaderSize , and\r |
b205f267 | 649 | /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r |
650 | /// \r | |
651 | EFI_STATUS_CODE_DATA DataHeader;\r | |
652 | ///\r | |
653 | /// The line number of the source file where the fault was generated.\r | |
654 | ///\r | |
655 | UINT32 LineNumber;\r | |
656 | ///\r | |
657 | /// The size in bytes of FileName.\r | |
658 | ///\r | |
659 | UINT32 FileNameSize;\r | |
660 | ///\r | |
661 | /// A pointer to a NULL-terminated ASCII or Unicode string that represents \r | |
662 | /// the file name of the source file where the fault was generated.\r | |
663 | ///\r | |
664 | EFI_STATUS_CODE_STRING_DATA *FileName;\r | |
665 | } EFI_DEBUG_ASSERT_DATA;\r | |
666 | \r | |
667 | ///\r | |
668 | /// System Context Data EBC/IA32/IPF\r | |
669 | ///\r | |
670 | typedef union {\r | |
671 | ///\r | |
672 | /// The context of the EBC virtual machine when the exception was generated. Type\r | |
673 | /// EFI_SYSTEM_CONTEXT_EBC is defined in EFI_DEBUG_SUPPORT_PROTOCOL\r | |
674 | /// in the UEFI Specification.\r | |
675 | ///\r | |
676 | EFI_SYSTEM_CONTEXT_EBC SystemContextEbc;\r | |
677 | ///\r | |
678 | /// The context of the IA-32 processor when the exception was generated. Type\r | |
679 | /// EFI_SYSTEM_CONTEXT_IA32 is defined in the\r | |
680 | /// EFI_DEBUG_SUPPORT_PROTOCOL in the UEFI Specification.\r | |
681 | ///\r | |
682 | EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32;\r | |
683 | ///\r | |
684 | /// The context of the Itanium(R) processor when the exception was generated. Type\r | |
685 | /// EFI_SYSTEM_CONTEXT_IPF is defined in the\r | |
686 | /// EFI_DEBUG_SUPPORT_PROTOCOL in the UEFI Specification.\r | |
687 | ///\r | |
688 | EFI_SYSTEM_CONTEXT_IPF SystemContextIpf;\r | |
689 | } EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT;\r | |
690 | \r | |
691 | ///\r | |
692 | /// This structure defines extended data describing a processor exception error.\r | |
693 | ///\r | |
694 | /// This extended data allows the processor context that is present at the time of the exception to be\r | |
695 | /// reported with the exception. The format and contents of the context data varies depending on the\r | |
696 | /// processor architecture.\r | |
697 | ///\r | |
698 | typedef struct {\r | |
699 | ///\r | |
700 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
701 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
d1eff2f5 | 702 | /// sizeof (EFI_STATUS_CODE_EXCEP_EXTENDED_DATA) - HeaderSize,\r |
b205f267 | 703 | /// and DataHeader.Type should be\r |
704 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
705 | ///\r | |
706 | EFI_STATUS_CODE_DATA DataHeader;\r | |
707 | ///\r | |
708 | /// The system context. \r | |
709 | ///\r | |
710 | EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context;\r | |
711 | } EFI_STATUS_CODE_EXCEP_EXTENDED_DATA;\r | |
712 | \r | |
713 | ///\r | |
714 | /// This structure defines extended data describing a call to a driver binding protocol start function.\r | |
715 | ///\r | |
716 | /// This extended data records information about a Start() function call. Start() is a member of\r | |
717 | /// the UEFI Driver Binding Protocol.\r | |
718 | ///\r | |
719 | typedef struct {\r | |
720 | /// \r | |
721 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
722 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
723 | /// sizeof (EFI_STATUS_CODE_START_EXTENDED_DATA) - HeaderSize,\r | |
724 | /// and DataHeader.Type should be\r | |
725 | /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
726 | ///\r | |
727 | EFI_STATUS_CODE_DATA DataHeader;\r | |
728 | ///\r | |
729 | /// The controller handle. \r | |
730 | ///\r | |
731 | EFI_HANDLE ControllerHandle;\r | |
732 | ///\r | |
733 | /// The driver binding handle.\r | |
734 | ///\r | |
735 | EFI_HANDLE DriverBindingHandle;\r | |
736 | /// \r | |
737 | /// The size of the RemainingDevicePath. It is zero if the Start() function is \r | |
738 | /// called with RemainingDevicePath = NULL. The UEFI Specification allows\r | |
739 | /// that the Start() function of bus drivers can be called in this way.\r | |
740 | ///\r | |
741 | UINT16 DevicePathSize;\r | |
742 | ///\r | |
743 | /// Matches the RemainingDevicePath parameter being passed to the Start() \r | |
744 | /// function. Note that this parameter is the variable-length device path and not a pointer \r | |
745 | /// to the device path.\r | |
746 | /// \r | |
747 | UINT8 *RemainingDevicePath;\r | |
748 | } EFI_STATUS_CODE_START_EXTENDED_DATA;\r | |
749 | \r | |
750 | ///\r | |
751 | /// This structure defines extended data describing a legacy option ROM (OpROM).\r | |
752 | ///\r | |
753 | /// The device handle and ROM image base can be used by consumers to determine which option ROM\r | |
754 | /// failed. Due to the black-box nature of legacy option ROMs, the amount of information that can be\r | |
755 | /// obtained may be limited.\r | |
756 | ///\r | |
757 | typedef struct {\r | |
758 | ///\r | |
759 | /// The data header identifying the data. DataHeader.HeaderSize should be\r | |
760 | /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r | |
761 | /// sizeof (EFI_LEGACY_OPROM_EXTENDED_DATA) - HeaderSize, and\r | |
762 | /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r | |
763 | ///\r | |
764 | EFI_STATUS_CODE_DATA DataHeader;\r | |
765 | ///\r | |
766 | /// The handle corresponding to the device that this legacy option ROM is being invoked.\r | |
767 | ///\r | |
768 | EFI_HANDLE DeviceHandle;\r | |
769 | ///\r | |
770 | /// The base address of the shadowed legacy ROM image. May or may not point to the shadow RAM area. \r | |
771 | ///\r | |
772 | EFI_PHYSICAL_ADDRESS RomImageBase;\r | |
773 | } EFI_LEGACY_OPROM_EXTENDED_DATA;\r | |
774 | \r | |
b205f267 | 775 | extern EFI_GUID gEfiStatusCodeSpecificDataGuid;\r |
776 | \r | |
777 | #endif\r |