icu: Split out icu/icu.c
[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 $
30 */
31
32/*
33 * This code implements a `root nexus' for Intel Architecture
34 * machines. The function of the root nexus is to serve as an
35 * attachment point for both processors and buses, and to manage
36 * resources which are common to all of them. In particular,
37 * this code implements the core resource managers for interrupt
38 * requests, DMA requests (which rightfully should be a part of the
39 * ISA code but it's easier to do it here for now), I/O port addresses,
40 * and I/O memory address space.
41 */
42
984263bc
MD
43#include <sys/param.h>
44#include <sys/systm.h>
45#include <sys/bus.h>
46#include <sys/kernel.h>
47#include <sys/malloc.h>
48#include <sys/module.h>
984263bc 49#include <sys/rman.h>
1b505979 50#include <sys/interrupt.h>
984263bc
MD
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
47ce2ca6
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 *);
96static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
e9cb6d99
MD
97 void (*)(void *), void *,
98 void **, lwkt_serialize_t);
984263bc
MD
99static int nexus_teardown_intr(device_t, device_t, struct resource *,
100 void *);
101static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
102static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
103static void nexus_delete_resource(device_t, device_t, int, int);
104
39b5d600
MD
105/*
106 * The device_identify method will cause nexus to automatically associate
107 * and attach to the root bus.
108 */
984263bc
MD
109static device_method_t nexus_methods[] = {
110 /* Device interface */
39b5d600 111 DEVMETHOD(device_identify, bus_generic_identify),
984263bc
MD
112 DEVMETHOD(device_probe, nexus_probe),
113 DEVMETHOD(device_attach, nexus_attach),
114 DEVMETHOD(device_detach, bus_generic_detach),
115 DEVMETHOD(device_shutdown, bus_generic_shutdown),
116 DEVMETHOD(device_suspend, bus_generic_suspend),
117 DEVMETHOD(device_resume, bus_generic_resume),
118
119 /* Bus interface */
120 DEVMETHOD(bus_print_child, nexus_print_child),
121 DEVMETHOD(bus_add_child, nexus_add_child),
2899c8b1
JS
122 DEVMETHOD(bus_read_ivar, nexus_read_ivar),
123 DEVMETHOD(bus_write_ivar, nexus_write_ivar),
984263bc
MD
124 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
125 DEVMETHOD(bus_release_resource, nexus_release_resource),
126 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
127 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
128 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
129 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
130 DEVMETHOD(bus_set_resource, nexus_set_resource),
131 DEVMETHOD(bus_get_resource, nexus_get_resource),
132 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
133
134 { 0, 0 }
135};
136
137static driver_t nexus_driver = {
138 "nexus",
139 nexus_methods,
140 1, /* no softc */
141};
142static devclass_t nexus_devclass;
143
144DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
145
146static int
147nexus_probe(device_t dev)
148{
984263bc
MD
149 device_quiet(dev); /* suppress attach message for neatness */
150
151 /*
152 * IRQ's are on the mainboard on old systems, but on the ISA part
153 * of PCI->ISA bridges. There would be multiple sets of IRQs on
154 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
155 * component, so in a way, PCI can be a partial child of an ISA bus(!).
156 * APIC interrupts are global though.
157 * In the non-APIC case, disallow the use of IRQ 2.
158 */
159 irq_rman.rm_start = 0;
160 irq_rman.rm_type = RMAN_ARRAY;
161 irq_rman.rm_descr = "Interrupt request lines";
30c5f287
MN
162
163#if SMP /* APIC-IO */
164if (apic_io_enable) {
984263bc
MD
165 irq_rman.rm_end = APIC_INTMAPSIZE - 1;
166 if (rman_init(&irq_rman)
167 || rman_manage_region(&irq_rman,
168 irq_rman.rm_start, irq_rman.rm_end))
169 panic("nexus_probe irq_rman");
30c5f287
MN
170} else {
171#endif
984263bc 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");
30c5f287
MN
177#if SMP /* APIC-IO */
178}
984263bc 179#endif
984263bc
MD
180 /*
181 * ISA DMA on PCI systems is implemented in the ISA part of each
182 * PCI->ISA bridge and the channels can be duplicated if there are
183 * multiple bridges. (eg: laptops with docking stations)
184 */
185 drq_rman.rm_start = 0;
984263bc 186 drq_rman.rm_end = 7;
984263bc
MD
187 drq_rman.rm_type = RMAN_ARRAY;
188 drq_rman.rm_descr = "DMA request lines";
189 /* XXX drq 0 not available on some machines */
190 if (rman_init(&drq_rman)
191 || rman_manage_region(&drq_rman,
192 drq_rman.rm_start, drq_rman.rm_end))
193 panic("nexus_probe drq_rman");
194
195 /*
196 * However, IO ports and Memory truely are global at this level,
197 * as are APIC interrupts (however many IO APICS there turn out
198 * to be on large systems..)
199 */
200 port_rman.rm_start = 0;
201 port_rman.rm_end = 0xffff;
202 port_rman.rm_type = RMAN_ARRAY;
203 port_rman.rm_descr = "I/O ports";
204 if (rman_init(&port_rman)
205 || rman_manage_region(&port_rman, 0, 0xffff))
206 panic("nexus_probe port_rman");
207
208 mem_rman.rm_start = 0;
209 mem_rman.rm_end = ~0u;
210 mem_rman.rm_type = RMAN_ARRAY;
211 mem_rman.rm_descr = "I/O memory addresses";
212 if (rman_init(&mem_rman)
213 || rman_manage_region(&mem_rman, 0, ~0))
214 panic("nexus_probe mem_rman");
215
216 return bus_generic_probe(dev);
217}
218
219static int
220nexus_attach(device_t dev)
221{
222 device_t child;
223
224 /*
41a01a4d
MD
225 * First, let our child driver's identify any child devices that
226 * they can find. Once that is done attach any devices that we
227 * found.
984263bc 228 */
41a01a4d
MD
229#if 0 /* FUTURE */
230 bus_generic_probe(dev);
231#endif
984263bc 232 bus_generic_attach(dev);
41a01a4d 233
984263bc
MD
234 /*
235 * And if we didn't see EISA or ISA on a pci bridge, create some
236 * connection points now so they show up "on motherboard".
237 */
238 if (!devclass_get_device(devclass_find("eisa"), 0)) {
2581072f 239 child = BUS_ADD_CHILD(dev, dev, 0, "eisa", 0);
984263bc
MD
240 if (child == NULL)
241 panic("nexus_attach eisa");
242 device_probe_and_attach(child);
243 }
984263bc 244 if (!devclass_get_device(devclass_find("isa"), 0)) {
2581072f 245 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
984263bc
MD
246 if (child == NULL)
247 panic("nexus_attach isa");
248 device_probe_and_attach(child);
249 }
250
251 return 0;
252}
253
254static int
255nexus_print_all_resources(device_t dev)
256{
257 struct nexus_device *ndev = DEVTONX(dev);
258 struct resource_list *rl = &ndev->nx_resources;
259 int retval = 0;
260
2899c8b1 261 if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
26be20a0 262 retval += kprintf(" at");
984263bc
MD
263
264 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
265 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
266 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
267
268 return retval;
269}
270
271static int
272nexus_print_child(device_t bus, device_t child)
273{
2899c8b1 274 struct nexus_device *ndev = DEVTONX(child);
984263bc
MD
275 int retval = 0;
276
277 retval += bus_print_child_header(bus, child);
278 retval += nexus_print_all_resources(child);
2899c8b1 279 if (ndev->nx_pcibus != -1)
26be20a0
SW
280 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
281 retval += kprintf(" on motherboard\n");
984263bc
MD
282
283 return (retval);
284}
285
286static device_t
2581072f
MD
287nexus_add_child(device_t bus, device_t parent, int order,
288 const char *name, int unit)
984263bc
MD
289{
290 device_t child;
291 struct nexus_device *ndev;
292
efda3bd0 293 ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
984263bc
MD
294 if (!ndev)
295 return(0);
296 resource_list_init(&ndev->nx_resources);
2899c8b1 297 ndev->nx_pcibus = -1;
984263bc 298
2581072f 299 child = device_add_child_ordered(parent, order, name, unit);
984263bc
MD
300
301 /* should we free this in nexus_child_detached? */
302 device_set_ivars(child, ndev);
303
304 return(child);
305}
306
2899c8b1
JS
307static int
308nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
309{
310 struct nexus_device *ndev = DEVTONX(child);
311
312 switch (which) {
313 case NEXUS_IVAR_PCIBUS:
314 *result = ndev->nx_pcibus;
315 break;
316 default:
317 return ENOENT;
318 }
319 return 0;
320}
321
322static int
323nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
324{
325 struct nexus_device *ndev = DEVTONX(child);
326
327 switch (which) {
328 case NEXUS_IVAR_PCIBUS:
329 ndev->nx_pcibus = value;
330 break;
331 default:
332 return ENOENT;
333 }
334 return 0;
335}
336
984263bc
MD
337/*
338 * Allocate a resource on behalf of child. NB: child is usually going to be a
339 * child of one of our descendants, not a direct child of nexus0.
340 * (Exceptions include npx.)
341 */
342static struct resource *
343nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
344 u_long start, u_long end, u_long count, u_int flags)
345{
346 struct nexus_device *ndev = DEVTONX(child);
347 struct resource *rv;
348 struct resource_list_entry *rle;
349 struct rman *rm;
350 int needactivate = flags & RF_ACTIVE;
351
352 /*
353 * If this is an allocation of the "default" range for a given RID, and
354 * we know what the resources for this device are (ie. they aren't maintained
355 * by a child bus), then work out the start/end values.
356 */
357 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
358 if (ndev == NULL)
359 return(NULL);
360 rle = resource_list_find(&ndev->nx_resources, type, *rid);
361 if (rle == NULL)
362 return(NULL);
363 start = rle->start;
364 end = rle->end;
365 count = rle->count;
366 }
367
368 flags &= ~RF_ACTIVE;
369
370 switch (type) {
371 case SYS_RES_IRQ:
372 rm = &irq_rman;
373 break;
374
375 case SYS_RES_DRQ:
376 rm = &drq_rman;
377 break;
378
379 case SYS_RES_IOPORT:
380 rm = &port_rman;
381 break;
382
383 case SYS_RES_MEMORY:
384 rm = &mem_rman;
385 break;
386
387 default:
388 return 0;
389 }
390
391 rv = rman_reserve_resource(rm, start, end, count, flags, child);
392 if (rv == 0)
393 return 0;
394
395 if (type == SYS_RES_MEMORY) {
396 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
397 } else if (type == SYS_RES_IOPORT) {
398 rman_set_bustag(rv, I386_BUS_SPACE_IO);
984263bc 399 rman_set_bushandle(rv, rv->r_start);
984263bc
MD
400 }
401
984263bc
MD
402 if (needactivate) {
403 if (bus_activate_resource(child, type, *rid, rv)) {
984263bc
MD
404 rman_release_resource(rv);
405 return 0;
406 }
407 }
408
409 return rv;
410}
411
412static int
413nexus_activate_resource(device_t bus, device_t child, int type, int rid,
414 struct resource *r)
415{
416 /*
417 * If this is a memory resource, map it into the kernel.
418 */
419 if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
420 caddr_t vaddr = 0;
421
778931ae 422 if (rman_get_end(r) < 1024 * 1024) {
984263bc
MD
423 /*
424 * The first 1Mb is mapped at KERNBASE.
425 */
778931ae 426 vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
984263bc
MD
427 } else {
428 u_int32_t paddr;
429 u_int32_t psize;
430 u_int32_t poffs;
431
778931ae
JS
432 paddr = rman_get_start(r);
433 psize = rman_get_size(r);
984263bc
MD
434
435 poffs = paddr - trunc_page(paddr);
436 vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
437 }
438 rman_set_virtual(r, vaddr);
984263bc
MD
439 /* IBM-PC: the type of bus_space_handle_t is u_int */
440 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
984263bc
MD
441 }
442 return (rman_activate_resource(r));
443}
444
445static int
446nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
447 struct resource *r)
448{
449 /*
450 * If this is a memory resource, unmap it.
451 */
778931ae
JS
452 if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
453 (rman_get_end(r) >= 1024 * 1024)) {
984263bc
MD
454 u_int32_t psize;
455
778931ae 456 psize = rman_get_size(r);
984263bc
MD
457 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
458 }
459
460 return (rman_deactivate_resource(r));
461}
462
463static int
464nexus_release_resource(device_t bus, device_t child, int type, int rid,
465 struct resource *r)
466{
778931ae 467 if (rman_get_flags(r) & RF_ACTIVE) {
984263bc
MD
468 int error = bus_deactivate_resource(child, type, rid, r);
469 if (error)
470 return error;
471 }
984263bc
MD
472 return (rman_release_resource(r));
473}
474
475/*
476 * Currently this uses the really grody interface from kern/kern_intr.c
477 * (which really doesn't belong in kern/anything.c). Eventually, all of
478 * the code in kern_intr.c and machdep_intr.c should get moved here, since
479 * this is going to be the official interface.
480 */
481static int
482nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
e9cb6d99
MD
483 int flags, void (*ihand)(void *), void *arg,
484 void **cookiep, lwkt_serialize_t serializer)
984263bc 485{
984263bc
MD
486 int error, icflags;
487
488 /* somebody tried to setup an irq that failed to allocate! */
489 if (irq == NULL)
490 panic("nexus_setup_intr: NULL irq resource!");
491
492 *cookiep = 0;
2581072f
MD
493 icflags = flags;
494 if ((irq->r_flags & RF_SHAREABLE) == 0)
495 icflags |= INTR_EXCL;
984263bc 496
984263bc
MD
497 /*
498 * We depend here on rman_activate_resource() being idempotent.
499 */
500 error = rman_activate_resource(irq);
501 if (error)
502 return (error);
503
477d3c1c
MD
504 /*
505 * XXX cast the interrupt handler function to an inthand2_t. The
506 * difference is that an additional frame argument is passed which
507 * we do not currently want to expose the BUS subsystem to.
508 */
9d522d14
MD
509 *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
510 device_get_nameunit(child), serializer,
511 icflags);
984263bc 512 if (*cookiep == NULL)
9d522d14 513 error = EINVAL;
984263bc
MD
514 return (error);
515}
516
517static int
518nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
519{
9d522d14
MD
520 if (ih) {
521 unregister_int(ih);
522 return (0);
523 }
524 return(-1);
984263bc
MD
525}
526
527static int
528nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
529{
530 struct nexus_device *ndev = DEVTONX(child);
531 struct resource_list *rl = &ndev->nx_resources;
532
533 /* XXX this should return a success/failure indicator */
534 resource_list_add(rl, type, rid, start, start + count - 1, count);
535 return(0);
536}
537
538static int
539nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
540{
541 struct nexus_device *ndev = DEVTONX(child);
542 struct resource_list *rl = &ndev->nx_resources;
543 struct resource_list_entry *rle;
544
545 rle = resource_list_find(rl, type, rid);
546 device_printf(child, "type %d rid %d startp %p countp %p - got %p\n",
547 type, rid, startp, countp, rle);
548 if (!rle)
549 return(ENOENT);
550 if (startp)
551 *startp = rle->start;
552 if (countp)
553 *countp = rle->count;
554 return(0);
555}
556
557static void
558nexus_delete_resource(device_t dev, device_t child, int type, int rid)
559{
560 struct nexus_device *ndev = DEVTONX(child);
561 struct resource_list *rl = &ndev->nx_resources;
562
563 resource_list_delete(rl, type, rid);
564}
9713df24 565