ums.c revision 1.98
1 /* $NetBSD: ums.c,v 1.98 2020/04/12 07:41:11 jdolecek Exp $ */ 2 3 /* 4 * Copyright (c) 1998, 2017 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 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf 35 */ 36 37 #include <sys/cdefs.h> 38 __KERNEL_RCSID(0, "$NetBSD: ums.c,v 1.98 2020/04/12 07:41:11 jdolecek Exp $"); 39 40 #ifdef _KERNEL_OPT 41 #include "opt_usb.h" 42 #endif 43 44 #include <sys/param.h> 45 #include <sys/systm.h> 46 #include <sys/kernel.h> 47 #include <sys/device.h> 48 #include <sys/ioctl.h> 49 #include <sys/file.h> 50 #include <sys/select.h> 51 #include <sys/proc.h> 52 #include <sys/vnode.h> 53 #include <sys/poll.h> 54 55 #include <dev/usb/usb.h> 56 #include <dev/usb/usbhid.h> 57 58 #include <dev/usb/usbdi.h> 59 #include <dev/usb/usbdi_util.h> 60 #include <dev/usb/usbdevs.h> 61 #include <dev/usb/usb_quirks.h> 62 #include <dev/usb/uhidev.h> 63 #include <dev/hid/hid.h> 64 #include <dev/hid/hidms.h> 65 66 #ifdef UMS_DEBUG 67 #define DPRINTF(x) if (umsdebug) printf x 68 #define DPRINTFN(n,x) if (umsdebug>(n)) printf x 69 int umsdebug = 0; 70 #else 71 #define DPRINTF(x) 72 #define DPRINTFN(n,x) 73 #endif 74 75 #define UMSUNIT(s) (minor(s)) 76 77 struct ums_softc { 78 struct uhidev sc_hdev; 79 struct hidms sc_ms; 80 81 bool sc_alwayson; 82 83 int sc_enabled; 84 char sc_dying; 85 }; 86 87 Static void ums_intr(struct uhidev *, void *, u_int); 88 89 Static int ums_enable(void *); 90 Static void ums_disable(void *); 91 Static int ums_ioctl(void *, u_long, void *, int, struct lwp *); 92 93 static const struct wsmouse_accessops ums_accessops = { 94 ums_enable, 95 ums_ioctl, 96 ums_disable, 97 }; 98 99 static int ums_match(device_t, cfdata_t, void *); 100 static void ums_attach(device_t, device_t, void *); 101 static void ums_childdet(device_t, device_t); 102 static int ums_detach(device_t, int); 103 static int ums_activate(device_t, enum devact); 104 105 CFATTACH_DECL2_NEW(ums, sizeof(struct ums_softc), ums_match, ums_attach, 106 ums_detach, ums_activate, NULL, ums_childdet); 107 108 static int 109 ums_match(device_t parent, cfdata_t match, void *aux) 110 { 111 struct uhidev_attach_arg *uha = aux; 112 int size; 113 void *desc; 114 115 /* 116 * Some (older) Griffin PowerMate knobs may masquerade as a 117 * mouse, avoid treating them as such, they have only one axis. 118 */ 119 if (uha->uiaa->uiaa_vendor == USB_VENDOR_GRIFFIN && 120 uha->uiaa->uiaa_product == USB_PRODUCT_GRIFFIN_POWERMATE) 121 return UMATCH_NONE; 122 123 uhidev_get_report_desc(uha->parent, &desc, &size); 124 if (!hid_is_collection(desc, size, uha->reportid, 125 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)) && 126 !hid_is_collection(desc, size, uha->reportid, 127 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_POINTER)) && 128 !hid_is_collection(desc, size, uha->reportid, 129 HID_USAGE2(HUP_DIGITIZERS, 0x0002))) 130 return UMATCH_NONE; 131 132 return UMATCH_IFACECLASS; 133 } 134 135 static void 136 ums_attach(device_t parent, device_t self, void *aux) 137 { 138 struct ums_softc *sc = device_private(self); 139 struct uhidev_attach_arg *uha = aux; 140 int size, error; 141 void *desc; 142 uint32_t quirks; 143 144 aprint_naive("\n"); 145 146 sc->sc_hdev.sc_dev = self; 147 sc->sc_hdev.sc_intr = ums_intr; 148 sc->sc_hdev.sc_parent = uha->parent; 149 sc->sc_hdev.sc_report_id = uha->reportid; 150 151 quirks = usbd_get_quirks(uha->parent->sc_udev)->uq_flags; 152 if (quirks & UQ_MS_REVZ) 153 sc->sc_ms.flags |= HIDMS_REVZ; 154 if (quirks & UQ_SPUR_BUT_UP) 155 sc->sc_ms.flags |= HIDMS_SPUR_BUT_UP; 156 157 if (!pmf_device_register(self, NULL, NULL)) 158 aprint_error_dev(self, "couldn't establish power handler\n"); 159 160 uhidev_get_report_desc(uha->parent, &desc, &size); 161 162 if (!hidms_setup(self, &sc->sc_ms, uha->reportid, desc, size)) 163 return; 164 165 if (uha->uiaa->uiaa_vendor == USB_VENDOR_MICROSOFT) { 166 int fixpos; 167 int woffset = 8; 168 /* 169 * The Microsoft Wireless Laser Mouse 6000 v2.0 and the 170 * Microsoft Comfort Mouse 2.0 report a bad position for 171 * the wheel and wheel tilt controls -- should be in bytes 172 * 3 & 4 of the report. Fix this if necessary. 173 */ 174 switch (uha->uiaa->uiaa_product) { 175 case USB_PRODUCT_MICROSOFT_24GHZ_XCVR10: 176 case USB_PRODUCT_MICROSOFT_24GHZ_XCVR20: 177 case USB_PRODUCT_MICROSOFT_NATURAL_6000: 178 fixpos = 24; 179 break; 180 case USB_PRODUCT_MICROSOFT_24GHZ_XCVR80: 181 fixpos = 40; 182 woffset = sc->sc_ms.hidms_loc_z.size; 183 break; 184 case USB_PRODUCT_MICROSOFT_CM6000: 185 fixpos = 40; 186 break; 187 default: 188 fixpos = 0; 189 break; 190 } 191 if (fixpos) { 192 if ((sc->sc_ms.flags & HIDMS_Z) && 193 sc->sc_ms.hidms_loc_z.pos == 0) 194 sc->sc_ms.hidms_loc_z.pos = fixpos; 195 if ((sc->sc_ms.flags & HIDMS_W) && 196 sc->sc_ms.hidms_loc_w.pos == 0) 197 sc->sc_ms.hidms_loc_w.pos = 198 sc->sc_ms.hidms_loc_z.pos + woffset; 199 } 200 } 201 202 if (uha->uiaa->uiaa_vendor == USB_VENDOR_HAILUCK && 203 uha->uiaa->uiaa_product == USB_PRODUCT_HAILUCK_KEYBOARD) { 204 /* 205 * The HAILUCK USB Keyboard has a built-in touchpad, which 206 * needs to be active for the keyboard to function properly. 207 */ 208 sc->sc_alwayson = true; 209 } 210 211 tpcalib_init(&sc->sc_ms.sc_tpcalib); 212 hidms_attach(self, &sc->sc_ms, &ums_accessops); 213 214 if (sc->sc_alwayson) { 215 error = uhidev_open(&sc->sc_hdev); 216 if (error != 0) { 217 aprint_error_dev(self, 218 "WARNING: couldn't open always-on device\n"); 219 sc->sc_alwayson = false; 220 } 221 } 222 } 223 224 static int 225 ums_activate(device_t self, enum devact act) 226 { 227 struct ums_softc *sc = device_private(self); 228 229 switch (act) { 230 case DVACT_DEACTIVATE: 231 sc->sc_dying = 1; 232 return 0; 233 default: 234 return EOPNOTSUPP; 235 } 236 } 237 238 static void 239 ums_childdet(device_t self, device_t child) 240 { 241 struct ums_softc *sc = device_private(self); 242 243 KASSERT(sc->sc_ms.hidms_wsmousedev == child); 244 sc->sc_ms.hidms_wsmousedev = NULL; 245 } 246 247 static int 248 ums_detach(device_t self, int flags) 249 { 250 struct ums_softc *sc = device_private(self); 251 int rv = 0; 252 253 DPRINTF(("ums_detach: sc=%p flags=%d\n", sc, flags)); 254 255 if (sc->sc_alwayson) 256 uhidev_close(&sc->sc_hdev); 257 258 /* No need to do reference counting of ums, wsmouse has all the goo. */ 259 if (sc->sc_ms.hidms_wsmousedev != NULL) 260 rv = config_detach(sc->sc_ms.hidms_wsmousedev, flags); 261 262 pmf_device_deregister(self); 263 264 return rv; 265 } 266 267 Static void 268 ums_intr(struct uhidev *addr, void *ibuf, u_int len) 269 { 270 struct ums_softc *sc = (struct ums_softc *)addr; 271 272 if (sc->sc_enabled) 273 hidms_intr(&sc->sc_ms, ibuf, len); 274 } 275 276 Static int 277 ums_enable(void *v) 278 { 279 struct ums_softc *sc = v; 280 int error = 0; 281 282 DPRINTFN(1,("ums_enable: sc=%p\n", sc)); 283 284 if (sc->sc_dying) 285 return EIO; 286 287 if (sc->sc_enabled) 288 return EBUSY; 289 290 sc->sc_enabled = 1; 291 sc->sc_ms.hidms_buttons = 0; 292 293 if (!sc->sc_alwayson) { 294 error = uhidev_open(&sc->sc_hdev); 295 if (error) 296 sc->sc_enabled = 0; 297 } 298 299 return error; 300 } 301 302 Static void 303 ums_disable(void *v) 304 { 305 struct ums_softc *sc = v; 306 307 DPRINTFN(1,("ums_disable: sc=%p\n", sc)); 308 #ifdef DIAGNOSTIC 309 if (!sc->sc_enabled) { 310 printf("ums_disable: not enabled\n"); 311 return; 312 } 313 #endif 314 315 if (sc->sc_enabled) { 316 sc->sc_enabled = 0; 317 if (!sc->sc_alwayson) 318 uhidev_close(&sc->sc_hdev); 319 } 320 } 321 322 Static int 323 ums_ioctl(void *v, u_long cmd, void *data, int flag, 324 struct lwp * p) 325 326 { 327 struct ums_softc *sc = v; 328 329 switch (cmd) { 330 case WSMOUSEIO_GTYPE: 331 if (sc->sc_ms.flags & HIDMS_ABS) 332 *(u_int *)data = WSMOUSE_TYPE_TPANEL; 333 else 334 *(u_int *)data = WSMOUSE_TYPE_USB; 335 return 0; 336 } 337 338 return EPASSTHROUGH; 339 } 340
Indexes created Sun Sep 28 16:09:52 GMT 2025