MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTable.h

   1 /** @file
   2   ACPI Table Protocol Driver
   3
   4   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _ACPI_TABLE_H_
  10 #define _ACPI_TABLE_H_
  11
  12
  13 #include <PiDxe.h>
  14
  15 #include <Protocol/AcpiTable.h>
  16 #include <Guid/Acpi.h>
  17 #include <Protocol/AcpiSystemDescriptionTable.h>
  18
  19 #include <Library/BaseLib.h>
  20 #include <Library/DebugLib.h>
  21 #include <Library/UefiLib.h>
  22 #include <Library/BaseMemoryLib.h>
  23 #include <Library/UefiDriverEntryPoint.h>
  24 #include <Library/MemoryAllocationLib.h>
  25 #include <Library/UefiBootServicesTableLib.h>
  26 #include <Library/PcdLib.h>
  27
  28 //
  29 // Statements that include other files
  30 //
  31 #include <IndustryStandard/Acpi.h>
  32
  33 #include "AcpiSdt.h"
  34
  35 //
  36 // Great than or equal to 2.0.
  37 //
  38 #define ACPI_TABLE_VERSION_GTE_2_0 (EFI_ACPI_TABLE_VERSION_2_0  | \
  39                                     EFI_ACPI_TABLE_VERSION_3_0  | \
  40                                     EFI_ACPI_TABLE_VERSION_4_0  | \
  41                                     EFI_ACPI_TABLE_VERSION_5_0)
  42
  43 //
  44 // Private Driver Data
  45 //
  46 //
  47 // ACPI Table Linked List Signature.
  48 //
  49 #define EFI_ACPI_TABLE_LIST_SIGNATURE SIGNATURE_32 ('E', 'A', 'T', 'L')
  50
  51 //
  52 // ACPI Table Linked List Entry definition.
  53 //
  54 //  Signature must be set to EFI_ACPI_TABLE_LIST_SIGNATURE
  55 //  Link is the linked list data.
  56 //  Version is the versions of the ACPI tables that this table belongs in.
  57 //  Table is a pointer to the table.
  58 //  TableSize is the size of the table
  59 //  Handle is used to identify a particular table.
  60 //  PoolAllocation carries the allocation type:
  61 //    FALSE: Table points to EFI_SIZE_TO_PAGES(TableSize) pages allocated using
  62 //           gBS->AllocatePages ()
  63 //    TRUE:  Table points to TableSize bytes allocated using gBS->AllocatePool ()
  64 //
  65 typedef struct {
  66   UINT32                  Signature;
  67   LIST_ENTRY              Link;
  68   EFI_ACPI_TABLE_VERSION  Version;
  69   EFI_ACPI_COMMON_HEADER  *Table;
  70   UINTN                   TableSize;
  71   UINTN                   Handle;
  72   BOOLEAN                 PoolAllocation;
  73 } EFI_ACPI_TABLE_LIST;
  74
  75 //
  76 // Containment record for ACPI Table linked list.
  77 //
  78 #define EFI_ACPI_TABLE_LIST_FROM_LINK(_link)  CR (_link, EFI_ACPI_TABLE_LIST, Link, EFI_ACPI_TABLE_LIST_SIGNATURE)
  79
  80 //
  81 // The maximum number of tables this driver supports
  82 //
  83 #define EFI_ACPI_MAX_NUM_TABLES 20
  84
  85 //
  86 // Protocol private structure definition
  87 //
  88 //
  89 // ACPI support protocol instance signature definition.
  90 //
  91 #define EFI_ACPI_TABLE_SIGNATURE  SIGNATURE_32 ('S', 'T', 'A', 'E')
  92
  93 //
  94 // ACPI support protocol instance data structure
  95 //
  96 typedef struct {
  97   UINTN                                         Signature;
  98   EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *Rsdp1;                 // Pointer to RSD_PTR structure
  99   EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *Rsdp3;                 // Pointer to RSD_PTR structure
 100   EFI_ACPI_DESCRIPTION_HEADER                   *Rsdt1;                 // Pointer to RSDT table header
 101   EFI_ACPI_DESCRIPTION_HEADER                   *Rsdt3;                 // Pointer to RSDT table header
 102   EFI_ACPI_DESCRIPTION_HEADER                   *Xsdt;                  // Pointer to XSDT table header
 103   EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE     *Fadt1;                 // Pointer to FADT table header
 104   EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE     *Fadt3;                 // Pointer to FADT table header
 105   EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE  *Facs1;                 // Pointer to FACS table header
 106   EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE  *Facs3;                 // Pointer to FACS table header
 107   EFI_ACPI_DESCRIPTION_HEADER                   *Dsdt1;                 // Pointer to DSDT table header
 108   EFI_ACPI_DESCRIPTION_HEADER                   *Dsdt3;                 // Pointer to DSDT table header
 109   LIST_ENTRY                                    TableList;
 110   UINTN                                         NumberOfTableEntries1;  // Number of ACPI 1.0 tables
 111   UINTN                                         NumberOfTableEntries3;  // Number of ACPI 3.0 tables
 112   UINTN                                         CurrentHandle;
 113   EFI_ACPI_TABLE_PROTOCOL                       AcpiTableProtocol;
 114   EFI_ACPI_SDT_PROTOCOL                         AcpiSdtProtocol;
 115   LIST_ENTRY                                    NotifyList;
 116 } EFI_ACPI_TABLE_INSTANCE;
 117
 118 //
 119 // ACPI table protocol instance containing record macro
 120 //
 121 #define EFI_ACPI_TABLE_INSTANCE_FROM_THIS(a) \
 122   CR (a, \
 123       EFI_ACPI_TABLE_INSTANCE, \
 124       AcpiTableProtocol, \
 125       EFI_ACPI_TABLE_SIGNATURE \
 126       )
 127
 128 //
 129 // Protocol Constructor functions
 130 //
 131
 132 /**
 133   Constructor for the ACPI support protocol.  Initializes instance
 134   data.
 135
 136   @param  AcpiTableInstance       Instance to construct
 137
 138   @return EFI_SUCCESS             Instance initialized.
 139   @return EFI_OUT_OF_RESOURCES    Unable to allocate required resources.
 140
 141 **/
 142 EFI_STATUS
 143 AcpiTableAcpiTableConstructor (
 144   EFI_ACPI_TABLE_INSTANCE                 *AcpiTableInstance
 145   );
 146
 147
 148 /**
 149   Entry point of the ACPI table driver.
 150   Creates and initializes an instance of the ACPI Table
 151   Protocol and installs it on a new handle.
 152
 153   @param  ImageHandle   A handle for the image that is initializing this driver
 154   @param  SystemTable   A pointer to the EFI system table
 155
 156   @return EFI_SUCCESS           Driver initialized successfully
 157   @return EFI_LOAD_ERROR        Failed to Initialize or has been loaded
 158   @return EFI_OUT_OF_RESOURCES  Could not allocate needed resources
 159
 160 **/
 161 EFI_STATUS
 162 EFIAPI
 163 InitializeAcpiTableDxe (
 164   IN EFI_HANDLE           ImageHandle,
 165   IN EFI_SYSTEM_TABLE     *SystemTable
 166   );
 167
 168 /**
 169
 170   This function finds the table specified by the handle and returns a pointer to it.
 171   If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are
 172   undefined.
 173
 174   @param[in]  Handle      Table to find.
 175   @param[in]  TableList   Table list to search
 176   @param[out] Table       Pointer to table found.
 177
 178   @retval EFI_SUCCESS              The function completed successfully.
 179   @retval EFI_NOT_FOUND            No table found matching the handle specified.
 180
 181 **/
 182 EFI_STATUS
 183 FindTableByHandle (
 184   IN UINTN                                Handle,
 185   IN LIST_ENTRY                           *TableList,
 186   OUT EFI_ACPI_TABLE_LIST                 **Table
 187   );
 188
 189 /**
 190
 191   This function calculates and updates an UINT8 checksum.
 192
 193   @param[in]  Buffer          Pointer to buffer to checksum
 194   @param[in]  Size            Number of bytes to checksum
 195   @param[in]  ChecksumOffset  Offset to place the checksum result in
 196
 197   @retval EFI_SUCCESS             The function completed successfully.
 198
 199 **/
 200 EFI_STATUS
 201 AcpiPlatformChecksum (
 202   IN VOID       *Buffer,
 203   IN UINTN      Size,
 204   IN UINTN      ChecksumOffset
 205   );
 206
 207 /**
 208   This function invokes ACPI notification.
 209
 210   @param[in]  AcpiTableInstance          Instance to AcpiTable
 211   @param[in]  Version                    Version(s) to set.
 212   @param[in]  Handle                     Handle of the table.
 213 **/
 214 VOID
 215 SdtNotifyAcpiList (
 216   IN EFI_ACPI_TABLE_INSTANCE   *AcpiTableInstance,
 217   IN EFI_ACPI_TABLE_VERSION    Version,
 218   IN UINTN                     Handle
 219   );
 220
 221 /**
 222   This function initializes AcpiSdt protocol in ACPI table instance.
 223
 224   @param[in]  AcpiTableInstance       Instance to construct
 225 **/
 226 VOID
 227 SdtAcpiTableAcpiSdtConstructor (
 228   IN EFI_ACPI_TABLE_INSTANCE   *AcpiTableInstance
 229   );
 230
 231 //
 232 // export PrivateData symbol, because we need that in AcpiSdtProtol implementation
 233 //
 234 extern EFI_HANDLE                mHandle;
 235 extern EFI_ACPI_TABLE_INSTANCE   *mPrivateData;
 236
 237 #endif