sys/dev/usb/uscanner.c

   1 /*      $NetBSD: uscanner.c,v 1.30 2002/07/11 21:14:36 augustss Exp$    */
   2
   3 /* Also already merged from NetBSD:
   4  *      $NetBSD: uscanner.c,v 1.33 2002/09/23 05:51:24 simonb Exp $
   5  */
   6
   7 #include <sys/cdefs.h>
   8 __FBSDID("$FreeBSD$");
   9
  10 /*-
  11  * Copyright (c) 2000 The NetBSD Foundation, Inc.
  12  * All rights reserved.
  13  *
  14  * This code is derived from software contributed to The NetBSD Foundation
  15  * by Lennart Augustsson (lennart@augustsson.net) at
  16  * Carlstedt Research & Technology
  17  * and Nick Hibma (n_hibma@qubesoft.com).
  18  *
  19  * Redistribution and use in source and binary forms, with or without
  20  * modification, are permitted provided that the following conditions
  21  * are met:
  22  * 1. Redistributions of source code must retain the above copyright
  23  *    notice, this list of conditions and the following disclaimer.
  24  * 2. Redistributions in binary form must reproduce the above copyright
  25  *    notice, this list of conditions and the following disclaimer in the
  26  *    documentation and/or other materials provided with the distribution.
  27  * 3. All advertising materials mentioning features or use of this software
  28  *    must display the following acknowledgement:
  29  *        This product includes software developed by the NetBSD
  30  *        Foundation, Inc. and its contributors.
  31  * 4. Neither the name of The NetBSD Foundation nor the names of its
  32  *    contributors may be used to endorse or promote products derived
  33  *    from this software without specific prior written permission.
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  36  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  37  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  39  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  40  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  41  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  42  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  43  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  44  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  45  * POSSIBILITY OF SUCH DAMAGE.
  46  */
  47
  48
  49 #include <sys/param.h>
  50 #include <sys/systm.h>
  51 #include <sys/kernel.h>
  52 #include <sys/malloc.h>
  53 #include <sys/module.h>
  54 #include <sys/bus.h>
  55 #include <sys/conf.h>
  56 #include <sys/fcntl.h>
  57 #include <sys/filio.h>
  58 #include <sys/tty.h>
  59 #include <sys/file.h>
  60 #include <sys/selinfo.h>
  61 #include <sys/proc.h>
  62 #include <sys/poll.h>
  63 #include <sys/conf.h>
  64 #include <sys/sysctl.h>
  65 #include <sys/uio.h>
  66
  67 #include <dev/usb/usb.h>
  68 #include <dev/usb/usbdi.h>
  69 #include <dev/usb/usbdi_util.h>
  70
  71 #include "usbdevs.h"
  72
  73 #ifdef USB_DEBUG
  74 #define DPRINTF(x)      if (uscannerdebug) printf x
  75 #define DPRINTFN(n,x)   if (uscannerdebug>(n)) printf x
  76 int     uscannerdebug = 0;
  77 SYSCTL_NODE(_hw_usb, OID_AUTO, uscanner, CTLFLAG_RW, 0, "USB uscanner");
  78 SYSCTL_INT(_hw_usb_uscanner, OID_AUTO, debug, CTLFLAG_RW,
  79            &uscannerdebug, 0, "uscanner debug level");
  80 #else
  81 #define DPRINTF(x)
  82 #define DPRINTFN(n,x)
  83 #endif
  84
  85 struct uscan_info {
  86         struct usb_devno devno;
  87         u_int flags;
  88 #define USC_KEEP_OPEN 1
  89 };
  90
  91 /* Table of scanners that may work with this driver. */
  92 static const struct uscan_info uscanner_devs[] = {
  93   /* Acer Peripherals */
  94  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_320U }, 0 },
  95  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_640U }, 0 },
  96  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_640BT }, 0 },
  97  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_620U }, 0 },
  98  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_1240U }, 0 },
  99  {{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_C310U }, 0 },
 100
 101   /* AGFA */
 102  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1236U }, 0 },
 103  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U }, 0 },
 104  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U2 }, 0 },
 105  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANTOUCH }, 0 },
 106  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE40 }, 0 },
 107  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE50 }, 0 },
 108  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE20 }, 0 },
 109  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE25 }, 0 },
 110  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE26 }, 0 },
 111  {{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE52 }, 0 },
 112
 113   /* Avision */
 114  {{ USB_VENDOR_AVISION, USB_PRODUCT_AVISION_1200U }, 0 },
 115
 116   /* Canon */
 117  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N656U }, 0 },
 118  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N676U }, 0 },
 119  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N1220U }, 0 },
 120  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_D660U }, 0 },
 121  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N1240U }, 0 },
 122  {{ USB_VENDOR_CANON, USB_PRODUCT_CANON_LIDE25 }, 0 },
 123
 124   /* Kye */
 125  {{ USB_VENDOR_KYE, USB_PRODUCT_KYE_VIVIDPRO }, 0 },
 126
 127   /* HP */
 128  {{ USB_VENDOR_HP, USB_PRODUCT_HP_2200C }, 0 },
 129  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3300C }, 0 },
 130  {{ USB_VENDOR_HP, USB_PRODUCT_HP_3400CSE }, 0 },
 131  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4100C }, 0 },
 132  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4200C }, 0 },
 133  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4300C }, 0 },
 134  {{ USB_VENDOR_HP, USB_PRODUCT_HP_4670V }, 0 },
 135  {{ USB_VENDOR_HP, USB_PRODUCT_HP_S20 }, 0 },
 136  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5200C }, 0 },
 137  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5300C }, 0 },
 138  {{ USB_VENDOR_HP, USB_PRODUCT_HP_5400C }, 0 },
 139  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6200C }, 0 },
 140  {{ USB_VENDOR_HP, USB_PRODUCT_HP_6300C }, 0 },
 141  {{ USB_VENDOR_HP, USB_PRODUCT_HP_82x0C }, 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   /* Nikon */
 172  {{ USB_VENDOR_NIKON, USB_PRODUCT_NIKON_LS40 }, 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_1670 }, 0 },
 201  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1260 }, 0 },
 202  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1270 }, 0 },
 203  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_RX425 }, 0 },
 204  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_3200 }, USC_KEEP_OPEN },
 205  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9700F }, USC_KEEP_OPEN },
 206  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9300UF }, 0 },
 207  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_2480 }, 0 },
 208  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_3500 }, USC_KEEP_OPEN },
 209  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_3590 }, 0 },
 210  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_4200 }, 0 },
 211  {{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_4990 }, 0 },
 212
 213   /* UMAX */
 214  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1220U }, 0 },
 215  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1236U }, 0 },
 216  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2000U }, 0 },
 217  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2100U }, 0 },
 218  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2200U }, 0 },
 219  {{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA3400 }, 0 },
 220
 221   /* Visioneer */
 222  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_3000 }, 0 },
 223  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_5300 }, 0 },
 224  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_7600 }, 0 },
 225  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6100 }, 0 },
 226  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6200 }, 0 },
 227  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8100 }, 0 },
 228  {{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8600 }, 0 },
 229
 230   /* Ultima */
 231  {{ USB_VENDOR_ULTIMA, USB_PRODUCT_ULTIMA_1200UBPLUS }, 0 },
 232
 233 };
 234 #define uscanner_lookup(v, p) ((const struct uscan_info *)usb_lookup(uscanner_devs, v, p))
 235
 236 #define USCANNER_BUFFERSIZE     1024
 237
 238 struct uscanner_softc {
 239         device_t                sc_dev;         /* base device */
 240         usbd_device_handle      sc_udev;
 241         usbd_interface_handle   sc_iface;
 242         struct cdev *dev;
 243
 244         u_int                   sc_dev_flags;
 245
 246         usbd_pipe_handle        sc_bulkin_pipe;
 247         int                     sc_bulkin;
 248         usbd_xfer_handle        sc_bulkin_xfer;
 249         void                    *sc_bulkin_buffer;
 250         int                     sc_bulkin_bufferlen;
 251         int                     sc_bulkin_datalen;
 252
 253         usbd_pipe_handle        sc_bulkout_pipe;
 254         int                     sc_bulkout;
 255         usbd_xfer_handle        sc_bulkout_xfer;
 256         void                    *sc_bulkout_buffer;
 257         int                     sc_bulkout_bufferlen;
 258         int                     sc_bulkout_datalen;
 259
 260         u_char                  sc_state;
 261 #define USCANNER_OPEN           0x01    /* opened */
 262
 263         int                     sc_refcnt;
 264         u_char                  sc_dying;
 265 };
 266
 267 d_open_t  uscanneropen;
 268 d_close_t uscannerclose;
 269 d_read_t  uscannerread;
 270 d_write_t uscannerwrite;
 271 d_poll_t  uscannerpoll;
 272
 273
 274 static struct cdevsw uscanner_cdevsw = {
 275         .d_version =    D_VERSION,
 276         .d_flags =      D_NEEDGIANT,
 277         .d_open =       uscanneropen,
 278         .d_close =      uscannerclose,
 279         .d_read =       uscannerread,
 280         .d_write =      uscannerwrite,
 281         .d_poll =       uscannerpoll,
 282         .d_name =       "uscanner",
 283 };
 284
 285 static int uscanner_do_read(struct uscanner_softc *, struct uio *, int);
 286 static int uscanner_do_write(struct uscanner_softc *, struct uio *, int);
 287 static void uscanner_do_close(struct uscanner_softc *);
 288
 289 #define USCANNERUNIT(n) (minor(n))
 290
 291 static device_probe_t uscanner_match;
 292 static device_attach_t uscanner_attach;
 293 static device_detach_t uscanner_detach;
 294
 295 static device_method_t uscanner_methods[] = {
 296         /* Device interface */
 297         DEVMETHOD(device_probe,         uscanner_match),
 298         DEVMETHOD(device_attach,        uscanner_attach),
 299         DEVMETHOD(device_detach,        uscanner_detach),
 300
 301         { 0, 0 }
 302 };
 303
 304 static driver_t uscanner_driver = {
 305         "uscanner",
 306         uscanner_methods,
 307         sizeof(struct uscanner_softc)
 308 };
 309
 310 static devclass_t uscanner_devclass;
 311
 312 static int
 313 uscanner_match(device_t self)
 314 {
 315         struct usb_attach_arg *uaa = device_get_ivars(self);
 316
 317         if (uaa->iface != NULL)
 318                 return UMATCH_NONE;
 319
 320         return (uscanner_lookup(uaa->vendor, uaa->product) != NULL ?
 321                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
 322 }
 323
 324 static int
 325 uscanner_attach(device_t self)
 326 {
 327         struct uscanner_softc *sc = device_get_softc(self);
 328         struct usb_attach_arg *uaa = device_get_ivars(self);
 329         usb_interface_descriptor_t *id = 0;
 330         usb_endpoint_descriptor_t *ed, *ed_bulkin = NULL, *ed_bulkout = NULL;
 331         int i;
 332         usbd_status err;
 333
 334         sc->sc_dev = self;
 335         sc->sc_dev_flags = uscanner_lookup(uaa->vendor, uaa->product)->flags;
 336         sc->sc_udev = uaa->device;
 337
 338         err = usbd_set_config_no(uaa->device, 1, 1); /* XXX */
 339         if (err) {
 340                 printf("%s: setting config no failed\n",
 341                     device_get_nameunit(sc->sc_dev));
 342                 return ENXIO;
 343         }
 344
 345         /* XXX We only check the first interface */
 346         err = usbd_device2interface_handle(sc->sc_udev, 0, &sc->sc_iface);
 347         if (!err && sc->sc_iface)
 348             id = usbd_get_interface_descriptor(sc->sc_iface);
 349         if (err || id == 0) {
 350                 printf("%s: could not get interface descriptor, err=%d,id=%p\n",
 351                        device_get_nameunit(sc->sc_dev), err, id);
 352                 return ENXIO;
 353         }
 354
 355         /* Find the two first bulk endpoints */
 356         for (i = 0 ; i < id->bNumEndpoints; i++) {
 357                 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
 358                 if (ed == 0) {
 359                         printf("%s: could not read endpoint descriptor\n",
 360                                device_get_nameunit(sc->sc_dev));
 361                         return ENXIO;
 362                 }
 363
 364                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
 365                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
 366                         ed_bulkin = ed;
 367                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
 368                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
 369                         ed_bulkout = ed;
 370                 }
 371
 372                 if (ed_bulkin && ed_bulkout)    /* found all we need */
 373                         break;
 374         }
 375
 376         /* Verify that we goething sensible */
 377         if (ed_bulkin == NULL || ed_bulkout == NULL) {
 378                 printf("%s: bulk-in and/or bulk-out endpoint not found\n",
 379                         device_get_nameunit(sc->sc_dev));
 380                 return ENXIO;
 381         }
 382
 383         sc->sc_bulkin = ed_bulkin->bEndpointAddress;
 384         sc->sc_bulkout = ed_bulkout->bEndpointAddress;
 385
 386         /* the main device, ctrl endpoint */
 387         sc->dev = make_dev(&uscanner_cdevsw, device_get_unit(sc->sc_dev),
 388                 UID_ROOT, GID_OPERATOR, 0644, "%s", device_get_nameunit(sc->sc_dev));
 389         usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,sc->sc_dev);
 390
 391         return 0;
 392 }
 393
 394 int
 395 uscanneropen(struct cdev *dev, int flag, int mode, struct thread *p)
 396 {
 397         struct uscanner_softc *sc;
 398         int unit = USCANNERUNIT(dev);
 399         usbd_status err;
 400
 401         sc = devclass_get_softc(uscanner_devclass, unit);
 402         if (sc == NULL)
 403                 return (ENXIO);
 404
 405         DPRINTFN(5, ("uscanneropen: flag=%d, mode=%d, unit=%d\n",
 406                      flag, mode, unit));
 407
 408         if (sc->sc_dying)
 409                 return (ENXIO);
 410
 411         if (sc->sc_state & USCANNER_OPEN)
 412                 return (EBUSY);
 413
 414         sc->sc_state |= USCANNER_OPEN;
 415
 416         sc->sc_bulkin_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
 417         sc->sc_bulkout_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
 418         /* No need to check buffers for NULL since we have WAITOK */
 419
 420         sc->sc_bulkin_bufferlen = USCANNER_BUFFERSIZE;
 421         sc->sc_bulkout_bufferlen = USCANNER_BUFFERSIZE;
 422
 423         /* We have decided on which endpoints to use, now open the pipes */
 424         if (sc->sc_bulkin_pipe == NULL) {
 425                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin,
 426                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkin_pipe);
 427                 if (err) {
 428                         printf("%s: cannot open bulk-in pipe (addr %d)\n",
 429                                device_get_nameunit(sc->sc_dev), sc->sc_bulkin);
 430                         uscanner_do_close(sc);
 431                         return (EIO);
 432                 }
 433         }
 434         if (sc->sc_bulkout_pipe == NULL) {
 435                 err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout,
 436                                      USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
 437                 if (err) {
 438                         printf("%s: cannot open bulk-out pipe (addr %d)\n",
 439                                device_get_nameunit(sc->sc_dev), sc->sc_bulkout);
 440                         uscanner_do_close(sc);
 441                         return (EIO);
 442                 }
 443         }
 444
 445         sc->sc_bulkin_xfer = usbd_alloc_xfer(sc->sc_udev);
 446         if (sc->sc_bulkin_xfer == NULL) {
 447                 uscanner_do_close(sc);
 448                 return (ENOMEM);
 449         }
 450         sc->sc_bulkout_xfer = usbd_alloc_xfer(sc->sc_udev);
 451         if (sc->sc_bulkout_xfer == NULL) {
 452                 uscanner_do_close(sc);
 453                 return (ENOMEM);
 454         }
 455
 456         return (0);     /* success */
 457 }
 458
 459 int
 460 uscannerclose(struct cdev *dev, int flag, int mode, struct thread *p)
 461 {
 462         struct uscanner_softc *sc;
 463
 464         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
 465         DPRINTFN(5, ("uscannerclose: flag=%d, mode=%d, unit=%d\n",
 466                      flag, mode, USCANNERUNIT(dev)));
 467
 468 #ifdef DIAGNOSTIC
 469         if (!(sc->sc_state & USCANNER_OPEN)) {
 470                 printf("uscannerclose: not open\n");
 471                 return (EINVAL);
 472         }
 473 #endif
 474
 475         uscanner_do_close(sc);
 476
 477         return (0);
 478 }
 479
 480 void
 481 uscanner_do_close(struct uscanner_softc *sc)
 482 {
 483         if (sc->sc_bulkin_xfer) {
 484                 usbd_free_xfer(sc->sc_bulkin_xfer);
 485                 sc->sc_bulkin_xfer = NULL;
 486         }
 487         if (sc->sc_bulkout_xfer) {
 488                 usbd_free_xfer(sc->sc_bulkout_xfer);
 489                 sc->sc_bulkout_xfer = NULL;
 490         }
 491
 492         if (!(sc->sc_dev_flags & USC_KEEP_OPEN)) {
 493                 if (sc->sc_bulkin_pipe != NULL) {
 494                         usbd_abort_pipe(sc->sc_bulkin_pipe);
 495                         usbd_close_pipe(sc->sc_bulkin_pipe);
 496                         sc->sc_bulkin_pipe = NULL;
 497                 }
 498                 if (sc->sc_bulkout_pipe != NULL) {
 499                         usbd_abort_pipe(sc->sc_bulkout_pipe);
 500                         usbd_close_pipe(sc->sc_bulkout_pipe);
 501                         sc->sc_bulkout_pipe = NULL;
 502                 }
 503         }
 504
 505         if (sc->sc_bulkin_buffer) {
 506                 free(sc->sc_bulkin_buffer, M_USBDEV);
 507                 sc->sc_bulkin_buffer = NULL;
 508         }
 509         if (sc->sc_bulkout_buffer) {
 510                 free(sc->sc_bulkout_buffer, M_USBDEV);
 511                 sc->sc_bulkout_buffer = NULL;
 512         }
 513
 514         sc->sc_state &= ~USCANNER_OPEN;
 515 }
 516
 517 static int
 518 uscanner_do_read(struct uscanner_softc *sc, struct uio *uio, int flag)
 519 {
 520         u_int32_t n, tn;
 521         usbd_status err;
 522         int error = 0;
 523
 524         DPRINTFN(5, ("%s: uscannerread\n", device_get_nameunit(sc->sc_dev)));
 525
 526         if (sc->sc_dying)
 527                 return (EIO);
 528
 529         while ((n = min(sc->sc_bulkin_bufferlen, uio->uio_resid)) != 0) {
 530                 DPRINTFN(1, ("uscannerread: start transfer %d bytes\n",n));
 531                 tn = n;
 532
 533                 err = usbd_bulk_transfer(
 534                         sc->sc_bulkin_xfer, sc->sc_bulkin_pipe,
 535                         USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
 536                         sc->sc_bulkin_buffer, &tn,
 537                         "uscnrb");
 538                 if (err) {
 539                         if (err == USBD_INTERRUPTED)
 540                                 error = EINTR;
 541                         else if (err == USBD_TIMEOUT)
 542                                 error = ETIMEDOUT;
 543                         else
 544                                 error = EIO;
 545                         break;
 546                 }
 547                 DPRINTFN(1, ("uscannerread: got %d bytes\n", tn));
 548                 error = uiomove(sc->sc_bulkin_buffer, tn, uio);
 549                 if (error || tn < n)
 550                         break;
 551         }
 552
 553         return (error);
 554 }
 555
 556 int
 557 uscannerread(struct cdev *dev, struct uio *uio, int flag)
 558 {
 559         struct uscanner_softc *sc;
 560         int error;
 561
 562         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
 563         sc->sc_refcnt++;
 564         error = uscanner_do_read(sc, uio, flag);
 565         if (--sc->sc_refcnt < 0)
 566                 usb_detach_wakeup(sc->sc_dev);
 567
 568         return (error);
 569 }
 570
 571 static int
 572 uscanner_do_write(struct uscanner_softc *sc, struct uio *uio, int flag)
 573 {
 574         u_int32_t n;
 575         int error = 0;
 576         usbd_status err;
 577
 578         DPRINTFN(5, ("%s: uscanner_do_write\n", device_get_nameunit(sc->sc_dev)));
 579
 580         if (sc->sc_dying)
 581                 return (EIO);
 582
 583         while ((n = min(sc->sc_bulkout_bufferlen, uio->uio_resid)) != 0) {
 584                 error = uiomove(sc->sc_bulkout_buffer, n, uio);
 585                 if (error)
 586                         break;
 587                 DPRINTFN(1, ("uscanner_do_write: transfer %d bytes\n", n));
 588                 err = usbd_bulk_transfer(
 589                         sc->sc_bulkout_xfer, sc->sc_bulkout_pipe,
 590                         0, USBD_NO_TIMEOUT,
 591                         sc->sc_bulkout_buffer, &n,
 592                         "uscnwb");
 593                 if (err) {
 594                         if (err == USBD_INTERRUPTED)
 595                                 error = EINTR;
 596                         else
 597                                 error = EIO;
 598                         break;
 599                 }
 600         }
 601
 602         return (error);
 603 }
 604
 605 int
 606 uscannerwrite(struct cdev *dev, struct uio *uio, int flag)
 607 {
 608         struct uscanner_softc *sc;
 609         int error;
 610
 611         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
 612         sc->sc_refcnt++;
 613         error = uscanner_do_write(sc, uio, flag);
 614         if (--sc->sc_refcnt < 0)
 615                 usb_detach_wakeup(sc->sc_dev);
 616         return (error);
 617 }
 618
 619 static int
 620 uscanner_detach(device_t self)
 621 {
 622         struct uscanner_softc *sc = device_get_softc(self);
 623         int s;
 624
 625         DPRINTF(("uscanner_detach: sc=%p\n", sc));
 626
 627         sc->sc_dying = 1;
 628         sc->sc_dev_flags = 0;   /* make close really close device */
 629
 630         /* Abort all pipes.  Causes processes waiting for transfer to wake. */
 631         if (sc->sc_bulkin_pipe != NULL)
 632                 usbd_abort_pipe(sc->sc_bulkin_pipe);
 633         if (sc->sc_bulkout_pipe != NULL)
 634                 usbd_abort_pipe(sc->sc_bulkout_pipe);
 635
 636         s = splusb();
 637         if (--sc->sc_refcnt >= 0) {
 638                 /* Wait for processes to go away. */
 639                 usb_detach_wait(sc->sc_dev);
 640         }
 641         splx(s);
 642
 643         /* destroy the device for the control endpoint */
 644         destroy_dev(sc->dev);
 645         usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
 646
 647         return (0);
 648 }
 649
 650 int
 651 uscannerpoll(struct cdev *dev, int events, struct thread *p)
 652 {
 653         struct uscanner_softc *sc;
 654         int revents = 0;
 655
 656         sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
 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 |= events &
 666                    (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
 667
 668         return (revents);
 669 }
 670
 671 MODULE_DEPEND(uscanner, usb, 1, 1, 1);
 672 DRIVER_MODULE(uscanner, uhub, uscanner_driver, uscanner_devclass, usbd_driver_load, 0);