IntelFrameworkPkg/Include/Protocol/DataHub.h File Reference


Data Structures

struct  EFI_DATA_RECORD_HEADER
struct  _EFI_DATA_HUB_PROTOCOL

Defines

#define EFI_DATA_HUB_PROTOCOL_GUID
#define EFI_DATA_RECORD_HEADER_VERSION   0x0100
#define EFI_DATA_RECORD_CLASS_DEBUG   0x0000000000000001
#define EFI_DATA_RECORD_CLASS_ERROR   0x0000000000000002
#define EFI_DATA_RECORD_CLASS_DATA   0x0000000000000004
#define EFI_DATA_RECORD_CLASS_PROGRESS_CODE   0x0000000000000008

Typedefs

typedef struct
_EFI_DATA_HUB_PROTOCOL 
EFI_DATA_HUB_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_DATA_HUB_LOG_DATA )(IN EFI_DATA_HUB_PROTOCOL *This, IN EFI_GUID *DataRecordGuid, IN EFI_GUID *ProducerName, IN UINT64 DataRecordClass, IN VOID *RawData, IN UINT32 RawDataSize)
typedef EFI_STATUS(EFIAPI * EFI_DATA_HUB_GET_NEXT_RECORD )(IN EFI_DATA_HUB_PROTOCOL *This, IN OUT UINT64 *MonotonicCount, IN EFI_EVENT *FilterDriver, OUT EFI_DATA_RECORD_HEADER **Record)
typedef EFI_STATUS(EFIAPI * EFI_DATA_HUB_REGISTER_FILTER_DRIVER )(IN EFI_DATA_HUB_PROTOCOL *This, IN EFI_EVENT FilterEvent, IN EFI_TPL FilterTpl, IN UINT64 FilterClass, IN EFI_GUID *FilterDataRecordGuid)
typedef EFI_STATUS(EFIAPI * EFI_DATA_HUB_UNREGISTER_FILTER_DRIVER )(IN EFI_DATA_HUB_PROTOCOL *This, IN EFI_EVENT FilterEvent)

Variables

EFI_GUID gEfiDataHubProtocolGuid

Detailed Description

The data hub protocol is used both by agents wishing to log data and those wishing to be made aware of all information that has been logged. This protocol may only be called <= TPL_NOTIFY.

Copyright (c) 2007 - 2010, 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 that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
The Data Hub Protocol is defined in Framework for EFI Data Hub Specification Version 0.9.

Define Documentation

#define EFI_DATA_HUB_PROTOCOL_GUID

Value:

{ \
    0xae80d021, 0x618e, 0x11d4, {0xbc, 0xd7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
  }

#define EFI_DATA_RECORD_CLASS_DATA   0x0000000000000004

#define EFI_DATA_RECORD_CLASS_DEBUG   0x0000000000000001

#define EFI_DATA_RECORD_CLASS_ERROR   0x0000000000000002

#define EFI_DATA_RECORD_CLASS_PROGRESS_CODE   0x0000000000000008

#define EFI_DATA_RECORD_HEADER_VERSION   0x0100


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_DATA_HUB_GET_NEXT_RECORD)(IN EFI_DATA_HUB_PROTOCOL *This, IN OUT UINT64 *MonotonicCount, IN EFI_EVENT *FilterDriver, OUT EFI_DATA_RECORD_HEADER **Record)

Allows the system data log to be searched.

Parameters:
This The EFI_DATA_HUB_PROTOCOL instance.
MonotonicCount On input, it specifies the Record to return. An input of zero means to return the first record, as does an input of one.
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 by FilterDriver.
Record Returns a dynamically allocated memory buffer with a data record that matches MonotonicCount.
Return values:
EFI_SUCCESS Data was returned in Record.
EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.
EFI_NOT_FOUND MonotonicCount does not match any data record in the system. If a MonotonicCount of zero was passed in, then no data records exist in the system.
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(EFIAPI * EFI_DATA_HUB_LOG_DATA)(IN EFI_DATA_HUB_PROTOCOL *This, IN EFI_GUID *DataRecordGuid, IN EFI_GUID *ProducerName, IN UINT64 DataRecordClass, IN VOID *RawData, IN UINT32 RawDataSize)

Logs a data record to the system event log.

Parameters:
This The EFI_DATA_HUB_PROTOCOL instance.
DataRecordGuid A GUID that indicates the format of the data passed into RawData.
ProducerName A GUID that indicates the identity of the caller to this API.
DataRecordClass This class indicates the generic type of the data record.
RawData The DataRecordGuid-defined data to be logged.
RawDataSize The size in bytes of RawData.
Return values:
EFI_SUCCESS Data was logged.
EFI_OUT_OF_RESOURCES Data was not logged due to lack of system resources.

typedef EFI_STATUS(EFIAPI * EFI_DATA_HUB_REGISTER_FILTER_DRIVER)(IN EFI_DATA_HUB_PROTOCOL *This, IN EFI_EVENT FilterEvent, IN EFI_TPL FilterTpl, IN UINT64 FilterClass, IN EFI_GUID *FilterDataRecordGuid)

Registers an event to be signaled every time a data record is logged in the system.

Parameters:
This The EFI_DATA_HUB_PROTOCOL instance.
FilterEvent The EFI_EVENT to signal whenever data that matches FilterClass is logged in the system.
FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled. It is strongly recommended that you use the lowest EFI_TPL possible.
FilterClass FilterEvent will be signaled whenever a bit in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass. If FilterClass is zero, no class-based filtering will be performed.
FilterDataRecordGuid FilterEvent will be signaled whenever FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid. If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed.
Return values:
EFI_SUCCESS The filter driver event was registered
EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again.
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(EFIAPI * EFI_DATA_HUB_UNREGISTER_FILTER_DRIVER)(IN EFI_DATA_HUB_PROTOCOL *This, IN EFI_EVENT FilterEvent)

Stops a filter driver from being notified when data records are logged.

Parameters:
This The EFI_DATA_HUB_PROTOCOL instance.
FilterEvent The EFI_EVENT to remove from the list of events to be signaled every time errors are logged.
Return values:
EFI_SUCCESS The filter driver represented by FilterEvent was shut off.
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.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1