Home | History | Annotate | Line # | Download | only in usb
usscanner.c revision 1.3
      1  1.3  augustss /*	$NetBSD: usscanner.c,v 1.3 2001/01/11 06:33:22 augustss Exp $	*/
      2  1.1  augustss 
      3  1.1  augustss /*
      4  1.3  augustss  * Copyright (c) 2001 The NetBSD Foundation, Inc.
      5  1.1  augustss  * All rights reserved.
      6  1.1  augustss  *
      7  1.1  augustss  * This code is derived from software contributed to The NetBSD Foundation
      8  1.1  augustss  * by Lennart Augustsson (lennart (at) augustsson.net) and LLoyd Parkes.
      9  1.1  augustss  *
     10  1.1  augustss  * Redistribution and use in source and binary forms, with or without
     11  1.1  augustss  * modification, are permitted provided that the following conditions
     12  1.1  augustss  * are met:
     13  1.1  augustss  * 1. Redistributions of source code must retain the above copyright
     14  1.1  augustss  *    notice, this list of conditions and the following disclaimer.
     15  1.1  augustss  * 2. Redistributions in binary form must reproduce the above copyright
     16  1.1  augustss  *    notice, this list of conditions and the following disclaimer in the
     17  1.1  augustss  *    documentation and/or other materials provided with the distribution.
     18  1.1  augustss  * 3. All advertising materials mentioning features or use of this software
     19  1.1  augustss  *    must display the following acknowledgement:
     20  1.1  augustss  *        This product includes software developed by the NetBSD
     21  1.1  augustss  *        Foundation, Inc. and its contributors.
     22  1.1  augustss  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  1.1  augustss  *    contributors may be used to endorse or promote products derived
     24  1.1  augustss  *    from this software without specific prior written permission.
     25  1.1  augustss  *
     26  1.1  augustss  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  1.1  augustss  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  1.1  augustss  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  1.1  augustss  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  1.1  augustss  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  1.1  augustss  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  1.1  augustss  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  1.1  augustss  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  1.1  augustss  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  1.1  augustss  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  1.1  augustss  * POSSIBILITY OF SUCH DAMAGE.
     37  1.1  augustss  */
     38  1.1  augustss 
     39  1.2  augustss /*
     40  1.2  augustss  * This driver is partly based on information taken from the Linux driver
     41  1.2  augustss  * by John Fremlin, Oliver Neukum, and Jeremy Hall.
     42  1.2  augustss  */
     43  1.3  augustss /*
     44  1.3  augustss  * Protocol:
     45  1.3  augustss  * Send raw SCSI command on the bulk-out pipe.
     46  1.3  augustss  * If output command then
     47  1.3  augustss  *     send further data on the bulk-out pipe
     48  1.3  augustss  * else if input command then
     49  1.3  augustss  *     read data on the bulk-in pipe
     50  1.3  augustss  * else
     51  1.3  augustss  *     don't do anything.
     52  1.3  augustss  * Read status byte on the interrupt pipe (which doesn't seem to be
     53  1.3  augustss  * an interrupt pipe at all).  This operations sometimes times out.
     54  1.3  augustss  */
     55  1.2  augustss 
     56  1.1  augustss #include <sys/param.h>
     57  1.1  augustss #include <sys/systm.h>
     58  1.1  augustss #include <sys/kernel.h>
     59  1.1  augustss #include <sys/malloc.h>
     60  1.1  augustss #include <sys/device.h>
     61  1.1  augustss #include <sys/conf.h>
     62  1.1  augustss #include <sys/buf.h>
     63  1.1  augustss 
     64  1.1  augustss #include <dev/usb/usb.h>
     65  1.1  augustss #include <dev/usb/usbdi.h>
     66  1.1  augustss #include <dev/usb/usbdi_util.h>
     67  1.1  augustss 
     68  1.1  augustss #include <dev/usb/usbdevs.h>
     69  1.1  augustss 
     70  1.1  augustss #include <sys/scsiio.h>
     71  1.1  augustss #include <dev/scsipi/scsi_all.h>
     72  1.1  augustss #include <dev/scsipi/scsipi_all.h>
     73  1.1  augustss #include <dev/scsipi/scsiconf.h>
     74  1.1  augustss #include <dev/scsipi/atapiconf.h>
     75  1.1  augustss 
     76  1.1  augustss #ifdef USSCANNER_DEBUG
     77  1.1  augustss #define DPRINTF(x)	if (usscannerdebug) logprintf x
     78  1.1  augustss #define DPRINTFN(n,x)	if (usscannerdebug>(n)) logprintf x
     79  1.2  augustss int	usscannerdebug = 0;
     80  1.1  augustss #else
     81  1.1  augustss #define DPRINTF(x)
     82  1.1  augustss #define DPRINTFN(n,x)
     83  1.1  augustss #endif
     84  1.1  augustss 
     85  1.1  augustss 
     86  1.1  augustss #define USSCANNER_CONFIG_NO		1
     87  1.1  augustss #define USSCANNER_IFACE_IDX		0
     88  1.1  augustss 
     89  1.1  augustss #define USSCANNER_SCSIID_HOST	0x00
     90  1.1  augustss #define USSCANNER_SCSIID_DEVICE	0x01
     91  1.1  augustss 
     92  1.1  augustss #define USSCANNER_MAX_TRANSFER_SIZE	MAXBSIZE
     93  1.1  augustss 
     94  1.1  augustss #define USSCANNER_TIMEOUT 2000
     95  1.1  augustss 
     96  1.1  augustss Static struct scsipi_device usscanner_dev =
     97  1.1  augustss {
     98  1.1  augustss 	NULL,			/* Use default error handler */
     99  1.1  augustss 	NULL,			/* have a queue, served by this */
    100  1.1  augustss 	NULL,			/* have no async handler */
    101  1.1  augustss 	NULL,			/* Use default 'done' routine */
    102  1.1  augustss };
    103  1.1  augustss 
    104  1.1  augustss struct usscanner_softc {
    105  1.1  augustss  	USBBASEDEVICE		sc_dev;
    106  1.1  augustss 	usbd_device_handle	sc_udev;
    107  1.1  augustss 	usbd_interface_handle	sc_iface;
    108  1.1  augustss 
    109  1.1  augustss 	int			sc_in_addr;
    110  1.1  augustss 	usbd_pipe_handle	sc_in_pipe;
    111  1.1  augustss 
    112  1.1  augustss 	int			sc_intr_addr;
    113  1.1  augustss 	usbd_pipe_handle	sc_intr_pipe;
    114  1.1  augustss 	usbd_xfer_handle	sc_intr_xfer;
    115  1.1  augustss 	u_char			sc_status;
    116  1.1  augustss 
    117  1.1  augustss 	int			sc_out_addr;
    118  1.1  augustss 	usbd_pipe_handle	sc_out_pipe;
    119  1.1  augustss 
    120  1.1  augustss 	usbd_xfer_handle	sc_cmd_xfer;
    121  1.1  augustss 	void			*sc_cmd_buffer;
    122  1.1  augustss 	usbd_xfer_handle	sc_data_xfer;
    123  1.1  augustss 	void			*sc_data_buffer;
    124  1.1  augustss 
    125  1.1  augustss 	int			sc_state;
    126  1.1  augustss #define UAS_IDLE	0
    127  1.1  augustss #define UAS_CMD		1
    128  1.1  augustss #define UAS_DATA	2
    129  1.1  augustss #define UAS_SENSECMD	3
    130  1.1  augustss #define UAS_SENSEDATA	4
    131  1.1  augustss #define UAS_STATUS	5
    132  1.1  augustss 
    133  1.1  augustss 	struct scsipi_xfer	*sc_xs;
    134  1.1  augustss 
    135  1.1  augustss 	device_ptr_t		sc_child;	/* child device, for detach */
    136  1.1  augustss 
    137  1.1  augustss 	struct scsipi_link	sc_link;
    138  1.1  augustss 	struct atapi_adapter	sc_atapi_adapter;
    139  1.1  augustss #define sc_adapter sc_atapi_adapter._generic
    140  1.1  augustss 
    141  1.1  augustss 	int			sc_refcnt;
    142  1.1  augustss 	char			sc_dying;
    143  1.1  augustss };
    144  1.1  augustss 
    145  1.1  augustss 
    146  1.1  augustss Static void usscanner_cleanup(struct usscanner_softc *sc);
    147  1.1  augustss Static int usscanner_scsipi_cmd(struct scsipi_xfer *xs);
    148  1.1  augustss Static void usscanner_scsipi_minphys(struct buf *bp);
    149  1.1  augustss Static void usscanner_done(struct usscanner_softc *sc);
    150  1.1  augustss Static void usscanner_sense(struct usscanner_softc *sc);
    151  1.1  augustss typedef void callback(usbd_xfer_handle, usbd_private_handle, usbd_status);
    152  1.1  augustss Static callback usscanner_intr_cb;
    153  1.1  augustss Static callback usscanner_cmd_cb;
    154  1.1  augustss Static callback usscanner_data_cb;
    155  1.1  augustss Static callback usscanner_sensecmd_cb;
    156  1.1  augustss Static callback usscanner_sensedata_cb;
    157  1.1  augustss 
    158  1.1  augustss USB_DECLARE_DRIVER(usscanner);
    159  1.1  augustss 
    160  1.1  augustss USB_MATCH(usscanner)
    161  1.1  augustss {
    162  1.1  augustss 	USB_MATCH_START(usscanner, uaa);
    163  1.1  augustss 
    164  1.1  augustss 	DPRINTFN(50,("usscanner_match\n"));
    165  1.1  augustss 
    166  1.1  augustss 	if (uaa->iface != NULL)
    167  1.1  augustss 		return (UMATCH_NONE);
    168  1.1  augustss 
    169  1.1  augustss 	if (uaa->vendor == USB_VENDOR_HP &&
    170  1.1  augustss 	    uaa->product == USB_PRODUCT_HP_5300C)
    171  1.1  augustss 		return (UMATCH_VENDOR_PRODUCT);
    172  1.1  augustss 	else
    173  1.1  augustss 		return (UMATCH_NONE);
    174  1.1  augustss }
    175  1.1  augustss 
    176  1.1  augustss USB_ATTACH(usscanner)
    177  1.1  augustss {
    178  1.1  augustss 	USB_ATTACH_START(usscanner, sc, uaa);
    179  1.1  augustss 	usbd_device_handle	dev = uaa->device;
    180  1.1  augustss 	usbd_interface_handle	iface;
    181  1.1  augustss 	char			devinfo[1024];
    182  1.1  augustss 	usbd_status		err;
    183  1.1  augustss 	usb_endpoint_descriptor_t *ed;
    184  1.1  augustss 	u_int8_t		epcount;
    185  1.1  augustss 	int			i;
    186  1.1  augustss 
    187  1.1  augustss 	DPRINTFN(10,("usscanner_attach: sc=%p\n", sc));
    188  1.1  augustss 
    189  1.1  augustss 	usbd_devinfo(dev, 0, devinfo);
    190  1.1  augustss 	USB_ATTACH_SETUP;
    191  1.1  augustss 	printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
    192  1.1  augustss 
    193  1.1  augustss 	err = usbd_set_config_no(dev, USSCANNER_CONFIG_NO, 1);
    194  1.1  augustss 	if (err) {
    195  1.1  augustss 		printf("%s: setting config no failed\n",
    196  1.1  augustss 		    USBDEVNAME(sc->sc_dev));
    197  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    198  1.1  augustss 	}
    199  1.1  augustss 
    200  1.1  augustss 	err = usbd_device2interface_handle(dev, USSCANNER_IFACE_IDX, &iface);
    201  1.1  augustss 	if (err) {
    202  1.1  augustss 		printf("%s: getting interface handle failed\n",
    203  1.1  augustss 		    USBDEVNAME(sc->sc_dev));
    204  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    205  1.1  augustss 	}
    206  1.1  augustss 
    207  1.1  augustss 	sc->sc_udev = dev;
    208  1.1  augustss 	sc->sc_iface = iface;
    209  1.1  augustss 
    210  1.1  augustss 	epcount = 0;
    211  1.1  augustss 	(void)usbd_endpoint_count(iface, &epcount);
    212  1.1  augustss 
    213  1.1  augustss 	sc->sc_in_addr = -1;
    214  1.1  augustss 	sc->sc_intr_addr = -1;
    215  1.1  augustss 	sc->sc_out_addr = -1;
    216  1.1  augustss 	for (i = 0; i < epcount; i++) {
    217  1.1  augustss 		ed = usbd_interface2endpoint_descriptor(iface, i);
    218  1.1  augustss 		if (ed == NULL) {
    219  1.1  augustss 			printf("%s: couldn't get ep %d\n",
    220  1.1  augustss 			    USBDEVNAME(sc->sc_dev), i);
    221  1.1  augustss 			USB_ATTACH_ERROR_RETURN;
    222  1.1  augustss 		}
    223  1.1  augustss 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    224  1.1  augustss 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
    225  1.1  augustss 			sc->sc_in_addr = ed->bEndpointAddress;
    226  1.1  augustss 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    227  1.1  augustss 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
    228  1.1  augustss 			sc->sc_intr_addr = ed->bEndpointAddress;
    229  1.1  augustss 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
    230  1.1  augustss 			   UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
    231  1.1  augustss 			sc->sc_out_addr = ed->bEndpointAddress;
    232  1.1  augustss 		}
    233  1.1  augustss 	}
    234  1.1  augustss 	if (sc->sc_in_addr == -1 || sc->sc_intr_addr == -1 ||
    235  1.1  augustss 	    sc->sc_out_addr == -1) {
    236  1.1  augustss 		printf("%s: missing endpoint\n", USBDEVNAME(sc->sc_dev));
    237  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    238  1.1  augustss 	}
    239  1.1  augustss 
    240  1.1  augustss 	err = usbd_open_pipe(sc->sc_iface, sc->sc_in_addr,
    241  1.1  augustss 			     USBD_EXCLUSIVE_USE, &sc->sc_in_pipe);
    242  1.1  augustss 	if (err) {
    243  1.1  augustss 		printf("%s: open in pipe failed, err=%d\n",
    244  1.1  augustss 		       USBDEVNAME(sc->sc_dev), err);
    245  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    246  1.1  augustss 	}
    247  1.1  augustss 
    248  1.1  augustss 	/* The interrupt endpoint must be opened as a normal pipe. */
    249  1.1  augustss 	err = usbd_open_pipe(sc->sc_iface, sc->sc_intr_addr,
    250  1.1  augustss 			     USBD_EXCLUSIVE_USE, &sc->sc_intr_pipe);
    251  1.1  augustss 
    252  1.1  augustss 	if (err) {
    253  1.1  augustss 		printf("%s: open intr pipe failed, err=%d\n",
    254  1.1  augustss 		       USBDEVNAME(sc->sc_dev), err);
    255  1.1  augustss 		usscanner_cleanup(sc);
    256  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    257  1.1  augustss 	}
    258  1.1  augustss 	err = usbd_open_pipe(sc->sc_iface, sc->sc_out_addr,
    259  1.1  augustss 			     USBD_EXCLUSIVE_USE, &sc->sc_out_pipe);
    260  1.1  augustss 	if (err) {
    261  1.1  augustss 		printf("%s: open out pipe failed, err=%d\n",
    262  1.1  augustss 		       USBDEVNAME(sc->sc_dev), err);
    263  1.1  augustss 		usscanner_cleanup(sc);
    264  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    265  1.1  augustss 	}
    266  1.1  augustss 
    267  1.1  augustss 	sc->sc_cmd_xfer = usbd_alloc_xfer(uaa->device);
    268  1.1  augustss 	if (sc->sc_cmd_xfer == NULL) {
    269  1.1  augustss 		printf("%s: alloc cmd xfer failed, err=%d\n",
    270  1.1  augustss 		       USBDEVNAME(sc->sc_dev), err);
    271  1.1  augustss 		usscanner_cleanup(sc);
    272  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    273  1.1  augustss 	}
    274  1.1  augustss 
    275  1.1  augustss 	/* XXX too big */
    276  1.1  augustss 	sc->sc_cmd_buffer = usbd_alloc_buffer(sc->sc_cmd_xfer,
    277  1.1  augustss 					     USSCANNER_MAX_TRANSFER_SIZE);
    278  1.1  augustss 	if (sc->sc_cmd_buffer == NULL) {
    279  1.1  augustss 		printf("%s: alloc cmd buffer failed, err=%d\n",
    280  1.1  augustss 		       USBDEVNAME(sc->sc_dev), err);
    281  1.1  augustss 		usscanner_cleanup(sc);
    282  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    283  1.1  augustss 	}
    284  1.1  augustss 
    285  1.1  augustss 	sc->sc_intr_xfer = usbd_alloc_xfer (uaa->device);
    286  1.1  augustss 	if (sc->sc_intr_xfer == NULL) {
    287  1.1  augustss 	  printf("%s: alloc intr xfer failed, err=%d\n",
    288  1.1  augustss 		 USBDEVNAME(sc->sc_dev), err);
    289  1.1  augustss 	  usscanner_cleanup(sc);
    290  1.1  augustss 	  USB_ATTACH_ERROR_RETURN;
    291  1.1  augustss         }
    292  1.1  augustss 
    293  1.1  augustss 	sc->sc_data_xfer = usbd_alloc_xfer(uaa->device);
    294  1.1  augustss 	if (sc->sc_data_xfer == NULL) {
    295  1.1  augustss 		printf("%s: alloc data xfer failed, err=%d\n",
    296  1.1  augustss 		       USBDEVNAME(sc->sc_dev), err);
    297  1.1  augustss 		usscanner_cleanup(sc);
    298  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    299  1.1  augustss 	}
    300  1.1  augustss 	sc->sc_data_buffer = usbd_alloc_buffer(sc->sc_data_xfer,
    301  1.1  augustss 					      USSCANNER_MAX_TRANSFER_SIZE);
    302  1.1  augustss 	if (sc->sc_data_buffer == NULL) {
    303  1.1  augustss 		printf("%s: alloc data buffer failed, err=%d\n",
    304  1.1  augustss 		       USBDEVNAME(sc->sc_dev), err);
    305  1.1  augustss 		usscanner_cleanup(sc);
    306  1.1  augustss 		USB_ATTACH_ERROR_RETURN;
    307  1.1  augustss 	}
    308  1.1  augustss 
    309  1.1  augustss 	/*
    310  1.1  augustss 	 * Fill in the adapter.
    311  1.1  augustss 	 */
    312  1.1  augustss 	sc->sc_adapter.scsipi_cmd = usscanner_scsipi_cmd;
    313  1.1  augustss 	sc->sc_adapter.scsipi_minphys = usscanner_scsipi_minphys;
    314  1.1  augustss 
    315  1.1  augustss 	/*
    316  1.1  augustss 	 * fill in the prototype scsipi_link.
    317  1.1  augustss 	 */
    318  1.1  augustss 	sc->sc_link.type = BUS_SCSI;
    319  1.1  augustss 	sc->sc_link.scsipi_scsi.channel = SCSI_CHANNEL_ONLY_ONE;
    320  1.1  augustss 	sc->sc_link.adapter_softc = sc;
    321  1.1  augustss 	sc->sc_link.scsipi_scsi.adapter_target = USSCANNER_SCSIID_HOST;
    322  1.1  augustss 	sc->sc_link.adapter = &sc->sc_adapter;
    323  1.1  augustss 	sc->sc_link.device = &usscanner_dev;
    324  1.1  augustss 	sc->sc_link.openings = 1;
    325  1.1  augustss 	sc->sc_link.scsipi_scsi.max_target = USSCANNER_SCSIID_DEVICE;
    326  1.1  augustss 	sc->sc_link.scsipi_scsi.max_lun = 0;
    327  1.1  augustss 
    328  1.1  augustss 	sc->sc_child = config_found(&sc->sc_dev, &sc->sc_link, scsiprint);
    329  1.1  augustss 
    330  1.1  augustss 	DPRINTFN(10, ("usscanner_attach: %p\n", sc->sc_udev));
    331  1.1  augustss 
    332  1.1  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
    333  1.1  augustss 			   USBDEV(sc->sc_dev));
    334  1.1  augustss 
    335  1.1  augustss 	USB_ATTACH_SUCCESS_RETURN;
    336  1.1  augustss }
    337  1.1  augustss 
    338  1.1  augustss USB_DETACH(usscanner)
    339  1.1  augustss {
    340  1.1  augustss 	USB_DETACH_START(usscanner, sc);
    341  1.1  augustss 	int rv, s;
    342  1.1  augustss 
    343  1.1  augustss 	DPRINTF(("usscanner_detach: sc=%p flags=%d\n", sc, flags));
    344  1.1  augustss 
    345  1.1  augustss 	sc->sc_dying = 1;
    346  1.1  augustss 	/* Abort all pipes.  Causes processes waiting for transfer to wake. */
    347  1.1  augustss 	if (sc->sc_in_pipe != NULL)
    348  1.1  augustss 		usbd_abort_pipe(sc->sc_in_pipe);
    349  1.1  augustss 	if (sc->sc_intr_pipe != NULL)
    350  1.1  augustss 		usbd_abort_pipe(sc->sc_intr_pipe);
    351  1.1  augustss 	if (sc->sc_out_pipe != NULL)
    352  1.1  augustss 		usbd_abort_pipe(sc->sc_out_pipe);
    353  1.1  augustss 
    354  1.1  augustss 	s = splusb();
    355  1.1  augustss 	if (--sc->sc_refcnt >= 0) {
    356  1.1  augustss 		/* Wait for processes to go away. */
    357  1.1  augustss 		usb_detach_wait(USBDEV(sc->sc_dev));
    358  1.1  augustss 	}
    359  1.1  augustss 	splx(s);
    360  1.1  augustss 
    361  1.1  augustss 	if (sc->sc_child != NULL)
    362  1.1  augustss 		rv = config_detach(sc->sc_child, flags);
    363  1.1  augustss 	else
    364  1.1  augustss 		rv = 0;
    365  1.1  augustss 
    366  1.1  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
    367  1.1  augustss 			   USBDEV(sc->sc_dev));
    368  1.1  augustss 
    369  1.1  augustss 	return (rv);
    370  1.1  augustss }
    371  1.1  augustss 
    372  1.1  augustss Static void
    373  1.1  augustss usscanner_cleanup(struct usscanner_softc *sc)
    374  1.1  augustss {
    375  1.1  augustss 	if (sc->sc_in_pipe != NULL) {
    376  1.1  augustss 		usbd_close_pipe(sc->sc_in_pipe);
    377  1.1  augustss 		sc->sc_in_pipe = NULL;
    378  1.1  augustss 	}
    379  1.1  augustss 	if (sc->sc_intr_pipe != NULL) {
    380  1.1  augustss 		usbd_close_pipe(sc->sc_intr_pipe);
    381  1.1  augustss 		sc->sc_intr_pipe = NULL;
    382  1.1  augustss 	}
    383  1.1  augustss 	if (sc->sc_out_pipe != NULL) {
    384  1.1  augustss 		usbd_close_pipe(sc->sc_out_pipe);
    385  1.1  augustss 		sc->sc_out_pipe = NULL;
    386  1.1  augustss 	}
    387  1.1  augustss 	if (sc->sc_cmd_xfer != NULL) {
    388  1.1  augustss 		usbd_free_xfer(sc->sc_cmd_xfer);
    389  1.1  augustss 		sc->sc_cmd_xfer = NULL;
    390  1.1  augustss 	}
    391  1.1  augustss 	if (sc->sc_data_xfer != NULL) {
    392  1.1  augustss 		usbd_free_xfer(sc->sc_data_xfer);
    393  1.1  augustss 		sc->sc_data_xfer = NULL;
    394  1.1  augustss 	}
    395  1.1  augustss }
    396  1.1  augustss 
    397  1.1  augustss int
    398  1.1  augustss usscanner_activate(device_ptr_t self, enum devact act)
    399  1.1  augustss {
    400  1.1  augustss 	struct usscanner_softc *sc = (struct usscanner_softc *)self;
    401  1.1  augustss 
    402  1.1  augustss 	switch (act) {
    403  1.1  augustss 	case DVACT_ACTIVATE:
    404  1.1  augustss 		return (EOPNOTSUPP);
    405  1.1  augustss 		break;
    406  1.1  augustss 
    407  1.1  augustss 	case DVACT_DEACTIVATE:
    408  1.1  augustss 		sc->sc_dying = 1;
    409  1.1  augustss 		break;
    410  1.1  augustss 	}
    411  1.1  augustss 	return (0);
    412  1.1  augustss }
    413  1.1  augustss 
    414  1.1  augustss Static void
    415  1.1  augustss usscanner_scsipi_minphys(struct buf *bp)
    416  1.1  augustss {
    417  1.1  augustss 	if (bp->b_bcount > USSCANNER_MAX_TRANSFER_SIZE)
    418  1.1  augustss 		bp->b_bcount = USSCANNER_MAX_TRANSFER_SIZE;
    419  1.1  augustss 	minphys(bp);
    420  1.1  augustss }
    421  1.1  augustss 
    422  1.1  augustss Static void
    423  1.1  augustss usscanner_sense(struct usscanner_softc *sc)
    424  1.1  augustss {
    425  1.1  augustss 	struct scsipi_xfer *xs = sc->sc_xs;
    426  1.1  augustss 	struct scsipi_link *sc_link = xs->sc_link;
    427  1.1  augustss 	struct scsipi_sense sense_cmd;
    428  1.1  augustss 	usbd_status err;
    429  1.1  augustss 
    430  1.1  augustss 	/* fetch sense data */
    431  1.1  augustss 	memset(&sense_cmd, 0, sizeof(sense_cmd));
    432  1.1  augustss 	sense_cmd.opcode = REQUEST_SENSE;
    433  1.1  augustss 	sense_cmd.byte2 = sc_link->scsipi_scsi.lun << SCSI_CMD_LUN_SHIFT;
    434  1.1  augustss 	sense_cmd.length = sizeof xs->sense;
    435  1.1  augustss 
    436  1.1  augustss 	sc->sc_state = UAS_SENSECMD;
    437  1.1  augustss 	memcpy(sc->sc_cmd_buffer, &sense_cmd, sizeof sense_cmd);
    438  1.1  augustss 	usbd_setup_xfer(sc->sc_cmd_xfer, sc->sc_out_pipe, sc, sc->sc_cmd_buffer,
    439  1.1  augustss 	    sizeof sense_cmd, USBD_NO_COPY, USSCANNER_TIMEOUT,
    440  1.1  augustss 	    usscanner_sensecmd_cb);
    441  1.1  augustss 	err = usbd_transfer(sc->sc_cmd_xfer);
    442  1.1  augustss 	if (err == USBD_IN_PROGRESS)
    443  1.1  augustss 		return;
    444  1.1  augustss 
    445  1.1  augustss 	xs->error = XS_DRIVER_STUFFUP;
    446  1.1  augustss 	usscanner_done(sc);
    447  1.1  augustss }
    448  1.1  augustss 
    449  1.1  augustss Static void
    450  1.1  augustss usscanner_intr_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
    451  1.1  augustss 		 usbd_status status)
    452  1.1  augustss {
    453  1.1  augustss 	struct usscanner_softc *sc = priv;
    454  1.1  augustss 	int s;
    455  1.1  augustss 
    456  1.1  augustss 	DPRINTFN(10, ("usscanner_data_cb status=%d\n", status));
    457  1.1  augustss 
    458  1.1  augustss #ifdef USSCANNER_DEBUG
    459  1.1  augustss 	if (sc->sc_state != UAS_STATUS) {
    460  1.1  augustss 		printf("%s: !UAS_STATUS\n", USBDEVNAME(sc->sc_dev));
    461  1.1  augustss 	}
    462  1.3  augustss 	if (sc->sc_status != 0) {
    463  1.3  augustss 		printf("%s: status byte=0x%02x\n", USBDEVNAME(sc->sc_dev), sc->sc_status);
    464  1.3  augustss 	}
    465  1.1  augustss #endif
    466  1.3  augustss 	/* XXX what should we do on non-0 status */
    467  1.1  augustss 
    468  1.1  augustss 	sc->sc_state = UAS_IDLE;
    469  1.1  augustss 
    470  1.1  augustss 	sc->sc_xs->xs_status |= XS_STS_DONE;
    471  1.1  augustss 	s = splbio();
    472  1.1  augustss 	scsipi_done(sc->sc_xs);
    473  1.1  augustss 	splx(s);
    474  1.1  augustss }
    475  1.1  augustss 
    476  1.1  augustss Static void
    477  1.1  augustss usscanner_data_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
    478  1.1  augustss 		 usbd_status status)
    479  1.1  augustss {
    480  1.1  augustss 	struct usscanner_softc *sc = priv;
    481  1.1  augustss 	struct scsipi_xfer *xs = sc->sc_xs;
    482  1.1  augustss 	u_int32_t len;
    483  1.1  augustss 
    484  1.1  augustss 	DPRINTFN(10, ("usscanner_data_cb status=%d\n", status));
    485  1.1  augustss 
    486  1.1  augustss #ifdef USSCANNER_DEBUG
    487  1.1  augustss 	if (sc->sc_state != UAS_DATA) {
    488  1.1  augustss 		printf("%s: !UAS_DATA\n", USBDEVNAME(sc->sc_dev));
    489  1.1  augustss 	}
    490  1.1  augustss #endif
    491  1.1  augustss 
    492  1.1  augustss 	usbd_get_xfer_status(xfer, NULL, NULL, &len, NULL);
    493  1.1  augustss 
    494  1.1  augustss 	xs->resid = xs->datalen - len;
    495  1.1  augustss 
    496  1.1  augustss 	switch (status) {
    497  1.1  augustss 	case USBD_NORMAL_COMPLETION:
    498  1.1  augustss 		if (xs->xs_control & XS_CTL_DATA_IN)
    499  1.1  augustss 			memcpy(xs->data, sc->sc_data_buffer, len);
    500  1.1  augustss 		xs->error = XS_NOERROR;
    501  1.1  augustss 		break;
    502  1.1  augustss 	case USBD_TIMEOUT:
    503  1.1  augustss 		xs->error = XS_TIMEOUT;
    504  1.1  augustss 		break;
    505  1.1  augustss 	case USBD_CANCELLED:
    506  1.1  augustss 		if (xs->error == XS_SENSE) {
    507  1.1  augustss 			usscanner_sense(sc);
    508  1.1  augustss 			return;
    509  1.1  augustss 		}
    510  1.1  augustss 		break;
    511  1.1  augustss 	default:
    512  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP; /* XXX ? */
    513  1.1  augustss 		break;
    514  1.1  augustss 	}
    515  1.1  augustss 	usscanner_done(sc);
    516  1.1  augustss }
    517  1.1  augustss 
    518  1.1  augustss Static void
    519  1.1  augustss usscanner_sensedata_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
    520  1.1  augustss 		       usbd_status status)
    521  1.1  augustss {
    522  1.1  augustss 	struct usscanner_softc *sc = priv;
    523  1.1  augustss 	struct scsipi_xfer *xs = sc->sc_xs;
    524  1.1  augustss 	u_int32_t len;
    525  1.1  augustss 
    526  1.1  augustss 	DPRINTFN(10, ("usscanner_sensedata_cb status=%d\n", status));
    527  1.1  augustss 
    528  1.1  augustss #ifdef USSCANNER_DEBUG
    529  1.1  augustss 	if (sc->sc_state != UAS_SENSEDATA) {
    530  1.1  augustss 		printf("%s: !UAS_SENSEDATA\n", USBDEVNAME(sc->sc_dev));
    531  1.1  augustss 	}
    532  1.1  augustss #endif
    533  1.1  augustss 
    534  1.1  augustss 	usbd_get_xfer_status(xfer, NULL, NULL, &len, NULL);
    535  1.1  augustss 
    536  1.1  augustss 	switch (status) {
    537  1.1  augustss 	case USBD_NORMAL_COMPLETION:
    538  1.1  augustss 		memcpy(&xs->sense, sc->sc_data_buffer, len);
    539  1.1  augustss 		if (len < sizeof xs->sense)
    540  1.1  augustss 			xs->error = XS_SHORTSENSE;
    541  1.1  augustss 		break;
    542  1.1  augustss 	case USBD_TIMEOUT:
    543  1.1  augustss 		xs->error = XS_TIMEOUT;
    544  1.1  augustss 		break;
    545  1.1  augustss 	case USBD_CANCELLED:
    546  1.1  augustss 		xs->error = XS_RESET;
    547  1.1  augustss 		break;
    548  1.1  augustss 	default:
    549  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP; /* XXX ? */
    550  1.1  augustss 		break;
    551  1.1  augustss 	}
    552  1.1  augustss 	usscanner_done(sc);
    553  1.1  augustss }
    554  1.1  augustss 
    555  1.1  augustss Static void
    556  1.1  augustss usscanner_done(struct usscanner_softc *sc)
    557  1.1  augustss {
    558  1.1  augustss 	struct scsipi_xfer *xs = sc->sc_xs;
    559  1.1  augustss 	usbd_status err;
    560  1.1  augustss 
    561  1.1  augustss 	DPRINTFN(10,("usscanner_done: error=%d\n", sc->sc_xs->error));
    562  1.1  augustss 
    563  1.1  augustss 	sc->sc_state = UAS_STATUS;
    564  1.1  augustss 	usbd_setup_xfer(sc->sc_intr_xfer, sc->sc_intr_pipe, sc, &sc->sc_status,
    565  1.1  augustss 	    1, USBD_SHORT_XFER_OK | USBD_NO_COPY,
    566  1.1  augustss 	    USSCANNER_TIMEOUT, usscanner_intr_cb);
    567  1.1  augustss 	err = usbd_transfer(sc->sc_intr_xfer);
    568  1.1  augustss 	if (err == USBD_IN_PROGRESS)
    569  1.1  augustss 		return;
    570  1.1  augustss 	xs->error = XS_DRIVER_STUFFUP;
    571  1.1  augustss }
    572  1.1  augustss 
    573  1.1  augustss Static void
    574  1.1  augustss usscanner_sensecmd_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
    575  1.3  augustss 		      usbd_status status)
    576  1.1  augustss {
    577  1.1  augustss 	struct usscanner_softc *sc = priv;
    578  1.1  augustss 	struct scsipi_xfer *xs = sc->sc_xs;
    579  1.1  augustss 	usbd_status err;
    580  1.1  augustss 
    581  1.1  augustss 	DPRINTFN(10, ("usscanner_sensecmd_cb status=%d\n", status));
    582  1.1  augustss 
    583  1.1  augustss #ifdef USSCANNER_DEBUG
    584  1.1  augustss 	if (usscannerdebug > 15)
    585  1.1  augustss 		xs->sc_link->flags |= DEBUGLEVEL;
    586  1.1  augustss 
    587  1.1  augustss 	if (sc->sc_state != UAS_SENSECMD) {
    588  1.1  augustss 		printf("%s: !UAS_SENSECMD\n", USBDEVNAME(sc->sc_dev));
    589  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP;
    590  1.1  augustss 		goto done;
    591  1.1  augustss 	}
    592  1.1  augustss #endif
    593  1.1  augustss 
    594  1.1  augustss 	switch (status) {
    595  1.1  augustss 	case USBD_NORMAL_COMPLETION:
    596  1.1  augustss 		break;
    597  1.1  augustss 	case USBD_TIMEOUT:
    598  1.1  augustss 		xs->error = XS_TIMEOUT;
    599  1.1  augustss 		goto done;
    600  1.1  augustss 	default:
    601  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP; /* XXX ? */
    602  1.1  augustss 		goto done;
    603  1.1  augustss 	}
    604  1.1  augustss 
    605  1.1  augustss 	sc->sc_state = UAS_SENSEDATA;
    606  1.1  augustss 	usbd_setup_xfer(sc->sc_data_xfer, sc->sc_in_pipe, sc,
    607  1.1  augustss 	    sc->sc_data_buffer,
    608  1.1  augustss 	    sizeof xs->sense, USBD_SHORT_XFER_OK | USBD_NO_COPY,
    609  1.1  augustss 	    USSCANNER_TIMEOUT, usscanner_sensedata_cb);
    610  1.1  augustss 	err = usbd_transfer(sc->sc_data_xfer);
    611  1.1  augustss 	if (err == USBD_IN_PROGRESS)
    612  1.1  augustss 		return;
    613  1.1  augustss 	xs->error = XS_DRIVER_STUFFUP;
    614  1.1  augustss  done:
    615  1.1  augustss 	usscanner_done(sc);
    616  1.1  augustss }
    617  1.1  augustss 
    618  1.1  augustss Static void
    619  1.1  augustss usscanner_cmd_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
    620  1.3  augustss 		 usbd_status status)
    621  1.1  augustss {
    622  1.1  augustss 	struct usscanner_softc *sc = priv;
    623  1.1  augustss 	struct scsipi_xfer *xs = sc->sc_xs;
    624  1.1  augustss 	usbd_pipe_handle pipe;
    625  1.1  augustss 	usbd_status err;
    626  1.1  augustss 
    627  1.1  augustss 	DPRINTFN(10, ("usscanner_cmd_cb status=%d\n", status));
    628  1.1  augustss 
    629  1.1  augustss #ifdef USSCANNER_DEBUG
    630  1.1  augustss 	if (usscannerdebug > 15)
    631  1.1  augustss 		xs->sc_link->flags |= DEBUGLEVEL;
    632  1.1  augustss 
    633  1.1  augustss 	if (sc->sc_state != UAS_CMD) {
    634  1.1  augustss 		printf("%s: !UAS_CMD\n", USBDEVNAME(sc->sc_dev));
    635  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP;
    636  1.1  augustss 		goto done;
    637  1.1  augustss 	}
    638  1.1  augustss #endif
    639  1.1  augustss 
    640  1.1  augustss 	switch (status) {
    641  1.1  augustss 	case USBD_NORMAL_COMPLETION:
    642  1.1  augustss 		break;
    643  1.1  augustss 	case USBD_TIMEOUT:
    644  1.1  augustss 		xs->error = XS_TIMEOUT;
    645  1.1  augustss 		goto done;
    646  1.1  augustss 	case USBD_CANCELLED:
    647  1.1  augustss 		goto done;
    648  1.1  augustss 	default:
    649  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP; /* XXX ? */
    650  1.1  augustss 		goto done;
    651  1.1  augustss 	}
    652  1.1  augustss 
    653  1.1  augustss 	if (xs->datalen == 0) {
    654  1.1  augustss 		DPRINTFN(4, ("usscanner_cmd_cb: no data phase\n"));
    655  1.1  augustss 		xs->error = XS_NOERROR;
    656  1.1  augustss 		goto done;
    657  1.1  augustss 	}
    658  1.1  augustss 
    659  1.1  augustss 	if (xs->xs_control & XS_CTL_DATA_IN) {
    660  1.1  augustss 		DPRINTFN(4, ("usscanner_cmd_cb: data in len=%d\n",
    661  1.1  augustss 			     xs->datalen));
    662  1.1  augustss 		pipe = sc->sc_in_pipe;
    663  1.1  augustss 	} else {
    664  1.1  augustss 		DPRINTFN(4, ("usscanner_cmd_cb: data out len=%d\n",
    665  1.1  augustss 			     xs->datalen));
    666  1.1  augustss 		memcpy(sc->sc_data_buffer, xs->data, xs->datalen);
    667  1.1  augustss 		pipe = sc->sc_out_pipe;
    668  1.1  augustss 	}
    669  1.1  augustss 	sc->sc_state = UAS_DATA;
    670  1.1  augustss 	usbd_setup_xfer(sc->sc_data_xfer, pipe, sc, sc->sc_data_buffer,
    671  1.1  augustss 	    xs->datalen, USBD_SHORT_XFER_OK | USBD_NO_COPY,
    672  1.1  augustss 	    xs->timeout, usscanner_data_cb);
    673  1.1  augustss 	err = usbd_transfer(sc->sc_data_xfer);
    674  1.1  augustss 	if (err == USBD_IN_PROGRESS)
    675  1.1  augustss 		return;
    676  1.1  augustss 	xs->error = XS_DRIVER_STUFFUP;
    677  1.1  augustss 
    678  1.1  augustss  done:
    679  1.1  augustss 	usscanner_done(sc);
    680  1.1  augustss }
    681  1.1  augustss 
    682  1.1  augustss Static int
    683  1.1  augustss usscanner_scsipi_cmd(struct scsipi_xfer *xs)
    684  1.1  augustss {
    685  1.1  augustss 	struct scsipi_link *sc_link = xs->sc_link;
    686  1.1  augustss 	struct usscanner_softc *sc = sc_link->adapter_softc;
    687  1.1  augustss 	usbd_status err;
    688  1.1  augustss 
    689  1.1  augustss 	DPRINTFN(8, ("%s: usscanner_scsi_cmd: %d:%d "
    690  1.1  augustss 	    "xs=%p cmd=0x%02x datalen=%d (quirks=0x%x, poll=%d)\n",
    691  1.1  augustss 	    USBDEVNAME(sc->sc_dev),
    692  1.1  augustss 	    sc_link->scsipi_scsi.target, sc_link->scsipi_scsi.lun,
    693  1.1  augustss 	    xs, xs->cmd->opcode, xs->datalen,
    694  1.1  augustss 	    sc_link->quirks, xs->xs_control & XS_CTL_POLL));
    695  1.1  augustss 
    696  1.1  augustss 	if (sc->sc_dying) {
    697  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP;
    698  1.1  augustss 		goto done;
    699  1.1  augustss 	}
    700  1.1  augustss 
    701  1.1  augustss #ifdef USSCANNER_DEBUG
    702  1.1  augustss 	if (sc_link->scsipi_scsi.target != USSCANNER_SCSIID_DEVICE) {
    703  1.1  augustss 		DPRINTF(("%s: wrong SCSI ID %d\n", USBDEVNAME(sc->sc_dev),
    704  1.1  augustss 		    sc_link->scsipi_scsi.target));
    705  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP;
    706  1.1  augustss 		goto done;
    707  1.1  augustss 	}
    708  1.1  augustss 	if (sc->sc_state != UAS_IDLE) {
    709  1.1  augustss 		printf("%s: !UAS_IDLE\n", USBDEVNAME(sc->sc_dev));
    710  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP;
    711  1.1  augustss 		goto done;
    712  1.1  augustss 	}
    713  1.1  augustss #endif
    714  1.1  augustss 
    715  1.1  augustss 	if (xs->datalen > USSCANNER_MAX_TRANSFER_SIZE) {
    716  1.1  augustss 		printf("umass_cmd: large datalen, %d\n", xs->datalen);
    717  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP;
    718  1.1  augustss 		goto done;
    719  1.1  augustss 	}
    720  1.1  augustss 
    721  1.1  augustss 	DPRINTFN(4, ("usscanner_scsi_cmd: async cmdlen=%d datalen=%d\n",
    722  1.1  augustss 		    xs->cmdlen, xs->datalen));
    723  1.1  augustss 	sc->sc_state = UAS_CMD;
    724  1.1  augustss 	sc->sc_xs = xs;
    725  1.1  augustss 	memcpy(sc->sc_cmd_buffer, xs->cmd, xs->cmdlen);
    726  1.1  augustss 	usbd_setup_xfer(sc->sc_cmd_xfer, sc->sc_out_pipe, sc, sc->sc_cmd_buffer,
    727  1.1  augustss 	    xs->cmdlen, USBD_NO_COPY, USSCANNER_TIMEOUT, usscanner_cmd_cb);
    728  1.1  augustss 	err = usbd_transfer(sc->sc_cmd_xfer);
    729  1.1  augustss 	if (err != USBD_IN_PROGRESS) {
    730  1.1  augustss 		xs->error = XS_DRIVER_STUFFUP;
    731  1.1  augustss 		goto done;
    732  1.1  augustss 	}
    733  1.1  augustss 
    734  1.1  augustss 	return (SUCCESSFULLY_QUEUED);
    735  1.1  augustss 
    736  1.1  augustss 
    737  1.1  augustss  done:
    738  1.1  augustss 	sc->sc_state = UAS_IDLE;
    739  1.1  augustss 	xs->xs_status |= XS_STS_DONE;
    740  1.1  augustss 	scsipi_done(xs);
    741  1.1  augustss 	if (xs->xs_control & XS_CTL_POLL)
    742  1.1  augustss 		return (COMPLETE);
    743  1.1  augustss 	else
    744  1.1  augustss 		return (SUCCESSFULLY_QUEUED);
    745  1.1  augustss }
    746