MdePkg: Fix SmBios.h PROCESSOR_CHARACTERISTIC_FLAGS to be UINT16

[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / AcpiTableDxe / AcpiTable.h

/** @file\r
  ACPI Table Protocol Driver\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ACPI_TABLE_H_\r
#define _ACPI_TABLE_H_\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/AcpiTable.h>\r
#include <Guid/Acpi.h>\r
#include <Protocol/AcpiSystemDescriptionTable.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
\r
//\r
// Statements that include other files\r
//\r
#include <IndustryStandard/Acpi.h>\r
\r
#include "AcpiSdt.h"\r
\r
//\r
// Great than or equal to 2.0.\r
//\r
#define ACPI_TABLE_VERSION_GTE_2_0 (EFI_ACPI_TABLE_VERSION_2_0  | \\r
                                    EFI_ACPI_TABLE_VERSION_3_0  | \\r
                                    EFI_ACPI_TABLE_VERSION_4_0  | \\r
                                    EFI_ACPI_TABLE_VERSION_5_0)\r
\r
//\r
// Private Driver Data\r
//\r
//\r
// ACPI Table Linked List Signature.\r
//\r
#define EFI_ACPI_TABLE_LIST_SIGNATURE SIGNATURE_32 ('E', 'A', 'T', 'L')\r
\r
//\r
// ACPI Table Linked List Entry definition.\r
//\r
//  Signature must be set to EFI_ACPI_TABLE_LIST_SIGNATURE\r
//  Link is the linked list data.\r
//  Version is the versions of the ACPI tables that this table belongs in.\r
//  Table is a pointer to the table.\r
//  PageAddress is the address of the pages allocated for the table.\r
//  NumberOfPages is the number of pages allocated at PageAddress.\r
//  Handle is used to identify a particular table.\r
//\r
typedef struct {\r
  UINT32                  Signature;\r
  LIST_ENTRY              Link;\r
  EFI_ACPI_TABLE_VERSION  Version;\r
  EFI_ACPI_COMMON_HEADER  *Table;\r
  EFI_PHYSICAL_ADDRESS    PageAddress;\r
  UINTN                   NumberOfPages;\r
  UINTN                   Handle;\r
} EFI_ACPI_TABLE_LIST;\r
\r
//\r
// Containment record for ACPI Table linked list.\r
//\r
#define EFI_ACPI_TABLE_LIST_FROM_LINK(_link)  CR (_link, EFI_ACPI_TABLE_LIST, Link, EFI_ACPI_TABLE_LIST_SIGNATURE)\r
\r
//\r
// The maximum number of tables this driver supports\r
//\r
#define EFI_ACPI_MAX_NUM_TABLES 20\r
\r
//\r
// Protocol private structure definition\r
//\r
//\r
// ACPI support protocol instance signature definition.\r
//\r
#define EFI_ACPI_TABLE_SIGNATURE  SIGNATURE_32 ('S', 'T', 'A', 'E')\r
\r
//\r
// ACPI support protocol instance data structure\r
//\r
typedef struct {\r
  UINTN                                         Signature;\r
  EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *Rsdp1;                 // Pointer to RSD_PTR structure\r
  EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *Rsdp3;                 // Pointer to RSD_PTR structure\r
  EFI_ACPI_DESCRIPTION_HEADER                   *Rsdt1;                 // Pointer to RSDT table header\r
  EFI_ACPI_DESCRIPTION_HEADER                   *Rsdt3;                 // Pointer to RSDT table header\r
  EFI_ACPI_DESCRIPTION_HEADER                   *Xsdt;                  // Pointer to XSDT table header\r
  EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE     *Fadt1;                 // Pointer to FADT table header\r
  EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE     *Fadt3;                 // Pointer to FADT table header\r
  EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE  *Facs1;                 // Pointer to FACS table header\r
  EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE  *Facs3;                 // Pointer to FACS table header\r
  EFI_ACPI_DESCRIPTION_HEADER                   *Dsdt1;                 // Pointer to DSDT table header\r
  EFI_ACPI_DESCRIPTION_HEADER                   *Dsdt3;                 // Pointer to DSDT table header\r
  LIST_ENTRY                                    TableList;\r
  UINTN                                         NumberOfTableEntries1;  // Number of ACPI 1.0 tables\r
  UINTN                                         NumberOfTableEntries3;  // Number of ACPI 3.0 tables\r
  UINTN                                         CurrentHandle;\r
  EFI_ACPI_TABLE_PROTOCOL                       AcpiTableProtocol;\r
  EFI_ACPI_SDT_PROTOCOL                         AcpiSdtProtocol;\r
  LIST_ENTRY                                    NotifyList;\r
} EFI_ACPI_TABLE_INSTANCE;\r
\r
//\r
// ACPI table protocol instance containing record macro\r
//\r
#define EFI_ACPI_TABLE_INSTANCE_FROM_THIS(a) \\r
  CR (a, \\r
      EFI_ACPI_TABLE_INSTANCE, \\r
      AcpiTableProtocol, \\r
      EFI_ACPI_TABLE_SIGNATURE \\r
      )\r
\r
//\r
// Protocol Constructor functions\r
//\r
\r
/**\r
  Constructor for the ACPI support protocol.  Initializes instance\r
  data.\r
\r
  @param  AcpiTableInstance       Instance to construct\r
\r
  @return EFI_SUCCESS             Instance initialized.\r
  @return EFI_OUT_OF_RESOURCES    Unable to allocate required resources.\r
\r
**/\r
EFI_STATUS\r
AcpiTableAcpiTableConstructor (\r
  EFI_ACPI_TABLE_INSTANCE                 *AcpiTableInstance\r
  );\r
\r
\r
/**\r
  Entry point of the ACPI table driver.\r
  Creates and initializes an instance of the ACPI Table\r
  Protocol and installs it on a new handle.\r
\r
  @param  ImageHandle   A handle for the image that is initializing this driver\r
  @param  SystemTable   A pointer to the EFI system table\r
\r
  @return EFI_SUCCESS           Driver initialized successfully\r
  @return EFI_LOAD_ERROR        Failed to Initialize or has been loaded\r
  @return EFI_OUT_OF_RESOURCES  Could not allocate needed resources\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeAcpiTableDxe (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  );\r
\r
/**\r
\r
  This function finds the table specified by the handle and returns a pointer to it.\r
  If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are\r
  undefined.\r
\r
  @param[in]  Handle      Table to find.\r
  @param[in]  TableList   Table list to search\r
  @param[out] Table       Pointer to table found.\r
\r
  @retval EFI_SUCCESS              The function completed successfully.\r
  @retval EFI_NOT_FOUND            No table found matching the handle specified.\r
\r
**/\r
EFI_STATUS\r
FindTableByHandle (\r
  IN UINTN                                Handle,\r
  IN LIST_ENTRY                           *TableList,\r
  OUT EFI_ACPI_TABLE_LIST                 **Table\r
  );\r
\r
/**\r
\r
  This function calculates and updates an UINT8 checksum.\r
\r
  @param[in]  Buffer          Pointer to buffer to checksum\r
  @param[in]  Size            Number of bytes to checksum\r
  @param[in]  ChecksumOffset  Offset to place the checksum result in\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
AcpiPlatformChecksum (\r
  IN VOID       *Buffer,\r
  IN UINTN      Size,\r
  IN UINTN      ChecksumOffset\r
  );\r
\r
/**\r
  This function invokes ACPI notification.\r
\r
  @param[in]  AcpiTableInstance          Instance to AcpiTable\r
  @param[in]  Version                    Version(s) to set.\r
  @param[in]  Handle                     Handle of the table.\r
**/\r
VOID\r
SdtNotifyAcpiList (\r
  IN EFI_ACPI_TABLE_INSTANCE   *AcpiTableInstance,\r
  IN EFI_ACPI_TABLE_VERSION    Version,\r
  IN UINTN                     Handle\r
  );\r
\r
/**\r
  This function initializes AcpiSdt protocol in ACPI table instance.\r
\r
  @param[in]  AcpiTableInstance       Instance to construct\r
**/\r
VOID\r
SdtAcpiTableAcpiSdtConstructor (\r
  IN EFI_ACPI_TABLE_INSTANCE   *AcpiTableInstance\r
  );\r
\r
//\r
// export PrivateData symbol, because we need that in AcpiSdtProtol implementation\r
//\r
extern EFI_HANDLE                mHandle;\r
extern EFI_ACPI_TABLE_INSTANCE   *mPrivateData;\r
\r
#endif\r