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