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