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