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 MAX(0x100, BULK_SIZE)
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_huawei_eject2[] = { 0x11, 0x06, 0x20, 0x00, 0x00, 0x01,
102 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
103 0x00, 0x00, 0x00, 0x00 };
104 static uint8_t scsi_tct_eject[] = { 0x06, 0xf5, 0x04, 0x02, 0x52, 0x70 };
105 static uint8_t scsi_sync_cache[] = { 0x35, 0x00, 0x00, 0x00, 0x00, 0x00,
106 0x00, 0x00, 0x00, 0x00 };
107 static uint8_t scsi_request_sense[] = { 0x03, 0x00, 0x00, 0x00, 0x12, 0x00,
108 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
109 static uint8_t scsi_read_capacity[] = { 0x25, 0x00, 0x00, 0x00, 0x00, 0x00,
110 0x00, 0x00, 0x00, 0x00 };
111 static uint8_t scsi_prevent_removal[] = { 0x1e, 0, 0, 0, 1, 0 };
112 static uint8_t scsi_allow_removal[] = { 0x1e, 0, 0, 0, 0, 0 };
114 #define BULK_SIZE 64 /* dummy */
115 #define ERR_CSW_FAILED -1
117 /* Command Block Wrapper */
119 uDWord dCBWSignature;
120 #define CBWSIGNATURE 0x43425355
122 uDWord dCBWDataTransferLength;
124 #define CBWFLAGS_OUT 0x00
125 #define CBWFLAGS_IN 0x80
128 #define CBWCDBLENGTH 16
129 uByte CBWCDB[CBWCDBLENGTH];
132 /* Command Status Wrapper */
134 uDWord dCSWSignature;
135 #define CSWSIGNATURE 0x53425355
137 uDWord dCSWDataResidue;
139 #define CSWSTATUS_GOOD 0x0
140 #define CSWSTATUS_FAILED 0x1
141 #define CSWSTATUS_PHASE 0x2
144 struct bbb_transfer {
150 struct usb_xfer *xfer[ST_MAX];
154 usb_size_t data_len; /* bytes */
155 usb_size_t data_rem; /* bytes */
156 usb_timeout_t data_timeout; /* ms */
157 usb_frlength_t actlen; /* bytes */
158 usb_frlength_t buffer_size; /* bytes */
160 uint8_t cmd_len; /* bytes */
170 static usb_callback_t bbb_command_callback;
171 static usb_callback_t bbb_data_read_callback;
172 static usb_callback_t bbb_data_rd_cs_callback;
173 static usb_callback_t bbb_data_write_callback;
174 static usb_callback_t bbb_data_wr_cs_callback;
175 static usb_callback_t bbb_status_callback;
176 static usb_callback_t bbb_raw_write_callback;
178 static void bbb_done(struct bbb_transfer *, int);
179 static void bbb_transfer_start(struct bbb_transfer *, uint8_t);
180 static void bbb_data_clear_stall_callback(struct usb_xfer *, uint8_t,
182 static int bbb_command_start(struct bbb_transfer *, uint8_t, uint8_t,
183 void *, size_t, void *, size_t, usb_timeout_t);
184 static struct bbb_transfer *bbb_attach(struct usb_device *, uint8_t, uint8_t);
185 static void bbb_detach(struct bbb_transfer *);
187 static const struct usb_config bbb_config[ST_MAX] = {
191 .endpoint = UE_ADDR_ANY,
192 .direction = UE_DIR_OUT,
193 .bufsize = sizeof(struct bbb_cbw),
194 .callback = &bbb_command_callback,
195 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
200 .endpoint = UE_ADDR_ANY,
201 .direction = UE_DIR_IN,
202 .bufsize = SCSI_MAX_LEN,
203 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1,},
204 .callback = &bbb_data_read_callback,
205 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
210 .endpoint = 0x00, /* Control pipe */
211 .direction = UE_DIR_ANY,
212 .bufsize = sizeof(struct usb_device_request),
213 .callback = &bbb_data_rd_cs_callback,
214 .timeout = 1 * USB_MS_HZ, /* 1 second */
219 .endpoint = UE_ADDR_ANY,
220 .direction = UE_DIR_OUT,
221 .bufsize = SCSI_MAX_LEN,
222 .flags = {.ext_buffer = 1,.proxy_buffer = 1,},
223 .callback = &bbb_data_write_callback,
224 .timeout = 4 * USB_MS_HZ, /* 4 seconds */
229 .endpoint = 0x00, /* Control pipe */
230 .direction = UE_DIR_ANY,
231 .bufsize = sizeof(struct usb_device_request),
232 .callback = &bbb_data_wr_cs_callback,
233 .timeout = 1 * USB_MS_HZ, /* 1 second */
238 .endpoint = UE_ADDR_ANY,
239 .direction = UE_DIR_IN,
240 .bufsize = sizeof(struct bbb_csw),
241 .flags = {.short_xfer_ok = 1,},
242 .callback = &bbb_status_callback,
243 .timeout = 1 * USB_MS_HZ, /* 1 second */
247 static const struct usb_config bbb_raw_config[1] = {
250 .type = UE_BULK_INTR,
251 .endpoint = UE_ADDR_ANY,
252 .direction = UE_DIR_OUT,
253 .bufsize = SCSI_MAX_LEN,
254 .flags = {.ext_buffer = 1,.proxy_buffer = 1,},
255 .callback = &bbb_raw_write_callback,
256 .timeout = 1 * USB_MS_HZ, /* 1 second */
261 bbb_done(struct bbb_transfer *sc, int error)
264 sc->state = ST_COMMAND;
270 bbb_transfer_start(struct bbb_transfer *sc, uint8_t xfer_index)
272 sc->state = xfer_index;
273 usbd_transfer_start(sc->xfer[xfer_index]);
277 bbb_data_clear_stall_callback(struct usb_xfer *xfer,
278 uint8_t next_xfer, uint8_t stall_xfer)
280 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
282 if (usbd_clear_stall_callback(xfer, sc->xfer[stall_xfer])) {
283 switch (USB_GET_STATE(xfer)) {
285 case USB_ST_TRANSFERRED:
286 bbb_transfer_start(sc, next_xfer);
289 bbb_done(sc, USB_ERR_STALLED);
296 bbb_command_callback(struct usb_xfer *xfer, usb_error_t error)
298 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
301 switch (USB_GET_STATE(xfer)) {
302 case USB_ST_TRANSFERRED:
304 (sc, ((sc->dir == DIR_IN) ? ST_DATA_RD :
305 (sc->dir == DIR_OUT) ? ST_DATA_WR :
311 tag = UGETDW(sc->cbw->dCBWTag) + 1;
312 USETDW(sc->cbw->dCBWSignature, CBWSIGNATURE);
313 USETDW(sc->cbw->dCBWTag, tag);
314 USETDW(sc->cbw->dCBWDataTransferLength, (uint32_t)sc->data_len);
315 sc->cbw->bCBWFlags = ((sc->dir == DIR_IN) ? CBWFLAGS_IN : CBWFLAGS_OUT);
316 sc->cbw->bCBWLUN = sc->lun;
317 sc->cbw->bCDBLength = sc->cmd_len;
318 if (sc->cbw->bCDBLength > sizeof(sc->cbw->CBWCDB)) {
319 sc->cbw->bCDBLength = sizeof(sc->cbw->CBWCDB);
320 DPRINTFN(0, "Truncating long command\n");
322 usbd_xfer_set_frame_len(xfer, 0,
323 sizeof(struct bbb_cbw));
324 usbd_transfer_submit(xfer);
334 bbb_data_read_callback(struct usb_xfer *xfer, usb_error_t error)
336 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
337 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
340 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
342 switch (USB_GET_STATE(xfer)) {
343 case USB_ST_TRANSFERRED:
344 sc->data_rem -= actlen;
345 sc->data_ptr += actlen;
346 sc->actlen += actlen;
348 if (actlen < sumlen) {
353 DPRINTF("max_bulk=%d, data_rem=%d\n",
354 max_bulk, sc->data_rem);
356 if (sc->data_rem == 0) {
357 bbb_transfer_start(sc, ST_STATUS);
360 if (max_bulk > sc->data_rem) {
361 max_bulk = sc->data_rem;
363 usbd_xfer_set_timeout(xfer, sc->data_timeout);
364 usbd_xfer_set_frame_data(xfer, 0, sc->data_ptr, max_bulk);
365 usbd_transfer_submit(xfer);
369 if (error == USB_ERR_CANCELLED) {
372 bbb_transfer_start(sc, ST_DATA_RD_CS);
379 bbb_data_rd_cs_callback(struct usb_xfer *xfer, usb_error_t error)
381 bbb_data_clear_stall_callback(xfer, ST_STATUS,
386 bbb_data_write_callback(struct usb_xfer *xfer, usb_error_t error)
388 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
389 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
392 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
394 switch (USB_GET_STATE(xfer)) {
395 case USB_ST_TRANSFERRED:
396 sc->data_rem -= actlen;
397 sc->data_ptr += actlen;
398 sc->actlen += actlen;
400 if (actlen < sumlen) {
405 DPRINTF("max_bulk=%d, data_rem=%d\n",
406 max_bulk, sc->data_rem);
408 if (sc->data_rem == 0) {
409 bbb_transfer_start(sc, ST_STATUS);
412 if (max_bulk > sc->data_rem) {
413 max_bulk = sc->data_rem;
415 usbd_xfer_set_timeout(xfer, sc->data_timeout);
416 usbd_xfer_set_frame_data(xfer, 0, sc->data_ptr, max_bulk);
417 usbd_transfer_submit(xfer);
421 if (error == USB_ERR_CANCELLED) {
424 bbb_transfer_start(sc, ST_DATA_WR_CS);
431 bbb_data_wr_cs_callback(struct usb_xfer *xfer, usb_error_t error)
433 bbb_data_clear_stall_callback(xfer, ST_STATUS,
438 bbb_status_callback(struct usb_xfer *xfer, usb_error_t error)
440 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
444 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
446 switch (USB_GET_STATE(xfer)) {
447 case USB_ST_TRANSFERRED:
449 /* very simple status check */
451 if (actlen < (int)sizeof(struct bbb_csw)) {
452 bbb_done(sc, USB_ERR_SHORT_XFER);
453 } else if (sc->csw->bCSWStatus == CSWSTATUS_GOOD) {
454 bbb_done(sc, 0); /* success */
456 bbb_done(sc, ERR_CSW_FAILED); /* error */
461 usbd_xfer_set_frame_len(xfer, 0,
462 sizeof(struct bbb_csw));
463 usbd_transfer_submit(xfer);
467 DPRINTF("Failed to read CSW: %s, try %d\n",
468 usbd_errstr(error), sc->status_try);
470 if (error == USB_ERR_CANCELLED || sc->status_try) {
474 bbb_transfer_start(sc, ST_DATA_RD_CS);
481 bbb_raw_write_callback(struct usb_xfer *xfer, usb_error_t error)
483 struct bbb_transfer *sc = usbd_xfer_softc(xfer);
484 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
487 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
489 switch (USB_GET_STATE(xfer)) {
490 case USB_ST_TRANSFERRED:
491 sc->data_rem -= actlen;
492 sc->data_ptr += actlen;
493 sc->actlen += actlen;
495 if (actlen < sumlen) {
500 DPRINTF("max_bulk=%d, data_rem=%d\n",
501 max_bulk, sc->data_rem);
503 if (sc->data_rem == 0) {
507 if (max_bulk > sc->data_rem) {
508 max_bulk = sc->data_rem;
510 usbd_xfer_set_timeout(xfer, sc->data_timeout);
511 usbd_xfer_set_frame_data(xfer, 0, sc->data_ptr, max_bulk);
512 usbd_transfer_submit(xfer);
521 /*------------------------------------------------------------------------*
522 * bbb_command_start - execute a SCSI command synchronously
527 *------------------------------------------------------------------------*/
529 bbb_command_start(struct bbb_transfer *sc, uint8_t dir, uint8_t lun,
530 void *data_ptr, size_t data_len, void *cmd_ptr, size_t cmd_len,
531 usb_timeout_t data_timeout)
534 sc->dir = data_len ? dir : DIR_NONE;
535 sc->data_ptr = data_ptr;
536 sc->data_len = data_len;
537 sc->data_rem = data_len;
538 sc->data_timeout = (data_timeout + USB_MS_HZ);
541 sc->cmd_len = cmd_len;
542 memset(&sc->cbw->CBWCDB, 0, sizeof(sc->cbw->CBWCDB));
543 memcpy(&sc->cbw->CBWCDB, cmd_ptr, cmd_len);
544 DPRINTFN(1, "SCSI cmd = %*D\n", (int)cmd_len, (char *)sc->cbw->CBWCDB, ":");
547 usbd_transfer_start(sc->xfer[sc->state]);
549 while (usbd_transfer_pending(sc->xfer[sc->state])) {
550 cv_wait(&sc->cv, &sc->mtx);
552 mtx_unlock(&sc->mtx);
556 /*------------------------------------------------------------------------*
557 * bbb_raw_write - write a raw BULK message synchronously
562 *------------------------------------------------------------------------*/
564 bbb_raw_write(struct bbb_transfer *sc, const void *data_ptr, size_t data_len,
565 usb_timeout_t data_timeout)
567 sc->data_ptr = __DECONST(void *, data_ptr);
568 sc->data_len = data_len;
569 sc->data_rem = data_len;
570 sc->data_timeout = (data_timeout + USB_MS_HZ);
574 DPRINTFN(1, "BULK DATA = %*D\n", (int)data_len,
575 (const char *)data_ptr, ":");
578 usbd_transfer_start(sc->xfer[0]);
579 while (usbd_transfer_pending(sc->xfer[0]))
580 cv_wait(&sc->cv, &sc->mtx);
581 mtx_unlock(&sc->mtx);
585 static struct bbb_transfer *
586 bbb_attach(struct usb_device *udev, uint8_t iface_index,
587 uint8_t bInterfaceClass)
589 struct usb_interface *iface;
590 struct usb_interface_descriptor *id;
591 const struct usb_config *pconfig;
592 struct bbb_transfer *sc;
597 /* Prevent re-enumeration */
598 do_unlock = usbd_enum_lock(udev);
601 * Make sure any driver which is hooked up to this interface,
602 * like umass is gone:
604 usb_detach_device(udev, iface_index, 0);
607 usbd_enum_unlock(udev);
609 iface = usbd_get_iface(udev, iface_index);
614 if (id == NULL || id->bInterfaceClass != bInterfaceClass)
617 switch (id->bInterfaceClass) {
619 switch (id->bInterfaceSubClass) {
620 case UISUBCLASS_SCSI:
622 case UISUBCLASS_SFF8020I:
623 case UISUBCLASS_SFF8070I:
628 switch (id->bInterfaceProtocol) {
629 case UIPROTO_MASS_BBB_OLD:
630 case UIPROTO_MASS_BBB:
635 pconfig = bbb_config;
639 switch (id->bInterfaceSubClass) {
645 pconfig = bbb_raw_config;
652 sc = malloc(sizeof(*sc), M_USB, M_WAITOK | M_ZERO);
653 mtx_init(&sc->mtx, "USB autoinstall", NULL, MTX_DEF);
654 cv_init(&sc->cv, "WBBB");
656 err = usbd_transfer_setup(udev, &iface_index, sc->xfer, pconfig,
657 nconfig, sc, &sc->mtx);
662 switch (id->bInterfaceClass) {
664 /* store pointer to DMA buffers */
665 sc->buffer = usbd_xfer_get_frame_buffer(
666 sc->xfer[ST_DATA_RD], 0);
668 usbd_xfer_max_len(sc->xfer[ST_DATA_RD]);
669 sc->cbw = usbd_xfer_get_frame_buffer(
670 sc->xfer[ST_COMMAND], 0);
671 sc->csw = usbd_xfer_get_frame_buffer(
672 sc->xfer[ST_STATUS], 0);
681 bbb_detach(struct bbb_transfer *sc)
683 usbd_transfer_unsetup(sc->xfer, ST_MAX);
684 mtx_destroy(&sc->mtx);
689 /*------------------------------------------------------------------------*
693 * 1: This interface is an auto install disk (CD-ROM)
694 * 0: Not an auto install disk.
695 *------------------------------------------------------------------------*/
697 usb_iface_is_cdrom(struct usb_device *udev, uint8_t iface_index)
699 struct bbb_transfer *sc;
705 sc = bbb_attach(udev, iface_index, UICLASS_MASS);
710 timeout = 4; /* tries */
712 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
713 SCSI_INQ_LEN, &scsi_inquiry, sizeof(scsi_inquiry),
716 if (err == 0 && sc->actlen > 0) {
717 sid_type = sc->buffer[0] & 0x1F;
718 if (sid_type == 0x05)
721 } else if (err != ERR_CSW_FAILED)
722 break; /* non retryable error */
723 usb_pause_mtx(NULL, hz);
730 usb_msc_get_max_lun(struct usb_device *udev, uint8_t iface_index)
732 struct usb_device_request req;
737 /* The Get Max Lun command is a class-specific request. */
738 req.bmRequestType = UT_READ_CLASS_INTERFACE;
739 req.bRequest = 0xFE; /* GET_MAX_LUN */
740 USETW(req.wValue, 0);
741 req.wIndex[0] = iface_index;
743 USETW(req.wLength, 1);
745 err = usbd_do_request(udev, NULL, &req, &buf);
753 usb_msc_auto_quirk(struct usb_device *udev, uint8_t iface_index)
755 struct bbb_transfer *sc;
757 uint8_t is_no_direct;
761 sc = bbb_attach(udev, iface_index, UICLASS_MASS);
766 * Some devices need a delay after that the configuration
767 * value is set to function properly:
769 usb_pause_mtx(NULL, hz);
771 if (usb_msc_get_max_lun(udev, iface_index) == 0) {
772 DPRINTF("Device has only got one LUN.\n");
773 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_GETMAXLUN);
777 for (timeout = 4; timeout != 0; timeout--) {
778 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
779 SCSI_INQ_LEN, &scsi_inquiry, sizeof(scsi_inquiry),
782 if (err == 0 && sc->actlen > 0) {
783 sid_type = sc->buffer[0] & 0x1F;
784 if (sid_type == 0x00)
787 } else if (err != ERR_CSW_FAILED) {
788 DPRINTF("Device is not responding "
789 "properly to SCSI INQUIRY command.\n");
790 goto error; /* non retryable error */
792 usb_pause_mtx(NULL, hz);
796 DPRINTF("Device is not direct access.\n");
800 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
801 &scsi_test_unit_ready, sizeof(scsi_test_unit_ready),
805 if (err != ERR_CSW_FAILED)
807 DPRINTF("Test unit ready failed\n");
810 err = bbb_command_start(sc, DIR_OUT, 0, NULL, 0,
811 &scsi_prevent_removal, sizeof(scsi_prevent_removal),
815 err = bbb_command_start(sc, DIR_OUT, 0, NULL, 0,
816 &scsi_allow_removal, sizeof(scsi_allow_removal),
821 if (err != ERR_CSW_FAILED)
823 DPRINTF("Device doesn't handle prevent and allow removal\n");
824 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_PREVENT_ALLOW);
830 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
831 &scsi_sync_cache, sizeof(scsi_sync_cache),
836 if (err != ERR_CSW_FAILED)
839 DPRINTF("Device doesn't handle synchronize cache\n");
841 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_SYNC_CACHE);
845 * Certain Kingston memory sticks fail the first
846 * read capacity after a synchronize cache command
847 * has been issued. Disable the synchronize cache
848 * command for such devices.
851 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer, 8,
852 &scsi_read_capacity, sizeof(scsi_read_capacity),
856 if (err != ERR_CSW_FAILED)
859 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer, 8,
860 &scsi_read_capacity, sizeof(scsi_read_capacity),
865 goto retry_sync_cache;
867 DPRINTF("Device most likely doesn't "
868 "handle synchronize cache\n");
870 usbd_add_dynamic_quirk(udev,
871 UQ_MSC_NO_SYNC_CACHE);
873 if (err != ERR_CSW_FAILED)
879 /* clear sense status of any failed commands on the device */
881 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
882 SCSI_INQ_LEN, &scsi_inquiry, sizeof(scsi_inquiry),
885 DPRINTF("Inquiry = %d\n", err);
889 if (err != ERR_CSW_FAILED)
893 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
894 SCSI_SENSE_LEN, &scsi_request_sense,
895 sizeof(scsi_request_sense), USB_MS_HZ);
897 DPRINTF("Request sense = %d\n", err);
901 if (err != ERR_CSW_FAILED)
912 DPRINTF("Device did not respond, enabling all quirks\n");
914 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_SYNC_CACHE);
915 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_PREVENT_ALLOW);
916 usbd_add_dynamic_quirk(udev, UQ_MSC_NO_TEST_UNIT_READY);
918 /* Need to re-enumerate the device */
919 usbd_req_re_enumerate(udev, NULL);
921 return (USB_ERR_STALLED);
925 usb_msc_eject(struct usb_device *udev, uint8_t iface_index, int method)
927 struct bbb_transfer *sc;
930 sc = bbb_attach(udev, iface_index, UICLASS_MASS);
932 return (USB_ERR_INVAL);
935 case MSC_EJECT_STOPUNIT:
936 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
937 &scsi_test_unit_ready, sizeof(scsi_test_unit_ready),
939 DPRINTF("Test unit ready status: %s\n", usbd_errstr(err));
940 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
941 &scsi_start_stop_unit, sizeof(scsi_start_stop_unit),
944 case MSC_EJECT_REZERO:
945 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
946 &scsi_rezero_init, sizeof(scsi_rezero_init),
949 case MSC_EJECT_ZTESTOR:
950 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
951 &scsi_ztestor_eject, sizeof(scsi_ztestor_eject),
954 case MSC_EJECT_CMOTECH:
955 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
956 &scsi_cmotech_eject, sizeof(scsi_cmotech_eject),
959 case MSC_EJECT_HUAWEI:
960 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
961 &scsi_huawei_eject, sizeof(scsi_huawei_eject),
964 case MSC_EJECT_HUAWEI2:
965 err = bbb_command_start(sc, DIR_IN, 0, NULL, 0,
966 &scsi_huawei_eject2, sizeof(scsi_huawei_eject2),
971 * TCTMobile needs DIR_IN flag. To get it, we
972 * supply a dummy data with the command.
974 err = bbb_command_start(sc, DIR_IN, 0, sc->buffer,
975 sc->buffer_size, &scsi_tct_eject,
976 sizeof(scsi_tct_eject), USB_MS_HZ);
979 DPRINTF("Unknown eject method (%d)\n", method);
981 return (USB_ERR_INVAL);
984 DPRINTF("Eject CD command status: %s\n", usbd_errstr(err));
991 usb_dymo_eject(struct usb_device *udev, uint8_t iface_index)
993 static const uint8_t data[3] = { 0x1b, 0x5a, 0x01 };
994 struct bbb_transfer *sc;
997 sc = bbb_attach(udev, iface_index, UICLASS_HID);
999 return (USB_ERR_INVAL);
1000 err = bbb_raw_write(sc, data, sizeof(data), USB_MS_HZ);