2 GUID used to identify id for the caller who is initiating the Status Code.
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: StatusCodeDataTypeId.h
15 @par Revision Reference:
16 GUIDs defined in Status Codes Specification 0.92
20 #ifndef __STATUS_CODE_DATA_TYPE_ID_GUID_H__
21 #define __STATUS_CODE_DATA_TYPE_ID_GUID_H__
24 #include <Framework/StatusCode.h>
25 #include <Framework/DataHubRecords.h>
26 #include <Protocol/DebugSupport.h>
27 #include <Protocol/FrameworkHii.h>
29 //////////////////////////////////////////////////////////////////////////////////////////
30 // String Data Type defintion. This is part of Status Code Specification
31 //////////////////////////////////////////////////////////////////////////////////////////
32 #define EFI_STATUS_CODE_DATA_TYPE_STRING_GUID \
33 { 0x92D11080, 0x496F, 0x4D95, { 0xBE, 0x7E, 0x03, 0x74, 0x88, 0x38, 0x2B, 0x0A } }
39 /// A NULL-terminated ASCII string.
43 /// A double NULL-terminated Unicode string.
47 /// An EFI_STATUS_CODE_STRING_TOKEN representing the string. The actual string
48 /// can be obtained by querying the HII Database.
55 /// The HII handle of the string pack, which can be used to retrieve the string.
56 /// It is a dynamic value that may not be the same for different boots.
58 FRAMEWORK_EFI_HII_HANDLE Handle
;
60 /// When combined with the HII handle, the string token can be used to retrieve the
64 } EFI_STATUS_CODE_STRING_TOKEN
;
68 /// ASCII formatted string.
72 /// Unicode formatted string.
76 /// HII handle/token pair.
78 EFI_STATUS_CODE_STRING_TOKEN Hii
;
79 } EFI_STATUS_CODE_STRING
;
83 /// The data header identifying the data. The HeaderSize should be sizeof
84 /// (EFI_STATUS_CODE_DATA).
85 /// The Size should be sizeof(EFI_STATUS_CODE_STRING_DATA) - HeaderSize.
86 /// The Type should be EFI_STATUS_CODE_DATA_TYPE_STRING_GUID.
88 EFI_STATUS_CODE_DATA DataHeader
;
90 /// Specifies if the string is ASCII or Unicode.
92 EFI_STRING_TYPE StringType
;
94 /// A pointer to a null-terminated ASCII or Unicode string.
96 EFI_STATUS_CODE_STRING String
;
97 } EFI_STATUS_CODE_STRING_DATA
;
100 extern EFI_GUID gEfiStatusCodeDataTypeStringGuid
;
103 //////////////////////////////////////////////////////////////////////////////////////////
104 // Special Data Type defintion. This is part of Status Code Specification
105 //////////////////////////////////////////////////////////////////////////////////////////
106 #define EFI_STATUS_CODE_SPECIFIC_DATA_GUID \
107 { 0x335984bd, 0xe805, 0x409a, { 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 } }
112 /// Device handle Extended Data. Used for many
113 /// errors and progress codes to point to the device.
116 EFI_STATUS_CODE_DATA DataHeader
;
118 } EFI_DEVICE_HANDLE_EXTENDED_DATA
;
121 /// Extended data about the device path, which is used for many errors and
122 /// progress codes to point to the device.
125 EFI_STATUS_CODE_DATA DataHeader
;
127 } EFI_DEVICE_PATH_EXTENDED_DATA
;
130 /// This structure defines extended data describing a PCI resource allocation error.
133 EFI_STATUS_CODE_DATA DataHeader
;
135 UINT16 DevicePathSize
;
141 } EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA
;
144 /// This structure provides the voltage at the time of error. It also provides
145 /// the threshold value indicating the minimum or maximum voltage that is considered
146 /// an error. If the voltage is less then the threshold, the error indicates that the
147 /// voltage fell below the minimum acceptable value. If the voltage is greater then the threshold,
148 /// the error indicates that the voltage rose above the maximum acceptable value.
152 /// The data header identifying the data.
154 EFI_STATUS_CODE_DATA DataHeader
;
156 /// The voltage value at the time of the error.
158 EFI_EXP_BASE10_DATA Voltage
;
160 /// The voltage threshold.
162 EFI_EXP_BASE10_DATA Threshold
;
163 } EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA
;
166 /// Microcode Update Extended Error Data
170 /// The data header identifying the data.
172 EFI_STATUS_CODE_DATA DataHeader
;
174 /// The version of the microcode update from the header.
177 } EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA
;
180 /// Asynchronous Timer Extended Error Data
181 /// The timer limit provides the timeout value of the timer prior to expiration.
185 /// The data header identifying the data.
187 EFI_STATUS_CODE_DATA DataHeader
;
189 /// The number of seconds that the computing unit timer was configured to expire.
191 EFI_EXP_BASE10_DATA TimerLimit
;
192 } EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA
;
195 /// Host Processor Mismatch Extended Error Data
196 /// This provides information to indicate which processors mismatch, and how they mismatch. The
197 /// status code contains the instance number of the processor that is in error. This structure's
198 /// Instance indicates the second processor that does not match. This differentiation allows the
199 /// consumer to determine which two processors do not match. The Attributes indicate what
200 /// mismatch is being reported. Because Attributes is a bit field, more than one mismatch can be
201 /// reported with one error code.
205 /// The data header identifying the data.
207 EFI_STATUS_CODE_DATA DataHeader
;
209 /// The unit number of the computing unit that does not match.
213 /// The attributes describing the failure.
216 } EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA
;
219 /// Thermal Extended Error Data
220 /// This structure provides the temperature at the time of error. It also provides the threshold value
221 /// indicating the minimum temperature that is considered an error.
225 /// The data header identifying the data.
227 EFI_STATUS_CODE_DATA DataHeader
;
229 /// The thermal value at the time of the error.
231 EFI_EXP_BASE10_DATA Temperature
;
233 /// The thermal threshold.
235 EFI_EXP_BASE10_DATA Threshold
;
236 } EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA
;
242 EfiInitCacheDataOnly
,
243 EfiInitCacheInstrOnly
,
245 EfiInitCacheUnspecified
246 } EFI_INIT_CACHE_TYPE
;
249 /// Embedded cache init extended data
252 EFI_STATUS_CODE_DATA DataHeader
;
254 EFI_INIT_CACHE_TYPE Type
;
255 } EFI_CACHE_INIT_DATA
;
258 /// Processor Disabled Extended Error Data
259 /// This structure provides details as to why and how the computing unit was disabled. The causes
260 /// should cover the typical reasons a processor would be disabled. How the processor was disabled is
261 /// important because there are distinct differences between hardware and software disabling.
265 /// The data header identifying the data.
267 EFI_STATUS_CODE_DATA DataHeader
;
269 /// The reason for disabling the processor.
273 /// TRUE if the processor is disabled via software means such as not listing it in the ACPI tables.
274 /// Such a processor will respond to Interprocessor Interrupts (IPIs). FALSE if the processor is hardware
275 /// disabled, which means it is invisible to software and will not respond to IPIs.
277 BOOLEAN SoftwareDisabled
;
278 } EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA
;
281 /// Memory Error Operation Definition
283 typedef UINT8 EFI_MEMORY_ERROR_OPERATION
;
286 /// Memory Error Granularity Definition
288 typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY
;
291 /// This structure provides specific details about the memory error that was detected. It provides
292 /// enough information so that consumers can identify the exact failure and provides enough
293 /// information to enable corrective action if necessary.
297 /// The data header identifying the data.
299 EFI_STATUS_CODE_DATA DataHeader
;
301 /// The error granularity type.
303 EFI_MEMORY_ERROR_GRANULARITY Granularity
;
305 /// The operation that resulted in the error being detected.
307 EFI_MEMORY_ERROR_OPERATION Operation
;
309 /// The error syndrome, vendor-specific ECC syndrome, or CRC data associated with
310 /// the error. If unknown, should be initialized to 0.
314 /// The physical address of the error.
316 EFI_PHYSICAL_ADDRESS Address
;
318 /// The range, in bytes, within which the error address can be determined.
321 } EFI_MEMORY_EXTENDED_ERROR_DATA
;
324 /// This extended data provides some context that consumers can use to locate a DIMM within the
325 /// overall memory scheme.
329 /// The data header identifying the data.
331 EFI_STATUS_CODE_DATA DataHeader
;
333 /// The memory array number.
337 /// The device number within that Array.
340 } EFI_STATUS_CODE_DIMM_NUMBER
;
343 /// Memory Module Mismatch Extended Error Data
347 /// The data header identifying the data.
349 EFI_STATUS_CODE_DATA DataHeader
;
351 /// The instance number of the memory module that does not match.
353 EFI_STATUS_CODE_DIMM_NUMBER Instance
;
354 } EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA
;
357 /// Memory Range Extended Data
358 /// This extended data may be used to convey the specifics of a memory range. Ranges are specified
359 /// with a start address and a length.
363 /// The data header identifying the data.
365 EFI_STATUS_CODE_DATA DataHeader
;
367 /// The starting address of the memory range.
369 EFI_PHYSICAL_ADDRESS Start
;
371 /// The length in bytes of the memory range.
373 EFI_PHYSICAL_ADDRESS Length
;
374 } EFI_MEMORY_RANGE_EXTENDED_DATA
;
377 /// Extended Error Data for Assert
378 /// The data indicates the location of the assertion that failed in the source code. This information
379 /// includes the file name and line number that are necessary to find the failing assertion in source code.
383 /// The data header identifying the data.
385 EFI_STATUS_CODE_DATA DataHeader
;
387 /// The line number of the source file where the fault was generated.
391 /// The size in bytes of FileName.
395 /// A pointer to a NULL-terminated ASCII or Unicode string that represents the file
396 /// name of the source file where the fault was generated.
398 EFI_STATUS_CODE_STRING_DATA
*FileName
;
399 } EFI_DEBUG_ASSERT_DATA
;
402 /// System Context Data EBC/IA32/IPF
405 EFI_SYSTEM_CONTEXT_EBC SystemContextEbc
;
406 EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32
;
407 EFI_SYSTEM_CONTEXT_IPF SystemContextIpf
;
408 } EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT
;
411 /// This extended data allows the processor context that is present at the time of the exception to be
412 /// reported with the exception. The format and contents of the context data varies depending on the
413 /// processor architecture.
417 /// The data header identifying the data.
419 EFI_STATUS_CODE_DATA DataHeader
;
421 /// The system context.
423 EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context
;
424 } EFI_STATUS_CODE_EXCEP_EXTENDED_DATA
;
427 /// This extended data records information about a Start() function call. Start() is a member of
428 /// the EFI 1.10 Driver Binding Protocol.
432 /// The data header identifying the data.
434 EFI_STATUS_CODE_DATA DataHeader
;
436 /// The controller handle.
438 EFI_HANDLE ControllerHandle
;
440 /// The driver binding handle.
442 EFI_HANDLE DriverBindingHandle
;
444 /// The size of the RemainingDevicePath. It is zero if the Start() function is
445 /// called with RemainingDevicePath = NULL.
447 UINT16 DevicePathSize
;
449 /// Matches the RemainingDevicePath parameter being passed to the Start()
450 /// function. Note that this parameter is the variable-length device path and not a pointer
451 /// to the device path.
453 UINT8
*RemainingDevicePath
;
454 } EFI_STATUS_CODE_START_EXTENDED_DATA
;
457 /// Legacy Oprom extended data
458 /// The device handle and ROM image base can be used by consumers to determine which option
459 /// ROM failed. Due to the black-box nature of legacy option ROMs, the amount of information that
460 /// can be obtained may be limited.
464 /// The data header identifying the data.
466 EFI_STATUS_CODE_DATA DataHeader
;
468 /// The handle corresponding to the device that this legacy option ROM is being invoked.
470 EFI_HANDLE DeviceHandle
;
472 /// The base address of the shadowed legacy ROM image.
473 /// May or may not point to the shadow RAM area.
475 EFI_PHYSICAL_ADDRESS RomImageBase
;
476 } EFI_LEGACY_OPROM_EXTENDED_DATA
;
480 extern EFI_GUID gEfiStatusCodeSpecificDataGuid
;
483 // EFI_COMPUTING_UNIT_MISMATCH_ATTRIBUTES
484 // All other attributes are reserved for future use and
485 // must be initialized to 0.
487 #define EFI_COMPUTING_UNIT_MISMATCH_SPEED 0x0001
488 #define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED 0x0002
489 #define EFI_COMPUTING_UNIT_MISMATCH_FAMILY 0x0004
490 #define EFI_COMPUTING_UNIT_MISMATCH_MODEL 0x0008
491 #define EFI_COMPUTING_UNIT_MISMATCH_STEPPING 0x0010
492 #define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE 0x0020
493 #define EFI_COMPUTING_UNIT_MISMATCH_OEM1 0x1000
494 #define EFI_COMPUTING_UNIT_MISMATCH_OEM2 0x2000
495 #define EFI_COMPUTING_UNIT_MISMATCH_OEM3 0x4000
496 #define EFI_COMPUTING_UNIT_MISMATCH_OEM4 0x8000
501 // Memory Error Granularities
503 #define EFI_MEMORY_ERROR_OTHER 0x01
504 #define EFI_MEMORY_ERROR_UNKNOWN 0x02
505 #define EFI_MEMORY_ERROR_DEVICE 0x03
506 #define EFI_MEMORY_ERROR_PARTITION 0x04
509 // Memory Error Operations
511 #define EFI_MEMORY_OPERATION_OTHER 0x01
512 #define EFI_MEMORY_OPERATION_UNKNOWN 0x02
513 #define EFI_MEMORY_OPERATION_READ 0x03
514 #define EFI_MEMORY_OPERATION_WRITE 0x04
515 #define EFI_MEMORY_OPERATION_PARTIAL_WRITE 0x05
518 // Define shorthands to describe Group Operations
519 // Many memory init operations are essentially group
522 /// A shorthand to describe that the operation is performed
523 /// on multiple devices within the array
525 #define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe
527 /// A shorthand to describe that the operation is performed on all devices within the array
529 #define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff
531 /// A shorthand to describe that the operation is performed on multiple arrays
533 #define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe
535 /// A shorthand to describe that the operation is performed on all the arrays
537 #define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff