added some comments in BaseLib

[mirror_edk2.git] / MdePkg / Library / DxeServicesTableLib / DxeServicesTableLib.c

/** @file\r
  DXE Library.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\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:  DxeServicesTableLib.c\r
\r
**/\r
\r
\r
//\r
// Cached copy of the System Configuration Table\r
//\r
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
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Cached copy of the System Configuration Table\r
  //\r
  Status = EfiGetSystemConfigurationTable (&gEfiDxeServicesTableGuid, (VOID **) &gDS);\r
  ASSERT_EFI_ERROR (Status);\r
  ASSERT (gDS != NULL);\r
\r
  return Status;\r
}\r