X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkModulePkg%2FBus%2FPci%2FPciBusDxe%2FPciEnumeratorSupport.h;h=1900990a15f8eeb5421796a4cff8d59fb64afa0d;hb=eeefcb9d4bbe0282ce9efeba838596e9c5a2f809;hp=ab46b5ac8a48f7a74d7714561e8938659547c4ca;hpb=ed66e1bc0d2be0a185fc47adab4930c3b7e2767f;p=mirror_edk2.git diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h index ab46b5ac8a..1900990a15 100644 --- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h +++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h @@ -1,4 +1,4 @@ -/**@file +/** @file Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials @@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ -#ifndef _EFI_PCI_ENUMERATOR_SUPPORT_H -#define _EFI_PCI_ENUMERATOR_SUPPORT_H +#ifndef _EFI_PCI_ENUMERATOR_SUPPORT_H_ +#define _EFI_PCI_ENUMERATOR_SUPPORT_H_ /** This routine is used to check whether the pci device is present. @@ -42,7 +42,7 @@ PciDevicePresent ( root bridge will then be created. @param Bridge Parent bridge instance - @param StartBusNumer Bus number of begining + @param StartBusNumber Bus number of begining **/ EFI_STATUS PciPciDeviceInfoCollector ( @@ -62,12 +62,12 @@ PciPciDeviceInfoCollector ( **/ EFI_STATUS PciSearchDevice ( - IN PCI_IO_DEVICE *Bridge, - PCI_TYPE00 *Pci, - UINT8 Bus, - UINT8 Device, - UINT8 Func, - PCI_IO_DEVICE **PciDevice + IN PCI_IO_DEVICE *Bridge, + IN PCI_TYPE00 *Pci, + IN UINT8 Bus, + IN UINT8 Device, + IN UINT8 Func, + OUT PCI_IO_DEVICE **PciDevice ); /** @@ -99,7 +99,7 @@ GatherDeviceInfo ( @param Device Bridge device's device NO. @param Func Bridge device's func NO. - @return bridge device instance + @return bridge device instance. **/ PCI_IO_DEVICE * GatherPpbInfo ( @@ -133,8 +133,8 @@ GatherP2CInfo ( /** Create device path for pci deivce - @param ParentDevicePath Parent bridge's path - @param PciIoDevice Pci device instance + @param ParentDevicePath Parent bridge's path. + @param PciIoDevice Pci device instance. @return device path protocol instance for specific pci device. **/ @@ -173,7 +173,7 @@ BarExisted ( @param OldCommand Old command register offset @param OldBridgeControl Old Bridge control value for PPB or P2C. - @return EFI_SUCCESS + @return EFI_SUCCESS. **/ EFI_STATUS PciTestSupportedAttribute ( @@ -204,8 +204,8 @@ PciSetDeviceAttribute ( /** Determine if the device can support Fast Back to Back attribute - @param PciIoDevice Pci device instance - @param StatusIndex Status register value + @param PciIoDevice Pci device instance. + @param StatusIndex Status register value. **/ EFI_STATUS GetFastBackToBackSupport ( @@ -216,7 +216,7 @@ GetFastBackToBackSupport ( /** Determine the related attributes of all devices under a Root Bridge - @param PciIoDevice PCI device instance + @param PciIoDevice PCI device instance. **/ EFI_STATUS @@ -227,8 +227,8 @@ DetermineDeviceAttribute ( /** This routine is used to update the bar information for those incompatible PCI device - @param PciIoDevice Pci device instance - @return EFI_UNSUPPORTED failed to update Pci Info + @param PciIoDevice Pci device instance. + @return EFI_UNSUPPORTED failed to update Pci Info. **/ EFI_STATUS UpdatePciInfo ( @@ -238,8 +238,8 @@ UpdatePciInfo ( /** This routine will update the alignment with the new alignment - @param Alignment old alignment - @param NewAlignment new alignment + @param Alignment old alignment. + @param NewAlignment new alignment. **/ VOID @@ -251,9 +251,9 @@ SetNewAlign ( /** Parse PCI bar bit. - @param PciIoDevice Pci device instance - @param Offset bar offset - @param BarIndex bar index + @param PciIoDevice Pci device instance. + @param Offset bar offset. + @param BarIndex bar index. @return next bar offset. **/ @@ -266,9 +266,9 @@ PciParseBar ( /** This routine is used to initialize the bar of a PCI device - It can be called typically when a device is going to be rejected + It can be called typically when a device is going to be rejected. - @param PciIoDevice Pci device instance + @param PciIoDevice Pci device instance. **/ EFI_STATUS InitializePciDevice ( @@ -278,7 +278,7 @@ InitializePciDevice ( /** Init PPB for bridge device - @param PciIoDevice Pci device instance + @param PciIoDevice Pci device instance. **/ EFI_STATUS InitializePpb ( @@ -288,7 +288,7 @@ InitializePpb ( /** Init private data for Hotplug bridge device - @param PciIoDevice hotplug bridge device + @param PciIoDevice hotplug bridge device. **/ EFI_STATUS InitializeP2C ( @@ -299,13 +299,13 @@ InitializeP2C ( Create and initiliaze general PCI I/O device instance for PCI device/bridge device/hotplug bridge device. - @param PciRootBridgeIo Pointer to instance of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL + @param PciRootBridgeIo Pointer to instance of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Pci Pci bar block @param Bus device Bus NO. @param Device device device NO. @param Func device func NO. - @return instance of PCI device + @return instance of PCI device. **/ PCI_IO_DEVICE * CreatePciIoDevice ( @@ -321,7 +321,7 @@ CreatePciIoDevice ( in a given platform It is only called on the second start on the same Root Bridge. - @param Controller Parent bridge handler + @param Controller Parent bridge handler. @return status of operation. **/ @@ -349,6 +349,14 @@ PciGetBusRange ( OUT UINT16 *BusRange ); +/** + This routine can be used to start the root bridge. + + @param RootBridgeDev Pci device instance. + + @retval EFI_SUCCESS This device started. + +**/ EFI_STATUS StartManagingRootBridge ( IN PCI_IO_DEVICE *RootBridgeDev @@ -357,10 +365,10 @@ StartManagingRootBridge ( /** This routine can be used to check whether a PCI device should be rejected when light enumeration - @param PciIoDevice Pci device instance + @param PciIoDevice Pci device instance. - @retval TRUE This device should be rejected - @retval FALSE This device shouldn't be rejected + @retval TRUE This device should be rejected. + @retval FALSE This device shouldn't be rejected. **/ BOOLEAN