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