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