5 * Copyright (c) 1999 MAEKAWA Masahide <bishop@rr.iij4u.or.jp>,
6 * Nick Hibma <n_hibma@FreeBSD.org>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
31 * $NetBSD: umass.c,v 1.28 2000/04/02 23:46:53 augustss Exp $
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 $
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
50 * Ported to NetBSD by Lennart Augustsson <augustss@NetBSD.org>.
51 * Parts of the code written by Jason R. Thorpe <thorpej@shagadelic.org>.
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)
61 * Over these wire protocols it handles the following command protocols
63 * - UFI (floppy command set)
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.
71 * The source code below is marked and can be split into a number of pieces
74 * - probe/attach/detach
75 * - generic transfer routines
78 * - CBI_I (in addition to functions from CBI)
79 * - CAM (Common Access Method)
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
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
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).
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.
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>
113 #include <sys/module.h>
114 #include <sys/lock.h>
115 #include <sys/mutex.h>
116 #include <sys/condvar.h>
117 #include <sys/sysctl.h>
119 #include <sys/unistd.h>
120 #include <sys/callout.h>
121 #include <sys/malloc.h>
122 #include <sys/priv.h>
124 #include <dev/usb/usb.h>
125 #include <dev/usb/usbdi.h>
126 #include <dev/usb/usbdi_util.h>
129 #include <dev/usb/quirk/usb_quirk.h>
132 #include <cam/cam_ccb.h>
133 #include <cam/cam_sim.h>
134 #include <cam/cam_xpt_sim.h>
135 #include <cam/scsi/scsi_all.h>
136 #include <cam/scsi/scsi_da.h>
138 #include <cam/cam_periph.h>
140 #define UMASS_EXT_BUFFER
141 #ifdef UMASS_EXT_BUFFER
142 /* this enables loading of virtual buffers into DMA */
143 #define UMASS_USB_FLAGS .ext_buffer=1,
145 #define UMASS_USB_FLAGS
151 if (umass_debug & (m)) { x ; } \
154 #define DPRINTF(sc, m, fmt, ...) \
156 if (umass_debug & (m)) { \
157 printf("%s:%s: " fmt, \
158 (sc) ? (const char *)(sc)->sc_name : \
159 (const char *)"umassX", \
160 __FUNCTION__ ,## __VA_ARGS__); \
164 #define UDMASS_GEN 0x00010000 /* general */
165 #define UDMASS_SCSI 0x00020000 /* scsi */
166 #define UDMASS_UFI 0x00040000 /* ufi command set */
167 #define UDMASS_ATAPI 0x00080000 /* 8070i command set */
168 #define UDMASS_CMD (UDMASS_SCSI|UDMASS_UFI|UDMASS_ATAPI)
169 #define UDMASS_USB 0x00100000 /* USB general */
170 #define UDMASS_BBB 0x00200000 /* Bulk-Only transfers */
171 #define UDMASS_CBI 0x00400000 /* CBI transfers */
172 #define UDMASS_WIRE (UDMASS_BBB|UDMASS_CBI)
173 #define UDMASS_ALL 0xffff0000 /* all of the above */
174 static int umass_debug = 0;
176 SYSCTL_NODE(_hw_usb, OID_AUTO, umass, CTLFLAG_RW, 0, "USB umass");
177 SYSCTL_INT(_hw_usb_umass, OID_AUTO, debug, CTLFLAG_RW,
178 &umass_debug, 0, "umass debug level");
180 TUNABLE_INT("hw.usb.umass.debug", &umass_debug);
182 #define DIF(...) do { } while (0)
183 #define DPRINTF(...) do { } while (0)
186 #define UMASS_GONE ((struct umass_softc *)1)
188 #define UMASS_BULK_SIZE (1 << 17)
189 #define UMASS_CBI_DIAGNOSTIC_CMDLEN 12 /* bytes */
190 #define UMASS_MAX_CMDLEN MAX(12, CAM_MAX_CDBLEN) /* bytes */
192 /* USB transfer definitions */
194 #define UMASS_T_BBB_RESET1 0 /* Bulk-Only */
195 #define UMASS_T_BBB_RESET2 1
196 #define UMASS_T_BBB_RESET3 2
197 #define UMASS_T_BBB_COMMAND 3
198 #define UMASS_T_BBB_DATA_READ 4
199 #define UMASS_T_BBB_DATA_RD_CS 5
200 #define UMASS_T_BBB_DATA_WRITE 6
201 #define UMASS_T_BBB_DATA_WR_CS 7
202 #define UMASS_T_BBB_STATUS 8
203 #define UMASS_T_BBB_MAX 9
205 #define UMASS_T_CBI_RESET1 0 /* CBI */
206 #define UMASS_T_CBI_RESET2 1
207 #define UMASS_T_CBI_RESET3 2
208 #define UMASS_T_CBI_COMMAND 3
209 #define UMASS_T_CBI_DATA_READ 4
210 #define UMASS_T_CBI_DATA_RD_CS 5
211 #define UMASS_T_CBI_DATA_WRITE 6
212 #define UMASS_T_CBI_DATA_WR_CS 7
213 #define UMASS_T_CBI_STATUS 8
214 #define UMASS_T_CBI_RESET4 9
215 #define UMASS_T_CBI_MAX 10
217 #define UMASS_T_MAX MAX(UMASS_T_CBI_MAX, UMASS_T_BBB_MAX)
219 /* Generic definitions */
221 /* Direction for transfer */
227 #define DEVNAME "umass"
228 #define DEVNAME_SIM "umass-sim"
230 /* Approximate maximum transfer speeds (assumes 33% overhead). */
231 #define UMASS_FULL_TRANSFER_SPEED 1000
232 #define UMASS_HIGH_TRANSFER_SPEED 40000
233 #define UMASS_SUPER_TRANSFER_SPEED 400000
234 #define UMASS_FLOPPY_TRANSFER_SPEED 20
236 #define UMASS_TIMEOUT 5000 /* ms */
238 /* CAM specific definitions */
240 #define UMASS_SCSIID_MAX 1 /* maximum number of drives expected */
241 #define UMASS_SCSIID_HOST UMASS_SCSIID_MAX
243 /* Bulk-Only features */
245 #define UR_BBB_RESET 0xff /* Bulk-Only reset */
246 #define UR_BBB_GET_MAX_LUN 0xfe /* Get maximum lun */
248 /* Command Block Wrapper */
250 uDWord dCBWSignature;
251 #define CBWSIGNATURE 0x43425355
253 uDWord dCBWDataTransferLength;
255 #define CBWFLAGS_OUT 0x00
256 #define CBWFLAGS_IN 0x80
259 #define CBWCDBLENGTH 16
260 uByte CBWCDB[CBWCDBLENGTH];
261 } __packed umass_bbb_cbw_t;
263 #define UMASS_BBB_CBW_SIZE 31
265 /* Command Status Wrapper */
267 uDWord dCSWSignature;
268 #define CSWSIGNATURE 0x53425355
269 #define CSWSIGNATURE_IMAGINATION_DBX1 0x43425355
270 #define CSWSIGNATURE_OLYMPUS_C1 0x55425355
272 uDWord dCSWDataResidue;
274 #define CSWSTATUS_GOOD 0x0
275 #define CSWSTATUS_FAILED 0x1
276 #define CSWSTATUS_PHASE 0x2
277 } __packed umass_bbb_csw_t;
279 #define UMASS_BBB_CSW_SIZE 13
283 #define UR_CBI_ADSC 0x00
288 #define IDB_TYPE_CCI 0x00
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
301 } __packed umass_cbi_sbl_t;
303 struct umass_softc; /* see below */
305 typedef void (umass_callback_t)(struct umass_softc *sc, union ccb *ccb,
306 uint32_t residue, uint8_t status);
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 */
313 typedef uint8_t (umass_transform_t)(struct umass_softc *sc, uint8_t *cmd_ptr,
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 */
327 /* Device specific quirks */
328 #define NO_QUIRKS 0x0000
330 * The drive does not support Test Unit Ready. Convert to Start Unit
332 #define NO_TEST_UNIT_READY 0x0001
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
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
363 * Device reports number of sectors from READ_CAPACITY, not max
366 #define READ_CAPACITY_OFFBY1 0x2000
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
374 #define NO_SYNCHRONIZE_CACHE 0x4000
378 struct scsi_sense cam_scsi_sense;
379 struct scsi_test_unit_ready cam_scsi_test_unit_ready;
384 umass_callback_t *callback;
386 uint32_t data_len; /* bytes */
387 uint32_t data_rem; /* bytes */
388 uint32_t data_timeout; /* ms */
389 uint32_t actlen; /* bytes */
391 uint8_t cmd_data[UMASS_MAX_CMDLEN];
392 uint8_t cmd_len; /* bytes */
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 */
401 /* CBI specific variables for transfers in progress */
402 umass_cbi_sbl_t sbl; /* status block */
405 struct usb_device *sc_udev;
406 struct cam_sim *sc_sim; /* SCSI Interface Module */
407 struct usb_xfer *sc_xfer[UMASS_T_MAX];
410 * The command transform function is used to convert the SCSI
411 * commands into their derivatives, like UFI, ATAPI, and friends.
413 umass_transform_t *sc_transform;
416 uint32_t sc_quirks; /* they got it almost right */
417 uint32_t sc_proto; /* wire and cmd protocol */
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;
426 struct umass_probe_proto {
435 static device_probe_t umass_probe;
436 static device_attach_t umass_attach;
437 static device_detach_t umass_detach;
439 static usb_callback_t umass_tr_error;
440 static usb_callback_t umass_t_bbb_reset1_callback;
441 static usb_callback_t umass_t_bbb_reset2_callback;
442 static usb_callback_t umass_t_bbb_reset3_callback;
443 static usb_callback_t umass_t_bbb_command_callback;
444 static usb_callback_t umass_t_bbb_data_read_callback;
445 static usb_callback_t umass_t_bbb_data_rd_cs_callback;
446 static usb_callback_t umass_t_bbb_data_write_callback;
447 static usb_callback_t umass_t_bbb_data_wr_cs_callback;
448 static usb_callback_t umass_t_bbb_status_callback;
449 static usb_callback_t umass_t_cbi_reset1_callback;
450 static usb_callback_t umass_t_cbi_reset2_callback;
451 static usb_callback_t umass_t_cbi_reset3_callback;
452 static usb_callback_t umass_t_cbi_reset4_callback;
453 static usb_callback_t umass_t_cbi_command_callback;
454 static usb_callback_t umass_t_cbi_data_read_callback;
455 static usb_callback_t umass_t_cbi_data_rd_cs_callback;
456 static usb_callback_t umass_t_cbi_data_write_callback;
457 static usb_callback_t umass_t_cbi_data_wr_cs_callback;
458 static usb_callback_t umass_t_cbi_status_callback;
460 static void umass_cancel_ccb(struct umass_softc *);
461 static void umass_init_shuttle(struct umass_softc *);
462 static void umass_reset(struct umass_softc *);
463 static void umass_t_bbb_data_clear_stall_callback(struct usb_xfer *,
464 uint8_t, uint8_t, usb_error_t);
465 static void umass_command_start(struct umass_softc *, uint8_t, void *,
466 uint32_t, uint32_t, umass_callback_t *, union ccb *);
467 static uint8_t umass_bbb_get_max_lun(struct umass_softc *);
468 static void umass_cbi_start_status(struct umass_softc *);
469 static void umass_t_cbi_data_clear_stall_callback(struct usb_xfer *,
470 uint8_t, uint8_t, usb_error_t);
471 static int umass_cam_attach_sim(struct umass_softc *);
472 static void umass_cam_attach(struct umass_softc *);
473 static void umass_cam_detach_sim(struct umass_softc *);
474 static void umass_cam_action(struct cam_sim *, union ccb *);
475 static void umass_cam_poll(struct cam_sim *);
476 static void umass_cam_cb(struct umass_softc *, union ccb *, uint32_t,
478 static void umass_cam_sense_cb(struct umass_softc *, union ccb *, uint32_t,
480 static void umass_cam_quirk_cb(struct umass_softc *, union ccb *, uint32_t,
482 static uint8_t umass_scsi_transform(struct umass_softc *, uint8_t *, uint8_t);
483 static uint8_t umass_rbc_transform(struct umass_softc *, uint8_t *, uint8_t);
484 static uint8_t umass_ufi_transform(struct umass_softc *, uint8_t *, uint8_t);
485 static uint8_t umass_atapi_transform(struct umass_softc *, uint8_t *,
487 static uint8_t umass_no_transform(struct umass_softc *, uint8_t *, uint8_t);
488 static uint8_t umass_std_transform(struct umass_softc *, union ccb *, uint8_t
492 static void umass_bbb_dump_cbw(struct umass_softc *, umass_bbb_cbw_t *);
493 static void umass_bbb_dump_csw(struct umass_softc *, umass_bbb_csw_t *);
494 static void umass_cbi_dump_cmd(struct umass_softc *, void *, uint8_t);
495 static void umass_dump_buffer(struct umass_softc *, uint8_t *, uint32_t,
499 static struct usb_config umass_bbb_config[UMASS_T_BBB_MAX] = {
501 [UMASS_T_BBB_RESET1] = {
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 */
511 [UMASS_T_BBB_RESET2] = {
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 */
521 [UMASS_T_BBB_RESET3] = {
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 */
531 [UMASS_T_BBB_COMMAND] = {
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 */
540 [UMASS_T_BBB_DATA_READ] = {
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 */
550 [UMASS_T_BBB_DATA_RD_CS] = {
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 */
559 [UMASS_T_BBB_DATA_WRITE] = {
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 */
569 [UMASS_T_BBB_DATA_WR_CS] = {
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 */
578 [UMASS_T_BBB_STATUS] = {
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 */
589 static struct usb_config umass_cbi_config[UMASS_T_CBI_MAX] = {
591 [UMASS_T_CBI_RESET1] = {
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 */
602 [UMASS_T_CBI_RESET2] = {
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 */
612 [UMASS_T_CBI_RESET3] = {
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 */
622 [UMASS_T_CBI_COMMAND] = {
624 .endpoint = 0x00, /* Control pipe */
625 .direction = UE_DIR_ANY,
626 .bufsize = (sizeof(struct usb_device_request) +
628 .callback = &umass_t_cbi_command_callback,
629 .timeout = 5000, /* 5 seconds */
632 [UMASS_T_CBI_DATA_READ] = {
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 */
642 [UMASS_T_CBI_DATA_RD_CS] = {
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 */
651 [UMASS_T_CBI_DATA_WRITE] = {
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 */
661 [UMASS_T_CBI_DATA_WR_CS] = {
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 */
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 */
680 [UMASS_T_CBI_RESET4] = {
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 */
690 /* If device cannot return valid inquiry data, fake it */
691 static 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
696 #define UFI_COMMAND_LENGTH 12 /* UFI commands are always 12 bytes */
697 #define ATAPI_COMMAND_LENGTH 12 /* ATAPI commands are always 12 bytes */
699 static devclass_t umass_devclass;
701 static 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),
709 static driver_t umass_driver = {
711 .methods = umass_methods,
712 .size = sizeof(struct umass_softc),
715 DRIVER_MODULE(umass, uhub, umass_driver, umass_devclass, NULL, 0);
716 MODULE_DEPEND(umass, usb, 1, 1, 1);
717 MODULE_DEPEND(umass, cam, 1, 1, 1);
718 MODULE_VERSION(umass, 1);
721 * USB device probe/attach/detach
724 static const STRUCT_USB_HOST_ID __used umass_devs[] = {
725 /* generic mass storage class */
726 {USB_IFACE_CLASS(UICLASS_MASS),},
730 umass_get_proto(struct usb_interface *iface)
732 struct usb_interface_descriptor *id;
737 /* Check for a standards compliant device */
738 id = usbd_get_interface_descriptor(iface);
740 (id->bInterfaceClass != UICLASS_MASS)) {
743 switch (id->bInterfaceSubClass) {
744 case UISUBCLASS_SCSI:
745 retval |= UMASS_PROTO_SCSI;
748 retval |= UMASS_PROTO_UFI;
751 retval |= UMASS_PROTO_RBC;
753 case UISUBCLASS_SFF8020I:
754 case UISUBCLASS_SFF8070I:
755 retval |= UMASS_PROTO_ATAPI;
761 switch (id->bInterfaceProtocol) {
762 case UIPROTO_MASS_CBI:
763 retval |= UMASS_PROTO_CBI;
765 case UIPROTO_MASS_CBI_I:
766 retval |= UMASS_PROTO_CBI_I;
768 case UIPROTO_MASS_BBB_OLD:
769 case UIPROTO_MASS_BBB:
770 retval |= UMASS_PROTO_BBB;
780 * Match the device we are seeing with the devices supported.
782 static struct umass_probe_proto
783 umass_probe_proto(device_t dev, struct usb_attach_arg *uaa)
785 struct umass_probe_proto ret;
786 uint32_t quirks = NO_QUIRKS;
787 uint32_t proto = umass_get_proto(uaa->iface);
789 memset(&ret, 0, sizeof(ret));
790 ret.error = BUS_PROBE_GENERIC;
792 /* Search for protocol enforcement */
794 if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_BBB)) {
795 proto &= ~UMASS_PROTO_WIRE;
796 proto |= UMASS_PROTO_BBB;
797 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_CBI)) {
798 proto &= ~UMASS_PROTO_WIRE;
799 proto |= UMASS_PROTO_CBI;
800 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_CBI_I)) {
801 proto &= ~UMASS_PROTO_WIRE;
802 proto |= UMASS_PROTO_CBI_I;
805 if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_SCSI)) {
806 proto &= ~UMASS_PROTO_COMMAND;
807 proto |= UMASS_PROTO_SCSI;
808 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_ATAPI)) {
809 proto &= ~UMASS_PROTO_COMMAND;
810 proto |= UMASS_PROTO_ATAPI;
811 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_UFI)) {
812 proto &= ~UMASS_PROTO_COMMAND;
813 proto |= UMASS_PROTO_UFI;
814 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_RBC)) {
815 proto &= ~UMASS_PROTO_COMMAND;
816 proto |= UMASS_PROTO_RBC;
819 /* Check if the protocol is invalid */
821 if ((proto & UMASS_PROTO_COMMAND) == 0) {
826 if ((proto & UMASS_PROTO_WIRE) == 0) {
831 /* Search for quirks */
833 if (usb_test_quirk(uaa, UQ_MSC_NO_TEST_UNIT_READY))
834 quirks |= NO_TEST_UNIT_READY;
835 if (usb_test_quirk(uaa, UQ_MSC_NO_RS_CLEAR_UA))
836 quirks |= RS_NO_CLEAR_UA;
837 if (usb_test_quirk(uaa, UQ_MSC_NO_START_STOP))
838 quirks |= NO_START_STOP;
839 if (usb_test_quirk(uaa, UQ_MSC_NO_GETMAXLUN))
840 quirks |= NO_GETMAXLUN;
841 if (usb_test_quirk(uaa, UQ_MSC_NO_INQUIRY))
842 quirks |= NO_INQUIRY;
843 if (usb_test_quirk(uaa, UQ_MSC_NO_INQUIRY_EVPD))
844 quirks |= NO_INQUIRY_EVPD;
845 if (usb_test_quirk(uaa, UQ_MSC_NO_SYNC_CACHE))
846 quirks |= NO_SYNCHRONIZE_CACHE;
847 if (usb_test_quirk(uaa, UQ_MSC_SHUTTLE_INIT))
848 quirks |= SHUTTLE_INIT;
849 if (usb_test_quirk(uaa, UQ_MSC_ALT_IFACE_1))
850 quirks |= ALT_IFACE_1;
851 if (usb_test_quirk(uaa, UQ_MSC_FLOPPY_SPEED))
852 quirks |= FLOPPY_SPEED;
853 if (usb_test_quirk(uaa, UQ_MSC_IGNORE_RESIDUE))
854 quirks |= IGNORE_RESIDUE;
855 if (usb_test_quirk(uaa, UQ_MSC_WRONG_CSWSIG))
856 quirks |= WRONG_CSWSIG;
857 if (usb_test_quirk(uaa, UQ_MSC_RBC_PAD_TO_12))
858 quirks |= RBC_PAD_TO_12;
859 if (usb_test_quirk(uaa, UQ_MSC_READ_CAP_OFFBY1))
860 quirks |= READ_CAPACITY_OFFBY1;
861 if (usb_test_quirk(uaa, UQ_MSC_FORCE_SHORT_INQ))
862 quirks |= FORCE_SHORT_INQUIRY;
871 umass_probe(device_t dev)
873 struct usb_attach_arg *uaa = device_get_ivars(dev);
874 struct umass_probe_proto temp;
876 if (uaa->usb_mode != USB_MODE_HOST) {
879 temp = umass_probe_proto(dev, uaa);
885 umass_attach(device_t dev)
887 struct umass_softc *sc = device_get_softc(dev);
888 struct usb_attach_arg *uaa = device_get_ivars(dev);
889 struct umass_probe_proto temp = umass_probe_proto(dev, uaa);
890 struct usb_interface_descriptor *id;
894 * NOTE: the softc struct is bzero-ed in device_set_driver.
895 * We can safely call umass_detach without specifically
896 * initializing the struct.
900 sc->sc_udev = uaa->device;
901 sc->sc_proto = temp.proto;
902 sc->sc_quirks = temp.quirks;
903 sc->sc_unit = device_get_unit(dev);
905 snprintf(sc->sc_name, sizeof(sc->sc_name),
906 "%s", device_get_nameunit(dev));
908 device_set_usb_desc(dev);
910 mtx_init(&sc->sc_mtx, device_get_nameunit(dev),
911 NULL, MTX_DEF | MTX_RECURSE);
913 /* get interface index */
915 id = usbd_get_interface_descriptor(uaa->iface);
917 device_printf(dev, "failed to get "
918 "interface number\n");
921 sc->sc_iface_no = id->bInterfaceNumber;
924 device_printf(dev, " ");
926 switch (sc->sc_proto & UMASS_PROTO_COMMAND) {
927 case UMASS_PROTO_SCSI:
930 case UMASS_PROTO_ATAPI:
931 printf("8070i (ATAPI)");
933 case UMASS_PROTO_UFI:
936 case UMASS_PROTO_RBC:
940 printf("(unknown 0x%02x)",
941 sc->sc_proto & UMASS_PROTO_COMMAND);
947 switch (sc->sc_proto & UMASS_PROTO_WIRE) {
948 case UMASS_PROTO_BBB:
951 case UMASS_PROTO_CBI: /* uses Comand/Bulk pipes */
954 case UMASS_PROTO_CBI_I: /* uses Comand/Bulk/Interrupt pipes */
955 printf("CBI with CCI");
958 printf("(unknown 0x%02x)",
959 sc->sc_proto & UMASS_PROTO_WIRE);
962 printf("; quirks = 0x%04x\n", sc->sc_quirks);
965 if (sc->sc_quirks & ALT_IFACE_1) {
966 err = usbd_set_alt_interface_index
967 (uaa->device, uaa->info.bIfaceIndex, 1);
970 DPRINTF(sc, UDMASS_USB, "could not switch to "
971 "Alt Interface 1\n");
975 /* allocate all required USB transfers */
977 if (sc->sc_proto & UMASS_PROTO_BBB) {
979 err = usbd_transfer_setup(uaa->device,
980 &uaa->info.bIfaceIndex, sc->sc_xfer, umass_bbb_config,
981 UMASS_T_BBB_MAX, sc, &sc->sc_mtx);
983 /* skip reset first time */
984 sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND;
986 } else if (sc->sc_proto & (UMASS_PROTO_CBI | UMASS_PROTO_CBI_I)) {
988 err = usbd_transfer_setup(uaa->device,
989 &uaa->info.bIfaceIndex, sc->sc_xfer, umass_cbi_config,
990 UMASS_T_CBI_MAX, sc, &sc->sc_mtx);
992 /* skip reset first time */
993 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND;
1000 device_printf(dev, "could not setup required "
1001 "transfers, %s\n", usbd_errstr(err));
1005 (sc->sc_proto & UMASS_PROTO_SCSI) ? &umass_scsi_transform :
1006 (sc->sc_proto & UMASS_PROTO_UFI) ? &umass_ufi_transform :
1007 (sc->sc_proto & UMASS_PROTO_ATAPI) ? &umass_atapi_transform :
1008 (sc->sc_proto & UMASS_PROTO_RBC) ? &umass_rbc_transform :
1009 &umass_no_transform;
1011 /* from here onwards the device can be used. */
1013 if (sc->sc_quirks & SHUTTLE_INIT) {
1014 umass_init_shuttle(sc);
1016 /* get the maximum LUN supported by the device */
1018 if (((sc->sc_proto & UMASS_PROTO_WIRE) == UMASS_PROTO_BBB) &&
1019 !(sc->sc_quirks & NO_GETMAXLUN))
1020 sc->sc_maxlun = umass_bbb_get_max_lun(sc);
1024 /* Prepare the SCSI command block */
1025 sc->cam_scsi_sense.opcode = REQUEST_SENSE;
1026 sc->cam_scsi_test_unit_ready.opcode = TEST_UNIT_READY;
1028 /* register the SIM */
1029 err = umass_cam_attach_sim(sc);
1034 umass_cam_attach(sc);
1036 DPRINTF(sc, UDMASS_GEN, "Attach finished\n");
1038 return (0); /* success */
1042 return (ENXIO); /* failure */
1046 umass_detach(device_t dev)
1048 struct umass_softc *sc = device_get_softc(dev);
1050 DPRINTF(sc, UDMASS_USB, "\n");
1052 /* teardown our statemachine */
1054 usbd_transfer_unsetup(sc->sc_xfer, UMASS_T_MAX);
1056 #if (__FreeBSD_version >= 700037)
1057 mtx_lock(&sc->sc_mtx);
1059 umass_cam_detach_sim(sc);
1061 #if (__FreeBSD_version >= 700037)
1062 mtx_unlock(&sc->sc_mtx);
1064 mtx_destroy(&sc->sc_mtx);
1066 return (0); /* success */
1070 umass_init_shuttle(struct umass_softc *sc)
1072 struct usb_device_request req;
1074 uint8_t status[2] = {0, 0};
1077 * The Linux driver does this, but no one can tell us what the
1080 req.bmRequestType = UT_READ_VENDOR_DEVICE;
1081 req.bRequest = 1; /* XXX unknown command */
1082 USETW(req.wValue, 0);
1083 req.wIndex[0] = sc->sc_iface_no;
1085 USETW(req.wLength, sizeof(status));
1086 err = usbd_do_request(sc->sc_udev, NULL, &req, &status);
1088 DPRINTF(sc, UDMASS_GEN, "Shuttle init returned 0x%02x%02x\n",
1089 status[0], status[1]);
1093 * Generic functions to handle transfers
1097 umass_transfer_start(struct umass_softc *sc, uint8_t xfer_index)
1099 DPRINTF(sc, UDMASS_GEN, "transfer index = "
1100 "%d\n", xfer_index);
1102 if (sc->sc_xfer[xfer_index]) {
1103 sc->sc_last_xfer_index = xfer_index;
1104 usbd_transfer_start(sc->sc_xfer[xfer_index]);
1106 umass_cancel_ccb(sc);
1111 umass_reset(struct umass_softc *sc)
1113 DPRINTF(sc, UDMASS_GEN, "resetting device\n");
1116 * stop the last transfer, if not already stopped:
1118 usbd_transfer_stop(sc->sc_xfer[sc->sc_last_xfer_index]);
1119 umass_transfer_start(sc, 0);
1123 umass_cancel_ccb(struct umass_softc *sc)
1127 mtx_assert(&sc->sc_mtx, MA_OWNED);
1129 ccb = sc->sc_transfer.ccb;
1130 sc->sc_transfer.ccb = NULL;
1131 sc->sc_last_xfer_index = 0;
1134 (sc->sc_transfer.callback)
1135 (sc, ccb, (sc->sc_transfer.data_len -
1136 sc->sc_transfer.actlen), STATUS_WIRE_FAILED);
1141 umass_tr_error(struct usb_xfer *xfer, usb_error_t error)
1143 struct umass_softc *sc = usbd_xfer_softc(xfer);
1145 if (error != USB_ERR_CANCELLED) {
1147 DPRINTF(sc, UDMASS_GEN, "transfer error, %s -> "
1148 "reset\n", usbd_errstr(error));
1150 umass_cancel_ccb(sc);
1154 * BBB protocol specific functions
1158 umass_t_bbb_reset1_callback(struct usb_xfer *xfer, usb_error_t error)
1160 struct umass_softc *sc = usbd_xfer_softc(xfer);
1161 struct usb_device_request req;
1162 struct usb_page_cache *pc;
1164 switch (USB_GET_STATE(xfer)) {
1165 case USB_ST_TRANSFERRED:
1166 umass_transfer_start(sc, UMASS_T_BBB_RESET2);
1171 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
1173 * For Reset Recovery the host shall issue in the following order:
1174 * a) a Bulk-Only Mass Storage Reset
1175 * b) a Clear Feature HALT to the Bulk-In endpoint
1176 * c) a Clear Feature HALT to the Bulk-Out endpoint
1178 * This is done in 3 steps, using 3 transfers:
1179 * UMASS_T_BBB_RESET1
1180 * UMASS_T_BBB_RESET2
1181 * UMASS_T_BBB_RESET3
1184 DPRINTF(sc, UDMASS_BBB, "BBB reset!\n");
1186 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1187 req.bRequest = UR_BBB_RESET; /* bulk only reset */
1188 USETW(req.wValue, 0);
1189 req.wIndex[0] = sc->sc_iface_no;
1191 USETW(req.wLength, 0);
1193 pc = usbd_xfer_get_frame(xfer, 0);
1194 usbd_copy_in(pc, 0, &req, sizeof(req));
1196 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1197 usbd_xfer_set_frames(xfer, 1);
1198 usbd_transfer_submit(xfer);
1201 default: /* Error */
1202 umass_tr_error(xfer, error);
1209 umass_t_bbb_reset2_callback(struct usb_xfer *xfer, usb_error_t error)
1211 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_RESET3,
1212 UMASS_T_BBB_DATA_READ, error);
1216 umass_t_bbb_reset3_callback(struct usb_xfer *xfer, usb_error_t error)
1218 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_COMMAND,
1219 UMASS_T_BBB_DATA_WRITE, error);
1223 umass_t_bbb_data_clear_stall_callback(struct usb_xfer *xfer,
1224 uint8_t next_xfer, uint8_t stall_xfer, usb_error_t error)
1226 struct umass_softc *sc = usbd_xfer_softc(xfer);
1228 switch (USB_GET_STATE(xfer)) {
1229 case USB_ST_TRANSFERRED:
1231 umass_transfer_start(sc, next_xfer);
1235 if (usbd_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) {
1236 goto tr_transferred;
1240 default: /* Error */
1241 umass_tr_error(xfer, error);
1248 umass_t_bbb_command_callback(struct usb_xfer *xfer, usb_error_t error)
1250 struct umass_softc *sc = usbd_xfer_softc(xfer);
1251 union ccb *ccb = sc->sc_transfer.ccb;
1252 struct usb_page_cache *pc;
1255 switch (USB_GET_STATE(xfer)) {
1256 case USB_ST_TRANSFERRED:
1257 umass_transfer_start
1258 (sc, ((sc->sc_transfer.dir == DIR_IN) ? UMASS_T_BBB_DATA_READ :
1259 (sc->sc_transfer.dir == DIR_OUT) ? UMASS_T_BBB_DATA_WRITE :
1260 UMASS_T_BBB_STATUS));
1265 sc->sc_status_try = 0;
1270 * the initial value is not important,
1271 * as long as the values are unique:
1273 tag = UGETDW(sc->cbw.dCBWTag) + 1;
1275 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
1276 USETDW(sc->cbw.dCBWTag, tag);
1279 * dCBWDataTransferLength:
1280 * This field indicates the number of bytes of data that the host
1281 * intends to transfer on the IN or OUT Bulk endpoint(as indicated by
1282 * the Direction bit) during the execution of this command. If this
1283 * field is set to 0, the device will expect that no data will be
1284 * transferred IN or OUT during this command, regardless of the value
1285 * of the Direction bit defined in dCBWFlags.
1287 USETDW(sc->cbw.dCBWDataTransferLength, sc->sc_transfer.data_len);
1291 * The bits of the Flags field are defined as follows:
1293 * Bit 7 Direction - this bit shall be ignored if the
1294 * dCBWDataTransferLength field is zero.
1295 * 0 = data Out from host to device
1296 * 1 = data In from device to host
1298 sc->cbw.bCBWFlags = ((sc->sc_transfer.dir == DIR_IN) ?
1299 CBWFLAGS_IN : CBWFLAGS_OUT);
1300 sc->cbw.bCBWLUN = sc->sc_transfer.lun;
1302 if (sc->sc_transfer.cmd_len > sizeof(sc->cbw.CBWCDB)) {
1303 sc->sc_transfer.cmd_len = sizeof(sc->cbw.CBWCDB);
1304 DPRINTF(sc, UDMASS_BBB, "Truncating long command!\n");
1306 sc->cbw.bCDBLength = sc->sc_transfer.cmd_len;
1308 bcopy(sc->sc_transfer.cmd_data, sc->cbw.CBWCDB,
1309 sc->sc_transfer.cmd_len);
1311 bzero(sc->sc_transfer.cmd_data + sc->sc_transfer.cmd_len,
1312 sizeof(sc->cbw.CBWCDB) - sc->sc_transfer.cmd_len);
1314 DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw));
1316 pc = usbd_xfer_get_frame(xfer, 0);
1317 usbd_copy_in(pc, 0, &sc->cbw, sizeof(sc->cbw));
1318 usbd_xfer_set_frame_len(xfer, 0, sizeof(sc->cbw));
1320 usbd_transfer_submit(xfer);
1324 default: /* Error */
1325 umass_tr_error(xfer, error);
1332 umass_t_bbb_data_read_callback(struct usb_xfer *xfer, usb_error_t error)
1334 struct umass_softc *sc = usbd_xfer_softc(xfer);
1335 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1336 #ifndef UMASS_EXT_BUFFER
1337 struct usb_page_cache *pc;
1341 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1343 switch (USB_GET_STATE(xfer)) {
1344 case USB_ST_TRANSFERRED:
1345 #ifndef UMASS_EXT_BUFFER
1346 pc = usbd_xfer_get_frame(xfer, 0);
1347 usbd_copy_out(pc, 0, sc->sc_transfer.data_ptr, actlen);
1349 sc->sc_transfer.data_rem -= actlen;
1350 sc->sc_transfer.data_ptr += actlen;
1351 sc->sc_transfer.actlen += actlen;
1353 if (actlen < sumlen) {
1354 /* short transfer */
1355 sc->sc_transfer.data_rem = 0;
1358 DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n",
1359 max_bulk, sc->sc_transfer.data_rem);
1361 if (sc->sc_transfer.data_rem == 0) {
1362 umass_transfer_start(sc, UMASS_T_BBB_STATUS);
1365 if (max_bulk > sc->sc_transfer.data_rem) {
1366 max_bulk = sc->sc_transfer.data_rem;
1368 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout);
1370 #ifdef UMASS_EXT_BUFFER
1371 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr,
1374 usbd_xfer_set_frame_len(xfer, 0, max_bulk);
1376 usbd_transfer_submit(xfer);
1379 default: /* Error */
1380 if (error == USB_ERR_CANCELLED) {
1381 umass_tr_error(xfer, error);
1383 umass_transfer_start(sc, UMASS_T_BBB_DATA_RD_CS);
1391 umass_t_bbb_data_rd_cs_callback(struct usb_xfer *xfer, usb_error_t error)
1393 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_STATUS,
1394 UMASS_T_BBB_DATA_READ, error);
1398 umass_t_bbb_data_write_callback(struct usb_xfer *xfer, usb_error_t error)
1400 struct umass_softc *sc = usbd_xfer_softc(xfer);
1401 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1402 #ifndef UMASS_EXT_BUFFER
1403 struct usb_page_cache *pc;
1407 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1409 switch (USB_GET_STATE(xfer)) {
1410 case USB_ST_TRANSFERRED:
1411 sc->sc_transfer.data_rem -= actlen;
1412 sc->sc_transfer.data_ptr += actlen;
1413 sc->sc_transfer.actlen += actlen;
1415 if (actlen < sumlen) {
1416 /* short transfer */
1417 sc->sc_transfer.data_rem = 0;
1420 DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n",
1421 max_bulk, sc->sc_transfer.data_rem);
1423 if (sc->sc_transfer.data_rem == 0) {
1424 umass_transfer_start(sc, UMASS_T_BBB_STATUS);
1427 if (max_bulk > sc->sc_transfer.data_rem) {
1428 max_bulk = sc->sc_transfer.data_rem;
1430 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout);
1432 #ifdef UMASS_EXT_BUFFER
1433 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr,
1436 pc = usbd_xfer_get_frame(xfer, 0);
1437 usbd_copy_in(pc, 0, sc->sc_transfer.data_ptr, max_bulk);
1438 usbd_xfer_set_frame_len(xfer, 0, max_bulk);
1441 usbd_transfer_submit(xfer);
1444 default: /* Error */
1445 if (error == USB_ERR_CANCELLED) {
1446 umass_tr_error(xfer, error);
1448 umass_transfer_start(sc, UMASS_T_BBB_DATA_WR_CS);
1456 umass_t_bbb_data_wr_cs_callback(struct usb_xfer *xfer, usb_error_t error)
1458 umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_STATUS,
1459 UMASS_T_BBB_DATA_WRITE, error);
1463 umass_t_bbb_status_callback(struct usb_xfer *xfer, usb_error_t error)
1465 struct umass_softc *sc = usbd_xfer_softc(xfer);
1466 union ccb *ccb = sc->sc_transfer.ccb;
1467 struct usb_page_cache *pc;
1471 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1473 switch (USB_GET_STATE(xfer)) {
1474 case USB_ST_TRANSFERRED:
1477 * Do a full reset if there is something wrong with the CSW:
1479 sc->sc_status_try = 1;
1481 /* Zero missing parts of the CSW: */
1483 if (actlen < sizeof(sc->csw)) {
1484 bzero(&sc->csw, sizeof(sc->csw));
1486 pc = usbd_xfer_get_frame(xfer, 0);
1487 usbd_copy_out(pc, 0, &sc->csw, actlen);
1489 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw));
1491 residue = UGETDW(sc->csw.dCSWDataResidue);
1493 if ((!residue) || (sc->sc_quirks & IGNORE_RESIDUE)) {
1494 residue = (sc->sc_transfer.data_len -
1495 sc->sc_transfer.actlen);
1497 if (residue > sc->sc_transfer.data_len) {
1498 DPRINTF(sc, UDMASS_BBB, "truncating residue from %d "
1499 "to %d bytes\n", residue, sc->sc_transfer.data_len);
1500 residue = sc->sc_transfer.data_len;
1502 /* translate weird command-status signatures: */
1503 if (sc->sc_quirks & WRONG_CSWSIG) {
1505 uint32_t temp = UGETDW(sc->csw.dCSWSignature);
1507 if ((temp == CSWSIGNATURE_OLYMPUS_C1) ||
1508 (temp == CSWSIGNATURE_IMAGINATION_DBX1)) {
1509 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE);
1512 /* check CSW and handle eventual error */
1513 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) {
1514 DPRINTF(sc, UDMASS_BBB, "bad CSW signature 0x%08x != 0x%08x\n",
1515 UGETDW(sc->csw.dCSWSignature), CSWSIGNATURE);
1517 * Invalid CSW: Wrong signature or wrong tag might
1518 * indicate that we lost synchronization. Reset the
1522 } else if (UGETDW(sc->csw.dCSWTag) != UGETDW(sc->cbw.dCBWTag)) {
1523 DPRINTF(sc, UDMASS_BBB, "Invalid CSW: tag 0x%08x should be "
1524 "0x%08x\n", UGETDW(sc->csw.dCSWTag),
1525 UGETDW(sc->cbw.dCBWTag));
1527 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) {
1528 DPRINTF(sc, UDMASS_BBB, "Invalid CSW: status %d > %d\n",
1529 sc->csw.bCSWStatus, CSWSTATUS_PHASE);
1531 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) {
1532 DPRINTF(sc, UDMASS_BBB, "Phase error, residue = "
1535 } else if (sc->sc_transfer.actlen > sc->sc_transfer.data_len) {
1536 DPRINTF(sc, UDMASS_BBB, "Buffer overrun %d > %d\n",
1537 sc->sc_transfer.actlen, sc->sc_transfer.data_len);
1539 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) {
1540 DPRINTF(sc, UDMASS_BBB, "Command failed, residue = "
1543 sc->sc_transfer.ccb = NULL;
1545 sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND;
1547 (sc->sc_transfer.callback)
1548 (sc, ccb, residue, STATUS_CMD_FAILED);
1550 sc->sc_transfer.ccb = NULL;
1552 sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND;
1554 (sc->sc_transfer.callback)
1555 (sc, ccb, residue, STATUS_CMD_OK);
1560 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1561 usbd_transfer_submit(xfer);
1566 DPRINTF(sc, UDMASS_BBB, "Failed to read CSW: %s, try %d\n",
1567 usbd_errstr(error), sc->sc_status_try);
1569 if ((error == USB_ERR_CANCELLED) ||
1570 (sc->sc_status_try)) {
1571 umass_tr_error(xfer, error);
1573 sc->sc_status_try = 1;
1574 umass_transfer_start(sc, UMASS_T_BBB_DATA_RD_CS);
1582 umass_command_start(struct umass_softc *sc, uint8_t dir,
1583 void *data_ptr, uint32_t data_len,
1584 uint32_t data_timeout, umass_callback_t *callback,
1587 sc->sc_transfer.lun = ccb->ccb_h.target_lun;
1590 * NOTE: assumes that "sc->sc_transfer.cmd_data" and
1591 * "sc->sc_transfer.cmd_len" has been properly
1595 sc->sc_transfer.dir = data_len ? dir : DIR_NONE;
1596 sc->sc_transfer.data_ptr = data_ptr;
1597 sc->sc_transfer.data_len = data_len;
1598 sc->sc_transfer.data_rem = data_len;
1599 sc->sc_transfer.data_timeout = (data_timeout + UMASS_TIMEOUT);
1601 sc->sc_transfer.actlen = 0;
1602 sc->sc_transfer.callback = callback;
1603 sc->sc_transfer.ccb = ccb;
1605 if (sc->sc_xfer[sc->sc_last_xfer_index]) {
1606 usbd_transfer_start(sc->sc_xfer[sc->sc_last_xfer_index]);
1608 ccb->ccb_h.status = CAM_TID_INVALID;
1614 umass_bbb_get_max_lun(struct umass_softc *sc)
1616 struct usb_device_request req;
1620 /* The Get Max Lun command is a class-specific request. */
1621 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1622 req.bRequest = UR_BBB_GET_MAX_LUN;
1623 USETW(req.wValue, 0);
1624 req.wIndex[0] = sc->sc_iface_no;
1626 USETW(req.wLength, 1);
1628 err = usbd_do_request(sc->sc_udev, NULL, &req, &buf);
1632 /* Device doesn't support Get Max Lun request. */
1633 printf("%s: Get Max Lun not supported (%s)\n",
1634 sc->sc_name, usbd_errstr(err));
1640 * Command/Bulk/Interrupt (CBI) specific functions
1644 umass_cbi_start_status(struct umass_softc *sc)
1646 if (sc->sc_xfer[UMASS_T_CBI_STATUS]) {
1647 umass_transfer_start(sc, UMASS_T_CBI_STATUS);
1649 union ccb *ccb = sc->sc_transfer.ccb;
1651 sc->sc_transfer.ccb = NULL;
1653 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND;
1655 (sc->sc_transfer.callback)
1656 (sc, ccb, (sc->sc_transfer.data_len -
1657 sc->sc_transfer.actlen), STATUS_CMD_UNKNOWN);
1662 umass_t_cbi_reset1_callback(struct usb_xfer *xfer, usb_error_t error)
1664 struct umass_softc *sc = usbd_xfer_softc(xfer);
1665 struct usb_device_request req;
1666 struct usb_page_cache *pc;
1667 uint8_t buf[UMASS_CBI_DIAGNOSTIC_CMDLEN];
1671 switch (USB_GET_STATE(xfer)) {
1672 case USB_ST_TRANSFERRED:
1673 umass_transfer_start(sc, UMASS_T_CBI_RESET2);
1678 * Command Block Reset Protocol
1680 * First send a reset request to the device. Then clear
1681 * any possibly stalled bulk endpoints.
1683 * This is done in 3 steps, using 3 transfers:
1684 * UMASS_T_CBI_RESET1
1685 * UMASS_T_CBI_RESET2
1686 * UMASS_T_CBI_RESET3
1687 * UMASS_T_CBI_RESET4 (only if there is an interrupt endpoint)
1690 DPRINTF(sc, UDMASS_CBI, "CBI reset!\n");
1692 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1693 req.bRequest = UR_CBI_ADSC;
1694 USETW(req.wValue, 0);
1695 req.wIndex[0] = sc->sc_iface_no;
1697 USETW(req.wLength, UMASS_CBI_DIAGNOSTIC_CMDLEN);
1700 * The 0x1d code is the SEND DIAGNOSTIC command. To
1701 * distinguish between the two, the last 10 bytes of the CBL
1702 * is filled with 0xff (section 2.2 of the CBI
1705 buf[0] = 0x1d; /* Command Block Reset */
1708 for (i = 2; i < UMASS_CBI_DIAGNOSTIC_CMDLEN; i++) {
1712 pc = usbd_xfer_get_frame(xfer, 0);
1713 usbd_copy_in(pc, 0, &req, sizeof(req));
1714 pc = usbd_xfer_get_frame(xfer, 1);
1715 usbd_copy_in(pc, 0, buf, sizeof(buf));
1717 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1718 usbd_xfer_set_frame_len(xfer, 1, sizeof(buf));
1719 usbd_xfer_set_frames(xfer, 2);
1720 usbd_transfer_submit(xfer);
1723 default: /* Error */
1724 if (error == USB_ERR_CANCELLED)
1725 umass_tr_error(xfer, error);
1727 umass_transfer_start(sc, UMASS_T_CBI_RESET2);
1734 umass_t_cbi_reset2_callback(struct usb_xfer *xfer, usb_error_t error)
1736 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_RESET3,
1737 UMASS_T_CBI_DATA_READ, error);
1741 umass_t_cbi_reset3_callback(struct usb_xfer *xfer, usb_error_t error)
1743 struct umass_softc *sc = usbd_xfer_softc(xfer);
1745 umass_t_cbi_data_clear_stall_callback
1746 (xfer, (sc->sc_xfer[UMASS_T_CBI_RESET4] &&
1747 sc->sc_xfer[UMASS_T_CBI_STATUS]) ?
1748 UMASS_T_CBI_RESET4 : UMASS_T_CBI_COMMAND,
1749 UMASS_T_CBI_DATA_WRITE, error);
1753 umass_t_cbi_reset4_callback(struct usb_xfer *xfer, usb_error_t error)
1755 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_COMMAND,
1756 UMASS_T_CBI_STATUS, error);
1760 umass_t_cbi_data_clear_stall_callback(struct usb_xfer *xfer,
1761 uint8_t next_xfer, uint8_t stall_xfer, usb_error_t error)
1763 struct umass_softc *sc = usbd_xfer_softc(xfer);
1765 switch (USB_GET_STATE(xfer)) {
1766 case USB_ST_TRANSFERRED:
1768 if (next_xfer == UMASS_T_CBI_STATUS) {
1769 umass_cbi_start_status(sc);
1771 umass_transfer_start(sc, next_xfer);
1776 if (usbd_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) {
1777 goto tr_transferred; /* should not happen */
1781 default: /* Error */
1782 umass_tr_error(xfer, error);
1789 umass_t_cbi_command_callback(struct usb_xfer *xfer, usb_error_t error)
1791 struct umass_softc *sc = usbd_xfer_softc(xfer);
1792 union ccb *ccb = sc->sc_transfer.ccb;
1793 struct usb_device_request req;
1794 struct usb_page_cache *pc;
1796 switch (USB_GET_STATE(xfer)) {
1797 case USB_ST_TRANSFERRED:
1799 if (sc->sc_transfer.dir == DIR_NONE) {
1800 umass_cbi_start_status(sc);
1802 umass_transfer_start
1803 (sc, (sc->sc_transfer.dir == DIR_IN) ?
1804 UMASS_T_CBI_DATA_READ : UMASS_T_CBI_DATA_WRITE);
1813 * do a CBI transfer with cmd_len bytes from
1814 * cmd_data, possibly a data phase of data_len
1815 * bytes from/to the device and finally a status
1819 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1820 req.bRequest = UR_CBI_ADSC;
1821 USETW(req.wValue, 0);
1822 req.wIndex[0] = sc->sc_iface_no;
1824 req.wLength[0] = sc->sc_transfer.cmd_len;
1827 pc = usbd_xfer_get_frame(xfer, 0);
1828 usbd_copy_in(pc, 0, &req, sizeof(req));
1829 pc = usbd_xfer_get_frame(xfer, 1);
1830 usbd_copy_in(pc, 0, sc->sc_transfer.cmd_data,
1831 sc->sc_transfer.cmd_len);
1833 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1834 usbd_xfer_set_frame_len(xfer, 1, sc->sc_transfer.cmd_len);
1835 usbd_xfer_set_frames(xfer,
1836 sc->sc_transfer.cmd_len ? 2 : 1);
1839 umass_cbi_dump_cmd(sc,
1840 sc->sc_transfer.cmd_data,
1841 sc->sc_transfer.cmd_len));
1843 usbd_transfer_submit(xfer);
1847 default: /* Error */
1849 * STALL on the control pipe can be result of the command error.
1850 * Attempt to clear this STALL same as for bulk pipe also
1851 * results in command completion interrupt, but ASC/ASCQ there
1852 * look like not always valid, so don't bother about it.
1854 if ((error == USB_ERR_STALLED) ||
1855 (sc->sc_transfer.callback == &umass_cam_cb)) {
1856 sc->sc_transfer.ccb = NULL;
1857 (sc->sc_transfer.callback)
1858 (sc, ccb, sc->sc_transfer.data_len,
1859 STATUS_CMD_UNKNOWN);
1861 umass_tr_error(xfer, error);
1863 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND;
1870 umass_t_cbi_data_read_callback(struct usb_xfer *xfer, usb_error_t error)
1872 struct umass_softc *sc = usbd_xfer_softc(xfer);
1873 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1874 #ifndef UMASS_EXT_BUFFER
1875 struct usb_page_cache *pc;
1879 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1881 switch (USB_GET_STATE(xfer)) {
1882 case USB_ST_TRANSFERRED:
1883 #ifndef UMASS_EXT_BUFFER
1884 pc = usbd_xfer_get_frame(xfer, 0);
1885 usbd_copy_out(pc, 0, sc->sc_transfer.data_ptr, actlen);
1887 sc->sc_transfer.data_rem -= actlen;
1888 sc->sc_transfer.data_ptr += actlen;
1889 sc->sc_transfer.actlen += actlen;
1891 if (actlen < sumlen) {
1892 /* short transfer */
1893 sc->sc_transfer.data_rem = 0;
1896 DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n",
1897 max_bulk, sc->sc_transfer.data_rem);
1899 if (sc->sc_transfer.data_rem == 0) {
1900 umass_cbi_start_status(sc);
1903 if (max_bulk > sc->sc_transfer.data_rem) {
1904 max_bulk = sc->sc_transfer.data_rem;
1906 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout);
1908 #ifdef UMASS_EXT_BUFFER
1909 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr,
1912 usbd_xfer_set_frame_len(xfer, 0, max_bulk);
1914 usbd_transfer_submit(xfer);
1917 default: /* Error */
1918 if ((error == USB_ERR_CANCELLED) ||
1919 (sc->sc_transfer.callback != &umass_cam_cb)) {
1920 umass_tr_error(xfer, error);
1922 umass_transfer_start(sc, UMASS_T_CBI_DATA_RD_CS);
1930 umass_t_cbi_data_rd_cs_callback(struct usb_xfer *xfer, usb_error_t error)
1932 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_STATUS,
1933 UMASS_T_CBI_DATA_READ, error);
1937 umass_t_cbi_data_write_callback(struct usb_xfer *xfer, usb_error_t error)
1939 struct umass_softc *sc = usbd_xfer_softc(xfer);
1940 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1941 #ifndef UMASS_EXT_BUFFER
1942 struct usb_page_cache *pc;
1946 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1948 switch (USB_GET_STATE(xfer)) {
1949 case USB_ST_TRANSFERRED:
1950 sc->sc_transfer.data_rem -= actlen;
1951 sc->sc_transfer.data_ptr += actlen;
1952 sc->sc_transfer.actlen += actlen;
1954 if (actlen < sumlen) {
1955 /* short transfer */
1956 sc->sc_transfer.data_rem = 0;
1959 DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n",
1960 max_bulk, sc->sc_transfer.data_rem);
1962 if (sc->sc_transfer.data_rem == 0) {
1963 umass_cbi_start_status(sc);
1966 if (max_bulk > sc->sc_transfer.data_rem) {
1967 max_bulk = sc->sc_transfer.data_rem;
1969 usbd_xfer_set_timeout(xfer, sc->sc_transfer.data_timeout);
1971 #ifdef UMASS_EXT_BUFFER
1972 usbd_xfer_set_frame_data(xfer, 0, sc->sc_transfer.data_ptr,
1975 pc = usbd_xfer_get_frame(xfer, 0);
1976 usbd_copy_in(pc, 0, sc->sc_transfer.data_ptr, max_bulk);
1977 usbd_xfer_set_frame_len(xfer, 0, max_bulk);
1980 usbd_transfer_submit(xfer);
1983 default: /* Error */
1984 if ((error == USB_ERR_CANCELLED) ||
1985 (sc->sc_transfer.callback != &umass_cam_cb)) {
1986 umass_tr_error(xfer, error);
1988 umass_transfer_start(sc, UMASS_T_CBI_DATA_WR_CS);
1996 umass_t_cbi_data_wr_cs_callback(struct usb_xfer *xfer, usb_error_t error)
1998 umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_STATUS,
1999 UMASS_T_CBI_DATA_WRITE, error);
2003 umass_t_cbi_status_callback(struct usb_xfer *xfer, usb_error_t error)
2005 struct umass_softc *sc = usbd_xfer_softc(xfer);
2006 union ccb *ccb = sc->sc_transfer.ccb;
2007 struct usb_page_cache *pc;
2012 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
2014 switch (USB_GET_STATE(xfer)) {
2015 case USB_ST_TRANSFERRED:
2017 if (actlen < sizeof(sc->sbl)) {
2020 pc = usbd_xfer_get_frame(xfer, 0);
2021 usbd_copy_out(pc, 0, &sc->sbl, sizeof(sc->sbl));
2023 residue = (sc->sc_transfer.data_len -
2024 sc->sc_transfer.actlen);
2026 /* dissect the information in the buffer */
2028 if (sc->sc_proto & UMASS_PROTO_UFI) {
2031 * Section 3.4.3.1.3 specifies that the UFI command
2032 * protocol returns an ASC and ASCQ in the interrupt
2036 DPRINTF(sc, UDMASS_CBI, "UFI CCI, ASC = 0x%02x, "
2037 "ASCQ = 0x%02x\n", sc->sbl.ufi.asc,
2040 status = (((sc->sbl.ufi.asc == 0) &&
2041 (sc->sbl.ufi.ascq == 0)) ?
2042 STATUS_CMD_OK : STATUS_CMD_FAILED);
2044 sc->sc_transfer.ccb = NULL;
2046 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND;
2048 (sc->sc_transfer.callback)
2049 (sc, ccb, residue, status);
2055 /* Command Interrupt Data Block */
2057 DPRINTF(sc, UDMASS_CBI, "type=0x%02x, value=0x%02x\n",
2058 sc->sbl.common.type, sc->sbl.common.value);
2060 if (sc->sbl.common.type == IDB_TYPE_CCI) {
2062 status = (sc->sbl.common.value & IDB_VALUE_STATUS_MASK);
2064 status = ((status == IDB_VALUE_PASS) ? STATUS_CMD_OK :
2065 (status == IDB_VALUE_FAIL) ? STATUS_CMD_FAILED :
2066 (status == IDB_VALUE_PERSISTENT) ? STATUS_CMD_FAILED :
2067 STATUS_WIRE_FAILED);
2069 sc->sc_transfer.ccb = NULL;
2071 sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND;
2073 (sc->sc_transfer.callback)
2074 (sc, ccb, residue, status);
2084 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
2085 usbd_transfer_submit(xfer);
2088 default: /* Error */
2089 DPRINTF(sc, UDMASS_CBI, "Failed to read CSW: %s\n",
2090 usbd_errstr(error));
2091 umass_tr_error(xfer, error);
2098 * CAM specific functions (used by SCSI, UFI, 8070i (ATAPI))
2102 umass_cam_attach_sim(struct umass_softc *sc)
2104 struct cam_devq *devq; /* Per device Queue */
2107 * A HBA is attached to the CAM layer.
2109 * The CAM layer will then after a while start probing for devices on
2110 * the bus. The number of SIMs is limited to one.
2113 devq = cam_simq_alloc(1 /* maximum openings */ );
2117 sc->sc_sim = cam_sim_alloc
2118 (&umass_cam_action, &umass_cam_poll,
2121 sc->sc_unit /* unit number */ ,
2122 #if (__FreeBSD_version >= 700037)
2123 &sc->sc_mtx /* mutex */ ,
2125 1 /* maximum device openings */ ,
2126 0 /* maximum tagged device openings */ ,
2129 if (sc->sc_sim == NULL) {
2130 cam_simq_free(devq);
2134 #if (__FreeBSD_version >= 700037)
2135 mtx_lock(&sc->sc_mtx);
2138 #if (__FreeBSD_version >= 700048)
2139 if (xpt_bus_register(sc->sc_sim, sc->sc_dev, sc->sc_unit) != CAM_SUCCESS) {
2140 mtx_unlock(&sc->sc_mtx);
2144 if (xpt_bus_register(sc->sc_sim, sc->sc_unit) != CAM_SUCCESS) {
2145 #if (__FreeBSD_version >= 700037)
2146 mtx_unlock(&sc->sc_mtx);
2152 #if (__FreeBSD_version >= 700037)
2153 mtx_unlock(&sc->sc_mtx);
2159 umass_cam_attach(struct umass_softc *sc)
2164 printf("%s:%d:%d:%d: Attached to scbus%d\n",
2165 sc->sc_name, cam_sim_path(sc->sc_sim),
2166 sc->sc_unit, CAM_LUN_WILDCARD,
2167 cam_sim_path(sc->sc_sim));
2171 * detach from the CAM layer
2175 umass_cam_detach_sim(struct umass_softc *sc)
2177 if (sc->sc_sim != NULL) {
2178 if (xpt_bus_deregister(cam_sim_path(sc->sc_sim))) {
2179 /* accessing the softc is not possible after this */
2180 sc->sc_sim->softc = UMASS_GONE;
2181 cam_sim_free(sc->sc_sim, /* free_devq */ TRUE);
2183 panic("%s: CAM layer is busy\n",
2191 * CAM requests for action come through here
2195 umass_cam_action(struct cam_sim *sim, union ccb *ccb)
2197 struct umass_softc *sc = (struct umass_softc *)sim->softc;
2199 if (sc == UMASS_GONE ||
2200 (sc != NULL && !usbd_device_attached(sc->sc_udev))) {
2201 ccb->ccb_h.status = CAM_SEL_TIMEOUT;
2206 #if (__FreeBSD_version < 700037)
2207 mtx_lock(&sc->sc_mtx);
2211 * Verify, depending on the operation to perform, that we either got
2212 * a valid sc, because an existing target was referenced, or
2213 * otherwise the SIM is addressed.
2215 * This avoids bombing out at a printf and does give the CAM layer some
2216 * sensible feedback on errors.
2218 switch (ccb->ccb_h.func_code) {
2221 case XPT_GET_TRAN_SETTINGS:
2222 case XPT_SET_TRAN_SETTINGS:
2223 case XPT_CALC_GEOMETRY:
2224 /* the opcodes requiring a target. These should never occur. */
2226 DPRINTF(sc, UDMASS_GEN, "%s:%d:%d:%d:func_code 0x%04x: "
2227 "Invalid target (target needed)\n",
2228 DEVNAME_SIM, cam_sim_path(sc->sc_sim),
2229 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2230 ccb->ccb_h.func_code);
2232 ccb->ccb_h.status = CAM_TID_INVALID;
2240 * The opcodes sometimes aimed at a target (sc is valid),
2241 * sometimes aimed at the SIM (sc is invalid and target is
2242 * CAM_TARGET_WILDCARD)
2245 (ccb->ccb_h.target_id != CAM_TARGET_WILDCARD)) {
2246 DPRINTF(sc, UDMASS_SCSI, "%s:%d:%d:%d:func_code 0x%04x: "
2247 "Invalid target (no wildcard)\n",
2248 DEVNAME_SIM, cam_sim_path(sc->sc_sim),
2249 ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
2250 ccb->ccb_h.func_code);
2252 ccb->ccb_h.status = CAM_TID_INVALID;
2258 /* XXX Hm, we should check the input parameters */
2262 /* Perform the requested action */
2263 switch (ccb->ccb_h.func_code) {
2269 if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) {
2270 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr);
2272 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes);
2275 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SCSI_IO: "
2276 "cmd: 0x%02x, flags: 0x%02x, "
2277 "%db cmd/%db data/%db sense\n",
2278 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2279 ccb->ccb_h.target_lun, cmd[0],
2280 ccb->ccb_h.flags & CAM_DIR_MASK, ccb->csio.cdb_len,
2281 ccb->csio.dxfer_len, ccb->csio.sense_len);
2283 if (sc->sc_transfer.ccb) {
2284 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SCSI_IO: "
2285 "I/O in progress, deferring\n",
2286 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2287 ccb->ccb_h.target_lun);
2288 ccb->ccb_h.status = CAM_SCSI_BUSY;
2292 switch (ccb->ccb_h.flags & CAM_DIR_MASK) {
2299 umass_dump_buffer(sc, ccb->csio.data_ptr,
2300 ccb->csio.dxfer_len, 48));
2306 ccb->ccb_h.status = CAM_REQ_INPROG | CAM_SIM_QUEUED;
2309 * sc->sc_transform will convert the command to the
2310 * command format needed by the specific command set
2311 * and return the converted command in
2312 * "sc->sc_transfer.cmd_data"
2314 if (umass_std_transform(sc, ccb, cmd, ccb->csio.cdb_len)) {
2316 if (sc->sc_transfer.cmd_data[0] == INQUIRY) {
2317 const char *pserial;
2319 pserial = usb_get_serial(sc->sc_udev);
2322 * Umass devices don't generally report their serial numbers
2323 * in the usual SCSI way. Emulate it here.
2325 if ((sc->sc_transfer.cmd_data[1] & SI_EVPD) &&
2326 (sc->sc_transfer.cmd_data[2] == SVPD_UNIT_SERIAL_NUMBER) &&
2327 (pserial[0] != '\0')) {
2328 struct scsi_vpd_unit_serial_number *vpd_serial;
2330 vpd_serial = (struct scsi_vpd_unit_serial_number *)ccb->csio.data_ptr;
2331 vpd_serial->length = strlen(pserial);
2332 if (vpd_serial->length > sizeof(vpd_serial->serial_num))
2333 vpd_serial->length = sizeof(vpd_serial->serial_num);
2334 memcpy(vpd_serial->serial_num, pserial, vpd_serial->length);
2335 ccb->csio.scsi_status = SCSI_STATUS_OK;
2336 ccb->ccb_h.status = CAM_REQ_CMP;
2342 * Handle EVPD inquiry for broken devices first
2343 * NO_INQUIRY also implies NO_INQUIRY_EVPD
2345 if ((sc->sc_quirks & (NO_INQUIRY_EVPD | NO_INQUIRY)) &&
2346 (sc->sc_transfer.cmd_data[1] & SI_EVPD)) {
2348 scsi_set_sense_data(&ccb->csio.sense_data,
2349 /*sense_format*/ SSD_TYPE_NONE,
2350 /*current_error*/ 1,
2351 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
2354 /*extra args*/ SSD_ELEM_NONE);
2355 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2356 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR |
2362 * Return fake inquiry data for
2365 if (sc->sc_quirks & NO_INQUIRY) {
2366 memcpy(ccb->csio.data_ptr, &fake_inq_data,
2367 sizeof(fake_inq_data));
2368 ccb->csio.scsi_status = SCSI_STATUS_OK;
2369 ccb->ccb_h.status = CAM_REQ_CMP;
2373 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) {
2374 ccb->csio.dxfer_len = SHORT_INQUIRY_LENGTH;
2376 } else if (sc->sc_transfer.cmd_data[0] == SYNCHRONIZE_CACHE) {
2377 if (sc->sc_quirks & NO_SYNCHRONIZE_CACHE) {
2378 ccb->csio.scsi_status = SCSI_STATUS_OK;
2379 ccb->ccb_h.status = CAM_REQ_CMP;
2384 umass_command_start(sc, dir, ccb->csio.data_ptr,
2385 ccb->csio.dxfer_len,
2387 &umass_cam_cb, ccb);
2393 struct ccb_pathinq *cpi = &ccb->cpi;
2395 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_PATH_INQ:.\n",
2396 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id,
2397 ccb->ccb_h.target_lun);
2399 /* host specific information */
2400 cpi->version_num = 1;
2401 cpi->hba_inquiry = 0;
2402 cpi->target_sprt = 0;
2403 cpi->hba_misc = PIM_NO_6_BYTE;
2404 cpi->hba_eng_cnt = 0;
2405 cpi->max_target = UMASS_SCSIID_MAX; /* one target */
2406 cpi->initiator_id = UMASS_SCSIID_HOST;
2407 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2408 strlcpy(cpi->hba_vid, "USB SCSI", HBA_IDLEN);
2409 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2410 cpi->unit_number = cam_sim_unit(sim);
2411 cpi->bus_id = sc->sc_unit;
2412 #if (__FreeBSD_version >= 700025)
2413 cpi->protocol = PROTO_SCSI;
2414 cpi->protocol_version = SCSI_REV_2;
2415 cpi->transport = XPORT_USB;
2416 cpi->transport_version = 0;
2419 cpi->base_transfer_speed = 0;
2422 if (sc->sc_quirks & FLOPPY_SPEED) {
2423 cpi->base_transfer_speed =
2424 UMASS_FLOPPY_TRANSFER_SPEED;
2426 switch (usbd_get_speed(sc->sc_udev)) {
2427 case USB_SPEED_SUPER:
2428 cpi->base_transfer_speed =
2429 UMASS_SUPER_TRANSFER_SPEED;
2430 cpi->maxio = MAXPHYS;
2432 case USB_SPEED_HIGH:
2433 cpi->base_transfer_speed =
2434 UMASS_HIGH_TRANSFER_SPEED;
2437 cpi->base_transfer_speed =
2438 UMASS_FULL_TRANSFER_SPEED;
2442 cpi->max_lun = sc->sc_maxlun;
2445 cpi->ccb_h.status = CAM_REQ_CMP;
2451 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_RESET_DEV:.\n",
2452 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2453 ccb->ccb_h.target_lun);
2457 ccb->ccb_h.status = CAM_REQ_CMP;
2461 case XPT_GET_TRAN_SETTINGS:
2463 struct ccb_trans_settings *cts = &ccb->cts;
2465 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_GET_TRAN_SETTINGS:.\n",
2466 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2467 ccb->ccb_h.target_lun);
2469 #if (__FreeBSD_version >= 700025)
2470 cts->protocol = PROTO_SCSI;
2471 cts->protocol_version = SCSI_REV_2;
2472 cts->transport = XPORT_USB;
2473 cts->transport_version = 0;
2474 cts->xport_specific.valid = 0;
2477 cts->flags = 0; /* no disconnection, tagging */
2479 ccb->ccb_h.status = CAM_REQ_CMP;
2483 case XPT_SET_TRAN_SETTINGS:
2485 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SET_TRAN_SETTINGS:.\n",
2486 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2487 ccb->ccb_h.target_lun);
2489 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2493 case XPT_CALC_GEOMETRY:
2495 cam_calc_geometry(&ccb->ccg, /* extended */ 1);
2501 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_NOOP:.\n",
2502 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id,
2503 ccb->ccb_h.target_lun);
2505 ccb->ccb_h.status = CAM_REQ_CMP;
2510 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:func_code 0x%04x: "
2511 "Not implemented\n",
2512 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id,
2513 ccb->ccb_h.target_lun, ccb->ccb_h.func_code);
2515 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2521 #if (__FreeBSD_version < 700037)
2523 mtx_unlock(&sc->sc_mtx);
2530 umass_cam_poll(struct cam_sim *sim)
2532 struct umass_softc *sc = (struct umass_softc *)sim->softc;
2534 if (sc == UMASS_GONE)
2537 DPRINTF(sc, UDMASS_SCSI, "CAM poll\n");
2539 usbd_transfer_poll(sc->sc_xfer, UMASS_T_MAX);
2544 * finalise a completed CAM command
2548 umass_cam_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue,
2551 ccb->csio.resid = residue;
2555 ccb->ccb_h.status = CAM_REQ_CMP;
2556 if ((sc->sc_quirks & READ_CAPACITY_OFFBY1) &&
2557 (ccb->ccb_h.func_code == XPT_SCSI_IO) &&
2558 (ccb->csio.cdb_io.cdb_bytes[0] == READ_CAPACITY)) {
2559 struct scsi_read_capacity_data *rcap;
2562 rcap = (void *)(ccb->csio.data_ptr);
2563 maxsector = scsi_4btoul(rcap->addr) - 1;
2564 scsi_ulto4b(maxsector, rcap->addr);
2567 * We have to add SVPD_UNIT_SERIAL_NUMBER to the list
2568 * of pages supported by the device - otherwise, CAM
2569 * will never ask us for the serial number if the
2570 * device cannot handle that by itself.
2572 if (ccb->ccb_h.func_code == XPT_SCSI_IO &&
2573 sc->sc_transfer.cmd_data[0] == INQUIRY &&
2574 (sc->sc_transfer.cmd_data[1] & SI_EVPD) &&
2575 sc->sc_transfer.cmd_data[2] == SVPD_SUPPORTED_PAGE_LIST &&
2576 (usb_get_serial(sc->sc_udev)[0] != '\0')) {
2577 struct ccb_scsiio *csio;
2578 struct scsi_vpd_supported_page_list *page_list;
2581 page_list = (struct scsi_vpd_supported_page_list *)csio->data_ptr;
2582 if (page_list->length + 1 < SVPD_SUPPORTED_PAGES_SIZE) {
2583 page_list->list[page_list->length] = SVPD_UNIT_SERIAL_NUMBER;
2584 page_list->length++;
2590 case STATUS_CMD_UNKNOWN:
2591 case STATUS_CMD_FAILED:
2593 /* fetch sense data */
2595 /* the rest of the command was filled in at attach */
2596 sc->cam_scsi_sense.length = ccb->csio.sense_len;
2598 DPRINTF(sc, UDMASS_SCSI, "Fetching %d bytes of "
2599 "sense data\n", ccb->csio.sense_len);
2601 if (umass_std_transform(sc, ccb, &sc->cam_scsi_sense.opcode,
2602 sizeof(sc->cam_scsi_sense))) {
2604 if ((sc->sc_quirks & FORCE_SHORT_INQUIRY) &&
2605 (sc->sc_transfer.cmd_data[0] == INQUIRY)) {
2606 ccb->csio.sense_len = SHORT_INQUIRY_LENGTH;
2608 umass_command_start(sc, DIR_IN, &ccb->csio.sense_data.error_code,
2609 ccb->csio.sense_len, ccb->ccb_h.timeout,
2610 &umass_cam_sense_cb, ccb);
2616 * The wire protocol failed and will hopefully have
2617 * recovered. We return an error to CAM and let CAM
2618 * retry the command if necessary.
2620 ccb->ccb_h.status = CAM_REQ_CMP_ERR;
2627 * Finalise a completed autosense operation
2630 umass_cam_sense_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue,
2637 case STATUS_CMD_UNKNOWN:
2638 case STATUS_CMD_FAILED: {
2641 ccb->csio.sense_resid = residue;
2642 sense_len = ccb->csio.sense_len - ccb->csio.sense_resid;
2643 key = scsi_get_sense_key(&ccb->csio.sense_data, sense_len,
2646 if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) {
2647 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr);
2649 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes);
2653 * Getting sense data always succeeds (apart from wire
2656 if ((sc->sc_quirks & RS_NO_CLEAR_UA) &&
2657 (cmd[0] == INQUIRY) &&
2658 (key == SSD_KEY_UNIT_ATTENTION)) {
2660 * Ignore unit attention errors in the case where
2661 * the Unit Attention state is not cleared on
2662 * REQUEST SENSE. They will appear again at the next
2665 ccb->ccb_h.status = CAM_REQ_CMP;
2666 } else if (key == SSD_KEY_NO_SENSE) {
2668 * No problem after all (in the case of CBI without
2671 ccb->ccb_h.status = CAM_REQ_CMP;
2672 } else if ((sc->sc_quirks & RS_NO_CLEAR_UA) &&
2673 (cmd[0] == READ_CAPACITY) &&
2674 (key == SSD_KEY_UNIT_ATTENTION)) {
2676 * Some devices do not clear the unit attention error
2677 * on request sense. We insert a test unit ready
2678 * command to make sure we clear the unit attention
2679 * condition, then allow the retry to proceed as
2683 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2684 | CAM_AUTOSNS_VALID;
2685 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2690 DPRINTF(sc, UDMASS_SCSI, "Doing a sneaky"
2691 "TEST_UNIT_READY\n");
2693 /* the rest of the command was filled in at attach */
2695 if (umass_std_transform(sc, ccb,
2696 &sc->cam_scsi_test_unit_ready.opcode,
2697 sizeof(sc->cam_scsi_test_unit_ready))) {
2698 umass_command_start(sc, DIR_NONE, NULL, 0,
2700 &umass_cam_quirk_cb, ccb);
2704 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2705 | CAM_AUTOSNS_VALID;
2706 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2712 DPRINTF(sc, UDMASS_SCSI, "Autosense failed, "
2713 "status %d\n", status);
2714 ccb->ccb_h.status = CAM_AUTOSENSE_FAIL;
2720 * This completion code just handles the fact that we sent a test-unit-ready
2721 * after having previously failed a READ CAPACITY with CHECK_COND. Even
2722 * though this command succeeded, we have to tell CAM to retry.
2725 umass_cam_quirk_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue,
2728 DPRINTF(sc, UDMASS_SCSI, "Test unit ready "
2729 "returned status %d\n", status);
2731 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2732 | CAM_AUTOSNS_VALID;
2733 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2738 * SCSI specific functions
2742 umass_scsi_transform(struct umass_softc *sc, uint8_t *cmd_ptr,
2745 if ((cmd_len == 0) ||
2746 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2747 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2748 "length: %d bytes\n", cmd_len);
2749 return (0); /* failure */
2751 sc->sc_transfer.cmd_len = cmd_len;
2753 switch (cmd_ptr[0]) {
2754 case TEST_UNIT_READY:
2755 if (sc->sc_quirks & NO_TEST_UNIT_READY) {
2756 DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY "
2758 bzero(sc->sc_transfer.cmd_data, cmd_len);
2759 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT;
2760 sc->sc_transfer.cmd_data[4] = SSS_START;
2767 * some drives wedge when asked for full inquiry
2770 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) {
2771 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len);
2772 sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH;
2778 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len);
2783 umass_rbc_transform(struct umass_softc *sc, uint8_t *cmd_ptr, uint8_t cmd_len)
2785 if ((cmd_len == 0) ||
2786 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2787 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2788 "length: %d bytes\n", cmd_len);
2789 return (0); /* failure */
2791 switch (cmd_ptr[0]) {
2792 /* these commands are defined in RBC: */
2795 case START_STOP_UNIT:
2796 case SYNCHRONIZE_CACHE:
2798 case 0x2f: /* VERIFY_10 is absent from
2801 case MODE_SELECT_10:
2803 case TEST_UNIT_READY:
2806 * The following commands are not listed in my copy of the
2807 * RBC specs. CAM however seems to want those, and at least
2808 * the Sony DSC device appears to support those as well
2813 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len);
2815 if ((sc->sc_quirks & RBC_PAD_TO_12) && (cmd_len < 12)) {
2816 bzero(sc->sc_transfer.cmd_data + cmd_len, 12 - cmd_len);
2819 sc->sc_transfer.cmd_len = cmd_len;
2820 return (1); /* sucess */
2822 /* All other commands are not legal in RBC */
2824 DPRINTF(sc, UDMASS_SCSI, "Unsupported RBC "
2825 "command 0x%02x\n", cmd_ptr[0]);
2826 return (0); /* failure */
2831 umass_ufi_transform(struct umass_softc *sc, uint8_t *cmd_ptr,
2834 if ((cmd_len == 0) ||
2835 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2836 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2837 "length: %d bytes\n", cmd_len);
2838 return (0); /* failure */
2840 /* An UFI command is always 12 bytes in length */
2841 sc->sc_transfer.cmd_len = UFI_COMMAND_LENGTH;
2843 /* Zero the command data */
2844 bzero(sc->sc_transfer.cmd_data, UFI_COMMAND_LENGTH);
2846 switch (cmd_ptr[0]) {
2848 * Commands of which the format has been verified. They
2849 * should work. Copy the command into the (zeroed out)
2850 * destination buffer.
2852 case TEST_UNIT_READY:
2853 if (sc->sc_quirks & NO_TEST_UNIT_READY) {
2855 * Some devices do not support this command. Start
2856 * Stop Unit should give the same results
2858 DPRINTF(sc, UDMASS_UFI, "Converted TEST_UNIT_READY "
2861 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT;
2862 sc->sc_transfer.cmd_data[4] = SSS_START;
2871 case START_STOP_UNIT:
2872 case SEND_DIAGNOSTIC:
2877 case POSITION_TO_ELEMENT: /* SEEK_10 */
2878 case WRITE_AND_VERIFY:
2880 case MODE_SELECT_10:
2884 case READ_FORMAT_CAPACITIES:
2888 * SYNCHRONIZE_CACHE isn't supported by UFI, nor should it be
2889 * required for UFI devices, so it is appropriate to fake
2892 case SYNCHRONIZE_CACHE:
2896 DPRINTF(sc, UDMASS_SCSI, "Unsupported UFI "
2897 "command 0x%02x\n", cmd_ptr[0]);
2898 return (0); /* failure */
2901 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len);
2902 return (1); /* success */
2906 * 8070i (ATAPI) specific functions
2909 umass_atapi_transform(struct umass_softc *sc, uint8_t *cmd_ptr,
2912 if ((cmd_len == 0) ||
2913 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2914 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2915 "length: %d bytes\n", cmd_len);
2916 return (0); /* failure */
2918 /* An ATAPI command is always 12 bytes in length. */
2919 sc->sc_transfer.cmd_len = ATAPI_COMMAND_LENGTH;
2921 /* Zero the command data */
2922 bzero(sc->sc_transfer.cmd_data, ATAPI_COMMAND_LENGTH);
2924 switch (cmd_ptr[0]) {
2926 * Commands of which the format has been verified. They
2927 * should work. Copy the command into the destination
2932 * some drives wedge when asked for full inquiry
2935 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) {
2936 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len);
2938 sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH;
2943 case TEST_UNIT_READY:
2944 if (sc->sc_quirks & NO_TEST_UNIT_READY) {
2945 DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY "
2947 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT;
2948 sc->sc_transfer.cmd_data[4] = SSS_START;
2955 case START_STOP_UNIT:
2956 case SEND_DIAGNOSTIC:
2961 case POSITION_TO_ELEMENT: /* SEEK_10 */
2962 case SYNCHRONIZE_CACHE:
2963 case MODE_SELECT_10:
2966 case 0x42: /* READ_SUBCHANNEL */
2967 case 0x43: /* READ_TOC */
2968 case 0x44: /* READ_HEADER */
2969 case 0x47: /* PLAY_MSF (Play Minute/Second/Frame) */
2970 case 0x48: /* PLAY_TRACK */
2971 case 0x49: /* PLAY_TRACK_REL */
2972 case 0x4b: /* PAUSE */
2973 case 0x51: /* READ_DISK_INFO */
2974 case 0x52: /* READ_TRACK_INFO */
2975 case 0x54: /* SEND_OPC */
2976 case 0x59: /* READ_MASTER_CUE */
2977 case 0x5b: /* CLOSE_TR_SESSION */
2978 case 0x5c: /* READ_BUFFER_CAP */
2979 case 0x5d: /* SEND_CUE_SHEET */
2980 case 0xa1: /* BLANK */
2981 case 0xa5: /* PLAY_12 */
2982 case 0xa6: /* EXCHANGE_MEDIUM */
2983 case 0xad: /* READ_DVD_STRUCTURE */
2984 case 0xbb: /* SET_CD_SPEED */
2985 case 0xe5: /* READ_TRACK_INFO_PHILIPS */
2991 DPRINTF(sc, UDMASS_SCSI, "Unsupported ATAPI "
2992 "command 0x%02x - trying anyway\n",
2997 bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len);
2998 return (1); /* success */
3002 umass_no_transform(struct umass_softc *sc, uint8_t *cmd,
3005 return (0); /* failure */
3009 umass_std_transform(struct umass_softc *sc, union ccb *ccb,
3010 uint8_t *cmd, uint8_t cmdlen)
3014 retval = (sc->sc_transform) (sc, cmd, cmdlen);
3017 ccb->ccb_h.status = CAM_REQ_CMP;
3020 } else if (retval == 0) {
3021 ccb->ccb_h.status = CAM_REQ_INVALID;
3025 /* Command should be executed */
3031 umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw)
3033 uint8_t *c = cbw->CBWCDB;
3035 uint32_t dlen = UGETDW(cbw->dCBWDataTransferLength);
3036 uint32_t tag = UGETDW(cbw->dCBWTag);
3038 uint8_t clen = cbw->bCDBLength;
3039 uint8_t flags = cbw->bCBWFlags;
3040 uint8_t lun = cbw->bCBWLUN;
3042 DPRINTF(sc, UDMASS_BBB, "CBW %d: cmd = %db "
3043 "(0x%02x%02x%02x%02x%02x%02x%s), "
3044 "data = %db, lun = %d, dir = %s\n",
3046 c[0], c[1], c[2], c[3], c[4], c[5], (clen > 6 ? "..." : ""),
3047 dlen, lun, (flags == CBWFLAGS_IN ? "in" :
3048 (flags == CBWFLAGS_OUT ? "out" : "<invalid>")));
3052 umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw)
3054 uint32_t sig = UGETDW(csw->dCSWSignature);
3055 uint32_t tag = UGETDW(csw->dCSWTag);
3056 uint32_t res = UGETDW(csw->dCSWDataResidue);
3057 uint8_t status = csw->bCSWStatus;
3059 DPRINTF(sc, UDMASS_BBB, "CSW %d: sig = 0x%08x (%s), tag = 0x%08x, "
3060 "res = %d, status = 0x%02x (%s)\n",
3061 tag, sig, (sig == CSWSIGNATURE ? "valid" : "invalid"),
3063 status, (status == CSWSTATUS_GOOD ? "good" :
3064 (status == CSWSTATUS_FAILED ? "failed" :
3065 (status == CSWSTATUS_PHASE ? "phase" : "<invalid>"))));
3069 umass_cbi_dump_cmd(struct umass_softc *sc, void *cmd, uint8_t cmdlen)
3072 uint8_t dir = sc->sc_transfer.dir;
3074 DPRINTF(sc, UDMASS_BBB, "cmd = %db "
3075 "(0x%02x%02x%02x%02x%02x%02x%s), "
3076 "data = %db, dir = %s\n",
3078 c[0], c[1], c[2], c[3], c[4], c[5], (cmdlen > 6 ? "..." : ""),
3079 sc->sc_transfer.data_len,
3080 (dir == DIR_IN ? "in" :
3081 (dir == DIR_OUT ? "out" :
3082 (dir == DIR_NONE ? "no data phase" : "<invalid>"))));
3086 umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, uint32_t buflen,
3097 sprintf(s2, " buffer=%p, buflen=%d", buffer, buflen);
3098 for (i = 0; (i < buflen) && (i < printlen); i++) {
3100 if (j == 0 && i != 0) {
3101 DPRINTF(sc, UDMASS_GEN, "0x %s%s\n",
3105 sprintf(&s1[j * 2], "%02x", buffer[i] & 0xff);
3107 if (buflen > printlen)
3108 sprintf(s3, " ...");
3109 DPRINTF(sc, UDMASS_GEN, "0x %s%s%s\n",