diff options
Diffstat (limited to 'IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c')
| -rw-r--r-- | IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c | 119 |
1 files changed, 63 insertions, 56 deletions
diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c index d7f7cc77ea..fd8eaf4325 100644 --- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c +++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c @@ -47,9 +47,9 @@ InstallHotPlugRequestProtocol ( /**
Install protocol gEfiPciHotplugDeviceGuid into hotplug device
- instance
+ instance.
- @param PciIoDevice hotplug device instance
+ @param PciIoDevice hotplug device instance.
**/
VOID
@@ -77,9 +77,9 @@ InstallPciHotplugGuid ( /**
UnInstall protocol gEfiPciHotplugDeviceGuid into hotplug device
- instance
+ instance.
- @param PciIoDevice hotplug device instance
+ @param PciIoDevice hotplug device instance.
**/
VOID
@@ -116,9 +116,9 @@ UninstallPciHotplugGuid ( }
/**
- Retrieve the BAR information via PciIo interface
+ Retrieve the BAR information via PciIo interface.
- @param PciIoDevice Pci device instance
+ @param PciIoDevice Pci device instance.
**/
VOID
GetBackPcCardBar (
@@ -196,8 +196,8 @@ GetBackPcCardBar ( Remove rejected pci device from specific root bridge
handle.
- @param RootBridgeHandle specific parent root bridge handle
- @param Bridge Bridge device instance
+ @param RootBridgeHandle specific parent root bridge handle.
+ @param Bridge Bridge device instance.
@retval EFI_SUCCESS Success operation.
**/
@@ -261,7 +261,7 @@ RemoveRejectedPciDevices ( /**
Wrapper function for allocating resource for pci host bridge.
- @param PciResAlloc Point to protocol instance EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
+ @param PciResAlloc Point to protocol instance EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
**/
EFI_STATUS
@@ -281,11 +281,11 @@ PciHostBridgeResourceAllocator ( }
/**
- Submits the I/O and memory resource requirements for the specified PCI Root Bridge
+ Submits the I/O and memory resource requirements for the specified PCI Root Bridge.
- @param PciResAlloc Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
+ @param PciResAlloc Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
- @retval EFI_SUCCESS Success
+ @retval EFI_SUCCESS Success.
**/
EFI_STATUS
PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (
@@ -644,11 +644,11 @@ PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport ( }
/**
- Submits the I/O and memory resource requirements for the specified PCI Root Bridge
+ Submits the I/O and memory resource requirements for the specified PCI Root Bridge.
- @param PciResAlloc Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
+ @param PciResAlloc Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
- @retval EFI_SUCCESS Success
+ @retval EFI_SUCCESS Success.
**/
EFI_STATUS
PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (
@@ -1138,15 +1138,15 @@ PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport ( /**
Wapper function of scanning pci bus and assign bus number to the given PCI bus system
- Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug
+ Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.
- @param Bridge Bridge device instance
- @param StartBusNumber start point
- @param SubBusNumber Point to sub bus number
- @param PaddedBusRange Customized bus number
+ @param Bridge Bridge device instance.
+ @param StartBusNumber start point.
+ @param SubBusNumber Point to sub bus number.
+ @param PaddedBusRange Customized bus number.
- @retval EFI_SUCCESS Success
- @retval EFI_DEVICE_ERROR Fail to scan bus
+ @retval EFI_SUCCESS Success.
+ @retval EFI_DEVICE_ERROR Fail to scan bus.
**/
EFI_STATUS
PciScanBus (
@@ -1175,15 +1175,15 @@ PciScanBus ( /**
Wapper function of scanning pci bus and assign bus number to the given PCI bus system
- Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug
+ Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.
- @param Bridge Bridge device instance
- @param StartBusNumber start point
- @param SubBusNumber Point to sub bus number
- @param PaddedBusRange Customized bus number
+ @param Bridge Bridge device instance.
+ @param StartBusNumber start point.
+ @param SubBusNumber Point to sub bus number.
+ @param PaddedBusRange Customized bus number.
- @retval EFI_SUCCESS Success
- @retval EFI_DEVICE_ERROR Fail to scan bus
+ @retval EFI_SUCCESS Success.
+ @retval EFI_DEVICE_ERROR Fail to scan bus.
**/
EFI_STATUS
PciScanBus_WithoutHotPlugDeviceSupport (
@@ -1353,15 +1353,15 @@ PciScanBus_WithoutHotPlugDeviceSupport ( /**
Wapper function of scanning pci bus and assign bus number to the given PCI bus system
- Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug
+ Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.
- @param Bridge Bridge device instance
- @param StartBusNumber start point
- @param SubBusNumber Point to sub bus number
- @param PaddedBusRange Customized bus number
+ @param Bridge Bridge device instance.
+ @param StartBusNumber start point.
+ @param SubBusNumber Point to sub bus number.
+ @param PaddedBusRange Customized bus number.
- @retval EFI_SUCCESS Success
- @retval EFI_DEVICE_ERROR Fail to scan bus
+ @retval EFI_SUCCESS Success.
+ @retval EFI_DEVICE_ERROR Fail to scan bus.
**/
EFI_STATUS
PciScanBus_WithHotPlugDeviceSupport (
@@ -1642,11 +1642,11 @@ PciScanBus_WithHotPlugDeviceSupport ( }
/**
- Process Option Rom on this host bridge
+ Process Option Rom on this host bridge.
- @param Bridge Pci bridge device instance
+ @param Bridge Pci bridge device instance.
- @retval EFI_SUCCESS Success
+ @retval EFI_SUCCESS Success.
**/
EFI_STATUS
PciRootBridgeP2CProcess (
@@ -1712,12 +1712,12 @@ PciRootBridgeP2CProcess ( }
/**
- Process Option Rom on this host bridge
+ Process Option Rom on this host bridge.
- @param PciResAlloc Pointer to instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
+ @param PciResAlloc Pointer to instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
- @retval EFI_NOT_FOUND Can not find the root bridge instance
- @retval EFI_SUCCESS Success process
+ @retval EFI_NOT_FOUND Can not find the root bridge instance.
+ @retval EFI_SUCCESS Success process.
**/
EFI_STATUS
PciHostBridgeP2CProcess (
@@ -1758,12 +1758,12 @@ PciHostBridgeP2CProcess ( /**
This function is used to enumerate the entire host bridge
- in a given platform
+ in a given platform.
@param PciResAlloc A pointer to the resource allocate protocol.
- @retval EFI_OUT_OF_RESOURCES no enough resource
- @retval EFI_SUCCESS Success
+ @retval EFI_OUT_OF_RESOURCES no enough resource.
+ @retval EFI_SUCCESS Success.
**/
EFI_STATUS
@@ -1998,7 +1998,7 @@ PciHostBridgeEnumerator ( @param PciIo A pointer to EFI_PCI_PROTOCOL.
@param PciDeviceInfo A pointer to EFI_PCI_DEVICE_INFO.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
@@ -2158,7 +2158,8 @@ ReadConfigData ( @param PciDeviceInfo A pointer to EFI_PCI_DEVICE_INFO.
@param AccessType Access type, READ or WRITE.
- @Param Address The address within the PCI configuration space.
+ @param Width Signifies the width of the memory operations.
+ @param Address The address within the PCI configuration space.
@param Buffer Store the register data.
@retval EFI_SUCCESS The data has been updated.
@@ -2229,7 +2230,7 @@ UpdateConfigData ( @param PciIo A pointer to EFI_PCI_PROTOCOL.
@param PciDeviceInfo A pointer to EFI_PCI_DEVICE_INFO.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
@@ -2407,7 +2408,7 @@ WriteConfigData ( @param PciRootBridgeIo A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
@param PciIo A pointer to EFI_PCI_PROTOCOL.
@param Pci A pointer to PCI_TYPE00.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
@param PciDeviceInfo A pointer to EFI_PCI_DEVICE_INFO.
@retval EFI_SUCCESS Pci device device information has been abstracted.
@@ -2508,7 +2509,8 @@ GetPciDeviceDeviceInfo ( @param PciIo A pointer to the EFI_PCI_IO_PROTOCOL.
@param Pci A pointer to PCI_TYPE00.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
+ @param Count The number of unit to be read.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
@@ -2574,7 +2576,8 @@ PciIncompatibilityCheckRead ( @param PciIo A pointer to the EFI_PCI_IO_PROTOCOL.
@param Pci A pointer to PCI_TYPE00.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
+ @param Count The number of unit to be write.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
@@ -2658,7 +2661,8 @@ PciIncompatibilityCheckWrite ( @param PciRootBridgeIo A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
@param Pci A pointer to PCI_TYPE00.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
+ @param Count The number of unit to be read.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
@@ -2708,7 +2712,8 @@ PciRootBridgeIoRead ( @param PciRootBridgeIo A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
@param Pci A pointer to PCI_TYPE00.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
+ @param Count The number of unit to be read.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
@@ -2758,7 +2763,8 @@ PciRootBridgeIoWrite ( @param PciIo A pointer to the EFI_PCI_O_PROTOCOL.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
+ @param Count The number of unit to be read.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
@@ -2806,7 +2812,8 @@ PciIoRead ( @param PciIo A pointer to the EFI_PCI_O_PROTOCOL.
@param Width Signifies the width of the memory operations.
- @Param Address The address within the PCI configuration space for the PCI controller.
+ @param Address The address within the PCI configuration space for the PCI controller.
+ @param Count The number of unit to be read.
@param Buffer For read operations, the destination buffer to store the results. For
write operations, the source buffer to write data from.
|