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

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

diff --git a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
index 97abaa4aeb5889d7b2731a80a2db6cd2566d39b7..6bacb323c0356d6111d2a11029e98d99a7e95753 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
@@ -1,6 +1,9 @@
 /** @file\r
-  PEI Services Table Pointer Library for IA-32 and X64.\r
+  PEI Services Table Pointer Library for IA-32 and x64.\r
 \r
+  According to PI specification, the peiservice pointer is stored prior at IDT\r
+  table in IA32 and x64 architecture.\r
+  \r
   Copyright (c) 2006 - 2007, 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
@@ -12,90 +15,63 @@
 \r
 **/\r
 \r
-#include "InternalPeiServicesTablePointer.h"\r
+#include <PiPei.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/PeiServicesTablePointerLib.h>\r
+#include <Library/DebugLib.h>\r
 \r
 /**\r
+  Retrieves the cached value of the PEI Services Table pointer.\r
+\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
-  The function returns the pointer to PeiServicee following\r
-  PI1.0.\r
-  \r
-  For IA32, the four-bytes field immediately prior to new IDT\r
-  base addres is used to save the EFI_PEI_SERVICES**.\r
-  For x64, the eight-bytes field immediately prior to new IDT\r
-  base addres is used to save the EFI_PEI_SERVICES**\r
-  \r
+  If the cached PEI Services Table pointer is NULL, then ASSERT().\r
+\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
   IA32_DESCRIPTOR   Idtr;\r
   \r
   AsmReadIdtr (&Idtr);\r
-  PeiServices = (EFI_PEI_SERVICES **) (*(UINTN*)(Idtr.Base - 4));\r
+  PeiServices = (CONST EFI_PEI_SERVICES **) (*(UINTN*)(Idtr.Base - sizeof (UINTN)));\r
   ASSERT (PeiServices != NULL);\r
   return PeiServices;\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 immediately preceding the IDT table\r
+  according to PI specification.\r
   \r
-  The function sets the pointer to PeiServicee following\r
-  PI1.0.\r
+  If PeiServicesTablePointer is NULL, then ASSERT().\r
   \r
-  For IA32, the four-bytes field immediately prior to new IDT\r
-  base addres is used to save the EFI_PEI_SERVICES**.\r
-  For x64, the eight-bytes field immediately prior to new IDT\r
-  base addres is used to save the EFI_PEI_SERVICES**\r
-  \r
-  @param PeiServicesTablePointer  The pointer to PeiServices.\r
-\r
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
 **/\r
 VOID\r
 EFIAPI\r
 SetPeiServicesTablePointer (\r
-  EFI_PEI_SERVICES ** PeiServicesTablePointer\r
+  IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
   )\r
 {\r
   IA32_DESCRIPTOR   Idtr;\r
   \r
+  ASSERT (PeiServicesTablePointer != NULL);\r
   AsmReadIdtr (&Idtr);\r
-  (*(UINTN*)(Idtr.Base - 4)) = (UINTN)PeiServicesTablePointer;\r
+  (*(UINTN*)(Idtr.Base - sizeof (UINTN))) = (UINTN)PeiServicesTablePointer;\r
 }\r
 \r
-/**\r
-  After memory initialization in PEI phase, the IDT table in temporary memory should \r
-  be migrated to memory, and the address of PeiServicesPointer also need to be updated  \r
-  immediately preceding the new IDT table.\r
-  \r
-  @param    PeiServices   The address of PeiServices pointer.\r
-**/\r
-VOID\r
-EFIAPI\r
-MigrateIdtTable (\r
-  IN EFI_PEI_SERVICES  **PeiServices\r
-  )\r
-{\r
-  UINTN           Size;\r
-  VOID            *NewBase;\r
-  EFI_STATUS      Status;\r
-  IA32_DESCRIPTOR Idtr;\r
-  \r
-  AsmReadIdtr (&Idtr);\r
-  \r
-  Size = sizeof(UINTN) + (Idtr.Limit + 1); \r
-  \r
-  Status = PeiServicesAllocatePool (Size, &NewBase);\r
-  ASSERT_EFI_ERROR (Status);\r
-  \r
-  CopyMem ((VOID*)((UINTN)NewBase + sizeof(UINTN)), (VOID*)Idtr.Base, (Idtr.Limit + 1));\r
-  \r
-  Idtr.Base = (UINTN)NewBase + sizeof(UINTN);\r
-  AsmWriteIdtr (&Idtr);\r
-  SetPeiServicesTablePointer(PeiServices);  \r
-}  \r
 \r