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