oj6sh.c revision 1.6 1 /* $NetBSD: oj6sh.c,v 1.6 2021/01/17 21:42:35 thorpej Exp $ */
2
3 /*
4 * Copyright (c) 2014 Genetec Corporation. All rights reserved.
5 * Written by Hashimoto Kenichi for Genetec Corporation.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY GENETEC CORPORATION ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GENETEC CORPORATION
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /*
30 * Sharp NetWalker's Optical Joystick
31 */
32
33 #include <sys/cdefs.h>
34 __KERNEL_RCSID(0, "$NetBSD: oj6sh.c,v 1.6 2021/01/17 21:42:35 thorpej Exp $");
35
36 #include "opt_oj6sh.h"
37
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/device.h>
42 #include <sys/lock.h>
43 #include <sys/callout.h>
44 #include <sys/bus.h>
45 #include <sys/mutex.h>
46 #include <sys/workqueue.h>
47
48 #include <dev/wscons/wsconsio.h>
49 #include <dev/wscons/wsmousevar.h>
50 #include <dev/wscons/wsdisplayvar.h>
51
52 #include <dev/hpc/hpcfbio.h>
53 #include <dev/hpc/hpctpanelvar.h>
54
55 #include <dev/spi/spivar.h>
56
57 #ifdef OJ6SH_DEBUG
58 int oj6sh_debug = OJ6SH_DEBUG;
59 #define DPRINTF(n,x) if (oj6sh_debug>(n)) printf x;
60 #else
61 #define DPRINTF(n,x)
62 #endif
63
64 #define POLLRATE (hz/30)
65
66 /* register address */
67 #define OJ6SH_PRODUCT 0x00
68 #define OJ6SH_REVISION 0x01
69 #define OJ6SH_MOTION 0x02
70 #define OJ6SH_DELTA_X 0x03
71 #define OJ6SH_DELTA_Y 0x04
72 #define OJ6SH_SQUAL 0x05
73 #define OJ6SH_SHUTTER 0x06
74 #define OJ6SH_CONFIG 0x11
75 #define OJ6SH_RESET 0x3a
76 #define POWERON_RESET 0x5a
77 #define OJ6SH_N_REVISION 0x3e
78 #define OJ6SH_N_PRODUCT 0x3f
79
80 struct oj6sh_softc {
81 device_t sc_dev;
82
83 struct spi_handle *sc_sh;
84 struct callout sc_c;
85
86 kmutex_t sc_lock;
87 struct workqueue *sc_wq;
88 struct work sc_wk;
89
90 int sc_enabled;
91
92 device_t sc_wsmousedev;
93 };
94
95 struct oj6sh_delta {
96 int x;
97 int y;
98 };
99
100 static uint8_t oj6sh_read(struct spi_handle *, uint8_t);
101 static void oj6sh_write(struct spi_handle *, uint8_t, uint8_t);
102
103 static int oj6sh_match(device_t , cfdata_t , void *);
104 static void oj6sh_attach(device_t , device_t , void *);
105
106 CFATTACH_DECL_NEW(oj6sh, sizeof(struct oj6sh_softc),
107 oj6sh_match, oj6sh_attach, NULL, NULL);
108
109 static bool oj6sh_motion(struct spi_handle *);
110 static bool oj6sh_squal(struct spi_handle *);
111 static bool oj6sh_shuttrer(struct spi_handle *);
112 static int oj6sh_readdelta(struct spi_handle *, struct oj6sh_delta *);
113
114 static void oj6sh_poll(void *);
115 static void oj6sh_cb(struct work *, void *);
116 static int oj6sh_enable(void *);
117 static void oj6sh_disable(void *);
118 static int oj6sh_ioctl(void *, u_long, void *, int, struct lwp *);
119
120 static bool oj6sh_resume(device_t, const pmf_qual_t *);
121 static bool oj6sh_suspend(device_t, const pmf_qual_t *);
122
123 static const struct wsmouse_accessops oj6sh_accessops = {
124 .enable = oj6sh_enable,
125 .ioctl = oj6sh_ioctl,
126 .disable = oj6sh_disable
127 };
128
129 static const struct device_compatible_entry compat_data[] = {
130 { .compat = "oj6sh" },
131
132 { 0 }
133 };
134
135 static int
136 oj6sh_match(device_t parent, cfdata_t cf, void *aux)
137 {
138 struct spi_attach_args *sa = aux;
139
140 if (spi_compatible_match(sa, cf, compat_data) == 0)
141 return 0;
142 if (spi_configure(sa->sa_handle, SPI_MODE_0, 2500000))
143 return 0;
144
145 return 2;
146 }
147
148 static void
149 oj6sh_doattach(device_t self)
150 {
151 struct oj6sh_softc *sc = device_private(self);
152 uint8_t product;
153 uint8_t rev;
154 uint8_t product_inv;
155 uint8_t rev_inv;
156
157 /* reset */
158 oj6sh_write(sc->sc_sh, OJ6SH_RESET, POWERON_RESET);
159 delay(10000);
160
161 /* resolution */
162 oj6sh_write(sc->sc_sh, OJ6SH_CONFIG, 0x80);
163
164 product = oj6sh_read(sc->sc_sh, OJ6SH_PRODUCT);
165 rev = oj6sh_read(sc->sc_sh, OJ6SH_REVISION);
166 product_inv = oj6sh_read(sc->sc_sh, OJ6SH_N_PRODUCT);
167 rev_inv = oj6sh_read(sc->sc_sh, OJ6SH_N_REVISION);
168
169 if (((product | product_inv) != 0xff) || ((rev | rev_inv) != 0xff)) {
170 aprint_error_dev(self,
171 "mismatch product (%02x:%02x), rev (%02x:%02x)\n",
172 product, product_inv, rev, rev_inv);
173 return;
174 }
175
176 aprint_normal("%s: id 0x%02x, revision 0x%02x\n",
177 device_xname(sc->sc_dev), product, rev);
178
179 return;
180 }
181
182 static void
183 oj6sh_attach(device_t parent, device_t self, void *aux)
184 {
185 struct oj6sh_softc *sc = device_private(self);
186 struct spi_attach_args *sa = aux;
187 struct wsmousedev_attach_args a;
188
189 aprint_naive("\n");
190 aprint_normal(": OJ6SH-T25 Optical Joystick\n");
191
192 mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_NONE);
193
194 sc->sc_dev = self;
195 sc->sc_enabled = 0;
196
197 callout_init(&sc->sc_c, 0);
198 workqueue_create(&sc->sc_wq, "oj6sh",
199 oj6sh_cb, sc, PRI_NONE, IPL_BIO, 0);
200
201 sc->sc_sh = sa->sa_handle;
202
203 a.accessops = &oj6sh_accessops;
204 a.accesscookie = sc;
205
206 sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint);
207
208 config_interrupts(self, oj6sh_doattach);
209 }
210
211 static void
212 oj6sh_poll(void *arg)
213 {
214 struct oj6sh_softc *sc = (struct oj6sh_softc *)arg;
215 workqueue_enqueue(sc->sc_wq, &sc->sc_wk, NULL);
216 }
217
218 static void
219 oj6sh_cb(struct work *wk, void *arg)
220 {
221 struct oj6sh_softc *sc = (struct oj6sh_softc *)arg;
222 struct oj6sh_delta delta = {0, 0};
223 uint32_t buttons = 0;
224 int s;
225 int x, y;
226
227 mutex_enter(&sc->sc_lock);
228
229 if (oj6sh_motion(sc->sc_sh) == false)
230 goto out;
231 else if ((oj6sh_squal(sc->sc_sh) == true) &&
232 (oj6sh_shuttrer(sc->sc_sh) == true))
233 goto out;
234
235 oj6sh_readdelta(sc->sc_sh, &delta);
236 DPRINTF(3,("%s: x = %d, y = %d\n", device_xname(sc->sc_dev),
237 delta.x, delta.y));
238
239 #if defined(OJ6SH_DOWN_Y_LEFT_X)
240 y = -delta.y;
241 x = -delta.x;
242 #elif defined(OJ6SH_UP_X_LEFT_Y)
243 y = delta.x;
244 x = -delta.y;
245 #elif defined(OJ6SH_DOWN_X_RIGHT_Y)
246 y = -delta.x;
247 x = delta.y;
248 #else /* OJ6SH_UP_Y_RIGHT_X */
249 y = delta.y;
250 x = delta.x;
251 #endif
252 s = spltty();
253 wsmouse_input(sc->sc_wsmousedev, buttons, x, y, 0, 0,
254 WSMOUSE_INPUT_DELTA);
255 splx(s);
256 out:
257 mutex_exit(&sc->sc_lock);
258
259 if (sc->sc_enabled)
260 callout_reset(&sc->sc_c, POLLRATE, oj6sh_poll, sc);
261 }
262
263 static uint8_t
264 oj6sh_read(struct spi_handle *spi, uint8_t reg)
265 {
266 uint8_t ret = 0;
267
268 spi_send_recv(spi, 1, ®, 1, &ret);
269 DPRINTF(4,("%s: 0x%02x = 0x%02x\n", __func__, reg, ret));
270 return ret;
271 }
272
273 static void
274 oj6sh_write(struct spi_handle *spi, uint8_t reg, uint8_t val)
275 {
276 uint8_t tmp[2] = {reg | 0x80, val};
277
278 spi_send(spi, 2, tmp);
279 DPRINTF(4,("%s: 0x%02x = 0x%02x\n", __func__, reg, val));
280 return;
281 }
282
283 static bool
284 oj6sh_motion(struct spi_handle *spi)
285 {
286 uint16_t motion;
287 motion = oj6sh_read(spi, OJ6SH_MOTION);
288 return (motion & __BIT(7) ? true : false);
289 }
290
291 static bool
292 oj6sh_squal(struct spi_handle *spi)
293 {
294 uint16_t squal;
295 squal = oj6sh_read(spi, OJ6SH_SQUAL);
296 return (squal < 25 ? true : false);
297 }
298
299 static bool
300 oj6sh_shuttrer(struct spi_handle *spi)
301 {
302 uint16_t shutter;
303 shutter = oj6sh_read(spi, OJ6SH_SHUTTER) << 8;
304 shutter |= oj6sh_read(spi, OJ6SH_SHUTTER + 1);
305 return (shutter > 600 ? true : false);
306 }
307
308 static int
309 oj6sh_readdelta(struct spi_handle *spi, struct oj6sh_delta *delta)
310 {
311 delta->x = (int8_t)oj6sh_read(spi, OJ6SH_DELTA_X);
312 delta->y = (int8_t)oj6sh_read(spi, OJ6SH_DELTA_Y);
313 return 0;
314 }
315
316 int
317 oj6sh_ioctl(void *v, u_long cmd, void *data, int flag, struct lwp *l)
318 {
319 struct wsmouse_id *id;
320
321 switch (cmd) {
322 case WSMOUSEIO_GTYPE:
323 *(u_int *)data = WSMOUSE_TYPE_PS2;
324 return 0;
325 case WSMOUSEIO_GETID:
326 id = (struct wsmouse_id *)data;
327 if (id->type != WSMOUSE_ID_TYPE_UIDSTR)
328 return EINVAL;
329 strlcpy(id->data, "OJ6SH-T25", WSMOUSE_ID_MAXLEN);
330 id->length = strlen(id->data);
331 return 0;
332 }
333
334 return EPASSTHROUGH;
335 }
336
337 int
338 oj6sh_enable(void *v)
339 {
340 struct oj6sh_softc *sc = (struct oj6sh_softc *)v;
341
342 DPRINTF(3,("%s: oj6sh_enable()\n", device_xname(sc->sc_dev)));
343 if (sc->sc_enabled) {
344 DPRINTF(3,("%s: already enabled\n", device_xname(sc->sc_dev)));
345 return EBUSY;
346 }
347
348 if (!pmf_device_register(sc->sc_dev, oj6sh_suspend, oj6sh_resume))
349 aprint_error_dev(sc->sc_dev, "couldn't establish power handler\n");
350
351 sc->sc_enabled = 1;
352 callout_reset(&sc->sc_c, POLLRATE, oj6sh_poll, sc);
353
354 return 0;
355 }
356
357 void
358 oj6sh_disable(void *v)
359 {
360 struct oj6sh_softc *sc = (struct oj6sh_softc *)v;
361
362 DPRINTF(3,("%s: oj6sh_disable()\n", device_xname(sc->sc_dev)));
363 if (!sc->sc_enabled) {
364 DPRINTF(3,("%s: already disabled()\n", device_xname(sc->sc_dev)));
365 return;
366 }
367
368 pmf_device_deregister(sc->sc_dev);
369
370 sc->sc_enabled = 0;
371
372 return;
373 }
374
375 static bool
376 oj6sh_suspend(device_t dv, const pmf_qual_t *qual)
377 {
378 struct oj6sh_softc *sc = device_private(dv);
379
380 DPRINTF(3,("%s: oj6sh_suspend()\n", device_xname(sc->sc_dev)));
381 callout_stop(&sc->sc_c);
382 sc->sc_enabled = 0;
383
384 return true;
385 }
386
387 static bool
388 oj6sh_resume(device_t dv, const pmf_qual_t *qual)
389 {
390 struct oj6sh_softc *sc = device_private(dv);
391
392 DPRINTF(3,("%s: oj6sh_resume()\n", device_xname(sc->sc_dev)));
393 sc->sc_enabled = 1;
394 callout_reset(&sc->sc_c, POLLRATE, oj6sh_poll, sc);
395
396 return true;
397 }
398
399