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