xref: /freebsd/sys/arm/ti/ti_pruss.c (revision d002f039aeb370370cd2cba63ad55cc4cf16c932)
1 /*-
2  * Copyright (c) 2013 Rui Paulo <rpaulo@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, 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 THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
18  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
28 
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/bus.h>
32 #include <sys/conf.h>
33 #include <sys/kernel.h>
34 #include <sys/module.h>
35 #include <sys/malloc.h>
36 #include <sys/rman.h>
37 #include <sys/event.h>
38 #include <sys/selinfo.h>
39 #include <machine/bus.h>
40 #include <machine/cpu.h>
41 #include <machine/frame.h>
42 #include <machine/intr.h>
43 
44 #include <dev/fdt/fdt_common.h>
45 #include <dev/ofw/openfirm.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/ofw_bus_subr.h>
48 
49 #include <machine/bus.h>
50 
51 #include <arm/ti/ti_prcm.h>
52 #include <arm/ti/ti_pruss.h>
53 
54 #ifdef DEBUG
55 #define	DPRINTF(fmt, ...)	do {	\
56 	printf("%s: ", __func__);	\
57 	printf(fmt, __VA_ARGS__);	\
58 } while (0)
59 #else
60 #define	DPRINTF(fmt, ...)
61 #endif
62 
63 static device_probe_t		ti_pruss_probe;
64 static device_attach_t		ti_pruss_attach;
65 static device_detach_t		ti_pruss_detach;
66 static void			ti_pruss_intr(void *);
67 static d_open_t			ti_pruss_open;
68 static d_mmap_t			ti_pruss_mmap;
69 static void 			ti_pruss_kq_read_detach(struct knote *);
70 static int 			ti_pruss_kq_read_event(struct knote *, long);
71 static d_kqfilter_t		ti_pruss_kqfilter;
72 
73 #define	TI_PRUSS_IRQS		8
74 
75 struct ti_pruss_softc {
76 	struct mtx		sc_mtx;
77 	struct resource 	*sc_mem_res;
78 	struct resource 	*sc_irq_res[TI_PRUSS_IRQS];
79 	void            	*sc_intr[TI_PRUSS_IRQS];
80 	bus_space_tag_t		sc_bt;
81 	bus_space_handle_t	sc_bh;
82 	struct cdev		*sc_pdev;
83 	struct selinfo		sc_selinfo;
84 };
85 
86 static struct cdevsw ti_pruss_cdevsw = {
87 	.d_version =	D_VERSION,
88 	.d_name =	"ti_pruss",
89 	.d_open =	ti_pruss_open,
90 	.d_mmap =	ti_pruss_mmap,
91 	.d_kqfilter =	ti_pruss_kqfilter,
92 };
93 
94 static device_method_t ti_pruss_methods[] = {
95 	DEVMETHOD(device_probe,		ti_pruss_probe),
96 	DEVMETHOD(device_attach,	ti_pruss_attach),
97 	DEVMETHOD(device_detach,	ti_pruss_detach),
98 
99 	DEVMETHOD_END
100 };
101 
102 static driver_t ti_pruss_driver = {
103 	"ti_pruss",
104 	ti_pruss_methods,
105 	sizeof(struct ti_pruss_softc)
106 };
107 
108 static devclass_t ti_pruss_devclass;
109 
110 DRIVER_MODULE(ti_pruss, simplebus, ti_pruss_driver, ti_pruss_devclass, 0, 0);
111 
112 static struct resource_spec ti_pruss_irq_spec[] = {
113 	{ SYS_RES_IRQ,	    0,  RF_ACTIVE },
114 	{ SYS_RES_IRQ,	    1,  RF_ACTIVE },
115 	{ SYS_RES_IRQ,	    2,  RF_ACTIVE },
116 	{ SYS_RES_IRQ,	    3,  RF_ACTIVE },
117 	{ SYS_RES_IRQ,	    4,  RF_ACTIVE },
118 	{ SYS_RES_IRQ,	    5,  RF_ACTIVE },
119 	{ SYS_RES_IRQ,	    6,  RF_ACTIVE },
120 	{ SYS_RES_IRQ,	    7,  RF_ACTIVE },
121 	{ -1,               0,  0 }
122 };
123 CTASSERT(TI_PRUSS_IRQS == nitems(ti_pruss_irq_spec) - 1);
124 
125 static struct ti_pruss_irq_arg {
126 	int 		       irq;
127 	struct ti_pruss_softc *sc;
128 } ti_pruss_irq_args[TI_PRUSS_IRQS];
129 
130 static __inline uint32_t
131 ti_pruss_reg_read(struct ti_pruss_softc *sc, uint32_t reg)
132 {
133 	return (bus_space_read_4(sc->sc_bt, sc->sc_bh, reg));
134 }
135 
136 static __inline void
137 ti_pruss_reg_write(struct ti_pruss_softc *sc, uint32_t reg, uint32_t val)
138 {
139 	bus_space_write_4(sc->sc_bt, sc->sc_bh, reg, val);
140 }
141 
142 static int
143 ti_pruss_probe(device_t dev)
144 {
145 
146 	if (!ofw_bus_status_okay(dev))
147 		return (ENXIO);
148 
149 	if (ofw_bus_is_compatible(dev, "ti,pruss-v1") ||
150 	    ofw_bus_is_compatible(dev, "ti,pruss-v2")) {
151 		device_set_desc(dev, "TI Programmable Realtime Unit Subsystem");
152 		return (BUS_PROBE_DEFAULT);
153 	}
154 
155 	return (ENXIO);
156 }
157 
158 static int
159 ti_pruss_attach(device_t dev)
160 {
161 	struct ti_pruss_softc *sc;
162 	int rid, i;
163 
164 	if (ti_prcm_clk_enable(PRUSS_CLK) != 0) {
165 		device_printf(dev, "could not enable PRUSS clock\n");
166 		return (ENXIO);
167 	}
168 	sc = device_get_softc(dev);
169 	rid = 0;
170 	mtx_init(&sc->sc_mtx, "TI PRUSS", NULL, MTX_DEF);
171 	knlist_init_mtx(&sc->sc_selinfo.si_note, &sc->sc_mtx);
172 	sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
173 	    RF_ACTIVE);
174 	if (sc->sc_mem_res == NULL) {
175 		device_printf(dev, "could not allocate memory resource\n");
176 		return (ENXIO);
177 	}
178 	sc->sc_bt = rman_get_bustag(sc->sc_mem_res);
179 	sc->sc_bh = rman_get_bushandle(sc->sc_mem_res);
180 	if (bus_alloc_resources(dev, ti_pruss_irq_spec, sc->sc_irq_res) != 0) {
181 		device_printf(dev, "could not allocate interrupt resource\n");
182 		ti_pruss_detach(dev);
183 		return (ENXIO);
184 	}
185 	for (i = 0; i < TI_PRUSS_IRQS; i++) {
186 		ti_pruss_irq_args[i].irq = i;
187 		ti_pruss_irq_args[i].sc = sc;
188 		if (bus_setup_intr(dev, sc->sc_irq_res[i],
189 		    INTR_MPSAFE | INTR_TYPE_MISC,
190 		    NULL, ti_pruss_intr, &ti_pruss_irq_args[i],
191 		    &sc->sc_intr[i]) != 0) {
192 			device_printf(dev,
193 			    "unable to setup the interrupt handler\n");
194 			ti_pruss_detach(dev);
195 			return (ENXIO);
196 		}
197 	}
198 	if (ti_pruss_reg_read(sc, PRUSS_AM18XX_INTC) == PRUSS_AM18XX_REV)
199 		device_printf(dev, "AM18xx PRU-ICSS\n");
200 	else if (ti_pruss_reg_read(sc, PRUSS_AM33XX_INTC) == PRUSS_AM33XX_REV)
201 		device_printf(dev, "AM33xx PRU-ICSS\n");
202 
203 	sc->sc_pdev = make_dev(&ti_pruss_cdevsw, 0, UID_ROOT, GID_WHEEL,
204 	    0600, "pruss%d", device_get_unit(dev));
205 	sc->sc_pdev->si_drv1 = dev;
206 
207 	return (0);
208 }
209 
210 static int
211 ti_pruss_detach(device_t dev)
212 {
213 	struct ti_pruss_softc *sc;
214 	int i;
215 
216 	sc = device_get_softc(dev);
217 	for (i = 0; i < TI_PRUSS_IRQS; i++) {
218 		if (sc->sc_intr[i])
219 			bus_teardown_intr(dev, sc->sc_irq_res[i], sc->sc_intr[i]);
220 		if (sc->sc_irq_res[i])
221 			bus_release_resource(dev, SYS_RES_IRQ,
222 			    rman_get_rid(sc->sc_irq_res[i]),
223 			    sc->sc_irq_res[i]);
224 	}
225 	knlist_clear(&sc->sc_selinfo.si_note, 0);
226 	knlist_destroy(&sc->sc_selinfo.si_note);
227 	mtx_destroy(&sc->sc_mtx);
228 	if (sc->sc_mem_res)
229 		bus_release_resource(dev, SYS_RES_MEMORY, rman_get_rid(sc->sc_mem_res),
230 		    sc->sc_mem_res);
231 	if (sc->sc_pdev)
232 		destroy_dev(sc->sc_pdev);
233 
234 	return (0);
235 }
236 
237 static void
238 ti_pruss_intr(void *arg)
239 {
240 	int val;
241 	struct ti_pruss_irq_arg *iap = arg;
242 	struct ti_pruss_softc *sc = iap->sc;
243 	/*
244 	 * Interrupts pr1_host_intr[0:7] are mapped to
245 	 * Host-2 to Host-9 of PRU-ICSS IRQ-controller.
246 	 */
247 	const int pru_int = iap->irq + 2;
248 	const int pru_int_mask = (1 << pru_int);
249 
250 	val = ti_pruss_reg_read(sc, PRUSS_AM33XX_INTC + PRUSS_INTC_HIER);
251 	DPRINTF("interrupt %p, %d", sc, pru_int);
252 	if (!(val & pru_int_mask))
253 		return;
254  	ti_pruss_reg_write(sc, PRUSS_AM33XX_INTC + PRUSS_INTC_HIDISR,
255 	    pru_int);
256 	KNOTE_UNLOCKED(&sc->sc_selinfo.si_note, pru_int);
257 }
258 
259 static int
260 ti_pruss_open(struct cdev *cdev __unused, int oflags __unused,
261     int devtype __unused, struct thread *td __unused)
262 {
263 	return (0);
264 }
265 
266 static int
267 ti_pruss_mmap(struct cdev *cdev, vm_ooffset_t offset, vm_paddr_t *paddr,
268     int nprot, vm_memattr_t *memattr)
269 {
270 	device_t dev = cdev->si_drv1;
271 	struct ti_pruss_softc *sc = device_get_softc(dev);
272 
273 	if (offset > rman_get_size(sc->sc_mem_res))
274 		return (-1);
275 	*paddr = rman_get_start(sc->sc_mem_res) + offset;
276 	*memattr = VM_MEMATTR_UNCACHEABLE;
277 
278 	return (0);
279 }
280 
281 static struct filterops ti_pruss_kq_read = {
282 	.f_isfd = 1,
283 	.f_detach = ti_pruss_kq_read_detach,
284 	.f_event = ti_pruss_kq_read_event,
285 };
286 
287 static void
288 ti_pruss_kq_read_detach(struct knote *kn)
289 {
290 	struct ti_pruss_softc *sc = kn->kn_hook;
291 
292 	knlist_remove(&sc->sc_selinfo.si_note, kn, 0);
293 }
294 
295 static int
296 ti_pruss_kq_read_event(struct knote *kn, long hint)
297 {
298 	kn->kn_data = hint;
299 
300 	return (hint);
301 }
302 
303 static int
304 ti_pruss_kqfilter(struct cdev *cdev, struct knote *kn)
305 {
306 	device_t dev = cdev->si_drv1;
307 	struct ti_pruss_softc *sc = device_get_softc(dev);
308 
309 	switch (kn->kn_filter) {
310 	case EVFILT_READ:
311 		kn->kn_hook = sc;
312 		kn->kn_fop = &ti_pruss_kq_read;
313 		knlist_add(&sc->sc_selinfo.si_note, kn, 0);
314 		break;
315 	default:
316 		return (EINVAL);
317 	}
318 
319 	return (0);
320 }
321