ofwbus.c revision 99652
1/*
2 * Copyright 1998 Massachusetts Institute of Technology
3 *
4 * Permission to use, copy, modify, and distribute this software and
5 * its documentation for any purpose and without fee is hereby
6 * granted, provided that both the above copyright notice and this
7 * permission notice appear in all copies, that both the above
8 * copyright notice and this permission notice appear in all
9 * supporting documentation, and that the name of M.I.T. not be used
10 * in advertising or publicity pertaining to distribution of the
11 * software without specific, written prior permission.  M.I.T. makes
12 * no representations about the suitability of this software for any
13 * purpose.  It is provided "as is" without express or implied
14 * warranty.
15 *
16 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
17 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29/*-
30 * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>.  All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 *    notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 *    notice, this list of conditions and the following disclaimer in the
39 *    documentation and/or other materials provided with the distribution.
40 *
41 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
52 *
53 * 	from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09
54 *
55 * $FreeBSD: head/sys/powerpc/aim/nexus.c 99652 2002-07-09 11:13:33Z benno $
56 */
57
58#include <sys/param.h>
59#include <sys/systm.h>
60#include <sys/bus.h>
61#include <sys/cons.h>
62#include <sys/kernel.h>
63#include <sys/malloc.h>
64
65#include <dev/ofw/openfirm.h>
66
67#include <machine/bus.h>
68#include <machine/frame.h>
69#include <machine/intr_machdep.h>
70#include <machine/nexusvar.h>
71#include <machine/resource.h>
72
73#include <sys/rman.h>
74
75#include "pic_if.h"
76
77/*
78 * The nexus (which is a pseudo-bus actually) iterates over the nodes that
79 * exist in OpenFirmware and adds them as devices to this bus so that drivers
80 * can be attached to them.
81 *
82 * Maybe this code should get into dev/ofw to some extent, as some of it should
83 * work for all OpenFirmware based machines...
84 */
85
86static MALLOC_DEFINE(M_NEXUS, "nexus", "nexus device information");
87
88struct nexus_devinfo {
89	phandle_t	ndi_node;
90	/* Some common properties. */
91	char		*ndi_name;
92	char		*ndi_device_type;
93	char		*ndi_compatible;
94};
95
96struct nexus_softc {
97	device_t	sc_pic;
98};
99
100/*
101 * Device interface
102 */
103static int	nexus_probe(device_t);
104static void	nexus_probe_nomatch(device_t, device_t);
105
106/*
107 * Bus interface
108 */
109static int	nexus_read_ivar(device_t, device_t, int, uintptr_t *);
110static int	nexus_write_ivar(device_t, device_t, int, uintptr_t);
111static int	nexus_setup_intr(device_t, device_t, struct resource *, int,
112		    driver_intr_t *, void *, void **);
113static int	nexus_teardown_intr(device_t, device_t, struct resource *,
114		    void *);
115static struct	resource *nexus_alloc_resource(device_t, device_t, int, int *,
116		    u_long, u_long, u_long, u_int);
117static int	nexus_activate_resource(device_t, device_t, int, int,
118		    struct resource *);
119static int	nexus_deactivate_resource(device_t, device_t, int, int,
120		    struct resource *);
121static int	nexus_release_resource(device_t, device_t, int, int,
122		    struct resource *);
123
124/*
125 * Local routines
126 */
127static device_t	create_device_from_node(device_t, phandle_t);
128
129static device_method_t nexus_methods[] = {
130	/* Device interface */
131	DEVMETHOD(device_probe,		nexus_probe),
132	DEVMETHOD(device_attach,	bus_generic_attach),
133	DEVMETHOD(device_detach,	bus_generic_detach),
134	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
135	DEVMETHOD(device_suspend,	bus_generic_suspend),
136	DEVMETHOD(device_resume,	bus_generic_resume),
137
138	/* Bus interface. Resource management is business of the children... */
139	DEVMETHOD(bus_print_child,	bus_generic_print_child),
140	DEVMETHOD(bus_probe_nomatch,	nexus_probe_nomatch),
141	DEVMETHOD(bus_read_ivar,	nexus_read_ivar),
142	DEVMETHOD(bus_write_ivar,	nexus_write_ivar),
143	DEVMETHOD(bus_setup_intr,	nexus_setup_intr),
144	DEVMETHOD(bus_teardown_intr,	nexus_teardown_intr),
145	DEVMETHOD(bus_alloc_resource,	nexus_alloc_resource),
146	DEVMETHOD(bus_activate_resource,	nexus_activate_resource),
147	DEVMETHOD(bus_deactivate_resource,	nexus_deactivate_resource),
148	DEVMETHOD(bus_release_resource,	nexus_release_resource),
149
150	{ 0, 0 }
151};
152
153static driver_t nexus_driver = {
154	"nexus",
155	nexus_methods,
156	sizeof(struct nexus_softc),
157};
158
159static devclass_t nexus_devclass;
160
161DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
162
163static int
164nexus_probe(device_t dev)
165{
166	phandle_t	root;
167	phandle_t	pic, cpus, child, new_node, temp_node;
168	struct		nexus_softc *sc;
169
170	if ((root = OF_peer(0)) == -1)
171		panic("nexus_probe: OF_peer failed.");
172
173	sc = device_get_softc(dev);
174
175	if ((cpus = OF_finddevice("/cpus")) != -1) {
176		for (child = OF_child(cpus); child; child = OF_peer(child))
177			(void)create_device_from_node(dev, child);
178	}
179
180	if ((child = OF_finddevice("/chosen")) == -1)
181		printf("nexus_probe: can't find /chosen");
182
183	if (OF_getprop(child, "interrupt-controller", &pic, 4) != 4)
184		printf("nexus_probe: can't get interrupt-controller");
185
186	sc->sc_pic = create_device_from_node(dev, pic);
187
188	if (sc->sc_pic == NULL)
189		printf("nexus_probe: failed to create PIC device");
190
191	child = root;
192	while (child != 0) {
193		if (child != pic)
194			(void)create_device_from_node(dev, child);
195
196		if (child == cpus)
197			new_node = 0;
198		else
199			new_node = OF_child(child);
200		if (new_node == -1)
201			panic("nexus_probe: OF_child returned -1");
202		if (new_node == 0)
203			new_node = OF_peer(child);
204		if (new_node == 0) {
205			temp_node = child;
206			while (new_node == 0) {
207				temp_node = OF_parent(temp_node);
208				if (temp_node == 0)
209					break;
210				new_node = OF_peer(temp_node);
211			}
212		}
213		child = new_node;
214	}
215	device_set_desc(dev, "OpenFirmware Nexus device");
216
217	{
218		u_int	*foo = 0xf8000020;
219		pmap_kenter(0xf8000000, 0xf8000000);
220		printf(">>> uni_n_clock_ctl = %08x\n", *foo);
221		pmap_kremove(0xf8000000);
222	}
223	return (0);
224}
225
226static void
227nexus_probe_nomatch(device_t dev, device_t child)
228{
229	char	*name, *type;
230
231	if (BUS_READ_IVAR(dev, child, NEXUS_IVAR_NAME,
232	    (uintptr_t *)&name) != 0 ||
233	    BUS_READ_IVAR(dev, child, NEXUS_IVAR_DEVICE_TYPE,
234	    (uintptr_t *)&type) != 0)
235		return;
236
237	if (type == NULL)
238		type = "(unknown)";
239#if 0
240	device_printf(dev, "<%s>, type %s (no driver attached)\n",
241	    name, type);
242#endif
243}
244
245static int
246nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
247{
248	struct nexus_devinfo *dinfo;
249
250	if ((dinfo = device_get_ivars(child)) == 0)
251		return (ENOENT);
252	switch (which) {
253	case NEXUS_IVAR_NODE:
254		*result = dinfo->ndi_node;
255		break;
256	case NEXUS_IVAR_NAME:
257		*result = (uintptr_t)dinfo->ndi_name;
258		break;
259	case NEXUS_IVAR_DEVICE_TYPE:
260		*result = (uintptr_t)dinfo->ndi_device_type;
261		break;
262	case NEXUS_IVAR_COMPATIBLE:
263		*result = (uintptr_t)dinfo->ndi_compatible;
264		break;
265	default:
266		return (ENOENT);
267	}
268	return 0;
269}
270
271static int
272nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
273{
274	struct nexus_devinfo *dinfo;
275
276	if ((dinfo = device_get_ivars(child)) == 0)
277		return (ENOENT);
278
279	switch (which) {
280	case NEXUS_IVAR_NODE:
281	case NEXUS_IVAR_NAME:
282	case NEXUS_IVAR_DEVICE_TYPE:
283		return (EINVAL);
284	default:
285		return (ENOENT);
286	}
287	return 0;
288}
289
290static int
291nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
292    driver_intr_t *intr, void *arg, void **cookiep)
293{
294	struct	nexus_softc *sc;
295
296	sc = device_get_softc(dev);
297
298	if (device_get_state(sc->sc_pic) != DS_ATTACHED)
299		panic("nexus_setup_intr: no pic attached\n");
300
301	return (PIC_SETUP_INTR(sc->sc_pic, child, res, flags, intr, arg,
302	    cookiep));
303}
304
305static int
306nexus_teardown_intr(device_t dev, device_t child, struct resource *res,
307    void *ih)
308{
309	struct	nexus_softc *sc;
310
311	sc = device_get_softc(dev);
312
313	if (device_get_state(sc->sc_pic) != DS_ATTACHED)
314		panic("nexus_teardown_intr: no pic attached\n");
315
316	return (PIC_TEARDOWN_INTR(sc->sc_pic, child, res, ih));
317}
318
319/*
320 * Allocate resources at the behest of a child.  This only handles interrupts,
321 * since I/O resources are handled by child busses.
322 */
323static struct resource *
324nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
325    u_long start, u_long end, u_long count, u_int flags)
326{
327	struct	nexus_softc *sc;
328	struct	resource *rv;
329
330	sc = device_get_softc(bus);
331
332	if (type != SYS_RES_IRQ) {
333		device_printf(bus, "unknown resource request from %s\n",
334		    device_get_nameunit(child));
335		return (NULL);
336	}
337
338	if (device_get_state(sc->sc_pic) != DS_ATTACHED)
339		panic("nexus_alloc_resource: no pic attached\n");
340
341	rv = PIC_ALLOCATE_INTR(sc->sc_pic, child, rid, start, flags);
342
343	return (rv);
344}
345
346static int
347nexus_activate_resource(device_t bus, device_t child, int type, int rid,
348    struct resource *res)
349{
350
351	/* Not much to be done yet... */
352	return (rman_activate_resource(res));
353}
354
355static int
356nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
357    struct resource *res)
358{
359
360	/* Not much to be done yet... */
361	return (rman_deactivate_resource(res));
362}
363
364static int
365nexus_release_resource(device_t bus, device_t child, int type, int rid,
366    struct resource *res)
367{
368	struct	nexus_softc *sc;
369
370	sc = device_get_softc(bus);
371
372	if (type != SYS_RES_IRQ) {
373		device_printf(bus, "unknown resource request from %s\n",
374		    device_get_nameunit(child));
375		return (NULL);
376	}
377
378	if (device_get_state(sc->sc_pic) != DS_ATTACHED)
379		panic("nexus_release_resource: no pic attached\n");
380
381	return (PIC_RELEASE_INTR(sc->sc_pic, child, rid, res));
382}
383
384static device_t
385create_device_from_node(device_t parent, phandle_t node)
386{
387	device_t	cdev;
388	struct		nexus_devinfo *dinfo;
389	char		*name, *type, *compatible;
390
391	OF_getprop_alloc(node, "name", 1, (void **)&name);
392	OF_getprop_alloc(node, "device_type", 1, (void **)&type);
393	OF_getprop_alloc(node, "compatible", 1, (void **)&compatible);
394	cdev = device_add_child(parent, NULL, -1);
395	if (cdev != NULL) {
396		dinfo = malloc(sizeof(*dinfo), M_NEXUS, M_WAITOK);
397		dinfo->ndi_node = node;
398		dinfo->ndi_name = name;
399		dinfo->ndi_device_type = type;
400		dinfo->ndi_compatible = compatible;
401		device_set_ivars(cdev, dinfo);
402	} else
403		free(name, M_OFWPROP);
404
405	return (cdev);
406}
407