2 The data hub protocol is used both by agents wishing to log
3 data and those wishing to be made aware of all information that
6 This protocol is defined in Framework for EFI Data Hub Specification.
9 Copyright (c) 2007 - 2009, Intel Corporation
10 All rights reserved. This program and the accompanying materials
11 are licensed and made available under the terms and conditions of the BSD License
12 which accompanies this distribution. The full text of the license may be found at
13 http://opensource.org/licenses/bsd-license.php
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 #ifndef __DATA_HUB_H__
21 #define __DATA_HUB_H__
24 #define EFI_DATA_HUB_PROTOCOL_GUID \
26 0xae80d021, 0x618e, 0x11d4, {0xbc, 0xd7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
30 // EFI generic Data Hub Header
32 // A Data Record is an EFI_DATA_RECORD_HEADER followed by RecordSize bytes of
33 // data. The format of the data is defined by the DataRecordGuid.
35 // If EFI_DATA_RECORD_HEADER is extended in the future the Version number must
36 // change and the HeaderSize will change if the definition of
37 // EFI_DATA_RECORD_HEADER is extended.
39 // The logger is responcible for initializing:
40 // Version, HeaderSize, RecordSize, DataRecordGuid, DataRecordClass
42 // The Data Hub driver is responcible for initializing:
43 // LogTime and LogMonotonicCount.
45 #define EFI_DATA_RECORD_HEADER_VERSION 0x0100
50 EFI_GUID DataRecordGuid
;
51 EFI_GUID ProducerName
;
52 UINT64 DataRecordClass
;
54 UINT64 LogMonotonicCount
;
55 } EFI_DATA_RECORD_HEADER
;
58 // Definition of DataRecordClass. These are used to filter out class types
59 // at a very high level. The DataRecordGuid still defines the format of
60 // the data. See DateHub.doc for rules on what can and can not be a
61 // new DataRecordClass
63 #define EFI_DATA_RECORD_CLASS_DEBUG 0x0000000000000001
64 #define EFI_DATA_RECORD_CLASS_ERROR 0x0000000000000002
65 #define EFI_DATA_RECORD_CLASS_DATA 0x0000000000000004
66 #define EFI_DATA_RECORD_CLASS_PROGRESS_CODE 0x0000000000000008
69 // Forward reference for pure ANSI compatability
71 typedef struct _EFI_DATA_HUB_PROTOCOL EFI_DATA_HUB_PROTOCOL
;
74 Logs a data record to the system event log.
76 @param This The EFI_DATA_HUB_PROTOCOL instance.
77 @param DataRecordGuid A GUID that indicates the format of the data passed into RawData.
78 @param ProducerName A GUID that indicates the identity of the caller to this API.
79 @param DataRecordClass This class indicates the generic type of the data record.
80 @param RawData The DataRecordGuid-defined data to be logged.
81 @param RawDataSize The size in bytes of RawData.
83 @retval EFI_SUCCESS Data was logged.
84 @retval EFI_OUT_OF_RESOURCES Data was not logged due to lack of system resources.
89 (EFIAPI
*EFI_DATA_HUB_LOG_DATA
)(
90 IN EFI_DATA_HUB_PROTOCOL
*This
,
91 IN EFI_GUID
*DataRecordGuid
,
92 IN EFI_GUID
*ProducerName
,
93 IN UINT64 DataRecordClass
,
99 Allows the system data log to be searched.
101 @param This The EFI_DATA_HUB_PROTOCOL instance.
102 @param MonotonicCount On input, it specifies the Record to return.
103 An input of zero means to return the first record.
104 @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero,
105 it means to return the first data record. If FilterDriver is passed in,
106 then a MonotonicCount of zero means to return the first data not yet read
108 @param Record Returns a dynamically allocated memory buffer with a data
109 record that matches MonotonicCount.
111 @retval EFI_SUCCESS Data was returned in Record.
112 @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.
113 @retval EFI_NOT_FOUND MonotonicCount does not match any data record
114 in the system. If a MonotonicCount of zero was passed in, then no
115 data records exist in the system.
116 @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack
118 @note: Inconsistent with specification here:
119 In Framework for EFI Data Hub Specification,Version 0.9, This definition is named as
120 EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistance is remained for backward compatibility
124 (EFIAPI
*EFI_DATA_HUB_GET_NEXT_RECORD
)(
125 IN EFI_DATA_HUB_PROTOCOL
*This
,
126 IN OUT UINT64
*MonotonicCount
,
127 IN EFI_EVENT
*FilterDriver OPTIONAL
,
128 OUT EFI_DATA_RECORD_HEADER
**Record
132 Registers an event to be signaled every time a data record is logged in the system.
134 @param This The EFI_DATA_HUB_PROTOCOL instance.
135 @param FilterEvent The EFI_EVENT to signal whenever data that matches
136 FilterClass is logged in the system.
137 @param FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled.
138 It is strongly recommended that you use the lowest EFI_TPL possible.
139 @param FilterClass FilterEvent will be signaled whenever a bit
140 in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass.
141 If FilterClass is zero, no class-based filtering will be performed.
142 @param FilterDataRecordGuid FilterEvent will be signaled whenever
143 FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid.
144 If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed.
146 @retval EFI_SUCCESS The filter driver event was registered
147 @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again.
148 @retval EFI_OUT_OF_RESOURCES The filter driver event was not registered
149 due to lack of system resources.
150 @note: Inconsistent with specification here:
151 In Framework for EFI Data Hub Specification,Version 0.9, This definition is named as
152 EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistance is remained for backward compatibility
156 (EFIAPI
*EFI_DATA_HUB_REGISTER_FILTER_DRIVER
)(
157 IN EFI_DATA_HUB_PROTOCOL
*This
,
158 IN EFI_EVENT FilterEvent
,
159 IN EFI_TPL FilterTpl
,
160 IN UINT64 FilterClass
,
161 IN EFI_GUID
*FilterDataRecordGuid OPTIONAL
165 Stops a filter driver from being notified when data records are logged.
167 @param This The EFI_DATA_HUB_PROTOCOL instance.
168 @param FilterEvent The EFI_EVENT to remove from the list of events to be
169 signaled every time errors are logged.
171 @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.
172 @retval EFI_NOT_FOUND FilterEvent did not exist.
173 @note: Inconsistent with specification here:
174 In Framework for EFI Data Hub Specification,Version 0.9, This definition is named as
175 EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistance is remained for backward compatibility
179 (EFIAPI
*EFI_DATA_HUB_UNREGISTER_FILTER_DRIVER
)(
180 IN EFI_DATA_HUB_PROTOCOL
*This
,
181 IN EFI_EVENT FilterEvent
185 This protocol is used to log information and register filter drivers
186 to receive data records.
188 struct _EFI_DATA_HUB_PROTOCOL
{
190 /// Logs a data record.
192 EFI_DATA_HUB_LOG_DATA LogData
;
195 /// Gets a data record. Used both to view the memory-based log and to
196 /// get information about which data records have been consumed by a filter driver.
198 EFI_DATA_HUB_GET_NEXT_RECORD GetNextRecord
;
201 /// Allows the registration of an EFI event to act as a filter driver for all data records that are logged.
203 EFI_DATA_HUB_REGISTER_FILTER_DRIVER RegisterFilterDriver
;
206 /// Used to remove a filter driver that was added with RegisterFilterDriver().
208 EFI_DATA_HUB_UNREGISTER_FILTER_DRIVER UnregisterFilterDriver
;
211 extern EFI_GUID gEfiDataHubProtocolGuid
;