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.11 2006/06/22 08:22:27 corecode 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 #include <sys/thread2.h>
  76
  77 #include <bus/usb/usb.h>
  78 #include <bus/usb/usbdi.h>
  79 #include <bus/usb/usbdi_util.h>
  80
  81 #include <bus/usb/usbdevs.h>
  82
  83 #ifdef USB_DEBUG
  84 #define DPRINTF(x)      if (uscannerdebug) logprintf x
  85 #define DPRINTFN(n,x)   if (uscannerdebug>(n)) logprintf x
  86 int     uscannerdebug = 0;
  87 SYSCTL_NODE(_hw_usb, OID_AUTO, uscanner, CTLFLAG_RW, 0, "USB uscanner");
  88 SYSCTL_INT(_hw_usb_uscanner, OID_AUTO, debug, CTLFLAG_RW,
  89            &uscannerdebug, 0, "uscanner debug level");
  90 #else
  91 #define DPRINTF(x)
  92 #define DPRINTFN(n,x)
  93 #endif
  94
  95 struct uscan_info {
  96         struct usb_devno devno;
  97         u_int flags;
  98 #define USC_KEEP_OPEN 1
  99 };
 100
 101 /* Table of scanners that may work with this driver. */
 102 static const struct uscan_info uscanner_devs[] = {
 103   /* Acer Peripherals */
 104  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_320U }, 0 },
 105  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_640U }, 0 },
 106  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_620U }, 0 },
 107  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_C310U }, 0 },
 108
 109   /* AGFA */
 110  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1236U }, 0 },
 111  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U }, 0 },
 112  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U2 }, 0 },
 113  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANTOUCH }, 0 },
 114  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE40 }, 0 },
 115  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE50 }, 0 },
 116  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE20 }, 0 },
 117  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE25 }, 0 },
 118  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE26 }, 0 },
 119  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE52 }, 0 },
 120
 121   /* Avision */
 122  {{ USB_VENDOR_AVISION, USB_PRODUCT_AVISION_1200U }, 0 },
 123
 124   /* Canon */
 125  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N656U }, 0 },
 126  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N676U }, 0 },
 127  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_D660U }, 0 },
 128
 129   /* Kye */
 130  {{ USB_VENDOR_KYE, USB_PRODUCT_KYE_VIVIDPRO }, 0 },
 131
 132   /* HP */
 133  {{ USB_VENDOR_HP, USB_PRODUCT_HP_2200C }, 0 },
 134  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3300C }, 0 },
 135  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3400CSE }, 0 },
 136  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4100C }, 0 },
 137  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4200C }, 0 },
 138  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4300C }, 0 },
 139  {{ USB_VENDOR_HP, USB_PRODUCT_HP_S20 }, 0 },
 140  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5200C }, 0 },
 141  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5300C }, 0 },
 142  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5400C }, 0 },
 143  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6200C }, 0 },
 144  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6300C }, 0 },
 145
 146   /* Microtek */
 147  {{ USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_336CX }, 0 },
 148  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_X6U }, 0 },
 149  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX }, 0 },
 150  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX2 }, 0 },
 151  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_C6 }, 0 },
 152  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL }, 0 },
 153  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL2 }, 0 },
 154  {{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6UL }, 0 },
 155
 156   /* Minolta */
 157  {{ USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_5400 }, 0 },
 158
 159   /* Mustek */
 160  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CU }, 0 },
 161  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_BEARPAW1200F }, 0 },
 162  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_BEARPAW1200TA }, 0 },
 163  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600USB }, 0 },
 164  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600CU }, 0 },
 165  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USB }, 0 },
 166  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200UB }, 0 },
 167  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USBPLUS }, 0 },
 168  {{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CUPLUS }, 0 },
 169
 170   /* National */
 171  {{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW1200 }, 0 },
 172  {{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW2400 }, 0 },
 173
 174   /* Primax */
 175  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2X300 }, 0 },
 176  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E300 }, 0 },
 177  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2300 }, 0 },
 178  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E3002 }, 0 },
 179  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_9600 }, 0 },
 180  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_600U }, 0 },
 181  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_6200 }, 0 },
 182  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_19200 }, 0 },
 183  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_1200U }, 0 },
 184  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G600 }, 0 },
 185  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_636I }, 0 },
 186  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2600 }, 0 },
 187  {{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E600 }, 0 },
 188
 189   /* Epson */
 190  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_636 }, 0 },
 191  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_610 }, 0 },
 192  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1200 }, 0 },
 193  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1240 }, 0 },
 194  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1250 }, 0 },
 195  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1600 }, 0 },
 196  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1640 }, 0 },
 197  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_640U }, 0 },
 198  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1650 }, 0 },
 199  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1660 }, 0 },
 200  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1260 }, 0 },
 201  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9700F }, USC_KEEP_OPEN },
 202  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9300UF }, 0 },
 203
 204   /* UMAX */
 205  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1220U }, 0 },
 206  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1236U }, 0 },
 207  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2000U }, 0 },
 208  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2100U }, 0 },
 209  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2200U }, 0 },
 210  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA3400 }, 0 },
 211
 212   /* Visioneer */
 213  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_3000 }, 0 },
 214  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_5300 }, 0 },
 215  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_7600 }, 0 },
 216  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6100 }, 0 },
 217  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6200 }, 0 },
 218  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8100 }, 0 },
 219  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8600 }, 0 },
 220
 221   /* Ultima */
 222  {{ USB_VENDOR_ULTIMA, USB_PRODUCT_ULTIMA_1200UBPLUS }, 0 },
 223
 224 };
 225 #define uscanner_lookup(v, p) ((const struct uscan_info *)usb_lookup(uscanner_devs, v, p))
 226
 227 #define USCANNER_BUFFERSIZE     1024
 228
 229 struct uscanner_softc {
 230         USBBASEDEVICE           sc_dev;         /* base device */
 231         usbd_device_handle      sc_udev;
 232         usbd_interface_handle   sc_iface;
 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         cdevsw_add(&uscanner_cdevsw, -1, USBDEVUNIT(sc->sc_dev));
 375         make_dev(&uscanner_cdevsw, USBDEVUNIT(sc->sc_dev),
 376                 UID_ROOT, GID_OPERATOR, 0644, "%s", USBDEVNAME(sc->sc_dev));
 377 #endif
 378
 379         usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
 380                            USBDEV(sc->sc_dev));
 381
 382         USB_ATTACH_SUCCESS_RETURN;
 383 }
 384
 385 int
 386 uscanneropen(dev_t dev, int flag, int mode, usb_proc_ptr p)
 387 {
 388         struct uscanner_softc *sc;
 389         int unit = USCANNERUNIT(dev);
 390         usbd_status err;
 391
 392         USB_GET_SC_OPEN(uscanner, unit, sc);
 393
 394         DPRINTFN(5, ("uscanneropen: flag=%d, mode=%d, unit=%d\n",
 395                      flag, mode, unit));
 396
 397         if (sc->sc_dying)
 398                 return (ENXIO);
 399
 400         if (sc->sc_state & USCANNER_OPEN)
 401                 return (EBUSY);
 402
 403         sc->sc_state |= USCANNER_OPEN;
 404
 405         sc->sc_bulkin_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
 406         sc->sc_bulkout_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
 407         /* No need to check buffers for NULL since we have WAITOK */
 408
 409         sc->sc_bulkin_bufferlen = USCANNER_BUFFERSIZE;
 410         sc->sc_bulkout_bufferlen = USCANNER_BUFFERSIZE;
 411
 412         /* We have decided on which endpoints to use, now open the pipes */
 413         if (sc->sc_bulkin_pipe == NULL) {
 414                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin,
 415                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkin_pipe);
 416                 if (err) {
 417                         printf("%s: cannot open bulk-in pipe (addr %d)\n",
 418                                USBDEVNAME(sc->sc_dev), sc->sc_bulkin);
 419                         uscanner_do_close(sc);
 420                         return (EIO);
 421                 }
 422         }
 423         if (sc->sc_bulkout_pipe == NULL) {
 424                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout,
 425                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
 426                 if (err) {
 427                         printf("%s: cannot open bulk-out pipe (addr %d)\n",
 428                                USBDEVNAME(sc->sc_dev), sc->sc_bulkout);
 429                         uscanner_do_close(sc);
 430                         return (EIO);
 431                 }
 432         }
 433
 434         sc->sc_bulkin_xfer = usbd_alloc_xfer(sc->sc_udev);
 435         if (sc->sc_bulkin_xfer == NULL) {
 436                 uscanner_do_close(sc);
 437                 return (ENOMEM);
 438         }
 439         sc->sc_bulkout_xfer = usbd_alloc_xfer(sc->sc_udev);
 440         if (sc->sc_bulkout_xfer == NULL) {
 441                 uscanner_do_close(sc);
 442                 return (ENOMEM);
 443         }
 444
 445         return (0);     /* success */
 446 }
 447
 448 int
 449 uscannerclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
 450 {
 451         struct uscanner_softc *sc;
 452
 453         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
 454
 455         DPRINTFN(5, ("uscannerclose: flag=%d, mode=%d, unit=%d\n",
 456                      flag, mode, USCANNERUNIT(dev)));
 457
 458 #ifdef DIAGNOSTIC
 459         if (!(sc->sc_state & USCANNER_OPEN)) {
 460                 printf("uscannerclose: not open\n");
 461                 return (EINVAL);
 462         }
 463 #endif
 464
 465         uscanner_do_close(sc);
 466
 467         return (0);
 468 }
 469
 470 void
 471 uscanner_do_close(struct uscanner_softc *sc)
 472 {
 473         if (sc->sc_bulkin_xfer) {
 474                 usbd_free_xfer(sc->sc_bulkin_xfer);
 475                 sc->sc_bulkin_xfer = NULL;
 476         }
 477         if (sc->sc_bulkout_xfer) {
 478                 usbd_free_xfer(sc->sc_bulkout_xfer);
 479                 sc->sc_bulkout_xfer = NULL;
 480         }
 481
 482         if (!(sc->sc_dev_flags & USC_KEEP_OPEN)) {
 483                 if (sc->sc_bulkin_pipe != NULL) {
 484                         usbd_abort_pipe(sc->sc_bulkin_pipe);
 485                         usbd_close_pipe(sc->sc_bulkin_pipe);
 486                         sc->sc_bulkin_pipe = NULL;
 487                 }
 488                 if (sc->sc_bulkout_pipe != NULL) {
 489                         usbd_abort_pipe(sc->sc_bulkout_pipe);
 490                         usbd_close_pipe(sc->sc_bulkout_pipe);
 491                         sc->sc_bulkout_pipe = NULL;
 492                 }
 493         }
 494
 495         if (sc->sc_bulkin_buffer) {
 496                 free(sc->sc_bulkin_buffer, M_USBDEV);
 497                 sc->sc_bulkin_buffer = NULL;
 498         }
 499         if (sc->sc_bulkout_buffer) {
 500                 free(sc->sc_bulkout_buffer, M_USBDEV);
 501                 sc->sc_bulkout_buffer = NULL;
 502         }
 503
 504         sc->sc_state &= ~USCANNER_OPEN;
 505 }
 506
 507 Static int
 508 uscanner_do_read(struct uscanner_softc *sc, struct uio *uio, int flag)
 509 {
 510         u_int32_t n, tn;
 511         usbd_status err;
 512         int error = 0;
 513
 514         DPRINTFN(5, ("%s: uscannerread\n", USBDEVNAME(sc->sc_dev)));
 515
 516         if (sc->sc_dying)
 517                 return (EIO);
 518
 519         while ((n = min(sc->sc_bulkin_bufferlen, uio->uio_resid)) != 0) {
 520                 DPRINTFN(1, ("uscannerread: start transfer %d bytes\n",n));
 521                 tn = n;
 522
 523                 err = usbd_bulk_transfer(
 524                         sc->sc_bulkin_xfer, sc->sc_bulkin_pipe,
 525                         USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
 526                         sc->sc_bulkin_buffer, &tn,
 527                         "uscnrb");
 528                 if (err) {
 529                         if (err == USBD_INTERRUPTED)
 530                                 error = EINTR;
 531                         else if (err == USBD_TIMEOUT)
 532                                 error = ETIMEDOUT;
 533                         else
 534                                 error = EIO;
 535                         break;
 536                 }
 537                 DPRINTFN(1, ("uscannerread: got %d bytes\n", tn));
 538                 error = uiomove(sc->sc_bulkin_buffer, tn, uio);
 539                 if (error || tn < n)
 540                         break;
 541         }
 542
 543         return (error);
 544 }
 545
 546 int
 547 uscannerread(dev_t dev, struct uio *uio, int flag)
 548 {
 549         struct uscanner_softc *sc;
 550         int error;
 551
 552         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
 553
 554         sc->sc_refcnt++;
 555         error = uscanner_do_read(sc, uio, flag);
 556         if (--sc->sc_refcnt < 0)
 557                 usb_detach_wakeup(USBDEV(sc->sc_dev));
 558
 559         return (error);
 560 }
 561
 562 Static int
 563 uscanner_do_write(struct uscanner_softc *sc, struct uio *uio, int flag)
 564 {
 565         u_int32_t n;
 566         int error = 0;
 567         usbd_status err;
 568
 569         DPRINTFN(5, ("%s: uscanner_do_write\n", USBDEVNAME(sc->sc_dev)));
 570
 571         if (sc->sc_dying)
 572                 return (EIO);
 573
 574         while ((n = min(sc->sc_bulkout_bufferlen, uio->uio_resid)) != 0) {
 575                 error = uiomove(sc->sc_bulkout_buffer, n, uio);
 576                 if (error)
 577                         break;
 578                 DPRINTFN(1, ("uscanner_do_write: transfer %d bytes\n", n));
 579                 err = usbd_bulk_transfer(
 580                         sc->sc_bulkout_xfer, sc->sc_bulkout_pipe,
 581                         0, USBD_NO_TIMEOUT,
 582                         sc->sc_bulkout_buffer, &n,
 583                         "uscnwb");
 584                 if (err) {
 585                         if (err == USBD_INTERRUPTED)
 586                                 error = EINTR;
 587                         else
 588                                 error = EIO;
 589                         break;
 590                 }
 591         }
 592
 593         return (error);
 594 }
 595
 596 int
 597 uscannerwrite(dev_t dev, struct uio *uio, int flag)
 598 {
 599         struct uscanner_softc *sc;
 600         int error;
 601
 602         USB_GET_SC(uscanner, USCANNERUNIT(dev), sc);
 603
 604         sc->sc_refcnt++;
 605         error = uscanner_do_write(sc, uio, flag);
 606         if (--sc->sc_refcnt < 0)
 607                 usb_detach_wakeup(USBDEV(sc->sc_dev));
 608         return (error);
 609 }
 610
 611 #if defined(__NetBSD__) || defined(__OpenBSD__)
 612 int
 613 uscanner_activate(device_ptr_t self, enum devact act)
 614 {
 615         struct uscanner_softc *sc = (struct uscanner_softc *)self;
 616
 617         switch (act) {
 618         case DVACT_ACTIVATE:
 619                 return (EOPNOTSUPP);
 620
 621         case DVACT_DEACTIVATE:
 622                 sc->sc_dying = 1;
 623                 break;
 624         }
 625         return (0);
 626 }
 627 #endif
 628
 629 USB_DETACH(uscanner)
 630 {
 631         USB_DETACH_START(uscanner, sc);
 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         crit_enter();
 652         if (--sc->sc_refcnt >= 0) {
 653                 /* Wait for processes to go away. */
 654                 usb_detach_wait(USBDEV(sc->sc_dev));
 655         }
 656         crit_exit();
 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         cdevsw_remove(&uscanner_cdevsw, -1, USBDEVUNIT(sc->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