1 /*-
2 * Copyright (c) 2002 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29
30 #include "opt_acpi.h"
31 #include <sys/param.h>
32 #include <sys/bus.h>
33 #include <sys/kernel.h>
34 #include <sys/limits.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37
38 #include <contrib/dev/acpica/include/acpi.h>
39
40 #include <dev/acpica/acpivar.h>
41 #include <dev/acpica/acpi_pcibvar.h>
42
43 #include <machine/pci_cfgreg.h>
44 #include <dev/pci/pcireg.h>
45 #include <dev/pci/pcivar.h>
46 #include "pcib_if.h"
47
48 /* Hooks for the ACPI CA debugging infrastructure. */
49 #define _COMPONENT ACPI_BUS
50 ACPI_MODULE_NAME("PCI_LINK")
51
52 ACPI_SERIAL_DECL(pci_link, "ACPI PCI link");
53
54 #define NUM_ISA_INTERRUPTS 16
55 #define NUM_ACPI_INTERRUPTS 256
56
57 /*
58 * An ACPI PCI link device may contain multiple links. Each link has its
59 * own ACPI resource. _PRT entries specify which link is being used via
60 * the Source Index.
61 *
62 * XXX: A note about Source Indices and DPFs: Currently we assume that
63 * the DPF start and end tags are not counted towards the index that
64 * Source Index corresponds to. Also, we assume that when DPFs are in use
65 * they various sets overlap in terms of Indices. Here's an example
66 * resource list indicating these assumptions:
67 *
68 * Resource Index
69 * -------- -----
70 * I/O Port 0
71 * Start DPF -
72 * IRQ 1
73 * MemIO 2
74 * Start DPF -
75 * IRQ 1
76 * MemIO 2
77 * End DPF -
78 * DMA Channel 3
79 *
80 * The XXX is because I'm not sure if this is a valid assumption to make.
81 */
82
83 /* States during DPF processing. */
84 #define DPF_OUTSIDE 0
85 #define DPF_FIRST 1
86 #define DPF_IGNORE 2
87
88 struct link;
89
90 struct acpi_pci_link_softc {
91 int pl_num_links;
92 int pl_crs_bad;
93 struct link *pl_links;
94 device_t pl_dev;
95 };
96
97 struct link {
98 struct acpi_pci_link_softc *l_sc;
99 uint8_t l_bios_irq;
100 uint8_t l_irq;
101 uint8_t l_initial_irq;
102 UINT32 l_crs_type;
103 int l_res_index;
104 int l_num_irqs;
105 int *l_irqs;
106 int l_references;
107 int l_routed:1;
108 int l_isa_irq:1;
109 ACPI_RESOURCE l_prs_template;
110 };
111
112 struct link_count_request {
113 int in_dpf;
114 int count;
115 };
116
117 struct link_res_request {
118 struct acpi_pci_link_softc *sc;
119 int in_dpf;
120 int res_index;
121 int link_index;
122 };
123
124 static MALLOC_DEFINE(M_PCI_LINK, "pci_link", "ACPI PCI Link structures");
125
126 static int pci_link_interrupt_weights[NUM_ACPI_INTERRUPTS];
127 static int pci_link_bios_isa_irqs;
128
129 static char *pci_link_ids[] = { "PNP0C0F", NULL };
130
131 /*
132 * Fetch the short name associated with an ACPI handle and save it in the
133 * passed in buffer.
134 */
135 static ACPI_STATUS
136 acpi_short_name(ACPI_HANDLE handle, char *buffer, size_t buflen)
137 {
138 ACPI_BUFFER buf;
139
140 buf.Length = buflen;
141 buf.Pointer = buffer;
142 return (AcpiGetName(handle, ACPI_SINGLE_NAME, &buf));
143 }
144
145 static int
146 acpi_pci_link_probe(device_t dev)
147 {
148 char descr[28], name[12];
149
150 /*
151 * We explicitly do not check _STA since not all systems set it to
152 * sensible values.
153 */
154 if (acpi_disabled("pci_link") ||
155 ACPI_ID_PROBE(device_get_parent(dev), dev, pci_link_ids) == NULL)
156 return (ENXIO);
157
158 if (ACPI_SUCCESS(acpi_short_name(acpi_get_handle(dev), name,
159 sizeof(name)))) {
160 snprintf(descr, sizeof(descr), "ACPI PCI Link %s", name);
161 device_set_desc_copy(dev, descr);
162 } else
163 device_set_desc(dev, "ACPI PCI Link");
164 device_quiet(dev);
165 return (0);
166 }
167
168 static ACPI_STATUS
169 acpi_count_irq_resources(ACPI_RESOURCE *res, void *context)
170 {
171 struct link_count_request *req;
172
173 req = (struct link_count_request *)context;
174 switch (res->Type) {
175 case ACPI_RESOURCE_TYPE_START_DEPENDENT:
176 switch (req->in_dpf) {
177 case DPF_OUTSIDE:
178 /* We've started the first DPF. */
179 req->in_dpf = DPF_FIRST;
180 break;
181 case DPF_FIRST:
182 /* We've started the second DPF. */
183 req->in_dpf = DPF_IGNORE;
184 break;
185 }
186 break;
187 case ACPI_RESOURCE_TYPE_END_DEPENDENT:
188 /* We are finished with DPF parsing. */
189 KASSERT(req->in_dpf != DPF_OUTSIDE,
190 ("%s: end dpf when not parsing a dpf", __func__));
191 req->in_dpf = DPF_OUTSIDE;
192 break;
193 case ACPI_RESOURCE_TYPE_IRQ:
194 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
195 /*
196 * Don't count resources if we are in a DPF set that we are
197 * ignoring.
198 */
199 if (req->in_dpf != DPF_IGNORE)
200 req->count++;
201 }
202 return (AE_OK);
203 }
204
205 static ACPI_STATUS
206 link_add_crs(ACPI_RESOURCE *res, void *context)
207 {
208 struct link_res_request *req;
209 struct link *link;
210
211 ACPI_SERIAL_ASSERT(pci_link);
212 req = (struct link_res_request *)context;
213 switch (res->Type) {
214 case ACPI_RESOURCE_TYPE_START_DEPENDENT:
215 switch (req->in_dpf) {
216 case DPF_OUTSIDE:
217 /* We've started the first DPF. */
218 req->in_dpf = DPF_FIRST;
219 break;
220 case DPF_FIRST:
221 /* We've started the second DPF. */
222 panic(
223 "%s: Multiple dependent functions within a current resource",
224 __func__);
225 break;
226 }
227 break;
228 case ACPI_RESOURCE_TYPE_END_DEPENDENT:
229 /* We are finished with DPF parsing. */
230 KASSERT(req->in_dpf != DPF_OUTSIDE,
231 ("%s: end dpf when not parsing a dpf", __func__));
232 req->in_dpf = DPF_OUTSIDE;
233 break;
234 case ACPI_RESOURCE_TYPE_IRQ:
235 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
236 KASSERT(req->link_index < req->sc->pl_num_links,
237 ("%s: array boundary violation", __func__));
238 link = &req->sc->pl_links[req->link_index];
239 link->l_res_index = req->res_index;
240 link->l_crs_type = res->Type;
241 req->link_index++;
242 req->res_index++;
243
244 /*
245 * Only use the current value if there's one IRQ. Some
246 * systems return multiple IRQs (which is nonsense for _CRS)
247 * when the link hasn't been programmed.
248 */
249 if (res->Type == ACPI_RESOURCE_TYPE_IRQ) {
250 if (res->Data.Irq.InterruptCount == 1)
251 link->l_irq = res->Data.Irq.Interrupts[0];
252 } else if (res->Data.ExtendedIrq.InterruptCount == 1)
253 link->l_irq = res->Data.ExtendedIrq.Interrupts[0];
254
255 /*
256 * An IRQ of zero means that the link isn't routed.
257 */
258 if (link->l_irq == 0)
259 link->l_irq = PCI_INVALID_IRQ;
260 break;
261 default:
262 req->res_index++;
263 }
264 return (AE_OK);
265 }
266
267 /*
268 * Populate the set of possible IRQs for each device.
269 */
270 static ACPI_STATUS
271 link_add_prs(ACPI_RESOURCE *res, void *context)
272 {
273 ACPI_RESOURCE *tmp;
274 struct link_res_request *req;
275 struct link *link;
276 UINT8 *irqs = NULL;
277 UINT32 *ext_irqs = NULL;
278 int i, is_ext_irq = 1;
279
280 ACPI_SERIAL_ASSERT(pci_link);
281 req = (struct link_res_request *)context;
282 switch (res->Type) {
283 case ACPI_RESOURCE_TYPE_START_DEPENDENT:
284 switch (req->in_dpf) {
285 case DPF_OUTSIDE:
286 /* We've started the first DPF. */
287 req->in_dpf = DPF_FIRST;
288 break;
289 case DPF_FIRST:
290 /* We've started the second DPF. */
291 req->in_dpf = DPF_IGNORE;
292 break;
293 }
294 break;
295 case ACPI_RESOURCE_TYPE_END_DEPENDENT:
296 /* We are finished with DPF parsing. */
297 KASSERT(req->in_dpf != DPF_OUTSIDE,
298 ("%s: end dpf when not parsing a dpf", __func__));
299 req->in_dpf = DPF_OUTSIDE;
300 break;
301 case ACPI_RESOURCE_TYPE_IRQ:
302 is_ext_irq = 0;
303 /* fall through */
304 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
305 /*
306 * Don't parse resources if we are in a DPF set that we are
307 * ignoring.
308 */
309 if (req->in_dpf == DPF_IGNORE)
310 break;
311
312 KASSERT(req->link_index < req->sc->pl_num_links,
313 ("%s: array boundary violation", __func__));
314 link = &req->sc->pl_links[req->link_index];
315 if (link->l_res_index == -1) {
316 KASSERT(req->sc->pl_crs_bad,
317 ("res_index should be set"));
318 link->l_res_index = req->res_index;
319 }
320 req->link_index++;
321 req->res_index++;
322
323 /*
324 * Stash a copy of the resource for later use when doing
325 * _SRS.
326 */
327 tmp = &link->l_prs_template;
328 if (is_ext_irq) {
329 bcopy(res, tmp, ACPI_RS_SIZE(tmp->Data.ExtendedIrq));
330
331 /*
332 * XXX acpi_AppendBufferResource() cannot handle
333 * optional data.
334 */
335 bzero(&tmp->Data.ExtendedIrq.ResourceSource,
336 sizeof(tmp->Data.ExtendedIrq.ResourceSource));
337 tmp->Length = ACPI_RS_SIZE(tmp->Data.ExtendedIrq);
338
339 link->l_num_irqs =
340 res->Data.ExtendedIrq.InterruptCount;
341 ext_irqs = res->Data.ExtendedIrq.Interrupts;
342 } else {
343 bcopy(res, tmp, ACPI_RS_SIZE(tmp->Data.Irq));
344 link->l_num_irqs = res->Data.Irq.InterruptCount;
345 irqs = res->Data.Irq.Interrupts;
346 }
347 if (link->l_num_irqs == 0)
348 break;
349
350 /*
351 * Save a list of the valid IRQs. Also, if all of the
352 * valid IRQs are ISA IRQs, then mark this link as
353 * routed via an ISA interrupt.
354 */
355 link->l_isa_irq = TRUE;
356 link->l_irqs = malloc(sizeof(int) * link->l_num_irqs,
357 M_PCI_LINK, M_WAITOK | M_ZERO);
358 for (i = 0; i < link->l_num_irqs; i++) {
359 if (is_ext_irq) {
360 link->l_irqs[i] = ext_irqs[i];
361 if (ext_irqs[i] >= NUM_ISA_INTERRUPTS)
362 link->l_isa_irq = FALSE;
363 } else {
364 link->l_irqs[i] = irqs[i];
365 if (irqs[i] >= NUM_ISA_INTERRUPTS)
366 link->l_isa_irq = FALSE;
367 }
368 }
369
370 /*
371 * If this is not an ISA IRQ but _CRS used a non-extended
372 * IRQ descriptor, don't use _CRS as a template for _SRS.
373 */
374 if (!req->sc->pl_crs_bad && !link->l_isa_irq &&
375 link->l_crs_type == ACPI_RESOURCE_TYPE_IRQ)
376 req->sc->pl_crs_bad = TRUE;
377 break;
378 default:
379 if (req->in_dpf == DPF_IGNORE)
380 break;
381 if (req->sc->pl_crs_bad)
382 device_printf(req->sc->pl_dev,
383 "Warning: possible resource %d will be lost during _SRS\n",
384 req->res_index);
385 req->res_index++;
386 }
387 return (AE_OK);
388 }
389
390 static int
391 link_valid_irq(struct link *link, int irq)
392 {
393 int i;
394
395 ACPI_SERIAL_ASSERT(pci_link);
396
397 /* Invalid interrupts are never valid. */
398 if (!PCI_INTERRUPT_VALID(irq))
399 return (FALSE);
400
401 /* Any interrupt in the list of possible interrupts is valid. */
402 for (i = 0; i < link->l_num_irqs; i++)
403 if (link->l_irqs[i] == irq)
404 return (TRUE);
405
406 /*
407 * For links routed via an ISA interrupt, if the SCI is routed via
408 * an ISA interrupt, the SCI is always treated as a valid IRQ.
409 */
410 if (link->l_isa_irq && AcpiGbl_FADT.SciInterrupt == irq &&
411 irq < NUM_ISA_INTERRUPTS)
412 return (TRUE);
413
414 /* If the interrupt wasn't found in the list it is not valid. */
415 return (FALSE);
416 }
417
418 static void
419 acpi_pci_link_dump(struct acpi_pci_link_softc *sc, int header, const char *tag)
420 {
421 struct link *link;
422 char buf[16];
423 int i, j;
424
425 ACPI_SERIAL_ASSERT(pci_link);
426 if (header) {
427 snprintf(buf, sizeof(buf), "%s:",
428 device_get_nameunit(sc->pl_dev));
429 printf("%-16.16s Index IRQ Rtd Ref IRQs\n", buf);
430 }
431 for (i = 0; i < sc->pl_num_links; i++) {
432 link = &sc->pl_links[i];
433 printf(" %-14.14s %5d %3d %c %3d ", i == 0 ? tag : "", i,
434 link->l_irq, link->l_routed ? 'Y' : 'N',
435 link->l_references);
436 if (link->l_num_irqs == 0)
437 printf(" none");
438 else for (j = 0; j < link->l_num_irqs; j++)
439 printf(" %d", link->l_irqs[j]);
440 printf("\n");
441 }
442 }
443
444 static int
445 acpi_pci_link_attach(device_t dev)
446 {
447 struct acpi_pci_link_softc *sc;
448 struct link_count_request creq;
449 struct link_res_request rreq;
450 ACPI_STATUS status;
451 int i;
452
453 sc = device_get_softc(dev);
454 sc->pl_dev = dev;
455 ACPI_SERIAL_BEGIN(pci_link);
456
457 /*
458 * Count the number of current resources so we know how big of
459 * a link array to allocate. On some systems, _CRS is broken,
460 * so for those systems try to derive the count from _PRS instead.
461 */
462 creq.in_dpf = DPF_OUTSIDE;
463 creq.count = 0;
464 status = AcpiWalkResources(acpi_get_handle(dev), "_CRS",
465 acpi_count_irq_resources, &creq);
466 sc->pl_crs_bad = ACPI_FAILURE(status);
467 if (sc->pl_crs_bad) {
468 creq.in_dpf = DPF_OUTSIDE;
469 creq.count = 0;
470 status = AcpiWalkResources(acpi_get_handle(dev), "_PRS",
471 acpi_count_irq_resources, &creq);
472 if (ACPI_FAILURE(status)) {
473 device_printf(dev,
474 "Unable to parse _CRS or _PRS: %s\n",
475 AcpiFormatException(status));
476 ACPI_SERIAL_END(pci_link);
477 return (ENXIO);
478 }
479 }
480 sc->pl_num_links = creq.count;
481 if (creq.count == 0) {
482 ACPI_SERIAL_END(pci_link);
483 return (0);
484 }
485 sc->pl_links = malloc(sizeof(struct link) * sc->pl_num_links,
486 M_PCI_LINK, M_WAITOK | M_ZERO);
487
488 /* Initialize the child links. */
489 for (i = 0; i < sc->pl_num_links; i++) {
490 sc->pl_links[i].l_irq = PCI_INVALID_IRQ;
491 sc->pl_links[i].l_bios_irq = PCI_INVALID_IRQ;
492 sc->pl_links[i].l_sc = sc;
493 sc->pl_links[i].l_isa_irq = FALSE;
494 sc->pl_links[i].l_res_index = -1;
495 }
496
497 /* Try to read the current settings from _CRS if it is valid. */
498 if (!sc->pl_crs_bad) {
499 rreq.in_dpf = DPF_OUTSIDE;
500 rreq.link_index = 0;
501 rreq.res_index = 0;
502 rreq.sc = sc;
503 status = AcpiWalkResources(acpi_get_handle(dev), "_CRS",
504 link_add_crs, &rreq);
505 if (ACPI_FAILURE(status)) {
506 device_printf(dev, "Unable to parse _CRS: %s\n",
507 AcpiFormatException(status));
508 goto fail;
509 }
510 }
511
512 /*
513 * Try to read the possible settings from _PRS. Note that if the
514 * _CRS is toast, we depend on having a working _PRS. However, if
515 * _CRS works, then it is ok for _PRS to be missing.
516 */
517 rreq.in_dpf = DPF_OUTSIDE;
518 rreq.link_index = 0;
519 rreq.res_index = 0;
520 rreq.sc = sc;
521 status = AcpiWalkResources(acpi_get_handle(dev), "_PRS",
522 link_add_prs, &rreq);
523 if (ACPI_FAILURE(status) &&
524 (status != AE_NOT_FOUND || sc->pl_crs_bad)) {
525 device_printf(dev, "Unable to parse _PRS: %s\n",
526 AcpiFormatException(status));
527 goto fail;
528 }
529 if (bootverbose)
530 acpi_pci_link_dump(sc, 1, "Initial Probe");
531
532 /* Verify initial IRQs if we have _PRS. */
533 if (status != AE_NOT_FOUND)
534 for (i = 0; i < sc->pl_num_links; i++)
535 if (!link_valid_irq(&sc->pl_links[i],
536 sc->pl_links[i].l_irq))
537 sc->pl_links[i].l_irq = PCI_INVALID_IRQ;
538 if (bootverbose)
539 acpi_pci_link_dump(sc, 0, "Validation");
540
541 /* Save initial IRQs. */
542 for (i = 0; i < sc->pl_num_links; i++)
543 sc->pl_links[i].l_initial_irq = sc->pl_links[i].l_irq;
544
545 /*
546 * Try to disable this link. If successful, set the current IRQ to
547 * zero and flags to indicate this link is not routed. If we can't
548 * run _DIS (i.e., the method doesn't exist), assume the initial
549 * IRQ was routed by the BIOS.
550 */
551 if (ACPI_SUCCESS(AcpiEvaluateObject(acpi_get_handle(dev), "_DIS", NULL,
552 NULL)))
553 for (i = 0; i < sc->pl_num_links; i++)
554 sc->pl_links[i].l_irq = PCI_INVALID_IRQ;
555 else
556 for (i = 0; i < sc->pl_num_links; i++)
557 if (PCI_INTERRUPT_VALID(sc->pl_links[i].l_irq))
558 sc->pl_links[i].l_routed = TRUE;
559 if (bootverbose)
560 acpi_pci_link_dump(sc, 0, "After Disable");
561 ACPI_SERIAL_END(pci_link);
562 return (0);
563 fail:
564 ACPI_SERIAL_END(pci_link);
565 for (i = 0; i < sc->pl_num_links; i++)
566 if (sc->pl_links[i].l_irqs != NULL)
567 free(sc->pl_links[i].l_irqs, M_PCI_LINK);
568 free(sc->pl_links, M_PCI_LINK);
569 return (ENXIO);
570 }
571
572 /* XXX: Note that this is identical to pci_pir_search_irq(). */
573 static uint8_t
574 acpi_pci_link_search_irq(int bus, int device, int pin)
575 {
576 uint32_t value;
577 uint8_t func, maxfunc;
578
579 /* See if we have a valid device at function 0. */
580 value = pci_cfgregread(bus, device, 0, PCIR_VENDOR, 2);
581 if (value == PCIV_INVALID)
582 return (PCI_INVALID_IRQ);
583 value = pci_cfgregread(bus, device, 0, PCIR_HDRTYPE, 1);
584 if ((value & PCIM_HDRTYPE) > PCI_MAXHDRTYPE)
585 return (PCI_INVALID_IRQ);
586 if (value & PCIM_MFDEV)
587 maxfunc = PCI_FUNCMAX;
588 else
589 maxfunc = 0;
590
591 /* Scan all possible functions at this device. */
592 for (func = 0; func <= maxfunc; func++) {
593 value = pci_cfgregread(bus, device, func, PCIR_VENDOR, 2);
594 if (value == PCIV_INVALID)
595 continue;
596 value = pci_cfgregread(bus, device, func, PCIR_INTPIN, 1);
597
598 /*
599 * See if it uses the pin in question. Note that the passed
600 * in pin uses 0 for A, .. 3 for D whereas the intpin
601 * register uses 0 for no interrupt, 1 for A, .. 4 for D.
602 */
603 if (value != pin + 1)
604 continue;
605 value = pci_cfgregread(bus, device, func, PCIR_INTLINE, 1);
606 if (bootverbose)
607 printf(
608 "ACPI: Found matching pin for %d.%d.INT%c at func %d: %d\n",
609 bus, device, pin + 'A', func, value);
610 if (value != PCI_INVALID_IRQ)
611 return (value);
612 }
613 return (PCI_INVALID_IRQ);
614 }
615
616 /*
617 * Find the link structure that corresponds to the resource index passed in
618 * via 'source_index'.
619 */
620 static struct link *
621 acpi_pci_link_lookup(device_t dev, int source_index)
622 {
623 struct acpi_pci_link_softc *sc;
624 int i;
625
626 ACPI_SERIAL_ASSERT(pci_link);
627 sc = device_get_softc(dev);
628 for (i = 0; i < sc->pl_num_links; i++)
629 if (sc->pl_links[i].l_res_index == source_index)
630 return (&sc->pl_links[i]);
631 return (NULL);
632 }
633
634 void
635 acpi_pci_link_add_reference(device_t dev, int index, device_t pcib, int slot,
636 int pin)
637 {
638 struct link *link;
639 uint8_t bios_irq;
640 uintptr_t bus;
641
642 /*
643 * Look up the PCI bus for the specified PCI bridge device. Note
644 * that the PCI bridge device might not have any children yet.
645 * However, looking up its bus number doesn't require a valid child
646 * device, so we just pass NULL.
647 */
648 if (BUS_READ_IVAR(pcib, NULL, PCIB_IVAR_BUS, &bus) != 0) {
649 device_printf(pcib, "Unable to read PCI bus number");
650 panic("PCI bridge without a bus number");
651 }
652
653 /* Bump the reference count. */
654 ACPI_SERIAL_BEGIN(pci_link);
655 link = acpi_pci_link_lookup(dev, index);
656 if (link == NULL) {
657 device_printf(dev, "apparently invalid index %d\n", index);
658 ACPI_SERIAL_END(pci_link);
659 return;
660 }
661 link->l_references++;
662 if (link->l_routed)
663 pci_link_interrupt_weights[link->l_irq]++;
664
665 /*
666 * The BIOS only routes interrupts via ISA IRQs using the ATPICs
667 * (8259As). Thus, if this link is routed via an ISA IRQ, go
668 * look to see if the BIOS routed an IRQ for this link at the
669 * indicated (bus, slot, pin). If so, we prefer that IRQ for
670 * this link and add that IRQ to our list of known-good IRQs.
671 * This provides a good work-around for link devices whose _CRS
672 * method is either broken or bogus. We only use the value
673 * returned by _CRS if we can't find a valid IRQ via this method
674 * in fact.
675 *
676 * If this link is not routed via an ISA IRQ (because we are using
677 * APIC for example), then don't bother looking up the BIOS IRQ
678 * as if we find one it won't be valid anyway.
679 */
680 if (!link->l_isa_irq) {
681 ACPI_SERIAL_END(pci_link);
682 return;
683 }
684
685 /* Try to find a BIOS IRQ setting from any matching devices. */
686 bios_irq = acpi_pci_link_search_irq(bus, slot, pin);
687 if (!PCI_INTERRUPT_VALID(bios_irq)) {
688 ACPI_SERIAL_END(pci_link);
689 return;
690 }
691
692 /* Validate the BIOS IRQ. */
693 if (!link_valid_irq(link, bios_irq)) {
694 device_printf(dev, "BIOS IRQ %u for %d.%d.INT%c is invalid\n",
695 bios_irq, (int)bus, slot, pin + 'A');
696 } else if (!PCI_INTERRUPT_VALID(link->l_bios_irq)) {
697 link->l_bios_irq = bios_irq;
698 if (bios_irq < NUM_ISA_INTERRUPTS)
699 pci_link_bios_isa_irqs |= (1 << bios_irq);
700 if (bios_irq != link->l_initial_irq &&
701 PCI_INTERRUPT_VALID(link->l_initial_irq))
702 device_printf(dev,
703 "BIOS IRQ %u does not match initial IRQ %u\n",
704 bios_irq, link->l_initial_irq);
705 } else if (bios_irq != link->l_bios_irq)
706 device_printf(dev,
707 "BIOS IRQ %u for %d.%d.INT%c does not match previous BIOS IRQ %u\n",
708 bios_irq, (int)bus, slot, pin + 'A',
709 link->l_bios_irq);
710 ACPI_SERIAL_END(pci_link);
711 }
712
713 static ACPI_STATUS
714 acpi_pci_link_srs_from_crs(struct acpi_pci_link_softc *sc, ACPI_BUFFER *srsbuf)
715 {
716 ACPI_RESOURCE *end, *res;
717 ACPI_STATUS status;
718 struct link *link;
719 int i, in_dpf;
720
721 /* Fetch the _CRS. */
722 ACPI_SERIAL_ASSERT(pci_link);
723 srsbuf->Pointer = NULL;
724 srsbuf->Length = ACPI_ALLOCATE_BUFFER;
725 status = AcpiGetCurrentResources(acpi_get_handle(sc->pl_dev), srsbuf);
726 if (ACPI_SUCCESS(status) && srsbuf->Pointer == NULL)
727 status = AE_NO_MEMORY;
728 if (ACPI_FAILURE(status)) {
729 if (bootverbose)
730 device_printf(sc->pl_dev,
731 "Unable to fetch current resources: %s\n",
732 AcpiFormatException(status));
733 return (status);
734 }
735
736 /* Fill in IRQ resources via link structures. */
737 link = sc->pl_links;
738 i = 0;
739 in_dpf = DPF_OUTSIDE;
740 res = (ACPI_RESOURCE *)srsbuf->Pointer;
741 end = (ACPI_RESOURCE *)((char *)srsbuf->Pointer + srsbuf->Length);
742 for (;;) {
743 switch (res->Type) {
744 case ACPI_RESOURCE_TYPE_START_DEPENDENT:
745 switch (in_dpf) {
746 case DPF_OUTSIDE:
747 /* We've started the first DPF. */
748 in_dpf = DPF_FIRST;
749 break;
750 case DPF_FIRST:
751 /* We've started the second DPF. */
752 panic(
753 "%s: Multiple dependent functions within a current resource",
754 __func__);
755 break;
756 }
757 break;
758 case ACPI_RESOURCE_TYPE_END_DEPENDENT:
759 /* We are finished with DPF parsing. */
760 KASSERT(in_dpf != DPF_OUTSIDE,
761 ("%s: end dpf when not parsing a dpf", __func__));
762 in_dpf = DPF_OUTSIDE;
763 break;
764 case ACPI_RESOURCE_TYPE_IRQ:
765 MPASS(i < sc->pl_num_links);
766 res->Data.Irq.InterruptCount = 1;
767 if (PCI_INTERRUPT_VALID(link->l_irq)) {
768 KASSERT(link->l_irq < NUM_ISA_INTERRUPTS,
769 ("%s: can't put non-ISA IRQ %d in legacy IRQ resource type",
770 __func__, link->l_irq));
771 res->Data.Irq.Interrupts[0] = link->l_irq;
772 } else
773 res->Data.Irq.Interrupts[0] = 0;
774 link++;
775 i++;
776 break;
777 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
778 MPASS(i < sc->pl_num_links);
779 res->Data.ExtendedIrq.InterruptCount = 1;
780 if (PCI_INTERRUPT_VALID(link->l_irq))
781 res->Data.ExtendedIrq.Interrupts[0] =
782 link->l_irq;
783 else
784 res->Data.ExtendedIrq.Interrupts[0] = 0;
785 link++;
786 i++;
787 break;
788 }
789 if (res->Type == ACPI_RESOURCE_TYPE_END_TAG)
790 break;
791 res = ACPI_NEXT_RESOURCE(res);
792 if (res >= end)
793 break;
794 }
795 return (AE_OK);
796 }
797
798 static ACPI_STATUS
799 acpi_pci_link_srs_from_links(struct acpi_pci_link_softc *sc,
800 ACPI_BUFFER *srsbuf)
801 {
802 ACPI_RESOURCE newres;
803 ACPI_STATUS status;
804 struct link *link;
805 int i;
806
807 /* Start off with an empty buffer. */
808 srsbuf->Pointer = NULL;
809 link = sc->pl_links;
810 for (i = 0; i < sc->pl_num_links; i++) {
811
812 /* Add a new IRQ resource from each link. */
813 link = &sc->pl_links[i];
814 if (link->l_prs_template.Type == ACPI_RESOURCE_TYPE_IRQ) {
815
816 /* Build an IRQ resource. */
817 bcopy(&link->l_prs_template, &newres,
818 ACPI_RS_SIZE(newres.Data.Irq));
819 newres.Data.Irq.InterruptCount = 1;
820 if (PCI_INTERRUPT_VALID(link->l_irq)) {
821 KASSERT(link->l_irq < NUM_ISA_INTERRUPTS,
822 ("%s: can't put non-ISA IRQ %d in legacy IRQ resource type",
823 __func__, link->l_irq));
824 newres.Data.Irq.Interrupts[0] = link->l_irq;
825 } else
826 newres.Data.Irq.Interrupts[0] = 0;
827 } else {
828
829 /* Build an ExtIRQ resuorce. */
830 bcopy(&link->l_prs_template, &newres,
831 ACPI_RS_SIZE(newres.Data.ExtendedIrq));
832 newres.Data.ExtendedIrq.InterruptCount = 1;
833 if (PCI_INTERRUPT_VALID(link->l_irq))
834 newres.Data.ExtendedIrq.Interrupts[0] =
835 link->l_irq;
836 else
837 newres.Data.ExtendedIrq.Interrupts[0] = 0;
838 }
839
840 /* Add the new resource to the end of the _SRS buffer. */
841 status = acpi_AppendBufferResource(srsbuf, &newres);
842 if (ACPI_FAILURE(status)) {
843 device_printf(sc->pl_dev,
844 "Unable to build resources: %s\n",
845 AcpiFormatException(status));
846 if (srsbuf->Pointer != NULL)
847 AcpiOsFree(srsbuf->Pointer);
848 return (status);
849 }
850 }
851 return (AE_OK);
852 }
853
854 static ACPI_STATUS
855 acpi_pci_link_route_irqs(device_t dev)
856 {
857 struct acpi_pci_link_softc *sc;
858 ACPI_RESOURCE *resource, *end;
859 ACPI_BUFFER srsbuf;
860 ACPI_STATUS status;
861 struct link *link;
862 int i;
863
864 ACPI_SERIAL_ASSERT(pci_link);
865 sc = device_get_softc(dev);
866 if (sc->pl_crs_bad)
867 status = acpi_pci_link_srs_from_links(sc, &srsbuf);
868 else
869 status = acpi_pci_link_srs_from_crs(sc, &srsbuf);
870
871 /* Write out new resources via _SRS. */
872 status = AcpiSetCurrentResources(acpi_get_handle(dev), &srsbuf);
873 if (ACPI_FAILURE(status)) {
874 device_printf(dev, "Unable to route IRQs: %s\n",
875 AcpiFormatException(status));
876 AcpiOsFree(srsbuf.Pointer);
877 return (status);
878 }
879
880 /*
881 * Perform acpi_config_intr() on each IRQ resource if it was just
882 * routed for the first time.
883 */
884 link = sc->pl_links;
885 i = 0;
886 resource = (ACPI_RESOURCE *)srsbuf.Pointer;
887 end = (ACPI_RESOURCE *)((char *)srsbuf.Pointer + srsbuf.Length);
888 for (;;) {
889 if (resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
890 break;
891 switch (resource->Type) {
892 case ACPI_RESOURCE_TYPE_IRQ:
893 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
894 MPASS(i < sc->pl_num_links);
895
896 /*
897 * Only configure the interrupt and update the
898 * weights if this link has a valid IRQ and was
899 * previously unrouted.
900 */
901 if (!link->l_routed &&
902 PCI_INTERRUPT_VALID(link->l_irq)) {
903 link->l_routed = TRUE;
904 acpi_config_intr(dev, resource);
905 pci_link_interrupt_weights[link->l_irq] +=
906 link->l_references;
907 }
908 link++;
909 i++;
910 break;
911 }
912 resource = ACPI_NEXT_RESOURCE(resource);
913 if (resource >= end)
914 break;
915 }
916 AcpiOsFree(srsbuf.Pointer);
917 return (AE_OK);
918 }
919
920 static int
921 acpi_pci_link_resume(device_t dev)
922 {
923 struct acpi_pci_link_softc *sc;
924 ACPI_STATUS status;
925 int i, routed;
926
927 /*
928 * If all of our links are routed, then restore the link via _SRS,
929 * otherwise, disable the link via _DIS.
930 */
931 ACPI_SERIAL_BEGIN(pci_link);
932 sc = device_get_softc(dev);
933 routed = 0;
934 for (i = 0; i < sc->pl_num_links; i++)
935 if (sc->pl_links[i].l_routed)
936 routed++;
937 if (routed == sc->pl_num_links)
938 status = acpi_pci_link_route_irqs(dev);
939 else {
940 AcpiEvaluateObject(acpi_get_handle(dev), "_DIS", NULL, NULL);
941 status = AE_OK;
942 }
943 ACPI_SERIAL_END(pci_link);
944 if (ACPI_FAILURE(status))
945 return (ENXIO);
946 else
947 return (0);
948 }
949
950 /*
951 * Pick an IRQ to use for this unrouted link.
952 */
953 static uint8_t
954 acpi_pci_link_choose_irq(device_t dev, struct link *link)
955 {
956 char tunable_buffer[64], link_name[5];
957 u_int8_t best_irq, pos_irq;
958 int best_weight, pos_weight, i;
959
960 KASSERT(!link->l_routed, ("%s: link already routed", __func__));
961 KASSERT(!PCI_INTERRUPT_VALID(link->l_irq),
962 ("%s: link already has an IRQ", __func__));
963
964 /* Check for a tunable override. */
965 if (ACPI_SUCCESS(acpi_short_name(acpi_get_handle(dev), link_name,
966 sizeof(link_name)))) {
967 snprintf(tunable_buffer, sizeof(tunable_buffer),
968 "hw.pci.link.%s.%d.irq", link_name, link->l_res_index);
969 if (getenv_int(tunable_buffer, &i) && PCI_INTERRUPT_VALID(i)) {
970 if (!link_valid_irq(link, i))
971 device_printf(dev,
972 "Warning, IRQ %d is not listed as valid\n",
973 i);
974 return (i);
975 }
976 snprintf(tunable_buffer, sizeof(tunable_buffer),
977 "hw.pci.link.%s.irq", link_name);
978 if (getenv_int(tunable_buffer, &i) && PCI_INTERRUPT_VALID(i)) {
979 if (!link_valid_irq(link, i))
980 device_printf(dev,
981 "Warning, IRQ %d is not listed as valid\n",
982 i);
983 return (i);
984 }
985 }
986
987 /*
988 * If we have a valid BIOS IRQ, use that. We trust what the BIOS
989 * says it routed over what _CRS says the link thinks is routed.
990 */
991 if (PCI_INTERRUPT_VALID(link->l_bios_irq))
992 return (link->l_bios_irq);
993
994 /*
995 * If we don't have a BIOS IRQ but do have a valid IRQ from _CRS,
996 * then use that.
997 */
998 if (PCI_INTERRUPT_VALID(link->l_initial_irq))
999 return (link->l_initial_irq);
1000
1001 /*
1002 * Ok, we have no useful hints, so we have to pick from the
1003 * possible IRQs. For ISA IRQs we only use interrupts that
1004 * have already been used by the BIOS.
1005 */
1006 best_irq = PCI_INVALID_IRQ;
1007 best_weight = INT_MAX;
1008 for (i = 0; i < link->l_num_irqs; i++) {
1009 pos_irq = link->l_irqs[i];
1010 if (pos_irq < NUM_ISA_INTERRUPTS &&
1011 (pci_link_bios_isa_irqs & 1 << pos_irq) == 0)
1012 continue;
1013 pos_weight = pci_link_interrupt_weights[pos_irq];
1014 if (pos_weight < best_weight) {
1015 best_weight = pos_weight;
1016 best_irq = pos_irq;
1017 }
1018 }
1019
1020 /*
1021 * If this is an ISA IRQ, try using the SCI if it is also an ISA
1022 * interrupt as a fallback.
1023 */
1024 if (link->l_isa_irq) {
1025 pos_irq = AcpiGbl_FADT.SciInterrupt;
1026 pos_weight = pci_link_interrupt_weights[pos_irq];
1027 if (pos_weight < best_weight) {
1028 best_weight = pos_weight;
1029 best_irq = pos_irq;
1030 }
1031 }
1032
1033 if (PCI_INTERRUPT_VALID(best_irq)) {
1034 if (bootverbose)
1035 device_printf(dev, "Picked IRQ %u with weight %d\n",
1036 best_irq, best_weight);
1037 } else
1038 device_printf(dev, "Unable to choose an IRQ\n");
1039 return (best_irq);
1040 }
1041
1042 int
1043 acpi_pci_link_route_interrupt(device_t dev, int index)
1044 {
1045 struct link *link;
1046
1047 if (acpi_disabled("pci_link"))
1048 return (PCI_INVALID_IRQ);
1049
1050 ACPI_SERIAL_BEGIN(pci_link);
1051 link = acpi_pci_link_lookup(dev, index);
1052 if (link == NULL)
1053 panic("%s: apparently invalid index %d", __func__, index);
1054
1055 /*
1056 * If this link device is already routed to an interrupt, just return
1057 * the interrupt it is routed to.
1058 */
1059 if (link->l_routed) {
1060 KASSERT(PCI_INTERRUPT_VALID(link->l_irq),
1061 ("%s: link is routed but has an invalid IRQ", __func__));
1062 ACPI_SERIAL_END(pci_link);
1063 return (link->l_irq);
1064 }
1065
1066 /* Choose an IRQ if we need one. */
1067 if (!PCI_INTERRUPT_VALID(link->l_irq)) {
1068 link->l_irq = acpi_pci_link_choose_irq(dev, link);
1069
1070 /*
1071 * Try to route the interrupt we picked. If it fails, then
1072 * assume the interrupt is not routed.
1073 */
1074 if (PCI_INTERRUPT_VALID(link->l_irq)) {
1075 acpi_pci_link_route_irqs(dev);
1076 if (!link->l_routed)
1077 link->l_irq = PCI_INVALID_IRQ;
1078 }
1079 }
1080 ACPI_SERIAL_END(pci_link);
1081
1082 return (link->l_irq);
1083 }
1084
1085 /*
1086 * This is gross, but we abuse the identify routine to perform one-time
1087 * SYSINIT() style initialization for the driver.
1088 */
1089 static void
1090 acpi_pci_link_identify(driver_t *driver, device_t parent)
1091 {
1092
1093 /*
1094 * If the SCI is an ISA IRQ, add it to the bitmask of known good
1095 * ISA IRQs.
1096 *
1097 * XXX: If we are using the APIC, the SCI might have been
1098 * rerouted to an APIC pin in which case this is invalid. However,
1099 * if we are using the APIC, we also shouldn't be having any PCI
1100 * interrupts routed via ISA IRQs, so this is probably ok.
1101 */
1102 if (AcpiGbl_FADT.SciInterrupt < NUM_ISA_INTERRUPTS)
1103 pci_link_bios_isa_irqs |= (1 << AcpiGbl_FADT.SciInterrupt);
1104 }
1105
1106 static device_method_t acpi_pci_link_methods[] = {
1107 /* Device interface */
1108 DEVMETHOD(device_identify, acpi_pci_link_identify),
1109 DEVMETHOD(device_probe, acpi_pci_link_probe),
1110 DEVMETHOD(device_attach, acpi_pci_link_attach),
1111 DEVMETHOD(device_resume, acpi_pci_link_resume),
1112
1113 DEVMETHOD_END
1114 };
1115
1116 static driver_t acpi_pci_link_driver = {
1117 "pci_link",
1118 acpi_pci_link_methods,
1119 sizeof(struct acpi_pci_link_softc),
1120 };
1121
1122 static devclass_t pci_link_devclass;
1123
1124 DRIVER_MODULE(acpi_pci_link, acpi, acpi_pci_link_driver, pci_link_devclass, 0,
1125 0);
1126 MODULE_DEPEND(acpi_pci_link, acpi, 1, 1, 1);
Cache object: 18edadeec93a117fd4b7c6a03b5e229f
|