UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdeModulePkg / Include / Guid / FirmwarePerformance.h

/** @file\r
  ACPI Firmware Performance Data Table (FPDT) implementation specific definitions.\r
\r
  Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _FIRMWARE_PERFORMANCE_GUID_H_\r
#define _FIRMWARE_PERFORMANCE_GUID_H_\r
\r
#include <PiPei.h>\r
#include <IndustryStandard/Acpi.h>\r
#include <Ppi/SecPerformance.h>\r
\r
///\r
/// This GUID is used for FPDT implementation specific EFI Variable, LockBox and Hob.\r
///\r
/// EFI Variable:\r
///   GUID - gEfiFirmwarePerformanceGuid\r
///   Name - EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME\r
///   Data - FIRMWARE_PERFORMANCE_VARIABLE\r
///\r
/// LockBox:\r
///   GUID - gEfiFirmwarePerformanceGuid\r
///   Data - EFI_ACPI_BASIC_S3_SUSPEND_PERFORMANCE_RECORD\r
///\r
/// Hob:\r
///   GUID - gEfiFirmwarePerformanceGuid\r
///   Data - FIRMWARE_SEC_PERFORMANCE (defined in <Ppi/SecPerformance.h>)\r
///\r
/// SMI:\r
///   GUID - gEfiFirmwarePerformanceGuid\r
///   Data - SMM_BOOT_RECORD_COMMUNICATE\r
///\r
/// StatusCodeData:\r
///   Type - gEfiFirmwarePerformanceGuid\r
///   Data - One or more boot record\r
///\r
#define EFI_FIRMWARE_PERFORMANCE_GUID \\r
  { \\r
    0xc095791a, 0x3001, 0x47b2, {0x80, 0xc9, 0xea, 0xc7, 0x31, 0x9f, 0x2f, 0xa4 } \\r
  }\r
\r
#define EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME  L"FirmwarePerformance"\r
\r
/// LockBox:\r
///   GUID - gFirmwarePerformanceS3PointerGuid\r
///   Data - S3 performance table pointer\r
///\r
#define FIRMWARE_PERFORMANCE_S3_POINTER_GUID \\r
  { \\r
    0xdc65adc, 0xa973, 0x4130, { 0x8d, 0xf0, 0x2a, 0xdb, 0xeb, 0x9e, 0x4a, 0x31 } \\r
  }\r
\r
#pragma pack(1)\r
\r
///\r
/// Firmware Performance Data Table.\r
/// This structure will be installed into ACPI table as FPDT in normal boot path.\r
///\r
typedef struct {\r
  EFI_ACPI_DESCRIPTION_HEADER                                Header;            ///< Common ACPI description table header.\r
  EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD    BootPointerRecord; ///< Basic Boot Performance Table Pointer record.\r
  EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD      S3PointerRecord;   ///< S3 Performance Table Pointer record.\r
} FIRMWARE_PERFORMANCE_TABLE;\r
\r
///\r
/// S3 Performance Data Table.\r
/// This structure contains S3 performance records which will be updated in S3\r
/// suspend and S3 resume boot path.\r
///\r
typedef struct {\r
  EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER    Header;    ///< Common ACPI table header.\r
  EFI_ACPI_5_0_FPDT_S3_RESUME_RECORD            S3Resume;  ///< Basic S3 Resume performance record.\r
  EFI_ACPI_5_0_FPDT_S3_SUSPEND_RECORD           S3Suspend; ///< Basic S3 Suspend performance record.\r
} S3_PERFORMANCE_TABLE;\r
\r
///\r
/// Basic Boot Performance Data Table.\r
/// This structure contains BasicBoot performance record.\r
///\r
typedef struct {\r
  EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER      Header;    ///< Common ACPI table header.\r
  EFI_ACPI_5_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD    BasicBoot; ///< Basic Boot Resume performance record.\r
  //\r
  // one or more boot performance records.\r
  //\r
} BOOT_PERFORMANCE_TABLE;\r
\r
///\r
/// Boot performance table for the performance record in SMM phase.\r
///\r
///\r
typedef struct {\r
  EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER    Header;    ///< Common ACPI table header.\r
  //\r
  // one or more boot performance records.\r
  //\r
} SMM_BOOT_PERFORMANCE_TABLE;\r
\r
///\r
/// Performance data pointed by Performance Pointer Record.\r
///\r
typedef struct {\r
  BOOT_PERFORMANCE_TABLE    BootPerformance;      ///< Basic Boot Performance.\r
  S3_PERFORMANCE_TABLE      S3Performance;        ///< S3 performance.\r
} FIRMWARE_PERFORMANCE_RUNTIME_DATA;\r
\r
///\r
/// Variable defined for FPDT implementation.\r
/// This Variable is produced by FPDT DXE module.\r
///\r
typedef struct {\r
  EFI_PHYSICAL_ADDRESS    BootPerformanceTablePointer; ///< Pointer to Boot Performance Table.\r
  EFI_PHYSICAL_ADDRESS    S3PerformanceTablePointer;   ///< Pointer to S3 Performance Table.\r
} FIRMWARE_PERFORMANCE_VARIABLE;\r
\r
#pragma pack()\r
\r
//\r
// Log BOOT RECORD from SMM driver on boot time.\r
//\r
#define SMM_FPDT_FUNCTION_GET_BOOT_RECORD_SIZE            1\r
#define SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA            2\r
#define SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA_BY_OFFSET  3\r
\r
typedef struct {\r
  UINTN         Function;\r
  EFI_STATUS    ReturnStatus;\r
  UINTN         BootRecordSize;\r
  VOID          *BootRecordData;\r
  UINTN         BootRecordOffset;\r
} SMM_BOOT_RECORD_COMMUNICATE;\r
\r
extern EFI_GUID  gEfiFirmwarePerformanceGuid;\r
extern EFI_GUID  gFirmwarePerformanceS3PointerGuid;\r
\r
#endif\r