4fca4e3735ce2145adf959b125db3b22b9d43743
[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[MAXCPU], 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         int cpuid;
151
152         device_quiet(dev);      /* suppress attach message for neatness */
153
154         for (cpuid = 0; cpuid < ncpus; ++cpuid) {
155                 struct rman *rm = &irq_rman[cpuid];
156
157                 rm->rm_start = 0;
158                 rm->rm_end = IDT_HWI_VECTORS - 1;
159                 rm->rm_type = RMAN_ARRAY;
160                 rm->rm_descr = "Interrupt request lines";
161
162                 if (rman_init(rm, cpuid))
163                         panic("nexus_probe rman_init");
164                 MachIntrABI.rman_setup(rm);
165         }
166
167         /*
168          * ISA DMA on PCI systems is implemented in the ISA part of each
169          * PCI->ISA bridge and the channels can be duplicated if there are
170          * multiple bridges.  (eg: laptops with docking stations)
171          */
172         drq_rman.rm_start = 0;
173         drq_rman.rm_end = 7;
174         drq_rman.rm_type = RMAN_ARRAY;
175         drq_rman.rm_descr = "DMA request lines";
176         /* XXX drq 0 not available on some machines */
177         if (rman_init(&drq_rman, -1)
178             || rman_manage_region(&drq_rman,
179                                   drq_rman.rm_start, drq_rman.rm_end))
180                 panic("nexus_probe drq_rman");
181
182         /*
183          * However, IO ports and Memory truely are global at this level,
184          * as are APIC interrupts (however many IO APICS there turn out
185          * to be on large systems..)
186          */
187         port_rman.rm_start = 0;
188         port_rman.rm_end = 0xffff;
189         port_rman.rm_type = RMAN_ARRAY;
190         port_rman.rm_descr = "I/O ports";
191         if (rman_init(&port_rman, -1)
192             || rman_manage_region(&port_rman, 0, 0xffff))
193                 panic("nexus_probe port_rman");
194
195         mem_rman.rm_start = 0;
196         mem_rman.rm_end = ~0u;
197         mem_rman.rm_type = RMAN_ARRAY;
198         mem_rman.rm_descr = "I/O memory addresses";
199         if (rman_init(&mem_rman, -1)
200             || rman_manage_region(&mem_rman, 0, ~0))
201                 panic("nexus_probe mem_rman");
202
203         return bus_generic_probe(dev);
204 }
205
206 static int
207 nexus_attach(device_t dev)
208 {
209         device_t        child;
210
211         /*
212          * First, let our child driver's identify any child devices that
213          * they can find.  Once that is done attach any devices that we
214          * found.
215          */
216 #if 0 /* FUTURE */
217         bus_generic_probe(dev);
218 #endif
219         bus_generic_attach(dev);
220
221         /*
222          * And if we didn't see ISA on a pci bridge, create a
223          * connection point now so it shows up "on motherboard".
224          */
225         if (!devclass_get_device(devclass_find("isa"), 0)) {
226                 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
227                 if (child == NULL)
228                         panic("nexus_attach isa");
229                 device_probe_and_attach(child);
230         }
231
232         return 0;
233 }
234
235 static int
236 nexus_print_all_resources(device_t dev)
237 {
238         struct  nexus_device *ndev = DEVTONX(dev);
239         struct resource_list *rl = &ndev->nx_resources;
240         int retval = 0;
241
242         if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
243                 retval += kprintf(" at");
244         
245         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
246         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
247         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
248
249         return retval;
250 }
251
252 static int
253 nexus_print_child(device_t bus, device_t child)
254 {
255         struct  nexus_device *ndev = DEVTONX(child);
256         int retval = 0;
257
258         retval += bus_print_child_header(bus, child);
259         retval += nexus_print_all_resources(child);
260         if (ndev->nx_pcibus != -1)
261                 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
262         retval += kprintf(" on motherboard\n");
263
264         return (retval);
265 }
266
267 static device_t
268 nexus_add_child(device_t bus, device_t parent, int order,
269                 const char *name, int unit)
270 {
271         device_t                child;
272         struct nexus_device     *ndev;
273
274         ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
275         if (!ndev)
276                 return(0);
277         resource_list_init(&ndev->nx_resources);
278         ndev->nx_pcibus = -1;
279
280         child = device_add_child_ordered(parent, order, name, unit); 
281
282         /* should we free this in nexus_child_detached? */
283         device_set_ivars(child, ndev);
284
285         return(child);
286 }
287
288 static int
289 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
290 {
291         struct nexus_device *ndev = DEVTONX(child);
292         
293         switch (which) {
294         case NEXUS_IVAR_PCIBUS:
295                 *result = ndev->nx_pcibus;
296                 break;
297         default:
298                 return ENOENT;
299         }
300         return 0;
301 }
302
303 static int
304 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
305 {
306         struct nexus_device *ndev = DEVTONX(child);
307         
308         switch (which) {
309         case NEXUS_IVAR_PCIBUS:
310                 ndev->nx_pcibus = value;
311                 break;
312         default:
313                 return ENOENT;
314         }
315         return 0;
316 }
317
318 /*
319  * Allocate a resource on behalf of child.  NB: child is usually going to be a
320  * child of one of our descendants, not a direct child of nexus0.
321  * (Exceptions include npx.)
322  */
323 static struct resource *
324 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
325     u_long start, u_long end, u_long count, u_int flags, int cpuid)
326 {
327         struct nexus_device *ndev = DEVTONX(child);
328         struct  resource *rv;
329         struct resource_list_entry *rle;
330         struct  rman *rm;
331         int needactivate = flags & RF_ACTIVE;
332
333         /*
334          * If this is an allocation of the "default" range for a given RID, and
335          * we know what the resources for this device are (ie. they aren't maintained
336          * by a child bus), then work out the start/end values.
337          */
338         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
339                 if (ndev == NULL)
340                         return(NULL);
341                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
342                 if (rle == NULL)
343                         return(NULL);
344                 start = rle->start;
345                 end = rle->end;
346                 count = rle->count;
347                 cpuid = rle->cpuid;
348         }
349
350         flags &= ~RF_ACTIVE;
351
352         switch (type) {
353         case SYS_RES_IRQ:
354                 if (cpuid < 0 || cpuid >= ncpus) {
355                         kprintf("NEXUS cpuid %d:\n", cpuid);
356                         print_backtrace(-1);
357                         cpuid = 0; /* XXX */
358                 }
359                 rm = &irq_rman[cpuid];
360                 break;
361
362         case SYS_RES_DRQ:
363                 rm = &drq_rman;
364                 break;
365
366         case SYS_RES_IOPORT:
367                 rm = &port_rman;
368                 break;
369
370         case SYS_RES_MEMORY:
371                 rm = &mem_rman;
372                 break;
373
374         default:
375                 return 0;
376         }
377
378         rv = rman_reserve_resource(rm, start, end, count, flags, child);
379         if (rv == 0)
380                 return 0;
381
382         if (type == SYS_RES_MEMORY) {
383                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
384         } else if (type == SYS_RES_IOPORT) {
385                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
386                 rman_set_bushandle(rv, rv->r_start);
387         }
388
389         if (needactivate) {
390                 if (bus_activate_resource(child, type, *rid, rv)) {
391                         rman_release_resource(rv);
392                         return 0;
393                 }
394         }
395         
396         return rv;
397 }
398
399 static int
400 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
401                         struct resource *r)
402 {
403         /*
404          * If this is a memory resource, map it into the kernel.
405          */
406         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
407                 caddr_t vaddr = 0;
408
409                 if (rman_get_end(r) < 1024 * 1024) {
410                         /*
411                          * The first 1Mb is mapped at KERNBASE.
412                          */
413                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
414                 } else {
415                         u_int64_t paddr;
416                         u_int64_t psize;
417                         u_int32_t poffs;
418
419                         paddr = rman_get_start(r);
420                         psize = rman_get_size(r);
421
422                         poffs = paddr - trunc_page(paddr);
423                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
424                 }
425                 rman_set_virtual(r, vaddr);
426                 /* IBM-PC: the type of bus_space_handle_t is u_int */
427                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
428         }
429         return (rman_activate_resource(r));
430 }
431
432 static int
433 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
434                           struct resource *r)
435 {
436         /*
437          * If this is a memory resource, unmap it.
438          */
439         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
440             (rman_get_end(r) >= 1024 * 1024)) {
441                 u_int32_t psize;
442
443                 psize = rman_get_size(r);
444                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
445         }
446                 
447         return (rman_deactivate_resource(r));
448 }
449
450 static int
451 nexus_release_resource(device_t bus, device_t child, int type, int rid,
452                        struct resource *r)
453 {
454         if (rman_get_flags(r) & RF_ACTIVE) {
455                 int error = bus_deactivate_resource(child, type, rid, r);
456                 if (error)
457                         return error;
458         }
459         return (rman_release_resource(r));
460 }
461
462 static int
463 nexus_config_intr(device_t bus, device_t chile, int irq,
464     enum intr_trigger trig, enum intr_polarity pola)
465 {
466         machintr_intr_config(irq, trig, pola);
467         return 0;
468 }
469
470 /*
471  * Currently this uses the really grody interface from kern/kern_intr.c
472  * (which really doesn't belong in kern/anything.c).  Eventually, all of
473  * the code in kern_intr.c and machdep_intr.c should get moved here, since
474  * this is going to be the official interface.
475  */
476 static int
477 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
478                  int flags, void (*ihand)(void *), void *arg,
479                  void **cookiep, lwkt_serialize_t serializer)
480 {
481         int     error, icflags;
482
483         /* somebody tried to setup an irq that failed to allocate! */
484         if (irq == NULL)
485                 panic("nexus_setup_intr: NULL irq resource!");
486
487         *cookiep = 0;
488         icflags = flags;
489         if ((irq->r_flags & RF_SHAREABLE) == 0)
490                 icflags |= INTR_EXCL;
491
492         /*
493          * We depend here on rman_activate_resource() being idempotent.
494          */
495         error = rman_activate_resource(irq);
496         if (error)
497                 return (error);
498
499         /*
500          * XXX cast the interrupt handler function to an inthand2_t.  The
501          * difference is that an additional frame argument is passed which
502          * we do not currently want to expose the BUS subsystem to.
503          */
504         *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
505                                 device_get_nameunit(child), serializer,
506                                 icflags, rman_get_cpuid(irq));
507         if (*cookiep == NULL)
508                 error = EINVAL;
509         return (error);
510 }
511
512 static int
513 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
514 {
515         if (ih) {
516                 unregister_int(ih, rman_get_cpuid(r));
517                 return (0);
518         }
519         return(-1);
520 }
521
522 static int
523 nexus_set_resource(device_t dev, device_t child, int type, int rid,
524     u_long start, u_long count, int cpuid)
525 {
526         struct nexus_device     *ndev = DEVTONX(child);
527         struct resource_list    *rl = &ndev->nx_resources;
528
529         /* XXX this should return a success/failure indicator */
530         resource_list_add(rl, type, rid, start, start + count - 1, count,
531             cpuid);
532         return(0);
533 }
534
535 static int
536 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
537 {
538         struct nexus_device     *ndev = DEVTONX(child);
539         struct resource_list    *rl = &ndev->nx_resources;
540         struct resource_list_entry *rle;
541
542         rle = resource_list_find(rl, type, rid);
543         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
544                       type, rid, startp, countp, rle);
545         if (!rle)
546                 return(ENOENT);
547         if (startp)
548                 *startp = rle->start;
549         if (countp)
550                 *countp = rle->count;
551         return(0);
552 }
553
554 static void
555 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
556 {
557         struct nexus_device     *ndev = DEVTONX(child);
558         struct resource_list    *rl = &ndev->nx_resources;
559
560         resource_list_delete(rl, type, rid);
561 }
562