at91.c revision 266277 
1/*-
2 * Copyright (c) 2005 Olivier Houchard.  All rights reserved.
3 * Copyright (c) 2010 Greg Ansley.  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 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 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 "opt_platform.h"
28
29#include <sys/cdefs.h>
30__FBSDID("$FreeBSD: stable/10/sys/arm/at91/at91.c 266277 2014-05-17 00:53:12Z ian $");
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/bus.h>
35#include <sys/kernel.h>
36#include <sys/malloc.h>
37#include <sys/module.h>
38
39#include <vm/vm.h>
40#include <vm/vm_kern.h>
41#include <vm/pmap.h>
42#include <vm/vm_page.h>
43#include <vm/vm_extern.h>
44
45#define	_ARM32_BUS_DMA_PRIVATE
46#include <machine/bus.h>
47#include <machine/devmap.h>
48#include <machine/intr.h>
49
50#include <arm/at91/at91var.h>
51#include <arm/at91/at91_pmcvar.h>
52#include <arm/at91/at91_aicreg.h>
53
54uint32_t at91_master_clock;
55
56static int
57at91_bs_map(void *t, bus_addr_t bpa, bus_size_t size, int flags,
58    bus_space_handle_t *bshp)
59{
60	vm_paddr_t pa, endpa;
61
62	pa = trunc_page(bpa);
63	if (pa >= AT91_PA_BASE + 0xff00000) {
64		*bshp = bpa - AT91_PA_BASE + AT91_BASE;
65		return (0);
66	}
67	if (pa >= AT91_BASE + 0xff00000) {
68		*bshp = bpa;
69		return (0);
70	}
71	endpa = round_page(bpa + size);
72
73	*bshp = (vm_offset_t)pmap_mapdev(pa, endpa - pa) + (bpa - pa);
74
75	return (0);
76}
77
78static void
79at91_bs_unmap(void *t, bus_space_handle_t h, bus_size_t size)
80{
81	vm_offset_t va, endva;
82
83	if (t == 0)
84		return;
85	va = trunc_page((vm_offset_t)t);
86	if (va >= AT91_BASE && va <= AT91_BASE + 0xff00000)
87		return;
88	endva = round_page((vm_offset_t)t + size);
89
90	/* Free the kernel virtual mapping. */
91	kva_free(va, endva - va);
92}
93
94static int
95at91_bs_subregion(void *t, bus_space_handle_t bsh, bus_size_t offset,
96    bus_size_t size, bus_space_handle_t *nbshp)
97{
98
99	*nbshp = bsh + offset;
100	return (0);
101}
102
103static void
104at91_barrier(void *t, bus_space_handle_t bsh, bus_size_t size, bus_size_t b,
105    int a)
106{
107}
108
109struct arm32_dma_range *
110bus_dma_get_range(void)
111{
112
113	return (NULL);
114}
115
116int
117bus_dma_get_range_nb(void)
118{
119	return (0);
120}
121
122bs_protos(generic);
123bs_protos(generic_armv4);
124
125struct bus_space at91_bs_tag = {
126	/* cookie */
127	(void *) 0,
128
129	/* mapping/unmapping */
130	at91_bs_map,
131	at91_bs_unmap,
132	at91_bs_subregion,
133
134	/* allocation/deallocation */
135	NULL,
136	NULL,
137
138	/* barrier */
139	at91_barrier,
140
141	/* read (single) */
142	generic_bs_r_1,
143	generic_armv4_bs_r_2,
144	generic_bs_r_4,
145	NULL,
146
147	/* read multiple */
148	generic_bs_rm_1,
149	generic_armv4_bs_rm_2,
150	generic_bs_rm_4,
151	NULL,
152
153	/* read region */
154	generic_bs_rr_1,
155	generic_armv4_bs_rr_2,
156	generic_bs_rr_4,
157	NULL,
158
159	/* write (single) */
160	generic_bs_w_1,
161	generic_armv4_bs_w_2,
162	generic_bs_w_4,
163	NULL,
164
165	/* write multiple */
166	generic_bs_wm_1,
167	generic_armv4_bs_wm_2,
168	generic_bs_wm_4,
169	NULL,
170
171	/* write region */
172	NULL,
173	generic_armv4_bs_wr_2,
174	generic_bs_wr_4,
175	NULL,
176
177	/* set multiple */
178	NULL,
179	NULL,
180	NULL,
181	NULL,
182
183	/* set region */
184	NULL,
185	generic_armv4_bs_sr_2,
186	generic_bs_sr_4,
187	NULL,
188
189	/* copy */
190	NULL,
191	generic_armv4_bs_c_2,
192	NULL,
193	NULL,
194
195	/* read (single) stream */
196	generic_bs_r_1,
197	generic_armv4_bs_r_2,
198	generic_bs_r_4,
199	NULL,
200
201	/* read multiple stream */
202	generic_bs_rm_1,
203	generic_armv4_bs_rm_2,
204	generic_bs_rm_4,
205	NULL,
206
207	/* read region stream */
208	generic_bs_rr_1,
209	generic_armv4_bs_rr_2,
210	generic_bs_rr_4,
211	NULL,
212
213	/* write (single) stream */
214	generic_bs_w_1,
215	generic_armv4_bs_w_2,
216	generic_bs_w_4,
217	NULL,
218
219	/* write multiple stream */
220	generic_bs_wm_1,
221	generic_armv4_bs_wm_2,
222	generic_bs_wm_4,
223	NULL,
224
225	/* write region stream */
226	NULL,
227	generic_armv4_bs_wr_2,
228	generic_bs_wr_4,
229	NULL,
230};
231
232#ifndef FDT
233
234static struct at91_softc *at91_softc;
235
236static void at91_eoi(void *);
237
238static int
239at91_probe(device_t dev)
240{
241
242	device_set_desc(dev, soc_info.name);
243	return (BUS_PROBE_NOWILDCARD);
244}
245
246static void
247at91_identify(driver_t *drv, device_t parent)
248{
249
250	BUS_ADD_CHILD(parent, 0, "atmelarm", 0);
251}
252
253static void
254at91_cpu_add_builtin_children(device_t dev, const struct cpu_devs *walker)
255{
256	int i;
257
258	for (i = 1; walker->name; i++, walker++) {
259		at91_add_child(dev, i, walker->name, walker->unit,
260		    walker->mem_base, walker->mem_len, walker->irq0,
261		    walker->irq1, walker->irq2);
262	}
263}
264
265static int
266at91_attach(device_t dev)
267{
268	struct at91_softc *sc = device_get_softc(dev);
269
270	arm_post_filter = at91_eoi;
271
272	at91_softc = sc;
273	sc->sc_st = &at91_bs_tag;
274	sc->sc_sh = AT91_BASE;
275	sc->sc_aic_sh = AT91_BASE + AT91_SYS_BASE;
276	sc->dev = dev;
277
278	sc->sc_irq_rman.rm_type = RMAN_ARRAY;
279	sc->sc_irq_rman.rm_descr = "AT91 IRQs";
280	if (rman_init(&sc->sc_irq_rman) != 0 ||
281	    rman_manage_region(&sc->sc_irq_rman, 1, 31) != 0)
282		panic("at91_attach: failed to set up IRQ rman");
283
284	sc->sc_mem_rman.rm_type = RMAN_ARRAY;
285	sc->sc_mem_rman.rm_descr = "AT91 Memory";
286	if (rman_init(&sc->sc_mem_rman) != 0)
287		panic("at91_attach: failed to set up memory rman");
288	/*
289	 * Manage the physical space, defined as being everything that isn't
290	 * DRAM.
291	 */
292	if (rman_manage_region(&sc->sc_mem_rman, 0, PHYSADDR - 1) != 0)
293		panic("at91_attach: failed to set up memory rman");
294	if (rman_manage_region(&sc->sc_mem_rman, PHYSADDR + (256 << 20),
295	    0xfffffffful) != 0)
296		panic("at91_attach: failed to set up memory rman");
297
298        /*
299         * Add this device's children...
300         */
301	at91_cpu_add_builtin_children(dev, soc_info.soc_data->soc_children);
302	soc_info.soc_data->soc_clock_init();
303
304	bus_generic_probe(dev);
305	bus_generic_attach(dev);
306	enable_interrupts(I32_bit | F32_bit);
307	return (0);
308}
309
310static struct resource *
311at91_alloc_resource(device_t dev, device_t child, int type, int *rid,
312    u_long start, u_long end, u_long count, u_int flags)
313{
314	struct at91_softc *sc = device_get_softc(dev);
315	struct resource_list_entry *rle;
316	struct at91_ivar *ivar = device_get_ivars(child);
317	struct resource_list *rl = &ivar->resources;
318	bus_space_handle_t bsh;
319
320	if (device_get_parent(child) != dev)
321		return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
322		    type, rid, start, end, count, flags));
323
324	rle = resource_list_find(rl, type, *rid);
325	if (rle == NULL)
326		return (NULL);
327	if (rle->res)
328		panic("Resource rid %d type %d already in use", *rid, type);
329	if (start == 0UL && end == ~0UL) {
330		start = rle->start;
331		count = ulmax(count, rle->count);
332		end = ulmax(rle->end, start + count - 1);
333	}
334	switch (type)
335	{
336	case SYS_RES_IRQ:
337		rle->res = rman_reserve_resource(&sc->sc_irq_rman,
338		    start, end, count, flags, child);
339		break;
340	case SYS_RES_MEMORY:
341		rle->res = rman_reserve_resource(&sc->sc_mem_rman,
342		    start, end, count, flags, child);
343		if (rle->res != NULL) {
344			bus_space_map(&at91_bs_tag, start,
345			    rman_get_size(rle->res), 0, &bsh);
346			rman_set_bustag(rle->res, &at91_bs_tag);
347			rman_set_bushandle(rle->res, bsh);
348		}
349		break;
350	}
351	if (rle->res) {
352		rle->start = rman_get_start(rle->res);
353		rle->end = rman_get_end(rle->res);
354		rle->count = count;
355		rman_set_rid(rle->res, *rid);
356	}
357	return (rle->res);
358}
359
360static struct resource_list *
361at91_get_resource_list(device_t dev, device_t child)
362{
363	struct at91_ivar *ivar;
364
365	ivar = device_get_ivars(child);
366	return (&(ivar->resources));
367}
368
369static int
370at91_release_resource(device_t dev, device_t child, int type,
371    int rid, struct resource *r)
372{
373	struct resource_list *rl;
374	struct resource_list_entry *rle;
375
376	rl = at91_get_resource_list(dev, child);
377	if (rl == NULL)
378		return (EINVAL);
379	rle = resource_list_find(rl, type, rid);
380	if (rle == NULL)
381		return (EINVAL);
382	rman_release_resource(r);
383	rle->res = NULL;
384	return (0);
385}
386
387static int
388at91_setup_intr(device_t dev, device_t child,
389    struct resource *ires, int flags, driver_filter_t *filt,
390    driver_intr_t *intr, void *arg, void **cookiep)
391{
392	int error;
393
394	if (rman_get_start(ires) == AT91_IRQ_SYSTEM && filt == NULL)
395		panic("All system interrupt ISRs must be FILTER");
396	error = BUS_SETUP_INTR(device_get_parent(dev), child, ires, flags,
397	    filt, intr, arg, cookiep);
398	if (error)
399		return (error);
400
401	return (0);
402}
403
404static int
405at91_teardown_intr(device_t dev, device_t child, struct resource *res,
406    void *cookie)
407{
408	struct at91_softc *sc = device_get_softc(dev);
409
410	bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_IDCR,
411	    1 << rman_get_start(res));
412	return (BUS_TEARDOWN_INTR(device_get_parent(dev), child, res, cookie));
413}
414
415static int
416at91_activate_resource(device_t bus, device_t child, int type, int rid,
417    struct resource *r)
418{
419#if 0
420	u_long p;
421	int error;
422
423	if (type == SYS_RES_MEMORY) {
424		error = bus_space_map(rman_get_bustag(r),
425		    rman_get_bushandle(r), rman_get_size(r), 0, &p);
426		if (error)
427			return (error);
428		rman_set_bushandle(r, p);
429	}
430#endif
431	return (rman_activate_resource(r));
432}
433
434static int
435at91_print_child(device_t dev, device_t child)
436{
437	struct at91_ivar *ivars;
438	struct resource_list *rl;
439	int retval = 0;
440
441	ivars = device_get_ivars(child);
442	rl = &ivars->resources;
443
444	retval += bus_print_child_header(dev, child);
445
446	retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
447	retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
448	retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
449	if (device_get_flags(dev))
450		retval += printf(" flags %#x", device_get_flags(dev));
451
452	retval += bus_print_child_footer(dev, child);
453
454	return (retval);
455}
456
457static void
458at91_eoi(void *unused)
459{
460	bus_space_write_4(at91_softc->sc_st, at91_softc->sc_aic_sh,
461	    IC_EOICR, 0);
462}
463
464void
465at91_add_child(device_t dev, int prio, const char *name, int unit,
466    bus_addr_t addr, bus_size_t size, int irq0, int irq1, int irq2)
467{
468	device_t kid;
469	struct at91_ivar *ivar;
470
471	kid = device_add_child_ordered(dev, prio, name, unit);
472	if (kid == NULL) {
473	    printf("Can't add child %s%d ordered\n", name, unit);
474	    return;
475	}
476	ivar = malloc(sizeof(*ivar), M_DEVBUF, M_NOWAIT | M_ZERO);
477	if (ivar == NULL) {
478		device_delete_child(dev, kid);
479		printf("Can't add alloc ivar\n");
480		return;
481	}
482	device_set_ivars(kid, ivar);
483	resource_list_init(&ivar->resources);
484	if (irq0 != -1) {
485		bus_set_resource(kid, SYS_RES_IRQ, 0, irq0, 1);
486		if (irq0 != AT91_IRQ_SYSTEM)
487			at91_pmc_clock_add(device_get_nameunit(kid), irq0, 0);
488	}
489	if (irq1 != 0)
490		bus_set_resource(kid, SYS_RES_IRQ, 1, irq1, 1);
491	if (irq2 != 0)
492		bus_set_resource(kid, SYS_RES_IRQ, 2, irq2, 1);
493	/*
494	 * Special case for on-board devices. These have their address
495	 * defined relative to AT91_PA_BASE in all the register files we
496	 * have. We could change this, but that's a lot of effort which
497	 * will be obsoleted when FDT arrives.
498	 */
499	if (addr != 0 && addr < 0x10000000 && addr >= 0x0f000000)
500		addr += AT91_PA_BASE;
501	if (addr != 0)
502		bus_set_resource(kid, SYS_RES_MEMORY, 0, addr, size);
503}
504
505static device_method_t at91_methods[] = {
506	DEVMETHOD(device_probe, at91_probe),
507	DEVMETHOD(device_attach, at91_attach),
508	DEVMETHOD(device_identify, at91_identify),
509
510	DEVMETHOD(bus_alloc_resource, at91_alloc_resource),
511	DEVMETHOD(bus_setup_intr, at91_setup_intr),
512	DEVMETHOD(bus_teardown_intr, at91_teardown_intr),
513	DEVMETHOD(bus_activate_resource, at91_activate_resource),
514	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
515	DEVMETHOD(bus_get_resource_list,at91_get_resource_list),
516	DEVMETHOD(bus_set_resource,	bus_generic_rl_set_resource),
517	DEVMETHOD(bus_get_resource,	bus_generic_rl_get_resource),
518	DEVMETHOD(bus_release_resource,	at91_release_resource),
519	DEVMETHOD(bus_print_child,	at91_print_child),
520
521	{0, 0},
522};
523
524static driver_t at91_driver = {
525	"atmelarm",
526	at91_methods,
527	sizeof(struct at91_softc),
528};
529
530static devclass_t at91_devclass;
531
532DRIVER_MODULE(atmelarm, nexus, at91_driver, at91_devclass, 0, 0);
533#endif
534