]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - IntelFrameworkPkg/Include/Guid/StatusCodeDataTypeId.h
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Refine SMM USB Dispatch Protocol definition.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Guid / StatusCodeDataTypeId.h
... / ...
CommitLineData
1/** @file\r
2 GUID used to identify id for the caller who is initiating the Status Code.\r
3\r
4 Copyright (c) 2006, Intel Corporation\r
5 All rights reserved. This program and the accompanying materials\r
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 Module Name: StatusCodeDataTypeId.h\r
14\r
15 @par Revision Reference:\r
16 GUIDs defined in Status Codes Specification 0.92\r
17\r
18**/\r
19\r
20#ifndef __STATUS_CODE_DATA_TYPE_ID_GUID_H__\r
21#define __STATUS_CODE_DATA_TYPE_ID_GUID_H__\r
22\r
23#include <PiPei.h>\r
24#include <Framework/StatusCode.h>\r
25#include <Framework/DataHubRecords.h>\r
26#include <Protocol/DebugSupport.h>\r
27#include <Protocol/FrameworkHii.h>\r
28\r
29//////////////////////////////////////////////////////////////////////////////////////////\r
30// String Data Type defintion. This is part of Status Code Specification\r
31//////////////////////////////////////////////////////////////////////////////////////////\r
32#define EFI_STATUS_CODE_DATA_TYPE_STRING_GUID \\r
33 { 0x92D11080, 0x496F, 0x4D95, { 0xBE, 0x7E, 0x03, 0x74, 0x88, 0x38, 0x2B, 0x0A } }\r
34\r
35#pragma pack(1)\r
36\r
37typedef enum {\r
38 EfiStringAscii,\r
39 EfiStringUnicode,\r
40 EfiStringToken\r
41} EFI_STRING_TYPE;\r
42\r
43typedef struct {\r
44 FRAMEWORK_EFI_HII_HANDLE Handle;\r
45 STRING_REF Token;\r
46} EFI_STATUS_CODE_STRING_TOKEN;\r
47\r
48typedef union {\r
49 CHAR8 *Ascii;\r
50 CHAR16 *Unicode;\r
51 EFI_STATUS_CODE_STRING_TOKEN Hii;\r
52} EFI_STATUS_CODE_STRING;\r
53\r
54typedef struct {\r
55 EFI_STATUS_CODE_DATA DataHeader;\r
56 EFI_STRING_TYPE StringType;\r
57 EFI_STATUS_CODE_STRING String;\r
58} EFI_STATUS_CODE_STRING_DATA;\r
59#pragma pack()\r
60\r
61extern EFI_GUID gEfiStatusCodeDataTypeStringGuid;\r
62\r
63\r
64//////////////////////////////////////////////////////////////////////////////////////////\r
65// Special Data Type defintion. This is part of Status Code Specification\r
66//////////////////////////////////////////////////////////////////////////////////////////\r
67#define EFI_STATUS_CODE_SPECIFIC_DATA_GUID \\r
68 { 0x335984bd, 0xe805, 0x409a, { 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 } }\r
69\r
70#pragma pack(1)\r
71\r
72///\r
73/// Device handle Extended Data. Used for many\r
74/// errors and progress codes to point to the device.\r
75///\r
76typedef struct {\r
77 EFI_STATUS_CODE_DATA DataHeader;\r
78 EFI_HANDLE Handle;\r
79} EFI_DEVICE_HANDLE_EXTENDED_DATA;\r
80\r
81\r
82typedef struct {\r
83 EFI_STATUS_CODE_DATA DataHeader;\r
84 UINT8 *DevicePath;\r
85} EFI_DEVICE_PATH_EXTENDED_DATA;\r
86\r
87typedef struct {\r
88 EFI_STATUS_CODE_DATA DataHeader;\r
89 UINT32 Bar;\r
90 UINT16 DevicePathSize;\r
91 UINT16 ReqResSize;\r
92 UINT16 AllocResSize;\r
93 UINT8 *DevicePath;\r
94 UINT8 *ReqRes;\r
95 UINT8 *AllocRes;\r
96} EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r
97\r
98///\r
99/// This structure provides the voltage at the time of error. It also provides \r
100/// the threshold value indicating the minimum or maximum voltage that is considered \r
101/// an error. If the voltage is less then the threshold, the error indicates that the \r
102/// voltage fell below the minimum acceptable value. If the voltage is greater then the threshold, \r
103/// the error indicates that the voltage rose above the maximum acceptable value.\r
104///\r
105typedef struct {\r
106 ///\r
107 /// The data header identifying the data. \r
108 ///\r
109 EFI_STATUS_CODE_DATA DataHeader;\r
110 ///\r
111 /// The voltage value at the time of the error.\r
112 ///\r
113 EFI_EXP_BASE10_DATA Voltage;\r
114 ///\r
115 /// The voltage threshold.\r
116 ///\r
117 EFI_EXP_BASE10_DATA Threshold;\r
118} EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA;\r
119\r
120///\r
121/// Microcode Update Extended Error Data\r
122///\r
123typedef struct {\r
124 ///\r
125 /// The data header identifying the data. \r
126 ///\r
127 EFI_STATUS_CODE_DATA DataHeader;\r
128 ///\r
129 /// The version of the microcode update from the header.\r
130 ///\r
131 UINT32 Version;\r
132} EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA;\r
133\r
134///\r
135/// Asynchronous Timer Extended Error Data\r
136/// The timer limit provides the timeout value of the timer prior to expiration.\r
137///\r
138typedef struct {\r
139 ///\r
140 /// The data header identifying the data. \r
141 ///\r
142 EFI_STATUS_CODE_DATA DataHeader;\r
143 ///\r
144 /// The number of seconds that the computing unit timer was configured to expire.\r
145 ///\r
146 EFI_EXP_BASE10_DATA TimerLimit;\r
147} EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA;\r
148\r
149///\r
150/// Host Processor Mismatch Extended Error Data\r
151/// This provides information to indicate which processors mismatch, and how they mismatch. The \r
152/// status code contains the instance number of the processor that is in error. This structure's \r
153/// Instance indicates the second processor that does not match. This differentiation allows the \r
154/// consumer to determine which two processors do not match. The Attributes indicate what \r
155/// mismatch is being reported. Because Attributes is a bit field, more than one mismatch can be \r
156/// reported with one error code.\r
157///\r
158typedef struct {\r
159 ///\r
160 /// The data header identifying the data. \r
161 ///\r
162 EFI_STATUS_CODE_DATA DataHeader;\r
163 ///\r
164 /// The unit number of the computing unit that does not match.\r
165 /// \r
166 UINT32 Instance;\r
167 /// \r
168 /// The attributes describing the failure. \r
169 /// \r
170 UINT16 Attributes;\r
171} EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA;\r
172\r
173///\r
174/// Thermal Extended Error Data\r
175/// This structure provides the temperature at the time of error. It also provides the threshold value \r
176/// indicating the minimum temperature that is considered an error.\r
177///\r
178typedef struct {\r
179 ///\r
180 /// The data header identifying the data. \r
181 ///\r
182 EFI_STATUS_CODE_DATA DataHeader;\r
183 ///\r
184 /// The thermal value at the time of the error.\r
185 ///\r
186 EFI_EXP_BASE10_DATA Temperature;\r
187 ///\r
188 /// The thermal threshold.\r
189 ///\r
190 EFI_EXP_BASE10_DATA Threshold;\r
191} EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA;\r
192\r
193//\r
194// Valid cache types\r
195//\r
196typedef enum {\r
197 EfiInitCacheDataOnly,\r
198 EfiInitCacheInstrOnly,\r
199 EfiInitCacheBoth,\r
200 EfiInitCacheUnspecified\r
201} EFI_INIT_CACHE_TYPE;\r
202\r
203///\r
204/// Embedded cache init extended data\r
205///\r
206typedef struct {\r
207 EFI_STATUS_CODE_DATA DataHeader;\r
208 UINT32 Level;\r
209 EFI_INIT_CACHE_TYPE Type;\r
210} EFI_CACHE_INIT_DATA;\r
211\r
212///\r
213/// Processor Disabled Extended Error Data\r
214/// This structure provides details as to why and how the computing unit was disabled. The causes \r
215/// should cover the typical reasons a processor would be disabled. How the processor was disabled is \r
216/// important because there are distinct differences between hardware and software disabling.\r
217///\r
218typedef struct {\r
219 ///\r
220 /// The data header identifying the data. \r
221 ///\r
222 EFI_STATUS_CODE_DATA DataHeader;\r
223 ///\r
224 /// The reason for disabling the processor. \r
225 /// \r
226 UINT32 Cause;\r
227 ///\r
228 /// TRUE if the processor is disabled via software means such as not listing it in the ACPI tables. \r
229 /// Such a processor will respond to Interprocessor Interrupts (IPIs). FALSE if the processor is hardware \r
230 /// disabled, which means it is invisible to software and will not respond to IPIs.\r
231 ///\r
232 BOOLEAN SoftwareDisabled;\r
233} EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA;\r
234\r
235///\r
236/// Memory Error Operation Definition\r
237///\r
238typedef UINT8 EFI_MEMORY_ERROR_OPERATION;\r
239\r
240///\r
241/// Memory Error Granularity Definition\r
242///\r
243typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY;\r
244\r
245///\r
246/// This structure provides specific details about the memory error that was detected. It provides \r
247/// enough information so that consumers can identify the exact failure and provides enough \r
248/// information to enable corrective action if necessary.\r
249///\r
250typedef struct {\r
251 ///\r
252 /// The data header identifying the data. \r
253 ///\r
254 EFI_STATUS_CODE_DATA DataHeader;\r
255 ///\r
256 /// The error granularity type.\r
257 ///\r
258 EFI_MEMORY_ERROR_GRANULARITY Granularity;\r
259 ///\r
260 /// The operation that resulted in the error being detected. \r
261 ///\r
262 EFI_MEMORY_ERROR_OPERATION Operation;\r
263 ///\r
264 /// The error syndrome, vendor-specific ECC syndrome, or CRC data associated with \r
265 /// the error. If unknown, should be initialized to 0.\r
266 ///\r
267 UINTN Syndrome;\r
268 ///\r
269 /// The physical address of the error. \r
270 ///\r
271 EFI_PHYSICAL_ADDRESS Address;\r
272 ///\r
273 /// The range, in bytes, within which the error address can be determined.\r
274 ///\r
275 UINTN Resolution;\r
276} EFI_MEMORY_EXTENDED_ERROR_DATA;\r
277\r
278///\r
279/// This extended data provides some context that consumers can use to locate a DIMM within the \r
280/// overall memory scheme. \r
281///\r
282typedef struct {\r
283 ///\r
284 /// The data header identifying the data. \r
285 ///\r
286 EFI_STATUS_CODE_DATA DataHeader;\r
287 ///\r
288 /// The memory array number.\r
289 ///\r
290 UINT16 Array;\r
291 ///\r
292 /// The device number within that Array.\r
293 ///\r
294 UINT16 Device;\r
295} EFI_STATUS_CODE_DIMM_NUMBER;\r
296\r
297///\r
298/// Memory Module Mismatch Extended Error Data\r
299/// \r
300typedef struct {\r
301 ///\r
302 /// The data header identifying the data.\r
303 ///\r
304 EFI_STATUS_CODE_DATA DataHeader;\r
305 ///\r
306 /// The instance number of the memory module that does not match. \r
307 ///\r
308 EFI_STATUS_CODE_DIMM_NUMBER Instance;\r
309} EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA;\r
310\r
311///\r
312/// Memory Range Extended Data\r
313/// This extended data may be used to convey the specifics of a memory range. Ranges are specified \r
314/// with a start address and a length.\r
315///\r
316typedef struct {\r
317 ///\r
318 /// The data header identifying the data. \r
319 ///\r
320 EFI_STATUS_CODE_DATA DataHeader;\r
321 ///\r
322 /// The starting address of the memory range. \r
323 ///\r
324 EFI_PHYSICAL_ADDRESS Start;\r
325 ///\r
326 /// The length in bytes of the memory range.\r
327 ///\r
328 EFI_PHYSICAL_ADDRESS Length;\r
329} EFI_MEMORY_RANGE_EXTENDED_DATA;\r
330\r
331///\r
332/// Extended Error Data for Assert\r
333/// The data indicates the location of the assertion that failed in the source code. This information \r
334/// includes the file name and line number that are necessary to find the failing assertion in source code.\r
335///\r
336typedef struct {\r
337 ///\r
338 /// The data header identifying the data.\r
339 /// \r
340 EFI_STATUS_CODE_DATA DataHeader;\r
341 ///\r
342 /// The line number of the source file where the fault was generated.\r
343 ///\r
344 UINT32 LineNumber;\r
345 ///\r
346 /// The size in bytes of FileName.\r
347 ///\r
348 UINT32 FileNameSize;\r
349 ///\r
350 /// A pointer to a NULL-terminated ASCII or Unicode string that represents the file \r
351 /// name of the source file where the fault was generated. \r
352 ///\r
353 EFI_STATUS_CODE_STRING_DATA *FileName;\r
354} EFI_DEBUG_ASSERT_DATA;\r
355\r
356///\r
357/// System Context Data EBC/IA32/IPF\r
358///\r
359typedef union {\r
360 EFI_SYSTEM_CONTEXT_EBC SystemContextEbc;\r
361 EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32;\r
362 EFI_SYSTEM_CONTEXT_IPF SystemContextIpf;\r
363} EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT;\r
364\r
365///\r
366/// This extended data allows the processor context that is present at the time of the exception to be \r
367/// reported with the exception. The format and contents of the context data varies depending on the \r
368/// processor architecture. \r
369///\r
370typedef struct {\r
371 ///\r
372 /// The data header identifying the data. \r
373 ///\r
374 EFI_STATUS_CODE_DATA DataHeader;\r
375 ///\r
376 /// The system context. \r
377 ///\r
378 EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context;\r
379} EFI_STATUS_CODE_EXCEP_EXTENDED_DATA;\r
380\r
381///\r
382/// This extended data records information about a Start() function call. Start() is a member of \r
383/// the EFI 1.10 Driver Binding Protocol.\r
384///\r
385typedef struct {\r
386 /// \r
387 /// The data header identifying the data. \r
388 ///\r
389 EFI_STATUS_CODE_DATA DataHeader;\r
390 ///\r
391 /// The controller handle. \r
392 ///\r
393 EFI_HANDLE ControllerHandle;\r
394 ///\r
395 /// The driver binding handle.\r
396 ///\r
397 EFI_HANDLE DriverBindingHandle;\r
398 /// \r
399 /// The size of the RemainingDevicePath. It is zero if the Start() function is \r
400 /// called with RemainingDevicePath = NULL. \r
401 ///\r
402 UINT16 DevicePathSize;\r
403 ///\r
404 /// Matches the RemainingDevicePath parameter being passed to the Start() \r
405 /// function. Note that this parameter is the variable-length device path and not a pointer \r
406 /// to the device path.\r
407 /// \r
408 UINT8 *RemainingDevicePath;\r
409} EFI_STATUS_CODE_START_EXTENDED_DATA;\r
410\r
411///\r
412/// Legacy Oprom extended data\r
413/// The device handle and ROM image base can be used by consumers to determine which option \r
414/// ROM failed. Due to the black-box nature of legacy option ROMs, the amount of information that \r
415/// can be obtained may be limited.\r
416///\r
417typedef struct {\r
418 ///\r
419 /// The data header identifying the data.\r
420 ///\r
421 EFI_STATUS_CODE_DATA DataHeader;\r
422 ///\r
423 /// The handle corresponding to the device that this legacy option ROM is being invoked.\r
424 ///\r
425 EFI_HANDLE DeviceHandle;\r
426 ///\r
427 /// The base address of the shadowed legacy ROM image. \r
428 /// May or may not point to the shadow RAM area. \r
429 ///\r
430 EFI_PHYSICAL_ADDRESS RomImageBase;\r
431} EFI_LEGACY_OPROM_EXTENDED_DATA;\r
432\r
433#pragma pack()\r
434\r
435extern EFI_GUID gEfiStatusCodeSpecificDataGuid;\r
436\r
437//\r
438// EFI_COMPUTING_UNIT_MISMATCH_ATTRIBUTES\r
439// All other attributes are reserved for future use and\r
440// must be initialized to 0.\r
441//\r
442#define EFI_COMPUTING_UNIT_MISMATCH_SPEED 0x0001\r
443#define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED 0x0002\r
444#define EFI_COMPUTING_UNIT_MISMATCH_FAMILY 0x0004\r
445#define EFI_COMPUTING_UNIT_MISMATCH_MODEL 0x0008\r
446#define EFI_COMPUTING_UNIT_MISMATCH_STEPPING 0x0010\r
447#define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE 0x0020\r
448#define EFI_COMPUTING_UNIT_MISMATCH_OEM1 0x1000\r
449#define EFI_COMPUTING_UNIT_MISMATCH_OEM2 0x2000\r
450#define EFI_COMPUTING_UNIT_MISMATCH_OEM3 0x4000\r
451#define EFI_COMPUTING_UNIT_MISMATCH_OEM4 0x8000\r
452\r
453\r
454\r
455//\r
456// Memory Error Granularities\r
457//\r
458#define EFI_MEMORY_ERROR_OTHER 0x01\r
459#define EFI_MEMORY_ERROR_UNKNOWN 0x02\r
460#define EFI_MEMORY_ERROR_DEVICE 0x03\r
461#define EFI_MEMORY_ERROR_PARTITION 0x04\r
462\r
463//\r
464// Memory Error Operations\r
465//\r
466#define EFI_MEMORY_OPERATION_OTHER 0x01\r
467#define EFI_MEMORY_OPERATION_UNKNOWN 0x02\r
468#define EFI_MEMORY_OPERATION_READ 0x03\r
469#define EFI_MEMORY_OPERATION_WRITE 0x04\r
470#define EFI_MEMORY_OPERATION_PARTIAL_WRITE 0x05\r
471\r
472//\r
473// Define shorthands to describe Group Operations\r
474// Many memory init operations are essentially group\r
475// operations.\r
476\r
477/// A shorthand to describe that the operation is performed\r
478/// on multiple devices within the array\r
479///\r
480#define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe\r
481///\r
482/// A shorthand to describe that the operation is performed on all devices within the array\r
483///\r
484#define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff\r
485///\r
486/// A shorthand to describe that the operation is performed on multiple arrays\r
487///\r
488#define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe\r
489///\r
490/// A shorthand to describe that the operation is performed on all the arrays\r
491///\r
492#define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff\r
493\r
494#endif\r
EFI Development Kit II mirror for PVE