added additional comments and fixed some typo.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5810 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 23 insertions, 19 deletions

diff --git a/MdePkg/Include/Pi/PiHob.h b/MdePkg/Include/Pi/PiHob.h
index 4dd9761fc6..ffaaea1e0f 100644
--- a/MdePkg/Include/Pi/PiHob.h
+++ b/MdePkg/Include/Pi/PiHob.h
@@ -1,7 +1,7 @@
 /** @file

   HOB related definitions in PI.

 

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         

+  Copyright (c) 2006 - 2008, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -69,9 +69,11 @@ typedef struct {
   EFI_PHYSICAL_ADDRESS    EfiEndOfHobList;

 } EFI_HOB_HANDOFF_INFO_TABLE;

 

+/// 

 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the

 /// various attributes of the logical memory allocation. The type field will be used for

 /// subsequent inclusion in the UEFI memory map.

+/// 

 typedef struct {

   ///

   /// A GUID that defines the memory allocation region¡¯s type and purpose, as well as

@@ -87,7 +89,9 @@ typedef struct {
   /// specification.

   EFI_PHYSICAL_ADDRESS  MemoryBaseAddress;

 

+  /// 

   /// The length in bytes of memory allocated by this HOB.

+  /// 

   UINT64                MemoryLength;

 

   ///

@@ -146,8 +150,8 @@ typedef struct {
 typedef struct {

   EFI_HOB_GENERIC_HEADER            Header;

   EFI_HOB_MEMORY_ALLOCATION_HEADER  MemoryAllocationHeader;

-  EFI_GUID ModuleName;

-  EFI_PHYSICAL_ADDRESS EntryPoint;

+  EFI_GUID                          ModuleName;

+  EFI_PHYSICAL_ADDRESS              EntryPoint;

 } EFI_HOB_MEMORY_ALLOCATION_MODULE;

 

 ///

@@ -183,21 +187,21 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 //

 // The rest of the settings describe capabilities

 //

-#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC       0x00000008

-#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC     0x00000010

-#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1       0x00000020

-#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2       0x00000040

-#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED       0x00000080

-#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED      0x00000100

-#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED  0x00000200

-#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE          0x00000400

-#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE    0x00000800

+#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC           0x00000008

+#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC         0x00000010

+#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1           0x00000020

+#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2           0x00000040

+#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED           0x00000080

+#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED          0x00000100

+#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED      0x00000200

+#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE              0x00000400

+#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE        0x00000800

 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE  0x00001000

-#define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000

-#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO            0x00004000

-#define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO            0x00008000

-#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO            0x00010000

-#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED    0x00020000

+#define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE     0x00002000

+#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO                0x00004000

+#define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO                0x00008000

+#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO                0x00010000

+#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED        0x00020000

 

 ///

 /// Describes the resource properties of all fixed, 

@@ -231,8 +235,8 @@ typedef struct {
 /// 

 typedef struct {

   EFI_HOB_GENERIC_HEADER Header;

-  EFI_PHYSICAL_ADDRESS BaseAddress;

-  UINT64 Length;

+  EFI_PHYSICAL_ADDRESS   BaseAddress;

+  UINT64                 Length;

 } EFI_HOB_FIRMWARE_VOLUME;

 

 ///