isa.c revision 116448 
1/*-
2 * Copyright (c) 1998 Doug Rabson
3 * Copyright (c) 2001 Thomas Moestl <tmm@FreeBSD.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 *	from: FreeBSD: src/sys/alpha/isa/isa.c,v 1.26 2001/07/11
28 *
29 * $FreeBSD: head/sys/sparc64/isa/isa.c 116448 2003-06-16 19:06:36Z jmg $
30 */
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/kernel.h>
35#include <sys/module.h>
36#include <sys/bus.h>
37#include <machine/bus.h>
38#include <sys/malloc.h>
39#include <sys/proc.h>
40#include <sys/rman.h>
41#include <sys/interrupt.h>
42
43#include <isa/isareg.h>
44#include <isa/isavar.h>
45#include <isa/isa_common.h>
46
47#include <pci/pcireg.h>
48#include <pci/pcivar.h>
49
50#include <ofw/ofw_pci.h>
51#include <ofw/openfirm.h>
52
53#include <machine/intr_machdep.h>
54#include <machine/ofw_bus.h>
55#include <machine/resource.h>
56
57#include <sparc64/pci/ofw_pci.h>
58#include <sparc64/isa/ofw_isa.h>
59
60#include "sparcbus_if.h"
61
62/* There can be only one ISA bus, so it is safe to use globals. */
63bus_space_tag_t isa_io_bt = NULL;
64bus_space_handle_t isa_io_hdl;
65bus_space_tag_t isa_mem_bt = NULL;
66bus_space_handle_t isa_mem_hdl;
67
68u_int64_t isa_io_base;
69u_int64_t isa_io_limit;
70u_int64_t isa_mem_base;
71u_int64_t isa_mem_limit;
72
73device_t isa_bus_device;
74
75static phandle_t isab_node;
76static u_int32_t isa_ino[8];
77
78/*
79 * XXX: This is really partly partly PCI-specific, but unfortunately is
80 * differently enough to have to duplicate it here...
81 */
82#define	ISAB_RANGE_PHYS(r)						\
83	(((u_int64_t)(r)->phys_mid << 32) | (u_int64_t)(r)->phys_lo)
84#define	ISAB_RANGE_SPACE(r)	(((r)->phys_hi >> 24) & 0x03)
85
86#define	ISAR_SPACE_IO		0x01
87#define	ISAR_SPACE_MEM		0x02
88
89#define INRANGE(x, start, end)	((x) >= (start) && (x) <= (end))
90
91static int isa_route_intr_res(device_t, u_long, u_long);
92
93intrmask_t
94isa_irq_pending(void)
95{
96	intrmask_t pending;
97	int i;
98
99	/* XXX: Is this correct? */
100	for (i = 7, pending = 0; i >= 0; i--) {
101		pending <<= 1;
102		if (isa_ino[i] != ORIR_NOTFOUND) {
103			pending |= (SPARCBUS_INTR_PENDING(isa_bus_device,
104			    isa_ino[i]) == 0) ? 0 : 1;
105		}
106	}
107	return (pending);
108}
109
110void
111isa_init(device_t dev)
112{
113	device_t bridge;
114	phandle_t node;
115	u_int32_t ino;
116	struct isa_ranges *br;
117	int nbr, i;
118
119	/* The parent of the bus must be a PCI-ISA bridge. */
120	bridge = device_get_parent(dev);
121	isab_node = ofw_pci_node(bridge);
122	nbr = OF_getprop_alloc(isab_node, "ranges", sizeof(*br), (void **)&br);
123	if (nbr <= 0)
124		panic("isa_init: cannot get bridge range property");
125	/*
126	 * This is really a bad kluge; however, it is needed to provide
127	 * isa_irq_pending().
128	 */
129	for (i = 0; i < 8; i++)
130		isa_ino[i] = ORIR_NOTFOUND;
131	for (node = OF_child(isab_node); node != 0; node = OF_peer(node)) {
132		if (OF_getprop(node, "interrupts", &ino, sizeof(ino)) == -1)
133			continue;
134		if (ino > 7)
135			panic("isa_init: XXX: ino too large");
136		isa_ino[ino] = ofw_bus_route_intr(node, ino,
137		    ofw_pci_orb_callback, dev);
138	}
139
140	for (nbr -= 1; nbr >= 0; nbr--) {
141		switch(ISAB_RANGE_SPACE(br + nbr)) {
142		case ISAR_SPACE_IO:
143			/* This is probably always 0. */
144			isa_io_base = ISAB_RANGE_PHYS(&br[nbr]);
145			isa_io_limit = br[nbr].size;
146			isa_io_hdl = SPARCBUS_GET_BUS_HANDLE(bridge, SBBT_IO,
147			    isa_io_base, &isa_io_bt);
148			break;
149		case ISAR_SPACE_MEM:
150			/* This is probably always 0. */
151			isa_mem_base = ISAB_RANGE_PHYS(&br[nbr]);
152			isa_mem_limit = br[nbr].size;
153			isa_mem_hdl = SPARCBUS_GET_BUS_HANDLE(bridge, SBBT_MEM,
154			    isa_mem_base, &isa_mem_bt);
155			break;
156		}
157	}
158	free(br, M_OFWPROP);
159}
160
161static int
162isa_route_intr_res(device_t bus, u_long start, u_long end)
163{
164	int res;
165
166	if (start != end) {
167		panic("isa_route_intr_res: allocation of interrupt range not "
168		    "supported (0x%lx - 0x%lx)", start, end);
169	}
170	if (start > 7)
171		panic("isa_route_intr_res: start out of isa range");
172	res = isa_ino[start];
173	if (res == ORIR_NOTFOUND)
174		device_printf(bus, "could not map interrupt %d\n", res);
175	return (res);
176}
177
178struct resource *
179isa_alloc_resource(device_t bus, device_t child, int type, int *rid,
180		   u_long start, u_long end, u_long count, u_int flags)
181{
182	/*
183	 * Consider adding a resource definition. We allow rid 0-1 for
184	 * irq and drq, 0-3 for memory and 0-7 for ports which is
185	 * sufficient for isapnp.
186	 */
187	int passthrough = (device_get_parent(child) != bus);
188	int isdefault = (start == 0UL && end == ~0UL);
189	struct isa_device* idev = DEVTOISA(child);
190	struct resource_list *rl = &idev->id_resources;
191	struct resource_list_entry *rle;
192	u_long base, limit;
193
194	if (!passthrough && !isdefault) {
195		rle = resource_list_find(rl, type, *rid);
196		if (!rle) {
197			if (*rid < 0)
198				return 0;
199			switch (type) {
200			case SYS_RES_IRQ:
201				if (*rid >= ISA_NIRQ)
202					return 0;
203				break;
204			case SYS_RES_DRQ:
205				if (*rid >= ISA_NDRQ)
206					return 0;
207				break;
208			case SYS_RES_MEMORY:
209				if (*rid >= ISA_NMEM)
210					return 0;
211				break;
212			case SYS_RES_IOPORT:
213				if (*rid >= ISA_NPORT)
214					return 0;
215				break;
216			default:
217				return 0;
218			}
219			resource_list_add(rl, type, *rid, start, end, count);
220		}
221	}
222
223	/*
224	 * Add the base, change default allocations to be between base and
225	 * limit, and reject allocations if a resource type is not enabled.
226	 */
227	base = limit = 0;
228	switch(type) {
229	case SYS_RES_MEMORY:
230		if (isa_mem_bt == NULL)
231			return (NULL);
232		base = isa_mem_base;
233		limit = base + isa_mem_limit;
234		break;
235	case SYS_RES_IOPORT:
236		if (isa_io_bt == NULL)
237			return (NULL);
238		base = isa_io_base;
239		limit = base + isa_io_limit;
240		break;
241	case SYS_RES_IRQ:
242		if (isdefault && passthrough)
243			panic("isa_alloc_resource: cannot pass through default "
244			    "irq allocation");
245		if (!isdefault) {
246			start = end = isa_route_intr_res(bus, start, end);
247			if (start == 255)
248				return (NULL);
249		}
250		break;
251	default:
252		panic("isa_alloc_resource: unsupported resource type %d", type);
253	}
254	if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
255		start = ulmin(start + base, limit);
256		end = ulmin(end + base, limit);
257	}
258
259	/*
260	 * This inlines a modified resource_list_alloc(); this is needed
261	 * because the resources need to have offsets added to them, which
262	 * cannot be done beforehand without patching the resource list entries
263	 * (which is ugly).
264	 */
265	if (passthrough) {
266		return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
267		    type, rid, start, end, count, flags));
268	}
269
270	rle = resource_list_find(rl, type, *rid);
271	if (rle == NULL)
272		return (NULL);		/* no resource of that type/rid */
273
274	if (rle->res != NULL)
275		panic("isa_alloc_resource: resource entry is busy");
276
277	if (isdefault) {
278		start = rle->start;
279		count = ulmax(count, rle->count);
280		end = ulmax(rle->end, start + count - 1);
281		switch (type) {
282		case SYS_RES_MEMORY:
283		case SYS_RES_IOPORT:
284			start += base;
285			end += base;
286			if (!INRANGE(start, base, limit) ||
287			    !INRANGE(end, base, limit))
288				return (NULL);
289			break;
290		case SYS_RES_IRQ:
291			start = end = isa_route_intr_res(bus, start, end);
292			if (start == 255)
293				return (NULL);
294			break;
295		}
296	}
297
298	rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
299	    type, rid, start, end, count, flags);
300
301	/*
302	 * Record the new range.
303	 */
304	if (rle->res != NULL) {
305		rle->start = rman_get_start(rle->res) - base;
306		rle->end = rman_get_end(rle->res) - base;
307		rle->count = count;
308	}
309
310	return (rle->res);
311}
312
313int
314isa_release_resource(device_t bus, device_t child, int type, int rid,
315		     struct resource *res)
316{
317	struct isa_device* idev = DEVTOISA(child);
318	struct resource_list *rl = &idev->id_resources;
319
320	return (resource_list_release(rl, bus, child, type, rid, res));
321}
322
323int
324isa_setup_intr(device_t dev, device_t child,
325	       struct resource *irq, int flags,
326	       driver_intr_t *intr, void *arg, void **cookiep)
327{
328
329	/*
330	 * Just pass through. This is going to be handled by either one of
331	 * the parent PCI buses or the nexus device.
332	 * The interrupt was routed at allocation time.
333	 */
334	return (BUS_SETUP_INTR(device_get_parent(dev), child, irq, flags, intr,
335	    arg, cookiep));
336}
337
338int
339isa_teardown_intr(device_t dev, device_t child,
340		  struct resource *irq, void *cookie)
341{
342
343	return (BUS_TEARDOWN_INTR(device_get_parent(dev), child, irq, cookie));
344}
345