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 2a346aa69f9d312280a9a623bba6ddc4f4cecb3b..a5b32a565ba9f82976e0b97e48bc7a8a624e5991 100644 (file)
--- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h
+++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
@@ -1,26 +1,59 @@
 /** @file\r
   PEI Services Table Pointer Library services\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
+  Copyright (c) 2006, Intel Corporation\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
 \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
-\r
-  Module Name:  PeiServicesTablePointerLib.h\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
 \r
 **/\r
 \r
 #ifndef __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
 #define __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
 \r
+/**\r
+  The function returns the pointer to PEI services.\r
+\r
+  The function returns the pointer to PEI services.\r
+  It will ASSERT() if the pointer to PEI services is NULL.\r
+\r
+  @retval  The pointer to PeiServices.\r
+\r
+**/\r
 EFI_PEI_SERVICES **\r
+EFIAPI\r
 GetPeiServicesTablePointer (\r
   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