/* $NetBSD: umass.c,v 1.62 2001/06/04 06:01:40 augustss Exp $ */ /*- * Copyright (c) 1999 MAEKAWA Masahide , * Nick Hibma * 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: src/sys/dev/usb/umass.c,v 1.13 2000/03/26 01:39:12 n_hibma Exp $ */ /* * Universal Serial Bus Mass Storage Class specs: * http://www.usb.org/developers/data/devclass/usbmassover_11.pdf * http://www.usb.org/developers/data/devclass/usbmassbulk_10.pdf * http://www.usb.org/developers/data/devclass/usbmass-cbi10.pdf * http://www.usb.org/developers/data/devclass/usbmass-ufi10.pdf */ /* * Ported to NetBSD by Lennart Augustsson . * Parts of the code written my Jason R. Thorpe . */ /* * 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 * - 8070 (ATA/ATAPI for rewritable removable media) * - UFI (USB Floppy Interface) * * 8070i is a transformed version of the SCSI command set. UFI is a transformed * version of the 8070i command set. The sc->transform method is used to * convert the commands into the appropriate format (if at all necessary). * For example, ATAPI 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 * * The protocols are implemented using a state machine, for the transfers as * well as for the resets. The state machine is contained in umass_*_state. * The state machine is started through either umass_*_transfer 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 "atapibus.h" #include #include #include #include #if defined(__NetBSD__) || defined(__OpenBSD__) #include #include #include #include #undef KASSERT #define KASSERT(cond, msg) #elif defined(__FreeBSD__) #include #include #include #endif #include #include #include #include #include #include #ifdef UMASS_DEBUG int umassdebug = 0; char *states[TSTATE_STATES+1] = { /* should be kept in sync with the list at transfer_state */ "Idle", "BBB CBW", "BBB Data", "BBB Data bulk-in/-out clear stall", "BBB CSW, 1st attempt", "BBB CSW bulk-in clear stall", "BBB CSW, 2nd attempt", "BBB Reset", "BBB bulk-in clear stall", "BBB bulk-out clear stall", "CBI Command", "CBI Data", "CBI Status", "CBI Data bulk-in/-out clear stall", "CBI Status intr-in clear stall", "CBI Reset", "CBI bulk-in clear stall", "CBI bulk-out clear stall", NULL }; #endif /* USB device probe/attach/detach functions */ USB_DECLARE_DRIVER(umass); Static void umass_disco(struct umass_softc *sc); Static int umass_match_proto(struct umass_softc *sc, usbd_interface_handle iface, usbd_device_handle dev); Static void umass_init_shuttle(struct umass_softc *sc); /* generic transfer functions */ Static usbd_status umass_setup_transfer(struct umass_softc *sc, usbd_pipe_handle pipe, void *buffer, int buflen, int flags, usbd_xfer_handle xfer); Static usbd_status umass_setup_ctrl_transfer(struct umass_softc *sc, usbd_device_handle dev, usb_device_request_t *req, void *buffer, int buflen, int flags, usbd_xfer_handle xfer); Static void umass_clear_endpoint_stall(struct umass_softc *sc, u_int8_t endpt, usbd_pipe_handle pipe, int state, usbd_xfer_handle xfer); #if 0 Static void umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv); #endif /* Bulk-Only related functions */ Static void umass_bbb_reset(struct umass_softc *sc, int status); Static void umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, void *data, int datalen, int dir, transfer_cb_f cb, void *priv); Static void umass_bbb_state(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status err); usbd_status umass_bbb_get_max_lun(struct umass_softc *sc, u_int8_t *maxlun); /* CBI related functions */ Static int umass_cbi_adsc(struct umass_softc *sc, char *buffer,int buflen, usbd_xfer_handle xfer); Static void umass_cbi_reset(struct umass_softc *sc, int status); Static void umass_cbi_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, void *data, int datalen, int dir, transfer_cb_f cb, void *priv); Static void umass_cbi_state(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status err); #ifdef UMASS_DEBUG /* General debugging functions */ Static void umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw); Static void umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw); Static void umass_dump_buffer(struct umass_softc *sc, u_int8_t *buffer, int buflen, int printlen); #endif void usbd_clear_endpoint_toggle(usbd_pipe_handle pipe); /* XXXXX */ /* * USB device probe/attach/detach */ /* * Match the device we are seeing with the devices supported. Fill in the * proto and drive fields in the softc accordingly. * This function is called from both probe and attach. */ Static int umass_match_proto(struct umass_softc *sc, usbd_interface_handle iface, usbd_device_handle dev) { usb_device_descriptor_t *dd; usb_interface_descriptor_t *id; u_int vendor, product; /* * Fill in sc->drive and sc->proto and return a match * value if both are determined and 0 otherwise. */ sc->drive = DRIVE_GENERIC; sc->transfer_speed = UMASS_DEFAULT_TRANSFER_SPEED; sc->sc_udev = dev; dd = usbd_get_device_descriptor(dev); vendor = UGETW(dd->idVendor); product = UGETW(dd->idProduct); if (vendor == USB_VENDOR_SHUTTLE && (product == USB_PRODUCT_SHUTTLE_EUSB || product == USB_PRODUCT_SHUTTLE_ZIOMMC) ) { if (product == USB_PRODUCT_SHUTTLE_EUSB) sc->drive = SHUTTLE_EUSB; #if CBI_I sc->wire_proto = WPROTO_CBI_I; sc->cmd_proto = CPROTO_ATAPI; #else sc->wire_proto = WPROTO_CBI; sc->cmd_proto = CPROTO_ATAPI; #endif sc->subclass = UISUBCLASS_SFF8020I; sc->protocol = UIPROTO_MASS_CBI; sc->quirks |= NO_TEST_UNIT_READY | NO_START_STOP; return (UMATCH_VENDOR_PRODUCT); } if (vendor == USB_VENDOR_MICROTECH && product == USB_PRODUCT_MICROTECH_DPCM) { sc->wire_proto = WPROTO_CBI; sc->cmd_proto = CPROTO_ATAPI; sc->subclass = UISUBCLASS_SFF8070I; sc->protocol = UIPROTO_MASS_CBI; sc->transfer_speed = UMASS_ZIP100_TRANSFER_SPEED * 2; return (UMATCH_VENDOR_PRODUCT); } if (vendor == USB_VENDOR_YANO && product == USB_PRODUCT_YANO_U640MO) { #if CBI_I sc->wire_proto = WPROTO_CBI_I; sc->cmd_proto = CPROTO_ATAPI; #else sc->wire_proto = WPROTO_CBI; sc->cmd_proto = CPROTO_ATAPI; #endif sc->quirks |= FORCE_SHORT_INQUIRY; return (UMATCH_VENDOR_PRODUCT); } if (vendor == USB_VENDOR_SONY && product == USB_PRODUCT_SONY_MSC) { sc->quirks |= FORCE_SHORT_INQUIRY; } if (vendor == USB_VENDOR_YEDATA && product == USB_PRODUCT_YEDATA_FLASHBUSTERU) { /* Revisions < 1.28 do not handle the interrupt endpoint * very well. */ if (UGETW(dd->bcdDevice) < 0x128) { sc->wire_proto = WPROTO_CBI; sc->cmd_proto = CPROTO_UFI; } else #if CBI_I sc->wire_proto = WPROTO_CBI_I; sc->cmd_proto = CPROTO_UFI; #else sc->wire_proto = WPROTO_CBI; sc->cmd_proto = CPROTO_UFI; #endif /* * Revisions < 1.28 do not have the TEST UNIT READY command * Revisions == 1.28 have a broken TEST UNIT READY */ if (UGETW(dd->bcdDevice) <= 0x128) sc->quirks |= NO_TEST_UNIT_READY; sc->subclass = UISUBCLASS_UFI; sc->protocol = UIPROTO_MASS_CBI; sc->quirks |= RS_NO_CLEAR_UA; sc->transfer_speed = UMASS_FLOPPY_TRANSFER_SPEED; return (UMATCH_VENDOR_PRODUCT_REV); } if (vendor == USB_VENDOR_INSYSTEM && product == USB_PRODUCT_INSYSTEM_USBCABLE) { sc->drive = INSYSTEM_USBCABLE; sc->wire_proto = WPROTO_CBI; sc->cmd_proto = CPROTO_ATAPI; sc->quirks |= NO_TEST_UNIT_READY | NO_START_STOP; return (UMATCH_VENDOR_PRODUCT); } id = usbd_get_interface_descriptor(iface); if (id == NULL || id->bInterfaceClass != UICLASS_MASS) return (UMATCH_NONE); if (vendor == USB_VENDOR_SONY && id->bInterfaceSubClass == 0xff) { /* * Sony DSC devices set the sub class to 0xff * instead of 1 (RBC). Fix that here. */ id->bInterfaceSubClass = UISUBCLASS_RBC; /* They also should be able to do higher speed. */ sc->transfer_speed = 500; } if (vendor == USB_VENDOR_FUJIPHOTO && product == USB_PRODUCT_FUJIPHOTO_MASS0100) sc->quirks |= NO_TEST_UNIT_READY | NO_START_STOP; sc->subclass = id->bInterfaceSubClass; sc->protocol = id->bInterfaceProtocol; switch (sc->subclass) { case UISUBCLASS_SCSI: sc->cmd_proto = CPROTO_SCSI; break; case UISUBCLASS_UFI: sc->transfer_speed = UMASS_FLOPPY_TRANSFER_SPEED; sc->cmd_proto = CPROTO_UFI; break; case UISUBCLASS_SFF8020I: case UISUBCLASS_SFF8070I: case UISUBCLASS_QIC157: sc->cmd_proto = CPROTO_ATAPI; break; case UISUBCLASS_RBC: sc->cmd_proto = CPROTO_RBC; break; default: DPRINTF(UDMASS_GEN, ("%s: Unsupported command protocol %d\n", USBDEVNAME(sc->sc_dev), id->bInterfaceSubClass)); return (UMATCH_NONE); } switch (sc->protocol) { case UIPROTO_MASS_CBI: sc->wire_proto = WPROTO_CBI; break; case UIPROTO_MASS_CBI_I: #if CBI_I sc->wire_proto = WPROTO_CBI_I; #else sc->wire_proto = WPROTO_CBI; #endif break; case UIPROTO_MASS_BBB: sc->wire_proto = WPROTO_BBB; break; case UIPROTO_MASS_BBB_P: sc->drive = ZIP_100; sc->wire_proto = WPROTO_BBB; sc->transfer_speed = UMASS_ZIP100_TRANSFER_SPEED; sc->quirks |= NO_TEST_UNIT_READY; break; default: DPRINTF(UDMASS_GEN, ("%s: Unsupported wire protocol %d\n", USBDEVNAME(sc->sc_dev), id->bInterfaceProtocol)); return (UMATCH_NONE); } return (UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO); } USB_MATCH(umass) { USB_MATCH_START(umass, uaa); #if defined(__FreeBSD__) struct umass_softc *sc = device_get_softc(self); #elif defined(__NetBSD__) || defined(__OpenBSD__) struct umass_softc scs, *sc = &scs; memset(sc, 0, sizeof *sc); strcpy(sc->sc_dev.dv_xname, "umass"); #endif if (uaa->iface == NULL) return(UMATCH_NONE); return (umass_match_proto(sc, uaa->iface, uaa->device)); } USB_ATTACH(umass) { USB_ATTACH_START(umass, sc, uaa); usb_interface_descriptor_t *id; usb_endpoint_descriptor_t *ed; const char *sSubclass, *sProto; char devinfo[1024]; int i, bno; int err; /* * the softc struct is bzero-ed in device_set_driver. We can safely * call umass_detach without specifically initialising the struct. */ usbd_devinfo(uaa->device, 0, devinfo); USB_ATTACH_SETUP; sc->iface = uaa->iface; sc->ifaceno = uaa->ifaceno; /* initialise the proto and drive values in the umass_softc (again) */ if (umass_match_proto(sc, sc->iface, uaa->device) == 0) { printf("%s: match failed\n", USBDEVNAME(sc->sc_dev)); USB_ATTACH_ERROR_RETURN; } if (sc->drive == INSYSTEM_USBCABLE) { err = usbd_set_interface(sc->iface, 1); if (err) { DPRINTF(UDMASS_USB, ("%s: could not switch to " "Alt Interface %d\n", USBDEVNAME(sc->sc_dev), 1)); umass_disco(sc); USB_ATTACH_ERROR_RETURN; } } /* * The timeout is based on the maximum expected transfer size * divided by the expected transfer speed. * We multiply by 4 to make sure a busy system doesn't make things * fail. */ sc->timeout = 4 * UMASS_MAX_TRANSFER_SIZE / sc->transfer_speed; sc->timeout += UMASS_SPINUP_TIME; /* allow for spinning up */ id = usbd_get_interface_descriptor(sc->iface); printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo); switch (sc->subclass) { case UISUBCLASS_RBC: sSubclass = "RBC"; break; case UISUBCLASS_SCSI: sSubclass = "SCSI"; break; case UISUBCLASS_UFI: sSubclass = "UFI"; break; case UISUBCLASS_SFF8020I: sSubclass = "SFF8020i"; break; case UISUBCLASS_SFF8070I: sSubclass = "SFF8070i"; break; case UISUBCLASS_QIC157: sSubclass = "QIC157"; break; default: sSubclass = "unknown"; break; } switch (sc->protocol) { case UIPROTO_MASS_CBI: sProto = "CBI"; break; case UIPROTO_MASS_CBI_I: sProto = "CBI-I"; break; case UIPROTO_MASS_BBB: sProto = "BBB"; break; case UIPROTO_MASS_BBB_P: sProto = "BBB-P"; break; default: sProto = "unknown"; break; } printf("%s: using %s over %s\n", USBDEVNAME(sc->sc_dev), sSubclass, sProto); /* * In addition to the Control endpoint the following endpoints * are required: * a) bulk-in endpoint. * b) bulk-out endpoint. * and for Control/Bulk/Interrupt with CCI (CBI_I) * c) intr-in * * The endpoint addresses are not fixed, so we have to read them * from the device descriptors of the current interface. */ for (i = 0 ; i < id->bNumEndpoints ; i++) { ed = usbd_interface2endpoint_descriptor(sc->iface, i); if (!ed) { printf("%s: could not read endpoint descriptor\n", USBDEVNAME(sc->sc_dev)); USB_ATTACH_ERROR_RETURN; } if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { sc->bulkin = ed->bEndpointAddress; } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { sc->bulkout = ed->bEndpointAddress; } else if (sc->wire_proto == WPROTO_CBI_I && UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) { sc->intrin = ed->bEndpointAddress; #ifdef UMASS_DEBUG if (UGETW(ed->wMaxPacketSize) > 2) { DPRINTF(UDMASS_CBI, ("%s: intr size is %d\n", USBDEVNAME(sc->sc_dev), UGETW(ed->wMaxPacketSize))); } #endif } } /* check whether we found all the endpoints we need */ if (!sc->bulkin || !sc->bulkout || (sc->wire_proto == WPROTO_CBI_I && !sc->intrin) ) { DPRINTF(UDMASS_USB, ("%s: endpoint not found %d/%d/%d\n", USBDEVNAME(sc->sc_dev), sc->bulkin, sc->bulkout, sc->intrin)); umass_disco(sc); USB_ATTACH_ERROR_RETURN; } /* * Get the maximum LUN supported by the device. */ if (sc->wire_proto == WPROTO_BBB) { err = umass_bbb_get_max_lun(sc, &sc->maxlun); if (err) { printf("%s: unable to get Max Lun: %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); USB_ATTACH_ERROR_RETURN; } } else { sc->maxlun = 0; } /* Open the bulk-in and -out pipe */ err = usbd_open_pipe(sc->iface, sc->bulkout, USBD_EXCLUSIVE_USE, &sc->bulkout_pipe); if (err) { DPRINTF(UDMASS_USB, ("%s: cannot open %d-out pipe (bulk)\n", USBDEVNAME(sc->sc_dev), sc->bulkout)); umass_disco(sc); USB_ATTACH_ERROR_RETURN; } err = usbd_open_pipe(sc->iface, sc->bulkin, USBD_EXCLUSIVE_USE, &sc->bulkin_pipe); if (err) { DPRINTF(UDMASS_USB, ("%s: could not open %d-in pipe (bulk)\n", USBDEVNAME(sc->sc_dev), sc->bulkin)); umass_disco(sc); USB_ATTACH_ERROR_RETURN; } /* * Open the intr-in pipe if the protocol is CBI with CCI. * Note: early versions of the Zip drive do have an interrupt pipe, but * this pipe is unused * * We do not open the interrupt pipe as an interrupt pipe, but as a * normal bulk endpoint. We send an IN transfer down the wire at the * appropriate time, because we know exactly when to expect data on * that endpoint. This saves bandwidth, but more important, makes the * code for handling the data on that endpoint simpler. No data * arriving concurrently. */ if (sc->wire_proto == WPROTO_CBI_I) { err = usbd_open_pipe(sc->iface, sc->intrin, USBD_EXCLUSIVE_USE, &sc->intrin_pipe); if (err) { DPRINTF(UDMASS_USB, ("%s: couldn't open %d-in (intr)\n", USBDEVNAME(sc->sc_dev), sc->intrin)); umass_disco(sc); USB_ATTACH_ERROR_RETURN; } } /* initialisation of generic part */ sc->transfer_state = TSTATE_IDLE; /* request a sufficient number of xfer handles */ for (i = 0; i < XFER_NR; i++) { sc->transfer_xfer[i] = usbd_alloc_xfer(uaa->device); if (sc->transfer_xfer[i] == 0) { DPRINTF(UDMASS_USB, ("%s: Out of memory\n", USBDEVNAME(sc->sc_dev))); umass_disco(sc); USB_ATTACH_ERROR_RETURN; } } /* Allocate buffer for data transfer (it's huge). */ switch (sc->wire_proto) { case WPROTO_BBB: bno = XFER_BBB_DATA; goto dalloc; case WPROTO_CBI: bno = XFER_CBI_DATA; goto dalloc; case WPROTO_CBI_I: bno = XFER_CBI_DATA; dalloc: sc->data_buffer = usbd_alloc_buffer(sc->transfer_xfer[bno], UMASS_MAX_TRANSFER_SIZE); if (sc->data_buffer == NULL) { umass_disco(sc); USB_ATTACH_ERROR_RETURN; } break; default: break; } /* Initialise the wire protocol specific methods */ if (sc->wire_proto == WPROTO_BBB) { sc->reset = umass_bbb_reset; sc->transfer = umass_bbb_transfer; sc->state = umass_bbb_state; } else if (sc->wire_proto == WPROTO_CBI || sc->wire_proto == WPROTO_CBI_I) { sc->reset = umass_cbi_reset; sc->transfer = umass_cbi_transfer; sc->state = umass_cbi_state; #ifdef UMASS_DEBUG } else { panic("%s:%d: Unknown wire proto 0x%02x\n", __FILE__, __LINE__, sc->wire_proto); #endif } if (sc->drive == SHUTTLE_EUSB) umass_init_shuttle(sc); if (umass_attach_bus(sc)) { umass_disco(sc); USB_ATTACH_ERROR_RETURN; } DPRINTF(UDMASS_GEN, ("%s: Attach finished\n", USBDEVNAME(sc->sc_dev))); USB_ATTACH_SUCCESS_RETURN; } USB_DETACH(umass) { USB_DETACH_START(umass, sc); int rv = 0; DPRINTF(UDMASS_USB, ("%s: detached\n", USBDEVNAME(sc->sc_dev))); /* Abort the pipes to wake up any waiting processes. */ if (sc->bulkout_pipe != NULL) usbd_abort_pipe(sc->bulkout_pipe); if (sc->bulkin_pipe != NULL) usbd_abort_pipe(sc->bulkin_pipe); if (sc->intrin_pipe != NULL) usbd_abort_pipe(sc->intrin_pipe); #if 0 /* Do we really need reference counting? Perhaps in ioctl() */ s = splusb(); if (--sc->sc_refcnt >= 0) { /* Wait for processes to go away. */ usb_detach_wait(USBDEV(sc->sc_dev)); } splx(s); #endif rv = umass_detach_bus(sc, flags); if (rv != 0) return (rv); umass_disco(sc); usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, USBDEV(sc->sc_dev)); return (0); } Static void umass_disco(struct umass_softc *sc) { int i; DPRINTF(UDMASS_GEN, ("umass_disco\n")); /* Free the xfers. */ for (i = 0; i < XFER_NR; i++) if (sc->transfer_xfer[i] != NULL) { usbd_free_xfer(sc->transfer_xfer[i]); sc->transfer_xfer[i] = NULL; } /* Remove all the pipes. */ if (sc->bulkout_pipe != NULL) usbd_close_pipe(sc->bulkout_pipe); if (sc->bulkin_pipe != NULL) usbd_close_pipe(sc->bulkin_pipe); if (sc->intrin_pipe != NULL) usbd_close_pipe(sc->intrin_pipe); } Static void umass_init_shuttle(struct umass_softc *sc) { usb_device_request_t req; u_char status[2]; /* The Linux driver does this */ req.bmRequestType = UT_READ_VENDOR_DEVICE; req.bRequest = 1; USETW(req.wValue, 0); USETW(req.wIndex, sc->ifaceno); USETW(req.wLength, sizeof status); (void)usbd_do_request(sc->sc_udev, &req, &status); } /* * Generic functions to handle transfers */ Static usbd_status umass_setup_transfer(struct umass_softc *sc, usbd_pipe_handle pipe, void *buffer, int buflen, int flags, usbd_xfer_handle xfer) { usbd_status err; if (sc->sc_dying) return (USBD_IOERROR); /* Initialiase a USB transfer and then schedule it */ usbd_setup_xfer(xfer, pipe, (void *)sc, buffer, buflen, flags | sc->sc_xfer_flags, sc->timeout, sc->state); err = usbd_transfer(xfer); DPRINTF(UDMASS_XFER,("%s: start xfer buffer=%p buflen=%d flags=0x%x " "timeout=%d\n", USBDEVNAME(sc->sc_dev), buffer, buflen, flags | sc->sc_xfer_flags, sc->timeout)); if (err && err != USBD_IN_PROGRESS) { DPRINTF(UDMASS_BBB, ("%s: failed to setup transfer, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err))); return (err); } return (USBD_NORMAL_COMPLETION); } Static usbd_status umass_setup_ctrl_transfer(struct umass_softc *sc, usbd_device_handle dev, usb_device_request_t *req, void *buffer, int buflen, int flags, usbd_xfer_handle xfer) { usbd_status err; if (sc->sc_dying) return (USBD_IOERROR); /* Initialiase a USB control transfer and then schedule it */ usbd_setup_default_xfer(xfer, dev, (void *) sc, sc->timeout, req, buffer, buflen, flags, sc->state); err = usbd_transfer(xfer); if (err && err != USBD_IN_PROGRESS) { DPRINTF(UDMASS_BBB, ("%s: failed to setup ctrl transfer, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err))); /* do not reset, as this would make us loop */ return (err); } return (USBD_NORMAL_COMPLETION); } Static void umass_clear_endpoint_stall(struct umass_softc *sc, u_int8_t endpt, usbd_pipe_handle pipe, int state, usbd_xfer_handle xfer) { usbd_device_handle dev; if (sc->sc_dying) return; DPRINTF(UDMASS_BBB, ("%s: Clear endpoint 0x%02x stall\n", USBDEVNAME(sc->sc_dev), endpt)); usbd_interface2device_handle(sc->iface, &dev); sc->transfer_state = state; usbd_clear_endpoint_toggle(pipe); sc->request.bmRequestType = UT_WRITE_ENDPOINT; sc->request.bRequest = UR_CLEAR_FEATURE; USETW(sc->request.wValue, UF_ENDPOINT_HALT); USETW(sc->request.wIndex, endpt); USETW(sc->request.wLength, 0); umass_setup_ctrl_transfer(sc, dev, &sc->request, NULL, 0, 0, xfer); } #if 0 Static void umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv) { sc->transfer_cb = cb; sc->transfer_priv = priv; /* The reset is a forced reset, so no error (yet) */ sc->reset(sc, STATUS_CMD_OK); } #endif /* * Bulk protocol specific functions */ Static void umass_bbb_reset(struct umass_softc *sc, int status) { usbd_device_handle dev; KASSERT(sc->proto & PROTO_BBB, ("sc->proto == 0x%02x wrong for umass_bbb_reset\n", sc->proto)); if (sc->sc_dying) return; /* * 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, states: * TSTATE_BBB_RESET1 * TSTATE_BBB_RESET2 * TSTATE_BBB_RESET3 * * If the reset doesn't succeed, the device should be port reset. */ DPRINTF(UDMASS_BBB, ("%s: Bulk Reset\n", USBDEVNAME(sc->sc_dev))); sc->transfer_state = TSTATE_BBB_RESET1; sc->transfer_status = status; usbd_interface2device_handle(sc->iface, &dev); /* reset is a class specific interface write */ sc->request.bmRequestType = UT_WRITE_CLASS_INTERFACE; sc->request.bRequest = UR_BBB_RESET; USETW(sc->request.wValue, 0); USETW(sc->request.wIndex, sc->ifaceno); USETW(sc->request.wLength, 0); umass_setup_ctrl_transfer(sc, dev, &sc->request, NULL, 0, 0, sc->transfer_xfer[XFER_BBB_RESET1]); } Static void umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, void *data, int datalen, int dir, transfer_cb_f cb, void *priv) { static int dCBWtag = 42; /* unique for CBW of transfer */ DPRINTF(UDMASS_BBB,("%s: umass_bbb_transfer cmd=0x%02x\n", USBDEVNAME(sc->sc_dev), *(u_char*)cmd)); KASSERT(sc->proto & PROTO_BBB, ("sc->proto == 0x%02x wrong for umass_bbb_transfer\n", sc->proto)); /* * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly * a data phase of datalen bytes from/to the device and finally a * csw read phase. * If the data direction was inbound a maximum of datalen bytes * is stored in the buffer pointed to by data. * * umass_bbb_transfer initialises the transfer and lets the state * machine in umass_bbb_state handle the completion. It uses the * following states: * TSTATE_BBB_COMMAND * -> TSTATE_BBB_DATA * -> TSTATE_BBB_STATUS * -> TSTATE_BBB_STATUS2 * -> TSTATE_BBB_IDLE * * An error in any of those states will invoke * umass_bbb_reset. */ /* check the given arguments */ KASSERT(datalen == 0 || data != NULL, ("%s: datalen > 0, but no buffer",USBDEVNAME(sc->sc_dev))); KASSERT(cmdlen <= CBWCDBLENGTH, ("%s: cmdlen exceeds CDB length in CBW (%d > %d)", USBDEVNAME(sc->sc_dev), cmdlen, CBWCDBLENGTH)); KASSERT(dir == DIR_NONE || datalen > 0, ("%s: datalen == 0 while direction is not NONE\n", USBDEVNAME(sc->sc_dev))); KASSERT(datalen == 0 || dir != DIR_NONE, ("%s: direction is NONE while datalen is not zero\n", USBDEVNAME(sc->sc_dev))); KASSERT(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE, ("%s: CBW struct does not have the right size (%d vs. %d)\n", USBDEVNAME(sc->sc_dev), sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE)); KASSERT(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE, ("%s: CSW struct does not have the right size (%d vs. %d)\n", USBDEVNAME(sc->sc_dev), sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE)); /* * Determine the direction of the data transfer and the length. * * dCBWDataTransferLength (datalen) : * 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. * * dCBWFlags (dir) : * 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 */ /* Fill in the Command Block Wrapper */ USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE); USETDW(sc->cbw.dCBWTag, dCBWtag); dCBWtag++; /* cannot be done in macro (it will be done 4 times) */ USETDW(sc->cbw.dCBWDataTransferLength, datalen); /* DIR_NONE is treated as DIR_OUT (0x00) */ sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT); sc->cbw.bCBWLUN = lun; sc->cbw.bCDBLength = cmdlen; bcopy(cmd, sc->cbw.CBWCDB, cmdlen); DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw)); /* store the details for the data transfer phase */ sc->transfer_dir = dir; sc->transfer_data = data; sc->transfer_datalen = datalen; sc->transfer_actlen = 0; sc->transfer_cb = cb; sc->transfer_priv = priv; sc->transfer_status = STATUS_CMD_OK; /* move from idle to the command state */ sc->transfer_state = TSTATE_BBB_COMMAND; /* Send the CBW from host to device via bulk-out endpoint. */ if (umass_setup_transfer(sc, sc->bulkout_pipe, &sc->cbw, UMASS_BBB_CBW_SIZE, 0, sc->transfer_xfer[XFER_BBB_CBW])) { umass_bbb_reset(sc, STATUS_WIRE_FAILED); } } Static void umass_bbb_state(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status err) { struct umass_softc *sc = (struct umass_softc *) priv; usbd_xfer_handle next_xfer; KASSERT(sc->proto & PROTO_BBB, ("sc->proto == 0x%02x wrong for umass_bbb_state\n",sc->proto)); if (sc->sc_dying) return; /* * State handling for BBB transfers. * * The subroutine is rather long. It steps through the states given in * Annex A of the Bulk-Only specification. * Each state first does the error handling of the previous transfer * and then prepares the next transfer. * Each transfer is done asynchroneously so after the request/transfer * has been submitted you will find a 'return;'. */ DPRINTF(UDMASS_BBB, ("%s: Handling BBB state %d (%s), xfer=%p, %s\n", USBDEVNAME(sc->sc_dev), sc->transfer_state, states[sc->transfer_state], xfer, usbd_errstr(err))); switch (sc->transfer_state) { /***** Bulk Transfer *****/ case TSTATE_BBB_COMMAND: /* Command transport phase, error handling */ if (err) { DPRINTF(UDMASS_BBB, ("%s: failed to send CBW\n", USBDEVNAME(sc->sc_dev))); /* If the device detects that the CBW is invalid, then * the device may STALL both bulk endpoints and require * a Bulk-Reset */ umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } /* Data transport phase, setup transfer */ sc->transfer_state = TSTATE_BBB_DATA; if (sc->transfer_dir == DIR_IN) { if (umass_setup_transfer(sc, sc->bulkin_pipe, sc->data_buffer, sc->transfer_datalen, USBD_SHORT_XFER_OK | USBD_NO_COPY, sc->transfer_xfer[XFER_BBB_DATA])) umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } else if (sc->transfer_dir == DIR_OUT) { memcpy(sc->data_buffer, sc->transfer_data, sc->transfer_datalen); if (umass_setup_transfer(sc, sc->bulkout_pipe, sc->data_buffer, sc->transfer_datalen, USBD_NO_COPY,/* fixed length transfer */ sc->transfer_xfer[XFER_BBB_DATA])) umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } else { DPRINTF(UDMASS_BBB, ("%s: no data phase\n", USBDEVNAME(sc->sc_dev))); } /* FALLTHROUGH if no data phase, err == 0 */ case TSTATE_BBB_DATA: /* Command transport phase, error handling (ignored if no data * phase (fallthrough from previous state)) */ if (sc->transfer_dir != DIR_NONE) { /* retrieve the length of the transfer that was done */ usbd_get_xfer_status(xfer, NULL, NULL, &sc->transfer_actlen, NULL); if (err) { DPRINTF(UDMASS_BBB, ("%s: Data-%s %db failed, " "%s\n", USBDEVNAME(sc->sc_dev), (sc->transfer_dir == DIR_IN?"in":"out"), sc->transfer_datalen,usbd_errstr(err))); if (err == USBD_STALLED) { umass_clear_endpoint_stall(sc, (sc->transfer_dir == DIR_IN? sc->bulkin:sc->bulkout), (sc->transfer_dir == DIR_IN? sc->bulkin_pipe:sc->bulkout_pipe), TSTATE_BBB_DCLEAR, sc->transfer_xfer[XFER_BBB_DCLEAR]); return; } else { /* Unless the error is a pipe stall the * error is fatal. */ umass_bbb_reset(sc,STATUS_WIRE_FAILED); return; } } } if (sc->transfer_dir == DIR_IN) memcpy(sc->transfer_data, sc->data_buffer, sc->transfer_actlen); DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN) umass_dump_buffer(sc, sc->transfer_data, sc->transfer_datalen, 48)); /* FALLTHROUGH, err == 0 (no data phase or successfull) */ case TSTATE_BBB_DCLEAR: /* stall clear after data phase */ case TSTATE_BBB_SCLEAR: /* stall clear after status phase */ /* Reading of CSW after bulk stall condition in data phase * (TSTATE_BBB_DATA2) or bulk-in stall condition after * reading CSW (TSTATE_BBB_SCLEAR). * In the case of no data phase or successfull data phase, * err == 0 and the following if block is passed. */ if (err) { /* should not occur */ /* try the transfer below, even if clear stall failed */ DPRINTF(UDMASS_BBB, ("%s: bulk-%s stall clear failed" ", %s\n", USBDEVNAME(sc->sc_dev), (sc->transfer_dir == DIR_IN? "in":"out"), usbd_errstr(err))); umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } /* Status transport phase, setup transfer */ if (sc->transfer_state == TSTATE_BBB_COMMAND || sc->transfer_state == TSTATE_BBB_DATA || sc->transfer_state == TSTATE_BBB_DCLEAR) { /* After no data phase, successfull data phase and * after clearing bulk-in/-out stall condition */ sc->transfer_state = TSTATE_BBB_STATUS1; next_xfer = sc->transfer_xfer[XFER_BBB_CSW1]; } else { /* After first attempt of fetching CSW */ sc->transfer_state = TSTATE_BBB_STATUS2; next_xfer = sc->transfer_xfer[XFER_BBB_CSW2]; } /* Read the Command Status Wrapper via bulk-in endpoint. */ if (umass_setup_transfer(sc, sc->bulkin_pipe, &sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) { umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } return; case TSTATE_BBB_STATUS1: /* first attempt */ case TSTATE_BBB_STATUS2: /* second attempt */ /* Status transfer, error handling */ if (err) { DPRINTF(UDMASS_BBB, ("%s: Failed to read CSW, %s%s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err), (sc->transfer_state == TSTATE_BBB_STATUS1? ", retrying":""))); /* If this was the first attempt at fetching the CSW * retry it, otherwise fail. */ if (sc->transfer_state == TSTATE_BBB_STATUS1) { umass_clear_endpoint_stall(sc, sc->bulkin, sc->bulkin_pipe, TSTATE_BBB_SCLEAR, sc->transfer_xfer[XFER_BBB_SCLEAR]); return; } else { umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } } DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw)); /* Check CSW and handle any error */ if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) { /* Invalid CSW: Wrong signature or wrong tag might * indicate that the device is confused -> reset it. */ printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n", USBDEVNAME(sc->sc_dev), UGETDW(sc->csw.dCSWSignature), CSWSIGNATURE); umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } else if (UGETDW(sc->csw.dCSWTag) != UGETDW(sc->cbw.dCBWTag)) { printf("%s: Invalid CSW: tag %d should be %d\n", USBDEVNAME(sc->sc_dev), UGETDW(sc->csw.dCSWTag), UGETDW(sc->cbw.dCBWTag)); umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; /* CSW is valid here */ } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) { printf("%s: Invalid CSW: status %d > %d\n", USBDEVNAME(sc->sc_dev), sc->csw.bCSWStatus, CSWSTATUS_PHASE); umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) { printf("%s: Phase Error, residue = %d\n", USBDEVNAME(sc->sc_dev), UGETDW(sc->csw.dCSWDataResidue)); umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; } else if (sc->transfer_actlen > sc->transfer_datalen) { /* Buffer overrun! Don't let this go by unnoticed */ panic("%s: transferred %d bytes instead of %d bytes\n", USBDEVNAME(sc->sc_dev), sc->transfer_actlen, sc->transfer_datalen); #if 0 } else if (sc->transfer_datalen - sc->transfer_actlen != UGETDW(sc->csw.dCSWDataResidue)) { DPRINTF(UDMASS_BBB, ("%s: actlen=%d != residue=%d\n", USBDEVNAME(sc->sc_dev), sc->transfer_datalen - sc->transfer_actlen, UGETDW(sc->csw.dCSWDataResidue))); umass_bbb_reset(sc, STATUS_WIRE_FAILED); return; #endif } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) { DPRINTF(UDMASS_BBB, ("%s: Command Failed, res = %d\n", USBDEVNAME(sc->sc_dev), UGETDW(sc->csw.dCSWDataResidue))); /* SCSI command failed but transfer was succesful */ sc->transfer_state = TSTATE_IDLE; sc->transfer_cb(sc, sc->transfer_priv, UGETDW(sc->csw.dCSWDataResidue), STATUS_CMD_FAILED); return; } else { /* success */ sc->transfer_state = TSTATE_IDLE; sc->transfer_cb(sc, sc->transfer_priv, UGETDW(sc->csw.dCSWDataResidue), STATUS_CMD_OK); return; } /***** Bulk Reset *****/ case TSTATE_BBB_RESET1: if (err) printf("%s: BBB reset failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); umass_clear_endpoint_stall(sc, sc->bulkin, sc->bulkin_pipe, TSTATE_BBB_RESET2, sc->transfer_xfer[XFER_BBB_RESET2]); return; case TSTATE_BBB_RESET2: if (err) /* should not occur */ printf("%s: BBB bulk-in clear stall failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); /* no error recovery, otherwise we end up in a loop */ umass_clear_endpoint_stall(sc, sc->bulkout, sc->bulkout_pipe, TSTATE_BBB_RESET3, sc->transfer_xfer[XFER_BBB_RESET3]); return; case TSTATE_BBB_RESET3: if (err) /* should not occur */ printf("%s: BBB bulk-out clear stall failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); /* no error recovery, otherwise we end up in a loop */ sc->transfer_state = TSTATE_IDLE; if (sc->transfer_priv) { sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen, sc->transfer_status); } return; /***** Default *****/ default: panic("%s: Unknown state %d\n", USBDEVNAME(sc->sc_dev), sc->transfer_state); } } /* * Command/Bulk/Interrupt (CBI) specific functions */ Static int umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, usbd_xfer_handle xfer) { usbd_device_handle dev; KASSERT(sc->proto & (PROTO_CBI|PROTO_CBI_I), ("sc->proto == 0x%02x wrong for umass_cbi_adsc\n",sc->proto)); usbd_interface2device_handle(sc->iface, &dev); sc->request.bmRequestType = UT_WRITE_CLASS_INTERFACE; sc->request.bRequest = UR_CBI_ADSC; USETW(sc->request.wValue, 0); USETW(sc->request.wIndex, sc->ifaceno); USETW(sc->request.wLength, buflen); return umass_setup_ctrl_transfer(sc, dev, &sc->request, buffer, buflen, 0, xfer); } Static void umass_cbi_reset(struct umass_softc *sc, int status) { int i; # define SEND_DIAGNOSTIC_CMDLEN 12 KASSERT(sc->proto & (PROTO_CBI|PROTO_CBI_I), ("sc->proto == 0x%02x wrong for umass_cbi_reset\n",sc->proto)); if (sc->sc_dying) return; /* * 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, states: * TSTATE_CBI_RESET1 * TSTATE_CBI_RESET2 * TSTATE_CBI_RESET3 * * If the reset doesn't succeed, the device should be port reset. */ DPRINTF(UDMASS_CBI, ("%s: CBI Reset\n", USBDEVNAME(sc->sc_dev))); KASSERT(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN, ("%s: CBL struct is too small (%d < %d)\n", USBDEVNAME(sc->sc_dev), sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN)); sc->transfer_state = TSTATE_CBI_RESET1; sc->transfer_status = status; /* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between * the two the last 10 bytes of the cbl is filled with 0xff (section * 2.2 of the CBI spec). */ sc->cbl[0] = 0x1d; /* Command Block Reset */ sc->cbl[1] = 0x04; for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++) sc->cbl[i] = 0xff; umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, sc->transfer_xfer[XFER_CBI_RESET1]); /* XXX if the command fails we should reset the port on the bub */ } Static void umass_cbi_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, void *data, int datalen, int dir, transfer_cb_f cb, void *priv) { DPRINTF(UDMASS_CBI,("%s: umass_cbi_transfer cmd=0x%02x, len=%d\n", USBDEVNAME(sc->sc_dev), *(u_char*)cmd, datalen)); KASSERT(sc->proto & (PROTO_CBI|PROTO_CBI_I), ("sc->proto == 0x%02x wrong for umass_cbi_transfer\n", sc->proto)); if (sc->sc_dying) return; /* * Do a CBI transfer with cmdlen bytes from cmd, possibly * a data phase of datalen bytes from/to the device and finally a * csw read phase. * If the data direction was inbound a maximum of datalen bytes * is stored in the buffer pointed to by data. * * umass_cbi_transfer initialises the transfer and lets the state * machine in umass_cbi_state handle the completion. It uses the * following states: * TSTATE_CBI_COMMAND * -> XXX fill in * * An error in any of those states will invoke * umass_cbi_reset. */ /* check the given arguments */ KASSERT(datalen == 0 || data != NULL, ("%s: datalen > 0, but no buffer",USBDEVNAME(sc->sc_dev))); KASSERT(datalen == 0 || dir != DIR_NONE, ("%s: direction is NONE while datalen is not zero\n", USBDEVNAME(sc->sc_dev))); /* store the details for the data transfer phase */ sc->transfer_dir = dir; sc->transfer_data = data; sc->transfer_datalen = datalen; sc->transfer_actlen = 0; sc->transfer_cb = cb; sc->transfer_priv = priv; sc->transfer_status = STATUS_CMD_OK; /* move from idle to the command state */ sc->transfer_state = TSTATE_CBI_COMMAND; /* Send the Command Block from host to device via control endpoint. */ if (umass_cbi_adsc(sc, cmd, cmdlen, sc->transfer_xfer[XFER_CBI_CB])) umass_cbi_reset(sc, STATUS_WIRE_FAILED); } Static void umass_cbi_state(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status err) { struct umass_softc *sc = (struct umass_softc *) priv; KASSERT(sc->proto & (PROTO_CBI|PROTO_CBI_I), ("sc->proto == 0x%02x wrong for umass_cbi_state\n", sc->proto)); if (sc->sc_dying) return; /* * State handling for CBI transfers. */ DPRINTF(UDMASS_CBI, ("%s: Handling CBI state %d (%s), xfer=%p, %s\n", USBDEVNAME(sc->sc_dev), sc->transfer_state, states[sc->transfer_state], xfer, usbd_errstr(err))); switch (sc->transfer_state) { /***** CBI Transfer *****/ case TSTATE_CBI_COMMAND: if (err == USBD_STALLED) { DPRINTF(UDMASS_CBI, ("%s: Command Transport failed\n", USBDEVNAME(sc->sc_dev))); /* Status transport by control pipe (section 2.3.2.1). * The command contained in the command block failed. * * The control pipe has already been unstalled by the * USB stack. * Section 2.4.3.1.1 states that the bulk in endpoints * should not stalled at this point. */ sc->transfer_state = TSTATE_IDLE; sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen, STATUS_CMD_FAILED); return; } else if (err) { DPRINTF(UDMASS_CBI, ("%s: failed to send ADSC\n", USBDEVNAME(sc->sc_dev))); umass_cbi_reset(sc, STATUS_WIRE_FAILED); return; } sc->transfer_state = TSTATE_CBI_DATA; if (sc->transfer_dir == DIR_IN) { if (umass_setup_transfer(sc, sc->bulkin_pipe, sc->transfer_data, sc->transfer_datalen, USBD_SHORT_XFER_OK | USBD_NO_COPY, sc->transfer_xfer[XFER_CBI_DATA])) umass_cbi_reset(sc, STATUS_WIRE_FAILED); } else if (sc->transfer_dir == DIR_OUT) { memcpy(sc->data_buffer, sc->transfer_data, sc->transfer_datalen); if (umass_setup_transfer(sc, sc->bulkout_pipe, sc->transfer_data, sc->transfer_datalen, USBD_NO_COPY,/* fixed length transfer */ sc->transfer_xfer[XFER_CBI_DATA])) umass_cbi_reset(sc, STATUS_WIRE_FAILED); } else if (sc->wire_proto == WPROTO_CBI_I) { DPRINTF(UDMASS_CBI, ("%s: no data phase\n", USBDEVNAME(sc->sc_dev))); sc->transfer_state = TSTATE_CBI_STATUS; if (umass_setup_transfer(sc, sc->intrin_pipe, &sc->sbl, sizeof(sc->sbl), 0, /* fixed length transfer */ sc->transfer_xfer[XFER_CBI_STATUS])){ umass_cbi_reset(sc, STATUS_WIRE_FAILED); } } else { DPRINTF(UDMASS_CBI, ("%s: no data phase\n", USBDEVNAME(sc->sc_dev))); /* No command completion interrupt. Request * sense data. */ sc->transfer_state = TSTATE_IDLE; sc->transfer_cb(sc, sc->transfer_priv, 0, STATUS_CMD_UNKNOWN); } return; case TSTATE_CBI_DATA: /* retrieve the length of the transfer that was done */ usbd_get_xfer_status(xfer,NULL,NULL,&sc->transfer_actlen,NULL); DPRINTF(UDMASS_CBI, ("%s: CBI_DATA actlen=%d\n", USBDEVNAME(sc->sc_dev), sc->transfer_actlen)); if (err) { DPRINTF(UDMASS_CBI, ("%s: Data-%s %db failed, " "%s\n", USBDEVNAME(sc->sc_dev), (sc->transfer_dir == DIR_IN?"in":"out"), sc->transfer_datalen,usbd_errstr(err))); if (err == USBD_STALLED) { umass_clear_endpoint_stall(sc, sc->bulkin, sc->bulkin_pipe, TSTATE_CBI_DCLEAR, sc->transfer_xfer[XFER_CBI_DCLEAR]); } else { umass_cbi_reset(sc, STATUS_WIRE_FAILED); } return; } if (sc->transfer_dir == DIR_IN) memcpy(sc->transfer_data, sc->data_buffer, sc->transfer_actlen); DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN) umass_dump_buffer(sc, sc->transfer_data, sc->transfer_actlen, 48)); if (sc->wire_proto == WPROTO_CBI_I) { sc->transfer_state = TSTATE_CBI_STATUS; memset(&sc->sbl, 0, sizeof(sc->sbl)); if (umass_setup_transfer(sc, sc->intrin_pipe, &sc->sbl, sizeof(sc->sbl), 0, /* fixed length transfer */ sc->transfer_xfer[XFER_CBI_STATUS])){ umass_cbi_reset(sc, STATUS_WIRE_FAILED); } } else { /* No command completion interrupt. Request * sense to get status of command. */ sc->transfer_state = TSTATE_IDLE; sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen - sc->transfer_actlen, STATUS_CMD_UNKNOWN); } return; case TSTATE_CBI_STATUS: if (err) { DPRINTF(UDMASS_CBI, ("%s: Status Transport failed\n", USBDEVNAME(sc->sc_dev))); /* Status transport by interrupt pipe (section 2.3.2.2). */ if (err == USBD_STALLED) { umass_clear_endpoint_stall(sc, sc->intrin, sc->intrin_pipe, TSTATE_CBI_SCLEAR, sc->transfer_xfer[XFER_CBI_SCLEAR]); } else { umass_cbi_reset(sc, STATUS_WIRE_FAILED); } return; } /* Dissect the information in the buffer */ if (sc->cmd_proto == CPROTO_UFI) { int status; /* Section 3.4.3.1.3 specifies that the UFI command * protocol returns an ASC and ASCQ in the interrupt * data block. */ DPRINTF(UDMASS_CBI, ("%s: UFI CCI, ASC = 0x%02x, " "ASCQ = 0x%02x\n", USBDEVNAME(sc->sc_dev), sc->sbl.ufi.asc, sc->sbl.ufi.ascq)); if (sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) status = STATUS_CMD_OK; else status = STATUS_CMD_FAILED; /* No sense, command successfull */ } else { /* Command Interrupt Data Block */ DPRINTF(UDMASS_CBI, ("%s: type=0x%02x, value=0x%02x\n", USBDEVNAME(sc->sc_dev), sc->sbl.common.type, sc->sbl.common.value)); if (sc->sbl.common.type == IDB_TYPE_CCI) { int err; if ((sc->sbl.common.value&IDB_VALUE_STATUS_MASK) == IDB_VALUE_PASS) { err = STATUS_CMD_OK; } else if ((sc->sbl.common.value & IDB_VALUE_STATUS_MASK) == IDB_VALUE_FAIL || (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) == IDB_VALUE_PERSISTENT) { err = STATUS_CMD_FAILED; } else { err = STATUS_WIRE_FAILED; } sc->transfer_state = TSTATE_IDLE; sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen, err); } } return; case TSTATE_CBI_DCLEAR: if (err) { /* should not occur */ printf("%s: CBI bulk-in/out stall clear failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); umass_cbi_reset(sc, STATUS_WIRE_FAILED); } sc->transfer_state = TSTATE_IDLE; sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen, STATUS_CMD_FAILED); return; case TSTATE_CBI_SCLEAR: if (err) /* should not occur */ printf("%s: CBI intr-in stall clear failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); /* Something really bad is going on. Reset the device */ umass_cbi_reset(sc, STATUS_CMD_FAILED); return; /***** CBI Reset *****/ case TSTATE_CBI_RESET1: if (err) printf("%s: CBI reset failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); umass_clear_endpoint_stall(sc, sc->bulkin, sc->bulkin_pipe, TSTATE_CBI_RESET2, sc->transfer_xfer[XFER_CBI_RESET2]); return; case TSTATE_CBI_RESET2: if (err) /* should not occur */ printf("%s: CBI bulk-in stall clear failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); /* no error recovery, otherwise we end up in a loop */ umass_clear_endpoint_stall(sc, sc->bulkout, sc->bulkout_pipe, TSTATE_CBI_RESET3, sc->transfer_xfer[XFER_CBI_RESET3]); return; case TSTATE_CBI_RESET3: if (err) /* should not occur */ printf("%s: CBI bulk-out stall clear failed, %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); /* no error recovery, otherwise we end up in a loop */ sc->transfer_state = TSTATE_IDLE; if (sc->transfer_priv) { sc->transfer_cb(sc, sc->transfer_priv, sc->transfer_datalen, sc->transfer_status); } return; /***** Default *****/ default: panic("%s: Unknown state %d\n", USBDEVNAME(sc->sc_dev), sc->transfer_state); } } usbd_status umass_bbb_get_max_lun(struct umass_softc *sc, u_int8_t *maxlun) { usbd_device_handle dev; usb_device_request_t req; usbd_status err; usb_interface_descriptor_t *id; *maxlun = 0; /* Default to 0. */ DPRINTF(UDMASS_BBB, ("%s: Get Max Lun\n", USBDEVNAME(sc->sc_dev))); usbd_interface2device_handle(sc->iface, &dev); id = usbd_get_interface_descriptor(sc->iface); /* 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); USETW(req.wIndex, id->bInterfaceNumber); USETW(req.wLength, 1); err = usbd_do_request(dev, &req, maxlun); switch (err) { case USBD_NORMAL_COMPLETION: DPRINTF(UDMASS_BBB, ("%s: Max Lun %d\n", USBDEVNAME(sc->sc_dev), *maxlun)); break; case USBD_STALLED: /* * Device doesn't support Get Max Lun request. */ err = USBD_NORMAL_COMPLETION; DPRINTF(UDMASS_BBB, ("%s: Get Max Lun not supported\n", USBDEVNAME(sc->sc_dev))); break; case USBD_SHORT_XFER: /* * XXX This must mean Get Max Lun is not supported, too! */ err = USBD_NORMAL_COMPLETION; DPRINTF(UDMASS_BBB, ("%s: Get Max Lun SHORT_XFER\n", USBDEVNAME(sc->sc_dev))); break; default: printf("%s: Get Max Lun failed: %s\n", USBDEVNAME(sc->sc_dev), usbd_errstr(err)); /* XXX Should we port_reset the device? */ break; } return (err); } #ifdef UMASS_DEBUG Static void umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw) { int clen = cbw->bCDBLength; int dlen = UGETDW(cbw->dCBWDataTransferLength); u_int8_t *c = cbw->CBWCDB; int tag = UGETDW(cbw->dCBWTag); int flags = cbw->bCBWFlags; DPRINTF(UDMASS_BBB, ("%s: CBW %d: cmd = %db " "(0x%02x%02x%02x%02x%02x%02x%s), " "data = %d bytes, dir = %s\n", USBDEVNAME(sc->sc_dev), tag, clen, c[0], c[1], c[2], c[3], c[4], c[5], (clen > 6? "...":""), dlen, (flags == CBWFLAGS_IN? "in": (flags == CBWFLAGS_OUT? "out":"")))); } Static void umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw) { int sig = UGETDW(csw->dCSWSignature); int tag = UGETW(csw->dCSWTag); int res = UGETDW(csw->dCSWDataResidue); int status = csw->bCSWStatus; DPRINTF(UDMASS_BBB, ("%s: CSW %d: sig = 0x%08x (%s), tag = %d, " "res = %d, status = 0x%02x (%s)\n", USBDEVNAME(sc->sc_dev), tag, sig, (sig == CSWSIGNATURE? "valid":"invalid"), tag, res, status, (status == CSWSTATUS_GOOD? "good": (status == CSWSTATUS_FAILED? "failed": (status == CSWSTATUS_PHASE? "phase":""))))); } Static void umass_dump_buffer(struct umass_softc *sc, u_int8_t *buffer, int buflen, int printlen) { int 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(UDMASS_GEN, ("%s: 0x %s%s\n", USBDEVNAME(sc->sc_dev), s1, s2)); s2[0] = '\0'; } sprintf(&s1[j*2], "%02x", buffer[i] & 0xff); } if (buflen > printlen) sprintf(s3, " ..."); DPRINTF(UDMASS_GEN, ("%s: 0x %s%s%s\n", USBDEVNAME(sc->sc_dev), s1, s2, s3)); } #endif