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