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 - 2014, 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 #define __HWPCI_C__ 117 118 #include "acpi.h" 119 #include "accommon.h" 120 121 122 #define _COMPONENT ACPI_NAMESPACE 123 ACPI_MODULE_NAME ("hwpci") 124 125 126 /* PCI configuration space values */ 127 128 #define PCI_CFG_HEADER_TYPE_REG 0x0E 129 #define PCI_CFG_PRIMARY_BUS_NUMBER_REG 0x18 130 #define PCI_CFG_SECONDARY_BUS_NUMBER_REG 0x19 131 132 /* PCI header values */ 133 134 #define PCI_HEADER_TYPE_MASK 0x7F 135 #define PCI_TYPE_BRIDGE 0x01 136 #define PCI_TYPE_CARDBUS_BRIDGE 0x02 137 138 typedef struct acpi_pci_device 139 { 140 ACPI_HANDLE Device; 141 struct acpi_pci_device *Next; 142 143 } ACPI_PCI_DEVICE; 144 145 146 /* Local prototypes */ 147 148 static ACPI_STATUS 149 AcpiHwBuildPciList ( 150 ACPI_HANDLE RootPciDevice, 151 ACPI_HANDLE PciRegion, 152 ACPI_PCI_DEVICE **ReturnListHead); 153 154 static ACPI_STATUS 155 AcpiHwProcessPciList ( 156 ACPI_PCI_ID *PciId, 157 ACPI_PCI_DEVICE *ListHead); 158 159 static void 160 AcpiHwDeletePciList ( 161 ACPI_PCI_DEVICE *ListHead); 162 163 static ACPI_STATUS 164 AcpiHwGetPciDeviceInfo ( 165 ACPI_PCI_ID *PciId, 166 ACPI_HANDLE PciDevice, 167 UINT16 *BusNumber, 168 BOOLEAN *IsBridge); 169 170 171 /******************************************************************************* 172 * 173 * FUNCTION: AcpiHwDerivePciId 174 * 175 * PARAMETERS: PciId - Initial values for the PCI ID. May be 176 * modified by this function. 177 * RootPciDevice - A handle to a PCI device object. This 178 * object must be a PCI Root Bridge having a 179 * _HID value of either PNP0A03 or PNP0A08 180 * PciRegion - A handle to a PCI configuration space 181 * Operation Region being initialized 182 * 183 * RETURN: Status 184 * 185 * DESCRIPTION: This function derives a full PCI ID for a PCI device, 186 * consisting of a Segment number, Bus number, Device number, 187 * and function code. 188 * 189 * The PCI hardware dynamically configures PCI bus numbers 190 * depending on the bus topology discovered during system 191 * initialization. This function is invoked during configuration 192 * of a PCI_Config Operation Region in order to (possibly) update 193 * the Bus/Device/Function numbers in the PciId with the actual 194 * values as determined by the hardware and operating system 195 * configuration. 196 * 197 * The PciId parameter is initially populated during the Operation 198 * Region initialization. This function is then called, and is 199 * will make any necessary modifications to the Bus, Device, or 200 * Function number PCI ID subfields as appropriate for the 201 * current hardware and OS configuration. 202 * 203 * NOTE: Created 08/2010. Replaces the previous OSL AcpiOsDerivePciId 204 * interface since this feature is OS-independent. This module 205 * specifically avoids any use of recursion by building a local 206 * temporary device list. 207 * 208 ******************************************************************************/ 209 210 ACPI_STATUS 211 AcpiHwDerivePciId ( 212 ACPI_PCI_ID *PciId, 213 ACPI_HANDLE RootPciDevice, 214 ACPI_HANDLE PciRegion) 215 { 216 ACPI_STATUS Status; 217 ACPI_PCI_DEVICE *ListHead = NULL; 218 219 220 ACPI_FUNCTION_TRACE (HwDerivePciId); 221 222 223 if (!PciId) 224 { 225 return_ACPI_STATUS (AE_BAD_PARAMETER); 226 } 227 228 /* Build a list of PCI devices, from PciRegion up to RootPciDevice */ 229 230 Status = AcpiHwBuildPciList (RootPciDevice, PciRegion, &ListHead); 231 if (ACPI_SUCCESS (Status)) 232 { 233 /* Walk the list, updating the PCI device/function/bus numbers */ 234 235 Status = AcpiHwProcessPciList (PciId, ListHead); 236 237 /* Delete the list */ 238 239 AcpiHwDeletePciList (ListHead); 240 } 241 242 return_ACPI_STATUS (Status); 243 } 244 245 246 /******************************************************************************* 247 * 248 * FUNCTION: AcpiHwBuildPciList 249 * 250 * PARAMETERS: RootPciDevice - A handle to a PCI device object. This 251 * object is guaranteed to be a PCI Root 252 * Bridge having a _HID value of either 253 * PNP0A03 or PNP0A08 254 * PciRegion - A handle to the PCI configuration space 255 * Operation Region 256 * ReturnListHead - Where the PCI device list is returned 257 * 258 * RETURN: Status 259 * 260 * DESCRIPTION: Builds a list of devices from the input PCI region up to the 261 * Root PCI device for this namespace subtree. 262 * 263 ******************************************************************************/ 264 265 static ACPI_STATUS 266 AcpiHwBuildPciList ( 267 ACPI_HANDLE RootPciDevice, 268 ACPI_HANDLE PciRegion, 269 ACPI_PCI_DEVICE **ReturnListHead) 270 { 271 ACPI_HANDLE CurrentDevice; 272 ACPI_HANDLE ParentDevice; 273 ACPI_STATUS Status; 274 ACPI_PCI_DEVICE *ListElement; 275 ACPI_PCI_DEVICE *ListHead = NULL; 276 277 278 /* 279 * Ascend namespace branch until the RootPciDevice is reached, building 280 * a list of device nodes. Loop will exit when either the PCI device is 281 * found, or the root of the namespace is reached. 282 */ 283 CurrentDevice = PciRegion; 284 while (1) 285 { 286 Status = AcpiGetParent (CurrentDevice, &ParentDevice); 287 if (ACPI_FAILURE (Status)) 288 { 289 /* Must delete the list before exit */ 290 291 AcpiHwDeletePciList (*ReturnListHead); 292 return (Status); 293 } 294 295 /* Finished when we reach the PCI root device (PNP0A03 or PNP0A08) */ 296 297 if (ParentDevice == RootPciDevice) 298 { 299 *ReturnListHead = ListHead; 300 return (AE_OK); 301 } 302 303 ListElement = ACPI_ALLOCATE (sizeof (ACPI_PCI_DEVICE)); 304 if (!ListElement) 305 { 306 /* Must delete the list before exit */ 307 308 AcpiHwDeletePciList (*ReturnListHead); 309 return (AE_NO_MEMORY); 310 } 311 312 /* Put new element at the head of the list */ 313 314 ListElement->Next = ListHead; 315 ListElement->Device = ParentDevice; 316 ListHead = ListElement; 317 318 CurrentDevice = ParentDevice; 319 } 320 } 321 322 323 /******************************************************************************* 324 * 325 * FUNCTION: AcpiHwProcessPciList 326 * 327 * PARAMETERS: PciId - Initial values for the PCI ID. May be 328 * modified by this function. 329 * ListHead - Device list created by 330 * AcpiHwBuildPciList 331 * 332 * RETURN: Status 333 * 334 * DESCRIPTION: Walk downward through the PCI device list, getting the device 335 * info for each, via the PCI configuration space and updating 336 * the PCI ID as necessary. Deletes the list during traversal. 337 * 338 ******************************************************************************/ 339 340 static ACPI_STATUS 341 AcpiHwProcessPciList ( 342 ACPI_PCI_ID *PciId, 343 ACPI_PCI_DEVICE *ListHead) 344 { 345 ACPI_STATUS Status = AE_OK; 346 ACPI_PCI_DEVICE *Info; 347 UINT16 BusNumber; 348 BOOLEAN IsBridge = TRUE; 349 350 351 ACPI_FUNCTION_NAME (HwProcessPciList); 352 353 354 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION, 355 "Input PciId: Seg %4.4X Bus %4.4X Dev %4.4X Func %4.4X\n", 356 PciId->Segment, PciId->Bus, PciId->Device, PciId->Function)); 357 358 BusNumber = PciId->Bus; 359 360 /* 361 * Descend down the namespace tree, collecting PCI device, function, 362 * and bus numbers. BusNumber is only important for PCI bridges. 363 * Algorithm: As we descend the tree, use the last valid PCI device, 364 * function, and bus numbers that are discovered, and assign them 365 * to the PCI ID for the target device. 366 */ 367 Info = ListHead; 368 while (Info) 369 { 370 Status = AcpiHwGetPciDeviceInfo (PciId, Info->Device, 371 &BusNumber, &IsBridge); 372 if (ACPI_FAILURE (Status)) 373 { 374 return (Status); 375 } 376 377 Info = Info->Next; 378 } 379 380 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION, 381 "Output PciId: Seg %4.4X Bus %4.4X Dev %4.4X Func %4.4X " 382 "Status %X BusNumber %X IsBridge %X\n", 383 PciId->Segment, PciId->Bus, PciId->Device, PciId->Function, 384 Status, BusNumber, IsBridge)); 385 386 return (AE_OK); 387 } 388 389 390 /******************************************************************************* 391 * 392 * FUNCTION: AcpiHwDeletePciList 393 * 394 * PARAMETERS: ListHead - Device list created by 395 * AcpiHwBuildPciList 396 * 397 * RETURN: None 398 * 399 * DESCRIPTION: Free the entire PCI list. 400 * 401 ******************************************************************************/ 402 403 static void 404 AcpiHwDeletePciList ( 405 ACPI_PCI_DEVICE *ListHead) 406 { 407 ACPI_PCI_DEVICE *Next; 408 ACPI_PCI_DEVICE *Previous; 409 410 411 Next = ListHead; 412 while (Next) 413 { 414 Previous = Next; 415 Next = Previous->Next; 416 ACPI_FREE (Previous); 417 } 418 } 419 420 421 /******************************************************************************* 422 * 423 * FUNCTION: AcpiHwGetPciDeviceInfo 424 * 425 * PARAMETERS: PciId - Initial values for the PCI ID. May be 426 * modified by this function. 427 * PciDevice - Handle for the PCI device object 428 * BusNumber - Where a PCI bridge bus number is returned 429 * IsBridge - Return value, indicates if this PCI 430 * device is a PCI bridge 431 * 432 * RETURN: Status 433 * 434 * DESCRIPTION: Get the device info for a single PCI device object. Get the 435 * _ADR (contains PCI device and function numbers), and for PCI 436 * bridge devices, get the bus number from PCI configuration 437 * space. 438 * 439 ******************************************************************************/ 440 441 static ACPI_STATUS 442 AcpiHwGetPciDeviceInfo ( 443 ACPI_PCI_ID *PciId, 444 ACPI_HANDLE PciDevice, 445 UINT16 *BusNumber, 446 BOOLEAN *IsBridge) 447 { 448 ACPI_STATUS Status; 449 ACPI_OBJECT_TYPE ObjectType; 450 UINT64 ReturnValue; 451 UINT64 PciValue; 452 453 454 /* We only care about objects of type Device */ 455 456 Status = AcpiGetType (PciDevice, &ObjectType); 457 if (ACPI_FAILURE (Status)) 458 { 459 return (Status); 460 } 461 462 if (ObjectType != ACPI_TYPE_DEVICE) 463 { 464 return (AE_OK); 465 } 466 467 /* We need an _ADR. Ignore device if not present */ 468 469 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, 470 PciDevice, &ReturnValue); 471 if (ACPI_FAILURE (Status)) 472 { 473 return (AE_OK); 474 } 475 476 /* 477 * From _ADR, get the PCI Device and Function and 478 * update the PCI ID. 479 */ 480 PciId->Device = ACPI_HIWORD (ACPI_LODWORD (ReturnValue)); 481 PciId->Function = ACPI_LOWORD (ACPI_LODWORD (ReturnValue)); 482 483 /* 484 * If the previous device was a bridge, use the previous 485 * device bus number 486 */ 487 if (*IsBridge) 488 { 489 PciId->Bus = *BusNumber; 490 } 491 492 /* 493 * Get the bus numbers from PCI Config space: 494 * 495 * First, get the PCI HeaderType 496 */ 497 *IsBridge = FALSE; 498 Status = AcpiOsReadPciConfiguration (PciId, 499 PCI_CFG_HEADER_TYPE_REG, &PciValue, 8); 500 if (ACPI_FAILURE (Status)) 501 { 502 return (Status); 503 } 504 505 /* We only care about bridges (1=PciBridge, 2=CardBusBridge) */ 506 507 PciValue &= PCI_HEADER_TYPE_MASK; 508 509 if ((PciValue != PCI_TYPE_BRIDGE) && 510 (PciValue != PCI_TYPE_CARDBUS_BRIDGE)) 511 { 512 return (AE_OK); 513 } 514 515 /* Bridge: Get the Primary BusNumber */ 516 517 Status = AcpiOsReadPciConfiguration (PciId, 518 PCI_CFG_PRIMARY_BUS_NUMBER_REG, &PciValue, 8); 519 if (ACPI_FAILURE (Status)) 520 { 521 return (Status); 522 } 523 524 *IsBridge = TRUE; 525 PciId->Bus = (UINT16) PciValue; 526 527 /* Bridge: Get the Secondary BusNumber */ 528 529 Status = AcpiOsReadPciConfiguration (PciId, 530 PCI_CFG_SECONDARY_BUS_NUMBER_REG, &PciValue, 8); 531 if (ACPI_FAILURE (Status)) 532 { 533 return (Status); 534 } 535 536 *BusNumber = (UINT16) PciValue; 537 return (AE_OK); 538 } 539