make the comment parameter be consistent with the function parameter.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / IncompatiblePciDeviceSupport.h

diff --git a/IntelFrameworkPkg/Include/Protocol/IncompatiblePciDeviceSupport.h b/IntelFrameworkPkg/Include/Protocol/IncompatiblePciDeviceSupport.h
index c684f15531b0fbaa1a3c8c956f210bd11f1be04d..b84884c119a7aaf2bf37063f8637900587eebcbc 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/IncompatiblePciDeviceSupport.h
+++ b/IntelFrameworkPkg/Include/Protocol/IncompatiblePciDeviceSupport.h
@@ -1,5 +1,19 @@
 /** @file\r
   This file declares EFI Incompatible PCI Device Support Protocol\r
+  This protocol allows the PCI bus driver to support resource allocation for some PCI devices that do not comply\r
+  with the PCI Specification.\r
+  The EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL is used by the PCI bus driver\r
+  to support resource allocation for some PCI devices that do not comply with the PCI Specification.\r
+  This protocol can find some incompatible PCI devices and report their special resource\r
+  requirements to the PCI bus driver. The generic PCI bus driver does not have prior knowledge of\r
+  any incompatible PCI devices. It interfaces with the\r
+  EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL to find out if a device is\r
+  incompatible and to obtain the special configuration requirements for a specific incompatible PCI\r
+  device.\r
+  This protocol is optional, and only one instance of this protocol can be present in the system. If a\r
+  platform supports this protocol, this protocol is produced by a Driver Execution Environment\r
+  (DXE) driver and must be made available before the Boot Device Selection (BDS) phase. The PCI\r
+  bus driver will look for the presence of this protocol before it begins PCI enumeration.\r
 \r
   Copyright (c) 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -21,6 +35,8 @@
 #ifndef _INCOMPATIBLE_PCI_DEVICE_SUPPORT_H_\r
 #define _INCOMPATIBLE_PCI_DEVICE_SUPPORT_H_\r
 \r
+#include <PiDxe.h>\r
+\r
 #define EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL_GUID \\r
         {0xeb23f55a, 0x7863, 0x4ac2, {0x8d, 0x3d, 0x95, 0x65, 0x35, 0xde, 0x03, 0x75} }\r
 \r
@@ -44,7 +60,7 @@ typedef struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL EFI_INCOMPATIBLE_PC
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_CHECK_DEVICE) (\r
+(EFIAPI *EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_CHECK_DEVICE)(\r
   IN EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL   *This,\r
   IN  UINTN                                         VendorId,\r
   IN  UINTN                                         DeviceId,\r