1/*-
2 * Copyright (c) 2011 Nathan Whitehorn
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 THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD$");
29#include <sys/param.h>
30#include <sys/systm.h>
31#include <sys/module.h>
32#include <sys/bus.h>
33#include <sys/conf.h>
34#include <sys/kernel.h>
35
36#include <dev/ofw/openfirm.h>
37#include <dev/ofw/ofw_pci.h>
38#include <dev/ofw/ofw_bus.h>
39#include <dev/ofw/ofw_bus_subr.h>
40
41#include <dev/pci/pcivar.h>
42#include <dev/pci/pcireg.h>
43
44#include <machine/bus.h>
45#include <machine/intr_machdep.h>
46#include <machine/md_var.h>
47#include <machine/pio.h>
48#include <machine/resource.h>
49
50#include <sys/rman.h>
51
52#include <vm/vm.h>
53#include <vm/pmap.h>
54
55#include <powerpc/ofw/ofw_pci.h>
56
57#include "pcib_if.h"
58
59/*
60 * Bus interface.
61 */
62static int		ofw_pci_read_ivar(device_t, device_t, int,
63			    uintptr_t *);
64static struct		resource * ofw_pci_alloc_resource(device_t bus,
65			    device_t child, int type, int *rid, rman_res_t start,
66			    rman_res_t end, rman_res_t count, u_int flags);
67static int		ofw_pci_release_resource(device_t bus, device_t child,
68    			    int type, int rid, struct resource *res);
69static int		ofw_pci_activate_resource(device_t bus, device_t child,
70			    int type, int rid, struct resource *res);
71static int		ofw_pci_deactivate_resource(device_t bus,
72    			    device_t child, int type, int rid,
73    			    struct resource *res);
74static int		ofw_pci_adjust_resource(device_t bus, device_t child,
75			    int type, struct resource *res, rman_res_t start,
76			    rman_res_t end);
77
78/*
79 * pcib interface.
80 */
81static int		ofw_pci_maxslots(device_t);
82static int		ofw_pci_route_interrupt(device_t, device_t, int);
83
84/*
85 * ofw_bus interface
86 */
87static phandle_t ofw_pci_get_node(device_t bus, device_t dev);
88
89/*
90 * local methods
91 */
92
93static int ofw_pci_nranges(phandle_t node);
94static int ofw_pci_fill_ranges(phandle_t node, struct ofw_pci_range *ranges);
95
96/*
97 * Driver methods.
98 */
99static device_method_t	ofw_pci_methods[] = {
100	/* Device interface */
101	DEVMETHOD(device_attach,	ofw_pci_attach),
102
103	/* Bus interface */
104	DEVMETHOD(bus_print_child,	bus_generic_print_child),
105	DEVMETHOD(bus_read_ivar,	ofw_pci_read_ivar),
106	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
107	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
108	DEVMETHOD(bus_alloc_resource,	ofw_pci_alloc_resource),
109	DEVMETHOD(bus_release_resource,	ofw_pci_release_resource),
110	DEVMETHOD(bus_activate_resource,	ofw_pci_activate_resource),
111	DEVMETHOD(bus_deactivate_resource,	ofw_pci_deactivate_resource),
112	DEVMETHOD(bus_adjust_resource,	ofw_pci_adjust_resource),
113
114	/* pcib interface */
115	DEVMETHOD(pcib_maxslots,	ofw_pci_maxslots),
116	DEVMETHOD(pcib_route_interrupt,	ofw_pci_route_interrupt),
117
118	/* ofw_bus interface */
119	DEVMETHOD(ofw_bus_get_node,     ofw_pci_get_node),
120
121	DEVMETHOD_END
122};
123
124DEFINE_CLASS_0(ofw_pci, ofw_pci_driver, ofw_pci_methods, 0);
125
126int
127ofw_pci_init(device_t dev)
128{
129	struct		ofw_pci_softc *sc;
130	phandle_t	node;
131	u_int32_t	busrange[2];
132	struct		ofw_pci_range *rp;
133	int		error;
134
135	node = ofw_bus_get_node(dev);
136	sc = device_get_softc(dev);
137	sc->sc_initialized = 1;
138
139	if (OF_getencprop(node, "bus-range", busrange, sizeof(busrange)) != 8)
140		busrange[0] = 0;
141
142	sc->sc_dev = dev;
143	sc->sc_node = node;
144	sc->sc_bus = busrange[0];
145
146	if (sc->sc_quirks & OFW_PCI_QUIRK_RANGES_ON_CHILDREN) {
147		phandle_t c;
148		int n, i;
149
150		sc->sc_nrange = 0;
151		for (c = OF_child(node); c != 0; c = OF_peer(c)) {
152			n = ofw_pci_nranges(c);
153			if (n > 0)
154				sc->sc_nrange += n;
155		}
156		if (sc->sc_nrange == 0)
157			return (ENXIO);
158		sc->sc_range = malloc(sc->sc_nrange * sizeof(sc->sc_range[0]),
159		    M_DEVBUF, M_WAITOK);
160		i = 0;
161		for (c = OF_child(node); c != 0; c = OF_peer(c)) {
162			n = ofw_pci_fill_ranges(c, &sc->sc_range[i]);
163			if (n > 0)
164				i += n;
165		}
166		KASSERT(i == sc->sc_nrange, ("range count mismatch"));
167	} else {
168		sc->sc_nrange = ofw_pci_nranges(node);
169		if (sc->sc_nrange <= 0) {
170			device_printf(dev, "could not get ranges\n");
171			return (ENXIO);
172		}
173		sc->sc_range = malloc(sc->sc_nrange * sizeof(sc->sc_range[0]),
174		    M_DEVBUF, M_WAITOK);
175		ofw_pci_fill_ranges(node, sc->sc_range);
176	}
177
178	sc->sc_io_rman.rm_type = RMAN_ARRAY;
179	sc->sc_io_rman.rm_descr = "PCI I/O Ports";
180	error = rman_init(&sc->sc_io_rman);
181	if (error) {
182		device_printf(dev, "rman_init() failed. error = %d\n", error);
183		return (error);
184	}
185
186	sc->sc_mem_rman.rm_type = RMAN_ARRAY;
187	sc->sc_mem_rman.rm_descr = "PCI Memory";
188	error = rman_init(&sc->sc_mem_rman);
189	if (error) {
190		device_printf(dev, "rman_init() failed. error = %d\n", error);
191		return (error);
192	}
193
194	for (rp = sc->sc_range; rp < sc->sc_range + sc->sc_nrange &&
195	       rp->pci_hi != 0; rp++) {
196		error = 0;
197
198		switch (rp->pci_hi & OFW_PCI_PHYS_HI_SPACEMASK) {
199		case OFW_PCI_PHYS_HI_SPACE_CONFIG:
200			break;
201		case OFW_PCI_PHYS_HI_SPACE_IO:
202			error = rman_manage_region(&sc->sc_io_rman, rp->pci,
203			    rp->pci + rp->size - 1);
204			break;
205		case OFW_PCI_PHYS_HI_SPACE_MEM32:
206		case OFW_PCI_PHYS_HI_SPACE_MEM64:
207			error = rman_manage_region(&sc->sc_mem_rman, rp->pci,
208			    rp->pci + rp->size - 1);
209			break;
210		}
211
212		if (error) {
213			device_printf(dev,
214			    "rman_manage_region(%x, %#jx, %#jx) failed. "
215			    "error = %d\n", rp->pci_hi &
216			    OFW_PCI_PHYS_HI_SPACEMASK, rp->pci,
217			    rp->pci + rp->size - 1, error);
218			return (error);
219		}
220	}
221
222	ofw_bus_setup_iinfo(node, &sc->sc_pci_iinfo, sizeof(cell_t));
223
224	return (error);
225}
226
227int
228ofw_pci_attach(device_t dev)
229{
230	struct ofw_pci_softc *sc;
231	int error;
232
233	sc = device_get_softc(dev);
234	if (!sc->sc_initialized) {
235		error = ofw_pci_init(dev);
236		if (error)
237			return (error);
238	}
239
240	device_add_child(dev, "pci", -1);
241	return (bus_generic_attach(dev));
242}
243
244static int
245ofw_pci_maxslots(device_t dev)
246{
247
248	return (PCI_SLOTMAX);
249}
250
251static int
252ofw_pci_route_interrupt(device_t bus, device_t dev, int pin)
253{
254	struct ofw_pci_softc *sc;
255	struct ofw_pci_register reg;
256	uint32_t pintr, mintr[2];
257	int intrcells;
258	phandle_t iparent;
259
260	sc = device_get_softc(bus);
261	pintr = pin;
262
263	/* Fabricate imap information in case this isn't an OFW device */
264	bzero(&reg, sizeof(reg));
265	reg.phys_hi = (pci_get_bus(dev) << OFW_PCI_PHYS_HI_BUSSHIFT) |
266	    (pci_get_slot(dev) << OFW_PCI_PHYS_HI_DEVICESHIFT) |
267	    (pci_get_function(dev) << OFW_PCI_PHYS_HI_FUNCTIONSHIFT);
268
269	intrcells = ofw_bus_lookup_imap(ofw_bus_get_node(dev),
270	    &sc->sc_pci_iinfo, &reg, sizeof(reg), &pintr, sizeof(pintr),
271	    mintr, sizeof(mintr), &iparent);
272	if (intrcells) {
273		pintr = ofw_bus_map_intr(dev, iparent, intrcells, mintr);
274		return (pintr);
275	}
276
277	/* Maybe it's a real interrupt, not an intpin */
278	if (pin > 4)
279		return (pin);
280
281	device_printf(bus, "could not route pin %d for device %d.%d\n",
282	    pin, pci_get_slot(dev), pci_get_function(dev));
283	return (PCI_INVALID_IRQ);
284}
285
286static int
287ofw_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
288{
289	struct	ofw_pci_softc *sc;
290
291	sc = device_get_softc(dev);
292
293	switch (which) {
294	case PCIB_IVAR_DOMAIN:
295		*result = device_get_unit(dev);
296		return (0);
297	case PCIB_IVAR_BUS:
298		*result = sc->sc_bus;
299		return (0);
300	}
301
302	return (ENOENT);
303}
304
305static struct resource *
306ofw_pci_alloc_resource(device_t bus, device_t child, int type, int *rid,
307    rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
308{
309	struct			ofw_pci_softc *sc;
310	struct			resource *rv;
311	struct			rman *rm;
312	int			needactivate;
313
314	needactivate = flags & RF_ACTIVE;
315	flags &= ~RF_ACTIVE;
316
317	sc = device_get_softc(bus);
318
319	switch (type) {
320	case SYS_RES_MEMORY:
321		rm = &sc->sc_mem_rman;
322		break;
323
324	case SYS_RES_IOPORT:
325		rm = &sc->sc_io_rman;
326		break;
327
328	case SYS_RES_IRQ:
329		return (bus_alloc_resource(bus, type, rid, start, end, count,
330		    flags));
331
332	default:
333		device_printf(bus, "unknown resource request from %s\n",
334		    device_get_nameunit(child));
335		return (NULL);
336	}
337
338	rv = rman_reserve_resource(rm, start, end, count, flags, child);
339	if (rv == NULL) {
340		device_printf(bus, "failed to reserve resource for %s\n",
341		    device_get_nameunit(child));
342		return (NULL);
343	}
344
345	rman_set_rid(rv, *rid);
346
347	if (needactivate) {
348		if (bus_activate_resource(child, type, *rid, rv) != 0) {
349			device_printf(bus,
350			    "failed to activate resource for %s\n",
351			    device_get_nameunit(child));
352			rman_release_resource(rv);
353			return (NULL);
354		}
355	}
356
357	return (rv);
358}
359
360static int
361ofw_pci_release_resource(device_t bus, device_t child, int type, int rid,
362    struct resource *res)
363{
364	if (rman_get_flags(res) & RF_ACTIVE) {
365		int error = bus_deactivate_resource(child, type, rid, res);
366		if (error)
367			return error;
368	}
369
370	return (rman_release_resource(res));
371}
372
373static int
374ofw_pci_activate_resource(device_t bus, device_t child, int type, int rid,
375    struct resource *res)
376{
377	struct ofw_pci_softc *sc;
378	void	*p;
379
380	sc = device_get_softc(bus);
381
382	if (type == SYS_RES_IRQ) {
383		return (bus_activate_resource(bus, type, rid, res));
384	}
385	if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
386		struct ofw_pci_range *rp;
387		vm_paddr_t start;
388		int space;
389
390		start = (vm_paddr_t)rman_get_start(res);
391
392		/*
393		 * Map this through the ranges list
394		 */
395		for (rp = sc->sc_range; rp < sc->sc_range + sc->sc_nrange &&
396		       rp->pci_hi != 0; rp++) {
397			if (start < rp->pci || start >= rp->pci + rp->size)
398				continue;
399
400			switch (rp->pci_hi & OFW_PCI_PHYS_HI_SPACEMASK) {
401			case OFW_PCI_PHYS_HI_SPACE_IO:
402				space = SYS_RES_IOPORT;
403				break;
404			case OFW_PCI_PHYS_HI_SPACE_MEM32:
405			case OFW_PCI_PHYS_HI_SPACE_MEM64:
406				space = SYS_RES_MEMORY;
407				break;
408			default:
409				space = -1;
410			}
411
412			if (type == space) {
413				start += (rp->host - rp->pci);
414				break;
415			}
416		}
417
418		if (bootverbose)
419			printf("ofw_pci mapdev: start %jx, len %jd\n",
420			    (rman_res_t)start, rman_get_size(res));
421
422		p = pmap_mapdev(start, (vm_size_t)rman_get_size(res));
423		if (p == NULL)
424			return (ENOMEM);
425
426		rman_set_virtual(res, p);
427		rman_set_bustag(res, &bs_le_tag);
428		rman_set_bushandle(res, (u_long)p);
429	}
430
431	return (rman_activate_resource(res));
432}
433
434static int
435ofw_pci_deactivate_resource(device_t bus, device_t child, int type, int rid,
436    struct resource *res)
437{
438	/*
439	 * If this is a memory resource, unmap it.
440	 */
441	if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
442		u_int32_t psize;
443
444		psize = rman_get_size(res);
445		pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize);
446	}
447
448	return (rman_deactivate_resource(res));
449}
450
451static int
452ofw_pci_adjust_resource(device_t bus, device_t child, int type,
453    struct resource *res, rman_res_t start, rman_res_t end)
454{
455	struct rman *rm = NULL;
456	struct ofw_pci_softc *sc = device_get_softc(bus);
457
458	KASSERT(!(rman_get_flags(res) & RF_ACTIVE),
459	    ("active resources cannot be adjusted"));
460	if (rman_get_flags(res) & RF_ACTIVE)
461		return (EINVAL);
462
463	switch (type) {
464	case SYS_RES_MEMORY:
465		rm = &sc->sc_mem_rman;
466		break;
467	case SYS_RES_IOPORT:
468		rm = &sc->sc_io_rman;
469		break;
470	default:
471		return (ENXIO);
472	}
473
474	if (!rman_is_region_manager(res, rm))
475		return (EINVAL);
476
477	return (rman_adjust_resource(res, start, end));
478}
479
480
481static phandle_t
482ofw_pci_get_node(device_t bus, device_t dev)
483{
484	struct ofw_pci_softc *sc;
485
486	sc = device_get_softc(bus);
487	/* We only have one child, the PCI bus, which needs our own node. */
488
489	return (sc->sc_node);
490}
491
492static int
493ofw_pci_nranges(phandle_t node)
494{
495	int host_address_cells = 1, pci_address_cells = 3, size_cells = 2;
496	ssize_t nbase_ranges;
497
498	OF_getencprop(OF_parent(node), "#address-cells", &host_address_cells,
499	    sizeof(host_address_cells));
500	OF_getencprop(node, "#address-cells", &pci_address_cells,
501	    sizeof(pci_address_cells));
502	OF_getencprop(node, "#size-cells", &size_cells, sizeof(size_cells));
503
504	nbase_ranges = OF_getproplen(node, "ranges");
505	if (nbase_ranges <= 0)
506		return (-1);
507
508	return (nbase_ranges / sizeof(cell_t) /
509	    (pci_address_cells + host_address_cells + size_cells));
510}
511
512static int
513ofw_pci_fill_ranges(phandle_t node, struct ofw_pci_range *ranges)
514{
515	int host_address_cells = 1, pci_address_cells = 3, size_cells = 2;
516	cell_t *base_ranges;
517	ssize_t nbase_ranges;
518	int nranges;
519	int i, j, k;
520
521	OF_getencprop(OF_parent(node), "#address-cells", &host_address_cells,
522	    sizeof(host_address_cells));
523	OF_getencprop(node, "#address-cells", &pci_address_cells,
524	    sizeof(pci_address_cells));
525	OF_getencprop(node, "#size-cells", &size_cells, sizeof(size_cells));
526
527	nbase_ranges = OF_getproplen(node, "ranges");
528	if (nbase_ranges <= 0)
529		return (-1);
530	nranges = nbase_ranges / sizeof(cell_t) /
531	    (pci_address_cells + host_address_cells + size_cells);
532
533	base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK);
534	OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
535
536	for (i = 0, j = 0; i < nranges; i++) {
537		ranges[i].pci_hi = base_ranges[j++];
538		ranges[i].pci = 0;
539		for (k = 0; k < pci_address_cells - 1; k++) {
540			ranges[i].pci <<= 32;
541			ranges[i].pci |= base_ranges[j++];
542		}
543		ranges[i].host = 0;
544		for (k = 0; k < host_address_cells; k++) {
545			ranges[i].host <<= 32;
546			ranges[i].host |= base_ranges[j++];
547		}
548		ranges[i].size = 0;
549		for (k = 0; k < size_cells; k++) {
550			ranges[i].size <<= 32;
551			ranges[i].size |= base_ranges[j++];
552		}
553	}
554
555	free(base_ranges, M_DEVBUF);
556	return (nranges);
557}
558
559