/** @file\r
HOB related definitions in PI.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2006 - 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
+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
+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
PI Version 1.0\r
#define EFI_HOB_TYPE_CPU 0x0006\r
#define EFI_HOB_TYPE_MEMORY_POOL 0x0007\r
#define EFI_HOB_TYPE_FV2 0x0009\r
-#define EFI_HOB_TYPE_LOAD_PEIM 0x000A\r
+#define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A\r
#define EFI_HOB_TYPE_UEFI_CAPSULE 0x000B\r
#define EFI_HOB_TYPE_UNUSED 0xFFFE\r
#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF\r
\r
\r
///\r
-/// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.\r
+/// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.\r
/// \r
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009\r
\r
EFI_HOB_GENERIC_HEADER Header;\r
///\r
/// The version number pertaining to the PHIT HOB definition.\r
- /// This value is 4 bytes in length to provide an 8-byte aligned entry \r
+ /// This value is four bytes in length to provide an 8-byte aligned entry \r
/// when it is combined with the 4-byte BootMode.\r
///\r
UINT32 Version;\r
\r
///\r
/// Describes the memory stack that is produced by the HOB producer \r
-/// phase and upon which all postmemory-installed executable\r
+/// phase and upon which all post-memory-installed executable\r
/// content in the HOB producer phase is executing.\r
/// \r
typedef struct {\r
} EFI_HOB_MEMORY_ALLOCATION_MODULE;\r
\r
///\r
-/// Resource type \r
+/// The resource type.\r
/// \r
typedef UINT32 EFI_RESOURCE_TYPE;\r
\r
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007\r
\r
///\r
-/// type of recount attribute type\r
+/// A type of recount attribute type.\r
/// \r
typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;\r
\r
//\r
// These types can be ORed together as needed.\r
//\r
-// The first three enumerations describe settings\r
+// The following attributes are used to describe settings\r
//\r
-#define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001\r
-#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002\r
-#define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004\r
+#define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001\r
+#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002\r
+#define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004\r
+#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080\r
+#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100\r
+#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200\r
//\r
-// The rest of the settings describe capabilities\r
+// The rest of the attributes are used to describe capabilities\r
//\r
#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008\r
#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010\r
#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020\r
#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040\r
-#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080\r
-#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100\r
-#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200\r
#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400\r
#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800\r
#define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000\r
#define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000\r
#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000\r
#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000\r
+#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000\r
+#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000\r
+#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000\r
\r
///\r
/// Describes the resource properties of all fixed, \r
///\r
EFI_GUID Owner;\r
///\r
- /// Resource type enumeration as defined by EFI_RESOURCE_TYPE.\r
+ /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.\r
///\r
EFI_RESOURCE_TYPE ResourceType;\r
///\r
///\r
EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;\r
///\r
- /// Physical start address of the resource region. \r
+ /// The physical start address of the resource region. \r
///\r
EFI_PHYSICAL_ADDRESS PhysicalStart;\r
///\r
- /// Number of bytes of the resource region.\r
+ /// The number of bytes of the resource region.\r
///\r
UINT64 ResourceLength;\r
} EFI_HOB_RESOURCE_DESCRIPTOR;\r
} EFI_HOB_FIRMWARE_VOLUME;\r
\r
///\r
-/// Details the location of a firmware volume which was extracted \r
+/// Details the location of a firmware volume that was extracted \r
/// from a file within another firmware volume.\r
/// \r
typedef struct {\r
///\r
EFI_GUID FvName;\r
///\r
- /// The name of the firmware file which contained this firmware volume.\r
+ /// The name of the firmware file that contained this firmware volume.\r
///\r
EFI_GUID FileName;\r
} EFI_HOB_FIRMWARE_VOLUME2;\r
///\r
/// The physical memory-mapped base address of an UEFI capsule. This value is set to\r
/// point to the base of the contiguous memory of the UEFI capsule.\r
- /// The length of the contiguous memory in bytes\r
+ /// The length of the contiguous memory in bytes.\r
///\r
EFI_PHYSICAL_ADDRESS BaseAddress;\r
UINT64 Length;\r
} EFI_HOB_UEFI_CAPSULE;\r
\r
///\r
-/// Union of all the possible HOB Types\r
+/// Union of all the possible HOB Types.\r
///\r
typedef union {\r
EFI_HOB_GENERIC_HEADER *Header;\r
projects / mirror_edk2.git / blobdiff