added some comments in BaseLib
[mirror_edk2.git] / MdePkg / Library / UefiRuntimeServicesTableLib / UefiRuntimeServicesTableLib.c
CommitLineData
878ddf1f 1/** @file\r
2 UEFI Runtime Services Table 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: UefiRuntimeServicesTableLib.c\r
14\r
15**/\r
16\r
878ddf1f 17EFI_RUNTIME_SERVICES *gRT = NULL;\r
18\r
19/**\r
a42b1820 20 The constructor function caches the pointer of Runtime Services Table.\r
9f73d38d 21\r
22 The constructor function caches the pointer of Runtime Services Table.\r
a42b1820 23 It will ASSERT() if the pointer of Runtime Services Table is NULL.\r
24 It will always return EFI_SUCCESS.\r
25\r
26 @param ImageHandle The firmware allocated handle for the EFI image.\r
27 @param SystemTable A pointer to the EFI System Table.\r
9f73d38d 28\r
a42b1820 29 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
30\r
878ddf1f 31**/\r
32EFI_STATUS\r
33UefiRuntimeServicesTableLibConstructor (\r
34 IN EFI_HANDLE ImageHandle,\r
35 IN EFI_SYSTEM_TABLE *SystemTable\r
36 )\r
37{\r
38 //\r
39 // Cache pointer to the EFI Runtime Services Table\r
40 //\r
41 gRT = SystemTable->RuntimeServices;\r
42 ASSERT (gRT != NULL);\r
43 return EFI_SUCCESS;\r
44}\r