2 ACPI Firmware Performance Data Table (FPDT) implementation specific definitions.
4 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _FIRMWARE_PERFORMANCE_GUID_H_
16 #define _FIRMWARE_PERFORMANCE_GUID_H_
19 #include <IndustryStandard/Acpi.h>
20 #include <Ppi/SecPerformance.h>
23 /// This GUID is used for FPDT implementation specific EFI Variable, LockBox and Hob.
26 /// GUID - gEfiFirmwarePerformanceGuid
27 /// Name - EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME
28 /// Data - FIRMWARE_PERFORMANCE_VARIABLE
31 /// GUID - gEfiFirmwarePerformanceGuid
32 /// Data - EFI_ACPI_BASIC_S3_SUSPEND_PERFORMANCE_RECORD
35 /// GUID - gEfiFirmwarePerformanceGuid
36 /// Data - FIRMWARE_SEC_PERFORMANCE (defined in <Ppi/SecPerformance.h>)
39 /// GUID - gEfiFirmwarePerformanceGuid
40 /// Data - SMM_BOOT_RECORD_COMMUNICATE
43 /// Type - gEfiFirmwarePerformanceGuid
44 /// Data - One or more boot record
46 #define EFI_FIRMWARE_PERFORMANCE_GUID \
48 0xc095791a, 0x3001, 0x47b2, {0x80, 0xc9, 0xea, 0xc7, 0x31, 0x9f, 0x2f, 0xa4 } \
51 #define EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME L"FirmwarePerformance"
54 /// GUID - gFirmwarePerformanceS3PointerGuid
55 /// Data - S3 performance table pointer
57 #define FIRMWARE_PERFORMANCE_S3_POINTER_GUID \
59 0xdc65adc, 0xa973, 0x4130, { 0x8d, 0xf0, 0x2a, 0xdb, 0xeb, 0x9e, 0x4a, 0x31 } \
65 /// Firmware Performance Data Table.
66 /// This structure will be installed into ACPI table as FPDT in normal boot path.
69 EFI_ACPI_DESCRIPTION_HEADER Header
; ///< Common ACPI description table header.
70 EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD BootPointerRecord
; ///< Basic Boot Performance Table Pointer record.
71 EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD S3PointerRecord
; ///< S3 Performance Table Pointer record.
72 } FIRMWARE_PERFORMANCE_TABLE
;
75 /// S3 Performance Data Table.
76 /// This structure contains S3 performance records which will be updated in S3
77 /// suspend and S3 resume boot path.
80 EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER Header
; ///< Common ACPI table header.
81 EFI_ACPI_5_0_FPDT_S3_RESUME_RECORD S3Resume
; ///< Basic S3 Resume performance record.
82 EFI_ACPI_5_0_FPDT_S3_SUSPEND_RECORD S3Suspend
; ///< Basic S3 Suspend performance record.
83 } S3_PERFORMANCE_TABLE
;
86 /// Basic Boot Performance Data Table.
87 /// This structure contains BasicBoot performance record.
90 EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER Header
; ///< Common ACPI table header.
91 EFI_ACPI_5_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD BasicBoot
; ///< Basic Boot Resume performance record.
93 // one or more boot performance records.
95 } BOOT_PERFORMANCE_TABLE
;
98 /// Boot performance table for the performance record in SMM phase.
102 EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER Header
; ///< Common ACPI table header.
104 // one or more boot performance records.
106 } SMM_BOOT_PERFORMANCE_TABLE
;
109 /// Performance data pointed by Performance Pointer Record.
112 BOOT_PERFORMANCE_TABLE BootPerformance
; ///< Basic Boot Performance.
113 S3_PERFORMANCE_TABLE S3Performance
; ///< S3 performance.
114 } FIRMWARE_PERFORMANCE_RUNTIME_DATA
;
117 /// Variable defined for FPDT implementation.
118 /// This Variable is produced by FPDT DXE module.
121 EFI_PHYSICAL_ADDRESS BootPerformanceTablePointer
; ///< Pointer to Boot Performance Table.
122 EFI_PHYSICAL_ADDRESS S3PerformanceTablePointer
; ///< Pointer to S3 Performance Table.
123 } FIRMWARE_PERFORMANCE_VARIABLE
;
128 // Log BOOT RECORD from SMM driver on boot time.
130 #define SMM_FPDT_FUNCTION_GET_BOOT_RECORD_SIZE 1
131 #define SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA 2
132 #define SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA_BY_OFFSET 3
136 EFI_STATUS ReturnStatus
;
137 UINTN BootRecordSize
;
138 VOID
*BootRecordData
;
139 UINTN BootRecordOffset
;
140 } SMM_BOOT_RECORD_COMMUNICATE
;
142 extern EFI_GUID gEfiFirmwarePerformanceGuid
;
143 extern EFI_GUID gFirmwarePerformanceS3PointerGuid
;