/** @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
+ Copyright (c) 2006 - 2018, 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
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
+ These GUIDs and structures are defined in UEFI Platform Initialization Specification 1.2\r
Volume 3: Shared Architectural Elements\r
\r
**/\r
///\r
EfiStringUnicode,\r
///\r
- /// An EFI_STATUS_CODE_STRING_TOKEN representing the string. The actual \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
///\r
/// Specifies the format of the data in EFI_STATUS_CODE_STRING_DATA.String.\r
///\r
///\r
EFI_STRING_ID Token;\r
} EFI_STATUS_CODE_STRING_TOKEN;\r
- \r
+\r
typedef union {\r
///\r
/// ASCII formatted string.\r
///\r
EFI_STATUS_CODE_STRING_TOKEN Hii;\r
} EFI_STATUS_CODE_STRING;\r
- \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
+/// 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
/// 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
+ 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
+ /// A pointer to the extended data. The data follows the format specified by\r
/// StringType.\r
///\r
EFI_STATUS_CODE_STRING String;\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
+/// 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
///\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
+ /// 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
/// This structure defines extended data describing a PCI resource allocation error.\r
///\r
-/// @par Note: \r
+/// @par Note:\r
/// The following structure contains variable-length fields and cannot be defined as a C-style\r
/// structure.\r
///\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
+ /// DevicePath.\r
///\r
UINT16 DevicePathSize;\r
///\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
+ /// 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
///\r
// UINT8 ReqRes[];\r
///\r
- /// The allocated resources in the format of an ACPI 2.0 resource descriptor. This \r
+ /// The allocated 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
// UINT8 AllocRes[];\r
/// This structure provides a calculation for base-10 representations.\r
///\r
/// Not consistent with PI 1.2 Specification.\r
-/// This data type is not defined in the PI 1.2 Specification, but is \r
+/// This data type is not defined in the PI 1.2 Specification, but is\r
/// required by several of the other data structures in this file.\r
///\r
typedef struct {\r
///\r
INT16 Value;\r
///\r
- /// The INT16 number by which to raise the base-2 calculation. \r
+ /// The INT16 number by which to raise the base-2 calculation.\r
///\r
INT16 Exponent;\r
} EFI_EXP_BASE10_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
+/// 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
/// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
/// sizeof (EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA) -\r
/// HeaderSize, and DataHeader.Type should be\r
- /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
///\r
/// This structure defines extended data for processor mismatch errors.\r
///\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
+/// 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
/// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
/// sizeof (EFI_ HOST_PROCESSOR_MISMATCH_ERROR_DATA) -\r
/// HeaderSize , and DataHeader.Type should be\r
- /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
/// The unit number of the computing unit that does not match.\r
- /// \r
+ ///\r
UINT32 Instance;\r
- /// \r
- /// The attributes describing the failure. \r
- /// \r
+ ///\r
+ /// The attributes describing the failure.\r
+ ///\r
UINT16 Attributes;\r
} EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA;\r
\r
///\r
/// This structure provides details about the computing unit thermal failure.\r
///\r
-/// This structure provides the temperature at the time of error. It also provides the threshold value \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
/// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
/// sizeof (EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA) -\r
/// HeaderSize , and DataHeader.Type should be\r
- /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
typedef UINT32 EFI_CPU_STATE_CHANGE_CAUSE;\r
\r
///\r
-/// The reasons that the processor is disabled. \r
+/// The reasons that the processor is disabled.\r
/// Used to fill in EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA.Cause.\r
///\r
///@{\r
///\r
/// This structure provides information about the disabled computing unit.\r
///\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
+/// 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
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
- /// The reason for disabling the processor. \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
+ /// 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
///@}\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
+/// 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
/// The data header identifying the data. DataHeader.HeaderSize should be\r
/// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
/// sizeof (EFI_MEMORY_EXTENDED_ERROR_DATA) - HeaderSize, and\r
- /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
///\r
EFI_MEMORY_ERROR_GRANULARITY Granularity;\r
///\r
- /// The operation that resulted in the error being detected. \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 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
+ /// 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
+ /// The physical address of the error.\r
///\r
EFI_PHYSICAL_ADDRESS Address;\r
///\r
\r
///\r
/// A definition to describe that the operation is performed on multiple devices within the array.\r
-/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r
+/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device.\r
///\r
#define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe\r
\r
///\r
/// A definition to describe that the operation is performed on all devices within the array.\r
-/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r
+/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device.\r
///\r
#define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff\r
\r
///\r
/// A definition to describe that the operation is performed on multiple arrays.\r
-/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r
+/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device.\r
///\r
#define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe\r
\r
///\r
/// A definition to describe that the operation is performed on all the arrays.\r
-/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. \r
+/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device.\r
///\r
#define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff\r
\r
///\r
-/// This extended data provides some context that consumers can use to locate a DIMM within the \r
-/// overall memory scheme. \r
+/// This extended data provides some context that consumers can use to locate a DIMM within the\r
+/// overall memory scheme.\r
///\r
/// This extended data provides some context that consumers can use to locate a DIMM within the\r
/// overall memory scheme. The Array and Device numbers may indicate a specific DIMM, or they\r
/// This structure defines extended data describing memory modules that do not match.\r
///\r
/// This extended data may be used to convey the specifics of memory modules that do not match.\r
-/// \r
+///\r
typedef struct {\r
///\r
/// The data header identifying the data. DataHeader.HeaderSize should be\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
- /// The instance number of the memory module that does not match. \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
/// This structure defines extended data describing a memory range.\r
///\r
-/// This extended data may be used to convey the specifics of a memory range. Ranges are specified \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
/// The data header identifying the data. DataHeader.HeaderSize should be\r
/// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
/// sizeof (EFI_MEMORY_RANGE_EXTENDED_DATA) - HeaderSize, and\r
- /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
- /// The starting address of the memory range. \r
+ /// The starting address of the memory range.\r
///\r
EFI_PHYSICAL_ADDRESS Start;\r
///\r
/// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
/// sizeof (EFI_DEBUG_ASSERT_DATA) - HeaderSize , and\r
/// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
- /// \r
+ ///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
/// The line number of the source file where the fault was generated.\r
///\r
UINT32 FileNameSize;\r
///\r
- /// A pointer to a NULL-terminated ASCII or Unicode string that represents \r
+ /// A pointer to a NULL-terminated ASCII or Unicode string that represents\r
/// the file name of the source file where the fault was generated.\r
///\r
EFI_STATUS_CODE_STRING_DATA *FileName;\r
/// EFI_SYSTEM_CONTEXT_X64 is defined in the\r
/// EFI_DEBUG_SUPPORT_PROTOCOL in the UEFI Specification.\r
///\r
- EFI_SYSTEM_CONTEXT_X64 SystemContextX64; \r
+ EFI_SYSTEM_CONTEXT_X64 SystemContextX64;\r
///\r
/// The context of the ARM processor when the exception was generated. Type\r
/// EFI_SYSTEM_CONTEXT_ARM is defined in the\r
/// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be\r
/// sizeof (EFI_STATUS_CODE_EXCEP_EXTENDED_DATA) - HeaderSize,\r
/// and DataHeader.Type should be\r
- /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
- /// The system context. \r
+ /// The system context.\r
///\r
EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context;\r
} EFI_STATUS_CODE_EXCEP_EXTENDED_DATA;\r
/// the UEFI Driver Binding Protocol.\r
///\r
typedef struct {\r
- /// \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_START_EXTENDED_DATA) - HeaderSize,\r
/// and DataHeader.Type should be\r
- /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
- /// The controller handle. \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
+ ///\r
+ /// The size of the RemainingDevicePath. It is zero if the Start() function is\r
/// called with RemainingDevicePath = NULL. The UEFI Specification allows\r
/// that the Start() function of bus drivers can be called in this way.\r
///\r
UINT16 DevicePathSize;\r
///\r
- /// Matches the RemainingDevicePath parameter being passed to the Start() function. \r
- /// Note that this parameter is the variable-length device path and not a pointer \r
+ /// Matches the RemainingDevicePath parameter being passed to the Start() function.\r
+ /// Note that this parameter is the variable-length device path and not a pointer\r
/// to the device path.\r
- /// \r
+ ///\r
// EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath;\r
} EFI_STATUS_CODE_START_EXTENDED_DATA;\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_LEGACY_OPROM_EXTENDED_DATA) - HeaderSize, and\r
- /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. \r
+ /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID.\r
///\r
EFI_STATUS_CODE_DATA DataHeader;\r
///\r
///\r
EFI_HANDLE DeviceHandle;\r
///\r
- /// The base address of the shadowed legacy ROM image. May or may not point to the shadow RAM area. \r
+ /// The base address of the shadowed legacy ROM image. May or may not point to the shadow RAM area.\r
///\r
EFI_PHYSICAL_ADDRESS RomImageBase;\r
} EFI_LEGACY_OPROM_EXTENDED_DATA;\r
projects / mirror_edk2.git / blobdiff