Get rid of bus_{disable,enable}_intr(), it wasn't generic enough for
[dragonfly.git] / sys / platform / pc32 / i386 / nexus.c
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  * $DragonFly: src/sys/platform/pc32/i386/nexus.c,v 1.14 2005/05/24 20:59:05 dillon Exp $
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
44 #include "use_mca.h"
45
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/bus.h>
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #include <sys/module.h>
52 #include <machine/bus.h>
53 #include <sys/rman.h>
54
55 #include <machine/vmparam.h>
56 #include <vm/vm.h>
57 #include <vm/pmap.h>
58 #include <machine/pmap.h>
59
60 #include <machine/nexusvar.h>
61 #include <machine/resource.h>
62 #ifdef APIC_IO
63 #include <machine/smp.h>
64 #include <machine/mpapic.h>
65 #endif
66
67 #include <bus/isa/isavar.h>
68 #include <bus/isa/i386/isa.h>
69 #include <i386/isa/intr_machdep.h>
70
71 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
72 struct nexus_device {
73         struct resource_list    nx_resources;
74         int                     nx_pcibus;
75 };
76
77 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
78
79 static struct rman irq_rman, drq_rman, port_rman, mem_rman;
80
81 static void nexus_identify(driver_t *, device_t);
82 static  int nexus_probe(device_t);
83 static  int nexus_attach(device_t);
84 static  int nexus_print_all_resources(device_t dev);
85 static  int nexus_print_child(device_t, device_t);
86 static device_t nexus_add_child(device_t bus, int order, const char *name,
87                                 int unit);
88 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
89                                               u_long, u_long, u_long, u_int);
90 static  int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
91 static  int nexus_write_ivar(device_t, device_t, int, uintptr_t);
92 static  int nexus_activate_resource(device_t, device_t, int, int,
93                                     struct resource *);
94 static  int nexus_deactivate_resource(device_t, device_t, int, int,
95                                       struct resource *);
96 static  int nexus_release_resource(device_t, device_t, int, int,
97                                    struct resource *);
98 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
99                              void (*)(void *), void *, 
100                              void **, lwkt_serialize_t);
101 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
102                                 void *);
103 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
104 static  int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
105 static void nexus_delete_resource(device_t, device_t, int, int);
106
107 static device_method_t nexus_methods[] = {
108         /* Device interface */
109         DEVMETHOD(device_identify,      nexus_identify),
110         DEVMETHOD(device_probe,         nexus_probe),
111         DEVMETHOD(device_attach,        nexus_attach),
112         DEVMETHOD(device_detach,        bus_generic_detach),
113         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
114         DEVMETHOD(device_suspend,       bus_generic_suspend),
115         DEVMETHOD(device_resume,        bus_generic_resume),
116
117         /* Bus interface */
118         DEVMETHOD(bus_print_child,      nexus_print_child),
119         DEVMETHOD(bus_add_child,        nexus_add_child),
120         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
121         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
122         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
123         DEVMETHOD(bus_release_resource, nexus_release_resource),
124         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
125         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
126         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
127         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
128         DEVMETHOD(bus_set_resource,     nexus_set_resource),
129         DEVMETHOD(bus_get_resource,     nexus_get_resource),
130         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
131
132         { 0, 0 }
133 };
134
135 static driver_t nexus_driver = {
136         "nexus",
137         nexus_methods,
138         1,                      /* no softc */
139 };
140 static devclass_t nexus_devclass;
141
142 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
143
144 static void
145 nexus_identify(driver_t *driver, device_t parent)
146 {
147         /*
148          * Add child device with order of 1 so it gets probed
149          * after ACPI (which is at order 0.
150          */
151         if (BUS_ADD_CHILD(parent, 1, "legacy", 0) == NULL)
152                 panic("legacy: could not attach");
153 }
154
155 static int
156 nexus_probe(device_t dev)
157 {
158 #if 0   /* FUTURE */
159         device_t acpi;
160 #endif
161
162 #if 0   /* FUTURE */
163         /*
164          * Fail to probe if ACPI is ok.
165          */
166         acpi = devclass_get_device(devclass_find("acpi"), 0);
167         if (acpi != NULL && device_is_alive(acpi))
168                 return(ENXIO);
169 #endif
170
171         device_quiet(dev);      /* suppress attach message for neatness */
172
173         /*
174          * IRQ's are on the mainboard on old systems, but on the ISA part
175          * of PCI->ISA bridges.  There would be multiple sets of IRQs on
176          * multi-ISA-bus systems.  PCI interrupts are routed to the ISA
177          * component, so in a way, PCI can be a partial child of an ISA bus(!).
178          * APIC interrupts are global though.
179          * In the non-APIC case, disallow the use of IRQ 2.
180          */
181         irq_rman.rm_start = 0;
182         irq_rman.rm_type = RMAN_ARRAY;
183         irq_rman.rm_descr = "Interrupt request lines";
184 #ifdef APIC_IO
185         irq_rman.rm_end = APIC_INTMAPSIZE - 1;
186         if (rman_init(&irq_rman)
187             || rman_manage_region(&irq_rman,
188                                   irq_rman.rm_start, irq_rman.rm_end))
189                 panic("nexus_probe irq_rman");
190 #else
191         irq_rman.rm_end = 15;
192         if (rman_init(&irq_rman)
193             || rman_manage_region(&irq_rman, irq_rman.rm_start, 1)
194             || rman_manage_region(&irq_rman, 3, irq_rman.rm_end))
195                 panic("nexus_probe irq_rman");
196 #endif
197
198         /*
199          * ISA DMA on PCI systems is implemented in the ISA part of each
200          * PCI->ISA bridge and the channels can be duplicated if there are
201          * multiple bridges.  (eg: laptops with docking stations)
202          */
203         drq_rman.rm_start = 0;
204         drq_rman.rm_end = 7;
205         drq_rman.rm_type = RMAN_ARRAY;
206         drq_rman.rm_descr = "DMA request lines";
207         /* XXX drq 0 not available on some machines */
208         if (rman_init(&drq_rman)
209             || rman_manage_region(&drq_rman,
210                                   drq_rman.rm_start, drq_rman.rm_end))
211                 panic("nexus_probe drq_rman");
212
213         /*
214          * However, IO ports and Memory truely are global at this level,
215          * as are APIC interrupts (however many IO APICS there turn out
216          * to be on large systems..)
217          */
218         port_rman.rm_start = 0;
219         port_rman.rm_end = 0xffff;
220         port_rman.rm_type = RMAN_ARRAY;
221         port_rman.rm_descr = "I/O ports";
222         if (rman_init(&port_rman)
223             || rman_manage_region(&port_rman, 0, 0xffff))
224                 panic("nexus_probe port_rman");
225
226         mem_rman.rm_start = 0;
227         mem_rman.rm_end = ~0u;
228         mem_rman.rm_type = RMAN_ARRAY;
229         mem_rman.rm_descr = "I/O memory addresses";
230         if (rman_init(&mem_rman)
231             || rman_manage_region(&mem_rman, 0, ~0))
232                 panic("nexus_probe mem_rman");
233
234         return bus_generic_probe(dev);
235 }
236
237 static int
238 nexus_attach(device_t dev)
239 {
240         device_t        child;
241
242         /*
243          * First, let our child driver's identify any child devices that
244          * they can find.  Once that is done attach any devices that we
245          * found.
246          */
247 #if 0 /* FUTURE */
248         bus_generic_probe(dev);
249 #endif
250         bus_generic_attach(dev);
251
252         /*
253          * And if we didn't see EISA or ISA on a pci bridge, create some
254          * connection points now so they show up "on motherboard".
255          */
256         if (!devclass_get_device(devclass_find("eisa"), 0)) {
257                 child = BUS_ADD_CHILD(dev, 0, "eisa", 0);
258                 if (child == NULL)
259                         panic("nexus_attach eisa");
260                 device_probe_and_attach(child);
261         }
262 #if NMCA > 0
263         if (!devclass_get_device(devclass_find("mca"), 0)) {
264                 child = BUS_ADD_CHILD(dev, 0, "mca", 0);
265                 if (child == NULL)
266                         panic("nexus_probe mca");
267                 device_probe_and_attach(child);
268         }
269 #endif
270         if (!devclass_get_device(devclass_find("isa"), 0)) {
271                 child = BUS_ADD_CHILD(dev, 0, "isa", 0);
272                 if (child == NULL)
273                         panic("nexus_attach isa");
274                 device_probe_and_attach(child);
275         }
276
277         return 0;
278 }
279
280 static int
281 nexus_print_all_resources(device_t dev)
282 {
283         struct  nexus_device *ndev = DEVTONX(dev);
284         struct resource_list *rl = &ndev->nx_resources;
285         int retval = 0;
286
287         if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
288                 retval += printf(" at");
289         
290         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
291         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
292         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
293
294         return retval;
295 }
296
297 static int
298 nexus_print_child(device_t bus, device_t child)
299 {
300         struct  nexus_device *ndev = DEVTONX(child);
301         int retval = 0;
302
303         retval += bus_print_child_header(bus, child);
304         retval += nexus_print_all_resources(child);
305         if (ndev->nx_pcibus != -1)
306                 retval += printf(" pcibus %d", ndev->nx_pcibus);
307         retval += printf(" on motherboard\n");
308
309         return (retval);
310 }
311
312 static device_t
313 nexus_add_child(device_t bus, int order, const char *name, int unit)
314 {
315         device_t                child;
316         struct nexus_device     *ndev;
317
318         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
319         if (!ndev)
320                 return(0);
321         resource_list_init(&ndev->nx_resources);
322         ndev->nx_pcibus = -1;
323
324         child = device_add_child_ordered(bus, order, name, unit); 
325
326         /* should we free this in nexus_child_detached? */
327         device_set_ivars(child, ndev);
328
329         return(child);
330 }
331
332 static int
333 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
334 {
335         struct nexus_device *ndev = DEVTONX(child);
336         
337         switch (which) {
338         case NEXUS_IVAR_PCIBUS:
339                 *result = ndev->nx_pcibus;
340                 break;
341         default:
342                 return ENOENT;
343         }
344         return 0;
345 }
346
347 static int
348 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
349 {
350         struct nexus_device *ndev = DEVTONX(child);
351         
352         switch (which) {
353         case NEXUS_IVAR_PCIBUS:
354                 ndev->nx_pcibus = value;
355                 break;
356         default:
357                 return ENOENT;
358         }
359         return 0;
360 }
361
362 /*
363  * Allocate a resource on behalf of child.  NB: child is usually going to be a
364  * child of one of our descendants, not a direct child of nexus0.
365  * (Exceptions include npx.)
366  */
367 static struct resource *
368 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
369                      u_long start, u_long end, u_long count, u_int flags)
370 {
371         struct nexus_device *ndev = DEVTONX(child);
372         struct  resource *rv;
373         struct resource_list_entry *rle;
374         struct  rman *rm;
375         int needactivate = flags & RF_ACTIVE;
376
377         /*
378          * If this is an allocation of the "default" range for a given RID, and
379          * we know what the resources for this device are (ie. they aren't maintained
380          * by a child bus), then work out the start/end values.
381          */
382         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
383                 if (ndev == NULL)
384                         return(NULL);
385                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
386                 if (rle == NULL)
387                         return(NULL);
388                 start = rle->start;
389                 end = rle->end;
390                 count = rle->count;
391         }
392
393         flags &= ~RF_ACTIVE;
394
395         switch (type) {
396         case SYS_RES_IRQ:
397                 rm = &irq_rman;
398                 break;
399
400         case SYS_RES_DRQ:
401                 rm = &drq_rman;
402                 break;
403
404         case SYS_RES_IOPORT:
405                 rm = &port_rman;
406                 break;
407
408         case SYS_RES_MEMORY:
409                 rm = &mem_rman;
410                 break;
411
412         default:
413                 return 0;
414         }
415
416         rv = rman_reserve_resource(rm, start, end, count, flags, child);
417         if (rv == 0)
418                 return 0;
419
420         if (type == SYS_RES_MEMORY) {
421                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
422         } else if (type == SYS_RES_IOPORT) {
423                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
424                 rman_set_bushandle(rv, rv->r_start);
425         }
426
427         if (needactivate) {
428                 if (bus_activate_resource(child, type, *rid, rv)) {
429                         rman_release_resource(rv);
430                         return 0;
431                 }
432         }
433         
434         return rv;
435 }
436
437 static int
438 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
439                         struct resource *r)
440 {
441         /*
442          * If this is a memory resource, map it into the kernel.
443          */
444         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
445                 caddr_t vaddr = 0;
446
447                 if (rman_get_end(r) < 1024 * 1024) {
448                         /*
449                          * The first 1Mb is mapped at KERNBASE.
450                          */
451                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
452                 } else {
453                         u_int32_t paddr;
454                         u_int32_t psize;
455                         u_int32_t poffs;
456
457                         paddr = rman_get_start(r);
458                         psize = rman_get_size(r);
459
460                         poffs = paddr - trunc_page(paddr);
461                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
462                 }
463                 rman_set_virtual(r, vaddr);
464                 /* IBM-PC: the type of bus_space_handle_t is u_int */
465                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
466         }
467         return (rman_activate_resource(r));
468 }
469
470 static int
471 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
472                           struct resource *r)
473 {
474         /*
475          * If this is a memory resource, unmap it.
476          */
477         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
478             (rman_get_end(r) >= 1024 * 1024)) {
479                 u_int32_t psize;
480
481                 psize = rman_get_size(r);
482                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
483         }
484                 
485         return (rman_deactivate_resource(r));
486 }
487
488 static int
489 nexus_release_resource(device_t bus, device_t child, int type, int rid,
490                        struct resource *r)
491 {
492         if (rman_get_flags(r) & RF_ACTIVE) {
493                 int error = bus_deactivate_resource(child, type, rid, r);
494                 if (error)
495                         return error;
496         }
497         return (rman_release_resource(r));
498 }
499
500 /*
501  * Currently this uses the really grody interface from kern/kern_intr.c
502  * (which really doesn't belong in kern/anything.c).  Eventually, all of
503  * the code in kern_intr.c and machdep_intr.c should get moved here, since
504  * this is going to be the official interface.
505  */
506 static int
507 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
508                  int flags, void (*ihand)(void *), void *arg,
509                  void **cookiep, lwkt_serialize_t serializer)
510 {
511         intrmask_t      *mask;
512         driver_t        *driver;
513         int     error, icflags;
514
515         /* somebody tried to setup an irq that failed to allocate! */
516         if (irq == NULL)
517                 panic("nexus_setup_intr: NULL irq resource!");
518
519         *cookiep = 0;
520         if (irq->r_flags & RF_SHAREABLE)
521                 icflags = 0;
522         else
523                 icflags = INTR_EXCL;
524
525         driver = device_get_driver(child);
526         switch (flags & INTR_TYPE_MASK) {
527         case INTR_TYPE_AV:
528         case INTR_TYPE_TTY:
529                 mask = &tty_imask;
530                 break;
531         case INTR_TYPE_BIO:
532                 mask = &bio_imask;
533                 break;
534         case INTR_TYPE_NET:
535                 mask = &net_imask;
536                 break;
537         case INTR_TYPE_CAM:
538                 mask = &cam_imask;
539                 break;
540         case INTR_TYPE_CLK:
541                 mask = 0;
542                 printf("nexus: Warning: do not know what imask to use for INTR_TYPE_CLK\n");
543                 break;
544         case INTR_TYPE_MISC:
545                 mask = 0;
546                 break;
547         default:
548                 panic("still using grody create_intr interface");
549         }
550         if (flags & INTR_FAST)
551                 icflags |= INTR_FAST;
552
553         /*
554          * We depend here on rman_activate_resource() being idempotent.
555          */
556         error = rman_activate_resource(irq);
557         if (error)
558                 return (error);
559
560         *cookiep = inthand_add(device_get_nameunit(child), irq->r_start,
561             ihand, arg, mask, icflags, serializer);
562         if (*cookiep == NULL)
563                 error = EINVAL; /* XXX ??? */
564
565         return (error);
566 }
567
568 static int
569 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
570 {
571         return (inthand_remove(ih));
572 }
573
574 static int
575 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
576 {
577         struct nexus_device     *ndev = DEVTONX(child);
578         struct resource_list    *rl = &ndev->nx_resources;
579
580         /* XXX this should return a success/failure indicator */
581         resource_list_add(rl, type, rid, start, start + count - 1, count);
582         return(0);
583 }
584
585 static int
586 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
587 {
588         struct nexus_device     *ndev = DEVTONX(child);
589         struct resource_list    *rl = &ndev->nx_resources;
590         struct resource_list_entry *rle;
591
592         rle = resource_list_find(rl, type, rid);
593         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
594                       type, rid, startp, countp, rle);
595         if (!rle)
596                 return(ENOENT);
597         if (startp)
598                 *startp = rle->start;
599         if (countp)
600                 *countp = rle->count;
601         return(0);
602 }
603
604 static void
605 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
606 {
607         struct nexus_device     *ndev = DEVTONX(child);
608         struct resource_list    *rl = &ndev->nx_resources;
609
610         resource_list_delete(rl, type, rid);
611 }
612
613 /*
614  * Placeholder which claims PnP 'devices' which describe system
615  * resources.
616  */
617 static struct isa_pnp_id sysresource_ids[] = {
618         { 0x010cd041 /* PNP0c01 */, "System Memory" },
619         { 0x020cd041 /* PNP0c02 */, "System Resource" },
620         { 0 }
621 };
622
623 static int
624 sysresource_probe(device_t dev)
625 {
626         int     result;
627
628         if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) >= 0) {
629                 device_quiet(dev);
630         }
631         return (result);
632 }
633
634 static int
635 sysresource_attach(device_t dev)
636 {
637         return (0);
638 }
639
640 static device_method_t sysresource_methods[] = {
641         /* Device interface */
642         DEVMETHOD(device_probe,         sysresource_probe),
643         DEVMETHOD(device_attach,        sysresource_attach),
644         DEVMETHOD(device_detach,        bus_generic_detach),
645         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
646         DEVMETHOD(device_suspend,       bus_generic_suspend),
647         DEVMETHOD(device_resume,        bus_generic_resume),
648         { 0, 0 }
649 };
650
651 static driver_t sysresource_driver = {
652         "sysresource",
653         sysresource_methods,
654         1,              /* no softc */
655 };
656
657 static devclass_t sysresource_devclass;
658
659 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);