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