at91.c revision 266097 
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 <sys/cdefs.h>
28__FBSDID("$FreeBSD: stable/10/sys/arm/at91/at91.c 266097 2014-05-14 23:51:07Z ian $");
29
30#include <sys/param.h>
31#include <sys/systm.h>
32#include <sys/bus.h>
33#include <sys/kernel.h>
34#include <sys/malloc.h>
35#include <sys/module.h>
36
37#include <vm/vm.h>
38#include <vm/vm_kern.h>
39#include <vm/pmap.h>
40#include <vm/vm_page.h>
41#include <vm/vm_extern.h>
42
43#define	_ARM32_BUS_DMA_PRIVATE
44#include <machine/bus.h>
45#include <machine/devmap.h>
46#include <machine/intr.h>
47
48#include <arm/at91/at91var.h>
49#include <arm/at91/at91_pmcvar.h>
50#include <arm/at91/at91_aicreg.h>
51
52static struct at91_softc *at91_softc;
53
54static void at91_eoi(void *);
55
56extern const struct arm_devmap_entry at91_devmap[];
57
58uint32_t at91_master_clock;
59
60static int
61at91_bs_map(void *t, bus_addr_t bpa, bus_size_t size, int flags,
62    bus_space_handle_t *bshp)
63{
64	vm_paddr_t pa, endpa;
65
66	pa = trunc_page(bpa);
67	if (pa >= AT91_PA_BASE + 0xff00000) {
68		*bshp = bpa - AT91_PA_BASE + AT91_BASE;
69		return (0);
70	}
71	if (pa >= AT91_BASE + 0xff00000) {
72		*bshp = bpa;
73		return (0);
74	}
75	endpa = round_page(bpa + size);
76
77	*bshp = (vm_offset_t)pmap_mapdev(pa, endpa - pa);
78
79	return (0);
80}
81
82static void
83at91_bs_unmap(void *t, bus_space_handle_t h, bus_size_t size)
84{
85	vm_offset_t va, endva;
86
87	va = trunc_page((vm_offset_t)t);
88	endva = va + round_page(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
232static int
233at91_probe(device_t dev)
234{
235
236	device_set_desc(dev, soc_info.name);
237	return (BUS_PROBE_NOWILDCARD);
238}
239
240static void
241at91_identify(driver_t *drv, device_t parent)
242{
243
244	BUS_ADD_CHILD(parent, 0, "atmelarm", 0);
245}
246
247static void
248at91_cpu_add_builtin_children(device_t dev, const struct cpu_devs *walker)
249{
250	int i;
251
252	for (i = 1; walker->name; i++, walker++) {
253		at91_add_child(dev, i, walker->name, walker->unit,
254		    walker->mem_base, walker->mem_len, walker->irq0,
255		    walker->irq1, walker->irq2);
256	}
257}
258
259static int
260at91_attach(device_t dev)
261{
262	struct at91_softc *sc = device_get_softc(dev);
263	const struct arm_devmap_entry *pdevmap;
264	int i;
265
266	arm_post_filter = at91_eoi;
267
268	at91_softc = sc;
269	sc->sc_st = &at91_bs_tag;
270	sc->sc_sh = AT91_BASE;
271	sc->sc_aic_sh = AT91_BASE + AT91_SYS_BASE;
272	sc->dev = dev;
273
274	sc->sc_irq_rman.rm_type = RMAN_ARRAY;
275	sc->sc_irq_rman.rm_descr = "AT91 IRQs";
276	if (rman_init(&sc->sc_irq_rman) != 0 ||
277	    rman_manage_region(&sc->sc_irq_rman, 1, 31) != 0)
278		panic("at91_attach: failed to set up IRQ rman");
279
280	sc->sc_mem_rman.rm_type = RMAN_ARRAY;
281	sc->sc_mem_rman.rm_descr = "AT91 Memory";
282	if (rman_init(&sc->sc_mem_rman) != 0)
283		panic("at91_attach: failed to set up memory rman");
284	for (pdevmap = at91_devmap; pdevmap->pd_va != 0; pdevmap++) {
285		if (rman_manage_region(&sc->sc_mem_rman, pdevmap->pd_va,
286		    pdevmap->pd_va + pdevmap->pd_size - 1) != 0)
287			panic("at91_attach: failed to set up memory rman");
288	}
289
290	/*
291	 * Setup the interrupt table.
292	 */
293	if (soc_info.soc_data == NULL || soc_info.soc_data->soc_irq_prio == NULL)
294		panic("Interrupt priority table missing\n");
295	for (i = 0; i < 32; i++) {
296		bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_SVR +
297		    i * 4, i);
298		/* Priority. */
299		bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_SMR + i * 4,
300		    soc_info.soc_data->soc_irq_prio[i]);
301		if (i < 8)
302			bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_EOICR,
303			    1);
304	}
305
306	bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_SPU, 32);
307	/* No debug. */
308	bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_DCR, 0);
309	/* Disable and clear all interrupts. */
310	bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_IDCR, 0xffffffff);
311	bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_ICCR, 0xffffffff);
312
313        /*
314         * Add this device's children...
315         */
316	at91_cpu_add_builtin_children(dev, soc_info.soc_data->soc_children);
317	soc_info.soc_data->soc_clock_init();
318
319	bus_generic_probe(dev);
320	bus_generic_attach(dev);
321	enable_interrupts(I32_bit | F32_bit);
322	return (0);
323}
324
325static struct resource *
326at91_alloc_resource(device_t dev, device_t child, int type, int *rid,
327    u_long start, u_long end, u_long count, u_int flags)
328{
329	struct at91_softc *sc = device_get_softc(dev);
330	struct resource_list_entry *rle;
331	struct at91_ivar *ivar = device_get_ivars(child);
332	struct resource_list *rl = &ivar->resources;
333
334	if (device_get_parent(child) != dev)
335		return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
336		    type, rid, start, end, count, flags));
337
338	rle = resource_list_find(rl, type, *rid);
339	if (rle == NULL)
340		return (NULL);
341	if (rle->res)
342		panic("Resource rid %d type %d already in use", *rid, type);
343	if (start == 0UL && end == ~0UL) {
344		start = rle->start;
345		count = ulmax(count, rle->count);
346		end = ulmax(rle->end, start + count - 1);
347	}
348	switch (type)
349	{
350	case SYS_RES_IRQ:
351		rle->res = rman_reserve_resource(&sc->sc_irq_rman,
352		    start, end, count, flags, child);
353		break;
354	case SYS_RES_MEMORY:
355		rle->res = rman_reserve_resource(&sc->sc_mem_rman,
356		    start, end, count, flags, child);
357		if (rle->res != NULL) {
358			rman_set_bustag(rle->res, &at91_bs_tag);
359			rman_set_bushandle(rle->res, start);
360		}
361		break;
362	}
363	if (rle->res) {
364		rle->start = rman_get_start(rle->res);
365		rle->end = rman_get_end(rle->res);
366		rle->count = count;
367		rman_set_rid(rle->res, *rid);
368	}
369	return (rle->res);
370}
371
372static struct resource_list *
373at91_get_resource_list(device_t dev, device_t child)
374{
375	struct at91_ivar *ivar;
376
377	ivar = device_get_ivars(child);
378	return (&(ivar->resources));
379}
380
381static int
382at91_release_resource(device_t dev, device_t child, int type,
383    int rid, struct resource *r)
384{
385	struct resource_list *rl;
386	struct resource_list_entry *rle;
387
388	rl = at91_get_resource_list(dev, child);
389	if (rl == NULL)
390		return (EINVAL);
391	rle = resource_list_find(rl, type, rid);
392	if (rle == NULL)
393		return (EINVAL);
394	rman_release_resource(r);
395	rle->res = NULL;
396	return (0);
397}
398
399static int
400at91_setup_intr(device_t dev, device_t child,
401    struct resource *ires, int flags, driver_filter_t *filt,
402    driver_intr_t *intr, void *arg, void **cookiep)
403{
404	int error;
405
406	if (rman_get_start(ires) == AT91_IRQ_SYSTEM && filt == NULL)
407		panic("All system interrupt ISRs must be FILTER");
408	error = BUS_SETUP_INTR(device_get_parent(dev), child, ires, flags,
409	    filt, intr, arg, cookiep);
410	if (error)
411		return (error);
412
413	return (0);
414}
415
416static int
417at91_teardown_intr(device_t dev, device_t child, struct resource *res,
418    void *cookie)
419{
420	struct at91_softc *sc = device_get_softc(dev);
421
422	bus_space_write_4(sc->sc_st, sc->sc_aic_sh, IC_IDCR,
423	    1 << rman_get_start(res));
424	return (BUS_TEARDOWN_INTR(device_get_parent(dev), child, res, cookie));
425}
426
427static int
428at91_activate_resource(device_t bus, device_t child, int type, int rid,
429    struct resource *r)
430{
431#if 0
432	u_long p;
433	int error;
434
435	if (type == SYS_RES_MEMORY) {
436		error = bus_space_map(rman_get_bustag(r),
437		    rman_get_bushandle(r), rman_get_size(r), 0, &p);
438		if (error)
439			return (error);
440		rman_set_bushandle(r, p);
441	}
442#endif
443	return (rman_activate_resource(r));
444}
445
446static int
447at91_print_child(device_t dev, device_t child)
448{
449	struct at91_ivar *ivars;
450	struct resource_list *rl;
451	int retval = 0;
452
453	ivars = device_get_ivars(child);
454	rl = &ivars->resources;
455
456	retval += bus_print_child_header(dev, child);
457
458	retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
459	retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
460	retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
461	if (device_get_flags(dev))
462		retval += printf(" flags %#x", device_get_flags(dev));
463
464	retval += bus_print_child_footer(dev, child);
465
466	return (retval);
467}
468
469void
470arm_mask_irq(uintptr_t nb)
471{
472
473	bus_space_write_4(at91_softc->sc_st,
474	    at91_softc->sc_aic_sh, IC_IDCR, 1 << nb);
475}
476
477int
478arm_get_next_irq(int last __unused)
479{
480	int status;
481	int irq;
482
483	irq = bus_space_read_4(at91_softc->sc_st,
484	    at91_softc->sc_aic_sh, IC_IVR);
485	status = bus_space_read_4(at91_softc->sc_st,
486	    at91_softc->sc_aic_sh, IC_ISR);
487	if (status == 0) {
488		bus_space_write_4(at91_softc->sc_st,
489		    at91_softc->sc_aic_sh, IC_EOICR, 1);
490		return (-1);
491	}
492	return (irq);
493}
494
495void
496arm_unmask_irq(uintptr_t nb)
497{
498
499	bus_space_write_4(at91_softc->sc_st,
500	at91_softc->sc_aic_sh, IC_IECR, 1 << nb);
501	bus_space_write_4(at91_softc->sc_st, at91_softc->sc_aic_sh,
502	    IC_EOICR, 0);
503}
504
505static void
506at91_eoi(void *unused)
507{
508	bus_space_write_4(at91_softc->sc_st, at91_softc->sc_aic_sh,
509	    IC_EOICR, 0);
510}
511
512void
513at91_add_child(device_t dev, int prio, const char *name, int unit,
514    bus_addr_t addr, bus_size_t size, int irq0, int irq1, int irq2)
515{
516	device_t kid;
517	struct at91_ivar *ivar;
518
519	kid = device_add_child_ordered(dev, prio, name, unit);
520	if (kid == NULL) {
521	    printf("Can't add child %s%d ordered\n", name, unit);
522	    return;
523	}
524	ivar = malloc(sizeof(*ivar), M_DEVBUF, M_NOWAIT | M_ZERO);
525	if (ivar == NULL) {
526		device_delete_child(dev, kid);
527		printf("Can't add alloc ivar\n");
528		return;
529	}
530	device_set_ivars(kid, ivar);
531	resource_list_init(&ivar->resources);
532	if (irq0 != -1) {
533		bus_set_resource(kid, SYS_RES_IRQ, 0, irq0, 1);
534		if (irq0 != AT91_IRQ_SYSTEM)
535			at91_pmc_clock_add(device_get_nameunit(kid), irq0, 0);
536	}
537	if (irq1 != 0)
538		bus_set_resource(kid, SYS_RES_IRQ, 1, irq1, 1);
539	if (irq2 != 0)
540		bus_set_resource(kid, SYS_RES_IRQ, 2, irq2, 1);
541	if (addr != 0 && addr < AT91_BASE)
542		addr += AT91_BASE;
543	if (addr != 0)
544		bus_set_resource(kid, SYS_RES_MEMORY, 0, addr, size);
545}
546
547static device_method_t at91_methods[] = {
548	DEVMETHOD(device_probe, at91_probe),
549	DEVMETHOD(device_attach, at91_attach),
550	DEVMETHOD(device_identify, at91_identify),
551
552	DEVMETHOD(bus_alloc_resource, at91_alloc_resource),
553	DEVMETHOD(bus_setup_intr, at91_setup_intr),
554	DEVMETHOD(bus_teardown_intr, at91_teardown_intr),
555	DEVMETHOD(bus_activate_resource, at91_activate_resource),
556	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
557	DEVMETHOD(bus_get_resource_list,at91_get_resource_list),
558	DEVMETHOD(bus_set_resource,	bus_generic_rl_set_resource),
559	DEVMETHOD(bus_get_resource,	bus_generic_rl_get_resource),
560	DEVMETHOD(bus_release_resource,	at91_release_resource),
561	DEVMETHOD(bus_print_child,	at91_print_child),
562
563	{0, 0},
564};
565
566static driver_t at91_driver = {
567	"atmelarm",
568	at91_methods,
569	sizeof(struct at91_softc),
570};
571
572static devclass_t at91_devclass;
573
574DRIVER_MODULE(atmelarm, nexus, at91_driver, at91_devclass, 0, 0);
575