d2ee8215647ce58a0be195589c9205cbdad4161f
[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/lapic.h>
63 #include <machine_base/apic/ioapic.h>
64
65 #include "pcib_if.h"
66
67 #define I386_BUS_SPACE_IO       0       /* space is i/o space */
68 #define I386_BUS_SPACE_MEM      1       /* space is mem space */
69
70 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
71 struct nexus_device {
72         struct resource_list    nx_resources;
73         int                     nx_pcibus;
74 };
75
76 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
77
78 static struct rman irq_rman[MAXCPU], drq_rman, port_rman, mem_rman;
79
80 static  int nexus_probe(device_t);
81 static  int nexus_attach(device_t);
82 static  int nexus_print_all_resources(device_t dev);
83 static  int nexus_print_child(device_t, device_t);
84 static device_t nexus_add_child(device_t bus, device_t parent, int order,
85                                 const char *name, int unit);
86 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
87     u_long, u_long, u_long, u_int, int);
88 static  int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
89 static  int nexus_write_ivar(device_t, device_t, int, uintptr_t);
90 static  int nexus_activate_resource(device_t, device_t, int, int,
91                                     struct resource *);
92 static  int nexus_deactivate_resource(device_t, device_t, int, int,
93                                       struct resource *);
94 static  int nexus_release_resource(device_t, device_t, int, int,
95                                    struct resource *);
96 static  int nexus_config_intr(device_t, device_t, int, enum intr_trigger,
97                               enum intr_polarity);
98 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
99                 void (*)(void *), void *, void **, lwkt_serialize_t,
100                 const char *);
101 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
102                                 void *);
103 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long,
104                                int);
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  int nexus_alloc_msi(device_t, device_t, int, int, int *, int);
109 static  int nexus_release_msi(device_t, device_t, int, int *, int);
110 static  int nexus_map_msi(device_t, device_t, int, uint64_t *, uint32_t *, int);
111 static  int nexus_alloc_msix(device_t, device_t, int *, int);
112 static  int nexus_release_msix(device_t, device_t, int, int);
113
114 /*
115  * The device_identify method will cause nexus to automatically associate
116  * and attach to the root bus.
117  */
118 static device_method_t nexus_methods[] = {
119         /* Device interface */
120         DEVMETHOD(device_identify,      bus_generic_identify),
121         DEVMETHOD(device_probe,         nexus_probe),
122         DEVMETHOD(device_attach,        nexus_attach),
123         DEVMETHOD(device_detach,        bus_generic_detach),
124         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
125         DEVMETHOD(device_suspend,       bus_generic_suspend),
126         DEVMETHOD(device_resume,        bus_generic_resume),
127
128         /* Bus interface */
129         DEVMETHOD(bus_print_child,      nexus_print_child),
130         DEVMETHOD(bus_add_child,        nexus_add_child),
131         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
132         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
133         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
134         DEVMETHOD(bus_release_resource, nexus_release_resource),
135         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
136         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
137         DEVMETHOD(bus_config_intr,      nexus_config_intr),
138         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
139         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
140         DEVMETHOD(bus_set_resource,     nexus_set_resource),
141         DEVMETHOD(bus_get_resource,     nexus_get_resource),
142         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
143
144         DEVMETHOD(pcib_alloc_msi,       nexus_alloc_msi),
145         DEVMETHOD(pcib_release_msi,     nexus_release_msi),
146         DEVMETHOD(pcib_map_msi,         nexus_map_msi),
147         DEVMETHOD(pcib_alloc_msix,      nexus_alloc_msix),
148         DEVMETHOD(pcib_release_msix,    nexus_release_msix),
149
150         { 0, 0 }
151 };
152
153 static driver_t nexus_driver = {
154         "nexus",
155         nexus_methods,
156         1,                      /* no softc */
157 };
158 static devclass_t nexus_devclass;
159
160 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, NULL, NULL);
161
162 static int
163 nexus_probe(device_t dev)
164 {
165         int cpuid;
166
167         device_quiet(dev);      /* suppress attach message for neatness */
168
169         for (cpuid = 0; cpuid < ncpus; ++cpuid) {
170                 struct rman *rm = &irq_rman[cpuid];
171
172                 rm->rm_start = 0;
173                 rm->rm_end = IDT_HWI_VECTORS - 1;
174                 rm->rm_type = RMAN_ARRAY;
175                 rm->rm_descr = "Interrupt request lines";
176
177                 if (rman_init(rm, cpuid))
178                         panic("nexus_probe rman_init");
179                 MachIntrABI.rman_setup(rm);
180         }
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         drq_rman.rm_end = 7;
189         drq_rman.rm_type = RMAN_ARRAY;
190         drq_rman.rm_descr = "DMA request lines";
191         /* XXX drq 0 not available on some machines */
192         if (rman_init(&drq_rman, -1)
193             || rman_manage_region(&drq_rman,
194                                   drq_rman.rm_start, drq_rman.rm_end))
195                 panic("nexus_probe drq_rman");
196
197         /*
198          * However, IO ports and Memory truely are global at this level,
199          * as are APIC interrupts (however many IO APICS there turn out
200          * to be on large systems..)
201          */
202         port_rman.rm_start = 0;
203         port_rman.rm_end = 0xffff;
204         port_rman.rm_type = RMAN_ARRAY;
205         port_rman.rm_descr = "I/O ports";
206         if (rman_init(&port_rman, -1)
207             || rman_manage_region(&port_rman, 0, 0xffff))
208                 panic("nexus_probe port_rman");
209
210         mem_rman.rm_start = 0;
211         mem_rman.rm_end = ~0u;
212         mem_rman.rm_type = RMAN_ARRAY;
213         mem_rman.rm_descr = "I/O memory addresses";
214         if (rman_init(&mem_rman, -1)
215             || rman_manage_region(&mem_rman, 0, ~0))
216                 panic("nexus_probe mem_rman");
217
218         return bus_generic_probe(dev);
219 }
220
221 static int
222 nexus_attach(device_t dev)
223 {
224         device_t        child;
225
226         /*
227          * First, let our child driver's identify any child devices that
228          * they can find.  Once that is done attach any devices that we
229          * found.
230          */
231 #if 0 /* FUTURE */
232         bus_generic_probe(dev);
233 #endif
234         bus_generic_attach(dev);
235
236         /*
237          * And if we didn't see ISA on a pci bridge, create a
238          * connection point now so it shows up "on motherboard".
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         resource_list_init(&ndev->nx_resources);
291         ndev->nx_pcibus = -1;
292
293         child = device_add_child_ordered(parent, order, name, unit); 
294
295         /* should we free this in nexus_child_detached? */
296         device_set_ivars(child, ndev);
297
298         return(child);
299 }
300
301 static int
302 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
303 {
304         struct nexus_device *ndev = DEVTONX(child);
305         
306         switch (which) {
307         case NEXUS_IVAR_PCIBUS:
308                 *result = ndev->nx_pcibus;
309                 break;
310         default:
311                 return ENOENT;
312         }
313         return 0;
314 }
315
316 static int
317 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
318 {
319         struct nexus_device *ndev = DEVTONX(child);
320         
321         switch (which) {
322         case NEXUS_IVAR_PCIBUS:
323                 ndev->nx_pcibus = value;
324                 break;
325         default:
326                 return ENOENT;
327         }
328         return 0;
329 }
330
331 /*
332  * Allocate a resource on behalf of child.  NB: child is usually going to be a
333  * child of one of our descendants, not a direct child of nexus0.
334  * (Exceptions include npx.)
335  */
336 static struct resource *
337 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
338     u_long start, u_long end, u_long count, u_int flags, int cpuid)
339 {
340         struct nexus_device *ndev = DEVTONX(child);
341         struct  resource *rv;
342         struct resource_list_entry *rle;
343         struct  rman *rm;
344         int needactivate = flags & RF_ACTIVE;
345
346         /*
347          * If this is an allocation of the "default" range for a given RID, and
348          * we know what the resources for this device are (ie. they aren't maintained
349          * by a child bus), then work out the start/end values.
350          */
351         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
352                 if (ndev == NULL)
353                         return(NULL);
354                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
355                 if (rle == NULL)
356                         return(NULL);
357                 start = rle->start;
358                 end = rle->end;
359                 count = rle->count;
360                 cpuid = rle->cpuid;
361         }
362
363         flags &= ~RF_ACTIVE;
364
365         switch (type) {
366         case SYS_RES_IRQ:
367                 KASSERT(cpuid >= 0 && cpuid < ncpus,
368                     ("nexus invalid cpuid: %d", cpuid));
369                 rm = &irq_rman[cpuid];
370                 break;
371
372         case SYS_RES_DRQ:
373                 rm = &drq_rman;
374                 break;
375
376         case SYS_RES_IOPORT:
377                 rm = &port_rman;
378                 break;
379
380         case SYS_RES_MEMORY:
381                 rm = &mem_rman;
382                 break;
383
384         default:
385                 return 0;
386         }
387
388         rv = rman_reserve_resource(rm, start, end, count, flags, child);
389         if (rv == NULL)
390                 return 0;
391         rman_set_rid(rv, *rid);
392
393         if (type == SYS_RES_MEMORY) {
394                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
395         } else if (type == SYS_RES_IOPORT) {
396                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
397                 rman_set_bushandle(rv, rv->r_start);
398         }
399
400         if (needactivate) {
401                 if (bus_activate_resource(child, type, *rid, rv)) {
402                         rman_release_resource(rv);
403                         return 0;
404                 }
405         }
406         
407         return rv;
408 }
409
410 static int
411 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
412                         struct resource *r)
413 {
414         /*
415          * If this is a memory resource, map it into the kernel.
416          */
417         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
418                 caddr_t vaddr = 0;
419
420                 if (rman_get_end(r) < 1024 * 1024) {
421                         /*
422                          * The first 1Mb is mapped at KERNBASE.
423                          */
424                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
425                 } else {
426                         u_int64_t paddr;
427                         u_int64_t psize;
428                         u_int32_t poffs;
429
430                         paddr = rman_get_start(r);
431                         psize = rman_get_size(r);
432
433                         poffs = paddr - trunc_page(paddr);
434                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
435                 }
436                 rman_set_virtual(r, vaddr);
437                 /* IBM-PC: the type of bus_space_handle_t is u_int */
438                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
439         }
440         return (rman_activate_resource(r));
441 }
442
443 static int
444 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
445                           struct resource *r)
446 {
447         /*
448          * If this is a memory resource, unmap it.
449          */
450         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
451             (rman_get_end(r) >= 1024 * 1024)) {
452                 u_int32_t psize;
453
454                 psize = rman_get_size(r);
455                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
456         }
457                 
458         return (rman_deactivate_resource(r));
459 }
460
461 static int
462 nexus_release_resource(device_t bus, device_t child, int type, int rid,
463                        struct resource *r)
464 {
465         if (rman_get_flags(r) & RF_ACTIVE) {
466                 int error = bus_deactivate_resource(child, type, rid, r);
467                 if (error)
468                         return error;
469         }
470         return (rman_release_resource(r));
471 }
472
473 static int
474 nexus_config_intr(device_t bus, device_t chile, int irq,
475     enum intr_trigger trig, enum intr_polarity pola)
476 {
477         machintr_legacy_intr_config(irq, trig, pola);
478         return 0;
479 }
480
481 /*
482  * Currently this uses the really grody interface from kern/kern_intr.c
483  * (which really doesn't belong in kern/anything.c).  Eventually, all of
484  * the code in kern_intr.c and machdep_intr.c should get moved here, since
485  * this is going to be the official interface.
486  */
487 static int
488 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
489     int flags, void (*ihand)(void *), void *arg, void **cookiep,
490     lwkt_serialize_t serializer, const char *desc)
491 {
492         int     error, icflags;
493
494         /* somebody tried to setup an irq that failed to allocate! */
495         if (irq == NULL)
496                 panic("nexus_setup_intr: NULL irq resource!");
497
498         *cookiep = NULL;
499         icflags = flags;
500         if ((irq->r_flags & RF_SHAREABLE) == 0)
501                 icflags |= INTR_EXCL;
502
503         /*
504          * We depend here on rman_activate_resource() being idempotent.
505          */
506         error = rman_activate_resource(irq);
507         if (error)
508                 return (error);
509
510         /* Use device name, if description is not specified */
511         if (desc == NULL)
512                 desc = device_get_nameunit(child);
513
514         /*
515          * XXX cast the interrupt handler function to an inthand2_t.  The
516          * difference is that an additional frame argument is passed which
517          * we do not currently want to expose the BUS subsystem to.
518          */
519         *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
520                                 desc, serializer, icflags, rman_get_cpuid(irq));
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, rman_get_cpuid(r));
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
577 static int
578 nexus_alloc_msi(device_t dev, device_t child, int count, int maxcount,
579     int *irqs, int cpuid)
580 {
581         if (!lapic_enable)
582                 return ENODEV;
583
584         return MachIntrABI.msi_alloc(irqs, count, cpuid);
585 }
586
587 static int
588 nexus_release_msi(device_t dev, device_t child, int count, int *irqs, int cpuid)
589 {
590         KKASSERT(lapic_enable);
591         MachIntrABI.msi_release(irqs, count, cpuid);
592         return 0;
593 }
594
595 static int
596 nexus_map_msi(device_t dev, device_t child, int irq, uint64_t *addr,
597     uint32_t *data, int cpuid)
598 {
599         KKASSERT(lapic_enable);
600         MachIntrABI.msi_map(irq, addr, data, cpuid);
601         return 0;
602 }
603
604 static int
605 nexus_alloc_msix(device_t dev, device_t child, int *irq, int cpuid)
606 {
607         if (!lapic_enable)
608                 return ENODEV;
609
610         return MachIntrABI.msix_alloc(irq, cpuid);
611 }
612
613 static int
614 nexus_release_msix(device_t dev, device_t child, int irq, int cpuid)
615 {
616         KKASSERT(lapic_enable);
617         MachIntrABI.msix_release(irq, cpuid);
618         return 0;
619 }