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 } }
38 EfiStringAscii
, ///< A NULL-terminated ASCII string.
39 EfiStringUnicode
, ///< A double NULL-terminated Unicode string.
40 EfiStringToken
///< An EFI_STATUS_CODE_STRING_TOKEN representing the string.
41 ///< The actual string can be obtained by querying the HII Database.
45 FRAMEWORK_EFI_HII_HANDLE Handle
; ///< The HII handle of the string pack, which can be
46 ///< used to retrieve the string. It is a dynamic value
47 ///< that may not be the same for different boots.
48 STRING_REF Token
; ///< When combined with the HII handle, the string
49 ///< token can be used to retrieve the string.
51 } EFI_STATUS_CODE_STRING_TOKEN
;
54 CHAR8
*Ascii
; ///< ASCII formatted string.
55 CHAR16
*Unicode
; ///< Unicode formatted string.
56 EFI_STATUS_CODE_STRING_TOKEN Hii
; ///< HII handle/token pair.
57 } EFI_STATUS_CODE_STRING
;
60 EFI_STATUS_CODE_DATA DataHeader
; ///< The data header identifying the data.
61 EFI_STRING_TYPE StringType
; ///< Specifies if the string is ASCII or Unicode.
62 EFI_STATUS_CODE_STRING String
; ///< A pointer to a null-terminated ASCII or Unicode string.
63 } EFI_STATUS_CODE_STRING_DATA
;
66 extern EFI_GUID gEfiStatusCodeDataTypeStringGuid
;
69 //////////////////////////////////////////////////////////////////////////////////////////
70 // Special Data Type defintion. This is part of Status Code Specification
71 //////////////////////////////////////////////////////////////////////////////////////////
72 #define EFI_STATUS_CODE_SPECIFIC_DATA_GUID \
73 { 0x335984bd, 0xe805, 0x409a, { 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 } }
78 /// Device handle Extended Data. Used for many
79 /// errors and progress codes to point to the device.
82 EFI_STATUS_CODE_DATA DataHeader
;
84 } EFI_DEVICE_HANDLE_EXTENDED_DATA
;
87 /// Extended data about the device path, which is used for many errors and
88 /// progress codes to point to the device.
91 EFI_STATUS_CODE_DATA DataHeader
;
93 } EFI_DEVICE_PATH_EXTENDED_DATA
;
96 /// This structure defines extended data describing a PCI resource allocation error.
99 EFI_STATUS_CODE_DATA DataHeader
;
101 UINT16 DevicePathSize
;
107 } EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA
;
110 /// This structure provides the voltage at the time of error. It also provides
111 /// the threshold value indicating the minimum or maximum voltage that is considered
112 /// an error. If the voltage is less then the threshold, the error indicates that the
113 /// voltage fell below the minimum acceptable value. If the voltage is greater then the threshold,
114 /// the error indicates that the voltage rose above the maximum acceptable value.
118 /// The data header identifying the data.
120 EFI_STATUS_CODE_DATA DataHeader
;
122 /// The voltage value at the time of the error.
124 EFI_EXP_BASE10_DATA Voltage
;
126 /// The voltage threshold.
128 EFI_EXP_BASE10_DATA Threshold
;
129 } EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA
;
132 /// Microcode Update Extended Error Data
136 /// The data header identifying the data.
138 EFI_STATUS_CODE_DATA DataHeader
;
140 /// The version of the microcode update from the header.
143 } EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA
;
146 /// Asynchronous Timer Extended Error Data
147 /// The timer limit provides the timeout value of the timer prior to expiration.
151 /// The data header identifying the data.
153 EFI_STATUS_CODE_DATA DataHeader
;
155 /// The number of seconds that the computing unit timer was configured to expire.
157 EFI_EXP_BASE10_DATA TimerLimit
;
158 } EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA
;
161 /// Host Processor Mismatch Extended Error Data
162 /// This provides information to indicate which processors mismatch, and how they mismatch. The
163 /// status code contains the instance number of the processor that is in error. This structure's
164 /// Instance indicates the second processor that does not match. This differentiation allows the
165 /// consumer to determine which two processors do not match. The Attributes indicate what
166 /// mismatch is being reported. Because Attributes is a bit field, more than one mismatch can be
167 /// reported with one error code.
171 /// The data header identifying the data.
173 EFI_STATUS_CODE_DATA DataHeader
;
175 /// The unit number of the computing unit that does not match.
179 /// The attributes describing the failure.
182 } EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA
;
185 /// Thermal Extended Error Data
186 /// This structure provides the temperature at the time of error. It also provides the threshold value
187 /// indicating the minimum temperature that is considered an error.
191 /// The data header identifying the data.
193 EFI_STATUS_CODE_DATA DataHeader
;
195 /// The thermal value at the time of the error.
197 EFI_EXP_BASE10_DATA Temperature
;
199 /// The thermal threshold.
201 EFI_EXP_BASE10_DATA Threshold
;
202 } EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA
;
208 EfiInitCacheDataOnly
,
209 EfiInitCacheInstrOnly
,
211 EfiInitCacheUnspecified
212 } EFI_INIT_CACHE_TYPE
;
215 /// Embedded cache init extended data
218 EFI_STATUS_CODE_DATA DataHeader
;
220 EFI_INIT_CACHE_TYPE Type
;
221 } EFI_CACHE_INIT_DATA
;
224 /// Processor Disabled Extended Error Data
225 /// This structure provides details as to why and how the computing unit was disabled. The causes
226 /// should cover the typical reasons a processor would be disabled. How the processor was disabled is
227 /// important because there are distinct differences between hardware and software disabling.
231 /// The data header identifying the data.
233 EFI_STATUS_CODE_DATA DataHeader
;
235 /// The reason for disabling the processor.
239 /// TRUE if the processor is disabled via software means such as not listing it in the ACPI tables.
240 /// Such a processor will respond to Interprocessor Interrupts (IPIs). FALSE if the processor is hardware
241 /// disabled, which means it is invisible to software and will not respond to IPIs.
243 BOOLEAN SoftwareDisabled
;
244 } EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA
;
247 /// Memory Error Operation Definition
249 typedef UINT8 EFI_MEMORY_ERROR_OPERATION
;
252 /// Memory Error Granularity Definition
254 typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY
;
257 /// This structure provides specific details about the memory error that was detected. It provides
258 /// enough information so that consumers can identify the exact failure and provides enough
259 /// information to enable corrective action if necessary.
263 /// The data header identifying the data.
265 EFI_STATUS_CODE_DATA DataHeader
;
267 /// The error granularity type.
269 EFI_MEMORY_ERROR_GRANULARITY Granularity
;
271 /// The operation that resulted in the error being detected.
273 EFI_MEMORY_ERROR_OPERATION Operation
;
275 /// The error syndrome, vendor-specific ECC syndrome, or CRC data associated with
276 /// the error. If unknown, should be initialized to 0.
277 /// Inconsistent with specification here:
278 /// This field in StatusCodes spec0.9 is defined as UINT32, keep code unchanged.
282 /// The physical address of the error.
284 EFI_PHYSICAL_ADDRESS Address
;
286 /// The range, in bytes, within which the error address can be determined.
289 } EFI_MEMORY_EXTENDED_ERROR_DATA
;
292 /// This extended data provides some context that consumers can use to locate a DIMM within the
293 /// overall memory scheme.
297 /// The data header identifying the data.
299 EFI_STATUS_CODE_DATA DataHeader
;
301 /// The memory array number.
305 /// The device number within that Array.
308 } EFI_STATUS_CODE_DIMM_NUMBER
;
311 /// Memory Module Mismatch Extended Error Data
315 /// The data header identifying the data.
317 EFI_STATUS_CODE_DATA DataHeader
;
319 /// The instance number of the memory module that does not match.
321 EFI_STATUS_CODE_DIMM_NUMBER Instance
;
322 } EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA
;
325 /// Memory Range Extended Data
326 /// This extended data may be used to convey the specifics of a memory range. Ranges are specified
327 /// with a start address and a length.
331 /// The data header identifying the data.
333 EFI_STATUS_CODE_DATA DataHeader
;
335 /// The starting address of the memory range.
337 EFI_PHYSICAL_ADDRESS Start
;
339 /// The length in bytes of the memory range.
341 EFI_PHYSICAL_ADDRESS Length
;
342 } EFI_MEMORY_RANGE_EXTENDED_DATA
;
345 /// Extended Error Data for Assert
346 /// The data indicates the location of the assertion that failed in the source code. This information
347 /// includes the file name and line number that are necessary to find the failing assertion in source code.
351 /// The data header identifying the data.
353 EFI_STATUS_CODE_DATA DataHeader
;
355 /// The line number of the source file where the fault was generated.
359 /// The size in bytes of FileName.
363 /// A pointer to a NULL-terminated ASCII or Unicode string that represents the file
364 /// name of the source file where the fault was generated.
366 EFI_STATUS_CODE_STRING_DATA
*FileName
;
367 } EFI_DEBUG_ASSERT_DATA
;
370 /// System Context Data EBC/IA32/IPF
373 EFI_SYSTEM_CONTEXT_EBC SystemContextEbc
;
374 EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32
;
375 EFI_SYSTEM_CONTEXT_IPF SystemContextIpf
;
376 } EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT
;
379 /// This extended data allows the processor context that is present at the time of the exception to be
380 /// reported with the exception. The format and contents of the context data varies depending on the
381 /// processor architecture.
385 /// The data header identifying the data.
387 EFI_STATUS_CODE_DATA DataHeader
;
389 /// The system context.
391 EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context
;
392 } EFI_STATUS_CODE_EXCEP_EXTENDED_DATA
;
395 /// This extended data records information about a Start() function call. Start() is a member of
396 /// the EFI 1.10 Driver Binding Protocol.
400 /// The data header identifying the data.
402 EFI_STATUS_CODE_DATA DataHeader
;
404 /// The controller handle.
406 EFI_HANDLE ControllerHandle
;
408 /// The driver binding handle.
410 EFI_HANDLE DriverBindingHandle
;
412 /// The size of the RemainingDevicePath. It is zero if the Start() function is
413 /// called with RemainingDevicePath = NULL.
415 UINT16 DevicePathSize
;
417 /// Matches the RemainingDevicePath parameter being passed to the Start()
418 /// function. Note that this parameter is the variable-length device path and not a pointer
419 /// to the device path.
421 UINT8
*RemainingDevicePath
;
422 } EFI_STATUS_CODE_START_EXTENDED_DATA
;
425 /// Legacy Oprom extended data
426 /// The device handle and ROM image base can be used by consumers to determine which option
427 /// ROM failed. Due to the black-box nature of legacy option ROMs, the amount of information that
428 /// can be obtained may be limited.
432 /// The data header identifying the data.
434 EFI_STATUS_CODE_DATA DataHeader
;
436 /// The handle corresponding to the device that this legacy option ROM is being invoked.
438 EFI_HANDLE DeviceHandle
;
440 /// The base address of the shadowed legacy ROM image.
441 /// May or may not point to the shadow RAM area.
443 EFI_PHYSICAL_ADDRESS RomImageBase
;
444 } EFI_LEGACY_OPROM_EXTENDED_DATA
;
448 extern EFI_GUID gEfiStatusCodeSpecificDataGuid
;
451 // EFI_COMPUTING_UNIT_MISMATCH_ATTRIBUTES
452 // All other attributes are reserved for future use and
453 // must be initialized to 0.
455 #define EFI_COMPUTING_UNIT_MISMATCH_SPEED 0x0001
456 #define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED 0x0002
457 #define EFI_COMPUTING_UNIT_MISMATCH_FAMILY 0x0004
458 #define EFI_COMPUTING_UNIT_MISMATCH_MODEL 0x0008
459 #define EFI_COMPUTING_UNIT_MISMATCH_STEPPING 0x0010
460 #define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE 0x0020
461 #define EFI_COMPUTING_UNIT_MISMATCH_OEM1 0x1000
462 #define EFI_COMPUTING_UNIT_MISMATCH_OEM2 0x2000
463 #define EFI_COMPUTING_UNIT_MISMATCH_OEM3 0x4000
464 #define EFI_COMPUTING_UNIT_MISMATCH_OEM4 0x8000
469 // Memory Error Granularities
471 #define EFI_MEMORY_ERROR_OTHER 0x01
472 #define EFI_MEMORY_ERROR_UNKNOWN 0x02
473 #define EFI_MEMORY_ERROR_DEVICE 0x03
474 #define EFI_MEMORY_ERROR_PARTITION 0x04
477 // Memory Error Operations
479 #define EFI_MEMORY_OPERATION_OTHER 0x01
480 #define EFI_MEMORY_OPERATION_UNKNOWN 0x02
481 #define EFI_MEMORY_OPERATION_READ 0x03
482 #define EFI_MEMORY_OPERATION_WRITE 0x04
483 #define EFI_MEMORY_OPERATION_PARTIAL_WRITE 0x05
486 // Define shorthands to describe Group Operations
487 // Many memory init operations are essentially group
490 /// A shorthand to describe that the operation is performed
491 /// on multiple devices within the array
493 #define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe
495 /// A shorthand to describe that the operation is performed on all devices within the array
497 #define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff
499 /// A shorthand to describe that the operation is performed on multiple arrays
501 #define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe
503 /// A shorthand to describe that the operation is performed on all the arrays
505 #define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff