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