X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FDxeServicesTableLib%2FDxeServicesTableLib.c;h=829e74f2807fa4d2327fe011b1790693393412af;hp=f130b207e5ebaf8238ebb720e9d13b2521c898a9;hb=151c1ccdcd6960c550fa491bd0ed467416bb2b74;hpb=878ddf1fc3540a715f63594ed22b6929e881afb4

diff --git a/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c b/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
index f130b207e5..829e74f280 100644
--- a/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
+++ b/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
@@ -2,23 +2,37 @@
   DXE Library.
 
   Copyright (c) 2006, Intel Corporation<BR>
-  All rights reserved. This program and the accompanying materials                          
-  are licensed and made available under the terms and conditions of the BSD License         
-  which accompanies this distribution.  The full text of the license may be found at        
-  http://opensource.org/licenses/bsd-license.php                                            
+  All rights reserved. This program and the accompanying materials
+  are licensed and made available under the terms and conditions of the BSD License
+  which accompanies this distribution.  The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
 
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Module Name:  DxeServicesTableLib.c
 
 **/
 
 
-
+//
+// Cache copy of the DXE Services Table
+//
 EFI_DXE_SERVICES  *gDS      = NULL;
 
 /**
+  The constructor function caches the pointer of DXE Services Table.
+
+  The constructor function caches the pointer of DXE Services Table.
+  It will ASSERT() if that operation fails.
+  It will ASSERT() if the pointer of DXE Services Table is NULL.
+  It will always return EFI_SUCCESS.
+
+  @param  ImageHandle   The firmware allocated handle for the EFI image.
+  @param  SystemTable   A pointer to the EFI System Table.
+
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
+
 **/
 EFI_STATUS
 DxeServicesTableLibConstructor (
@@ -28,6 +42,9 @@ DxeServicesTableLibConstructor (
 {
   EFI_STATUS  Status;
 
+  //
+  // Cache copy of the DXE Services Table
+  //
   Status = EfiGetSystemConfigurationTable (&gEfiDxeServicesTableGuid, (VOID **) &gDS);
   ASSERT_EFI_ERROR (Status);
   ASSERT (gDS != NULL);