added additional comments and fixed some typo.
authorvanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Thu, 4 Sep 2008 06:16:14 +0000 (06:16 +0000)
committervanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Thu, 4 Sep 2008 06:16:14 +0000 (06:16 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@5810 de2fecce-e211-0410-80a6-f3fac2684e05

edk2/MdePkg/Include/Pi/PiDependency.h
edk2/MdePkg/Include/Pi/PiDxeCis.h
edk2/MdePkg/Include/Pi/PiFirmwareFile.h
edk2/MdePkg/Include/Pi/PiHob.h
edk2/MdePkg/Include/Pi/PiPeiCis.h

index 4dbf42f..fe552e8 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Present the dependency expression values in PI.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
 #define __PI_DEPENDENCY_H__\r
 \r
 /// \r
-/// If present, this must be the first and only opcode\r
+/// If present, this must be the first and only opcode,\r
+/// EFI_DEP_BEFORE is only used by DXE driver.\r
 /// \r
 #define EFI_DEP_BEFORE        0x00\r
 \r
 /// \r
-/// If present, this must be the first and only opcode\r
+/// If present, this must be the first and only opcode,\r
+/// EFI_DEP_AFTER is only used by DXE driver.\r
 /// \r
 #define EFI_DEP_AFTER         0x01\r
 \r
@@ -37,7 +39,8 @@
 \r
 \r
 /// \r
-/// If present, this must be the first opcode.\r
+/// If present, this must be the first opcode,\r
+/// EFI_DEP_SOR is only used by DXE driver.\r
 /// \r
 #define EFI_DEP_SOR           0x09\r
 \r
index 574ee46..81c9739 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Include file matches things in PI.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
index 1fd9da3..febebe7 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   The firmware file related definitions in PI.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -225,6 +225,10 @@ typedef struct {
 typedef struct {\r
   EFI_COMMON_SECTION_HEADER   CommonHeader;\r
   UINT16                      BuildNumber;\r
+\r
+  ///\r
+  /// Array of unicode string.\r
+  /// \r
   CHAR16                      VersionString[1];\r
 } EFI_VERSION_SECTION;\r
 \r
index 4dd9761..ffaaea1 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   HOB related definitions in PI.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -69,9 +69,11 @@ typedef struct {
   EFI_PHYSICAL_ADDRESS    EfiEndOfHobList;\r
 } EFI_HOB_HANDOFF_INFO_TABLE;\r
 \r
+/// \r
 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the\r
 /// various attributes of the logical memory allocation. The type field will be used for\r
 /// subsequent inclusion in the UEFI memory map.\r
+/// \r
 typedef struct {\r
   ///\r
   /// A GUID that defines the memory allocation region¡¯s type and purpose, as well as\r
@@ -87,7 +89,9 @@ typedef struct {
   /// specification.\r
   EFI_PHYSICAL_ADDRESS  MemoryBaseAddress;\r
 \r
+  /// \r
   /// The length in bytes of memory allocated by this HOB.\r
+  /// \r
   UINT64                MemoryLength;\r
 \r
   ///\r
@@ -146,8 +150,8 @@ typedef struct {
 typedef struct {\r
   EFI_HOB_GENERIC_HEADER            Header;\r
   EFI_HOB_MEMORY_ALLOCATION_HEADER  MemoryAllocationHeader;\r
-  EFI_GUID ModuleName;\r
-  EFI_PHYSICAL_ADDRESS EntryPoint;\r
+  EFI_GUID                          ModuleName;\r
+  EFI_PHYSICAL_ADDRESS              EntryPoint;\r
 } EFI_HOB_MEMORY_ALLOCATION_MODULE;\r
 \r
 ///\r
@@ -183,21 +187,21 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 //\r
 // The rest of the settings 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_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_WRITE_BACK_CACHEABLE 0x00002000\r
-#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO            0x00004000\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_WRITE_BACK_CACHEABLE     0x00002000\r
+#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO                0x00004000\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
 \r
 ///\r
 /// Describes the resource properties of all fixed, \r
@@ -231,8 +235,8 @@ typedef struct {
 /// \r
 typedef struct {\r
   EFI_HOB_GENERIC_HEADER Header;\r
-  EFI_PHYSICAL_ADDRESS BaseAddress;\r
-  UINT64 Length;\r
+  EFI_PHYSICAL_ADDRESS   BaseAddress;\r
+  UINT64                 Length;\r
 } EFI_HOB_FIRMWARE_VOLUME;\r
 \r
 ///\r
index e866a16..34691a0 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   PI PEI master include file. This file should match the PI spec.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -282,7 +282,7 @@ EFI_STATUS
   IN CONST EFI_PEI_SERVICES            **PeiServices,\r
   IN UINT16                            Type,\r
   IN UINT16                            Length,\r
-  OUT VOID                             **Hob\r
+  IN OUT VOID                          **Hob\r
   );\r
 \r
 /**\r
@@ -297,7 +297,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The volume was found.\r
   @retval EFI_NOT_FOUND         The volume was not found.\r
-  @retval EFI_INVALID_PARAMETER VolHandle is NULL\r
+  @retval EFI_INVALID_PARAMETER VolumeHandle is NULL.\r
 \r
 **/\r
 typedef\r