UefiPayloadPkg: Replace MEMROY_ENTRY by MEMORY_ENTRY

[mirror_edk2.git] / UefiPayloadPkg / Library / PciHostBridgeLib / PciHostBridge.h

/** @file\r
  Header file of PciHostBridgeLib.\r
\r
  Copyright (C) 2016, Red Hat, Inc.\r
  Copyright (c) 2016 - 2021, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _PCI_HOST_BRIDGE_H\r
#define _PCI_HOST_BRIDGE_H\r
\r
#include <UniversalPayload/PciRootBridges.h>\r
\r
typedef struct {\r
  ACPI_HID_DEVICE_PATH     AcpiDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL EndDevicePath;\r
} CB_PCI_ROOT_BRIDGE_DEVICE_PATH;\r
\r
/**\r
  Scan for all root bridges in platform.\r
\r
  @param[out] NumberOfRootBridges  Number of root bridges detected\r
\r
  @retval     Pointer to the allocated PCI_ROOT_BRIDGE structure array.\r
**/\r
PCI_ROOT_BRIDGE *\r
ScanForRootBridges (\r
  OUT UINTN      *NumberOfRootBridges\r
);\r
\r
/**\r
  Scan for all root bridges from Universal Payload PciRootBridgeInfoHob\r
\r
  @param[in]  PciRootBridgeInfo    Pointer of Universal Payload PCI Root Bridge Info Hob\r
  @param[out] NumberOfRootBridges  Number of root bridges detected\r
\r
  @retval     Pointer to the allocated PCI_ROOT_BRIDGE structure array.\r
\r
**/\r
PCI_ROOT_BRIDGE *\r
RetrieveRootBridgeInfoFromHob (\r
  IN  UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES  *PciRootBridgeInfo,\r
  OUT UINTN                               *NumberOfRootBridges\r
);\r
\r
/**\r
  Initialize a PCI_ROOT_BRIDGE structure.\r
\r
  @param[in]  Supports         Supported attributes.\r
\r
  @param[in]  Attributes       Initial attributes.\r
\r
  @param[in]  AllocAttributes  Allocation attributes.\r
\r
  @param[in]  RootBusNumber    The bus number to store in RootBus.\r
\r
  @param[in]  MaxSubBusNumber  The inclusive maximum bus number that can be\r
                               assigned to any subordinate bus found behind any\r
                               PCI bridge hanging off this root bus.\r
\r
                               The caller is responsible for ensuring that\r
                               RootBusNumber <= MaxSubBusNumber. If\r
                               RootBusNumber equals MaxSubBusNumber, then the\r
                               root bus has no room for subordinate buses.\r
\r
  @param[in]  Io               IO aperture.\r
\r
  @param[in]  Mem              MMIO aperture.\r
\r
  @param[in]  MemAbove4G       MMIO aperture above 4G.\r
\r
  @param[in]  PMem             Prefetchable MMIO aperture.\r
\r
  @param[in]  PMemAbove4G      Prefetchable MMIO aperture above 4G.\r
\r
  @param[out] RootBus          The PCI_ROOT_BRIDGE structure (allocated by the\r
                               caller) that should be filled in by this\r
                               function.\r
\r
  @retval EFI_SUCCESS           Initialization successful. A device path\r
                                consisting of an ACPI device path node, with\r
                                UID = RootBusNumber, has been allocated and\r
                                linked into RootBus.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Memory allocation failed.\r
**/\r
EFI_STATUS\r
InitRootBridge (\r
  IN  UINT64                   Supports,\r
  IN  UINT64                   Attributes,\r
  IN  UINT64                   AllocAttributes,\r
  IN  UINT8                    RootBusNumber,\r
  IN  UINT8                    MaxSubBusNumber,\r
  IN  PCI_ROOT_BRIDGE_APERTURE *Io,\r
  IN  PCI_ROOT_BRIDGE_APERTURE *Mem,\r
  IN  PCI_ROOT_BRIDGE_APERTURE *MemAbove4G,\r
  IN  PCI_ROOT_BRIDGE_APERTURE *PMem,\r
  IN  PCI_ROOT_BRIDGE_APERTURE *PMemAbove4G,\r
  OUT PCI_ROOT_BRIDGE          *RootBus\r
);\r
\r
/**\r
  Initialize DevicePath for a PCI_ROOT_BRIDGE.\r
  @param[in] HID               HID for device path\r
  @param[in] UID               UID for device path\r
\r
  @retval A pointer to the new created device patch.\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
CreateRootBridgeDevicePath (\r
  IN     UINT32                   HID,\r
  IN     UINT32                   UID\r
);\r
#endif\r