kernel: Remove some lonely tabs.
[dragonfly.git] / sys / platform / pc32 / 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  */
31
32 /*
33  * This code implements a `root nexus' for Intel Architecture
34  * machines.  The function of the root nexus is to serve as an
35  * attachment point for both processors and buses, and to manage
36  * resources which are common to all of them.  In particular,
37  * this code implements the core resource managers for interrupt
38  * requests, DMA requests (which rightfully should be a part of the
39  * ISA code but it's easier to do it here for now), I/O port addresses,
40  * and I/O memory address space.
41  */
42
43 #include "use_pci.h"
44
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/bus.h>
48 #include <sys/kernel.h>
49 #include <sys/malloc.h>
50 #include <sys/module.h>
51 #include <sys/rman.h>
52 #include <sys/interrupt.h>
53 #include <sys/machintr.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/smp.h>
62 #include <machine/intr_machdep.h>
63 #include <machine_base/apic/ioapic.h>
64 #include <machine_base/apic/lapic.h>
65
66 #if NPCI > 0
67 #include "pcib_if.h"
68 #endif
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 #if NPCI > 0
109 static  int nexus_alloc_msi(device_t, device_t, int, int, int *, int);
110 static  int nexus_release_msi(device_t, device_t, int, int *, int);
111 static  int nexus_map_msi(device_t, device_t, int, uint64_t *, uint32_t *, int);
112 static  int nexus_alloc_msix(device_t, device_t, int *, int);
113 static  int nexus_release_msix(device_t, device_t, int, int);
114 #endif
115
116 /*
117  * The device_identify method will cause nexus to automatically associate
118  * and attach to the root bus.
119  */
120 static device_method_t nexus_methods[] = {
121         /* Device interface */
122         DEVMETHOD(device_identify,      bus_generic_identify),
123         DEVMETHOD(device_probe,         nexus_probe),
124         DEVMETHOD(device_attach,        nexus_attach),
125         DEVMETHOD(device_detach,        bus_generic_detach),
126         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
127         DEVMETHOD(device_suspend,       bus_generic_suspend),
128         DEVMETHOD(device_resume,        bus_generic_resume),
129
130         /* Bus interface */
131         DEVMETHOD(bus_print_child,      nexus_print_child),
132         DEVMETHOD(bus_add_child,        nexus_add_child),
133         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
134         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
135         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
136         DEVMETHOD(bus_release_resource, nexus_release_resource),
137         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
138         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
139         DEVMETHOD(bus_config_intr,      nexus_config_intr),
140         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
141         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
142         DEVMETHOD(bus_set_resource,     nexus_set_resource),
143         DEVMETHOD(bus_get_resource,     nexus_get_resource),
144         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
145
146 #if NPCI > 0
147         DEVMETHOD(pcib_alloc_msi,       nexus_alloc_msi),
148         DEVMETHOD(pcib_release_msi,     nexus_release_msi),
149         DEVMETHOD(pcib_map_msi,         nexus_map_msi),
150         DEVMETHOD(pcib_alloc_msix,      nexus_alloc_msix),
151         DEVMETHOD(pcib_release_msix,    nexus_release_msix),
152 #endif
153
154         DEVMETHOD_END
155 };
156
157 static driver_t nexus_driver = {
158         "nexus",
159         nexus_methods,
160         1,                      /* no softc */
161 };
162 static devclass_t nexus_devclass;
163
164 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, NULL, NULL);
165
166 static int
167 nexus_probe(device_t dev)
168 {
169         int cpuid;
170
171         device_quiet(dev);      /* suppress attach message for neatness */
172
173         for (cpuid = 0; cpuid < ncpus; ++cpuid) {
174                 struct rman *rm = &irq_rman[cpuid];
175
176                 rm->rm_start = 0;
177                 rm->rm_end = IDT_HWI_VECTORS - 1;
178                 rm->rm_type = RMAN_ARRAY;
179                 rm->rm_descr = "Interrupt request lines";
180
181                 if (rman_init(rm, cpuid))
182                         panic("nexus_probe rman_init");
183                 MachIntrABI.rman_setup(rm);
184         }
185
186         /*
187          * ISA DMA on PCI systems is implemented in the ISA part of each
188          * PCI->ISA bridge and the channels can be duplicated if there are
189          * multiple bridges.  (eg: laptops with docking stations)
190          */
191         drq_rman.rm_start = 0;
192         drq_rman.rm_end = 7;
193         drq_rman.rm_type = RMAN_ARRAY;
194         drq_rman.rm_descr = "DMA request lines";
195         /* XXX drq 0 not available on some machines */
196         if (rman_init(&drq_rman, -1)
197             || rman_manage_region(&drq_rman,
198                                   drq_rman.rm_start, drq_rman.rm_end))
199                 panic("nexus_probe drq_rman");
200
201         /*
202          * However, IO ports and Memory truely are global at this level,
203          * as are APIC interrupts (however many IO APICS there turn out
204          * to be on large systems..)
205          */
206         port_rman.rm_start = 0;
207         port_rman.rm_end = 0xffff;
208         port_rman.rm_type = RMAN_ARRAY;
209         port_rman.rm_descr = "I/O ports";
210         if (rman_init(&port_rman, -1)
211             || rman_manage_region(&port_rman, 0, 0xffff))
212                 panic("nexus_probe port_rman");
213
214         mem_rman.rm_start = 0;
215         mem_rman.rm_end = ~0u;
216         mem_rman.rm_type = RMAN_ARRAY;
217         mem_rman.rm_descr = "I/O memory addresses";
218         if (rman_init(&mem_rman, -1)
219             || rman_manage_region(&mem_rman, 0, ~0))
220                 panic("nexus_probe mem_rman");
221
222         return bus_generic_probe(dev);
223 }
224
225 static int
226 nexus_attach(device_t dev)
227 {
228         device_t        child;
229
230         /*
231          * First, let our child driver's identify any child devices that
232          * they can find.  Once that is done attach any devices that we
233          * found.
234          */
235 #if 0 /* FUTURE */
236         bus_generic_probe(dev);
237 #endif
238         bus_generic_attach(dev);
239
240         /*
241          * And if we didn't see ISA on a pci bridge, create a
242          * connection point now so it shows up "on motherboard".
243          */
244         if (!devclass_get_device(devclass_find("isa"), 0)) {
245                 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
246                 if (child == NULL)
247                         panic("nexus_attach isa");
248                 device_probe_and_attach(child);
249         }
250
251         return 0;
252 }
253
254 static int
255 nexus_print_all_resources(device_t dev)
256 {
257         struct  nexus_device *ndev = DEVTONX(dev);
258         struct resource_list *rl = &ndev->nx_resources;
259         int retval = 0;
260
261         if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
262                 retval += kprintf(" at");
263
264         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
265         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
266         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
267
268         return retval;
269 }
270
271 static int
272 nexus_print_child(device_t bus, device_t child)
273 {
274         struct  nexus_device *ndev = DEVTONX(child);
275         int retval = 0;
276
277         retval += bus_print_child_header(bus, child);
278         retval += nexus_print_all_resources(child);
279         if (ndev->nx_pcibus != -1)
280                 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
281         retval += kprintf(" on motherboard\n");
282
283         return (retval);
284 }
285
286 static device_t
287 nexus_add_child(device_t bus, device_t parent, int order,
288                 const char *name, int unit)
289 {
290         device_t                child;
291         struct nexus_device     *ndev;
292
293         ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
294         resource_list_init(&ndev->nx_resources);
295         ndev->nx_pcibus = -1;
296
297         child = device_add_child_ordered(parent, order, name, unit); 
298
299         /* should we free this in nexus_child_detached? */
300         device_set_ivars(child, ndev);
301
302         return(child);
303 }
304
305 static int
306 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
307 {
308         struct nexus_device *ndev = DEVTONX(child);
309
310         switch (which) {
311         case NEXUS_IVAR_PCIBUS:
312                 *result = ndev->nx_pcibus;
313                 break;
314         default:
315                 return ENOENT;
316         }
317         return 0;
318 }
319
320 static int
321 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
322 {
323         struct nexus_device *ndev = DEVTONX(child);
324
325         switch (which) {
326         case NEXUS_IVAR_PCIBUS:
327                 ndev->nx_pcibus = value;
328                 break;
329         default:
330                 return ENOENT;
331         }
332         return 0;
333 }
334
335 /*
336  * Allocate a resource on behalf of child.  NB: child is usually going to be a
337  * child of one of our descendants, not a direct child of nexus0.
338  * (Exceptions include npx.)
339  */
340 static struct resource *
341 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
342     u_long start, u_long end, u_long count, u_int flags, int cpuid)
343 {
344         struct nexus_device *ndev = DEVTONX(child);
345         struct  resource *rv;
346         struct resource_list_entry *rle;
347         struct  rman *rm;
348         int needactivate = flags & RF_ACTIVE;
349
350         /*
351          * If this is an allocation of the "default" range for a given RID, and
352          * we know what the resources for this device are (ie. they aren't maintained
353          * by a child bus), then work out the start/end values.
354          */
355         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
356                 if (ndev == NULL)
357                         return(NULL);
358                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
359                 if (rle == NULL)
360                         return(NULL);
361                 start = rle->start;
362                 end = rle->end;
363                 count = rle->count;
364                 cpuid = rle->cpuid;
365         }
366
367         flags &= ~RF_ACTIVE;
368
369         switch (type) {
370         case SYS_RES_IRQ:
371                 KASSERT(cpuid >= 0 && cpuid < ncpus,
372                     ("nexus invalid cpuid: %d", cpuid));
373                 rm = &irq_rman[cpuid];
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 == NULL)
394                 return 0;
395         rman_set_rid(rv, *rid);
396
397         if (type == SYS_RES_MEMORY) {
398                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
399         } else if (type == SYS_RES_IOPORT) {
400                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
401                 rman_set_bushandle(rv, rv->r_start);
402         }
403
404         if (needactivate) {
405                 if (bus_activate_resource(child, type, *rid, rv)) {
406                         rman_release_resource(rv);
407                         return 0;
408                 }
409         }
410
411         return rv;
412 }
413
414 static int
415 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
416                         struct resource *r)
417 {
418         /*
419          * If this is a memory resource, map it into the kernel.
420          */
421         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
422                 caddr_t vaddr = 0;
423
424                 if (rman_get_end(r) < 1024 * 1024) {
425                         /*
426                          * The first 1Mb is mapped at KERNBASE.
427                          */
428                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
429                 } else {
430                         u_int32_t paddr;
431                         u_int32_t psize;
432                         u_int32_t poffs;
433
434                         paddr = rman_get_start(r);
435                         psize = rman_get_size(r);
436
437                         poffs = paddr - trunc_page(paddr);
438                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
439                 }
440                 rman_set_virtual(r, vaddr);
441                 /* IBM-PC: the type of bus_space_handle_t is u_int */
442                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
443         }
444         return (rman_activate_resource(r));
445 }
446
447 static int
448 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
449                           struct resource *r)
450 {
451         /*
452          * If this is a memory resource, unmap it.
453          */
454         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
455             (rman_get_end(r) >= 1024 * 1024)) {
456                 u_int32_t psize;
457
458                 psize = rman_get_size(r);
459                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
460         }
461
462         return (rman_deactivate_resource(r));
463 }
464
465 static int
466 nexus_release_resource(device_t bus, device_t child, int type, int rid,
467                        struct resource *r)
468 {
469         if (rman_get_flags(r) & RF_ACTIVE) {
470                 int error = bus_deactivate_resource(child, type, rid, r);
471                 if (error)
472                         return error;
473         }
474         return (rman_release_resource(r));
475 }
476
477 static int
478 nexus_config_intr(device_t bus, device_t chile, int irq,
479     enum intr_trigger trig, enum intr_polarity pola)
480 {
481         machintr_legacy_intr_config(irq, trig, pola);
482         return 0;
483 }
484
485 /*
486  * Currently this uses the really grody interface from kern/kern_intr.c
487  * (which really doesn't belong in kern/anything.c).  Eventually, all of
488  * the code in kern_intr.c and machdep_intr.c should get moved here, since
489  * this is going to be the official interface.
490  */
491 static int
492 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
493     int flags, void (*ihand)(void *), void *arg, void **cookiep,
494     lwkt_serialize_t serializer, const char *desc)
495 {
496         int     error, icflags;
497
498         /* somebody tried to setup an irq that failed to allocate! */
499         if (irq == NULL)
500                 panic("nexus_setup_intr: NULL irq resource!");
501
502         *cookiep = NULL;
503         icflags = flags;
504         if ((irq->r_flags & RF_SHAREABLE) == 0)
505                 icflags |= INTR_EXCL;
506
507         /*
508          * We depend here on rman_activate_resource() being idempotent.
509          */
510         error = rman_activate_resource(irq);
511         if (error)
512                 return (error);
513
514         /* Use device name, if description is not specified */
515         if (desc == NULL)
516                 desc = device_get_nameunit(child);
517
518         /*
519          * XXX cast the interrupt handler function to an inthand2_t.  The
520          * difference is that an additional frame argument is passed which
521          * we do not currently want to expose the BUS subsystem to.
522          */
523         *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
524                                 desc, serializer, icflags, rman_get_cpuid(irq));
525         if (*cookiep == NULL)
526                 error = EINVAL;
527         return (error);
528 }
529
530 static int
531 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
532 {
533         if (ih) {
534                 unregister_int(ih, rman_get_cpuid(r));
535                 return (0);
536         }
537         return(-1);
538 }
539
540 static int
541 nexus_set_resource(device_t dev, device_t child, int type, int rid,
542     u_long start, u_long count, int cpuid)
543 {
544         struct nexus_device     *ndev = DEVTONX(child);
545         struct resource_list    *rl = &ndev->nx_resources;
546
547         /* XXX this should return a success/failure indicator */
548         resource_list_add(rl, type, rid, start, start + count - 1, count,
549             cpuid);
550         return(0);
551 }
552
553 static int
554 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
555 {
556         struct nexus_device     *ndev = DEVTONX(child);
557         struct resource_list    *rl = &ndev->nx_resources;
558         struct resource_list_entry *rle;
559
560         rle = resource_list_find(rl, type, rid);
561         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
562                       type, rid, startp, countp, rle);
563         if (!rle)
564                 return(ENOENT);
565         if (startp)
566                 *startp = rle->start;
567         if (countp)
568                 *countp = rle->count;
569         return(0);
570 }
571
572 static void
573 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
574 {
575         struct nexus_device     *ndev = DEVTONX(child);
576         struct resource_list    *rl = &ndev->nx_resources;
577
578         resource_list_delete(rl, type, rid);
579 }
580
581 #if NPCI > 0
582 static int
583 nexus_alloc_msi(device_t dev, device_t child, int count, int maxcount,
584     int *irqs, int cpuid)
585 {
586         if (!lapic_enable)
587                 return ENODEV;
588
589         return MachIntrABI.msi_alloc(irqs, count, cpuid);
590 }
591
592 static int
593 nexus_release_msi(device_t dev, device_t child, int count, int *irqs, int cpuid)
594 {
595         KKASSERT(lapic_enable);
596         MachIntrABI.msi_release(irqs, count, cpuid);
597         return 0;
598 }
599
600 static int
601 nexus_map_msi(device_t dev, device_t child, int irq, uint64_t *addr,
602     uint32_t *data, int cpuid)
603 {
604         KKASSERT(lapic_enable);
605         MachIntrABI.msi_map(irq, addr, data, cpuid);
606         return 0;
607 }
608
609 static int
610 nexus_alloc_msix(device_t dev, device_t child, int *irq, int cpuid)
611 {
612         if (!lapic_enable)
613                 return ENODEV;
614
615         return MachIntrABI.msix_alloc(irq, cpuid);
616 }
617
618 static int
619 nexus_release_msix(device_t dev, device_t child, int irq, int cpuid)
620 {
621         KKASSERT(lapic_enable);
622         MachIntrABI.msix_release(irq, cpuid);
623         return 0;
624 }
625 #endif