2 * pci_link.c - ACPI PCI Interrupt Link Device Driver ($Revision: 34 $)
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>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
24 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 * 1. Support more than one IRQ resource entry per link device (index).
28 * 2. Implement start/stop mechanism and use ACPI Bus Driver facilities
29 * for IRQ management (e.g. start()->_SRS).
32 #include <linux/kernel.h>
33 #include <linux/module.h>
34 #include <linux/init.h>
35 #include <linux/types.h>
36 #include <linux/proc_fs.h>
37 #include <linux/spinlock.h>
39 #include <linux/pci.h>
41 #include <acpi/acpi_bus.h>
42 #include <acpi/acpi_drivers.h>
45 #define _COMPONENT ACPI_PCI_COMPONENT
46 ACPI_MODULE_NAME ("pci_link")
48 #define ACPI_PCI_LINK_CLASS "pci_irq_routing"
49 #define ACPI_PCI_LINK_HID "PNP0C0F"
50 #define ACPI_PCI_LINK_DRIVER_NAME "ACPI PCI Interrupt Link Driver"
51 #define ACPI_PCI_LINK_DEVICE_NAME "PCI Interrupt Link"
52 #define ACPI_PCI_LINK_FILE_INFO "info"
53 #define ACPI_PCI_LINK_FILE_STATUS "state"
55 #define ACPI_PCI_LINK_MAX_POSSIBLE 16
57 static int acpi_pci_link_add (struct acpi_device *device);
58 static int acpi_pci_link_remove (struct acpi_device *device, int type);
60 static struct acpi_driver acpi_pci_link_driver = {
61 .name = ACPI_PCI_LINK_DRIVER_NAME,
62 .class = ACPI_PCI_LINK_CLASS,
63 .ids = ACPI_PCI_LINK_HID,
65 .add = acpi_pci_link_add,
66 .remove = acpi_pci_link_remove,
70 struct acpi_pci_link_irq {
71 u8 active; /* Current IRQ */
72 u8 edge_level; /* All IRQs */
73 u8 active_high_low; /* All IRQs */
77 u8 possible[ACPI_PCI_LINK_MAX_POSSIBLE];
80 struct acpi_pci_link {
81 struct list_head node;
82 struct acpi_device *device;
84 struct acpi_pci_link_irq irq;
89 struct list_head entries;
93 /* --------------------------------------------------------------------------
94 PCI Link Device Management
95 -------------------------------------------------------------------------- */
98 * set context (link) possible list from resource list
101 acpi_pci_link_check_possible (
102 struct acpi_resource *resource,
105 struct acpi_pci_link *link = (struct acpi_pci_link *) context;
108 ACPI_FUNCTION_TRACE("acpi_pci_link_check_possible");
110 switch (resource->id) {
111 case ACPI_RSTYPE_START_DPF:
113 case ACPI_RSTYPE_IRQ:
115 struct acpi_resource_irq *p = &resource->data.irq;
116 if (!p || !p->number_of_interrupts) {
117 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "Blank IRQ resource\n"));
120 for (i = 0; (i<p->number_of_interrupts && i<ACPI_PCI_LINK_MAX_POSSIBLE); i++) {
121 if (!p->interrupts[i]) {
122 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "Invalid IRQ %d\n", p->interrupts[i]));
125 link->irq.possible[i] = p->interrupts[i];
126 link->irq.possible_count++;
128 link->irq.edge_level = p->edge_level;
129 link->irq.active_high_low = p->active_high_low;
130 link->irq.resource_type = ACPI_RSTYPE_IRQ;
133 case ACPI_RSTYPE_EXT_IRQ:
135 struct acpi_resource_ext_irq *p = &resource->data.extended_irq;
136 if (!p || !p->number_of_interrupts) {
137 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
138 "Blank EXT IRQ resource\n"));
141 for (i = 0; (i<p->number_of_interrupts && i<ACPI_PCI_LINK_MAX_POSSIBLE); i++) {
142 if (!p->interrupts[i]) {
143 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "Invalid IRQ %d\n", p->interrupts[i]));
146 link->irq.possible[i] = p->interrupts[i];
147 link->irq.possible_count++;
149 link->irq.edge_level = p->edge_level;
150 link->irq.active_high_low = p->active_high_low;
151 link->irq.resource_type = ACPI_RSTYPE_EXT_IRQ;
155 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
156 "Resource is not an IRQ entry\n"));
160 return AE_CTRL_TERMINATE;
165 acpi_pci_link_get_possible (
166 struct acpi_pci_link *link)
170 ACPI_FUNCTION_TRACE("acpi_pci_link_get_possible");
173 return_VALUE(-EINVAL);
175 status = acpi_walk_resources(link->handle, METHOD_NAME__PRS,
176 acpi_pci_link_check_possible, link);
177 if (ACPI_FAILURE(status)) {
178 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error evaluating _PRS\n"));
179 return_VALUE(-ENODEV);
182 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
183 "Found %d possible IRQs\n", link->irq.possible_count));
190 acpi_pci_link_check_current (
191 struct acpi_resource *resource,
194 int *irq = (int *) context;
196 ACPI_FUNCTION_TRACE("acpi_pci_link_check_current");
198 switch (resource->id) {
199 case ACPI_RSTYPE_IRQ:
201 struct acpi_resource_irq *p = &resource->data.irq;
202 if (!p || !p->number_of_interrupts) {
204 * IRQ descriptors may have no IRQ# bits set,
205 * particularly those those w/ _STA disabled
207 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
208 "Blank IRQ resource\n"));
211 *irq = p->interrupts[0];
214 case ACPI_RSTYPE_EXT_IRQ:
216 struct acpi_resource_ext_irq *p = &resource->data.extended_irq;
217 if (!p || !p->number_of_interrupts) {
219 * extended IRQ descriptors must
220 * return at least 1 IRQ
222 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
223 "Blank EXT IRQ resource\n"));
226 *irq = p->interrupts[0];
230 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
231 "Resource isn't an IRQ\n"));
234 return AE_CTRL_TERMINATE;
238 * Run _CRS and set link->irq.active
245 acpi_pci_link_get_current (
246 struct acpi_pci_link *link)
249 acpi_status status = AE_OK;
252 ACPI_FUNCTION_TRACE("acpi_pci_link_get_current");
254 if (!link || !link->handle)
255 return_VALUE(-EINVAL);
257 link->irq.active = 0;
259 /* in practice, status disabled is meaningless, ignore it */
261 /* Query _STA, set link->device->status */
262 result = acpi_bus_get_status(link->device);
264 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Unable to read status\n"));
268 if (!link->device->status.enabled) {
269 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Link disabled\n"));
275 * Query and parse _CRS to get the current IRQ assignment.
278 status = acpi_walk_resources(link->handle, METHOD_NAME__CRS,
279 acpi_pci_link_check_current, &irq);
280 if (ACPI_FAILURE(status)) {
281 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error evaluating _CRS\n"));
286 if (acpi_strict && !irq) {
287 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "_CRS returned 0\n"));
291 link->irq.active = irq;
293 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Link at IRQ %d \n", link->irq.active));
296 return_VALUE(result);
301 struct acpi_pci_link *link,
305 acpi_status status = AE_OK;
307 struct acpi_resource res;
308 struct acpi_resource end;
310 struct acpi_buffer buffer = {sizeof(resource)+1, &resource};
312 ACPI_FUNCTION_TRACE("acpi_pci_link_set");
315 return_VALUE(-EINVAL);
317 memset(&resource, 0, sizeof(resource));
319 switch(link->irq.resource_type) {
320 case ACPI_RSTYPE_IRQ:
321 resource.res.id = ACPI_RSTYPE_IRQ;
322 resource.res.length = sizeof(struct acpi_resource);
323 resource.res.data.irq.edge_level = link->irq.edge_level;
324 resource.res.data.irq.active_high_low = link->irq.active_high_low;
325 if (link->irq.edge_level == ACPI_EDGE_SENSITIVE)
326 resource.res.data.irq.shared_exclusive = ACPI_EXCLUSIVE;
328 resource.res.data.irq.shared_exclusive = ACPI_SHARED;
329 resource.res.data.irq.number_of_interrupts = 1;
330 resource.res.data.irq.interrupts[0] = irq;
333 case ACPI_RSTYPE_EXT_IRQ:
334 resource.res.id = ACPI_RSTYPE_EXT_IRQ;
335 resource.res.length = sizeof(struct acpi_resource);
336 resource.res.data.extended_irq.producer_consumer = ACPI_CONSUMER;
337 resource.res.data.extended_irq.edge_level = link->irq.edge_level;
338 resource.res.data.extended_irq.active_high_low = link->irq.active_high_low;
339 if (link->irq.edge_level == ACPI_EDGE_SENSITIVE)
340 resource.res.data.irq.shared_exclusive = ACPI_EXCLUSIVE;
342 resource.res.data.irq.shared_exclusive = ACPI_SHARED;
343 resource.res.data.extended_irq.number_of_interrupts = 1;
344 resource.res.data.extended_irq.interrupts[0] = irq;
345 /* ignore resource_source, it's optional */
348 printk("ACPI BUG: resource_type %d\n", link->irq.resource_type);
349 return_VALUE(-EINVAL);
352 resource.end.id = ACPI_RSTYPE_END_TAG;
354 /* Attempt to set the resource */
355 status = acpi_set_current_resources(link->handle, &buffer);
357 /* check for total failure */
358 if (ACPI_FAILURE(status)) {
359 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error evaluating _SRS\n"));
360 return_VALUE(-ENODEV);
363 /* Query _STA, set device->status */
364 result = acpi_bus_get_status(link->device);
366 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Unable to read status\n"));
367 return_VALUE(result);
369 if (!link->device->status.enabled) {
370 printk(KERN_WARNING PREFIX
371 "%s [%s] disabled and referenced, BIOS bug.\n",
372 acpi_device_name(link->device),
373 acpi_device_bid(link->device));
376 /* Query _CRS, set link->irq.active */
377 result = acpi_pci_link_get_current(link);
379 return_VALUE(result);
383 * Is current setting not what we set?
384 * set link->irq.active
386 if (link->irq.active != irq) {
388 * policy: when _CRS doesn't return what we just _SRS
389 * assume _SRS worked and override _CRS value.
391 printk(KERN_WARNING PREFIX
392 "%s [%s] BIOS reported IRQ %d, using IRQ %d\n",
393 acpi_device_name(link->device),
394 acpi_device_bid(link->device),
395 link->irq.active, irq);
396 link->irq.active = irq;
399 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Set IRQ %d\n", link->irq.active));
405 /* --------------------------------------------------------------------------
406 PCI Link IRQ Management
407 -------------------------------------------------------------------------- */
410 * "acpi_irq_balance" (default in APIC mode) enables ACPI to use PIC Interrupt
411 * Link Devices to move the PIRQs around to minimize sharing.
413 * "acpi_irq_nobalance" (default in PIC mode) tells ACPI not to move any PIC IRQs
414 * that the BIOS has already set to active. This is necessary because
415 * ACPI has no automatic means of knowing what ISA IRQs are used. Note that
416 * if the BIOS doesn't set a Link Device active, ACPI needs to program it
417 * even if acpi_irq_nobalance is set.
419 * A tables of penalties avoids directing PCI interrupts to well known
420 * ISA IRQs. Boot params are available to over-ride the default table:
422 * List interrupts that are free for PCI use.
425 * List interrupts that should not be used for PCI:
428 * Note that PCI IRQ routers have a list of possible IRQs,
429 * which may not include the IRQs this table says are available.
431 * Since this heuristic can't tell the difference between a link
432 * that no device will attach to, vs. a link which may be shared
433 * by multiple active devices -- it is not optimal.
435 * If interrupt performance is that important, get an IO-APIC system
436 * with a pin dedicated to each device. Or for that matter, an MSI
440 #define ACPI_MAX_IRQS 256
441 #define ACPI_MAX_ISA_IRQ 16
443 #define PIRQ_PENALTY_PCI_AVAILABLE (0)
444 #define PIRQ_PENALTY_PCI_POSSIBLE (16*16)
445 #define PIRQ_PENALTY_PCI_USING (16*16*16)
446 #define PIRQ_PENALTY_ISA_TYPICAL (16*16*16*16)
447 #define PIRQ_PENALTY_ISA_USED (16*16*16*16*16)
448 #define PIRQ_PENALTY_ISA_ALWAYS (16*16*16*16*16*16)
450 static int __initdata acpi_irq_penalty[ACPI_MAX_IRQS] = {
451 PIRQ_PENALTY_ISA_ALWAYS, /* IRQ0 timer */
452 PIRQ_PENALTY_ISA_ALWAYS, /* IRQ1 keyboard */
453 PIRQ_PENALTY_ISA_ALWAYS, /* IRQ2 cascade */
454 PIRQ_PENALTY_ISA_TYPICAL, /* IRQ3 serial */
455 PIRQ_PENALTY_ISA_TYPICAL, /* IRQ4 serial */
456 PIRQ_PENALTY_ISA_TYPICAL, /* IRQ5 sometimes SoundBlaster */
457 PIRQ_PENALTY_ISA_TYPICAL, /* IRQ6 */
458 PIRQ_PENALTY_ISA_TYPICAL, /* IRQ7 parallel, spurious */
459 PIRQ_PENALTY_ISA_TYPICAL, /* IRQ8 rtc, sometimes */
460 PIRQ_PENALTY_PCI_AVAILABLE, /* IRQ9 PCI, often acpi */
461 PIRQ_PENALTY_PCI_AVAILABLE, /* IRQ10 PCI */
462 PIRQ_PENALTY_PCI_AVAILABLE, /* IRQ11 PCI */
463 PIRQ_PENALTY_ISA_USED, /* IRQ12 mouse */
464 PIRQ_PENALTY_ISA_USED, /* IRQ13 fpe, sometimes */
465 PIRQ_PENALTY_ISA_USED, /* IRQ14 ide0 */
466 PIRQ_PENALTY_ISA_USED, /* IRQ15 ide1 */
471 acpi_irq_penalty_init(void)
473 struct list_head *node = NULL;
474 struct acpi_pci_link *link = NULL;
477 ACPI_FUNCTION_TRACE("acpi_irq_penalty_init");
480 * Update penalties to facilitate IRQ balancing.
482 list_for_each(node, &acpi_link.entries) {
484 link = list_entry(node, struct acpi_pci_link, node);
486 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid link context\n"));
491 * reflect the possible and active irqs in the penalty table --
492 * useful for breaking ties.
494 if (link->irq.possible_count) {
495 int penalty = PIRQ_PENALTY_PCI_POSSIBLE / link->irq.possible_count;
497 for (i = 0; i < link->irq.possible_count; i++) {
498 if (link->irq.possible[i] < ACPI_MAX_ISA_IRQ)
499 acpi_irq_penalty[link->irq.possible[i]] += penalty;
502 } else if (link->irq.active) {
503 acpi_irq_penalty[link->irq.active] += PIRQ_PENALTY_PCI_POSSIBLE;
506 /* Add a penalty for the SCI */
507 acpi_irq_penalty[acpi_fadt.sci_int] += PIRQ_PENALTY_PCI_USING;
512 static int acpi_irq_balance; /* 0: static, 1: balance */
514 static int acpi_pci_link_allocate(struct acpi_pci_link* link) {
518 ACPI_FUNCTION_TRACE("acpi_pci_link_allocate");
520 if (link->irq.setonboot)
524 * search for active IRQ in list of possible IRQs.
526 for (i = 0; i < link->irq.possible_count; ++i) {
527 if (link->irq.active == link->irq.possible[i])
531 * forget active IRQ that is not in possible list
533 if (i == link->irq.possible_count) {
535 printk(KERN_WARNING PREFIX "_CRS %d not found"
536 " in _PRS\n", link->irq.active);
537 link->irq.active = 0;
541 * if active found, use it; else pick entry from end of possible list.
543 if (link->irq.active) {
544 irq = link->irq.active;
546 irq = link->irq.possible[link->irq.possible_count - 1];
549 if (acpi_irq_balance || !link->irq.active) {
551 * Select the best IRQ. This is done in reverse to promote
552 * the use of IRQs 9, 10, 11, and >15.
554 for (i = (link->irq.possible_count - 1); i >= 0; i--) {
555 if (acpi_irq_penalty[irq] > acpi_irq_penalty[link->irq.possible[i]])
556 irq = link->irq.possible[i];
560 /* Attempt to enable the link device at this IRQ. */
561 if (acpi_pci_link_set(link, irq)) {
562 printk(PREFIX "Unable to set IRQ for %s [%s] (likely buggy ACPI BIOS).\n"
563 "Try pci=noacpi or acpi=off\n",
564 acpi_device_name(link->device),
565 acpi_device_bid(link->device));
566 return_VALUE(-ENODEV);
568 acpi_irq_penalty[link->irq.active] += PIRQ_PENALTY_PCI_USING;
569 printk(PREFIX "%s [%s] enabled at IRQ %d\n",
570 acpi_device_name(link->device),
571 acpi_device_bid(link->device), link->irq.active);
574 link->irq.setonboot = 1;
581 acpi_pci_link_get_irq (
585 int* active_high_low)
588 struct acpi_device *device = NULL;
589 struct acpi_pci_link *link = NULL;
591 ACPI_FUNCTION_TRACE("acpi_pci_link_get_irq");
593 result = acpi_bus_get_device(handle, &device);
595 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid link device\n"));
599 link = (struct acpi_pci_link *) acpi_driver_data(device);
601 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid link context\n"));
605 /* TBD: Support multiple index (IRQ) entries per Link Device */
607 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid index %d\n", index));
611 if (acpi_pci_link_allocate(link))
614 if (!link->irq.active) {
615 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Link active IRQ is 0!\n"));
619 if (edge_level) *edge_level = link->irq.edge_level;
620 if (active_high_low) *active_high_low = link->irq.active_high_low;
621 return_VALUE(link->irq.active);
625 /* --------------------------------------------------------------------------
627 -------------------------------------------------------------------------- */
631 struct acpi_device *device)
634 struct acpi_pci_link *link = NULL;
638 ACPI_FUNCTION_TRACE("acpi_pci_link_add");
641 return_VALUE(-EINVAL);
643 link = kmalloc(sizeof(struct acpi_pci_link), GFP_KERNEL);
645 return_VALUE(-ENOMEM);
646 memset(link, 0, sizeof(struct acpi_pci_link));
648 link->device = device;
649 link->handle = device->handle;
650 strcpy(acpi_device_name(device), ACPI_PCI_LINK_DEVICE_NAME);
651 strcpy(acpi_device_class(device), ACPI_PCI_LINK_CLASS);
652 acpi_driver_data(device) = link;
654 result = acpi_pci_link_get_possible(link);
658 /* query and set link->irq.active */
659 acpi_pci_link_get_current(link);
661 printk(PREFIX "%s [%s] (IRQs", acpi_device_name(device),
662 acpi_device_bid(device));
663 for (i = 0; i < link->irq.possible_count; i++) {
664 if (link->irq.active == link->irq.possible[i]) {
665 printk(" *%d", link->irq.possible[i]);
669 printk(" %d", link->irq.possible[i]);
675 printk(" *%d", link->irq.active);
677 if(!link->device->status.enabled)
678 printk(", disabled.");
682 /* TBD: Acquire/release lock */
683 list_add_tail(&link->node, &acpi_link.entries);
687 /* disable all links -- to be activated on use */
688 acpi_ut_evaluate_object(link->handle, "_DIS", 0, NULL);
693 return_VALUE(result);
698 acpi_pci_link_remove (
699 struct acpi_device *device,
702 struct acpi_pci_link *link = NULL;
704 ACPI_FUNCTION_TRACE("acpi_pci_link_remove");
706 if (!device || !acpi_driver_data(device))
707 return_VALUE(-EINVAL);
709 link = (struct acpi_pci_link *) acpi_driver_data(device);
711 /* TBD: Acquire/release lock */
712 list_del(&link->node);
720 * modify acpi_irq_penalty[] from cmdline
722 static int __init acpi_irq_penalty_update(char *str, int used)
726 for (i = 0; i < 16; i++) {
730 retval = get_option(&str,&irq);
733 break; /* no number found */
738 if (irq >= ACPI_MAX_IRQS)
742 acpi_irq_penalty[irq] += PIRQ_PENALTY_ISA_USED;
744 acpi_irq_penalty[irq] = PIRQ_PENALTY_PCI_AVAILABLE;
746 if (retval != 2) /* no next number */
753 * Over-ride default table to reserve additional IRQs for use by ISA
754 * e.g. acpi_irq_isa=5
755 * Useful for telling ACPI how not to interfere with your ISA sound card.
757 static int __init acpi_irq_isa(char *str)
759 return(acpi_irq_penalty_update(str, 1));
761 __setup("acpi_irq_isa=", acpi_irq_isa);
764 * Over-ride default table to free additional IRQs for use by PCI
765 * e.g. acpi_irq_pci=7,15
766 * Used for acpi_irq_balance to free up IRQs to reduce PCI IRQ sharing.
768 static int __init acpi_irq_pci(char *str)
770 return(acpi_irq_penalty_update(str, 0));
772 __setup("acpi_irq_pci=", acpi_irq_pci);
774 static int __init acpi_irq_nobalance_set(char *str)
776 acpi_irq_balance = 0;
779 __setup("acpi_irq_nobalance", acpi_irq_nobalance_set);
781 int __init acpi_irq_balance_set(char *str)
783 acpi_irq_balance = 1;
786 __setup("acpi_irq_balance", acpi_irq_balance_set);
789 static int __init acpi_pci_link_init (void)
791 ACPI_FUNCTION_TRACE("acpi_pci_link_init");
793 if (acpi_pci_disabled)
797 INIT_LIST_HEAD(&acpi_link.entries);
799 if (acpi_bus_register_driver(&acpi_pci_link_driver) < 0)
800 return_VALUE(-ENODEV);
805 subsys_initcall(acpi_pci_link_init);