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