apb.c revision 191079 
1/*-
2 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
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 unmodified, this list of conditions, and the following
10 *    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
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD$");
30
31#include <sys/param.h>
32#include <sys/systm.h>
33#include <sys/bus.h>
34#include <sys/interrupt.h>
35#include <sys/kernel.h>
36#include <sys/module.h>
37#include <sys/rman.h>
38#include <sys/malloc.h>
39
40#include <machine/bus.h>
41
42#include <mips/atheros/apbvar.h>
43#include <mips/atheros/ar71xxreg.h>
44
45#undef APB_DEBUG
46#ifdef APB_DEBUG
47#define dprintf printf
48#else
49#define dprintf(x, arg...)
50#endif  /* APB_DEBUG */
51
52static int	apb_activate_resource(device_t, device_t, int, int,
53		    struct resource *);
54static device_t	apb_add_child(device_t, int, const char *, int);
55static struct resource *
56		apb_alloc_resource(device_t, device_t, int, int *, u_long,
57		    u_long, u_long, u_int);
58static int	apb_attach(device_t);
59static int	apb_deactivate_resource(device_t, device_t, int, int,
60		    struct resource *);
61static struct resource_list *
62		apb_get_resource_list(device_t, device_t);
63static void	apb_hinted_child(device_t, const char *, int);
64static int	apb_intr(void *);
65static int	apb_probe(device_t);
66static int	apb_release_resource(device_t, device_t, int, int,
67		    struct resource *);
68static int	apb_setup_intr(device_t, device_t, struct resource *, int,
69		    driver_filter_t *, driver_intr_t *, void *, void **);
70static int	apb_teardown_intr(device_t, device_t, struct resource *,
71		    void *);
72
73static void apb_mask_irq(unsigned int irq)
74{
75	uint32_t reg;
76
77	reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK);
78	ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg & ~(1 << irq));
79
80}
81
82static void apb_unmask_irq(unsigned int irq)
83{
84	uint32_t reg;
85
86	reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK);
87	ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg | (1 << irq));
88}
89
90static int
91apb_probe(device_t dev)
92{
93
94	return (0);
95}
96
97static int
98apb_attach(device_t dev)
99{
100	struct apb_softc *sc = device_get_softc(dev);
101	int rid = 0;
102
103	device_set_desc(dev, "APB Bus bridge");
104	sc->apb_irq_rman.rm_type = RMAN_ARRAY;
105	sc->apb_irq_rman.rm_descr = "APB IRQ";
106
107	if (rman_init(&sc->apb_irq_rman) != 0 ||
108	    rman_manage_region(&sc->apb_irq_rman,
109			APB_IRQ_BASE, APB_IRQ_END) != 0)
110		panic("apb_attach: failed to set up IRQ rman");
111
112	if ((sc->sc_misc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
113	    RF_SHAREABLE | RF_ACTIVE)) == NULL) {
114		device_printf(dev, "unable to allocate IRQ resource\n");
115		return (ENXIO);
116	}
117
118	if ((bus_setup_intr(dev, sc->sc_misc_irq, INTR_TYPE_MISC,
119	    apb_intr, NULL, sc, &sc->sc_misc_ih))) {
120		device_printf(dev,
121		    "WARNING: unable to register interrupt handler\n");
122		return (ENXIO);
123	}
124
125	bus_generic_probe(dev);
126	bus_enumerate_hinted_children(dev);
127	bus_generic_attach(dev);
128
129	return (0);
130}
131
132static struct resource *
133apb_alloc_resource(device_t bus, device_t child, int type, int *rid,
134    u_long start, u_long end, u_long count, u_int flags)
135{
136	struct apb_softc		*sc = device_get_softc(bus);
137	struct apb_ivar			*ivar = device_get_ivars(child);
138	struct resource			*rv;
139	struct resource_list_entry	*rle;
140	struct rman			*rm;
141	int				 isdefault, needactivate, passthrough;
142
143	isdefault = (start == 0UL && end == ~0UL);
144	needactivate = flags & RF_ACTIVE;
145	/*
146	 * Pass memory requests to nexus device
147	 */
148	passthrough = (device_get_parent(child) != bus) ||
149		(type == SYS_RES_MEMORY);
150	rle = NULL;
151
152	dprintf("%s: entry (%p, %p, %d, %p, %p, %p, %ld, %d)\n",
153	    __func__, bus, child, type, rid, (void *)(intptr_t)start,
154	    (void *)(intptr_t)end, count, flags);
155
156	if (passthrough)
157		return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type,
158		    rid, start, end, count, flags));
159
160	/*
161	 * If this is an allocation of the "default" range for a given RID,
162	 * and we know what the resources for this device are (ie. they aren't
163	 * maintained by a child bus), then work out the start/end values.
164	 */
165
166	if (isdefault) {
167		rle = resource_list_find(&ivar->resources, type, *rid);
168		if (rle == NULL) {
169			return (NULL);
170		}
171
172		if (rle->res != NULL) {
173			panic("%s: resource entry is busy", __func__);
174		}
175		start = rle->start;
176		end = rle->end;
177		count = rle->count;
178
179		dprintf("%s: default resource (%p, %p, %ld)\n",
180		    __func__, (void *)(intptr_t)start,
181		    (void *)(intptr_t)end, count);
182	}
183
184	switch (type) {
185	case SYS_RES_IRQ:
186		rm = &sc->apb_irq_rman;
187		break;
188	default:
189		printf("%s: unknown resource type %d\n", __func__, type);
190		return (0);
191	}
192
193	rv = rman_reserve_resource(rm, start, end, count, flags, child);
194	if (rv == 0) {
195		printf("%s: could not reserve resource\n", __func__);
196		return (0);
197	}
198
199	rman_set_rid(rv, *rid);
200
201	if (needactivate) {
202		if (bus_activate_resource(child, type, *rid, rv)) {
203			printf("%s: could not activate resource\n", __func__);
204			rman_release_resource(rv);
205			return (0);
206		}
207	}
208
209	return (rv);
210}
211
212static int
213apb_activate_resource(device_t bus, device_t child, int type, int rid,
214    struct resource *r)
215{
216
217	/* XXX: should we mask/unmask IRQ here? */
218	return (BUS_ACTIVATE_RESOURCE(device_get_parent(bus), child,
219		type, rid, r));
220}
221
222static int
223apb_deactivate_resource(device_t bus, device_t child, int type, int rid,
224    struct resource *r)
225{
226
227	/* XXX: should we mask/unmask IRQ here? */
228	return (BUS_DEACTIVATE_RESOURCE(device_get_parent(bus), child,
229		type, rid, r));
230}
231
232static int
233apb_release_resource(device_t dev, device_t child, int type,
234    int rid, struct resource *r)
235{
236	struct resource_list *rl;
237	struct resource_list_entry *rle;
238
239	rl = apb_get_resource_list(dev, child);
240	if (rl == NULL)
241		return (EINVAL);
242	rle = resource_list_find(rl, type, rid);
243	if (rle == NULL)
244		return (EINVAL);
245	rman_release_resource(r);
246	rle->res = NULL;
247
248	return (0);
249}
250
251static int
252apb_setup_intr(device_t bus, device_t child, struct resource *ires,
253		int flags, driver_filter_t *filt, driver_intr_t *handler,
254		void *arg, void **cookiep)
255{
256	struct apb_softc *sc = device_get_softc(bus);
257	struct intr_event *event;
258	int irq, error;
259
260	irq = rman_get_start(ires);
261
262	if (irq > APB_IRQ_END)
263		panic("%s: bad irq %d", __func__, irq);
264
265	event = sc->sc_eventstab[irq];
266	if (event == NULL) {
267		error = intr_event_create(&event, (void *)irq, 0, irq,
268		    (mask_fn)apb_mask_irq, (mask_fn)apb_unmask_irq,
269		    NULL, NULL,
270		    "apb intr%d:", irq);
271
272		sc->sc_eventstab[irq] = event;
273	}
274
275	intr_event_add_handler(event, device_get_nameunit(child), filt,
276	    handler, arg, intr_priority(flags), flags, cookiep);
277
278	return (0);
279}
280
281static int
282apb_teardown_intr(device_t dev, device_t child, struct resource *ires,
283    void *cookie)
284{
285	struct apb_softc *sc = device_get_softc(dev);
286	int irq, result;
287
288	irq = rman_get_start(ires);
289	if (irq > APB_IRQ_END)
290		panic("%s: bad irq %d", __func__, irq);
291
292	if (sc->sc_eventstab[irq] == NULL)
293		panic("Trying to teardown unoccupied IRQ");
294
295	apb_mask_irq(irq);
296
297	result = intr_event_remove_handler(cookie);
298	if (!result)
299		sc->sc_eventstab[irq] = NULL;
300
301	return (result);
302}
303
304static int
305apb_intr(void *arg)
306{
307	struct apb_softc *sc = arg;
308	struct intr_event *event;
309	uint32_t reg, irq;
310
311	reg = ATH_READ_REG(AR71XX_MISC_INTR_STATUS);
312	for (irq = 0; irq < APB_NIRQS; irq++) {
313		if (reg & (1 << irq)) {
314			event = sc->sc_eventstab[irq];
315			if (!event || TAILQ_EMPTY(&event->ie_handlers)) {
316				printf("Stray IRQ %d\n", irq);
317				continue;
318			}
319
320			/* TODO: frame instead of NULL? */
321			intr_event_handle(event, NULL);
322		}
323	}
324
325	return (FILTER_HANDLED);
326}
327
328static void
329apb_hinted_child(device_t bus, const char *dname, int dunit)
330{
331	device_t		child;
332	long			maddr;
333	int			msize;
334	int			irq;
335	int			result;
336	int			mem_hints_count;
337
338	child = BUS_ADD_CHILD(bus, 0, dname, dunit);
339
340	/*
341	 * Set hard-wired resources for hinted child using
342	 * specific RIDs.
343	 */
344	mem_hints_count = 0;
345	if (resource_long_value(dname, dunit, "maddr", &maddr) == 0)
346		mem_hints_count++;
347	if (resource_int_value(dname, dunit, "msize", &msize) == 0)
348		mem_hints_count++;
349
350	/* check if all info for mem resource has been provided */
351	if ((mem_hints_count > 0) && (mem_hints_count < 2)) {
352		printf("Either maddr or msize hint is missing for %s%d\n",
353		    dname, dunit);
354	} else if (mem_hints_count) {
355		result = bus_set_resource(child, SYS_RES_MEMORY, 0,
356		    maddr, msize);
357		if (result != 0)
358			device_printf(bus,
359			    "warning: bus_set_resource() failed\n");
360	}
361
362	if (resource_int_value(dname, dunit, "irq", &irq) == 0) {
363		result = bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
364		if (result != 0)
365			device_printf(bus,
366			    "warning: bus_set_resource() failed\n");
367	}
368}
369
370static device_t
371apb_add_child(device_t bus, int order, const char *name, int unit)
372{
373	device_t		child;
374	struct apb_ivar	*ivar;
375
376	ivar = malloc(sizeof(struct apb_ivar), M_DEVBUF, M_WAITOK | M_ZERO);
377	if (ivar == NULL) {
378		printf("Failed to allocate ivar\n");
379		return (0);
380	}
381	resource_list_init(&ivar->resources);
382
383	child = device_add_child_ordered(bus, order, name, unit);
384	if (child == NULL) {
385		printf("Can't add child %s%d ordered\n", name, unit);
386		return (0);
387	}
388
389	device_set_ivars(child, ivar);
390
391	return (child);
392}
393
394/*
395 * Helper routine for bus_generic_rl_get_resource/bus_generic_rl_set_resource
396 * Provides pointer to resource_list for these routines
397 */
398static struct resource_list *
399apb_get_resource_list(device_t dev, device_t child)
400{
401	struct apb_ivar *ivar;
402
403	ivar = device_get_ivars(child);
404	return (&(ivar->resources));
405}
406
407static device_method_t apb_methods[] = {
408	DEVMETHOD(bus_activate_resource,	apb_activate_resource),
409	DEVMETHOD(bus_add_child,		apb_add_child),
410	DEVMETHOD(bus_alloc_resource,		apb_alloc_resource),
411	DEVMETHOD(bus_deactivate_resource,	apb_deactivate_resource),
412	DEVMETHOD(bus_get_resource_list,	apb_get_resource_list),
413	DEVMETHOD(bus_hinted_child,		apb_hinted_child),
414	DEVMETHOD(bus_print_child,		bus_generic_print_child),
415	DEVMETHOD(bus_release_resource,		apb_release_resource),
416	DEVMETHOD(bus_setup_intr,		apb_setup_intr),
417	DEVMETHOD(bus_teardown_intr,		apb_teardown_intr),
418	DEVMETHOD(device_attach,		apb_attach),
419	DEVMETHOD(device_probe,			apb_probe),
420	DEVMETHOD(bus_get_resource,		bus_generic_rl_get_resource),
421	DEVMETHOD(bus_set_resource,		bus_generic_rl_set_resource),
422
423	{0, 0},
424};
425
426static driver_t apb_driver = {
427	"apb",
428	apb_methods,
429	sizeof(struct apb_softc),
430};
431static devclass_t apb_devclass;
432
433DRIVER_MODULE(apb, nexus, apb_driver, apb_devclass, 0, 0);
434