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