xref: /netbsd-src/sys/arch/sparc64/dev/ebus.c (revision b757af438b42b93f8c6571f026d8b8ef3eaf5fc9)
1 /*	$NetBSD: ebus.c,v 1.60 2012/01/30 04:25:15 mrg Exp $	*/
2 
3 /*
4  * Copyright (c) 1999, 2000, 2001 Matthew R. Green
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __KERNEL_RCSID(0, "$NetBSD: ebus.c,v 1.60 2012/01/30 04:25:15 mrg Exp $");
31 
32 #include "opt_ddb.h"
33 
34 /*
35  * UltraSPARC 5 and beyond ebus support.
36  *
37  * note that this driver is not complete:
38  *	- interrupt establish is written and appears to work
39  *	- bus map code is written and appears to work
40  *	- ebus2 DMA code is completely unwritten, we just punt to
41  *	  the iommu.
42  */
43 
44 #ifdef DEBUG
45 #define	EDB_PROM	0x01
46 #define EDB_CHILD	0x02
47 #define	EDB_INTRMAP	0x04
48 #define EDB_BUSMAP	0x08
49 #define EDB_BUSDMA	0x10
50 #define EDB_INTR	0x20
51 int ebus_debug = 0x0;
52 #define DPRINTF(l, s)   do { if (ebus_debug & l) printf s; } while (0)
53 #else
54 #define DPRINTF(l, s)
55 #endif
56 
57 #include <sys/param.h>
58 #include <sys/conf.h>
59 #include <sys/device.h>
60 #include <sys/errno.h>
61 #include <sys/extent.h>
62 #include <sys/malloc.h>
63 #include <sys/systm.h>
64 #include <sys/time.h>
65 
66 #define _SPARC_BUS_DMA_PRIVATE
67 #include <sys/bus.h>
68 #include <machine/autoconf.h>
69 #include <machine/openfirm.h>
70 
71 #include <dev/pci/pcivar.h>
72 #include <dev/pci/pcireg.h>
73 #include <dev/pci/pcidevs.h>
74 
75 #include <dev/ebus/ebusreg.h>
76 #include <dev/ebus/ebusvar.h>
77 #include <sparc64/dev/ebusvar.h>
78 
79 int	ebus_match(device_t, cfdata_t, void *);
80 void	ebus_attach(device_t, device_t, void *);
81 
82 CFATTACH_DECL_NEW(ebus, sizeof(struct ebus_softc),
83     ebus_match, ebus_attach, NULL, NULL);
84 
85 /*
86  * here are our bus space and bus DMA routines.
87  */
88 static int _ebus_bus_map(bus_space_tag_t, bus_addr_t, bus_size_t, int, vaddr_t,
89 	bus_space_handle_t *);
90 static void *ebus_intr_establish(bus_space_tag_t, int, int, int (*)(void *),
91 	void *, void(*)(void));
92 
93 int
94 ebus_match(device_t parent, cfdata_t match, void *aux)
95 {
96 	struct pci_attach_args *pa = aux;
97 	char *name;
98 	int node;
99 
100 	/* Only attach if there's a PROM node. */
101 	node = PCITAG_NODE(pa->pa_tag);
102 	if (node == -1)
103 		return (0);
104 
105 	if (PCI_CLASS(pa->pa_class) != PCI_CLASS_BRIDGE)
106 		return (0);
107 
108 	/* Match a real ebus */
109 	name = prom_getpropstring(node, "name");
110 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN &&
111 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_EBUS &&
112 		strcmp(name, "ebus") == 0)
113 		return (1);
114 
115 	/* Or a real ebus III */
116 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN &&
117 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_EBUSIII &&
118 		strcmp(name, "ebus") == 0)
119 		return (1);
120 
121 	/* Or a PCI-ISA bridge XXX I hope this is on-board. */
122 	if (PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_BRIDGE_ISA) {
123 		return (1);
124 	}
125 
126 	return (0);
127 }
128 
129 /*
130  * attach an ebus and all it's children.  this code is modeled
131  * after the sbus code which does similar things.
132  */
133 void
134 ebus_attach(device_t parent, device_t self, void *aux)
135 {
136 	struct ebus_softc *sc = device_private(self);
137 	struct pci_attach_args *pa = aux;
138 	struct ebus_attach_args eba;
139 	struct ebus_interrupt_map_mask *immp;
140 	int node, nmapmask, error;
141 	char devinfo[256];
142 
143 	sc->sc_dev = self;
144 
145 	aprint_normal("\n");
146 	aprint_naive("\n");
147 
148 	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
149 	aprint_normal_dev(self, "%s, revision 0x%02x\n", devinfo,
150 	    PCI_REVISION(pa->pa_class));
151 
152 	sc->sc_memtag = pa->pa_memt;
153 	sc->sc_iotag = pa->pa_iot;
154 	sc->sc_childbustag = ebus_alloc_bus_tag(sc, PCI_MEMORY_BUS_SPACE);
155 	sc->sc_dmatag = pa->pa_dmat;
156 
157 	node = PCITAG_NODE(pa->pa_tag);
158 	if (node == -1)
159 		panic("could not find ebus node");
160 
161 	sc->sc_node = node;
162 
163 	/*
164 	 * fill in our softc with information from the prom
165 	 */
166 	sc->sc_intmap = NULL;
167 	sc->sc_range = NULL;
168 	sc->sc_nintmap = 0;
169 	error = prom_getprop(node, "interrupt-map",
170 			sizeof(struct ebus_interrupt_map),
171 			&sc->sc_nintmap, &sc->sc_intmap);
172 	switch (error) {
173 	case 0:
174 		immp = &sc->sc_intmapmask;
175 		nmapmask = sizeof(*immp);
176 		error = prom_getprop(node, "interrupt-map-mask",
177 			    sizeof(struct ebus_interrupt_map_mask), &nmapmask,
178 			    &immp);
179 		if (error)
180 			panic("could not get ebus interrupt-map-mask, error %d",
181 			    error);
182 		if (nmapmask != 1)
183 			panic("ebus interrupt-map-mask is broken");
184 		break;
185 	case ENOENT:
186 		break;
187 	default:
188 		panic("ebus interrupt-map: error %d", error);
189 		break;
190 	}
191 
192 	error = prom_getprop(node, "ranges", sizeof(struct ebus_ranges),
193 	    &sc->sc_nrange, &sc->sc_range);
194 	if (error)
195 		panic("ebus ranges: error %d", error);
196 
197 	/*
198 	 * now attach all our children
199 	 */
200 	DPRINTF(EDB_CHILD, ("ebus node %08x, searching children...\n", node));
201 	for (node = firstchild(node); node; node = nextsibling(node)) {
202 		char *name = prom_getpropstring(node, "name");
203 
204 		if (ebus_setup_attach_args(sc, node, &eba) != 0) {
205 			aprint_error("ebus_attach: %s: incomplete\n", name);
206 			continue;
207 		} else {
208 			DPRINTF(EDB_CHILD, ("- found child `%s', attaching\n",
209 			    eba.ea_name));
210 			(void)config_found(self, &eba, ebus_print);
211 		}
212 		ebus_destroy_attach_args(&eba);
213 	}
214 }
215 
216 int	ebus_setup_attach_args(struct ebus_softc *, int,
217 	    struct ebus_attach_args *);
218 int
219 ebus_setup_attach_args(struct ebus_softc *sc, int node,
220 	struct ebus_attach_args	*ea)
221 {
222 	int	n, rv;
223 
224 	memset(ea, 0, sizeof(struct ebus_attach_args));
225 	n = 0;
226 	rv = prom_getprop(node, "name", 1, &n, &ea->ea_name);
227 	if (rv != 0)
228 		return (rv);
229 	KASSERT(ea->ea_name[n-1] == '\0');
230 
231 	ea->ea_node = node;
232 	ea->ea_bustag = sc->sc_childbustag;
233 	ea->ea_dmatag = sc->sc_dmatag;
234 
235 	rv = prom_getprop(node, "reg", sizeof(struct ebus_regs), &ea->ea_nreg,
236 	    &ea->ea_reg);
237 	if (rv)
238 		return (rv);
239 
240 	rv = prom_getprop(node, "address", sizeof(uint32_t), &ea->ea_nvaddr,
241 	    &ea->ea_vaddr);
242 	if (rv != ENOENT) {
243 		if (rv)
244 			return (rv);
245 
246 		if (ea->ea_nreg != ea->ea_nvaddr)
247 			printf("ebus loses: device %s: %d regs and %d addrs\n",
248 			    ea->ea_name, ea->ea_nreg, ea->ea_nvaddr);
249 	} else
250 		ea->ea_nvaddr = 0;
251 
252 	if (prom_getprop(node, "interrupts", sizeof(uint32_t), &ea->ea_nintr,
253 	    &ea->ea_intr))
254 		ea->ea_nintr = 0;
255 	else
256 		ebus_find_ino(sc, ea);
257 
258 	return (0);
259 }
260 
261 void
262 ebus_destroy_attach_args(struct ebus_attach_args *ea)
263 {
264 
265 	if (ea->ea_name)
266 		free((void *)ea->ea_name, M_DEVBUF);
267 	if (ea->ea_reg)
268 		free((void *)ea->ea_reg, M_DEVBUF);
269 	if (ea->ea_intr)
270 		free((void *)ea->ea_intr, M_DEVBUF);
271 	if (ea->ea_vaddr)
272 		free((void *)ea->ea_vaddr, M_DEVBUF);
273 }
274 
275 int
276 ebus_print(void *aux, const char *p)
277 {
278 	struct ebus_attach_args *ea = aux;
279 	int i;
280 
281 	if (p)
282 		aprint_normal("%s at %s", ea->ea_name, p);
283 	for (i = 0; i < ea->ea_nreg; i++)
284 		aprint_normal("%s %x-%x", i == 0 ? " addr" : ",",
285 		    ea->ea_reg[i].lo,
286 		    ea->ea_reg[i].lo + ea->ea_reg[i].size - 1);
287 	for (i = 0; i < ea->ea_nintr; i++)
288 		aprint_normal(" ipl %x", ea->ea_intr[i]);
289 	return (UNCONF);
290 }
291 
292 
293 /*
294  * find the INO values for each interrupt and fill them in.
295  *
296  * for each "reg" property of this device, mask it's hi and lo
297  * values with the "interrupt-map-mask"'s hi/lo values, and also
298  * mask the interrupt number with the interrupt mask.  search the
299  * "interrupt-map" list for matching values of hi, lo and interrupt
300  * to give the INO for this interrupt.
301  */
302 void
303 ebus_find_ino(struct ebus_softc *sc, struct ebus_attach_args *ea)
304 {
305 	uint32_t hi, lo, intr;
306 	int i, j, k;
307 
308 	if (sc->sc_nintmap == 0) {
309 		for (i = 0; i < ea->ea_nintr; i++) {
310 			OF_mapintr(ea->ea_node, &ea->ea_intr[i],
311 				sizeof(ea->ea_intr[0]),
312 				sizeof(ea->ea_intr[0]));
313 		}
314 		return;
315 	}
316 
317 	DPRINTF(EDB_INTRMAP,
318 	    ("ebus_find_ino: searching %d interrupts", ea->ea_nintr));
319 
320 	for (j = 0; j < ea->ea_nintr; j++) {
321 
322 		intr = ea->ea_intr[j] & sc->sc_intmapmask.intr;
323 
324 		DPRINTF(EDB_INTRMAP,
325 		    ("; intr %x masked to %x", ea->ea_intr[j], intr));
326 		for (i = 0; i < ea->ea_nreg; i++) {
327 			hi = ea->ea_reg[i].hi & sc->sc_intmapmask.hi;
328 			lo = ea->ea_reg[i].lo & sc->sc_intmapmask.lo;
329 
330 			DPRINTF(EDB_INTRMAP,
331 			    ("; reg hi.lo %08x.%08x masked to %08x.%08x",
332 			    ea->ea_reg[i].hi, ea->ea_reg[i].lo, hi, lo));
333 			for (k = 0; k < sc->sc_nintmap; k++) {
334 				DPRINTF(EDB_INTRMAP,
335 				    ("; checking hi.lo %08x.%08x intr %x",
336 				    sc->sc_intmap[k].hi, sc->sc_intmap[k].lo,
337 				    sc->sc_intmap[k].intr));
338 				if (hi == sc->sc_intmap[k].hi &&
339 				    lo == sc->sc_intmap[k].lo &&
340 				    intr == sc->sc_intmap[k].intr) {
341 					ea->ea_intr[j] =
342 					    sc->sc_intmap[k].cintr;
343 					DPRINTF(EDB_INTRMAP,
344 					    ("; FOUND IT! changing to %d\n",
345 					    sc->sc_intmap[k].cintr));
346 					goto next_intr;
347 				}
348 			}
349 		}
350 next_intr:;
351 	}
352 }
353 
354 /*
355  * bus space support.  <sparc64/dev/psychoreg.h> has a discussion
356  * about PCI physical addresses, which also applies to ebus.
357  */
358 bus_space_tag_t
359 ebus_alloc_bus_tag(struct ebus_softc *sc, int type)
360 {
361 	bus_space_tag_t bt;
362 
363 	bt = (bus_space_tag_t)
364 		malloc(sizeof(struct sparc_bus_space_tag), M_DEVBUF, M_NOWAIT);
365 	if (bt == NULL)
366 		panic("could not allocate ebus bus tag");
367 
368 	memset(bt, 0, sizeof *bt);
369 	bt->cookie = sc;
370 	bt->parent = sc->sc_memtag;
371 	bt->type = type;
372 	bt->sparc_bus_map = _ebus_bus_map;
373 	bt->sparc_bus_mmap = ebus_bus_mmap;
374 	bt->sparc_intr_establish = ebus_intr_establish;
375 	return (bt);
376 }
377 
378 static int
379 _ebus_bus_map(bus_space_tag_t t, bus_addr_t ba, bus_size_t size, int flags,
380 	vaddr_t va, bus_space_handle_t *hp)
381 {
382 	struct ebus_softc *sc = t->cookie;
383 	paddr_t offset;
384 	u_int bar;
385 	int i, ss;
386 
387 	bar = BUS_ADDR_IOSPACE(ba);
388 	offset = BUS_ADDR_PADDR(ba);
389 
390 	DPRINTF(EDB_BUSMAP,
391 		("\n_ebus_bus_map: bar %d offset %08x sz %x flags %x va %p\n",
392 		 (int)bar, (uint32_t)offset, (uint32_t)size,
393 		 flags, (void *)va));
394 
395 	for (i = 0; i < sc->sc_nrange; i++) {
396 		bus_addr_t pciaddr;
397 
398 		if (bar != sc->sc_range[i].child_hi)
399 			continue;
400 		if (offset < sc->sc_range[i].child_lo ||
401 		    (offset + size) >
402 		      (sc->sc_range[i].child_lo + sc->sc_range[i].size))
403 			continue;
404 
405 		/* Isolate address space and find the right tag */
406 		ss = (sc->sc_range[i].phys_hi>>24)&3;
407 		switch (ss) {
408 		case 1:	/* I/O space */
409 			t = sc->sc_iotag;
410 			break;
411 		case 2:	/* Memory space */
412 			t = sc->sc_memtag;
413 			break;
414 		case 0:	/* Config space */
415 		case 3:	/* 64-bit Memory space */
416 		default: /* WTF? */
417 			/* We don't handle these */
418 			panic("_ebus_bus_map: illegal space %x", ss);
419 			break;
420 		}
421 		pciaddr = ((bus_addr_t)sc->sc_range[i].phys_mid << 32UL) |
422 				       sc->sc_range[i].phys_lo;
423 		pciaddr += offset;
424 
425 		DPRINTF(EDB_BUSMAP,
426 			("_ebus_bus_map: mapping to PCI addr %x\n",
427 			 (uint32_t)pciaddr));
428 
429 		/* pass it onto the psycho */
430 		return (bus_space_map(t, pciaddr, size, flags, hp));
431 	}
432 	DPRINTF(EDB_BUSMAP, (": FAILED\n"));
433 	return (EINVAL);
434 }
435 
436 paddr_t
437 ebus_bus_mmap(bus_space_tag_t t, bus_addr_t paddr, off_t off, int prot,
438 	int flags)
439 {
440 	bus_addr_t offset = paddr;
441 	struct ebus_softc *sc = t->cookie;
442 	int i;
443 
444 	for (i = 0; i < sc->sc_nrange; i++) {
445 		bus_addr_t paddr1 =
446 		    ((bus_addr_t)sc->sc_range[i].child_hi << 32) |
447 		    sc->sc_range[i].child_lo;
448 
449 		if (offset != paddr1)
450 			continue;
451 
452 		DPRINTF(EDB_BUSMAP, ("\n_ebus_bus_mmap: mapping paddr %qx\n",
453 		    (unsigned long long)paddr1));
454 		return (bus_space_mmap(sc->sc_memtag, paddr1, off,
455 				       prot, flags));
456 	}
457 
458 	return (-1);
459 }
460 
461 /*
462  * install an interrupt handler for a ebus device
463  */
464 void *
465 ebus_intr_establish(bus_space_tag_t t, int pri, int level,
466 	int (*handler)(void *), void *arg, void (*fastvec)(void) /* ignored */)
467 {
468 
469 	return (bus_intr_establish(t->parent, pri, level, handler, arg));
470 }
471