Home | History | Annotate | Line # | Download | only in usb
umass.c revision 1.179
      1  1.179  riastrad /*	$NetBSD: umass.c,v 1.179 2020/02/19 16:02:50 riastradh Exp $	*/
      2  1.102   mycroft 
      3  1.102   mycroft /*
      4  1.102   mycroft  * Copyright (c) 2003 The NetBSD Foundation, Inc.
      5  1.102   mycroft  * All rights reserved.
      6  1.102   mycroft  *
      7  1.102   mycroft  * This code is derived from software contributed to The NetBSD Foundation
      8  1.104   mycroft  * by Charles M. Hannum.
      9  1.102   mycroft  *
     10  1.102   mycroft  * Redistribution and use in source and binary forms, with or without
     11  1.102   mycroft  * modification, are permitted provided that the following conditions
     12  1.102   mycroft  * are met:
     13  1.102   mycroft  * 1. Redistributions of source code must retain the above copyright
     14  1.102   mycroft  *    notice, this list of conditions and the following disclaimer.
     15  1.102   mycroft  * 2. Redistributions in binary form must reproduce the above copyright
     16  1.102   mycroft  *    notice, this list of conditions and the following disclaimer in the
     17  1.102   mycroft  *    documentation and/or other materials provided with the distribution.
     18  1.102   mycroft  *
     19  1.102   mycroft  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  1.102   mycroft  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  1.102   mycroft  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  1.102   mycroft  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  1.102   mycroft  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  1.102   mycroft  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  1.102   mycroft  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  1.102   mycroft  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  1.102   mycroft  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  1.102   mycroft  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  1.102   mycroft  * POSSIBILITY OF SUCH DAMAGE.
     30  1.102   mycroft  */
     31  1.102   mycroft 
     32    1.1   thorpej /*-
     33    1.1   thorpej  * Copyright (c) 1999 MAEKAWA Masahide <bishop (at) rr.iij4u.or.jp>,
     34   1.28  augustss  *		      Nick Hibma <n_hibma (at) freebsd.org>
     35    1.1   thorpej  * All rights reserved.
     36    1.1   thorpej  *
     37    1.1   thorpej  * Redistribution and use in source and binary forms, with or without
     38    1.1   thorpej  * modification, are permitted provided that the following conditions
     39    1.1   thorpej  * are met:
     40    1.1   thorpej  * 1. Redistributions of source code must retain the above copyright
     41    1.1   thorpej  *    notice, this list of conditions and the following disclaimer.
     42    1.1   thorpej  * 2. Redistributions in binary form must reproduce the above copyright
     43    1.1   thorpej  *    notice, this list of conditions and the following disclaimer in the
     44    1.1   thorpej  *    documentation and/or other materials provided with the distribution.
     45    1.1   thorpej  *
     46    1.1   thorpej  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     47    1.1   thorpej  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     48    1.1   thorpej  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     49    1.1   thorpej  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     50    1.1   thorpej  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     51    1.1   thorpej  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     52    1.1   thorpej  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     53    1.1   thorpej  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     54    1.1   thorpej  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     55    1.1   thorpej  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     56    1.1   thorpej  * SUCH DAMAGE.
     57    1.1   thorpej  *
     58   1.28  augustss  *     $FreeBSD: src/sys/dev/usb/umass.c,v 1.13 2000/03/26 01:39:12 n_hibma Exp $
     59   1.28  augustss  */
     60   1.28  augustss 
     61   1.28  augustss /*
     62   1.47  augustss  * Universal Serial Bus Mass Storage Class specs:
     63  1.150    martin  * http://www.usb.org/developers/docs/devclass_docs/Mass_Storage_Specification_Overview_v1.4_2-19-2010.pdf
     64  1.150    martin  * http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
     65  1.150    martin  * http://www.usb.org/developers/docs/devclass_docs/usb_msc_cbi_1.1.pdf
     66  1.150    martin  * http://www.usb.org/developers/docs/devclass_docs/usbmass-ufi10.pdf
     67   1.28  augustss  */
     68   1.28  augustss 
     69   1.28  augustss /*
     70  1.109    keihan  * Ported to NetBSD by Lennart Augustsson <augustss (at) NetBSD.org>.
     71   1.90     pooka  * Parts of the code written by Jason R. Thorpe <thorpej (at) shagadelic.org>.
     72    1.1   thorpej  */
     73    1.1   thorpej 
     74    1.1   thorpej /*
     75   1.28  augustss  * The driver handles 3 Wire Protocols
     76   1.28  augustss  * - Command/Bulk/Interrupt (CBI)
     77   1.28  augustss  * - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI)
     78   1.28  augustss  * - Mass Storage Bulk-Only (BBB)
     79   1.28  augustss  *   (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases)
     80   1.28  augustss  *
     81   1.28  augustss  * Over these wire protocols it handles the following command protocols
     82   1.28  augustss  * - SCSI
     83   1.54  augustss  * - 8070 (ATA/ATAPI for rewritable removable media)
     84   1.54  augustss  * - UFI (USB Floppy Interface)
     85    1.1   thorpej  *
     86   1.54  augustss  * 8070i is a transformed version of the SCSI command set. UFI is a transformed
     87   1.88  augustss  * version of the 8070i command set.  The sc->transform method is used to
     88   1.54  augustss  * convert the commands into the appropriate format (if at all necessary).
     89   1.54  augustss  * For example, ATAPI requires all commands to be 12 bytes in length amongst
     90   1.54  augustss  * other things.
     91    1.3   thorpej  *
     92   1.28  augustss  * The source code below is marked and can be split into a number of pieces
     93   1.28  augustss  * (in this order):
     94    1.3   thorpej  *
     95   1.28  augustss  * - probe/attach/detach
     96   1.28  augustss  * - generic transfer routines
     97   1.28  augustss  * - BBB
     98   1.28  augustss  * - CBI
     99   1.28  augustss  * - CBI_I (in addition to functions from CBI)
    100   1.28  augustss  * - CAM (Common Access Method)
    101   1.28  augustss  * - SCSI
    102   1.28  augustss  * - UFI
    103   1.28  augustss  * - 8070i
    104    1.3   thorpej  *
    105   1.28  augustss  * The protocols are implemented using a state machine, for the transfers as
    106   1.28  augustss  * well as for the resets. The state machine is contained in umass_*_state.
    107   1.28  augustss  * The state machine is started through either umass_*_transfer or
    108   1.28  augustss  * umass_*_reset.
    109   1.28  augustss  *
    110   1.28  augustss  * The reason for doing this is a) CAM performs a lot better this way and b) it
    111  1.167     skrll  * avoids sleeping in interrupt context which is prohibited (for example after a
    112  1.167     skrll  * failed transfer).
    113    1.1   thorpej  */
    114    1.1   thorpej 
    115   1.28  augustss /*
    116   1.28  augustss  * The SCSI related part of this driver has been derived from the
    117   1.28  augustss  * dev/ppbus/vpo.c driver, by Nicolas Souchu (nsouch (at) freebsd.org).
    118    1.1   thorpej  *
    119   1.28  augustss  * The CAM layer uses so called actions which are messages sent to the host
    120   1.28  augustss  * adapter for completion. The actions come in through umass_cam_action. The
    121   1.28  augustss  * appropriate block of routines is called depending on the transport protocol
    122   1.28  augustss  * in use. When the transfer has finished, these routines call
    123   1.28  augustss  * umass_cam_cb again to complete the CAM command.
    124    1.1   thorpej  */
    125   1.64     lukem 
    126   1.64     lukem #include <sys/cdefs.h>
    127  1.179  riastrad __KERNEL_RCSID(0, "$NetBSD: umass.c,v 1.179 2020/02/19 16:02:50 riastradh Exp $");
    128  1.140  christos 
    129  1.141   mbalmer #ifdef _KERNEL_OPT
    130  1.149     skrll #include "opt_usb.h"
    131  1.141   mbalmer #endif
    132    1.1   thorpej 
    133   1.29     enami #include "atapibus.h"
    134   1.79  augustss #include "scsibus.h"
    135   1.80  augustss #include "wd.h"
    136   1.29     enami 
    137    1.1   thorpej #include <sys/param.h>
    138  1.171     skrll #include <sys/buf.h>
    139   1.28  augustss #include <sys/conf.h>
    140   1.28  augustss #include <sys/device.h>
    141  1.171     skrll #include <sys/kernel.h>
    142  1.173     skrll #include <sys/kmem.h>
    143  1.149     skrll #include <sys/sysctl.h>
    144  1.171     skrll #include <sys/systm.h>
    145    1.1   thorpej 
    146    1.1   thorpej #include <dev/usb/usb.h>
    147    1.1   thorpej #include <dev/usb/usbdi.h>
    148    1.1   thorpej #include <dev/usb/usbdi_util.h>
    149   1.28  augustss #include <dev/usb/usbdevs.h>
    150  1.149     skrll #include <dev/usb/usbhist.h>
    151    1.1   thorpej 
    152   1.56  augustss #include <dev/usb/umassvar.h>
    153   1.78   gehenna #include <dev/usb/umass_quirks.h>
    154   1.79  augustss #include <dev/usb/umass_scsipi.h>
    155   1.80  augustss #include <dev/usb/umass_isdata.h>
    156   1.28  augustss 
    157   1.99   mycroft #include <dev/scsipi/scsipi_all.h>
    158   1.99   mycroft #include <dev/scsipi/scsipiconf.h>
    159   1.99   mycroft 
    160  1.149     skrll #ifdef USB_DEBUG
    161  1.155     skrll #ifdef UMASS_DEBUG
    162  1.149     skrll int umassdebug = 0;
    163  1.149     skrll 
    164  1.149     skrll SYSCTL_SETUP(sysctl_hw_umass_setup, "sysctl hw.umass setup")
    165  1.149     skrll {
    166  1.149     skrll 	int err;
    167  1.149     skrll 	const struct sysctlnode *rnode;
    168  1.149     skrll 	const struct sysctlnode *cnode;
    169  1.149     skrll 
    170  1.149     skrll 	err = sysctl_createv(clog, 0, NULL, &rnode,
    171  1.149     skrll 	    CTLFLAG_PERMANENT, CTLTYPE_NODE, "umass",
    172  1.149     skrll 	    SYSCTL_DESCR("umass global controls"),
    173  1.149     skrll 	    NULL, 0, NULL, 0, CTL_HW, CTL_CREATE, CTL_EOL);
    174  1.149     skrll 
    175  1.149     skrll 	if (err)
    176  1.149     skrll 		goto fail;
    177  1.149     skrll 
    178  1.149     skrll 	/* control debugging printfs */
    179  1.149     skrll 	err = sysctl_createv(clog, 0, &rnode, &cnode,
    180  1.149     skrll 	    CTLFLAG_PERMANENT|CTLFLAG_READWRITE, CTLTYPE_INT,
    181  1.149     skrll 	    "debug", SYSCTL_DESCR("Enable debugging output"),
    182  1.149     skrll 	    NULL, 0, &umassdebug, sizeof(umassdebug), CTL_CREATE, CTL_EOL);
    183  1.149     skrll 	if (err)
    184  1.149     skrll 		goto fail;
    185   1.28  augustss 
    186  1.149     skrll 	return;
    187  1.149     skrll fail:
    188  1.149     skrll 	aprint_error("%s: sysctl_createv failed (err = %d)\n", __func__, err);
    189  1.149     skrll }
    190   1.57  augustss 
    191  1.119  drochner const char *states[TSTATE_STATES+1] = {
    192   1.28  augustss 	/* should be kept in sync with the list at transfer_state */
    193   1.28  augustss 	"Idle",
    194   1.28  augustss 	"BBB CBW",
    195   1.28  augustss 	"BBB Data",
    196   1.28  augustss 	"BBB Data bulk-in/-out clear stall",
    197   1.28  augustss 	"BBB CSW, 1st attempt",
    198   1.28  augustss 	"BBB CSW bulk-in clear stall",
    199   1.28  augustss 	"BBB CSW, 2nd attempt",
    200   1.28  augustss 	"BBB Reset",
    201   1.28  augustss 	"BBB bulk-in clear stall",
    202   1.28  augustss 	"BBB bulk-out clear stall",
    203   1.28  augustss 	"CBI Command",
    204   1.28  augustss 	"CBI Data",
    205   1.28  augustss 	"CBI Status",
    206   1.28  augustss 	"CBI Data bulk-in/-out clear stall",
    207   1.28  augustss 	"CBI Status intr-in clear stall",
    208   1.28  augustss 	"CBI Reset",
    209   1.28  augustss 	"CBI bulk-in clear stall",
    210   1.28  augustss 	"CBI bulk-out clear stall",
    211   1.28  augustss 	NULL
    212   1.28  augustss };
    213   1.28  augustss #endif
    214  1.155     skrll #endif
    215    1.1   thorpej 
    216   1.28  augustss /* USB device probe/attach/detach functions */
    217  1.176      maxv static int umass_match(device_t, cfdata_t, void *);
    218  1.176      maxv static void umass_attach(device_t, device_t, void *);
    219  1.176      maxv static int umass_detach(device_t, int);
    220  1.131    dyoung static void umass_childdet(device_t, device_t);
    221  1.176      maxv static int umass_activate(device_t, enum devact);
    222  1.175       mrg 
    223  1.156   msaitoh CFATTACH_DECL2_NEW(umass, sizeof(struct umass_softc), umass_match,
    224  1.156   msaitoh     umass_attach, umass_detach, umass_activate, NULL, umass_childdet);
    225  1.131    dyoung 
    226   1.38  augustss Static void umass_disco(struct umass_softc *sc);
    227    1.1   thorpej 
    228   1.28  augustss /* generic transfer functions */
    229  1.151     skrll Static usbd_status umass_setup_transfer(struct umass_softc *,
    230  1.151     skrll 				struct usbd_pipe *,
    231  1.151     skrll 				void *, int, int,
    232  1.151     skrll 				struct usbd_xfer *);
    233  1.151     skrll Static usbd_status umass_setup_ctrl_transfer(struct umass_softc *,
    234  1.151     skrll 				usb_device_request_t *,
    235  1.151     skrll 				void *, int, int,
    236  1.151     skrll 				struct usbd_xfer *);
    237  1.151     skrll Static void umass_clear_endpoint_stall(struct umass_softc *, int,
    238  1.151     skrll 				struct usbd_xfer *);
    239  1.178  riastrad Static void umass_transfer_done(struct umass_softc *, int, int);
    240  1.178  riastrad Static void umass_transfer_reset(struct umass_softc *);
    241   1.29     enami #if 0
    242  1.151     skrll Static void umass_reset(struct umass_softc *, transfer_cb_f, void *);
    243   1.29     enami #endif
    244    1.1   thorpej 
    245    1.1   thorpej /* Bulk-Only related functions */
    246   1.75   gehenna Static void umass_bbb_transfer(struct umass_softc *, int, void *, int, void *,
    247  1.143       mrg 			       int, int, u_int, int, umass_callback, void *);
    248   1.75   gehenna Static void umass_bbb_reset(struct umass_softc *, int);
    249  1.151     skrll Static void umass_bbb_state(struct usbd_xfer *, void *, usbd_status);
    250   1.28  augustss 
    251  1.176      maxv static usbd_status umass_bbb_get_max_lun(struct umass_softc *, uint8_t *);
    252   1.28  augustss 
    253   1.28  augustss /* CBI related functions */
    254   1.88  augustss Static void umass_cbi_transfer(struct umass_softc *, int, void *, int, void *,
    255  1.143       mrg 			       int, int, u_int, int, umass_callback, void *);
    256   1.75   gehenna Static void umass_cbi_reset(struct umass_softc *, int);
    257  1.151     skrll Static void umass_cbi_state(struct usbd_xfer *, void *, usbd_status);
    258   1.75   gehenna 
    259  1.156   msaitoh Static int umass_cbi_adsc(struct umass_softc *, char *, int, int,
    260  1.156   msaitoh     struct usbd_xfer *);
    261   1.75   gehenna 
    262   1.75   gehenna const struct umass_wire_methods umass_bbb_methods = {
    263  1.151     skrll 	.wire_xfer = umass_bbb_transfer,
    264  1.151     skrll 	.wire_reset = umass_bbb_reset,
    265  1.151     skrll 	.wire_state = umass_bbb_state
    266   1.75   gehenna };
    267   1.75   gehenna 
    268   1.75   gehenna const struct umass_wire_methods umass_cbi_methods = {
    269  1.151     skrll 	.wire_xfer = umass_cbi_transfer,
    270  1.151     skrll 	.wire_reset = umass_cbi_reset,
    271  1.151     skrll 	.wire_state = umass_cbi_state
    272   1.75   gehenna };
    273   1.28  augustss 
    274   1.28  augustss #ifdef UMASS_DEBUG
    275   1.28  augustss /* General debugging functions */
    276  1.172     skrll Static void umass_bbb_dump_cbw(struct umass_softc *, umass_bbb_cbw_t *);
    277  1.172     skrll Static void umass_bbb_dump_csw(struct umass_softc *, umass_bbb_csw_t *);
    278  1.172     skrll Static void umass_dump_buffer(struct umass_softc *, uint8_t *, int, int);
    279   1.28  augustss #endif
    280   1.28  augustss 
    281   1.28  augustss 
    282   1.28  augustss /*
    283   1.28  augustss  * USB device probe/attach/detach
    284   1.28  augustss  */
    285   1.28  augustss 
    286  1.176      maxv static int
    287  1.131    dyoung umass_match(device_t parent, cfdata_t match, void *aux)
    288   1.28  augustss {
    289  1.151     skrll 	struct usbif_attach_arg *uiaa = aux;
    290   1.78   gehenna 	const struct umass_quirk *quirk;
    291   1.28  augustss 
    292  1.151     skrll 	quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product);
    293  1.126    ichiro 	if (quirk != NULL && quirk->uq_match != UMASS_QUIRK_USE_DEFAULTMATCH)
    294  1.151     skrll 		return quirk->uq_match;
    295   1.40  augustss 
    296  1.151     skrll 	if (uiaa->uiaa_class != UICLASS_MASS)
    297  1.151     skrll 		return UMATCH_NONE;
    298    1.1   thorpej 
    299  1.151     skrll 	switch (uiaa->uiaa_subclass) {
    300   1.78   gehenna 	case UISUBCLASS_RBC:
    301   1.78   gehenna 	case UISUBCLASS_SFF8020I:
    302   1.78   gehenna 	case UISUBCLASS_QIC157:
    303   1.28  augustss 	case UISUBCLASS_UFI:
    304   1.28  augustss 	case UISUBCLASS_SFF8070I:
    305   1.78   gehenna 	case UISUBCLASS_SCSI:
    306   1.40  augustss 		break;
    307   1.28  augustss 	default:
    308  1.151     skrll 		return UMATCH_IFACECLASS;
    309   1.28  augustss 	}
    310   1.28  augustss 
    311  1.151     skrll 	switch (uiaa->uiaa_proto) {
    312   1.78   gehenna 	case UIPROTO_MASS_CBI_I:
    313   1.28  augustss 	case UIPROTO_MASS_CBI:
    314   1.78   gehenna 	case UIPROTO_MASS_BBB_OLD:
    315   1.28  augustss 	case UIPROTO_MASS_BBB:
    316   1.28  augustss 		break;
    317   1.28  augustss 	default:
    318  1.151     skrll 		return UMATCH_IFACECLASS_IFACESUBCLASS;
    319   1.28  augustss 	}
    320    1.1   thorpej 
    321  1.151     skrll 	return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO;
    322    1.1   thorpej }
    323    1.1   thorpej 
    324  1.176      maxv static void
    325  1.131    dyoung umass_attach(device_t parent, device_t self, void *aux)
    326    1.1   thorpej {
    327  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
    328  1.131    dyoung 	struct umass_softc *sc = device_private(self);
    329  1.151     skrll 	struct usbif_attach_arg *uiaa = aux;
    330   1.78   gehenna 	const struct umass_quirk *quirk;
    331    1.1   thorpej 	usb_interface_descriptor_t *id;
    332    1.1   thorpej 	usb_endpoint_descriptor_t *ed;
    333   1.78   gehenna 	const char *sWire, *sCommand;
    334  1.118  augustss 	char *devinfop;
    335   1.78   gehenna 	usbd_status err;
    336  1.148   mlelstv 	int i, error;
    337    1.1   thorpej 
    338  1.128      cube 	sc->sc_dev = self;
    339  1.128      cube 
    340  1.134    plunky 	aprint_naive("\n");
    341  1.134    plunky 	aprint_normal("\n");
    342  1.134    plunky 
    343  1.151     skrll 	mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB);
    344  1.145       mrg 	cv_init(&sc->sc_detach_cv, "umassdet");
    345  1.145       mrg 
    346  1.151     skrll 	devinfop = usbd_devinfo_alloc(uiaa->uiaa_device, 0);
    347  1.134    plunky 	aprint_normal_dev(self, "%s\n", devinfop);
    348  1.118  augustss 	usbd_devinfo_free(devinfop);
    349    1.1   thorpej 
    350  1.151     skrll 	sc->sc_udev = uiaa->uiaa_device;
    351  1.151     skrll 	sc->sc_iface = uiaa->uiaa_iface;
    352  1.151     skrll 	sc->sc_ifaceno = uiaa->uiaa_ifaceno;
    353   1.28  augustss 
    354  1.151     skrll 	quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product);
    355   1.78   gehenna 	if (quirk != NULL) {
    356   1.78   gehenna 		sc->sc_wire = quirk->uq_wire;
    357   1.78   gehenna 		sc->sc_cmd = quirk->uq_cmd;
    358   1.78   gehenna 		sc->sc_quirks = quirk->uq_flags;
    359   1.82  augustss 		sc->sc_busquirks = quirk->uq_busquirks;
    360   1.78   gehenna 
    361   1.78   gehenna 		if (quirk->uq_fixup != NULL)
    362   1.78   gehenna 			(*quirk->uq_fixup)(sc);
    363   1.78   gehenna 	} else {
    364   1.78   gehenna 		sc->sc_wire = UMASS_WPROTO_UNSPEC;
    365   1.78   gehenna 		sc->sc_cmd = UMASS_CPROTO_UNSPEC;
    366   1.78   gehenna 		sc->sc_quirks = 0;
    367   1.82  augustss 		sc->sc_busquirks = 0;
    368   1.78   gehenna 	}
    369   1.78   gehenna 
    370   1.78   gehenna 	if (sc->sc_wire == UMASS_WPROTO_UNSPEC) {
    371  1.151     skrll 		switch (uiaa->uiaa_proto) {
    372   1.78   gehenna 		case UIPROTO_MASS_CBI:
    373   1.78   gehenna 			sc->sc_wire = UMASS_WPROTO_CBI;
    374   1.78   gehenna 			break;
    375   1.78   gehenna 		case UIPROTO_MASS_CBI_I:
    376   1.78   gehenna 			sc->sc_wire = UMASS_WPROTO_CBI_I;
    377   1.78   gehenna 			break;
    378   1.78   gehenna 		case UIPROTO_MASS_BBB:
    379   1.78   gehenna 		case UIPROTO_MASS_BBB_OLD:
    380   1.78   gehenna 			sc->sc_wire = UMASS_WPROTO_BBB;
    381   1.78   gehenna 			break;
    382   1.78   gehenna 		default:
    383  1.160  pgoyette 			DPRINTFM(UDMASS_GEN, "Unsupported wire protocol %ju",
    384  1.153     skrll 			    uiaa->uiaa_proto, 0, 0, 0);
    385  1.131    dyoung 			return;
    386   1.78   gehenna 		}
    387   1.40  augustss 	}
    388   1.28  augustss 
    389   1.78   gehenna 	if (sc->sc_cmd == UMASS_CPROTO_UNSPEC) {
    390  1.151     skrll 		switch (uiaa->uiaa_subclass) {
    391   1.78   gehenna 		case UISUBCLASS_SCSI:
    392   1.78   gehenna 			sc->sc_cmd = UMASS_CPROTO_SCSI;
    393   1.78   gehenna 			break;
    394   1.78   gehenna 		case UISUBCLASS_UFI:
    395   1.78   gehenna 			sc->sc_cmd = UMASS_CPROTO_UFI;
    396   1.78   gehenna 			break;
    397   1.78   gehenna 		case UISUBCLASS_SFF8020I:
    398   1.78   gehenna 		case UISUBCLASS_SFF8070I:
    399   1.78   gehenna 		case UISUBCLASS_QIC157:
    400   1.78   gehenna 			sc->sc_cmd = UMASS_CPROTO_ATAPI;
    401   1.78   gehenna 			break;
    402   1.78   gehenna 		case UISUBCLASS_RBC:
    403   1.78   gehenna 			sc->sc_cmd = UMASS_CPROTO_RBC;
    404   1.78   gehenna 			break;
    405   1.78   gehenna 		default:
    406  1.160  pgoyette 			DPRINTFM(UDMASS_GEN, "Unsupported command protocol %ju",
    407  1.153     skrll 			    uiaa->uiaa_subclass, 0, 0, 0);
    408  1.131    dyoung 			return;
    409   1.78   gehenna 		}
    410   1.78   gehenna 	}
    411   1.17   thorpej 
    412   1.78   gehenna 	switch (sc->sc_wire) {
    413   1.78   gehenna 	case UMASS_WPROTO_CBI:
    414   1.78   gehenna 		sWire = "CBI";
    415   1.32  augustss 		break;
    416   1.78   gehenna 	case UMASS_WPROTO_CBI_I:
    417   1.78   gehenna 		sWire = "CBI with CCI";
    418   1.28  augustss 		break;
    419   1.78   gehenna 	case UMASS_WPROTO_BBB:
    420   1.78   gehenna 		sWire = "Bulk-Only";
    421   1.28  augustss 		break;
    422   1.17   thorpej 	default:
    423   1.78   gehenna 		sWire = "unknown";
    424   1.28  augustss 		break;
    425   1.17   thorpej 	}
    426   1.78   gehenna 
    427   1.78   gehenna 	switch (sc->sc_cmd) {
    428   1.78   gehenna 	case UMASS_CPROTO_RBC:
    429   1.78   gehenna 		sCommand = "RBC";
    430   1.78   gehenna 		break;
    431   1.78   gehenna 	case UMASS_CPROTO_SCSI:
    432   1.78   gehenna 		sCommand = "SCSI";
    433   1.28  augustss 		break;
    434   1.78   gehenna 	case UMASS_CPROTO_UFI:
    435   1.78   gehenna 		sCommand = "UFI";
    436   1.28  augustss 		break;
    437   1.78   gehenna 	case UMASS_CPROTO_ATAPI:
    438   1.78   gehenna 		sCommand = "ATAPI";
    439   1.32  augustss 		break;
    440   1.80  augustss 	case UMASS_CPROTO_ISD_ATA:
    441   1.80  augustss 		sCommand = "ISD-ATA";
    442   1.80  augustss 		break;
    443   1.17   thorpej 	default:
    444   1.78   gehenna 		sCommand = "unknown";
    445   1.32  augustss 		break;
    446   1.17   thorpej 	}
    447   1.78   gehenna 
    448  1.132  jmcneill 	aprint_verbose_dev(self, "using %s over %s\n", sCommand, sWire);
    449    1.1   thorpej 
    450  1.104   mycroft 	if (quirk != NULL && quirk->uq_init != NULL) {
    451  1.104   mycroft 		err = (*quirk->uq_init)(sc);
    452  1.104   mycroft 		if (err) {
    453  1.128      cube 			aprint_error_dev(self, "quirk init failed\n");
    454  1.104   mycroft 			umass_disco(sc);
    455  1.131    dyoung 			return;
    456  1.104   mycroft 		}
    457  1.104   mycroft 	}
    458  1.104   mycroft 
    459    1.1   thorpej 	/*
    460   1.28  augustss 	 * In addition to the Control endpoint the following endpoints
    461   1.28  augustss 	 * are required:
    462   1.28  augustss 	 * a) bulk-in endpoint.
    463   1.28  augustss 	 * b) bulk-out endpoint.
    464   1.28  augustss 	 * and for Control/Bulk/Interrupt with CCI (CBI_I)
    465   1.28  augustss 	 * c) intr-in
    466    1.1   thorpej 	 *
    467    1.1   thorpej 	 * The endpoint addresses are not fixed, so we have to read them
    468    1.1   thorpej 	 * from the device descriptors of the current interface.
    469    1.1   thorpej 	 */
    470  1.124  drochner 	id = usbd_get_interface_descriptor(sc->sc_iface);
    471    1.1   thorpej 	for (i = 0 ; i < id->bNumEndpoints ; i++) {
    472   1.76   gehenna 		ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
    473   1.78   gehenna 		if (ed == NULL) {
    474  1.128      cube 			aprint_error_dev(self,
    475  1.128      cube 			    "could not read endpoint descriptor\n");
    476  1.131    dyoung 			return;
    477    1.1   thorpej 		}
    478   1.11  augustss 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
    479    1.1   thorpej 		    && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    480   1.73   gehenna 			sc->sc_epaddr[UMASS_BULKIN] = ed->bEndpointAddress;
    481   1.11  augustss 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
    482    1.1   thorpej 		    && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    483   1.73   gehenna 			sc->sc_epaddr[UMASS_BULKOUT] = ed->bEndpointAddress;
    484   1.78   gehenna 		} else if (sc->sc_wire == UMASS_WPROTO_CBI_I
    485   1.28  augustss 		    && UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
    486   1.28  augustss 		    && (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
    487   1.73   gehenna 			sc->sc_epaddr[UMASS_INTRIN] = ed->bEndpointAddress;
    488   1.28  augustss #ifdef UMASS_DEBUG
    489   1.28  augustss 			if (UGETW(ed->wMaxPacketSize) > 2) {
    490  1.160  pgoyette 				DPRINTFM(UDMASS_CBI, "sc %#jx intr size is %jd",
    491  1.160  pgoyette 				    (uintptr_t)sc, UGETW(ed->wMaxPacketSize),
    492  1.160  pgoyette 				    0, 0);
    493   1.28  augustss 			}
    494   1.28  augustss #endif
    495    1.1   thorpej 		}
    496    1.1   thorpej 	}
    497    1.1   thorpej 
    498   1.28  augustss 	/* check whether we found all the endpoints we need */
    499   1.73   gehenna 	if (!sc->sc_epaddr[UMASS_BULKIN] || !sc->sc_epaddr[UMASS_BULKOUT] ||
    500   1.78   gehenna 	    (sc->sc_wire == UMASS_WPROTO_CBI_I &&
    501   1.78   gehenna 	     !sc->sc_epaddr[UMASS_INTRIN])) {
    502  1.128      cube 		aprint_error_dev(self, "endpoint not found %u/%u/%u\n",
    503  1.128      cube 		       sc->sc_epaddr[UMASS_BULKIN],
    504  1.105  augustss 		       sc->sc_epaddr[UMASS_BULKOUT],
    505  1.105  augustss 		       sc->sc_epaddr[UMASS_INTRIN]);
    506  1.131    dyoung 		return;
    507   1.28  augustss 	}
    508   1.28  augustss 
    509    1.7   thorpej 	/*
    510    1.7   thorpej 	 * Get the maximum LUN supported by the device.
    511    1.7   thorpej 	 */
    512  1.129     rmind 	if (sc->sc_wire == UMASS_WPROTO_BBB &&
    513  1.129     rmind 	    (sc->sc_quirks & UMASS_QUIRK_NOGETMAXLUN) == 0) {
    514   1.28  augustss 		err = umass_bbb_get_max_lun(sc, &sc->maxlun);
    515   1.28  augustss 		if (err) {
    516  1.128      cube 			aprint_error_dev(self, "unable to get Max Lun: %s\n",
    517  1.128      cube 			    usbd_errstr(err));
    518  1.131    dyoung 			return;
    519   1.28  augustss 		}
    520   1.99   mycroft 		if (sc->maxlun > 0)
    521   1.99   mycroft 			sc->sc_busquirks |= PQUIRK_FORCELUNS;
    522   1.28  augustss 	} else {
    523   1.28  augustss 		sc->maxlun = 0;
    524    1.7   thorpej 	}
    525    1.7   thorpej 
    526    1.1   thorpej 	/* Open the bulk-in and -out pipe */
    527  1.160  pgoyette 	DPRINTFM(UDMASS_USB, "sc %#jx: opening iface %#jx epaddr %jd for "
    528  1.160  pgoyette 	    "BULKOUT", (uintptr_t)sc, (uintptr_t)sc->sc_iface,
    529  1.160  pgoyette 	    sc->sc_epaddr[UMASS_BULKOUT], 0);
    530   1.76   gehenna 	err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKOUT],
    531  1.157     skrll 	    USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKOUT]);
    532    1.1   thorpej 	if (err) {
    533  1.128      cube 		aprint_error_dev(self, "cannot open %u-out pipe (bulk)\n",
    534  1.128      cube 		    sc->sc_epaddr[UMASS_BULKOUT]);
    535   1.28  augustss 		umass_disco(sc);
    536  1.131    dyoung 		return;
    537    1.1   thorpej 	}
    538  1.160  pgoyette 	DPRINTFM(UDMASS_USB, "sc %#jx: opening iface %#jx epaddr %jd for "
    539  1.160  pgoyette 	    "BULKIN", (uintptr_t)sc, (uintptr_t)sc->sc_iface,
    540  1.160  pgoyette 	    sc->sc_epaddr[UMASS_BULKIN], 0);
    541   1.76   gehenna 	err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN],
    542  1.157     skrll 	    USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKIN]);
    543    1.1   thorpej 	if (err) {
    544  1.128      cube 		aprint_error_dev(self, "could not open %u-in pipe (bulk)\n",
    545  1.128      cube 		    sc->sc_epaddr[UMASS_BULKIN]);
    546   1.28  augustss 		umass_disco(sc);
    547  1.131    dyoung 		return;
    548    1.1   thorpej 	}
    549   1.88  augustss 	/*
    550   1.28  augustss 	 * Open the intr-in pipe if the protocol is CBI with CCI.
    551   1.28  augustss 	 * Note: early versions of the Zip drive do have an interrupt pipe, but
    552   1.28  augustss 	 * this pipe is unused
    553   1.28  augustss 	 *
    554   1.28  augustss 	 * We do not open the interrupt pipe as an interrupt pipe, but as a
    555   1.28  augustss 	 * normal bulk endpoint. We send an IN transfer down the wire at the
    556   1.28  augustss 	 * appropriate time, because we know exactly when to expect data on
    557   1.28  augustss 	 * that endpoint. This saves bandwidth, but more important, makes the
    558   1.28  augustss 	 * code for handling the data on that endpoint simpler. No data
    559   1.28  augustss 	 * arriving concurrently.
    560   1.28  augustss 	 */
    561   1.78   gehenna 	if (sc->sc_wire == UMASS_WPROTO_CBI_I) {
    562  1.156   msaitoh 		DPRINTFM(UDMASS_USB,
    563  1.160  pgoyette 		    "sc %#jx: opening iface %#jx epaddr %jd for INTRIN",
    564  1.160  pgoyette 		    (uintptr_t)sc, (uintptr_t)sc->sc_iface,
    565  1.160  pgoyette 		    sc->sc_epaddr[UMASS_INTRIN], 0);
    566   1.76   gehenna 		err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN],
    567  1.157     skrll 		    USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_INTRIN]);
    568   1.28  augustss 		if (err) {
    569  1.128      cube 			aprint_error_dev(self, "couldn't open %u-in (intr)\n",
    570  1.128      cube 			    sc->sc_epaddr[UMASS_INTRIN]);
    571   1.28  augustss 			umass_disco(sc);
    572  1.131    dyoung 			return;
    573   1.28  augustss 		}
    574   1.28  augustss 	}
    575   1.28  augustss 
    576   1.28  augustss 	/* initialisation of generic part */
    577   1.28  augustss 	sc->transfer_state = TSTATE_IDLE;
    578   1.28  augustss 
    579   1.28  augustss 	for (i = 0; i < XFER_NR; i++) {
    580  1.151     skrll 		sc->transfer_xfer[i] = NULL;
    581   1.28  augustss 	}
    582  1.151     skrll 
    583  1.151     skrll 	/*
    584  1.151     skrll 	 * Create the transfers
    585  1.151     skrll 	 */
    586  1.151     skrll 	struct usbd_pipe *pipe0 = usbd_get_pipe0(sc->sc_udev);
    587   1.78   gehenna 	switch (sc->sc_wire) {
    588   1.78   gehenna 	case UMASS_WPROTO_BBB:
    589  1.151     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
    590  1.163     skrll 		    UMASS_MAX_TRANSFER_SIZE, 0, 0,
    591  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_DATAIN]);
    592  1.151     skrll 		if (err)
    593  1.151     skrll 			goto fail_create;
    594  1.151     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT],
    595  1.163     skrll 		    UMASS_MAX_TRANSFER_SIZE, 0, 0,
    596  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_DATAOUT]);
    597  1.151     skrll 		if (err)
    598  1.151     skrll 			goto fail_create;
    599  1.151     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT],
    600  1.163     skrll 		    UMASS_BBB_CBW_SIZE, 0, 0,
    601  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_CBW]);
    602  1.151     skrll 		if (err)
    603  1.151     skrll 			goto fail_create;
    604  1.151     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
    605  1.163     skrll 		    UMASS_BBB_CSW_SIZE, 0, 0,
    606  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_CSW1]);
    607  1.151     skrll 		if (err)
    608  1.151     skrll 			goto fail_create;
    609  1.151     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
    610  1.163     skrll 		    UMASS_BBB_CSW_SIZE, 0, 0,
    611  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_CSW2]);
    612  1.151     skrll 		if (err)
    613  1.151     skrll 			goto fail_create;
    614  1.151     skrll 		err = usbd_create_xfer(pipe0, 0, 0, 0,
    615  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_SCLEAR]);
    616  1.151     skrll 		if (err)
    617  1.151     skrll 			goto fail_create;
    618  1.151     skrll 		err = usbd_create_xfer(pipe0, 0, 0, 0,
    619  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_DCLEAR]);
    620  1.151     skrll 		if (err)
    621  1.151     skrll 			goto fail_create;
    622  1.151     skrll 		err = usbd_create_xfer(pipe0, 0, 0, 0,
    623  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_RESET1]);
    624  1.151     skrll 		if (err)
    625  1.151     skrll 			goto fail_create;
    626  1.151     skrll 		err = usbd_create_xfer(pipe0, 0, 0, 0,
    627  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_RESET2]);
    628  1.151     skrll 		if (err)
    629  1.151     skrll 			goto fail_create;
    630  1.151     skrll 		err = usbd_create_xfer(pipe0, 0, 0, 0,
    631  1.151     skrll 		    &sc->transfer_xfer[XFER_BBB_RESET3]);
    632  1.151     skrll 		if (err)
    633  1.151     skrll 			goto fail_create;
    634  1.148   mlelstv 		break;
    635   1.78   gehenna 	case UMASS_WPROTO_CBI:
    636   1.78   gehenna 	case UMASS_WPROTO_CBI_I:
    637  1.151     skrll 		err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
    638  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_CB]);
    639  1.151     skrll 		if (err)
    640  1.151     skrll 			goto fail_create;
    641  1.151     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
    642  1.163     skrll 		    UMASS_MAX_TRANSFER_SIZE, 0, 0,
    643  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_DATAIN]);
    644  1.151     skrll 		if (err)
    645  1.151     skrll 			goto fail_create;
    646  1.151     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT],
    647  1.151     skrll 		    UMASS_MAX_TRANSFER_SIZE, 0, 0,
    648  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_DATAOUT]);
    649  1.151     skrll 		if (err)
    650  1.151     skrll 			goto fail_create;
    651  1.152     skrll 		err = usbd_create_xfer(sc->sc_pipe[UMASS_INTRIN],
    652  1.152     skrll 		    sizeof(sc->sbl), 0, 0,
    653  1.152     skrll 		    &sc->transfer_xfer[XFER_CBI_STATUS]);
    654  1.151     skrll 		if (err)
    655  1.151     skrll 			goto fail_create;
    656  1.151     skrll 		err = usbd_create_xfer(pipe0, 0, 0, 0,
    657  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_DCLEAR]);
    658  1.151     skrll 		if (err)
    659  1.151     skrll 			goto fail_create;
    660  1.151     skrll 		err = usbd_create_xfer(pipe0, 0, 0, 0,
    661  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_SCLEAR]);
    662  1.151     skrll 		if (err)
    663  1.151     skrll 			goto fail_create;
    664  1.151     skrll 		err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
    665  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_RESET1]);
    666  1.151     skrll 		if (err)
    667  1.151     skrll 			goto fail_create;
    668  1.151     skrll 		err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
    669  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_RESET2]);
    670  1.151     skrll 		if (err)
    671  1.151     skrll 			goto fail_create;
    672  1.151     skrll 		err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
    673  1.151     skrll 		    &sc->transfer_xfer[XFER_CBI_RESET3]);
    674  1.151     skrll 		if (err)
    675  1.151     skrll 			goto fail_create;
    676   1.28  augustss 		break;
    677   1.28  augustss 	default:
    678  1.151     skrll 	fail_create:
    679  1.151     skrll 		aprint_error_dev(self, "failed to create xfers\n");
    680  1.151     skrll 		umass_disco(sc);
    681  1.151     skrll 		return;
    682   1.28  augustss 	}
    683    1.1   thorpej 
    684  1.151     skrll 	/*
    685  1.170     skrll 	 * Record buffer pointers for data transfer (it's huge), command and
    686  1.151     skrll 	 * status data here
    687  1.151     skrll 	 */
    688  1.151     skrll 	switch (sc->sc_wire) {
    689  1.151     skrll 	case UMASS_WPROTO_BBB:
    690  1.151     skrll 		sc->datain_buffer =
    691  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAIN]);
    692  1.151     skrll 		sc->dataout_buffer =
    693  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAOUT]);
    694  1.151     skrll 		sc->cmd_buffer =
    695  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CBW]);
    696  1.151     skrll 		sc->s1_buffer =
    697  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW1]);
    698  1.151     skrll 		sc->s2_buffer =
    699  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW2]);
    700  1.151     skrll 		break;
    701  1.151     skrll 	case UMASS_WPROTO_CBI:
    702  1.151     skrll 	case UMASS_WPROTO_CBI_I:
    703  1.151     skrll 		sc->datain_buffer =
    704  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAIN]);
    705  1.151     skrll 		sc->dataout_buffer =
    706  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAOUT]);
    707  1.151     skrll 		sc->cmd_buffer =
    708  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_CBI_CB]);
    709  1.151     skrll 		sc->s1_buffer =
    710  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_CBI_STATUS]);
    711  1.151     skrll 		sc->s2_buffer =
    712  1.151     skrll 		    usbd_get_buffer(sc->transfer_xfer[XFER_CBI_RESET1]);
    713  1.151     skrll 		break;
    714  1.151     skrll 	default:
    715  1.151     skrll 		break;
    716  1.148   mlelstv 	}
    717  1.148   mlelstv 
    718   1.28  augustss 	/* Initialise the wire protocol specific methods */
    719   1.78   gehenna 	switch (sc->sc_wire) {
    720   1.78   gehenna 	case UMASS_WPROTO_BBB:
    721   1.75   gehenna 		sc->sc_methods = &umass_bbb_methods;
    722   1.78   gehenna 		break;
    723   1.78   gehenna 	case UMASS_WPROTO_CBI:
    724   1.78   gehenna 	case UMASS_WPROTO_CBI_I:
    725   1.75   gehenna 		sc->sc_methods = &umass_cbi_methods;
    726   1.78   gehenna 		break;
    727   1.78   gehenna 	default:
    728   1.78   gehenna 		umass_disco(sc);
    729  1.131    dyoung 		return;
    730   1.78   gehenna 	}
    731   1.28  augustss 
    732   1.79  augustss 	error = 0;
    733   1.79  augustss 	switch (sc->sc_cmd) {
    734   1.79  augustss 	case UMASS_CPROTO_RBC:
    735   1.79  augustss 	case UMASS_CPROTO_SCSI:
    736   1.79  augustss #if NSCSIBUS > 0
    737   1.79  augustss 		error = umass_scsi_attach(sc);
    738   1.79  augustss #else
    739  1.128      cube 		aprint_error_dev(self, "scsibus not configured\n");
    740   1.79  augustss #endif
    741   1.79  augustss 		break;
    742   1.79  augustss 
    743   1.79  augustss 	case UMASS_CPROTO_UFI:
    744   1.79  augustss 	case UMASS_CPROTO_ATAPI:
    745   1.79  augustss #if NATAPIBUS > 0
    746   1.79  augustss 		error = umass_atapi_attach(sc);
    747   1.79  augustss #else
    748  1.128      cube 		aprint_error_dev(self, "atapibus not configured\n");
    749   1.80  augustss #endif
    750   1.80  augustss 		break;
    751   1.80  augustss 
    752   1.80  augustss 	case UMASS_CPROTO_ISD_ATA:
    753  1.164  jdolecek #if NWD > 0 && NATABUS > 0
    754   1.80  augustss 		error = umass_isdata_attach(sc);
    755   1.80  augustss #else
    756  1.128      cube 		aprint_error_dev(self, "isdata not configured\n");
    757   1.79  augustss #endif
    758   1.79  augustss 		break;
    759   1.79  augustss 
    760   1.79  augustss 	default:
    761  1.128      cube 		aprint_error_dev(self, "command protocol=0x%x not supported\n",
    762  1.128      cube 		    sc->sc_cmd);
    763   1.28  augustss 		umass_disco(sc);
    764  1.131    dyoung 		return;
    765   1.28  augustss 	}
    766   1.79  augustss 	if (error) {
    767  1.128      cube 		aprint_error_dev(self, "bus attach failed\n");
    768   1.79  augustss 		umass_disco(sc);
    769  1.131    dyoung 		return;
    770   1.79  augustss 	}
    771   1.79  augustss 
    772  1.156   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
    773    1.1   thorpej 
    774  1.125  jmcneill 	if (!pmf_device_register(self, NULL, NULL))
    775  1.125  jmcneill 		aprint_error_dev(self, "couldn't establish power handler\n");
    776  1.125  jmcneill 
    777  1.160  pgoyette 	DPRINTFM(UDMASS_GEN, "sc %#jx: Attach finished", (uintptr_t)sc,
    778  1.160  pgoyette 	    0, 0, 0);
    779   1.28  augustss 
    780  1.131    dyoung 	return;
    781    1.1   thorpej }
    782    1.1   thorpej 
    783  1.131    dyoung static void
    784  1.131    dyoung umass_childdet(device_t self, device_t child)
    785  1.131    dyoung {
    786  1.131    dyoung 	struct umass_softc *sc = device_private(self);
    787  1.131    dyoung 
    788  1.142       mrg 	KASSERTMSG(child == sc->bus->sc_child,
    789  1.142       mrg 		   "assertion child == sc->bus->sc_child failed\n");
    790  1.131    dyoung 	sc->bus->sc_child = NULL;
    791  1.131    dyoung }
    792  1.131    dyoung 
    793  1.176      maxv static int
    794  1.131    dyoung umass_detach(device_t self, int flags)
    795   1.28  augustss {
    796  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
    797  1.131    dyoung 	struct umass_softc *sc = device_private(self);
    798  1.105  augustss 	struct umassbus_softc *scbus;
    799  1.145       mrg 	int rv = 0, i;
    800    1.1   thorpej 
    801  1.160  pgoyette 	DPRINTFM(UDMASS_USB, "sc %#jx detached", (uintptr_t)sc, 0, 0, 0);
    802   1.28  augustss 
    803  1.166   mlelstv 	mutex_enter(&sc->sc_lock);
    804  1.158     skrll 	sc->sc_dying = true;
    805  1.166   mlelstv 	mutex_exit(&sc->sc_lock);
    806  1.158     skrll 
    807  1.125  jmcneill 	pmf_device_deregister(self);
    808  1.125  jmcneill 
    809   1.28  augustss 	/* Abort the pipes to wake up any waiting processes. */
    810   1.73   gehenna 	for (i = 0 ; i < UMASS_NEP ; i++) {
    811  1.117   nathanw 		if (sc->sc_pipe[i] != NULL)
    812   1.73   gehenna 			usbd_abort_pipe(sc->sc_pipe[i]);
    813   1.73   gehenna 	}
    814  1.177  riastrad 	usbd_abort_default_pipe(sc->sc_udev);
    815   1.28  augustss 
    816   1.42  augustss 	/* Do we really need reference counting?  Perhaps in ioctl() */
    817  1.145       mrg 	mutex_enter(&sc->sc_lock);
    818   1.28  augustss 	if (--sc->sc_refcnt >= 0) {
    819   1.95  augustss #ifdef DIAGNOSTIC
    820  1.128      cube 		aprint_normal_dev(self, "waiting for refcnt\n");
    821   1.95  augustss #endif
    822   1.28  augustss 		/* Wait for processes to go away. */
    823  1.169     skrll 		if (cv_timedwait(&sc->sc_detach_cv, &sc->sc_lock, hz * 60))
    824  1.169     skrll 			aprint_error_dev(self, ": didn't detach\n");
    825   1.28  augustss 	}
    826  1.145       mrg 	mutex_exit(&sc->sc_lock);
    827   1.28  augustss 
    828  1.105  augustss 	scbus = sc->bus;
    829   1.79  augustss 	if (scbus != NULL) {
    830   1.79  augustss 		if (scbus->sc_child != NULL)
    831   1.79  augustss 			rv = config_detach(scbus->sc_child, flags);
    832  1.159  jdolecek 
    833  1.159  jdolecek 		switch (sc->sc_cmd) {
    834  1.174  jdolecek 		case UMASS_CPROTO_RBC:
    835  1.174  jdolecek 		case UMASS_CPROTO_SCSI:
    836  1.174  jdolecek #if NSCSIBUS > 0
    837  1.174  jdolecek 			umass_scsi_detach(sc);
    838  1.174  jdolecek #else
    839  1.174  jdolecek 			aprint_error_dev(self, "scsibus not configured\n");
    840  1.174  jdolecek #endif
    841  1.174  jdolecek 			break;
    842  1.174  jdolecek 
    843  1.174  jdolecek 		case UMASS_CPROTO_UFI:
    844  1.174  jdolecek 		case UMASS_CPROTO_ATAPI:
    845  1.174  jdolecek #if NATAPIBUS > 0
    846  1.174  jdolecek 			umass_atapi_detach(sc);
    847  1.174  jdolecek #else
    848  1.174  jdolecek 			aprint_error_dev(self, "atapibus not configured\n");
    849  1.174  jdolecek #endif
    850  1.174  jdolecek 			break;
    851  1.174  jdolecek 
    852  1.159  jdolecek 		case UMASS_CPROTO_ISD_ATA:
    853  1.159  jdolecek #if NWD > 0
    854  1.159  jdolecek 			umass_isdata_detach(sc);
    855  1.159  jdolecek #else
    856  1.159  jdolecek 			aprint_error_dev(self, "isdata not configured\n");
    857  1.159  jdolecek #endif
    858  1.159  jdolecek 			break;
    859  1.159  jdolecek 
    860  1.159  jdolecek 		default:
    861  1.159  jdolecek 			/* nothing to do */
    862  1.159  jdolecek 			break;
    863  1.159  jdolecek 		}
    864  1.159  jdolecek 
    865  1.174  jdolecek 		/* protocol detach is expected to free sc->bus */
    866  1.174  jdolecek 		KASSERT(sc->bus == NULL);
    867   1.79  augustss 	}
    868   1.56  augustss 
    869   1.28  augustss 	if (rv != 0)
    870  1.151     skrll 		return rv;
    871   1.28  augustss 
    872   1.28  augustss 	umass_disco(sc);
    873   1.28  augustss 
    874  1.156   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
    875   1.28  augustss 
    876  1.145       mrg 	mutex_destroy(&sc->sc_lock);
    877  1.145       mrg 	cv_destroy(&sc->sc_detach_cv);
    878  1.145       mrg 
    879  1.151     skrll 	return rv;
    880   1.79  augustss }
    881   1.79  augustss 
    882  1.176      maxv static int
    883  1.128      cube umass_activate(device_t dev, enum devact act)
    884   1.79  augustss {
    885  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
    886  1.128      cube 	struct umass_softc *sc = device_private(dev);
    887   1.79  augustss 
    888  1.160  pgoyette 	DPRINTFM(UDMASS_USB, "sc %#jx act %jd", (uintptr_t)sc, act, 0, 0);
    889   1.79  augustss 
    890   1.79  augustss 	switch (act) {
    891   1.79  augustss 	case DVACT_DEACTIVATE:
    892   1.79  augustss 		sc->sc_dying = 1;
    893  1.136    dyoung 		return 0;
    894  1.133    dyoung 	default:
    895  1.133    dyoung 		return EOPNOTSUPP;
    896   1.79  augustss 	}
    897   1.28  augustss }
    898   1.28  augustss 
    899   1.28  augustss Static void
    900   1.38  augustss umass_disco(struct umass_softc *sc)
    901   1.88  augustss {
    902  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
    903   1.28  augustss 	int i;
    904   1.28  augustss 
    905   1.28  augustss 	/* Remove all the pipes. */
    906   1.73   gehenna 	for (i = 0 ; i < UMASS_NEP ; i++) {
    907   1.93    toshii 		if (sc->sc_pipe[i] != NULL) {
    908  1.130    jmorse 			usbd_abort_pipe(sc->sc_pipe[i]);
    909   1.93    toshii 		}
    910   1.73   gehenna 	}
    911  1.130    jmorse 
    912  1.130    jmorse 	/* Some xfers may be queued in the default pipe */
    913  1.130    jmorse 	usbd_abort_default_pipe(sc->sc_udev);
    914  1.130    jmorse 
    915  1.130    jmorse 	/* Free the xfers. */
    916  1.151     skrll 	for (i = 0; i < XFER_NR; i++) {
    917  1.130    jmorse 		if (sc->transfer_xfer[i] != NULL) {
    918  1.151     skrll 			usbd_destroy_xfer(sc->transfer_xfer[i]);
    919  1.130    jmorse 			sc->transfer_xfer[i] = NULL;
    920  1.130    jmorse 		}
    921  1.151     skrll 	}
    922  1.151     skrll 
    923  1.151     skrll 	for (i = 0 ; i < UMASS_NEP ; i++) {
    924  1.151     skrll 		if (sc->sc_pipe[i] != NULL) {
    925  1.151     skrll 			usbd_close_pipe(sc->sc_pipe[i]);
    926  1.151     skrll 			sc->sc_pipe[i] = NULL;
    927  1.151     skrll 		}
    928  1.151     skrll 	}
    929  1.151     skrll 
    930   1.28  augustss }
    931    1.1   thorpej 
    932   1.28  augustss /*
    933   1.28  augustss  * Generic functions to handle transfers
    934   1.28  augustss  */
    935    1.9   thorpej 
    936   1.28  augustss Static usbd_status
    937  1.151     skrll umass_setup_transfer(struct umass_softc *sc, struct usbd_pipe *pipe,
    938   1.28  augustss 			void *buffer, int buflen, int flags,
    939  1.151     skrll 			struct usbd_xfer *xfer)
    940   1.28  augustss {
    941  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
    942   1.28  augustss 	usbd_status err;
    943    1.9   thorpej 
    944   1.28  augustss 	if (sc->sc_dying)
    945  1.151     skrll 		return USBD_IOERROR;
    946   1.18  augustss 
    947   1.28  augustss 	/* Initialiase a USB transfer and then schedule it */
    948   1.18  augustss 
    949  1.151     skrll 	usbd_setup_xfer(xfer, sc, buffer, buflen, flags, sc->timeout,
    950  1.151     skrll 	    sc->sc_methods->wire_state);
    951   1.18  augustss 
    952   1.28  augustss 	err = usbd_transfer(xfer);
    953  1.160  pgoyette 	DPRINTFM(UDMASS_XFER, "start xfer buffer=%#jx buflen=%jd flags=0x%jx "
    954  1.160  pgoyette 	    "timeout=%d", (uintptr_t)buffer, buflen, flags, sc->timeout);
    955   1.28  augustss 	if (err && err != USBD_IN_PROGRESS) {
    956  1.160  pgoyette 		DPRINTFM(UDMASS_BBB, "failed to setup transfer... err=%jd",
    957  1.153     skrll 		    err, 0, 0, 0);
    958  1.151     skrll 		return err;
    959    1.9   thorpej 	}
    960   1.24  augustss 
    961  1.151     skrll 	return USBD_NORMAL_COMPLETION;
    962    1.1   thorpej }
    963    1.1   thorpej 
    964    1.1   thorpej 
    965   1.28  augustss Static usbd_status
    966   1.74   gehenna umass_setup_ctrl_transfer(struct umass_softc *sc, usb_device_request_t *req,
    967  1.151     skrll 	 void *buffer, int buflen, int flags, struct usbd_xfer *xfer)
    968    1.1   thorpej {
    969  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
    970    1.1   thorpej 	usbd_status err;
    971    1.1   thorpej 
    972   1.28  augustss 	if (sc->sc_dying)
    973  1.151     skrll 		return USBD_IOERROR;
    974    1.1   thorpej 
    975   1.28  augustss 	/* Initialiase a USB control transfer and then schedule it */
    976    1.1   thorpej 
    977   1.75   gehenna 	usbd_setup_default_xfer(xfer, sc->sc_udev, (void *) sc, sc->timeout,
    978   1.75   gehenna 		req, buffer, buflen, flags, sc->sc_methods->wire_state);
    979    1.1   thorpej 
    980   1.28  augustss 	err = usbd_transfer(xfer);
    981   1.28  augustss 	if (err && err != USBD_IN_PROGRESS) {
    982  1.160  pgoyette 		DPRINTFM(UDMASS_BBB, "failed to setup ctrl transfer... err=%jd",
    983  1.153     skrll 		    err, 0, 0, 0);
    984    1.1   thorpej 
    985   1.28  augustss 		/* do not reset, as this would make us loop */
    986  1.151     skrll 		return err;
    987   1.28  augustss 	}
    988    1.1   thorpej 
    989  1.151     skrll 	return USBD_NORMAL_COMPLETION;
    990    1.1   thorpej }
    991    1.1   thorpej 
    992   1.28  augustss Static void
    993   1.73   gehenna umass_clear_endpoint_stall(struct umass_softc *sc, int endpt,
    994  1.151     skrll 	struct usbd_xfer *xfer)
    995    1.7   thorpej {
    996  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
    997  1.153     skrll 
    998  1.179  riastrad 	if (sc->sc_dying) {
    999  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen,
   1000  1.179  riastrad 		    STATUS_WIRE_FAILED);
   1001   1.28  augustss 		return;
   1002  1.179  riastrad 	}
   1003    1.1   thorpej 
   1004  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "Clear endpoint 0x%02jx stall",
   1005  1.153     skrll 	    sc->sc_epaddr[endpt], 0, 0, 0);
   1006    1.7   thorpej 
   1007   1.73   gehenna 	usbd_clear_endpoint_toggle(sc->sc_pipe[endpt]);
   1008    1.7   thorpej 
   1009   1.78   gehenna 	sc->sc_req.bmRequestType = UT_WRITE_ENDPOINT;
   1010   1.78   gehenna 	sc->sc_req.bRequest = UR_CLEAR_FEATURE;
   1011   1.78   gehenna 	USETW(sc->sc_req.wValue, UF_ENDPOINT_HALT);
   1012   1.78   gehenna 	USETW(sc->sc_req.wIndex, sc->sc_epaddr[endpt]);
   1013   1.78   gehenna 	USETW(sc->sc_req.wLength, 0);
   1014  1.179  riastrad 	if (umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, xfer))
   1015  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen,
   1016  1.179  riastrad 		    STATUS_WIRE_FAILED);
   1017   1.28  augustss }
   1018   1.15   thorpej 
   1019  1.178  riastrad Static void
   1020  1.178  riastrad umass_transfer_done(struct umass_softc *sc, int residue, int status)
   1021  1.178  riastrad {
   1022  1.178  riastrad 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1023  1.178  riastrad 
   1024  1.178  riastrad 	sc->transfer_state = TSTATE_IDLE;
   1025  1.178  riastrad 	sc->transfer_cb(sc, sc->transfer_priv, residue, status);
   1026  1.178  riastrad }
   1027  1.178  riastrad 
   1028  1.178  riastrad Static void
   1029  1.178  riastrad umass_transfer_reset(struct umass_softc *sc)
   1030  1.178  riastrad {
   1031  1.178  riastrad 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1032  1.178  riastrad 
   1033  1.178  riastrad 	sc->transfer_state = TSTATE_IDLE;
   1034  1.178  riastrad 	if (sc->transfer_priv)
   1035  1.178  riastrad 		sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen,
   1036  1.178  riastrad 		    sc->transfer_status);
   1037  1.178  riastrad }
   1038  1.178  riastrad 
   1039   1.29     enami #if 0
   1040   1.28  augustss Static void
   1041   1.28  augustss umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv)
   1042   1.28  augustss {
   1043   1.28  augustss 	sc->transfer_cb = cb;
   1044   1.28  augustss 	sc->transfer_priv = priv;
   1045    1.1   thorpej 
   1046   1.28  augustss 	/* The reset is a forced reset, so no error (yet) */
   1047   1.28  augustss 	sc->reset(sc, STATUS_CMD_OK);
   1048    1.7   thorpej }
   1049   1.29     enami #endif
   1050    1.1   thorpej 
   1051   1.28  augustss /*
   1052   1.28  augustss  * Bulk protocol specific functions
   1053   1.28  augustss  */
   1054   1.28  augustss 
   1055   1.28  augustss Static void
   1056   1.28  augustss umass_bbb_reset(struct umass_softc *sc, int status)
   1057    1.1   thorpej {
   1058  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1059  1.142       mrg 	KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
   1060  1.142       mrg 		   "sc->sc_wire == 0x%02x wrong for umass_bbb_reset\n",
   1061  1.142       mrg 		   sc->sc_wire);
   1062   1.28  augustss 
   1063  1.179  riastrad 	if (sc->sc_dying) {
   1064  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen, status);
   1065   1.28  augustss 		return;
   1066  1.179  riastrad 	}
   1067    1.1   thorpej 
   1068    1.1   thorpej 	/*
   1069    1.1   thorpej 	 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
   1070    1.1   thorpej 	 *
   1071    1.1   thorpej 	 * For Reset Recovery the host shall issue in the following order:
   1072    1.1   thorpej 	 * a) a Bulk-Only Mass Storage Reset
   1073    1.1   thorpej 	 * b) a Clear Feature HALT to the Bulk-In endpoint
   1074    1.1   thorpej 	 * c) a Clear Feature HALT to the Bulk-Out endpoint
   1075   1.28  augustss 	 *
   1076   1.28  augustss 	 * This is done in 3 steps, states:
   1077   1.28  augustss 	 * TSTATE_BBB_RESET1
   1078   1.28  augustss 	 * TSTATE_BBB_RESET2
   1079   1.28  augustss 	 * TSTATE_BBB_RESET3
   1080   1.28  augustss 	 *
   1081   1.28  augustss 	 * If the reset doesn't succeed, the device should be port reset.
   1082    1.1   thorpej 	 */
   1083    1.1   thorpej 
   1084  1.153     skrll 	DPRINTFM(UDMASS_BBB, "Bulk Reset", 0, 0, 0, 0);
   1085   1.88  augustss 
   1086   1.28  augustss 	sc->transfer_state = TSTATE_BBB_RESET1;
   1087   1.28  augustss 	sc->transfer_status = status;
   1088    1.1   thorpej 
   1089   1.28  augustss 	/* reset is a class specific interface write */
   1090   1.78   gehenna 	sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
   1091   1.78   gehenna 	sc->sc_req.bRequest = UR_BBB_RESET;
   1092   1.78   gehenna 	USETW(sc->sc_req.wValue, 0);
   1093   1.78   gehenna 	USETW(sc->sc_req.wIndex, sc->sc_ifaceno);
   1094   1.78   gehenna 	USETW(sc->sc_req.wLength, 0);
   1095  1.179  riastrad 	if (umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0,
   1096  1.179  riastrad 		sc->transfer_xfer[XFER_BBB_RESET1]))
   1097  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen, status);
   1098   1.28  augustss }
   1099   1.28  augustss 
   1100   1.28  augustss Static void
   1101   1.28  augustss umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen,
   1102   1.67  augustss 		   void *data, int datalen, int dir, u_int timeout,
   1103  1.143       mrg 		   int flags, umass_callback cb, void *priv)
   1104   1.28  augustss {
   1105  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1106   1.28  augustss 	static int dCBWtag = 42;	/* unique for CBW of transfer */
   1107    1.1   thorpej 
   1108  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "sc %#jx cmd=0x%02jx", (uintptr_t)sc,
   1109  1.160  pgoyette 	    *(u_char *)cmd, 0, 0);
   1110    1.1   thorpej 
   1111  1.142       mrg 	KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
   1112  1.142       mrg 		   "sc->sc_wire == 0x%02x wrong for umass_bbb_transfer\n",
   1113  1.142       mrg 		   sc->sc_wire);
   1114    1.1   thorpej 
   1115  1.179  riastrad 	if (sc->sc_dying) {
   1116  1.179  riastrad 		cb(sc, priv, datalen, STATUS_WIRE_FAILED);
   1117  1.116   mycroft 		return;
   1118  1.179  riastrad 	}
   1119  1.116   mycroft 
   1120   1.67  augustss 	/* Be a little generous. */
   1121   1.67  augustss 	sc->timeout = timeout + USBD_DEFAULT_TIMEOUT;
   1122   1.67  augustss 
   1123    1.1   thorpej 	/*
   1124   1.28  augustss 	 * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly
   1125   1.28  augustss 	 * a data phase of datalen bytes from/to the device and finally a
   1126   1.28  augustss 	 * csw read phase.
   1127   1.28  augustss 	 * If the data direction was inbound a maximum of datalen bytes
   1128   1.28  augustss 	 * is stored in the buffer pointed to by data.
   1129   1.28  augustss 	 *
   1130   1.28  augustss 	 * umass_bbb_transfer initialises the transfer and lets the state
   1131   1.88  augustss 	 * machine in umass_bbb_state handle the completion. It uses the
   1132   1.28  augustss 	 * following states:
   1133   1.28  augustss 	 * TSTATE_BBB_COMMAND
   1134   1.28  augustss 	 *   -> TSTATE_BBB_DATA
   1135   1.28  augustss 	 *   -> TSTATE_BBB_STATUS
   1136   1.28  augustss 	 *   -> TSTATE_BBB_STATUS2
   1137   1.28  augustss 	 *   -> TSTATE_BBB_IDLE
   1138   1.28  augustss 	 *
   1139   1.28  augustss 	 * An error in any of those states will invoke
   1140   1.28  augustss 	 * umass_bbb_reset.
   1141    1.1   thorpej 	 */
   1142    1.1   thorpej 
   1143    1.1   thorpej 	/* check the given arguments */
   1144  1.142       mrg 	KASSERTMSG(datalen == 0 || data != NULL,
   1145  1.142       mrg 		   "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev));
   1146  1.142       mrg 	KASSERTMSG(cmdlen <= CBWCDBLENGTH,
   1147  1.142       mrg 		   "%s: cmdlen exceeds CDB length in CBW (%d > %d)",
   1148  1.142       mrg 			device_xname(sc->sc_dev), cmdlen, CBWCDBLENGTH);
   1149  1.142       mrg 	KASSERTMSG(dir == DIR_NONE || datalen > 0,
   1150  1.142       mrg 		   "%s: datalen == 0 while direction is not NONE\n",
   1151  1.142       mrg 			device_xname(sc->sc_dev));
   1152  1.142       mrg 	KASSERTMSG(datalen == 0 || dir != DIR_NONE,
   1153  1.142       mrg 		   "%s: direction is NONE while datalen is not zero\n",
   1154  1.142       mrg 			device_xname(sc->sc_dev));
   1155  1.142       mrg 	/* CTASSERT */
   1156  1.142       mrg 	KASSERTMSG(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE,
   1157  1.142       mrg 		   "%s: CBW struct does not have the right size (%zu vs. %u)\n",
   1158  1.131    dyoung 			device_xname(sc->sc_dev),
   1159  1.142       mrg 			sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE);
   1160  1.142       mrg 	/* CTASSERT */
   1161  1.142       mrg 	KASSERTMSG(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE,
   1162  1.142       mrg 		   "%s: CSW struct does not have the right size (%zu vs. %u)\n",
   1163  1.131    dyoung 			device_xname(sc->sc_dev),
   1164  1.142       mrg 			sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE);
   1165    1.1   thorpej 
   1166    1.1   thorpej 	/*
   1167   1.28  augustss 	 * Determine the direction of the data transfer and the length.
   1168    1.1   thorpej 	 *
   1169    1.1   thorpej 	 * dCBWDataTransferLength (datalen) :
   1170    1.1   thorpej 	 *   This field indicates the number of bytes of data that the host
   1171    1.1   thorpej 	 *   intends to transfer on the IN or OUT Bulk endpoint(as indicated by
   1172    1.1   thorpej 	 *   the Direction bit) during the execution of this command. If this
   1173    1.1   thorpej 	 *   field is set to 0, the device will expect that no data will be
   1174    1.1   thorpej 	 *   transferred IN or OUT during this command, regardless of the value
   1175    1.1   thorpej 	 *   of the Direction bit defined in dCBWFlags.
   1176    1.1   thorpej 	 *
   1177    1.1   thorpej 	 * dCBWFlags (dir) :
   1178    1.1   thorpej 	 *   The bits of the Flags field are defined as follows:
   1179   1.28  augustss 	 *     Bits 0-6	 reserved
   1180   1.28  augustss 	 *     Bit  7	 Direction - this bit shall be ignored if the
   1181   1.28  augustss 	 *			     dCBWDataTransferLength field is zero.
   1182   1.28  augustss 	 *		 0 = data Out from host to device
   1183   1.28  augustss 	 *		 1 = data In from device to host
   1184    1.1   thorpej 	 */
   1185    1.1   thorpej 
   1186   1.28  augustss 	/* Fill in the Command Block Wrapper */
   1187   1.28  augustss 	USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
   1188   1.28  augustss 	USETDW(sc->cbw.dCBWTag, dCBWtag);
   1189   1.28  augustss 	dCBWtag++;	/* cannot be done in macro (it will be done 4 times) */
   1190   1.28  augustss 	USETDW(sc->cbw.dCBWDataTransferLength, datalen);
   1191   1.28  augustss 	/* DIR_NONE is treated as DIR_OUT (0x00) */
   1192   1.28  augustss 	sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT);
   1193   1.28  augustss 	sc->cbw.bCBWLUN = lun;
   1194   1.28  augustss 	sc->cbw.bCDBLength = cmdlen;
   1195   1.69   gehenna 	memcpy(sc->cbw.CBWCDB, cmd, cmdlen);
   1196   1.28  augustss 
   1197   1.28  augustss 	DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw));
   1198   1.28  augustss 
   1199   1.28  augustss 	/* store the details for the data transfer phase */
   1200   1.28  augustss 	sc->transfer_dir = dir;
   1201   1.28  augustss 	sc->transfer_data = data;
   1202   1.28  augustss 	sc->transfer_datalen = datalen;
   1203   1.28  augustss 	sc->transfer_actlen = 0;
   1204   1.28  augustss 	sc->transfer_cb = cb;
   1205   1.28  augustss 	sc->transfer_priv = priv;
   1206   1.28  augustss 	sc->transfer_status = STATUS_CMD_OK;
   1207    1.1   thorpej 
   1208   1.28  augustss 	/* move from idle to the command state */
   1209   1.28  augustss 	sc->transfer_state = TSTATE_BBB_COMMAND;
   1210    1.1   thorpej 
   1211    1.1   thorpej 	/* Send the CBW from host to device via bulk-out endpoint. */
   1212   1.73   gehenna 	if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT],
   1213  1.143       mrg 			&sc->cbw, UMASS_BBB_CBW_SIZE, flags,
   1214   1.28  augustss 			sc->transfer_xfer[XFER_BBB_CBW])) {
   1215   1.28  augustss 		umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1216    1.1   thorpej 	}
   1217   1.28  augustss }
   1218   1.28  augustss 
   1219    1.1   thorpej 
   1220   1.28  augustss Static void
   1221  1.151     skrll umass_bbb_state(struct usbd_xfer *xfer, void *priv,
   1222   1.28  augustss 		usbd_status err)
   1223   1.28  augustss {
   1224  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1225   1.28  augustss 	struct umass_softc *sc = (struct umass_softc *) priv;
   1226  1.151     skrll 	struct usbd_xfer *next_xfer;
   1227  1.135        is 	int residue;
   1228   1.28  augustss 
   1229  1.142       mrg 	KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
   1230  1.142       mrg 		   "sc->sc_wire == 0x%02x wrong for umass_bbb_state\n",
   1231  1.142       mrg 		   sc->sc_wire);
   1232   1.28  augustss 
   1233    1.1   thorpej 	/*
   1234   1.28  augustss 	 * State handling for BBB transfers.
   1235   1.28  augustss 	 *
   1236   1.28  augustss 	 * The subroutine is rather long. It steps through the states given in
   1237   1.28  augustss 	 * Annex A of the Bulk-Only specification.
   1238   1.28  augustss 	 * Each state first does the error handling of the previous transfer
   1239   1.28  augustss 	 * and then prepares the next transfer.
   1240   1.28  augustss 	 * Each transfer is done asynchroneously so after the request/transfer
   1241   1.28  augustss 	 * has been submitted you will find a 'return;'.
   1242    1.1   thorpej 	 */
   1243    1.1   thorpej 
   1244  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx, transfer_state %jd dir %jd",
   1245  1.160  pgoyette 	    (uintptr_t)sc, (uintptr_t)xfer, sc->transfer_state,
   1246  1.160  pgoyette 	    sc->transfer_dir);
   1247  1.149     skrll 
   1248  1.166   mlelstv 	if (err == USBD_CANCELLED) {
   1249  1.166   mlelstv 		DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx cancelled",
   1250  1.166   mlelstv 		    (uintptr_t)sc, (uintptr_t)xfer, 0, 0);
   1251  1.166   mlelstv 
   1252  1.178  riastrad 		umass_transfer_done(sc, 0, STATUS_TIMEOUT);
   1253  1.166   mlelstv 		return;
   1254  1.166   mlelstv 	}
   1255  1.166   mlelstv 
   1256  1.179  riastrad 	if (sc->sc_dying) {
   1257  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen,
   1258  1.179  riastrad 		    STATUS_WIRE_FAILED);
   1259  1.166   mlelstv 		return;
   1260  1.179  riastrad 	}
   1261  1.166   mlelstv 
   1262   1.28  augustss 	switch (sc->transfer_state) {
   1263   1.28  augustss 
   1264   1.28  augustss 	/***** Bulk Transfer *****/
   1265   1.28  augustss 	case TSTATE_BBB_COMMAND:
   1266   1.28  augustss 		/* Command transport phase, error handling */
   1267   1.28  augustss 		if (err) {
   1268  1.160  pgoyette 			DPRINTFM(UDMASS_BBB, "sc %#jx failed to send CBW",
   1269  1.160  pgoyette 			    (uintptr_t)sc, 0, 0, 0);
   1270   1.28  augustss 			/* If the device detects that the CBW is invalid, then
   1271   1.28  augustss 			 * the device may STALL both bulk endpoints and require
   1272   1.28  augustss 			 * a Bulk-Reset
   1273   1.28  augustss 			 */
   1274   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1275   1.28  augustss 			return;
   1276   1.28  augustss 		}
   1277   1.28  augustss 
   1278   1.28  augustss 		/* Data transport phase, setup transfer */
   1279   1.28  augustss 		sc->transfer_state = TSTATE_BBB_DATA;
   1280   1.28  augustss 		if (sc->transfer_dir == DIR_IN) {
   1281   1.73   gehenna 			if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
   1282  1.151     skrll 					sc->datain_buffer, sc->transfer_datalen,
   1283  1.151     skrll 					USBD_SHORT_XFER_OK,
   1284  1.151     skrll 					sc->transfer_xfer[XFER_BBB_DATAIN]))
   1285   1.28  augustss 				umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1286   1.28  augustss 
   1287   1.28  augustss 			return;
   1288   1.28  augustss 		} else if (sc->transfer_dir == DIR_OUT) {
   1289  1.151     skrll 			memcpy(sc->dataout_buffer, sc->transfer_data,
   1290   1.28  augustss 			       sc->transfer_datalen);
   1291  1.156   msaitoh 			if (umass_setup_transfer(sc,
   1292  1.156   msaitoh 			    sc->sc_pipe[UMASS_BULKOUT], sc->dataout_buffer,
   1293  1.156   msaitoh 			    sc->transfer_datalen, 0,/* fixed length transfer */
   1294  1.156   msaitoh 			    sc->transfer_xfer[XFER_BBB_DATAOUT]))
   1295   1.28  augustss 				umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1296    1.1   thorpej 
   1297   1.28  augustss 			return;
   1298   1.28  augustss 		} else {
   1299  1.160  pgoyette 			DPRINTFM(UDMASS_BBB, "sc %#jx: no data phase",
   1300  1.160  pgoyette 			    (uintptr_t)sc, 0, 0, 0);
   1301   1.28  augustss 		}
   1302    1.1   thorpej 
   1303  1.168       mrg 		/* if no data phase, err == 0 */
   1304  1.168       mrg 		/* FALLTHROUGH */
   1305   1.28  augustss 	case TSTATE_BBB_DATA:
   1306  1.103   mycroft 		/* Command transport phase error handling (ignored if no data
   1307   1.28  augustss 		 * phase (fallthrough from previous state)) */
   1308   1.28  augustss 		if (sc->transfer_dir != DIR_NONE) {
   1309   1.28  augustss 			/* retrieve the length of the transfer that was done */
   1310   1.28  augustss 			usbd_get_xfer_status(xfer, NULL, NULL,
   1311  1.103   mycroft 			     &sc->transfer_actlen, NULL);
   1312  1.160  pgoyette 			DPRINTFM(UDMASS_BBB, "sc %#jx: BBB_DATA actlen=%jd",
   1313  1.160  pgoyette 			    (uintptr_t)sc, sc->transfer_actlen, 0, 0);
   1314   1.28  augustss 
   1315   1.28  augustss 			if (err) {
   1316  1.160  pgoyette 				DPRINTFM(UDMASS_BBB, "sc %#jx Data dir %jd "
   1317  1.160  pgoyette 				    "err %jd failed, err %jd",
   1318  1.160  pgoyette 				    (uintptr_t)sc, sc->transfer_dir,
   1319  1.153     skrll 				    sc->transfer_datalen, err);
   1320   1.28  augustss 
   1321   1.28  augustss 				if (err == USBD_STALLED) {
   1322   1.70   gehenna 					sc->transfer_state = TSTATE_BBB_DCLEAR;
   1323   1.28  augustss 					umass_clear_endpoint_stall(sc,
   1324   1.28  augustss 					  (sc->transfer_dir == DIR_IN?
   1325   1.73   gehenna 					    UMASS_BULKIN:UMASS_BULKOUT),
   1326   1.28  augustss 					  sc->transfer_xfer[XFER_BBB_DCLEAR]);
   1327   1.28  augustss 				} else {
   1328   1.28  augustss 					/* Unless the error is a pipe stall the
   1329   1.28  augustss 					 * error is fatal.
   1330   1.28  augustss 					 */
   1331   1.28  augustss 					umass_bbb_reset(sc,STATUS_WIRE_FAILED);
   1332   1.28  augustss 				}
   1333  1.103   mycroft 				return;
   1334   1.28  augustss 			}
   1335   1.28  augustss 		}
   1336    1.1   thorpej 
   1337  1.168       mrg 		/* err == 0 (no data phase or successful) */
   1338  1.168       mrg 		/* FALLTHROUGH */
   1339  1.101   mycroft 	case TSTATE_BBB_DCLEAR: /* stall clear after data phase */
   1340   1.28  augustss 		if (sc->transfer_dir == DIR_IN)
   1341  1.151     skrll 			memcpy(sc->transfer_data, sc->datain_buffer,
   1342   1.28  augustss 			       sc->transfer_actlen);
   1343   1.28  augustss 
   1344   1.28  augustss 		DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN)
   1345   1.28  augustss 					umass_dump_buffer(sc, sc->transfer_data,
   1346   1.28  augustss 						sc->transfer_datalen, 48));
   1347   1.28  augustss 
   1348  1.168       mrg 		/* err == 0 (no data phase or successful) */
   1349  1.168       mrg 		/* FALLTHROUGH */
   1350   1.28  augustss 	case TSTATE_BBB_SCLEAR: /* stall clear after status phase */
   1351   1.28  augustss 		/* Reading of CSW after bulk stall condition in data phase
   1352   1.28  augustss 		 * (TSTATE_BBB_DATA2) or bulk-in stall condition after
   1353   1.28  augustss 		 * reading CSW (TSTATE_BBB_SCLEAR).
   1354   1.94       wiz 		 * In the case of no data phase or successful data phase,
   1355   1.28  augustss 		 * err == 0 and the following if block is passed.
   1356   1.28  augustss 		 */
   1357   1.28  augustss 		if (err) {	/* should not occur */
   1358  1.103   mycroft 			printf("%s: BBB bulk-%s stall clear failed, %s\n",
   1359  1.131    dyoung 			    device_xname(sc->sc_dev),
   1360  1.103   mycroft 			    (sc->transfer_dir == DIR_IN? "in":"out"),
   1361  1.103   mycroft 			    usbd_errstr(err));
   1362   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1363   1.28  augustss 			return;
   1364   1.28  augustss 		}
   1365   1.88  augustss 
   1366   1.28  augustss 		/* Status transport phase, setup transfer */
   1367   1.28  augustss 		if (sc->transfer_state == TSTATE_BBB_COMMAND ||
   1368   1.28  augustss 		    sc->transfer_state == TSTATE_BBB_DATA ||
   1369   1.28  augustss 		    sc->transfer_state == TSTATE_BBB_DCLEAR) {
   1370   1.94       wiz 			/* After no data phase, successful data phase and
   1371   1.28  augustss 			 * after clearing bulk-in/-out stall condition
   1372   1.28  augustss 			 */
   1373   1.28  augustss 			sc->transfer_state = TSTATE_BBB_STATUS1;
   1374   1.28  augustss 			next_xfer = sc->transfer_xfer[XFER_BBB_CSW1];
   1375   1.28  augustss 		} else {
   1376   1.28  augustss 			/* After first attempt of fetching CSW */
   1377   1.28  augustss 			sc->transfer_state = TSTATE_BBB_STATUS2;
   1378   1.28  augustss 			next_xfer = sc->transfer_xfer[XFER_BBB_CSW2];
   1379    1.1   thorpej 		}
   1380    1.1   thorpej 
   1381   1.28  augustss 		/* Read the Command Status Wrapper via bulk-in endpoint. */
   1382   1.73   gehenna 		if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
   1383   1.73   gehenna 			&sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) {
   1384   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1385   1.28  augustss 			return;
   1386   1.28  augustss 		}
   1387    1.1   thorpej 
   1388   1.28  augustss 		return;
   1389   1.28  augustss 	case TSTATE_BBB_STATUS1:	/* first attempt */
   1390   1.28  augustss 	case TSTATE_BBB_STATUS2:	/* second attempt */
   1391   1.28  augustss 		/* Status transfer, error handling */
   1392    1.1   thorpej 		if (err) {
   1393  1.160  pgoyette 			DPRINTFM(UDMASS_BBB, "sc %#jx Failed to read CSW "
   1394  1.160  pgoyette 			    "err %jd (state %jd)", (uintptr_t)sc, err,
   1395  1.160  pgoyette 			    sc->transfer_state, 0);
   1396   1.28  augustss 
   1397   1.28  augustss 			/* If this was the first attempt at fetching the CSW
   1398   1.28  augustss 			 * retry it, otherwise fail.
   1399   1.28  augustss 			 */
   1400   1.28  augustss 			if (sc->transfer_state == TSTATE_BBB_STATUS1) {
   1401   1.70   gehenna 				sc->transfer_state = TSTATE_BBB_SCLEAR;
   1402   1.73   gehenna 				umass_clear_endpoint_stall(sc, UMASS_BULKIN,
   1403   1.66  augustss 				    sc->transfer_xfer[XFER_BBB_SCLEAR]);
   1404   1.28  augustss 				return;
   1405   1.28  augustss 			} else {
   1406   1.28  augustss 				umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1407   1.28  augustss 				return;
   1408   1.28  augustss 			}
   1409   1.28  augustss 		}
   1410   1.28  augustss 
   1411   1.28  augustss 		DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw));
   1412   1.68  augustss 
   1413  1.146  drochner #ifdef UMASS_DEBUG
   1414  1.146  drochner 		residue = UGETDW(sc->csw.dCSWDataResidue);
   1415  1.146  drochner 		if (residue != sc->transfer_datalen - sc->transfer_actlen)
   1416  1.146  drochner 			printf("%s: dCSWDataResidue=%d req=%d act=%d\n",
   1417  1.146  drochner 			       device_xname(sc->sc_dev), residue,
   1418  1.146  drochner 			       sc->transfer_datalen, sc->transfer_actlen);
   1419  1.146  drochner #endif
   1420  1.146  drochner 		residue = sc->transfer_datalen - sc->transfer_actlen;
   1421  1.135        is 
   1422   1.68  augustss 		/* Translate weird command-status signatures. */
   1423   1.78   gehenna 		if ((sc->sc_quirks & UMASS_QUIRK_WRONG_CSWSIG) &&
   1424   1.68  augustss 		    UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1)
   1425   1.68  augustss 			USETDW(sc->csw.dCSWSignature, CSWSIGNATURE);
   1426   1.91       erh 
   1427   1.91       erh 		/* Translate invalid command-status tags */
   1428   1.91       erh 		if (sc->sc_quirks & UMASS_QUIRK_WRONG_CSWTAG)
   1429   1.91       erh 			USETDW(sc->csw.dCSWTag, UGETDW(sc->cbw.dCBWTag));
   1430   1.28  augustss 
   1431   1.28  augustss 		/* Check CSW and handle any error */
   1432   1.28  augustss 		if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) {
   1433   1.28  augustss 			/* Invalid CSW: Wrong signature or wrong tag might
   1434   1.28  augustss 			 * indicate that the device is confused -> reset it.
   1435   1.28  augustss 			 */
   1436   1.28  augustss 			printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n",
   1437  1.131    dyoung 				device_xname(sc->sc_dev),
   1438   1.28  augustss 				UGETDW(sc->csw.dCSWSignature),
   1439   1.28  augustss 				CSWSIGNATURE);
   1440   1.28  augustss 
   1441   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1442   1.28  augustss 			return;
   1443   1.28  augustss 		} else if (UGETDW(sc->csw.dCSWTag)
   1444   1.28  augustss 				!= UGETDW(sc->cbw.dCBWTag)) {
   1445   1.28  augustss 			printf("%s: Invalid CSW: tag %d should be %d\n",
   1446  1.131    dyoung 				device_xname(sc->sc_dev),
   1447   1.28  augustss 				UGETDW(sc->csw.dCSWTag),
   1448   1.28  augustss 				UGETDW(sc->cbw.dCBWTag));
   1449   1.28  augustss 
   1450   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1451   1.28  augustss 			return;
   1452   1.28  augustss 
   1453   1.28  augustss 		/* CSW is valid here */
   1454   1.28  augustss 		} else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) {
   1455   1.28  augustss 			printf("%s: Invalid CSW: status %d > %d\n",
   1456  1.131    dyoung 				device_xname(sc->sc_dev),
   1457   1.28  augustss 				sc->csw.bCSWStatus,
   1458   1.28  augustss 				CSWSTATUS_PHASE);
   1459   1.28  augustss 
   1460   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1461   1.28  augustss 			return;
   1462   1.28  augustss 		} else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) {
   1463   1.28  augustss 			printf("%s: Phase Error, residue = %d\n",
   1464  1.135        is 				device_xname(sc->sc_dev), residue);
   1465   1.88  augustss 
   1466   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1467   1.28  augustss 			return;
   1468   1.28  augustss 
   1469   1.28  augustss 		} else if (sc->transfer_actlen > sc->transfer_datalen) {
   1470   1.28  augustss 			/* Buffer overrun! Don't let this go by unnoticed */
   1471  1.147     skrll 			panic("%s: transferred %s %d bytes instead of %d bytes",
   1472  1.147     skrll 			    device_xname(sc->sc_dev),
   1473  1.147     skrll 			    sc->transfer_dir == DIR_IN ? "IN" : "OUT",
   1474  1.147     skrll 			    sc->transfer_actlen, sc->transfer_datalen);
   1475   1.62  augustss #if 0
   1476   1.28  augustss 		} else if (sc->transfer_datalen - sc->transfer_actlen
   1477  1.135        is 			   != residue) {
   1478  1.160  pgoyette 			DPRINTFM(UDMASS_BBB, "sc %#jx: actlen=%jd != "
   1479  1.160  pgoyette 			    "residue=%jd\n", (uintptr_t)sc,
   1480  1.160  pgoyette 			    sc->transfer_datalen - sc->transfer_actlen,
   1481  1.160  pgoyette 			    residue, 0);
   1482   1.28  augustss 
   1483   1.28  augustss 			umass_bbb_reset(sc, STATUS_WIRE_FAILED);
   1484   1.28  augustss 			return;
   1485   1.62  augustss #endif
   1486   1.28  augustss 		} else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) {
   1487  1.160  pgoyette 			DPRINTFM(UDMASS_BBB, "sc %#jx: Command Failed, "
   1488  1.160  pgoyette 			    "res = %jd", (uintptr_t)sc, residue, 0, 0);
   1489   1.28  augustss 
   1490   1.28  augustss 			/* SCSI command failed but transfer was succesful */
   1491  1.178  riastrad 			umass_transfer_done(sc, residue, STATUS_CMD_FAILED);
   1492   1.28  augustss 			return;
   1493   1.28  augustss 
   1494   1.28  augustss 		} else {	/* success */
   1495  1.178  riastrad 			umass_transfer_done(sc, residue, STATUS_CMD_OK);
   1496   1.28  augustss 			return;
   1497    1.1   thorpej 		}
   1498    1.1   thorpej 
   1499   1.28  augustss 	/***** Bulk Reset *****/
   1500   1.28  augustss 	case TSTATE_BBB_RESET1:
   1501   1.28  augustss 		if (err)
   1502   1.28  augustss 			printf("%s: BBB reset failed, %s\n",
   1503  1.131    dyoung 				device_xname(sc->sc_dev), usbd_errstr(err));
   1504   1.28  augustss 
   1505   1.70   gehenna 		sc->transfer_state = TSTATE_BBB_RESET2;
   1506   1.73   gehenna 		umass_clear_endpoint_stall(sc, UMASS_BULKIN,
   1507   1.28  augustss 			sc->transfer_xfer[XFER_BBB_RESET2]);
   1508   1.28  augustss 
   1509   1.28  augustss 		return;
   1510   1.28  augustss 	case TSTATE_BBB_RESET2:
   1511   1.28  augustss 		if (err)	/* should not occur */
   1512   1.28  augustss 			printf("%s: BBB bulk-in clear stall failed, %s\n",
   1513  1.131    dyoung 			       device_xname(sc->sc_dev), usbd_errstr(err));
   1514   1.28  augustss 			/* no error recovery, otherwise we end up in a loop */
   1515   1.28  augustss 
   1516   1.70   gehenna 		sc->transfer_state = TSTATE_BBB_RESET3;
   1517   1.73   gehenna 		umass_clear_endpoint_stall(sc, UMASS_BULKOUT,
   1518   1.28  augustss 			sc->transfer_xfer[XFER_BBB_RESET3]);
   1519   1.28  augustss 
   1520   1.28  augustss 		return;
   1521   1.28  augustss 	case TSTATE_BBB_RESET3:
   1522   1.28  augustss 		if (err)	/* should not occur */
   1523   1.28  augustss 			printf("%s: BBB bulk-out clear stall failed, %s\n",
   1524  1.131    dyoung 			       device_xname(sc->sc_dev), usbd_errstr(err));
   1525   1.28  augustss 			/* no error recovery, otherwise we end up in a loop */
   1526   1.28  augustss 
   1527  1.178  riastrad 		umass_transfer_reset(sc);
   1528    1.1   thorpej 
   1529   1.28  augustss 		return;
   1530    1.1   thorpej 
   1531   1.28  augustss 	/***** Default *****/
   1532   1.28  augustss 	default:
   1533   1.89    provos 		panic("%s: Unknown state %d",
   1534  1.131    dyoung 		      device_xname(sc->sc_dev), sc->transfer_state);
   1535   1.28  augustss 	}
   1536    1.1   thorpej }
   1537    1.1   thorpej 
   1538    1.1   thorpej /*
   1539   1.28  augustss  * Command/Bulk/Interrupt (CBI) specific functions
   1540    1.1   thorpej  */
   1541    1.1   thorpej 
   1542   1.28  augustss Static int
   1543  1.143       mrg umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, int flags,
   1544  1.151     skrll 	       struct usbd_xfer *xfer)
   1545    1.1   thorpej {
   1546  1.142       mrg 	KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
   1547  1.142       mrg 		   "sc->sc_wire == 0x%02x wrong for umass_cbi_adsc\n",
   1548  1.142       mrg 		   sc->sc_wire);
   1549   1.78   gehenna 
   1550  1.123  christos 	if ((sc->sc_cmd == UMASS_CPROTO_RBC) &&
   1551  1.123  christos 	    (sc->sc_quirks & UMASS_QUIRK_RBC_PAD_TO_12) != 0 && buflen < 12) {
   1552  1.123  christos 		(void)memset(buffer + buflen, 0, 12 - buflen);
   1553  1.123  christos 		buflen = 12;
   1554  1.123  christos 	}
   1555  1.123  christos 
   1556   1.78   gehenna 	sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
   1557   1.78   gehenna 	sc->sc_req.bRequest = UR_CBI_ADSC;
   1558   1.78   gehenna 	USETW(sc->sc_req.wValue, 0);
   1559   1.78   gehenna 	USETW(sc->sc_req.wIndex, sc->sc_ifaceno);
   1560   1.78   gehenna 	USETW(sc->sc_req.wLength, buflen);
   1561   1.78   gehenna 	return umass_setup_ctrl_transfer(sc, &sc->sc_req, buffer,
   1562  1.143       mrg 					 buflen, flags, xfer);
   1563   1.28  augustss }
   1564   1.28  augustss 
   1565    1.1   thorpej 
   1566   1.28  augustss Static void
   1567   1.28  augustss umass_cbi_reset(struct umass_softc *sc, int status)
   1568   1.28  augustss {
   1569  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1570   1.28  augustss 	int i;
   1571   1.28  augustss #	define SEND_DIAGNOSTIC_CMDLEN	12
   1572    1.1   thorpej 
   1573  1.142       mrg 	KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
   1574  1.142       mrg 		   "sc->sc_wire == 0x%02x wrong for umass_cbi_reset\n",
   1575  1.142       mrg 		   sc->sc_wire);
   1576   1.15   thorpej 
   1577  1.179  riastrad 	if (sc->sc_dying) {
   1578  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen, status);
   1579   1.28  augustss 		return;
   1580  1.179  riastrad 	}
   1581   1.28  augustss 
   1582   1.28  augustss 	/*
   1583   1.28  augustss 	 * Command Block Reset Protocol
   1584   1.88  augustss 	 *
   1585   1.28  augustss 	 * First send a reset request to the device. Then clear
   1586   1.28  augustss 	 * any possibly stalled bulk endpoints.
   1587   1.28  augustss 
   1588   1.28  augustss 	 * This is done in 3 steps, states:
   1589   1.28  augustss 	 * TSTATE_CBI_RESET1
   1590   1.28  augustss 	 * TSTATE_CBI_RESET2
   1591   1.28  augustss 	 * TSTATE_CBI_RESET3
   1592   1.28  augustss 	 *
   1593   1.28  augustss 	 * If the reset doesn't succeed, the device should be port reset.
   1594   1.28  augustss 	 */
   1595   1.28  augustss 
   1596  1.160  pgoyette 	DPRINTFM(UDMASS_CBI, "sc %#jx: CBI Reset", (uintptr_t)sc, 0, 0, 0);
   1597   1.88  augustss 
   1598  1.142       mrg 	/* CTASSERT */
   1599  1.142       mrg 	KASSERTMSG(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN,
   1600  1.142       mrg 		   "%s: CBL struct is too small (%zu < %u)\n",
   1601  1.131    dyoung 			device_xname(sc->sc_dev),
   1602  1.142       mrg 			sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN);
   1603   1.28  augustss 
   1604   1.28  augustss 	sc->transfer_state = TSTATE_CBI_RESET1;
   1605   1.28  augustss 	sc->transfer_status = status;
   1606   1.28  augustss 
   1607   1.28  augustss 	/* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between
   1608   1.28  augustss 	 * the two the last 10 bytes of the cbl is filled with 0xff (section
   1609   1.28  augustss 	 * 2.2 of the CBI spec).
   1610   1.28  augustss 	 */
   1611   1.28  augustss 	sc->cbl[0] = 0x1d;	/* Command Block Reset */
   1612   1.28  augustss 	sc->cbl[1] = 0x04;
   1613   1.28  augustss 	for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++)
   1614   1.28  augustss 		sc->cbl[i] = 0xff;
   1615   1.28  augustss 
   1616  1.179  riastrad 	if (umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, 0,
   1617  1.179  riastrad 		sc->transfer_xfer[XFER_CBI_RESET1]))
   1618  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen, status);
   1619   1.28  augustss 	/* XXX if the command fails we should reset the port on the bub */
   1620   1.28  augustss }
   1621   1.28  augustss 
   1622   1.28  augustss Static void
   1623  1.122  christos umass_cbi_transfer(struct umass_softc *sc, int lun,
   1624   1.67  augustss 		   void *cmd, int cmdlen, void *data, int datalen, int dir,
   1625  1.143       mrg 		   u_int timeout, int flags, umass_callback cb, void *priv)
   1626   1.28  augustss {
   1627  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1628  1.153     skrll 
   1629  1.160  pgoyette 	DPRINTFM(UDMASS_CBI, "sc %#jx: cmd=0x%02jx, len=%jd",
   1630  1.160  pgoyette 	     (uintptr_t)sc, *(u_char *)cmd, datalen, 0);
   1631   1.28  augustss 
   1632  1.142       mrg 	KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
   1633  1.142       mrg 		   "sc->sc_wire == 0x%02x wrong for umass_cbi_transfer\n",
   1634  1.142       mrg 		   sc->sc_wire);
   1635   1.28  augustss 
   1636  1.179  riastrad 	if (sc->sc_dying) {
   1637  1.179  riastrad 		cb(sc, priv, datalen, STATUS_WIRE_FAILED);
   1638   1.28  augustss 		return;
   1639  1.179  riastrad 	}
   1640   1.67  augustss 
   1641   1.67  augustss 	/* Be a little generous. */
   1642   1.67  augustss 	sc->timeout = timeout + USBD_DEFAULT_TIMEOUT;
   1643   1.28  augustss 
   1644   1.28  augustss 	/*
   1645   1.28  augustss 	 * Do a CBI transfer with cmdlen bytes from cmd, possibly
   1646   1.28  augustss 	 * a data phase of datalen bytes from/to the device and finally a
   1647   1.28  augustss 	 * csw read phase.
   1648   1.28  augustss 	 * If the data direction was inbound a maximum of datalen bytes
   1649   1.28  augustss 	 * is stored in the buffer pointed to by data.
   1650   1.28  augustss 	 *
   1651   1.28  augustss 	 * umass_cbi_transfer initialises the transfer and lets the state
   1652   1.88  augustss 	 * machine in umass_cbi_state handle the completion. It uses the
   1653   1.28  augustss 	 * following states:
   1654   1.28  augustss 	 * TSTATE_CBI_COMMAND
   1655   1.28  augustss 	 *   -> XXX fill in
   1656   1.28  augustss 	 *
   1657   1.28  augustss 	 * An error in any of those states will invoke
   1658   1.28  augustss 	 * umass_cbi_reset.
   1659   1.28  augustss 	 */
   1660   1.28  augustss 
   1661   1.28  augustss 	/* check the given arguments */
   1662  1.142       mrg 	KASSERTMSG(datalen == 0 || data != NULL,
   1663  1.142       mrg 		   "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev));
   1664  1.142       mrg 	KASSERTMSG(datalen == 0 || dir != DIR_NONE,
   1665  1.142       mrg 		   "%s: direction is NONE while datalen is not zero\n",
   1666  1.142       mrg 			device_xname(sc->sc_dev));
   1667   1.28  augustss 
   1668   1.28  augustss 	/* store the details for the data transfer phase */
   1669   1.28  augustss 	sc->transfer_dir = dir;
   1670   1.28  augustss 	sc->transfer_data = data;
   1671   1.28  augustss 	sc->transfer_datalen = datalen;
   1672   1.28  augustss 	sc->transfer_actlen = 0;
   1673   1.28  augustss 	sc->transfer_cb = cb;
   1674   1.28  augustss 	sc->transfer_priv = priv;
   1675   1.28  augustss 	sc->transfer_status = STATUS_CMD_OK;
   1676   1.28  augustss 
   1677   1.28  augustss 	/* move from idle to the command state */
   1678   1.28  augustss 	sc->transfer_state = TSTATE_CBI_COMMAND;
   1679   1.28  augustss 
   1680   1.28  augustss 	/* Send the Command Block from host to device via control endpoint. */
   1681  1.156   msaitoh 	if (umass_cbi_adsc(sc, cmd, cmdlen, flags,
   1682  1.156   msaitoh 	    sc->transfer_xfer[XFER_CBI_CB]))
   1683   1.28  augustss 		umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1684   1.28  augustss }
   1685   1.28  augustss 
   1686   1.28  augustss Static void
   1687  1.151     skrll umass_cbi_state(struct usbd_xfer *xfer, void *priv,
   1688   1.28  augustss 		usbd_status err)
   1689   1.28  augustss {
   1690  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1691   1.28  augustss 	struct umass_softc *sc = (struct umass_softc *) priv;
   1692   1.28  augustss 
   1693  1.142       mrg 	KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
   1694  1.142       mrg 		   "sc->sc_wire == 0x%02x wrong for umass_cbi_state\n",
   1695  1.142       mrg 		   sc->sc_wire);
   1696   1.28  augustss 
   1697  1.166   mlelstv 	if (err == USBD_CANCELLED) {
   1698  1.166   mlelstv 		DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx cancelled",
   1699  1.166   mlelstv 			(uintptr_t)sc, (uintptr_t)xfer, 0, 0);
   1700  1.178  riastrad 		umass_transfer_done(sc, 0, STATUS_TIMEOUT);
   1701  1.166   mlelstv 		return;
   1702  1.166   mlelstv 	}
   1703  1.166   mlelstv 
   1704  1.179  riastrad 	if (sc->sc_dying) {
   1705  1.179  riastrad 		umass_transfer_done(sc, sc->transfer_datalen,
   1706  1.179  riastrad 		    STATUS_WIRE_FAILED);
   1707   1.28  augustss 		return;
   1708  1.179  riastrad 	}
   1709   1.28  augustss 
   1710   1.28  augustss 	/*
   1711   1.28  augustss 	 * State handling for CBI transfers.
   1712   1.28  augustss 	 */
   1713   1.28  augustss 
   1714  1.160  pgoyette 	DPRINTFM(UDMASS_CBI, "sc %#jx: Handling CBI state %jd, xfer=%#jx, ...",
   1715  1.160  pgoyette 	    (uintptr_t)sc, sc->transfer_state, (uintptr_t)xfer, 0);
   1716  1.160  pgoyette 	DPRINTFM(UDMASS_CBI, "... err %jd", err, 0, 0, 0);
   1717   1.28  augustss 
   1718   1.28  augustss 	switch (sc->transfer_state) {
   1719   1.28  augustss 
   1720   1.28  augustss 	/***** CBI Transfer *****/
   1721   1.28  augustss 	case TSTATE_CBI_COMMAND:
   1722   1.28  augustss 		if (err == USBD_STALLED) {
   1723  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: Command Transport "
   1724  1.160  pgoyette 			    "failed", (uintptr_t)sc, 0, 0, 0);
   1725   1.28  augustss 			/* Status transport by control pipe (section 2.3.2.1).
   1726   1.28  augustss 			 * The command contained in the command block failed.
   1727   1.28  augustss 			 *
   1728   1.28  augustss 			 * The control pipe has already been unstalled by the
   1729   1.28  augustss 			 * USB stack.
   1730   1.28  augustss 			 * Section 2.4.3.1.1 states that the bulk in endpoints
   1731   1.28  augustss 			 * should not stalled at this point.
   1732   1.28  augustss 			 */
   1733  1.178  riastrad 			umass_transfer_done(sc, sc->transfer_datalen,
   1734  1.178  riastrad 			    STATUS_CMD_FAILED);
   1735   1.28  augustss 			return;
   1736   1.28  augustss 		} else if (err) {
   1737  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: failed to send ADSC",
   1738  1.160  pgoyette 			    (uintptr_t)sc, 0, 0, 0);
   1739   1.28  augustss 			umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1740   1.28  augustss 			return;
   1741   1.28  augustss 		}
   1742   1.88  augustss 
   1743  1.103   mycroft 		/* Data transport phase, setup transfer */
   1744   1.28  augustss 		sc->transfer_state = TSTATE_CBI_DATA;
   1745   1.28  augustss 		if (sc->transfer_dir == DIR_IN) {
   1746   1.73   gehenna 			if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
   1747  1.151     skrll 			    sc->datain_buffer, sc->transfer_datalen,
   1748  1.151     skrll 			    USBD_SHORT_XFER_OK,
   1749  1.151     skrll 			    sc->transfer_xfer[XFER_CBI_DATAIN]))
   1750   1.28  augustss 				umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1751   1.28  augustss 
   1752  1.103   mycroft 			return;
   1753   1.28  augustss 		} else if (sc->transfer_dir == DIR_OUT) {
   1754  1.151     skrll 			memcpy(sc->dataout_buffer, sc->transfer_data,
   1755   1.28  augustss 			       sc->transfer_datalen);
   1756   1.73   gehenna 			if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT],
   1757  1.151     skrll 			    sc->dataout_buffer, sc->transfer_datalen,
   1758  1.151     skrll 			    0, /* fixed length transfer */
   1759  1.151     skrll 			    sc->transfer_xfer[XFER_CBI_DATAOUT]))
   1760   1.28  augustss 				umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1761   1.28  augustss 
   1762  1.103   mycroft 			return;
   1763   1.28  augustss 		} else {
   1764  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: no data phase",
   1765  1.160  pgoyette 			    (uintptr_t)sc, 0, 0, 0);
   1766   1.28  augustss 		}
   1767   1.28  augustss 
   1768  1.168       mrg 		/* if no data phase, err == 0 */
   1769  1.168       mrg 		/* FALLTHROUGH */
   1770   1.28  augustss 	case TSTATE_CBI_DATA:
   1771  1.103   mycroft 		/* Command transport phase error handling (ignored if no data
   1772  1.103   mycroft 		 * phase (fallthrough from previous state)) */
   1773  1.103   mycroft 		if (sc->transfer_dir != DIR_NONE) {
   1774  1.103   mycroft 			/* retrieve the length of the transfer that was done */
   1775  1.103   mycroft 			usbd_get_xfer_status(xfer, NULL, NULL,
   1776  1.103   mycroft 			    &sc->transfer_actlen, NULL);
   1777  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: CBI_DATA actlen=%jd",
   1778  1.160  pgoyette 				(uintptr_t)sc, sc->transfer_actlen, 0, 0);
   1779   1.28  augustss 
   1780  1.103   mycroft 			if (err) {
   1781  1.160  pgoyette 				DPRINTFM(UDMASS_CBI, "sc %#jx: Data dir %jd "
   1782  1.160  pgoyette 				    "err %d failed",
   1783  1.160  pgoyette 				    (uintptr_t)sc, sc->transfer_dir,
   1784  1.153     skrll 				    sc->transfer_datalen, err);
   1785   1.28  augustss 
   1786  1.103   mycroft 				if (err == USBD_STALLED) {
   1787  1.103   mycroft 					sc->transfer_state = TSTATE_CBI_DCLEAR;
   1788  1.103   mycroft 					umass_clear_endpoint_stall(sc,
   1789  1.103   mycroft 					  (sc->transfer_dir == DIR_IN?
   1790  1.103   mycroft 					    UMASS_BULKIN:UMASS_BULKOUT),
   1791   1.28  augustss 					sc->transfer_xfer[XFER_CBI_DCLEAR]);
   1792  1.103   mycroft 				} else {
   1793  1.103   mycroft 					/* Unless the error is a pipe stall the
   1794  1.103   mycroft 					 * error is fatal.
   1795  1.103   mycroft 					 */
   1796  1.103   mycroft 					umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1797  1.103   mycroft 				}
   1798  1.103   mycroft 				return;
   1799   1.28  augustss 			}
   1800   1.28  augustss 		}
   1801   1.28  augustss 
   1802   1.28  augustss 		if (sc->transfer_dir == DIR_IN)
   1803  1.151     skrll 			memcpy(sc->transfer_data, sc->datain_buffer,
   1804   1.28  augustss 			       sc->transfer_actlen);
   1805   1.28  augustss 
   1806   1.28  augustss 		DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN)
   1807   1.28  augustss 					umass_dump_buffer(sc, sc->transfer_data,
   1808   1.28  augustss 						sc->transfer_actlen, 48));
   1809   1.28  augustss 
   1810  1.103   mycroft 		/* Status phase */
   1811   1.78   gehenna 		if (sc->sc_wire == UMASS_WPROTO_CBI_I) {
   1812   1.28  augustss 			sc->transfer_state = TSTATE_CBI_STATUS;
   1813   1.28  augustss 			memset(&sc->sbl, 0, sizeof(sc->sbl));
   1814   1.73   gehenna 			if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_INTRIN],
   1815   1.28  augustss 				    &sc->sbl, sizeof(sc->sbl),
   1816   1.28  augustss 				    0,	/* fixed length transfer */
   1817  1.100   mycroft 				    sc->transfer_xfer[XFER_CBI_STATUS]))
   1818   1.28  augustss 				umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1819   1.28  augustss 		} else {
   1820   1.28  augustss 			/* No command completion interrupt. Request
   1821   1.28  augustss 			 * sense to get status of command.
   1822   1.28  augustss 			 */
   1823  1.178  riastrad 			umass_transfer_done(sc,
   1824  1.178  riastrad 			    sc->transfer_datalen - sc->transfer_actlen,
   1825  1.178  riastrad 			    STATUS_CMD_UNKNOWN);
   1826   1.28  augustss 		}
   1827   1.28  augustss 		return;
   1828   1.28  augustss 
   1829   1.28  augustss 	case TSTATE_CBI_STATUS:
   1830   1.28  augustss 		if (err) {
   1831  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: Status Transport failed",
   1832  1.160  pgoyette 			    (uintptr_t)sc, 0, 0, 0);
   1833   1.28  augustss 			/* Status transport by interrupt pipe (section 2.3.2.2).
   1834   1.28  augustss 			 */
   1835   1.28  augustss 
   1836   1.28  augustss 			if (err == USBD_STALLED) {
   1837   1.70   gehenna 				sc->transfer_state = TSTATE_CBI_SCLEAR;
   1838   1.73   gehenna 				umass_clear_endpoint_stall(sc, UMASS_INTRIN,
   1839   1.28  augustss 					sc->transfer_xfer[XFER_CBI_SCLEAR]);
   1840   1.28  augustss 			} else {
   1841   1.28  augustss 				umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1842   1.28  augustss 			}
   1843   1.28  augustss 			return;
   1844   1.28  augustss 		}
   1845   1.28  augustss 
   1846   1.28  augustss 		/* Dissect the information in the buffer */
   1847   1.28  augustss 
   1848  1.100   mycroft 		{
   1849  1.151     skrll 			uint32_t actlen;
   1850  1.100   mycroft 			usbd_get_xfer_status(xfer,NULL,NULL,&actlen,NULL);
   1851  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: CBI_STATUS actlen=%jd",
   1852  1.160  pgoyette 			    (uintptr_t)sc, actlen, 0, 0);
   1853  1.100   mycroft 			if (actlen != 2)
   1854  1.100   mycroft 				break;
   1855  1.100   mycroft 		}
   1856  1.100   mycroft 
   1857   1.78   gehenna 		if (sc->sc_cmd == UMASS_CPROTO_UFI) {
   1858   1.28  augustss 			int status;
   1859   1.88  augustss 
   1860   1.28  augustss 			/* Section 3.4.3.1.3 specifies that the UFI command
   1861   1.28  augustss 			 * protocol returns an ASC and ASCQ in the interrupt
   1862   1.28  augustss 			 * data block.
   1863   1.28  augustss 			 */
   1864   1.28  augustss 
   1865  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: UFI CCI, ASC = 0x%02jx, "
   1866  1.160  pgoyette 			    "ASCQ = 0x%02jx", (uintptr_t)sc, sc->sbl.ufi.asc,
   1867  1.153     skrll 			    sc->sbl.ufi.ascq, 0);
   1868   1.28  augustss 
   1869  1.100   mycroft 			if ((sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) ||
   1870  1.100   mycroft 			    sc->sc_sense)
   1871   1.28  augustss 				status = STATUS_CMD_OK;
   1872   1.28  augustss 			else
   1873   1.28  augustss 				status = STATUS_CMD_FAILED;
   1874   1.28  augustss 
   1875  1.100   mycroft 			/* No autosense, command successful */
   1876  1.178  riastrad 			umass_transfer_done(sc,
   1877  1.178  riastrad 			    sc->transfer_datalen - sc->transfer_actlen,
   1878  1.178  riastrad 			    status);
   1879   1.28  augustss 		} else {
   1880  1.100   mycroft 			int status;
   1881  1.100   mycroft 
   1882   1.28  augustss 			/* Command Interrupt Data Block */
   1883  1.100   mycroft 
   1884  1.160  pgoyette 			DPRINTFM(UDMASS_CBI, "sc %#jx: type=0x%02jx, "
   1885  1.160  pgoyette 			    "value=0x%02jx", (uintptr_t)sc,
   1886  1.160  pgoyette 			    sc->sbl.common.type, sc->sbl.common.value, 0);
   1887   1.28  augustss 
   1888   1.28  augustss 			if (sc->sbl.common.type == IDB_TYPE_CCI) {
   1889  1.100   mycroft 				switch (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) {
   1890  1.100   mycroft 				case IDB_VALUE_PASS:
   1891  1.100   mycroft 					status = STATUS_CMD_OK;
   1892  1.100   mycroft 					break;
   1893  1.100   mycroft 				case IDB_VALUE_FAIL:
   1894  1.100   mycroft 				case IDB_VALUE_PERSISTENT:
   1895  1.100   mycroft 					status = STATUS_CMD_FAILED;
   1896  1.100   mycroft 					break;
   1897  1.100   mycroft 				case IDB_VALUE_PHASE:
   1898  1.107   mycroft 				default: /* XXX: gcc */
   1899  1.100   mycroft 					status = STATUS_WIRE_FAILED;
   1900  1.100   mycroft 					break;
   1901   1.28  augustss 				}
   1902   1.28  augustss 
   1903  1.178  riastrad 				umass_transfer_done(sc,
   1904  1.156   msaitoh 				    sc->transfer_datalen - sc->transfer_actlen,
   1905  1.156   msaitoh 				    status);
   1906  1.179  riastrad 			} else {
   1907  1.179  riastrad 				/* XXX What to do?  */
   1908  1.179  riastrad 				umass_transfer_done(sc, sc->transfer_datalen,
   1909  1.179  riastrad 				    STATUS_WIRE_FAILED);
   1910   1.28  augustss 			}
   1911   1.28  augustss 		}
   1912   1.28  augustss 		return;
   1913   1.28  augustss 
   1914   1.28  augustss 	case TSTATE_CBI_DCLEAR:
   1915  1.113   mycroft 		if (err) {	/* should not occur */
   1916  1.103   mycroft 			printf("%s: CBI bulk-%s stall clear failed, %s\n",
   1917  1.131    dyoung 			    device_xname(sc->sc_dev),
   1918  1.103   mycroft 			    (sc->transfer_dir == DIR_IN? "in":"out"),
   1919  1.103   mycroft 			    usbd_errstr(err));
   1920  1.113   mycroft 			umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1921  1.115   mycroft 		} else {
   1922  1.178  riastrad 			umass_transfer_done(sc,
   1923  1.115   mycroft 			    sc->transfer_datalen, STATUS_CMD_FAILED);
   1924  1.115   mycroft 		}
   1925   1.28  augustss 		return;
   1926   1.28  augustss 
   1927   1.28  augustss 	case TSTATE_CBI_SCLEAR:
   1928  1.113   mycroft 		if (err) {	/* should not occur */
   1929   1.28  augustss 			printf("%s: CBI intr-in stall clear failed, %s\n",
   1930  1.131    dyoung 			       device_xname(sc->sc_dev), usbd_errstr(err));
   1931  1.113   mycroft 			umass_cbi_reset(sc, STATUS_WIRE_FAILED);
   1932  1.115   mycroft 		} else {
   1933  1.178  riastrad 			umass_transfer_done(sc,
   1934  1.115   mycroft 			    sc->transfer_datalen, STATUS_CMD_FAILED);
   1935  1.115   mycroft 		}
   1936   1.28  augustss 		return;
   1937   1.28  augustss 
   1938   1.28  augustss 	/***** CBI Reset *****/
   1939   1.28  augustss 	case TSTATE_CBI_RESET1:
   1940   1.28  augustss 		if (err)
   1941   1.28  augustss 			printf("%s: CBI reset failed, %s\n",
   1942  1.131    dyoung 				device_xname(sc->sc_dev), usbd_errstr(err));
   1943   1.28  augustss 
   1944   1.70   gehenna 		sc->transfer_state = TSTATE_CBI_RESET2;
   1945   1.73   gehenna 		umass_clear_endpoint_stall(sc, UMASS_BULKIN,
   1946   1.28  augustss 			sc->transfer_xfer[XFER_CBI_RESET2]);
   1947   1.28  augustss 
   1948   1.28  augustss 		return;
   1949   1.28  augustss 	case TSTATE_CBI_RESET2:
   1950   1.28  augustss 		if (err)	/* should not occur */
   1951   1.28  augustss 			printf("%s: CBI bulk-in stall clear failed, %s\n",
   1952  1.131    dyoung 			       device_xname(sc->sc_dev), usbd_errstr(err));
   1953   1.28  augustss 			/* no error recovery, otherwise we end up in a loop */
   1954   1.28  augustss 
   1955   1.70   gehenna 		sc->transfer_state = TSTATE_CBI_RESET3;
   1956   1.73   gehenna 		umass_clear_endpoint_stall(sc, UMASS_BULKOUT,
   1957   1.28  augustss 			sc->transfer_xfer[XFER_CBI_RESET3]);
   1958   1.28  augustss 
   1959   1.28  augustss 		return;
   1960   1.28  augustss 	case TSTATE_CBI_RESET3:
   1961   1.28  augustss 		if (err)	/* should not occur */
   1962   1.28  augustss 			printf("%s: CBI bulk-out stall clear failed, %s\n",
   1963  1.131    dyoung 			       device_xname(sc->sc_dev), usbd_errstr(err));
   1964   1.28  augustss 			/* no error recovery, otherwise we end up in a loop */
   1965   1.28  augustss 
   1966  1.178  riastrad 		umass_transfer_reset(sc);
   1967   1.28  augustss 		return;
   1968   1.28  augustss 
   1969   1.28  augustss 
   1970   1.28  augustss 	/***** Default *****/
   1971   1.28  augustss 	default:
   1972   1.89    provos 		panic("%s: Unknown state %d",
   1973  1.131    dyoung 		      device_xname(sc->sc_dev), sc->transfer_state);
   1974   1.28  augustss 	}
   1975   1.28  augustss }
   1976   1.28  augustss 
   1977  1.176      maxv static usbd_status
   1978  1.151     skrll umass_bbb_get_max_lun(struct umass_softc *sc, uint8_t *maxlun)
   1979   1.28  augustss {
   1980  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   1981   1.28  augustss 	usb_device_request_t req;
   1982   1.28  augustss 	usbd_status err;
   1983   1.28  augustss 
   1984   1.28  augustss 	*maxlun = 0;		/* Default to 0. */
   1985   1.28  augustss 
   1986  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun", (uintptr_t)sc, 0, 0, 0);
   1987   1.28  augustss 
   1988   1.28  augustss 	/* The Get Max Lun command is a class-specific request. */
   1989   1.28  augustss 	req.bmRequestType = UT_READ_CLASS_INTERFACE;
   1990   1.28  augustss 	req.bRequest = UR_BBB_GET_MAX_LUN;
   1991   1.28  augustss 	USETW(req.wValue, 0);
   1992   1.76   gehenna 	USETW(req.wIndex, sc->sc_ifaceno);
   1993   1.28  augustss 	USETW(req.wLength, 1);
   1994   1.28  augustss 
   1995   1.97   mycroft 	err = usbd_do_request_flags(sc->sc_udev, &req, maxlun,
   1996   1.97   mycroft 	    USBD_SHORT_XFER_OK, 0, USBD_DEFAULT_TIMEOUT);
   1997   1.28  augustss 	switch (err) {
   1998   1.28  augustss 	case USBD_NORMAL_COMPLETION:
   1999  1.160  pgoyette 		DPRINTFM(UDMASS_BBB, "sc %#jx: Max Lun %jd",
   2000  1.160  pgoyette 		    (uintptr_t)sc, *maxlun , 0, 0);
   2001   1.28  augustss 		break;
   2002   1.28  augustss 
   2003   1.28  augustss 	case USBD_STALLED:
   2004   1.28  augustss 		/*
   2005   1.28  augustss 		 * Device doesn't support Get Max Lun request.
   2006   1.28  augustss 		 */
   2007   1.28  augustss 		err = USBD_NORMAL_COMPLETION;
   2008  1.160  pgoyette 		DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun not supported",
   2009  1.160  pgoyette 		    (uintptr_t)sc, 0, 0, 0);
   2010   1.28  augustss 		break;
   2011   1.28  augustss 
   2012   1.28  augustss 	case USBD_SHORT_XFER:
   2013   1.28  augustss 		/*
   2014   1.28  augustss 		 * XXX This must mean Get Max Lun is not supported, too!
   2015   1.28  augustss 		 */
   2016   1.28  augustss 		err = USBD_NORMAL_COMPLETION;
   2017  1.160  pgoyette 		DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun SHORT_XFER",
   2018  1.160  pgoyette 		    (uintptr_t)sc, 0, 0, 0);
   2019   1.28  augustss 		break;
   2020   1.28  augustss 
   2021   1.28  augustss 	default:
   2022   1.28  augustss 		printf("%s: Get Max Lun failed: %s\n",
   2023  1.131    dyoung 		    device_xname(sc->sc_dev), usbd_errstr(err));
   2024   1.28  augustss 		/* XXX Should we port_reset the device? */
   2025   1.28  augustss 		break;
   2026   1.28  augustss 	}
   2027   1.28  augustss 
   2028  1.151     skrll 	return err;
   2029   1.28  augustss }
   2030   1.28  augustss 
   2031   1.28  augustss 
   2032   1.28  augustss 
   2033   1.28  augustss 
   2034   1.28  augustss #ifdef UMASS_DEBUG
   2035   1.28  augustss Static void
   2036   1.28  augustss umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw)
   2037   1.28  augustss {
   2038  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   2039   1.28  augustss 	int clen = cbw->bCDBLength;
   2040   1.28  augustss 	int dlen = UGETDW(cbw->dCBWDataTransferLength);
   2041  1.151     skrll 	uint8_t *c = cbw->CBWCDB;
   2042   1.28  augustss 	int tag = UGETDW(cbw->dCBWTag);
   2043   1.28  augustss 	int flags = cbw->bCBWFlags;
   2044   1.28  augustss 
   2045  1.161  pgoyette 	DPRINTFM(UDMASS_BBB, "sc %#jx: CBW %jd: cmdlen=%jd",
   2046  1.161  pgoyette 	    (uintptr_t)sc, tag, clen, 0);
   2047  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "  0x%02jx%02jx%02jx%02jx...",
   2048  1.160  pgoyette 	    c[0], c[1], c[2], c[3]);
   2049  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "  0x%02jx%02jx%02jx%02jx...",
   2050  1.160  pgoyette 	    c[4], c[5], c[6], c[7]);
   2051  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "  0x%02jx%02jx...", c[8], c[9], 0, 0);
   2052  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "  data = %jd bytes, flags = %jx", dlen, flags, 0,
   2053  1.153     skrll 	    0);
   2054   1.28  augustss }
   2055   1.28  augustss 
   2056   1.28  augustss Static void
   2057   1.28  augustss umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw)
   2058   1.28  augustss {
   2059  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   2060   1.28  augustss 	int sig = UGETDW(csw->dCSWSignature);
   2061  1.112   mycroft 	int tag = UGETDW(csw->dCSWTag);
   2062   1.28  augustss 	int res = UGETDW(csw->dCSWDataResidue);
   2063   1.28  augustss 	int status = csw->bCSWStatus;
   2064   1.28  augustss 
   2065  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "sc %#jx: CSW %jd: sig = 0x%08jx, tag = %jd",
   2066  1.160  pgoyette 	    (uintptr_t)sc, (uintptr_t)csw, sig, tag);
   2067  1.160  pgoyette 	DPRINTFM(UDMASS_BBB, "  res = %jd, status = 0x%02jx",
   2068  1.160  pgoyette 	    res, status, 0, 0);
   2069   1.28  augustss }
   2070   1.28  augustss 
   2071   1.28  augustss Static void
   2072  1.151     skrll umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, int buflen,
   2073   1.28  augustss 		  int printlen)
   2074   1.28  augustss {
   2075  1.153     skrll 	UMASSHIST_FUNC(); UMASSHIST_CALLED();
   2076  1.153     skrll 	int i;
   2077  1.153     skrll 
   2078  1.162  pgoyette 	DPRINTFM(UDMASS_GEN, "sc %#jx: buffer %#jx", (uintptr_t)sc,
   2079  1.162  pgoyette 	    (uintptr_t)buffer, 0, 0);
   2080  1.153     skrll 	for (i = 0; i < buflen && i < printlen;) {
   2081  1.153     skrll 		if (i + 3 < buflen && i + 3 < printlen) {
   2082  1.160  pgoyette 			DPRINTFM(UDMASS_GEN, "   0x%02jx%02jx%02jx%02jx",
   2083  1.154     skrll 			    buffer[i], buffer[i + 1],
   2084  1.153     skrll 			    buffer[i + 2], buffer[i + 3]);
   2085  1.153     skrll 			i += 4;
   2086  1.153     skrll 		} else if (i + 2 < buflen && i + 2 < printlen) {
   2087  1.160  pgoyette 			DPRINTFM(UDMASS_GEN, "   0x%02jx%02jx%02jx",
   2088  1.153     skrll 			    buffer[i], buffer[i + 1], buffer[i + 2], 0);
   2089  1.153     skrll 			i += 3;
   2090  1.153     skrll 		} else if (i + 1 < buflen && i + 2 < printlen) {
   2091  1.160  pgoyette 			DPRINTFM(UDMASS_GEN, "   0x%02jx%02jx",
   2092  1.153     skrll 			    buffer[i], buffer[i + 1], 0, 0);
   2093  1.153     skrll 			i += 2;
   2094  1.153     skrll 		} else {
   2095  1.160  pgoyette 			DPRINTFM(UDMASS_GEN, "   0x%02jx", buffer[i], 0, 0, 0);
   2096  1.153     skrll 			i += 1;
   2097  1.153     skrll 		}
   2098  1.153     skrll 	}
   2099   1.28  augustss }
   2100   1.28  augustss #endif
   2101