[mirror_edk2.git] / DynamicTablesPkg / Library / Acpi / Arm / AcpiSsdtPcieLibArm / SsdtPcieGenerator.c

/** @file\r
  SSDT Pcie Table Generator.\r
\r
  Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Reference(s):\r
  - PCI Firmware Specification - Revision 3.0\r
  - ACPI 6.4 specification:\r
   - s6.2.13 "_PRT (PCI Routing Table)"\r
   - s6.1.1 "_ADR (Address)"\r
  - linux kernel code\r
  - Arm Base Boot Requirements v1.0\r
  - Arm Base System Architecture v1.0\r
**/\r
\r
#include <Library/AcpiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Protocol/AcpiTable.h>\r
\r
// Module specific include files.\r
#include <AcpiTableGenerator.h>\r
#include <ConfigurationManagerObject.h>\r
#include <ConfigurationManagerHelper.h>\r
#include <Library/AcpiHelperLib.h>\r
#include <Library/TableHelperLib.h>\r
#include <Library/AmlLib/AmlLib.h>\r
#include <Protocol/ConfigurationManagerProtocol.h>\r
\r
#include "SsdtPcieGenerator.h"\r
\r
/** ARM standard SSDT Pcie Table Generator.\r
\r
Requirements:\r
  The following Configuration Manager Object(s) are required by\r
  this Generator:\r
  - EArmObjCmRef\r
  - EArmObjPciConfigSpaceInfo\r
  - EArmObjPciAddressMapInfo\r
  - EArmObjPciInterruptMapInfo\r
*/\r
\r
/** This macro expands to a function that retrieves the cross-CM-object-\r
    reference information from the Configuration Manager.\r
*/\r
GET_OBJECT_LIST (\r
  EObjNameSpaceArm,\r
  EArmObjCmRef,\r
  CM_ARM_OBJ_REF\r
  );\r
\r
/** This macro expands to a function that retrieves the Pci\r
    Configuration Space Information from the Configuration Manager.\r
*/\r
GET_OBJECT_LIST (\r
  EObjNameSpaceArm,\r
  EArmObjPciConfigSpaceInfo,\r
  CM_ARM_PCI_CONFIG_SPACE_INFO\r
  );\r
\r
/** This macro expands to a function that retrieves the Pci\r
    Address Mapping Information from the Configuration Manager.\r
*/\r
GET_OBJECT_LIST (\r
  EObjNameSpaceArm,\r
  EArmObjPciAddressMapInfo,\r
  CM_ARM_PCI_ADDRESS_MAP_INFO\r
  );\r
\r
/** This macro expands to a function that retrieves the Pci\r
    Interrupt Mapping Information from the Configuration Manager.\r
*/\r
GET_OBJECT_LIST (\r
  EObjNameSpaceArm,\r
  EArmObjPciInterruptMapInfo,\r
  CM_ARM_PCI_INTERRUPT_MAP_INFO\r
  );\r
\r
/** Initialize the MappingTable.\r
\r
  @param [in] MappingTable  The mapping table structure.\r
  @param [in] Count         Number of entries to allocate in the\r
                            MappingTable.\r
\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_INVALID_PARAMETER  Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
MappingTableInitialize (\r
  IN  MAPPING_TABLE  *MappingTable,\r
  IN  UINT32         Count\r
  )\r
{\r
  UINT32  *Table;\r
\r
  if ((MappingTable == NULL)  ||\r
      (Count == 0))\r
  {\r
    ASSERT (0);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Table = AllocateZeroPool (sizeof (*Table) * Count);\r
  if (Table == NULL) {\r
    ASSERT (0);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  MappingTable->Table     = Table;\r
  MappingTable->LastIndex = 0;\r
  MappingTable->MaxIndex  = Count;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Free the MappingTable.\r
\r
  @param [in, out]  MappingTable  The mapping table structure.\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
MappingTableFree (\r
  IN  OUT MAPPING_TABLE  *MappingTable\r
  )\r
{\r
  ASSERT (MappingTable != NULL);\r
  ASSERT (MappingTable->Table != NULL);\r
\r
  if (MappingTable->Table != NULL) {\r
    FreePool (MappingTable->Table);\r
  }\r
}\r
\r
/** Add a new entry to the MappingTable and return its index.\r
\r
  If an entry with [Integer] is already available in the table,\r
  return its index without adding a new entry.\r
\r
  @param [in] MappingTable  The mapping table structure.\r
  @param [in] Integer       New Integer entry to add.\r
\r
  @retval The index of the Integer entry in the MappingTable.\r
**/\r
STATIC\r
UINT32\r
EFIAPI\r
MappingTableAdd (\r
  IN  MAPPING_TABLE  *MappingTable,\r
  IN  UINT32         Integer\r
  )\r
{\r
  UINT32  *Table;\r
  UINT32  Index;\r
  UINT32  LastIndex;\r
\r
  ASSERT (MappingTable != NULL);\r
  ASSERT (MappingTable->Table != NULL);\r
\r
  Table     = MappingTable->Table;\r
  LastIndex = MappingTable->LastIndex;\r
\r
  // Search if there is already an entry with this Integer.\r
  for (Index = 0; Index < LastIndex; Index++) {\r
    if (Table[Index] == Integer) {\r
      return Index;\r
    }\r
  }\r
\r
  ASSERT (LastIndex < MappingTable->MaxIndex);\r
\r
  // If no, create a new entry.\r
  Table[LastIndex] = Integer;\r
\r
  return MappingTable->LastIndex++;\r
}\r
\r
/** Generate required Pci device information.\r
\r
  ASL code:\r
    Name (_UID, <Uid>)                // Uid of the Pci device\r
    Name (_HID, EISAID ("PNP0A08"))   // PCI Express Root Bridge\r
    Name (_CID, EISAID ("PNP0A03"))   // Compatible PCI Root Bridge\r
    Name (_SEG, <Pci segment group>)  // PCI Segment Group number\r
    Name (_BBN, <Bus number>)         // PCI Base Bus Number\r
    Name (_CCA, 1)                    // Initially mark the PCI coherent\r
\r
  @param [in]       PciInfo         Pci device information.\r
  @param [in]       Uid             Unique Id of the Pci device.\r
  @param [in, out]  PciNode         Pci node to amend.\r
\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_INVALID_PARAMETER  Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GeneratePciDeviceInfo (\r
  IN      CONST CM_ARM_PCI_CONFIG_SPACE_INFO  *PciInfo,\r
  IN            UINT32                        Uid,\r
  IN  OUT       AML_OBJECT_NODE_HANDLE        PciNode\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT32      EisaId;\r
\r
  ASSERT (PciInfo != NULL);\r
  ASSERT (PciNode != NULL);\r
\r
  // ASL: Name (_UID, <Uid>)\r
  Status = AmlCodeGenNameInteger ("_UID", Uid, PciNode, NULL);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // ASL: Name (_HID, EISAID ("PNP0A08"))\r
  Status = AmlGetEisaIdFromString ("PNP0A08", &EisaId);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  Status = AmlCodeGenNameInteger ("_HID", EisaId, PciNode, NULL);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // ASL: Name (_CID, EISAID ("PNP0A03"))\r
  Status = AmlGetEisaIdFromString ("PNP0A03", &EisaId);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  Status = AmlCodeGenNameInteger ("_CID", EisaId, PciNode, NULL);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // ASL: Name (_SEG, <Pci segment group>)\r
  Status = AmlCodeGenNameInteger (\r
             "_SEG",\r
             PciInfo->PciSegmentGroupNumber,\r
             PciNode,\r
             NULL\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // ASL: Name (_BBN, <Bus number>)\r
  Status = AmlCodeGenNameInteger (\r
             "_BBN",\r
             PciInfo->StartBusNumber,\r
             PciNode,\r
             NULL\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // ASL: Name (_CCA, 1)\r
  // Must be aligned with the IORT CCA property in\r
  // "Table 14 Memory access properties"\r
  Status = AmlCodeGenNameInteger ("_CCA", 1, PciNode, NULL);\r
  ASSERT_EFI_ERROR (Status);\r
  return Status;\r
}\r
\r
/** Generate Pci slots devices.\r
\r
  PCI Firmware Specification - Revision 3.3,\r
  s4.8 "Generic ACPI PCI Slot Description" requests to describe the PCI slot\r
  used. It should be possible to enumerate them, but this is additional\r
  information.\r
\r
  @param [in]  MappingTable  The mapping table structure.\r
  @param [in, out]  PciNode     Pci node to amend.\r
\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_INVALID_PARAMETER  Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GeneratePciSlots (\r
  IN      CONST MAPPING_TABLE           *MappingTable,\r
  IN  OUT       AML_OBJECT_NODE_HANDLE  PciNode\r
  )\r
{\r
  EFI_STATUS              Status;\r
  UINT32                  Index;\r
  UINT32                  LastIndex;\r
  UINT32                  DeviceId;\r
  CHAR8                   AslName[AML_NAME_SEG_SIZE + 1];\r
  AML_OBJECT_NODE_HANDLE  DeviceNode;\r
\r
  ASSERT (MappingTable != NULL);\r
  ASSERT (PciNode != NULL);\r
\r
  // Generic device name is "Dxx".\r
  CopyMem (AslName, "Dxx_", AML_NAME_SEG_SIZE + 1);\r
\r
  LastIndex = MappingTable->LastIndex;\r
\r
  // There are at most 32 devices on a Pci bus.\r
  if (LastIndex >= 32) {\r
    ASSERT (0);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  for (Index = 0; Index < LastIndex; Index++) {\r
    DeviceId                       = MappingTable->Table[Index];\r
    AslName[AML_NAME_SEG_SIZE - 3] = AsciiFromHex (DeviceId & 0xF);\r
    AslName[AML_NAME_SEG_SIZE - 2] = AsciiFromHex ((DeviceId >> 4) & 0xF);\r
\r
    // ASL:\r
    // Device (Dxx) {\r
    //   Name (_ADR, <address value>)\r
    // }\r
    Status = AmlCodeGenDevice (AslName, PciNode, &DeviceNode);\r
    if (EFI_ERROR (Status)) {\r
      ASSERT (0);\r
      return Status;\r
    }\r
\r
    /* ACPI 6.4 specification, Table 6.2: "ADR Object Address Encodings"\r
       High word-Device #, Low word-Function #. (for example, device 3,\r
       function 2 is 0x00030002). To refer to all the functions on a device #,\r
       use a function number of FFFF).\r
    */\r
    Status = AmlCodeGenNameInteger (\r
               "_ADR",\r
               (DeviceId << 16) | 0xFFFF,\r
               DeviceNode,\r
               NULL\r
               );\r
    if (EFI_ERROR (Status)) {\r
      ASSERT (0);\r
      return Status;\r
    }\r
\r
    // _SUN object is not generated as we don't know which slot will be used.\r
  }\r
\r
  return Status;\r
}\r
\r
/** Generate a _PRT object (Pci Routing Table) for the Pci device.\r
\r
  Cf. ACPI 6.4 specification, s6.2.13 "_PRT (PCI Routing Table)"\r
\r
  The first model (defining a _CRS object) is used. This is necessary because\r
  PCI legacy interrupts are active low and GICv2 SPI interrupts are active\r
  high.\r
  Even though PCI interrupts cannot be re-routed, only the first model allows\r
  to specify the activation state (low/high).\r
\r
  @param [in]       Generator       The SSDT Pci generator.\r
  @param [in]       CfgMgrProtocol  Pointer to the Configuration Manager\r
                                    Protocol interface.\r
  @param [in]       PciInfo         Pci device information.\r
  @param [in, out]  PciNode         Pci node to amend.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GeneratePrt (\r
  IN            ACPI_PCI_GENERATOR                            *Generator,\r
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,\r
  IN      CONST CM_ARM_PCI_CONFIG_SPACE_INFO                  *PciInfo,\r
  IN  OUT       AML_OBJECT_NODE_HANDLE                        PciNode\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  INT32                          Index;\r
  AML_OBJECT_NODE_HANDLE         PrtNode;\r
  CM_ARM_OBJ_REF                 *RefInfo;\r
  UINT32                         RefCount;\r
  CM_ARM_PCI_INTERRUPT_MAP_INFO  *IrqMapInfo;\r
\r
  ASSERT (Generator != NULL);\r
  ASSERT (CfgMgrProtocol != NULL);\r
  ASSERT (PciInfo != NULL);\r
  ASSERT (PciNode != NULL);\r
\r
  PrtNode = NULL;\r
\r
  // Get the array of CM_ARM_OBJ_REF referencing the\r
  // CM_ARM_PCI_INTERRUPT_MAP_INFO objects.\r
  Status = GetEArmObjCmRef (\r
             CfgMgrProtocol,\r
             PciInfo->InterruptMapToken,\r
             &RefInfo,\r
             &RefCount\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // Initialized DeviceTable.\r
  Status = MappingTableInitialize (&Generator->DeviceTable, RefCount);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    goto exit_handler0;\r
  }\r
\r
  // ASL: Name (_PRT, Package () {})\r
  Status = AmlCodeGenNamePackage ("_PRT", NULL, &PrtNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    goto exit_handler;\r
  }\r
\r
  for (Index = 0; Index < RefCount; Index++) {\r
    // Get CM_ARM_PCI_INTERRUPT_MAP_INFO structures one by one.\r
    Status = GetEArmObjPciInterruptMapInfo (\r
               CfgMgrProtocol,\r
               RefInfo[Index].ReferenceToken,\r
               &IrqMapInfo,\r
               NULL\r
               );\r
    if (EFI_ERROR (Status)) {\r
      ASSERT (0);\r
      goto exit_handler;\r
    }\r
\r
    // Check that the interrupts flags are SPIs, level high.\r
    // Cf. Arm BSA v1.0, sE.6 "Legacy interrupts"\r
    if ((Index > 0)   &&\r
        (IrqMapInfo->IntcInterrupt.Interrupt >= 32)   &&\r
        (IrqMapInfo->IntcInterrupt.Interrupt < 1020)  &&\r
        ((IrqMapInfo->IntcInterrupt.Flags & 0x3) != BIT0))\r
    {\r
      Status = EFI_INVALID_PARAMETER;\r
      ASSERT_EFI_ERROR (Status);\r
      goto exit_handler;\r
    }\r
\r
    // Add the device to the DeviceTable.\r
    MappingTableAdd (&Generator->DeviceTable, IrqMapInfo->PciDevice);\r
\r
    /* Add a _PRT entry.\r
       ASL\r
       Name (_PRT, Package () {\r
         <OldPrtEntries>,\r
         <NewPrtEntry>\r
       })\r
\r
     Address is set as:\r
     ACPI 6.4 specification, Table 6.2: "ADR Object Address Encodings"\r
       High word-Device #, Low word-Function #. (for example, device 3,\r
       function 2 is 0x00030002). To refer to all the functions on a device #,\r
       use a function number of FFFF).\r
    */\r
    Status = AmlAddPrtEntry (\r
               (IrqMapInfo->PciDevice << 16) | 0xFFFF,\r
               IrqMapInfo->PciInterrupt,\r
               NULL,\r
               IrqMapInfo->IntcInterrupt.Interrupt,\r
               PrtNode\r
               );\r
    if (EFI_ERROR (Status)) {\r
      ASSERT (0);\r
      goto exit_handler;\r
    }\r
  } // for\r
\r
  // Attach the _PRT entry.\r
  Status = AmlAttachNode (PciNode, PrtNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT_EFI_ERROR (Status);\r
    goto exit_handler;\r
  }\r
\r
  PrtNode = NULL;\r
\r
  // Generate the Pci slots once all the device have been added.\r
  Status = GeneratePciSlots (&Generator->DeviceTable, PciNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    goto exit_handler;\r
  }\r
\r
exit_handler:\r
  MappingTableFree (&Generator->DeviceTable);\r
exit_handler0:\r
  if (PrtNode != NULL) {\r
    AmlDeleteTree (PrtNode);\r
  }\r
\r
  return Status;\r
}\r
\r
/** Generate a _CRS method for the Pci device.\r
\r
  @param [in]       Generator       The SSDT Pci generator.\r
  @param [in]       CfgMgrProtocol  Pointer to the Configuration Manager\r
                                    Protocol interface.\r
  @param [in]       PciInfo         Pci device information.\r
  @param [in, out]  PciNode         Pci node to amend.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GeneratePciCrs (\r
  IN            ACPI_PCI_GENERATOR                            *Generator,\r
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,\r
  IN      CONST CM_ARM_PCI_CONFIG_SPACE_INFO                  *PciInfo,\r
  IN  OUT       AML_OBJECT_NODE_HANDLE                        PciNode\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  BOOLEAN                      Translation;\r
  UINT32                       Index;\r
  CM_ARM_OBJ_REF               *RefInfo;\r
  UINT32                       RefCount;\r
  CM_ARM_PCI_ADDRESS_MAP_INFO  *AddrMapInfo;\r
  AML_OBJECT_NODE_HANDLE       CrsNode;\r
\r
  ASSERT (Generator != NULL);\r
  ASSERT (CfgMgrProtocol != NULL);\r
  ASSERT (PciInfo != NULL);\r
  ASSERT (PciNode != NULL);\r
\r
  // ASL: Name (_CRS, ResourceTemplate () {})\r
  Status = AmlCodeGenNameResourceTemplate ("_CRS", PciNode, &CrsNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // ASL:\r
  // WordBusNumber (          // Bus numbers assigned to this root\r
  //   ResourceProducer, MinFixed, MaxFixed, PosDecode,\r
  //   0,                     // AddressGranularity\r
  //   <Start>,               // AddressMinimum - Minimum Bus Number\r
  //   <End>,                 // AddressMaximum - Maximum Bus Number\r
  //   0,                     // AddressTranslation - Set to 0\r
  //   <End> - <Start> + 1    // RangeLength - Number of Busses\r
  // )\r
  Status = AmlCodeGenRdWordBusNumber (\r
             FALSE,\r
             TRUE,\r
             TRUE,\r
             TRUE,\r
             0,\r
             PciInfo->StartBusNumber,\r
             PciInfo->EndBusNumber,\r
             0,\r
             PciInfo->EndBusNumber - PciInfo->StartBusNumber + 1,\r
             0,\r
             NULL,\r
             CrsNode,\r
             NULL\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // Get the array of CM_ARM_OBJ_REF referencing the\r
  // CM_ARM_PCI_ADDRESS_MAP_INFO objects.\r
  Status = GetEArmObjCmRef (\r
             CfgMgrProtocol,\r
             PciInfo->AddressMapToken,\r
             &RefInfo,\r
             &RefCount\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  for (Index = 0; Index < RefCount; Index++) {\r
    // Get CM_ARM_PCI_ADDRESS_MAP_INFO structures one by one.\r
    Status = GetEArmObjPciAddressMapInfo (\r
               CfgMgrProtocol,\r
               RefInfo[Index].ReferenceToken,\r
               &AddrMapInfo,\r
               NULL\r
               );\r
    if (EFI_ERROR (Status)) {\r
      ASSERT (0);\r
      return Status;\r
    }\r
\r
    Translation = (AddrMapInfo->CpuAddress != AddrMapInfo->PciAddress);\r
\r
    switch (AddrMapInfo->SpaceCode) {\r
      case PCI_SS_IO:\r
        Status = AmlCodeGenRdDWordIo (\r
                   FALSE,\r
                   TRUE,\r
                   TRUE,\r
                   TRUE,\r
                   3,\r
                   0,\r
                   AddrMapInfo->PciAddress,\r
                   AddrMapInfo->PciAddress + AddrMapInfo->AddressSize - 1,\r
                   Translation ? AddrMapInfo->CpuAddress : 0,\r
                   AddrMapInfo->AddressSize,\r
                   0,\r
                   NULL,\r
                   TRUE,\r
                   FALSE,\r
                   CrsNode,\r
                   NULL\r
                   );\r
        break;\r
\r
      case PCI_SS_M32:\r
        Status = AmlCodeGenRdDWordMemory (\r
                   FALSE,\r
                   TRUE,\r
                   TRUE,\r
                   TRUE,\r
                   TRUE,\r
                   TRUE,\r
                   0,\r
                   AddrMapInfo->PciAddress,\r
                   AddrMapInfo->PciAddress + AddrMapInfo->AddressSize - 1,\r
                   Translation ? AddrMapInfo->CpuAddress : 0,\r
                   AddrMapInfo->AddressSize,\r
                   0,\r
                   NULL,\r
                   0,\r
                   TRUE,\r
                   CrsNode,\r
                   NULL\r
                   );\r
        break;\r
\r
      case PCI_SS_M64:\r
        Status = AmlCodeGenRdQWordMemory (\r
                   FALSE,\r
                   TRUE,\r
                   TRUE,\r
                   TRUE,\r
                   TRUE,\r
                   TRUE,\r
                   0,\r
                   AddrMapInfo->PciAddress,\r
                   AddrMapInfo->PciAddress + AddrMapInfo->AddressSize - 1,\r
                   Translation ? AddrMapInfo->CpuAddress : 0,\r
                   AddrMapInfo->AddressSize,\r
                   0,\r
                   NULL,\r
                   0,\r
                   TRUE,\r
                   CrsNode,\r
                   NULL\r
                   );\r
        break;\r
\r
      default:\r
        Status = EFI_INVALID_PARAMETER;\r
    } // switch\r
\r
    if (EFI_ERROR (Status)) {\r
      ASSERT (0);\r
      return Status;\r
    }\r
  } // for\r
\r
  return Status;\r
}\r
\r
/** Add an _OSC template method to the PciNode.\r
\r
  The _OSC method is provided as an AML blob. The blob is\r
  parsed and attached at the end of the PciNode list of variable elements.\r
\r
  @param [in, out]  PciNode     Pci node to amend.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
AddOscMethod (\r
  IN  OUT   AML_OBJECT_NODE_HANDLE  PciNode\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_STATUS                   Status1;\r
  EFI_ACPI_DESCRIPTION_HEADER  *SsdtPcieOscTemplate;\r
  AML_ROOT_NODE_HANDLE         OscTemplateRoot;\r
  AML_OBJECT_NODE_HANDLE       OscNode;\r
\r
  ASSERT (PciNode != NULL);\r
\r
  // Parse the Ssdt Pci Osc Template.\r
  SsdtPcieOscTemplate = (EFI_ACPI_DESCRIPTION_HEADER *)\r
                        ssdtpcieosctemplate_aml_code;\r
\r
  OscNode         = NULL;\r
  OscTemplateRoot = NULL;\r
  Status          = AmlParseDefinitionBlock (\r
                      SsdtPcieOscTemplate,\r
                      &OscTemplateRoot\r
                      );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: SSDT-PCI-OSC: Failed to parse SSDT PCI OSC Template."\r
      " Status = %r\n",\r
      Status\r
      ));\r
    return Status;\r
  }\r
\r
  Status = AmlFindNode (OscTemplateRoot, "\\_OSC", &OscNode);\r
  if (EFI_ERROR (Status)) {\r
    goto error_handler;\r
  }\r
\r
  Status = AmlDetachNode (OscNode);\r
  if (EFI_ERROR (Status)) {\r
    goto error_handler;\r
  }\r
\r
  Status = AmlAttachNode (PciNode, OscNode);\r
  if (EFI_ERROR (Status)) {\r
    // Free the detached node.\r
    AmlDeleteTree (OscNode);\r
    goto error_handler;\r
  }\r
\r
error_handler:\r
  // Cleanup\r
  Status1 = AmlDeleteTree (OscTemplateRoot);\r
  if (EFI_ERROR (Status1)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: SSDT-PCI-OSC: Failed to cleanup AML tree."\r
      " Status = %r\n",\r
      Status1\r
      ));\r
    // If Status was success but we failed to delete the AML Tree\r
    // return Status1 else return the original error code, i.e. Status.\r
    if (!EFI_ERROR (Status)) {\r
      return Status1;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/** Generate a Pci device.\r
\r
  @param [in]       Generator       The SSDT Pci generator.\r
  @param [in]       CfgMgrProtocol  Pointer to the Configuration Manager\r
                                    Protocol interface.\r
  @param [in]       PciInfo         Pci device information.\r
  @param [in]       Uid             Unique Id of the Pci device.\r
  @param [in, out]  RootNode        RootNode of the AML tree to populate.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GeneratePciDevice (\r
  IN            ACPI_PCI_GENERATOR                            *Generator,\r
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,\r
  IN      CONST CM_ARM_PCI_CONFIG_SPACE_INFO                  *PciInfo,\r
  IN            UINT32                                        Uid,\r
  IN  OUT       AML_ROOT_NODE_HANDLE                          *RootNode\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  CHAR8                   AslName[AML_NAME_SEG_SIZE + 1];\r
  AML_OBJECT_NODE_HANDLE  ScopeNode;\r
  AML_OBJECT_NODE_HANDLE  PciNode;\r
\r
  ASSERT (Generator != NULL);\r
  ASSERT (CfgMgrProtocol != NULL);\r
  ASSERT (PciInfo != NULL);\r
  ASSERT (RootNode != NULL);\r
\r
  PciNode = NULL;\r
\r
  // ASL: Scope (\_SB) {}\r
  Status = AmlCodeGenScope (SB_SCOPE, RootNode, &ScopeNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // Write the name of the PCI device.\r
  CopyMem (AslName, "PCIx", AML_NAME_SEG_SIZE + 1);\r
  AslName[AML_NAME_SEG_SIZE - 1] = AsciiFromHex (Uid);\r
\r
  // ASL: Device (PCIx) {}\r
  Status = AmlCodeGenDevice (AslName, ScopeNode, &PciNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // Populate the PCIx node with some Id values.\r
  Status = GeneratePciDeviceInfo (PciInfo, Uid, PciNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // Generate the Pci Routing Table (_PRT).\r
  if (PciInfo->InterruptMapToken != CM_NULL_TOKEN) {\r
    Status = GeneratePrt (\r
               Generator,\r
               CfgMgrProtocol,\r
               PciInfo,\r
               PciNode\r
               );\r
    if (EFI_ERROR (Status)) {\r
      ASSERT (0);\r
      return Status;\r
    }\r
  }\r
\r
  // Generate the _CRS method.\r
  Status = GeneratePciCrs (Generator, CfgMgrProtocol, PciInfo, PciNode);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  // Add the template _OSC method.\r
  Status = AddOscMethod (PciNode);\r
  ASSERT_EFI_ERROR (Status);\r
  return Status;\r
}\r
\r
/** Build an Ssdt table describing a Pci device.\r
\r
  @param [in]  Generator        The SSDT Pci generator.\r
  @param [in]  CfgMgrProtocol   Pointer to the Configuration Manager\r
                                Protocol interface.\r
  @param [in]  AcpiTableInfo    Pointer to the ACPI table information.\r
  @param [in]  PciInfo          Pci device information.\r
  @param [in]  Uid              Unique Id of the Pci device.\r
  @param [out] Table            If success, contains the created SSDT table.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate memory.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
BuildSsdtPciTable (\r
  IN        ACPI_PCI_GENERATOR                            *Generator,\r
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,\r
  IN  CONST CM_STD_OBJ_ACPI_TABLE_INFO            *CONST  AcpiTableInfo,\r
  IN  CONST CM_ARM_PCI_CONFIG_SPACE_INFO                  *PciInfo,\r
  IN        UINT32                                        Uid,\r
  OUT       EFI_ACPI_DESCRIPTION_HEADER                   **Table\r
  )\r
{\r
  EFI_STATUS            Status;\r
  EFI_STATUS            Status1;\r
  AML_ROOT_NODE_HANDLE  RootNode;\r
\r
  ASSERT (Generator != NULL);\r
  ASSERT (CfgMgrProtocol != NULL);\r
  ASSERT (PciInfo != NULL);\r
  ASSERT (Table != NULL);\r
\r
  // Create a new Ssdt table.\r
  Status = AddSsdtAcpiHeader (\r
             CfgMgrProtocol,\r
             &Generator->Header,\r
             AcpiTableInfo,\r
             &RootNode\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  Status = GeneratePciDevice (\r
             Generator,\r
             CfgMgrProtocol,\r
             PciInfo,\r
             Uid,\r
             RootNode\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    goto exit_handler;\r
  }\r
\r
  // Serialize the tree.\r
  Status = AmlSerializeDefinitionBlock (\r
             RootNode,\r
             Table\r
             );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: SSDT-PCI: Failed to Serialize SSDT Table Data."\r
      " Status = %r\n",\r
      Status\r
      ));\r
  }\r
\r
exit_handler:\r
  // Cleanup\r
  Status1 = AmlDeleteTree (RootNode);\r
  if (EFI_ERROR (Status1)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: SSDT-PCI: Failed to cleanup AML tree."\r
      " Status = %r\n",\r
      Status1\r
      ));\r
    // If Status was success but we failed to delete the AML Tree\r
    // return Status1 else return the original error code, i.e. Status.\r
    if (!EFI_ERROR (Status)) {\r
      return Status1;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/** Construct SSDT tables describing Pci root complexes.\r
\r
  This function invokes the Configuration Manager protocol interface\r
  to get the required hardware information for generating the ACPI\r
  table.\r
\r
  If this function allocates any resources then they must be freed\r
  in the FreeXXXXTableResourcesEx function.\r
\r
  @param [in]  This            Pointer to the ACPI table generator.\r
  @param [in]  AcpiTableInfo   Pointer to the ACPI table information.\r
  @param [in]  CfgMgrProtocol  Pointer to the Configuration Manager\r
                               Protocol interface.\r
  @param [out] Table           Pointer to a list of generated ACPI table(s).\r
  @param [out] TableCount      Number of generated ACPI table(s).\r
\r
  @retval EFI_SUCCESS            Table generated successfully.\r
  @retval EFI_BAD_BUFFER_SIZE    The size returned by the Configuration\r
                                 Manager is less than the Object size for\r
                                 the requested object.\r
  @retval EFI_INVALID_PARAMETER  A parameter is invalid.\r
  @retval EFI_NOT_FOUND          Could not find information.\r
  @retval EFI_OUT_OF_RESOURCES   Could not allocate memory.\r
  @retval EFI_UNSUPPORTED        Unsupported configuration.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
BuildSsdtPciTableEx (\r
  IN  CONST ACPI_TABLE_GENERATOR                           *This,\r
  IN  CONST CM_STD_OBJ_ACPI_TABLE_INFO             *CONST  AcpiTableInfo,\r
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL   *CONST  CfgMgrProtocol,\r
  OUT       EFI_ACPI_DESCRIPTION_HEADER                    ***Table,\r
  OUT       UINTN                                  *CONST  TableCount\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  CM_ARM_PCI_CONFIG_SPACE_INFO  *PciInfo;\r
  UINT32                        PciCount;\r
  UINTN                         Index;\r
  EFI_ACPI_DESCRIPTION_HEADER   **TableList;\r
  ACPI_PCI_GENERATOR            *Generator;\r
\r
  ASSERT (This != NULL);\r
  ASSERT (AcpiTableInfo != NULL);\r
  ASSERT (CfgMgrProtocol != NULL);\r
  ASSERT (Table != NULL);\r
  ASSERT (TableCount != NULL);\r
  ASSERT (AcpiTableInfo->TableGeneratorId == This->GeneratorID);\r
  ASSERT (AcpiTableInfo->AcpiTableSignature == This->AcpiTableSignature);\r
\r
  *TableCount = 0;\r
  Generator   = (ACPI_PCI_GENERATOR *)This;\r
\r
  Status = GetEArmObjPciConfigSpaceInfo (\r
             CfgMgrProtocol,\r
             CM_NULL_TOKEN,\r
             &PciInfo,\r
             &PciCount\r
             );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (0);\r
    return Status;\r
  }\r
\r
  if (PciCount > MAX_PCI_ROOT_COMPLEXES_SUPPORTED) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: SSDT-PCI: Too many Pci root complexes: %d."\r
      " Maximum Pci root complexes supported = %d.\n",\r
      PciCount,\r
      MAX_PCI_ROOT_COMPLEXES_SUPPORTED\r
      ));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  // Allocate a table to store pointers to the SSDT tables.\r
  TableList = (EFI_ACPI_DESCRIPTION_HEADER **)\r
              AllocateZeroPool (\r
                (sizeof (EFI_ACPI_DESCRIPTION_HEADER *) * PciCount)\r
                );\r
  if (TableList == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: SSDT-PCI: Failed to allocate memory for Table List."\r
      " Status = %r\n",\r
      Status\r
      ));\r
    return Status;\r
  }\r
\r
  // Setup the table list early so that appropriate cleanup\r
  // can be done in case of failure.\r
  *Table = TableList;\r
\r
  for (Index = 0; Index < PciCount; Index++) {\r
    // Build a SSDT table describing the Pci devices.\r
    Status = BuildSsdtPciTable (\r
               Generator,\r
               CfgMgrProtocol,\r
               AcpiTableInfo,\r
               &PciInfo[Index],\r
               Index,\r
               &TableList[Index]\r
               );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "ERROR: SSDT-PCI: Failed to build associated SSDT table."\r
        " Status = %r\n",\r
        Status\r
        ));\r
      goto error_handler;\r
    }\r
\r
    *TableCount += 1;\r
  } // for\r
\r
error_handler:\r
  // Note: Table list and Table count have been setup. The\r
  // error handler does nothing here as the framework will invoke\r
  // FreeSsdtPciTableEx () even on failure.\r
  return Status;\r
}\r
\r
/** Free any resources allocated for constructing the tables.\r
\r
  @param [in]      This           Pointer to the ACPI table generator.\r
  @param [in]      AcpiTableInfo  Pointer to the ACPI Table Info.\r
  @param [in]      CfgMgrProtocol Pointer to the Configuration Manager\r
                                  Protocol Interface.\r
  @param [in, out] Table          Pointer to an array of pointers\r
                                  to ACPI Table(s).\r
  @param [in]      TableCount     Number of ACPI table(s).\r
\r
  @retval EFI_SUCCESS           The resources were freed successfully.\r
  @retval EFI_INVALID_PARAMETER The table pointer is NULL or invalid.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
FreeSsdtPciTableEx (\r
  IN      CONST ACPI_TABLE_GENERATOR                   *CONST  This,\r
  IN      CONST CM_STD_OBJ_ACPI_TABLE_INFO             *CONST  AcpiTableInfo,\r
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL   *CONST  CfgMgrProtocol,\r
  IN OUT        EFI_ACPI_DESCRIPTION_HEADER          ***CONST  Table,\r
  IN      CONST UINTN                                          TableCount\r
  )\r
{\r
  EFI_ACPI_DESCRIPTION_HEADER  **TableList;\r
  UINTN                        Index;\r
\r
  ASSERT (This != NULL);\r
  ASSERT (AcpiTableInfo != NULL);\r
  ASSERT (CfgMgrProtocol != NULL);\r
  ASSERT (AcpiTableInfo->TableGeneratorId == This->GeneratorID);\r
  ASSERT (AcpiTableInfo->AcpiTableSignature == This->AcpiTableSignature);\r
\r
  if ((Table == NULL)   ||\r
      (*Table == NULL)  ||\r
      (TableCount == 0))\r
  {\r
    DEBUG ((DEBUG_ERROR, "ERROR: SSDT-PCI: Invalid Table Pointer\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  TableList = *Table;\r
  for (Index = 0; Index < TableCount; Index++) {\r
    if ((TableList[Index] != NULL) &&\r
        (TableList[Index]->Signature ==\r
         EFI_ACPI_6_3_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE))\r
    {\r
      FreePool (TableList[Index]);\r
    } else {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "ERROR: SSDT-PCI: Could not free SSDT table at index %d.",\r
        Index\r
        ));\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  } // for\r
\r
  // Free the table list.\r
  FreePool (*Table);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** This macro defines the SSDT Pci Table Generator revision.\r
*/\r
#define SSDT_PCI_GENERATOR_REVISION  CREATE_REVISION (1, 0)\r
\r
/** The interface for the SSDT Pci Table Generator.\r
*/\r
STATIC\r
ACPI_PCI_GENERATOR  SsdtPcieGenerator = {\r
  // ACPI table generator header\r
  {\r
    // Generator ID\r
    CREATE_STD_ACPI_TABLE_GEN_ID (EStdAcpiTableIdSsdtPciExpress),\r
    // Generator Description\r
    L"ACPI.STD.SSDT.PCI.GENERATOR",\r
    // ACPI Table Signature\r
    EFI_ACPI_6_3_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,\r
    // ACPI Table Revision - Unused\r
    0,\r
    // Minimum ACPI Table Revision - Unused\r
    0,\r
    // Creator ID\r
    TABLE_GENERATOR_CREATOR_ID_ARM,\r
    // Creator Revision\r
    SSDT_PCI_GENERATOR_REVISION,\r
    // Build table function. Use the extended version instead.\r
    NULL,\r
    // Free table function. Use the extended version instead.\r
    NULL,\r
    // Extended Build table function.\r
    BuildSsdtPciTableEx,\r
    // Extended free function.\r
    FreeSsdtPciTableEx\r
  },\r
\r
  // Private fields are defined from here.\r
\r
  // DeviceTable\r
  {\r
    // Table\r
    NULL,\r
    // LastIndex\r
    0,\r
    // MaxIndex\r
    0\r
  },\r
};\r
\r
/** Register the Generator with the ACPI Table Factory.\r
\r
  @param [in]  ImageHandle  The handle to the image.\r
  @param [in]  SystemTable  Pointer to the System Table.\r
\r
  @retval EFI_SUCCESS           The Generator is registered.\r
  @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
  @retval EFI_ALREADY_STARTED   The Generator for the Table ID\r
                                is already registered.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiSsdtPcieLibConstructor (\r
  IN  EFI_HANDLE        ImageHandle,\r
  IN  EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = RegisterAcpiTableGenerator (&SsdtPcieGenerator.Header);\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "SSDT-PCI: Register Generator. Status = %r\n",\r
    Status\r
    ));\r
  ASSERT_EFI_ERROR (Status);\r
  return Status;\r
}\r
\r
/** Deregister the Generator from the ACPI Table Factory.\r
\r
  @param [in]  ImageHandle  The handle to the image.\r
  @param [in]  SystemTable  Pointer to the System Table.\r
\r
  @retval EFI_SUCCESS           The Generator is deregistered.\r
  @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
  @retval EFI_NOT_FOUND         The Generator is not registered.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiSsdtPcieLibDestructor (\r
  IN  EFI_HANDLE        ImageHandle,\r
  IN  EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = DeregisterAcpiTableGenerator (&SsdtPcieGenerator.Header);\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "SSDT-PCI: Deregister Generator. Status = %r\n",\r
    Status\r
    ));\r
  ASSERT_EFI_ERROR (Status);\r
  return Status;\r
}\r