]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Library / PeiServicesTablePointerLibIdt / PeiServicesTablePointer.c
index 97abaa4aeb5889d7b2731a80a2db6cd2566d39b7..dac31c9985346dd634d131cffabe029ff8b57e15 100644 (file)
 /** @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
-  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
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  According to PI specification, the peiservice pointer is stored prior at IDT\r
+  table in IA32 and x64 architecture.\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
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \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
+#include <Library/BaseMemoryLib.h>\r
 \r
 /**\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
+  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
+  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
+\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
-  \r
-  The function sets 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
-  @param PeiServicesTablePointer  The pointer to PeiServices.\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
+  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 ** PeiServicesTablePointer\r
+  IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
   )\r
 {\r
-  IA32_DESCRIPTOR   Idtr;\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
+  Perform CPU specific actions required to migrate the PEI Services Table\r
+  pointer from temporary RAM to permanent RAM.\r
+\r
+  For IA32 CPUs, the PEI Services Table pointer is stored in the 4 bytes\r
+  immediately preceding the Interrupt Descriptor Table (IDT) in memory.\r
+  For X64 CPUs, the PEI Services Table pointer is stored in the 8 bytes\r
+  immediately preceding the Interrupt Descriptor Table (IDT) in memory.\r
+  For Itanium and ARM CPUs, a the PEI Services Table Pointer is stored in\r
+  a dedicated CPU register.  This means that there is no memory storage\r
+  associated with storing the PEI Services Table pointer, so no additional\r
+  migration actions are required for Itanium or ARM CPUs.\r
+\r
+  If The cached PEI Services Table pointer is NULL, then ASSERT().\r
+  If the permanent memory is allocated failed, then ASSERT().\r
 **/\r
 VOID\r
 EFIAPI\r
-MigrateIdtTable (\r
-  IN EFI_PEI_SERVICES  **PeiServices\r
+MigratePeiServicesTablePointer (\r
+  VOID\r
   )\r
 {\r
-  UINTN           Size;\r
-  VOID            *NewBase;\r
-  EFI_STATUS      Status;\r
-  IA32_DESCRIPTOR Idtr;\r
-  \r
+  EFI_STATUS             Status;\r
+  IA32_DESCRIPTOR        Idtr;\r
+  EFI_PHYSICAL_ADDRESS   IdtBase;\r
+  CONST EFI_PEI_SERVICES  **PeiServices;\r
+\r
+  //\r
+  // Get PEI Services Table pointer\r
+  //\r
   AsmReadIdtr (&Idtr);\r
-  \r
-  Size = sizeof(UINTN) + (Idtr.Limit + 1); \r
-  \r
-  Status = PeiServicesAllocatePool (Size, &NewBase);\r
+  PeiServices = (CONST EFI_PEI_SERVICES **) (*(UINTN*)(Idtr.Base - sizeof (UINTN)));\r
+  ASSERT (PeiServices != NULL);\r
+  //\r
+  // Allocate the permanent memory.\r
+  //\r
+  Status = (*PeiServices)->AllocatePages (\r
+                            PeiServices,\r
+                            EfiBootServicesCode,\r
+                            EFI_SIZE_TO_PAGES(Idtr.Limit + 1 + sizeof (UINTN)),\r
+                            &IdtBase\r
+                            );\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
+  //\r
+  // Idt table needs to be migrated into memory.\r
+  //\r
+  CopyMem ((VOID *) (UINTN) IdtBase, (VOID *) (Idtr.Base - sizeof (UINTN)), Idtr.Limit + 1 + sizeof (UINTN));\r
+  Idtr.Base = (UINTN) IdtBase + sizeof (UINTN);\r
   AsmWriteIdtr (&Idtr);\r
-  SetPeiServicesTablePointer(PeiServices);  \r
-}  \r
+\r
+  return;\r
+}\r
+\r
 \r