Add comment for modules which have external input.

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

diff --git a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
index bc189cd428c3bf344469c8b4c491fbf0cae970fd..4c91a9618726a04c8c19f620b33be1a5529138d5 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
@@ -2,11 +2,11 @@
   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
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
+  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
@@ -18,24 +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
+/**\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
+VOID\r
+EFIAPI\r
+SetPeiServicesTablePointer (\r
+  IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
+  )\r
+{\r
+  ASSERT (PeiServicesTablePointer != NULL);\r
+  AsmWriteKr7 ((UINT64)(UINTN)PeiServicesTablePointer);\r
+}\r
+  \r
+\r
+\r
+\r