xref: /freebsd/sys/powerpc/powermac/uninorth.c (revision 4f29da19bd44f0e99f021510460a81bf754c21d2) 
1 /*-
2  * Copyright (C) 2002 Benno Rice.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
23  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #include <sys/param.h>
29 #include <sys/systm.h>
30 #include <sys/module.h>
31 #include <sys/bus.h>
32 #include <sys/conf.h>
33 #include <sys/kernel.h>
34 
35 #include <dev/ofw/openfirm.h>
36 #include <dev/ofw/ofw_pci.h>
37 
38 #include <dev/pci/pcivar.h>
39 #include <dev/pci/pcireg.h>
40 
41 #include <machine/bus.h>
42 #include <machine/md_var.h>
43 #include <machine/nexusvar.h>
44 #include <machine/resource.h>
45 
46 #include <sys/rman.h>
47 
48 #include <powerpc/ofw/ofw_pci.h>
49 #include <powerpc/powermac/uninorthvar.h>
50 
51 #include <vm/vm.h>
52 #include <vm/pmap.h>
53 
54 #include "pcib_if.h"
55 
56 #define	UNINORTH_DEBUG	0
57 
58 /*
59  * Device interface.
60  */
61 static int		uninorth_probe(device_t);
62 static int		uninorth_attach(device_t);
63 
64 /*
65  * Bus interface.
66  */
67 static int		uninorth_read_ivar(device_t, device_t, int,
68 			    uintptr_t *);
69 static struct		resource * uninorth_alloc_resource(device_t bus,
70 			    device_t child, int type, int *rid, u_long start,
71 			    u_long end, u_long count, u_int flags);
72 static int		uninorth_activate_resource(device_t bus, device_t child,
73 			    int type, int rid, struct resource *res);
74 
75 /*
76  * pcib interface.
77  */
78 static int		uninorth_maxslots(device_t);
79 static u_int32_t	uninorth_read_config(device_t, u_int, u_int, u_int,
80 			    u_int, int);
81 static void		uninorth_write_config(device_t, u_int, u_int, u_int,
82 			    u_int, u_int32_t, int);
83 static int		uninorth_route_interrupt(device_t, device_t, int);
84 
85 /*
86  * Local routines.
87  */
88 static int		uninorth_enable_config(struct uninorth_softc *, u_int,
89 			    u_int, u_int, u_int);
90 static void		unin_enable_gmac(void);
91 
92 /*
93  * Driver methods.
94  */
95 static device_method_t	uninorth_methods[] = {
96 	/* Device interface */
97 	DEVMETHOD(device_probe,		uninorth_probe),
98 	DEVMETHOD(device_attach,	uninorth_attach),
99 
100 	/* Bus interface */
101 	DEVMETHOD(bus_print_child,	bus_generic_print_child),
102 	DEVMETHOD(bus_read_ivar,	uninorth_read_ivar),
103 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
104 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
105 	DEVMETHOD(bus_alloc_resource,	uninorth_alloc_resource),
106 	DEVMETHOD(bus_activate_resource,	uninorth_activate_resource),
107 
108 	/* pcib interface */
109 	DEVMETHOD(pcib_maxslots,	uninorth_maxslots),
110 	DEVMETHOD(pcib_read_config,	uninorth_read_config),
111 	DEVMETHOD(pcib_write_config,	uninorth_write_config),
112 	DEVMETHOD(pcib_route_interrupt,	uninorth_route_interrupt),
113 
114 	{ 0, 0 }
115 };
116 
117 static driver_t	uninorth_driver = {
118 	"pcib",
119 	uninorth_methods,
120 	sizeof(struct uninorth_softc)
121 };
122 
123 static devclass_t	uninorth_devclass;
124 
125 DRIVER_MODULE(uninorth, nexus, uninorth_driver, uninorth_devclass, 0, 0);
126 
127 static int
128 uninorth_probe(device_t dev)
129 {
130 	char	*type, *compatible;
131 
132 	type = nexus_get_device_type(dev);
133 	compatible = nexus_get_compatible(dev);
134 
135 	if (type == NULL || compatible == NULL)
136 		return (ENXIO);
137 
138 	if (strcmp(type, "pci") != 0 || strcmp(compatible, "uni-north") != 0)
139 		return (ENXIO);
140 
141 	device_set_desc(dev, "Apple UniNorth Host-PCI bridge");
142 	return (0);
143 }
144 
145 static int
146 uninorth_attach(device_t dev)
147 {
148 	struct		uninorth_softc *sc;
149 	phandle_t	node;
150 	phandle_t	child;
151 	u_int32_t	reg[2], busrange[2];
152 	struct		uninorth_range *rp, *io, *mem[2];
153 	int		nmem, i;
154 
155 	node = nexus_get_node(dev);
156 	sc = device_get_softc(dev);
157 
158 	if (OF_getprop(node, "reg", reg, sizeof(reg)) < 8)
159 		return (ENXIO);
160 
161 	if (OF_getprop(node, "bus-range", busrange, sizeof(busrange)) != 8)
162 		return (ENXIO);
163 
164 	sc->sc_dev = dev;
165 	sc->sc_node = node;
166 	sc->sc_addr = (vm_offset_t)pmap_mapdev(reg[0] + 0x800000, PAGE_SIZE);
167 	sc->sc_data = (vm_offset_t)pmap_mapdev(reg[0] + 0xc00000, PAGE_SIZE);
168 	sc->sc_bus = busrange[0];
169 
170 	bzero(sc->sc_range, sizeof(sc->sc_range));
171 	sc->sc_nrange = OF_getprop(node, "ranges", sc->sc_range,
172 	    sizeof(sc->sc_range));
173 
174 	if (sc->sc_nrange == -1) {
175 		device_printf(dev, "could not get ranges\n");
176 		return (ENXIO);
177 	}
178 
179 	sc->sc_range[6].pci_hi = 0;
180 	io = NULL;
181 	nmem = 0;
182 
183 	for (rp = sc->sc_range; rp->pci_hi != 0; rp++) {
184 		switch (rp->pci_hi & OFW_PCI_PHYS_HI_SPACEMASK) {
185 		case OFW_PCI_PHYS_HI_SPACE_CONFIG:
186 			break;
187 		case OFW_PCI_PHYS_HI_SPACE_IO:
188 			io = rp;
189 			break;
190 		case OFW_PCI_PHYS_HI_SPACE_MEM32:
191 			mem[nmem] = rp;
192 			nmem++;
193 			break;
194 		case OFW_PCI_PHYS_HI_SPACE_MEM64:
195 			break;
196 		}
197 	}
198 
199 	if (io == NULL) {
200 		device_printf(dev, "can't find io range\n");
201 		return (ENXIO);
202 	}
203 	sc->sc_io_rman.rm_type = RMAN_ARRAY;
204 	sc->sc_io_rman.rm_descr = "UniNorth PCI I/O Ports";
205 	sc->sc_iostart = io->host;
206 	if (rman_init(&sc->sc_io_rman) != 0 ||
207 	    rman_manage_region(&sc->sc_io_rman, io->pci_lo,
208 	    io->pci_lo + io->size_lo - 1) != 0) {
209 		device_printf(dev, "failed to set up io range management\n");
210 		return (ENXIO);
211 	}
212 
213 	if (nmem == 0) {
214 		device_printf(dev, "can't find mem ranges\n");
215 		return (ENXIO);
216 	}
217 	sc->sc_mem_rman.rm_type = RMAN_ARRAY;
218 	sc->sc_mem_rman.rm_descr = "UniNorth PCI Memory";
219 	if (rman_init(&sc->sc_mem_rman) != 0) {
220 		device_printf(dev,
221 		    "failed to init mem range resources\n");
222 		return (ENXIO);
223 	}
224 	for (i = 0; i < nmem; i++) {
225 		if (rman_manage_region(&sc->sc_mem_rman, mem[i]->pci_lo,
226 		    mem[i]->pci_lo + mem[i]->size_lo - 1) != 0) {
227 			device_printf(dev,
228 			    "failed to set up memory range management\n");
229 			return (ENXIO);
230 		}
231 	}
232 
233 	/*
234 	 * Enable the GMAC Ethernet cell if Open Firmware says it is
235 	 * used.
236 	 */
237 	for (child = OF_child(node); child; child = OF_peer(child)) {
238 		char compat[32];
239 
240 		memset(compat, 0, sizeof(compat));
241 		OF_getprop(child, "compatible", compat, sizeof(compat));
242 		if (strcmp(compat, "gmac") == 0) {
243 			unin_enable_gmac();
244 		}
245 	}
246 
247 	/*
248 	 * Write out the correct PIC interrupt values to config space
249 	 * of all devices on the bus. This has to be done after the GEM
250 	 * cell is enabled above.
251 	 */
252 	ofw_pci_fixup(dev, sc->sc_bus, node);
253 
254 	device_add_child(dev, "pci", device_get_unit(dev));
255 	return (bus_generic_attach(dev));
256 }
257 
258 static int
259 uninorth_maxslots(device_t dev)
260 {
261 
262 	return (PCI_SLOTMAX);
263 }
264 
265 static u_int32_t
266 uninorth_read_config(device_t dev, u_int bus, u_int slot, u_int func, u_int reg,
267     int width)
268 {
269 	struct		uninorth_softc *sc;
270 	vm_offset_t	caoff;
271 
272 	sc = device_get_softc(dev);
273 	caoff = sc->sc_data + (reg & 0x07);
274 
275 	if (uninorth_enable_config(sc, bus, slot, func, reg) != 0) {
276 		switch (width) {
277 		case 1:
278 			return (in8rb(caoff));
279 			break;
280 		case 2:
281 			return (in16rb(caoff));
282 			break;
283 		case 4:
284 			return (in32rb(caoff));
285 			break;
286 		}
287 	}
288 
289 	return (0xffffffff);
290 }
291 
292 static void
293 uninorth_write_config(device_t dev, u_int bus, u_int slot, u_int func,
294     u_int reg, u_int32_t val, int width)
295 {
296 	struct		uninorth_softc *sc;
297 	vm_offset_t	caoff;
298 
299 	sc = device_get_softc(dev);
300 	caoff = sc->sc_data + (reg & 0x07);
301 
302 	if (uninorth_enable_config(sc, bus, slot, func, reg)) {
303 		switch (width) {
304 		case 1:
305 			out8rb(caoff, val);
306 			(void)in8rb(caoff);
307 			break;
308 		case 2:
309 			out16rb(caoff, val);
310 			(void)in16rb(caoff);
311 			break;
312 		case 4:
313 			out32rb(caoff, val);
314 			(void)in32rb(caoff);
315 			break;
316 		}
317 	}
318 }
319 
320 static int
321 uninorth_route_interrupt(device_t bus, device_t dev, int pin)
322 {
323 
324 	return (0);
325 }
326 
327 static int
328 uninorth_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
329 {
330 	struct	uninorth_softc *sc;
331 
332 	sc = device_get_softc(dev);
333 
334 	switch (which) {
335 	case PCIB_IVAR_BUS:
336 		*result = sc->sc_bus;
337 		return (0);
338 		break;
339 	}
340 
341 	return (ENOENT);
342 }
343 
344 static struct resource *
345 uninorth_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)
347 {
348 	struct			uninorth_softc *sc;
349 	struct			resource *rv;
350 	struct			rman *rm;
351 	bus_space_tag_t		bt;
352 	int			needactivate;
353 
354 	needactivate = flags & RF_ACTIVE;
355 	flags &= ~RF_ACTIVE;
356 
357 	sc = device_get_softc(bus);
358 
359 	switch (type) {
360 	case SYS_RES_MEMORY:
361 		rm = &sc->sc_mem_rman;
362 		bt = PPC_BUS_SPACE_MEM;
363 		break;
364 
365 	case SYS_RES_IOPORT:
366 		rm = &sc->sc_io_rman;
367 		bt = PPC_BUS_SPACE_IO;
368 		break;
369 
370 	case SYS_RES_IRQ:
371 		return (bus_alloc_resource(bus, type, rid, start, end, count,
372 		    flags));
373 		break;
374 	default:
375 		device_printf(bus, "unknown resource request from %s\n",
376 		    device_get_nameunit(child));
377 		return (NULL);
378 	}
379 
380 	rv = rman_reserve_resource(rm, start, end, count, flags, child);
381 	if (rv == NULL) {
382 		device_printf(bus, "failed to reserve resource for %s\n",
383 		    device_get_nameunit(child));
384 		return (NULL);
385 	}
386 
387 	rman_set_bustag(rv, bt);
388 	rman_set_bushandle(rv, rman_get_start(rv));
389 
390 	if (needactivate) {
391 		if (bus_activate_resource(child, type, *rid, rv) != 0) {
392 			device_printf(bus,
393 			    "failed to activate resource for %s\n",
394 			    device_get_nameunit(child));
395 			rman_release_resource(rv);
396 			return (NULL);
397 		}
398 	}
399 
400 	return (rv);
401 }
402 
403 static int
404 uninorth_activate_resource(device_t bus, device_t child, int type, int rid,
405     struct resource *res)
406 {
407 	void	*p;
408 	struct	uninorth_softc *sc;
409 
410 	sc = device_get_softc(bus);
411 
412 	if (type == SYS_RES_IRQ)
413 		return (bus_activate_resource(bus, type, rid, res));
414 
415 	if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
416 		vm_offset_t start;
417 
418 		start = (vm_offset_t)rman_get_start(res);
419 		/*
420 		 * For i/o-ports, convert the start address to the
421 		 * uninorth PCI i/o window
422 		 */
423 		if (type == SYS_RES_IOPORT)
424 			start += sc->sc_iostart;
425 
426 		if (bootverbose)
427 			printf("uninorth mapdev: start %x, len %ld\n", start,
428 			    rman_get_size(res));
429 
430 		p = pmap_mapdev(start, (vm_size_t)rman_get_size(res));
431 		if (p == NULL)
432 			return (ENOMEM);
433 		rman_set_virtual(res, p);
434 		rman_set_bushandle(res, (u_long)p);
435 	}
436 
437 	return (rman_activate_resource(res));
438 }
439 
440 static int
441 uninorth_enable_config(struct uninorth_softc *sc, u_int bus, u_int slot,
442     u_int func, u_int reg)
443 {
444 	uint32_t	cfgval;
445 	uint32_t	pass;
446 
447 	if (resource_int_value(device_get_name(sc->sc_dev),
448 	        device_get_unit(sc->sc_dev), "skipslot", &pass) == 0) {
449 		if (pass == slot)
450 			return (0);
451 	}
452 
453 	if (sc->sc_bus == bus) {
454 		/*
455 		 * No slots less than 11 on the primary bus
456 		 */
457 		if (slot < 11)
458 			return (0);
459 
460 		cfgval = (1 << slot) | (func << 8) | (reg & 0xfc);
461 	} else {
462 		cfgval = (bus << 16) | (slot << 11) | (func << 8) |
463 		    (reg & 0xfc) | 1;
464 	}
465 
466 	do {
467 		out32rb(sc->sc_addr, cfgval);
468 	} while (in32rb(sc->sc_addr) != cfgval);
469 
470 	return (1);
471 }
472 
473 /*
474  * Driver to swallow UniNorth host bridges from the PCI bus side.
475  */
476 static int
477 unhb_probe(device_t dev)
478 {
479 
480 	if (pci_get_class(dev) == PCIC_BRIDGE &&
481 	    pci_get_subclass(dev) == PCIS_BRIDGE_HOST) {
482 		device_set_desc(dev, "Host to PCI bridge");
483 		device_quiet(dev);
484 		return (-10000);
485 	}
486 
487 	return (ENXIO);
488 }
489 
490 static int
491 unhb_attach(device_t dev)
492 {
493 
494 	return (0);
495 }
496 
497 static device_method_t unhb_methods[] = {
498 	/* Device interface */
499 	DEVMETHOD(device_probe,         unhb_probe),
500 	DEVMETHOD(device_attach,        unhb_attach),
501 
502 	{ 0, 0 }
503 };
504 
505 static driver_t unhb_driver = {
506 	"unhb",
507 	unhb_methods,
508 	1,
509 };
510 static devclass_t unhb_devclass;
511 
512 DRIVER_MODULE(unhb, pci, unhb_driver, unhb_devclass, 0, 0);
513 
514 
515 /*
516  * Small stub driver for the Uninorth chip itself, to allow setting
517  * of various parameters and cell enables
518  */
519 static struct unin_chip_softc *uncsc;
520 
521 static void
522 unin_enable_gmac(void)
523 {
524 	volatile u_int *clkreg;
525 	u_int32_t tmpl;
526 
527 	if (uncsc == NULL)
528 		panic("unin_enable_gmac: device not found");
529 
530 	clkreg = (void *)(uncsc->sc_addr + UNIN_CLOCKCNTL);
531 	tmpl = inl(clkreg);
532 	tmpl |= UNIN_CLOCKCNTL_GMAC;
533 	outl(clkreg, tmpl);
534 }
535 
536 static int
537 unin_chip_probe(device_t dev)
538 {
539 	char	*name;
540 
541 	name = nexus_get_name(dev);
542 
543 	if (name == NULL)
544 		return (ENXIO);
545 
546 	if (strcmp(name, "uni-n") != 0)
547 		return (ENXIO);
548 
549 	device_set_desc(dev, "Apple UniNorth System Controller");
550 	return (0);
551 }
552 
553 static int
554 unin_chip_attach(device_t dev)
555 {
556 	phandle_t node;
557 	u_int reg[2];
558 
559 	uncsc = device_get_softc(dev);
560 	node = nexus_get_node(dev);
561 
562 	if (OF_getprop(node, "reg", reg, sizeof(reg)) < 8)
563 		return (ENXIO);
564 
565 	uncsc->sc_physaddr = reg[0];
566 	uncsc->sc_size = reg[1];
567 
568 	/*
569 	 * Only map the first page, since that is where the registers
570 	 * of interest lie.
571 	 */
572 	uncsc->sc_addr = (vm_offset_t) pmap_mapdev(reg[0], PAGE_SIZE);
573 
574 	uncsc->sc_version = *(u_int *)uncsc->sc_addr;
575 	device_printf(dev, "Version %d\n", uncsc->sc_version);
576 
577 	return (0);
578 }
579 
580 static device_method_t unin_chip_methods[] = {
581 	/* Device interface */
582 	DEVMETHOD(device_probe,         unin_chip_probe),
583 	DEVMETHOD(device_attach,        unin_chip_attach),
584 
585 	{ 0, 0 }
586 };
587 
588 static driver_t	unin_chip_driver = {
589 	"unin",
590 	unin_chip_methods,
591 	sizeof(struct unin_chip_softc)
592 };
593 
594 static devclass_t	unin_chip_devclass;
595 
596 DRIVER_MODULE(unin, nexus, unin_chip_driver, unin_chip_devclass, 0, 0);
597 
598 
599 
600 
601