follow up code review

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

diff --git a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
index 9dea0476d973ca85b7d5321584237e9c23609f6f..b601545b8caa7c2f65e88f87f801925954359926 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
@@ -1,5 +1,8 @@
 /** @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
   All rights reserved. This program and the accompanying materials\r
@@ -10,16 +13,27 @@
   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
-  Module Name:  PeiServicesTablePointer.c\r
-\r
 **/\r
 \r
 #include <PiPei.h>\r
 #include <Library/PeiServicesTablePointerLib.h>\r
 #include <Library/DebugLib.h>\r
 \r
+STATIC EFI_PEI_SERVICES  **gPeiServices;\r
 \r
-static EFI_PEI_SERVICES  **gPeiServices;\r
+/**\r
+  The function cache the pointer of PEI services to global variable.\r
+  \r
+  @param    PeiServices   The address of PeiServices pointer.\r
+**/\r
+VOID\r
+EFIAPI\r
+SetPeiServicesTablePointer (\r
+  IN EFI_PEI_SERVICES  **PeiServices\r
+  )\r
+{\r
+  gPeiServices = PeiServices;\r
+}\r
 \r
 /**\r
   The function returns the pointer to PEI services.\r
@@ -46,7 +60,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
@@ -55,10 +69,12 @@ GetPeiServicesTablePointer (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesTablePointerLibConstructor (\r
-  IN EFI_FFS_FILE_HEADER  *FfsHeader,\r
+  IN EFI_PEI_FILE_HANDLE  FileHandle,\r
   IN EFI_PEI_SERVICES     **PeiServices\r
   )\r
 {\r
   gPeiServices = PeiServices;\r
   return EFI_SUCCESS;\r
 }\r
+\r
+\r