c793d2950b8ba8008861de560ef12f2e572cc5db
[dragonfly.git] / sys / dev / usbmisc / uscanner / uscanner.c
1 /*      $NetBSD: uscanner.c,v 1.26 2001/12/31 12:15:22 augustss Exp $   */
2 /*      $FreeBSD: src/sys/dev/usb/uscanner.c,v 1.2.2.12 2003/01/27 09:48:57 joe Exp $   */
3 /*      $DragonFly: src/sys/dev/usbmisc/uscanner/uscanner.c,v 1.4 2003/08/07 21:17:15 dillon Exp $      */
4
5 /*
6  * Copyright (c) 2000 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Lennart Augustsson (lennart@augustsson.net) at
11  * Carlstedt Research & Technology
12  * and Nick Hibma (n_hibma@qubesoft.com).
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. All advertising materials mentioning features or use of this software
23  *    must display the following acknowledgement:
24  *        This product includes software developed by the NetBSD
25  *        Foundation, Inc. and its contributors.
26  * 4. Neither the name of The NetBSD Foundation nor the names of its
27  *    contributors may be used to endorse or promote products derived
28  *    from this software without specific prior written permission.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
31  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
32  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
33  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
34  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
38  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40  * POSSIBILITY OF SUCH DAMAGE.
41  */
42
43
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
48 #if defined(__NetBSD__) || defined(__OpenBSD__)
49 #include <sys/device.h>
50 #elif defined(__FreeBSD__)
51 #include <sys/module.h>
52 #include <sys/bus.h>
53 #include <sys/conf.h>
54 #include <sys/fcntl.h>
55 #include <sys/filio.h>
56 #endif
57 #include <sys/tty.h>
58 #include <sys/file.h>
59 #include <sys/select.h>
60 #include <sys/proc.h>
61 #include <sys/vnode.h>
62 #include <sys/poll.h>
63 #include <sys/conf.h>
64 #include <sys/sysctl.h>
65
66 #include <bus/usb/usb.h>
67 #include <bus/usb/usbdi.h>
68 #include <bus/usb/usbdi_util.h>
69
70 #include <bus/usb/usbdevs.h>
71
72 #ifdef USB_DEBUG
73 #define DPRINTF(x)      if (uscannerdebug) logprintf x
74 #define DPRINTFN(n,x)   if (uscannerdebug>(n)) logprintf 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_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_320U }, 0 },
94  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_640U }, 0 },
95  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_620U }, 0 },
96  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_C310U }, 0 },
97
98   /* AGFA */
99  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1236U }, 0 },
100  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U }, 0 },
101  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U2 }, 0 },
102  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANTOUCH }, 0 },
103  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE40 }, 0 },
104  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE50 }, 0 },
105  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE20 }, 0 },
106  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE25 }, 0 },
107  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE26 }, 0 },
108  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE52 }, 0 },
109
110   /* Avision */
111  {{ USB_VENDOR_AVISION, USB_PRODUCT_AVISION_1200U }, 0 },
112
113   /* Canon */
114  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N656U }, 0 },
115
116   /* Kye */
117  {{ USB_VENDOR_KYE, USB_PRODUCT_KYE_VIVIDPRO }, 0 },
118
119   /* HP */
120  {{ USB_VENDOR_HP, USB_PRODUCT_HP_2200C }, 0 },
121  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3300C }, 0 },
122  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3400CSE }, 0 },
123  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4100C }, 0 },
124  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4200C }, 0 },
125  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4300C }, 0 },
126  {{ USB_VENDOR_HP, USB_PRODUCT_HP_S20 }, 0 },
127  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5200C }, 0 },
128  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5300C }, 0 },
129  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5400C }, 0 },
130  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6200C }, 0 },
131  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6300C }, 0 },
132
133   /* Microtek */
134  {{ USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_336CX }, 0 },
135  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_X6U }, 0 },
136  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX }, 0 },
137  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX2 }, 0 },
138  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_C6 }, 0 },
139  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL }, 0 },
140  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL2 }, 0 },
141  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6UL }, 0 },
142
143   /* Mustek */
144  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CU }, 0 },
145  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_BEARPAW1200F }, 0 },
146  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600USB }, 0 },
147  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600CU }, 0 },
148  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USB }, 0 },
149  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200UB }, 0 },
150  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USBPLUS }, 0 },
151  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CUPLUS }, 0 },
152
153   /* National */
154  {{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW1200 }, 0 },
155  {{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW2400 }, 0 },
156
157   /* Primax */
158  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2X300 }, 0 },
159  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E300 }, 0 },
160  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2300 }, 0 },
161  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E3002 }, 0 },
162  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_9600 }, 0 },
163  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_600U }, 0 },
164  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_6200 }, 0 },
165  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_19200 }, 0 },
166  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_1200U }, 0 },
167  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G600 }, 0 },
168  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_636I }, 0 },
169  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2600 }, 0 },
170  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E600 }, 0 },
171
172   /* Epson */
173  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_636 }, 0 },
174  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_610 }, 0 },
175  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1200 }, 0 },
176  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1240 }, 0 },
177  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1600 }, 0 },
178  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1640 }, 0 },
179  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_640U }, 0 },
180  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1650 }, 0 },
181  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1660 }, 0 },
182  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1260 }, 0 },
183  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9700F }, USC_KEEP_OPEN },
184
185   /* UMAX */
186  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1220U }, 0 },
187  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1236U }, 0 },
188  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2000U }, 0 },
189  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2200U }, 0 },
190  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA3400 }, 0 },
191
192   /* Visioneer */
193  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_3000 }, 0 },
194  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_5300 }, 0 },
195  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_7600 }, 0 },
196  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6100 }, 0 },
197  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6200 }, 0 },
198  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8100 }, 0 },
199  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8600 }, 0 },
200
201   /* Ultima */
202  {{ USB_VENDOR_ULTIMA, USB_PRODUCT_ULTIMA_1200UBPLUS }, 0 },
203
204 };
205 #define uscanner_lookup(v, p) ((const struct uscan_info *)usb_lookup(uscanner_devs, v, p))
206
207 #define USCANNER_BUFFERSIZE     1024
208
209 struct uscanner_softc {
210         USBBASEDEVICE           sc_dev;         /* base device */
211         usbd_device_handle      sc_udev;
212         usbd_interface_handle   sc_iface;
213
214         u_int                   sc_dev_flags;
215
216         usbd_pipe_handle        sc_bulkin_pipe;
217         int                     sc_bulkin;
218         usbd_xfer_handle        sc_bulkin_xfer;
219         void                    *sc_bulkin_buffer;
220         int                     sc_bulkin_bufferlen;
221         int                     sc_bulkin_datalen;
222
223         usbd_pipe_handle        sc_bulkout_pipe;
224         int                     sc_bulkout;
225         usbd_xfer_handle        sc_bulkout_xfer;
226         void                    *sc_bulkout_buffer;
227         int                     sc_bulkout_bufferlen;
228         int                     sc_bulkout_datalen;
229
230         u_char                  sc_state;
231 #define USCANNER_OPEN           0x01    /* opened */
232
233         int                     sc_refcnt;
234         u_char                  sc_dying;
235 };
236
237 #if defined(__NetBSD__) || defined(__OpenBSD__)
238 cdev_decl(uscanner);
239 #elif defined(__FreeBSD__)
240 d_open_t  uscanneropen;
241 d_close_t uscannerclose;
242 d_read_t  uscannerread;
243 d_write_t uscannerwrite;
244 d_ioctl_t uscannerioctl;
245 d_poll_t  uscannerpoll;
246
247 #define USCANNER_CDEV_MAJOR     156
248
249 Static struct cdevsw uscanner_cdevsw = {
250         /* name */      "uscanner",
251         /* maj */       USCANNER_CDEV_MAJOR,
252         /* flags */     0,
253         /* port */      NULL,
254         /* autoq */     0,
255
256         /* open */      uscanneropen,
257         /* close */     uscannerclose,
258         /* read */      uscannerread,
259         /* write */     uscannerwrite,
260         /* ioctl */     uscannerioctl,
261         /* poll */      uscannerpoll,
262         /* mmap */      nommap,
263         /* strategy */  nostrategy,
264         /* dump */      nodump,
265         /* psize */     nopsize
266 };
267 #endif
268
269 Static int uscanner_do_read(struct uscanner_softc *, struct uio *, int);
270 Static int uscanner_do_write(struct uscanner_softc *, struct uio *, int);
271 Static void uscanner_do_close(struct uscanner_softc *);
272
273 #define USCANNERUNIT(n) (minor(n))
274
275 USB_DECLARE_DRIVER(uscanner);
276
277 USB_MATCH(uscanner)
278 {
279         USB_MATCH_START(uscanner, uaa);
280
281         if (uaa->iface != NULL)
282                 return UMATCH_NONE;
283
284         return (uscanner_lookup(uaa->vendor, uaa->product) != NULL ?
285                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
286 }
287
288 USB_ATTACH(uscanner)
289 {
290         USB_ATTACH_START(uscanner, sc, uaa);
291         usb_interface_descriptor_t *id = 0;
292         usb_endpoint_descriptor_t *ed, *ed_bulkin = NULL, *ed_bulkout = NULL;
293         char devinfo[1024];
294         int i;
295         usbd_status err;
296
297         usbd_devinfo(uaa->device, 0, devinfo);
298         USB_ATTACH_SETUP;
299         printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
300
301         sc->sc_dev_flags = uscanner_lookup(uaa->vendor, uaa->product)->flags;
302
303         sc->sc_udev = uaa->device;
304
305         err = usbd_set_config_no(uaa->device, 1, 1); /* XXX */
306         if (err) {
307                 printf("%s: setting config no failed\n",
308                     USBDEVNAME(sc->sc_dev));
309                 USB_ATTACH_ERROR_RETURN;
310         }
311
312         /* XXX We only check the first interface */
313         err = usbd_device2interface_handle(sc->sc_udev, 0, &sc->sc_iface);
314         if (!err && sc->sc_iface)
315             id = usbd_get_interface_descriptor(sc->sc_iface);
316         if (err || id == 0) {
317                 printf("%s: could not get interface descriptor, err=%d,id=%p\n",
318                        USBDEVNAME(sc->sc_dev), err, id);
319                 USB_ATTACH_ERROR_RETURN;
320         }
321
322         /* Find the two first bulk endpoints */
323         for (i = 0 ; i < id->bNumEndpoints; i++) {
324                 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
325                 if (ed == 0) {
326                         printf("%s: could not read endpoint descriptor\n",
327                                USBDEVNAME(sc->sc_dev));
328                         USB_ATTACH_ERROR_RETURN;
329                 }
330
331                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
332                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
333                         ed_bulkin = ed;
334                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
335                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
336                         ed_bulkout = ed;
337                 }
338
339                 if (ed_bulkin && ed_bulkout)    /* found all we need */
340                         break;
341         }
342
343         /* Verify that we goething sensible */
344         if (ed_bulkin == NULL || ed_bulkout == NULL) {
345                 printf("%s: bulk-in and/or bulk-out endpoint not found\n",
346                         USBDEVNAME(sc->sc_dev));
347                 USB_ATTACH_ERROR_RETURN;
348         }
349
350         sc->sc_bulkin = ed_bulkin->bEndpointAddress;
351         sc->sc_bulkout = ed_bulkout->bEndpointAddress;
352
353 #ifdef __FreeBSD__
354         /* the main device, ctrl endpoint */
355         make_dev(&uscanner_cdevsw, USBDEVUNIT(sc->sc_dev),
356                 UID_ROOT, GID_OPERATOR, 0644, "%s", USBDEVNAME(sc->sc_dev));
357 #endif
358
359         USB_ATTACH_SUCCESS_RETURN;
360 }
361
362 int
363 uscanneropen(dev_t dev, int flag, int mode, usb_proc_ptr p)
364 {
365         struct uscanner_softc *sc;
366         int unit = USCANNERUNIT(dev);
367         usbd_status err;
368
369         USB_GET_SC_OPEN(uscanner, unit, sc);
370
371         DPRINTFN(5, ("uscanneropen: flag=%d, mode=%d, unit=%d\n", 
372                      flag, mode, unit));
373
374         if (sc->sc_dying)
375                 return (ENXIO);
376
377         if (sc->sc_state & USCANNER_OPEN)
378                 return (EBUSY);
379
380         sc->sc_state |= USCANNER_OPEN;
381
382         sc->sc_bulkin_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
383         sc->sc_bulkout_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
384         /* No need to check buffers for NULL since we have WAITOK */
385
386         sc->sc_bulkin_bufferlen = USCANNER_BUFFERSIZE;
387         sc->sc_bulkout_bufferlen = USCANNER_BUFFERSIZE;
388
389         /* We have decided on which endpoints to use, now open the pipes */
390         if (sc->sc_bulkin_pipe == NULL) {
391                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin,
392                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkin_pipe);
393                 if (err) {
394                         printf("%s: cannot open bulk-in pipe (addr %d)\n",
395                                USBDEVNAME(sc->sc_dev), sc->sc_bulkin);
396                         uscanner_do_close(sc);
397                         return (EIO);
398                 }
399         }
400         if (sc->sc_bulkout_pipe == NULL) {
401                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout,
402                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
403                 if (err) {
404                         printf("%s: cannot open bulk-out pipe (addr %d)\n",
405                                USBDEVNAME(sc->sc_dev), sc->sc_bulkout);
406                         uscanner_do_close(sc);
407                         return (EIO);
408                 }
409         }
410
411         sc->sc_bulkin_xfer = usbd_alloc_xfer(sc->sc_udev);
412         if (sc->sc_bulkin_xfer == NULL) {
413                 uscanner_do_close(sc);
414                 return (ENOMEM);
415         }
416         sc->sc_bulkout_xfer = usbd_alloc_xfer(sc->sc_udev);
417         if (sc->sc_bulkout_xfer == NULL) {
418                 uscanner_do_close(sc);
419                 return (ENOMEM);
420         }
421
422         return (0);     /* success */
423 }
424
425 int
426 uscannerclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
427 {
428         struct uscanner_softc *sc;
429
430         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
431
432         DPRINTFN(5, ("uscannerclose: flag=%d, mode=%d, unit=%d\n",
433                      flag, mode, USCANNERUNIT(dev)));
434
435 #ifdef DIAGNOSTIC
436         if (!(sc->sc_state & USCANNER_OPEN)) {
437                 printf("uscannerclose: not open\n");
438                 return (EINVAL);
439         }
440 #endif
441
442         uscanner_do_close(sc);
443
444         return (0);
445 }
446
447 void
448 uscanner_do_close(struct uscanner_softc *sc)
449 {
450         if (sc->sc_bulkin_xfer) {
451                 usbd_free_xfer(sc->sc_bulkin_xfer);
452                 sc->sc_bulkin_xfer = NULL;
453         }
454         if (sc->sc_bulkout_xfer) {
455                 usbd_free_xfer(sc->sc_bulkout_xfer);
456                 sc->sc_bulkout_xfer = NULL;
457         }
458
459         if (!(sc->sc_dev_flags & USC_KEEP_OPEN)) {
460                 if (sc->sc_bulkin_pipe != NULL) {
461                         usbd_abort_pipe(sc->sc_bulkin_pipe);
462                         usbd_close_pipe(sc->sc_bulkin_pipe);
463                         sc->sc_bulkin_pipe = NULL;
464                 }
465                 if (sc->sc_bulkout_pipe != NULL) {
466                         usbd_abort_pipe(sc->sc_bulkout_pipe);
467                         usbd_close_pipe(sc->sc_bulkout_pipe);
468                         sc->sc_bulkout_pipe = NULL;
469                 }
470         }
471
472         if (sc->sc_bulkin_buffer) {
473                 free(sc->sc_bulkin_buffer, M_USBDEV);
474                 sc->sc_bulkin_buffer = NULL;
475         }
476         if (sc->sc_bulkout_buffer) {
477                 free(sc->sc_bulkout_buffer, M_USBDEV);
478                 sc->sc_bulkout_buffer = NULL;
479         }
480
481         sc->sc_state &= ~USCANNER_OPEN;
482 }
483
484 Static int
485 uscanner_do_read(struct uscanner_softc *sc, struct uio *uio, int flag)
486 {
487         u_int32_t n, tn;
488         usbd_status err;
489         int error = 0;
490
491         DPRINTFN(5, ("%s: uscannerread\n", USBDEVNAME(sc->sc_dev)));
492
493         if (sc->sc_dying)
494                 return (EIO);
495
496         while ((n = min(sc->sc_bulkin_bufferlen, uio->uio_resid)) != 0) {
497                 DPRINTFN(1, ("uscannerread: start transfer %d bytes\n",n));
498                 tn = n;
499
500                 err = usbd_bulk_transfer(
501                         sc->sc_bulkin_xfer, sc->sc_bulkin_pipe,
502                         USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
503                         sc->sc_bulkin_buffer, &tn,
504                         "uscnrb");
505                 if (err) {
506                         if (err == USBD_INTERRUPTED)
507                                 error = EINTR;
508                         else if (err == USBD_TIMEOUT)
509                                 error = ETIMEDOUT;
510                         else
511                                 error = EIO;
512                         break;
513                 }
514                 DPRINTFN(1, ("uscannerread: got %d bytes\n", tn));
515                 error = uiomove(sc->sc_bulkin_buffer, tn, uio);
516                 if (error || tn < n)
517                         break;
518         }
519
520         return (error);
521 }
522
523 int
524 uscannerread(dev_t dev, struct uio *uio, int flag)
525 {
526         struct uscanner_softc *sc;
527         int error;
528
529         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
530
531         sc->sc_refcnt++;
532         error = uscanner_do_read(sc, uio, flag);
533         if (--sc->sc_refcnt < 0)
534                 usb_detach_wakeup(USBDEV(sc->sc_dev));
535
536         return (error);
537 }
538
539 Static int
540 uscanner_do_write(struct uscanner_softc *sc, struct uio *uio, int flag)
541 {
542         u_int32_t n;
543         int error = 0;
544         usbd_status err;
545
546         DPRINTFN(5, ("%s: uscanner_do_write\n", USBDEVNAME(sc->sc_dev)));
547
548         if (sc->sc_dying)
549                 return (EIO);
550
551         while ((n = min(sc->sc_bulkout_bufferlen, uio->uio_resid)) != 0) {
552                 error = uiomove(sc->sc_bulkout_buffer, n, uio);
553                 if (error)
554                         break;
555                 DPRINTFN(1, ("uscanner_do_write: transfer %d bytes\n", n));
556                 err = usbd_bulk_transfer(
557                         sc->sc_bulkout_xfer, sc->sc_bulkout_pipe,
558                         0, USBD_NO_TIMEOUT,
559                         sc->sc_bulkout_buffer, &n,
560                         "uscnwb");
561                 if (err) {
562                         if (err == USBD_INTERRUPTED)
563                                 error = EINTR;
564                         else
565                                 error = EIO;
566                         break;
567                 }
568         }
569
570         return (error);
571 }
572
573 int
574 uscannerwrite(dev_t dev, struct uio *uio, int flag)
575 {
576         struct uscanner_softc *sc;
577         int error;
578
579         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
580
581         sc->sc_refcnt++;
582         error = uscanner_do_write(sc, uio, flag);
583         if (--sc->sc_refcnt < 0)
584                 usb_detach_wakeup(USBDEV(sc->sc_dev));
585         return (error);
586 }
587
588 #if defined(__NetBSD__) || defined(__OpenBSD__)
589 int
590 uscanner_activate(device_ptr_t self, enum devact act)
591 {
592         struct uscanner_softc *sc = (struct uscanner_softc *)self;
593
594         switch (act) {
595         case DVACT_ACTIVATE:
596                 return (EOPNOTSUPP);
597                 break;
598
599         case DVACT_DEACTIVATE:
600                 sc->sc_dying = 1;
601                 break;
602         }
603         return (0);
604 }
605 #endif
606
607 USB_DETACH(uscanner)
608 {
609         USB_DETACH_START(uscanner, sc);
610         int s;
611 #if defined(__NetBSD__) || defined(__OpenBSD__)
612         int maj, mn;
613 #elif defined(__FreeBSD__)
614         dev_t dev;
615         struct vnode *vp;
616 #endif
617
618 #if defined(__NetBSD__) || defined(__OpenBSD__)
619         DPRINTF(("uscanner_detach: sc=%p flags=%d\n", sc, flags));
620 #elif defined(__FreeBSD__)
621         DPRINTF(("uscanner_detach: sc=%p\n", sc));
622 #endif
623
624         sc->sc_dying = 1;
625         sc->sc_dev_flags = 0;   /* make close really close device */
626
627         /* Abort all pipes.  Causes processes waiting for transfer to wake. */
628         if (sc->sc_bulkin_pipe != NULL)
629                 usbd_abort_pipe(sc->sc_bulkin_pipe);
630         if (sc->sc_bulkout_pipe != NULL)
631                 usbd_abort_pipe(sc->sc_bulkout_pipe);
632
633         s = splusb();
634         if (--sc->sc_refcnt >= 0) {
635                 /* Wait for processes to go away. */
636                 usb_detach_wait(USBDEV(sc->sc_dev));
637         }
638         splx(s);
639
640 #if defined(__NetBSD__) || defined(__OpenBSD__)
641         /* locate the major number */
642         for (maj = 0; maj < nchrdev; maj++)
643                 if (cdevsw[maj].d_open == uscanneropen)
644                         break;
645
646         /* Nuke the vnodes for any open instances (calls close). */
647         mn = self->dv_unit * USB_MAX_ENDPOINTS;
648         vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
649 #elif defined(__FreeBSD__)
650         /* destroy the device for the control endpoint */
651         dev = makedev(USCANNER_CDEV_MAJOR, USBDEVUNIT(sc->sc_dev));
652         vp = SLIST_FIRST(&dev->si_hlist);
653         if (vp)
654                 VOP_REVOKE(vp, REVOKEALL);
655         destroy_dev(dev);
656 #endif
657
658         return (0);
659 }
660
661 int
662 uscannerpoll(dev_t dev, int events, usb_proc_ptr p)
663 {
664         struct uscanner_softc *sc;
665         int revents = 0;
666
667         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
668
669         if (sc->sc_dying)
670                 return (EIO);
671
672         /* 
673          * We have no easy way of determining if a read will
674          * yield any data or a write will happen.
675          * Pretend they will.
676          */
677         revents |= events & 
678                    (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
679
680         return (revents);
681 }
682
683 int
684 uscannerioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
685 {
686         return (EINVAL);
687 }
688
689 #if defined(__FreeBSD__)
690 DRIVER_MODULE(uscanner, uhub, uscanner_driver, uscanner_devclass, usbd_driver_load, 0);
691 #endif