EmbeddedPkg/AcpiLib: Introduced LocateAndInstallAcpiFromFvConditional()

[mirror_edk2.git] / EmbeddedPkg / Library / AcpiLib / AcpiLib.c

/** @file\r
*\r
*  Copyright (c) 2014-2015, ARM Limited. All rights reserved.\r
*\r
*  This program and the accompanying materials\r
*  are licensed and made available under the terms and conditions of the BSD License\r
*  which accompanies this distribution.  The full text of the license may be found at\r
*  http://opensource.org/licenses/bsd-license.php\r
*\r
*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
*\r
**/\r
\r
#include <Uefi.h>\r
\r
#include <Library/AcpiLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include <Protocol/AcpiTable.h>\r
#include <Protocol/FirmwareVolume2.h>\r
\r
#include <IndustryStandard/Acpi.h>\r
\r
/**\r
  Locate and Install the ACPI tables from the Firmware Volume if it verifies\r
  the function condition.\r
\r
  @param  AcpiFile                Guid of the ACPI file into the Firmware Volume\r
  @param  CheckAcpiTableFunction  Function that checks if the ACPI table should be installed\r
\r
  @return EFI_SUCCESS             The function completed successfully.\r
  @return EFI_NOT_FOUND           The protocol could not be located.\r
  @return EFI_OUT_OF_RESOURCES    There are not enough resources to find the protocol.\r
\r
**/\r
EFI_STATUS\r
LocateAndInstallAcpiFromFvConditional (\r
  IN CONST EFI_GUID*        AcpiFile,\r
  IN EFI_LOCATE_ACPI_CHECK  CheckAcpiTableFunction\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_ACPI_TABLE_PROTOCOL       *AcpiProtocol;\r
  EFI_HANDLE                    *HandleBuffer;\r
  UINTN                         NumberOfHandles;\r
  UINT32                        FvStatus;\r
  UINTN                         Index;\r
  EFI_FIRMWARE_VOLUME2_PROTOCOL *FvInstance;\r
  INTN                          SectionInstance;\r
  UINTN                         SectionSize;\r
  EFI_ACPI_COMMON_HEADER       *AcpiTable;\r
  UINTN                         AcpiTableSize;\r
  UINTN                         AcpiTableKey;\r
  BOOLEAN                       Valid;\r
\r
  // Ensure the ACPI Table is present\r
  Status = gBS->LocateProtocol (\r
                  &gEfiAcpiTableProtocolGuid,\r
                  NULL,\r
                  (VOID**)&AcpiProtocol\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  FvStatus        = 0;\r
  SectionInstance = 0;\r
\r
  // Locate all the Firmware Volume protocols.\r
  Status = gBS->LocateHandleBuffer (\r
                   ByProtocol,\r
                   &gEfiFirmwareVolume2ProtocolGuid,\r
                   NULL,\r
                   &NumberOfHandles,\r
                   &HandleBuffer\r
                   );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Looking for FV with ACPI storage file\r
  for (Index = 0; Index < NumberOfHandles; Index++) {\r
    //\r
    // Get the protocol on this handle\r
    // This should not fail because of LocateHandleBuffer\r
    //\r
    Status = gBS->HandleProtocol (\r
                     HandleBuffer[Index],\r
                     &gEfiFirmwareVolume2ProtocolGuid,\r
                     (VOID**) &FvInstance\r
                     );\r
    if (EFI_ERROR (Status)) {\r
      goto FREE_HANDLE_BUFFER;\r
    }\r
\r
    while (Status == EFI_SUCCESS) {\r
      // AcpiTable must be allocated by ReadSection (ie: AcpiTable == NULL)\r
      AcpiTable = NULL;\r
\r
      // See if it has the ACPI storage file\r
      Status = FvInstance->ReadSection (\r
                        FvInstance,\r
                        AcpiFile,\r
                        EFI_SECTION_RAW,\r
                        SectionInstance,\r
                        (VOID**) &AcpiTable,\r
                        &SectionSize,\r
                        &FvStatus\r
                        );\r
      if (!EFI_ERROR (Status)) {\r
        AcpiTableKey = 0;\r
        AcpiTableSize = ((EFI_ACPI_DESCRIPTION_HEADER *) AcpiTable)->Length;\r
        ASSERT (SectionSize >= AcpiTableSize);\r
\r
        DEBUG ((EFI_D_ERROR, "- Found '%c%c%c%c' ACPI Table\n",\r
            (((EFI_ACPI_DESCRIPTION_HEADER *) AcpiTable)->Signature & 0xFF),\r
            ((((EFI_ACPI_DESCRIPTION_HEADER *) AcpiTable)->Signature >> 8) & 0xFF),\r
            ((((EFI_ACPI_DESCRIPTION_HEADER *) AcpiTable)->Signature >> 16) & 0xFF),\r
            ((((EFI_ACPI_DESCRIPTION_HEADER *) AcpiTable)->Signature >> 24) & 0xFF)));\r
\r
        // Is the ACPI table valid?\r
        if (CheckAcpiTableFunction) {\r
          Valid = CheckAcpiTableFunction ((EFI_ACPI_DESCRIPTION_HEADER *)AcpiTable);\r
        } else {\r
          Valid = TRUE;\r
        }\r
\r
        // Install the ACPI Table\r
        if (Valid) {\r
          Status = AcpiProtocol->InstallAcpiTable (\r
                                 AcpiProtocol,\r
                                 AcpiTable,\r
                                 AcpiTableSize,\r
                                 &AcpiTableKey\r
                                 );\r
        }\r
\r
        // Free memory allocated by ReadSection\r
        gBS->FreePool (AcpiTable);\r
\r
        if (EFI_ERROR (Status)) {\r
          break;\r
        }\r
\r
        // Increment the section instance\r
        SectionInstance++;\r
      }\r
    }\r
  }\r
\r
FREE_HANDLE_BUFFER:\r
  //\r
  // Free any allocated buffers\r
  //\r
  gBS->FreePool (HandleBuffer);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Locate and Install the ACPI tables from the Firmware Volume\r
\r
  @param  AcpiFile              Guid of the ACPI file into the Firmware Volume\r
\r
  @return EFI_SUCCESS           The function completed successfully.\r
  @return EFI_NOT_FOUND         The protocol could not be located.\r
  @return EFI_OUT_OF_RESOURCES  There are not enough resources to find the protocol.\r
\r
**/\r
EFI_STATUS\r
LocateAndInstallAcpiFromFv (\r
  IN CONST EFI_GUID* AcpiFile\r
  )\r
{\r
  return LocateAndInstallAcpiFromFvConditional (AcpiFile, NULL);\r
}\r