Add rman_get_device and rman_get_size, use macros in nexus.c
[dragonfly.git] / sys / i386 / 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/i386/i386/Attic/nexus.c,v 1.5 2004/01/13 18:45:37 joerg 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 #ifdef PC98
68 #include <pc98/pc98/pc98.h>
69 #else
70 #include <bus/isa/i386/isa.h>
71 #endif
72 #include <i386/isa/intr_machdep.h>
73
74 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
75 struct nexus_device {
76         struct resource_list    nx_resources;
77         int                     nx_pcibus;
78 };
79
80 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
81
82 static struct rman irq_rman, drq_rman, port_rman, mem_rman;
83
84 static  int nexus_probe(device_t);
85 static  int nexus_attach(device_t);
86 static  int nexus_print_all_resources(device_t dev);
87 static  int nexus_print_child(device_t, device_t);
88 static device_t nexus_add_child(device_t bus, int order, const char *name,
89                                 int unit);
90 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
91                                               u_long, u_long, u_long, u_int);
92 static  int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
93 static  int nexus_write_ivar(device_t, device_t, int, uintptr_t);
94 static  int nexus_activate_resource(device_t, device_t, int, int,
95                                     struct resource *);
96 static  int nexus_deactivate_resource(device_t, device_t, int, int,
97                                       struct resource *);
98 static  int nexus_release_resource(device_t, device_t, int, int,
99                                    struct resource *);
100 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
101                              void (*)(void *), void *, void **);
102 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
103                                 void *);
104 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
105 static  int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
106 static void nexus_delete_resource(device_t, device_t, int, int);
107
108 static device_method_t nexus_methods[] = {
109         /* Device interface */
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 int
145 nexus_probe(device_t dev)
146 {
147
148         device_quiet(dev);      /* suppress attach message for neatness */
149
150         /*
151          * IRQ's are on the mainboard on old systems, but on the ISA part
152          * of PCI->ISA bridges.  There would be multiple sets of IRQs on
153          * multi-ISA-bus systems.  PCI interrupts are routed to the ISA
154          * component, so in a way, PCI can be a partial child of an ISA bus(!).
155          * APIC interrupts are global though.
156          * In the non-APIC case, disallow the use of IRQ 2.
157          */
158         irq_rman.rm_start = 0;
159         irq_rman.rm_type = RMAN_ARRAY;
160         irq_rman.rm_descr = "Interrupt request lines";
161 #ifdef APIC_IO
162         irq_rman.rm_end = APIC_INTMAPSIZE - 1;
163         if (rman_init(&irq_rman)
164             || rman_manage_region(&irq_rman,
165                                   irq_rman.rm_start, irq_rman.rm_end))
166                 panic("nexus_probe irq_rman");
167 #else
168         irq_rman.rm_end = 15;
169 #ifdef PC98
170         if (rman_init(&irq_rman)
171             || rman_manage_region(&irq_rman,
172                                   irq_rman.rm_start, irq_rman.rm_end))
173                 panic("nexus_probe irq_rman");
174 #else
175         if (rman_init(&irq_rman)
176             || rman_manage_region(&irq_rman, irq_rman.rm_start, 1)
177             || rman_manage_region(&irq_rman, 3, irq_rman.rm_end))
178                 panic("nexus_probe irq_rman");
179 #endif /* PC98 */
180 #endif
181
182         /*
183          * ISA DMA on PCI systems is implemented in the ISA part of each
184          * PCI->ISA bridge and the channels can be duplicated if there are
185          * multiple bridges.  (eg: laptops with docking stations)
186          */
187         drq_rman.rm_start = 0;
188 #ifdef PC98
189         drq_rman.rm_end = 3;
190 #else
191         drq_rman.rm_end = 7;
192 #endif
193         drq_rman.rm_type = RMAN_ARRAY;
194         drq_rman.rm_descr = "DMA request lines";
195         /* XXX drq 0 not available on some machines */
196         if (rman_init(&drq_rman)
197             || rman_manage_region(&drq_rman,
198                                   drq_rman.rm_start, drq_rman.rm_end))
199                 panic("nexus_probe drq_rman");
200
201         /*
202          * However, IO ports and Memory truely are global at this level,
203          * as are APIC interrupts (however many IO APICS there turn out
204          * to be on large systems..)
205          */
206         port_rman.rm_start = 0;
207         port_rman.rm_end = 0xffff;
208         port_rman.rm_type = RMAN_ARRAY;
209         port_rman.rm_descr = "I/O ports";
210         if (rman_init(&port_rman)
211             || rman_manage_region(&port_rman, 0, 0xffff))
212                 panic("nexus_probe port_rman");
213
214         mem_rman.rm_start = 0;
215         mem_rman.rm_end = ~0u;
216         mem_rman.rm_type = RMAN_ARRAY;
217         mem_rman.rm_descr = "I/O memory addresses";
218         if (rman_init(&mem_rman)
219             || rman_manage_region(&mem_rman, 0, ~0))
220                 panic("nexus_probe mem_rman");
221
222         return bus_generic_probe(dev);
223 }
224
225 static int
226 nexus_attach(device_t dev)
227 {
228         device_t        child;
229
230         /*
231          * First, deal with the children we know about already
232          */
233         bus_generic_attach(dev);
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)) {
239                 child = BUS_ADD_CHILD(dev, 0, "eisa", 0);
240                 if (child == NULL)
241                         panic("nexus_attach eisa");
242                 device_probe_and_attach(child);
243         }
244 #if NMCA > 0
245         if (!devclass_get_device(devclass_find("mca"), 0)) {
246                 child = BUS_ADD_CHILD(dev, 0, "mca", 0);
247                 if (child == NULL)
248                         panic("nexus_probe mca");
249                 device_probe_and_attach(child);
250         }
251 #endif
252         if (!devclass_get_device(devclass_find("isa"), 0)) {
253                 child = BUS_ADD_CHILD(dev, 0, "isa", 0);
254                 if (child == NULL)
255                         panic("nexus_attach isa");
256                 device_probe_and_attach(child);
257         }
258
259         return 0;
260 }
261
262 static int
263 nexus_print_all_resources(device_t dev)
264 {
265         struct  nexus_device *ndev = DEVTONX(dev);
266         struct resource_list *rl = &ndev->nx_resources;
267         int retval = 0;
268
269         if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
270                 retval += printf(" at");
271         
272         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
273         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
274         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
275
276         return retval;
277 }
278
279 static int
280 nexus_print_child(device_t bus, device_t child)
281 {
282         struct  nexus_device *ndev = DEVTONX(child);
283         int retval = 0;
284
285         retval += bus_print_child_header(bus, child);
286         retval += nexus_print_all_resources(child);
287         if (ndev->nx_pcibus != -1)
288                 retval += printf(" pcibus %d", ndev->nx_pcibus);
289         retval += printf(" on motherboard\n");
290
291         return (retval);
292 }
293
294 static device_t
295 nexus_add_child(device_t bus, int order, const char *name, int unit)
296 {
297         device_t                child;
298         struct nexus_device     *ndev;
299
300         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
301         if (!ndev)
302                 return(0);
303         resource_list_init(&ndev->nx_resources);
304         ndev->nx_pcibus = -1;
305
306         child = device_add_child_ordered(bus, order, name, unit); 
307
308         /* should we free this in nexus_child_detached? */
309         device_set_ivars(child, ndev);
310
311         return(child);
312 }
313
314 static int
315 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
316 {
317         struct nexus_device *ndev = DEVTONX(child);
318         
319         switch (which) {
320         case NEXUS_IVAR_PCIBUS:
321                 *result = ndev->nx_pcibus;
322                 break;
323         default:
324                 return ENOENT;
325         }
326         return 0;
327 }
328
329 static int
330 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
331 {
332         struct nexus_device *ndev = DEVTONX(child);
333         
334         switch (which) {
335         case NEXUS_IVAR_PCIBUS:
336                 ndev->nx_pcibus = value;
337                 break;
338         default:
339                 return ENOENT;
340         }
341         return 0;
342 }
343
344 /*
345  * Allocate a resource on behalf of child.  NB: child is usually going to be a
346  * child of one of our descendants, not a direct child of nexus0.
347  * (Exceptions include npx.)
348  */
349 static struct resource *
350 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
351                      u_long start, u_long end, u_long count, u_int flags)
352 {
353         struct nexus_device *ndev = DEVTONX(child);
354         struct  resource *rv;
355         struct resource_list_entry *rle;
356         struct  rman *rm;
357         int needactivate = flags & RF_ACTIVE;
358
359         /*
360          * If this is an allocation of the "default" range for a given RID, and
361          * we know what the resources for this device are (ie. they aren't maintained
362          * by a child bus), then work out the start/end values.
363          */
364         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
365                 if (ndev == NULL)
366                         return(NULL);
367                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
368                 if (rle == NULL)
369                         return(NULL);
370                 start = rle->start;
371                 end = rle->end;
372                 count = rle->count;
373         }
374
375         flags &= ~RF_ACTIVE;
376
377         switch (type) {
378         case SYS_RES_IRQ:
379                 rm = &irq_rman;
380                 break;
381
382         case SYS_RES_DRQ:
383                 rm = &drq_rman;
384                 break;
385
386         case SYS_RES_IOPORT:
387                 rm = &port_rman;
388                 break;
389
390         case SYS_RES_MEMORY:
391                 rm = &mem_rman;
392                 break;
393
394         default:
395                 return 0;
396         }
397
398         rv = rman_reserve_resource(rm, start, end, count, flags, child);
399         if (rv == 0)
400                 return 0;
401
402         if (type == SYS_RES_MEMORY) {
403                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
404         } else if (type == SYS_RES_IOPORT) {
405                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
406 #ifndef PC98
407                 rman_set_bushandle(rv, rv->r_start);
408 #endif
409         }
410
411 #ifdef PC98
412         if ((type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) &&
413             i386_bus_space_handle_alloc(rv->r_bustag, rv->r_start, count,
414                                         &rv->r_bushandle) != 0) {
415                 rman_release_resource(rv);
416                 return 0;
417         }
418 #endif
419
420         if (needactivate) {
421                 if (bus_activate_resource(child, type, *rid, rv)) {
422 #ifdef PC98
423                         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
424                                 i386_bus_space_handle_free(rv->r_bustag,
425                                   rv->r_bushandle, rv->r_bushandle->bsh_sz);
426                         }
427 #endif
428                         rman_release_resource(rv);
429                         return 0;
430                 }
431         }
432         
433         return rv;
434 }
435
436 static int
437 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
438                         struct resource *r)
439 {
440         /*
441          * If this is a memory resource, map it into the kernel.
442          */
443         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
444                 caddr_t vaddr = 0;
445
446                 if (rman_get_end(r) < 1024 * 1024) {
447                         /*
448                          * The first 1Mb is mapped at KERNBASE.
449                          */
450                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
451                 } else {
452                         u_int32_t paddr;
453                         u_int32_t psize;
454                         u_int32_t poffs;
455
456                         paddr = rman_get_start(r);
457                         psize = rman_get_size(r);
458
459                         poffs = paddr - trunc_page(paddr);
460                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
461                 }
462                 rman_set_virtual(r, vaddr);
463 #ifdef PC98
464                 /* PC-98: the type of bus_space_handle_t is the structure. */
465                 r->r_bushandle->bsh_base = (bus_addr_t) vaddr;
466 #else
467                 /* IBM-PC: the type of bus_space_handle_t is u_int */
468                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
469 #endif
470         }
471         return (rman_activate_resource(r));
472 }
473
474 static int
475 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
476                           struct resource *r)
477 {
478         /*
479          * If this is a memory resource, unmap it.
480          */
481         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
482             (rman_get_end(r) >= 1024 * 1024)) {
483                 u_int32_t psize;
484
485                 psize = rman_get_size(r);
486                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
487         }
488                 
489         return (rman_deactivate_resource(r));
490 }
491
492 static int
493 nexus_release_resource(device_t bus, device_t child, int type, int rid,
494                        struct resource *r)
495 {
496         if (rman_get_flags(r) & RF_ACTIVE) {
497                 int error = bus_deactivate_resource(child, type, rid, r);
498                 if (error)
499                         return error;
500         }
501 #ifdef PC98
502         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
503                 i386_bus_space_handle_free(r->r_bustag, r->r_bushandle,
504                                            r->r_bushandle->bsh_sz);
505         }
506 #endif
507         return (rman_release_resource(r));
508 }
509
510 /*
511  * Currently this uses the really grody interface from kern/kern_intr.c
512  * (which really doesn't belong in kern/anything.c).  Eventually, all of
513  * the code in kern_intr.c and machdep_intr.c should get moved here, since
514  * this is going to be the official interface.
515  */
516 static int
517 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
518                  int flags, void (*ihand)(void *), void *arg, void **cookiep)
519 {
520         intrmask_t      *mask;
521         driver_t        *driver;
522         int     error, icflags;
523
524         /* somebody tried to setup an irq that failed to allocate! */
525         if (irq == NULL)
526                 panic("nexus_setup_intr: NULL irq resource!");
527
528         *cookiep = 0;
529         if (irq->r_flags & RF_SHAREABLE)
530                 icflags = 0;
531         else
532                 icflags = INTR_EXCL;
533
534         driver = device_get_driver(child);
535         switch (flags & ~INTR_TYPE_FAST) {
536         case INTR_TYPE_TTY:
537                 mask = &tty_imask;
538                 break;
539         case INTR_TYPE_BIO:
540                 mask = &bio_imask;
541                 break;
542         case INTR_TYPE_NET:
543                 mask = &net_imask;
544                 break;
545         case INTR_TYPE_CAM:
546                 mask = &cam_imask;
547                 break;
548         case INTR_TYPE_MISC:
549                 mask = 0;
550                 break;
551         default:
552                 panic("still using grody create_intr interface");
553         }
554         if (flags & INTR_TYPE_FAST)
555                 icflags |= INTR_FAST;
556
557         /*
558          * We depend here on rman_activate_resource() being idempotent.
559          */
560         error = rman_activate_resource(irq);
561         if (error)
562                 return (error);
563
564         *cookiep = inthand_add(device_get_nameunit(child), irq->r_start,
565             ihand, arg, mask, icflags);
566         if (*cookiep == NULL)
567                 error = EINVAL; /* XXX ??? */
568
569         return (error);
570 }
571
572 static int
573 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
574 {
575         return (inthand_remove(ih));
576 }
577
578 static int
579 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
580 {
581         struct nexus_device     *ndev = DEVTONX(child);
582         struct resource_list    *rl = &ndev->nx_resources;
583
584         /* XXX this should return a success/failure indicator */
585         resource_list_add(rl, type, rid, start, start + count - 1, count);
586         return(0);
587 }
588
589 static int
590 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
591 {
592         struct nexus_device     *ndev = DEVTONX(child);
593         struct resource_list    *rl = &ndev->nx_resources;
594         struct resource_list_entry *rle;
595
596         rle = resource_list_find(rl, type, rid);
597         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
598                       type, rid, startp, countp, rle);
599         if (!rle)
600                 return(ENOENT);
601         if (startp)
602                 *startp = rle->start;
603         if (countp)
604                 *countp = rle->count;
605         return(0);
606 }
607
608 static void
609 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
610 {
611         struct nexus_device     *ndev = DEVTONX(child);
612         struct resource_list    *rl = &ndev->nx_resources;
613
614         resource_list_delete(rl, type, rid);
615 }