Update status code data structures according errata.

[mirror_edk2.git] / MdePkg / 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 - 2013, Intel Corporation. All rights reserved.<BR>\r
  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
  @par Revision Reference:\r
  These GUIDs and structures are defined in UEFI Platform Initialization Specification 1.2 \r
  Volume 3: Shared Architectural Elements\r
\r
**/\r
\r
#ifndef __PI_STATUS_CODE_DATA_TYPE_ID_GUID_H__\r
#define __PI_STATUS_CODE_DATA_TYPE_ID_GUID_H__\r
\r
#include <PiDxe.h>\r
#include <Protocol/DebugSupport.h>\r
\r
///\r
/// Global ID for the EFI_STATUS_CODE_STRING structure\r
///\r
#define EFI_STATUS_CODE_DATA_TYPE_STRING_GUID \\r
  { 0x92D11080, 0x496F, 0x4D95, { 0xBE, 0x7E, 0x03, 0x74, 0x88, 0x38, 0x2B, 0x0A } }\r
\r
typedef enum {\r
  ///\r
  /// A NULL-terminated ASCII string.\r
  ///\r
  EfiStringAscii,\r
  ///\r
  /// A double NULL-terminated Unicode string.\r
  ///\r
  EfiStringUnicode,\r
  ///\r
  /// An EFI_STATUS_CODE_STRING_TOKEN representing the string.  The actual \r
  /// string can be obtained by querying the HII Database\r
  ///\r
  EfiStringToken\r
} EFI_STRING_TYPE;\r
 \r
///\r
/// Specifies the format of the data in EFI_STATUS_CODE_STRING_DATA.String.\r
///\r
typedef struct {\r
  ///\r
  /// The HII package list which contains the string.  Handle is a dynamic value that may\r
  /// not be the same for different boots.  Type EFI_HII_HANDLE is defined in\r
  /// EFI_HII_DATABASE_PROTOCOL.NewPackageList() in the UEFI Specification.\r
  ///\r
  EFI_HII_HANDLE  Handle;\r
  ///\r
  /// When combined with Handle, the string token can be used to retrieve the string.\r
  /// Type EFI_STRING_ID is defined in EFI_IFR_OP_HEADER in the UEFI Specification.\r
  ///\r
  EFI_STRING_ID   Token;\r
} EFI_STATUS_CODE_STRING_TOKEN;\r
 \r
typedef union {\r
  ///\r
  /// ASCII formatted string.\r
  ///\r
  CHAR8                         *Ascii;\r
  ///\r
  /// Unicode formatted string.\r
  ///\r
  CHAR16                        *Unicode;\r
  ///\r
  /// HII handle/token pair.\r
  ///\r
  EFI_STATUS_CODE_STRING_TOKEN  Hii;\r
} EFI_STATUS_CODE_STRING;\r
 \r
///\r
/// This data type defines a string type of extended data. A string can accompany \r
/// any status code. The string can provide additional information about the \r
/// status code. The string can be ASCII, Unicode, or a Human Interface Infrastructure \r
/// (HII) token/GUID pair.\r
///\r
typedef struct {\r
  ///\r
  /// The data header identifying the data. DataHeader.HeaderSize should be\r
  /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
  /// sizeof (EFI_STATUS_CODE_STRING_DATA) - HeaderSize, and\r
  /// DataHeader.Type should be\r
  /// EFI_STATUS_CODE_DATA_TYPE_STRING_GUID.\r
  /// \r
  EFI_STATUS_CODE_DATA           DataHeader; \r
  ///\r
  /// Specifies the format of the data in String.\r
  ///\r
  EFI_STRING_TYPE                StringType;\r
  ///\r
  /// A pointer to the extended data. The data follows the format specified by \r
  /// StringType.\r
  ///\r
  EFI_STATUS_CODE_STRING         String;\r
} EFI_STATUS_CODE_STRING_DATA;\r
\r
extern EFI_GUID gEfiStatusCodeDataTypeStringGuid;\r
\r
///\r
/// Global ID for the following structures:\r
///   - EFI_DEVICE_PATH_EXTENDED_DATA\r
///   - EFI_DEVICE_HANDLE_EXTENDED_DATA\r
///   - EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA\r
///   - EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA\r
///   - EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA\r
///   - EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA\r
///   - EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA\r
///   - EFI_MEMORY_RANGE_EXTENDED_DATA\r
///   - EFI_DEBUG_ASSERT_DATA\r
///   - EFI_STATUS_CODE_EXCEP_EXTENDED_DATA\r
///   - EFI_STATUS_CODE_START_EXTENDED_DATA\r
///   - EFI_LEGACY_OPROM_EXTENDED_DATA\r
///\r
#define EFI_STATUS_CODE_SPECIFIC_DATA_GUID \\r
  { 0x335984bd, 0xe805, 0x409a, { 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 } }\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
/// The device path is used to point to the physical device in case there is more than one device\r
/// belonging to the same subclass. For example, the system may contain two USB keyboards and one\r
/// PS/2* keyboard. The driver that parses the status code can use the device path extended data to\r
/// differentiate between the three. The index field is not useful in this case because there is no standard\r
/// numbering convention. Device paths are preferred over using device handles because device handles\r
/// for a given device can change from one boot to another and do not mean anything beyond Boot\r
/// Services time. In certain cases, the bus driver may not create a device handle for a given device if it\r
/// detects a critical error. In these cases, the device path extended data can be used to refer to the\r
/// device, but there may not be any device handles with an instance of\r
/// EFI_DEVICE_PATH_PROTOCOL that matches DevicePath. The variable device path structure\r
/// is included in this structure to make it self sufficient.\r
///\r
typedef struct {\r
  ///\r
  /// The data header identifying the data. DataHeader.HeaderSize should be\r
  /// sizeof (EFI_STATUS_CODE_DATA). DataHeader.Size should be the size\r
  /// of variable-length DevicePath, and DataHeader.Size is zero for a virtual\r
  /// device that does not have a device path. DataHeader.Type should be\r
  /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
  ///\r
  EFI_STATUS_CODE_DATA                 DataHeader;\r
  ///\r
  /// The device path to the controller or the hardware device. Note that this parameter is a \r
  /// variable-length device path structure and not a pointer to such a structure. This structure is\r
  /// populated only if it is a physical device. For virtual devices, the Size field in DataHeader\r
  /// is set to zero and this field is not populated.\r
  ///\r
  //  EFI_DEVICE_PATH_PROTOCOL         DevicePath;\r
} EFI_DEVICE_PATH_EXTENDED_DATA;\r
\r
///\r
/// Device handle Extended Data. Used for many\r
/// errors and progress codes to point to the device.\r
///\r
/// The handle of the device with which the progress or error code is associated. The handle is\r
/// guaranteed to be accurate only at the time the status code is reported. Handles are dynamic entities\r
/// between boots, so handles cannot be considered to be valid if the system has reset subsequent to the\r
/// status code being reported. Handles may be used to determine a wide variety of useful information\r
/// about the source of the status code.\r
///\r
typedef struct {\r
  ///\r
  /// The data header identifying the data. DataHeader.HeaderSize should be\r
  /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
  /// sizeof (EFI_DEVICE_HANDLE_EXTENDED_DATA) - HeaderSize, and\r
  /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
  ///\r
  EFI_STATUS_CODE_DATA  DataHeader;\r
  ///\r
  /// The device handle.\r
  ///\r
  EFI_HANDLE            Handle;\r
} EFI_DEVICE_HANDLE_EXTENDED_DATA;\r
\r
///\r
/// This structure defines extended data describing a PCI resource allocation error.\r
///\r
/// @par Note: \r
///   The following structure contains variable-length fields and cannot be defined as a C-style\r
///   structure.\r
///\r
/// This extended data conveys details for a PCI resource allocation failure error. See the PCI\r
/// specification and the ACPI specification for details on PCI resource allocations and the format for\r
/// resource descriptors. This error does not detail why the resource allocation failed. It may be due to a\r
/// bad resource request or a lack of available resources to satisfy a valid request. The variable device\r
/// path structure and the resource structures are included in this structure to make it self sufficient.\r
///\r
typedef struct {\r
  ///\r
  /// The data header identifying the data. DataHeader.HeaderSize should be sizeof\r
  /// (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
  /// (DevicePathSize + DevicePathSize + DevicePathSize +\r
  /// sizeof(UINT32) + 3 * sizeof (UINT16) ), and DataHeader.Type\r
  /// should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
  ///\r
  EFI_STATUS_CODE_DATA               DataHeader;\r
  ///\r
  /// The PCI BAR. Applicable only for PCI devices. Ignored for all other devices.\r
  ///\r
  UINT32                             Bar;\r
  ///\r
  /// DevicePathSize should be zero if it is a virtual device that is not associated with\r
  /// a device path. Otherwise, this parameter is the length of the variable-length\r
  /// DevicePath. \r
  ///\r
  UINT16                             DevicePathSize;\r
  ///\r
  /// Represents the size the ReqRes parameter. ReqResSize should be zero if the\r
  /// requested resources are not provided as a part of extended data.\r
  ///\r
  UINT16                             ReqResSize;\r
  ///\r
  /// Represents the size the AllocRes parameter. AllocResSize should be zero if the\r
  /// allocated resources are not provided as a part of extended data.\r
  ///\r
  UINT16                             AllocResSize;\r
  ///\r
  /// The device path to the controller or the hardware device that did not get the requested \r
  /// resources. Note that this parameter is the variable-length device path structure and not \r
  /// a pointer to this structure. \r
  ///\r
  //  EFI_DEVICE_PATH_PROTOCOL       DevicePath;\r
  ///\r
  /// The requested resources in the format of an ACPI 2.0 resource descriptor. This\r
  /// parameter is not a pointer; it is the complete resource descriptor.\r
  ///\r