[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / AcpiTableDxe / AcpiTableProtocol.c

/** @file\r
  ACPI Table Protocol Implementation\r
\r
  Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
//\r
// Includes\r
//\r
#include "AcpiTable.h"\r
//\r
// The maximum number of tables that pre-allocated.\r
//\r
UINTN  mEfiAcpiMaxNumTables = EFI_ACPI_MAX_NUM_TABLES;\r
\r
//\r
// Allocation strategy to use for AllocatePages ().\r
// Runtime value depends on PcdExposedAcpiTableVersions.\r
//\r
STATIC EFI_ALLOCATE_TYPE  mAcpiTableAllocType;\r
\r
/**\r
  This function adds an ACPI table to the table list.  It will detect FACS and\r
  allocate the correct type of memory and properly align the table.\r
\r
  @param  AcpiTableInstance         Instance of the protocol.\r
  @param  Table                     Table to add.\r
  @param  Checksum                  Does the table require checksumming.\r
  @param  Version                   The version of the list to add the table to.\r
  @param  IsFromHob                 True, if add Apci Table from Hob List.\r
  @param  Handle                    Pointer for returning the handle.\r
\r
  @return EFI_SUCCESS               The function completed successfully.\r
  @return EFI_OUT_OF_RESOURCES      Could not allocate a required resource.\r
  @return EFI_ABORTED               The table is a duplicate of a table that is required\r
                                    to be unique.\r
\r
**/\r
EFI_STATUS\r
AddTableToList (\r
  IN EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance,\r
  IN VOID                     *Table,\r
  IN BOOLEAN                  Checksum,\r
  IN EFI_ACPI_TABLE_VERSION   Version,\r
  IN BOOLEAN                  IsFromHob,\r
  OUT UINTN                   *Handle\r
  );\r
\r
/**\r
  This function finds and removes the table specified by the handle.\r
\r
  @param  AcpiTableInstance  Instance of the protocol.\r
  @param  Version            Bitmask of which versions to remove.\r
  @param  Handle             Table to remove.\r
\r
  @return EFI_SUCCESS    The function completed successfully.\r
  @return EFI_ABORTED    An error occurred.\r
  @return EFI_NOT_FOUND  Handle not found in table list.\r
\r
**/\r
EFI_STATUS\r
RemoveTableFromList (\r
  IN EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance,\r
  IN EFI_ACPI_TABLE_VERSION   Version,\r
  IN UINTN                    Handle\r
  );\r
\r
/**\r
  This function calculates and updates an UINT8 checksum.\r
\r
  @param  Buffer          Pointer to buffer to checksum\r
  @param  Size            Number of bytes to checksum\r
  @param  ChecksumOffset  Offset to place the checksum result in\r
\r
  @return EFI_SUCCESS             The function completed successfully.\r
**/\r
EFI_STATUS\r
AcpiPlatformChecksum (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size,\r
  IN UINTN  ChecksumOffset\r
  );\r
\r
/**\r
  Checksum all versions of the common tables, RSDP, RSDT, XSDT.\r
\r
  @param  AcpiTableInstance  Protocol instance private data.\r
\r
  @return EFI_SUCCESS        The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
ChecksumCommonTables (\r
  IN OUT EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance\r
  );\r
\r
//\r
// Protocol function implementations.\r
//\r
\r
/**\r
  This function publishes the specified versions of the ACPI tables by\r
  installing EFI configuration table entries for them.  Any combination of\r
  table versions can be published.\r
\r
  @param  AcpiTableInstance  Instance of the protocol.\r
  @param  Version            Version(s) to publish.\r
\r
  @return EFI_SUCCESS  The function completed successfully.\r
  @return EFI_ABORTED  The function could not complete successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PublishTables (\r
  IN EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance,\r
  IN EFI_ACPI_TABLE_VERSION   Version\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT32      *CurrentRsdtEntry;\r
  VOID        *CurrentXsdtEntry;\r
  UINT64      Buffer64;\r
\r
  //\r
  // Reorder tables as some operating systems don't seem to find the\r
  // FADT correctly if it is not in the first few entries\r
  //\r
\r
  //\r
  // Add FADT as the first entry\r
  //\r
  if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    CurrentRsdtEntry  = (UINT32 *)((UINT8 *)AcpiTableInstance->Rsdt1 + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
    *CurrentRsdtEntry = (UINT32)(UINTN)AcpiTableInstance->Fadt1;\r
\r
    CurrentRsdtEntry  = (UINT32 *)((UINT8 *)AcpiTableInstance->Rsdt3 + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
    *CurrentRsdtEntry = (UINT32)(UINTN)AcpiTableInstance->Fadt3;\r
  }\r
\r
  if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
    CurrentXsdtEntry = (VOID *)((UINT8 *)AcpiTableInstance->Xsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
    //\r
    // Add entry to XSDT, XSDT expects 64 bit pointers, but\r
    // the table pointers in XSDT are not aligned on 8 byte boundary.\r
    //\r
    Buffer64 = (UINT64)(UINTN)AcpiTableInstance->Fadt3;\r
    CopyMem (\r
      CurrentXsdtEntry,\r
      &Buffer64,\r
      sizeof (UINT64)\r
      );\r
  }\r
\r
  //\r
  // Do checksum again because Dsdt/Xsdt is updated.\r
  //\r
  ChecksumCommonTables (AcpiTableInstance);\r
\r
  //\r
  // Add the RSD_PTR to the system table and store that we have installed the\r
  // tables.\r
  //\r
  if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    Status = gBS->InstallConfigurationTable (&gEfiAcpi10TableGuid, AcpiTableInstance->Rsdp1);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_ABORTED;\r
    }\r
  }\r
\r
  if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
    Status = gBS->InstallConfigurationTable (&gEfiAcpiTableGuid, AcpiTableInstance->Rsdp3);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_ABORTED;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Installs an ACPI table into the RSDT/XSDT.\r
  Note that the ACPI table should be checksumed before installing it.\r
  Otherwise it will assert.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  AcpiTableBuffer      A pointer to a buffer containing the ACPI table to be installed.\r
  @param  AcpiTableBufferSize  Specifies the size, in bytes, of the AcpiTableBuffer buffer.\r
  @param  TableKey             Reurns a key to refer to the ACPI table.\r
\r
  @return EFI_SUCCESS            The table was successfully inserted.\r
  @return EFI_INVALID_PARAMETER  Either AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize\r
                                 and the size field embedded in the ACPI table pointed to by AcpiTableBuffer\r
                                 are not in sync.\r
  @return EFI_OUT_OF_RESOURCES   Insufficient resources exist to complete the request.\r
  @retval EFI_ACCESS_DENIED      The table signature matches a table already\r
                                 present in the system and platform policy\r
                                 does not allow duplicate tables of this type.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InstallAcpiTable (\r
  IN   EFI_ACPI_TABLE_PROTOCOL  *This,\r
  IN   VOID                     *AcpiTableBuffer,\r
  IN   UINTN                    AcpiTableBufferSize,\r
  OUT  UINTN                    *TableKey\r
  )\r
{\r
  EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance;\r
  EFI_STATUS               Status;\r
  VOID                     *AcpiTableBufferConst;\r
  EFI_ACPI_TABLE_VERSION   Version;\r
\r
  //\r
  // Check for invalid input parameters\r
  //\r
  if (  (AcpiTableBuffer == NULL) || (TableKey == NULL)\r
     || (((EFI_ACPI_DESCRIPTION_HEADER *)AcpiTableBuffer)->Length != AcpiTableBufferSize))\r
  {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Version = PcdGet32 (PcdAcpiExposedTableVersions);\r
\r
  //\r
  // Get the instance of the ACPI table protocol\r
  //\r
  AcpiTableInstance = EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This);\r
\r
  //\r
  // Install the ACPI table\r
  //\r
  AcpiTableBufferConst = AllocateCopyPool (AcpiTableBufferSize, AcpiTableBuffer);\r
  *TableKey            = 0;\r
  Status               = AddTableToList (\r
                           AcpiTableInstance,\r
                           AcpiTableBufferConst,\r
                           TRUE,\r
                           Version,\r
                           FALSE,\r
                           TableKey\r
                           );\r
  if (!EFI_ERROR (Status)) {\r
    Status = PublishTables (\r
               AcpiTableInstance,\r
               Version\r
               );\r
  }\r
\r
  FreePool (AcpiTableBufferConst);\r
\r
  //\r
  // Add a new table successfully, notify registed callback\r
  //\r
  if (FeaturePcdGet (PcdInstallAcpiSdtProtocol)) {\r
    if (!EFI_ERROR (Status)) {\r
      SdtNotifyAcpiList (\r
        AcpiTableInstance,\r
        Version,\r
        *TableKey\r
        );\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Removes an ACPI table from the RSDT/XSDT.\r
\r
  @param  This      Protocol instance pointer.\r
  @param  TableKey  Specifies the table to uninstall.  The key was returned from InstallAcpiTable().\r
\r
  @return EFI_SUCCESS    The table was successfully uninstalled.\r
  @return EFI_NOT_FOUND  TableKey does not refer to a valid key for a table entry.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UninstallAcpiTable (\r
  IN  EFI_ACPI_TABLE_PROTOCOL  *This,\r
  IN  UINTN                    TableKey\r
  )\r
{\r
  EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance;\r
  EFI_STATUS               Status;\r
  EFI_ACPI_TABLE_VERSION   Version;\r
\r
  //\r
  // Get the instance of the ACPI table protocol\r
  //\r
  AcpiTableInstance = EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This);\r
\r
  Version = PcdGet32 (PcdAcpiExposedTableVersions);\r
\r
  //\r
  // Uninstall the ACPI table\r
  //\r
  Status = RemoveTableFromList (\r
             AcpiTableInstance,\r
             Version,\r
             TableKey\r
             );\r
  if (!EFI_ERROR (Status)) {\r
    Status = PublishTables (\r
               AcpiTableInstance,\r
               Version\r
               );\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_FOUND;\r
  } else {\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
/**\r
  If the number of APCI tables exceeds the preallocated max table number, enlarge the table buffer.\r
\r
  @param  AcpiTableInstance       ACPI table protocol instance data structure.\r
\r
  @return EFI_SUCCESS             reallocate the table beffer successfully.\r
  @return EFI_OUT_OF_RESOURCES    Unable to allocate required resources.\r
\r
**/\r
EFI_STATUS\r
ReallocateAcpiTableBuffer (\r
  IN EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance\r
  )\r
{\r
  UINTN                    NewMaxTableNumber;\r
  UINTN                    TotalSize;\r
  UINT8                    *Pointer;\r
  EFI_PHYSICAL_ADDRESS     PageAddress;\r
  EFI_ACPI_TABLE_INSTANCE  TempPrivateData;\r
  EFI_STATUS               Status;\r
  UINT64                   CurrentData;\r
\r
  CopyMem (&TempPrivateData, AcpiTableInstance, sizeof (EFI_ACPI_TABLE_INSTANCE));\r
  //\r
  // Enlarge the max table number from mEfiAcpiMaxNumTables to mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES\r
  //\r
  NewMaxTableNumber = mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES;\r
  //\r
  // Create RSDT, XSDT structures and allocate buffers.\r
  //\r
  TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) +         // for ACPI 2.0/3.0 XSDT\r
              NewMaxTableNumber * sizeof (UINT64);\r
\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    TotalSize += sizeof (EFI_ACPI_DESCRIPTION_HEADER) +      // for ACPI 1.0 RSDT\r
                 NewMaxTableNumber * sizeof (UINT32) +\r
                 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +      // for ACPI 2.0/3.0 RSDT\r
                 NewMaxTableNumber * sizeof (UINT32);\r
  }\r
\r
  if (mAcpiTableAllocType != AllocateAnyPages) {\r
    //\r
    // Allocate memory in the lower 32 bit of address range for\r
    // compatibility with ACPI 1.0 OS.\r
    //\r
    // This is done because ACPI 1.0 pointers are 32 bit values.\r
    // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
    // There is no architectural reason these should be below 4GB, it is purely\r
    // for convenience of implementation that we force memory below 4GB.\r
    //\r
    PageAddress = 0xFFFFFFFF;\r
    Status      = gBS->AllocatePages (\r
                         mAcpiTableAllocType,\r
                         EfiACPIReclaimMemory,\r
                         EFI_SIZE_TO_PAGES (TotalSize),\r
                         &PageAddress\r
                         );\r
  } else {\r
    Status = gBS->AllocatePool (\r
                    EfiACPIReclaimMemory,\r
                    TotalSize,\r
                    (VOID **)&Pointer\r
                    );\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  if (mAcpiTableAllocType != AllocateAnyPages) {\r
    Pointer = (UINT8 *)(UINTN)PageAddress;\r
  }\r
\r
  ZeroMem (Pointer, TotalSize);\r
\r
  AcpiTableInstance->Rsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *)Pointer;\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    Pointer                 += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + NewMaxTableNumber * sizeof (UINT32));\r
    AcpiTableInstance->Rsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *)Pointer;\r
    Pointer                 += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + NewMaxTableNumber * sizeof (UINT32));\r
  }\r
\r
  AcpiTableInstance->Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *)Pointer;\r
\r
  //\r
  // Update RSDP to point to the new Rsdt and Xsdt address.\r
  //\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    AcpiTableInstance->Rsdp1->RsdtAddress = (UINT32)(UINTN)AcpiTableInstance->Rsdt1;\r
    AcpiTableInstance->Rsdp3->RsdtAddress = (UINT32)(UINTN)AcpiTableInstance->Rsdt3;\r
  }\r
\r
  CurrentData = (UINT64)(UINTN)AcpiTableInstance->Xsdt;\r
  CopyMem (&AcpiTableInstance->Rsdp3->XsdtAddress, &CurrentData, sizeof (UINT64));\r
\r
  //\r
  // copy the original Rsdt1, Rsdt3 and Xsdt structure to new buffer\r
  //\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    CopyMem (AcpiTableInstance->Rsdt1, TempPrivateData.Rsdt1, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT32)));\r
    CopyMem (AcpiTableInstance->Rsdt3, TempPrivateData.Rsdt3, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT32)));\r
  }\r
\r
  CopyMem (AcpiTableInstance->Xsdt, TempPrivateData.Xsdt, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT64)));\r
\r
  if (mAcpiTableAllocType != AllocateAnyPages) {\r
    //\r
    // Calculate orignal ACPI table buffer size\r
    //\r
    TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) +         // for ACPI 2.0/3.0 XSDT\r
                mEfiAcpiMaxNumTables * sizeof (UINT64);\r
\r
    if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
      TotalSize += sizeof (EFI_ACPI_DESCRIPTION_HEADER) +         // for ACPI 1.0 RSDT\r
                   mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
                   sizeof (EFI_ACPI_DESCRIPTION_HEADER) +         // for ACPI 2.0/3.0 RSDT\r
                   mEfiAcpiMaxNumTables * sizeof (UINT32);\r
    }\r
\r
    gBS->FreePages (\r
           (EFI_PHYSICAL_ADDRESS)(UINTN)TempPrivateData.Rsdt1,\r
           EFI_SIZE_TO_PAGES (TotalSize)\r
           );\r
  } else {\r
    gBS->FreePool (TempPrivateData.Rsdt1);\r
  }\r
\r
  //\r
  // Update the Max ACPI table number\r
  //\r
  mEfiAcpiMaxNumTables = NewMaxTableNumber;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Free the memory associated with the provided EFI_ACPI_TABLE_LIST instance.\r
\r
  @param  TableEntry                EFI_ACPI_TABLE_LIST instance pointer\r
\r
**/\r
STATIC\r
VOID\r
FreeTableMemory (\r
  EFI_ACPI_TABLE_LIST  *TableEntry\r
  )\r
{\r
  if (TableEntry->PoolAllocation) {\r
    gBS->FreePool (TableEntry->Table);\r
  } else {\r
    gBS->FreePages (\r
           (EFI_PHYSICAL_ADDRESS)(UINTN)TableEntry->Table,\r
           EFI_SIZE_TO_PAGES (TableEntry->TableSize)\r
           );\r
  }\r
}\r
\r
/**\r
  This function adds an ACPI table to the table list.  It will detect FACS and\r
  allocate the correct type of memory and properly align the table.\r
\r
  @param  AcpiTableInstance         Instance of the protocol.\r
  @param  Table                     Table to add.\r
  @param  Checksum                  Does the table require checksumming.\r
  @param  Version                   The version of the list to add the table to.\r
  @param  IsFromHob                 True, if add Apci Table from Hob List.\r
  @param  Handle                    Pointer for returning the handle.\r
\r
  @return EFI_SUCCESS               The function completed successfully.\r
  @return EFI_OUT_OF_RESOURCES      Could not allocate a required resource.\r
  @retval EFI_ACCESS_DENIED         The table signature matches a table already\r
                                    present in the system and platform policy\r
                                    does not allow duplicate tables of this type.\r
\r
**/\r
EFI_STATUS\r
AddTableToList (\r
  IN EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance,\r
  IN VOID                     *Table,\r
  IN BOOLEAN                  Checksum,\r
  IN EFI_ACPI_TABLE_VERSION   Version,\r
  IN BOOLEAN                  IsFromHob,\r
  OUT UINTN                   *Handle\r
  )\r
{\r
  EFI_STATUS            Status;\r
  EFI_ACPI_TABLE_LIST   *CurrentTableList;\r
  UINT32                CurrentTableSignature;\r
  UINT32                CurrentTableSize;\r
  UINT32                *CurrentRsdtEntry;\r
  VOID                  *CurrentXsdtEntry;\r
  EFI_PHYSICAL_ADDRESS  AllocPhysAddress;\r
  UINT64                Buffer64;\r
  BOOLEAN               AddToRsdt;\r
\r
  //\r
  // Check for invalid input parameters\r
  //\r
  ASSERT (AcpiTableInstance);\r
  ASSERT (Table);\r
  ASSERT (Handle);\r
\r
  //\r
  // Init locals\r
  //\r
  AddToRsdt = TRUE;\r
\r
  //\r
  // Create a new list entry\r
  //\r
  CurrentTableList = AllocatePool (sizeof (EFI_ACPI_TABLE_LIST));\r
  ASSERT (CurrentTableList);\r
\r
  //\r
  // Determine table type and size\r
  //\r
  CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *)Table)->Signature;\r
  CurrentTableSize      = ((EFI_ACPI_COMMON_HEADER *)Table)->Length;\r
\r
  //\r
  // Allocate a buffer for the table.  All tables are allocated in the lower 32 bits of address space\r
  // for backwards compatibility with ACPI 1.0 OS.\r
  //\r
  // This is done because ACPI 1.0 pointers are 32 bit values.\r
  // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
  // There is no architectural reason these should be below 4GB, it is purely\r
  // for convenience of implementation that we force memory below 4GB.\r
  //\r
  AllocPhysAddress                 = 0xFFFFFFFF;\r
  CurrentTableList->TableSize      = CurrentTableSize;\r
  CurrentTableList->PoolAllocation = FALSE;\r
\r
  //\r
  // Allocation memory type depends on the type of the table\r
  //\r
  if ((CurrentTableSignature == EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
      (CurrentTableSignature == EFI_ACPI_4_0_UEFI_ACPI_DATA_TABLE_SIGNATURE))\r
  {\r
    //\r
    // Allocate memory for the FACS.  This structure must be aligned\r
    // on a 64 byte boundary and must be ACPI NVS memory.\r
    // Using AllocatePages should ensure that it is always aligned.\r
    // Do not change signature for new ACPI version because they are same.\r
    //\r
    // UEFI table also need to be in ACPI NVS memory, because some data field\r
    // could be updated by OS present agent. For example, BufferPtrAddress in\r
    // SMM communication ACPI table.\r
    //\r
    ASSERT ((EFI_PAGE_SIZE % 64) == 0);\r
    if (IsFromHob) {\r
      AllocPhysAddress = (UINTN)Table;\r
      Status           = EFI_SUCCESS;\r
    } else {\r
      Status = gBS->AllocatePages (\r
                      AllocateMaxAddress,\r
                      EfiACPIMemoryNVS,\r
                      EFI_SIZE_TO_PAGES (CurrentTableList->TableSize),\r
                      &AllocPhysAddress\r
                      );\r
    }\r
  } else if (mAcpiTableAllocType == AllocateAnyPages) {\r
    //\r
    // If there is no allocation limit, there is also no need to use page\r
    // based allocations for ACPI tables, which may be wasteful on platforms\r
    // such as AArch64 that allocate multiples of 64 KB\r
    //\r
    Status = gBS->AllocatePool (\r
                    EfiACPIReclaimMemory,\r
                    CurrentTableList->TableSize,\r
                    (VOID **)&CurrentTableList->Table\r
                    );\r
    CurrentTableList->PoolAllocation = TRUE;\r
  } else {\r
    //\r
    // All other tables are ACPI reclaim memory, no alignment requirements.\r
    //\r
    Status = gBS->AllocatePages (\r
                    mAcpiTableAllocType,\r
                    EfiACPIReclaimMemory,\r
                    EFI_SIZE_TO_PAGES (CurrentTableList->TableSize),\r
                    &AllocPhysAddress\r
                    );\r
    CurrentTableList->Table = (EFI_ACPI_COMMON_HEADER *)(UINTN)AllocPhysAddress;\r
  }\r
\r
  //\r
  // Check return value from memory alloc.\r
  //\r
  if (EFI_ERROR (Status)) {\r
    gBS->FreePool (CurrentTableList);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  if (!CurrentTableList->PoolAllocation) {\r
    CurrentTableList->Table = (EFI_ACPI_COMMON_HEADER *)(UINTN)AllocPhysAddress;\r
  }\r
\r
  //\r
  // Initialize the table contents\r
  //\r
  CurrentTableList->Signature = EFI_ACPI_TABLE_LIST_SIGNATURE;\r
  CopyMem (CurrentTableList->Table, Table, CurrentTableSize);\r
  CurrentTableList->Handle  = AcpiTableInstance->CurrentHandle++;\r
  *Handle                   = CurrentTableList->Handle;\r
  CurrentTableList->Version = Version;\r
\r
  //\r
  // Update internal pointers if this is a required table.  If it is a required\r
  // table and a table of that type already exists, return an error.\r
  //\r
  // Calculate the checksum if the table is not FACS.\r
  //\r
  switch (CurrentTableSignature) {\r
    case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
      //\r
      // We don't add the FADT in the standard way because some\r
      // OS expect the FADT to be early in the table list.\r
      // So we always add it as the first element in the list.\r
      //\r
      AddToRsdt = FALSE;\r
\r
      //\r
      // Check that the table has not been previously added.\r
      //\r
      if ((((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) && (AcpiTableInstance->Fadt1 != NULL)) ||\r
          (((Version & ACPI_TABLE_VERSION_GTE_2_0)  != 0) && (AcpiTableInstance->Fadt3 != NULL))\r
          )\r
      {\r
        FreeTableMemory (CurrentTableList);\r
        gBS->FreePool (CurrentTableList);\r
        return EFI_ACCESS_DENIED;\r
      }\r
\r
      //\r
      // Add the table to the appropriate table version\r
      //\r
      if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
        //\r
        // Save a pointer to the table\r
        //\r
        AcpiTableInstance->Fadt1 = (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE *)CurrentTableList->Table;\r
\r
        //\r
        // Update pointers in FADT.  If tables don't exist this will put NULL pointers there.\r
        //\r
        AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32)(UINTN)AcpiTableInstance->Facs1;\r
        AcpiTableInstance->Fadt1->Dsdt         = (UINT32)(UINTN)AcpiTableInstance->Dsdt1;\r
\r
        //\r
        // RSDP OEM information is updated to match the FADT OEM information\r
        //\r
        CopyMem (\r
          &AcpiTableInstance->Rsdp1->OemId,\r
          &AcpiTableInstance->Fadt1->Header.OemId,\r
          6\r
          );\r
\r
        //\r
        // RSDT OEM information is updated to match the FADT OEM information.\r
        //\r
        CopyMem (\r
          &AcpiTableInstance->Rsdt1->OemId,\r
          &AcpiTableInstance->Fadt1->Header.OemId,\r
          6\r
          );\r
\r
        CopyMem (\r
          &AcpiTableInstance->Rsdt1->OemTableId,\r
          &AcpiTableInstance->Fadt1->Header.OemTableId,\r
          sizeof (UINT64)\r
          );\r
        AcpiTableInstance->Rsdt1->OemRevision = AcpiTableInstance->Fadt1->Header.OemRevision;\r
      }\r
\r
      if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
        //\r
        // Save a pointer to the table\r
        //\r
        AcpiTableInstance->Fadt3 = (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *)CurrentTableList->Table;\r
\r
        //\r
        // Update pointers in FADT.  If tables don't exist this will put NULL pointers there.\r
        // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and\r
        // vice-versa.\r
        //\r
        if ((UINT64)(UINTN)AcpiTableInstance->Facs3 < BASE_4GB) {\r
          AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32)(UINTN)AcpiTableInstance->Facs3;\r
          ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
        } else {\r
          Buffer64 = (UINT64)(UINTN)AcpiTableInstance->Facs3;\r
          CopyMem (\r
            &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
            &Buffer64,\r
            sizeof (UINT64)\r
            );\r
          AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
        }\r
\r
        if ((UINT64)(UINTN)AcpiTableInstance->Dsdt3 < BASE_4GB) {\r
          AcpiTableInstance->Fadt3->Dsdt = (UINT32)(UINTN)AcpiTableInstance->Dsdt3;\r
          //\r
          // Comment block "the caller installs the tables in "DSDT, FADT" order"\r
          // The below comments are also in "the caller installs the tables in "FADT, DSDT" order" comment block.\r
          //\r
          // The ACPI specification, up to and including revision 5.1 Errata A,\r
          // allows the DSDT and X_DSDT fields to be both set in the FADT.\r
          // (Obviously, this only makes sense if the DSDT address is representable in 4 bytes.)\r
          // Starting with 5.1 Errata B, specifically for Mantis 1393 <https://mantis.uefi.org/mantis/view.php?id=1393>,\r
          // the spec requires at most one of DSDT and X_DSDT fields to be set to a nonzero value,\r
          // but strangely an exception is 6.0 that has no this requirement.\r
          //\r
          // Here we do not make the DSDT and X_DSDT fields mutual exclusion conditionally\r
          // by checking FADT revision, but always set both DSDT and X_DSDT fields in the FADT\r
          // to have better compatibility as some OS may have assumption to only consume X_DSDT\r
          // field even the DSDT address is < 4G.\r
          //\r
          Buffer64 = AcpiTableInstance->Fadt3->Dsdt;\r
        } else {\r
          AcpiTableInstance->Fadt3->Dsdt = 0;\r
          Buffer64                       = (UINT64)(UINTN)AcpiTableInstance->Dsdt3;\r
        }\r
\r
        CopyMem (&AcpiTableInstance->Fadt3->XDsdt, &Buffer64, sizeof (UINT64));\r
\r
        //\r
        // RSDP OEM information is updated to match the FADT OEM information\r
        //\r
        CopyMem (\r
          &AcpiTableInstance->Rsdp3->OemId,\r
          &AcpiTableInstance->Fadt3->Header.OemId,\r
          6\r
          );\r
\r
        if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
          //\r
          // RSDT OEM information is updated to match FADT OEM information.\r
          //\r
          CopyMem (\r
            &AcpiTableInstance->Rsdt3->OemId,\r
            &AcpiTableInstance->Fadt3->Header.OemId,\r
            6\r
            );\r
          CopyMem (\r
            &AcpiTableInstance->Rsdt3->OemTableId,\r
            &AcpiTableInstance->Fadt3->Header.OemTableId,\r
            sizeof (UINT64)\r
            );\r
          AcpiTableInstance->Rsdt3->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
        }\r
\r
        //\r
        // XSDT OEM information is updated to match FADT OEM information.\r
        //\r
        CopyMem (\r
          &AcpiTableInstance->Xsdt->OemId,\r
          &AcpiTableInstance->Fadt3->Header.OemId,\r
          6\r
          );\r
        CopyMem (\r
          &AcpiTableInstance->Xsdt->OemTableId,\r
          &AcpiTableInstance->Fadt3->Header.OemTableId,\r
          sizeof (UINT64)\r
          );\r
        AcpiTableInstance->Xsdt->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
      }\r
\r
      //\r
      // Checksum the table\r
      //\r
      if (Checksum) {\r
        AcpiPlatformChecksum (\r
          CurrentTableList->Table,\r
          CurrentTableList->Table->Length,\r
          OFFSET_OF (\r
            EFI_ACPI_DESCRIPTION_HEADER,\r
            Checksum\r
            )\r
          );\r
      }\r
\r
      break;\r
\r
    case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
      //\r
      // Check that the table has not been previously added.\r
      //\r
      if ((((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) && (AcpiTableInstance->Facs1 != NULL)) ||\r
          (((Version & ACPI_TABLE_VERSION_GTE_2_0)  != 0) && (AcpiTableInstance->Facs3 != NULL))\r
          )\r
      {\r
        FreeTableMemory (CurrentTableList);\r
        gBS->FreePool (CurrentTableList);\r
        return EFI_ACCESS_DENIED;\r
      }\r
\r
      //\r
      // FACS is referenced by FADT and is not part of RSDT\r
      //\r
      AddToRsdt = FALSE;\r
\r
      //\r
      // Add the table to the appropriate table version\r
      //\r
      if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
        //\r
        // Save a pointer to the table\r
        //\r
        AcpiTableInstance->Facs1 = (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *)CurrentTableList->Table;\r
\r
        //\r
        // If FADT already exists, update table pointers.\r
        //\r
        if (AcpiTableInstance->Fadt1 != NULL) {\r
          AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32)(UINTN)AcpiTableInstance->Facs1;\r
\r
          //\r
          // Checksum FADT table\r
          //\r
          AcpiPlatformChecksum (\r
            AcpiTableInstance->Fadt1,\r
            AcpiTableInstance->Fadt1->Header.Length,\r
            OFFSET_OF (\r
              EFI_ACPI_DESCRIPTION_HEADER,\r
              Checksum\r
              )\r
            );\r
        }\r
      }\r
\r
      if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
        //\r
        // Save a pointer to the table\r
        //\r
        AcpiTableInstance->Facs3 = (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *)CurrentTableList->Table;\r
\r
        //\r
        // If FADT already exists, update table pointers.\r
        //\r
        if (AcpiTableInstance->Fadt3 != NULL) {\r
          //\r
          // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and\r
          // vice-versa.\r
          //\r
          if ((UINT64)(UINTN)AcpiTableInstance->Facs3 < BASE_4GB) {\r
            AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32)(UINTN)AcpiTableInstance->Facs3;\r
            ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
          } else {\r
            Buffer64 = (UINT64)(UINTN)AcpiTableInstance->Facs3;\r
            CopyMem (\r
              &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
              &Buffer64,\r
              sizeof (UINT64)\r
              );\r
            AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
          }\r
\r
          //\r
          // Checksum FADT table\r
          //\r
          AcpiPlatformChecksum (\r
            AcpiTableInstance->Fadt3,\r
            AcpiTableInstance->Fadt3->Header.Length,\r
            OFFSET_OF (\r
              EFI_ACPI_DESCRIPTION_HEADER,\r
              Checksum\r
              )\r
            );\r
        }\r
      }\r
\r
      break;\r
\r
    case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
      //\r
      // Check that the table has not been previously added.\r
      //\r
      if ((((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) && (AcpiTableInstance->Dsdt1 != NULL)) ||\r
          (((Version & ACPI_TABLE_VERSION_GTE_2_0)  != 0) && (AcpiTableInstance->Dsdt3 != NULL))\r
          )\r
      {\r
        FreeTableMemory (CurrentTableList);\r
        gBS->FreePool (CurrentTableList);\r
        return EFI_ACCESS_DENIED;\r
      }\r
\r
      //\r
      // DSDT is referenced by FADT and is not part of RSDT\r
      //\r
      AddToRsdt = FALSE;\r
\r
      //\r
      // Add the table to the appropriate table version\r
      //\r
      if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
        //\r
        // Save a pointer to the table\r
        //\r
        AcpiTableInstance->Dsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *)CurrentTableList->Table;\r
\r
        //\r
        // If FADT already exists, update table pointers.\r
        //\r
        if (AcpiTableInstance->Fadt1 != NULL) {\r
          AcpiTableInstance->Fadt1->Dsdt = (UINT32)(UINTN)AcpiTableInstance->Dsdt1;\r
\r
          //\r
          // Checksum FADT table\r
          //\r
          AcpiPlatformChecksum (\r
            AcpiTableInstance->Fadt1,\r
            AcpiTableInstance->Fadt1->Header.Length,\r
            OFFSET_OF (\r
              EFI_ACPI_DESCRIPTION_HEADER,\r
              Checksum\r
              )\r
            );\r
        }\r
      }\r
\r
      if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
        //\r
        // Save a pointer to the table\r
        //\r
        AcpiTableInstance->Dsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *)CurrentTableList->Table;\r
\r
        //\r
        // If FADT already exists, update table pointers.\r
        //\r
        if (AcpiTableInstance->Fadt3 != NULL) {\r
          if ((UINT64)(UINTN)AcpiTableInstance->Dsdt3 < BASE_4GB) {\r
            AcpiTableInstance->Fadt3->Dsdt = (UINT32)(UINTN)AcpiTableInstance->Dsdt3;\r
            //\r
            // Comment block "the caller installs the tables in "FADT, DSDT" order"\r
            // The below comments are also in "the caller installs the tables in "DSDT, FADT" order" comment block.\r
            //\r
            // The ACPI specification, up to and including revision 5.1 Errata A,\r
            // allows the DSDT and X_DSDT fields to be both set in the FADT.\r
            // (Obviously, this only makes sense if the DSDT address is representable in 4 bytes.)\r
            // Starting with 5.1 Errata B, specifically for Mantis 1393 <https://mantis.uefi.org/mantis/view.php?id=1393>,\r
            // the spec requires at most one of DSDT and X_DSDT fields to be set to a nonzero value,\r
            // but strangely an exception is 6.0 that has no this requirement.\r
            //\r
            // Here we do not make the DSDT and X_DSDT fields mutual exclusion conditionally\r
            // by checking FADT revision, but always set both DSDT and X_DSDT fields in the FADT\r
            // to have better compatibility as some OS may have assumption to only consume X_DSDT\r
            // field even the DSDT address is < 4G.\r
            //\r
            Buffer64 = AcpiTableInstance->Fadt3->Dsdt;\r
          } else {\r
            AcpiTableInstance->Fadt3->Dsdt = 0;\r
            Buffer64                       = (UINT64)(UINTN)AcpiTableInstance->Dsdt3;\r
          }\r
\r
          CopyMem (&AcpiTableInstance->Fadt3->XDsdt, &Buffer64, sizeof (UINT64));\r
\r
          //\r
          // Checksum FADT table\r
          //\r
          AcpiPlatformChecksum (\r
            AcpiTableInstance->Fadt3,\r
            AcpiTableInstance->Fadt3->Header.Length,\r
            OFFSET_OF (\r
              EFI_ACPI_DESCRIPTION_HEADER,\r
              Checksum\r
              )\r
            );\r
        }\r
      }\r
\r
      //\r
      // Checksum the table\r
      //\r
      if (Checksum) {\r
        AcpiPlatformChecksum (\r
          CurrentTableList->Table,\r
          CurrentTableList->Table->Length,\r
          OFFSET_OF (\r
            EFI_ACPI_DESCRIPTION_HEADER,\r
            Checksum\r
            )\r
          );\r
      }\r
\r
      break;\r
\r
    default:\r
      //\r
      // Checksum the table\r
      //\r
      if (Checksum) {\r
        AcpiPlatformChecksum (\r
          CurrentTableList->Table,\r
          CurrentTableList->Table->Length,\r
          OFFSET_OF (\r
            EFI_ACPI_DESCRIPTION_HEADER,\r
            Checksum\r
            )\r
          );\r
      }\r
\r
      break;\r
  }\r
\r
  //\r
  // Add the table to the current list of tables\r
  //\r
  InsertTailList (&AcpiTableInstance->TableList, &CurrentTableList->Link);\r
\r
  //\r
  // Add the table to RSDT and/or XSDT table entry lists.\r
  //\r
  //\r
  // Add to ACPI 1.0b table tree\r
  //\r
  if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    if (AddToRsdt) {\r
      //\r
      // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
      //\r
      if (AcpiTableInstance->NumberOfTableEntries1 >= mEfiAcpiMaxNumTables) {\r
        Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
        ASSERT_EFI_ERROR (Status);\r
      }\r
\r
      CurrentRsdtEntry = (UINT32 *)\r
                         (\r
                          (UINT8 *)AcpiTableInstance->Rsdt1 +\r
                          sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
                          AcpiTableInstance->NumberOfTableEntries1 *\r
                          sizeof (UINT32)\r
                         );\r
\r
      //\r
      // Add entry to the RSDT unless its the FACS or DSDT\r
      //\r
      *CurrentRsdtEntry = (UINT32)(UINTN)CurrentTableList->Table;\r
\r
      //\r
      // Update RSDT length\r
      //\r
      AcpiTableInstance->Rsdt1->Length = AcpiTableInstance->Rsdt1->Length + sizeof (UINT32);\r
\r
      AcpiTableInstance->NumberOfTableEntries1++;\r
    }\r
  }\r
\r
  //\r
  // Add to ACPI 2.0/3.0  table tree\r
  //\r
  if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
    if (AddToRsdt) {\r
      //\r
      // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
      //\r
      if (AcpiTableInstance->NumberOfTableEntries3 >= mEfiAcpiMaxNumTables) {\r
        Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
        ASSERT_EFI_ERROR (Status);\r
      }\r
\r
      if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
        //\r
        // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
        // If it becomes necessary to maintain separate table lists, changes will be required.\r
        //\r
        CurrentRsdtEntry = (UINT32 *)\r
                           (\r
                            (UINT8 *)AcpiTableInstance->Rsdt3 +\r
                            sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
                            AcpiTableInstance->NumberOfTableEntries3 *\r
                            sizeof (UINT32)\r
                           );\r
\r
        //\r
        // Add entry to the RSDT\r
        //\r
        *CurrentRsdtEntry = (UINT32)(UINTN)CurrentTableList->Table;\r
\r
        //\r
        // Update RSDT length\r
        //\r
        AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof (UINT32);\r
      }\r
\r
      //\r
      // This pointer must not be directly dereferenced as the XSDT entries may not\r
      // be 64 bit aligned resulting in a possible fault.  Use CopyMem to update.\r
      //\r
      CurrentXsdtEntry = (VOID *)\r
                         (\r
                          (UINT8 *)AcpiTableInstance->Xsdt +\r
                          sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
                          AcpiTableInstance->NumberOfTableEntries3 *\r
                          sizeof (UINT64)\r
                         );\r
\r
      //\r
      // Add entry to XSDT, XSDT expects 64 bit pointers, but\r
      // the table pointers in XSDT are not aligned on 8 byte boundary.\r
      //\r
      Buffer64 = (UINT64)(UINTN)CurrentTableList->Table;\r
      CopyMem (\r
        CurrentXsdtEntry,\r
        &Buffer64,\r
        sizeof (UINT64)\r
        );\r
\r
      //\r
      // Update length\r
      //\r
      AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof (UINT64);\r
\r
      AcpiTableInstance->NumberOfTableEntries3++;\r
    }\r
  }\r
\r
  ChecksumCommonTables (AcpiTableInstance);\r
  return EFI_SUCCESS;\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  Handle      Table to find.\r
  @param  TableList   Table list to search\r
  @param  Table       Pointer to table found.\r
\r
  @return EFI_SUCCESS    The function completed successfully.\r
  @return 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
  LIST_ENTRY           *CurrentLink;\r
  EFI_ACPI_TABLE_LIST  *CurrentTable;\r
\r
  //\r
  // Check for invalid input parameters\r
  //\r
  ASSERT (Table);\r
\r
  //\r
  // Find the table\r
  //\r
  CurrentLink = TableList->ForwardLink;\r
\r
  while (CurrentLink != TableList) {\r
    CurrentTable = EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink);\r
    if (CurrentTable->Handle == Handle) {\r
      //\r
      // Found handle, so return this table.\r
      //\r
      *Table = CurrentTable;\r
      return EFI_SUCCESS;\r
    }\r
\r
    CurrentLink = CurrentLink->ForwardLink;\r
  }\r
\r
  //\r
  // Table not found\r
  //\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  This function removes a basic table from the RSDT and/or XSDT.\r
  For Acpi 1.0 tables, pass in the Rsdt.\r
  For Acpi 2.0 tables, pass in both Rsdt and Xsdt.\r
\r
  @param  Table                 Pointer to table found.\r
  @param  NumberOfTableEntries  Current number of table entries in the RSDT/XSDT\r
  @param  Rsdt                  Pointer to the RSDT to remove from\r
  @param  Xsdt                  Pointer to the Xsdt to remove from\r
\r
  @return EFI_SUCCESS            The function completed successfully.\r
  @return EFI_INVALID_PARAMETER  The table was not found in both Rsdt and Xsdt.\r
\r
**/\r
EFI_STATUS\r
RemoveTableFromRsdt (\r
  IN OUT EFI_ACPI_TABLE_LIST          *Table,\r
  IN OUT UINTN                        *NumberOfTableEntries,\r
  IN OUT EFI_ACPI_DESCRIPTION_HEADER  *Rsdt OPTIONAL,\r
  IN OUT EFI_ACPI_DESCRIPTION_HEADER  *Xsdt OPTIONAL\r
  )\r
{\r
  UINT32  *CurrentRsdtEntry;\r
  VOID    *CurrentXsdtEntry;\r
  UINT64  CurrentTablePointer64;\r
  UINTN   Index;\r
\r
  //\r
  // Check for invalid input parameters\r
  //\r
  ASSERT (Table);\r
  ASSERT (NumberOfTableEntries);\r
  ASSERT (Rsdt || Xsdt);\r
\r
  //\r
  // Find the table entry in the RSDT and XSDT\r
  //\r
  for (Index = 0; Index < *NumberOfTableEntries; Index++) {\r
    //\r
    // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
    // If it becomes necessary to maintain separate table lists, changes will be required.\r
    //\r
    if (Rsdt != NULL) {\r
      CurrentRsdtEntry = (UINT32 *)((UINT8 *)Rsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT32));\r
    } else {\r
      CurrentRsdtEntry = NULL;\r
    }\r
\r
    if (Xsdt != NULL) {\r
      //\r
      // This pointer must not be directly dereferenced as the XSDT entries may not\r
      // be 64 bit aligned resulting in a possible fault.  Use CopyMem to update.\r
      //\r
      CurrentXsdtEntry = (VOID *)((UINT8 *)Xsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT64));\r
\r
      //\r
      // Read the entry value out of the XSDT\r
      //\r
      CopyMem (&CurrentTablePointer64, CurrentXsdtEntry, sizeof (UINT64));\r
    } else {\r
      //\r
      // Initialize to NULL\r
      //\r
      CurrentXsdtEntry      = 0;\r
      CurrentTablePointer64 = 0;\r
    }\r
\r
    //\r
    // Check if we have found the corresponding entry in both RSDT and XSDT\r
    //\r
    if (((Rsdt == NULL) || (*CurrentRsdtEntry == (UINT32)(UINTN)Table->Table)) &&\r
        ((Xsdt == NULL) || (CurrentTablePointer64 == (UINT64)(UINTN)Table->Table))\r
        )\r
    {\r
      //\r
      // Found entry, so copy all following entries and shrink table\r
      // We actually copy all + 1 to copy the initialized value of memory over\r
      // the last entry.\r
      //\r
      if (Rsdt != NULL) {\r
        CopyMem (CurrentRsdtEntry, CurrentRsdtEntry + 1, (*NumberOfTableEntries - Index) * sizeof (UINT32));\r
        Rsdt->Length = Rsdt->Length - sizeof (UINT32);\r
      }\r
\r
      if (Xsdt != NULL) {\r
        CopyMem (CurrentXsdtEntry, ((UINT64 *)CurrentXsdtEntry) + 1, (*NumberOfTableEntries - Index) * sizeof (UINT64));\r
        Xsdt->Length = Xsdt->Length - sizeof (UINT64);\r
      }\r
\r
      break;\r
    } else if (Index + 1 == *NumberOfTableEntries) {\r
      //\r
      // At the last entry, and table not found\r
      //\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  //\r
  // Checksum the tables\r
  //\r
  if (Rsdt != NULL) {\r
    AcpiPlatformChecksum (\r
      Rsdt,\r
      Rsdt->Length,\r
      OFFSET_OF (\r
        EFI_ACPI_DESCRIPTION_HEADER,\r
        Checksum\r
        )\r
      );\r
  }\r
\r
  if (Xsdt != NULL) {\r
    AcpiPlatformChecksum (\r
      Xsdt,\r
      Xsdt->Length,\r
      OFFSET_OF (\r
        EFI_ACPI_DESCRIPTION_HEADER,\r
        Checksum\r
        )\r
      );\r
  }\r
\r
  //\r
  // Decrement the number of tables\r
  //\r
  (*NumberOfTableEntries)--;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function removes a table and frees any associated memory.\r
\r
  @param  AcpiTableInstance  Instance of the protocol.\r
  @param  Version            Version(s) to delete.\r
  @param  Table              Pointer to table found.\r
\r
  @return EFI_SUCCESS  The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
DeleteTable (\r
  IN EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance,\r
  IN EFI_ACPI_TABLE_VERSION   Version,\r
  IN OUT EFI_ACPI_TABLE_LIST  *Table\r
  )\r
{\r
  UINT32   CurrentTableSignature;\r
  BOOLEAN  RemoveFromRsdt;\r
\r
  //\r
  // Check for invalid input parameters\r
  //\r
  ASSERT (AcpiTableInstance);\r
  ASSERT (Table);\r
\r
  //\r
  // Init locals\r
  //\r
  RemoveFromRsdt = TRUE;\r
  //\r
  // Check for Table->Table\r
  //\r
  ASSERT (Table->Table != NULL);\r
  CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *)Table->Table)->Signature;\r
\r
  //\r
  // Basic tasks to accomplish delete are:\r
  //   Determine removal requirements (in RSDT/XSDT or not)\r
  //   Remove entry from RSDT/XSDT\r
  //   Remove any table references to the table\r
  //   If no one is using the table\r
  //      Free the table (removing pointers from private data and tables)\r
  //      Remove from list\r
  //      Free list structure\r
  //\r
  //\r
  // Determine if this table is in the RSDT or XSDT\r
  //\r
  if ((CurrentTableSignature == EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
      (CurrentTableSignature == EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) ||\r
      (CurrentTableSignature == EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE)\r
      )\r
  {\r
    RemoveFromRsdt = FALSE;\r
  }\r
\r
  //\r
  // We don't remove the FADT in the standard way because some\r
  // OS expect the FADT to be early in the table list.\r
  // So we always put it as the first element in the list.\r
  //\r
  if (CurrentTableSignature == EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) {\r
    RemoveFromRsdt = FALSE;\r
  }\r
\r
  //\r
  // Remove the table from RSDT and XSDT\r
  //\r
  if (Table->Table != NULL) {\r
    //\r
    // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt\r
    //\r
    if (Version & EFI_ACPI_TABLE_VERSION_NONE & Table->Version) {\r
      //\r
      // Remove this version from the table\r
      //\r
      Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_NONE;\r
    }\r
\r
    if (Version & EFI_ACPI_TABLE_VERSION_1_0B & Table->Version) {\r
      //\r
      // Remove this version from the table\r
      //\r
      Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_1_0B;\r
\r
      //\r
      // Remove from Rsdt.  We don't care about the return value because it is\r
      // acceptable for the table to not exist in Rsdt.\r
      // We didn't add some tables so we don't remove them.\r
      //\r
      if (RemoveFromRsdt) {\r
        RemoveTableFromRsdt (\r
          Table,\r
          &AcpiTableInstance->NumberOfTableEntries1,\r
          AcpiTableInstance->Rsdt1,\r
          NULL\r
          );\r
      }\r
    }\r
\r
    if (Version & ACPI_TABLE_VERSION_GTE_2_0 & Table->Version) {\r
      //\r
      // Remove this version from the table\r
      //\r
      Table->Version = Table->Version &~(Version & ACPI_TABLE_VERSION_GTE_2_0);\r
\r
      //\r
      // Remove from Rsdt and Xsdt.  We don't care about the return value\r
      // because it is acceptable for the table to not exist in Rsdt/Xsdt.\r
      // We didn't add some tables so we don't remove them.\r
      //\r
      if (RemoveFromRsdt) {\r
        RemoveTableFromRsdt (\r
          Table,\r
          &AcpiTableInstance->NumberOfTableEntries3,\r
          AcpiTableInstance->Rsdt3,\r
          AcpiTableInstance->Xsdt\r
          );\r
      }\r
    }\r
\r
    //\r
    // Free the table, clean up any dependent tables and our private data pointers.\r
    //\r
    switch (Table->Table->Signature) {\r
      case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
        if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
          AcpiTableInstance->Fadt1 = NULL;\r
        }\r
\r
        if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
          AcpiTableInstance->Fadt3 = NULL;\r
        }\r
\r
        break;\r
\r
      case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
        if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
          AcpiTableInstance->Facs1 = NULL;\r
\r
          //\r
          // Update FADT table pointers\r
          //\r
          if (AcpiTableInstance->Fadt1 != NULL) {\r
            AcpiTableInstance->Fadt1->FirmwareCtrl = 0;\r
\r
            //\r
            // Checksum table\r
            //\r
            AcpiPlatformChecksum (\r
              AcpiTableInstance->Fadt1,\r
              AcpiTableInstance->Fadt1->Header.Length,\r
              OFFSET_OF (\r
                EFI_ACPI_DESCRIPTION_HEADER,\r
                Checksum\r
                )\r
              );\r
          }\r
        }\r
\r
        if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
          AcpiTableInstance->Facs3 = NULL;\r
\r
          //\r
          // Update FADT table pointers\r
          //\r
          if (AcpiTableInstance->Fadt3 != NULL) {\r
            AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
            ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
\r
            //\r
            // Checksum table\r
            //\r
            AcpiPlatformChecksum (\r
              AcpiTableInstance->Fadt3,\r
              AcpiTableInstance->Fadt3->Header.Length,\r
              OFFSET_OF (\r
                EFI_ACPI_DESCRIPTION_HEADER,\r
                Checksum\r
                )\r
              );\r
          }\r
        }\r
\r
        break;\r
\r
      case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
        if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
          AcpiTableInstance->Dsdt1 = NULL;\r
\r
          //\r
          // Update FADT table pointers\r
          //\r
          if (AcpiTableInstance->Fadt1 != NULL) {\r
            AcpiTableInstance->Fadt1->Dsdt = 0;\r
\r
            //\r
            // Checksum table\r
            //\r
            AcpiPlatformChecksum (\r
              AcpiTableInstance->Fadt1,\r
              AcpiTableInstance->Fadt1->Header.Length,\r
              OFFSET_OF (\r
                EFI_ACPI_DESCRIPTION_HEADER,\r
                Checksum\r
                )\r
              );\r
          }\r
        }\r
\r
        if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
          AcpiTableInstance->Dsdt3 = NULL;\r
\r
          //\r
          // Update FADT table pointers\r
          //\r
          if (AcpiTableInstance->Fadt3 != NULL) {\r
            AcpiTableInstance->Fadt3->Dsdt = 0;\r
            ZeroMem (&AcpiTableInstance->Fadt3->XDsdt, sizeof (UINT64));\r
\r
            //\r
            // Checksum table\r
            //\r
            AcpiPlatformChecksum (\r
              AcpiTableInstance->Fadt3,\r
              AcpiTableInstance->Fadt3->Header.Length,\r
              OFFSET_OF (\r
                EFI_ACPI_DESCRIPTION_HEADER,\r
                Checksum\r
                )\r
              );\r
          }\r
        }\r
\r
        break;\r
\r
      default:\r
        //\r
        // Do nothing\r
        //\r
        break;\r
    }\r
  }\r
\r
  //\r
  // If no version is using this table anymore, remove and free list entry.\r
  //\r
  if (Table->Version == 0) {\r
    //\r
    // Free the Table\r
    //\r
    FreeTableMemory (Table);\r
    RemoveEntryList (&(Table->Link));\r
    gBS->FreePool (Table);\r
  }\r
\r
  //\r
  // Done\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function finds and removes the table specified by the handle.\r
\r
  @param  AcpiTableInstance  Instance of the protocol.\r
  @param  Version            Bitmask of which versions to remove.\r
  @param  Handle             Table to remove.\r
\r
  @return EFI_SUCCESS    The function completed successfully.\r
  @return EFI_ABORTED    An error occurred.\r
  @return EFI_NOT_FOUND  Handle not found in table list.\r
\r
**/\r
EFI_STATUS\r
RemoveTableFromList (\r
  IN EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance,\r
  IN EFI_ACPI_TABLE_VERSION   Version,\r
  IN UINTN                    Handle\r
  )\r
{\r
  EFI_ACPI_TABLE_LIST  *Table;\r
  EFI_STATUS           Status;\r
\r
  Table = (EFI_ACPI_TABLE_LIST *)NULL;\r
\r
  //\r
  // Check for invalid input parameters\r
  //\r
  ASSERT (AcpiTableInstance);\r
\r
  //\r
  // Find the table\r
  //\r
  Status = FindTableByHandle (\r
             Handle,\r
             &AcpiTableInstance->TableList,\r
             &Table\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Remove the table\r
  //\r
  Status = DeleteTable (AcpiTableInstance, Version, Table);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_ABORTED;\r
  }\r
\r
  //\r
  // Completed successfully\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function calculates and updates an UINT8 checksum.\r
\r
  @param  Buffer          Pointer to buffer to checksum\r
  @param  Size            Number of bytes to checksum\r
  @param  ChecksumOffset  Offset to place the checksum result in\r
\r
  @return 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
  UINT8  Sum;\r
  UINT8  *Ptr;\r
\r
  Sum = 0;\r
  //\r
  // Initialize pointer\r
  //\r
  Ptr = Buffer;\r
\r
  //\r
  // set checksum to 0 first\r
  //\r
  Ptr[ChecksumOffset] = 0;\r
\r
  //\r
  // add all content of buffer\r
  //\r
  while ((Size--) != 0) {\r
    Sum = (UINT8)(Sum + (*Ptr++));\r
  }\r
\r
  //\r
  // set checksum\r
  //\r
  Ptr                 = Buffer;\r
  Ptr[ChecksumOffset] = (UINT8)(0xff - Sum + 1);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Checksum all versions of the common tables, RSDP, RSDT, XSDT.\r
\r
  @param  AcpiTableInstance  Protocol instance private data.\r
\r
  @return EFI_SUCCESS        The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
ChecksumCommonTables (\r
  IN OUT EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance\r
  )\r
{\r
  //\r
  // RSDP ACPI 1.0 checksum for 1.0 table.  This is only the first 20 bytes of the structure\r
  //\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    AcpiPlatformChecksum (\r
      AcpiTableInstance->Rsdp1,\r
      sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
      OFFSET_OF (\r
        EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
        Checksum\r
        )\r
      );\r
  }\r
\r
  //\r
  // RSDP ACPI 1.0 checksum for 2.0/3.0 table.  This is only the first 20 bytes of the structure\r
  //\r
  AcpiPlatformChecksum (\r
    AcpiTableInstance->Rsdp3,\r
    sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
    OFFSET_OF (\r
      EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
      Checksum\r
      )\r
    );\r
\r
  //\r
  // RSDP ACPI 2.0/3.0 checksum, this is the entire table\r
  //\r
  AcpiPlatformChecksum (\r
    AcpiTableInstance->Rsdp3,\r
    sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
    OFFSET_OF (\r
      EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
      ExtendedChecksum\r
      )\r
    );\r
\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    //\r
    // RSDT checksums\r
    //\r
    AcpiPlatformChecksum (\r
      AcpiTableInstance->Rsdt1,\r
      AcpiTableInstance->Rsdt1->Length,\r
      OFFSET_OF (\r
        EFI_ACPI_DESCRIPTION_HEADER,\r
        Checksum\r
        )\r
      );\r
\r
    AcpiPlatformChecksum (\r
      AcpiTableInstance->Rsdt3,\r
      AcpiTableInstance->Rsdt3->Length,\r
      OFFSET_OF (\r
        EFI_ACPI_DESCRIPTION_HEADER,\r
        Checksum\r
        )\r
      );\r
  }\r
\r
  //\r
  // XSDT checksum\r
  //\r
  AcpiPlatformChecksum (\r
    AcpiTableInstance->Xsdt,\r
    AcpiTableInstance->Xsdt->Length,\r
    OFFSET_OF (\r
      EFI_ACPI_DESCRIPTION_HEADER,\r
      Checksum\r
      )\r
    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function will find gUniversalPayloadAcpiTableGuid Guid Hob, and install Acpi table from it.\r
\r
  @param  AcpiTableInstance  Protocol instance private data.\r
\r
  @return EFI_SUCCESS        The function completed successfully.\r
  @return EFI_NOT_FOUND      The function doesn't find the gEfiAcpiTableGuid Guid Hob.\r
  @return EFI_ABORTED        The function could not complete successfully.\r
\r
**/\r
EFI_STATUS\r
InstallAcpiTableFromHob (\r
  EFI_ACPI_TABLE_INSTANCE  *AcpiTableInstance\r
  )\r
{\r
  EFI_HOB_GUID_TYPE                             *GuidHob;\r
  EFI_ACPI_TABLE_VERSION                        Version;\r
  EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *Rsdp;\r
  EFI_ACPI_DESCRIPTION_HEADER                   *Rsdt;\r
  EFI_ACPI_DESCRIPTION_HEADER                   *ChildTable;\r
  UINT64                                        ChildTableAddress;\r
  UINTN                                         Count;\r
  UINTN                                         Index;\r
  UINTN                                         TableKey;\r
  EFI_STATUS                                    Status;\r
  UINTN                                         EntrySize;\r
  UNIVERSAL_PAYLOAD_ACPI_TABLE                  *AcpiTableAdress;\r
  VOID                                          *TableToInstall;\r
  EFI_ACPI_SDT_HEADER                           *Table;\r
  UNIVERSAL_PAYLOAD_GENERIC_HEADER              *GenericHeader;\r
\r
  TableKey = 0;\r
  Version  = PcdGet32 (PcdAcpiExposedTableVersions);\r
  Status   = EFI_SUCCESS;\r
  //\r
  // HOB only contains the ACPI table in 2.0+ format.\r
  //\r
  GuidHob = GetFirstGuidHob (&gUniversalPayloadAcpiTableGuid);\r
  if (GuidHob == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  GenericHeader = (UNIVERSAL_PAYLOAD_GENERIC_HEADER *)GET_GUID_HOB_DATA (GuidHob);\r
  if ((sizeof (UNIVERSAL_PAYLOAD_GENERIC_HEADER) > GET_GUID_HOB_DATA_SIZE (GuidHob)) || (GenericHeader->Length > GET_GUID_HOB_DATA_SIZE (GuidHob))) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (GenericHeader->Revision == UNIVERSAL_PAYLOAD_ACPI_TABLE_REVISION) {\r
    //\r
    // UNIVERSAL_PAYLOAD_ACPI_TABLE structure is used when Revision equals to UNIVERSAL_PAYLOAD_ACPI_TABLE_REVISION\r
    //\r
    AcpiTableAdress = (UNIVERSAL_PAYLOAD_ACPI_TABLE *)GET_GUID_HOB_DATA (GuidHob);\r
    if (AcpiTableAdress->Header.Length < UNIVERSAL_PAYLOAD_SIZEOF_THROUGH_FIELD (UNIVERSAL_PAYLOAD_ACPI_TABLE, Rsdp)) {\r
      //\r
      // Retrun if can't find the ACPI Info Hob with enough length\r
      //\r
      return EFI_NOT_FOUND;\r
    }\r
\r
    Rsdp = (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER *)(UINTN)(AcpiTableAdress->Rsdp);\r
\r
    //\r
    // An ACPI-compatible OS must use the XSDT if present.\r
    // It shouldn't happen that XsdtAddress points beyond 4G range in 32-bit environment.\r
    //\r
    ASSERT ((UINTN)Rsdp->XsdtAddress == Rsdp->XsdtAddress);\r
\r
    EntrySize = sizeof (UINT64);\r
    Rsdt      = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)Rsdp->XsdtAddress;\r
    if (Rsdt == NULL) {\r
      //\r
      // XsdtAddress is zero, then we use Rsdt which has 32 bit entry\r
      //\r
      Rsdt      = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)Rsdp->RsdtAddress;\r
      EntrySize = sizeof (UINT32);\r
    }\r
\r
    if (Rsdt->Length <= sizeof (EFI_ACPI_DESCRIPTION_HEADER)) {\r
      return EFI_ABORTED;\r
    }\r
\r
    Count = (Rsdt->Length - sizeof (EFI_ACPI_DESCRIPTION_HEADER)) / EntrySize;\r
\r
    for (Index = 0; Index < Count; Index++) {\r
      ChildTableAddress = 0;\r
      CopyMem (&ChildTableAddress, (UINT8 *)(Rsdt + 1) + EntrySize * Index, EntrySize);\r
      //\r
      // If the address is of UINT64 while this module runs at 32 bits,\r
      // make sure the upper bits are all-zeros.\r
      //\r
      ASSERT (ChildTableAddress == (UINTN)ChildTableAddress);\r
      if (ChildTableAddress != (UINTN)ChildTableAddress) {\r
        Status = EFI_ABORTED;\r
        break;\r
      }\r
\r
      ChildTable = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)ChildTableAddress;\r
      Status     = AddTableToList (AcpiTableInstance, ChildTable, TRUE, Version, TRUE, &TableKey);\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((DEBUG_ERROR, "InstallAcpiTableFromHob: Fail to add ACPI table at 0x%p\n", ChildTable));\r
        ASSERT_EFI_ERROR (Status);\r
        break;\r
      }\r
\r
      if (ChildTable->Signature == EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) {\r
        //\r
        // Add the FACS and DSDT tables if it is not NULL.\r
        //\r
        if (((EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *)ChildTable)->FirmwareCtrl != 0) {\r
          TableToInstall = (VOID *)(UINTN)((EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *)ChildTable)->FirmwareCtrl;\r
          Status         = AddTableToList (AcpiTableInstance, TableToInstall, TRUE, Version, TRUE, &TableKey);\r
          if (EFI_ERROR (Status)) {\r
            DEBUG ((DEBUG_ERROR, "InstallAcpiTableFromHob: Fail to add ACPI table FACS\n"));\r
            ASSERT_EFI_ERROR (Status);\r
            break;\r
          }\r
        }\r
\r
        if (((EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *)ChildTable)->Dsdt != 0) {\r
          TableToInstall = (VOID *)(UINTN)((EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *)ChildTable)->Dsdt;\r
          Status         = AddTableToList (AcpiTableInstance, TableToInstall, TRUE, Version, TRUE, &TableKey);\r
          if (EFI_ERROR (Status)) {\r
            DEBUG ((DEBUG_ERROR, "InstallAcpiTableFromHob: Fail to add ACPI table DSDT\n"));\r
            ASSERT_EFI_ERROR (Status);\r
            break;\r
          }\r
        }\r
      }\r
    }\r
  } else {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Error happens when trying to add ACPI table to the list.\r
    // Remove all of them from list because at this time, no other tables except from HOB are in the list\r
    //\r
    while (SdtGetAcpiTable (AcpiTableInstance, 0, &Table, &Version, &TableKey) == EFI_SUCCESS) {\r
      RemoveTableFromList (AcpiTableInstance, Version, TableKey);\r
    }\r
  } else {\r
    Status = PublishTables (AcpiTableInstance, Version);\r
  }\r
\r
  ASSERT_EFI_ERROR (Status);\r
  return Status;\r
}\r
\r
/**\r
  Constructor for the ACPI table 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
  EFI_STATUS            Status;\r
  UINT64                CurrentData;\r
  UINTN                 TotalSize;\r
  UINTN                 RsdpTableSize;\r
  UINT8                 *Pointer;\r
  EFI_PHYSICAL_ADDRESS  PageAddress;\r
\r
  //\r
  // Check for invalid input parameters\r
  //\r
  ASSERT (AcpiTableInstance);\r
\r
  //\r
  // If ACPI v1.0b is among the ACPI versions we aim to support, we have to\r
  // ensure that all memory allocations are below 4 GB.\r
  //\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    mAcpiTableAllocType = AllocateMaxAddress;\r
  } else {\r
    mAcpiTableAllocType = AllocateAnyPages;\r
  }\r
\r
  InitializeListHead (&AcpiTableInstance->TableList);\r
  AcpiTableInstance->CurrentHandle = 1;\r
\r
  AcpiTableInstance->AcpiTableProtocol.InstallAcpiTable   = InstallAcpiTable;\r
  AcpiTableInstance->AcpiTableProtocol.UninstallAcpiTable = UninstallAcpiTable;\r
\r
  if (FeaturePcdGet (PcdInstallAcpiSdtProtocol)) {\r
    SdtAcpiTableAcpiSdtConstructor (AcpiTableInstance);\r
  }\r
\r
  //\r
  // Create RSDP table\r
  //\r
  RsdpTableSize = sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    RsdpTableSize += sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
  }\r
\r
  if (mAcpiTableAllocType != AllocateAnyPages) {\r
    PageAddress = 0xFFFFFFFF;\r
    Status      = gBS->AllocatePages (\r
                         mAcpiTableAllocType,\r
                         EfiACPIReclaimMemory,\r
                         EFI_SIZE_TO_PAGES (RsdpTableSize),\r
                         &PageAddress\r
                         );\r
  } else {\r
    Status = gBS->AllocatePool (\r
                    EfiACPIReclaimMemory,\r
                    RsdpTableSize,\r
                    (VOID **)&Pointer\r
                    );\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  if (mAcpiTableAllocType != AllocateAnyPages) {\r
    Pointer = (UINT8 *)(UINTN)PageAddress;\r
  }\r
\r
  ZeroMem (Pointer, RsdpTableSize);\r
\r
  AcpiTableInstance->Rsdp1 = (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER *)Pointer;\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    Pointer += sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
  }\r
\r
  AcpiTableInstance->Rsdp3 = (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER *)Pointer;\r
\r
  //\r
  // Create RSDT, XSDT structures\r
  //\r
  TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) +         // for ACPI 2.0/3.0 XSDT\r
              mEfiAcpiMaxNumTables * sizeof (UINT64);\r
\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    TotalSize += sizeof (EFI_ACPI_DESCRIPTION_HEADER) +      // for ACPI 1.0 RSDT\r
                 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
                 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +      // for ACPI 2.0/3.0 RSDT\r
                 mEfiAcpiMaxNumTables * sizeof (UINT32);\r
  }\r
\r
  if (mAcpiTableAllocType != AllocateAnyPages) {\r
    //\r
    // Allocate memory in the lower 32 bit of address range for\r
    // compatibility with ACPI 1.0 OS.\r
    //\r
    // This is done because ACPI 1.0 pointers are 32 bit values.\r
    // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
    // There is no architectural reason these should be below 4GB, it is purely\r
    // for convenience of implementation that we force memory below 4GB.\r
    //\r
    PageAddress = 0xFFFFFFFF;\r
    Status      = gBS->AllocatePages (\r
                         mAcpiTableAllocType,\r
                         EfiACPIReclaimMemory,\r
                         EFI_SIZE_TO_PAGES (TotalSize),\r
                         &PageAddress\r
                         );\r
  } else {\r
    Status = gBS->AllocatePool (\r
                    EfiACPIReclaimMemory,\r
                    TotalSize,\r
                    (VOID **)&Pointer\r
                    );\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    if (mAcpiTableAllocType != AllocateAnyPages) {\r
      gBS->FreePages (\r
             (EFI_PHYSICAL_ADDRESS)(UINTN)AcpiTableInstance->Rsdp1,\r
             EFI_SIZE_TO_PAGES (RsdpTableSize)\r
             );\r
    } else {\r
      gBS->FreePool (AcpiTableInstance->Rsdp1);\r
    }\r
\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  if (mAcpiTableAllocType != AllocateAnyPages) {\r
    Pointer = (UINT8 *)(UINTN)PageAddress;\r
  }\r
\r
  ZeroMem (Pointer, TotalSize);\r
\r
  AcpiTableInstance->Rsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *)Pointer;\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    Pointer                 += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
    AcpiTableInstance->Rsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *)Pointer;\r
    Pointer                 += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
  }\r
\r
  AcpiTableInstance->Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *)Pointer;\r
\r
  //\r
  // Initialize RSDP\r
  //\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    CurrentData = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
    CopyMem (&AcpiTableInstance->Rsdp1->Signature, &CurrentData, sizeof (UINT64));\r
    CopyMem (AcpiTableInstance->Rsdp1->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdp1->OemId));\r
    AcpiTableInstance->Rsdp1->Reserved    = EFI_ACPI_RESERVED_BYTE;\r
    AcpiTableInstance->Rsdp1->RsdtAddress = (UINT32)(UINTN)AcpiTableInstance->Rsdt1;\r
  }\r
\r
  CurrentData = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
  CopyMem (&AcpiTableInstance->Rsdp3->Signature, &CurrentData, sizeof (UINT64));\r
  CopyMem (AcpiTableInstance->Rsdp3->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdp3->OemId));\r
  AcpiTableInstance->Rsdp3->Revision = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION;\r
  AcpiTableInstance->Rsdp3->Length   = sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    AcpiTableInstance->Rsdp3->RsdtAddress = (UINT32)(UINTN)AcpiTableInstance->Rsdt3;\r
  }\r
\r
  CurrentData = (UINT64)(UINTN)AcpiTableInstance->Xsdt;\r
  CopyMem (&AcpiTableInstance->Rsdp3->XsdtAddress, &CurrentData, sizeof (UINT64));\r
  SetMem (AcpiTableInstance->Rsdp3->Reserved, 3, EFI_ACPI_RESERVED_BYTE);\r
\r
  if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
    //\r
    // Initialize Rsdt\r
    //\r
    // Note that we "reserve" one entry for the FADT so it can always be\r
    // at the beginning of the list of tables.  Some OS don't seem\r
    // to find it correctly if it is too far down the list.\r
    //\r
    AcpiTableInstance->Rsdt1->Signature = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
    AcpiTableInstance->Rsdt1->Length    = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
    AcpiTableInstance->Rsdt1->Revision  = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
    CopyMem (AcpiTableInstance->Rsdt1->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdt1->OemId));\r
    CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
    CopyMem (&AcpiTableInstance->Rsdt1->OemTableId, &CurrentData, sizeof (UINT64));\r
    AcpiTableInstance->Rsdt1->OemRevision     = PcdGet32 (PcdAcpiDefaultOemRevision);\r
    AcpiTableInstance->Rsdt1->CreatorId       = PcdGet32 (PcdAcpiDefaultCreatorId);\r
    AcpiTableInstance->Rsdt1->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
    //\r
    // We always reserve first one for FADT\r
    //\r
    AcpiTableInstance->NumberOfTableEntries1 = 1;\r
    AcpiTableInstance->Rsdt1->Length         = AcpiTableInstance->Rsdt1->Length + sizeof (UINT32);\r
\r
    AcpiTableInstance->Rsdt3->Signature = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
    AcpiTableInstance->Rsdt3->Length    = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
    AcpiTableInstance->Rsdt3->Revision  = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
    CopyMem (AcpiTableInstance->Rsdt3->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdt3->OemId));\r
    CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
    CopyMem (&AcpiTableInstance->Rsdt3->OemTableId, &CurrentData, sizeof (UINT64));\r
    AcpiTableInstance->Rsdt3->OemRevision     = PcdGet32 (PcdAcpiDefaultOemRevision);\r
    AcpiTableInstance->Rsdt3->CreatorId       = PcdGet32 (PcdAcpiDefaultCreatorId);\r
    AcpiTableInstance->Rsdt3->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
    //\r
    // We always reserve first one for FADT\r
    //\r
    AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof (UINT32);\r
  }\r
\r
  AcpiTableInstance->NumberOfTableEntries3 = 1;\r
\r
  //\r
  // Initialize Xsdt\r
  //\r
  AcpiTableInstance->Xsdt->Signature = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
  AcpiTableInstance->Xsdt->Length    = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
  AcpiTableInstance->Xsdt->Revision  = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
  CopyMem (AcpiTableInstance->Xsdt->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Xsdt->OemId));\r
  CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
  CopyMem (&AcpiTableInstance->Xsdt->OemTableId, &CurrentData, sizeof (UINT64));\r
  AcpiTableInstance->Xsdt->OemRevision     = PcdGet32 (PcdAcpiDefaultOemRevision);\r
  AcpiTableInstance->Xsdt->CreatorId       = PcdGet32 (PcdAcpiDefaultCreatorId);\r
  AcpiTableInstance->Xsdt->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
  //\r
  // We always reserve first one for FADT\r
  //\r
  AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof (UINT64);\r
\r
  ChecksumCommonTables (AcpiTableInstance);\r
\r
  InstallAcpiTableFromHob (AcpiTableInstance);\r
\r
  //\r
  // Completed successfully\r
  //\r
  return EFI_SUCCESS;\r
}\r