/* $NetBSD: umass.c,v 1.189 2022/09/22 14:27:52 riastradh Exp $ */

/* $NetBSD: umass.c,v 1.189 2022/09/22 14:27:52 riastradh Exp $ */

/*
* Copyright (c) 2003 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Charles M. Hannum.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

/*-
* Copyright (c) 1999 MAEKAWA Masahide <[email protected]>,
* Nick Hibma <[email protected]>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD: src/sys/dev/usb/umass.c,v 1.13 2000/03/26 01:39:12 n_hibma Exp $
*/

/*
* Universal Serial Bus Mass Storage Class specs:
* http://www.usb.org/developers/docs/devclass_docs/Mass_Storage_Specification_Overview_v1.4_2-19-2010.pdf
* http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
* http://www.usb.org/developers/docs/devclass_docs/usb_msc_cbi_1.1.pdf
* http://www.usb.org/developers/docs/devclass_docs/usbmass-ufi10.pdf
*/

/*
* Ported to NetBSD by Lennart Augustsson <[email protected]>.
* Parts of the code written by Jason R. Thorpe <[email protected]>.
*/

/*
* The driver handles 3 Wire Protocols
* - Command/Bulk/Interrupt (CBI)
* - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI)
* - Mass Storage Bulk-Only (BBB)
* (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases)
*
* Over these wire protocols it handles the following command protocols
* - SCSI
* - 8070 (ATA/ATAPI for rewritable removable media)
* - UFI (USB Floppy Interface)
*
* 8070i is a transformed version of the SCSI command set. UFI is a transformed
* version of the 8070i command set. The sc->transform method is used to
* convert the commands into the appropriate format (if at all necessary).
* For example, ATAPI requires all commands to be 12 bytes in length amongst
* other things.
*
* The source code below is marked and can be split into a number of pieces
* (in this order):
*
* - probe/attach/detach
* - generic transfer routines
* - BBB
* - CBI
* - CBI_I (in addition to functions from CBI)
* - CAM (Common Access Method)
* - SCSI
* - UFI
* - 8070i
*
* The protocols are implemented using a state machine, for the transfers as
* well as for the resets. The state machine is contained in umass_*_state.
* The state machine is started through either umass_*_transfer or
* umass_*_reset.
*
* The reason for doing this is a) CAM performs a lot better this way and b) it
* avoids sleeping in interrupt context which is prohibited (for example after a
* failed transfer).
*/

/*
* The SCSI related part of this driver has been derived from the
* dev/ppbus/vpo.c driver, by Nicolas Souchu ([email protected]).
*
* The CAM layer uses so called actions which are messages sent to the host
* adapter for completion. The actions come in through umass_cam_action. The
* appropriate block of routines is called depending on the transport protocol
* in use. When the transfer has finished, these routines call
* umass_cam_cb again to complete the CAM command.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: umass.c,v 1.189 2022/09/22 14:27:52 riastradh Exp $");

#ifdef _KERNEL_OPT
#include "opt_usb.h"
#endif

#include "atapibus.h"
#include "scsibus.h"

#include <sys/param.h>
#include <sys/buf.h>
#include <sys/conf.h>
#include <sys/device.h>
#include <sys/kernel.h>
#include <sys/kmem.h>
#include <sys/sysctl.h>
#include <sys/systm.h>

#include <dev/usb/usb.h>
#include <dev/usb/usb_sdt.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include <dev/usb/usbdevs.h>
#include <dev/usb/usbhist.h>

#include <dev/usb/umassvar.h>
#include <dev/usb/umass_quirks.h>
#include <dev/usb/umass_scsipi.h>

#include <dev/scsipi/scsipi_all.h>
#include <dev/scsipi/scsipiconf.h>

SDT_PROBE_DEFINE1(usb, umass, device, attach__start,
"struct umass_softc *"/*sc*/);
SDT_PROBE_DEFINE2(usb, umass, device, attach__done,
"struct umass_softc *"/*sc*/, "usbd_status"/*err*/);
SDT_PROBE_DEFINE1(usb, umass, device, detach__start,
"struct umass_softc *"/*sc*/);
SDT_PROBE_DEFINE2(usb, umass, device, detach__done,
"struct umass_softc *"/*sc*/, "int"/*error*/);

SDT_PROBE_DEFINE7(usb, umass, transfer, start__bbb,
"struct umass_softc *"/*sc*/,
"transfer_cb_f"/*cb*/,
"void *"/*priv*/,
"void *"/*data*/,
"int"/*datalen*/,
"int"/*dir*/,
"int"/*timeout*/);
SDT_PROBE_DEFINE7(usb, umass, transfer, start__cbi,
"struct umass_softc *"/*sc*/,
"transfer_cb_f"/*cb*/,
"void *"/*priv*/,
"void *"/*data*/,
"int"/*datalen*/,
"int"/*dir*/,
"int"/*timeout*/);
SDT_PROBE_DEFINE7(usb, umass, transfer, done,
"struct umass_softc *"/*sc*/,
"transfer_cb_f"/*cb*/,
"void *"/*priv*/,
"void *"/*data*/,
"int"/*datalen*/,
"int"/*resid*/,
"int"/*status*/); /* STATUS_* */

SDT_PROBE_DEFINE3(usb, umass, bbb, state,
"struct umass_softc *"/*sc*/,
"struct usbd_xfer *"/*xfer*/,
"usbd_status"/*err*/);
SDT_PROBE_DEFINE2(usb, umass, bbb, reset,
"struct umass_softc *"/*sc*/,
"int"/*status*/);

SDT_PROBE_DEFINE3(usb, umass, cbi, state,
"struct umass_softc *"/*sc*/,
"struct usbd_xfer *"/*xfer*/,
"usbd_status"/*err*/);
SDT_PROBE_DEFINE2(usb, umass, cbi, reset,
"struct umass_softc *"/*sc*/,
"int"/*status*/);

#ifdef USB_DEBUG
#ifdef UMASS_DEBUG
int umassdebug = 0;

SYSCTL_SETUP(sysctl_hw_umass_setup, "sysctl hw.umass setup")
{
int err;
const struct sysctlnode *rnode;
const struct sysctlnode *cnode;

err = sysctl_createv(clog, 0, NULL, &rnode,
CTLFLAG_PERMANENT, CTLTYPE_NODE, "umass",
SYSCTL_DESCR("umass global controls"),
NULL, 0, NULL, 0, CTL_HW, CTL_CREATE, CTL_EOL);

if (err)
goto fail;

/* control debugging printfs */
err = sysctl_createv(clog, 0, &rnode, &cnode,
CTLFLAG_PERMANENT|CTLFLAG_READWRITE, CTLTYPE_INT,
"debug", SYSCTL_DESCR("Enable debugging output"),
NULL, 0, &umassdebug, sizeof(umassdebug), CTL_CREATE, CTL_EOL);
if (err)
goto fail;

return;
fail:
aprint_error("%s: sysctl_createv failed (err = %d)\n", __func__, err);
}

const char *states[TSTATE_STATES+1] = {
/* should be kept in sync with the list at transfer_state */
"Idle",
"BBB CBW",
"BBB Data",
"BBB Data bulk-in/-out clear stall",
"BBB CSW, 1st attempt",
"BBB CSW bulk-in clear stall",
"BBB CSW, 2nd attempt",
"BBB Reset",
"BBB bulk-in clear stall",
"BBB bulk-out clear stall",
"CBI Command",
"CBI Data",
"CBI Status",
"CBI Data bulk-in/-out clear stall",
"CBI Status intr-in clear stall",
"CBI Reset",
"CBI bulk-in clear stall",
"CBI bulk-out clear stall",
NULL
};
#endif
#endif

/* USB device probe/attach/detach functions */
static int umass_match(device_t, cfdata_t, void *);
static void umass_attach(device_t, device_t, void *);
static int umass_detach(device_t, int);
static void umass_childdet(device_t, device_t);
static int umass_activate(device_t, enum devact);

CFATTACH_DECL2_NEW(umass, sizeof(struct umass_softc), umass_match,
umass_attach, umass_detach, umass_activate, NULL, umass_childdet);

Static void umass_disco(struct umass_softc *sc);

/* generic transfer functions */
Static usbd_status umass_setup_transfer(struct umass_softc *,
struct usbd_pipe *,
void *, int, int,
struct usbd_xfer *);
Static usbd_status umass_setup_ctrl_transfer(struct umass_softc *,
usb_device_request_t *,
void *, int, int,
struct usbd_xfer *);
Static void umass_clear_endpoint_stall(struct umass_softc *, int,
struct usbd_xfer *);
Static void umass_transfer_done(struct umass_softc *, int, int);
Static void umass_transfer_reset(struct umass_softc *);
#if 0
Static void umass_reset(struct umass_softc *, transfer_cb_f, void *);
#endif

/* Bulk-Only related functions */
Static void umass_bbb_transfer(struct umass_softc *, int, void *, int, void *,
int, int, u_int, int, umass_callback, void *);
Static void umass_bbb_reset(struct umass_softc *, int);
Static void umass_bbb_state(struct usbd_xfer *, void *, usbd_status);

static usbd_status umass_bbb_get_max_lun(struct umass_softc *, uint8_t *);

/* CBI related functions */
Static void umass_cbi_transfer(struct umass_softc *, int, void *, int, void *,
int, int, u_int, int, umass_callback, void *);
Static void umass_cbi_reset(struct umass_softc *, int);
Static void umass_cbi_state(struct usbd_xfer *, void *, usbd_status);

Static int umass_cbi_adsc(struct umass_softc *, char *, int, int,
struct usbd_xfer *);

const struct umass_wire_methods umass_bbb_methods = {
.wire_xfer = umass_bbb_transfer,
.wire_reset = umass_bbb_reset,
.wire_state = umass_bbb_state
};

const struct umass_wire_methods umass_cbi_methods = {
.wire_xfer = umass_cbi_transfer,
.wire_reset = umass_cbi_reset,
.wire_state = umass_cbi_state
};

#ifdef UMASS_DEBUG
/* General debugging functions */
Static void umass_bbb_dump_cbw(struct umass_softc *, umass_bbb_cbw_t *);
Static void umass_bbb_dump_csw(struct umass_softc *, umass_bbb_csw_t *);
Static void umass_dump_buffer(struct umass_softc *, uint8_t *, int, int);
#endif

/*
* USB device probe/attach/detach
*/

static int
umass_match(device_t parent, cfdata_t match, void *aux)
{
struct usbif_attach_arg *uiaa = aux;
const struct umass_quirk *quirk;

quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product);
if (quirk != NULL && quirk->uq_match != UMASS_QUIRK_USE_DEFAULTMATCH)
return quirk->uq_match;

if (uiaa->uiaa_class != UICLASS_MASS)
return UMATCH_NONE;

switch (uiaa->uiaa_subclass) {
case UISUBCLASS_RBC:
case UISUBCLASS_SFF8020I:
case UISUBCLASS_QIC157:
case UISUBCLASS_UFI:
case UISUBCLASS_SFF8070I:
case UISUBCLASS_SCSI:
break;
default:
return UMATCH_IFACECLASS;
}

switch (uiaa->uiaa_proto) {
case UIPROTO_MASS_CBI_I:
case UIPROTO_MASS_CBI:
case UIPROTO_MASS_BBB_OLD:
case UIPROTO_MASS_BBB:
break;
default:
return UMATCH_IFACECLASS_IFACESUBCLASS;
}

return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO;
}

static void
umass_attach(device_t parent, device_t self, void *aux)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
struct umass_softc *sc = device_private(self);
struct usbif_attach_arg *uiaa = aux;
const struct umass_quirk *quirk;
usb_interface_descriptor_t *id;
usb_endpoint_descriptor_t *ed;
const char *sWire, *sCommand;
char *devinfop;
usbd_status err;
int i, error;

SDT_PROBE1(usb, umass, device, attach__start, sc);

sc->sc_dev = self;

aprint_naive("\n");
aprint_normal("\n");

mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB);

devinfop = usbd_devinfo_alloc(uiaa->uiaa_device, 0);
aprint_normal_dev(self, "%s\n", devinfop);
usbd_devinfo_free(devinfop);

sc->sc_udev = uiaa->uiaa_device;
sc->sc_iface = uiaa->uiaa_iface;
sc->sc_ifaceno = uiaa->uiaa_ifaceno;

quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product);
if (quirk != NULL) {
sc->sc_wire = quirk->uq_wire;
sc->sc_cmd = quirk->uq_cmd;
sc->sc_quirks = quirk->uq_flags;
sc->sc_busquirks = quirk->uq_busquirks;

if (quirk->uq_fixup != NULL)
(*quirk->uq_fixup)(sc);
} else {
sc->sc_wire = UMASS_WPROTO_UNSPEC;
sc->sc_cmd = UMASS_CPROTO_UNSPEC;
sc->sc_quirks = 0;
sc->sc_busquirks = 0;
}

if (sc->sc_wire == UMASS_WPROTO_UNSPEC) {
switch (uiaa->uiaa_proto) {
case UIPROTO_MASS_CBI:
sc->sc_wire = UMASS_WPROTO_CBI;
break;
case UIPROTO_MASS_CBI_I:
sc->sc_wire = UMASS_WPROTO_CBI_I;
break;
case UIPROTO_MASS_BBB:
case UIPROTO_MASS_BBB_OLD:
sc->sc_wire = UMASS_WPROTO_BBB;
break;
default:
DPRINTFM(UDMASS_GEN, "Unsupported wire protocol %ju",
uiaa->uiaa_proto, 0, 0, 0);
SDT_PROBE2(usb, umass, device, attach__done,
sc, USBD_IOERROR);
return;
}
}

if (sc->sc_cmd == UMASS_CPROTO_UNSPEC) {
switch (uiaa->uiaa_subclass) {
case UISUBCLASS_SCSI:
sc->sc_cmd = UMASS_CPROTO_SCSI;
break;
case UISUBCLASS_UFI:
sc->sc_cmd = UMASS_CPROTO_UFI;
break;
case UISUBCLASS_SFF8020I:
case UISUBCLASS_SFF8070I:
case UISUBCLASS_QIC157:
sc->sc_cmd = UMASS_CPROTO_ATAPI;
break;
case UISUBCLASS_RBC:
sc->sc_cmd = UMASS_CPROTO_RBC;
break;
default:
DPRINTFM(UDMASS_GEN, "Unsupported command protocol %ju",
uiaa->uiaa_subclass, 0, 0, 0);
SDT_PROBE2(usb, umass, device, attach__done,
sc, USBD_IOERROR);
return;
}
}

switch (sc->sc_wire) {
case UMASS_WPROTO_CBI:
sWire = "CBI";
break;
case UMASS_WPROTO_CBI_I:
sWire = "CBI with CCI";
break;
case UMASS_WPROTO_BBB:
sWire = "Bulk-Only";
break;
default:
sWire = "unknown";
break;
}

switch (sc->sc_cmd) {
case UMASS_CPROTO_RBC:
sCommand = "RBC";
break;
case UMASS_CPROTO_SCSI:
sCommand = "SCSI";
break;
case UMASS_CPROTO_UFI:
sCommand = "UFI";
break;
case UMASS_CPROTO_ATAPI:
sCommand = "ATAPI";
break;
case UMASS_CPROTO_ISD_ATA:
sCommand = "ISD-ATA";
break;
default:
sCommand = "unknown";
break;
}

aprint_verbose_dev(self, "using %s over %s\n", sCommand, sWire);

if (quirk != NULL && quirk->uq_init != NULL) {
err = (*quirk->uq_init)(sc);
if (err) {
aprint_error_dev(self, "quirk init failed\n");
SDT_PROBE2(usb, umass, device, attach__done, sc, err);
umass_disco(sc);
return;
}
}

/*
* In addition to the Control endpoint the following endpoints
* are required:
* a) bulk-in endpoint.
* b) bulk-out endpoint.
* and for Control/Bulk/Interrupt with CCI (CBI_I)
* c) intr-in
*
* The endpoint addresses are not fixed, so we have to read them
* from the device descriptors of the current interface.
*/
id = usbd_get_interface_descriptor(sc->sc_iface);
for (i = 0 ; i < id->bNumEndpoints ; i++) {
ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
if (ed == NULL) {
aprint_error_dev(self,
"could not read endpoint descriptor\n");
SDT_PROBE2(usb, umass, device, attach__done,
sc, USBD_IOERROR);
return;
}
if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
&& (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
sc->sc_epaddr[UMASS_BULKIN] = ed->bEndpointAddress;
} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
&& (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
sc->sc_epaddr[UMASS_BULKOUT] = ed->bEndpointAddress;
} else if (sc->sc_wire == UMASS_WPROTO_CBI_I
&& UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
&& (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
sc->sc_epaddr[UMASS_INTRIN] = ed->bEndpointAddress;
#ifdef UMASS_DEBUG
if (UGETW(ed->wMaxPacketSize) > 2) {
DPRINTFM(UDMASS_CBI, "sc %#jx intr size is %jd",
(uintptr_t)sc, UGETW(ed->wMaxPacketSize),
0, 0);
}
#endif
}
}

/* check whether we found all the endpoints we need */
if (!sc->sc_epaddr[UMASS_BULKIN] || !sc->sc_epaddr[UMASS_BULKOUT] ||
(sc->sc_wire == UMASS_WPROTO_CBI_I &&
!sc->sc_epaddr[UMASS_INTRIN])) {
aprint_error_dev(self, "endpoint not found %u/%u/%u\n",
sc->sc_epaddr[UMASS_BULKIN],
sc->sc_epaddr[UMASS_BULKOUT],
sc->sc_epaddr[UMASS_INTRIN]);
return;
}

/*
* Get the maximum LUN supported by the device.
*/
if (sc->sc_wire == UMASS_WPROTO_BBB &&
(sc->sc_quirks & UMASS_QUIRK_NOGETMAXLUN) == 0) {
err = umass_bbb_get_max_lun(sc, &sc->maxlun);
if (err) {
aprint_error_dev(self, "unable to get Max Lun: %s\n",
usbd_errstr(err));
SDT_PROBE2(usb, umass, device, attach__done, sc, err);
return;
}
if (sc->maxlun > 0)
sc->sc_busquirks |= PQUIRK_FORCELUNS;
} else {
sc->maxlun = 0;
}

/* Open the bulk-in and -out pipe */
DPRINTFM(UDMASS_USB, "sc %#jx: opening iface %#jx epaddr %jd for "
"BULKOUT", (uintptr_t)sc, (uintptr_t)sc->sc_iface,
sc->sc_epaddr[UMASS_BULKOUT], 0);
err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKOUT],
USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKOUT]);
if (err) {
aprint_error_dev(self, "cannot open %u-out pipe (bulk)\n",
sc->sc_epaddr[UMASS_BULKOUT]);
SDT_PROBE2(usb, umass, device, attach__done, sc, err);
umass_disco(sc);
return;
}
DPRINTFM(UDMASS_USB, "sc %#jx: opening iface %#jx epaddr %jd for "
"BULKIN", (uintptr_t)sc, (uintptr_t)sc->sc_iface,
sc->sc_epaddr[UMASS_BULKIN], 0);
err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN],
USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKIN]);
if (err) {
aprint_error_dev(self, "could not open %u-in pipe (bulk)\n",
sc->sc_epaddr[UMASS_BULKIN]);
SDT_PROBE2(usb, umass, device, attach__done, sc, err);
umass_disco(sc);
return;
}
/*
* Open the intr-in pipe if the protocol is CBI with CCI.
* Note: early versions of the Zip drive do have an interrupt pipe, but
* this pipe is unused
*
* We do not open the interrupt pipe as an interrupt pipe, but as a
* normal bulk endpoint. We send an IN transfer down the wire at the
* appropriate time, because we know exactly when to expect data on
* that endpoint. This saves bandwidth, but more important, makes the
* code for handling the data on that endpoint simpler. No data
* arriving concurrently.
*/
if (sc->sc_wire == UMASS_WPROTO_CBI_I) {
DPRINTFM(UDMASS_USB,
"sc %#jx: opening iface %#jx epaddr %jd for INTRIN",
(uintptr_t)sc, (uintptr_t)sc->sc_iface,
sc->sc_epaddr[UMASS_INTRIN], 0);
err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN],
USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_INTRIN]);
if (err) {
aprint_error_dev(self, "couldn't open %u-in (intr)\n",
sc->sc_epaddr[UMASS_INTRIN]);
SDT_PROBE2(usb, umass, device, attach__done, sc, err);
umass_disco(sc);
return;
}
}

/* initialisation of generic part */
sc->transfer_state = TSTATE_IDLE;

for (i = 0; i < XFER_NR; i++) {
sc->transfer_xfer[i] = NULL;
}

/*
* Create the transfers
*/
struct usbd_pipe *pipe0 = usbd_get_pipe0(sc->sc_udev);
switch (sc->sc_wire) {
case UMASS_WPROTO_BBB:
err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
UMASS_MAX_TRANSFER_SIZE, 0, 0,
&sc->transfer_xfer[XFER_BBB_DATAIN]);
if (err)
goto fail_create;
err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT],
UMASS_MAX_TRANSFER_SIZE, 0, 0,
&sc->transfer_xfer[XFER_BBB_DATAOUT]);
if (err)
goto fail_create;
err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT],
UMASS_BBB_CBW_SIZE, 0, 0,
&sc->transfer_xfer[XFER_BBB_CBW]);
if (err)
goto fail_create;
err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
UMASS_BBB_CSW_SIZE, 0, 0,
&sc->transfer_xfer[XFER_BBB_CSW1]);
if (err)
goto fail_create;
err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
UMASS_BBB_CSW_SIZE, 0, 0,
&sc->transfer_xfer[XFER_BBB_CSW2]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, 0, 0, 0,
&sc->transfer_xfer[XFER_BBB_SCLEAR]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, 0, 0, 0,
&sc->transfer_xfer[XFER_BBB_DCLEAR]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, 0, 0, 0,
&sc->transfer_xfer[XFER_BBB_RESET1]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, 0, 0, 0,
&sc->transfer_xfer[XFER_BBB_RESET2]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, 0, 0, 0,
&sc->transfer_xfer[XFER_BBB_RESET3]);
if (err)
goto fail_create;
break;
case UMASS_WPROTO_CBI:
case UMASS_WPROTO_CBI_I:
err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
&sc->transfer_xfer[XFER_CBI_CB]);
if (err)
goto fail_create;
err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN],
UMASS_MAX_TRANSFER_SIZE, 0, 0,
&sc->transfer_xfer[XFER_CBI_DATAIN]);
if (err)
goto fail_create;
err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT],
UMASS_MAX_TRANSFER_SIZE, 0, 0,
&sc->transfer_xfer[XFER_CBI_DATAOUT]);
if (err)
goto fail_create;
err = usbd_create_xfer(sc->sc_pipe[UMASS_INTRIN],
sizeof(sc->sbl), 0, 0,
&sc->transfer_xfer[XFER_CBI_STATUS]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, 0, 0, 0,
&sc->transfer_xfer[XFER_CBI_DCLEAR]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, 0, 0, 0,
&sc->transfer_xfer[XFER_CBI_SCLEAR]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
&sc->transfer_xfer[XFER_CBI_RESET1]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
&sc->transfer_xfer[XFER_CBI_RESET2]);
if (err)
goto fail_create;
err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0,
&sc->transfer_xfer[XFER_CBI_RESET3]);
if (err)
goto fail_create;
break;
default:
fail_create:
aprint_error_dev(self, "failed to create xfers\n");
SDT_PROBE2(usb, umass, device, attach__done, sc, err);
umass_disco(sc);
return;
}

/*
* Record buffer pointers for data transfer (it's huge), command and
* status data here
*/
switch (sc->sc_wire) {
case UMASS_WPROTO_BBB:
sc->datain_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAIN]);
sc->dataout_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAOUT]);
sc->cmd_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CBW]);
sc->s1_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW1]);
sc->s2_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW2]);
break;
case UMASS_WPROTO_CBI:
case UMASS_WPROTO_CBI_I:
sc->datain_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAIN]);
sc->dataout_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAOUT]);
sc->cmd_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_CBI_CB]);
sc->s1_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_CBI_STATUS]);
sc->s2_buffer =
usbd_get_buffer(sc->transfer_xfer[XFER_CBI_RESET1]);
break;
default:
break;
}

/* Initialise the wire protocol specific methods */
switch (sc->sc_wire) {
case UMASS_WPROTO_BBB:
sc->sc_methods = &umass_bbb_methods;
break;
case UMASS_WPROTO_CBI:
case UMASS_WPROTO_CBI_I:
sc->sc_methods = &umass_cbi_methods;
break;
default:
umass_disco(sc);
return;
}

error = 0;
switch (sc->sc_cmd) {
case UMASS_CPROTO_RBC:
case UMASS_CPROTO_SCSI:
#if NSCSIBUS > 0
error = umass_scsi_attach(sc);
#else
aprint_error_dev(self, "scsibus not configured\n");
#endif
break;

case UMASS_CPROTO_UFI:
case UMASS_CPROTO_ATAPI:
#if NATAPIBUS > 0
error = umass_atapi_attach(sc);
#else
aprint_error_dev(self, "atapibus not configured\n");
#endif
break;

default:
aprint_error_dev(self, "command protocol=%#x not supported\n",
sc->sc_cmd);
umass_disco(sc);
return;
}
if (error) {
aprint_error_dev(self, "bus attach failed\n");
SDT_PROBE2(usb, umass, device, attach__done,
sc, USBD_IOERROR);
umass_disco(sc);
return;
}

usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);

if (!pmf_device_register(self, NULL, NULL))
aprint_error_dev(self, "couldn't establish power handler\n");

DPRINTFM(UDMASS_GEN, "sc %#jx: Attach finished", (uintptr_t)sc,
0, 0, 0);

SDT_PROBE2(usb, umass, device, attach__done, sc, 0);
return;
}

static void
umass_childdet(device_t self, device_t child)
{
struct umass_softc *sc = device_private(self);

KASSERTMSG(child == sc->bus->sc_child,
"assertion child == sc->bus->sc_child failed\n");
sc->bus->sc_child = NULL;
}

static int
umass_detach(device_t self, int flags)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
struct umass_softc *sc = device_private(self);
struct umassbus_softc *scbus;
int rv = 0, i;

DPRINTFM(UDMASS_USB, "sc %#jx detached", (uintptr_t)sc, 0, 0, 0);
SDT_PROBE1(usb, umass, device, detach__start, sc);

mutex_enter(&sc->sc_lock);
sc->sc_dying = true;
mutex_exit(&sc->sc_lock);

pmf_device_deregister(self);

/* Abort the pipes to wake up any waiting processes. */
for (i = 0 ; i < UMASS_NEP ; i++) {
if (sc->sc_pipe[i] != NULL)
usbd_abort_pipe(sc->sc_pipe[i]);
}
usbd_abort_default_pipe(sc->sc_udev);

scbus = sc->bus;
if (scbus != NULL) {
if (scbus->sc_child != NULL)
rv = config_detach(scbus->sc_child, flags);

switch (sc->sc_cmd) {
case UMASS_CPROTO_RBC:
case UMASS_CPROTO_SCSI:
#if NSCSIBUS > 0
umass_scsi_detach(sc);
#else
aprint_error_dev(self, "scsibus not configured\n");
#endif
break;

case UMASS_CPROTO_UFI:
case UMASS_CPROTO_ATAPI:
#if NATAPIBUS > 0
umass_atapi_detach(sc);
#else
aprint_error_dev(self, "atapibus not configured\n");
#endif
break;

default:
/* nothing to do */
break;
}

/* protocol detach is expected to free sc->bus */
KASSERT(sc->bus == NULL);
}

if (rv)
goto out;

umass_disco(sc);

usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);

mutex_destroy(&sc->sc_lock);

out: SDT_PROBE2(usb, umass, device, detach__done, sc, rv);
return rv;
}

static int
umass_activate(device_t dev, enum devact act)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
struct umass_softc *sc = device_private(dev);

DPRINTFM(UDMASS_USB, "sc %#jx act %jd", (uintptr_t)sc, act, 0, 0);

switch (act) {
case DVACT_DEACTIVATE:
sc->sc_dying = 1;
return 0;
default:
return EOPNOTSUPP;
}
}

Static void
umass_disco(struct umass_softc *sc)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
int i;

/* Remove all the pipes. */
for (i = 0 ; i < UMASS_NEP ; i++) {
if (sc->sc_pipe[i] != NULL) {
usbd_abort_pipe(sc->sc_pipe[i]);
}
}

/* Some xfers may be queued in the default pipe */
usbd_abort_default_pipe(sc->sc_udev);

/* Free the xfers. */
for (i = 0; i < XFER_NR; i++) {
if (sc->transfer_xfer[i] != NULL) {
usbd_destroy_xfer(sc->transfer_xfer[i]);
sc->transfer_xfer[i] = NULL;
}
}

for (i = 0 ; i < UMASS_NEP ; i++) {
if (sc->sc_pipe[i] != NULL) {
usbd_close_pipe(sc->sc_pipe[i]);
sc->sc_pipe[i] = NULL;
}
}

}

/*
* Generic functions to handle transfers
*/

Static usbd_status
umass_setup_transfer(struct umass_softc *sc, struct usbd_pipe *pipe,
void *buffer, int buflen, int flags,
struct usbd_xfer *xfer)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
usbd_status err;

if (sc->sc_dying)
return USBD_IOERROR;

/* Initialise a USB transfer and then schedule it */

usbd_setup_xfer(xfer, sc, buffer, buflen, flags, sc->timeout,
sc->sc_methods->wire_state);

err = usbd_transfer(xfer);
DPRINTFM(UDMASS_XFER, "start xfer buffer=%#jx buflen=%jd flags=%#jx "
"timeout=%jd", (uintptr_t)buffer, buflen, flags, sc->timeout);
if (err && err != USBD_IN_PROGRESS) {
DPRINTFM(UDMASS_BBB, "failed to setup transfer... err=%jd",
err, 0, 0, 0);
return err;
}

return USBD_NORMAL_COMPLETION;
}

Static usbd_status
umass_setup_ctrl_transfer(struct umass_softc *sc, usb_device_request_t *req,
void *buffer, int buflen, int flags, struct usbd_xfer *xfer)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
usbd_status err;

if (sc->sc_dying)
return USBD_IOERROR;

/* Initialise a USB control transfer and then schedule it */

usbd_setup_default_xfer(xfer, sc->sc_udev, sc, USBD_DEFAULT_TIMEOUT,
req, buffer, buflen, flags, sc->sc_methods->wire_state);

err = usbd_transfer(xfer);
if (err && err != USBD_IN_PROGRESS) {
DPRINTFM(UDMASS_BBB, "failed to setup ctrl transfer... err=%jd",
err, 0, 0, 0);

/* do not reset, as this would make us loop */
return err;
}

return USBD_NORMAL_COMPLETION;
}

Static void
umass_clear_endpoint_stall(struct umass_softc *sc, int endpt,
struct usbd_xfer *xfer)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();

if (sc->sc_dying) {
umass_transfer_done(sc, sc->transfer_datalen,
STATUS_WIRE_FAILED);
return;
}

DPRINTFM(UDMASS_BBB, "Clear endpoint 0x%02jx stall",
sc->sc_epaddr[endpt], 0, 0, 0);

usbd_clear_endpoint_toggle(sc->sc_pipe[endpt]);

sc->sc_req.bmRequestType = UT_WRITE_ENDPOINT;
sc->sc_req.bRequest = UR_CLEAR_FEATURE;
USETW(sc->sc_req.wValue, UF_ENDPOINT_HALT);
USETW(sc->sc_req.wIndex, sc->sc_epaddr[endpt]);
USETW(sc->sc_req.wLength, 0);
if (umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, xfer))
umass_transfer_done(sc, sc->transfer_datalen,
STATUS_WIRE_FAILED);
}

Static void
umass_transfer_done(struct umass_softc *sc, int residue, int status)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();

sc->transfer_state = TSTATE_IDLE;
SDT_PROBE7(usb, umass, transfer, done,
sc,
sc->transfer_cb,
sc->transfer_priv,
sc->transfer_data,
sc->transfer_datalen,
residue,
status);
sc->transfer_cb(sc, sc->transfer_priv, residue, status);
}

Static void
umass_transfer_reset(struct umass_softc *sc)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();

sc->transfer_state = TSTATE_IDLE;
if (sc->transfer_priv) {
SDT_PROBE7(usb, umass, transfer, done,
sc,
sc->transfer_cb,
sc->transfer_priv,
sc->transfer_data,
sc->transfer_datalen,
sc->transfer_datalen,
sc->transfer_status);
sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen,
sc->transfer_status);
}
}

#if 0
Static void
umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv)
{
sc->transfer_cb = cb;
sc->transfer_priv = priv;

/* The reset is a forced reset, so no error (yet) */
sc->reset(sc, STATUS_CMD_OK);
}
#endif

/*
* Bulk protocol specific functions
*/

Static void
umass_bbb_reset(struct umass_softc *sc, int status)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
SDT_PROBE2(usb, umass, bbb, reset, sc, status);
KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
"sc->sc_wire == 0x%02x wrong for umass_bbb_reset\n",
sc->sc_wire);

if (sc->sc_dying) {
umass_transfer_done(sc, sc->transfer_datalen, status);
return;
}

/*
* Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
*
* For Reset Recovery the host shall issue in the following order:
* a) a Bulk-Only Mass Storage Reset
* b) a Clear Feature HALT to the Bulk-In endpoint
* c) a Clear Feature HALT to the Bulk-Out endpoint
*
* This is done in 3 steps, states:
* TSTATE_BBB_RESET1
* TSTATE_BBB_RESET2
* TSTATE_BBB_RESET3
*
* If the reset doesn't succeed, the device should be port reset.
*/

DPRINTFM(UDMASS_BBB, "Bulk Reset", 0, 0, 0, 0);

sc->transfer_state = TSTATE_BBB_RESET1;
sc->transfer_status = status;

/* reset is a class specific interface write */
sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
sc->sc_req.bRequest = UR_BBB_RESET;
USETW(sc->sc_req.wValue, 0);
USETW(sc->sc_req.wIndex, sc->sc_ifaceno);
USETW(sc->sc_req.wLength, 0);
if (umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0,
sc->transfer_xfer[XFER_BBB_RESET1]))
umass_transfer_done(sc, sc->transfer_datalen, status);
}

Static void
umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen,
void *data, int datalen, int dir, u_int timeout,
int flags, umass_callback cb, void *priv)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
SDT_PROBE7(usb, umass, transfer, start__bbb,
sc, cb, priv, data, datalen, dir, timeout);
static int dCBWtag = 42; /* unique for CBW of transfer */

KASSERT(cb);
DPRINTFM(UDMASS_BBB, "sc %#jx cmd=0x%02jx", (uintptr_t)sc,
*(u_char *)cmd, 0, 0);

KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
"sc->sc_wire == 0x%02x wrong for umass_bbb_transfer\n",
sc->sc_wire);

if (sc->sc_dying) {
SDT_PROBE7(usb, umass, transfer, done,
sc, cb, priv, data, datalen, datalen, STATUS_WIRE_FAILED);
cb(sc, priv, datalen, STATUS_WIRE_FAILED);
return;
}

/* Be a little generous. */
sc->timeout = timeout + USBD_DEFAULT_TIMEOUT;

/*
* Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly
* a data phase of datalen bytes from/to the device and finally a
* csw read phase.
* If the data direction was inbound a maximum of datalen bytes
* is stored in the buffer pointed to by data.
*
* umass_bbb_transfer initialises the transfer and lets the state
* machine in umass_bbb_state handle the completion. It uses the
* following states:
* TSTATE_BBB_COMMAND
* -> TSTATE_BBB_DATA
* -> TSTATE_BBB_STATUS
* -> TSTATE_BBB_STATUS2
* -> TSTATE_BBB_IDLE
*
* An error in any of those states will invoke
* umass_bbb_reset.
*/

/* check the given arguments */
KASSERTMSG(datalen == 0 || data != NULL,
"%s: datalen > 0, but no buffer",device_xname(sc->sc_dev));
KASSERTMSG(cmdlen <= CBWCDBLENGTH,
"%s: cmdlen exceeds CDB length in CBW (%d > %d)",
device_xname(sc->sc_dev), cmdlen, CBWCDBLENGTH);
KASSERTMSG(dir == DIR_NONE || datalen > 0,
"%s: datalen == 0 while direction is not NONE\n",
device_xname(sc->sc_dev));
KASSERTMSG(datalen == 0 || dir != DIR_NONE,
"%s: direction is NONE while datalen is not zero\n",
device_xname(sc->sc_dev));
/* CTASSERT */
KASSERTMSG(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE,
"%s: CBW struct does not have the right size (%zu vs. %u)\n",
device_xname(sc->sc_dev),
sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE);
/* CTASSERT */
KASSERTMSG(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE,
"%s: CSW struct does not have the right size (%zu vs. %u)\n",
device_xname(sc->sc_dev),
sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE);

/*
* Determine the direction of the data transfer and the length.
*
* dCBWDataTransferLength (datalen) :
* This field indicates the number of bytes of data that the host
* intends to transfer on the IN or OUT Bulk endpoint(as indicated by
* the Direction bit) during the execution of this command. If this
* field is set to 0, the device will expect that no data will be
* transferred IN or OUT during this command, regardless of the value
* of the Direction bit defined in dCBWFlags.
*
* dCBWFlags (dir) :
* The bits of the Flags field are defined as follows:
* Bits 0-6 reserved
* Bit 7 Direction - this bit shall be ignored if the
* dCBWDataTransferLength field is zero.
* 0 = data Out from host to device
* 1 = data In from device to host
*/

/* Fill in the Command Block Wrapper */
USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
USETDW(sc->cbw.dCBWTag, dCBWtag);
dCBWtag++; /* cannot be done in macro (it will be done 4 times) */
USETDW(sc->cbw.dCBWDataTransferLength, datalen);
/* DIR_NONE is treated as DIR_OUT (0x00) */
sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT);
sc->cbw.bCBWLUN = lun;
sc->cbw.bCDBLength = cmdlen;
memcpy(sc->cbw.CBWCDB, cmd, cmdlen);

DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw));

/* store the details for the data transfer phase */
sc->transfer_dir = dir;
sc->transfer_data = data;
sc->transfer_datalen = datalen;
sc->transfer_actlen = 0;
sc->transfer_cb = cb;
sc->transfer_priv = priv;
sc->transfer_status = STATUS_CMD_OK;

/* move from idle to the command state */
sc->transfer_state = TSTATE_BBB_COMMAND;

/* Send the CBW from host to device via bulk-out endpoint. */
if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT],
&sc->cbw, UMASS_BBB_CBW_SIZE, flags,
sc->transfer_xfer[XFER_BBB_CBW])) {
umass_bbb_reset(sc, STATUS_WIRE_FAILED);
}
}

Static void
umass_bbb_state(struct usbd_xfer *xfer, void *priv,
usbd_status err)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
struct umass_softc *sc = (struct umass_softc *) priv;
struct usbd_xfer *next_xfer;
int residue;

SDT_PROBE3(usb, umass, bbb, state, sc, xfer, err);

KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
"sc->sc_wire == 0x%02x wrong for umass_bbb_state\n",
sc->sc_wire);

/*
* State handling for BBB transfers.
*
* The subroutine is rather long. It steps through the states given in
* Annex A of the Bulk-Only specification.
* Each state first does the error handling of the previous transfer
* and then prepares the next transfer.
* Each transfer is done asynchroneously so after the request/transfer
* has been submitted you will find a 'return;'.
*/

DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx, transfer_state %jd dir %jd",
(uintptr_t)sc, (uintptr_t)xfer, sc->transfer_state,
sc->transfer_dir);

if (err == USBD_CANCELLED) {
DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx cancelled",
(uintptr_t)sc, (uintptr_t)xfer, 0, 0);

umass_transfer_done(sc, 0, STATUS_TIMEOUT);
return;
}

if (sc->sc_dying) {
umass_transfer_done(sc, sc->transfer_datalen,
STATUS_WIRE_FAILED);
return;
}

switch (sc->transfer_state) {

/***** Bulk Transfer *****/
case TSTATE_BBB_COMMAND:
/* Command transport phase, error handling */
if (err) {
DPRINTFM(UDMASS_BBB, "sc %#jx failed to send CBW",
(uintptr_t)sc, 0, 0, 0);
/* If the device detects that the CBW is invalid, then
* the device may STALL both bulk endpoints and require
* a Bulk-Reset
*/
umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;
}

/* Data transport phase, setup transfer */
sc->transfer_state = TSTATE_BBB_DATA;
if (sc->transfer_dir == DIR_IN) {
if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
sc->datain_buffer, sc->transfer_datalen,
USBD_SHORT_XFER_OK,
sc->transfer_xfer[XFER_BBB_DATAIN]))
umass_bbb_reset(sc, STATUS_WIRE_FAILED);

return;
} else if (sc->transfer_dir == DIR_OUT) {
memcpy(sc->dataout_buffer, sc->transfer_data,
sc->transfer_datalen);
if (umass_setup_transfer(sc,
sc->sc_pipe[UMASS_BULKOUT], sc->dataout_buffer,
sc->transfer_datalen, 0,/* fixed length transfer */
sc->transfer_xfer[XFER_BBB_DATAOUT]))
umass_bbb_reset(sc, STATUS_WIRE_FAILED);

return;
} else {
DPRINTFM(UDMASS_BBB, "sc %#jx: no data phase",
(uintptr_t)sc, 0, 0, 0);
}

/* if no data phase, err == 0 */
/* FALLTHROUGH */
case TSTATE_BBB_DATA:
/* Command transport phase error handling (ignored if no data
* phase (fallthrough from previous state)) */
if (sc->transfer_dir != DIR_NONE) {
/* retrieve the length of the transfer that was done */
usbd_get_xfer_status(xfer, NULL, NULL,
&sc->transfer_actlen, NULL);
DPRINTFM(UDMASS_BBB, "sc %#jx: BBB_DATA actlen=%jd",
(uintptr_t)sc, sc->transfer_actlen, 0, 0);

if (err) {
DPRINTFM(UDMASS_BBB, "sc %#jx Data dir %jd "
"err %jd failed, err %jd",
(uintptr_t)sc, sc->transfer_dir,
sc->transfer_datalen, err);

if (err == USBD_STALLED) {
sc->transfer_state = TSTATE_BBB_DCLEAR;
umass_clear_endpoint_stall(sc,
(sc->transfer_dir == DIR_IN?
UMASS_BULKIN:UMASS_BULKOUT),
sc->transfer_xfer[XFER_BBB_DCLEAR]);
} else {
/* Unless the error is a pipe stall the
* error is fatal.
*/
umass_bbb_reset(sc,STATUS_WIRE_FAILED);
}
return;
}
}

/* err == 0 (no data phase or successful) */
/* FALLTHROUGH */
case TSTATE_BBB_DCLEAR: /* stall clear after data phase */
if (sc->transfer_dir == DIR_IN)
memcpy(sc->transfer_data, sc->datain_buffer,
sc->transfer_actlen);

DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN)
umass_dump_buffer(sc, sc->transfer_data,
sc->transfer_datalen, 48));

/* err == 0 (no data phase or successful) */
/* FALLTHROUGH */
case TSTATE_BBB_SCLEAR: /* stall clear after status phase */
/* Reading of CSW after bulk stall condition in data phase
* (TSTATE_BBB_DATA2) or bulk-in stall condition after
* reading CSW (TSTATE_BBB_SCLEAR).
* In the case of no data phase or successful data phase,
* err == 0 and the following if block is passed.
*/
if (err) { /* should not occur */
printf("%s: BBB bulk-%s stall clear failed, %s\n",
device_xname(sc->sc_dev),
(sc->transfer_dir == DIR_IN? "in":"out"),
usbd_errstr(err));
umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;
}

/* Status transport phase, setup transfer */
if (sc->transfer_state == TSTATE_BBB_COMMAND ||
sc->transfer_state == TSTATE_BBB_DATA ||
sc->transfer_state == TSTATE_BBB_DCLEAR) {
/* After no data phase, successful data phase and
* after clearing bulk-in/-out stall condition
*/
sc->transfer_state = TSTATE_BBB_STATUS1;
next_xfer = sc->transfer_xfer[XFER_BBB_CSW1];
} else {
/* After first attempt of fetching CSW */
sc->transfer_state = TSTATE_BBB_STATUS2;
next_xfer = sc->transfer_xfer[XFER_BBB_CSW2];
}

/* Read the Command Status Wrapper via bulk-in endpoint. */
if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
&sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) {
umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;
}

return;
case TSTATE_BBB_STATUS1: /* first attempt */
case TSTATE_BBB_STATUS2: /* second attempt */
/* Status transfer, error handling */
if (err) {
DPRINTFM(UDMASS_BBB, "sc %#jx Failed to read CSW "
"err %jd (state %jd)", (uintptr_t)sc, err,
sc->transfer_state, 0);

/* If this was the first attempt at fetching the CSW
* retry it, otherwise fail.
*/
if (sc->transfer_state == TSTATE_BBB_STATUS1) {
sc->transfer_state = TSTATE_BBB_SCLEAR;
umass_clear_endpoint_stall(sc, UMASS_BULKIN,
sc->transfer_xfer[XFER_BBB_SCLEAR]);
return;
} else {
umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;
}
}

DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw));

#ifdef UMASS_DEBUG
residue = UGETDW(sc->csw.dCSWDataResidue);
if (residue != sc->transfer_datalen - sc->transfer_actlen)
printf("%s: dCSWDataResidue=%d req=%d act=%d\n",
device_xname(sc->sc_dev), residue,
sc->transfer_datalen, sc->transfer_actlen);
#endif
residue = sc->transfer_datalen - sc->transfer_actlen;

/* Translate weird command-status signatures. */
if ((sc->sc_quirks & UMASS_QUIRK_WRONG_CSWSIG) &&
UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1)
USETDW(sc->csw.dCSWSignature, CSWSIGNATURE);

/* Translate invalid command-status tags */
if (sc->sc_quirks & UMASS_QUIRK_WRONG_CSWTAG)
USETDW(sc->csw.dCSWTag, UGETDW(sc->cbw.dCBWTag));

/* Check CSW and handle any error */
if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) {
/* Invalid CSW: Wrong signature or wrong tag might
* indicate that the device is confused -> reset it.
*/
printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n",
device_xname(sc->sc_dev),
UGETDW(sc->csw.dCSWSignature),
CSWSIGNATURE);

umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;
} else if (UGETDW(sc->csw.dCSWTag)
!= UGETDW(sc->cbw.dCBWTag)) {
printf("%s: Invalid CSW: tag %d should be %d\n",
device_xname(sc->sc_dev),
UGETDW(sc->csw.dCSWTag),
UGETDW(sc->cbw.dCBWTag));

umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;

/* CSW is valid here */
} else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) {
printf("%s: Invalid CSW: status %d > %d\n",
device_xname(sc->sc_dev),
sc->csw.bCSWStatus,
CSWSTATUS_PHASE);

umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;
} else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) {
printf("%s: Phase Error, residue = %d\n",
device_xname(sc->sc_dev), residue);

umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;

} else if (sc->transfer_actlen > sc->transfer_datalen) {
/* Buffer overrun! Don't let this go by unnoticed */
panic("%s: transferred %s %d bytes instead of %d bytes",
device_xname(sc->sc_dev),
sc->transfer_dir == DIR_IN ? "IN" : "OUT",
sc->transfer_actlen, sc->transfer_datalen);
#if 0
} else if (sc->transfer_datalen - sc->transfer_actlen
!= residue) {
DPRINTFM(UDMASS_BBB, "sc %#jx: actlen=%jd != "
"residue=%jd\n", (uintptr_t)sc,
sc->transfer_datalen - sc->transfer_actlen,
residue, 0);

umass_bbb_reset(sc, STATUS_WIRE_FAILED);
return;
#endif
} else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) {
DPRINTFM(UDMASS_BBB, "sc %#jx: Command Failed, "
"res = %jd", (uintptr_t)sc, residue, 0, 0);

/* SCSI command failed but transfer was successful */
umass_transfer_done(sc, residue, STATUS_CMD_FAILED);
return;

} else { /* success */
umass_transfer_done(sc, residue, STATUS_CMD_OK);
return;
}

/***** Bulk Reset *****/
case TSTATE_BBB_RESET1:
if (err)
printf("%s: BBB reset failed, %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));

sc->transfer_state = TSTATE_BBB_RESET2;
umass_clear_endpoint_stall(sc, UMASS_BULKIN,
sc->transfer_xfer[XFER_BBB_RESET2]);

return;
case TSTATE_BBB_RESET2:
if (err) /* should not occur */
printf("%s: BBB bulk-in clear stall failed, %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));
/* no error recovery, otherwise we end up in a loop */

sc->transfer_state = TSTATE_BBB_RESET3;
umass_clear_endpoint_stall(sc, UMASS_BULKOUT,
sc->transfer_xfer[XFER_BBB_RESET3]);

return;
case TSTATE_BBB_RESET3:
if (err) /* should not occur */
printf("%s: BBB bulk-out clear stall failed, %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));
/* no error recovery, otherwise we end up in a loop */

umass_transfer_reset(sc);

return;

/***** Default *****/
default:
panic("%s: Unknown state %d",
device_xname(sc->sc_dev), sc->transfer_state);
}
}

/*
* Command/Bulk/Interrupt (CBI) specific functions
*/

Static int
umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, int flags,
struct usbd_xfer *xfer)
{
KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
"sc->sc_wire == 0x%02x wrong for umass_cbi_adsc\n",
sc->sc_wire);

if ((sc->sc_cmd == UMASS_CPROTO_RBC) &&
(sc->sc_quirks & UMASS_QUIRK_RBC_PAD_TO_12) != 0 && buflen < 12) {
(void)memset(buffer + buflen, 0, 12 - buflen);
buflen = 12;
}

sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
sc->sc_req.bRequest = UR_CBI_ADSC;
USETW(sc->sc_req.wValue, 0);
USETW(sc->sc_req.wIndex, sc->sc_ifaceno);
USETW(sc->sc_req.wLength, buflen);
return umass_setup_ctrl_transfer(sc, &sc->sc_req, buffer,
buflen, flags, xfer);
}

Static void
umass_cbi_reset(struct umass_softc *sc, int status)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
SDT_PROBE2(usb, umass, bbb, reset, sc, status);
int i;
# define SEND_DIAGNOSTIC_CMDLEN 12

KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
"sc->sc_wire == 0x%02x wrong for umass_cbi_reset\n",
sc->sc_wire);

if (sc->sc_dying) {
umass_transfer_done(sc, sc->transfer_datalen, status);
return;
}

/*
* Command Block Reset Protocol
*
* First send a reset request to the device. Then clear
* any possibly stalled bulk endpoints.

* This is done in 3 steps, states:
* TSTATE_CBI_RESET1
* TSTATE_CBI_RESET2
* TSTATE_CBI_RESET3
*
* If the reset doesn't succeed, the device should be port reset.
*/

DPRINTFM(UDMASS_CBI, "sc %#jx: CBI Reset", (uintptr_t)sc, 0, 0, 0);

/* CTASSERT */
KASSERTMSG(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN,
"%s: CBL struct is too small (%zu < %u)\n",
device_xname(sc->sc_dev),
sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN);

sc->transfer_state = TSTATE_CBI_RESET1;
sc->transfer_status = status;

/* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between
* the two the last 10 bytes of the cbl is filled with 0xff (section
* 2.2 of the CBI spec).
*/
sc->cbl[0] = 0x1d; /* Command Block Reset */
sc->cbl[1] = 0x04;
for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++)
sc->cbl[i] = 0xff;

if (umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, 0,
sc->transfer_xfer[XFER_CBI_RESET1]))
umass_transfer_done(sc, sc->transfer_datalen, status);
/* XXX if the command fails we should reset the port on the bub */
}

Static void
umass_cbi_transfer(struct umass_softc *sc, int lun,
void *cmd, int cmdlen, void *data, int datalen, int dir,
u_int timeout, int flags, umass_callback cb, void *priv)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
SDT_PROBE7(usb, umass, transfer, start__cbi,
sc, cb, priv, data, datalen, dir, timeout);

DPRINTFM(UDMASS_CBI, "sc %#jx: cmd=0x%02jx, len=%jd",
(uintptr_t)sc, *(u_char *)cmd, datalen, 0);

KASSERT(cb);
KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
"sc->sc_wire == 0x%02x wrong for umass_cbi_transfer\n",
sc->sc_wire);

if (sc->sc_dying) {
SDT_PROBE7(usb, umass, transfer, done,
sc, cb, priv, data, datalen, datalen, STATUS_WIRE_FAILED);
cb(sc, priv, datalen, STATUS_WIRE_FAILED);
return;
}

/* Be a little generous. */
sc->timeout = timeout + USBD_DEFAULT_TIMEOUT;

/*
* Do a CBI transfer with cmdlen bytes from cmd, possibly
* a data phase of datalen bytes from/to the device and finally a
* csw read phase.
* If the data direction was inbound a maximum of datalen bytes
* is stored in the buffer pointed to by data.
*
* umass_cbi_transfer initialises the transfer and lets the state
* machine in umass_cbi_state handle the completion. It uses the
* following states:
* TSTATE_CBI_COMMAND
* -> XXX fill in
*
* An error in any of those states will invoke
* umass_cbi_reset.
*/

/* check the given arguments */
KASSERTMSG(datalen == 0 || data != NULL,
"%s: datalen > 0, but no buffer",device_xname(sc->sc_dev));
KASSERTMSG(datalen == 0 || dir != DIR_NONE,
"%s: direction is NONE while datalen is not zero\n",
device_xname(sc->sc_dev));

/* store the details for the data transfer phase */
sc->transfer_dir = dir;
sc->transfer_data = data;
sc->transfer_datalen = datalen;
sc->transfer_actlen = 0;
sc->transfer_cb = cb;
sc->transfer_priv = priv;
sc->transfer_status = STATUS_CMD_OK;

/* move from idle to the command state */
sc->transfer_state = TSTATE_CBI_COMMAND;

/* Send the Command Block from host to device via control endpoint. */
if (umass_cbi_adsc(sc, cmd, cmdlen, flags,
sc->transfer_xfer[XFER_CBI_CB]))
umass_cbi_reset(sc, STATUS_WIRE_FAILED);
}

Static void
umass_cbi_state(struct usbd_xfer *xfer, void *priv,
usbd_status err)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
struct umass_softc *sc = (struct umass_softc *) priv;

SDT_PROBE3(usb, umass, bbb, state, sc, xfer, err);

KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
"sc->sc_wire == 0x%02x wrong for umass_cbi_state\n",
sc->sc_wire);

if (err == USBD_CANCELLED) {
DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx cancelled",
(uintptr_t)sc, (uintptr_t)xfer, 0, 0);
umass_transfer_done(sc, 0, STATUS_TIMEOUT);
return;
}

if (sc->sc_dying) {
umass_transfer_done(sc, sc->transfer_datalen,
STATUS_WIRE_FAILED);
return;
}

/*
* State handling for CBI transfers.
*/

DPRINTFM(UDMASS_CBI, "sc %#jx: Handling CBI state %jd, xfer=%#jx, ...",
(uintptr_t)sc, sc->transfer_state, (uintptr_t)xfer, 0);
DPRINTFM(UDMASS_CBI, "... err %jd", err, 0, 0, 0);

switch (sc->transfer_state) {

/***** CBI Transfer *****/
case TSTATE_CBI_COMMAND:
if (err == USBD_STALLED) {
DPRINTFM(UDMASS_CBI, "sc %#jx: Command Transport "
"failed", (uintptr_t)sc, 0, 0, 0);
/* Status transport by control pipe (section 2.3.2.1).
* The command contained in the command block failed.
*
* The control pipe has already been unstalled by the
* USB stack.
* Section 2.4.3.1.1 states that the bulk in endpoints
* should not stalled at this point.
*/
umass_transfer_done(sc, sc->transfer_datalen,
STATUS_CMD_FAILED);
return;
} else if (err) {
DPRINTFM(UDMASS_CBI, "sc %#jx: failed to send ADSC",
(uintptr_t)sc, 0, 0, 0);
umass_cbi_reset(sc, STATUS_WIRE_FAILED);
return;
}

/* Data transport phase, setup transfer */
sc->transfer_state = TSTATE_CBI_DATA;
if (sc->transfer_dir == DIR_IN) {
if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
sc->datain_buffer, sc->transfer_datalen,
USBD_SHORT_XFER_OK,
sc->transfer_xfer[XFER_CBI_DATAIN]))
umass_cbi_reset(sc, STATUS_WIRE_FAILED);

return;
} else if (sc->transfer_dir == DIR_OUT) {
memcpy(sc->dataout_buffer, sc->transfer_data,
sc->transfer_datalen);
if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT],
sc->dataout_buffer, sc->transfer_datalen,
0, /* fixed length transfer */
sc->transfer_xfer[XFER_CBI_DATAOUT]))
umass_cbi_reset(sc, STATUS_WIRE_FAILED);

return;
} else {
DPRINTFM(UDMASS_CBI, "sc %#jx: no data phase",
(uintptr_t)sc, 0, 0, 0);
}

/* if no data phase, err == 0 */
/* FALLTHROUGH */
case TSTATE_CBI_DATA:
/* Command transport phase error handling (ignored if no data
* phase (fallthrough from previous state)) */
if (sc->transfer_dir != DIR_NONE) {
/* retrieve the length of the transfer that was done */
usbd_get_xfer_status(xfer, NULL, NULL,
&sc->transfer_actlen, NULL);
DPRINTFM(UDMASS_CBI, "sc %#jx: CBI_DATA actlen=%jd",
(uintptr_t)sc, sc->transfer_actlen, 0, 0);

if (err) {
DPRINTFM(UDMASS_CBI, "sc %#jx: Data dir %jd "
"err %jd failed",
(uintptr_t)sc, sc->transfer_dir,
sc->transfer_datalen, err);

if (err == USBD_STALLED) {
sc->transfer_state = TSTATE_CBI_DCLEAR;
umass_clear_endpoint_stall(sc,
(sc->transfer_dir == DIR_IN?
UMASS_BULKIN:UMASS_BULKOUT),
sc->transfer_xfer[XFER_CBI_DCLEAR]);
} else {
/* Unless the error is a pipe stall the
* error is fatal.
*/
umass_cbi_reset(sc, STATUS_WIRE_FAILED);
}
return;
}
}

if (sc->transfer_dir == DIR_IN)
memcpy(sc->transfer_data, sc->datain_buffer,
sc->transfer_actlen);

DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN)
umass_dump_buffer(sc, sc->transfer_data,
sc->transfer_actlen, 48));

/* Status phase */
if (sc->sc_wire == UMASS_WPROTO_CBI_I) {
sc->transfer_state = TSTATE_CBI_STATUS;
memset(&sc->sbl, 0, sizeof(sc->sbl));
if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_INTRIN],
&sc->sbl, sizeof(sc->sbl),
0, /* fixed length transfer */
sc->transfer_xfer[XFER_CBI_STATUS]))
umass_cbi_reset(sc, STATUS_WIRE_FAILED);
} else {
/* No command completion interrupt. Request
* sense to get status of command.
*/
umass_transfer_done(sc,
sc->transfer_datalen - sc->transfer_actlen,
STATUS_CMD_UNKNOWN);
}
return;

case TSTATE_CBI_STATUS:
if (err) {
DPRINTFM(UDMASS_CBI, "sc %#jx: Status Transport failed",
(uintptr_t)sc, 0, 0, 0);
/* Status transport by interrupt pipe (section 2.3.2.2).
*/

if (err == USBD_STALLED) {
sc->transfer_state = TSTATE_CBI_SCLEAR;
umass_clear_endpoint_stall(sc, UMASS_INTRIN,
sc->transfer_xfer[XFER_CBI_SCLEAR]);
} else {
umass_cbi_reset(sc, STATUS_WIRE_FAILED);
}
return;
}

/* Dissect the information in the buffer */

{
uint32_t actlen;
usbd_get_xfer_status(xfer,NULL,NULL,&actlen,NULL);
DPRINTFM(UDMASS_CBI, "sc %#jx: CBI_STATUS actlen=%jd",
(uintptr_t)sc, actlen, 0, 0);
if (actlen != 2)
break;
}

if (sc->sc_cmd == UMASS_CPROTO_UFI) {
int status;

/* Section 3.4.3.1.3 specifies that the UFI command
* protocol returns an ASC and ASCQ in the interrupt
* data block.
*/

DPRINTFM(UDMASS_CBI, "sc %#jx: UFI CCI, ASC = 0x%02jx, "
"ASCQ = 0x%02jx", (uintptr_t)sc, sc->sbl.ufi.asc,
sc->sbl.ufi.ascq, 0);

if ((sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) ||
sc->sc_sense)
status = STATUS_CMD_OK;
else
status = STATUS_CMD_FAILED;

/* No autosense, command successful */
umass_transfer_done(sc,
sc->transfer_datalen - sc->transfer_actlen,
status);
} else {
int status;

/* Command Interrupt Data Block */

DPRINTFM(UDMASS_CBI, "sc %#jx: type=0x%02jx, "
"value=0x%02jx", (uintptr_t)sc,
sc->sbl.common.type, sc->sbl.common.value, 0);

if (sc->sbl.common.type == IDB_TYPE_CCI) {
switch (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) {
case IDB_VALUE_PASS:
status = STATUS_CMD_OK;
break;
case IDB_VALUE_FAIL:
case IDB_VALUE_PERSISTENT:
status = STATUS_CMD_FAILED;
break;
case IDB_VALUE_PHASE:
default: /* XXX: gcc */
status = STATUS_WIRE_FAILED;
break;
}

umass_transfer_done(sc,
sc->transfer_datalen - sc->transfer_actlen,
status);
} else {
/* XXX What to do? */
umass_transfer_done(sc, sc->transfer_datalen,
STATUS_WIRE_FAILED);
}
}
return;

case TSTATE_CBI_DCLEAR:
if (err) { /* should not occur */
printf("%s: CBI bulk-%s stall clear failed, %s\n",
device_xname(sc->sc_dev),
(sc->transfer_dir == DIR_IN? "in":"out"),
usbd_errstr(err));
umass_cbi_reset(sc, STATUS_WIRE_FAILED);
} else {
umass_transfer_done(sc,
sc->transfer_datalen, STATUS_CMD_FAILED);
}
return;

case TSTATE_CBI_SCLEAR:
if (err) { /* should not occur */
printf("%s: CBI intr-in stall clear failed, %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));
umass_cbi_reset(sc, STATUS_WIRE_FAILED);
} else {
umass_transfer_done(sc,
sc->transfer_datalen, STATUS_CMD_FAILED);
}
return;

/***** CBI Reset *****/
case TSTATE_CBI_RESET1:
if (err)
printf("%s: CBI reset failed, %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));

sc->transfer_state = TSTATE_CBI_RESET2;
umass_clear_endpoint_stall(sc, UMASS_BULKIN,
sc->transfer_xfer[XFER_CBI_RESET2]);

return;
case TSTATE_CBI_RESET2:
if (err) /* should not occur */
printf("%s: CBI bulk-in stall clear failed, %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));
/* no error recovery, otherwise we end up in a loop */

sc->transfer_state = TSTATE_CBI_RESET3;
umass_clear_endpoint_stall(sc, UMASS_BULKOUT,
sc->transfer_xfer[XFER_CBI_RESET3]);

return;
case TSTATE_CBI_RESET3:
if (err) /* should not occur */
printf("%s: CBI bulk-out stall clear failed, %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));
/* no error recovery, otherwise we end up in a loop */

umass_transfer_reset(sc);
return;

/***** Default *****/
default:
panic("%s: Unknown state %d",
device_xname(sc->sc_dev), sc->transfer_state);
}
}

static usbd_status
umass_bbb_get_max_lun(struct umass_softc *sc, uint8_t *maxlun)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
usb_device_request_t req;
usbd_status err;

*maxlun = 0; /* Default to 0. */

DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun", (uintptr_t)sc, 0, 0, 0);

/* The Get Max Lun command is a class-specific request. */
req.bmRequestType = UT_READ_CLASS_INTERFACE;
req.bRequest = UR_BBB_GET_MAX_LUN;
USETW(req.wValue, 0);
USETW(req.wIndex, sc->sc_ifaceno);
USETW(req.wLength, 1);

err = usbd_do_request_flags(sc->sc_udev, &req, maxlun,
USBD_SHORT_XFER_OK, 0, USBD_DEFAULT_TIMEOUT);
switch (err) {
case USBD_NORMAL_COMPLETION:
DPRINTFM(UDMASS_BBB, "sc %#jx: Max Lun %jd",
(uintptr_t)sc, *maxlun , 0, 0);
break;

case USBD_STALLED:
/*
* Device doesn't support Get Max Lun request.
*/
err = USBD_NORMAL_COMPLETION;
DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun not supported",
(uintptr_t)sc, 0, 0, 0);
break;

case USBD_SHORT_XFER:
/*
* XXX This must mean Get Max Lun is not supported, too!
*/
err = USBD_NORMAL_COMPLETION;
DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun SHORT_XFER",
(uintptr_t)sc, 0, 0, 0);
break;

default:
printf("%s: Get Max Lun failed: %s\n",
device_xname(sc->sc_dev), usbd_errstr(err));
/* XXX Should we port_reset the device? */
break;
}

return err;
}

#ifdef UMASS_DEBUG
Static void
umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
int clen = cbw->bCDBLength;
int dlen = UGETDW(cbw->dCBWDataTransferLength);
uint8_t *c = cbw->CBWCDB;
int tag = UGETDW(cbw->dCBWTag);
int flags = cbw->bCBWFlags;

DPRINTFM(UDMASS_BBB, "sc %#jx: CBW %jd: cmdlen=%jd",
(uintptr_t)sc, tag, clen, 0);
DPRINTFM(UDMASS_BBB, " 0x%02jx%02jx%02jx%02jx...",
c[0], c[1], c[2], c[3]);
DPRINTFM(UDMASS_BBB, " 0x%02jx%02jx%02jx%02jx...",
c[4], c[5], c[6], c[7]);
DPRINTFM(UDMASS_BBB, " 0x%02jx%02jx...", c[8], c[9], 0, 0);
DPRINTFM(UDMASS_BBB, " data = %jd bytes, flags = %jx", dlen, flags, 0,
0);
}

Static void
umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
int sig = UGETDW(csw->dCSWSignature);
int tag = UGETDW(csw->dCSWTag);
int res = UGETDW(csw->dCSWDataResidue);
int status = csw->bCSWStatus;

DPRINTFM(UDMASS_BBB, "sc %#jx: CSW %jd: sig = 0x%08jx, tag = %jd",
(uintptr_t)sc, (uintptr_t)csw, sig, tag);
DPRINTFM(UDMASS_BBB, " res = %jd, status = 0x%02jx",
res, status, 0, 0);
}

Static void
umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, int buflen,
int printlen)
{
UMASSHIST_FUNC(); UMASSHIST_CALLED();
int i;

DPRINTFM(UDMASS_GEN, "sc %#jx: buffer %#jx", (uintptr_t)sc,
(uintptr_t)buffer, 0, 0);
for (i = 0; i < buflen && i < printlen;) {
if (i + 3 < buflen && i + 3 < printlen) {
DPRINTFM(UDMASS_GEN, " 0x%02jx%02jx%02jx%02jx",
buffer[i], buffer[i + 1],
buffer[i + 2], buffer[i + 3]);
i += 4;
} else if (i + 2 < buflen && i + 2 < printlen) {
DPRINTFM(UDMASS_GEN, " 0x%02jx%02jx%02jx",
buffer[i], buffer[i + 1], buffer[i + 2], 0);
i += 3;
} else if (i + 1 < buflen && i + 2 < printlen) {
DPRINTFM(UDMASS_GEN, " 0x%02jx%02jx",
buffer[i], buffer[i + 1], 0, 0);
i += 2;
} else {
DPRINTFM(UDMASS_GEN, " 0x%02jx", buffer[i], 0, 0, 0);
i += 1;
}
}
}
#endif