xref: /src/sys/dev/usb/ums.c

/*	$NetBSD: ums.c,v 1.2 1998/07/24 20:59:57 augustss Exp $	*/

/*
 * Copyright (c) 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * Author: Lennart Augustsson <augustss (at) carlstedt.se>
 *         Carlstedt Research & Technology
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *        This product includes software developed by the NetBSD
 *        Foundation, Inc. and its contributors.
 * 4. Neither the name of The NetBSD Foundation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/malloc.h>
#include <sys/device.h>
#include <sys/ioctl.h>
#include <sys/tty.h>
#include <sys/file.h>
#include <sys/select.h>
#include <sys/proc.h>
#include <sys/vnode.h>
#include <sys/device.h>
#include <sys/poll.h>

#include <machine/mouse.h>

#include <dev/usb/usb.h>
#include <dev/usb/usbhid.h>

#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include <dev/usb/usbdevs.h>
#include <dev/usb/usb_quirks.h>
#include <dev/usb/hid.h>

#ifdef USB_DEBUG
#define DPRINTF(x)	if (umsdebug) printf x
#define DPRINTFN(n,x)	if (umsdebug>(n)) printf x
int	umsdebug = 0;
#else
#define DPRINTF(x)
#define DPRINTFN(n,x)
#endif

#define PS2LBUTMASK 0x01
#define PS2RBUTMASK 0x02
#define PS2MBUTMASK 0x04
#define PS2BUTMASK 0x0f

struct ums_softc {
	struct device sc_dev;		/* base device */
	usbd_interface_handle sc_iface;	/* interface */
	usbd_pipe_handle sc_intrpipe;	/* interrupt pipe */
	int sc_ep_addr;

	u_char *sc_ibuf;
	u_int8_t sc_iid;
	int sc_isize;
	struct hid_location sc_loc_x, sc_loc_y,
		sc_loc_btn1, sc_loc_btn2, sc_loc_btn3;

	struct clist sc_q;
	struct selinfo sc_rsel;
	u_char sc_state;	/* mouse driver state */
#define	UMS_OPEN	0x01	/* device is open */
#define	UMS_ASLP	0x02	/* waiting for mouse data */
#define UMS_NEEDCLEAR	0x04	/* needs clearing endpoint stall */
	u_char sc_status;	/* mouse button status */
	int sc_x, sc_y;		/* accumulated motion in the X,Y axis */
	int sc_disconnected;	/* device is gone */
};

#define	UMSUNIT(dev)	(minor(dev))
#define	UMS_CHUNK	128	/* chunk size for read */
#define	UMS_BSIZE	1020	/* buffer size */

#define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE)
#define MOUSE_FLAGS (HIO_RELATIVE)

int ums_match __P((struct device *, struct cfdata *, void *));
void ums_attach __P((struct device *, struct device *, void *));

int umsopen __P((dev_t, int, int, struct proc *));
int umsclose __P((dev_t, int, int, struct proc *p));
int umsread __P((dev_t, struct uio *uio, int));
int umsioctl __P((dev_t, u_long, caddr_t, int, struct proc *));
int umspoll __P((dev_t, int, struct proc *));
void ums_intr __P((usbd_request_handle, usbd_private_handle, usbd_status));
void ums_disco __P((void *));

extern struct cfdriver ums_cd;

struct cfattach ums_ca = {
	sizeof(struct ums_softc), ums_match, ums_attach
};

int
ums_match(parent, match, aux)
	struct device *parent;
	struct cfdata *match;
	void *aux;
{
	struct usb_attach_arg *uaa = aux;
	usb_interface_descriptor_t *id;
	int size, ret;
	void *desc;
	usbd_status r;

	if (!uaa->iface)
		return (UMATCH_NONE);
	id = usbd_get_interface_descriptor(uaa->iface);
	if (id->bInterfaceClass != UCLASS_HID)
		return (UMATCH_NONE);

	r = usbd_alloc_report_desc(uaa->iface, &desc, &size, M_TEMP);
	if (r != USBD_NORMAL_COMPLETION)
		return (UMATCH_NONE);

	if (hid_is_collection(desc, size,
			      HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
		ret = UMATCH_IFACECLASS;
	else
		ret = UMATCH_NONE;

	free(desc, M_TEMP);
	return (ret);
}

void
ums_attach(parent, self, aux)
	struct device *parent;
	struct device *self;
	void *aux;
{
	struct ums_softc *sc = (struct ums_softc *)self;
	struct usb_attach_arg *uaa = aux;
	usbd_interface_handle iface = uaa->iface;
	usb_interface_descriptor_t *id;
	usb_endpoint_descriptor_t *ed;
	int size;
	void *desc;
	usbd_status r;
	char devinfo[1024];
	u_int32_t flags;

	sc->sc_disconnected = 1;
	sc->sc_iface = iface;
	id = usbd_get_interface_descriptor(iface);
	usbd_devinfo(uaa->device, 0, devinfo);
	printf(": %s (interface class %d/%d)\n", devinfo,
	       id->bInterfaceClass, id->bInterfaceSubClass);
	ed = usbd_interface2endpoint_descriptor(iface, 0);
	if (!ed) {
		printf("%s: could not read endpoint descriptor\n",
		       sc->sc_dev.dv_xname);
		return;
	}

	DPRINTFN(10,("ums_attach: \
bLength=%d bDescriptorType=%d bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d bInterval=%d\n",
	       ed->bLength, ed->bDescriptorType, ed->bEndpointAddress & UE_ADDR,
	       ed->bEndpointAddress & UE_IN ? "in" : "out",
	       ed->bmAttributes & UE_XFERTYPE,
	       UGETW(ed->wMaxPacketSize), ed->bInterval));

	if ((ed->bEndpointAddress & UE_IN) != UE_IN ||
	    (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
		printf("%s: unexpected endpoint\n",
		       sc->sc_dev.dv_xname);
		return;
	}

	r = usbd_alloc_report_desc(uaa->iface, &desc, &size, M_TEMP);
	if (r != USBD_NORMAL_COMPLETION)
		return;
	if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
		       hid_input, &sc->sc_loc_x, &flags)) {
		printf("%s: mouse has no X report\n", sc->sc_dev.dv_xname);
		return;
	}
	if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS)
		printf("%s: sorry, X report 0x%04x not supported yet\n",
		       sc->sc_dev.dv_xname, flags);
	if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
		       hid_input, &sc->sc_loc_y, &flags)) {
		printf("%s: mouse has no Y report\n", sc->sc_dev.dv_xname);
		return;
	}
	if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS)
		printf("%s: sorry, Y report 0x%04x not supported yet\n",
		       sc->sc_dev.dv_xname, flags);
	hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, 1),
		   hid_input, &sc->sc_loc_btn1, 0);
	hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, 2),
		   hid_input, &sc->sc_loc_btn2, 0);
	hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, 3),
		   hid_input, &sc->sc_loc_btn3, 0);
	DPRINTF(("ums_attach: sc=%p\n", sc));
	DPRINTF(("ums_attach: X  %d/%d\n",
		 sc->sc_loc_x.pos, sc->sc_loc_x.size));
	DPRINTF(("ums_attach: Y  %d/%d\n",
		 sc->sc_loc_x.pos, sc->sc_loc_x.size));
	DPRINTF(("ums_attach: B1 %d/%d\n",
		 sc->sc_loc_btn1.pos,sc->sc_loc_btn1.size));
	DPRINTF(("ums_attach: B2 %d/%d\n",
		 sc->sc_loc_btn2.pos,sc->sc_loc_btn2.size));
	DPRINTF(("ums_attach: B3 %d/%d\n",
		 sc->sc_loc_btn3.pos,sc->sc_loc_btn3.size));

	sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
	DPRINTF(("ums_attach: size=%d, id=%d\n", sc->sc_isize, sc->sc_iid));
	sc->sc_ibuf = malloc(sc->sc_isize, M_USB, M_NOWAIT);
	if (!sc->sc_ibuf)
		return;

	sc->sc_ep_addr = ed->bEndpointAddress;
	sc->sc_disconnected = 0;
	free(desc, M_TEMP);
}

void
ums_disco(p)
	void *p;
{
	struct ums_softc *sc = p;
	sc->sc_disconnected = 1;
}

void
ums_intr(reqh, addr, status)
	usbd_request_handle reqh;
	usbd_private_handle addr;
	usbd_status status;
{
	struct ums_softc *sc = addr;
	u_char *ibuf;
	char dx, dy;
	u_char buttons, changed;
	u_char buffer[5];

	DPRINTFN(5, ("ums_intr: sc=%p status=%d\n", sc, status));
	DPRINTFN(5, ("ums_intr: data = %02x %02x %02x\n",
		     sc->sc_ibuf[0], sc->sc_ibuf[1], sc->sc_ibuf[2]));

	if (status == USBD_CANCELLED)
		return;

	if (status != USBD_NORMAL_COMPLETION) {
		DPRINTF(("ums_intr: status=%d\n", status));
		sc->sc_state |= UMS_NEEDCLEAR;
		return;
	}

	ibuf = sc->sc_ibuf;
	if (sc->sc_iid) {
		if (*ibuf++ != sc->sc_iid)
			return;
	}
	DPRINTF(("ums_attach: X  %d/%d\n",
		 sc->sc_loc_x.pos, sc->sc_loc_x.size));
	dx =  hid_get_data(ibuf, &sc->sc_loc_x);
	dy = -hid_get_data(ibuf, &sc->sc_loc_y);
	buttons = 0;
	if (hid_get_data(ibuf, &sc->sc_loc_btn1)) buttons |= PS2LBUTMASK;
	if (hid_get_data(ibuf, &sc->sc_loc_btn2)) buttons |= PS2RBUTMASK;
	if (hid_get_data(ibuf, &sc->sc_loc_btn3)) buttons |= PS2MBUTMASK;

	buttons = ((buttons & PS2LBUTMASK) << 2) |
		  ((buttons & (PS2RBUTMASK | PS2MBUTMASK)) >> 1);
	changed = ((buttons ^ sc->sc_status) & BUTSTATMASK) << 3;
	sc->sc_status = buttons | (sc->sc_status & ~BUTSTATMASK) | changed;

	if (dx || dy || changed) {
		/* Update accumulated movements. */
		sc->sc_x += dx;
		sc->sc_y += dy;

		/* Add this event to the queue. */
		buffer[0] = 0x80 | (buttons ^ BUTSTATMASK);
		buffer[1] = dx;
		buffer[2] = dy;
		buffer[3] = buffer[4] = 0;
		(void) b_to_q(buffer, sizeof buffer, &sc->sc_q);

		if (sc->sc_state & UMS_ASLP) {
			sc->sc_state &= ~UMS_ASLP;
			DPRINTFN(5, ("ums_intr: waking %p\n", sc));
			wakeup((caddr_t)sc);
		}
		selwakeup(&sc->sc_rsel);
	}
}

int
umsopen(dev, flag, mode, p)
	dev_t dev;
	int flag;
	int mode;
	struct proc *p;
{
	int unit = UMSUNIT(dev);
	struct ums_softc *sc;
	usbd_status r;

	if (unit >= ums_cd.cd_ndevs)
		return ENXIO;
	sc = ums_cd.cd_devs[unit];
	if (!sc)
		return ENXIO;

	DPRINTF(("umsopen: sc=%p, disco=%d\n", sc, sc->sc_disconnected));

	if (sc->sc_disconnected)
		return (EIO);

	if (sc->sc_state & UMS_OPEN)
		return EBUSY;

	if (clalloc(&sc->sc_q, UMS_BSIZE, 0) == -1)
		return ENOMEM;

	sc->sc_state |= UMS_OPEN;
	sc->sc_status = 0;

	/* Set up interrupt pipe. */
	r = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
				USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc,
				sc->sc_ibuf, sc->sc_isize, ums_intr);
	if (r != USBD_NORMAL_COMPLETION) {
		DPRINTF(("umsopen: usbd_open_pipe_intr failed, error=%d\n",r));
		sc->sc_state &= ~UMS_OPEN;
		clfree(&sc->sc_q);
		return (EIO);
	}
	usbd_set_disco(sc->sc_intrpipe, ums_disco, sc);
	return 0;
}

int
umsclose(dev, flag, mode, p)
	dev_t dev;
	int flag;
	int mode;
	struct proc *p;
{
	struct ums_softc *sc = ums_cd.cd_devs[UMSUNIT(dev)];

	if (sc->sc_disconnected)
		return (EIO);

	DPRINTF(("umsclose: sc=%p\n", sc));

	/* Disable interrupts. */
	usbd_abort_pipe(sc->sc_intrpipe);
	usbd_close_pipe(sc->sc_intrpipe);

	sc->sc_state &= ~UMS_OPEN;

	clfree(&sc->sc_q);

	return 0;
}

int
umsread(dev, uio, flag)
	dev_t dev;
	struct uio *uio;
	int flag;
{
	struct ums_softc *sc = ums_cd.cd_devs[UMSUNIT(dev)];
	int s;
	int error = 0;
	size_t length;
	u_char buffer[UMS_CHUNK];

	/* Block until mouse activity occured. */

	if (sc->sc_disconnected)
		return (EIO);

	s = spltty();
	while (sc->sc_q.c_cc == 0) {
		if (flag & IO_NDELAY) {
			splx(s);
			return EWOULDBLOCK;
		}
		sc->sc_state |= UMS_ASLP;
		DPRINTFN(5, ("umsread: sleep on %p\n", sc));
		error = tsleep((caddr_t)sc, PZERO | PCATCH, "umsrea", 0);
		DPRINTFN(5, ("umsread: woke, error=%d\n", error));
		if (error) {
			sc->sc_state &= ~UMS_ASLP;
			splx(s);
			return error;
		}
		if (sc->sc_state & UMS_NEEDCLEAR) {
			DPRINTFN(-1,("umsread: clearing stall\n"));
			sc->sc_state &= ~UMS_NEEDCLEAR;
			usbd_clear_endpoint_stall(sc->sc_intrpipe);
		}
	}
	splx(s);

	/* Transfer as many chunks as possible. */
	while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0) {
		length = min(sc->sc_q.c_cc, uio->uio_resid);
		if (length > sizeof(buffer))
			length = sizeof(buffer);

		/* Remove a small chunk from the input queue. */
		(void) q_to_b(&sc->sc_q, buffer, length);
		DPRINTFN(5, ("umsread: got %d chars\n", length));

		/* Copy the data to the user process. */
		if ((error = uiomove(buffer, length, uio)) != 0)
			break;
	}

	return error;
}

int
umsioctl(dev, cmd, addr, flag, p)
	dev_t dev;
	u_long cmd;
	caddr_t addr;
	int flag;
	struct proc *p;
{
	struct ums_softc *sc = ums_cd.cd_devs[UMSUNIT(dev)];

	if (sc->sc_disconnected)
		return (EIO);

	return EINVAL;
}

int
umspoll(dev, events, p)
	dev_t dev;
	int events;
	struct proc *p;
{
	struct ums_softc *sc = ums_cd.cd_devs[UMSUNIT(dev)];
	int revents = 0;
	int s;

	if (sc->sc_disconnected)
		return (EIO);

	s = spltty();
	if (events & (POLLIN | POLLRDNORM))
		if (sc->sc_q.c_cc > 0)
			revents |= events & (POLLIN | POLLRDNORM);
		else
			selrecord(p, &sc->sc_rsel);

	splx(s);
	return (revents);
}