THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
- Module Name: StatusCodeDataTypeId.h\r
-\r
@par Revision Reference:\r
GUIDs defined in Status Codes Specification 0.92\r
\r
#ifndef __STATUS_CODE_DATA_TYPE_ID_GUID_H__\r
#define __STATUS_CODE_DATA_TYPE_ID_GUID_H__\r
\r
-#include <PiPei.h>\r
#include <Framework/StatusCode.h>\r
-#include <Framework/DataHubRecords.h>\r
#include <Protocol/DebugSupport.h>\r
+#include <Protocol/FrameworkHii.h>\r
\r
//////////////////////////////////////////////////////////////////////////////////////////\r
// String Data Type defintion. This is part of Status Code Specification\r
#pragma pack(1)\r
\r
typedef enum {\r
- EfiStringAscii,\r
- EfiStringUnicode,\r
- EfiStringToken\r
+ EfiStringAscii, ///< A NULL-terminated ASCII string.\r
+ EfiStringUnicode, ///< A double NULL-terminated Unicode string.\r
+ EfiStringToken ///< An EFI_STATUS_CODE_STRING_TOKEN representing the string. \r
+ ///< The actual string can be obtained by querying the HII Database.\r
} EFI_STRING_TYPE;\r
\r
typedef struct {\r
- EFI_HII_HANDLE Handle;\r
- STRING_REF Token;\r
+ FRAMEWORK_EFI_HII_HANDLE Handle; ///< The HII handle of the string pack, which can be\r
+ ///< used to retrieve the string. It is a dynamic value\r
+ ///< that may not be the same for different boots.\r
+ STRING_REF Token; ///< When combined with the HII handle, the string \r
+ ///< token can be used to retrieve the string.\r
+\r
} EFI_STATUS_CODE_STRING_TOKEN;\r
\r
typedef union {\r
- CHAR8 *Ascii;\r
- CHAR16 *Unicode;\r
- EFI_STATUS_CODE_STRING_TOKEN Hii;\r
+ CHAR8 *Ascii; ///< ASCII formatted string.\r
+ CHAR16 *Unicode; ///< Unicode formatted string.\r
+ EFI_STATUS_CODE_STRING_TOKEN Hii; ///< HII handle/token pair.\r
} EFI_STATUS_CODE_STRING;\r
\r
typedef struct {\r
- EFI_STATUS_CODE_DATA DataHeader;\r
- EFI_STRING_TYPE StringType;\r
- EFI_STATUS_CODE_STRING String;\r
+ EFI_STATUS_CODE_DATA DataHeader; ///< The data header identifying the data.\r
+ EFI_STRING_TYPE StringType; ///< Specifies if the string is ASCII or Unicode.\r
+ EFI_STATUS_CODE_STRING String; ///< A pointer to a null-terminated ASCII or Unicode string.\r
} EFI_STATUS_CODE_STRING_DATA;\r
#pragma pack()\r
\r
EFI_HANDLE Handle;\r
} EFI_DEVICE_HANDLE_EXTENDED_DATA;\r
\r
-\r
+///\r
+/// Extended data about the device path, which is used for many errors and \r
+/// progress codes to point to the device.\r
+///\r
typedef struct {\r
EFI_STATUS_CODE_DATA DataHeader;\r
UINT8 *DevicePath;\r
} EFI_DEVICE_PATH_EXTENDED_DATA;\r
\r
+///\r
+/// This structure defines extended data describing a PCI resource allocation error.\r
+///\r
typedef struct {\r
EFI_STATUS_CODE_DATA DataHeader;\r
UINT32 Bar;\r
} EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r
\r
///\r
-/// Voltage Extended Error Data\r
+/// This structure provides the voltage at the time of error. It also provides \r
+/// the threshold value indicating the minimum or maximum voltage that is considered \r
+/// an error. If the voltage is less then the threshold, the error indicates that the \r
+/// voltage fell below the minimum acceptable value. If the voltage is greater then the threshold, \r
+/// the error indicates that the voltage rose above the maximum acceptable value.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The voltage value at the time of the error.\r
+ ///\r
EFI_EXP_BASE10_DATA Voltage;\r
+ ///\r
+ /// The voltage threshold.\r
+ ///\r
EFI_EXP_BASE10_DATA Threshold;\r
} EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA;\r
\r
/// Microcode Update Extended Error Data\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The version of the microcode update from the header.\r
+ ///\r
UINT32 Version;\r
} EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA;\r
\r
///\r
/// Asynchronous Timer Extended Error Data\r
+/// The timer limit provides the timeout value of the timer prior to expiration.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The number of seconds that the computing unit timer was configured to expire.\r
+ ///\r
EFI_EXP_BASE10_DATA TimerLimit;\r
} EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA;\r
\r
///\r
/// Host Processor Mismatch Extended Error Data\r
+/// This provides information to indicate which processors mismatch, and how they mismatch. The \r
+/// status code contains the instance number of the processor that is in error. This structure's \r
+/// Instance indicates the second processor that does not match. This differentiation allows the \r
+/// consumer to determine which two processors do not match. The Attributes indicate what \r
+/// mismatch is being reported. Because Attributes is a bit field, more than one mismatch can be \r
+/// reported with one error code.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The unit number of the computing unit that does not match.\r
+ /// \r
UINT32 Instance;\r
+ /// \r
+ /// The attributes describing the failure. \r
+ /// \r
UINT16 Attributes;\r
} EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA;\r
\r
///\r
/// Thermal Extended Error Data\r
+/// This structure provides the temperature at the time of error. It also provides the threshold value \r
+/// indicating the minimum temperature that is considered an error.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The thermal value at the time of the error.\r
+ ///\r
EFI_EXP_BASE10_DATA Temperature;\r
+ ///\r
+ /// The thermal threshold.\r
+ ///\r
EFI_EXP_BASE10_DATA Threshold;\r
} EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA;\r
\r
-\r
+//\r
+// Valid cache types\r
+//\r
typedef enum {\r
EfiInitCacheDataOnly,\r
EfiInitCacheInstrOnly,\r
\r
///\r
/// Processor Disabled Extended Error Data\r
+/// This structure provides details as to why and how the computing unit was disabled. The causes \r
+/// should cover the typical reasons a processor would be disabled. How the processor was disabled is \r
+/// important because there are distinct differences between hardware and software disabling.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The reason for disabling the processor. \r
+ /// \r
UINT32 Cause;\r
+ ///\r
+ /// TRUE if the processor is disabled via software means such as not listing it in the ACPI tables. \r
+ /// Such a processor will respond to Interprocessor Interrupts (IPIs). FALSE if the processor is hardware \r
+ /// disabled, which means it is invisible to software and will not respond to IPIs.\r
+ ///\r
BOOLEAN SoftwareDisabled;\r
} EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA;\r
\r
///\r
typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY;\r
\r
+///\r
+/// This structure provides specific details about the memory error that was detected. It provides \r
+/// enough information so that consumers can identify the exact failure and provides enough \r
+/// information to enable corrective action if necessary.\r
+///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The error granularity type.\r
+ ///\r
EFI_MEMORY_ERROR_GRANULARITY Granularity;\r
+ ///\r
+ /// The operation that resulted in the error being detected. \r
+ ///\r
EFI_MEMORY_ERROR_OPERATION Operation;\r
+ ///\r
+ /// The error syndrome, vendor-specific ECC syndrome, or CRC data associated with \r
+ /// the error. If unknown, should be initialized to 0.\r
+ /// Inconsistent with specification here: \r
+ /// This field in StatusCodes spec0.9 is defined as UINT32, keep code unchanged.\r
+ ///\r
UINTN Syndrome;\r
+ ///\r
+ /// The physical address of the error. \r
+ ///\r
EFI_PHYSICAL_ADDRESS Address;\r
+ ///\r
+ /// The range, in bytes, within which the error address can be determined.\r
+ ///\r
UINTN Resolution;\r
} EFI_MEMORY_EXTENDED_ERROR_DATA;\r
\r
+///\r
+/// This extended data provides some context that consumers can use to locate a DIMM within the \r
+/// overall memory scheme. \r
+///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The memory array number.\r
+ ///\r
UINT16 Array;\r
+ ///\r
+ /// The device number within that Array.\r
+ ///\r
UINT16 Device;\r
} EFI_STATUS_CODE_DIMM_NUMBER;\r
\r
///\r
/// Memory Module Mismatch Extended Error Data\r
-///\r
+/// \r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data.\r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The instance number of the memory module that does not match. \r
+ ///\r
EFI_STATUS_CODE_DIMM_NUMBER Instance;\r
} EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA;\r
\r
///\r
/// Memory Range Extended Data\r
+/// This extended data may be used to convey the specifics of a memory range. Ranges are specified \r
+/// with a start address and a length.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The starting address of the memory range. \r
+ ///\r
EFI_PHYSICAL_ADDRESS Start;\r
+ ///\r
+ /// The length in bytes of the memory range.\r
+ ///\r
EFI_PHYSICAL_ADDRESS Length;\r
} EFI_MEMORY_RANGE_EXTENDED_DATA;\r
\r
///\r
/// Extended Error Data for Assert\r
+/// The data indicates the location of the assertion that failed in the source code. This information \r
+/// includes the file name and line number that are necessary to find the failing assertion in source code.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data.\r
+ /// \r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The line number of the source file where the fault was generated.\r
+ ///\r
UINT32 LineNumber;\r
+ ///\r
+ /// The size in bytes of FileName.\r
+ ///\r
UINT32 FileNameSize;\r
+ ///\r
+ /// A pointer to a NULL-terminated ASCII or Unicode string that represents the file \r
+ /// name of the source file where the fault was generated. \r
+ ///\r
EFI_STATUS_CODE_STRING_DATA *FileName;\r
} EFI_DEBUG_ASSERT_DATA;\r
\r
EFI_SYSTEM_CONTEXT_IPF SystemContextIpf;\r
} EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT;\r
\r
+///\r
+/// This extended data allows the processor context that is present at the time of the exception to be \r
+/// reported with the exception. The format and contents of the context data varies depending on the \r
+/// processor architecture. \r
+///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The system context. \r
+ ///\r
EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context;\r
} EFI_STATUS_CODE_EXCEP_EXTENDED_DATA;\r
\r
+///\r
+/// This extended data records information about a Start() function call. Start() is a member of \r
+/// the EFI 1.10 Driver Binding Protocol.\r
+///\r
typedef struct {\r
+ /// \r
+ /// The data header identifying the data. \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The controller handle. \r
+ ///\r
EFI_HANDLE ControllerHandle;\r
+ ///\r
+ /// The driver binding handle.\r
+ ///\r
EFI_HANDLE DriverBindingHandle;\r
+ /// \r
+ /// The size of the RemainingDevicePath. It is zero if the Start() function is \r
+ /// called with RemainingDevicePath = NULL. \r
+ ///\r
UINT16 DevicePathSize;\r
+ ///\r
+ /// Matches the RemainingDevicePath parameter being passed to the Start() \r
+ /// function. Note that this parameter is the variable-length device path and not a pointer \r
+ /// to the device path.\r
+ /// \r
UINT8 *RemainingDevicePath;\r
} EFI_STATUS_CODE_START_EXTENDED_DATA;\r
\r
///\r
/// Legacy Oprom extended data\r
+/// The device handle and ROM image base can be used by consumers to determine which option \r
+/// ROM failed. Due to the black-box nature of legacy option ROMs, the amount of information that \r
+/// can be obtained may be limited.\r
///\r
typedef struct {\r
+ ///\r
+ /// The data header identifying the data.\r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
+ ///\r
+ /// The handle corresponding to the device that this legacy option ROM is being invoked.\r
+ ///\r
EFI_HANDLE DeviceHandle;\r
+ ///\r
+ /// The base address of the shadowed legacy ROM image. \r
+ /// May or may not point to the shadow RAM area. \r
+ ///\r
EFI_PHYSICAL_ADDRESS RomImageBase;\r
} EFI_LEGACY_OPROM_EXTENDED_DATA;\r
\r
///\r
#define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff\r
\r
-\r
-\r
-\r
-//\r
-// Debug Assert Data. This is part of Status Code Specification\r
-//\r
-#define EFI_STATUS_CODE_DATA_TYPE_ASSERT_GUID \\r
- { 0xDA571595, 0x4D99, 0x487C, { 0x82, 0x7C, 0x26, 0x22, 0x67, 0x7D, 0x33, 0x07 } }\r
-\r
-\r
-extern EFI_GUID gEfiStatusCodeDataTypeAssertGuid;\r
-\r
-//\r
-// Exception Data type (CPU REGS)\r
-//\r
-#define EFI_STATUS_CODE_DATA_TYPE_EXCEPTION_HANDLER_GUID \\r
- { 0x3BC2BD12, 0xAD2E, 0x11D5, { 0x87, 0xDD, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xB9 } }\r
-\r
-extern EFI_GUID gEfiStatusCodeDataTypeExceptionHandlerGuid;\r
-\r
-//\r
-// Debug DataType defintions. User Defined Data Types.\r
-//\r
-#define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \\r
- { 0x9A4E9246, 0xD553, 0x11D5, { 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xb9 } }\r
-\r
-extern EFI_GUID gEfiStatusCodeDataTypeDebugGuid;\r
-\r
-//\r
-// Progress Code. User Defined Data Type Guid.\r
-//\r
-#define EFI_STATUS_CODE_DATA_TYPE_ERROR_GUID \\r
- { 0xAB359CE3, 0x99B3, 0xAE18, { 0xC8, 0x9D, 0x95, 0xD3, 0xB0, 0x72, 0xE1, 0x9B } }\r
-\r
-extern EFI_GUID gEfiStatusCodeDataTypeErrorGuid;\r
-\r
-//\r
-// Progress Code. User Defined Data Type Guid.\r
-//\r
-#define EFI_STATUS_CODE_DATA_TYPE_PROGRESS_CODE_GUID \\r
- { 0xA356AB39, 0x35C4, 0x35DA, { 0xB3, 0x7A, 0xF8, 0xEA, 0x9E, 0x8B, 0x36, 0xA3 } }\r
-\r
-extern EFI_GUID gEfiStatusCodeDataTypeProgressCodeGuid;\r
-\r
-\r
#endif\r
projects / mirror_edk2.git / blobdiff