Update header file comments.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Library / PciIncompatibleDeviceSupportLib.h

/** @file\r
  PCI Incompatible device support Libary. Platform can implement an \r
  instance to support the incompatible PCI devices.\r
\r
Copyright (c) 2006 - 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
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.  \r
\r
**/\r
\r
#ifndef __PCI_INCOMPATIBLE_DEVICE_SUPPORT_LIB_H__\r
#define __PCI_INCOMPATIBLE_DEVICE_SUPPORT_LIB_H__\r
\r
#define PCI_REGISTER_READ    0xfffffffffffffff1ULL\r
#define PCI_REGISTER_WRITE   0xfffffffffffffff2ULL\r
#define VALUE_NOCARE         0xffffffffffffffffULL\r
\r
//\r
// PCI device device information\r
//\r
typedef struct {\r
  UINT64              VendorID;\r
  UINT64              DeviceID;\r
  UINT64              RevisionID;\r
  UINT64              SubsystemVendorID;\r
  UINT64              SubsystemID;\r
} EFI_PCI_DEVICE_INFO;\r
\r
\r
//\r
// store hardcode value of resgister\r
//\r
typedef struct {\r
  UINT64              AndValue;\r
  UINT64              OrValue;\r
} EFI_PCI_REGISTER_VALUE_DATA;\r
\r
//\r
// store access width information\r
//\r
typedef struct {\r
  UINT64              StartOffset;\r
  UINT64              EndOffset;\r
  UINT64              Width;\r
} EFI_PCI_REGISTER_ACCESS_DATA;\r
\r
\r
//\r
// ACPI resource descriptor\r
//\r
typedef struct {\r
  UINT64  ResType;\r
  UINT64  GenFlag;\r
  UINT64  SpecificFlag;\r
  UINT64  AddrSpaceGranularity;\r
  UINT64  AddrRangeMin;\r
  UINT64  AddrRangeMax;\r
  UINT64  AddrTranslationOffset;\r
  UINT64  AddrLen;\r
} EFI_PCI_RESOUCE_DESCRIPTOR;\r
\r
/**\r
  Checks the incompatible device list for ACPI resource update and return\r
  the configuration.\r
\r
  This function searches the incompatible device list according to request\r
  information. If the PCI device belongs to the devices list, corresponding\r
  configuration informtion will be returned, in the meantime return EFI_SUCCESS.\r
\r
  @param  PciDeviceInfo       A pointer to PCI device information.\r
  @param  Configuration       Returned information.\r
\r
  @retval EFI_SUCCESS         The incompatible device is supported.\r
  @retval EFI_UNSUPPORTED     The incompatible device is not supported.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PciResourceUpdateCheck (\r
  IN  EFI_PCI_DEVICE_INFO           *PciDeviceInfo,\r
  OUT VOID                          *Configuration\r
  );\r
\r
/**\r
  Checks the incompatible device list and return configuration register mask values.\r
\r
  This function searches the incompatible device list according to request\r
  information. If the PCI device belongs to the devices list, corresponding\r
  configuration informtion will be returned, in the meantime return EFI_SUCCESS.\r
\r
  @param  PciDeviceInfo       A pointer to EFI_PCI_DEVICE_INFO.\r
  @param  AccessType          Access Type, READ or WRITE.\r
  @param  Offset              The address within the PCI configuration space.\r
  @param  Configuration       Returned information.\r
\r
  @retval EFI_SUCCESS         The incompatible device is supported.\r
  @retval EFI_UNSUPPORTED     The incompatible device is not supported.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PciRegisterUpdateCheck (\r
  IN  EFI_PCI_DEVICE_INFO           *PciDeviceInfo,\r
  IN  UINT64                        AccessType,\r
  IN  UINT64                        Offset,\r
  OUT VOID                          *Configuration\r
  );\r
\r
/**\r
  Checks the incompatible device list for access width incompatibility and\r
  return the configuration\r
\r
  This function searches the incompatible device list for access width\r
  incompatibility according to request information. If the PCI device\r
  belongs to the devices list, corresponding configuration informtion\r
  will be returned, in the meantime return EFI_SUCCESS.\r
\r
  @param  PciDeviceInfo       A pointer to PCI device information.\r
  @param  AccessType          Access type, READ or WRITE.\r
  @param  Offset              The address within the PCI configuration space.\r
  @param  AccessWidth         Access width needs to check incompatibility.\r
  @param  Configuration       Returned information.\r
\r
  @retval EFI_SUCCESS         The incompatible device is supported.\r
  @retval EFI_UNSUPPORTED     The incompatible device is not supported.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PciRegisterAccessCheck (\r
  IN  EFI_PCI_DEVICE_INFO           *PciDeviceInfo,\r
  IN  UINT64                        AccessType,\r
  IN  UINT64                        Offset,\r
  IN  UINT64                        AccessWidth,\r
  OUT VOID                          *Configuration\r
  );\r
\r
#endif\r
\r