Code scrub performance library instances in MdeModulePkg

[mirror_edk2.git] / MdeModulePkg / Library / DxePerformanceLib / DxePerformanceLib.c

diff --git a/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.c b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.c
index 35a50f726b12fe4582d9d530fba2ec56f3ae62e6..8da302769acf9ef059fc1db7dce46983871b2929 100644 (file)
--- a/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.c
+++ b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.c
@@ -1,7 +1,12 @@
 /** @file\r
   Performance Library\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+  This library instance provides infrastructure for DXE phase drivers to log performance\r
+  data. It consumes Performance Protocol published by DxeCorePerformanceLib\r
+  to log performance data. If Performance Protocol is not available, it does not log any\r
+  performance information.\r
+\r
+  Copyright (c) 2006 - 2008, 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
@@ -22,6 +27,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/PcdLib.h>\r
 \r
+//\r
+// The cached performance protocol interface.\r
+//\r
 PERFORMANCE_PROTOCOL    *mPerformance = NULL;\r
 \r
 /**\r
@@ -165,7 +173,7 @@ EndPerformanceMeasurement (
 \r
   @param  LogEntryKey             On entry, the key of the performance measurement log entry to retrieve.\r
                                   0, then the first performance measurement log entry is retrieved.\r
-                                  On exit, the key of the next performance lof entry entry.\r
+                                  On exit, the key of the next performance log entry.\r
   @param  Handle                  Pointer to environment specific context used to identify the component\r
                                   being measured.\r
   @param  Token                   Pointer to a Null-terminated ASCII string that identifies the component\r