3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * The following file contains code that will detect USB autoinstall
31 * TODO: Potentially we could add code to automatically detect USB
32 * mass storage quirks for not supported SCSI commands!
35 #include <sys/stdint.h>
36 #include <sys/stddef.h>
37 #include <sys/param.h>
38 #include <sys/queue.h>
39 #include <sys/types.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
43 #include <sys/module.h>
45 #include <sys/mutex.h>
46 #include <sys/condvar.h>
47 #include <sys/sysctl.h>
49 #include <sys/unistd.h>
50 #include <sys/callout.h>
51 #include <sys/malloc.h>
54 #include <dev/usb/usb.h>
55 #include <dev/usb/usbdi.h>
56 #include <dev/usb/usbdi_util.h>
58 #define USB_DEBUG_VAR usb_debug
60 #include <dev/usb/usb_busdma.h>
61 #include <dev/usb/usb_process.h>
62 #include <dev/usb/usb_transfer.h>
63 #include <dev/usb/usb_msctest.h>
64 #include <dev/usb/usb_debug.h>
65 #include <dev/usb/usb_busdma.h>
66 #include <dev/usb/usb_device.h>
67 #include <dev/usb/usb_request.h>
68 #include <dev/usb/usb_util.h>
69 #include <dev/usb/quirk/usb_quirk.h>
87 #define SCSI_INQ_LEN 0x24
88 static uint8_t scsi_test_unit_ready[] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
89 static uint8_t scsi_inquiry[] = { 0x12, 0x00, 0x00, 0x00, SCSI_INQ_LEN, 0x00 };
90 static uint8_t scsi_rezero_init[] = { 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 };
91 static uint8_t scsi_start_stop_unit[] = { 0x1b, 0x00, 0x00, 0x00, 0x02, 0x00 };
92 static uint8_t scsi_ztestor_eject[] = { 0x85, 0x01, 0x01, 0x01, 0x18, 0x01,
93 0x01, 0x01, 0x01, 0x01, 0x00, 0x00 };
94 static uint8_t scsi_cmotech_eject[] = { 0xff, 0x52, 0x44, 0x45, 0x56, 0x43,
96 static uint8_t scsi_huawei_eject[] = { 0x11, 0x06, 0x00, 0x00, 0x00, 0x00,
97 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
98 0x00, 0x00, 0x00, 0x00 };
99 static uint8_t scsi_tct_eject[] = { 0x06, 0xf5, 0x04, 0x02, 0x52, 0x70 };
101 #define BULK_SIZE 64 /* dummy */
102 #define ERR_CSW_FAILED -1
104 /* Command Block Wrapper */
106 uDWord dCBWSignature;
107 #define CBWSIGNATURE 0x43425355
109 uDWord dCBWDataTransferLength;
111 #define CBWFLAGS_OUT 0x00
112 #define CBWFLAGS_IN 0x80
115 #define CBWCDBLENGTH 16
116 uByte CBWCDB[CBWCDBLENGTH];
119 /* Command Status Wrapper */
121 uDWord dCSWSignature;
122 #define CSWSIGNATURE 0x53425355
124 uDWord dCSWDataResidue;
126 #define CSWSTATUS_GOOD 0x0
127 #define CSWSTATUS_FAILED 0x1
128 #define CSWSTATUS_PHASE 0x2
131 struct bbb_transfer {
137 struct usb_xfer *xfer[ST_MAX];
141 usb_size_t data_len; /* bytes */
142 usb_size_t data_rem; /* bytes */
143 usb_timeout_t data_timeout; /* ms */
144 usb_frlength_t actlen; /* bytes */
146 uint8_t cmd_len; /* bytes */
156 static usb_callback_t bbb_command_callback;
157 static usb_callback_t bbb_data_read_callback;
158 static usb_callback_t bbb_data_rd_cs_callback;
159 static usb_callback_t bbb_data_write_callback;
160 static usb_callback_t bbb_data_wr_cs_callback;
161 static usb_callback_t bbb_status_callback;
163 static void bbb_done(struct bbb_transfer *, int);
164 static void bbb_transfer_start(struct bbb_transfer *, uint8_t);
165 static void bbb_data_clear_stall_callback(struct usb_xfer *, uint8_t,
167 static uint8_t bbb_command_start(struct bbb_transfer *, uint8_t, uint8_t,
168 void *, size_t, void *, size_t, usb_timeout_t);
169 static struct bbb_transfer *bbb_attach(struct usb_device *, uint8_t);
170 static void bbb_detach(struct bbb_transfer *);
172 static const struct usb_config bbb_config[ST_MAX] = {
176 .endpoint = UE_ADDR_ANY,
177 .direction = UE_DIR_OUT,
178 .bufsize = sizeof(struct bbb_cbw),
179 .callback = &bbb_command_callback,
180 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
185 .endpoint = UE_ADDR_ANY,
186 .direction = UE_DIR_IN,
187 .bufsize = BULK_SIZE,
188 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1,},
189 .callback = &bbb_data_read_callback,
190 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
195 .endpoint = 0x00, /* Control pipe */
196 .direction = UE_DIR_ANY,
197 .bufsize = sizeof(struct usb_device_request),
198 .callback = &bbb_data_rd_cs_callback,
199 .timeout = 1 * USB_MS_HZ, /* 1 second */
204 .endpoint = UE_ADDR_ANY,
205 .direction = UE_DIR_OUT,
206 .bufsize = BULK_SIZE,
207 .flags = {.proxy_buffer = 1,},
208 .callback = &bbb_data_write_callback,
209 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
214 .endpoint = 0x00, /* Control pipe */
215 .direction = UE_DIR_ANY,
216 .bufsize = sizeof(struct usb_device_request),
217 .callback = &bbb_data_wr_cs_callback,
218 .timeout = 1 * USB_MS_HZ, /* 1 second */
223 .endpoint = UE_ADDR_ANY,
224 .direction = UE_DIR_IN,
225 .bufsize = sizeof(struct bbb_csw),
226 .flags = {.short_xfer_ok = 1,},
227 .callback = &bbb_status_callback,
228 .timeout = 1 * USB_MS_HZ, /* 1 second */
233 bbb_done(struct bbb_transfer *sc, int error)
237 sc->state = ST_COMMAND;
243 bbb_transfer_start(struct bbb_transfer *sc, uint8_t xfer_index)
245 sc->state = xfer_index;
246 usbd_transfer_start(sc->xfer[xfer_index]);
250 bbb_data_clear_stall_callback(struct usb_xfer *xfer,
251 uint8_t next_xfer, uint8_t stall_xfer)
253 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
255 if (usbd_clear_stall_callback(xfer, sc->xfer[stall_xfer])) {
256 switch (USB_GET_STATE(xfer)) {
258 case USB_ST_TRANSFERRED:
259 bbb_transfer_start(sc, next_xfer);
262 bbb_done(sc, USB_ERR_STALLED);
269 bbb_command_callback(struct usb_xfer *xfer, usb_error_t error)
271 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
274 switch (USB_GET_STATE(xfer)) {
275 case USB_ST_TRANSFERRED:
277 (sc, ((sc->dir == DIR_IN) ? ST_DATA_RD :
278 (sc->dir == DIR_OUT) ? ST_DATA_WR :
284 tag = UGETDW(sc->cbw.dCBWTag) + 1;
285 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
286 USETDW(sc->cbw.dCBWTag, tag);
287 USETDW(sc->cbw.dCBWDataTransferLength, (uint32_t)sc->data_len);
288 sc->cbw.bCBWFlags = ((sc->dir == DIR_IN) ? CBWFLAGS_IN : CBWFLAGS_OUT);
289 sc->cbw.bCBWLUN = sc->lun;
290 sc->cbw.bCDBLength = sc->cmd_len;
291 if (sc->cbw.bCDBLength > sizeof(sc->cbw.CBWCDB)) {
292 sc->cbw.bCDBLength = sizeof(sc->cbw.CBWCDB);
293 DPRINTFN(0, "Truncating long command\n");
295 usbd_xfer_set_frame_data(xfer, 0, &sc->cbw, sizeof(sc->cbw));
296 usbd_transfer_submit(xfer);
306 bbb_data_read_callback(struct usb_xfer *xfer, usb_error_t error)
308 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
309 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
312 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
314 switch (USB_GET_STATE(xfer)) {
315 case USB_ST_TRANSFERRED:
316 sc->data_rem -= actlen;
317 sc->data_ptr += actlen;
318 sc->actlen += actlen;
320 if (actlen < sumlen) {
325 DPRINTF("max_bulk=%d, data_rem=%d\n",
326 max_bulk, sc->data_rem);
328 if (sc->data_rem == 0) {
329 bbb_transfer_start(sc, ST_STATUS);
332 if (max_bulk > sc->data_rem) {
333 max_bulk = sc->data_rem;
335 usbd_xfer_set_timeout(xfer, sc->data_timeout);
336 usbd_xfer_set_frame_data(xfer, 0, sc->data_ptr, max_bulk);
337 usbd_transfer_submit(xfer);
341 if (error == USB_ERR_CANCELLED) {
344 bbb_transfer_start(sc, ST_DATA_RD_CS);
351 bbb_data_rd_cs_callback(struct usb_xfer *xfer, usb_error_t error)
353 bbb_data_clear_stall_callback(xfer, ST_STATUS,
358 bbb_data_write_callback(struct usb_xfer *xfer, usb_error_t error)
360 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
361 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
364 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
366 switch (USB_GET_STATE(xfer)) {
367 case USB_ST_TRANSFERRED:
368 sc->data_rem -= actlen;
369 sc->data_ptr += actlen;
370 sc->actlen += actlen;
372 if (actlen < sumlen) {
377 DPRINTF("max_bulk=%d, data_rem=%d\n",
378 max_bulk, sc->data_rem);
380 if (sc->data_rem == 0) {
381 bbb_transfer_start(sc, ST_STATUS);
384 if (max_bulk > sc->data_rem) {
385 max_bulk = sc->data_rem;
387 usbd_xfer_set_timeout(xfer, sc->data_timeout);
388 usbd_xfer_set_frame_data(xfer, 0, sc->data_ptr, max_bulk);
389 usbd_transfer_submit(xfer);
393 if (error == USB_ERR_CANCELLED) {
396 bbb_transfer_start(sc, ST_DATA_WR_CS);
404 bbb_data_wr_cs_callback(struct usb_xfer *xfer, usb_error_t error)
406 bbb_data_clear_stall_callback(xfer, ST_STATUS,
411 bbb_status_callback(struct usb_xfer *xfer, usb_error_t error)
413 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
416 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
418 switch (USB_GET_STATE(xfer)) {
419 case USB_ST_TRANSFERRED:
421 /* very simple status check */
423 if (actlen < sizeof(sc->csw)) {
424 bbb_done(sc, USB_ERR_SHORT_XFER);
425 } else if (sc->csw.bCSWStatus == CSWSTATUS_GOOD) {
426 bbb_done(sc, 0); /* success */
428 bbb_done(sc, ERR_CSW_FAILED); /* error */
433 usbd_xfer_set_frame_data(xfer, 0, &sc->csw, sizeof(sc->csw));
434 usbd_transfer_submit(xfer);
438 DPRINTF("Failed to read CSW: %s, try %d\n",
439 usbd_errstr(error), sc->status_try);
441 if (error == USB_ERR_CANCELLED || sc->status_try) {
445 bbb_transfer_start(sc, ST_DATA_RD_CS);
451 /*------------------------------------------------------------------------*
452 * bbb_command_start - execute a SCSI command synchronously
457 *------------------------------------------------------------------------*/
459 bbb_command_start(struct bbb_transfer *sc, uint8_t dir, uint8_t lun,
460 void *data_ptr, size_t data_len, void *cmd_ptr, size_t cmd_len,
461 usb_timeout_t data_timeout)
464 sc->dir = data_len ? dir : DIR_NONE;
465 sc->data_ptr = data_ptr;
466 sc->data_len = data_len;
467 sc->data_rem = data_len;
468 sc->data_timeout = (data_timeout + USB_MS_HZ);
470 sc->cmd_len = cmd_len;
471 bzero(&sc->cbw.CBWCDB, sizeof(sc->cbw.CBWCDB));
472 bcopy(cmd_ptr, &sc->cbw.CBWCDB, cmd_len);
473 DPRINTFN(1, "SCSI cmd = %*D\n", (int)cmd_len, &sc->cbw.CBWCDB, ":");
476 usbd_transfer_start(sc->xfer[sc->state]);
478 while (usbd_transfer_pending(sc->xfer[sc->state])) {
479 cv_wait(&sc->cv, &sc->mtx);
481 mtx_unlock(&sc->mtx);
485 static struct bbb_transfer *
486 bbb_attach(struct usb_device *udev, uint8_t iface_index)
488 struct usb_interface *iface;
489 struct usb_interface_descriptor *id;
490 struct bbb_transfer *sc;
493 iface = usbd_get_iface(udev, iface_index);
498 if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
501 switch (id->bInterfaceSubClass) {
502 case UISUBCLASS_SCSI:
504 case UISUBCLASS_SFF8020I:
505 case UISUBCLASS_SFF8070I:
511 switch (id->bInterfaceProtocol) {
512 case UIPROTO_MASS_BBB_OLD:
513 case UIPROTO_MASS_BBB:
519 sc = malloc(sizeof(*sc), M_USB, M_WAITOK | M_ZERO);
520 mtx_init(&sc->mtx, "USB autoinstall", NULL, MTX_DEF);
521 cv_init(&sc->cv, "WBBB");
523 err = usbd_transfer_setup(udev, &iface_index, sc->xfer, bbb_config,
524 ST_MAX, sc, &sc->mtx);
533 bbb_detach(struct bbb_transfer *sc)
535 usbd_transfer_unsetup(sc->xfer, ST_MAX);
536 mtx_destroy(&sc->mtx);
541 /*------------------------------------------------------------------------*
545 * 1: This interface is an auto install disk (CD-ROM)
546 * 0: Not an auto install disk.
547 *------------------------------------------------------------------------*/
549 usb_iface_is_cdrom(struct usb_device *udev, uint8_t iface_index)
551 struct bbb_transfer *sc;
553 uint8_t timeout, is_cdrom;
556 sc = bbb_attach(udev, iface_index);
561 timeout = 4; /* tries */
563 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
564 SCSI_INQ_LEN, &scsi_inquiry, sizeof(scsi_inquiry),
567 if (err == 0 && sc->actlen > 0) {
568 sid_type = sc->buffer[0] & 0x1F;
569 if (sid_type == 0x05)
572 } else if (err != ERR_CSW_FAILED)
573 break; /* non retryable error */
574 usb_pause_mtx(NULL, hz);
581 usb_msc_eject(struct usb_device *udev, uint8_t iface_index, int method)
583 struct bbb_transfer *sc;
586 sc = bbb_attach(udev, iface_index);
588 return (USB_ERR_INVAL);
592 case MSC_EJECT_STOPUNIT:
593 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
594 &scsi_test_unit_ready, sizeof(scsi_test_unit_ready),
596 DPRINTF("Test unit ready status: %s\n", usbd_errstr(err));
597 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
598 &scsi_start_stop_unit, sizeof(scsi_start_stop_unit),
601 case MSC_EJECT_REZERO:
602 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
603 &scsi_rezero_init, sizeof(scsi_rezero_init),
606 case MSC_EJECT_ZTESTOR:
607 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
608 &scsi_ztestor_eject, sizeof(scsi_ztestor_eject),
611 case MSC_EJECT_CMOTECH:
612 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
613 &scsi_cmotech_eject, sizeof(scsi_cmotech_eject),
616 case MSC_EJECT_HUAWEI:
617 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
618 &scsi_huawei_eject, sizeof(scsi_huawei_eject),
623 * TCTMobile needs DIR_IN flag. To get it, we
624 * supply a dummy data with the command.
626 err = bbb_command_start(sc, DIR_IN, 0, &sc->buffer,
627 sizeof(sc->buffer), &scsi_tct_eject,
628 sizeof(scsi_tct_eject), USB_MS_HZ);
631 printf("usb_msc_eject: unknown eject method (%d)\n", method);
634 DPRINTF("Eject CD command status: %s\n", usbd_errstr(err));