Vlv2TbltDevicePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Vlv2TbltDevicePkg / AcpiPlatform / AcpiPlatform.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
\r
Module Name:\r
\r
  AcpiPlatform.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
\r
#ifndef _ACPI_PLATFORM_H_\r
#define _ACPI_PLATFORM_H_\r
\r
//\r
// Statements that include other header files.\r
//\r
#include <FrameworkDxe.h>\r
#include <PiDxe.h>\r
#include <Base.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Protocol/FirmwareVolume.h>\r
#include <Library/PcdLib.h>\r
#include <IndustryStandard/HighPrecisionEventTimerTable.h>\r
#include <IndustryStandard/Acpi.h>\r
#include <Protocol/AcpiSystemDescriptionTable.h>\r
#include <Protocol/MpService.h>\r
#include <Protocol/CpuIo.h>\r
#include <IndustryStandard/Acpi30.h>\r
#include <IndustryStandard/Acpi20.h>\r
#include <Library/HobLib.h>\r
#include <AlertStandardFormatTable.h>\r
#include <Guid/SetupVariable.h>\r
#include <Protocol/GlobalNvsArea.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <PchRegs.h>\r
#include <Library/PchPlatformLib.h>\r
//\r
// Global variables.\r
//\r
extern EFI_GLOBAL_NVS_AREA_PROTOCOL  mGlobalNvsArea;\r
\r
//\r
// ACPI table information used to initialize tables.\r
#define EFI_ACPI_OEM_REVISION     0x00000003\r
#define EFI_ACPI_CREATOR_ID       SIGNATURE_32 ('V', 'L', 'V', '2')\r
#define EFI_ACPI_CREATOR_REVISION 0x0100000D\r
\r
#define WPCN381U_CONFIG_INDEX     0x2E\r
#define WPCN381U_CONFIG_DATA      0x2F\r
#define WPCN381U_CHIP_ID          0xF4\r
#define WDCP376_CHIP_ID           0xF1\r
\r
#define MOBILE_PLATFORM 1\r
#define DESKTOP_PLATFORM 2\r
\r
//\r
// Define macros to build data structure signatures from characters.\r
//\r
#ifndef EFI_SIGNATURE_16\r
#define EFI_SIGNATURE_16(A, B)        ((A) | (B << 8))\r
#endif\r
#ifndef EFI_SIGNATURE_32\r
#define EFI_SIGNATURE_32(A, B, C, D)  (EFI_SIGNATURE_16 (A, B) | (EFI_SIGNATURE_16 (C, D) << 16))\r
#endif\r
#ifndef EFI_SIGNATURE_64\r
#define EFI_SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
    (EFI_SIGNATURE_32 (A, B, C, D) | ((UINT64) (EFI_SIGNATURE_32 (E, F, G, H)) << 32))\r
#endif\r
\r
\r
#define GV3_SSDT_OEM_TABLE_IDBASE 0x4000\r
\r
//\r
// Private Driver Data.\r
//\r
//\r
// Define Union of IO APIC & Local APIC structure.\r
//\r
typedef union {\r
  EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE AcpiLocalApic;\r
  EFI_ACPI_2_0_IO_APIC_STRUCTURE              AcpiIoApic;\r
  struct {\r
    UINT8 Type;\r
    UINT8 Length;\r
  } AcpiApicCommon;\r
} ACPI_APIC_STRUCTURE_PTR;\r
\r
//\r
// Protocol private structure definition.\r
//\r
\r
/**\r
  Entry point of the ACPI platform driver.\r
\r
  @param[in]  ImageHandle        EFI_HANDLE: A handle for the image that is initializing this driver.\r
  @param[in]  SystemTable        EFI_SYSTEM_TABLE: A pointer to the EFI system table.\r
\r
  @retval  EFI_SUCCESS           Driver initialized successfully.\r
  @retval  EFI_LOAD_ERROR        Failed to Initialize or has been loaded.\r
  @retval  EFI_OUT_OF_RESOURCES  Could not allocate needed resources.\r
\r
**/\r
EFI_STATUS\r
InstallAcpiPlatform (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  );\r
\r
/**\r
  Get Acpi Table Version.\r
\r
  @param[in]  ImageHandle          EFI_HANDLE: A handle for the image that is initializing this driver.\r
  @param[in]  SystemTable          EFI_SYSTEM_TABLE: A pointer to the EFI system table.\r
\r
  @retval  EFI_SUCCESS:            Driver initialized successfully.\r
  @retval  EFI_LOAD_ERROR:         Failed to Initialize or has been loaded.\r
  @retval  EFI_OUT_OF_RESOURCES:   Could not allocate needed resources.\r
\r
--*/\r
EFI_ACPI_TABLE_VERSION\r
GetAcpiTableVersion (\r
  VOID\r
  );\r
\r
/**\r
  The funtion returns Oem specific information of Acpi Platform.\r
\r
  @param[in]  OemId          OemId returned.\r
  @param[in]  OemTableId     OemTableId returned.\r
  @param[in]  OemRevision    OemRevision returned.\r
\r
  @retval  EFI_STATUS        Status of function execution.\r
\r
**/\r
EFI_STATUS\r
AcpiPlatformGetOemFields (\r
  OUT UINT8   *OemId,\r
  OUT UINT64  *OemTableId,\r
  OUT UINT32  *OemRevision\r
  );\r
\r
/**\r
  The function returns Acpi table version.\r
\r
  @param[in]\r
\r
  @retval  EFI_ACPI_TABLE_VERSION   Acpi table version encoded as a UINT32.\r
\r
**/\r
EFI_ACPI_TABLE_VERSION\r
AcpiPlatformGetAcpiSetting (\r
  VOID\r
  );\r
\r
/**\r
  Entry point for Acpi platform driver.\r
\r
  @param[in]  ImageHandle        A handle for the image that is initializing this driver.\r
  @param[in]  SystemTable        A pointer to the EFI system table.\r
\r
  @retval  EFI_SUCCESS           Driver initialized successfully.\r
  @retval  EFI_LOAD_ERROR        Failed to Initialize or has been loaded.\r
  @retval  EFI_OUT_OF_RESOURCES  Could not allocate needed resources.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiPlatformEntryPoint (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  );\r
\r
UINT8\r
ReadCmosBank1Byte (\r
  IN  UINT8                           Index\r
  );\r
\r
VOID\r
WriteCmosBank1Byte (\r
  IN  UINT8                           Index,\r
  IN  UINT8                           Data\r
  );\r
\r
VOID\r
SelectNFCDevice (\r
  IN VOID\r
  );\r
\r
VOID\r
SettingI2CTouchAddress (\r
  IN VOID\r
  );\r
\r
extern \r
EFI_STATUS \r
EFIAPI\r
IsctDxeEntryPoint (\r
  IN EFI_HANDLE       ImageHandle,\r
  IN EFI_SYSTEM_TABLE *SystemTable\r
  );\r
\r
#endif\r