xref: /freebsd/sys/arm/broadcom/bcm2835/bcm2835_ft5406.c (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*-
2  * Copyright (C) 2016 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, 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 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 THE 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 
28 #include <sys/param.h>
29 #include <sys/systm.h>
30 #include <sys/bus.h>
31 #include <sys/cpu.h>
32 #include <sys/kernel.h>
33 #include <sys/lock.h>
34 #include <sys/malloc.h>
35 #include <sys/module.h>
36 #include <sys/mutex.h>
37 #include <sys/condvar.h>
38 #include <sys/sysctl.h>
39 #include <sys/selinfo.h>
40 #include <sys/poll.h>
41 #include <sys/uio.h>
42 #include <sys/conf.h>
43 
44 #include <vm/vm.h>
45 #include <vm/pmap.h>
46 
47 #include <dev/ofw/ofw_bus.h>
48 #include <dev/ofw/ofw_bus_subr.h>
49 
50 #include <dev/evdev/input.h>
51 #include <dev/evdev/evdev.h>
52 
53 #include <machine/bus.h>
54 #include <machine/cpu.h>
55 #include <machine/intr.h>
56 
57 #include <arm/broadcom/bcm2835/bcm2835_mbox.h>
58 #include <arm/broadcom/bcm2835/bcm2835_mbox_prop.h>
59 #include <arm/broadcom/bcm2835/bcm2835_vcbus.h>
60 
61 #include "mbox_if.h"
62 
63 #ifdef DEBUG
64 #define DPRINTF(fmt, ...) do {			\
65 	printf("%s:%u: ", __func__, __LINE__);	\
66 	printf(fmt, ##__VA_ARGS__);		\
67 } while (0)
68 #else
69 #define DPRINTF(fmt, ...)
70 #endif
71 
72 #define	FT5406_LOCK(_sc)		\
73 	mtx_lock(&(_sc)->sc_mtx)
74 #define	FT5406_UNLOCK(_sc)		\
75 	mtx_unlock(&(_sc)->sc_mtx)
76 #define	FT5406_LOCK_INIT(_sc)	\
77 	mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->sc_dev), \
78 	    "ft5406", MTX_DEF)
79 #define	FT5406_LOCK_DESTROY(_sc)	\
80 	mtx_destroy(&_sc->sc_mtx);
81 #define	FT5406_LOCK_ASSERT(_sc)	\
82 	mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
83 
84 #define	FT5406_DEVICE_MODE	0
85 #define	FT5406_GESTURE_ID	1
86 #define	FT5406_NUM_POINTS	2
87 #define	FT5406_POINT_XH(n)	(0 + 3 + (n)*6)
88 #define	FT5406_POINT_XL(n)	(1 + 3 + (n)*6)
89 #define	FT5406_POINT_YH(n)	(2 + 3 + (n)*6)
90 #define	FT5406_POINT_YL(n)	(3 + 3 + (n)*6)
91 #define	FT5406_WINDOW_SIZE	64
92 
93 #define	GET_NUM_POINTS(buf)	(buf[FT5406_NUM_POINTS])
94 #define	GET_X(buf, n)		(((buf[FT5406_POINT_XH(n)] & 0xf) << 8) | \
95 				    (buf[FT5406_POINT_XL(n)]))
96 #define	GET_Y(buf, n)		(((buf[FT5406_POINT_YH(n)] & 0xf) << 8) | \
97 				    (buf[FT5406_POINT_YL(n)]))
98 #define	GET_TOUCH_ID(buf, n)	((buf[FT5406_POINT_YH(n)] >> 4) & 0xf)
99 
100 #define	NO_POINTS		99
101 #define	SCREEN_WIDTH		800
102 #define	SCREEN_HEIGHT		480
103 #define	SCREEN_WIDTH_MM		155
104 #define	SCREEN_HEIGHT_MM	86
105 #define	SCREEN_RES_X	(SCREEN_WIDTH / SCREEN_WIDTH_MM)
106 #define	SCREEN_RES_Y	(SCREEN_HEIGHT / SCREEN_HEIGHT_MM)
107 #define	MAX_TOUCH_ID	(10 - 1)
108 
109 struct ft5406ts_softc {
110 	device_t		sc_dev;
111 	struct mtx		sc_mtx;
112 	int			sc_tick;
113 	struct callout		sc_callout;
114 
115 	/* mbox buffer (mapped to KVA) */
116 	uint8_t			*touch_buf;
117 
118 	/* initial hook for waiting mbox intr */
119 	struct intr_config_hook	sc_init_hook;
120 
121 	struct evdev_dev	*sc_evdev;
122 
123 	uint8_t			sc_window[FT5406_WINDOW_SIZE];
124 };
125 
126 static evdev_open_t ft5406ts_ev_open;
127 static evdev_close_t ft5406ts_ev_close;
128 
129 static const struct evdev_methods ft5406ts_evdev_methods = {
130 	.ev_open = &ft5406ts_ev_open,
131 	.ev_close = &ft5406ts_ev_close,
132 };
133 
134 static void
135 ft5406ts_callout(void *data)
136 {
137 	struct ft5406ts_softc *sc = (struct ft5406ts_softc *)data;
138 	int points;
139 	int id, i, x, y;
140 
141 	FT5406_LOCK_ASSERT(sc);
142 
143 	memcpy(sc->sc_window, sc->touch_buf, FT5406_WINDOW_SIZE);
144 	sc->touch_buf[FT5406_NUM_POINTS] = NO_POINTS;
145 
146 	points = GET_NUM_POINTS(sc->sc_window);
147 	/*
148 	 * No update from VC - do nothing.
149 	 */
150 	if (points == NO_POINTS)
151 		goto out;
152 
153 	for (i = 0; i < points; i++) {
154 		id = GET_TOUCH_ID(sc->sc_window, i);
155 		x = GET_X(sc->sc_window, i);
156 		y = GET_Y(sc->sc_window, i);
157 
158 		if (id > MAX_TOUCH_ID) {
159 			device_printf(sc->sc_dev, "bad touch id: %d", id);
160 			continue;
161 		}
162 		evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_SLOT, id);
163 		evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_TRACKING_ID, id);
164 		evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_POSITION_X, x);
165 		evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_POSITION_Y, y);
166 	}
167 	evdev_sync(sc->sc_evdev);
168 out:
169 	callout_reset(&sc->sc_callout, sc->sc_tick, ft5406ts_callout, sc);
170 }
171 
172 static int
173 ft5406ts_ev_close(struct evdev_dev *evdev)
174 {
175 	struct ft5406ts_softc *sc = evdev_get_softc(evdev);
176 
177 	FT5406_LOCK_ASSERT(sc);
178 
179 	callout_stop(&sc->sc_callout);
180 
181 	return (0);
182 }
183 
184 static int
185 ft5406ts_ev_open(struct evdev_dev *evdev)
186 {
187 	struct ft5406ts_softc *sc = evdev_get_softc(evdev);
188 
189 	FT5406_LOCK_ASSERT(sc);
190 
191 	callout_reset(&sc->sc_callout, sc->sc_tick, ft5406ts_callout, sc);
192 
193 	return (0);
194 }
195 
196 static void
197 ft5406ts_init(void *arg)
198 {
199 	struct ft5406ts_softc *sc = arg;
200 	struct bcm2835_mbox_tag_touchbuf msg;
201 	uint32_t touchbuf;
202 	int err;
203 
204 	/* release this hook (continue boot) */
205 	config_intrhook_disestablish(&sc->sc_init_hook);
206 
207 	memset(&msg, 0, sizeof(msg));
208 	msg.hdr.buf_size = sizeof(msg);
209 	msg.hdr.code = BCM2835_MBOX_CODE_REQ;
210 	msg.tag_hdr.tag = BCM2835_MBOX_TAG_GET_TOUCHBUF;
211 	msg.tag_hdr.val_buf_size = sizeof(msg.body);
212 	msg.tag_hdr.val_len = sizeof(msg.body);
213 	msg.end_tag = 0;
214 
215 	/* call mailbox property */
216 	err = bcm2835_mbox_property(&msg, sizeof(msg));
217 	if (err) {
218 		device_printf(sc->sc_dev, "failed to get touchbuf address\n");
219 		return;
220 	}
221 
222 	if (msg.body.resp.address == 0) {
223 		device_printf(sc->sc_dev, "touchscreen not detected\n");
224 		return;
225 	}
226 
227 	touchbuf = VCBUS_TO_ARMC(msg.body.resp.address);
228 	sc->touch_buf = (uint8_t*)pmap_mapdev(touchbuf, FT5406_WINDOW_SIZE);
229 
230 	/* 60Hz */
231 	sc->sc_tick = hz * 17 / 1000;
232 	if (sc->sc_tick == 0)
233 		sc->sc_tick = 1;
234 
235 	sc->sc_evdev = evdev_alloc();
236 	evdev_set_name(sc->sc_evdev, device_get_desc(sc->sc_dev));
237 	evdev_set_phys(sc->sc_evdev, device_get_nameunit(sc->sc_dev));
238 	evdev_set_id(sc->sc_evdev, BUS_HOST, 0, 0, 0);
239 	evdev_set_methods(sc->sc_evdev, sc, &ft5406ts_evdev_methods);
240 	evdev_set_flag(sc->sc_evdev, EVDEV_FLAG_MT_STCOMPAT);
241 	evdev_set_flag(sc->sc_evdev, EVDEV_FLAG_MT_AUTOREL);
242 	evdev_support_prop(sc->sc_evdev, INPUT_PROP_DIRECT);
243 	evdev_support_event(sc->sc_evdev, EV_SYN);
244 	evdev_support_event(sc->sc_evdev, EV_ABS);
245 
246 	evdev_support_abs(sc->sc_evdev, ABS_MT_SLOT, 0,
247 	    MAX_TOUCH_ID, 0, 0, 0);
248 	evdev_support_abs(sc->sc_evdev, ABS_MT_TRACKING_ID, -1,
249 	    MAX_TOUCH_ID, 0, 0, 0);
250 	evdev_support_abs(sc->sc_evdev, ABS_MT_POSITION_X, 0,
251 	    SCREEN_WIDTH, 0, 0, SCREEN_RES_X);
252 	evdev_support_abs(sc->sc_evdev, ABS_MT_POSITION_Y, 0,
253 	    SCREEN_HEIGHT, 0, 0, SCREEN_RES_Y);
254 
255 	err = evdev_register_mtx(sc->sc_evdev, &sc->sc_mtx);
256 	if (err) {
257 		evdev_free(sc->sc_evdev);
258 		sc->sc_evdev = NULL;	/* Avoid double free */
259 		return;
260 	}
261 
262 	sc->touch_buf[FT5406_NUM_POINTS] = NO_POINTS;
263 	callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
264 }
265 
266 static int
267 ft5406ts_probe(device_t dev)
268 {
269 
270 	if (!ofw_bus_is_compatible(dev, "raspberrypi,firmware-ts"))
271 		return (ENXIO);
272 
273 	device_set_desc(dev, "FT5406 touchscreen (VC memory interface)");
274 
275 	return (BUS_PROBE_DEFAULT);
276 }
277 
278 static int
279 ft5406ts_attach(device_t dev)
280 {
281 	struct ft5406ts_softc *sc;
282 
283 	/* set self dev */
284 	sc = device_get_softc(dev);
285 	sc->sc_dev = dev;
286 
287 	/* register callback for using mbox when interrupts are enabled */
288 	sc->sc_init_hook.ich_func = ft5406ts_init;
289 	sc->sc_init_hook.ich_arg = sc;
290 
291 	FT5406_LOCK_INIT(sc);
292 
293 	if (config_intrhook_establish(&sc->sc_init_hook) != 0) {
294 		device_printf(dev, "config_intrhook_establish failed\n");
295 		FT5406_LOCK_DESTROY(sc);
296 		return (ENOMEM);
297 	}
298 
299 	return (0);
300 }
301 
302 static int
303 ft5406ts_detach(device_t dev)
304 {
305 	struct ft5406ts_softc *sc;
306 
307 	sc = device_get_softc(dev);
308 
309 	evdev_free(sc->sc_evdev);
310 
311 	FT5406_LOCK_DESTROY(sc);
312 
313 	return (0);
314 }
315 
316 static device_method_t ft5406ts_methods[] = {
317 	/* Device interface */
318 	DEVMETHOD(device_probe,		ft5406ts_probe),
319 	DEVMETHOD(device_attach,	ft5406ts_attach),
320 	DEVMETHOD(device_detach,	ft5406ts_detach),
321 
322 	DEVMETHOD_END
323 };
324 
325 static driver_t ft5406ts_driver = {
326 	"ft5406ts",
327 	ft5406ts_methods,
328 	sizeof(struct ft5406ts_softc),
329 };
330 
331 DRIVER_MODULE(ft5406ts, simplebus, ft5406ts_driver, 0, 0);
332 MODULE_DEPEND(ft5406ts, evdev, 1, 1, 1);
333