added some comments in BaseLib
[mirror_edk2.git] / MdePkg / Library / DxeServicesTableLib / DxeServicesTableLib.c
CommitLineData
878ddf1f 1/** @file\r
2 DXE Library.\r
3\r
4 Copyright (c) 2006, Intel Corporation<BR>\r
9f73d38d 5 All rights reserved. This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
878ddf1f 9\r
9f73d38d 10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
878ddf1f 12\r
13 Module Name: DxeServicesTableLib.c\r
14\r
15**/\r
16\r
17\r
9f73d38d 18//\r
19// Cached copy of the System Configuration Table\r
20//\r
878ddf1f 21EFI_DXE_SERVICES *gDS = NULL;\r
22\r
23/**\r
a42b1820 24 The constructor function caches the pointer of System Configuration Table.\r
9f73d38d 25\r
26 The constructor function caches the pointer of System Configuration Table.\r
a42b1820 27 It will ASSERT() if that operation fails.\r
28 It will ASSERT() if the pointer of System Configuration Table is NULL.\r
29 It will always return EFI_SUCCESS.\r
30\r
31 @param ImageHandle The firmware allocated handle for the EFI image.\r
32 @param SystemTable A pointer to the EFI System Table.\r
9f73d38d 33\r
a42b1820 34 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
35\r
878ddf1f 36**/\r
37EFI_STATUS\r
38DxeServicesTableLibConstructor (\r
39 IN EFI_HANDLE ImageHandle,\r
40 IN EFI_SYSTEM_TABLE *SystemTable\r
41 )\r
42{\r
43 EFI_STATUS Status;\r
44\r
9f73d38d 45 //\r
46 // Cached copy of the System Configuration Table\r
47 //\r
878ddf1f 48 Status = EfiGetSystemConfigurationTable (&gEfiDxeServicesTableGuid, (VOID **) &gDS);\r
49 ASSERT_EFI_ERROR (Status);\r
50 ASSERT (gDS != NULL);\r
51\r
52 return Status;\r
53}\r