Vlv2TbltDevicePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Vlv2TbltDevicePkg / AcpiPlatform / AcpiPlatformHooks.h

/*++\r
\r
  Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>\r
                                                                                   \r\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
                                                                                   \r\r
\r
Module Name:\r
\r
  AcpiPlatformHooks.h\r
\r
Abstract:\r
\r
  This is an implementation of the ACPI platform driver.  Requirements for\r
  this driver are defined in the Tiano ACPI External Product Specification,\r
  revision 0.3.6.\r
\r
--*/\r
\r
#ifndef _ACPI_PLATFORM_HOOKS_H_\r
#define _ACPI_PLATFORM_HOOKS_H_\r
\r
//\r
// Statements that include other header files\r
//\r
\r
#include <IndustryStandard/Acpi.h>\r
#include "Platform.h"\r
#include <Protocol/EnhancedSpeedstep.h>\r
\r
#define AML_NAME_OP           0x08\r
#define AML_METHOD_OP         0x14\r
#define AML_OPREGION_OP       0x80\r
#define AML_PACKAGE_OP        0x12  // Package operator.\r
#define AML_NAME_PREFIX_SIZE  0x06\r
#define AML_NAME_DWORD_SIZE   0x0C\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT8   AcpiProcessorId;\r
  UINT8   ApicId;\r
  UINT16  Flags;\r
} EFI_CPU_ID_MAP;\r
\r
typedef struct {\r
  UINT8   StartByte;\r
  UINT32  NameStr;\r
  UINT8   Size;\r
  UINT32  Value;\r
} EFI_ACPI_NAMEPACK_DWORD;\r
\r
typedef struct {\r
  UINT8   StartByte;\r
  UINT32  NameStr;\r
  UINT8   OpCode;\r
  UINT16  Size;                     // Hardcode to 16bit width because the table we use is fixed size\r
  UINT8   NumEntries;\r
} EFI_ACPI_NAME_COMMAND;\r
\r
typedef struct {\r
  UINT8   PackageOp;\r
  UINT8   PkgLeadByte;\r
  UINT8   NumEntries;\r
  UINT8   DwordPrefix0;\r
  UINT32  CoreFreq;\r
  UINT8   DwordPrefix1;\r
  UINT32  Power;\r
  UINT8   DwordPrefix2;\r
  UINT32  TransLatency;\r
  UINT8   DwordPrefix3;\r
  UINT32  BMLatency;\r
  UINT8   DwordPrefix4;\r
  UINT32  Control;\r
  UINT8   DwordPrefix5;\r
  UINT32  Status;\r
} EFI_PSS_PACKAGE;\r
\r
typedef struct {\r
  UINT8 PackageOp;\r
  UINT8 PkgLeadByte;\r
  UINT8 NumEntries;\r
  UINT8 BytePrefix0;\r
  UINT8 Entries;\r
  UINT8 BytePrefix1;\r
  UINT8 Revision;\r
  UINT8 BytePrefix2;\r
  UINT8 Domain;\r
  UINT8 BytePrefix3;\r
  UINT8 Coordinate;\r
  UINT8 BytePrefix4;\r
  UINT8 ProcNumber;\r
} EFI_PSD_PACKAGE;\r
\r
#pragma pack()\r
\r
#define ACPI_NAME_COMMAND_FROM_NAME_STR(a)  BASE_CR (a, EFI_ACPI_NAME_COMMAND, NameStr)\r
#define ACPI_NAME_COMMAND_FROM_NAMEPACK_STR(a)  BASE_CR (a, EFI_ACPI_NAMEPACK_DWORD, NameStr)\r
\r
EFI_STATUS\r
PlatformHookInit (\r
  VOID\r
  );\r
\r
\r
EFI_STATUS\r
PatchDsdtTable (\r
  IN OUT   EFI_ACPI_DESCRIPTION_HEADER  *TableHeader\r
  );\r
\r
EFI_STATUS\r
PatchGv3SsdtTable (\r
  IN OUT  EFI_ACPI_DESCRIPTION_HEADER *Table\r
  );\r
\r
EFI_STATUS\r
PatchErstTable (\r
  IN OUT  EFI_ACPI_DESCRIPTION_HEADER *Table\r
  );\r
\r
EFI_STATUS\r
AppendCpuMapTableEntry (\r
  IN EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE   *AcpiLocalApic\r
  );\r
\r
#endif\r