umass.c revision 1.172
1 /* $NetBSD: umass.c,v 1.172 2019/02/07 13:43:44 skrll Exp $ */ 2 3 /* 4 * Copyright (c) 2003 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Charles M. Hannum. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /*- 33 * Copyright (c) 1999 MAEKAWA Masahide <bishop (at) rr.iij4u.or.jp>, 34 * Nick Hibma <n_hibma (at) freebsd.org> 35 * All rights reserved. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 40 * 1. Redistributions of source code must retain the above copyright 41 * notice, this list of conditions and the following disclaimer. 42 * 2. Redistributions in binary form must reproduce the above copyright 43 * notice, this list of conditions and the following disclaimer in the 44 * documentation and/or other materials provided with the distribution. 45 * 46 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 49 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 56 * SUCH DAMAGE. 57 * 58 * $FreeBSD: src/sys/dev/usb/umass.c,v 1.13 2000/03/26 01:39:12 n_hibma Exp $ 59 */ 60 61 /* 62 * Universal Serial Bus Mass Storage Class specs: 63 * http://www.usb.org/developers/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 sleeping in interrupt context which is prohibited (for example after a 112 * failed 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.172 2019/02/07 13:43:44 skrll Exp $"); 128 129 #ifdef _KERNEL_OPT 130 #include "opt_usb.h" 131 #endif 132 133 #include "atapibus.h" 134 #include "scsibus.h" 135 #include "wd.h" 136 137 #include <sys/param.h> 138 #include <sys/buf.h> 139 #include <sys/conf.h> 140 #include <sys/device.h> 141 #include <sys/kernel.h> 142 #include <sys/malloc.h> 143 #include <sys/sysctl.h> 144 #include <sys/systm.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 *, umass_bbb_cbw_t *); 275 Static void umass_bbb_dump_csw(struct umass_softc *, umass_bbb_csw_t *); 276 Static void umass_dump_buffer(struct umass_softc *, uint8_t *, int, int); 277 #endif 278 279 280 /* 281 * USB device probe/attach/detach 282 */ 283 284 int 285 umass_match(device_t parent, cfdata_t match, void *aux) 286 { 287 struct usbif_attach_arg *uiaa = aux; 288 const struct umass_quirk *quirk; 289 290 quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product); 291 if (quirk != NULL && quirk->uq_match != UMASS_QUIRK_USE_DEFAULTMATCH) 292 return quirk->uq_match; 293 294 if (uiaa->uiaa_class != UICLASS_MASS) 295 return UMATCH_NONE; 296 297 switch (uiaa->uiaa_subclass) { 298 case UISUBCLASS_RBC: 299 case UISUBCLASS_SFF8020I: 300 case UISUBCLASS_QIC157: 301 case UISUBCLASS_UFI: 302 case UISUBCLASS_SFF8070I: 303 case UISUBCLASS_SCSI: 304 break; 305 default: 306 return UMATCH_IFACECLASS; 307 } 308 309 switch (uiaa->uiaa_proto) { 310 case UIPROTO_MASS_CBI_I: 311 case UIPROTO_MASS_CBI: 312 case UIPROTO_MASS_BBB_OLD: 313 case UIPROTO_MASS_BBB: 314 break; 315 default: 316 return UMATCH_IFACECLASS_IFACESUBCLASS; 317 } 318 319 return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO; 320 } 321 322 void 323 umass_attach(device_t parent, device_t self, void *aux) 324 { 325 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 326 struct umass_softc *sc = device_private(self); 327 struct usbif_attach_arg *uiaa = aux; 328 const struct umass_quirk *quirk; 329 usb_interface_descriptor_t *id; 330 usb_endpoint_descriptor_t *ed; 331 const char *sWire, *sCommand; 332 char *devinfop; 333 usbd_status err; 334 int i, error; 335 336 sc->sc_dev = self; 337 338 aprint_naive("\n"); 339 aprint_normal("\n"); 340 341 mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB); 342 cv_init(&sc->sc_detach_cv, "umassdet"); 343 344 devinfop = usbd_devinfo_alloc(uiaa->uiaa_device, 0); 345 aprint_normal_dev(self, "%s\n", devinfop); 346 usbd_devinfo_free(devinfop); 347 348 sc->sc_udev = uiaa->uiaa_device; 349 sc->sc_iface = uiaa->uiaa_iface; 350 sc->sc_ifaceno = uiaa->uiaa_ifaceno; 351 352 quirk = umass_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product); 353 if (quirk != NULL) { 354 sc->sc_wire = quirk->uq_wire; 355 sc->sc_cmd = quirk->uq_cmd; 356 sc->sc_quirks = quirk->uq_flags; 357 sc->sc_busquirks = quirk->uq_busquirks; 358 359 if (quirk->uq_fixup != NULL) 360 (*quirk->uq_fixup)(sc); 361 } else { 362 sc->sc_wire = UMASS_WPROTO_UNSPEC; 363 sc->sc_cmd = UMASS_CPROTO_UNSPEC; 364 sc->sc_quirks = 0; 365 sc->sc_busquirks = 0; 366 } 367 368 if (sc->sc_wire == UMASS_WPROTO_UNSPEC) { 369 switch (uiaa->uiaa_proto) { 370 case UIPROTO_MASS_CBI: 371 sc->sc_wire = UMASS_WPROTO_CBI; 372 break; 373 case UIPROTO_MASS_CBI_I: 374 sc->sc_wire = UMASS_WPROTO_CBI_I; 375 break; 376 case UIPROTO_MASS_BBB: 377 case UIPROTO_MASS_BBB_OLD: 378 sc->sc_wire = UMASS_WPROTO_BBB; 379 break; 380 default: 381 DPRINTFM(UDMASS_GEN, "Unsupported wire protocol %ju", 382 uiaa->uiaa_proto, 0, 0, 0); 383 return; 384 } 385 } 386 387 if (sc->sc_cmd == UMASS_CPROTO_UNSPEC) { 388 switch (uiaa->uiaa_subclass) { 389 case UISUBCLASS_SCSI: 390 sc->sc_cmd = UMASS_CPROTO_SCSI; 391 break; 392 case UISUBCLASS_UFI: 393 sc->sc_cmd = UMASS_CPROTO_UFI; 394 break; 395 case UISUBCLASS_SFF8020I: 396 case UISUBCLASS_SFF8070I: 397 case UISUBCLASS_QIC157: 398 sc->sc_cmd = UMASS_CPROTO_ATAPI; 399 break; 400 case UISUBCLASS_RBC: 401 sc->sc_cmd = UMASS_CPROTO_RBC; 402 break; 403 default: 404 DPRINTFM(UDMASS_GEN, "Unsupported command protocol %ju", 405 uiaa->uiaa_subclass, 0, 0, 0); 406 return; 407 } 408 } 409 410 switch (sc->sc_wire) { 411 case UMASS_WPROTO_CBI: 412 sWire = "CBI"; 413 break; 414 case UMASS_WPROTO_CBI_I: 415 sWire = "CBI with CCI"; 416 break; 417 case UMASS_WPROTO_BBB: 418 sWire = "Bulk-Only"; 419 break; 420 default: 421 sWire = "unknown"; 422 break; 423 } 424 425 switch (sc->sc_cmd) { 426 case UMASS_CPROTO_RBC: 427 sCommand = "RBC"; 428 break; 429 case UMASS_CPROTO_SCSI: 430 sCommand = "SCSI"; 431 break; 432 case UMASS_CPROTO_UFI: 433 sCommand = "UFI"; 434 break; 435 case UMASS_CPROTO_ATAPI: 436 sCommand = "ATAPI"; 437 break; 438 case UMASS_CPROTO_ISD_ATA: 439 sCommand = "ISD-ATA"; 440 break; 441 default: 442 sCommand = "unknown"; 443 break; 444 } 445 446 aprint_verbose_dev(self, "using %s over %s\n", sCommand, sWire); 447 448 if (quirk != NULL && quirk->uq_init != NULL) { 449 err = (*quirk->uq_init)(sc); 450 if (err) { 451 aprint_error_dev(self, "quirk init failed\n"); 452 umass_disco(sc); 453 return; 454 } 455 } 456 457 /* 458 * In addition to the Control endpoint the following endpoints 459 * are required: 460 * a) bulk-in endpoint. 461 * b) bulk-out endpoint. 462 * and for Control/Bulk/Interrupt with CCI (CBI_I) 463 * c) intr-in 464 * 465 * The endpoint addresses are not fixed, so we have to read them 466 * from the device descriptors of the current interface. 467 */ 468 id = usbd_get_interface_descriptor(sc->sc_iface); 469 for (i = 0 ; i < id->bNumEndpoints ; i++) { 470 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 471 if (ed == NULL) { 472 aprint_error_dev(self, 473 "could not read endpoint descriptor\n"); 474 return; 475 } 476 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN 477 && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 478 sc->sc_epaddr[UMASS_BULKIN] = ed->bEndpointAddress; 479 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT 480 && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 481 sc->sc_epaddr[UMASS_BULKOUT] = ed->bEndpointAddress; 482 } else if (sc->sc_wire == UMASS_WPROTO_CBI_I 483 && UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN 484 && (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) { 485 sc->sc_epaddr[UMASS_INTRIN] = ed->bEndpointAddress; 486 #ifdef UMASS_DEBUG 487 if (UGETW(ed->wMaxPacketSize) > 2) { 488 DPRINTFM(UDMASS_CBI, "sc %#jx intr size is %jd", 489 (uintptr_t)sc, UGETW(ed->wMaxPacketSize), 490 0, 0); 491 } 492 #endif 493 } 494 } 495 496 /* check whether we found all the endpoints we need */ 497 if (!sc->sc_epaddr[UMASS_BULKIN] || !sc->sc_epaddr[UMASS_BULKOUT] || 498 (sc->sc_wire == UMASS_WPROTO_CBI_I && 499 !sc->sc_epaddr[UMASS_INTRIN])) { 500 aprint_error_dev(self, "endpoint not found %u/%u/%u\n", 501 sc->sc_epaddr[UMASS_BULKIN], 502 sc->sc_epaddr[UMASS_BULKOUT], 503 sc->sc_epaddr[UMASS_INTRIN]); 504 return; 505 } 506 507 /* 508 * Get the maximum LUN supported by the device. 509 */ 510 if (sc->sc_wire == UMASS_WPROTO_BBB && 511 (sc->sc_quirks & UMASS_QUIRK_NOGETMAXLUN) == 0) { 512 err = umass_bbb_get_max_lun(sc, &sc->maxlun); 513 if (err) { 514 aprint_error_dev(self, "unable to get Max Lun: %s\n", 515 usbd_errstr(err)); 516 return; 517 } 518 if (sc->maxlun > 0) 519 sc->sc_busquirks |= PQUIRK_FORCELUNS; 520 } else { 521 sc->maxlun = 0; 522 } 523 524 /* Open the bulk-in and -out pipe */ 525 DPRINTFM(UDMASS_USB, "sc %#jx: opening iface %#jx epaddr %jd for " 526 "BULKOUT", (uintptr_t)sc, (uintptr_t)sc->sc_iface, 527 sc->sc_epaddr[UMASS_BULKOUT], 0); 528 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKOUT], 529 USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKOUT]); 530 if (err) { 531 aprint_error_dev(self, "cannot open %u-out pipe (bulk)\n", 532 sc->sc_epaddr[UMASS_BULKOUT]); 533 umass_disco(sc); 534 return; 535 } 536 DPRINTFM(UDMASS_USB, "sc %#jx: opening iface %#jx epaddr %jd for " 537 "BULKIN", (uintptr_t)sc, (uintptr_t)sc->sc_iface, 538 sc->sc_epaddr[UMASS_BULKIN], 0); 539 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN], 540 USBD_EXCLUSIVE_USE | USBD_MPSAFE, &sc->sc_pipe[UMASS_BULKIN]); 541 if (err) { 542 aprint_error_dev(self, "could not open %u-in pipe (bulk)\n", 543 sc->sc_epaddr[UMASS_BULKIN]); 544 umass_disco(sc); 545 return; 546 } 547 /* 548 * Open the intr-in pipe if the protocol is CBI with CCI. 549 * Note: early versions of the Zip drive do have an interrupt pipe, but 550 * this pipe is unused 551 * 552 * We do not open the interrupt pipe as an interrupt pipe, but as a 553 * normal bulk endpoint. We send an IN transfer down the wire at the 554 * appropriate time, because we know exactly when to expect data on 555 * that endpoint. This saves bandwidth, but more important, makes the 556 * code for handling the data on that endpoint simpler. No data 557 * arriving concurrently. 558 */ 559 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 560 DPRINTFM(UDMASS_USB, 561 "sc %#jx: opening iface %#jx epaddr %jd for INTRIN", 562 (uintptr_t)sc, (uintptr_t)sc->sc_iface, 563 sc->sc_epaddr[UMASS_INTRIN], 0); 564 err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN], 565 USBD_EXCLUSIVE_USE | USBD_MPSAFE, &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 pointers 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 && NATABUS > 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 %#jx: Attach finished", (uintptr_t)sc, 776 0, 0, 0); 777 778 return; 779 } 780 781 static void 782 umass_childdet(device_t self, device_t child) 783 { 784 struct umass_softc *sc = device_private(self); 785 786 KASSERTMSG(child == sc->bus->sc_child, 787 "assertion child == sc->bus->sc_child failed\n"); 788 sc->bus->sc_child = NULL; 789 } 790 791 int 792 umass_detach(device_t self, int flags) 793 { 794 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 795 struct umass_softc *sc = device_private(self); 796 struct umassbus_softc *scbus; 797 int rv = 0, i; 798 799 DPRINTFM(UDMASS_USB, "sc %#jx detached", (uintptr_t)sc, 0, 0, 0); 800 801 mutex_enter(&sc->sc_lock); 802 sc->sc_dying = true; 803 mutex_exit(&sc->sc_lock); 804 805 pmf_device_deregister(self); 806 807 /* Abort the pipes to wake up any waiting processes. */ 808 for (i = 0 ; i < UMASS_NEP ; i++) { 809 if (sc->sc_pipe[i] != NULL) 810 usbd_abort_pipe(sc->sc_pipe[i]); 811 } 812 813 /* Do we really need reference counting? Perhaps in ioctl() */ 814 mutex_enter(&sc->sc_lock); 815 if (--sc->sc_refcnt >= 0) { 816 #ifdef DIAGNOSTIC 817 aprint_normal_dev(self, "waiting for refcnt\n"); 818 #endif 819 /* Wait for processes to go away. */ 820 if (cv_timedwait(&sc->sc_detach_cv, &sc->sc_lock, hz * 60)) 821 aprint_error_dev(self, ": didn't detach\n"); 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 830 switch (sc->sc_cmd) { 831 case UMASS_CPROTO_ISD_ATA: 832 #if NWD > 0 833 umass_isdata_detach(sc); 834 #else 835 aprint_error_dev(self, "isdata not configured\n"); 836 #endif 837 break; 838 839 default: 840 /* nothing to do */ 841 break; 842 } 843 844 free(scbus, M_DEVBUF); 845 sc->bus = NULL; 846 } 847 848 if (rv != 0) 849 return rv; 850 851 umass_disco(sc); 852 853 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev); 854 855 mutex_destroy(&sc->sc_lock); 856 cv_destroy(&sc->sc_detach_cv); 857 858 return rv; 859 } 860 861 int 862 umass_activate(device_t dev, enum devact act) 863 { 864 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 865 struct umass_softc *sc = device_private(dev); 866 867 DPRINTFM(UDMASS_USB, "sc %#jx act %jd", (uintptr_t)sc, act, 0, 0); 868 869 switch (act) { 870 case DVACT_DEACTIVATE: 871 sc->sc_dying = 1; 872 return 0; 873 default: 874 return EOPNOTSUPP; 875 } 876 } 877 878 Static void 879 umass_disco(struct umass_softc *sc) 880 { 881 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 882 int i; 883 884 /* Remove all the pipes. */ 885 for (i = 0 ; i < UMASS_NEP ; i++) { 886 if (sc->sc_pipe[i] != NULL) { 887 usbd_abort_pipe(sc->sc_pipe[i]); 888 } 889 } 890 891 /* Some xfers may be queued in the default pipe */ 892 usbd_abort_default_pipe(sc->sc_udev); 893 894 /* Free the xfers. */ 895 for (i = 0; i < XFER_NR; i++) { 896 if (sc->transfer_xfer[i] != NULL) { 897 usbd_destroy_xfer(sc->transfer_xfer[i]); 898 sc->transfer_xfer[i] = NULL; 899 } 900 } 901 902 for (i = 0 ; i < UMASS_NEP ; i++) { 903 if (sc->sc_pipe[i] != NULL) { 904 usbd_close_pipe(sc->sc_pipe[i]); 905 sc->sc_pipe[i] = NULL; 906 } 907 } 908 909 } 910 911 /* 912 * Generic functions to handle transfers 913 */ 914 915 Static usbd_status 916 umass_setup_transfer(struct umass_softc *sc, struct usbd_pipe *pipe, 917 void *buffer, int buflen, int flags, 918 struct usbd_xfer *xfer) 919 { 920 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 921 usbd_status err; 922 923 if (sc->sc_dying) 924 return USBD_IOERROR; 925 926 /* Initialiase a USB transfer and then schedule it */ 927 928 usbd_setup_xfer(xfer, sc, buffer, buflen, flags, sc->timeout, 929 sc->sc_methods->wire_state); 930 931 err = usbd_transfer(xfer); 932 DPRINTFM(UDMASS_XFER, "start xfer buffer=%#jx buflen=%jd flags=0x%jx " 933 "timeout=%d", (uintptr_t)buffer, buflen, flags, sc->timeout); 934 if (err && err != USBD_IN_PROGRESS) { 935 DPRINTFM(UDMASS_BBB, "failed to setup transfer... err=%jd", 936 err, 0, 0, 0); 937 return err; 938 } 939 940 return USBD_NORMAL_COMPLETION; 941 } 942 943 944 Static usbd_status 945 umass_setup_ctrl_transfer(struct umass_softc *sc, usb_device_request_t *req, 946 void *buffer, int buflen, int flags, struct usbd_xfer *xfer) 947 { 948 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 949 usbd_status err; 950 951 if (sc->sc_dying) 952 return USBD_IOERROR; 953 954 /* Initialiase a USB control transfer and then schedule it */ 955 956 usbd_setup_default_xfer(xfer, sc->sc_udev, (void *) sc, sc->timeout, 957 req, buffer, buflen, flags, sc->sc_methods->wire_state); 958 959 err = usbd_transfer(xfer); 960 if (err && err != USBD_IN_PROGRESS) { 961 DPRINTFM(UDMASS_BBB, "failed to setup ctrl transfer... err=%jd", 962 err, 0, 0, 0); 963 964 /* do not reset, as this would make us loop */ 965 return err; 966 } 967 968 return USBD_NORMAL_COMPLETION; 969 } 970 971 Static void 972 umass_clear_endpoint_stall(struct umass_softc *sc, int endpt, 973 struct usbd_xfer *xfer) 974 { 975 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 976 977 if (sc->sc_dying) 978 return; 979 980 DPRINTFM(UDMASS_BBB, "Clear endpoint 0x%02jx stall", 981 sc->sc_epaddr[endpt], 0, 0, 0); 982 983 usbd_clear_endpoint_toggle(sc->sc_pipe[endpt]); 984 985 sc->sc_req.bmRequestType = UT_WRITE_ENDPOINT; 986 sc->sc_req.bRequest = UR_CLEAR_FEATURE; 987 USETW(sc->sc_req.wValue, UF_ENDPOINT_HALT); 988 USETW(sc->sc_req.wIndex, sc->sc_epaddr[endpt]); 989 USETW(sc->sc_req.wLength, 0); 990 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, xfer); 991 } 992 993 #if 0 994 Static void 995 umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv) 996 { 997 sc->transfer_cb = cb; 998 sc->transfer_priv = priv; 999 1000 /* The reset is a forced reset, so no error (yet) */ 1001 sc->reset(sc, STATUS_CMD_OK); 1002 } 1003 #endif 1004 1005 /* 1006 * Bulk protocol specific functions 1007 */ 1008 1009 Static void 1010 umass_bbb_reset(struct umass_softc *sc, int status) 1011 { 1012 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1013 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1014 "sc->sc_wire == 0x%02x wrong for umass_bbb_reset\n", 1015 sc->sc_wire); 1016 1017 if (sc->sc_dying) 1018 return; 1019 1020 /* 1021 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class) 1022 * 1023 * For Reset Recovery the host shall issue in the following order: 1024 * a) a Bulk-Only Mass Storage Reset 1025 * b) a Clear Feature HALT to the Bulk-In endpoint 1026 * c) a Clear Feature HALT to the Bulk-Out endpoint 1027 * 1028 * This is done in 3 steps, states: 1029 * TSTATE_BBB_RESET1 1030 * TSTATE_BBB_RESET2 1031 * TSTATE_BBB_RESET3 1032 * 1033 * If the reset doesn't succeed, the device should be port reset. 1034 */ 1035 1036 DPRINTFM(UDMASS_BBB, "Bulk Reset", 0, 0, 0, 0); 1037 1038 sc->transfer_state = TSTATE_BBB_RESET1; 1039 sc->transfer_status = status; 1040 1041 /* reset is a class specific interface write */ 1042 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1043 sc->sc_req.bRequest = UR_BBB_RESET; 1044 USETW(sc->sc_req.wValue, 0); 1045 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 1046 USETW(sc->sc_req.wLength, 0); 1047 umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, 1048 sc->transfer_xfer[XFER_BBB_RESET1]); 1049 } 1050 1051 Static void 1052 umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen, 1053 void *data, int datalen, int dir, u_int timeout, 1054 int flags, umass_callback cb, void *priv) 1055 { 1056 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1057 static int dCBWtag = 42; /* unique for CBW of transfer */ 1058 1059 DPRINTFM(UDMASS_BBB, "sc %#jx cmd=0x%02jx", (uintptr_t)sc, 1060 *(u_char *)cmd, 0, 0); 1061 1062 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1063 "sc->sc_wire == 0x%02x wrong for umass_bbb_transfer\n", 1064 sc->sc_wire); 1065 1066 if (sc->sc_dying) 1067 return; 1068 1069 /* Be a little generous. */ 1070 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 1071 1072 /* 1073 * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly 1074 * a data phase of datalen bytes from/to the device and finally a 1075 * csw read phase. 1076 * If the data direction was inbound a maximum of datalen bytes 1077 * is stored in the buffer pointed to by data. 1078 * 1079 * umass_bbb_transfer initialises the transfer and lets the state 1080 * machine in umass_bbb_state handle the completion. It uses the 1081 * following states: 1082 * TSTATE_BBB_COMMAND 1083 * -> TSTATE_BBB_DATA 1084 * -> TSTATE_BBB_STATUS 1085 * -> TSTATE_BBB_STATUS2 1086 * -> TSTATE_BBB_IDLE 1087 * 1088 * An error in any of those states will invoke 1089 * umass_bbb_reset. 1090 */ 1091 1092 /* check the given arguments */ 1093 KASSERTMSG(datalen == 0 || data != NULL, 1094 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 1095 KASSERTMSG(cmdlen <= CBWCDBLENGTH, 1096 "%s: cmdlen exceeds CDB length in CBW (%d > %d)", 1097 device_xname(sc->sc_dev), cmdlen, CBWCDBLENGTH); 1098 KASSERTMSG(dir == DIR_NONE || datalen > 0, 1099 "%s: datalen == 0 while direction is not NONE\n", 1100 device_xname(sc->sc_dev)); 1101 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 1102 "%s: direction is NONE while datalen is not zero\n", 1103 device_xname(sc->sc_dev)); 1104 /* CTASSERT */ 1105 KASSERTMSG(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE, 1106 "%s: CBW struct does not have the right size (%zu vs. %u)\n", 1107 device_xname(sc->sc_dev), 1108 sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE); 1109 /* CTASSERT */ 1110 KASSERTMSG(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE, 1111 "%s: CSW struct does not have the right size (%zu vs. %u)\n", 1112 device_xname(sc->sc_dev), 1113 sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE); 1114 1115 /* 1116 * Determine the direction of the data transfer and the length. 1117 * 1118 * dCBWDataTransferLength (datalen) : 1119 * This field indicates the number of bytes of data that the host 1120 * intends to transfer on the IN or OUT Bulk endpoint(as indicated by 1121 * the Direction bit) during the execution of this command. If this 1122 * field is set to 0, the device will expect that no data will be 1123 * transferred IN or OUT during this command, regardless of the value 1124 * of the Direction bit defined in dCBWFlags. 1125 * 1126 * dCBWFlags (dir) : 1127 * The bits of the Flags field are defined as follows: 1128 * Bits 0-6 reserved 1129 * Bit 7 Direction - this bit shall be ignored if the 1130 * dCBWDataTransferLength field is zero. 1131 * 0 = data Out from host to device 1132 * 1 = data In from device to host 1133 */ 1134 1135 /* Fill in the Command Block Wrapper */ 1136 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE); 1137 USETDW(sc->cbw.dCBWTag, dCBWtag); 1138 dCBWtag++; /* cannot be done in macro (it will be done 4 times) */ 1139 USETDW(sc->cbw.dCBWDataTransferLength, datalen); 1140 /* DIR_NONE is treated as DIR_OUT (0x00) */ 1141 sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT); 1142 sc->cbw.bCBWLUN = lun; 1143 sc->cbw.bCDBLength = cmdlen; 1144 memcpy(sc->cbw.CBWCDB, cmd, cmdlen); 1145 1146 DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw)); 1147 1148 /* store the details for the data transfer phase */ 1149 sc->transfer_dir = dir; 1150 sc->transfer_data = data; 1151 sc->transfer_datalen = datalen; 1152 sc->transfer_actlen = 0; 1153 sc->transfer_cb = cb; 1154 sc->transfer_priv = priv; 1155 sc->transfer_status = STATUS_CMD_OK; 1156 1157 /* move from idle to the command state */ 1158 sc->transfer_state = TSTATE_BBB_COMMAND; 1159 1160 /* Send the CBW from host to device via bulk-out endpoint. */ 1161 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1162 &sc->cbw, UMASS_BBB_CBW_SIZE, flags, 1163 sc->transfer_xfer[XFER_BBB_CBW])) { 1164 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1165 } 1166 } 1167 1168 1169 Static void 1170 umass_bbb_state(struct usbd_xfer *xfer, void *priv, 1171 usbd_status err) 1172 { 1173 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1174 struct umass_softc *sc = (struct umass_softc *) priv; 1175 struct usbd_xfer *next_xfer; 1176 int residue; 1177 1178 KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB, 1179 "sc->sc_wire == 0x%02x wrong for umass_bbb_state\n", 1180 sc->sc_wire); 1181 1182 /* 1183 * State handling for BBB transfers. 1184 * 1185 * The subroutine is rather long. It steps through the states given in 1186 * Annex A of the Bulk-Only specification. 1187 * Each state first does the error handling of the previous transfer 1188 * and then prepares the next transfer. 1189 * Each transfer is done asynchroneously so after the request/transfer 1190 * has been submitted you will find a 'return;'. 1191 */ 1192 1193 DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx, transfer_state %jd dir %jd", 1194 (uintptr_t)sc, (uintptr_t)xfer, sc->transfer_state, 1195 sc->transfer_dir); 1196 1197 if (err == USBD_CANCELLED) { 1198 DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx cancelled", 1199 (uintptr_t)sc, (uintptr_t)xfer, 0, 0); 1200 1201 sc->transfer_state = TSTATE_IDLE; 1202 sc->transfer_cb(sc, sc->transfer_priv, 0, STATUS_TIMEOUT); 1203 return; 1204 } 1205 1206 if (sc->sc_dying) 1207 return; 1208 1209 switch (sc->transfer_state) { 1210 1211 /***** Bulk Transfer *****/ 1212 case TSTATE_BBB_COMMAND: 1213 /* Command transport phase, error handling */ 1214 if (err) { 1215 DPRINTFM(UDMASS_BBB, "sc %#jx failed to send CBW", 1216 (uintptr_t)sc, 0, 0, 0); 1217 /* If the device detects that the CBW is invalid, then 1218 * the device may STALL both bulk endpoints and require 1219 * a Bulk-Reset 1220 */ 1221 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1222 return; 1223 } 1224 1225 /* Data transport phase, setup transfer */ 1226 sc->transfer_state = TSTATE_BBB_DATA; 1227 if (sc->transfer_dir == DIR_IN) { 1228 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1229 sc->datain_buffer, sc->transfer_datalen, 1230 USBD_SHORT_XFER_OK, 1231 sc->transfer_xfer[XFER_BBB_DATAIN])) 1232 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1233 1234 return; 1235 } else if (sc->transfer_dir == DIR_OUT) { 1236 memcpy(sc->dataout_buffer, sc->transfer_data, 1237 sc->transfer_datalen); 1238 if (umass_setup_transfer(sc, 1239 sc->sc_pipe[UMASS_BULKOUT], sc->dataout_buffer, 1240 sc->transfer_datalen, 0,/* fixed length transfer */ 1241 sc->transfer_xfer[XFER_BBB_DATAOUT])) 1242 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1243 1244 return; 1245 } else { 1246 DPRINTFM(UDMASS_BBB, "sc %#jx: no data phase", 1247 (uintptr_t)sc, 0, 0, 0); 1248 } 1249 1250 /* if no data phase, err == 0 */ 1251 /* FALLTHROUGH */ 1252 case TSTATE_BBB_DATA: 1253 /* Command transport phase error handling (ignored if no data 1254 * phase (fallthrough from previous state)) */ 1255 if (sc->transfer_dir != DIR_NONE) { 1256 /* retrieve the length of the transfer that was done */ 1257 usbd_get_xfer_status(xfer, NULL, NULL, 1258 &sc->transfer_actlen, NULL); 1259 DPRINTFM(UDMASS_BBB, "sc %#jx: BBB_DATA actlen=%jd", 1260 (uintptr_t)sc, sc->transfer_actlen, 0, 0); 1261 1262 if (err) { 1263 DPRINTFM(UDMASS_BBB, "sc %#jx Data dir %jd " 1264 "err %jd failed, err %jd", 1265 (uintptr_t)sc, sc->transfer_dir, 1266 sc->transfer_datalen, err); 1267 1268 if (err == USBD_STALLED) { 1269 sc->transfer_state = TSTATE_BBB_DCLEAR; 1270 umass_clear_endpoint_stall(sc, 1271 (sc->transfer_dir == DIR_IN? 1272 UMASS_BULKIN:UMASS_BULKOUT), 1273 sc->transfer_xfer[XFER_BBB_DCLEAR]); 1274 } else { 1275 /* Unless the error is a pipe stall the 1276 * error is fatal. 1277 */ 1278 umass_bbb_reset(sc,STATUS_WIRE_FAILED); 1279 } 1280 return; 1281 } 1282 } 1283 1284 /* err == 0 (no data phase or successful) */ 1285 /* FALLTHROUGH */ 1286 case TSTATE_BBB_DCLEAR: /* stall clear after data phase */ 1287 if (sc->transfer_dir == DIR_IN) 1288 memcpy(sc->transfer_data, sc->datain_buffer, 1289 sc->transfer_actlen); 1290 1291 DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN) 1292 umass_dump_buffer(sc, sc->transfer_data, 1293 sc->transfer_datalen, 48)); 1294 1295 /* err == 0 (no data phase or successful) */ 1296 /* FALLTHROUGH */ 1297 case TSTATE_BBB_SCLEAR: /* stall clear after status phase */ 1298 /* Reading of CSW after bulk stall condition in data phase 1299 * (TSTATE_BBB_DATA2) or bulk-in stall condition after 1300 * reading CSW (TSTATE_BBB_SCLEAR). 1301 * In the case of no data phase or successful data phase, 1302 * err == 0 and the following if block is passed. 1303 */ 1304 if (err) { /* should not occur */ 1305 printf("%s: BBB bulk-%s stall clear failed, %s\n", 1306 device_xname(sc->sc_dev), 1307 (sc->transfer_dir == DIR_IN? "in":"out"), 1308 usbd_errstr(err)); 1309 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1310 return; 1311 } 1312 1313 /* Status transport phase, setup transfer */ 1314 if (sc->transfer_state == TSTATE_BBB_COMMAND || 1315 sc->transfer_state == TSTATE_BBB_DATA || 1316 sc->transfer_state == TSTATE_BBB_DCLEAR) { 1317 /* After no data phase, successful data phase and 1318 * after clearing bulk-in/-out stall condition 1319 */ 1320 sc->transfer_state = TSTATE_BBB_STATUS1; 1321 next_xfer = sc->transfer_xfer[XFER_BBB_CSW1]; 1322 } else { 1323 /* After first attempt of fetching CSW */ 1324 sc->transfer_state = TSTATE_BBB_STATUS2; 1325 next_xfer = sc->transfer_xfer[XFER_BBB_CSW2]; 1326 } 1327 1328 /* Read the Command Status Wrapper via bulk-in endpoint. */ 1329 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1330 &sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) { 1331 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1332 return; 1333 } 1334 1335 return; 1336 case TSTATE_BBB_STATUS1: /* first attempt */ 1337 case TSTATE_BBB_STATUS2: /* second attempt */ 1338 /* Status transfer, error handling */ 1339 if (err) { 1340 DPRINTFM(UDMASS_BBB, "sc %#jx Failed to read CSW " 1341 "err %jd (state %jd)", (uintptr_t)sc, err, 1342 sc->transfer_state, 0); 1343 1344 /* If this was the first attempt at fetching the CSW 1345 * retry it, otherwise fail. 1346 */ 1347 if (sc->transfer_state == TSTATE_BBB_STATUS1) { 1348 sc->transfer_state = TSTATE_BBB_SCLEAR; 1349 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1350 sc->transfer_xfer[XFER_BBB_SCLEAR]); 1351 return; 1352 } else { 1353 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1354 return; 1355 } 1356 } 1357 1358 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw)); 1359 1360 #ifdef UMASS_DEBUG 1361 residue = UGETDW(sc->csw.dCSWDataResidue); 1362 if (residue != sc->transfer_datalen - sc->transfer_actlen) 1363 printf("%s: dCSWDataResidue=%d req=%d act=%d\n", 1364 device_xname(sc->sc_dev), residue, 1365 sc->transfer_datalen, sc->transfer_actlen); 1366 #endif 1367 residue = sc->transfer_datalen - sc->transfer_actlen; 1368 1369 /* Translate weird command-status signatures. */ 1370 if ((sc->sc_quirks & UMASS_QUIRK_WRONG_CSWSIG) && 1371 UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1) 1372 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE); 1373 1374 /* Translate invalid command-status tags */ 1375 if (sc->sc_quirks & UMASS_QUIRK_WRONG_CSWTAG) 1376 USETDW(sc->csw.dCSWTag, UGETDW(sc->cbw.dCBWTag)); 1377 1378 /* Check CSW and handle any error */ 1379 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) { 1380 /* Invalid CSW: Wrong signature or wrong tag might 1381 * indicate that the device is confused -> reset it. 1382 */ 1383 printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n", 1384 device_xname(sc->sc_dev), 1385 UGETDW(sc->csw.dCSWSignature), 1386 CSWSIGNATURE); 1387 1388 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1389 return; 1390 } else if (UGETDW(sc->csw.dCSWTag) 1391 != UGETDW(sc->cbw.dCBWTag)) { 1392 printf("%s: Invalid CSW: tag %d should be %d\n", 1393 device_xname(sc->sc_dev), 1394 UGETDW(sc->csw.dCSWTag), 1395 UGETDW(sc->cbw.dCBWTag)); 1396 1397 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1398 return; 1399 1400 /* CSW is valid here */ 1401 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) { 1402 printf("%s: Invalid CSW: status %d > %d\n", 1403 device_xname(sc->sc_dev), 1404 sc->csw.bCSWStatus, 1405 CSWSTATUS_PHASE); 1406 1407 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1408 return; 1409 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) { 1410 printf("%s: Phase Error, residue = %d\n", 1411 device_xname(sc->sc_dev), residue); 1412 1413 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1414 return; 1415 1416 } else if (sc->transfer_actlen > sc->transfer_datalen) { 1417 /* Buffer overrun! Don't let this go by unnoticed */ 1418 panic("%s: transferred %s %d bytes instead of %d bytes", 1419 device_xname(sc->sc_dev), 1420 sc->transfer_dir == DIR_IN ? "IN" : "OUT", 1421 sc->transfer_actlen, sc->transfer_datalen); 1422 #if 0 1423 } else if (sc->transfer_datalen - sc->transfer_actlen 1424 != residue) { 1425 DPRINTFM(UDMASS_BBB, "sc %#jx: actlen=%jd != " 1426 "residue=%jd\n", (uintptr_t)sc, 1427 sc->transfer_datalen - sc->transfer_actlen, 1428 residue, 0); 1429 1430 umass_bbb_reset(sc, STATUS_WIRE_FAILED); 1431 return; 1432 #endif 1433 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) { 1434 DPRINTFM(UDMASS_BBB, "sc %#jx: Command Failed, " 1435 "res = %jd", (uintptr_t)sc, residue, 0, 0); 1436 1437 /* SCSI command failed but transfer was succesful */ 1438 sc->transfer_state = TSTATE_IDLE; 1439 sc->transfer_cb(sc, sc->transfer_priv, residue, 1440 STATUS_CMD_FAILED); 1441 1442 return; 1443 1444 } else { /* success */ 1445 sc->transfer_state = TSTATE_IDLE; 1446 sc->transfer_cb(sc, sc->transfer_priv, residue, 1447 STATUS_CMD_OK); 1448 1449 return; 1450 } 1451 1452 /***** Bulk Reset *****/ 1453 case TSTATE_BBB_RESET1: 1454 if (err) 1455 printf("%s: BBB reset failed, %s\n", 1456 device_xname(sc->sc_dev), usbd_errstr(err)); 1457 1458 sc->transfer_state = TSTATE_BBB_RESET2; 1459 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1460 sc->transfer_xfer[XFER_BBB_RESET2]); 1461 1462 return; 1463 case TSTATE_BBB_RESET2: 1464 if (err) /* should not occur */ 1465 printf("%s: BBB bulk-in clear stall failed, %s\n", 1466 device_xname(sc->sc_dev), usbd_errstr(err)); 1467 /* no error recovery, otherwise we end up in a loop */ 1468 1469 sc->transfer_state = TSTATE_BBB_RESET3; 1470 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1471 sc->transfer_xfer[XFER_BBB_RESET3]); 1472 1473 return; 1474 case TSTATE_BBB_RESET3: 1475 if (err) /* should not occur */ 1476 printf("%s: BBB bulk-out clear stall failed, %s\n", 1477 device_xname(sc->sc_dev), usbd_errstr(err)); 1478 /* no error recovery, otherwise we end up in a loop */ 1479 1480 sc->transfer_state = TSTATE_IDLE; 1481 if (sc->transfer_priv) { 1482 sc->transfer_cb(sc, sc->transfer_priv, 1483 sc->transfer_datalen, 1484 sc->transfer_status); 1485 } 1486 1487 return; 1488 1489 /***** Default *****/ 1490 default: 1491 panic("%s: Unknown state %d", 1492 device_xname(sc->sc_dev), sc->transfer_state); 1493 } 1494 } 1495 1496 /* 1497 * Command/Bulk/Interrupt (CBI) specific functions 1498 */ 1499 1500 Static int 1501 umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, int flags, 1502 struct usbd_xfer *xfer) 1503 { 1504 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1505 "sc->sc_wire == 0x%02x wrong for umass_cbi_adsc\n", 1506 sc->sc_wire); 1507 1508 if ((sc->sc_cmd == UMASS_CPROTO_RBC) && 1509 (sc->sc_quirks & UMASS_QUIRK_RBC_PAD_TO_12) != 0 && buflen < 12) { 1510 (void)memset(buffer + buflen, 0, 12 - buflen); 1511 buflen = 12; 1512 } 1513 1514 sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 1515 sc->sc_req.bRequest = UR_CBI_ADSC; 1516 USETW(sc->sc_req.wValue, 0); 1517 USETW(sc->sc_req.wIndex, sc->sc_ifaceno); 1518 USETW(sc->sc_req.wLength, buflen); 1519 return umass_setup_ctrl_transfer(sc, &sc->sc_req, buffer, 1520 buflen, flags, xfer); 1521 } 1522 1523 1524 Static void 1525 umass_cbi_reset(struct umass_softc *sc, int status) 1526 { 1527 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1528 int i; 1529 # define SEND_DIAGNOSTIC_CMDLEN 12 1530 1531 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1532 "sc->sc_wire == 0x%02x wrong for umass_cbi_reset\n", 1533 sc->sc_wire); 1534 1535 if (sc->sc_dying) 1536 return; 1537 1538 /* 1539 * Command Block Reset Protocol 1540 * 1541 * First send a reset request to the device. Then clear 1542 * any possibly stalled bulk endpoints. 1543 1544 * This is done in 3 steps, states: 1545 * TSTATE_CBI_RESET1 1546 * TSTATE_CBI_RESET2 1547 * TSTATE_CBI_RESET3 1548 * 1549 * If the reset doesn't succeed, the device should be port reset. 1550 */ 1551 1552 DPRINTFM(UDMASS_CBI, "sc %#jx: CBI Reset", (uintptr_t)sc, 0, 0, 0); 1553 1554 /* CTASSERT */ 1555 KASSERTMSG(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN, 1556 "%s: CBL struct is too small (%zu < %u)\n", 1557 device_xname(sc->sc_dev), 1558 sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN); 1559 1560 sc->transfer_state = TSTATE_CBI_RESET1; 1561 sc->transfer_status = status; 1562 1563 /* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between 1564 * the two the last 10 bytes of the cbl is filled with 0xff (section 1565 * 2.2 of the CBI spec). 1566 */ 1567 sc->cbl[0] = 0x1d; /* Command Block Reset */ 1568 sc->cbl[1] = 0x04; 1569 for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++) 1570 sc->cbl[i] = 0xff; 1571 1572 umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, 0, 1573 sc->transfer_xfer[XFER_CBI_RESET1]); 1574 /* XXX if the command fails we should reset the port on the bub */ 1575 } 1576 1577 Static void 1578 umass_cbi_transfer(struct umass_softc *sc, int lun, 1579 void *cmd, int cmdlen, void *data, int datalen, int dir, 1580 u_int timeout, int flags, umass_callback cb, void *priv) 1581 { 1582 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1583 1584 DPRINTFM(UDMASS_CBI, "sc %#jx: cmd=0x%02jx, len=%jd", 1585 (uintptr_t)sc, *(u_char *)cmd, datalen, 0); 1586 1587 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1588 "sc->sc_wire == 0x%02x wrong for umass_cbi_transfer\n", 1589 sc->sc_wire); 1590 1591 if (sc->sc_dying) 1592 return; 1593 1594 /* Be a little generous. */ 1595 sc->timeout = timeout + USBD_DEFAULT_TIMEOUT; 1596 1597 /* 1598 * Do a CBI transfer with cmdlen bytes from cmd, possibly 1599 * a data phase of datalen bytes from/to the device and finally a 1600 * csw read phase. 1601 * If the data direction was inbound a maximum of datalen bytes 1602 * is stored in the buffer pointed to by data. 1603 * 1604 * umass_cbi_transfer initialises the transfer and lets the state 1605 * machine in umass_cbi_state handle the completion. It uses the 1606 * following states: 1607 * TSTATE_CBI_COMMAND 1608 * -> XXX fill in 1609 * 1610 * An error in any of those states will invoke 1611 * umass_cbi_reset. 1612 */ 1613 1614 /* check the given arguments */ 1615 KASSERTMSG(datalen == 0 || data != NULL, 1616 "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev)); 1617 KASSERTMSG(datalen == 0 || dir != DIR_NONE, 1618 "%s: direction is NONE while datalen is not zero\n", 1619 device_xname(sc->sc_dev)); 1620 1621 /* store the details for the data transfer phase */ 1622 sc->transfer_dir = dir; 1623 sc->transfer_data = data; 1624 sc->transfer_datalen = datalen; 1625 sc->transfer_actlen = 0; 1626 sc->transfer_cb = cb; 1627 sc->transfer_priv = priv; 1628 sc->transfer_status = STATUS_CMD_OK; 1629 1630 /* move from idle to the command state */ 1631 sc->transfer_state = TSTATE_CBI_COMMAND; 1632 1633 /* Send the Command Block from host to device via control endpoint. */ 1634 if (umass_cbi_adsc(sc, cmd, cmdlen, flags, 1635 sc->transfer_xfer[XFER_CBI_CB])) 1636 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1637 } 1638 1639 Static void 1640 umass_cbi_state(struct usbd_xfer *xfer, void *priv, 1641 usbd_status err) 1642 { 1643 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1644 struct umass_softc *sc = (struct umass_softc *) priv; 1645 1646 KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I), 1647 "sc->sc_wire == 0x%02x wrong for umass_cbi_state\n", 1648 sc->sc_wire); 1649 1650 if (err == USBD_CANCELLED) { 1651 DPRINTFM(UDMASS_BBB, "sc %#jx xfer %#jx cancelled", 1652 (uintptr_t)sc, (uintptr_t)xfer, 0, 0); 1653 sc->transfer_state = TSTATE_IDLE; 1654 sc->transfer_cb(sc, sc->transfer_priv, 0, STATUS_TIMEOUT); 1655 return; 1656 } 1657 1658 if (sc->sc_dying) 1659 return; 1660 1661 /* 1662 * State handling for CBI transfers. 1663 */ 1664 1665 DPRINTFM(UDMASS_CBI, "sc %#jx: Handling CBI state %jd, xfer=%#jx, ...", 1666 (uintptr_t)sc, sc->transfer_state, (uintptr_t)xfer, 0); 1667 DPRINTFM(UDMASS_CBI, "... err %jd", err, 0, 0, 0); 1668 1669 switch (sc->transfer_state) { 1670 1671 /***** CBI Transfer *****/ 1672 case TSTATE_CBI_COMMAND: 1673 if (err == USBD_STALLED) { 1674 DPRINTFM(UDMASS_CBI, "sc %#jx: Command Transport " 1675 "failed", (uintptr_t)sc, 0, 0, 0); 1676 /* Status transport by control pipe (section 2.3.2.1). 1677 * The command contained in the command block failed. 1678 * 1679 * The control pipe has already been unstalled by the 1680 * USB stack. 1681 * Section 2.4.3.1.1 states that the bulk in endpoints 1682 * should not stalled at this point. 1683 */ 1684 1685 sc->transfer_state = TSTATE_IDLE; 1686 sc->transfer_cb(sc, sc->transfer_priv, 1687 sc->transfer_datalen, 1688 STATUS_CMD_FAILED); 1689 1690 return; 1691 } else if (err) { 1692 DPRINTFM(UDMASS_CBI, "sc %#jx: failed to send ADSC", 1693 (uintptr_t)sc, 0, 0, 0); 1694 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1695 return; 1696 } 1697 1698 /* Data transport phase, setup transfer */ 1699 sc->transfer_state = TSTATE_CBI_DATA; 1700 if (sc->transfer_dir == DIR_IN) { 1701 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN], 1702 sc->datain_buffer, sc->transfer_datalen, 1703 USBD_SHORT_XFER_OK, 1704 sc->transfer_xfer[XFER_CBI_DATAIN])) 1705 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1706 1707 return; 1708 } else if (sc->transfer_dir == DIR_OUT) { 1709 memcpy(sc->dataout_buffer, sc->transfer_data, 1710 sc->transfer_datalen); 1711 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT], 1712 sc->dataout_buffer, sc->transfer_datalen, 1713 0, /* fixed length transfer */ 1714 sc->transfer_xfer[XFER_CBI_DATAOUT])) 1715 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1716 1717 return; 1718 } else { 1719 DPRINTFM(UDMASS_CBI, "sc %#jx: no data phase", 1720 (uintptr_t)sc, 0, 0, 0); 1721 } 1722 1723 /* if no data phase, err == 0 */ 1724 /* FALLTHROUGH */ 1725 case TSTATE_CBI_DATA: 1726 /* Command transport phase error handling (ignored if no data 1727 * phase (fallthrough from previous state)) */ 1728 if (sc->transfer_dir != DIR_NONE) { 1729 /* retrieve the length of the transfer that was done */ 1730 usbd_get_xfer_status(xfer, NULL, NULL, 1731 &sc->transfer_actlen, NULL); 1732 DPRINTFM(UDMASS_CBI, "sc %#jx: CBI_DATA actlen=%jd", 1733 (uintptr_t)sc, sc->transfer_actlen, 0, 0); 1734 1735 if (err) { 1736 DPRINTFM(UDMASS_CBI, "sc %#jx: Data dir %jd " 1737 "err %d failed", 1738 (uintptr_t)sc, sc->transfer_dir, 1739 sc->transfer_datalen, err); 1740 1741 if (err == USBD_STALLED) { 1742 sc->transfer_state = TSTATE_CBI_DCLEAR; 1743 umass_clear_endpoint_stall(sc, 1744 (sc->transfer_dir == DIR_IN? 1745 UMASS_BULKIN:UMASS_BULKOUT), 1746 sc->transfer_xfer[XFER_CBI_DCLEAR]); 1747 } else { 1748 /* Unless the error is a pipe stall the 1749 * error is fatal. 1750 */ 1751 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1752 } 1753 return; 1754 } 1755 } 1756 1757 if (sc->transfer_dir == DIR_IN) 1758 memcpy(sc->transfer_data, sc->datain_buffer, 1759 sc->transfer_actlen); 1760 1761 DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN) 1762 umass_dump_buffer(sc, sc->transfer_data, 1763 sc->transfer_actlen, 48)); 1764 1765 /* Status phase */ 1766 if (sc->sc_wire == UMASS_WPROTO_CBI_I) { 1767 sc->transfer_state = TSTATE_CBI_STATUS; 1768 memset(&sc->sbl, 0, sizeof(sc->sbl)); 1769 if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_INTRIN], 1770 &sc->sbl, sizeof(sc->sbl), 1771 0, /* fixed length transfer */ 1772 sc->transfer_xfer[XFER_CBI_STATUS])) 1773 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1774 } else { 1775 /* No command completion interrupt. Request 1776 * sense to get status of command. 1777 */ 1778 sc->transfer_state = TSTATE_IDLE; 1779 sc->transfer_cb(sc, sc->transfer_priv, 1780 sc->transfer_datalen - sc->transfer_actlen, 1781 STATUS_CMD_UNKNOWN); 1782 } 1783 return; 1784 1785 case TSTATE_CBI_STATUS: 1786 if (err) { 1787 DPRINTFM(UDMASS_CBI, "sc %#jx: Status Transport failed", 1788 (uintptr_t)sc, 0, 0, 0); 1789 /* Status transport by interrupt pipe (section 2.3.2.2). 1790 */ 1791 1792 if (err == USBD_STALLED) { 1793 sc->transfer_state = TSTATE_CBI_SCLEAR; 1794 umass_clear_endpoint_stall(sc, UMASS_INTRIN, 1795 sc->transfer_xfer[XFER_CBI_SCLEAR]); 1796 } else { 1797 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1798 } 1799 return; 1800 } 1801 1802 /* Dissect the information in the buffer */ 1803 1804 { 1805 uint32_t actlen; 1806 usbd_get_xfer_status(xfer,NULL,NULL,&actlen,NULL); 1807 DPRINTFM(UDMASS_CBI, "sc %#jx: CBI_STATUS actlen=%jd", 1808 (uintptr_t)sc, actlen, 0, 0); 1809 if (actlen != 2) 1810 break; 1811 } 1812 1813 if (sc->sc_cmd == UMASS_CPROTO_UFI) { 1814 int status; 1815 1816 /* Section 3.4.3.1.3 specifies that the UFI command 1817 * protocol returns an ASC and ASCQ in the interrupt 1818 * data block. 1819 */ 1820 1821 DPRINTFM(UDMASS_CBI, "sc %#jx: UFI CCI, ASC = 0x%02jx, " 1822 "ASCQ = 0x%02jx", (uintptr_t)sc, sc->sbl.ufi.asc, 1823 sc->sbl.ufi.ascq, 0); 1824 1825 if ((sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) || 1826 sc->sc_sense) 1827 status = STATUS_CMD_OK; 1828 else 1829 status = STATUS_CMD_FAILED; 1830 1831 /* No autosense, command successful */ 1832 sc->transfer_state = TSTATE_IDLE; 1833 sc->transfer_cb(sc, sc->transfer_priv, 1834 sc->transfer_datalen - sc->transfer_actlen, status); 1835 } else { 1836 int status; 1837 1838 /* Command Interrupt Data Block */ 1839 1840 DPRINTFM(UDMASS_CBI, "sc %#jx: type=0x%02jx, " 1841 "value=0x%02jx", (uintptr_t)sc, 1842 sc->sbl.common.type, sc->sbl.common.value, 0); 1843 1844 if (sc->sbl.common.type == IDB_TYPE_CCI) { 1845 switch (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) { 1846 case IDB_VALUE_PASS: 1847 status = STATUS_CMD_OK; 1848 break; 1849 case IDB_VALUE_FAIL: 1850 case IDB_VALUE_PERSISTENT: 1851 status = STATUS_CMD_FAILED; 1852 break; 1853 case IDB_VALUE_PHASE: 1854 default: /* XXX: gcc */ 1855 status = STATUS_WIRE_FAILED; 1856 break; 1857 } 1858 1859 sc->transfer_state = TSTATE_IDLE; 1860 sc->transfer_cb(sc, sc->transfer_priv, 1861 sc->transfer_datalen - sc->transfer_actlen, 1862 status); 1863 } 1864 } 1865 return; 1866 1867 case TSTATE_CBI_DCLEAR: 1868 if (err) { /* should not occur */ 1869 printf("%s: CBI bulk-%s stall clear failed, %s\n", 1870 device_xname(sc->sc_dev), 1871 (sc->transfer_dir == DIR_IN? "in":"out"), 1872 usbd_errstr(err)); 1873 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1874 } else { 1875 sc->transfer_state = TSTATE_IDLE; 1876 sc->transfer_cb(sc, sc->transfer_priv, 1877 sc->transfer_datalen, STATUS_CMD_FAILED); 1878 } 1879 return; 1880 1881 case TSTATE_CBI_SCLEAR: 1882 if (err) { /* should not occur */ 1883 printf("%s: CBI intr-in stall clear failed, %s\n", 1884 device_xname(sc->sc_dev), usbd_errstr(err)); 1885 umass_cbi_reset(sc, STATUS_WIRE_FAILED); 1886 } else { 1887 sc->transfer_state = TSTATE_IDLE; 1888 sc->transfer_cb(sc, sc->transfer_priv, 1889 sc->transfer_datalen, STATUS_CMD_FAILED); 1890 } 1891 return; 1892 1893 /***** CBI Reset *****/ 1894 case TSTATE_CBI_RESET1: 1895 if (err) 1896 printf("%s: CBI reset failed, %s\n", 1897 device_xname(sc->sc_dev), usbd_errstr(err)); 1898 1899 sc->transfer_state = TSTATE_CBI_RESET2; 1900 umass_clear_endpoint_stall(sc, UMASS_BULKIN, 1901 sc->transfer_xfer[XFER_CBI_RESET2]); 1902 1903 return; 1904 case TSTATE_CBI_RESET2: 1905 if (err) /* should not occur */ 1906 printf("%s: CBI bulk-in stall clear failed, %s\n", 1907 device_xname(sc->sc_dev), usbd_errstr(err)); 1908 /* no error recovery, otherwise we end up in a loop */ 1909 1910 sc->transfer_state = TSTATE_CBI_RESET3; 1911 umass_clear_endpoint_stall(sc, UMASS_BULKOUT, 1912 sc->transfer_xfer[XFER_CBI_RESET3]); 1913 1914 return; 1915 case TSTATE_CBI_RESET3: 1916 if (err) /* should not occur */ 1917 printf("%s: CBI bulk-out stall clear failed, %s\n", 1918 device_xname(sc->sc_dev), usbd_errstr(err)); 1919 /* no error recovery, otherwise we end up in a loop */ 1920 1921 sc->transfer_state = TSTATE_IDLE; 1922 if (sc->transfer_priv) { 1923 sc->transfer_cb(sc, sc->transfer_priv, 1924 sc->transfer_datalen, 1925 sc->transfer_status); 1926 } 1927 1928 return; 1929 1930 1931 /***** Default *****/ 1932 default: 1933 panic("%s: Unknown state %d", 1934 device_xname(sc->sc_dev), sc->transfer_state); 1935 } 1936 } 1937 1938 usbd_status 1939 umass_bbb_get_max_lun(struct umass_softc *sc, uint8_t *maxlun) 1940 { 1941 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 1942 usb_device_request_t req; 1943 usbd_status err; 1944 1945 *maxlun = 0; /* Default to 0. */ 1946 1947 DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun", (uintptr_t)sc, 0, 0, 0); 1948 1949 /* The Get Max Lun command is a class-specific request. */ 1950 req.bmRequestType = UT_READ_CLASS_INTERFACE; 1951 req.bRequest = UR_BBB_GET_MAX_LUN; 1952 USETW(req.wValue, 0); 1953 USETW(req.wIndex, sc->sc_ifaceno); 1954 USETW(req.wLength, 1); 1955 1956 err = usbd_do_request_flags(sc->sc_udev, &req, maxlun, 1957 USBD_SHORT_XFER_OK, 0, USBD_DEFAULT_TIMEOUT); 1958 switch (err) { 1959 case USBD_NORMAL_COMPLETION: 1960 DPRINTFM(UDMASS_BBB, "sc %#jx: Max Lun %jd", 1961 (uintptr_t)sc, *maxlun , 0, 0); 1962 break; 1963 1964 case USBD_STALLED: 1965 /* 1966 * Device doesn't support Get Max Lun request. 1967 */ 1968 err = USBD_NORMAL_COMPLETION; 1969 DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun not supported", 1970 (uintptr_t)sc, 0, 0, 0); 1971 break; 1972 1973 case USBD_SHORT_XFER: 1974 /* 1975 * XXX This must mean Get Max Lun is not supported, too! 1976 */ 1977 err = USBD_NORMAL_COMPLETION; 1978 DPRINTFM(UDMASS_BBB, "sc %#jx: Get Max Lun SHORT_XFER", 1979 (uintptr_t)sc, 0, 0, 0); 1980 break; 1981 1982 default: 1983 printf("%s: Get Max Lun failed: %s\n", 1984 device_xname(sc->sc_dev), usbd_errstr(err)); 1985 /* XXX Should we port_reset the device? */ 1986 break; 1987 } 1988 1989 return err; 1990 } 1991 1992 1993 1994 1995 #ifdef UMASS_DEBUG 1996 Static void 1997 umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw) 1998 { 1999 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 2000 int clen = cbw->bCDBLength; 2001 int dlen = UGETDW(cbw->dCBWDataTransferLength); 2002 uint8_t *c = cbw->CBWCDB; 2003 int tag = UGETDW(cbw->dCBWTag); 2004 int flags = cbw->bCBWFlags; 2005 2006 DPRINTFM(UDMASS_BBB, "sc %#jx: CBW %jd: cmdlen=%jd", 2007 (uintptr_t)sc, tag, clen, 0); 2008 DPRINTFM(UDMASS_BBB, " 0x%02jx%02jx%02jx%02jx...", 2009 c[0], c[1], c[2], c[3]); 2010 DPRINTFM(UDMASS_BBB, " 0x%02jx%02jx%02jx%02jx...", 2011 c[4], c[5], c[6], c[7]); 2012 DPRINTFM(UDMASS_BBB, " 0x%02jx%02jx...", c[8], c[9], 0, 0); 2013 DPRINTFM(UDMASS_BBB, " data = %jd bytes, flags = %jx", dlen, flags, 0, 2014 0); 2015 } 2016 2017 Static void 2018 umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw) 2019 { 2020 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 2021 int sig = UGETDW(csw->dCSWSignature); 2022 int tag = UGETDW(csw->dCSWTag); 2023 int res = UGETDW(csw->dCSWDataResidue); 2024 int status = csw->bCSWStatus; 2025 2026 DPRINTFM(UDMASS_BBB, "sc %#jx: CSW %jd: sig = 0x%08jx, tag = %jd", 2027 (uintptr_t)sc, (uintptr_t)csw, sig, tag); 2028 DPRINTFM(UDMASS_BBB, " res = %jd, status = 0x%02jx", 2029 res, status, 0, 0); 2030 } 2031 2032 Static void 2033 umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, int buflen, 2034 int printlen) 2035 { 2036 UMASSHIST_FUNC(); UMASSHIST_CALLED(); 2037 int i; 2038 2039 DPRINTFM(UDMASS_GEN, "sc %#jx: buffer %#jx", (uintptr_t)sc, 2040 (uintptr_t)buffer, 0, 0); 2041 for (i = 0; i < buflen && i < printlen;) { 2042 if (i + 3 < buflen && i + 3 < printlen) { 2043 DPRINTFM(UDMASS_GEN, " 0x%02jx%02jx%02jx%02jx", 2044 buffer[i], buffer[i + 1], 2045 buffer[i + 2], buffer[i + 3]); 2046 i += 4; 2047 } else if (i + 2 < buflen && i + 2 < printlen) { 2048 DPRINTFM(UDMASS_GEN, " 0x%02jx%02jx%02jx", 2049 buffer[i], buffer[i + 1], buffer[i + 2], 0); 2050 i += 3; 2051 } else if (i + 1 < buflen && i + 2 < printlen) { 2052 DPRINTFM(UDMASS_GEN, " 0x%02jx%02jx", 2053 buffer[i], buffer[i + 1], 0, 0); 2054 i += 2; 2055 } else { 2056 DPRINTFM(UDMASS_GEN, " 0x%02jx", buffer[i], 0, 0, 0); 2057 i += 1; 2058 } 2059 } 2060 } 2061 #endif 2062
Indexes created Tue Sep 30 07:10:03 GMT 2025