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