Minor grammatical work--mostly adding periods. Items with ONLY period added did...

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

diff --git a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
index 38051a9173eb9b07094621cd5ae35bacc44a88ff..7ed0c29bfab1f95f98a21865ff4f89f2ac2dce37 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
@@ -4,11 +4,11 @@
   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
+  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
@@ -19,32 +19,43 @@
 #include <Library/PeiServicesTablePointerLib.h>\r
 #include <Library/DebugLib.h>\r
 \r
-STATIC EFI_PEI_SERVICES  **gPeiServices;\r
+CONST EFI_PEI_SERVICES  **gPeiServices;\r
 \r
 /**\r
-  The function cache the pointer of PEI services to global variable.\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
   \r
-  @param    PeiServices   The address of PeiServices pointer.\r
+  If PeiServicesTablePointer is NULL, then ASSERT().\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
+  ASSERT (PeiServicesTablePointer != NULL);\r
+  gPeiServices = PeiServicesTablePointer;\r
 }\r
 \r
 /**\r
-  The function returns the pointer to PEI services.\r
+  Retrieves the cached value of the PEI Services Table pointer.\r
 \r
-  The function returns the pointer to PEI services.\r
-  It will ASSERT() if the pointer to PEI services 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
@@ -61,7 +72,7 @@ GetPeiServicesTablePointer (
   It will always return EFI_SUCCESS.\r
 \r
   @param  FileHandle   Handle of FFS header the loaded driver.\r
-  @param  PeiServices Pointer to the PEI services.\r
+  @param  PeiServices The pointer to the PEI services.\r
 \r
   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
 \r
@@ -69,8 +80,8 @@ GetPeiServicesTablePointer (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesTablePointerLibConstructor (\r
-  IN EFI_PEI_FILE_HANDLE  FileHandle,\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