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