]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/PerformanceLib.h
Add 2 functions to UefiLib library class: CatSPrint and CatVSPrint.
[mirror_edk2.git] / MdePkg / Include / Library / PerformanceLib.h
index 06de00d8d88f9fc3cba2a4eb13cbb586106695cb..8d7185e6ae7304f16c2012009a562abc292361fb 100644 (file)
@@ -1,25 +1,23 @@
 /** @file\r
-  Library that provides services to measure module execution performance\r
+  Provides services to log the execution times and retrieve them later.\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 - 2008, Intel Corporation. All rights reserved.<BR>\r
+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
-\r
-  Module Name:  PerformanceLib.h\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
 **/\r
 \r
 #ifndef __PERFORMANCE_LIB_H__\r
 #define __PERFORMANCE_LIB_H__\r
 \r
-//\r
-// Performance library propery mask bits\r
-//\r
+///\r
+/// Performance library propery mask bits\r
+///\r
 #define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED  0x00000001\r
 \r
 /**\r
@@ -40,6 +38,7 @@
 \r
   @retval RETURN_SUCCESS          The start of the measurement was recorded.\r
   @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r
+  @retval RETURN_DEVICE_ERROR     A device error reading the time stamp.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -72,6 +71,7 @@ StartPerformanceMeasurement (
 \r
   @retval RETURN_SUCCESS          The end of  the measurement was recorded.\r
   @retval RETURN_NOT_FOUND        The specified measurement record could not be found.\r
+  @retval RETURN_DEVICE_ERROR     A device error reading the time stamp.\r
 \r
 **/\r
 RETURN_STATUS\r