# 4. Some defintitions don't exactly match Framework specification, some new field members are introduced in EdkII\r
# to reflect the latest industry standard.\r
#\r
-# Note: \r
+# Note:\r
# The IntelFrameworkPkg contains Framework specification contents that were not adopted by UEFI/PI, and names may be\r
# changed (such as adding "FRAMEWORK_") to avoid name collisions with approved UEFI/PI specifications.\r
##\r
#pragma pack()\r
\r
Section "Alignment" in DataHubSubclass specification say "Fields in a data hub record should be aligned at their\r
- natural boundaries". But in EdkII, the data structures above are packed. \r
+ natural boundaries". But in EdkII, the data structures above are packed.\r
Keeping this inconsistency for backward compatibility.\r
- \r
+\r
3. Guid/DataHubRecords.h\r
#define EFI_SUBCLASS_INSTANCE_RESERVED 0\r
#define EFI_SUBCLASS_INSTANCE_NON_APPLICABLE 0xFFFF\r
\r
The field type of the definition is *NOT* consistent with CacheSubclass specification. Specification defines\r
them as UINT16, which is incorrect and should be UINT32 because the total width of bit-fields is 32bits width.\r
- \r
+\r
3. Guid/DataHubRecords.h\r
typedef enum {\r
CacheSizeRecordType = 1,\r
#define EFI_CACHE_MAXIMUM_SIZE_RECORD_NUMBER 0x00000002\r
#define EFI_CACHE_SPEED_RECORD_NUMBER 0x00000003\r
#define EFI_CACHE_SOCKET_RECORD_NUMBER 0x00000004\r
- #define EFI_CACHE_SRAM_SUPPORT_RECORD_NUMBER 0x00000005 \r
- #define EFI_CACHE_SRAM_INSTALL_RECORD_NUMBER 0x00000006 \r
+ #define EFI_CACHE_SRAM_SUPPORT_RECORD_NUMBER 0x00000005\r
+ #define EFI_CACHE_SRAM_INSTALL_RECORD_NUMBER 0x00000006\r
#define EFI_CACHE_ERROR_SUPPORT_RECORD_NUMBER 0x00000007\r
#define EFI_CACHE_TYPE_RECORD_NUMBER 0x00000008\r
#define EFI_CACHE_ASSOCIATIVITY_RECORD_NUMBER 0x00000009\r
EfiProcessorFamilyIntelCeleronD = 0xBA,\r
EfiProcessorFamilyIntelPentiumD = 0xBB,\r
EfiProcessorFamilyIntelPentiumEx = 0xBC,\r
- EfiProcessorFamilyIntelCoreSolo = 0xBD, \r
- EfiProcessorFamilyReserved = 0xBE, \r
+ EfiProcessorFamilyIntelCoreSolo = 0xBD,\r
+ EfiProcessorFamilyReserved = 0xBE,\r
EfiProcessorFamilyIntelCore2 = 0xBF,\r
...\r
EfiProcessorFamilyG6 = 0xCB,\r
} EFI_PROCESSOR_SOCKET_TYPE_DATA;\r
\r
The fields listed here are *NOT* defined in ProcSubclass specification 0.9. They are introduced to support\r
- new processor upgrade (type 4 offset 19h) defined in SmBios 2.6 specification. \r
+ new processor upgrade (type 4 offset 19h) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
5. Guid/DataHubRecords.h\r
typedef enum {\r
EfiProcessorHealthy = 1,\r
EfiProcessorPerfRestricted = 2,\r
- EfiProcessorFuncRestricted = 3 \r
+ EfiProcessorFuncRestricted = 3\r
} EFI_PROCESSOR_HEALTH_STATUS;\r
\r
The structure name "EFI_PROCESSOR_HEALTH_STATUS" is *NOT* consistent with ProcSubclass specification 0.9, in which\r
ProcessorPartNumberRecordType = 30,\r
} EFI_CPU_VARIABLE_RECORD_TYPE;\r
\r
- The enumeration fields from ProcessorCoreFrequencyRecordType to ProcessorHealthStatusRecordType are *NOT* defined \r
+ The enumeration fields from ProcessorCoreFrequencyRecordType to ProcessorHealthStatusRecordType are *NOT* defined\r
in ProcSubclass specification 0.9, which only defines the following macros to specify the record number of the data record:\r
#define EFI_PROCESSOR_FREQUENCY_RECORD_NUMBER 0x00000001\r
#define EFI_PROCESSOR_BUS_FREQUENCY_RECORD_NUMBER 0x00000002\r
#define EFI_PROCESSOR_HEALTH_STATUS_RECORD_NUMBER 0x00000018\r
Keeping this inconsistency for backward compatibility.\r
\r
- The enumeration fields from ProcessorCoreCountRecordType to ProcessorPartNumberRecordType are *NOT* defined \r
- in ProcSubclass specification 0.9. \r
+ The enumeration fields from ProcessorCoreCountRecordType to ProcessorPartNumberRecordType are *NOT* defined\r
+ in ProcSubclass specification 0.9.\r
They are introduced to support new fields for type 4 defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
...\r
EFI_PROCESSOR_FAMILY2_DATA ProcessorFamily2;\r
} EFI_CPU_VARIABLE_RECORD;\r
- \r
+\r
typedef struct {\r
EFI_SUBCLASS_TYPE1_HEADER DataRecordHeader;\r
EFI_CPU_VARIABLE_RECORD VariableRecord;\r
} EFI_PROCESSOR_CHARACTERISTICS_DATA;\r
\r
The fields listed here are *NOT* defined in ProcSubclass specification 0.9. They are introduced to support\r
- new fields for type 4 defined in SmBios 2.6 specification. \r
+ new fields for type 4 defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
##\r
...\r
EfiMemoryFormFactorFbDimm = 0x0F\r
} EFI_MEMORY_FORM_FACTOR;\r
- \r
+\r
typedef enum _EFI_MEMORY_ARRAY_TYPE {\r
...\r
EfiMemoryTypeDdr2 = 0x13,\r
EfiMemoryTypeDdr2FbDimm = 0x14\r
} EFI_MEMORY_ARRAY_TYPE;\r
- \r
+\r
typedef enum {\r
...\r
EfiMemoryStatePartial = 6\r
} EFI_MEMORY_STATE;\r
\r
The fields listed above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support\r
- new memory device (type 17) defined in SmBios 2.6 specification. \r
+ new memory device (type 17) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
2. Guid/DataHubRecords.h\r
- typedef struct { \r
+ typedef struct {\r
...\r
- EFI_EXP_BASE10_DATA MemorySpeed; \r
+ EFI_EXP_BASE10_DATA MemorySpeed;\r
...\r
} EFI_MEMORY_ARRAY_LINK_DATA;\r
\r
3. Guid/DataHubRecords.h\r
#define EFI_MEMORY_CONTROLLER_INFORMATION_RECORD_NUMBER 0x00000008\r
\r
- typedef enum { \r
+ typedef enum {\r
EfiErrorDetectingMethodOther = 1,\r
EfiErrorDetectingMethodUnknown = 2,\r
EfiErrorDetectingMethodNone = 3,\r
UINT8 Reserved :2;\r
} EFI_MEMORY_ERROR_CORRECT_CAPABILITY;\r
\r
- typedef enum { \r
+ typedef enum {\r
EfiMemoryInterleaveOther = 1,\r
EfiMemoryInterleaveUnknown = 2,\r
EfiMemoryInterleaveOneWay = 3,\r
} EFI_MEMORY_CONTROLLER_INFORMATION_DATA;\r
\r
The definitions above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support\r
- new memory controller information (type 5) defined in SmBios 2.6 specification. \r
+ new memory controller information (type 5) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
4. Guid/DataHubRecords.h\r
#define EFI_MEMORY_32BIT_ERROR_INFORMATION_RECORD_NUMBER 0x00000009\r
\r
- typedef enum { \r
+ typedef enum {\r
EfiMemoryErrorOther = 1,\r
EfiMemoryErrorUnknown = 2,\r
EfiMemoryErrorOk = 3,\r
EfiMemoryErrorUnCorrectable = 14\r
} EFI_MEMORY_ERROR_TYPE;\r
\r
- typedef enum { \r
+ typedef enum {\r
EfiMemoryGranularityOther = 1,\r
EfiMemoryGranularityOtherUnknown = 2,\r
EfiMemoryGranularityDeviceLevel = 3,\r
EfiMemoryGranularityMemPartitionLevel = 4\r
} EFI_MEMORY_ERROR_GRANULARITY_TYPE;\r
\r
- typedef enum { \r
+ typedef enum {\r
EfiMemoryErrorOperationOther = 1,\r
EfiMemoryErrorOperationUnknown = 2,\r
EfiMemoryErrorOperationRead = 3,\r
} EFI_MEMORY_32BIT_ERROR_INFORMATION;\r
\r
The definitions above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support\r
- new 32-bit memory error information (type 18) defined in SmBios 2.6 specification. \r
+ new 32-bit memory error information (type 18) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
5. Guid/DataHubRecords.h\r
#define EFI_MEMORY_64BIT_ERROR_INFORMATION_RECORD_NUMBER 0x0000000A\r
- \r
+\r
typedef struct {\r
EFI_MEMORY_ERROR_TYPE MemoryErrorType;\r
EFI_MEMORY_ERROR_GRANULARITY_TYPE MemoryErrorGranularity;\r
} EFI_MEMORY_64BIT_ERROR_INFORMATION;\r
\r
The definitions above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support\r
- new 64-bit memory error information (type 33) defined in SmBios 2.6 specification. \r
+ new 64-bit memory error information (type 33) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
6. Guid/DataHubRecords.h\r
PCI_DEVICE_PATH PciBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} USB_PORT_DEVICE_PATH;\r
- \r
+\r
typedef struct _IDE_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH PciBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} IDE_DEVICE_PATH;\r
- \r
+\r
typedef struct _RMC_CONN_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH PciBridgeDevicePath;\r
PCI_DEVICE_PATH PciBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} RMC_CONN_DEVICE_PATH;\r
- \r
+\r
typedef struct _RIDE_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH PciBridgeDevicePath;\r
PCI_DEVICE_PATH PciBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} RIDE_DEVICE_PATH;\r
- \r
+\r
typedef struct _GB_NIC_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH PciBridgeDevicePath;\r
PCI_DEVICE_PATH PciXBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} GB_NIC_DEVICE_PATH;\r
- \r
+\r
typedef struct _PS2_CONN_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH LpcBridgeDevicePath;\r
ACPI_HID_DEVICE_PATH LpcBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} PS2_CONN_DEVICE_PATH;\r
- \r
+\r
typedef struct _SERIAL_CONN_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH LpcBridgeDevicePath;\r
ACPI_HID_DEVICE_PATH LpcBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} SERIAL_CONN_DEVICE_PATH;\r
- \r
+\r
typedef struct _PARALLEL_CONN_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH LpcBridgeDevicePath;\r
ACPI_HID_DEVICE_PATH LpcBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} PARALLEL_CONN_DEVICE_PATH;\r
- \r
+\r
typedef struct _FLOOPY_CONN_DEVICE_PATH {\r
ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;\r
PCI_DEVICE_PATH LpcBridgeDevicePath;\r
ACPI_HID_DEVICE_PATH LpcBusDevicePath;\r
EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} FLOOPY_CONN_DEVICE_PATH;\r
- \r
+\r
typedef union _EFI_MISC_PORT_DEVICE_PATH {\r
USB_PORT_DEVICE_PATH UsbDevicePath;\r
IDE_DEVICE_PATH IdeDevicePath;\r
} EFI_MISC_BIOS_VENDOR_DATA;\r
\r
The fields listed above are *NOT* defined in MiscSubclass specification 0.9. They are introduced to support\r
- new bios information (type 0) defined in SmBios 2.6 specification. \r
+ new bios information (type 0) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
4. Guid/DataHubRecords.h\r
} EFI_MISC_SYSTEM_MANUFACTURER_DATA;\r
\r
The fields listed above are *NOT* defined in MiscSubclass specification 0.9. They are introduced to support\r
- new system information (type 1) defined in SmBios 2.6 specification. \r
+ new system information (type 1) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
5. Guid/DataHubRecords.h\r
} EFI_MISC_MANAGEMENT_DEVICE_COMPONENT_DESCRIPTION_DATA;\r
\r
a. The field "ManagementDeviceThresholdLink" above is *NOT* defined in MiscSubclass specification 0.9. It is introduced to support\r
- new management device component (type 35) defined in SmBios 2.6 specification. \r
+ new management device component (type 35) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
b. The field "ComponentType" above is *NOT* defined in MiscSubclass specifications 0.9. It's implementation-specific to simplify the code logic.\r
Keeping this inconsistency for backward compatibility.\r
...\r
} EFI_MISC_ONBOARD_DEVICE_DATA;\r
\r
- The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the field "OnBoardDeviceStatus" is \r
+ The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the field "OnBoardDeviceStatus" is\r
named as "OnBoardDeviceType". Keeping this inconsistency for backward compatibility.\r
\r
9. Guid/DataHubRecords.h\r
"EFI_MISC_BATTERY_LOCATION_RECORD_NUMBER". Keeping this inconsistency for backward compatibility.\r
\r
10. Guid/DataHubRecords.h\r
- typedef enum { \r
+ typedef enum {\r
EfiPortableBatteryDeviceChemistryOther = 1,\r
EfiPortableBatteryDeviceChemistryUnknown = 2,\r
EfiPortableBatteryDeviceChemistryLeadAcid = 3,\r
} EFI_MISC_PORTABLE_BATTERY_DEVICE_CHEMISTRY;\r
\r
The name of the definition is *NOT* consistent with MiscSubclass specification, in which it is defined as\r
- "EFI_MISC_BATTERY_DEVICE_CHEMISTRY". And all field names have a redundant "Portable" string compared with MisSubclass \r
+ "EFI_MISC_BATTERY_DEVICE_CHEMISTRY". And all field names have a redundant "Portable" string compared with MisSubclass\r
specification 0.9.\r
Keeping this inconsistency for backward compatibility.\r
\r
} EFI_MISC_PORTABLE_BATTERY;\r
\r
The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the structure name is defined as\r
- "EFI_MISC_BATTERY_LOCATION_DATA". Moreover, the name and the order of all fields are also different with MiscSubclass \r
+ "EFI_MISC_BATTERY_LOCATION_DATA". Moreover, the name and the order of all fields are also different with MiscSubclass\r
specification 0.9. Keeping this inconsistency for backward compatibility.\r
\r
12. Guid/DataHubRecords.h\r
...\r
} EFI_MISC_BOOT_INFORMATION_STATUS_DATA;\r
\r
- The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the type of the first field is \r
+ The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the type of the first field is\r
"EFI_MISC_BOOT_INFORMATION_STATUS_TYPE". Keeping this inconsistency for backward compatibility.\r
\r
14. Guid/DataHubRecords.h\r
...\r
} EFI_MISC_SMBIOS_STRUCT_ENCAPSULATION_DATA;\r
\r
- The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the type of the first field is \r
+ The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the type of the first field is\r
"EFI_SMBIOS_STRUCTURE_HDR". Keeping this inconsistency for backward compatibility.\r
\r
17. Guid/DataHubRecords.h\r
#define ACCESS_GPNV 0x04\r
\r
The definitions listed above are *NOT* defined in MiscSubclass specification 0.9. It is introduced to support\r
- new system event log (type 15) defined in SmBios 2.6 specification. \r
+ new system event log (type 15) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
19. Guid/DataHubRecords.h\r
} EFI_MISC_MANAGEMENT_DEVICE_THRESHOLD;\r
\r
The definitions listed above are *NOT* defined in MiscSubclass specification 0.9. It is introduced to support\r
- new management device threshold data (type 36) defined in SmBios 2.6 specification. \r
+ new management device threshold data (type 36) defined in SmBios 2.6 specification.\r
Keeping this inconsistency to reflect the latest industry standard.\r
\r
20. Guid/DataHubRecords.h\r
UINT32 CoolingDeviceOemDefined;\r
} EFI_MISC_COOLING_DEVICE_TEMP_LINK_DATA;\r
\r
- The "CoolingDeviceUnitGroup" field and "CoolingDeviceNominalSpeed" field are *NOT* consistent with \r
+ The "CoolingDeviceUnitGroup" field and "CoolingDeviceNominalSpeed" field are *NOT* consistent with\r
MiscSubclass specification 0.9. These fields are aligned with SMBIOS 2.6 specification. And user can easily\r
assign any value to CoolingDeviceNominalSpeed.\r
\r
#define EFI_SW_EC_X64_SIMD EXCEPT_X64_SIMD\r
\r
The definitions are *NOT* defined in Framework StatusCodes specification 0.92, in which IA32 and IPF exception subclass error code definitions\r
- are defined but omit the corresponding definitions for X64. EdkII introduce these definitions for implementation. \r
+ are defined but omit the corresponding definitions for X64. EdkII introduce these definitions for implementation.\r
\r
##\r
# Mismatch with Intel Platform Innovation Framework for EFI Boot Script Specification (Version 0.91)\r
Keeping this inconsistency for backward compatibility.\r
\r
5. Include/Protocol/BootScriptSave.h\r
- typedef \r
- EFI_STATUS \r
+ typedef\r
+ EFI_STATUS\r
(EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (\r
IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This,\r
...\r
##\r
1. Include/Framework/DxeCis.h\r
EFI_STATUS_CODE_ARCH_PROTOCOL is removed.\r
- \r
+\r
EdkII doesn't provide EFI_STATUS_CODE_ARCH_PROTOCOL definition due to ReportStatusCode() field has been\r
removed from EFI Runtime Service Table of PI specification. EFI_STATUS_CODE_ARCH_PROTOCOL is *NOT* required,\r
and is replaced with EFI_STATUS_CODE_RUNTIME_PROTOCOL.\r
}\r
\r
The Framework HII specification 0.92 changed part of HII interfaces but did not update the protocol GUID.\r
- This change should cause a change of GUID in both of code and HII spec. EdkII updates the GUID in code, \r
+ This change should cause a change of GUID in both of code and HII spec. EdkII updates the GUID in code,\r
but the Framework HII specification 0.92 is not updated. This is a known issue.\r
\r
2. Include/Protocol/FrameworkHii.h\r
...\r
};\r
\r
- The field listed above is *NOT* defined in Framework HII specification 0.92. EdkII adds this field to provide \r
- an ability of removing any new strings that were added after the initial string export for this handle. \r
+ The field listed above is *NOT* defined in Framework HII specification 0.92. EdkII adds this field to provide\r
+ an ability of removing any new strings that were added after the initial string export for this handle.\r
\r
5. Include/Protocol/FrameworkHii.h\r
typedef\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
UINT8 Flags;\r
} EFI_IFR_SUPPRESS;\r
- \r
+\r
typedef struct {\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
UINT8 Flags;\r
} EFI_IFR_GRAY_OUT;\r
- \r
+\r
typedef struct {\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
STRING_REF Popup;\r
UINT8 Flags;\r
} EFI_IFR_INCONSISTENT;\r
- \r
+\r
typedef struct {\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
UINT16 QuestionId;\r
UINT8 Width;\r
UINT16 Value;\r
} FRAMEWORK_EFI_IFR_EQ_ID_VAL;\r
- \r
+\r
typedef struct {\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
UINT16 QuestionId;\r
UINT16 ListLength;\r
UINT16 ValueList[1];\r
} FRAMEWORK_EFI_IFR_EQ_ID_LIST;\r
- \r
+\r
typedef struct {\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
UINT16 QuestionId1;\r
UINT8 Width;\r
UINT16 QuestionId2;\r
} FRAMEWORK_EFI_IFR_EQ_ID_ID;\r
- \r
+\r
typedef struct {\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
UINT16 VariableId;\r
The defintions are not complied with Framework HII spec 0.92. Keeping the inconsistent for implementation needed.\r
\r
7. Include/Protocol/FrameworkFormCallback.h\r
- #define RESET_REQUIRED 1 \r
+ #define RESET_REQUIRED 1\r
#define EXIT_REQUIRED 2\r
#define SAVE_REQUIRED 4\r
#define NV_CHANGED 8\r
...\r
} EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;\r
\r
- 1) The name of the definition is *NOT* consistent with Framework SmmCis specification 0.91, in which it's \r
- defined as "EFI_HOB_SMRAM_DESCRIPTOR_BLOCK" rather than "EFI_SMRAM_HOB_DESCRIPTOR_BLOCK". \r
+ 1) The name of the definition is *NOT* consistent with Framework SmmCis specification 0.91, in which it's\r
+ defined as "EFI_HOB_SMRAM_DESCRIPTOR_BLOCK" rather than "EFI_SMRAM_HOB_DESCRIPTOR_BLOCK".\r
Keeping this inconsistency for backward compatibility.\r
\r
2) The definition of NumberOfSmmReservedRegions is *NOT* consistent with Framework SmmCis specification 0.91,\r
3. Include/Framework/SmmCis.h\r
typedef union {\r
///\r
- /// The processor save-state information for IA-32 processors. \r
+ /// The processor save-state information for IA-32 processors.\r
///\r
EFI_SMI_CPU_SAVE_STATE Ia32SaveState;\r
///\r
EFI_STATUS\r
(EFIAPI *EFI_ACPI_S3_SAVE) (\r
IN EFI_ACPI_S3_SAVE_PROTOCOL *This,\r
- IN VOID *LegacyMemoryAddress \r
+ IN VOID *LegacyMemoryAddress\r
);\r
\r
The first parameter's type is *NOT* consistent with Framework S3Resume specification, in which it's defined as\r
/** @file\r
- This file contains the boot script defintions that are shared between the \r
+ This file contains the boot script defintions that are shared between the\r
Boot Script Executor PPI and the Boot Script Save Protocol.\r
\r
-Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
\r
#include <PiDxe.h>\r
///\r
-/// The framework implementation defines follow opcode that are different from the PI specification: \r
+/// The framework implementation defines follow opcode that are different from the PI specification:\r
/// Add FRAMEWORK_ prefix to avoid naming conflict.\r
///\r
/// S3 Boot Script Table identifier.\r
///\r
#define FRAMEWORK_EFI_ACPI_S3_RESUME_SCRIPT_TABLE 0x00\r
///\r
-/// The opcode is used to add a record for memory reads of the memory location and continues when the \r
+/// The opcode is used to add a record for memory reads of the memory location and continues when the\r
/// exit criteria is satisfied, or after a defined duration.\r
///\r
#define FRAMEWORK_EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x09\r
Include file for definitions in the Intel Platform Innovation Framework for EFI\r
Driver Execution Environment Core Interface Specification (DXE CIS) Version 0.91.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
\r
/**\r
Functions of this type are used with the Framework MP Services Protocol and\r
- the SMM Services Table to execute a procedure on enabled APs. The context \r
+ the SMM Services Table to execute a procedure on enabled APs. The context\r
the AP should use durng execution is specified by Buffer.\r
- \r
+\r
@param[in] Buffer The pointer to the procedure's argument.\r
\r
**/\r
all firmware volumes that are either memory mapped or have an\r
associated FirmwareVolumeBlock protocol.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
images loaded via the FirmwareVolume protocol. The Firmware Volume specification\r
is the basis for these definitions.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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 definitions are from the Firmware Volume Spec 0.9.\r
Framework IFR is primarily consumed by the EFI presentation engine, and produced by EFI\r
internal application and drivers as well as all add-in card option-ROM drivers\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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 definitions are from the Framework Specification HII 0.92.\r
\r
//\r
// There is an interesting twist with regards to Time and Date. This is one of the few items which can accept input\r
-// from a user, and may or may not need to use storage in the NVRAM space. The decided method for determining \r
-// if NVRAM space will be used (only for a TimeOp or DateOp) is: If .QuestionId == 0 && .Width == 0 (normally an \r
+// from a user, and may or may not need to use storage in the NVRAM space. The decided method for determining\r
+// if NVRAM space will be used (only for a TimeOp or DateOp) is: If .QuestionId == 0 && .Width == 0 (normally an\r
// impossibility) then use system resources to store the data away and not NV resources. In other words, the setup\r
// engine will call gRT->SetTime, and gRT->SetDate for the saving of data, and the values displayed will be from the\r
// gRT->GetXXXX series of calls.\r
typedef struct {\r
FRAMEWORK_EFI_IFR_OP_HEADER Header;\r
UINT16 QuestionId; ///< The ID designating what the question is about...\r
- UINT8 Width; ///< The Size of the Data being saved. \r
+ UINT8 Width; ///< The Size of the Data being saved.\r
STRING_REF Prompt; ///< The String Token for the Prompt.\r
STRING_REF Help; ///< The string Token for the context-help.\r
UINT8 Flags; ///< This is included solely for purposes of interactive/dynamic support.\r
\r
///\r
/// Inconsistent with specification here:\r
-/// The following defintion may not comply with Framework Specification HII 0.92. To \r
+/// The following defintion may not comply with Framework Specification HII 0.92. To\r
/// keep the inconsistant is for implementation needed.\r
///@{\r
typedef struct {\r
/** @file\r
This file defines the data structures per HOB specification v0.9.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
///\r
/// Capsule volume HOB -- identical to a firmware volume.\r
/// This macro is defined to comply with the hob Framework Spec. And the marco was\r
-/// retired in the PI1.0 specification. \r
+/// retired in the PI1.0 specification.\r
///\r
#define EFI_HOB_TYPE_CV 0x0008\r
\r
The Include file for definitions in the Intel Platform Innovation Framework for EFI\r
Pre-EFI Initialization Core Interface Specification (PEI CIS) Version 0.91.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
\r
typedef struct _FRAMEWORK_EFI_PEI_SERVICES FRAMEWORK_EFI_PEI_SERVICES;\r
\r
/**\r
- The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI \r
- Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r
+ The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI\r
+ Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.\r
\r
@param FfsHeader The pointer to the FFS file header.\r
@param PeiServices Describes the list of possible PEI Services.\r
IN EFI_FFS_FILE_HEADER *FfsHeader,\r
IN EFI_PEI_SERVICES **PeiServices\r
);\r
- \r
+\r
/**\r
- This service abstracts the capability of the PEI \r
- Foundation to discover instances of firmware volumes in the system. \r
- Given the input file pointer, this service searches for the next \r
+ This service abstracts the capability of the PEI\r
+ Foundation to discover instances of firmware volumes in the system.\r
+ Given the input file pointer, this service searches for the next\r
matching file in the Firmware File System (FFS) volume.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
IN UINTN Instance,\r
IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader\r
);\r
- \r
+\r
/**\r
- This service abstracts the capability of the PEI \r
- Foundation to discover instances of firmware files in the system. \r
- Given the input file pointer, this service searches for the next matching \r
+ This service abstracts the capability of the PEI\r
+ Foundation to discover instances of firmware files in the system.\r
+ Given the input file pointer, this service searches for the next matching\r
file in the Firmware File System (FFS) volume.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param SearchType A filter to find files only of this type.\r
- @param FwVolHeader The pointer to the firmware volume header of the volume to search. This parameter \r
+ @param FwVolHeader The pointer to the firmware volume header of the volume to search. This parameter\r
must point to a valid FFS volume.\r
- @param FileHeader The pointer to the current file from which to begin searching. Upon return this pointer will be \r
+ @param FileHeader The pointer to the current file from which to begin searching. Upon return this pointer will be\r
updated to reflect the file found.\r
\r
@retval EFI_SUCCESS The file was found.\r
);\r
\r
/**\r
- Given the input file pointer, this service searches for the next \r
- matching file in the Firmware File System (FFS) volume. \r
+ Given the input file pointer, this service searches for the next\r
+ matching file in the Firmware File System (FFS) volume.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param SectionType The value of the section type to find.\r
\r
///\r
/// FRAMEWORK_EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r
-/// Foundation. The table may be located in the temporary or permanent memory, depending upon the capabilities \r
+/// Foundation. The table may be located in the temporary or permanent memory, depending upon the capabilities\r
/// and phase of execution of PEI.\r
-/// \r
+///\r
/// These services fall into various classes, including the following:\r
/// - Managing the boot mode.\r
/// - Allocating both early and permanent memory.\r
/// - Supporting the Firmware File System (FFS).\r
/// - Abstracting the PPI database abstraction.\r
/// - Creating Hand-Off Blocks (HOBs).\r
-/// \r
+///\r
struct _FRAMEWORK_EFI_PEI_SERVICES {\r
EFI_TABLE_HEADER Hdr;\r
//\r
//\r
EFI_PEI_RESET_SYSTEM ResetSystem;\r
///\r
- /// Inconsistent with specification here: \r
- /// In Framework Spec, PeiCis0.91, CpuIo and PciCfg are NOT pointers. \r
+ /// Inconsistent with specification here:\r
+ /// In Framework Spec, PeiCis0.91, CpuIo and PciCfg are NOT pointers.\r
///\r
- \r
+\r
//\r
// I/O Abstractions\r
//\r
///\r
typedef enum {\r
///\r
- /// Used to induce a system-wide reset. This sets all circuitry within the \r
+ /// Used to induce a system-wide reset. This sets all circuitry within the\r
/// system to its initial state. This type of reset is asynchronous to system\r
- /// operation and operates withgout regard to cycle boundaries. EfiColdReset \r
+ /// operation and operates withgout regard to cycle boundaries. EfiColdReset\r
/// is tantamount to a system power cycle.\r
///\r
EfiPeiResetCold,\r
///\r
/// Used to induce a system-wide initialization. The processors are set to their\r
- /// initial state, and pending cycles are not corrupted. If the system does \r
+ /// initial state, and pending cycles are not corrupted. If the system does\r
/// not support this reset type, then an EfiResetCold must be performed.\r
///\r
EfiPeiResetWarm,\r
} EFI_PEI_RESET_TYPE;\r
\r
-#endif \r
+#endif\r
\r
Include file for definitions in the Intel Platform Innovation Framework for EFI\r
System Management Mode Core Interface Specification (SMM CIS) version 0.91.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
Allocates pool memory from SMRAM for IA-32, or runtime memory for\r
the Itanium processor family.\r
\r
- @param PoolType The type of pool to allocate. The only supported type \r
+ @param PoolType The type of pool to allocate. The only supported type\r
is EfiRuntimeServicesData.\r
@param Size The number of bytes to allocate from the pool.\r
- @param Buffer A pointer to a pointer to the allocated buffer if the \r
+ @param Buffer A pointer to a pointer to the allocated buffer if the\r
call succeeds. Otherwise, undefined.\r
\r
@retval EFI_SUCCESS The requested number of bytes was allocated.\r
@retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r
@retval EFI_UNSUPPORTED In runtime.\r
@note Inconsistent with specification here:\r
- In Framework Spec, this definition is named EFI_SMM_ALLOCATE_POOL. \r
+ In Framework Spec, this definition is named EFI_SMM_ALLOCATE_POOL.\r
To avoid a naming conflict, the definition is renamed.\r
**/\r
typedef\r
@retval EFI_INVALID_PARAMETER Buffer was invalid.\r
@retval EFI_UNSUPPORTED In runtime.\r
@note Inconsistent with specification here:\r
- In Framework Spec, this definition is named EFI_SMM_FREE_POOL. \r
- To avoid a naming conflict, the definition is renamed. \r
+ In Framework Spec, this definition is named EFI_SMM_FREE_POOL.\r
+ To avoid a naming conflict, the definition is renamed.\r
**/\r
typedef\r
EFI_STATUS\r
@retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
or AllocateAddress. Or, MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
@note Inconsistent with specification here:\r
- In the Framework Spec, this definition is named EFI_SMM_ALLOCATE_PAGES. \r
+ In the Framework Spec, this definition is named EFI_SMM_ALLOCATE_PAGES.\r
To avoid a naming conflict, the definition here is renamed.\r
**/\r
typedef\r
@retval EFI_SUCCESS The requested memory pages were freed.\r
@retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.\r
@retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().\r
- \r
+\r
@note Inconsistent with specification here:\r
- In the Framework Spec, this definition is named EFI_SMM_FREE_PAGES. \r
+ In the Framework Spec, this definition is named EFI_SMM_FREE_PAGES.\r
To avoid a naming conflict, the definition here is renamed.\r
**/\r
typedef\r
UINT8 Reserved2[164];\r
\r
//\r
- // Registers in IA-32 processors. \r
+ // Registers in IA-32 processors.\r
//\r
UINT32 ES;\r
UINT32 CS;\r
/// The processor save-state information for the Itanium processor family. This information is\r
/// important in that the SMM drivers may need to ascertain the state of the processor before invoking\r
/// the PMI. This structure is mandatory and must be 512 byte aligned.\r
-/// \r
+///\r
typedef struct {\r
UINT64 reserved;\r
UINT64 r1;\r
///\r
typedef union {\r
///\r
- /// The processor save-state information for IA-32 processors. \r
+ /// The processor save-state information for IA-32 processors.\r
///\r
EFI_SMI_CPU_SAVE_STATE Ia32SaveState;\r
///\r
\r
///\r
/// The optional floating point save-state information for the Itanium processor family. If the optional\r
-/// floating point save is indicated for any handler, then this data structure must be preserved. \r
-/// \r
+/// floating point save is indicated for any handler, then this data structure must be preserved.\r
+///\r
typedef struct {\r
UINT64 f2[2];\r
UINT64 f3[2];\r
/// point save is indicated for any handler, then this data structure must be preserved.\r
///\r
typedef union {\r
- /// \r
- /// The optional floating point save-state information for IA-32 processors. \r
+ ///\r
+ /// The optional floating point save-state information for IA-32 processors.\r
///\r
EFI_SMI_OPTIONAL_FPSAVE_STATE Ia32FpSave;\r
///\r
- /// The optional floating point save-state information for Itanium processors. \r
+ /// The optional floating point save-state information for Itanium processors.\r
///\r
EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT ItaniumFpSave;\r
} EFI_SMM_FLOATING_POINT_SAVE_STATE;\r
//\r
struct _EFI_SMM_SYSTEM_TABLE {\r
///\r
- /// The table header for the System Management System Table (SMST). \r
+ /// The table header for the System Management System Table (SMST).\r
///\r
EFI_TABLE_HEADER Hdr;\r
\r
UINT32 SmmFirmwareRevision;\r
\r
///\r
- /// Adds, updates, or removes a configuration table entry from the SMST. \r
+ /// Adds, updates, or removes a configuration table entry from the SMST.\r
///\r
EFI_SMM_INSTALL_CONFIGURATION_TABLE SmmInstallConfigurationTable;\r
\r
// I/O Services\r
//\r
///\r
- /// A GUID that designates the particular CPU I/O services. \r
+ /// A GUID that designates the particular CPU I/O services.\r
///\r
EFI_GUID EfiSmmCpuIoGuid;\r
///\r
///\r
EFI_SMMCORE_ALLOCATE_POOL SmmAllocatePool;\r
///\r
- /// Returns pool memory to the system. \r
+ /// Returns pool memory to the system.\r
///\r
EFI_SMMCORE_FREE_POOL SmmFreePool;\r
///\r
- /// Allocates memory pages from the system. \r
+ /// Allocates memory pages from the system.\r
///\r
EFI_SMMCORE_ALLOCATE_PAGES SmmAllocatePages;\r
///\r
//\r
// MP service\r
//\r
- \r
+\r
/// Inconsistent with specification here:\r
- /// In Framework Spec, this definition does not exist. This method is introduced in PI1.1 specification for \r
+ /// In Framework Spec, this definition does not exist. This method is introduced in PI1.1 specification for\r
/// the implementation needed.\r
EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp;\r
\r
Status Code Definitions, according to Intel Platform Innovation Framework\r
for EFI Status Codes Specification\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
///\r
/// Software Class DXE BS Driver Subclass Progress Code definitions.\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
///@{\r
#define EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS (EFI_SUBCLASS_SPECIFIC | 0x00000005)\r
///\r
/// Software Class DXE RT Driver Subclass Progress Code definitions.\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
///@{\r
#define EFI_SW_DXE_RT_PC_S0 (EFI_SUBCLASS_SPECIFIC | 0x00000000)\r
///\r
/// Software Subclass definitions.\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
#define EFI_SOFTWARE_X64_EXCEPTION (EFI_SOFTWARE | 0x00130000)\r
\r
/// These exceptions are derived from the debug protocol definitions in the EFI\r
/// specification.\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
///@{\r
#define EFI_SW_EC_X64_DIVIDE_ERROR EXCEPT_X64_DIVIDE_ERROR\r
///\r
/// Software Class DXE Core Subclass Error Code definitions.\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
-#define EFI_SW_CSM_LEGACY_ROM_INIT (EFI_SUBCLASS_SPECIFIC | 0x00000000) \r
+#define EFI_SW_CSM_LEGACY_ROM_INIT (EFI_SUBCLASS_SPECIFIC | 0x00000000)\r
\r
///\r
/// IO Bus Class ATA/ATAPI Subclass Progress Code definitions.\r
///\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
///@{\r
#define EFI_IOB_ATA_BUS_SMART_ENABLE (EFI_SUBCLASS_SPECIFIC | 0x00000000)\r
/// IO Bus Class ATA/ATAPI Subclass Error Code definitions.\r
///\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
///@{\r
#define EFI_IOB_ATA_BUS_SMART_NOTSUPPORTED (EFI_SUBCLASS_SPECIFIC | 0x00000000)\r
///\r
/// The reason that the processor was disabled.\r
///\r
-/// Inconsistent with specification here: \r
-/// The Framework Specification, StatusCodes 0.92, does not define the macros. \r
+/// Inconsistent with specification here:\r
+/// The Framework Specification, StatusCodes 0.92, does not define the macros.\r
///\r
///@{\r
#define EFI_CPU_CAUSE_NOT_DISABLED 0x0000\r
/** @file\r
- The root header file that provides Framework extension to UEFI/PI for modules. It can be included by \r
+ The root header file that provides Framework extension to UEFI/PI for modules. It can be included by\r
DXE, RUNTIME and SMM type modules that use Framework definitions.\r
\r
\r
This header file includes Framework extension definitions common to DXE\r
modules.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
\r
This header file must include Framework extension definitions common to PEI\r
modules.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
This header file must include Framework extension definitions common to DXE\r
modules.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
/** @file\r
- This file declares the hardware-device class GUIDs that may be used by the \r
+ This file declares the hardware-device class GUIDs that may be used by the\r
PEIM that produces the Virtual Block I/O PPI.\r
\r
These GUIDs are hardware-device class GUIDs that would be imported only by the\r
- Virtual Block I/O PEIM. This virtual PEIM imports only the actual Block I/O \r
+ Virtual Block I/O PEIM. This virtual PEIM imports only the actual Block I/O\r
PPIs from the device-class ones listed here and published a single instance of\r
the Block I/O PPI for consumption by the File System PEIM. In the parlance of\r
- the Framework DXE software stack, this Virtual Block I/O PEIM is actually \r
+ the Framework DXE software stack, this Virtual Block I/O PEIM is actually\r
embodying the functionality of the partition driver. Thsi Virtual Block I/O\r
PEIM has to multiple the multiple possible instances of Block I/O and also know\r
how to parse at least El Torito for CD-ROM, and perhaps Master Boot Record(MBR)\r
and GUID Partition Table(GPT) in the future.\r
- \r
-Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+\r
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
/** @file\r
Framework Capule related Definition.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
///\r
UINT32 HeaderSize;\r
///\r
- /// A bit-mapped list describing the capsule's attributes. \r
+ /// A bit-mapped list describing the capsule's attributes.\r
/// All undefined bits should be written as zero (0).\r
///\r
UINT32 Flags;\r
/** @file\r
DataHubRecord.h includes all data hub subclass GUID definitions.\r
\r
- This file includes all data hub sub class defitions from \r
+ This file includes all data hub sub class defitions from\r
Cache subclass specification 0.9, DataHub SubClass specification 0.9, Memory SubClass Spec 0.9,\r
Processor Subclass specification 0.9, and Misc SubClass specification 0.9.\r
- \r
-Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
extern EFI_GUID gEfiCacheSubClassGuid;\r
\r
///\r
-/// The memory subclass belongs to the data class and is identified as the memory \r
+/// The memory subclass belongs to the data class and is identified as the memory\r
/// subclass by the GUID.\r
///\r
#define EFI_MEMORY_SUBCLASS_GUID \\r
\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In ProcSubclass specification 0.9, the value is 0x0100.\r
/// Keep it unchanged from the perspective of binary consistency.\r
///\r
} FLOOPY_CONN_DEVICE_PATH;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this data structure and corrsponding fields are NOT defined.\r
/// It's implementation-specific to simplify the code logic.\r
///\r
///\r
/// String Token Definition\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// The macro isn't defined by any specification.\r
/// Keep it unchanged for backward compatibility.\r
///\r
#define EFI_STRING_TOKEN UINT16\r
\r
///\r
-/// Each data record that is a member of some subclass starts with a standard \r
+/// Each data record that is a member of some subclass starts with a standard\r
/// header of type EFI_SUBCLASS_TYPE1_HEADER.\r
-/// This header is only a guideline and applicable only to a data \r
-/// subclass that is producing SMBIOS data records. A subclass can start with a \r
-/// different header if needed. \r
+/// This header is only a guideline and applicable only to a data\r
+/// subclass that is producing SMBIOS data records. A subclass can start with a\r
+/// different header if needed.\r
///\r
typedef struct {\r
///\r
- /// The version of the specification to which a specific subclass data record adheres. \r
+ /// The version of the specification to which a specific subclass data record adheres.\r
///\r
UINT32 Version;\r
///\r
- /// The size in bytes of this data class header. \r
+ /// The size in bytes of this data class header.\r
///\r
UINT32 HeaderSize;\r
///\r
- /// The instance number of the subclass with the same ProducerName. This number is \r
- /// applicable in cases where multiple subclass instances that were produced by the same \r
- /// driver exist in the system. This entry is 1 based; 0 means Reserved and -1 means Not \r
- /// Applicable. All data consumer drivers should be able to handle all the possible values \r
- /// of Instance, including Not Applicable and Reserved. \r
+ /// The instance number of the subclass with the same ProducerName. This number is\r
+ /// applicable in cases where multiple subclass instances that were produced by the same\r
+ /// driver exist in the system. This entry is 1 based; 0 means Reserved and -1 means Not\r
+ /// Applicable. All data consumer drivers should be able to handle all the possible values\r
+ /// of Instance, including Not Applicable and Reserved.\r
///\r
UINT16 Instance;\r
///\r
- /// The instance number of the RecordType for the same Instance. This number is \r
- /// applicable in cases where multiple instances of the RecordType exist for a specific \r
- /// Instance. This entry is 1 based; 0 means Reserved and -1 means Not Applicable. \r
- /// All data consumer drivers should be able to handle all the possible values of \r
- /// SubInstance, including Not Applicable and Reserved. \r
+ /// The instance number of the RecordType for the same Instance. This number is\r
+ /// applicable in cases where multiple instances of the RecordType exist for a specific\r
+ /// Instance. This entry is 1 based; 0 means Reserved and -1 means Not Applicable.\r
+ /// All data consumer drivers should be able to handle all the possible values of\r
+ /// SubInstance, including Not Applicable and Reserved.\r
///\r
UINT16 SubInstance;\r
///\r
- /// The record number for the data record being specified. The numbering scheme and \r
- /// definition is defined in the specific subclass specification. \r
+ /// The record number for the data record being specified. The numbering scheme and\r
+ /// definition is defined in the specific subclass specification.\r
///\r
UINT32 RecordType;\r
} EFI_SUBCLASS_TYPE1_HEADER;\r
\r
///\r
-/// This structure is used to link data records in the same subclasses. A data record is \r
-/// defined as a link to another data record in the same subclass using this structure. \r
+/// This structure is used to link data records in the same subclasses. A data record is\r
+/// defined as a link to another data record in the same subclass using this structure.\r
///\r
typedef struct {\r
///\r
- /// An EFI_GUID that identifies the component that produced this data record. Type \r
- /// EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification. \r
+ /// An EFI_GUID that identifies the component that produced this data record. Type\r
+ /// EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
///\r
EFI_GUID ProducerName;\r
///\r
- /// The instance number of the subclass with the same ProducerName. This number is \r
- /// applicable in cases where multiple subclass instances that were produced by the same \r
- /// driver exist in the system. This entry is 1 based; 0 means Reserved and -1 means Not \r
- /// Applicable. All data consumer drivers should be able to handle all the possible values \r
- /// of Instance, including Not Applicable and Reserved. \r
+ /// The instance number of the subclass with the same ProducerName. This number is\r
+ /// applicable in cases where multiple subclass instances that were produced by the same\r
+ /// driver exist in the system. This entry is 1 based; 0 means Reserved and -1 means Not\r
+ /// Applicable. All data consumer drivers should be able to handle all the possible values\r
+ /// of Instance, including Not Applicable and Reserved.\r
///\r
UINT16 Instance;\r
- /// The instance number of the RecordType for the same Instance. This number is \r
- /// applicable in cases where multiple instances of the RecordType exist for a specific \r
- /// Instance. This entry is 1 based; 0 means Reserved and -1 means Not Applicable. \r
- /// All data consumer drivers should be able to handle all the possible values of \r
- /// SubInstance, including Not Applicable and Reserved. \r
+ /// The instance number of the RecordType for the same Instance. This number is\r
+ /// applicable in cases where multiple instances of the RecordType exist for a specific\r
+ /// Instance. This entry is 1 based; 0 means Reserved and -1 means Not Applicable.\r
+ /// All data consumer drivers should be able to handle all the possible values of\r
+ /// SubInstance, including Not Applicable and Reserved.\r
UINT16 SubInstance;\r
} EFI_INTER_LINK_DATA;\r
\r
// EXP data\r
//\r
///\r
-/// This macro provides a calculation for base-10 representations. Value and Exponent are each \r
+/// This macro provides a calculation for base-10 representations. Value and Exponent are each\r
/// INT16. It is signed to cover negative values and is 16 bits wide (15 bits for data and 1 bit\r
-/// for the sign). \r
+/// for the sign).\r
///\r
typedef struct {\r
///\r
- /// The INT16 number by which to multiply the base-10 representation. \r
+ /// The INT16 number by which to multiply the base-10 representation.\r
///\r
UINT16 Value;\r
///\r
- /// The INT16 number by which to raise the base-10 calculation. \r
+ /// The INT16 number by which to raise the base-10 calculation.\r
///\r
UINT16 Exponent;\r
} EFI_EXP_BASE2_DATA;\r
typedef EFI_EXP_BASE10_DATA EFI_PROCESSOR_CORE_FREQUENCY_DATA;\r
\r
///\r
-/// This data record refers to the list of frequencies that the processor core supports. The list of \r
-/// supported frequencies is determined by the firmware based on hardware capabilities--for example, \r
-/// it could be a common subset of all processors and the chipset. The unit of measurement of this data \r
-/// record is in Hertz. For asynchronous processors, the content of this data record is zero. \r
-/// The list is terminated by -1 in the Value field of the last element. A Value field of zero means \r
-/// that the processor/driver supports automatic frequency selection. \r
+/// This data record refers to the list of frequencies that the processor core supports. The list of\r
+/// supported frequencies is determined by the firmware based on hardware capabilities--for example,\r
+/// it could be a common subset of all processors and the chipset. The unit of measurement of this data\r
+/// record is in Hertz. For asynchronous processors, the content of this data record is zero.\r
+/// The list is terminated by -1 in the Value field of the last element. A Value field of zero means\r
+/// that the processor/driver supports automatic frequency selection.\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// According to MiscSubclass 0.9 specification, it should be a pointer since it refers to a list of frequencies.\r
///\r
typedef EFI_EXP_BASE10_DATA *EFI_PROCESSOR_CORE_FREQUENCY_LIST_DATA;\r
\r
///\r
-/// This data record refers to the list of supported frequencies of the processor external bus. The list of \r
-/// supported frequencies is determined by the firmware based on hardware capabilities--for example, \r
-/// it could be a common subset of all processors and the chipset. The unit of measurement of this data \r
-/// record is in Hertz. For asynchronous processors, the content of this data record is NULL. \r
-/// The list is terminated by -1 in the Value field of the last element. A Value field of zero means \r
-/// that the processor/driver supports automatic frequency selection. \r
+/// This data record refers to the list of supported frequencies of the processor external bus. The list of\r
+/// supported frequencies is determined by the firmware based on hardware capabilities--for example,\r
+/// it could be a common subset of all processors and the chipset. The unit of measurement of this data\r
+/// record is in Hertz. For asynchronous processors, the content of this data record is NULL.\r
+/// The list is terminated by -1 in the Value field of the last element. A Value field of zero means\r
+/// that the processor/driver supports automatic frequency selection.\r
///\r
typedef EFI_EXP_BASE10_DATA *EFI_PROCESSOR_FSB_FREQUENCY_LIST_DATA;\r
typedef EFI_EXP_BASE10_DATA EFI_PROCESSOR_FSB_FREQUENCY_DATA;\r
\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// The name of third field in ProcSubClass specification 0.9 is LogicalProcessorCount.\r
/// Keep it unchanged for backward compatibility.\r
///\r
} EFI_PROCESSOR_FEATURE_FLAGS;\r
\r
///\r
-/// This data record refers to the unique ID that identifies a set of processors. This data record is 16 \r
-/// bytes in length. The data in this structure is processor specific and reserved values can be defined \r
-/// for future use. The consumer of this data should not make any assumption and should use this data \r
-/// with respect to the processor family defined in the Family record number. \r
+/// This data record refers to the unique ID that identifies a set of processors. This data record is 16\r
+/// bytes in length. The data in this structure is processor specific and reserved values can be defined\r
+/// for future use. The consumer of this data should not make any assumption and should use this data\r
+/// with respect to the processor family defined in the Family record number.\r
///\r
typedef struct {\r
///\r
///\r
EFI_PROCESSOR_SIGNATURE Signature;\r
///\r
- /// Provides additional processor information. \r
+ /// Provides additional processor information.\r
///\r
EFI_PROCESSOR_MISC_INFO MiscInfo;\r
///\r
- /// Reserved for future use. \r
+ /// Reserved for future use.\r
///\r
UINT32 Reserved;\r
///\r
- /// Provides additional processor information. \r
+ /// Provides additional processor information.\r
///\r
EFI_PROCESSOR_FEATURE_FLAGS FeatureFlags;\r
} EFI_PROCESSOR_ID_DATA;\r
\r
///\r
-/// This data record refers to the general classification of the processor. This data record is 4 bytes in \r
-/// length. \r
+/// This data record refers to the general classification of the processor. This data record is 4 bytes in\r
+/// length.\r
///\r
typedef enum {\r
EfiProcessorOther = 1,\r
} EFI_PROCESSOR_TYPE_DATA;\r
\r
///\r
-/// This data record refers to the family of the processor as defined by the DMTF. \r
-/// This data record is 4 bytes in length. \r
+/// This data record refers to the family of the processor as defined by the DMTF.\r
+/// This data record is 4 bytes in length.\r
///\r
typedef enum {\r
- EfiProcessorFamilyOther = 0x01, \r
+ EfiProcessorFamilyOther = 0x01,\r
EfiProcessorFamilyUnknown = 0x02,\r
- EfiProcessorFamily8086 = 0x03, \r
+ EfiProcessorFamily8086 = 0x03,\r
EfiProcessorFamily80286 = 0x04,\r
- EfiProcessorFamilyIntel386 = 0x05, \r
+ EfiProcessorFamilyIntel386 = 0x05,\r
EfiProcessorFamilyIntel486 = 0x06,\r
EfiProcessorFamily8087 = 0x07,\r
EfiProcessorFamily80287 = 0x08,\r
- EfiProcessorFamily80387 = 0x09, \r
+ EfiProcessorFamily80387 = 0x09,\r
EfiProcessorFamily80487 = 0x0A,\r
- EfiProcessorFamilyPentium = 0x0B, \r
+ EfiProcessorFamilyPentium = 0x0B,\r
EfiProcessorFamilyPentiumPro = 0x0C,\r
EfiProcessorFamilyPentiumII = 0x0D,\r
EfiProcessorFamilyPentiumMMX = 0x0E,\r
EfiProcessorFamilyCeleron = 0x0F,\r
EfiProcessorFamilyPentiumIIXeon = 0x10,\r
- EfiProcessorFamilyPentiumIII = 0x11, \r
+ EfiProcessorFamilyPentiumIII = 0x11,\r
EfiProcessorFamilyM1 = 0x12,\r
EfiProcessorFamilyM2 = 0x13,\r
EfiProcessorFamilyM1Reserved2 = 0x14,\r
EfiProcessorFamilyM1Reserved4 = 0x16,\r
EfiProcessorFamilyM1Reserved5 = 0x17,\r
EfiProcessorFamilyAmdDuron = 0x18,\r
- EfiProcessorFamilyK5 = 0x19, \r
+ EfiProcessorFamilyK5 = 0x19,\r
EfiProcessorFamilyK6 = 0x1A,\r
EfiProcessorFamilyK6_2 = 0x1B,\r
EfiProcessorFamilyK6_3 = 0x1C,\r
EfiProcessorFamilyUltraSparcIIi = 0x56,\r
EfiProcessorFamilyUltraSparcIII = 0x57,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field in ProcSubClass specification 0.9 is defined as EfiProcessorFamilyUltraSparcIIi.\r
/// Change it to EfiProcessorFamilyUltraSparcIIIi to avoid build break.\r
///\r
EfiProcessorFamilyAMDAthlonMP = 0xB7,\r
EfiProcessorFamilyIntelItanium2 = 0xB8,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyIntelPentiumM = 0xB9,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyIntelCeleronD = 0xBA,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyIntelPentiumD = 0xBB,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyIntelPentiumEx = 0xBC,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
- EfiProcessorFamilyIntelCoreSolo = 0xBD, \r
+ EfiProcessorFamilyIntelCoreSolo = 0xBD,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
- EfiProcessorFamilyReserved = 0xBE, \r
+ EfiProcessorFamilyReserved = 0xBE,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyIntelCore2 = 0xBF,\r
EfiProcessorFamilyG4 = 0xC9,\r
EfiProcessorFamilyG5 = 0xCA,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyG6 = 0xCB,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyzArchitectur = 0xCC,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyViaC7M = 0xD2,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyViaC7D = 0xD3,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyViaC7 = 0xD4,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyViaEden = 0xD5,\r
EfiProcessorFamilyi860 = 0xFA,\r
EfiProcessorFamilyi960 = 0xFB,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyIndicatorFamily2 = 0xFE,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorFamilyReserved1 = 0xFF\r
} EFI_PROCESSOR_FAMILY2_DATA;\r
\r
///\r
-/// This data record refers to the core voltage of the processor being defined. The unit of measurement \r
-/// of this data record is in volts. \r
+/// This data record refers to the core voltage of the processor being defined. The unit of measurement\r
+/// of this data record is in volts.\r
///\r
typedef EFI_EXP_BASE10_DATA EFI_PROCESSOR_VOLTAGE_DATA;\r
\r
///\r
-/// This data record refers to the base address of the APIC of the processor being defined. This data \r
-/// record is a physical address location. \r
+/// This data record refers to the base address of the APIC of the processor being defined. This data\r
+/// record is a physical address location.\r
///\r
typedef EFI_PHYSICAL_ADDRESS EFI_PROCESSOR_APIC_BASE_ADDRESS_DATA;\r
\r
///\r
-/// This data record refers to the ID of the APIC of the processor being defined. This data record is a \r
-/// 4-byte entry. \r
+/// This data record refers to the ID of the APIC of the processor being defined. This data record is a\r
+/// 4-byte entry.\r
///\r
typedef UINT32 EFI_PROCESSOR_APIC_ID_DATA;\r
\r
///\r
-/// This data record refers to the version number of the APIC of the processor being defined. This data \r
-/// record is a 4-byte entry. \r
+/// This data record refers to the version number of the APIC of the processor being defined. This data\r
+/// record is a 4-byte entry.\r
///\r
typedef UINT32 EFI_PROCESSOR_APIC_VERSION_NUMBER_DATA;\r
\r
} EFI_PROCESSOR_MICROCODE_TYPE;\r
\r
///\r
-/// This data record refers to the revision of the processor microcode that is loaded in the processor. \r
-/// This data record is a 4-byte entry. \r
+/// This data record refers to the revision of the processor microcode that is loaded in the processor.\r
+/// This data record is a 4-byte entry.\r
///\r
typedef struct {\r
///\r
- /// Identifies what type of microcode the data is. \r
- /// \r
+ /// Identifies what type of microcode the data is.\r
+ ///\r
EFI_PROCESSOR_MICROCODE_TYPE ProcessorMicrocodeType;\r
///\r
- /// Indicates the revision number of this microcode. \r
+ /// Indicates the revision number of this microcode.\r
///\r
UINT32 ProcessorMicrocodeRevisionNumber;\r
} EFI_PROCESSOR_MICROCODE_REVISION_DATA;\r
/// This data record refers to the status of the processor.\r
///\r
typedef struct {\r
- UINT32 CpuStatus :3; ///< Indicates the status of the processor. \r
- UINT32 Reserved1 :3; ///< Reserved for future use. Should be set to zero. \r
- UINT32 SocketPopulated :1; ///< Indicates if the processor is socketed or not. \r
- UINT32 Reserved2 :1; ///< Reserved for future use. Should be set to zero. \r
- UINT32 ApicEnable :1; ///< Indicates if the APIC is enabled or not. \r
- UINT32 BootApplicationProcessor :1; ///< Indicates if this processor is the boot processor. \r
- UINT32 Reserved3 :22;///< Reserved for future use. Should be set to zero. \r
+ UINT32 CpuStatus :3; ///< Indicates the status of the processor.\r
+ UINT32 Reserved1 :3; ///< Reserved for future use. Should be set to zero.\r
+ UINT32 SocketPopulated :1; ///< Indicates if the processor is socketed or not.\r
+ UINT32 Reserved2 :1; ///< Reserved for future use. Should be set to zero.\r
+ UINT32 ApicEnable :1; ///< Indicates if the APIC is enabled or not.\r
+ UINT32 BootApplicationProcessor :1; ///< Indicates if this processor is the boot processor.\r
+ UINT32 Reserved3 :22;///< Reserved for future use. Should be set to zero.\r
} EFI_PROCESSOR_STATUS_DATA;\r
\r
typedef enum {\r
EfiProcessorSocket754 = 0x10,\r
EfiProcessorSocket940 = 0x11,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorSocket939 = 0x12,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorSocketmPGA604 = 0x13,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorSocketLGA771 = 0x14,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in ProcSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiProcessorSocketLGA775 = 0x15\r
typedef STRING_REF EFI_PROCESSOR_SOCKET_NAME_DATA;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In ProcSubclass specification 0.9, the naming is EFI_PROCESSOR_CACHE_ASSOCIATION_DATA.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
typedef EFI_INTER_LINK_DATA EFI_CACHE_ASSOCIATION_DATA;\r
\r
///\r
-/// This data record refers to the health status of the processor. \r
+/// This data record refers to the health status of the processor.\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In ProcSubclass specification 0.9, the naming is EFI_PROCESSOR_HEALTH_STATUS_DATA.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
typedef enum {\r
EfiProcessorHealthy = 1,\r
EfiProcessorPerfRestricted = 2,\r
- EfiProcessorFuncRestricted = 3 \r
+ EfiProcessorFuncRestricted = 3\r
} EFI_PROCESSOR_HEALTH_STATUS;\r
\r
///\r
-/// This data record refers to the package number of this processor. Multiple logical processors can \r
-/// exist in a system and each logical processor can be correlated to the physical processor using this \r
-/// record type. \r
+/// This data record refers to the package number of this processor. Multiple logical processors can\r
+/// exist in a system and each logical processor can be correlated to the physical processor using this\r
+/// record type.\r
///\r
typedef UINTN EFI_PROCESSOR_PACKAGE_NUMBER_DATA;\r
\r
///\r
/// Inconsistent with specification here:\r
/// In ProcSubclass specification 0.9, the enumeration type data structure is NOT defined.\r
-/// The equivalent in specification is \r
+/// The equivalent in specification is\r
/// #define EFI_PROCESSOR_FREQUENCY_RECORD_NUMBER 0x00000001\r
/// #define EFI_PROCESSOR_BUS_FREQUENCY_RECORD_NUMBER 0x00000002\r
/// #define EFI_PROCESSOR_VERSION_RECORD_NUMBER 0x00000003\r
} EFI_CPU_VARIABLE_RECORD_TYPE;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In ProcSubclass specification 0.9, the union type data structure is NOT defined.\r
/// It's implementation-specific to simplify the code logic.\r
///\r
\r
typedef EFI_EXP_BASE2_DATA EFI_CACHE_SIZE_DATA;\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In CacheSubclass specification 0.9, the naming is EFI_CACHE_MAXIMUM_SIZE_DATA.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
} EFI_CACHE_ASSOCIATIVITY_DATA;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In CacheSubclass 0.9 specification. It defines the field type as UINT16.\r
/// In fact, it should be UINT32 type because it refers to a 32bit width data.\r
///\r
///\r
/// Inconsistent with specification here:\r
/// In CacheSubclass specification 0.9, the enumeration type data structure is NOT defined.\r
-/// The equivalent in specification is \r
+/// The equivalent in specification is\r
/// #define EFI_CACHE_SIZE_RECORD_NUMBER 0x00000001\r
/// #define EFI_CACHE_MAXIMUM_SIZE_RECORD_NUMBER 0x00000002\r
/// #define EFI_CACHE_SPEED_RECORD_NUMBER 0x00000003\r
/// #define EFI_CACHE_SOCKET_RECORD_NUMBER 0x00000004\r
-/// #define EFI_CACHE_SRAM_SUPPORT_RECORD_NUMBER 0x00000005 \r
-/// #define EFI_CACHE_SRAM_INSTALL_RECORD_NUMBER 0x00000006 \r
+/// #define EFI_CACHE_SRAM_SUPPORT_RECORD_NUMBER 0x00000005\r
+/// #define EFI_CACHE_SRAM_INSTALL_RECORD_NUMBER 0x00000006\r
/// #define EFI_CACHE_ERROR_SUPPORT_RECORD_NUMBER 0x00000007\r
/// #define EFI_CACHE_TYPE_RECORD_NUMBER 0x00000008\r
/// #define EFI_CACHE_ASSOCIATIVITY_RECORD_NUMBER 0x00000009\r
} EFI_CACHE_VARIABLE_RECORD_TYPE;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In CacheSubclass specification 0.9, the union type data structure is NOT defined.\r
/// It's implementation-specific to simplify the code logic.\r
///\r
} EFI_MEMORY_REGION_TYPE;\r
\r
///\r
-/// This data record refers to the size of a memory region. The regions that are \r
-/// described can refer to physical memory, memory-mapped I/O, or reserved BIOS memory regions. \r
-/// The unit of measurement of this data record is in bytes. \r
+/// This data record refers to the size of a memory region. The regions that are\r
+/// described can refer to physical memory, memory-mapped I/O, or reserved BIOS memory regions.\r
+/// The unit of measurement of this data record is in bytes.\r
///\r
typedef struct {\r
///\r
- /// A zero-based value that indicates which processor(s) can access the memory region. \r
- /// A value of 0xFFFF indicates the region is accessible by all processors. \r
+ /// A zero-based value that indicates which processor(s) can access the memory region.\r
+ /// A value of 0xFFFF indicates the region is accessible by all processors.\r
///\r
UINT32 ProcessorNumber;\r
///\r
- /// A zero-based value that indicates the starting bus that can access the memory region. \r
+ /// A zero-based value that indicates the starting bus that can access the memory region.\r
///\r
UINT16 StartBusNumber;\r
///\r
- /// A zero-based value that indicates the ending bus that can access the memory region. \r
- /// A value of 0xFF for a PCI system indicates the region is accessible by all buses and \r
- /// is global in scope. An example of the EndBusNumber not being 0xFF is a system \r
- /// with two or more peer-to-host PCI bridges. \r
+ /// A zero-based value that indicates the ending bus that can access the memory region.\r
+ /// A value of 0xFF for a PCI system indicates the region is accessible by all buses and\r
+ /// is global in scope. An example of the EndBusNumber not being 0xFF is a system\r
+ /// with two or more peer-to-host PCI bridges.\r
///\r
UINT16 EndBusNumber;\r
///\r
- /// The type of memory region from the operating system's point of view. \r
- /// MemoryRegionType values are equivalent to the legacy INT 15 AX = E820 BIOS \r
- /// command values. \r
+ /// The type of memory region from the operating system's point of view.\r
+ /// MemoryRegionType values are equivalent to the legacy INT 15 AX = E820 BIOS\r
+ /// command values.\r
///\r
EFI_MEMORY_REGION_TYPE MemoryRegionType;\r
///\r
- /// The size of the memory region in bytes. \r
+ /// The size of the memory region in bytes.\r
///\r
EFI_EXP_BASE2_DATA MemorySize;\r
///\r
- /// The starting physical address of the memory region. \r
+ /// The starting physical address of the memory region.\r
///\r
EFI_PHYSICAL_ADDRESS MemoryStartAddress;\r
} EFI_MEMORY_SIZE_DATA;\r
} EFI_MEMORY_ERROR_CORRECTION;\r
\r
///\r
-/// This data record refers to the physical memory array. This data record is a structure. \r
-/// The type definition structure for EFI_MEMORY_ARRAY_LOCATION_DATA is in SMBIOS 2.3.4: \r
-/// - Table 3.3.17.1, Type 16, Offset 0x4 \r
-/// - Table 3.3.17.2, Type 16, Offset 0x5 \r
-/// - Table 3.3.17.3, Type 16, with the following offsets: \r
-/// -- Offset 0x6 \r
-/// -- Offset 0x7 \r
-/// -- Offset 0xB \r
-/// -- Offset 0xD \r
-/// \r
+/// This data record refers to the physical memory array. This data record is a structure.\r
+/// The type definition structure for EFI_MEMORY_ARRAY_LOCATION_DATA is in SMBIOS 2.3.4:\r
+/// - Table 3.3.17.1, Type 16, Offset 0x4\r
+/// - Table 3.3.17.2, Type 16, Offset 0x5\r
+/// - Table 3.3.17.3, Type 16, with the following offsets:\r
+/// -- Offset 0x6\r
+/// -- Offset 0x7\r
+/// -- Offset 0xB\r
+/// -- Offset 0xD\r
+///\r
typedef struct {\r
///\r
- /// The physical location of the memory array. \r
+ /// The physical location of the memory array.\r
///\r
EFI_MEMORY_ARRAY_LOCATION MemoryArrayLocation;\r
///\r
///\r
EFI_MEMORY_ERROR_CORRECTION MemoryErrorCorrection;\r
///\r
- /// The maximum memory capacity size in kilobytes. If capacity is unknown, then \r
- /// values of MaximumMemoryCapacity.Value = 0x00 and \r
+ /// The maximum memory capacity size in kilobytes. If capacity is unknown, then\r
+ /// values of MaximumMemoryCapacity.Value = 0x00 and\r
/// MaximumMemoryCapacity.Exponent = 0x8000 are used.\r
///\r
EFI_EXP_BASE2_DATA MaximumMemoryCapacity;\r
///\r
- /// The number of memory slots or sockets that are available for memory devices \r
- /// in this array. \r
+ /// The number of memory slots or sockets that are available for memory devices\r
+ /// in this array.\r
///\r
UINT16 NumberMemoryDevices;\r
} EFI_MEMORY_ARRAY_LOCATION_DATA;\r
EfiMemoryFormFactorSodimm = 0x0D,\r
EfiMemoryFormFactorSrimm = 0x0E,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in MemSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiMemoryFormFactorFbDimm = 0x0F\r
EfiMemoryTypeRdram = 0x11,\r
EfiMemoryTypeDdr = 0x12,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in MemSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiMemoryTypeDdr2 = 0x13,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in MemSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiMemoryTypeDdr2FbDimm = 0x14\r
EfiMemoryStateAbsent = 4,\r
EfiMemoryStateDisabled = 5,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// This field is NOT defined in MemSubClass specification 0.9. It's introduced for SMBIOS2.6 specification.\r
///\r
EfiMemoryStatePartial = 6\r
} EFI_MEMORY_STATE;\r
\r
///\r
-/// This data record describes a memory device. This data record is a structure. \r
+/// This data record describes a memory device. This data record is a structure.\r
/// The type definition structure for EFI_MEMORY_ARRAY_LINK_DATA is in SMBIOS 2.3.4.\r
///\r
typedef struct {\r
///\r
- /// A string that identifies the physically labeled socket or board position where the \r
+ /// A string that identifies the physically labeled socket or board position where the\r
/// memory device is located.\r
///\r
STRING_REF MemoryDeviceLocator;\r
///\r
- /// A string denoting the physically labeled bank where the memory device is located. \r
+ /// A string denoting the physically labeled bank where the memory device is located.\r
///\r
STRING_REF MemoryBankLocator;\r
///\r
- /// A string denoting the memory manufacturer. \r
- /// \r
+ /// A string denoting the memory manufacturer.\r
+ ///\r
STRING_REF MemoryManufacturer;\r
///\r
- /// A string denoting the serial number of the memory device. \r
+ /// A string denoting the serial number of the memory device.\r
///\r
STRING_REF MemorySerialNumber;\r
///\r
- /// The asset tag of the memory device. \r
+ /// The asset tag of the memory device.\r
///\r
STRING_REF MemoryAssetTag;\r
///\r
- /// A string denoting the part number of the memory device. \r
+ /// A string denoting the part number of the memory device.\r
///\r
STRING_REF MemoryPartNumber;\r
///\r
- /// A link to a memory array structure set. \r
+ /// A link to a memory array structure set.\r
///\r
EFI_INTER_LINK_DATA MemoryArrayLink;\r
///\r
///\r
EFI_INTER_LINK_DATA MemorySubArrayLink;\r
///\r
- /// The total width in bits of this memory device. If there are no error correcting bits, \r
- /// then the total width equals the data width. If the width is unknown, then set the field \r
- /// to 0xFFFF. \r
+ /// The total width in bits of this memory device. If there are no error correcting bits,\r
+ /// then the total width equals the data width. If the width is unknown, then set the field\r
+ /// to 0xFFFF.\r
///\r
UINT16 MemoryTotalWidth;\r
///\r
- /// The data width in bits of the memory device. A data width of 0x00 and a total width \r
- /// of 0x08 indicate that the device is used solely for error correction. \r
+ /// The data width in bits of the memory device. A data width of 0x00 and a total width\r
+ /// of 0x08 indicate that the device is used solely for error correction.\r
///\r
UINT16 MemoryDataWidth;\r
///\r
- /// The size in bytes of the memory device. A value of 0x00 denotes that no device is \r
+ /// The size in bytes of the memory device. A value of 0x00 denotes that no device is\r
/// installed, while a value of all Fs denotes that the size is not known.\r
///\r
EFI_EXP_BASE2_DATA MemoryDeviceSize;\r
///\r
- /// The form factor of the memory device. \r
+ /// The form factor of the memory device.\r
///\r
EFI_MEMORY_FORM_FACTOR MemoryFormFactor;\r
///\r
- /// A memory device set that must be populated with all devices of the same type and \r
- /// size. A value of 0x00 indicates that the device is not part of any set. A value of 0xFF \r
- /// indicates that the attribute is unknown. Any other value denotes the set number. \r
+ /// A memory device set that must be populated with all devices of the same type and\r
+ /// size. A value of 0x00 indicates that the device is not part of any set. A value of 0xFF\r
+ /// indicates that the attribute is unknown. Any other value denotes the set number.\r
///\r
UINT8 MemoryDeviceSet;\r
///\r
- /// The memory type in the socket. \r
+ /// The memory type in the socket.\r
///\r
EFI_MEMORY_ARRAY_TYPE MemoryType;\r
///\r
- /// The memory type details. \r
+ /// The memory type details.\r
///\r
EFI_MEMORY_TYPE_DETAIL MemoryTypeDetail;\r
///\r
- /// The memory speed in megahertz (MHz). A value of 0x00 denotes that \r
+ /// The memory speed in megahertz (MHz). A value of 0x00 denotes that\r
/// the speed is unknown.\r
- /// Inconsistent with specification here: \r
- /// In MemSubclass specification 0.9, the naming is MemoryTypeSpeed.\r
- /// Keep it unchanged for backward compatibilty.\r
- ///\r
+ /// Inconsistent with specification here:\r
+ /// In MemSubclass specification 0.9, the naming is MemoryTypeSpeed.\r
+ /// Keep it unchanged for backward compatibilty.\r
+ ///\r
EFI_EXP_BASE10_DATA MemorySpeed;\r
///\r
- /// The memory state. \r
+ /// The memory state.\r
///\r
EFI_MEMORY_STATE MemoryState;\r
} EFI_MEMORY_ARRAY_LINK_DATA;\r
#define EFI_MEMORY_ARRAY_START_ADDRESS_RECORD_NUMBER 0x00000004\r
\r
///\r
-/// This data record refers to a specified physical memory array associated with \r
-/// a given memory range. \r
-/// \r
+/// This data record refers to a specified physical memory array associated with\r
+/// a given memory range.\r
+///\r
typedef struct {\r
///\r
- /// The starting physical address in bytes of memory mapped to a specified physical \r
- /// memory array. \r
+ /// The starting physical address in bytes of memory mapped to a specified physical\r
+ /// memory array.\r
///\r
EFI_PHYSICAL_ADDRESS MemoryArrayStartAddress;\r
///\r
- /// The last physical address in bytes of memory mapped to a specified physical memory \r
- /// array. \r
+ /// The last physical address in bytes of memory mapped to a specified physical memory\r
+ /// array.\r
///\r
EFI_PHYSICAL_ADDRESS MemoryArrayEndAddress;\r
///\r
///\r
EFI_INTER_LINK_DATA PhysicalMemoryArrayLink;\r
///\r
- /// The number of memory devices that form a single row of memory for the address \r
- /// partition. \r
+ /// The number of memory devices that form a single row of memory for the address\r
+ /// partition.\r
///\r
UINT16 MemoryArrayPartitionWidth;\r
} EFI_MEMORY_ARRAY_START_ADDRESS_DATA;\r
#define EFI_MEMORY_DEVICE_START_ADDRESS_RECORD_NUMBER 0x00000005\r
\r
///\r
-/// This data record refers to a physical memory device that is associated with \r
+/// This data record refers to a physical memory device that is associated with\r
/// a given memory range.\r
-/// \r
+///\r
typedef struct {\r
///\r
- /// The starting physical address that is associated with the device. \r
+ /// The starting physical address that is associated with the device.\r
///\r
EFI_PHYSICAL_ADDRESS MemoryDeviceStartAddress;\r
///\r
- /// The ending physical address that is associated with the device. \r
+ /// The ending physical address that is associated with the device.\r
///\r
EFI_PHYSICAL_ADDRESS MemoryDeviceEndAddress;\r
///\r
- /// A link to the memory device data structure. \r
+ /// A link to the memory device data structure.\r
///\r
EFI_INTER_LINK_DATA PhysicalMemoryDeviceLink;\r
- /// \r
- /// A link to the memory array data structure. \r
+ ///\r
+ /// A link to the memory array data structure.\r
///\r
EFI_INTER_LINK_DATA PhysicalMemoryArrayLink;\r
///\r
- /// The position of the memory device in a row. A value of 0x00 is reserved and a value \r
- /// of 0xFF indicates that the position is unknown. \r
+ /// The position of the memory device in a row. A value of 0x00 is reserved and a value\r
+ /// of 0xFF indicates that the position is unknown.\r
///\r
UINT8 MemoryDevicePartitionRowPosition;\r
///\r
- /// The position of the device in an interleave. \r
+ /// The position of the device in an interleave.\r
///\r
UINT8 MemoryDeviceInterleavePosition;\r
///\r
- /// The maximum number of consecutive rows from the device that are accessed in a \r
- /// single interleave transfer. A value of 0x00 indicates that the device is not interleaved \r
- /// and a value of 0xFF indicates that the interleave configuration is unknown. \r
+ /// The maximum number of consecutive rows from the device that are accessed in a\r
+ /// single interleave transfer. A value of 0x00 indicates that the device is not interleaved\r
+ /// and a value of 0xFF indicates that the interleave configuration is unknown.\r
///\r
UINT8 MemoryDeviceInterleaveDataDepth;\r
} EFI_MEMORY_DEVICE_START_ADDRESS_DATA;\r
} EFI_MEMORY_CHANNEL_TYPE;\r
\r
///\r
-/// This data record refers the type of memory that is associated with the channel. This data record is a \r
-/// structure. \r
-/// The type definition structure for EFI_MEMORY_CHANNEL_TYPE_DATA is in SMBIOS 2.3.4, \r
-/// Table 3.3.38, Type 37, with the following offsets: \r
-/// - Offset 0x4 \r
-/// - Offset 0x5 \r
+/// This data record refers the type of memory that is associated with the channel. This data record is a\r
+/// structure.\r
+/// The type definition structure for EFI_MEMORY_CHANNEL_TYPE_DATA is in SMBIOS 2.3.4,\r
+/// Table 3.3.38, Type 37, with the following offsets:\r
+/// - Offset 0x4\r
+/// - Offset 0x5\r
/// - Offset 0x6\r
-/// \r
+///\r
typedef struct {\r
///\r
- /// The type of memory that is associated with the channel. \r
- /// \r
+ /// The type of memory that is associated with the channel.\r
+ ///\r
EFI_MEMORY_CHANNEL_TYPE MemoryChannelType;\r
///\r
/// The maximum load that is supported by the channel.\r
///\r
UINT8 MemoryChannelMaximumLoad;\r
///\r
- /// The number of memory devices on this channel. \r
+ /// The number of memory devices on this channel.\r
///\r
UINT8 MemoryChannelDeviceCount;\r
} EFI_MEMORY_CHANNEL_TYPE_DATA;\r
#define EFI_MEMORY_CHANNEL_DEVICE_RECORD_NUMBER 0x00000007\r
\r
///\r
-/// This data record refers to the memory device that is associated with the memory channel. This data \r
-/// record is a structure. \r
-/// The type definition structure for EFI_MEMORY_CHANNEL_DEVICE_DATA is in SMBIOS 2.3.4, \r
-/// Table 3.3.38, Type 37, with the following offsets: \r
-/// - Offset 0x7 \r
+/// This data record refers to the memory device that is associated with the memory channel. This data\r
+/// record is a structure.\r
+/// The type definition structure for EFI_MEMORY_CHANNEL_DEVICE_DATA is in SMBIOS 2.3.4,\r
+/// Table 3.3.38, Type 37, with the following offsets:\r
+/// - Offset 0x7\r
/// - Offset 0x8\r
///\r
typedef struct {\r
///\r
- /// A number between one and MemoryChannelDeviceCount plus an arbitrary base. \r
- /// \r
+ /// A number between one and MemoryChannelDeviceCount plus an arbitrary base.\r
+ ///\r
UINT8 DeviceId;\r
///\r
- /// The Link of the associated memory device. See Memory Device (Type 17) for \r
- /// memory devices. \r
+ /// The Link of the associated memory device. See Memory Device (Type 17) for\r
+ /// memory devices.\r
///\r
EFI_INTER_LINK_DATA DeviceLink;\r
///\r
- /// The number of load units that this device consumes. \r
+ /// The number of load units that this device consumes.\r
///\r
UINT8 MemoryChannelDeviceLoad;\r
} EFI_MEMORY_CHANNEL_DEVICE_DATA;\r
// Memory. Controller Information - SMBIOS Type 5\r
//\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
#define EFI_MEMORY_CONTROLLER_INFORMATION_RECORD_NUMBER 0x00000008\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
-typedef enum { \r
+typedef enum {\r
EfiErrorDetectingMethodOther = 1,\r
EfiErrorDetectingMethodUnknown = 2,\r
EfiErrorDetectingMethodNone = 3,\r
} EFI_MEMORY_ERROR_DETECT_METHOD_TYPE;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
} EFI_MEMORY_ERROR_CORRECT_CAPABILITY;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
-typedef enum { \r
+typedef enum {\r
EfiMemoryInterleaveOther = 1,\r
EfiMemoryInterleaveUnknown = 2,\r
EfiMemoryInterleaveOneWay = 3,\r
} EFI_MEMORY_SUPPORT_INTERLEAVE_TYPE;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
} EFI_MEMORY_SPEED_TYPE;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
} EFI_MEMORY_SUPPORTED_TYPE;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
/// EFI_MEMORY_CONTROLLER_INFORMATION is obsolete\r
/// Use EFI_MEMORY_CONTROLLER_INFORMATION_DATA instead\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
} EFI_MEMORY_CONTROLLER_INFORMATION;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 5.\r
///\r
///\r
/// Memory. Error Information - SMBIOS Type 18\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 18.\r
///\r
#define EFI_MEMORY_32BIT_ERROR_INFORMATION_RECORD_NUMBER 0x00000009\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 18.\r
///\r
-typedef enum { \r
+typedef enum {\r
EfiMemoryErrorOther = 1,\r
EfiMemoryErrorUnknown = 2,\r
EfiMemoryErrorOk = 3,\r
EfiMemoryErrorUnCorrectable = 14\r
} EFI_MEMORY_ERROR_TYPE;\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 18.\r
///\r
-typedef enum { \r
+typedef enum {\r
EfiMemoryGranularityOther = 1,\r
EfiMemoryGranularityOtherUnknown = 2,\r
EfiMemoryGranularityDeviceLevel = 3,\r
EfiMemoryGranularityMemPartitionLevel = 4\r
} EFI_MEMORY_ERROR_GRANULARITY_TYPE;\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 18.\r
///\r
-typedef enum { \r
+typedef enum {\r
EfiMemoryErrorOperationOther = 1,\r
EfiMemoryErrorOperationUnknown = 2,\r
EfiMemoryErrorOperationRead = 3,\r
EfiMemoryErrorOperationPartialWrite = 5\r
} EFI_MEMORY_ERROR_OPERATION_TYPE;\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 18.\r
///\r
///\r
/// Memory. Error Information - SMBIOS Type 33.\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 33.\r
///\r
#define EFI_MEMORY_64BIT_ERROR_INFORMATION_RECORD_NUMBER 0x0000000A\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 type 33.\r
///\r
} EFI_MEMORY_64BIT_ERROR_INFORMATION;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It is implementation-specific to simplify the code logic.\r
///\r
EFI_PHYSICAL_ADDRESS BiosStartingAddress;\r
EFI_EXP_BASE2_DATA BiosPhysicalDeviceSize;\r
EFI_MISC_BIOS_CHARACTERISTICS BiosCharacteristics1;\r
- EFI_MISC_BIOS_CHARACTERISTICS_EXTENSION \r
+ EFI_MISC_BIOS_CHARACTERISTICS_EXTENSION\r
BiosCharacteristics2;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this data structure and corrsponding fields are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 0.\r
///\r
UINT8 BiosMajorRelease;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this data structure and corrsponding fields are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 0.\r
///\r
UINT8 BiosMinorRelease;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this data structure and corrsponding fields are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 0.\r
///\r
UINT8 BiosEmbeddedFirmwareMajorRelease;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this data structure and corrsponding fields are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 0.\r
///\r
EFI_GUID SystemUuid;\r
EFI_MISC_SYSTEM_WAKEUP_TYPE SystemWakeupType;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this data structure and corrsponding fields are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 1.\r
///\r
STRING_REF SystemSKUNumber;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this data structure and corrsponding fields are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 1.\r
///\r
\r
typedef struct {\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass 0.9 specification, it has the incorrect field name "EFI_MISC_CHASSIS_TYPE".\r
/// Change it to "ChassisType" to pass build.\r
///\r
EFI_MISC_PORT_CONNECTOR_TYPE PortExternalConnectorType;\r
EFI_MISC_PORT_TYPE PortType;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this type of field is defined as EFI_DEVICE_PATH_PROTOCOL,\r
- /// which causes the implementation some complexity. Keep it unchanged for backward \r
+ /// which causes the implementation some complexity. Keep it unchanged for backward\r
/// compatibility.\r
///\r
EFI_MISC_PORT_DEVICE_PATH PortPath;\r
EfiSlotTypePci66MhzCapable = 0x0E,\r
EfiSlotTypeAgp = 0x0F,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, its naming should be EfiSlotTypeAgp2X\r
/// rather than EfiSlotTypeApg2X.\r
///\r
EfiSlotTypePC98LocalBus = 0xA3,\r
EfiSlotTypePC98Card = 0xA4,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, these fields aren't defined.\r
/// They're introduced for SmBios 2.6 specification type 9.\r
///\r
EfiSlotDataBusWidth64Bit = 0x06,\r
EfiSlotDataBusWidth128Bit = 0x07,\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, these fields aren't defined.\r
/// They're introduced for SmBios 2.6 specification type 9.\r
///\r
typedef struct {\r
STRING_REF OnBoardDeviceDescription;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the name is OnBoardDeviceType.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
// Portable Battery - SMBIOS Type 22\r
//\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the name is EFI_MISC_BATTERY_LOCATION_RECORD_NUMBER.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
#define EFI_MISC_PORTABLE_BATTERY_RECORD_NUMBER 0x00000010\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the structure name is EFI_MISC_BATTERY_DEVICE_CHEMISTRY.\r
/// And all field namings are also different with specification.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
-typedef enum { \r
+typedef enum {\r
EfiPortableBatteryDeviceChemistryOther = 1,\r
EfiPortableBatteryDeviceChemistryUnknown = 2,\r
EfiPortableBatteryDeviceChemistryLeadAcid = 3,\r
} EFI_MISC_PORTABLE_BATTERY_DEVICE_CHEMISTRY;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the structure name is EFI_MISC_BATTERY_LOCATION_DATA.\r
/// Also, the name and the order of the fields vary with specifications.\r
/// Keep it unchanged for backward compatibilty.\r
STRING_REF ManufactureDate;\r
STRING_REF SerialNumber;\r
STRING_REF DeviceName;\r
- EFI_MISC_PORTABLE_BATTERY_DEVICE_CHEMISTRY \r
+ EFI_MISC_PORTABLE_BATTERY_DEVICE_CHEMISTRY\r
DeviceChemistry;\r
UINT16 DesignCapacity;\r
UINT16 DesignVoltage;\r
UINT16 SBDSManufactureDate;\r
STRING_REF SBDSDeviceChemistry;\r
UINT8 DesignCapacityMultiplier;\r
- UINT32 OEMSpecific; \r
- UINT8 BatteryNumber; // Temporary \r
+ UINT32 OEMSpecific;\r
+ UINT8 BatteryNumber; // Temporary\r
BOOLEAN Valid; // Is entry valid - Temporary\r
} EFI_MISC_PORTABLE_BATTERY;\r
\r
#define EFI_MISC_HARDWARE_SECURITY_SETTINGS_DATA_RECORD_NUMBER 0x00000012\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// The MiscSubclass specification 0.9 only mentions the possible value of each field in\r
-/// EFI_MISC_HARDWARE_SECURITY_SETTINGS. \r
+/// EFI_MISC_HARDWARE_SECURITY_SETTINGS.\r
/// It's implementation-specific in order to to simplify the code logic.\r
///\r
typedef enum {\r
EFI_MISC_TEMPERATURE_PROBE_LOCATION\r
TemperatureProbeLocation;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// MiscSubclass 0.9 specification defines the fields type as EFI_EXP_BASE10_DATA.\r
/// In fact, they should be UINT16 type because they refer to 16bit width data.\r
/// Keeping this inconsistency for backward compatibility.\r
#define EFI_MISC_BOOT_INFORMATION_STATUS_RECORD_NUMBER 0x0000001A\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the structure name is EFI_MISC_BOOT_INFORMATION_STATUS_TYPE.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
\r
typedef struct {\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the field name is EFI_MISC_BOOT_INFORMATION_STATUS_TYPE.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
EFI_INTER_LINK_DATA ManagementDeviceLink;\r
EFI_INTER_LINK_DATA ManagementDeviceComponentLink;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this field is NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 35.\r
///\r
EFI_INTER_LINK_DATA ManagementDeviceThresholdLink;\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, this field is NOT defined.\r
/// It's implementation-specific to simplify the code logic.\r
///\r
\r
typedef struct {\r
EFI_MISC_IPMI_INTERFACE_TYPE IpmiInterfaceType;\r
- EFI_MISC_IPMI_SPECIFICATION_REVISION \r
+ EFI_MISC_IPMI_SPECIFICATION_REVISION\r
IpmiSpecificationRevision;\r
UINT16 IpmiI2CSlaveAddress;\r
UINT16 IpmiNvDeviceAddress;\r
///\r
/// System Power supply Record - SMBIOS Type 39\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the type of all fields are UINT32.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
} EFI_MISC_POWER_SUPPLY_CHARACTERISTICS;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the structure name is EFI_MISC_POWER_SUPPLY_UNIT_GROUP_DATA.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
///\r
/// OEM Data Record - SMBIOS Type 0x80-0xFF\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the structure name is EFI_SMBIOS_STRUCTURE_HDR.\r
/// Due to this, the structure is commonly used by vendors to construct SmBios type 0x80~0xFF table,\r
/// Keep it unchanged for backward compatibilty.\r
\r
typedef struct {\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the field name is EFI_SMBIOS_STRUCTURE_HDR.\r
/// Keep it unchanged for backward compatibilty.\r
///\r
///\r
/// Misc. System Event Log - SMBIOS Type 15\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 15.\r
///\r
#define EFI_MISC_SYSTEM_EVENT_LOG_RECORD_NUMBER 0x00000020\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 15.\r
///\r
// 0x00~0x04: as following definition\r
// 0x05~0x7f: Available for future assignment.\r
// 0x80~0xff: BIOS Vendor/OEM-specific.\r
-// \r
+//\r
#define ACCESS_INDEXIO_1INDEX8BIT_DATA8BIT 0x00\r
#define ACCESS_INDEXIO_2INDEX8BIT_DATA8BIT 0X01\r
#define ACCESS_INDEXIO_1INDEX16BIT_DATA8BIT 0X02\r
///\r
/// Management Device Threshold Data Record - SMBIOS Type 36\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 36.\r
///\r
#define EFI_MISC_MANAGEMENT_DEVICE_THRESHOLD_RECORD_NUMBER 0x00000021\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MiscSubclass specification 0.9, the following data structures are NOT defined.\r
/// It's introduced for SmBios 2.6 specification type 36.\r
///\r
typedef EFI_MISC_VOLTAGE_PROBE_DESCRIPTION_DATA EFI_MISC_VOLTAGE_PROBE_DESCRIPTION;\r
typedef EFI_MISC_COOLING_DEVICE_TEMP_LINK_DATA EFI_MISC_COOLING_DEVICE_TEMP_LINK;\r
typedef EFI_MISC_TEMPERATURE_PROBE_DESCRIPTION_DATA EFI_MISC_TEMPERATURE_PROBE_DESCRIPTION;\r
-typedef EFI_MISC_REMOTE_ACCESS_MANUFACTURER_DESCRIPTION_DATA \r
+typedef EFI_MISC_REMOTE_ACCESS_MANUFACTURER_DESCRIPTION_DATA\r
EFI_MISC_REMOTE_ACCESS_MANUFACTURER_DESCRIPTION;\r
typedef EFI_MISC_MANAGEMENT_DEVICE_DESCRIPTION_DATA EFI_MISC_MANAGEMENT_DEVICE_DESCRIPTION;\r
typedef EFI_MISC_ELECTRICAL_CURRENT_PROBE_DESCRIPTION_DATA EFI_MISC_ELECTRICAL_CURRENT_PROBE_DESCRIPTION;\r
EFI_MISC_MANAGEMENT_DEVICE_COMPONENT_DESCRIPTION;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It is implementation-specific to simplify the code logic.\r
///\r
} EFI_MISC_SUBCLASS_RECORDS;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In MemSubclass specification 0.9, the following data structures are NOT defined.\r
/// It is implementation-specific to simplify the code logic.\r
///\r
#pragma pack()\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In DataHubSubclass specification 0.9 page 16, the following symbol is NOT defined.\r
/// But value is meaningful, 0 means Reserved.\r
///\r
#define EFI_SUBCLASS_INSTANCE_RESERVED 0\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In DataHubSubclass specification 0.9 page 16, the following symbol is NOT defined.\r
/// But value is meaningful, -1 means Not Applicable.\r
///\r
Guid used to define the Firmware File System. See the Framework Firmware\r
File System Specification for more details.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
Definitions EFI_SMM_COMMUNICATE_HEADER used by EFI_SMM_BASE_PROTOCOL.Communicate()\r
functions.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
#define _SMM_COMMUNICATE_GUID_H_\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// GUID definition format has been changed, because the GUID format in the Framework specification is incorrect.\r
///\r
#define SMM_COMMUNICATE_HEADER_GUID \\r
* the GUID specific data structure of HOB for reserving SMRAM regions.\r
This GUIDed HOB can be used to convey the existence of the T-SEG reservation and H-SEG usage\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
/**\r
* GUID specific data structure of HOB for reserving SMRAM regions.\r
*\r
-* Inconsistent with specification here: \r
+* Inconsistent with specification here:\r
* EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.\r
* This inconsistency is kept in code in order for backward compatibility.\r
**/\r
typedef struct {\r
///\r
/// Designates the number of possible regions in the system\r
- /// that can be usable for SMRAM. \r
+ /// that can be usable for SMRAM.\r
///\r
- /// Inconsistent with specification here: \r
+ /// Inconsistent with specification here:\r
/// In Framework SMM CIS 0.91 specification, it defines the field type as UINTN.\r
/// However, HOBs are supposed to be CPU neutral, so UINT32 should be used instead.\r
///\r
UINT32 NumberOfSmmReservedRegions;\r
///\r
/// Used throughout this protocol to describe the candidate\r
- /// regions for SMRAM that are supported by this platform. \r
+ /// regions for SMRAM that are supported by this platform.\r
///\r
EFI_SMRAM_DESCRIPTOR Descriptor[1];\r
} EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;\r
execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it\r
by issuing the native IA-32 instruction.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
@param PeiServices A pointer to the system PEI Services Table.\r
@param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r
@param Address The physical memory address where the table is stored.\r
- It must be zero if the table to be executed is stored in \r
+ It must be zero if the table to be executed is stored in\r
a firmware volume file.\r
@param FvFile The firmware volume file name that contains the table to\r
- be executed. It must be NULL if the table to be executed \r
+ be executed. It must be NULL if the table to be executed\r
is stored in physical memory.\r
\r
@retval EFI_SUCCESS The boot script table was executed successfully.\r
@retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.\r
@retval EFI_UNSUPPORTED The format of the boot script table is invalid.\r
Or, an unsupported opcode occurred in the table.\r
- Or there were opcode execution errors, such as an \r
+ Or there were opcode execution errors, such as an\r
insufficient dependency.\r
\r
**/\r
);\r
\r
///\r
-/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and \r
+/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and\r
/// executes the Framework boot script table.\r
///\r
struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r
- ///\r
- /// Executes a boot script table.\r
- ///\r
- EFI_PEI_BOOT_SCRIPT_EXECUTE Execute; \r
+ ///\r
+ /// Executes a boot script table.\r
+ ///\r
+ EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;\r
};\r
\r
extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r
/** @file\r
This file declares FindFv PPI, which is used to locate FVs that contain PEIMs in PEI.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
#define _FIND_FV_H_\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// GUID value format has been changed to the standard GUID format.\r
///\r
#define EFI_PEI_FIND_FV_PPI_GUID \\r
/** @file\r
Load image file from fv to memory.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
/** @file\r
This file declares the PciCfg PPI used to access the PCI configuration space in PEI\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
This PPI is defined in PEI CIS\r
);\r
\r
/**\r
- The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI \r
+ The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI\r
controllers behind a PCI root bridge controller.\r
**/\r
struct _EFI_PEI_PCI_CFG_PPI {\r
/// PCI read services. See the Read() function description.\r
///\r
EFI_PEI_PCI_CFG_PPI_IO Read;\r
- \r
+\r
///\r
/// PCI write services. See the Write() function description.\r
///\r
EFI_PEI_PCI_CFG_PPI_IO Write;\r
- \r
+\r
///\r
/// PCI read-modify-write services. See the Modify() function description.\r
///\r
storage. As such, a write command to certain technologies would alter the contents of the entire part,\r
making the PEIM execution in the original position not follow the required flow.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004\r
///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
/// In Framework Spec, PeiCis0.91, neither the macro or its value is defined.\r
/// Keeping this inconsistancy for backward compatibility.\r
-/// \r
+///\r
#define EFI_VARIABLE_READ_ONLY 0x00000008\r
///@}\r
\r
/**\r
Get Variable value by Name and GUID pair.\r
\r
- @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published\r
by the PEI Foundation.\r
@param[in] VariableName A NULL-terminated Unicode string that is the name of the vendor's variable.\r
@param[in] VendorGuid A unique identifier for the vendor.\r
and on output the interface returns the next variable name data. When the\r
entire variable list has been returned, the error EFI_NOT_FOUND is returned.\r
\r
- @param[in] PeiServices An indirect pointer to the PEI Services Table \r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table\r
published by the PEI Foundation.\r
@param[in] VariableNameSize The size of the VariableName buffer.\r
@param[in] VariableName On input, supplies the last VariableName that was\r
- returned by GetNextVariableName(). On output, \r
- returns the Null-terminated Unicode string of the \r
+ returned by GetNextVariableName(). On output,\r
+ returns the Null-terminated Unicode string of the\r
current variable.\r
@param[in] VendorGuid On input, supplies the last VendorGuid that was\r
- returned by GetNextVariableName(). On output, \r
+ returned by GetNextVariableName(). On output,\r
returns the VendorGuid of the current variable.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_FOUND The next variable was not found.\r
@retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
- @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to \r
+ @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to\r
a hardware error.\r
\r
**/\r
\r
///\r
/// This PPI provides a lightweight, read-only variant of the full EFI\r
-/// variable services. \r
+/// variable services.\r
///\r
struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {\r
- ///\r
- /// Inconsistent with specification here: \r
+ ///\r
+ /// Inconsistent with specification here:\r
/// In Framework Spec, PeiCis0.91, the field is named as GetVariable and GetNextVariableName.\r
/// Keeping this inconsistancy for backward compatibility.\r
- /// \r
+ ///\r
EFI_PEI_GET_VARIABLE PeiGetVariable; ///< A service to ascertain a given variable name.\r
EFI_PEI_GET_NEXT_VARIABLE_NAME PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable\r
};\r
\r
extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r
\r
-#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */\r
+#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */\r
\r
/** @file\r
This file declares S3 Resume PPI which accomplishes the firmware S3 resume boot path\r
and transfers control to OS.\r
- \r
+\r
This PPI is published by the S3 resume PEIM and can be used on the S3 resume boot path to\r
restore the platform to its preboot configuration and transfer control to OS. The information that is\r
required for an S3 resume can be saved during the normal boot path using\r
- OS waking vector.\r
- The reserved memory range to be used for the S3 resume.\r
Otherwise, the S3 resume boot path may fail.\r
- \r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
@param PeiServices The pointer to the PEI Services Table\r
\r
@retval EFI_ABORTED Execution of the S3 resume boot script table failed.\r
- @retval EFI_NOT_FOUND Could not be locate some necessary information that \r
+ @retval EFI_NOT_FOUND Could not be locate some necessary information that\r
is used for the S3 resume boot path d.\r
\r
**/\r
This PPI is defined in PEI CIS version 0.91. It supports encapsulating sections,\r
such as GUIDed sections used to authenticate the file encapsulation of other domain-specific wrapping.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
\r
@param PeiServices The pointer to the PEI Services Table.\r
@param This Indicates the calling context\r
- @param SectionType The pointer to an EFI_SECTION_TYPE. If \r
- SectionType == NULL, the contents of the entire \r
+ @param SectionType The pointer to an EFI_SECTION_TYPE. If\r
+ SectionType == NULL, the contents of the entire\r
section are returned in Buffer. If SectionType\r
is not NULL, only the requested section is returned.\r
@param SectionDefinitionGuid The pointer to an EFI_GUID.\r
- If SectionType == EFI_SECTION_GUID_DEFINED, \r
- SectionDefinitionGuid indicates for which section \r
- GUID to search. If SectionType != EFI_SECTION_GUID_DEFINED, \r
+ If SectionType == EFI_SECTION_GUID_DEFINED,\r
+ SectionDefinitionGuid indicates for which section\r
+ GUID to search. If SectionType != EFI_SECTION_GUID_DEFINED,\r
SectionDefinitionGuid is unused and is ignored.\r
@param SectionInstance If SectionType is not NULL, indicates which\r
instance of the requested section type to return.\r
- @param Buffer The pointer to a pointer to a buffer in which the \r
+ @param Buffer The pointer to a pointer to a buffer in which the\r
section contents are returned.\r
- @param BufferSize A pointer to a caller-allocated UINT32. On input, \r
- *BufferSize indicates the size in bytes of the \r
+ @param BufferSize A pointer to a caller-allocated UINT32. On input,\r
+ *BufferSize indicates the size in bytes of the\r
memory region pointed to by Buffer. On output,\r
- *BufferSize contains the number of bytes required \r
+ *BufferSize contains the number of bytes required\r
to read the section.\r
@param AuthenticationStatus A pointer to a caller-allocated UINT32 in\r
- which any metadata from encapsulating GUID-defined \r
+ which any metadata from encapsulating GUID-defined\r
sections is returned.\r
\r
@retval EFI_SUCCESS The section was successfully processed, and the section\r
contents were returned in Buffer.\r
@retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in\r
- the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED \r
- bit set, but there was no corresponding GUIDed \r
- Section Extraction Protocol in the handle database. \r
+ the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED\r
+ bit set, but there was no corresponding GUIDed\r
+ Section Extraction Protocol in the handle database.\r
*Buffer is unmodified.\r
- @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is \r
+ @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is\r
unmodified.\r
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process \r
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process\r
the request.\r
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
@retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to\r
- contain the requested section. The input buffer \r
- is filled and contents are section contents are \r
+ contain the requested section. The input buffer\r
+ is filled and contents are section contents are\r
truncated.\r
\r
**/\r
/** @file\r
This file declares the Security Architectural PPI.\r
- \r
+\r
This PPI is installed by a platform PEIM that abstracts the security policy to the PEI\r
Foundation, namely the case of a PEIM's authentication state being returned during the PEI section\r
extraction process.\r
- \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
to varying file authentication states.\r
\r
@param PeiServices The pointer to the PEI Services Table.\r
- @param This Interface pointer that implements the particular \r
+ @param This Interface pointer that implements the particular\r
EFI_PEI_SECURITY_PPI instance.\r
- @param AuthenticationStatus Status returned by the verification service as \r
+ @param AuthenticationStatus Status returned by the verification service as\r
part of section extraction.\r
@param FfsFileHeader The pointer to the file under review.\r
- @param DeferExecution The pointer to a variable that alerts the PEI \r
+ @param DeferExecution The pointer to a variable that alerts the PEI\r
Foundation to defer execution of a PEIM.\r
\r
@retval EFI_SUCCESS The service performed its action successfully.\r
/** @file\r
- This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM \r
+ This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM\r
uses to access its SMBus controller and the slave devices attached to it.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
@param[in] SlaveAddress The SMBUS hardware address to which the SMBUS\r
device is preassigned or allocated.\r
@param[in] Command This command is transmitted by the SMBus host\r
- controller to the SMBus slave device, and the \r
+ controller to the SMBus slave device, and the\r
interpretation is SMBus slave device specific.\r
@param[in] Operation Signifies which particular SMBus hardware protocol\r
instance to use to execute the SMBus transactions.\r
- @param[in] PecCheck Defines if Packet Error Code (PEC) checking is \r
+ @param[in] PecCheck Defines if Packet Error Code (PEC) checking is\r
required for this operation.\r
@param[in, out] Length The number of bytes for this operation.\r
- @param[in, out] Buffer Contains the value of data to execute to the SMBus \r
+ @param[in, out] Buffer Contains the value of data to execute to the SMBus\r
slave device.\r
\r
@retval EFI_SUCCESS The last data that was returned from the access\r
@retval EFI_DEVICE_ERROR The request was not completed because a failure\r
was recorded in the Host Status Register bit.\r
@retval EFI_INVALID_PARAMETER The operation is not defined in EFI_SMBUS_OPERATION.\r
- @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for \r
- EfiSmbusQuickRead and EfiSmbusQuickWrite. Length \r
+ @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for\r
+ EfiSmbusQuickRead and EfiSmbusQuickWrite. Length\r
is outside the range of valid values.\r
@retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.\r
@retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.\r
\r
@param[in] PeiServices A pointer to the system PEI Services Table.\r
@param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
- @param[in] ArpAll A Boolean expression that indicates if the host \r
- drivers need to enumerate all the devices or to \r
+ @param[in] ArpAll A Boolean expression that indicates if the host\r
+ drivers need to enumerate all the devices or to\r
enumerate only the device that is identified\r
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and \r
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and\r
SlaveAddress are optional and ignored if entered.\r
- If ArpAll is FALSE, ArpDevice will enumerate \r
+ If ArpAll is FALSE, ArpDevice will enumerate\r
SmbusUdid, and the address will be at SlaveAddress.\r
@param[in] SmbusUdid The targeted SMBus Unique Device Identifier (UDID).\r
- The UDID may not exist for SMBus devices with fixed \r
+ The UDID may not exist for SMBus devices with fixed\r
addresses.\r
@param[in, out] SlaveAddress The new SMBus address for the slave device for\r
which the operation is targeted.\r
due to a lack of resources.\r
@retval EFI_TIMEOUT The SMBus slave device did not respond.\r
@retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.\r
- @retval EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM. \r
+ @retval EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM.\r
This return value is not defined in the Framework Specification.\r
This return value was introduced in the PI Specification.\r
\r
by the SMBus controller driver.\r
\r
@retval EFI_SUCCESS The device map was returned correctly in the buffer.\r
- @retval EFI_UNSUPPORTED GetArpMap() are not implemented by this PEIM. \r
+ @retval EFI_UNSUPPORTED GetArpMap() are not implemented by this PEIM.\r
This return value was not defined in the Framework Specification.\r
This return value was introduced in the PI Specification.\r
\r
);\r
\r
/**\r
- Allows a device driver to register for a callback when the bus driver detects a state that it needs to \r
+ Allows a device driver to register for a callback when the bus driver detects a state that it needs to\r
propagate to other PEIMs that are registered for a callback.\r
\r
The Notify() function registers all the callback functions to allow the\r
detects the SlaveAddress and Data pair.\r
\r
@retval EFI_SUCCESS NotifyFunction has been registered.\r
- @retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM. \r
+ @retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM.\r
This return value is not defined in the Framework Specification.\r
This return value was introduced in the PI Specification.\r
\r
/// Executes the SMBus operation to an SMBus slave device.\r
///\r
EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;\r
- \r
+\r
///\r
/// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
///\r
EFI_PEI_SMBUS_PPI_ARP_DEVICE ArpDevice;\r
- \r
+\r
///\r
/// Allows a PEIM to retrieve the address that was allocated by the SMBus\r
- /// host controller during enumeration/ARP. \r
+ /// host controller during enumeration/ARP.\r
///\r
EFI_PEI_SMBUS_PPI_GET_ARP_MAP GetArpMap;\r
- \r
+\r
///\r
/// Allows a driver to register for a callback to the SMBus host\r
- /// controller driver when the bus issues a notification to the bus controller PEIM. \r
+ /// controller driver when the bus issues a notification to the bus controller PEIM.\r
///\r
EFI_PEI_SMBUS_PPI_NOTIFY Notify;\r
};\r
/** @file\r
This protocol is used to prepare all information that is needed for the S3 resume boot path. This\r
protocol is not required for all platforms.\r
- \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
This Protocol is defined in Framework of S3 Resume Boot Path Spec.\r
Version 0.9.\r
- \r
+\r
**/\r
\r
#ifndef _ACPI_S3_SAVE_PROTOCOL_H_\r
//\r
\r
/**\r
- This function is used to:\r
- \r
+ This function is used to:\r
+\r
- Prepare all information that is needed in the S3 resume boot path. This information can include\r
the following:\r
-- Framework boot script table\r
-- RSDT pointer\r
-- Reserved memory for the S3 resume\r
- \r
+\r
- Get the minimum legacy memory length (meaning below 1 MB) that is required for the S3 resume boot path.\r
If LegacyMemoryAddress is NULL, the firmware will be unable to jump into a real-mode\r
waking vector. However, it might still be able to jump into a flat-mode waking vector as long as the\r
@retval EFI_SUCCESS All information was saved successfully.\r
@retval EFI_INVALID_PARAMETER The memory range is not located below 1 MB.\r
@retval EFI_OUT_OF_RESOURCES Resources were insufficient to save all the information.\r
- @retval EFI_NOT_FOUND Some necessary information cannot be found. \r
+ @retval EFI_NOT_FOUND Some necessary information cannot be found.\r
\r
**/\r
typedef\r
scope of this specification.\r
\r
@param This A pointer to the EFI_ACPI_S3_SAVE_PROTOCOL instance.\r
- @param Size The returned size of legacy memory below 1MB.\r
+ @param Size The returned size of legacy memory below 1MB.\r
\r
@retval EFI_SUCCESS Size was successfully returned.\r
@retval EFI_INVALID_PARAMETER The pointer Size is NULL.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
- ACPI table information, such as RSDT, through which the OS waking vector can be located.\r
- The range of reserved memory that can be used on the S3 resume boot path.\r
This protocol can be used after the Framework makes sure that the boot process is complete and\r
- that no hardware has been left unconfigured. Where to call this protocol to save information is implementation-specific. \r
+ that no hardware has been left unconfigured. Where to call this protocol to save information is implementation-specific.\r
In the case of an EFI-aware OS, ExitBootServices() can be a choice to provide this hook.\r
The currently executing EFI OS loader image calls ExitBootServices()to terminate all boot\r
services. After ExitBootServices() successfully completes, the loader becomes responsible\r
/// Gets the size of legacy memory below 1 MB that is required for S3 resume.\r
///\r
EFI_ACPI_GET_LEGACY_MEMORY_SIZE GetLegacyMemorySize;\r
- \r
+\r
///\r
/// Prepare all information for an S3 resume.\r
///\r
services handle many of the more mundane tasks that are required to publish a set of tables. The\r
services will:\r
- Generate common tables.\r
- - Update the table links.\r
- - Ensure that tables are properly aligned and use correct types of memory.\r
- - Update checksum values and IDs.\r
- - Complete the final installation of the tables.\r
- \r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+ - Update the table links.\r
+ - Ensure that tables are properly aligned and use correct types of memory.\r
+ - Update checksum values and IDs.\r
+ - Complete the final installation of the tables.\r
+\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
Causes one or more versions of the ACPI tables to be published in\r
the EFI system configuration tables.\r
\r
- The PublishTables() function installs the ACPI tables for the versions that are specified in \r
- Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once \r
- published, tables will continue to be updated as tables are modified with \r
- EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable(). \r
+ The PublishTables() function installs the ACPI tables for the versions that are specified in\r
+ Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once\r
+ published, tables will continue to be updated as tables are modified with\r
+ EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable().\r
\r
@param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
@param Version Indicates to which version(s) of ACPI the table should be published.\r
/** @file\r
- This protocol is used to store or record various boot scripts into boot \r
+ This protocol is used to store or record various boot scripts into boot\r
script tables.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
/** @file\r
- This code abstracts the CPU IO Protocol which installed by some platform or chipset-specific \r
- PEIM that abstracts the processor-visible I/O operations. \r
- \r
+ This code abstracts the CPU IO Protocol which installed by some platform or chipset-specific\r
+ PEIM that abstracts the processor-visible I/O operations.\r
+\r
Note: This is a runtime protocol and can be used by runtime drivers after ExitBootServices().\r
It is different from the PI 1.2 CPU I/O 2 Protocol, which is a boot services only protocol\r
and may not be used by runtime drivers after ExitBootServices().\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
}\r
\r
//\r
-// Framework CPU IO protocol structure is the same as CPU IO 2 protocol defined in PI 1.2 spec. \r
+// Framework CPU IO protocol structure is the same as CPU IO 2 protocol defined in PI 1.2 spec.\r
// However, there is a significant different between the Framework CPU I/O\r
// Protocol and the PI 1.2 CPU I/O 2 Protocol. The Framework one is a runtime\r
// protocol, which means it can be used by runtime drivers after ExitBootServices().\r
// The PI one is not runtime safe, so it is a boot services only protocol and may\r
// not be used by runtime drivers after ExitBootServices().\r
-// \r
+//\r
typedef EFI_CPU_IO2_PROTOCOL EFI_CPU_IO_PROTOCOL;\r
\r
extern EFI_GUID gEfiCpuIoProtocolGuid;\r
data and those wishing to be made aware of all information that\r
has been logged. This protocol may only be called <= TPL_NOTIFY.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
// data. The format of the data is defined by the DataRecordGuid.\r
//\r
// If EFI_DATA_RECORD_HEADER is extended in the future, the Version number and HeaderSize must\r
-// change. \r
+// change.\r
//\r
// The logger is responcible for initializing:\r
// Version, HeaderSize, RecordSize, DataRecordGuid, DataRecordClass\r
\r
@param This The EFI_DATA_HUB_PROTOCOL instance.\r
@param MonotonicCount On input, it specifies the Record to return.\r
- An input of zero means to return the first record, \r
+ An input of zero means to return the first record,\r
as does an input of one.\r
@param FilterDriver If FilterDriver is not passed in a MonotonicCount\r
- of zero, it means to return the first data record. \r
- If FilterDriver is passed in, then a MonotonicCount \r
+ of zero, it means to return the first data record.\r
+ If FilterDriver is passed in, then a MonotonicCount\r
of zero means to return the first data not yet read\r
by FilterDriver.\r
- @param Record Returns a dynamically allocated memory buffer with \r
+ @param Record Returns a dynamically allocated memory buffer with\r
a data record that matches MonotonicCount.\r
\r
@retval EFI_SUCCESS Data was returned in Record.\r
@retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.\r
@retval EFI_NOT_FOUND MonotonicCount does not match any data record\r
- in the system. If a MonotonicCount of zero was \r
+ in the system. If a MonotonicCount of zero was\r
passed in, then no data records exist in the system.\r
@retval EFI_OUT_OF_RESOURCES Record was not returned due to lack\r
of system resources.\r
- @note Inconsistent with specification here: \r
- In Framework for EFI Data Hub Specification, Version 0.9, This definition \r
- is named as EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is \r
- maintained for backward compatibility. \r
+ @note Inconsistent with specification here:\r
+ In Framework for EFI Data Hub Specification, Version 0.9, This definition\r
+ is named as EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is\r
+ maintained for backward compatibility.\r
**/\r
typedef\r
EFI_STATUS\r
@param This The EFI_DATA_HUB_PROTOCOL instance.\r
@param FilterEvent The EFI_EVENT to signal whenever data that matches\r
FilterClass is logged in the system.\r
- @param FilterTpl The maximum EFI_TPL at which FilterEvent can be \r
- signaled. It is strongly recommended that you use \r
- the lowest EFI_TPL possible. \r
+ @param FilterTpl The maximum EFI_TPL at which FilterEvent can be\r
+ signaled. It is strongly recommended that you use\r
+ the lowest EFI_TPL possible.\r
@param FilterClass FilterEvent will be signaled whenever a bit\r
- in EFI_DATA_RECORD_HEADER.DataRecordClass is also \r
- set in FilterClass. If FilterClass is zero, no \r
+ in EFI_DATA_RECORD_HEADER.DataRecordClass is also\r
+ set in FilterClass. If FilterClass is zero, no\r
class-based filtering will be performed.\r
@param FilterDataRecordGuid FilterEvent will be signaled whenever\r
- FilterDataRecordGuid matches \r
- EFI_DATA_RECORD_HEADER.DataRecordGuid. \r
- If FilterDataRecordGuid is NULL, then no GUID-based \r
+ FilterDataRecordGuid matches\r
+ EFI_DATA_RECORD_HEADER.DataRecordGuid.\r
+ If FilterDataRecordGuid is NULL, then no GUID-based\r
filtering will be performed.\r
\r
@retval EFI_SUCCESS The filter driver event was registered\r
- @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot \r
+ @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot\r
be registered again.\r
@retval EFI_OUT_OF_RESOURCES The filter driver event was not registered\r
due to lack of system resources.\r
- @note Inconsistent with specification here: \r
- In Framework for EFI Data Hub Specification, Version 0.9, This definition \r
- is named as EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency \r
- is maintained for backward compatibility. \r
+ @note Inconsistent with specification here:\r
+ In Framework for EFI Data Hub Specification, Version 0.9, This definition\r
+ is named as EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency\r
+ is maintained for backward compatibility.\r
**/\r
typedef\r
EFI_STATUS\r
\r
@retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.\r
@retval EFI_NOT_FOUND FilterEvent did not exist.\r
- @note Inconsistent with specification here: \r
- In Framework for EFI Data Hub Specification, Version 0.9, This definition \r
- is named as EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency \r
- is maintained for backward compatibility. \r
+ @note Inconsistent with specification here:\r
+ In Framework for EFI Data Hub Specification, Version 0.9, This definition\r
+ is named as EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency\r
+ is maintained for backward compatibility.\r
**/\r
typedef\r
EFI_STATUS\r
///\r
/// Logs a data record.\r
///\r
- EFI_DATA_HUB_LOG_DATA LogData; \r
- \r
+ EFI_DATA_HUB_LOG_DATA LogData;\r
+\r
///\r
/// Gets a data record. Used both to view the memory-based log and to\r
/// get information about which data records have been consumed by a filter driver.\r
///\r
EFI_DATA_HUB_GET_NEXT_RECORD GetNextRecord;\r
- \r
+\r
///\r
/// Allows the registration of an EFI event to act as a filter driver for all data records that are logged.\r
///\r
EFI_DATA_HUB_REGISTER_FILTER_DRIVER RegisterFilterDriver;\r
- \r
+\r
///\r
/// Used to remove a filter driver that was added with RegisterFilterDriver().\r
///\r
/** @file\r
This file declares the Firmware Volume Protocol.\r
- \r
+\r
The Firmware Volume Protocol provides file-level access to the firmware volume.\r
Each firmware volume driver must produce an instance of the Firmware Volume\r
Protocol if the firmware volume is to be visible to the system. The Firmware\r
Volume Protocol also provides mechanisms for determining and modifying some\r
attributes of the firmware volume.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
Sets volume attributes\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param Attributes On input, Attributes is a pointer to an \r
- EFI_FV_ATTRIBUTES containing the desired firmware \r
- volume settings. On successful return, it contains \r
- the new settings of the firmware volume. On \r
- unsuccessful return, Attributes is not modified \r
+ @param Attributes On input, Attributes is a pointer to an\r
+ EFI_FV_ATTRIBUTES containing the desired firmware\r
+ volume settings. On successful return, it contains\r
+ the new settings of the firmware volume. On\r
+ unsuccessful return, Attributes is not modified\r
and the firmware volume settings are not changed.\r
\r
@retval EFI_INVALID_PARAMETER A bit in Attributes was invalid.\r
- @retval EFI_SUCCESS The requested firmware volume attributes were set \r
+ @retval EFI_SUCCESS The requested firmware volume attributes were set\r
and the resulting EFI_FV_ATTRIBUTES is returned in\r
Attributes.\r
- @retval EFI_ACCESS_DENIED The Device is locked and does not permit modification. \r
+ @retval EFI_ACCESS_DENIED The Device is locked and does not permit modification.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- Read the requested file (NameGuid) or file information from the firmware volume \r
+ Read the requested file (NameGuid) or file information from the firmware volume\r
and returns data in Buffer.\r
\r
@param This The EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param NameGuid The pointer to EFI_GUID, which is the filename of \r
+ @param NameGuid The pointer to EFI_GUID, which is the filename of\r
the file to read.\r
@param Buffer The pointer to pointer to buffer in which contents of file are returned.\r
<br>\r
- If Buffer is NULL, only type, attributes, and size \r
+ If Buffer is NULL, only type, attributes, and size\r
are returned as there is no output buffer.\r
<br>\r
- If Buffer != NULL and *Buffer == NULL, the output \r
+ If Buffer != NULL and *Buffer == NULL, the output\r
buffer is allocated from BS pool by ReadFile.\r
<br>\r
- If Buffer != NULL and *Buffer != NULL, the output \r
- buffer has been allocated by the caller and is being \r
+ If Buffer != NULL and *Buffer != NULL, the output\r
+ buffer has been allocated by the caller and is being\r
passed in.\r
@param BufferSize On input: The buffer size. On output: The size\r
required to complete the read.\r
- @param FoundType The pointer to the type of the file whose data \r
+ @param FoundType The pointer to the type of the file whose data\r
is returned.\r
@param FileAttributes The pointer to attributes of the file whose data\r
is returned.\r
@retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output.\r
The buffer filled, and the output is truncated.\r
@retval EFI_NOT_FOUND NameGuid was not found in the firmware volume.\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to \r
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to\r
access the firmware volume.\r
@retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads.\r
@retval EFI_OUT_OF_RESOURCES An allocation failure occurred.\r
@param NameGuid Filename identifying the file from which to read.\r
@param SectionType The section type to retrieve.\r
@param SectionInstance The instance of SectionType to retrieve.\r
- @param Buffer Pointer to pointer to buffer in which contents of \r
+ @param Buffer Pointer to pointer to buffer in which contents of\r
a file are returned.\r
<br>\r
If Buffer is NULL, only type, attributes, and size\r
are returned as there is no output buffer.\r
<br>\r
- If Buffer != NULL and *Buffer == NULL, the output \r
+ If Buffer != NULL and *Buffer == NULL, the output\r
buffer is allocated from BS pool by ReadFile.\r
<br>\r
- If Buffer != NULL and *Buffer != NULL, the output \r
- buffer has been allocated by the caller and is being \r
+ If Buffer != NULL and *Buffer != NULL, the output\r
+ buffer has been allocated by the caller and is being\r
passed in.\r
- @param BufferSize The pointer to the buffer size passed in, and on \r
+ @param BufferSize The pointer to the buffer size passed in, and on\r
output the size required to complete the read.\r
@param AuthenticationStatus The pointer to the authentication status of the data.\r
\r
@retval EFI_SUCCESS The call completed successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output. \r
+ @retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output.\r
The buffer is filled and the output is truncated.\r
@retval EFI_OUT_OF_RESOURCES An allocation failure occurred.\r
@retval EFI_NOT_FOUND The name was not found in the firmware volume.\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to \r
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to\r
access the firmware volume.\r
@retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads.\r
\r
Write the supplied file (NameGuid) to the FV.\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param NumberOfFiles Indicates the number of file records pointed to \r
+ @param NumberOfFiles Indicates the number of file records pointed to\r
by FileData.\r
- @param WritePolicy Indicates the level of reliability of the write \r
+ @param WritePolicy Indicates the level of reliability of the write\r
with respect to things like power failure events.\r
- @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA \r
- structures. Each element in the array indicates \r
+ @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA\r
+ structures. Each element in the array indicates\r
a file to write, and there are NumberOfFiles\r
elements in the input array.\r
\r
@retval EFI_SUCCESS The write completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free \r
+ @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free\r
space to store file(s).\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to \r
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to\r
access the firmware volume.\r
@retval EFI_WRITE_PROTECTED The firmware volume is configured to disallow writes.\r
- @retval EFI_NOT_FOUND A delete was requested, but the requested file was \r
+ @retval EFI_NOT_FOUND A delete was requested, but the requested file was\r
not found in the firmware volume.\r
@retval EFI_INVALID_PARAMETER A delete was requested with a multiple file write.\r
An unsupported WritePolicy was requested.\r
Given the input key, search for the next matching file in the volume.\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param Key Pointer to a caller allocated buffer that contains \r
- an implementation-specific key that is used to track \r
+ @param Key Pointer to a caller allocated buffer that contains\r
+ an implementation-specific key that is used to track\r
where to begin searching on successive calls.\r
@param FileType The pointer to the file type to filter for.\r
@param NameGuid The pointer to Guid filename of the file found.\r
@param Attributes The pointer to Attributes of the file found.\r
@param Size The pointer to Size in bytes of the file found.\r
\r
- @retval EFI_SUCCESS The output parameters are filled with data obtained from \r
+ @retval EFI_SUCCESS The output parameters are filled with data obtained from\r
the first matching file that was found.\r
@retval EFI_NOT_FOUND No files of type FileType were found.\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access \r
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access\r
the firmware volume.\r
@retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads.\r
\r
/** @file\r
This file provides control over block-oriented firmware devices.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+http://opensource.org/licenses/bsd-license.php.\r
\r
- @par Revision Reference: \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
This protocol is defined in framework spec: Firmware Volume Block Specification.\r
\r
**/\r
typedef struct _FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL;\r
///\r
/// The type of EFI FVB attribute per the Framework specification.\r
-/// \r
+///\r
typedef UINT32 EFI_FVB_ATTRIBUTES;\r
\r
/**\r
The GetAttributes() function retrieves the attributes and\r
- current settings of the block. \r
+ current settings of the block.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
\r
@param Attributes Pointer to EFI_FVB_ATTRIBUTES in which the\r
attributes and current settings are\r
- returned. \r
+ returned.\r
\r
@retval EFI_SUCCESS The firmware volume attributes were\r
returned.\r
EFI_FVB_ATTRIBUTES that contains the\r
desired firmware volume settings. On\r
successful return, it contains the new\r
- settings of the firmware volume. \r
- \r
+ settings of the firmware volume.\r
+\r
@retval EFI_SUCCESS The firmware volume attributes were returned.\r
\r
@retval EFI_INVALID_PARAMETER The attributes requested are in\r
only for memory-mapped firmware volumes.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
- \r
+\r
@param Address Pointer to a caller-allocated\r
EFI_PHYSICAL_ADDRESS that, on successful\r
return from GetPhysicalAddress(), contains the\r
base address of the firmware volume.\r
- \r
+\r
@retval EFI_SUCCESS The firmware volume base address is returned.\r
- \r
+\r
@retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
\r
**/\r
blocks in this range have a size of\r
BlockSize.\r
\r
- \r
+\r
@retval EFI_SUCCESS The firmware volume base address was returned.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.\r
\r
**/\r
aware that a read may be partially completed.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
- \r
+\r
@param Lba The starting logical block index\r
from which to read.\r
\r
\r
@retval EFI_SUCCESS The firmware volume was read successfully\r
and contents are in Buffer.\r
- \r
+\r
@retval EFI_BAD_BUFFER_SIZE A read was attempted across an LBA\r
boundary. On output, NumBytes\r
contains the total number of bytes\r
returned in Buffer.\r
- \r
+\r
@retval EFI_ACCESS_DENIED The firmware volume is in the\r
ReadDisabled state.\r
- \r
+\r
@retval EFI_DEVICE_ERROR The block device is not\r
functioning correctly and could\r
not be read.\r
EraseBlocks() function first to erase the specified block to\r
write. A block erase cycle will transition bits from the\r
(NOT)EFI_FVB_ERASE_POLARITY state back to the\r
- EFI_FVB_ERASE_POLARITY state. Implementors should note \r
+ EFI_FVB_ERASE_POLARITY state. Implementors should note\r
that the firmware volume might be in the WriteDisabled\r
state. If it is in this state, the Write() function must\r
return the status code EFI_ACCESS_DENIED without modifying the\r
returns.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
- \r
+\r
@param Lba The starting logical block index to write to.\r
- \r
+\r
@param Offset Offset into the block at which to begin writing.\r
- \r
+\r
@param NumBytes The pointer to a UINTN. Input: the total size of the buffer.\r
Output: the total number of bytes actually written.\r
- \r
+\r
@param Buffer The pointer to a caller-allocated buffer that\r
contains the source for the write.\r
- \r
+\r
@retval EFI_SUCCESS The firmware volume was written successfully.\r
- \r
+\r
@retval EFI_BAD_BUFFER_SIZE The write was attempted across an\r
LBA boundary. On output, NumBytes\r
contains the total number of bytes\r
actually written.\r
- \r
+\r
@retval EFI_ACCESS_DENIED The firmware volume is in the\r
WriteDisabled state.\r
- \r
+\r
@retval EFI_DEVICE_ERROR The block device is malfunctioning\r
and could not be written.\r
\r
\r
@retval EFI_SUCCESS The erase request successfully\r
completed.\r
- \r
+\r
@retval EFI_ACCESS_DENIED The firmware volume is in the\r
WriteDisabled state.\r
@retval EFI_DEVICE_ERROR The block device is not functioning\r
partially erased.\r
@retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r
in the variable argument list do\r
- not exist in the firmware volume. \r
+ not exist in the firmware volume.\r
\r
**/\r
typedef\r
FRAMEWORK_EFI_FVB_ERASE_BLOCKS EraseBlocks;\r
///\r
/// The handle of the parent firmware volume.\r
- /// \r
+ ///\r
EFI_HANDLE ParentHandle;\r
};\r
\r
packet of data. This will also allow the caller to post messages\r
into the configuration drivers internal mailbox.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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: FrameworkFormBrowser.h\r
\r
@param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.\r
@param UseDatabase Determines whether the HII database is to be\r
- used to gather information. If the value is FALSE, \r
- the configuration driver will get the information \r
+ used to gather information. If the value is FALSE,\r
+ the configuration driver will get the information\r
provided in the passed-in Packet parameters.\r
- @param Handle A pointer to an array of HII handles to display. \r
- This value should correspond to the value of the \r
+ @param Handle A pointer to an array of HII handles to display.\r
+ This value should correspond to the value of the\r
HII form package that is required to be displayed.\r
@param HandleCount The number of handles in the array specified by Handle.\r
@param Packet A pointer to a set of data containing pointers to IFR\r
and/or string data.\r
@param CallbackHandle The handle to the driver's callback interface.\r
- This parameter is used only when the UseDatabase \r
- parameter is FALSE and an application wants to \r
+ This parameter is used only when the UseDatabase\r
+ parameter is FALSE and an application wants to\r
register a callback with the browser.\r
@param NvMapOverride This buffer is used only when there is no NV variable\r
- to define the current settings and the caller needs \r
- to provide to the browser the current settings for \r
+ to define the current settings and the caller needs\r
+ to provide to the browser the current settings for\r
the "fake" NV variable.\r
@param ScreenDimensions Allows the browser to be called so that it occupies\r
- a portion of the physical screen instead of dynamically \r
+ a portion of the physical screen instead of dynamically\r
determining the screen dimensions.\r
@param ResetRequired This BOOLEAN value denotes whether a reset is required\r
- based on the data that might have been changed. \r
- The ResetRequired parameter is primarily applicable \r
+ based on the data that might have been changed.\r
+ The ResetRequired parameter is primarily applicable\r
for configuration applications, and is an\r
optional parameter.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_FOUND The variable was not found.\r
@retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.\r
- DataSize has been updated with the size needed to \r
+ DataSize has been updated with the size needed to\r
complete the request.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
@retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r
\r
@param NumberOfLines The number of lines for the dialog box.\r
@param HotKey Defines whether a single character is parsed (TRUE)\r
- and returned in KeyValue, or if a string is returned \r
+ and returned in KeyValue, or if a string is returned\r
in StringBuffer.\r
@param MaximumStringSize The maximum size in bytes of a typed-in string.\r
- Because each character is a CHAR16, the minimum \r
+ Because each character is a CHAR16, the minimum\r
string returned is two bytes.\r
@param StringBuffer The passed-in pointer to the buffer that will hold\r
the typed in string if HotKey is FALSE.\r
/// a pointer to the calling driver's callback interface.\r
///\r
EFI_SEND_FORM SendForm;\r
- \r
+\r
///\r
/// Routine used to abstract a generic dialog interface and return the\r
- /// selected key or string. \r
+ /// selected key or string.\r
///\r
EFI_CREATE_POP_UP CreatePopUp;\r
};\r
specific drivers that want to export access to custom hardware storage or\r
publish IFR that need to call back the original driver.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
typedef struct _EFI_FORM_CALLBACK_PROTOCOL EFI_FORM_CALLBACK_PROTOCOL;\r
\r
///\r
-/// Inconsistent with specification here: \r
-/// RESET_REQUIRED, EXIT_REQUIRED, SAVE_REQUIRED, NV_CHANGED and NV_NOT_CHANGED are not \r
+/// Inconsistent with specification here:\r
+/// RESET_REQUIRED, EXIT_REQUIRED, SAVE_REQUIRED, NV_CHANGED and NV_NOT_CHANGED are not\r
/// defined in HII specification. These Flags of EFI_IFR_DATA_ENTRY should be defined\r
/// to describe the standard behavior of the browser after the callback.\r
///\r
/// If this flag is set, the browser will exit and reset after processing callback results.\r
///\r
-#define RESET_REQUIRED 1 \r
+#define RESET_REQUIRED 1\r
///\r
/// If this flag is set, the browser will exit after processing callback results.\r
///\r
\r
@param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
@param VariableName A NULL-terminated Unicode string that is the\r
- name of the vendor's variable. Each VariableName \r
- is unique for each VendorGuid. \r
+ name of the vendor's variable. Each VariableName\r
+ is unique for each VendorGuid.\r
@param VendorGuid A unique identifier for the vendor.\r
@param Attributes Attributes bit-mask to set for the variable.\r
- Inconsistent with specification here: \r
- Attributes data type has been changed from \r
+ Inconsistent with specification here:\r
+ Attributes data type has been changed from\r
UINT32 * to UINT32, because the input parameter is\r
not necessary to use a pointer date type.\r
@param DataSize The size in bytes of the Buffer. A size of zero causes\r
\r
@param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
@param KeyValue A unique value which is sent to the original exporting\r
- driver so that it can identify the type of data \r
- to expect. The format of the data tends to vary based \r
+ driver so that it can identify the type of data\r
+ to expect. The format of the data tends to vary based\r
on the opcode that generated the callback.\r
@param Data A pointer to the data being sent to the original exporting driver.\r
@param Packet A pointer to a packet of information that a driver passes\r
used by resources that want to publish IFR/Font/String data and have it\r
collected by the Configuration engine.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
Removes a package from the HII database.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle that was registered to the data that \r
+ @param Handle The handle that was registered to the data that\r
is requested for removal.\r
\r
@retval EFI_SUCCESS The data associated with the Handle was removed\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param StringToTest A pointer to a Unicode string.\r
@param FirstMissing A pointer to an index into the string. On input,\r
- the index of the first character in the StringToTest \r
- to examine. On exit, the index of the first character \r
+ the index of the first character in the StringToTest\r
+ to examine. On exit, the index of the first character\r
encountered for which a glyph is unavailable.\r
- If all glyphs in the string are available, the \r
+ If all glyphs in the string are available, the\r
index is the index of the terminator of the string.\r
@param GlyphBufferSize A pointer to a value. On output, if the function\r
- returns EFI_SUCCESS, it contains the amount of \r
- memory that is required to store the string's \r
+ returns EFI_SUCCESS, it contains the amount of\r
+ memory that is required to store the string's\r
glyph equivalent.\r
\r
@retval EFI_SUCCESS All glyphs are available. Note that an empty string\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Source A pointer to a Unicode string.\r
- @param Index On input, the offset into the string from which to \r
- fetch the character. On successful completion, the \r
- index is updated to the first character past the \r
+ @param Index On input, the offset into the string from which to\r
+ fetch the character. On successful completion, the\r
+ index is updated to the first character past the\r
character(s) making up the just extracted glyph.\r
@param GlyphBuffer Pointer to an array where the glyphs corresponding\r
- to the characters in the source may be stored. \r
- GlyphBuffer is assumed to be wide enough to accept \r
+ to the characters in the source may be stored.\r
+ GlyphBuffer is assumed to be wide enough to accept\r
a wide glyph character.\r
@param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by\r
this value is filled with the length of the glyph in\r
pixels. It is unchanged if the call was unsuccessful.\r
@param InternalStatus The cell pointed to by this parameter must be\r
- initialized to zero prior to invoking the call the \r
+ initialized to zero prior to invoking the call the\r
first time for any string.\r
\r
- @retval EFI_SUCCESS Found the corresponding font glyph for a Unicode \r
- character. \r
+ @retval EFI_SUCCESS Found the corresponding font glyph for a Unicode\r
+ character.\r
@retval EFI_NOT_FOUND A glyph for a character was not found.\r
\r
**/\r
@param BltBuffer A pointer to the buffer that contains the data that is\r
ready to be used by the UGA BLT routines.\r
\r
- @retval EFI_SUCCESS Successfully translated a glyph into the required \r
+ @retval EFI_SUCCESS Successfully translated a glyph into the required\r
format for input to UGA BLT routines.\r
@retval EFI_NOT_FOUND A glyph for a character was not found.\r
@note Inconsistent with specification here:\r
to avoid name confict with EFI_HII_NEW_STRING defined in the UEFI 2.1d specification.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Pointer to a NULL-terminated string containing a single \r
- ISO 639-2 language identifier, indicating the language \r
- in which the string is translated. \r
- @param Handle The handle of the language pack to which the string \r
+ @param Pointer to a NULL-terminated string containing a single\r
+ ISO 639-2 language identifier, indicating the language\r
+ in which the string is translated.\r
+ @param Handle The handle of the language pack to which the string\r
is to be added.\r
- @param Reference The identifier of the string to be added. If the \r
- reference value is zero, then the string will be \r
+ @param Reference The identifier of the string to be added. If the\r
+ reference value is zero, then the string will be\r
assigned a new identifier on that handle for\r
- the language specified. Otherwise, the string will \r
+ the language specified. Otherwise, the string will\r
be updated with the NewString Value.\r
@param NewString The string to be added.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the strings reside.\r
@param LanguageString A string allocated by GetPrimaryLanguages() that\r
- contains a list of all primary languages registered \r
+ contains a list of all primary languages registered\r
on the handle.\r
\r
@retval EFI_SUCCESS LanguageString was correctly returned.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the strings reside.\r
- @param PrimaryLanguage Pointer to a NULL-terminated string containing a \r
- single ISO 639-2 language identifier, indicating \r
+ @param PrimaryLanguage Pointer to a NULL-terminated string containing a\r
+ single ISO 639-2 language identifier, indicating\r
the primary language.\r
@param LanguageString A string allocated by GetSecondaryLanguages()\r
- containing a list of all secondary languages \r
+ containing a list of all secondary languages\r
registered on the handle.\r
\r
@retval EFI_SUCCESS LanguageString was correctly returned.\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the string resides.\r
@param Token The string token assigned to the string.\r
- @param Raw If TRUE, the string is returned unedited in the \r
- internal storage format. If false, the string \r
- returned is edited by replacing <cr> with <space> \r
+ @param Raw If TRUE, the string is returned unedited in the\r
+ internal storage format. If false, the string\r
+ returned is edited by replacing <cr> with <space>\r
and by removing special characters such as the\r
<wide> prefix.\r
@param LanguageString Pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating \r
- the language to print. If the LanguageString is \r
+ single ISO 639-2 language identifier, indicating\r
+ the language to print. If the LanguageString is\r
empty (starts with a NULL), the default system\r
language will be used to determine the language.\r
@param BufferLength Length of the StringBuffer.\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the string resides.\r
@param Token The string token assigned to the string.\r
- @param Index On input, the offset into the string where the \r
- line is to start. On output, the index is updated \r
- to point beyond the last character returned in \r
+ @param Index On input, the offset into the string where the\r
+ line is to start. On output, the index is updated\r
+ to point beyond the last character returned in\r
the call.\r
@param LineWidth The maximum width of the line in units of narrow glyphs.\r
@param LanguageString The pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating \r
+ single ISO 639-2 language identifier, indicating\r
the language to print.\r
@param BufferLength The pointer to the length of the StringBuffer.\r
- @param StringBuffer The buffer designed to receive the characters in \r
+ @param StringBuffer The buffer designed to receive the characters in\r
the string.\r
\r
- @retval EFI_SUCCESS StringBuffer filled with characters that will fit \r
+ @retval EFI_SUCCESS StringBuffer filled with characters that will fit\r
on the line.\r
@retval EFI_NOT_FOUND The font glyph for at least one of the characters in\r
the string is not in the font database.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The HII handle from which will have default data retrieved.\r
- @param DefaultMask The mask used to specify some type of default \r
+ @param DefaultMask The mask used to specify some type of default\r
override when extracting the default image data.\r
- @param VariablePackList An indirect pointer to the first entry of a link \r
+ @param VariablePackList An indirect pointer to the first entry of a link\r
list with type EFI_HII_VARIABLE_PACK_LIST.\r
\r
@retval EFI_SUCCESS The VariablePackList was populated with the appropriate\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param DescriptorCount A pointer to the number of Descriptor entries being\r
described in the keyboard layout being retrieved.\r
- @param Descriptor A pointer to a buffer containing an array of \r
- FRAMEWORK_EFI_KEY_DESCRIPTOR entries. Each entry \r
+ @param Descriptor A pointer to a buffer containing an array of\r
+ FRAMEWORK_EFI_KEY_DESCRIPTOR entries. Each entry\r
will reflect the definition of a specific physical key.\r
\r
@retval EFI_SUCCESS The keyboard layout was retrieved successfully.\r
/** @file\r
- When installed, the Framework MP Services Protocol produces a collection of \r
- services that are needed for MP management, such as initialization and management \r
- of application processors. \r
- \r
- @par Note: \r
- This protocol has been deprecated and has been replaced by the MP Services \r
+ When installed, the Framework MP Services Protocol produces a collection of\r
+ services that are needed for MP management, such as initialization and management\r
+ of application processors.\r
+\r
+ @par Note:\r
+ This protocol has been deprecated and has been replaced by the MP Services\r
Protocol from the UEFI Platform Initialization Specification 1.2, Volume 2:\r
Driver Execution Environment Core Interface.\r
\r
The Protocol is available only during boot time.\r
\r
MP Services Protocol is hardware-independent. Most of the logic of this protocol\r
- is architecturally neutral. It abstracts the multi-processor environment and \r
- status of processors, and provides interfaces to retrieve information, maintain, \r
+ is architecturally neutral. It abstracts the multi-processor environment and\r
+ status of processors, and provides interfaces to retrieve information, maintain,\r
and dispatch.\r
\r
- MP Services Protocol may be consumed by ACPI module. The ACPI module may use this \r
+ MP Services Protocol may be consumed by ACPI module. The ACPI module may use this\r
protocol to retrieve data that are needed for an MP platform and report them to OS.\r
- MP Services Protocol may also be used to program and configure processors, such \r
+ MP Services Protocol may also be used to program and configure processors, such\r
as MTRR synchronization for memory space attributes setting in DXE Services.\r
- MP Services Protocol may be used by non-CPU DXE drivers to speed up platform boot \r
- by taking advantage of the processing capabilities of the APs, for example, using \r
+ MP Services Protocol may be used by non-CPU DXE drivers to speed up platform boot\r
+ by taking advantage of the processing capabilities of the APs, for example, using\r
APs to help test system memory in parallel with other device initialization.\r
Diagnostics applications may also use this protocol for multi-processor.\r
\r
-Copyright (c) 1999 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
**/\r
#define DELIVERY_MODE_FIXED 0x0\r
\r
///\r
-/// Lowest priority delivery mode that may be used as the DeliveryMode parameter in SendIpi(). \r
+/// Lowest priority delivery mode that may be used as the DeliveryMode parameter in SendIpi().\r
///\r
#define DELIVERY_MODE_LOWEST_PRIORITY 0x1\r
\r
///\r
-/// SMI delivery mode that may be used as the DeliveryMode parameter in SendIpi(). \r
+/// SMI delivery mode that may be used as the DeliveryMode parameter in SendIpi().\r
///\r
#define DELIVERY_MODE_SMI 0x2\r
\r
///\r
-/// Remote read delivery mode that may be used as the DeliveryMode parameter in SendIpi(). \r
+/// Remote read delivery mode that may be used as the DeliveryMode parameter in SendIpi().\r
///\r
#define DELIVERY_MODE_REMOTE_READ 0x3\r
\r
///\r
-/// NMI delivery mode that may be used as the DeliveryMode parameter in SendIpi(). \r
+/// NMI delivery mode that may be used as the DeliveryMode parameter in SendIpi().\r
///\r
#define DELIVERY_MODE_NMI 0x4\r
\r
///\r
-/// INIT delivery mode that may be used as the DeliveryMode parameter in SendIpi(). \r
+/// INIT delivery mode that may be used as the DeliveryMode parameter in SendIpi().\r
///\r
#define DELIVERY_MODE_INIT 0x5\r
\r
\r
typedef union {\r
///\r
- /// Bitfield structure for the IPF Self Test State Parameter. \r
+ /// Bitfield structure for the IPF Self Test State Parameter.\r
///\r
struct {\r
UINT32 Status:2;\r
/// BIST (built-in self-test) data of the processor.\r
///\r
/// @par IPF:\r
- /// Lower 32 bits of the self-test state parameter. For definition of self-test \r
- /// state parameter, please refer to Intel(R) Itanium(R) Architecture Software \r
+ /// Lower 32 bits of the self-test state parameter. For definition of self-test\r
+ /// state parameter, please refer to Intel(R) Itanium(R) Architecture Software\r
/// Developer's Manual, Volume 2: System Architecture.\r
///\r
EFI_MP_HEALTH_FLAGS Flags;\r
/// The lower 8 bits contains local APIC ID, and higher bits are reserved.\r
///\r
/// @par IPF:\r
- /// The lower 16 bits contains id/eid as physical address of local SAPIC \r
+ /// The lower 16 bits contains id/eid as physical address of local SAPIC\r
/// unit, and higher bits are reserved.\r
///\r
UINT32 ApicID;\r
///\r
- /// This field indicates whether the processor is enabled. If the value is \r
+ /// This field indicates whether the processor is enabled. If the value is\r
/// TRUE, then the processor is enabled. Otherwise, it is disabled.\r
///\r
BOOLEAN Enabled;\r
///\r
/// This field indicates whether the processor is playing the role of BSP.\r
- /// If the value is EfiCpuAP, then the processor is AP. If the value is \r
+ /// If the value is EfiCpuAP, then the processor is AP. If the value is\r
/// EfiCpuBSP, then the processor is BSP.\r
///\r
EFI_CPU_DESIGNATION Designation;\r
///\r
/// @par IA32, X64:\r
- /// The Flags field of this EFI_MP_HEALTH data structure holds BIST (built-in \r
- /// self test) data of the processor. The TestStatus field is not used, and \r
+ /// The Flags field of this EFI_MP_HEALTH data structure holds BIST (built-in\r
+ /// self test) data of the processor. The TestStatus field is not used, and\r
/// the value is always zero.\r
///\r
/// @par IPF:\r
- /// Bit format of this field is the same as the definition of self-test state \r
- /// parameter, in Intel(R) Itanium(R) Architecture Software Developer's Manual, \r
+ /// Bit format of this field is the same as the definition of self-test state\r
+ /// parameter, in Intel(R) Itanium(R) Architecture Software Developer's Manual,\r
/// Volume 2: System Architecture.\r
///\r
EFI_MP_HEALTH Health;\r
///\r
- /// Zero-based physical package number that identifies the cartridge of the \r
+ /// Zero-based physical package number that identifies the cartridge of the\r
/// processor.\r
///\r
UINTN PackageNumber;\r
/// This field is not used, and the value is always zero.\r
///\r
/// @par IPF:\r
- /// This field is a mask number that is handed off by the PAL about which \r
+ /// This field is a mask number that is handed off by the PAL about which\r
/// processor tests are performed and which are masked.\r
///\r
UINT64 ProcessorTestMask;\r
\r
@param[in] This The pointer to the FRAMEWORK_EFI_MP_SERVICES_PROTOCOL\r
instance.\r
- @param[out] NumberOfCPUs The pointer to the total number of logical processors \r
- in the system, including the BSP and disabled \r
+ @param[out] NumberOfCPUs The pointer to the total number of logical processors\r
+ in the system, including the BSP and disabled\r
APs. If NULL, this parameter is ignored.\r
- @param[out] MaximumNumberOfCPUs Pointer to the maximum number of processors \r
- supported by the system. If NULL, this \r
+ @param[out] MaximumNumberOfCPUs Pointer to the maximum number of processors\r
+ supported by the system. If NULL, this\r
parameter is ignored.\r
- @param[out] NumberOfEnabledCPUs The pointer to the number of enabled logical \r
- processors that exist in system, including \r
+ @param[out] NumberOfEnabledCPUs The pointer to the number of enabled logical\r
+ processors that exist in system, including\r
the BSP. If NULL, this parameter is ignored.\r
@param[out] RendezvousIntNumber This parameter is only meaningful for IPF.\r
- - IA32, X64: The returned value is zero. \r
+ - IA32, X64: The returned value is zero.\r
If NULL, this parameter is ignored.\r
- - IPF: Pointer to the rendezvous interrupt \r
+ - IPF: Pointer to the rendezvous interrupt\r
number that is used for AP wake-up.\r
- @param[out] RendezvousProcLength The pointer to the length of rendezvous procedure. \r
- - IA32, X64: The returned value is 0x1000. \r
+ @param[out] RendezvousProcLength The pointer to the length of rendezvous procedure.\r
+ - IA32, X64: The returned value is 0x1000.\r
If NULL, this parameter is ignored.\r
- IPF: The returned value is zero.\r
\r
projects / mirror_edk2.git / commitdiff