refine comments for EFI_CONSOLE_CONTROL_PROTOCOL

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

diff --git a/MdeModulePkg/Include/Protocol/Performance.h b/MdeModulePkg/Include/Protocol/Performance.h
index 716148824680b799e526446e544c9e24774c8d5e..9d0253912591c631d064b4549ddbcda802e074d1 100644 (file)
--- a/MdeModulePkg/Include/Protocol/Performance.h
+++ b/MdeModulePkg/Include/Protocol/Performance.h
@@ -23,14 +23,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;\r
 \r
+#define SEC_TOK                         "SEC"\r
 #define DXE_TOK                         "DXE"\r
 #define SHELL_TOK                       "SHELL"\r
 #define PEI_TOK                         "PEI"\r
 #define BDS_TOK                         "BDS"\r
-#define DRIVERBINDING_START_TOK         "DriverBinding:Start"\r
-#define DRIVERBINDING_SUPPORT_TOK       "DriverBinding:Support"\r
-#define START_IMAGE_TOK                 "StartImage"\r
-#define LOAD_IMAGE_TOK                  "LoadImage"\r
+#define DRIVERBINDING_START_TOK         "DB:Start:"\r
+#define DRIVERBINDING_SUPPORT_TOK       "DB:Support:"\r
+#define START_IMAGE_TOK                 "StartImage:"\r
+#define LOAD_IMAGE_TOK                  "LoadImage:"\r
 \r
 //\r
 // DXE_PERFORMANCE_STRING_SIZE must be a multiple of 8.\r
@@ -45,17 +46,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;
 \r
 typedef struct {\r
   EFI_PHYSICAL_ADDRESS  Handle;\r
-  CHAR8                 Token[DXE_PERFORMANCE_STRING_SIZE];\r
-  CHAR8                 Module[DXE_PERFORMANCE_STRING_SIZE];\r
-  UINT64                StartTimeStamp;\r
-  UINT64                EndTimeStamp;\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;\r
+  UINT32                NumberOfEntries; /// The number of all performance guage entries\r
   UINT32                Reserved;\r
 } GAUGE_DATA_HEADER;\r
 \r
@@ -136,7 +137,7 @@ EFI_STATUS
   @param  GaugeDataEntry          The indirect pointer to the gauge data entry specified by LogEntryKey\r
                                   if the retrieval is successful.\r
 \r
-  @retval EFI_SUCCESS             The GuageDataEntry is successfuly found based on LogEntryKey.\r
+  @retval EFI_SUCCESS             The GuageDataEntry is successfully found based on LogEntryKey.\r
   @retval EFI_NOT_FOUND           The LogEntryKey is the last entry (equals to the total entry number).\r
   @retval EFI_INVALIDE_PARAMETER  The LogEntryKey is not a valid entry (greater than the total entry number).\r
   @retval EFI_INVALIDE_PARAMETER  GaugeDataEntry is NULL.\r