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