1 /* $OpenBSD: uts.c,v 1.31 2013/04/15 09:23:02 mglocker Exp $ */ 2 3 /* 4 * Copyright (c) 2007 Robert Nagy <robert@openbsd.org> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #include <sys/param.h> 20 #include <sys/sockio.h> 21 #include <sys/mbuf.h> 22 #include <sys/kernel.h> 23 #include <sys/socket.h> 24 #include <sys/systm.h> 25 #include <sys/malloc.h> 26 #include <sys/timeout.h> 27 #include <sys/conf.h> 28 #include <sys/device.h> 29 30 #include <machine/bus.h> 31 #include <machine/endian.h> 32 #include <machine/intr.h> 33 34 #include <dev/usb/usb.h> 35 #include <dev/usb/usbdi.h> 36 #include <dev/usb/usbdi_util.h> 37 #include <dev/usb/usbdevs.h> 38 39 #include <dev/wscons/wsconsio.h> 40 #include <dev/wscons/wsmousevar.h> 41 42 #ifdef USB_DEBUG 43 #define UTS_DEBUG 44 #endif 45 46 #ifdef UTS_DEBUG 47 #define DPRINTF(x) do { printf x; } while (0) 48 #else 49 #define DPRINTF(x) 50 #endif 51 52 #define UTS_CONFIG_INDEX 0 53 54 struct tsscale { 55 int minx, maxx; 56 int miny, maxy; 57 int swapxy; 58 int resx, resy; 59 } def_scale = { 60 67, 1931, 102, 1937, 0, 1024, 768 61 }; 62 63 struct uts_softc { 64 struct device sc_dev; 65 struct usbd_device *sc_udev; 66 struct usbd_interface *sc_iface; 67 int sc_iface_number; 68 int sc_product; 69 int sc_vendor; 70 71 int sc_intr_number; 72 struct usbd_pipe *sc_intr_pipe; 73 u_char *sc_ibuf; 74 int sc_isize; 75 u_int8_t sc_pkts; 76 77 struct device *sc_wsmousedev; 78 79 int sc_enabled; 80 int sc_buttons; 81 int sc_dying; 82 int sc_oldx; 83 int sc_oldy; 84 int sc_rawmode; 85 86 struct tsscale sc_tsscale; 87 }; 88 89 struct uts_pos { 90 int down; 91 int x; 92 int y; 93 int z; /* touch pressure */ 94 }; 95 96 const struct usb_devno uts_devs[] = { 97 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_ITM_TOUCH }, 98 { USB_VENDOR_EGALAX, USB_PRODUCT_EGALAX_TPANEL }, 99 { USB_VENDOR_EGALAX, USB_PRODUCT_EGALAX_TPANEL2 }, 100 { USB_VENDOR_GUNZE, USB_PRODUCT_GUNZE_TOUCHPANEL } 101 }; 102 103 void uts_intr(struct usbd_xfer *, void *, usbd_status); 104 void uts_get_pos(void *addr, struct uts_pos *tp); 105 106 int uts_enable(void *); 107 void uts_disable(void *); 108 int uts_ioctl(void *, u_long, caddr_t, int, struct proc *); 109 110 const struct wsmouse_accessops uts_accessops = { 111 uts_enable, 112 uts_ioctl, 113 uts_disable, 114 }; 115 116 int uts_match(struct device *, void *, void *); 117 void uts_attach(struct device *, struct device *, void *); 118 int uts_detach(struct device *, int); 119 int uts_activate(struct device *, int); 120 121 struct cfdriver uts_cd = { 122 NULL, "uts", DV_DULL 123 }; 124 125 const struct cfattach uts_ca = { 126 sizeof(struct uts_softc), 127 uts_match, 128 uts_attach, 129 uts_detach, 130 uts_activate, 131 }; 132 133 int 134 uts_match(struct device *parent, void *match, void *aux) 135 { 136 struct usb_attach_arg *uaa = aux; 137 usb_interface_descriptor_t *id; 138 139 if (uaa->iface == NULL) 140 return (UMATCH_NONE); 141 142 /* Some eGalax touch screens are HID devices. ignore them */ 143 id = usbd_get_interface_descriptor(uaa->iface); 144 if (id != NULL && id->bInterfaceClass == UICLASS_HID) 145 return (UMATCH_NONE); 146 147 return (usb_lookup(uts_devs, uaa->vendor, uaa->product) != NULL) ? 148 UMATCH_VENDOR_PRODUCT : UMATCH_NONE; 149 } 150 151 void 152 uts_attach(struct device *parent, struct device *self, void *aux) 153 { 154 struct uts_softc *sc = (struct uts_softc *)self; 155 struct usb_attach_arg *uaa = aux; 156 usb_config_descriptor_t *cdesc; 157 usb_interface_descriptor_t *id; 158 usb_endpoint_descriptor_t *ed; 159 struct wsmousedev_attach_args a; 160 int i; 161 162 sc->sc_udev = uaa->device; 163 sc->sc_product = uaa->product; 164 sc->sc_vendor = uaa->vendor; 165 sc->sc_intr_number = -1; 166 sc->sc_intr_pipe = NULL; 167 sc->sc_enabled = sc->sc_isize = 0; 168 169 /* Copy the default scalue values to each softc */ 170 bcopy(&def_scale, &sc->sc_tsscale, sizeof(sc->sc_tsscale)); 171 172 /* Move the device into the configured state. */ 173 if (usbd_set_config_index(uaa->device, UTS_CONFIG_INDEX, 1) != 0) { 174 printf("%s: could not set configuartion no\n", 175 sc->sc_dev.dv_xname); 176 sc->sc_dying = 1; 177 return; 178 } 179 180 /* get the config descriptor */ 181 cdesc = usbd_get_config_descriptor(sc->sc_udev); 182 if (cdesc == NULL) { 183 printf("%s: failed to get configuration descriptor\n", 184 sc->sc_dev.dv_xname); 185 sc->sc_dying = 1; 186 return; 187 } 188 189 /* get the interface */ 190 if (usbd_device2interface_handle(uaa->device, 0, &sc->sc_iface) != 0) { 191 printf("%s: failed to get interface\n", 192 sc->sc_dev.dv_xname); 193 sc->sc_dying = 1; 194 return; 195 } 196 197 /* Find the interrupt endpoint */ 198 id = usbd_get_interface_descriptor(sc->sc_iface); 199 sc->sc_iface_number = id->bInterfaceNumber; 200 201 for (i = 0; i < id->bNumEndpoints; i++) { 202 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 203 if (ed == NULL) { 204 printf("%s: no endpoint descriptor for %d\n", 205 sc->sc_dev.dv_xname, i); 206 sc->sc_dying = 1; 207 return; 208 } 209 210 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 211 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { 212 sc->sc_intr_number = ed->bEndpointAddress; 213 sc->sc_isize = UGETW(ed->wMaxPacketSize); 214 } 215 } 216 217 if (sc->sc_intr_number== -1) { 218 printf("%s: Could not find interrupt in\n", 219 sc->sc_dev.dv_xname); 220 sc->sc_dying = 1; 221 return; 222 } 223 224 a.accessops = &uts_accessops; 225 a.accesscookie = sc; 226 227 sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint); 228 } 229 230 int 231 uts_detach(struct device *self, int flags) 232 { 233 struct uts_softc *sc = (struct uts_softc *)self; 234 int rv = 0; 235 236 if (sc->sc_intr_pipe != NULL) { 237 usbd_abort_pipe(sc->sc_intr_pipe); 238 usbd_close_pipe(sc->sc_intr_pipe); 239 sc->sc_intr_pipe = NULL; 240 } 241 242 if (sc->sc_wsmousedev != NULL) { 243 rv = config_detach(sc->sc_wsmousedev, flags); 244 sc->sc_wsmousedev = NULL; 245 } 246 247 return (rv); 248 } 249 250 int 251 uts_activate(struct device *self, int act) 252 { 253 struct uts_softc *sc = (struct uts_softc *)self; 254 int rv = 0; 255 256 switch (act) { 257 case DVACT_DEACTIVATE: 258 if (sc->sc_wsmousedev != NULL) 259 rv = config_deactivate(sc->sc_wsmousedev); 260 sc->sc_dying = 1; 261 break; 262 } 263 264 return (rv); 265 } 266 267 int 268 uts_enable(void *v) 269 { 270 struct uts_softc *sc = v; 271 int err; 272 273 if (sc->sc_dying) 274 return (EIO); 275 276 if (sc->sc_enabled) 277 return (EBUSY); 278 279 if (sc->sc_isize == 0) 280 return (0); 281 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK); 282 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_intr_number, 283 USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_ibuf, 284 sc->sc_isize, uts_intr, USBD_DEFAULT_INTERVAL); 285 if (err) { 286 free(sc->sc_ibuf, M_USBDEV); 287 sc->sc_intr_pipe = NULL; 288 return (EIO); 289 } 290 291 sc->sc_enabled = 1; 292 sc->sc_buttons = 0; 293 294 return (0); 295 } 296 297 void 298 uts_disable(void *v) 299 { 300 struct uts_softc *sc = v; 301 302 if (!sc->sc_enabled) { 303 printf("uts_disable: already disabled!\n"); 304 return; 305 } 306 307 /* Disable interrupts. */ 308 if (sc->sc_intr_pipe != NULL) { 309 usbd_abort_pipe(sc->sc_intr_pipe); 310 usbd_close_pipe(sc->sc_intr_pipe); 311 sc->sc_intr_pipe = NULL; 312 } 313 314 if (sc->sc_ibuf != NULL) { 315 free(sc->sc_ibuf, M_USBDEV); 316 sc->sc_ibuf = NULL; 317 } 318 319 sc->sc_enabled = 0; 320 } 321 322 int 323 uts_ioctl(void *v, u_long cmd, caddr_t data, int flag, struct proc *l) 324 { 325 int error = 0; 326 struct uts_softc *sc = v; 327 struct wsmouse_calibcoords *wsmc = (struct wsmouse_calibcoords *)data; 328 329 DPRINTF(("uts_ioctl(%d, '%c', %d)\n", 330 IOCPARM_LEN(cmd), IOCGROUP(cmd), cmd & 0xff)); 331 332 switch (cmd) { 333 case WSMOUSEIO_SCALIBCOORDS: 334 if (!(wsmc->minx >= 0 && wsmc->maxx >= 0 && 335 wsmc->miny >= 0 && wsmc->maxy >= 0 && 336 wsmc->resx >= 0 && wsmc->resy >= 0 && 337 wsmc->minx < 32768 && wsmc->maxx < 32768 && 338 wsmc->miny < 32768 && wsmc->maxy < 32768 && 339 (wsmc->maxx - wsmc->minx) != 0 && 340 (wsmc->maxy - wsmc->miny) != 0 && 341 wsmc->resx < 32768 && wsmc->resy < 32768 && 342 wsmc->swapxy >= 0 && wsmc->swapxy <= 1 && 343 wsmc->samplelen >= 0 && wsmc->samplelen <= 1)) 344 return (EINVAL); 345 346 sc->sc_tsscale.minx = wsmc->minx; 347 sc->sc_tsscale.maxx = wsmc->maxx; 348 sc->sc_tsscale.miny = wsmc->miny; 349 sc->sc_tsscale.maxy = wsmc->maxy; 350 sc->sc_tsscale.swapxy = wsmc->swapxy; 351 sc->sc_tsscale.resx = wsmc->resx; 352 sc->sc_tsscale.resy = wsmc->resy; 353 sc->sc_rawmode = wsmc->samplelen; 354 break; 355 case WSMOUSEIO_GCALIBCOORDS: 356 wsmc->minx = sc->sc_tsscale.minx; 357 wsmc->maxx = sc->sc_tsscale.maxx; 358 wsmc->miny = sc->sc_tsscale.miny; 359 wsmc->maxy = sc->sc_tsscale.maxy; 360 wsmc->swapxy = sc->sc_tsscale.swapxy; 361 wsmc->resx = sc->sc_tsscale.resx; 362 wsmc->resy = sc->sc_tsscale.resy; 363 wsmc->samplelen = sc->sc_rawmode; 364 break; 365 case WSMOUSEIO_GTYPE: 366 *(u_int *)data = WSMOUSE_TYPE_TPANEL; 367 break; 368 default: 369 error = ENOTTY; 370 break; 371 } 372 373 return (error); 374 } 375 376 void 377 uts_get_pos(void *addr, struct uts_pos *tp) 378 { 379 struct uts_softc *sc = addr; 380 u_char *p = sc->sc_ibuf; 381 int down, x, y, z; 382 383 switch (sc->sc_product) { 384 case USB_PRODUCT_FTDI_ITM_TOUCH: 385 down = (~p[7] & 0x20); 386 x = ((p[0] & 0x1f) << 7) | (p[3] & 0x7f); 387 /* Invert the Y coordinate */ 388 y = 0x0fff - abs(((p[1] & 0x1f) << 7) | (p[4] & 0x7f)); 389 z = ((p[2] & 0x1) << 7) | (p[5] & 0x7f); 390 sc->sc_pkts = 0x8; 391 break; 392 case USB_PRODUCT_EGALAX_TPANEL: 393 case USB_PRODUCT_EGALAX_TPANEL2: 394 /* 395 * eGalax and Gunze USB touch panels have the same device ID, 396 * so decide upon the vendor ID. 397 */ 398 switch (sc->sc_vendor) { 399 case USB_VENDOR_EGALAX: 400 down = (p[0] & 0x01); 401 /* Invert the X coordinate */ 402 x = 0x07ff - abs(((p[3] & 0x0f) << 7) | (p[4] & 0x7f)); 403 y = ((p[1] & 0x0f) << 7) | (p[2] & 0x7f); 404 z = down; 405 sc->sc_pkts = 0x5; 406 break; 407 case USB_VENDOR_GUNZE: 408 down = (~p[7] & 0x20); 409 /* Invert the X coordinate */ 410 x = 0x0fff - abs(((p[0] & 0x1f) << 7) | (p[2] & 0x7f)); 411 y = ((p[1] & 0x1f) << 7) | (p[3] & 0x7f); 412 z = (down != 0); 413 sc->sc_pkts = 0x4; 414 break; 415 } 416 break; 417 } 418 419 DPRINTF(("%s: down = 0x%x, sc->sc_pkts = 0x%x\n", 420 sc->sc_dev.dv_xname, down, sc->sc_pkts)); 421 422 /* x/y values are not reliable if there is no pressure */ 423 if (down) { 424 if (sc->sc_tsscale.swapxy && !sc->sc_rawmode) { 425 /* Swap X/Y-Axis */ 426 tp->y = x; 427 tp->x = y; 428 } else { 429 tp->x = x; 430 tp->y = y; 431 } 432 if (!sc->sc_rawmode && 433 (sc->sc_tsscale.maxx - sc->sc_tsscale.minx) != 0 && 434 (sc->sc_tsscale.maxy - sc->sc_tsscale.miny) != 0) { 435 /* Scale down to the screen resolution. */ 436 tp->x = ((tp->x - sc->sc_tsscale.minx) * 437 sc->sc_tsscale.resx) / 438 (sc->sc_tsscale.maxx - sc->sc_tsscale.minx); 439 tp->y = ((tp->y - sc->sc_tsscale.miny) * 440 sc->sc_tsscale.resy) / 441 (sc->sc_tsscale.maxy - sc->sc_tsscale.miny); 442 } 443 } else { 444 tp->x = sc->sc_oldx; 445 tp->y = sc->sc_oldy; 446 } 447 tp->z = z; 448 tp->down = down; 449 } 450 451 void 452 uts_intr(struct usbd_xfer *xfer, void *addr, usbd_status status) 453 { 454 struct uts_softc *sc = addr; 455 u_int32_t len; 456 int s; 457 struct uts_pos tp; 458 459 if (status == USBD_CANCELLED) 460 return; 461 462 if (status != USBD_NORMAL_COMPLETION) { 463 printf("%s: status %d\n", sc->sc_dev.dv_xname, status); 464 if (status == USBD_STALLED) 465 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe); 466 return; 467 } 468 469 usbd_get_xfer_status(xfer, NULL, NULL, &len, NULL); 470 471 s = spltty(); 472 473 uts_get_pos(sc, &tp); 474 475 if (len != sc->sc_pkts) { 476 DPRINTF(("%s: bad input length %d != %d\n", 477 sc->sc_dev.dv_xname, len, sc->sc_isize)); 478 splx(s); 479 return; 480 } 481 482 DPRINTF(("%s: tp.down = %d, tp.z = %d, tp.x = %d, tp.y = %d\n", 483 sc->sc_dev.dv_xname, tp.down, tp.z, tp.x, tp.y)); 484 485 wsmouse_input(sc->sc_wsmousedev, tp.down, tp.x, tp.y, tp.z, 0, 486 WSMOUSE_INPUT_ABSOLUTE_X | WSMOUSE_INPUT_ABSOLUTE_Y | 487 WSMOUSE_INPUT_ABSOLUTE_Z); 488 sc->sc_oldy = tp.y; 489 sc->sc_oldx = tp.x; 490 491 splx(s); 492 } 493