2 * Copyright (C) 2016 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
35 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
41 #include <sys/sysctl.h>
42 #include <sys/selinfo.h>
50 #include <dev/ofw/ofw_bus.h>
51 #include <dev/ofw/ofw_bus_subr.h>
53 #include <dev/evdev/input.h>
54 #include <dev/evdev/evdev.h>
56 #include <machine/bus.h>
57 #include <machine/cpu.h>
58 #include <machine/intr.h>
60 #include <arm/broadcom/bcm2835/bcm2835_mbox.h>
61 #include <arm/broadcom/bcm2835/bcm2835_mbox_prop.h>
62 #include <arm/broadcom/bcm2835/bcm2835_vcbus.h>
67 #define DPRINTF(fmt, ...) do { \
68 printf("%s:%u: ", __func__, __LINE__); \
69 printf(fmt, ##__VA_ARGS__); \
72 #define DPRINTF(fmt, ...)
75 #define FT5406_LOCK(_sc) \
76 mtx_lock(&(_sc)->sc_mtx)
77 #define FT5406_UNLOCK(_sc) \
78 mtx_unlock(&(_sc)->sc_mtx)
79 #define FT5406_LOCK_INIT(_sc) \
80 mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->sc_dev), \
82 #define FT5406_LOCK_DESTROY(_sc) \
83 mtx_destroy(&_sc->sc_mtx);
84 #define FT5406_LOCK_ASSERT(_sc) \
85 mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
87 #define FT5406_DEVICE_MODE 0
88 #define FT5406_GESTURE_ID 1
89 #define FT5406_NUM_POINTS 2
90 #define FT5406_POINT_XH(n) (0 + 3 + (n)*6)
91 #define FT5406_POINT_XL(n) (1 + 3 + (n)*6)
92 #define FT5406_POINT_YH(n) (2 + 3 + (n)*6)
93 #define FT5406_POINT_YL(n) (3 + 3 + (n)*6)
94 #define FT5406_WINDOW_SIZE 64
96 #define GET_NUM_POINTS(buf) (buf[FT5406_NUM_POINTS])
97 #define GET_X(buf, n) (((buf[FT5406_POINT_XH(n)] & 0xf) << 8) | \
98 (buf[FT5406_POINT_XL(n)]))
99 #define GET_Y(buf, n) (((buf[FT5406_POINT_YH(n)] & 0xf) << 8) | \
100 (buf[FT5406_POINT_YL(n)]))
101 #define GET_TOUCH_ID(buf, n) ((buf[FT5406_POINT_YH(n)] >> 4) & 0xf)
104 #define SCREEN_WIDTH 800
105 #define SCREEN_HEIGHT 480
106 #define SCREEN_WIDTH_MM 155
107 #define SCREEN_HEIGHT_MM 86
108 #define SCREEN_RES_X (SCREEN_WIDTH / SCREEN_WIDTH_MM)
109 #define SCREEN_RES_Y (SCREEN_HEIGHT / SCREEN_HEIGHT_MM)
110 #define MAX_TOUCH_ID (10 - 1)
112 struct ft5406ts_softc {
116 struct callout sc_callout;
118 /* mbox buffer (mapped to KVA) */
121 /* initial hook for waiting mbox intr */
122 struct intr_config_hook sc_init_hook;
124 struct evdev_dev *sc_evdev;
126 uint8_t sc_window[FT5406_WINDOW_SIZE];
129 static evdev_open_t ft5406ts_ev_open;
130 static evdev_close_t ft5406ts_ev_close;
132 static const struct evdev_methods ft5406ts_evdev_methods = {
133 .ev_open = &ft5406ts_ev_open,
134 .ev_close = &ft5406ts_ev_close,
138 ft5406ts_callout(void *data)
140 struct ft5406ts_softc *sc = (struct ft5406ts_softc *)data;
144 FT5406_LOCK_ASSERT(sc);
146 memcpy(sc->sc_window, sc->touch_buf, FT5406_WINDOW_SIZE);
147 sc->touch_buf[FT5406_NUM_POINTS] = NO_POINTS;
149 points = GET_NUM_POINTS(sc->sc_window);
151 * No update from VC - do nothing.
153 if (points == NO_POINTS)
156 for (i = 0; i < points; i++) {
157 id = GET_TOUCH_ID(sc->sc_window, i);
158 x = GET_X(sc->sc_window, i);
159 y = GET_Y(sc->sc_window, i);
161 if (id > MAX_TOUCH_ID) {
162 device_printf(sc->sc_dev, "bad touch id: %d", id);
165 evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_SLOT, id);
166 evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_TRACKING_ID, id);
167 evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_POSITION_X, x);
168 evdev_push_event(sc->sc_evdev, EV_ABS, ABS_MT_POSITION_Y, y);
170 evdev_sync(sc->sc_evdev);
172 callout_reset(&sc->sc_callout, sc->sc_tick, ft5406ts_callout, sc);
176 ft5406ts_ev_close(struct evdev_dev *evdev)
178 struct ft5406ts_softc *sc = evdev_get_softc(evdev);
180 FT5406_LOCK_ASSERT(sc);
182 callout_stop(&sc->sc_callout);
188 ft5406ts_ev_open(struct evdev_dev *evdev)
190 struct ft5406ts_softc *sc = evdev_get_softc(evdev);
192 FT5406_LOCK_ASSERT(sc);
194 callout_reset(&sc->sc_callout, sc->sc_tick, ft5406ts_callout, sc);
200 ft5406ts_init(void *arg)
202 struct ft5406ts_softc *sc = arg;
203 struct bcm2835_mbox_tag_touchbuf msg;
207 /* release this hook (continue boot) */
208 config_intrhook_disestablish(&sc->sc_init_hook);
210 memset(&msg, 0, sizeof(msg));
211 msg.hdr.buf_size = sizeof(msg);
212 msg.hdr.code = BCM2835_MBOX_CODE_REQ;
213 msg.tag_hdr.tag = BCM2835_MBOX_TAG_GET_TOUCHBUF;
214 msg.tag_hdr.val_buf_size = sizeof(msg.body);
215 msg.tag_hdr.val_len = sizeof(msg.body);
218 /* call mailbox property */
219 err = bcm2835_mbox_property(&msg, sizeof(msg));
221 device_printf(sc->sc_dev, "failed to get touchbuf address\n");
225 if (msg.body.resp.address == 0) {
226 device_printf(sc->sc_dev, "touchscreen not detected\n");
230 touchbuf = VCBUS_TO_PHYS(msg.body.resp.address);
231 sc->touch_buf = (uint8_t*)pmap_mapdev(touchbuf, FT5406_WINDOW_SIZE);
234 sc->sc_tick = hz * 17 / 1000;
235 if (sc->sc_tick == 0)
238 sc->sc_evdev = evdev_alloc();
239 evdev_set_name(sc->sc_evdev, device_get_desc(sc->sc_dev));
240 evdev_set_phys(sc->sc_evdev, device_get_nameunit(sc->sc_dev));
241 evdev_set_id(sc->sc_evdev, BUS_HOST, 0, 0, 0);
242 evdev_set_methods(sc->sc_evdev, sc, &ft5406ts_evdev_methods);
243 evdev_set_flag(sc->sc_evdev, EVDEV_FLAG_MT_STCOMPAT);
244 evdev_set_flag(sc->sc_evdev, EVDEV_FLAG_MT_AUTOREL);
245 evdev_support_prop(sc->sc_evdev, INPUT_PROP_DIRECT);
246 evdev_support_event(sc->sc_evdev, EV_SYN);
247 evdev_support_event(sc->sc_evdev, EV_ABS);
249 evdev_support_abs(sc->sc_evdev, ABS_MT_SLOT, 0, 0,
250 MAX_TOUCH_ID, 0, 0, 0);
251 evdev_support_abs(sc->sc_evdev, ABS_MT_TRACKING_ID, 0, -1,
252 MAX_TOUCH_ID, 0, 0, 0);
253 evdev_support_abs(sc->sc_evdev, ABS_MT_POSITION_X, 0, 0,
254 SCREEN_WIDTH, 0, 0, SCREEN_RES_X);
255 evdev_support_abs(sc->sc_evdev, ABS_MT_POSITION_Y, 0, 0,
256 SCREEN_HEIGHT, 0, 0, SCREEN_RES_Y);
258 err = evdev_register_mtx(sc->sc_evdev, &sc->sc_mtx);
260 evdev_free(sc->sc_evdev);
261 sc->sc_evdev = NULL; /* Avoid double free */
265 sc->touch_buf[FT5406_NUM_POINTS] = NO_POINTS;
266 callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
270 ft5406ts_probe(device_t dev)
273 if (!ofw_bus_is_compatible(dev, "rpi,rpi-ft5406"))
276 device_set_desc(dev, "FT5406 touchscreen (VC memory interface)");
278 return (BUS_PROBE_DEFAULT);
282 ft5406ts_attach(device_t dev)
284 struct ft5406ts_softc *sc;
287 sc = device_get_softc(dev);
290 /* register callback for using mbox when interrupts are enabled */
291 sc->sc_init_hook.ich_func = ft5406ts_init;
292 sc->sc_init_hook.ich_arg = sc;
294 FT5406_LOCK_INIT(sc);
296 if (config_intrhook_establish(&sc->sc_init_hook) != 0) {
297 device_printf(dev, "config_intrhook_establish failed\n");
298 FT5406_LOCK_DESTROY(sc);
306 ft5406ts_detach(device_t dev)
308 struct ft5406ts_softc *sc;
310 sc = device_get_softc(dev);
312 evdev_free(sc->sc_evdev);
314 FT5406_LOCK_DESTROY(sc);
319 static device_method_t ft5406ts_methods[] = {
320 /* Device interface */
321 DEVMETHOD(device_probe, ft5406ts_probe),
322 DEVMETHOD(device_attach, ft5406ts_attach),
323 DEVMETHOD(device_detach, ft5406ts_detach),
328 static devclass_t ft5406ts_devclass;
329 static driver_t ft5406ts_driver = {
332 sizeof(struct ft5406ts_softc),
335 DRIVER_MODULE(ft5406ts, ofwbus, ft5406ts_driver, ft5406ts_devclass, 0, 0);
336 MODULE_DEPEND(ft5406ts, evdev, 1, 1, 1);