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