Move SmmLib from IntelFrameworkPkg to MdePkg because this library is useful to both...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / DataHub.h

diff --git a/IntelFrameworkPkg/Include/Protocol/DataHub.h b/IntelFrameworkPkg/Include/Protocol/DataHub.h
index d0db8397949ebc48159fa92f3bcfde932ee38e10..4b51e7a8c21d26761a59d16e26c51e6c52323dc8 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/DataHub.h
+++ b/IntelFrameworkPkg/Include/Protocol/DataHub.h
@@ -3,10 +3,7 @@
   data and those wishing to be made aware of all information that\r
   has been logged.\r
 \r
-  This protocol is defined in Framework for EFI Data Hub Specification.\r
-  Version 0.9.\r
-\r
-  Copyright (c) 2007 - 2009, Intel Corporation\r
+  Copyright (c) 2007 - 2010, 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
@@ -15,6 +12,10 @@
   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
+  @par Revision Reference:\r
+  The Data Hub Protocol is defined in Framework for EFI Data Hub Specification\r
+  Version 0.9.\r
+\r
 **/\r
 \r
 #ifndef __DATA_HUB_H__\r
@@ -31,9 +32,8 @@
 // A Data Record is an EFI_DATA_RECORD_HEADER followed by RecordSize bytes of\r
 //  data. The format of the data is defined by the DataRecordGuid.\r
 //\r
-// If EFI_DATA_RECORD_HEADER is extended in the future the Version number must\r
-//  change and the HeaderSize will change if the definition of\r
-//  EFI_DATA_RECORD_HEADER is extended.\r
+// If EFI_DATA_RECORD_HEADER is extended in the future, the Version number and HeaderSize must\r
+//  change. \r
 //\r
 // The logger is responcible for initializing:\r
 //  Version, HeaderSize, RecordSize, DataRecordGuid, DataRecordClass\r
@@ -56,7 +56,7 @@ typedef struct {
 //\r
 // Definition of DataRecordClass. These are used to filter out class types\r
 // at a very high level. The DataRecordGuid still defines the format of\r
-// the data. See DateHub.doc for rules on what can and can not be a\r
+// the data. See the Data Hub Specification for rules on what can and can not be a\r
 // new DataRecordClass\r
 //\r
 #define EFI_DATA_RECORD_CLASS_DEBUG         0x0000000000000001\r
@@ -99,7 +99,7 @@ EFI_STATUS
 \r
   @param  This                  The EFI_DATA_HUB_PROTOCOL instance.\r
   @param  MonotonicCount        On input, it specifies the Record to return.\r
-                                An input of zero means to return the first record.\r
+                                An input of zero means to return the first record, as does an input of one.\r
   @param  FilterDriver          If FilterDriver is not passed in a MonotonicCount of zero,\r
                                 it means to return the first data record. If FilterDriver is passed in,\r
                                 then a MonotonicCount of zero means to return the first data not yet read\r
@@ -114,9 +114,9 @@ EFI_STATUS
                                 data records exist in the system.\r
   @retval EFI_OUT_OF_RESOURCES  Record was not returned due to lack\r
                                 of system resources.\r
-  @note: Inconsistent with specification here: \r
-         In Framework for EFI Data Hub Specification,Version 0.9, This definition is named as\r
-         EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistance is remained for backward compatibility \r
+  @note  Inconsistent with specification here: \r
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as\r
+         EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is maintained for backward compatibility. \r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -146,9 +146,9 @@ EFI_STATUS
   @retval EFI_ALREADY_STARTED   FilterEvent was previously registered and cannot be registered again.\r
   @retval EFI_OUT_OF_RESOURCES  The filter driver event was not registered\r
                                 due to lack of system resources.\r
-  @note: Inconsistent with specification here: \r
-         In Framework for EFI Data Hub Specification,Version 0.9, This definition is named as\r
-         EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistance is remained for backward compatibility \r
+  @note  Inconsistent with specification here: \r
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as\r
+         EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency is maintained for backward compatibility. \r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -169,9 +169,9 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The filter driver represented by FilterEvent was shut off.\r
   @retval EFI_NOT_FOUND         FilterEvent did not exist.\r
-  @note: Inconsistent with specification here: \r
-         In Framework for EFI Data Hub Specification,Version 0.9, This definition is named as\r
-         EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistance is remained for backward compatibility \r
+  @note  Inconsistent with specification here: \r
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as\r
+         EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency is maintained for backward compatibility.  \r
 **/\r
 typedef\r
 EFI_STATUS\r