ums.c revision 1.103.4.1
1 /* $NetBSD: ums.c,v 1.103.4.1 2024/01/14 15:52:26 martin 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.103.4.1 2024/01/14 15:52:26 martin 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 usbd_device *sc_udev; 80 struct hidms sc_ms; 81 82 bool sc_alwayson; 83 84 int sc_enabled; 85 char sc_dying; 86 }; 87 88 Static void ums_intr(void *, void *, u_int); 89 90 Static int ums_enable(void *); 91 Static void ums_disable(void *); 92 Static int ums_ioctl(void *, u_long, void *, int, struct lwp *); 93 94 static const struct wsmouse_accessops ums_accessops = { 95 ums_enable, 96 ums_ioctl, 97 ums_disable, 98 }; 99 100 static int ums_match(device_t, cfdata_t, void *); 101 static void ums_attach(device_t, device_t, void *); 102 static void ums_childdet(device_t, device_t); 103 static int ums_detach(device_t, int); 104 static int ums_activate(device_t, enum devact); 105 106 CFATTACH_DECL2_NEW(ums, sizeof(struct ums_softc), ums_match, ums_attach, 107 ums_detach, ums_activate, NULL, ums_childdet); 108 109 static int 110 ums_match(device_t parent, cfdata_t match, void *aux) 111 { 112 struct uhidev_attach_arg *uha = aux; 113 int size; 114 void *desc; 115 116 /* 117 * Some (older) Griffin PowerMate knobs may masquerade as a 118 * mouse, avoid treating them as such, they have only one axis. 119 */ 120 if (uha->uiaa->uiaa_vendor == USB_VENDOR_GRIFFIN && 121 uha->uiaa->uiaa_product == USB_PRODUCT_GRIFFIN_POWERMATE) 122 return UMATCH_NONE; 123 124 uhidev_get_report_desc(uha->parent, &desc, &size); 125 if (!hid_is_collection(desc, size, uha->reportid, 126 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)) && 127 !hid_is_collection(desc, size, uha->reportid, 128 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_POINTER)) && 129 !hid_is_collection(desc, size, uha->reportid, 130 HID_USAGE2(HUP_DIGITIZERS, 0x0002))) 131 return UMATCH_NONE; 132 133 return UMATCH_IFACECLASS; 134 } 135 136 static void 137 ums_attach(device_t parent, device_t self, void *aux) 138 { 139 struct ums_softc *sc = device_private(self); 140 struct uhidev_attach_arg *uha = aux; 141 struct hid_data *d; 142 struct hid_item item; 143 int size, error; 144 void *desc; 145 uint32_t quirks; 146 147 aprint_naive("\n"); 148 149 sc->sc_hdev = uha->parent; 150 sc->sc_udev = uha->uiaa->uiaa_device; 151 152 quirks = usbd_get_quirks(sc->sc_udev)->uq_flags; 153 if (quirks & UQ_MS_REVZ) 154 sc->sc_ms.flags |= HIDMS_REVZ; 155 if (quirks & UQ_SPUR_BUT_UP) 156 sc->sc_ms.flags |= HIDMS_SPUR_BUT_UP; 157 if (quirks & UQ_ALWAYS_ON) 158 sc->sc_alwayson = true; 159 160 if (!pmf_device_register(self, NULL, NULL)) 161 aprint_error_dev(self, "couldn't establish power handler\n"); 162 163 uhidev_get_report_desc(uha->parent, &desc, &size); 164 165 if (!hidms_setup(self, &sc->sc_ms, uha->reportid, desc, size)) 166 return; 167 168 if (uha->uiaa->uiaa_vendor == USB_VENDOR_MICROSOFT) { 169 int fixpos; 170 int woffset = 8; 171 /* 172 * The Microsoft Wireless Laser Mouse 6000 v2.0 and the 173 * Microsoft Comfort Mouse 2.0 report a bad position for 174 * the wheel and wheel tilt controls -- should be in bytes 175 * 3 & 4 of the report. Fix this if necessary. 176 */ 177 switch (uha->uiaa->uiaa_product) { 178 case USB_PRODUCT_MICROSOFT_24GHZ_XCVR10: 179 case USB_PRODUCT_MICROSOFT_24GHZ_XCVR20: 180 case USB_PRODUCT_MICROSOFT_NATURAL_6000: 181 fixpos = 24; 182 break; 183 case USB_PRODUCT_MICROSOFT_24GHZ_XCVR80: 184 case USB_PRODUCT_MICROSOFT_24GHZ_XCVR90: 185 fixpos = 40; 186 woffset = sc->sc_ms.hidms_loc_z.size; 187 break; 188 case USB_PRODUCT_MICROSOFT_CM6000: 189 fixpos = 40; 190 break; 191 default: 192 fixpos = 0; 193 break; 194 } 195 if (fixpos) { 196 if ((sc->sc_ms.flags & HIDMS_Z) && 197 sc->sc_ms.hidms_loc_z.pos == 0) 198 sc->sc_ms.hidms_loc_z.pos = fixpos; 199 if ((sc->sc_ms.flags & HIDMS_W) && 200 sc->sc_ms.hidms_loc_w.pos == 0) 201 sc->sc_ms.hidms_loc_w.pos = 202 sc->sc_ms.hidms_loc_z.pos + woffset; 203 } 204 } 205 206 tpcalib_init(&sc->sc_ms.sc_tpcalib); 207 208 /* calibrate the pointer if it reports absolute events */ 209 if (sc->sc_ms.flags & HIDMS_ABS) { 210 memset(&sc->sc_ms.sc_calibcoords, 0, sizeof(sc->sc_ms.sc_calibcoords)); 211 sc->sc_ms.sc_calibcoords.maxx = 0; 212 sc->sc_ms.sc_calibcoords.maxy = 0; 213 sc->sc_ms.sc_calibcoords.samplelen = WSMOUSE_CALIBCOORDS_RESET; 214 d = hid_start_parse(desc, size, hid_input); 215 if (d != NULL) { 216 while (hid_get_item(d, &item)) { 217 if (item.kind != hid_input 218 || HID_GET_USAGE_PAGE(item.usage) != HUP_GENERIC_DESKTOP 219 || item.report_ID != uha->reportid) 220 continue; 221 if (HID_GET_USAGE(item.usage) == HUG_X) { 222 sc->sc_ms.sc_calibcoords.minx = item.logical_minimum; 223 sc->sc_ms.sc_calibcoords.maxx = item.logical_maximum; 224 } 225 if (HID_GET_USAGE(item.usage) == HUG_Y) { 226 sc->sc_ms.sc_calibcoords.miny = item.logical_minimum; 227 sc->sc_ms.sc_calibcoords.maxy = item.logical_maximum; 228 } 229 } 230 hid_end_parse(d); 231 } 232 tpcalib_ioctl(&sc->sc_ms.sc_tpcalib, WSMOUSEIO_SCALIBCOORDS, 233 (void *)&sc->sc_ms.sc_calibcoords, 0, 0); 234 } 235 236 hidms_attach(self, &sc->sc_ms, &ums_accessops); 237 238 if (sc->sc_alwayson) { 239 error = uhidev_open(sc->sc_hdev, &ums_intr, sc); 240 if (error != 0) { 241 aprint_error_dev(self, 242 "WARNING: couldn't open always-on device\n"); 243 sc->sc_alwayson = false; 244 } 245 } 246 } 247 248 static int 249 ums_activate(device_t self, enum devact act) 250 { 251 struct ums_softc *sc = device_private(self); 252 253 switch (act) { 254 case DVACT_DEACTIVATE: 255 sc->sc_dying = 1; 256 return 0; 257 default: 258 return EOPNOTSUPP; 259 } 260 } 261 262 static void 263 ums_childdet(device_t self, device_t child) 264 { 265 struct ums_softc *sc = device_private(self); 266 267 KASSERT(sc->sc_ms.hidms_wsmousedev == child); 268 sc->sc_ms.hidms_wsmousedev = NULL; 269 } 270 271 static int 272 ums_detach(device_t self, int flags) 273 { 274 struct ums_softc *sc = device_private(self); 275 int rv = 0; 276 277 DPRINTF(("ums_detach: sc=%p flags=%d\n", sc, flags)); 278 279 if (sc->sc_alwayson) 280 uhidev_close(sc->sc_hdev); 281 282 /* No need to do reference counting of ums, wsmouse has all the goo. */ 283 if (sc->sc_ms.hidms_wsmousedev != NULL) 284 rv = config_detach(sc->sc_ms.hidms_wsmousedev, flags); 285 286 pmf_device_deregister(self); 287 288 return rv; 289 } 290 291 Static void 292 ums_intr(void *cookie, void *ibuf, u_int len) 293 { 294 struct ums_softc *sc = cookie; 295 296 if (sc->sc_enabled) 297 hidms_intr(&sc->sc_ms, ibuf, len); 298 } 299 300 Static int 301 ums_enable(void *v) 302 { 303 struct ums_softc *sc = v; 304 int error = 0; 305 306 DPRINTFN(1,("ums_enable: sc=%p\n", sc)); 307 308 if (sc->sc_dying) 309 return EIO; 310 311 if (sc->sc_enabled) 312 return EBUSY; 313 314 sc->sc_enabled = 1; 315 sc->sc_ms.hidms_buttons = 0; 316 317 if (!sc->sc_alwayson) { 318 error = uhidev_open(sc->sc_hdev, &ums_intr, sc); 319 if (error) 320 sc->sc_enabled = 0; 321 } 322 323 return error; 324 } 325 326 Static void 327 ums_disable(void *v) 328 { 329 struct ums_softc *sc = v; 330 331 DPRINTFN(1,("ums_disable: sc=%p\n", sc)); 332 #ifdef DIAGNOSTIC 333 if (!sc->sc_enabled) { 334 printf("ums_disable: not enabled\n"); 335 return; 336 } 337 #endif 338 339 if (sc->sc_enabled) { 340 sc->sc_enabled = 0; 341 if (!sc->sc_alwayson) 342 uhidev_close(sc->sc_hdev); 343 } 344 } 345 346 Static int 347 ums_ioctl(void *v, u_long cmd, void *data, int flag, 348 struct lwp *l) 349 350 { 351 struct ums_softc *sc = v; 352 int error; 353 354 if (sc->sc_ms.flags & HIDMS_ABS) { 355 error = tpcalib_ioctl(&sc->sc_ms.sc_tpcalib, cmd, data, 356 flag, l); 357 if (error != EPASSTHROUGH) 358 return error; 359 } 360 361 switch (cmd) { 362 case WSMOUSEIO_GTYPE: 363 if (sc->sc_ms.flags & HIDMS_ABS) 364 *(u_int *)data = WSMOUSE_TYPE_TPANEL; 365 else 366 *(u_int *)data = WSMOUSE_TYPE_USB; 367 return 0; 368 } 369 370 return EPASSTHROUGH; 371 } 372
Indexes created Wed Oct 01 15:09:59 GMT 2025