uep.c revision 1.15
1 /* $NetBSD: uep.c,v 1.15 2010/11/03 22:34:23 dyoung Exp $ */ 2 3 /* 4 * Copyright (c) 2004 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Tyler C. Sarna (tsarna (at) netbsd.org). 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /* 33 * eGalax USB touchpanel controller driver. 34 * 35 * For Programming Documentation, see: 36 * 37 * http://www.egalax.com/SoftwareProgrammingGuide_1.1.pdf 38 */ 39 40 #include <sys/cdefs.h> 41 __KERNEL_RCSID(0, "$NetBSD: uep.c,v 1.15 2010/11/03 22:34:23 dyoung Exp $"); 42 43 #include <sys/param.h> 44 #include <sys/systm.h> 45 #include <sys/kernel.h> 46 #include <sys/malloc.h> 47 #include <sys/device.h> 48 #include <sys/ioctl.h> 49 #include <sys/vnode.h> 50 51 #include <dev/usb/usb.h> 52 #include <dev/usb/usbdi.h> 53 #include <dev/usb/usbdi_util.h> 54 #include <dev/usb/usbdevs.h> 55 #include <dev/usb/usb_quirks.h> 56 57 #include <dev/wscons/wsconsio.h> 58 #include <dev/wscons/wsmousevar.h> 59 #include <dev/wscons/tpcalibvar.h> 60 61 #define UIDSTR "eGalax USB SN000000" 62 63 struct uep_softc { 64 device_t sc_dev; 65 usbd_device_handle sc_udev; /* device */ 66 usbd_interface_handle sc_iface; /* interface */ 67 int sc_iface_number; 68 69 int sc_intr_number; /* interrupt number */ 70 usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */ 71 u_char *sc_ibuf; 72 int sc_isize; 73 74 device_t sc_wsmousedev; /* wsmouse device */ 75 struct tpcalib_softc sc_tpcalib; /* calibration */ 76 77 u_char sc_enabled; 78 u_char sc_dying; 79 }; 80 81 static struct wsmouse_calibcoords default_calib = { 82 .minx = 0, 83 .miny = 0, 84 .maxx = 2047, 85 .maxy = 2047, 86 .samplelen = WSMOUSE_CALIBCOORDS_RESET, 87 }; 88 89 Static void uep_intr(usbd_xfer_handle, usbd_private_handle, usbd_status); 90 91 Static int uep_enable(void *); 92 Static void uep_disable(void *); 93 Static int uep_ioctl(void *, u_long, void *, int, struct lwp *); 94 95 const struct wsmouse_accessops uep_accessops = { 96 uep_enable, 97 uep_ioctl, 98 uep_disable, 99 }; 100 101 int uep_match(device_t, cfdata_t, void *); 102 void uep_attach(device_t, device_t, void *); 103 void uep_childdet(device_t, device_t); 104 int uep_detach(device_t, int); 105 int uep_activate(device_t, enum devact); 106 extern struct cfdriver uep_cd; 107 CFATTACH_DECL2_NEW(uep, sizeof(struct uep_softc), uep_match, uep_attach, 108 uep_detach, uep_activate, NULL, uep_childdet); 109 110 int 111 uep_match(device_t parent, cfdata_t match, void *aux) 112 { 113 struct usb_attach_arg *uaa = aux; 114 115 if ((uaa->vendor == USB_VENDOR_EGALAX) && ( 116 (uaa->product == USB_PRODUCT_EGALAX_TPANEL) 117 || (uaa->product == USB_PRODUCT_EGALAX_TPANEL2) 118 )) 119 return UMATCH_VENDOR_PRODUCT; 120 121 if ((uaa->vendor == USB_VENDOR_EGALAX2) 122 && (uaa->product == USB_PRODUCT_EGALAX2_TPANEL)) 123 return UMATCH_VENDOR_PRODUCT; 124 125 126 return UMATCH_NONE; 127 } 128 129 void 130 uep_attach(device_t parent, device_t self, void *aux) 131 { 132 struct uep_softc *sc = device_private(self); 133 struct usb_attach_arg *uaa = aux; 134 usbd_device_handle dev = uaa->device; 135 usb_config_descriptor_t *cdesc; 136 usb_interface_descriptor_t *id; 137 usb_endpoint_descriptor_t *ed; 138 struct wsmousedev_attach_args a; 139 char *devinfop; 140 usbd_status err; 141 int i, found; 142 143 sc->sc_dev = self; 144 145 aprint_naive("\n"); 146 aprint_normal("\n"); 147 148 devinfop = usbd_devinfo_alloc(dev, 0); 149 aprint_normal_dev(self, "%s\n", devinfop); 150 usbd_devinfo_free(devinfop); 151 152 sc->sc_udev = dev; 153 sc->sc_intr_number = -1; 154 sc->sc_intr_pipe = NULL; 155 sc->sc_enabled = sc->sc_isize = 0; 156 157 /* Move the device into the configured state. */ 158 err = usbd_set_config_index(dev, 0, 1); 159 if (err) { 160 aprint_error("\n%s: failed to set configuration, err=%s\n", 161 device_xname(sc->sc_dev), usbd_errstr(err)); 162 sc->sc_dying = 1; 163 return; 164 } 165 166 /* get the config descriptor */ 167 cdesc = usbd_get_config_descriptor(sc->sc_udev); 168 if (cdesc == NULL) { 169 aprint_error_dev(self, 170 "failed to get configuration descriptor\n"); 171 sc->sc_dying = 1; 172 return; 173 } 174 175 /* get the interface */ 176 err = usbd_device2interface_handle(dev, 0, &sc->sc_iface); 177 if (err) { 178 aprint_error("\n%s: failed to get interface, err=%s\n", 179 device_xname(sc->sc_dev), usbd_errstr(err)); 180 sc->sc_dying = 1; 181 return; 182 } 183 184 /* Find the interrupt endpoint */ 185 id = usbd_get_interface_descriptor(sc->sc_iface); 186 sc->sc_iface_number = id->bInterfaceNumber; 187 found = 0; 188 189 for (i = 0; i < id->bNumEndpoints; i++) { 190 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 191 if (ed == NULL) { 192 aprint_error_dev(self, 193 "no endpoint descriptor for %d\n", i); 194 sc->sc_dying = 1; 195 return; 196 } 197 198 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 199 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { 200 sc->sc_intr_number = ed->bEndpointAddress; 201 sc->sc_isize = UGETW(ed->wMaxPacketSize); 202 } 203 } 204 205 if (sc->sc_intr_number== -1) { 206 aprint_error_dev(self, "Could not find interrupt in\n"); 207 sc->sc_dying = 1; 208 return; 209 } 210 211 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 212 sc->sc_dev); 213 214 a.accessops = &uep_accessops; 215 a.accesscookie = sc; 216 217 sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint); 218 219 tpcalib_init(&sc->sc_tpcalib); 220 tpcalib_ioctl(&sc->sc_tpcalib, WSMOUSEIO_SCALIBCOORDS, 221 (void *)&default_calib, 0, 0); 222 223 return; 224 } 225 226 int 227 uep_detach(device_t self, int flags) 228 { 229 struct uep_softc *sc = device_private(self); 230 int rv = 0; 231 232 if (sc->sc_intr_pipe != NULL) { 233 usbd_abort_pipe(sc->sc_intr_pipe); 234 usbd_close_pipe(sc->sc_intr_pipe); 235 sc->sc_intr_pipe = NULL; 236 } 237 238 sc->sc_dying = 1; 239 240 /* save current calib as defaults */ 241 default_calib = sc->sc_tpcalib.sc_saved; 242 243 if (sc->sc_wsmousedev != NULL) 244 rv = config_detach(sc->sc_wsmousedev, flags); 245 246 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 247 sc->sc_dev); 248 249 return rv; 250 } 251 252 void 253 uep_childdet(device_t self, device_t child) 254 { 255 struct uep_softc *sc = device_private(self); 256 257 KASSERT(sc->sc_wsmousedev == child); 258 sc->sc_wsmousedev = NULL; 259 } 260 261 int 262 uep_activate(device_t self, enum devact act) 263 { 264 struct uep_softc *sc = device_private(self); 265 266 switch (act) { 267 case DVACT_DEACTIVATE: 268 sc->sc_dying = 1; 269 return 0; 270 default: 271 return EOPNOTSUPP; 272 } 273 } 274 275 Static int 276 uep_enable(void *v) 277 { 278 struct uep_softc *sc = v; 279 int err; 280 281 if (sc->sc_dying) 282 return EIO; 283 284 if (sc->sc_enabled) 285 return EBUSY; 286 287 if (sc->sc_isize == 0) 288 return 0; 289 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK); 290 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_intr_number, 291 USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_ibuf, 292 sc->sc_isize, uep_intr, USBD_DEFAULT_INTERVAL); 293 if (err) { 294 free(sc->sc_ibuf, M_USBDEV); 295 sc->sc_intr_pipe = NULL; 296 return EIO; 297 } 298 299 sc->sc_enabled = 1; 300 301 return 0; 302 } 303 304 Static void 305 uep_disable(void *v) 306 { 307 struct uep_softc *sc = v; 308 309 if (!sc->sc_enabled) { 310 printf("uep_disable: already disabled!\n"); 311 return; 312 } 313 314 /* Disable interrupts. */ 315 if (sc->sc_intr_pipe != NULL) { 316 usbd_abort_pipe(sc->sc_intr_pipe); 317 usbd_close_pipe(sc->sc_intr_pipe); 318 sc->sc_intr_pipe = NULL; 319 } 320 321 if (sc->sc_ibuf != NULL) { 322 free(sc->sc_ibuf, M_USBDEV); 323 sc->sc_ibuf = NULL; 324 } 325 326 sc->sc_enabled = 0; 327 } 328 329 Static int 330 uep_ioctl(void *v, u_long cmd, void *data, int flag, struct lwp *l) 331 { 332 struct uep_softc *sc = v; 333 struct wsmouse_id *id; 334 335 switch (cmd) { 336 case WSMOUSEIO_GTYPE: 337 *(u_int *)data = WSMOUSE_TYPE_TPANEL; 338 return 0; 339 340 case WSMOUSEIO_GETID: 341 /* 342 * return unique ID string 343 * "<vendor> <model> <serial number>" 344 * unfortunately we have no serial number... 345 */ 346 id = (struct wsmouse_id *)data; 347 if (id->type != WSMOUSE_ID_TYPE_UIDSTR) 348 return EINVAL; 349 350 strcpy(id->data, UIDSTR); 351 id->length = strlen(UIDSTR); 352 return 0; 353 354 case WSMOUSEIO_SCALIBCOORDS: 355 case WSMOUSEIO_GCALIBCOORDS: 356 return tpcalib_ioctl(&sc->sc_tpcalib, cmd, data, flag, l); 357 } 358 359 return EPASSTHROUGH; 360 } 361 362 void 363 uep_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status) 364 { 365 struct uep_softc *sc = addr; 366 u_char *p = sc->sc_ibuf; 367 u_int32_t len; 368 int x = 0, y = 0, s; 369 370 usbd_get_xfer_status(xfer, NULL, NULL, &len, NULL); 371 372 if (status == USBD_CANCELLED) 373 return; 374 375 if (status != USBD_NORMAL_COMPLETION) { 376 aprint_error_dev(sc->sc_dev, "status %d\n", status); 377 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe); 378 return; 379 } 380 381 if (len != 5) { 382 #if 0 383 printf("%s: bad input length %d != %d\n", 384 device_xname(sc->sc_dev), len, sc->sc_isize); 385 #endif 386 return; 387 } 388 389 if ((p[0] & 0xFE) != 0x80) { 390 aprint_error_dev(sc->sc_dev, 391 "bad input packet format\n"); 392 return; 393 } 394 395 if (sc->sc_wsmousedev != NULL) { 396 /* 397 * Packet format is 5 bytes: 398 * 399 * 1000000T 400 * 0000AAAA 401 * 0AAAAAAA 402 * 0000BBBB 403 * 0BBBBBBB 404 * 405 * T: 1=touched 0=not touched 406 * A: bits of axis A position, MSB to LSB 407 * B: bits of axis B position, MSB to LSB 408 * 409 * For the unit I have, A = Y and B = X. 410 * I don't know if units exist with A=X and B=Y, 411 * if so we'll cross that bridge when we come to it. 412 * 413 * The controller sends a stream of T=1 events while the 414 * panel is touched, followed by a single T=0 event. 415 * 416 */ 417 418 x = (p[3] << 7) | p[4]; 419 y = (p[1] << 7) | p[2]; 420 421 tpcalib_trans(&sc->sc_tpcalib, x, y, &x, &y); 422 423 s = spltty(); 424 wsmouse_input(sc->sc_wsmousedev, p[0] & 0x01, x, y, 0, 0, 425 WSMOUSE_INPUT_ABSOLUTE_X | WSMOUSE_INPUT_ABSOLUTE_Y); 426 splx(s); 427 } 428 } 429
Indexes created Tue Oct 07 21:09:53 GMT 2025