e8e1dc3cbc
V3:
Add "FPDT_" prefix for related definitions.
Cc: Liming Gao <liming.gao@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Liming Gao <liming.gao@intel.com>
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
(cherry picked from commit 73fef64f14)
292 lines
11 KiB
C
292 lines
11 KiB
C
/** @file
|
|
This file defines edk2 extended firmware performance records.
|
|
These records will be added into ACPI FPDT Firmware Basic Boot Performance Table.
|
|
|
|
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
|
|
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.
|
|
|
|
**/
|
|
|
|
#ifndef __EXTENDED_FIRMWARE_PERFORMANCE_H__
|
|
#define __EXTENDED_FIRMWARE_PERFORMANCE_H__
|
|
|
|
#include <IndustryStandard/Acpi.h>
|
|
|
|
//
|
|
// Known performance tokens
|
|
//
|
|
#define SEC_TOK "SEC" ///< SEC Phase
|
|
#define DXE_TOK "DXE" ///< DXE Phase
|
|
#define PEI_TOK "PEI" ///< PEI Phase
|
|
#define BDS_TOK "BDS" ///< BDS Phase
|
|
#define DRIVERBINDING_START_TOK "DB:Start:" ///< Driver Binding Start() function call
|
|
#define DRIVERBINDING_SUPPORT_TOK "DB:Support:" ///< Driver Binding Support() function call
|
|
#define DRIVERBINDING_STOP_TOK "DB:Stop:" ///< Driver Binding Stop() function call
|
|
#define LOAD_IMAGE_TOK "LoadImage:" ///< Load a dispatched module
|
|
#define START_IMAGE_TOK "StartImage:" ///< Dispatched Modules Entry Point execution
|
|
#define PEIM_TOK "PEIM" ///< PEIM Modules Entry Point execution
|
|
|
|
//
|
|
// Public Progress Identifiers for Event Records to map the above known token
|
|
//
|
|
#define MODULE_START_ID 0x01
|
|
#define MODULE_END_ID 0x02
|
|
#define MODULE_LOADIMAGE_START_ID 0x03
|
|
#define MODULE_LOADIMAGE_END_ID 0x04
|
|
#define MODULE_DB_START_ID 0x05
|
|
#define MODULE_DB_END_ID 0x06
|
|
#define MODULE_DB_SUPPORT_START_ID 0x07
|
|
#define MODULE_DB_SUPPORT_END_ID 0x08
|
|
#define MODULE_DB_STOP_START_ID 0x09
|
|
#define MODULE_DB_STOP_END_ID 0x0A
|
|
|
|
#define PERF_EVENTSIGNAL_START_ID 0x10
|
|
#define PERF_EVENTSIGNAL_END_ID 0x11
|
|
#define PERF_CALLBACK_START_ID 0x20
|
|
#define PERF_CALLBACK_END_ID 0x21
|
|
#define PERF_FUNCTION_START_ID 0x30
|
|
#define PERF_FUNCTION_END_ID 0x31
|
|
#define PERF_INMODULE_START_ID 0x40
|
|
#define PERF_INMODULE_END_ID 0x41
|
|
#define PERF_CROSSMODULE_START_ID 0x50
|
|
#define PERF_CROSSMODULE_END_ID 0x51
|
|
|
|
//
|
|
// Misc defines
|
|
//
|
|
#define FPDT_RECORD_REVISION_1 (0x01)
|
|
|
|
//
|
|
// Length field in EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER is a UINT8, thus:
|
|
//
|
|
#define FPDT_MAX_PERF_RECORD_SIZE (MAX_UINT8)
|
|
|
|
//
|
|
// FPDT Record Types
|
|
//
|
|
#define FPDT_GUID_EVENT_TYPE 0x1010
|
|
#define FPDT_DYNAMIC_STRING_EVENT_TYPE 0x1011
|
|
#define FPDT_DUAL_GUID_STRING_EVENT_TYPE 0x1012
|
|
#define FPDT_GUID_QWORD_EVENT_TYPE 0x1013
|
|
#define FPDT_GUID_QWORD_STRING_EVENT_TYPE 0x1014
|
|
|
|
//
|
|
// EDKII extended Fpdt record structures
|
|
//
|
|
#define FPDT_STRING_EVENT_RECORD_NAME_LENGTH 24
|
|
|
|
#pragma pack(1)
|
|
//
|
|
// FPDT Boot Performance Guid Event Record Structure
|
|
//
|
|
typedef struct {
|
|
EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
|
|
///
|
|
/// ProgressID < 0x10 are reserved for core performance entries.
|
|
/// Start measurement point shall have lowered one nibble set to zero and
|
|
/// corresponding end points shall have lowered one nibble set to non-zero value;
|
|
/// keeping other nibbles same as start point.
|
|
///
|
|
UINT16 ProgressID;
|
|
///
|
|
/// APIC ID for the processor in the system used as a timestamp clock source.
|
|
/// If only one timestamp clock source is used, this field is Reserved and populated as 0.
|
|
///
|
|
UINT32 ApicID;
|
|
///
|
|
/// 64-bit value (nanosecond) describing elapsed time since the most recent deassertion of processor reset.
|
|
///
|
|
UINT64 Timestamp;
|
|
///
|
|
/// If ProgressID < 0x10, GUID of the referenced module; otherwise, GUID of the module logging the event.
|
|
///
|
|
EFI_GUID Guid;
|
|
} FPDT_GUID_EVENT_RECORD;
|
|
|
|
//
|
|
// FPDT Boot Performance Dynamic String Event Record Structure
|
|
//
|
|
typedef struct {
|
|
EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
|
|
///
|
|
/// ProgressID < 0x10 are reserved for core performance entries.
|
|
/// Start measurement point shall have lowered one nibble set to zero and
|
|
/// corresponding end points shall have lowered one nibble set to non-zero value;
|
|
/// keeping other nibbles same as start point.
|
|
///
|
|
UINT16 ProgressID;
|
|
///
|
|
/// APIC ID for the processor in the system used as a timestamp clock source.
|
|
/// If only one timestamp clock source is used, this field is Reserved and populated as 0.
|
|
///
|
|
UINT32 ApicID;
|
|
///
|
|
/// 64-bit value (nanosecond) describing elapsed time since the most recent deassertion of processor reset.
|
|
///
|
|
UINT64 Timestamp;
|
|
///
|
|
/// If ProgressID < 0x10, GUID of the referenced module; otherwise, GUID of the module logging the event.
|
|
///
|
|
EFI_GUID Guid;
|
|
///
|
|
/// ASCII string describing the module. Padding supplied at the end if necessary with null characters (0x00).
|
|
/// It may be module name, function name, or token name.
|
|
///
|
|
CHAR8 String[0];
|
|
} FPDT_DYNAMIC_STRING_EVENT_RECORD;
|
|
|
|
//
|
|
// FPDT Boot Performance Dual GUID String Event Record Structure
|
|
//
|
|
typedef struct {
|
|
EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
|
|
///
|
|
/// ProgressID < 0x10 are reserved for core performance entries.
|
|
/// Start measurement point shall have lowered one nibble set to zero and
|
|
/// corresponding end points shall have lowered one nibble set to non-zero value;
|
|
/// keeping other nibbles same as start point.
|
|
///
|
|
UINT16 ProgressID;
|
|
///
|
|
/// APIC ID for the processor in the system used as a timestamp clock source.
|
|
/// If only one timestamp clock source is used, this field is Reserved and populated as 0.
|
|
///
|
|
UINT32 ApicID;
|
|
///
|
|
/// 64-bit value (nanosecond) describing elapsed time since the most recent deassertion of processor reset.
|
|
///
|
|
UINT64 Timestamp;
|
|
///
|
|
/// GUID of the module logging the event.
|
|
///
|
|
EFI_GUID Guid1;
|
|
///
|
|
/// Event or Ppi or Protocol GUID for Callback.
|
|
///
|
|
EFI_GUID Guid2;
|
|
///
|
|
/// ASCII string describing the module. Padding supplied at the end if necessary with null characters (0x00).
|
|
/// It is the function name.
|
|
///
|
|
CHAR8 String[0];
|
|
} FPDT_DUAL_GUID_STRING_EVENT_RECORD;
|
|
|
|
//
|
|
// FPDT Boot Performance GUID Qword Event Record Structure
|
|
//
|
|
typedef struct {
|
|
EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
|
|
///
|
|
/// ProgressID < 0x10 are reserved for core performance entries.
|
|
/// Start measurement point shall have lowered one nibble set to zero and
|
|
/// corresponding end points shall have lowered one nibble set to non-zero value;
|
|
/// keeping other nibbles same as start point.
|
|
///
|
|
UINT16 ProgressID;
|
|
///
|
|
/// APIC ID for the processor in the system used as a timestamp clock source.
|
|
/// If only one timestamp clock source is used, this field is Reserved and populated as 0.
|
|
///
|
|
UINT32 ApicID;
|
|
///
|
|
/// 64-bit value (nanosecond) describing elapsed time since the most recent deassertion of processor reset.
|
|
///
|
|
UINT64 Timestamp;
|
|
///
|
|
/// GUID of the module logging the event
|
|
///
|
|
EFI_GUID Guid;
|
|
///
|
|
/// Qword of misc data, meaning depends on the ProgressId
|
|
///
|
|
UINT64 Qword;
|
|
} FPDT_GUID_QWORD_EVENT_RECORD;
|
|
|
|
//
|
|
// FPDT Boot Performance GUID Qword String Event Record Structure
|
|
//
|
|
typedef struct {
|
|
EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
|
|
///
|
|
/// ProgressID < 0x10 are reserved for core performance entries.
|
|
/// Start measurement point shall have lowered one nibble set to zero and
|
|
/// corresponding end points shall have lowered one nibble set to non-zero value;
|
|
/// keeping other nibbles same as start point.
|
|
///
|
|
UINT16 ProgressID;
|
|
///
|
|
/// APIC ID for the processor in the system used as a timestamp clock source.
|
|
/// If only one timestamp clock source is used, this field is Reserved and populated as 0.
|
|
///
|
|
UINT32 ApicID;
|
|
///
|
|
/// 64-bit value (nanosecond) describing elapsed time since the most recent deassertion of processor reset.
|
|
///
|
|
UINT64 Timestamp;
|
|
///
|
|
/// GUID of the module logging the event
|
|
///
|
|
EFI_GUID Guid;
|
|
///
|
|
/// Qword of misc data, meaning depends on the ProgressId
|
|
///
|
|
UINT64 Qword;
|
|
///
|
|
/// ASCII string describing the module. Padding supplied at the end if necessary with null characters (0x00).
|
|
///
|
|
CHAR8 String[0];
|
|
} FPDT_GUID_QWORD_STRING_EVENT_RECORD;
|
|
|
|
#pragma pack()
|
|
|
|
typedef struct {
|
|
UINT16 ProgressID;
|
|
UINT16 Type;
|
|
UINT8 RecordSize;
|
|
} FPDT_BASIC_RECORD_INFO;
|
|
|
|
//
|
|
// Union of all FPDT records
|
|
//
|
|
typedef union {
|
|
EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER RecordHeader;
|
|
FPDT_GUID_EVENT_RECORD GuidEvent;
|
|
FPDT_DYNAMIC_STRING_EVENT_RECORD DynamicStringEvent;
|
|
FPDT_DUAL_GUID_STRING_EVENT_RECORD DualGuidStringEvent;
|
|
FPDT_GUID_QWORD_EVENT_RECORD GuidQwordEvent;
|
|
FPDT_GUID_QWORD_STRING_EVENT_RECORD GuidQwordStringEvent;
|
|
} FPDT_RECORD;
|
|
|
|
//
|
|
// Union of all pointers to FPDT records
|
|
//
|
|
typedef union {
|
|
EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *RecordHeader;
|
|
FPDT_GUID_EVENT_RECORD *GuidEvent;
|
|
FPDT_DYNAMIC_STRING_EVENT_RECORD *DynamicStringEvent;
|
|
FPDT_DUAL_GUID_STRING_EVENT_RECORD *DualGuidStringEvent;
|
|
FPDT_GUID_QWORD_EVENT_RECORD *GuidQwordEvent;
|
|
FPDT_GUID_QWORD_STRING_EVENT_RECORD *GuidQwordStringEvent;
|
|
} FPDT_RECORD_PTR;
|
|
|
|
///
|
|
/// Hob:
|
|
/// GUID - gEdkiiFpdtExtendedFirmwarePerformanceGuid;
|
|
/// Data - FPDT_PEI_EXT_PERF_HEADER + one or more FPDT records
|
|
///
|
|
typedef struct {
|
|
UINT32 SizeOfAllEntries;
|
|
UINT32 LoadImageCount;
|
|
UINT32 HobIsFull;
|
|
} FPDT_PEI_EXT_PERF_HEADER;
|
|
|
|
extern EFI_GUID gEdkiiFpdtExtendedFirmwarePerformanceGuid;
|
|
|
|
#endif
|