Style(9) cleanup to src/sys/vfs, stage 20/21: umapfs.
[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.8 2004/05/13 23:49:22 dillon 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 #if defined(__NetBSD__) || defined(__OpenBSD__)
55 #include <sys/device.h>
56 #elif defined(__FreeBSD__) || defined(__DragonFly__)
57 #include <sys/module.h>
58 #include <sys/bus.h>
59 #include <sys/conf.h>
60 #include <sys/fcntl.h>
61 #include <sys/filio.h>
62 #endif
63 #include <sys/tty.h>
64 #include <sys/file.h>
65 #if defined(__FreeBSD__) && __FreeBSD_version >= 500014
66 #include <sys/selinfo.h>
67 #else
68 #include <sys/select.h>
69 #endif
70 #include <sys/proc.h>
71 #include <sys/vnode.h>
72 #include <sys/poll.h>
73 #include <sys/conf.h>
74 #include <sys/sysctl.h>
75
76 #include <bus/usb/usb.h>
77 #include <bus/usb/usbdi.h>
78 #include <bus/usb/usbdi_util.h>
79
80 #include <bus/usb/usbdevs.h>
81
82 #ifdef USB_DEBUG
83 #define DPRINTF(x)      if (uscannerdebug) logprintf x
84 #define DPRINTFN(n,x)   if (uscannerdebug>(n)) logprintf x
85 int     uscannerdebug = 0;
86 SYSCTL_NODE(_hw_usb, OID_AUTO, uscanner, CTLFLAG_RW, 0, "USB uscanner");
87 SYSCTL_INT(_hw_usb_uscanner, OID_AUTO, debug, CTLFLAG_RW,
88            &uscannerdebug, 0, "uscanner debug level");
89 #else
90 #define DPRINTF(x)
91 #define DPRINTFN(n,x)
92 #endif
93
94 struct uscan_info {
95         struct usb_devno devno;
96         u_int flags;
97 #define USC_KEEP_OPEN 1
98 };
99
100 /* Table of scanners that may work with this driver. */
101 static const struct uscan_info uscanner_devs[] = {
102   /* Acer Peripherals */
103  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_320U }, 0 },
104  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_640U }, 0 },
105  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_620U }, 0 },
106  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_C310U }, 0 },
107
108   /* AGFA */
109  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1236U }, 0 },
110  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U }, 0 },
111  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U2 }, 0 },
112  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANTOUCH }, 0 },
113  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE40 }, 0 },
114  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE50 }, 0 },
115  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE20 }, 0 },
116  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE25 }, 0 },
117  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE26 }, 0 },
118  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE52 }, 0 },
119
120   /* Avision */
121  {{ USB_VENDOR_AVISION, USB_PRODUCT_AVISION_1200U }, 0 },
122
123   /* Canon */
124  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N656U }, 0 },
125
126   /* Kye */
127  {{ USB_VENDOR_KYE, USB_PRODUCT_KYE_VIVIDPRO }, 0 },
128
129   /* HP */
130  {{ USB_VENDOR_HP, USB_PRODUCT_HP_2200C }, 0 },
131  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3300C }, 0 },
132  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3400CSE }, 0 },
133  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4100C }, 0 },
134  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4200C }, 0 },
135  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4300C }, 0 },
136  {{ USB_VENDOR_HP, USB_PRODUCT_HP_S20 }, 0 },
137  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5200C }, 0 },
138  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5300C }, 0 },
139  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5400C }, 0 },
140  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6200C }, 0 },
141  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6300C }, 0 },
142
143   /* Microtek */
144  {{ USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_336CX }, 0 },
145  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_X6U }, 0 },
146  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX }, 0 },
147  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX2 }, 0 },
148  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_C6 }, 0 },
149  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL }, 0 },
150  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL2 }, 0 },
151  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6UL }, 0 },
152
153   /* Minolta */
154  {{ USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_5400 }, 0 },
155
156   /* Mustek */
157  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CU }, 0 },
158  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_BEARPAW1200F }, 0 },
159  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_BEARPAW1200TA }, 0 },
160  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600USB }, 0 },
161  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600CU }, 0 },
162  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USB }, 0 },
163  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200UB }, 0 },
164  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USBPLUS }, 0 },
165  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CUPLUS }, 0 },
166
167   /* National */
168  {{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW1200 }, 0 },
169  {{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW2400 }, 0 },
170
171   /* Primax */
172  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2X300 }, 0 },
173  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E300 }, 0 },
174  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2300 }, 0 },
175  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E3002 }, 0 },
176  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_9600 }, 0 },
177  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_600U }, 0 },
178  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_6200 }, 0 },
179  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_19200 }, 0 },
180  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_1200U }, 0 },
181  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G600 }, 0 },
182  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_636I }, 0 },
183  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2600 }, 0 },
184  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E600 }, 0 },
185
186   /* Epson */
187  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_636 }, 0 },
188  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_610 }, 0 },
189  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1200 }, 0 },
190  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1240 }, 0 },
191  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1250 }, 0 },
192  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1600 }, 0 },
193  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1640 }, 0 },
194  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_640U }, 0 },
195  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1650 }, 0 },
196  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1660 }, 0 },
197  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1260 }, 0 },
198  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9700F }, USC_KEEP_OPEN },
199  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9300UF }, 0 },
200
201   /* UMAX */
202  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1220U }, 0 },
203  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1236U }, 0 },
204  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2000U }, 0 },
205  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2100U }, 0 },
206  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2200U }, 0 },
207  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA3400 }, 0 },
208
209   /* Visioneer */
210  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_3000 }, 0 },
211  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_5300 }, 0 },
212  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_7600 }, 0 },
213  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6100 }, 0 },
214  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6200 }, 0 },
215  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8100 }, 0 },
216  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8600 }, 0 },
217
218   /* Ultima */
219  {{ USB_VENDOR_ULTIMA, USB_PRODUCT_ULTIMA_1200UBPLUS }, 0 },
220
221 };
222 #define uscanner_lookup(v, p) ((const struct uscan_info *)usb_lookup(uscanner_devs, v, p))
223
224 #define USCANNER_BUFFERSIZE     1024
225
226 struct uscanner_softc {
227         USBBASEDEVICE           sc_dev;         /* base device */
228         usbd_device_handle      sc_udev;
229         usbd_interface_handle   sc_iface;
230 #if defined(__FreeBSD__) || defined(__DragonFly__)
231         dev_t                   dev;
232 #endif
233
234         u_int                   sc_dev_flags;
235
236         usbd_pipe_handle        sc_bulkin_pipe;
237         int                     sc_bulkin;
238         usbd_xfer_handle        sc_bulkin_xfer;
239         void                    *sc_bulkin_buffer;
240         int                     sc_bulkin_bufferlen;
241         int                     sc_bulkin_datalen;
242
243         usbd_pipe_handle        sc_bulkout_pipe;
244         int                     sc_bulkout;
245         usbd_xfer_handle        sc_bulkout_xfer;
246         void                    *sc_bulkout_buffer;
247         int                     sc_bulkout_bufferlen;
248         int                     sc_bulkout_datalen;
249
250         u_char                  sc_state;
251 #define USCANNER_OPEN           0x01    /* opened */
252
253         int                     sc_refcnt;
254         u_char                  sc_dying;
255 };
256
257 #if defined(__NetBSD__) || defined(__OpenBSD__)
258 cdev_decl(uscanner);
259 #elif defined(__FreeBSD__) || defined(__DragonFly__)
260 d_open_t  uscanneropen;
261 d_close_t uscannerclose;
262 d_read_t  uscannerread;
263 d_write_t uscannerwrite;
264 d_poll_t  uscannerpoll;
265
266 #define USCANNER_CDEV_MAJOR     156
267
268 Static struct cdevsw uscanner_cdevsw = {
269         /* name */      "uscanner",
270         /* maj */       USCANNER_CDEV_MAJOR,
271         /* flags */     0,
272         /* port */      NULL,
273         /* clone */     NULL,
274
275         /* open */      uscanneropen,
276         /* close */     uscannerclose,
277         /* read */      uscannerread,
278         /* write */     uscannerwrite,
279         /* ioctl */     noioctl,
280         /* poll */      uscannerpoll,
281         /* mmap */      nommap,
282         /* strategy */  nostrategy,
283         /* dump */      nodump,
284         /* psize */     nopsize
285 };
286 #endif
287
288 Static int uscanner_do_read(struct uscanner_softc *, struct uio *, int);
289 Static int uscanner_do_write(struct uscanner_softc *, struct uio *, int);
290 Static void uscanner_do_close(struct uscanner_softc *);
291
292 #define USCANNERUNIT(n) (minor(n))
293
294 USB_DECLARE_DRIVER(uscanner);
295
296 USB_MATCH(uscanner)
297 {
298         USB_MATCH_START(uscanner, uaa);
299
300         if (uaa->iface != NULL)
301                 return UMATCH_NONE;
302
303         return (uscanner_lookup(uaa->vendor, uaa->product) != NULL ?
304                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
305 }
306
307 USB_ATTACH(uscanner)
308 {
309         USB_ATTACH_START(uscanner, sc, uaa);
310         usb_interface_descriptor_t *id = 0;
311         usb_endpoint_descriptor_t *ed, *ed_bulkin = NULL, *ed_bulkout = NULL;
312         char devinfo[1024];
313         int i;
314         usbd_status err;
315
316         usbd_devinfo(uaa->device, 0, devinfo);
317         USB_ATTACH_SETUP;
318         printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
319
320         sc->sc_dev_flags = uscanner_lookup(uaa->vendor, uaa->product)->flags;
321
322         sc->sc_udev = uaa->device;
323
324         err = usbd_set_config_no(uaa->device, 1, 1); /* XXX */
325         if (err) {
326                 printf("%s: setting config no failed\n",
327                     USBDEVNAME(sc->sc_dev));
328                 USB_ATTACH_ERROR_RETURN;
329         }
330
331         /* XXX We only check the first interface */
332         err = usbd_device2interface_handle(sc->sc_udev, 0, &sc->sc_iface);
333         if (!err && sc->sc_iface)
334             id = usbd_get_interface_descriptor(sc->sc_iface);
335         if (err || id == 0) {
336                 printf("%s: could not get interface descriptor, err=%d,id=%p\n",
337                        USBDEVNAME(sc->sc_dev), err, id);
338                 USB_ATTACH_ERROR_RETURN;
339         }
340
341         /* Find the two first bulk endpoints */
342         for (i = 0 ; i < id->bNumEndpoints; i++) {
343                 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
344                 if (ed == 0) {
345                         printf("%s: could not read endpoint descriptor\n",
346                                USBDEVNAME(sc->sc_dev));
347                         USB_ATTACH_ERROR_RETURN;
348                 }
349
350                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
351                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
352                         ed_bulkin = ed;
353                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
354                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
355                         ed_bulkout = ed;
356                 }
357
358                 if (ed_bulkin && ed_bulkout)    /* found all we need */
359                         break;
360         }
361
362         /* Verify that we goething sensible */
363         if (ed_bulkin == NULL || ed_bulkout == NULL) {
364                 printf("%s: bulk-in and/or bulk-out endpoint not found\n",
365                         USBDEVNAME(sc->sc_dev));
366                 USB_ATTACH_ERROR_RETURN;
367         }
368
369         sc->sc_bulkin = ed_bulkin->bEndpointAddress;
370         sc->sc_bulkout = ed_bulkout->bEndpointAddress;
371
372 #if defined(__FreeBSD__) || defined(__DragonFly__)
373         /* the main device, ctrl endpoint */
374         sc->dev = make_dev(&uscanner_cdevsw, USBDEVUNIT(sc->sc_dev),
375                 UID_ROOT, GID_OPERATOR, 0644, "%s", USBDEVNAME(sc->sc_dev));
376 #endif
377
378         usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
379                            USBDEV(sc->sc_dev));
380
381         USB_ATTACH_SUCCESS_RETURN;
382 }
383
384 int
385 uscanneropen(dev_t dev, int flag, int mode, usb_proc_ptr p)
386 {
387         struct uscanner_softc *sc;
388         int unit = USCANNERUNIT(dev);
389         usbd_status err;
390
391         USB_GET_SC_OPEN(uscanner, unit, sc);
392
393         DPRINTFN(5, ("uscanneropen: flag=%d, mode=%d, unit=%d\n",
394                      flag, mode, unit));
395
396         if (sc->sc_dying)
397                 return (ENXIO);
398
399         if (sc->sc_state & USCANNER_OPEN)
400                 return (EBUSY);
401
402         sc->sc_state |= USCANNER_OPEN;
403
404         sc->sc_bulkin_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
405         sc->sc_bulkout_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
406         /* No need to check buffers for NULL since we have WAITOK */
407
408         sc->sc_bulkin_bufferlen = USCANNER_BUFFERSIZE;
409         sc->sc_bulkout_bufferlen = USCANNER_BUFFERSIZE;
410
411         /* We have decided on which endpoints to use, now open the pipes */
412         if (sc->sc_bulkin_pipe == NULL) {
413                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin,
414                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkin_pipe);
415                 if (err) {
416                         printf("%s: cannot open bulk-in pipe (addr %d)\n",
417                                USBDEVNAME(sc->sc_dev), sc->sc_bulkin);
418                         uscanner_do_close(sc);
419                         return (EIO);
420                 }
421         }
422         if (sc->sc_bulkout_pipe == NULL) {
423                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout,
424                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
425                 if (err) {
426                         printf("%s: cannot open bulk-out pipe (addr %d)\n",
427                                USBDEVNAME(sc->sc_dev), sc->sc_bulkout);
428                         uscanner_do_close(sc);
429                         return (EIO);
430                 }
431         }
432
433         sc->sc_bulkin_xfer = usbd_alloc_xfer(sc->sc_udev);
434         if (sc->sc_bulkin_xfer == NULL) {
435                 uscanner_do_close(sc);
436                 return (ENOMEM);
437         }
438         sc->sc_bulkout_xfer = usbd_alloc_xfer(sc->sc_udev);
439         if (sc->sc_bulkout_xfer == NULL) {
440                 uscanner_do_close(sc);
441                 return (ENOMEM);
442         }
443
444         return (0);     /* success */
445 }
446
447 int
448 uscannerclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
449 {
450         struct uscanner_softc *sc;
451
452         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
453
454         DPRINTFN(5, ("uscannerclose: flag=%d, mode=%d, unit=%d\n",
455                      flag, mode, USCANNERUNIT(dev)));
456
457 #ifdef DIAGNOSTIC
458         if (!(sc->sc_state & USCANNER_OPEN)) {
459                 printf("uscannerclose: not open\n");
460                 return (EINVAL);
461         }
462 #endif
463
464         uscanner_do_close(sc);
465
466         return (0);
467 }
468
469 void
470 uscanner_do_close(struct uscanner_softc *sc)
471 {
472         if (sc->sc_bulkin_xfer) {
473                 usbd_free_xfer(sc->sc_bulkin_xfer);
474                 sc->sc_bulkin_xfer = NULL;
475         }
476         if (sc->sc_bulkout_xfer) {
477                 usbd_free_xfer(sc->sc_bulkout_xfer);
478                 sc->sc_bulkout_xfer = NULL;
479         }
480
481         if (!(sc->sc_dev_flags & USC_KEEP_OPEN)) {
482                 if (sc->sc_bulkin_pipe != NULL) {
483                         usbd_abort_pipe(sc->sc_bulkin_pipe);
484                         usbd_close_pipe(sc->sc_bulkin_pipe);
485                         sc->sc_bulkin_pipe = NULL;
486                 }
487                 if (sc->sc_bulkout_pipe != NULL) {
488                         usbd_abort_pipe(sc->sc_bulkout_pipe);
489                         usbd_close_pipe(sc->sc_bulkout_pipe);
490                         sc->sc_bulkout_pipe = NULL;
491                 }
492         }
493
494         if (sc->sc_bulkin_buffer) {
495                 free(sc->sc_bulkin_buffer, M_USBDEV);
496                 sc->sc_bulkin_buffer = NULL;
497         }
498         if (sc->sc_bulkout_buffer) {
499                 free(sc->sc_bulkout_buffer, M_USBDEV);
500                 sc->sc_bulkout_buffer = NULL;
501         }
502
503         sc->sc_state &= ~USCANNER_OPEN;
504 }
505
506 Static int
507 uscanner_do_read(struct uscanner_softc *sc, struct uio *uio, int flag)
508 {
509         u_int32_t n, tn;
510         usbd_status err;
511         int error = 0;
512
513         DPRINTFN(5, ("%s: uscannerread\n", USBDEVNAME(sc->sc_dev)));
514
515         if (sc->sc_dying)
516                 return (EIO);
517
518         while ((n = min(sc->sc_bulkin_bufferlen, uio->uio_resid)) != 0) {
519                 DPRINTFN(1, ("uscannerread: start transfer %d bytes\n",n));
520                 tn = n;
521
522                 err = usbd_bulk_transfer(
523                         sc->sc_bulkin_xfer, sc->sc_bulkin_pipe,
524                         USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
525                         sc->sc_bulkin_buffer, &tn,
526                         "uscnrb");
527                 if (err) {
528                         if (err == USBD_INTERRUPTED)
529                                 error = EINTR;
530                         else if (err == USBD_TIMEOUT)
531                                 error = ETIMEDOUT;
532                         else
533                                 error = EIO;
534                         break;
535                 }
536                 DPRINTFN(1, ("uscannerread: got %d bytes\n", tn));
537                 error = uiomove(sc->sc_bulkin_buffer, tn, uio);
538                 if (error || tn < n)
539                         break;
540         }
541
542         return (error);
543 }
544
545 int
546 uscannerread(dev_t dev, struct uio *uio, int flag)
547 {
548         struct uscanner_softc *sc;
549         int error;
550
551         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
552
553         sc->sc_refcnt++;
554         error = uscanner_do_read(sc, uio, flag);
555         if (--sc->sc_refcnt < 0)
556                 usb_detach_wakeup(USBDEV(sc->sc_dev));
557
558         return (error);
559 }
560
561 Static int
562 uscanner_do_write(struct uscanner_softc *sc, struct uio *uio, int flag)
563 {
564         u_int32_t n;
565         int error = 0;
566         usbd_status err;
567
568         DPRINTFN(5, ("%s: uscanner_do_write\n", USBDEVNAME(sc->sc_dev)));
569
570         if (sc->sc_dying)
571                 return (EIO);
572
573         while ((n = min(sc->sc_bulkout_bufferlen, uio->uio_resid)) != 0) {
574                 error = uiomove(sc->sc_bulkout_buffer, n, uio);
575                 if (error)
576                         break;
577                 DPRINTFN(1, ("uscanner_do_write: transfer %d bytes\n", n));
578                 err = usbd_bulk_transfer(
579                         sc->sc_bulkout_xfer, sc->sc_bulkout_pipe,
580                         0, USBD_NO_TIMEOUT,
581                         sc->sc_bulkout_buffer, &n,
582                         "uscnwb");
583                 if (err) {
584                         if (err == USBD_INTERRUPTED)
585                                 error = EINTR;
586                         else
587                                 error = EIO;
588                         break;
589                 }
590         }
591
592         return (error);
593 }
594
595 int
596 uscannerwrite(dev_t dev, struct uio *uio, int flag)
597 {
598         struct uscanner_softc *sc;
599         int error;
600
601         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
602
603         sc->sc_refcnt++;
604         error = uscanner_do_write(sc, uio, flag);
605         if (--sc->sc_refcnt < 0)
606                 usb_detach_wakeup(USBDEV(sc->sc_dev));
607         return (error);
608 }
609
610 #if defined(__NetBSD__) || defined(__OpenBSD__)
611 int
612 uscanner_activate(device_ptr_t self, enum devact act)
613 {
614         struct uscanner_softc *sc = (struct uscanner_softc *)self;
615
616         switch (act) {
617         case DVACT_ACTIVATE:
618                 return (EOPNOTSUPP);
619
620         case DVACT_DEACTIVATE:
621                 sc->sc_dying = 1;
622                 break;
623         }
624         return (0);
625 }
626 #endif
627
628 USB_DETACH(uscanner)
629 {
630         USB_DETACH_START(uscanner, sc);
631         int s;
632 #if defined(__NetBSD__) || defined(__OpenBSD__)
633         int maj, mn;
634 #endif
635
636 #if defined(__NetBSD__) || defined(__OpenBSD__)
637         DPRINTF(("uscanner_detach: sc=%p flags=%d\n", sc, flags));
638 #elif defined(__FreeBSD__) || defined(__DragonFly__)
639         DPRINTF(("uscanner_detach: sc=%p\n", sc));
640 #endif
641
642         sc->sc_dying = 1;
643         sc->sc_dev_flags = 0;   /* make close really close device */
644
645         /* Abort all pipes.  Causes processes waiting for transfer to wake. */
646         if (sc->sc_bulkin_pipe != NULL)
647                 usbd_abort_pipe(sc->sc_bulkin_pipe);
648         if (sc->sc_bulkout_pipe != NULL)
649                 usbd_abort_pipe(sc->sc_bulkout_pipe);
650
651         s = splusb();
652         if (--sc->sc_refcnt >= 0) {
653                 /* Wait for processes to go away. */
654                 usb_detach_wait(USBDEV(sc->sc_dev));
655         }
656         splx(s);
657
658 #if defined(__NetBSD__) || defined(__OpenBSD__)
659         /* locate the major number */
660         for (maj = 0; maj < nchrdev; maj++)
661                 if (cdevsw[maj].d_open == uscanneropen)
662                         break;
663
664         /* Nuke the vnodes for any open instances (calls close). */
665         mn = self->dv_unit * USB_MAX_ENDPOINTS;
666         vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
667 #elif defined(__FreeBSD__) || defined(__DragonFly__)
668         /* destroy the device for the control endpoint */
669         destroy_dev(sc->dev);
670 #endif
671
672         usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
673                            USBDEV(sc->sc_dev));
674
675         return (0);
676 }
677
678 int
679 uscannerpoll(dev_t dev, int events, usb_proc_ptr p)
680 {
681         struct uscanner_softc *sc;
682         int revents = 0;
683
684         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
685
686         if (sc->sc_dying)
687                 return (EIO);
688
689         /*
690          * We have no easy way of determining if a read will
691          * yield any data or a write will happen.
692          * Pretend they will.
693          */
694         revents |= events &
695                    (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
696
697         return (revents);
698 }
699
700 #if defined(__FreeBSD__) || defined(__DragonFly__)
701 DRIVER_MODULE(uscanner, uhub, uscanner_driver, uscanner_devclass, usbd_driver_load, 0);
702 #endif