Add more comments for DxeServicesTableLib library instance.
[people/mcb30/edk2.git] / edk2 / MdePkg / Library / DxeServicesTableLib / DxeServicesTableLib.c
1 /** @file\r
2   This library produce EFI_DXE_SERVICE pointer in global EFI system table. It should\r
3   be linked to a DXE driver who use gBS.\r
4   \r
5   This library contains contruct function to retrieve EFI_DXE_SERIVCE, this construct\r
6   function will be invoked in DXE driver's autogen file.\r
7 \r
8   Copyright (c) 2006, Intel Corporation<BR>\r
9   All rights reserved. This program and the accompanying materials\r
10   are licensed and made available under the terms and conditions of the BSD License\r
11   which accompanies this distribution.  The full text of the license may be found at\r
12   http://opensource.org/licenses/bsd-license.php\r
13 \r
14   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
15   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
16 \r
17 **/\r
18 \r
19 #include <PiDxe.h>\r
20 #include <Guid/DxeServices.h>\r
21 #include <Library/DxeServicesTableLib.h>\r
22 #include <Library/DebugLib.h>\r
23 #include <Library/UefiLib.h>\r
24 \r
25 //\r
26 // Cache copy of the DXE Services Table\r
27 //\r
28 EFI_DXE_SERVICES  *gDS      = NULL;\r
29 \r
30 /**\r
31   The constructor function caches the pointer of DXE Services Table.\r
32 \r
33   The constructor function caches the pointer of DXE Services Table.\r
34   It will ASSERT() if that operation fails.\r
35   It will ASSERT() if the pointer of DXE Services Table is NULL.\r
36   It will always return EFI_SUCCESS.\r
37 \r
38   @param  ImageHandle   The firmware allocated handle for the EFI image.\r
39   @param  SystemTable   A pointer to the EFI System Table.\r
40 \r
41   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
42 \r
43 **/\r
44 EFI_STATUS\r
45 EFIAPI\r
46 DxeServicesTableLibConstructor (\r
47   IN EFI_HANDLE        ImageHandle,\r
48   IN EFI_SYSTEM_TABLE  *SystemTable\r
49   )\r
50 {\r
51   EFI_STATUS  Status;\r
52 \r
53   //\r
54   // Cache copy of the DXE Services Table\r
55   //\r
56   Status = EfiGetSystemConfigurationTable (&gEfiDxeServicesTableGuid, (VOID **) &gDS);\r
57   ASSERT_EFI_ERROR (Status);\r
58   ASSERT (gDS != NULL);\r
59 \r
60   return Status;\r
61 }\r