ACPI: PCI: whitespace and useless initialization cleanup
[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        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 do_prt_fixups(struct acpi_prt_entry *entry,
153                           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 acpi_pci_irq_add_entry(acpi_handle handle, int segment, int bus,
184                                   struct acpi_pci_routing_table *prt)
185 {
186         struct acpi_prt_entry *entry;
187
188         entry = kzalloc(sizeof(struct acpi_prt_entry), GFP_KERNEL);
189         if (!entry)
190                 return -ENOMEM;
191
192         /*
193          * Note that the _PRT uses 0=INTA, 1=INTB, etc, while PCI uses
194          * 1=INTA, 2=INTB.  We use the PCI encoding throughout, so convert
195          * it here.
196          */
197         entry->id.segment = segment;
198         entry->id.bus = bus;
199         entry->id.device = (prt->address >> 16) & 0xFFFF;
200         entry->pin = prt->pin + 1;
201
202         do_prt_fixups(entry, prt);
203
204         entry->index = prt->source_index;
205
206         /*
207          * Type 1: Dynamic
208          * ---------------
209          * The 'source' field specifies the PCI interrupt link device used to
210          * configure the IRQ assigned to this slot|dev|pin.  The 'source_index'
211          * indicates which resource descriptor in the resource template (of
212          * the link device) this interrupt is allocated from.
213          * 
214          * NOTE: Don't query the Link Device for IRQ information at this time
215          *       because Link Device enumeration may not have occurred yet
216          *       (e.g. exists somewhere 'below' this _PRT entry in the ACPI
217          *       namespace).
218          */
219         if (prt->source[0])
220                 acpi_get_handle(handle, prt->source, &entry->link);
221
222         /*
223          * Type 2: Static
224          * --------------
225          * The 'source' field is NULL, and the 'source_index' field specifies
226          * the IRQ value, which is hardwired to specific interrupt inputs on
227          * the interrupt controller.
228          */
229
230         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INFO,
231                               "      %04x:%02x:%02x[%c] -> %s[%d]\n",
232                               entry->id.segment, entry->id.bus,
233                               entry->id.device, pin_name(entry->pin),
234                               prt->source, entry->index));
235
236         spin_lock(&acpi_prt_lock);
237         list_add_tail(&entry->list, &acpi_prt_list);
238         spin_unlock(&acpi_prt_lock);
239
240         return 0;
241 }
242
243 int acpi_pci_irq_add_prt(acpi_handle handle, int segment, int bus)
244 {
245         acpi_status status;
246         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
247         struct acpi_pci_routing_table *entry;
248
249         /* 'handle' is the _PRT's parent (root bridge or PCI-PCI bridge) */
250         status = acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
251         if (ACPI_FAILURE(status))
252                 return -ENODEV;
253
254         printk(KERN_DEBUG "ACPI: PCI Interrupt Routing Table [%s._PRT]\n",
255                (char *) buffer.pointer);
256
257         kfree(buffer.pointer);
258
259         buffer.length = ACPI_ALLOCATE_BUFFER;
260         buffer.pointer = NULL;
261
262         status = acpi_get_irq_routing_table(handle, &buffer);
263         if (ACPI_FAILURE(status)) {
264                 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PRT [%s]",
265                                 acpi_format_exception(status)));
266                 kfree(buffer.pointer);
267                 return -ENODEV;
268         }
269
270         entry = buffer.pointer;
271         while (entry && (entry->length > 0)) {
272                 acpi_pci_irq_add_entry(handle, segment, bus, entry);
273                 entry = (struct acpi_pci_routing_table *)
274                     ((unsigned long)entry + entry->length);
275         }
276
277         kfree(buffer.pointer);
278         return 0;
279 }
280
281 void acpi_pci_irq_del_prt(int segment, int bus)
282 {
283         struct acpi_prt_entry *entry, *tmp;
284
285         printk(KERN_DEBUG
286                "ACPI: Delete PCI Interrupt Routing Table for %04x:%02x\n",
287                segment, bus);
288         spin_lock(&acpi_prt_lock);
289         list_for_each_entry_safe(entry, tmp, &acpi_prt_list, list) {
290                 if (segment == entry->id.segment && bus == entry->id.bus) {
291                         list_del(&entry->list);
292                         kfree(entry);
293                 }
294         }
295         spin_unlock(&acpi_prt_lock);
296 }
297
298 /* --------------------------------------------------------------------------
299                           PCI Interrupt Routing Support
300    -------------------------------------------------------------------------- */
301 static struct acpi_prt_entry *acpi_pci_irq_lookup(struct pci_dev *dev, int pin)
302 {
303         struct acpi_prt_entry *entry;
304         struct pci_dev *bridge;
305         u8 bridge_pin, orig_pin = pin;
306
307         entry = acpi_pci_irq_find_prt_entry(dev, pin);
308         if (entry) {
309                 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found %s[%c] _PRT entry\n",
310                                   pci_name(dev), pin_name(pin)));
311                 return entry;
312         }
313
314         /* 
315          * Attempt to derive an IRQ for this device from a parent bridge's
316          * PCI interrupt routing entry (eg. yenta bridge and add-in card bridge).
317          */
318         bridge = dev->bus->self;
319         while (bridge) {
320                 pin = (((pin - 1) + PCI_SLOT(dev->devfn)) % 4) + 1;
321
322                 if ((bridge->class >> 8) == PCI_CLASS_BRIDGE_CARDBUS) {
323                         /* PC card has the same IRQ as its cardbridge */
324                         bridge_pin = bridge->pin;
325                         if (!bridge_pin) {
326                                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
327                                                   "No interrupt pin configured for device %s\n",
328                                                   pci_name(bridge)));
329                                 return NULL;
330                         }
331                         pin = bridge_pin;
332                 }
333
334                 entry = acpi_pci_irq_find_prt_entry(bridge, pin);
335                 if (entry) {
336                         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
337                                          "Derived GSI for %s INT %c from %s\n",
338                                          pci_name(dev), pin_name(orig_pin),
339                                          pci_name(bridge)));
340                         return entry;
341                 }
342
343                 dev = bridge;
344                 bridge = dev->bus->self;
345         }
346
347         dev_warn(&dev->dev, "can't derive routing for PCI INT %c\n",
348                  pin_name(orig_pin));
349         return NULL;
350 }
351
352 int acpi_pci_irq_enable(struct pci_dev *dev)
353 {
354         struct acpi_prt_entry *entry;
355         int gsi;
356         u8 pin;
357         int triggering = ACPI_LEVEL_SENSITIVE;
358         int polarity = ACPI_ACTIVE_LOW;
359         char *link = NULL;
360         char link_desc[16];
361         int rc;
362
363         pin = dev->pin;
364         if (!pin) {
365                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
366                                   "No interrupt pin configured for device %s\n",
367                                   pci_name(dev)));
368                 return 0;
369         }
370
371         entry = acpi_pci_irq_lookup(dev, pin);
372         if (!entry) {
373                 /*
374                  * IDE legacy mode controller IRQs are magic. Why do compat
375                  * extensions always make such a nasty mess.
376                  */
377                 if (dev->class >> 8 == PCI_CLASS_STORAGE_IDE &&
378                                 (dev->class & 0x05) == 0)
379                         return 0;
380         }
381
382         if (entry) {
383                 if (entry->link)
384                         gsi = acpi_pci_link_allocate_irq(entry->link,
385                                                          entry->index,
386                                                          &triggering, &polarity,
387                                                          &link);
388                 else
389                         gsi = entry->index;
390         } else
391                 gsi = -1;
392
393         /*
394          * No IRQ known to the ACPI subsystem - maybe the BIOS / 
395          * driver reported one, then use it. Exit in any case.
396          */
397         if (gsi < 0) {
398                 dev_warn(&dev->dev, "PCI INT %c: no GSI", pin_name(pin));
399                 /* Interrupt Line values above 0xF are forbidden */
400                 if (dev->irq > 0 && (dev->irq <= 0xF)) {
401                         printk(" - using IRQ %d\n", dev->irq);
402                         acpi_register_gsi(dev->irq, ACPI_LEVEL_SENSITIVE,
403                                           ACPI_ACTIVE_LOW);
404                         return 0;
405                 } else {
406                         printk("\n");
407                         return 0;
408                 }
409         }
410
411         rc = acpi_register_gsi(gsi, triggering, polarity);
412         if (rc < 0) {
413                 dev_warn(&dev->dev, "PCI INT %c: failed to register GSI\n",
414                          pin_name(pin));
415                 return rc;
416         }
417         dev->irq = rc;
418
419         if (link)
420                 snprintf(link_desc, sizeof(link_desc), " -> Link[%s]", link);
421         else
422                 link_desc[0] = '\0';
423
424         dev_info(&dev->dev, "PCI INT %c%s -> GSI %u (%s, %s) -> IRQ %d\n",
425                  pin_name(pin), link_desc, gsi,
426                  (triggering == ACPI_LEVEL_SENSITIVE) ? "level" : "edge",
427                  (polarity == ACPI_ACTIVE_LOW) ? "low" : "high", dev->irq);
428
429         return 0;
430 }
431
432 /* FIXME: implement x86/x86_64 version */
433 void __attribute__ ((weak)) acpi_unregister_gsi(u32 i)
434 {
435 }
436
437 void acpi_pci_irq_disable(struct pci_dev *dev)
438 {
439         struct acpi_prt_entry *entry;
440         int gsi;
441         u8 pin;
442
443         pin = dev->pin;
444         if (!pin)
445                 return;
446
447         entry = acpi_pci_irq_lookup(dev, pin);
448         if (!entry)
449                 return;
450
451         if (entry->link)
452                 gsi = acpi_pci_link_free_irq(entry->link);
453         else
454                 gsi = entry->index;
455
456         /*
457          * TBD: It might be worth clearing dev->irq by magic constant
458          * (e.g. PCI_UNDEFINED_IRQ).
459          */
460
461         dev_info(&dev->dev, "PCI INT %c disabled\n", pin_name(pin));
462         acpi_unregister_gsi(gsi);
463 }