/** @file\r
PEI Services Table Pointer Library.\r
\r
- Copyright (c) 2006, 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
+ This library is used for PEIM which does executed from flash device directly but\r
+ executed in memory.\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 <Library/PeiServicesTablePointerLib.h>\r
#include <Library/DebugLib.h>\r
\r
-#include "PeiServicesTablePointerInternal.h"\r
-\r
-static EFI_PEI_SERVICES **gPeiServices;\r
+CONST EFI_PEI_SERVICES **gPeiServices;\r
\r
/**\r
- The function set the pointer of PEI services immediately preceding the IDT table\r
- according to PI specification.\r
- \r
- @param PeiServices The address of PeiServices pointer.\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
- 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
+ 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 PEI services.\r
- It will ASSERT() if the pointer to PEI services is NULL.\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
/**\r
The constructor function caches the pointer to PEI services.\r
- \r
+\r
The constructor function caches the pointer to PEI services.\r
It will always return EFI_SUCCESS.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\r
+ @param FileHandle The handle of FFS header the loaded driver.\r
+ @param PeiServices The pointer to the PEI services.\r
\r
- @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesTablePointerLibConstructor (\r
- IN EFI_PEI_FILE_HANDLE *FfsHeader,\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
}\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
**/\r
VOID\r
-MigrateIdtTable (\r
- IN EFI_PEI_SERVICES **PeiServices\r
+EFIAPI\r
+MigratePeiServicesTablePointer (\r
+ VOID\r
)\r
{\r
+ //\r
+ // PEI Services Table pointer is cached in the global variable. No additional\r
+ // migration actions are required.\r
+ //\r
+ return;\r
}\r
-\r