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  * $DragonFly: src/sys/dev/usbmisc/umass/umass.c,v 1.11 2004/03/15 05:45:19 dillon Exp $
  30  */
  31
  32 /*
  33  * Universal Serial Bus Mass Storage Class specs:
  34  * http://www.usb.org/developers/data/devclass/usbmassover_11.pdf
  35  * http://www.usb.org/developers/data/devclass/usbmassbulk_10.pdf
  36  * http://www.usb.org/developers/data/devclass/usbmass-cbi10.pdf
  37  * http://www.usb.org/developers/data/devclass/usbmass-ufi10.pdf
  38  */
  39
  40 /*
  41  * Ported to NetBSD by Lennart Augustsson <augustss@netbsd.org>.
  42  * Parts of the code written my Jason R. Thorpe <thorpej@shagadelic.org>.
  43  */
  44
  45 /*
  46  * The driver handles 3 Wire Protocols
  47  * - Command/Bulk/Interrupt (CBI)
  48  * - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI)
  49  * - Mass Storage Bulk-Only (BBB)
  50  *   (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases)
  51  *
  52  * Over these wire protocols it handles the following command protocols
  53  * - SCSI
  54  * - UFI (floppy command set)
  55  * - 8070i (ATAPI)
  56  *
  57  * UFI and 8070i (ATAPI) are transformed versions of the SCSI command set. The
  58  * sc->transform method is used to convert the commands into the appropriate
  59  * format (if at all necessary). For example, UFI requires all commands to be
  60  * 12 bytes in length amongst other things.
  61  *
  62  * The source code below is marked and can be split into a number of pieces
  63  * (in this order):
  64  *
  65  * - probe/attach/detach
  66  * - generic transfer routines
  67  * - BBB
  68  * - CBI
  69  * - CBI_I (in addition to functions from CBI)
  70  * - CAM (Common Access Method)
  71  * - SCSI
  72  * - UFI
  73  * - 8070i (ATAPI)
  74  *
  75  * The protocols are implemented using a state machine, for the transfers as
  76  * well as for the resets. The state machine is contained in umass_*_state.
  77  * The state machine is started through either umass_*_transfer or
  78  * umass_*_reset.
  79  *
  80  * The reason for doing this is a) CAM performs a lot better this way and b) it
  81  * avoids using tsleep from interrupt context (for example after a failed
  82  * transfer).
  83  */
  84
  85 /*
  86  * The SCSI related part of this driver has been derived from the
  87  * dev/ppbus/vpo.c driver, by Nicolas Souchu (nsouch@freebsd.org).
  88  *
  89  * The CAM layer uses so called actions which are messages sent to the host
  90  * adapter for completion. The actions come in through umass_cam_action. The
  91  * appropriate block of routines is called depending on the transport protocol
  92  * in use. When the transfer has finished, these routines call
  93  * umass_cam_cb again to complete the CAM command.
  94  */
  95
  96 /*
  97  * XXX Currently CBI with CCI is not supported because it bombs the system
  98  *     when the device is detached (low frequency interrupts are detached
  99  *     too late.
 100  */
 101 #undef CBI_I
 102
 103 #include <sys/param.h>
 104 #include <sys/systm.h>
 105 #include <sys/kernel.h>
 106 #include <sys/module.h>
 107 #include <sys/bus.h>
 108 #include <sys/sysctl.h>
 109
 110 #include <bus/usb/usb.h>
 111 #include <bus/usb/usbdi.h>
 112 #include <bus/usb/usbdi_util.h>
 113 #include <bus/usb/usbdevs.h>
 114
 115 #include <bus/cam/cam.h>
 116 #include <bus/cam/cam_ccb.h>
 117 #include <bus/cam/cam_sim.h>
 118 #include <bus/cam/cam_xpt_sim.h>
 119 #include <bus/cam/scsi/scsi_all.h>
 120 #include <bus/cam/scsi/scsi_da.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)) logprintf 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 #define UMASS_DEFAULT_TRANSFER_SPEED    1000
 160 #define UMASS_FLOPPY_TRANSFER_SPEED     20
 161
 162 #define UMASS_TIMEOUT                   5000 /* msecs */
 163
 164 /* CAM specific definitions */
 165
 166 #define UMASS_SCSIID_MAX        1       /* maximum number of drives expected */
 167 #define UMASS_SCSIID_HOST       UMASS_SCSIID_MAX
 168
 169 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
 170
 171
 172 /* Bulk-Only features */
 173
 174 #define UR_BBB_RESET            0xff            /* Bulk-Only reset */
 175 #define UR_BBB_GET_MAX_LUN      0xfe            /* Get maximum lun */
 176
 177 /* Command Block Wrapper */
 178 typedef struct {
 179         uDWord          dCBWSignature;
 180 #       define CBWSIGNATURE     0x43425355
 181         uDWord          dCBWTag;
 182         uDWord          dCBWDataTransferLength;
 183         uByte           bCBWFlags;
 184 #       define CBWFLAGS_OUT     0x00
 185 #       define CBWFLAGS_IN      0x80
 186         uByte           bCBWLUN;
 187         uByte           bCDBLength;
 188 #       define CBWCDBLENGTH     16
 189         uByte           CBWCDB[CBWCDBLENGTH];
 190 } umass_bbb_cbw_t;
 191 #define UMASS_BBB_CBW_SIZE      31
 192
 193 /* Command Status Wrapper */
 194 typedef struct {
 195         uDWord          dCSWSignature;
 196 #       define CSWSIGNATURE     0x53425355
 197 #       define CSWSIGNATURE_OLYMPUS_C1  0x55425355
 198         uDWord          dCSWTag;
 199         uDWord          dCSWDataResidue;
 200         uByte           bCSWStatus;
 201 #       define CSWSTATUS_GOOD   0x0
 202 #       define CSWSTATUS_FAILED 0x1
 203 #       define CSWSTATUS_PHASE  0x2
 204 } umass_bbb_csw_t;
 205 #define UMASS_BBB_CSW_SIZE      13
 206
 207 /* CBI features */
 208
 209 #define UR_CBI_ADSC     0x00
 210
 211 typedef unsigned char umass_cbi_cbl_t[16];      /* Command block */
 212
 213 typedef union {
 214         struct {
 215                 unsigned char   type;
 216                 #define IDB_TYPE_CCI            0x00
 217                 unsigned char   value;
 218                 #define IDB_VALUE_PASS          0x00
 219                 #define IDB_VALUE_FAIL          0x01
 220                 #define IDB_VALUE_PHASE         0x02
 221                 #define IDB_VALUE_PERSISTENT    0x03
 222                 #define IDB_VALUE_STATUS_MASK   0x03
 223         } common;
 224
 225         struct {
 226                 unsigned char   asc;
 227                 unsigned char   ascq;
 228         } ufi;
 229 } umass_cbi_sbl_t;
 230
 231
 232
 233 struct umass_softc;             /* see below */
 234
 235 typedef void (*transfer_cb_f)   (struct umass_softc *sc, void *priv,
 236                                 int residue, int status);
 237 #define STATUS_CMD_OK           0       /* everything ok */
 238 #define STATUS_CMD_UNKNOWN      1       /* will have to fetch sense */
 239 #define STATUS_CMD_FAILED       2       /* transfer was ok, command failed */
 240 #define STATUS_WIRE_FAILED      3       /* couldn't even get command across */
 241
 242 typedef void (*wire_reset_f)    (struct umass_softc *sc, int status);
 243 typedef void (*wire_transfer_f) (struct umass_softc *sc, int lun,
 244                                 void *cmd, int cmdlen, void *data, int datalen,
 245                                 int dir, transfer_cb_f cb, void *priv);
 246 typedef void (*wire_state_f)    (usbd_xfer_handle xfer,
 247                                 usbd_private_handle priv, usbd_status err);
 248
 249 typedef int (*command_transform_f)      (struct umass_softc *sc,
 250                                 unsigned char *cmd, int cmdlen,
 251                                 unsigned char **rcmd, int *rcmdlen);
 252
 253
 254 struct umass_devdescr_t {
 255         u_int32_t       vid;
 256 #       define VID_WILDCARD     0xffffffff
 257 #       define VID_EOT          0xfffffffe
 258         u_int32_t       pid;
 259 #       define PID_WILDCARD     0xffffffff
 260 #       define PID_EOT          0xfffffffe
 261         u_int32_t       rid;
 262 #       define RID_WILDCARD     0xffffffff
 263 #       define RID_EOT          0xfffffffe
 264
 265         /* wire and command protocol */
 266         u_int16_t       proto;
 267 #       define UMASS_PROTO_BBB          0x0001  /* USB wire protocol */
 268 #       define UMASS_PROTO_CBI          0x0002
 269 #       define UMASS_PROTO_CBI_I        0x0004
 270 #       define UMASS_PROTO_WIRE         0x00ff  /* USB wire protocol mask */
 271 #       define UMASS_PROTO_SCSI         0x0100  /* command protocol */
 272 #       define UMASS_PROTO_ATAPI        0x0200
 273 #       define UMASS_PROTO_UFI          0x0400
 274 #       define UMASS_PROTO_RBC          0x0800
 275 #       define UMASS_PROTO_COMMAND      0xff00  /* command protocol mask */
 276
 277         /* Device specific quirks */
 278         u_int16_t       quirks;
 279 #       define NO_QUIRKS                0x0000
 280         /* The drive does not support Test Unit Ready. Convert to Start Unit
 281          */
 282 #       define NO_TEST_UNIT_READY       0x0001
 283         /* The drive does not reset the Unit Attention state after REQUEST
 284          * SENSE has been sent. The INQUIRY command does not reset the UA
 285          * either, and so CAM runs in circles trying to retrieve the initial
 286          * INQUIRY data.
 287          */
 288 #       define RS_NO_CLEAR_UA           0x0002
 289         /* The drive does not support START STOP.  */
 290 #       define NO_START_STOP            0x0004
 291         /* Don't ask for full inquiry data (255b).  */
 292 #       define FORCE_SHORT_INQUIRY      0x0008
 293         /* Needs to be initialised the Shuttle way */
 294 #       define SHUTTLE_INIT             0x0010
 295         /* Drive needs to be switched to alternate iface 1 */
 296 #       define ALT_IFACE_1              0x0020
 297         /* Drive does not do 1Mb/s, but just floppy speeds (20kb/s) */
 298 #       define FLOPPY_SPEED             0x0040
 299         /* The device can't count and gets the residue of transfers wrong */
 300 #       define IGNORE_RESIDUE           0x0080
 301         /* No GetMaxLun call */
 302 #       define NO_GETMAXLUN             0x0100
 303         /* The device uses a weird CSWSIGNATURE. */
 304 #       define WRONG_CSWSIG             0x0200
 305         /* Device cannot handle INQUIRY so fake a generic response */
 306 #       define NO_INQUIRY               0x0400
 307         /* Device cannot handle INQUIRY EVPD, return CHECK CONDITION */
 308 #       define NO_INQUIRY_EVPD          0x0800
 309 };
 310
 311 Static struct umass_devdescr_t umass_devdescrs[] = {
 312         { USB_VENDOR_ASAHIOPTICAL, PID_WILDCARD, RID_WILDCARD,
 313           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 314           RS_NO_CLEAR_UA
 315         },
 316         { USB_VENDOR_FUJIPHOTO, USB_PRODUCT_FUJIPHOTO_MASS0100, RID_WILDCARD,
 317           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 318           RS_NO_CLEAR_UA
 319         },
 320         { USB_VENDOR_GENESYS,  USB_PRODUCT_GENESYS_GL641USB2IDE, RID_WILDCARD,
 321           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 322           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 323         },
 324         { USB_VENDOR_GENESYS,  USB_PRODUCT_GENESYS_GL641USB, RID_WILDCARD,
 325           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 326           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 327         },
 328         { USB_VENDOR_HITACHI, USB_PRODUCT_HITACHI_DVDCAM_USB, RID_WILDCARD,
 329           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 330           NO_INQUIRY
 331         },
 332         { USB_VENDOR_HP, USB_PRODUCT_HP_CDW8200, RID_WILDCARD,
 333           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 334           NO_TEST_UNIT_READY | NO_START_STOP
 335         },
 336         { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE, RID_WILDCARD,
 337           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI,
 338           NO_TEST_UNIT_READY | NO_START_STOP | ALT_IFACE_1
 339         },
 340         { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP100, RID_WILDCARD,
 341           /* XXX This is not correct as there are Zip drives that use ATAPI.
 342            */
 343           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 344           NO_TEST_UNIT_READY
 345         },
 346         { USB_VENDOR_LOGITEC, USB_PRODUCT_LOGITEC_LDR_H443U2, RID_WILDCARD,
 347           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 348           NO_QUIRKS
 349         },
 350         { USB_VENDOR_MELCO,  USB_PRODUCT_MELCO_DUBPXXG, RID_WILDCARD,
 351           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 352           FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE
 353         },
 354         { USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_DPCM, RID_WILDCARD,
 355           UMASS_PROTO_SCSI | UMASS_PROTO_CBI,
 356           NO_TEST_UNIT_READY | NO_START_STOP
 357         },
 358         { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY, RID_WILDCARD,
 359           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 360           IGNORE_RESIDUE | NO_GETMAXLUN | RS_NO_CLEAR_UA
 361         },
 362         { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY2, RID_WILDCARD,
 363           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 364           NO_QUIRKS
 365         },
 366         { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1, RID_WILDCARD,
 367           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 368           WRONG_CSWSIG
 369         },
 370         { USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXLCB20AN, RID_WILDCARD,
 371           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 372           NO_QUIRKS
 373         },
 374         { USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXLCB35AN, RID_WILDCARD,
 375           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 376           NO_QUIRKS
 377         },
 378         { USB_VENDOR_PNY, USB_PRODUCT_PNY_ATTACHE, RID_WILDCARD,
 379           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 380           IGNORE_RESIDUE
 381         },
 382         { USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R, RID_WILDCARD,
 383           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 384           NO_QUIRKS
 385         },
 386         { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB, RID_WILDCARD,
 387           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 388           NO_TEST_UNIT_READY | NO_START_STOP | SHUTTLE_INIT
 389         },
 390         { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_I_BEAD100, RID_WILDCARD,
 391           UMASS_PROTO_SCSI | UMASS_PROTO_BBB,
 392           SHUTTLE_INIT
 393         },
 394         { USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC, RID_WILDCARD,
 395           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 396           NO_QUIRKS
 397         },
 398         { USB_VENDOR_SONY, USB_PRODUCT_SONY_MSC, RID_WILDCARD,
 399           UMASS_PROTO_RBC | UMASS_PROTO_CBI,
 400           NO_QUIRKS
 401         },
 402         { USB_VENDOR_TREK, USB_PRODUCT_TREK_THUMBDRIVE_8MB, RID_WILDCARD,
 403           UMASS_PROTO_ATAPI | UMASS_PROTO_BBB,
 404           IGNORE_RESIDUE
 405         },
 406         { USB_VENDOR_YANO,  USB_PRODUCT_YANO_U640MO, RID_WILDCARD,
 407           UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I,
 408           FORCE_SHORT_INQUIRY
 409         },
 410         { VID_EOT, PID_EOT, RID_EOT, 0, 0 }
 411 };
 412
 413
 414 /* the per device structure */
 415 struct umass_softc {
 416         USBBASEDEVICE           sc_dev;         /* base device */
 417         usbd_device_handle      sc_udev;        /* USB device */
 418
 419         struct cam_sim          *umass_sim;     /* SCSI Interface Module */
 420
 421         unsigned char           flags;          /* various device flags */
 422 #       define UMASS_FLAGS_GONE         0x01    /* devices is no more */
 423
 424         u_int16_t               proto;          /* wire and cmd protocol */
 425         u_int16_t               quirks;         /* they got it almost right */
 426
 427         usbd_interface_handle   iface;          /* Mass Storage interface */
 428         int                     ifaceno;        /* MS iface number */
 429
 430         u_int8_t                bulkin;         /* bulk-in Endpoint Address */
 431         u_int8_t                bulkout;        /* bulk-out Endpoint Address */
 432         u_int8_t                intrin;         /* intr-in Endp. (CBI) */
 433         usbd_pipe_handle        bulkin_pipe;
 434         usbd_pipe_handle        bulkout_pipe;
 435         usbd_pipe_handle        intrin_pipe;
 436
 437         /* Reset the device in a wire protocol specific way */
 438         wire_reset_f            reset;
 439
 440         /* The start of a wire transfer. It prepares the whole transfer (cmd,
 441          * data, and status stage) and initiates it. It is up to the state
 442          * machine (below) to handle the various stages and errors in these
 443          */
 444         wire_transfer_f         transfer;
 445
 446         /* The state machine, handling the various states during a transfer */
 447         wire_state_f            state;
 448
 449         /* The command transform function is used to conver the SCSI commands
 450          * into their derivatives, like UFI, ATAPI, and friends.
 451          */
 452         command_transform_f     transform;      /* command transform */
 453
 454         /* Bulk specific variables for transfers in progress */
 455         umass_bbb_cbw_t         cbw;    /* command block wrapper */
 456         umass_bbb_csw_t         csw;    /* command status wrapper*/
 457         /* CBI specific variables for transfers in progress */
 458         umass_cbi_cbl_t         cbl;    /* command block */
 459         umass_cbi_sbl_t         sbl;    /* status block */
 460
 461         /* generic variables for transfers in progress */
 462         /* ctrl transfer requests */
 463         usb_device_request_t    request;
 464
 465         /* xfer handles
 466          * Most of our operations are initiated from interrupt context, so
 467          * we need to avoid using the one that is in use. We want to avoid
 468          * allocating them in the interrupt context as well.
 469          */
 470         /* indices into array below */
 471 #       define XFER_BBB_CBW             0       /* Bulk-Only */
 472 #       define XFER_BBB_DATA            1
 473 #       define XFER_BBB_DCLEAR          2
 474 #       define XFER_BBB_CSW1            3
 475 #       define XFER_BBB_CSW2            4
 476 #       define XFER_BBB_SCLEAR          5
 477 #       define XFER_BBB_RESET1          6
 478 #       define XFER_BBB_RESET2          7
 479 #       define XFER_BBB_RESET3          8
 480
 481 #       define XFER_CBI_CB              0       /* CBI */
 482 #       define XFER_CBI_DATA            1
 483 #       define XFER_CBI_STATUS          2
 484 #       define XFER_CBI_DCLEAR          3
 485 #       define XFER_CBI_SCLEAR          4
 486 #       define XFER_CBI_RESET1          5
 487 #       define XFER_CBI_RESET2          6
 488 #       define XFER_CBI_RESET3          7
 489
 490 #       define XFER_NR                  9       /* maximum number */
 491
 492         usbd_xfer_handle        transfer_xfer[XFER_NR]; /* for ctrl xfers */
 493
 494         int                     transfer_dir;           /* data direction */
 495         void                    *transfer_data;         /* data buffer */
 496         int                     transfer_datalen;       /* (maximum) length */
 497         int                     transfer_actlen;        /* actual length */
 498         transfer_cb_f           transfer_cb;            /* callback */
 499         void                    *transfer_priv;         /* for callback */
 500         int                     transfer_status;
 501
 502         int                     transfer_state;
 503 #       define TSTATE_ATTACH                    0       /* in attach */
 504 #       define TSTATE_IDLE                      1
 505 #       define TSTATE_BBB_COMMAND               2       /* CBW transfer */
 506 #       define TSTATE_BBB_DATA                  3       /* Data transfer */
 507 #       define TSTATE_BBB_DCLEAR                4       /* clear endpt stall */
 508 #       define TSTATE_BBB_STATUS1               5       /* clear endpt stall */
 509 #       define TSTATE_BBB_SCLEAR                6       /* clear endpt stall */
 510 #       define TSTATE_BBB_STATUS2               7       /* CSW transfer */
 511 #       define TSTATE_BBB_RESET1                8       /* reset command */
 512 #       define TSTATE_BBB_RESET2                9       /* in clear stall */
 513 #       define TSTATE_BBB_RESET3                10      /* out clear stall */
 514 #       define TSTATE_CBI_COMMAND               11      /* command transfer */
 515 #       define TSTATE_CBI_DATA                  12      /* data transfer */
 516 #       define TSTATE_CBI_STATUS                13      /* status transfer */
 517 #       define TSTATE_CBI_DCLEAR                14      /* clear ep stall */
 518 #       define TSTATE_CBI_SCLEAR                15      /* clear ep stall */
 519 #       define TSTATE_CBI_RESET1                16      /* reset command */
 520 #       define TSTATE_CBI_RESET2                17      /* in clear stall */
 521 #       define TSTATE_CBI_RESET3                18      /* out clear stall */
 522 #       define TSTATE_STATES                    19      /* # of states above */
 523
 524
 525         /* SCSI/CAM specific variables */
 526         unsigned char           cam_scsi_command[CAM_MAX_CDBLEN];
 527         unsigned char           cam_scsi_command2[CAM_MAX_CDBLEN];
 528         struct scsi_sense       cam_scsi_sense;
 529         struct scsi_sense       cam_scsi_test_unit_ready;
 530
 531         int                     maxlun;                 /* maximum LUN number */
 532         struct callout_handle   rescan_timeout;
 533 };
 534
 535 #ifdef USB_DEBUG
 536 char *states[TSTATE_STATES+1] = {
 537         /* should be kept in sync with the list at transfer_state */
 538         "Attach",
 539         "Idle",
 540         "BBB CBW",
 541         "BBB Data",
 542         "BBB Data bulk-in/-out clear stall",
 543         "BBB CSW, 1st attempt",
 544         "BBB CSW bulk-in clear stall",
 545         "BBB CSW, 2nd attempt",
 546         "BBB Reset",
 547         "BBB bulk-in clear stall",
 548         "BBB bulk-out clear stall",
 549         "CBI Command",
 550         "CBI Data",
 551         "CBI Status",
 552         "CBI Data bulk-in/-out clear stall",
 553         "CBI Status intr-in clear stall",
 554         "CBI Reset",
 555         "CBI bulk-in clear stall",
 556         "CBI bulk-out clear stall",
 557         NULL
 558 };
 559 #endif
 560
 561 /* If device cannot return valid inquiry data, fake it */
 562 Static uint8_t fake_inq_data[SHORT_INQUIRY_LENGTH] = {
 563         0, /*removable*/ 0x80, SCSI_REV_2, SCSI_REV_2,
 564         /*additional_length*/ 31, 0, 0, 0
 565 };
 566
 567 /* USB device probe/attach/detach functions */
 568 USB_DECLARE_DRIVER(umass);
 569 Static int umass_match_proto    (struct umass_softc *sc,
 570                                 usbd_interface_handle iface,
 571                                 usbd_device_handle udev);
 572
 573 /* quirk functions */
 574 Static void umass_init_shuttle  (struct umass_softc *sc);
 575
 576 /* generic transfer functions */
 577 Static usbd_status umass_setup_transfer (struct umass_softc *sc,
 578                                 usbd_pipe_handle pipe,
 579                                 void *buffer, int buflen, int flags,
 580                                 usbd_xfer_handle xfer);
 581 Static usbd_status umass_setup_ctrl_transfer    (struct umass_softc *sc,
 582                                 usbd_device_handle udev,
 583                                 usb_device_request_t *req,
 584                                 void *buffer, int buflen, int flags,
 585                                 usbd_xfer_handle xfer);
 586 Static void umass_clear_endpoint_stall  (struct umass_softc *sc,
 587                                 u_int8_t endpt, usbd_pipe_handle pipe,
 588                                 int state, usbd_xfer_handle xfer);
 589 Static void umass_reset         (struct umass_softc *sc,
 590                                 transfer_cb_f cb, void *priv);
 591
 592 /* Bulk-Only related functions */
 593 Static void umass_bbb_reset     (struct umass_softc *sc, int status);
 594 Static void umass_bbb_transfer  (struct umass_softc *sc, int lun,
 595                                 void *cmd, int cmdlen,
 596                                 void *data, int datalen, int dir,
 597                                 transfer_cb_f cb, void *priv);
 598 Static void umass_bbb_state     (usbd_xfer_handle xfer,
 599                                 usbd_private_handle priv,
 600                                 usbd_status err);
 601 Static int umass_bbb_get_max_lun
 602                                 (struct umass_softc *sc);
 603
 604 /* CBI related functions */
 605 Static int umass_cbi_adsc       (struct umass_softc *sc,
 606                                 char *buffer, int buflen,
 607                                 usbd_xfer_handle xfer);
 608 Static void umass_cbi_reset     (struct umass_softc *sc, int status);
 609 Static void umass_cbi_transfer  (struct umass_softc *sc, int lun,
 610                                 void *cmd, int cmdlen,
 611                                 void *data, int datalen, int dir,
 612                                 transfer_cb_f cb, void *priv);
 613 Static void umass_cbi_state     (usbd_xfer_handle xfer,
 614                                 usbd_private_handle priv, usbd_status err);
 615
 616 /* CAM related functions */
 617 Static void umass_cam_action    (struct cam_sim *sim, union ccb *ccb);
 618 Static void umass_cam_poll      (struct cam_sim *sim);
 619
 620 Static void umass_cam_cb        (struct umass_softc *sc, void *priv,
 621                                 int residue, int status);
 622 Static void umass_cam_sense_cb  (struct umass_softc *sc, void *priv,
 623                                 int residue, int status);
 624 Static void umass_cam_quirk_cb  (struct umass_softc *sc, void *priv,
 625                                 int residue, int status);
 626
 627 Static void umass_cam_rescan_callback
 628                                 (struct cam_periph *periph,union ccb *ccb);
 629 Static void umass_cam_rescan    (void *addr);
 630
 631 Static int umass_cam_attach_sim (struct umass_softc *sc);
 632 Static int umass_cam_attach     (struct umass_softc *sc);
 633 Static int umass_cam_detach_sim (struct umass_softc *sc);
 634
 635
 636 /* SCSI specific functions */
 637 Static int umass_scsi_transform (struct umass_softc *sc,
 638                                 unsigned char *cmd, int cmdlen,
 639                                 unsigned char **rcmd, int *rcmdlen);
 640
 641 /* UFI specific functions */
 642 #define UFI_COMMAND_LENGTH      12      /* UFI commands are always 12 bytes */
 643 Static int umass_ufi_transform  (struct umass_softc *sc,
 644                                 unsigned char *cmd, int cmdlen,
 645                                 unsigned char **rcmd, int *rcmdlen);
 646
 647 /* ATAPI (8070i) specific functions */
 648 #define ATAPI_COMMAND_LENGTH    12      /* ATAPI commands are always 12 bytes */
 649 Static int umass_atapi_transform        (struct umass_softc *sc,
 650                                 unsigned char *cmd, int cmdlen,
 651                                 unsigned char **rcmd, int *rcmdlen);
 652
 653 /* RBC specific functions */
 654 Static int umass_rbc_transform  (struct umass_softc *sc,
 655                                 unsigned char *cmd, int cmdlen,
 656                                 unsigned char **rcmd, int *rcmdlen);
 657
 658 #ifdef USB_DEBUG
 659 /* General debugging functions */
 660 Static void umass_bbb_dump_cbw  (struct umass_softc *sc, umass_bbb_cbw_t *cbw);
 661 Static void umass_bbb_dump_csw  (struct umass_softc *sc, umass_bbb_csw_t *csw);
 662 Static void umass_cbi_dump_cmd  (struct umass_softc *sc, void *cmd, int cmdlen);
 663 Static void umass_dump_buffer   (struct umass_softc *sc, u_int8_t *buffer,
 664                                 int buflen, int printlen);
 665 #endif
 666
 667 #if defined(__FreeBSD__) || defined(__DragonFly__)
 668 MODULE_DEPEND(umass, cam, 1,1,1);
 669 #endif
 670
 671 /*
 672  * USB device probe/attach/detach
 673  */
 674
 675 /*
 676  * Match the device we are seeing with the devices supported. Fill in the
 677  * description in the softc accordingly. This function is called from both
 678  * probe and attach.
 679  */
 680
 681 Static int
 682 umass_match_proto(struct umass_softc *sc, usbd_interface_handle iface,
 683                   usbd_device_handle udev)
 684 {
 685         usb_device_descriptor_t *dd;
 686         usb_interface_descriptor_t *id;
 687         int i;
 688         int found = 0;
 689
 690         sc->sc_udev = udev;
 691         sc->proto = 0;
 692         sc->quirks = 0;
 693
 694         dd = usbd_get_device_descriptor(udev);
 695
 696         /* An entry specifically for Y-E Data devices as they don't fit in the
 697          * device description table.
 698          */
 699         if (UGETW(dd->idVendor) == USB_VENDOR_YEDATA
 700             && UGETW(dd->idProduct) == USB_PRODUCT_YEDATA_FLASHBUSTERU) {
 701
 702                 /* Revisions < 1.28 do not handle the inerrupt endpoint
 703                  * very well.
 704                  */
 705                 if (UGETW(dd->bcdDevice) < 0x128) {
 706                         sc->proto = UMASS_PROTO_UFI | UMASS_PROTO_CBI;
 707                 } else {
 708                         sc->proto = UMASS_PROTO_UFI | UMASS_PROTO_CBI_I;
 709                 }
 710
 711                 /*
 712                  * Revisions < 1.28 do not have the TEST UNIT READY command
 713                  * Revisions == 1.28 have a broken TEST UNIT READY
 714                  */
 715                 if (UGETW(dd->bcdDevice) <= 0x128)
 716                         sc->quirks |= NO_TEST_UNIT_READY;
 717
 718                 sc->quirks |= RS_NO_CLEAR_UA | FLOPPY_SPEED;
 719                 return(UMATCH_VENDOR_PRODUCT);
 720         }
 721
 722         /* Check the list of supported devices for a match. While looking,
 723          * check for wildcarded and fully matched. First match wins.
 724          */
 725         for (i = 0; umass_devdescrs[i].vid != VID_EOT && !found; i++) {
 726                 if (umass_devdescrs[i].vid == VID_WILDCARD &&
 727                     umass_devdescrs[i].pid == PID_WILDCARD &&
 728                     umass_devdescrs[i].rid == RID_WILDCARD) {
 729                         printf("umass: ignoring invalid wildcard quirk\n");
 730                         continue;
 731                 }
 732                 if ((umass_devdescrs[i].vid == UGETW(dd->idVendor) ||
 733                      umass_devdescrs[i].vid == VID_WILDCARD)
 734                  && (umass_devdescrs[i].pid == UGETW(dd->idProduct) ||
 735                      umass_devdescrs[i].pid == PID_WILDCARD)) {
 736                         if (umass_devdescrs[i].rid == RID_WILDCARD) {
 737                                 sc->proto = umass_devdescrs[i].proto;
 738                                 sc->quirks = umass_devdescrs[i].quirks;
 739                                 return (UMATCH_VENDOR_PRODUCT);
 740                         } else if (umass_devdescrs[i].rid ==
 741                             UGETW(dd->bcdDevice)) {
 742                                 sc->proto = umass_devdescrs[i].proto;
 743                                 sc->quirks = umass_devdescrs[i].quirks;
 744                                 return (UMATCH_VENDOR_PRODUCT_REV);
 745                         } /* else RID does not match */
 746                 }
 747         }
 748
 749         /* Check for a standards compliant device */
 750
 751         id = usbd_get_interface_descriptor(iface);
 752         if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
 753                 return(UMATCH_NONE);
 754
 755         switch (id->bInterfaceSubClass) {
 756         case UISUBCLASS_SCSI:
 757                 sc->proto |= UMASS_PROTO_SCSI;
 758                 break;
 759         case UISUBCLASS_UFI:
 760                 sc->proto |= UMASS_PROTO_UFI;
 761                 break;
 762         case UISUBCLASS_RBC:
 763                 sc->proto |= UMASS_PROTO_RBC;
 764                 break;
 765         case UISUBCLASS_SFF8020I:
 766         case UISUBCLASS_SFF8070I:
 767                 sc->proto |= UMASS_PROTO_ATAPI;
 768                 break;
 769         default:
 770                 DPRINTF(UDMASS_GEN, ("%s: Unsupported command protocol %d\n",
 771                         USBDEVNAME(sc->sc_dev), id->bInterfaceSubClass));
 772                 return(UMATCH_NONE);
 773         }
 774
 775         switch (id->bInterfaceProtocol) {
 776         case UIPROTO_MASS_CBI:
 777                 sc->proto |= UMASS_PROTO_CBI;
 778                 break;
 779         case UIPROTO_MASS_CBI_I:
 780                 sc->proto |= UMASS_PROTO_CBI_I;
 781                 break;
 782         case UIPROTO_MASS_BBB_OLD:
 783         case UIPROTO_MASS_BBB:
 784                 sc->proto |= UMASS_PROTO_BBB;
 785                 break;
 786         default:
 787                 DPRINTF(UDMASS_GEN, ("%s: Unsupported wire protocol %d\n",
 788                         USBDEVNAME(sc->sc_dev), id->bInterfaceProtocol));
 789                 return(UMATCH_NONE);
 790         }
 791
 792         return(UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO);
 793 }
 794
 795 USB_MATCH(umass)
 796 {
 797         USB_MATCH_START(umass, uaa);
 798         struct umass_softc *sc = device_get_softc(self);
 799
 800         USB_MATCH_SETUP;
 801
 802         if (uaa->iface == NULL)
 803                 return(UMATCH_NONE);
 804
 805         return(umass_match_proto(sc, uaa->iface, uaa->device));
 806 }
 807
 808 USB_ATTACH(umass)
 809 {
 810         USB_ATTACH_START(umass, sc, uaa);
 811         usb_interface_descriptor_t *id;
 812         usb_endpoint_descriptor_t *ed;
 813         char devinfo[1024];
 814         int i;
 815         int err;
 816
 817         /*
 818          * the softc struct is bzero-ed in device_set_driver. We can safely
 819          * call umass_detach without specifically initialising the struct.
 820          */
 821
 822         usbd_devinfo(uaa->device, 0, devinfo);
 823         USB_ATTACH_SETUP;
 824
 825         sc->iface = uaa->iface;
 826         sc->ifaceno = uaa->ifaceno;
 827
 828         /* initialise the proto and drive values in the umass_softc (again) */
 829         (void) umass_match_proto(sc, sc->iface, uaa->device);
 830
 831         id = usbd_get_interface_descriptor(sc->iface);
 832         printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
 833 #ifdef USB_DEBUG
 834         printf("%s: ", USBDEVNAME(sc->sc_dev));
 835         switch (sc->proto&UMASS_PROTO_COMMAND) {
 836         case UMASS_PROTO_SCSI:
 837                 printf("SCSI");
 838                 break;
 839         case UMASS_PROTO_ATAPI:
 840                 printf("8070i (ATAPI)");
 841                 break;
 842         case UMASS_PROTO_UFI:
 843                 printf("UFI");
 844                 break;
 845         case UMASS_PROTO_RBC:
 846                 printf("RBC");
 847                 break;
 848         default:
 849                 printf("(unknown 0x%02x)", sc->proto&UMASS_PROTO_COMMAND);
 850                 break;
 851         }
 852         printf(" over ");
 853         switch (sc->proto&UMASS_PROTO_WIRE) {
 854         case UMASS_PROTO_BBB:
 855                 printf("Bulk-Only");
 856                 break;
 857         case UMASS_PROTO_CBI:                   /* uses Comand/Bulk pipes */
 858                 printf("CBI");
 859                 break;
 860         case UMASS_PROTO_CBI_I:         /* uses Comand/Bulk/Interrupt pipes */
 861                 printf("CBI with CCI");
 862 #ifndef CBI_I
 863                 printf(" (using CBI)");
 864 #endif
 865                 break;
 866         default:
 867                 printf("(unknown 0x%02x)", sc->proto&UMASS_PROTO_WIRE);
 868         }
 869         printf("; quirks = 0x%04x\n", sc->quirks);
 870 #endif
 871
 872 #ifndef CBI_I
 873         if (sc->proto & UMASS_PROTO_CBI_I) {
 874                 /* See beginning of file for comment on the use of CBI with CCI */
 875                 sc->proto = (sc->proto & ~UMASS_PROTO_CBI_I) | UMASS_PROTO_CBI;
 876         }
 877 #endif
 878
 879         if (sc->quirks & ALT_IFACE_1) {
 880                 err = usbd_set_interface(0, 1);
 881                 if (err) {
 882                         DPRINTF(UDMASS_USB, ("%s: could not switch to "
 883                                 "Alt Interface %d\n",
 884                                 USBDEVNAME(sc->sc_dev), 1));
 885                         umass_detach(self);
 886                         USB_ATTACH_ERROR_RETURN;
 887                 }
 888         }
 889
 890         /*
 891          * In addition to the Control endpoint the following endpoints
 892          * are required:
 893          * a) bulk-in endpoint.
 894          * b) bulk-out endpoint.
 895          * and for Control/Bulk/Interrupt with CCI (CBI_I)
 896          * c) intr-in
 897          *
 898          * The endpoint addresses are not fixed, so we have to read them
 899          * from the device descriptors of the current interface.
 900          */
 901         for (i = 0 ; i < id->bNumEndpoints ; i++) {
 902                 ed = usbd_interface2endpoint_descriptor(sc->iface, i);
 903                 if (!ed) {
 904                         printf("%s: could not read endpoint descriptor\n",
 905                                USBDEVNAME(sc->sc_dev));
 906                         USB_ATTACH_ERROR_RETURN;
 907                 }
 908                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
 909                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
 910                         sc->bulkin = ed->bEndpointAddress;
 911                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
 912                     && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
 913                         sc->bulkout = ed->bEndpointAddress;
 914                 } else if (sc->proto & UMASS_PROTO_CBI_I
 915                     && UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
 916                     && (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
 917                         sc->intrin = ed->bEndpointAddress;
 918 #ifdef USB_DEBUG
 919                         if (UGETW(ed->wMaxPacketSize) > 2) {
 920                                 DPRINTF(UDMASS_CBI, ("%s: intr size is %d\n",
 921                                         USBDEVNAME(sc->sc_dev),
 922                                         UGETW(ed->wMaxPacketSize)));
 923                         }
 924 #endif
 925                 }
 926         }
 927
 928         /* check whether we found all the endpoints we need */
 929         if (!sc->bulkin || !sc->bulkout
 930             || (sc->proto & UMASS_PROTO_CBI_I && !sc->intrin) ) {
 931                 DPRINTF(UDMASS_USB, ("%s: endpoint not found %d/%d/%d\n",
 932                         USBDEVNAME(sc->sc_dev),
 933                         sc->bulkin, sc->bulkout, sc->intrin));
 934                 umass_detach(self);
 935                 USB_ATTACH_ERROR_RETURN;
 936         }
 937
 938         /* Open the bulk-in and -out pipe */
 939         err = usbd_open_pipe(sc->iface, sc->bulkout,
 940                                 USBD_EXCLUSIVE_USE, &sc->bulkout_pipe);
 941         if (err) {
 942                 DPRINTF(UDMASS_USB, ("%s: cannot open %d-out pipe (bulk)\n",
 943                         USBDEVNAME(sc->sc_dev), sc->bulkout));
 944                 umass_detach(self);
 945                 USB_ATTACH_ERROR_RETURN;
 946         }
 947         err = usbd_open_pipe(sc->iface, sc->bulkin,
 948                                 USBD_EXCLUSIVE_USE, &sc->bulkin_pipe);
 949         if (err) {
 950                 DPRINTF(UDMASS_USB, ("%s: could not open %d-in pipe (bulk)\n",
 951                         USBDEVNAME(sc->sc_dev), sc->bulkin));
 952                 umass_detach(self);
 953                 USB_ATTACH_ERROR_RETURN;
 954         }
 955         /* Open the intr-in pipe if the protocol is CBI with CCI.
 956          * Note: early versions of the Zip drive do have an interrupt pipe, but
 957          * this pipe is unused
 958          *
 959          * We do not open the interrupt pipe as an interrupt pipe, but as a
 960          * normal bulk endpoint. We send an IN transfer down the wire at the
 961          * appropriate time, because we know exactly when to expect data on
 962          * that endpoint. This saves bandwidth, but more important, makes the
 963          * code for handling the data on that endpoint simpler. No data
 964          * arriving concurently.
 965          */
 966         if (sc->proto & UMASS_PROTO_CBI_I) {
 967                 err = usbd_open_pipe(sc->iface, sc->intrin,
 968                                 USBD_EXCLUSIVE_USE, &sc->intrin_pipe);
 969                 if (err) {
 970                         DPRINTF(UDMASS_USB, ("%s: couldn't open %d-in (intr)\n",
 971                                 USBDEVNAME(sc->sc_dev), sc->intrin));
 972                         umass_detach(self);
 973                         USB_ATTACH_ERROR_RETURN;
 974                 }
 975         }
 976
 977         /* initialisation of generic part */
 978         sc->transfer_state = TSTATE_ATTACH;
 979
 980         /* request a sufficient number of xfer handles */
 981         for (i = 0; i < XFER_NR; i++) {
 982                 sc->transfer_xfer[i] = usbd_alloc_xfer(uaa->device);
 983                 if (!sc->transfer_xfer[i]) {
 984                         DPRINTF(UDMASS_USB, ("%s: Out of memory\n",
 985                                 USBDEVNAME(sc->sc_dev)));
 986                         umass_detach(self);
 987                         USB_ATTACH_ERROR_RETURN;
 988                 }
 989         }
 990
 991         /* Initialise the wire protocol specific methods */
 992         if (sc->proto & UMASS_PROTO_BBB) {
 993                 sc->reset = umass_bbb_reset;
 994                 sc->transfer = umass_bbb_transfer;
 995                 sc->state = umass_bbb_state;
 996         } else if (sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I)) {
 997                 sc->reset = umass_cbi_reset;
 998                 sc->transfer = umass_cbi_transfer;
 999                 sc->state = umass_cbi_state;
1000 #ifdef USB_DEBUG
1001         } else {
1002                 panic("%s:%d: Unknown proto 0x%02x",
1003                       __FILE__, __LINE__, sc->proto);
1004 #endif
1005         }
1006
1007         if (sc->proto & UMASS_PROTO_SCSI)
1008                 sc->transform = umass_scsi_transform;
1009         else if (sc->proto & UMASS_PROTO_UFI)
1010                 sc->transform = umass_ufi_transform;
1011         else if (sc->proto & UMASS_PROTO_ATAPI)
1012                 sc->transform = umass_atapi_transform;
1013         else if (sc->proto & UMASS_PROTO_RBC)
1014                 sc->transform = umass_rbc_transform;
1015 #ifdef USB_DEBUG
1016         else
1017                 panic("No transformation defined for command proto 0x%02x",
1018                       sc->proto & UMASS_PROTO_COMMAND);
1019 #endif
1020
1021         /* From here onwards the device can be used. */
1022
1023         if (sc->quirks & SHUTTLE_INIT)
1024                 umass_init_shuttle(sc);
1025
1026         /* Get the maximum LUN supported by the device.
1027          */
1028         if ((sc->proto & UMASS_PROTO_WIRE) == UMASS_PROTO_BBB)
1029                 sc->maxlun = umass_bbb_get_max_lun(sc);
1030         else
1031                 sc->maxlun = 0;
1032
1033         if ((sc->proto & UMASS_PROTO_SCSI) ||
1034             (sc->proto & UMASS_PROTO_ATAPI) ||
1035             (sc->proto & UMASS_PROTO_UFI) ||
1036             (sc->proto & UMASS_PROTO_RBC)) {
1037                 /* Prepare the SCSI command block */
1038                 sc->cam_scsi_sense.opcode = REQUEST_SENSE;
1039                 sc->cam_scsi_test_unit_ready.opcode = TEST_UNIT_READY;
1040
1041                 /* register the SIM */
1042                 err = umass_cam_attach_sim(sc);
1043                 if (err) {
1044                         umass_detach(self);
1045                         USB_ATTACH_ERROR_RETURN;
1046                 }
1047                 /* scan the new sim */
1048                 err = umass_cam_attach(sc);
1049                 if (err) {
1050                         umass_cam_detach_sim(sc);
1051                         umass_detach(self);
1052                         USB_ATTACH_ERROR_RETURN;
1053                 }
1054         } else {
1055                 panic("%s:%d: Unknown proto 0x%02x",
1056                       __FILE__, __LINE__, sc->proto);
1057         }
1058
1059         sc->transfer_state = TSTATE_IDLE;
1060         DPRINTF(UDMASS_GEN, ("%s: Attach finished\n", USBDEVNAME(sc->sc_dev)));
1061
1062         USB_ATTACH_SUCCESS_RETURN;
1063 }
1064
1065 USB_DETACH(umass)
1066 {
1067         USB_DETACH_START(umass, sc);
1068         int err = 0;
1069         int i;
1070
1071         DPRINTF(UDMASS_USB, ("%s: detached\n", USBDEVNAME(sc->sc_dev)));
1072
1073         /*
1074          * Set UMASS_FLAGS_GONE to prevent any new transfers from being
1075          * queued, and abort any transfers in progress to ensure that
1076          * pending requests (e.g. from CAM's bus scan) are terminated.
1077          */
1078         sc->flags |= UMASS_FLAGS_GONE;
1079
1080         if (sc->bulkout_pipe)
1081                 usbd_abort_pipe(sc->bulkout_pipe);
1082         if (sc->bulkin_pipe)
1083                 usbd_abort_pipe(sc->bulkin_pipe);
1084         if (sc->intrin_pipe)
1085                 usbd_abort_pipe(sc->intrin_pipe);
1086
1087         if ((sc->proto & UMASS_PROTO_SCSI) ||
1088             (sc->proto & UMASS_PROTO_ATAPI) ||
1089             (sc->proto & UMASS_PROTO_UFI) ||
1090             (sc->proto & UMASS_PROTO_RBC)) {
1091                 /* detach the SCSI host controller (SIM) */
1092                 err = umass_cam_detach_sim(sc);
1093         }
1094
1095         for (i = 0; i < XFER_NR; i++) {
1096                 if (sc->transfer_xfer[i])
1097                         usbd_free_xfer(sc->transfer_xfer[i]);
1098         }
1099
1100         /* remove all the pipes */
1101         if (sc->bulkout_pipe)
1102                 usbd_close_pipe(sc->bulkout_pipe);
1103         if (sc->bulkin_pipe)
1104                 usbd_close_pipe(sc->bulkin_pipe);
1105         if (sc->intrin_pipe)
1106                 usbd_close_pipe(sc->intrin_pipe);
1107
1108         return(err);
1109 }
1110
1111 Static void
1112 umass_init_shuttle(struct umass_softc *sc)
1113 {
1114         usb_device_request_t req;
1115         u_char status[2];
1116
1117         /* The Linux driver does this, but no one can tell us what the
1118          * command does.
1119          */
1120         req.bmRequestType = UT_READ_VENDOR_DEVICE;
1121         req.bRequest = 1;       /* XXX unknown command */
1122         USETW(req.wValue, 0);
1123         USETW(req.wIndex, sc->ifaceno);
1124         USETW(req.wLength, sizeof status);
1125         (void) usbd_do_request(sc->sc_udev, &req, &status);
1126
1127         DPRINTF(UDMASS_GEN, ("%s: Shuttle init returned 0x%02x%02x\n",
1128                 USBDEVNAME(sc->sc_dev), status[0], status[1]));
1129 }
1130
1131  /*
1132  * Generic functions to handle transfers
1133  */
1134
1135 Static usbd_status
1136 umass_setup_transfer(struct umass_softc *sc, usbd_pipe_handle pipe,
1137                         void *buffer, int buflen, int flags,
1138                         usbd_xfer_handle xfer)
1139 {
1140         usbd_status err;
1141
1142         /* Initialiase a USB transfer and then schedule it */
1143
1144         (void) usbd_setup_xfer(xfer, pipe, (void *) sc, buffer, buflen, flags,
1145                         UMASS_TIMEOUT, sc->state);
1146
1147         err = usbd_transfer(xfer);
1148         if (err && err != USBD_IN_PROGRESS) {
1149                 DPRINTF(UDMASS_BBB, ("%s: failed to setup transfer, %s\n",
1150                         USBDEVNAME(sc->sc_dev), usbd_errstr(err)));
1151                 return(err);
1152         }
1153
1154         return (USBD_NORMAL_COMPLETION);
1155 }
1156
1157
1158 Static usbd_status
1159 umass_setup_ctrl_transfer(struct umass_softc *sc, usbd_device_handle udev,
1160          usb_device_request_t *req,
1161          void *buffer, int buflen, int flags,
1162          usbd_xfer_handle xfer)
1163 {
1164         usbd_status err;
1165
1166         /* Initialiase a USB control transfer and then schedule it */
1167
1168         (void) usbd_setup_default_xfer(xfer, udev, (void *) sc,
1169                         UMASS_TIMEOUT, req, buffer, buflen, flags, sc->state);
1170
1171         err = usbd_transfer(xfer);
1172         if (err && err != USBD_IN_PROGRESS) {
1173                 DPRINTF(UDMASS_BBB, ("%s: failed to setup ctrl transfer, %s\n",
1174                          USBDEVNAME(sc->sc_dev), usbd_errstr(err)));
1175
1176                 /* do not reset, as this would make us loop */
1177                 return(err);
1178         }
1179
1180         return (USBD_NORMAL_COMPLETION);
1181 }
1182
1183 Static void
1184 umass_clear_endpoint_stall(struct umass_softc *sc,
1185                                 u_int8_t endpt, usbd_pipe_handle pipe,
1186                                 int state, usbd_xfer_handle xfer)
1187 {
1188         usbd_device_handle udev;
1189
1190         DPRINTF(UDMASS_BBB, ("%s: Clear endpoint 0x%02x stall\n",
1191                 USBDEVNAME(sc->sc_dev), endpt));
1192
1193         usbd_interface2device_handle(sc->iface, &udev);
1194
1195         sc->transfer_state = state;
1196
1197         usbd_clear_endpoint_toggle(pipe);
1198
1199         sc->request.bmRequestType = UT_WRITE_ENDPOINT;
1200         sc->request.bRequest = UR_CLEAR_FEATURE;
1201         USETW(sc->request.wValue, UF_ENDPOINT_HALT);
1202         USETW(sc->request.wIndex, endpt);
1203         USETW(sc->request.wLength, 0);
1204         umass_setup_ctrl_transfer(sc, udev, &sc->request, NULL, 0, 0, xfer);
1205 }
1206
1207 Static void
1208 umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv)
1209 {
1210         sc->transfer_cb = cb;
1211         sc->transfer_priv = priv;
1212
1213         /* The reset is a forced reset, so no error (yet) */
1214         sc->reset(sc, STATUS_CMD_OK);
1215 }
1216
1217 /*
1218  * Bulk protocol specific functions
1219  */
1220
1221 Static void
1222 umass_bbb_reset(struct umass_softc *sc, int status)
1223 {
1224         usbd_device_handle udev;
1225
1226         KASSERT(sc->proto & UMASS_PROTO_BBB,
1227                 ("%s: umass_bbb_reset: wrong sc->proto 0x%02x\n",
1228                         USBDEVNAME(sc->sc_dev), sc->proto));
1229
1230         /*
1231          * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
1232          *
1233          * For Reset Recovery the host shall issue in the following order:
1234          * a) a Bulk-Only Mass Storage Reset
1235          * b) a Clear Feature HALT to the Bulk-In endpoint
1236          * c) a Clear Feature HALT to the Bulk-Out endpoint
1237          *
1238          * This is done in 3 steps, states:
1239          * TSTATE_BBB_RESET1
1240          * TSTATE_BBB_RESET2
1241          * TSTATE_BBB_RESET3
1242          *
1243          * If the reset doesn't succeed, the device should be port reset.
1244          */
1245
1246         DPRINTF(UDMASS_BBB, ("%s: Bulk Reset\n",
1247                 USBDEVNAME(sc->sc_dev)));
1248
1249         sc->transfer_state = TSTATE_BBB_RESET1;
1250         sc->transfer_status = status;
1251
1252         usbd_interface2device_handle(sc->iface, &udev);
1253
1254         /* reset is a class specific interface write */
1255         sc->request.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1256         sc->request.bRequest = UR_BBB_RESET;
1257         USETW(sc->request.wValue, 0);
1258         USETW(sc->request.wIndex, sc->ifaceno);
1259         USETW(sc->request.wLength, 0);
1260         umass_setup_ctrl_transfer(sc, udev, &sc->request, NULL, 0, 0,
1261                                   sc->transfer_xfer[XFER_BBB_RESET1]);
1262 }
1263
1264 Static void
1265 umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen,
1266                     void *data, int datalen, int dir,
1267                     transfer_cb_f cb, void *priv)
1268 {
1269         KASSERT(sc->proto & UMASS_PROTO_BBB,
1270                 ("%s: umass_bbb_transfer: wrong sc->proto 0x%02x\n",
1271                         USBDEVNAME(sc->sc_dev), sc->proto));
1272
1273         /*
1274          * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly
1275          * a data phase of datalen bytes from/to the device and finally a
1276          * csw read phase.
1277          * If the data direction was inbound a maximum of datalen bytes
1278          * is stored in the buffer pointed to by data.
1279          *
1280          * umass_bbb_transfer initialises the transfer and lets the state
1281          * machine in umass_bbb_state handle the completion. It uses the
1282          * following states:
1283          * TSTATE_BBB_COMMAND
1284          *   -> TSTATE_BBB_DATA
1285          *   -> TSTATE_BBB_STATUS
1286          *   -> TSTATE_BBB_STATUS2
1287          *   -> TSTATE_BBB_IDLE
1288          *
1289          * An error in any of those states will invoke
1290          * umass_bbb_reset.
1291          */
1292
1293         /* check the given arguments */
1294         KASSERT(datalen == 0 || data != NULL,
1295                 ("%s: datalen > 0, but no buffer",USBDEVNAME(sc->sc_dev)));
1296         KASSERT(cmdlen <= CBWCDBLENGTH,
1297                 ("%s: cmdlen exceeds CDB length in CBW (%d > %d)",
1298                         USBDEVNAME(sc->sc_dev), cmdlen, CBWCDBLENGTH));
1299         KASSERT(dir == DIR_NONE || datalen > 0,
1300                 ("%s: datalen == 0 while direction is not NONE\n",
1301                         USBDEVNAME(sc->sc_dev)));
1302         KASSERT(datalen == 0 || dir != DIR_NONE,
1303                 ("%s: direction is NONE while datalen is not zero\n",
1304                         USBDEVNAME(sc->sc_dev)));
1305         KASSERT(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE,
1306                 ("%s: CBW struct does not have the right size (%ld vs. %d)\n",
1307                         USBDEVNAME(sc->sc_dev),
1308                         (long)sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE));
1309         KASSERT(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE,
1310                 ("%s: CSW struct does not have the right size (%ld vs. %d)\n",
1311                         USBDEVNAME(sc->sc_dev),
1312                         (long)sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE));
1313
1314         /*
1315          * Determine the direction of the data transfer and the length.
1316          *
1317          * dCBWDataTransferLength (datalen) :
1318          *   This field indicates the number of bytes of data that the host
1319          *   intends to transfer on the IN or OUT Bulk endpoint(as indicated by
1320          *   the Direction bit) during the execution of this command. If this
1321          *   field is set to 0, the device will expect that no data will be
1322          *   transferred IN or OUT during this command, regardless of the value
1323          *   of the Direction bit defined in dCBWFlags.
1324          *
1325          * dCBWFlags (dir) :
1326          *   The bits of the Flags field are defined as follows:
1327          *     Bits 0-6  reserved
1328          *     Bit  7    Direction - this bit shall be ignored if the
1329          *                           dCBWDataTransferLength field is zero.
1330          *               0 = data Out from host to device
1331          *               1 = data In from device to host
1332          */
1333
1334         /* Fill in the Command Block Wrapper
1335          * We fill in all the fields, so there is no need to bzero it first.
1336          */
1337         USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
1338         /* We don't care about the initial value, as long as the values are unique */
1339         USETDW(sc->cbw.dCBWTag, UGETDW(sc->cbw.dCBWTag) + 1);
1340         USETDW(sc->cbw.dCBWDataTransferLength, datalen);
1341         /* DIR_NONE is treated as DIR_OUT (0x00) */
1342         sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT);
1343         sc->cbw.bCBWLUN = lun;
1344         sc->cbw.bCDBLength = cmdlen;
1345         bcopy(cmd, sc->cbw.CBWCDB, cmdlen);
1346
1347         DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw));
1348
1349         /* store the details for the data transfer phase */
1350         sc->transfer_dir = dir;
1351         sc->transfer_data = data;
1352         sc->transfer_datalen = datalen;
1353         sc->transfer_actlen = 0;
1354         sc->transfer_cb = cb;
1355         sc->transfer_priv = priv;
1356         sc->transfer_status = STATUS_CMD_OK;
1357
1358         /* move from idle to the command state */
1359         sc->transfer_state = TSTATE_BBB_COMMAND;
1360
1361         /* Send the CBW from host to device via bulk-out endpoint. */
1362         if (umass_setup_transfer(sc, sc->bulkout_pipe,
1363                         &sc->cbw, UMASS_BBB_CBW_SIZE, 0,
1364                         sc->transfer_xfer[XFER_BBB_CBW])) {
1365                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1366         }
1367 }
1368
1369
1370 Static void
1371 umass_bbb_state(usbd_xfer_handle xfer, usbd_private_handle priv,
1372                 usbd_status err)
1373 {
1374         struct umass_softc *sc = (struct umass_softc *) priv;
1375         usbd_xfer_handle next_xfer;
1376
1377         KASSERT(sc->proto & UMASS_PROTO_BBB,
1378                 ("%s: umass_bbb_state: wrong sc->proto 0x%02x\n",
1379                         USBDEVNAME(sc->sc_dev), sc->proto));
1380
1381         /*
1382          * State handling for BBB transfers.
1383          *
1384          * The subroutine is rather long. It steps through the states given in
1385          * Annex A of the Bulk-Only specification.
1386          * Each state first does the error handling of the previous transfer
1387          * and then prepares the next transfer.
1388          * Each transfer is done asynchroneously so after the request/transfer
1389          * has been submitted you will find a 'return;'.
1390          */
1391
1392         DPRINTF(UDMASS_BBB, ("%s: Handling BBB state %d (%s), xfer=%p, %s\n",
1393                 USBDEVNAME(sc->sc_dev), sc->transfer_state,
1394                 states[sc->transfer_state], xfer, usbd_errstr(err)));
1395
1396         switch (sc->transfer_state) {
1397
1398         /***** Bulk Transfer *****/
1399         case TSTATE_BBB_COMMAND:
1400                 /* Command transport phase, error handling */
1401                 if (err) {
1402                         DPRINTF(UDMASS_BBB, ("%s: failed to send CBW\n",
1403                                 USBDEVNAME(sc->sc_dev)));
1404                         /* If the device detects that the CBW is invalid, then
1405                          * the device may STALL both bulk endpoints and require
1406                          * a Bulk-Reset
1407                          */
1408                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1409                         return;
1410                 }
1411
1412                 /* Data transport phase, setup transfer */
1413                 sc->transfer_state = TSTATE_BBB_DATA;
1414                 if (sc->transfer_dir == DIR_IN) {
1415                         if (umass_setup_transfer(sc, sc->bulkin_pipe,
1416                                         sc->transfer_data, sc->transfer_datalen,
1417                                         USBD_SHORT_XFER_OK,
1418                                         sc->transfer_xfer[XFER_BBB_DATA]))
1419                                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1420
1421                         return;
1422                 } else if (sc->transfer_dir == DIR_OUT) {
1423                         if (umass_setup_transfer(sc, sc->bulkout_pipe,
1424                                         sc->transfer_data, sc->transfer_datalen,
1425                                         0,      /* fixed length transfer */
1426                                         sc->transfer_xfer[XFER_BBB_DATA]))
1427                                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1428
1429                         return;
1430                 } else {
1431                         DPRINTF(UDMASS_BBB, ("%s: no data phase\n",
1432                                 USBDEVNAME(sc->sc_dev)));
1433                 }
1434
1435                 /* FALLTHROUGH if no data phase, err == 0 */
1436         case TSTATE_BBB_DATA:
1437                 /* Command transport phase, error handling (ignored if no data
1438                  * phase (fallthrough from previous state)) */
1439                 if (sc->transfer_dir != DIR_NONE) {
1440                         /* retrieve the length of the transfer that was done */
1441                         usbd_get_xfer_status(xfer, NULL, NULL,
1442                                                 &sc->transfer_actlen, NULL);
1443
1444                         if (err) {
1445                                 DPRINTF(UDMASS_BBB, ("%s: Data-%s %db failed, "
1446                                         "%s\n", USBDEVNAME(sc->sc_dev),
1447                                         (sc->transfer_dir == DIR_IN?"in":"out"),
1448                                         sc->transfer_datalen,usbd_errstr(err)));
1449
1450                                 if (err == USBD_STALLED) {
1451                                         umass_clear_endpoint_stall(sc,
1452                                           (sc->transfer_dir == DIR_IN?
1453                                             sc->bulkin:sc->bulkout),
1454                                           (sc->transfer_dir == DIR_IN?
1455                                             sc->bulkin_pipe:sc->bulkout_pipe),
1456                                           TSTATE_BBB_DCLEAR,
1457                                           sc->transfer_xfer[XFER_BBB_DCLEAR]);
1458                                         return;
1459                                 } else {
1460                                         /* Unless the error is a pipe stall the
1461                                          * error is fatal.
1462                                          */
1463                                         umass_bbb_reset(sc,STATUS_WIRE_FAILED);
1464                                         return;
1465                                 }
1466                         }
1467                 }
1468
1469                 DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN)
1470                                         umass_dump_buffer(sc, sc->transfer_data,
1471                                                 sc->transfer_datalen, 48));
1472
1473
1474
1475                 /* FALLTHROUGH, err == 0 (no data phase or successfull) */
1476         case TSTATE_BBB_DCLEAR: /* stall clear after data phase */
1477         case TSTATE_BBB_SCLEAR: /* stall clear after status phase */
1478                 /* Reading of CSW after bulk stall condition in data phase
1479                  * (TSTATE_BBB_DATA2) or bulk-in stall condition after
1480                  * reading CSW (TSTATE_BBB_SCLEAR).
1481                  * In the case of no data phase or successfull data phase,
1482                  * err == 0 and the following if block is passed.
1483                  */
1484                 if (err) {      /* should not occur */
1485                         /* try the transfer below, even if clear stall failed */
1486                         DPRINTF(UDMASS_BBB, ("%s: bulk-%s stall clear failed"
1487                                 ", %s\n", USBDEVNAME(sc->sc_dev),
1488                                 (sc->transfer_dir == DIR_IN? "in":"out"),
1489                                 usbd_errstr(err)));
1490                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1491                         return;
1492                 }
1493
1494                 /* Status transport phase, setup transfer */
1495                 if (sc->transfer_state == TSTATE_BBB_COMMAND ||
1496                     sc->transfer_state == TSTATE_BBB_DATA ||
1497                     sc->transfer_state == TSTATE_BBB_DCLEAR) {
1498                         /* After no data phase, successfull data phase and
1499                          * after clearing bulk-in/-out stall condition
1500                          */
1501                         sc->transfer_state = TSTATE_BBB_STATUS1;
1502                         next_xfer = sc->transfer_xfer[XFER_BBB_CSW1];
1503                 } else {
1504                         /* After first attempt of fetching CSW */
1505                         sc->transfer_state = TSTATE_BBB_STATUS2;
1506                         next_xfer = sc->transfer_xfer[XFER_BBB_CSW2];
1507                 }
1508
1509                 /* Read the Command Status Wrapper via bulk-in endpoint. */
1510                 if (umass_setup_transfer(sc, sc->bulkin_pipe,
1511                                 &sc->csw, UMASS_BBB_CSW_SIZE, 0,
1512                                 next_xfer)) {
1513                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1514                         return;
1515                 }
1516
1517                 return;
1518         case TSTATE_BBB_STATUS1:        /* first attempt */
1519         case TSTATE_BBB_STATUS2:        /* second attempt */
1520                 /* Status transfer, error handling */
1521                 {
1522                 int Residue;
1523                 if (err) {
1524                         DPRINTF(UDMASS_BBB, ("%s: Failed to read CSW, %s%s\n",
1525                                 USBDEVNAME(sc->sc_dev), usbd_errstr(err),
1526                                 (sc->transfer_state == TSTATE_BBB_STATUS1?
1527                                         ", retrying":"")));
1528
1529                         /* If this was the first attempt at fetching the CSW
1530                          * retry it, otherwise fail.
1531                          */
1532                         if (sc->transfer_state == TSTATE_BBB_STATUS1) {
1533                                 umass_clear_endpoint_stall(sc,
1534                                             sc->bulkin, sc->bulkin_pipe,
1535                                             TSTATE_BBB_SCLEAR,
1536                                             sc->transfer_xfer[XFER_BBB_SCLEAR]);
1537                                 return;
1538                         } else {
1539                                 umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1540                                 return;
1541                         }
1542                 }
1543
1544                 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw));
1545
1546                 /* Translate weird command-status signatures. */
1547                 if ((sc->quirks & WRONG_CSWSIG) &&
1548                     UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1)
1549                         USETDW(sc->csw.dCSWSignature, CSWSIGNATURE);
1550
1551                 Residue = UGETDW(sc->csw.dCSWDataResidue);
1552                 if (Residue == 0 &&
1553                     sc->transfer_datalen - sc->transfer_actlen != 0)
1554                         Residue = sc->transfer_datalen - sc->transfer_actlen;
1555
1556                 /* Check CSW and handle any error */
1557                 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) {
1558                         /* Invalid CSW: Wrong signature or wrong tag might
1559                          * indicate that the device is confused -> reset it.
1560                          */
1561                         printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n",
1562                                 USBDEVNAME(sc->sc_dev),
1563                                 UGETDW(sc->csw.dCSWSignature),
1564                                 CSWSIGNATURE);
1565
1566                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1567                         return;
1568                 } else if (UGETDW(sc->csw.dCSWTag)
1569                                 != UGETDW(sc->cbw.dCBWTag)) {
1570                         printf("%s: Invalid CSW: tag %d should be %d\n",
1571                                 USBDEVNAME(sc->sc_dev),
1572                                 UGETDW(sc->csw.dCSWTag),
1573                                 UGETDW(sc->cbw.dCBWTag));
1574
1575                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1576                         return;
1577
1578                 /* CSW is valid here */
1579                 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) {
1580                         printf("%s: Invalid CSW: status %d > %d\n",
1581                                 USBDEVNAME(sc->sc_dev),
1582                                 sc->csw.bCSWStatus,
1583                                 CSWSTATUS_PHASE);
1584
1585                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1586                         return;
1587                 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) {
1588                         printf("%s: Phase Error, residue = %d\n",
1589                                 USBDEVNAME(sc->sc_dev), Residue);
1590
1591                         umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1592                         return;
1593
1594                 } else if (sc->transfer_actlen > sc->transfer_datalen) {
1595                         /* Buffer overrun! Don't let this go by unnoticed */
1596                         panic("%s: transferred %db instead of %db",
1597                                 USBDEVNAME(sc->sc_dev),
1598                                 sc->transfer_actlen, sc->transfer_datalen);
1599
1600                 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) {
1601                         DPRINTF(UDMASS_BBB, ("%s: Command Failed, res = %d\n",
1602                                 USBDEVNAME(sc->sc_dev), Residue));
1603
1604                         /* SCSI command failed but transfer was succesful */
1605                         sc->transfer_state = TSTATE_IDLE;
1606                         sc->transfer_cb(sc, sc->transfer_priv, Residue,
1607                                         STATUS_CMD_FAILED);
1608                         return;
1609
1610                 } else {        /* success */
1611                         sc->transfer_state = TSTATE_IDLE;
1612                         sc->transfer_cb(sc, sc->transfer_priv, Residue,
1613                                         STATUS_CMD_OK);
1614
1615                         return;
1616                 }
1617                 }
1618
1619         /***** Bulk Reset *****/
1620         case TSTATE_BBB_RESET1:
1621                 if (err)
1622                         printf("%s: BBB reset failed, %s\n",
1623                                 USBDEVNAME(sc->sc_dev), usbd_errstr(err));
1624
1625                 umass_clear_endpoint_stall(sc,
1626                         sc->bulkin, sc->bulkin_pipe, TSTATE_BBB_RESET2,
1627                         sc->transfer_xfer[XFER_BBB_RESET2]);
1628
1629                 return;
1630         case TSTATE_BBB_RESET2:
1631                 if (err)        /* should not occur */
1632                         printf("%s: BBB bulk-in clear stall failed, %s\n",
1633                                USBDEVNAME(sc->sc_dev), usbd_errstr(err));
1634                         /* no error recovery, otherwise we end up in a loop */
1635
1636                 umass_clear_endpoint_stall(sc,
1637                         sc->bulkout, sc->bulkout_pipe, TSTATE_BBB_RESET3,
1638                         sc->transfer_xfer[XFER_BBB_RESET3]);
1639
1640                 return;
1641         case TSTATE_BBB_RESET3:
1642                 if (err)        /* should not occur */
1643                         printf("%s: BBB bulk-out clear stall failed, %s\n",
1644                                USBDEVNAME(sc->sc_dev), usbd_errstr(err));
1645                         /* no error recovery, otherwise we end up in a loop */
1646
1647                 sc->transfer_state = TSTATE_IDLE;
1648                 if (sc->transfer_priv) {
1649                         sc->transfer_cb(sc, sc->transfer_priv,
1650                                         sc->transfer_datalen,
1651                                         sc->transfer_status);
1652                 }
1653
1654                 return;
1655
1656         /***** Default *****/
1657         default:
1658                 panic("%s: Unknown state %d",
1659                       USBDEVNAME(sc->sc_dev), sc->transfer_state);
1660         }
1661 }
1662
1663 Static int
1664 umass_bbb_get_max_lun(struct umass_softc *sc)
1665 {
1666         usbd_device_handle udev;
1667         usb_device_request_t req;
1668         usbd_status err;
1669         usb_interface_descriptor_t *id;
1670         int maxlun = 0;
1671         u_int8_t buf = 0;
1672
1673         usbd_interface2device_handle(sc->iface, &udev);
1674         id = usbd_get_interface_descriptor(sc->iface);
1675
1676         /* The Get Max Lun command is a class-specific request. */
1677         req.bmRequestType = UT_READ_CLASS_INTERFACE;
1678         req.bRequest = UR_BBB_GET_MAX_LUN;
1679         USETW(req.wValue, 0);
1680         USETW(req.wIndex, id->bInterfaceNumber);
1681         USETW(req.wLength, 1);
1682
1683         err = usbd_do_request(udev, &req, &buf);
1684         switch (err) {
1685         case USBD_NORMAL_COMPLETION:
1686                 maxlun = buf;
1687                 DPRINTF(UDMASS_BBB, ("%s: Max Lun is %d\n",
1688                     USBDEVNAME(sc->sc_dev), maxlun));
1689                 break;
1690         case USBD_STALLED:
1691         case USBD_SHORT_XFER:
1692         default:
1693                 /* Device doesn't support Get Max Lun request. */
1694                 printf("%s: Get Max Lun not supported (%s)\n",
1695                     USBDEVNAME(sc->sc_dev), usbd_errstr(err));
1696                 /* XXX Should we port_reset the device? */
1697                 break;
1698         }
1699
1700         return(maxlun);
1701 }
1702
1703 /*
1704  * Command/Bulk/Interrupt (CBI) specific functions
1705  */
1706
1707 Static int
1708 umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen,
1709                usbd_xfer_handle xfer)
1710 {
1711         usbd_device_handle udev;
1712
1713         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
1714                 ("%s: umass_cbi_adsc: wrong sc->proto 0x%02x\n",
1715                         USBDEVNAME(sc->sc_dev), sc->proto));
1716
1717         usbd_interface2device_handle(sc->iface, &udev);
1718
1719         sc->request.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1720         sc->request.bRequest = UR_CBI_ADSC;
1721         USETW(sc->request.wValue, 0);
1722         USETW(sc->request.wIndex, sc->ifaceno);
1723         USETW(sc->request.wLength, buflen);
1724         return umass_setup_ctrl_transfer(sc, udev, &sc->request, buffer,
1725                                          buflen, 0, xfer);
1726 }
1727
1728
1729 Static void
1730 umass_cbi_reset(struct umass_softc *sc, int status)
1731 {
1732         int i;
1733 #       define SEND_DIAGNOSTIC_CMDLEN   12
1734
1735         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
1736                 ("%s: umass_cbi_reset: wrong sc->proto 0x%02x\n",
1737                         USBDEVNAME(sc->sc_dev), sc->proto));
1738
1739         /*
1740          * Command Block Reset Protocol
1741          *
1742          * First send a reset request to the device. Then clear
1743          * any possibly stalled bulk endpoints.
1744
1745          * This is done in 3 steps, states:
1746          * TSTATE_CBI_RESET1
1747          * TSTATE_CBI_RESET2
1748          * TSTATE_CBI_RESET3
1749          *
1750          * If the reset doesn't succeed, the device should be port reset.
1751          */
1752
1753         DPRINTF(UDMASS_CBI, ("%s: CBI Reset\n",
1754                 USBDEVNAME(sc->sc_dev)));
1755
1756         KASSERT(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN,
1757                 ("%s: CBL struct is too small (%ld < %d)\n",
1758                         USBDEVNAME(sc->sc_dev),
1759                         (long)sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN));
1760
1761         sc->transfer_state = TSTATE_CBI_RESET1;
1762         sc->transfer_status = status;
1763
1764         /* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between
1765          * the two the last 10 bytes of the cbl is filled with 0xff (section
1766          * 2.2 of the CBI spec).
1767          */
1768         sc->cbl[0] = 0x1d;      /* Command Block Reset */
1769         sc->cbl[1] = 0x04;
1770         for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++)
1771                 sc->cbl[i] = 0xff;
1772
1773         umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN,
1774                        sc->transfer_xfer[XFER_CBI_RESET1]);
1775         /* XXX if the command fails we should reset the port on the bub */
1776 }
1777
1778 Static void
1779 umass_cbi_transfer(struct umass_softc *sc, int lun,
1780                 void *cmd, int cmdlen, void *data, int datalen, int dir,
1781                 transfer_cb_f cb, void *priv)
1782 {
1783         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
1784                 ("%s: umass_cbi_transfer: wrong sc->proto 0x%02x\n",
1785                         USBDEVNAME(sc->sc_dev), sc->proto));
1786
1787         /*
1788          * Do a CBI transfer with cmdlen bytes from cmd, possibly
1789          * a data phase of datalen bytes from/to the device and finally a
1790          * csw read phase.
1791          * If the data direction was inbound a maximum of datalen bytes
1792          * is stored in the buffer pointed to by data.
1793          *
1794          * umass_cbi_transfer initialises the transfer and lets the state
1795          * machine in umass_cbi_state handle the completion. It uses the
1796          * following states:
1797          * TSTATE_CBI_COMMAND
1798          *   -> XXX fill in
1799          *
1800          * An error in any of those states will invoke
1801          * umass_cbi_reset.
1802          */
1803
1804         /* check the given arguments */
1805         KASSERT(datalen == 0 || data != NULL,
1806                 ("%s: datalen > 0, but no buffer",USBDEVNAME(sc->sc_dev)));
1807         KASSERT(datalen == 0 || dir != DIR_NONE,
1808                 ("%s: direction is NONE while datalen is not zero\n",
1809                         USBDEVNAME(sc->sc_dev)));
1810
1811         /* store the details for the data transfer phase */
1812         sc->transfer_dir = dir;
1813         sc->transfer_data = data;
1814         sc->transfer_datalen = datalen;
1815         sc->transfer_actlen = 0;
1816         sc->transfer_cb = cb;
1817         sc->transfer_priv = priv;
1818         sc->transfer_status = STATUS_CMD_OK;
1819
1820         /* move from idle to the command state */
1821         sc->transfer_state = TSTATE_CBI_COMMAND;
1822
1823         DIF(UDMASS_CBI, umass_cbi_dump_cmd(sc, cmd, cmdlen));
1824
1825         /* Send the Command Block from host to device via control endpoint. */
1826         if (umass_cbi_adsc(sc, cmd, cmdlen, sc->transfer_xfer[XFER_CBI_CB]))
1827                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1828 }
1829
1830 Static void
1831 umass_cbi_state(usbd_xfer_handle xfer, usbd_private_handle priv,
1832                 usbd_status err)
1833 {
1834         struct umass_softc *sc = (struct umass_softc *) priv;
1835
1836         KASSERT(sc->proto & (UMASS_PROTO_CBI|UMASS_PROTO_CBI_I),
1837                 ("%s: umass_cbi_state: wrong sc->proto 0x%02x\n",
1838                         USBDEVNAME(sc->sc_dev), sc->proto));
1839
1840         /*
1841          * State handling for CBI transfers.
1842          */
1843
1844         DPRINTF(UDMASS_CBI, ("%s: Handling CBI state %d (%s), xfer=%p, %s\n",
1845                 USBDEVNAME(sc->sc_dev), sc->transfer_state,
1846                 states[sc->transfer_state], xfer, usbd_errstr(err)));
1847
1848         switch (sc->transfer_state) {
1849
1850         /***** CBI Transfer *****/
1851         case TSTATE_CBI_COMMAND:
1852                 if (err == USBD_STALLED) {
1853                         DPRINTF(UDMASS_CBI, ("%s: Command Transport failed\n",
1854                                 USBDEVNAME(sc->sc_dev)));
1855                         /* Status transport by control pipe (section 2.3.2.1).
1856                          * The command contained in the command block failed.
1857                          *
1858                          * The control pipe has already been unstalled by the
1859                          * USB stack.
1860                          * Section 2.4.3.1.1 states that the bulk in endpoints
1861                          * should not be stalled at this point.
1862                          */
1863
1864                         sc->transfer_state = TSTATE_IDLE;
1865                         sc->transfer_cb(sc, sc->transfer_priv,
1866                                         sc->transfer_datalen,
1867                                         STATUS_CMD_FAILED);
1868
1869                         return;
1870                 } else if (err) {
1871                         DPRINTF(UDMASS_CBI, ("%s: failed to send ADSC\n",
1872                                 USBDEVNAME(sc->sc_dev)));
1873                         umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1874
1875                         return;
1876                 }
1877
1878                 sc->transfer_state = TSTATE_CBI_DATA;
1879                 if (sc->transfer_dir == DIR_IN) {
1880                         if (umass_setup_transfer(sc, sc->bulkin_pipe,
1881                                         sc->transfer_data, sc->transfer_datalen,
1882                                         USBD_SHORT_XFER_OK,
1883                                         sc->transfer_xfer[XFER_CBI_DATA]))
1884                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1885
1886                 } else if (sc->transfer_dir == DIR_OUT) {
1887                         if (umass_setup_transfer(sc, sc->bulkout_pipe,
1888                                         sc->transfer_data, sc->transfer_datalen,
1889                                         0,      /* fixed length transfer */
1890                                         sc->transfer_xfer[XFER_CBI_DATA]))
1891                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1892
1893                 } else if (sc->proto & UMASS_PROTO_CBI_I) {
1894                         DPRINTF(UDMASS_CBI, ("%s: no data phase\n",
1895                                 USBDEVNAME(sc->sc_dev)));
1896                         sc->transfer_state = TSTATE_CBI_STATUS;
1897                         if (umass_setup_transfer(sc, sc->intrin_pipe,
1898                                         &sc->sbl, sizeof(sc->sbl),
1899                                         0,      /* fixed length transfer */
1900                                         sc->transfer_xfer[XFER_CBI_STATUS])){
1901                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1902                         }
1903                 } else {
1904                         DPRINTF(UDMASS_CBI, ("%s: no data phase\n",
1905                                 USBDEVNAME(sc->sc_dev)));
1906                         /* No command completion interrupt. Request
1907                          * sense data.
1908                          */
1909                         sc->transfer_state = TSTATE_IDLE;
1910                         sc->transfer_cb(sc, sc->transfer_priv,
1911                                0, STATUS_CMD_UNKNOWN);
1912                 }
1913
1914                 return;
1915
1916         case TSTATE_CBI_DATA:
1917                 /* retrieve the length of the transfer that was done */
1918                 usbd_get_xfer_status(xfer,NULL,NULL,&sc->transfer_actlen,NULL);
1919
1920                 if (err) {
1921                         DPRINTF(UDMASS_CBI, ("%s: Data-%s %db failed, "
1922                                 "%s\n", USBDEVNAME(sc->sc_dev),
1923                                 (sc->transfer_dir == DIR_IN?"in":"out"),
1924                                 sc->transfer_datalen,usbd_errstr(err)));
1925
1926                         if (err == USBD_STALLED) {
1927                                 umass_clear_endpoint_stall(sc,
1928                                         sc->bulkin, sc->bulkin_pipe,
1929                                         TSTATE_CBI_DCLEAR,
1930                                         sc->transfer_xfer[XFER_CBI_DCLEAR]);
1931                         } else {
1932                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1933                         }
1934                         return;
1935                 }
1936
1937                 DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN)
1938                                         umass_dump_buffer(sc, sc->transfer_data,
1939                                                 sc->transfer_actlen, 48));
1940
1941                 if (sc->proto & UMASS_PROTO_CBI_I) {
1942                         sc->transfer_state = TSTATE_CBI_STATUS;
1943                         if (umass_setup_transfer(sc, sc->intrin_pipe,
1944                                     &sc->sbl, sizeof(sc->sbl),
1945                                     0,  /* fixed length transfer */
1946                                     sc->transfer_xfer[XFER_CBI_STATUS])){
1947                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1948                         }
1949                 } else {
1950                         /* No command completion interrupt. Request
1951                          * sense to get status of command.
1952                          */
1953                         sc->transfer_state = TSTATE_IDLE;
1954                         sc->transfer_cb(sc, sc->transfer_priv,
1955                                 sc->transfer_datalen - sc->transfer_actlen,
1956                                 STATUS_CMD_UNKNOWN);
1957                 }
1958                 return;
1959
1960         case TSTATE_CBI_STATUS:
1961                 if (err) {
1962                         DPRINTF(UDMASS_CBI, ("%s: Status Transport failed\n",
1963                                 USBDEVNAME(sc->sc_dev)));
1964                         /* Status transport by interrupt pipe (section 2.3.2.2).
1965                          */
1966
1967                         if (err == USBD_STALLED) {
1968                                 umass_clear_endpoint_stall(sc,
1969                                         sc->intrin, sc->intrin_pipe,
1970                                         TSTATE_CBI_SCLEAR,
1971                                         sc->transfer_xfer[XFER_CBI_SCLEAR]);
1972                         } else {
1973                                 umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1974                         }
1975                         return;
1976                 }
1977
1978                 /* Dissect the information in the buffer */
1979
1980                 if (sc->proto & UMASS_PROTO_UFI) {
1981                         int status;
1982
1983                         /* Section 3.4.3.1.3 specifies that the UFI command
1984                          * protocol returns an ASC and ASCQ in the interrupt
1985                          * data block.
1986                          */
1987
1988                         DPRINTF(UDMASS_CBI, ("%s: UFI CCI, ASC = 0x%02x, "
1989                                 "ASCQ = 0x%02x\n",
1990                                 USBDEVNAME(sc->sc_dev),
1991                                 sc->sbl.ufi.asc, sc->sbl.ufi.ascq));
1992
1993                         if (sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0)
1994                                 status = STATUS_CMD_OK;
1995                         else
1996                                 status = STATUS_CMD_FAILED;
1997
1998                         sc->transfer_state = TSTATE_IDLE;
1999                         sc->transfer_cb(sc, sc->transfer_priv,
2000                                 sc->transfer_datalen - sc->transfer_actlen,
2001                                 status);
2002                 } else {
2003                         /* Command Interrupt Data Block */
2004                         DPRINTF(UDMASS_CBI, ("%s: type=0x%02x, value=0x%02x\n",
2005                                 USBDEVNAME(sc->sc_dev),
2006                                 sc->sbl.common.type, sc->sbl.common.value));
2007
2008                         if (sc->sbl.common.type == IDB_TYPE_CCI) {
2009                                 int err;
2010
2011                                 if ((sc->sbl.common.value&IDB_VALUE_STATUS_MASK)
2012                                                         == IDB_VALUE_PASS) {
2013                                         err = STATUS_CMD_OK;
2014                                 } else if ((sc->sbl.common.value & IDB_VALUE_STATUS_MASK)
2015                                                         == IDB_VALUE_FAIL ||
2016                                            (sc->sbl.common.value & IDB_VALUE_STATUS_MASK)
2017                                                 == IDB_VALUE_PERSISTENT) {
2018                                         err = STATUS_CMD_FAILED;
2019                                 } else {
2020                                         err = STATUS_WIRE_FAILED;
2021                                 }
2022
2023                                 sc->transfer_state = TSTATE_IDLE;
2024                                 sc->transfer_cb(sc, sc->transfer_priv,
2025                                        sc->transfer_datalen-sc->transfer_actlen,
2026                                        err);
2027                         }
2028                 }
2029                 return;
2030
2031         case TSTATE_CBI_DCLEAR:
2032                 if (err) {      /* should not occur */
2033                         printf("%s: CBI bulk-in/out stall clear failed, %s\n",
2034                                USBDEVNAME(sc->sc_dev), usbd_errstr(err));
2035                         umass_cbi_reset(sc, STATUS_WIRE_FAILED);
2036                 }
2037
2038                 sc->transfer_state = TSTATE_IDLE;
2039                 sc->transfer_cb(sc, sc->transfer_priv,
2040                                 sc->transfer_datalen,
2041                                 STATUS_CMD_FAILED);
2042                 return;
2043
2044         case TSTATE_CBI_SCLEAR:
2045                 if (err)        /* should not occur */
2046                         printf("%s: CBI intr-in stall clear failed, %s\n",
2047                                USBDEVNAME(sc->sc_dev), usbd_errstr(err));
2048
2049                 /* Something really bad is going on. Reset the device */
2050                 umass_cbi_reset(sc, STATUS_CMD_FAILED);
2051                 return;
2052
2053         /***** CBI Reset *****/
2054         case TSTATE_CBI_RESET1:
2055                 if (err)
2056                         printf("%s: CBI reset failed, %s\n",
2057                                 USBDEVNAME(sc->sc_dev), usbd_errstr(err));
2058
2059                 umass_clear_endpoint_stall(sc,
2060                         sc->bulkin, sc->bulkin_pipe, TSTATE_CBI_RESET2,
2061                         sc->transfer_xfer[XFER_CBI_RESET2]);
2062
2063                 return;
2064         case TSTATE_CBI_RESET2:
2065                 if (err)        /* should not occur */
2066                         printf("%s: CBI bulk-in stall clear failed, %s\n",
2067                                USBDEVNAME(sc->sc_dev), usbd_errstr(err));
2068                         /* no error recovery, otherwise we end up in a loop */
2069
2070                 umass_clear_endpoint_stall(sc,
2071                         sc->bulkout, sc->bulkout_pipe, TSTATE_CBI_RESET3,
2072                         sc->transfer_xfer[XFER_CBI_RESET3]);
2073
2074                 return;
2075         case TSTATE_CBI_RESET3:
2076                 if (err)        /* should not occur */
2077                         printf("%s: CBI bulk-out stall clear failed, %s\n",
2078                                USBDEVNAME(sc->sc_dev), usbd_errstr(err));
2079                         /* no error recovery, otherwise we end up in a loop */
2080
2081                 sc->transfer_state = TSTATE_IDLE;
2082                 if (sc->transfer_priv) {
2083                         sc->transfer_cb(sc, sc->transfer_priv,
2084                                         sc->transfer_datalen,
2085                                         sc->transfer_status);
2086                 }
2087
2088                 return;
2089
2090
2091         /***** Default *****/
2092         default:
2093                 panic("%s: Unknown state %d",
2094                       USBDEVNAME(sc->sc_dev), sc->transfer_state);
2095         }
2096 }
2097
2098
2099
2100
2101 /*
2102  * CAM specific functions (used by SCSI, UFI, 8070i (ATAPI))
2103  */
2104
2105 Static int
2106 umass_cam_attach_sim(struct umass_softc *sc)
2107 {
2108         struct cam_devq *devq;          /* Per device Queue */
2109
2110         /* A HBA is attached to the CAM layer.
2111          *
2112          * The CAM layer will then after a while start probing for
2113          * devices on the bus. The number of SIMs is limited to one.
2114          */
2115
2116         devq = cam_simq_alloc(1 /*maximum openings*/);
2117         if (devq == NULL)
2118                 return(ENOMEM);
2119
2120         sc->umass_sim = cam_sim_alloc(umass_cam_action, umass_cam_poll,
2121                                 DEVNAME_SIM,
2122                                 sc /*priv*/,
2123                                 USBDEVUNIT(sc->sc_dev) /*unit number*/,
2124                                 1 /*maximum device openings*/,
2125                                 0 /*maximum tagged device openings*/,
2126                                 devq);
2127         cam_simq_release(devq);
2128         if (sc->umass_sim == NULL)
2129                 return(ENOMEM);
2130
2131         /*
2132          * If we could not register the bus we must immediately free the
2133          * sim so we do not attempt to deregister a bus later on that we
2134          * had not registered.
2135          */
2136         if (xpt_bus_register(sc->umass_sim, USBDEVUNIT(sc->sc_dev)) !=
2137             CAM_SUCCESS) {
2138                 cam_sim_free(sc->umass_sim);
2139                 sc->umass_sim = NULL;
2140                 return(ENOMEM);
2141         }
2142
2143         return(0);
2144 }
2145
2146 Static void
2147 umass_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
2148 {
2149 #ifdef USB_DEBUG
2150         if (ccb->ccb_h.status != CAM_REQ_CMP) {
2151                 DPRINTF(UDMASS_SCSI, ("%s:%d Rescan failed, 0x%04x\n",
2152                         periph->periph_name, periph->unit_number,
2153                         ccb->ccb_h.status));
2154         } else {
2155                 DPRINTF(UDMASS_SCSI, ("%s%d: Rescan succeeded\n",
2156                         periph->periph_name, periph->unit_number));
2157         }
2158 #endif
2159
2160         xpt_free_path(ccb->ccb_h.path);
2161         free(ccb, M_USBDEV);
2162 }
2163
2164 Static void
2165 umass_cam_rescan(void *addr)
2166 {
2167         struct umass_softc *sc = (struct umass_softc *) addr;
2168         struct cam_path *path;
2169         union ccb *ccb;
2170
2171         sc->rescan_timeout.callout = NULL;
2172         ccb = malloc(sizeof(union ccb), M_USBDEV, M_INTWAIT|M_ZERO);
2173
2174         DPRINTF(UDMASS_SCSI, ("scbus%d: scanning for %s:%d:%d:%d\n",
2175                 cam_sim_path(sc->umass_sim),
2176                 USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2177                 USBDEVUNIT(sc->sc_dev), CAM_LUN_WILDCARD));
2178
2179         if (xpt_create_path(&path, xpt_periph, cam_sim_path(sc->umass_sim),
2180                             CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD)
2181             != CAM_REQ_CMP)
2182                 return;
2183
2184         xpt_setup_ccb(&ccb->ccb_h, path, 5/*priority (low)*/);
2185         ccb->ccb_h.func_code = XPT_SCAN_BUS;
2186         ccb->ccb_h.cbfcnp = umass_cam_rescan_callback;
2187         ccb->crcn.flags = CAM_FLAG_NONE;
2188         xpt_action(ccb);
2189
2190         /* The scan is in progress now. */
2191 }
2192
2193 Static int
2194 umass_cam_attach(struct umass_softc *sc)
2195 {
2196 #ifndef USB_DEBUG
2197         if (bootverbose)
2198 #endif
2199                 printf("%s:%d:%d:%d: Attached to scbus%d\n",
2200                         USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2201                         USBDEVUNIT(sc->sc_dev), CAM_LUN_WILDCARD,
2202                         cam_sim_path(sc->umass_sim));
2203
2204         if (!cold) {
2205                 /*
2206                  * Notify CAM of the new device after 1 second delay. Any
2207                  * failure is benign, as the user can still do it by hand
2208                  * (camcontrol rescan <busno>). Only do this if we are not
2209                  * booting, because CAM does a scan after booting has
2210                  * completed, when interrupts have been enabled.
2211                  */
2212                 sc->rescan_timeout =
2213                         timeout(umass_cam_rescan, sc, MS_TO_TICKS(200));
2214         }
2215
2216         return(0);      /* always succesfull */
2217 }
2218
2219 /* umass_cam_detach
2220  *      detach from the CAM layer
2221  */
2222
2223 Static int
2224 umass_cam_detach_sim(struct umass_softc *sc)
2225 {
2226         if (sc->rescan_timeout.callout) {
2227                 untimeout(umass_cam_rescan, sc, sc->rescan_timeout);
2228                 sc->rescan_timeout.callout = NULL;
2229         }
2230         if (sc->umass_sim) {
2231                 if (xpt_bus_deregister(cam_sim_path(sc->umass_sim)))
2232                         cam_sim_free(sc->umass_sim);
2233                 else
2234                         return(EBUSY);
2235
2236                 sc->umass_sim = NULL;
2237         }
2238
2239         return(0);
2240 }
2241
2242 /* umass_cam_action
2243  *      CAM requests for action come through here
2244  */
2245
2246 Static void
2247 umass_cam_action(struct cam_sim *sim, union ccb *ccb)
2248 {
2249         struct umass_softc *sc = (struct umass_softc *)sim->softc;
2250
2251         /* The softc is still there, but marked as going away. umass_cam_detach
2252          * has not yet notified CAM of the lost device however.
2253          */
2254         if (sc && (sc->flags & UMASS_FLAGS_GONE)) {
2255                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:func_code 0x%04x: "
2256                         "Invalid target (gone)\n",
2257                         USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2258                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2259                         ccb->ccb_h.func_code));
2260                 ccb->ccb_h.status = CAM_TID_INVALID;
2261                 xpt_done(ccb);
2262                 return;
2263         }
2264
2265         /* Verify, depending on the operation to perform, that we either got a
2266          * valid sc, because an existing target was referenced, or otherwise
2267          * the SIM is addressed.
2268          *
2269          * This avoids bombing out at a printf and does give the CAM layer some
2270          * sensible feedback on errors.
2271          */
2272         switch (ccb->ccb_h.func_code) {
2273         case XPT_SCSI_IO:
2274         case XPT_RESET_DEV:
2275         case XPT_GET_TRAN_SETTINGS:
2276         case XPT_SET_TRAN_SETTINGS:
2277         case XPT_CALC_GEOMETRY:
2278                 /* the opcodes requiring a target. These should never occur. */
2279                 if (sc == NULL) {
2280                         printf("%s:%d:%d:%d:func_code 0x%04x: "
2281                                 "Invalid target (target needed)\n",
2282                                 DEVNAME_SIM, cam_sim_path(sc->umass_sim),
2283                                 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2284                                 ccb->ccb_h.func_code);
2285
2286                         ccb->ccb_h.status = CAM_TID_INVALID;
2287                         xpt_done(ccb);
2288                         return;
2289                 }
2290                 break;
2291         case XPT_PATH_INQ:
2292         case XPT_NOOP:
2293                 /* The opcodes sometimes aimed at a target (sc is valid),
2294                  * sometimes aimed at the SIM (sc is invalid and target is
2295                  * CAM_TARGET_WILDCARD)
2296                  */
2297                 if (sc == NULL && ccb->ccb_h.target_id != CAM_TARGET_WILDCARD) {
2298                         DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:func_code 0x%04x: "
2299                                 "Invalid target (no wildcard)\n",
2300                                 DEVNAME_SIM, cam_sim_path(sc->umass_sim),
2301                                 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2302                                 ccb->ccb_h.func_code));
2303
2304                         ccb->ccb_h.status = CAM_TID_INVALID;
2305                         xpt_done(ccb);
2306                         return;
2307                 }
2308                 break;
2309         default:
2310                 /* XXX Hm, we should check the input parameters */
2311                 break;
2312         }
2313
2314         /* Perform the requested action */
2315         switch (ccb->ccb_h.func_code) {
2316         case XPT_SCSI_IO:
2317         {
2318                 struct ccb_scsiio *csio = &ccb->csio;   /* deref union */
2319                 int dir;
2320                 unsigned char *cmd;
2321                 int cmdlen;
2322                 unsigned char *rcmd;
2323                 int rcmdlen;
2324
2325                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_SCSI_IO: "
2326                         "cmd: 0x%02x, flags: 0x%02x, "
2327                         "%db cmd/%db data/%db sense\n",
2328                         USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2329                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2330                         csio->cdb_io.cdb_bytes[0],
2331                         ccb->ccb_h.flags & CAM_DIR_MASK,
2332                         csio->cdb_len, csio->dxfer_len,
2333                         csio->sense_len));
2334
2335                 /* clear the end of the buffer to make sure we don't send out
2336                  * garbage.
2337                  */
2338                 DIF(UDMASS_SCSI, if ((ccb->ccb_h.flags & CAM_DIR_MASK)
2339                                      == CAM_DIR_OUT)
2340                                         umass_dump_buffer(sc, csio->data_ptr,
2341                                                 csio->dxfer_len, 48));
2342
2343                 if (sc->transfer_state != TSTATE_IDLE) {
2344                         DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_SCSI_IO: "
2345                                 "I/O in progress, deferring (state %d, %s)\n",
2346                                 USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2347                                 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2348                                 sc->transfer_state,states[sc->transfer_state]));
2349                         ccb->ccb_h.status = CAM_SCSI_BUSY;
2350                         xpt_done(ccb);
2351                         return;
2352                 }
2353
2354                 switch(ccb->ccb_h.flags&CAM_DIR_MASK) {
2355                 case CAM_DIR_IN:
2356                         dir = DIR_IN;
2357                         break;
2358                 case CAM_DIR_OUT:
2359                         dir = DIR_OUT;
2360                         break;
2361                 default:
2362                         dir = DIR_NONE;
2363                 }
2364
2365                 ccb->ccb_h.status = CAM_REQ_INPROG | CAM_SIM_QUEUED;
2366
2367
2368                 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2369                         cmd = (unsigned char *) csio->cdb_io.cdb_ptr;
2370                 } else {
2371                         cmd = (unsigned char *) &csio->cdb_io.cdb_bytes;
2372                 }
2373                 cmdlen = csio->cdb_len;
2374                 rcmd = (unsigned char *) &sc->cam_scsi_command;
2375                 rcmdlen = sizeof(sc->cam_scsi_command);
2376
2377                 /* sc->transform will convert the command to the command
2378                  * (format) needed by the specific command set and return
2379                  * the converted command in a buffer pointed to be rcmd.
2380                  * We pass in a buffer, but if the command does not
2381                  * have to be transformed it returns a ptr to the original
2382                  * buffer (see umass_scsi_transform).
2383                  */
2384
2385                 if (sc->transform(sc, cmd, cmdlen, &rcmd, &rcmdlen)) {
2386                         /*
2387                          * Handle EVPD inquiry for broken devices first
2388                          * NO_INQUIRY also implies NO_INQUIRY_EVPD
2389                          */
2390                         if ((sc->quirks & (NO_INQUIRY_EVPD | NO_INQUIRY)) &&
2391                             rcmd[0] == INQUIRY && (rcmd[1] & SI_EVPD)) {
2392                                 struct scsi_sense_data *sense;
2393
2394                                 sense = &ccb->csio.sense_data;
2395                                 bzero(sense, sizeof(*sense));
2396                                 sense->error_code = SSD_CURRENT_ERROR;
2397                                 sense->flags = SSD_KEY_ILLEGAL_REQUEST;
2398                                 sense->add_sense_code = 0x24;
2399                                 sense->extra_len = 10;
2400                                 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2401                                 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR |
2402                                     CAM_AUTOSNS_VALID;
2403                                 xpt_done(ccb);
2404                                 return;
2405                         }
2406                         /* Return fake inquiry data for broken devices */
2407                         if ((sc->quirks & NO_INQUIRY) && rcmd[0] == INQUIRY) {
2408                                 struct ccb_scsiio *csio = &ccb->csio;
2409
2410                                 memcpy(csio->data_ptr, &fake_inq_data,
2411                                     sizeof(fake_inq_data));
2412                                 csio->scsi_status = SCSI_STATUS_OK;
2413                                 ccb->ccb_h.status = CAM_REQ_CMP;
2414                                 xpt_done(ccb);
2415                                 return;
2416                         }
2417                         if ((sc->quirks & FORCE_SHORT_INQUIRY) &&
2418                             rcmd[0] == INQUIRY) {
2419                                 csio->dxfer_len = SHORT_INQUIRY_LENGTH;
2420                         }
2421                         sc->transfer(sc, ccb->ccb_h.target_lun, rcmd, rcmdlen,
2422                                      csio->data_ptr,
2423                                      csio->dxfer_len, dir,
2424                                      umass_cam_cb, (void *) ccb);
2425                 } else {
2426                         ccb->ccb_h.status = CAM_REQ_INVALID;
2427                         xpt_done(ccb);
2428                 }
2429
2430                 break;
2431         }
2432         case XPT_PATH_INQ:
2433         {
2434                 struct ccb_pathinq *cpi = &ccb->cpi;
2435
2436                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_PATH_INQ:.\n",
2437                         (sc == NULL? DEVNAME_SIM:USBDEVNAME(sc->sc_dev)),
2438                         cam_sim_path(sc->umass_sim),
2439                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
2440
2441                 /* host specific information */
2442                 cpi->version_num = 1;
2443                 cpi->hba_inquiry = 0;
2444                 cpi->target_sprt = 0;
2445                 cpi->hba_misc = PIM_NO_6_BYTE;
2446                 cpi->hba_eng_cnt = 0;
2447                 cpi->max_target = UMASS_SCSIID_MAX;     /* one target */
2448                 cpi->initiator_id = UMASS_SCSIID_HOST;
2449                 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2450                 strncpy(cpi->hba_vid, "USB SCSI", HBA_IDLEN);
2451                 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2452                 cpi->unit_number = cam_sim_unit(sim);
2453                 cpi->bus_id = USBDEVUNIT(sc->sc_dev);
2454
2455                 if (sc == NULL) {
2456                         cpi->base_transfer_speed = 0;
2457                         cpi->max_lun = 0;
2458                 } else {
2459                         if (sc->quirks & FLOPPY_SPEED) {
2460                             cpi->base_transfer_speed = UMASS_FLOPPY_TRANSFER_SPEED;
2461                         } else {
2462                             cpi->base_transfer_speed = UMASS_DEFAULT_TRANSFER_SPEED;
2463                         }
2464                         cpi->max_lun = sc->maxlun;
2465                 }
2466
2467                 cpi->ccb_h.status = CAM_REQ_CMP;
2468                 xpt_done(ccb);
2469                 break;
2470         }
2471         case XPT_RESET_DEV:
2472         {
2473                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_RESET_DEV:.\n",
2474                         USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2475                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
2476
2477                 ccb->ccb_h.status = CAM_REQ_INPROG;
2478                 umass_reset(sc, umass_cam_cb, (void *) ccb);
2479                 break;
2480         }
2481         case XPT_GET_TRAN_SETTINGS:
2482         {
2483                 struct ccb_trans_settings *cts = &ccb->cts;
2484
2485                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_GET_TRAN_SETTINGS:.\n",
2486                         USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2487                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
2488
2489                 cts->valid = 0;
2490                 cts->flags = 0;         /* no disconnection, tagging */
2491
2492                 ccb->ccb_h.status = CAM_REQ_CMP;
2493                 xpt_done(ccb);
2494                 break;
2495         }
2496         case XPT_SET_TRAN_SETTINGS:
2497         {
2498                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_SET_TRAN_SETTINGS:.\n",
2499                         USBDEVNAME(sc->sc_dev), cam_sim_path(sc->umass_sim),
2500                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
2501
2502                 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2503                 xpt_done(ccb);
2504                 break;
2505         }
2506         case XPT_CALC_GEOMETRY:
2507         {
2508                 cam_calc_geometry(&ccb->ccg, /*extended*/1);
2509                 xpt_done(ccb);
2510                 break;
2511         }
2512         case XPT_NOOP:
2513         {
2514                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:XPT_NOOP:.\n",
2515                         (sc == NULL? DEVNAME_SIM:USBDEVNAME(sc->sc_dev)),
2516                         cam_sim_path(sc->umass_sim),
2517                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun));
2518
2519                 ccb->ccb_h.status = CAM_REQ_CMP;
2520                 xpt_done(ccb);
2521                 break;
2522         }
2523         default:
2524                 DPRINTF(UDMASS_SCSI, ("%s:%d:%d:%d:func_code 0x%04x: "
2525                         "Not implemented\n",
2526                         (sc == NULL? DEVNAME_SIM:USBDEVNAME(sc->sc_dev)),
2527                         cam_sim_path(sc->umass_sim),
2528                         ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2529                         ccb->ccb_h.func_code));
2530
2531                 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2532                 xpt_done(ccb);
2533                 break;
2534         }
2535 }
2536
2537 /* umass_cam_poll
2538  *      all requests are handled through umass_cam_action, requests
2539  *      are never pending. So, nothing to do here.
2540  */
2541 Static void
2542 umass_cam_poll(struct cam_sim *sim)
2543 {
2544 #ifdef USB_DEBUG
2545         struct umass_softc *sc = (struct umass_softc *) sim->softc;
2546
2547         DPRINTF(UDMASS_SCSI, ("%s: CAM poll\n",
2548                 USBDEVNAME(sc->sc_dev)));
2549 #endif
2550
2551         /* nop */
2552 }
2553
2554
2555 /* umass_cam_cb
2556  *      finalise a completed CAM command
2557  */
2558
2559 Static void
2560 umass_cam_cb(struct umass_softc *sc, void *priv, int residue, int status)
2561 {
2562         union ccb *ccb = (union ccb *) priv;
2563         struct ccb_scsiio *csio = &ccb->csio;           /* deref union */
2564
2565         csio->resid = residue;
2566
2567         switch (status) {
2568         case STATUS_CMD_OK:
2569                 ccb->ccb_h.status = CAM_REQ_CMP;
2570                 xpt_done(ccb);
2571                 break;
2572
2573         case STATUS_CMD_UNKNOWN:
2574         case STATUS_CMD_FAILED:
2575                 switch (ccb->ccb_h.func_code) {
2576                 case XPT_SCSI_IO:
2577                 {
2578                         unsigned char *rcmd;
2579                         int rcmdlen;
2580
2581                         /* fetch sense data */
2582                         /* the rest of the command was filled in at attach */
2583                         sc->cam_scsi_sense.length = csio->sense_len;
2584
2585                         DPRINTF(UDMASS_SCSI,("%s: Fetching %db sense data\n",
2586                                 USBDEVNAME(sc->sc_dev), csio->sense_len));
2587
2588                         rcmd = (unsigned char *) &sc->cam_scsi_command;
2589                         rcmdlen = sizeof(sc->cam_scsi_command);
2590
2591                         if (sc->transform(sc,
2592                                     (unsigned char *) &sc->cam_scsi_sense,
2593                                     sizeof(sc->cam_scsi_sense),
2594                                     &rcmd, &rcmdlen)) {
2595                                 if ((sc->quirks & FORCE_SHORT_INQUIRY) && (rcmd[0] == INQUIRY)) {
2596                                         csio->sense_len = SHORT_INQUIRY_LENGTH;
2597                                 }
2598                                 sc->transfer(sc, ccb->ccb_h.target_lun,
2599                                              rcmd, rcmdlen,
2600                                              &csio->sense_data,
2601                                              csio->sense_len, DIR_IN,
2602                                              umass_cam_sense_cb, (void *) ccb);
2603                         } else {
2604                                 panic("transform(REQUEST_SENSE) failed");
2605                         }
2606                         break;
2607                 }
2608                 case XPT_RESET_DEV: /* Reset failed */
2609                         ccb->ccb_h.status = CAM_REQ_CMP_ERR;
2610                         xpt_done(ccb);
2611                         break;
2612                 default:
2613                         panic("umass_cam_cb called for func_code %d",
2614                               ccb->ccb_h.func_code);
2615                 }
2616                 break;
2617
2618         case STATUS_WIRE_FAILED:
2619                 /* the wire protocol failed and will have recovered
2620                  * (hopefully).  We return an error to CAM and let CAM retry
2621                  * the command if necessary.
2622                  */
2623                 ccb->ccb_h.status = CAM_REQ_CMP_ERR;
2624                 xpt_done(ccb);
2625                 break;
2626         default:
2627                 panic("%s: Unknown status %d in umass_cam_cb",
2628                         USBDEVNAME(sc->sc_dev), status);
2629         }
2630 }
2631
2632 /* Finalise a completed autosense operation
2633  */
2634 Static void
2635 umass_cam_sense_cb(struct umass_softc *sc, void *priv, int residue, int status)
2636 {
2637         union ccb *ccb = (union ccb *) priv;
2638         struct ccb_scsiio *csio = &ccb->csio;           /* deref union */
2639         unsigned char *rcmd;
2640         int rcmdlen;
2641
2642         switch (status) {
2643         case STATUS_CMD_OK:
2644         case STATUS_CMD_UNKNOWN:
2645         case STATUS_CMD_FAILED:
2646                 /* Getting sense data always succeeds (apart from wire
2647                  * failures).
2648                  */
2649                 if ((sc->quirks & RS_NO_CLEAR_UA)
2650                     && csio->cdb_io.cdb_bytes[0] == INQUIRY
2651                     && (csio->sense_data.flags & SSD_KEY)
2652                                                 == SSD_KEY_UNIT_ATTENTION) {
2653                         /* Ignore unit attention errors in the case where
2654                          * the Unit Attention state is not cleared on
2655                          * REQUEST SENSE. They will appear again at the next
2656                          * command.
2657                          */
2658                         ccb->ccb_h.status = CAM_REQ_CMP;
2659                 } else if ((csio->sense_data.flags & SSD_KEY)
2660                                                 == SSD_KEY_NO_SENSE) {
2661                         /* No problem after all (in the case of CBI without
2662                          * CCI)
2663                          */
2664                         ccb->ccb_h.status = CAM_REQ_CMP;
2665                 } else if ((sc->quirks & RS_NO_CLEAR_UA) &&
2666                            (csio->cdb_io.cdb_bytes[0] == READ_CAPACITY) &&
2667                            ((csio->sense_data.flags & SSD_KEY)
2668                             == SSD_KEY_UNIT_ATTENTION)) {
2669                         /*
2670                          * Some devices do not clear the unit attention error
2671                          * on request sense. We insert a test unit ready
2672                          * command to make sure we clear the unit attention
2673                          * condition, then allow the retry to proceed as
2674                          * usual.
2675                          */
2676
2677                         ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2678                                             | CAM_AUTOSNS_VALID;
2679                         csio->scsi_status = SCSI_STATUS_CHECK_COND;
2680
2681 #if 0
2682                         DELAY(300000);
2683 #endif
2684
2685                         DPRINTF(UDMASS_SCSI,("%s: Doing a sneaky"
2686                                              "TEST_UNIT_READY\n",
2687                                 USBDEVNAME(sc->sc_dev)));
2688
2689                         /* the rest of the command was filled in at attach */
2690
2691                         rcmd = (unsigned char *) &sc->cam_scsi_command2;
2692                         rcmdlen = sizeof(sc->cam_scsi_command2);
2693
2694                         if (sc->transform(sc,
2695                                         (unsigned char *)
2696                                         &sc->cam_scsi_test_unit_ready,
2697                                         sizeof(sc->cam_scsi_test_unit_ready),
2698                                         &rcmd, &rcmdlen)) {
2699                                 sc->transfer(sc, ccb->ccb_h.target_lun,
2700                                              rcmd, rcmdlen,
2701                                              NULL, 0, DIR_NONE,
2702                                              umass_cam_quirk_cb, (void *) ccb);
2703                         } else {
2704                                 panic("transform(TEST_UNIT_READY) failed");
2705                         }
2706                         break;
2707                 } else {
2708                         ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2709                                             | CAM_AUTOSNS_VALID;
2710                         csio->scsi_status = SCSI_STATUS_CHECK_COND;
2711                 }
2712                 xpt_done(ccb);
2713                 break;
2714
2715         default:
2716                 DPRINTF(UDMASS_SCSI, ("%s: Autosense failed, status %d\n",
2717                         USBDEVNAME(sc->sc_dev), status));
2718                 ccb->ccb_h.status = CAM_AUTOSENSE_FAIL;
2719                 xpt_done(ccb);
2720         }
2721 }
2722
2723 /*
2724  * This completion code just handles the fact that we sent a test-unit-ready
2725  * after having previously failed a READ CAPACITY with CHECK_COND.  Even
2726  * though this command succeeded, we have to tell CAM to retry.
2727  */
2728 Static void
2729 umass_cam_quirk_cb(struct umass_softc *sc, void *priv, int residue, int status)
2730 {
2731         union ccb *ccb = (union ccb *) priv;
2732
2733         DPRINTF(UDMASS_SCSI, ("%s: Test unit ready returned status %d\n",
2734         USBDEVNAME(sc->sc_dev), status));
2735 #if 0
2736         ccb->ccb_h.status = CAM_REQ_CMP;
2737 #endif
2738         ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2739                             | CAM_AUTOSNS_VALID;
2740         ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2741         xpt_done(ccb);
2742 }
2743
2744 Static int
2745 umass_driver_load(module_t mod, int what, void *arg)
2746 {
2747         switch (what) {
2748         case MOD_UNLOAD:
2749         case MOD_LOAD:
2750         default:
2751                 return(usbd_driver_load(mod, what, arg));
2752         }
2753 }
2754
2755 /*
2756  * SCSI specific functions
2757  */
2758
2759 Static int
2760 umass_scsi_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
2761                      unsigned char **rcmd, int *rcmdlen)
2762 {
2763         switch (cmd[0]) {
2764         case TEST_UNIT_READY:
2765                 if (sc->quirks & NO_TEST_UNIT_READY) {
2766                         KASSERT(*rcmdlen >= sizeof(struct scsi_start_stop_unit),
2767                                 ("rcmdlen = %d < %ld, buffer too small",
2768                                  *rcmdlen,
2769                                  (long)sizeof(struct scsi_start_stop_unit)));
2770                         DPRINTF(UDMASS_SCSI, ("%s: Converted TEST_UNIT_READY "
2771                                 "to START_UNIT\n", USBDEVNAME(sc->sc_dev)));
2772                         memset(*rcmd, 0, *rcmdlen);
2773                         (*rcmd)[0] = START_STOP_UNIT;
2774                         (*rcmd)[4] = SSS_START;
2775                         return 1;
2776                 }
2777                 /* fallthrough */
2778         case INQUIRY:
2779                 /* some drives wedge when asked for full inquiry information. */
2780                 if (sc->quirks & FORCE_SHORT_INQUIRY) {
2781                         memcpy(*rcmd, cmd, cmdlen);
2782                         *rcmdlen = cmdlen;
2783                         (*rcmd)[4] = SHORT_INQUIRY_LENGTH;
2784                         return 1;
2785                 }
2786                 /* fallthrough */
2787         default:
2788                 *rcmd = cmd;            /* We don't need to copy it */
2789                 *rcmdlen = cmdlen;
2790         }
2791
2792         return 1;
2793 }
2794 /* RBC specific functions */
2795 Static int
2796 umass_rbc_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
2797                      unsigned char **rcmd, int *rcmdlen)
2798 {
2799         switch (cmd[0]) {
2800         /* these commands are defined in RBC: */
2801         case READ_10:
2802         case READ_CAPACITY:
2803         case START_STOP_UNIT:
2804         case SYNCHRONIZE_CACHE:
2805         case WRITE_10:
2806         case 0x2f: /* VERIFY_10 is absent from scsi_all.h??? */
2807         case INQUIRY:
2808         case MODE_SELECT_10:
2809         case MODE_SENSE_10:
2810         case TEST_UNIT_READY:
2811         case WRITE_BUFFER:
2812          /* The following commands are not listed in my copy of the RBC specs.
2813           * CAM however seems to want those, and at least the Sony DSC device
2814           * appears to support those as well */
2815         case REQUEST_SENSE:
2816         case PREVENT_ALLOW:
2817                 *rcmd = cmd;            /* We don't need to copy it */
2818                 *rcmdlen = cmdlen;
2819                 return 1;
2820         /* All other commands are not legal in RBC */
2821         default:
2822                 printf("%s: Unsupported RBC command 0x%02x",
2823                         USBDEVNAME(sc->sc_dev), cmd[0]);
2824                 printf("\n");
2825                 return 0;       /* failure */
2826         }
2827 }
2828
2829 /*
2830  * UFI specific functions
2831  */
2832 Static int
2833 umass_ufi_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
2834                     unsigned char **rcmd, int *rcmdlen)
2835 {
2836         /* A UFI command is always 12 bytes in length */
2837         KASSERT(*rcmdlen >= UFI_COMMAND_LENGTH,
2838                 ("rcmdlen = %d < %d, buffer too small",
2839                  *rcmdlen, UFI_COMMAND_LENGTH));
2840
2841         *rcmdlen = UFI_COMMAND_LENGTH;
2842         memset(*rcmd, 0, UFI_COMMAND_LENGTH);
2843
2844         switch (cmd[0]) {
2845         /* Commands of which the format has been verified. They should work.
2846          * Copy the command into the (zeroed out) destination buffer.
2847          */
2848         case TEST_UNIT_READY:
2849                 if (sc->quirks &  NO_TEST_UNIT_READY) {
2850                         /* Some devices do not support this command.
2851                          * Start Stop Unit should give the same results
2852                          */
2853                         DPRINTF(UDMASS_UFI, ("%s: Converted TEST_UNIT_READY "
2854                                 "to START_UNIT\n", USBDEVNAME(sc->sc_dev)));
2855                         (*rcmd)[0] = START_STOP_UNIT;
2856                         (*rcmd)[4] = SSS_START;
2857                 } else {
2858                         memcpy(*rcmd, cmd, cmdlen);
2859                 }
2860                 return 1;
2861
2862         case REZERO_UNIT:
2863         case REQUEST_SENSE:
2864         case INQUIRY:
2865         case START_STOP_UNIT:
2866         case SEND_DIAGNOSTIC:
2867         case PREVENT_ALLOW:
2868         case READ_CAPACITY:
2869         case READ_10:
2870         case WRITE_10:
2871         case POSITION_TO_ELEMENT:       /* SEEK_10 */
2872         case MODE_SELECT_10:
2873         case MODE_SENSE_10:
2874         case READ_12:
2875         case WRITE_12:
2876                 memcpy(*rcmd, cmd, cmdlen);
2877                 return 1;
2878
2879         /* Other UFI commands: FORMAT_UNIT, READ_FORMAT_CAPACITY,
2880          * VERIFY, WRITE_AND_VERIFY.
2881          * These should be checked whether they somehow can be made to fit.
2882          */
2883
2884         default:
2885                 printf("%s: Unsupported UFI command 0x%02x\n",
2886                         USBDEVNAME(sc->sc_dev), cmd[0]);
2887                 return 0;       /* failure */
2888         }
2889 }
2890
2891 /*
2892  * 8070i (ATAPI) specific functions
2893  */
2894 Static int
2895 umass_atapi_transform(struct umass_softc *sc, unsigned char *cmd, int cmdlen,
2896                       unsigned char **rcmd, int *rcmdlen)
2897 {
2898         /* An ATAPI command is always 12 bytes in length. */
2899         KASSERT(*rcmdlen >= ATAPI_COMMAND_LENGTH,
2900                 ("rcmdlen = %d < %d, buffer too small",
2901                  *rcmdlen, ATAPI_COMMAND_LENGTH));
2902
2903         *rcmdlen = ATAPI_COMMAND_LENGTH;
2904         memset(*rcmd, 0, ATAPI_COMMAND_LENGTH);
2905
2906         switch (cmd[0]) {
2907         /* Commands of which the format has been verified. They should work.
2908          * Copy the command into the (zeroed out) destination buffer.
2909          */
2910         case INQUIRY:
2911                 memcpy(*rcmd, cmd, cmdlen);
2912                 /* some drives wedge when asked for full inquiry information. */
2913                 if (sc->quirks & FORCE_SHORT_INQUIRY)
2914                         (*rcmd)[4] = SHORT_INQUIRY_LENGTH;
2915                 return 1;
2916
2917         case TEST_UNIT_READY:
2918                 if (sc->quirks & NO_TEST_UNIT_READY) {
2919                         KASSERT(*rcmdlen >= sizeof(struct scsi_start_stop_unit),
2920                                 ("rcmdlen = %d < %ld, buffer too small",
2921                                  *rcmdlen,
2922                                  (long)sizeof(struct scsi_start_stop_unit)));
2923                         DPRINTF(UDMASS_SCSI, ("%s: Converted TEST_UNIT_READY "
2924                                 "to START_UNIT\n", USBDEVNAME(sc->sc_dev)));
2925                         memset(*rcmd, 0, *rcmdlen);
2926                         (*rcmd)[0] = START_STOP_UNIT;
2927                         (*rcmd)[4] = SSS_START;
2928                         return 1;
2929                 }
2930                 /* fallthrough */
2931         case REZERO_UNIT:
2932         case REQUEST_SENSE:
2933         case START_STOP_UNIT:
2934         case SEND_DIAGNOSTIC:
2935         case PREVENT_ALLOW:
2936         case READ_CAPACITY:
2937         case READ_10:
2938         case WRITE_10:
2939         case POSITION_TO_ELEMENT:       /* SEEK_10 */
2940         case SYNCHRONIZE_CACHE:
2941         case MODE_SELECT_10:
2942         case MODE_SENSE_10:
2943                 memcpy(*rcmd, cmd, cmdlen);
2944                 return 1;
2945
2946         case READ_12:
2947         case WRITE_12:
2948         default:
2949                 printf("%s: Unsupported ATAPI command 0x%02x\n",
2950                         USBDEVNAME(sc->sc_dev), cmd[0]);
2951                 return 0;       /* failure */
2952         }
2953 }
2954
2955
2956 /* (even the comment is missing) */
2957
2958 DRIVER_MODULE(umass, uhub, umass_driver, umass_devclass, umass_driver_load, 0);
2959
2960
2961
2962 #ifdef USB_DEBUG
2963 Static void
2964 umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw)
2965 {
2966         int clen = cbw->bCDBLength;
2967         int dlen = UGETDW(cbw->dCBWDataTransferLength);
2968         u_int8_t *c = cbw->CBWCDB;
2969         int tag = UGETDW(cbw->dCBWTag);
2970         int flags = cbw->bCBWFlags;
2971
2972         DPRINTF(UDMASS_BBB, ("%s: CBW %d: cmd = %db "
2973                 "(0x%02x%02x%02x%02x%02x%02x%s), "
2974                 "data = %db, dir = %s\n",
2975                 USBDEVNAME(sc->sc_dev), tag, clen,
2976                 c[0], c[1], c[2], c[3], c[4], c[5], (clen > 6? "...":""),
2977                 dlen, (flags == CBWFLAGS_IN? "in":
2978                        (flags == CBWFLAGS_OUT? "out":"<invalid>"))));
2979 }
2980
2981 Static void
2982 umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw)
2983 {
2984         int sig = UGETDW(csw->dCSWSignature);
2985         int tag = UGETW(csw->dCSWTag);
2986         int res = UGETDW(csw->dCSWDataResidue);
2987         int status = csw->bCSWStatus;
2988
2989         DPRINTF(UDMASS_BBB, ("%s: CSW %d: sig = 0x%08x (%s), tag = %d, "
2990                 "res = %d, status = 0x%02x (%s)\n", USBDEVNAME(sc->sc_dev),
2991                 tag, sig, (sig == CSWSIGNATURE?  "valid":"invalid"),
2992                 tag, res,
2993                 status, (status == CSWSTATUS_GOOD? "good":
2994                          (status == CSWSTATUS_FAILED? "failed":
2995                           (status == CSWSTATUS_PHASE? "phase":"<invalid>")))));
2996 }
2997
2998 Static void
2999 umass_cbi_dump_cmd(struct umass_softc *sc, void *cmd, int cmdlen)
3000 {
3001         u_int8_t *c = cmd;
3002         int dir = sc->transfer_dir;
3003
3004         DPRINTF(UDMASS_BBB, ("%s: cmd = %db "
3005                 "(0x%02x%02x%02x%02x%02x%02x%s), "
3006                 "data = %db, dir = %s\n",
3007                 USBDEVNAME(sc->sc_dev), cmdlen,
3008                 c[0], c[1], c[2], c[3], c[4], c[5], (cmdlen > 6? "...":""),
3009                 sc->transfer_datalen,
3010                 (dir == DIR_IN? "in":
3011                  (dir == DIR_OUT? "out":
3012                   (dir == DIR_NONE? "no data phase": "<invalid>")))));
3013 }
3014
3015 Static void
3016 umass_dump_buffer(struct umass_softc *sc, u_int8_t *buffer, int buflen,
3017                   int printlen)
3018 {
3019         int i, j;
3020         char s1[40];
3021         char s2[40];
3022         char s3[5];
3023
3024         s1[0] = '\0';
3025         s3[0] = '\0';
3026
3027         sprintf(s2, " buffer=%p, buflen=%d", buffer, buflen);
3028         for (i = 0; i < buflen && i < printlen; i++) {
3029                 j = i % 16;
3030                 if (j == 0 && i != 0) {
3031                         DPRINTF(UDMASS_GEN, ("%s: 0x %s%s\n",
3032                                 USBDEVNAME(sc->sc_dev), s1, s2));
3033                         s2[0] = '\0';
3034                 }
3035                 sprintf(&s1[j*2], "%02x", buffer[i] & 0xff);
3036         }
3037         if (buflen > printlen)
3038                 sprintf(s3, " ...");
3039         DPRINTF(UDMASS_GEN, ("%s: 0x %s%s%s\n",
3040                 USBDEVNAME(sc->sc_dev), s1, s2, s3));
3041 }
3042 #endif