Provides the basic interfaces to abstract a PCI host bridge resource allocation. This protocol is\r
mandatory if the system includes PCI devices.\r
\r
- Copyright (c) 2007, Intel Corporation\r
+ Copyright (c) 2007 - 2009, 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
// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ATTRIBUTES\r
//\r
\r
-// If this bit is set, then the PCI Root Bridge does not\r
-// support separate windows for Non-prefetchable and Prefetchable\r
-// memory. A PCI bus driver needs to include requests for Prefetchable\r
-// memory in the Non-prefetchable memory pool.\r
-//\r
+/// If this bit is set, then the PCI Root Bridge does not\r
+/// support separate windows for Non-prefetchable and Prefetchable\r
+/// memory. A PCI bus driver needs to include requests for Prefetchable\r
+/// memory in the Non-prefetchable memory pool.\r
+///\r
#define EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM 1\r
\r
-//\r
-// If this bit is set, then the PCI Root Bridge supports\r
-// 64 bit memory windows. If this bit is not set,\r
-// the PCI bus driver needs to include requests for 64 bit\r
-// memory address in the corresponding 32 bit memory pool.\r
-//\r
+///\r
+/// If this bit is set, then the PCI Root Bridge supports\r
+/// 64 bit memory windows. If this bit is not set,\r
+/// the PCI bus driver needs to include requests for 64 bit\r
+/// memory address in the corresponding 32 bit memory pool.\r
+///\r
#define EFI_PCI_HOST_BRIDGE_MEM64_DECODE 2\r
\r
typedef UINT64 EFI_RESOURCE_ALLOCATION_STATUS;\r
// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE\r
//\r
typedef enum {\r
+ ///\r
+ /// Reset the host bridge PCI apertures and internal data structures.\r
+ /// PCI enumerator should issue this notification before starting fresh\r
+ /// enumeration process. Enumeration cannot be restarted after sending\r
+ /// any other notification such as EfiPciHostBridgeBeginBusAllocation.\r
+ ///\r
EfiPciHostBridgeBeginEnumeration,\r
+\r
+ ///\r
+ /// The bus allocation phase is about to begin. No specific action\r
+ /// is required here. This notification can be used to perform any\r
+ /// chipset specific programming. \r
+ ///\r
EfiPciHostBridgeBeginBusAllocation,\r
+\r
+ ///\r
+ /// The bus allocation and bus programming phase is complete. No specific\r
+ /// action is required here. This notification can be used to perform any\r
+ /// chipset specific programming. \r
+ ///\r
EfiPciHostBridgeEndBusAllocation,\r
+ \r
+ ///\r
+ /// The resource allocation phase is about to begin.No specific action is\r
+ /// required here. This notification can be used to perform any chipset specific programming. \r
+ ///\r
EfiPciHostBridgeBeginResourceAllocation,\r
+ \r
+ ///\r
+ /// Allocate resources per previously submitted requests for all the PCI Root\r
+ /// Bridges. These resource settings are returned on the next call to\r
+ /// GetProposedResources(). \r
+ ///\r
EfiPciHostBridgeAllocateResources,\r
+ \r
+ ///\r
+ /// Program the Host Bridge hardware to decode previously allocated resources\r
+ /// (proposed resources) for all the PCI Root Bridges.\r
+ ///\r
EfiPciHostBridgeSetResources,\r
+ \r
+ ///\r
+ /// De-allocate previously allocated resources previously for all the PCI\r
+ /// Root Bridges and reset the I/O and memory apertures to initial state. \r
+ ///\r
EfiPciHostBridgeFreeResources,\r
+ \r
+ ///\r
+ /// The resource allocation phase is completed. No specific action is required\r
+ /// here. This notification can be used to perform any chipset specific programming. \r
+ ///\r
EfiPciHostBridgeEndResourceAllocation\r
} EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE;\r
\r
-//\r
-// EfiPciHostBridgeBeginEnumeration\r
-// Reset the host bridge PCI apertures and internal data structures.\r
-// PCI enumerator should issue this notification before starting fresh\r
-// enumeration process. Enumeration cannot be restarted after sending\r
-// any other notification such as EfiPciHostBridgeBeginBusAllocation.\r
-//\r
-// EfiPciHostBridgeBeginBusAllocation\r
-// The bus allocation phase is about to begin. No specific action\r
-// is required here. This notification can be used to perform any\r
-// chipset specific programming.\r
-//\r
-// EfiPciHostBridgeEndBusAllocation\r
-// The bus allocation and bus programming phase is complete. No specific\r
-// action is required here. This notification can be used to perform any\r
-// chipset specific programming.\r
-//\r
-// EfiPciHostBridgeBeginResourceAllocation\r
-// The resource allocation phase is about to begin.No specific action is\r
-// required here. This notification can be used to perform any chipset specific programming.\r
-//\r
-// EfiPciHostBridgeAllocateResources\r
-// Allocate resources per previously submitted requests for all the PCI Root\r
-// Bridges. These resource settings are returned on the next call to\r
-// GetProposedResources().\r
-//\r
-// EfiPciHostBridgeSetResources\r
-// Program the Host Bridge hardware to decode previously allocated resources\r
-// (proposed resources) for all the PCI Root Bridges.\r
-//\r
-// EfiPciHostBridgeFreeResources\r
-// De-allocate previously allocated resources previously for all the PCI\r
-// Root Bridges and reset the I/O and memory apertures to initial state.\r
-//\r
-// EfiPciHostBridgeEndResourceAllocation\r
-// The resource allocation phase is completed. No specific action is required\r
-// here. This notification can be used to perform any chipset specific programming.\r
-\r
-\r
-\r
-//\r
-// EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE\r
-//\r
+///\r
+/// EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE\r
+///\r
typedef enum {\r
+ ///\r
+ /// This notification is only applicable to PCI-PCI bridges and\r
+ /// indicates that the PCI enumerator is about to begin enumerating\r
+ /// the bus behind the PCI-PCI Bridge. This notification is sent after\r
+ /// the primary bus number, the secondary bus number and the subordinate\r
+ /// bus number registers in the PCI-PCI Bridge are programmed to valid\r
+ /// (not necessary final) values\r
+ ///\r
EfiPciBeforeChildBusEnumeration,\r
+\r
+ ///\r
+ /// This notification is sent before the PCI enumerator probes BAR registers\r
+ /// for every valid PCI function. \r
+ ///\r
EfiPciBeforeResourceCollection\r
} EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE;\r
\r
-//\r
-// EfiPciBeforeChildBusEnumeration\r
-// This notification is only applicable to PCI-PCI bridges and\r
-// indicates that the PCI enumerator is about to begin enumerating\r
-// the bus behind the PCI-PCI Bridge. This notification is sent after\r
-// the primary bus number, the secondary bus number and the subordinate\r
-// bus number registers in the PCI-PCI Bridge are programmed to valid\r
-// (not necessary final) values\r
-//\r
-// EfiPciBeforeResourceCollection\r
-// This notification is sent before the PCI enumerator probes BAR registers\r
-// for every valid PCI function.\r
-//\r
-\r
-\r
/**\r
Enter a certain phase of the PCI enumeration process\r
\r
);\r
\r
/**\r
- @par Protocol Description:\r
Provides the basic interfaces to abstract a PCI host bridge resource allocation.\r
-\r
- @param NotifyPhase\r
- The notification from the PCI bus enumerator that it is about to enter\r
- a certain phase during the enumeration process.\r
-\r
- @param GetNextRootBridge\r
- Retrieves the device handle for the next PCI root bridge that is produced by the\r
- host bridge to which this instance of the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is attached.\r
-\r
- @param GetAllocAttributes\r
- Retrieves the allocation-related attributes of a PCI root bridge.\r
-\r
- @param StartBusEnumeration\r
- Sets up a PCI root bridge for bus enumeration.\r
-\r
- @param SetBusNumbers\r
- Sets up the PCI root bridge so that it decodes a specific range of bus numbers.\r
-\r
- @param SubmitResources\r
- Submits the resource requirements for the specified PCI root bridge.\r
-\r
- @param GetProposedResources\r
- Returns the proposed resource assignment for the specified PCI root bridges.\r
-\r
- @param PreprocessController\r
- Provides hooks from the PCI bus driver to every PCI controller\r
- (device/function) at various stages of the PCI enumeration process that\r
- allow the host bridge driver to preinitialize individual PCI controllers\r
- before enumeration.\r
-\r
**/\r
struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL {\r
+ ///\r
+ /// The notification from the PCI bus enumerator that it is about to enter\r
+ /// a certain phase during the enumeration process.\r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_NOTIFY_PHASE NotifyPhase;\r
+ \r
+ ///\r
+ /// Retrieves the device handle for the next PCI root bridge that is produced by the\r
+ /// host bridge to which this instance of the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is attached. \r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_NEXT_ROOT_BRIDGE GetNextRootBridge;\r
+ \r
+ ///\r
+ /// Retrieves the allocation-related attributes of a PCI root bridge.\r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_ATTRIBUTES GetAllocAttributes;\r
+ \r
+ ///\r
+ /// Sets up a PCI root bridge for bus enumeration.\r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_START_BUS_ENUMERATION StartBusEnumeration;\r
+ \r
+ ///\r
+ /// Sets up the PCI root bridge so that it decodes a specific range of bus numbers.\r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_SET_BUS_NUMBERS SetBusNumbers;\r
+ \r
+ ///\r
+ /// Submits the resource requirements for the specified PCI root bridge.\r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_SUBMIT_RESOURCES SubmitResources;\r
+ \r
+ ///\r
+ /// Returns the proposed resource assignment for the specified PCI root bridges.\r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_PROPOSED_RESOURCES GetProposedResources;\r
+ \r
+ ///\r
+ /// Provides hooks from the PCI bus driver to every PCI controller\r
+ /// (device/function) at various stages of the PCI enumeration process that\r
+ /// allow the host bridge driver to preinitialize individual PCI controllers\r
+ /// before enumeration. \r
+ ///\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_PREPROCESS_CONTROLLER PreprocessController;\r
};\r
\r
projects / mirror_edk2.git / blobdiff