uep.c revision 1.4.2.4
1 /* $NetBSD: uep.c,v 1.4.2.4 2008/02/27 08:36:47 yamt 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.4.2.4 2008/02/27 08:36:47 yamt 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, void *, int, struct lwp *); 101 102 const struct wsmouse_accessops uep_accessops = { 103 uep_enable, 104 uep_ioctl, 105 uep_disable, 106 }; 107 108 int uep_match(device_t, struct cfdata *, void *); 109 void uep_attach(device_t, device_t, void *); 110 void uep_childdet(device_t, device_t); 111 int uep_detach(device_t, int); 112 int uep_activate(device_t, enum devact); 113 extern struct cfdriver uep_cd; 114 CFATTACH_DECL2(uep, sizeof(struct uep_softc), uep_match, uep_attach, 115 uep_detach, uep_activate, NULL, uep_childdet); 116 117 USB_MATCH(uep) 118 { 119 USB_MATCH_START(uep, uaa); 120 121 if ((uaa->vendor == USB_VENDOR_EGALAX) && ( 122 (uaa->product == USB_PRODUCT_EGALAX_TPANEL) 123 || (uaa->product == USB_PRODUCT_EGALAX_TPANEL2) 124 )) 125 return UMATCH_VENDOR_PRODUCT; 126 127 if ((uaa->vendor == USB_VENDOR_EGALAX2) 128 && (uaa->product == USB_PRODUCT_EGALAX2_TPANEL)) 129 return UMATCH_VENDOR_PRODUCT; 130 131 132 return UMATCH_NONE; 133 } 134 135 USB_ATTACH(uep) 136 { 137 USB_ATTACH_START(uep, sc, uaa); 138 usbd_device_handle dev = uaa->device; 139 usb_config_descriptor_t *cdesc; 140 usb_interface_descriptor_t *id; 141 usb_endpoint_descriptor_t *ed; 142 struct wsmousedev_attach_args a; 143 char *devinfop; 144 usbd_status err; 145 int i, found; 146 147 devinfop = usbd_devinfo_alloc(dev, 0); 148 USB_ATTACH_SETUP; 149 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), 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 printf("\n%s: failed to set configuration, err=%s\n", 161 USBDEVNAME(sc->sc_dev), usbd_errstr(err)); 162 sc->sc_dying = 1; 163 USB_ATTACH_ERROR_RETURN; 164 } 165 166 /* get the config descriptor */ 167 cdesc = usbd_get_config_descriptor(sc->sc_udev); 168 if (cdesc == NULL) { 169 printf("%s: failed to get configuration descriptor\n", 170 USBDEVNAME(sc->sc_dev)); 171 sc->sc_dying = 1; 172 USB_ATTACH_ERROR_RETURN; 173 } 174 175 /* get the interface */ 176 err = usbd_device2interface_handle(dev, 0, &sc->sc_iface); 177 if (err) { 178 printf("\n%s: failed to get interface, err=%s\n", 179 USBDEVNAME(sc->sc_dev), usbd_errstr(err)); 180 sc->sc_dying = 1; 181 USB_ATTACH_ERROR_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 printf("%s: no endpoint descriptor for %d\n", 193 USBDEVNAME(sc->sc_dev), i); 194 sc->sc_dying = 1; 195 USB_ATTACH_ERROR_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 printf("%s: Could not find interrupt in\n", 207 USBDEVNAME(sc->sc_dev)); 208 sc->sc_dying = 1; 209 USB_ATTACH_ERROR_RETURN; 210 } 211 212 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 213 USBDEV(sc->sc_dev)); 214 215 a.accessops = &uep_accessops; 216 a.accesscookie = sc; 217 218 sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint); 219 220 tpcalib_init(&sc->sc_tpcalib); 221 tpcalib_ioctl(&sc->sc_tpcalib, WSMOUSEIO_SCALIBCOORDS, 222 (void *)&default_calib, 0, 0); 223 224 USB_ATTACH_SUCCESS_RETURN; 225 } 226 227 USB_DETACH(uep) 228 { 229 USB_DETACH_START(uep, sc); 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 USBDEV(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 int rv = 0; 266 267 switch (act) { 268 case DVACT_ACTIVATE: 269 return EOPNOTSUPP; 270 271 case DVACT_DEACTIVATE: 272 if (sc->sc_wsmousedev != NULL) 273 rv = config_deactivate(sc->sc_wsmousedev); 274 sc->sc_dying = 1; 275 break; 276 } 277 278 return rv; 279 } 280 281 Static int 282 uep_enable(void *v) 283 { 284 struct uep_softc *sc = v; 285 int err; 286 287 if (sc->sc_dying) 288 return EIO; 289 290 if (sc->sc_enabled) 291 return EBUSY; 292 293 if (sc->sc_isize == 0) 294 return 0; 295 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK); 296 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_intr_number, 297 USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_ibuf, 298 sc->sc_isize, uep_intr, USBD_DEFAULT_INTERVAL); 299 if (err) { 300 free(sc->sc_ibuf, M_USBDEV); 301 sc->sc_intr_pipe = NULL; 302 return EIO; 303 } 304 305 sc->sc_enabled = 1; 306 307 return 0; 308 } 309 310 Static void 311 uep_disable(void *v) 312 { 313 struct uep_softc *sc = v; 314 315 if (!sc->sc_enabled) { 316 printf("uep_disable: already disabled!\n"); 317 return; 318 } 319 320 /* Disable interrupts. */ 321 if (sc->sc_intr_pipe != NULL) { 322 usbd_abort_pipe(sc->sc_intr_pipe); 323 usbd_close_pipe(sc->sc_intr_pipe); 324 sc->sc_intr_pipe = NULL; 325 } 326 327 if (sc->sc_ibuf != NULL) { 328 free(sc->sc_ibuf, M_USBDEV); 329 sc->sc_ibuf = NULL; 330 } 331 332 sc->sc_enabled = 0; 333 } 334 335 Static int 336 uep_ioctl(void *v, u_long cmd, void *data, int flag, struct lwp *l) 337 { 338 struct uep_softc *sc = v; 339 struct wsmouse_id *id; 340 341 switch (cmd) { 342 case WSMOUSEIO_GTYPE: 343 *(u_int *)data = WSMOUSE_TYPE_TPANEL; 344 return 0; 345 346 case WSMOUSEIO_GETID: 347 /* 348 * return unique ID string 349 * "<vendor> <model> <serial number>" 350 * unfortunately we have no serial number... 351 */ 352 id = (struct wsmouse_id *)data; 353 if (id->type != WSMOUSE_ID_TYPE_UIDSTR) 354 return EINVAL; 355 356 strcpy(id->data, UIDSTR); 357 id->length = strlen(UIDSTR); 358 return 0; 359 360 case WSMOUSEIO_SCALIBCOORDS: 361 case WSMOUSEIO_GCALIBCOORDS: 362 return tpcalib_ioctl(&sc->sc_tpcalib, cmd, data, flag, l); 363 } 364 365 return EPASSTHROUGH; 366 } 367 368 void 369 uep_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status) 370 { 371 struct uep_softc *sc = addr; 372 u_char *p = sc->sc_ibuf; 373 u_int32_t len; 374 int x = 0, y = 0, s; 375 376 usbd_get_xfer_status(xfer, NULL, NULL, &len, NULL); 377 378 if (status == USBD_CANCELLED) 379 return; 380 381 if (status != USBD_NORMAL_COMPLETION) { 382 printf("%s: status %d\n", USBDEVNAME(sc->sc_dev), status); 383 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe); 384 return; 385 } 386 387 if (len != 5) { 388 #if 0 389 printf("%s: bad input length %d != %d\n", 390 USBDEVNAME(sc->sc_dev), len, sc->sc_isize); 391 #endif 392 return; 393 } 394 395 if ((p[0] & 0xFE) != 0x80) { 396 printf("%s: bad input packet format\n", USBDEVNAME(sc->sc_dev)); 397 return; 398 } 399 400 if (sc->sc_wsmousedev != NULL) { 401 /* 402 * Packet format is 5 bytes: 403 * 404 * 1000000T 405 * 0000AAAA 406 * 0AAAAAAA 407 * 0000BBBB 408 * 0BBBBBBB 409 * 410 * T: 1=touched 0=not touched 411 * A: bits of axis A position, MSB to LSB 412 * B: bits of axis B position, MSB to LSB 413 * 414 * For the unit I have, A = Y and B = X. 415 * I don't know if units exist with A=X and B=Y, 416 * if so we'll cross that bridge when we come to it. 417 * 418 * The controller sends a stream of T=1 events while the 419 * panel is touched, followed by a single T=0 event. 420 * 421 */ 422 423 x = (p[3] << 7) | p[4]; 424 y = (p[1] << 7) | p[2]; 425 426 tpcalib_trans(&sc->sc_tpcalib, x, y, &x, &y); 427 428 s = spltty(); 429 wsmouse_input(sc->sc_wsmousedev, p[0] & 0x01, x, y, 0, 0, 430 WSMOUSE_INPUT_ABSOLUTE_X | WSMOUSE_INPUT_ABSOLUTE_Y); 431 splx(s); 432 } 433 } 434
Indexes created Tue Oct 07 21:09:53 GMT 2025