oj6sh.c revision 1.12
1 /* $NetBSD: oj6sh.c,v 1.12 2025/09/10 00:50:33 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.12 2025/09/10 00:50:33 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 DEVICE_COMPAT_EOL 132 }; 133 134 static int 135 oj6sh_match(device_t parent, cfdata_t cf, void *aux) 136 { 137 struct spi_attach_args *sa = aux; 138 139 if (spi_compatible_match(sa, cf, compat_data) == 0) 140 return 0; 141 142 return 2; 143 } 144 145 static void 146 oj6sh_doattach(device_t self) 147 { 148 struct oj6sh_softc *sc = device_private(self); 149 uint8_t product; 150 uint8_t rev; 151 uint8_t product_inv; 152 uint8_t rev_inv; 153 154 /* reset */ 155 oj6sh_write(sc->sc_sh, OJ6SH_RESET, POWERON_RESET); 156 delay(10000); 157 158 /* resolution */ 159 oj6sh_write(sc->sc_sh, OJ6SH_CONFIG, 0x80); 160 161 product = oj6sh_read(sc->sc_sh, OJ6SH_PRODUCT); 162 rev = oj6sh_read(sc->sc_sh, OJ6SH_REVISION); 163 product_inv = oj6sh_read(sc->sc_sh, OJ6SH_N_PRODUCT); 164 rev_inv = oj6sh_read(sc->sc_sh, OJ6SH_N_REVISION); 165 166 if (((product | product_inv) != 0xff) || ((rev | rev_inv) != 0xff)) { 167 aprint_error_dev(self, 168 "mismatch product (%02x:%02x), rev (%02x:%02x)\n", 169 product, product_inv, rev, rev_inv); 170 return; 171 } 172 173 aprint_normal("%s: id 0x%02x, revision 0x%02x\n", 174 device_xname(sc->sc_dev), product, rev); 175 176 return; 177 } 178 179 static void 180 oj6sh_attach(device_t parent, device_t self, void *aux) 181 { 182 struct oj6sh_softc *sc = device_private(self); 183 struct spi_attach_args *sa = aux; 184 struct wsmousedev_attach_args a; 185 int error; 186 187 aprint_naive("\n"); 188 aprint_normal(": OJ6SH-T25 Optical Joystick\n"); 189 190 error = spi_configure(self, sa->sa_handle, SPI_MODE_0, 191 SPI_FREQ_KHz(2500)); 192 if (error) { 193 return; 194 } 195 196 mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_NONE); 197 198 sc->sc_dev = self; 199 sc->sc_enabled = 0; 200 201 callout_init(&sc->sc_c, 0); 202 workqueue_create(&sc->sc_wq, "oj6sh", 203 oj6sh_cb, sc, PRI_NONE, IPL_BIO, 0); 204 205 sc->sc_sh = sa->sa_handle; 206 207 a.accessops = &oj6sh_accessops; 208 a.accesscookie = sc; 209 210 sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint, CFARGS_NONE); 211 212 config_interrupts(self, oj6sh_doattach); 213 } 214 215 static void 216 oj6sh_poll(void *arg) 217 { 218 struct oj6sh_softc *sc = (struct oj6sh_softc *)arg; 219 workqueue_enqueue(sc->sc_wq, &sc->sc_wk, NULL); 220 } 221 222 static void 223 oj6sh_cb(struct work *wk, void *arg) 224 { 225 struct oj6sh_softc *sc = (struct oj6sh_softc *)arg; 226 struct oj6sh_delta delta = {0, 0}; 227 uint32_t buttons = 0; 228 int s; 229 int x, y; 230 231 mutex_enter(&sc->sc_lock); 232 233 if (oj6sh_motion(sc->sc_sh) == false) 234 goto out; 235 else if ((oj6sh_squal(sc->sc_sh) == true) && 236 (oj6sh_shuttrer(sc->sc_sh) == true)) 237 goto out; 238 239 oj6sh_readdelta(sc->sc_sh, &delta); 240 DPRINTF(3,("%s: x = %d, y = %d\n", device_xname(sc->sc_dev), 241 delta.x, delta.y)); 242 243 #if defined(OJ6SH_DOWN_Y_LEFT_X) 244 y = -delta.y; 245 x = -delta.x; 246 #elif defined(OJ6SH_UP_X_LEFT_Y) 247 y = delta.x; 248 x = -delta.y; 249 #elif defined(OJ6SH_DOWN_X_RIGHT_Y) 250 y = -delta.x; 251 x = delta.y; 252 #else /* OJ6SH_UP_Y_RIGHT_X */ 253 y = delta.y; 254 x = delta.x; 255 #endif 256 s = spltty(); 257 wsmouse_input(sc->sc_wsmousedev, buttons, x, y, 0, 0, 258 WSMOUSE_INPUT_DELTA); 259 splx(s); 260 out: 261 mutex_exit(&sc->sc_lock); 262 263 if (sc->sc_enabled) 264 callout_reset(&sc->sc_c, POLLRATE, oj6sh_poll, sc); 265 } 266 267 static uint8_t 268 oj6sh_read(struct spi_handle *spi, uint8_t reg) 269 { 270 uint8_t ret = 0; 271 272 spi_send_recv(spi, 1, ®, 1, &ret); 273 DPRINTF(4,("%s: 0x%02x = 0x%02x\n", __func__, reg, ret)); 274 return ret; 275 } 276 277 static void 278 oj6sh_write(struct spi_handle *spi, uint8_t reg, uint8_t val) 279 { 280 uint8_t tmp[2] = {reg | 0x80, val}; 281 282 spi_send(spi, 2, tmp); 283 DPRINTF(4,("%s: 0x%02x = 0x%02x\n", __func__, reg, val)); 284 return; 285 } 286 287 static bool 288 oj6sh_motion(struct spi_handle *spi) 289 { 290 uint16_t motion; 291 motion = oj6sh_read(spi, OJ6SH_MOTION); 292 return (motion & __BIT(7) ? true : false); 293 } 294 295 static bool 296 oj6sh_squal(struct spi_handle *spi) 297 { 298 uint16_t squal; 299 squal = oj6sh_read(spi, OJ6SH_SQUAL); 300 return (squal < 25 ? true : false); 301 } 302 303 static bool 304 oj6sh_shuttrer(struct spi_handle *spi) 305 { 306 uint16_t shutter; 307 shutter = oj6sh_read(spi, OJ6SH_SHUTTER) << 8; 308 shutter |= oj6sh_read(spi, OJ6SH_SHUTTER + 1); 309 return (shutter > 600 ? true : false); 310 } 311 312 static int 313 oj6sh_readdelta(struct spi_handle *spi, struct oj6sh_delta *delta) 314 { 315 delta->x = (int8_t)oj6sh_read(spi, OJ6SH_DELTA_X); 316 delta->y = (int8_t)oj6sh_read(spi, OJ6SH_DELTA_Y); 317 return 0; 318 } 319 320 int 321 oj6sh_ioctl(void *v, u_long cmd, void *data, int flag, struct lwp *l) 322 { 323 struct wsmouse_id *id; 324 325 switch (cmd) { 326 case WSMOUSEIO_GTYPE: 327 *(u_int *)data = WSMOUSE_TYPE_PS2; 328 return 0; 329 case WSMOUSEIO_GETID: 330 id = (struct wsmouse_id *)data; 331 if (id->type != WSMOUSE_ID_TYPE_UIDSTR) 332 return EINVAL; 333 strlcpy(id->data, "OJ6SH-T25", WSMOUSE_ID_MAXLEN); 334 id->length = strlen(id->data); 335 return 0; 336 } 337 338 return EPASSTHROUGH; 339 } 340 341 int 342 oj6sh_enable(void *v) 343 { 344 struct oj6sh_softc *sc = (struct oj6sh_softc *)v; 345 346 DPRINTF(3,("%s: oj6sh_enable()\n", device_xname(sc->sc_dev))); 347 if (sc->sc_enabled) { 348 DPRINTF(3,("%s: already enabled\n", device_xname(sc->sc_dev))); 349 return EBUSY; 350 } 351 352 if (!pmf_device_register(sc->sc_dev, oj6sh_suspend, oj6sh_resume)) 353 aprint_error_dev(sc->sc_dev, "couldn't establish power handler\n"); 354 355 sc->sc_enabled = 1; 356 callout_reset(&sc->sc_c, POLLRATE, oj6sh_poll, sc); 357 358 return 0; 359 } 360 361 void 362 oj6sh_disable(void *v) 363 { 364 struct oj6sh_softc *sc = (struct oj6sh_softc *)v; 365 366 DPRINTF(3,("%s: oj6sh_disable()\n", device_xname(sc->sc_dev))); 367 if (!sc->sc_enabled) { 368 DPRINTF(3,("%s: already disabled()\n", device_xname(sc->sc_dev))); 369 return; 370 } 371 372 pmf_device_deregister(sc->sc_dev); 373 374 sc->sc_enabled = 0; 375 376 return; 377 } 378 379 static bool 380 oj6sh_suspend(device_t dv, const pmf_qual_t *qual) 381 { 382 struct oj6sh_softc *sc = device_private(dv); 383 384 DPRINTF(3,("%s: oj6sh_suspend()\n", device_xname(sc->sc_dev))); 385 callout_stop(&sc->sc_c); 386 sc->sc_enabled = 0; 387 388 return true; 389 } 390 391 static bool 392 oj6sh_resume(device_t dv, const pmf_qual_t *qual) 393 { 394 struct oj6sh_softc *sc = device_private(dv); 395 396 DPRINTF(3,("%s: oj6sh_resume()\n", device_xname(sc->sc_dev))); 397 sc->sc_enabled = 1; 398 callout_reset(&sc->sc_c, POLLRATE, oj6sh_poll, sc); 399 400 return true; 401 } 402 403
Indexes created Tue Sep 23 07:09:52 GMT 2025