Merge branch 'vendor/GDTOA'
[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
53 #include <machine/vmparam.h>
54 #include <vm/vm.h>
55 #include <vm/pmap.h>
56 #include <machine/pmap.h>
57
58 #include <machine/nexusvar.h>
59 #include <machine/smp.h>
60 #include <machine_base/apic/mpapic.h>
61 #include <machine_base/isa/intr_machdep.h>
62
63 #define I386_BUS_SPACE_IO       0       /* space is i/o space */
64 #define I386_BUS_SPACE_MEM      1       /* space is mem space */
65
66 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
67 struct nexus_device {
68         struct resource_list    nx_resources;
69         int                     nx_pcibus;
70 };
71
72 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
73
74 static struct rman irq_rman, drq_rman, port_rman, mem_rman;
75
76 static  int nexus_probe(device_t);
77 static  int nexus_attach(device_t);
78 static  int nexus_print_all_resources(device_t dev);
79 static  int nexus_print_child(device_t, device_t);
80 static device_t nexus_add_child(device_t bus, device_t parent, int order,
81                                 const char *name, int unit);
82 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
83                                               u_long, u_long, u_long, u_int);
84 static  int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
85 static  int nexus_write_ivar(device_t, device_t, int, uintptr_t);
86 static  int nexus_activate_resource(device_t, device_t, int, int,
87                                     struct resource *);
88 static  int nexus_deactivate_resource(device_t, device_t, int, int,
89                                       struct resource *);
90 static  int nexus_release_resource(device_t, device_t, int, int,
91                                    struct resource *);
92 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
93                              void (*)(void *), void *, 
94                              void **, lwkt_serialize_t);
95 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
96                                 void *);
97 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
98 static  int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
99 static void nexus_delete_resource(device_t, device_t, int, int);
100
101 /*
102  * The device_identify method will cause nexus to automatically associate
103  * and attach to the root bus.
104  */
105 static device_method_t nexus_methods[] = {
106         /* Device interface */
107         DEVMETHOD(device_identify,      bus_generic_identify),
108         DEVMETHOD(device_probe,         nexus_probe),
109         DEVMETHOD(device_attach,        nexus_attach),
110         DEVMETHOD(device_detach,        bus_generic_detach),
111         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
112         DEVMETHOD(device_suspend,       bus_generic_suspend),
113         DEVMETHOD(device_resume,        bus_generic_resume),
114
115         /* Bus interface */
116         DEVMETHOD(bus_print_child,      nexus_print_child),
117         DEVMETHOD(bus_add_child,        nexus_add_child),
118         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
119         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
120         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
121         DEVMETHOD(bus_release_resource, nexus_release_resource),
122         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
123         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
124         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
125         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
126         DEVMETHOD(bus_set_resource,     nexus_set_resource),
127         DEVMETHOD(bus_get_resource,     nexus_get_resource),
128         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
129
130         { 0, 0 }
131 };
132
133 static driver_t nexus_driver = {
134         "nexus",
135         nexus_methods,
136         1,                      /* no softc */
137 };
138 static devclass_t nexus_devclass;
139
140 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
141
142 static int
143 nexus_probe(device_t dev)
144 {
145         device_quiet(dev);      /* suppress attach message for neatness */
146
147         /*
148          * IRQ's are on the mainboard on old systems, but on the ISA part
149          * of PCI->ISA bridges.  There would be multiple sets of IRQs on
150          * multi-ISA-bus systems.  PCI interrupts are routed to the ISA
151          * component, so in a way, PCI can be a partial child of an ISA bus(!).
152          * APIC interrupts are global though.
153          * In the non-APIC case, disallow the use of IRQ 2.
154          */
155         irq_rman.rm_start = 0;
156         irq_rman.rm_type = RMAN_ARRAY;
157         irq_rman.rm_descr = "Interrupt request lines";
158 #ifdef SMP /* APIC-IO */
159 if (apic_io_enable) {
160         irq_rman.rm_end = APIC_INTMAPSIZE - 1;
161         if (rman_init(&irq_rman)
162             || rman_manage_region(&irq_rman,
163                                   irq_rman.rm_start, irq_rman.rm_end))
164                 panic("nexus_probe irq_rman");
165 } else {
166 #endif
167         irq_rman.rm_end = 15;
168         if (rman_init(&irq_rman)
169             || rman_manage_region(&irq_rman, irq_rman.rm_start, 1)
170             || rman_manage_region(&irq_rman, 3, irq_rman.rm_end))
171                 panic("nexus_probe irq_rman");
172 #ifdef SMP /* APIC-IO */
173 }
174 #endif
175
176         /*
177          * ISA DMA on PCI systems is implemented in the ISA part of each
178          * PCI->ISA bridge and the channels can be duplicated if there are
179          * multiple bridges.  (eg: laptops with docking stations)
180          */
181         drq_rman.rm_start = 0;
182         drq_rman.rm_end = 7;
183         drq_rman.rm_type = RMAN_ARRAY;
184         drq_rman.rm_descr = "DMA request lines";
185         /* XXX drq 0 not available on some machines */
186         if (rman_init(&drq_rman)
187             || rman_manage_region(&drq_rman,
188                                   drq_rman.rm_start, drq_rman.rm_end))
189                 panic("nexus_probe drq_rman");
190
191         /*
192          * However, IO ports and Memory truely are global at this level,
193          * as are APIC interrupts (however many IO APICS there turn out
194          * to be on large systems..)
195          */
196         port_rman.rm_start = 0;
197         port_rman.rm_end = 0xffff;
198         port_rman.rm_type = RMAN_ARRAY;
199         port_rman.rm_descr = "I/O ports";
200         if (rman_init(&port_rman)
201             || rman_manage_region(&port_rman, 0, 0xffff))
202                 panic("nexus_probe port_rman");
203
204         mem_rman.rm_start = 0;
205         mem_rman.rm_end = ~0u;
206         mem_rman.rm_type = RMAN_ARRAY;
207         mem_rman.rm_descr = "I/O memory addresses";
208         if (rman_init(&mem_rman)
209             || rman_manage_region(&mem_rman, 0, ~0))
210                 panic("nexus_probe mem_rman");
211
212         return bus_generic_probe(dev);
213 }
214
215 static int
216 nexus_attach(device_t dev)
217 {
218         device_t        child;
219
220         /*
221          * First, let our child driver's identify any child devices that
222          * they can find.  Once that is done attach any devices that we
223          * found.
224          */
225 #if 0 /* FUTURE */
226         bus_generic_probe(dev);
227 #endif
228         bus_generic_attach(dev);
229
230         /*
231          * And if we didn't see EISA or ISA on a pci bridge, create some
232          * connection points now so they show up "on motherboard".
233          */
234         if (!devclass_get_device(devclass_find("eisa"), 0)) {
235                 child = BUS_ADD_CHILD(dev, dev, 0, "eisa", 0);
236                 if (child == NULL)
237                         panic("nexus_attach eisa");
238                 device_probe_and_attach(child);
239         }
240         if (!devclass_get_device(devclass_find("isa"), 0)) {
241                 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
242                 if (child == NULL)
243                         panic("nexus_attach isa");
244                 device_probe_and_attach(child);
245         }
246
247         return 0;
248 }
249
250 static int
251 nexus_print_all_resources(device_t dev)
252 {
253         struct  nexus_device *ndev = DEVTONX(dev);
254         struct resource_list *rl = &ndev->nx_resources;
255         int retval = 0;
256
257         if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
258                 retval += kprintf(" at");
259         
260         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
261         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
262         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
263
264         return retval;
265 }
266
267 static int
268 nexus_print_child(device_t bus, device_t child)
269 {
270         struct  nexus_device *ndev = DEVTONX(child);
271         int retval = 0;
272
273         retval += bus_print_child_header(bus, child);
274         retval += nexus_print_all_resources(child);
275         if (ndev->nx_pcibus != -1)
276                 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
277         retval += kprintf(" on motherboard\n");
278
279         return (retval);
280 }
281
282 static device_t
283 nexus_add_child(device_t bus, device_t parent, int order,
284                 const char *name, int unit)
285 {
286         device_t                child;
287         struct nexus_device     *ndev;
288
289         ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
290         if (!ndev)
291                 return(0);
292         resource_list_init(&ndev->nx_resources);
293         ndev->nx_pcibus = -1;
294
295         child = device_add_child_ordered(parent, order, name, unit); 
296
297         /* should we free this in nexus_child_detached? */
298         device_set_ivars(child, ndev);
299
300         return(child);
301 }
302
303 static int
304 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
305 {
306         struct nexus_device *ndev = DEVTONX(child);
307         
308         switch (which) {
309         case NEXUS_IVAR_PCIBUS:
310                 *result = ndev->nx_pcibus;
311                 break;
312         default:
313                 return ENOENT;
314         }
315         return 0;
316 }
317
318 static int
319 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
320 {
321         struct nexus_device *ndev = DEVTONX(child);
322         
323         switch (which) {
324         case NEXUS_IVAR_PCIBUS:
325                 ndev->nx_pcibus = value;
326                 break;
327         default:
328                 return ENOENT;
329         }
330         return 0;
331 }
332
333 /*
334  * Allocate a resource on behalf of child.  NB: child is usually going to be a
335  * child of one of our descendants, not a direct child of nexus0.
336  * (Exceptions include npx.)
337  */
338 static struct resource *
339 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
340                      u_long start, u_long end, u_long count, u_int flags)
341 {
342         struct nexus_device *ndev = DEVTONX(child);
343         struct  resource *rv;
344         struct resource_list_entry *rle;
345         struct  rman *rm;
346         int needactivate = flags & RF_ACTIVE;
347
348         /*
349          * If this is an allocation of the "default" range for a given RID, and
350          * we know what the resources for this device are (ie. they aren't maintained
351          * by a child bus), then work out the start/end values.
352          */
353         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
354                 if (ndev == NULL)
355                         return(NULL);
356                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
357                 if (rle == NULL)
358                         return(NULL);
359                 start = rle->start;
360                 end = rle->end;
361                 count = rle->count;
362         }
363
364         flags &= ~RF_ACTIVE;
365
366         switch (type) {
367         case SYS_RES_IRQ:
368                 rm = &irq_rman;
369                 break;
370
371         case SYS_RES_DRQ:
372                 rm = &drq_rman;
373                 break;
374
375         case SYS_RES_IOPORT:
376                 rm = &port_rman;
377                 break;
378
379         case SYS_RES_MEMORY:
380                 rm = &mem_rman;
381                 break;
382
383         default:
384                 return 0;
385         }
386
387         rv = rman_reserve_resource(rm, start, end, count, flags, child);
388         if (rv == 0)
389                 return 0;
390
391         if (type == SYS_RES_MEMORY) {
392                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
393         } else if (type == SYS_RES_IOPORT) {
394                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
395                 rman_set_bushandle(rv, rv->r_start);
396         }
397
398         if (needactivate) {
399                 if (bus_activate_resource(child, type, *rid, rv)) {
400                         rman_release_resource(rv);
401                         return 0;
402                 }
403         }
404         
405         return rv;
406 }
407
408 static int
409 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
410                         struct resource *r)
411 {
412         /*
413          * If this is a memory resource, map it into the kernel.
414          */
415         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
416                 caddr_t vaddr = 0;
417
418                 if (rman_get_end(r) < 1024 * 1024) {
419                         /*
420                          * The first 1Mb is mapped at KERNBASE.
421                          */
422                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
423                 } else {
424                         u_int64_t paddr;
425                         u_int64_t psize;
426                         u_int32_t poffs;
427
428                         paddr = rman_get_start(r);
429                         psize = rman_get_size(r);
430
431                         poffs = paddr - trunc_page(paddr);
432                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
433                 }
434                 rman_set_virtual(r, vaddr);
435                 /* IBM-PC: the type of bus_space_handle_t is u_int */
436                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
437         }
438         return (rman_activate_resource(r));
439 }
440
441 static int
442 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
443                           struct resource *r)
444 {
445         /*
446          * If this is a memory resource, unmap it.
447          */
448         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
449             (rman_get_end(r) >= 1024 * 1024)) {
450                 u_int32_t psize;
451
452                 psize = rman_get_size(r);
453                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
454         }
455                 
456         return (rman_deactivate_resource(r));
457 }
458
459 static int
460 nexus_release_resource(device_t bus, device_t child, int type, int rid,
461                        struct resource *r)
462 {
463         if (rman_get_flags(r) & RF_ACTIVE) {
464                 int error = bus_deactivate_resource(child, type, rid, r);
465                 if (error)
466                         return error;
467         }
468         return (rman_release_resource(r));
469 }
470
471 /*
472  * Currently this uses the really grody interface from kern/kern_intr.c
473  * (which really doesn't belong in kern/anything.c).  Eventually, all of
474  * the code in kern_intr.c and machdep_intr.c should get moved here, since
475  * this is going to be the official interface.
476  */
477 static int
478 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
479                  int flags, void (*ihand)(void *), void *arg,
480                  void **cookiep, lwkt_serialize_t serializer)
481 {
482         int     error, icflags;
483
484         /* somebody tried to setup an irq that failed to allocate! */
485         if (irq == NULL)
486                 panic("nexus_setup_intr: NULL irq resource!");
487
488         *cookiep = 0;
489         icflags = flags;
490         if ((irq->r_flags & RF_SHAREABLE) == 0)
491                 icflags |= INTR_EXCL;
492
493         /*
494          * We depend here on rman_activate_resource() being idempotent.
495          */
496         error = rman_activate_resource(irq);
497         if (error)
498                 return (error);
499
500         /*
501          * XXX cast the interrupt handler function to an inthand2_t.  The
502          * difference is that an additional frame argument is passed which
503          * we do not currently want to expose the BUS subsystem to.
504          */
505         *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
506                                 device_get_nameunit(child), serializer,
507                                 icflags);
508         if (*cookiep == NULL)
509                 error = EINVAL;
510         return (error);
511 }
512
513 static int
514 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
515 {
516         if (ih) {
517                 unregister_int(ih);
518                 return (0);
519         }
520         return(-1);
521 }
522
523 static int
524 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
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         return(0);
532 }
533
534 static int
535 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
536 {
537         struct nexus_device     *ndev = DEVTONX(child);
538         struct resource_list    *rl = &ndev->nx_resources;
539         struct resource_list_entry *rle;
540
541         rle = resource_list_find(rl, type, rid);
542         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
543                       type, rid, startp, countp, rle);
544         if (!rle)
545                 return(ENOENT);
546         if (startp)
547                 *startp = rle->start;
548         if (countp)
549                 *countp = rle->count;
550         return(0);
551 }
552
553 static void
554 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
555 {
556         struct nexus_device     *ndev = DEVTONX(child);
557         struct resource_list    *rl = &ndev->nx_resources;
558
559         resource_list_delete(rl, type, rid);
560 }
561