Remove extra debug messages, whitespace changes.
[dragonfly.git] / sys / platform / pc32 / i386 / nexus.c
CommitLineData
984263bc
MD
1/*
2 * Copyright 1998 Massachusetts Institute of Technology
3 *
4 * Permission to use, copy, modify, and distribute this software and
5 * its documentation for any purpose and without fee is hereby
6 * granted, provided that both the above copyright notice and this
7 * permission notice appear in all copies, that both the above
8 * copyright notice and this permission notice appear in all
9 * supporting documentation, and that the name of M.I.T. not be used
10 * in advertising or publicity pertaining to distribution of the
11 * software without specific, written prior permission. M.I.T. makes
12 * no representations about the suitability of this software for any
13 * purpose. It is provided "as is" without express or implied
14 * warranty.
15 *
16 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS
17 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: src/sys/i386/i386/nexus.c,v 1.26.2.10 2003/02/22 13:16:45 imp Exp $
26be20a0 30 * $DragonFly: src/sys/platform/pc32/i386/nexus.c,v 1.29 2006/12/23 00:27:03 swildner Exp $
984263bc
MD
31 */
32
33/*
34 * This code implements a `root nexus' for Intel Architecture
35 * machines. The function of the root nexus is to serve as an
36 * attachment point for both processors and buses, and to manage
37 * resources which are common to all of them. In particular,
38 * this code implements the core resource managers for interrupt
39 * requests, DMA requests (which rightfully should be a part of the
40 * ISA code but it's easier to do it here for now), I/O port addresses,
41 * and I/O memory address space.
42 */
43
984263bc
MD
44#include <sys/param.h>
45#include <sys/systm.h>
46#include <sys/bus.h>
47#include <sys/kernel.h>
48#include <sys/malloc.h>
49#include <sys/module.h>
984263bc
MD
50#include <sys/rman.h>
51
52#include <machine/vmparam.h>
53#include <vm/vm.h>
54#include <vm/pmap.h>
55#include <machine/pmap.h>
56
2899c8b1 57#include <machine/nexusvar.h>
984263bc 58#include <machine/smp.h>
a9295349
MD
59#include <machine_base/apic/mpapic.h>
60#include <machine_base/isa/intr_machdep.h>
984263bc 61
635705f1
AP
62#include <bus/pci/pcivar.h>
63#include <bus/pci/pcireg.h>
64#include <bus/pci/pcibus.h>
65#include <bus/pci/pci_cfgreg.h>
66#include <bus/pci/pcib_private.h>
67
68#include "pcib_if.h"
69
984263bc
MD
70static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
71struct nexus_device {
72 struct resource_list nx_resources;
2899c8b1 73 int nx_pcibus;
984263bc
MD
74};
75
76#define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
77
78static struct rman irq_rman, drq_rman, port_rman, mem_rman;
79
80static int nexus_probe(device_t);
81static int nexus_attach(device_t);
82static int nexus_print_all_resources(device_t dev);
83static int nexus_print_child(device_t, device_t);
2581072f
MD
84static device_t nexus_add_child(device_t bus, device_t parent, int order,
85 const char *name, int unit);
984263bc
MD
86static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
87 u_long, u_long, u_long, u_int);
2899c8b1
JS
88static int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
89static int nexus_write_ivar(device_t, device_t, int, uintptr_t);
984263bc
MD
90static int nexus_activate_resource(device_t, device_t, int, int,
91 struct resource *);
92static int nexus_deactivate_resource(device_t, device_t, int, int,
93 struct resource *);
94static int nexus_release_resource(device_t, device_t, int, int,
95 struct resource *);
17a49ad5
AP
96static int nexus_config_intr(device_t, device_t, int, enum intr_trigger,
97 enum intr_polarity);
984263bc 98static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
e9cb6d99
MD
99 void (*)(void *), void *,
100 void **, lwkt_serialize_t);
984263bc
MD
101static int nexus_teardown_intr(device_t, device_t, struct resource *,
102 void *);
103static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
104static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
105static void nexus_delete_resource(device_t, device_t, int, int);
106
39b5d600
MD
107/*
108 * The device_identify method will cause nexus to automatically associate
109 * and attach to the root bus.
110 */
984263bc
MD
111static device_method_t nexus_methods[] = {
112 /* Device interface */
39b5d600 113 DEVMETHOD(device_identify, bus_generic_identify),
984263bc
MD
114 DEVMETHOD(device_probe, nexus_probe),
115 DEVMETHOD(device_attach, nexus_attach),
116 DEVMETHOD(device_detach, bus_generic_detach),
117 DEVMETHOD(device_shutdown, bus_generic_shutdown),
118 DEVMETHOD(device_suspend, bus_generic_suspend),
119 DEVMETHOD(device_resume, bus_generic_resume),
120
121 /* Bus interface */
122 DEVMETHOD(bus_print_child, nexus_print_child),
123 DEVMETHOD(bus_add_child, nexus_add_child),
2899c8b1
JS
124 DEVMETHOD(bus_read_ivar, nexus_read_ivar),
125 DEVMETHOD(bus_write_ivar, nexus_write_ivar),
984263bc
MD
126 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
127 DEVMETHOD(bus_release_resource, nexus_release_resource),
128 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
129 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
17a49ad5 130 DEVMETHOD(bus_config_intr, nexus_config_intr),
984263bc
MD
131 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
132 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
133 DEVMETHOD(bus_set_resource, nexus_set_resource),
134 DEVMETHOD(bus_get_resource, nexus_get_resource),
135 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
136
137 { 0, 0 }
138};
139
140static driver_t nexus_driver = {
141 "nexus",
142 nexus_methods,
143 1, /* no softc */
144};
145static devclass_t nexus_devclass;
146
147DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
148
149static int
150nexus_probe(device_t dev)
151{
984263bc
MD
152 device_quiet(dev); /* suppress attach message for neatness */
153
154 /*
155 * IRQ's are on the mainboard on old systems, but on the ISA part
156 * of PCI->ISA bridges. There would be multiple sets of IRQs on
157 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
158 * component, so in a way, PCI can be a partial child of an ISA bus(!).
159 * APIC interrupts are global though.
160 * In the non-APIC case, disallow the use of IRQ 2.
161 */
162 irq_rman.rm_start = 0;
163 irq_rman.rm_type = RMAN_ARRAY;
164 irq_rman.rm_descr = "Interrupt request lines";
165#ifdef APIC_IO
166 irq_rman.rm_end = APIC_INTMAPSIZE - 1;
167 if (rman_init(&irq_rman)
168 || rman_manage_region(&irq_rman,
169 irq_rman.rm_start, irq_rman.rm_end))
170 panic("nexus_probe irq_rman");
171#else
172 irq_rman.rm_end = 15;
984263bc
MD
173 if (rman_init(&irq_rman)
174 || rman_manage_region(&irq_rman, irq_rman.rm_start, 1)
175 || rman_manage_region(&irq_rman, 3, irq_rman.rm_end))
176 panic("nexus_probe irq_rman");
984263bc
MD
177#endif
178
179 /*
180 * ISA DMA on PCI systems is implemented in the ISA part of each
181 * PCI->ISA bridge and the channels can be duplicated if there are
182 * multiple bridges. (eg: laptops with docking stations)
183 */
184 drq_rman.rm_start = 0;
984263bc 185 drq_rman.rm_end = 7;
984263bc
MD
186 drq_rman.rm_type = RMAN_ARRAY;
187 drq_rman.rm_descr = "DMA request lines";
188 /* XXX drq 0 not available on some machines */
189 if (rman_init(&drq_rman)
190 || rman_manage_region(&drq_rman,
191 drq_rman.rm_start, drq_rman.rm_end))
192 panic("nexus_probe drq_rman");
193
194 /*
195 * However, IO ports and Memory truely are global at this level,
196 * as are APIC interrupts (however many IO APICS there turn out
197 * to be on large systems..)
198 */
199 port_rman.rm_start = 0;
200 port_rman.rm_end = 0xffff;
201 port_rman.rm_type = RMAN_ARRAY;
202 port_rman.rm_descr = "I/O ports";
203 if (rman_init(&port_rman)
204 || rman_manage_region(&port_rman, 0, 0xffff))
205 panic("nexus_probe port_rman");
206
207 mem_rman.rm_start = 0;
208 mem_rman.rm_end = ~0u;
209 mem_rman.rm_type = RMAN_ARRAY;
210 mem_rman.rm_descr = "I/O memory addresses";
211 if (rman_init(&mem_rman)
212 || rman_manage_region(&mem_rman, 0, ~0))
213 panic("nexus_probe mem_rman");
214
215 return bus_generic_probe(dev);
216}
217
218static int
219nexus_attach(device_t dev)
220{
221 device_t child;
222
223 /*
41a01a4d
MD
224 * First, let our child driver's identify any child devices that
225 * they can find. Once that is done attach any devices that we
226 * found.
984263bc 227 */
41a01a4d
MD
228#if 0 /* FUTURE */
229 bus_generic_probe(dev);
230#endif
984263bc 231 bus_generic_attach(dev);
41a01a4d 232
984263bc
MD
233 /*
234 * And if we didn't see EISA or ISA on a pci bridge, create some
235 * connection points now so they show up "on motherboard".
236 */
237 if (!devclass_get_device(devclass_find("eisa"), 0)) {
2581072f 238 child = BUS_ADD_CHILD(dev, dev, 0, "eisa", 0);
984263bc
MD
239 if (child == NULL)
240 panic("nexus_attach eisa");
241 device_probe_and_attach(child);
242 }
984263bc 243 if (!devclass_get_device(devclass_find("isa"), 0)) {
2581072f 244 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
984263bc
MD
245 if (child == NULL)
246 panic("nexus_attach isa");
247 device_probe_and_attach(child);
248 }
249
250 return 0;
251}
252
253static int
254nexus_print_all_resources(device_t dev)
255{
256 struct nexus_device *ndev = DEVTONX(dev);
257 struct resource_list *rl = &ndev->nx_resources;
258 int retval = 0;
259
2899c8b1 260 if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
26be20a0 261 retval += kprintf(" at");
984263bc
MD
262
263 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
264 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
265 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
266
267 return retval;
268}
269
270static int
271nexus_print_child(device_t bus, device_t child)
272{
2899c8b1 273 struct nexus_device *ndev = DEVTONX(child);
984263bc
MD
274 int retval = 0;
275
276 retval += bus_print_child_header(bus, child);
277 retval += nexus_print_all_resources(child);
2899c8b1 278 if (ndev->nx_pcibus != -1)
26be20a0
SW
279 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
280 retval += kprintf(" on motherboard\n");
984263bc
MD
281
282 return (retval);
283}
284
285static device_t
2581072f
MD
286nexus_add_child(device_t bus, device_t parent, int order,
287 const char *name, int unit)
984263bc
MD
288{
289 device_t child;
290 struct nexus_device *ndev;
291
efda3bd0 292 ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
984263bc
MD
293 if (!ndev)
294 return(0);
295 resource_list_init(&ndev->nx_resources);
2899c8b1 296 ndev->nx_pcibus = -1;
984263bc 297
2581072f 298 child = device_add_child_ordered(parent, order, name, unit);
984263bc
MD
299
300 /* should we free this in nexus_child_detached? */
301 device_set_ivars(child, ndev);
302
303 return(child);
304}
305
2899c8b1
JS
306static int
307nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
308{
309 struct nexus_device *ndev = DEVTONX(child);
310
311 switch (which) {
312 case NEXUS_IVAR_PCIBUS:
313 *result = ndev->nx_pcibus;
314 break;
315 default:
316 return ENOENT;
317 }
318 return 0;
319}
320
321static int
322nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
323{
324 struct nexus_device *ndev = DEVTONX(child);
325
326 switch (which) {
327 case NEXUS_IVAR_PCIBUS:
328 ndev->nx_pcibus = value;
329 break;
330 default:
331 return ENOENT;
332 }
333 return 0;
334}
335
984263bc
MD
336/*
337 * Allocate a resource on behalf of child. NB: child is usually going to be a
338 * child of one of our descendants, not a direct child of nexus0.
339 * (Exceptions include npx.)
340 */
341static struct resource *
342nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
343 u_long start, u_long end, u_long count, u_int flags)
344{
345 struct nexus_device *ndev = DEVTONX(child);
346 struct resource *rv;
347 struct resource_list_entry *rle;
348 struct rman *rm;
349 int needactivate = flags & RF_ACTIVE;
350
351 /*
352 * If this is an allocation of the "default" range for a given RID, and
353 * we know what the resources for this device are (ie. they aren't maintained
354 * by a child bus), then work out the start/end values.
355 */
356 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
357 if (ndev == NULL)
358 return(NULL);
359 rle = resource_list_find(&ndev->nx_resources, type, *rid);
360 if (rle == NULL)
361 return(NULL);
362 start = rle->start;
363 end = rle->end;
364 count = rle->count;
365 }
366
367 flags &= ~RF_ACTIVE;
368
369 switch (type) {
370 case SYS_RES_IRQ:
371 rm = &irq_rman;
372 break;
373
374 case SYS_RES_DRQ:
375 rm = &drq_rman;
376 break;
377
378 case SYS_RES_IOPORT:
379 rm = &port_rman;
380 break;
381
382 case SYS_RES_MEMORY:
383 rm = &mem_rman;
384 break;
385
386 default:
387 return 0;
388 }
389
390 rv = rman_reserve_resource(rm, start, end, count, flags, child);
391 if (rv == 0)
392 return 0;
393
394 if (type == SYS_RES_MEMORY) {
395 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
396 } else if (type == SYS_RES_IOPORT) {
397 rman_set_bustag(rv, I386_BUS_SPACE_IO);
984263bc 398 rman_set_bushandle(rv, rv->r_start);
984263bc
MD
399 }
400
984263bc
MD
401 if (needactivate) {
402 if (bus_activate_resource(child, type, *rid, rv)) {
984263bc
MD
403 rman_release_resource(rv);
404 return 0;
405 }
406 }
407
408 return rv;
409}
410
411static int
412nexus_activate_resource(device_t bus, device_t child, int type, int rid,
413 struct resource *r)
414{
415 /*
416 * If this is a memory resource, map it into the kernel.
417 */
418 if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
419 caddr_t vaddr = 0;
420
778931ae 421 if (rman_get_end(r) < 1024 * 1024) {
984263bc
MD
422 /*
423 * The first 1Mb is mapped at KERNBASE.
424 */
778931ae 425 vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
984263bc
MD
426 } else {
427 u_int32_t paddr;
428 u_int32_t psize;
429 u_int32_t poffs;
430
778931ae
JS
431 paddr = rman_get_start(r);
432 psize = rman_get_size(r);
984263bc
MD
433
434 poffs = paddr - trunc_page(paddr);
435 vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
436 }
437 rman_set_virtual(r, vaddr);
984263bc
MD
438 /* IBM-PC: the type of bus_space_handle_t is u_int */
439 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
984263bc
MD
440 }
441 return (rman_activate_resource(r));
442}
443
444static int
445nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
446 struct resource *r)
447{
448 /*
449 * If this is a memory resource, unmap it.
450 */
778931ae
JS
451 if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
452 (rman_get_end(r) >= 1024 * 1024)) {
984263bc
MD
453 u_int32_t psize;
454
778931ae 455 psize = rman_get_size(r);
984263bc
MD
456 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
457 }
458
459 return (rman_deactivate_resource(r));
460}
461
462static int
463nexus_release_resource(device_t bus, device_t child, int type, int rid,
464 struct resource *r)
465{
778931ae 466 if (rman_get_flags(r) & RF_ACTIVE) {
984263bc
MD
467 int error = bus_deactivate_resource(child, type, rid, r);
468 if (error)
469 return error;
470 }
984263bc
MD
471 return (rman_release_resource(r));
472}
473
17a49ad5
AP
474
475static int
476nexus_config_intr(device_t dev, device_t child, int irq, enum intr_trigger trig,
477 enum intr_polarity pol)
478{
635705f1
AP
479#ifdef APIC_IO
480 int line;
e3ca97c0
AP
481 int slot = pci_get_slot(child);
482 int bus = pci_get_bus(child);
483 int pin = irq + 1;
e3ca97c0 484 line = pci_apic_irq(bus, slot, pin);
635705f1
AP
485 if(line >= 0)
486 return line;
487 line = isa_apic_irq(pci_get_irq(child));
e3ca97c0
AP
488 if(line >= 0)
489 return line;
490
e3ca97c0 491 return PCI_INVALID_IRQ;
635705f1
AP
492#else
493 return irq;
494#endif
17a49ad5
AP
495}
496
984263bc
MD
497/*
498 * Currently this uses the really grody interface from kern/kern_intr.c
499 * (which really doesn't belong in kern/anything.c). Eventually, all of
500 * the code in kern_intr.c and machdep_intr.c should get moved here, since
501 * this is going to be the official interface.
502 */
503static int
504nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
e9cb6d99
MD
505 int flags, void (*ihand)(void *), void *arg,
506 void **cookiep, lwkt_serialize_t serializer)
984263bc 507{
984263bc
MD
508 driver_t *driver;
509 int error, icflags;
510
511 /* somebody tried to setup an irq that failed to allocate! */
512 if (irq == NULL)
513 panic("nexus_setup_intr: NULL irq resource!");
514
515 *cookiep = 0;
2581072f
MD
516 icflags = flags;
517 if ((irq->r_flags & RF_SHAREABLE) == 0)
518 icflags |= INTR_EXCL;
984263bc
MD
519
520 driver = device_get_driver(child);
38787eef 521
984263bc
MD
522 /*
523 * We depend here on rman_activate_resource() being idempotent.
524 */
525 error = rman_activate_resource(irq);
526 if (error)
527 return (error);
528
477d3c1c
MD
529 /*
530 * XXX cast the interrupt handler function to an inthand2_t. The
531 * difference is that an additional frame argument is passed which
532 * we do not currently want to expose the BUS subsystem to.
533 */
9d522d14
MD
534 *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
535 device_get_nameunit(child), serializer,
536 icflags);
984263bc 537 if (*cookiep == NULL)
9d522d14 538 error = EINVAL;
984263bc
MD
539 return (error);
540}
541
542static int
543nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
544{
9d522d14
MD
545 if (ih) {
546 unregister_int(ih);
547 return (0);
548 }
549 return(-1);
984263bc
MD
550}
551
552static int
553nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
554{
555 struct nexus_device *ndev = DEVTONX(child);
556 struct resource_list *rl = &ndev->nx_resources;
557
558 /* XXX this should return a success/failure indicator */
559 resource_list_add(rl, type, rid, start, start + count - 1, count);
560 return(0);
561}
562
563static int
564nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
565{
566 struct nexus_device *ndev = DEVTONX(child);
567 struct resource_list *rl = &ndev->nx_resources;
568 struct resource_list_entry *rle;
569
570 rle = resource_list_find(rl, type, rid);
571 device_printf(child, "type %d rid %d startp %p countp %p - got %p\n",
572 type, rid, startp, countp, rle);
573 if (!rle)
574 return(ENOENT);
575 if (startp)
576 *startp = rle->start;
577 if (countp)
578 *countp = rle->count;
579 return(0);
580}
581
582static void
583nexus_delete_resource(device_t dev, device_t child, int type, int rid)
584{
585 struct nexus_device *ndev = DEVTONX(child);
586 struct resource_list *rl = &ndev->nx_resources;
587
588 resource_list_delete(rl, type, rid);
589}
9713df24 590