umass.c revision 1.148.4.2
1 /* $NetBSD: umass.c,v 1.148.4.2 2018/02/19 19:33:06 snj 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.148.4.2 2018/02/19 19:33:06 snj 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, 531 &sc->sc_pipe[UMASS_BULKOUT]); 532 if (err) { 533 aprint_error_dev(self, "cannot open %u-out pipe (bulk)\n", 534 sc->sc_epaddr[UMASS_BULKOUT]); 535 umass_disco(sc); 536 return; 537 } 538 DPRINTFM(UDMASS_USB, "sc %p: opening iface %p epaddr %d for BULKIN", 539 sc, sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN], 0); 540 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN], 541 USBD_EXCLUSIVE_USE, &sc->sc_pipe[UMASS_BULKIN]); 542 if (err) { 543 aprint_error_dev(self, "could not open %u-in pipe (bulk)\n", 544 sc->sc_epaddr[UMASS_BULKIN]); 545 umass_disco(sc); 546 return; 547 } 548 /* 549 * Open the intr-in pipe if the protocol is CBI with CCI. 550 * Note: early versions of the Zip drive do have an interrupt pipe, but 551 * this pipe is unused 552 * 553 * We do not open the interrupt pipe as an interrupt pipe, but as a 554 * normal bulk endpoint. We send an IN transfer down the wire at the 555 * appropriate time, because we know exactly when to expect data on 556 * that endpoint. This saves bandwidth, but more important, makes the 557 * code for handling the data on that endpoint simpler. No data 558 * arriving concurrently. 559 */ 560 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 561 DPRINTFM(UDMASS_USB, 562 "sc %p: opening iface %p epaddr %d for INTRIN", 563 sc, sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN], 0); 564 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN], 565 USBD_EXCLUSIVE_USE, &sc->sc_pipe[UMASS_INTRIN]); 566 if (err) { 567 aprint_error_dev(self, "couldn't open %u-in (intr)\n", 568 sc->sc_epaddr[UMASS_INTRIN]); 569 umass_disco(sc); 570 return; 571 } 572 } 573 574 /* initialisation of generic part */ 575 sc->transfer_state = TSTATE_IDLE; 576 577 for (i = 0; i < XFER_NR; i++) { 578 sc->transfer_xfer[i] = NULL; 579 } 580 581 /* 582 * Create the transfers 583 */ 584 struct usbd_pipe *pipe0 = usbd_get_pipe0(sc->sc_udev); 585 switch (sc->sc_wire) { 586 case UMASS_WPROTO_BBB: 587 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 588 UMASS_MAX_TRANSFER_SIZE, 0, 0, 589 &sc->transfer_xfer[XFER_BBB_DATAIN]); 590 if (err) 591 goto fail_create; 592 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT], 593 UMASS_MAX_TRANSFER_SIZE, 0, 0, 594 &sc->transfer_xfer[XFER_BBB_DATAOUT]); 595 if (err) 596 goto fail_create; 597 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT], 598 UMASS_BBB_CBW_SIZE, 0, 0, 599 &sc->transfer_xfer[XFER_BBB_CBW]); 600 if (err) 601 goto fail_create; 602 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 603 UMASS_BBB_CSW_SIZE, 0, 0, 604 &sc->transfer_xfer[XFER_BBB_CSW1]); 605 if (err) 606 goto fail_create; 607 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 608 UMASS_BBB_CSW_SIZE, 0, 0, 609 &sc->transfer_xfer[XFER_BBB_CSW2]); 610 if (err) 611 goto fail_create; 612 err = usbd_create_xfer(pipe0, 0, 0, 0, 613 &sc->transfer_xfer[XFER_BBB_SCLEAR]); 614 if (err) 615 goto fail_create; 616 err = usbd_create_xfer(pipe0, 0, 0, 0, 617 &sc->transfer_xfer[XFER_BBB_DCLEAR]); 618 if (err) 619 goto fail_create; 620 err = usbd_create_xfer(pipe0, 0, 0, 0, 621 &sc->transfer_xfer[XFER_BBB_RESET1]); 622 if (err) 623 goto fail_create; 624 err = usbd_create_xfer(pipe0, 0, 0, 0, 625 &sc->transfer_xfer[XFER_BBB_RESET2]); 626 if (err) 627 goto fail_create; 628 err = usbd_create_xfer(pipe0, 0, 0, 0, 629 &sc->transfer_xfer[XFER_BBB_RESET3]); 630 if (err) 631 goto fail_create; 632 break; 633 case UMASS_WPROTO_CBI: 634 case UMASS_WPROTO_CBI_I: 635 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 636 &sc->transfer_xfer[XFER_CBI_CB]); 637 if (err) 638 goto fail_create; 639 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKIN], 640 UMASS_MAX_TRANSFER_SIZE, 0, 0, 641 &sc->transfer_xfer[XFER_CBI_DATAIN]); 642 if (err) 643 goto fail_create; 644 err = usbd_create_xfer(sc->sc_pipe[UMASS_BULKOUT], 645 UMASS_MAX_TRANSFER_SIZE, 0, 0, 646 &sc->transfer_xfer[XFER_CBI_DATAOUT]); 647 if (err) 648 goto fail_create; 649 err = usbd_create_xfer(sc->sc_pipe[UMASS_INTRIN], 650 sizeof(sc->sbl), 0, 0, 651 &sc->transfer_xfer[XFER_CBI_STATUS]); 652 if (err) 653 goto fail_create; 654 err = usbd_create_xfer(pipe0, 0, 0, 0, 655 &sc->transfer_xfer[XFER_CBI_DCLEAR]); 656 if (err) 657 goto fail_create; 658 err = usbd_create_xfer(pipe0, 0, 0, 0, 659 &sc->transfer_xfer[XFER_CBI_SCLEAR]); 660 if (err) 661 goto fail_create; 662 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 663 &sc->transfer_xfer[XFER_CBI_RESET1]); 664 if (err) 665 goto fail_create; 666 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 667 &sc->transfer_xfer[XFER_CBI_RESET2]); 668 if (err) 669 goto fail_create; 670 err = usbd_create_xfer(pipe0, sizeof(sc->cbl), 0, 0, 671 &sc->transfer_xfer[XFER_CBI_RESET3]); 672 if (err) 673 goto fail_create; 674 break; 675 default: 676 fail_create: 677 aprint_error_dev(self, "failed to create xfers\n"); 678 umass_disco(sc); 679 return; 680 } 681 682 /* 683 * Record buffer pinters for data transfer (it's huge), command and 684 * status data here 685 */ 686 switch (sc->sc_wire) { 687 case UMASS_WPROTO_BBB: 688 sc->datain_buffer = 689 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAIN]); 690 sc->dataout_buffer = 691 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_DATAOUT]); 692 sc->cmd_buffer = 693 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CBW]); 694 sc->s1_buffer = 695 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW1]); 696 sc->s2_buffer = 697 usbd_get_buffer(sc->transfer_xfer[XFER_BBB_CSW2]); 698 break; 699 case UMASS_WPROTO_CBI: 700 case UMASS_WPROTO_CBI_I: 701 sc->datain_buffer = 702 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAIN]); 703 sc->dataout_buffer = 704 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_DATAOUT]); 705 sc->cmd_buffer = 706 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_CB]); 707 sc->s1_buffer = 708 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_STATUS]); 709 sc->s2_buffer = 710 usbd_get_buffer(sc->transfer_xfer[XFER_CBI_RESET1]); 711 break; 712 default: 713 break; 714 } 715 716 /* Initialise the wire protocol specific methods */ 717 switch (sc->sc_wire) { 718 case UMASS_WPROTO_BBB: 719 sc->sc_methods = &umass_bbb_methods; 720 break; 721 case UMASS_WPROTO_CBI: 722 case UMASS_WPROTO_CBI_I: 723 sc->sc_methods = &umass_cbi_methods; 724 break; 725 default: 726 umass_disco(sc); 727 return; 728 } 729 730 error = 0; 731 switch (sc->sc_cmd) { 732 case UMASS_CPROTO_RBC: 733 case UMASS_CPROTO_SCSI: 734 #if NSCSIBUS > 0 735 error = umass_scsi_attach(sc); 736 #else 737 aprint_error_dev(self, "scsibus not configured\n"); 738 #endif 739 break; 740 741 case UMASS_CPROTO_UFI: 742 case UMASS_CPROTO_ATAPI: 743 #if NATAPIBUS > 0 744 error = umass_atapi_attach(sc); 745 #else 746 aprint_error_dev(self, "atapibus not configured\n"); 747 #endif 748 break; 749 750 case UMASS_CPROTO_ISD_ATA: 751 #if NWD > 0 752 error = umass_isdata_attach(sc); 753 #else 754 aprint_error_dev(self, "isdata not configured\n"); 755 #endif 756 break; 757 758 default: 759 aprint_error_dev(self, "command protocol=0x%x not supported\n", 760 sc->sc_cmd); 761 umass_disco(sc); 762 return; 763 } 764 if (error) { 765 aprint_error_dev(self, "bus attach failed\n"); 766 umass_disco(sc); 767 return; 768 } 769 770 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev); 771 772 if (!pmf_device_register(self, NULL, NULL)) 773 aprint_error_dev(self, "couldn't establish power handler\n"); 774 775 DPRINTFM(UDMASS_GEN, "sc %p: Attach finished", sc, 0, 0, 0); 776 777 return; 778 } 779 780 static void 781 umass_childdet(device_t self, device_t child) 782 { 783 struct umass_softc *sc = device_private(self); 784 785 KASSERTMSG(child == sc->bus->sc_child, 786 "assertion child == sc->bus->sc_child failed\n"); 787 sc->bus->sc_child = NULL; 788 } 789 790 int 791 umass_detach(device_t self, int flags) 792 { 793 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 794 struct umass_softc *sc = device_private(self); 795 struct umassbus_softc *scbus; 796 int rv = 0, i; 797 798 DPRINTFM(UDMASS_USB, "sc %p detached", sc, 0, 0, 0); 799 800 pmf_device_deregister(self); 801 802 /* Abort the pipes to wake up any waiting processes. */ 803 for (i = 0 ; i < UMASS_NEP ; i++) { 804 if (sc->sc_pipe[i] != NULL) 805 usbd_abort_pipe(sc->sc_pipe[i]); 806 } 807 808 /* Do we really need reference counting? Perhaps in ioctl() */ 809 mutex_enter(&sc->sc_lock); 810 if (--sc->sc_refcnt >= 0) { 811 #ifdef DIAGNOSTIC 812 aprint_normal_dev(self, "waiting for refcnt\n"); 813 #endif 814 /* Wait for processes to go away. */ 815 if (cv_timedwait(&sc->sc_detach_cv, &sc->sc_lock, hz * 60)) { 816 printf("%s: %s didn't detach\n", __func__, 817 device_xname(sc->sc_dev)); 818 } 819 } 820 mutex_exit(&sc->sc_lock); 821 822 scbus = sc->bus; 823 if (scbus != NULL) { 824 if (scbus->sc_child != NULL) 825 rv = config_detach(scbus->sc_child, flags); 826 free(scbus, M_DEVBUF); 827 sc->bus = NULL; 828 } 829 830 if (rv != 0) 831 return rv; 832 833 umass_disco(sc); 834 835 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev); 836 837 mutex_destroy(&sc->sc_lock); 838 cv_destroy(&sc->sc_detach_cv); 839 840 return rv; 841 } 842 843 int 844 umass_activate(device_t dev, enum devact act) 845 { 846 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 847 struct umass_softc *sc = device_private(dev); 848 849 DPRINTFM(UDMASS_USB, "sc %p act %d", sc, act, 0, 0); 850 851 switch (act) { 852 case DVACT_DEACTIVATE: 853 sc->sc_dying = 1; 854 return 0; 855 default: 856 return EOPNOTSUPP; 857 } 858 } 859 860 Static void 861 umass_disco(struct umass_softc *sc) 862 { 863 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 864 int i; 865 866 /* Remove all the pipes. */ 867 for (i = 0 ; i < UMASS_NEP ; i++) { 868 if (sc->sc_pipe[i] != NULL) { 869 usbd_abort_pipe(sc->sc_pipe[i]); 870 } 871 } 872 873 /* Some xfers may be queued in the default pipe */ 874 usbd_abort_default_pipe(sc->sc_udev); 875 876 /* Free the xfers. */ 877 for (i = 0; i < XFER_NR; i++) { 878 if (sc->transfer_xfer[i] != NULL) { 879 usbd_destroy_xfer(sc->transfer_xfer[i]); 880 sc->transfer_xfer[i] = NULL; 881 } 882 } 883 884 for (i = 0 ; i < UMASS_NEP ; i++) { 885 if (sc->sc_pipe[i] != NULL) { 886 usbd_close_pipe(sc->sc_pipe[i]); 887 sc->sc_pipe[i] = NULL; 888 } 889 } 890 891 } 892 893 /* 894 * Generic functions to handle transfers 895 */ 896 897 Static usbd_status 898 umass_setup_transfer(struct umass_softc *sc, struct usbd_pipe *pipe, 899 void *buffer, int buflen, int flags, 900 struct usbd_xfer *xfer) 901 { 902 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 903 usbd_status err; 904 905 if (sc->sc_dying) 906 return USBD_IOERROR; 907 908 /* Initialiase a USB transfer and then schedule it */ 909 910 usbd_setup_xfer(xfer, sc, buffer, buflen, flags, sc->timeout, 911 sc->sc_methods->wire_state); 912 913 err = usbd_transfer(xfer); 914 DPRINTFM(UDMASS_XFER, "start xfer buffer=%p buflen=%d flags=0x%x " 915 "timeout=%d", buffer, buflen, flags, sc->timeout); 916 if (err && err != USBD_IN_PROGRESS) { 917 DPRINTFM(UDMASS_BBB, "failed to setup transfer... err=%d", 918 err, 0, 0, 0); 919 return err; 920 } 921 922 return USBD_NORMAL_COMPLETION; 923 } 924 925 926 Static usbd_status 927 umass_setup_ctrl_transfer(struct umass_softc *sc, usb_device_request_t *req, 928 void *buffer, int buflen, int flags, struct usbd_xfer *xfer) 929 { 930 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 931 usbd_status err; 932 933 if (sc->sc_dying) 934 return USBD_IOERROR; 935 936 /* Initialiase a USB control transfer and then schedule it */ 937 938 usbd_setup_default_xfer(xfer, sc->sc_udev, (void *) sc, sc->timeout, 939 req, buffer, buflen, flags, sc->sc_methods->wire_state); 940 941 err = usbd_transfer(xfer); 942 if (err && err != USBD_IN_PROGRESS) { 943 DPRINTFM(UDMASS_BBB, "failed to setup ctrl transfer... err=%d", 944 err, 0, 0, 0); 945 946 /* do not reset, as this would make us loop */ 947 return err; 948 } 949 950 return USBD_NORMAL_COMPLETION; 951 } 952 953 Static void 954 umass_clear_endpoint_stall(struct umass_softc *sc, int endpt, 955 struct usbd_xfer *xfer) 956 { 957 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 958 959 if (sc->sc_dying) 960 return; 961 962 DPRINTFM(UDMASS_BBB, "Clear endpoint 0x%02x stall", 963 sc->sc_epaddr[endpt], 0, 0, 0); 964 965 usbd_clear_endpoint_toggle(sc->sc_pipe[endpt]); 966 967 sc->sc_req.bmRequestType = UT_WRITE_ENDPOINT; 968 sc->sc_req.bRequest = UR_CLEAR_FEATURE; 969 USETW(sc->sc_req.wValue, UF_ENDPOINT_HALT); 970 USETW(sc->sc_req.wIndex, sc->sc_epaddr[endpt]); 971 USETW(sc->sc_req.wLength, 0); 972 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, xfer); 973 } 974 975 #if 0 976 Static void 977 umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv) 978 { 979 sc->transfer_cb = cb; 980 sc->transfer_priv = priv; 981 982 /* The reset is a forced reset, so no error (yet) */ 983 sc->reset(sc, STATUS_CMD_OK); 984 } 985 #endif 986 987 /* 988 * Bulk protocol specific functions 989 */ 990 991 Static void 992 umass_bbb_reset(struct umass_softc *sc, int status) 993 { 994 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 995 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 996 "sc->sc_wire == 0x%02x wrong for umass_bbb_reset\n", 997 sc->sc_wire); 998 999 if (sc->sc_dying) 1000 return; 1001 1002 /* 1003 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class) 1004 * 1005 * For Reset Recovery the host shall issue in the following order: 1006 * a) a Bulk-Only Mass Storage Reset 1007 * b) a Clear Feature HALT to the Bulk-In endpoint 1008 * c) a Clear Feature HALT to the Bulk-Out endpoint 1009 * 1010 * This is done in 3 steps, states: 1011 * TSTATE_BBB_RESET1 1012 * TSTATE_BBB_RESET2 1013 * TSTATE_BBB_RESET3 1014 * 1015 * If the reset doesn't succeed, the device should be port reset. 1016 */ 1017 1018 DPRINTFM(UDMASS_BBB, "Bulk Reset", 0, 0, 0, 0); 1019 1020 sc->transfer_state = TSTATE_BBB_RESET1; 1021 sc->transfer_status = status; 1022 1023 /* reset is a class specific interface write */ 1024 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1025 sc->sc_req.bRequest = UR_BBB_RESET; 1026 USETW(sc->sc_req.wValue, 0); 1027 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 1028 USETW(sc->sc_req.wLength, 0); 1029 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, 1030 sc->transfer_xfer[XFER_BBB_RESET1]); 1031 } 1032 1033 Static void 1034 umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, 1035 void *data, int datalen, int dir, u_int timeout, 1036 int flags, umass_callback cb, void *priv) 1037 { 1038 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1039 static int dCBWtag = 42; /* unique for CBW of transfer */ 1040 1041 DPRINTFM(UDMASS_BBB, "sc %p cmd=0x%02x", sc, *(u_char *)cmd, 0, 0); 1042 1043 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1044 "sc->sc_wire == 0x%02x wrong for umass_bbb_transfer\n", 1045 sc->sc_wire); 1046 1047 if (sc->sc_dying) 1048 return; 1049 1050 /* Be a little generous. */ 1051 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 1052 1053 /* 1054 * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly 1055 * a data phase of datalen bytes from/to the device and finally a 1056 * csw read phase. 1057 * If the data direction was inbound a maximum of datalen bytes 1058 * is stored in the buffer pointed to by data. 1059 * 1060 * umass_bbb_transfer initialises the transfer and lets the state 1061 * machine in umass_bbb_state handle the completion. It uses the 1062 * following states: 1063 * TSTATE_BBB_COMMAND 1064 * -> TSTATE_BBB_DATA 1065 * -> TSTATE_BBB_STATUS 1066 * -> TSTATE_BBB_STATUS2 1067 * -> TSTATE_BBB_IDLE 1068 * 1069 * An error in any of those states will invoke 1070 * umass_bbb_reset. 1071 */ 1072 1073 /* check the given arguments */ 1074 KASSERTMSG(datalen == 0 || data != NULL, 1075 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 1076 KASSERTMSG(cmdlen <= CBWCDBLENGTH, 1077 "%s: cmdlen exceeds CDB length in CBW (%d > %d)", 1078 device_xname(sc->sc_dev), cmdlen, CBWCDBLENGTH); 1079 KASSERTMSG(dir == DIR_NONE || datalen > 0, 1080 "%s: datalen == 0 while direction is not NONE\n", 1081 device_xname(sc->sc_dev)); 1082 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 1083 "%s: direction is NONE while datalen is not zero\n", 1084 device_xname(sc->sc_dev)); 1085 /* CTASSERT */ 1086 KASSERTMSG(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE, 1087 "%s: CBW struct does not have the right size (%zu vs. %u)\n", 1088 device_xname(sc->sc_dev), 1089 sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE); 1090 /* CTASSERT */ 1091 KASSERTMSG(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE, 1092 "%s: CSW struct does not have the right size (%zu vs. %u)\n", 1093 device_xname(sc->sc_dev), 1094 sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE); 1095 1096 /* 1097 * Determine the direction of the data transfer and the length. 1098 * 1099 * dCBWDataTransferLength (datalen) : 1100 * This field indicates the number of bytes of data that the host 1101 * intends to transfer on the IN or OUT Bulk endpoint(as indicated by 1102 * the Direction bit) during the execution of this command. If this 1103 * field is set to 0, the device will expect that no data will be 1104 * transferred IN or OUT during this command, regardless of the value 1105 * of the Direction bit defined in dCBWFlags. 1106 * 1107 * dCBWFlags (dir) : 1108 * The bits of the Flags field are defined as follows: 1109 * Bits 0-6 reserved 1110 * Bit 7 Direction - this bit shall be ignored if the 1111 * dCBWDataTransferLength field is zero. 1112 * 0 = data Out from host to device 1113 * 1 = data In from device to host 1114 */ 1115 1116 /* Fill in the Command Block Wrapper */ 1117 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE); 1118 USETDW(sc->cbw.dCBWTag, dCBWtag); 1119 dCBWtag++; /* cannot be done in macro (it will be done 4 times) */ 1120 USETDW(sc->cbw.dCBWDataTransferLength, datalen); 1121 /* DIR_NONE is treated as DIR_OUT (0x00) */ 1122 sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT); 1123 sc->cbw.bCBWLUN = lun; 1124 sc->cbw.bCDBLength = cmdlen; 1125 memcpy(sc->cbw.CBWCDB, cmd, cmdlen); 1126 1127 DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw)); 1128 1129 /* store the details for the data transfer phase */ 1130 sc->transfer_dir = dir; 1131 sc->transfer_data = data; 1132 sc->transfer_datalen = datalen; 1133 sc->transfer_actlen = 0; 1134 sc->transfer_cb = cb; 1135 sc->transfer_priv = priv; 1136 sc->transfer_status = STATUS_CMD_OK; 1137 1138 /* move from idle to the command state */ 1139 sc->transfer_state = TSTATE_BBB_COMMAND; 1140 1141 /* Send the CBW from host to device via bulk-out endpoint. */ 1142 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1143 &sc->cbw, UMASS_BBB_CBW_SIZE, flags, 1144 sc->transfer_xfer[XFER_BBB_CBW])) { 1145 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1146 } 1147 } 1148 1149 1150 Static void 1151 umass_bbb_state(struct usbd_xfer *xfer, void *priv, 1152 usbd_status err) 1153 { 1154 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1155 struct umass_softc *sc = (struct umass_softc *) priv; 1156 struct usbd_xfer *next_xfer; 1157 int residue; 1158 1159 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1160 "sc->sc_wire == 0x%02x wrong for umass_bbb_state\n", 1161 sc->sc_wire); 1162 1163 if (sc->sc_dying) 1164 return; 1165 1166 /* 1167 * State handling for BBB transfers. 1168 * 1169 * The subroutine is rather long. It steps through the states given in 1170 * Annex A of the Bulk-Only specification. 1171 * Each state first does the error handling of the previous transfer 1172 * and then prepares the next transfer. 1173 * Each transfer is done asynchroneously so after the request/transfer 1174 * has been submitted you will find a 'return;'. 1175 */ 1176 1177 DPRINTFM(UDMASS_BBB, "sc %p xfer %p, transfer_state %d dir %d", sc, 1178 xfer, sc->transfer_state, sc->transfer_dir); 1179 1180 switch (sc->transfer_state) { 1181 1182 /***** Bulk Transfer *****/ 1183 case TSTATE_BBB_COMMAND: 1184 /* Command transport phase, error handling */ 1185 if (err) { 1186 DPRINTFM(UDMASS_BBB, "sc %p failed to send CBW", sc, 1187 0, 0, 0); 1188 /* If the device detects that the CBW is invalid, then 1189 * the device may STALL both bulk endpoints and require 1190 * a Bulk-Reset 1191 */ 1192 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1193 return; 1194 } 1195 1196 /* Data transport phase, setup transfer */ 1197 sc->transfer_state = TSTATE_BBB_DATA; 1198 if (sc->transfer_dir == DIR_IN) { 1199 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1200 sc->datain_buffer, sc->transfer_datalen, 1201 USBD_SHORT_XFER_OK, 1202 sc->transfer_xfer[XFER_BBB_DATAIN])) 1203 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1204 1205 return; 1206 } else if (sc->transfer_dir == DIR_OUT) { 1207 memcpy(sc->dataout_buffer, sc->transfer_data, 1208 sc->transfer_datalen); 1209 if (umass_setup_transfer(sc, 1210 sc->sc_pipe[UMASS_BULKOUT], sc->dataout_buffer, 1211 sc->transfer_datalen, 0,/* fixed length transfer */ 1212 sc->transfer_xfer[XFER_BBB_DATAOUT])) 1213 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1214 1215 return; 1216 } else { 1217 DPRINTFM(UDMASS_BBB, "sc %p: no data phase", sc, 0, 0, 1218 0); 1219 } 1220 1221 /* FALLTHROUGH if no data phase, err == 0 */ 1222 case TSTATE_BBB_DATA: 1223 /* Command transport phase error handling (ignored if no data 1224 * phase (fallthrough from previous state)) */ 1225 if (sc->transfer_dir != DIR_NONE) { 1226 /* retrieve the length of the transfer that was done */ 1227 usbd_get_xfer_status(xfer, NULL, NULL, 1228 &sc->transfer_actlen, NULL); 1229 DPRINTFM(UDMASS_BBB, "sc %p: BBB_DATA actlen=%d", 1230 sc, sc->transfer_actlen, 0, 0); 1231 1232 if (err) { 1233 DPRINTFM(UDMASS_BBB, "sc %p Data dir %d err %d" 1234 " failed, ", sc, sc->transfer_dir, 1235 sc->transfer_datalen, err); 1236 1237 if (err == USBD_STALLED) { 1238 sc->transfer_state = TSTATE_BBB_DCLEAR; 1239 umass_clear_endpoint_stall(sc, 1240 (sc->transfer_dir == DIR_IN? 1241 UMASS_BULKIN:UMASS_BULKOUT), 1242 sc->transfer_xfer[XFER_BBB_DCLEAR]); 1243 } else { 1244 /* Unless the error is a pipe stall the 1245 * error is fatal. 1246 */ 1247 umass_bbb_reset(sc,STATUS_WIRE_FAILED); 1248 } 1249 return; 1250 } 1251 } 1252 1253 /* FALLTHROUGH, err == 0 (no data phase or successful) */ 1254 case TSTATE_BBB_DCLEAR: /* stall clear after data phase */ 1255 if (sc->transfer_dir == DIR_IN) 1256 memcpy(sc->transfer_data, sc->datain_buffer, 1257 sc->transfer_actlen); 1258 1259 DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN) 1260 umass_dump_buffer(sc, sc->transfer_data, 1261 sc->transfer_datalen, 48)); 1262 1263 /* FALLTHROUGH, err == 0 (no data phase or successful) */ 1264 case TSTATE_BBB_SCLEAR: /* stall clear after status phase */ 1265 /* Reading of CSW after bulk stall condition in data phase 1266 * (TSTATE_BBB_DATA2) or bulk-in stall condition after 1267 * reading CSW (TSTATE_BBB_SCLEAR). 1268 * In the case of no data phase or successful data phase, 1269 * err == 0 and the following if block is passed. 1270 */ 1271 if (err) { /* should not occur */ 1272 printf("%s: BBB bulk-%s stall clear failed, %s\n", 1273 device_xname(sc->sc_dev), 1274 (sc->transfer_dir == DIR_IN? "in":"out"), 1275 usbd_errstr(err)); 1276 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1277 return; 1278 } 1279 1280 /* Status transport phase, setup transfer */ 1281 if (sc->transfer_state == TSTATE_BBB_COMMAND || 1282 sc->transfer_state == TSTATE_BBB_DATA || 1283 sc->transfer_state == TSTATE_BBB_DCLEAR) { 1284 /* After no data phase, successful data phase and 1285 * after clearing bulk-in/-out stall condition 1286 */ 1287 sc->transfer_state = TSTATE_BBB_STATUS1; 1288 next_xfer = sc->transfer_xfer[XFER_BBB_CSW1]; 1289 } else { 1290 /* After first attempt of fetching CSW */ 1291 sc->transfer_state = TSTATE_BBB_STATUS2; 1292 next_xfer = sc->transfer_xfer[XFER_BBB_CSW2]; 1293 } 1294 1295 /* Read the Command Status Wrapper via bulk-in endpoint. */ 1296 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1297 &sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) { 1298 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1299 return; 1300 } 1301 1302 return; 1303 case TSTATE_BBB_STATUS1: /* first attempt */ 1304 case TSTATE_BBB_STATUS2: /* second attempt */ 1305 /* Status transfer, error handling */ 1306 if (err) { 1307 DPRINTFM(UDMASS_BBB, "sc %p Failed to read CSW err %d " 1308 "(state %d)", sc, err, sc->transfer_state, 0); 1309 1310 /* If this was the first attempt at fetching the CSW 1311 * retry it, otherwise fail. 1312 */ 1313 if (sc->transfer_state == TSTATE_BBB_STATUS1) { 1314 sc->transfer_state = TSTATE_BBB_SCLEAR; 1315 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1316 sc->transfer_xfer[XFER_BBB_SCLEAR]); 1317 return; 1318 } else { 1319 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1320 return; 1321 } 1322 } 1323 1324 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw)); 1325 1326 #ifdef UMASS_DEBUG 1327 residue = UGETDW(sc->csw.dCSWDataResidue); 1328 if (residue != sc->transfer_datalen - sc->transfer_actlen) 1329 printf("%s: dCSWDataResidue=%d req=%d act=%d\n", 1330 device_xname(sc->sc_dev), residue, 1331 sc->transfer_datalen, sc->transfer_actlen); 1332 #endif 1333 residue = sc->transfer_datalen - sc->transfer_actlen; 1334 1335 /* Translate weird command-status signatures. */ 1336 if ((sc->sc_quirks & UMASS_QUIRK_WRONG_CSWSIG) && 1337 UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1) 1338 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE); 1339 1340 /* Translate invalid command-status tags */ 1341 if (sc->sc_quirks & UMASS_QUIRK_WRONG_CSWTAG) 1342 USETDW(sc->csw.dCSWTag, UGETDW(sc->cbw.dCBWTag)); 1343 1344 /* Check CSW and handle any error */ 1345 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) { 1346 /* Invalid CSW: Wrong signature or wrong tag might 1347 * indicate that the device is confused -> reset it. 1348 */ 1349 printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n", 1350 device_xname(sc->sc_dev), 1351 UGETDW(sc->csw.dCSWSignature), 1352 CSWSIGNATURE); 1353 1354 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1355 return; 1356 } else if (UGETDW(sc->csw.dCSWTag) 1357 != UGETDW(sc->cbw.dCBWTag)) { 1358 printf("%s: Invalid CSW: tag %d should be %d\n", 1359 device_xname(sc->sc_dev), 1360 UGETDW(sc->csw.dCSWTag), 1361 UGETDW(sc->cbw.dCBWTag)); 1362 1363 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1364 return; 1365 1366 /* CSW is valid here */ 1367 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) { 1368 printf("%s: Invalid CSW: status %d > %d\n", 1369 device_xname(sc->sc_dev), 1370 sc->csw.bCSWStatus, 1371 CSWSTATUS_PHASE); 1372 1373 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1374 return; 1375 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) { 1376 printf("%s: Phase Error, residue = %d\n", 1377 device_xname(sc->sc_dev), residue); 1378 1379 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1380 return; 1381 1382 } else if (sc->transfer_actlen > sc->transfer_datalen) { 1383 /* Buffer overrun! Don't let this go by unnoticed */ 1384 panic("%s: transferred %s %d bytes instead of %d bytes", 1385 device_xname(sc->sc_dev), 1386 sc->transfer_dir == DIR_IN ? "IN" : "OUT", 1387 sc->transfer_actlen, sc->transfer_datalen); 1388 #if 0 1389 } else if (sc->transfer_datalen - sc->transfer_actlen 1390 != residue) { 1391 DPRINTFM(UDMASS_BBB, "sc %p: actlen=%d != residue=%d\n", 1392 sc, 1393 sc->transfer_datalen - sc->transfer_actlen, 1394 residue)); 1395 1396 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1397 return; 1398 #endif 1399 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) { 1400 DPRINTFM(UDMASS_BBB, "sc %p: Command Failed, res = %d", 1401 sc, residue, 0, 0); 1402 1403 /* SCSI command failed but transfer was succesful */ 1404 sc->transfer_state = TSTATE_IDLE; 1405 sc->transfer_cb(sc, sc->transfer_priv, residue, 1406 STATUS_CMD_FAILED); 1407 1408 return; 1409 1410 } else { /* success */ 1411 sc->transfer_state = TSTATE_IDLE; 1412 sc->transfer_cb(sc, sc->transfer_priv, residue, 1413 STATUS_CMD_OK); 1414 1415 return; 1416 } 1417 1418 /***** Bulk Reset *****/ 1419 case TSTATE_BBB_RESET1: 1420 if (err) 1421 printf("%s: BBB reset failed, %s\n", 1422 device_xname(sc->sc_dev), usbd_errstr(err)); 1423 1424 sc->transfer_state = TSTATE_BBB_RESET2; 1425 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1426 sc->transfer_xfer[XFER_BBB_RESET2]); 1427 1428 return; 1429 case TSTATE_BBB_RESET2: 1430 if (err) /* should not occur */ 1431 printf("%s: BBB bulk-in clear stall failed, %s\n", 1432 device_xname(sc->sc_dev), usbd_errstr(err)); 1433 /* no error recovery, otherwise we end up in a loop */ 1434 1435 sc->transfer_state = TSTATE_BBB_RESET3; 1436 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1437 sc->transfer_xfer[XFER_BBB_RESET3]); 1438 1439 return; 1440 case TSTATE_BBB_RESET3: 1441 if (err) /* should not occur */ 1442 printf("%s: BBB bulk-out 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_IDLE; 1447 if (sc->transfer_priv) { 1448 sc->transfer_cb(sc, sc->transfer_priv, 1449 sc->transfer_datalen, 1450 sc->transfer_status); 1451 } 1452 1453 return; 1454 1455 /***** Default *****/ 1456 default: 1457 panic("%s: Unknown state %d", 1458 device_xname(sc->sc_dev), sc->transfer_state); 1459 } 1460 } 1461 1462 /* 1463 * Command/Bulk/Interrupt (CBI) specific functions 1464 */ 1465 1466 Static int 1467 umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, int flags, 1468 struct usbd_xfer *xfer) 1469 { 1470 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1471 "sc->sc_wire == 0x%02x wrong for umass_cbi_adsc\n", 1472 sc->sc_wire); 1473 1474 if ((sc->sc_cmd == UMASS_CPROTO_RBC) && 1475 (sc->sc_quirks & UMASS_QUIRK_RBC_PAD_TO_12) != 0 && buflen < 12) { 1476 (void)memset(buffer + buflen, 0, 12 - buflen); 1477 buflen = 12; 1478 } 1479 1480 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1481 sc->sc_req.bRequest = UR_CBI_ADSC; 1482 USETW(sc->sc_req.wValue, 0); 1483 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 1484 USETW(sc->sc_req.wLength, buflen); 1485 return umass_setup_ctrl_transfer(sc, &sc->sc_req, buffer, 1486 buflen, flags, xfer); 1487 } 1488 1489 1490 Static void 1491 umass_cbi_reset(struct umass_softc *sc, int status) 1492 { 1493 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1494 int i; 1495 # define SEND_DIAGNOSTIC_CMDLEN 12 1496 1497 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1498 "sc->sc_wire == 0x%02x wrong for umass_cbi_reset\n", 1499 sc->sc_wire); 1500 1501 if (sc->sc_dying) 1502 return; 1503 1504 /* 1505 * Command Block Reset Protocol 1506 * 1507 * First send a reset request to the device. Then clear 1508 * any possibly stalled bulk endpoints. 1509 1510 * This is done in 3 steps, states: 1511 * TSTATE_CBI_RESET1 1512 * TSTATE_CBI_RESET2 1513 * TSTATE_CBI_RESET3 1514 * 1515 * If the reset doesn't succeed, the device should be port reset. 1516 */ 1517 1518 DPRINTFM(UDMASS_CBI, "sc %p: CBI Reset", sc, 0, 0, 0); 1519 1520 /* CTASSERT */ 1521 KASSERTMSG(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN, 1522 "%s: CBL struct is too small (%zu < %u)\n", 1523 device_xname(sc->sc_dev), 1524 sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN); 1525 1526 sc->transfer_state = TSTATE_CBI_RESET1; 1527 sc->transfer_status = status; 1528 1529 /* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between 1530 * the two the last 10 bytes of the cbl is filled with 0xff (section 1531 * 2.2 of the CBI spec). 1532 */ 1533 sc->cbl[0] = 0x1d; /* Command Block Reset */ 1534 sc->cbl[1] = 0x04; 1535 for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++) 1536 sc->cbl[i] = 0xff; 1537 1538 umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, 0, 1539 sc->transfer_xfer[XFER_CBI_RESET1]); 1540 /* XXX if the command fails we should reset the port on the bub */ 1541 } 1542 1543 Static void 1544 umass_cbi_transfer(struct umass_softc *sc, int lun, 1545 void *cmd, int cmdlen, void *data, int datalen, int dir, 1546 u_int timeout, int flags, umass_callback cb, void *priv) 1547 { 1548 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1549 1550 DPRINTFM(UDMASS_CBI, "sc %p: cmd=0x%02x, len=%d", sc, *(u_char *)cmd, 1551 datalen, 0); 1552 1553 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1554 "sc->sc_wire == 0x%02x wrong for umass_cbi_transfer\n", 1555 sc->sc_wire); 1556 1557 if (sc->sc_dying) 1558 return; 1559 1560 /* Be a little generous. */ 1561 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 1562 1563 /* 1564 * Do a CBI transfer with cmdlen bytes from cmd, possibly 1565 * a data phase of datalen bytes from/to the device and finally a 1566 * csw read phase. 1567 * If the data direction was inbound a maximum of datalen bytes 1568 * is stored in the buffer pointed to by data. 1569 * 1570 * umass_cbi_transfer initialises the transfer and lets the state 1571 * machine in umass_cbi_state handle the completion. It uses the 1572 * following states: 1573 * TSTATE_CBI_COMMAND 1574 * -> XXX fill in 1575 * 1576 * An error in any of those states will invoke 1577 * umass_cbi_reset. 1578 */ 1579 1580 /* check the given arguments */ 1581 KASSERTMSG(datalen == 0 || data != NULL, 1582 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 1583 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 1584 "%s: direction is NONE while datalen is not zero\n", 1585 device_xname(sc->sc_dev)); 1586 1587 /* store the details for the data transfer phase */ 1588 sc->transfer_dir = dir; 1589 sc->transfer_data = data; 1590 sc->transfer_datalen = datalen; 1591 sc->transfer_actlen = 0; 1592 sc->transfer_cb = cb; 1593 sc->transfer_priv = priv; 1594 sc->transfer_status = STATUS_CMD_OK; 1595 1596 /* move from idle to the command state */ 1597 sc->transfer_state = TSTATE_CBI_COMMAND; 1598 1599 /* Send the Command Block from host to device via control endpoint. */ 1600 if (umass_cbi_adsc(sc, cmd, cmdlen, flags, 1601 sc->transfer_xfer[XFER_CBI_CB])) 1602 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1603 } 1604 1605 Static void 1606 umass_cbi_state(struct usbd_xfer *xfer, void *priv, 1607 usbd_status err) 1608 { 1609 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1610 struct umass_softc *sc = (struct umass_softc *) priv; 1611 1612 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1613 "sc->sc_wire == 0x%02x wrong for umass_cbi_state\n", 1614 sc->sc_wire); 1615 1616 if (sc->sc_dying) 1617 return; 1618 1619 /* 1620 * State handling for CBI transfers. 1621 */ 1622 1623 DPRINTFM(UDMASS_CBI, "sc %p: Handling CBI state %d, xfer=%p, ...", 1624 sc, sc->transfer_state, xfer, 0); 1625 DPRINTFM(UDMASS_CBI, "... err %d", err, 0, 0, 0); 1626 1627 switch (sc->transfer_state) { 1628 1629 /***** CBI Transfer *****/ 1630 case TSTATE_CBI_COMMAND: 1631 if (err == USBD_STALLED) { 1632 DPRINTFM(UDMASS_CBI, "sc %p: Command Transport failed", 1633 sc, 0, 0, 0); 1634 /* Status transport by control pipe (section 2.3.2.1). 1635 * The command contained in the command block failed. 1636 * 1637 * The control pipe has already been unstalled by the 1638 * USB stack. 1639 * Section 2.4.3.1.1 states that the bulk in endpoints 1640 * should not stalled at this point. 1641 */ 1642 1643 sc->transfer_state = TSTATE_IDLE; 1644 sc->transfer_cb(sc, sc->transfer_priv, 1645 sc->transfer_datalen, 1646 STATUS_CMD_FAILED); 1647 1648 return; 1649 } else if (err) { 1650 DPRINTFM(UDMASS_CBI, "sc %p: failed to send ADSC", 1651 sc, 0, 0, 0); 1652 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1653 return; 1654 } 1655 1656 /* Data transport phase, setup transfer */ 1657 sc->transfer_state = TSTATE_CBI_DATA; 1658 if (sc->transfer_dir == DIR_IN) { 1659 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1660 sc->datain_buffer, sc->transfer_datalen, 1661 USBD_SHORT_XFER_OK, 1662 sc->transfer_xfer[XFER_CBI_DATAIN])) 1663 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1664 1665 return; 1666 } else if (sc->transfer_dir == DIR_OUT) { 1667 memcpy(sc->dataout_buffer, sc->transfer_data, 1668 sc->transfer_datalen); 1669 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1670 sc->dataout_buffer, sc->transfer_datalen, 1671 0, /* fixed length transfer */ 1672 sc->transfer_xfer[XFER_CBI_DATAOUT])) 1673 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1674 1675 return; 1676 } else { 1677 DPRINTFM(UDMASS_CBI, "sc %p: no data phase", sc, 0, 0, 1678 0); 1679 } 1680 1681 /* FALLTHROUGH if no data phase, err == 0 */ 1682 case TSTATE_CBI_DATA: 1683 /* Command transport phase error handling (ignored if no data 1684 * phase (fallthrough from previous state)) */ 1685 if (sc->transfer_dir != DIR_NONE) { 1686 /* retrieve the length of the transfer that was done */ 1687 usbd_get_xfer_status(xfer, NULL, NULL, 1688 &sc->transfer_actlen, NULL); 1689 DPRINTFM(UDMASS_CBI, "sc %p: CBI_DATA actlen=%d", 1690 sc, sc->transfer_actlen, 0, 0); 1691 1692 if (err) { 1693 DPRINTFM(UDMASS_CBI, "sc %p: Data dir %d " 1694 "err %d failed", sc, sc->transfer_dir, 1695 sc->transfer_datalen, err); 1696 1697 if (err == USBD_STALLED) { 1698 sc->transfer_state = TSTATE_CBI_DCLEAR; 1699 umass_clear_endpoint_stall(sc, 1700 (sc->transfer_dir == DIR_IN? 1701 UMASS_BULKIN:UMASS_BULKOUT), 1702 sc->transfer_xfer[XFER_CBI_DCLEAR]); 1703 } else { 1704 /* Unless the error is a pipe stall the 1705 * error is fatal. 1706 */ 1707 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1708 } 1709 return; 1710 } 1711 } 1712 1713 if (sc->transfer_dir == DIR_IN) 1714 memcpy(sc->transfer_data, sc->datain_buffer, 1715 sc->transfer_actlen); 1716 1717 DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN) 1718 umass_dump_buffer(sc, sc->transfer_data, 1719 sc->transfer_actlen, 48)); 1720 1721 /* Status phase */ 1722 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 1723 sc->transfer_state = TSTATE_CBI_STATUS; 1724 memset(&sc->sbl, 0, sizeof(sc->sbl)); 1725 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_INTRIN], 1726 &sc->sbl, sizeof(sc->sbl), 1727 0, /* fixed length transfer */ 1728 sc->transfer_xfer[XFER_CBI_STATUS])) 1729 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1730 } else { 1731 /* No command completion interrupt. Request 1732 * sense to get status of command. 1733 */ 1734 sc->transfer_state = TSTATE_IDLE; 1735 sc->transfer_cb(sc, sc->transfer_priv, 1736 sc->transfer_datalen - sc->transfer_actlen, 1737 STATUS_CMD_UNKNOWN); 1738 } 1739 return; 1740 1741 case TSTATE_CBI_STATUS: 1742 if (err) { 1743 DPRINTFM(UDMASS_CBI, "sc %p: Status Transport failed", 1744 sc, 0, 0, 0); 1745 /* Status transport by interrupt pipe (section 2.3.2.2). 1746 */ 1747 1748 if (err == USBD_STALLED) { 1749 sc->transfer_state = TSTATE_CBI_SCLEAR; 1750 umass_clear_endpoint_stall(sc, UMASS_INTRIN, 1751 sc->transfer_xfer[XFER_CBI_SCLEAR]); 1752 } else { 1753 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1754 } 1755 return; 1756 } 1757 1758 /* Dissect the information in the buffer */ 1759 1760 { 1761 uint32_t actlen; 1762 usbd_get_xfer_status(xfer,NULL,NULL,&actlen,NULL); 1763 DPRINTFM(UDMASS_CBI, "sc %p: CBI_STATUS actlen=%d", 1764 sc, actlen, 0, 0); 1765 if (actlen != 2) 1766 break; 1767 } 1768 1769 if (sc->sc_cmd == UMASS_CPROTO_UFI) { 1770 int status; 1771 1772 /* Section 3.4.3.1.3 specifies that the UFI command 1773 * protocol returns an ASC and ASCQ in the interrupt 1774 * data block. 1775 */ 1776 1777 DPRINTFM(UDMASS_CBI, "sc %p: UFI CCI, ASC = 0x%02x, " 1778 "ASCQ = 0x%02x", sc, sc->sbl.ufi.asc, 1779 sc->sbl.ufi.ascq, 0); 1780 1781 if ((sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) || 1782 sc->sc_sense) 1783 status = STATUS_CMD_OK; 1784 else 1785 status = STATUS_CMD_FAILED; 1786 1787 /* No autosense, command successful */ 1788 sc->transfer_state = TSTATE_IDLE; 1789 sc->transfer_cb(sc, sc->transfer_priv, 1790 sc->transfer_datalen - sc->transfer_actlen, status); 1791 } else { 1792 int status; 1793 1794 /* Command Interrupt Data Block */ 1795 1796 DPRINTFM(UDMASS_CBI, "sc %p: type=0x%02x, value=0x%02x", 1797 sc, sc->sbl.common.type, sc->sbl.common.value, 0); 1798 1799 if (sc->sbl.common.type == IDB_TYPE_CCI) { 1800 switch (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) { 1801 case IDB_VALUE_PASS: 1802 status = STATUS_CMD_OK; 1803 break; 1804 case IDB_VALUE_FAIL: 1805 case IDB_VALUE_PERSISTENT: 1806 status = STATUS_CMD_FAILED; 1807 break; 1808 case IDB_VALUE_PHASE: 1809 default: /* XXX: gcc */ 1810 status = STATUS_WIRE_FAILED; 1811 break; 1812 } 1813 1814 sc->transfer_state = TSTATE_IDLE; 1815 sc->transfer_cb(sc, sc->transfer_priv, 1816 sc->transfer_datalen - sc->transfer_actlen, 1817 status); 1818 } 1819 } 1820 return; 1821 1822 case TSTATE_CBI_DCLEAR: 1823 if (err) { /* should not occur */ 1824 printf("%s: CBI bulk-%s stall clear failed, %s\n", 1825 device_xname(sc->sc_dev), 1826 (sc->transfer_dir == DIR_IN? "in":"out"), 1827 usbd_errstr(err)); 1828 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1829 } else { 1830 sc->transfer_state = TSTATE_IDLE; 1831 sc->transfer_cb(sc, sc->transfer_priv, 1832 sc->transfer_datalen, STATUS_CMD_FAILED); 1833 } 1834 return; 1835 1836 case TSTATE_CBI_SCLEAR: 1837 if (err) { /* should not occur */ 1838 printf("%s: CBI intr-in stall clear failed, %s\n", 1839 device_xname(sc->sc_dev), usbd_errstr(err)); 1840 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1841 } else { 1842 sc->transfer_state = TSTATE_IDLE; 1843 sc->transfer_cb(sc, sc->transfer_priv, 1844 sc->transfer_datalen, STATUS_CMD_FAILED); 1845 } 1846 return; 1847 1848 /***** CBI Reset *****/ 1849 case TSTATE_CBI_RESET1: 1850 if (err) 1851 printf("%s: CBI reset failed, %s\n", 1852 device_xname(sc->sc_dev), usbd_errstr(err)); 1853 1854 sc->transfer_state = TSTATE_CBI_RESET2; 1855 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1856 sc->transfer_xfer[XFER_CBI_RESET2]); 1857 1858 return; 1859 case TSTATE_CBI_RESET2: 1860 if (err) /* should not occur */ 1861 printf("%s: CBI bulk-in stall clear failed, %s\n", 1862 device_xname(sc->sc_dev), usbd_errstr(err)); 1863 /* no error recovery, otherwise we end up in a loop */ 1864 1865 sc->transfer_state = TSTATE_CBI_RESET3; 1866 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1867 sc->transfer_xfer[XFER_CBI_RESET3]); 1868 1869 return; 1870 case TSTATE_CBI_RESET3: 1871 if (err) /* should not occur */ 1872 printf("%s: CBI bulk-out 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_IDLE; 1877 if (sc->transfer_priv) { 1878 sc->transfer_cb(sc, sc->transfer_priv, 1879 sc->transfer_datalen, 1880 sc->transfer_status); 1881 } 1882 1883 return; 1884 1885 1886 /***** Default *****/ 1887 default: 1888 panic("%s: Unknown state %d", 1889 device_xname(sc->sc_dev), sc->transfer_state); 1890 } 1891 } 1892 1893 usbd_status 1894 umass_bbb_get_max_lun(struct umass_softc *sc, uint8_t *maxlun) 1895 { 1896 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1897 usb_device_request_t req; 1898 usbd_status err; 1899 1900 *maxlun = 0; /* Default to 0. */ 1901 1902 DPRINTFM(UDMASS_BBB, "sc %p: Get Max Lun", sc, 0, 0, 0); 1903 1904 /* The Get Max Lun command is a class-specific request. */ 1905 req.bmRequestType = UT_READ_CLASS_INTERFACE; 1906 req.bRequest = UR_BBB_GET_MAX_LUN; 1907 USETW(req.wValue, 0); 1908 USETW(req.wIndex, sc->sc_ifaceno); 1909 USETW(req.wLength, 1); 1910 1911 err = usbd_do_request_flags(sc->sc_udev, &req, maxlun, 1912 USBD_SHORT_XFER_OK, 0, USBD_DEFAULT_TIMEOUT); 1913 switch (err) { 1914 case USBD_NORMAL_COMPLETION: 1915 DPRINTFM(UDMASS_BBB, "sc %p: Max Lun %d", sc, *maxlun , 0, 0); 1916 break; 1917 1918 case USBD_STALLED: 1919 /* 1920 * Device doesn't support Get Max Lun request. 1921 */ 1922 err = USBD_NORMAL_COMPLETION; 1923 DPRINTFM(UDMASS_BBB, "sc %p: Get Max Lun not supported", sc, 1924 0, 0, 0); 1925 break; 1926 1927 case USBD_SHORT_XFER: 1928 /* 1929 * XXX This must mean Get Max Lun is not supported, too! 1930 */ 1931 err = USBD_NORMAL_COMPLETION; 1932 DPRINTFM(UDMASS_BBB, "sc %p: Get Max Lun SHORT_XFER", sc, 0, 0, 1933 0); 1934 break; 1935 1936 default: 1937 printf("%s: Get Max Lun failed: %s\n", 1938 device_xname(sc->sc_dev), usbd_errstr(err)); 1939 /* XXX Should we port_reset the device? */ 1940 break; 1941 } 1942 1943 return err; 1944 } 1945 1946 1947 1948 1949 #ifdef UMASS_DEBUG 1950 Static void 1951 umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw) 1952 { 1953 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1954 int clen = cbw->bCDBLength; 1955 int dlen = UGETDW(cbw->dCBWDataTransferLength); 1956 uint8_t *c = cbw->CBWCDB; 1957 int tag = UGETDW(cbw->dCBWTag); 1958 int flags = cbw->bCBWFlags; 1959 1960 DPRINTFM(UDMASS_BBB, "sc %p: CBW %d: cmdlen=%d", sc, tag, clen, 0); 1961 DPRINTFM(UDMASS_BBB, " 0x%02x%02x%02x%02x...", c[0], c[1], c[2], c[3]); 1962 DPRINTFM(UDMASS_BBB, " 0x%02x%02x%02x%02x...", c[4], c[5], c[6], c[7]); 1963 DPRINTFM(UDMASS_BBB, " 0x%02x%02x...", c[8], c[9], 0, 0); 1964 DPRINTFM(UDMASS_BBB, " data = %d bytes, flags = %x", dlen, flags, 0, 1965 0); 1966 } 1967 1968 Static void 1969 umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw) 1970 { 1971 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1972 int sig = UGETDW(csw->dCSWSignature); 1973 int tag = UGETDW(csw->dCSWTag); 1974 int res = UGETDW(csw->dCSWDataResidue); 1975 int status = csw->bCSWStatus; 1976 1977 DPRINTFM(UDMASS_BBB, "sc %p: CSW %d: sig = 0x%08x, tag = %d", sc, tag, 1978 sig, tag); 1979 DPRINTFM(UDMASS_BBB, " res = %d, status = 0x%02x", res, status, 0, 0); 1980 } 1981 1982 Static void 1983 umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, int buflen, 1984 int printlen) 1985 { 1986 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1987 int i; 1988 1989 DPRINTFM(UDMASS_GEN, "sc %p: buffer %p", sc, buffer, 0, 0); 1990 for (i = 0; i < buflen && i < printlen;) { 1991 if (i + 3 < buflen && i + 3 < printlen) { 1992 DPRINTFM(UDMASS_GEN, " 0x%02x%02x%02x%02x", 1993 buffer[i], buffer[i + 1], 1994 buffer[i + 2], buffer[i + 3]); 1995 i += 4; 1996 } else if (i + 2 < buflen && i + 2 < printlen) { 1997 DPRINTFM(UDMASS_GEN, " 0x%02x%02x%02x", 1998 buffer[i], buffer[i + 1], buffer[i + 2], 0); 1999 i += 3; 2000 } else if (i + 1 < buflen && i + 2 < printlen) { 2001 DPRINTFM(UDMASS_GEN, " 0x%02x%02x", 2002 buffer[i], buffer[i + 1], 0, 0); 2003 i += 2; 2004 } else { 2005 DPRINTFM(UDMASS_GEN, " 0x%02x", buffer[i], 0, 0, 0); 2006 i += 1; 2007 } 2008 } 2009 } 2010 #endif 2011
Indexes created Tue Oct 14 06:10:07 GMT 2025