add comments for protocol/print.h and retire ReadOnlyVariableThunkPresent

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

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
index 19bd8a8ae4117fe5fc89547585ffc6507a83e192..a58c9dc7643327f0af26fc268d8270f8ffaec993 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
@@ -22,7 +22,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 typedef struct _ECP_PEI_PCI_CFG_PPI ECP_PEI_PCI_CFG_PPI;\r
 \r
+/**\r
+  PCI read and write operation.\r
+  \r
+  Write to/read from a given location in the PCI configuration space.\r
 \r
+  @param  PeiServices                   An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This                              Pointer to local data for the interface.\r
+  @param  Width                            The width of the access. Enumerated in bytes.\r
+                                                    See EFI_PEI_PCI_CFG_PPI_WIDTH above.\r
+  @param  Address                         The physical address of the access. The format of\r
+                                                    the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS.\r
+  @param  Buffer                            A pointer to the buffer of data..\r
+  @retval EFI_SUCCESS                   The function completed successfully.\r
+  @retval EFI_DEVICE_ERROR          There was a problem with the transaction.\r
+  @retval EFI_DEVICE_NOT_READY  The device is not capable of supporting the operation at this\r
+                                                 time.\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *ECP_PEI_PCI_CFG_PPI_IO) (\r
@@ -33,6 +49,16 @@ EFI_STATUS
   IN OUT VOID                 *Buffer\r
   );\r
 \r
+/**\r
+  The ECP_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI \r
+  controllers behind a PCI root bridge controller.\r
+  @param Read\r
+  PCI read services.  See the Read() function description.\r
+  @param Write\r
+  PCI write services.  See the Write() function description.\r
+\r
+**/\r
+\r
 struct _ECP_PEI_PCI_CFG_PPI {\r
   ECP_PEI_PCI_CFG_PPI_IO  Read;\r
   ECP_PEI_PCI_CFG_PPI_IO  Write;\r

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Ppi/ReadOnlyVariableThunkPresent.h b/EdkCompatibilityPkg/Compatibility/Include/Ppi/ReadOnlyVariableThunkPresent.h
deleted file mode 100644 (file)
index 9ca395d..0000000
--- a/EdkCompatibilityPkg/Compatibility/Include/Ppi/ReadOnlyVariableThunkPresent.h
+++ /dev/null
@@ -1,28 +0,0 @@
-/** @file\r
-  PPI published by the ReadOnlyVariable to ReadOnlyVariable2 or ReadOnlyVariable2 to ReadOnlyVariable\r
-  thunking PEIM to mark that such module has already been excuted.\r
-\r
-  This PPI is referenced in Edk2/EdkCompatibility/Compatibility/ReadOnlyVariable2ToReadOnlyVariable \r
-  and Edk2/EdkCompatibility/Compatibility/ReadOnlyVariable2ToReadOnlyVariable.\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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
-\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
-#ifndef _PEI_READONLY_VARIABLE_THUNK_PRESENT_H_\r
-#define _PEI_READONLY_VARIABLE_THUNK_PRESENT_H_\r
-\r
-#define PEI_READONLY_VARIABLE_THUNK_PRESENT_GUID  \\r
-  { 0xe84e9e0b, 0xb5dd, 0x4d08, { 0x9e, 0x46, 0x82, 0x1f, 0xf, 0x14, 0xe9, 0x1b } }\r
-\r
-extern EFI_GUID                     gPeiReadonlyVariableThunkPresentPpiGuid;\r
-\r
-#endif\r
-\r

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h b/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h
index 3e26c520f9a399e43b6d690f240f077b9918e3b3..5c0426232a5962cbf849acc3ea7fc7de8a7b9622 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h
@@ -68,7 +68,11 @@ UINTN
   IN  VA_LIST       Marker\r
   );\r
 \r
-\r
+/**\r
+   The EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string\r
+   based on a Null-terminated Unicode format string and a VA_LIST argument list and fill into \r
+   the buffer as output\r
+**/\r
 struct _EFI_PRINT_PROTOCOL {\r
   UNI_VSPRINT               VSPrint;\r
 };\r

diff --git a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.c b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.c
index 2de6c92785d08e5db7aa75d6619e4b18aa3ed466..adeddbc00e1ebb90ea5229a556f045dc158d0e37 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.c
+++ b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.c
@@ -26,7 +26,6 @@ Module Name:
 #include <PiPei.h>\r
 #include <Ppi/ReadOnlyVariable2.h>\r
 #include <Ppi/ReadOnlyVariable.h>\r
-#include <Ppi/ReadOnlyVariableThunkPresent.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/PeiServicesTablePointerLib.h>\r
 #include <Library/PeiServicesLib.h>\r
@@ -69,12 +68,6 @@ EFI_PEI_PPI_DESCRIPTOR     mPpiListVariable = {
 };\r
 \r
 \r
-EFI_PEI_PPI_DESCRIPTOR     mReadOnlyVariableThunkPresent = {\r
-    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
-    &gPeiReadonlyVariableThunkPresentPpiGuid,\r
-    NULL\r
-};\r
-\r
 /**\r
   User entry for this PEIM driver.\r
   \r
@@ -92,8 +85,6 @@ PeimInitializeReadOnlyVariable2 (
   IN CONST EFI_PEI_SERVICES    **PeiServices\r
   )\r
 {\r
-  VOID        *Interface;\r
-  EFI_STATUS  Status;\r
   //\r
   // This thunk module can only be used together with a PI PEI core, as we \r
   // assume PeiServices Pointer Table can be located in a standard way defined\r
@@ -102,15 +93,9 @@ PeimInitializeReadOnlyVariable2 (
   ASSERT ((*PeiServices)->Hdr.Revision >= 0x00010000);\r
 \r
   //\r
-  // Make sure ReadOnlyVariable2ToReadOnlyVariable module is not present. If so, the call chain will form a\r
-  // infinite loop: ReadOnlyVariable2 -> ReadOnlyVariable -> ReadOnlyVariable2 -> ....\r
+  // Developer should make sure ReadOnlyVariable2ToReadOnlyVariable module is not present. or else, the call chain will form a\r
+  // infinite loop: ReadOnlyVariable2 -> ReadOnlyVariable -> ReadOnlyVariable2 -> .....\r
   //\r
-  Status = PeiServicesLocatePpi (&gPeiReadonlyVariableThunkPresentPpiGuid, 0, NULL, &Interface);\r
-  ASSERT (Status == EFI_NOT_FOUND);\r
-  \r
-  Status = PeiServicesInstallPpi (&mReadOnlyVariableThunkPresent);\r
-  ASSERT_EFI_ERROR (Status);\r
-  \r
   //\r
   // Publish the variable capability to other modules\r
   //\r

diff --git a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.inf b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.inf
index 64664f1cd251bd740c13db6ec7f66520a387d963..dabdc68339ed33b18a596e31379b37ff52d1435a 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.inf
+++ b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2OnReadOnlyVariableThunk.inf
@@ -59,7 +59,6 @@
 [Ppis]\r
   gEfiPeiReadOnlyVariablePpiGuid                 # PPI ALWAYS_CONSUMED\r
   gEfiPeiReadOnlyVariable2PpiGuid                # PPI ALWAYS_PRODUCED\r
-  gPeiReadonlyVariableThunkPresentPpiGuid\r
 \r
 [Depex]\r
   gEfiPeiReadOnlyVariablePpiGuid\r

diff --git a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.c b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.c
index 0e531e3a5fd709eaade33e2ef21e9261fc2449a3..3eaa929c7c7dd9194b99b59ef65afd0b388b7edc 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.c
+++ b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.c
@@ -25,7 +25,6 @@ Module Name:
 #include <PiPei.h>\r
 #include <Ppi/ReadOnlyVariable.h>\r
 #include <Ppi/ReadOnlyVariable2.h>\r
-#include <Ppi/ReadOnlyVariableThunkPresent.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/PeiServicesLib.h>\r
 \r
@@ -66,11 +65,6 @@ EFI_PEI_PPI_DESCRIPTOR     mPpiListVariable = {
   &mVariablePpi\r
 };\r
 \r
-EFI_PEI_PPI_DESCRIPTOR     mReadOnlyVariableThunkPresent = {\r
-    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
-    &gPeiReadonlyVariableThunkPresentPpiGuid,\r
-    NULL\r
-};\r
 \r
 \r
 /**\r
@@ -89,19 +83,10 @@ PeimInitializeReadOnlyVariable (
   IN CONST EFI_PEI_SERVICES  **PeiServices\r
   )\r
 {\r
-  VOID        *Interface;\r
-  EFI_STATUS  Status;\r
-\r
   //\r
-  // Make sure ReadOnlyVariableToReadOnlyVariable2 module is not present. If so, the call chain will form a\r
+  //Developer should make sure ReadOnlyVariableToReadOnlyVariable2 module is not present. If so, the call chain will form a\r
   // infinite loop: ReadOnlyVariable -> ReadOnlyVariable2 -> ReadOnlyVariable -> ....\r
   //\r
-  Status = PeiServicesLocatePpi (&gPeiReadonlyVariableThunkPresentPpiGuid, 0, NULL, &Interface);\r
-  ASSERT (Status == EFI_NOT_FOUND);\r
-\r
-  Status = PeiServicesInstallPpi (&mReadOnlyVariableThunkPresent);\r
-  ASSERT_EFI_ERROR (Status);\r
-\r
   //\r
   // Publish the variable capability to other modules\r
   //\r

diff --git a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.inf b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.inf
index f3975c2f2cdb653112e6bb7b9afcb059d17946cc..f7546e3dd3b9afc933bfeeb2a4ecd653e428a292 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.inf
+++ b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariableOnReadOnlyVariable2Thunk/ReadOnlyVariableOnReadOnlyVariable2Thunk.inf
@@ -56,7 +56,6 @@
 [Ppis]\r
   gEfiPeiReadOnlyVariable2PpiGuid               # PPI ALWAYS_CONSUMED\r
   gEfiPeiReadOnlyVariablePpiGuid                # PPI ALWAYS_PRODUCED\r
-  gPeiReadonlyVariableThunkPresentPpiGuid\r
 \r
 [Depex]\r
   gEfiPeiReadOnlyVariable2PpiGuid\r

diff --git a/EdkCompatibilityPkg/EdkCompatibilityPkg.dec b/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
index 961f56513ec521e2d33264da3d6d5ea7447ef72b..03aeacb96aa92146739b1d343749e2ea457bdea2 100644 (file)
--- a/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
+++ b/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
@@ -49,7 +49,6 @@
 [LibraryClasses.common]\r
 \r
 [Ppis.common]\r
-  gPeiReadonlyVariableThunkPresentPpiGuid = { 0xe84e9e0b, 0xb5dd, 0x4d08, { 0x9e, 0x46, 0x82, 0x1f, 0xf, 0x14, 0xe9, 0x1b }} \r
   gEcpPeiPciCfgPpiGuid                    = { 0xb0ee53d4, 0xa049, 0x4a79, { 0xb2, 0xff, 0x19, 0xd9, 0xfa, 0xef, 0xaa, 0x94 }} \r
 \r
 [Protocols.common]\r