Synchronize the USB, CAM, and TASKQUEUE subsystems with FreeBSD RELENG_4.
[dragonfly.git] / sys / dev / usbmisc / ulpt / ulpt.c
1 /*
2  * $NetBSD: ulpt.c,v 1.29 1999/11/17 23:00:50 augustss Exp $
3  * $FreeBSD: src/sys/dev/usb/ulpt.c,v 1.26.2.14 2003/06/22 13:54:30 iedowse Exp $
4  * $DragonFly: src/sys/dev/usbmisc/ulpt/ulpt.c,v 1.6 2003/12/29 06:42:17 dillon Exp $
5  */
6
7 /*
8  * Copyright (c) 1998 The NetBSD Foundation, Inc.
9  * All rights reserved.
10  *
11  * This code is derived from software contributed to The NetBSD Foundation
12  * by Lennart Augustsson (lennart@augustsson.net) at
13  * Carlstedt Research & Technology.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
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.
30  *
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.
42  */
43
44 /*
45  * Printer Class spec: http://www.usb.org/developers/data/usbprn10.pdf
46  */
47
48 /* XXX Note in the manpage the ULPT_NOPRIME version of the printer */
49
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/proc.h>
53 #include <sys/kernel.h>
54 #if defined(__NetBSD__) || defined(__OpenBSD__)
55 #include <sys/device.h>
56 #include <sys/ioctl.h>
57 #elif defined(__FreeBSD__)
58 #include <sys/module.h>
59 #include <sys/bus.h>
60 #endif
61 #include <sys/uio.h>
62 #include <sys/conf.h>
63 #include <sys/vnode.h>
64 #include <sys/syslog.h>
65 #include <sys/sysctl.h>
66
67 #include <bus/usb/usb.h>
68 #include <bus/usb/usbdi.h>
69 #include <bus/usb/usbdi_util.h>
70
71 #define TIMEOUT         hz*16   /* wait up to 16 seconds for a ready */
72 #define STEP            hz/4
73
74 #define ULPT_BSIZE      16384
75
76 #ifdef USB_DEBUG
77 #define DPRINTF(x)      if (ulptdebug) logprintf x
78 #define DPRINTFN(n,x)   if (ulptdebug>(n)) logprintf x
79 int     ulptdebug = 0;
80 SYSCTL_NODE(_hw_usb, OID_AUTO, ulpt, CTLFLAG_RW, 0, "USB ulpt");
81 SYSCTL_INT(_hw_usb_ulpt, OID_AUTO, debug, CTLFLAG_RW,
82            &ulptdebug, 0, "ulpt debug level");
83 #else
84 #define DPRINTF(x)
85 #define DPRINTFN(n,x)
86 #endif
87
88 #define UR_GET_DEVICE_ID 0
89 #define UR_GET_PORT_STATUS 1
90 #define UR_SOFT_RESET 2
91
92 #define LPS_NERR                0x08    /* printer no error */
93 #define LPS_SELECT              0x10    /* printer selected */
94 #define LPS_NOPAPER             0x20    /* printer out of paper */
95 #define LPS_INVERT      (LPS_SELECT|LPS_NERR)
96 #define LPS_MASK        (LPS_SELECT|LPS_NERR|LPS_NOPAPER)
97
98 struct ulpt_softc {
99         USBBASEDEVICE sc_dev;
100         usbd_device_handle sc_udev;     /* device */
101         usbd_interface_handle sc_iface; /* interface */
102         int sc_ifaceno;
103         usbd_pipe_handle sc_bulkpipe;   /* bulk pipe */
104         int sc_bulk;
105
106         u_char sc_state;
107 #define ULPT_OPEN       0x01    /* device is open */
108 #define ULPT_OBUSY      0x02    /* printer is busy doing output */
109 #define ULPT_INIT       0x04    /* waiting to initialize for open */
110         u_char sc_flags;
111 #define ULPT_NOPRIME    0x40    /* don't prime on open */
112         u_char sc_laststatus;
113
114         int sc_refcnt;
115         u_char sc_dying;
116
117 #if defined(__FreeBSD__)
118         dev_t dev;
119         dev_t dev_noprime;
120 #endif
121 };
122
123 #if defined(__NetBSD__) || defined(__OpenBSD__)
124 cdev_decl(ulpt);
125 #elif defined(__FreeBSD__)
126 Static d_open_t ulptopen;
127 Static d_close_t ulptclose;
128 Static d_write_t ulptwrite;
129 Static d_ioctl_t ulptioctl;
130
131 #define ULPT_CDEV_MAJOR 113
132
133 Static struct cdevsw ulpt_cdevsw = {
134         /* name */      "ulpt",
135         /* maj */       ULPT_CDEV_MAJOR,
136         /* flags */     0,
137         /* port */      NULL,
138         /* autoq */     0,
139
140         /* open */      ulptopen,
141         /* close */     ulptclose,
142         /* read */      noread,
143         /* write */     ulptwrite,
144         /* ioctl */     ulptioctl,
145         /* poll */      nopoll,
146         /* mmap */      nommap,
147         /* strategy */  nostrategy,
148         /* dump */      nodump,
149         /* psize */     nopsize
150 };
151 #endif
152
153 void ulpt_disco(void *);
154
155 int ulpt_do_write(struct ulpt_softc *, struct uio *uio, int);
156 int ulpt_status(struct ulpt_softc *);
157 void ulpt_reset(struct ulpt_softc *);
158 int ulpt_statusmsg(u_char, struct ulpt_softc *);
159
160 void ieee1284_print_id(char *);
161
162 #define ULPTUNIT(s)     (minor(s) & 0x1f)
163 #define ULPTFLAGS(s)    (minor(s) & 0xe0)
164
165
166 USB_DECLARE_DRIVER(ulpt);
167
168 USB_MATCH(ulpt)
169 {
170         USB_MATCH_START(ulpt, uaa);
171         usb_interface_descriptor_t *id;
172         
173         DPRINTFN(10,("ulpt_match\n"));
174         if (uaa->iface == NULL)
175                 return (UMATCH_NONE);
176         id = usbd_get_interface_descriptor(uaa->iface);
177         if (id != NULL &&
178             id->bInterfaceClass == UICLASS_PRINTER &&
179             id->bInterfaceSubClass == UISUBCLASS_PRINTER &&
180             (id->bInterfaceProtocol == UIPROTO_PRINTER_UNI ||
181              id->bInterfaceProtocol == UIPROTO_PRINTER_BI))
182                 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
183         return (UMATCH_NONE);
184 }
185
186 USB_ATTACH(ulpt)
187 {
188         USB_ATTACH_START(ulpt, sc, uaa);
189         usbd_device_handle dev = uaa->device;
190         usbd_interface_handle iface = uaa->iface;
191         usb_interface_descriptor_t *id = usbd_get_interface_descriptor(iface);
192         char devinfo[1024];
193         usb_endpoint_descriptor_t *ed;
194         usbd_status err;
195         
196         DPRINTFN(10,("ulpt_attach: sc=%p\n", sc));
197         usbd_devinfo(dev, 0, devinfo);
198         USB_ATTACH_SETUP;
199         printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
200                devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
201
202         /* Figure out which endpoint is the bulk out endpoint. */
203         ed = usbd_interface2endpoint_descriptor(iface, 0);
204         if (ed == NULL)
205                 goto nobulk;
206         if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_OUT ||
207             (ed->bmAttributes & UE_XFERTYPE) != UE_BULK) {
208                 /* In case we are using a bidir protocol... */
209                 ed = usbd_interface2endpoint_descriptor(iface, 1);
210                 if (ed == NULL)
211                         goto nobulk;
212                 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_OUT ||
213                     (ed->bmAttributes & UE_XFERTYPE) != UE_BULK)
214                         goto nobulk;
215         }
216         sc->sc_bulk = ed->bEndpointAddress;
217         DPRINTFN(10, ("ulpt_attach: bulk=%d\n", sc->sc_bulk));
218
219         sc->sc_iface = iface;
220         err = usbd_interface2device_handle(iface, &sc->sc_udev);
221         if (err) {
222                 sc->sc_dying = 1;
223                 USB_ATTACH_ERROR_RETURN;
224         }
225         sc->sc_ifaceno = id->bInterfaceNumber;
226
227 #if 0
228 /*
229  * This code is disabled because for some mysterious reason it causes
230  * printing not to work.  But only sometimes, and mostly with
231  * UHCI and less often with OHCI.  *sigh*
232  */
233         {
234         usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev);
235         usb_device_request_t req;
236         int len, alen;
237
238         req.bmRequestType = UT_READ_CLASS_INTERFACE;
239         req.bRequest = UR_GET_DEVICE_ID;
240         USETW(req.wValue, cd->bConfigurationValue);
241         USETW2(req.wIndex, id->bInterfaceNumber, id->bAlternateSetting);
242         USETW(req.wLength, sizeof devinfo - 1);
243         err = usbd_do_request_flags(dev, &req, devinfo, USBD_SHORT_XFER_OK,
244                   &alen);
245         if (err) {
246                 printf("%s: cannot get device id\n", USBDEVNAME(sc->sc_dev));
247         } else if (alen <= 2) {
248                 printf("%s: empty device id, no printer connected?\n",
249                        USBDEVNAME(sc->sc_dev));
250         } else {
251                 /* devinfo now contains an IEEE-1284 device ID */
252                 len = ((devinfo[0] & 0xff) << 8) | (devinfo[1] & 0xff);
253                 if (len > sizeof devinfo - 3)
254                         len = sizeof devinfo - 3;
255                 devinfo[len] = 0;
256                 printf("%s: device id <", USBDEVNAME(sc->sc_dev));
257                 ieee1284_print_id(devinfo+2);
258                 printf(">\n");
259         }
260         }
261 #endif
262
263 #if defined(__FreeBSD__)
264         sc->dev = make_dev(&ulpt_cdevsw, device_get_unit(self),
265                 UID_ROOT, GID_OPERATOR, 0644, "ulpt%d", device_get_unit(self));
266         sc->dev_noprime = make_dev(&ulpt_cdevsw,
267                 device_get_unit(self)|ULPT_NOPRIME,
268                 UID_ROOT, GID_OPERATOR, 0644, "unlpt%d", device_get_unit(self));
269 #endif
270
271         USB_ATTACH_SUCCESS_RETURN;
272
273  nobulk:
274         printf("%s: could not find bulk endpoint\n", USBDEVNAME(sc->sc_dev));
275         sc->sc_dying = 1;
276         USB_ATTACH_ERROR_RETURN;
277 }
278
279 #if defined(__NetBSD__) || defined(__OpenBSD__)
280 int
281 ulpt_activate(device_ptr_t self, enum devact act)
282 {
283         struct ulpt_softc *sc = (struct ulpt_softc *)self;
284
285         switch (act) {
286         case DVACT_ACTIVATE:
287                 return (EOPNOTSUPP);
288                 break;
289
290         case DVACT_DEACTIVATE:
291                 sc->sc_dying = 1;
292                 break;
293         }
294         return (0);
295 }
296 #endif
297
298 USB_DETACH(ulpt)
299 {
300         USB_DETACH_START(ulpt, sc);
301         int s;
302 #if defined(__NetBSD__) || defined(__OpenBSD__)
303         int maj, mn;
304 #elif defined(__FreeBSD__)
305         struct vnode *vp;
306 #endif
307
308 #if defined(__NetBSD__) || defined(__OpenBSD__)
309         DPRINTF(("ulpt_detach: sc=%p flags=%d\n", sc, flags));
310 #elif defined(__FreeBSD__)
311         DPRINTF(("ulpt_detach: sc=%p\n", sc));
312 #endif
313
314         sc->sc_dying = 1;
315         if (sc->sc_bulkpipe != NULL)
316                 usbd_abort_pipe(sc->sc_bulkpipe);
317
318         s = splusb();
319         if (--sc->sc_refcnt >= 0) {
320                 /* There is noone to wake, aborting the pipe is enough */
321                 /* Wait for processes to go away. */
322                 usb_detach_wait(USBDEV(sc->sc_dev));
323         }
324         splx(s);
325
326 #if defined(__NetBSD__) || defined(__OpenBSD__)
327         /* locate the major number */
328         for (maj = 0; maj < nchrdev; maj++)
329                 if (cdevsw[maj].d_open == ulptopen)
330                         break;
331
332         /* Nuke the vnodes for any open instances (calls close). */
333         mn = self->dv_unit;
334         vdevgone(maj, mn, mn, VCHR);
335 #elif defined(__FreeBSD__)
336         vp = SLIST_FIRST(&sc->dev->si_hlist);
337         if (vp)
338                 VOP_REVOKE(vp, REVOKEALL);
339         vp = SLIST_FIRST(&sc->dev_noprime->si_hlist);
340         if (vp)
341                 VOP_REVOKE(vp, REVOKEALL);
342
343         destroy_dev(sc->dev);
344         destroy_dev(sc->dev_noprime);
345 #endif
346
347         return (0);
348 }
349
350 int
351 ulpt_status(struct ulpt_softc *sc)
352 {
353         usb_device_request_t req;
354         usbd_status err;
355         u_char status;
356
357         req.bmRequestType = UT_READ_CLASS_INTERFACE;
358         req.bRequest = UR_GET_PORT_STATUS;
359         USETW(req.wValue, 0);
360         USETW(req.wIndex, sc->sc_ifaceno);
361         USETW(req.wLength, 1);
362         err = usbd_do_request(sc->sc_udev, &req, &status);
363         DPRINTFN(1, ("ulpt_status: status=0x%02x err=%d\n", status, err));
364         if (!err)
365                 return (status);
366         else
367                 return (0);
368 }
369
370 void
371 ulpt_reset(struct ulpt_softc *sc)
372 {
373         usb_device_request_t req;
374
375         DPRINTFN(1, ("ulpt_reset\n"));
376         req.bmRequestType = UT_WRITE_CLASS_OTHER;
377         req.bRequest = UR_SOFT_RESET;
378         USETW(req.wValue, 0);
379         USETW(req.wIndex, sc->sc_ifaceno);
380         USETW(req.wLength, 0);
381         (void)usbd_do_request(sc->sc_udev, &req, 0);
382 }
383
384 /*
385  * Reset the printer, then wait until it's selected and not busy.
386  */
387 int
388 ulptopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
389 {
390         u_char flags = ULPTFLAGS(dev);
391         struct ulpt_softc *sc;
392         usbd_status err;
393         int spin, error;
394
395         USB_GET_SC_OPEN(ulpt, ULPTUNIT(dev), sc);
396
397         if (sc == NULL || sc->sc_iface == NULL || sc->sc_dying)
398                 return (ENXIO);
399
400         if (sc->sc_state)
401                 return (EBUSY);
402
403         sc->sc_state = ULPT_INIT;
404         sc->sc_flags = flags;
405         DPRINTF(("ulptopen: flags=0x%x\n", (unsigned)flags));
406
407 #if defined(USB_DEBUG) && defined(__FreeBSD__)
408         /* Ignoring these flags might not be a good idea */
409         if ((flags & ~ULPT_NOPRIME) != 0)
410                 printf("ulptopen: flags ignored: %b\n", flags,
411                         "\20\3POS_INIT\4POS_ACK\6PRIME_OPEN\7AUTOLF\10BYPASS");
412 #endif
413
414
415         if ((flags & ULPT_NOPRIME) == 0) {
416                 ulpt_reset(sc);
417                 if (sc->sc_dying) {
418                         sc->sc_state = 0;
419                         return (ENXIO);
420                 }
421         }
422
423         for (spin = 0; (ulpt_status(sc) & LPS_SELECT) == 0; spin += STEP) {
424                 if (spin >= TIMEOUT) {
425                         sc->sc_state = 0;
426                         return (EBUSY);
427                 }
428
429                 /* wait 1/4 second, give up if we get a signal */
430                 error = tsleep((caddr_t)sc, PCATCH, "ulptop", STEP);
431                 if (error != EWOULDBLOCK) {
432                         sc->sc_state = 0;
433                         return (error);
434                 }
435
436                 if (sc->sc_dying) {
437                         sc->sc_state = 0;
438                         return (ENXIO);
439                 }
440         }
441
442         err = usbd_open_pipe(sc->sc_iface, sc->sc_bulk, 0, &sc->sc_bulkpipe);
443         if (err) {
444                 sc->sc_state = 0;
445                 return (EIO);
446         }
447
448         sc->sc_state = ULPT_OPEN;
449
450         DPRINTF(("ulptopen: done\n"));
451         return (0);
452 }
453
454 int
455 ulpt_statusmsg(u_char status, struct ulpt_softc *sc)
456 {
457         u_char new;
458
459         status = (status ^ LPS_INVERT) & LPS_MASK;
460         new = status & ~sc->sc_laststatus;
461         sc->sc_laststatus = status;
462
463         if (new & LPS_SELECT)
464                 log(LOG_NOTICE, "%s: offline\n", USBDEVNAME(sc->sc_dev));
465         else if (new & LPS_NOPAPER)
466                 log(LOG_NOTICE, "%s: out of paper\n", USBDEVNAME(sc->sc_dev));
467         else if (new & LPS_NERR)
468                 log(LOG_NOTICE, "%s: output error\n", USBDEVNAME(sc->sc_dev));
469
470         return (status);
471 }
472
473 int
474 ulptclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
475 {
476         struct ulpt_softc *sc;
477
478         USB_GET_SC(ulpt, ULPTUNIT(dev), sc);
479
480         if (sc->sc_state != ULPT_OPEN)
481                 /* We are being forced to close before the open completed. */
482                 return (0);
483
484         usbd_close_pipe(sc->sc_bulkpipe);
485         sc->sc_bulkpipe = 0;
486
487         sc->sc_state = 0;
488
489         DPRINTF(("ulptclose: closed\n"));
490         return (0);
491 }
492
493 int
494 ulpt_do_write(struct ulpt_softc *sc, struct uio *uio, int flags)
495 {
496         u_int32_t n;
497         int error = 0;
498         void *bufp;
499         usbd_xfer_handle xfer;
500         usbd_status err;
501
502         DPRINTF(("ulptwrite\n"));
503         xfer = usbd_alloc_xfer(sc->sc_udev);
504         if (xfer == NULL)
505                 return (ENOMEM);
506         bufp = usbd_alloc_buffer(xfer, ULPT_BSIZE);
507         if (bufp == NULL) {
508                 usbd_free_xfer(xfer);
509                 return (ENOMEM);
510         }
511         while ((n = min(ULPT_BSIZE, uio->uio_resid)) != 0) {
512                 ulpt_statusmsg(ulpt_status(sc), sc);
513                 error = uiomove(bufp, n, uio);
514                 if (error)
515                         break;
516                 DPRINTFN(1, ("ulptwrite: transfer %d bytes\n", n));
517                 err = usbd_bulk_transfer(xfer, sc->sc_bulkpipe, USBD_NO_COPY, 
518                           USBD_NO_TIMEOUT, bufp, &n, "ulptwr");
519                 if (err) {
520                         DPRINTF(("ulptwrite: error=%d\n", err));
521                         error = EIO;
522                         break;
523                 }
524         }
525         usbd_free_xfer(xfer);
526
527         return (error);
528 }
529
530 int
531 ulptwrite(dev_t dev, struct uio *uio, int flags)
532 {
533         struct ulpt_softc *sc;
534         int error;
535
536         USB_GET_SC(ulpt, ULPTUNIT(dev), sc);
537
538         if (sc->sc_dying)
539                 return (EIO);
540
541         sc->sc_refcnt++;
542         error = ulpt_do_write(sc, uio, flags);
543         if (--sc->sc_refcnt < 0)
544                 usb_detach_wakeup(USBDEV(sc->sc_dev));
545         return (error);
546 }
547
548 int
549 ulptioctl(dev_t dev, u_long cmd, caddr_t data, int flag, usb_proc_ptr p)
550 {
551         int error = 0;
552
553         switch (cmd) {
554         default:
555                 error = ENODEV;
556         }
557
558         return (error);
559 }
560
561 #if 0
562 /* XXX This does not belong here. */
563 /*
564  * Print select parts of a IEEE 1284 device ID.
565  */
566 void
567 ieee1284_print_id(char *str)
568 {
569         char *p, *q;
570
571         for (p = str-1; p; p = strchr(p, ';')) {
572                 p++;            /* skip ';' */
573                 if (strncmp(p, "MFG:", 4) == 0 ||
574                     strncmp(p, "MANUFACTURER:", 14) == 0 ||
575                     strncmp(p, "MDL:", 4) == 0 ||
576                     strncmp(p, "MODEL:", 6) == 0) {
577                         q = strchr(p, ';');
578                         if (q)
579                                 printf("%.*s", (int)(q - p + 1), p);
580                 }
581         }
582 }
583 #endif
584
585 #if defined(__FreeBSD__)
586 DRIVER_MODULE(ulpt, uhub, ulpt_driver, ulpt_devclass, usbd_driver_load, 0);
587 #endif