EmbeddedPkg/AcpiLib: Fix code formatting errors

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

/** @file\r
*\r
*  Copyright (c) 2014-2015, ARM Limited. All rights reserved.\r
*  Copyright (c) 2021, Ampere Computing LLC. All rights reserved.\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#include <Uefi.h>\r
\r
#include <Library/AcpiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include <Protocol/AcpiSystemDescriptionTable.h>\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 ((\r
          DEBUG_ERROR,\r
          "- 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
\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
\r
/**\r
  This function calculates and updates a UINT8 checksum\r
  in an ACPI description table header.\r
\r
  @param  Buffer          Pointer to buffer to checksum\r
  @param  Size            Number of bytes to checksum\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiUpdateChecksum (\r
  IN OUT  UINT8  *Buffer,\r
  IN      UINTN  Size\r
  )\r
{\r
  UINTN  ChecksumOffset;\r
\r
  if ((Buffer == NULL) || (Size == 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ChecksumOffset = OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER, Checksum);\r
\r
  //\r
  // Set checksum to 0 first\r
  //\r
  Buffer[ChecksumOffset] = 0;\r
\r
  //\r
  // Update checksum value\r
  //\r
  Buffer[ChecksumOffset] = CalculateCheckSum8 (Buffer, Size);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function uses the ACPI SDT protocol to search an ACPI table\r
  with a given signature.\r
\r
  @param  AcpiTableSdtProtocol    Pointer to ACPI SDT protocol.\r
  @param  TableSignature          ACPI table signature.\r
  @param  Index                   The zero-based index of the table where to search the table.\r
                                  The index will be updated to the next instance if the table\r
                                  is found with the matched TableSignature.\r
  @param  Table                   Pointer to the table.\r
  @param  TableKey                Pointer to the table key.\r
\r
  @return EFI_SUCCESS             The function completed successfully.\r
  @return EFI_INVALID_PARAMETER   At least one of parameters is invalid.\r
  @retval EFI_NOT_FOUND           The requested index is too large and a table was not found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiLocateTableBySignature (\r
  IN      EFI_ACPI_SDT_PROTOCOL        *AcpiSdtProtocol,\r
  IN      UINT32                       TableSignature,\r
  IN OUT  UINTN                        *Index,\r
  OUT     EFI_ACPI_DESCRIPTION_HEADER  **Table,\r
  OUT     UINTN                        *TableKey\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_ACPI_SDT_HEADER     *TempTable;\r
  EFI_ACPI_TABLE_VERSION  TableVersion;\r
  UINTN                   TableIndex;\r
\r
  if (  (AcpiSdtProtocol == NULL)\r
     || (Table == NULL)\r
     || (TableKey == NULL))\r
  {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = EFI_SUCCESS;\r
\r
  //\r
  // Search for ACPI Table with matching signature\r
  //\r
  TableVersion = 0;\r
  TableIndex   = *Index;\r
  while (!EFI_ERROR (Status)) {\r
    Status = AcpiSdtProtocol->GetAcpiTable (\r
                                TableIndex,\r
                                &TempTable,\r
                                &TableVersion,\r
                                TableKey\r
                                );\r
    if (!EFI_ERROR (Status)) {\r
      TableIndex++;\r
\r
      if (((EFI_ACPI_DESCRIPTION_HEADER *)TempTable)->Signature == TableSignature) {\r
        *Table = (EFI_ACPI_DESCRIPTION_HEADER *)TempTable;\r
        *Index = TableIndex;\r
        break;\r
      }\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  This function updates the integer value of an AML Object.\r
\r
  @param  AcpiTableSdtProtocol    Pointer to ACPI SDT protocol.\r
  @param  TableHandle             Points to the table representing the starting point\r
                                  for the object path search.\r
  @param  AsciiObjectPath         Pointer to the ACPI path of the object being updated.\r
  @param  Value                   New value to write to the object.\r
\r
  @return EFI_SUCCESS             The function completed successfully.\r
  @return EFI_INVALID_PARAMETER   At least one of parameters is invalid or the data type\r
                                  of the ACPI object is not an integer value.\r
  @retval EFI_NOT_FOUND           The object is not found with the given path.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiAmlObjectUpdateInteger (\r
  IN  EFI_ACPI_SDT_PROTOCOL  *AcpiSdtProtocol,\r
  IN  EFI_ACPI_HANDLE        TableHandle,\r
  IN  CHAR8                  *AsciiObjectPath,\r
  IN  UINTN                  Value\r
  )\r
{\r
  EFI_STATUS          Status;\r
  EFI_ACPI_HANDLE     ObjectHandle;\r
  EFI_ACPI_HANDLE     DataHandle;\r
  EFI_ACPI_DATA_TYPE  DataType;\r
  UINT8               *Buffer;\r
  UINTN               BufferSize;\r
  UINTN               DataSize;\r
\r
  if ((AcpiSdtProtocol == NULL) || (AsciiObjectPath == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ObjectHandle = NULL;\r
  DataHandle   = NULL;\r
\r
  Status = AcpiSdtProtocol->FindPath (TableHandle, AsciiObjectPath, &ObjectHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = AcpiSdtProtocol->GetOption (ObjectHandle, 0, &DataType, (VOID *)&Buffer, &BufferSize);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_NOT_FOUND;\r
    goto Exit;\r
  }\r
\r
  ASSERT (DataType == EFI_ACPI_DATA_TYPE_OPCODE);\r
  ASSERT (Buffer != NULL);\r
\r
  if (Buffer[0] != AML_NAME_OP) {\r
    Status = EFI_NOT_FOUND;\r
    goto Exit;\r
  }\r
\r
  //\r
  // Get handle of data object\r
  //\r
  Status = AcpiSdtProtocol->GetChild (ObjectHandle, &DataHandle);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = AcpiSdtProtocol->GetOption (DataHandle, 0, &DataType, (VOID *)&Buffer, &BufferSize);\r
  ASSERT (DataType == EFI_ACPI_DATA_TYPE_OPCODE);\r
  ASSERT (Buffer != NULL);\r
\r
  if ((Buffer[0] == AML_ZERO_OP) || (Buffer[0] == AML_ONE_OP)) {\r
    Status = AcpiSdtProtocol->SetOption (DataHandle, 0, (VOID *)&Value, sizeof (UINT8));\r
    ASSERT_EFI_ERROR (Status);\r
  } else {\r
    //\r
    // Check the size of data object\r
    //\r
    switch (Buffer[0]) {\r
      case AML_BYTE_PREFIX:\r
        DataSize = sizeof (UINT8);\r
        break;\r
\r
      case AML_WORD_PREFIX:\r
        DataSize = sizeof (UINT16);\r
        break;\r
\r
      case AML_DWORD_PREFIX:\r
        DataSize = sizeof (UINT32);\r
        break;\r
\r
      case AML_QWORD_PREFIX:\r
        DataSize = sizeof (UINT64);\r
        break;\r
\r
      default:\r
        // The data type of the ACPI object is not an integer\r
        Status = EFI_INVALID_PARAMETER;\r
        goto Exit;\r
    }\r
\r
    Status = AcpiSdtProtocol->SetOption (DataHandle, 1, (VOID *)&Value, DataSize);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
Exit:\r
  AcpiSdtProtocol->Close (DataHandle);\r
  AcpiSdtProtocol->Close (ObjectHandle);\r
\r
  return Status;\r
}\r