ShellPkg: acpiview: MADT: Prevent buffer overruns

[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Madt / MadtParser.c

/** @file\r
  MADT table parser\r
\r
  Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Reference(s):\r
    - ACPI 6.3 Specification - January 2019\r
    - Arm Generic Interrupt Controller Architecture Specification,\r
      GIC architecture version 3 and version 4, issue E\r
    - Arm Server Base System Architecture 5.0\r
**/\r
\r
#include <IndustryStandard/Acpi.h>\r
#include <Library/UefiLib.h>\r
#include "AcpiParser.h"\r
#include "AcpiTableParser.h"\r
#include "MadtParser.h"\r
\r
// Local Variables\r
STATIC CONST UINT8* MadtInterruptControllerType;\r
STATIC CONST UINT8* MadtInterruptControllerLength;\r
STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
\r
/**\r
  This function validates the System Vector Base in the GICD.\r
\r
  @param [in] Ptr     Pointer to the start of the field data.\r
  @param [in] Context Pointer to context specific information e.g. this\r
                      could be a pointer to the ACPI table header.\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
ValidateGICDSystemVectorBase (\r
  IN UINT8* Ptr,\r
  IN VOID*  Context\r
)\r
{\r
  if (*(UINT32*)Ptr != 0) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"\nERROR: System Vector Base must be zero."\r
    );\r
  }\r
}\r
\r
/**\r
  This function validates the SPE Overflow Interrupt in the GICC.\r
\r
  @param [in] Ptr     Pointer to the start of the field data.\r
  @param [in] Context Pointer to context specific information e.g. this\r
                      could be a pointer to the ACPI table header.\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
ValidateSpeOverflowInterrupt (\r
  IN UINT8* Ptr,\r
  IN VOID*  Context\r
  )\r
{\r
  UINT16 SpeOverflowInterrupt;\r
\r
  SpeOverflowInterrupt = *(UINT16*)Ptr;\r
\r
  // SPE not supported by this processor\r
  if (SpeOverflowInterrupt == 0) {\r
    return;\r
  }\r
\r
  if ((SpeOverflowInterrupt < ARM_PPI_ID_MIN) ||\r
      ((SpeOverflowInterrupt > ARM_PPI_ID_MAX) &&\r
       (SpeOverflowInterrupt < ARM_PPI_ID_EXTENDED_MIN)) ||\r
      (SpeOverflowInterrupt > ARM_PPI_ID_EXTENDED_MAX)) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"\nERROR: SPE Overflow Interrupt ID of %d is not in the allowed PPI ID "\r
        L"ranges of %d-%d or %d-%d (for GICv3.1 or later).",\r
      SpeOverflowInterrupt,\r
      ARM_PPI_ID_MIN,\r
      ARM_PPI_ID_MAX,\r
      ARM_PPI_ID_EXTENDED_MIN,\r
      ARM_PPI_ID_EXTENDED_MAX\r
    );\r
  } else if (SpeOverflowInterrupt != ARM_PPI_ID_PMBIRQ) {\r
    IncrementWarningCount();\r
    Print (\r
      L"\nWARNING: SPE Overflow Interrupt ID of %d is not compliant with SBSA "\r
        L"Level 3 PPI ID assignment: %d.",\r
      SpeOverflowInterrupt,\r
      ARM_PPI_ID_PMBIRQ\r
    );\r
  }\r
}\r
\r
/**\r
  An ACPI_PARSER array describing the GICC Interrupt Controller Structure.\r
**/\r
STATIC CONST ACPI_PARSER GicCParser[] = {\r
  {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 2, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
\r
  {L"CPU Interface Number", 4, 4, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"ACPI Processor UID", 4, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Flags", 4, 12, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Parking Protocol Version", 4, 16, L"0x%x", NULL, NULL, NULL, NULL},\r
\r
  {L"Performance Interrupt GSIV", 4, 20, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Parked Address", 8, 24, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"Physical Base Address", 8, 32, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"GICV", 8, 40, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"GICH", 8, 48, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"VGIC Maintenance interrupt", 4, 56, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"GICR Base Address", 8, 60, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"MPIDR", 8, 68, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"Processor Power Efficiency Class", 1, 76, L"0x%x", NULL, NULL, NULL,\r
   NULL},\r
  {L"Reserved", 1, 77, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"SPE overflow Interrupt", 2, 78, L"0x%x", NULL, NULL,\r
    ValidateSpeOverflowInterrupt, NULL}\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the GICD Interrupt Controller Structure.\r
**/\r
STATIC CONST ACPI_PARSER GicDParser[] = {\r
  {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 2, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
\r
  {L"GIC ID", 4, 4, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Physical Base Address", 8, 8, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"System Vector Base", 4, 16, L"0x%x", NULL, NULL,\r
    ValidateGICDSystemVectorBase, NULL},\r
  {L"GIC Version", 1, 20, L"%d", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 3, 21, L"%x %x %x", Dump3Chars, NULL, NULL, NULL}\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the MSI Frame Interrupt Controller Structure.\r
**/\r
STATIC CONST ACPI_PARSER GicMSIFrameParser[] = {\r
  {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 2, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
\r
  {L"MSI Frame ID", 4, 4, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Physical Base Address", 8, 8, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"Flags", 4, 16, L"0x%x", NULL, NULL, NULL, NULL},\r
\r
  {L"SPI Count", 2, 20, L"%d", NULL, NULL, NULL, NULL},\r
  {L"SPI Base", 2, 22, L"0x%x", NULL, NULL, NULL, NULL}\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the GICR Interrupt Controller Structure.\r
**/\r
STATIC CONST ACPI_PARSER GicRParser[] = {\r
  {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 2, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
\r
  {L"Discovery Range Base Address", 8, 4, L"0x%lx", NULL, NULL, NULL,\r
   NULL},\r
  {L"Discovery Range Length", 4, 12, L"0x%x", NULL, NULL, NULL, NULL}\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the GIC ITS Interrupt Controller Structure.\r
**/\r
STATIC CONST ACPI_PARSER GicITSParser[] = {\r
  {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 2, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
\r
  {L"GIC ITS ID", 4, 4, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Physical Base Address", 8, 8, L"0x%lx", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 4, 16, L"0x%x", NULL, NULL, NULL, NULL}\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the ACPI MADT Table.\r
**/\r
STATIC CONST ACPI_PARSER MadtParser[] = {\r
  PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
  {L"Local Interrupt Controller Address", 4, 36, L"0x%x", NULL, NULL, NULL,\r
   NULL},\r
  {L"Flags", 4, 40, L"0x%x", NULL, NULL, NULL, NULL}\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the MADT Interrupt Controller Structure Header Structure.\r
**/\r
STATIC CONST ACPI_PARSER MadtInterruptControllerHeaderParser[] = {\r
  {NULL, 1, 0, NULL, NULL, (VOID**)&MadtInterruptControllerType, NULL, NULL},\r
  {L"Length", 1, 1, NULL, NULL, (VOID**)&MadtInterruptControllerLength, NULL,\r
   NULL},\r
  {L"Reserved", 2, 2, NULL, NULL, NULL, NULL, NULL}\r
};\r
\r
/**\r
  This function parses the ACPI MADT table.\r
  When trace is enabled this function parses the MADT table and\r
  traces the ACPI table fields.\r
\r
  This function currently parses the following Interrupt Controller\r
  Structures:\r
    - GICC\r
    - GICD\r
    - GIC MSI Frame\r
    - GICR\r
    - GIC ITS\r
\r
  This function also performs validation of the ACPI table fields.\r
\r
  @param [in] Trace              If TRUE, trace the ACPI fields.\r
  @param [in] Ptr                Pointer to the start of the buffer.\r
  @param [in] AcpiTableLength    Length of the ACPI table.\r
  @param [in] AcpiTableRevision  Revision of the ACPI table.\r
**/\r
VOID\r
EFIAPI\r
ParseAcpiMadt (\r
  IN BOOLEAN Trace,\r
  IN UINT8*  Ptr,\r
  IN UINT32  AcpiTableLength,\r
  IN UINT8   AcpiTableRevision\r
  )\r
{\r
  UINT32 Offset;\r
  UINT8* InterruptContollerPtr;\r
  UINT32 GICDCount;\r
\r
  GICDCount = 0;\r
\r
  if (!Trace) {\r
    return;\r
  }\r
\r
  Offset = ParseAcpi (\r
             TRUE,\r
             0,\r
             "MADT",\r
             Ptr,\r
             AcpiTableLength,\r
             PARSER_PARAMS (MadtParser)\r
             );\r
  InterruptContollerPtr = Ptr + Offset;\r
\r
  while (Offset < AcpiTableLength) {\r
    // Parse Interrupt Controller Structure to obtain Length.\r
    ParseAcpi (\r
      FALSE,\r
      0,\r
      NULL,\r
      InterruptContollerPtr,\r
      AcpiTableLength - Offset,\r
      PARSER_PARAMS (MadtInterruptControllerHeaderParser)\r
      );\r
\r
    // Make sure forward progress is made.\r
    if (*MadtInterruptControllerLength < 2) {\r
      IncrementErrorCount ();\r
      Print (\r
        L"ERROR: Structure length is too small: " \\r
          L"MadtInterruptControllerLength = %d. " \\r
          L"MadtInterruptControllerType = %d. MADT parsing aborted.\n",\r
        *MadtInterruptControllerLength,\r
        *MadtInterruptControllerType\r
        );\r
      return;\r
    }\r
\r
    // Make sure the MADT structure lies inside the table\r
    if ((Offset + *MadtInterruptControllerLength) > AcpiTableLength) {\r
      IncrementErrorCount ();\r
      Print (\r
        L"ERROR: Invalid MADT structure length. " \\r
          L"MadtInterruptControllerLength = %d. " \\r
          L"RemainingTableBufferLength = %d. MADT parsing aborted.\n",\r
        *MadtInterruptControllerLength,\r
        AcpiTableLength - Offset\r
        );\r
      return;\r
    }\r
\r
    switch (*MadtInterruptControllerType) {\r
      case EFI_ACPI_6_3_GIC: {\r
        ParseAcpi (\r
          TRUE,\r
          2,\r
          "GICC",\r
          InterruptContollerPtr,\r
          *MadtInterruptControllerLength,\r
          PARSER_PARAMS (GicCParser)\r
          );\r
        break;\r
      }\r
\r
      case EFI_ACPI_6_3_GICD: {\r
        if (++GICDCount > 1) {\r
          IncrementErrorCount ();\r
          Print (\r
            L"ERROR: Only one GICD must be present,"\r
              L" GICDCount = %d\n",\r
            GICDCount\r
            );\r
        }\r
        ParseAcpi (\r
          TRUE,\r
          2,\r
          "GICD",\r
          InterruptContollerPtr,\r
          *MadtInterruptControllerLength,\r
          PARSER_PARAMS (GicDParser)\r
          );\r
        break;\r
      }\r
\r
      case EFI_ACPI_6_3_GIC_MSI_FRAME: {\r
        ParseAcpi (\r
          TRUE,\r
          2,\r
          "GIC MSI Frame",\r
          InterruptContollerPtr,\r
          *MadtInterruptControllerLength,\r
          PARSER_PARAMS (GicMSIFrameParser)\r
          );\r
        break;\r
      }\r
\r
      case EFI_ACPI_6_3_GICR: {\r
        ParseAcpi (\r
          TRUE,\r
          2,\r
          "GICR",\r
          InterruptContollerPtr,\r
          *MadtInterruptControllerLength,\r
          PARSER_PARAMS (GicRParser)\r
          );\r
        break;\r
      }\r
\r
      case EFI_ACPI_6_3_GIC_ITS: {\r
        ParseAcpi (\r
          TRUE,\r
          2,\r
          "GIC ITS",\r
          InterruptContollerPtr,\r
          *MadtInterruptControllerLength,\r
          PARSER_PARAMS (GicITSParser)\r
          );\r
        break;\r
      }\r
\r
      default: {\r
        IncrementErrorCount ();\r
        Print (\r
          L"ERROR: Unknown Interrupt Controller Structure,"\r
            L" Type = %d, Length = %d\n",\r
          *MadtInterruptControllerType,\r
          *MadtInterruptControllerLength\r
          );\r
      }\r
    } // switch\r
\r
    InterruptContollerPtr += *MadtInterruptControllerLength;\r
    Offset += *MadtInterruptControllerLength;\r
  } // while\r
}\r