umass.c revision 1.157.4.1
1 /* $NetBSD: umass.c,v 1.157.4.1 2017/06/24 00:23:39 jdolecek Exp $ */ 2 3 /* 4 * Copyright (c) 2003 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Charles M. Hannum. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /*- 33 * Copyright (c) 1999 MAEKAWA Masahide <bishop (at) rr.iij4u.or.jp>, 34 * Nick Hibma <n_hibma (at) freebsd.org> 35 * All rights reserved. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 40 * 1. Redistributions of source code must retain the above copyright 41 * notice, this list of conditions and the following disclaimer. 42 * 2. Redistributions in binary form must reproduce the above copyright 43 * notice, this list of conditions and the following disclaimer in the 44 * documentation and/or other materials provided with the distribution. 45 * 46 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 49 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 56 * SUCH DAMAGE. 57 * 58 * $FreeBSD: src/sys/dev/usb/umass.c,v 1.13 2000/03/26 01:39:12 n_hibma Exp $ 59 */ 60 61 /* 62 * Universal Serial Bus Mass Storage Class specs: 63 * http://www.usb.org/developers/docs/devclass_docs/Mass_Storage_Specification_Overview_v1.4_2-19-2010.pdf 64 * http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf 65 * http://www.usb.org/developers/docs/devclass_docs/usb_msc_cbi_1.1.pdf 66 * http://www.usb.org/developers/docs/devclass_docs/usbmass-ufi10.pdf 67 */ 68 69 /* 70 * Ported to NetBSD by Lennart Augustsson <augustss (at) NetBSD.org>. 71 * Parts of the code written by Jason R. Thorpe <thorpej (at) shagadelic.org>. 72 */ 73 74 /* 75 * The driver handles 3 Wire Protocols 76 * - Command/Bulk/Interrupt (CBI) 77 * - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI) 78 * - Mass Storage Bulk-Only (BBB) 79 * (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases) 80 * 81 * Over these wire protocols it handles the following command protocols 82 * - SCSI 83 * - 8070 (ATA/ATAPI for rewritable removable media) 84 * - UFI (USB Floppy Interface) 85 * 86 * 8070i is a transformed version of the SCSI command set. UFI is a transformed 87 * version of the 8070i command set. The sc->transform method is used to 88 * convert the commands into the appropriate format (if at all necessary). 89 * For example, ATAPI requires all commands to be 12 bytes in length amongst 90 * other things. 91 * 92 * The source code below is marked and can be split into a number of pieces 93 * (in this order): 94 * 95 * - probe/attach/detach 96 * - generic transfer routines 97 * - BBB 98 * - CBI 99 * - CBI_I (in addition to functions from CBI) 100 * - CAM (Common Access Method) 101 * - SCSI 102 * - UFI 103 * - 8070i 104 * 105 * The protocols are implemented using a state machine, for the transfers as 106 * well as for the resets. The state machine is contained in umass_*_state. 107 * The state machine is started through either umass_*_transfer or 108 * umass_*_reset. 109 * 110 * The reason for doing this is a) CAM performs a lot better this way and b) it 111 * avoids using tsleep from interrupt context (for example after a failed 112 * transfer). 113 */ 114 115 /* 116 * The SCSI related part of this driver has been derived from the 117 * dev/ppbus/vpo.c driver, by Nicolas Souchu (nsouch (at) freebsd.org). 118 * 119 * The CAM layer uses so called actions which are messages sent to the host 120 * adapter for completion. The actions come in through umass_cam_action. The 121 * appropriate block of routines is called depending on the transport protocol 122 * in use. When the transfer has finished, these routines call 123 * umass_cam_cb again to complete the CAM command. 124 */ 125 126 #include <sys/cdefs.h> 127 __KERNEL_RCSID(0, "$NetBSD: umass.c,v 1.157.4.1 2017/06/24 00:23:39 jdolecek Exp $"); 128 129 #ifdef _KERNEL_OPT 130 #include "opt_usb.h" 131 #endif 132 133 #include "atapibus.h" 134 #include "scsibus.h" 135 #include "wd.h" 136 137 #include <sys/param.h> 138 #include <sys/systm.h> 139 #include <sys/kernel.h> 140 #include <sys/conf.h> 141 #include <sys/buf.h> 142 #include <sys/device.h> 143 #include <sys/malloc.h> 144 #include <sys/sysctl.h> 145 146 #include <dev/usb/usb.h> 147 #include <dev/usb/usbdi.h> 148 #include <dev/usb/usbdi_util.h> 149 #include <dev/usb/usbdevs.h> 150 #include <dev/usb/usbhist.h> 151 152 #include <dev/usb/umassvar.h> 153 #include <dev/usb/umass_quirks.h> 154 #include <dev/usb/umass_scsipi.h> 155 #include <dev/usb/umass_isdata.h> 156 157 #include <dev/scsipi/scsipi_all.h> 158 #include <dev/scsipi/scsipiconf.h> 159 160 #ifdef USB_DEBUG 161 #ifdef UMASS_DEBUG 162 int umassdebug = 0; 163 164 SYSCTL_SETUP(sysctl_hw_umass_setup, "sysctl hw.umass setup") 165 { 166 int err; 167 const struct sysctlnode *rnode; 168 const struct sysctlnode *cnode; 169 170 err = sysctl_createv(clog, 0, NULL, &rnode, 171 CTLFLAG_PERMANENT, CTLTYPE_NODE, "umass", 172 SYSCTL_DESCR("umass global controls"), 173 NULL, 0, NULL, 0, CTL_HW, CTL_CREATE, CTL_EOL); 174 175 if (err) 176 goto fail; 177 178 /* control debugging printfs */ 179 err = sysctl_createv(clog, 0, &rnode, &cnode, 180 CTLFLAG_PERMANENT|CTLFLAG_READWRITE, CTLTYPE_INT, 181 "debug", SYSCTL_DESCR("Enable debugging output"), 182 NULL, 0, &umassdebug, sizeof(umassdebug), CTL_CREATE, CTL_EOL); 183 if (err) 184 goto fail; 185 186 return; 187 fail: 188 aprint_error("%s: sysctl_createv failed (err = %d)\n", __func__, err); 189 } 190 191 const char *states[TSTATE_STATES+1] = { 192 /* should be kept in sync with the list at transfer_state */ 193 "Idle", 194 "BBB CBW", 195 "BBB Data", 196 "BBB Data bulk-in/-out clear stall", 197 "BBB CSW, 1st attempt", 198 "BBB CSW bulk-in clear stall", 199 "BBB CSW, 2nd attempt", 200 "BBB Reset", 201 "BBB bulk-in clear stall", 202 "BBB bulk-out clear stall", 203 "CBI Command", 204 "CBI Data", 205 "CBI Status", 206 "CBI Data bulk-in/-out clear stall", 207 "CBI Status intr-in clear stall", 208 "CBI Reset", 209 "CBI bulk-in clear stall", 210 "CBI bulk-out clear stall", 211 NULL 212 }; 213 #endif 214 #endif 215 216 /* USB device probe/attach/detach functions */ 217 int umass_match(device_t, cfdata_t, void *); 218 void umass_attach(device_t, device_t, void *); 219 int umass_detach(device_t, int); 220 static void umass_childdet(device_t, device_t); 221 int umass_activate(device_t, enum devact); 222 extern struct cfdriver umass_cd; 223 CFATTACH_DECL2_NEW(umass, sizeof(struct umass_softc), umass_match, 224 umass_attach, umass_detach, umass_activate, NULL, umass_childdet); 225 226 Static void umass_disco(struct umass_softc *sc); 227 228 /* generic transfer functions */ 229 Static usbd_status umass_setup_transfer(struct umass_softc *, 230 struct usbd_pipe *, 231 void *, int, int, 232 struct usbd_xfer *); 233 Static usbd_status umass_setup_ctrl_transfer(struct umass_softc *, 234 usb_device_request_t *, 235 void *, int, int, 236 struct usbd_xfer *); 237 Static void umass_clear_endpoint_stall(struct umass_softc *, int, 238 struct usbd_xfer *); 239 #if 0 240 Static void umass_reset(struct umass_softc *, transfer_cb_f, void *); 241 #endif 242 243 /* Bulk-Only related functions */ 244 Static void umass_bbb_transfer(struct umass_softc *, int, void *, int, void *, 245 int, int, u_int, int, umass_callback, void *); 246 Static void umass_bbb_reset(struct umass_softc *, int); 247 Static void umass_bbb_state(struct usbd_xfer *, void *, usbd_status); 248 249 usbd_status umass_bbb_get_max_lun(struct umass_softc *, uint8_t *); 250 251 /* CBI related functions */ 252 Static void umass_cbi_transfer(struct umass_softc *, int, void *, int, void *, 253 int, int, u_int, int, umass_callback, void *); 254 Static void umass_cbi_reset(struct umass_softc *, int); 255 Static void umass_cbi_state(struct usbd_xfer *, void *, usbd_status); 256 257 Static int umass_cbi_adsc(struct umass_softc *, char *, int, int, 258 struct usbd_xfer *); 259 260 const struct umass_wire_methods umass_bbb_methods = { 261 .wire_xfer = umass_bbb_transfer, 262 .wire_reset = umass_bbb_reset, 263 .wire_state = umass_bbb_state 264 }; 265 266 const struct umass_wire_methods umass_cbi_methods = { 267 .wire_xfer = umass_cbi_transfer, 268 .wire_reset = umass_cbi_reset, 269 .wire_state = umass_cbi_state 270 }; 271 272 #ifdef UMASS_DEBUG 273 /* General debugging functions */ 274 Static void umass_bbb_dump_cbw(struct umass_softc *sc, 275 umass_bbb_cbw_t *cbw); 276 Static void umass_bbb_dump_csw(struct umass_softc *sc, 277 umass_bbb_csw_t *csw); 278 Static void umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, 279 int buflen, int printlen); 280 #endif 281 282 283 /* 284 * USB device probe/attach/detach 285 */ 286 287 int 288 umass_match(device_t parent, cfdata_t match, void *aux) 289 { 290 struct usbif_attach_arg *uiaa = aux; 291 const struct umass_quirk *quirk; 292 293 quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product); 294 if (quirk != NULL && quirk->uq_match != UMASS_QUIRK_USE_DEFAULTMATCH) 295 return quirk->uq_match; 296 297 if (uiaa->uiaa_class != UICLASS_MASS) 298 return UMATCH_NONE; 299 300 switch (uiaa->uiaa_subclass) { 301 case UISUBCLASS_RBC: 302 case UISUBCLASS_SFF8020I: 303 case UISUBCLASS_QIC157: 304 case UISUBCLASS_UFI: 305 case UISUBCLASS_SFF8070I: 306 case UISUBCLASS_SCSI: 307 break; 308 default: 309 return UMATCH_IFACECLASS; 310 } 311 312 switch (uiaa->uiaa_proto) { 313 case UIPROTO_MASS_CBI_I: 314 case UIPROTO_MASS_CBI: 315 case UIPROTO_MASS_BBB_OLD: 316 case UIPROTO_MASS_BBB: 317 break; 318 default: 319 return UMATCH_IFACECLASS_IFACESUBCLASS; 320 } 321 322 return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO; 323 } 324 325 void 326 umass_attach(device_t parent, device_t self, void *aux) 327 { 328 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 329 struct umass_softc *sc = device_private(self); 330 struct usbif_attach_arg *uiaa = aux; 331 const struct umass_quirk *quirk; 332 usb_interface_descriptor_t *id; 333 usb_endpoint_descriptor_t *ed; 334 const char *sWire, *sCommand; 335 char *devinfop; 336 usbd_status err; 337 int i, error; 338 339 sc->sc_dev = self; 340 341 aprint_naive("\n"); 342 aprint_normal("\n"); 343 344 mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB); 345 cv_init(&sc->sc_detach_cv, "umassdet"); 346 347 devinfop = usbd_devinfo_alloc(uiaa->uiaa_device, 0); 348 aprint_normal_dev(self, "%s\n", devinfop); 349 usbd_devinfo_free(devinfop); 350 351 sc->sc_udev = uiaa->uiaa_device; 352 sc->sc_iface = uiaa->uiaa_iface; 353 sc->sc_ifaceno = uiaa->uiaa_ifaceno; 354 355 quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product); 356 if (quirk != NULL) { 357 sc->sc_wire = quirk->uq_wire; 358 sc->sc_cmd = quirk->uq_cmd; 359 sc->sc_quirks = quirk->uq_flags; 360 sc->sc_busquirks = quirk->uq_busquirks; 361 362 if (quirk->uq_fixup != NULL) 363 (*quirk->uq_fixup)(sc); 364 } else { 365 sc->sc_wire = UMASS_WPROTO_UNSPEC; 366 sc->sc_cmd = UMASS_CPROTO_UNSPEC; 367 sc->sc_quirks = 0; 368 sc->sc_busquirks = 0; 369 } 370 371 if (sc->sc_wire == UMASS_WPROTO_UNSPEC) { 372 switch (uiaa->uiaa_proto) { 373 case UIPROTO_MASS_CBI: 374 sc->sc_wire = UMASS_WPROTO_CBI; 375 break; 376 case UIPROTO_MASS_CBI_I: 377 sc->sc_wire = UMASS_WPROTO_CBI_I; 378 break; 379 case UIPROTO_MASS_BBB: 380 case UIPROTO_MASS_BBB_OLD: 381 sc->sc_wire = UMASS_WPROTO_BBB; 382 break; 383 default: 384 DPRINTFM(UDMASS_GEN, "Unsupported wire protocol %u", 385 uiaa->uiaa_proto, 0, 0, 0); 386 return; 387 } 388 } 389 390 if (sc->sc_cmd == UMASS_CPROTO_UNSPEC) { 391 switch (uiaa->uiaa_subclass) { 392 case UISUBCLASS_SCSI: 393 sc->sc_cmd = UMASS_CPROTO_SCSI; 394 break; 395 case UISUBCLASS_UFI: 396 sc->sc_cmd = UMASS_CPROTO_UFI; 397 break; 398 case UISUBCLASS_SFF8020I: 399 case UISUBCLASS_SFF8070I: 400 case UISUBCLASS_QIC157: 401 sc->sc_cmd = UMASS_CPROTO_ATAPI; 402 break; 403 case UISUBCLASS_RBC: 404 sc->sc_cmd = UMASS_CPROTO_RBC; 405 break; 406 default: 407 DPRINTFM(UDMASS_GEN, "Unsupported command protocol %u", 408 uiaa->uiaa_subclass, 0, 0, 0); 409 return; 410 } 411 } 412 413 switch (sc->sc_wire) { 414 case UMASS_WPROTO_CBI: 415 sWire = "CBI"; 416 break; 417 case UMASS_WPROTO_CBI_I: 418 sWire = "CBI with CCI"; 419 break; 420 case UMASS_WPROTO_BBB: 421 sWire = "Bulk-Only"; 422 break; 423 default: 424 sWire = "unknown"; 425 break; 426 } 427 428 switch (sc->sc_cmd) { 429 case UMASS_CPROTO_RBC: 430 sCommand = "RBC"; 431 break; 432 case UMASS_CPROTO_SCSI: 433 sCommand = "SCSI"; 434 break; 435 case UMASS_CPROTO_UFI: 436 sCommand = "UFI"; 437 break; 438 case UMASS_CPROTO_ATAPI: 439 sCommand = "ATAPI"; 440 break; 441 case UMASS_CPROTO_ISD_ATA: 442 sCommand = "ISD-ATA"; 443 break; 444 default: 445 sCommand = "unknown"; 446 break; 447 } 448 449 aprint_verbose_dev(self, "using %s over %s\n", sCommand, sWire); 450 451 if (quirk != NULL && quirk->uq_init != NULL) { 452 err = (*quirk->uq_init)(sc); 453 if (err) { 454 aprint_error_dev(self, "quirk init failed\n"); 455 umass_disco(sc); 456 return; 457 } 458 } 459 460 /* 461 * In addition to the Control endpoint the following endpoints 462 * are required: 463 * a) bulk-in endpoint. 464 * b) bulk-out endpoint. 465 * and for Control/Bulk/Interrupt with CCI (CBI_I) 466 * c) intr-in 467 * 468 * The endpoint addresses are not fixed, so we have to read them 469 * from the device descriptors of the current interface. 470 */ 471 id = usbd_get_interface_descriptor(sc->sc_iface); 472 for (i = 0 ; i < id->bNumEndpoints ; i++) { 473 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 474 if (ed == NULL) { 475 aprint_error_dev(self, 476 "could not read endpoint descriptor\n"); 477 return; 478 } 479 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN 480 && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 481 sc->sc_epaddr[UMASS_BULKIN] = ed->bEndpointAddress; 482 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT 483 && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 484 sc->sc_epaddr[UMASS_BULKOUT] = ed->bEndpointAddress; 485 } else if (sc->sc_wire == UMASS_WPROTO_CBI_I 486 && UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN 487 && (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) { 488 sc->sc_epaddr[UMASS_INTRIN] = ed->bEndpointAddress; 489 #ifdef UMASS_DEBUG 490 if (UGETW(ed->wMaxPacketSize) > 2) { 491 DPRINTFM(UDMASS_CBI, "sc %p intr size is %d", 492 sc, UGETW(ed->wMaxPacketSize), 0, 0); 493 } 494 #endif 495 } 496 } 497 498 /* check whether we found all the endpoints we need */ 499 if (!sc->sc_epaddr[UMASS_BULKIN] || !sc->sc_epaddr[UMASS_BULKOUT] || 500 (sc->sc_wire == UMASS_WPROTO_CBI_I && 501 !sc->sc_epaddr[UMASS_INTRIN])) { 502 aprint_error_dev(self, "endpoint not found %u/%u/%u\n", 503 sc->sc_epaddr[UMASS_BULKIN], 504 sc->sc_epaddr[UMASS_BULKOUT], 505 sc->sc_epaddr[UMASS_INTRIN]); 506 return; 507 } 508 509 /* 510 * Get the maximum LUN supported by the device. 511 */ 512 if (sc->sc_wire == UMASS_WPROTO_BBB && 513 (sc->sc_quirks & UMASS_QUIRK_NOGETMAXLUN) == 0) { 514 err = umass_bbb_get_max_lun(sc, &sc->maxlun); 515 if (err) { 516 aprint_error_dev(self, "unable to get Max Lun: %s\n", 517 usbd_errstr(err)); 518 return; 519 } 520 if (sc->maxlun > 0) 521 sc->sc_busquirks |= PQUIRK_FORCELUNS; 522 } else { 523 sc->maxlun = 0; 524 } 525 526 /* Open the bulk-in and -out pipe */ 527 DPRINTFM(UDMASS_USB, "sc %p: opening iface %p epaddr %d for BULKOUT", 528 sc, sc->sc_iface, sc->sc_epaddr[UMASS_BULKOUT], 0); 529 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKOUT], 530 USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKOUT]); 531 if (err) { 532 aprint_error_dev(self, "cannot open %u-out pipe (bulk)\n", 533 sc->sc_epaddr[UMASS_BULKOUT]); 534 umass_disco(sc); 535 return; 536 } 537 DPRINTFM(UDMASS_USB, "sc %p: opening iface %p epaddr %d for BULKIN", 538 sc, sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN], 0); 539 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN], 540 USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKIN]); 541 if (err) { 542 aprint_error_dev(self, "could not open %u-in pipe (bulk)\n", 543 sc->sc_epaddr[UMASS_BULKIN]); 544 umass_disco(sc); 545 return; 546 } 547 /* 548 * Open the intr-in pipe if the protocol is CBI with CCI. 549 * Note: early versions of the Zip drive do have an interrupt pipe, but 550 * this pipe is unused 551 * 552 * We do not open the interrupt pipe as an interrupt pipe, but as a 553 * normal bulk endpoint. We send an IN transfer down the wire at the 554 * appropriate time, because we know exactly when to expect data on 555 * that endpoint. This saves bandwidth, but more important, makes the 556 * code for handling the data on that endpoint simpler. No data 557 * arriving concurrently. 558 */ 559 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 560 DPRINTFM(UDMASS_USB, 561 "sc %p: opening iface %p epaddr %d for INTRIN", 562 sc, sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN], 0); 563 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN], 564 USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_INTRIN]); 565 if (err) { 566 aprint_error_dev(self, "couldn't open %u-in (intr)\n", 567 sc->sc_epaddr[UMASS_INTRIN]); 568 umass_disco(sc); 569 return; 570 } 571 } 572 573 /* initialisation of generic part */ 574 sc->transfer_state = TSTATE_IDLE; 575 576 for (i = 0; i < XFER_NR; i++) { 577 sc->transfer_xfer[i] = NULL; 578 } 579 580 /* 581 * Create the transfers 582 */ 583 struct usbd_pipe *pipe0 = usbd_get_pipe0(sc->sc_udev); 584 switch (sc->sc_wire) { 585 case UMASS_WPROTO_BBB: 586 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 587 UMASS_MAX_TRANSFER_SIZE, USBD_SHORT_XFER_OK, 0, 588 &sc->transfer_xfer[XFER_BBB_DATAIN]); 589 if (err) 590 goto fail_create; 591 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT], 592 UMASS_MAX_TRANSFER_SIZE, USBD_SHORT_XFER_OK, 0, 593 &sc->transfer_xfer[XFER_BBB_DATAOUT]); 594 if (err) 595 goto fail_create; 596 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT], 597 UMASS_BBB_CBW_SIZE, USBD_SHORT_XFER_OK, 0, 598 &sc->transfer_xfer[XFER_BBB_CBW]); 599 if (err) 600 goto fail_create; 601 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 602 UMASS_BBB_CSW_SIZE, USBD_SHORT_XFER_OK, 0, 603 &sc->transfer_xfer[XFER_BBB_CSW1]); 604 if (err) 605 goto fail_create; 606 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 607 UMASS_BBB_CSW_SIZE, USBD_SHORT_XFER_OK, 0, 608 &sc->transfer_xfer[XFER_BBB_CSW2]); 609 if (err) 610 goto fail_create; 611 err = usbd_create_xfer(pipe0, 0, 0, 0, 612 &sc->transfer_xfer[XFER_BBB_SCLEAR]); 613 if (err) 614 goto fail_create; 615 err = usbd_create_xfer(pipe0, 0, 0, 0, 616 &sc->transfer_xfer[XFER_BBB_DCLEAR]); 617 if (err) 618 goto fail_create; 619 err = usbd_create_xfer(pipe0, 0, 0, 0, 620 &sc->transfer_xfer[XFER_BBB_RESET1]); 621 if (err) 622 goto fail_create; 623 err = usbd_create_xfer(pipe0, 0, 0, 0, 624 &sc->transfer_xfer[XFER_BBB_RESET2]); 625 if (err) 626 goto fail_create; 627 err = usbd_create_xfer(pipe0, 0, 0, 0, 628 &sc->transfer_xfer[XFER_BBB_RESET3]); 629 if (err) 630 goto fail_create; 631 break; 632 case UMASS_WPROTO_CBI: 633 case UMASS_WPROTO_CBI_I: 634 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 635 &sc->transfer_xfer[XFER_CBI_CB]); 636 if (err) 637 goto fail_create; 638 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 639 UMASS_MAX_TRANSFER_SIZE, USBD_SHORT_XFER_OK, 0, 640 &sc->transfer_xfer[XFER_CBI_DATAIN]); 641 if (err) 642 goto fail_create; 643 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT], 644 UMASS_MAX_TRANSFER_SIZE, 0, 0, 645 &sc->transfer_xfer[XFER_CBI_DATAOUT]); 646 if (err) 647 goto fail_create; 648 err = usbd_create_xfer(sc->sc_pipe[UMASS_INTRIN], 649 sizeof(sc->sbl), 0, 0, 650 &sc->transfer_xfer[XFER_CBI_STATUS]); 651 if (err) 652 goto fail_create; 653 err = usbd_create_xfer(pipe0, 0, 0, 0, 654 &sc->transfer_xfer[XFER_CBI_DCLEAR]); 655 if (err) 656 goto fail_create; 657 err = usbd_create_xfer(pipe0, 0, 0, 0, 658 &sc->transfer_xfer[XFER_CBI_SCLEAR]); 659 if (err) 660 goto fail_create; 661 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 662 &sc->transfer_xfer[XFER_CBI_RESET1]); 663 if (err) 664 goto fail_create; 665 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 666 &sc->transfer_xfer[XFER_CBI_RESET2]); 667 if (err) 668 goto fail_create; 669 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 670 &sc->transfer_xfer[XFER_CBI_RESET3]); 671 if (err) 672 goto fail_create; 673 break; 674 default: 675 fail_create: 676 aprint_error_dev(self, "failed to create xfers\n"); 677 umass_disco(sc); 678 return; 679 } 680 681 /* 682 * Record buffer pinters for data transfer (it's huge), command and 683 * status data here 684 */ 685 switch (sc->sc_wire) { 686 case UMASS_WPROTO_BBB: 687 sc->datain_buffer = 688 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAIN]); 689 sc->dataout_buffer = 690 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAOUT]); 691 sc->cmd_buffer = 692 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CBW]); 693 sc->s1_buffer = 694 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW1]); 695 sc->s2_buffer = 696 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW2]); 697 break; 698 case UMASS_WPROTO_CBI: 699 case UMASS_WPROTO_CBI_I: 700 sc->datain_buffer = 701 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAIN]); 702 sc->dataout_buffer = 703 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAOUT]); 704 sc->cmd_buffer = 705 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_CB]); 706 sc->s1_buffer = 707 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_STATUS]); 708 sc->s2_buffer = 709 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_RESET1]); 710 break; 711 default: 712 break; 713 } 714 715 /* Initialise the wire protocol specific methods */ 716 switch (sc->sc_wire) { 717 case UMASS_WPROTO_BBB: 718 sc->sc_methods = &umass_bbb_methods; 719 break; 720 case UMASS_WPROTO_CBI: 721 case UMASS_WPROTO_CBI_I: 722 sc->sc_methods = &umass_cbi_methods; 723 break; 724 default: 725 umass_disco(sc); 726 return; 727 } 728 729 error = 0; 730 switch (sc->sc_cmd) { 731 case UMASS_CPROTO_RBC: 732 case UMASS_CPROTO_SCSI: 733 #if NSCSIBUS > 0 734 error = umass_scsi_attach(sc); 735 #else 736 aprint_error_dev(self, "scsibus not configured\n"); 737 #endif 738 break; 739 740 case UMASS_CPROTO_UFI: 741 case UMASS_CPROTO_ATAPI: 742 #if NATAPIBUS > 0 743 error = umass_atapi_attach(sc); 744 #else 745 aprint_error_dev(self, "atapibus not configured\n"); 746 #endif 747 break; 748 749 case UMASS_CPROTO_ISD_ATA: 750 #if NWD > 0 751 error = umass_isdata_attach(sc); 752 #else 753 aprint_error_dev(self, "isdata not configured\n"); 754 #endif 755 break; 756 757 default: 758 aprint_error_dev(self, "command protocol=0x%x not supported\n", 759 sc->sc_cmd); 760 umass_disco(sc); 761 return; 762 } 763 if (error) { 764 aprint_error_dev(self, "bus attach failed\n"); 765 umass_disco(sc); 766 return; 767 } 768 769 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev); 770 771 if (!pmf_device_register(self, NULL, NULL)) 772 aprint_error_dev(self, "couldn't establish power handler\n"); 773 774 DPRINTFM(UDMASS_GEN, "sc %p: Attach finished", sc, 0, 0, 0); 775 776 return; 777 } 778 779 static void 780 umass_childdet(device_t self, device_t child) 781 { 782 struct umass_softc *sc = device_private(self); 783 784 KASSERTMSG(child == sc->bus->sc_child, 785 "assertion child == sc->bus->sc_child failed\n"); 786 sc->bus->sc_child = NULL; 787 } 788 789 int 790 umass_detach(device_t self, int flags) 791 { 792 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 793 struct umass_softc *sc = device_private(self); 794 struct umassbus_softc *scbus; 795 int rv = 0, i; 796 797 DPRINTFM(UDMASS_USB, "sc %p detached", sc, 0, 0, 0); 798 799 pmf_device_deregister(self); 800 801 /* Abort the pipes to wake up any waiting processes. */ 802 for (i = 0 ; i < UMASS_NEP ; i++) { 803 if (sc->sc_pipe[i] != NULL) 804 usbd_abort_pipe(sc->sc_pipe[i]); 805 } 806 807 /* Do we really need reference counting? Perhaps in ioctl() */ 808 mutex_enter(&sc->sc_lock); 809 if (--sc->sc_refcnt >= 0) { 810 #ifdef DIAGNOSTIC 811 aprint_normal_dev(self, "waiting for refcnt\n"); 812 #endif 813 /* Wait for processes to go away. */ 814 usb_detach_wait(sc->sc_dev, &sc->sc_detach_cv, &sc->sc_lock); 815 } 816 mutex_exit(&sc->sc_lock); 817 818 scbus = sc->bus; 819 if (scbus != NULL) { 820 if (scbus->sc_child != NULL) 821 rv = config_detach(scbus->sc_child, flags); 822 823 switch (sc->sc_cmd) { 824 case UMASS_CPROTO_ISD_ATA: 825 #if NWD > 0 826 umass_isdata_detach(sc); 827 #else 828 aprint_error_dev(self, "isdata not configured\n"); 829 #endif 830 break; 831 832 default: 833 /* nothing to do */ 834 break; 835 } 836 837 free(scbus, M_DEVBUF); 838 sc->bus = NULL; 839 } 840 841 if (rv != 0) 842 return rv; 843 844 umass_disco(sc); 845 846 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev); 847 848 mutex_destroy(&sc->sc_lock); 849 cv_destroy(&sc->sc_detach_cv); 850 851 return rv; 852 } 853 854 int 855 umass_activate(device_t dev, enum devact act) 856 { 857 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 858 struct umass_softc *sc = device_private(dev); 859 860 DPRINTFM(UDMASS_USB, "sc %p act %d", sc, act, 0, 0); 861 862 switch (act) { 863 case DVACT_DEACTIVATE: 864 sc->sc_dying = 1; 865 return 0; 866 default: 867 return EOPNOTSUPP; 868 } 869 } 870 871 Static void 872 umass_disco(struct umass_softc *sc) 873 { 874 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 875 int i; 876 877 /* Remove all the pipes. */ 878 for (i = 0 ; i < UMASS_NEP ; i++) { 879 if (sc->sc_pipe[i] != NULL) { 880 usbd_abort_pipe(sc->sc_pipe[i]); 881 } 882 } 883 884 /* Some xfers may be queued in the default pipe */ 885 usbd_abort_default_pipe(sc->sc_udev); 886 887 /* Free the xfers. */ 888 for (i = 0; i < XFER_NR; i++) { 889 if (sc->transfer_xfer[i] != NULL) { 890 usbd_destroy_xfer(sc->transfer_xfer[i]); 891 sc->transfer_xfer[i] = NULL; 892 } 893 } 894 895 for (i = 0 ; i < UMASS_NEP ; i++) { 896 if (sc->sc_pipe[i] != NULL) { 897 usbd_close_pipe(sc->sc_pipe[i]); 898 sc->sc_pipe[i] = NULL; 899 } 900 } 901 902 } 903 904 /* 905 * Generic functions to handle transfers 906 */ 907 908 Static usbd_status 909 umass_setup_transfer(struct umass_softc *sc, struct usbd_pipe *pipe, 910 void *buffer, int buflen, int flags, 911 struct usbd_xfer *xfer) 912 { 913 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 914 usbd_status err; 915 916 if (sc->sc_dying) 917 return USBD_IOERROR; 918 919 /* Initialiase a USB transfer and then schedule it */ 920 921 usbd_setup_xfer(xfer, sc, buffer, buflen, flags, sc->timeout, 922 sc->sc_methods->wire_state); 923 924 err = usbd_transfer(xfer); 925 DPRINTFM(UDMASS_XFER, "start xfer buffer=%p buflen=%d flags=0x%x " 926 "timeout=%d", buffer, buflen, flags, sc->timeout); 927 if (err && err != USBD_IN_PROGRESS) { 928 DPRINTFM(UDMASS_BBB, "failed to setup transfer... err=%d", 929 err, 0, 0, 0); 930 return err; 931 } 932 933 return USBD_NORMAL_COMPLETION; 934 } 935 936 937 Static usbd_status 938 umass_setup_ctrl_transfer(struct umass_softc *sc, usb_device_request_t *req, 939 void *buffer, int buflen, int flags, struct usbd_xfer *xfer) 940 { 941 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 942 usbd_status err; 943 944 if (sc->sc_dying) 945 return USBD_IOERROR; 946 947 /* Initialiase a USB control transfer and then schedule it */ 948 949 usbd_setup_default_xfer(xfer, sc->sc_udev, (void *) sc, sc->timeout, 950 req, buffer, buflen, flags, sc->sc_methods->wire_state); 951 952 err = usbd_transfer(xfer); 953 if (err && err != USBD_IN_PROGRESS) { 954 DPRINTFM(UDMASS_BBB, "failed to setup ctrl transfer... err=%d", 955 err, 0, 0, 0); 956 957 /* do not reset, as this would make us loop */ 958 return err; 959 } 960 961 return USBD_NORMAL_COMPLETION; 962 } 963 964 Static void 965 umass_clear_endpoint_stall(struct umass_softc *sc, int endpt, 966 struct usbd_xfer *xfer) 967 { 968 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 969 970 if (sc->sc_dying) 971 return; 972 973 DPRINTFM(UDMASS_BBB, "Clear endpoint 0x%02x stall", 974 sc->sc_epaddr[endpt], 0, 0, 0); 975 976 usbd_clear_endpoint_toggle(sc->sc_pipe[endpt]); 977 978 sc->sc_req.bmRequestType = UT_WRITE_ENDPOINT; 979 sc->sc_req.bRequest = UR_CLEAR_FEATURE; 980 USETW(sc->sc_req.wValue, UF_ENDPOINT_HALT); 981 USETW(sc->sc_req.wIndex, sc->sc_epaddr[endpt]); 982 USETW(sc->sc_req.wLength, 0); 983 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, xfer); 984 } 985 986 #if 0 987 Static void 988 umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv) 989 { 990 sc->transfer_cb = cb; 991 sc->transfer_priv = priv; 992 993 /* The reset is a forced reset, so no error (yet) */ 994 sc->reset(sc, STATUS_CMD_OK); 995 } 996 #endif 997 998 /* 999 * Bulk protocol specific functions 1000 */ 1001 1002 Static void 1003 umass_bbb_reset(struct umass_softc *sc, int status) 1004 { 1005 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1006 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1007 "sc->sc_wire == 0x%02x wrong for umass_bbb_reset\n", 1008 sc->sc_wire); 1009 1010 if (sc->sc_dying) 1011 return; 1012 1013 /* 1014 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class) 1015 * 1016 * For Reset Recovery the host shall issue in the following order: 1017 * a) a Bulk-Only Mass Storage Reset 1018 * b) a Clear Feature HALT to the Bulk-In endpoint 1019 * c) a Clear Feature HALT to the Bulk-Out endpoint 1020 * 1021 * This is done in 3 steps, states: 1022 * TSTATE_BBB_RESET1 1023 * TSTATE_BBB_RESET2 1024 * TSTATE_BBB_RESET3 1025 * 1026 * If the reset doesn't succeed, the device should be port reset. 1027 */ 1028 1029 DPRINTFM(UDMASS_BBB, "Bulk Reset", 0, 0, 0, 0); 1030 1031 sc->transfer_state = TSTATE_BBB_RESET1; 1032 sc->transfer_status = status; 1033 1034 /* reset is a class specific interface write */ 1035 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1036 sc->sc_req.bRequest = UR_BBB_RESET; 1037 USETW(sc->sc_req.wValue, 0); 1038 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 1039 USETW(sc->sc_req.wLength, 0); 1040 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, 1041 sc->transfer_xfer[XFER_BBB_RESET1]); 1042 } 1043 1044 Static void 1045 umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, 1046 void *data, int datalen, int dir, u_int timeout, 1047 int flags, umass_callback cb, void *priv) 1048 { 1049 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1050 static int dCBWtag = 42; /* unique for CBW of transfer */ 1051 1052 DPRINTFM(UDMASS_BBB, "sc %p cmd=0x%02x", sc, *(u_char *)cmd, 0, 0); 1053 1054 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1055 "sc->sc_wire == 0x%02x wrong for umass_bbb_transfer\n", 1056 sc->sc_wire); 1057 1058 if (sc->sc_dying) 1059 return; 1060 1061 /* Be a little generous. */ 1062 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 1063 1064 /* 1065 * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly 1066 * a data phase of datalen bytes from/to the device and finally a 1067 * csw read phase. 1068 * If the data direction was inbound a maximum of datalen bytes 1069 * is stored in the buffer pointed to by data. 1070 * 1071 * umass_bbb_transfer initialises the transfer and lets the state 1072 * machine in umass_bbb_state handle the completion. It uses the 1073 * following states: 1074 * TSTATE_BBB_COMMAND 1075 * -> TSTATE_BBB_DATA 1076 * -> TSTATE_BBB_STATUS 1077 * -> TSTATE_BBB_STATUS2 1078 * -> TSTATE_BBB_IDLE 1079 * 1080 * An error in any of those states will invoke 1081 * umass_bbb_reset. 1082 */ 1083 1084 /* check the given arguments */ 1085 KASSERTMSG(datalen == 0 || data != NULL, 1086 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 1087 KASSERTMSG(cmdlen <= CBWCDBLENGTH, 1088 "%s: cmdlen exceeds CDB length in CBW (%d > %d)", 1089 device_xname(sc->sc_dev), cmdlen, CBWCDBLENGTH); 1090 KASSERTMSG(dir == DIR_NONE || datalen > 0, 1091 "%s: datalen == 0 while direction is not NONE\n", 1092 device_xname(sc->sc_dev)); 1093 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 1094 "%s: direction is NONE while datalen is not zero\n", 1095 device_xname(sc->sc_dev)); 1096 /* CTASSERT */ 1097 KASSERTMSG(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE, 1098 "%s: CBW struct does not have the right size (%zu vs. %u)\n", 1099 device_xname(sc->sc_dev), 1100 sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE); 1101 /* CTASSERT */ 1102 KASSERTMSG(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE, 1103 "%s: CSW struct does not have the right size (%zu vs. %u)\n", 1104 device_xname(sc->sc_dev), 1105 sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE); 1106 1107 /* 1108 * Determine the direction of the data transfer and the length. 1109 * 1110 * dCBWDataTransferLength (datalen) : 1111 * This field indicates the number of bytes of data that the host 1112 * intends to transfer on the IN or OUT Bulk endpoint(as indicated by 1113 * the Direction bit) during the execution of this command. If this 1114 * field is set to 0, the device will expect that no data will be 1115 * transferred IN or OUT during this command, regardless of the value 1116 * of the Direction bit defined in dCBWFlags. 1117 * 1118 * dCBWFlags (dir) : 1119 * The bits of the Flags field are defined as follows: 1120 * Bits 0-6 reserved 1121 * Bit 7 Direction - this bit shall be ignored if the 1122 * dCBWDataTransferLength field is zero. 1123 * 0 = data Out from host to device 1124 * 1 = data In from device to host 1125 */ 1126 1127 /* Fill in the Command Block Wrapper */ 1128 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE); 1129 USETDW(sc->cbw.dCBWTag, dCBWtag); 1130 dCBWtag++; /* cannot be done in macro (it will be done 4 times) */ 1131 USETDW(sc->cbw.dCBWDataTransferLength, datalen); 1132 /* DIR_NONE is treated as DIR_OUT (0x00) */ 1133 sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT); 1134 sc->cbw.bCBWLUN = lun; 1135 sc->cbw.bCDBLength = cmdlen; 1136 memcpy(sc->cbw.CBWCDB, cmd, cmdlen); 1137 1138 DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw)); 1139 1140 /* store the details for the data transfer phase */ 1141 sc->transfer_dir = dir; 1142 sc->transfer_data = data; 1143 sc->transfer_datalen = datalen; 1144 sc->transfer_actlen = 0; 1145 sc->transfer_cb = cb; 1146 sc->transfer_priv = priv; 1147 sc->transfer_status = STATUS_CMD_OK; 1148 1149 /* move from idle to the command state */ 1150 sc->transfer_state = TSTATE_BBB_COMMAND; 1151 1152 /* Send the CBW from host to device via bulk-out endpoint. */ 1153 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1154 &sc->cbw, UMASS_BBB_CBW_SIZE, flags, 1155 sc->transfer_xfer[XFER_BBB_CBW])) { 1156 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1157 } 1158 } 1159 1160 1161 Static void 1162 umass_bbb_state(struct usbd_xfer *xfer, void *priv, 1163 usbd_status err) 1164 { 1165 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1166 struct umass_softc *sc = (struct umass_softc *) priv; 1167 struct usbd_xfer *next_xfer; 1168 int residue; 1169 1170 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1171 "sc->sc_wire == 0x%02x wrong for umass_bbb_state\n", 1172 sc->sc_wire); 1173 1174 if (sc->sc_dying) 1175 return; 1176 1177 /* 1178 * State handling for BBB transfers. 1179 * 1180 * The subroutine is rather long. It steps through the states given in 1181 * Annex A of the Bulk-Only specification. 1182 * Each state first does the error handling of the previous transfer 1183 * and then prepares the next transfer. 1184 * Each transfer is done asynchroneously so after the request/transfer 1185 * has been submitted you will find a 'return;'. 1186 */ 1187 1188 DPRINTFM(UDMASS_BBB, "sc %p xfer %p, transfer_state %d dir %d", sc, 1189 xfer, sc->transfer_state, sc->transfer_dir); 1190 1191 switch (sc->transfer_state) { 1192 1193 /***** Bulk Transfer *****/ 1194 case TSTATE_BBB_COMMAND: 1195 /* Command transport phase, error handling */ 1196 if (err) { 1197 DPRINTFM(UDMASS_BBB, "sc %p failed to send CBW", sc, 1198 0, 0, 0); 1199 /* If the device detects that the CBW is invalid, then 1200 * the device may STALL both bulk endpoints and require 1201 * a Bulk-Reset 1202 */ 1203 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1204 return; 1205 } 1206 1207 /* Data transport phase, setup transfer */ 1208 sc->transfer_state = TSTATE_BBB_DATA; 1209 if (sc->transfer_dir == DIR_IN) { 1210 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1211 sc->datain_buffer, sc->transfer_datalen, 1212 USBD_SHORT_XFER_OK, 1213 sc->transfer_xfer[XFER_BBB_DATAIN])) 1214 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1215 1216 return; 1217 } else if (sc->transfer_dir == DIR_OUT) { 1218 memcpy(sc->dataout_buffer, sc->transfer_data, 1219 sc->transfer_datalen); 1220 if (umass_setup_transfer(sc, 1221 sc->sc_pipe[UMASS_BULKOUT], sc->dataout_buffer, 1222 sc->transfer_datalen, 0,/* fixed length transfer */ 1223 sc->transfer_xfer[XFER_BBB_DATAOUT])) 1224 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1225 1226 return; 1227 } else { 1228 DPRINTFM(UDMASS_BBB, "sc %p: no data phase", sc, 0, 0, 1229 0); 1230 } 1231 1232 /* FALLTHROUGH if no data phase, err == 0 */ 1233 case TSTATE_BBB_DATA: 1234 /* Command transport phase error handling (ignored if no data 1235 * phase (fallthrough from previous state)) */ 1236 if (sc->transfer_dir != DIR_NONE) { 1237 /* retrieve the length of the transfer that was done */ 1238 usbd_get_xfer_status(xfer, NULL, NULL, 1239 &sc->transfer_actlen, NULL); 1240 DPRINTFM(UDMASS_BBB, "sc %p: BBB_DATA actlen=%d", 1241 sc, sc->transfer_actlen, 0, 0); 1242 1243 if (err) { 1244 DPRINTFM(UDMASS_BBB, "sc %p Data dir %d err %d" 1245 " failed, ", sc, sc->transfer_dir, 1246 sc->transfer_datalen, err); 1247 1248 if (err == USBD_STALLED) { 1249 sc->transfer_state = TSTATE_BBB_DCLEAR; 1250 umass_clear_endpoint_stall(sc, 1251 (sc->transfer_dir == DIR_IN? 1252 UMASS_BULKIN:UMASS_BULKOUT), 1253 sc->transfer_xfer[XFER_BBB_DCLEAR]); 1254 } else { 1255 /* Unless the error is a pipe stall the 1256 * error is fatal. 1257 */ 1258 umass_bbb_reset(sc,STATUS_WIRE_FAILED); 1259 } 1260 return; 1261 } 1262 } 1263 1264 /* FALLTHROUGH, err == 0 (no data phase or successful) */ 1265 case TSTATE_BBB_DCLEAR: /* stall clear after data phase */ 1266 if (sc->transfer_dir == DIR_IN) 1267 memcpy(sc->transfer_data, sc->datain_buffer, 1268 sc->transfer_actlen); 1269 1270 DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN) 1271 umass_dump_buffer(sc, sc->transfer_data, 1272 sc->transfer_datalen, 48)); 1273 1274 /* FALLTHROUGH, err == 0 (no data phase or successful) */ 1275 case TSTATE_BBB_SCLEAR: /* stall clear after status phase */ 1276 /* Reading of CSW after bulk stall condition in data phase 1277 * (TSTATE_BBB_DATA2) or bulk-in stall condition after 1278 * reading CSW (TSTATE_BBB_SCLEAR). 1279 * In the case of no data phase or successful data phase, 1280 * err == 0 and the following if block is passed. 1281 */ 1282 if (err) { /* should not occur */ 1283 printf("%s: BBB bulk-%s stall clear failed, %s\n", 1284 device_xname(sc->sc_dev), 1285 (sc->transfer_dir == DIR_IN? "in":"out"), 1286 usbd_errstr(err)); 1287 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1288 return; 1289 } 1290 1291 /* Status transport phase, setup transfer */ 1292 if (sc->transfer_state == TSTATE_BBB_COMMAND || 1293 sc->transfer_state == TSTATE_BBB_DATA || 1294 sc->transfer_state == TSTATE_BBB_DCLEAR) { 1295 /* After no data phase, successful data phase and 1296 * after clearing bulk-in/-out stall condition 1297 */ 1298 sc->transfer_state = TSTATE_BBB_STATUS1; 1299 next_xfer = sc->transfer_xfer[XFER_BBB_CSW1]; 1300 } else { 1301 /* After first attempt of fetching CSW */ 1302 sc->transfer_state = TSTATE_BBB_STATUS2; 1303 next_xfer = sc->transfer_xfer[XFER_BBB_CSW2]; 1304 } 1305 1306 /* Read the Command Status Wrapper via bulk-in endpoint. */ 1307 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1308 &sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) { 1309 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1310 return; 1311 } 1312 1313 return; 1314 case TSTATE_BBB_STATUS1: /* first attempt */ 1315 case TSTATE_BBB_STATUS2: /* second attempt */ 1316 /* Status transfer, error handling */ 1317 if (err) { 1318 DPRINTFM(UDMASS_BBB, "sc %p Failed to read CSW err %d " 1319 "(state %d)", sc, err, sc->transfer_state, 0); 1320 1321 /* If this was the first attempt at fetching the CSW 1322 * retry it, otherwise fail. 1323 */ 1324 if (sc->transfer_state == TSTATE_BBB_STATUS1) { 1325 sc->transfer_state = TSTATE_BBB_SCLEAR; 1326 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1327 sc->transfer_xfer[XFER_BBB_SCLEAR]); 1328 return; 1329 } else { 1330 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1331 return; 1332 } 1333 } 1334 1335 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw)); 1336 1337 #ifdef UMASS_DEBUG 1338 residue = UGETDW(sc->csw.dCSWDataResidue); 1339 if (residue != sc->transfer_datalen - sc->transfer_actlen) 1340 printf("%s: dCSWDataResidue=%d req=%d act=%d\n", 1341 device_xname(sc->sc_dev), residue, 1342 sc->transfer_datalen, sc->transfer_actlen); 1343 #endif 1344 residue = sc->transfer_datalen - sc->transfer_actlen; 1345 1346 /* Translate weird command-status signatures. */ 1347 if ((sc->sc_quirks & UMASS_QUIRK_WRONG_CSWSIG) && 1348 UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1) 1349 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE); 1350 1351 /* Translate invalid command-status tags */ 1352 if (sc->sc_quirks & UMASS_QUIRK_WRONG_CSWTAG) 1353 USETDW(sc->csw.dCSWTag, UGETDW(sc->cbw.dCBWTag)); 1354 1355 /* Check CSW and handle any error */ 1356 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) { 1357 /* Invalid CSW: Wrong signature or wrong tag might 1358 * indicate that the device is confused -> reset it. 1359 */ 1360 printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n", 1361 device_xname(sc->sc_dev), 1362 UGETDW(sc->csw.dCSWSignature), 1363 CSWSIGNATURE); 1364 1365 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1366 return; 1367 } else if (UGETDW(sc->csw.dCSWTag) 1368 != UGETDW(sc->cbw.dCBWTag)) { 1369 printf("%s: Invalid CSW: tag %d should be %d\n", 1370 device_xname(sc->sc_dev), 1371 UGETDW(sc->csw.dCSWTag), 1372 UGETDW(sc->cbw.dCBWTag)); 1373 1374 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1375 return; 1376 1377 /* CSW is valid here */ 1378 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) { 1379 printf("%s: Invalid CSW: status %d > %d\n", 1380 device_xname(sc->sc_dev), 1381 sc->csw.bCSWStatus, 1382 CSWSTATUS_PHASE); 1383 1384 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1385 return; 1386 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) { 1387 printf("%s: Phase Error, residue = %d\n", 1388 device_xname(sc->sc_dev), residue); 1389 1390 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1391 return; 1392 1393 } else if (sc->transfer_actlen > sc->transfer_datalen) { 1394 /* Buffer overrun! Don't let this go by unnoticed */ 1395 panic("%s: transferred %s %d bytes instead of %d bytes", 1396 device_xname(sc->sc_dev), 1397 sc->transfer_dir == DIR_IN ? "IN" : "OUT", 1398 sc->transfer_actlen, sc->transfer_datalen); 1399 #if 0 1400 } else if (sc->transfer_datalen - sc->transfer_actlen 1401 != residue) { 1402 DPRINTFM(UDMASS_BBB, "sc %p: actlen=%d != residue=%d\n", 1403 sc, 1404 sc->transfer_datalen - sc->transfer_actlen, 1405 residue)); 1406 1407 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1408 return; 1409 #endif 1410 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) { 1411 DPRINTFM(UDMASS_BBB, "sc %p: Command Failed, res = %d", 1412 sc, residue, 0, 0); 1413 1414 /* SCSI command failed but transfer was succesful */ 1415 sc->transfer_state = TSTATE_IDLE; 1416 sc->transfer_cb(sc, sc->transfer_priv, residue, 1417 STATUS_CMD_FAILED); 1418 1419 return; 1420 1421 } else { /* success */ 1422 sc->transfer_state = TSTATE_IDLE; 1423 sc->transfer_cb(sc, sc->transfer_priv, residue, 1424 STATUS_CMD_OK); 1425 1426 return; 1427 } 1428 1429 /***** Bulk Reset *****/ 1430 case TSTATE_BBB_RESET1: 1431 if (err) 1432 printf("%s: BBB reset failed, %s\n", 1433 device_xname(sc->sc_dev), usbd_errstr(err)); 1434 1435 sc->transfer_state = TSTATE_BBB_RESET2; 1436 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1437 sc->transfer_xfer[XFER_BBB_RESET2]); 1438 1439 return; 1440 case TSTATE_BBB_RESET2: 1441 if (err) /* should not occur */ 1442 printf("%s: BBB bulk-in clear stall failed, %s\n", 1443 device_xname(sc->sc_dev), usbd_errstr(err)); 1444 /* no error recovery, otherwise we end up in a loop */ 1445 1446 sc->transfer_state = TSTATE_BBB_RESET3; 1447 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1448 sc->transfer_xfer[XFER_BBB_RESET3]); 1449 1450 return; 1451 case TSTATE_BBB_RESET3: 1452 if (err) /* should not occur */ 1453 printf("%s: BBB bulk-out clear stall failed, %s\n", 1454 device_xname(sc->sc_dev), usbd_errstr(err)); 1455 /* no error recovery, otherwise we end up in a loop */ 1456 1457 sc->transfer_state = TSTATE_IDLE; 1458 if (sc->transfer_priv) { 1459 sc->transfer_cb(sc, sc->transfer_priv, 1460 sc->transfer_datalen, 1461 sc->transfer_status); 1462 } 1463 1464 return; 1465 1466 /***** Default *****/ 1467 default: 1468 panic("%s: Unknown state %d", 1469 device_xname(sc->sc_dev), sc->transfer_state); 1470 } 1471 } 1472 1473 /* 1474 * Command/Bulk/Interrupt (CBI) specific functions 1475 */ 1476 1477 Static int 1478 umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, int flags, 1479 struct usbd_xfer *xfer) 1480 { 1481 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1482 "sc->sc_wire == 0x%02x wrong for umass_cbi_adsc\n", 1483 sc->sc_wire); 1484 1485 if ((sc->sc_cmd == UMASS_CPROTO_RBC) && 1486 (sc->sc_quirks & UMASS_QUIRK_RBC_PAD_TO_12) != 0 && buflen < 12) { 1487 (void)memset(buffer + buflen, 0, 12 - buflen); 1488 buflen = 12; 1489 } 1490 1491 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1492 sc->sc_req.bRequest = UR_CBI_ADSC; 1493 USETW(sc->sc_req.wValue, 0); 1494 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 1495 USETW(sc->sc_req.wLength, buflen); 1496 return umass_setup_ctrl_transfer(sc, &sc->sc_req, buffer, 1497 buflen, flags, xfer); 1498 } 1499 1500 1501 Static void 1502 umass_cbi_reset(struct umass_softc *sc, int status) 1503 { 1504 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1505 int i; 1506 # define SEND_DIAGNOSTIC_CMDLEN 12 1507 1508 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1509 "sc->sc_wire == 0x%02x wrong for umass_cbi_reset\n", 1510 sc->sc_wire); 1511 1512 if (sc->sc_dying) 1513 return; 1514 1515 /* 1516 * Command Block Reset Protocol 1517 * 1518 * First send a reset request to the device. Then clear 1519 * any possibly stalled bulk endpoints. 1520 1521 * This is done in 3 steps, states: 1522 * TSTATE_CBI_RESET1 1523 * TSTATE_CBI_RESET2 1524 * TSTATE_CBI_RESET3 1525 * 1526 * If the reset doesn't succeed, the device should be port reset. 1527 */ 1528 1529 DPRINTFM(UDMASS_CBI, "sc %p: CBI Reset", sc, 0, 0, 0); 1530 1531 /* CTASSERT */ 1532 KASSERTMSG(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN, 1533 "%s: CBL struct is too small (%zu < %u)\n", 1534 device_xname(sc->sc_dev), 1535 sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN); 1536 1537 sc->transfer_state = TSTATE_CBI_RESET1; 1538 sc->transfer_status = status; 1539 1540 /* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between 1541 * the two the last 10 bytes of the cbl is filled with 0xff (section 1542 * 2.2 of the CBI spec). 1543 */ 1544 sc->cbl[0] = 0x1d; /* Command Block Reset */ 1545 sc->cbl[1] = 0x04; 1546 for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++) 1547 sc->cbl[i] = 0xff; 1548 1549 umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, 0, 1550 sc->transfer_xfer[XFER_CBI_RESET1]); 1551 /* XXX if the command fails we should reset the port on the bub */ 1552 } 1553 1554 Static void 1555 umass_cbi_transfer(struct umass_softc *sc, int lun, 1556 void *cmd, int cmdlen, void *data, int datalen, int dir, 1557 u_int timeout, int flags, umass_callback cb, void *priv) 1558 { 1559 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1560 1561 DPRINTFM(UDMASS_CBI, "sc %p: cmd=0x%02x, len=%d", sc, *(u_char *)cmd, 1562 datalen, 0); 1563 1564 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1565 "sc->sc_wire == 0x%02x wrong for umass_cbi_transfer\n", 1566 sc->sc_wire); 1567 1568 if (sc->sc_dying) 1569 return; 1570 1571 /* Be a little generous. */ 1572 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 1573 1574 /* 1575 * Do a CBI transfer with cmdlen bytes from cmd, possibly 1576 * a data phase of datalen bytes from/to the device and finally a 1577 * csw read phase. 1578 * If the data direction was inbound a maximum of datalen bytes 1579 * is stored in the buffer pointed to by data. 1580 * 1581 * umass_cbi_transfer initialises the transfer and lets the state 1582 * machine in umass_cbi_state handle the completion. It uses the 1583 * following states: 1584 * TSTATE_CBI_COMMAND 1585 * -> XXX fill in 1586 * 1587 * An error in any of those states will invoke 1588 * umass_cbi_reset. 1589 */ 1590 1591 /* check the given arguments */ 1592 KASSERTMSG(datalen == 0 || data != NULL, 1593 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 1594 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 1595 "%s: direction is NONE while datalen is not zero\n", 1596 device_xname(sc->sc_dev)); 1597 1598 /* store the details for the data transfer phase */ 1599 sc->transfer_dir = dir; 1600 sc->transfer_data = data; 1601 sc->transfer_datalen = datalen; 1602 sc->transfer_actlen = 0; 1603 sc->transfer_cb = cb; 1604 sc->transfer_priv = priv; 1605 sc->transfer_status = STATUS_CMD_OK; 1606 1607 /* move from idle to the command state */ 1608 sc->transfer_state = TSTATE_CBI_COMMAND; 1609 1610 /* Send the Command Block from host to device via control endpoint. */ 1611 if (umass_cbi_adsc(sc, cmd, cmdlen, flags, 1612 sc->transfer_xfer[XFER_CBI_CB])) 1613 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1614 } 1615 1616 Static void 1617 umass_cbi_state(struct usbd_xfer *xfer, void *priv, 1618 usbd_status err) 1619 { 1620 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1621 struct umass_softc *sc = (struct umass_softc *) priv; 1622 1623 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1624 "sc->sc_wire == 0x%02x wrong for umass_cbi_state\n", 1625 sc->sc_wire); 1626 1627 if (sc->sc_dying) 1628 return; 1629 1630 /* 1631 * State handling for CBI transfers. 1632 */ 1633 1634 DPRINTFM(UDMASS_CBI, "sc %p: Handling CBI state %d, xfer=%p, ...", 1635 sc, sc->transfer_state, xfer, 0); 1636 DPRINTFM(UDMASS_CBI, "... err %d", err, 0, 0, 0); 1637 1638 switch (sc->transfer_state) { 1639 1640 /***** CBI Transfer *****/ 1641 case TSTATE_CBI_COMMAND: 1642 if (err == USBD_STALLED) { 1643 DPRINTFM(UDMASS_CBI, "sc %p: Command Transport failed", 1644 sc, 0, 0, 0); 1645 /* Status transport by control pipe (section 2.3.2.1). 1646 * The command contained in the command block failed. 1647 * 1648 * The control pipe has already been unstalled by the 1649 * USB stack. 1650 * Section 2.4.3.1.1 states that the bulk in endpoints 1651 * should not stalled at this point. 1652 */ 1653 1654 sc->transfer_state = TSTATE_IDLE; 1655 sc->transfer_cb(sc, sc->transfer_priv, 1656 sc->transfer_datalen, 1657 STATUS_CMD_FAILED); 1658 1659 return; 1660 } else if (err) { 1661 DPRINTFM(UDMASS_CBI, "sc %p: failed to send ADSC", 1662 sc, 0, 0, 0); 1663 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1664 return; 1665 } 1666 1667 /* Data transport phase, setup transfer */ 1668 sc->transfer_state = TSTATE_CBI_DATA; 1669 if (sc->transfer_dir == DIR_IN) { 1670 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1671 sc->datain_buffer, sc->transfer_datalen, 1672 USBD_SHORT_XFER_OK, 1673 sc->transfer_xfer[XFER_CBI_DATAIN])) 1674 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1675 1676 return; 1677 } else if (sc->transfer_dir == DIR_OUT) { 1678 memcpy(sc->dataout_buffer, sc->transfer_data, 1679 sc->transfer_datalen); 1680 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1681 sc->dataout_buffer, sc->transfer_datalen, 1682 0, /* fixed length transfer */ 1683 sc->transfer_xfer[XFER_CBI_DATAOUT])) 1684 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1685 1686 return; 1687 } else { 1688 DPRINTFM(UDMASS_CBI, "sc %p: no data phase", sc, 0, 0, 1689 0); 1690 } 1691 1692 /* FALLTHROUGH if no data phase, err == 0 */ 1693 case TSTATE_CBI_DATA: 1694 /* Command transport phase error handling (ignored if no data 1695 * phase (fallthrough from previous state)) */ 1696 if (sc->transfer_dir != DIR_NONE) { 1697 /* retrieve the length of the transfer that was done */ 1698 usbd_get_xfer_status(xfer, NULL, NULL, 1699 &sc->transfer_actlen, NULL); 1700 DPRINTFM(UDMASS_CBI, "sc %p: CBI_DATA actlen=%d", 1701 sc, sc->transfer_actlen, 0, 0); 1702 1703 if (err) { 1704 DPRINTFM(UDMASS_CBI, "sc %p: Data dir %d " 1705 "err %d failed", sc, sc->transfer_dir, 1706 sc->transfer_datalen, err); 1707 1708 if (err == USBD_STALLED) { 1709 sc->transfer_state = TSTATE_CBI_DCLEAR; 1710 umass_clear_endpoint_stall(sc, 1711 (sc->transfer_dir == DIR_IN? 1712 UMASS_BULKIN:UMASS_BULKOUT), 1713 sc->transfer_xfer[XFER_CBI_DCLEAR]); 1714 } else { 1715 /* Unless the error is a pipe stall the 1716 * error is fatal. 1717 */ 1718 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1719 } 1720 return; 1721 } 1722 } 1723 1724 if (sc->transfer_dir == DIR_IN) 1725 memcpy(sc->transfer_data, sc->datain_buffer, 1726 sc->transfer_actlen); 1727 1728 DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN) 1729 umass_dump_buffer(sc, sc->transfer_data, 1730 sc->transfer_actlen, 48)); 1731 1732 /* Status phase */ 1733 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 1734 sc->transfer_state = TSTATE_CBI_STATUS; 1735 memset(&sc->sbl, 0, sizeof(sc->sbl)); 1736 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_INTRIN], 1737 &sc->sbl, sizeof(sc->sbl), 1738 0, /* fixed length transfer */ 1739 sc->transfer_xfer[XFER_CBI_STATUS])) 1740 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1741 } else { 1742 /* No command completion interrupt. Request 1743 * sense to get status of command. 1744 */ 1745 sc->transfer_state = TSTATE_IDLE; 1746 sc->transfer_cb(sc, sc->transfer_priv, 1747 sc->transfer_datalen - sc->transfer_actlen, 1748 STATUS_CMD_UNKNOWN); 1749 } 1750 return; 1751 1752 case TSTATE_CBI_STATUS: 1753 if (err) { 1754 DPRINTFM(UDMASS_CBI, "sc %p: Status Transport failed", 1755 sc, 0, 0, 0); 1756 /* Status transport by interrupt pipe (section 2.3.2.2). 1757 */ 1758 1759 if (err == USBD_STALLED) { 1760 sc->transfer_state = TSTATE_CBI_SCLEAR; 1761 umass_clear_endpoint_stall(sc, UMASS_INTRIN, 1762 sc->transfer_xfer[XFER_CBI_SCLEAR]); 1763 } else { 1764 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1765 } 1766 return; 1767 } 1768 1769 /* Dissect the information in the buffer */ 1770 1771 { 1772 uint32_t actlen; 1773 usbd_get_xfer_status(xfer,NULL,NULL,&actlen,NULL); 1774 DPRINTFM(UDMASS_CBI, "sc %p: CBI_STATUS actlen=%d", 1775 sc, actlen, 0, 0); 1776 if (actlen != 2) 1777 break; 1778 } 1779 1780 if (sc->sc_cmd == UMASS_CPROTO_UFI) { 1781 int status; 1782 1783 /* Section 3.4.3.1.3 specifies that the UFI command 1784 * protocol returns an ASC and ASCQ in the interrupt 1785 * data block. 1786 */ 1787 1788 DPRINTFM(UDMASS_CBI, "sc %p: UFI CCI, ASC = 0x%02x, " 1789 "ASCQ = 0x%02x", sc, sc->sbl.ufi.asc, 1790 sc->sbl.ufi.ascq, 0); 1791 1792 if ((sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) || 1793 sc->sc_sense) 1794 status = STATUS_CMD_OK; 1795 else 1796 status = STATUS_CMD_FAILED; 1797 1798 /* No autosense, command successful */ 1799 sc->transfer_state = TSTATE_IDLE; 1800 sc->transfer_cb(sc, sc->transfer_priv, 1801 sc->transfer_datalen - sc->transfer_actlen, status); 1802 } else { 1803 int status; 1804 1805 /* Command Interrupt Data Block */ 1806 1807 DPRINTFM(UDMASS_CBI, "sc %p: type=0x%02x, value=0x%02x", 1808 sc, sc->sbl.common.type, sc->sbl.common.value, 0); 1809 1810 if (sc->sbl.common.type == IDB_TYPE_CCI) { 1811 switch (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) { 1812 case IDB_VALUE_PASS: 1813 status = STATUS_CMD_OK; 1814 break; 1815 case IDB_VALUE_FAIL: 1816 case IDB_VALUE_PERSISTENT: 1817 status = STATUS_CMD_FAILED; 1818 break; 1819 case IDB_VALUE_PHASE: 1820 default: /* XXX: gcc */ 1821 status = STATUS_WIRE_FAILED; 1822 break; 1823 } 1824 1825 sc->transfer_state = TSTATE_IDLE; 1826 sc->transfer_cb(sc, sc->transfer_priv, 1827 sc->transfer_datalen - sc->transfer_actlen, 1828 status); 1829 } 1830 } 1831 return; 1832 1833 case TSTATE_CBI_DCLEAR: 1834 if (err) { /* should not occur */ 1835 printf("%s: CBI bulk-%s stall clear failed, %s\n", 1836 device_xname(sc->sc_dev), 1837 (sc->transfer_dir == DIR_IN? "in":"out"), 1838 usbd_errstr(err)); 1839 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1840 } else { 1841 sc->transfer_state = TSTATE_IDLE; 1842 sc->transfer_cb(sc, sc->transfer_priv, 1843 sc->transfer_datalen, STATUS_CMD_FAILED); 1844 } 1845 return; 1846 1847 case TSTATE_CBI_SCLEAR: 1848 if (err) { /* should not occur */ 1849 printf("%s: CBI intr-in stall clear failed, %s\n", 1850 device_xname(sc->sc_dev), usbd_errstr(err)); 1851 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1852 } else { 1853 sc->transfer_state = TSTATE_IDLE; 1854 sc->transfer_cb(sc, sc->transfer_priv, 1855 sc->transfer_datalen, STATUS_CMD_FAILED); 1856 } 1857 return; 1858 1859 /***** CBI Reset *****/ 1860 case TSTATE_CBI_RESET1: 1861 if (err) 1862 printf("%s: CBI reset failed, %s\n", 1863 device_xname(sc->sc_dev), usbd_errstr(err)); 1864 1865 sc->transfer_state = TSTATE_CBI_RESET2; 1866 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1867 sc->transfer_xfer[XFER_CBI_RESET2]); 1868 1869 return; 1870 case TSTATE_CBI_RESET2: 1871 if (err) /* should not occur */ 1872 printf("%s: CBI bulk-in stall clear failed, %s\n", 1873 device_xname(sc->sc_dev), usbd_errstr(err)); 1874 /* no error recovery, otherwise we end up in a loop */ 1875 1876 sc->transfer_state = TSTATE_CBI_RESET3; 1877 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1878 sc->transfer_xfer[XFER_CBI_RESET3]); 1879 1880 return; 1881 case TSTATE_CBI_RESET3: 1882 if (err) /* should not occur */ 1883 printf("%s: CBI bulk-out stall clear failed, %s\n", 1884 device_xname(sc->sc_dev), usbd_errstr(err)); 1885 /* no error recovery, otherwise we end up in a loop */ 1886 1887 sc->transfer_state = TSTATE_IDLE; 1888 if (sc->transfer_priv) { 1889 sc->transfer_cb(sc, sc->transfer_priv, 1890 sc->transfer_datalen, 1891 sc->transfer_status); 1892 } 1893 1894 return; 1895 1896 1897 /***** Default *****/ 1898 default: 1899 panic("%s: Unknown state %d", 1900 device_xname(sc->sc_dev), sc->transfer_state); 1901 } 1902 } 1903 1904 usbd_status 1905 umass_bbb_get_max_lun(struct umass_softc *sc, uint8_t *maxlun) 1906 { 1907 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1908 usb_device_request_t req; 1909 usbd_status err; 1910 1911 *maxlun = 0; /* Default to 0. */ 1912 1913 DPRINTFM(UDMASS_BBB, "sc %p: Get Max Lun", sc, 0, 0, 0); 1914 1915 /* The Get Max Lun command is a class-specific request. */ 1916 req.bmRequestType = UT_READ_CLASS_INTERFACE; 1917 req.bRequest = UR_BBB_GET_MAX_LUN; 1918 USETW(req.wValue, 0); 1919 USETW(req.wIndex, sc->sc_ifaceno); 1920 USETW(req.wLength, 1); 1921 1922 err = usbd_do_request_flags(sc->sc_udev, &req, maxlun, 1923 USBD_SHORT_XFER_OK, 0, USBD_DEFAULT_TIMEOUT); 1924 switch (err) { 1925 case USBD_NORMAL_COMPLETION: 1926 DPRINTFM(UDMASS_BBB, "sc %p: Max Lun %d", sc, *maxlun , 0, 0); 1927 break; 1928 1929 case USBD_STALLED: 1930 /* 1931 * Device doesn't support Get Max Lun request. 1932 */ 1933 err = USBD_NORMAL_COMPLETION; 1934 DPRINTFM(UDMASS_BBB, "sc %p: Get Max Lun not supported", sc, 1935 0, 0, 0); 1936 break; 1937 1938 case USBD_SHORT_XFER: 1939 /* 1940 * XXX This must mean Get Max Lun is not supported, too! 1941 */ 1942 err = USBD_NORMAL_COMPLETION; 1943 DPRINTFM(UDMASS_BBB, "sc %p: Get Max Lun SHORT_XFER", sc, 0, 0, 1944 0); 1945 break; 1946 1947 default: 1948 printf("%s: Get Max Lun failed: %s\n", 1949 device_xname(sc->sc_dev), usbd_errstr(err)); 1950 /* XXX Should we port_reset the device? */ 1951 break; 1952 } 1953 1954 return err; 1955 } 1956 1957 1958 1959 1960 #ifdef UMASS_DEBUG 1961 Static void 1962 umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw) 1963 { 1964 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1965 int clen = cbw->bCDBLength; 1966 int dlen = UGETDW(cbw->dCBWDataTransferLength); 1967 uint8_t *c = cbw->CBWCDB; 1968 int tag = UGETDW(cbw->dCBWTag); 1969 int flags = cbw->bCBWFlags; 1970 1971 DPRINTFM(UDMASS_BBB, "sc %p: CBW %d: cmdlen=%d", sc, tag, clen, 0); 1972 DPRINTFM(UDMASS_BBB, " 0x%02x%02x%02x%02x...", c[0], c[1], c[2], c[3]); 1973 DPRINTFM(UDMASS_BBB, " 0x%02x%02x%02x%02x...", c[4], c[5], c[6], c[7]); 1974 DPRINTFM(UDMASS_BBB, " 0x%02x%02x...", c[8], c[9], 0, 0); 1975 DPRINTFM(UDMASS_BBB, " data = %d bytes, flags = %x", dlen, flags, 0, 1976 0); 1977 } 1978 1979 Static void 1980 umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw) 1981 { 1982 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1983 int sig = UGETDW(csw->dCSWSignature); 1984 int tag = UGETDW(csw->dCSWTag); 1985 int res = UGETDW(csw->dCSWDataResidue); 1986 int status = csw->bCSWStatus; 1987 1988 DPRINTFM(UDMASS_BBB, "sc %p: CSW %d: sig = 0x%08x, tag = %d", sc, tag, 1989 sig, tag); 1990 DPRINTFM(UDMASS_BBB, " res = %d, status = 0x%02x", res, status, 0, 0); 1991 } 1992 1993 Static void 1994 umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, int buflen, 1995 int printlen) 1996 { 1997 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1998 int i; 1999 2000 DPRINTFM(UDMASS_GEN, "sc %p: buffer %p", sc, buffer, 0, 0); 2001 for (i = 0; i < buflen && i < printlen;) { 2002 if (i + 3 < buflen && i + 3 < printlen) { 2003 DPRINTFM(UDMASS_GEN, " 0x%02x%02x%02x%02x", 2004 buffer[i], buffer[i + 1], 2005 buffer[i + 2], buffer[i + 3]); 2006 i += 4; 2007 } else if (i + 2 < buflen && i + 2 < printlen) { 2008 DPRINTFM(UDMASS_GEN, " 0x%02x%02x%02x", 2009 buffer[i], buffer[i + 1], buffer[i + 2], 0); 2010 i += 3; 2011 } else if (i + 1 < buflen && i + 2 < printlen) { 2012 DPRINTFM(UDMASS_GEN, " 0x%02x%02x", 2013 buffer[i], buffer[i + 1], 0, 0); 2014 i += 2; 2015 } else { 2016 DPRINTFM(UDMASS_GEN, " 0x%02x", buffer[i], 0, 0, 0); 2017 i += 1; 2018 } 2019 } 2020 } 2021 #endif 2022
Indexes created Tue Oct 14 21:09:58 GMT 2025