uep.c revision 1.4.2.3
1 /* $NetBSD: uep.c,v 1.4.2.3 2007/09/03 14:39:11 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.3 2007/09/03 14:39:11 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 USB_DECLARE_DRIVER(uep); 109 110 USB_MATCH(uep) 111 { 112 USB_MATCH_START(uep, uaa); 113 114 if ((uaa->vendor == USB_VENDOR_EGALAX) && ( 115 (uaa->product == USB_PRODUCT_EGALAX_TPANEL) 116 || (uaa->product == USB_PRODUCT_EGALAX_TPANEL2) 117 )) 118 return UMATCH_VENDOR_PRODUCT; 119 120 if ((uaa->vendor == USB_VENDOR_EGALAX2) 121 && (uaa->product == USB_PRODUCT_EGALAX2_TPANEL)) 122 return UMATCH_VENDOR_PRODUCT; 123 124 125 return UMATCH_NONE; 126 } 127 128 USB_ATTACH(uep) 129 { 130 USB_ATTACH_START(uep, sc, uaa); 131 usbd_device_handle dev = uaa->device; 132 usb_config_descriptor_t *cdesc; 133 usb_interface_descriptor_t *id; 134 usb_endpoint_descriptor_t *ed; 135 struct wsmousedev_attach_args a; 136 char *devinfop; 137 usbd_status err; 138 int i, found; 139 140 devinfop = usbd_devinfo_alloc(dev, 0); 141 USB_ATTACH_SETUP; 142 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfop); 143 usbd_devinfo_free(devinfop); 144 145 sc->sc_udev = dev; 146 sc->sc_intr_number = -1; 147 sc->sc_intr_pipe = NULL; 148 sc->sc_enabled = sc->sc_isize = 0; 149 150 /* Move the device into the configured state. */ 151 err = usbd_set_config_index(dev, 0, 1); 152 if (err) { 153 printf("\n%s: failed to set configuration, err=%s\n", 154 USBDEVNAME(sc->sc_dev), usbd_errstr(err)); 155 sc->sc_dying = 1; 156 USB_ATTACH_ERROR_RETURN; 157 } 158 159 /* get the config descriptor */ 160 cdesc = usbd_get_config_descriptor(sc->sc_udev); 161 if (cdesc == NULL) { 162 printf("%s: failed to get configuration descriptor\n", 163 USBDEVNAME(sc->sc_dev)); 164 sc->sc_dying = 1; 165 USB_ATTACH_ERROR_RETURN; 166 } 167 168 /* get the interface */ 169 err = usbd_device2interface_handle(dev, 0, &sc->sc_iface); 170 if (err) { 171 printf("\n%s: failed to get interface, err=%s\n", 172 USBDEVNAME(sc->sc_dev), usbd_errstr(err)); 173 sc->sc_dying = 1; 174 USB_ATTACH_ERROR_RETURN; 175 } 176 177 /* Find the interrupt endpoint */ 178 id = usbd_get_interface_descriptor(sc->sc_iface); 179 sc->sc_iface_number = id->bInterfaceNumber; 180 found = 0; 181 182 for (i = 0; i < id->bNumEndpoints; i++) { 183 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 184 if (ed == NULL) { 185 printf("%s: no endpoint descriptor for %d\n", 186 USBDEVNAME(sc->sc_dev), i); 187 sc->sc_dying = 1; 188 USB_ATTACH_ERROR_RETURN; 189 } 190 191 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 192 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { 193 sc->sc_intr_number = ed->bEndpointAddress; 194 sc->sc_isize = UGETW(ed->wMaxPacketSize); 195 } 196 } 197 198 if (sc->sc_intr_number== -1) { 199 printf("%s: Could not find interrupt in\n", 200 USBDEVNAME(sc->sc_dev)); 201 sc->sc_dying = 1; 202 USB_ATTACH_ERROR_RETURN; 203 } 204 205 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 206 USBDEV(sc->sc_dev)); 207 208 a.accessops = &uep_accessops; 209 a.accesscookie = sc; 210 211 sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint); 212 213 tpcalib_init(&sc->sc_tpcalib); 214 tpcalib_ioctl(&sc->sc_tpcalib, WSMOUSEIO_SCALIBCOORDS, 215 (void *)&default_calib, 0, 0); 216 217 USB_ATTACH_SUCCESS_RETURN; 218 } 219 220 USB_DETACH(uep) 221 { 222 USB_DETACH_START(uep, sc); 223 int rv = 0; 224 225 if (sc->sc_intr_pipe != NULL) { 226 usbd_abort_pipe(sc->sc_intr_pipe); 227 usbd_close_pipe(sc->sc_intr_pipe); 228 sc->sc_intr_pipe = NULL; 229 } 230 231 sc->sc_dying = 1; 232 233 /* save current calib as defaults */ 234 default_calib = sc->sc_tpcalib.sc_saved; 235 236 if (sc->sc_wsmousedev != NULL) { 237 rv = config_detach(sc->sc_wsmousedev, flags); 238 sc->sc_wsmousedev = NULL; 239 } 240 241 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 242 USBDEV(sc->sc_dev)); 243 244 return rv; 245 } 246 247 int 248 uep_activate(device_ptr_t self, enum devact act) 249 { 250 struct uep_softc *sc = (struct uep_softc *)self; 251 int rv = 0; 252 253 switch (act) { 254 case DVACT_ACTIVATE: 255 return EOPNOTSUPP; 256 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 Static int 268 uep_enable(void *v) 269 { 270 struct uep_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, uep_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 293 return 0; 294 } 295 296 Static void 297 uep_disable(void *v) 298 { 299 struct uep_softc *sc = v; 300 301 if (!sc->sc_enabled) { 302 printf("uep_disable: already disabled!\n"); 303 return; 304 } 305 306 /* Disable interrupts. */ 307 if (sc->sc_intr_pipe != NULL) { 308 usbd_abort_pipe(sc->sc_intr_pipe); 309 usbd_close_pipe(sc->sc_intr_pipe); 310 sc->sc_intr_pipe = NULL; 311 } 312 313 if (sc->sc_ibuf != NULL) { 314 free(sc->sc_ibuf, M_USBDEV); 315 sc->sc_ibuf = NULL; 316 } 317 318 sc->sc_enabled = 0; 319 } 320 321 Static int 322 uep_ioctl(void *v, u_long cmd, void *data, int flag, struct lwp *l) 323 { 324 struct uep_softc *sc = v; 325 struct wsmouse_id *id; 326 327 switch (cmd) { 328 case WSMOUSEIO_GTYPE: 329 *(u_int *)data = WSMOUSE_TYPE_TPANEL; 330 return 0; 331 332 case WSMOUSEIO_GETID: 333 /* 334 * return unique ID string 335 * "<vendor> <model> <serial number>" 336 * unfortunately we have no serial number... 337 */ 338 id = (struct wsmouse_id *)data; 339 if (id->type != WSMOUSE_ID_TYPE_UIDSTR) 340 return EINVAL; 341 342 strcpy(id->data, UIDSTR); 343 id->length = strlen(UIDSTR); 344 return 0; 345 346 case WSMOUSEIO_SCALIBCOORDS: 347 case WSMOUSEIO_GCALIBCOORDS: 348 return tpcalib_ioctl(&sc->sc_tpcalib, cmd, data, flag, l); 349 } 350 351 return EPASSTHROUGH; 352 } 353 354 void 355 uep_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status) 356 { 357 struct uep_softc *sc = addr; 358 u_char *p = sc->sc_ibuf; 359 u_int32_t len; 360 int x = 0, y = 0, s; 361 362 usbd_get_xfer_status(xfer, NULL, NULL, &len, NULL); 363 364 if (status == USBD_CANCELLED) 365 return; 366 367 if (status != USBD_NORMAL_COMPLETION) { 368 printf("%s: status %d\n", USBDEVNAME(sc->sc_dev), status); 369 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe); 370 return; 371 } 372 373 if (len != 5) { 374 #if 0 375 printf("%s: bad input length %d != %d\n", 376 USBDEVNAME(sc->sc_dev), len, sc->sc_isize); 377 #endif 378 return; 379 } 380 381 if ((p[0] & 0xFE) != 0x80) { 382 printf("%s: bad input packet format\n", USBDEVNAME(sc->sc_dev)); 383 return; 384 } 385 386 if (sc->sc_wsmousedev != NULL) { 387 /* 388 * Packet format is 5 bytes: 389 * 390 * 1000000T 391 * 0000AAAA 392 * 0AAAAAAA 393 * 0000BBBB 394 * 0BBBBBBB 395 * 396 * T: 1=touched 0=not touched 397 * A: bits of axis A position, MSB to LSB 398 * B: bits of axis B position, MSB to LSB 399 * 400 * For the unit I have, A = Y and B = X. 401 * I don't know if units exist with A=X and B=Y, 402 * if so we'll cross that bridge when we come to it. 403 * 404 * The controller sends a stream of T=1 events while the 405 * panel is touched, followed by a single T=0 event. 406 * 407 */ 408 409 x = (p[3] << 7) | p[4]; 410 y = (p[1] << 7) | p[2]; 411 412 tpcalib_trans(&sc->sc_tpcalib, x, y, &x, &y); 413 414 s = spltty(); 415 wsmouse_input(sc->sc_wsmousedev, p[0] & 0x01, x, y, 0, 0, 416 WSMOUSE_INPUT_ABSOLUTE_X | WSMOUSE_INPUT_ABSOLUTE_Y); 417 splx(s); 418 } 419 } 420
Indexes created Tue Oct 07 21:09:53 GMT 2025