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