umass.c revision 1.149.2.6
1 /* $NetBSD: umass.c,v 1.149.2.6 2015/03/01 08:33:15 skrll 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/devclass_docs/usb_msc_overview_1.2.pdf 64 * http://www.usb.org/developers/devclass_docs/usbmassbulk_10.pdf 65 * http://www.usb.org/developers/devclass_docs/usb_msc_cbi_1.1.pdf 66 * http://www.usb.org/developers/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.149.2.6 2015/03/01 08:33:15 skrll 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 int umassdebug = 0; 162 163 SYSCTL_SETUP(sysctl_hw_umass_setup, "sysctl hw.umass setup") 164 { 165 int err; 166 const struct sysctlnode *rnode; 167 const struct sysctlnode *cnode; 168 169 err = sysctl_createv(clog, 0, NULL, &rnode, 170 CTLFLAG_PERMANENT, CTLTYPE_NODE, "umass", 171 SYSCTL_DESCR("umass global controls"), 172 NULL, 0, NULL, 0, CTL_HW, CTL_CREATE, CTL_EOL); 173 174 if (err) 175 goto fail; 176 177 /* control debugging printfs */ 178 err = sysctl_createv(clog, 0, &rnode, &cnode, 179 CTLFLAG_PERMANENT|CTLFLAG_READWRITE, CTLTYPE_INT, 180 "debug", SYSCTL_DESCR("Enable debugging output"), 181 NULL, 0, &umassdebug, sizeof(umassdebug), CTL_CREATE, CTL_EOL); 182 if (err) 183 goto fail; 184 185 return; 186 fail: 187 aprint_error("%s: sysctl_createv failed (err = %d)\n", __func__, err); 188 } 189 190 const char *states[TSTATE_STATES+1] = { 191 /* should be kept in sync with the list at transfer_state */ 192 "Idle", 193 "BBB CBW", 194 "BBB Data", 195 "BBB Data bulk-in/-out clear stall", 196 "BBB CSW, 1st attempt", 197 "BBB CSW bulk-in clear stall", 198 "BBB CSW, 2nd attempt", 199 "BBB Reset", 200 "BBB bulk-in clear stall", 201 "BBB bulk-out clear stall", 202 "CBI Command", 203 "CBI Data", 204 "CBI Status", 205 "CBI Data bulk-in/-out clear stall", 206 "CBI Status intr-in clear stall", 207 "CBI Reset", 208 "CBI bulk-in clear stall", 209 "CBI bulk-out clear stall", 210 NULL 211 }; 212 #endif 213 214 /* USB device probe/attach/detach functions */ 215 int umass_match(device_t, cfdata_t, void *); 216 void umass_attach(device_t, device_t, void *); 217 int umass_detach(device_t, int); 218 static void umass_childdet(device_t, device_t); 219 int umass_activate(device_t, enum devact); 220 extern struct cfdriver umass_cd; 221 CFATTACH_DECL2_NEW(umass, sizeof(struct umass_softc), umass_match, umass_attach, 222 umass_detach, umass_activate, NULL, umass_childdet); 223 224 Static void umass_disco(struct umass_softc *sc); 225 226 /* generic transfer functions */ 227 Static usbd_status umass_setup_transfer(struct umass_softc *, 228 usbd_pipe_handle, 229 void *, int, int, 230 usbd_xfer_handle); 231 Static usbd_status umass_setup_ctrl_transfer(struct umass_softc *, 232 usb_device_request_t *, 233 void *, int, int, 234 usbd_xfer_handle); 235 Static void umass_clear_endpoint_stall(struct umass_softc *, int, 236 usbd_xfer_handle); 237 #if 0 238 Static void umass_reset(struct umass_softc *, transfer_cb_f, void *); 239 #endif 240 241 /* Bulk-Only related functions */ 242 Static void umass_bbb_transfer(struct umass_softc *, int, void *, int, void *, 243 int, int, u_int, int, umass_callback, void *); 244 Static void umass_bbb_reset(struct umass_softc *, int); 245 Static void umass_bbb_state(usbd_xfer_handle, usbd_private_handle, usbd_status); 246 247 usbd_status umass_bbb_get_max_lun(struct umass_softc *, uint8_t *); 248 249 /* CBI related functions */ 250 Static void umass_cbi_transfer(struct umass_softc *, int, void *, int, void *, 251 int, int, u_int, int, umass_callback, void *); 252 Static void umass_cbi_reset(struct umass_softc *, int); 253 Static void umass_cbi_state(usbd_xfer_handle, usbd_private_handle, usbd_status); 254 255 Static int umass_cbi_adsc(struct umass_softc *, char *, int, int, usbd_xfer_handle); 256 257 const struct umass_wire_methods umass_bbb_methods = { 258 .wire_xfer = umass_bbb_transfer, 259 .wire_reset = umass_bbb_reset, 260 .wire_state = umass_bbb_state 261 }; 262 263 const struct umass_wire_methods umass_cbi_methods = { 264 .wire_xfer = umass_cbi_transfer, 265 .wire_reset = umass_cbi_reset, 266 .wire_state = umass_cbi_state 267 }; 268 269 #ifdef UMASS_DEBUG 270 /* General debugging functions */ 271 Static void umass_bbb_dump_cbw(struct umass_softc *sc, 272 umass_bbb_cbw_t *cbw); 273 Static void umass_bbb_dump_csw(struct umass_softc *sc, 274 umass_bbb_csw_t *csw); 275 Static void umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, 276 int buflen, int printlen); 277 #endif 278 279 280 /* 281 * USB device probe/attach/detach 282 */ 283 284 int 285 umass_match(device_t parent, cfdata_t match, void *aux) 286 { 287 struct usbif_attach_arg *uaa = aux; 288 const struct umass_quirk *quirk; 289 290 quirk = umass_lookup(uaa->vendor, uaa->product); 291 if (quirk != NULL && quirk->uq_match != UMASS_QUIRK_USE_DEFAULTMATCH) 292 return quirk->uq_match; 293 294 if (uaa->class != UICLASS_MASS) 295 return UMATCH_NONE; 296 297 switch (uaa->subclass) { 298 case UISUBCLASS_RBC: 299 case UISUBCLASS_SFF8020I: 300 case UISUBCLASS_QIC157: 301 case UISUBCLASS_UFI: 302 case UISUBCLASS_SFF8070I: 303 case UISUBCLASS_SCSI: 304 break; 305 default: 306 return UMATCH_IFACECLASS; 307 } 308 309 switch (uaa->proto) { 310 case UIPROTO_MASS_CBI_I: 311 case UIPROTO_MASS_CBI: 312 case UIPROTO_MASS_BBB_OLD: 313 case UIPROTO_MASS_BBB: 314 break; 315 default: 316 return UMATCH_IFACECLASS_IFACESUBCLASS; 317 } 318 319 return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO; 320 } 321 322 void 323 umass_attach(device_t parent, device_t self, void *aux) 324 { 325 struct umass_softc *sc = device_private(self); 326 struct usbif_attach_arg *uaa = aux; 327 const struct umass_quirk *quirk; 328 usb_interface_descriptor_t *id; 329 usb_endpoint_descriptor_t *ed; 330 const char *sWire, *sCommand; 331 char *devinfop; 332 usbd_status err; 333 int i, error; 334 335 sc->sc_dev = self; 336 337 aprint_naive("\n"); 338 aprint_normal("\n"); 339 340 mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_USB); 341 cv_init(&sc->sc_detach_cv, "umassdet"); 342 343 devinfop = usbd_devinfo_alloc(uaa->device, 0); 344 aprint_normal_dev(self, "%s\n", devinfop); 345 usbd_devinfo_free(devinfop); 346 347 sc->sc_udev = uaa->device; 348 sc->sc_iface = uaa->iface; 349 sc->sc_ifaceno = uaa->ifaceno; 350 351 quirk = umass_lookup(uaa->vendor, uaa->product); 352 if (quirk != NULL) { 353 sc->sc_wire = quirk->uq_wire; 354 sc->sc_cmd = quirk->uq_cmd; 355 sc->sc_quirks = quirk->uq_flags; 356 sc->sc_busquirks = quirk->uq_busquirks; 357 358 if (quirk->uq_fixup != NULL) 359 (*quirk->uq_fixup)(sc); 360 } else { 361 sc->sc_wire = UMASS_WPROTO_UNSPEC; 362 sc->sc_cmd = UMASS_CPROTO_UNSPEC; 363 sc->sc_quirks = 0; 364 sc->sc_busquirks = 0; 365 } 366 367 if (sc->sc_wire == UMASS_WPROTO_UNSPEC) { 368 switch (uaa->proto) { 369 case UIPROTO_MASS_CBI: 370 sc->sc_wire = UMASS_WPROTO_CBI; 371 break; 372 case UIPROTO_MASS_CBI_I: 373 sc->sc_wire = UMASS_WPROTO_CBI_I; 374 break; 375 case UIPROTO_MASS_BBB: 376 case UIPROTO_MASS_BBB_OLD: 377 sc->sc_wire = UMASS_WPROTO_BBB; 378 break; 379 default: 380 DPRINTF(UDMASS_GEN, 381 ("%s: Unsupported wire protocol %u\n", 382 device_xname(sc->sc_dev), 383 uaa->proto)); 384 return; 385 } 386 } 387 388 if (sc->sc_cmd == UMASS_CPROTO_UNSPEC) { 389 switch (uaa->subclass) { 390 case UISUBCLASS_SCSI: 391 sc->sc_cmd = UMASS_CPROTO_SCSI; 392 break; 393 case UISUBCLASS_UFI: 394 sc->sc_cmd = UMASS_CPROTO_UFI; 395 break; 396 case UISUBCLASS_SFF8020I: 397 case UISUBCLASS_SFF8070I: 398 case UISUBCLASS_QIC157: 399 sc->sc_cmd = UMASS_CPROTO_ATAPI; 400 break; 401 case UISUBCLASS_RBC: 402 sc->sc_cmd = UMASS_CPROTO_RBC; 403 break; 404 default: 405 DPRINTF(UDMASS_GEN, 406 ("%s: Unsupported command protocol %u\n", 407 device_xname(sc->sc_dev), 408 uaa->subclass)); 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 DPRINTF(UDMASS_CBI, ("%s: intr size is %d\n", 492 device_xname(sc->sc_dev), 493 UGETW(ed->wMaxPacketSize))); 494 } 495 #endif 496 } 497 } 498 499 /* check whether we found all the endpoints we need */ 500 if (!sc->sc_epaddr[UMASS_BULKIN] || !sc->sc_epaddr[UMASS_BULKOUT] || 501 (sc->sc_wire == UMASS_WPROTO_CBI_I && 502 !sc->sc_epaddr[UMASS_INTRIN])) { 503 aprint_error_dev(self, "endpoint not found %u/%u/%u\n", 504 sc->sc_epaddr[UMASS_BULKIN], 505 sc->sc_epaddr[UMASS_BULKOUT], 506 sc->sc_epaddr[UMASS_INTRIN]); 507 return; 508 } 509 510 /* 511 * Get the maximum LUN supported by the device. 512 */ 513 if (sc->sc_wire == UMASS_WPROTO_BBB && 514 (sc->sc_quirks & UMASS_QUIRK_NOGETMAXLUN) == 0) { 515 err = umass_bbb_get_max_lun(sc, &sc->maxlun); 516 if (err) { 517 aprint_error_dev(self, "unable to get Max Lun: %s\n", 518 usbd_errstr(err)); 519 return; 520 } 521 if (sc->maxlun > 0) 522 sc->sc_busquirks |= PQUIRK_FORCELUNS; 523 } else { 524 sc->maxlun = 0; 525 } 526 527 /* Open the bulk-in and -out pipe */ 528 DPRINTF(UDMASS_USB, ("%s: opening iface %p epaddr %d for BULKOUT\n", 529 device_xname(sc->sc_dev), sc->sc_iface, 530 sc->sc_epaddr[UMASS_BULKOUT])); 531 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKOUT], 532 USBD_EXCLUSIVE_USE, 533 &sc->sc_pipe[UMASS_BULKOUT]); 534 if (err) { 535 aprint_error_dev(self, "cannot open %u-out pipe (bulk)\n", 536 sc->sc_epaddr[UMASS_BULKOUT]); 537 umass_disco(sc); 538 return; 539 } 540 DPRINTF(UDMASS_USB, ("%s: opening iface %p epaddr %d for BULKIN\n", 541 device_xname(sc->sc_dev), sc->sc_iface, 542 sc->sc_epaddr[UMASS_BULKIN])); 543 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN], 544 USBD_EXCLUSIVE_USE, &sc->sc_pipe[UMASS_BULKIN]); 545 if (err) { 546 aprint_error_dev(self, "could not open %u-in pipe (bulk)\n", 547 sc->sc_epaddr[UMASS_BULKIN]); 548 umass_disco(sc); 549 return; 550 } 551 /* 552 * Open the intr-in pipe if the protocol is CBI with CCI. 553 * Note: early versions of the Zip drive do have an interrupt pipe, but 554 * this pipe is unused 555 * 556 * We do not open the interrupt pipe as an interrupt pipe, but as a 557 * normal bulk endpoint. We send an IN transfer down the wire at the 558 * appropriate time, because we know exactly when to expect data on 559 * that endpoint. This saves bandwidth, but more important, makes the 560 * code for handling the data on that endpoint simpler. No data 561 * arriving concurrently. 562 */ 563 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 564 DPRINTF(UDMASS_USB, ("%s: opening iface %p epaddr %d for INTRIN\n", 565 device_xname(sc->sc_dev), sc->sc_iface, 566 sc->sc_epaddr[UMASS_INTRIN])); 567 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN], 568 USBD_EXCLUSIVE_USE, &sc->sc_pipe[UMASS_INTRIN]); 569 if (err) { 570 aprint_error_dev(self, "couldn't open %u-in (intr)\n", 571 sc->sc_epaddr[UMASS_INTRIN]); 572 umass_disco(sc); 573 return; 574 } 575 } 576 577 /* initialisation of generic part */ 578 sc->transfer_state = TSTATE_IDLE; 579 580 /* request a sufficient number of xfer handles */ 581 for (i = 0; i < XFER_NR; i++) { 582 sc->transfer_xfer[i] = usbd_alloc_xfer(uaa->device); 583 if (sc->transfer_xfer[i] == NULL) { 584 aprint_error_dev(self, "Out of memory\n"); 585 umass_disco(sc); 586 return; 587 } 588 } 589 /* 590 * Allocate buffer for data transfer (it's huge), command and 591 * status data here as auto allocation cannot happen in interrupt 592 * context 593 */ 594 switch (sc->sc_wire) { 595 case UMASS_WPROTO_BBB: 596 sc->data_buffer = usbd_alloc_buffer( 597 sc->transfer_xfer[XFER_BBB_DATA], 598 UMASS_MAX_TRANSFER_SIZE); 599 sc->cmd_buffer = usbd_alloc_buffer( 600 sc->transfer_xfer[XFER_BBB_CBW], 601 UMASS_BBB_CBW_SIZE); 602 sc->s1_buffer = usbd_alloc_buffer( 603 sc->transfer_xfer[XFER_BBB_CSW1], 604 UMASS_BBB_CSW_SIZE); 605 sc->s2_buffer = usbd_alloc_buffer( 606 sc->transfer_xfer[XFER_BBB_CSW2], 607 UMASS_BBB_CSW_SIZE); 608 break; 609 case UMASS_WPROTO_CBI: 610 case UMASS_WPROTO_CBI_I: 611 sc->data_buffer = usbd_alloc_buffer( 612 sc->transfer_xfer[XFER_CBI_DATA], 613 UMASS_MAX_TRANSFER_SIZE); 614 sc->cmd_buffer = usbd_alloc_buffer( 615 sc->transfer_xfer[XFER_CBI_CB], 616 sizeof(sc->cbl)); 617 sc->s1_buffer = usbd_alloc_buffer( 618 sc->transfer_xfer[XFER_CBI_STATUS], 619 sizeof(sc->sbl)); 620 sc->s2_buffer = usbd_alloc_buffer( 621 sc->transfer_xfer[XFER_CBI_RESET1], 622 sizeof(sc->cbl)); 623 break; 624 default: 625 break; 626 } 627 628 if (sc->data_buffer == NULL || sc->cmd_buffer == NULL 629 || sc->s1_buffer == NULL || sc->s2_buffer == NULL) { 630 /* 631 * partially preallocated buffers are freed with 632 * the xfer structures 633 */ 634 aprint_error_dev(self, "no buffer memory\n"); 635 umass_disco(sc); 636 return; 637 } 638 639 /* Initialise the wire protocol specific methods */ 640 switch (sc->sc_wire) { 641 case UMASS_WPROTO_BBB: 642 sc->sc_methods = &umass_bbb_methods; 643 break; 644 case UMASS_WPROTO_CBI: 645 case UMASS_WPROTO_CBI_I: 646 sc->sc_methods = &umass_cbi_methods; 647 break; 648 default: 649 umass_disco(sc); 650 return; 651 } 652 653 error = 0; 654 switch (sc->sc_cmd) { 655 case UMASS_CPROTO_RBC: 656 case UMASS_CPROTO_SCSI: 657 #if NSCSIBUS > 0 658 error = umass_scsi_attach(sc); 659 #else 660 aprint_error_dev(self, "scsibus not configured\n"); 661 #endif 662 break; 663 664 case UMASS_CPROTO_UFI: 665 case UMASS_CPROTO_ATAPI: 666 #if NATAPIBUS > 0 667 error = umass_atapi_attach(sc); 668 #else 669 aprint_error_dev(self, "atapibus not configured\n"); 670 #endif 671 break; 672 673 case UMASS_CPROTO_ISD_ATA: 674 #if NWD > 0 675 error = umass_isdata_attach(sc); 676 #else 677 aprint_error_dev(self, "isdata not configured\n"); 678 #endif 679 break; 680 681 default: 682 aprint_error_dev(self, "command protocol=0x%x not supported\n", 683 sc->sc_cmd); 684 umass_disco(sc); 685 return; 686 } 687 if (error) { 688 aprint_error_dev(self, "bus attach failed\n"); 689 umass_disco(sc); 690 return; 691 } 692 693 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 694 sc->sc_dev); 695 696 if (!pmf_device_register(self, NULL, NULL)) 697 aprint_error_dev(self, "couldn't establish power handler\n"); 698 699 DPRINTF(UDMASS_GEN, ("%s: Attach finished\n", device_xname(sc->sc_dev))); 700 701 return; 702 } 703 704 static void 705 umass_childdet(device_t self, device_t child) 706 { 707 struct umass_softc *sc = device_private(self); 708 709 KASSERTMSG(child == sc->bus->sc_child, 710 "assertion child == sc->bus->sc_child failed\n"); 711 sc->bus->sc_child = NULL; 712 } 713 714 int 715 umass_detach(device_t self, int flags) 716 { 717 struct umass_softc *sc = device_private(self); 718 struct umassbus_softc *scbus; 719 int rv = 0, i; 720 721 DPRINTF(UDMASS_USB, ("%s: detached\n", device_xname(sc->sc_dev))); 722 723 pmf_device_deregister(self); 724 725 /* Abort the pipes to wake up any waiting processes. */ 726 for (i = 0 ; i < UMASS_NEP ; i++) { 727 if (sc->sc_pipe[i] != NULL) 728 usbd_abort_pipe(sc->sc_pipe[i]); 729 } 730 731 /* Do we really need reference counting? Perhaps in ioctl() */ 732 mutex_enter(&sc->sc_lock); 733 if (--sc->sc_refcnt >= 0) { 734 #ifdef DIAGNOSTIC 735 aprint_normal_dev(self, "waiting for refcnt\n"); 736 #endif 737 /* Wait for processes to go away. */ 738 usb_detach_wait(sc->sc_dev, &sc->sc_detach_cv, &sc->sc_lock); 739 } 740 mutex_exit(&sc->sc_lock); 741 742 scbus = sc->bus; 743 if (scbus != NULL) { 744 if (scbus->sc_child != NULL) 745 rv = config_detach(scbus->sc_child, flags); 746 free(scbus, M_DEVBUF); 747 sc->bus = NULL; 748 } 749 750 if (rv != 0) 751 return rv; 752 753 umass_disco(sc); 754 755 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 756 sc->sc_dev); 757 758 mutex_destroy(&sc->sc_lock); 759 cv_destroy(&sc->sc_detach_cv); 760 761 return rv; 762 } 763 764 int 765 umass_activate(device_t dev, enum devact act) 766 { 767 struct umass_softc *sc = device_private(dev); 768 769 DPRINTF(UDMASS_USB, ("%s: umass_activate: %d\n", 770 device_xname(dev), act)); 771 772 switch (act) { 773 case DVACT_DEACTIVATE: 774 sc->sc_dying = 1; 775 return 0; 776 default: 777 return EOPNOTSUPP; 778 } 779 } 780 781 Static void 782 umass_disco(struct umass_softc *sc) 783 { 784 int i; 785 786 DPRINTF(UDMASS_GEN, ("umass_disco\n")); 787 788 /* Remove all the pipes. */ 789 for (i = 0 ; i < UMASS_NEP ; i++) { 790 if (sc->sc_pipe[i] != NULL) { 791 usbd_abort_pipe(sc->sc_pipe[i]); 792 usbd_close_pipe(sc->sc_pipe[i]); 793 sc->sc_pipe[i] = NULL; 794 } 795 } 796 797 /* Some xfers may be queued in the default pipe */ 798 usbd_abort_default_pipe(sc->sc_udev); 799 800 /* Free the xfers. */ 801 for (i = 0; i < XFER_NR; i++) 802 if (sc->transfer_xfer[i] != NULL) { 803 usbd_free_xfer(sc->transfer_xfer[i]); 804 sc->transfer_xfer[i] = NULL; 805 } 806 } 807 808 /* 809 * Generic functions to handle transfers 810 */ 811 812 Static usbd_status 813 umass_setup_transfer(struct umass_softc *sc, usbd_pipe_handle pipe, 814 void *buffer, int buflen, int flags, 815 usbd_xfer_handle xfer) 816 { 817 usbd_status err; 818 819 USBHIST_FUNC(); USBHIST_CALLED(umassdebug); 820 821 if (sc->sc_dying) 822 return USBD_IOERROR; 823 824 /* Initialiase a USB transfer and then schedule it */ 825 826 usbd_setup_xfer(xfer, pipe, (void *)sc, buffer, buflen, 827 flags, sc->timeout, sc->sc_methods->wire_state); 828 829 USBHIST_LOG(umassdebug, "xfer %p, flags %d", xfer, flags, 0, 0); 830 831 err = usbd_transfer(xfer); 832 DPRINTF(UDMASS_XFER,("%s: start xfer buffer=%p buflen=%d flags=0x%x " 833 "timeout=%d\n", device_xname(sc->sc_dev), 834 buffer, buflen, flags, sc->timeout)); 835 if (err && err != USBD_IN_PROGRESS) { 836 DPRINTF(UDMASS_BBB, ("%s: failed to setup transfer, %s\n", 837 device_xname(sc->sc_dev), usbd_errstr(err))); 838 return err; 839 } 840 841 return USBD_NORMAL_COMPLETION; 842 } 843 844 845 Static usbd_status 846 umass_setup_ctrl_transfer(struct umass_softc *sc, usb_device_request_t *req, 847 void *buffer, int buflen, int flags, usbd_xfer_handle xfer) 848 { 849 usbd_status err; 850 851 if (sc->sc_dying) 852 return USBD_IOERROR; 853 854 /* Initialiase a USB control transfer and then schedule it */ 855 856 usbd_setup_default_xfer(xfer, sc->sc_udev, (void *) sc, sc->timeout, 857 req, buffer, buflen, flags, sc->sc_methods->wire_state); 858 859 err = usbd_transfer(xfer); 860 if (err && err != USBD_IN_PROGRESS) { 861 DPRINTF(UDMASS_BBB, ("%s: failed to setup ctrl transfer, %s\n", 862 device_xname(sc->sc_dev), usbd_errstr(err))); 863 864 /* do not reset, as this would make us loop */ 865 return err; 866 } 867 868 return USBD_NORMAL_COMPLETION; 869 } 870 871 Static void 872 umass_clear_endpoint_stall(struct umass_softc *sc, int endpt, 873 usbd_xfer_handle xfer) 874 { 875 if (sc->sc_dying) 876 return; 877 878 DPRINTF(UDMASS_BBB, ("%s: Clear endpoint 0x%02x stall\n", 879 device_xname(sc->sc_dev), sc->sc_epaddr[endpt])); 880 881 usbd_clear_endpoint_toggle(sc->sc_pipe[endpt]); 882 883 sc->sc_req.bmRequestType = UT_WRITE_ENDPOINT; 884 sc->sc_req.bRequest = UR_CLEAR_FEATURE; 885 USETW(sc->sc_req.wValue, UF_ENDPOINT_HALT); 886 USETW(sc->sc_req.wIndex, sc->sc_epaddr[endpt]); 887 USETW(sc->sc_req.wLength, 0); 888 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, xfer); 889 } 890 891 #if 0 892 Static void 893 umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv) 894 { 895 sc->transfer_cb = cb; 896 sc->transfer_priv = priv; 897 898 /* The reset is a forced reset, so no error (yet) */ 899 sc->reset(sc, STATUS_CMD_OK); 900 } 901 #endif 902 903 /* 904 * Bulk protocol specific functions 905 */ 906 907 Static void 908 umass_bbb_reset(struct umass_softc *sc, int status) 909 { 910 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 911 "sc->sc_wire == 0x%02x wrong for umass_bbb_reset\n", 912 sc->sc_wire); 913 914 if (sc->sc_dying) 915 return; 916 917 /* 918 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class) 919 * 920 * For Reset Recovery the host shall issue in the following order: 921 * a) a Bulk-Only Mass Storage Reset 922 * b) a Clear Feature HALT to the Bulk-In endpoint 923 * c) a Clear Feature HALT to the Bulk-Out endpoint 924 * 925 * This is done in 3 steps, states: 926 * TSTATE_BBB_RESET1 927 * TSTATE_BBB_RESET2 928 * TSTATE_BBB_RESET3 929 * 930 * If the reset doesn't succeed, the device should be port reset. 931 */ 932 933 DPRINTF(UDMASS_BBB, ("%s: Bulk Reset\n", 934 device_xname(sc->sc_dev))); 935 936 sc->transfer_state = TSTATE_BBB_RESET1; 937 sc->transfer_status = status; 938 939 /* reset is a class specific interface write */ 940 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 941 sc->sc_req.bRequest = UR_BBB_RESET; 942 USETW(sc->sc_req.wValue, 0); 943 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 944 USETW(sc->sc_req.wLength, 0); 945 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, 946 sc->transfer_xfer[XFER_BBB_RESET1]); 947 } 948 949 Static void 950 umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, 951 void *data, int datalen, int dir, u_int timeout, 952 int flags, umass_callback cb, void *priv) 953 { 954 static int dCBWtag = 42; /* unique for CBW of transfer */ 955 956 DPRINTF(UDMASS_BBB,("%s: umass_bbb_transfer cmd=0x%02x\n", 957 device_xname(sc->sc_dev), *(u_char *)cmd)); 958 959 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 960 "sc->sc_wire == 0x%02x wrong for umass_bbb_transfer\n", 961 sc->sc_wire); 962 963 if (sc->sc_dying) 964 return; 965 966 /* Be a little generous. */ 967 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 968 969 /* 970 * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly 971 * a data phase of datalen bytes from/to the device and finally a 972 * csw read phase. 973 * If the data direction was inbound a maximum of datalen bytes 974 * is stored in the buffer pointed to by data. 975 * 976 * umass_bbb_transfer initialises the transfer and lets the state 977 * machine in umass_bbb_state handle the completion. It uses the 978 * following states: 979 * TSTATE_BBB_COMMAND 980 * -> TSTATE_BBB_DATA 981 * -> TSTATE_BBB_STATUS 982 * -> TSTATE_BBB_STATUS2 983 * -> TSTATE_BBB_IDLE 984 * 985 * An error in any of those states will invoke 986 * umass_bbb_reset. 987 */ 988 989 /* check the given arguments */ 990 KASSERTMSG(datalen == 0 || data != NULL, 991 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 992 KASSERTMSG(cmdlen <= CBWCDBLENGTH, 993 "%s: cmdlen exceeds CDB length in CBW (%d > %d)", 994 device_xname(sc->sc_dev), cmdlen, CBWCDBLENGTH); 995 KASSERTMSG(dir == DIR_NONE || datalen > 0, 996 "%s: datalen == 0 while direction is not NONE\n", 997 device_xname(sc->sc_dev)); 998 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 999 "%s: direction is NONE while datalen is not zero\n", 1000 device_xname(sc->sc_dev)); 1001 /* CTASSERT */ 1002 KASSERTMSG(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE, 1003 "%s: CBW struct does not have the right size (%zu vs. %u)\n", 1004 device_xname(sc->sc_dev), 1005 sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE); 1006 /* CTASSERT */ 1007 KASSERTMSG(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE, 1008 "%s: CSW struct does not have the right size (%zu vs. %u)\n", 1009 device_xname(sc->sc_dev), 1010 sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE); 1011 1012 /* 1013 * Determine the direction of the data transfer and the length. 1014 * 1015 * dCBWDataTransferLength (datalen) : 1016 * This field indicates the number of bytes of data that the host 1017 * intends to transfer on the IN or OUT Bulk endpoint(as indicated by 1018 * the Direction bit) during the execution of this command. If this 1019 * field is set to 0, the device will expect that no data will be 1020 * transferred IN or OUT during this command, regardless of the value 1021 * of the Direction bit defined in dCBWFlags. 1022 * 1023 * dCBWFlags (dir) : 1024 * The bits of the Flags field are defined as follows: 1025 * Bits 0-6 reserved 1026 * Bit 7 Direction - this bit shall be ignored if the 1027 * dCBWDataTransferLength field is zero. 1028 * 0 = data Out from host to device 1029 * 1 = data In from device to host 1030 */ 1031 1032 /* Fill in the Command Block Wrapper */ 1033 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE); 1034 USETDW(sc->cbw.dCBWTag, dCBWtag); 1035 dCBWtag++; /* cannot be done in macro (it will be done 4 times) */ 1036 USETDW(sc->cbw.dCBWDataTransferLength, datalen); 1037 /* DIR_NONE is treated as DIR_OUT (0x00) */ 1038 sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT); 1039 sc->cbw.bCBWLUN = lun; 1040 sc->cbw.bCDBLength = cmdlen; 1041 memcpy(sc->cbw.CBWCDB, cmd, cmdlen); 1042 1043 DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw)); 1044 1045 /* store the details for the data transfer phase */ 1046 sc->transfer_dir = dir; 1047 sc->transfer_data = data; 1048 sc->transfer_datalen = datalen; 1049 sc->transfer_actlen = 0; 1050 sc->transfer_cb = cb; 1051 sc->transfer_priv = priv; 1052 sc->transfer_status = STATUS_CMD_OK; 1053 1054 /* move from idle to the command state */ 1055 sc->transfer_state = TSTATE_BBB_COMMAND; 1056 1057 /* Send the CBW from host to device via bulk-out endpoint. */ 1058 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1059 &sc->cbw, UMASS_BBB_CBW_SIZE, flags, 1060 sc->transfer_xfer[XFER_BBB_CBW])) { 1061 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1062 } 1063 } 1064 1065 1066 Static void 1067 umass_bbb_state(usbd_xfer_handle xfer, usbd_private_handle priv, 1068 usbd_status err) 1069 { 1070 struct umass_softc *sc = (struct umass_softc *) priv; 1071 usbd_xfer_handle next_xfer; 1072 int residue; 1073 1074 USBHIST_FUNC(); USBHIST_CALLED(umassdebug); 1075 1076 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1077 "sc->sc_wire == 0x%02x wrong for umass_bbb_state\n", 1078 sc->sc_wire); 1079 1080 if (sc->sc_dying) 1081 return; 1082 1083 /* 1084 * State handling for BBB transfers. 1085 * 1086 * The subroutine is rather long. It steps through the states given in 1087 * Annex A of the Bulk-Only specification. 1088 * Each state first does the error handling of the previous transfer 1089 * and then prepares the next transfer. 1090 * Each transfer is done asynchroneously so after the request/transfer 1091 * has been submitted you will find a 'return;'. 1092 */ 1093 1094 DPRINTF(UDMASS_BBB, ("%s: Handling BBB state %d (%s), xfer=%p, %s\n", 1095 device_xname(sc->sc_dev), sc->transfer_state, 1096 states[sc->transfer_state], xfer, usbd_errstr(err))); 1097 1098 USBHIST_LOG(umassdebug, "xfer %p, transfer_state %d dir %d", xfer, 1099 sc->transfer_state, sc->transfer_dir, 0); 1100 1101 switch (sc->transfer_state) { 1102 1103 /***** Bulk Transfer *****/ 1104 case TSTATE_BBB_COMMAND: 1105 /* Command transport phase, error handling */ 1106 if (err) { 1107 DPRINTF(UDMASS_BBB, ("%s: failed to send CBW\n", 1108 device_xname(sc->sc_dev))); 1109 /* If the device detects that the CBW is invalid, then 1110 * the device may STALL both bulk endpoints and require 1111 * a Bulk-Reset 1112 */ 1113 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1114 return; 1115 } 1116 1117 /* Data transport phase, setup transfer */ 1118 sc->transfer_state = TSTATE_BBB_DATA; 1119 if (sc->transfer_dir == DIR_IN) { 1120 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1121 sc->data_buffer, sc->transfer_datalen, 1122 USBD_SHORT_XFER_OK, 1123 sc->transfer_xfer[XFER_BBB_DATA])) 1124 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1125 1126 return; 1127 } else if (sc->transfer_dir == DIR_OUT) { 1128 memcpy(sc->data_buffer, sc->transfer_data, 1129 sc->transfer_datalen); 1130 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1131 sc->data_buffer, sc->transfer_datalen, 1132 0,/* fixed length transfer */ 1133 sc->transfer_xfer[XFER_BBB_DATA])) 1134 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1135 1136 return; 1137 } else { 1138 DPRINTF(UDMASS_BBB, ("%s: no data phase\n", 1139 device_xname(sc->sc_dev))); 1140 } 1141 1142 /* FALLTHROUGH if no data phase, err == 0 */ 1143 case TSTATE_BBB_DATA: 1144 /* Command transport phase error handling (ignored if no data 1145 * phase (fallthrough from previous state)) */ 1146 if (sc->transfer_dir != DIR_NONE) { 1147 /* retrieve the length of the transfer that was done */ 1148 usbd_get_xfer_status(xfer, NULL, NULL, 1149 &sc->transfer_actlen, NULL); 1150 DPRINTF(UDMASS_BBB, ("%s: BBB_DATA actlen=%d\n", 1151 device_xname(sc->sc_dev), sc->transfer_actlen)); 1152 1153 if (err) { 1154 DPRINTF(UDMASS_BBB, ("%s: Data-%s %d failed, " 1155 "%s\n", device_xname(sc->sc_dev), 1156 (sc->transfer_dir == DIR_IN?"in":"out"), 1157 sc->transfer_datalen,usbd_errstr(err))); 1158 1159 if (err == USBD_STALLED) { 1160 sc->transfer_state = TSTATE_BBB_DCLEAR; 1161 umass_clear_endpoint_stall(sc, 1162 (sc->transfer_dir == DIR_IN? 1163 UMASS_BULKIN:UMASS_BULKOUT), 1164 sc->transfer_xfer[XFER_BBB_DCLEAR]); 1165 } else { 1166 /* Unless the error is a pipe stall the 1167 * error is fatal. 1168 */ 1169 umass_bbb_reset(sc,STATUS_WIRE_FAILED); 1170 } 1171 return; 1172 } 1173 } 1174 1175 /* FALLTHROUGH, err == 0 (no data phase or successful) */ 1176 case TSTATE_BBB_DCLEAR: /* stall clear after data phase */ 1177 if (sc->transfer_dir == DIR_IN) 1178 memcpy(sc->transfer_data, sc->data_buffer, 1179 sc->transfer_actlen); 1180 1181 DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN) 1182 umass_dump_buffer(sc, sc->transfer_data, 1183 sc->transfer_datalen, 48)); 1184 1185 /* FALLTHROUGH, err == 0 (no data phase or successful) */ 1186 case TSTATE_BBB_SCLEAR: /* stall clear after status phase */ 1187 /* Reading of CSW after bulk stall condition in data phase 1188 * (TSTATE_BBB_DATA2) or bulk-in stall condition after 1189 * reading CSW (TSTATE_BBB_SCLEAR). 1190 * In the case of no data phase or successful data phase, 1191 * err == 0 and the following if block is passed. 1192 */ 1193 if (err) { /* should not occur */ 1194 printf("%s: BBB bulk-%s stall clear failed, %s\n", 1195 device_xname(sc->sc_dev), 1196 (sc->transfer_dir == DIR_IN? "in":"out"), 1197 usbd_errstr(err)); 1198 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1199 return; 1200 } 1201 1202 /* Status transport phase, setup transfer */ 1203 if (sc->transfer_state == TSTATE_BBB_COMMAND || 1204 sc->transfer_state == TSTATE_BBB_DATA || 1205 sc->transfer_state == TSTATE_BBB_DCLEAR) { 1206 /* After no data phase, successful data phase and 1207 * after clearing bulk-in/-out stall condition 1208 */ 1209 sc->transfer_state = TSTATE_BBB_STATUS1; 1210 next_xfer = sc->transfer_xfer[XFER_BBB_CSW1]; 1211 } else { 1212 /* After first attempt of fetching CSW */ 1213 sc->transfer_state = TSTATE_BBB_STATUS2; 1214 next_xfer = sc->transfer_xfer[XFER_BBB_CSW2]; 1215 } 1216 1217 /* Read the Command Status Wrapper via bulk-in endpoint. */ 1218 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1219 &sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) { 1220 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1221 return; 1222 } 1223 1224 return; 1225 case TSTATE_BBB_STATUS1: /* first attempt */ 1226 case TSTATE_BBB_STATUS2: /* second attempt */ 1227 /* Status transfer, error handling */ 1228 if (err) { 1229 DPRINTF(UDMASS_BBB, ("%s: Failed to read CSW, %s%s\n", 1230 device_xname(sc->sc_dev), usbd_errstr(err), 1231 (sc->transfer_state == TSTATE_BBB_STATUS1? 1232 ", retrying":""))); 1233 1234 /* If this was the first attempt at fetching the CSW 1235 * retry it, otherwise fail. 1236 */ 1237 if (sc->transfer_state == TSTATE_BBB_STATUS1) { 1238 sc->transfer_state = TSTATE_BBB_SCLEAR; 1239 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1240 sc->transfer_xfer[XFER_BBB_SCLEAR]); 1241 return; 1242 } else { 1243 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1244 return; 1245 } 1246 } 1247 1248 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw)); 1249 1250 #ifdef UMASS_DEBUG 1251 residue = UGETDW(sc->csw.dCSWDataResidue); 1252 if (residue != sc->transfer_datalen - sc->transfer_actlen) 1253 printf("%s: dCSWDataResidue=%d req=%d act=%d\n", 1254 device_xname(sc->sc_dev), residue, 1255 sc->transfer_datalen, sc->transfer_actlen); 1256 #endif 1257 residue = sc->transfer_datalen - sc->transfer_actlen; 1258 1259 /* Translate weird command-status signatures. */ 1260 if ((sc->sc_quirks & UMASS_QUIRK_WRONG_CSWSIG) && 1261 UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1) 1262 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE); 1263 1264 /* Translate invalid command-status tags */ 1265 if (sc->sc_quirks & UMASS_QUIRK_WRONG_CSWTAG) 1266 USETDW(sc->csw.dCSWTag, UGETDW(sc->cbw.dCBWTag)); 1267 1268 /* Check CSW and handle any error */ 1269 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) { 1270 /* Invalid CSW: Wrong signature or wrong tag might 1271 * indicate that the device is confused -> reset it. 1272 */ 1273 printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n", 1274 device_xname(sc->sc_dev), 1275 UGETDW(sc->csw.dCSWSignature), 1276 CSWSIGNATURE); 1277 1278 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1279 return; 1280 } else if (UGETDW(sc->csw.dCSWTag) 1281 != UGETDW(sc->cbw.dCBWTag)) { 1282 printf("%s: Invalid CSW: tag %d should be %d\n", 1283 device_xname(sc->sc_dev), 1284 UGETDW(sc->csw.dCSWTag), 1285 UGETDW(sc->cbw.dCBWTag)); 1286 1287 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1288 return; 1289 1290 /* CSW is valid here */ 1291 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) { 1292 printf("%s: Invalid CSW: status %d > %d\n", 1293 device_xname(sc->sc_dev), 1294 sc->csw.bCSWStatus, 1295 CSWSTATUS_PHASE); 1296 1297 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1298 return; 1299 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) { 1300 printf("%s: Phase Error, residue = %d\n", 1301 device_xname(sc->sc_dev), residue); 1302 1303 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1304 return; 1305 1306 } else if (sc->transfer_actlen > sc->transfer_datalen) { 1307 /* Buffer overrun! Don't let this go by unnoticed */ 1308 panic("%s: transferred %s %d bytes instead of %d bytes", 1309 device_xname(sc->sc_dev), 1310 sc->transfer_dir == DIR_IN ? "IN" : "OUT", 1311 sc->transfer_actlen, sc->transfer_datalen); 1312 #if 0 1313 } else if (sc->transfer_datalen - sc->transfer_actlen 1314 != residue) { 1315 DPRINTF(UDMASS_BBB, ("%s: actlen=%d != residue=%d\n", 1316 device_xname(sc->sc_dev), 1317 sc->transfer_datalen - sc->transfer_actlen, 1318 residue)); 1319 1320 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1321 return; 1322 #endif 1323 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) { 1324 DPRINTF(UDMASS_BBB, ("%s: Command Failed, res = %d\n", 1325 device_xname(sc->sc_dev), residue)); 1326 1327 /* SCSI command failed but transfer was succesful */ 1328 sc->transfer_state = TSTATE_IDLE; 1329 sc->transfer_cb(sc, sc->transfer_priv, residue, 1330 STATUS_CMD_FAILED); 1331 1332 return; 1333 1334 } else { /* success */ 1335 sc->transfer_state = TSTATE_IDLE; 1336 sc->transfer_cb(sc, sc->transfer_priv, residue, 1337 STATUS_CMD_OK); 1338 1339 return; 1340 } 1341 1342 /***** Bulk Reset *****/ 1343 case TSTATE_BBB_RESET1: 1344 if (err) 1345 printf("%s: BBB reset failed, %s\n", 1346 device_xname(sc->sc_dev), usbd_errstr(err)); 1347 1348 sc->transfer_state = TSTATE_BBB_RESET2; 1349 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1350 sc->transfer_xfer[XFER_BBB_RESET2]); 1351 1352 return; 1353 case TSTATE_BBB_RESET2: 1354 if (err) /* should not occur */ 1355 printf("%s: BBB bulk-in clear stall failed, %s\n", 1356 device_xname(sc->sc_dev), usbd_errstr(err)); 1357 /* no error recovery, otherwise we end up in a loop */ 1358 1359 sc->transfer_state = TSTATE_BBB_RESET3; 1360 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1361 sc->transfer_xfer[XFER_BBB_RESET3]); 1362 1363 return; 1364 case TSTATE_BBB_RESET3: 1365 if (err) /* should not occur */ 1366 printf("%s: BBB bulk-out clear stall failed, %s\n", 1367 device_xname(sc->sc_dev), usbd_errstr(err)); 1368 /* no error recovery, otherwise we end up in a loop */ 1369 1370 sc->transfer_state = TSTATE_IDLE; 1371 if (sc->transfer_priv) { 1372 sc->transfer_cb(sc, sc->transfer_priv, 1373 sc->transfer_datalen, 1374 sc->transfer_status); 1375 } 1376 1377 return; 1378 1379 /***** Default *****/ 1380 default: 1381 panic("%s: Unknown state %d", 1382 device_xname(sc->sc_dev), sc->transfer_state); 1383 } 1384 } 1385 1386 /* 1387 * Command/Bulk/Interrupt (CBI) specific functions 1388 */ 1389 1390 Static int 1391 umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, int flags, 1392 usbd_xfer_handle xfer) 1393 { 1394 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1395 "sc->sc_wire == 0x%02x wrong for umass_cbi_adsc\n", 1396 sc->sc_wire); 1397 1398 if ((sc->sc_cmd == UMASS_CPROTO_RBC) && 1399 (sc->sc_quirks & UMASS_QUIRK_RBC_PAD_TO_12) != 0 && buflen < 12) { 1400 (void)memset(buffer + buflen, 0, 12 - buflen); 1401 buflen = 12; 1402 } 1403 1404 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1405 sc->sc_req.bRequest = UR_CBI_ADSC; 1406 USETW(sc->sc_req.wValue, 0); 1407 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 1408 USETW(sc->sc_req.wLength, buflen); 1409 return umass_setup_ctrl_transfer(sc, &sc->sc_req, buffer, 1410 buflen, flags, xfer); 1411 } 1412 1413 1414 Static void 1415 umass_cbi_reset(struct umass_softc *sc, int status) 1416 { 1417 int i; 1418 # define SEND_DIAGNOSTIC_CMDLEN 12 1419 1420 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1421 "sc->sc_wire == 0x%02x wrong for umass_cbi_reset\n", 1422 sc->sc_wire); 1423 1424 if (sc->sc_dying) 1425 return; 1426 1427 /* 1428 * Command Block Reset Protocol 1429 * 1430 * First send a reset request to the device. Then clear 1431 * any possibly stalled bulk endpoints. 1432 1433 * This is done in 3 steps, states: 1434 * TSTATE_CBI_RESET1 1435 * TSTATE_CBI_RESET2 1436 * TSTATE_CBI_RESET3 1437 * 1438 * If the reset doesn't succeed, the device should be port reset. 1439 */ 1440 1441 DPRINTF(UDMASS_CBI, ("%s: CBI Reset\n", 1442 device_xname(sc->sc_dev))); 1443 1444 /* CTASSERT */ 1445 KASSERTMSG(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN, 1446 "%s: CBL struct is too small (%zu < %u)\n", 1447 device_xname(sc->sc_dev), 1448 sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN); 1449 1450 sc->transfer_state = TSTATE_CBI_RESET1; 1451 sc->transfer_status = status; 1452 1453 /* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between 1454 * the two the last 10 bytes of the cbl is filled with 0xff (section 1455 * 2.2 of the CBI spec). 1456 */ 1457 sc->cbl[0] = 0x1d; /* Command Block Reset */ 1458 sc->cbl[1] = 0x04; 1459 for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++) 1460 sc->cbl[i] = 0xff; 1461 1462 umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, 0, 1463 sc->transfer_xfer[XFER_CBI_RESET1]); 1464 /* XXX if the command fails we should reset the port on the bub */ 1465 } 1466 1467 Static void 1468 umass_cbi_transfer(struct umass_softc *sc, int lun, 1469 void *cmd, int cmdlen, void *data, int datalen, int dir, 1470 u_int timeout, int flags, umass_callback cb, void *priv) 1471 { 1472 DPRINTF(UDMASS_CBI,("%s: umass_cbi_transfer cmd=0x%02x, len=%d\n", 1473 device_xname(sc->sc_dev), *(u_char *)cmd, datalen)); 1474 1475 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1476 "sc->sc_wire == 0x%02x wrong for umass_cbi_transfer\n", 1477 sc->sc_wire); 1478 1479 if (sc->sc_dying) 1480 return; 1481 1482 /* Be a little generous. */ 1483 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 1484 1485 /* 1486 * Do a CBI transfer with cmdlen bytes from cmd, possibly 1487 * a data phase of datalen bytes from/to the device and finally a 1488 * csw read phase. 1489 * If the data direction was inbound a maximum of datalen bytes 1490 * is stored in the buffer pointed to by data. 1491 * 1492 * umass_cbi_transfer initialises the transfer and lets the state 1493 * machine in umass_cbi_state handle the completion. It uses the 1494 * following states: 1495 * TSTATE_CBI_COMMAND 1496 * -> XXX fill in 1497 * 1498 * An error in any of those states will invoke 1499 * umass_cbi_reset. 1500 */ 1501 1502 /* check the given arguments */ 1503 KASSERTMSG(datalen == 0 || data != NULL, 1504 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 1505 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 1506 "%s: direction is NONE while datalen is not zero\n", 1507 device_xname(sc->sc_dev)); 1508 1509 /* store the details for the data transfer phase */ 1510 sc->transfer_dir = dir; 1511 sc->transfer_data = data; 1512 sc->transfer_datalen = datalen; 1513 sc->transfer_actlen = 0; 1514 sc->transfer_cb = cb; 1515 sc->transfer_priv = priv; 1516 sc->transfer_status = STATUS_CMD_OK; 1517 1518 /* move from idle to the command state */ 1519 sc->transfer_state = TSTATE_CBI_COMMAND; 1520 1521 /* Send the Command Block from host to device via control endpoint. */ 1522 if (umass_cbi_adsc(sc, cmd, cmdlen, flags, sc->transfer_xfer[XFER_CBI_CB])) 1523 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1524 } 1525 1526 Static void 1527 umass_cbi_state(usbd_xfer_handle xfer, usbd_private_handle priv, 1528 usbd_status err) 1529 { 1530 struct umass_softc *sc = (struct umass_softc *) priv; 1531 1532 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1533 "sc->sc_wire == 0x%02x wrong for umass_cbi_state\n", 1534 sc->sc_wire); 1535 1536 if (sc->sc_dying) 1537 return; 1538 1539 /* 1540 * State handling for CBI transfers. 1541 */ 1542 1543 DPRINTF(UDMASS_CBI, ("%s: Handling CBI state %d (%s), xfer=%p, %s\n", 1544 device_xname(sc->sc_dev), sc->transfer_state, 1545 states[sc->transfer_state], xfer, usbd_errstr(err))); 1546 1547 switch (sc->transfer_state) { 1548 1549 /***** CBI Transfer *****/ 1550 case TSTATE_CBI_COMMAND: 1551 if (err == USBD_STALLED) { 1552 DPRINTF(UDMASS_CBI, ("%s: Command Transport failed\n", 1553 device_xname(sc->sc_dev))); 1554 /* Status transport by control pipe (section 2.3.2.1). 1555 * The command contained in the command block failed. 1556 * 1557 * The control pipe has already been unstalled by the 1558 * USB stack. 1559 * Section 2.4.3.1.1 states that the bulk in endpoints 1560 * should not stalled at this point. 1561 */ 1562 1563 sc->transfer_state = TSTATE_IDLE; 1564 sc->transfer_cb(sc, sc->transfer_priv, 1565 sc->transfer_datalen, 1566 STATUS_CMD_FAILED); 1567 1568 return; 1569 } else if (err) { 1570 DPRINTF(UDMASS_CBI, ("%s: failed to send ADSC\n", 1571 device_xname(sc->sc_dev))); 1572 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1573 return; 1574 } 1575 1576 /* Data transport phase, setup transfer */ 1577 sc->transfer_state = TSTATE_CBI_DATA; 1578 if (sc->transfer_dir == DIR_IN) { 1579 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1580 sc->data_buffer, sc->transfer_datalen, 1581 USBD_SHORT_XFER_OK, 1582 sc->transfer_xfer[XFER_CBI_DATA])) 1583 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1584 1585 return; 1586 } else if (sc->transfer_dir == DIR_OUT) { 1587 memcpy(sc->data_buffer, sc->transfer_data, 1588 sc->transfer_datalen); 1589 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1590 sc->data_buffer, sc->transfer_datalen, 1591 0,/* fixed length transfer */ 1592 sc->transfer_xfer[XFER_CBI_DATA])) 1593 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1594 1595 return; 1596 } else { 1597 DPRINTF(UDMASS_CBI, ("%s: no data phase\n", 1598 device_xname(sc->sc_dev))); 1599 } 1600 1601 /* FALLTHROUGH if no data phase, err == 0 */ 1602 case TSTATE_CBI_DATA: 1603 /* Command transport phase error handling (ignored if no data 1604 * phase (fallthrough from previous state)) */ 1605 if (sc->transfer_dir != DIR_NONE) { 1606 /* retrieve the length of the transfer that was done */ 1607 usbd_get_xfer_status(xfer, NULL, NULL, 1608 &sc->transfer_actlen, NULL); 1609 DPRINTF(UDMASS_CBI, ("%s: CBI_DATA actlen=%d\n", 1610 device_xname(sc->sc_dev), sc->transfer_actlen)); 1611 1612 if (err) { 1613 DPRINTF(UDMASS_CBI, ("%s: Data-%s %d failed, " 1614 "%s\n", device_xname(sc->sc_dev), 1615 (sc->transfer_dir == DIR_IN?"in":"out"), 1616 sc->transfer_datalen,usbd_errstr(err))); 1617 1618 if (err == USBD_STALLED) { 1619 sc->transfer_state = TSTATE_CBI_DCLEAR; 1620 umass_clear_endpoint_stall(sc, 1621 (sc->transfer_dir == DIR_IN? 1622 UMASS_BULKIN:UMASS_BULKOUT), 1623 sc->transfer_xfer[XFER_CBI_DCLEAR]); 1624 } else { 1625 /* Unless the error is a pipe stall the 1626 * error is fatal. 1627 */ 1628 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1629 } 1630 return; 1631 } 1632 } 1633 1634 if (sc->transfer_dir == DIR_IN) 1635 memcpy(sc->transfer_data, sc->data_buffer, 1636 sc->transfer_actlen); 1637 1638 DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN) 1639 umass_dump_buffer(sc, sc->transfer_data, 1640 sc->transfer_actlen, 48)); 1641 1642 /* Status phase */ 1643 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 1644 sc->transfer_state = TSTATE_CBI_STATUS; 1645 memset(&sc->sbl, 0, sizeof(sc->sbl)); 1646 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_INTRIN], 1647 &sc->sbl, sizeof(sc->sbl), 1648 0, /* fixed length transfer */ 1649 sc->transfer_xfer[XFER_CBI_STATUS])) 1650 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1651 } else { 1652 /* No command completion interrupt. Request 1653 * sense to get status of command. 1654 */ 1655 sc->transfer_state = TSTATE_IDLE; 1656 sc->transfer_cb(sc, sc->transfer_priv, 1657 sc->transfer_datalen - sc->transfer_actlen, 1658 STATUS_CMD_UNKNOWN); 1659 } 1660 return; 1661 1662 case TSTATE_CBI_STATUS: 1663 if (err) { 1664 DPRINTF(UDMASS_CBI, ("%s: Status Transport failed\n", 1665 device_xname(sc->sc_dev))); 1666 /* Status transport by interrupt pipe (section 2.3.2.2). 1667 */ 1668 1669 if (err == USBD_STALLED) { 1670 sc->transfer_state = TSTATE_CBI_SCLEAR; 1671 umass_clear_endpoint_stall(sc, UMASS_INTRIN, 1672 sc->transfer_xfer[XFER_CBI_SCLEAR]); 1673 } else { 1674 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1675 } 1676 return; 1677 } 1678 1679 /* Dissect the information in the buffer */ 1680 1681 { 1682 uint32_t actlen; 1683 usbd_get_xfer_status(xfer,NULL,NULL,&actlen,NULL); 1684 DPRINTF(UDMASS_CBI, ("%s: CBI_STATUS actlen=%d\n", 1685 device_xname(sc->sc_dev), actlen)); 1686 if (actlen != 2) 1687 break; 1688 } 1689 1690 if (sc->sc_cmd == UMASS_CPROTO_UFI) { 1691 int status; 1692 1693 /* Section 3.4.3.1.3 specifies that the UFI command 1694 * protocol returns an ASC and ASCQ in the interrupt 1695 * data block. 1696 */ 1697 1698 DPRINTF(UDMASS_CBI, ("%s: UFI CCI, ASC = 0x%02x, " 1699 "ASCQ = 0x%02x\n", 1700 device_xname(sc->sc_dev), 1701 sc->sbl.ufi.asc, sc->sbl.ufi.ascq)); 1702 1703 if ((sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) || 1704 sc->sc_sense) 1705 status = STATUS_CMD_OK; 1706 else 1707 status = STATUS_CMD_FAILED; 1708 1709 /* No autosense, command successful */ 1710 sc->transfer_state = TSTATE_IDLE; 1711 sc->transfer_cb(sc, sc->transfer_priv, 1712 sc->transfer_datalen - sc->transfer_actlen, status); 1713 } else { 1714 int status; 1715 1716 /* Command Interrupt Data Block */ 1717 1718 DPRINTF(UDMASS_CBI, ("%s: type=0x%02x, value=0x%02x\n", 1719 device_xname(sc->sc_dev), 1720 sc->sbl.common.type, sc->sbl.common.value)); 1721 1722 if (sc->sbl.common.type == IDB_TYPE_CCI) { 1723 switch (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) { 1724 case IDB_VALUE_PASS: 1725 status = STATUS_CMD_OK; 1726 break; 1727 case IDB_VALUE_FAIL: 1728 case IDB_VALUE_PERSISTENT: 1729 status = STATUS_CMD_FAILED; 1730 break; 1731 case IDB_VALUE_PHASE: 1732 default: /* XXX: gcc */ 1733 status = STATUS_WIRE_FAILED; 1734 break; 1735 } 1736 1737 sc->transfer_state = TSTATE_IDLE; 1738 sc->transfer_cb(sc, sc->transfer_priv, 1739 sc->transfer_datalen - sc->transfer_actlen, status); 1740 } 1741 } 1742 return; 1743 1744 case TSTATE_CBI_DCLEAR: 1745 if (err) { /* should not occur */ 1746 printf("%s: CBI bulk-%s stall clear failed, %s\n", 1747 device_xname(sc->sc_dev), 1748 (sc->transfer_dir == DIR_IN? "in":"out"), 1749 usbd_errstr(err)); 1750 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1751 } else { 1752 sc->transfer_state = TSTATE_IDLE; 1753 sc->transfer_cb(sc, sc->transfer_priv, 1754 sc->transfer_datalen, STATUS_CMD_FAILED); 1755 } 1756 return; 1757 1758 case TSTATE_CBI_SCLEAR: 1759 if (err) { /* should not occur */ 1760 printf("%s: CBI intr-in stall clear failed, %s\n", 1761 device_xname(sc->sc_dev), usbd_errstr(err)); 1762 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1763 } else { 1764 sc->transfer_state = TSTATE_IDLE; 1765 sc->transfer_cb(sc, sc->transfer_priv, 1766 sc->transfer_datalen, STATUS_CMD_FAILED); 1767 } 1768 return; 1769 1770 /***** CBI Reset *****/ 1771 case TSTATE_CBI_RESET1: 1772 if (err) 1773 printf("%s: CBI reset failed, %s\n", 1774 device_xname(sc->sc_dev), usbd_errstr(err)); 1775 1776 sc->transfer_state = TSTATE_CBI_RESET2; 1777 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1778 sc->transfer_xfer[XFER_CBI_RESET2]); 1779 1780 return; 1781 case TSTATE_CBI_RESET2: 1782 if (err) /* should not occur */ 1783 printf("%s: CBI bulk-in stall clear failed, %s\n", 1784 device_xname(sc->sc_dev), usbd_errstr(err)); 1785 /* no error recovery, otherwise we end up in a loop */ 1786 1787 sc->transfer_state = TSTATE_CBI_RESET3; 1788 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1789 sc->transfer_xfer[XFER_CBI_RESET3]); 1790 1791 return; 1792 case TSTATE_CBI_RESET3: 1793 if (err) /* should not occur */ 1794 printf("%s: CBI bulk-out stall clear failed, %s\n", 1795 device_xname(sc->sc_dev), usbd_errstr(err)); 1796 /* no error recovery, otherwise we end up in a loop */ 1797 1798 sc->transfer_state = TSTATE_IDLE; 1799 if (sc->transfer_priv) { 1800 sc->transfer_cb(sc, sc->transfer_priv, 1801 sc->transfer_datalen, 1802 sc->transfer_status); 1803 } 1804 1805 return; 1806 1807 1808 /***** Default *****/ 1809 default: 1810 panic("%s: Unknown state %d", 1811 device_xname(sc->sc_dev), sc->transfer_state); 1812 } 1813 } 1814 1815 usbd_status 1816 umass_bbb_get_max_lun(struct umass_softc *sc, uint8_t *maxlun) 1817 { 1818 usb_device_request_t req; 1819 usbd_status err; 1820 1821 *maxlun = 0; /* Default to 0. */ 1822 1823 DPRINTF(UDMASS_BBB, ("%s: Get Max Lun\n", device_xname(sc->sc_dev))); 1824 1825 /* The Get Max Lun command is a class-specific request. */ 1826 req.bmRequestType = UT_READ_CLASS_INTERFACE; 1827 req.bRequest = UR_BBB_GET_MAX_LUN; 1828 USETW(req.wValue, 0); 1829 USETW(req.wIndex, sc->sc_ifaceno); 1830 USETW(req.wLength, 1); 1831 1832 err = usbd_do_request_flags(sc->sc_udev, &req, maxlun, 1833 USBD_SHORT_XFER_OK, 0, USBD_DEFAULT_TIMEOUT); 1834 switch (err) { 1835 case USBD_NORMAL_COMPLETION: 1836 DPRINTF(UDMASS_BBB, ("%s: Max Lun %d\n", 1837 device_xname(sc->sc_dev), *maxlun)); 1838 break; 1839 1840 case USBD_STALLED: 1841 /* 1842 * Device doesn't support Get Max Lun request. 1843 */ 1844 err = USBD_NORMAL_COMPLETION; 1845 DPRINTF(UDMASS_BBB, ("%s: Get Max Lun not supported\n", 1846 device_xname(sc->sc_dev))); 1847 break; 1848 1849 case USBD_SHORT_XFER: 1850 /* 1851 * XXX This must mean Get Max Lun is not supported, too! 1852 */ 1853 err = USBD_NORMAL_COMPLETION; 1854 DPRINTF(UDMASS_BBB, ("%s: Get Max Lun SHORT_XFER\n", 1855 device_xname(sc->sc_dev))); 1856 break; 1857 1858 default: 1859 printf("%s: Get Max Lun failed: %s\n", 1860 device_xname(sc->sc_dev), usbd_errstr(err)); 1861 /* XXX Should we port_reset the device? */ 1862 break; 1863 } 1864 1865 return err; 1866 } 1867 1868 1869 1870 1871 #ifdef UMASS_DEBUG 1872 Static void 1873 umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw) 1874 { 1875 int clen = cbw->bCDBLength; 1876 int dlen = UGETDW(cbw->dCBWDataTransferLength); 1877 uint8_t *c = cbw->CBWCDB; 1878 int tag = UGETDW(cbw->dCBWTag); 1879 int flags = cbw->bCBWFlags; 1880 1881 DPRINTF(UDMASS_BBB, ("%s: CBW %d: cmdlen=%d " 1882 "(0x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%s), " 1883 "data = %d bytes, dir = %s\n", 1884 device_xname(sc->sc_dev), tag, clen, 1885 c[0], c[1], c[2], c[3], c[4], c[5], 1886 c[6], c[7], c[8], c[9], 1887 (clen > 10? "...":""), 1888 dlen, (flags == CBWFLAGS_IN? "in": 1889 (flags == CBWFLAGS_OUT? "out":"<invalid>")))); 1890 } 1891 1892 Static void 1893 umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw) 1894 { 1895 int sig = UGETDW(csw->dCSWSignature); 1896 int tag = UGETDW(csw->dCSWTag); 1897 int res = UGETDW(csw->dCSWDataResidue); 1898 int status = csw->bCSWStatus; 1899 1900 DPRINTF(UDMASS_BBB, ("%s: CSW %d: sig = 0x%08x (%s), tag = %d, " 1901 "res = %d, status = 0x%02x (%s)\n", device_xname(sc->sc_dev), 1902 tag, sig, (sig == CSWSIGNATURE? "valid":"invalid"), 1903 tag, res, 1904 status, (status == CSWSTATUS_GOOD? "good": 1905 (status == CSWSTATUS_FAILED? "failed": 1906 (status == CSWSTATUS_PHASE? "phase":"<invalid>"))))); 1907 } 1908 1909 Static void 1910 umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, int buflen, 1911 int printlen) 1912 { 1913 int i, j; 1914 char s1[40]; 1915 char s2[40]; 1916 char s3[5]; 1917 1918 s1[0] = '\0'; 1919 s3[0] = '\0'; 1920 1921 snprintf(s2, sizeof(s2), " buffer=%p, buflen=%d", buffer, buflen); 1922 for (i = 0; i < buflen && i < printlen; i++) { 1923 j = i % 16; 1924 if (j == 0 && i != 0) { 1925 DPRINTF(UDMASS_GEN, ("%s: 0x %s%s\n", 1926 device_xname(sc->sc_dev), s1, s2)); 1927 s2[0] = '\0'; 1928 } 1929 snprintf(&s1[j * 2], sizeof(s1) - j * 2, "%02x", 1930 buffer[i] & 0xff); 1931 } 1932 if (buflen > printlen) 1933 snprintf(s3, sizeof(s3), " ..."); 1934 DPRINTF(UDMASS_GEN, ("%s: 0x %s%s%s\n", 1935 device_xname(sc->sc_dev), s1, s2, s3)); 1936 } 1937 #endif 1938
Indexes created Tue Oct 14 06:10:07 GMT 2025