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