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
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
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
// 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
//\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
\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
@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
+ 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
@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
+ 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
@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
+ 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