4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Header file of the Pci Host Bridge Driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/PciHostBridgeResourceAllocation.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Hard code the host bridge number in the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// In this chipset, there is only one host bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PCI_HOST_BRIDGE_SIGNATURE SIGNATURE_32('e', 'h', 's', 't')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL ResAlloc;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CR(a, PCI_HOST_BRIDGE_INSTANCE, ResAlloc, PCI_HOST_BRIDGE_SIGNATURE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// HostBridge Resource Allocation interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync These are the notifications from the PCI bus driver that it is about to enter a certain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync phase of the PCI enumeration process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This member function can be used to notify the host bridge driver to perform specific actions,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync including any chipset-specific initialization, so that the chipset is ready to enter the next phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Eight notification points are defined at this time. See belows:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeBeginEnumeration Resets the host bridge PCI apertures and internal data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync structures. The PCI enumerator should issue this notification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync before starting a fresh enumeration process. Enumeration cannot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be restarted after sending any other notification such as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeBeginBusAllocation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeBeginBusAllocation The bus allocation phase is about to begin. No specific action is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required here. This notification can be used to perform any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeEndBusAllocation The bus allocation and bus programming phase is complete. No
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specific action is required here. This notification can be used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync perform any chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeBeginResourceAllocation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The resource allocation phase is about to begin. No specific
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync action is required here. This notification can be used to perform
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync any chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeAllocateResources Allocates resources per previously submitted requests for all the PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync root bridges. These resource settings are returned on the next call to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetProposedResources(). Before calling NotifyPhase() with a Phase of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeAllocateResource, the PCI bus enumerator is responsible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for gathering I/O and memory requests for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all the PCI root bridges and submitting these requests using
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SubmitResources(). This function pads the resource amount
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to suit the root bridge hardware, takes care of dependencies between
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the PCI root bridges, and calls the Global Coherency Domain (GCD)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the allocation request. In the case of padding, the allocated range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could be bigger than what was requested.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeSetResources Programs the host bridge hardware to decode previously allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resources (proposed resources) for all the PCI root bridges. After the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync hardware is programmed, reassigning resources will not be supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The bus settings are not affected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeFreeResources Deallocates resources that were previously allocated for all the PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync root bridges and resets the I/O and memory apertures to their initial
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync state. The bus settings are not affected. If the request to allocate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resources fails, the PCI enumerator can use this notification to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync deallocate previous resources, adjust the requests, and retry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeEndResourceAllocation The resource allocation phase is completed. No specific action is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required here. This notification can be used to perform any chipsetspecific
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Phase The phase during enumeration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY This phase cannot be entered at this time. For example, this error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is valid for a Phase of EfiPciHostBridgeAllocateResources if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SubmitResources() has not been called for one or more
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PCI root bridges before this call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. This error is valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for a Phase of EfiPciHostBridgeSetResources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Invalid phase parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This error is valid for a Phase of EfiPciHostBridgeAllocateResources if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previously submitted resource requests cannot be fulfilled or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync were only partially fulfilled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The notification was accepted without any errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the device handle of the next PCI root bridge that is associated with this Host Bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called multiple times to retrieve the device handles of all the PCI root bridges that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are associated with this PCI host bridge. Each PCI host bridge is associated with one or more PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync root bridges. On each call, the handle that was returned by the previous call is passed into the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interface, and on output the interface returns the device handle of the next PCI root bridge. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller can use the handle to obtain the instance of the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for that root bridge. When there are no more PCI root bridges to report, the interface returns
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_FOUND. A PCI enumerator must enumerate the PCI root bridges in the order that they
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are returned by this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For D945 implementation, there is only one root bridge in PCI host bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] RootBridgeHandle Returns the device handle of the next PCI root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS If parameter RootBridgeHandle = NULL, then return the first Rootbridge handle of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specific Host bridge and return EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Can not find the any more root bridge in specific host bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER RootBridgeHandle is not an EFI_HANDLE that was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned on a previous call to GetNextRootBridge().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the allocation attributes of a PCI root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The function returns the allocation attributes of a specific PCI root bridge. The attributes can vary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from one PCI root bridge to another. These attributes are different from the decode-related
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes that are returned by the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.GetAttributes() member function. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RootBridgeHandle parameter is used to specify the instance of the PCI root bridge. The device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handles of all the root bridges that are associated with this host bridge must be obtained by calling
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetNextRootBridge(). The attributes are static in the sense that they do not change during or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after the enumeration process. The hardware may provide mechanisms to change the attributes on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the fly, but such changes must be completed before EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed. The permitted values of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ATTRIBUTES are defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "Related Definitions" below. The caller uses these attributes to combine multiple resource requests.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For example, if the flag EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM is set, the PCI bus enumerator needs to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync include requests for the prefetchable memory in the nonprefetchable memory pool and not request any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prefetchable memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Attribute Description
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ------------------------------------ ----------------------------------------------------------------------
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM If this bit is set, then the PCI root bridge does not support separate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync windows for nonprefetchable and prefetchable memory. A PCI bus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver needs to include requests for prefetchable memory in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync nonprefetchable memory pool.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_HOST_BRIDGE_MEM64_DECODE If this bit is set, then the PCI root bridge supports 64-bit memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync windows. If this bit is not set, the PCI bus driver needs to include
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync requests for a 64-bit memory address in the corresponding 32-bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync memory pool.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested. Type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Attributes The pointer to attribte of root bridge, it is output parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Attribute pointer is NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER RootBridgehandle is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Success to get attribute of interested root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets up the specified PCI root bridge for the bus enumeration process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This member function sets up the root bridge for bus enumeration and returns the PCI bus range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync over which the search should be performed in ACPI 2.0 resource descriptor format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RootBridgeHandle The PCI Root Bridge to be set up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Configuration Pointer to the pointer to the PCI bus resource descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Invalid Root bridge's handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Fail to allocate ACPI resource descriptor tag.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Sucess to allocate ACPI resource descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This member function programs the specified PCI root bridge to decode the bus range that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by the input parameter Configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The bus range information is specified in terms of the ACPI 2.0 resource descriptor format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Configuration The pointer to the PCI bus resource descriptor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration does not include a valid ACPI 2.0 bus resource descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration includes valid ACPI 2.0 resource descriptors other than
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bus descriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER "Address Range Minimum" is invalid for this root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The bus range for the PCI root bridge was programmed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Submits the I/O and memory resource requirements for the specified PCI root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to submit all the I/O and memory resources that are required by the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PCI root bridge. The input parameter Configuration is used to specify the following:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The various types of resources that are required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The associated lengths in terms of ACPI 2.0 resource descriptor format
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being submitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Configuration The pointer to the PCI I/O and PCI memory resource descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The I/O and memory resource requests for a PCI root bridge were accepted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Configuration includes requests for one or more resource types that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not supported by this PCI root bridge. This error will happen if the caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync did not combine resources according to Attributes that were returned by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetAllocAttributes().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Address Range Maximum" is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this PCI root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER "Address Space Granularity" is invalid for this PCI root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the proposed resource settings for the specified PCI root bridge.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This member function returns the proposed resource settings for the specified PCI root bridge. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync proposed resource settings are prepared when NotifyPhase() is called with a Phase of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiPciHostBridgeAllocateResources. The output parameter Configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specifies the following:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The various types of resources, excluding bus resources, that are allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The associated lengths in terms of ACPI 2.0 resource descriptor format
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RootBridgeHandle The PCI root bridge handle. Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested parameters were returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PCI controllers before enumeration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called during the PCI enumeration process. No specific action is expected from this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync member function. It allows the host bridge driver to preinitialize individual PCI controllers before
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync enumeration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RootBridgeHandle The associated PCI root bridge handle. Type EFI_HANDLE is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InstallProtocolInterface() in the UEFI 2.0 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PciAddress The address of the PCI device on the PCI bus. This address can be passed to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL member functions to access the PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration space of the device. See Table 12-1 in the UEFI 2.0 Specification for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the definition of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Phase The phase of the PCI device enumeration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested parameters were returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Phase is not a valid phase that is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. The PCI enumerator should
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not enumerate this device, including its child devices if it is a PCI-to-PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Define resource status constant
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_NONEXISTENT 0xFFFFFFFFFFFFFFFFULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Driver Instance Data Prototypes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION Operation;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PCI_ROOT_BRIDGE_SIGNATURE SIGNATURE_32('e', '2', 'p', 'b')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Specific for this memory controller: Bus, I/O, Mem
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Addressing for Memory and I/O and Bus arrange
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Driver Instance Data Macros
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DRIVER_INSTANCE_FROM_PCI_ROOT_BRIDGE_IO_THIS(a) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CR(a, PCI_ROOT_BRIDGE_INSTANCE, Io, PCI_ROOT_BRIDGE_SIGNATURE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CR(a, PCI_ROOT_BRIDGE_INSTANCE, Link, PCI_ROOT_BRIDGE_SIGNATURE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Construct the Pci Root Bridge Io protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol Point to protocol instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HostBridgeHandle Handle of host bridge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attri Attribute of host bridge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResAppeture ResourceAppeture for host bridge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Success to initialize the Pci Root Bridge.