EmulatorPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmulatorPkg / Library / PeiServicesTablePointerLibMagicPage / PeiServicesTablePointer.c

/** @file\r
  PEI Services Table Pointer Library.\r
\r
  Store PEI Services Table pointer via gEmulatorPkgTokenSpaceGuid.PcdPeiServicesTablePage.\r
  This emulates a platform SRAM. The PI mechaism does not work in the emulator due to\r
  lack of privledge.\r
\r
  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
  Portiions copyrigth (c) 2011, Apple Inc. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/EmuMagicPageLib.h>\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
\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
  ASSERT (*PeiServicesTablePointer != NULL);\r
  EMU_MAGIC_PAGE()->PeiServicesTablePointer = PeiServicesTablePointer;\r
}\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
  If the cached PEI Services Table pointer is NULL, then ASSERT().\r
\r
  @return  The pointer to PeiServices.\r
\r
**/\r
CONST EFI_PEI_SERVICES **\r
EFIAPI\r
GetPeiServicesTablePointer (\r
  VOID\r
  )\r
{\r
  CONST EFI_PEI_SERVICES **PeiServicesTablePointer;\r
\r
  PeiServicesTablePointer = EMU_MAGIC_PAGE()->PeiServicesTablePointer;\r
  ASSERT (PeiServicesTablePointer != NULL);\r
  ASSERT (*PeiServicesTablePointer != NULL);\r
  return PeiServicesTablePointer;\r
}\r
\r
/**\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
**/\r
VOID\r
EFIAPI\r
MigratePeiServicesTablePointer (\r
  VOID\r
  )\r
{\r
  //\r
  //  PEI Services Table pointer is cached in SRAM. No additional\r
  //  migration actions are required.\r
  //\r
  return;\r
}\r
\r
\r