MdeModulePkg/Include/Guid/FirmwarePerformance.h

   1 /** @file
   2   ACPI Firmware Performance Data Table (FPDT) implementation specific definitions.
   3
   4   Copyright (c) 2011, 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
   9
  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.
  12
  13 **/
  14
  15 #ifndef _FIRMWARE_PERFORMANCE_GUID_H_
  16 #define _FIRMWARE_PERFORMANCE_GUID_H_
  17
  18 #include <IndustryStandard/Acpi50.h>
  19 #include <PiPei.h>
  20 #include <Ppi/SecPerformance.h>
  21
  22 ///
  23 /// This GUID is used for FPDT implementation specific EFI Variable, LockBox and Hob.
  24 ///
  25 /// EFI Variable:
  26 ///   GUID - gEfiFirmwarePerformanceGuid
  27 ///   Name - EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME
  28 ///   Data - FIRMWARE_PERFORMANCE_VARIABLE
  29 ///
  30 /// LockBox:
  31 ///   GUID - gEfiFirmwarePerformanceGuid
  32 ///   Data - EFI_ACPI_BASIC_S3_SUSPEND_PERFORMANCE_RECORD
  33 ///
  34 /// Hob:
  35 ///   GUID - gEfiFirmwarePerformanceGuid
  36 ///   Data - FIRMWARE_SEC_PERFORMANCE (defined in <Ppi/SecPerformance.h>)
  37 ///
  38 #define EFI_FIRMWARE_PERFORMANCE_GUID \
  39   { \
  40     0xc095791a, 0x3001, 0x47b2, {0x80, 0xc9, 0xea, 0xc7, 0x31, 0x9f, 0x2f, 0xa4 } \
  41   }
  42
  43 #define EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME  L"FirmwarePerformance"
  44
  45 #pragma pack(1)
  46
  47 ///
  48 /// Firmware Performance Data Table.
  49 /// This structure will be installed into ACPI table as FPDT in normal boot path.
  50 ///
  51 typedef struct {
  52   EFI_ACPI_DESCRIPTION_HEADER                             Header;            ///< Common ACPI description table header.
  53   EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD BootPointerRecord; ///< Basic Boot Performance Table Pointer record.
  54   EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD   S3PointerRecord;   ///< S3 Performance Table Pointer record.
  55 } FIRMWARE_PERFORMANCE_TABLE;
  56
  57 ///
  58 /// S3 Performance Data Table.
  59 /// This structure contains S3 performance records which will be updated in S3
  60 /// suspend and S3 resume boot path.
  61 ///
  62 typedef struct {
  63   EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER  Header;    ///< Common ACPI table header.
  64   EFI_ACPI_5_0_FPDT_S3_RESUME_RECORD          S3Resume;  ///< Basic S3 Resume performance record.
  65   EFI_ACPI_5_0_FPDT_S3_SUSPEND_RECORD         S3Suspend; ///< Basic S3 Suspend performance record.
  66 } S3_PERFORMANCE_TABLE;
  67
  68 ///
  69 /// Basic Boot Performance Data Table.
  70 /// This structure contains BasicBoot performance record.
  71 ///
  72 typedef struct {
  73   EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER   Header;     ///< Common ACPI table header.
  74   EFI_ACPI_5_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD BasicBoot;  ///< Basic Boot Resume performance record.
  75 } BOOT_PERFORMANCE_TABLE;
  76
  77 ///
  78 /// Performance data pointed by Performance Pointer Record.
  79 ///
  80 typedef struct {
  81   BOOT_PERFORMANCE_TABLE         BootPerformance; ///< Basic Boot Performance.
  82   S3_PERFORMANCE_TABLE           S3Performance;   ///< S3 performance.
  83 } FIRMWARE_PERFORMANCE_RUNTIME_DATA;
  84
  85 ///
  86 /// Variable defined for FPDT implementation.
  87 /// This Variable is produced by FPDT DXE module and consumed by FPDT PEIM.
  88 ///
  89 typedef struct {
  90   EFI_PHYSICAL_ADDRESS  BootPerformanceTablePointer; ///< Pointer to Boot Performance Table.
  91   EFI_PHYSICAL_ADDRESS  S3PerformanceTablePointer;   ///< Pointer to S3 Performance Table.
  92 } FIRMWARE_PERFORMANCE_VARIABLE;
  93
  94 #pragma pack()
  95
  96 extern EFI_GUID gEfiFirmwarePerformanceGuid;
  97
  98 #endif