Due to SmBios2.6 spec section 3.3.8.5 doesn't enumerate 24-way set-associative for...

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

diff --git a/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h b/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h
index 527a704042692f3f811342eb960c4c7f1d943598..f490ae4106e5de59ee908e275ae6de676b841880 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h
@@ -1,17 +1,21 @@
 /** @file\r
-  PCI Incompatible device support Libary.\r
+  PCI Incompatible device support Libary. Platform can implement an\r
+  instance to support the incompatible PCI devices.\r
 \r
-Copyright (c) 2007 Intel Corporation. All rights reserved. <BR>\r
-This software and associated documentation (if any) is furnished\r
-under a license and may only be used or copied in accordance\r
-with the terms of the license. Except as permitted by such\r
-license, no part of this software or documentation may be\r
-reproduced, stored in a retrieval system, or transmitted in any\r
-form or by any means without the express written consent of\r
-Intel Corporation.\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
@@ -61,20 +65,23 @@ typedef struct {
 } EFI_PCI_RESOUCE_DESCRIPTOR;\r
 \r
 /**\r
-  Checks the incompatible device list for ACPI resource update and return\r
+  Check 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
+  @param  PciDeviceInfo        A pointer to PCI device information.\r
+  @param  Configuration        Returned information.\r
+\r
+  @retval EFI_SUCCESS          If check incompatible device successfully.\r
+  @retval EFI_ABORTED          No any resource type.\r
+  @retval EFI_OUT_OF_RESOURCES No memory available.\r
+  @retval EFI_UNSUPPORTED      Invalid Tag encounted.\r
 \r
-  @retval returns EFI_SUCCESS if check incompatible device ok.\r
-          Otherwise return EFI_UNSUPPORTED.\r
 **/\r
-RETURN_STATUS\r
+EFI_STATUS\r
 EFIAPI\r
 PciResourceUpdateCheck (\r
   IN  EFI_PCI_DEVICE_INFO           *PciDeviceInfo,\r
@@ -82,7 +89,7 @@ PciResourceUpdateCheck (
   );\r
 \r
 /**\r
-  Checks the incompatible device list and return configuration register mask values.\r
+  Check the incompatible device list and return configuraton 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
@@ -93,10 +100,11 @@ PciResourceUpdateCheck (
   @param  Offset              The address within the PCI configuration space.\r
   @param  Configuration       Returned information.\r
 \r
-  @retval returns EFI_SUCCESS if check incompatible device ok.\r
-          Otherwise return EFI_UNSUPPORTED.\r
+  @retval EFI_SUCCESS         If check incompatible device successfully.\r
+  @retval EFI_UNSUPPORTED     Failed to check incompatibility device.\r
+\r
 **/\r
-RETURN_STATUS\r
+EFI_STATUS\r
 EFIAPI\r
 PciRegisterUpdateCheck (\r
   IN  EFI_PCI_DEVICE_INFO           *PciDeviceInfo,\r
@@ -106,8 +114,8 @@ PciRegisterUpdateCheck (
   );\r
 \r
 /**\r
-  Checks the incompatible device list for access width incompatibility and\r
-  return the configuration\r
+  Check 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
@@ -120,10 +128,11 @@ PciRegisterUpdateCheck (
   @param  AccessWidth         Access width needs to check incompatibility.\r
   @param  Configuration       Returned information.\r
 \r
-  @retval returns EFI_SUCCESS if check incompatible device ok.\r
-          Otherwise return EFI_UNSUPPORTED.\r
+  @retval EFI_SUCCESS         If check incompatible device successfully.\r
+  @retval EFI_UNSUPPORTED     Failed to check incompatibility device.\r
+\r
 **/\r
-RETURN_STATUS\r
+EFI_STATUS\r
 EFIAPI\r
 PciRegisterAccessCheck (\r
   IN  EFI_PCI_DEVICE_INFO           *PciDeviceInfo,\r
@@ -132,3 +141,6 @@ PciRegisterAccessCheck (
   IN  UINT64                        AccessWidth,\r
   OUT VOID                          *Configuration\r
   );\r
+\r
+#endif\r
+\r