added some comments in BaseLib
authorvanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 20 Jul 2006 04:00:59 +0000 (04:00 +0000)
committervanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 20 Jul 2006 04:00:59 +0000 (04:00 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1053 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/DxeServicesTableLib.h
MdePkg/Include/Library/UefiBootServicesTableLib.h
MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.c

index b3aa42b127428cb712e293d5564540e91fddbfd8..fc39725c92494e0bc59cddf1cb9f9ac5d06e2db2 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   Library that provides a global pointer to the DXE Services Table\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
+  Copyright (c) 2006, Intel Corporation\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
+  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.h\r
 \r
@@ -18,7 +18,7 @@
 #define __DXE_SERVICES_TABLE_LIB_H__\r
 \r
 //\r
-//\r
+// Cached copy of the System Configuration Table\r
 //\r
 extern EFI_DXE_SERVICES  *gDS;\r
 \r
index 73a2e39a5ddcc858924bd11dd963a0bf9f4f5783..df900a7eceeb4c95b09750fb69b5c741e71cf83b 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   Library that provides a global pointer to the UEFI Boot Services Tables\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
+  Copyright (c) 2006, Intel Corporation\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
+  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:  UefiBootServicesTableLib.h\r
 \r
 #define __UEFI_BOOT_SERVICES_TABLE_LIB_H__\r
 \r
 //\r
-//\r
+// Cache the Image Handle\r
 //\r
 extern EFI_HANDLE         gImageHandle;\r
+\r
+//\r
+// Cache pointer to the EFI System Table\r
+//\r
 extern EFI_SYSTEM_TABLE   *gST;\r
+\r
+//\r
+// Cache pointer to the EFI Boot Services Table\r
+//\r
 extern EFI_BOOT_SERVICES  *gBS;\r
 \r
 #endif\r
index d1dfe43710c5095f725345abdf961e554ac38b93..4f1ce3a1f8812368715654f4191cbb577c31cb1e 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   Library that provides a global pointer to the UEFI Runtime Services Tables\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
+  Copyright (c) 2006, Intel Corporation\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
+  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:  UefiRuntimeServicesTableLib.h\r
 \r
@@ -18,7 +18,7 @@
 #define __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__\r
 \r
 //\r
-//\r
+// Cached copy of the EFI Runtime Services Table\r
 //\r
 extern EFI_RUNTIME_SERVICES  *gRT;\r
 \r
index 40d4f641a4cf449cb80fba15632e872da01df100..fac2dde8dc7341707214715cdabd50e287ba569c 100644 (file)
@@ -2,33 +2,35 @@
   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
+  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
+  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
+//\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
+\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
+\r
   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
 \r
 **/\r
@@ -40,6 +42,9 @@ DxeServicesTableLibConstructor (
 {\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
index bd996ba8b565e5a7fbb76afbd521633dd4573ed8..bf15467bbec028914088d9975e30cee829bd7bc2 100644 (file)
@@ -2,33 +2,30 @@
   UEFI Runtime Services Table 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
+  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
+  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:  UefiRuntimeServicesTableLib.c\r
 \r
 **/\r
 \r
-//\r
-// Cached copy of the EFI Runtime Services Table\r
-//\r
 EFI_RUNTIME_SERVICES  *gRT = NULL;\r
 \r
 /**\r
   The constructor function caches the pointer of Runtime Services Table.\r
-  \r
-  The constructor function caches the pointer of Runtime Services Table. \r
+\r
+  The constructor function caches the pointer of Runtime Services Table.\r
   It will ASSERT() if the pointer of Runtime Services 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
+\r
   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
 \r
 **/\r