freebsd-dev/sys/dev/usb/uscanner.c
Luigi Rizzo cf1a10e8c0 Add entries for Epson multifunction scanner/printer/card readers,
with all functions supported. This is done adding usb device IDs
to the table of recognised devices (because there is no standard
'scanner' class, so no other way to recognise them), and with
a small change to the uscanner attach routine that prevents
reconfiguring the whole USB device while we are dealing only with
one of its USB interfaces.

The latter part has been suggested by Steinar Hamre in
http://www.freebsd.org/cgi/query-pr.cgi?pr=107665 , i have
only added a bit of explaination to the code.

I have personally tried this on the Epson DX-5050 and DX-6000
devices (on the US market they have different names, CX-something).
I have good reasons to think that, possibly with the mere addition
of more USB ids to the table in uscanner.c, this should work with
all Epson multifunction devices in that family (from DX-3800 to
DX-7000 - these units are in the 50-120$ price range).
More details on related topics (SANE configuration, OCR, etc.)
at http://info.iet.unipi.it/~luigi/FreeBSD/dx5050.html

Manpage updates coming soon.

Approved by: re, imp
MFC after: 3 days
2007-10-05 07:26:39 +00:00

704 lines
21 KiB
C

/* $NetBSD: uscanner.c,v 1.30 2002/07/11 21:14:36 augustss Exp$ */
/* Also already merged from NetBSD:
* $NetBSD: uscanner.c,v 1.33 2002/09/23 05:51:24 simonb Exp $
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
/*-
* Copyright (c) 2000 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Lennart Augustsson (lennart@augustsson.net) at
* Carlstedt Research & Technology
* and Nick Hibma (n_hibma@qubesoft.com).
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the NetBSD
* Foundation, Inc. and its contributors.
* 4. Neither the name of The NetBSD Foundation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/malloc.h>
#include <sys/module.h>
#include <sys/bus.h>
#include <sys/conf.h>
#include <sys/fcntl.h>
#include <sys/filio.h>
#include <sys/tty.h>
#include <sys/file.h>
#include <sys/selinfo.h>
#include <sys/proc.h>
#include <sys/poll.h>
#include <sys/conf.h>
#include <sys/sysctl.h>
#include <sys/uio.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include "usbdevs.h"
#ifdef USB_DEBUG
#define DPRINTF(x) if (uscannerdebug) printf x
#define DPRINTFN(n,x) if (uscannerdebug>(n)) printf x
int uscannerdebug = 0;
SYSCTL_NODE(_hw_usb, OID_AUTO, uscanner, CTLFLAG_RW, 0, "USB uscanner");
SYSCTL_INT(_hw_usb_uscanner, OID_AUTO, debug, CTLFLAG_RW,
&uscannerdebug, 0, "uscanner debug level");
#else
#define DPRINTF(x)
#define DPRINTFN(n,x)
#endif
struct uscan_info {
struct usb_devno devno;
u_int flags;
#define USC_KEEP_OPEN 1
};
/* Table of scanners that may work with this driver. */
static const struct uscan_info uscanner_devs[] = {
/* Acer Peripherals */
{{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_320U }, 0 },
{{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_4300U }, 0 },
{{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_640U }, 0 },
{{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_640BT }, 0 },
{{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_620U }, 0 },
{{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_1240U }, 0 },
{{ USB_VENDOR_ACERP, USB_PRODUCT_ACERP_ACERSCAN_C310U }, 0 },
/* AGFA */
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1236U }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCAN1212U2 }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANTOUCH }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE40 }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE50 }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE20 }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE25 }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE26 }, 0 },
{{ USB_VENDOR_AGFA, USB_PRODUCT_AGFA_SNAPSCANE52 }, 0 },
/* Avision */
{{ USB_VENDOR_AVISION, USB_PRODUCT_AVISION_1200U }, 0 },
/* Canon */
{{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N656U }, 0 },
{{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N676U }, 0 },
{{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N1220U }, 0 },
{{ USB_VENDOR_CANON, USB_PRODUCT_CANON_D660U }, 0 },
{{ USB_VENDOR_CANON, USB_PRODUCT_CANON_N1240U }, 0 },
{{ USB_VENDOR_CANON, USB_PRODUCT_CANON_LIDE25 }, 0 },
/* Kye */
{{ USB_VENDOR_KYE, USB_PRODUCT_KYE_VIVIDPRO }, 0 },
/* HP */
{{ USB_VENDOR_HP, USB_PRODUCT_HP_2200C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_3300C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_3400CSE }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_4100C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_4200C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_4300C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_4670V }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_S20 }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_5200C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_5300C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_5400C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_6200C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_6300C }, 0 },
{{ USB_VENDOR_HP, USB_PRODUCT_HP_82x0C }, 0 },
/* Microtek */
{{ USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_336CX }, 0 },
{{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_X6U }, 0 },
{{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX }, 0 },
{{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_336CX2 }, 0 },
{{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_C6 }, 0 },
{{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL }, 0 },
{{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6USL2 }, 0 },
{{ USB_VENDOR_MICROTEK, USB_PRODUCT_MICROTEK_V6UL }, 0 },
/* Minolta */
{{ USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_5400 }, 0 },
/* Mustek */
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CU }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_BEARPAW1200F }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_BEARPAW1200TA }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600USB }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_600CU }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USB }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200UB }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200USBPLUS }, 0 },
{{ USB_VENDOR_MUSTEK, USB_PRODUCT_MUSTEK_1200CUPLUS }, 0 },
/* National */
{{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW1200 }, 0 },
{{ USB_VENDOR_NATIONAL, USB_PRODUCT_NATIONAL_BEARPAW2400 }, 0 },
/* Nikon */
{{ USB_VENDOR_NIKON, USB_PRODUCT_NIKON_LS40 }, 0 },
/* Primax */
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2X300 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E300 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2300 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E3002 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_9600 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_600U }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_6200 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_19200 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_1200U }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G600 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_636I }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2600 }, 0 },
{{ USB_VENDOR_PRIMAX, USB_PRODUCT_PRIMAX_G2E600 }, 0 },
/* Epson */
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_636 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_610 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1200 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1240 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1250 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1600 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1640 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_640U }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1650 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1660 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1670 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1260 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_1270 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_RX425 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_3200 }, USC_KEEP_OPEN },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9700F }, USC_KEEP_OPEN },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_GT9300UF }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_2480 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_3500 }, USC_KEEP_OPEN },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_3590 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_4200 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_4990 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_5000 }, 0 },
{{ USB_VENDOR_EPSON, USB_PRODUCT_EPSON_6000 }, 0 },
/* UMAX */
{{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1220U }, 0 },
{{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA1236U }, 0 },
{{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2000U }, 0 },
{{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2100U }, 0 },
{{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA2200U }, 0 },
{{ USB_VENDOR_UMAX, USB_PRODUCT_UMAX_ASTRA3400 }, 0 },
/* Visioneer */
{{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_3000 }, 0 },
{{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_5300 }, 0 },
{{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_7600 }, 0 },
{{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6100 }, 0 },
{{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_6200 }, 0 },
{{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8100 }, 0 },
{{ USB_VENDOR_VISIONEER, USB_PRODUCT_VISIONEER_8600 }, 0 },
/* Ultima */
{{ USB_VENDOR_ULTIMA, USB_PRODUCT_ULTIMA_1200UBPLUS }, 0 },
};
#define uscanner_lookup(v, p) ((const struct uscan_info *)usb_lookup(uscanner_devs, v, p))
#define USCANNER_BUFFERSIZE 1024
struct uscanner_softc {
device_t sc_dev; /* base device */
usbd_device_handle sc_udev;
usbd_interface_handle sc_iface;
struct cdev *dev;
u_int sc_dev_flags;
usbd_pipe_handle sc_bulkin_pipe;
int sc_bulkin;
usbd_xfer_handle sc_bulkin_xfer;
void *sc_bulkin_buffer;
int sc_bulkin_bufferlen;
int sc_bulkin_datalen;
usbd_pipe_handle sc_bulkout_pipe;
int sc_bulkout;
usbd_xfer_handle sc_bulkout_xfer;
void *sc_bulkout_buffer;
int sc_bulkout_bufferlen;
int sc_bulkout_datalen;
u_char sc_state;
#define USCANNER_OPEN 0x01 /* opened */
int sc_refcnt;
u_char sc_dying;
};
d_open_t uscanneropen;
d_close_t uscannerclose;
d_read_t uscannerread;
d_write_t uscannerwrite;
d_poll_t uscannerpoll;
static struct cdevsw uscanner_cdevsw = {
.d_version = D_VERSION,
.d_flags = D_NEEDGIANT,
.d_open = uscanneropen,
.d_close = uscannerclose,
.d_read = uscannerread,
.d_write = uscannerwrite,
.d_poll = uscannerpoll,
.d_name = "uscanner",
};
static int uscanner_do_read(struct uscanner_softc *, struct uio *, int);
static int uscanner_do_write(struct uscanner_softc *, struct uio *, int);
static void uscanner_do_close(struct uscanner_softc *);
#define USCANNERUNIT(n) (minor(n))
static device_probe_t uscanner_match;
static device_attach_t uscanner_attach;
static device_detach_t uscanner_detach;
static device_method_t uscanner_methods[] = {
/* Device interface */
DEVMETHOD(device_probe, uscanner_match),
DEVMETHOD(device_attach, uscanner_attach),
DEVMETHOD(device_detach, uscanner_detach),
{ 0, 0 }
};
static driver_t uscanner_driver = {
"uscanner",
uscanner_methods,
sizeof(struct uscanner_softc)
};
static devclass_t uscanner_devclass;
static int
uscanner_match(device_t self)
{
struct usb_attach_arg *uaa = device_get_ivars(self);
usb_interface_descriptor_t *id;
if (uaa->iface == NULL)
return UMATCH_NONE; /* do not grab the entire device */
if (uscanner_lookup(uaa->vendor, uaa->product) == NULL)
return UMATCH_NONE; /* not in the list of known devices */
id = usbd_get_interface_descriptor(uaa->iface);
if (id == NULL)
return UMATCH_NONE;
/*
* There isn't a specific UICLASS for scanners, many vendors use
* UICLASS_VENDOR, so detecting the right interface is not so easy.
* But certainly we can exclude PRINTER and MASS - which some
* multifunction devices implement.
*/
if (id->bInterfaceClass == UICLASS_PRINTER ||
id->bInterfaceClass == UICLASS_MASS)
return UMATCH_NONE;
return UMATCH_VENDOR_PRODUCT; /* ok we found it */
}
static int
uscanner_attach(device_t self)
{
struct uscanner_softc *sc = device_get_softc(self);
struct usb_attach_arg *uaa = device_get_ivars(self);
usb_interface_descriptor_t *id = 0;
usb_endpoint_descriptor_t *ed, *ed_bulkin = NULL, *ed_bulkout = NULL;
int i;
usbd_status err;
int ifnum;
sc->sc_dev = self;
sc->sc_dev_flags = uscanner_lookup(uaa->vendor, uaa->product)->flags;
sc->sc_udev = uaa->device;
id = usbd_get_interface_descriptor(uaa->iface);
ifnum = id->bInterfaceNumber;
#if 0
/*
* This was in the original driver, but we cannot change the
* configuration of the whole device while attaching only to
* one of its interfaces. This can kill other already-attached
* driver, and/or possibly prevent this driver from attaching
* if an error occurs in set_config_no.
* If a device need setting the configuration, this must be done
* before attaching drivers to the various interfaces.
*/
err = usbd_set_config_no(uaa->device, 1, 1); /* XXX */
if (err) {
printf("%s: setting config no failed\n",
device_get_nameunit(sc->sc_dev));
return ENXIO;
}
#endif
err = usbd_device2interface_handle(sc->sc_udev, ifnum, &sc->sc_iface);
if (!err && sc->sc_iface)
id = usbd_get_interface_descriptor(sc->sc_iface);
if (err || id == 0) {
printf("%s: could not get interface descriptor, err=%d,id=%p\n",
device_get_nameunit(sc->sc_dev), err, id);
return ENXIO;
}
/* Find the two first bulk endpoints */
for (i = 0 ; i < id->bNumEndpoints; i++) {
ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
if (ed == 0) {
printf("%s: could not read endpoint descriptor\n",
device_get_nameunit(sc->sc_dev));
return ENXIO;
}
if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
&& (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
ed_bulkin = ed;
} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
&& (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
ed_bulkout = ed;
}
if (ed_bulkin && ed_bulkout) /* found all we need */
break;
}
/* Verify that we goething sensible */
if (ed_bulkin == NULL || ed_bulkout == NULL) {
printf("%s: bulk-in and/or bulk-out endpoint not found\n",
device_get_nameunit(sc->sc_dev));
return ENXIO;
}
sc->sc_bulkin = ed_bulkin->bEndpointAddress;
sc->sc_bulkout = ed_bulkout->bEndpointAddress;
/* the main device, ctrl endpoint */
sc->dev = make_dev(&uscanner_cdevsw, device_get_unit(sc->sc_dev),
UID_ROOT, GID_OPERATOR, 0644, "%s", device_get_nameunit(sc->sc_dev));
usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,sc->sc_dev);
return 0;
}
int
uscanneropen(struct cdev *dev, int flag, int mode, struct thread *p)
{
struct uscanner_softc *sc;
int unit = USCANNERUNIT(dev);
usbd_status err;
sc = devclass_get_softc(uscanner_devclass, unit);
if (sc == NULL)
return (ENXIO);
DPRINTFN(5, ("uscanneropen: flag=%d, mode=%d, unit=%d\n",
flag, mode, unit));
if (sc->sc_dying)
return (ENXIO);
if (sc->sc_state & USCANNER_OPEN)
return (EBUSY);
sc->sc_state |= USCANNER_OPEN;
sc->sc_bulkin_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
sc->sc_bulkout_buffer = malloc(USCANNER_BUFFERSIZE, M_USBDEV, M_WAITOK);
/* No need to check buffers for NULL since we have WAITOK */
sc->sc_bulkin_bufferlen = USCANNER_BUFFERSIZE;
sc->sc_bulkout_bufferlen = USCANNER_BUFFERSIZE;
/* We have decided on which endpoints to use, now open the pipes */
if (sc->sc_bulkin_pipe == NULL) {
err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin,
USBD_EXCLUSIVE_USE, &sc->sc_bulkin_pipe);
if (err) {
printf("%s: cannot open bulk-in pipe (addr %d)\n",
device_get_nameunit(sc->sc_dev), sc->sc_bulkin);
uscanner_do_close(sc);
return (EIO);
}
}
if (sc->sc_bulkout_pipe == NULL) {
err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout,
USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
if (err) {
printf("%s: cannot open bulk-out pipe (addr %d)\n",
device_get_nameunit(sc->sc_dev), sc->sc_bulkout);
uscanner_do_close(sc);
return (EIO);
}
}
sc->sc_bulkin_xfer = usbd_alloc_xfer(sc->sc_udev);
if (sc->sc_bulkin_xfer == NULL) {
uscanner_do_close(sc);
return (ENOMEM);
}
sc->sc_bulkout_xfer = usbd_alloc_xfer(sc->sc_udev);
if (sc->sc_bulkout_xfer == NULL) {
uscanner_do_close(sc);
return (ENOMEM);
}
return (0); /* success */
}
int
uscannerclose(struct cdev *dev, int flag, int mode, struct thread *p)
{
struct uscanner_softc *sc;
sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
DPRINTFN(5, ("uscannerclose: flag=%d, mode=%d, unit=%d\n",
flag, mode, USCANNERUNIT(dev)));
#ifdef DIAGNOSTIC
if (!(sc->sc_state & USCANNER_OPEN)) {
printf("uscannerclose: not open\n");
return (EINVAL);
}
#endif
uscanner_do_close(sc);
return (0);
}
void
uscanner_do_close(struct uscanner_softc *sc)
{
if (sc->sc_bulkin_xfer) {
usbd_free_xfer(sc->sc_bulkin_xfer);
sc->sc_bulkin_xfer = NULL;
}
if (sc->sc_bulkout_xfer) {
usbd_free_xfer(sc->sc_bulkout_xfer);
sc->sc_bulkout_xfer = NULL;
}
if (!(sc->sc_dev_flags & USC_KEEP_OPEN)) {
if (sc->sc_bulkin_pipe != NULL) {
usbd_abort_pipe(sc->sc_bulkin_pipe);
usbd_close_pipe(sc->sc_bulkin_pipe);
sc->sc_bulkin_pipe = NULL;
}
if (sc->sc_bulkout_pipe != NULL) {
usbd_abort_pipe(sc->sc_bulkout_pipe);
usbd_close_pipe(sc->sc_bulkout_pipe);
sc->sc_bulkout_pipe = NULL;
}
}
if (sc->sc_bulkin_buffer) {
free(sc->sc_bulkin_buffer, M_USBDEV);
sc->sc_bulkin_buffer = NULL;
}
if (sc->sc_bulkout_buffer) {
free(sc->sc_bulkout_buffer, M_USBDEV);
sc->sc_bulkout_buffer = NULL;
}
sc->sc_state &= ~USCANNER_OPEN;
}
static int
uscanner_do_read(struct uscanner_softc *sc, struct uio *uio, int flag)
{
u_int32_t n, tn;
usbd_status err;
int error = 0;
DPRINTFN(5, ("%s: uscannerread\n", device_get_nameunit(sc->sc_dev)));
if (sc->sc_dying)
return (EIO);
while ((n = min(sc->sc_bulkin_bufferlen, uio->uio_resid)) != 0) {
DPRINTFN(1, ("uscannerread: start transfer %d bytes\n",n));
tn = n;
err = usbd_bulk_transfer(
sc->sc_bulkin_xfer, sc->sc_bulkin_pipe,
USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
sc->sc_bulkin_buffer, &tn,
"uscnrb");
if (err) {
if (err == USBD_INTERRUPTED)
error = EINTR;
else if (err == USBD_TIMEOUT)
error = ETIMEDOUT;
else
error = EIO;
break;
}
DPRINTFN(1, ("uscannerread: got %d bytes\n", tn));
error = uiomove(sc->sc_bulkin_buffer, tn, uio);
if (error || tn < n)
break;
}
return (error);
}
int
uscannerread(struct cdev *dev, struct uio *uio, int flag)
{
struct uscanner_softc *sc;
int error;
sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
sc->sc_refcnt++;
error = uscanner_do_read(sc, uio, flag);
if (--sc->sc_refcnt < 0)
usb_detach_wakeup(sc->sc_dev);
return (error);
}
static int
uscanner_do_write(struct uscanner_softc *sc, struct uio *uio, int flag)
{
u_int32_t n;
int error = 0;
usbd_status err;
DPRINTFN(5, ("%s: uscanner_do_write\n", device_get_nameunit(sc->sc_dev)));
if (sc->sc_dying)
return (EIO);
while ((n = min(sc->sc_bulkout_bufferlen, uio->uio_resid)) != 0) {
error = uiomove(sc->sc_bulkout_buffer, n, uio);
if (error)
break;
DPRINTFN(1, ("uscanner_do_write: transfer %d bytes\n", n));
err = usbd_bulk_transfer(
sc->sc_bulkout_xfer, sc->sc_bulkout_pipe,
0, USBD_NO_TIMEOUT,
sc->sc_bulkout_buffer, &n,
"uscnwb");
if (err) {
if (err == USBD_INTERRUPTED)
error = EINTR;
else
error = EIO;
break;
}
}
return (error);
}
int
uscannerwrite(struct cdev *dev, struct uio *uio, int flag)
{
struct uscanner_softc *sc;
int error;
sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
sc->sc_refcnt++;
error = uscanner_do_write(sc, uio, flag);
if (--sc->sc_refcnt < 0)
usb_detach_wakeup(sc->sc_dev);
return (error);
}
static int
uscanner_detach(device_t self)
{
struct uscanner_softc *sc = device_get_softc(self);
int s;
DPRINTF(("uscanner_detach: sc=%p\n", sc));
sc->sc_dying = 1;
sc->sc_dev_flags = 0; /* make close really close device */
/* Abort all pipes. Causes processes waiting for transfer to wake. */
if (sc->sc_bulkin_pipe != NULL)
usbd_abort_pipe(sc->sc_bulkin_pipe);
if (sc->sc_bulkout_pipe != NULL)
usbd_abort_pipe(sc->sc_bulkout_pipe);
s = splusb();
if (--sc->sc_refcnt >= 0) {
/* Wait for processes to go away. */
usb_detach_wait(sc->sc_dev);
}
splx(s);
/* destroy the device for the control endpoint */
destroy_dev(sc->dev);
usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
return (0);
}
int
uscannerpoll(struct cdev *dev, int events, struct thread *p)
{
struct uscanner_softc *sc;
int revents = 0;
sc = devclass_get_softc(uscanner_devclass, USCANNERUNIT(dev));
if (sc->sc_dying)
return (EIO);
/*
* We have no easy way of determining if a read will
* yield any data or a write will happen.
* Pretend they will.
*/
revents |= events &
(POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
return (revents);
}
MODULE_DEPEND(uscanner, usb, 1, 1, 1);
DRIVER_MODULE(uscanner, uhub, uscanner_driver, uscanner_devclass, usbd_driver_load, 0);