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