Synchronize interface function comment from declaration in library class header file...

[mirror_edk2.git] / MdePkg / Library / PeiServicesTablePointerLib / PeiServicesTablePointer.c

diff --git a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
index 54a500a7326b1ff3aa25126ab6579b6185721c4d..c45a55829d0f7ff13c72e346547d18ae47f4fca4 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
@@ -1,7 +1,10 @@
 /** @file\r
   PEI Services Table Pointer Library.\r
+  \r
+  This library is used for PEIM which does executed from flash device directly but\r
+  executed in memory.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\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
@@ -16,17 +19,21 @@
 #include <Library/PeiServicesTablePointerLib.h>\r
 #include <Library/DebugLib.h>\r
 \r
-#include "PeiServicesTablePointerInternal.h"\r
-\r
-static EFI_PEI_SERVICES  **gPeiServices;\r
+CONST EFI_PEI_SERVICES  **gPeiServices;\r
 \r
+/**\r
+  The function set the pointer of PEI services immediately preceding the IDT table\r
+  according to PI specification.\r
+  \r
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
+**/\r
 VOID\r
 EFIAPI\r
 SetPeiServicesTablePointer (\r
-  EFI_PEI_SERVICES  **PeiServices\r
+  IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
   )\r
 {\r
-  gPeiServices = PeiServices;\r
+  gPeiServices = PeiServicesTablePointer;\r
 }\r
 \r
 /**\r
@@ -38,7 +45,8 @@ SetPeiServicesTablePointer (
   @retval  The pointer to PeiServices.\r
 \r
 **/\r
-EFI_PEI_SERVICES **\r
+CONST EFI_PEI_SERVICES **\r
+EFIAPI\r
 GetPeiServicesTablePointer (\r
   VOID\r
   )\r
@@ -54,7 +62,7 @@ GetPeiServicesTablePointer (
   The constructor function caches the pointer to PEI services.\r
   It will always return EFI_SUCCESS.\r
 \r
-  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
+  @param  FileHandle   Handle of FFS header the loaded driver.\r
   @param  PeiServices Pointer to the PEI services.\r
 \r
   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
@@ -63,10 +71,12 @@ GetPeiServicesTablePointer (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesTablePointerLibConstructor (\r
-  IN EFI_PEI_FILE_HANDLE  *FfsHeader,\r
-  IN EFI_PEI_SERVICES     **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE        FileHandle,\r
+  IN CONST EFI_PEI_SERVICES     **PeiServices\r
   )\r
 {\r
   gPeiServices = PeiServices;\r
   return EFI_SUCCESS;\r
 }\r
+\r
+\r