ums.c revision 1.70
1 /* $NetBSD: ums.c,v 1.70 2007/12/11 03:45:57 jmcneill Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart (at) augustsson.net) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf 42 */ 43 44 #include <sys/cdefs.h> 45 __KERNEL_RCSID(0, "$NetBSD: ums.c,v 1.70 2007/12/11 03:45:57 jmcneill Exp $"); 46 47 #include <sys/param.h> 48 #include <sys/systm.h> 49 #include <sys/kernel.h> 50 #include <sys/malloc.h> 51 #include <sys/device.h> 52 #include <sys/ioctl.h> 53 #include <sys/tty.h> 54 #include <sys/file.h> 55 #include <sys/select.h> 56 #include <sys/proc.h> 57 #include <sys/vnode.h> 58 #include <sys/poll.h> 59 60 #include <dev/usb/usb.h> 61 #include <dev/usb/usbhid.h> 62 63 #include <dev/usb/usbdi.h> 64 #include <dev/usb/usbdi_util.h> 65 #include <dev/usb/usbdevs.h> 66 #include <dev/usb/usb_quirks.h> 67 #include <dev/usb/uhidev.h> 68 #include <dev/usb/hid.h> 69 70 #include <dev/wscons/wsconsio.h> 71 #include <dev/wscons/wsmousevar.h> 72 73 #ifdef USB_DEBUG 74 #define DPRINTF(x) if (umsdebug) logprintf x 75 #define DPRINTFN(n,x) if (umsdebug>(n)) logprintf x 76 int umsdebug = 0; 77 #else 78 #define DPRINTF(x) 79 #define DPRINTFN(n,x) 80 #endif 81 82 #define UMS_BUT(i) ((i) == 1 || (i) == 2 ? 3 - (i) : i) 83 84 #define UMSUNIT(s) (minor(s)) 85 86 #define PS2LBUTMASK x01 87 #define PS2RBUTMASK x02 88 #define PS2MBUTMASK x04 89 #define PS2BUTMASK 0x0f 90 91 #define MAX_BUTTONS 31 /* must not exceed size of sc_buttons */ 92 93 struct ums_softc { 94 struct uhidev sc_hdev; 95 96 struct hid_location sc_loc_x, sc_loc_y, sc_loc_z, sc_loc_w; 97 struct hid_location sc_loc_btn[MAX_BUTTONS]; 98 99 int sc_enabled; 100 101 int flags; /* device configuration */ 102 #define UMS_Z 0x01 /* z direction available */ 103 #define UMS_SPUR_BUT_UP 0x02 /* spurious button up events */ 104 #define UMS_REVZ 0x04 /* Z-axis is reversed */ 105 106 int nbuttons; 107 108 u_int32_t sc_buttons; /* mouse button status */ 109 struct device *sc_wsmousedev; 110 111 char sc_dying; 112 }; 113 114 #define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE) 115 #define MOUSE_FLAGS (HIO_RELATIVE) 116 117 Static void ums_intr(struct uhidev *addr, void *ibuf, u_int len); 118 119 Static int ums_enable(void *); 120 Static void ums_disable(void *); 121 Static int ums_ioctl(void *, u_long, void *, int, struct lwp * ); 122 123 const struct wsmouse_accessops ums_accessops = { 124 ums_enable, 125 ums_ioctl, 126 ums_disable, 127 }; 128 129 USB_DECLARE_DRIVER(ums); 130 131 int 132 ums_match(struct device *parent, struct cfdata *match, 133 void *aux) 134 { 135 struct uhidev_attach_arg *uha = aux; 136 int size; 137 void *desc; 138 139 uhidev_get_report_desc(uha->parent, &desc, &size); 140 if (!hid_is_collection(desc, size, uha->reportid, 141 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE))) 142 return (UMATCH_NONE); 143 144 return (UMATCH_IFACECLASS); 145 } 146 147 void 148 ums_attach(struct device *parent, struct device *self, void *aux) 149 { 150 struct ums_softc *sc = (struct ums_softc *)self; 151 struct uhidev_attach_arg *uha = aux; 152 struct wsmousedev_attach_args a; 153 int size; 154 void *desc; 155 u_int32_t flags, quirks; 156 int i, wheel; 157 struct hid_location loc_btn; 158 159 aprint_naive("\n"); 160 161 sc->sc_hdev.sc_intr = ums_intr; 162 sc->sc_hdev.sc_parent = uha->parent; 163 sc->sc_hdev.sc_report_id = uha->reportid; 164 165 quirks = usbd_get_quirks(uha->parent->sc_udev)->uq_flags; 166 if (quirks & UQ_MS_REVZ) 167 sc->flags |= UMS_REVZ; 168 if (quirks & UQ_SPUR_BUT_UP) 169 sc->flags |= UMS_SPUR_BUT_UP; 170 171 uhidev_get_report_desc(uha->parent, &desc, &size); 172 173 if (!pmf_device_register(self, NULL, NULL)) 174 aprint_error_dev(self, "couldn't establish power handler\n"); 175 176 if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X), 177 uha->reportid, hid_input, &sc->sc_loc_x, &flags)) { 178 aprint_error("\n%s: mouse has no X report\n", 179 USBDEVNAME(sc->sc_hdev.sc_dev)); 180 USB_ATTACH_ERROR_RETURN; 181 } 182 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) { 183 aprint_error("\n%s: X report 0x%04x not supported\n", 184 USBDEVNAME(sc->sc_hdev.sc_dev), flags); 185 USB_ATTACH_ERROR_RETURN; 186 } 187 188 if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y), 189 uha->reportid, hid_input, &sc->sc_loc_y, &flags)) { 190 aprint_error("\n%s: mouse has no Y report\n", 191 USBDEVNAME(sc->sc_hdev.sc_dev)); 192 USB_ATTACH_ERROR_RETURN; 193 } 194 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) { 195 aprint_error("\n%s: Y report 0x%04x not supported\n", 196 USBDEVNAME(sc->sc_hdev.sc_dev), flags); 197 USB_ATTACH_ERROR_RETURN; 198 } 199 200 /* Try the wheel first as the Z activator since it's tradition. */ 201 wheel = hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, 202 HUG_WHEEL), 203 uha->reportid, hid_input, &sc->sc_loc_z, &flags); 204 if (wheel) { 205 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) { 206 aprint_verbose("\n%s: Wheel report 0x%04x not " 207 "supported\n", USBDEVNAME(sc->sc_hdev.sc_dev), 208 flags); 209 sc->sc_loc_z.size = 0; /* Bad Z coord, ignore it */ 210 } else { 211 sc->flags |= UMS_Z; 212 /* Wheels need the Z axis reversed. */ 213 sc->flags ^= UMS_REVZ; 214 } 215 /* 216 * We might have both a wheel and Z direction, if so put 217 * put the Z on the W coordinate. 218 */ 219 if (hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, 220 HUG_Z), 221 uha->reportid, hid_input, &sc->sc_loc_w, &flags)) { 222 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) { 223 aprint_verbose("\n%s: Z report 0x%04x not " 224 "supported\n", 225 USBDEVNAME(sc->sc_hdev.sc_dev), flags); 226 sc->sc_loc_w.size = 0; /* Bad Z, ignore */ 227 } 228 } 229 } else if (hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, 230 HUG_Z), 231 uha->reportid, hid_input, &sc->sc_loc_z, &flags)) { 232 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) { 233 aprint_verbose("\n%s: Z report 0x%04x not supported\n", 234 USBDEVNAME(sc->sc_hdev.sc_dev), flags); 235 sc->sc_loc_z.size = 0; /* Bad Z coord, ignore it */ 236 } else { 237 sc->flags |= UMS_Z; 238 } 239 } 240 241 242 /* figure out the number of buttons */ 243 for (i = 1; i <= MAX_BUTTONS; i++) 244 if (!hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i), 245 uha->reportid, hid_input, &loc_btn, 0)) 246 break; 247 sc->nbuttons = i - 1; 248 249 aprint_normal(": %d button%s%s\n", 250 sc->nbuttons, sc->nbuttons == 1 ? "" : "s", 251 sc->flags & UMS_Z ? " and Z dir." : ""); 252 253 for (i = 1; i <= sc->nbuttons; i++) 254 hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i), 255 uha->reportid, hid_input, 256 &sc->sc_loc_btn[i-1], 0); 257 258 #ifdef USB_DEBUG 259 DPRINTF(("ums_attach: sc=%p\n", sc)); 260 DPRINTF(("ums_attach: X\t%d/%d\n", 261 sc->sc_loc_x.pos, sc->sc_loc_x.size)); 262 DPRINTF(("ums_attach: Y\t%d/%d\n", 263 sc->sc_loc_y.pos, sc->sc_loc_y.size)); 264 if (sc->flags & UMS_Z) 265 DPRINTF(("ums_attach: Z\t%d/%d\n", 266 sc->sc_loc_z.pos, sc->sc_loc_z.size)); 267 for (i = 1; i <= sc->nbuttons; i++) { 268 DPRINTF(("ums_attach: B%d\t%d/%d\n", 269 i, sc->sc_loc_btn[i-1].pos,sc->sc_loc_btn[i-1].size)); 270 } 271 #endif 272 273 a.accessops = &ums_accessops; 274 a.accesscookie = sc; 275 276 sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint); 277 278 USB_ATTACH_SUCCESS_RETURN; 279 } 280 281 int 282 ums_activate(device_ptr_t self, enum devact act) 283 { 284 struct ums_softc *sc = (struct ums_softc *)self; 285 int rv = 0; 286 287 switch (act) { 288 case DVACT_ACTIVATE: 289 return (EOPNOTSUPP); 290 291 case DVACT_DEACTIVATE: 292 if (sc->sc_wsmousedev != NULL) 293 rv = config_deactivate(sc->sc_wsmousedev); 294 sc->sc_dying = 1; 295 break; 296 } 297 return (rv); 298 } 299 300 int 301 ums_detach(struct device *self, int flags) 302 { 303 struct ums_softc *sc = (struct ums_softc *)self; 304 int rv = 0; 305 306 DPRINTF(("ums_detach: sc=%p flags=%d\n", sc, flags)); 307 308 /* No need to do reference counting of ums, wsmouse has all the goo. */ 309 if (sc->sc_wsmousedev != NULL) 310 rv = config_detach(sc->sc_wsmousedev, flags); 311 312 pmf_device_deregister(self); 313 314 return (rv); 315 } 316 317 void 318 ums_intr(struct uhidev *addr, void *ibuf, u_int len) 319 { 320 struct ums_softc *sc = (struct ums_softc *)addr; 321 int dx, dy, dz, dw; 322 u_int32_t buttons = 0; 323 int i; 324 int s; 325 326 DPRINTFN(5,("ums_intr: len=%d\n", len)); 327 328 dx = hid_get_data(ibuf, &sc->sc_loc_x); 329 dy = -hid_get_data(ibuf, &sc->sc_loc_y); 330 dz = hid_get_data(ibuf, &sc->sc_loc_z); 331 dw = hid_get_data(ibuf, &sc->sc_loc_w); 332 if (sc->flags & UMS_REVZ) 333 dz = -dz; 334 for (i = 0; i < sc->nbuttons; i++) 335 if (hid_get_data(ibuf, &sc->sc_loc_btn[i])) 336 buttons |= (1 << UMS_BUT(i)); 337 338 if (dx != 0 || dy != 0 || dz != 0 || dw != 0 || 339 buttons != sc->sc_buttons) { 340 DPRINTFN(10, ("ums_intr: x:%d y:%d z:%d w:%d buttons:0x%x\n", 341 dx, dy, dz, dw, buttons)); 342 sc->sc_buttons = buttons; 343 if (sc->sc_wsmousedev != NULL) { 344 s = spltty(); 345 wsmouse_input(sc->sc_wsmousedev, 346 buttons, 347 dx, dy, dz, dw, 348 WSMOUSE_INPUT_DELTA); 349 splx(s); 350 } 351 } 352 } 353 354 Static int 355 ums_enable(void *v) 356 { 357 struct ums_softc *sc = v; 358 359 DPRINTFN(1,("ums_enable: sc=%p\n", sc)); 360 361 if (sc->sc_dying) 362 return (EIO); 363 364 if (sc->sc_enabled) 365 return (EBUSY); 366 367 sc->sc_enabled = 1; 368 sc->sc_buttons = 0; 369 370 return (uhidev_open(&sc->sc_hdev)); 371 } 372 373 Static void 374 ums_disable(void *v) 375 { 376 struct ums_softc *sc = v; 377 378 DPRINTFN(1,("ums_disable: sc=%p\n", sc)); 379 #ifdef DIAGNOSTIC 380 if (!sc->sc_enabled) { 381 printf("ums_disable: not enabled\n"); 382 return; 383 } 384 #endif 385 386 sc->sc_enabled = 0; 387 uhidev_close(&sc->sc_hdev); 388 } 389 390 Static int 391 ums_ioctl(void *v, u_long cmd, void *data, int flag, 392 struct lwp * p) 393 394 { 395 switch (cmd) { 396 case WSMOUSEIO_GTYPE: 397 *(u_int *)data = WSMOUSE_TYPE_USB; 398 return (0); 399 } 400 401 return (EPASSTHROUGH); 402 } 403
Indexes created Sun Sep 28 16:09:52 GMT 2025