reactos/drivers/bus/acpi/acpica/hardware/hwpci.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: hwpci - Obtain PCI bus, device, and function numbers
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118
 119
 120 #define _COMPONENT          ACPI_NAMESPACE
 121         ACPI_MODULE_NAME    ("hwpci")
 122
 123
 124 /* PCI configuration space values */
 125
 126 #define PCI_CFG_HEADER_TYPE_REG             0x0E
 127 #define PCI_CFG_PRIMARY_BUS_NUMBER_REG      0x18
 128 #define PCI_CFG_SECONDARY_BUS_NUMBER_REG    0x19
 129
 130 /* PCI header values */
 131
 132 #define PCI_HEADER_TYPE_MASK                0x7F
 133 #define PCI_TYPE_BRIDGE                     0x01
 134 #define PCI_TYPE_CARDBUS_BRIDGE             0x02
 135
 136 typedef struct acpi_pci_device
 137 {
 138     ACPI_HANDLE             Device;
 139     struct acpi_pci_device  *Next;
 140
 141 } ACPI_PCI_DEVICE;
 142
 143
 144 /* Local prototypes */
 145
 146 static ACPI_STATUS
 147 AcpiHwBuildPciList (
 148     ACPI_HANDLE             RootPciDevice,
 149     ACPI_HANDLE             PciRegion,
 150     ACPI_PCI_DEVICE         **ReturnListHead);
 151
 152 static ACPI_STATUS
 153 AcpiHwProcessPciList (
 154     ACPI_PCI_ID             *PciId,
 155     ACPI_PCI_DEVICE         *ListHead);
 156
 157 static void
 158 AcpiHwDeletePciList (
 159     ACPI_PCI_DEVICE         *ListHead);
 160
 161 static ACPI_STATUS
 162 AcpiHwGetPciDeviceInfo (
 163     ACPI_PCI_ID             *PciId,
 164     ACPI_HANDLE             PciDevice,
 165     UINT16                  *BusNumber,
 166     BOOLEAN                 *IsBridge);
 167
 168
 169 /*******************************************************************************
 170  *
 171  * FUNCTION:    AcpiHwDerivePciId
 172  *
 173  * PARAMETERS:  PciId               - Initial values for the PCI ID. May be
 174  *                                    modified by this function.
 175  *              RootPciDevice       - A handle to a PCI device object. This
 176  *                                    object must be a PCI Root Bridge having a
 177  *                                    _HID value of either PNP0A03 or PNP0A08
 178  *              PciRegion           - A handle to a PCI configuration space
 179  *                                    Operation Region being initialized
 180  *
 181  * RETURN:      Status
 182  *
 183  * DESCRIPTION: This function derives a full PCI ID for a PCI device,
 184  *              consisting of a Segment number, Bus number, Device number,
 185  *              and function code.
 186  *
 187  *              The PCI hardware dynamically configures PCI bus numbers
 188  *              depending on the bus topology discovered during system
 189  *              initialization. This function is invoked during configuration
 190  *              of a PCI_Config Operation Region in order to (possibly) update
 191  *              the Bus/Device/Function numbers in the PciId with the actual
 192  *              values as determined by the hardware and operating system
 193  *              configuration.
 194  *
 195  *              The PciId parameter is initially populated during the Operation
 196  *              Region initialization. This function is then called, and is
 197  *              will make any necessary modifications to the Bus, Device, or
 198  *              Function number PCI ID subfields as appropriate for the
 199  *              current hardware and OS configuration.
 200  *
 201  * NOTE:        Created 08/2010. Replaces the previous OSL AcpiOsDerivePciId
 202  *              interface since this feature is OS-independent. This module
 203  *              specifically avoids any use of recursion by building a local
 204  *              temporary device list.
 205  *
 206  ******************************************************************************/
 207
 208 ACPI_STATUS
 209 AcpiHwDerivePciId (
 210     ACPI_PCI_ID             *PciId,
 211     ACPI_HANDLE             RootPciDevice,
 212     ACPI_HANDLE             PciRegion)
 213 {
 214     ACPI_STATUS             Status;
 215     ACPI_PCI_DEVICE         *ListHead = NULL;
 216
 217
 218     ACPI_FUNCTION_TRACE (HwDerivePciId);
 219
 220
 221     if (!PciId)
 222     {
 223         return_ACPI_STATUS (AE_BAD_PARAMETER);
 224     }
 225
 226     /* Build a list of PCI devices, from PciRegion up to RootPciDevice */
 227
 228     Status = AcpiHwBuildPciList (RootPciDevice, PciRegion, &ListHead);
 229     if (ACPI_SUCCESS (Status))
 230     {
 231         /* Walk the list, updating the PCI device/function/bus numbers */
 232
 233         Status = AcpiHwProcessPciList (PciId, ListHead);
 234
 235         /* Delete the list */
 236
 237         AcpiHwDeletePciList (ListHead);
 238     }
 239
 240     return_ACPI_STATUS (Status);
 241 }
 242
 243
 244 /*******************************************************************************
 245  *
 246  * FUNCTION:    AcpiHwBuildPciList
 247  *
 248  * PARAMETERS:  RootPciDevice       - A handle to a PCI device object. This
 249  *                                    object is guaranteed to be a PCI Root
 250  *                                    Bridge having a _HID value of either
 251  *                                    PNP0A03 or PNP0A08
 252  *              PciRegion           - A handle to the PCI configuration space
 253  *                                    Operation Region
 254  *              ReturnListHead      - Where the PCI device list is returned
 255  *
 256  * RETURN:      Status
 257  *
 258  * DESCRIPTION: Builds a list of devices from the input PCI region up to the
 259  *              Root PCI device for this namespace subtree.
 260  *
 261  ******************************************************************************/
 262
 263 static ACPI_STATUS
 264 AcpiHwBuildPciList (
 265     ACPI_HANDLE             RootPciDevice,
 266     ACPI_HANDLE             PciRegion,
 267     ACPI_PCI_DEVICE         **ReturnListHead)
 268 {
 269     ACPI_HANDLE             CurrentDevice;
 270     ACPI_HANDLE             ParentDevice;
 271     ACPI_STATUS             Status;
 272     ACPI_PCI_DEVICE         *ListElement;
 273     ACPI_PCI_DEVICE         *ListHead = NULL;
 274
 275
 276     /*
 277      * Ascend namespace branch until the RootPciDevice is reached, building
 278      * a list of device nodes. Loop will exit when either the PCI device is
 279      * found, or the root of the namespace is reached.
 280      */
 281     CurrentDevice = PciRegion;
 282     while (1)
 283     {
 284         Status = AcpiGetParent (CurrentDevice, &ParentDevice);
 285         if (ACPI_FAILURE (Status))
 286         {
 287             /* Must delete the list before exit */
 288
 289             AcpiHwDeletePciList (*ReturnListHead);
 290             return (Status);
 291         }
 292
 293         /* Finished when we reach the PCI root device (PNP0A03 or PNP0A08) */
 294
 295         if (ParentDevice == RootPciDevice)
 296         {
 297             *ReturnListHead = ListHead;
 298             return (AE_OK);
 299         }
 300
 301         ListElement = ACPI_ALLOCATE (sizeof (ACPI_PCI_DEVICE));
 302         if (!ListElement)
 303         {
 304             /* Must delete the list before exit */
 305
 306             AcpiHwDeletePciList (*ReturnListHead);
 307             return (AE_NO_MEMORY);
 308         }
 309
 310         /* Put new element at the head of the list */
 311
 312         ListElement->Next = ListHead;
 313         ListElement->Device = ParentDevice;
 314         ListHead = ListElement;
 315
 316         CurrentDevice = ParentDevice;
 317     }
 318 }
 319
 320
 321 /*******************************************************************************
 322  *
 323  * FUNCTION:    AcpiHwProcessPciList
 324  *
 325  * PARAMETERS:  PciId               - Initial values for the PCI ID. May be
 326  *                                    modified by this function.
 327  *              ListHead            - Device list created by
 328  *                                    AcpiHwBuildPciList
 329  *
 330  * RETURN:      Status
 331  *
 332  * DESCRIPTION: Walk downward through the PCI device list, getting the device
 333  *              info for each, via the PCI configuration space and updating
 334  *              the PCI ID as necessary. Deletes the list during traversal.
 335  *
 336  ******************************************************************************/
 337
 338 static ACPI_STATUS
 339 AcpiHwProcessPciList (
 340     ACPI_PCI_ID             *PciId,
 341     ACPI_PCI_DEVICE         *ListHead)
 342 {
 343     ACPI_STATUS             Status = AE_OK;
 344     ACPI_PCI_DEVICE         *Info;
 345     UINT16                  BusNumber;
 346     BOOLEAN                 IsBridge = TRUE;
 347
 348
 349     ACPI_FUNCTION_NAME (HwProcessPciList);
 350
 351
 352     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 353         "Input PciId:  Seg %4.4X Bus %4.4X Dev %4.4X Func %4.4X\n",
 354         PciId->Segment, PciId->Bus, PciId->Device, PciId->Function));
 355
 356     BusNumber = PciId->Bus;
 357
 358     /*
 359      * Descend down the namespace tree, collecting PCI device, function,
 360      * and bus numbers. BusNumber is only important for PCI bridges.
 361      * Algorithm: As we descend the tree, use the last valid PCI device,
 362      * function, and bus numbers that are discovered, and assign them
 363      * to the PCI ID for the target device.
 364      */
 365     Info = ListHead;
 366     while (Info)
 367     {
 368         Status = AcpiHwGetPciDeviceInfo (PciId, Info->Device,
 369             &BusNumber, &IsBridge);
 370         if (ACPI_FAILURE (Status))
 371         {
 372             return (Status);
 373         }
 374
 375         Info = Info->Next;
 376     }
 377
 378     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 379         "Output PciId: Seg %4.4X Bus %4.4X Dev %4.4X Func %4.4X "
 380         "Status %X BusNumber %X IsBridge %X\n",
 381         PciId->Segment, PciId->Bus, PciId->Device, PciId->Function,
 382         Status, BusNumber, IsBridge));
 383
 384     return (AE_OK);
 385 }
 386
 387
 388 /*******************************************************************************
 389  *
 390  * FUNCTION:    AcpiHwDeletePciList
 391  *
 392  * PARAMETERS:  ListHead            - Device list created by
 393  *                                    AcpiHwBuildPciList
 394  *
 395  * RETURN:      None
 396  *
 397  * DESCRIPTION: Free the entire PCI list.
 398  *
 399  ******************************************************************************/
 400
 401 static void
 402 AcpiHwDeletePciList (
 403     ACPI_PCI_DEVICE         *ListHead)
 404 {
 405     ACPI_PCI_DEVICE         *Next;
 406     ACPI_PCI_DEVICE         *Previous;
 407
 408
 409     Next = ListHead;
 410     while (Next)
 411     {
 412         Previous = Next;
 413         Next = Previous->Next;
 414         ACPI_FREE (Previous);
 415     }
 416 }
 417
 418
 419 /*******************************************************************************
 420  *
 421  * FUNCTION:    AcpiHwGetPciDeviceInfo
 422  *
 423  * PARAMETERS:  PciId               - Initial values for the PCI ID. May be
 424  *                                    modified by this function.
 425  *              PciDevice           - Handle for the PCI device object
 426  *              BusNumber           - Where a PCI bridge bus number is returned
 427  *              IsBridge            - Return value, indicates if this PCI
 428  *                                    device is a PCI bridge
 429  *
 430  * RETURN:      Status
 431  *
 432  * DESCRIPTION: Get the device info for a single PCI device object. Get the
 433  *              _ADR (contains PCI device and function numbers), and for PCI
 434  *              bridge devices, get the bus number from PCI configuration
 435  *              space.
 436  *
 437  ******************************************************************************/
 438
 439 static ACPI_STATUS
 440 AcpiHwGetPciDeviceInfo (
 441     ACPI_PCI_ID             *PciId,
 442     ACPI_HANDLE             PciDevice,
 443     UINT16                  *BusNumber,
 444     BOOLEAN                 *IsBridge)
 445 {
 446     ACPI_STATUS             Status;
 447     ACPI_OBJECT_TYPE        ObjectType;
 448     UINT64                  ReturnValue;
 449     UINT64                  PciValue;
 450
 451
 452     /* We only care about objects of type Device */
 453
 454     Status = AcpiGetType (PciDevice, &ObjectType);
 455     if (ACPI_FAILURE (Status))
 456     {
 457         return (Status);
 458     }
 459
 460     if (ObjectType != ACPI_TYPE_DEVICE)
 461     {
 462         return (AE_OK);
 463     }
 464
 465     /* We need an _ADR. Ignore device if not present */
 466
 467     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR,
 468         PciDevice, &ReturnValue);
 469     if (ACPI_FAILURE (Status))
 470     {
 471         return (AE_OK);
 472     }
 473
 474     /*
 475      * From _ADR, get the PCI Device and Function and
 476      * update the PCI ID.
 477      */
 478     PciId->Device = ACPI_HIWORD (ACPI_LODWORD (ReturnValue));
 479     PciId->Function = ACPI_LOWORD (ACPI_LODWORD (ReturnValue));
 480
 481     /*
 482      * If the previous device was a bridge, use the previous
 483      * device bus number
 484      */
 485     if (*IsBridge)
 486     {
 487         PciId->Bus = *BusNumber;
 488     }
 489
 490     /*
 491      * Get the bus numbers from PCI Config space:
 492      *
 493      * First, get the PCI HeaderType
 494      */
 495     *IsBridge = FALSE;
 496     Status = AcpiOsReadPciConfiguration (PciId,
 497         PCI_CFG_HEADER_TYPE_REG, &PciValue, 8);
 498     if (ACPI_FAILURE (Status))
 499     {
 500         return (Status);
 501     }
 502
 503     /* We only care about bridges (1=PciBridge, 2=CardBusBridge) */
 504
 505     PciValue &= PCI_HEADER_TYPE_MASK;
 506
 507     if ((PciValue != PCI_TYPE_BRIDGE) &&
 508         (PciValue != PCI_TYPE_CARDBUS_BRIDGE))
 509     {
 510         return (AE_OK);
 511     }
 512
 513     /* Bridge: Get the Primary BusNumber */
 514
 515     Status = AcpiOsReadPciConfiguration (PciId,
 516         PCI_CFG_PRIMARY_BUS_NUMBER_REG, &PciValue, 8);
 517     if (ACPI_FAILURE (Status))
 518     {
 519         return (Status);
 520     }
 521
 522     *IsBridge = TRUE;
 523     PciId->Bus = (UINT16) PciValue;
 524
 525     /* Bridge: Get the Secondary BusNumber */
 526
 527     Status = AcpiOsReadPciConfiguration (PciId,
 528         PCI_CFG_SECONDARY_BUS_NUMBER_REG, &PciValue, 8);
 529     if (ACPI_FAILURE (Status))
 530     {
 531         return (Status);
 532     }
 533
 534     *BusNumber = (UINT16) PciValue;
 535     return (AE_OK);
 536 }