added function header
authorvanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 13 Jul 2006 01:17:21 +0000 (01:17 +0000)
committervanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 13 Jul 2006 01:17:21 +0000 (01:17 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@935 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/PeiServicesTablePointerLib.h
MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
MdePkg/Library/PeiServicesTablePointerLibMm7/PeiServicesTablePointer.c
MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.c
MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.c

index 2a346aa69f9d312280a9a623bba6ddc4f4cecb3b..79f27c34562e6dbf80c4e6beaead764ce16e33a1 100644 (file)
 #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
 GetPeiServicesTablePointer (\r
   VOID\r
index f130b207e5ebaf8238ebb720e9d13b2521c898a9..40d4f641a4cf449cb80fba15632e872da01df100 100644 (file)
 EFI_DXE_SERVICES  *gDS      = NULL;\r
 \r
 /**\r
+  The constructor function caches the pointer of System Configuration Table.\r
+  \r
+  The constructor function caches the pointer of System Configuration Table. \r
+  It will ASSERT() if that operation fails.\r
+  It will ASSERT() if the pointer of System Configuration Table is NULL.\r
+  It will always return EFI_SUCCESS.\r
+\r
+  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param  SystemTable   A pointer to the EFI System Table.\r
+  \r
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
+\r
 **/\r
 EFI_STATUS\r
 DxeServicesTableLibConstructor (\r
index b4c13c850b346154c308593ef3b9a984c8e0d260..18d8c99b44df6c7ba6ed1542c93c493a5d4d45eb 100644 (file)
 \r
 static EFI_PEI_SERVICES  **gPeiServices;\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
 GetPeiServicesTablePointer (\r
   VOID\r
@@ -27,7 +36,18 @@ GetPeiServicesTablePointer (
   return gPeiServices;\r
 }\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
index f5faf63086bb1c4fd290de04d747deaab7214864..5901527adaa4640b2839c7a3923635ab8a47dac3 100644 (file)
 **/\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
@@ -29,6 +37,16 @@ GetPeiServicesTablePointer (
 }\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
index aa990f7fdfd38d4811e79ec0fc297ccd482a2c7e..b45d12debfa0cf0edb189c81d8e64e49a2740ef7 100644 (file)
@@ -19,6 +19,18 @@ EFI_SYSTEM_TABLE   *gST;
 EFI_BOOT_SERVICES  *gBS;\r
 \r
 /**\r
+  The constructor function caches the pointer of Boot Services Table.\r
+  \r
+  The constructor function caches the pointer of Boot Services Table through System Table. \r
+  It will ASSERT() if the pointer of System Table is NULL.\r
+  It will ASSERT() if the pointer of Boot Services Table is NULL.\r
+  It will always return EFI_SUCCESS.\r
+\r
+  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param  SystemTable   A pointer to the EFI System Table.\r
+  \r
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
+\r
 **/\r
 EFI_STATUS\r
 UefiBootServicesTableLibConstructor (\r
index ac4b3ebfbfdb22c37bd66d3bcd4adf136f53c3b0..bd996ba8b565e5a7fbb76afbd521633dd4573ed8 100644 (file)
 EFI_RUNTIME_SERVICES  *gRT = NULL;\r
 \r
 /**\r
+  The constructor function caches the pointer of Runtime Services Table.\r
+  \r
+  The constructor function caches the pointer of Runtime Services Table. \r
+  It will ASSERT() if the pointer of Runtime Services Table is NULL.\r
+  It will always return EFI_SUCCESS.\r
+\r
+  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param  SystemTable   A pointer to the EFI System Table.\r
+  \r
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
+\r
 **/\r
 EFI_STATUS\r
 UefiRuntimeServicesTableLibConstructor (\r