Modified PeiServicesTablePointerLib.h to match the Spec, and sync the c files with it.

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

diff --git a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
index 94895b30c966764c78f9a8a27a78c894618ef5a4..671268fa53d838935b7f973840a3f6e3dafc5821 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
@@ -2,7 +2,7 @@
   PEI Services Table Pointer Library implementation for IPF that uses Kernel\r
   Register 7 to store the pointer.\r
 \r
-  Copyright (c) 2006 - 2007, 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
@@ -18,48 +18,54 @@
 #include <Library/DebugLib.h>\r
 \r
 /**\r
-  The function returns the pointer to PeiServices.\r
+  Retrieves the cached value of the PEI Services Table pointer.\r
 \r
-  The function returns the pointer to PeiServices.\r
-  It will ASSERT() if the pointer to PeiServices is NULL.\r
+  Returns the cached value of the PEI Services Table pointer in a CPU specific manner \r
+  as specified in the CPU binding section of the Platform Initialization Pre-EFI \r
+  Initialization Core Interface Specification.\r
+  \r
+  If the cached PEI Services Table pointer is NULL, then ASSERT().\r
 \r
-  @retval  The pointer to PeiServices.\r
+  @return  The pointer to PeiServices.\r
 \r
 **/\r
-EFI_PEI_SERVICES **\r
+CONST EFI_PEI_SERVICES **\r
 EFIAPI\r
 GetPeiServicesTablePointer (\r
   VOID\r
   )\r
 {\r
-  EFI_PEI_SERVICES  **PeiServices;\r
+  CONST EFI_PEI_SERVICES  **PeiServices;\r
 \r
-  PeiServices = (EFI_PEI_SERVICES **)(UINTN)AsmReadKr7 ();\r
+  PeiServices = (CONST EFI_PEI_SERVICES **)(UINTN)AsmReadKr7 ();\r
   ASSERT (PeiServices != NULL);\r
   return PeiServices;\r
 }\r
 \r
-/**\r
-  The constructor function caches the pointer to PEI services.\r
-\r
-  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  PeiServices Pointer to the PEI services.\r
-\r
-  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
 \r
+/**\r
+  Caches a pointer PEI Services Table. \r
+ \r
+  Caches the pointer to the PEI Services Table specified by PeiServicesTablePointer \r
+  in a CPU specific manner as specified in the CPU binding section of the Platform Initialization \r
+  Pre-EFI Initialization Core Interface Specification. \r
+  The function set the pointer of PEI services in KR7 register \r
+  according to PI specification.\r
+  \r
+  If PeiServicesTablePointer is NULL, then ASSERT().\r
+  \r
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
 **/\r
-EFI_STATUS\r
+VOID\r
 EFIAPI\r
-PeiServicesTablePointerLibConstructor (\r
-  IN EFI_FFS_FILE_HEADER  *FfsHeader,\r
-  IN EFI_PEI_SERVICES     **PeiServices\r
+SetPeiServicesTablePointer (\r
+  IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
   )\r
 {\r
-  AsmWriteKr7 ((UINT64)(UINTN)PeiServices);\r
-  return EFI_SUCCESS;\r
+  ASSERT (PeiServicesTablePointer != NULL);\r
+  AsmWriteKr7 ((UINT64)(UINTN)PeiServicesTablePointer);\r
 }\r
+  \r
+\r
 \r
 \r