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