3 * Copyright (c) 2008,2011 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_device.h>
66 #include <dev/usb/usb_request.h>
67 #include <dev/usb/usb_util.h>
68 #include <dev/usb/quirk/usb_quirk.h>
86 #define SCSI_MAX_LEN 0x100
87 #define SCSI_INQ_LEN 0x24
88 #define SCSI_SENSE_LEN 0xFF
90 static uint8_t scsi_test_unit_ready[] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
91 static uint8_t scsi_inquiry[] = { 0x12, 0x00, 0x00, 0x00, SCSI_INQ_LEN, 0x00 };
92 static uint8_t scsi_rezero_init[] = { 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 };
93 static uint8_t scsi_start_stop_unit[] = { 0x1b, 0x00, 0x00, 0x00, 0x02, 0x00 };
94 static uint8_t scsi_ztestor_eject[] = { 0x85, 0x01, 0x01, 0x01, 0x18, 0x01,
95 0x01, 0x01, 0x01, 0x01, 0x00, 0x00 };
96 static uint8_t scsi_cmotech_eject[] = { 0xff, 0x52, 0x44, 0x45, 0x56, 0x43,
98 static uint8_t scsi_huawei_eject[] = { 0x11, 0x06, 0x00, 0x00, 0x00, 0x00,
99 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
100 0x00, 0x00, 0x00, 0x00 };
101 static uint8_t scsi_tct_eject[] = { 0x06, 0xf5, 0x04, 0x02, 0x52, 0x70 };
102 static uint8_t scsi_sync_cache[] = { 0x35, 0x00, 0x00, 0x00, 0x00, 0x00,
103 0x00, 0x00, 0x00, 0x00 };
104 static uint8_t scsi_request_sense[] = { 0x03, 0x00, 0x00, 0x00, 0x12, 0x00,
105 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
107 #define BULK_SIZE 64 /* dummy */
108 #define ERR_CSW_FAILED -1
110 /* Command Block Wrapper */
112 uDWord dCBWSignature;
113 #define CBWSIGNATURE 0x43425355
115 uDWord dCBWDataTransferLength;
117 #define CBWFLAGS_OUT 0x00
118 #define CBWFLAGS_IN 0x80
121 #define CBWCDBLENGTH 16
122 uByte CBWCDB[CBWCDBLENGTH];
125 /* Command Status Wrapper */
127 uDWord dCSWSignature;
128 #define CSWSIGNATURE 0x53425355
130 uDWord dCSWDataResidue;
132 #define CSWSTATUS_GOOD 0x0
133 #define CSWSTATUS_FAILED 0x1
134 #define CSWSTATUS_PHASE 0x2
137 struct bbb_transfer {
143 struct usb_xfer *xfer[ST_MAX];
147 usb_size_t data_len; /* bytes */
148 usb_size_t data_rem; /* bytes */
149 usb_timeout_t data_timeout; /* ms */
150 usb_frlength_t actlen; /* bytes */
152 uint8_t cmd_len; /* bytes */
159 uint8_t buffer[SCSI_MAX_LEN] __aligned(4);
162 static usb_callback_t bbb_command_callback;
163 static usb_callback_t bbb_data_read_callback;
164 static usb_callback_t bbb_data_rd_cs_callback;
165 static usb_callback_t bbb_data_write_callback;
166 static usb_callback_t bbb_data_wr_cs_callback;
167 static usb_callback_t bbb_status_callback;
169 static void bbb_done(struct bbb_transfer *, int);
170 static void bbb_transfer_start(struct bbb_transfer *, uint8_t);
171 static void bbb_data_clear_stall_callback(struct usb_xfer *, uint8_t,
173 static int bbb_command_start(struct bbb_transfer *, uint8_t, uint8_t,
174 void *, size_t, void *, size_t, usb_timeout_t);
175 static struct bbb_transfer *bbb_attach(struct usb_device *, uint8_t);
176 static void bbb_detach(struct bbb_transfer *);
178 static const struct usb_config bbb_config[ST_MAX] = {
182 .endpoint = UE_ADDR_ANY,
183 .direction = UE_DIR_OUT,
184 .bufsize = sizeof(struct bbb_cbw),
185 .flags = {.ext_buffer = 1,},
186 .callback = &bbb_command_callback,
187 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
192 .endpoint = UE_ADDR_ANY,
193 .direction = UE_DIR_IN,
194 .bufsize = BULK_SIZE,
195 .flags = {.ext_buffer = 1,.proxy_buffer = 1,.short_xfer_ok = 1,},
196 .callback = &bbb_data_read_callback,
197 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
202 .endpoint = 0x00, /* Control pipe */
203 .direction = UE_DIR_ANY,
204 .bufsize = sizeof(struct usb_device_request),
205 .callback = &bbb_data_rd_cs_callback,
206 .timeout = 1 * USB_MS_HZ, /* 1 second */
211 .endpoint = UE_ADDR_ANY,
212 .direction = UE_DIR_OUT,
213 .bufsize = BULK_SIZE,
214 .flags = {.ext_buffer = 1,.proxy_buffer = 1,},
215 .callback = &bbb_data_write_callback,
216 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
221 .endpoint = 0x00, /* Control pipe */
222 .direction = UE_DIR_ANY,
223 .bufsize = sizeof(struct usb_device_request),
224 .callback = &bbb_data_wr_cs_callback,
225 .timeout = 1 * USB_MS_HZ, /* 1 second */
230 .endpoint = UE_ADDR_ANY,
231 .direction = UE_DIR_IN,
232 .bufsize = sizeof(struct bbb_csw),
233 .flags = {.ext_buffer = 1,.short_xfer_ok = 1,},
234 .callback = &bbb_status_callback,
235 .timeout = 1 * USB_MS_HZ, /* 1 second */
240 bbb_done(struct bbb_transfer *sc, int error)
244 sc->state = ST_COMMAND;
250 bbb_transfer_start(struct bbb_transfer *sc, uint8_t xfer_index)
252 sc->state = xfer_index;
253 usbd_transfer_start(sc->xfer[xfer_index]);
257 bbb_data_clear_stall_callback(struct usb_xfer *xfer,
258 uint8_t next_xfer, uint8_t stall_xfer)
260 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
262 if (usbd_clear_stall_callback(xfer, sc->xfer[stall_xfer])) {
263 switch (USB_GET_STATE(xfer)) {
265 case USB_ST_TRANSFERRED:
266 bbb_transfer_start(sc, next_xfer);
269 bbb_done(sc, USB_ERR_STALLED);
276 bbb_command_callback(struct usb_xfer *xfer, usb_error_t error)
278 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
281 switch (USB_GET_STATE(xfer)) {
282 case USB_ST_TRANSFERRED:
284 (sc, ((sc->dir == DIR_IN) ? ST_DATA_RD :
285 (sc->dir == DIR_OUT) ? ST_DATA_WR :
291 tag = UGETDW(sc->cbw.dCBWTag) + 1;
292 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
293 USETDW(sc->cbw.dCBWTag, tag);
294 USETDW(sc->cbw.dCBWDataTransferLength, (uint32_t)sc->data_len);
295 sc->cbw.bCBWFlags = ((sc->dir == DIR_IN) ? CBWFLAGS_IN : CBWFLAGS_OUT);
296 sc->cbw.bCBWLUN = sc->lun;
297 sc->cbw.bCDBLength = sc->cmd_len;
298 if (sc->cbw.bCDBLength > sizeof(sc->cbw.CBWCDB)) {
299 sc->cbw.bCDBLength = sizeof(sc->cbw.CBWCDB);
300 DPRINTFN(0, "Truncating long command\n");
302 usbd_xfer_set_frame_data(xfer, 0, &sc->cbw, sizeof(sc->cbw));
303 usbd_transfer_submit(xfer);
313 bbb_data_read_callback(struct usb_xfer *xfer, usb_error_t error)
315 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
316 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
319 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
321 switch (USB_GET_STATE(xfer)) {
322 case USB_ST_TRANSFERRED:
323 sc->data_rem -= actlen;
324 sc->data_ptr += actlen;
325 sc->actlen += actlen;
327 if (actlen < sumlen) {
332 DPRINTF("max_bulk=%d, data_rem=%d\n",
333 max_bulk, sc->data_rem);
335 if (sc->data_rem == 0) {
336 bbb_transfer_start(sc, ST_STATUS);
339 if (max_bulk > sc->data_rem) {
340 max_bulk = sc->data_rem;
342 usbd_xfer_set_timeout(xfer, sc->data_timeout);
343 usbd_xfer_set_frame_data(xfer, 0, sc->data_ptr, max_bulk);
344 usbd_transfer_submit(xfer);
348 if (error == USB_ERR_CANCELLED) {
351 bbb_transfer_start(sc, ST_DATA_RD_CS);
358 bbb_data_rd_cs_callback(struct usb_xfer *xfer, usb_error_t error)
360 bbb_data_clear_stall_callback(xfer, ST_STATUS,
365 bbb_data_write_callback(struct usb_xfer *xfer, usb_error_t error)
367 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
368 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
371 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
373 switch (USB_GET_STATE(xfer)) {
374 case USB_ST_TRANSFERRED:
375 sc->data_rem -= actlen;
376 sc->data_ptr += actlen;
377 sc->actlen += actlen;
379 if (actlen < sumlen) {
384 DPRINTF("max_bulk=%d, data_rem=%d\n",
385 max_bulk, sc->data_rem);
387 if (sc->data_rem == 0) {
388 bbb_transfer_start(sc, ST_STATUS);
391 if (max_bulk > sc->data_rem) {
392 max_bulk = sc->data_rem;
394 usbd_xfer_set_timeout(xfer, sc->data_timeout);
395 usbd_xfer_set_frame_data(xfer, 0, sc->data_ptr, max_bulk);
396 usbd_transfer_submit(xfer);
400 if (error == USB_ERR_CANCELLED) {
403 bbb_transfer_start(sc, ST_DATA_WR_CS);
411 bbb_data_wr_cs_callback(struct usb_xfer *xfer, usb_error_t error)
413 bbb_data_clear_stall_callback(xfer, ST_STATUS,
418 bbb_status_callback(struct usb_xfer *xfer, usb_error_t error)
420 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
423 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
425 switch (USB_GET_STATE(xfer)) {
426 case USB_ST_TRANSFERRED:
428 /* very simple status check */
430 if (actlen < sizeof(sc->csw)) {
431 bbb_done(sc, USB_ERR_SHORT_XFER);
432 } else if (sc->csw.bCSWStatus == CSWSTATUS_GOOD) {
433 bbb_done(sc, 0); /* success */
435 bbb_done(sc, ERR_CSW_FAILED); /* error */
440 usbd_xfer_set_frame_data(xfer, 0, &sc->csw, sizeof(sc->csw));
441 usbd_transfer_submit(xfer);
445 DPRINTF("Failed to read CSW: %s, try %d\n",
446 usbd_errstr(error), sc->status_try);
448 if (error == USB_ERR_CANCELLED || sc->status_try) {
452 bbb_transfer_start(sc, ST_DATA_RD_CS);
458 /*------------------------------------------------------------------------*
459 * bbb_command_start - execute a SCSI command synchronously
464 *------------------------------------------------------------------------*/
466 bbb_command_start(struct bbb_transfer *sc, uint8_t dir, uint8_t lun,
467 void *data_ptr, size_t data_len, void *cmd_ptr, size_t cmd_len,
468 usb_timeout_t data_timeout)
471 sc->dir = data_len ? dir : DIR_NONE;
472 sc->data_ptr = data_ptr;
473 sc->data_len = data_len;
474 sc->data_rem = data_len;
475 sc->data_timeout = (data_timeout + USB_MS_HZ);
477 sc->cmd_len = cmd_len;
478 bzero(&sc->cbw.CBWCDB, sizeof(sc->cbw.CBWCDB));
479 bcopy(cmd_ptr, &sc->cbw.CBWCDB, cmd_len);
480 DPRINTFN(1, "SCSI cmd = %*D\n", (int)cmd_len, &sc->cbw.CBWCDB, ":");
483 usbd_transfer_start(sc->xfer[sc->state]);
485 while (usbd_transfer_pending(sc->xfer[sc->state])) {
486 cv_wait(&sc->cv, &sc->mtx);
488 mtx_unlock(&sc->mtx);
492 static struct bbb_transfer *
493 bbb_attach(struct usb_device *udev, uint8_t iface_index)
495 struct usb_interface *iface;
496 struct usb_interface_descriptor *id;
497 struct bbb_transfer *sc;
501 /* automatic locking */
502 if (usbd_enum_is_locked(udev)) {
506 usbd_enum_lock(udev);
510 * Make sure any driver which is hooked up to this interface,
511 * like umass is gone:
513 usb_detach_device(udev, iface_index, 0);
516 usbd_enum_unlock(udev);
518 iface = usbd_get_iface(udev, iface_index);
523 if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
526 switch (id->bInterfaceSubClass) {
527 case UISUBCLASS_SCSI:
529 case UISUBCLASS_SFF8020I:
530 case UISUBCLASS_SFF8070I:
536 switch (id->bInterfaceProtocol) {
537 case UIPROTO_MASS_BBB_OLD:
538 case UIPROTO_MASS_BBB:
544 sc = malloc(sizeof(*sc), M_USB, M_WAITOK | M_ZERO);
545 mtx_init(&sc->mtx, "USB autoinstall", NULL, MTX_DEF);
546 cv_init(&sc->cv, "WBBB");
548 err = usbd_transfer_setup(udev, &iface_index, sc->xfer, bbb_config,
549 ST_MAX, sc, &sc->mtx);
558 bbb_detach(struct bbb_transfer *sc)
560 usbd_transfer_unsetup(sc->xfer, ST_MAX);
561 mtx_destroy(&sc->mtx);
566 /*------------------------------------------------------------------------*
570 * 1: This interface is an auto install disk (CD-ROM)
571 * 0: Not an auto install disk.
572 *------------------------------------------------------------------------*/
574 usb_iface_is_cdrom(struct usb_device *udev, uint8_t iface_index)
576 struct bbb_transfer *sc;
582 sc = bbb_attach(udev, iface_index);
587 timeout = 4; /* tries */
589 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
590 SCSI_INQ_LEN, &scsi_inquiry, sizeof(scsi_inquiry),
593 if (err == 0 && sc->actlen > 0) {
594 sid_type = sc->buffer[0] & 0x1F;
595 if (sid_type == 0x05)
598 } else if (err != ERR_CSW_FAILED)
599 break; /* non retryable error */
600 usb_pause_mtx(NULL, hz);
607 usb_msc_auto_quirk(struct usb_device *udev, uint8_t iface_index)
609 struct bbb_transfer *sc;
611 uint8_t is_no_direct;
615 sc = bbb_attach(udev, iface_index);
620 * Some devices need a delay after that the configuration
621 * value is set to function properly:
623 usb_pause_mtx(NULL, hz);
626 for (timeout = 4; timeout; timeout--) {
627 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
628 SCSI_INQ_LEN, &scsi_inquiry, sizeof(scsi_inquiry),
631 if (err == 0 && sc->actlen > 0) {
632 sid_type = sc->buffer[0] & 0x1F;
633 if (sid_type == 0x00)
636 } else if (err != ERR_CSW_FAILED)
637 break; /* non retryable error */
638 usb_pause_mtx(NULL, hz);
642 DPRINTF("Device is not direct access.\n");
646 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
647 &scsi_test_unit_ready, sizeof(scsi_test_unit_ready),
652 if (err != ERR_CSW_FAILED)
656 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
657 &scsi_sync_cache, sizeof(scsi_sync_cache),
662 if (err != ERR_CSW_FAILED)
665 DPRINTF("Device doesn't handle synchronize cache\n");
667 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_SYNC_CACHE);
670 /* clear sense status of any failed commands on the device */
672 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
673 SCSI_INQ_LEN, &scsi_inquiry, sizeof(scsi_inquiry),
676 DPRINTF("Inquiry = %d\n", err);
680 if (err != ERR_CSW_FAILED)
684 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
685 SCSI_SENSE_LEN, &scsi_request_sense,
686 sizeof(scsi_request_sense), USB_MS_HZ);
688 DPRINTF("Request sense = %d\n", err);
692 if (err != ERR_CSW_FAILED)
703 DPRINTF("Device did not respond, enabling all quirks\n");
705 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_SYNC_CACHE);
706 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_TEST_UNIT_READY);
708 /* Need to re-enumerate the device */
709 usbd_req_re_enumerate(udev, NULL);
711 return (USB_ERR_STALLED);
715 usb_msc_eject(struct usb_device *udev, uint8_t iface_index, int method)
717 struct bbb_transfer *sc;
720 sc = bbb_attach(udev, iface_index);
722 return (USB_ERR_INVAL);
726 case MSC_EJECT_STOPUNIT:
727 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
728 &scsi_test_unit_ready, sizeof(scsi_test_unit_ready),
730 DPRINTF("Test unit ready status: %s\n", usbd_errstr(err));
731 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
732 &scsi_start_stop_unit, sizeof(scsi_start_stop_unit),
735 case MSC_EJECT_REZERO:
736 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
737 &scsi_rezero_init, sizeof(scsi_rezero_init),
740 case MSC_EJECT_ZTESTOR:
741 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
742 &scsi_ztestor_eject, sizeof(scsi_ztestor_eject),
745 case MSC_EJECT_CMOTECH:
746 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
747 &scsi_cmotech_eject, sizeof(scsi_cmotech_eject),
750 case MSC_EJECT_HUAWEI:
751 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
752 &scsi_huawei_eject, sizeof(scsi_huawei_eject),
757 * TCTMobile needs DIR_IN flag. To get it, we
758 * supply a dummy data with the command.
760 err = bbb_command_start(sc, DIR_IN, 0, &sc->buffer,
761 sizeof(sc->buffer), &scsi_tct_eject,
762 sizeof(scsi_tct_eject), USB_MS_HZ);
765 printf("usb_msc_eject: unknown eject method (%d)\n", method);
768 DPRINTF("Eject CD command status: %s\n", usbd_errstr(err));