]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkModulePkg/Universal/DataHubDxe/DataHubDxe.uni
281c5bcdf64145cffdb29b5f00e427d622d57ecd
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / DataHubDxe / DataHubDxe.uni
1 // /** @file
2 // This driver initializes and installs the Data Hub protocol.
3 //
4 // The data hub is a volatile database that is intended as the major focus for the accumulation of
5 // manageability data.T he hub is fed by "producers" with chunks of data in a defined format.
6 // Consumers may then extract the data in temporal "log" order.As an example, progress codes might
7 // be recorded in the data hub for future processing.Ot her data contributed to the data hub might
8 // include, for example, statistics on enumerated items such as memory, add-in buses, and add-in
9 // cards and data on errors encountered during boot (for example, the system did not boot off the
10 // network because the cable was not plugged in).
11 // Some classes of data have defined formats.For example, the amount of memory in the system is
12 // reported in a standard format so that consumers can be written to extract the data.O ther data is
13 // system specific.For example, additional detail on errors might be specific to the driver that
14 // discovered the error.The consumer might be a driver that tabularizes data from the data hub,
15 // providing a mechanism for the raw data to be made available to the OS for post-processing by
16 // OS-based applications.
17 // The intent of the data hub is for drivers that enumerate and configure parts of the system to report
18 // their discoveries to the data hub.This data can then be extracted by other drivers that report those
19 // discoveries using standard manageability interfaces such as SMBIOS and Intelligent Platform
20 // Management Interface (IPMI).The alternative to a data-hub-like architecture is to require all
21 // drivers to be aware of all reporting formats.
22 // For more information, please ref http://www.intel.com/technology/framework/
23 //
24 // Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
25 //
26 // SPDX-License-Identifier: BSD-2-Clause-Patent
27 //
28 // **/
29
30
31 #string STR_MODULE_ABSTRACT #language en-US "Initializes and installs the Data Hub protocol"
32
33 #string STR_MODULE_DESCRIPTION #language en-US "The data hub is a volatile database that is intended as the major focus for the accumulation of manageability data. The hub is fed by \"producers\" with chunks of data in a defined format. Consumers may then extract the data in a temporal \"log\" order. As an example, progress codes might be recorded in the data hub for future processing. For example, other data contributed to the data hub might include, statistics on enumerated items such as memory, add-in buses, and add-in cards, and data on errors encountered during boot (such as, the system did not boot off the network because the cable was not plugged in). Some classes of data have defined formats. For example, the amount of memory in the system is reported in a standard format so that consumers can be written to extract the data. Other data is system specific. For example, additional detail on errors might be specific to the driver that discovered the error. The consumer might be a driver that tabularizes data from the data hub, providing a mechanism for the raw data to be made available to the OS for post-processing by OS-based applications. The intent of the data hub is for drivers that enumerate and configure parts of the system to report their discoveries to the data hub. This data can then be extracted by other drivers that report those discoveries using standard manageability interfaces such as SMBIOS and Intelligent Platform Management Interface (IPMI). The alternative to a data-hub-like architecture is to require all drivers to be aware of all reporting formats. For more information, refer to http://www.intel.com/technology/framework/ ."
34