git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10288 6f19259b...

[mirror_edk2.git] / MdeModulePkg / Include / Guid / Performance.h

diff --git a/MdeModulePkg/Include/Guid/Performance.h b/MdeModulePkg/Include/Guid/Performance.h
index b59fe8104059e25f4384042c6fb4cf75064282a2..73b2419094f6190d410bea4e95d5d311c8f175c5 100644 (file)
--- a/MdeModulePkg/Include/Guid/Performance.h
+++ b/MdeModulePkg/Include/Guid/Performance.h
@@ -1,16 +1,16 @@
 /** @file\r
   This file defines performance-related definitions, including the format of:\r
-  * performance GUID HOB\r
-  * performance protocol interfaces\r
+  * performance GUID HOB.\r
+  * performance protocol interfaces.\r
   * performance variables.  \r
 \r
-Copyright (c) 2009, 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
+Copyright (c) 2009 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
+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
@@ -26,17 +26,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 typedef struct {\r
   EFI_PHYSICAL_ADDRESS  Handle;\r
-  CHAR8                 Token[PEI_PERFORMANCE_STRING_SIZE];   ///> Measured token string name \r
-  CHAR8                 Module[PEI_PERFORMANCE_STRING_SIZE];  ///> Module string name\r
-  UINT64                StartTimeStamp;                       ///> Start time point\r
-  UINT64                EndTimeStamp;                         ///> End time point\r
+  CHAR8                 Token[PEI_PERFORMANCE_STRING_SIZE];   ///< Measured token string name. \r
+  CHAR8                 Module[PEI_PERFORMANCE_STRING_SIZE];  ///< Module string name.\r
+  UINT64                StartTimeStamp;                       ///< Start time point.\r
+  UINT64                EndTimeStamp;                         ///< End time point.\r
 } PEI_PERFORMANCE_LOG_ENTRY;\r
 \r
 //\r
 // The header must be aligned at 8 bytes.\r
 // \r
 typedef struct {\r
-  UINT32                NumberOfEntries;  ///> The number of all performance log entries\r
+  UINT32                NumberOfEntries;  ///< The number of all performance log entries.\r
   UINT32                Reserved;\r
 } PEI_PERFORMANCE_LOG_HEADER;\r
 \r
@@ -86,17 +86,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;
 \r
 typedef struct {\r
   EFI_PHYSICAL_ADDRESS  Handle;\r
-  CHAR8                 Token[DXE_PERFORMANCE_STRING_SIZE];  ///> Measured token string name \r
-  CHAR8                 Module[DXE_PERFORMANCE_STRING_SIZE]; ///> Module string name\r
-  UINT64                StartTimeStamp;                      ///> Start time point\r
-  UINT64                EndTimeStamp;                        ///> End time point\r
+  CHAR8                 Token[DXE_PERFORMANCE_STRING_SIZE];  ///< Measured token string name. \r
+  CHAR8                 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name.\r
+  UINT64                StartTimeStamp;                      ///< Start time point.\r
+  UINT64                EndTimeStamp;                        ///< End time point.\r
 } GAUGE_DATA_ENTRY;\r
 \r
 //\r
 // The header must be aligned at 8 bytes\r
 //\r
 typedef struct {\r
-  UINT32                NumberOfEntries; ///> The number of all performance gauge entries\r
+  UINT32                NumberOfEntries; ///< The number of all performance gauge entries.\r
   UINT32                Reserved;\r
 } GAUGE_DATA_HEADER;\r
 \r
@@ -110,13 +110,13 @@ typedef struct {
   If TimeStamp is zero, the start time in the record is filled in with the value\r
   read from the current time stamp.\r
 \r
-  @param  Handle                  Pointer to environment specific context used\r
+  @param  Handle                  The pointer to environment specific context used\r
                                   to identify the component being measured.\r
-  @param  Token                   Pointer to a Null-terminated ASCII string\r
+  @param  Token                   The pointer to a Null-terminated ASCII string\r
                                   that identifies the component being measured.\r
-  @param  Module                  Pointer to a Null-terminated ASCII string\r
+  @param  Module                  The pointer to a Null-terminated ASCII string\r
                                   that identifies the module being measured.\r
-  @param  TimeStamp               64-bit time stamp.\r
+  @param  TimeStamp               The 64-bit time stamp.\r
 \r
   @retval EFI_SUCCESS             The data was read correctly from the device.\r
   @retval EFI_OUT_OF_RESOURCES    There are not enough resources to record the measurement.\r
@@ -136,20 +136,20 @@ EFI_STATUS
   for the first matching record that contains a zero end time and fills in a valid end time.\r
 \r
   Searches the performance measurement log from the beginning of the log\r
-  for the first record that matches Handle, Token, and Module and has an end time value of zero.\r
+  for the first record that matches Handle, Token, and Module, and has an end time value of zero.\r
   If the record can not be found then return EFI_NOT_FOUND.\r
   If the record is found and TimeStamp is not zero,\r
   then the end time in the record is filled in with the value specified by TimeStamp.\r
   If the record is found and TimeStamp is zero, then the end time in the matching record\r
   is filled in with the current time stamp value.\r
 \r
-  @param  Handle                  Pointer to environment specific context used\r
+  @param  Handle                  The pointer to environment specific context used\r
                                   to identify the component being measured.\r
-  @param  Token                   Pointer to a Null-terminated ASCII string\r
+  @param  Token                   The pointer to a Null-terminated ASCII string\r
                                   that identifies the component being measured.\r
-  @param  Module                  Pointer to a Null-terminated ASCII string\r
+  @param  Module                  The pointer to a Null-terminated ASCII string\r
                                   that identifies the module being measured.\r
-  @param  TimeStamp               64-bit time stamp.\r
+  @param  TimeStamp               The 64-bit time stamp.\r
 \r
   @retval EFI_SUCCESS             The end of  the measurement was recorded.\r
   @retval EFI_NOT_FOUND           The specified measurement record could not be found.\r