[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Iort / IortParser.c

/** @file\r
  IORT table parser\r
\r
  Copyright (c) 2016 - 2022, Arm Limited. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Reference(s):\r
    - IO Remapping Table, Platform Design Document, Revision E.d, Feb 2022\r
      (https://developer.arm.com/documentation/den0049/)\r
\r
  @par Glossary:\r
    - Ref  - Reference\r
    - Desc - Descriptor\r
**/\r
\r
#include <IndustryStandard/IoRemappingTable.h>\r
#include <Library/PrintLib.h>\r
#include <Library/UefiLib.h>\r
#include "AcpiParser.h"\r
#include "AcpiTableParser.h"\r
#include "AcpiViewConfig.h"\r
\r
// Local variables\r
STATIC ACPI_DESCRIPTION_HEADER_INFO  AcpiHdrInfo;\r
\r
STATIC CONST UINT32  *IortNodeCount;\r
STATIC CONST UINT32  *IortNodeOffset;\r
\r
STATIC CONST UINT8   *IortNodeType;\r
STATIC CONST UINT16  *IortNodeLength;\r
STATIC CONST UINT8   *IortNodeRevision;\r
STATIC CONST UINT32  *IortIdMappingCount;\r
STATIC CONST UINT32  *IortIdMappingOffset;\r
\r
STATIC CONST UINT32  *InterruptContextCount;\r
STATIC CONST UINT32  *InterruptContextOffset;\r
STATIC CONST UINT32  *PmuInterruptCount;\r
STATIC CONST UINT32  *PmuInterruptOffset;\r
\r
STATIC CONST UINT32  *ItsCount;\r
\r
STATIC CONST UINT32  *RmrMemDescCount;\r
STATIC CONST UINT32  *RmrMemDescOffset;\r
\r
/**\r
  This function validates the ID Mapping array count for the ITS node.\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
ValidateItsIdMappingCount (\r
  IN UINT8  *Ptr,\r
  IN VOID   *Context\r
  )\r
{\r
  if (*(UINT32 *)Ptr != 0) {\r
    IncrementErrorCount ();\r
    Print (L"\nERROR: IORT ID Mapping count must be zero.");\r
  }\r
}\r
\r
/**\r
  This function validates the ID Mapping array count for the Performance\r
  Monitoring Counter Group (PMCG) node.\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
ValidatePmcgIdMappingCount (\r
  IN UINT8  *Ptr,\r
  IN VOID   *Context\r
  )\r
{\r
  if (*(UINT32 *)Ptr > 1) {\r
    IncrementErrorCount ();\r
    Print (L"\nERROR: IORT ID Mapping count must not be greater than 1.");\r
  }\r
}\r
\r
/**\r
  This function validates the ID Mapping array offset for the ITS node.\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
ValidateItsIdArrayReference (\r
  IN UINT8  *Ptr,\r
  IN VOID   *Context\r
  )\r
{\r
  if (*(UINT32 *)Ptr != 0) {\r
    IncrementErrorCount ();\r
    Print (L"\nERROR: IORT ID Mapping offset must be zero.");\r
  }\r
}\r
\r
/**\r
  This function validates that the Physical Range address or length is not zero\r
  and is 64K aligned.\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
ValidatePhysicalRange (\r
  IN UINT8  *Ptr,\r
  IN VOID   *Context\r
  )\r
{\r
  UINT64  Value;\r
\r
  Value = *(UINT64 *)Ptr;\r
  if ((Value == 0) || ((Value & (SIZE_64KB - 1)) != 0)) {\r
    IncrementErrorCount ();\r
    Print (L"\nERROR: Physical Range must be 64K aligned and cannot be zero.");\r
  }\r
}\r
\r
/**\r
  This function validates that the RMR memory range descriptor count.\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
ValidateRmrMemDescCount (\r
  IN UINT8  *Ptr,\r
  IN VOID   *Context\r
  )\r
{\r
  if (*(UINT32 *)Ptr == 0) {\r
    IncrementErrorCount ();\r
    Print (L"\nERROR: Memory Range Descriptor count must be >=1.");\r
  }\r
}\r
\r
/**\r
  Helper Macro for populating the IORT Node header in the ACPI_PARSER array.\r
\r
  @param [out] ValidateIdMappingCount    Optional pointer to a function for\r
                                         validating the ID Mapping count.\r
  @param [out] ValidateIdArrayReference  Optional pointer to a function for\r
                                         validating the ID Array reference.\r
**/\r
#define PARSE_IORT_NODE_HEADER(ValidateIdMappingCount,                        \\r
                               ValidateIdArrayReference)                      \\r
  { L"Type", 1, 0, L"%d", NULL, (VOID**)&IortNodeType, NULL, NULL },          \\r
  { L"Length", 2, 1, L"%d", NULL, (VOID**)&IortNodeLength, NULL, NULL },      \\r
  { L"Revision", 1, 3, L"%d", NULL, (VOID**)&IortNodeRevision, NULL, NULL },  \\r
  { L"Identifier", 4, 4, L"0x%x", NULL, NULL, NULL, NULL },                   \\r
  { L"Number of ID mappings", 4, 8, L"%d", NULL,                              \\r
    (VOID**)&IortIdMappingCount, ValidateIdMappingCount, NULL },              \\r
  { L"Reference to ID Array", 4, 12, L"0x%x", NULL,                           \\r
    (VOID**)&IortIdMappingOffset, ValidateIdArrayReference, NULL }\r
\r
/**\r
  An ACPI_PARSER array describing the ACPI IORT Table\r
**/\r
STATIC CONST ACPI_PARSER  IortParser[] = {\r
  PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
  { L"Number of IORT Nodes",       4,     36, L"%d",   NULL,\r
    (VOID **)&IortNodeCount,       NULL,  NULL },\r
  { L"Offset to Array of IORT Nodes",4,     40, L"0x%x", NULL,\r
    (VOID **)&IortNodeOffset,      NULL,  NULL },\r
  { L"Reserved",                   4,     44, L"0x%x", NULL,NULL,NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT node header structure.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeHeaderParser[] = {\r
  PARSE_IORT_NODE_HEADER (NULL, NULL)\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT SMMUv1/2 node.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeSmmuV1V2Parser[] = {\r
  PARSE_IORT_NODE_HEADER (NULL,       NULL),\r
  { L"Base Address",                  8,    16,  L"0x%lx", NULL, NULL, NULL, NULL },\r
  { L"Span",                          8,    24,  L"0x%lx", NULL, NULL, NULL, NULL },\r
  { L"Model",                         4,    32,  L"%d",    NULL, NULL, NULL, NULL },\r
  { L"Flags",                         4,    36,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Global Interrupt Array Ref",    4,    40,  L"0x%x",  NULL, NULL, NULL,\r
    NULL },\r
  { L"Number of context interrupts",  4,    44,  L"%d",    NULL,\r
    (VOID **)&InterruptContextCount,  NULL, NULL },\r
  { L"Context Interrupt Array Ref",   4,    48,  L"0x%x",  NULL,\r
    (VOID **)&InterruptContextOffset, NULL, NULL },\r
  { L"Number of PMU Interrupts",      4,    52,  L"%d",    NULL,\r
    (VOID **)&PmuInterruptCount,      NULL, NULL },\r
  { L"PMU Interrupt Array Ref",       4,    56,  L"0x%x",  NULL,\r
    (VOID **)&PmuInterruptOffset,     NULL, NULL },\r
\r
  // Interrupt Array\r
  { L"SMMU_NSgIrpt",                  4,    60,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"SMMU_NSgIrpt interrupt flags",  4,    64,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"SMMU_NSgCfgIrpt",               4,    68,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"SMMU_NSgCfgIrpt interrupt flags",4,    72,  L"0x%x",  NULL, NULL, NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the SMMUv1/2 Node Interrupt Array.\r
**/\r
STATIC CONST ACPI_PARSER  InterruptArrayParser[] = {\r
  { L"Interrupt GSIV", 4, 0, L"0x%x", NULL, NULL, NULL, NULL },\r
  { L"Flags",          4, 4, L"0x%x", NULL, NULL, NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT ID Mapping.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeIdMappingParser[] = {\r
  { L"Input base",       4, 0,  L"0x%x", NULL, NULL, NULL, NULL },\r
  { L"Number of IDs",    4, 4,  L"0x%x", NULL, NULL, NULL, NULL },\r
  { L"Output base",      4, 8,  L"0x%x", NULL, NULL, NULL, NULL },\r
  { L"Output reference", 4, 12, L"0x%x", NULL, NULL, NULL, NULL },\r
  { L"Flags",            4, 16, L"0x%x", NULL, NULL, NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT SMMUv3 node.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeSmmuV3Parser[] = {\r
  PARSE_IORT_NODE_HEADER (NULL, NULL),\r
  { L"Base Address",            8,    16,  L"0x%lx", NULL, NULL, NULL, NULL },\r
  { L"Flags",                   4,    24,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Reserved",                4,    28,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"VATOS Address",           8,    32,  L"0x%lx", NULL, NULL, NULL, NULL },\r
  { L"Model",                   4,    40,  L"%d",    NULL, NULL, NULL, NULL },\r
  { L"Event",                   4,    44,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"PRI",                     4,    48,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"GERR",                    4,    52,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Sync",                    4,    56,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Proximity domain",        4,    60,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Device ID mapping index", 4,    64,  L"%d",    NULL, NULL, NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT ITS node.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeItsParser[] = {\r
  PARSE_IORT_NODE_HEADER (\r
    ValidateItsIdMappingCount,\r
    ValidateItsIdArrayReference\r
    ),\r
  { L"Number of ITSs",        4,16, L"%d", NULL, (VOID **)&ItsCount, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the ITS ID.\r
**/\r
STATIC CONST ACPI_PARSER  ItsIdParser[] = {\r
  { L"GIC ITS Identifier", 4, 0, L"%d", NULL, NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT Names Component node.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeNamedComponentParser[] = {\r
  PARSE_IORT_NODE_HEADER (NULL, NULL),\r
  { L"Node Flags",              4,    16,  L"%d",    NULL, NULL, NULL, NULL },\r
  { L"Memory access properties",8,    20,  L"0x%lx", NULL, NULL, NULL, NULL },\r
  { L"Device memory address size limit",1,    28,  L"%d",    NULL, NULL, NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT Root Complex node.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeRootComplexParser[] = {\r
  PARSE_IORT_NODE_HEADER (NULL, NULL),\r
  { L"Memory access properties",8,    16,  L"0x%lx", NULL, NULL, NULL, NULL },\r
  { L"ATS Attribute",           4,    24,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"PCI Segment number",      4,    28,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Memory access size limit",1,    32,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"PASID capabilities",      2,    33,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Reserved",                1,    35,  L"%x",    NULL, NULL, NULL, NULL },\r
  { L"Flags",                   4,    36,  L"0x%x",  NULL, NULL, NULL, NULL },\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT PMCG node.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodePmcgParser[] = {\r
  PARSE_IORT_NODE_HEADER (ValidatePmcgIdMappingCount, NULL),\r
  { L"Page 0 Base Address",                           8,    16,  L"0x%lx", NULL, NULL, NULL, NULL },\r
  { L"Overflow interrupt GSIV",                       4,    24,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Node reference",                                4,    28,  L"0x%x",  NULL, NULL, NULL, NULL },\r
  { L"Page 1 Base Address",                           8,    32,  L"0x%lx", NULL, NULL, NULL, NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT RMR node.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeRmrParser[] = {\r
  PARSE_IORT_NODE_HEADER (NULL, NULL),\r
  { L"Flags",                   4,                      16,  L"0x%x", NULL, NULL, NULL, NULL },\r
  { L"Memory Range Desc count", 4,                      20,  L"%d",   NULL,\r
    (VOID **)&RmrMemDescCount,  ValidateRmrMemDescCount,NULL },\r
  { L"Memory Range Desc Ref",   4,                      24,  L"0x%x", NULL,\r
    (VOID **)&RmrMemDescOffset, NULL,                   NULL }\r
};\r
\r
/**\r
  An ACPI_PARSER array describing the IORT RMR Memory Range Descriptor.\r
**/\r
STATIC CONST ACPI_PARSER  IortNodeRmrMemRangeDescParser[] = {\r
  { L"Physical Range offset", 8, 0,  L"0x%lx", NULL, NULL, ValidatePhysicalRange,\r
    NULL },\r
  { L"Physical Range length", 8, 8,  L"0x%lx", NULL, NULL, ValidatePhysicalRange,\r
    NULL },\r
  { L"Reserved",              4, 16, L"0x%x",  NULL, NULL, NULL,                 NULL}\r
};\r
\r
/**\r
  This function parses the IORT Node Id Mapping array.\r
\r
  @param [in] Ptr            Pointer to the start of the ID mapping array.\r
  @param [in] Length         Length of the buffer.\r
  @param [in] MappingCount   The ID Mapping count.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeIdMappings (\r
  IN UINT8   *Ptr,\r
  IN UINT32  Length,\r
  IN UINT32  MappingCount\r
  )\r
{\r
  UINT32  Index;\r
  UINT32  Offset;\r
  CHAR8   Buffer[40]; // Used for AsciiName param of ParseAcpi\r
\r
  Index  = 0;\r
  Offset = 0;\r
\r
  while ((Index < MappingCount) &&\r
         (Offset < Length))\r
  {\r
    AsciiSPrint (\r
      Buffer,\r
      sizeof (Buffer),\r
      "ID Mapping [%d]",\r
      Index\r
      );\r
    Offset += ParseAcpi (\r
                TRUE,\r
                4,\r
                Buffer,\r
                Ptr + Offset,\r
                Length - Offset,\r
                PARSER_PARAMS (IortNodeIdMappingParser)\r
                );\r
    Index++;\r
  }\r
}\r
\r
/**\r
  This function parses the IORT SMMUv1/2 node.\r
\r
  @param [in] Ptr            Pointer to the start of the buffer.\r
  @param [in] Length         Length of the buffer.\r
  @param [in] MappingCount   The ID Mapping count.\r
  @param [in] MappingOffset  The offset of the ID Mapping array\r
                             from the start of the IORT table.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeSmmuV1V2 (\r
  IN UINT8   *Ptr,\r
  IN UINT16  Length,\r
  IN UINT32  MappingCount,\r
  IN UINT32  MappingOffset\r
  )\r
{\r
  UINT32  Index;\r
  UINT32  Offset;\r
  CHAR8   Buffer[50]; // Used for AsciiName param of ParseAcpi\r
\r
  ParseAcpi (\r
    TRUE,\r
    2,\r
    "SMMUv1 or SMMUv2 Node",\r
    Ptr,\r
    Length,\r
    PARSER_PARAMS (IortNodeSmmuV1V2Parser)\r
    );\r
\r
  // Check if the values used to control the parsing logic have been\r
  // successfully read.\r
  if ((InterruptContextCount == NULL)   ||\r
      (InterruptContextOffset == NULL)  ||\r
      (PmuInterruptCount == NULL)       ||\r
      (PmuInterruptOffset == NULL))\r
  {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: Insufficient SMMUv1/2 node length. Length = %d\n",\r
      Length\r
      );\r
    return;\r
  }\r
\r
  Offset = *InterruptContextOffset;\r
  Index  = 0;\r
\r
  while ((Index < *InterruptContextCount) &&\r
         (Offset < Length))\r
  {\r
    AsciiSPrint (\r
      Buffer,\r
      sizeof (Buffer),\r
      "Context Interrupts Array [%d]",\r
      Index\r
      );\r
    Offset += ParseAcpi (\r
                TRUE,\r
                4,\r
                Buffer,\r
                Ptr + Offset,\r
                Length - Offset,\r
                PARSER_PARAMS (InterruptArrayParser)\r
                );\r
    Index++;\r
  }\r
\r
  Offset = *PmuInterruptOffset;\r
  Index  = 0;\r
\r
  while ((Index < *PmuInterruptCount) &&\r
         (Offset < Length))\r
  {\r
    AsciiSPrint (\r
      Buffer,\r
      sizeof (Buffer),\r
      "PMU Interrupts Array [%d]",\r
      Index\r
      );\r
    Offset += ParseAcpi (\r
                TRUE,\r
                4,\r
                Buffer,\r
                Ptr + Offset,\r
                Length - Offset,\r
                PARSER_PARAMS (InterruptArrayParser)\r
                );\r
    Index++;\r
  }\r
\r
  DumpIortNodeIdMappings (\r
    Ptr + MappingOffset,\r
    Length - MappingOffset,\r
    MappingCount\r
    );\r
}\r
\r
/**\r
  This function parses the IORT SMMUv3 node.\r
\r
  @param [in] Ptr            Pointer to the start of the buffer.\r
  @param [in] Length         Length of the buffer.\r
  @param [in] MappingCount   The ID Mapping count.\r
  @param [in] MappingOffset  The offset of the ID Mapping array\r
                             from the start of the IORT table.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeSmmuV3 (\r
  IN UINT8   *Ptr,\r
  IN UINT16  Length,\r
  IN UINT32  MappingCount,\r
  IN UINT32  MappingOffset\r
  )\r
{\r
  ParseAcpi (\r
    TRUE,\r
    2,\r
    "SMMUV3 Node",\r
    Ptr,\r
    Length,\r
    PARSER_PARAMS (IortNodeSmmuV3Parser)\r
    );\r
\r
  DumpIortNodeIdMappings (\r
    Ptr + MappingOffset,\r
    Length - MappingOffset,\r
    MappingCount\r
    );\r
}\r
\r
/**\r
  This function parses the IORT ITS node.\r
\r
  @param [in] Ptr            Pointer to the start of the buffer.\r
  @param [in] Length         Length of the buffer.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeIts (\r
  IN UINT8   *Ptr,\r
  IN UINT16  Length\r
  )\r
{\r
  UINT32  Offset;\r
  UINT32  Index;\r
  CHAR8   Buffer[80]; // Used for AsciiName param of ParseAcpi\r
\r
  Offset = ParseAcpi (\r
             TRUE,\r
             2,\r
             "ITS Node",\r
             Ptr,\r
             Length,\r
             PARSER_PARAMS (IortNodeItsParser)\r
             );\r
\r
  // Check if the values used to control the parsing logic have been\r
  // successfully read.\r
  if (ItsCount == NULL) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: Insufficient ITS group length. Length = %d.\n",\r
      Length\r
      );\r
    return;\r
  }\r
\r
  Index = 0;\r
\r
  while ((Index < *ItsCount) &&\r
         (Offset < Length))\r
  {\r
    AsciiSPrint (\r
      Buffer,\r
      sizeof (Buffer),\r
      "GIC ITS Identifier Array [%d]",\r
      Index\r
      );\r
    Offset += ParseAcpi (\r
                TRUE,\r
                4,\r
                Buffer,\r
                Ptr + Offset,\r
                Length - Offset,\r
                PARSER_PARAMS (ItsIdParser)\r
                );\r
    Index++;\r
  }\r
\r
  // Note: ITS does not have the ID Mappings Array\r
}\r
\r
/**\r
  This function parses the IORT Named Component node.\r
\r
  @param [in] Ptr            Pointer to the start of the buffer.\r
  @param [in] Length         Length of the buffer.\r
  @param [in] MappingCount   The ID Mapping count.\r
  @param [in] MappingOffset  The offset of the ID Mapping array\r
                             from the start of the IORT table.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeNamedComponent (\r
  IN UINT8   *Ptr,\r
  IN UINT16  Length,\r
  IN UINT32  MappingCount,\r
  IN UINT32  MappingOffset\r
  )\r
{\r
  UINT32  Offset;\r
\r
  Offset = ParseAcpi (\r
             TRUE,\r
             2,\r
             "Named Component Node",\r
             Ptr,\r
             Length,\r
             PARSER_PARAMS (IortNodeNamedComponentParser)\r
             );\r
\r
  // Estimate the Device Name length\r
  PrintFieldName (2, L"Device Object Name");\r
\r
  while ((*(Ptr + Offset) != 0) &&\r
         (Offset < Length))\r
  {\r
    Print (L"%c", *(Ptr + Offset));\r
    Offset++;\r
  }\r
\r
  Print (L"\n");\r
\r
  DumpIortNodeIdMappings (\r
    Ptr + MappingOffset,\r
    Length - MappingOffset,\r
    MappingCount\r
    );\r
}\r
\r
/**\r
  This function parses the IORT Root Complex node.\r
\r
  @param [in] Ptr            Pointer to the start of the buffer.\r
  @param [in] Length         Length of the buffer.\r
  @param [in] MappingCount   The ID Mapping count.\r
  @param [in] MappingOffset  The offset of the ID Mapping array\r
                             from the start of the IORT table.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeRootComplex (\r
  IN UINT8   *Ptr,\r
  IN UINT16  Length,\r
  IN UINT32  MappingCount,\r
  IN UINT32  MappingOffset\r
  )\r
{\r
  ParseAcpi (\r
    TRUE,\r
    2,\r
    "Root Complex Node",\r
    Ptr,\r
    Length,\r
    PARSER_PARAMS (IortNodeRootComplexParser)\r
    );\r
\r
  DumpIortNodeIdMappings (\r
    Ptr + MappingOffset,\r
    Length - MappingOffset,\r
    MappingCount\r
    );\r
}\r
\r
/**\r
  This function parses the IORT PMCG node.\r
\r
  @param [in] Ptr            Pointer to the start of the buffer.\r
  @param [in] Length         Length of the buffer.\r
  @param [in] MappingCount   The ID Mapping count.\r
  @param [in] MappingOffset  The offset of the ID Mapping array\r
                             from the start of the IORT table.\r
**/\r
STATIC\r
VOID\r
DumpIortNodePmcg (\r
  IN UINT8   *Ptr,\r
  IN UINT16  Length,\r
  IN UINT32  MappingCount,\r
  IN UINT32  MappingOffset\r
  )\r
{\r
  ParseAcpi (\r
    TRUE,\r
    2,\r
    "PMCG Node",\r
    Ptr,\r
    Length,\r
    PARSER_PARAMS (IortNodePmcgParser)\r
    );\r
\r
  DumpIortNodeIdMappings (\r
    Ptr + MappingOffset,\r
    Length - MappingOffset,\r
    MappingCount\r
    );\r
}\r
\r
/**\r
  This function parses the IORT RMR Node Memory Range Descriptor array.\r
\r
  @param [in] Ptr         Pointer to the start of the Memory Range Descriptor\r
                          array.\r
  @param [in] Length      Length of the buffer.\r
  @param [in] DescCount   Memory Range Descriptor count.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeRmrMemRangeDesc (\r
  IN UINT8   *Ptr,\r
  IN UINT32  Length,\r
  IN UINT32  DescCount\r
  )\r
{\r
  UINT32  Index;\r
  UINT32  Offset;\r
  CHAR8   Buffer[40]; // Used for AsciiName param of ParseAcpi\r
\r
  Index  = 0;\r
  Offset = 0;\r
\r
  while ((Index < DescCount) &&\r
         (Offset < Length))\r
  {\r
    AsciiSPrint (\r
      Buffer,\r
      sizeof (Buffer),\r
      "Mem range Descriptor [%d]",\r
      Index\r
      );\r
    Offset += ParseAcpi (\r
                TRUE,\r
                4,\r
                Buffer,\r
                Ptr + Offset,\r
                Length - Offset,\r
                PARSER_PARAMS (IortNodeRmrMemRangeDescParser)\r
                );\r
    Index++;\r
  }\r
}\r
\r
/**\r
  This function parses the IORT RMR node.\r
\r
  @param [in] Ptr            Pointer to the start of the buffer.\r
  @param [in] Length         Length of the buffer.\r
  @param [in] MappingCount   The ID Mapping count.\r
  @param [in] MappingOffset  The offset of the ID Mapping array\r
                             from the start of the IORT table.\r
**/\r
STATIC\r
VOID\r
DumpIortNodeRmr (\r
  IN UINT8   *Ptr,\r
  IN UINT16  Length,\r
  IN UINT32  MappingCount,\r
  IN UINT32  MappingOffset\r
  )\r
{\r
  ParseAcpi (\r
    TRUE,\r
    2,\r
    "RMR Node",\r
    Ptr,\r
    Length,\r
    PARSER_PARAMS (IortNodeRmrParser)\r
    );\r
\r
  if (*IortNodeRevision == EFI_ACPI_IORT_RMR_NODE_REVISION_02) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: RMR node Rev 2 (defined in IORT Rev E.c) must not be used."\r
      L" IORT tabe Revision E.c is deprecated and must not be used.\n"\r
      );\r
  }\r
\r
  DumpIortNodeIdMappings (\r
    Ptr + MappingOffset,\r
    Length - MappingOffset,\r
    MappingCount\r
    );\r
\r
  DumpIortNodeRmrMemRangeDesc (\r
    Ptr + (*RmrMemDescOffset),\r
    Length - (*RmrMemDescOffset),\r
    *RmrMemDescCount\r
    );\r
}\r
\r
/**\r
  This function parses the ACPI IORT table.\r
  When trace is enabled this function parses the IORT table and traces the ACPI\r
  fields.\r
\r
  This function also parses the following nodes:\r
    - ITS Group\r
    - Named Component\r
    - Root Complex\r
    - SMMUv1/2\r
    - SMMUv3\r
    - PMCG\r
    - RMR\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
ParseAcpiIort (\r
  IN BOOLEAN  Trace,\r
  IN UINT8    *Ptr,\r
  IN UINT32   AcpiTableLength,\r
  IN UINT8    AcpiTableRevision\r
  )\r
{\r
  UINT32  Offset;\r
  UINT32  Index;\r
  UINT8   *NodePtr;\r
\r
  if (!Trace) {\r
    return;\r
  }\r
\r
  if ((AcpiTableRevision > EFI_ACPI_IO_REMAPPING_TABLE_REVISION_00) &&\r
      (AcpiTableRevision < EFI_ACPI_IO_REMAPPING_TABLE_REVISION_05))\r
  {\r
    Print (\r
      L"ERROR: Parsing not supported for IORT tabe Revision E, E.<a,b,c>.\n"\r
      );\r
    if (AcpiTableRevision == EFI_ACPI_IO_REMAPPING_TABLE_REVISION_04) {\r
      IncrementErrorCount ();\r
      Print (\r
        L"ERROR: IORT tabe Revision E.c is deprecated and must not be used.\n"\r
        );\r
    }\r
\r
    return;\r
  }\r
\r
  ParseAcpi (\r
    TRUE,\r
    0,\r
    "IORT",\r
    Ptr,\r
    AcpiTableLength,\r
    PARSER_PARAMS (IortParser)\r
    );\r
\r
  // Check if the values used to control the parsing logic have been\r
  // successfully read.\r
  if ((IortNodeCount == NULL) ||\r
      (IortNodeOffset == NULL))\r
  {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: Insufficient table length. AcpiTableLength = %d.\n",\r
      AcpiTableLength\r
      );\r
    return;\r
  }\r
\r
  Offset  = *IortNodeOffset;\r
  NodePtr = Ptr + Offset;\r
  Index   = 0;\r
\r
  // Parse the specified number of IORT nodes or the IORT table buffer length.\r
  // Whichever is minimum.\r
  while ((Index++ < *IortNodeCount) &&\r
         (Offset < AcpiTableLength))\r
  {\r
    // Parse the IORT Node Header\r
    ParseAcpi (\r
      FALSE,\r
      0,\r
      "IORT Node Header",\r
      NodePtr,\r
      AcpiTableLength - Offset,\r
      PARSER_PARAMS (IortNodeHeaderParser)\r
      );\r
\r
    // Check if the values used to control the parsing logic have been\r
    // successfully read.\r
    if ((IortNodeType == NULL)        ||\r
        (IortNodeLength == NULL)      ||\r
        (IortIdMappingCount == NULL)  ||\r
        (IortIdMappingOffset == NULL))\r
    {\r
      IncrementErrorCount ();\r
      Print (\r
        L"ERROR: Insufficient remaining table buffer length to read the " \\r
        L"IORT node header. Length = %d.\n",\r
        AcpiTableLength - Offset\r
        );\r
      return;\r
    }\r
\r
    // Validate IORT Node length\r
    if ((*IortNodeLength == 0) ||\r
        ((Offset + (*IortNodeLength)) > AcpiTableLength))\r
    {\r
      IncrementErrorCount ();\r
      Print (\r
        L"ERROR: Invalid IORT Node length. " \\r
        L"Length = %d. Offset = %d. AcpiTableLength = %d.\n",\r
        *IortNodeLength,\r
        Offset,\r
        AcpiTableLength\r
        );\r
      return;\r
    }\r
\r
    PrintFieldName (2, L"* Node Offset *");\r
    Print (L"0x%x\n", Offset);\r
\r
    switch (*IortNodeType) {\r
      case EFI_ACPI_IORT_TYPE_ITS_GROUP:\r
        DumpIortNodeIts (\r
          NodePtr,\r
          *IortNodeLength\r
          );\r
        break;\r
      case EFI_ACPI_IORT_TYPE_NAMED_COMP:\r
        DumpIortNodeNamedComponent (\r
          NodePtr,\r
          *IortNodeLength,\r
          *IortIdMappingCount,\r
          *IortIdMappingOffset\r
          );\r
        break;\r
      case EFI_ACPI_IORT_TYPE_ROOT_COMPLEX:\r
        DumpIortNodeRootComplex (\r
          NodePtr,\r
          *IortNodeLength,\r
          *IortIdMappingCount,\r
          *IortIdMappingOffset\r
          );\r
        break;\r
      case EFI_ACPI_IORT_TYPE_SMMUv1v2:\r
        DumpIortNodeSmmuV1V2 (\r
          NodePtr,\r
          *IortNodeLength,\r
          *IortIdMappingCount,\r
          *IortIdMappingOffset\r
          );\r
        break;\r
      case EFI_ACPI_IORT_TYPE_SMMUv3:\r
        DumpIortNodeSmmuV3 (\r
          NodePtr,\r
          *IortNodeLength,\r
          *IortIdMappingCount,\r
          *IortIdMappingOffset\r
          );\r
        break;\r
      case EFI_ACPI_IORT_TYPE_PMCG:\r
        DumpIortNodePmcg (\r
          NodePtr,\r
          *IortNodeLength,\r
          *IortIdMappingCount,\r
          *IortIdMappingOffset\r
          );\r
        break;\r
      case EFI_ACPI_IORT_TYPE_RMR:\r
        DumpIortNodeRmr (\r
          NodePtr,\r
          *IortNodeLength,\r
          *IortIdMappingCount,\r
          *IortIdMappingOffset\r
          );\r
        break;\r
      default:\r
        IncrementErrorCount ();\r
        Print (L"ERROR: Unsupported IORT Node type = %d\n", *IortNodeType);\r
    } // switch\r
\r
    NodePtr += (*IortNodeLength);\r
    Offset  += (*IortNodeLength);\r
  } // while\r
}\r