added function header

[mirror_edk2.git] / MdePkg / Library / PeiServicesTablePointerLibMm7 / PeiServicesTablePointer.c

diff --git a/MdePkg/Library/PeiServicesTablePointerLibMm7/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibMm7/PeiServicesTablePointer.c
index 285a5a05ad4ce74938a99a9e1705280d38beba84..5901527adaa4640b2839c7a3923635ab8a47dac3 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLibMm7/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLibMm7/PeiServicesTablePointer.c
@@ -15,16 +15,38 @@
 **/\r
 \r
 \r
+/**\r
+  The function returns the pointer to PeiServices.\r
+  \r
+  The function returns the pointer to PeiServices. \r
+  It will ASSERT() if the pointer to PeiServices is NULL.\r
+\r
+  @retval  The pointer to PeiServices.\r
 \r
+**/\r
 EFI_PEI_SERVICES **\r
 GetPeiServicesTablePointer (\r
   VOID\r
   )\r
 {\r
-  return (EFI_PEI_SERVICES **)(UINTN)AsmReadMm7 ();\r
+  EFI_PEI_SERVICES  **PeiServices;\r
+\r
+  PeiServices = (EFI_PEI_SERVICES **)(UINTN)AsmReadMm7 ();\r
+  ASSERT (PeiServices != NULL);\r
+  return PeiServices;\r
 }\r
 \r
 /**\r
+  The constructor function caches the pointer to PEI services.\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
+  \r
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
+\r
 **/\r
 EFI_STATUS\r
 PeiServicesTablePointerLibConstructor (\r