update the comments on Event

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciEnumerator.h

/** @file\r
  Header file declares all logic function for PCI bus enumeration.\r
  \r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
\r
#ifndef _EFI_PCI_ENUMERATOR_H_\r
#define _EFI_PCI_ENUMERATOR_H_\r
\r
#include "PciResourceSupport.h"\r
\r
/**\r
  This routine is used to enumerate entire pci bus system\r
  in a given platform\r
\r
  @param Controller  Parent controller handle.\r
  \r
  @return Status of enumerating.\r
**/\r
EFI_STATUS\r
PciEnumerator (\r
  IN EFI_HANDLE                    Controller\r
  );\r
\r
/**\r
  Enumerate PCI root bridge\r
  \r
  @param PciResAlloc   Pointer to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
  @param RootBridgeDev Instance of root bridge device.\r
  \r
  @retval EFI_SUCCESS  Success to enumerate root bridge.\r
  @retval Others       Fail to enumerate root bridge.\r
  \r
**/\r
EFI_STATUS\r
PciRootBridgeEnumerator (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc,\r
  IN PCI_IO_DEVICE                                     *RootBridgeDev\r
  );\r
\r
/**\r
  This routine is used to process option rom on a certain root bridge\r
  \r
  @param Bridge     Given parent's root bridge.\r
  @param RomBase    Base address of ROM driver loaded from.\r
  @param MaxLength  Max rom size.\r
  \r
  @retval EFI_SUCCESS Success to process option rom image.\r
**/\r
EFI_STATUS\r
ProcessOptionRom (\r
  IN PCI_IO_DEVICE *Bridge,\r
  IN UINT64        RomBase,\r
  IN UINT64        MaxLength\r
  );\r
\r
/**\r
  This routine is used to assign bus number to the given PCI bus system\r
  \r
  @param Bridge           Parent root bridge instance.\r
  @param StartBusNumber   Number of beginning.\r
  @param SubBusNumber     the number of sub bus.\r
  \r
  @retval EFI_SUCCESS  Success to assign bus number.\r
**/\r
EFI_STATUS\r
PciAssignBusNumber (\r
  IN PCI_IO_DEVICE                      *Bridge,\r
  IN UINT8                              StartBusNumber,\r
  OUT UINT8                             *SubBusNumber\r
  );\r
\r
/**\r
  This routine is used to determine the root bridge attribute by interfacing\r
  the host bridge resource allocation protocol.\r
\r
  @param PciResAlloc    Protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
  @param RootBridgeDev  Root bridge instance.\r
  \r
  @retval EFI_SUCCESS  Success to get root bridge's attribute.\r
  @retval Others       Fail to get attribute.\r
**/\r
EFI_STATUS\r
DetermineRootBridgeAttributes (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
  IN PCI_IO_DEVICE                                    *RootBridgeDev\r
  );\r
\r
/**\r
  Get Max Option Rom size on this bridge\r
  \r
  @param Bridge  Bridge device instance.\r
  @return Max size of option rom.\r
**/\r
UINT64\r
GetMaxOptionRomSize (\r
  IN PCI_IO_DEVICE   *Bridge\r
  );\r
\r
/**\r
  Process attributes of devices on this host bridge\r
  \r
  @param PciResAlloc Protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
  \r
  @retval EFI_NOT_FOUND Can not find the specific root bridge device.\r
  @retval EFI_SUCCESS   Success Process attribute.\r
  @retval Others        Can not determine the root bridge device's attribute.\r
**/\r
EFI_STATUS\r
PciHostBridgeDeviceAttribute (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
  );\r
\r
/**\r
  Get resource allocation status from the ACPI pointer\r
\r
  @param AcpiConfig       Point to Acpi configuration table.\r
  @param IoResStatus      Return the status of I/O resource.\r
  @param Mem32ResStatus   Return the status of 32-bit Memory resource.\r
  @param PMem32ResStatus  Return the status of 32-bit PMemory resource.\r
  @param Mem64ResStatus   Return the status of 64-bit Memory resource.\r
  @param PMem64ResStatus  Return the status of 64-bit PMemory resource.\r
  \r
  @retval EFI_SUCCESS Success to get resource allocation status from ACPI configuration table.\r
**/\r
EFI_STATUS\r
GetResourceAllocationStatus (\r
  VOID        *AcpiConfig,\r
  OUT UINT64  *IoResStatus,\r
  OUT UINT64  *Mem32ResStatus,\r
  OUT UINT64  *PMem32ResStatus,\r
  OUT UINT64  *Mem64ResStatus,\r
  OUT UINT64  *PMem64ResStatus\r
  );\r
\r
/**\r
  Remove a PCI device from device pool and mark its bar\r
  \r
  @param PciDevice Instance of Pci device.\r
  \r
  @retval EFI_SUCCESS Success Operation.\r
  @retval EFI_ABORTED Pci device is a root bridge.\r
**/\r
EFI_STATUS\r
RejectPciDevice (\r
  IN PCI_IO_DEVICE       *PciDevice\r
  );\r
\r
/**\r
  Determine whethter a PCI device can be rejected\r
  \r
  @param PciResNode Pointer to Pci resource node instance.\r
  \r
  @return whethter a PCI device can be rejected.\r
**/\r
BOOLEAN\r
IsRejectiveDevice (\r
  IN  PCI_RESOURCE_NODE   *PciResNode\r
  );\r
\r
/**\r
  Compare two resource node and get the larger resource consumer\r
  \r
  @param PciResNode1  resource node 1 want to be compared.\r
  @param PciResNode2  resource node 2 want to be compared.\r
  \r
  @return Larger resource consumer.\r
**/\r
PCI_RESOURCE_NODE *\r
GetLargerConsumerDevice (\r
  IN  PCI_RESOURCE_NODE   *PciResNode1,\r
  IN  PCI_RESOURCE_NODE   *PciResNode2\r
  );\r
\r
/**\r
  Get the max resource consumer in the host resource pool\r
  \r
  @param ResPool  Pointer to resource pool node.\r
  \r
  @return the max resource consumer in the host resource pool.\r
**/\r
PCI_RESOURCE_NODE *\r
GetMaxResourceConsumerDevice (\r
  IN  PCI_RESOURCE_NODE   *ResPool\r
  );\r
\r
/**\r
  Adjust host bridge allocation so as to reduce resource requirement\r
  \r
  @param IoPool           Pointer to instance of I/O resource Node.\r
  @param Mem32Pool        Pointer to instance of 32-bit memory resource Node.\r
  @param PMem32Pool       Pointer to instance of 32-bit Pmemory resource node.\r
  @param Mem64Pool        Pointer to instance of 64-bit memory resource node.\r
  @param PMem64Pool       Pointer to instance of 64-bit Pmemory resource node.\r
  @param IoResStatus      Status of I/O resource Node.\r
  @param Mem32ResStatus   Status of 32-bit memory resource Node.\r
  @param PMem32ResStatus  Status of 32-bit Pmemory resource node.\r
  @param Mem64ResStatus   Status of 64-bit memory resource node.\r
  @param PMem64ResStatus  Status of 64-bit Pmemory resource node.\r
**/\r
EFI_STATUS\r
PciHostBridgeAdjustAllocation (\r
  IN  PCI_RESOURCE_NODE   *IoPool,\r
  IN  PCI_RESOURCE_NODE   *Mem32Pool,\r
  IN  PCI_RESOURCE_NODE   *PMem32Pool,\r
  IN  PCI_RESOURCE_NODE   *Mem64Pool,\r
  IN  PCI_RESOURCE_NODE   *PMem64Pool,\r
  IN  UINT64              IoResStatus,\r
  IN  UINT64              Mem32ResStatus,\r
  IN  UINT64              PMem32ResStatus,\r
  IN  UINT64              Mem64ResStatus,\r
  IN  UINT64              PMem64ResStatus\r
  );\r
\r
/**\r
  Summary requests for all resource type, and contruct ACPI resource\r
  requestor instance.\r
  \r
  @param Bridge           detecting bridge.\r
  @param IoNode           Pointer to instance of I/O resource Node.\r
  @param Mem32Node        Pointer to instance of 32-bit memory resource Node.\r
  @param PMem32Node       Pointer to instance of 32-bit Pmemory resource node.\r
  @param Mem64Node        Pointer to instance of 64-bit memory resource node.\r
  @param PMem64Node       Pointer to instance of 64-bit Pmemory resource node.\r
  @param Config           Output buffer holding new constructed APCI resource requestor.\r
**/\r
EFI_STATUS\r
ConstructAcpiResourceRequestor (\r
  IN PCI_IO_DEVICE      *Bridge,\r
  IN PCI_RESOURCE_NODE  *IoNode,\r
  IN PCI_RESOURCE_NODE  *Mem32Node,\r
  IN PCI_RESOURCE_NODE  *PMem32Node,\r
  IN PCI_RESOURCE_NODE  *Mem64Node,\r
  IN PCI_RESOURCE_NODE  *PMem64Node,\r
  OUT VOID              **Config\r
  );\r
\r
/**\r
  Get resource base from an acpi configuration descriptor.\r
  \r
  @param Config       an acpi configuration descriptor.\r
  @param IoBase       output of I/O resource base address.\r
  @param Mem32Base    output of 32-bit memory base address.\r
  @param PMem32Base   output of 32-bit pmemory base address.\r
  @param Mem64Base    output of 64-bit memory base address.\r
  @param PMem64Base   output of 64-bit pmemory base address.\r
  \r
  @return EFI_SUCCESS    Get resource base address successfully.\r
\r
**/\r
EFI_STATUS\r
GetResourceBase (\r
  IN VOID     *Config,\r
  OUT UINT64  *IoBase,\r
  OUT UINT64  *Mem32Base,\r
  OUT UINT64  *PMem32Base,\r
  OUT UINT64  *Mem64Base,\r
  OUT UINT64  *PMem64Base\r
  );\r
\r
/**\r
  Enumerate pci bridge, allocate resource and determine attribute\r
  for devices on this bridge\r
  \r
  @param BridgeDev Pointer to instance of bridge device.\r
  \r
  @retval EFI_SUCCESS Success operation.\r
  @retval Others      Fail to enumerate.\r
**/\r
EFI_STATUS\r
PciBridgeEnumerator (\r
  IN PCI_IO_DEVICE                                     *BridgeDev\r
  );\r
\r
/**\r
  Allocate all kinds of resource for bridge\r
  \r
  @param Bridge      Pointer to bridge instance.\r
  \r
  @retval EFI_SUCCESS Success operation.\r
  @retval Others      Fail to allocate resource for bridge.\r
**/\r
EFI_STATUS\r
PciBridgeResourceAllocator (\r
  IN PCI_IO_DEVICE  *Bridge\r
  );\r
\r
/**\r
  Get resource base address for a pci bridge device\r
  \r
  @param Bridge  Given Pci driver instance.\r
  @param IoBase  output for base address of I/O type resource.\r
  @param Mem32Base  output for base address of 32-bit memory type resource.\r
  @param PMem32Base  output for base address of 32-bit Pmemory type resource.\r
  @param Mem64Base  output for base address of 64-bit memory type resource.\r
  @param PMem64Base  output for base address of 64-bit Pmemory type resource.\r
  \r
  @retval EFI_SUCCESS Succes to get resource base address.\r
**/\r
EFI_STATUS\r
GetResourceBaseFromBridge (\r
  IN  PCI_IO_DEVICE *Bridge,\r
  OUT UINT64        *IoBase,\r
  OUT UINT64        *Mem32Base,\r
  OUT UINT64        *PMem32Base,\r
  OUT UINT64        *Mem64Base,\r
  OUT UINT64        *PMem64Base\r
  );\r
\r
/**\r
  Process Option Rom on this host bridge\r
  \r
  @param PciResAlloc Pointer to instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
  \r
  @retval EFI_NOT_FOUND Can not find the root bridge instance.\r
  @retval EFI_SUCCESS   Success process.\r
**/\r
EFI_STATUS\r
PciHostBridgeP2CProcess (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
  );\r
\r
/**\r
   These are the notifications from the PCI bus driver that it is about to enter a certain \r
   phase of the PCI enumeration process.\r
\r
   This member function can be used to notify the host bridge driver to perform specific actions,\r
   including any chipset-specific initialization, so that the chipset is ready to enter the next phase.\r
   Eight notification points are defined at this time. See belows:\r
   EfiPciHostBridgeBeginEnumeration     - Resets the host bridge PCI apertures and internal data\r
                                          structures. The PCI enumerator should issue this notification\r
                                          before starting a fresh enumeration process. Enumeration cannot\r
                                          be restarted after sending any other notification such as\r
                                          EfiPciHostBridgeBeginBusAllocation.\r
   EfiPciHostBridgeBeginBusAllocation   - The bus allocation phase is about to begin. No specific action is\r
                                          required here. This notification can be used to perform any\r
                                          chipset-specific programming.\r
   EfiPciHostBridgeEndBusAllocation     - The bus allocation and bus programming phase is complete. No\r
                                          specific action is required here. This notification can be used to\r
                                          perform any chipset-specific programming.\r
   EfiPciHostBridgeBeginResourceAllocation -  The resource allocation phase is about to begin. No specific\r
                                              action is required here. This notification can be used to perform\r
                                              any chipset-specific programming.\r
   EfiPciHostBridgeAllocateResources    - Allocates resources per previously submitted requests for all the PCI\r
                                          root bridges. These resource settings are returned on the next call to\r
                                          GetProposedResources(). Before calling NotifyPhase() with a Phase of\r
                                          EfiPciHostBridgeAllocateResource, the PCI bus enumerator is responsible for gathering I/O and memory requests for\r
                                          all the PCI root bridges and submitting these requests using\r
                                          SubmitResources(). This function pads the resource amount\r
                                          to suit the root bridge hardware, takes care of dependencies between\r
                                          the PCI root bridges, and calls the Global Coherency Domain (GCD)\r
                                          with the allocation request. In the case of padding, the allocated range\r
                                          could be bigger than what was requested.\r
   EfiPciHostBridgeSetResources         - Programs the host bridge hardware to decode previously allocated\r
                                          resources (proposed resources) for all the PCI root bridges. After the\r
                                          hardware is programmed, reassigning resources will not be supported.\r
                                          The bus settings are not affected.\r
   EfiPciHostBridgeFreeResources        - Deallocates resources that were previously allocated for all the PCI\r
                                          root bridges and resets the I/O and memory apertures to their initial\r
                                          state. The bus settings are not affected. If the request to allocate\r
                                          resources fails, the PCI enumerator can use this notification to\r
                                          deallocate previous resources, adjust the requests, and retry\r
                                          allocation.\r
   EfiPciHostBridgeEndResourceAllocation- The resource allocation phase is completed. No specific action is\r
                                          required here. This notification can be used to perform any chipsetspecific\r
                                          programming.\r
      \r
   @param[in] PciResAlloc         The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
   @param[in] Phase               The phase during enumeration\r
   \r
   @retval EFI_NOT_READY          This phase cannot be entered at this time. For example, this error\r
                                  is valid for a Phase of EfiPciHostBridgeAllocateResources if\r
                                  SubmitResources() has not been called for one or more\r
                                  PCI root bridges before this call\r
   @retval EFI_DEVICE_ERROR       Programming failed due to a hardware error. This error is valid\r
                                  for a Phase of EfiPciHostBridgeSetResources.\r
   @retval EFI_INVALID_PARAMETER  Invalid phase parameter\r
   @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a lack of resources.\r
                                  This error is valid for a Phase of EfiPciHostBridgeAllocateResources if the\r
                                  previously submitted resource requests cannot be fulfilled or\r
                                  were only partially fulfilled.\r
   @retval EFI_SUCCESS            The notification was accepted without any errors.\r
\r
**/\r
EFI_STATUS\r
NotifyPhase (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE       Phase\r
  );\r
\r
/**\r
   Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various\r
   stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual\r
   PCI controllers before enumeration.\r
\r
   This function is called during the PCI enumeration process. No specific action is expected from this\r
   member function. It allows the host bridge driver to preinitialize individual PCI controllers before\r
   enumeration.\r
\r
   @param Bridge            Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
   @param Bus               The bus number of the pci device. \r
   @param Device            The device number of the pci device. \r
   @param Func              The function number of the pci device. \r
   @param Phase             The phase of the PCI device enumeration. \r
   \r
   @retval EFI_SUCCESS              The requested parameters were returned.\r
   @retval EFI_INVALID_PARAMETER    RootBridgeHandle is not a valid root bridge handle.\r
   @retval EFI_INVALID_PARAMETER    Phase is not a valid phase that is defined in\r
                                    EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE.\r
   @retval EFI_DEVICE_ERROR         Programming failed due to a hardware error. The PCI enumerator should\r
                                    not enumerate this device, including its child devices if it is a PCI-to-PCI\r
                                    bridge.\r
\r
**/\r
EFI_STATUS\r
PreprocessController (\r
  IN PCI_IO_DEVICE                                  *Bridge,\r
  IN UINT8                                          Bus,\r
  IN UINT8                                          Device,\r
  IN UINT8                                          Func,\r
  IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE   Phase\r
  );\r
\r
/**\r
  Hot plug request notify.\r
  \r
  @param This                 - A pointer to the hot plug request protocol.\r
  @param Operation            - The operation.\r
  @param Controller           - A pointer to the controller.\r
  @param RemainingDevicePath  - A pointer to the device path.\r
  @param NumberOfChildren     - A the number of child handle in the ChildHandleBuffer.\r
  @param ChildHandleBuffer    - A pointer to the array contain the child handle.\r
  \r
  @retval EFI_NOT_FOUND Can not find bridge according to controller handle.\r
  @retval EFI_SUCCESS   Success operating.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PciHotPlugRequestNotify (\r
  IN EFI_PCI_HOTPLUG_REQUEST_PROTOCOL * This,\r
  IN EFI_PCI_HOTPLUG_OPERATION        Operation,\r
  IN EFI_HANDLE                       Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL         * RemainingDevicePath OPTIONAL,\r
  IN OUT UINT8                        *NumberOfChildren,\r
  IN OUT EFI_HANDLE                   * ChildHandleBuffer\r
  );\r
\r
/**\r
  Search hostbridge according to given handle\r
  \r
  @param RootBridgeHandle     - Host bridge handle.\r
\r
  @return TRUE  Found.\r
  @return FALSE Not found.\r
**/\r
BOOLEAN\r
SearchHostBridgeHandle (\r
  IN EFI_HANDLE RootBridgeHandle\r
  );\r
\r
/**\r
  Add host bridge handle to global variable for enumating.\r
  \r
  @param HostBridgeHandle host bridge handle.\r
**/\r
EFI_STATUS\r
AddHostBridgeEnumerator (\r
  IN EFI_HANDLE HostBridgeHandle\r
  );\r
\r
#endif\r