UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdePkg / Include / Library / PeiServicesTablePointerLib.h

diff --git a/MdePkg/Include/Library/PeiServicesTablePointerLib.h b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
index 601e1d57f3deedbfcff8b08ce38b3cffe20fd776..61635eff00deb6533aef55f6fe81f46c6e9dd402 100644 (file)
--- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h
+++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
@@ -1,14 +1,8 @@
 /** @file\r
   Provides a service to retrieve a pointer to the PEI Services Table.\r
 \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
-\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
@@ -18,10 +12,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\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
+  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
+\r
   If the cached PEI Services Table pointer is NULL, then ASSERT().\r
 \r
   @return  The pointer to PeiServices.\r
@@ -34,21 +28,40 @@ GetPeiServicesTablePointer (
   );\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
+  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
+\r
   @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
 **/\r
 VOID\r
 EFIAPI\r
 SetPeiServicesTablePointer (\r
-  IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
+  IN CONST EFI_PEI_SERVICES  **PeiServicesTablePointer\r
   );\r
 \r
-#endif\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
+#endif\r