37fb997d45d04904e76f149d00e3ec1aa5e08d96
[dragonfly.git] / sys / dev / usbmisc / uscanner / uscanner.c
1 /* 
2  * $NetBSD: uscanner.c,v 1.30 2002/07/11 21:14:36 augustss Exp $
3  * $FreeBSD: src/sys/dev/usb/uscanner.c,v 1.48 2003/12/22 19:58:27 sanpei Exp $
4  * $DragonFly: src/sys/dev/usbmisc/uscanner/uscanner.c,v 1.27 2008/01/16 12:25:36 matthias Exp $
5  */
6
7 /* Also already merged from NetBSD:
8  *      $NetBSD: uscanner.c,v 1.33 2002/09/23 05:51:24 simonb Exp $
9  */
10
11 /*
12  * Copyright (c) 2000 The NetBSD Foundation, Inc.
13  * All rights reserved.
14  *
15  * This code is derived from software contributed to The NetBSD Foundation
16  * by Lennart Augustsson (lennart@augustsson.net) at
17  * Carlstedt Research & Technology
18  * and Nick Hibma (n_hibma@qubesoft.com).
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  * 1. Redistributions of source code must retain the above copyright
24  *    notice, this list of conditions and the following disclaimer.
25  * 2. Redistributions in binary form must reproduce the above copyright
26  *    notice, this list of conditions and the following disclaimer in the
27  *    documentation and/or other materials provided with the distribution.
28  * 3. All advertising materials mentioning features or use of this software
29  *    must display the following acknowledgement:
30  *        This product includes software developed by the NetBSD
31  *        Foundation, Inc. and its contributors.
32  * 4. Neither the name of The NetBSD Foundation nor the names of its
33  *    contributors may be used to endorse or promote products derived
34  *    from this software without specific prior written permission.
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
37  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
38  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
41  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
42  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
43  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
44  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
46  * POSSIBILITY OF SUCH DAMAGE.
47  */
48
49
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/kernel.h>
53 #include <sys/malloc.h>
54 #include <sys/module.h>
55 #include <sys/bus.h>
56 #include <sys/conf.h>
57 #include <sys/fcntl.h>
58 #include <sys/filio.h>
59 #include <sys/tty.h>
60 #include <sys/file.h>
61 #include <sys/select.h>
62 #include <sys/proc.h>
63 #include <sys/poll.h>
64 #include <sys/conf.h>
65 #include <sys/sysctl.h>
66 #include <sys/thread2.h>
67
68 #include <bus/usb/usb.h>
69 #include <bus/usb/usbdi.h>
70 #include <bus/usb/usbdi_util.h>
71
72 #ifdef USB_DEBUG
73 #define DPRINTF(x)      if (uscannerdebug) kprintf x
74 #define DPRINTFN(n,x)   if (uscannerdebug>(n)) kprintf x
75 int     uscannerdebug = 0;
76 SYSCTL_NODE(_hw_usb, OID_AUTO, uscanner, CTLFLAG_RW, 0, "USB uscanner");
77 SYSCTL_INT(_hw_usb_uscanner, OID_AUTO, debug, CTLFLAG_RW,
78            &uscannerdebug, 0, "uscanner debug level");
79 #else
80 #define DPRINTF(x)
81 #define DPRINTFN(n,x)
82 #endif
83
84 struct uscan_info {
85         struct usb_devno devno;
86         u_int flags;
87 #define USC_KEEP_OPEN 1
88 };
89
90 /* Table of scanners that may work with this driver. */
91 static const struct uscan_info uscanner_devs[] = {
92   /* Acer Peripherals */
93  {{ USB_DEVICE(0x04a5, 0x2022) }, 0 }, /* Acerscan 320U */
94  {{ USB_DEVICE(0x04a5, 0x20b0) }, 0 }, /* Benq 3300U/4300U */
95  {{ USB_DEVICE(0x04a5, 0x2040) }, 0 }, /* Acerscan 640U */
96  {{ USB_DEVICE(0x04a5, 0x20be) }, 0 }, /* Acerscan 640BT */
97  {{ USB_DEVICE(0x04a5, 0x2060) }, 0 }, /* Acerscan 620U */
98  {{ USB_DEVICE(0x04a5, 0x20c0) }, 0 }, /* Acerscan 1240U */
99  {{ USB_DEVICE(0x04a5, 0x12a6) }, 0 }, /* Acerscan C310U */
100   /* AGFA */
101  {{ USB_DEVICE(0x06bd, 0x0002) }, 0 }, /* SnapScan 1236U */
102  {{ USB_DEVICE(0x06bd, 0x0001) }, 0 }, /* SnapScan 1212U */
103  {{ USB_DEVICE(0x06bd, 0x2061) }, 0 }, /* SnapScan 1212U */
104  {{ USB_DEVICE(0x06bd, 0x0100) }, 0 }, /* SnapScan Touch */
105  {{ USB_DEVICE(0x06bd, 0x208d) }, 0 }, /* SnapScan e40 */
106  {{ USB_DEVICE(0x06bd, 0x208f) }, 0 }, /* SnapScan e50 */
107  {{ USB_DEVICE(0x06bd, 0x2091) }, 0 }, /* SnapScan e20 */
108  {{ USB_DEVICE(0x06bd, 0x2095) }, 0 }, /* SnapScan e25 */
109  {{ USB_DEVICE(0x06bd, 0x2097) }, 0 }, /* SnapScan e26 */
110  {{ USB_DEVICE(0x06bd, 0x20fd) }, 0 }, /* SnapScan e52 */
111   /* Avision */
112  {{ USB_DEVICE(0x0638, 0x0268) }, 0 }, /* Avision 1200U */
113   /* Canon */
114  {{ USB_DEVICE(0x04a9, 0x2206) }, 0 }, /* CanoScan N656U */
115  {{ USB_DEVICE(0x04a9, 0x220d) }, 0 }, /* CanoScan N676U */
116  {{ USB_DEVICE(0x04a9, 0x2207) }, 0 }, /* CanoScan N1220U */
117  {{ USB_DEVICE(0x04a9, 0x2208) }, 0 }, /* CanoScan D660U */
118  {{ USB_DEVICE(0x04a9, 0x220e) }, 0 }, /* CanoScan N1240U */
119  {{ USB_DEVICE(0x04a9, 0x2220) }, 0 }, /* CanoScan LIDE 25 */
120   /* Kye */
121  {{ USB_DEVICE(0x0458, 0x2001) }, 0 }, /* ColorPage Vivid-Pro */
122   /* HP */
123  {{ USB_DEVICE(0x03f0, 0x0605) }, 0 }, /* ScanJet 2200C */
124  {{ USB_DEVICE(0x03f0, 0x0205) }, 0 }, /* ScanJet 3300C */
125  {{ USB_DEVICE(0x03f0, 0x0405) }, 0 }, /* ScanJet 3400cse */
126  {{ USB_DEVICE(0x03f0, 0x0101) }, 0 }, /* Scanjet 4100C */
127  {{ USB_DEVICE(0x03f0, 0x0105) }, 0 }, /* ScanJet 4200C */
128  {{ USB_DEVICE(0x03f0, 0x0305) }, 0 }, /* Scanjet 4300C */
129  {{ USB_DEVICE(0x03f0, 0x3005) }, 0 }, /* ScanJet 4670v */
130  {{ USB_DEVICE(0x03f0, 0x0102) }, 0 }, /* Photosmart S20 */
131  {{ USB_DEVICE(0x03f0, 0x0401) }, 0 }, /* Scanjet 5200C */
132  {{ USB_DEVICE(0x03f0, 0x0701) }, 0 }, /* Scanjet 5300C */
133  {{ USB_DEVICE(0x03f0, 0x1005) }, 0 }, /* Scanjet 5400C */
134  {{ USB_DEVICE(0x03f0, 0x0201) }, 0 }, /* ScanJet 6200C */
135  {{ USB_DEVICE(0x03f0, 0x0601) }, 0 }, /* Scanjet 6300C */
136  {{ USB_DEVICE(0x03f0, 0x0b01) }, 0 }, /* Scanjet 82x0C */
137   /* Scanlogic */
138  {{ USB_DEVICE(0x04ce, 0x0300) }, 0 }, /* Phantom 336CX - C3 */
139   /* Microtek */
140  {{ USB_DEVICE(0x05da, 0x0099) }, 0 }, /* Phantom 336CX - C3 */
141  {{ USB_DEVICE(0x05da, 0x0094) }, 0 }, /* ScanMaker X6 - X6U */
142  {{ USB_DEVICE(0x05da, 0x00a0) }, 0 }, /* Phantom 336CX - C3 */
143  {{ USB_DEVICE(0x05da, 0x009a) }, 0 }, /* Phantom C6 */
144  {{ USB_DEVICE(0x05da, 0x00a3) }, 0 }, /* ScanMaker V6USL */
145  {{ USB_DEVICE(0x05da, 0x80a3) }, 0 }, /* ScanMaker V6USL */
146  {{ USB_DEVICE(0x05da, 0x80ac) }, 0 }, /* ScanMaker V6UL */
147   /* Minolta */
148  {{ USB_DEVICE(0x0686, 0x400e) }, 0 }, /* Dimage 5400 */
149   /* Mustek */
150  {{ USB_DEVICE(0x055f, 0x0001) }, 0 }, /* 1200 CU */
151  {{ USB_DEVICE(0x055f, 0x0010) }, 0 }, /* BearPaw 1200F */
152  {{ USB_DEVICE(0x055f, 0x021e) }, 0 }, /* BearPaw 1200TA */
153  {{ USB_DEVICE(0x055f, 0x0873) }, 0 }, /* 600 USB */
154  {{ USB_DEVICE(0x055f, 0x0002) }, 0 }, /* 600 CU */
155  {{ USB_DEVICE(0x055f, 0x0003) }, 0 }, /* 1200 USB */
156  {{ USB_DEVICE(0x055f, 0x0006) }, 0 }, /* 1200 UB */
157  {{ USB_DEVICE(0x055f, 0x0007) }, 0 }, /* 1200 USB */
158  {{ USB_DEVICE(0x055f, 0x0008) }, 0 }, /* 1200 CU */
159   /* National */
160  {{ USB_DEVICE(0x0400, 0x1000) }, 0 }, /* BearPaw 1200 */
161  {{ USB_DEVICE(0x0400, 0x1001) }, 0 }, /* BearPaw 2400 */
162   /* Nikon */
163  {{ USB_DEVICE(0x04b0, 0x4000) }, 0 }, /* CoolScan LS40 ED */
164   /* Primax */
165  {{ USB_DEVICE(0x0461, 0x0300) }, 0 }, /* G2-200 */
166  {{ USB_DEVICE(0x0461, 0x0301) }, 0 }, /* G2E-300 */
167  {{ USB_DEVICE(0x0461, 0x0302) }, 0 }, /* G2-300 */
168  {{ USB_DEVICE(0x0461, 0x0303) }, 0 }, /* G2E-300 */
169  {{ USB_DEVICE(0x0461, 0x0340) }, 0 }, /* Colorado USB 9600 */
170  {{ USB_DEVICE(0x0461, 0x0341) }, 0 }, /* Colorado 600u */
171  {{ USB_DEVICE(0x0461, 0x0345) }, 0 }, /* Visioneer 6200 */
172  {{ USB_DEVICE(0x0461, 0x0360) }, 0 }, /* Colorado USB 19200 */
173  {{ USB_DEVICE(0x0461, 0x0361) }, 0 }, /* Colorado 1200u */
174  {{ USB_DEVICE(0x0461, 0x0380) }, 0 }, /* G2-600 */
175  {{ USB_DEVICE(0x0461, 0x0381) }, 0 }, /* ReadyScan 636i */
176  {{ USB_DEVICE(0x0461, 0x0382) }, 0 }, /* G2-600 */
177  {{ USB_DEVICE(0x0461, 0x0383) }, 0 }, /* G2E-600 */
178   /* Epson */
179  {{ USB_DEVICE(0x04b8, 0x0101) }, 0 }, /* Perfection 636U/636Photo */
180  {{ USB_DEVICE(0x04b8, 0x0103) }, 0 }, /* Perfection 610 */
181  {{ USB_DEVICE(0x04b8, 0x0104) }, 0 }, /* Perfection 1200U/1200Photo */
182  {{ USB_DEVICE(0x04b8, 0x010b) }, 0 }, /* Perfection 1240U/1240Photo */
183  {{ USB_DEVICE(0x04b8, 0x010f) }, 0 }, /* Perfection 1250U/1250Photo */
184  {{ USB_DEVICE(0x04b8, 0x0107) }, 0 }, /* Expression 1600 */
185  {{ USB_DEVICE(0x04b8, 0x010a) }, 0 }, /* Perfection 1640SU */
186  {{ USB_DEVICE(0x04b8, 0x010c) }, 0 }, /* Perfection 640U */
187  {{ USB_DEVICE(0x04b8, 0x0110) }, 0 }, /* Perfection 1650 */
188  {{ USB_DEVICE(0x04b8, 0x011e) }, 0 }, /* Perfection 1660 */
189  {{ USB_DEVICE(0x04b8, 0x011d) }, 0 }, /* Perfection 1260 */
190  {{ USB_DEVICE(0x04b8, 0x011f) }, 0 }, /* Perfection 1670 */
191  {{ USB_DEVICE(0x04b8, 0x0120) }, 0 }, /* Perfection 1270 */
192  {{ USB_DEVICE(0x04b8, 0x080f) }, 0 }, /* Stylus Photo RX425 */
193  {{ USB_DEVICE(0x04b8, 0x011c) }, USC_KEEP_OPEN }, /* Perfection 3200 */
194  {{ USB_DEVICE(0x04b8, 0x0112) }, USC_KEEP_OPEN }, /* GT-9700F */
195  {{ USB_DEVICE(0x04b8, 0x011b) }, 0 }, /* GT-9300UF */
196  {{ USB_DEVICE(0x04b8, 0x0121) }, 0 }, /* Perfection 2480 */
197  {{ USB_DEVICE(0x04b8, 0x080e) }, USC_KEEP_OPEN }, /* CX-3500/3600/3650 MFP */
198  {{ USB_DEVICE(0x04b8, 0x0122) }, 0 }, /* Perfection 3590 */
199  {{ USB_DEVICE(0x04b8, 0x0820) }, 0 }, /* CX4200 MP */
200  {{ USB_DEVICE(0x04b8, 0x012a) }, 0 }, /* Perfection 4990 Photo */
201  {{ USB_DEVICE(0x04b8, 0x082b) }, 0 }, /* DX-50x0 MFP */
202  {{ USB_DEVICE(0x04b8, 0x082e) }, 0 }, /* DX-60x0 MFP */
203   /* UMAX */
204  {{ USB_DEVICE(0x1606, 0x0010) }, 0 }, /* Astra 1220U */
205  {{ USB_DEVICE(0x1606, 0x0002) }, 0 }, /* Astra 1236U */
206  {{ USB_DEVICE(0x1606, 0x0030) }, 0 }, /* Astra 2000U */
207  {{ USB_DEVICE(0x1606, 0x0130) }, 0 }, /* Astra 2100U */
208  {{ USB_DEVICE(0x1606, 0x0230) }, 0 }, /* Astra 2200U */
209  {{ USB_DEVICE(0x1606, 0x0060) }, 0 }, /* Astra 3400 */
210   /* Visioneer */
211  {{ USB_DEVICE(0x04a7, 0x0224) }, 0 }, /* Scanport 3000 */
212  {{ USB_DEVICE(0x04a7, 0x0221) }, 0 }, /* OneTouch 5300 */
213  {{ USB_DEVICE(0x04a7, 0x0211) }, 0 }, /* OneTouch 7600 */
214  {{ USB_DEVICE(0x04a7, 0x0231) }, 0 }, /* OneTouch 6100 */
215  {{ USB_DEVICE(0x04a7, 0x0311) }, 0 }, /* OneTouch 6200 */
216  {{ USB_DEVICE(0x04a7, 0x0321) }, 0 }, /* OneTouch 8100 */
217  {{ USB_DEVICE(0x04a7, 0x0331) }, 0 }, /* OneTouch 8600 */
218   /* Ultima */
219  {{ USB_DEVICE(0x05d8, 0x4002) }, 0 }, /* 1200 UB Plus */
220 };
221 #define uscanner_lookup(v, p) ((const struct uscan_info *)usb_lookup(uscanner_devs, v, p))
222
223 #define USCANNER_BUFFERSIZE     1024
224
225 struct uscanner_softc {
226         device_t                sc_dev;         /* base device */
227         usbd_device_handle      sc_udev;
228         usbd_interface_handle   sc_iface;
229
230         u_int                   sc_dev_flags;
231
232         usbd_pipe_handle        sc_bulkin_pipe;
233         int                     sc_bulkin;
234         usbd_xfer_handle        sc_bulkin_xfer;
235         void                    *sc_bulkin_buffer;
236         int                     sc_bulkin_bufferlen;
237         int                     sc_bulkin_datalen;
238
239         usbd_pipe_handle        sc_bulkout_pipe;
240         int                     sc_bulkout;
241         usbd_xfer_handle        sc_bulkout_xfer;
242         void                    *sc_bulkout_buffer;
243         int                     sc_bulkout_bufferlen;
244         int                     sc_bulkout_datalen;
245
246         u_char                  sc_state;
247 #define USCANNER_OPEN           0x01    /* opened */
248
249         int                     sc_refcnt;
250         u_char                  sc_dying;
251 };
252
253 d_open_t  uscanneropen;
254 d_close_t uscannerclose;
255 d_read_t  uscannerread;
256 d_write_t uscannerwrite;
257 d_poll_t  uscannerpoll;
258
259 #define USCANNER_CDEV_MAJOR     156
260
261 static struct dev_ops uscanner_ops = {
262         { "uscanner", USCANNER_CDEV_MAJOR, 0 },
263         .d_open =       uscanneropen,
264         .d_close =      uscannerclose,
265         .d_read =       uscannerread,
266         .d_write =      uscannerwrite,
267         .d_poll =       uscannerpoll,
268 };
269
270 static int uscanner_do_read(struct uscanner_softc *, struct uio *, int);
271 static int uscanner_do_write(struct uscanner_softc *, struct uio *, int);
272 static void uscanner_do_close(struct uscanner_softc *);
273
274 #define USCANNERUNIT(n) (minor(n))
275
276 static device_probe_t uscanner_match;
277 static device_attach_t uscanner_attach;
278 static device_detach_t uscanner_detach;
279
280 static devclass_t uscanner_devclass;
281
282 static kobj_method_t uscanner_methods[] = {
283         DEVMETHOD(device_probe, uscanner_match),
284         DEVMETHOD(device_attach, uscanner_attach),
285         DEVMETHOD(device_detach, uscanner_detach),
286         {0,0}
287 };
288
289 static driver_t uscanner_driver = {
290         "uscanner",
291         uscanner_methods,
292         sizeof(struct uscanner_softc)
293 };
294
295 MODULE_DEPEND(uscanner, usb, 1, 1, 1);
296
297 static int
298 uscanner_match(device_t self)
299 {
300         struct usb_attach_arg *uaa = device_get_ivars(self);
301
302         if (uaa->iface != NULL)
303                 return UMATCH_NONE;
304
305         return (uscanner_lookup(uaa->vendor, uaa->product) != NULL ?
306                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
307 }
308
309 static int
310 uscanner_attach(device_t self)
311 {
312         struct uscanner_softc *sc = device_get_softc(self);
313         struct usb_attach_arg *uaa = device_get_ivars(self);
314         usb_interface_descriptor_t *id = 0;
315         usb_endpoint_descriptor_t *ed, *ed_bulkin = NULL, *ed_bulkout = NULL;
316         int i;
317         usbd_status err;
318
319         sc->sc_dev = self;
320
321         sc->sc_dev_flags = uscanner_lookup(uaa->vendor, uaa->product)->flags;
322
323         sc->sc_udev = uaa->device;
324
325         err = usbd_set_config_no(uaa->device, 1, 1); /* XXX */
326         if (err) {
327                 kprintf("%s: setting config no failed\n",
328                     device_get_nameunit(sc->sc_dev));
329                 return ENXIO;
330         }
331
332         /* XXX We only check the first interface */
333         err = usbd_device2interface_handle(sc->sc_udev, 0, &sc->sc_iface);
334         if (!err && sc->sc_iface)
335             id = usbd_get_interface_descriptor(sc->sc_iface);
336         if (err || id == 0) {
337                 kprintf("%s: could not get interface descriptor, err=%d,id=%p\n",
338                        device_get_nameunit(sc->sc_dev), err, id);
339                 return ENXIO;
340         }
341
342         /* Find the two first bulk endpoints */
343         for (i = 0 ; i < id->bNumEndpoints; i++) {
344                 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
345                 if (ed == 0) {
346                         kprintf("%s: could not read endpoint descriptor\n",
347                                device_get_nameunit(sc->sc_dev));
348                         return ENXIO;
349                 }
350
351                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
352                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
353                         ed_bulkin = ed;
354                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
355                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
356                         ed_bulkout = ed;
357                 }
358
359                 if (ed_bulkin && ed_bulkout)    /* found all we need */
360                         break;
361         }
362
363         /* Verify that we goething sensible */
364         if (ed_bulkin == NULL || ed_bulkout == NULL) {
365                 kprintf("%s: bulk-in and/or bulk-out endpoint not found\n",
366                         device_get_nameunit(sc->sc_dev));
367                 return ENXIO;
368         }
369
370         sc->sc_bulkin = ed_bulkin->bEndpointAddress;
371         sc->sc_bulkout = ed_bulkout->bEndpointAddress;
372
373         /* the main device, ctrl endpoint */
374         make_dev(&uscanner_ops, device_get_unit(sc->sc_dev),
375                  UID_ROOT, GID_OPERATOR, 0644,
376                  "%s", device_get_nameunit(sc->sc_dev));
377
378         usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
379                            sc->sc_dev);
380
381         return 0;
382 }
383
384 int
385 uscanneropen(struct dev_open_args *ap)
386 {
387         cdev_t dev = ap->a_head.a_dev;
388         struct uscanner_softc *sc;
389         int unit = USCANNERUNIT(dev);
390         usbd_status err;
391
392         sc = devclass_get_softc(uscanner_devclass, unit);
393         if (sc == NULL)
394                 return (ENXIO);
395
396         DPRINTFN(5, ("uscanneropen: flag=%d, mode=%d, unit=%d\n",
397                      ap->a_oflags, ap->a_devtype, unit));
398
399         if (sc->sc_dying)
400                 return (ENXIO);
401
402         if (sc->sc_state & USCANNER_OPEN)
403                 return (EBUSY);
404
405         sc->sc_state |= USCANNER_OPEN;
406
407         sc->sc_bulkin_buffer = kmalloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
408         sc->sc_bulkout_buffer = kmalloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
409         /* No need to check buffers for NULL since we have WAITOK */
410
411         sc->sc_bulkin_bufferlen = USCANNER_BUFFERSIZE;
412         sc->sc_bulkout_bufferlen = USCANNER_BUFFERSIZE;
413
414         /* We have decided on which endpoints to use, now open the pipes */
415         if (sc->sc_bulkin_pipe == NULL) {
416                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin,
417                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkin_pipe);
418                 if (err) {
419                         kprintf("%s: cannot open bulk-in pipe (addr %d)\n",
420                                device_get_nameunit(sc->sc_dev), sc->sc_bulkin);
421                         uscanner_do_close(sc);
422                         return (EIO);
423                 }
424         }
425         if (sc->sc_bulkout_pipe == NULL) {
426                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout,
427                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
428                 if (err) {
429                         kprintf("%s: cannot open bulk-out pipe (addr %d)\n",
430                                device_get_nameunit(sc->sc_dev), sc->sc_bulkout);
431                         uscanner_do_close(sc);
432                         return (EIO);
433                 }
434         }
435
436         sc->sc_bulkin_xfer = usbd_alloc_xfer(sc->sc_udev);
437         if (sc->sc_bulkin_xfer == NULL) {
438                 uscanner_do_close(sc);
439                 return (ENOMEM);
440         }
441         sc->sc_bulkout_xfer = usbd_alloc_xfer(sc->sc_udev);
442         if (sc->sc_bulkout_xfer == NULL) {
443                 uscanner_do_close(sc);
444                 return (ENOMEM);
445         }
446
447         return (0);     /* success */
448 }
449
450 int
451 uscannerclose(struct dev_close_args *ap)
452 {
453         cdev_t dev = ap->a_head.a_dev;
454         struct uscanner_softc *sc;
455
456         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
457
458         DPRINTFN(5, ("uscannerclose: flag=%d, mode=%d, unit=%d\n",
459                      ap->a_fflag, ap->a_devtype, USCANNERUNIT(dev)));
460
461 #ifdef DIAGNOSTIC
462         if (!(sc->sc_state & USCANNER_OPEN)) {
463                 kprintf("uscannerclose: not open\n");
464                 return (EINVAL);
465         }
466 #endif
467
468         uscanner_do_close(sc);
469
470         return (0);
471 }
472
473 void
474 uscanner_do_close(struct uscanner_softc *sc)
475 {
476         if (sc->sc_bulkin_xfer) {
477                 usbd_free_xfer(sc->sc_bulkin_xfer);
478                 sc->sc_bulkin_xfer = NULL;
479         }
480         if (sc->sc_bulkout_xfer) {
481                 usbd_free_xfer(sc->sc_bulkout_xfer);
482                 sc->sc_bulkout_xfer = NULL;
483         }
484
485         if (!(sc->sc_dev_flags & USC_KEEP_OPEN)) {
486                 if (sc->sc_bulkin_pipe != NULL) {
487                         usbd_abort_pipe(sc->sc_bulkin_pipe);
488                         usbd_close_pipe(sc->sc_bulkin_pipe);
489                         sc->sc_bulkin_pipe = NULL;
490                 }
491                 if (sc->sc_bulkout_pipe != NULL) {
492                         usbd_abort_pipe(sc->sc_bulkout_pipe);
493                         usbd_close_pipe(sc->sc_bulkout_pipe);
494                         sc->sc_bulkout_pipe = NULL;
495                 }
496         }
497
498         if (sc->sc_bulkin_buffer) {
499                 kfree(sc->sc_bulkin_buffer, M_USBDEV);
500                 sc->sc_bulkin_buffer = NULL;
501         }
502         if (sc->sc_bulkout_buffer) {
503                 kfree(sc->sc_bulkout_buffer, M_USBDEV);
504                 sc->sc_bulkout_buffer = NULL;
505         }
506
507         sc->sc_state &= ~USCANNER_OPEN;
508 }
509
510 static int
511 uscanner_do_read(struct uscanner_softc *sc, struct uio *uio, int flag)
512 {
513         u_int32_t n, tn;
514         usbd_status err;
515         int error = 0;
516
517         DPRINTFN(5, ("%s: uscannerread\n", device_get_nameunit(sc->sc_dev)));
518
519         if (sc->sc_dying)
520                 return (EIO);
521
522         while ((n = min(sc->sc_bulkin_bufferlen, uio->uio_resid)) != 0) {
523                 DPRINTFN(1, ("uscannerread: start transfer %d bytes\n",n));
524                 tn = n;
525
526                 err = usbd_bulk_transfer(
527                         sc->sc_bulkin_xfer, sc->sc_bulkin_pipe,
528                         USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
529                         sc->sc_bulkin_buffer, &tn,
530                         "uscnrb");
531                 if (err) {
532                         if (err == USBD_INTERRUPTED)
533                                 error = EINTR;
534                         else if (err == USBD_TIMEOUT)
535                                 error = ETIMEDOUT;
536                         else
537                                 error = EIO;
538                         break;
539                 }
540                 DPRINTFN(1, ("uscannerread: got %d bytes\n", tn));
541                 error = uiomove(sc->sc_bulkin_buffer, tn, uio);
542                 if (error || tn < n)
543                         break;
544         }
545
546         return (error);
547 }
548
549 int
550 uscannerread(struct dev_read_args *ap)
551 {
552         cdev_t dev = ap->a_head.a_dev;
553         struct uscanner_softc *sc;
554         int error;
555
556         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
557
558         sc->sc_refcnt++;
559         error = uscanner_do_read(sc, ap->a_uio, ap->a_ioflag);
560         if (--sc->sc_refcnt < 0)
561                 usb_detach_wakeup(sc->sc_dev);
562
563         return (error);
564 }
565
566 static int
567 uscanner_do_write(struct uscanner_softc *sc, struct uio *uio, int flag)
568 {
569         u_int32_t n;
570         int error = 0;
571         usbd_status err;
572
573         DPRINTFN(5, ("%s: uscanner_do_write\n", device_get_nameunit(sc->sc_dev)));
574
575         if (sc->sc_dying)
576                 return (EIO);
577
578         while ((n = min(sc->sc_bulkout_bufferlen, uio->uio_resid)) != 0) {
579                 error = uiomove(sc->sc_bulkout_buffer, n, uio);
580                 if (error)
581                         break;
582                 DPRINTFN(1, ("uscanner_do_write: transfer %d bytes\n", n));
583                 err = usbd_bulk_transfer(
584                         sc->sc_bulkout_xfer, sc->sc_bulkout_pipe,
585                         0, USBD_NO_TIMEOUT,
586                         sc->sc_bulkout_buffer, &n,
587                         "uscnwb");
588                 if (err) {
589                         if (err == USBD_INTERRUPTED)
590                                 error = EINTR;
591                         else
592                                 error = EIO;
593                         break;
594                 }
595         }
596
597         return (error);
598 }
599
600 int
601 uscannerwrite(struct dev_write_args *ap)
602 {
603         cdev_t dev = ap->a_head.a_dev;
604         struct uscanner_softc *sc;
605         int error;
606
607         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
608
609         sc->sc_refcnt++;
610         error = uscanner_do_write(sc, ap->a_uio, ap->a_ioflag);
611         if (--sc->sc_refcnt < 0)
612                 usb_detach_wakeup(sc->sc_dev);
613         return (error);
614 }
615
616 static int
617 uscanner_detach(device_t self)
618 {
619         struct uscanner_softc *sc = device_get_softc(self);
620
621         DPRINTF(("uscanner_detach: sc=%p\n", sc));
622
623         sc->sc_dying = 1;
624         sc->sc_dev_flags = 0;   /* make close really close device */
625
626         /* Abort all pipes.  Causes processes waiting for transfer to wake. */
627         if (sc->sc_bulkin_pipe != NULL)
628                 usbd_abort_pipe(sc->sc_bulkin_pipe);
629         if (sc->sc_bulkout_pipe != NULL)
630                 usbd_abort_pipe(sc->sc_bulkout_pipe);
631
632         crit_enter();
633         if (--sc->sc_refcnt >= 0) {
634                 /* Wait for processes to go away. */
635                 usb_detach_wait(sc->sc_dev);
636         }
637         crit_exit();
638
639         /* destroy the device for the control endpoint */
640         dev_ops_remove_minor(&uscanner_ops, /*-1, */device_get_unit(sc->sc_dev));
641
642         usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
643                            sc->sc_dev);
644
645         return (0);
646 }
647
648 int
649 uscannerpoll(struct dev_poll_args *ap)
650 {
651         cdev_t dev = ap->a_head.a_dev;
652         struct uscanner_softc *sc;
653         int revents = 0;
654
655         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
656
657         if (sc->sc_dying)
658                 return (EIO);
659
660         /*
661          * We have no easy way of determining if a read will
662          * yield any data or a write will happen.
663          * Pretend they will.
664          */
665         revents |= ap->a_events &
666                    (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
667
668         ap->a_events = revents;
669         return (0);
670 }
671
672 DRIVER_MODULE(uscanner, uhub, uscanner_driver, uscanner_devclass, usbd_driver_load, 0);
673