sys/dev/usb/umass.c

   1 /*-
   2  * Copyright (c) 1999 MAEKAWA Masahide <bishop@rr.iij4u.or.jp>,
   3  *                    Nick Hibma <n_hibma@freebsd.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  *      $FreeBSD$
  28  *      $NetBSD: umass.c,v 1.28 2000/04/02 23:46:53 augustss Exp $
  29  */
  30
  31 /* Also already merged from NetBSD:
  32  *      $NetBSD: umass.c,v 1.67 2001/11/25 19:05:22 augustss Exp $
  33  *      $NetBSD: umass.c,v 1.90 2002/11/04 19:17:33 pooka Exp $
  34  *      $NetBSD: umass.c,v 1.108 2003/11/07 17:03:25 wiz Exp $
  35  *      $NetBSD: umass.c,v 1.109 2003/12/04 13:57:31 keihan Exp $
  36  */
  37
  38 /*
  39  * Universal Serial Bus Mass Storage Class specs:
  40  * http://www.usb.org/developers/devclass_docs/usb_msc_overview_1.2.pdf
  41  * http://www.usb.org/developers/devclass_docs/usbmassbulk_10.pdf
  42  * http://www.usb.org/developers/devclass_docs/usb_msc_cbi_1.1.pdf
  43  * http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf
  44  */
  45
  46 /*
  47  * Ported to NetBSD by Lennart Augustsson <augustss@NetBSD.org>.
  48  * Parts of the code written by Jason R. Thorpe <thorpej@shagadelic.org>.
  49  */
  50
  51 /*
  52  * The driver handles 3 Wire Protocols
  53  * - Command/Bulk/Interrupt (CBI)
  54  * - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI)
  55  * - Mass Storage Bulk-Only (BBB)
  56  *   (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases)
  57  *
  58  * Over these wire protocols it handles the following command protocols
  59  * - SCSI
  60  * - UFI (floppy command set)
  61  * - 8070i (ATAPI)
  62  *
  63  * UFI and 8070i (ATAPI) are transformed versions of the SCSI command set. The
  64  * sc->transform method is used to convert the commands into the appropriate
  65  * format (if at all necessary). For example, UFI requires all commands to be
  66  * 12 bytes in length amongst other things.
  67  *
  68  * The source code below is marked and can be split into a number of pieces
  69  * (in this order):
  70  *
  71  * - probe/attach/detach
  72  * - generic transfer routines
  73  * - BBB
  74  * - CBI
  75  * - CBI_I (in addition to functions from CBI)
  76  * - CAM (Common Access Method)
  77  * - SCSI
  78  * - UFI
  79  * - 8070i (ATAPI)
  80  *
  81  * The protocols are implemented using a state machine, for the transfers as
  82  * well as for the resets. The state machine is contained in umass_*_state.
  83  * The state machine is started through either umass_*_transfer or
  84  * umass_*_reset.
  85  *
  86  * The reason for doing this is a) CAM performs a lot better this way and b) it
  87  * avoids using tsleep from interrupt context (for example after a failed
  88  * transfer).
  89  */
  90
  91 /*
  92  * The SCSI related part of this driver has been derived from the
  93  * dev/ppbus/vpo.c driver, by Nicolas Souchu (nsouch@freebsd.org).
  94  *
  95  * The CAM layer uses so called actions which are messages sent to the host
  96  * adapter for completion. The actions come in through umass_cam_action. The
  97  * appropriate block of routines is called depending on the transport protocol
  98  * in use. When the transfer has finished, these routines call
  99  * umass_cam_cb again to complete the CAM command.
 100  */
 101
 102 /*
 103  * XXX Currently CBI with CCI is not supported because it bombs the system
 104  *     when the device is detached (low frequency interrupts are detached
 105  *     too late.
 106  */
 107 #undef CBI_I
 108
 109 #include <sys/param.h>
 110 #include <sys/systm.h>
 111 #include <sys/kernel.h>
 112 #include <sys/module.h>
 113 #include <sys/lock.h>
 114 #include <sys/mutex.h>
 115 #include <sys/bus.h>
 116 #include <sys/sysctl.h>
 117
 118 #include <dev/usb/usb.h>
 119 #include <dev/usb/usbdi.h>
 120 #include <dev/usb/usbdi_util.h>
 121 #include "usbdevs.h"
 122
 123 #include <cam/cam.h>
 124 #include <cam/cam_ccb.h>
 125 #include <cam/cam_sim.h>
 126 #include <cam/cam_xpt_sim.h>
 127 #include <cam/scsi/scsi_all.h>
 128 #include <cam/scsi/scsi_da.h>
 129
 130 #include <cam/cam_periph.h>
 131
 132 #ifdef USB_DEBUG
 133 #define DIF(m, x)       if (umassdebug & (m)) do { x ; } while (0)
 134 #define DPRINTF(m, x)   if (umassdebug & (m)) printf x
 135 #define UDMASS_GEN      0x00010000      /* general */
 136 #define UDMASS_SCSI     0x00020000      /* scsi */
 137 #define UDMASS_UFI      0x00040000      /* ufi command set */
 138 #define UDMASS_ATAPI    0x00080000      /* 8070i command set */
 139 #define UDMASS_CMD      (UDMASS_SCSI|UDMASS_UFI|UDMASS_ATAPI)
 140 #define UDMASS_USB      0x00100000      /* USB general */
 141 #define UDMASS_BBB      0x00200000      /* Bulk-Only transfers */
 142 #define UDMASS_CBI      0x00400000      /* CBI transfers */
 143 #define UDMASS_WIRE     (UDMASS_BBB|UDMASS_CBI)
 144 #define UDMASS_ALL      0xffff0000      /* all of the above */
 145 int umassdebug = 0;
 146 SYSCTL_NODE(_hw_usb, OID_AUTO, umass, CTLFLAG_RW, 0, "USB umass");
 147 SYSCTL_INT(_hw_usb_umass, OID_AUTO, debug, CTLFLAG_RW,
 148            &umassdebug, 0, "umass debug level");
 149 #else
 150 #define DIF(m, x)       /* nop */
 151 #define DPRINTF(m, x)   /* nop */
 152 #endif
 153
 154
 155 /* Generic definitions */
 156
 157 /* Direction for umass_*_transfer */
 158 #define DIR_NONE        0
 159 #define DIR_IN          1
 160 #define DIR_OUT         2
 161
 162 /* device name */
 163 #define DEVNAME         "umass"
 164 #define DEVNAME_SIM     "umass-sim"
 165
 166 #define UMASS_MAX_TRANSFER_SIZE         65536
 167 /* Approximate maximum transfer speeds (assumes 33% overhead). */
 168 #define UMASS_FULL_TRANSFER_SPEED       1000
 169 #define UMASS_HIGH_TRANSFER_SPEED       40000
 170 #define UMASS_FLOPPY_TRANSFER_SPEED     20
 171
 172 #define UMASS_TIMEOUT                   5000 /* msecs */
 173
 174 /* CAM specific definitions */
 175
 176 #define UMASS_SCSIID_MAX        1       /* maximum number of drives expected */
 177 #define UMASS_SCSIID_HOST       UMASS_SCSIID_MAX
 178
 179 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
 180
 181
 182 /* Bulk-Only features */
 183
 184 #define UR_BBB_RESET            0xff            /* Bulk-Only reset */
 185 #define UR_BBB_GET_MAX_LUN      0xfe            /* Get maximum lun */
 186
 187 /* Command Block Wrapper */
 188 typedef struct {
 189         uDWord          dCBWSignature;
 190 #       define CBWSIGNATURE     0x43425355
 191         uDWord          dCBWTag;
 192         uDWord          dCBWDataTransferLength;
 193         uByte           bCBWFlags;
 194 #       define CBWFLAGS_OUT     0x00
 195 #       define CBWFLAGS_IN      0x80
 196         uByte           bCBWLUN;
 197         uByte           bCDBLength;
 198 #       define CBWCDBLENGTH     16
 199         uByte           CBWCDB[CBWCDBLENGTH];
 200 } umass_bbb_cbw_t;
 201 #define UMASS_BBB_CBW_SIZE      31
 202
 203 /* Command Status Wrapper */
 204 typedef struct {
 205         uDWord          dCSWSignature;
 206 #       define CSWSIGNATURE     0x53425355
 207 #       define CSWSIGNATURE_IMAGINATION_DBX1    0x43425355
 208 #       define CSWSIGNATURE_OLYMPUS_C1  0x55425355
 209         uDWord          dCSWTag;
 210         uDWord          dCSWDataResidue;
 211         uByte           bCSWStatus;
 212 #       define CSWSTATUS_GOOD   0x0
 213 #       define CSWSTATUS_FAILED 0x1
 214 #       define CSWSTATUS_PHASE  0x2
 215 } umass_bbb_csw_t;
 216 #define UMASS_BBB_CSW_SIZE      13
 217
 218 /* CBI features */
 219
 220 #define UR_CBI_ADSC     0x00
 221
 222 typedef unsigned char umass_cbi_cbl_t[16];      /* Command block */
 223
 224 typedef union {
 225         struct {
 226                 unsigned char   type;
 227                 #define IDB_TYPE_CCI            0x00
 228                 unsigned char   value;
 229                 #define IDB_VALUE_PASS          0x00
 230                 #define IDB_VALUE_FAIL          0x01
 231                 #define IDB_VALUE_PHASE         0x02
 232                 #define IDB_VALUE_PERSISTENT    0x03
 233                 #define IDB_VALUE_STATUS_MASK   0x03
 234         } common;
 235
 236         struct {
 237                 unsigned char   asc;
 238                 unsigned char   ascq;
 239         } ufi;
 240 } umass_cbi_sbl_t;
 241
 242
 243
 244 struct umass_softc;             /* see below */
 245
 246 typedef void (*transfer_cb_f)   (struct umass_softc *sc, void *priv,
 247                                 int residue, int status);
 248 #define STATUS_CMD_OK           0       /* everything ok */
 249 #define STATUS_CMD_UNKNOWN      1       /* will have to fetch sense */
 250 #define STATUS_CMD_FAILED       2       /* transfer was ok, command failed */
 251 #define STATUS_WIRE_FAILED      3       /* couldn't even get command across */
 252
 253 typedef void (*wire_reset_f)    (struct umass_softc *sc, int status);
 254 typedef void (*wire_transfer_f) (struct umass_softc *sc, int lun,
 255                                 void *cmd, int cmdlen, void *data, int datalen,
 256                                 int dir, u_int timeout, transfer_cb_f cb, void *priv);
 257 typedef void (*wire_state_f)    (usbd_xfer_handle xfer,
 258                                 usbd_private_handle priv, usbd_status err);
 259
 260 typedef int (*command_transform_f)      (struct umass_softc *sc,
 261                                 unsigned char *cmd, int cmdlen,
 262                                 unsigned char **rcmd, int *rcmdlen);
 263
 264
 265 struct umass_devdescr_t {
 266         u_int32_t       vid;
 267 #       define VID_WILDCARD     0xffffffff
 268 #       define VID_EOT          0xfffffffe
 269         u_int32_t       pid;
 270 #       define PID_WILDCARD     0xffffffff
 271 #       define PID_EOT          0xfffffffe
 272         u_int32_t       rid;
 273 #       define RID_WILDCARD     0xffffffff
 274 #       define RID_EOT          0xfffffffe
 275
 276         /* wire and command protocol */
 277         u_int16_t       proto;
 278 #       define UMASS_PROTO_BBB          0x0001  /* USB wire protocol */
 279 #       define UMASS_PROTO_CBI          0x0002
 280 #       define UMASS_PROTO_CBI_I        0x0004
 281 #       define UMASS_PROTO_WIRE         0x00ff  /* USB wire protocol mask */
 282 #       define UMASS_PROTO_SCSI         0x0100  /* command protocol */
 283 #       define UMASS_PROTO_ATAPI        0x0200
 284 #       define UMASS_PROTO_UFI          0x0400
 285 #       define UMASS_PROTO_RBC          0x0800
 286 #       define UMASS_PROTO_COMMAND      0xff00  /* command protocol mask */
 287
 288         /* Device specific quirks */
 289         u_int16_t       quirks;
 290 #       define NO_QUIRKS                0x0000
 291         /* The drive does not support Test Unit Ready. Convert to Start Unit
 292          */
 293 #       define NO_TEST_UNIT_READY       0x0001
 294         /* The drive does not reset the Unit Attention state after REQUEST
 295          * SENSE has been sent. The INQUIRY command does not reset the UA
 296          * either, and so CAM runs in circles trying to retrieve the initial
 297          * INQUIRY data.
 298          */
 299 #       define RS_NO_CLEAR_UA           0x0002
 300         /* The drive does not support START STOP.  */
 301 #       define NO_START_STOP            0x0004
 302         /* Don't ask for full inquiry data (255b).  */
 303 #       define FORCE_SHORT_INQUIRY      0x0008
 304         /* Needs to be initialised the Shuttle way */
 305 #       define SHUTTLE_INIT             0x0010
 306         /* Drive needs to be switched to alternate iface 1 */
 307 #       define ALT_IFACE_1              0x0020
 308         /* Drive does not do 1Mb/s, but just floppy speeds (20kb/s) */
 309 #       define FLOPPY_SPEED             0x0040
 310         /* The device can't count and gets the residue of transfers wrong */
 311 #       define IGNORE_RESIDUE           0x0080
 312         /* No GetMaxLun call */
 313 #       define NO_GETMAXLUN             0x0100
 314         /* The device uses a weird CSWSIGNATURE. */
 315 #       define WRONG_CSWSIG             0x0200
 316         /* Device cannot handle INQUIRY so fake a generic response */
 317 #       define NO_INQUIRY               0x0400
 318         /* Device cannot handle INQUIRY EVPD, return CHECK CONDITION */
 319 #       define NO_INQUIRY_EVPD          0x0800
 320         /* Pad all RBC requests to 12 bytes. */
 321 #       define RBC_PAD_TO_12            0x1000
 322         /* Device reports number of sectors from READ_CAPACITY, not max
 323          * sector number.
 324          */
 325 #       define READ_CAPACITY_OFFBY1     0x2000
 326         /* Device cannot handle a SCSI synchronize cache command.  Normally
 327          * this quirk would be handled in the cam layer, but for IDE bridges
 328          * we need to associate the quirk with the bridge and not the
 329          * underlying disk device.  This is handled by faking a success result.
 330          */
 331 #       define NO_SYNCHRONIZE_CACHE     0x4000
 332 };
 333
 334 static struct umass_devdescr_t umass_devdescrs[] = {
 335         { USB_VENDOR_ADDONICS2, USB_PRODUCT_ADDONICS2_CABLE_205, RID_WILDCARD,
 336           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 337           NO_QUIRKS
 338         },
 339         { USB_VENDOR_AIPTEK, USB_PRODUCT_AIPTEK_POCKETCAM3M, RID_WILDCARD,
 340           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 341           NO_QUIRKS
 342         },
 343         { USB_VENDOR_ALCOR, USB_PRODUCT_ALCOR_UMCR_9361, RID_WILDCARD,
 344           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 345           NO_GETMAXLUN
 346         },
 347         { USB_VENDOR_ASAHIOPTICAL, USB_PRODUCT_ASAHIOPTICAL_OPTIO230, RID_WILDCARD,
 348           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 349           NO_INQUIRY
 350         },
 351         { USB_VENDOR_ASAHIOPTICAL, USB_PRODUCT_ASAHIOPTICAL_OPTIO330, RID_WILDCARD,
 352           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 353           NO_INQUIRY
 354         },
 355         { USB_VENDOR_ASAHIOPTICAL, PID_WILDCARD, RID_WILDCARD,
 356           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 357           RS_NO_CLEAR_UA
 358         },
 359         { USB_VENDOR_ADDON, USB_PRODUCT_ADDON_ATTACHE, RID_WILDCARD,
 360           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 361           IGNORE_RESIDUE
 362         },
 363         { USB_VENDOR_ADDON, USB_PRODUCT_ADDON_A256MB, RID_WILDCARD,
 364           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 365           IGNORE_RESIDUE
 366         },
 367         { USB_VENDOR_ADDON, USB_PRODUCT_ADDON_DISKPRO512, RID_WILDCARD,
 368           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 369           IGNORE_RESIDUE
 370         },
 371         { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_USB2SCSI, RID_WILDCARD,
 372           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 373           NO_QUIRKS
 374         },
 375         { USB_VENDOR_CASIO, USB_PRODUCT_CASIO_QV_DIGICAM, RID_WILDCARD,
 376           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 377           NO_INQUIRY
 378         },
 379         { USB_VENDOR_CCYU, USB_PRODUCT_CCYU_ED1064, RID_WILDCARD,
 380           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 381           NO_QUIRKS
 382         },
 383         { USB_VENDOR_CENTURY, USB_PRODUCT_CENTURY_EX35QUAT, RID_WILDCARD,
 384           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 385           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 386         },
 387         { USB_VENDOR_DESKNOTE, USB_PRODUCT_DESKNOTE_UCR_61S2B, RID_WILDCARD,
 388           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 389           NO_QUIRKS
 390         },
 391         { USB_VENDOR_DMI, USB_PRODUCT_DMI_CFSM_RW, RID_WILDCARD,
 392           UMASS_PROTO_SCSI,
 393           NO_GETMAXLUN
 394         },
 395         { USB_VENDOR_EPSON, USB_PRODUCT_EPSON_STYLUS_875DC, RID_WILDCARD,
 396           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 397           NO_INQUIRY
 398         },
 399         { USB_VENDOR_EPSON, USB_PRODUCT_EPSON_STYLUS_895, RID_WILDCARD,
 400           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 401           NO_GETMAXLUN
 402         },
 403         { USB_VENDOR_FEIYA, USB_PRODUCT_FEIYA_5IN1, RID_WILDCARD,
 404           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 405           NO_QUIRKS
 406         },
 407         { USB_VENDOR_FREECOM, USB_PRODUCT_FREECOM_DVD, RID_WILDCARD,
 408           UMASS_PROTO_SCSI,
 409           NO_QUIRKS
 410         },
 411         { USB_VENDOR_FUJIPHOTO, USB_PRODUCT_FUJIPHOTO_MASS0100, RID_WILDCARD,
 412           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 413           RS_NO_CLEAR_UA
 414         },
 415         { USB_VENDOR_GENESYS,  USB_PRODUCT_GENESYS_GL641USB2IDE, RID_WILDCARD,
 416           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 417           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 418         },
 419         { USB_VENDOR_GENESYS,  USB_PRODUCT_GENESYS_GL641USB2IDE_2, RID_WILDCARD,
 420           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 421           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 422         },
 423         { USB_VENDOR_GENESYS,  USB_PRODUCT_GENESYS_GL641USB, RID_WILDCARD,
 424           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 425           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 426         },
 427         { USB_VENDOR_GENESYS,  USB_PRODUCT_GENESYS_GL641USB_2, RID_WILDCARD,
 428           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 429           WRONG_CSWSIG
 430         },
 431         { USB_VENDOR_HAGIWARA, USB_PRODUCT_HAGIWARA_FG, RID_WILDCARD,
 432           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 433           NO_QUIRKS
 434         },
 435         { USB_VENDOR_HAGIWARA, USB_PRODUCT_HAGIWARA_FGSM, RID_WILDCARD,
 436           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 437           NO_QUIRKS
 438         },
 439         { USB_VENDOR_HITACHI, USB_PRODUCT_HITACHI_DVDCAM_USB, RID_WILDCARD,
 440           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 441           NO_INQUIRY
 442         },
 443         { USB_VENDOR_HITACHI, USB_PRODUCT_HITACHI_DVDCAM_DZ_MV100A, RID_WILDCARD,
 444           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 445           NO_GETMAXLUN
 446         },
 447         { USB_VENDOR_HP, USB_PRODUCT_HP_CDW4E, RID_WILDCARD,
 448           UMASS_PROTO_ATAPI,
 449           NO_QUIRKS
 450         },
 451         { USB_VENDOR_HP, USB_PRODUCT_HP_CDW8200, RID_WILDCARD,
 452           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 453           NO_TEST_UNIT_READY | NO_START_STOP
 454         },
 455         { USB_VENDOR_IMAGINATION, USB_PRODUCT_IMAGINATION_DBX1, RID_WILDCARD,
 456           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 457           WRONG_CSWSIG
 458         },
 459         { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ATAPI, RID_WILDCARD,
 460           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 461           NO_QUIRKS
 462         },
 463         { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_STORAGE_V2, RID_WILDCARD,
 464           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 465           NO_QUIRKS
 466         },
 467         { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE, RID_WILDCARD,
 468           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 469           NO_TEST_UNIT_READY | NO_START_STOP | ALT_IFACE_1
 470         },
 471         { USB_VENDOR_IODATA, USB_PRODUCT_IODATA_IU_CD2, RID_WILDCARD,
 472           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 473           NO_QUIRKS
 474         },
 475         { USB_VENDOR_IODATA, USB_PRODUCT_IODATA_DVR_UEH8, RID_WILDCARD,
 476           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 477           NO_QUIRKS
 478         },
 479         { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP100, RID_WILDCARD,
 480           /* XXX This is not correct as there are Zip drives that use ATAPI.
 481            */
 482           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 483           NO_TEST_UNIT_READY
 484         },
 485         { USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_L3, RID_WILDCARD,
 486           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 487           NO_INQUIRY
 488         },
 489         { USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_S3X, RID_WILDCARD,
 490           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 491           NO_INQUIRY
 492         },
 493         { USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_S4, RID_WILDCARD,
 494           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 495           NO_INQUIRY
 496         },
 497         { USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_S5, RID_WILDCARD,
 498           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 499           NO_INQUIRY
 500         },
 501         { USB_VENDOR_LACIE, USB_PRODUCT_LACIE_HD, RID_WILDCARD,
 502           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 503           NO_QUIRKS
 504         },
 505         { USB_VENDOR_LEXAR, USB_PRODUCT_LEXAR_CF_READER, RID_WILDCARD,
 506           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 507           NO_INQUIRY
 508         },
 509         { USB_VENDOR_LEXAR, USB_PRODUCT_LEXAR_JUMPSHOT, RID_WILDCARD,
 510           UMASS_PROTO_SCSI,
 511           NO_QUIRKS
 512         },
 513         { USB_VENDOR_LOGITEC, USB_PRODUCT_LOGITEC_LDR_H443SU2, RID_WILDCARD,
 514           UMASS_PROTO_SCSI,
 515           NO_QUIRKS
 516         },
 517         { USB_VENDOR_LOGITEC, USB_PRODUCT_LOGITEC_LDR_H443U2, RID_WILDCARD,
 518           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 519           NO_QUIRKS
 520         },
 521         { USB_VENDOR_MELCO,  USB_PRODUCT_MELCO_DUBPXXG, RID_WILDCARD,
 522           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 523           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 524         },
 525         { USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_DPCM, RID_WILDCARD,
 526           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 527           NO_TEST_UNIT_READY | NO_START_STOP
 528         },
 529         { USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_SCSIDB25, RID_WILDCARD,
 530           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 531           NO_QUIRKS
 532         },
 533         { USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_SCSIHD50, RID_WILDCARD,
 534           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 535           NO_QUIRKS
 536         },
 537         { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_E223, RID_WILDCARD,
 538           UMASS_PROTO_SCSI,
 539           NO_QUIRKS
 540         },
 541         { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_F300, RID_WILDCARD,
 542           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 543           NO_QUIRKS
 544         },
 545         { USB_VENDOR_MITSUMI, USB_PRODUCT_MITSUMI_CDRRW, RID_WILDCARD,
 546           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 547           NO_QUIRKS
 548         },
 549         { USB_VENDOR_MITSUMI, USB_PRODUCT_MITSUMI_FDD, RID_WILDCARD,
 550           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 551           NO_GETMAXLUN
 552         },
 553         { USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_E398, RID_WILDCARD,
 554           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 555           FORCE_SHORT_INQUIRY | NO_INQUIRY_EVPD | NO_GETMAXLUN
 556         },
 557         { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY, RID_WILDCARD,
 558           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 559           IGNORE_RESIDUE | NO_GETMAXLUN | RS_NO_CLEAR_UA
 560         },
 561         { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY2, RID_WILDCARD,
 562           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 563           NO_QUIRKS
 564         },
 565         { USB_VENDOR_MYSON,  USB_PRODUCT_MYSON_HEDEN, RID_WILDCARD,
 566           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 567           NO_INQUIRY | IGNORE_RESIDUE
 568         },
 569         { USB_VENDOR_NEODIO, USB_PRODUCT_NEODIO_ND3260, RID_WILDCARD,
 570           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 571           FORCE_SHORT_INQUIRY
 572         },
 573         { USB_VENDOR_NETAC, USB_PRODUCT_NETAC_CF_CARD, RID_WILDCARD,
 574           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 575           NO_INQUIRY
 576         },
 577         { USB_VENDOR_NETAC, USB_PRODUCT_NETAC_ONLYDISK, RID_WILDCARD,
 578           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 579           IGNORE_RESIDUE
 580         },
 581         { USB_VENDOR_NETCHIP, USB_PRODUCT_NETCHIP_CLIK_40, RID_WILDCARD,
 582           UMASS_PROTO_ATAPI,
 583           NO_INQUIRY
 584         },
 585         { USB_VENDOR_NIKON, USB_PRODUCT_NIKON_D300, RID_WILDCARD,
 586           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 587           NO_QUIRKS
 588         },
 589         { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1, RID_WILDCARD,
 590           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 591           WRONG_CSWSIG
 592         },
 593         { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C700, RID_WILDCARD,
 594           UMASS_PROTO_SCSI,
 595           NO_GETMAXLUN
 596         },
 597         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFMS_RW, RID_WILDCARD,
 598           UMASS_PROTO_SCSI,
 599           NO_QUIRKS
 600         },
 601         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFSM_COMBO, RID_WILDCARD,
 602           UMASS_PROTO_SCSI,
 603           NO_QUIRKS
 604         },
 605         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFSM_READER, RID_WILDCARD,
 606           UMASS_PROTO_SCSI,
 607           NO_QUIRKS
 608         },
 609         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFSM_READER2, RID_WILDCARD,
 610           UMASS_PROTO_SCSI,
 611           NO_QUIRKS
 612         },
 613         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_SDS_HOTFIND_D, RID_WILDCARD,
 614           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 615           NO_GETMAXLUN | NO_SYNCHRONIZE_CACHE
 616         },
 617         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MDCFE_B_CF_READER, RID_WILDCARD,
 618           UMASS_PROTO_SCSI,
 619           NO_QUIRKS
 620         },
 621         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MDSM_B_READER, RID_WILDCARD,
 622           UMASS_PROTO_SCSI,
 623           NO_INQUIRY
 624         },
 625         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_READER, RID_WILDCARD,
 626           UMASS_PROTO_SCSI,
 627           NO_QUIRKS
 628         },
 629         { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_UCF100, RID_WILDCARD,
 630           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 631           NO_INQUIRY | NO_GETMAXLUN
 632         },
 633         { USB_VENDOR_ONSPEC2, USB_PRODUCT_ONSPEC2_IMAGEMATE_SDDR55, RID_WILDCARD,
 634           UMASS_PROTO_SCSI,
 635           NO_GETMAXLUN
 636         },
 637         { USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXL840AN, RID_WILDCARD,
 638           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 639           NO_GETMAXLUN
 640         },
 641         { USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXLCB20AN, RID_WILDCARD,
 642           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 643           NO_QUIRKS
 644         },
 645         { USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXLCB35AN, RID_WILDCARD,
 646           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 647           NO_QUIRKS
 648         },
 649         { USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_LS120CAM, RID_WILDCARD,
 650           UMASS_PROTO_UFI,
 651           NO_QUIRKS
 652         },
 653         { USB_VENDOR_PLEXTOR, USB_PRODUCT_PLEXTOR_40_12_40U, RID_WILDCARD,
 654           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 655           NO_TEST_UNIT_READY
 656         },
 657         { USB_VENDOR_PNY, USB_PRODUCT_PNY_ATTACHE2, RID_WILDCARD,
 658           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 659           IGNORE_RESIDUE | NO_START_STOP
 660         },
 661         { USB_VENDOR_SAMSUNG,  USB_PRODUCT_SAMSUNG_YP_U2, RID_WILDCARD,
 662           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 663           SHUTTLE_INIT | NO_GETMAXLUN
 664         },
 665         { USB_VENDOR_SAMSUNG_TECHWIN, USB_PRODUCT_SAMSUNG_TECHWIN_DIGIMAX_410, RID_WILDCARD,
 666           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 667           NO_INQUIRY
 668         },
 669         { USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR05A, RID_WILDCARD,
 670           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 671           READ_CAPACITY_OFFBY1 | NO_GETMAXLUN
 672         },
 673         { USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR09, RID_WILDCARD,
 674           UMASS_PROTO_SCSI,
 675           READ_CAPACITY_OFFBY1 | NO_GETMAXLUN
 676         },
 677         { USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR12, RID_WILDCARD,
 678           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 679           READ_CAPACITY_OFFBY1 | NO_GETMAXLUN
 680         },
 681         { USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR31, RID_WILDCARD,
 682           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 683           READ_CAPACITY_OFFBY1
 684         },
 685         { USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDCZ2_256, RID_WILDCARD,
 686           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 687           IGNORE_RESIDUE
 688         },
 689         { USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDCZ4_128, RID_WILDCARD,
 690           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 691           IGNORE_RESIDUE
 692         },
 693         { USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDCZ4_256, RID_WILDCARD,
 694           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 695           IGNORE_RESIDUE
 696         },
 697         { USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R, RID_WILDCARD,
 698           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 699           NO_INQUIRY
 700         },
 701         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_CDRW, RID_WILDCARD,
 702           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 703           NO_QUIRKS
 704         },
 705         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_CF, RID_WILDCARD,
 706           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 707           NO_QUIRKS
 708         },
 709         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB, RID_WILDCARD,
 710           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 711           NO_TEST_UNIT_READY | NO_START_STOP | SHUTTLE_INIT
 712         },
 713         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSBATAPI, RID_WILDCARD,
 714           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 715           NO_QUIRKS
 716         },
 717         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSBCFSM, RID_WILDCARD,
 718           UMASS_PROTO_SCSI,
 719           NO_QUIRKS
 720         },
 721         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSCSI, RID_WILDCARD,
 722           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 723           NO_QUIRKS
 724         },
 725         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_HIFD, RID_WILDCARD,
 726           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 727           NO_GETMAXLUN
 728         },
 729         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_SDDR09, RID_WILDCARD,
 730           UMASS_PROTO_SCSI,
 731           NO_GETMAXLUN
 732         },
 733         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_ZIOMMC, RID_WILDCARD,
 734           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 735           NO_GETMAXLUN
 736         },
 737         { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_I_BEAD100, RID_WILDCARD,
 738           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 739           SHUTTLE_INIT
 740         },
 741         { USB_VENDOR_SIIG, USB_PRODUCT_SIIG_WINTERREADER, RID_WILDCARD,
 742           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 743           IGNORE_RESIDUE
 744         },
 745         { USB_VENDOR_SKANHEX, USB_PRODUCT_SKANHEX_MD_7425, RID_WILDCARD,
 746           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 747           NO_INQUIRY
 748         },
 749         { USB_VENDOR_SKANHEX, USB_PRODUCT_SKANHEX_SX_520Z, RID_WILDCARD,
 750           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 751           NO_INQUIRY
 752         },
 753         { USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_40_MS, RID_WILDCARD,
 754           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 755           NO_INQUIRY
 756         },
 757         { USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC, 0x0500,
 758           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 759           RBC_PAD_TO_12
 760         },
 761         { USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC, 0x0600,
 762           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 763           RBC_PAD_TO_12
 764         },
 765         { USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC, RID_WILDCARD,
 766           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 767           NO_QUIRKS
 768         },
 769         { USB_VENDOR_SONY, USB_PRODUCT_SONY_HANDYCAM, 0x0500,
 770           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 771           RBC_PAD_TO_12
 772         },
 773         { USB_VENDOR_SONY, USB_PRODUCT_SONY_HANDYCAM, RID_WILDCARD,
 774           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 775           NO_QUIRKS
 776         },
 777         { USB_VENDOR_SONY, USB_PRODUCT_SONY_MS_MSC_U03, RID_WILDCARD,
 778           UMASS_PROTO_UFI | UMASS_PROTO_CBI,
 779           NO_GETMAXLUN
 780         },
 781         { USB_VENDOR_SONY, USB_PRODUCT_SONY_MS_NW_MS7, RID_WILDCARD,
 782           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 783           NO_GETMAXLUN
 784         },
 785         { USB_VENDOR_SONY, USB_PRODUCT_SONY_MS_PEG_N760C, RID_WILDCARD,
 786           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 787           NO_INQUIRY
 788         },
 789         { USB_VENDOR_SONY, USB_PRODUCT_SONY_MSACUS1, RID_WILDCARD,
 790           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 791           NO_GETMAXLUN
 792         },
 793         { USB_VENDOR_SONY, USB_PRODUCT_SONY_MSC, RID_WILDCARD,
 794           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 795           NO_QUIRKS
 796         },
 797         { USB_VENDOR_SONY, USB_PRODUCT_SONY_PORTABLE_HDD_V2, RID_WILDCARD,
 798           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 799           NO_QUIRKS
 800         },
 801         { USB_VENDOR_TAUGA, USB_PRODUCT_TAUGA_CAMERAMATE, RID_WILDCARD,
 802           UMASS_PROTO_SCSI,
 803           NO_QUIRKS
 804         },
 805         { USB_VENDOR_TEAC, USB_PRODUCT_TEAC_FD05PUB, RID_WILDCARD,
 806           UMASS_PROTO_UFI | UMASS_PROTO_CBI,
 807           NO_QUIRKS
 808         },
 809         { USB_VENDOR_TREK, USB_PRODUCT_TREK_MEMKEY, RID_WILDCARD,
 810           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 811           NO_INQUIRY
 812         },
 813         { USB_VENDOR_TREK, USB_PRODUCT_TREK_THUMBDRIVE_8MB, RID_WILDCARD,
 814           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 815           IGNORE_RESIDUE
 816         },
 817         { USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_C3310, RID_WILDCARD,
 818           UMASS_PROTO_UFI | UMASS_PROTO_CBI,
 819           NO_QUIRKS
 820         },
 821         { USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_MP3, RID_WILDCARD,
 822           UMASS_PROTO_RBC,
 823           NO_QUIRKS
 824         },
 825         { USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_T33520, RID_WILDCARD,
 826           UMASS_PROTO_SCSI,
 827           NO_QUIRKS
 828         },
 829         { USB_VENDOR_TWINMOS, USB_PRODUCT_TWINMOS_MDIV, RID_WILDCARD,
 830           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 831           NO_QUIRKS
 832         },
 833         { USB_VENDOR_VIA, USB_PRODUCT_VIA_USB2IDEBRIDGE, RID_WILDCARD,
 834           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 835           NO_SYNCHRONIZE_CACHE
 836         },
 837         { USB_VENDOR_VIVITAR, USB_PRODUCT_VIVITAR_35XX, RID_WILDCARD,
 838           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 839           NO_INQUIRY
 840         },
 841         { USB_VENDOR_WESTERN,  USB_PRODUCT_WESTERN_COMBO, RID_WILDCARD,
 842           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 843           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 844         },
 845         { USB_VENDOR_WESTERN,  USB_PRODUCT_WESTERN_EXTHDD, RID_WILDCARD,
 846           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 847           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 848         },
 849         { USB_VENDOR_WESTERN,  USB_PRODUCT_WESTERN_MYBOOK, RID_WILDCARD,
 850           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 851           NO_INQUIRY_EVPD
 852         },
 853         { USB_VENDOR_WINMAXGROUP, USB_PRODUCT_WINMAXGROUP_FLASH64MC, RID_WILDCARD,
 854           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 855           NO_INQUIRY
 856         },
 857         { USB_VENDOR_YANO,  USB_PRODUCT_YANO_FW800HD, RID_WILDCARD,
 858           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 859           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 860         },
 861         { USB_VENDOR_YANO,  USB_PRODUCT_YANO_U640MO, RID_WILDCARD,
 862           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 863           FORCE_SHORT_INQUIRY
 864         },
 865         { USB_VENDOR_YEDATA, USB_PRODUCT_YEDATA_FLASHBUSTERU, RID_WILDCARD,
 866           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 867           NO_GETMAXLUN
 868         },
 869         { USB_VENDOR_ZORAN, USB_PRODUCT_ZORAN_EX20DSC, RID_WILDCARD,
 870           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 871           NO_QUIRKS
 872         },
 873         { VID_EOT, PID_EOT, RID_EOT, 0, 0 }
 874 };
 875
 876
 877 /* the per device structure */
 878 struct umass_softc {
 879         device_t                sc_dev;         /* base device */
 880         usbd_device_handle      sc_udev;        /* USB device */
 881
 882         struct cam_sim          *umass_sim;     /* SCSI Interface Module */
 883
 884         unsigned char           flags;          /* various device flags */
 885 #       define UMASS_FLAGS_GONE         0x01    /* devices is no more */
 886
 887         u_int16_t               proto;          /* wire and cmd protocol */
 888         u_int16_t               quirks;         /* they got it almost right */
 889
 890         usbd_interface_handle   iface;          /* Mass Storage interface */
 891         int                     ifaceno;        /* MS iface number */
 892
 893         u_int8_t                bulkin;         /* bulk-in Endpoint Address */
 894         u_int8_t                bulkout;        /* bulk-out Endpoint Address */
 895         u_int8_t                intrin;         /* intr-in Endp. (CBI) */
 896         usbd_pipe_handle        bulkin_pipe;
 897         usbd_pipe_handle        bulkout_pipe;
 898         usbd_pipe_handle        intrin_pipe;
 899
 900         /* Reset the device in a wire protocol specific way */
 901         wire_reset_f            reset;
 902
 903         /* The start of a wire transfer. It prepares the whole transfer (cmd,
 904          * data, and status stage) and initiates it. It is up to the state
 905          * machine (below) to handle the various stages and errors in these
 906          */
 907         wire_transfer_f         transfer;
 908
 909         /* The state machine, handling the various states during a transfer */
 910         wire_state_f            state;
 911
 912         /* The command transform function is used to conver the SCSI commands
 913          * into their derivatives, like UFI, ATAPI, and friends.
 914          */
 915         command_transform_f     transform;      /* command transform */
 916
 917         /* Bulk specific variables for transfers in progress */
 918         umass_bbb_cbw_t         cbw;    /* command block wrapper */
 919         umass_bbb_csw_t         csw;    /* command status wrapper*/
 920         /* CBI specific variables for transfers in progress */
 921         umass_cbi_cbl_t         cbl;    /* command block */
 922         umass_cbi_sbl_t         sbl;    /* status block */
 923
 924         /* generic variables for transfers in progress */
 925         /* ctrl transfer requests */
 926         usb_device_request_t    request;
 927
 928         /* xfer handles
 929          * Most of our operations are initiated from interrupt context, so
 930          * we need to avoid using the one that is in use. We want to avoid
 931          * allocating them in the interrupt context as well.
 932          */
 933         /* indices into array below */
 934 #       define XFER_BBB_CBW             0       /* Bulk-Only */
 935 #       define XFER_BBB_DATA            1
 936 #       define XFER_BBB_DCLEAR          2
 937 #       define XFER_BBB_CSW1            3
 938 #       define XFER_BBB_CSW2            4
 939 #       define XFER_BBB_SCLEAR          5
 940 #       define XFER_BBB_RESET1          6
 941 #       define XFER_BBB_RESET2          7
 942 #       define XFER_BBB_RESET3          8
 943
 944 #       define XFER_CBI_CB              0       /* CBI */
 945 #       define XFER_CBI_DATA            1
 946 #       define XFER_CBI_STATUS          2
 947 #       define XFER_CBI_DCLEAR          3
 948 #       define XFER_CBI_SCLEAR          4
 949 #       define XFER_CBI_RESET1          5
 950 #       define XFER_CBI_RESET2          6
 951 #       define XFER_CBI_RESET3          7
 952
 953 #       define XFER_NR                  9       /* maximum number */
 954
 955         usbd_xfer_handle        transfer_xfer[XFER_NR]; /* for ctrl xfers */
 956
 957         int                     transfer_dir;           /* data direction */
 958         void                    *transfer_data;         /* data buffer */
 959         int                     transfer_datalen;       /* (maximum) length */
 960         int                     transfer_actlen;        /* actual length */
 961         transfer_cb_f           transfer_cb;            /* callback */
 962         void                    *transfer_priv;         /* for callback */
 963         int                     transfer_status;
 964
 965         int                     transfer_state;
 966 #       define TSTATE_ATTACH                    0       /* in attach */
 967 #       define TSTATE_IDLE                      1
 968 #       define TSTATE_BBB_COMMAND               2       /* CBW transfer */
 969 #       define TSTATE_BBB_DATA                  3       /* Data transfer */
 970 #       define TSTATE_BBB_DCLEAR                4       /* clear endpt stall */
 971 #       define TSTATE_BBB_STATUS1               5       /* clear endpt stall */
 972 #       define TSTATE_BBB_SCLEAR                6       /* clear endpt stall */
 973 #       define TSTATE_BBB_STATUS2               7       /* CSW transfer */
 974 #       define TSTATE_BBB_RESET1                8       /* reset command */
 975 #       define TSTATE_BBB_RESET2                9       /* in clear stall */
 976 #       define TSTATE_BBB_RESET3                10      /* out clear stall */
 977 #       define TSTATE_CBI_COMMAND               11      /* command transfer */
 978 #       define TSTATE_CBI_DATA                  12      /* data transfer */
 979 #       define TSTATE_CBI_STATUS                13      /* status transfer */
 980 #       define TSTATE_CBI_DCLEAR                14      /* clear ep stall */
 981 #       define TSTATE_CBI_SCLEAR                15      /* clear ep stall */
 982 #       define TSTATE_CBI_RESET1                16      /* reset command */
 983 #       define TSTATE_CBI_RESET2                17      /* in clear stall */
 984 #       define TSTATE_CBI_RESET3                18      /* out clear stall */
 985 #       define TSTATE_STATES                    19      /* # of states above */
 986
 987
 988         /* SCSI/CAM specific variables */
 989         unsigned char           cam_scsi_command[CAM_MAX_CDBLEN];
 990         unsigned char           cam_scsi_command2[CAM_MAX_CDBLEN];
 991         struct scsi_sense       cam_scsi_sense;
 992         struct scsi_sense       cam_scsi_test_unit_ready;
 993         struct callout          cam_scsi_rescan_ch;
 994
 995         int                     timeout;                /* in msecs */
 996
 997         int                     maxlun;                 /* maximum LUN number */
 998 };
 999
1000 #ifdef USB_DEBUG
1001 char *states[TSTATE_STATES+1] = {
1002         /* should be kept in sync with the list at transfer_state */
1003         "Attach",
1004         "Idle",
1005         "BBB CBW",
1006         "BBB Data",
1007         "BBB Data bulk-in/-out clear stall",
1008         "BBB CSW, 1st attempt",
1009         "BBB CSW bulk-in clear stall",
1010         "BBB CSW, 2nd attempt",
1011         "BBB Reset",
1012         "BBB bulk-in clear stall",
1013         "BBB bulk-out clear stall",
1014         "CBI Command",
1015         "CBI Data",
1016         "CBI Status",
1017         "CBI Data bulk-in/-out clear stall",
1018         "CBI Status intr-in clear stall",
1019         "CBI Reset",
1020         "CBI bulk-in clear stall",
1021         "CBI bulk-out clear stall",
1022         NULL
1023 };
1024 #endif
1025
1026 /* If device cannot return valid inquiry data, fake it */
1027 static uint8_t fake_inq_data[SHORT_INQUIRY_LENGTH] = {
1028         0, /*removable*/ 0x80, SCSI_REV_2, SCSI_REV_2,
1029         /*additional_length*/ 31, 0, 0, 0
1030 };
1031
1032 /* USB device probe/attach/detach functions */
1033 static device_probe_t umass_match;
1034 static device_attach_t umass_attach;
1035 static device_detach_t umass_detach;
1036
1037 static device_method_t umass_methods[] = {
1038         /* Device interface */
1039         DEVMETHOD(device_probe,         umass_match),
1040         DEVMETHOD(device_attach,        umass_attach),
1041         DEVMETHOD(device_detach,        umass_detach),
1042
1043         { 0, 0 }
1044 };
1045
1046 static driver_t umass_driver = {
1047         "umass",
1048         umass_methods,
1049         sizeof(struct umass_softc)
1050 };
1051
1052 static devclass_t umass_devclass;
1053
1054 static int umass_match_proto    (struct umass_softc *sc,
1055                                 usbd_interface_handle iface,
1056                                 usbd_device_handle udev);
1057
1058 /* quirk functions */
1059 static void umass_init_shuttle  (struct umass_softc *sc);
1060
1061 /* generic transfer functions */
1062 static usbd_status umass_setup_transfer (struct umass_softc *sc,
1063                                 usbd_pipe_handle pipe,
1064                                 void *buffer, int buflen, int flags,
1065                                 usbd_xfer_handle xfer);
1066 static usbd_status umass_setup_ctrl_transfer    (struct umass_softc *sc,
1067                                 usbd_device_handle udev,
1068                                 usb_device_request_t *req,
1069                                 void *buffer, int buflen, int flags,
1070                                 usbd_xfer_handle xfer);
1071 static void umass_clear_endpoint_stall  (struct umass_softc *sc,
1072                                 u_int8_t endpt, usbd_pipe_handle pipe,
1073                                 int state, usbd_xfer_handle xfer);
1074 static void umass_reset         (struct umass_softc *sc,
1075                                 transfer_cb_f cb, void *priv);
1076
1077 /* Bulk-Only related functions */
1078 static void umass_bbb_reset     (struct umass_softc *sc, int status);
1079 static void umass_bbb_transfer  (struct umass_softc *sc, int lun,
1080                                 void *cmd, int cmdlen,
1081                                 void *data, int datalen, int dir, u_int timeout,
1082                                 transfer_cb_f cb, void *priv);
1083 static void umass_bbb_state     (usbd_xfer_handle xfer,
1084                                 usbd_private_handle priv,
1085                                 usbd_status err);
1086 static int umass_bbb_get_max_lun
1087                                 (struct umass_softc *sc);
1088
1089 /* CBI related functions */
1090 static int umass_cbi_adsc       (struct umass_softc *sc,
1091                                 char *buffer, int buflen,
1092                                 usbd_xfer_handle xfer);
1093 static void umass_cbi_reset     (struct umass_softc *sc, int status);
1094 static void umass_cbi_transfer  (struct umass_softc *sc, int lun,
1095                                 void *cmd, int cmdlen,
1096                                 void *data, int datalen, int dir, u_int timeout,
1097                                 transfer_cb_f cb, void *priv);
1098 static void umass_cbi_state     (usbd_xfer_handle xfer,
1099                                 usbd_private_handle priv, usbd_status err);
1100
1101 /* CAM related functions */
1102 static void umass_cam_action    (struct cam_sim *sim, union ccb *ccb);
1103 static void umass_cam_poll      (struct cam_sim *sim);
1104
1105 static void umass_cam_cb        (struct umass_softc *sc, void *priv,
1106                                 int residue, int status);
1107 static void umass_cam_sense_cb  (struct umass_softc *sc, void *priv,
1108                                 int residue, int status);
1109 static void umass_cam_quirk_cb  (struct umass_softc *sc, void *priv,
1110                                 int residue, int status);
1111
1112 static void umass_cam_rescan_callback
1113                                 (struct cam_periph *periph,union ccb *ccb);
1114 static void umass_cam_rescan    (void *addr);
1115
1116 static int umass_cam_attach_sim (struct umass_softc *sc);
1117 static int umass_cam_attach     (struct umass_softc *sc);
1118 static int umass_cam_detach_sim (struct umass_softc *sc);
1119
1120
1121 /* SCSI specific functions */
1122 static int umass_scsi_transform (struct umass_softc *sc,
1123                                 unsigned char *cmd, int cmdlen,
1124                                 unsigned char **rcmd, int *rcmdlen);
1125
1126 /* UFI specific functions */
1127 #define UFI_COMMAND_LENGTH      12      /* UFI commands are always 12 bytes */
1128 static int umass_ufi_transform  (struct umass_softc *sc,
1129                                 unsigned char *cmd, int cmdlen,
1130                                 unsigned char **rcmd, int *rcmdlen);
1131
1132 /* ATAPI (8070i) specific functions */
1133 #define ATAPI_COMMAND_LENGTH    12      /* ATAPI commands are always 12 bytes */
1134 static int umass_atapi_transform        (struct umass_softc *sc,
1135                                 unsigned char *cmd, int cmdlen,
1136                                 unsigned char **rcmd, int *rcmdlen);
1137
1138 /* RBC specific functions */
1139 static int umass_rbc_transform  (struct umass_softc *sc,
1140                                 unsigned char *cmd, int cmdlen,
1141                                 unsigned char **rcmd, int *rcmdlen);
1142
1143 #ifdef USB_DEBUG
1144 /* General debugging functions */
1145 static void umass_bbb_dump_cbw  (struct umass_softc *sc, umass_bbb_cbw_t *cbw);
1146 static void umass_bbb_dump_csw  (struct umass_softc *sc, umass_bbb_csw_t *csw);
1147 static void umass_cbi_dump_cmd  (struct umass_softc *sc, void *cmd, int cmdlen);
1148 static void umass_dump_buffer   (struct umass_softc *sc, u_int8_t *buffer,
1149                                 int buflen, int printlen);
1150 #endif
1151
1152 MODULE_DEPEND(umass, cam, 1, 1, 1);
1153 MODULE_DEPEND(umass, usb, 1, 1, 1);
1154
1155 /*
1156  * USB device probe/attach/detach
1157  */
1158
1159 /*
1160  * Match the device we are seeing with the devices supported. Fill in the
1161  * description in the softc accordingly. This function is called from both
1162  * probe and attach.
1163  */
1164
1165 static int
1166 umass_match_proto(struct umass_softc *sc, usbd_interface_handle iface,
1167                   usbd_device_handle udev)
1168 {
1169         usb_device_descriptor_t *dd;
1170         usb_interface_descriptor_t *id;
1171         int i;
1172         int found = 0;
1173
1174         sc->sc_udev = udev;
1175         sc->proto = 0;
1176         sc->quirks = 0;
1177
1178         dd = usbd_get_device_descriptor(udev);
1179
1180         /* An entry specifically for Y-E Data devices as they don't fit in the
1181          * device description table.
1182          */
1183         if (UGETW(dd->idVendor) == USB_VENDOR_YEDATA
1184             && UGETW(dd->idProduct) == USB_PRODUCT_YEDATA_FLASHBUSTERU) {
1185
1186                 /* Revisions < 1.28 do not handle the interrupt endpoint
1187                  * very well.
1188                  */
1189                 if (UGETW(dd->bcdDevice) < 0x128) {
1190                         sc->proto = UMASS_PROTO_UFI | UMASS_PROTO_CBI;
1191                 } else {
1192                         sc->proto = UMASS_PROTO_UFI | UMASS_PROTO_CBI_I;
1193                 }
1194
1195                 /*
1196                  * Revisions < 1.28 do not have the TEST UNIT READY command
1197                  * Revisions == 1.28 have a broken TEST UNIT READY
1198                  */
1199                 if (UGETW(dd->bcdDevice) <= 0x128)
1200                         sc->quirks |= NO_TEST_UNIT_READY;
1201
1202                 sc->quirks |= RS_NO_CLEAR_UA | FLOPPY_SPEED;
1203                 return(UMATCH_VENDOR_PRODUCT);
1204         }
1205
1206         /* Check the list of supported devices for a match. While looking,
1207          * check for wildcarded and fully matched. First match wins.
1208          */
1209         for (i = 0; umass_devdescrs[i].vid != VID_EOT && !found; i++) {
1210                 if (umass_devdescrs[i].vid == VID_WILDCARD &&
1211                     umass_devdescrs[i].pid == PID_WILDCARD &&
1212                     umass_devdescrs[i].rid == RID_WILDCARD) {
1213                         printf("umass: ignoring invalid wildcard quirk\n");
1214                         continue;
1215                 }
1216                 if ((umass_devdescrs[i].vid == UGETW(dd->idVendor) ||
1217                      umass_devdescrs[i].vid == VID_WILDCARD)
1218                  && (umass_devdescrs[i].pid == UGETW(dd->idProduct) ||
1219                      umass_devdescrs[i].pid == PID_WILDCARD)) {
1220                         if (umass_devdescrs[i].rid == RID_WILDCARD) {
1221                                 sc->proto = umass_devdescrs[i].proto;
1222                                 sc->quirks = umass_devdescrs[i].quirks;
1223                                 return (UMATCH_VENDOR_PRODUCT);
1224                         } else if (umass_devdescrs[i].rid ==
1225                             UGETW(dd->bcdDevice)) {
1226                                 sc->proto = umass_devdescrs[i].proto;
1227                                 sc->quirks = umass_devdescrs[i].quirks;
1228                                 return (UMATCH_VENDOR_PRODUCT_REV);
1229                         } /* else RID does not match */
1230                 }
1231         }
1232
1233         /* Check for a standards compliant device */
1234         id = usbd_get_interface_descriptor(iface);
1235         if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
1236                 return(UMATCH_NONE);
1237
1238         switch (id->bInterfaceSubClass) {
1239         case UISUBCLASS_SCSI:
1240                 sc->proto |= UMASS_PROTO_SCSI;
1241                 break;
1242         case UISUBCLASS_UFI:
1243                 sc->proto |= UMASS_PROTO_UFI;
1244                 break;
1245         case UISUBCLASS_RBC:
1246                 sc->proto |= UMASS_PROTO_RBC;
1247                 break;
1248         case UISUBCLASS_SFF8020I:
1249         case UISUBCLASS_SFF8070I:
1250                 sc->proto |= UMASS_PROTO_ATAPI;
1251                 break;
1252         default:
1253                 DPRINTF(UDMASS_GEN, ("%s: Unsupported command protocol %d\n",
1254                         device_get_nameunit(sc->sc_dev), id->bInterfaceSubClass));
1255                 return(UMATCH_NONE);
1256         }
1257
1258         switch (id->bInterfaceProtocol) {
1259         case UIPROTO_MASS_CBI:
1260                 sc->proto |= UMASS_PROTO_CBI;
1261                 break;
1262         case UIPROTO_MASS_CBI_I:
1263                 sc->proto |= UMASS_PROTO_CBI_I;
1264                 break;
1265         case UIPROTO_MASS_BBB_OLD:
1266         case UIPROTO_MASS_BBB:
1267                 sc->proto |= UMASS_PROTO_BBB;
1268                 break;
1269         default:
1270                 DPRINTF(UDMASS_GEN, ("%s: Unsupported wire protocol %d\n",
1271                         device_get_nameunit(sc->sc_dev), id->bInterfaceProtocol));
1272                 return(UMATCH_NONE);
1273         }
1274
1275         return(UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
1276 }
1277
1278 static int
1279 umass_match(device_t self)
1280 {
1281         struct usb_attach_arg *uaa = device_get_ivars(self);
1282         struct umass_softc *sc = device_get_softc(self);
1283
1284         sc->sc_dev = self;
1285         if (uaa->iface == NULL)
1286                 return(UMATCH_NONE);
1287
1288         return(umass_match_proto(sc, uaa->iface, uaa->device));
1289 }
1290
1291 static int
1292 umass_attach(device_t self)
1293 {
1294         struct umass_softc *sc = device_get_softc(self);
1295         struct usb_attach_arg *uaa = device_get_ivars(self);
1296         usb_interface_descriptor_t *id;
1297         usb_endpoint_descriptor_t *ed;
1298         int i;
1299         int err;
1300
1301         /*
1302          * the softc struct is bzero-ed in device_set_driver. We can safely
1303          * call umass_detach without specifically initialising the struct.
1304          */
1305         sc->sc_dev = self;
1306         sc->iface = uaa->iface;
1307         sc->ifaceno = uaa->ifaceno;
1308         callout_init(&sc->cam_scsi_rescan_ch, 0);
1309
1310         /* initialise the proto and drive values in the umass_softc (again) */
1311         (void) umass_match_proto(sc, sc->iface, uaa->device);
1312
1313         id = usbd_get_interface_descriptor(sc->iface);
1314 #ifdef USB_DEBUG
1315         printf("%s: ", device_get_nameunit(sc->sc_dev));
1316         switch (sc->proto&UMASS_PROTO_COMMAND) {
1317         case UMASS_PROTO_SCSI:
1318                 printf("SCSI");
1319                 break;
1320         case UMASS_PROTO_ATAPI:
1321                 printf("8070i (ATAPI)");
1322                 break;
1323         case UMASS_PROTO_UFI:
1324                 printf("UFI");
1325                 break;
1326         case UMASS_PROTO_RBC:
1327                 printf("RBC");
1328                 break;
1329         default:
1330                 printf("(unknown 0x%02x)", sc->proto&UMASS_PROTO_COMMAND);
1331                 break;
1332         }
1333         printf(" over ");
1334         switch (sc->proto&UMASS_PROTO_WIRE) {
1335         case UMASS_PROTO_BBB:
1336                 printf("Bulk-Only");
1337                 break;
1338         case UMASS_PROTO_CBI:                   /* uses Comand/Bulk pipes */
1339                 printf("CBI");
1340                 break;
1341         case UMASS_PROTO_CBI_I:         /* uses Comand/Bulk/Interrupt pipes */
1342                 printf("CBI with CCI");
1343 #ifndef CBI_I
1344                 printf(" (using CBI)");
1345 #endif
1346                 break;
1347         default:
1348                 printf("(unknown 0x%02x)", sc->proto&UMASS_PROTO_WIRE);
1349         }
1350         printf("; quirks = 0x%04x\n", sc->quirks);
1351 #endif
1352
1353 #ifndef CBI_I
1354         if (sc->proto & UMASS_PROTO_CBI_I) {
1355                 /* See beginning of file for comment on the use of CBI with CCI */
1356                 sc->proto = (sc->proto & ~UMASS_PROTO_CBI_I) | UMASS_PROTO_CBI;
1357         }
1358 #endif
1359
1360         if (sc->quirks & ALT_IFACE_1) {
1361                 err = usbd_set_interface(uaa->iface, 1);
1362                 if (err) {
1363                         DPRINTF(UDMASS_USB, ("%s: could not switch to "
1364                                 "Alt Interface %d\n",
1365                                 device_get_nameunit(sc->sc_dev), 1));
1366                         umass_detach(self);
1367                         return ENXIO;
1368                 }
1369         }
1370
1371         /*
1372          * In addition to the Control endpoint the following endpoints
1373          * are required:
1374          * a) bulk-in endpoint.
1375          * b) bulk-out endpoint.
1376          * and for Control/Bulk/Interrupt with CCI (CBI_I)
1377          * c) intr-in
1378          *
1379          * The endpoint addresses are not fixed, so we have to read them
1380          * from the device descriptors of the current interface.
1381          */
1382         for (i = 0 ; i < id->bNumEndpoints ; i++) {
1383                 ed = usbd_interface2endpoint_descriptor(sc->iface, i);
1384                 if (!ed) {
1385                         printf("%s: could not read endpoint descriptor\n",
1386                                device_get_nameunit(sc->sc_dev));
1387                         return ENXIO;
1388                 }
1389                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
1390                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
1391                         sc->bulkin = ed->bEndpointAddress;
1392                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
1393                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
1394                         sc->bulkout = ed->bEndpointAddress;
1395                 } else if (sc->proto & UMASS_PROTO_CBI_I
1396                     && UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
1397                     && (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
1398                         sc->intrin = ed->bEndpointAddress;
1399 #ifdef USB_DEBUG
1400                         if (UGETW(ed->wMaxPacketSize) > 2) {
1401                                 DPRINTF(UDMASS_CBI, ("%s: intr size is %d\n",
1402                                         device_get_nameunit(sc->sc_dev),
1403                                         UGETW(ed->wMaxPacketSize)));
1404                         }
1405 #endif
1406                 }
1407         }
1408
1409         /* check whether we found all the endpoints we need */
1410         if (!sc->bulkin || !sc->bulkout
1411             || (sc->proto & UMASS_PROTO_CBI_I && !sc->intrin) ) {
1412                 DPRINTF(UDMASS_USB, ("%s: endpoint not found %d/%d/%d\n",
1413                         device_get_nameunit(sc->sc_dev),
1414                         sc->bulkin, sc->bulkout, sc->intrin));
1415                 umass_detach(self);
1416                 return ENXIO;
1417         }
1418
1419         /* Open the bulk-in and -out pipe */
1420         err = usbd_open_pipe(sc->iface, sc->bulkout,
1421                                 USBD_EXCLUSIVE_USE, &sc->bulkout_pipe);
1422         if (err) {
1423                 DPRINTF(UDMASS_USB, ("%s: cannot open %d-out pipe (bulk)\n",
1424                         device_get_nameunit(sc->sc_dev), sc->bulkout));
1425                 umass_detach(self);
1426                 return ENXIO;
1427         }
1428         err = usbd_open_pipe(sc->iface, sc->bulkin,
1429                                 USBD_EXCLUSIVE_USE, &sc->bulkin_pipe);
1430         if (err) {
1431                 DPRINTF(UDMASS_USB, ("%s: could not open %d-in pipe (bulk)\n",
1432                         device_get_nameunit(sc->sc_dev), sc->bulkin));
1433                 umass_detach(self);
1434                 return ENXIO;
1435         }
1436         /* Open the intr-in pipe if the protocol is CBI with CCI.
1437          * Note: early versions of the Zip drive do have an interrupt pipe, but
1438          * this pipe is unused.
1439          *
1440          * We do not open the interrupt pipe as an interrupt pipe, but as a
1441          * normal bulk endpoint. We send an IN transfer down the wire at the
1442          * appropriate time, because we know exactly when to expect data on
1443          * that endpoint. This saves bandwidth, but more important, makes the
1444          * code for handling the data on that endpoint simpler. No data
1445          * arriving concurrently.
1446          */
1447         if (sc->proto & UMASS_PROTO_CBI_I) {
1448                 err = usbd_open_pipe(sc->iface, sc->intrin,
1449                                 USBD_EXCLUSIVE_USE, &sc->intrin_pipe);
1450                 if (err) {
1451                         DPRINTF(UDMASS_USB, ("%s: couldn't open %d-in (intr)\n",
1452                                 device_get_nameunit(sc->sc_dev), sc->intrin));
1453                         umass_detach(self);
1454                         return ENXIO;
1455                 }
1456         }
1457
1458         /* initialisation of generic part */
1459         sc->transfer_state = TSTATE_ATTACH;
1460
1461         /* request a sufficient number of xfer handles */
1462         for (i = 0; i < XFER_NR; i++) {
1463                 sc->transfer_xfer[i] = usbd_alloc_xfer(uaa->device);
1464                 if (!sc->transfer_xfer[i]) {
1465                         DPRINTF(UDMASS_USB, ("%s: Out of memory\n",
1466                                 device_get_nameunit(sc->sc_dev)));
1467                         umass_detach(self);
1468                         return ENXIO;
1469                 }
1470         }
1471
1472         /* Initialise the wire protocol specific methods */
1473         if (sc->proto & UMASS_PROTO_BBB) {
1474                 sc->reset = umass_bbb_reset;
1475                 sc->transfer = umass_bbb_transfer;
1476                 sc->state = umass_bbb_state;
1477         } else if (sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I)) {
1478                 sc->reset = umass_cbi_reset;
1479                 sc->transfer = umass_cbi_transfer;
1480                 sc->state = umass_cbi_state;
1481 #ifdef USB_DEBUG
1482         } else {
1483                 panic("%s:%d: Unknown proto 0x%02x",
1484                       __FILE__, __LINE__, sc->proto);
1485 #endif
1486         }
1487
1488         if (sc->proto & UMASS_PROTO_SCSI)
1489                 sc->transform = umass_scsi_transform;
1490         else if (sc->proto & UMASS_PROTO_UFI)
1491                 sc->transform = umass_ufi_transform;
1492         else if (sc->proto & UMASS_PROTO_ATAPI)
1493                 sc->transform = umass_atapi_transform;
1494         else if (sc->proto & UMASS_PROTO_RBC)
1495                 sc->transform = umass_rbc_transform;
1496 #ifdef USB_DEBUG
1497         else
1498                 panic("No transformation defined for command proto 0x%02x",
1499                       sc->proto & UMASS_PROTO_COMMAND);
1500 #endif
1501
1502         /* From here onwards the device can be used. */
1503
1504         if (sc->quirks & SHUTTLE_INIT)
1505                 umass_init_shuttle(sc);
1506
1507         /* Get the maximum LUN supported by the device.
1508          */
1509         if (((sc->proto & UMASS_PROTO_WIRE) == UMASS_PROTO_BBB) &&
1510             !(sc->quirks & NO_GETMAXLUN))
1511                 sc->maxlun = umass_bbb_get_max_lun(sc);
1512         else
1513                 sc->maxlun = 0;
1514
1515         if ((sc->proto & UMASS_PROTO_SCSI) ||
1516             (sc->proto & UMASS_PROTO_ATAPI) ||
1517             (sc->proto & UMASS_PROTO_UFI) ||
1518             (sc->proto & UMASS_PROTO_RBC)) {
1519                 /* Prepare the SCSI command block */
1520                 sc->cam_scsi_sense.opcode = REQUEST_SENSE;
1521                 sc->cam_scsi_test_unit_ready.opcode = TEST_UNIT_READY;
1522
1523                 /* register the SIM */
1524                 err = umass_cam_attach_sim(sc);
1525                 if (err) {
1526                         umass_detach(self);
1527                         return ENXIO;
1528                 }
1529                 /* scan the new sim */
1530                 err = umass_cam_attach(sc);
1531                 if (err) {
1532                         umass_cam_detach_sim(sc);
1533                         umass_detach(self);
1534                         return ENXIO;
1535                 }
1536         } else {
1537                 panic("%s:%d: Unknown proto 0x%02x",
1538                       __FILE__, __LINE__, sc->proto);
1539         }
1540
1541         sc->transfer_state = TSTATE_IDLE;
1542         DPRINTF(UDMASS_GEN, ("%s: Attach finished\n", device_get_nameunit(sc->sc_dev)));
1543
1544         return 0;
1545 }
1546
1547 static int
1548 umass_detach(device_t self)
1549 {
1550         struct umass_softc *sc = device_get_softc(self);
1551         int err = 0;
1552         int i;
1553
1554         DPRINTF(UDMASS_USB, ("%s: detached\n", device_get_nameunit(sc->sc_dev)));
1555
1556         sc->flags |= UMASS_FLAGS_GONE;
1557
1558         /* abort all the pipes in case there are transfers active. */
1559         usbd_abort_default_pipe(sc->sc_udev);
1560         if (sc->bulkout_pipe)
1561                 usbd_abort_pipe(sc->bulkout_pipe);
1562         if (sc->bulkin_pipe)
1563                 usbd_abort_pipe(sc->bulkin_pipe);
1564         if (sc->intrin_pipe)
1565                 usbd_abort_pipe(sc->intrin_pipe);
1566
1567         callout_drain(&sc->cam_scsi_rescan_ch);
1568         if ((sc->proto & UMASS_PROTO_SCSI) ||
1569             (sc->proto & UMASS_PROTO_ATAPI) ||
1570             (sc->proto & UMASS_PROTO_UFI) ||
1571             (sc->proto & UMASS_PROTO_RBC))
1572                 /* detach the SCSI host controller (SIM) */
1573                 err = umass_cam_detach_sim(sc);
1574
1575         for (i = 0; i < XFER_NR; i++)
1576                 if (sc->transfer_xfer[i])
1577                         usbd_free_xfer(sc->transfer_xfer[i]);
1578
1579         /* remove all the pipes */
1580         if (sc->bulkout_pipe)
1581                 usbd_close_pipe(sc->bulkout_pipe);
1582         if (sc->bulkin_pipe)
1583                 usbd_close_pipe(sc->bulkin_pipe);
1584         if (sc->intrin_pipe)
1585                 usbd_close_pipe(sc->intrin_pipe);
1586
1587         return(err);
1588 }
1589
1590 static void
1591 umass_init_shuttle(struct umass_softc *sc)
1592 {
1593         usb_device_request_t req;
1594         u_char status[2];
1595
1596         /* The Linux driver does this, but no one can tell us what the
1597          * command does.
1598          */
1599         req.bmRequestType = UT_READ_VENDOR_DEVICE;
1600         req.bRequest = 1;       /* XXX unknown command */
1601         USETW(req.wValue, 0);
1602         USETW(req.wIndex, sc->ifaceno);
1603         USETW(req.wLength, sizeof status);
1604         (void) usbd_do_request(sc->sc_udev, &req, &status);
1605
1606         DPRINTF(UDMASS_GEN, ("%s: Shuttle init returned 0x%02x%02x\n",
1607                 device_get_nameunit(sc->sc_dev), status[0], status[1]));
1608 }
1609
1610  /*
1611  * Generic functions to handle transfers
1612  */
1613
1614 static usbd_status
1615 umass_setup_transfer(struct umass_softc *sc, usbd_pipe_handle pipe,
1616                         void *buffer, int buflen, int flags,
1617                         usbd_xfer_handle xfer)
1618 {
1619         usbd_status err;
1620
1621         /* Initialise a USB transfer and then schedule it */
1622
1623         (void) usbd_setup_xfer(xfer, pipe, (void *) sc, buffer, buflen, flags,
1624                         sc->timeout, sc->state);
1625
1626         err = usbd_transfer(xfer);
1627         if (err && err != USBD_IN_PROGRESS) {
1628                 DPRINTF(UDMASS_BBB, ("%s: failed to setup transfer, %s\n",
1629                         device_get_nameunit(sc->sc_dev), usbd_errstr(err)));
1630                 return(err);
1631         }
1632
1633         return (USBD_NORMAL_COMPLETION);
1634 }
1635
1636
1637 static usbd_status
1638 umass_setup_ctrl_transfer(struct umass_softc *sc, usbd_device_handle udev,
1639          usb_device_request_t *req,
1640          void *buffer, int buflen, int flags,
1641          usbd_xfer_handle xfer)
1642 {
1643         usbd_status err;
1644
1645         /* Initialise a USB control transfer and then schedule it */
1646
1647         (void) usbd_setup_default_xfer(xfer, udev, (void *) sc,
1648                         sc->timeout, req, buffer, buflen, flags, sc->state);
1649
1650         err = usbd_transfer(xfer);
1651         if (err && err != USBD_IN_PROGRESS) {
1652                 DPRINTF(UDMASS_BBB, ("%s: failed to setup ctrl transfer, %s\n",
1653                          device_get_nameunit(sc->sc_dev), usbd_errstr(err)));
1654
1655                 /* do not reset, as this would make us loop */
1656                 return(err);
1657         }
1658
1659         return (USBD_NORMAL_COMPLETION);
1660 }
1661
1662 static void
1663 umass_clear_endpoint_stall(struct umass_softc *sc,
1664                                 u_int8_t endpt, usbd_pipe_handle pipe,
1665                                 int state, usbd_xfer_handle xfer)
1666 {
1667         usbd_device_handle udev;
1668
1669         DPRINTF(UDMASS_BBB, ("%s: Clear endpoint 0x%02x stall\n",
1670                 device_get_nameunit(sc->sc_dev), endpt));
1671
1672         usbd_interface2device_handle(sc->iface, &udev);
1673
1674         sc->transfer_state = state;
1675
1676         usbd_clear_endpoint_toggle(pipe);
1677
1678         sc->request.bmRequestType = UT_WRITE_ENDPOINT;
1679         sc->request.bRequest = UR_CLEAR_FEATURE;
1680         USETW(sc->request.wValue, UF_ENDPOINT_HALT);
1681         USETW(sc->request.wIndex, endpt);
1682         USETW(sc->request.wLength, 0);
1683         umass_setup_ctrl_transfer(sc, udev, &sc->request, NULL, 0, 0, xfer);
1684 }
1685
1686 static void
1687 umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv)
1688 {
1689         sc->transfer_cb = cb;
1690         sc->transfer_priv = priv;
1691
1692         /* The reset is a forced reset, so no error (yet) */
1693         sc->reset(sc, STATUS_CMD_OK);
1694 }
1695
1696 /*
1697  * Bulk protocol specific functions
1698  */
1699
1700 static void
1701 umass_bbb_reset(struct umass_softc *sc, int status)
1702 {
1703         usbd_device_handle udev;
1704
1705         KASSERT(sc->proto & UMASS_PROTO_BBB,
1706                 ("%s: umass_bbb_reset: wrong sc->proto 0x%02x\n",
1707                         device_get_nameunit(sc->sc_dev), sc->proto));
1708
1709         /*
1710          * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
1711          *
1712          * For Reset Recovery the host shall issue in the following order:
1713          * a) a Bulk-Only Mass Storage Reset
1714          * b) a Clear Feature HALT to the Bulk-In endpoint
1715          * c) a Clear Feature HALT to the Bulk-Out endpoint
1716          *
1717          * This is done in 3 steps, states:
1718          * TSTATE_BBB_RESET1
1719          * TSTATE_BBB_RESET2
1720          * TSTATE_BBB_RESET3
1721          *
1722          * If the reset doesn't succeed, the device should be port reset.
1723          */
1724
1725         DPRINTF(UDMASS_BBB, ("%s: Bulk Reset\n",
1726                 device_get_nameunit(sc->sc_dev)));
1727
1728         sc->transfer_state = TSTATE_BBB_RESET1;
1729         sc->transfer_status = status;
1730
1731         usbd_interface2device_handle(sc->iface, &udev);
1732
1733         /* reset is a class specific interface write */
1734         sc->request.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1735         sc->request.bRequest = UR_BBB_RESET;
1736         USETW(sc->request.wValue, 0);
1737         USETW(sc->request.wIndex, sc->ifaceno);
1738         USETW(sc->request.wLength, 0);
1739         umass_setup_ctrl_transfer(sc, udev, &sc->request, NULL, 0, 0,
1740                                   sc->transfer_xfer[XFER_BBB_RESET1]);
1741 }
1742
1743 static void
1744 umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen,
1745                     void *data, int datalen, int dir, u_int timeout,
1746                     transfer_cb_f cb, void *priv)
1747 {
1748         KASSERT(sc->proto & UMASS_PROTO_BBB,
1749                 ("%s: umass_bbb_transfer: wrong sc->proto 0x%02x\n",
1750                         device_get_nameunit(sc->sc_dev), sc->proto));
1751
1752         /* Be a little generous. */
1753         sc->timeout = timeout + UMASS_TIMEOUT;
1754
1755         /*
1756          * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly
1757          * a data phase of datalen bytes from/to the device and finally a
1758          * csw read phase.
1759          * If the data direction was inbound a maximum of datalen bytes
1760          * is stored in the buffer pointed to by data.
1761          *
1762          * umass_bbb_transfer initialises the transfer and lets the state
1763          * machine in umass_bbb_state handle the completion. It uses the
1764          * following states:
1765          * TSTATE_BBB_COMMAND
1766          *   -> TSTATE_BBB_DATA
1767          *   -> TSTATE_BBB_STATUS
1768          *   -> TSTATE_BBB_STATUS2
1769          *   -> TSTATE_BBB_IDLE
1770          *
1771          * An error in any of those states will invoke
1772          * umass_bbb_reset.
1773          */
1774
1775         /* check the given arguments */
1776         KASSERT(datalen == 0 || data != NULL,
1777                 ("%s: datalen > 0, but no buffer",device_get_nameunit(sc->sc_dev)));
1778         KASSERT(cmdlen <= CBWCDBLENGTH,
1779                 ("%s: cmdlen exceeds CDB length in CBW (%d > %d)",
1780                         device_get_nameunit(sc->sc_dev), cmdlen, CBWCDBLENGTH));
1781         KASSERT(dir == DIR_NONE || datalen > 0,
1782                 ("%s: datalen == 0 while direction is not NONE\n",
1783                         device_get_nameunit(sc->sc_dev)));
1784         KASSERT(datalen == 0 || dir != DIR_NONE,
1785                 ("%s: direction is NONE while datalen is not zero\n",
1786                         device_get_nameunit(sc->sc_dev)));
1787         KASSERT(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE,
1788                 ("%s: CBW struct does not have the right size (%ld vs. %d)\n",
1789                         device_get_nameunit(sc->sc_dev),
1790                         (long)sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE));
1791         KASSERT(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE,
1792                 ("%s: CSW struct does not have the right size (%ld vs. %d)\n",
1793                         device_get_nameunit(sc->sc_dev),
1794                         (long)sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE));
1795
1796         /*
1797          * Determine the direction of the data transfer and the length.
1798          *
1799          * dCBWDataTransferLength (datalen) :
1800          *   This field indicates the number of bytes of data that the host
1801          *   intends to transfer on the IN or OUT Bulk endpoint(as indicated by
1802          *   the Direction bit) during the execution of this command. If this
1803          *   field is set to 0, the device will expect that no data will be
1804          *   transferred IN or OUT during this command, regardless of the value
1805          *   of the Direction bit defined in dCBWFlags.
1806          *
1807          * dCBWFlags (dir) :
1808          *   The bits of the Flags field are defined as follows:
1809          *     Bits 0-6  reserved
1810          *     Bit  7    Direction - this bit shall be ignored if the
1811          *                           dCBWDataTransferLength field is zero.
1812          *               0 = data Out from host to device
1813          *               1 = data In from device to host
1814          */
1815
1816         /* Fill in the Command Block Wrapper
1817          * We fill in all the fields, so there is no need to bzero it first.
1818          */
1819         USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
1820         /* We don't care about the initial value, as long as the values are unique */
1821         USETDW(sc->cbw.dCBWTag, UGETDW(sc->cbw.dCBWTag) + 1);
1822         USETDW(sc->cbw.dCBWDataTransferLength, datalen);
1823         /* DIR_NONE is treated as DIR_OUT (0x00) */
1824         sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT);
1825         sc->cbw.bCBWLUN = lun;
1826         sc->cbw.bCDBLength = cmdlen;
1827         bcopy(cmd, sc->cbw.CBWCDB, cmdlen);
1828
1829         DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw));
1830
1831         /* store the details for the data transfer phase */
1832         sc->transfer_dir = dir;
1833         sc->transfer_data = data;
1834         sc->transfer_datalen = datalen;
1835         sc->transfer_actlen = 0;
1836         sc->transfer_cb = cb;
1837         sc->transfer_priv = priv;
1838         sc->transfer_status = STATUS_CMD_OK;
1839
1840         /* move from idle to the command state */
1841         sc->transfer_state = TSTATE_BBB_COMMAND;
1842
1843         /* Send the CBW from host to device via bulk-out endpoint. */
1844         if (umass_setup_transfer(sc, sc->bulkout_pipe,
1845                         &sc->cbw, UMASS_BBB_CBW_SIZE, 0,
1846                         sc->transfer_xfer[XFER_BBB_CBW])) {
1847                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1848         }
1849 }
1850
1851
1852 static void
1853 umass_bbb_state(usbd_xfer_handle xfer, usbd_private_handle priv,
1854                 usbd_status err)
1855 {
1856         struct umass_softc *sc = (struct umass_softc *) priv;
1857         usbd_xfer_handle next_xfer;
1858
1859         KASSERT(sc->proto & UMASS_PROTO_BBB,
1860                 ("%s: umass_bbb_state: wrong sc->proto 0x%02x\n",
1861                         device_get_nameunit(sc->sc_dev), sc->proto));
1862
1863         /*
1864          * State handling for BBB transfers.
1865          *
1866          * The subroutine is rather long. It steps through the states given in
1867          * Annex A of the Bulk-Only specification.
1868          * Each state first does the error handling of the previous transfer
1869          * and then prepares the next transfer.
1870          * Each transfer is done asynchronously so after the request/transfer
1871          * has been submitted you will find a 'return;'.
1872          */
1873
1874         DPRINTF(UDMASS_BBB, ("%s: Handling BBB state %d (%s), xfer=%p, %s\n",
1875                 device_get_nameunit(sc->sc_dev), sc->transfer_state,
1876                 states[sc->transfer_state], xfer, usbd_errstr(err)));
1877
1878         /* Give up if the device has detached. */
1879         if (sc->flags & UMASS_FLAGS_GONE) {
1880                 sc->transfer_state = TSTATE_IDLE;
1881                 sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen,
1882                     STATUS_CMD_FAILED);
1883                 return;
1884         }
1885
1886         switch (sc->transfer_state) {
1887
1888         /***** Bulk Transfer *****/
1889         case TSTATE_BBB_COMMAND:
1890                 /* Command transport phase, error handling */
1891                 if (err) {
1892                         DPRINTF(UDMASS_BBB, ("%s: failed to send CBW\n",
1893                                 device_get_nameunit(sc->sc_dev)));
1894                         /* If the device detects that the CBW is invalid, then
1895                          * the device may STALL both bulk endpoints and require
1896                          * a Bulk-Reset
1897                          */
1898                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1899                         return;
1900                 }
1901
1902                 /* Data transport phase, setup transfer */
1903                 sc->transfer_state = TSTATE_BBB_DATA;
1904                 if (sc->transfer_dir == DIR_IN) {
1905                         if (umass_setup_transfer(sc, sc->bulkin_pipe,
1906                                         sc->transfer_data, sc->transfer_datalen,
1907                                         USBD_SHORT_XFER_OK,
1908                                         sc->transfer_xfer[XFER_BBB_DATA]))
1909                                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1910
1911                         return;
1912                 } else if (sc->transfer_dir == DIR_OUT) {
1913                         if (umass_setup_transfer(sc, sc->bulkout_pipe,
1914                                         sc->transfer_data, sc->transfer_datalen,
1915                                         0,      /* fixed length transfer */
1916                                         sc->transfer_xfer[XFER_BBB_DATA]))
1917                                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1918
1919                         return;
1920                 } else {
1921                         DPRINTF(UDMASS_BBB, ("%s: no data phase\n",
1922                                 device_get_nameunit(sc->sc_dev)));
1923                 }
1924
1925                 /* FALLTHROUGH if no data phase, err == 0 */
1926         case TSTATE_BBB_DATA:
1927                 /* Command transport phase, error handling (ignored if no data
1928                  * phase (fallthrough from previous state)) */
1929                 if (sc->transfer_dir != DIR_NONE) {
1930                         /* retrieve the length of the transfer that was done */
1931                         usbd_get_xfer_status(xfer, NULL, NULL,
1932                                                 &sc->transfer_actlen, NULL);
1933
1934                         if (err) {
1935                                 DPRINTF(UDMASS_BBB, ("%s: Data-%s %db failed, "
1936                                         "%s\n", device_get_nameunit(sc->sc_dev),
1937                                         (sc->transfer_dir == DIR_IN?"in":"out"),
1938                                         sc->transfer_datalen,usbd_errstr(err)));
1939
1940                                 if (err == USBD_STALLED) {
1941                                         umass_clear_endpoint_stall(sc,
1942                                           (sc->transfer_dir == DIR_IN?
1943                                             sc->bulkin:sc->bulkout),
1944                                           (sc->transfer_dir == DIR_IN?
1945                                             sc->bulkin_pipe:sc->bulkout_pipe),
1946                                           TSTATE_BBB_DCLEAR,
1947                                           sc->transfer_xfer[XFER_BBB_DCLEAR]);
1948                                         return;
1949                                 } else {
1950                                         /* Unless the error is a pipe stall the
1951                                          * error is fatal.
1952                                          */
1953                                         umass_bbb_reset(sc,STATUS_WIRE_FAILED);
1954                                         return;
1955                                 }
1956                         }
1957                 }
1958
1959                 DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN)
1960                                         umass_dump_buffer(sc, sc->transfer_data,
1961                                                 sc->transfer_datalen, 48));
1962
1963
1964
1965                 /* FALLTHROUGH, err == 0 (no data phase or successfull) */
1966         case TSTATE_BBB_DCLEAR: /* stall clear after data phase */
1967         case TSTATE_BBB_SCLEAR: /* stall clear after status phase */
1968                 /* Reading of CSW after bulk stall condition in data phase
1969                  * (TSTATE_BBB_DATA2) or bulk-in stall condition after
1970                  * reading CSW (TSTATE_BBB_SCLEAR).
1971                  * In the case of no data phase or successfull data phase,
1972                  * err == 0 and the following if block is passed.
1973                  */
1974                 if (err) {      /* should not occur */
1975                         /* try the transfer below, even if clear stall failed */
1976                         DPRINTF(UDMASS_BBB, ("%s: bulk-%s stall clear failed"
1977                                 ", %s\n", device_get_nameunit(sc->sc_dev),
1978                                 (sc->transfer_dir == DIR_IN? "in":"out"),
1979                                 usbd_errstr(err)));
1980                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1981                         return;
1982                 }
1983
1984                 /* Status transport phase, setup transfer */
1985                 if (sc->transfer_state == TSTATE_BBB_COMMAND ||
1986                     sc->transfer_state == TSTATE_BBB_DATA ||
1987                     sc->transfer_state == TSTATE_BBB_DCLEAR) {
1988                         /* After no data phase, successfull data phase and
1989                          * after clearing bulk-in/-out stall condition
1990                          */
1991                         sc->transfer_state = TSTATE_BBB_STATUS1;
1992                         next_xfer = sc->transfer_xfer[XFER_BBB_CSW1];
1993                 } else {
1994                         /* After first attempt of fetching CSW */
1995                         sc->transfer_state = TSTATE_BBB_STATUS2;
1996                         next_xfer = sc->transfer_xfer[XFER_BBB_CSW2];
1997                 }
1998
1999                 /* Read the Command Status Wrapper via bulk-in endpoint. */
2000                 if (umass_setup_transfer(sc, sc->bulkin_pipe,
2001                                 &sc->csw, UMASS_BBB_CSW_SIZE, 0,
2002                                 next_xfer)) {
2003                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
2004                         return;
2005                 }
2006
2007                 return;
2008         case TSTATE_BBB_STATUS1:        /* first attempt */
2009         case TSTATE_BBB_STATUS2:        /* second attempt */
2010                 /* Status transfer, error handling */
2011                 if (err) {
2012                         DPRINTF(UDMASS_BBB, ("%s: Failed to read CSW, %s%s\n",
2013                                 device_get_nameunit(sc->sc_dev), usbd_errstr(err),
2014                                 (sc->transfer_state == TSTATE_BBB_STATUS1?
2015                                         ", retrying":"")));
2016
2017                         /* If this was the first attempt at fetching the CSW
2018                          * retry it, otherwise fail.
2019                          */
2020                         if (sc->transfer_state == TSTATE_BBB_STATUS1) {
2021                                 umass_clear_endpoint_stall(sc,
2022                                             sc->bulkin, sc->bulkin_pipe,
2023                                             TSTATE_BBB_SCLEAR,
2024                                             sc->transfer_xfer[XFER_BBB_SCLEAR]);
2025                                 return;
2026                         } else {
2027                                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
2028                                 return;
2029                         }
2030                 }
2031
2032                 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw));
2033
2034                 /* Translate weird command-status signatures. */
2035                 if (sc->quirks & WRONG_CSWSIG) {
2036                         u_int32_t dCSWSignature = UGETDW(sc->csw.dCSWSignature);
2037                         if (dCSWSignature == CSWSIGNATURE_OLYMPUS_C1 ||
2038                             dCSWSignature == CSWSIGNATURE_IMAGINATION_DBX1)
2039                                 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE);
2040                 }
2041
2042                 int Residue;
2043                 Residue = UGETDW(sc->csw.dCSWDataResidue);
2044                 if (Residue == 0 &&
2045                     sc->transfer_datalen - sc->transfer_actlen != 0)
2046                         Residue = sc->transfer_datalen - sc->transfer_actlen;
2047
2048                 /* Check CSW and handle any error */
2049                 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) {
2050                         /* Invalid CSW: Wrong signature or wrong tag might
2051                          * indicate that the device is confused -> reset it.
2052                          */
2053                         printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n",
2054                                 device_get_nameunit(sc->sc_dev),
2055                                 UGETDW(sc->csw.dCSWSignature),
2056                                 CSWSIGNATURE);
2057
2058                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
2059                         return;
2060                 } else if (UGETDW(sc->csw.dCSWTag)
2061                                 != UGETDW(sc->cbw.dCBWTag)) {
2062                         printf("%s: Invalid CSW: tag %d should be %d\n",
2063                                 device_get_nameunit(sc->sc_dev),
2064                                 UGETDW(sc->csw.dCSWTag),
2065                                 UGETDW(sc->cbw.dCBWTag));
2066
2067                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
2068                         return;
2069
2070                 /* CSW is valid here */
2071                 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) {
2072                         printf("%s: Invalid CSW: status %d > %d\n",
2073                                 device_get_nameunit(sc->sc_dev),
2074                                 sc->csw.bCSWStatus,
2075                                 CSWSTATUS_PHASE);
2076
2077                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
2078                         return;
2079                 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) {
2080                         printf("%s: Phase Error, residue = %d\n",
2081                                 device_get_nameunit(sc->sc_dev), Residue);
2082
2083                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
2084                         return;
2085
2086                 } else if (sc->transfer_actlen > sc->transfer_datalen) {
2087                         /* Buffer overrun! Don't let this go by unnoticed */
2088                         panic("%s: transferred %db instead of %db",
2089                                 device_get_nameunit(sc->sc_dev),
2090                                 sc->transfer_actlen, sc->transfer_datalen);
2091
2092                 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) {
2093                         DPRINTF(UDMASS_BBB, ("%s: Command Failed, res = %d\n",
2094                                 device_get_nameunit(sc->sc_dev), Residue));
2095
2096                         /* SCSI command failed but transfer was succesful */
2097                         sc->transfer_state = TSTATE_IDLE;
2098                         sc->transfer_cb(sc, sc->transfer_priv, Residue,
2099                                         STATUS_CMD_FAILED);
2100                         return;
2101
2102                 } else {        /* success */
2103                         sc->transfer_state = TSTATE_IDLE;
2104                         sc->transfer_cb(sc, sc->transfer_priv, Residue,
2105                                         STATUS_CMD_OK);
2106
2107                         return;
2108                 }
2109
2110         /***** Bulk Reset *****/
2111         case TSTATE_BBB_RESET1:
2112                 if (err)
2113                         printf("%s: BBB reset failed, %s\n",
2114                                 device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2115
2116                 umass_clear_endpoint_stall(sc,
2117                         sc->bulkin, sc->bulkin_pipe, TSTATE_BBB_RESET2,
2118                         sc->transfer_xfer[XFER_BBB_RESET2]);
2119
2120                 return;
2121         case TSTATE_BBB_RESET2:
2122                 if (err)        /* should not occur */
2123                         printf("%s: BBB bulk-in clear stall failed, %s\n",
2124                                device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2125                         /* no error recovery, otherwise we end up in a loop */
2126
2127                 umass_clear_endpoint_stall(sc,
2128                         sc->bulkout, sc->bulkout_pipe, TSTATE_BBB_RESET3,
2129                         sc->transfer_xfer[XFER_BBB_RESET3]);
2130
2131                 return;
2132         case TSTATE_BBB_RESET3:
2133                 if (err)        /* should not occur */
2134                         printf("%s: BBB bulk-out clear stall failed, %s\n",
2135                                device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2136                         /* no error recovery, otherwise we end up in a loop */
2137
2138                 sc->transfer_state = TSTATE_IDLE;
2139                 if (sc->transfer_priv) {
2140                         sc->transfer_cb(sc, sc->transfer_priv,
2141                                         sc->transfer_datalen,
2142                                         sc->transfer_status);
2143                 }
2144
2145                 return;
2146
2147         /***** Default *****/
2148         default:
2149                 panic("%s: Unknown state %d",
2150                       device_get_nameunit(sc->sc_dev), sc->transfer_state);
2151         }
2152 }
2153
2154 static int
2155 umass_bbb_get_max_lun(struct umass_softc *sc)
2156 {
2157         usbd_device_handle udev;
2158         usb_device_request_t req;
2159         usbd_status err;
2160         usb_interface_descriptor_t *id;
2161         int maxlun = 0;
2162         u_int8_t buf = 0;
2163
2164         usbd_interface2device_handle(sc->iface, &udev);
2165         id = usbd_get_interface_descriptor(sc->iface);
2166
2167         /* The Get Max Lun command is a class-specific request. */
2168         req.bmRequestType = UT_READ_CLASS_INTERFACE;
2169         req.bRequest = UR_BBB_GET_MAX_LUN;
2170         USETW(req.wValue, 0);
2171         USETW(req.wIndex, id->bInterfaceNumber);
2172         USETW(req.wLength, 1);
2173
2174         err = usbd_do_request(udev, &req, &buf);
2175         switch (err) {
2176         case USBD_NORMAL_COMPLETION:
2177                 maxlun = buf;
2178                 DPRINTF(UDMASS_BBB, ("%s: Max Lun is %d\n",
2179                     device_get_nameunit(sc->sc_dev), maxlun));
2180                 break;
2181         case USBD_STALLED:
2182         case USBD_SHORT_XFER:
2183         default:
2184                 /* Device doesn't support Get Max Lun request. */
2185                 printf("%s: Get Max Lun not supported (%s)\n",
2186                     device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2187                 /* XXX Should we port_reset the device? */
2188                 break;
2189         }
2190
2191         return(maxlun);
2192 }
2193
2194 /*
2195  * Command/Bulk/Interrupt (CBI) specific functions
2196  */
2197
2198 static int
2199 umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen,
2200                usbd_xfer_handle xfer)
2201 {
2202         usbd_device_handle udev;
2203
2204         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
2205                 ("%s: umass_cbi_adsc: wrong sc->proto 0x%02x\n",
2206                         device_get_nameunit(sc->sc_dev), sc->proto));
2207
2208         usbd_interface2device_handle(sc->iface, &udev);
2209
2210         sc->request.bmRequestType = UT_WRITE_CLASS_INTERFACE;
2211         sc->request.bRequest = UR_CBI_ADSC;
2212         USETW(sc->request.wValue, 0);
2213         USETW(sc->request.wIndex, sc->ifaceno);
2214         USETW(sc->request.wLength, buflen);
2215         return umass_setup_ctrl_transfer(sc, udev, &sc->request, buffer,
2216                                          buflen, 0, xfer);
2217 }
2218
2219
2220 static void
2221 umass_cbi_reset(struct umass_softc *sc, int status)
2222 {
2223         int i;
2224 #       define SEND_DIAGNOSTIC_CMDLEN   12
2225
2226         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
2227                 ("%s: umass_cbi_reset: wrong sc->proto 0x%02x\n",
2228                         device_get_nameunit(sc->sc_dev), sc->proto));
2229
2230         /*
2231          * Command Block Reset Protocol
2232          *
2233          * First send a reset request to the device. Then clear
2234          * any possibly stalled bulk endpoints.
2235          *
2236          * This is done in 3 steps, states:
2237          * TSTATE_CBI_RESET1
2238          * TSTATE_CBI_RESET2
2239          * TSTATE_CBI_RESET3
2240          *
2241          * If the reset doesn't succeed, the device should be port reset.
2242          */
2243
2244         DPRINTF(UDMASS_CBI, ("%s: CBI Reset\n",
2245                 device_get_nameunit(sc->sc_dev)));
2246
2247         KASSERT(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN,
2248                 ("%s: CBL struct is too small (%ld < %d)\n",
2249                         device_get_nameunit(sc->sc_dev),
2250                         (long)sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN));
2251
2252         sc->transfer_state = TSTATE_CBI_RESET1;
2253         sc->transfer_status = status;
2254
2255         /* The 0x1d code is the SEND DIAGNOSTIC command. To distinguish between
2256          * the two the last 10 bytes of the cbl is filled with 0xff (section
2257          * 2.2 of the CBI spec).
2258          */
2259         sc->cbl[0] = 0x1d;      /* Command Block Reset */
2260         sc->cbl[1] = 0x04;
2261         for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++)
2262                 sc->cbl[i] = 0xff;
2263
2264         umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN,
2265                        sc->transfer_xfer[XFER_CBI_RESET1]);
2266         /* XXX if the command fails we should reset the port on the hub */
2267 }
2268
2269 static void
2270 umass_cbi_transfer(struct umass_softc *sc, int lun,
2271                 void *cmd, int cmdlen, void *data, int datalen, int dir,
2272                 u_int timeout, transfer_cb_f cb, void *priv)
2273 {
2274         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
2275                 ("%s: umass_cbi_transfer: wrong sc->proto 0x%02x\n",
2276                         device_get_nameunit(sc->sc_dev), sc->proto));
2277
2278         /* Be a little generous. */
2279         sc->timeout = timeout + UMASS_TIMEOUT;
2280
2281         /*
2282          * Do a CBI transfer with cmdlen bytes from cmd, possibly
2283          * a data phase of datalen bytes from/to the device and finally a
2284          * csw read phase.
2285          * If the data direction was inbound a maximum of datalen bytes
2286          * is stored in the buffer pointed to by data.
2287          *
2288          * umass_cbi_transfer initialises the transfer and lets the state
2289          * machine in umass_cbi_state handle the completion. It uses the
2290          * following states:
2291          * TSTATE_CBI_COMMAND
2292          *   -> XXX fill in
2293          *
2294          * An error in any of those states will invoke
2295          * umass_cbi_reset.
2296          */
2297
2298         /* check the given arguments */
2299         KASSERT(datalen == 0 || data != NULL,
2300                 ("%s: datalen > 0, but no buffer",device_get_nameunit(sc->sc_dev)));
2301         KASSERT(datalen == 0 || dir != DIR_NONE,
2302                 ("%s: direction is NONE while datalen is not zero\n",
2303                         device_get_nameunit(sc->sc_dev)));
2304
2305         /* store the details for the data transfer phase */
2306         sc->transfer_dir = dir;
2307         sc->transfer_data = data;
2308         sc->transfer_datalen = datalen;
2309         sc->transfer_actlen = 0;
2310         sc->transfer_cb = cb;
2311         sc->transfer_priv = priv;
2312         sc->transfer_status = STATUS_CMD_OK;
2313
2314         /* move from idle to the command state */
2315         sc->transfer_state = TSTATE_CBI_COMMAND;
2316
2317         DIF(UDMASS_CBI, umass_cbi_dump_cmd(sc, cmd, cmdlen));
2318
2319         /* Send the Command Block from host to device via control endpoint. */
2320         if (umass_cbi_adsc(sc, cmd, cmdlen, sc->transfer_xfer[XFER_CBI_CB]))
2321                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2322 }
2323
2324 static void
2325 umass_cbi_state(usbd_xfer_handle xfer, usbd_private_handle priv,
2326                 usbd_status err)
2327 {
2328         struct umass_softc *sc = (struct umass_softc *) priv;
2329
2330         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
2331                 ("%s: umass_cbi_state: wrong sc->proto 0x%02x\n",
2332                         device_get_nameunit(sc->sc_dev), sc->proto));
2333
2334         /*
2335          * State handling for CBI transfers.
2336          */
2337
2338         DPRINTF(UDMASS_CBI, ("%s: Handling CBI state %d (%s), xfer=%p, %s\n",
2339                 device_get_nameunit(sc->sc_dev), sc->transfer_state,
2340                 states[sc->transfer_state], xfer, usbd_errstr(err)));
2341
2342         /* Give up if the device has detached. */
2343         if (sc->flags & UMASS_FLAGS_GONE) {
2344                 sc->transfer_state = TSTATE_IDLE;
2345                 sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen,
2346                     STATUS_CMD_FAILED);
2347                 return;
2348         }
2349
2350         switch (sc->transfer_state) {
2351
2352         /***** CBI Transfer *****/
2353         case TSTATE_CBI_COMMAND:
2354                 if (err == USBD_STALLED) {
2355                         DPRINTF(UDMASS_CBI, ("%s: Command Transport failed\n",
2356                                 device_get_nameunit(sc->sc_dev)));
2357                         /* Status transport by control pipe (section 2.3.2.1).
2358                          * The command contained in the command block failed.
2359                          *
2360                          * The control pipe has already been unstalled by the
2361                          * USB stack.
2362                          * Section 2.4.3.1.1 states that the bulk in endpoints
2363                          * should not be stalled at this point.
2364                          */
2365
2366                         sc->transfer_state = TSTATE_IDLE;
2367                         sc->transfer_cb(sc, sc->transfer_priv,
2368                                         sc->transfer_datalen,
2369                                         STATUS_CMD_FAILED);
2370
2371                         return;
2372                 } else if (err) {
2373                         DPRINTF(UDMASS_CBI, ("%s: failed to send ADSC\n",
2374                                 device_get_nameunit(sc->sc_dev)));
2375                         umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2376
2377                         return;
2378                 }
2379
2380                 sc->transfer_state = TSTATE_CBI_DATA;
2381                 if (sc->transfer_dir == DIR_IN) {
2382                         if (umass_setup_transfer(sc, sc->bulkin_pipe,
2383                                         sc->transfer_data, sc->transfer_datalen,
2384                                         USBD_SHORT_XFER_OK,
2385                                         sc->transfer_xfer[XFER_CBI_DATA]))
2386                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2387
2388                 } else if (sc->transfer_dir == DIR_OUT) {
2389                         if (umass_setup_transfer(sc, sc->bulkout_pipe,
2390                                         sc->transfer_data, sc->transfer_datalen,
2391                                         0,      /* fixed length transfer */
2392                                         sc->transfer_xfer[XFER_CBI_DATA]))
2393                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2394
2395                 } else if (sc->proto & UMASS_PROTO_CBI_I) {
2396                         DPRINTF(UDMASS_CBI, ("%s: no data phase\n",
2397                                 device_get_nameunit(sc->sc_dev)));
2398                         sc->transfer_state = TSTATE_CBI_STATUS;
2399                         if (umass_setup_transfer(sc, sc->intrin_pipe,
2400                                         &sc->sbl, sizeof(sc->sbl),
2401                                         0,      /* fixed length transfer */
2402                                         sc->transfer_xfer[XFER_CBI_STATUS])){
2403                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2404                         }
2405                 } else {
2406                         DPRINTF(UDMASS_CBI, ("%s: no data phase\n",
2407                                 device_get_nameunit(sc->sc_dev)));
2408                         /* No command completion interrupt. Request
2409                          * sense data.
2410                          */
2411                         sc->transfer_state = TSTATE_IDLE;
2412                         sc->transfer_cb(sc, sc->transfer_priv,
2413                                0, STATUS_CMD_UNKNOWN);
2414                 }
2415
2416                 return;
2417
2418         case TSTATE_CBI_DATA:
2419                 /* retrieve the length of the transfer that was done */
2420                 usbd_get_xfer_status(xfer,NULL,NULL,&sc->transfer_actlen,NULL);
2421
2422                 if (err) {
2423                         DPRINTF(UDMASS_CBI, ("%s: Data-%s %db failed, "
2424                                 "%s\n", device_get_nameunit(sc->sc_dev),
2425                                 (sc->transfer_dir == DIR_IN?"in":"out"),
2426                                 sc->transfer_datalen,usbd_errstr(err)));
2427
2428                         if (err == USBD_STALLED) {
2429                                 umass_clear_endpoint_stall(sc,
2430                                         sc->bulkin, sc->bulkin_pipe,
2431                                         TSTATE_CBI_DCLEAR,
2432                                         sc->transfer_xfer[XFER_CBI_DCLEAR]);
2433                         } else {
2434                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2435                         }
2436                         return;
2437                 }
2438
2439                 DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN)
2440                                         umass_dump_buffer(sc, sc->transfer_data,
2441                                                 sc->transfer_actlen, 48));
2442
2443                 if (sc->proto & UMASS_PROTO_CBI_I) {
2444                         sc->transfer_state = TSTATE_CBI_STATUS;
2445                         if (umass_setup_transfer(sc, sc->intrin_pipe,
2446                                     &sc->sbl, sizeof(sc->sbl),
2447                                     0,  /* fixed length transfer */
2448                                     sc->transfer_xfer[XFER_CBI_STATUS])){
2449                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2450                         }
2451                 } else {
2452                         /* No command completion interrupt. Request
2453                          * sense to get status of command.
2454                          */
2455                         sc->transfer_state = TSTATE_IDLE;
2456                         sc->transfer_cb(sc, sc->transfer_priv,
2457                                 sc->transfer_datalen - sc->transfer_actlen,
2458                                 STATUS_CMD_UNKNOWN);
2459                 }
2460                 return;
2461
2462         case TSTATE_CBI_STATUS:
2463                 if (err) {
2464                         DPRINTF(UDMASS_CBI, ("%s: Status Transport failed\n",
2465                                 device_get_nameunit(sc->sc_dev)));
2466                         /* Status transport by interrupt pipe (section 2.3.2.2).
2467                          */
2468
2469                         if (err == USBD_STALLED) {
2470                                 umass_clear_endpoint_stall(sc,
2471                                         sc->intrin, sc->intrin_pipe,
2472                                         TSTATE_CBI_SCLEAR,
2473                                         sc->transfer_xfer[XFER_CBI_SCLEAR]);
2474                         } else {
2475                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2476                         }
2477                         return;
2478                 }
2479
2480                 /* Dissect the information in the buffer */
2481
2482                 if (sc->proto & UMASS_PROTO_UFI) {
2483                         int status;
2484
2485                         /* Section 3.4.3.1.3 specifies that the UFI command
2486                          * protocol returns an ASC and ASCQ in the interrupt
2487                          * data block.
2488                          */
2489
2490                         DPRINTF(UDMASS_CBI, ("%s: UFI CCI, ASC = 0x%02x, "
2491                                 "ASCQ = 0x%02x\n",
2492                                 device_get_nameunit(sc->sc_dev),
2493                                 sc->sbl.ufi.asc, sc->sbl.ufi.ascq));
2494
2495                         if (sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0)
2496                                 status = STATUS_CMD_OK;
2497                         else
2498                                 status = STATUS_CMD_FAILED;
2499
2500                         sc->transfer_state = TSTATE_IDLE;
2501                         sc->transfer_cb(sc, sc->transfer_priv,
2502                                 sc->transfer_datalen - sc->transfer_actlen,
2503                                 status);
2504                 } else {
2505                         /* Command Interrupt Data Block */
2506                         DPRINTF(UDMASS_CBI, ("%s: type=0x%02x, value=0x%02x\n",
2507                                 device_get_nameunit(sc->sc_dev),
2508                                 sc->sbl.common.type, sc->sbl.common.value));
2509
2510                         if (sc->sbl.common.type == IDB_TYPE_CCI) {
2511                                 int err;
2512
2513                                 if ((sc->sbl.common.value&IDB_VALUE_STATUS_MASK)
2514                                                         == IDB_VALUE_PASS) {
2515                                         err = STATUS_CMD_OK;
2516                                 } else if ((sc->sbl.common.value & IDB_VALUE_STATUS_MASK)
2517                                                         == IDB_VALUE_FAIL ||
2518                                            (sc->sbl.common.value & IDB_VALUE_STATUS_MASK)
2519                                                 == IDB_VALUE_PERSISTENT) {
2520                                         err = STATUS_CMD_FAILED;
2521                                 } else {
2522                                         err = STATUS_WIRE_FAILED;
2523                                 }
2524
2525                                 sc->transfer_state = TSTATE_IDLE;
2526                                 sc->transfer_cb(sc, sc->transfer_priv,
2527                                        sc->transfer_datalen-sc->transfer_actlen,
2528                                        err);
2529                         }
2530                 }
2531                 return;
2532
2533         case TSTATE_CBI_DCLEAR:
2534                 if (err) {      /* should not occur */
2535                         printf("%s: CBI bulk-in/out stall clear failed, %s\n",
2536                                device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2537                         umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2538                 }
2539
2540                 sc->transfer_state = TSTATE_IDLE;
2541                 sc->transfer_cb(sc, sc->transfer_priv,
2542                                 sc->transfer_datalen,
2543                                 STATUS_CMD_FAILED);
2544                 return;
2545
2546         case TSTATE_CBI_SCLEAR:
2547                 if (err)        /* should not occur */
2548                         printf("%s: CBI intr-in stall clear failed, %s\n",
2549                                device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2550
2551                 /* Something really bad is going on. Reset the device */
2552                 umass_cbi_reset(sc, STATUS_CMD_FAILED);
2553                 return;
2554
2555         /***** CBI Reset *****/
2556         case TSTATE_CBI_RESET1:
2557                 if (err)
2558                         printf("%s: CBI reset failed, %s\n",
2559                                 device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2560
2561                 umass_clear_endpoint_stall(sc,
2562                         sc->bulkin, sc->bulkin_pipe, TSTATE_CBI_RESET2,
2563                         sc->transfer_xfer[XFER_CBI_RESET2]);
2564
2565                 return;
2566         case TSTATE_CBI_RESET2:
2567                 if (err)        /* should not occur */
2568                         printf("%s: CBI bulk-in stall clear failed, %s\n",
2569                                device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2570                         /* no error recovery, otherwise we end up in a loop */
2571
2572                 umass_clear_endpoint_stall(sc,
2573                         sc->bulkout, sc->bulkout_pipe, TSTATE_CBI_RESET3,
2574                         sc->transfer_xfer[XFER_CBI_RESET3]);
2575
2576                 return;
2577         case TSTATE_CBI_RESET3:
2578                 if (err)        /* should not occur */
2579                         printf("%s: CBI bulk-out stall clear failed, %s\n",
2580                                device_get_nameunit(sc->sc_dev), usbd_errstr(err));
2581                         /* no error recovery, otherwise we end up in a loop */
2582
2583                 sc->transfer_state = TSTATE_IDLE;
2584                 if (sc->transfer_priv) {
2585                         sc->transfer_cb(sc, sc->transfer_priv,
2586                                         sc->transfer_datalen,
2587                                         sc->transfer_status);
2588                 }
2589
2590                 return;
2591
2592
2593         /***** Default *****/
2594         default:
2595                 panic("%s: Unknown state %d",
2596                       device_get_nameunit(sc->sc_dev), sc->transfer_state);
2597         }
2598 }
2599
2600
2601
2602
2603 /*
2604  * CAM specific functions (used by SCSI, UFI, 8070i (ATAPI))
2605  */
2606
2607 static int
2608 umass_cam_attach_sim(struct umass_softc *sc)
2609 {
2610         struct cam_devq *devq;          /* Per device Queue */
2611
2612         /* A HBA is attached to the CAM layer.
2613          *
2614          * The CAM layer will then after a while start probing for
2615          * devices on the bus. The number of SIMs is limited to one.
2616          */
2617
2618         devq = cam_simq_alloc(1 /*maximum openings*/);
2619         if (devq == NULL)
2620                 return(ENOMEM);
2621
2622         sc->umass_sim = cam_sim_alloc(umass_cam_action, umass_cam_poll,
2623                                 DEVNAME_SIM,
2624                                 sc /*priv*/,
2625                                 device_get_unit(sc->sc_dev) /*unit number*/,
2626                                 &Giant,
2627                                 1 /*maximum device openings*/,
2628                                 0 /*maximum tagged device openings*/,
2629                                 devq);
2630         if (sc->umass_sim == NULL) {
2631                 cam_simq_free(devq);
2632                 return(ENOMEM);
2633         }
2634
2635         if(xpt_bus_register(sc->umass_sim, NULL, device_get_unit(sc->sc_dev)) !=
2636             CAM_SUCCESS)
2637                 return(ENOMEM);
2638
2639         return(0);
2640 }
2641
2642 static void
2643 umass_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
2644 {
2645 #ifdef USB_DEBUG
2646         if (ccb->ccb_h.status != CAM_REQ_CMP) {
2647                 DPRINTF(UDMASS_SCSI, ("%s:%d Rescan failed, 0x%04x\n",
2648                         periph->periph_name, periph->unit_number,
2649                         ccb->ccb_h.status));
2650         } else {
2651                 DPRINTF(UDMASS_SCSI, ("%s%d: Rescan succeeded\n",
2652                         periph->periph_name, periph->unit_number));
2653         }
2654 #endif
2655
2656         xpt_free_path(ccb->ccb_h.path);
2657         free(ccb, M_USBDEV);
2658 }
2659
2660 static void
2661 umass_cam_rescan(void *addr)
2662 {
2663         struct umass_softc *sc = (struct umass_softc *) addr;
2664         struct cam_path *path;
2665         union ccb *ccb;
2666
2667         DPRINTF(UDMASS_SCSI, ("scbus%d: scanning for %s:%d:%d:%d\n",
2668                 cam_sim_path(sc->umass_sim),
2669                 device_get_nameunit(sc->sc_dev), cam_sim_path(sc->umass_sim),
2670                 device_get_unit(sc->sc_dev), CAM_LUN_WILDCARD));
2671
2672         ccb = malloc(sizeof(union ccb), M_USBDEV, M_NOWAIT | M_ZERO);
2673         if (ccb == NULL)
2674                 return;
2675         if (xpt_create_path(&path, xpt_periph, cam_sim_path(sc->umass_sim),
2676                             device_get_unit(sc->sc_dev), CAM_LUN_WILDCARD)
2677             != CAM_REQ_CMP) {
2678                 free(ccb, M_USBDEV);
2679                 return;
2680         }
2681
2682         xpt_setup_ccb(&ccb->ccb_h, path, 5/*priority (low)*/);
2683         ccb->ccb_h.func_code = XPT_SCAN_BUS;
2684         ccb->ccb_h.cbfcnp = umass_cam_rescan_callback;
2685         ccb->crcn.flags = CAM_FLAG_NONE;
2686         xpt_action(ccb);
2687
2688         /* The scan is in progress now. */
2689 }
2690
2691 static int
2692 umass_cam_attach(struct umass_softc *sc)
2693 {
2694 #ifndef USB_DEBUG
2695         if (bootverbose)
2696 #endif
2697                 printf("%s:%d:%d:%d: Attached to scbus%d\n",
2698                         device_get_nameunit(sc->sc_dev), cam_sim_path(sc->umass_sim),
2699                         device_get_unit(sc->sc_dev), CAM_LUN_WILDCARD,
2700                         cam_sim_path(sc->umass_sim));
2701
2702         if (!cold) {
2703                 /* Notify CAM of the new device after a short delay. Any
2704                  * failure is benign, as the user can still do it by hand
2705                  * (camcontrol rescan <busno>). Only do this if we are not
2706                  * booting, because CAM does a scan after booting has
2707                  * completed, when interrupts have been enabled.
2708                  */
2709
2710                 callout_reset(&sc->cam_scsi_rescan_ch, MS_TO_TICKS(200),
2711                     umass_cam_rescan, sc);
2712         }
2713
2714         return(0);      /* always succesfull */
2715 }
2716
2717 /* umass_cam_detach
2718  *      detach from the CAM layer
2719  */
2720
2721 static int
2722 umass_cam_detach_sim(struct umass_softc *sc)
2723 {
2724         if (sc->umass_sim) {
2725                 if (xpt_bus_deregister(cam_sim_path(sc->umass_sim)))
2726                         cam_sim_free(sc->umass_sim, /*free_devq*/TRUE);
2727                 else
2728                         return(EBUSY);
2729
2730                 sc->umass_sim = NULL;
2731         }
2732
2733         return(0);
2734 }
2735
2736 /* umass_cam_action
2737  *      CAM requests for action come through here
2738  */
2739
2740 static void
2741 umass_cam_action(struct cam_sim *sim, union ccb *ccb)
2742 {
2743         struct umass_softc *sc = (struct umass_softc *)sim->softc;
2744
2745         /* The softc is still there, but marked as going away. umass_cam_detach
2746          * has not yet notified CAM of the lost device however.
2747          */
2748         if (sc && (sc->flags & UMASS_FLAGS_GONE)) {
2749                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:func_code 0x%04x: "
2750                         "Invalid target (gone)\n",
2751                         device_get_nameunit(sc->sc_dev), cam_sim_path(sc->umass_sim),
2752                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2753                         ccb->ccb_h.func_code));
2754                 ccb->ccb_h.status = CAM_TID_INVALID;
2755                 xpt_done(ccb);
2756                 return;
2757         }
2758
2759         /* Verify, depending on the operation to perform, that we either got a
2760          * valid sc, because an existing target was referenced, or otherwise
2761          * the SIM is addressed.
2762          *
2763          * This avoids bombing out at a printf and does give the CAM layer some
2764          * sensible feedback on errors.
2765          */
2766         switch (ccb->ccb_h.func_code) {
2767         case XPT_SCSI_IO:
2768         case XPT_RESET_DEV:
2769         case XPT_GET_TRAN_SETTINGS:
2770         case XPT_SET_TRAN_SETTINGS:
2771         case XPT_CALC_GEOMETRY:
2772                 /* the opcodes requiring a target. These should never occur. */
2773                 if (sc == NULL) {
2774                         printf("%s:%d:%d:%d:func_code 0x%04x: "
2775                                 "Invalid target (target needed)\n",
2776                                 DEVNAME_SIM, cam_sim_path(sc->umass_sim),
2777                                 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2778                                 ccb->ccb_h.func_code);
2779
2780                         ccb->ccb_h.status = CAM_TID_INVALID;
2781                         xpt_done(ccb);
2782                         return;
2783                 }
2784                 break;
2785         case XPT_PATH_INQ:
2786         case XPT_NOOP:
2787                 /* The opcodes sometimes aimed at a target (sc is valid),
2788                  * sometimes aimed at the SIM (sc is invalid and target is
2789                  * CAM_TARGET_WILDCARD)
2790                  */
2791                 if (sc == NULL && ccb->ccb_h.target_id != CAM_TARGET_WILDCARD) {
2792                         DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:func_code 0x%04x: "
2793                                 "Invalid target (no wildcard)\n",
2794                                 DEVNAME_SIM, cam_sim_path(sc->umass_sim),
2795                                 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2796                                 ccb->ccb_h.func_code));
2797
2798                         ccb->ccb_h.status = CAM_TID_INVALID;
2799                         xpt_done(ccb);
2800                         return;
2801                 }
2802                 break;
2803         default:
2804                 /* XXX Hm, we should check the input parameters */
2805                 break;
2806         }
2807
2808         /* Perform the requested action */
2809         switch (ccb->ccb_h.func_code) {
2810         case XPT_SCSI_IO:
2811         {
2812                 struct ccb_scsiio *csio = &ccb->csio;   /* deref union */
2813                 int dir;
2814                 unsigned char *cmd;
2815                 int cmdlen;
2816                 unsigned char *rcmd;
2817                 int rcmdlen;
2818
2819                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_SCSI_IO: "
2820                         "cmd: 0x%02x, flags: 0x%02x, "
2821                         "%db cmd/%db data/%db sense\n",
2822                         device_get_nameunit(sc->sc_dev), cam_sim_path(sc->umass_sim),
2823                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2824                         csio->cdb_io.cdb_bytes[0],
2825                         ccb->ccb_h.flags & CAM_DIR_MASK,
2826                         csio->cdb_len, csio->dxfer_len,
2827                         csio->sense_len));
2828
2829                 /* clear the end of the buffer to make sure we don't send out
2830                  * garbage.
2831                  */
2832                 DIF(UDMASS_SCSI, if ((ccb->ccb_h.flags & CAM_DIR_MASK)
2833                                      == CAM_DIR_OUT)
2834                                         umass_dump_buffer(sc, csio->data_ptr,
2835                                                 csio->dxfer_len, 48));
2836
2837                 if (sc->transfer_state != TSTATE_IDLE) {
2838                         DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_SCSI_IO: "
2839                                 "I/O in progress, deferring (state %d, %s)\n",
2840                                 device_get_nameunit(sc->sc_dev), cam_sim_path(sc->umass_sim),
2841                                 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2842                                 sc->transfer_state,states[sc->transfer_state]));
2843                         ccb->ccb_h.status = CAM_SCSI_BUSY;
2844                         xpt_done(ccb);
2845                         return;
2846                 }
2847
2848                 switch(ccb->ccb_h.flags&CAM_DIR_MASK) {
2849                 case CAM_DIR_IN:
2850                         dir = DIR_IN;
2851                         break;
2852                 case CAM_DIR_OUT:
2853                         dir = DIR_OUT;
2854                         break;
2855                 default:
2856                         dir = DIR_NONE;
2857                 }
2858
2859                 ccb->ccb_h.status = CAM_REQ_INPROG | CAM_SIM_QUEUED;
2860
2861
2862                 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2863                         cmd = (unsigned char *) csio->cdb_io.cdb_ptr;
2864                 } else {
2865                         cmd = (unsigned char *) &csio->cdb_io.cdb_bytes;
2866                 }
2867                 cmdlen = csio->cdb_len;
2868                 rcmd = (unsigned char *) &sc->cam_scsi_command;
2869                 rcmdlen = sizeof(sc->cam_scsi_command);
2870
2871                 /* sc->transform will convert the command to the command
2872                  * (format) needed by the specific command set and return
2873                  * the converted command in a buffer pointed to be rcmd.
2874                  * We pass in a buffer, but if the command does not
2875                  * have to be transformed it returns a ptr to the original
2876                  * buffer (see umass_scsi_transform).
2877                  */
2878
2879                 switch (sc->transform(sc, cmd, cmdlen, &rcmd, &rcmdlen)) {
2880                 case 1:
2881                         /*
2882                          * Handle EVPD inquiry for broken devices first
2883                          * NO_INQUIRY also implies NO_INQUIRY_EVPD
2884                          */
2885                         if ((sc->quirks & (NO_INQUIRY_EVPD | NO_INQUIRY)) &&
2886                             rcmd[0] == INQUIRY && (rcmd[1] & SI_EVPD)) {
2887                                 struct scsi_sense_data *sense;
2888
2889                                 sense = &ccb->csio.sense_data;
2890                                 bzero(sense, sizeof(*sense));
2891                                 sense->error_code = SSD_CURRENT_ERROR;
2892                                 sense->flags = SSD_KEY_ILLEGAL_REQUEST;
2893                                 sense->add_sense_code = 0x24;
2894                                 sense->extra_len = 10;
2895                                 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2896                                 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR |
2897                                     CAM_AUTOSNS_VALID;
2898                                 xpt_done(ccb);
2899                                 return;
2900                         }
2901                         /* Return fake inquiry data for broken devices */
2902                         if ((sc->quirks & NO_INQUIRY) && rcmd[0] == INQUIRY) {
2903                                 struct ccb_scsiio *csio = &ccb->csio;
2904
2905                                 memcpy(csio->data_ptr, &fake_inq_data,
2906                                     sizeof(fake_inq_data));
2907                                 csio->scsi_status = SCSI_STATUS_OK;
2908                                 ccb->ccb_h.status = CAM_REQ_CMP;
2909                                 xpt_done(ccb);
2910                                 return;
2911                         }
2912                         if ((sc->quirks & NO_SYNCHRONIZE_CACHE) &&
2913                             rcmd[0] == SYNCHRONIZE_CACHE) {
2914                                 struct ccb_scsiio *csio = &ccb->csio;
2915
2916                                 csio->scsi_status = SCSI_STATUS_OK;
2917                                 ccb->ccb_h.status = CAM_REQ_CMP;
2918                                 xpt_done(ccb);
2919                                 return;
2920                         }
2921                         if ((sc->quirks & FORCE_SHORT_INQUIRY) &&
2922                             rcmd[0] == INQUIRY) {
2923                                 csio->dxfer_len = SHORT_INQUIRY_LENGTH;
2924                         }
2925                         sc->transfer(sc, ccb->ccb_h.target_lun, rcmd, rcmdlen,
2926                                      csio->data_ptr,
2927                                      csio->dxfer_len, dir, ccb->ccb_h.timeout,
2928                                      umass_cam_cb, (void *) ccb);
2929                         break;
2930                 case 0:
2931                         ccb->ccb_h.status = CAM_REQ_INVALID;
2932                         xpt_done(ccb);
2933                         break;
2934                 case 2:
2935                         ccb->ccb_h.status = CAM_REQ_CMP;
2936                         xpt_done(ccb);
2937                         break;
2938                 }
2939
2940                 break;
2941         }
2942         case XPT_PATH_INQ:
2943         {
2944                 struct ccb_pathinq *cpi = &ccb->cpi;
2945
2946                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_PATH_INQ:.\n",
2947                         (sc == NULL? DEVNAME_SIM:device_get_nameunit(sc->sc_dev)),
2948                         cam_sim_path(sc->umass_sim),
2949                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
2950
2951                 /* host specific information */
2952                 cpi->version_num = 1;
2953                 cpi->hba_inquiry = 0;
2954                 cpi->target_sprt = 0;
2955                 cpi->hba_misc = PIM_NO_6_BYTE;
2956                 cpi->hba_eng_cnt = 0;
2957                 cpi->max_target = UMASS_SCSIID_MAX;     /* one target */
2958                 cpi->initiator_id = UMASS_SCSIID_HOST;
2959                 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2960                 strncpy(cpi->hba_vid, "USB SCSI", HBA_IDLEN);
2961                 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2962                 cpi->unit_number = cam_sim_unit(sim);
2963                 cpi->bus_id = device_get_unit(sc->sc_dev);
2964                 cpi->protocol = PROTO_SCSI;
2965                 cpi->protocol_version = SCSI_REV_2;
2966                 cpi->transport = XPORT_USB;
2967                 cpi->transport_version = 0;
2968
2969                 if (sc == NULL) {
2970                         cpi->base_transfer_speed = 0;
2971                         cpi->max_lun = 0;
2972                 } else {
2973                         if (sc->quirks & FLOPPY_SPEED) {
2974                                 cpi->base_transfer_speed =
2975                                     UMASS_FLOPPY_TRANSFER_SPEED;
2976                         } else if (usbd_get_speed(sc->sc_udev) ==
2977                             USB_SPEED_HIGH) {
2978                                 cpi->base_transfer_speed =
2979                                     UMASS_HIGH_TRANSFER_SPEED;
2980                         } else {
2981                                 cpi->base_transfer_speed =
2982                                     UMASS_FULL_TRANSFER_SPEED;
2983                         }
2984                         cpi->max_lun = sc->maxlun;
2985                 }
2986
2987                 cpi->ccb_h.status = CAM_REQ_CMP;
2988                 xpt_done(ccb);
2989                 break;
2990         }
2991         case XPT_RESET_DEV:
2992         {
2993                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_RESET_DEV:.\n",
2994                         device_get_nameunit(sc->sc_dev), cam_sim_path(sc->umass_sim),
2995                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
2996
2997                 ccb->ccb_h.status = CAM_REQ_INPROG;
2998                 umass_reset(sc, umass_cam_cb, (void *) ccb);
2999                 break;
3000         }
3001         case XPT_GET_TRAN_SETTINGS:
3002         {
3003                 struct ccb_trans_settings *cts = &ccb->cts;
3004                 cts->protocol = PROTO_SCSI;
3005                 cts->protocol_version = SCSI_REV_2;
3006                 cts->transport = XPORT_USB;
3007                 cts->transport_version = 0;
3008                 cts->xport_specific.valid = 0;
3009
3010
3011                 ccb->ccb_h.status = CAM_REQ_CMP;
3012                 xpt_done(ccb);
3013                 break;
3014         }
3015         case XPT_SET_TRAN_SETTINGS:
3016         {
3017                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_SET_TRAN_SETTINGS:.\n",
3018                         device_get_nameunit(sc->sc_dev), cam_sim_path(sc->umass_sim),
3019                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
3020
3021                 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
3022                 xpt_done(ccb);
3023                 break;
3024         }
3025         case XPT_CALC_GEOMETRY:
3026         {
3027                 cam_calc_geometry(&ccb->ccg, /*extended*/1);
3028                 xpt_done(ccb);
3029                 break;
3030         }
3031         case XPT_NOOP:
3032         {
3033                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_NOOP:.\n",
3034                         (sc == NULL? DEVNAME_SIM:device_get_nameunit(sc->sc_dev)),
3035                         cam_sim_path(sc->umass_sim),
3036                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
3037
3038                 ccb->ccb_h.status = CAM_REQ_CMP;
3039                 xpt_done(ccb);
3040                 break;
3041         }
3042         default:
3043                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:func_code 0x%04x: "
3044                         "Not implemented\n",
3045                         (sc == NULL? DEVNAME_SIM:device_get_nameunit(sc->sc_dev)),
3046                         cam_sim_path(sc->umass_sim),
3047                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
3048                         ccb->ccb_h.func_code));
3049
3050                 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
3051                 xpt_done(ccb);
3052                 break;
3053         }
3054 }
3055
3056 static void
3057 umass_cam_poll(struct cam_sim *sim)
3058 {
3059         struct umass_softc *sc = (struct umass_softc *) sim->softc;
3060
3061         DPRINTF(UDMASS_SCSI, ("%s: CAM poll\n",
3062                 device_get_nameunit(sc->sc_dev)));
3063
3064         usbd_set_polling(sc->sc_udev, 1);
3065         usbd_dopoll(sc->iface);
3066         usbd_set_polling(sc->sc_udev, 0);
3067 }
3068
3069
3070 /* umass_cam_cb
3071  *      finalise a completed CAM command
3072  */
3073
3074 static void
3075 umass_cam_cb(struct umass_softc *sc, void *priv, int residue, int status)
3076 {
3077         union ccb *ccb = (union ccb *) priv;
3078         struct ccb_scsiio *csio = &ccb->csio;           /* deref union */
3079
3080         /* If the device is gone, just fail the request. */
3081         if (sc->flags & UMASS_FLAGS_GONE) {
3082                 ccb->ccb_h.status = CAM_TID_INVALID;
3083                 xpt_done(ccb);
3084                 return;
3085         }
3086
3087         csio->resid = residue;
3088
3089         switch (status) {
3090         case STATUS_CMD_OK:
3091                 ccb->ccb_h.status = CAM_REQ_CMP;
3092                 if ((sc->quirks & READ_CAPACITY_OFFBY1) &&
3093                     (ccb->ccb_h.func_code == XPT_SCSI_IO) &&
3094                     (csio->cdb_io.cdb_bytes[0] == READ_CAPACITY)) {
3095                         struct scsi_read_capacity_data *rcap;
3096                         uint32_t maxsector;
3097
3098                         rcap = (struct scsi_read_capacity_data *)csio->data_ptr;
3099                         maxsector = scsi_4btoul(rcap->addr) - 1;
3100                         scsi_ulto4b(maxsector, rcap->addr);
3101                 }
3102                 xpt_done(ccb);
3103                 break;
3104
3105         case STATUS_CMD_UNKNOWN:
3106         case STATUS_CMD_FAILED:
3107                 switch (ccb->ccb_h.func_code) {
3108                 case XPT_SCSI_IO:
3109                 {
3110                         unsigned char *rcmd;
3111                         int rcmdlen;
3112
3113                         /* fetch sense data */
3114                         /* the rest of the command was filled in at attach */
3115                         sc->cam_scsi_sense.length = csio->sense_len;
3116
3117                         DPRINTF(UDMASS_SCSI,("%s: Fetching %db sense data\n",
3118                                 device_get_nameunit(sc->sc_dev), csio->sense_len));
3119
3120                         rcmd = (unsigned char *) &sc->cam_scsi_command;
3121                         rcmdlen = sizeof(sc->cam_scsi_command);
3122
3123                         if (sc->transform(sc,
3124                                     (unsigned char *) &sc->cam_scsi_sense,
3125                                     sizeof(sc->cam_scsi_sense),
3126                                     &rcmd, &rcmdlen) == 1) {
3127                                 if ((sc->quirks & FORCE_SHORT_INQUIRY) && (rcmd[0] == INQUIRY)) {
3128                                         csio->sense_len = SHORT_INQUIRY_LENGTH;
3129                                 }
3130                                 sc->transfer(sc, ccb->ccb_h.target_lun,
3131                                              rcmd, rcmdlen,
3132                                              &csio->sense_data,
3133                                              csio->sense_len, DIR_IN, ccb->ccb_h.timeout,
3134                                              umass_cam_sense_cb, (void *) ccb);
3135                         } else {
3136                                 panic("transform(REQUEST_SENSE) failed");
3137                         }
3138                         break;
3139                 }
3140                 case XPT_RESET_DEV: /* Reset failed */
3141                         ccb->ccb_h.status = CAM_REQ_CMP_ERR;
3142                         xpt_done(ccb);
3143                         break;
3144                 default:
3145                         panic("umass_cam_cb called for func_code %d",
3146                               ccb->ccb_h.func_code);
3147                 }
3148                 break;
3149
3150         case STATUS_WIRE_FAILED:
3151                 /* the wire protocol failed and will have recovered
3152                  * (hopefully).  We return an error to CAM and let CAM retry
3153                  * the command if necessary.
3154                  */
3155                 ccb->ccb_h.status = CAM_REQ_CMP_ERR;
3156                 xpt_done(ccb);
3157                 break;
3158         default:
3159                 panic("%s: Unknown status %d in umass_cam_cb",
3160                         device_get_nameunit(sc->sc_dev), status);
3161         }
3162 }
3163
3164 /* Finalise a completed autosense operation
3165  */
3166 static void
3167 umass_cam_sense_cb(struct umass_softc *sc, void *priv, int residue, int status)
3168 {
3169         union ccb *ccb = (union ccb *) priv;
3170         struct ccb_scsiio *csio = &ccb->csio;           /* deref union */
3171         unsigned char *rcmd;
3172         int rcmdlen;
3173
3174         if (sc->flags & UMASS_FLAGS_GONE) {
3175                 ccb->ccb_h.status = CAM_AUTOSENSE_FAIL;
3176                 xpt_done(ccb);
3177                 return;
3178         }
3179
3180         switch (status) {
3181         case STATUS_CMD_OK:
3182         case STATUS_CMD_UNKNOWN:
3183         case STATUS_CMD_FAILED:
3184                 /* Getting sense data always succeeds (apart from wire
3185                  * failures).
3186                  */
3187                 if ((sc->quirks & RS_NO_CLEAR_UA)
3188                     && csio->cdb_io.cdb_bytes[0] == INQUIRY
3189                     && (csio->sense_data.flags & SSD_KEY)
3190                                                 == SSD_KEY_UNIT_ATTENTION) {
3191                         /* Ignore unit attention errors in the case where
3192                          * the Unit Attention state is not cleared on
3193                          * REQUEST SENSE. They will appear again at the next
3194                          * command.
3195                          */
3196                         ccb->ccb_h.status = CAM_REQ_CMP;
3197                 } else if ((csio->sense_data.flags & SSD_KEY)
3198                                                 == SSD_KEY_NO_SENSE) {
3199                         /* No problem after all (in the case of CBI without
3200                          * CCI)
3201                          */
3202                         ccb->ccb_h.status = CAM_REQ_CMP;
3203                 } else if ((sc->quirks & RS_NO_CLEAR_UA) &&
3204                            (csio->cdb_io.cdb_bytes[0] == READ_CAPACITY) &&
3205                            ((csio->sense_data.flags & SSD_KEY)
3206                             == SSD_KEY_UNIT_ATTENTION)) {
3207                         /*
3208                          * Some devices do not clear the unit attention error
3209                          * on request sense. We insert a test unit ready
3210                          * command to make sure we clear the unit attention
3211                          * condition, then allow the retry to proceed as
3212                          * usual.
3213                          */
3214
3215                         ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
3216                                             | CAM_AUTOSNS_VALID;
3217                         csio->scsi_status = SCSI_STATUS_CHECK_COND;
3218
3219 #if 0
3220                         DELAY(300000);
3221 #endif
3222
3223                         DPRINTF(UDMASS_SCSI,("%s: Doing a sneaky"
3224                                              "TEST_UNIT_READY\n",
3225                                 device_get_nameunit(sc->sc_dev)));
3226
3227                         /* the rest of the command was filled in at attach */
3228
3229                         rcmd = (unsigned char *) &sc->cam_scsi_command2;
3230                         rcmdlen = sizeof(sc->cam_scsi_command2);
3231
3232                         if (sc->transform(sc,
3233                                         (unsigned char *)
3234                                         &sc->cam_scsi_test_unit_ready,
3235                                         sizeof(sc->cam_scsi_test_unit_ready),
3236                                         &rcmd, &rcmdlen) == 1) {
3237                                 sc->transfer(sc, ccb->ccb_h.target_lun,
3238                                              rcmd, rcmdlen,
3239                                              NULL, 0, DIR_NONE, ccb->ccb_h.timeout,
3240                                              umass_cam_quirk_cb, (void *) ccb);
3241                         } else {
3242                                 panic("transform(TEST_UNIT_READY) failed");
3243                         }
3244                         break;
3245                 } else {
3246                         ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
3247                                             | CAM_AUTOSNS_VALID;
3248                         csio->scsi_status = SCSI_STATUS_CHECK_COND;
3249                 }
3250                 xpt_done(ccb);
3251                 break;
3252
3253         default:
3254                 DPRINTF(UDMASS_SCSI, ("%s: Autosense failed, status %d\n",
3255                         device_get_nameunit(sc->sc_dev), status));
3256                 ccb->ccb_h.status = CAM_AUTOSENSE_FAIL;
3257                 xpt_done(ccb);
3258         }
3259 }
3260
3261 /*
3262  * This completion code just handles the fact that we sent a test-unit-ready
3263  * after having previously failed a READ CAPACITY with CHECK_COND.  Even
3264  * though this command succeeded, we have to tell CAM to retry.
3265  */
3266 static void
3267 umass_cam_quirk_cb(struct umass_softc *sc, void *priv, int residue, int status)
3268 {
3269         union ccb *ccb = (union ccb *) priv;
3270
3271         DPRINTF(UDMASS_SCSI, ("%s: Test unit ready returned status %d\n",
3272         device_get_nameunit(sc->sc_dev), status));
3273
3274         if (sc->flags & UMASS_FLAGS_GONE) {
3275                 ccb->ccb_h.status = CAM_TID_INVALID;
3276                 xpt_done(ccb);
3277                 return;
3278         }
3279 #if 0
3280         ccb->ccb_h.status = CAM_REQ_CMP;
3281 #endif
3282         ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
3283                             | CAM_AUTOSNS_VALID;
3284         ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
3285         xpt_done(ccb);
3286 }
3287
3288 /*
3289  * SCSI specific functions
3290  */
3291
3292 static int
3293 umass_scsi_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
3294                      unsigned char **rcmd, int *rcmdlen)
3295 {
3296         switch (cmd[0]) {
3297         case TEST_UNIT_READY:
3298                 if (sc->quirks & NO_TEST_UNIT_READY) {
3299                         KASSERT(*rcmdlen >= sizeof(struct scsi_start_stop_unit),
3300                                 ("rcmdlen = %d < %ld, buffer too small",
3301                                  *rcmdlen,
3302                                  (long)sizeof(struct scsi_start_stop_unit)));
3303                         DPRINTF(UDMASS_SCSI, ("%s: Converted TEST_UNIT_READY "
3304                                 "to START_UNIT\n", device_get_nameunit(sc->sc_dev)));
3305                         memset(*rcmd, 0, *rcmdlen);
3306                         (*rcmd)[0] = START_STOP_UNIT;
3307                         (*rcmd)[4] = SSS_START;
3308                         return 1;
3309                 }
3310                 /* fallthrough */
3311         case INQUIRY:
3312                 /* some drives wedge when asked for full inquiry information. */
3313                 if (sc->quirks & FORCE_SHORT_INQUIRY) {
3314                         memcpy(*rcmd, cmd, cmdlen);
3315                         *rcmdlen = cmdlen;
3316                         (*rcmd)[4] = SHORT_INQUIRY_LENGTH;
3317                         return 1;
3318                 }
3319                 /* fallthrough */
3320         default:
3321                 *rcmd = cmd;            /* We don't need to copy it */
3322                 *rcmdlen = cmdlen;
3323         }
3324
3325         return 1;
3326 }
3327 /* RBC specific functions */
3328 static int
3329 umass_rbc_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
3330                      unsigned char **rcmd, int *rcmdlen)
3331 {
3332         switch (cmd[0]) {
3333         /* these commands are defined in RBC: */
3334         case READ_10:
3335         case READ_CAPACITY:
3336         case START_STOP_UNIT:
3337         case SYNCHRONIZE_CACHE:
3338         case WRITE_10:
3339         case 0x2f: /* VERIFY_10 is absent from scsi_all.h??? */
3340         case INQUIRY:
3341         case MODE_SELECT_10:
3342         case MODE_SENSE_10:
3343         case TEST_UNIT_READY:
3344         case WRITE_BUFFER:
3345          /* The following commands are not listed in my copy of the RBC specs.
3346           * CAM however seems to want those, and at least the Sony DSC device
3347           * appears to support those as well */
3348         case REQUEST_SENSE:
3349         case PREVENT_ALLOW:
3350                 if ((sc->quirks & RBC_PAD_TO_12) && cmdlen < 12) {
3351                         *rcmdlen = 12;
3352                         bcopy(cmd, *rcmd, cmdlen);
3353                         bzero(*rcmd + cmdlen, 12 - cmdlen);
3354                 } else {
3355                         *rcmd = cmd;            /* We don't need to copy it */
3356                         *rcmdlen = cmdlen;
3357                 }
3358                 return 1;
3359         /* All other commands are not legal in RBC */
3360         default:
3361                 printf("%s: Unsupported RBC command 0x%02x",
3362                         device_get_nameunit(sc->sc_dev), cmd[0]);
3363                 printf("\n");
3364                 return 0;       /* failure */
3365         }
3366 }
3367
3368 /*
3369  * UFI specific functions
3370  */
3371 static int
3372 umass_ufi_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
3373                     unsigned char **rcmd, int *rcmdlen)
3374 {
3375         /* A UFI command is always 12 bytes in length */
3376         KASSERT(*rcmdlen >= UFI_COMMAND_LENGTH,
3377                 ("rcmdlen = %d < %d, buffer too small",
3378                  *rcmdlen, UFI_COMMAND_LENGTH));
3379
3380         *rcmdlen = UFI_COMMAND_LENGTH;
3381         memset(*rcmd, 0, UFI_COMMAND_LENGTH);
3382
3383         switch (cmd[0]) {
3384         /* Commands of which the format has been verified. They should work.
3385          * Copy the command into the (zeroed out) destination buffer.
3386          */
3387         case TEST_UNIT_READY:
3388                 if (sc->quirks &  NO_TEST_UNIT_READY) {
3389                         /* Some devices do not support this command.
3390                          * Start Stop Unit should give the same results
3391                          */
3392                         DPRINTF(UDMASS_UFI, ("%s: Converted TEST_UNIT_READY "
3393                                 "to START_UNIT\n", device_get_nameunit(sc->sc_dev)));
3394                         (*rcmd)[0] = START_STOP_UNIT;
3395                         (*rcmd)[4] = SSS_START;
3396                 } else {
3397                         memcpy(*rcmd, cmd, cmdlen);
3398                 }
3399                 return 1;
3400
3401         case REZERO_UNIT:
3402         case REQUEST_SENSE:
3403         case FORMAT_UNIT:
3404         case INQUIRY:
3405         case START_STOP_UNIT:
3406         case SEND_DIAGNOSTIC:
3407         case PREVENT_ALLOW:
3408         case READ_CAPACITY:
3409         case READ_10:
3410         case WRITE_10:
3411         case POSITION_TO_ELEMENT:       /* SEEK_10 */
3412         case WRITE_AND_VERIFY:
3413         case VERIFY:
3414         case MODE_SELECT_10:
3415         case MODE_SENSE_10:
3416         case READ_12:
3417         case WRITE_12:
3418         case READ_FORMAT_CAPACITIES:
3419                 memcpy(*rcmd, cmd, cmdlen);
3420                 return 1;
3421
3422         /*
3423          * SYNCHRONIZE_CACHE isn't supported by UFI, nor should it be
3424          * required for UFI devices, so it is appropriate to fake
3425          * success.
3426          */
3427         case SYNCHRONIZE_CACHE:
3428                 return 2;
3429
3430         default:
3431                 printf("%s: Unsupported UFI command 0x%02x\n",
3432                         device_get_nameunit(sc->sc_dev), cmd[0]);
3433                 return 0;       /* failure */
3434         }
3435 }
3436
3437 /*
3438  * 8070i (ATAPI) specific functions
3439  */
3440 static int
3441 umass_atapi_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
3442                       unsigned char **rcmd, int *rcmdlen)
3443 {
3444         /* An ATAPI command is always 12 bytes in length. */
3445         KASSERT(*rcmdlen >= ATAPI_COMMAND_LENGTH,
3446                 ("rcmdlen = %d < %d, buffer too small",
3447                  *rcmdlen, ATAPI_COMMAND_LENGTH));
3448
3449         *rcmdlen = ATAPI_COMMAND_LENGTH;
3450         memset(*rcmd, 0, ATAPI_COMMAND_LENGTH);
3451
3452         switch (cmd[0]) {
3453         /* Commands of which the format has been verified. They should work.
3454          * Copy the command into the (zeroed out) destination buffer.
3455          */
3456         case INQUIRY:
3457                 memcpy(*rcmd, cmd, cmdlen);
3458                 /* some drives wedge when asked for full inquiry information. */
3459                 if (sc->quirks & FORCE_SHORT_INQUIRY)
3460                         (*rcmd)[4] = SHORT_INQUIRY_LENGTH;
3461                 return 1;
3462
3463         case TEST_UNIT_READY:
3464                 if (sc->quirks & NO_TEST_UNIT_READY) {
3465                         KASSERT(*rcmdlen >= sizeof(struct scsi_start_stop_unit),
3466                                 ("rcmdlen = %d < %ld, buffer too small",
3467                                  *rcmdlen,
3468                                  (long)sizeof(struct scsi_start_stop_unit)));
3469                         DPRINTF(UDMASS_SCSI, ("%s: Converted TEST_UNIT_READY "
3470                                 "to START_UNIT\n", device_get_nameunit(sc->sc_dev)));
3471                         memset(*rcmd, 0, *rcmdlen);
3472                         (*rcmd)[0] = START_STOP_UNIT;
3473                         (*rcmd)[4] = SSS_START;
3474                         return 1;
3475                 }
3476                 /* fallthrough */
3477         case REZERO_UNIT:
3478         case REQUEST_SENSE:
3479         case START_STOP_UNIT:
3480         case SEND_DIAGNOSTIC:
3481         case PREVENT_ALLOW:
3482         case READ_CAPACITY:
3483         case READ_10:
3484         case WRITE_10:
3485         case POSITION_TO_ELEMENT:       /* SEEK_10 */
3486         case SYNCHRONIZE_CACHE:
3487         case MODE_SELECT_10:
3488         case MODE_SENSE_10:
3489         case READ_BUFFER:
3490         case 0x42: /* READ_SUBCHANNEL */
3491         case 0x43: /* READ_TOC */
3492         case 0x44: /* READ_HEADER */
3493         case 0x47: /* PLAY_MSF (Play Minute/Second/Frame) */
3494         case 0x48: /* PLAY_TRACK */
3495         case 0x49: /* PLAY_TRACK_REL */
3496         case 0x4b: /* PAUSE */
3497         case 0x51: /* READ_DISK_INFO */
3498         case 0x52: /* READ_TRACK_INFO */
3499         case 0x54: /* SEND_OPC */
3500         case 0x59: /* READ_MASTER_CUE */
3501         case 0x5b: /* CLOSE_TR_SESSION */
3502         case 0x5c: /* READ_BUFFER_CAP */
3503         case 0x5d: /* SEND_CUE_SHEET */
3504         case 0xa1: /* BLANK */
3505         case 0xa5: /* PLAY_12 */
3506         case 0xa6: /* EXCHANGE_MEDIUM */
3507         case 0xad: /* READ_DVD_STRUCTURE */
3508         case 0xbb: /* SET_CD_SPEED */
3509         case 0xe5: /* READ_TRACK_INFO_PHILIPS */
3510                 memcpy(*rcmd, cmd, cmdlen);
3511                 return 1;
3512
3513         case READ_12:
3514         case WRITE_12:
3515         default:
3516                 printf("%s: Unsupported ATAPI command 0x%02x"
3517                         " - trying anyway\n",
3518                         device_get_nameunit(sc->sc_dev), cmd[0]);
3519                 memcpy(*rcmd, cmd, cmdlen);
3520                 return 1;
3521         }
3522 }
3523
3524
3525 /* (even the comment is missing) */
3526
3527 DRIVER_MODULE(umass, uhub, umass_driver, umass_devclass, usbd_driver_load, 0);
3528
3529
3530
3531 #ifdef USB_DEBUG
3532 static void
3533 umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw)
3534 {
3535         int clen = cbw->bCDBLength;
3536         int dlen = UGETDW(cbw->dCBWDataTransferLength);
3537         u_int8_t *c = cbw->CBWCDB;
3538         int tag = UGETDW(cbw->dCBWTag);
3539         int flags = cbw->bCBWFlags;
3540
3541         DPRINTF(UDMASS_BBB, ("%s: CBW %d: cmd = %db "
3542                 "(0x%02x%02x%02x%02x%02x%02x%s), "
3543                 "data = %db, dir = %s\n",
3544                 device_get_nameunit(sc->sc_dev), tag, clen,
3545                 c[0], c[1], c[2], c[3], c[4], c[5], (clen > 6? "...":""),
3546                 dlen, (flags == CBWFLAGS_IN? "in":
3547                        (flags == CBWFLAGS_OUT? "out":"<invalid>"))));
3548 }
3549
3550 static void
3551 umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw)
3552 {
3553         int sig = UGETDW(csw->dCSWSignature);
3554         int tag = UGETW(csw->dCSWTag);
3555         int res = UGETDW(csw->dCSWDataResidue);
3556         int status = csw->bCSWStatus;
3557
3558         DPRINTF(UDMASS_BBB, ("%s: CSW %d: sig = 0x%08x (%s), tag = %d, "
3559                 "res = %d, status = 0x%02x (%s)\n", device_get_nameunit(sc->sc_dev),
3560                 tag, sig, (sig == CSWSIGNATURE?  "valid":"invalid"),
3561                 tag, res,
3562                 status, (status == CSWSTATUS_GOOD? "good":
3563                          (status == CSWSTATUS_FAILED? "failed":
3564                           (status == CSWSTATUS_PHASE? "phase":"<invalid>")))));
3565 }
3566
3567 static void
3568 umass_cbi_dump_cmd(struct umass_softc *sc, void *cmd, int cmdlen)
3569 {
3570         u_int8_t *c = cmd;
3571         int dir = sc->transfer_dir;
3572
3573         DPRINTF(UDMASS_BBB, ("%s: cmd = %db "
3574                 "(0x%02x%02x%02x%02x%02x%02x%s), "
3575                 "data = %db, dir = %s\n",
3576                 device_get_nameunit(sc->sc_dev), cmdlen,
3577                 c[0], c[1], c[2], c[3], c[4], c[5], (cmdlen > 6? "...":""),
3578                 sc->transfer_datalen,
3579                 (dir == DIR_IN? "in":
3580                  (dir == DIR_OUT? "out":
3581                   (dir == DIR_NONE? "no data phase": "<invalid>")))));
3582 }
3583
3584 static void
3585 umass_dump_buffer(struct umass_softc *sc, u_int8_t *buffer, int buflen,
3586                   int printlen)
3587 {
3588         int i, j;
3589         char s1[40];
3590         char s2[40];
3591         char s3[5];
3592
3593         s1[0] = '\0';
3594         s3[0] = '\0';
3595
3596         sprintf(s2, " buffer=%p, buflen=%d", buffer, buflen);
3597         for (i = 0; i < buflen && i < printlen; i++) {
3598                 j = i % 16;
3599                 if (j == 0 && i != 0) {
3600                         DPRINTF(UDMASS_GEN, ("%s: 0x %s%s\n",
3601                                 device_get_nameunit(sc->sc_dev), s1, s2));
3602                         s2[0] = '\0';
3603                 }
3604                 sprintf(&s1[j*2], "%02x", buffer[i] & 0xff);
3605         }
3606         if (buflen > printlen)
3607                 sprintf(s3, " ...");
3608         DPRINTF(UDMASS_GEN, ("%s: 0x %s%s%s\n",
3609                 device_get_nameunit(sc->sc_dev), s1, s2, s3));
3610 }
3611 #endif