Keep inconsistency in code and add additional comments for that.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Guid / StatusCodeDataTypeId.h

/** @file\r
  GUID used to identify id for the caller who is initiating the Status Code.\r
\r
  Copyright (c) 2006, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  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
**/\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
//////////////////////////////////////////////////////////////////////////////////////////\r
#define EFI_STATUS_CODE_DATA_TYPE_STRING_GUID \\r
  { 0x92D11080, 0x496F, 0x4D95, { 0xBE, 0x7E, 0x03, 0x74, 0x88, 0x38, 0x2B, 0x0A } }\r
\r
#pragma pack(1)\r
\r
typedef enum {\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
  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;   ///< 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; ///< 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
extern EFI_GUID gEfiStatusCodeDataTypeStringGuid;\r
\r
\r
//////////////////////////////////////////////////////////////////////////////////////////\r
// Special Data Type defintion. This is part of Status Code Specification\r
//////////////////////////////////////////////////////////////////////////////////////////\r
#define EFI_STATUS_CODE_SPECIFIC_DATA_GUID \\r
  { 0x335984bd, 0xe805, 0x409a, { 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 } }\r
\r
#pragma pack(1)\r
\r
///\r
/// Device handle Extended Data. Used for many\r
/// errors and progress codes to point to the device.\r
///\r
typedef struct {\r
  EFI_STATUS_CODE_DATA  DataHeader;\r
  EFI_HANDLE            Handle;\r
} EFI_DEVICE_HANDLE_EXTENDED_DATA;\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
  UINT16                             DevicePathSize;\r
  UINT16                             ReqResSize;\r
  UINT16                             AllocResSize;\r
  UINT8                              *DevicePath;\r
  UINT8                              *ReqRes;\r
  UINT8                              *AllocRes;\r
} EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r
\r
///\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
///\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
// Valid cache types\r
//\r
typedef enum {\r
  EfiInitCacheDataOnly,\r
  EfiInitCacheInstrOnly,\r
  EfiInitCacheBoth,\r
  EfiInitCacheUnspecified\r
} EFI_INIT_CACHE_TYPE;\r
\r
///\r
/// Embedded cache init extended data\r
///\r
typedef struct {\r
  EFI_STATUS_CODE_DATA  DataHeader;\r
  UINT32                Level;\r
  EFI_INIT_CACHE_TYPE   Type;\r
} EFI_CACHE_INIT_DATA;\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
/// Memory Error Operation Definition\r
///\r
typedef UINT8 EFI_MEMORY_ERROR_OPERATION;\r
\r
///\r
/// Memory Error Granularity Definition\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
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
///\r
/// System Context Data EBC/IA32/IPF\r
///\r
typedef union {\r
  EFI_SYSTEM_CONTEXT_EBC  SystemContextEbc;\r
  EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32;\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
#pragma pack()\r
\r
extern EFI_GUID gEfiStatusCodeSpecificDataGuid;\r
\r
//\r
// EFI_COMPUTING_UNIT_MISMATCH_ATTRIBUTES\r
// All other attributes are reserved for future use and\r
// must be initialized to 0.\r
//\r
#define EFI_COMPUTING_UNIT_MISMATCH_SPEED       0x0001\r
#define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED   0x0002\r
#define EFI_COMPUTING_UNIT_MISMATCH_FAMILY      0x0004\r
#define EFI_COMPUTING_UNIT_MISMATCH_MODEL       0x0008\r
#define EFI_COMPUTING_UNIT_MISMATCH_STEPPING    0x0010\r
#define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE  0x0020\r
#define EFI_COMPUTING_UNIT_MISMATCH_OEM1        0x1000\r
#define EFI_COMPUTING_UNIT_MISMATCH_OEM2        0x2000\r
#define EFI_COMPUTING_UNIT_MISMATCH_OEM3        0x4000\r
#define EFI_COMPUTING_UNIT_MISMATCH_OEM4        0x8000\r
\r
\r
\r
//\r
// Memory Error Granularities\r
//\r
#define EFI_MEMORY_ERROR_OTHER      0x01\r
#define EFI_MEMORY_ERROR_UNKNOWN    0x02\r
#define EFI_MEMORY_ERROR_DEVICE     0x03\r
#define EFI_MEMORY_ERROR_PARTITION  0x04\r
\r
//\r
// Memory Error Operations\r
//\r
#define EFI_MEMORY_OPERATION_OTHER          0x01\r
#define EFI_MEMORY_OPERATION_UNKNOWN        0x02\r
#define EFI_MEMORY_OPERATION_READ           0x03\r
#define EFI_MEMORY_OPERATION_WRITE          0x04\r
#define EFI_MEMORY_OPERATION_PARTIAL_WRITE  0x05\r
\r
//\r
// Define shorthands to describe Group Operations\r
// Many memory init operations are essentially group\r
// operations.\r
\r
/// A shorthand to describe that the operation is performed\r
/// on multiple devices within the array\r
///\r
#define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION  0xfffe\r
///\r
/// A shorthand to describe that the operation is performed on all devices within the array\r
///\r
#define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff\r
///\r
/// A shorthand to describe that the operation is performed on multiple arrays\r
///\r
#define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe\r
///\r
/// A shorthand to describe that the operation is performed on all the arrays\r
///\r
#define EFI_ALL_MEMORY_ARRAY_OPERATION  0xffff\r
\r
#endif\r