drivers/acpi/pci_irq.c

   1 /*
   2  *  pci_irq.c - ACPI PCI Interrupt Routing ($Revision: 11 $)
   3  *
   4  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
   5  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
   6  *  Copyright (C) 2002       Dominik Brodowski <devel@brodo.de>
   7  *
   8  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or (at
  13  *  your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful, but
  16  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  *  General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License along
  21  *  with this program; if not, write to the Free Software Foundation, Inc.,
  22  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  23  *
  24  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  25  */
  26
  27
  28 #include <linux/dmi.h>
  29 #include <linux/kernel.h>
  30 #include <linux/module.h>
  31 #include <linux/init.h>
  32 #include <linux/types.h>
  33 #include <linux/proc_fs.h>
  34 #include <linux/spinlock.h>
  35 #include <linux/pm.h>
  36 #include <linux/pci.h>
  37 #include <linux/acpi.h>
  38 #include <acpi/acpi_bus.h>
  39 #include <acpi/acpi_drivers.h>
  40
  41 #define _COMPONENT              ACPI_PCI_COMPONENT
  42 ACPI_MODULE_NAME("pci_irq");
  43
  44 struct acpi_prt_entry {
  45         struct list_head        node;
  46         struct acpi_pci_id      id;
  47         u8                      pin;
  48         struct {
  49                 acpi_handle             handle;
  50                 u32                     index;
  51         }                       link;
  52         u32                     irq;
  53 };
  54
  55 struct acpi_prt_list {
  56         int                     count;
  57         struct list_head        entries;
  58 };
  59
  60 static struct acpi_prt_list acpi_prt;
  61 static DEFINE_SPINLOCK(acpi_prt_lock);
  62
  63 static inline char pin_name(int pin)
  64 {
  65         return 'A' + pin - 1;
  66 }
  67
  68 /* --------------------------------------------------------------------------
  69                          PCI IRQ Routing Table (PRT) Support
  70    -------------------------------------------------------------------------- */
  71
  72 static struct acpi_prt_entry *acpi_pci_irq_find_prt_entry(struct pci_dev *dev,
  73                                                           int pin)
  74 {
  75         struct acpi_prt_entry *entry = NULL;
  76         int segment = pci_domain_nr(dev->bus);
  77         int bus = dev->bus->number;
  78         int device = PCI_SLOT(dev->devfn);
  79
  80         if (!acpi_prt.count)
  81                 return NULL;
  82
  83         /*
  84          * Parse through all PRT entries looking for a match on the specified
  85          * PCI device's segment, bus, device, and pin (don't care about func).
  86          *
  87          */
  88         spin_lock(&acpi_prt_lock);
  89         list_for_each_entry(entry, &acpi_prt.entries, node) {
  90                 if ((segment == entry->id.segment)
  91                     && (bus == entry->id.bus)
  92                     && (device == entry->id.device)
  93                     && (pin == entry->pin)) {
  94                         spin_unlock(&acpi_prt_lock);
  95                         return entry;
  96                 }
  97         }
  98
  99         spin_unlock(&acpi_prt_lock);
 100         return NULL;
 101 }
 102
 103 /* http://bugzilla.kernel.org/show_bug.cgi?id=4773 */
 104 static struct dmi_system_id medion_md9580[] = {
 105         {
 106                 .ident = "Medion MD9580-F laptop",
 107                 .matches = {
 108                         DMI_MATCH(DMI_SYS_VENDOR, "MEDIONNB"),
 109                         DMI_MATCH(DMI_PRODUCT_NAME, "A555"),
 110                 },
 111         },
 112         { }
 113 };
 114
 115 /* http://bugzilla.kernel.org/show_bug.cgi?id=5044 */
 116 static struct dmi_system_id dell_optiplex[] = {
 117         {
 118                 .ident = "Dell Optiplex GX1",
 119                 .matches = {
 120                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer Corporation"),
 121                         DMI_MATCH(DMI_PRODUCT_NAME, "OptiPlex GX1 600S+"),
 122                 },
 123         },
 124         { }
 125 };
 126
 127 /* http://bugzilla.kernel.org/show_bug.cgi?id=10138 */
 128 static struct dmi_system_id hp_t5710[] = {
 129         {
 130                 .ident = "HP t5710",
 131                 .matches = {
 132                         DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
 133                         DMI_MATCH(DMI_PRODUCT_NAME, "hp t5000 series"),
 134                         DMI_MATCH(DMI_BOARD_NAME, "098Ch"),
 135                 },
 136         },
 137         { }
 138 };
 139
 140 struct prt_quirk {
 141         struct dmi_system_id    *system;
 142         unsigned int            segment;
 143         unsigned int            bus;
 144         unsigned int            device;
 145         unsigned char           pin;
 146         char                    *source;        /* according to BIOS */
 147         char                    *actual_source;
 148 };
 149
 150 #define PCI_INTX_PIN(c)         (c - 'A' + 1)
 151
 152 /*
 153  * These systems have incorrect _PRT entries.  The BIOS claims the PCI
 154  * interrupt at the listed segment/bus/device/pin is connected to the first
 155  * link device, but it is actually connected to the second.
 156  */
 157 static struct prt_quirk prt_quirks[] = {
 158         { medion_md9580, 0, 0, 9, PCI_INTX_PIN('A'),
 159                 "\\_SB_.PCI0.ISA_.LNKA",
 160                 "\\_SB_.PCI0.ISA_.LNKB"},
 161         { dell_optiplex, 0, 0, 0xd, PCI_INTX_PIN('A'),
 162                 "\\_SB_.LNKB",
 163                 "\\_SB_.LNKA"},
 164         { hp_t5710, 0, 0, 1, PCI_INTX_PIN('A'),
 165                 "\\_SB_.PCI0.LNK1",
 166                 "\\_SB_.PCI0.LNK3"},
 167 };
 168
 169 static void
 170 do_prt_fixups(struct acpi_prt_entry *entry, struct acpi_pci_routing_table *prt)
 171 {
 172         int i;
 173         struct prt_quirk *quirk;
 174
 175         for (i = 0; i < ARRAY_SIZE(prt_quirks); i++) {
 176                 quirk = &prt_quirks[i];
 177
 178                 /* All current quirks involve link devices, not GSIs */
 179                 if (!prt->source)
 180                         continue;
 181
 182                 if (dmi_check_system(quirk->system) &&
 183                     entry->id.segment == quirk->segment &&
 184                     entry->id.bus == quirk->bus &&
 185                     entry->id.device == quirk->device &&
 186                     entry->pin == quirk->pin &&
 187                     !strcmp(prt->source, quirk->source) &&
 188                     strlen(prt->source) >= strlen(quirk->actual_source)) {
 189                         printk(KERN_WARNING PREFIX "firmware reports "
 190                                 "%04x:%02x:%02x PCI INT %c connected to %s; "
 191                                 "changing to %s\n",
 192                                 entry->id.segment, entry->id.bus,
 193                                 entry->id.device, pin_name(entry->pin),
 194                                 prt->source, quirk->actual_source);
 195                         strcpy(prt->source, quirk->actual_source);
 196                 }
 197         }
 198 }
 199
 200 static int
 201 acpi_pci_irq_add_entry(acpi_handle handle,
 202                        int segment, int bus, struct acpi_pci_routing_table *prt)
 203 {
 204         struct acpi_prt_entry *entry = NULL;
 205
 206         entry = kzalloc(sizeof(struct acpi_prt_entry), GFP_KERNEL);
 207         if (!entry)
 208                 return -ENOMEM;
 209
 210         /*
 211          * Note that the _PRT uses 0=INTA, 1=INTB, etc, while PCI uses
 212          * 1=INTA, 2=INTB.  We use the PCI encoding throughout, so convert
 213          * it here.
 214          */
 215         entry->id.segment = segment;
 216         entry->id.bus = bus;
 217         entry->id.device = (prt->address >> 16) & 0xFFFF;
 218         entry->pin = prt->pin + 1;
 219
 220         do_prt_fixups(entry, prt);
 221
 222         /*
 223          * Type 1: Dynamic
 224          * ---------------
 225          * The 'source' field specifies the PCI interrupt link device used to
 226          * configure the IRQ assigned to this slot|dev|pin.  The 'source_index'
 227          * indicates which resource descriptor in the resource template (of
 228          * the link device) this interrupt is allocated from.
 229          *
 230          * NOTE: Don't query the Link Device for IRQ information at this time
 231          *       because Link Device enumeration may not have occurred yet
 232          *       (e.g. exists somewhere 'below' this _PRT entry in the ACPI
 233          *       namespace).
 234          */
 235         if (prt->source[0]) {
 236                 acpi_get_handle(handle, prt->source, &entry->link.handle);
 237                 entry->link.index = prt->source_index;
 238         }
 239         /*
 240          * Type 2: Static
 241          * --------------
 242          * The 'source' field is NULL, and the 'source_index' field specifies
 243          * the IRQ value, which is hardwired to specific interrupt inputs on
 244          * the interrupt controller.
 245          */
 246         else
 247                 entry->link.index = prt->source_index;
 248
 249         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INFO,
 250                               "      %04x:%02x:%02x[%c] -> %s[%d]\n",
 251                               entry->id.segment, entry->id.bus,
 252                               entry->id.device, pin_name(entry->pin),
 253                               prt->source, entry->link.index));
 254
 255         spin_lock(&acpi_prt_lock);
 256         list_add_tail(&entry->node, &acpi_prt.entries);
 257         acpi_prt.count++;
 258         spin_unlock(&acpi_prt_lock);
 259
 260         return 0;
 261 }
 262
 263 static void
 264 acpi_pci_irq_del_entry(int segment, int bus, struct acpi_prt_entry *entry)
 265 {
 266         if (segment == entry->id.segment && bus == entry->id.bus) {
 267                 acpi_prt.count--;
 268                 list_del(&entry->node);
 269                 kfree(entry);
 270         }
 271 }
 272
 273 int acpi_pci_irq_add_prt(acpi_handle handle, int segment, int bus)
 274 {
 275         acpi_status status;
 276         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 277         struct acpi_pci_routing_table *entry;
 278         static int first_time = 1;
 279
 280         if (first_time) {
 281                 acpi_prt.count = 0;
 282                 INIT_LIST_HEAD(&acpi_prt.entries);
 283                 first_time = 0;
 284         }
 285
 286         /* 'handle' is the _PRT's parent (root bridge or PCI-PCI bridge) */
 287         status = acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
 288         if (ACPI_FAILURE(status))
 289                 return -ENODEV;
 290
 291         printk(KERN_DEBUG "ACPI: PCI Interrupt Routing Table [%s._PRT]\n",
 292                (char *) buffer.pointer);
 293
 294         kfree(buffer.pointer);
 295
 296         buffer.length = ACPI_ALLOCATE_BUFFER;
 297         buffer.pointer = NULL;
 298
 299         status = acpi_get_irq_routing_table(handle, &buffer);
 300         if (ACPI_FAILURE(status)) {
 301                 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PRT [%s]",
 302                                 acpi_format_exception(status)));
 303                 kfree(buffer.pointer);
 304                 return -ENODEV;
 305         }
 306
 307         entry = buffer.pointer;
 308         while (entry && (entry->length > 0)) {
 309                 acpi_pci_irq_add_entry(handle, segment, bus, entry);
 310                 entry = (struct acpi_pci_routing_table *)
 311                     ((unsigned long)entry + entry->length);
 312         }
 313
 314         kfree(buffer.pointer);
 315         return 0;
 316 }
 317
 318 void acpi_pci_irq_del_prt(int segment, int bus)
 319 {
 320         struct list_head *node = NULL, *n = NULL;
 321         struct acpi_prt_entry *entry = NULL;
 322
 323         if (!acpi_prt.count) {
 324                 return;
 325         }
 326
 327         printk(KERN_DEBUG
 328                "ACPI: Delete PCI Interrupt Routing Table for %04x:%02x\n",
 329                segment, bus);
 330         spin_lock(&acpi_prt_lock);
 331         list_for_each_safe(node, n, &acpi_prt.entries) {
 332                 entry = list_entry(node, struct acpi_prt_entry, node);
 333
 334                 acpi_pci_irq_del_entry(segment, bus, entry);
 335         }
 336         spin_unlock(&acpi_prt_lock);
 337 }
 338
 339 /* --------------------------------------------------------------------------
 340                           PCI Interrupt Routing Support
 341    -------------------------------------------------------------------------- */
 342 typedef int (*irq_lookup_func) (struct acpi_prt_entry *, int *, int *, char **);
 343
 344 static int
 345 acpi_pci_allocate_irq(struct acpi_prt_entry *entry,
 346                       int *triggering, int *polarity, char **link)
 347 {
 348         int irq;
 349
 350
 351         if (entry->link.handle) {
 352                 irq = acpi_pci_link_allocate_irq(entry->link.handle,
 353                                                  entry->link.index, triggering,
 354                                                  polarity, link);
 355                 if (irq < 0) {
 356                         printk(KERN_WARNING PREFIX
 357                                       "Invalid IRQ link routing entry\n");
 358                         return -1;
 359                 }
 360         } else {
 361                 irq = entry->link.index;
 362                 *triggering = ACPI_LEVEL_SENSITIVE;
 363                 *polarity = ACPI_ACTIVE_LOW;
 364         }
 365
 366         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found GSI %d\n", irq));
 367         return irq;
 368 }
 369
 370 static int
 371 acpi_pci_free_irq(struct acpi_prt_entry *entry,
 372                   int *triggering, int *polarity, char **link)
 373 {
 374         int irq;
 375
 376         if (entry->link.handle) {
 377                 irq = acpi_pci_link_free_irq(entry->link.handle);
 378         } else {
 379                 irq = entry->link.index;
 380         }
 381         return irq;
 382 }
 383
 384 /*
 385  * acpi_pci_irq_lookup
 386  * success: return IRQ >= 0
 387  * failure: return -1
 388  */
 389 static int
 390 acpi_pci_irq_lookup(struct pci_dev *dev, int pin,
 391                     int *triggering,
 392                     int *polarity, char **link, irq_lookup_func func)
 393 {
 394         struct acpi_prt_entry *entry = NULL;
 395         int ret;
 396
 397
 398         entry = acpi_pci_irq_find_prt_entry(dev, pin);
 399         if (!entry) {
 400                 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "No %s[%c] _PRT entry\n",
 401                                   pci_name(dev), pin_name(pin)));
 402                 return -1;
 403         }
 404
 405         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found %s[%c] _PRT entry\n",
 406                           pci_name(dev), pin_name(pin)));
 407
 408         ret = func(entry, triggering, polarity, link);
 409         return ret;
 410 }
 411
 412 /*
 413  * acpi_pci_irq_derive
 414  * success: return IRQ >= 0
 415  * failure: return < 0
 416  */
 417 static int
 418 acpi_pci_irq_derive(struct pci_dev *dev,
 419                     int pin,
 420                     int *triggering,
 421                     int *polarity, char **link, irq_lookup_func func)
 422 {
 423         struct pci_dev *bridge = dev;
 424         int irq = -1;
 425         u8 bridge_pin = 0, orig_pin = pin;
 426
 427
 428         /*
 429          * Attempt to derive an IRQ for this device from a parent bridge's
 430          * PCI interrupt routing entry (eg. yenta bridge and add-in card bridge).
 431          */
 432         while (irq < 0 && bridge->bus->self) {
 433                 pin = (((pin - 1) + PCI_SLOT(bridge->devfn)) % 4) + 1;
 434                 bridge = bridge->bus->self;
 435
 436                 if ((bridge->class >> 8) == PCI_CLASS_BRIDGE_CARDBUS) {
 437                         /* PC card has the same IRQ as its cardbridge */
 438                         bridge_pin = bridge->pin;
 439                         if (!bridge_pin) {
 440                                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 441                                                   "No interrupt pin configured for device %s\n",
 442                                                   pci_name(bridge)));
 443                                 return -1;
 444                         }
 445                         pin = bridge_pin;
 446                 }
 447
 448                 irq = acpi_pci_irq_lookup(bridge,
 449                                           pin, triggering, polarity,
 450                                           link, func);
 451         }
 452
 453         if (irq < 0) {
 454                 dev_warn(&dev->dev, "can't derive routing for PCI INT %c\n",
 455                          pin_name(orig_pin));
 456                 return -1;
 457         }
 458
 459         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Derived GSI %d for %s INT %c from %s\n",
 460                           irq, pci_name(dev), pin_name(orig_pin), pci_name(bridge)));
 461
 462         return irq;
 463 }
 464
 465 /*
 466  * acpi_pci_irq_enable
 467  * success: return 0
 468  * failure: return < 0
 469  */
 470
 471 int acpi_pci_irq_enable(struct pci_dev *dev)
 472 {
 473         int gsi = 0;
 474         u8 pin = 0;
 475         int triggering = ACPI_LEVEL_SENSITIVE;
 476         int polarity = ACPI_ACTIVE_LOW;
 477         char *link = NULL;
 478         char link_desc[16];
 479         int rc;
 480
 481
 482         pin = dev->pin;
 483         if (!pin) {
 484                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 485                                   "No interrupt pin configured for device %s\n",
 486                                   pci_name(dev)));
 487                 return 0;
 488         }
 489
 490         /*
 491          * First we check the PCI IRQ routing table (PRT) for an IRQ.  PRT
 492          * values override any BIOS-assigned IRQs set during boot.
 493          */
 494         gsi = acpi_pci_irq_lookup(dev, pin,
 495                                   &triggering, &polarity, &link,
 496                                   acpi_pci_allocate_irq);
 497
 498         /*
 499          * If no PRT entry was found, we'll try to derive an IRQ from the
 500          * device's parent bridge.
 501          */
 502         if (gsi < 0)
 503                 gsi = acpi_pci_irq_derive(dev, pin, &triggering,
 504                                           &polarity, &link,
 505                                           acpi_pci_allocate_irq);
 506
 507         if (gsi < 0) {
 508                 /*
 509                  * IDE legacy mode controller IRQs are magic. Why do compat
 510                  * extensions always make such a nasty mess.
 511                  */
 512                 if (dev->class >> 8 == PCI_CLASS_STORAGE_IDE &&
 513                                 (dev->class & 0x05) == 0)
 514                         return 0;
 515         }
 516         /*
 517          * No IRQ known to the ACPI subsystem - maybe the BIOS /
 518          * driver reported one, then use it. Exit in any case.
 519          */
 520         if (gsi < 0) {
 521                 dev_warn(&dev->dev, "PCI INT %c: no GSI", pin_name(pin));
 522                 /* Interrupt Line values above 0xF are forbidden */
 523                 if (dev->irq > 0 && (dev->irq <= 0xF)) {
 524                         printk(" - using IRQ %d\n", dev->irq);
 525                         acpi_register_gsi(dev->irq, ACPI_LEVEL_SENSITIVE,
 526                                           ACPI_ACTIVE_LOW);
 527                         return 0;
 528                 } else {
 529                         printk("\n");
 530                         return 0;
 531                 }
 532         }
 533
 534         rc = acpi_register_gsi(gsi, triggering, polarity);
 535         if (rc < 0) {
 536                 dev_warn(&dev->dev, "PCI INT %c: failed to register GSI\n",
 537                          pin_name(pin));
 538                 return rc;
 539         }
 540         dev->irq = rc;
 541
 542         if (link)
 543                 snprintf(link_desc, sizeof(link_desc), " -> Link[%s]", link);
 544         else
 545                 link_desc[0] = '\0';
 546
 547         dev_info(&dev->dev, "PCI INT %c%s -> GSI %u (%s, %s) -> IRQ %d\n",
 548                  pin_name(pin), link_desc, gsi,
 549                  (triggering == ACPI_LEVEL_SENSITIVE) ? "level" : "edge",
 550                  (polarity == ACPI_ACTIVE_LOW) ? "low" : "high", dev->irq);
 551
 552         return 0;
 553 }
 554
 555 /* FIXME: implement x86/x86_64 version */
 556 void __attribute__ ((weak)) acpi_unregister_gsi(u32 i)
 557 {
 558 }
 559
 560 void acpi_pci_irq_disable(struct pci_dev *dev)
 561 {
 562         int gsi = 0;
 563         u8 pin = 0;
 564         int triggering = ACPI_LEVEL_SENSITIVE;
 565         int polarity = ACPI_ACTIVE_LOW;
 566
 567
 568         pin = dev->pin;
 569         if (!pin)
 570                 return;
 571
 572         /*
 573          * First we check the PCI IRQ routing table (PRT) for an IRQ.
 574          */
 575         gsi = acpi_pci_irq_lookup(dev, pin,
 576                                   &triggering, &polarity, NULL,
 577                                   acpi_pci_free_irq);
 578         /*
 579          * If no PRT entry was found, we'll try to derive an IRQ from the
 580          * device's parent bridge.
 581          */
 582         if (gsi < 0)
 583                 gsi = acpi_pci_irq_derive(dev, pin,
 584                                           &triggering, &polarity, NULL,
 585                                           acpi_pci_free_irq);
 586         if (gsi < 0)
 587                 return;
 588
 589         /*
 590          * TBD: It might be worth clearing dev->irq by magic constant
 591          * (e.g. PCI_UNDEFINED_IRQ).
 592          */
 593
 594         dev_info(&dev->dev, "PCI INT %c disabled\n", pin_name(pin));
 595         acpi_unregister_gsi(gsi);
 596 }