Home | History | Annotate | Line # | Download | only in usb
ums.c revision 1.20
      1  1.20  augustss /*	$NetBSD: ums.c,v 1.20 1999/01/10 11:13:36 augustss Exp $	*/
      2   1.1  augustss 
      3   1.1  augustss /*
      4   1.1  augustss  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      5   1.1  augustss  * All rights reserved.
      6   1.1  augustss  *
      7  1.11  augustss  * This code is derived from software contributed to The NetBSD Foundation
      8  1.11  augustss  * by Lennart Augustsson (augustss (at) carlstedt.se) at
      9  1.11  augustss  * Carlstedt Research & Technology.
     10   1.1  augustss  *
     11   1.1  augustss  * Redistribution and use in source and binary forms, with or without
     12   1.1  augustss  * modification, are permitted provided that the following conditions
     13   1.1  augustss  * are met:
     14   1.1  augustss  * 1. Redistributions of source code must retain the above copyright
     15   1.1  augustss  *    notice, this list of conditions and the following disclaimer.
     16   1.1  augustss  * 2. Redistributions in binary form must reproduce the above copyright
     17   1.1  augustss  *    notice, this list of conditions and the following disclaimer in the
     18   1.1  augustss  *    documentation and/or other materials provided with the distribution.
     19   1.1  augustss  * 3. All advertising materials mentioning features or use of this software
     20   1.1  augustss  *    must display the following acknowledgement:
     21   1.1  augustss  *        This product includes software developed by the NetBSD
     22   1.1  augustss  *        Foundation, Inc. and its contributors.
     23   1.1  augustss  * 4. Neither the name of The NetBSD Foundation nor the names of its
     24   1.1  augustss  *    contributors may be used to endorse or promote products derived
     25   1.1  augustss  *    from this software without specific prior written permission.
     26   1.1  augustss  *
     27   1.1  augustss  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     28   1.1  augustss  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     29   1.1  augustss  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     30   1.1  augustss  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     31   1.1  augustss  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     32   1.1  augustss  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     33   1.1  augustss  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     34   1.1  augustss  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     35   1.1  augustss  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     36   1.1  augustss  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     37   1.1  augustss  * POSSIBILITY OF SUCH DAMAGE.
     38  1.20  augustss  */
     39  1.20  augustss 
     40  1.20  augustss /*
     41  1.20  augustss  * HID spec: http://www.usb.org/developers/data/usbhid10.pdf
     42   1.1  augustss  */
     43   1.1  augustss 
     44   1.1  augustss #include <sys/param.h>
     45   1.1  augustss #include <sys/systm.h>
     46   1.1  augustss #include <sys/kernel.h>
     47   1.1  augustss #include <sys/malloc.h>
     48  1.16  augustss #if defined(__NetBSD__)
     49   1.1  augustss #include <sys/device.h>
     50   1.1  augustss #include <sys/ioctl.h>
     51  1.16  augustss #elif defined(__FreeBSD__)
     52  1.16  augustss #include <sys/module.h>
     53  1.16  augustss #include <sys/bus.h>
     54  1.16  augustss #include <sys/ioccom.h>
     55  1.16  augustss #include <sys/conf.h>
     56  1.16  augustss #endif
     57   1.1  augustss #include <sys/tty.h>
     58   1.1  augustss #include <sys/file.h>
     59   1.1  augustss #include <sys/select.h>
     60   1.1  augustss #include <sys/proc.h>
     61   1.1  augustss #include <sys/vnode.h>
     62   1.1  augustss #include <sys/poll.h>
     63   1.1  augustss 
     64   1.1  augustss #include <dev/usb/usb.h>
     65   1.1  augustss #include <dev/usb/usbhid.h>
     66   1.1  augustss 
     67   1.1  augustss #include <dev/usb/usbdi.h>
     68   1.1  augustss #include <dev/usb/usbdi_util.h>
     69   1.1  augustss #include <dev/usb/usbdevs.h>
     70   1.1  augustss #include <dev/usb/usb_quirks.h>
     71   1.1  augustss #include <dev/usb/hid.h>
     72   1.1  augustss 
     73  1.16  augustss #if defined(__NetBSD__)
     74   1.3  augustss #include <dev/wscons/wsconsio.h>
     75   1.3  augustss #include <dev/wscons/wsmousevar.h>
     76  1.16  augustss #elif defined(__FreeBSD__)
     77  1.16  augustss #include <machine/mouse.h>
     78  1.16  augustss #endif
     79   1.3  augustss 
     80   1.1  augustss #ifdef USB_DEBUG
     81   1.1  augustss #define DPRINTF(x)	if (umsdebug) printf x
     82   1.1  augustss #define DPRINTFN(n,x)	if (umsdebug>(n)) printf x
     83   1.1  augustss int	umsdebug = 0;
     84   1.1  augustss #else
     85   1.1  augustss #define DPRINTF(x)
     86   1.1  augustss #define DPRINTFN(n,x)
     87   1.1  augustss #endif
     88   1.1  augustss 
     89  1.16  augustss #define UMSUNIT(s)	(minor(s)&0x1f)
     90  1.16  augustss 
     91  1.16  augustss #define PS2LBUTMASK	x01
     92  1.16  augustss #define PS2RBUTMASK	x02
     93  1.16  augustss #define PS2MBUTMASK	x04
     94   1.1  augustss #define PS2BUTMASK 0x0f
     95   1.1  augustss 
     96  1.16  augustss #define QUEUE_BUFSIZE	240	/* MUST be divisible by 3 _and_ 4 */
     97  1.16  augustss 
     98   1.1  augustss struct ums_softc {
     99  1.16  augustss 	bdevice sc_dev;			/* base device */
    100   1.1  augustss 	usbd_interface_handle sc_iface;	/* interface */
    101   1.1  augustss 	usbd_pipe_handle sc_intrpipe;	/* interrupt pipe */
    102   1.1  augustss 	int sc_ep_addr;
    103   1.1  augustss 
    104   1.1  augustss 	u_char *sc_ibuf;
    105   1.1  augustss 	u_int8_t sc_iid;
    106   1.1  augustss 	int sc_isize;
    107  1.16  augustss 	struct hid_location sc_loc_x, sc_loc_y, sc_loc_z;
    108  1.16  augustss 	struct hid_location *sc_loc_btn;
    109   1.1  augustss 
    110  1.16  augustss 	int sc_enabled;
    111   1.1  augustss 	int sc_disconnected;	/* device is gone */
    112   1.3  augustss 
    113  1.16  augustss 	int flags;		/* device configuration */
    114  1.16  augustss #define UMS_Z		0x01	/* z direction available */
    115  1.16  augustss 	int nbuttons;
    116  1.16  augustss 
    117  1.16  augustss #if defined(__NetBSD__)
    118  1.16  augustss 	u_char sc_buttons;	/* mouse button status */
    119   1.3  augustss 	struct device *sc_wsmousedev;
    120  1.16  augustss #elif defined(__FreeBSD__)
    121  1.16  augustss 	u_char		qbuf[QUEUE_BUFSIZE];
    122  1.16  augustss 	u_char		dummy[100];		/* just for safety and for now */
    123  1.16  augustss 	int		qcount, qhead, qtail;
    124  1.16  augustss 	mousehw_t	hw;
    125  1.16  augustss 	mousemode_t	mode;
    126  1.16  augustss 	mousestatus_t	status;
    127  1.16  augustss 
    128  1.16  augustss 	int		state;
    129  1.16  augustss #	  define	UMS_ASLEEP	0x01	/* readFromDevice is waiting */
    130  1.16  augustss #	  define	UMS_SELECT	0x02	/* select is waiting */
    131  1.16  augustss 	struct selinfo	rsel;		/* process waiting in select */
    132  1.16  augustss #endif
    133   1.1  augustss };
    134   1.1  augustss 
    135   1.2  augustss #define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE)
    136   1.2  augustss #define MOUSE_FLAGS (HIO_RELATIVE)
    137   1.2  augustss 
    138   1.1  augustss void ums_intr __P((usbd_request_handle, usbd_private_handle, usbd_status));
    139   1.1  augustss void ums_disco __P((void *));
    140   1.1  augustss 
    141  1.16  augustss static int	ums_enable __P((void *));
    142  1.16  augustss static void	ums_disable __P((void *));
    143  1.16  augustss 
    144  1.16  augustss #if defined(__NetBSD__)
    145  1.16  augustss static int	ums_ioctl __P((void *, u_long, caddr_t, int, struct proc *));
    146   1.3  augustss 
    147   1.3  augustss const struct wsmouse_accessops ums_accessops = {
    148   1.3  augustss 	ums_enable,
    149   1.3  augustss 	ums_ioctl,
    150   1.3  augustss 	ums_disable,
    151   1.3  augustss };
    152   1.3  augustss 
    153  1.16  augustss #elif defined(__FreeBSD__)
    154  1.16  augustss static d_open_t ums_open;
    155  1.16  augustss static d_close_t ums_close;
    156  1.16  augustss static d_read_t ums_read;
    157  1.16  augustss static d_ioctl_t ums_ioctl;
    158  1.16  augustss static d_poll_t ums_poll;
    159  1.16  augustss 
    160  1.19  augustss #define UMS_CDEV_MAJOR	111
    161  1.16  augustss 
    162  1.16  augustss static struct  cdevsw ums_cdevsw = {
    163  1.16  augustss 	ums_open,	ums_close,	ums_read,	nowrite,
    164  1.16  augustss 	ums_ioctl,	nostop,		nullreset,	nodevtotty,
    165  1.16  augustss 	ums_poll,	nommap,
    166  1.19  augustss 	NULL,		"ums",		NULL,		-1
    167  1.16  augustss };
    168  1.16  augustss #endif
    169   1.1  augustss 
    170  1.16  augustss USB_DECLARE_DRIVER(ums);
    171   1.1  augustss 
    172  1.16  augustss USB_MATCH(ums)
    173   1.1  augustss {
    174  1.16  augustss 	USB_MATCH_START(ums, uaa);
    175   1.1  augustss 	usb_interface_descriptor_t *id;
    176   1.1  augustss 	int size, ret;
    177   1.1  augustss 	void *desc;
    178   1.1  augustss 	usbd_status r;
    179   1.1  augustss 
    180   1.1  augustss 	if (!uaa->iface)
    181   1.1  augustss 		return (UMATCH_NONE);
    182   1.1  augustss 	id = usbd_get_interface_descriptor(uaa->iface);
    183  1.14  augustss 	if (!id || id->bInterfaceClass != UCLASS_HID)
    184   1.1  augustss 		return (UMATCH_NONE);
    185   1.1  augustss 
    186   1.1  augustss 	r = usbd_alloc_report_desc(uaa->iface, &desc, &size, M_TEMP);
    187   1.1  augustss 	if (r != USBD_NORMAL_COMPLETION)
    188   1.1  augustss 		return (UMATCH_NONE);
    189   1.1  augustss 
    190   1.1  augustss 	if (hid_is_collection(desc, size,
    191   1.1  augustss 			      HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
    192   1.1  augustss 		ret = UMATCH_IFACECLASS;
    193   1.1  augustss 	else
    194   1.1  augustss 		ret = UMATCH_NONE;
    195   1.1  augustss 
    196   1.1  augustss 	free(desc, M_TEMP);
    197   1.1  augustss 	return (ret);
    198   1.1  augustss }
    199   1.1  augustss 
    200  1.16  augustss USB_ATTACH(ums)
    201   1.1  augustss {
    202  1.16  augustss 	USB_ATTACH_START(ums, sc, uaa);
    203   1.1  augustss 	usbd_interface_handle iface = uaa->iface;
    204   1.1  augustss 	usb_interface_descriptor_t *id;
    205   1.1  augustss 	usb_endpoint_descriptor_t *ed;
    206  1.19  augustss #if defined(__NetBSD__)
    207   1.3  augustss 	struct wsmousedev_attach_args a;
    208  1.19  augustss #endif
    209   1.1  augustss 	int size;
    210   1.1  augustss 	void *desc;
    211   1.1  augustss 	usbd_status r;
    212   1.1  augustss 	char devinfo[1024];
    213   1.2  augustss 	u_int32_t flags;
    214  1.16  augustss 	int i;
    215  1.16  augustss 	struct hid_location loc_btn;
    216   1.1  augustss 
    217   1.1  augustss 	sc->sc_disconnected = 1;
    218   1.1  augustss 	sc->sc_iface = iface;
    219   1.1  augustss 	id = usbd_get_interface_descriptor(iface);
    220   1.1  augustss 	usbd_devinfo(uaa->device, 0, devinfo);
    221  1.16  augustss 	USB_ATTACH_SETUP;
    222  1.16  augustss 	printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
    223  1.12  augustss 	       devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
    224   1.1  augustss 	ed = usbd_interface2endpoint_descriptor(iface, 0);
    225   1.1  augustss 	if (!ed) {
    226   1.1  augustss 		printf("%s: could not read endpoint descriptor\n",
    227  1.16  augustss 		       USBDEVNAME(sc->sc_dev));
    228  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    229   1.1  augustss 	}
    230   1.1  augustss 
    231  1.15  augustss 	DPRINTFN(10,("ums_attach: bLength=%d bDescriptorType=%d "
    232  1.15  augustss 		     "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
    233  1.15  augustss 		     " bInterval=%d\n",
    234  1.15  augustss 		     ed->bLength, ed->bDescriptorType,
    235  1.15  augustss 		     ed->bEndpointAddress & UE_ADDR,
    236  1.15  augustss 		     ed->bEndpointAddress & UE_IN ? "in" : "out",
    237  1.15  augustss 		     ed->bmAttributes & UE_XFERTYPE,
    238  1.15  augustss 		     UGETW(ed->wMaxPacketSize), ed->bInterval));
    239   1.1  augustss 
    240   1.1  augustss 	if ((ed->bEndpointAddress & UE_IN) != UE_IN ||
    241   1.1  augustss 	    (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
    242   1.1  augustss 		printf("%s: unexpected endpoint\n",
    243  1.16  augustss 		       USBDEVNAME(sc->sc_dev));
    244  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    245   1.1  augustss 	}
    246   1.1  augustss 
    247   1.1  augustss 	r = usbd_alloc_report_desc(uaa->iface, &desc, &size, M_TEMP);
    248   1.1  augustss 	if (r != USBD_NORMAL_COMPLETION)
    249  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    250  1.16  augustss 
    251   1.2  augustss 	if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
    252   1.2  augustss 		       hid_input, &sc->sc_loc_x, &flags)) {
    253  1.16  augustss 		printf("%s: mouse has no X report\n", USBDEVNAME(sc->sc_dev));
    254  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    255  1.16  augustss 	}
    256  1.16  augustss 	if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
    257  1.16  augustss 		printf("%s: X report 0x%04x not supported\n",
    258  1.16  augustss 		       USBDEVNAME(sc->sc_dev), flags);
    259  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    260   1.1  augustss 	}
    261  1.10  augustss 
    262   1.2  augustss 	if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
    263   1.2  augustss 		       hid_input, &sc->sc_loc_y, &flags)) {
    264  1.16  augustss 		printf("%s: mouse has no Y report\n", USBDEVNAME(sc->sc_dev));
    265  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    266  1.16  augustss 	}
    267  1.16  augustss 	if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
    268  1.16  augustss 		printf("%s: Y report 0x%04x not supported\n",
    269  1.16  augustss 		       USBDEVNAME(sc->sc_dev), flags);
    270  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    271   1.1  augustss 	}
    272  1.10  augustss 
    273  1.16  augustss 	/* try to guess the Z activator: first check Z, then WHEEL */
    274   1.6  augustss 	if (hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Z),
    275   1.6  augustss 		       hid_input, &sc->sc_loc_z, &flags) ||
    276   1.6  augustss 	    hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_WHEEL),
    277   1.6  augustss 		       hid_input, &sc->sc_loc_z, &flags)) {
    278  1.16  augustss 		if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
    279  1.16  augustss 			sc->sc_loc_z.size = 0;	/* Bad Z coord, ignore it */
    280  1.16  augustss 		} else {
    281  1.16  augustss 			sc->flags |= UMS_Z;
    282  1.16  augustss 		}
    283   1.6  augustss 	}
    284   1.6  augustss 
    285  1.16  augustss 	/* figure out the number of buttons, 7 is an arbitrary limit */
    286  1.16  augustss 	for (i = 1; i <= 7; i++)
    287  1.16  augustss 		if (!hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
    288  1.16  augustss 				hid_input, &loc_btn, 0))
    289  1.16  augustss 			break;
    290  1.16  augustss 	sc->nbuttons = i - 1;
    291  1.16  augustss 	sc->sc_loc_btn = malloc(sizeof(struct hid_location)*sc->nbuttons,
    292  1.16  augustss 				M_USBDEV, M_NOWAIT);
    293  1.16  augustss 	if (!sc->sc_loc_btn)
    294  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    295  1.16  augustss 
    296  1.16  augustss 	printf("%s: %d buttons%s\n", USBDEVNAME(sc->sc_dev),
    297  1.16  augustss 	       sc->nbuttons, (sc->flags & UMS_Z? " and Z dir." : ""));
    298  1.16  augustss 
    299  1.16  augustss 	for (i = 1; i <= sc->nbuttons; i++)
    300  1.16  augustss 		hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
    301  1.16  augustss 				hid_input, &sc->sc_loc_btn[i-1], 0);
    302   1.1  augustss 
    303   1.1  augustss 	sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
    304   1.1  augustss 	sc->sc_ibuf = malloc(sc->sc_isize, M_USB, M_NOWAIT);
    305  1.16  augustss 	if (!sc->sc_ibuf) {
    306  1.16  augustss 		free(sc->sc_loc_btn, M_USB);
    307  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    308  1.16  augustss 	}
    309   1.1  augustss 
    310   1.1  augustss 	sc->sc_ep_addr = ed->bEndpointAddress;
    311   1.1  augustss 	sc->sc_disconnected = 0;
    312   1.1  augustss 	free(desc, M_TEMP);
    313   1.3  augustss 
    314  1.16  augustss #ifdef USB_DEBUG
    315  1.16  augustss 	DPRINTF(("ums_attach: sc=%p\n", sc));
    316  1.16  augustss 	DPRINTF(("ums_attach: X\t%d/%d\n",
    317  1.16  augustss 		 sc->sc_loc_x.pos, sc->sc_loc_x.size));
    318  1.16  augustss 	DPRINTF(("ums_attach: Y\t%d/%d\n",
    319  1.16  augustss 		 sc->sc_loc_x.pos, sc->sc_loc_x.size));
    320  1.16  augustss 	if (sc->flags & UMS_Z)
    321  1.16  augustss 		DPRINTF(("ums_attach: Z\t%d/%d\n",
    322  1.16  augustss 			 sc->sc_loc_z.pos, sc->sc_loc_z.size));
    323  1.16  augustss 	for (i = 1; i <= sc->nbuttons; i++) {
    324  1.16  augustss 		DPRINTF(("ums_attach: B%d\t%d/%d\n",
    325  1.16  augustss 			 i, sc->sc_loc_btn[i-1].pos,sc->sc_loc_btn[i-1].size));
    326  1.16  augustss 	}
    327  1.16  augustss 	DPRINTF(("ums_attach: size=%d, id=%d\n", sc->sc_isize, sc->sc_iid));
    328  1.16  augustss #endif
    329  1.16  augustss 
    330  1.16  augustss #if defined(__NetBSD__)
    331   1.3  augustss 	a.accessops = &ums_accessops;
    332   1.3  augustss 	a.accesscookie = sc;
    333   1.3  augustss 
    334   1.3  augustss 	sc->sc_wsmousedev = config_found(self, &a, wsmousedevprint);
    335  1.16  augustss #elif defined(__FreeBSD__)
    336  1.16  augustss 	sc->hw.buttons = 2;		/* XXX hw&mode values are bogus */
    337  1.16  augustss 	sc->hw.iftype = MOUSE_IF_PS2;
    338  1.16  augustss 	sc->hw.type = MOUSE_MOUSE;
    339  1.16  augustss 	if (sc->flags & UMS_Z)
    340  1.16  augustss 		sc->hw.model = MOUSE_MODEL_INTELLI;
    341  1.16  augustss 	else
    342  1.16  augustss 		sc->hw.model = MOUSE_MODEL_GENERIC;
    343  1.16  augustss 	sc->hw.hwid = 0;
    344  1.16  augustss 	sc->mode.protocol = MOUSE_PROTO_PS2;
    345  1.16  augustss 	sc->mode.rate = -1;
    346  1.16  augustss 	sc->mode.resolution = MOUSE_RES_DEFAULT;
    347  1.16  augustss 	sc->mode.accelfactor = 1;
    348  1.16  augustss 	sc->mode.level = 0;
    349  1.16  augustss 	if (sc->flags & UMS_Z) {
    350  1.16  augustss 		sc->mode.packetsize = MOUSE_INTELLI_PACKETSIZE;
    351  1.16  augustss 		sc->mode.syncmask[0] = 0xc8;
    352  1.16  augustss 	} else {
    353  1.16  augustss 		sc->mode.packetsize = MOUSE_PS2_PACKETSIZE;
    354  1.16  augustss 		sc->mode.syncmask[0] = 0xc0;
    355  1.16  augustss 	}
    356  1.16  augustss 	sc->mode.syncmask[1] = 0;
    357  1.16  augustss 
    358  1.16  augustss 	sc->status.flags = 0;
    359  1.16  augustss 	sc->status.button = sc->status.obutton = 0;
    360  1.16  augustss 	sc->status.dx = sc->status.dy = sc->status.dz = 0;
    361  1.16  augustss 
    362  1.16  augustss 	sc->rsel.si_flags = 0;
    363  1.16  augustss 	sc->rsel.si_pid = 0;
    364  1.16  augustss #endif
    365  1.16  augustss 
    366  1.16  augustss 	USB_ATTACH_SUCCESS_RETURN;
    367  1.16  augustss }
    368  1.16  augustss 
    369  1.16  augustss 
    370  1.16  augustss #if defined(__FreeBSD__)
    371  1.16  augustss static int
    372  1.16  augustss ums_detach(device_t self)
    373  1.16  augustss {
    374  1.16  augustss 	struct ums_softc *sc = device_get_softc(self);
    375  1.16  augustss 	char *devinfo = (char *) device_get_desc(self);
    376  1.16  augustss 
    377  1.16  augustss 	if (devinfo) {
    378  1.16  augustss 		device_set_desc(self, NULL);
    379  1.16  augustss 		free(devinfo, M_USB);
    380  1.16  augustss 	}
    381  1.16  augustss 	free(sc->sc_loc_btn, M_USB);
    382  1.16  augustss 	free(sc->sc_ibuf, M_USB);
    383  1.16  augustss 
    384  1.16  augustss 	return 0;
    385   1.1  augustss }
    386  1.16  augustss #endif
    387   1.1  augustss 
    388   1.1  augustss void
    389   1.1  augustss ums_disco(p)
    390   1.1  augustss 	void *p;
    391   1.1  augustss {
    392   1.1  augustss 	struct ums_softc *sc = p;
    393   1.8  augustss 
    394   1.8  augustss 	DPRINTF(("ums_disco: sc=%p\n", sc));
    395   1.8  augustss 	usbd_abort_pipe(sc->sc_intrpipe);
    396   1.1  augustss 	sc->sc_disconnected = 1;
    397   1.1  augustss }
    398   1.1  augustss 
    399   1.1  augustss void
    400   1.1  augustss ums_intr(reqh, addr, status)
    401   1.1  augustss 	usbd_request_handle reqh;
    402   1.1  augustss 	usbd_private_handle addr;
    403   1.1  augustss 	usbd_status status;
    404   1.1  augustss {
    405   1.1  augustss 	struct ums_softc *sc = addr;
    406   1.1  augustss 	u_char *ibuf;
    407   1.6  augustss 	int dx, dy, dz;
    408  1.16  augustss 	u_char buttons = 0;
    409  1.16  augustss 	int i;
    410  1.16  augustss #if defined(__NetBSD__)
    411  1.16  augustss #define UMS_BUT(i) ((i) == 1 || (i) == 2 ? 3 - (i) : i)
    412  1.16  augustss #elif defined(__FreeBSD__)
    413  1.16  augustss #define UMS_BUT(i) (i)
    414  1.16  augustss #endif
    415   1.1  augustss 
    416   1.1  augustss 	DPRINTFN(5, ("ums_intr: sc=%p status=%d\n", sc, status));
    417   1.1  augustss 	DPRINTFN(5, ("ums_intr: data = %02x %02x %02x\n",
    418   1.1  augustss 		     sc->sc_ibuf[0], sc->sc_ibuf[1], sc->sc_ibuf[2]));
    419   1.1  augustss 
    420   1.1  augustss 	if (status == USBD_CANCELLED)
    421   1.1  augustss 		return;
    422   1.1  augustss 
    423   1.1  augustss 	if (status != USBD_NORMAL_COMPLETION) {
    424   1.1  augustss 		DPRINTF(("ums_intr: status=%d\n", status));
    425   1.7  augustss 		usbd_clear_endpoint_stall_async(sc->sc_intrpipe);
    426   1.1  augustss 		return;
    427   1.1  augustss 	}
    428   1.1  augustss 
    429   1.1  augustss 	ibuf = sc->sc_ibuf;
    430   1.1  augustss 	if (sc->sc_iid) {
    431   1.1  augustss 		if (*ibuf++ != sc->sc_iid)
    432   1.1  augustss 			return;
    433   1.1  augustss 	}
    434   1.1  augustss 	dx =  hid_get_data(ibuf, &sc->sc_loc_x);
    435   1.1  augustss 	dy = -hid_get_data(ibuf, &sc->sc_loc_y);
    436   1.6  augustss 	dz =  hid_get_data(ibuf, &sc->sc_loc_z);
    437  1.16  augustss 	/* NWH Why are you modifying the button assignments here?
    438  1.16  augustss 	 * That's the purpose of a high level mouse driver
    439  1.16  augustss 	 */
    440  1.16  augustss 	for (i = 0; i < sc->nbuttons; i++)
    441  1.16  augustss 		if (hid_get_data(ibuf, &sc->sc_loc_btn[i]))
    442  1.16  augustss 			buttons |= (1 << UMS_BUT(i));
    443   1.4  augustss 
    444  1.16  augustss #if defined(__NetBSD__)
    445   1.4  augustss 	if (dx || dy || buttons != sc->sc_buttons) {
    446  1.16  augustss 		DPRINTFN(10, ("ums_intr: x:%d y:%d z:%d buttons:0x%x\n",
    447  1.16  augustss 			dx, dy, dz, buttons));
    448   1.4  augustss 		sc->sc_buttons = buttons;
    449   1.4  augustss 		if (sc->sc_wsmousedev)
    450   1.6  augustss 			wsmouse_input(sc->sc_wsmousedev, buttons, dx, dy, dz);
    451  1.16  augustss #elif defined(__FreeBSD__)
    452  1.16  augustss 	if (dx || dy || buttons != sc->status.button) {
    453  1.16  augustss 		DPRINTFN(10, ("ums_intr: x:%d y:%d z:%d buttons:0x%x\n",
    454  1.16  augustss 			dx, dy, dz, buttons));
    455  1.16  augustss 
    456  1.16  augustss 		sc->status.button = buttons;
    457  1.16  augustss 		sc->status.dx += dx;
    458  1.16  augustss 		sc->status.dy += dy;
    459  1.16  augustss 		sc->status.dz += dz;
    460  1.16  augustss 
    461  1.16  augustss 		/* Discard data in case of full buffer */
    462  1.16  augustss 		if (sc->qcount == sizeof(sc->qbuf)) {
    463  1.16  augustss 			DPRINTF(("Buffer full, discarded packet"));
    464  1.16  augustss 			return;
    465  1.16  augustss 		}
    466  1.16  augustss 
    467  1.16  augustss 		sc->qbuf[sc->qhead] = MOUSE_PS2_SYNC;
    468  1.16  augustss 		if (dx < 0)
    469  1.16  augustss 			sc->qbuf[sc->qhead] |= MOUSE_PS2_XNEG;
    470  1.16  augustss 		if (dx > 255 || dx < -255)
    471  1.16  augustss 			sc->qbuf[sc->qhead] |= MOUSE_PS2_XOVERFLOW;
    472  1.16  augustss 		if (dy < 0)
    473  1.16  augustss 			sc->qbuf[sc->qhead] |= MOUSE_PS2_YNEG;
    474  1.16  augustss 		if (dy > 255 || dy < -255)
    475  1.16  augustss 			sc->qbuf[sc->qhead] |= MOUSE_PS2_YOVERFLOW;
    476  1.16  augustss 		sc->qbuf[sc->qhead++] |= buttons;
    477  1.16  augustss 		sc->qbuf[sc->qhead++] = dx;
    478  1.16  augustss 		sc->qbuf[sc->qhead++] = dy;
    479  1.16  augustss 		sc->qcount += 3;
    480  1.16  augustss 		if (sc->flags & UMS_Z) {
    481  1.16  augustss 			sc->qbuf[sc->qhead++] = dz;
    482  1.16  augustss 			sc->qcount++;
    483  1.16  augustss 		}
    484  1.16  augustss #ifdef USB_DEBUG
    485  1.16  augustss 		if (sc->qhead > sizeof(sc->qbuf))
    486  1.16  augustss 			DPRINTF(("Buffer overrun! %d %d\n",
    487  1.16  augustss 				 sc->qhead, sizeof(sc->qbuf)));
    488  1.16  augustss #endif
    489  1.16  augustss 		/* wrap round at end of buffer */
    490  1.16  augustss 		if (sc->qhead >= sizeof(sc->qbuf))
    491  1.16  augustss 			sc->qhead = 0;
    492  1.16  augustss 
    493  1.16  augustss 		/* someone waiting for data */
    494  1.16  augustss 		if (sc->state & UMS_ASLEEP)
    495  1.16  augustss 			wakeup(sc);
    496  1.16  augustss 		/* wake up any pending selects */
    497  1.16  augustss 		selwakeup(&sc->rsel);
    498  1.16  augustss 		sc->state &= ~UMS_SELECT;
    499  1.16  augustss #endif
    500   1.1  augustss 	}
    501   1.1  augustss }
    502   1.3  augustss 
    503  1.16  augustss 
    504  1.16  augustss static int
    505   1.3  augustss ums_enable(v)
    506   1.3  augustss 	void *v;
    507   1.3  augustss {
    508   1.3  augustss 	struct ums_softc *sc = v;
    509  1.16  augustss 
    510   1.3  augustss 	usbd_status r;
    511   1.3  augustss 
    512   1.3  augustss 	if (sc->sc_enabled)
    513   1.3  augustss 		return EBUSY;
    514   1.3  augustss 
    515   1.3  augustss 	sc->sc_enabled = 1;
    516  1.16  augustss #if defined(__NetBSD__)
    517   1.4  augustss 	sc->sc_buttons = 0;
    518  1.16  augustss #elif defined(__FreeBSD__)
    519  1.16  augustss 	sc->qcount = 0;
    520  1.16  augustss 	sc->qhead = sc->qtail = 0;
    521  1.16  augustss #ifdef USB_DEBUG
    522  1.16  augustss 	if (sizeof(sc->qbuf) % 4 || sizeof(sc->qbuf) % 3) {
    523  1.16  augustss 		DPRINTF(("Buffer size not divisible by 3 or 4\n"));
    524  1.16  augustss 		return ENXIO;
    525  1.16  augustss 	}
    526  1.16  augustss #endif
    527  1.16  augustss 	sc->status.flags = 0;
    528  1.16  augustss 	sc->status.button = sc->status.obutton = 0;
    529  1.16  augustss 	sc->status.dx = sc->status.dy = sc->status.dz = 0;
    530  1.16  augustss #endif
    531   1.3  augustss 
    532   1.3  augustss 	/* Set up interrupt pipe. */
    533   1.3  augustss 	r = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
    534   1.3  augustss 				USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc,
    535   1.3  augustss 				sc->sc_ibuf, sc->sc_isize, ums_intr);
    536   1.3  augustss 	if (r != USBD_NORMAL_COMPLETION) {
    537   1.3  augustss 		DPRINTF(("ums_enable: usbd_open_pipe_intr failed, error=%d\n",
    538   1.3  augustss 			 r));
    539   1.3  augustss 		sc->sc_enabled = 0;
    540   1.3  augustss 		return (EIO);
    541   1.3  augustss 	}
    542   1.3  augustss 	usbd_set_disco(sc->sc_intrpipe, ums_disco, sc);
    543   1.3  augustss 	return (0);
    544   1.3  augustss }
    545   1.3  augustss 
    546  1.16  augustss static void
    547   1.3  augustss ums_disable(v)
    548   1.3  augustss 	void *v;
    549   1.3  augustss {
    550   1.3  augustss 	struct ums_softc *sc = v;
    551   1.3  augustss 
    552   1.3  augustss 	/* Disable interrupts. */
    553   1.3  augustss 	usbd_abort_pipe(sc->sc_intrpipe);
    554   1.3  augustss 	usbd_close_pipe(sc->sc_intrpipe);
    555   1.3  augustss 
    556   1.3  augustss 	sc->sc_enabled = 0;
    557  1.16  augustss 
    558  1.16  augustss #if defined(USBVERBOSE) && defined(__FreeBSD__)
    559  1.16  augustss 	if (sc->qcount != 0)
    560  1.16  augustss 		DPRINTF(("Discarded %d bytes in queue\n", sc->qcount));
    561  1.16  augustss #endif
    562   1.3  augustss }
    563   1.3  augustss 
    564  1.16  augustss #if defined(__NetBSD__)
    565  1.16  augustss static int
    566   1.3  augustss ums_ioctl(v, cmd, data, flag, p)
    567   1.3  augustss 	void *v;
    568   1.3  augustss 	u_long cmd;
    569   1.3  augustss 	caddr_t data;
    570   1.3  augustss 	int flag;
    571   1.3  augustss 	struct proc *p;
    572  1.16  augustss 
    573   1.3  augustss {
    574   1.3  augustss 	switch (cmd) {
    575   1.3  augustss 	case WSMOUSEIO_GTYPE:
    576  1.17  augustss 		*(u_int *)data = WSMOUSE_TYPE_USB;
    577   1.3  augustss 		return (0);
    578   1.3  augustss 	}
    579  1.16  augustss 
    580   1.3  augustss 	return (-1);
    581   1.3  augustss }
    582  1.16  augustss 
    583  1.16  augustss #elif defined(__FreeBSD__)
    584  1.16  augustss static int
    585  1.16  augustss ums_open(dev_t dev, int flag, int fmt, struct proc *p)
    586  1.16  augustss {
    587  1.16  augustss 	struct ums_softc *sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
    588  1.16  augustss 
    589  1.16  augustss 	if (!sc) {
    590  1.16  augustss 		DPRINTF(("sc not found at open"));
    591  1.16  augustss 		return EINVAL;
    592  1.16  augustss 	}
    593  1.16  augustss 
    594  1.16  augustss 	return ums_enable(sc);
    595  1.16  augustss }
    596  1.16  augustss 
    597  1.16  augustss static int
    598  1.16  augustss ums_close(dev_t dev, int flag, int fmt, struct proc *p)
    599  1.16  augustss {
    600  1.16  augustss 	struct ums_softc *sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
    601  1.16  augustss 
    602  1.16  augustss 	if (!sc) {
    603  1.16  augustss 		DPRINTF(("sc not found at close"));
    604  1.16  augustss 		return EINVAL;
    605  1.16  augustss 	}
    606  1.16  augustss 
    607  1.16  augustss 	if (sc->sc_enabled)
    608  1.16  augustss 		ums_disable(sc);
    609  1.16  augustss 	return 0;
    610  1.16  augustss }
    611  1.16  augustss 
    612  1.16  augustss static int
    613  1.16  augustss ums_read(dev_t dev, struct uio *uio, int flag)
    614  1.16  augustss {
    615  1.16  augustss 	struct ums_softc *sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
    616  1.16  augustss 	int s;
    617  1.16  augustss 	char buf[sizeof(sc->qbuf)];
    618  1.16  augustss 	int l = 0;
    619  1.16  augustss 	int error;
    620  1.16  augustss 
    621  1.16  augustss 	if (!sc || !sc->sc_enabled) {
    622  1.16  augustss 		DPRINTF(("sc not found at read"));
    623  1.16  augustss 		return EINVAL;
    624  1.16  augustss 	}
    625  1.16  augustss 
    626  1.16  augustss 	s = splusb();
    627  1.16  augustss 	while (sc->qcount == 0 )  {
    628  1.16  augustss 		/* NWH XXX non blocking I/O ??
    629  1.16  augustss 		if (non blocking I/O ) {
    630  1.16  augustss 			splx(s);
    631  1.16  augustss 			return EWOULDBLOCK;
    632  1.16  augustss 		} else {
    633  1.16  augustss 		*/
    634  1.16  augustss 		sc->state |= UMS_ASLEEP;
    635  1.16  augustss 		error = tsleep(sc, PZERO | PCATCH, "umsrea", 0);
    636  1.16  augustss 		sc->state &= ~UMS_ASLEEP;
    637  1.16  augustss 		if (error) {
    638  1.16  augustss 			splx(s);
    639  1.16  augustss 			return error;
    640  1.16  augustss 		}
    641  1.16  augustss 	}
    642  1.16  augustss 
    643  1.16  augustss 	while ((sc->qcount > 0) && (uio->uio_resid > 0)) {
    644  1.16  augustss 		l = (sc->qcount < uio->uio_resid? sc->qcount:uio->uio_resid);
    645  1.16  augustss 		if (l > sizeof(buf))
    646  1.16  augustss 			l = sizeof(buf);
    647  1.16  augustss 		if (l > sizeof(sc->qbuf) - sc->qtail)		/* transfer till end of buf */
    648  1.16  augustss 			l = sizeof(sc->qbuf) - sc->qtail;
    649  1.16  augustss 
    650  1.16  augustss 		splx(s);
    651  1.16  augustss 		uiomove(&sc->qbuf[sc->qtail], l, uio);
    652  1.16  augustss 		s = splusb();
    653  1.16  augustss 
    654  1.16  augustss 		if ( sc->qcount - l < 0 ) {
    655  1.16  augustss 			DPRINTF(("qcount below 0, count=%d l=%d\n", sc->qcount, l));
    656  1.16  augustss 			sc->qcount = l;
    657  1.16  augustss 		}
    658  1.16  augustss 		sc->qcount -= l;	/* remove the bytes from the buffer */
    659  1.16  augustss 		sc->qtail = (sc->qtail + l) % sizeof(sc->qbuf);
    660  1.16  augustss 	}
    661  1.16  augustss 	splx(s);
    662  1.16  augustss 
    663  1.16  augustss 	return 0;
    664  1.16  augustss }
    665  1.16  augustss 
    666  1.16  augustss static int
    667  1.16  augustss ums_poll(dev_t dev, int events, struct proc *p)
    668  1.16  augustss {
    669  1.16  augustss 	struct ums_softc *sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
    670  1.16  augustss 	int revents = 0;
    671  1.16  augustss 	int s;
    672  1.16  augustss 
    673  1.16  augustss 	if (!sc) {
    674  1.16  augustss 		DPRINTF(("sc not found at poll"));
    675  1.16  augustss 		return 0;	/* just to make sure */
    676  1.16  augustss 	}
    677  1.16  augustss 
    678  1.16  augustss 	s = splusb();
    679  1.16  augustss 	if (events & (POLLIN | POLLRDNORM))
    680  1.16  augustss 		if (sc->qcount) {
    681  1.16  augustss 			revents = events & (POLLIN | POLLRDNORM);
    682  1.16  augustss 		} else {
    683  1.16  augustss 			sc->state |= UMS_SELECT;
    684  1.16  augustss 			selrecord(p, &sc->rsel);
    685  1.16  augustss 		}
    686  1.16  augustss 	splx(s);
    687  1.16  augustss 
    688  1.16  augustss 	return revents;
    689  1.16  augustss }
    690  1.16  augustss 
    691  1.16  augustss int
    692  1.16  augustss ums_ioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct proc *p)
    693  1.16  augustss {
    694  1.16  augustss 	struct ums_softc *sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
    695  1.16  augustss 	int error = 0;
    696  1.16  augustss 	int s;
    697  1.16  augustss 
    698  1.16  augustss 	if (!sc) {
    699  1.16  augustss 		DPRINTF(("sc not found at ioctl"));
    700  1.16  augustss 		return ENOENT;
    701  1.16  augustss 	}
    702  1.16  augustss 
    703  1.16  augustss 	switch(cmd) {
    704  1.16  augustss 	case MOUSE_GETHWINFO:
    705  1.16  augustss 		*(mousehw_t *)addr = sc->hw;
    706  1.16  augustss 		break;
    707  1.16  augustss 	case MOUSE_GETMODE:
    708  1.16  augustss 		*(mousemode_t *)addr = sc->mode;
    709  1.16  augustss 		break;
    710  1.16  augustss 	case MOUSE_GETLEVEL:
    711  1.16  augustss 		*(int *)addr = sc->mode.level;
    712  1.16  augustss 		break;
    713  1.16  augustss 	case MOUSE_GETSTATUS: {
    714  1.16  augustss 		mousestatus_t *status = (mousestatus_t *) addr;
    715  1.16  augustss 
    716  1.16  augustss 		s = splusb();
    717  1.16  augustss 		*status = sc->status;
    718  1.16  augustss 		sc->status.obutton = sc->status.button;
    719  1.16  augustss 		sc->status.button = 0;
    720  1.16  augustss 		sc->status.dx = sc->status.dy = sc->status.dz = 0;
    721  1.16  augustss 		splx(s);
    722  1.16  augustss 
    723  1.16  augustss 		if (status->dx || status->dy || status->dz)
    724  1.16  augustss 			status->flags |= MOUSE_POSCHANGED;
    725  1.16  augustss 		if (status->button != status->obutton)
    726  1.16  augustss 			status->flags |= MOUSE_BUTTONSCHANGED;
    727  1.16  augustss 		break;
    728  1.16  augustss 		}
    729  1.16  augustss 	default:
    730  1.16  augustss 		error = ENOTTY;
    731  1.16  augustss 	}
    732  1.16  augustss 
    733  1.16  augustss 	return error;
    734  1.16  augustss }
    735  1.16  augustss #endif
    736  1.16  augustss 
    737  1.16  augustss #if defined(__FreeBSD__)
    738  1.16  augustss CDEV_DRIVER_MODULE(ums, usb, ums_driver, ums_devclass,
    739  1.19  augustss 			UMS_CDEV_MAJOR, ums_cdevsw, usbd_driver_load, 0);
    740  1.16  augustss #endif
    741   1.3  augustss 
    742