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