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