3819c786572735e432f279eb02f591b512d6ab4e
[dragonfly.git] / sys / dev / usbmisc / ums / ums.c
1 /*
2  * $FreeBSD: src/sys/dev/usb/ums.c,v 1.64 2003/11/09 09:17:22 tanimura Exp $
3  * $DragonFly: src/sys/dev/usbmisc/ums/ums.c,v 1.31 2008/08/14 20:55:54 hasso Exp $
4  */
5
6 /*
7  * Copyright (c) 1998 The NetBSD Foundation, Inc.
8  * All rights reserved.
9  *
10  * This code is derived from software contributed to The NetBSD Foundation
11  * by Lennart Augustsson (lennart@augustsson.net) at
12  * Carlstedt Research & Technology.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. All advertising materials mentioning features or use of this software
23  *    must display the following acknowledgement:
24  *        This product includes software developed by the NetBSD
25  *        Foundation, Inc. and its contributors.
26  * 4. Neither the name of The NetBSD Foundation nor the names of its
27  *    contributors may be used to endorse or promote products derived
28  *    from this software without specific prior written permission.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
31  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
32  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
33  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
34  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
38  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40  * POSSIBILITY OF SUCH DAMAGE.
41  */
42
43 /*
44  * HID spec: http://www.usb.org/developers/data/devclass/hid1_1.pdf
45  */
46
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #include <sys/module.h>
52 #include <sys/bus.h>
53 #include <sys/conf.h>
54 #include <sys/tty.h>
55 #include <sys/file.h>
56 #include <sys/select.h>
57 #include <sys/vnode.h>
58 #include <sys/poll.h>
59 #include <sys/event.h>
60 #include <sys/sysctl.h>
61 #include <sys/thread2.h>
62
63 #include <bus/usb/usb.h>
64 #include <bus/usb/usbhid.h>
65
66 #include <bus/usb/usbdi.h>
67 #include <bus/usb/usbdi_util.h>
68 #include <bus/usb/usb_quirks.h>
69 #include <bus/usb/hid.h>
70
71 #include <machine/mouse.h>
72
73 #ifdef USB_DEBUG
74 #define DPRINTF(x)      if (umsdebug) kprintf x
75 #define DPRINTFN(n,x)   if (umsdebug>(n)) kprintf x
76 int     umsdebug = 0;
77 SYSCTL_NODE(_hw_usb, OID_AUTO, ums, CTLFLAG_RW, 0, "USB ums");
78 SYSCTL_INT(_hw_usb_ums, OID_AUTO, debug, CTLFLAG_RW,
79            &umsdebug, 0, "ums debug level");
80 #else
81 #define DPRINTF(x)
82 #define DPRINTFN(n,x)
83 #endif
84
85 #define UMSUNIT(s)      (minor(s)&0x1f)
86
87 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
88
89 #define QUEUE_BUFSIZE   400     /* MUST be divisible by 5 _and_ 8 */
90
91 struct ums_softc {
92         device_t sc_dev;                /* base device */
93         usbd_interface_handle sc_iface; /* interface */
94         usbd_pipe_handle sc_intrpipe;   /* interrupt pipe */
95         int sc_ep_addr;
96
97         u_char *sc_ibuf;
98         u_int8_t sc_iid;
99         int sc_isize;
100         struct hid_location sc_loc_x, sc_loc_y, sc_loc_z;
101         struct hid_location *sc_loc_btn;
102
103         struct callout sc_timeout;      /* for spurious button ups */
104
105         int sc_enabled;
106         int sc_disconnected;    /* device is gone */
107
108         int flags;              /* device configuration */
109 #define UMS_Z           0x01    /* z direction available */
110 #define UMS_SPUR_BUT_UP 0x02    /* spurious button up events */
111         int nbuttons;
112 #define MAX_BUTTONS     31      /* must not exceed size of sc_buttons */
113
114         u_char          qbuf[QUEUE_BUFSIZE];    /* must be divisable by 3&4 */
115         u_char          dummy[100];     /* XXX just for safety and for now */
116         int             qcount, qhead, qtail;
117         mousehw_t       hw;
118         mousemode_t     mode;
119         mousestatus_t   status;
120
121         int             state;
122 #         define        UMS_ASLEEP      0x01    /* readFromDevice is waiting */
123         struct selinfo  rsel;           /* process waiting in select */
124 };
125
126 #define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE)
127 #define MOUSE_FLAGS (HIO_RELATIVE)
128
129 static void ums_intr(usbd_xfer_handle xfer,
130                           usbd_private_handle priv, usbd_status status);
131
132 static void ums_add_to_queue(struct ums_softc *sc,
133                                 int dx, int dy, int dz, int buttons);
134 static void ums_add_to_queue_timeout(void *priv);
135
136 static int  ums_enable(void *);
137 static void ums_disable(void *);
138
139 static d_open_t  ums_open;
140 static d_close_t ums_close;
141 static d_read_t  ums_read;
142 static d_ioctl_t ums_ioctl;
143 static d_poll_t  ums_poll;
144 static d_kqfilter_t ums_kqfilter;
145
146 static void ums_filt_detach(struct knote *);
147 static int ums_filt(struct knote *, long);
148
149 #define UMS_CDEV_MAJOR  111
150
151 static struct dev_ops ums_ops = {
152         { "ums", UMS_CDEV_MAJOR, D_KQFILTER },
153         .d_open =       ums_open,
154         .d_close =      ums_close,
155         .d_read =       ums_read,
156         .d_ioctl =      ums_ioctl,
157         .d_poll =       ums_poll,
158         .d_kqfilter =   ums_kqfilter
159 };
160
161 static device_probe_t ums_match;
162 static device_attach_t ums_attach;
163 static device_detach_t ums_detach;
164
165 static devclass_t ums_devclass;
166
167 static kobj_method_t ums_methods[] = {
168         DEVMETHOD(device_probe, ums_match),
169         DEVMETHOD(device_attach, ums_attach),
170         DEVMETHOD(device_detach, ums_detach),
171         {0,0}
172 };
173
174 static driver_t ums_driver = {
175         "ums",
176         ums_methods,
177         sizeof(struct ums_softc)
178 };
179
180 MODULE_DEPEND(ums, usb, 1, 1, 1);
181
182 static int
183 ums_match(device_t self)
184 {
185         struct usb_attach_arg *uaa = device_get_ivars(self);
186         usb_interface_descriptor_t *id;
187         int size, ret;
188         void *desc;
189         usbd_status err;
190
191         if (!uaa->iface)
192                 return (UMATCH_NONE);
193         id = usbd_get_interface_descriptor(uaa->iface);
194         if (!id || id->bInterfaceClass != UICLASS_HID)
195                 return (UMATCH_NONE);
196
197         err = usbd_read_report_desc(uaa->iface, &desc, &size, M_TEMP);
198         if (err)
199                 return (UMATCH_NONE);
200
201         if (hid_is_collection(desc, size,
202                               HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
203                 ret = UMATCH_IFACECLASS;
204         else
205                 ret = UMATCH_NONE;
206
207         kfree(desc, M_TEMP);
208         return (ret);
209 }
210
211 static int
212 ums_attach(device_t self)
213 {
214         struct ums_softc *sc = device_get_softc(self);
215         struct usb_attach_arg *uaa = device_get_ivars(self);
216         usbd_interface_handle iface = uaa->iface;
217         usb_endpoint_descriptor_t *ed;
218         int size;
219         void *desc;
220         usbd_status err;
221         u_int32_t flags;
222         int i;
223         struct hid_location loc_btn;
224
225         sc->sc_disconnected = 1;
226         sc->sc_iface = iface;
227         sc->sc_dev = self;
228         ed = usbd_interface2endpoint_descriptor(iface, 0);
229         if (!ed) {
230                 kprintf("%s: could not read endpoint descriptor\n",
231                        device_get_nameunit(sc->sc_dev));
232                 return ENXIO;
233         }
234
235         DPRINTFN(10,("ums_attach: bLength=%d bDescriptorType=%d "
236                      "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
237                      " bInterval=%d\n",
238                      ed->bLength, ed->bDescriptorType,
239                      UE_GET_ADDR(ed->bEndpointAddress),
240                      UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN ? "in":"out",
241                      UE_GET_XFERTYPE(ed->bmAttributes),
242                      UGETW(ed->wMaxPacketSize), ed->bInterval));
243
244         if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
245             UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT) {
246                 kprintf("%s: unexpected endpoint\n",
247                        device_get_nameunit(sc->sc_dev));
248                 return ENXIO;
249         }
250
251         err = usbd_read_report_desc(uaa->iface, &desc, &size, M_TEMP);
252         if (err)
253                 return ENXIO;
254
255         if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
256                        hid_input, &sc->sc_loc_x, &flags)) {
257                 kprintf("%s: mouse has no X report\n", device_get_nameunit(sc->sc_dev));
258                 return ENXIO;
259         }
260         if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
261                 kprintf("%s: X report 0x%04x not supported\n",
262                        device_get_nameunit(sc->sc_dev), flags);
263                 return ENXIO;
264         }
265
266         if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
267                        hid_input, &sc->sc_loc_y, &flags)) {
268                 kprintf("%s: mouse has no Y report\n", device_get_nameunit(sc->sc_dev));
269                 return ENXIO;
270         }
271         if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
272                 kprintf("%s: Y report 0x%04x not supported\n",
273                        device_get_nameunit(sc->sc_dev), flags);
274                 return ENXIO;
275         }
276
277         /* try to guess the Z activator: first check Z, then WHEEL */
278         if (hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Z),
279                        hid_input, &sc->sc_loc_z, &flags) ||
280             hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_WHEEL),
281                        hid_input, &sc->sc_loc_z, &flags)) {
282                 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
283                         sc->sc_loc_z.size = 0;  /* Bad Z coord, ignore it */
284                 } else {
285                         sc->flags |= UMS_Z;
286                 }
287         }
288
289         /* figure out the number of buttons */
290         for (i = 1; i <= MAX_BUTTONS; i++)
291                 if (!hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
292                                 hid_input, &loc_btn, 0))
293                         break;
294         sc->nbuttons = i - 1;
295         sc->sc_loc_btn = kmalloc(sizeof(struct hid_location)*sc->nbuttons,
296                                 M_USBDEV, M_INTWAIT);
297
298         kprintf("%s: %d buttons%s\n", device_get_nameunit(sc->sc_dev),
299                sc->nbuttons, sc->flags & UMS_Z? " and Z dir." : "");
300
301         for (i = 1; i <= sc->nbuttons; i++)
302                 hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
303                                 hid_input, &sc->sc_loc_btn[i-1], 0);
304
305         sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
306         sc->sc_ibuf = kmalloc(sc->sc_isize, M_USB, M_INTWAIT);
307         sc->sc_ep_addr = ed->bEndpointAddress;
308         sc->sc_disconnected = 0;
309         kfree(desc, M_TEMP);
310
311 #ifdef USB_DEBUG
312         DPRINTF(("ums_attach: sc=%p\n", sc));
313         DPRINTF(("ums_attach: X\t%d/%d\n",
314                  sc->sc_loc_x.pos, sc->sc_loc_x.size));
315         DPRINTF(("ums_attach: Y\t%d/%d\n",
316                  sc->sc_loc_y.pos, sc->sc_loc_y.size));
317         if (sc->flags & UMS_Z)
318                 DPRINTF(("ums_attach: Z\t%d/%d\n",
319                          sc->sc_loc_z.pos, sc->sc_loc_z.size));
320         for (i = 1; i <= sc->nbuttons; i++) {
321                 DPRINTF(("ums_attach: B%d\t%d/%d\n",
322                          i, sc->sc_loc_btn[i-1].pos,sc->sc_loc_btn[i-1].size));
323         }
324         DPRINTF(("ums_attach: size=%d, id=%d\n", sc->sc_isize, sc->sc_iid));
325 #endif
326
327         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
328                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
329         else
330                 sc->hw.buttons = sc->nbuttons;
331         sc->hw.iftype = MOUSE_IF_USB;
332         sc->hw.type = MOUSE_MOUSE;
333         sc->hw.model = MOUSE_MODEL_GENERIC;
334         sc->hw.hwid = 0;
335         sc->mode.protocol = MOUSE_PROTO_MSC;
336         sc->mode.rate = -1;
337         sc->mode.resolution = MOUSE_RES_UNKNOWN;
338         sc->mode.accelfactor = 0;
339         sc->mode.level = 0;
340         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
341         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
342         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
343
344         sc->status.flags = 0;
345         sc->status.button = sc->status.obutton = 0;
346         sc->status.dx = sc->status.dy = sc->status.dz = 0;
347
348         make_dev(&ums_ops, device_get_unit(self),
349                  UID_ROOT, GID_OPERATOR,
350                  0644, "ums%d", device_get_unit(self));
351
352         if (usbd_get_quirks(uaa->device)->uq_flags & UQ_SPUR_BUT_UP) {
353                 DPRINTF(("%s: Spurious button up events\n",
354                         device_get_nameunit(sc->sc_dev)));
355                 sc->flags |= UMS_SPUR_BUT_UP;
356         }
357
358         return 0;
359 }
360
361
362 static int
363 ums_detach(device_t self)
364 {
365         struct ums_softc *sc = device_get_softc(self);
366
367         if (sc->sc_enabled)
368                 ums_disable(sc);
369
370         DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
371
372         kfree(sc->sc_loc_btn, M_USB);
373         kfree(sc->sc_ibuf, M_USB);
374
375         /* someone waiting for data */
376         /*
377          * XXX If we wakeup the process here, the device will be gone by
378          * the time the process gets a chance to notice. *_close and friends
379          * should be fixed to handle this case.
380          * Or we should do a delayed detach for this.
381          * Does this delay now force tsleep to exit with an error?
382          */
383         if (sc->state & UMS_ASLEEP) {
384                 sc->state &= ~UMS_ASLEEP;
385                 wakeup(sc);
386         }
387         selwakeup(&sc->rsel);
388
389         dev_ops_remove_minor(&ums_ops, /*-1, */device_get_unit(self));
390
391         return 0;
392 }
393
394 void
395 ums_intr(usbd_xfer_handle xfer, usbd_private_handle addr,
396          usbd_status status)
397 {
398         struct ums_softc *sc = addr;
399         u_char *ibuf;
400         int dx, dy, dz;
401         u_char buttons = 0;
402         int i;
403
404 #define UMS_BUT(i) ((i) < 3 ? (((i) + 2) % 3) : (i))
405
406         DPRINTFN(5, ("ums_intr: sc=%p status=%d\n", sc, status));
407         DPRINTFN(5, ("ums_intr: data = %02x %02x %02x\n",
408                      sc->sc_ibuf[0], sc->sc_ibuf[1], sc->sc_ibuf[2]));
409
410         if (status == USBD_CANCELLED)
411                 return;
412
413         if (status != USBD_NORMAL_COMPLETION) {
414                 DPRINTF(("ums_intr: status=%d\n", status));
415                 if (status == USBD_STALLED)
416                     usbd_clear_endpoint_stall_async(sc->sc_intrpipe);
417                 return;
418         }
419
420         ibuf = sc->sc_ibuf;
421         if (sc->sc_iid) {
422                 if (*ibuf++ != sc->sc_iid)
423                         return;
424         }
425
426         dx =  hid_get_data(ibuf, &sc->sc_loc_x);
427         dy = -hid_get_data(ibuf, &sc->sc_loc_y);
428         dz = -hid_get_data(ibuf, &sc->sc_loc_z);
429         for (i = 0; i < sc->nbuttons; i++)
430                 if (hid_get_data(ibuf, &sc->sc_loc_btn[i]))
431                         buttons |= (1 << UMS_BUT(i));
432
433         if (dx || dy || dz || (sc->flags & UMS_Z)
434             || buttons != sc->status.button) {
435                 DPRINTFN(5, ("ums_intr: x:%d y:%d z:%d buttons:0x%x\n",
436                         dx, dy, dz, buttons));
437
438                 sc->status.button = buttons;
439                 sc->status.dx += dx;
440                 sc->status.dy += dy;
441                 sc->status.dz += dz;
442
443                 /* Discard data in case of full buffer */
444                 if (sc->qcount == sizeof(sc->qbuf)) {
445                         DPRINTF(("Buffer full, discarded packet"));
446                         return;
447                 }
448
449                 /*
450                  * The Qtronix keyboard has a built in PS/2 port for a mouse.
451                  * The firmware once in a while posts a spurious button up
452                  * event. This event we ignore by doing a timeout for 50 msecs.
453                  * If we receive dx=dy=dz=buttons=0 before we add the event to
454                  * the queue.
455                  * In any other case we delete the timeout event.
456                  */
457                 if (sc->flags & UMS_SPUR_BUT_UP &&
458                     dx == 0 && dy == 0 && dz == 0 && buttons == 0) {
459                         callout_reset(&sc->sc_timeout, MS_TO_TICKS(50),
460                                     ums_add_to_queue_timeout, (void *) sc);
461                 } else {
462                         callout_stop(&sc->sc_timeout);
463                         ums_add_to_queue(sc, dx, dy, dz, buttons);
464                 }
465         }
466 }
467
468 static void
469 ums_add_to_queue_timeout(void *priv)
470 {
471         struct ums_softc *sc = priv;
472
473         crit_enter();
474         ums_add_to_queue(sc, 0, 0, 0, 0);
475         crit_exit();
476 }
477
478 static void
479 ums_add_to_queue(struct ums_softc *sc, int dx, int dy, int dz, int buttons)
480 {
481         /* Discard data in case of full buffer */
482         if (sc->qhead+sc->mode.packetsize > sizeof(sc->qbuf)) {
483                 DPRINTF(("Buffer full, discarded packet"));
484                 return;
485         }
486
487         if (dx >  254)          dx =  254;
488         if (dx < -256)          dx = -256;
489         if (dy >  254)          dy =  254;
490         if (dy < -256)          dy = -256;
491         if (dz >  126)          dz =  126;
492         if (dz < -128)          dz = -128;
493
494         sc->qbuf[sc->qhead] = sc->mode.syncmask[1];
495         sc->qbuf[sc->qhead] |= ~buttons & MOUSE_MSC_BUTTONS;
496         sc->qbuf[sc->qhead+1] = dx >> 1;
497         sc->qbuf[sc->qhead+2] = dy >> 1;
498         sc->qbuf[sc->qhead+3] = dx - (dx >> 1);
499         sc->qbuf[sc->qhead+4] = dy - (dy >> 1);
500
501         if (sc->mode.level == 1) {
502                 sc->qbuf[sc->qhead+5] = dz >> 1;
503                 sc->qbuf[sc->qhead+6] = dz - (dz >> 1);
504                 sc->qbuf[sc->qhead+7] = ((~buttons >> 3)
505                                          & MOUSE_SYS_EXTBUTTONS);
506         }
507
508         sc->qhead += sc->mode.packetsize;
509         sc->qcount += sc->mode.packetsize;
510         /* wrap round at end of buffer */
511         if (sc->qhead >= sizeof(sc->qbuf))
512                 sc->qhead = 0;
513
514         /* someone waiting for data */
515         if (sc->state & UMS_ASLEEP) {
516                 sc->state &= ~UMS_ASLEEP;
517                 wakeup(sc);
518         }
519         selwakeup(&sc->rsel);
520 }
521
522 static int
523 ums_enable(void *v)
524 {
525         struct ums_softc *sc = v;
526
527         usbd_status err;
528
529         if (sc->sc_enabled)
530                 return EBUSY;
531
532         sc->sc_enabled = 1;
533         sc->qcount = 0;
534         sc->qhead = sc->qtail = 0;
535         sc->status.flags = 0;
536         sc->status.button = sc->status.obutton = 0;
537         sc->status.dx = sc->status.dy = sc->status.dz = 0;
538
539         callout_init(&sc->sc_timeout);
540
541         /* Set up interrupt pipe. */
542         err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
543                                 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc,
544                                 sc->sc_ibuf, sc->sc_isize, ums_intr,
545                                 USBD_DEFAULT_INTERVAL);
546         if (err) {
547                 DPRINTF(("ums_enable: usbd_open_pipe_intr failed, error=%d\n",
548                          err));
549                 sc->sc_enabled = 0;
550                 return (EIO);
551         }
552         return (0);
553 }
554
555 static void
556 ums_disable(void *priv)
557 {
558         struct ums_softc *sc = priv;
559
560         callout_stop(&sc->sc_timeout);
561
562         /* Disable interrupts. */
563         usbd_abort_pipe(sc->sc_intrpipe);
564         usbd_close_pipe(sc->sc_intrpipe);
565
566         sc->sc_enabled = 0;
567
568         if (sc->qcount != 0)
569                 DPRINTF(("Discarded %d bytes in queue\n", sc->qcount));
570 }
571
572 static int
573 ums_open(struct dev_open_args *ap)
574 {
575         cdev_t dev = ap->a_head.a_dev;
576         struct ums_softc *sc;
577
578         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
579         if (sc == NULL)
580                 return (ENXIO);
581
582         return ums_enable(sc);
583 }
584
585 static int
586 ums_close(struct dev_close_args *ap)
587 {
588         cdev_t dev = ap->a_head.a_dev;
589         struct ums_softc *sc;
590
591         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
592
593         if (!sc)
594                 return 0;
595
596         if (sc->sc_enabled)
597                 ums_disable(sc);
598
599         return 0;
600 }
601
602 static int
603 ums_read(struct dev_read_args *ap)
604 {
605         cdev_t dev = ap->a_head.a_dev;
606         struct uio *uio = ap->a_uio;
607         struct ums_softc *sc;
608         char buf[sizeof(sc->qbuf)];
609         int l = 0;
610         int error;
611
612         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
613
614         crit_enter();
615         if (!sc) {
616                 crit_exit();
617                 return EIO;
618         }
619
620         while (sc->qcount == 0 )  {
621                 if (ap->a_ioflag & IO_NDELAY) {         /* non-blocking I/O */
622                         crit_exit();
623                         return EWOULDBLOCK;
624                 }
625
626                 sc->state |= UMS_ASLEEP;        /* blocking I/O */
627                 error = tsleep(sc, PCATCH, "umsrea", 0);
628                 if (error) {
629                         crit_exit();
630                         return error;
631                 } else if (!sc->sc_enabled) {
632                         crit_exit();
633                         return EINTR;
634                 }
635                 /* check whether the device is still there */
636
637                 sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
638                 if (!sc) {
639                         crit_exit();
640                         return EIO;
641                 }
642         }
643
644         /*
645          * The writer process only extends qcount and qtail. We could copy
646          * them and use the copies to do the copying out of the queue.
647          */
648
649         while ((sc->qcount > 0) && (uio->uio_resid > 0)) {
650                 l = (sc->qcount < uio->uio_resid? sc->qcount:uio->uio_resid);
651                 if (l > sizeof(buf))
652                         l = sizeof(buf);
653                 if (l > sizeof(sc->qbuf) - sc->qtail)           /* transfer till end of buf */
654                         l = sizeof(sc->qbuf) - sc->qtail;
655
656                 crit_exit();
657                 uiomove(&sc->qbuf[sc->qtail], l, uio);
658                 crit_enter();
659
660                 if ( sc->qcount - l < 0 ) {
661                         DPRINTF(("qcount below 0, count=%d l=%d\n", sc->qcount, l));
662                         sc->qcount = l;
663                 }
664                 sc->qcount -= l;        /* remove the bytes from the buffer */
665                 sc->qtail = (sc->qtail + l) % sizeof(sc->qbuf);
666         }
667         crit_exit();
668
669         return 0;
670 }
671
672 static int
673 ums_poll(struct dev_poll_args *ap)
674 {
675         cdev_t dev = ap->a_head.a_dev;
676         struct ums_softc *sc;
677         int revents = 0;
678
679         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
680
681         if (!sc) {
682                 ap->a_events = 0;
683                 return 0;
684         }
685
686         crit_enter();
687         if (ap->a_events & (POLLIN | POLLRDNORM)) {
688                 if (sc->qcount) {
689                         revents = ap->a_events & (POLLIN | POLLRDNORM);
690                 } else {
691                         /* sc->state |= UMS_SELECT; */
692                         selrecord(curthread, &sc->rsel);
693                 }
694         }
695         crit_exit();
696         ap->a_events = revents;
697         return (0);
698 }
699
700 static struct filterops ums_filtops =
701         { 1, NULL, ums_filt_detach, ums_filt };
702
703 static int
704 ums_kqfilter(struct dev_kqfilter_args *ap)
705 {
706         cdev_t dev = ap->a_head.a_dev;
707         struct knote *kn = ap->a_kn;
708         struct ums_softc *sc;
709         struct klist *klist;
710
711         ap->a_result = 0;
712
713         switch (kn->kn_filter) {
714         case EVFILT_READ:
715                 sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
716                 kn->kn_fop = &ums_filtops;
717                 kn->kn_hook = (caddr_t)sc;
718                 break;
719         default:
720                 ap->a_result = 1;
721                 return (0);
722         }
723
724         crit_enter();
725         klist = &sc->rsel.si_note;
726         SLIST_INSERT_HEAD(klist, kn, kn_selnext);
727         crit_exit();
728
729         return (0);
730 }
731
732 static void
733 ums_filt_detach(struct knote *kn)
734 {
735         struct ums_softc *sc = (struct ums_softc *)kn->kn_hook;
736         struct klist *klist;
737
738         crit_enter();
739         klist = &sc->rsel.si_note;
740         SLIST_REMOVE(klist, kn, knote, kn_selnext);
741         crit_exit();
742 }
743
744 static int
745 ums_filt(struct knote *kn, long hint)
746 {
747         struct ums_softc *sc = (struct ums_softc *)kn->kn_hook;
748         int ready = 0;
749
750         crit_enter();
751         if (sc->qcount)
752                 ready = 1;
753         crit_exit();
754
755         return (ready);
756 }
757
758 int
759 ums_ioctl(struct dev_ioctl_args *ap)
760 {
761         cdev_t dev = ap->a_head.a_dev;
762         struct ums_softc *sc;
763         int error = 0;
764         mousemode_t mode;
765
766         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
767
768         if (!sc)
769                 return EIO;
770
771         switch(ap->a_cmd) {
772         case MOUSE_GETHWINFO:
773                 *(mousehw_t *)ap->a_data = sc->hw;
774                 break;
775         case MOUSE_GETMODE:
776                 *(mousemode_t *)ap->a_data = sc->mode;
777                 break;
778         case MOUSE_SETMODE:
779                 mode = *(mousemode_t *)ap->a_data;
780
781                 if (mode.level == -1)
782                         /* don't change the current setting */
783                         ;
784                 else if ((mode.level < 0) || (mode.level > 1))
785                         return (EINVAL);
786
787                 crit_enter();
788                 sc->mode.level = mode.level;
789
790                 if (sc->mode.level == 0) {
791                         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
792                                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
793                         else
794                                 sc->hw.buttons = sc->nbuttons;
795                         sc->mode.protocol = MOUSE_PROTO_MSC;
796                         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
797                         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
798                         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
799                 } else if (sc->mode.level == 1) {
800                         if (sc->nbuttons > MOUSE_SYS_MAXBUTTON)
801                                 sc->hw.buttons = MOUSE_SYS_MAXBUTTON;
802                         else
803                                 sc->hw.buttons = sc->nbuttons;
804                         sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
805                         sc->mode.packetsize = MOUSE_SYS_PACKETSIZE;
806                         sc->mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
807                         sc->mode.syncmask[1] = MOUSE_SYS_SYNC;
808                 }
809
810                 bzero(sc->qbuf, sizeof(sc->qbuf));
811                 sc->qhead = sc->qtail = sc->qcount = 0;
812                 crit_exit();
813
814                 break;
815         case MOUSE_GETLEVEL:
816                 *(int *)ap->a_data = sc->mode.level;
817                 break;
818         case MOUSE_SETLEVEL:
819                 if (*(int *)ap->a_data < 0 || *(int *)ap->a_data > 1)
820                         return (EINVAL);
821
822                 crit_enter();
823                 sc->mode.level = *(int *)ap->a_data;
824
825                 if (sc->mode.level == 0) {
826                         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
827                                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
828                         else
829                                 sc->hw.buttons = sc->nbuttons;
830                         sc->mode.protocol = MOUSE_PROTO_MSC;
831                         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
832                         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
833                         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
834                 } else if (sc->mode.level == 1) {
835                         if (sc->nbuttons > MOUSE_SYS_MAXBUTTON)
836                                 sc->hw.buttons = MOUSE_SYS_MAXBUTTON;
837                         else
838                                 sc->hw.buttons = sc->nbuttons;
839                         sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
840                         sc->mode.packetsize = MOUSE_SYS_PACKETSIZE;
841                         sc->mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
842                         sc->mode.syncmask[1] = MOUSE_SYS_SYNC;
843                 }
844
845                 bzero(sc->qbuf, sizeof(sc->qbuf));
846                 sc->qhead = sc->qtail = sc->qcount = 0;
847                 crit_exit();
848
849                 break;
850         case MOUSE_GETSTATUS: {
851                 mousestatus_t *status = (mousestatus_t *) ap->a_data;
852
853                 crit_enter();
854                 *status = sc->status;
855                 sc->status.obutton = sc->status.button;
856                 sc->status.button = 0;
857                 sc->status.dx = sc->status.dy = sc->status.dz = 0;
858                 crit_exit();
859
860                 if (status->dx || status->dy || status->dz)
861                         status->flags |= MOUSE_POSCHANGED;
862                 if (status->button != status->obutton)
863                         status->flags |= MOUSE_BUTTONSCHANGED;
864                 break;
865                 }
866         default:
867                 error = ENOTTY;
868         }
869
870         return error;
871 }
872
873 DRIVER_MODULE(ums, uhub, ums_driver, ums_devclass, usbd_driver_load, 0);