MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h

   1 /** @file
   2   This file declares EFI Incompatible PCI Device Support Protocol
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  IncompatiblePciDeviceSupport.h
  14
  15   @par Revision Reference:
  16   This protocol is defined in Framework of EFI PCI Platform Support Specification.
  17   Version0.9
  18
  19 **/
  20
  21 #ifndef _INCOMPATIBLE_PCI_DEVICE_SUPPORT_H_
  22 #define _INCOMPATIBLE_PCI_DEVICE_SUPPORT_H_
  23
  24 #define EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL_GUID \
  25         {0xeb23f55a, 0x7863, 0x4ac2, {0x8d, 0x3d, 0x95, 0x65, 0x35, 0xde, 0x03, 0x75} }
  26
  27 typedef struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL;
  28
  29 /**
  30   Returns a list of ACPI resource descriptors that detail the special
  31   resource configuration requirements for an incompatible PCI device.
  32
  33   @param  This                  Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance.
  34   @param  VendorID              A unique ID to identify the manufacturer of the PCI device.
  35   @param  DeviceID              A unique ID to identify the particular PCI device.
  36   @param  RevisionID            A PCI device-specific revision identifier.
  37   @param  SubsystemVendorId     Specifies the subsystem vendor ID.
  38   @param  SubsystemDeviceId     Specifies the subsystem device ID.
  39   @param  Configuration         A list of ACPI resource descriptors that detail
  40                                 the configuration requirement.
  41
  42   @retval EFI_SUCCESS           The function always returns EFI_SUCCESS.
  43
  44 **/
  45 typedef
  46 EFI_STATUS
  47 (EFIAPI *EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_CHECK_DEVICE) (
  48   IN EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL   *This,
  49   IN  UINTN                                         VendorId,
  50   IN  UINTN                                         DeviceId,
  51   IN  UINTN                                         Revision,
  52   IN  UINTN                                         SubVendorId,OPTIONAL
  53   IN  UINTN                                         SubDeviceId,OPTIONAL
  54   OUT VOID                                          **Configuration
  55 );
  56
  57
  58 //
  59 // Interface structure for the Incompatible PCI Device Support Protocol
  60 //
  61 /**
  62   @par Protocol Description:
  63   This protocol can find some incompatible PCI devices and report their
  64   special resource requirements to the PCI bus driver.
  65
  66   @param CheckDevice
  67   Returns a list of ACPI resource descriptors that detail any special
  68   resource configuration requirements if the specified device is a recognized
  69   incompatible PCI device.
  70
  71 **/
  72 struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL {
  73   EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_CHECK_DEVICE      CheckDevice;
  74 };
  75
  76 extern EFI_GUID gEfiIncompatiblePciDeviceSupportProtocolGuid;
  77
  78 #endif