Much cleaner sync with NetBSD. Some #if defined() magic has been sent in the

form of a diff to augustss@netbsd.org so that future syncs will be very easy.
This commit also adds support for ADMtek AN986 "Pegasus" based USB Ethernet,
CATC USB-EL1210A based USB Ethernet, and USB Printers (all untested).

1 files changed, 594 insertions, 0 deletions

diff --git a/sys/dev/usb/ulpt.c b/sys/dev/usb/ulpt.c
new file mode 100644
index 00000000000..93ade608e84
--- /dev/null
+++ b/sys/dev/usb/ulpt.c
@@ -0,0 +1,594 @@
+/*	$OpenBSD: ulpt.c,v 1.1 2000/03/28 19:37:50 aaron Exp $ */
+/*	$NetBSD: ulpt.c,v 1.33 2000/03/06 20:58:39 augustss Exp $	*/
+/*	$FreeBSD: src/sys/dev/usb/ulpt.c,v 1.24 1999/11/17 22:33:44 n_hibma Exp $	*/
+
+/*
+ * Copyright (c) 1998 The NetBSD Foundation, Inc.
+ * All rights reserved.
+ *
+ * This code is derived from software contributed to The NetBSD Foundation
+ * by Lennart Augustsson (augustss@carlstedt.se) at
+ * 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.
+ */
+
+/*
+ * Printer Class spec: http://www.usb.org/developers/data/usbprn10.pdf
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/proc.h>
+#include <sys/kernel.h>
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+#include <sys/device.h>
+#include <sys/ioctl.h>
+#elif defined(__FreeBSD__)
+#include <sys/ioccom.h>
+#include <sys/module.h>
+#include <sys/bus.h>
+#endif
+#include <sys/uio.h>
+#include <sys/conf.h>
+#include <sys/vnode.h>
+#include <sys/syslog.h>
+
+#include <dev/usb/usb.h>
+#include <dev/usb/usbdi.h>
+#include <dev/usb/usbdi_util.h>
+#include <dev/usb/usbdevs.h>
+#include <dev/usb/usb_quirks.h>
+
+#define	TIMEOUT		hz*16	/* wait up to 16 seconds for a ready */
+#define	STEP		hz/4
+
+#define	LPTPRI		(PZERO+8)
+#define	ULPT_BSIZE	16384
+
+#ifdef ULPT_DEBUG
+#define DPRINTF(x)	if (ulptdebug) logprintf x
+#define DPRINTFN(n,x)	if (ulptdebug>(n)) logprintf x
+int	ulptdebug = 0;
+#else
+#define DPRINTF(x)
+#define DPRINTFN(n,x)
+#endif
+
+#define UR_GET_DEVICE_ID 0
+#define UR_GET_PORT_STATUS 1
+#define UR_SOFT_RESET 2
+
+#define	LPS_NERR		0x08	/* printer no error */
+#define	LPS_SELECT		0x10	/* printer selected */
+#define	LPS_NOPAPER		0x20	/* printer out of paper */
+#define LPS_INVERT      (LPS_SELECT|LPS_NERR)
+#define LPS_MASK        (LPS_SELECT|LPS_NERR|LPS_NOPAPER)
+
+struct ulpt_softc {
+	USBBASEDEVICE sc_dev;
+	usbd_device_handle sc_udev;	/* device */
+	usbd_interface_handle sc_iface;	/* interface */
+	int sc_ifaceno;
+	usbd_pipe_handle sc_bulkpipe;	/* bulk pipe */
+	int sc_bulk;
+
+	u_char sc_state;
+#define	ULPT_OPEN	0x01	/* device is open */
+#define	ULPT_OBUSY	0x02	/* printer is busy doing output */
+#define	ULPT_INIT	0x04	/* waiting to initialize for open */
+	u_char sc_flags;
+#define	ULPT_NOPRIME	0x40	/* don't prime on open */
+	u_char sc_laststatus;
+
+	int sc_refcnt;
+	u_char sc_dying;
+
+#if defined(__FreeBSD__)
+	dev_t dev;
+	dev_t dev_noprime;
+#endif
+};
+
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+cdev_decl(ulpt);
+#elif defined(__FreeBSD__)
+static d_open_t ulptopen;
+static d_close_t ulptclose;
+static d_write_t ulptwrite;
+static d_ioctl_t ulptioctl;
+
+#define ULPT_CDEV_MAJOR 113
+
+static struct cdevsw ulpt_cdevsw = {
+	/* open */	ulptopen,
+	/* close */	ulptclose,
+	/* read */	noread,
+	/* write */	ulptwrite,
+	/* ioctl */	ulptioctl,
+	/* poll */	nopoll,
+	/* mmap */	nommap,
+	/* strategy */	nostrategy,
+	/* name */	"ulpt",
+	/* maj */	ULPT_CDEV_MAJOR,
+	/* dump */	nodump,
+	/* psize */	nopsize,
+	/* flags */	0,
+	/* bmaj */	-1
+};
+#endif
+
+void ulpt_disco __P((void *));
+
+int ulpt_do_write __P((struct ulpt_softc *, struct uio *uio, int));
+int ulpt_status __P((struct ulpt_softc *));
+void ulpt_reset __P((struct ulpt_softc *));
+int ulpt_statusmsg __P((u_char, struct ulpt_softc *));
+
+void ieee1284_print_id __P((char *));
+
+#define	ULPTUNIT(s)	(minor(s) & 0x1f)
+#define	ULPTFLAGS(s)	(minor(s) & 0xe0)
+
+
+USB_DECLARE_DRIVER(ulpt);
+
+USB_MATCH(ulpt)
+{
+	USB_MATCH_START(ulpt, uaa);
+	usb_interface_descriptor_t *id;
+	
+	DPRINTFN(10,("ulpt_match\n"));
+	if (uaa->iface == NULL)
+		return (UMATCH_NONE);
+	id = usbd_get_interface_descriptor(uaa->iface);
+	if (id != NULL &&
+	    id->bInterfaceClass == UICLASS_PRINTER &&
+	    id->bInterfaceSubClass == UISUBCLASS_PRINTER &&
+	    (id->bInterfaceProtocol == UIPROTO_PRINTER_UNI ||
+	     id->bInterfaceProtocol == UIPROTO_PRINTER_BI))
+		return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
+	return (UMATCH_NONE);
+}
+
+USB_ATTACH(ulpt)
+{
+	USB_ATTACH_START(ulpt, sc, uaa);
+	usbd_device_handle dev = uaa->device;
+	usbd_interface_handle iface = uaa->iface;
+	usb_interface_descriptor_t *id = usbd_get_interface_descriptor(iface);
+	char devinfo[1024];
+	usb_endpoint_descriptor_t *ed;
+	usbd_status err;
+	
+	DPRINTFN(10,("ulpt_attach: sc=%p\n", sc));
+	usbd_devinfo(dev, 0, devinfo);
+	USB_ATTACH_SETUP;
+	printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
+	       devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
+
+	/* Figure out which endpoint is the bulk out endpoint. */
+	ed = usbd_interface2endpoint_descriptor(iface, 0);
+	if (ed == NULL)
+		goto nobulk;
+	if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_OUT ||
+	    (ed->bmAttributes & UE_XFERTYPE) != UE_BULK) {
+		/* In case we are using a bidir protocol... */
+		ed = usbd_interface2endpoint_descriptor(iface, 1);
+		if (ed == NULL)
+			goto nobulk;
+		if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_OUT ||
+		    (ed->bmAttributes & UE_XFERTYPE) != UE_BULK)
+			goto nobulk;
+	}
+	sc->sc_bulk = ed->bEndpointAddress;
+	DPRINTFN(10, ("ulpt_attach: bulk=%d\n", sc->sc_bulk));
+
+	sc->sc_iface = iface;
+	err = usbd_interface2device_handle(iface, &sc->sc_udev);
+	if (err) {
+		sc->sc_dying = 1;
+		USB_ATTACH_ERROR_RETURN;
+	}
+	sc->sc_ifaceno = id->bInterfaceNumber;
+
+#if 0
+/*
+ * This code is disabled because for some mysterious it causes
+ * printing not to work.  But only sometimes, and mostly with
+ * UHCI and less often with OHCI.  *sigh*
+ */
+	{
+	usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev);
+	usb_device_request_t req;
+	int len, alen;
+
+	req.bmRequestType = UT_READ_CLASS_INTERFACE;
+	req.bRequest = UR_GET_DEVICE_ID;
+	USETW(req.wValue, cd->bConfigurationValue);
+	USETW2(req.wIndex, id->bInterfaceNumber, id->bAlternateSetting);
+	USETW(req.wLength, sizeof devinfo - 1);
+	err = usbd_do_request_flags(dev, &req, devinfo,USBD_SHORT_XFER_OK,
+		  &alen);
+	if (err) {
+		printf("%s: cannot get device id\n", USBDEVNAME(sc->sc_dev));
+	} else if (alen <= 2) {
+		printf("%s: empty device id, no printer connected?\n",
+		       USBDEVNAME(sc->sc_dev));
+	} else {
+		/* devinfo now contains an IEEE-1284 device ID */
+		len = ((devinfo[0] & 0xff) << 8) | (devinfo[1] & 0xff);
+		if (len > sizeof devinfo - 3)
+			len = sizeof devinfo - 3;
+		devinfo[len] = 0;
+		printf("%s: device id <", USBDEVNAME(sc->sc_dev));
+		ieee1284_print_id(devinfo+2);
+		printf(">\n");
+	}
+	}
+#endif
+
+#if defined(__FreeBSD__)
+	sc->dev = make_dev(&ulpt_cdevsw, device_get_unit(self),
+		UID_ROOT, GID_OPERATOR, 0644, "ulpt%d", device_get_unit(self));
+	sc->dev_noprime = make_dev(&ulpt_cdevsw,
+		device_get_unit(self)|ULPT_NOPRIME,
+		UID_ROOT, GID_OPERATOR, 0644, "unlpt%d", device_get_unit(self));
+#endif
+
+	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
+			   USBDEV(sc->sc_dev));
+
+	USB_ATTACH_SUCCESS_RETURN;
+
+ nobulk:
+	printf("%s: could not find bulk endpoint\n", USBDEVNAME(sc->sc_dev));
+	sc->sc_dying = 1;
+	USB_ATTACH_ERROR_RETURN;
+}
+
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+int
+ulpt_activate(self, act)
+	device_ptr_t self;
+	enum devact act;
+{
+	struct ulpt_softc *sc = (struct ulpt_softc *)self;
+
+	switch (act) {
+	case DVACT_ACTIVATE:
+		return (EOPNOTSUPP);
+		break;
+
+	case DVACT_DEACTIVATE:
+		sc->sc_dying = 1;
+		break;
+	}
+	return (0);
+}
+#endif
+
+USB_DETACH(ulpt)
+{
+	USB_DETACH_START(ulpt, sc);
+	int s;
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+	int maj, mn;
+
+	DPRINTF(("ulpt_detach: sc=%p flags=%d\n", sc, flags));
+#elif defined(__FreeBSD__)
+	DPRINTF(("ulpt_detach: sc=%p\n", sc));
+#endif
+
+	sc->sc_dying = 1;
+	if (sc->sc_bulkpipe != NULL)
+		usbd_abort_pipe(sc->sc_bulkpipe);
+
+	s = splusb();
+	if (--sc->sc_refcnt >= 0) {
+		/* There is noone to wake, aborting the pipe is enough */
+		/* Wait for processes to go away. */
+		usb_detach_wait(USBDEV(sc->sc_dev));
+	}
+	splx(s);
+
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+	/* locate the major number */
+	for (maj = 0; maj < nchrdev; maj++)
+		if (cdevsw[maj].d_open == ulptopen)
+			break;
+
+	/* Nuke the vnodes for any open instances (calls close). */
+	mn = self->dv_unit;
+	vdevgone(maj, mn, mn, VCHR);
+#elif defined(__FreeBSD__)
+	/* XXX not implemented yet */
+
+	destroy_dev(sc->dev);
+	destroy_dev(sc->dev_noprime);
+#endif
+
+	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
+			   USBDEV(sc->sc_dev));
+
+	return (0);
+}
+
+int
+ulpt_status(sc)
+	struct ulpt_softc *sc;
+{
+	usb_device_request_t req;
+	usbd_status err;
+	u_char status;
+
+	req.bmRequestType = UT_READ_CLASS_INTERFACE;
+	req.bRequest = UR_GET_PORT_STATUS;
+	USETW(req.wValue, 0);
+	USETW(req.wIndex, sc->sc_ifaceno);
+	USETW(req.wLength, 1);
+	err = usbd_do_request(sc->sc_udev, &req, &status);
+	DPRINTFN(1, ("ulpt_status: status=0x%02x err=%d\n", status, err));
+	if (!err)
+		return (status);
+	else
+		return (0);
+}
+
+void
+ulpt_reset(sc)
+	struct ulpt_softc *sc;
+{
+	usb_device_request_t req;
+
+	DPRINTFN(1, ("ulpt_reset\n"));
+	req.bmRequestType = UT_WRITE_CLASS_OTHER;
+	req.bRequest = UR_SOFT_RESET;
+	USETW(req.wValue, 0);
+	USETW(req.wIndex, sc->sc_ifaceno);
+	USETW(req.wLength, 0);
+	(void)usbd_do_request(sc->sc_udev, &req, 0);
+}
+
+/*
+ * Reset the printer, then wait until it's selected and not busy.
+ */
+int
+ulptopen(dev, flag, mode, p)
+	dev_t dev;
+	int flag;
+	int mode;
+	struct proc *p;
+{
+	u_char flags = ULPTFLAGS(dev);
+	struct ulpt_softc *sc;
+	usbd_status err;
+	int spin, error;
+
+	USB_GET_SC_OPEN(ulpt, ULPTUNIT(dev), sc);
+
+	if (sc == NULL || sc->sc_iface == NULL || sc->sc_dying)
+		return (ENXIO);
+
+	if (sc->sc_state)
+		return (EBUSY);
+
+	sc->sc_state = ULPT_INIT;
+	sc->sc_flags = flags;
+	DPRINTF(("ulptopen: flags=0x%x\n", (unsigned)flags));
+
+#if defined(ULPT_DEBUG) && defined(__FreeBSD__)
+	/* Ignoring these flags might not be a good idea */
+	if ((flags & ~ULPT_NOPRIME) != 0)
+		printf("ulptopen: flags ignored: %b\n", flags,
+			"\20\3POS_INIT\4POS_ACK\6PRIME_OPEN\7AUTOLF\10BYPASS");
+#endif
+
+
+	if ((flags & ULPT_NOPRIME) == 0)
+		ulpt_reset(sc);
+
+	for (spin = 0; (ulpt_status(sc) & LPS_SELECT) == 0; spin += STEP) {
+		if (spin >= TIMEOUT) {
+			sc->sc_state = 0;
+			return (EBUSY);
+		}
+
+		/* wait 1/4 second, give up if we get a signal */
+		error = tsleep((caddr_t)sc, LPTPRI | PCATCH, "ulptop", STEP);
+		if (error != EWOULDBLOCK) {
+			sc->sc_state = 0;
+			return (error);
+		}
+	}
+
+	err = usbd_open_pipe(sc->sc_iface, sc->sc_bulk, 0, &sc->sc_bulkpipe);
+	if (err) {
+		sc->sc_state = 0;
+		return (EIO);
+	}
+
+	sc->sc_state = ULPT_OPEN;
+
+	DPRINTF(("ulptopen: done\n"));
+	return (0);
+}
+
+int
+ulpt_statusmsg(status, sc)
+	u_char status;
+	struct ulpt_softc *sc;
+{
+	u_char new;
+
+	status = (status ^ LPS_INVERT) & LPS_MASK;
+	new = status & ~sc->sc_laststatus;
+	sc->sc_laststatus = status;
+
+	if (new & LPS_SELECT)
+		log(LOG_NOTICE, "%s: offline\n", USBDEVNAME(sc->sc_dev));
+	else if (new & LPS_NOPAPER)
+		log(LOG_NOTICE, "%s: out of paper\n", USBDEVNAME(sc->sc_dev));
+	else if (new & LPS_NERR)
+		log(LOG_NOTICE, "%s: output error\n", USBDEVNAME(sc->sc_dev));
+
+	return (status);
+}
+
+int
+ulptclose(dev, flag, mode, p)
+	dev_t dev;
+	int flag;
+	int mode;
+	struct proc *p;
+{
+	struct ulpt_softc *sc;
+
+	USB_GET_SC(ulpt, ULPTUNIT(dev), sc);
+
+	if (sc->sc_state != ULPT_OPEN)
+		/* We are being forced to close before the open completed. */
+		return (0);
+
+	usbd_close_pipe(sc->sc_bulkpipe);
+	sc->sc_bulkpipe = 0;
+
+	sc->sc_state = 0;
+
+	DPRINTF(("ulptclose: closed\n"));
+	return (0);
+}
+
+int
+ulpt_do_write(sc, uio, flags)
+	struct ulpt_softc *sc;
+	struct uio *uio;
+	int flags;
+{
+	u_int32_t n;
+	int error = 0;
+	void *bufp;
+	usbd_xfer_handle xfer;
+	usbd_status err;
+
+	DPRINTF(("ulptwrite\n"));
+	xfer = usbd_alloc_xfer(sc->sc_udev);
+	if (xfer == NULL)
+		return (ENOMEM);
+	bufp = usbd_alloc_buffer(xfer, ULPT_BSIZE);
+	if (bufp == NULL) {
+		usbd_free_xfer(xfer);
+		return (ENOMEM);
+	}
+	while ((n = min(ULPT_BSIZE, uio->uio_resid)) != 0) {
+		ulpt_statusmsg(ulpt_status(sc), sc);
+		error = uiomove(bufp, n, uio);
+		if (error)
+			break;
+		DPRINTFN(1, ("ulptwrite: transfer %d bytes\n", n));
+		err = usbd_bulk_transfer(xfer, sc->sc_bulkpipe, USBD_NO_COPY, 
+			  USBD_NO_TIMEOUT, bufp, &n, "ulptwr");
+		if (err) {
+			DPRINTF(("ulptwrite: error=%d\n", err));
+			error = EIO;
+			break;
+		}
+	}
+	usbd_free_xfer(xfer);
+
+	return (error);
+}
+
+int
+ulptwrite(dev, uio, flags)
+	dev_t dev;
+	struct uio *uio;
+	int flags;
+{
+	struct ulpt_softc *sc;
+	int error;
+
+	USB_GET_SC(ulpt, ULPTUNIT(dev), sc);
+
+	if (sc->sc_dying)
+		return (EIO);
+
+	sc->sc_refcnt++;
+	error = ulpt_do_write(sc, uio, flags);
+	if (--sc->sc_refcnt < 0)
+		usb_detach_wakeup(USBDEV(sc->sc_dev));
+	return (error);
+}
+
+int
+ulptioctl(dev, cmd, data, flag, p)
+	dev_t dev;
+	u_long cmd;
+	caddr_t data;
+	int flag;
+	struct proc *p;
+{
+	int error = 0;
+
+	switch (cmd) {
+	default:
+		error = ENODEV;
+	}
+
+	return (error);
+}
+
+#if 0
+/* XXX This does not belong here. */
+/*
+ * Print select parts of a IEEE 1284 device ID.
+ */
+void
+ieee1284_print_id(str)
+	char *str;
+{
+	char *p, *q;
+
+	for (p = str-1; p; p = strchr(p, ';')) {
+		p++;		/* skip ';' */
+		if (strncmp(p, "MFG:", 4) == 0 ||
+		    strncmp(p, "MANUFACTURER:", 14) == 0 ||
+		    strncmp(p, "MDL:", 4) == 0 ||
+		    strncmp(p, "MODEL:", 6) == 0) {
+			q = strchr(p, ';');
+			if (q)
+				printf("%.*s", (int)(q - p + 1), p);
+		}
+	}
+}
+#endif
+
+#if defined(__FreeBSD__)
+DRIVER_MODULE(ulpt, uhub, ulpt_driver, ulpt_devclass, usbd_driver_load, 0);
+#endif