apb.c revision 190099
1/*-
2 * Copyright (c) 1994,1995 Stefan Esser, Wolfgang StanglMeier
3 * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
4 * Copyright (c) 2000 BSDi
5 * Copyright (c) 2001, 2003 Thomas Moestl <tmm@FreeBSD.org>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. The name of the author may not be used to endorse or promote products
17 *    derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 *	from: FreeBSD: src/sys/dev/pci/pci_pci.c,v 1.3 2000/12/13
32 */
33
34#include <sys/cdefs.h>
35__FBSDID("$FreeBSD: head/sys/sparc64/pci/apb.c 190099 2009-03-19 20:31:55Z marius $");
36
37/*
38 * Support for the Sun APB (Advanced PCI Bridge) PCI-PCI bridge.
39 * This bridge does not fully comply to the PCI bridge specification, and is
40 * therefore not supported by the generic driver.
41 * We can use some of the pcib methods anyway.
42 */
43
44#include "opt_ofw_pci.h"
45
46#include <sys/param.h>
47#include <sys/systm.h>
48#include <sys/kernel.h>
49#include <sys/module.h>
50#include <sys/bus.h>
51
52#include <dev/ofw/ofw_bus.h>
53#include <dev/ofw/openfirm.h>
54
55#include <machine/bus.h>
56#include <machine/resource.h>
57
58#include <dev/pci/pcireg.h>
59#include <dev/pci/pcivar.h>
60#include <dev/pci/pcib_private.h>
61
62#include "pcib_if.h"
63
64#include <sparc64/pci/ofw_pci.h>
65#include <sparc64/pci/ofw_pcib_subr.h>
66
67/*
68 * Bridge-specific data.
69 */
70struct apb_softc {
71	struct ofw_pcib_gen_softc	sc_bsc;
72	uint8_t		sc_iomap;
73	uint8_t		sc_memmap;
74};
75
76static device_probe_t apb_probe;
77static device_attach_t apb_attach;
78static bus_alloc_resource_t apb_alloc_resource;
79
80static device_method_t apb_methods[] = {
81	/* Device interface */
82	DEVMETHOD(device_probe,		apb_probe),
83	DEVMETHOD(device_attach,	apb_attach),
84	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
85	DEVMETHOD(device_suspend,	bus_generic_suspend),
86	DEVMETHOD(device_resume,	bus_generic_resume),
87
88	/* Bus interface */
89	DEVMETHOD(bus_print_child,	bus_generic_print_child),
90	DEVMETHOD(bus_read_ivar,	pcib_read_ivar),
91	DEVMETHOD(bus_write_ivar,	pcib_write_ivar),
92	DEVMETHOD(bus_alloc_resource,	apb_alloc_resource),
93	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
94	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
95	DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
96	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
97	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
98
99	/* pcib interface */
100	DEVMETHOD(pcib_maxslots,	pcib_maxslots),
101	DEVMETHOD(pcib_read_config,	pcib_read_config),
102	DEVMETHOD(pcib_write_config,	pcib_write_config),
103	DEVMETHOD(pcib_route_interrupt,	ofw_pcib_gen_route_interrupt),
104
105	/* ofw_bus interface */
106	DEVMETHOD(ofw_bus_get_node,	ofw_pcib_gen_get_node),
107
108	KOBJMETHOD_END
109};
110
111static devclass_t pcib_devclass;
112
113DEFINE_CLASS_0(pcib, apb_driver, apb_methods, sizeof(struct apb_softc));
114DRIVER_MODULE(apb, pci, apb_driver, pcib_devclass, 0, 0);
115
116/* APB specific registers */
117#define	APBR_IOMAP	0xde
118#define	APBR_MEMMAP	0xdf
119
120/* Definitions for the mapping registers */
121#define	APB_IO_SCALE	0x200000
122#define	APB_MEM_SCALE	0x20000000
123
124/*
125 * Generic device interface
126 */
127static int
128apb_probe(device_t dev)
129{
130
131	if (pci_get_vendor(dev) == 0x108e &&	/* Sun */
132	    pci_get_device(dev) == 0x5000)  {	/* APB */
133		device_set_desc(dev, "APB PCI-PCI bridge");
134		return (0);
135	}
136	return (ENXIO);
137}
138
139static void
140apb_map_print(uint8_t map, u_long scale)
141{
142	int i, first;
143
144	for (first = 1, i = 0; i < 8; i++) {
145		if ((map & (1 << i)) != 0) {
146			printf("%s0x%lx-0x%lx", first ? "" : ", ",
147			    i * scale, (i + 1) * scale - 1);
148			first = 0;
149		}
150	}
151}
152
153static int
154apb_checkrange(uint8_t map, u_long scale, u_long start, u_long end)
155{
156	int i, ei;
157
158	i = start / scale;
159	ei = end / scale;
160	if (i > 7 || ei > 7)
161		return (0);
162	for (; i <= ei; i++)
163		if ((map & (1 << i)) == 0)
164			return (0);
165	return (1);
166}
167
168static int
169apb_attach(device_t dev)
170{
171	struct apb_softc *sc;
172
173	sc = device_get_softc(dev);
174
175	/*
176	 * Get current bridge configuration.
177	 */
178	sc->sc_bsc.ops_pcib_sc.domain = pci_get_domain(dev);
179	sc->sc_bsc.ops_pcib_sc.secbus =
180	    pci_read_config(dev, PCIR_SECBUS_1, 1);
181	sc->sc_bsc.ops_pcib_sc.subbus =
182	    pci_read_config(dev, PCIR_SUBBUS_1, 1);
183	sc->sc_iomap = pci_read_config(dev, APBR_IOMAP, 1);
184	sc->sc_memmap = pci_read_config(dev, APBR_MEMMAP, 1);
185	ofw_pcib_gen_setup(dev);
186
187	if (bootverbose) {
188		device_printf(dev, "  domain            %d\n",
189		    sc->sc_bsc.ops_pcib_sc.domain);
190		device_printf(dev, "  secondary bus     %d\n",
191		    sc->sc_bsc.ops_pcib_sc.secbus);
192		device_printf(dev, "  subordinate bus   %d\n",
193		    sc->sc_bsc.ops_pcib_sc.subbus);
194		device_printf(dev, "  I/O decode        ");
195		apb_map_print(sc->sc_iomap, APB_IO_SCALE);
196		printf("\n");
197		device_printf(dev, "  memory decode     ");
198		apb_map_print(sc->sc_memmap, APB_MEM_SCALE);
199		printf("\n");
200	}
201
202	device_add_child(dev, "pci", -1);
203	return (bus_generic_attach(dev));
204}
205
206/*
207 * We have to trap resource allocation requests and ensure that the bridge
208 * is set up to, or capable of handling them.
209 */
210static struct resource *
211apb_alloc_resource(device_t dev, device_t child, int type, int *rid,
212    u_long start, u_long end, u_long count, u_int flags)
213{
214	struct apb_softc *sc;
215
216	sc = device_get_softc(dev);
217
218	/*
219	 * If this is a "default" allocation against this rid, we can't work
220	 * out where it's coming from (we should actually never see these) so
221	 * we just have to punt.
222	 */
223	if (start == 0 && end == ~0) {
224		device_printf(dev, "can't decode default resource id %d for "
225		    "%s%d, bypassing\n", *rid, device_get_name(child),
226		    device_get_unit(child));
227		goto passup;
228	}
229
230	/*
231	 * Fail the allocation for this range if it's not supported.
232	 * XXX we should probably just fix up the bridge decode and
233	 * soldier on.
234	 */
235	switch (type) {
236	case SYS_RES_IOPORT:
237		if (!apb_checkrange(sc->sc_iomap, APB_IO_SCALE, start, end)) {
238			device_printf(dev, "device %s%d requested unsupported "
239			    "I/O range 0x%lx-0x%lx\n", device_get_name(child),
240			    device_get_unit(child), start, end);
241			return (NULL);
242		}
243		if (bootverbose)
244			device_printf(sc->sc_bsc.ops_pcib_sc.dev, "device "
245			    "%s%d requested decoded I/O range 0x%lx-0x%lx\n",
246			    device_get_name(child), device_get_unit(child),
247			    start, end);
248		break;
249
250	case SYS_RES_MEMORY:
251		if (!apb_checkrange(sc->sc_memmap, APB_MEM_SCALE, start, end)) {
252			device_printf(dev, "device %s%d requested unsupported "
253			    "memory range 0x%lx-0x%lx\n",
254			    device_get_name(child), device_get_unit(child),
255			    start, end);
256			return (NULL);
257		}
258		if (bootverbose)
259			device_printf(sc->sc_bsc.ops_pcib_sc.dev, "device "
260			    "%s%d requested decoded memory range 0x%lx-0x%lx\n",
261			    device_get_name(child), device_get_unit(child),
262			    start, end);
263		break;
264
265	default:
266		break;
267	}
268
269 passup:
270	/*
271	 * Bridge is OK decoding this resource, so pass it up.
272	 */
273	return (bus_generic_alloc_resource(dev, child, type, rid, start, end,
274	    count, flags));
275}
276