diff options
Diffstat (limited to 'sys/dev/usb2/storage')
| -rw-r--r-- | sys/dev/usb2/storage/ata-usb2.c | 1103 | ||||
| -rw-r--r-- | sys/dev/usb2/storage/umass2.c | 3620 | ||||
| -rw-r--r-- | sys/dev/usb2/storage/urio2.c | 480 | ||||
| -rw-r--r-- | sys/dev/usb2/storage/usb2_storage.c | 31 | ||||
| -rw-r--r-- | sys/dev/usb2/storage/usb2_storage.h | 30 | ||||
| -rw-r--r-- | sys/dev/usb2/storage/ustorage2_fs.c | 1898 |
6 files changed, 0 insertions, 7162 deletions
diff --git a/sys/dev/usb2/storage/ata-usb2.c b/sys/dev/usb2/storage/ata-usb2.c deleted file mode 100644 index a4d2da4..0000000 --- a/sys/dev/usb2/storage/ata-usb2.c +++ /dev/null @@ -1,1103 +0,0 @@ -/*- - * Copyright (c) 2006 - 2008 Søren Schmidt <sos@FreeBSD.org> - * All rights reserved. - * - * Copyright (c) 2006 Hans Petter Selasky - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer, - * without modification, immediately at the beginning of the file. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -#include <sys/cdefs.h> -__FBSDID("$FreeBSD$"); - -#include "usbdevs.h" -#include <dev/usb2/include/usb2_standard.h> -#include <dev/usb2/include/usb2_mfunc.h> -#include <dev/usb2/include/usb2_error.h> - -#include <dev/usb2/core/usb2_core.h> -#include <dev/usb2/core/usb2_util.h> -#include <dev/usb2/core/usb2_busdma.h> -#include <dev/usb2/core/usb2_request.h> -#include <dev/usb2/core/usb2_debug.h> -#include <dev/usb2/core/usb2_process.h> -#include <dev/usb2/core/usb2_transfer.h> - -#include <sys/ata.h> -#include <sys/bio.h> -#include <sys/sema.h> -#include <sys/taskqueue.h> -#include <vm/uma.h> - -#include <dev/ata/ata-all.h> -#include <ata_if.h> - -#define ATAUSB_BULK_SIZE (1<<17) - -/* Command Block Wrapper */ -struct bbb_cbw { - uint8_t signature[4]; -#define CBWSIGNATURE 0x43425355 - - uint8_t tag[4]; - uint8_t transfer_length[4]; - uint8_t flags; -#define CBWFLAGS_OUT 0x00 -#define CBWFLAGS_IN 0x80 - - uint8_t lun; - uint8_t length; -#define CBWCDBLENGTH 16 - - uint8_t cdb[CBWCDBLENGTH]; -} __packed; - -/* Command Status Wrapper */ -struct bbb_csw { - uint8_t signature[4]; -#define CSWSIGNATURE 0x53425355 - - uint8_t tag[4]; - uint8_t residue[4]; - uint8_t status; -#define CSWSTATUS_GOOD 0x0 -#define CSWSTATUS_FAILED 0x1 -#define CSWSTATUS_PHASE 0x2 -} __packed; - -/* USB-ATA 'controller' softc */ -struct atausb2_softc { - struct bbb_cbw cbw; - struct bbb_csw csw; - struct mtx locked_mtx; - - struct ata_channel *locked_ch; - struct ata_channel *restart_ch; - struct ata_request *ata_request; - -#define ATAUSB_T_BBB_RESET1 0 -#define ATAUSB_T_BBB_RESET2 1 -#define ATAUSB_T_BBB_RESET3 2 -#define ATAUSB_T_BBB_COMMAND 3 -#define ATAUSB_T_BBB_DATA_READ 4 -#define ATAUSB_T_BBB_DATA_RD_CS 5 -#define ATAUSB_T_BBB_DATA_WRITE 6 -#define ATAUSB_T_BBB_DATA_WR_CS 7 -#define ATAUSB_T_BBB_STATUS 8 -#define ATAUSB_T_BBB_MAX 9 - -#define ATAUSB_T_MAX ATAUSB_T_BBB_MAX - - struct usb2_xfer *xfer[ATAUSB_T_MAX]; - caddr_t ata_data; - device_t dev; - - uint32_t timeout; - uint32_t ata_donecount; - uint32_t ata_bytecount; - - uint8_t last_xfer_no; - uint8_t usb2_speed; - uint8_t intr_stalled; - uint8_t maxlun; - uint8_t iface_no; - uint8_t status_try; -}; - -static const int atausbdebug = 0; - -/* prototypes */ - -static device_probe_t atausb2_probe; -static device_attach_t atausb2_attach; -static device_detach_t atausb2_detach; - -static usb2_callback_t atausb2_t_bbb_reset1_callback; -static usb2_callback_t atausb2_t_bbb_reset2_callback; -static usb2_callback_t atausb2_t_bbb_reset3_callback; -static usb2_callback_t atausb2_t_bbb_command_callback; -static usb2_callback_t atausb2_t_bbb_data_read_callback; -static usb2_callback_t atausb2_t_bbb_data_rd_cs_callback; -static usb2_callback_t atausb2_t_bbb_data_write_callback; -static usb2_callback_t atausb2_t_bbb_data_wr_cs_callback; -static usb2_callback_t atausb2_t_bbb_status_callback; -static usb2_callback_t atausb2_tr_error; - -static void atausb2_cancel_request(struct atausb2_softc *sc); -static void atausb2_transfer_start(struct atausb2_softc *sc, uint8_t xfer_no); -static void atausb2_t_bbb_data_clear_stall_callback(struct usb2_xfer *xfer, uint8_t next_xfer, uint8_t stall_xfer); -static int ata_usbchannel_begin_transaction(struct ata_request *request); -static int ata_usbchannel_end_transaction(struct ata_request *request); - -static device_probe_t ata_usbchannel_probe; -static device_attach_t ata_usbchannel_attach; -static device_detach_t ata_usbchannel_detach; - -static ata_setmode_t ata_usbchannel_setmode; -static ata_locking_t ata_usbchannel_locking; - -/* - * USB frontend part - */ - -struct usb2_config atausb2_config[ATAUSB_T_BBB_MAX] = { - - [ATAUSB_T_BBB_RESET1] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &atausb2_t_bbb_reset1_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 500, /* 500 milliseconds */ - }, - - [ATAUSB_T_BBB_RESET2] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &atausb2_t_bbb_reset2_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 50, /* 50 milliseconds */ - }, - - [ATAUSB_T_BBB_RESET3] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &atausb2_t_bbb_reset3_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 50, /* 50 milliseconds */ - }, - - [ATAUSB_T_BBB_COMMAND] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .mh.bufsize = sizeof(struct bbb_cbw), - .mh.flags = {}, - .mh.callback = &atausb2_t_bbb_command_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [ATAUSB_T_BBB_DATA_READ] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .mh.bufsize = ATAUSB_BULK_SIZE, - .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,}, - .mh.callback = &atausb2_t_bbb_data_read_callback, - .mh.timeout = 0, /* overwritten later */ - }, - - [ATAUSB_T_BBB_DATA_RD_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &atausb2_t_bbb_data_rd_cs_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [ATAUSB_T_BBB_DATA_WRITE] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .mh.bufsize = ATAUSB_BULK_SIZE, - .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,}, - .mh.callback = &atausb2_t_bbb_data_write_callback, - .mh.timeout = 0, /* overwritten later */ - }, - - [ATAUSB_T_BBB_DATA_WR_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &atausb2_t_bbb_data_wr_cs_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [ATAUSB_T_BBB_STATUS] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .mh.bufsize = sizeof(struct bbb_csw), - .mh.flags = {.short_xfer_ok = 1,}, - .mh.callback = &atausb2_t_bbb_status_callback, - .mh.timeout = 5000, /* ms */ - }, -}; - -static devclass_t atausb2_devclass; - -static device_method_t atausb2_methods[] = { - DEVMETHOD(device_probe, atausb2_probe), - DEVMETHOD(device_attach, atausb2_attach), - DEVMETHOD(device_detach, atausb2_detach), - {0, 0} -}; - -static driver_t atausb2_driver = { - .name = "atausb", - .methods = atausb2_methods, - .size = sizeof(struct atausb2_softc), -}; - -DRIVER_MODULE(atausb, ushub, atausb2_driver, atausb2_devclass, 0, 0); -MODULE_DEPEND(atausb, usb2_storage, 1, 1, 1); -MODULE_DEPEND(atausb, usb2_core, 1, 1, 1); -MODULE_VERSION(atausb, 1); - -static int -atausb2_probe(device_t dev) -{ - struct usb2_attach_arg *uaa = device_get_ivars(dev); - struct usb2_interface_descriptor *id; - - if (uaa->usb2_mode != USB_MODE_HOST) { - return (ENXIO); - } - if (uaa->use_generic == 0) { - /* give other drivers a try first */ - return (ENXIO); - } - id = usb2_get_interface_descriptor(uaa->iface); - if ((!id) || (id->bInterfaceClass != UICLASS_MASS)) { - return (ENXIO); - } - switch (id->bInterfaceSubClass) { - case UISUBCLASS_QIC157: - case UISUBCLASS_RBC: - case UISUBCLASS_SCSI: - case UISUBCLASS_SFF8020I: - case UISUBCLASS_SFF8070I: - case UISUBCLASS_UFI: - switch (id->bInterfaceProtocol) { - case UIPROTO_MASS_CBI: - case UIPROTO_MASS_CBI_I: - case UIPROTO_MASS_BBB: - case UIPROTO_MASS_BBB_OLD: - return (0); - default: - return (0); - } - break; - default: - return (0); - } -} - -static int -atausb2_attach(device_t dev) -{ - struct atausb2_softc *sc = device_get_softc(dev); - struct usb2_attach_arg *uaa = device_get_ivars(dev); - struct usb2_interface_descriptor *id; - const char *proto, *subclass; - struct usb2_device_request request; - uint16_t i; - uint8_t maxlun; - uint8_t has_intr; - int err; - - device_set_usb2_desc(dev); - - sc->dev = dev; - sc->maxlun = 0; - sc->locked_ch = NULL; - sc->restart_ch = NULL; - sc->usb2_speed = usb2_get_speed(uaa->device); - mtx_init(&sc->locked_mtx, "ATAUSB lock", NULL, (MTX_DEF | MTX_RECURSE)); - - id = usb2_get_interface_descriptor(uaa->iface); - switch (id->bInterfaceProtocol) { - case UIPROTO_MASS_BBB: - case UIPROTO_MASS_BBB_OLD: - proto = "Bulk-Only"; - break; - case UIPROTO_MASS_CBI: - proto = "CBI"; - break; - case UIPROTO_MASS_CBI_I: - proto = "CBI with CCI"; - break; - default: - proto = "Unknown"; - } - - switch (id->bInterfaceSubClass) { - case UISUBCLASS_RBC: - subclass = "RBC"; - break; - case UISUBCLASS_QIC157: - case UISUBCLASS_SFF8020I: - case UISUBCLASS_SFF8070I: - subclass = "ATAPI"; - break; - case UISUBCLASS_SCSI: - subclass = "SCSI"; - break; - case UISUBCLASS_UFI: - subclass = "UFI"; - break; - default: - subclass = "Unknown"; - } - - has_intr = (id->bInterfaceProtocol == UIPROTO_MASS_CBI_I); - sc->iface_no = id->bInterfaceNumber; - - device_printf(dev, "using %s over %s\n", subclass, proto); - if (strcmp(proto, "Bulk-Only") || - (strcmp(subclass, "ATAPI") && strcmp(subclass, "SCSI"))) { - goto detach; - } - err = usb2_transfer_setup(uaa->device, &uaa->info.bIfaceIndex, - sc->xfer, atausb2_config, ATAUSB_T_BBB_MAX, sc, - &sc->locked_mtx); - - /* skip reset first time */ - sc->last_xfer_no = ATAUSB_T_BBB_COMMAND; - - if (err) { - device_printf(sc->dev, "could not setup required " - "transfers, %s\n", usb2_errstr(err)); - goto detach; - } - /* get number of devices so we can add matching channels */ - request.bmRequestType = UT_READ_CLASS_INTERFACE; - request.bRequest = 0xfe; /* GET_MAX_LUN; */ - USETW(request.wValue, 0); - USETW(request.wIndex, sc->iface_no); - USETW(request.wLength, sizeof(maxlun)); - err = usb2_do_request(uaa->device, &Giant, &request, &maxlun); - - if (err) { - if (bootverbose) { - device_printf(sc->dev, "get maxlun not supported %s\n", - usb2_errstr(err)); - } - } else { - sc->maxlun = maxlun; - if (bootverbose) { - device_printf(sc->dev, "maxlun=%d\n", sc->maxlun); - } - } - - /* ata channels are children to this USB control device */ - for (i = 0; i <= sc->maxlun; i++) { - if (!device_add_child(sc->dev, "ata", - devclass_find_free_unit(ata_devclass, 2))) { - device_printf(sc->dev, "failed to attach ata child device\n"); - goto detach; - } - } - bus_generic_attach(sc->dev); - - return (0); - -detach: - atausb2_detach(dev); - return (ENXIO); -} - -static int -atausb2_detach(device_t dev) -{ - struct atausb2_softc *sc = device_get_softc(dev); - device_t *children; - int nchildren, i; - - /* teardown our statemachine */ - - usb2_transfer_unsetup(sc->xfer, ATAUSB_T_MAX); - - /* detach & delete all children, if any */ - - if (!device_get_children(dev, &children, &nchildren)) { - for (i = 0; i < nchildren; i++) { - device_delete_child(dev, children[i]); - } - free(children, M_TEMP); - } - mtx_destroy(&sc->locked_mtx); - return (0); -} - -static void -atausb2_transfer_start(struct atausb2_softc *sc, uint8_t xfer_no) -{ - if (atausbdebug) { - device_printf(sc->dev, "BBB transfer %d\n", xfer_no); - } - if (sc->xfer[xfer_no]) { - sc->last_xfer_no = xfer_no; - usb2_transfer_start(sc->xfer[xfer_no]); - } else { - atausb2_cancel_request(sc); - } -} - -static void -atausb2_t_bbb_reset1_callback(struct usb2_xfer *xfer) -{ - struct atausb2_softc *sc = xfer->priv_sc; - struct usb2_device_request req; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - atausb2_transfer_start(sc, ATAUSB_T_BBB_RESET2); - return; - - case USB_ST_SETUP: - req.bmRequestType = UT_WRITE_CLASS_INTERFACE; - req.bRequest = 0xff; /* bulk-only reset */ - USETW(req.wValue, 0); - req.wIndex[0] = sc->iface_no; - req.wIndex[1] = 0; - USETW(req.wLength, 0); - - usb2_copy_in(xfer->frbuffers, 0, &req, sizeof(req)); - - xfer->frlengths[0] = sizeof(req); - xfer->nframes = 1; - usb2_start_hardware(xfer); - return; - - default: /* Error */ - atausb2_tr_error(xfer); - return; - - } -} - -static void -atausb2_t_bbb_reset2_callback(struct usb2_xfer *xfer) -{ - atausb2_t_bbb_data_clear_stall_callback(xfer, ATAUSB_T_BBB_RESET3, - ATAUSB_T_BBB_DATA_READ); -} - -static void -atausb2_t_bbb_reset3_callback(struct usb2_xfer *xfer) -{ - atausb2_t_bbb_data_clear_stall_callback(xfer, ATAUSB_T_BBB_COMMAND, - ATAUSB_T_BBB_DATA_WRITE); -} - -static void -atausb2_t_bbb_data_clear_stall_callback(struct usb2_xfer *xfer, - uint8_t next_xfer, - uint8_t stall_xfer) -{ - struct atausb2_softc *sc = xfer->priv_sc; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: -tr_transferred: - atausb2_transfer_start(sc, next_xfer); - return; - - case USB_ST_SETUP: - if (usb2_clear_stall_callback(xfer, sc->xfer[stall_xfer])) { - goto tr_transferred; - } - return; - - default: /* Error */ - atausb2_tr_error(xfer); - return; - - } -} - -static void -atausb2_t_bbb_command_callback(struct usb2_xfer *xfer) -{ - struct atausb2_softc *sc = xfer->priv_sc; - struct ata_request *request = sc->ata_request; - struct ata_channel *ch; - uint32_t tag; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - atausb2_transfer_start - (sc, ((request->flags & ATA_R_READ) ? ATAUSB_T_BBB_DATA_READ : - (request->flags & ATA_R_WRITE) ? ATAUSB_T_BBB_DATA_WRITE : - ATAUSB_T_BBB_STATUS)); - return; - - case USB_ST_SETUP: - - sc->status_try = 0; - - if (request) { - ch = device_get_softc(request->parent); - - sc->timeout = (request->timeout * 1000) + 5000; - - tag = UGETDW(sc->cbw.tag) + 1; - - USETDW(sc->cbw.signature, CBWSIGNATURE); - USETDW(sc->cbw.tag, tag); - USETDW(sc->cbw.transfer_length, request->bytecount); - sc->cbw.flags = (request->flags & ATA_R_READ) ? CBWFLAGS_IN : CBWFLAGS_OUT; - sc->cbw.lun = ch->unit; - sc->cbw.length = 16; - bzero(sc->cbw.cdb, 16); - bcopy(request->u.atapi.ccb, sc->cbw.cdb, 12); /* XXX SOS */ - - usb2_copy_in(xfer->frbuffers, 0, &sc->cbw, sizeof(sc->cbw)); - - xfer->frlengths[0] = sizeof(sc->cbw); - usb2_start_hardware(xfer); - } - return; - - default: /* Error */ - atausb2_tr_error(xfer); - return; - - } -} - -static void -atausb2_t_bbb_data_read_callback(struct usb2_xfer *xfer) -{ - struct atausb2_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - - usb2_copy_out(xfer->frbuffers, 0, - sc->ata_data, xfer->actlen); - - sc->ata_bytecount -= xfer->actlen; - sc->ata_data += xfer->actlen; - sc->ata_donecount += xfer->actlen; - - if (xfer->actlen < xfer->sumlen) { - /* short transfer */ - sc->ata_bytecount = 0; - } - case USB_ST_SETUP: - - if (atausbdebug > 1) { - device_printf(sc->dev, "%s: max_bulk=%d, ata_bytecount=%d\n", - __FUNCTION__, max_bulk, sc->ata_bytecount); - } - if (sc->ata_bytecount == 0) { - atausb2_transfer_start(sc, ATAUSB_T_BBB_STATUS); - return; - } - if (max_bulk > sc->ata_bytecount) { - max_bulk = sc->ata_bytecount; - } - xfer->timeout = sc->timeout; - xfer->frlengths[0] = max_bulk; - - usb2_start_hardware(xfer); - return; - - default: /* Error */ - if (xfer->error == USB_ERR_CANCELLED) { - atausb2_tr_error(xfer); - } else { - atausb2_transfer_start(sc, ATAUSB_T_BBB_DATA_RD_CS); - } - return; - - } -} - -static void -atausb2_t_bbb_data_rd_cs_callback(struct usb2_xfer *xfer) -{ - atausb2_t_bbb_data_clear_stall_callback(xfer, ATAUSB_T_BBB_STATUS, - ATAUSB_T_BBB_DATA_READ); -} - -static void -atausb2_t_bbb_data_write_callback(struct usb2_xfer *xfer) -{ - struct atausb2_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - - sc->ata_bytecount -= xfer->actlen; - sc->ata_data += xfer->actlen; - sc->ata_donecount += xfer->actlen; - - case USB_ST_SETUP: - - if (atausbdebug > 1) { - device_printf(sc->dev, "%s: max_bulk=%d, ata_bytecount=%d\n", - __FUNCTION__, max_bulk, sc->ata_bytecount); - } - if (sc->ata_bytecount == 0) { - atausb2_transfer_start(sc, ATAUSB_T_BBB_STATUS); - return; - } - if (max_bulk > sc->ata_bytecount) { - max_bulk = sc->ata_bytecount; - } - xfer->timeout = sc->timeout; - xfer->frlengths[0] = max_bulk; - - usb2_copy_in(xfer->frbuffers, 0, - sc->ata_data, max_bulk); - - usb2_start_hardware(xfer); - return; - - default: /* Error */ - if (xfer->error == USB_ERR_CANCELLED) { - atausb2_tr_error(xfer); - } else { - atausb2_transfer_start(sc, ATAUSB_T_BBB_DATA_WR_CS); - } - return; - - } -} - -static void -atausb2_t_bbb_data_wr_cs_callback(struct usb2_xfer *xfer) -{ - atausb2_t_bbb_data_clear_stall_callback(xfer, ATAUSB_T_BBB_STATUS, - ATAUSB_T_BBB_DATA_WRITE); -} - -static void -atausb2_t_bbb_status_callback(struct usb2_xfer *xfer) -{ - struct atausb2_softc *sc = xfer->priv_sc; - struct ata_request *request = sc->ata_request; - uint32_t residue; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - - if (xfer->actlen < sizeof(sc->csw)) { - bzero(&sc->csw, sizeof(sc->csw)); - } - usb2_copy_out(xfer->frbuffers, 0, &sc->csw, xfer->actlen); - - if (request->flags & (ATA_R_READ | ATA_R_WRITE)) { - request->donecount = sc->ata_donecount; - } - residue = UGETDW(sc->csw.residue); - - if (!residue) { - residue = (request->bytecount - request->donecount); - } - if (residue > request->bytecount) { - if (atausbdebug) { - device_printf(sc->dev, "truncating residue from %d " - "to %d bytes\n", residue, - request->bytecount); - } - residue = request->bytecount; - } - /* check CSW and handle eventual error */ - if (UGETDW(sc->csw.signature) != CSWSIGNATURE) { - if (atausbdebug) { - device_printf(sc->dev, "bad CSW signature 0x%08x != 0x%08x\n", - UGETDW(sc->csw.signature), CSWSIGNATURE); - } - goto tr_error; - } else if (UGETDW(sc->csw.tag) != UGETDW(sc->cbw.tag)) { - if (atausbdebug) { - device_printf(sc->dev, "bad CSW tag %d != %d\n", - UGETDW(sc->csw.tag), UGETDW(sc->cbw.tag)); - } - goto tr_error; - } else if (sc->csw.status > CSWSTATUS_PHASE) { - if (atausbdebug) { - device_printf(sc->dev, "bad CSW status %d > %d\n", - sc->csw.status, CSWSTATUS_PHASE); - } - goto tr_error; - } else if (sc->csw.status == CSWSTATUS_PHASE) { - if (atausbdebug) { - device_printf(sc->dev, "phase error residue = %d\n", residue); - } - goto tr_error; - } else if (request->donecount > request->bytecount) { - if (atausbdebug) { - device_printf(sc->dev, "buffer overrun %d > %d\n", - request->donecount, request->bytecount); - } - goto tr_error; - } else if (sc->csw.status == CSWSTATUS_FAILED) { - if (atausbdebug) { - device_printf(sc->dev, "CSWSTATUS_FAILED\n"); - } - request->error = ATA_E_ATAPI_SENSE_MASK; - } - sc->last_xfer_no = ATAUSB_T_BBB_COMMAND; - - sc->ata_request = NULL; - - /* drop the USB transfer lock while doing the ATA interrupt */ - mtx_unlock(&sc->locked_mtx); - - ata_interrupt(device_get_softc(request->parent)); - - mtx_lock(&sc->locked_mtx); - return; - - case USB_ST_SETUP: - xfer->frlengths[0] = xfer->max_data_length; - usb2_start_hardware(xfer); - return; - - default: -tr_error: - if ((xfer->error == USB_ERR_CANCELLED) || - (sc->status_try)) { - atausb2_tr_error(xfer); - } else { - sc->status_try = 1; - atausb2_transfer_start(sc, ATAUSB_T_BBB_DATA_RD_CS); - } - return; - - } -} - -static void -atausb2_cancel_request(struct atausb2_softc *sc) -{ - struct ata_request *request; - - mtx_assert(&sc->locked_mtx, MA_OWNED); - - request = sc->ata_request; - sc->ata_request = NULL; - sc->last_xfer_no = ATAUSB_T_BBB_RESET1; - - if (request) { - request->error = ATA_E_ATAPI_SENSE_MASK; - - mtx_unlock(&sc->locked_mtx); - - ata_interrupt(device_get_softc(request->parent)); - - mtx_lock(&sc->locked_mtx); - } -} - -static void -atausb2_tr_error(struct usb2_xfer *xfer) -{ - struct atausb2_softc *sc = xfer->priv_sc; - - if (xfer->error != USB_ERR_CANCELLED) { - - if (atausbdebug) { - device_printf(sc->dev, "transfer failed, %s, in state %d " - "-> BULK reset\n", usb2_errstr(xfer->error), - sc->last_xfer_no); - } - } - atausb2_cancel_request(sc); -} - -/* - * ATA backend part - */ -struct atapi_inquiry { - uint8_t device_type; - uint8_t device_modifier; - uint8_t version; - uint8_t response_format; - uint8_t length; - uint8_t reserved[2]; - uint8_t flags; - uint8_t vendor[8]; - uint8_t product[16]; - uint8_t revision[4]; - /* uint8_t crap[60]; */ -} __packed; - -static int -ata_usbchannel_begin_transaction(struct ata_request *request) -{ - struct atausb2_softc *sc = - device_get_softc(device_get_parent(request->parent)); - int error; - - if (atausbdebug > 1) { - device_printf(request->dev, "begin_transaction %s\n", - ata_cmd2str(request)); - } - mtx_lock(&sc->locked_mtx); - - /* sanity, just in case */ - if (sc->ata_request) { - device_printf(request->dev, "begin is busy, " - "state = %d\n", sc->last_xfer_no); - request->result = EBUSY; - error = ATA_OP_FINISHED; - goto done; - } - /* - * XXX SOS convert the request into the format used, only BBB for - * now - */ - - /* ATA/ATAPI IDENTIFY needs special treatment */ - if (!(request->flags & ATA_R_ATAPI)) { - if (request->u.ata.command != ATA_ATAPI_IDENTIFY) { - device_printf(request->dev, "%s unsupported\n", - ata_cmd2str(request)); - request->result = EIO; - error = ATA_OP_FINISHED; - goto done; - } - request->flags |= ATA_R_ATAPI; - bzero(request->u.atapi.ccb, 16); - request->u.atapi.ccb[0] = ATAPI_INQUIRY; - request->u.atapi.ccb[4] = 255; /* sizeof(struct - * atapi_inquiry); */ - request->data += 256; /* arbitrary offset into ata_param */ - request->bytecount = 255; /* sizeof(struct - * atapi_inquiry); */ - } - if (sc->xfer[sc->last_xfer_no]) { - - sc->ata_request = request; - sc->ata_bytecount = request->bytecount; - sc->ata_data = request->data; - sc->ata_donecount = 0; - - usb2_transfer_start(sc->xfer[sc->last_xfer_no]); - error = ATA_OP_CONTINUES; - } else { - request->result = EIO; - error = ATA_OP_FINISHED; - } - -done: - mtx_unlock(&sc->locked_mtx); - return (error); -} - -static int -ata_usbchannel_end_transaction(struct ata_request *request) -{ - if (atausbdebug > 1) { - device_printf(request->dev, "end_transaction %s\n", - ata_cmd2str(request)); - } - /* - * XXX SOS convert the request from the format used, only BBB for - * now - */ - - /* ATA/ATAPI IDENTIFY needs special treatment */ - if ((request->flags & ATA_R_ATAPI) && - (request->u.atapi.ccb[0] == ATAPI_INQUIRY)) { - struct ata_device *atadev = device_get_softc(request->dev); - struct atapi_inquiry *inquiry = (struct atapi_inquiry *)request->data; - uint16_t *ptr; - - /* convert inquiry data into simple ata_param like format */ - atadev->param.config = ATA_PROTO_ATAPI | ATA_PROTO_ATAPI_12; - atadev->param.config |= (inquiry->device_type & 0x1f) << 8; - bzero(atadev->param.model, sizeof(atadev->param.model)); - strncpy(atadev->param.model, inquiry->vendor, 8); - strcpy(atadev->param.model, " "); - strncpy(atadev->param.model, inquiry->product, 16); - ptr = (uint16_t *)(atadev->param.model + sizeof(atadev->param.model)); - while (--ptr >= (uint16_t *)atadev->param.model) { - *ptr = ntohs(*ptr); - } - strncpy(atadev->param.revision, inquiry->revision, 4); - ptr = (uint16_t *)(atadev->param.revision + sizeof(atadev->param.revision)); - while (--ptr >= (uint16_t *)atadev->param.revision) { - *ptr = ntohs(*ptr); - } - request->result = 0; - } - return (ATA_OP_FINISHED); -} - -static int -ata_usbchannel_probe(device_t dev) -{ - struct ata_channel *ch = device_get_softc(dev); - device_t *children; - int count, i; - char buffer[32]; - - /* take care of green memory */ - bzero(ch, sizeof(struct ata_channel)); - - /* find channel number on this controller */ - if (!device_get_children(device_get_parent(dev), &children, &count)) { - for (i = 0; i < count; i++) { - if (children[i] == dev) - ch->unit = i; - } - free(children, M_TEMP); - } - snprintf(buffer, sizeof(buffer), "USB lun %d", ch->unit); - device_set_desc_copy(dev, buffer); - - return (0); -} - -static int -ata_usbchannel_attach(device_t dev) -{ - struct ata_channel *ch = device_get_softc(dev); - - /* initialize the softc basics */ - ch->dev = dev; - ch->state = ATA_IDLE; - ch->hw.begin_transaction = ata_usbchannel_begin_transaction; - ch->hw.end_transaction = ata_usbchannel_end_transaction; - ch->hw.status = NULL; - ch->hw.command = NULL; - bzero(&ch->state_mtx, sizeof(struct mtx)); - mtx_init(&ch->state_mtx, "ATA state lock", NULL, MTX_DEF); - bzero(&ch->queue_mtx, sizeof(struct mtx)); - mtx_init(&ch->queue_mtx, "ATA queue lock", NULL, MTX_DEF); - TAILQ_INIT(&ch->ata_queue); - - /* XXX SOS reset the controller HW, the channel and device(s) */ - /* ATA_RESET(dev); */ - - /* probe and attach device on this channel */ - ch->devices = ATA_ATAPI_MASTER; - if (!ata_delayed_attach) { - ata_identify(dev); - } - return (0); -} - -static int -ata_usbchannel_detach(device_t dev) -{ - struct ata_channel *ch = device_get_softc(dev); - device_t *children; - int nchildren, i; - - /* detach & delete all children */ - if (!device_get_children(dev, &children, &nchildren)) { - for (i = 0; i < nchildren; i++) - if (children[i]) - device_delete_child(dev, children[i]); - free(children, M_TEMP); - } - mtx_destroy(&ch->state_mtx); - mtx_destroy(&ch->queue_mtx); - return (0); -} - -static void -ata_usbchannel_setmode(device_t parent, device_t dev) -{ - struct atausb2_softc *sc = device_get_softc(GRANDPARENT(dev)); - struct ata_device *atadev = device_get_softc(dev); - - if (sc->usb2_speed == USB_SPEED_HIGH) - atadev->mode = ATA_USB2; - else - atadev->mode = ATA_USB1; -} - -static int -ata_usbchannel_locking(device_t dev, int flags) -{ - struct atausb2_softc *sc = device_get_softc(device_get_parent(dev)); - struct ata_channel *ch = device_get_softc(dev); - int res = -1; - - mtx_lock(&sc->locked_mtx); - switch (flags) { - case ATA_LF_LOCK: - if (sc->locked_ch == NULL) - sc->locked_ch = ch; - if (sc->locked_ch != ch) - sc->restart_ch = ch; - break; - - case ATA_LF_UNLOCK: - if (sc->locked_ch == ch) { - sc->locked_ch = NULL; - if (sc->restart_ch) { - ch = sc->restart_ch; - sc->restart_ch = NULL; - mtx_unlock(&sc->locked_mtx); - ata_start(ch->dev); - return (res); - } - } - break; - - case ATA_LF_WHICH: - break; - } - if (sc->locked_ch) { - res = sc->locked_ch->unit; - } - mtx_unlock(&sc->locked_mtx); - return (res); -} - -static device_method_t ata_usbchannel_methods[] = { - /* device interface */ - DEVMETHOD(device_probe, ata_usbchannel_probe), - DEVMETHOD(device_attach, ata_usbchannel_attach), - DEVMETHOD(device_detach, ata_usbchannel_detach), - - /* ATA methods */ - DEVMETHOD(ata_setmode, ata_usbchannel_setmode), - DEVMETHOD(ata_locking, ata_usbchannel_locking), - /* DEVMETHOD(ata_reset, ata_usbchannel_reset), */ - - {0, 0} -}; - -static driver_t ata_usbchannel_driver = { - "ata", - ata_usbchannel_methods, - sizeof(struct ata_channel), -}; - -DRIVER_MODULE(ata, atausb, ata_usbchannel_driver, ata_devclass, 0, 0); -MODULE_DEPEND(atausb, ata, 1, 1, 1); diff --git a/sys/dev/usb2/storage/umass2.c b/sys/dev/usb2/storage/umass2.c deleted file mode 100644 index ff83290..0000000 --- a/sys/dev/usb2/storage/umass2.c +++ /dev/null @@ -1,3620 +0,0 @@ -#include <sys/cdefs.h> -__FBSDID("$FreeBSD$"); - -/*- - * Copyright (c) 1999 MAEKAWA Masahide <bishop@rr.iij4u.or.jp>, - * Nick Hibma <n_hibma@freebsd.org> - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND - * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS - * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - * - * $FreeBSD$ - * $NetBSD: umass.c,v 1.28 2000/04/02 23:46:53 augustss Exp $ - */ - -/* Also already merged from NetBSD: - * $NetBSD: umass.c,v 1.67 2001/11/25 19:05:22 augustss Exp $ - * $NetBSD: umass.c,v 1.90 2002/11/04 19:17:33 pooka Exp $ - * $NetBSD: umass.c,v 1.108 2003/11/07 17:03:25 wiz Exp $ - * $NetBSD: umass.c,v 1.109 2003/12/04 13:57:31 keihan Exp $ - */ - -/* - * Universal Serial Bus Mass Storage Class specs: - * http://www.usb.org/developers/devclass_docs/usb_msc_overview_1.2.pdf - * http://www.usb.org/developers/devclass_docs/usbmassbulk_10.pdf - * http://www.usb.org/developers/devclass_docs/usb_msc_cbi_1.1.pdf - * http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf - */ - -/* - * Ported to NetBSD by Lennart Augustsson <augustss@NetBSD.org>. - * Parts of the code written by Jason R. Thorpe <thorpej@shagadelic.org>. - */ - -/* - * The driver handles 3 Wire Protocols - * - Command/Bulk/Interrupt (CBI) - * - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI) - * - Mass Storage Bulk-Only (BBB) - * (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases) - * - * Over these wire protocols it handles the following command protocols - * - SCSI - * - UFI (floppy command set) - * - 8070i (ATAPI) - * - * UFI and 8070i (ATAPI) are transformed versions of the SCSI command set. The - * sc->sc_transform method is used to convert the commands into the appropriate - * format (if at all necessary). For example, UFI requires all commands to be - * 12 bytes in length amongst other things. - * - * The source code below is marked and can be split into a number of pieces - * (in this order): - * - * - probe/attach/detach - * - generic transfer routines - * - BBB - * - CBI - * - CBI_I (in addition to functions from CBI) - * - CAM (Common Access Method) - * - SCSI - * - UFI - * - 8070i (ATAPI) - * - * The protocols are implemented using a state machine, for the transfers as - * well as for the resets. The state machine is contained in umass_t_*_callback. - * The state machine is started through either umass_command_start() or - * umass_reset(). - * - * The reason for doing this is a) CAM performs a lot better this way and b) it - * avoids using tsleep from interrupt context (for example after a failed - * transfer). - */ - -/* - * The SCSI related part of this driver has been derived from the - * dev/ppbus/vpo.c driver, by Nicolas Souchu (nsouch@freebsd.org). - * - * The CAM layer uses so called actions which are messages sent to the host - * adapter for completion. The actions come in through umass_cam_action. The - * appropriate block of routines is called depending on the transport protocol - * in use. When the transfer has finished, these routines call - * umass_cam_cb again to complete the CAM command. - */ - -#include "usbdevs.h" -#include <dev/usb2/include/usb2_standard.h> -#include <dev/usb2/include/usb2_mfunc.h> -#include <dev/usb2/include/usb2_error.h> - -#include <dev/usb2/core/usb2_core.h> -#include <dev/usb2/core/usb2_util.h> -#include <dev/usb2/core/usb2_busdma.h> -#include <dev/usb2/core/usb2_request.h> -#include <dev/usb2/core/usb2_debug.h> -#include <dev/usb2/core/usb2_process.h> -#include <dev/usb2/core/usb2_transfer.h> - -#include <cam/cam.h> -#include <cam/cam_ccb.h> -#include <cam/cam_sim.h> -#include <cam/cam_xpt_sim.h> -#include <cam/scsi/scsi_all.h> -#include <cam/scsi/scsi_da.h> - -#include <cam/cam_periph.h> - -#if 1 -/* this enables loading of virtual buffers into DMA */ -#define UMASS_USB_FLAGS .ext_buffer=1, -#else -#define UMASS_USB_FLAGS -#endif - -#if USB_DEBUG -#define DIF(m, x) \ - do { \ - if (umass_debug & (m)) { x ; } \ - } while (0) - -#define DPRINTF(sc, m, fmt, ...) \ - do { \ - if (umass_debug & (m)) { \ - printf("%s:%s: " fmt, \ - (sc) ? (const char *)(sc)->sc_name : \ - (const char *)"umassX", \ - __FUNCTION__ ,## __VA_ARGS__); \ - } \ - } while (0) - -#define UDMASS_GEN 0x00010000 /* general */ -#define UDMASS_SCSI 0x00020000 /* scsi */ -#define UDMASS_UFI 0x00040000 /* ufi command set */ -#define UDMASS_ATAPI 0x00080000 /* 8070i command set */ -#define UDMASS_CMD (UDMASS_SCSI|UDMASS_UFI|UDMASS_ATAPI) -#define UDMASS_USB 0x00100000 /* USB general */ -#define UDMASS_BBB 0x00200000 /* Bulk-Only transfers */ -#define UDMASS_CBI 0x00400000 /* CBI transfers */ -#define UDMASS_WIRE (UDMASS_BBB|UDMASS_CBI) -#define UDMASS_ALL 0xffff0000 /* all of the above */ -static int umass_debug = 0; - -SYSCTL_NODE(_hw_usb2, OID_AUTO, umass, CTLFLAG_RW, 0, "USB umass"); -SYSCTL_INT(_hw_usb2_umass, OID_AUTO, debug, CTLFLAG_RW, - &umass_debug, 0, "umass debug level"); -#else -#define DIF(...) do { } while (0) -#define DPRINTF(...) do { } while (0) -#endif - -#define UMASS_GONE ((struct umass_softc *)1) - -#define UMASS_BULK_SIZE (1 << 17) -#define UMASS_CBI_DIAGNOSTIC_CMDLEN 12 /* bytes */ -#define UMASS_MAX_CMDLEN MAX(12, CAM_MAX_CDBLEN) /* bytes */ - -/* USB transfer definitions */ - -#define UMASS_T_BBB_RESET1 0 /* Bulk-Only */ -#define UMASS_T_BBB_RESET2 1 -#define UMASS_T_BBB_RESET3 2 -#define UMASS_T_BBB_COMMAND 3 -#define UMASS_T_BBB_DATA_READ 4 -#define UMASS_T_BBB_DATA_RD_CS 5 -#define UMASS_T_BBB_DATA_WRITE 6 -#define UMASS_T_BBB_DATA_WR_CS 7 -#define UMASS_T_BBB_STATUS 8 -#define UMASS_T_BBB_MAX 9 - -#define UMASS_T_CBI_RESET1 0 /* CBI */ -#define UMASS_T_CBI_RESET2 1 -#define UMASS_T_CBI_RESET3 2 -#define UMASS_T_CBI_COMMAND 3 -#define UMASS_T_CBI_DATA_READ 4 -#define UMASS_T_CBI_DATA_RD_CS 5 -#define UMASS_T_CBI_DATA_WRITE 6 -#define UMASS_T_CBI_DATA_WR_CS 7 -#define UMASS_T_CBI_STATUS 8 -#define UMASS_T_CBI_RESET4 9 -#define UMASS_T_CBI_MAX 10 - -#define UMASS_T_MAX MAX(UMASS_T_CBI_MAX, UMASS_T_BBB_MAX) - -/* Generic definitions */ - -/* Direction for transfer */ -#define DIR_NONE 0 -#define DIR_IN 1 -#define DIR_OUT 2 - -/* device name */ -#define DEVNAME "umass" -#define DEVNAME_SIM "umass-sim" - -/* Approximate maximum transfer speeds (assumes 33% overhead). */ -#define UMASS_FULL_TRANSFER_SPEED 1000 -#define UMASS_HIGH_TRANSFER_SPEED 40000 -#define UMASS_FLOPPY_TRANSFER_SPEED 20 - -#define UMASS_TIMEOUT 5000 /* ms */ - -/* CAM specific definitions */ - -#define UMASS_SCSIID_MAX 1 /* maximum number of drives expected */ -#define UMASS_SCSIID_HOST UMASS_SCSIID_MAX - -/* Bulk-Only features */ - -#define UR_BBB_RESET 0xff /* Bulk-Only reset */ -#define UR_BBB_GET_MAX_LUN 0xfe /* Get maximum lun */ - -/* Command Block Wrapper */ -typedef struct { - uDWord dCBWSignature; -#define CBWSIGNATURE 0x43425355 - uDWord dCBWTag; - uDWord dCBWDataTransferLength; - uByte bCBWFlags; -#define CBWFLAGS_OUT 0x00 -#define CBWFLAGS_IN 0x80 - uByte bCBWLUN; - uByte bCDBLength; -#define CBWCDBLENGTH 16 - uByte CBWCDB[CBWCDBLENGTH]; -} __packed umass_bbb_cbw_t; - -#define UMASS_BBB_CBW_SIZE 31 - -/* Command Status Wrapper */ -typedef struct { - uDWord dCSWSignature; -#define CSWSIGNATURE 0x53425355 -#define CSWSIGNATURE_IMAGINATION_DBX1 0x43425355 -#define CSWSIGNATURE_OLYMPUS_C1 0x55425355 - uDWord dCSWTag; - uDWord dCSWDataResidue; - uByte bCSWStatus; -#define CSWSTATUS_GOOD 0x0 -#define CSWSTATUS_FAILED 0x1 -#define CSWSTATUS_PHASE 0x2 -} __packed umass_bbb_csw_t; - -#define UMASS_BBB_CSW_SIZE 13 - -/* CBI features */ - -#define UR_CBI_ADSC 0x00 - -typedef union { - struct { - uint8_t type; -#define IDB_TYPE_CCI 0x00 - uint8_t value; -#define IDB_VALUE_PASS 0x00 -#define IDB_VALUE_FAIL 0x01 -#define IDB_VALUE_PHASE 0x02 -#define IDB_VALUE_PERSISTENT 0x03 -#define IDB_VALUE_STATUS_MASK 0x03 - } __packed common; - - struct { - uint8_t asc; - uint8_t ascq; - } __packed ufi; -} __packed umass_cbi_sbl_t; - -struct umass_softc; /* see below */ - -typedef void (umass_callback_t)(struct umass_softc *sc, union ccb *ccb, - uint32_t residue, uint8_t status); - -#define STATUS_CMD_OK 0 /* everything ok */ -#define STATUS_CMD_UNKNOWN 1 /* will have to fetch sense */ -#define STATUS_CMD_FAILED 2 /* transfer was ok, command failed */ -#define STATUS_WIRE_FAILED 3 /* couldn't even get command across */ - -typedef uint8_t (umass_transform_t)(struct umass_softc *sc, uint8_t *cmd_ptr, - uint8_t cmd_len); - -struct umass_devdescr { - uint32_t vid; -#define VID_WILDCARD 0xffffffff -#define VID_EOT 0xfffffffe - uint32_t pid; -#define PID_WILDCARD 0xffffffff -#define PID_EOT 0xfffffffe - uint32_t rid; -#define RID_WILDCARD 0xffffffff -#define RID_EOT 0xfffffffe - - /* wire and command protocol */ - uint16_t proto; -#define UMASS_PROTO_BBB 0x0001 /* USB wire protocol */ -#define UMASS_PROTO_CBI 0x0002 -#define UMASS_PROTO_CBI_I 0x0004 -#define UMASS_PROTO_WIRE 0x00ff /* USB wire protocol mask */ -#define UMASS_PROTO_SCSI 0x0100 /* command protocol */ -#define UMASS_PROTO_ATAPI 0x0200 -#define UMASS_PROTO_UFI 0x0400 -#define UMASS_PROTO_RBC 0x0800 -#define UMASS_PROTO_COMMAND 0xff00 /* command protocol mask */ - - /* Device specific quirks */ - uint16_t quirks; -#define NO_QUIRKS 0x0000 - /* - * The drive does not support Test Unit Ready. Convert to Start Unit - */ -#define NO_TEST_UNIT_READY 0x0001 - /* - * The drive does not reset the Unit Attention state after REQUEST - * SENSE has been sent. The INQUIRY command does not reset the UA - * either, and so CAM runs in circles trying to retrieve the initial - * INQUIRY data. - */ -#define RS_NO_CLEAR_UA 0x0002 - /* The drive does not support START STOP. */ -#define NO_START_STOP 0x0004 - /* Don't ask for full inquiry data (255b). */ -#define FORCE_SHORT_INQUIRY 0x0008 - /* Needs to be initialised the Shuttle way */ -#define SHUTTLE_INIT 0x0010 - /* Drive needs to be switched to alternate iface 1 */ -#define ALT_IFACE_1 0x0020 - /* Drive does not do 1Mb/s, but just floppy speeds (20kb/s) */ -#define FLOPPY_SPEED 0x0040 - /* The device can't count and gets the residue of transfers wrong */ -#define IGNORE_RESIDUE 0x0080 - /* No GetMaxLun call */ -#define NO_GETMAXLUN 0x0100 - /* The device uses a weird CSWSIGNATURE. */ -#define WRONG_CSWSIG 0x0200 - /* Device cannot handle INQUIRY so fake a generic response */ -#define NO_INQUIRY 0x0400 - /* Device cannot handle INQUIRY EVPD, return CHECK CONDITION */ -#define NO_INQUIRY_EVPD 0x0800 - /* Pad all RBC requests to 12 bytes. */ -#define RBC_PAD_TO_12 0x1000 - /* - * Device reports number of sectors from READ_CAPACITY, not max - * sector number. - */ -#define READ_CAPACITY_OFFBY1 0x2000 - /* - * Device cannot handle a SCSI synchronize cache command. Normally - * this quirk would be handled in the cam layer, but for IDE bridges - * we need to associate the quirk with the bridge and not the - * underlying disk device. This is handled by faking a success - * result. - */ -#define NO_SYNCHRONIZE_CACHE 0x4000 -}; - -static const struct umass_devdescr umass_devdescr[] = { - {USB_VENDOR_ASAHIOPTICAL, PID_WILDCARD, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I, - RS_NO_CLEAR_UA - }, - {USB_VENDOR_ADDON, USB_PRODUCT_ADDON_ATTACHE, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_ADDON, USB_PRODUCT_ADDON_A256MB, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_ADDON, USB_PRODUCT_ADDON_DISKPRO512, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_ADDONICS2, USB_PRODUCT_ADDONICS2_CABLE_205, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_AIPTEK, USB_PRODUCT_AIPTEK_POCKETCAM3M, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_ALCOR, USB_PRODUCT_ALCOR_UMCR_9361, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_GETMAXLUN - }, - {USB_VENDOR_ALCOR, USB_PRODUCT_ALCOR_TRANSCEND, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_GETMAXLUN - }, - {USB_VENDOR_ASAHIOPTICAL, USB_PRODUCT_ASAHIOPTICAL_OPTIO230, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_ASAHIOPTICAL, USB_PRODUCT_ASAHIOPTICAL_OPTIO330, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_USB2SCSI, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_CASIO, USB_PRODUCT_CASIO_QV_DIGICAM, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - NO_INQUIRY - }, - {USB_VENDOR_CCYU, USB_PRODUCT_CCYU_ED1064, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_CENTURY, USB_PRODUCT_CENTURY_EX35QUAT, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_DESKNOTE, USB_PRODUCT_DESKNOTE_UCR_61S2B, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_DMI, USB_PRODUCT_DMI_CFSM_RW, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_GETMAXLUN - }, - {USB_VENDOR_EPSON, USB_PRODUCT_EPSON_STYLUS_875DC, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - NO_INQUIRY - }, - {USB_VENDOR_EPSON, USB_PRODUCT_EPSON_STYLUS_895, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_GETMAXLUN - }, - {USB_VENDOR_FEIYA, USB_PRODUCT_FEIYA_5IN1, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_FREECOM, USB_PRODUCT_FREECOM_DVD, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_FUJIPHOTO, USB_PRODUCT_FUJIPHOTO_MASS0100, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I, - RS_NO_CLEAR_UA - }, - {USB_VENDOR_GENESYS, USB_PRODUCT_GENESYS_GL641USB2IDE, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_GENESYS, USB_PRODUCT_GENESYS_GL641USB2IDE_2, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_GENESYS, USB_PRODUCT_GENESYS_GL641USB, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_GENESYS, USB_PRODUCT_GENESYS_GL641USB_2, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - WRONG_CSWSIG - }, - {USB_VENDOR_HAGIWARA, USB_PRODUCT_HAGIWARA_FG, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_HAGIWARA, USB_PRODUCT_HAGIWARA_FGSM, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_HITACHI, USB_PRODUCT_HITACHI_DVDCAM_DZ_MV100A, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - NO_GETMAXLUN - }, - {USB_VENDOR_HITACHI, USB_PRODUCT_HITACHI_DVDCAM_USB, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I, - NO_INQUIRY - }, - {USB_VENDOR_HP, USB_PRODUCT_HP_CDW4E, RID_WILDCARD, - UMASS_PROTO_ATAPI, - NO_QUIRKS - }, - {USB_VENDOR_HP, USB_PRODUCT_HP_CDW8200, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I, - NO_TEST_UNIT_READY | NO_START_STOP - }, - {USB_VENDOR_IMAGINATION, USB_PRODUCT_IMAGINATION_DBX1, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - WRONG_CSWSIG - }, - {USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_TEST_UNIT_READY | NO_START_STOP | ALT_IFACE_1 - }, - {USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ATAPI, RID_WILDCARD, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_STORAGE_V2, RID_WILDCARD, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_IODATA, USB_PRODUCT_IODATA_IU_CD2, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_IODATA, USB_PRODUCT_IODATA_DVR_UEH8, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP100, RID_WILDCARD, - /* - * XXX This is not correct as there are Zip drives that use - * ATAPI. - */ - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_TEST_UNIT_READY - }, - {USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_L3, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_S3X, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_INQUIRY - }, - {USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_S4, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_INQUIRY - }, - {USB_VENDOR_KYOCERA, USB_PRODUCT_KYOCERA_FINECAM_S5, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_LACIE, USB_PRODUCT_LACIE_HD, RID_WILDCARD, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_LEXAR, USB_PRODUCT_LEXAR_CF_READER, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_LEXAR, USB_PRODUCT_LEXAR_JUMPSHOT, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_LOGITEC, USB_PRODUCT_LOGITEC_LDR_H443SU2, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_LOGITEC, USB_PRODUCT_LOGITEC_LDR_H443U2, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_MELCO, USB_PRODUCT_MELCO_DUBPXXG, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_DPCM, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - NO_TEST_UNIT_READY | NO_START_STOP - }, - {USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_SCSIDB25, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_SCSIHD50, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_E223, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_F300, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_MITSUMI, USB_PRODUCT_MITSUMI_CDRRW, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_MITSUMI, USB_PRODUCT_MITSUMI_FDD, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_GETMAXLUN - }, - {USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_E398, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_INQUIRY_EVPD | NO_GETMAXLUN - }, - {USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE | NO_GETMAXLUN | RS_NO_CLEAR_UA - }, - {USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY2, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_MYSON, USB_PRODUCT_MYSON_HEDEN, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY | IGNORE_RESIDUE - }, - {USB_VENDOR_MYSON, USB_PRODUCT_MYSON_STARREADER, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_SYNCHRONIZE_CACHE - }, - {USB_VENDOR_NEODIO, USB_PRODUCT_NEODIO_ND3260, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY - }, - {USB_VENDOR_NETAC, USB_PRODUCT_NETAC_CF_CARD, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_NETAC, USB_PRODUCT_NETAC_ONLYDISK, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_NETCHIP, USB_PRODUCT_NETCHIP_CLIK_40, RID_WILDCARD, - UMASS_PROTO_ATAPI, - NO_INQUIRY - }, - {USB_VENDOR_NIKON, USB_PRODUCT_NIKON_D300, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - WRONG_CSWSIG - }, - {USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C700, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_GETMAXLUN - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_SDS_HOTFIND_D, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_GETMAXLUN | NO_SYNCHRONIZE_CACHE - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFMS_RW, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFSM_COMBO, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFSM_READER, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_CFSM_READER2, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MDCFE_B_CF_READER, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MDSM_B_READER, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_INQUIRY - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_READER, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_UCF100, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_BBB, - NO_INQUIRY | NO_GETMAXLUN - }, - {USB_VENDOR_ONSPEC2, USB_PRODUCT_ONSPEC2_IMAGEMATE_SDDR55, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_GETMAXLUN - }, - {USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXL840AN, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_BBB, - NO_GETMAXLUN - }, - {USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXLCB20AN, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_KXLCB35AN, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_LS120CAM, RID_WILDCARD, - UMASS_PROTO_UFI, - NO_QUIRKS - }, - {USB_VENDOR_PLEXTOR, USB_PRODUCT_PLEXTOR_40_12_40U, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_TEST_UNIT_READY - }, - {USB_VENDOR_PNY, USB_PRODUCT_PNY_ATTACHE2, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE | NO_START_STOP - }, - {USB_VENDOR_SAMSUNG, USB_PRODUCT_SAMSUNG_YP_U2, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - SHUTTLE_INIT | NO_GETMAXLUN - }, - {USB_VENDOR_SAMSUNG_TECHWIN, USB_PRODUCT_SAMSUNG_TECHWIN_DIGIMAX_410, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR05A, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - READ_CAPACITY_OFFBY1 | NO_GETMAXLUN - }, - {USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR09, RID_WILDCARD, - UMASS_PROTO_SCSI, - READ_CAPACITY_OFFBY1 | NO_GETMAXLUN - }, - {USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR12, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - READ_CAPACITY_OFFBY1 | NO_GETMAXLUN - }, - {USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDCZ2_256, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDCZ4_128, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDCZ4_256, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_SANDISK, USB_PRODUCT_SANDISK_SDDR31, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - READ_CAPACITY_OFFBY1 - }, - {USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I, - NO_TEST_UNIT_READY | NO_START_STOP | SHUTTLE_INIT - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_CDRW, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_CF, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSBATAPI, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSBCFSM, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSCSI, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_HIFD, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - NO_GETMAXLUN - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_SDDR09, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_GETMAXLUN - }, - {USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_ZIOMMC, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - NO_GETMAXLUN - }, - {USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_I_BEAD100, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - SHUTTLE_INIT - }, - {USB_VENDOR_SIIG, USB_PRODUCT_SIIG_WINTERREADER, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_SKANHEX, USB_PRODUCT_SKANHEX_MD_7425, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_SKANHEX, USB_PRODUCT_SKANHEX_SX_520Z, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_HANDYCAM, 0x0500, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - RBC_PAD_TO_12 - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_40_MS, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC, 0x0500, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - RBC_PAD_TO_12 - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC, 0x0600, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - RBC_PAD_TO_12 - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC, RID_WILDCARD, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_HANDYCAM, RID_WILDCARD, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_MSC, RID_WILDCARD, - UMASS_PROTO_RBC | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_MS_MSC_U03, RID_WILDCARD, - UMASS_PROTO_UFI | UMASS_PROTO_CBI, - NO_GETMAXLUN - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_MS_NW_MS7, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_GETMAXLUN - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_MS_PEG_N760C, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_MSACUS1, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_GETMAXLUN - }, - {USB_VENDOR_SONY, USB_PRODUCT_SONY_PORTABLE_HDD_V2, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_TAUGA, USB_PRODUCT_TAUGA_CAMERAMATE, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_TEAC, USB_PRODUCT_TEAC_FD05PUB, RID_WILDCARD, - UMASS_PROTO_UFI | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_TREK, USB_PRODUCT_TREK_MEMKEY, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_TREK, USB_PRODUCT_TREK_THUMBDRIVE_8MB, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_BBB, - IGNORE_RESIDUE - }, - {USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_C3310, RID_WILDCARD, - UMASS_PROTO_UFI | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_MP3, RID_WILDCARD, - UMASS_PROTO_RBC, - NO_QUIRKS - }, - {USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_T33520, RID_WILDCARD, - UMASS_PROTO_SCSI, - NO_QUIRKS - }, - {USB_VENDOR_TWINMOS, USB_PRODUCT_TWINMOS_MDIV, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_QUIRKS - }, - {USB_VENDOR_VIA, USB_PRODUCT_VIA_USB2IDEBRIDGE, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_SYNCHRONIZE_CACHE - }, - {USB_VENDOR_VIVITAR, USB_PRODUCT_VIVITAR_35XX, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_WESTERN, USB_PRODUCT_WESTERN_COMBO, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_WESTERN, USB_PRODUCT_WESTERN_EXTHDD, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_WESTERN, USB_PRODUCT_WESTERN_MYBOOK, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY_EVPD - }, - {USB_VENDOR_WINMAXGROUP, USB_PRODUCT_WINMAXGROUP_FLASH64MC, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY - }, - {USB_VENDOR_YANO, USB_PRODUCT_YANO_FW800HD, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - FORCE_SHORT_INQUIRY | NO_START_STOP | IGNORE_RESIDUE - }, - {USB_VENDOR_YANO, USB_PRODUCT_YANO_U640MO, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI_I, - FORCE_SHORT_INQUIRY - }, - {USB_VENDOR_YEDATA, USB_PRODUCT_YEDATA_FLASHBUSTERU, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_CBI, - NO_GETMAXLUN - }, - {USB_VENDOR_ZORAN, USB_PRODUCT_ZORAN_EX20DSC, RID_WILDCARD, - UMASS_PROTO_ATAPI | UMASS_PROTO_CBI, - NO_QUIRKS - }, - {USB_VENDOR_MEIZU, USB_PRODUCT_MEIZU_M6_SL, RID_WILDCARD, - UMASS_PROTO_SCSI | UMASS_PROTO_BBB, - NO_INQUIRY | NO_SYNCHRONIZE_CACHE - }, - {VID_EOT, PID_EOT, RID_EOT, 0, 0} -}; - -struct umass_softc { - - struct scsi_sense cam_scsi_sense; - struct scsi_test_unit_ready cam_scsi_test_unit_ready; - struct mtx sc_mtx; - struct { - uint8_t *data_ptr; - union ccb *ccb; - umass_callback_t *callback; - - uint32_t data_len; /* bytes */ - uint32_t data_rem; /* bytes */ - uint32_t data_timeout; /* ms */ - uint32_t actlen; /* bytes */ - - uint8_t cmd_data[UMASS_MAX_CMDLEN]; - uint8_t cmd_len; /* bytes */ - uint8_t dir; - uint8_t lun; - } sc_transfer; - - /* Bulk specific variables for transfers in progress */ - umass_bbb_cbw_t cbw; /* command block wrapper */ - umass_bbb_csw_t csw; /* command status wrapper */ - - /* CBI specific variables for transfers in progress */ - umass_cbi_sbl_t sbl; /* status block */ - - device_t sc_dev; - struct usb2_device *sc_udev; - struct cam_sim *sc_sim; /* SCSI Interface Module */ - struct usb2_xfer *sc_xfer[UMASS_T_MAX]; - - /* - * The command transform function is used to convert the SCSI - * commands into their derivatives, like UFI, ATAPI, and friends. - */ - umass_transform_t *sc_transform; - - uint32_t sc_unit; - - uint16_t sc_proto; /* wire and cmd protocol */ - uint16_t sc_quirks; /* they got it almost right */ - - uint8_t sc_name[16]; - uint8_t sc_iface_no; /* interface number */ - uint8_t sc_maxlun; /* maximum LUN number, inclusive */ - uint8_t sc_last_xfer_index; - uint8_t sc_status_try; -}; - -struct umass_probe_proto { - uint16_t quirks; - uint16_t proto; - - int32_t error; -}; - -/* prototypes */ - -static device_probe_t umass_probe; -static device_attach_t umass_attach; -static device_detach_t umass_detach; - -static usb2_callback_t umass_tr_error; -static usb2_callback_t umass_t_bbb_reset1_callback; -static usb2_callback_t umass_t_bbb_reset2_callback; -static usb2_callback_t umass_t_bbb_reset3_callback; -static usb2_callback_t umass_t_bbb_command_callback; -static usb2_callback_t umass_t_bbb_data_read_callback; -static usb2_callback_t umass_t_bbb_data_rd_cs_callback; -static usb2_callback_t umass_t_bbb_data_write_callback; -static usb2_callback_t umass_t_bbb_data_wr_cs_callback; -static usb2_callback_t umass_t_bbb_status_callback; -static usb2_callback_t umass_t_cbi_reset1_callback; -static usb2_callback_t umass_t_cbi_reset2_callback; -static usb2_callback_t umass_t_cbi_reset3_callback; -static usb2_callback_t umass_t_cbi_reset4_callback; -static usb2_callback_t umass_t_cbi_command_callback; -static usb2_callback_t umass_t_cbi_data_read_callback; -static usb2_callback_t umass_t_cbi_data_rd_cs_callback; -static usb2_callback_t umass_t_cbi_data_write_callback; -static usb2_callback_t umass_t_cbi_data_wr_cs_callback; -static usb2_callback_t umass_t_cbi_status_callback; - -static void umass_cancel_ccb(struct umass_softc *); -static void umass_init_shuttle(struct umass_softc *); -static void umass_reset(struct umass_softc *); -static void umass_t_bbb_data_clear_stall_callback(struct usb2_xfer *, - uint8_t, uint8_t); -static void umass_command_start(struct umass_softc *, uint8_t, void *, - uint32_t, uint32_t, umass_callback_t *, union ccb *); -static uint8_t umass_bbb_get_max_lun(struct umass_softc *); -static void umass_cbi_start_status(struct umass_softc *); -static void umass_t_cbi_data_clear_stall_callback(struct usb2_xfer *, - uint8_t, uint8_t); -static int umass_cam_attach_sim(struct umass_softc *); -static void umass_cam_rescan_callback(struct cam_periph *, union ccb *); -static void umass_cam_rescan(struct umass_softc *); -static void umass_cam_attach(struct umass_softc *); -static void umass_cam_detach_sim(struct umass_softc *); -static void umass_cam_action(struct cam_sim *, union ccb *); -static void umass_cam_poll(struct cam_sim *); -static void umass_cam_cb(struct umass_softc *, union ccb *, uint32_t, - uint8_t); -static void umass_cam_sense_cb(struct umass_softc *, union ccb *, uint32_t, - uint8_t); -static void umass_cam_quirk_cb(struct umass_softc *, union ccb *, uint32_t, - uint8_t); -static uint8_t umass_scsi_transform(struct umass_softc *, uint8_t *, uint8_t); -static uint8_t umass_rbc_transform(struct umass_softc *, uint8_t *, uint8_t); -static uint8_t umass_ufi_transform(struct umass_softc *, uint8_t *, uint8_t); -static uint8_t umass_atapi_transform(struct umass_softc *, uint8_t *, - uint8_t); -static uint8_t umass_no_transform(struct umass_softc *, uint8_t *, uint8_t); -static uint8_t umass_std_transform(struct umass_softc *, union ccb *, uint8_t - *, uint8_t); - -#if USB_DEBUG -static void umass_bbb_dump_cbw(struct umass_softc *, umass_bbb_cbw_t *); -static void umass_bbb_dump_csw(struct umass_softc *, umass_bbb_csw_t *); -static void umass_cbi_dump_cmd(struct umass_softc *, void *, uint8_t); -static void umass_dump_buffer(struct umass_softc *, uint8_t *, uint32_t, - uint32_t); -#endif - -struct usb2_config umass_bbb_config[UMASS_T_BBB_MAX] = { - - [UMASS_T_BBB_RESET1] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_bbb_reset1_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 500, /* 500 milliseconds */ - }, - - [UMASS_T_BBB_RESET2] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_bbb_reset2_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 50, /* 50 milliseconds */ - }, - - [UMASS_T_BBB_RESET3] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_bbb_reset3_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 50, /* 50 milliseconds */ - }, - - [UMASS_T_BBB_COMMAND] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .mh.bufsize = sizeof(umass_bbb_cbw_t), - .mh.flags = {}, - .mh.callback = &umass_t_bbb_command_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [UMASS_T_BBB_DATA_READ] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .mh.bufsize = UMASS_BULK_SIZE, - .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, - .mh.callback = &umass_t_bbb_data_read_callback, - .mh.timeout = 0, /* overwritten later */ - }, - - [UMASS_T_BBB_DATA_RD_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_bbb_data_rd_cs_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [UMASS_T_BBB_DATA_WRITE] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .mh.bufsize = UMASS_BULK_SIZE, - .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, - .mh.callback = &umass_t_bbb_data_write_callback, - .mh.timeout = 0, /* overwritten later */ - }, - - [UMASS_T_BBB_DATA_WR_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_bbb_data_wr_cs_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [UMASS_T_BBB_STATUS] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .mh.bufsize = sizeof(umass_bbb_csw_t), - .mh.flags = {.short_xfer_ok = 1,}, - .mh.callback = &umass_t_bbb_status_callback, - .mh.timeout = 5000, /* ms */ - }, -}; - -struct usb2_config umass_cbi_config[UMASS_T_CBI_MAX] = { - - [UMASS_T_CBI_RESET1] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = (sizeof(struct usb2_device_request) + - UMASS_CBI_DIAGNOSTIC_CMDLEN), - .mh.flags = {}, - .mh.callback = &umass_t_cbi_reset1_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 500, /* 500 milliseconds */ - }, - - [UMASS_T_CBI_RESET2] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_cbi_reset2_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 50, /* 50 milliseconds */ - }, - - [UMASS_T_CBI_RESET3] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_cbi_reset3_callback, - .mh.timeout = 5000, /* 5 seconds */ - .mh.interval = 50, /* 50 milliseconds */ - }, - - [UMASS_T_CBI_COMMAND] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = (sizeof(struct usb2_device_request) + - UMASS_MAX_CMDLEN), - .mh.flags = {}, - .mh.callback = &umass_t_cbi_command_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [UMASS_T_CBI_DATA_READ] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .mh.bufsize = UMASS_BULK_SIZE, - .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, - .mh.callback = &umass_t_cbi_data_read_callback, - .mh.timeout = 0, /* overwritten later */ - }, - - [UMASS_T_CBI_DATA_RD_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_cbi_data_rd_cs_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [UMASS_T_CBI_DATA_WRITE] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .mh.bufsize = UMASS_BULK_SIZE, - .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1, UMASS_USB_FLAGS}, - .mh.callback = &umass_t_cbi_data_write_callback, - .mh.timeout = 0, /* overwritten later */ - }, - - [UMASS_T_CBI_DATA_WR_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_cbi_data_wr_cs_callback, - .mh.timeout = 5000, /* 5 seconds */ - }, - - [UMASS_T_CBI_STATUS] = { - .type = UE_INTERRUPT, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .mh.flags = {.short_xfer_ok = 1,}, - .mh.bufsize = sizeof(umass_cbi_sbl_t), - .mh.callback = &umass_t_cbi_status_callback, - .mh.timeout = 5000, /* ms */ - }, - - [UMASS_T_CBI_RESET4] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &umass_t_cbi_reset4_callback, - .mh.timeout = 5000, /* ms */ - }, -}; - -/* If device cannot return valid inquiry data, fake it */ -static const uint8_t fake_inq_data[SHORT_INQUIRY_LENGTH] = { - 0, /* removable */ 0x80, SCSI_REV_2, SCSI_REV_2, - /* additional_length */ 31, 0, 0, 0 -}; - -#define UFI_COMMAND_LENGTH 12 /* UFI commands are always 12 bytes */ -#define ATAPI_COMMAND_LENGTH 12 /* ATAPI commands are always 12 bytes */ - -static devclass_t umass_devclass; - -static device_method_t umass_methods[] = { - /* Device interface */ - DEVMETHOD(device_probe, umass_probe), - DEVMETHOD(device_attach, umass_attach), - DEVMETHOD(device_detach, umass_detach), - {0, 0} -}; - -static driver_t umass_driver = { - .name = "umass", - .methods = umass_methods, - .size = sizeof(struct umass_softc), -}; - -DRIVER_MODULE(umass, ushub, umass_driver, umass_devclass, NULL, 0); -MODULE_DEPEND(umass, usb2_storage, 1, 1, 1); -MODULE_DEPEND(umass, usb2_core, 1, 1, 1); -MODULE_DEPEND(umass, cam, 1, 1, 1); - -/* - * USB device probe/attach/detach - */ - -/* - * Match the device we are seeing with the - * devices supported. - */ -static struct umass_probe_proto -umass_probe_proto(device_t dev, struct usb2_attach_arg *uaa) -{ - const struct umass_devdescr *udd = umass_devdescr; - struct usb2_interface_descriptor *id; - struct umass_probe_proto ret; - - bzero(&ret, sizeof(ret)); - - /* - * An entry specifically for Y-E Data devices as they don't fit in - * the device description table. - */ - if ((uaa->info.idVendor == USB_VENDOR_YEDATA) && - (uaa->info.idProduct == USB_PRODUCT_YEDATA_FLASHBUSTERU)) { - - /* - * Revisions < 1.28 do not handle the interrupt endpoint - * very well. - */ - if (uaa->info.bcdDevice < 0x128) { - ret.proto = UMASS_PROTO_UFI | UMASS_PROTO_CBI; - } else { - ret.proto = UMASS_PROTO_UFI | UMASS_PROTO_CBI_I; - } - - /* - * Revisions < 1.28 do not have the TEST UNIT READY command - * Revisions == 1.28 have a broken TEST UNIT READY - */ - if (uaa->info.bcdDevice <= 0x128) { - ret.quirks |= NO_TEST_UNIT_READY; - } - ret.quirks |= RS_NO_CLEAR_UA | FLOPPY_SPEED; - ret.error = 0; - goto done; - } - /* - * Check the list of supported devices for a match. While looking, - * check for wildcarded and fully matched. First match wins. - */ - for (; udd->vid != VID_EOT; udd++) { - if ((udd->vid == VID_WILDCARD) && - (udd->pid == PID_WILDCARD) && - (udd->rid == RID_WILDCARD)) { - device_printf(dev, "ignoring invalid " - "wildcard quirk\n"); - continue; - } - if (((udd->vid == uaa->info.idVendor) || - (udd->vid == VID_WILDCARD)) && - ((udd->pid == uaa->info.idProduct) || - (udd->pid == PID_WILDCARD))) { - if (udd->rid == RID_WILDCARD) { - ret.proto = udd->proto; - ret.quirks = udd->quirks; - ret.error = 0; - goto done; - } else if (udd->rid == uaa->info.bcdDevice) { - ret.proto = udd->proto; - ret.quirks = udd->quirks; - ret.error = 0; - goto done; - } /* else RID does not match */ - } - } - - /* Check for a standards compliant device */ - id = usb2_get_interface_descriptor(uaa->iface); - if ((id == NULL) || - (id->bInterfaceClass != UICLASS_MASS)) { - ret.error = ENXIO; - goto done; - } - switch (id->bInterfaceSubClass) { - case UISUBCLASS_SCSI: - ret.proto |= UMASS_PROTO_SCSI; - break; - case UISUBCLASS_UFI: - ret.proto |= UMASS_PROTO_UFI; - break; - case UISUBCLASS_RBC: - ret.proto |= UMASS_PROTO_RBC; - break; - case UISUBCLASS_SFF8020I: - case UISUBCLASS_SFF8070I: - ret.proto |= UMASS_PROTO_ATAPI; - break; - default: - device_printf(dev, "unsupported command " - "protocol %d\n", id->bInterfaceSubClass); - ret.error = ENXIO; - goto done; - } - - switch (id->bInterfaceProtocol) { - case UIPROTO_MASS_CBI: - ret.proto |= UMASS_PROTO_CBI; - break; - case UIPROTO_MASS_CBI_I: - ret.proto |= UMASS_PROTO_CBI_I; - break; - case UIPROTO_MASS_BBB_OLD: - case UIPROTO_MASS_BBB: - ret.proto |= UMASS_PROTO_BBB; - break; - default: - device_printf(dev, "unsupported wire " - "protocol %d\n", id->bInterfaceProtocol); - ret.error = ENXIO; - goto done; - } - - ret.error = 0; -done: - return (ret); -} - -static int -umass_probe(device_t dev) -{ - struct usb2_attach_arg *uaa = device_get_ivars(dev); - struct umass_probe_proto temp; - - if (uaa->usb2_mode != USB_MODE_HOST) { - return (ENXIO); - } - if (uaa->use_generic == 0) { - /* give other drivers a try first */ - return (ENXIO); - } - temp = umass_probe_proto(dev, uaa); - - return (temp.error); -} - -static int -umass_attach(device_t dev) -{ - struct umass_softc *sc = device_get_softc(dev); - struct usb2_attach_arg *uaa = device_get_ivars(dev); - struct umass_probe_proto temp = umass_probe_proto(dev, uaa); - struct usb2_interface_descriptor *id; - int32_t err; - - /* - * NOTE: the softc struct is bzero-ed in device_set_driver. - * We can safely call umass_detach without specifically - * initializing the struct. - */ - - sc->sc_dev = dev; - sc->sc_udev = uaa->device; - sc->sc_proto = temp.proto; - sc->sc_quirks = temp.quirks; - sc->sc_unit = device_get_unit(dev); - - snprintf(sc->sc_name, sizeof(sc->sc_name), - "%s", device_get_nameunit(dev)); - - device_set_usb2_desc(dev); - - mtx_init(&sc->sc_mtx, device_get_nameunit(dev), - NULL, MTX_DEF | MTX_RECURSE); - - /* get interface index */ - - id = usb2_get_interface_descriptor(uaa->iface); - if (id == NULL) { - device_printf(dev, "failed to get " - "interface number\n"); - goto detach; - } - sc->sc_iface_no = id->bInterfaceNumber; - -#if USB_DEBUG - device_printf(dev, " "); - - switch (sc->sc_proto & UMASS_PROTO_COMMAND) { - case UMASS_PROTO_SCSI: - printf("SCSI"); - break; - case UMASS_PROTO_ATAPI: - printf("8070i (ATAPI)"); - break; - case UMASS_PROTO_UFI: - printf("UFI"); - break; - case UMASS_PROTO_RBC: - printf("RBC"); - break; - default: - printf("(unknown 0x%02x)", - sc->sc_proto & UMASS_PROTO_COMMAND); - break; - } - - printf(" over "); - - switch (sc->sc_proto & UMASS_PROTO_WIRE) { - case UMASS_PROTO_BBB: - printf("Bulk-Only"); - break; - case UMASS_PROTO_CBI: /* uses Comand/Bulk pipes */ - printf("CBI"); - break; - case UMASS_PROTO_CBI_I: /* uses Comand/Bulk/Interrupt pipes */ - printf("CBI with CCI"); - break; - default: - printf("(unknown 0x%02x)", - sc->sc_proto & UMASS_PROTO_WIRE); - } - - printf("; quirks = 0x%04x\n", sc->sc_quirks); -#endif - - if (sc->sc_quirks & ALT_IFACE_1) { - err = usb2_set_alt_interface_index - (uaa->device, uaa->info.bIfaceIndex, 1); - - if (err) { - DPRINTF(sc, UDMASS_USB, "could not switch to " - "Alt Interface 1\n"); - goto detach; - } - } - /* allocate all required USB transfers */ - - if (sc->sc_proto & UMASS_PROTO_BBB) { - - err = usb2_transfer_setup(uaa->device, - &uaa->info.bIfaceIndex, sc->sc_xfer, umass_bbb_config, - UMASS_T_BBB_MAX, sc, &sc->sc_mtx); - - /* skip reset first time */ - sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND; - - } else if (sc->sc_proto & (UMASS_PROTO_CBI | UMASS_PROTO_CBI_I)) { - - err = usb2_transfer_setup(uaa->device, - &uaa->info.bIfaceIndex, sc->sc_xfer, umass_cbi_config, - (sc->sc_proto & UMASS_PROTO_CBI_I) ? - UMASS_T_CBI_MAX : (UMASS_T_CBI_MAX - 2), sc, - &sc->sc_mtx); - - /* skip reset first time */ - sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; - - } else { - err = USB_ERR_INVAL; - } - - if (err) { - device_printf(dev, "could not setup required " - "transfers, %s\n", usb2_errstr(err)); - goto detach; - } - sc->sc_transform = - (sc->sc_proto & UMASS_PROTO_SCSI) ? &umass_scsi_transform : - (sc->sc_proto & UMASS_PROTO_UFI) ? &umass_ufi_transform : - (sc->sc_proto & UMASS_PROTO_ATAPI) ? &umass_atapi_transform : - (sc->sc_proto & UMASS_PROTO_RBC) ? &umass_rbc_transform : - &umass_no_transform; - - /* from here onwards the device can be used. */ - - if (sc->sc_quirks & SHUTTLE_INIT) { - umass_init_shuttle(sc); - } - /* get the maximum LUN supported by the device */ - - if (((sc->sc_proto & UMASS_PROTO_WIRE) == UMASS_PROTO_BBB) && - !(sc->sc_quirks & NO_GETMAXLUN)) - sc->sc_maxlun = umass_bbb_get_max_lun(sc); - else - sc->sc_maxlun = 0; - - /* Prepare the SCSI command block */ - sc->cam_scsi_sense.opcode = REQUEST_SENSE; - sc->cam_scsi_test_unit_ready.opcode = TEST_UNIT_READY; - - /* - * some devices need a delay after that the configuration value is - * set to function properly: - */ - usb2_pause_mtx(&Giant, hz); - - /* register the SIM */ - err = umass_cam_attach_sim(sc); - if (err) { - goto detach; - } - /* scan the SIM */ - umass_cam_attach(sc); - - DPRINTF(sc, UDMASS_GEN, "Attach finished\n"); - - return (0); /* success */ - -detach: - umass_detach(dev); - return (ENXIO); /* failure */ -} - -static int -umass_detach(device_t dev) -{ - struct umass_softc *sc = device_get_softc(dev); - - DPRINTF(sc, UDMASS_USB, "\n"); - - /* teardown our statemachine */ - - usb2_transfer_unsetup(sc->sc_xfer, UMASS_T_MAX); - -#if (__FreeBSD_version >= 700037) - mtx_lock(&sc->sc_mtx); -#endif - umass_cam_detach_sim(sc); - -#if (__FreeBSD_version >= 700037) - mtx_unlock(&sc->sc_mtx); -#endif - - return (0); /* success */ -} - -static void -umass_init_shuttle(struct umass_softc *sc) -{ - struct usb2_device_request req; - usb2_error_t err; - uint8_t status[2] = {0, 0}; - - /* - * The Linux driver does this, but no one can tell us what the - * command does. - */ - req.bmRequestType = UT_READ_VENDOR_DEVICE; - req.bRequest = 1; /* XXX unknown command */ - USETW(req.wValue, 0); - req.wIndex[0] = sc->sc_iface_no; - req.wIndex[1] = 0; - USETW(req.wLength, sizeof(status)); - err = usb2_do_request(sc->sc_udev, &Giant, &req, &status); - - DPRINTF(sc, UDMASS_GEN, "Shuttle init returned 0x%02x%02x\n", - status[0], status[1]); -} - -/* - * Generic functions to handle transfers - */ - -static void -umass_transfer_start(struct umass_softc *sc, uint8_t xfer_index) -{ - DPRINTF(sc, UDMASS_GEN, "transfer index = " - "%d\n", xfer_index); - - if (sc->sc_xfer[xfer_index]) { - sc->sc_last_xfer_index = xfer_index; - usb2_transfer_start(sc->sc_xfer[xfer_index]); - } else { - umass_cancel_ccb(sc); - } -} - -static void -umass_reset(struct umass_softc *sc) -{ - DPRINTF(sc, UDMASS_GEN, "resetting device\n"); - - /* - * stop the last transfer, if not already stopped: - */ - usb2_transfer_stop(sc->sc_xfer[sc->sc_last_xfer_index]); - umass_transfer_start(sc, 0); -} - -static void -umass_cancel_ccb(struct umass_softc *sc) -{ - union ccb *ccb; - - mtx_assert(&sc->sc_mtx, MA_OWNED); - - ccb = sc->sc_transfer.ccb; - sc->sc_transfer.ccb = NULL; - sc->sc_last_xfer_index = 0; - - if (ccb) { - (sc->sc_transfer.callback) - (sc, ccb, (sc->sc_transfer.data_len - - sc->sc_transfer.actlen), STATUS_WIRE_FAILED); - } -} - -static void -umass_tr_error(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - - if (xfer->error != USB_ERR_CANCELLED) { - - DPRINTF(sc, UDMASS_GEN, "transfer error, %s -> " - "reset\n", usb2_errstr(xfer->error)); - } - umass_cancel_ccb(sc); -} - -/* - * BBB protocol specific functions - */ - -static void -umass_t_bbb_reset1_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - struct usb2_device_request req; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - umass_transfer_start(sc, UMASS_T_BBB_RESET2); - return; - - case USB_ST_SETUP: - /* - * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class) - * - * For Reset Recovery the host shall issue in the following order: - * a) a Bulk-Only Mass Storage Reset - * b) a Clear Feature HALT to the Bulk-In endpoint - * c) a Clear Feature HALT to the Bulk-Out endpoint - * - * This is done in 3 steps, using 3 transfers: - * UMASS_T_BBB_RESET1 - * UMASS_T_BBB_RESET2 - * UMASS_T_BBB_RESET3 - */ - - DPRINTF(sc, UDMASS_BBB, "BBB reset!\n"); - - req.bmRequestType = UT_WRITE_CLASS_INTERFACE; - req.bRequest = UR_BBB_RESET; /* bulk only reset */ - USETW(req.wValue, 0); - req.wIndex[0] = sc->sc_iface_no; - req.wIndex[1] = 0; - USETW(req.wLength, 0); - - usb2_copy_in(xfer->frbuffers, 0, &req, sizeof(req)); - - xfer->frlengths[0] = sizeof(req); - xfer->nframes = 1; - usb2_start_hardware(xfer); - return; - - default: /* Error */ - umass_tr_error(xfer); - return; - - } -} - -static void -umass_t_bbb_reset2_callback(struct usb2_xfer *xfer) -{ - umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_RESET3, - UMASS_T_BBB_DATA_READ); -} - -static void -umass_t_bbb_reset3_callback(struct usb2_xfer *xfer) -{ - umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_COMMAND, - UMASS_T_BBB_DATA_WRITE); -} - -static void -umass_t_bbb_data_clear_stall_callback(struct usb2_xfer *xfer, - uint8_t next_xfer, - uint8_t stall_xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: -tr_transferred: - umass_transfer_start(sc, next_xfer); - return; - - case USB_ST_SETUP: - if (usb2_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) { - goto tr_transferred; - } - return; - - default: /* Error */ - umass_tr_error(xfer); - return; - - } -} - -static void -umass_t_bbb_command_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - union ccb *ccb = sc->sc_transfer.ccb; - uint32_t tag; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - umass_transfer_start - (sc, ((sc->sc_transfer.dir == DIR_IN) ? UMASS_T_BBB_DATA_READ : - (sc->sc_transfer.dir == DIR_OUT) ? UMASS_T_BBB_DATA_WRITE : - UMASS_T_BBB_STATUS)); - return; - - case USB_ST_SETUP: - - sc->sc_status_try = 0; - - if (ccb) { - - /* - * the initial value is not important, - * as long as the values are unique: - */ - tag = UGETDW(sc->cbw.dCBWTag) + 1; - - USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE); - USETDW(sc->cbw.dCBWTag, tag); - - /* - * dCBWDataTransferLength: - * This field indicates the number of bytes of data that the host - * intends to transfer on the IN or OUT Bulk endpoint(as indicated by - * the Direction bit) during the execution of this command. If this - * field is set to 0, the device will expect that no data will be - * transferred IN or OUT during this command, regardless of the value - * of the Direction bit defined in dCBWFlags. - */ - USETDW(sc->cbw.dCBWDataTransferLength, sc->sc_transfer.data_len); - - /* - * dCBWFlags: - * The bits of the Flags field are defined as follows: - * Bits 0-6 reserved - * Bit 7 Direction - this bit shall be ignored if the - * dCBWDataTransferLength field is zero. - * 0 = data Out from host to device - * 1 = data In from device to host - */ - sc->cbw.bCBWFlags = ((sc->sc_transfer.dir == DIR_IN) ? - CBWFLAGS_IN : CBWFLAGS_OUT); - sc->cbw.bCBWLUN = sc->sc_transfer.lun; - - if (sc->sc_transfer.cmd_len > sizeof(sc->cbw.CBWCDB)) { - sc->sc_transfer.cmd_len = sizeof(sc->cbw.CBWCDB); - DPRINTF(sc, UDMASS_BBB, "Truncating long command!\n"); - } - sc->cbw.bCDBLength = sc->sc_transfer.cmd_len; - - bcopy(sc->sc_transfer.cmd_data, sc->cbw.CBWCDB, - sc->sc_transfer.cmd_len); - - bzero(sc->sc_transfer.cmd_data + sc->sc_transfer.cmd_len, - sizeof(sc->cbw.CBWCDB) - sc->sc_transfer.cmd_len); - - DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw)); - - usb2_copy_in(xfer->frbuffers, 0, &sc->cbw, sizeof(sc->cbw)); - - xfer->frlengths[0] = sizeof(sc->cbw); - usb2_start_hardware(xfer); - } - return; - - default: /* Error */ - umass_tr_error(xfer); - return; - - } -} - -static void -umass_t_bbb_data_read_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - if (!xfer->flags.ext_buffer) { - usb2_copy_out(xfer->frbuffers, 0, - sc->sc_transfer.data_ptr, xfer->actlen); - } - sc->sc_transfer.data_rem -= xfer->actlen; - sc->sc_transfer.data_ptr += xfer->actlen; - sc->sc_transfer.actlen += xfer->actlen; - - if (xfer->actlen < xfer->sumlen) { - /* short transfer */ - sc->sc_transfer.data_rem = 0; - } - case USB_ST_SETUP: - DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n", - max_bulk, sc->sc_transfer.data_rem); - - if (sc->sc_transfer.data_rem == 0) { - umass_transfer_start(sc, UMASS_T_BBB_STATUS); - return; - } - if (max_bulk > sc->sc_transfer.data_rem) { - max_bulk = sc->sc_transfer.data_rem; - } - xfer->timeout = sc->sc_transfer.data_timeout; - xfer->frlengths[0] = max_bulk; - - if (xfer->flags.ext_buffer) { - usb2_set_frame_data(xfer, sc->sc_transfer.data_ptr, 0); - } - usb2_start_hardware(xfer); - return; - - default: /* Error */ - if (xfer->error == USB_ERR_CANCELLED) { - umass_tr_error(xfer); - } else { - umass_transfer_start(sc, UMASS_T_BBB_DATA_RD_CS); - } - return; - - } -} - -static void -umass_t_bbb_data_rd_cs_callback(struct usb2_xfer *xfer) -{ - umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_STATUS, - UMASS_T_BBB_DATA_READ); -} - -static void -umass_t_bbb_data_write_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - sc->sc_transfer.data_rem -= xfer->actlen; - sc->sc_transfer.data_ptr += xfer->actlen; - sc->sc_transfer.actlen += xfer->actlen; - - if (xfer->actlen < xfer->sumlen) { - /* short transfer */ - sc->sc_transfer.data_rem = 0; - } - case USB_ST_SETUP: - DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n", - max_bulk, sc->sc_transfer.data_rem); - - if (sc->sc_transfer.data_rem == 0) { - umass_transfer_start(sc, UMASS_T_BBB_STATUS); - return; - } - if (max_bulk > sc->sc_transfer.data_rem) { - max_bulk = sc->sc_transfer.data_rem; - } - xfer->timeout = sc->sc_transfer.data_timeout; - xfer->frlengths[0] = max_bulk; - - if (xfer->flags.ext_buffer) { - usb2_set_frame_data(xfer, sc->sc_transfer.data_ptr, 0); - } else { - usb2_copy_in(xfer->frbuffers, 0, - sc->sc_transfer.data_ptr, max_bulk); - } - - usb2_start_hardware(xfer); - return; - - default: /* Error */ - if (xfer->error == USB_ERR_CANCELLED) { - umass_tr_error(xfer); - } else { - umass_transfer_start(sc, UMASS_T_BBB_DATA_WR_CS); - } - return; - - } -} - -static void -umass_t_bbb_data_wr_cs_callback(struct usb2_xfer *xfer) -{ - umass_t_bbb_data_clear_stall_callback(xfer, UMASS_T_BBB_STATUS, - UMASS_T_BBB_DATA_WRITE); -} - -static void -umass_t_bbb_status_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - union ccb *ccb = sc->sc_transfer.ccb; - uint32_t residue; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - - /* - * Do a full reset if there is something wrong with the CSW: - */ - sc->sc_status_try = 1; - - /* Zero missing parts of the CSW: */ - - if (xfer->actlen < sizeof(sc->csw)) { - bzero(&sc->csw, sizeof(sc->csw)); - } - usb2_copy_out(xfer->frbuffers, 0, &sc->csw, xfer->actlen); - - DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw)); - - residue = UGETDW(sc->csw.dCSWDataResidue); - - if (!residue) { - residue = (sc->sc_transfer.data_len - - sc->sc_transfer.actlen); - } - if (residue > sc->sc_transfer.data_len) { - DPRINTF(sc, UDMASS_BBB, "truncating residue from %d " - "to %d bytes\n", residue, sc->sc_transfer.data_len); - residue = sc->sc_transfer.data_len; - } - /* translate weird command-status signatures: */ - if (sc->sc_quirks & WRONG_CSWSIG) { - - uint32_t temp = UGETDW(sc->csw.dCSWSignature); - - if ((temp == CSWSIGNATURE_OLYMPUS_C1) || - (temp == CSWSIGNATURE_IMAGINATION_DBX1)) { - USETDW(sc->csw.dCSWSignature, CSWSIGNATURE); - } - } - /* check CSW and handle eventual error */ - if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) { - DPRINTF(sc, UDMASS_BBB, "bad CSW signature 0x%08x != 0x%08x\n", - UGETDW(sc->csw.dCSWSignature), CSWSIGNATURE); - /* - * Invalid CSW: Wrong signature or wrong tag might - * indicate that we lost synchronization. Reset the - * device. - */ - goto tr_error; - } else if (UGETDW(sc->csw.dCSWTag) != UGETDW(sc->cbw.dCBWTag)) { - DPRINTF(sc, UDMASS_BBB, "Invalid CSW: tag 0x%08x should be " - "0x%08x\n", UGETDW(sc->csw.dCSWTag), - UGETDW(sc->cbw.dCBWTag)); - goto tr_error; - } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) { - DPRINTF(sc, UDMASS_BBB, "Invalid CSW: status %d > %d\n", - sc->csw.bCSWStatus, CSWSTATUS_PHASE); - goto tr_error; - } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) { - DPRINTF(sc, UDMASS_BBB, "Phase error, residue = " - "%d\n", residue); - goto tr_error; - } else if (sc->sc_transfer.actlen > sc->sc_transfer.data_len) { - DPRINTF(sc, UDMASS_BBB, "Buffer overrun %d > %d\n", - sc->sc_transfer.actlen, sc->sc_transfer.data_len); - goto tr_error; - } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) { - DPRINTF(sc, UDMASS_BBB, "Command failed, residue = " - "%d\n", residue); - - sc->sc_transfer.ccb = NULL; - - sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND; - - (sc->sc_transfer.callback) - (sc, ccb, residue, STATUS_CMD_FAILED); - } else { - sc->sc_transfer.ccb = NULL; - - sc->sc_last_xfer_index = UMASS_T_BBB_COMMAND; - - (sc->sc_transfer.callback) - (sc, ccb, residue, STATUS_CMD_OK); - } - return; - - case USB_ST_SETUP: - xfer->frlengths[0] = xfer->max_data_length; - usb2_start_hardware(xfer); - return; - - default: -tr_error: - DPRINTF(sc, UDMASS_BBB, "Failed to read CSW: %s, try %d\n", - usb2_errstr(xfer->error), sc->sc_status_try); - - if ((xfer->error == USB_ERR_CANCELLED) || - (sc->sc_status_try)) { - umass_tr_error(xfer); - } else { - sc->sc_status_try = 1; - umass_transfer_start(sc, UMASS_T_BBB_DATA_RD_CS); - } - return; - - } -} - -static void -umass_command_start(struct umass_softc *sc, uint8_t dir, - void *data_ptr, uint32_t data_len, - uint32_t data_timeout, umass_callback_t *callback, - union ccb *ccb) -{ - sc->sc_transfer.lun = ccb->ccb_h.target_lun; - - /* - * NOTE: assumes that "sc->sc_transfer.cmd_data" and - * "sc->sc_transfer.cmd_len" has been properly - * initialized. - */ - - sc->sc_transfer.dir = data_len ? dir : DIR_NONE; - sc->sc_transfer.data_ptr = data_ptr; - sc->sc_transfer.data_len = data_len; - sc->sc_transfer.data_rem = data_len; - sc->sc_transfer.data_timeout = (data_timeout + UMASS_TIMEOUT); - - sc->sc_transfer.actlen = 0; - sc->sc_transfer.callback = callback; - sc->sc_transfer.ccb = ccb; - - if (sc->sc_xfer[sc->sc_last_xfer_index]) { - usb2_transfer_start(sc->sc_xfer[sc->sc_last_xfer_index]); - } else { - ccb->ccb_h.status = CAM_TID_INVALID; - xpt_done(ccb); - } -} - -static uint8_t -umass_bbb_get_max_lun(struct umass_softc *sc) -{ - struct usb2_device_request req; - usb2_error_t err; - uint8_t buf = 0; - - /* The Get Max Lun command is a class-specific request. */ - req.bmRequestType = UT_READ_CLASS_INTERFACE; - req.bRequest = UR_BBB_GET_MAX_LUN; - USETW(req.wValue, 0); - req.wIndex[0] = sc->sc_iface_no; - req.wIndex[1] = 0; - USETW(req.wLength, 1); - - err = usb2_do_request(sc->sc_udev, &Giant, &req, &buf); - if (err) { - buf = 0; - - /* Device doesn't support Get Max Lun request. */ - printf("%s: Get Max Lun not supported (%s)\n", - sc->sc_name, usb2_errstr(err)); - } - return (buf); -} - -/* - * Command/Bulk/Interrupt (CBI) specific functions - */ - -static void -umass_cbi_start_status(struct umass_softc *sc) -{ - if (sc->sc_xfer[UMASS_T_CBI_STATUS]) { - umass_transfer_start(sc, UMASS_T_CBI_STATUS); - } else { - union ccb *ccb = sc->sc_transfer.ccb; - - sc->sc_transfer.ccb = NULL; - - sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; - - (sc->sc_transfer.callback) - (sc, ccb, (sc->sc_transfer.data_len - - sc->sc_transfer.actlen), STATUS_CMD_UNKNOWN); - } -} - -static void -umass_t_cbi_reset1_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - struct usb2_device_request req; - uint8_t buf[UMASS_CBI_DIAGNOSTIC_CMDLEN]; - - uint8_t i; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - umass_transfer_start(sc, UMASS_T_CBI_RESET2); - return; - - case USB_ST_SETUP: - /* - * Command Block Reset Protocol - * - * First send a reset request to the device. Then clear - * any possibly stalled bulk endpoints. - * - * This is done in 3 steps, using 3 transfers: - * UMASS_T_CBI_RESET1 - * UMASS_T_CBI_RESET2 - * UMASS_T_CBI_RESET3 - * UMASS_T_CBI_RESET4 (only if there is an interrupt endpoint) - */ - - DPRINTF(sc, UDMASS_CBI, "CBI reset!\n"); - - req.bmRequestType = UT_WRITE_CLASS_INTERFACE; - req.bRequest = UR_CBI_ADSC; - USETW(req.wValue, 0); - req.wIndex[0] = sc->sc_iface_no; - req.wIndex[1] = 0; - USETW(req.wLength, UMASS_CBI_DIAGNOSTIC_CMDLEN); - - /* - * The 0x1d code is the SEND DIAGNOSTIC command. To - * distinguish between the two, the last 10 bytes of the CBL - * is filled with 0xff (section 2.2 of the CBI - * specification) - */ - buf[0] = 0x1d; /* Command Block Reset */ - buf[1] = 0x04; - - for (i = 2; i < UMASS_CBI_DIAGNOSTIC_CMDLEN; i++) { - buf[i] = 0xff; - } - - usb2_copy_in(xfer->frbuffers, 0, &req, sizeof(req)); - usb2_copy_in(xfer->frbuffers + 1, 0, buf, sizeof(buf)); - - xfer->frlengths[0] = sizeof(req); - xfer->frlengths[1] = sizeof(buf); - xfer->nframes = 2; - usb2_start_hardware(xfer); - return; - - default: /* Error */ - umass_tr_error(xfer); - return; - - } -} - -static void -umass_t_cbi_reset2_callback(struct usb2_xfer *xfer) -{ - umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_RESET3, - UMASS_T_CBI_DATA_READ); -} - -static void -umass_t_cbi_reset3_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - - umass_t_cbi_data_clear_stall_callback - (xfer, (sc->sc_xfer[UMASS_T_CBI_RESET4] && - sc->sc_xfer[UMASS_T_CBI_STATUS]) ? - UMASS_T_CBI_RESET4 : UMASS_T_CBI_COMMAND, - UMASS_T_CBI_DATA_WRITE); -} - -static void -umass_t_cbi_reset4_callback(struct usb2_xfer *xfer) -{ - umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_COMMAND, - UMASS_T_CBI_STATUS); -} - -static void -umass_t_cbi_data_clear_stall_callback(struct usb2_xfer *xfer, - uint8_t next_xfer, - uint8_t stall_xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: -tr_transferred: - if (next_xfer == UMASS_T_CBI_STATUS) { - umass_cbi_start_status(sc); - } else { - umass_transfer_start(sc, next_xfer); - } - return; - - case USB_ST_SETUP: - if (usb2_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) { - goto tr_transferred; /* should not happen */ - } - return; - - default: /* Error */ - umass_tr_error(xfer); - return; - - } -} - -static void -umass_t_cbi_command_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - union ccb *ccb = sc->sc_transfer.ccb; - struct usb2_device_request req; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - - if (sc->sc_transfer.dir == DIR_NONE) { - umass_cbi_start_status(sc); - } else { - umass_transfer_start - (sc, (sc->sc_transfer.dir == DIR_IN) ? - UMASS_T_CBI_DATA_READ : UMASS_T_CBI_DATA_WRITE); - } - return; - - case USB_ST_SETUP: - - if (ccb) { - - /* - * do a CBI transfer with cmd_len bytes from - * cmd_data, possibly a data phase of data_len - * bytes from/to the device and finally a status - * read phase. - */ - - req.bmRequestType = UT_WRITE_CLASS_INTERFACE; - req.bRequest = UR_CBI_ADSC; - USETW(req.wValue, 0); - req.wIndex[0] = sc->sc_iface_no; - req.wIndex[1] = 0; - req.wLength[0] = sc->sc_transfer.cmd_len; - req.wLength[1] = 0; - - usb2_copy_in(xfer->frbuffers, 0, &req, sizeof(req)); - usb2_copy_in(xfer->frbuffers + 1, 0, sc->sc_transfer.cmd_data, - sc->sc_transfer.cmd_len); - - xfer->frlengths[0] = sizeof(req); - xfer->frlengths[1] = sc->sc_transfer.cmd_len; - xfer->nframes = xfer->frlengths[1] ? 2 : 1; - - DIF(UDMASS_CBI, - umass_cbi_dump_cmd(sc, - sc->sc_transfer.cmd_data, - sc->sc_transfer.cmd_len)); - - usb2_start_hardware(xfer); - } - return; - - default: /* Error */ - umass_tr_error(xfer); - return; - - } -} - -static void -umass_t_cbi_data_read_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - if (!xfer->flags.ext_buffer) { - usb2_copy_out(xfer->frbuffers, 0, - sc->sc_transfer.data_ptr, xfer->actlen); - } - sc->sc_transfer.data_rem -= xfer->actlen; - sc->sc_transfer.data_ptr += xfer->actlen; - sc->sc_transfer.actlen += xfer->actlen; - - if (xfer->actlen < xfer->sumlen) { - /* short transfer */ - sc->sc_transfer.data_rem = 0; - } - case USB_ST_SETUP: - DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n", - max_bulk, sc->sc_transfer.data_rem); - - if (sc->sc_transfer.data_rem == 0) { - umass_cbi_start_status(sc); - return; - } - if (max_bulk > sc->sc_transfer.data_rem) { - max_bulk = sc->sc_transfer.data_rem; - } - xfer->timeout = sc->sc_transfer.data_timeout; - - if (xfer->flags.ext_buffer) { - usb2_set_frame_data(xfer, sc->sc_transfer.data_ptr, 0); - } - xfer->frlengths[0] = max_bulk; - usb2_start_hardware(xfer); - return; - - default: /* Error */ - if ((xfer->error == USB_ERR_CANCELLED) || - (sc->sc_transfer.callback != &umass_cam_cb)) { - umass_tr_error(xfer); - } else { - umass_transfer_start(sc, UMASS_T_CBI_DATA_RD_CS); - } - return; - - } -} - -static void -umass_t_cbi_data_rd_cs_callback(struct usb2_xfer *xfer) -{ - umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_STATUS, - UMASS_T_CBI_DATA_READ); -} - -static void -umass_t_cbi_data_write_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - sc->sc_transfer.data_rem -= xfer->actlen; - sc->sc_transfer.data_ptr += xfer->actlen; - sc->sc_transfer.actlen += xfer->actlen; - - if (xfer->actlen < xfer->sumlen) { - /* short transfer */ - sc->sc_transfer.data_rem = 0; - } - case USB_ST_SETUP: - DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n", - max_bulk, sc->sc_transfer.data_rem); - - if (sc->sc_transfer.data_rem == 0) { - umass_cbi_start_status(sc); - return; - } - if (max_bulk > sc->sc_transfer.data_rem) { - max_bulk = sc->sc_transfer.data_rem; - } - xfer->timeout = sc->sc_transfer.data_timeout; - - if (xfer->flags.ext_buffer) { - usb2_set_frame_data(xfer, sc->sc_transfer.data_ptr, 0); - } else { - usb2_copy_in(xfer->frbuffers, 0, - sc->sc_transfer.data_ptr, max_bulk); - } - - xfer->frlengths[0] = max_bulk; - usb2_start_hardware(xfer); - return; - - default: /* Error */ - if ((xfer->error == USB_ERR_CANCELLED) || - (sc->sc_transfer.callback != &umass_cam_cb)) { - umass_tr_error(xfer); - } else { - umass_transfer_start(sc, UMASS_T_CBI_DATA_WR_CS); - } - return; - - } -} - -static void -umass_t_cbi_data_wr_cs_callback(struct usb2_xfer *xfer) -{ - umass_t_cbi_data_clear_stall_callback(xfer, UMASS_T_CBI_STATUS, - UMASS_T_CBI_DATA_WRITE); -} - -static void -umass_t_cbi_status_callback(struct usb2_xfer *xfer) -{ - struct umass_softc *sc = xfer->priv_sc; - union ccb *ccb = sc->sc_transfer.ccb; - uint32_t residue; - uint8_t status; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - - if (xfer->actlen < sizeof(sc->sbl)) { - goto tr_setup; - } - usb2_copy_out(xfer->frbuffers, 0, &sc->sbl, sizeof(sc->sbl)); - - residue = (sc->sc_transfer.data_len - - sc->sc_transfer.actlen); - - /* dissect the information in the buffer */ - - if (sc->sc_proto & UMASS_PROTO_UFI) { - - /* - * Section 3.4.3.1.3 specifies that the UFI command - * protocol returns an ASC and ASCQ in the interrupt - * data block. - */ - - DPRINTF(sc, UDMASS_CBI, "UFI CCI, ASC = 0x%02x, " - "ASCQ = 0x%02x\n", sc->sbl.ufi.asc, - sc->sbl.ufi.ascq); - - status = (((sc->sbl.ufi.asc == 0) && - (sc->sbl.ufi.ascq == 0)) ? - STATUS_CMD_OK : STATUS_CMD_FAILED); - - sc->sc_transfer.ccb = NULL; - - sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; - - (sc->sc_transfer.callback) - (sc, ccb, residue, status); - - return; - - } else { - - /* Command Interrupt Data Block */ - - DPRINTF(sc, UDMASS_CBI, "type=0x%02x, value=0x%02x\n", - sc->sbl.common.type, sc->sbl.common.value); - - if (sc->sbl.common.type == IDB_TYPE_CCI) { - - status = (sc->sbl.common.value & IDB_VALUE_STATUS_MASK); - - status = ((status == IDB_VALUE_PASS) ? STATUS_CMD_OK : - (status == IDB_VALUE_FAIL) ? STATUS_CMD_FAILED : - (status == IDB_VALUE_PERSISTENT) ? STATUS_CMD_FAILED : - STATUS_WIRE_FAILED); - - sc->sc_transfer.ccb = NULL; - - sc->sc_last_xfer_index = UMASS_T_CBI_COMMAND; - - (sc->sc_transfer.callback) - (sc, ccb, residue, status); - - return; - } - } - - /* fallthrough */ - - case USB_ST_SETUP: -tr_setup: - xfer->frlengths[0] = xfer->max_data_length; - usb2_start_hardware(xfer); - return; - - default: /* Error */ - DPRINTF(sc, UDMASS_CBI, "Failed to read CSW: %s\n", - usb2_errstr(xfer->error)); - umass_tr_error(xfer); - return; - - } -} - -/* - * CAM specific functions (used by SCSI, UFI, 8070i (ATAPI)) - */ - -static int -umass_cam_attach_sim(struct umass_softc *sc) -{ - struct cam_devq *devq; /* Per device Queue */ - - /* - * A HBA is attached to the CAM layer. - * - * The CAM layer will then after a while start probing for devices on - * the bus. The number of SIMs is limited to one. - */ - - devq = cam_simq_alloc(1 /* maximum openings */ ); - if (devq == NULL) { - return (ENOMEM); - } - sc->sc_sim = cam_sim_alloc - (&umass_cam_action, &umass_cam_poll, - DEVNAME_SIM, - sc /* priv */ , - sc->sc_unit /* unit number */ , -#if (__FreeBSD_version >= 700037) - &sc->sc_mtx /* mutex */ , -#endif - 1 /* maximum device openings */ , - 0 /* maximum tagged device openings */ , - devq); - - if (sc->sc_sim == NULL) { - cam_simq_free(devq); - return (ENOMEM); - } - -#if (__FreeBSD_version >= 700037) - mtx_lock(&sc->sc_mtx); -#endif - -#if (__FreeBSD_version >= 700048) - if (xpt_bus_register(sc->sc_sim, sc->sc_dev, sc->sc_unit) != CAM_SUCCESS) { - mtx_unlock(&sc->sc_mtx); - return (ENOMEM); - } -#else - if (xpt_bus_register(sc->sc_sim, sc->sc_unit) != CAM_SUCCESS) { -#if (__FreeBSD_version >= 700037) - mtx_unlock(&sc->sc_mtx); -#endif - return (ENOMEM); - } -#endif - -#if (__FreeBSD_version >= 700037) - mtx_unlock(&sc->sc_mtx); -#endif - return (0); -} - -static void -umass_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb) -{ -#if USB_DEBUG - struct umass_softc *sc = NULL; - - if (ccb->ccb_h.status != CAM_REQ_CMP) { - DPRINTF(sc, UDMASS_SCSI, "%s:%d Rescan failed, 0x%04x\n", - periph->periph_name, periph->unit_number, - ccb->ccb_h.status); - } else { - DPRINTF(sc, UDMASS_SCSI, "%s%d: Rescan succeeded\n", - periph->periph_name, periph->unit_number); - } -#endif - - xpt_free_path(ccb->ccb_h.path); - free(ccb, M_USBDEV); -} - -static void -umass_cam_rescan(struct umass_softc *sc) -{ - struct cam_path *path; - union ccb *ccb; - - DPRINTF(sc, UDMASS_SCSI, "scbus%d: scanning for %d:%d:%d\n", - cam_sim_path(sc->sc_sim), - cam_sim_path(sc->sc_sim), - sc->sc_unit, CAM_LUN_WILDCARD); - - ccb = malloc(sizeof(*ccb), M_USBDEV, M_WAITOK | M_ZERO); - - if (ccb == NULL) { - return; - } -#if (__FreeBSD_version >= 700037) - mtx_lock(&sc->sc_mtx); -#endif - - if (xpt_create_path(&path, xpt_periph, cam_sim_path(sc->sc_sim), - CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) - != CAM_REQ_CMP) { -#if (__FreeBSD_version >= 700037) - mtx_unlock(&sc->sc_mtx); -#endif - free(ccb, M_USBDEV); - return; - } - xpt_setup_ccb(&ccb->ccb_h, path, 5 /* priority (low) */ ); - ccb->ccb_h.func_code = XPT_SCAN_BUS; - ccb->ccb_h.cbfcnp = &umass_cam_rescan_callback; - ccb->crcn.flags = CAM_FLAG_NONE; - xpt_action(ccb); - -#if (__FreeBSD_version >= 700037) - mtx_unlock(&sc->sc_mtx); -#endif - - /* The scan is in progress now. */ -} - -static void -umass_cam_attach(struct umass_softc *sc) -{ -#ifndef USB_DEBUG - if (bootverbose) -#endif - printf("%s:%d:%d:%d: Attached to scbus%d\n", - sc->sc_name, cam_sim_path(sc->sc_sim), - sc->sc_unit, CAM_LUN_WILDCARD, - cam_sim_path(sc->sc_sim)); - - if (!cold) { - /* - * Notify CAM of the new device after a short delay. Any - * failure is benign, as the user can still do it by hand - * (camcontrol rescan <busno>). Only do this if we are not - * booting, because CAM does a scan after booting has - * completed, when interrupts have been enabled. - */ - - /* scan the new sim */ - umass_cam_rescan(sc); - } -} - -/* umass_cam_detach - * detach from the CAM layer - */ - -static void -umass_cam_detach_sim(struct umass_softc *sc) -{ - if (sc->sc_sim != NULL) { - if (xpt_bus_deregister(cam_sim_path(sc->sc_sim))) { - /* accessing the softc is not possible after this */ - sc->sc_sim->softc = UMASS_GONE; - cam_sim_free(sc->sc_sim, /* free_devq */ TRUE); - } else { - panic("%s: CAM layer is busy!\n", - sc->sc_name); - } - sc->sc_sim = NULL; - } -} - -/* umass_cam_action - * CAM requests for action come through here - */ - -static void -umass_cam_action(struct cam_sim *sim, union ccb *ccb) -{ - struct umass_softc *sc = (struct umass_softc *)sim->softc; - - if (sc == UMASS_GONE) { - ccb->ccb_h.status = CAM_TID_INVALID; - xpt_done(ccb); - return; - } - if (sc) { -#if (__FreeBSD_version < 700037) - mtx_lock(&sc->sc_mtx); -#endif - } - /* - * Verify, depending on the operation to perform, that we either got - * a valid sc, because an existing target was referenced, or - * otherwise the SIM is addressed. - * - * This avoids bombing out at a printf and does give the CAM layer some - * sensible feedback on errors. - */ - switch (ccb->ccb_h.func_code) { - case XPT_SCSI_IO: - case XPT_RESET_DEV: - case XPT_GET_TRAN_SETTINGS: - case XPT_SET_TRAN_SETTINGS: - case XPT_CALC_GEOMETRY: - /* the opcodes requiring a target. These should never occur. */ - if (sc == NULL) { - DPRINTF(sc, UDMASS_GEN, "%s:%d:%d:%d:func_code 0x%04x: " - "Invalid target (target needed)\n", - DEVNAME_SIM, cam_sim_path(sc->sc_sim), - ccb->ccb_h.target_id, ccb->ccb_h.target_lun, - ccb->ccb_h.func_code); - - ccb->ccb_h.status = CAM_TID_INVALID; - xpt_done(ccb); - goto done; - } - break; - case XPT_PATH_INQ: - case XPT_NOOP: - /* - * The opcodes sometimes aimed at a target (sc is valid), - * sometimes aimed at the SIM (sc is invalid and target is - * CAM_TARGET_WILDCARD) - */ - if ((sc == NULL) && - (ccb->ccb_h.target_id != CAM_TARGET_WILDCARD)) { - DPRINTF(sc, UDMASS_SCSI, "%s:%d:%d:%d:func_code 0x%04x: " - "Invalid target (no wildcard)\n", - DEVNAME_SIM, cam_sim_path(sc->sc_sim), - ccb->ccb_h.target_id, ccb->ccb_h.target_lun, - ccb->ccb_h.func_code); - - ccb->ccb_h.status = CAM_TID_INVALID; - xpt_done(ccb); - goto done; - } - break; - default: - /* XXX Hm, we should check the input parameters */ - break; - } - - /* Perform the requested action */ - switch (ccb->ccb_h.func_code) { - case XPT_SCSI_IO: - { - uint8_t *cmd; - uint8_t dir; - - if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) { - cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr); - } else { - cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes); - } - - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SCSI_IO: " - "cmd: 0x%02x, flags: 0x%02x, " - "%db cmd/%db data/%db sense\n", - cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, - ccb->ccb_h.target_lun, cmd[0], - ccb->ccb_h.flags & CAM_DIR_MASK, ccb->csio.cdb_len, - ccb->csio.dxfer_len, ccb->csio.sense_len); - - if (sc->sc_transfer.ccb) { - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SCSI_IO: " - "I/O in progress, deferring\n", - cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, - ccb->ccb_h.target_lun); - ccb->ccb_h.status = CAM_SCSI_BUSY; - xpt_done(ccb); - goto done; - } - switch (ccb->ccb_h.flags & CAM_DIR_MASK) { - case CAM_DIR_IN: - dir = DIR_IN; - break; - case CAM_DIR_OUT: - dir = DIR_OUT; - DIF(UDMASS_SCSI, - umass_dump_buffer(sc, ccb->csio.data_ptr, - ccb->csio.dxfer_len, 48)); - break; - default: - dir = DIR_NONE; - } - - ccb->ccb_h.status = CAM_REQ_INPROG | CAM_SIM_QUEUED; - - /* - * sc->sc_transform will convert the command to the - * command format needed by the specific command set - * and return the converted command in - * "sc->sc_transfer.cmd_data" - */ - if (umass_std_transform(sc, ccb, cmd, ccb->csio.cdb_len)) { - - if (sc->sc_transfer.cmd_data[0] == INQUIRY) { - - /* - * Handle EVPD inquiry for broken devices first - * NO_INQUIRY also implies NO_INQUIRY_EVPD - */ - if ((sc->sc_quirks & (NO_INQUIRY_EVPD | NO_INQUIRY)) && - (sc->sc_transfer.cmd_data[1] & SI_EVPD)) { - struct scsi_sense_data *sense; - - sense = &ccb->csio.sense_data; - bzero(sense, sizeof(*sense)); - sense->error_code = SSD_CURRENT_ERROR; - sense->flags = SSD_KEY_ILLEGAL_REQUEST; - sense->add_sense_code = 0x24; - sense->extra_len = 10; - ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; - ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR | - CAM_AUTOSNS_VALID; - xpt_done(ccb); - goto done; - } - /* - * Return fake inquiry data for - * broken devices - */ - if (sc->sc_quirks & NO_INQUIRY) { - memcpy(ccb->csio.data_ptr, &fake_inq_data, - sizeof(fake_inq_data)); - ccb->csio.scsi_status = SCSI_STATUS_OK; - ccb->ccb_h.status = CAM_REQ_CMP; - xpt_done(ccb); - goto done; - } - if (sc->sc_quirks & FORCE_SHORT_INQUIRY) { - ccb->csio.dxfer_len = SHORT_INQUIRY_LENGTH; - } - } else if (sc->sc_transfer.cmd_data[0] == SYNCHRONIZE_CACHE) { - if (sc->sc_quirks & NO_SYNCHRONIZE_CACHE) { - ccb->csio.scsi_status = SCSI_STATUS_OK; - ccb->ccb_h.status = CAM_REQ_CMP; - xpt_done(ccb); - goto done; - } - } - umass_command_start(sc, dir, ccb->csio.data_ptr, - ccb->csio.dxfer_len, - ccb->ccb_h.timeout, - &umass_cam_cb, ccb); - } - break; - } - case XPT_PATH_INQ: - { - struct ccb_pathinq *cpi = &ccb->cpi; - - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_PATH_INQ:.\n", - sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id, - ccb->ccb_h.target_lun); - - /* host specific information */ - cpi->version_num = 1; - cpi->hba_inquiry = 0; - cpi->target_sprt = 0; - cpi->hba_misc = PIM_NO_6_BYTE; - cpi->hba_eng_cnt = 0; - cpi->max_target = UMASS_SCSIID_MAX; /* one target */ - cpi->initiator_id = UMASS_SCSIID_HOST; - strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN); - strlcpy(cpi->hba_vid, "USB SCSI", HBA_IDLEN); - strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN); - cpi->unit_number = cam_sim_unit(sim); - cpi->bus_id = sc->sc_unit; -#if (__FreeBSD_version >= 700025) - cpi->protocol = PROTO_SCSI; - cpi->protocol_version = SCSI_REV_2; - cpi->transport = XPORT_USB; - cpi->transport_version = 0; -#endif - if (sc == NULL) { - cpi->base_transfer_speed = 0; - cpi->max_lun = 0; - } else { - if (sc->sc_quirks & FLOPPY_SPEED) { - cpi->base_transfer_speed = - UMASS_FLOPPY_TRANSFER_SPEED; - } else if (usb2_get_speed(sc->sc_udev) == - USB_SPEED_HIGH) { - cpi->base_transfer_speed = - UMASS_HIGH_TRANSFER_SPEED; - } else { - cpi->base_transfer_speed = - UMASS_FULL_TRANSFER_SPEED; - } - cpi->max_lun = sc->sc_maxlun; - } - - cpi->ccb_h.status = CAM_REQ_CMP; - xpt_done(ccb); - break; - } - case XPT_RESET_DEV: - { - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_RESET_DEV:.\n", - cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, - ccb->ccb_h.target_lun); - - umass_reset(sc); - - ccb->ccb_h.status = CAM_REQ_CMP; - xpt_done(ccb); - break; - } - case XPT_GET_TRAN_SETTINGS: - { - struct ccb_trans_settings *cts = &ccb->cts; - - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_GET_TRAN_SETTINGS:.\n", - cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, - ccb->ccb_h.target_lun); - -#if (__FreeBSD_version >= 700025) - cts->protocol = PROTO_SCSI; - cts->protocol_version = SCSI_REV_2; - cts->transport = XPORT_USB; - cts->transport_version = 0; - cts->xport_specific.valid = 0; -#else - cts->valid = 0; - cts->flags = 0; /* no disconnection, tagging */ -#endif - ccb->ccb_h.status = CAM_REQ_CMP; - xpt_done(ccb); - break; - } - case XPT_SET_TRAN_SETTINGS: - { - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_SET_TRAN_SETTINGS:.\n", - cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id, - ccb->ccb_h.target_lun); - - ccb->ccb_h.status = CAM_FUNC_NOTAVAIL; - xpt_done(ccb); - break; - } - case XPT_CALC_GEOMETRY: - { - cam_calc_geometry(&ccb->ccg, /* extended */ 1); - xpt_done(ccb); - break; - } - case XPT_NOOP: - { - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:XPT_NOOP:.\n", - sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id, - ccb->ccb_h.target_lun); - - ccb->ccb_h.status = CAM_REQ_CMP; - xpt_done(ccb); - break; - } - default: - DPRINTF(sc, UDMASS_SCSI, "%d:%d:%d:func_code 0x%04x: " - "Not implemented\n", - sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id, - ccb->ccb_h.target_lun, ccb->ccb_h.func_code); - - ccb->ccb_h.status = CAM_FUNC_NOTAVAIL; - xpt_done(ccb); - break; - } - -done: -#if (__FreeBSD_version < 700037) - if (sc) { - mtx_unlock(&sc->sc_mtx); - } -#endif - return; -} - -static void -umass_cam_poll(struct cam_sim *sim) -{ - struct umass_softc *sc = (struct umass_softc *)sim->softc; - - if (sc == UMASS_GONE) - return; - - DPRINTF(sc, UDMASS_SCSI, "CAM poll\n"); - - usb2_do_poll(sc->sc_xfer, UMASS_T_MAX); -} - - -/* umass_cam_cb - * finalise a completed CAM command - */ - -static void -umass_cam_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue, - uint8_t status) -{ - ccb->csio.resid = residue; - - switch (status) { - case STATUS_CMD_OK: - ccb->ccb_h.status = CAM_REQ_CMP; - if ((sc->sc_quirks & READ_CAPACITY_OFFBY1) && - (ccb->ccb_h.func_code == XPT_SCSI_IO) && - (ccb->csio.cdb_io.cdb_bytes[0] == READ_CAPACITY)) { - struct scsi_read_capacity_data *rcap; - uint32_t maxsector; - - rcap = (void *)(ccb->csio.data_ptr); - maxsector = scsi_4btoul(rcap->addr) - 1; - scsi_ulto4b(maxsector, rcap->addr); - } - xpt_done(ccb); - break; - - case STATUS_CMD_UNKNOWN: - case STATUS_CMD_FAILED: - - /* fetch sense data */ - - /* the rest of the command was filled in at attach */ - sc->cam_scsi_sense.length = ccb->csio.sense_len; - - DPRINTF(sc, UDMASS_SCSI, "Fetching %d bytes of " - "sense data\n", ccb->csio.sense_len); - - if (umass_std_transform(sc, ccb, &sc->cam_scsi_sense.opcode, - sizeof(sc->cam_scsi_sense))) { - - if ((sc->sc_quirks & FORCE_SHORT_INQUIRY) && - (sc->sc_transfer.cmd_data[0] == INQUIRY)) { - ccb->csio.sense_len = SHORT_INQUIRY_LENGTH; - } - umass_command_start(sc, DIR_IN, &ccb->csio.sense_data.error_code, - ccb->csio.sense_len, ccb->ccb_h.timeout, - &umass_cam_sense_cb, ccb); - } - break; - - default: - /* - * the wire protocol failed and will have recovered - * (hopefully). We return an error to CAM and let CAM retry - * the command if necessary. - */ - ccb->ccb_h.status = CAM_REQ_CMP_ERR; - xpt_done(ccb); - break; - } -} - -/* - * Finalise a completed autosense operation - */ -static void -umass_cam_sense_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue, - uint8_t status) -{ - uint8_t *cmd; - uint8_t key; - - switch (status) { - case STATUS_CMD_OK: - case STATUS_CMD_UNKNOWN: - case STATUS_CMD_FAILED: - - if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) { - cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr); - } else { - cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes); - } - - key = (ccb->csio.sense_data.flags & SSD_KEY); - - /* - * Getting sense data always succeeds (apart from wire - * failures): - */ - if ((sc->sc_quirks & RS_NO_CLEAR_UA) && - (cmd[0] == INQUIRY) && - (key == SSD_KEY_UNIT_ATTENTION)) { - /* - * Ignore unit attention errors in the case where - * the Unit Attention state is not cleared on - * REQUEST SENSE. They will appear again at the next - * command. - */ - ccb->ccb_h.status = CAM_REQ_CMP; - } else if (key == SSD_KEY_NO_SENSE) { - /* - * No problem after all (in the case of CBI without - * CCI) - */ - ccb->ccb_h.status = CAM_REQ_CMP; - } else if ((sc->sc_quirks & RS_NO_CLEAR_UA) && - (cmd[0] == READ_CAPACITY) && - (key == SSD_KEY_UNIT_ATTENTION)) { - /* - * Some devices do not clear the unit attention error - * on request sense. We insert a test unit ready - * command to make sure we clear the unit attention - * condition, then allow the retry to proceed as - * usual. - */ - - ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR - | CAM_AUTOSNS_VALID; - ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; - -#if 0 - DELAY(300000); -#endif - DPRINTF(sc, UDMASS_SCSI, "Doing a sneaky" - "TEST_UNIT_READY\n"); - - /* the rest of the command was filled in at attach */ - - if (umass_std_transform(sc, ccb, - &sc->cam_scsi_test_unit_ready.opcode, - sizeof(sc->cam_scsi_test_unit_ready))) { - umass_command_start(sc, DIR_NONE, NULL, 0, - ccb->ccb_h.timeout, - &umass_cam_quirk_cb, ccb); - } - break; - } else { - ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR - | CAM_AUTOSNS_VALID; - ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; - } - xpt_done(ccb); - break; - - default: - DPRINTF(sc, UDMASS_SCSI, "Autosense failed, " - "status %d\n", status); - ccb->ccb_h.status = CAM_AUTOSENSE_FAIL; - xpt_done(ccb); - } -} - -/* - * This completion code just handles the fact that we sent a test-unit-ready - * after having previously failed a READ CAPACITY with CHECK_COND. Even - * though this command succeeded, we have to tell CAM to retry. - */ -static void -umass_cam_quirk_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue, - uint8_t status) -{ - DPRINTF(sc, UDMASS_SCSI, "Test unit ready " - "returned status %d\n", status); - - ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR - | CAM_AUTOSNS_VALID; - ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND; - xpt_done(ccb); -} - -/* - * SCSI specific functions - */ - -static uint8_t -umass_scsi_transform(struct umass_softc *sc, uint8_t *cmd_ptr, - uint8_t cmd_len) -{ - if ((cmd_len == 0) || - (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { - DPRINTF(sc, UDMASS_SCSI, "Invalid command " - "length: %d bytes\n", cmd_len); - return (0); /* failure */ - } - sc->sc_transfer.cmd_len = cmd_len; - - switch (cmd_ptr[0]) { - case TEST_UNIT_READY: - if (sc->sc_quirks & NO_TEST_UNIT_READY) { - DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY " - "to START_UNIT\n"); - bzero(sc->sc_transfer.cmd_data, cmd_len); - sc->sc_transfer.cmd_data[0] = START_STOP_UNIT; - sc->sc_transfer.cmd_data[4] = SSS_START; - return (1); - } - break; - - case INQUIRY: - /* - * some drives wedge when asked for full inquiry - * information. - */ - if (sc->sc_quirks & FORCE_SHORT_INQUIRY) { - bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); - sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH; - return (1); - } - break; - } - - bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); - return (1); -} - -static uint8_t -umass_rbc_transform(struct umass_softc *sc, uint8_t *cmd_ptr, uint8_t cmd_len) -{ - if ((cmd_len == 0) || - (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { - DPRINTF(sc, UDMASS_SCSI, "Invalid command " - "length: %d bytes\n", cmd_len); - return (0); /* failure */ - } - switch (cmd_ptr[0]) { - /* these commands are defined in RBC: */ - case READ_10: - case READ_CAPACITY: - case START_STOP_UNIT: - case SYNCHRONIZE_CACHE: - case WRITE_10: - case 0x2f: /* VERIFY_10 is absent from - * scsi_all.h??? */ - case INQUIRY: - case MODE_SELECT_10: - case MODE_SENSE_10: - case TEST_UNIT_READY: - case WRITE_BUFFER: - /* - * The following commands are not listed in my copy of the - * RBC specs. CAM however seems to want those, and at least - * the Sony DSC device appears to support those as well - */ - case REQUEST_SENSE: - case PREVENT_ALLOW: - - bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); - - if ((sc->sc_quirks & RBC_PAD_TO_12) && (cmd_len < 12)) { - bzero(sc->sc_transfer.cmd_data + cmd_len, 12 - cmd_len); - cmd_len = 12; - } - sc->sc_transfer.cmd_len = cmd_len; - return (1); /* sucess */ - - /* All other commands are not legal in RBC */ - default: - DPRINTF(sc, UDMASS_SCSI, "Unsupported RBC " - "command 0x%02x\n", cmd_ptr[0]); - return (0); /* failure */ - } -} - -static uint8_t -umass_ufi_transform(struct umass_softc *sc, uint8_t *cmd_ptr, - uint8_t cmd_len) -{ - if ((cmd_len == 0) || - (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { - DPRINTF(sc, UDMASS_SCSI, "Invalid command " - "length: %d bytes\n", cmd_len); - return (0); /* failure */ - } - /* An UFI command is always 12 bytes in length */ - sc->sc_transfer.cmd_len = UFI_COMMAND_LENGTH; - - /* Zero the command data */ - bzero(sc->sc_transfer.cmd_data, UFI_COMMAND_LENGTH); - - switch (cmd_ptr[0]) { - /* - * Commands of which the format has been verified. They - * should work. Copy the command into the (zeroed out) - * destination buffer. - */ - case TEST_UNIT_READY: - if (sc->sc_quirks & NO_TEST_UNIT_READY) { - /* - * Some devices do not support this command. Start - * Stop Unit should give the same results - */ - DPRINTF(sc, UDMASS_UFI, "Converted TEST_UNIT_READY " - "to START_UNIT\n"); - - sc->sc_transfer.cmd_data[0] = START_STOP_UNIT; - sc->sc_transfer.cmd_data[4] = SSS_START; - return (1); - } - break; - - case REZERO_UNIT: - case REQUEST_SENSE: - case FORMAT_UNIT: - case INQUIRY: - case START_STOP_UNIT: - case SEND_DIAGNOSTIC: - case PREVENT_ALLOW: - case READ_CAPACITY: - case READ_10: - case WRITE_10: - case POSITION_TO_ELEMENT: /* SEEK_10 */ - case WRITE_AND_VERIFY: - case VERIFY: - case MODE_SELECT_10: - case MODE_SENSE_10: - case READ_12: - case WRITE_12: - case READ_FORMAT_CAPACITIES: - break; - - /* - * SYNCHRONIZE_CACHE isn't supported by UFI, nor should it be - * required for UFI devices, so it is appropriate to fake - * success. - */ - case SYNCHRONIZE_CACHE: - return (2); - - default: - DPRINTF(sc, UDMASS_SCSI, "Unsupported UFI " - "command 0x%02x\n", cmd_ptr[0]); - return (0); /* failure */ - } - - bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); - return (1); /* success */ -} - -/* - * 8070i (ATAPI) specific functions - */ -static uint8_t -umass_atapi_transform(struct umass_softc *sc, uint8_t *cmd_ptr, - uint8_t cmd_len) -{ - if ((cmd_len == 0) || - (cmd_len > sizeof(sc->sc_transfer.cmd_data))) { - DPRINTF(sc, UDMASS_SCSI, "Invalid command " - "length: %d bytes\n", cmd_len); - return (0); /* failure */ - } - /* An ATAPI command is always 12 bytes in length. */ - sc->sc_transfer.cmd_len = ATAPI_COMMAND_LENGTH; - - /* Zero the command data */ - bzero(sc->sc_transfer.cmd_data, ATAPI_COMMAND_LENGTH); - - switch (cmd_ptr[0]) { - /* - * Commands of which the format has been verified. They - * should work. Copy the command into the destination - * buffer. - */ - case INQUIRY: - /* - * some drives wedge when asked for full inquiry - * information. - */ - if (sc->sc_quirks & FORCE_SHORT_INQUIRY) { - bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); - - sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH; - return (1); - } - break; - - case TEST_UNIT_READY: - if (sc->sc_quirks & NO_TEST_UNIT_READY) { - DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY " - "to START_UNIT\n"); - sc->sc_transfer.cmd_data[0] = START_STOP_UNIT; - sc->sc_transfer.cmd_data[4] = SSS_START; - return (1); - } - break; - - case REZERO_UNIT: - case REQUEST_SENSE: - case START_STOP_UNIT: - case SEND_DIAGNOSTIC: - case PREVENT_ALLOW: - case READ_CAPACITY: - case READ_10: - case WRITE_10: - case POSITION_TO_ELEMENT: /* SEEK_10 */ - case SYNCHRONIZE_CACHE: - case MODE_SELECT_10: - case MODE_SENSE_10: - case READ_BUFFER: - case 0x42: /* READ_SUBCHANNEL */ - case 0x43: /* READ_TOC */ - case 0x44: /* READ_HEADER */ - case 0x47: /* PLAY_MSF (Play Minute/Second/Frame) */ - case 0x48: /* PLAY_TRACK */ - case 0x49: /* PLAY_TRACK_REL */ - case 0x4b: /* PAUSE */ - case 0x51: /* READ_DISK_INFO */ - case 0x52: /* READ_TRACK_INFO */ - case 0x54: /* SEND_OPC */ - case 0x59: /* READ_MASTER_CUE */ - case 0x5b: /* CLOSE_TR_SESSION */ - case 0x5c: /* READ_BUFFER_CAP */ - case 0x5d: /* SEND_CUE_SHEET */ - case 0xa1: /* BLANK */ - case 0xa5: /* PLAY_12 */ - case 0xa6: /* EXCHANGE_MEDIUM */ - case 0xad: /* READ_DVD_STRUCTURE */ - case 0xbb: /* SET_CD_SPEED */ - case 0xe5: /* READ_TRACK_INFO_PHILIPS */ - break;; - - case READ_12: - case WRITE_12: - default: - DPRINTF(sc, UDMASS_SCSI, "Unsupported ATAPI " - "command 0x%02x - trying anyway\n", - cmd_ptr[0]); - break;; - } - - bcopy(cmd_ptr, sc->sc_transfer.cmd_data, cmd_len); - return (1); /* success */ -} - -static uint8_t -umass_no_transform(struct umass_softc *sc, uint8_t *cmd, - uint8_t cmdlen) -{ - return (0); /* failure */ -} - -static uint8_t -umass_std_transform(struct umass_softc *sc, union ccb *ccb, - uint8_t *cmd, uint8_t cmdlen) -{ - uint8_t retval; - - retval = (sc->sc_transform) (sc, cmd, cmdlen); - - if (retval == 2) { - ccb->ccb_h.status = CAM_REQ_CMP; - xpt_done(ccb); - return (0); - } else if (retval == 0) { - ccb->ccb_h.status = CAM_REQ_INVALID; - xpt_done(ccb); - return (0); - } - /* Command should be executed */ - return (1); -} - -#if USB_DEBUG -static void -umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw) -{ - uint8_t *c = cbw->CBWCDB; - - uint32_t dlen = UGETDW(cbw->dCBWDataTransferLength); - uint32_t tag = UGETDW(cbw->dCBWTag); - - uint8_t clen = cbw->bCDBLength; - uint8_t flags = cbw->bCBWFlags; - uint8_t lun = cbw->bCBWLUN; - - DPRINTF(sc, UDMASS_BBB, "CBW %d: cmd = %db " - "(0x%02x%02x%02x%02x%02x%02x%s), " - "data = %db, lun = %d, dir = %s\n", - tag, clen, - c[0], c[1], c[2], c[3], c[4], c[5], (clen > 6 ? "..." : ""), - dlen, lun, (flags == CBWFLAGS_IN ? "in" : - (flags == CBWFLAGS_OUT ? "out" : "<invalid>"))); -} - -static void -umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw) -{ - uint32_t sig = UGETDW(csw->dCSWSignature); - uint32_t tag = UGETDW(csw->dCSWTag); - uint32_t res = UGETDW(csw->dCSWDataResidue); - uint8_t status = csw->bCSWStatus; - - DPRINTF(sc, UDMASS_BBB, "CSW %d: sig = 0x%08x (%s), tag = 0x%08x, " - "res = %d, status = 0x%02x (%s)\n", - tag, sig, (sig == CSWSIGNATURE ? "valid" : "invalid"), - tag, res, - status, (status == CSWSTATUS_GOOD ? "good" : - (status == CSWSTATUS_FAILED ? "failed" : - (status == CSWSTATUS_PHASE ? "phase" : "<invalid>")))); -} - -static void -umass_cbi_dump_cmd(struct umass_softc *sc, void *cmd, uint8_t cmdlen) -{ - uint8_t *c = cmd; - uint8_t dir = sc->sc_transfer.dir; - - DPRINTF(sc, UDMASS_BBB, "cmd = %db " - "(0x%02x%02x%02x%02x%02x%02x%s), " - "data = %db, dir = %s\n", - cmdlen, - c[0], c[1], c[2], c[3], c[4], c[5], (cmdlen > 6 ? "..." : ""), - sc->sc_transfer.data_len, - (dir == DIR_IN ? "in" : - (dir == DIR_OUT ? "out" : - (dir == DIR_NONE ? "no data phase" : "<invalid>")))); -} - -static void -umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, uint32_t buflen, - uint32_t printlen) -{ - uint32_t i, j; - char s1[40]; - char s2[40]; - char s3[5]; - - s1[0] = '\0'; - s3[0] = '\0'; - - sprintf(s2, " buffer=%p, buflen=%d", buffer, buflen); - for (i = 0; (i < buflen) && (i < printlen); i++) { - j = i % 16; - if (j == 0 && i != 0) { - DPRINTF(sc, UDMASS_GEN, "0x %s%s\n", - s1, s2); - s2[0] = '\0'; - } - sprintf(&s1[j * 2], "%02x", buffer[i] & 0xff); - } - if (buflen > printlen) - sprintf(s3, " ..."); - DPRINTF(sc, UDMASS_GEN, "0x %s%s%s\n", - s1, s2, s3); -} - -#endif diff --git a/sys/dev/usb2/storage/urio2.c b/sys/dev/usb2/storage/urio2.c deleted file mode 100644 index e592f77..0000000 --- a/sys/dev/usb2/storage/urio2.c +++ /dev/null @@ -1,480 +0,0 @@ -/*- - * Copyright (c) 2000 Iwasa Kazmi - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions, and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND - * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR - * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS - * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - * - * This code is based on ugen.c and ulpt.c developed by Lennart Augustsson. - * This code includes software developed by the NetBSD Foundation, Inc. and - * its contributors. - */ - -#include <sys/cdefs.h> -__FBSDID("$FreeBSD$"); - - -/* - * 2000/3/24 added NetBSD/OpenBSD support (from Alex Nemirovsky) - * 2000/3/07 use two bulk-pipe handles for read and write (Dirk) - * 2000/3/06 change major number(143), and copyright header - * some fix for 4.0 (Dirk) - * 2000/3/05 codes for FreeBSD 4.x - CURRENT (Thanks to Dirk-Willem van Gulik) - * 2000/3/01 remove retry code from urioioctl() - * change method of bulk transfer (no interrupt) - * 2000/2/28 small fixes for new rio_usb.h - * 2000/2/24 first version. - */ - -#include "usbdevs.h" -#include <dev/usb2/include/usb2_standard.h> -#include <dev/usb2/include/usb2_mfunc.h> -#include <dev/usb2/include/usb2_error.h> -#include <dev/usb2/include/usb2_ioctl.h> -#include <dev/usb/rio500_usb.h> - -#define USB_DEBUG_VAR urio_debug - -#include <dev/usb2/core/usb2_core.h> -#include <dev/usb2/core/usb2_debug.h> -#include <dev/usb2/core/usb2_process.h> -#include <dev/usb2/core/usb2_request.h> -#include <dev/usb2/core/usb2_lookup.h> -#include <dev/usb2/core/usb2_util.h> -#include <dev/usb2/core/usb2_busdma.h> -#include <dev/usb2/core/usb2_mbuf.h> -#include <dev/usb2/core/usb2_dev.h> -#include <dev/usb2/core/usb2_generic.h> - -#if USB_DEBUG -static int urio_debug = 0; - -SYSCTL_NODE(_hw_usb2, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio"); -SYSCTL_INT(_hw_usb2_urio, OID_AUTO, debug, CTLFLAG_RW, - &urio_debug, 0, "urio debug level"); -#endif - -#define URIO_T_WR 0 -#define URIO_T_RD 1 -#define URIO_T_WR_CS 2 -#define URIO_T_RD_CS 3 -#define URIO_T_MAX 4 - -#define URIO_BSIZE (1<<12) /* bytes */ -#define URIO_IFQ_MAXLEN 2 /* units */ - -struct urio_softc { - struct usb2_fifo_sc sc_fifo; - struct mtx sc_mtx; - - struct usb2_device *sc_udev; - struct usb2_xfer *sc_xfer[URIO_T_MAX]; - - uint8_t sc_flags; -#define URIO_FLAG_READ_STALL 0x01 /* read transfer stalled */ -#define URIO_FLAG_WRITE_STALL 0x02 /* write transfer stalled */ - - uint8_t sc_name[16]; -}; - -/* prototypes */ - -static device_probe_t urio_probe; -static device_attach_t urio_attach; -static device_detach_t urio_detach; - -static usb2_callback_t urio_write_callback; -static usb2_callback_t urio_write_clear_stall_callback; -static usb2_callback_t urio_read_callback; -static usb2_callback_t urio_read_clear_stall_callback; - -static usb2_fifo_close_t urio_close; -static usb2_fifo_cmd_t urio_start_read; -static usb2_fifo_cmd_t urio_start_write; -static usb2_fifo_cmd_t urio_stop_read; -static usb2_fifo_cmd_t urio_stop_write; -static usb2_fifo_ioctl_t urio_ioctl; -static usb2_fifo_open_t urio_open; - -static struct usb2_fifo_methods urio_fifo_methods = { - .f_close = &urio_close, - .f_ioctl = &urio_ioctl, - .f_open = &urio_open, - .f_start_read = &urio_start_read, - .f_start_write = &urio_start_write, - .f_stop_read = &urio_stop_read, - .f_stop_write = &urio_stop_write, - .basename[0] = "urio", -}; - -static const struct usb2_config urio_config[URIO_T_MAX] = { - [URIO_T_WR] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .mh.bufsize = URIO_BSIZE, - .mh.flags = {.pipe_bof = 1,.force_short_xfer = 1,.proxy_buffer = 1,}, - .mh.callback = &urio_write_callback, - }, - - [URIO_T_RD] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .mh.bufsize = URIO_BSIZE, - .mh.flags = {.pipe_bof = 1,.short_xfer_ok = 1,.proxy_buffer = 1,}, - .mh.callback = &urio_read_callback, - }, - - [URIO_T_WR_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &urio_write_clear_stall_callback, - .mh.timeout = 1000, /* 1 second */ - .mh.interval = 50, /* 50ms */ - }, - - [URIO_T_RD_CS] = { - .type = UE_CONTROL, - .endpoint = 0x00, /* Control pipe */ - .direction = UE_DIR_ANY, - .mh.bufsize = sizeof(struct usb2_device_request), - .mh.flags = {}, - .mh.callback = &urio_read_clear_stall_callback, - .mh.timeout = 1000, /* 1 second */ - .mh.interval = 50, /* 50ms */ - }, -}; - -static devclass_t urio_devclass; - -static device_method_t urio_methods[] = { - /* Device interface */ - DEVMETHOD(device_probe, urio_probe), - DEVMETHOD(device_attach, urio_attach), - DEVMETHOD(device_detach, urio_detach), - {0, 0} -}; - -static driver_t urio_driver = { - .name = "urio", - .methods = urio_methods, - .size = sizeof(struct urio_softc), -}; - -DRIVER_MODULE(urio, ushub, urio_driver, urio_devclass, NULL, 0); -MODULE_DEPEND(urio, usb2_storage, 1, 1, 1); -MODULE_DEPEND(urio, usb2_core, 1, 1, 1); - -static int -urio_probe(device_t dev) -{ - struct usb2_attach_arg *uaa = device_get_ivars(dev); - - if (uaa->usb2_mode != USB_MODE_HOST) { - return (ENXIO); - } - if ((((uaa->info.idVendor == USB_VENDOR_DIAMOND) && - (uaa->info.idProduct == USB_PRODUCT_DIAMOND_RIO500USB)) || - ((uaa->info.idVendor == USB_VENDOR_DIAMOND2) && - ((uaa->info.idProduct == USB_PRODUCT_DIAMOND2_RIO600USB) || - (uaa->info.idProduct == USB_PRODUCT_DIAMOND2_RIO800USB))))) - return (0); - else - return (ENXIO); -} - -static int -urio_attach(device_t dev) -{ - struct usb2_attach_arg *uaa = device_get_ivars(dev); - struct urio_softc *sc = device_get_softc(dev); - int error; - - device_set_usb2_desc(dev); - - sc->sc_udev = uaa->device; - - mtx_init(&sc->sc_mtx, "urio lock", NULL, MTX_DEF | MTX_RECURSE); - - snprintf(sc->sc_name, sizeof(sc->sc_name), - "%s", device_get_nameunit(dev)); - - error = usb2_transfer_setup(uaa->device, - &uaa->info.bIfaceIndex, sc->sc_xfer, - urio_config, URIO_T_MAX, sc, &sc->sc_mtx); - - if (error) { - DPRINTF("error=%s\n", usb2_errstr(error)); - goto detach; - } - /* set interface permissions */ - usb2_set_iface_perm(uaa->device, uaa->info.bIfaceIndex, - UID_ROOT, GID_OPERATOR, 0644); - - error = usb2_fifo_attach(uaa->device, sc, &sc->sc_mtx, - &urio_fifo_methods, &sc->sc_fifo, - device_get_unit(dev), 0 - 1, uaa->info.bIfaceIndex); - if (error) { - goto detach; - } - return (0); /* success */ - -detach: - urio_detach(dev); - return (ENOMEM); /* failure */ -} - -static void -urio_write_callback(struct usb2_xfer *xfer) -{ - struct urio_softc *sc = xfer->priv_sc; - struct usb2_fifo *f = sc->sc_fifo.fp[USB_FIFO_TX]; - uint32_t actlen; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - case USB_ST_SETUP: - if (sc->sc_flags & URIO_FLAG_WRITE_STALL) { - usb2_transfer_start(sc->sc_xfer[URIO_T_WR_CS]); - return; - } - if (usb2_fifo_get_data(f, xfer->frbuffers, 0, - xfer->max_data_length, &actlen, 0)) { - - xfer->frlengths[0] = actlen; - usb2_start_hardware(xfer); - } - return; - - default: /* Error */ - if (xfer->error != USB_ERR_CANCELLED) { - /* try to clear stall first */ - sc->sc_flags |= URIO_FLAG_WRITE_STALL; - usb2_transfer_start(sc->sc_xfer[URIO_T_WR_CS]); - } - return; - } -} - -static void -urio_write_clear_stall_callback(struct usb2_xfer *xfer) -{ - struct urio_softc *sc = xfer->priv_sc; - struct usb2_xfer *xfer_other = sc->sc_xfer[URIO_T_WR]; - - if (usb2_clear_stall_callback(xfer, xfer_other)) { - DPRINTF("stall cleared\n"); - sc->sc_flags &= ~URIO_FLAG_WRITE_STALL; - usb2_transfer_start(xfer_other); - } -} - -static void -urio_read_callback(struct usb2_xfer *xfer) -{ - struct urio_softc *sc = xfer->priv_sc; - struct usb2_fifo *f = sc->sc_fifo.fp[USB_FIFO_RX]; - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - usb2_fifo_put_data(f, xfer->frbuffers, 0, - xfer->actlen, 1); - - case USB_ST_SETUP: - if (sc->sc_flags & URIO_FLAG_READ_STALL) { - usb2_transfer_start(sc->sc_xfer[URIO_T_RD_CS]); - return; - } - if (usb2_fifo_put_bytes_max(f) != 0) { - xfer->frlengths[0] = xfer->max_data_length; - usb2_start_hardware(xfer); - } - return; - - default: /* Error */ - if (xfer->error != USB_ERR_CANCELLED) { - /* try to clear stall first */ - sc->sc_flags |= URIO_FLAG_READ_STALL; - usb2_transfer_start(sc->sc_xfer[URIO_T_RD_CS]); - } - return; - } -} - -static void -urio_read_clear_stall_callback(struct usb2_xfer *xfer) -{ - struct urio_softc *sc = xfer->priv_sc; - struct usb2_xfer *xfer_other = sc->sc_xfer[URIO_T_RD]; - - if (usb2_clear_stall_callback(xfer, xfer_other)) { - DPRINTF("stall cleared\n"); - sc->sc_flags &= ~URIO_FLAG_READ_STALL; - usb2_transfer_start(xfer_other); - } -} - -static void -urio_start_read(struct usb2_fifo *fifo) -{ - struct urio_softc *sc = fifo->priv_sc0; - - usb2_transfer_start(sc->sc_xfer[URIO_T_RD]); -} - -static void -urio_stop_read(struct usb2_fifo *fifo) -{ - struct urio_softc *sc = fifo->priv_sc0; - - usb2_transfer_stop(sc->sc_xfer[URIO_T_RD_CS]); - usb2_transfer_stop(sc->sc_xfer[URIO_T_RD]); -} - -static void -urio_start_write(struct usb2_fifo *fifo) -{ - struct urio_softc *sc = fifo->priv_sc0; - - usb2_transfer_start(sc->sc_xfer[URIO_T_WR]); -} - -static void -urio_stop_write(struct usb2_fifo *fifo) -{ - struct urio_softc *sc = fifo->priv_sc0; - - usb2_transfer_stop(sc->sc_xfer[URIO_T_WR_CS]); - usb2_transfer_stop(sc->sc_xfer[URIO_T_WR]); -} - -static int -urio_open(struct usb2_fifo *fifo, int fflags, struct thread *td) -{ - struct urio_softc *sc = fifo->priv_sc0; - - if ((fflags & (FWRITE | FREAD)) != (FWRITE | FREAD)) { - return (EACCES); - } - if (fflags & FREAD) { - /* clear stall first */ - mtx_lock(&sc->sc_mtx); - sc->sc_flags |= URIO_FLAG_READ_STALL; - mtx_unlock(&sc->sc_mtx); - - if (usb2_fifo_alloc_buffer(fifo, - sc->sc_xfer[URIO_T_RD]->max_data_length, - URIO_IFQ_MAXLEN)) { - return (ENOMEM); - } - } - if (fflags & FWRITE) { - /* clear stall first */ - sc->sc_flags |= URIO_FLAG_WRITE_STALL; - - if (usb2_fifo_alloc_buffer(fifo, - sc->sc_xfer[URIO_T_WR]->max_data_length, - URIO_IFQ_MAXLEN)) { - return (ENOMEM); - } - } - return (0); /* success */ -} - -static void -urio_close(struct usb2_fifo *fifo, int fflags, struct thread *td) -{ - if (fflags & (FREAD | FWRITE)) { - usb2_fifo_free_buffer(fifo); - } -} - -static int -urio_ioctl(struct usb2_fifo *fifo, u_long cmd, void *addr, - int fflags, struct thread *td) -{ - struct usb2_ctl_request ur; - struct RioCommand *rio_cmd; - int error; - - switch (cmd) { - case RIO_RECV_COMMAND: - if (!(fflags & FWRITE)) { - error = EPERM; - goto done; - } - bzero(&ur, sizeof(ur)); - rio_cmd = addr; - ur.ucr_request.bmRequestType = - rio_cmd->requesttype | UT_READ_VENDOR_DEVICE; - break; - - case RIO_SEND_COMMAND: - if (!(fflags & FWRITE)) { - error = EPERM; - goto done; - } - bzero(&ur, sizeof(ur)); - rio_cmd = addr; - ur.ucr_request.bmRequestType = - rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE; - break; - - default: - error = EINVAL; - goto done; - } - - DPRINTFN(2, "Sending command\n"); - - /* Send rio control message */ - ur.ucr_request.bRequest = rio_cmd->request; - USETW(ur.ucr_request.wValue, rio_cmd->value); - USETW(ur.ucr_request.wIndex, rio_cmd->index); - USETW(ur.ucr_request.wLength, rio_cmd->length); - ur.ucr_data = rio_cmd->buffer; - - /* reuse generic USB code */ - error = ugen_do_request(fifo, &ur); - -done: - return (error); -} - -static int -urio_detach(device_t dev) -{ - struct urio_softc *sc = device_get_softc(dev); - - DPRINTF("\n"); - - usb2_fifo_detach(&sc->sc_fifo); - - usb2_transfer_unsetup(sc->sc_xfer, URIO_T_MAX); - - mtx_destroy(&sc->sc_mtx); - - return (0); -} diff --git a/sys/dev/usb2/storage/usb2_storage.c b/sys/dev/usb2/storage/usb2_storage.c deleted file mode 100644 index c8233ef..0000000 --- a/sys/dev/usb2/storage/usb2_storage.c +++ /dev/null @@ -1,31 +0,0 @@ -/* $FreeBSD$ */ -/*- - * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND - * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS - * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ - -#include <dev/usb2/core/usb2_core.h> -#include <dev/usb2/storage/usb2_storage.h> - -MODULE_VERSION(usb2_storage, 1); -MODULE_DEPEND(usb2_storage, usb2_core, 1, 1, 1); diff --git a/sys/dev/usb2/storage/usb2_storage.h b/sys/dev/usb2/storage/usb2_storage.h deleted file mode 100644 index f40828a..0000000 --- a/sys/dev/usb2/storage/usb2_storage.h +++ /dev/null @@ -1,30 +0,0 @@ -/* $FreeBSD$ */ -/*- - * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND - * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS - * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ - -#ifndef _USB2_STORAGE_H_ -#define _USB2_STORAGE_H_ - -#endif /* _USB2_STORAGE_H_ */ diff --git a/sys/dev/usb2/storage/ustorage2_fs.c b/sys/dev/usb2/storage/ustorage2_fs.c deleted file mode 100644 index 2fb42a5..0000000 --- a/sys/dev/usb2/storage/ustorage2_fs.c +++ /dev/null @@ -1,1898 +0,0 @@ -/* $FreeBSD$ */ -/*- - * Copyright (C) 2003-2005 Alan Stern - * Copyright (C) 2008 Hans Petter Selasky - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions, and the following disclaimer, - * without modification. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * 3. The names of the above-listed copyright holders may not be used - * to endorse or promote products derived from this software without - * specific prior written permission. - * - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS - * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, - * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR - * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, - * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR - * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF - * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING - * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/* - * NOTE: Much of the SCSI statemachine handling code derives from the - * Linux USB gadget stack. - */ -#include "usbdevs.h" -#include <dev/usb2/include/usb2_standard.h> -#include <dev/usb2/include/usb2_mfunc.h> -#include <dev/usb2/include/usb2_error.h> -#include <dev/usb2/include/usb2_defs.h> - -#define USB_DEBUG_VAR ustorage_fs_debug - -#include <dev/usb2/core/usb2_core.h> -#include <dev/usb2/core/usb2_util.h> -#include <dev/usb2/core/usb2_busdma.h> -#include <dev/usb2/core/usb2_debug.h> -#include <dev/usb2/core/usb2_process.h> -#include <dev/usb2/core/usb2_device.h> - -#if USB_DEBUG -static int ustorage_fs_debug = 0; - -SYSCTL_NODE(_hw_usb2, OID_AUTO, ustorage_fs, CTLFLAG_RW, 0, "USB ustorage_fs"); -SYSCTL_INT(_hw_usb2_ustorage_fs, OID_AUTO, debug, CTLFLAG_RW, - &ustorage_fs_debug, 0, "ustorage_fs debug level"); -#endif - -/* Define some limits */ - -#define USTORAGE_FS_BULK_SIZE (1 << 17) -#define USTORAGE_FS_MAX_LUN 8 -#define USTORAGE_FS_RELEASE 0x0101 -#define USTORAGE_FS_RAM_SECT (1 << 13) - -static uint8_t *ustorage_fs_ramdisk; - -/* USB transfer definitions */ - -#define USTORAGE_FS_T_BBB_COMMAND 0 -#define USTORAGE_FS_T_BBB_DATA_DUMP 1 -#define USTORAGE_FS_T_BBB_DATA_READ 2 -#define USTORAGE_FS_T_BBB_DATA_WRITE 3 -#define USTORAGE_FS_T_BBB_STATUS 4 -#define USTORAGE_FS_T_BBB_MAX 5 - -/* USB data stage direction */ - -#define DIR_NONE 0 -#define DIR_READ 1 -#define DIR_WRITE 2 - -/* USB interface specific control request */ - -#define UR_BBB_RESET 0xff /* Bulk-Only reset */ -#define UR_BBB_GET_MAX_LUN 0xfe /* Get maximum lun */ - -/* Command Block Wrapper */ -typedef struct { - uDWord dCBWSignature; -#define CBWSIGNATURE 0x43425355 - uDWord dCBWTag; - uDWord dCBWDataTransferLength; - uByte bCBWFlags; -#define CBWFLAGS_OUT 0x00 -#define CBWFLAGS_IN 0x80 - uByte bCBWLUN; - uByte bCDBLength; -#define CBWCDBLENGTH 16 - uByte CBWCDB[CBWCDBLENGTH]; -} __packed ustorage_fs_bbb_cbw_t; - -#define USTORAGE_FS_BBB_CBW_SIZE 31 - -/* Command Status Wrapper */ -typedef struct { - uDWord dCSWSignature; -#define CSWSIGNATURE 0x53425355 - uDWord dCSWTag; - uDWord dCSWDataResidue; - uByte bCSWStatus; -#define CSWSTATUS_GOOD 0x0 -#define CSWSTATUS_FAILED 0x1 -#define CSWSTATUS_PHASE 0x2 -} __packed ustorage_fs_bbb_csw_t; - -#define USTORAGE_FS_BBB_CSW_SIZE 13 - -struct ustorage_fs_lun { - - void *memory_image; - - uint32_t num_sectors; - uint32_t sense_data; - uint32_t sense_data_info; - uint32_t unit_attention_data; - - uint8_t read_only:1; - uint8_t prevent_medium_removal:1; - uint8_t info_valid:1; - uint8_t removable:1; -}; - -struct ustorage_fs_softc { - - ustorage_fs_bbb_cbw_t sc_cbw; /* Command Wrapper Block */ - ustorage_fs_bbb_csw_t sc_csw; /* Command Status Block */ - - struct mtx sc_mtx; - - struct ustorage_fs_lun sc_lun[USTORAGE_FS_MAX_LUN]; - - struct { - uint8_t *data_ptr; - struct ustorage_fs_lun *currlun; - - uint32_t data_rem; /* bytes, as reported by the command - * block wrapper */ - uint32_t offset; /* bytes */ - - uint8_t cbw_dir; - uint8_t cmd_dir; - uint8_t lun; - uint8_t cmd_data[CBWCDBLENGTH]; - uint8_t cmd_len; - uint8_t data_short:1; - uint8_t data_error:1; - } sc_transfer; - - device_t sc_dev; - struct usb2_device *sc_udev; - struct usb2_xfer *sc_xfer[USTORAGE_FS_T_BBB_MAX]; - - uint32_t sc_unit; - - uint8_t sc_name[16]; - uint8_t sc_iface_no; /* interface number */ - uint8_t sc_last_lun; - uint8_t sc_last_xfer_index; - uint8_t sc_qdata[1024]; -}; - -/* prototypes */ - -static device_probe_t ustorage_fs_probe; -static device_attach_t ustorage_fs_attach; -static device_detach_t ustorage_fs_detach; -static device_suspend_t ustorage_fs_suspend; -static device_resume_t ustorage_fs_resume; -static device_shutdown_t ustorage_fs_shutdown; -static usb2_handle_request_t ustorage_fs_handle_request; - -static usb2_callback_t ustorage_fs_t_bbb_command_callback; -static usb2_callback_t ustorage_fs_t_bbb_data_dump_callback; -static usb2_callback_t ustorage_fs_t_bbb_data_read_callback; -static usb2_callback_t ustorage_fs_t_bbb_data_write_callback; -static usb2_callback_t ustorage_fs_t_bbb_status_callback; - -static void ustorage_fs_transfer_start(struct ustorage_fs_softc *sc, uint8_t xfer_index); -static void ustorage_fs_transfer_stop(struct ustorage_fs_softc *sc); - -static uint8_t ustorage_fs_verify(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_inquiry(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_request_sense(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_read_capacity(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_mode_sense(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_start_stop(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_prevent_allow(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_read_format_capacities(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_mode_select(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_min_len(struct ustorage_fs_softc *sc, uint32_t len, uint32_t mask); -static uint8_t ustorage_fs_read(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_write(struct ustorage_fs_softc *sc); -static uint8_t ustorage_fs_check_cmd(struct ustorage_fs_softc *sc, uint8_t cmd_size, uint16_t mask, uint8_t needs_medium); -static uint8_t ustorage_fs_do_cmd(struct ustorage_fs_softc *sc); - -static device_method_t ustorage_fs_methods[] = { - /* USB interface */ - DEVMETHOD(usb2_handle_request, ustorage_fs_handle_request), - - /* Device interface */ - DEVMETHOD(device_probe, ustorage_fs_probe), - DEVMETHOD(device_attach, ustorage_fs_attach), - DEVMETHOD(device_detach, ustorage_fs_detach), - DEVMETHOD(device_suspend, ustorage_fs_suspend), - DEVMETHOD(device_resume, ustorage_fs_resume), - DEVMETHOD(device_shutdown, ustorage_fs_shutdown), - - {0, 0} -}; - -static driver_t ustorage_fs_driver = { - .name = "ustorage_fs", - .methods = ustorage_fs_methods, - .size = sizeof(struct ustorage_fs_softc), -}; - -static devclass_t ustorage_fs_devclass; - -DRIVER_MODULE(ustorage_fs, ushub, ustorage_fs_driver, ustorage_fs_devclass, NULL, 0); -MODULE_VERSION(ustorage_fs, 0); -MODULE_DEPEND(ustorage_fs, usb2_storage, 1, 1, 1); -MODULE_DEPEND(ustorage_fs, usb2_core, 1, 1, 1); - -struct usb2_config ustorage_fs_bbb_config[USTORAGE_FS_T_BBB_MAX] = { - - [USTORAGE_FS_T_BBB_COMMAND] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .md.bufsize = sizeof(ustorage_fs_bbb_cbw_t), - .md.flags = {.ext_buffer = 1,}, - .md.callback = &ustorage_fs_t_bbb_command_callback, - }, - - [USTORAGE_FS_T_BBB_DATA_DUMP] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .md.bufsize = 0, /* use wMaxPacketSize */ - .md.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,}, - .md.callback = &ustorage_fs_t_bbb_data_dump_callback, - }, - - [USTORAGE_FS_T_BBB_DATA_READ] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_OUT, - .md.bufsize = USTORAGE_FS_BULK_SIZE, - .md.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,.ext_buffer = 1}, - .md.callback = &ustorage_fs_t_bbb_data_read_callback, - }, - - [USTORAGE_FS_T_BBB_DATA_WRITE] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .md.bufsize = USTORAGE_FS_BULK_SIZE, - .md.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,.ext_buffer = 1}, - .md.callback = &ustorage_fs_t_bbb_data_write_callback, - }, - - [USTORAGE_FS_T_BBB_STATUS] = { - .type = UE_BULK, - .endpoint = UE_ADDR_ANY, - .direction = UE_DIR_IN, - .md.bufsize = sizeof(ustorage_fs_bbb_csw_t), - .md.flags = {.short_xfer_ok = 1,.ext_buffer = 1,}, - .md.callback = &ustorage_fs_t_bbb_status_callback, - }, -}; - -/* - * USB device probe/attach/detach - */ - -static int -ustorage_fs_probe(device_t dev) -{ - struct usb2_attach_arg *uaa = device_get_ivars(dev); - struct usb2_interface_descriptor *id; - - if (uaa->usb2_mode != USB_MODE_DEVICE) { - return (ENXIO); - } - if (uaa->use_generic == 0) { - /* give other drivers a try first */ - return (ENXIO); - } - /* Check for a standards compliant device */ - id = usb2_get_interface_descriptor(uaa->iface); - if ((id == NULL) || - (id->bInterfaceClass != UICLASS_MASS) || - (id->bInterfaceSubClass != UISUBCLASS_SCSI) || - (id->bInterfaceProtocol != UIPROTO_MASS_BBB)) { - return (ENXIO); - } - return (0); -} - -static int -ustorage_fs_attach(device_t dev) -{ - struct ustorage_fs_softc *sc = device_get_softc(dev); - struct usb2_attach_arg *uaa = device_get_ivars(dev); - struct usb2_interface_descriptor *id; - int err; - - /* - * NOTE: the softc struct is bzero-ed in device_set_driver. - * We can safely call ustorage_fs_detach without specifically - * initializing the struct. - */ - - sc->sc_dev = dev; - sc->sc_udev = uaa->device; - sc->sc_unit = device_get_unit(dev); - - if (sc->sc_unit == 0) { - if (ustorage_fs_ramdisk == NULL) { - /* - * allocate a memory image for our ramdisk until - * further - */ - ustorage_fs_ramdisk = - malloc(USTORAGE_FS_RAM_SECT << 9, M_USB, M_ZERO | M_WAITOK); - if (ustorage_fs_ramdisk == NULL) { - return (ENOMEM); - } - } - sc->sc_lun[0].memory_image = ustorage_fs_ramdisk; - sc->sc_lun[0].num_sectors = USTORAGE_FS_RAM_SECT; - sc->sc_lun[0].removable = 1; - } - snprintf(sc->sc_name, sizeof(sc->sc_name), - "%s", device_get_nameunit(dev)); - - device_set_usb2_desc(dev); - - mtx_init(&sc->sc_mtx, "USTORAGE_FS lock", - NULL, (MTX_DEF | MTX_RECURSE)); - - /* get interface index */ - - id = usb2_get_interface_descriptor(uaa->iface); - if (id == NULL) { - device_printf(dev, "failed to get " - "interface number\n"); - goto detach; - } - sc->sc_iface_no = id->bInterfaceNumber; - - err = usb2_transfer_setup(uaa->device, - &uaa->info.bIfaceIndex, sc->sc_xfer, ustorage_fs_bbb_config, - USTORAGE_FS_T_BBB_MAX, sc, &sc->sc_mtx); - if (err) { - device_printf(dev, "could not setup required " - "transfers, %s\n", usb2_errstr(err)); - goto detach; - } - /* start Mass Storage State Machine */ - - mtx_lock(&sc->sc_mtx); - ustorage_fs_transfer_start(sc, USTORAGE_FS_T_BBB_COMMAND); - mtx_unlock(&sc->sc_mtx); - - return (0); /* success */ - -detach: - ustorage_fs_detach(dev); - return (ENXIO); /* failure */ -} - -static int -ustorage_fs_detach(device_t dev) -{ - struct ustorage_fs_softc *sc = device_get_softc(dev); - - /* teardown our statemachine */ - - usb2_transfer_unsetup(sc->sc_xfer, USTORAGE_FS_T_BBB_MAX); - - mtx_destroy(&sc->sc_mtx); - - return (0); /* success */ -} - -static int -ustorage_fs_suspend(device_t dev) -{ - device_printf(dev, "suspending\n"); - return (0); /* success */ -} - -static int -ustorage_fs_resume(device_t dev) -{ - device_printf(dev, "resuming\n"); - return (0); /* success */ -} - -static int -ustorage_fs_shutdown(device_t dev) -{ - return (0); /* success */ -} - -/* - * Generic functions to handle transfers - */ - -static void -ustorage_fs_transfer_start(struct ustorage_fs_softc *sc, uint8_t xfer_index) -{ - if (sc->sc_xfer[xfer_index]) { - sc->sc_last_xfer_index = xfer_index; - usb2_transfer_start(sc->sc_xfer[xfer_index]); - } -} - -static void -ustorage_fs_transfer_stop(struct ustorage_fs_softc *sc) -{ - usb2_transfer_stop(sc->sc_xfer[sc->sc_last_xfer_index]); - mtx_unlock(&sc->sc_mtx); - usb2_transfer_drain(sc->sc_xfer[sc->sc_last_xfer_index]); - mtx_lock(&sc->sc_mtx); -} - -static int -ustorage_fs_handle_request(device_t dev, - const void *preq, void **pptr, uint16_t *plen, - uint16_t offset, uint8_t is_complete) -{ - struct ustorage_fs_softc *sc = device_get_softc(dev); - const struct usb2_device_request *req = preq; - - if (!is_complete) { - if (req->bRequest == UR_BBB_RESET) { - *plen = 0; - mtx_lock(&sc->sc_mtx); - ustorage_fs_transfer_stop(sc); - sc->sc_transfer.data_error = 1; - ustorage_fs_transfer_start(sc, - USTORAGE_FS_T_BBB_COMMAND); - mtx_unlock(&sc->sc_mtx); - return (0); - } else if (req->bRequest == UR_BBB_GET_MAX_LUN) { - if (offset == 0) { - *plen = 1; - *pptr = &sc->sc_last_lun; - } else { - *plen = 0; - } - return (0); - } - } - return (ENXIO); /* use builtin handler */ -} - -static void -ustorage_fs_t_bbb_command_callback(struct usb2_xfer *xfer) -{ - struct ustorage_fs_softc *sc = xfer->priv_sc; - uint32_t tag; - uint8_t error = 0; - - DPRINTF("\n"); - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - - tag = UGETDW(sc->sc_cbw.dCBWSignature); - - if (tag != CBWSIGNATURE) { - /* do nothing */ - DPRINTF("invalid signature 0x%08x\n", tag); - break; - } - tag = UGETDW(sc->sc_cbw.dCBWTag); - - /* echo back tag */ - USETDW(sc->sc_csw.dCSWTag, tag); - - /* reset status */ - sc->sc_csw.bCSWStatus = 0; - - /* reset data offset, data length and data remainder */ - sc->sc_transfer.offset = 0; - sc->sc_transfer.data_rem = - UGETDW(sc->sc_cbw.dCBWDataTransferLength); - - /* reset data flags */ - sc->sc_transfer.data_short = 0; - - /* extract LUN */ - sc->sc_transfer.lun = sc->sc_cbw.bCBWLUN; - - if (sc->sc_transfer.data_rem == 0) { - sc->sc_transfer.cbw_dir = DIR_NONE; - } else { - if (sc->sc_cbw.bCBWFlags & CBWFLAGS_IN) { - sc->sc_transfer.cbw_dir = DIR_WRITE; - } else { - sc->sc_transfer.cbw_dir = DIR_READ; - } - } - - sc->sc_transfer.cmd_len = sc->sc_cbw.bCDBLength; - if ((sc->sc_transfer.cmd_len > sizeof(sc->sc_cbw.CBWCDB)) || - (sc->sc_transfer.cmd_len == 0)) { - /* just halt - this is invalid */ - DPRINTF("invalid command length %d bytes\n", - sc->sc_transfer.cmd_len); - break; - } - bcopy(sc->sc_cbw.CBWCDB, sc->sc_transfer.cmd_data, - sc->sc_transfer.cmd_len); - - bzero(sc->sc_cbw.CBWCDB + sc->sc_transfer.cmd_len, - sizeof(sc->sc_cbw.CBWCDB) - sc->sc_transfer.cmd_len); - - error = ustorage_fs_do_cmd(sc); - if (error) { - /* got an error */ - DPRINTF("command failed\n"); - break; - } - if ((sc->sc_transfer.data_rem > 0) && - (sc->sc_transfer.cbw_dir != sc->sc_transfer.cmd_dir)) { - /* contradicting data transfer direction */ - error = 1; - DPRINTF("data direction mismatch\n"); - break; - } - switch (sc->sc_transfer.cbw_dir) { - case DIR_READ: - ustorage_fs_transfer_start(sc, USTORAGE_FS_T_BBB_DATA_READ); - break; - case DIR_WRITE: - ustorage_fs_transfer_start(sc, USTORAGE_FS_T_BBB_DATA_WRITE); - break; - default: - ustorage_fs_transfer_start(sc, - USTORAGE_FS_T_BBB_STATUS); - break; - } - break; - - case USB_ST_SETUP: -tr_setup: - if (sc->sc_transfer.data_error) { - sc->sc_transfer.data_error = 0; - xfer->flags.stall_pipe = 1; - DPRINTF("stall pipe\n"); - } else { - xfer->flags.stall_pipe = 0; - } - - xfer->frlengths[0] = sizeof(sc->sc_cbw); - usb2_set_frame_data(xfer, &sc->sc_cbw, 0); - usb2_start_hardware(xfer); - break; - - default: /* Error */ - DPRINTF("error\n"); - if (xfer->error == USB_ERR_CANCELLED) { - break; - } - /* If the pipe is already stalled, don't do another stall */ - if (!xfer->pipe->is_stalled) { - sc->sc_transfer.data_error = 1; - } - /* try again */ - goto tr_setup; - } - if (error) { - if (sc->sc_csw.bCSWStatus == 0) { - /* set some default error code */ - sc->sc_csw.bCSWStatus = CSWSTATUS_FAILED; - } - if (sc->sc_transfer.cbw_dir == DIR_READ) { - /* dump all data */ - ustorage_fs_transfer_start(sc, - USTORAGE_FS_T_BBB_DATA_DUMP); - return; - } - if (sc->sc_transfer.cbw_dir == DIR_WRITE) { - /* need to stall before status */ - sc->sc_transfer.data_error = 1; - } - ustorage_fs_transfer_start(sc, USTORAGE_FS_T_BBB_STATUS); - } -} - -static void -ustorage_fs_t_bbb_data_dump_callback(struct usb2_xfer *xfer) -{ - struct ustorage_fs_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - DPRINTF("\n"); - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - sc->sc_transfer.data_rem -= xfer->actlen; - sc->sc_transfer.offset += xfer->actlen; - - if ((xfer->actlen != xfer->sumlen) || - (sc->sc_transfer.data_rem == 0)) { - /* short transfer or end of data */ - ustorage_fs_transfer_start(sc, - USTORAGE_FS_T_BBB_STATUS); - break; - } - /* Fallthrough */ - - case USB_ST_SETUP: -tr_setup: - if (max_bulk > sc->sc_transfer.data_rem) { - max_bulk = sc->sc_transfer.data_rem; - } - if (sc->sc_transfer.data_error) { - sc->sc_transfer.data_error = 0; - xfer->flags.stall_pipe = 1; - } else { - xfer->flags.stall_pipe = 0; - } - xfer->frlengths[0] = max_bulk; - usb2_start_hardware(xfer); - break; - - default: /* Error */ - if (xfer->error == USB_ERR_CANCELLED) { - break; - } - /* - * If the pipe is already stalled, don't do another stall: - */ - if (!xfer->pipe->is_stalled) { - sc->sc_transfer.data_error = 1; - } - /* try again */ - goto tr_setup; - } -} - -static void -ustorage_fs_t_bbb_data_read_callback(struct usb2_xfer *xfer) -{ - struct ustorage_fs_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - DPRINTF("\n"); - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - sc->sc_transfer.data_rem -= xfer->actlen; - sc->sc_transfer.data_ptr += xfer->actlen; - sc->sc_transfer.offset += xfer->actlen; - - if ((xfer->actlen != xfer->sumlen) || - (sc->sc_transfer.data_rem == 0)) { - /* short transfer or end of data */ - ustorage_fs_transfer_start(sc, - USTORAGE_FS_T_BBB_STATUS); - break; - } - /* Fallthrough */ - - case USB_ST_SETUP: -tr_setup: - if (max_bulk > sc->sc_transfer.data_rem) { - max_bulk = sc->sc_transfer.data_rem; - } - if (sc->sc_transfer.data_error) { - sc->sc_transfer.data_error = 0; - xfer->flags.stall_pipe = 1; - } else { - xfer->flags.stall_pipe = 0; - } - - xfer->frlengths[0] = max_bulk; - usb2_set_frame_data(xfer, sc->sc_transfer.data_ptr, 0); - usb2_start_hardware(xfer); - break; - - default: /* Error */ - if (xfer->error == USB_ERR_CANCELLED) { - break; - } - /* If the pipe is already stalled, don't do another stall */ - if (!xfer->pipe->is_stalled) { - sc->sc_transfer.data_error = 1; - } - /* try again */ - goto tr_setup; - } -} - -static void -ustorage_fs_t_bbb_data_write_callback(struct usb2_xfer *xfer) -{ - struct ustorage_fs_softc *sc = xfer->priv_sc; - uint32_t max_bulk = xfer->max_data_length; - - DPRINTF("\n"); - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - sc->sc_transfer.data_rem -= xfer->actlen; - sc->sc_transfer.data_ptr += xfer->actlen; - sc->sc_transfer.offset += xfer->actlen; - - if ((xfer->actlen != xfer->sumlen) || - (sc->sc_transfer.data_rem == 0)) { - /* short transfer or end of data */ - ustorage_fs_transfer_start(sc, - USTORAGE_FS_T_BBB_STATUS); - break; - } - case USB_ST_SETUP: -tr_setup: - if (max_bulk >= sc->sc_transfer.data_rem) { - max_bulk = sc->sc_transfer.data_rem; - if (sc->sc_transfer.data_short) { - xfer->flags.force_short_xfer = 1; - } else { - xfer->flags.force_short_xfer = 0; - } - } else { - xfer->flags.force_short_xfer = 0; - } - - if (sc->sc_transfer.data_error) { - sc->sc_transfer.data_error = 0; - xfer->flags.stall_pipe = 1; - } else { - xfer->flags.stall_pipe = 0; - } - - xfer->frlengths[0] = max_bulk; - usb2_set_frame_data(xfer, sc->sc_transfer.data_ptr, 0); - usb2_start_hardware(xfer); - break; - - default: /* Error */ - if (xfer->error == USB_ERR_CANCELLED) { - break; - } - /* - * If the pipe is already stalled, don't do another - * stall - */ - if (!xfer->pipe->is_stalled) { - sc->sc_transfer.data_error = 1; - } - /* try again */ - goto tr_setup; - } -} - -static void -ustorage_fs_t_bbb_status_callback(struct usb2_xfer *xfer) -{ - struct ustorage_fs_softc *sc = xfer->priv_sc; - - DPRINTF("\n"); - - switch (USB_GET_STATE(xfer)) { - case USB_ST_TRANSFERRED: - ustorage_fs_transfer_start(sc, USTORAGE_FS_T_BBB_COMMAND); - break; - - case USB_ST_SETUP: -tr_setup: - USETDW(sc->sc_csw.dCSWSignature, CSWSIGNATURE); - USETDW(sc->sc_csw.dCSWDataResidue, sc->sc_transfer.data_rem); - - if (sc->sc_transfer.data_error) { - sc->sc_transfer.data_error = 0; - xfer->flags.stall_pipe = 1; - } else { - xfer->flags.stall_pipe = 0; - } - - xfer->frlengths[0] = sizeof(sc->sc_csw); - usb2_set_frame_data(xfer, &sc->sc_csw, 0); - usb2_start_hardware(xfer); - break; - - default: - if (xfer->error == USB_ERR_CANCELLED) { - break; - } - /* If the pipe is already stalled, don't do another stall */ - if (!xfer->pipe->is_stalled) { - sc->sc_transfer.data_error = 1; - } - /* try again */ - goto tr_setup; - } -} - -/* SCSI commands that we recognize */ -#define SC_FORMAT_UNIT 0x04 -#define SC_INQUIRY 0x12 -#define SC_MODE_SELECT_6 0x15 -#define SC_MODE_SELECT_10 0x55 -#define SC_MODE_SENSE_6 0x1a -#define SC_MODE_SENSE_10 0x5a -#define SC_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e -#define SC_READ_6 0x08 -#define SC_READ_10 0x28 -#define SC_READ_12 0xa8 -#define SC_READ_CAPACITY 0x25 -#define SC_READ_FORMAT_CAPACITIES 0x23 -#define SC_RELEASE 0x17 -#define SC_REQUEST_SENSE 0x03 -#define SC_RESERVE 0x16 -#define SC_SEND_DIAGNOSTIC 0x1d -#define SC_START_STOP_UNIT 0x1b -#define SC_SYNCHRONIZE_CACHE 0x35 -#define SC_TEST_UNIT_READY 0x00 -#define SC_VERIFY 0x2f -#define SC_WRITE_6 0x0a -#define SC_WRITE_10 0x2a -#define SC_WRITE_12 0xaa - -/* SCSI Sense Key/Additional Sense Code/ASC Qualifier values */ -#define SS_NO_SENSE 0 -#define SS_COMMUNICATION_FAILURE 0x040800 -#define SS_INVALID_COMMAND 0x052000 -#define SS_INVALID_FIELD_IN_CDB 0x052400 -#define SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x052100 -#define SS_LOGICAL_UNIT_NOT_SUPPORTED 0x052500 -#define SS_MEDIUM_NOT_PRESENT 0x023a00 -#define SS_MEDIUM_REMOVAL_PREVENTED 0x055302 -#define SS_NOT_READY_TO_READY_TRANSITION 0x062800 -#define SS_RESET_OCCURRED 0x062900 -#define SS_SAVING_PARAMETERS_NOT_SUPPORTED 0x053900 -#define SS_UNRECOVERED_READ_ERROR 0x031100 -#define SS_WRITE_ERROR 0x030c02 -#define SS_WRITE_PROTECTED 0x072700 - -#define SK(x) ((uint8_t) ((x) >> 16)) /* Sense Key byte, etc. */ -#define ASC(x) ((uint8_t) ((x) >> 8)) -#define ASCQ(x) ((uint8_t) (x)) - -/* Routines for unaligned data access */ - -static uint16_t -get_be16(uint8_t *buf) -{ - return ((uint16_t)buf[0] << 8) | ((uint16_t)buf[1]); -} - -static uint32_t -get_be32(uint8_t *buf) -{ - return ((uint32_t)buf[0] << 24) | ((uint32_t)buf[1] << 16) | - ((uint32_t)buf[2] << 8) | ((uint32_t)buf[3]); -} - -static void -put_be16(uint8_t *buf, uint16_t val) -{ - buf[0] = val >> 8; - buf[1] = val; -} - -static void -put_be32(uint8_t *buf, uint32_t val) -{ - buf[0] = val >> 24; - buf[1] = val >> 16; - buf[2] = val >> 8; - buf[3] = val & 0xff; -} - -/*------------------------------------------------------------------------* - * ustorage_fs_verify - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_verify(struct ustorage_fs_softc *sc) -{ - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint32_t lba; - uint32_t vlen; - uint64_t file_offset; - uint64_t amount_left; - - /* - * Get the starting Logical Block Address - */ - lba = get_be32(&sc->sc_transfer.cmd_data[2]); - - /* - * We allow DPO (Disable Page Out = don't save data in the cache) - * but we don't implement it. - */ - if ((sc->sc_transfer.cmd_data[1] & ~0x10) != 0) { - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - return (1); - } - vlen = get_be16(&sc->sc_transfer.cmd_data[7]); - if (vlen == 0) { - goto done; - } - /* No default reply */ - - /* Prepare to carry out the file verify */ - amount_left = vlen; - amount_left <<= 9; - file_offset = lba; - file_offset <<= 9; - - /* Range check */ - vlen += lba; - - if ((vlen < lba) || - (vlen > currlun->num_sectors) || - (lba >= currlun->num_sectors)) { - currlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE; - return (1); - } - /* XXX TODO: verify that data is readable */ -done: - return (ustorage_fs_min_len(sc, 0, 0 - 1)); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_inquiry - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_inquiry(struct ustorage_fs_softc *sc) -{ - uint8_t *buf = sc->sc_transfer.data_ptr; - static const char vendor_id[] = "FreeBSD "; - static const char product_id[] = "File-Stor Gadget"; - - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - - if (!sc->sc_transfer.currlun) { - /* Unsupported LUNs are okay */ - memset(buf, 0, 36); - buf[0] = 0x7f; - /* Unsupported, no device - type */ - return (ustorage_fs_min_len(sc, 36, 0 - 1)); - } - memset(buf, 0, 8); - /* Non - removable, direct - access device */ - if (currlun->removable) - buf[1] = 0x80; - buf[2] = 2; - /* ANSI SCSI level 2 */ - buf[3] = 2; - /* SCSI - 2 INQUIRY data format */ - buf[4] = 31; - /* Additional length */ - /* No special options */ - /* - * NOTE: We are writing an extra zero here, that is not - * transferred to the peer: - */ - snprintf(buf + 8, 28 + 1, "%-8s%-16s%04x", vendor_id, product_id, - USTORAGE_FS_RELEASE); - return (ustorage_fs_min_len(sc, 36, 0 - 1)); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_request_sense - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_request_sense(struct ustorage_fs_softc *sc) -{ - uint8_t *buf = sc->sc_transfer.data_ptr; - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint32_t sd; - uint32_t sdinfo; - uint8_t valid; - - /* - * From the SCSI-2 spec., section 7.9 (Unit attention condition): - * - * If a REQUEST SENSE command is received from an initiator - * with a pending unit attention condition (before the target - * generates the contingent allegiance condition), then the - * target shall either: - * a) report any pending sense data and preserve the unit - * attention condition on the logical unit, or, - * b) report the unit attention condition, may discard any - * pending sense data, and clear the unit attention - * condition on the logical unit for that initiator. - * - * FSG normally uses option a); enable this code to use option b). - */ -#if 0 - if (currlun && currlun->unit_attention_data != SS_NO_SENSE) { - currlun->sense_data = currlun->unit_attention_data; - currlun->unit_attention_data = SS_NO_SENSE; - } -#endif - - if (!currlun) { - /* Unsupported LUNs are okay */ - sd = SS_LOGICAL_UNIT_NOT_SUPPORTED; - sdinfo = 0; - valid = 0; - } else { - sd = currlun->sense_data; - sdinfo = currlun->sense_data_info; - valid = currlun->info_valid << 7; - currlun->sense_data = SS_NO_SENSE; - currlun->sense_data_info = 0; - currlun->info_valid = 0; - } - - memset(buf, 0, 18); - buf[0] = valid | 0x70; - /* Valid, current error */ - buf[2] = SK(sd); - put_be32(&buf[3], sdinfo); - /* Sense information */ - buf[7] = 18 - 8; - /* Additional sense length */ - buf[12] = ASC(sd); - buf[13] = ASCQ(sd); - return (ustorage_fs_min_len(sc, 18, 0 - 1)); -} - - -/*------------------------------------------------------------------------* - * ustorage_fs_read_capacity - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_read_capacity(struct ustorage_fs_softc *sc) -{ - uint8_t *buf = sc->sc_transfer.data_ptr; - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint32_t lba = get_be32(&sc->sc_transfer.cmd_data[2]); - uint8_t pmi = sc->sc_transfer.cmd_data[8]; - - /* Check the PMI and LBA fields */ - if ((pmi > 1) || ((pmi == 0) && (lba != 0))) { - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - return (1); - } - put_be32(&buf[0], currlun->num_sectors - 1); - /* Max logical block */ - put_be32(&buf[4], 512); - /* Block length */ - return (ustorage_fs_min_len(sc, 8, 0 - 1)); -} - - -/*------------------------------------------------------------------------* - * ustorage_fs_mode_sense - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_mode_sense(struct ustorage_fs_softc *sc) -{ - uint8_t *buf = sc->sc_transfer.data_ptr; - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint8_t *buf0; - uint16_t len; - uint16_t limit; - uint8_t mscmnd = sc->sc_transfer.cmd_data[0]; - uint8_t pc; - uint8_t page_code; - uint8_t changeable_values; - uint8_t all_pages; - - buf0 = buf; - - if ((sc->sc_transfer.cmd_data[1] & ~0x08) != 0) { - /* Mask away DBD */ - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - return (1); - } - pc = sc->sc_transfer.cmd_data[2] >> 6; - page_code = sc->sc_transfer.cmd_data[2] & 0x3f; - if (pc == 3) { - currlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED; - return (1); - } - changeable_values = (pc == 1); - all_pages = (page_code == 0x3f); - - /* - * Write the mode parameter header. Fixed values are: default - * medium type, no cache control (DPOFUA), and no block descriptors. - * The only variable value is the WriteProtect bit. We will fill in - * the mode data length later. - */ - memset(buf, 0, 8); - if (mscmnd == SC_MODE_SENSE_6) { - buf[2] = (currlun->read_only ? 0x80 : 0x00); - /* WP, DPOFUA */ - buf += 4; - limit = 255; - } else { - /* SC_MODE_SENSE_10 */ - buf[3] = (currlun->read_only ? 0x80 : 0x00); - /* WP, DPOFUA */ - buf += 8; - limit = 65535; - /* Should really be mod_data.buflen */ - } - - /* No block descriptors */ - - /* - * The mode pages, in numerical order. - */ - if ((page_code == 0x08) || all_pages) { - buf[0] = 0x08; - /* Page code */ - buf[1] = 10; - /* Page length */ - memset(buf + 2, 0, 10); - /* None of the fields are changeable */ - - if (!changeable_values) { - buf[2] = 0x04; - /* Write cache enable, */ - /* Read cache not disabled */ - /* No cache retention priorities */ - put_be16(&buf[4], 0xffff); - /* Don 't disable prefetch */ - /* Minimum prefetch = 0 */ - put_be16(&buf[8], 0xffff); - /* Maximum prefetch */ - put_be16(&buf[10], 0xffff); - /* Maximum prefetch ceiling */ - } - buf += 12; - } - /* - * Check that a valid page was requested and the mode data length - * isn't too long. - */ - len = buf - buf0; - if (len > limit) { - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - return (1); - } - /* Store the mode data length */ - if (mscmnd == SC_MODE_SENSE_6) - buf0[0] = len - 1; - else - put_be16(buf0, len - 2); - return (ustorage_fs_min_len(sc, len, 0 - 1)); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_start_stop - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_start_stop(struct ustorage_fs_softc *sc) -{ - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint8_t loej; - uint8_t start; - uint8_t immed; - - if (!currlun->removable) { - currlun->sense_data = SS_INVALID_COMMAND; - return (1); - } - immed = sc->sc_transfer.cmd_data[1] & 0x01; - loej = sc->sc_transfer.cmd_data[4] & 0x02; - start = sc->sc_transfer.cmd_data[4] & 0x01; - - if (immed || loej || start) { - /* compile fix */ - } - return (0); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_prevent_allow - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_prevent_allow(struct ustorage_fs_softc *sc) -{ - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint8_t prevent; - - if (!currlun->removable) { - currlun->sense_data = SS_INVALID_COMMAND; - return (1); - } - prevent = sc->sc_transfer.cmd_data[4] & 0x01; - if ((sc->sc_transfer.cmd_data[4] & ~0x01) != 0) { - /* Mask away Prevent */ - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - return (1); - } - if (currlun->prevent_medium_removal && !prevent) { - //fsync_sub(currlun); - } - currlun->prevent_medium_removal = prevent; - return (0); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_read_format_capacities - * - * Returns: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_read_format_capacities(struct ustorage_fs_softc *sc) -{ - uint8_t *buf = sc->sc_transfer.data_ptr; - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - - buf[0] = buf[1] = buf[2] = 0; - buf[3] = 8; - /* Only the Current / Maximum Capacity Descriptor */ - buf += 4; - - put_be32(&buf[0], currlun->num_sectors); - /* Number of blocks */ - put_be32(&buf[4], 512); - /* Block length */ - buf[4] = 0x02; - /* Current capacity */ - return (ustorage_fs_min_len(sc, 12, 0 - 1)); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_mode_select - * - * Return values: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_mode_select(struct ustorage_fs_softc *sc) -{ - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - - /* We don't support MODE SELECT */ - currlun->sense_data = SS_INVALID_COMMAND; - return (1); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_synchronize_cache - * - * Return values: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_synchronize_cache(struct ustorage_fs_softc *sc) -{ -#if 0 - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint8_t rc; - - /* - * We ignore the requested LBA and write out all dirty data buffers. - */ - rc = 0; - if (rc) { - currlun->sense_data = SS_WRITE_ERROR; - } -#endif - return (0); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_read - read data from disk - * - * Return values: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_read(struct ustorage_fs_softc *sc) -{ - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint64_t file_offset; - uint32_t lba; - uint32_t len; - - /* - * Get the starting Logical Block Address and check that it's not - * too big - */ - if (sc->sc_transfer.cmd_data[0] == SC_READ_6) { - lba = (sc->sc_transfer.cmd_data[1] << 16) | - get_be16(&sc->sc_transfer.cmd_data[2]); - } else { - lba = get_be32(&sc->sc_transfer.cmd_data[2]); - - /* - * We allow DPO (Disable Page Out = don't save data in the - * cache) and FUA (Force Unit Access = don't read from the - * cache), but we don't implement them. - */ - if ((sc->sc_transfer.cmd_data[1] & ~0x18) != 0) { - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - return (1); - } - } - len = sc->sc_transfer.data_rem >> 9; - len += lba; - - if ((len < lba) || - (len > currlun->num_sectors) || - (lba >= currlun->num_sectors)) { - currlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE; - return (1); - } - file_offset = lba; - file_offset <<= 9; - - sc->sc_transfer.data_ptr = - USB_ADD_BYTES(currlun->memory_image, (uint32_t)file_offset); - - return (0); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_write - write data to disk - * - * Return values: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_write(struct ustorage_fs_softc *sc) -{ - struct ustorage_fs_lun *currlun = sc->sc_transfer.currlun; - uint64_t file_offset; - uint32_t lba; - uint32_t len; - - if (currlun->read_only) { - currlun->sense_data = SS_WRITE_PROTECTED; - return (1); - } - /* XXX clear SYNC */ - - /* - * Get the starting Logical Block Address and check that it's not - * too big. - */ - if (sc->sc_transfer.cmd_data[0] == SC_WRITE_6) - lba = (sc->sc_transfer.cmd_data[1] << 16) | - get_be16(&sc->sc_transfer.cmd_data[2]); - else { - lba = get_be32(&sc->sc_transfer.cmd_data[2]); - - /* - * We allow DPO (Disable Page Out = don't save data in the - * cache) and FUA (Force Unit Access = write directly to the - * medium). We don't implement DPO; we implement FUA by - * performing synchronous output. - */ - if ((sc->sc_transfer.cmd_data[1] & ~0x18) != 0) { - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - return (1); - } - if (sc->sc_transfer.cmd_data[1] & 0x08) { - /* FUA */ - /* XXX set SYNC flag here */ - } - } - - len = sc->sc_transfer.data_rem >> 9; - len += lba; - - if ((len < lba) || - (len > currlun->num_sectors) || - (lba >= currlun->num_sectors)) { - currlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE; - return (1); - } - file_offset = lba; - file_offset <<= 9; - - sc->sc_transfer.data_ptr = - USB_ADD_BYTES(currlun->memory_image, (uint32_t)file_offset); - - return (0); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_min_len - * - * Return values: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_min_len(struct ustorage_fs_softc *sc, uint32_t len, uint32_t mask) -{ - if (len != sc->sc_transfer.data_rem) { - - if (sc->sc_transfer.cbw_dir == DIR_READ) { - /* - * there must be something wrong about this SCSI - * command - */ - sc->sc_csw.bCSWStatus = CSWSTATUS_PHASE; - return (1); - } - /* compute the minimum length */ - - if (sc->sc_transfer.data_rem > len) { - /* data ends prematurely */ - sc->sc_transfer.data_rem = len; - sc->sc_transfer.data_short = 1; - } - /* check length alignment */ - - if (sc->sc_transfer.data_rem & ~mask) { - /* data ends prematurely */ - sc->sc_transfer.data_rem &= mask; - sc->sc_transfer.data_short = 1; - } - } - return (0); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_check_cmd - check command routine - * - * Check whether the command is properly formed and whether its data - * size and direction agree with the values we already have. - * - * Return values: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_check_cmd(struct ustorage_fs_softc *sc, uint8_t min_cmd_size, - uint16_t mask, uint8_t needs_medium) -{ - struct ustorage_fs_lun *currlun; - uint8_t lun = (sc->sc_transfer.cmd_data[1] >> 5); - uint8_t i; - - /* Verify the length of the command itself */ - if (min_cmd_size > sc->sc_transfer.cmd_len) { - DPRINTF("%u > %u\n", - min_cmd_size, sc->sc_transfer.cmd_len); - sc->sc_csw.bCSWStatus = CSWSTATUS_PHASE; - return (1); - } - /* Mask away the LUN */ - sc->sc_transfer.cmd_data[1] &= 0x1f; - - /* Check if LUN is correct */ - if (lun != sc->sc_transfer.lun) { - - } - /* Check the LUN */ - if (sc->sc_transfer.lun <= sc->sc_last_lun) { - sc->sc_transfer.currlun = currlun = - sc->sc_lun + sc->sc_transfer.lun; - if (sc->sc_transfer.cmd_data[0] != SC_REQUEST_SENSE) { - currlun->sense_data = SS_NO_SENSE; - currlun->sense_data_info = 0; - currlun->info_valid = 0; - } - /* - * If a unit attention condition exists, only INQUIRY - * and REQUEST SENSE commands are allowed. Anything - * else must fail! - */ - if ((currlun->unit_attention_data != SS_NO_SENSE) && - (sc->sc_transfer.cmd_data[0] != SC_INQUIRY) && - (sc->sc_transfer.cmd_data[0] != SC_REQUEST_SENSE)) { - currlun->sense_data = currlun->unit_attention_data; - currlun->unit_attention_data = SS_NO_SENSE; - return (1); - } - } else { - sc->sc_transfer.currlun = currlun = NULL; - - /* - * INQUIRY and REQUEST SENSE commands are explicitly allowed - * to use unsupported LUNs; all others may not. - */ - if ((sc->sc_transfer.cmd_data[0] != SC_INQUIRY) && - (sc->sc_transfer.cmd_data[0] != SC_REQUEST_SENSE)) { - return (1); - } - } - - /* - * Check that only command bytes listed in the mask are - * non-zero. - */ - for (i = 0; i != min_cmd_size; i++) { - if (sc->sc_transfer.cmd_data[i] && !(mask & (1 << i))) { - if (currlun) { - currlun->sense_data = SS_INVALID_FIELD_IN_CDB; - } - return (1); - } - } - - /* - * If the medium isn't mounted and the command needs to access - * it, return an error. - */ - if (currlun && (!currlun->memory_image) && needs_medium) { - currlun->sense_data = SS_MEDIUM_NOT_PRESENT; - return (1); - } - return (0); -} - -/*------------------------------------------------------------------------* - * ustorage_fs_do_cmd - do command - * - * Return values: - * 0: Success - * Else: Failure - *------------------------------------------------------------------------*/ -static uint8_t -ustorage_fs_do_cmd(struct ustorage_fs_softc *sc) -{ - uint8_t error = 1; - uint8_t i; - - /* set default data transfer pointer */ - sc->sc_transfer.data_ptr = sc->sc_qdata; - - DPRINTF("cmd_data[0]=0x%02x, data_rem=0x%08x\n", - sc->sc_transfer.cmd_data[0], sc->sc_transfer.data_rem); - - switch (sc->sc_transfer.cmd_data[0]) { - case SC_INQUIRY: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, sc->sc_transfer.cmd_data[4], 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (1 << 4) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_inquiry(sc); - - break; - - case SC_MODE_SELECT_6: - sc->sc_transfer.cmd_dir = DIR_READ; - error = ustorage_fs_min_len(sc, sc->sc_transfer.cmd_data[4], 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (1 << 1) | (1 << 4) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_mode_select(sc); - - break; - - case SC_MODE_SELECT_10: - sc->sc_transfer.cmd_dir = DIR_READ; - error = ustorage_fs_min_len(sc, - get_be16(&sc->sc_transfer.cmd_data[7]), 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 10, - (1 << 1) | (3 << 7) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_mode_select(sc); - - break; - - case SC_MODE_SENSE_6: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, sc->sc_transfer.cmd_data[4], 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (1 << 1) | (1 << 2) | (1 << 4) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_mode_sense(sc); - - break; - - case SC_MODE_SENSE_10: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, - get_be16(&sc->sc_transfer.cmd_data[7]), 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 10, - (1 << 1) | (1 << 2) | (3 << 7) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_mode_sense(sc); - - break; - - case SC_PREVENT_ALLOW_MEDIUM_REMOVAL: - error = ustorage_fs_min_len(sc, 0, 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (1 << 4) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_prevent_allow(sc); - - break; - - case SC_READ_6: - i = sc->sc_transfer.cmd_data[4]; - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, - ((i == 0) ? 256 : i) << 9, 0 - (1 << 9)); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (7 << 1) | (1 << 4) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_read(sc); - - break; - - case SC_READ_10: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, - get_be16(&sc->sc_transfer.cmd_data[7]) << 9, 0 - (1 << 9)); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 10, - (1 << 1) | (0xf << 2) | (3 << 7) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_read(sc); - - break; - - case SC_READ_12: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, - get_be32(&sc->sc_transfer.cmd_data[6]) << 9, 0 - (1 << 9)); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 12, - (1 << 1) | (0xf << 2) | (0xf << 6) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_read(sc); - - break; - - case SC_READ_CAPACITY: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_check_cmd(sc, 10, - (0xf << 2) | (1 << 8) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_read_capacity(sc); - - break; - - case SC_READ_FORMAT_CAPACITIES: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, - get_be16(&sc->sc_transfer.cmd_data[7]), 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 10, - (3 << 7) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_read_format_capacities(sc); - - break; - - case SC_REQUEST_SENSE: - sc->sc_transfer.cmd_dir = DIR_WRITE; - error = ustorage_fs_min_len(sc, sc->sc_transfer.cmd_data[4], 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (1 << 4) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_request_sense(sc); - - break; - - case SC_START_STOP_UNIT: - error = ustorage_fs_min_len(sc, 0, 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (1 << 1) | (1 << 4) | 1, 0); - if (error) { - break; - } - error = ustorage_fs_start_stop(sc); - - break; - - case SC_SYNCHRONIZE_CACHE: - error = ustorage_fs_min_len(sc, 0, 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 10, - (0xf << 2) | (3 << 7) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_synchronize_cache(sc); - - break; - - case SC_TEST_UNIT_READY: - error = ustorage_fs_min_len(sc, 0, 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - 0 | 1, 1); - break; - - /* - * Although optional, this command is used by MS-Windows. - * We support a minimal version: BytChk must be 0. - */ - case SC_VERIFY: - error = ustorage_fs_min_len(sc, 0, 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 10, - (1 << 1) | (0xf << 2) | (3 << 7) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_verify(sc); - - break; - - case SC_WRITE_6: - i = sc->sc_transfer.cmd_data[4]; - sc->sc_transfer.cmd_dir = DIR_READ; - error = ustorage_fs_min_len(sc, - ((i == 0) ? 256 : i) << 9, 0 - (1 << 9)); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 6, - (7 << 1) | (1 << 4) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_write(sc); - - break; - - case SC_WRITE_10: - sc->sc_transfer.cmd_dir = DIR_READ; - error = ustorage_fs_min_len(sc, - get_be16(&sc->sc_transfer.cmd_data[7]) << 9, 0 - (1 << 9)); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 10, - (1 << 1) | (0xf << 2) | (3 << 7) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_write(sc); - - break; - - case SC_WRITE_12: - sc->sc_transfer.cmd_dir = DIR_READ; - error = ustorage_fs_min_len(sc, - get_be32(&sc->sc_transfer.cmd_data[6]) << 9, 0 - (1 << 9)); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, 12, - (1 << 1) | (0xf << 2) | (0xf << 6) | 1, 1); - if (error) { - break; - } - error = ustorage_fs_write(sc); - - break; - - /* - * Some mandatory commands that we recognize but don't - * implement. They don't mean much in this setting. - * It's left as an exercise for anyone interested to - * implement RESERVE and RELEASE in terms of Posix - * locks. - */ - case SC_FORMAT_UNIT: - case SC_RELEASE: - case SC_RESERVE: - case SC_SEND_DIAGNOSTIC: - /* Fallthrough */ - - default: - error = ustorage_fs_min_len(sc, 0, 0 - 1); - if (error) { - break; - } - error = ustorage_fs_check_cmd(sc, sc->sc_transfer.cmd_len, - 0xff, 0); - if (error) { - break; - } - sc->sc_transfer.currlun->sense_data = - SS_INVALID_COMMAND; - error = 1; - - break; - } - return (error); -} |
