Use doxygen comment style for document entity such as struct, enum, variable that...

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

diff --git a/MdePkg/Include/Library/PeiServicesTablePointerLib.h b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
index 7a602f9041126c67aae6bb4a6f736771e739267f..a5b32a565ba9f82976e0b97e48bc7a8a624e5991 100644 (file)
--- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h
+++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
@@ -30,11 +30,30 @@ GetPeiServicesTablePointer (
   VOID\r
   );\r
 \r
+/**\r
+  The function set the pointer of PEI services immediately preceding the IDT table\r
+  according to PI specification.\r
+  \r
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
+**/\r
 VOID\r
 EFIAPI\r
 SetPeiServicesTablePointer (\r
   EFI_PEI_SERVICES ** 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
 #endif\r
 \r