umass_scsipi.c revision 1.38.10.2
1 /* $NetBSD: umass_scsipi.c,v 1.38.10.2 2012/08/20 19:34:20 riz Exp $ */ 2 3 /* 4 * Copyright (c) 2001, 2003 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart (at) augustsson.net) at 9 * Carlstedt Research & Technology and by Charles M. Hamnnum. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #include <sys/cdefs.h> 34 __KERNEL_RCSID(0, "$NetBSD: umass_scsipi.c,v 1.38.10.2 2012/08/20 19:34:20 riz Exp $"); 35 36 #ifdef _KERNEL_OPT 37 #include "opt_umass.h" 38 #endif 39 40 #include "atapibus.h" 41 #include "scsibus.h" 42 43 #include <sys/param.h> 44 #include <sys/systm.h> 45 #include <sys/kernel.h> 46 #include <sys/conf.h> 47 #include <sys/buf.h> 48 #include <sys/bufq.h> 49 #include <sys/device.h> 50 #include <sys/ioctl.h> 51 #include <sys/malloc.h> 52 53 /* SCSI & ATAPI */ 54 #include <sys/scsiio.h> 55 #include <dev/scsipi/scsi_spc.h> 56 #include <dev/scsipi/scsi_all.h> 57 #include <dev/scsipi/scsipi_all.h> 58 #include <dev/scsipi/scsiconf.h> 59 60 #include <dev/scsipi/atapiconf.h> 61 62 #include <dev/scsipi/scsipi_disk.h> 63 #include <dev/scsipi/scsi_disk.h> 64 #include <dev/scsipi/scsi_changer.h> 65 66 #include <sys/disk.h> /* XXX */ 67 #include <dev/scsipi/sdvar.h> /* XXX */ 68 69 /* USB */ 70 #include <dev/usb/usb.h> 71 #include <dev/usb/usbdi.h> 72 #include <dev/usb/usbdi_util.h> 73 #include <dev/usb/usbdevs.h> 74 75 #include <dev/usb/umassvar.h> 76 #include <dev/usb/umass_scsipi.h> 77 78 struct umass_scsipi_softc { 79 struct umassbus_softc base; 80 81 struct atapi_adapter sc_atapi_adapter; 82 #define sc_adapter sc_atapi_adapter._generic 83 struct scsipi_channel sc_channel; 84 usbd_status sc_sync_status; 85 struct scsi_request_sense sc_sense_cmd; 86 }; 87 88 89 #define SHORT_INQUIRY_LENGTH 36 /* XXX */ 90 91 #define UMASS_ATAPI_DRIVE 0 92 93 Static void umass_scsipi_request(struct scsipi_channel *, 94 scsipi_adapter_req_t, void *); 95 Static void umass_scsipi_minphys(struct buf *bp); 96 Static int umass_scsipi_ioctl(struct scsipi_channel *, u_long, 97 void *, int, proc_t *); 98 Static int umass_scsipi_getgeom(struct scsipi_periph *periph, 99 struct disk_parms *, u_long sectors); 100 101 Static void umass_scsipi_cb(struct umass_softc *sc, void *priv, 102 int residue, int status); 103 Static void umass_scsipi_sense_cb(struct umass_softc *sc, void *priv, 104 int residue, int status); 105 106 Static struct umass_scsipi_softc *umass_scsipi_setup(struct umass_softc *sc); 107 108 #if NATAPIBUS > 0 109 Static void umass_atapi_probe_device(struct atapibus_softc *, int); 110 111 const struct scsipi_bustype umass_atapi_bustype = { 112 SCSIPI_BUSTYPE_ATAPI, 113 atapi_scsipi_cmd, 114 atapi_interpret_sense, 115 atapi_print_addr, 116 scsi_kill_pending, 117 }; 118 #endif 119 120 121 #if NSCSIBUS > 0 122 int 123 umass_scsi_attach(struct umass_softc *sc) 124 { 125 struct umass_scsipi_softc *scbus; 126 127 scbus = umass_scsipi_setup(sc); 128 129 scbus->sc_channel.chan_bustype = &scsi_bustype; 130 scbus->sc_channel.chan_ntargets = 2; 131 scbus->sc_channel.chan_nluns = sc->maxlun + 1; 132 scbus->sc_channel.chan_id = scbus->sc_channel.chan_ntargets - 1; 133 DPRINTF(UDMASS_USB, ("%s: umass_attach_bus: SCSI\n", 134 device_xname(sc->sc_dev))); 135 136 sc->sc_refcnt++; 137 scbus->base.sc_child = 138 config_found_ia(sc->sc_dev, "scsi", &scbus->sc_channel, 139 scsiprint); 140 if (--sc->sc_refcnt < 0) 141 usb_detach_wakeup(sc->sc_dev); 142 143 return (0); 144 } 145 #endif 146 147 #if NATAPIBUS > 0 148 int 149 umass_atapi_attach(struct umass_softc *sc) 150 { 151 struct umass_scsipi_softc *scbus; 152 153 scbus = umass_scsipi_setup(sc); 154 scbus->sc_atapi_adapter.atapi_probe_device = umass_atapi_probe_device; 155 156 scbus->sc_channel.chan_bustype = &umass_atapi_bustype; 157 scbus->sc_channel.chan_ntargets = 2; 158 scbus->sc_channel.chan_nluns = 1; 159 160 scbus->sc_channel.chan_defquirks |= sc->sc_busquirks; 161 DPRINTF(UDMASS_USB, ("%s: umass_attach_bus: ATAPI\n", 162 device_xname(sc->sc_dev))); 163 164 sc->sc_refcnt++; 165 scbus->base.sc_child = 166 config_found_ia(sc->sc_dev, "atapi", &scbus->sc_channel, 167 atapiprint); 168 if (--sc->sc_refcnt < 0) 169 usb_detach_wakeup(sc->sc_dev); 170 171 return (0); 172 } 173 #endif 174 175 Static struct umass_scsipi_softc * 176 umass_scsipi_setup(struct umass_softc *sc) 177 { 178 struct umass_scsipi_softc *scbus; 179 180 scbus = malloc(sizeof *scbus, M_DEVBUF, M_WAITOK | M_ZERO); 181 sc->bus = &scbus->base; 182 183 /* Only use big commands for USB SCSI devices. */ 184 sc->sc_busquirks |= PQUIRK_ONLYBIG; 185 186 /* Fill in the adapter. */ 187 memset(&scbus->sc_adapter, 0, sizeof(scbus->sc_adapter)); 188 scbus->sc_adapter.adapt_dev = sc->sc_dev; 189 scbus->sc_adapter.adapt_nchannels = 1; 190 scbus->sc_adapter.adapt_request = umass_scsipi_request; 191 scbus->sc_adapter.adapt_minphys = umass_scsipi_minphys; 192 scbus->sc_adapter.adapt_ioctl = umass_scsipi_ioctl; 193 scbus->sc_adapter.adapt_getgeom = umass_scsipi_getgeom; 194 195 /* Fill in the channel. */ 196 memset(&scbus->sc_channel, 0, sizeof(scbus->sc_channel)); 197 scbus->sc_channel.chan_adapter = &scbus->sc_adapter; 198 scbus->sc_channel.chan_channel = 0; 199 scbus->sc_channel.chan_flags = SCSIPI_CHAN_OPENINGS | SCSIPI_CHAN_NOSETTLE; 200 scbus->sc_channel.chan_openings = 1; 201 scbus->sc_channel.chan_max_periph = 1; 202 scbus->sc_channel.chan_defquirks |= sc->sc_busquirks; 203 204 return (scbus); 205 } 206 207 Static void 208 umass_scsipi_request(struct scsipi_channel *chan, 209 scsipi_adapter_req_t req, void *arg) 210 { 211 struct scsipi_adapter *adapt = chan->chan_adapter; 212 struct scsipi_periph *periph; 213 struct scsipi_xfer *xs; 214 struct umass_softc *sc = device_private(adapt->adapt_dev); 215 struct umass_scsipi_softc *scbus = (struct umass_scsipi_softc *)sc->bus; 216 struct scsipi_generic *cmd; 217 int cmdlen; 218 int dir; 219 #ifdef UMASS_DEBUG 220 microtime(&sc->tv); 221 #endif 222 switch(req) { 223 case ADAPTER_REQ_RUN_XFER: 224 xs = arg; 225 periph = xs->xs_periph; 226 DIF(UDMASS_UPPER, periph->periph_dbflags |= SCSIPI_DEBUG_FLAGS); 227 228 DPRINTF(UDMASS_CMD, ("%s: umass_scsi_cmd: at %"PRIu64".%06"PRIu64": %d:%d " 229 "xs=%p cmd=0x%02x datalen=%d (quirks=0x%x, poll=%d)\n", 230 device_xname(sc->sc_dev), sc->tv.tv_sec, (uint64_t)sc->tv.tv_usec, 231 periph->periph_target, periph->periph_lun, 232 xs, xs->cmd->opcode, xs->datalen, 233 periph->periph_quirks, xs->xs_control & XS_CTL_POLL)); 234 #if defined(USB_DEBUG) && defined(SCSIPI_DEBUG) 235 if (umassdebug & UDMASS_SCSI) 236 show_scsipi_xs(xs); 237 else if (umassdebug & ~UDMASS_CMD) 238 show_scsipi_cmd(xs); 239 #endif 240 241 if (sc->sc_dying) { 242 xs->error = XS_DRIVER_STUFFUP; 243 goto done; 244 } 245 246 #ifdef UMASS_DEBUG 247 if (SCSIPI_BUSTYPE_TYPE(chan->chan_bustype->bustype_type) == 248 SCSIPI_BUSTYPE_ATAPI ? 249 periph->periph_target != UMASS_ATAPI_DRIVE : 250 periph->periph_target == chan->chan_id) { 251 DPRINTF(UDMASS_SCSI, ("%s: wrong SCSI ID %d\n", 252 device_xname(sc->sc_dev), 253 periph->periph_target)); 254 xs->error = XS_DRIVER_STUFFUP; 255 goto done; 256 } 257 #endif 258 259 cmd = xs->cmd; 260 cmdlen = xs->cmdlen; 261 262 dir = DIR_NONE; 263 if (xs->datalen) { 264 switch (xs->xs_control & 265 (XS_CTL_DATA_IN | XS_CTL_DATA_OUT)) { 266 case XS_CTL_DATA_IN: 267 dir = DIR_IN; 268 break; 269 case XS_CTL_DATA_OUT: 270 dir = DIR_OUT; 271 break; 272 } 273 } 274 275 if (xs->datalen > UMASS_MAX_TRANSFER_SIZE) { 276 printf("umass_cmd: large datalen, %d\n", xs->datalen); 277 xs->error = XS_DRIVER_STUFFUP; 278 goto done; 279 } 280 281 if (xs->xs_control & XS_CTL_POLL) { 282 /* Use sync transfer. XXX Broken! */ 283 DPRINTF(UDMASS_SCSI, 284 ("umass_scsi_cmd: sync dir=%d\n", dir)); 285 sc->sc_xfer_flags = USBD_SYNCHRONOUS; 286 scbus->sc_sync_status = USBD_INVAL; 287 sc->sc_methods->wire_xfer(sc, periph->periph_lun, cmd, 288 cmdlen, xs->data, 289 xs->datalen, dir, 290 xs->timeout, 0, xs); 291 sc->sc_xfer_flags = 0; 292 DPRINTF(UDMASS_SCSI, ("umass_scsi_cmd: done err=%d\n", 293 scbus->sc_sync_status)); 294 switch (scbus->sc_sync_status) { 295 case USBD_NORMAL_COMPLETION: 296 xs->error = XS_NOERROR; 297 break; 298 case USBD_TIMEOUT: 299 xs->error = XS_TIMEOUT; 300 break; 301 default: 302 xs->error = XS_DRIVER_STUFFUP; 303 break; 304 } 305 goto done; 306 } else { 307 DPRINTF(UDMASS_SCSI, 308 ("umass_scsi_cmd: async dir=%d, cmdlen=%d" 309 " datalen=%d\n", 310 dir, cmdlen, xs->datalen)); 311 sc->sc_methods->wire_xfer(sc, periph->periph_lun, cmd, 312 cmdlen, xs->data, 313 xs->datalen, dir, 314 xs->timeout, 315 umass_scsipi_cb, xs); 316 return; 317 } 318 319 /* Return if command finishes early. */ 320 done: 321 scsipi_done(xs); 322 return; 323 default: 324 /* Not supported, nothing to do. */ 325 ; 326 } 327 } 328 329 Static void 330 umass_scsipi_minphys(struct buf *bp) 331 { 332 #ifdef DIAGNOSTIC 333 if (bp->b_bcount <= 0) { 334 printf("umass_scsipi_minphys count(%d) <= 0\n", 335 bp->b_bcount); 336 bp->b_bcount = UMASS_MAX_TRANSFER_SIZE; 337 } 338 #endif 339 if (bp->b_bcount > UMASS_MAX_TRANSFER_SIZE) 340 bp->b_bcount = UMASS_MAX_TRANSFER_SIZE; 341 minphys(bp); 342 } 343 344 int 345 umass_scsipi_ioctl(struct scsipi_channel *chan, u_long cmd, 346 void *arg, int flag, proc_t *p) 347 { 348 /*struct umass_softc *sc = link->adapter_softc;*/ 349 /*struct umass_scsipi_softc *scbus = sc->bus;*/ 350 351 switch (cmd) { 352 #if 0 353 case SCBUSIORESET: 354 ccb->ccb_h.status = CAM_REQ_INPROG; 355 umass_reset(sc, umass_cam_cb, (void *) ccb); 356 return (0); 357 #endif 358 default: 359 return (ENOTTY); 360 } 361 } 362 363 Static int 364 umass_scsipi_getgeom(struct scsipi_periph *periph, struct disk_parms *dp, 365 u_long sectors) 366 { 367 struct umass_softc *sc = 368 device_private(periph->periph_channel->chan_adapter->adapt_dev); 369 370 /* If it's not a floppy, we don't know what to do. */ 371 if (sc->sc_cmd != UMASS_CPROTO_UFI) 372 return (0); 373 374 switch (sectors) { 375 case 1440: 376 /* Most likely a single density 3.5" floppy. */ 377 dp->heads = 2; 378 dp->sectors = 9; 379 dp->cyls = 80; 380 return (1); 381 case 2880: 382 /* Most likely a double density 3.5" floppy. */ 383 dp->heads = 2; 384 dp->sectors = 18; 385 dp->cyls = 80; 386 return (1); 387 default: 388 return (0); 389 } 390 } 391 392 Static void 393 umass_scsipi_cb(struct umass_softc *sc, void *priv, int residue, int status) 394 { 395 struct umass_scsipi_softc *scbus = (struct umass_scsipi_softc *)sc->bus; 396 struct scsipi_xfer *xs = priv; 397 struct scsipi_periph *periph = xs->xs_periph; 398 int cmdlen, senselen; 399 int s; 400 #ifdef UMASS_DEBUG 401 struct timeval tv; 402 u_int delta; 403 microtime(&tv); 404 delta = (tv.tv_sec - sc->tv.tv_sec) * 1000000 + tv.tv_usec - sc->tv.tv_usec; 405 #endif 406 407 DPRINTF(UDMASS_CMD,("umass_scsipi_cb: at %"PRIu64".%06"PRIu64", delta=%u: xs=%p residue=%d" 408 " status=%d\n", tv.tv_sec, (uint64_t)tv.tv_usec, delta, xs, residue, status)); 409 410 xs->resid = residue; 411 412 switch (status) { 413 case STATUS_CMD_OK: 414 xs->error = XS_NOERROR; 415 break; 416 417 case STATUS_CMD_UNKNOWN: 418 /* FALLTHROUGH */ 419 case STATUS_CMD_FAILED: 420 /* fetch sense data */ 421 sc->sc_sense = 1; 422 memset(&scbus->sc_sense_cmd, 0, sizeof(scbus->sc_sense_cmd)); 423 scbus->sc_sense_cmd.opcode = SCSI_REQUEST_SENSE; 424 scbus->sc_sense_cmd.byte2 = periph->periph_lun << 425 SCSI_CMD_LUN_SHIFT; 426 427 if (sc->sc_cmd == UMASS_CPROTO_UFI || 428 sc->sc_cmd == UMASS_CPROTO_ATAPI) 429 cmdlen = UFI_COMMAND_LENGTH; /* XXX */ 430 else 431 cmdlen = sizeof(scbus->sc_sense_cmd); 432 if (periph->periph_version < 0x05) /* SPC-3 */ 433 senselen = 18; 434 else 435 senselen = sizeof(xs->sense); 436 scbus->sc_sense_cmd.length = senselen; 437 sc->sc_methods->wire_xfer(sc, periph->periph_lun, 438 &scbus->sc_sense_cmd, cmdlen, 439 &xs->sense, senselen, 440 DIR_IN, xs->timeout, 441 umass_scsipi_sense_cb, xs); 442 return; 443 444 case STATUS_WIRE_FAILED: 445 xs->error = XS_RESET; 446 break; 447 448 default: 449 panic("%s: Unknown status %d in umass_scsipi_cb", 450 device_xname(sc->sc_dev), status); 451 } 452 453 DPRINTF(UDMASS_CMD,("umass_scsipi_cb: at %"PRIu64".%06"PRIu64": return xs->error=" 454 "%d, xs->xs_status=0x%x xs->resid=%d\n", 455 tv.tv_sec, (uint64_t)tv.tv_usec, 456 xs->error, xs->xs_status, xs->resid)); 457 458 s = splbio(); 459 scsipi_done(xs); 460 splx(s); 461 } 462 463 /* 464 * Finalise a completed autosense operation 465 */ 466 Static void 467 umass_scsipi_sense_cb(struct umass_softc *sc, void *priv, int residue, 468 int status) 469 { 470 struct scsipi_xfer *xs = priv; 471 int s; 472 473 DPRINTF(UDMASS_CMD,("umass_scsipi_sense_cb: xs=%p residue=%d " 474 "status=%d\n", xs, residue, status)); 475 476 sc->sc_sense = 0; 477 switch (status) { 478 case STATUS_CMD_OK: 479 case STATUS_CMD_UNKNOWN: 480 /* getting sense data succeeded */ 481 if (residue == 0 || residue == 14)/* XXX */ 482 xs->error = XS_SENSE; 483 else 484 xs->error = XS_SHORTSENSE; 485 break; 486 default: 487 DPRINTF(UDMASS_SCSI, ("%s: Autosense failed, status %d\n", 488 device_xname(sc->sc_dev), status)); 489 xs->error = XS_DRIVER_STUFFUP; 490 break; 491 } 492 493 DPRINTF(UDMASS_CMD,("umass_scsipi_sense_cb: return xs->error=%d, " 494 "xs->xs_status=0x%x xs->resid=%d\n", xs->error, xs->xs_status, 495 xs->resid)); 496 497 s = splbio(); 498 scsipi_done(xs); 499 splx(s); 500 } 501 502 #if NATAPIBUS > 0 503 Static void 504 umass_atapi_probe_device(struct atapibus_softc *atapi, int target) 505 { 506 struct scsipi_channel *chan = atapi->sc_channel; 507 struct scsipi_periph *periph; 508 struct scsipibus_attach_args sa; 509 char vendor[33], product[65], revision[17]; 510 struct scsipi_inquiry_data inqbuf; 511 512 DPRINTF(UDMASS_SCSI,("umass_atapi_probe_device: atapi=%p target=%d\n", 513 atapi, target)); 514 515 if (target != UMASS_ATAPI_DRIVE) /* only probe drive 0 */ 516 return; 517 518 /* skip if already attached */ 519 if (scsipi_lookup_periph(chan, target, 0) != NULL) 520 return; 521 522 periph = scsipi_alloc_periph(M_NOWAIT); 523 if (periph == NULL) { 524 aprint_error_dev(atapi->sc_dev, 525 "can't allocate link for drive %d\n", target); 526 return; 527 } 528 529 DIF(UDMASS_UPPER, periph->periph_dbflags |= 1); /* XXX 1 */ 530 periph->periph_channel = chan; 531 periph->periph_switch = &atapi_probe_periphsw; 532 periph->periph_target = target; 533 periph->periph_quirks = chan->chan_defquirks; 534 535 DPRINTF(UDMASS_SCSI, ("umass_atapi_probe_device: doing inquiry\n")); 536 /* Now go ask the device all about itself. */ 537 memset(&inqbuf, 0, sizeof(inqbuf)); 538 if (scsipi_inquire(periph, &inqbuf, XS_CTL_DISCOVERY) != 0) { 539 DPRINTF(UDMASS_SCSI, ("umass_atapi_probe_device: " 540 "scsipi_inquire failed\n")); 541 free(periph, M_DEVBUF); 542 return; 543 } 544 545 scsipi_strvis(vendor, 33, inqbuf.vendor, 8); 546 scsipi_strvis(product, 65, inqbuf.product, 16); 547 scsipi_strvis(revision, 17, inqbuf.revision, 4); 548 549 sa.sa_periph = periph; 550 sa.sa_inqbuf.type = inqbuf.device; 551 sa.sa_inqbuf.removable = inqbuf.dev_qual2 & SID_REMOVABLE ? 552 T_REMOV : T_FIXED; 553 if (sa.sa_inqbuf.removable) 554 periph->periph_flags |= PERIPH_REMOVABLE; 555 sa.sa_inqbuf.vendor = vendor; 556 sa.sa_inqbuf.product = product; 557 sa.sa_inqbuf.revision = revision; 558 sa.sa_inqptr = NULL; 559 560 DPRINTF(UDMASS_SCSI, ("umass_atapi_probedev: doing atapi_probedev on " 561 "'%s' '%s' '%s'\n", vendor, product, revision)); 562 atapi_probe_device(atapi, target, periph, &sa); 563 /* atapi_probe_device() frees the periph when there is no device.*/ 564 } 565 #endif 566
Indexes created Sun Sep 28 16:09:52 GMT 2025