]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciCommand.c
Retired PciIncompatibleDeviceSupportLib from IntelFrameworkModulePkg.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciCommand.c
index 13d459b86450420d8d41716756fae227dfff8528..39f5271e9bc142c172692b2886567475d87e2485 100644 (file)
@@ -1,19 +1,31 @@
-/**@file\r
+/** @file\r
+  PCI command register operations supporting functions implementation for PCI Bus module.\r
 \r
-Copyright (c) 2006, 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
+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
+#include "PciBus.h"\r
+\r
+/**\r
+  Operate the PCI register via PciIo function interface.\r
 \r
-#include "pcibus.h"\r
+  @param PciIoDevice    Pointer to instance of PCI_IO_DEVICE.\r
+  @param Command        Operator command.\r
+  @param Offset         The address within the PCI configuration space for the PCI controller.\r
+  @param Operation      Type of Operation.\r
+  @param PtrCommand     Return buffer holding old PCI command, if operation is not EFI_SET_REGISTER.\r
 \r
+  @return Status of PciIo operation.\r
+\r
+**/\r
 EFI_STATUS\r
 PciOperateRegister (\r
   IN  PCI_IO_DEVICE *PciIoDevice,\r
@@ -22,22 +34,6 @@ PciOperateRegister (
   IN  UINT8         Operation,\r
   OUT UINT16        *PtrCommand\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
-  None\r
-\r
-**/\r
-// TODO:    PciIoDevice - add argument and description to function comment\r
-// TODO:    Command - add argument and description to function comment\r
-// TODO:    Offset - add argument and description to function comment\r
-// TODO:    Operation - add argument and description to function comment\r
-// TODO:    PtrCommand - add argument and description to function comment\r
 {\r
   UINT16              OldCommand;\r
   EFI_STATUS          Status;\r
@@ -47,13 +43,13 @@ Returns:
   PciIo       = &PciIoDevice->PciIo;\r
 \r
   if (Operation != EFI_SET_REGISTER) {\r
-    Status = PciIoRead (\r
-                         PciIo,\r
-                         EfiPciIoWidthUint16,\r
-                         Offset,\r
-                         1,\r
-                         &OldCommand\r
-                        );\r
+    Status = PciIo->Pci.Read (\r
+                          PciIo,\r
+                          EfiPciIoWidthUint16,\r
+                          Offset,\r
+                          1,\r
+                          &OldCommand\r
+                          );\r
 \r
     if (Operation == EFI_GET_REGISTER) {\r
       *PtrCommand = OldCommand;\r
@@ -69,40 +65,49 @@ Returns:
     OldCommand = Command;\r
   }\r
 \r
-  return PciIoWrite (\r
+  return PciIo->Pci.Write (\r
                       PciIo,\r
                       EfiPciIoWidthUint16,\r
                       Offset,\r
                       1,\r
                       &OldCommand\r
-                    );\r
+                      );\r
 }\r
 \r
-BOOLEAN\r
-PciCapabilitySupport (\r
-  IN PCI_IO_DEVICE  *PciIoDevice\r
-  )\r
 /**\r
+  Check the cpability supporting by given device.\r
 \r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
+  @param PciIoDevice   Pointer to instance of PCI_IO_DEVICE.\r
 \r
-  None\r
+  @retval TRUE         Cpability supportted.\r
+  @retval FALSE        Cpability not supportted.\r
 \r
 **/\r
-// TODO:    PciIoDevice - add argument and description to function comment\r
+BOOLEAN\r
+PciCapabilitySupport (\r
+  IN PCI_IO_DEVICE  *PciIoDevice\r
+  )\r
 {\r
-\r
-  if (PciIoDevice->Pci.Hdr.Status & EFI_PCI_STATUS_CAPABILITY) {\r
+  if ((PciIoDevice->Pci.Hdr.Status & EFI_PCI_STATUS_CAPABILITY) != 0) {\r
     return TRUE;\r
   }\r
 \r
   return FALSE;\r
 }\r
 \r
+/**\r
+  Locate capability register block per capability ID.\r
+\r
+  @param PciIoDevice       A pointer to the PCI_IO_DEVICE.\r
+  @param CapId             The capability ID.\r
+  @param Offset            A pointer to the offset returned.\r
+  @param NextRegBlock      A pointer to the next block returned.\r
+\r
+  @retval EFI_SUCCESS      Successfuly located capability register block.\r
+  @retval EFI_UNSUPPORTED  Pci device does not support capability.\r
+  @retval EFI_NOT_FOUND    Pci device support but can not find register block.\r
+\r
+**/\r
 EFI_STATUS\r
 LocateCapabilityRegBlock (\r
   IN PCI_IO_DEVICE  *PciIoDevice,\r
@@ -110,25 +115,6 @@ LocateCapabilityRegBlock (
   IN OUT UINT8      *Offset,\r
   OUT UINT8         *NextRegBlock OPTIONAL\r
   )\r
-/**\r
-\r
-Routine Description:\r
-  Locate cap reg.\r
-\r
-Arguments:\r
-  PciIoDevice         - A pointer to the PCI_IO_DEVICE.\r
-  CapId               - The cap ID.\r
-  Offset              - A pointer to the offset.\r
-  NextRegBlock        - A pointer to the next block.\r
-\r
-Returns:\r
-\r
-  None\r
-\r
-**/\r
-// TODO:    EFI_UNSUPPORTED - add return value to function comment\r
-// TODO:    EFI_SUCCESS - add return value to function comment\r
-// TODO:    EFI_NOT_FOUND - add return value to function comment\r
 {\r
   UINT8   CapabilityPtr;\r
   UINT16  CapabilityEntry;\r
@@ -148,37 +134,33 @@ Returns:
     CapabilityPtr = 0;\r
     if (IS_CARDBUS_BRIDGE (&PciIoDevice->Pci)) {\r
 \r
-      PciIoRead (\r
-                  &PciIoDevice->PciIo,\r
-                  EfiPciIoWidthUint8,\r
-                  EFI_PCI_CARDBUS_BRIDGE_CAPABILITY_PTR,\r
-                  1,\r
-                  &CapabilityPtr\r
-                );\r
+      PciIoDevice->PciIo.Pci.Read (\r
+                               &PciIoDevice->PciIo,\r
+                               EfiPciIoWidthUint8,\r
+                               EFI_PCI_CARDBUS_BRIDGE_CAPABILITY_PTR,\r
+                               1,\r
+                               &CapabilityPtr\r
+                               );\r
     } else {\r
 \r
-      PciIoRead (\r
-                  &PciIoDevice->PciIo,\r
-                  EfiPciIoWidthUint8,\r
-                  EFI_PCI_CAPABILITY_PTR,\r
-                  1,\r
-                  &CapabilityPtr\r
-                );\r
+      PciIoDevice->PciIo.Pci.Read (\r
+                               &PciIoDevice->PciIo,\r
+                               EfiPciIoWidthUint8,\r
+                               PCI_CAPBILITY_POINTER_OFFSET,\r
+                               1,\r
+                               &CapabilityPtr\r
+                               );\r
     }\r
   }\r
 \r
-  while (CapabilityPtr > 0x3F) {\r
-    //\r
-    // Mask it to DWORD alignment per PCI spec\r
-    //\r
-    CapabilityPtr &= 0xFC;\r
-    PciIoRead (\r
-                &PciIoDevice->PciIo,\r
-                EfiPciIoWidthUint16,\r
-                CapabilityPtr,\r
-                1,\r
-                &CapabilityEntry\r
-              );\r
+  while ((CapabilityPtr >= 0x40) && ((CapabilityPtr & 0x03) == 0x00)) {\r
+    PciIoDevice->PciIo.Pci.Read (\r
+                             &PciIoDevice->PciIo,\r
+                             EfiPciIoWidthUint16,\r
+                             CapabilityPtr,\r
+                             1,\r
+                             &CapabilityEntry\r
+                             );\r
 \r
     CapabilityID = (UINT8) CapabilityEntry;\r
 \r
@@ -196,3 +178,4 @@ Returns:
 \r
   return EFI_NOT_FOUND;\r
 }\r
+\r