2 * $NetBSD: ulpt.c,v 1.55 2002/10/23 09:14:01 jdolecek Exp $
3 * $FreeBSD: src/sys/dev/usb/ulpt.c,v 1.59 2003/09/28 20:48:13 phk Exp $
4 * $DragonFly: src/sys/dev/usbmisc/ulpt/ulpt.c,v 1.22 2007/07/02 23:52:05 hasso Exp $
8 * Copyright (c) 1998 The NetBSD Foundation, Inc.
11 * This code is derived from software contributed to The NetBSD Foundation
12 * by Lennart Augustsson (lennart@augustsson.net) at
13 * Carlstedt Research & Technology.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. All advertising materials mentioning features or use of this software
24 * must display the following acknowledgement:
25 * This product includes software developed by the NetBSD
26 * Foundation, Inc. and its contributors.
27 * 4. Neither the name of The NetBSD Foundation nor the names of its
28 * contributors may be used to endorse or promote products derived
29 * from this software without specific prior written permission.
31 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
32 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
33 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
34 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
35 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGE.
45 * Printer Class spec: http://www.usb.org/developers/data/devclass/usbprint109.PDF
48 #include <sys/param.h>
49 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/ioccom.h>
53 #include <sys/module.h>
57 #include <sys/device.h>
58 #include <sys/syslog.h>
59 #include <sys/sysctl.h>
60 #include <sys/thread2.h>
62 #include <bus/usb/usb.h>
63 #include <bus/usb/usbdi.h>
64 #include <bus/usb/usbdi_util.h>
65 #include <bus/usb/usbdevs.h>
66 #include <bus/usb/usb_quirks.h>
68 #define TIMEOUT hz*16 /* wait up to 16 seconds for a ready */
71 #define ULPT_BSIZE 16384
74 #define DPRINTF(x) if (ulptdebug) kprintf x
75 #define DPRINTFN(n,x) if (ulptdebug>(n)) kprintf x
77 SYSCTL_NODE(_hw_usb, OID_AUTO, ulpt, CTLFLAG_RW, 0, "USB ulpt");
78 SYSCTL_INT(_hw_usb_ulpt, OID_AUTO, debug, CTLFLAG_RW,
79 &ulptdebug, 0, "ulpt debug level");
85 #define UR_GET_DEVICE_ID 0
86 #define UR_GET_PORT_STATUS 1
87 #define UR_SOFT_RESET 2
89 #define LPS_NERR 0x08 /* printer no error */
90 #define LPS_SELECT 0x10 /* printer selected */
91 #define LPS_NOPAPER 0x20 /* printer out of paper */
92 #define LPS_INVERT (LPS_SELECT|LPS_NERR)
93 #define LPS_MASK (LPS_SELECT|LPS_NERR|LPS_NOPAPER)
97 usbd_device_handle sc_udev; /* device */
98 usbd_interface_handle sc_iface; /* interface */
102 usbd_pipe_handle sc_out_pipe; /* bulk out pipe */
105 usbd_pipe_handle sc_in_pipe; /* bulk in pipe */
106 usbd_xfer_handle sc_in_xfer1;
107 usbd_xfer_handle sc_in_xfer2;
108 u_char sc_junk[64]; /* somewhere to dump input */
111 #define ULPT_OPEN 0x01 /* device is open */
112 #define ULPT_OBUSY 0x02 /* printer is busy doing output */
113 #define ULPT_INIT 0x04 /* waiting to initialize for open */
115 #define ULPT_NOPRIME 0x40 /* don't prime on open */
116 u_char sc_laststatus;
122 static d_open_t ulptopen;
123 static d_close_t ulptclose;
124 static d_write_t ulptwrite;
125 static d_ioctl_t ulptioctl;
127 #define ULPT_CDEV_MAJOR 113
129 static struct dev_ops ulpt_ops = {
130 { "ulpt", ULPT_CDEV_MAJOR, 0 },
132 .d_close = ulptclose,
133 .d_write = ulptwrite,
134 .d_ioctl = ulptioctl,
137 void ulpt_disco(void *);
139 int ulpt_do_write(struct ulpt_softc *, struct uio *uio, int);
140 int ulpt_status(struct ulpt_softc *);
141 void ulpt_reset(struct ulpt_softc *);
142 int ulpt_statusmsg(u_char, struct ulpt_softc *);
145 void ieee1284_print_id(char *);
148 #define ULPTUNIT(s) (minor(s) & 0x1f)
149 #define ULPTFLAGS(s) (minor(s) & 0xe0)
152 static device_probe_t ulpt_match;
153 static device_attach_t ulpt_attach;
154 static device_detach_t ulpt_detach;
156 static devclass_t ulpt_devclass;
158 static kobj_method_t ulpt_methods[] = {
159 DEVMETHOD(device_probe, ulpt_match),
160 DEVMETHOD(device_attach, ulpt_attach),
161 DEVMETHOD(device_detach, ulpt_detach),
165 static driver_t ulpt_driver = {
168 sizeof(struct ulpt_softc)
171 MODULE_DEPEND(ulpt, usb, 1, 1, 1);
174 ulpt_match(device_t self)
176 struct usb_attach_arg *uaa = device_get_ivars(self);
177 usb_interface_descriptor_t *id;
179 DPRINTFN(10,("ulpt_match\n"));
180 if (uaa->iface == NULL)
181 return (UMATCH_NONE);
182 id = usbd_get_interface_descriptor(uaa->iface);
184 id->bInterfaceClass == UICLASS_PRINTER &&
185 id->bInterfaceSubClass == UISUBCLASS_PRINTER &&
186 (id->bInterfaceProtocol == UIPROTO_PRINTER_UNI ||
187 id->bInterfaceProtocol == UIPROTO_PRINTER_BI ||
188 id->bInterfaceProtocol == UIPROTO_PRINTER_1284))
189 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
190 return (UMATCH_NONE);
194 ulpt_attach(device_t self)
196 struct ulpt_softc *sc = device_get_softc(self);
197 struct usb_attach_arg *uaa = device_get_ivars(self);
198 usbd_device_handle dev = uaa->device;
199 usbd_interface_handle iface = uaa->iface;
200 usb_interface_descriptor_t *ifcd = usbd_get_interface_descriptor(iface);
201 usb_interface_descriptor_t *id, *iend;
202 usb_config_descriptor_t *cdesc;
205 usb_endpoint_descriptor_t *ed;
209 DPRINTFN(10,("ulpt_attach: sc=%p\n", sc));
210 usbd_devinfo(dev, 0, devinfo);
212 device_set_desc_copy(self, devinfo);
213 kprintf("%s: %s, iclass %d/%d\n", device_get_nameunit(sc->sc_dev),
214 devinfo, ifcd->bInterfaceClass, ifcd->bInterfaceSubClass);
217 * Stepping through the alternate settings needs to be abstracted out.
219 cdesc = usbd_get_config_descriptor(dev);
221 kprintf("%s: failed to get configuration descriptor\n",
222 device_get_nameunit(sc->sc_dev));
225 iend = (usb_interface_descriptor_t *)
226 ((char *)cdesc + UGETW(cdesc->wTotalLength));
228 if (ifcd < (usb_interface_descriptor_t *)cdesc ||
230 panic("ulpt: iface desc out of range");
232 /* Step through all the descriptors looking for bidir mode */
233 for (id = ifcd, altno = 0;
235 id = (void *)((char *)id + id->bLength)) {
236 if (id->bDescriptorType == UDESC_INTERFACE &&
237 id->bInterfaceNumber == ifcd->bInterfaceNumber) {
238 if (id->bInterfaceClass == UICLASS_PRINTER &&
239 id->bInterfaceSubClass == UISUBCLASS_PRINTER &&
240 (id->bInterfaceProtocol == UIPROTO_PRINTER_BI /* ||
241 id->bInterfaceProtocol == UIPROTO_PRINTER_1284 */))
246 id = ifcd; /* not found, use original */
249 /* Found a new bidir setting */
250 DPRINTF(("ulpt_attach: set altno = %d\n", altno));
251 err = usbd_set_interface(iface, altno);
253 kprintf("%s: setting alternate interface failed\n",
254 device_get_nameunit(sc->sc_dev));
261 (void)usbd_endpoint_count(iface, &epcount);
265 for (i = 0; i < epcount; i++) {
266 ed = usbd_interface2endpoint_descriptor(iface, i);
268 kprintf("%s: couldn't get ep %d\n",
269 device_get_nameunit(sc->sc_dev), i);
272 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
273 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
274 sc->sc_in = ed->bEndpointAddress;
275 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
276 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
277 sc->sc_out = ed->bEndpointAddress;
280 if (sc->sc_out == -1) {
281 kprintf("%s: could not find bulk out endpoint\n",
282 device_get_nameunit(sc->sc_dev));
287 if (usbd_get_quirks(dev)->uq_flags & UQ_BROKEN_BIDIR) {
288 /* This device doesn't handle reading properly. */
292 kprintf("%s: using %s-directional mode\n", device_get_nameunit(sc->sc_dev),
293 sc->sc_in >= 0 ? "bi" : "uni");
295 DPRINTFN(10, ("ulpt_attach: bulk=%d\n", sc->sc_out));
297 sc->sc_iface = iface;
298 sc->sc_ifaceno = id->bInterfaceNumber;
303 * This code is disabled because for some mysterious reason it causes
304 * printing not to work. But only sometimes, and mostly with
305 * UHCI and less often with OHCI. *sigh*
308 usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev);
309 usb_device_request_t req;
312 req.bmRequestType = UT_READ_CLASS_INTERFACE;
313 req.bRequest = UR_GET_DEVICE_ID;
314 USETW(req.wValue, cd->bConfigurationValue);
315 USETW2(req.wIndex, id->bInterfaceNumber, id->bAlternateSetting);
316 USETW(req.wLength, sizeof devinfo - 1);
317 err = usbd_do_request_flags(dev, &req, devinfo, USBD_SHORT_XFER_OK,
318 &alen, USBD_DEFAULT_TIMEOUT);
320 kprintf("%s: cannot get device id\n", device_get_nameunit(sc->sc_dev));
321 } else if (alen <= 2) {
322 kprintf("%s: empty device id, no printer connected?\n",
323 device_get_nameunit(sc->sc_dev));
325 /* devinfo now contains an IEEE-1284 device ID */
326 len = ((devinfo[0] & 0xff) << 8) | (devinfo[1] & 0xff);
327 if (len > sizeof devinfo - 3)
328 len = sizeof devinfo - 3;
330 kprintf("%s: device id <", device_get_nameunit(sc->sc_dev));
331 ieee1284_print_id(devinfo+2);
337 dev_ops_add(&ulpt_ops, -1, device_get_unit(self));
338 make_dev(&ulpt_ops, device_get_unit(self),
339 UID_ROOT, GID_OPERATOR, 0644, "ulpt%d", device_get_unit(self));
341 device_get_unit(self)|ULPT_NOPRIME,
342 UID_ROOT, GID_OPERATOR, 0644, "unlpt%d", device_get_unit(self));
344 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
351 ulpt_detach(device_t self)
353 struct ulpt_softc *sc = device_get_softc(self);
355 DPRINTF(("ulpt_detach: sc=%p\n", sc));
358 if (sc->sc_out_pipe != NULL)
359 usbd_abort_pipe(sc->sc_out_pipe);
360 if (sc->sc_in_pipe != NULL)
361 usbd_abort_pipe(sc->sc_in_pipe);
364 * Wait for any ongoing operations to complete before we actually
370 if (sc->sc_refcnt >= 0) {
371 kprintf("%s: waiting for idle\n", device_get_nameunit(sc->sc_dev));
372 while (sc->sc_refcnt >= 0)
373 usb_detach_wait(sc->sc_dev);
374 kprintf("%s: idle wait done\n", device_get_nameunit(sc->sc_dev));
378 dev_ops_remove(&ulpt_ops, -1, device_get_unit(self));
380 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
387 ulpt_status(struct ulpt_softc *sc)
389 usb_device_request_t req;
393 req.bmRequestType = UT_READ_CLASS_INTERFACE;
394 req.bRequest = UR_GET_PORT_STATUS;
395 USETW(req.wValue, 0);
396 USETW(req.wIndex, sc->sc_ifaceno);
397 USETW(req.wLength, 1);
398 err = usbd_do_request(sc->sc_udev, &req, &status);
399 DPRINTFN(1, ("ulpt_status: status=0x%02x err=%d\n", status, err));
407 ulpt_reset(struct ulpt_softc *sc)
409 usb_device_request_t req;
411 DPRINTFN(1, ("ulpt_reset\n"));
412 req.bRequest = UR_SOFT_RESET;
413 USETW(req.wValue, 0);
414 USETW(req.wIndex, sc->sc_ifaceno);
415 USETW(req.wLength, 0);
418 * There was a mistake in the USB printer 1.0 spec that gave the
419 * request type as UT_WRITE_CLASS_OTHER; it should have been
420 * UT_WRITE_CLASS_INTERFACE. Many printers use the old one,
423 req.bmRequestType = UT_WRITE_CLASS_OTHER;
424 if (usbd_do_request(sc->sc_udev, &req, 0)) { /* 1.0 */
425 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
426 (void)usbd_do_request(sc->sc_udev, &req, 0); /* 1.1 */
431 ulpt_input(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
433 struct ulpt_softc *sc = priv;
436 /* Don't loop on errors or 0-length input. */
437 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
438 if (status != USBD_NORMAL_COMPLETION || count == 0)
441 DPRINTFN(2,("ulpt_input: got some data\n"));
443 if (xfer == sc->sc_in_xfer1)
444 usbd_transfer(sc->sc_in_xfer2);
446 usbd_transfer(sc->sc_in_xfer1);
452 * Reset the printer, then wait until it's selected and not busy.
455 ulptopen(struct dev_open_args *ap)
457 cdev_t dev = ap->a_head.a_dev;
458 u_char flags = ULPTFLAGS(dev);
459 struct ulpt_softc *sc;
463 sc = devclass_get_softc(ulpt_devclass, ULPTUNIT(dev));
467 if (sc == NULL || sc->sc_iface == NULL || sc->sc_dying)
473 sc->sc_state = ULPT_INIT;
474 sc->sc_flags = flags;
475 DPRINTF(("ulptopen: flags=0x%x\n", (unsigned)flags));
477 #if defined(USB_DEBUG)
478 /* Ignoring these flags might not be a good idea */
479 if ((flags & ~ULPT_NOPRIME) != 0)
480 kprintf("ulptopen: flags ignored: %b\n", flags,
481 "\20\3POS_INIT\4POS_ACK\6PRIME_OPEN\7AUTOLF\10BYPASS");
487 if ((flags & ULPT_NOPRIME) == 0) {
496 for (spin = 0; (ulpt_status(sc) & LPS_SELECT) == 0; spin += STEP) {
497 DPRINTF(("ulpt_open: waiting a while\n"));
498 if (spin >= TIMEOUT) {
504 /* wait 1/4 second, give up if we get a signal */
505 error = tsleep((caddr_t)sc, PCATCH, "ulptop", STEP);
506 if (error != EWOULDBLOCK) {
518 err = usbd_open_pipe(sc->sc_iface, sc->sc_out, 0, &sc->sc_out_pipe);
525 if (ulptusein && sc->sc_in != -1) {
526 DPRINTF(("ulpt_open: open input pipe\n"));
527 err = usbd_open_pipe(sc->sc_iface, sc->sc_in,0,&sc->sc_in_pipe);
530 usbd_close_pipe(sc->sc_out_pipe);
531 sc->sc_out_pipe = NULL;
535 sc->sc_in_xfer1 = usbd_alloc_xfer(sc->sc_udev);
536 sc->sc_in_xfer2 = usbd_alloc_xfer(sc->sc_udev);
537 if (sc->sc_in_xfer1 == NULL || sc->sc_in_xfer2 == NULL) {
539 if (sc->sc_in_xfer1 != NULL) {
540 usbd_free_xfer(sc->sc_in_xfer1);
541 sc->sc_in_xfer1 = NULL;
543 if (sc->sc_in_xfer2 != NULL) {
544 usbd_free_xfer(sc->sc_in_xfer2);
545 sc->sc_in_xfer2 = NULL;
547 usbd_close_pipe(sc->sc_out_pipe);
548 sc->sc_out_pipe = NULL;
549 usbd_close_pipe(sc->sc_in_pipe);
550 sc->sc_in_pipe = NULL;
554 usbd_setup_xfer(sc->sc_in_xfer1, sc->sc_in_pipe, sc,
555 sc->sc_junk, sizeof sc->sc_junk, USBD_SHORT_XFER_OK,
556 USBD_NO_TIMEOUT, ulpt_input);
557 usbd_setup_xfer(sc->sc_in_xfer2, sc->sc_in_pipe, sc,
558 sc->sc_junk, sizeof sc->sc_junk, USBD_SHORT_XFER_OK,
559 USBD_NO_TIMEOUT, ulpt_input);
560 usbd_transfer(sc->sc_in_xfer1); /* ignore failed start */
563 sc->sc_state = ULPT_OPEN;
566 if (--sc->sc_refcnt < 0)
567 usb_detach_wakeup(sc->sc_dev);
569 DPRINTF(("ulptopen: done, error=%d\n", error));
574 ulpt_statusmsg(u_char status, struct ulpt_softc *sc)
578 status = (status ^ LPS_INVERT) & LPS_MASK;
579 new = status & ~sc->sc_laststatus;
580 sc->sc_laststatus = status;
582 if (new & LPS_SELECT)
583 log(LOG_NOTICE, "%s: offline\n", device_get_nameunit(sc->sc_dev));
584 else if (new & LPS_NOPAPER)
585 log(LOG_NOTICE, "%s: out of paper\n", device_get_nameunit(sc->sc_dev));
586 else if (new & LPS_NERR)
587 log(LOG_NOTICE, "%s: output error\n", device_get_nameunit(sc->sc_dev));
593 ulptclose(struct dev_close_args *ap)
595 cdev_t dev = ap->a_head.a_dev;
596 struct ulpt_softc *sc;
598 sc = devclass_get_softc(ulpt_devclass, ULPTUNIT(dev));
600 if (sc->sc_state != ULPT_OPEN)
601 /* We are being forced to close before the open completed. */
604 if (sc->sc_out_pipe != NULL) {
605 usbd_close_pipe(sc->sc_out_pipe);
606 sc->sc_out_pipe = NULL;
608 if (sc->sc_in_pipe != NULL) {
609 usbd_abort_pipe(sc->sc_in_pipe);
610 usbd_close_pipe(sc->sc_in_pipe);
611 sc->sc_in_pipe = NULL;
612 if (sc->sc_in_xfer1 != NULL) {
613 usbd_free_xfer(sc->sc_in_xfer1);
614 sc->sc_in_xfer1 = NULL;
616 if (sc->sc_in_xfer2 != NULL) {
617 usbd_free_xfer(sc->sc_in_xfer2);
618 sc->sc_in_xfer2 = NULL;
624 DPRINTF(("ulptclose: closed\n"));
629 ulpt_do_write(struct ulpt_softc *sc, struct uio *uio, int flags)
634 usbd_xfer_handle xfer;
637 DPRINTF(("ulptwrite\n"));
638 xfer = usbd_alloc_xfer(sc->sc_udev);
641 bufp = usbd_alloc_buffer(xfer, ULPT_BSIZE);
643 usbd_free_xfer(xfer);
646 while ((n = min(ULPT_BSIZE, uio->uio_resid)) != 0) {
647 ulpt_statusmsg(ulpt_status(sc), sc);
648 error = uiomove(bufp, n, uio);
651 DPRINTFN(1, ("ulptwrite: transfer %d bytes\n", n));
652 err = usbd_bulk_transfer(xfer, sc->sc_out_pipe, USBD_NO_COPY,
653 USBD_NO_TIMEOUT, bufp, &n, "ulptwr");
655 DPRINTF(("ulptwrite: error=%d\n", err));
660 usbd_free_xfer(xfer);
666 ulptwrite(struct dev_write_args *ap)
668 cdev_t dev = ap->a_head.a_dev;
669 struct ulpt_softc *sc;
672 sc = devclass_get_softc(ulpt_devclass, ULPTUNIT(dev));
678 error = ulpt_do_write(sc, ap->a_uio, ap->a_ioflag);
679 if (--sc->sc_refcnt < 0)
680 usb_detach_wakeup(sc->sc_dev);
685 ulptioctl(struct dev_ioctl_args *ap)
698 /* XXX This does not belong here. */
700 * Print select parts of an IEEE 1284 device ID.
703 ieee1284_print_id(char *str)
707 for (p = str-1; p; p = strchr(p, ';')) {
709 if (strncmp(p, "MFG:", 4) == 0 ||
710 strncmp(p, "MANUFACTURER:", 14) == 0 ||
711 strncmp(p, "MDL:", 4) == 0 ||
712 strncmp(p, "MODEL:", 6) == 0) {
715 kprintf("%.*s", (int)(q - p + 1), p);
721 DRIVER_MODULE(ulpt, uhub, ulpt_driver, ulpt_devclass, usbd_driver_load, 0);