X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FDataHub.h;h=7e965fd94c3e770164a274fdfe3b9486806d231a;hp=82bd928751aaba5bb68b3c829f2aefad8d4ed6dd;hb=ce9b1e3ae0bdcf8f926ea5132f0bd34e7d384973;hpb=4e97801cfaa9859814ea838f93f18fb7d64e2e26

diff --git a/IntelFrameworkPkg/Include/Protocol/DataHub.h b/IntelFrameworkPkg/Include/Protocol/DataHub.h
index 82bd928751..7e965fd94c 100644
--- a/IntelFrameworkPkg/Include/Protocol/DataHub.h
+++ b/IntelFrameworkPkg/Include/Protocol/DataHub.h
@@ -3,9 +3,6 @@
   data and those wishing to be made aware of all information that
   has been logged.
 
-  For more information please look at Intel Platform Innovation
-  Framework for EFI Data Hub Specification.
-
   Copyright (c) 2007 - 2009, Intel Corporation
   All rights reserved. This program and the accompanying materials
   are licensed and made available under the terms and conditions of the BSD License
@@ -15,10 +12,8 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
-  Module Name:  DataHub.h
-
   @par Revision Reference:
-  This protocol is defined in Framework for EFI Data Hub Specification.
+  The Data Hub Protocol is defined in Framework for EFI Data Hub Specification
   Version 0.9.
 
 **/
@@ -26,8 +21,6 @@
 #ifndef __DATA_HUB_H__
 #define __DATA_HUB_H__
 
-#include <PiDxe.h>
-
 #define EFI_DATA_HUB_PROTOCOL_GUID \
   { \
     0xae80d021, 0x618e, 0x11d4, {0xbc, 0xd7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
@@ -39,9 +32,8 @@
 // A Data Record is an EFI_DATA_RECORD_HEADER followed by RecordSize bytes of
 //  data. The format of the data is defined by the DataRecordGuid.
 //
-// If EFI_DATA_RECORD_HEADER is extended in the future the Version number must
-//  change and the HeaderSize will change if the definition of
-//  EFI_DATA_RECORD_HEADER is extended.
+// If EFI_DATA_RECORD_HEADER is extended in the future, the Version number and HeaderSize must
+//  change. 
 //
 // The logger is responcible for initializing:
 //  Version, HeaderSize, RecordSize, DataRecordGuid, DataRecordClass
@@ -64,7 +56,7 @@ typedef struct {
 //
 // Definition of DataRecordClass. These are used to filter out class types
 // at a very high level. The DataRecordGuid still defines the format of
-// the data. See DateHub.doc for rules on what can and can not be a
+// the data. See the Data Hub Specification for rules on what can and can not be a
 // new DataRecordClass
 //
 #define EFI_DATA_RECORD_CLASS_DEBUG         0x0000000000000001
@@ -81,7 +73,6 @@ typedef struct _EFI_DATA_HUB_PROTOCOL EFI_DATA_HUB_PROTOCOL;
   Logs a data record to the system event log.
 
   @param  This                  The EFI_DATA_HUB_PROTOCOL instance.
-  @param  description
   @param  DataRecordGuid        A GUID that indicates the format of the data passed into RawData.
   @param  ProducerName          A GUID that indicates the identity of the caller to this API.
   @param  DataRecordClass       This class indicates the generic type of the data record.
@@ -108,7 +99,7 @@ EFI_STATUS
 
   @param  This                  The EFI_DATA_HUB_PROTOCOL instance.
   @param  MonotonicCount        On input, it specifies the Record to return.
-                                An input of zero means to return the first record.
+                                An input of zero means to return the first record, as does an input of one.
   @param  FilterDriver          If FilterDriver is not passed in a MonotonicCount of zero,
                                 it means to return the first data record. If FilterDriver is passed in,
                                 then a MonotonicCount of zero means to return the first data not yet read
@@ -123,7 +114,9 @@ EFI_STATUS
                                 data records exist in the system.
   @retval EFI_OUT_OF_RESOURCES  Record was not returned due to lack
                                 of system resources.
-
+  @note: Inconsistent with specification here: 
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as
+         EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is maintained for backward compatibility. 
 **/
 typedef
 EFI_STATUS
@@ -153,7 +146,9 @@ EFI_STATUS
   @retval EFI_ALREADY_STARTED   FilterEvent was previously registered and cannot be registered again.
   @retval EFI_OUT_OF_RESOURCES  The filter driver event was not registered
                                 due to lack of system resources.
-
+  @note: Inconsistent with specification here: 
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as
+         EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency is maintained for backward compatibility. 
 **/
 typedef
 EFI_STATUS
@@ -174,7 +169,9 @@ EFI_STATUS
 
   @retval EFI_SUCCESS           The filter driver represented by FilterEvent was shut off.
   @retval EFI_NOT_FOUND         FilterEvent did not exist.
-
+  @note: Inconsistent with specification here: 
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as
+         EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency is maintained for backward compatibility.  
 **/
 typedef
 EFI_STATUS