umass.c revision 212136
1#include <sys/cdefs.h> 2__FBSDID("$FreeBSD: head/sys/dev/usb/storage/umass.c 212136 2010-09-02 04:39:45Z thompsa $"); 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: head/sys/dev/usb/storage/umass.c 212136 2010-09-02 04:39:45Z thompsa $ 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 <sys/stdint.h> 106#include <sys/stddef.h> 107#include <sys/param.h> 108#include <sys/queue.h> 109#include <sys/types.h> 110#include <sys/systm.h> 111#include <sys/kernel.h> 112#include <sys/bus.h> 113#include <sys/linker_set.h> 114#include <sys/module.h> 115#include <sys/lock.h> 116#include <sys/mutex.h> 117#include <sys/condvar.h> 118#include <sys/sysctl.h> 119#include <sys/sx.h> 120#include <sys/unistd.h> 121#include <sys/callout.h> 122#include <sys/malloc.h> 123#include <sys/priv.h> 124 125#include <dev/usb/usb.h> 126#include <dev/usb/usbdi.h> 127#include <dev/usb/usbdi_util.h> 128#include "usbdevs.h" 129 130#include <dev/usb/quirk/usb_quirk.h> 131 132#include <cam/cam.h> 133#include <cam/cam_ccb.h> 134#include <cam/cam_sim.h> 135#include <cam/cam_xpt_sim.h> 136#include <cam/scsi/scsi_all.h> 137#include <cam/scsi/scsi_da.h> 138 139#include <cam/cam_periph.h> 140 141#define UMASS_EXT_BUFFER 142#ifdef UMASS_EXT_BUFFER 143/* this enables loading of virtual buffers into DMA */ 144#define UMASS_USB_FLAGS .ext_buffer=1, 145#else 146#define UMASS_USB_FLAGS 147#endif 148 149#ifdef USB_DEBUG 150#define DIF(m, x) \ 151 do { \ 152 if (umass_debug & (m)) { x ; } \ 153 } while (0) 154 155#define DPRINTF(sc, m, fmt, ...) \ 156 do { \ 157 if (umass_debug & (m)) { \ 158 printf("%s:%s: " fmt, \ 159 (sc) ? (const char *)(sc)->sc_name : \ 160 (const char *)"umassX", \ 161 __FUNCTION__ ,## __VA_ARGS__); \ 162 } \ 163 } while (0) 164 165#define UDMASS_GEN 0x00010000 /* general */ 166#define UDMASS_SCSI 0x00020000 /* scsi */ 167#define UDMASS_UFI 0x00040000 /* ufi command set */ 168#define UDMASS_ATAPI 0x00080000 /* 8070i command set */ 169#define UDMASS_CMD (UDMASS_SCSI|UDMASS_UFI|UDMASS_ATAPI) 170#define UDMASS_USB 0x00100000 /* USB general */ 171#define UDMASS_BBB 0x00200000 /* Bulk-Only transfers */ 172#define UDMASS_CBI 0x00400000 /* CBI transfers */ 173#define UDMASS_WIRE (UDMASS_BBB|UDMASS_CBI) 174#define UDMASS_ALL 0xffff0000 /* all of the above */ 175static int umass_debug = 0; 176 177SYSCTL_NODE(_hw_usb, OID_AUTO, umass, CTLFLAG_RW, 0, "USB umass"); 178SYSCTL_INT(_hw_usb_umass, OID_AUTO, debug, CTLFLAG_RW, 179 &umass_debug, 0, "umass debug level"); 180 181TUNABLE_INT("hw.usb.umass.debug", &umass_debug); 182#else 183#define DIF(...) do { } while (0) 184#define DPRINTF(...) do { } while (0) 185#endif 186 187#define UMASS_GONE ((struct umass_softc *)1) 188 189#define UMASS_BULK_SIZE (1 << 17) 190#define UMASS_CBI_DIAGNOSTIC_CMDLEN 12 /* bytes */ 191#define UMASS_MAX_CMDLEN MAX(12, CAM_MAX_CDBLEN) /* bytes */ 192 193/* USB transfer definitions */ 194 195#define UMASS_T_BBB_RESET1 0 /* Bulk-Only */ 196#define UMASS_T_BBB_RESET2 1 197#define UMASS_T_BBB_RESET3 2 198#define UMASS_T_BBB_COMMAND 3 199#define UMASS_T_BBB_DATA_READ 4 200#define UMASS_T_BBB_DATA_RD_CS 5 201#define UMASS_T_BBB_DATA_WRITE 6 202#define UMASS_T_BBB_DATA_WR_CS 7 203#define UMASS_T_BBB_STATUS 8 204#define UMASS_T_BBB_MAX 9 205 206#define UMASS_T_CBI_RESET1 0 /* CBI */ 207#define UMASS_T_CBI_RESET2 1 208#define UMASS_T_CBI_RESET3 2 209#define UMASS_T_CBI_COMMAND 3 210#define UMASS_T_CBI_DATA_READ 4 211#define UMASS_T_CBI_DATA_RD_CS 5 212#define UMASS_T_CBI_DATA_WRITE 6 213#define UMASS_T_CBI_DATA_WR_CS 7 214#define UMASS_T_CBI_STATUS 8 215#define UMASS_T_CBI_RESET4 9 216#define UMASS_T_CBI_MAX 10 217 218#define UMASS_T_MAX MAX(UMASS_T_CBI_MAX, UMASS_T_BBB_MAX) 219 220/* Generic definitions */ 221 222/* Direction for transfer */ 223#define DIR_NONE 0 224#define DIR_IN 1 225#define DIR_OUT 2 226 227/* device name */ 228#define DEVNAME "umass" 229#define DEVNAME_SIM "umass-sim" 230 231/* Approximate maximum transfer speeds (assumes 33% overhead). */ 232#define UMASS_FULL_TRANSFER_SPEED 1000 233#define UMASS_HIGH_TRANSFER_SPEED 40000 234#define UMASS_FLOPPY_TRANSFER_SPEED 20 235 236#define UMASS_TIMEOUT 5000 /* ms */ 237 238/* CAM specific definitions */ 239 240#define UMASS_SCSIID_MAX 1 /* maximum number of drives expected */ 241#define UMASS_SCSIID_HOST UMASS_SCSIID_MAX 242 243/* Bulk-Only features */ 244 245#define UR_BBB_RESET 0xff /* Bulk-Only reset */ 246#define UR_BBB_GET_MAX_LUN 0xfe /* Get maximum lun */ 247 248/* Command Block Wrapper */ 249typedef struct { 250 uDWord dCBWSignature; 251#define CBWSIGNATURE 0x43425355 252 uDWord dCBWTag; 253 uDWord dCBWDataTransferLength; 254 uByte bCBWFlags; 255#define CBWFLAGS_OUT 0x00 256#define CBWFLAGS_IN 0x80 257 uByte bCBWLUN; 258 uByte bCDBLength; 259#define CBWCDBLENGTH 16 260 uByte CBWCDB[CBWCDBLENGTH]; 261} __packed umass_bbb_cbw_t; 262 263#define UMASS_BBB_CBW_SIZE 31 264 265/* Command Status Wrapper */ 266typedef struct { 267 uDWord dCSWSignature; 268#define CSWSIGNATURE 0x53425355 269#define CSWSIGNATURE_IMAGINATION_DBX1 0x43425355 270#define CSWSIGNATURE_OLYMPUS_C1 0x55425355 271 uDWord dCSWTag; 272 uDWord dCSWDataResidue; 273 uByte bCSWStatus; 274#define CSWSTATUS_GOOD 0x0 275#define CSWSTATUS_FAILED 0x1 276#define CSWSTATUS_PHASE 0x2 277} __packed umass_bbb_csw_t; 278 279#define UMASS_BBB_CSW_SIZE 13 280 281/* CBI features */ 282 283#define UR_CBI_ADSC 0x00 284 285typedef union { 286 struct { 287 uint8_t type; 288#define IDB_TYPE_CCI 0x00 289 uint8_t value; 290#define IDB_VALUE_PASS 0x00 291#define IDB_VALUE_FAIL 0x01 292#define IDB_VALUE_PHASE 0x02 293#define IDB_VALUE_PERSISTENT 0x03 294#define IDB_VALUE_STATUS_MASK 0x03 295 } __packed common; 296 297 struct { 298 uint8_t asc; 299 uint8_t ascq; 300 } __packed ufi; 301} __packed umass_cbi_sbl_t; 302 303struct umass_softc; /* see below */ 304 305typedef void (umass_callback_t)(struct umass_softc *sc, union ccb *ccb, 306 uint32_t residue, uint8_t status); 307 308#define STATUS_CMD_OK 0 /* everything ok */ 309#define STATUS_CMD_UNKNOWN 1 /* will have to fetch sense */ 310#define STATUS_CMD_FAILED 2 /* transfer was ok, command failed */ 311#define STATUS_WIRE_FAILED 3 /* couldn't even get command across */ 312 313typedef uint8_t (umass_transform_t)(struct umass_softc *sc, uint8_t *cmd_ptr, 314 uint8_t cmd_len); 315 316/* Wire and command protocol */ 317#define UMASS_PROTO_BBB 0x0001 /* USB wire protocol */ 318#define UMASS_PROTO_CBI 0x0002 319#define UMASS_PROTO_CBI_I 0x0004 320#define UMASS_PROTO_WIRE 0x00ff /* USB wire protocol mask */ 321#define UMASS_PROTO_SCSI 0x0100 /* command protocol */ 322#define UMASS_PROTO_ATAPI 0x0200 323#define UMASS_PROTO_UFI 0x0400 324#define UMASS_PROTO_RBC 0x0800 325#define UMASS_PROTO_COMMAND 0xff00 /* command protocol mask */ 326 327/* Device specific quirks */ 328#define NO_QUIRKS 0x0000 329 /* 330 * The drive does not support Test Unit Ready. Convert to Start Unit 331 */ 332#define NO_TEST_UNIT_READY 0x0001 333 /* 334 * The drive does not reset the Unit Attention state after REQUEST 335 * SENSE has been sent. The INQUIRY command does not reset the UA 336 * either, and so CAM runs in circles trying to retrieve the initial 337 * INQUIRY data. 338 */ 339#define RS_NO_CLEAR_UA 0x0002 340 /* The drive does not support START STOP. */ 341#define NO_START_STOP 0x0004 342 /* Don't ask for full inquiry data (255b). */ 343#define FORCE_SHORT_INQUIRY 0x0008 344 /* Needs to be initialised the Shuttle way */ 345#define SHUTTLE_INIT 0x0010 346 /* Drive needs to be switched to alternate iface 1 */ 347#define ALT_IFACE_1 0x0020 348 /* Drive does not do 1Mb/s, but just floppy speeds (20kb/s) */ 349#define FLOPPY_SPEED 0x0040 350 /* The device can't count and gets the residue of transfers wrong */ 351#define IGNORE_RESIDUE 0x0080 352 /* No GetMaxLun call */ 353#define NO_GETMAXLUN 0x0100 354 /* The device uses a weird CSWSIGNATURE. */ 355#define WRONG_CSWSIG 0x0200 356 /* Device cannot handle INQUIRY so fake a generic response */ 357#define NO_INQUIRY 0x0400 358 /* Device cannot handle INQUIRY EVPD, return CHECK CONDITION */ 359#define NO_INQUIRY_EVPD 0x0800 360 /* Pad all RBC requests to 12 bytes. */ 361#define RBC_PAD_TO_12 0x1000 362 /* 363 * Device reports number of sectors from READ_CAPACITY, not max 364 * sector number. 365 */ 366#define READ_CAPACITY_OFFBY1 0x2000 367 /* 368 * Device cannot handle a SCSI synchronize cache command. Normally 369 * this quirk would be handled in the cam layer, but for IDE bridges 370 * we need to associate the quirk with the bridge and not the 371 * underlying disk device. This is handled by faking a success 372 * result. 373 */ 374#define NO_SYNCHRONIZE_CACHE 0x4000 375 376struct umass_softc { 377 378 struct scsi_sense cam_scsi_sense; 379 struct scsi_test_unit_ready cam_scsi_test_unit_ready; 380 struct mtx sc_mtx; 381 struct { 382 uint8_t *data_ptr; 383 union ccb *ccb; 384 umass_callback_t *callback; 385 386 uint32_t data_len; /* bytes */ 387 uint32_t data_rem; /* bytes */ 388 uint32_t data_timeout; /* ms */ 389 uint32_t actlen; /* bytes */ 390 391 uint8_t cmd_data[UMASS_MAX_CMDLEN]; 392 uint8_t cmd_len; /* bytes */ 393 uint8_t dir; 394 uint8_t lun; 395 } sc_transfer; 396 397 /* Bulk specific variables for transfers in progress */ 398 umass_bbb_cbw_t cbw; /* command block wrapper */ 399 umass_bbb_csw_t csw; /* command status wrapper */ 400 401 /* CBI specific variables for transfers in progress */ 402 umass_cbi_sbl_t sbl; /* status block */ 403 404 device_t sc_dev; 405 struct usb_device *sc_udev; 406 struct cam_sim *sc_sim; /* SCSI Interface Module */ 407 struct usb_xfer *sc_xfer[UMASS_T_MAX]; 408 409 /* 410 * The command transform function is used to convert the SCSI 411 * commands into their derivatives, like UFI, ATAPI, and friends. 412 */ 413 umass_transform_t *sc_transform; 414 415 uint32_t sc_unit; 416 uint32_t sc_quirks; /* they got it almost right */ 417 uint32_t sc_proto; /* wire and cmd protocol */ 418 419 uint8_t sc_name[16]; 420 uint8_t sc_iface_no; /* interface number */ 421 uint8_t sc_maxlun; /* maximum LUN number, inclusive */ 422 uint8_t sc_last_xfer_index; 423 uint8_t sc_status_try; 424}; 425 426struct umass_probe_proto { 427 uint32_t quirks; 428 uint32_t proto; 429 430 int error; 431}; 432 433/* prototypes */ 434 435static device_probe_t umass_probe; 436static device_attach_t umass_attach; 437static device_detach_t umass_detach; 438 439static usb_callback_t umass_tr_error; 440static usb_callback_t umass_t_bbb_reset1_callback; 441static usb_callback_t umass_t_bbb_reset2_callback; 442static usb_callback_t umass_t_bbb_reset3_callback; 443static usb_callback_t umass_t_bbb_command_callback; 444static usb_callback_t umass_t_bbb_data_read_callback; 445static usb_callback_t umass_t_bbb_data_rd_cs_callback; 446static usb_callback_t umass_t_bbb_data_write_callback; 447static usb_callback_t umass_t_bbb_data_wr_cs_callback; 448static usb_callback_t umass_t_bbb_status_callback; 449static usb_callback_t umass_t_cbi_reset1_callback; 450static usb_callback_t umass_t_cbi_reset2_callback; 451static usb_callback_t umass_t_cbi_reset3_callback; 452static usb_callback_t umass_t_cbi_reset4_callback; 453static usb_callback_t umass_t_cbi_command_callback; 454static usb_callback_t umass_t_cbi_data_read_callback; 455static usb_callback_t umass_t_cbi_data_rd_cs_callback; 456static usb_callback_t umass_t_cbi_data_write_callback; 457static usb_callback_t umass_t_cbi_data_wr_cs_callback; 458static usb_callback_t umass_t_cbi_status_callback; 459 460static void umass_cancel_ccb(struct umass_softc *); 461static void umass_init_shuttle(struct umass_softc *); 462static void umass_reset(struct umass_softc *); 463static void umass_t_bbb_data_clear_stall_callback(struct usb_xfer *, 464 uint8_t, uint8_t, usb_error_t); 465static void umass_command_start(struct umass_softc *, uint8_t, void *, 466 uint32_t, uint32_t, umass_callback_t *, union ccb *); 467static uint8_t umass_bbb_get_max_lun(struct umass_softc *); 468static void umass_cbi_start_status(struct umass_softc *); 469static void umass_t_cbi_data_clear_stall_callback(struct usb_xfer *, 470 uint8_t, uint8_t, usb_error_t); 471static int umass_cam_attach_sim(struct umass_softc *); 472static void umass_cam_attach(struct umass_softc *); 473static void umass_cam_detach_sim(struct umass_softc *); 474static void umass_cam_action(struct cam_sim *, union ccb *); 475static void umass_cam_poll(struct cam_sim *); 476static void umass_cam_cb(struct umass_softc *, union ccb *, uint32_t, 477 uint8_t); 478static void umass_cam_sense_cb(struct umass_softc *, union ccb *, uint32_t, 479 uint8_t); 480static void umass_cam_quirk_cb(struct umass_softc *, union ccb *, uint32_t, 481 uint8_t); 482static uint8_t umass_scsi_transform(struct umass_softc *, uint8_t *, uint8_t); 483static uint8_t umass_rbc_transform(struct umass_softc *, uint8_t *, uint8_t); 484static uint8_t umass_ufi_transform(struct umass_softc *, uint8_t *, uint8_t); 485static uint8_t umass_atapi_transform(struct umass_softc *, uint8_t *, 486 uint8_t); 487static uint8_t umass_no_transform(struct umass_softc *, uint8_t *, uint8_t); 488static uint8_t umass_std_transform(struct umass_softc *, union ccb *, uint8_t 489 *, uint8_t); 490 491#ifdef USB_DEBUG 492static void umass_bbb_dump_cbw(struct umass_softc *, umass_bbb_cbw_t *); 493static void umass_bbb_dump_csw(struct umass_softc *, umass_bbb_csw_t *); 494static void umass_cbi_dump_cmd(struct umass_softc *, void *, uint8_t); 495static void umass_dump_buffer(struct umass_softc *, uint8_t *, uint32_t, 496 uint32_t); 497#endif 498 499static struct usb_config umass_bbb_config[UMASS_T_BBB_MAX] = { 500 501 [UMASS_T_BBB_RESET1] = { 502 .type = UE_CONTROL, 503 .endpoint = 0x00, /* Control pipe */ 504 .direction = UE_DIR_ANY, 505 .bufsize = sizeof(struct usb_device_request), 506 .callback = &umass_t_bbb_reset1_callback, 507 .timeout = 5000, /* 5 seconds */ 508 .interval = 500, /* 500 milliseconds */ 509 }, 510 511 [UMASS_T_BBB_RESET2] = { 512 .type = UE_CONTROL, 513 .endpoint = 0x00, /* Control pipe */ 514 .direction = UE_DIR_ANY, 515 .bufsize = sizeof(struct usb_device_request), 516 .callback = &umass_t_bbb_reset2_callback, 517 .timeout = 5000, /* 5 seconds */ 518 .interval = 50, /* 50 milliseconds */ 519 }, 520 521 [UMASS_T_BBB_RESET3] = { 522 .type = UE_CONTROL, 523 .endpoint = 0x00, /* Control pipe */ 524 .direction = UE_DIR_ANY, 525 .bufsize = sizeof(struct usb_device_request), 526 .callback = &umass_t_bbb_reset3_callback, 527 .timeout = 5000, /* 5 seconds */ 528 .interval = 50, /* 50 milliseconds */ 529 }, 530 531 [UMASS_T_BBB_COMMAND] = { 532 .type = UE_BULK, 533 .endpoint = UE_ADDR_ANY, 534 .direction = UE_DIR_OUT, 535 .bufsize = sizeof(umass_bbb_cbw_t), 536 .callback = &umass_t_bbb_command_callback, 537 .timeout = 5000, /* 5 seconds */ 538 }, 539 540 [UMASS_T_BBB_DATA_READ] = { 541 .type = UE_BULK, 542 .endpoint = UE_ADDR_ANY, 543 .direction = UE_DIR_IN, 544 .bufsize = UMASS_BULK_SIZE, 545 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, 546 .callback = &umass_t_bbb_data_read_callback, 547 .timeout = 0, /* overwritten later */ 548 }, 549 550 [UMASS_T_BBB_DATA_RD_CS] = { 551 .type = UE_CONTROL, 552 .endpoint = 0x00, /* Control pipe */ 553 .direction = UE_DIR_ANY, 554 .bufsize = sizeof(struct usb_device_request), 555 .callback = &umass_t_bbb_data_rd_cs_callback, 556 .timeout = 5000, /* 5 seconds */ 557 }, 558 559 [UMASS_T_BBB_DATA_WRITE] = { 560 .type = UE_BULK, 561 .endpoint = UE_ADDR_ANY, 562 .direction = UE_DIR_OUT, 563 .bufsize = UMASS_BULK_SIZE, 564 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, 565 .callback = &umass_t_bbb_data_write_callback, 566 .timeout = 0, /* overwritten later */ 567 }, 568 569 [UMASS_T_BBB_DATA_WR_CS] = { 570 .type = UE_CONTROL, 571 .endpoint = 0x00, /* Control pipe */ 572 .direction = UE_DIR_ANY, 573 .bufsize = sizeof(struct usb_device_request), 574 .callback = &umass_t_bbb_data_wr_cs_callback, 575 .timeout = 5000, /* 5 seconds */ 576 }, 577 578 [UMASS_T_BBB_STATUS] = { 579 .type = UE_BULK, 580 .endpoint = UE_ADDR_ANY, 581 .direction = UE_DIR_IN, 582 .bufsize = sizeof(umass_bbb_csw_t), 583 .flags = {.short_xfer_ok = 1,}, 584 .callback = &umass_t_bbb_status_callback, 585 .timeout = 5000, /* ms */ 586 }, 587}; 588 589static struct usb_config umass_cbi_config[UMASS_T_CBI_MAX] = { 590 591 [UMASS_T_CBI_RESET1] = { 592 .type = UE_CONTROL, 593 .endpoint = 0x00, /* Control pipe */ 594 .direction = UE_DIR_ANY, 595 .bufsize = (sizeof(struct usb_device_request) + 596 UMASS_CBI_DIAGNOSTIC_CMDLEN), 597 .callback = &umass_t_cbi_reset1_callback, 598 .timeout = 5000, /* 5 seconds */ 599 .interval = 500, /* 500 milliseconds */ 600 }, 601 602 [UMASS_T_CBI_RESET2] = { 603 .type = UE_CONTROL, 604 .endpoint = 0x00, /* Control pipe */ 605 .direction = UE_DIR_ANY, 606 .bufsize = sizeof(struct usb_device_request), 607 .callback = &umass_t_cbi_reset2_callback, 608 .timeout = 5000, /* 5 seconds */ 609 .interval = 50, /* 50 milliseconds */ 610 }, 611 612 [UMASS_T_CBI_RESET3] = { 613 .type = UE_CONTROL, 614 .endpoint = 0x00, /* Control pipe */ 615 .direction = UE_DIR_ANY, 616 .bufsize = sizeof(struct usb_device_request), 617 .callback = &umass_t_cbi_reset3_callback, 618 .timeout = 5000, /* 5 seconds */ 619 .interval = 50, /* 50 milliseconds */ 620 }, 621 622 [UMASS_T_CBI_COMMAND] = { 623 .type = UE_CONTROL, 624 .endpoint = 0x00, /* Control pipe */ 625 .direction = UE_DIR_ANY, 626 .bufsize = (sizeof(struct usb_device_request) + 627 UMASS_MAX_CMDLEN), 628 .callback = &umass_t_cbi_command_callback, 629 .timeout = 5000, /* 5 seconds */ 630 }, 631 632 [UMASS_T_CBI_DATA_READ] = { 633 .type = UE_BULK, 634 .endpoint = UE_ADDR_ANY, 635 .direction = UE_DIR_IN, 636 .bufsize = UMASS_BULK_SIZE, 637 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, 638 .callback = &umass_t_cbi_data_read_callback, 639 .timeout = 0, /* overwritten later */ 640 }, 641 642 [UMASS_T_CBI_DATA_RD_CS] = { 643 .type = UE_CONTROL, 644 .endpoint = 0x00, /* Control pipe */ 645 .direction = UE_DIR_ANY, 646 .bufsize = sizeof(struct usb_device_request), 647 .callback = &umass_t_cbi_data_rd_cs_callback, 648 .timeout = 5000, /* 5 seconds */ 649 }, 650 651 [UMASS_T_CBI_DATA_WRITE] = { 652 .type = UE_BULK, 653 .endpoint = UE_ADDR_ANY, 654 .direction = UE_DIR_OUT, 655 .bufsize = UMASS_BULK_SIZE, 656 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, 657 .callback = &umass_t_cbi_data_write_callback, 658 .timeout = 0, /* overwritten later */ 659 }, 660 661 [UMASS_T_CBI_DATA_WR_CS] = { 662 .type = UE_CONTROL, 663 .endpoint = 0x00, /* Control pipe */ 664 .direction = UE_DIR_ANY, 665 .bufsize = sizeof(struct usb_device_request), 666 .callback = &umass_t_cbi_data_wr_cs_callback, 667 .timeout = 5000, /* 5 seconds */ 668 }, 669 670 [UMASS_T_CBI_STATUS] = { 671 .type = UE_INTERRUPT, 672 .endpoint = UE_ADDR_ANY, 673 .direction = UE_DIR_IN, 674 .flags = {.short_xfer_ok = 1,.no_pipe_ok = 1,}, 675 .bufsize = sizeof(umass_cbi_sbl_t), 676 .callback = &umass_t_cbi_status_callback, 677 .timeout = 5000, /* ms */ 678 }, 679 680 [UMASS_T_CBI_RESET4] = { 681 .type = UE_CONTROL, 682 .endpoint = 0x00, /* Control pipe */ 683 .direction = UE_DIR_ANY, 684 .bufsize = sizeof(struct usb_device_request), 685 .callback = &umass_t_cbi_reset4_callback, 686 .timeout = 5000, /* ms */ 687 }, 688}; 689 690/* If device cannot return valid inquiry data, fake it */ 691static const uint8_t fake_inq_data[SHORT_INQUIRY_LENGTH] = { 692 0, /* removable */ 0x80, SCSI_REV_2, SCSI_REV_2, 693 /* additional_length */ 31, 0, 0, 0 694}; 695 696#define UFI_COMMAND_LENGTH 12 /* UFI commands are always 12 bytes */ 697#define ATAPI_COMMAND_LENGTH 12 /* ATAPI commands are always 12 bytes */ 698 699static devclass_t umass_devclass; 700 701static device_method_t umass_methods[] = { 702 /* Device interface */ 703 DEVMETHOD(device_probe, umass_probe), 704 DEVMETHOD(device_attach, umass_attach), 705 DEVMETHOD(device_detach, umass_detach), 706 {0, 0} 707}; 708 709static driver_t umass_driver = { 710 .name = "umass", 711 .methods = umass_methods, 712 .size = sizeof(struct umass_softc), 713}; 714 715DRIVER_MODULE(umass, uhub, umass_driver, umass_devclass, NULL, 0); 716MODULE_DEPEND(umass, usb, 1, 1, 1); 717MODULE_DEPEND(umass, cam, 1, 1, 1); 718MODULE_VERSION(umass, 1); 719 720/* 721 * USB device probe/attach/detach 722 */ 723 724static uint16_t 725umass_get_proto(struct usb_interface *iface) 726{ 727 struct usb_interface_descriptor *id; 728 uint16_t retval; 729 730 retval = 0; 731 732 /* Check for a standards compliant device */ 733 id = usbd_get_interface_descriptor(iface); 734 if ((id == NULL) || 735 (id->bInterfaceClass != UICLASS_MASS)) { 736 goto done; 737 } 738 switch (id->bInterfaceSubClass) { 739 case UISUBCLASS_SCSI: 740 retval |= UMASS_PROTO_SCSI; 741 break; 742 case UISUBCLASS_UFI: 743 retval |= UMASS_PROTO_UFI; 744 break; 745 case UISUBCLASS_RBC: 746 retval |= UMASS_PROTO_RBC; 747 break; 748 case UISUBCLASS_SFF8020I: 749 case UISUBCLASS_SFF8070I: 750 retval |= UMASS_PROTO_ATAPI; 751 break; 752 default: 753 goto done; 754 } 755 756 switch (id->bInterfaceProtocol) { 757 case UIPROTO_MASS_CBI: 758 retval |= UMASS_PROTO_CBI; 759 break; 760 case UIPROTO_MASS_CBI_I: 761 retval |= UMASS_PROTO_CBI_I; 762 break; 763 case UIPROTO_MASS_BBB_OLD: 764 case UIPROTO_MASS_BBB: 765 retval |= UMASS_PROTO_BBB; 766 break; 767 default: 768 goto done; 769 } 770done: 771 return (retval); 772} 773 774/* 775 * Match the device we are seeing with the devices supported. 776 */ 777static struct umass_probe_proto 778umass_probe_proto(device_t dev, struct usb_attach_arg *uaa) 779{ 780 struct umass_probe_proto ret; 781 uint32_t quirks = NO_QUIRKS; 782 uint32_t proto = umass_get_proto(uaa->iface); 783 784 memset(&ret, 0, sizeof(ret)); 785 786 /* Search for protocol enforcement */ 787 788 if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_BBB)) { 789 proto &= ~UMASS_PROTO_WIRE; 790 proto |= UMASS_PROTO_BBB; 791 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_CBI)) { 792 proto &= ~UMASS_PROTO_WIRE; 793 proto |= UMASS_PROTO_CBI; 794 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_CBI_I)) { 795 proto &= ~UMASS_PROTO_WIRE; 796 proto |= UMASS_PROTO_CBI_I; 797 } 798 799 if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_SCSI)) { 800 proto &= ~UMASS_PROTO_COMMAND; 801 proto |= UMASS_PROTO_SCSI; 802 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_ATAPI)) { 803 proto &= ~UMASS_PROTO_COMMAND; 804 proto |= UMASS_PROTO_ATAPI; 805 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_UFI)) { 806 proto &= ~UMASS_PROTO_COMMAND; 807 proto |= UMASS_PROTO_UFI; 808 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_RBC)) { 809 proto &= ~UMASS_PROTO_COMMAND; 810 proto |= UMASS_PROTO_RBC; 811 } 812 813 /* Check if the protocol is invalid */ 814 815 if ((proto & UMASS_PROTO_COMMAND) == 0) { 816 ret.error = ENXIO; 817 goto done; 818 } 819 820 if ((proto & UMASS_PROTO_WIRE) == 0) { 821 ret.error = ENXIO; 822 goto done; 823 } 824 825 /* Search for quirks */ 826 827 if (usb_test_quirk(uaa, UQ_MSC_NO_TEST_UNIT_READY)) 828 quirks |= NO_TEST_UNIT_READY; 829 if (usb_test_quirk(uaa, UQ_MSC_NO_RS_CLEAR_UA)) 830 quirks |= RS_NO_CLEAR_UA; 831 if (usb_test_quirk(uaa, UQ_MSC_NO_START_STOP)) 832 quirks |= NO_START_STOP; 833 if (usb_test_quirk(uaa, UQ_MSC_NO_GETMAXLUN)) 834 quirks |= NO_GETMAXLUN; 835 if (usb_test_quirk(uaa, UQ_MSC_NO_INQUIRY)) 836 quirks |= NO_INQUIRY; 837 if (usb_test_quirk(uaa, UQ_MSC_NO_INQUIRY_EVPD)) 838 quirks |= NO_INQUIRY_EVPD; 839 if (usb_test_quirk(uaa, UQ_MSC_NO_SYNC_CACHE)) 840 quirks |= NO_SYNCHRONIZE_CACHE; 841 if (usb_test_quirk(uaa, UQ_MSC_SHUTTLE_INIT)) 842 quirks |= SHUTTLE_INIT; 843 if (usb_test_quirk(uaa, UQ_MSC_ALT_IFACE_1)) 844 quirks |= ALT_IFACE_1; 845 if (usb_test_quirk(uaa, UQ_MSC_FLOPPY_SPEED)) 846 quirks |= FLOPPY_SPEED; 847 if (usb_test_quirk(uaa, UQ_MSC_IGNORE_RESIDUE)) 848 quirks |= IGNORE_RESIDUE; 849 if (usb_test_quirk(uaa, UQ_MSC_WRONG_CSWSIG)) 850 quirks |= WRONG_CSWSIG; 851 if (usb_test_quirk(uaa, UQ_MSC_RBC_PAD_TO_12)) 852 quirks |= RBC_PAD_TO_12; 853 if (usb_test_quirk(uaa, UQ_MSC_READ_CAP_OFFBY1)) 854 quirks |= READ_CAPACITY_OFFBY1; 855 if (usb_test_quirk(uaa, UQ_MSC_FORCE_SHORT_INQ)) 856 quirks |= FORCE_SHORT_INQUIRY; 857 858done: 859 ret.quirks = quirks; 860 ret.proto = proto; 861 return (ret); 862} 863 864static int 865umass_probe(device_t dev) 866{ 867 struct usb_attach_arg *uaa = device_get_ivars(dev); 868 struct umass_probe_proto temp; 869 870 if (uaa->usb_mode != USB_MODE_HOST) { 871 return (ENXIO); 872 } 873 if (uaa->use_generic == 0) { 874 /* give other drivers a try first */ 875 return (ENXIO); 876 } 877 temp = umass_probe_proto(dev, uaa); 878 879 return (temp.error); 880} 881 882static int 883umass_attach(device_t dev) 884{ 885 struct umass_softc *sc = device_get_softc(dev); 886 struct usb_attach_arg *uaa = device_get_ivars(dev); 887 struct umass_probe_proto temp = umass_probe_proto(dev, uaa); 888 struct usb_interface_descriptor *id; 889 int32_t err; 890 891 /* 892 * NOTE: the softc struct is bzero-ed in device_set_driver. 893 * We can safely call umass_detach without specifically 894 * initializing the struct. 895 */ 896 897 sc->sc_dev = dev; 898 sc->sc_udev = uaa->device; 899 sc->sc_proto = temp.proto; 900 sc->sc_quirks = temp.quirks; 901 sc->sc_unit = device_get_unit(dev); 902 903 snprintf(sc->sc_name, sizeof(sc->sc_name), 904 "%s", device_get_nameunit(dev)); 905 906 device_set_usb_desc(dev); 907 908 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), 909 NULL, MTX_DEF | MTX_RECURSE); 910 911 /* get interface index */ 912 913 id = usbd_get_interface_descriptor(uaa->iface); 914 if (id == NULL) { 915 device_printf(dev, "failed to get " 916 "interface number\n"); 917 goto detach; 918 } 919 sc->sc_iface_no = id->bInterfaceNumber; 920 921#ifdef USB_DEBUG 922 device_printf(dev, " "); 923 924 switch (sc->sc_proto & UMASS_PROTO_COMMAND) { 925 case UMASS_PROTO_SCSI: 926 printf("SCSI"); 927 break; 928 case UMASS_PROTO_ATAPI: 929 printf("8070i (ATAPI)"); 930 break; 931 case UMASS_PROTO_UFI: 932 printf("UFI"); 933 break; 934 case UMASS_PROTO_RBC: 935 printf("RBC"); 936 break; 937 default: 938 printf("(unknown 0x%02x)", 939 sc->sc_proto & UMASS_PROTO_COMMAND); 940 break; 941 } 942 943 printf(" over "); 944 945 switch (sc->sc_proto & UMASS_PROTO_WIRE) { 946 case UMASS_PROTO_BBB: 947 printf("Bulk-Only"); 948 break; 949 case UMASS_PROTO_CBI: /* uses Comand/Bulk pipes */ 950 printf("CBI"); 951 break; 952 case UMASS_PROTO_CBI_I: /* uses Comand/Bulk/Interrupt pipes */ 953 printf("CBI with CCI"); 954 break; 955 default: 956 printf("(unknown 0x%02x)", 957 sc->sc_proto & UMASS_PROTO_WIRE); 958 } 959 960 printf("; quirks = 0x%04x\n", sc->sc_quirks); 961#endif 962 963 if (sc->sc_quirks & ALT_IFACE_1) { 964 err = usbd_set_alt_interface_index 965 (uaa->device, uaa->info.bIfaceIndex, 1); 966 967 if (err) { 968 DPRINTF(sc, UDMASS_USB, "could not switch to " 969 "Alt Interface 1\n"); 970 goto detach; 971 } 972 } 973 /* allocate all required USB transfers */ 974 975 if (sc->sc_proto & UMASS_PROTO_BBB) { 976 977 err = usbd_transfer_setup(uaa->device, 978 &uaa->info.bIfaceIndex, sc->sc_xfer, umass_bbb_config, 979 UMASS_T_BBB_MAX, sc, &sc->sc_mtx); 980 981 /* skip reset first time */ 982 sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND; 983 984 } else if (sc->sc_proto & (UMASS_PROTO_CBI | UMASS_PROTO_CBI_I)) { 985 986 err = usbd_transfer_setup(uaa->device, 987 &uaa->info.bIfaceIndex, sc->sc_xfer, umass_cbi_config, 988 UMASS_T_CBI_MAX, sc, &sc->sc_mtx); 989 990 /* skip reset first time */ 991 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; 992 993 } else { 994 err = USB_ERR_INVAL; 995 } 996 997 if (err) { 998 device_printf(dev, "could not setup required " 999 "transfers, %s\n", usbd_errstr(err)); 1000 goto detach; 1001 } 1002 sc->sc_transform = 1003 (sc->sc_proto & UMASS_PROTO_SCSI) ? &umass_scsi_transform : 1004 (sc->sc_proto & UMASS_PROTO_UFI) ? &umass_ufi_transform : 1005 (sc->sc_proto & UMASS_PROTO_ATAPI) ? &umass_atapi_transform : 1006 (sc->sc_proto & UMASS_PROTO_RBC) ? &umass_rbc_transform : 1007 &umass_no_transform; 1008 1009 /* from here onwards the device can be used. */ 1010 1011 if (sc->sc_quirks & SHUTTLE_INIT) { 1012 umass_init_shuttle(sc); 1013 } 1014 /* get the maximum LUN supported by the device */ 1015 1016 if (((sc->sc_proto & UMASS_PROTO_WIRE) == UMASS_PROTO_BBB) && 1017 !(sc->sc_quirks & NO_GETMAXLUN)) 1018 sc->sc_maxlun = umass_bbb_get_max_lun(sc); 1019 else 1020 sc->sc_maxlun = 0; 1021 1022 /* Prepare the SCSI command block */ 1023 sc->cam_scsi_sense.opcode = REQUEST_SENSE; 1024 sc->cam_scsi_test_unit_ready.opcode = TEST_UNIT_READY; 1025 1026 /* 1027 * some devices need a delay after that the configuration value is 1028 * set to function properly: 1029 */ 1030 usb_pause_mtx(NULL, hz); 1031 1032 /* register the SIM */ 1033 err = umass_cam_attach_sim(sc); 1034 if (err) { 1035 goto detach; 1036 } 1037 /* scan the SIM */ 1038 umass_cam_attach(sc); 1039 1040 DPRINTF(sc, UDMASS_GEN, "Attach finished\n"); 1041 1042 return (0); /* success */ 1043 1044detach: 1045 umass_detach(dev); 1046 return (ENXIO); /* failure */ 1047} 1048 1049static int 1050umass_detach(device_t dev) 1051{ 1052 struct umass_softc *sc = device_get_softc(dev); 1053 1054 DPRINTF(sc, UDMASS_USB, "\n"); 1055 1056 /* teardown our statemachine */ 1057 1058 usbd_transfer_unsetup(sc->sc_xfer, UMASS_T_MAX); 1059 1060#if (__FreeBSD_version >= 700037) 1061 mtx_lock(&sc->sc_mtx); 1062#endif 1063 umass_cam_detach_sim(sc); 1064 1065#if (__FreeBSD_version >= 700037) 1066 mtx_unlock(&sc->sc_mtx); 1067#endif 1068 mtx_destroy(&sc->sc_mtx); 1069 1070 return (0); /* success */ 1071} 1072 1073static void 1074umass_init_shuttle(struct umass_softc *sc) 1075{ 1076 struct usb_device_request req; 1077 usb_error_t err; 1078 uint8_t status[2] = {0, 0}; 1079 1080 /* 1081 * The Linux driver does this, but no one can tell us what the 1082 * command does. 1083 */ 1084 req.bmRequestType = UT_READ_VENDOR_DEVICE; 1085 req.bRequest = 1; /* XXX unknown command */ 1086 USETW(req.wValue, 0); 1087 req.wIndex[0] = sc->sc_iface_no; 1088 req.wIndex[1] = 0; 1089 USETW(req.wLength, sizeof(status)); 1090 err = usbd_do_request(sc->sc_udev, NULL, &req, &status); 1091 1092 DPRINTF(sc, UDMASS_GEN, "Shuttle init returned 0x%02x%02x\n", 1093 status[0], status[1]); 1094} 1095 1096/* 1097 * Generic functions to handle transfers 1098 */ 1099 1100static void 1101umass_transfer_start(struct umass_softc *sc, uint8_t xfer_index) 1102{ 1103 DPRINTF(sc, UDMASS_GEN, "transfer index = " 1104 "%d\n", xfer_index); 1105 1106 if (sc->sc_xfer[xfer_index]) { 1107 sc->sc_last_xfer_index = xfer_index; 1108 usbd_transfer_start(sc->sc_xfer[xfer_index]); 1109 } else { 1110 umass_cancel_ccb(sc); 1111 } 1112} 1113 1114static void 1115umass_reset(struct umass_softc *sc) 1116{ 1117 DPRINTF(sc, UDMASS_GEN, "resetting device\n"); 1118 1119 /* 1120 * stop the last transfer, if not already stopped: 1121 */ 1122 usbd_transfer_stop(sc->sc_xfer[sc->sc_last_xfer_index]); 1123 umass_transfer_start(sc, 0); 1124} 1125 1126static void 1127umass_cancel_ccb(struct umass_softc *sc) 1128{ 1129 union ccb *ccb; 1130 1131 mtx_assert(&sc->sc_mtx, MA_OWNED); 1132 1133 ccb = sc->sc_transfer.ccb; 1134 sc->sc_transfer.ccb = NULL; 1135 sc->sc_last_xfer_index = 0; 1136 1137 if (ccb) { 1138 (sc->sc_transfer.callback) 1139 (sc, ccb, (sc->sc_transfer.data_len - 1140 sc->sc_transfer.actlen), STATUS_WIRE_FAILED); 1141 } 1142} 1143 1144static void 1145umass_tr_error(struct usb_xfer *xfer, usb_error_t error) 1146{ 1147 struct umass_softc *sc = usbd_xfer_softc(xfer); 1148 1149 if (error != USB_ERR_CANCELLED) { 1150 1151 DPRINTF(sc, UDMASS_GEN, "transfer error, %s -> " 1152 "reset\n", usbd_errstr(error)); 1153 } 1154 umass_cancel_ccb(sc); 1155} 1156 1157/* 1158 * BBB protocol specific functions 1159 */ 1160 1161static void 1162umass_t_bbb_reset1_callback(struct usb_xfer *xfer, usb_error_t error) 1163{ 1164 struct umass_softc *sc = usbd_xfer_softc(xfer); 1165 struct usb_device_request req; 1166 struct usb_page_cache *pc; 1167 1168 switch (USB_GET_STATE(xfer)) { 1169 case USB_ST_TRANSFERRED: 1170 umass_transfer_start(sc, UMASS_T_BBB_RESET2); 1171 return; 1172 1173 case USB_ST_SETUP: 1174 /* 1175 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class) 1176 * 1177 * For Reset Recovery the host shall issue in the following order: 1178 * a) a Bulk-Only Mass Storage Reset 1179 * b) a Clear Feature HALT to the Bulk-In endpoint 1180 * c) a Clear Feature HALT to the Bulk-Out endpoint 1181 * 1182 * This is done in 3 steps, using 3 transfers: 1183 * UMASS_T_BBB_RESET1 1184 * UMASS_T_BBB_RESET2 1185 * UMASS_T_BBB_RESET3 1186 */ 1187 1188 DPRINTF(sc, UDMASS_BBB, "BBB reset!\n"); 1189 1190 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1191 req.bRequest = UR_BBB_RESET; /* bulk only reset */ 1192 USETW(req.wValue, 0); 1193 req.wIndex[0] = sc->sc_iface_no; 1194 req.wIndex[1] = 0; 1195 USETW(req.wLength, 0); 1196 1197 pc = usbd_xfer_get_frame(xfer, 0); 1198 usbd_copy_in(pc, 0, &req, sizeof(req)); 1199 1200 usbd_xfer_set_frame_len(xfer, 0, sizeof(req)); 1201 usbd_xfer_set_frames(xfer, 1); 1202 usbd_transfer_submit(xfer); 1203 return; 1204 1205 default: /* Error */ 1206 umass_tr_error(xfer, error); 1207 return; 1208 1209 } 1210} 1211 1212static void 1213umass_t_bbb_reset2_callback(struct usb_xfer *xfer, usb_error_t error) 1214{ 1215 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_RESET3, 1216 UMASS_T_BBB_DATA_READ, error); 1217} 1218 1219static void 1220umass_t_bbb_reset3_callback(struct usb_xfer *xfer, usb_error_t error) 1221{ 1222 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_COMMAND, 1223 UMASS_T_BBB_DATA_WRITE, error); 1224} 1225 1226static void 1227umass_t_bbb_data_clear_stall_callback(struct usb_xfer *xfer, 1228 uint8_t next_xfer, uint8_t stall_xfer, usb_error_t error) 1229{ 1230 struct umass_softc *sc = usbd_xfer_softc(xfer); 1231 1232 switch (USB_GET_STATE(xfer)) { 1233 case USB_ST_TRANSFERRED: 1234tr_transferred: 1235 umass_transfer_start(sc, next_xfer); 1236 return; 1237 1238 case USB_ST_SETUP: 1239 if (usbd_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) { 1240 goto tr_transferred; 1241 } 1242 return; 1243 1244 default: /* Error */ 1245 umass_tr_error(xfer, error); 1246 return; 1247 1248 } 1249} 1250 1251static void 1252umass_t_bbb_command_callback(struct usb_xfer *xfer, usb_error_t error) 1253{ 1254 struct umass_softc *sc = usbd_xfer_softc(xfer); 1255 union ccb *ccb = sc->sc_transfer.ccb; 1256 struct usb_page_cache *pc; 1257 uint32_t tag; 1258 1259 switch (USB_GET_STATE(xfer)) { 1260 case USB_ST_TRANSFERRED: 1261 umass_transfer_start 1262 (sc, ((sc->sc_transfer.dir == DIR_IN) ? UMASS_T_BBB_DATA_READ : 1263 (sc->sc_transfer.dir == DIR_OUT) ? UMASS_T_BBB_DATA_WRITE : 1264 UMASS_T_BBB_STATUS)); 1265 return; 1266 1267 case USB_ST_SETUP: 1268 1269 sc->sc_status_try = 0; 1270 1271 if (ccb) { 1272 1273 /* 1274 * the initial value is not important, 1275 * as long as the values are unique: 1276 */ 1277 tag = UGETDW(sc->cbw.dCBWTag) + 1; 1278 1279 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE); 1280 USETDW(sc->cbw.dCBWTag, tag); 1281 1282 /* 1283 * dCBWDataTransferLength: 1284 * This field indicates the number of bytes of data that the host 1285 * intends to transfer on the IN or OUT Bulk endpoint(as indicated by 1286 * the Direction bit) during the execution of this command. If this 1287 * field is set to 0, the device will expect that no data will be 1288 * transferred IN or OUT during this command, regardless of the value 1289 * of the Direction bit defined in dCBWFlags. 1290 */ 1291 USETDW(sc->cbw.dCBWDataTransferLength, sc->sc_transfer.data_len); 1292 1293 /* 1294 * dCBWFlags: 1295 * The bits of the Flags field are defined as follows: 1296 * Bits 0-6 reserved 1297 * Bit 7 Direction - this bit shall be ignored if the 1298 * dCBWDataTransferLength field is zero. 1299 * 0 = data Out from host to device 1300 * 1 = data In from device to host 1301 */ 1302 sc->cbw.bCBWFlags = ((sc->sc_transfer.dir == DIR_IN) ? 1303 CBWFLAGS_IN : CBWFLAGS_OUT); 1304 sc->cbw.bCBWLUN = sc->sc_transfer.lun; 1305 1306 if (sc->sc_transfer.cmd_len > sizeof(sc->cbw.CBWCDB)) { 1307 sc->sc_transfer.cmd_len = sizeof(sc->cbw.CBWCDB); 1308 DPRINTF(sc, UDMASS_BBB, "Truncating long command!\n"); 1309 } 1310 sc->cbw.bCDBLength = sc->sc_transfer.cmd_len; 1311 1312 bcopy(sc->sc_transfer.cmd_data, sc->cbw.CBWCDB, 1313 sc->sc_transfer.cmd_len); 1314 1315 bzero(sc->sc_transfer.cmd_data + sc->sc_transfer.cmd_len, 1316 sizeof(sc->cbw.CBWCDB) - sc->sc_transfer.cmd_len); 1317 1318 DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw)); 1319 1320 pc = usbd_xfer_get_frame(xfer, 0); 1321 usbd_copy_in(pc, 0, &sc->cbw, sizeof(sc->cbw)); 1322 usbd_xfer_set_frame_len(xfer, 0, sizeof(sc->cbw)); 1323 1324 usbd_transfer_submit(xfer); 1325 } 1326 return; 1327 1328 default: /* Error */ 1329 umass_tr_error(xfer, error); 1330 return; 1331 1332 } 1333} 1334 1335static void 1336umass_t_bbb_data_read_callback(struct usb_xfer *xfer, usb_error_t error) 1337{ 1338 struct umass_softc *sc = usbd_xfer_softc(xfer); 1339 uint32_t max_bulk = usbd_xfer_max_len(xfer); 1340#ifndef UMASS_EXT_BUFFER 1341 struct usb_page_cache *pc; 1342#endif 1343 int actlen, sumlen; 1344 1345 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL); 1346 1347 switch (USB_GET_STATE(xfer)) { 1348 case USB_ST_TRANSFERRED: 1349#ifndef UMASS_EXT_BUFFER 1350 pc = usbd_xfer_get_frame(xfer, 0); 1351 usbd_copy_out(pc, 0, sc->sc_transfer.data_ptr, actlen); 1352#endif 1353 sc->sc_transfer.data_rem -= actlen; 1354 sc->sc_transfer.data_ptr += actlen; 1355 sc->sc_transfer.actlen += actlen; 1356 1357 if (actlen < sumlen) { 1358 /* short transfer */ 1359 sc->sc_transfer.data_rem = 0; 1360 } 1361 case USB_ST_SETUP: 1362 DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n", 1363 max_bulk, sc->sc_transfer.data_rem); 1364 1365 if (sc->sc_transfer.data_rem == 0) { 1366 umass_transfer_start(sc, UMASS_T_BBB_STATUS); 1367 return; 1368 } 1369 if (max_bulk > sc->sc_transfer.data_rem) { 1370 max_bulk = sc->sc_transfer.data_rem; 1371 } 1372 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout); 1373 1374#ifdef UMASS_EXT_BUFFER 1375 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr, 1376 max_bulk); 1377#else 1378 usbd_xfer_set_frame_len(xfer, 0, max_bulk); 1379#endif 1380 usbd_transfer_submit(xfer); 1381 return; 1382 1383 default: /* Error */ 1384 if (error == USB_ERR_CANCELLED) { 1385 umass_tr_error(xfer, error); 1386 } else { 1387 umass_transfer_start(sc, UMASS_T_BBB_DATA_RD_CS); 1388 } 1389 return; 1390 1391 } 1392} 1393 1394static void 1395umass_t_bbb_data_rd_cs_callback(struct usb_xfer *xfer, usb_error_t error) 1396{ 1397 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_STATUS, 1398 UMASS_T_BBB_DATA_READ, error); 1399} 1400 1401static void 1402umass_t_bbb_data_write_callback(struct usb_xfer *xfer, usb_error_t error) 1403{ 1404 struct umass_softc *sc = usbd_xfer_softc(xfer); 1405 uint32_t max_bulk = usbd_xfer_max_len(xfer); 1406#ifndef UMASS_EXT_BUFFER 1407 struct usb_page_cache *pc; 1408#endif 1409 int actlen, sumlen; 1410 1411 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL); 1412 1413 switch (USB_GET_STATE(xfer)) { 1414 case USB_ST_TRANSFERRED: 1415 sc->sc_transfer.data_rem -= actlen; 1416 sc->sc_transfer.data_ptr += actlen; 1417 sc->sc_transfer.actlen += actlen; 1418 1419 if (actlen < sumlen) { 1420 /* short transfer */ 1421 sc->sc_transfer.data_rem = 0; 1422 } 1423 case USB_ST_SETUP: 1424 DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n", 1425 max_bulk, sc->sc_transfer.data_rem); 1426 1427 if (sc->sc_transfer.data_rem == 0) { 1428 umass_transfer_start(sc, UMASS_T_BBB_STATUS); 1429 return; 1430 } 1431 if (max_bulk > sc->sc_transfer.data_rem) { 1432 max_bulk = sc->sc_transfer.data_rem; 1433 } 1434 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout); 1435 1436#ifdef UMASS_EXT_BUFFER 1437 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr, 1438 max_bulk); 1439#else 1440 pc = usbd_xfer_get_frame(xfer, 0); 1441 usbd_copy_in(pc, 0, sc->sc_transfer.data_ptr, max_bulk); 1442 usbd_xfer_set_frame_len(xfer, 0, max_bulk); 1443#endif 1444 1445 usbd_transfer_submit(xfer); 1446 return; 1447 1448 default: /* Error */ 1449 if (error == USB_ERR_CANCELLED) { 1450 umass_tr_error(xfer, error); 1451 } else { 1452 umass_transfer_start(sc, UMASS_T_BBB_DATA_WR_CS); 1453 } 1454 return; 1455 1456 } 1457} 1458 1459static void 1460umass_t_bbb_data_wr_cs_callback(struct usb_xfer *xfer, usb_error_t error) 1461{ 1462 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_STATUS, 1463 UMASS_T_BBB_DATA_WRITE, error); 1464} 1465 1466static void 1467umass_t_bbb_status_callback(struct usb_xfer *xfer, usb_error_t error) 1468{ 1469 struct umass_softc *sc = usbd_xfer_softc(xfer); 1470 union ccb *ccb = sc->sc_transfer.ccb; 1471 struct usb_page_cache *pc; 1472 uint32_t residue; 1473 int actlen; 1474 1475 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 1476 1477 switch (USB_GET_STATE(xfer)) { 1478 case USB_ST_TRANSFERRED: 1479 1480 /* 1481 * Do a full reset if there is something wrong with the CSW: 1482 */ 1483 sc->sc_status_try = 1; 1484 1485 /* Zero missing parts of the CSW: */ 1486 1487 if (actlen < sizeof(sc->csw)) { 1488 bzero(&sc->csw, sizeof(sc->csw)); 1489 } 1490 pc = usbd_xfer_get_frame(xfer, 0); 1491 usbd_copy_out(pc, 0, &sc->csw, actlen); 1492 1493 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw)); 1494 1495 residue = UGETDW(sc->csw.dCSWDataResidue); 1496 1497 if ((!residue) || (sc->sc_quirks & IGNORE_RESIDUE)) { 1498 residue = (sc->sc_transfer.data_len - 1499 sc->sc_transfer.actlen); 1500 } 1501 if (residue > sc->sc_transfer.data_len) { 1502 DPRINTF(sc, UDMASS_BBB, "truncating residue from %d " 1503 "to %d bytes\n", residue, sc->sc_transfer.data_len); 1504 residue = sc->sc_transfer.data_len; 1505 } 1506 /* translate weird command-status signatures: */ 1507 if (sc->sc_quirks & WRONG_CSWSIG) { 1508 1509 uint32_t temp = UGETDW(sc->csw.dCSWSignature); 1510 1511 if ((temp == CSWSIGNATURE_OLYMPUS_C1) || 1512 (temp == CSWSIGNATURE_IMAGINATION_DBX1)) { 1513 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE); 1514 } 1515 } 1516 /* check CSW and handle eventual error */ 1517 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) { 1518 DPRINTF(sc, UDMASS_BBB, "bad CSW signature 0x%08x != 0x%08x\n", 1519 UGETDW(sc->csw.dCSWSignature), CSWSIGNATURE); 1520 /* 1521 * Invalid CSW: Wrong signature or wrong tag might 1522 * indicate that we lost synchronization. Reset the 1523 * device. 1524 */ 1525 goto tr_error; 1526 } else if (UGETDW(sc->csw.dCSWTag) != UGETDW(sc->cbw.dCBWTag)) { 1527 DPRINTF(sc, UDMASS_BBB, "Invalid CSW: tag 0x%08x should be " 1528 "0x%08x\n", UGETDW(sc->csw.dCSWTag), 1529 UGETDW(sc->cbw.dCBWTag)); 1530 goto tr_error; 1531 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) { 1532 DPRINTF(sc, UDMASS_BBB, "Invalid CSW: status %d > %d\n", 1533 sc->csw.bCSWStatus, CSWSTATUS_PHASE); 1534 goto tr_error; 1535 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) { 1536 DPRINTF(sc, UDMASS_BBB, "Phase error, residue = " 1537 "%d\n", residue); 1538 goto tr_error; 1539 } else if (sc->sc_transfer.actlen > sc->sc_transfer.data_len) { 1540 DPRINTF(sc, UDMASS_BBB, "Buffer overrun %d > %d\n", 1541 sc->sc_transfer.actlen, sc->sc_transfer.data_len); 1542 goto tr_error; 1543 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) { 1544 DPRINTF(sc, UDMASS_BBB, "Command failed, residue = " 1545 "%d\n", residue); 1546 1547 sc->sc_transfer.ccb = NULL; 1548 1549 sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND; 1550 1551 (sc->sc_transfer.callback) 1552 (sc, ccb, residue, STATUS_CMD_FAILED); 1553 } else { 1554 sc->sc_transfer.ccb = NULL; 1555 1556 sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND; 1557 1558 (sc->sc_transfer.callback) 1559 (sc, ccb, residue, STATUS_CMD_OK); 1560 } 1561 return; 1562 1563 case USB_ST_SETUP: 1564 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 1565 usbd_transfer_submit(xfer); 1566 return; 1567 1568 default: 1569tr_error: 1570 DPRINTF(sc, UDMASS_BBB, "Failed to read CSW: %s, try %d\n", 1571 usbd_errstr(error), sc->sc_status_try); 1572 1573 if ((error == USB_ERR_CANCELLED) || 1574 (sc->sc_status_try)) { 1575 umass_tr_error(xfer, error); 1576 } else { 1577 sc->sc_status_try = 1; 1578 umass_transfer_start(sc, UMASS_T_BBB_DATA_RD_CS); 1579 } 1580 return; 1581 1582 } 1583} 1584 1585static void 1586umass_command_start(struct umass_softc *sc, uint8_t dir, 1587 void *data_ptr, uint32_t data_len, 1588 uint32_t data_timeout, umass_callback_t *callback, 1589 union ccb *ccb) 1590{ 1591 sc->sc_transfer.lun = ccb->ccb_h.target_lun; 1592 1593 /* 1594 * NOTE: assumes that "sc->sc_transfer.cmd_data" and 1595 * "sc->sc_transfer.cmd_len" has been properly 1596 * initialized. 1597 */ 1598 1599 sc->sc_transfer.dir = data_len ? dir : DIR_NONE; 1600 sc->sc_transfer.data_ptr = data_ptr; 1601 sc->sc_transfer.data_len = data_len; 1602 sc->sc_transfer.data_rem = data_len; 1603 sc->sc_transfer.data_timeout = (data_timeout + UMASS_TIMEOUT); 1604 1605 sc->sc_transfer.actlen = 0; 1606 sc->sc_transfer.callback = callback; 1607 sc->sc_transfer.ccb = ccb; 1608 1609 if (sc->sc_xfer[sc->sc_last_xfer_index]) { 1610 usbd_transfer_start(sc->sc_xfer[sc->sc_last_xfer_index]); 1611 } else { 1612 ccb->ccb_h.status = CAM_TID_INVALID; 1613 xpt_done(ccb); 1614 } 1615} 1616 1617static uint8_t 1618umass_bbb_get_max_lun(struct umass_softc *sc) 1619{ 1620 struct usb_device_request req; 1621 usb_error_t err; 1622 uint8_t buf = 0; 1623 1624 /* The Get Max Lun command is a class-specific request. */ 1625 req.bmRequestType = UT_READ_CLASS_INTERFACE; 1626 req.bRequest = UR_BBB_GET_MAX_LUN; 1627 USETW(req.wValue, 0); 1628 req.wIndex[0] = sc->sc_iface_no; 1629 req.wIndex[1] = 0; 1630 USETW(req.wLength, 1); 1631 1632 err = usbd_do_request(sc->sc_udev, NULL, &req, &buf); 1633 if (err) { 1634 buf = 0; 1635 1636 /* Device doesn't support Get Max Lun request. */ 1637 printf("%s: Get Max Lun not supported (%s)\n", 1638 sc->sc_name, usbd_errstr(err)); 1639 } 1640 return (buf); 1641} 1642 1643/* 1644 * Command/Bulk/Interrupt (CBI) specific functions 1645 */ 1646 1647static void 1648umass_cbi_start_status(struct umass_softc *sc) 1649{ 1650 if (sc->sc_xfer[UMASS_T_CBI_STATUS]) { 1651 umass_transfer_start(sc, UMASS_T_CBI_STATUS); 1652 } else { 1653 union ccb *ccb = sc->sc_transfer.ccb; 1654 1655 sc->sc_transfer.ccb = NULL; 1656 1657 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; 1658 1659 (sc->sc_transfer.callback) 1660 (sc, ccb, (sc->sc_transfer.data_len - 1661 sc->sc_transfer.actlen), STATUS_CMD_UNKNOWN); 1662 } 1663} 1664 1665static void 1666umass_t_cbi_reset1_callback(struct usb_xfer *xfer, usb_error_t error) 1667{ 1668 struct umass_softc *sc = usbd_xfer_softc(xfer); 1669 struct usb_device_request req; 1670 struct usb_page_cache *pc; 1671 uint8_t buf[UMASS_CBI_DIAGNOSTIC_CMDLEN]; 1672 1673 uint8_t i; 1674 1675 switch (USB_GET_STATE(xfer)) { 1676 case USB_ST_TRANSFERRED: 1677 umass_transfer_start(sc, UMASS_T_CBI_RESET2); 1678 break; 1679 1680 case USB_ST_SETUP: 1681 /* 1682 * Command Block Reset Protocol 1683 * 1684 * First send a reset request to the device. Then clear 1685 * any possibly stalled bulk endpoints. 1686 * 1687 * This is done in 3 steps, using 3 transfers: 1688 * UMASS_T_CBI_RESET1 1689 * UMASS_T_CBI_RESET2 1690 * UMASS_T_CBI_RESET3 1691 * UMASS_T_CBI_RESET4 (only if there is an interrupt endpoint) 1692 */ 1693 1694 DPRINTF(sc, UDMASS_CBI, "CBI reset!\n"); 1695 1696 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1697 req.bRequest = UR_CBI_ADSC; 1698 USETW(req.wValue, 0); 1699 req.wIndex[0] = sc->sc_iface_no; 1700 req.wIndex[1] = 0; 1701 USETW(req.wLength, UMASS_CBI_DIAGNOSTIC_CMDLEN); 1702 1703 /* 1704 * The 0x1d code is the SEND DIAGNOSTIC command. To 1705 * distinguish between the two, the last 10 bytes of the CBL 1706 * is filled with 0xff (section 2.2 of the CBI 1707 * specification) 1708 */ 1709 buf[0] = 0x1d; /* Command Block Reset */ 1710 buf[1] = 0x04; 1711 1712 for (i = 2; i < UMASS_CBI_DIAGNOSTIC_CMDLEN; i++) { 1713 buf[i] = 0xff; 1714 } 1715 1716 pc = usbd_xfer_get_frame(xfer, 0); 1717 usbd_copy_in(pc, 0, &req, sizeof(req)); 1718 pc = usbd_xfer_get_frame(xfer, 1); 1719 usbd_copy_in(pc, 0, buf, sizeof(buf)); 1720 1721 usbd_xfer_set_frame_len(xfer, 0, sizeof(req)); 1722 usbd_xfer_set_frame_len(xfer, 1, sizeof(buf)); 1723 usbd_xfer_set_frames(xfer, 2); 1724 usbd_transfer_submit(xfer); 1725 break; 1726 1727 default: /* Error */ 1728 if (error == USB_ERR_CANCELLED) 1729 umass_tr_error(xfer, error); 1730 else 1731 umass_transfer_start(sc, UMASS_T_CBI_RESET2); 1732 break; 1733 1734 } 1735} 1736 1737static void 1738umass_t_cbi_reset2_callback(struct usb_xfer *xfer, usb_error_t error) 1739{ 1740 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_RESET3, 1741 UMASS_T_CBI_DATA_READ, error); 1742} 1743 1744static void 1745umass_t_cbi_reset3_callback(struct usb_xfer *xfer, usb_error_t error) 1746{ 1747 struct umass_softc *sc = usbd_xfer_softc(xfer); 1748 1749 umass_t_cbi_data_clear_stall_callback 1750 (xfer, (sc->sc_xfer[UMASS_T_CBI_RESET4] && 1751 sc->sc_xfer[UMASS_T_CBI_STATUS]) ? 1752 UMASS_T_CBI_RESET4 : UMASS_T_CBI_COMMAND, 1753 UMASS_T_CBI_DATA_WRITE, error); 1754} 1755 1756static void 1757umass_t_cbi_reset4_callback(struct usb_xfer *xfer, usb_error_t error) 1758{ 1759 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_COMMAND, 1760 UMASS_T_CBI_STATUS, error); 1761} 1762 1763static void 1764umass_t_cbi_data_clear_stall_callback(struct usb_xfer *xfer, 1765 uint8_t next_xfer, uint8_t stall_xfer, usb_error_t error) 1766{ 1767 struct umass_softc *sc = usbd_xfer_softc(xfer); 1768 1769 switch (USB_GET_STATE(xfer)) { 1770 case USB_ST_TRANSFERRED: 1771tr_transferred: 1772 if (next_xfer == UMASS_T_CBI_STATUS) { 1773 umass_cbi_start_status(sc); 1774 } else { 1775 umass_transfer_start(sc, next_xfer); 1776 } 1777 break; 1778 1779 case USB_ST_SETUP: 1780 if (usbd_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) { 1781 goto tr_transferred; /* should not happen */ 1782 } 1783 break; 1784 1785 default: /* Error */ 1786 umass_tr_error(xfer, error); 1787 break; 1788 1789 } 1790} 1791 1792static void 1793umass_t_cbi_command_callback(struct usb_xfer *xfer, usb_error_t error) 1794{ 1795 struct umass_softc *sc = usbd_xfer_softc(xfer); 1796 union ccb *ccb = sc->sc_transfer.ccb; 1797 struct usb_device_request req; 1798 struct usb_page_cache *pc; 1799 1800 switch (USB_GET_STATE(xfer)) { 1801 case USB_ST_TRANSFERRED: 1802 1803 if (sc->sc_transfer.dir == DIR_NONE) { 1804 umass_cbi_start_status(sc); 1805 } else { 1806 umass_transfer_start 1807 (sc, (sc->sc_transfer.dir == DIR_IN) ? 1808 UMASS_T_CBI_DATA_READ : UMASS_T_CBI_DATA_WRITE); 1809 } 1810 break; 1811 1812 case USB_ST_SETUP: 1813 1814 if (ccb) { 1815 1816 /* 1817 * do a CBI transfer with cmd_len bytes from 1818 * cmd_data, possibly a data phase of data_len 1819 * bytes from/to the device and finally a status 1820 * read phase. 1821 */ 1822 1823 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1824 req.bRequest = UR_CBI_ADSC; 1825 USETW(req.wValue, 0); 1826 req.wIndex[0] = sc->sc_iface_no; 1827 req.wIndex[1] = 0; 1828 req.wLength[0] = sc->sc_transfer.cmd_len; 1829 req.wLength[1] = 0; 1830 1831 pc = usbd_xfer_get_frame(xfer, 0); 1832 usbd_copy_in(pc, 0, &req, sizeof(req)); 1833 pc = usbd_xfer_get_frame(xfer, 1); 1834 usbd_copy_in(pc, 0, sc->sc_transfer.cmd_data, 1835 sc->sc_transfer.cmd_len); 1836 1837 usbd_xfer_set_frame_len(xfer, 0, sizeof(req)); 1838 usbd_xfer_set_frame_len(xfer, 1, sc->sc_transfer.cmd_len); 1839 usbd_xfer_set_frames(xfer, 1840 sc->sc_transfer.cmd_len ? 2 : 1); 1841 1842 DIF(UDMASS_CBI, 1843 umass_cbi_dump_cmd(sc, 1844 sc->sc_transfer.cmd_data, 1845 sc->sc_transfer.cmd_len)); 1846 1847 usbd_transfer_submit(xfer); 1848 } 1849 break; 1850 1851 default: /* Error */ 1852 umass_tr_error(xfer, error); 1853 /* skip reset */ 1854 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; 1855 break; 1856 } 1857} 1858 1859static void 1860umass_t_cbi_data_read_callback(struct usb_xfer *xfer, usb_error_t error) 1861{ 1862 struct umass_softc *sc = usbd_xfer_softc(xfer); 1863 uint32_t max_bulk = usbd_xfer_max_len(xfer); 1864#ifndef UMASS_EXT_BUFFER 1865 struct usb_page_cache *pc; 1866#endif 1867 int actlen, sumlen; 1868 1869 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL); 1870 1871 switch (USB_GET_STATE(xfer)) { 1872 case USB_ST_TRANSFERRED: 1873#ifndef UMASS_EXT_BUFFER 1874 pc = usbd_xfer_get_frame(xfer, 0); 1875 usbd_copy_out(pc, 0, sc->sc_transfer.data_ptr, actlen); 1876#endif 1877 sc->sc_transfer.data_rem -= actlen; 1878 sc->sc_transfer.data_ptr += actlen; 1879 sc->sc_transfer.actlen += actlen; 1880 1881 if (actlen < sumlen) { 1882 /* short transfer */ 1883 sc->sc_transfer.data_rem = 0; 1884 } 1885 case USB_ST_SETUP: 1886 DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n", 1887 max_bulk, sc->sc_transfer.data_rem); 1888 1889 if (sc->sc_transfer.data_rem == 0) { 1890 umass_cbi_start_status(sc); 1891 break; 1892 } 1893 if (max_bulk > sc->sc_transfer.data_rem) { 1894 max_bulk = sc->sc_transfer.data_rem; 1895 } 1896 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout); 1897 1898#ifdef UMASS_EXT_BUFFER 1899 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr, 1900 max_bulk); 1901#else 1902 usbd_xfer_set_frame_len(xfer, 0, max_bulk); 1903#endif 1904 usbd_transfer_submit(xfer); 1905 break; 1906 1907 default: /* Error */ 1908 if ((error == USB_ERR_CANCELLED) || 1909 (sc->sc_transfer.callback != &umass_cam_cb)) { 1910 umass_tr_error(xfer, error); 1911 } else { 1912 umass_transfer_start(sc, UMASS_T_CBI_DATA_RD_CS); 1913 } 1914 break; 1915 1916 } 1917} 1918 1919static void 1920umass_t_cbi_data_rd_cs_callback(struct usb_xfer *xfer, usb_error_t error) 1921{ 1922 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_STATUS, 1923 UMASS_T_CBI_DATA_READ, error); 1924} 1925 1926static void 1927umass_t_cbi_data_write_callback(struct usb_xfer *xfer, usb_error_t error) 1928{ 1929 struct umass_softc *sc = usbd_xfer_softc(xfer); 1930 uint32_t max_bulk = usbd_xfer_max_len(xfer); 1931#ifndef UMASS_EXT_BUFFER 1932 struct usb_page_cache *pc; 1933#endif 1934 int actlen, sumlen; 1935 1936 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL); 1937 1938 switch (USB_GET_STATE(xfer)) { 1939 case USB_ST_TRANSFERRED: 1940 sc->sc_transfer.data_rem -= actlen; 1941 sc->sc_transfer.data_ptr += actlen; 1942 sc->sc_transfer.actlen += actlen; 1943 1944 if (actlen < sumlen) { 1945 /* short transfer */ 1946 sc->sc_transfer.data_rem = 0; 1947 } 1948 case USB_ST_SETUP: 1949 DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n", 1950 max_bulk, sc->sc_transfer.data_rem); 1951 1952 if (sc->sc_transfer.data_rem == 0) { 1953 umass_cbi_start_status(sc); 1954 break; 1955 } 1956 if (max_bulk > sc->sc_transfer.data_rem) { 1957 max_bulk = sc->sc_transfer.data_rem; 1958 } 1959 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout); 1960 1961#ifdef UMASS_EXT_BUFFER 1962 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr, 1963 max_bulk); 1964#else 1965 pc = usbd_xfer_get_frame(xfer, 0); 1966 usbd_copy_in(pc, 0, sc->sc_transfer.data_ptr, max_bulk); 1967 usbd_xfer_set_frame_len(xfer, 0, max_bulk); 1968#endif 1969 1970 usbd_transfer_submit(xfer); 1971 break; 1972 1973 default: /* Error */ 1974 if ((error == USB_ERR_CANCELLED) || 1975 (sc->sc_transfer.callback != &umass_cam_cb)) { 1976 umass_tr_error(xfer, error); 1977 } else { 1978 umass_transfer_start(sc, UMASS_T_CBI_DATA_WR_CS); 1979 } 1980 break; 1981 1982 } 1983} 1984 1985static void 1986umass_t_cbi_data_wr_cs_callback(struct usb_xfer *xfer, usb_error_t error) 1987{ 1988 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_STATUS, 1989 UMASS_T_CBI_DATA_WRITE, error); 1990} 1991 1992static void 1993umass_t_cbi_status_callback(struct usb_xfer *xfer, usb_error_t error) 1994{ 1995 struct umass_softc *sc = usbd_xfer_softc(xfer); 1996 union ccb *ccb = sc->sc_transfer.ccb; 1997 struct usb_page_cache *pc; 1998 uint32_t residue; 1999 uint8_t status; 2000 int actlen; 2001 2002 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 2003 2004 switch (USB_GET_STATE(xfer)) { 2005 case USB_ST_TRANSFERRED: 2006 2007 if (actlen < sizeof(sc->sbl)) { 2008 goto tr_setup; 2009 } 2010 pc = usbd_xfer_get_frame(xfer, 0); 2011 usbd_copy_out(pc, 0, &sc->sbl, sizeof(sc->sbl)); 2012 2013 residue = (sc->sc_transfer.data_len - 2014 sc->sc_transfer.actlen); 2015 2016 /* dissect the information in the buffer */ 2017 2018 if (sc->sc_proto & UMASS_PROTO_UFI) { 2019 2020 /* 2021 * Section 3.4.3.1.3 specifies that the UFI command 2022 * protocol returns an ASC and ASCQ in the interrupt 2023 * data block. 2024 */ 2025 2026 DPRINTF(sc, UDMASS_CBI, "UFI CCI, ASC = 0x%02x, " 2027 "ASCQ = 0x%02x\n", sc->sbl.ufi.asc, 2028 sc->sbl.ufi.ascq); 2029 2030 status = (((sc->sbl.ufi.asc == 0) && 2031 (sc->sbl.ufi.ascq == 0)) ? 2032 STATUS_CMD_OK : STATUS_CMD_FAILED); 2033 2034 sc->sc_transfer.ccb = NULL; 2035 2036 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; 2037 2038 (sc->sc_transfer.callback) 2039 (sc, ccb, residue, status); 2040 2041 break; 2042 2043 } else { 2044 2045 /* Command Interrupt Data Block */ 2046 2047 DPRINTF(sc, UDMASS_CBI, "type=0x%02x, value=0x%02x\n", 2048 sc->sbl.common.type, sc->sbl.common.value); 2049 2050 if (sc->sbl.common.type == IDB_TYPE_CCI) { 2051 2052 status = (sc->sbl.common.value & IDB_VALUE_STATUS_MASK); 2053 2054 status = ((status == IDB_VALUE_PASS) ? STATUS_CMD_OK : 2055 (status == IDB_VALUE_FAIL) ? STATUS_CMD_FAILED : 2056 (status == IDB_VALUE_PERSISTENT) ? STATUS_CMD_FAILED : 2057 STATUS_WIRE_FAILED); 2058 2059 sc->sc_transfer.ccb = NULL; 2060 2061 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; 2062 2063 (sc->sc_transfer.callback) 2064 (sc, ccb, residue, status); 2065 2066 break; 2067 } 2068 } 2069 2070 /* fallthrough */ 2071 2072 case USB_ST_SETUP: 2073tr_setup: 2074 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 2075 usbd_transfer_submit(xfer); 2076 break; 2077 2078 default: /* Error */ 2079 DPRINTF(sc, UDMASS_CBI, "Failed to read CSW: %s\n", 2080 usbd_errstr(error)); 2081 umass_tr_error(xfer, error); 2082 break; 2083 2084 } 2085} 2086 2087/* 2088 * CAM specific functions (used by SCSI, UFI, 8070i (ATAPI)) 2089 */ 2090 2091static int 2092umass_cam_attach_sim(struct umass_softc *sc) 2093{ 2094 struct cam_devq *devq; /* Per device Queue */ 2095 2096 /* 2097 * A HBA is attached to the CAM layer. 2098 * 2099 * The CAM layer will then after a while start probing for devices on 2100 * the bus. The number of SIMs is limited to one. 2101 */ 2102 2103 devq = cam_simq_alloc(1 /* maximum openings */ ); 2104 if (devq == NULL) { 2105 return (ENOMEM); 2106 } 2107 sc->sc_sim = cam_sim_alloc 2108 (&umass_cam_action, &umass_cam_poll, 2109 DEVNAME_SIM, 2110 sc /* priv */ , 2111 sc->sc_unit /* unit number */ , 2112#if (__FreeBSD_version >= 700037) 2113 &sc->sc_mtx /* mutex */ , 2114#endif 2115 1 /* maximum device openings */ , 2116 0 /* maximum tagged device openings */ , 2117 devq); 2118 2119 if (sc->sc_sim == NULL) { 2120 cam_simq_free(devq); 2121 return (ENOMEM); 2122 } 2123 2124#if (__FreeBSD_version >= 700037) 2125 mtx_lock(&sc->sc_mtx); 2126#endif 2127 2128#if (__FreeBSD_version >= 700048) 2129 if (xpt_bus_register(sc->sc_sim, sc->sc_dev, sc->sc_unit) != CAM_SUCCESS) { 2130 mtx_unlock(&sc->sc_mtx); 2131 return (ENOMEM); 2132 } 2133#else 2134 if (xpt_bus_register(sc->sc_sim, sc->sc_unit) != CAM_SUCCESS) { 2135#if (__FreeBSD_version >= 700037) 2136 mtx_unlock(&sc->sc_mtx); 2137#endif 2138 return (ENOMEM); 2139 } 2140#endif 2141 2142#if (__FreeBSD_version >= 700037) 2143 mtx_unlock(&sc->sc_mtx); 2144#endif 2145 return (0); 2146} 2147 2148static void 2149umass_cam_attach(struct umass_softc *sc) 2150{ 2151#ifndef USB_DEBUG 2152 if (bootverbose) 2153#endif 2154 printf("%s:%d:%d:%d: Attached to scbus%d\n", 2155 sc->sc_name, cam_sim_path(sc->sc_sim), 2156 sc->sc_unit, CAM_LUN_WILDCARD, 2157 cam_sim_path(sc->sc_sim)); 2158} 2159 2160/* umass_cam_detach 2161 * detach from the CAM layer 2162 */ 2163 2164static void 2165umass_cam_detach_sim(struct umass_softc *sc) 2166{ 2167 if (sc->sc_sim != NULL) { 2168 if (xpt_bus_deregister(cam_sim_path(sc->sc_sim))) { 2169 /* accessing the softc is not possible after this */ 2170 sc->sc_sim->softc = UMASS_GONE; 2171 cam_sim_free(sc->sc_sim, /* free_devq */ TRUE); 2172 } else { 2173 panic("%s: CAM layer is busy\n", 2174 sc->sc_name); 2175 } 2176 sc->sc_sim = NULL; 2177 } 2178} 2179 2180/* umass_cam_action 2181 * CAM requests for action come through here 2182 */ 2183 2184static void 2185umass_cam_action(struct cam_sim *sim, union ccb *ccb) 2186{ 2187 struct umass_softc *sc = (struct umass_softc *)sim->softc; 2188 2189 if (sc == UMASS_GONE || 2190 (sc != NULL && !usbd_device_attached(sc->sc_udev))) { 2191 ccb->ccb_h.status = CAM_SEL_TIMEOUT; 2192 xpt_done(ccb); 2193 return; 2194 } 2195 if (sc) { 2196#if (__FreeBSD_version < 700037) 2197 mtx_lock(&sc->sc_mtx); 2198#endif 2199 } 2200 /* 2201 * Verify, depending on the operation to perform, that we either got 2202 * a valid sc, because an existing target was referenced, or 2203 * otherwise the SIM is addressed. 2204 * 2205 * This avoids bombing out at a printf and does give the CAM layer some 2206 * sensible feedback on errors. 2207 */ 2208 switch (ccb->ccb_h.func_code) { 2209 case XPT_SCSI_IO: 2210 case XPT_RESET_DEV: 2211 case XPT_GET_TRAN_SETTINGS: 2212 case XPT_SET_TRAN_SETTINGS: 2213 case XPT_CALC_GEOMETRY: 2214 /* the opcodes requiring a target. These should never occur. */ 2215 if (sc == NULL) { 2216 DPRINTF(sc, UDMASS_GEN, "%s:%d:%d:%d:func_code 0x%04x: " 2217 "Invalid target (target needed)\n", 2218 DEVNAME_SIM, cam_sim_path(sc->sc_sim), 2219 ccb->ccb_h.target_id, ccb->ccb_h.target_lun, 2220 ccb->ccb_h.func_code); 2221 2222 ccb->ccb_h.status = CAM_TID_INVALID; 2223 xpt_done(ccb); 2224 goto done; 2225 } 2226 break; 2227 case XPT_PATH_INQ: 2228 case XPT_NOOP: 2229 /* 2230 * The opcodes sometimes aimed at a target (sc is valid), 2231 * sometimes aimed at the SIM (sc is invalid and target is 2232 * CAM_TARGET_WILDCARD) 2233 */ 2234 if ((sc == NULL) && 2235 (ccb->ccb_h.target_id != CAM_TARGET_WILDCARD)) { 2236 DPRINTF(sc, UDMASS_SCSI, "%s:%d:%d:%d:func_code 0x%04x: " 2237 "Invalid target (no wildcard)\n", 2238 DEVNAME_SIM, cam_sim_path(sc->sc_sim), 2239 ccb->ccb_h.target_id, ccb->ccb_h.target_lun, 2240 ccb->ccb_h.func_code); 2241 2242 ccb->ccb_h.status = CAM_TID_INVALID; 2243 xpt_done(ccb); 2244 goto done; 2245 } 2246 break; 2247 default: 2248 /* XXX Hm, we should check the input parameters */ 2249 break; 2250 } 2251 2252 /* Perform the requested action */ 2253 switch (ccb->ccb_h.func_code) { 2254 case XPT_SCSI_IO: 2255 { 2256 uint8_t *cmd; 2257 uint8_t dir; 2258 2259 if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) { 2260 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr); 2261 } else { 2262 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes); 2263 } 2264 2265 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SCSI_IO: " 2266 "cmd: 0x%02x, flags: 0x%02x, " 2267 "%db cmd/%db data/%db sense\n", 2268 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, 2269 ccb->ccb_h.target_lun, cmd[0], 2270 ccb->ccb_h.flags & CAM_DIR_MASK, ccb->csio.cdb_len, 2271 ccb->csio.dxfer_len, ccb->csio.sense_len); 2272 2273 if (sc->sc_transfer.ccb) { 2274 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SCSI_IO: " 2275 "I/O in progress, deferring\n", 2276 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, 2277 ccb->ccb_h.target_lun); 2278 ccb->ccb_h.status = CAM_SCSI_BUSY; 2279 xpt_done(ccb); 2280 goto done; 2281 } 2282 switch (ccb->ccb_h.flags & CAM_DIR_MASK) { 2283 case CAM_DIR_IN: 2284 dir = DIR_IN; 2285 break; 2286 case CAM_DIR_OUT: 2287 dir = DIR_OUT; 2288 DIF(UDMASS_SCSI, 2289 umass_dump_buffer(sc, ccb->csio.data_ptr, 2290 ccb->csio.dxfer_len, 48)); 2291 break; 2292 default: 2293 dir = DIR_NONE; 2294 } 2295 2296 ccb->ccb_h.status = CAM_REQ_INPROG | CAM_SIM_QUEUED; 2297 2298 /* 2299 * sc->sc_transform will convert the command to the 2300 * command format needed by the specific command set 2301 * and return the converted command in 2302 * "sc->sc_transfer.cmd_data" 2303 */ 2304 if (umass_std_transform(sc, ccb, cmd, ccb->csio.cdb_len)) { 2305 2306 if (sc->sc_transfer.cmd_data[0] == INQUIRY) { 2307 const char *pserial; 2308 2309 pserial = usb_get_serial(sc->sc_udev); 2310 2311 /* 2312 * Umass devices don't generally report their serial numbers 2313 * in the usual SCSI way. Emulate it here. 2314 */ 2315 if ((sc->sc_transfer.cmd_data[1] & SI_EVPD) && 2316 (sc->sc_transfer.cmd_data[2] == SVPD_UNIT_SERIAL_NUMBER) && 2317 (pserial[0] != '\0')) { 2318 struct scsi_vpd_unit_serial_number *vpd_serial; 2319 2320 vpd_serial = (struct scsi_vpd_unit_serial_number *)ccb->csio.data_ptr; 2321 vpd_serial->length = strlen(pserial); 2322 if (vpd_serial->length > sizeof(vpd_serial->serial_num)) 2323 vpd_serial->length = sizeof(vpd_serial->serial_num); 2324 memcpy(vpd_serial->serial_num, pserial, vpd_serial->length); 2325 ccb->csio.scsi_status = SCSI_STATUS_OK; 2326 ccb->ccb_h.status = CAM_REQ_CMP; 2327 xpt_done(ccb); 2328 goto done; 2329 } 2330 2331 /* 2332 * Handle EVPD inquiry for broken devices first 2333 * NO_INQUIRY also implies NO_INQUIRY_EVPD 2334 */ 2335 if ((sc->sc_quirks & (NO_INQUIRY_EVPD | NO_INQUIRY)) && 2336 (sc->sc_transfer.cmd_data[1] & SI_EVPD)) { 2337 struct scsi_sense_data *sense; 2338 2339 sense = &ccb->csio.sense_data; 2340 bzero(sense, sizeof(*sense)); 2341 sense->error_code = SSD_CURRENT_ERROR; 2342 sense->flags = SSD_KEY_ILLEGAL_REQUEST; 2343 sense->add_sense_code = 0x24; 2344 sense->extra_len = 10; 2345 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; 2346 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR | 2347 CAM_AUTOSNS_VALID; 2348 xpt_done(ccb); 2349 goto done; 2350 } 2351 /* 2352 * Return fake inquiry data for 2353 * broken devices 2354 */ 2355 if (sc->sc_quirks & NO_INQUIRY) { 2356 memcpy(ccb->csio.data_ptr, &fake_inq_data, 2357 sizeof(fake_inq_data)); 2358 ccb->csio.scsi_status = SCSI_STATUS_OK; 2359 ccb->ccb_h.status = CAM_REQ_CMP; 2360 xpt_done(ccb); 2361 goto done; 2362 } 2363 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) { 2364 ccb->csio.dxfer_len = SHORT_INQUIRY_LENGTH; 2365 } 2366 } else if (sc->sc_transfer.cmd_data[0] == SYNCHRONIZE_CACHE) { 2367 if (sc->sc_quirks & NO_SYNCHRONIZE_CACHE) { 2368 ccb->csio.scsi_status = SCSI_STATUS_OK; 2369 ccb->ccb_h.status = CAM_REQ_CMP; 2370 xpt_done(ccb); 2371 goto done; 2372 } 2373 } 2374 umass_command_start(sc, dir, ccb->csio.data_ptr, 2375 ccb->csio.dxfer_len, 2376 ccb->ccb_h.timeout, 2377 &umass_cam_cb, ccb); 2378 } 2379 break; 2380 } 2381 case XPT_PATH_INQ: 2382 { 2383 struct ccb_pathinq *cpi = &ccb->cpi; 2384 2385 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_PATH_INQ:.\n", 2386 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id, 2387 ccb->ccb_h.target_lun); 2388 2389 /* host specific information */ 2390 cpi->version_num = 1; 2391 cpi->hba_inquiry = 0; 2392 cpi->target_sprt = 0; 2393 cpi->hba_misc = PIM_NO_6_BYTE; 2394 cpi->hba_eng_cnt = 0; 2395 cpi->max_target = UMASS_SCSIID_MAX; /* one target */ 2396 cpi->initiator_id = UMASS_SCSIID_HOST; 2397 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN); 2398 strlcpy(cpi->hba_vid, "USB SCSI", HBA_IDLEN); 2399 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN); 2400 cpi->unit_number = cam_sim_unit(sim); 2401 cpi->bus_id = sc->sc_unit; 2402#if (__FreeBSD_version >= 700025) 2403 cpi->protocol = PROTO_SCSI; 2404 cpi->protocol_version = SCSI_REV_2; 2405 cpi->transport = XPORT_USB; 2406 cpi->transport_version = 0; 2407#endif 2408 if (sc == NULL) { 2409 cpi->base_transfer_speed = 0; 2410 cpi->max_lun = 0; 2411 } else { 2412 if (sc->sc_quirks & FLOPPY_SPEED) { 2413 cpi->base_transfer_speed = 2414 UMASS_FLOPPY_TRANSFER_SPEED; 2415 } else if (usbd_get_speed(sc->sc_udev) == 2416 USB_SPEED_HIGH) { 2417 cpi->base_transfer_speed = 2418 UMASS_HIGH_TRANSFER_SPEED; 2419 } else { 2420 cpi->base_transfer_speed = 2421 UMASS_FULL_TRANSFER_SPEED; 2422 } 2423 cpi->max_lun = sc->sc_maxlun; 2424 } 2425 2426 cpi->ccb_h.status = CAM_REQ_CMP; 2427 xpt_done(ccb); 2428 break; 2429 } 2430 case XPT_RESET_DEV: 2431 { 2432 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_RESET_DEV:.\n", 2433 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, 2434 ccb->ccb_h.target_lun); 2435 2436 umass_reset(sc); 2437 2438 ccb->ccb_h.status = CAM_REQ_CMP; 2439 xpt_done(ccb); 2440 break; 2441 } 2442 case XPT_GET_TRAN_SETTINGS: 2443 { 2444 struct ccb_trans_settings *cts = &ccb->cts; 2445 2446 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_GET_TRAN_SETTINGS:.\n", 2447 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, 2448 ccb->ccb_h.target_lun); 2449 2450#if (__FreeBSD_version >= 700025) 2451 cts->protocol = PROTO_SCSI; 2452 cts->protocol_version = SCSI_REV_2; 2453 cts->transport = XPORT_USB; 2454 cts->transport_version = 0; 2455 cts->xport_specific.valid = 0; 2456#else 2457 cts->valid = 0; 2458 cts->flags = 0; /* no disconnection, tagging */ 2459#endif 2460 ccb->ccb_h.status = CAM_REQ_CMP; 2461 xpt_done(ccb); 2462 break; 2463 } 2464 case XPT_SET_TRAN_SETTINGS: 2465 { 2466 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SET_TRAN_SETTINGS:.\n", 2467 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, 2468 ccb->ccb_h.target_lun); 2469 2470 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL; 2471 xpt_done(ccb); 2472 break; 2473 } 2474 case XPT_CALC_GEOMETRY: 2475 { 2476 cam_calc_geometry(&ccb->ccg, /* extended */ 1); 2477 xpt_done(ccb); 2478 break; 2479 } 2480 case XPT_NOOP: 2481 { 2482 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_NOOP:.\n", 2483 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id, 2484 ccb->ccb_h.target_lun); 2485 2486 ccb->ccb_h.status = CAM_REQ_CMP; 2487 xpt_done(ccb); 2488 break; 2489 } 2490 default: 2491 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:func_code 0x%04x: " 2492 "Not implemented\n", 2493 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id, 2494 ccb->ccb_h.target_lun, ccb->ccb_h.func_code); 2495 2496 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL; 2497 xpt_done(ccb); 2498 break; 2499 } 2500 2501done: 2502#if (__FreeBSD_version < 700037) 2503 if (sc) { 2504 mtx_unlock(&sc->sc_mtx); 2505 } 2506#endif 2507 return; 2508} 2509 2510static void 2511umass_cam_poll(struct cam_sim *sim) 2512{ 2513 struct umass_softc *sc = (struct umass_softc *)sim->softc; 2514 2515 if (sc == UMASS_GONE) 2516 return; 2517 2518 DPRINTF(sc, UDMASS_SCSI, "CAM poll\n"); 2519 2520 usbd_transfer_poll(sc->sc_xfer, UMASS_T_MAX); 2521} 2522 2523 2524/* umass_cam_cb 2525 * finalise a completed CAM command 2526 */ 2527 2528static void 2529umass_cam_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue, 2530 uint8_t status) 2531{ 2532 ccb->csio.resid = residue; 2533 2534 switch (status) { 2535 case STATUS_CMD_OK: 2536 ccb->ccb_h.status = CAM_REQ_CMP; 2537 if ((sc->sc_quirks & READ_CAPACITY_OFFBY1) && 2538 (ccb->ccb_h.func_code == XPT_SCSI_IO) && 2539 (ccb->csio.cdb_io.cdb_bytes[0] == READ_CAPACITY)) { 2540 struct scsi_read_capacity_data *rcap; 2541 uint32_t maxsector; 2542 2543 rcap = (void *)(ccb->csio.data_ptr); 2544 maxsector = scsi_4btoul(rcap->addr) - 1; 2545 scsi_ulto4b(maxsector, rcap->addr); 2546 } 2547 /* 2548 * We have to add SVPD_UNIT_SERIAL_NUMBER to the list 2549 * of pages supported by the device - otherwise, CAM 2550 * will never ask us for the serial number if the 2551 * device cannot handle that by itself. 2552 */ 2553 if (ccb->ccb_h.func_code == XPT_SCSI_IO && 2554 sc->sc_transfer.cmd_data[0] == INQUIRY && 2555 (sc->sc_transfer.cmd_data[1] & SI_EVPD) && 2556 sc->sc_transfer.cmd_data[2] == SVPD_SUPPORTED_PAGE_LIST && 2557 (usb_get_serial(sc->sc_udev)[0] != '\0')) { 2558 struct ccb_scsiio *csio; 2559 struct scsi_vpd_supported_page_list *page_list; 2560 2561 csio = &ccb->csio; 2562 page_list = (struct scsi_vpd_supported_page_list *)csio->data_ptr; 2563 if (page_list->length + 1 < SVPD_SUPPORTED_PAGES_SIZE) { 2564 page_list->list[page_list->length] = SVPD_UNIT_SERIAL_NUMBER; 2565 page_list->length++; 2566 } 2567 } 2568 xpt_done(ccb); 2569 break; 2570 2571 case STATUS_CMD_UNKNOWN: 2572 case STATUS_CMD_FAILED: 2573 2574 /* fetch sense data */ 2575 2576 /* the rest of the command was filled in at attach */ 2577 sc->cam_scsi_sense.length = ccb->csio.sense_len; 2578 2579 DPRINTF(sc, UDMASS_SCSI, "Fetching %d bytes of " 2580 "sense data\n", ccb->csio.sense_len); 2581 2582 if (umass_std_transform(sc, ccb, &sc->cam_scsi_sense.opcode, 2583 sizeof(sc->cam_scsi_sense))) { 2584 2585 if ((sc->sc_quirks & FORCE_SHORT_INQUIRY) && 2586 (sc->sc_transfer.cmd_data[0] == INQUIRY)) { 2587 ccb->csio.sense_len = SHORT_INQUIRY_LENGTH; 2588 } 2589 umass_command_start(sc, DIR_IN, &ccb->csio.sense_data.error_code, 2590 ccb->csio.sense_len, ccb->ccb_h.timeout, 2591 &umass_cam_sense_cb, ccb); 2592 } 2593 break; 2594 2595 default: 2596 /* 2597 * The wire protocol failed and will hopefully have 2598 * recovered. We return an error to CAM and let CAM 2599 * retry the command if necessary. In case of SCSI IO 2600 * commands we ask the CAM layer to check the 2601 * condition first. This is a quick hack to make 2602 * certain devices work. 2603 */ 2604 if (ccb->ccb_h.func_code == XPT_SCSI_IO) { 2605 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR; 2606 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; 2607 } else { 2608 ccb->ccb_h.status = CAM_REQ_CMP_ERR; 2609 } 2610 xpt_done(ccb); 2611 break; 2612 } 2613} 2614 2615/* 2616 * Finalise a completed autosense operation 2617 */ 2618static void 2619umass_cam_sense_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue, 2620 uint8_t status) 2621{ 2622 uint8_t *cmd; 2623 uint8_t key; 2624 2625 switch (status) { 2626 case STATUS_CMD_OK: 2627 case STATUS_CMD_UNKNOWN: 2628 case STATUS_CMD_FAILED: 2629 2630 if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) { 2631 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr); 2632 } else { 2633 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes); 2634 } 2635 2636 key = (ccb->csio.sense_data.flags & SSD_KEY); 2637 2638 /* 2639 * Getting sense data always succeeds (apart from wire 2640 * failures): 2641 */ 2642 if ((sc->sc_quirks & RS_NO_CLEAR_UA) && 2643 (cmd[0] == INQUIRY) && 2644 (key == SSD_KEY_UNIT_ATTENTION)) { 2645 /* 2646 * Ignore unit attention errors in the case where 2647 * the Unit Attention state is not cleared on 2648 * REQUEST SENSE. They will appear again at the next 2649 * command. 2650 */ 2651 ccb->ccb_h.status = CAM_REQ_CMP; 2652 } else if (key == SSD_KEY_NO_SENSE) { 2653 /* 2654 * No problem after all (in the case of CBI without 2655 * CCI) 2656 */ 2657 ccb->ccb_h.status = CAM_REQ_CMP; 2658 } else if ((sc->sc_quirks & RS_NO_CLEAR_UA) && 2659 (cmd[0] == READ_CAPACITY) && 2660 (key == SSD_KEY_UNIT_ATTENTION)) { 2661 /* 2662 * Some devices do not clear the unit attention error 2663 * on request sense. We insert a test unit ready 2664 * command to make sure we clear the unit attention 2665 * condition, then allow the retry to proceed as 2666 * usual. 2667 */ 2668 2669 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR 2670 | CAM_AUTOSNS_VALID; 2671 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; 2672 2673#if 0 2674 DELAY(300000); 2675#endif 2676 DPRINTF(sc, UDMASS_SCSI, "Doing a sneaky" 2677 "TEST_UNIT_READY\n"); 2678 2679 /* the rest of the command was filled in at attach */ 2680 2681 if (umass_std_transform(sc, ccb, 2682 &sc->cam_scsi_test_unit_ready.opcode, 2683 sizeof(sc->cam_scsi_test_unit_ready))) { 2684 umass_command_start(sc, DIR_NONE, NULL, 0, 2685 ccb->ccb_h.timeout, 2686 &umass_cam_quirk_cb, ccb); 2687 } 2688 break; 2689 } else { 2690 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR 2691 | CAM_AUTOSNS_VALID; 2692 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; 2693 } 2694 xpt_done(ccb); 2695 break; 2696 2697 default: 2698 DPRINTF(sc, UDMASS_SCSI, "Autosense failed, " 2699 "status %d\n", status); 2700 ccb->ccb_h.status = CAM_AUTOSENSE_FAIL; 2701 xpt_done(ccb); 2702 } 2703} 2704 2705/* 2706 * This completion code just handles the fact that we sent a test-unit-ready 2707 * after having previously failed a READ CAPACITY with CHECK_COND. Even 2708 * though this command succeeded, we have to tell CAM to retry. 2709 */ 2710static void 2711umass_cam_quirk_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue, 2712 uint8_t status) 2713{ 2714 DPRINTF(sc, UDMASS_SCSI, "Test unit ready " 2715 "returned status %d\n", status); 2716 2717 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR 2718 | CAM_AUTOSNS_VALID; 2719 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; 2720 xpt_done(ccb); 2721} 2722 2723/* 2724 * SCSI specific functions 2725 */ 2726 2727static uint8_t 2728umass_scsi_transform(struct umass_softc *sc, uint8_t *cmd_ptr, 2729 uint8_t cmd_len) 2730{ 2731 if ((cmd_len == 0) || 2732 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { 2733 DPRINTF(sc, UDMASS_SCSI, "Invalid command " 2734 "length: %d bytes\n", cmd_len); 2735 return (0); /* failure */ 2736 } 2737 sc->sc_transfer.cmd_len = cmd_len; 2738 2739 switch (cmd_ptr[0]) { 2740 case TEST_UNIT_READY: 2741 if (sc->sc_quirks & NO_TEST_UNIT_READY) { 2742 DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY " 2743 "to START_UNIT\n"); 2744 bzero(sc->sc_transfer.cmd_data, cmd_len); 2745 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT; 2746 sc->sc_transfer.cmd_data[4] = SSS_START; 2747 return (1); 2748 } 2749 break; 2750 2751 case INQUIRY: 2752 /* 2753 * some drives wedge when asked for full inquiry 2754 * information. 2755 */ 2756 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) { 2757 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); 2758 sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH; 2759 return (1); 2760 } 2761 break; 2762 } 2763 2764 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); 2765 return (1); 2766} 2767 2768static uint8_t 2769umass_rbc_transform(struct umass_softc *sc, uint8_t *cmd_ptr, uint8_t cmd_len) 2770{ 2771 if ((cmd_len == 0) || 2772 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { 2773 DPRINTF(sc, UDMASS_SCSI, "Invalid command " 2774 "length: %d bytes\n", cmd_len); 2775 return (0); /* failure */ 2776 } 2777 switch (cmd_ptr[0]) { 2778 /* these commands are defined in RBC: */ 2779 case READ_10: 2780 case READ_CAPACITY: 2781 case START_STOP_UNIT: 2782 case SYNCHRONIZE_CACHE: 2783 case WRITE_10: 2784 case 0x2f: /* VERIFY_10 is absent from 2785 * scsi_all.h??? */ 2786 case INQUIRY: 2787 case MODE_SELECT_10: 2788 case MODE_SENSE_10: 2789 case TEST_UNIT_READY: 2790 case WRITE_BUFFER: 2791 /* 2792 * The following commands are not listed in my copy of the 2793 * RBC specs. CAM however seems to want those, and at least 2794 * the Sony DSC device appears to support those as well 2795 */ 2796 case REQUEST_SENSE: 2797 case PREVENT_ALLOW: 2798 2799 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); 2800 2801 if ((sc->sc_quirks & RBC_PAD_TO_12) && (cmd_len < 12)) { 2802 bzero(sc->sc_transfer.cmd_data + cmd_len, 12 - cmd_len); 2803 cmd_len = 12; 2804 } 2805 sc->sc_transfer.cmd_len = cmd_len; 2806 return (1); /* sucess */ 2807 2808 /* All other commands are not legal in RBC */ 2809 default: 2810 DPRINTF(sc, UDMASS_SCSI, "Unsupported RBC " 2811 "command 0x%02x\n", cmd_ptr[0]); 2812 return (0); /* failure */ 2813 } 2814} 2815 2816static uint8_t 2817umass_ufi_transform(struct umass_softc *sc, uint8_t *cmd_ptr, 2818 uint8_t cmd_len) 2819{ 2820 if ((cmd_len == 0) || 2821 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { 2822 DPRINTF(sc, UDMASS_SCSI, "Invalid command " 2823 "length: %d bytes\n", cmd_len); 2824 return (0); /* failure */ 2825 } 2826 /* An UFI command is always 12 bytes in length */ 2827 sc->sc_transfer.cmd_len = UFI_COMMAND_LENGTH; 2828 2829 /* Zero the command data */ 2830 bzero(sc->sc_transfer.cmd_data, UFI_COMMAND_LENGTH); 2831 2832 switch (cmd_ptr[0]) { 2833 /* 2834 * Commands of which the format has been verified. They 2835 * should work. Copy the command into the (zeroed out) 2836 * destination buffer. 2837 */ 2838 case TEST_UNIT_READY: 2839 if (sc->sc_quirks & NO_TEST_UNIT_READY) { 2840 /* 2841 * Some devices do not support this command. Start 2842 * Stop Unit should give the same results 2843 */ 2844 DPRINTF(sc, UDMASS_UFI, "Converted TEST_UNIT_READY " 2845 "to START_UNIT\n"); 2846 2847 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT; 2848 sc->sc_transfer.cmd_data[4] = SSS_START; 2849 return (1); 2850 } 2851 break; 2852 2853 case REZERO_UNIT: 2854 case REQUEST_SENSE: 2855 case FORMAT_UNIT: 2856 case INQUIRY: 2857 case START_STOP_UNIT: 2858 case SEND_DIAGNOSTIC: 2859 case PREVENT_ALLOW: 2860 case READ_CAPACITY: 2861 case READ_10: 2862 case WRITE_10: 2863 case POSITION_TO_ELEMENT: /* SEEK_10 */ 2864 case WRITE_AND_VERIFY: 2865 case VERIFY: 2866 case MODE_SELECT_10: 2867 case MODE_SENSE_10: 2868 case READ_12: 2869 case WRITE_12: 2870 case READ_FORMAT_CAPACITIES: 2871 break; 2872 2873 /* 2874 * SYNCHRONIZE_CACHE isn't supported by UFI, nor should it be 2875 * required for UFI devices, so it is appropriate to fake 2876 * success. 2877 */ 2878 case SYNCHRONIZE_CACHE: 2879 return (2); 2880 2881 default: 2882 DPRINTF(sc, UDMASS_SCSI, "Unsupported UFI " 2883 "command 0x%02x\n", cmd_ptr[0]); 2884 return (0); /* failure */ 2885 } 2886 2887 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); 2888 return (1); /* success */ 2889} 2890 2891/* 2892 * 8070i (ATAPI) specific functions 2893 */ 2894static uint8_t 2895umass_atapi_transform(struct umass_softc *sc, uint8_t *cmd_ptr, 2896 uint8_t cmd_len) 2897{ 2898 if ((cmd_len == 0) || 2899 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { 2900 DPRINTF(sc, UDMASS_SCSI, "Invalid command " 2901 "length: %d bytes\n", cmd_len); 2902 return (0); /* failure */ 2903 } 2904 /* An ATAPI command is always 12 bytes in length. */ 2905 sc->sc_transfer.cmd_len = ATAPI_COMMAND_LENGTH; 2906 2907 /* Zero the command data */ 2908 bzero(sc->sc_transfer.cmd_data, ATAPI_COMMAND_LENGTH); 2909 2910 switch (cmd_ptr[0]) { 2911 /* 2912 * Commands of which the format has been verified. They 2913 * should work. Copy the command into the destination 2914 * buffer. 2915 */ 2916 case INQUIRY: 2917 /* 2918 * some drives wedge when asked for full inquiry 2919 * information. 2920 */ 2921 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) { 2922 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); 2923 2924 sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH; 2925 return (1); 2926 } 2927 break; 2928 2929 case TEST_UNIT_READY: 2930 if (sc->sc_quirks & NO_TEST_UNIT_READY) { 2931 DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY " 2932 "to START_UNIT\n"); 2933 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT; 2934 sc->sc_transfer.cmd_data[4] = SSS_START; 2935 return (1); 2936 } 2937 break; 2938 2939 case REZERO_UNIT: 2940 case REQUEST_SENSE: 2941 case START_STOP_UNIT: 2942 case SEND_DIAGNOSTIC: 2943 case PREVENT_ALLOW: 2944 case READ_CAPACITY: 2945 case READ_10: 2946 case WRITE_10: 2947 case POSITION_TO_ELEMENT: /* SEEK_10 */ 2948 case SYNCHRONIZE_CACHE: 2949 case MODE_SELECT_10: 2950 case MODE_SENSE_10: 2951 case READ_BUFFER: 2952 case 0x42: /* READ_SUBCHANNEL */ 2953 case 0x43: /* READ_TOC */ 2954 case 0x44: /* READ_HEADER */ 2955 case 0x47: /* PLAY_MSF (Play Minute/Second/Frame) */ 2956 case 0x48: /* PLAY_TRACK */ 2957 case 0x49: /* PLAY_TRACK_REL */ 2958 case 0x4b: /* PAUSE */ 2959 case 0x51: /* READ_DISK_INFO */ 2960 case 0x52: /* READ_TRACK_INFO */ 2961 case 0x54: /* SEND_OPC */ 2962 case 0x59: /* READ_MASTER_CUE */ 2963 case 0x5b: /* CLOSE_TR_SESSION */ 2964 case 0x5c: /* READ_BUFFER_CAP */ 2965 case 0x5d: /* SEND_CUE_SHEET */ 2966 case 0xa1: /* BLANK */ 2967 case 0xa5: /* PLAY_12 */ 2968 case 0xa6: /* EXCHANGE_MEDIUM */ 2969 case 0xad: /* READ_DVD_STRUCTURE */ 2970 case 0xbb: /* SET_CD_SPEED */ 2971 case 0xe5: /* READ_TRACK_INFO_PHILIPS */ 2972 break; 2973 2974 case READ_12: 2975 case WRITE_12: 2976 default: 2977 DPRINTF(sc, UDMASS_SCSI, "Unsupported ATAPI " 2978 "command 0x%02x - trying anyway\n", 2979 cmd_ptr[0]); 2980 break; 2981 } 2982 2983 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); 2984 return (1); /* success */ 2985} 2986 2987static uint8_t 2988umass_no_transform(struct umass_softc *sc, uint8_t *cmd, 2989 uint8_t cmdlen) 2990{ 2991 return (0); /* failure */ 2992} 2993 2994static uint8_t 2995umass_std_transform(struct umass_softc *sc, union ccb *ccb, 2996 uint8_t *cmd, uint8_t cmdlen) 2997{ 2998 uint8_t retval; 2999 3000 retval = (sc->sc_transform) (sc, cmd, cmdlen); 3001 3002 if (retval == 2) { 3003 ccb->ccb_h.status = CAM_REQ_CMP; 3004 xpt_done(ccb); 3005 return (0); 3006 } else if (retval == 0) { 3007 ccb->ccb_h.status = CAM_REQ_INVALID; 3008 xpt_done(ccb); 3009 return (0); 3010 } 3011 /* Command should be executed */ 3012 return (1); 3013} 3014 3015#ifdef USB_DEBUG 3016static void 3017umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw) 3018{ 3019 uint8_t *c = cbw->CBWCDB; 3020 3021 uint32_t dlen = UGETDW(cbw->dCBWDataTransferLength); 3022 uint32_t tag = UGETDW(cbw->dCBWTag); 3023 3024 uint8_t clen = cbw->bCDBLength; 3025 uint8_t flags = cbw->bCBWFlags; 3026 uint8_t lun = cbw->bCBWLUN; 3027 3028 DPRINTF(sc, UDMASS_BBB, "CBW %d: cmd = %db " 3029 "(0x%02x%02x%02x%02x%02x%02x%s), " 3030 "data = %db, lun = %d, dir = %s\n", 3031 tag, clen, 3032 c[0], c[1], c[2], c[3], c[4], c[5], (clen > 6 ? "..." : ""), 3033 dlen, lun, (flags == CBWFLAGS_IN ? "in" : 3034 (flags == CBWFLAGS_OUT ? "out" : "<invalid>"))); 3035} 3036 3037static void 3038umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw) 3039{ 3040 uint32_t sig = UGETDW(csw->dCSWSignature); 3041 uint32_t tag = UGETDW(csw->dCSWTag); 3042 uint32_t res = UGETDW(csw->dCSWDataResidue); 3043 uint8_t status = csw->bCSWStatus; 3044 3045 DPRINTF(sc, UDMASS_BBB, "CSW %d: sig = 0x%08x (%s), tag = 0x%08x, " 3046 "res = %d, status = 0x%02x (%s)\n", 3047 tag, sig, (sig == CSWSIGNATURE ? "valid" : "invalid"), 3048 tag, res, 3049 status, (status == CSWSTATUS_GOOD ? "good" : 3050 (status == CSWSTATUS_FAILED ? "failed" : 3051 (status == CSWSTATUS_PHASE ? "phase" : "<invalid>")))); 3052} 3053 3054static void 3055umass_cbi_dump_cmd(struct umass_softc *sc, void *cmd, uint8_t cmdlen) 3056{ 3057 uint8_t *c = cmd; 3058 uint8_t dir = sc->sc_transfer.dir; 3059 3060 DPRINTF(sc, UDMASS_BBB, "cmd = %db " 3061 "(0x%02x%02x%02x%02x%02x%02x%s), " 3062 "data = %db, dir = %s\n", 3063 cmdlen, 3064 c[0], c[1], c[2], c[3], c[4], c[5], (cmdlen > 6 ? "..." : ""), 3065 sc->sc_transfer.data_len, 3066 (dir == DIR_IN ? "in" : 3067 (dir == DIR_OUT ? "out" : 3068 (dir == DIR_NONE ? "no data phase" : "<invalid>")))); 3069} 3070 3071static void 3072umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, uint32_t buflen, 3073 uint32_t printlen) 3074{ 3075 uint32_t i, j; 3076 char s1[40]; 3077 char s2[40]; 3078 char s3[5]; 3079 3080 s1[0] = '\0'; 3081 s3[0] = '\0'; 3082 3083 sprintf(s2, " buffer=%p, buflen=%d", buffer, buflen); 3084 for (i = 0; (i < buflen) && (i < printlen); i++) { 3085 j = i % 16; 3086 if (j == 0 && i != 0) { 3087 DPRINTF(sc, UDMASS_GEN, "0x %s%s\n", 3088 s1, s2); 3089 s2[0] = '\0'; 3090 } 3091 sprintf(&s1[j * 2], "%02x", buffer[i] & 0xff); 3092 } 3093 if (buflen > printlen) 3094 sprintf(s3, " ..."); 3095 DPRINTF(sc, UDMASS_GEN, "0x %s%s%s\n", 3096 s1, s2, s3); 3097} 3098 3099#endif 3100