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.25 2008/02/11 16:56:53 dillon 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/module.h>
56 #include <sys/device.h>
57 #include <sys/syslog.h>
58 #include <sys/sysctl.h>
59 #include <sys/thread2.h>
61 #include <bus/usb/usb.h>
62 #include <bus/usb/usbdi.h>
63 #include <bus/usb/usbdi_util.h>
64 #include <bus/usb/usb_quirks.h>
66 #define TIMEOUT hz*16 /* wait up to 16 seconds for a ready */
69 #define ULPT_BSIZE 16384
72 #define DPRINTF(x) if (ulptdebug) kprintf x
73 #define DPRINTFN(n,x) if (ulptdebug>(n)) kprintf x
75 SYSCTL_NODE(_hw_usb, OID_AUTO, ulpt, CTLFLAG_RW, 0, "USB ulpt");
76 SYSCTL_INT(_hw_usb_ulpt, OID_AUTO, debug, CTLFLAG_RW,
77 &ulptdebug, 0, "ulpt debug level");
83 #define UR_GET_DEVICE_ID 0
84 #define UR_GET_PORT_STATUS 1
85 #define UR_SOFT_RESET 2
87 #define LPS_NERR 0x08 /* printer no error */
88 #define LPS_SELECT 0x10 /* printer selected */
89 #define LPS_NOPAPER 0x20 /* printer out of paper */
90 #define LPS_INVERT (LPS_SELECT|LPS_NERR)
91 #define LPS_MASK (LPS_SELECT|LPS_NERR|LPS_NOPAPER)
95 usbd_device_handle sc_udev; /* device */
96 usbd_interface_handle sc_iface; /* interface */
100 usbd_pipe_handle sc_out_pipe; /* bulk out pipe */
103 usbd_pipe_handle sc_in_pipe; /* bulk in pipe */
104 usbd_xfer_handle sc_in_xfer1;
105 usbd_xfer_handle sc_in_xfer2;
106 u_char sc_junk[64]; /* somewhere to dump input */
109 #define ULPT_OPEN 0x01 /* device is open */
110 #define ULPT_OBUSY 0x02 /* printer is busy doing output */
111 #define ULPT_INIT 0x04 /* waiting to initialize for open */
113 #define ULPT_NOPRIME 0x40 /* don't prime on open */
114 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;
204 usb_endpoint_descriptor_t *ed;
208 DPRINTFN(10,("ulpt_attach: sc=%p\n", sc));
212 * Stepping through the alternate settings needs to be abstracted out.
214 cdesc = usbd_get_config_descriptor(dev);
216 kprintf("%s: failed to get configuration descriptor\n",
217 device_get_nameunit(sc->sc_dev));
220 iend = (usb_interface_descriptor_t *)
221 ((char *)cdesc + UGETW(cdesc->wTotalLength));
223 if (ifcd < (usb_interface_descriptor_t *)cdesc ||
225 panic("ulpt: iface desc out of range");
227 /* Step through all the descriptors looking for bidir mode */
228 for (id = ifcd, altno = 0;
230 id = (void *)((char *)id + id->bLength)) {
231 if (id->bDescriptorType == UDESC_INTERFACE &&
232 id->bInterfaceNumber == ifcd->bInterfaceNumber) {
233 if (id->bInterfaceClass == UICLASS_PRINTER &&
234 id->bInterfaceSubClass == UISUBCLASS_PRINTER &&
235 (id->bInterfaceProtocol == UIPROTO_PRINTER_BI /* ||
236 id->bInterfaceProtocol == UIPROTO_PRINTER_1284 */))
241 id = ifcd; /* not found, use original */
244 /* Found a new bidir setting */
245 DPRINTF(("ulpt_attach: set altno = %d\n", altno));
246 err = usbd_set_interface(iface, altno);
248 kprintf("%s: setting alternate interface failed\n",
249 device_get_nameunit(sc->sc_dev));
256 (void)usbd_endpoint_count(iface, &epcount);
260 sc->vendor = uaa->vendor;
261 sc->product = uaa->product;
262 for (i = 0; i < epcount; i++) {
263 ed = usbd_interface2endpoint_descriptor(iface, i);
265 kprintf("%s: couldn't get ep %d\n",
266 device_get_nameunit(sc->sc_dev), i);
269 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
270 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
271 sc->sc_in = ed->bEndpointAddress;
272 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
273 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
274 sc->sc_out = ed->bEndpointAddress;
277 if (sc->sc_out == -1) {
278 kprintf("%s: could not find bulk out endpoint\n",
279 device_get_nameunit(sc->sc_dev));
284 if (usbd_get_quirks(dev)->uq_flags & UQ_BROKEN_BIDIR) {
285 /* This device doesn't handle reading properly. */
289 kprintf("%s: using %s-directional mode\n", device_get_nameunit(sc->sc_dev),
290 sc->sc_in >= 0 ? "bi" : "uni");
292 DPRINTFN(10, ("ulpt_attach: bulk=%d\n", sc->sc_out));
294 sc->sc_iface = iface;
295 sc->sc_ifaceno = id->bInterfaceNumber;
298 dev_ops_add(&ulpt_ops, -1, device_get_unit(self));
299 make_dev(&ulpt_ops, device_get_unit(self),
300 UID_ROOT, GID_OPERATOR, 0644, "ulpt%d", device_get_unit(self));
302 device_get_unit(self)|ULPT_NOPRIME,
303 UID_ROOT, GID_OPERATOR, 0644, "unlpt%d", device_get_unit(self));
305 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
312 ulpt_detach(device_t self)
314 struct ulpt_softc *sc = device_get_softc(self);
316 DPRINTF(("ulpt_detach: sc=%p\n", sc));
319 if (sc->sc_out_pipe != NULL)
320 usbd_abort_pipe(sc->sc_out_pipe);
321 if (sc->sc_in_pipe != NULL)
322 usbd_abort_pipe(sc->sc_in_pipe);
325 * Wait for any ongoing operations to complete before we actually
331 if (sc->sc_refcnt >= 0) {
332 kprintf("%s: waiting for idle\n", device_get_nameunit(sc->sc_dev));
333 while (sc->sc_refcnt >= 0)
334 usb_detach_wait(sc->sc_dev);
335 kprintf("%s: idle wait done\n", device_get_nameunit(sc->sc_dev));
339 dev_ops_remove_minor(&ulpt_ops, /*-1, */device_get_unit(self));
341 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
348 ulpt_status(struct ulpt_softc *sc)
350 usb_device_request_t req;
354 req.bmRequestType = UT_READ_CLASS_INTERFACE;
355 req.bRequest = UR_GET_PORT_STATUS;
356 USETW(req.wValue, 0);
357 USETW(req.wIndex, sc->sc_ifaceno);
358 USETW(req.wLength, 1);
359 err = usbd_do_request(sc->sc_udev, &req, &status);
360 DPRINTFN(1, ("ulpt_status: status=0x%02x err=%d\n", status, err));
368 ulpt_reset(struct ulpt_softc *sc)
370 usb_device_request_t req;
373 /* The Brother HL1240 doesn't handle UT_WRITE_CLASS_OTHER */
374 other_fails = (sc->vendor == 0x04f9 && sc->product == 0x0006);
376 DPRINTFN(1, ("ulpt_reset\n"));
377 req.bRequest = UR_SOFT_RESET;
378 USETW(req.wValue, 0);
379 USETW(req.wIndex, sc->sc_ifaceno);
380 USETW(req.wLength, 0);
383 * There was a mistake in the USB printer 1.0 spec that gave the
384 * request type as UT_WRITE_CLASS_OTHER; it should have been
385 * UT_WRITE_CLASS_INTERFACE. Many printers use the old one,
388 req.bmRequestType = UT_WRITE_CLASS_OTHER;
389 /* Some printers don't handle UT_WRITE_CLASS_OTHER */
390 if (other_fails || usbd_do_request(sc->sc_udev, &req, 0)) {/* 1.0 */
391 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
392 (void)usbd_do_request(sc->sc_udev, &req, 0); /* 1.1 */
397 ulpt_input(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
399 struct ulpt_softc *sc = priv;
402 /* Don't loop on errors or 0-length input. */
403 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
404 if (status != USBD_NORMAL_COMPLETION || count == 0)
407 DPRINTFN(2,("ulpt_input: got some data\n"));
409 if (xfer == sc->sc_in_xfer1)
410 usbd_transfer(sc->sc_in_xfer2);
412 usbd_transfer(sc->sc_in_xfer1);
418 * Reset the printer, then wait until it's selected and not busy.
421 ulptopen(struct dev_open_args *ap)
423 cdev_t dev = ap->a_head.a_dev;
424 u_char flags = ULPTFLAGS(dev);
425 struct ulpt_softc *sc;
429 sc = devclass_get_softc(ulpt_devclass, ULPTUNIT(dev));
433 if (sc == NULL || sc->sc_iface == NULL || sc->sc_dying)
439 sc->sc_state = ULPT_INIT;
440 sc->sc_flags = flags;
441 DPRINTF(("ulptopen: flags=0x%x\n", (unsigned)flags));
443 #if defined(USB_DEBUG)
444 /* Ignoring these flags might not be a good idea */
445 if ((flags & ~ULPT_NOPRIME) != 0)
446 kprintf("ulptopen: flags ignored: %b\n", flags,
447 "\20\3POS_INIT\4POS_ACK\6PRIME_OPEN\7AUTOLF\10BYPASS");
453 if ((flags & ULPT_NOPRIME) == 0) {
462 for (spin = 0; (ulpt_status(sc) & LPS_SELECT) == 0; spin += STEP) {
463 DPRINTF(("ulpt_open: waiting a while\n"));
464 if (spin >= TIMEOUT) {
470 /* wait 1/4 second, give up if we get a signal */
471 error = tsleep((caddr_t)sc, PCATCH, "ulptop", STEP);
472 if (error != EWOULDBLOCK) {
484 err = usbd_open_pipe(sc->sc_iface, sc->sc_out, 0, &sc->sc_out_pipe);
491 if (ulptusein && sc->sc_in != -1) {
492 DPRINTF(("ulpt_open: open input pipe\n"));
493 err = usbd_open_pipe(sc->sc_iface, sc->sc_in,0,&sc->sc_in_pipe);
496 usbd_close_pipe(sc->sc_out_pipe);
497 sc->sc_out_pipe = NULL;
501 sc->sc_in_xfer1 = usbd_alloc_xfer(sc->sc_udev);
502 sc->sc_in_xfer2 = usbd_alloc_xfer(sc->sc_udev);
503 if (sc->sc_in_xfer1 == NULL || sc->sc_in_xfer2 == NULL) {
505 if (sc->sc_in_xfer1 != NULL) {
506 usbd_free_xfer(sc->sc_in_xfer1);
507 sc->sc_in_xfer1 = NULL;
509 if (sc->sc_in_xfer2 != NULL) {
510 usbd_free_xfer(sc->sc_in_xfer2);
511 sc->sc_in_xfer2 = NULL;
513 usbd_close_pipe(sc->sc_out_pipe);
514 sc->sc_out_pipe = NULL;
515 usbd_close_pipe(sc->sc_in_pipe);
516 sc->sc_in_pipe = NULL;
520 usbd_setup_xfer(sc->sc_in_xfer1, sc->sc_in_pipe, sc,
521 sc->sc_junk, sizeof sc->sc_junk, USBD_SHORT_XFER_OK,
522 USBD_NO_TIMEOUT, ulpt_input);
523 usbd_setup_xfer(sc->sc_in_xfer2, sc->sc_in_pipe, sc,
524 sc->sc_junk, sizeof sc->sc_junk, USBD_SHORT_XFER_OK,
525 USBD_NO_TIMEOUT, ulpt_input);
526 usbd_transfer(sc->sc_in_xfer1); /* ignore failed start */
529 sc->sc_state = ULPT_OPEN;
532 if (--sc->sc_refcnt < 0)
533 usb_detach_wakeup(sc->sc_dev);
535 DPRINTF(("ulptopen: done, error=%d\n", error));
540 ulpt_statusmsg(u_char status, struct ulpt_softc *sc)
544 status = (status ^ LPS_INVERT) & LPS_MASK;
545 new = status & ~sc->sc_laststatus;
546 sc->sc_laststatus = status;
548 if (new & LPS_SELECT)
549 log(LOG_NOTICE, "%s: offline\n", device_get_nameunit(sc->sc_dev));
550 else if (new & LPS_NOPAPER)
551 log(LOG_NOTICE, "%s: out of paper\n", device_get_nameunit(sc->sc_dev));
552 else if (new & LPS_NERR)
553 log(LOG_NOTICE, "%s: output error\n", device_get_nameunit(sc->sc_dev));
559 ulptclose(struct dev_close_args *ap)
561 cdev_t dev = ap->a_head.a_dev;
562 struct ulpt_softc *sc;
564 sc = devclass_get_softc(ulpt_devclass, ULPTUNIT(dev));
566 if (sc->sc_state != ULPT_OPEN)
567 /* We are being forced to close before the open completed. */
570 if (sc->sc_out_pipe != NULL) {
571 usbd_close_pipe(sc->sc_out_pipe);
572 sc->sc_out_pipe = NULL;
574 if (sc->sc_in_pipe != NULL) {
575 usbd_abort_pipe(sc->sc_in_pipe);
576 usbd_close_pipe(sc->sc_in_pipe);
577 sc->sc_in_pipe = NULL;
578 if (sc->sc_in_xfer1 != NULL) {
579 usbd_free_xfer(sc->sc_in_xfer1);
580 sc->sc_in_xfer1 = NULL;
582 if (sc->sc_in_xfer2 != NULL) {
583 usbd_free_xfer(sc->sc_in_xfer2);
584 sc->sc_in_xfer2 = NULL;
590 DPRINTF(("ulptclose: closed\n"));
595 ulpt_do_write(struct ulpt_softc *sc, struct uio *uio, int flags)
600 usbd_xfer_handle xfer;
603 DPRINTF(("ulptwrite\n"));
604 xfer = usbd_alloc_xfer(sc->sc_udev);
607 bufp = usbd_alloc_buffer(xfer, ULPT_BSIZE);
609 usbd_free_xfer(xfer);
612 while ((n = min(ULPT_BSIZE, uio->uio_resid)) != 0) {
613 ulpt_statusmsg(ulpt_status(sc), sc);
614 error = uiomove(bufp, n, uio);
617 DPRINTFN(1, ("ulptwrite: transfer %d bytes\n", n));
618 err = usbd_bulk_transfer(xfer, sc->sc_out_pipe, USBD_NO_COPY,
619 USBD_NO_TIMEOUT, bufp, &n, "ulptwr");
621 DPRINTF(("ulptwrite: error=%d\n", err));
626 usbd_free_xfer(xfer);
632 ulptwrite(struct dev_write_args *ap)
634 cdev_t dev = ap->a_head.a_dev;
635 struct ulpt_softc *sc;
638 sc = devclass_get_softc(ulpt_devclass, ULPTUNIT(dev));
644 error = ulpt_do_write(sc, ap->a_uio, ap->a_ioflag);
645 if (--sc->sc_refcnt < 0)
646 usb_detach_wakeup(sc->sc_dev);
651 ulptioctl(struct dev_ioctl_args *ap)
664 /* XXX This does not belong here. */
666 * Print select parts of an IEEE 1284 device ID.
669 ieee1284_print_id(char *str)
673 for (p = str-1; p; p = strchr(p, ';')) {
675 if (strncmp(p, "MFG:", 4) == 0 ||
676 strncmp(p, "MANUFACTURER:", 14) == 0 ||
677 strncmp(p, "MDL:", 4) == 0 ||
678 strncmp(p, "MODEL:", 6) == 0) {
681 kprintf("%.*s", (int)(q - p + 1), p);
687 DRIVER_MODULE(ulpt, uhub, ulpt_driver, ulpt_devclass, usbd_driver_load, 0);