1 /* $NetBSD: scsipi_base.c,v 1.156 2012/02/20 20:09:08 mrg Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000, 2002, 2003, 2004 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; by Jason R. Thorpe of the Numerical Aerospace 9 * Simulation Facility, NASA Ames Research Center. 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: scsipi_base.c,v 1.156 2012/02/20 20:09:08 mrg Exp $"); 35 36 #include "opt_scsi.h" 37 38 #include <sys/param.h> 39 #include <sys/systm.h> 40 #include <sys/kernel.h> 41 #include <sys/buf.h> 42 #include <sys/uio.h> 43 #include <sys/malloc.h> 44 #include <sys/pool.h> 45 #include <sys/errno.h> 46 #include <sys/device.h> 47 #include <sys/proc.h> 48 #include <sys/kthread.h> 49 #include <sys/hash.h> 50 51 #include <dev/scsipi/scsi_spc.h> 52 #include <dev/scsipi/scsipi_all.h> 53 #include <dev/scsipi/scsipi_disk.h> 54 #include <dev/scsipi/scsipiconf.h> 55 #include <dev/scsipi/scsipi_base.h> 56 57 #include <dev/scsipi/scsi_all.h> 58 #include <dev/scsipi/scsi_message.h> 59 60 #include <machine/param.h> 61 62 static int scsipi_complete(struct scsipi_xfer *); 63 static void scsipi_request_sense(struct scsipi_xfer *); 64 static int scsipi_enqueue(struct scsipi_xfer *); 65 static void scsipi_run_queue(struct scsipi_channel *chan); 66 67 static void scsipi_completion_thread(void *); 68 69 static void scsipi_get_tag(struct scsipi_xfer *); 70 static void scsipi_put_tag(struct scsipi_xfer *); 71 72 static int scsipi_get_resource(struct scsipi_channel *); 73 static void scsipi_put_resource(struct scsipi_channel *); 74 75 static void scsipi_async_event_max_openings(struct scsipi_channel *, 76 struct scsipi_max_openings *); 77 static void scsipi_async_event_xfer_mode(struct scsipi_channel *, 78 struct scsipi_xfer_mode *); 79 static void scsipi_async_event_channel_reset(struct scsipi_channel *); 80 81 static struct pool scsipi_xfer_pool; 82 83 /* 84 * scsipi_init: 85 * 86 * Called when a scsibus or atapibus is attached to the system 87 * to initialize shared data structures. 88 */ 89 void 90 scsipi_init(void) 91 { 92 static int scsipi_init_done; 93 94 if (scsipi_init_done) 95 return; 96 scsipi_init_done = 1; 97 98 /* Initialize the scsipi_xfer pool. */ 99 pool_init(&scsipi_xfer_pool, sizeof(struct scsipi_xfer), 0, 100 0, 0, "scxspl", NULL, IPL_BIO); 101 if (pool_prime(&scsipi_xfer_pool, 102 PAGE_SIZE / sizeof(struct scsipi_xfer)) == ENOMEM) { 103 printf("WARNING: not enough memory for scsipi_xfer_pool\n"); 104 } 105 } 106 107 /* 108 * scsipi_channel_init: 109 * 110 * Initialize a scsipi_channel when it is attached. 111 */ 112 int 113 scsipi_channel_init(struct scsipi_channel *chan) 114 { 115 struct scsipi_adapter *adapt = chan->chan_adapter; 116 int i; 117 118 /* Initialize shared data. */ 119 scsipi_init(); 120 121 /* Initialize the queues. */ 122 TAILQ_INIT(&chan->chan_queue); 123 TAILQ_INIT(&chan->chan_complete); 124 125 for (i = 0; i < SCSIPI_CHAN_PERIPH_BUCKETS; i++) 126 LIST_INIT(&chan->chan_periphtab[i]); 127 128 /* 129 * Create the asynchronous completion thread. 130 */ 131 if (kthread_create(PRI_NONE, 0, NULL, scsipi_completion_thread, chan, 132 &chan->chan_thread, "%s", chan->chan_name)) { 133 aprint_error_dev(adapt->adapt_dev, "unable to create completion thread for " 134 "channel %d\n", chan->chan_channel); 135 panic("scsipi_channel_init"); 136 } 137 138 return (0); 139 } 140 141 /* 142 * scsipi_channel_shutdown: 143 * 144 * Shutdown a scsipi_channel. 145 */ 146 void 147 scsipi_channel_shutdown(struct scsipi_channel *chan) 148 { 149 150 /* 151 * Shut down the completion thread. 152 */ 153 chan->chan_tflags |= SCSIPI_CHANT_SHUTDOWN; 154 wakeup(&chan->chan_complete); 155 156 /* 157 * Now wait for the thread to exit. 158 */ 159 while (chan->chan_thread != NULL) 160 (void) tsleep(&chan->chan_thread, PRIBIO, "scshut", 0); 161 } 162 163 static uint32_t 164 scsipi_chan_periph_hash(uint64_t t, uint64_t l) 165 { 166 uint32_t hash; 167 168 hash = hash32_buf(&t, sizeof(t), HASH32_BUF_INIT); 169 hash = hash32_buf(&l, sizeof(l), hash); 170 171 return (hash & SCSIPI_CHAN_PERIPH_HASHMASK); 172 } 173 174 /* 175 * scsipi_insert_periph: 176 * 177 * Insert a periph into the channel. 178 */ 179 void 180 scsipi_insert_periph(struct scsipi_channel *chan, struct scsipi_periph *periph) 181 { 182 uint32_t hash; 183 int s; 184 185 hash = scsipi_chan_periph_hash(periph->periph_target, 186 periph->periph_lun); 187 188 s = splbio(); 189 LIST_INSERT_HEAD(&chan->chan_periphtab[hash], periph, periph_hash); 190 splx(s); 191 } 192 193 /* 194 * scsipi_remove_periph: 195 * 196 * Remove a periph from the channel. 197 */ 198 void 199 scsipi_remove_periph(struct scsipi_channel *chan, 200 struct scsipi_periph *periph) 201 { 202 int s; 203 204 s = splbio(); 205 LIST_REMOVE(periph, periph_hash); 206 splx(s); 207 } 208 209 /* 210 * scsipi_lookup_periph: 211 * 212 * Lookup a periph on the specified channel. 213 */ 214 struct scsipi_periph * 215 scsipi_lookup_periph(struct scsipi_channel *chan, int target, int lun) 216 { 217 struct scsipi_periph *periph; 218 uint32_t hash; 219 int s; 220 221 KASSERT(KERNEL_LOCKED_P()); 222 223 if (target >= chan->chan_ntargets || 224 lun >= chan->chan_nluns) 225 return (NULL); 226 227 hash = scsipi_chan_periph_hash(target, lun); 228 229 s = splbio(); 230 LIST_FOREACH(periph, &chan->chan_periphtab[hash], periph_hash) { 231 if (periph->periph_target == target && 232 periph->periph_lun == lun) 233 break; 234 } 235 splx(s); 236 237 return (periph); 238 } 239 240 /* 241 * scsipi_get_resource: 242 * 243 * Allocate a single xfer `resource' from the channel. 244 * 245 * NOTE: Must be called at splbio(). 246 */ 247 static int 248 scsipi_get_resource(struct scsipi_channel *chan) 249 { 250 struct scsipi_adapter *adapt = chan->chan_adapter; 251 252 if (chan->chan_flags & SCSIPI_CHAN_OPENINGS) { 253 if (chan->chan_openings > 0) { 254 chan->chan_openings--; 255 return (1); 256 } 257 return (0); 258 } 259 260 if (adapt->adapt_openings > 0) { 261 adapt->adapt_openings--; 262 return (1); 263 } 264 return (0); 265 } 266 267 /* 268 * scsipi_grow_resources: 269 * 270 * Attempt to grow resources for a channel. If this succeeds, 271 * we allocate one for our caller. 272 * 273 * NOTE: Must be called at splbio(). 274 */ 275 static inline int 276 scsipi_grow_resources(struct scsipi_channel *chan) 277 { 278 279 if (chan->chan_flags & SCSIPI_CHAN_CANGROW) { 280 if ((chan->chan_flags & SCSIPI_CHAN_TACTIVE) == 0) { 281 scsipi_adapter_request(chan, 282 ADAPTER_REQ_GROW_RESOURCES, NULL); 283 return (scsipi_get_resource(chan)); 284 } 285 /* 286 * ask the channel thread to do it. It'll have to thaw the 287 * queue 288 */ 289 scsipi_channel_freeze(chan, 1); 290 chan->chan_tflags |= SCSIPI_CHANT_GROWRES; 291 wakeup(&chan->chan_complete); 292 return (0); 293 } 294 295 return (0); 296 } 297 298 /* 299 * scsipi_put_resource: 300 * 301 * Free a single xfer `resource' to the channel. 302 * 303 * NOTE: Must be called at splbio(). 304 */ 305 static void 306 scsipi_put_resource(struct scsipi_channel *chan) 307 { 308 struct scsipi_adapter *adapt = chan->chan_adapter; 309 310 if (chan->chan_flags & SCSIPI_CHAN_OPENINGS) 311 chan->chan_openings++; 312 else 313 adapt->adapt_openings++; 314 } 315 316 /* 317 * scsipi_get_tag: 318 * 319 * Get a tag ID for the specified xfer. 320 * 321 * NOTE: Must be called at splbio(). 322 */ 323 static void 324 scsipi_get_tag(struct scsipi_xfer *xs) 325 { 326 struct scsipi_periph *periph = xs->xs_periph; 327 int bit, tag; 328 u_int word; 329 330 bit = 0; /* XXX gcc */ 331 for (word = 0; word < PERIPH_NTAGWORDS; word++) { 332 bit = ffs(periph->periph_freetags[word]); 333 if (bit != 0) 334 break; 335 } 336 #ifdef DIAGNOSTIC 337 if (word == PERIPH_NTAGWORDS) { 338 scsipi_printaddr(periph); 339 printf("no free tags\n"); 340 panic("scsipi_get_tag"); 341 } 342 #endif 343 344 bit -= 1; 345 periph->periph_freetags[word] &= ~(1 << bit); 346 tag = (word << 5) | bit; 347 348 /* XXX Should eventually disallow this completely. */ 349 if (tag >= periph->periph_openings) { 350 scsipi_printaddr(periph); 351 printf("WARNING: tag %d greater than available openings %d\n", 352 tag, periph->periph_openings); 353 } 354 355 xs->xs_tag_id = tag; 356 } 357 358 /* 359 * scsipi_put_tag: 360 * 361 * Put the tag ID for the specified xfer back into the pool. 362 * 363 * NOTE: Must be called at splbio(). 364 */ 365 static void 366 scsipi_put_tag(struct scsipi_xfer *xs) 367 { 368 struct scsipi_periph *periph = xs->xs_periph; 369 int word, bit; 370 371 word = xs->xs_tag_id >> 5; 372 bit = xs->xs_tag_id & 0x1f; 373 374 periph->periph_freetags[word] |= (1 << bit); 375 } 376 377 /* 378 * scsipi_get_xs: 379 * 380 * Allocate an xfer descriptor and associate it with the 381 * specified peripherial. If the peripherial has no more 382 * available command openings, we either block waiting for 383 * one to become available, or fail. 384 */ 385 struct scsipi_xfer * 386 scsipi_get_xs(struct scsipi_periph *periph, int flags) 387 { 388 struct scsipi_xfer *xs; 389 int s; 390 391 SC_DEBUG(periph, SCSIPI_DB3, ("scsipi_get_xs\n")); 392 393 KASSERT(!cold); 394 395 #ifdef DIAGNOSTIC 396 /* 397 * URGENT commands can never be ASYNC. 398 */ 399 if ((flags & (XS_CTL_URGENT|XS_CTL_ASYNC)) == 400 (XS_CTL_URGENT|XS_CTL_ASYNC)) { 401 scsipi_printaddr(periph); 402 printf("URGENT and ASYNC\n"); 403 panic("scsipi_get_xs"); 404 } 405 #endif 406 407 s = splbio(); 408 /* 409 * Wait for a command opening to become available. Rules: 410 * 411 * - All xfers must wait for an available opening. 412 * Exception: URGENT xfers can proceed when 413 * active == openings, because we use the opening 414 * of the command we're recovering for. 415 * - if the periph has sense pending, only URGENT & REQSENSE 416 * xfers may proceed. 417 * 418 * - If the periph is recovering, only URGENT xfers may 419 * proceed. 420 * 421 * - If the periph is currently executing a recovery 422 * command, URGENT commands must block, because only 423 * one recovery command can execute at a time. 424 */ 425 for (;;) { 426 if (flags & XS_CTL_URGENT) { 427 if (periph->periph_active > periph->periph_openings) 428 goto wait_for_opening; 429 if (periph->periph_flags & PERIPH_SENSE) { 430 if ((flags & XS_CTL_REQSENSE) == 0) 431 goto wait_for_opening; 432 } else { 433 if ((periph->periph_flags & 434 PERIPH_RECOVERY_ACTIVE) != 0) 435 goto wait_for_opening; 436 periph->periph_flags |= PERIPH_RECOVERY_ACTIVE; 437 } 438 break; 439 } 440 if (periph->periph_active >= periph->periph_openings || 441 (periph->periph_flags & PERIPH_RECOVERING) != 0) 442 goto wait_for_opening; 443 periph->periph_active++; 444 break; 445 446 wait_for_opening: 447 if (flags & XS_CTL_NOSLEEP) { 448 splx(s); 449 return (NULL); 450 } 451 SC_DEBUG(periph, SCSIPI_DB3, ("sleeping\n")); 452 periph->periph_flags |= PERIPH_WAITING; 453 (void) tsleep(periph, PRIBIO, "getxs", 0); 454 } 455 SC_DEBUG(periph, SCSIPI_DB3, ("calling pool_get\n")); 456 xs = pool_get(&scsipi_xfer_pool, 457 ((flags & XS_CTL_NOSLEEP) != 0 ? PR_NOWAIT : PR_WAITOK)); 458 if (xs == NULL) { 459 if (flags & XS_CTL_URGENT) { 460 if ((flags & XS_CTL_REQSENSE) == 0) 461 periph->periph_flags &= ~PERIPH_RECOVERY_ACTIVE; 462 } else 463 periph->periph_active--; 464 scsipi_printaddr(periph); 465 printf("unable to allocate %sscsipi_xfer\n", 466 (flags & XS_CTL_URGENT) ? "URGENT " : ""); 467 } 468 splx(s); 469 470 SC_DEBUG(periph, SCSIPI_DB3, ("returning\n")); 471 472 if (xs != NULL) { 473 memset(xs, 0, sizeof(*xs)); 474 callout_init(&xs->xs_callout, 0); 475 xs->xs_periph = periph; 476 xs->xs_control = flags; 477 xs->xs_status = 0; 478 s = splbio(); 479 TAILQ_INSERT_TAIL(&periph->periph_xferq, xs, device_q); 480 splx(s); 481 } 482 return (xs); 483 } 484 485 /* 486 * scsipi_put_xs: 487 * 488 * Release an xfer descriptor, decreasing the outstanding command 489 * count for the peripherial. If there is a thread waiting for 490 * an opening, wake it up. If not, kick any queued I/O the 491 * peripherial may have. 492 * 493 * NOTE: Must be called at splbio(). 494 */ 495 void 496 scsipi_put_xs(struct scsipi_xfer *xs) 497 { 498 struct scsipi_periph *periph = xs->xs_periph; 499 int flags = xs->xs_control; 500 501 SC_DEBUG(periph, SCSIPI_DB3, ("scsipi_free_xs\n")); 502 503 TAILQ_REMOVE(&periph->periph_xferq, xs, device_q); 504 callout_destroy(&xs->xs_callout); 505 pool_put(&scsipi_xfer_pool, xs); 506 507 #ifdef DIAGNOSTIC 508 if ((periph->periph_flags & PERIPH_RECOVERY_ACTIVE) != 0 && 509 periph->periph_active == 0) { 510 scsipi_printaddr(periph); 511 printf("recovery without a command to recovery for\n"); 512 panic("scsipi_put_xs"); 513 } 514 #endif 515 516 if (flags & XS_CTL_URGENT) { 517 if ((flags & XS_CTL_REQSENSE) == 0) 518 periph->periph_flags &= ~PERIPH_RECOVERY_ACTIVE; 519 } else 520 periph->periph_active--; 521 if (periph->periph_active == 0 && 522 (periph->periph_flags & PERIPH_WAITDRAIN) != 0) { 523 periph->periph_flags &= ~PERIPH_WAITDRAIN; 524 wakeup(&periph->periph_active); 525 } 526 527 if (periph->periph_flags & PERIPH_WAITING) { 528 periph->periph_flags &= ~PERIPH_WAITING; 529 wakeup(periph); 530 } else { 531 if (periph->periph_switch->psw_start != NULL && 532 device_is_active(periph->periph_dev)) { 533 SC_DEBUG(periph, SCSIPI_DB2, 534 ("calling private start()\n")); 535 (*periph->periph_switch->psw_start)(periph); 536 } 537 } 538 } 539 540 /* 541 * scsipi_channel_freeze: 542 * 543 * Freeze a channel's xfer queue. 544 */ 545 void 546 scsipi_channel_freeze(struct scsipi_channel *chan, int count) 547 { 548 int s; 549 550 s = splbio(); 551 chan->chan_qfreeze += count; 552 splx(s); 553 } 554 555 /* 556 * scsipi_channel_thaw: 557 * 558 * Thaw a channel's xfer queue. 559 */ 560 void 561 scsipi_channel_thaw(struct scsipi_channel *chan, int count) 562 { 563 int s; 564 565 s = splbio(); 566 chan->chan_qfreeze -= count; 567 /* 568 * Don't let the freeze count go negative. 569 * 570 * Presumably the adapter driver could keep track of this, 571 * but it might just be easier to do this here so as to allow 572 * multiple callers, including those outside the adapter driver. 573 */ 574 if (chan->chan_qfreeze < 0) { 575 chan->chan_qfreeze = 0; 576 } 577 splx(s); 578 /* 579 * Kick the channel's queue here. Note, we may be running in 580 * interrupt context (softclock or HBA's interrupt), so the adapter 581 * driver had better not sleep. 582 */ 583 if (chan->chan_qfreeze == 0) 584 scsipi_run_queue(chan); 585 } 586 587 /* 588 * scsipi_channel_timed_thaw: 589 * 590 * Thaw a channel after some time has expired. This will also 591 * run the channel's queue if the freeze count has reached 0. 592 */ 593 void 594 scsipi_channel_timed_thaw(void *arg) 595 { 596 struct scsipi_channel *chan = arg; 597 598 scsipi_channel_thaw(chan, 1); 599 } 600 601 /* 602 * scsipi_periph_freeze: 603 * 604 * Freeze a device's xfer queue. 605 */ 606 void 607 scsipi_periph_freeze(struct scsipi_periph *periph, int count) 608 { 609 int s; 610 611 s = splbio(); 612 periph->periph_qfreeze += count; 613 splx(s); 614 } 615 616 /* 617 * scsipi_periph_thaw: 618 * 619 * Thaw a device's xfer queue. 620 */ 621 void 622 scsipi_periph_thaw(struct scsipi_periph *periph, int count) 623 { 624 int s; 625 626 s = splbio(); 627 periph->periph_qfreeze -= count; 628 #ifdef DIAGNOSTIC 629 if (periph->periph_qfreeze < 0) { 630 static const char pc[] = "periph freeze count < 0"; 631 scsipi_printaddr(periph); 632 printf("%s\n", pc); 633 panic(pc); 634 } 635 #endif 636 if (periph->periph_qfreeze == 0 && 637 (periph->periph_flags & PERIPH_WAITING) != 0) 638 wakeup(periph); 639 splx(s); 640 } 641 642 /* 643 * scsipi_periph_timed_thaw: 644 * 645 * Thaw a device after some time has expired. 646 */ 647 void 648 scsipi_periph_timed_thaw(void *arg) 649 { 650 int s; 651 struct scsipi_periph *periph = arg; 652 653 callout_stop(&periph->periph_callout); 654 655 s = splbio(); 656 scsipi_periph_thaw(periph, 1); 657 if ((periph->periph_channel->chan_flags & SCSIPI_CHAN_TACTIVE) == 0) { 658 /* 659 * Kick the channel's queue here. Note, we're running in 660 * interrupt context (softclock), so the adapter driver 661 * had better not sleep. 662 */ 663 scsipi_run_queue(periph->periph_channel); 664 } else { 665 /* 666 * Tell the completion thread to kick the channel's queue here. 667 */ 668 periph->periph_channel->chan_tflags |= SCSIPI_CHANT_KICK; 669 wakeup(&periph->periph_channel->chan_complete); 670 } 671 splx(s); 672 } 673 674 /* 675 * scsipi_wait_drain: 676 * 677 * Wait for a periph's pending xfers to drain. 678 */ 679 void 680 scsipi_wait_drain(struct scsipi_periph *periph) 681 { 682 int s; 683 684 s = splbio(); 685 while (periph->periph_active != 0) { 686 periph->periph_flags |= PERIPH_WAITDRAIN; 687 (void) tsleep(&periph->periph_active, PRIBIO, "sxdrn", 0); 688 } 689 splx(s); 690 } 691 692 /* 693 * scsipi_kill_pending: 694 * 695 * Kill off all pending xfers for a periph. 696 * 697 * NOTE: Must be called at splbio(). 698 */ 699 void 700 scsipi_kill_pending(struct scsipi_periph *periph) 701 { 702 703 (*periph->periph_channel->chan_bustype->bustype_kill_pending)(periph); 704 scsipi_wait_drain(periph); 705 } 706 707 /* 708 * scsipi_print_cdb: 709 * prints a command descriptor block (for debug purpose, error messages, 710 * SCSIVERBOSE, ...) 711 */ 712 void 713 scsipi_print_cdb(struct scsipi_generic *cmd) 714 { 715 int i, j; 716 717 printf("0x%02x", cmd->opcode); 718 719 switch (CDB_GROUPID(cmd->opcode)) { 720 case CDB_GROUPID_0: 721 j = CDB_GROUP0; 722 break; 723 case CDB_GROUPID_1: 724 j = CDB_GROUP1; 725 break; 726 case CDB_GROUPID_2: 727 j = CDB_GROUP2; 728 break; 729 case CDB_GROUPID_3: 730 j = CDB_GROUP3; 731 break; 732 case CDB_GROUPID_4: 733 j = CDB_GROUP4; 734 break; 735 case CDB_GROUPID_5: 736 j = CDB_GROUP5; 737 break; 738 case CDB_GROUPID_6: 739 j = CDB_GROUP6; 740 break; 741 case CDB_GROUPID_7: 742 j = CDB_GROUP7; 743 break; 744 default: 745 j = 0; 746 } 747 if (j == 0) 748 j = sizeof (cmd->bytes); 749 for (i = 0; i < j-1; i++) /* already done the opcode */ 750 printf(" %02x", cmd->bytes[i]); 751 } 752 753 /* 754 * scsipi_interpret_sense: 755 * 756 * Look at the returned sense and act on the error, determining 757 * the unix error number to pass back. (0 = report no error) 758 * 759 * NOTE: If we return ERESTART, we are expected to haved 760 * thawed the device! 761 * 762 * THIS IS THE DEFAULT ERROR HANDLER FOR SCSI DEVICES. 763 */ 764 int 765 scsipi_interpret_sense(struct scsipi_xfer *xs) 766 { 767 struct scsi_sense_data *sense; 768 struct scsipi_periph *periph = xs->xs_periph; 769 u_int8_t key; 770 int error; 771 u_int32_t info; 772 static const char *error_mes[] = { 773 "soft error (corrected)", 774 "not ready", "medium error", 775 "non-media hardware failure", "illegal request", 776 "unit attention", "readonly device", 777 "no data found", "vendor unique", 778 "copy aborted", "command aborted", 779 "search returned equal", "volume overflow", 780 "verify miscompare", "unknown error key" 781 }; 782 783 sense = &xs->sense.scsi_sense; 784 #ifdef SCSIPI_DEBUG 785 if (periph->periph_flags & SCSIPI_DB1) { 786 int count; 787 scsipi_printaddr(periph); 788 printf(" sense debug information:\n"); 789 printf("\tcode 0x%x valid %d\n", 790 SSD_RCODE(sense->response_code), 791 sense->response_code & SSD_RCODE_VALID ? 1 : 0); 792 printf("\tseg 0x%x key 0x%x ili 0x%x eom 0x%x fmark 0x%x\n", 793 sense->segment, 794 SSD_SENSE_KEY(sense->flags), 795 sense->flags & SSD_ILI ? 1 : 0, 796 sense->flags & SSD_EOM ? 1 : 0, 797 sense->flags & SSD_FILEMARK ? 1 : 0); 798 printf("\ninfo: 0x%x 0x%x 0x%x 0x%x followed by %d " 799 "extra bytes\n", 800 sense->info[0], 801 sense->info[1], 802 sense->info[2], 803 sense->info[3], 804 sense->extra_len); 805 printf("\textra: "); 806 for (count = 0; count < SSD_ADD_BYTES_LIM(sense); count++) 807 printf("0x%x ", sense->csi[count]); 808 printf("\n"); 809 } 810 #endif 811 812 /* 813 * If the periph has it's own error handler, call it first. 814 * If it returns a legit error value, return that, otherwise 815 * it wants us to continue with normal error processing. 816 */ 817 if (periph->periph_switch->psw_error != NULL) { 818 SC_DEBUG(periph, SCSIPI_DB2, 819 ("calling private err_handler()\n")); 820 error = (*periph->periph_switch->psw_error)(xs); 821 if (error != EJUSTRETURN) 822 return (error); 823 } 824 /* otherwise use the default */ 825 switch (SSD_RCODE(sense->response_code)) { 826 827 /* 828 * Old SCSI-1 and SASI devices respond with 829 * codes other than 70. 830 */ 831 case 0x00: /* no error (command completed OK) */ 832 return (0); 833 case 0x04: /* drive not ready after it was selected */ 834 if ((periph->periph_flags & PERIPH_REMOVABLE) != 0) 835 periph->periph_flags &= ~PERIPH_MEDIA_LOADED; 836 if ((xs->xs_control & XS_CTL_IGNORE_NOT_READY) != 0) 837 return (0); 838 /* XXX - display some sort of error here? */ 839 return (EIO); 840 case 0x20: /* invalid command */ 841 if ((xs->xs_control & 842 XS_CTL_IGNORE_ILLEGAL_REQUEST) != 0) 843 return (0); 844 return (EINVAL); 845 case 0x25: /* invalid LUN (Adaptec ACB-4000) */ 846 return (EACCES); 847 848 /* 849 * If it's code 70, use the extended stuff and 850 * interpret the key 851 */ 852 case 0x71: /* delayed error */ 853 scsipi_printaddr(periph); 854 key = SSD_SENSE_KEY(sense->flags); 855 printf(" DEFERRED ERROR, key = 0x%x\n", key); 856 /* FALLTHROUGH */ 857 case 0x70: 858 if ((sense->response_code & SSD_RCODE_VALID) != 0) 859 info = _4btol(sense->info); 860 else 861 info = 0; 862 key = SSD_SENSE_KEY(sense->flags); 863 864 switch (key) { 865 case SKEY_NO_SENSE: 866 case SKEY_RECOVERED_ERROR: 867 if (xs->resid == xs->datalen && xs->datalen) { 868 /* 869 * Why is this here? 870 */ 871 xs->resid = 0; /* not short read */ 872 } 873 case SKEY_EQUAL: 874 error = 0; 875 break; 876 case SKEY_NOT_READY: 877 if ((periph->periph_flags & PERIPH_REMOVABLE) != 0) 878 periph->periph_flags &= ~PERIPH_MEDIA_LOADED; 879 if ((xs->xs_control & XS_CTL_IGNORE_NOT_READY) != 0) 880 return (0); 881 if (sense->asc == 0x3A) { 882 error = ENODEV; /* Medium not present */ 883 if (xs->xs_control & XS_CTL_SILENT_NODEV) 884 return (error); 885 } else 886 error = EIO; 887 if ((xs->xs_control & XS_CTL_SILENT) != 0) 888 return (error); 889 break; 890 case SKEY_ILLEGAL_REQUEST: 891 if ((xs->xs_control & 892 XS_CTL_IGNORE_ILLEGAL_REQUEST) != 0) 893 return (0); 894 /* 895 * Handle the case where a device reports 896 * Logical Unit Not Supported during discovery. 897 */ 898 if ((xs->xs_control & XS_CTL_DISCOVERY) != 0 && 899 sense->asc == 0x25 && 900 sense->ascq == 0x00) 901 return (EINVAL); 902 if ((xs->xs_control & XS_CTL_SILENT) != 0) 903 return (EIO); 904 error = EINVAL; 905 break; 906 case SKEY_UNIT_ATTENTION: 907 if (sense->asc == 0x29 && 908 sense->ascq == 0x00) { 909 /* device or bus reset */ 910 return (ERESTART); 911 } 912 if ((periph->periph_flags & PERIPH_REMOVABLE) != 0) 913 periph->periph_flags &= ~PERIPH_MEDIA_LOADED; 914 if ((xs->xs_control & 915 XS_CTL_IGNORE_MEDIA_CHANGE) != 0 || 916 /* XXX Should reupload any transient state. */ 917 (periph->periph_flags & 918 PERIPH_REMOVABLE) == 0) { 919 return (ERESTART); 920 } 921 if ((xs->xs_control & XS_CTL_SILENT) != 0) 922 return (EIO); 923 error = EIO; 924 break; 925 case SKEY_DATA_PROTECT: 926 error = EROFS; 927 break; 928 case SKEY_BLANK_CHECK: 929 error = 0; 930 break; 931 case SKEY_ABORTED_COMMAND: 932 if (xs->xs_retries != 0) { 933 xs->xs_retries--; 934 error = ERESTART; 935 } else 936 error = EIO; 937 break; 938 case SKEY_VOLUME_OVERFLOW: 939 error = ENOSPC; 940 break; 941 default: 942 error = EIO; 943 break; 944 } 945 946 /* Print verbose decode if appropriate and possible */ 947 if ((key == 0) || 948 ((xs->xs_control & XS_CTL_SILENT) != 0) || 949 (scsipi_print_sense(xs, 0) != 0)) 950 return (error); 951 952 /* Print brief(er) sense information */ 953 scsipi_printaddr(periph); 954 printf("%s", error_mes[key - 1]); 955 if ((sense->response_code & SSD_RCODE_VALID) != 0) { 956 switch (key) { 957 case SKEY_NOT_READY: 958 case SKEY_ILLEGAL_REQUEST: 959 case SKEY_UNIT_ATTENTION: 960 case SKEY_DATA_PROTECT: 961 break; 962 case SKEY_BLANK_CHECK: 963 printf(", requested size: %d (decimal)", 964 info); 965 break; 966 case SKEY_ABORTED_COMMAND: 967 if (xs->xs_retries) 968 printf(", retrying"); 969 printf(", cmd 0x%x, info 0x%x", 970 xs->cmd->opcode, info); 971 break; 972 default: 973 printf(", info = %d (decimal)", info); 974 } 975 } 976 if (sense->extra_len != 0) { 977 int n; 978 printf(", data ="); 979 for (n = 0; n < sense->extra_len; n++) 980 printf(" %02x", 981 sense->csi[n]); 982 } 983 printf("\n"); 984 return (error); 985 986 /* 987 * Some other code, just report it 988 */ 989 default: 990 #if defined(SCSIDEBUG) || defined(DEBUG) 991 { 992 static const char *uc = "undecodable sense error"; 993 int i; 994 u_int8_t *cptr = (u_int8_t *) sense; 995 scsipi_printaddr(periph); 996 if (xs->cmd == &xs->cmdstore) { 997 printf("%s for opcode 0x%x, data=", 998 uc, xs->cmdstore.opcode); 999 } else { 1000 printf("%s, data=", uc); 1001 } 1002 for (i = 0; i < sizeof (sense); i++) 1003 printf(" 0x%02x", *(cptr++) & 0xff); 1004 printf("\n"); 1005 } 1006 #else 1007 scsipi_printaddr(periph); 1008 printf("Sense Error Code 0x%x", 1009 SSD_RCODE(sense->response_code)); 1010 if ((sense->response_code & SSD_RCODE_VALID) != 0) { 1011 struct scsi_sense_data_unextended *usense = 1012 (struct scsi_sense_data_unextended *)sense; 1013 printf(" at block no. %d (decimal)", 1014 _3btol(usense->block)); 1015 } 1016 printf("\n"); 1017 #endif 1018 return (EIO); 1019 } 1020 } 1021 1022 /* 1023 * scsipi_test_unit_ready: 1024 * 1025 * Issue a `test unit ready' request. 1026 */ 1027 int 1028 scsipi_test_unit_ready(struct scsipi_periph *periph, int flags) 1029 { 1030 struct scsi_test_unit_ready cmd; 1031 int retries; 1032 1033 /* some ATAPI drives don't support TEST UNIT READY. Sigh */ 1034 if (periph->periph_quirks & PQUIRK_NOTUR) 1035 return (0); 1036 1037 if (flags & XS_CTL_DISCOVERY) 1038 retries = 0; 1039 else 1040 retries = SCSIPIRETRIES; 1041 1042 memset(&cmd, 0, sizeof(cmd)); 1043 cmd.opcode = SCSI_TEST_UNIT_READY; 1044 1045 return (scsipi_command(periph, (void *)&cmd, sizeof(cmd), 0, 0, 1046 retries, 10000, NULL, flags)); 1047 } 1048 1049 /* 1050 * scsipi_inquire: 1051 * 1052 * Ask the device about itself. 1053 */ 1054 int 1055 scsipi_inquire(struct scsipi_periph *periph, struct scsipi_inquiry_data *inqbuf, 1056 int flags) 1057 { 1058 struct scsipi_inquiry cmd; 1059 int error; 1060 int retries; 1061 1062 if (flags & XS_CTL_DISCOVERY) 1063 retries = 0; 1064 else 1065 retries = SCSIPIRETRIES; 1066 1067 /* 1068 * If we request more data than the device can provide, it SHOULD just 1069 * return a short reponse. However, some devices error with an 1070 * ILLEGAL REQUEST sense code, and yet others have even more special 1071 * failture modes (such as the GL641USB flash adapter, which goes loony 1072 * and sends corrupted CRCs). To work around this, and to bring our 1073 * behavior more in line with other OSes, we do a shorter inquiry, 1074 * covering all the SCSI-2 information, first, and then request more 1075 * data iff the "additional length" field indicates there is more. 1076 * - mycroft, 2003/10/16 1077 */ 1078 memset(&cmd, 0, sizeof(cmd)); 1079 cmd.opcode = INQUIRY; 1080 cmd.length = SCSIPI_INQUIRY_LENGTH_SCSI2; 1081 error = scsipi_command(periph, (void *)&cmd, sizeof(cmd), 1082 (void *)inqbuf, SCSIPI_INQUIRY_LENGTH_SCSI2, retries, 1083 10000, NULL, flags | XS_CTL_DATA_IN); 1084 if (!error && 1085 inqbuf->additional_length > SCSIPI_INQUIRY_LENGTH_SCSI2 - 4) { 1086 #if 0 1087 printf("inquire: addlen=%d, retrying\n", inqbuf->additional_length); 1088 #endif 1089 cmd.length = SCSIPI_INQUIRY_LENGTH_SCSI3; 1090 error = scsipi_command(periph, (void *)&cmd, sizeof(cmd), 1091 (void *)inqbuf, SCSIPI_INQUIRY_LENGTH_SCSI3, retries, 1092 10000, NULL, flags | XS_CTL_DATA_IN); 1093 #if 0 1094 printf("inquire: error=%d\n", error); 1095 #endif 1096 } 1097 1098 #ifdef SCSI_OLD_NOINQUIRY 1099 /* 1100 * Kludge for the Adaptec ACB-4000 SCSI->MFM translator. 1101 * This board doesn't support the INQUIRY command at all. 1102 */ 1103 if (error == EINVAL || error == EACCES) { 1104 /* 1105 * Conjure up an INQUIRY response. 1106 */ 1107 inqbuf->device = (error == EINVAL ? 1108 SID_QUAL_LU_PRESENT : 1109 SID_QUAL_LU_NOTPRESENT) | T_DIRECT; 1110 inqbuf->dev_qual2 = 0; 1111 inqbuf->version = 0; 1112 inqbuf->response_format = SID_FORMAT_SCSI1; 1113 inqbuf->additional_length = SCSIPI_INQUIRY_LENGTH_SCSI2 - 4; 1114 inqbuf->flags1 = inqbuf->flags2 = inqbuf->flags3 = 0; 1115 memcpy(inqbuf->vendor, "ADAPTEC ACB-4000 ", 28); 1116 error = 0; 1117 } 1118 1119 /* 1120 * Kludge for the Emulex MT-02 SCSI->QIC translator. 1121 * This board gives an empty response to an INQUIRY command. 1122 */ 1123 else if (error == 0 && 1124 inqbuf->device == (SID_QUAL_LU_PRESENT | T_DIRECT) && 1125 inqbuf->dev_qual2 == 0 && 1126 inqbuf->version == 0 && 1127 inqbuf->response_format == SID_FORMAT_SCSI1) { 1128 /* 1129 * Fill out the INQUIRY response. 1130 */ 1131 inqbuf->device = (SID_QUAL_LU_PRESENT | T_SEQUENTIAL); 1132 inqbuf->dev_qual2 = SID_REMOVABLE; 1133 inqbuf->additional_length = SCSIPI_INQUIRY_LENGTH_SCSI2 - 4; 1134 inqbuf->flags1 = inqbuf->flags2 = inqbuf->flags3 = 0; 1135 memcpy(inqbuf->vendor, "EMULEX MT-02 QIC ", 28); 1136 } 1137 #endif /* SCSI_OLD_NOINQUIRY */ 1138 1139 return error; 1140 } 1141 1142 /* 1143 * scsipi_prevent: 1144 * 1145 * Prevent or allow the user to remove the media 1146 */ 1147 int 1148 scsipi_prevent(struct scsipi_periph *periph, int type, int flags) 1149 { 1150 struct scsi_prevent_allow_medium_removal cmd; 1151 1152 if (periph->periph_quirks & PQUIRK_NODOORLOCK) 1153 return 0; 1154 1155 memset(&cmd, 0, sizeof(cmd)); 1156 cmd.opcode = SCSI_PREVENT_ALLOW_MEDIUM_REMOVAL; 1157 cmd.how = type; 1158 1159 return (scsipi_command(periph, (void *)&cmd, sizeof(cmd), 0, 0, 1160 SCSIPIRETRIES, 5000, NULL, flags)); 1161 } 1162 1163 /* 1164 * scsipi_start: 1165 * 1166 * Send a START UNIT. 1167 */ 1168 int 1169 scsipi_start(struct scsipi_periph *periph, int type, int flags) 1170 { 1171 struct scsipi_start_stop cmd; 1172 1173 memset(&cmd, 0, sizeof(cmd)); 1174 cmd.opcode = START_STOP; 1175 cmd.byte2 = 0x00; 1176 cmd.how = type; 1177 1178 return (scsipi_command(periph, (void *)&cmd, sizeof(cmd), 0, 0, 1179 SCSIPIRETRIES, (type & SSS_START) ? 60000 : 10000, NULL, flags)); 1180 } 1181 1182 /* 1183 * scsipi_mode_sense, scsipi_mode_sense_big: 1184 * get a sense page from a device 1185 */ 1186 1187 int 1188 scsipi_mode_sense(struct scsipi_periph *periph, int byte2, int page, 1189 struct scsi_mode_parameter_header_6 *data, int len, int flags, int retries, 1190 int timeout) 1191 { 1192 struct scsi_mode_sense_6 cmd; 1193 1194 memset(&cmd, 0, sizeof(cmd)); 1195 cmd.opcode = SCSI_MODE_SENSE_6; 1196 cmd.byte2 = byte2; 1197 cmd.page = page; 1198 cmd.length = len & 0xff; 1199 1200 return (scsipi_command(periph, (void *)&cmd, sizeof(cmd), 1201 (void *)data, len, retries, timeout, NULL, flags | XS_CTL_DATA_IN)); 1202 } 1203 1204 int 1205 scsipi_mode_sense_big(struct scsipi_periph *periph, int byte2, int page, 1206 struct scsi_mode_parameter_header_10 *data, int len, int flags, int retries, 1207 int timeout) 1208 { 1209 struct scsi_mode_sense_10 cmd; 1210 1211 memset(&cmd, 0, sizeof(cmd)); 1212 cmd.opcode = SCSI_MODE_SENSE_10; 1213 cmd.byte2 = byte2; 1214 cmd.page = page; 1215 _lto2b(len, cmd.length); 1216 1217 return (scsipi_command(periph, (void *)&cmd, sizeof(cmd), 1218 (void *)data, len, retries, timeout, NULL, flags | XS_CTL_DATA_IN)); 1219 } 1220 1221 int 1222 scsipi_mode_select(struct scsipi_periph *periph, int byte2, 1223 struct scsi_mode_parameter_header_6 *data, int len, int flags, int retries, 1224 int timeout) 1225 { 1226 struct scsi_mode_select_6 cmd; 1227 1228 memset(&cmd, 0, sizeof(cmd)); 1229 cmd.opcode = SCSI_MODE_SELECT_6; 1230 cmd.byte2 = byte2; 1231 cmd.length = len & 0xff; 1232 1233 return (scsipi_command(periph, (void *)&cmd, sizeof(cmd), 1234 (void *)data, len, retries, timeout, NULL, flags | XS_CTL_DATA_OUT)); 1235 } 1236 1237 int 1238 scsipi_mode_select_big(struct scsipi_periph *periph, int byte2, 1239 struct scsi_mode_parameter_header_10 *data, int len, int flags, int retries, 1240 int timeout) 1241 { 1242 struct scsi_mode_select_10 cmd; 1243 1244 memset(&cmd, 0, sizeof(cmd)); 1245 cmd.opcode = SCSI_MODE_SELECT_10; 1246 cmd.byte2 = byte2; 1247 _lto2b(len, cmd.length); 1248 1249 return (scsipi_command(periph, (void *)&cmd, sizeof(cmd), 1250 (void *)data, len, retries, timeout, NULL, flags | XS_CTL_DATA_OUT)); 1251 } 1252 1253 /* 1254 * scsipi_done: 1255 * 1256 * This routine is called by an adapter's interrupt handler when 1257 * an xfer is completed. 1258 */ 1259 void 1260 scsipi_done(struct scsipi_xfer *xs) 1261 { 1262 struct scsipi_periph *periph = xs->xs_periph; 1263 struct scsipi_channel *chan = periph->periph_channel; 1264 int s, freezecnt; 1265 1266 KASSERT(KERNEL_LOCKED_P()); 1267 1268 SC_DEBUG(periph, SCSIPI_DB2, ("scsipi_done\n")); 1269 #ifdef SCSIPI_DEBUG 1270 if (periph->periph_dbflags & SCSIPI_DB1) 1271 show_scsipi_cmd(xs); 1272 #endif 1273 1274 s = splbio(); 1275 /* 1276 * The resource this command was using is now free. 1277 */ 1278 if (xs->xs_status & XS_STS_DONE) { 1279 /* XXX in certain circumstances, such as a device 1280 * being detached, a xs that has already been 1281 * scsipi_done()'d by the main thread will be done'd 1282 * again by scsibusdetach(). Putting the xs on the 1283 * chan_complete queue causes list corruption and 1284 * everyone dies. This prevents that, but perhaps 1285 * there should be better coordination somewhere such 1286 * that this won't ever happen (and can be turned into 1287 * a KASSERT(). 1288 */ 1289 splx(s); 1290 goto out; 1291 } 1292 scsipi_put_resource(chan); 1293 xs->xs_periph->periph_sent--; 1294 1295 /* 1296 * If the command was tagged, free the tag. 1297 */ 1298 if (XS_CTL_TAGTYPE(xs) != 0) 1299 scsipi_put_tag(xs); 1300 else 1301 periph->periph_flags &= ~PERIPH_UNTAG; 1302 1303 /* Mark the command as `done'. */ 1304 xs->xs_status |= XS_STS_DONE; 1305 1306 #ifdef DIAGNOSTIC 1307 if ((xs->xs_control & (XS_CTL_ASYNC|XS_CTL_POLL)) == 1308 (XS_CTL_ASYNC|XS_CTL_POLL)) 1309 panic("scsipi_done: ASYNC and POLL"); 1310 #endif 1311 1312 /* 1313 * If the xfer had an error of any sort, freeze the 1314 * periph's queue. Freeze it again if we were requested 1315 * to do so in the xfer. 1316 */ 1317 freezecnt = 0; 1318 if (xs->error != XS_NOERROR) 1319 freezecnt++; 1320 if (xs->xs_control & XS_CTL_FREEZE_PERIPH) 1321 freezecnt++; 1322 if (freezecnt != 0) 1323 scsipi_periph_freeze(periph, freezecnt); 1324 1325 /* 1326 * record the xfer with a pending sense, in case a SCSI reset is 1327 * received before the thread is waked up. 1328 */ 1329 if (xs->error == XS_BUSY && xs->status == SCSI_CHECK) { 1330 periph->periph_flags |= PERIPH_SENSE; 1331 periph->periph_xscheck = xs; 1332 } 1333 1334 /* 1335 * If this was an xfer that was not to complete asynchronously, 1336 * let the requesting thread perform error checking/handling 1337 * in its context. 1338 */ 1339 if ((xs->xs_control & XS_CTL_ASYNC) == 0) { 1340 splx(s); 1341 /* 1342 * If it's a polling job, just return, to unwind the 1343 * call graph. We don't need to restart the queue, 1344 * because pollings jobs are treated specially, and 1345 * are really only used during crash dumps anyway 1346 * (XXX or during boot-time autconfiguration of 1347 * ATAPI devices). 1348 */ 1349 if (xs->xs_control & XS_CTL_POLL) 1350 return; 1351 wakeup(xs); 1352 goto out; 1353 } 1354 1355 /* 1356 * Catch the extremely common case of I/O completing 1357 * without error; no use in taking a context switch 1358 * if we can handle it in interrupt context. 1359 */ 1360 if (xs->error == XS_NOERROR) { 1361 splx(s); 1362 (void) scsipi_complete(xs); 1363 goto out; 1364 } 1365 1366 /* 1367 * There is an error on this xfer. Put it on the channel's 1368 * completion queue, and wake up the completion thread. 1369 */ 1370 TAILQ_INSERT_TAIL(&chan->chan_complete, xs, channel_q); 1371 splx(s); 1372 wakeup(&chan->chan_complete); 1373 1374 out: 1375 /* 1376 * If there are more xfers on the channel's queue, attempt to 1377 * run them. 1378 */ 1379 scsipi_run_queue(chan); 1380 } 1381 1382 /* 1383 * scsipi_complete: 1384 * 1385 * Completion of a scsipi_xfer. This is the guts of scsipi_done(). 1386 * 1387 * NOTE: This routine MUST be called with valid thread context 1388 * except for the case where the following two conditions are 1389 * true: 1390 * 1391 * xs->error == XS_NOERROR 1392 * XS_CTL_ASYNC is set in xs->xs_control 1393 * 1394 * The semantics of this routine can be tricky, so here is an 1395 * explanation: 1396 * 1397 * 0 Xfer completed successfully. 1398 * 1399 * ERESTART Xfer had an error, but was restarted. 1400 * 1401 * anything else Xfer had an error, return value is Unix 1402 * errno. 1403 * 1404 * If the return value is anything but ERESTART: 1405 * 1406 * - If XS_CTL_ASYNC is set, `xs' has been freed back to 1407 * the pool. 1408 * - If there is a buf associated with the xfer, 1409 * it has been biodone()'d. 1410 */ 1411 static int 1412 scsipi_complete(struct scsipi_xfer *xs) 1413 { 1414 struct scsipi_periph *periph = xs->xs_periph; 1415 struct scsipi_channel *chan = periph->periph_channel; 1416 int error, s; 1417 1418 #ifdef DIAGNOSTIC 1419 if ((xs->xs_control & XS_CTL_ASYNC) != 0 && xs->bp == NULL) 1420 panic("scsipi_complete: XS_CTL_ASYNC but no buf"); 1421 #endif 1422 /* 1423 * If command terminated with a CHECK CONDITION, we need to issue a 1424 * REQUEST_SENSE command. Once the REQUEST_SENSE has been processed 1425 * we'll have the real status. 1426 * Must be processed at splbio() to avoid missing a SCSI bus reset 1427 * for this command. 1428 */ 1429 s = splbio(); 1430 if (xs->error == XS_BUSY && xs->status == SCSI_CHECK) { 1431 /* request sense for a request sense ? */ 1432 if (xs->xs_control & XS_CTL_REQSENSE) { 1433 scsipi_printaddr(periph); 1434 printf("request sense for a request sense ?\n"); 1435 /* XXX maybe we should reset the device ? */ 1436 /* we've been frozen because xs->error != XS_NOERROR */ 1437 scsipi_periph_thaw(periph, 1); 1438 splx(s); 1439 if (xs->resid < xs->datalen) { 1440 printf("we read %d bytes of sense anyway:\n", 1441 xs->datalen - xs->resid); 1442 scsipi_print_sense_data((void *)xs->data, 0); 1443 } 1444 return EINVAL; 1445 } 1446 scsipi_request_sense(xs); 1447 } 1448 splx(s); 1449 1450 /* 1451 * If it's a user level request, bypass all usual completion 1452 * processing, let the user work it out.. 1453 */ 1454 if ((xs->xs_control & XS_CTL_USERCMD) != 0) { 1455 SC_DEBUG(periph, SCSIPI_DB3, ("calling user done()\n")); 1456 if (xs->error != XS_NOERROR) 1457 scsipi_periph_thaw(periph, 1); 1458 scsipi_user_done(xs); 1459 SC_DEBUG(periph, SCSIPI_DB3, ("returned from user done()\n ")); 1460 return 0; 1461 } 1462 1463 switch (xs->error) { 1464 case XS_NOERROR: 1465 error = 0; 1466 break; 1467 1468 case XS_SENSE: 1469 case XS_SHORTSENSE: 1470 error = (*chan->chan_bustype->bustype_interpret_sense)(xs); 1471 break; 1472 1473 case XS_RESOURCE_SHORTAGE: 1474 /* 1475 * XXX Should freeze channel's queue. 1476 */ 1477 scsipi_printaddr(periph); 1478 printf("adapter resource shortage\n"); 1479 /* FALLTHROUGH */ 1480 1481 case XS_BUSY: 1482 if (xs->error == XS_BUSY && xs->status == SCSI_QUEUE_FULL) { 1483 struct scsipi_max_openings mo; 1484 1485 /* 1486 * We set the openings to active - 1, assuming that 1487 * the command that got us here is the first one that 1488 * can't fit into the device's queue. If that's not 1489 * the case, I guess we'll find out soon enough. 1490 */ 1491 mo.mo_target = periph->periph_target; 1492 mo.mo_lun = periph->periph_lun; 1493 if (periph->periph_active < periph->periph_openings) 1494 mo.mo_openings = periph->periph_active - 1; 1495 else 1496 mo.mo_openings = periph->periph_openings - 1; 1497 #ifdef DIAGNOSTIC 1498 if (mo.mo_openings < 0) { 1499 scsipi_printaddr(periph); 1500 printf("QUEUE FULL resulted in < 0 openings\n"); 1501 panic("scsipi_done"); 1502 } 1503 #endif 1504 if (mo.mo_openings == 0) { 1505 scsipi_printaddr(periph); 1506 printf("QUEUE FULL resulted in 0 openings\n"); 1507 mo.mo_openings = 1; 1508 } 1509 scsipi_async_event(chan, ASYNC_EVENT_MAX_OPENINGS, &mo); 1510 error = ERESTART; 1511 } else if (xs->xs_retries != 0) { 1512 xs->xs_retries--; 1513 /* 1514 * Wait one second, and try again. 1515 */ 1516 if ((xs->xs_control & XS_CTL_POLL) || 1517 (chan->chan_flags & SCSIPI_CHAN_TACTIVE) == 0) { 1518 /* XXX: quite extreme */ 1519 kpause("xsbusy", false, hz, NULL); 1520 } else if (!callout_pending(&periph->periph_callout)) { 1521 scsipi_periph_freeze(periph, 1); 1522 callout_reset(&periph->periph_callout, 1523 hz, scsipi_periph_timed_thaw, periph); 1524 } 1525 error = ERESTART; 1526 } else 1527 error = EBUSY; 1528 break; 1529 1530 case XS_REQUEUE: 1531 error = ERESTART; 1532 break; 1533 1534 case XS_SELTIMEOUT: 1535 case XS_TIMEOUT: 1536 /* 1537 * If the device hasn't gone away, honor retry counts. 1538 * 1539 * Note that if we're in the middle of probing it, 1540 * it won't be found because it isn't here yet so 1541 * we won't honor the retry count in that case. 1542 */ 1543 if (scsipi_lookup_periph(chan, periph->periph_target, 1544 periph->periph_lun) && xs->xs_retries != 0) { 1545 xs->xs_retries--; 1546 error = ERESTART; 1547 } else 1548 error = EIO; 1549 break; 1550 1551 case XS_RESET: 1552 if (xs->xs_control & XS_CTL_REQSENSE) { 1553 /* 1554 * request sense interrupted by reset: signal it 1555 * with EINTR return code. 1556 */ 1557 error = EINTR; 1558 } else { 1559 if (xs->xs_retries != 0) { 1560 xs->xs_retries--; 1561 error = ERESTART; 1562 } else 1563 error = EIO; 1564 } 1565 break; 1566 1567 case XS_DRIVER_STUFFUP: 1568 scsipi_printaddr(periph); 1569 printf("generic HBA error\n"); 1570 error = EIO; 1571 break; 1572 default: 1573 scsipi_printaddr(periph); 1574 printf("invalid return code from adapter: %d\n", xs->error); 1575 error = EIO; 1576 break; 1577 } 1578 1579 s = splbio(); 1580 if (error == ERESTART) { 1581 /* 1582 * If we get here, the periph has been thawed and frozen 1583 * again if we had to issue recovery commands. Alternatively, 1584 * it may have been frozen again and in a timed thaw. In 1585 * any case, we thaw the periph once we re-enqueue the 1586 * command. Once the periph is fully thawed, it will begin 1587 * operation again. 1588 */ 1589 xs->error = XS_NOERROR; 1590 xs->status = SCSI_OK; 1591 xs->xs_status &= ~XS_STS_DONE; 1592 xs->xs_requeuecnt++; 1593 error = scsipi_enqueue(xs); 1594 if (error == 0) { 1595 scsipi_periph_thaw(periph, 1); 1596 splx(s); 1597 return (ERESTART); 1598 } 1599 } 1600 1601 /* 1602 * scsipi_done() freezes the queue if not XS_NOERROR. 1603 * Thaw it here. 1604 */ 1605 if (xs->error != XS_NOERROR) 1606 scsipi_periph_thaw(periph, 1); 1607 1608 if (periph->periph_switch->psw_done) 1609 periph->periph_switch->psw_done(xs, error); 1610 1611 if (xs->xs_control & XS_CTL_ASYNC) 1612 scsipi_put_xs(xs); 1613 splx(s); 1614 1615 return (error); 1616 } 1617 1618 /* 1619 * Issue a request sense for the given scsipi_xfer. Called when the xfer 1620 * returns with a CHECK_CONDITION status. Must be called in valid thread 1621 * context and at splbio(). 1622 */ 1623 1624 static void 1625 scsipi_request_sense(struct scsipi_xfer *xs) 1626 { 1627 struct scsipi_periph *periph = xs->xs_periph; 1628 int flags, error; 1629 struct scsi_request_sense cmd; 1630 1631 periph->periph_flags |= PERIPH_SENSE; 1632 1633 /* if command was polling, request sense will too */ 1634 flags = xs->xs_control & XS_CTL_POLL; 1635 /* Polling commands can't sleep */ 1636 if (flags) 1637 flags |= XS_CTL_NOSLEEP; 1638 1639 flags |= XS_CTL_REQSENSE | XS_CTL_URGENT | XS_CTL_DATA_IN | 1640 XS_CTL_THAW_PERIPH | XS_CTL_FREEZE_PERIPH; 1641 1642 memset(&cmd, 0, sizeof(cmd)); 1643 cmd.opcode = SCSI_REQUEST_SENSE; 1644 cmd.length = sizeof(struct scsi_sense_data); 1645 1646 error = scsipi_command(periph, (void *)&cmd, sizeof(cmd), 1647 (void *)&xs->sense.scsi_sense, sizeof(struct scsi_sense_data), 1648 0, 1000, NULL, flags); 1649 periph->periph_flags &= ~PERIPH_SENSE; 1650 periph->periph_xscheck = NULL; 1651 switch (error) { 1652 case 0: 1653 /* we have a valid sense */ 1654 xs->error = XS_SENSE; 1655 return; 1656 case EINTR: 1657 /* REQUEST_SENSE interrupted by bus reset. */ 1658 xs->error = XS_RESET; 1659 return; 1660 case EIO: 1661 /* request sense coudn't be performed */ 1662 /* 1663 * XXX this isn't quite right but we don't have anything 1664 * better for now 1665 */ 1666 xs->error = XS_DRIVER_STUFFUP; 1667 return; 1668 default: 1669 /* Notify that request sense failed. */ 1670 xs->error = XS_DRIVER_STUFFUP; 1671 scsipi_printaddr(periph); 1672 printf("request sense failed with error %d\n", error); 1673 return; 1674 } 1675 } 1676 1677 /* 1678 * scsipi_enqueue: 1679 * 1680 * Enqueue an xfer on a channel. 1681 */ 1682 static int 1683 scsipi_enqueue(struct scsipi_xfer *xs) 1684 { 1685 struct scsipi_channel *chan = xs->xs_periph->periph_channel; 1686 struct scsipi_xfer *qxs; 1687 int s; 1688 1689 s = splbio(); 1690 1691 /* 1692 * If the xfer is to be polled, and there are already jobs on 1693 * the queue, we can't proceed. 1694 */ 1695 if ((xs->xs_control & XS_CTL_POLL) != 0 && 1696 TAILQ_FIRST(&chan->chan_queue) != NULL) { 1697 splx(s); 1698 xs->error = XS_DRIVER_STUFFUP; 1699 return (EAGAIN); 1700 } 1701 1702 /* 1703 * If we have an URGENT xfer, it's an error recovery command 1704 * and it should just go on the head of the channel's queue. 1705 */ 1706 if (xs->xs_control & XS_CTL_URGENT) { 1707 TAILQ_INSERT_HEAD(&chan->chan_queue, xs, channel_q); 1708 goto out; 1709 } 1710 1711 /* 1712 * If this xfer has already been on the queue before, we 1713 * need to reinsert it in the correct order. That order is: 1714 * 1715 * Immediately before the first xfer for this periph 1716 * with a requeuecnt less than xs->xs_requeuecnt. 1717 * 1718 * Failing that, at the end of the queue. (We'll end up 1719 * there naturally.) 1720 */ 1721 if (xs->xs_requeuecnt != 0) { 1722 for (qxs = TAILQ_FIRST(&chan->chan_queue); qxs != NULL; 1723 qxs = TAILQ_NEXT(qxs, channel_q)) { 1724 if (qxs->xs_periph == xs->xs_periph && 1725 qxs->xs_requeuecnt < xs->xs_requeuecnt) 1726 break; 1727 } 1728 if (qxs != NULL) { 1729 TAILQ_INSERT_AFTER(&chan->chan_queue, qxs, xs, 1730 channel_q); 1731 goto out; 1732 } 1733 } 1734 TAILQ_INSERT_TAIL(&chan->chan_queue, xs, channel_q); 1735 out: 1736 if (xs->xs_control & XS_CTL_THAW_PERIPH) 1737 scsipi_periph_thaw(xs->xs_periph, 1); 1738 splx(s); 1739 return (0); 1740 } 1741 1742 /* 1743 * scsipi_run_queue: 1744 * 1745 * Start as many xfers as possible running on the channel. 1746 */ 1747 static void 1748 scsipi_run_queue(struct scsipi_channel *chan) 1749 { 1750 struct scsipi_xfer *xs; 1751 struct scsipi_periph *periph; 1752 int s; 1753 1754 for (;;) { 1755 s = splbio(); 1756 1757 /* 1758 * If the channel is frozen, we can't do any work right 1759 * now. 1760 */ 1761 if (chan->chan_qfreeze != 0) { 1762 splx(s); 1763 return; 1764 } 1765 1766 /* 1767 * Look for work to do, and make sure we can do it. 1768 */ 1769 for (xs = TAILQ_FIRST(&chan->chan_queue); xs != NULL; 1770 xs = TAILQ_NEXT(xs, channel_q)) { 1771 periph = xs->xs_periph; 1772 1773 if ((periph->periph_sent >= periph->periph_openings) || 1774 periph->periph_qfreeze != 0 || 1775 (periph->periph_flags & PERIPH_UNTAG) != 0) 1776 continue; 1777 1778 if ((periph->periph_flags & 1779 (PERIPH_RECOVERING | PERIPH_SENSE)) != 0 && 1780 (xs->xs_control & XS_CTL_URGENT) == 0) 1781 continue; 1782 1783 /* 1784 * We can issue this xfer! 1785 */ 1786 goto got_one; 1787 } 1788 1789 /* 1790 * Can't find any work to do right now. 1791 */ 1792 splx(s); 1793 return; 1794 1795 got_one: 1796 /* 1797 * Have an xfer to run. Allocate a resource from 1798 * the adapter to run it. If we can't allocate that 1799 * resource, we don't dequeue the xfer. 1800 */ 1801 if (scsipi_get_resource(chan) == 0) { 1802 /* 1803 * Adapter is out of resources. If the adapter 1804 * supports it, attempt to grow them. 1805 */ 1806 if (scsipi_grow_resources(chan) == 0) { 1807 /* 1808 * Wasn't able to grow resources, 1809 * nothing more we can do. 1810 */ 1811 if (xs->xs_control & XS_CTL_POLL) { 1812 scsipi_printaddr(xs->xs_periph); 1813 printf("polling command but no " 1814 "adapter resources"); 1815 /* We'll panic shortly... */ 1816 } 1817 splx(s); 1818 1819 /* 1820 * XXX: We should be able to note that 1821 * XXX: that resources are needed here! 1822 */ 1823 return; 1824 } 1825 /* 1826 * scsipi_grow_resources() allocated the resource 1827 * for us. 1828 */ 1829 } 1830 1831 /* 1832 * We have a resource to run this xfer, do it! 1833 */ 1834 TAILQ_REMOVE(&chan->chan_queue, xs, channel_q); 1835 1836 /* 1837 * If the command is to be tagged, allocate a tag ID 1838 * for it. 1839 */ 1840 if (XS_CTL_TAGTYPE(xs) != 0) 1841 scsipi_get_tag(xs); 1842 else 1843 periph->periph_flags |= PERIPH_UNTAG; 1844 periph->periph_sent++; 1845 splx(s); 1846 1847 scsipi_adapter_request(chan, ADAPTER_REQ_RUN_XFER, xs); 1848 } 1849 #ifdef DIAGNOSTIC 1850 panic("scsipi_run_queue: impossible"); 1851 #endif 1852 } 1853 1854 /* 1855 * scsipi_execute_xs: 1856 * 1857 * Begin execution of an xfer, waiting for it to complete, if necessary. 1858 */ 1859 int 1860 scsipi_execute_xs(struct scsipi_xfer *xs) 1861 { 1862 struct scsipi_periph *periph = xs->xs_periph; 1863 struct scsipi_channel *chan = periph->periph_channel; 1864 int oasync, async, poll, error, s; 1865 1866 KASSERT(!cold); 1867 KASSERT(KERNEL_LOCKED_P()); 1868 1869 (chan->chan_bustype->bustype_cmd)(xs); 1870 1871 xs->xs_status &= ~XS_STS_DONE; 1872 xs->error = XS_NOERROR; 1873 xs->resid = xs->datalen; 1874 xs->status = SCSI_OK; 1875 1876 #ifdef SCSIPI_DEBUG 1877 if (xs->xs_periph->periph_dbflags & SCSIPI_DB3) { 1878 printf("scsipi_execute_xs: "); 1879 show_scsipi_xs(xs); 1880 printf("\n"); 1881 } 1882 #endif 1883 1884 /* 1885 * Deal with command tagging: 1886 * 1887 * - If the device's current operating mode doesn't 1888 * include tagged queueing, clear the tag mask. 1889 * 1890 * - If the device's current operating mode *does* 1891 * include tagged queueing, set the tag_type in 1892 * the xfer to the appropriate byte for the tag 1893 * message. 1894 */ 1895 if ((PERIPH_XFER_MODE(periph) & PERIPH_CAP_TQING) == 0 || 1896 (xs->xs_control & XS_CTL_REQSENSE)) { 1897 xs->xs_control &= ~XS_CTL_TAGMASK; 1898 xs->xs_tag_type = 0; 1899 } else { 1900 /* 1901 * If the request doesn't specify a tag, give Head 1902 * tags to URGENT operations and Ordered tags to 1903 * everything else. 1904 */ 1905 if (XS_CTL_TAGTYPE(xs) == 0) { 1906 if (xs->xs_control & XS_CTL_URGENT) 1907 xs->xs_control |= XS_CTL_HEAD_TAG; 1908 else 1909 xs->xs_control |= XS_CTL_ORDERED_TAG; 1910 } 1911 1912 switch (XS_CTL_TAGTYPE(xs)) { 1913 case XS_CTL_ORDERED_TAG: 1914 xs->xs_tag_type = MSG_ORDERED_Q_TAG; 1915 break; 1916 1917 case XS_CTL_SIMPLE_TAG: 1918 xs->xs_tag_type = MSG_SIMPLE_Q_TAG; 1919 break; 1920 1921 case XS_CTL_HEAD_TAG: 1922 xs->xs_tag_type = MSG_HEAD_OF_Q_TAG; 1923 break; 1924 1925 default: 1926 scsipi_printaddr(periph); 1927 printf("invalid tag mask 0x%08x\n", 1928 XS_CTL_TAGTYPE(xs)); 1929 panic("scsipi_execute_xs"); 1930 } 1931 } 1932 1933 /* If the adaptor wants us to poll, poll. */ 1934 if (chan->chan_adapter->adapt_flags & SCSIPI_ADAPT_POLL_ONLY) 1935 xs->xs_control |= XS_CTL_POLL; 1936 1937 /* 1938 * If we don't yet have a completion thread, or we are to poll for 1939 * completion, clear the ASYNC flag. 1940 */ 1941 oasync = (xs->xs_control & XS_CTL_ASYNC); 1942 if (chan->chan_thread == NULL || (xs->xs_control & XS_CTL_POLL) != 0) 1943 xs->xs_control &= ~XS_CTL_ASYNC; 1944 1945 async = (xs->xs_control & XS_CTL_ASYNC); 1946 poll = (xs->xs_control & XS_CTL_POLL); 1947 1948 #ifdef DIAGNOSTIC 1949 if (oasync != 0 && xs->bp == NULL) 1950 panic("scsipi_execute_xs: XS_CTL_ASYNC but no buf"); 1951 #endif 1952 1953 /* 1954 * Enqueue the transfer. If we're not polling for completion, this 1955 * should ALWAYS return `no error'. 1956 */ 1957 error = scsipi_enqueue(xs); 1958 if (error) { 1959 if (poll == 0) { 1960 scsipi_printaddr(periph); 1961 printf("not polling, but enqueue failed with %d\n", 1962 error); 1963 panic("scsipi_execute_xs"); 1964 } 1965 1966 scsipi_printaddr(periph); 1967 printf("should have flushed queue?\n"); 1968 goto free_xs; 1969 } 1970 1971 restarted: 1972 scsipi_run_queue(chan); 1973 1974 /* 1975 * The xfer is enqueued, and possibly running. If it's to be 1976 * completed asynchronously, just return now. 1977 */ 1978 if (async) 1979 return (0); 1980 1981 /* 1982 * Not an asynchronous command; wait for it to complete. 1983 */ 1984 s = splbio(); 1985 while ((xs->xs_status & XS_STS_DONE) == 0) { 1986 if (poll) { 1987 scsipi_printaddr(periph); 1988 printf("polling command not done\n"); 1989 panic("scsipi_execute_xs"); 1990 } 1991 (void) tsleep(xs, PRIBIO, "xscmd", 0); 1992 } 1993 splx(s); 1994 1995 /* 1996 * Command is complete. scsipi_done() has awakened us to perform 1997 * the error handling. 1998 */ 1999 error = scsipi_complete(xs); 2000 if (error == ERESTART) 2001 goto restarted; 2002 2003 /* 2004 * If it was meant to run async and we cleared aync ourselve, 2005 * don't return an error here. It has already been handled 2006 */ 2007 if (oasync) 2008 error = 0; 2009 /* 2010 * Command completed successfully or fatal error occurred. Fall 2011 * into.... 2012 */ 2013 free_xs: 2014 s = splbio(); 2015 scsipi_put_xs(xs); 2016 splx(s); 2017 2018 /* 2019 * Kick the queue, keep it running in case it stopped for some 2020 * reason. 2021 */ 2022 scsipi_run_queue(chan); 2023 2024 return (error); 2025 } 2026 2027 /* 2028 * scsipi_completion_thread: 2029 * 2030 * This is the completion thread. We wait for errors on 2031 * asynchronous xfers, and perform the error handling 2032 * function, restarting the command, if necessary. 2033 */ 2034 static void 2035 scsipi_completion_thread(void *arg) 2036 { 2037 struct scsipi_channel *chan = arg; 2038 struct scsipi_xfer *xs; 2039 int s; 2040 2041 if (chan->chan_init_cb) 2042 (*chan->chan_init_cb)(chan, chan->chan_init_cb_arg); 2043 2044 s = splbio(); 2045 chan->chan_flags |= SCSIPI_CHAN_TACTIVE; 2046 splx(s); 2047 for (;;) { 2048 s = splbio(); 2049 xs = TAILQ_FIRST(&chan->chan_complete); 2050 if (xs == NULL && chan->chan_tflags == 0) { 2051 /* nothing to do; wait */ 2052 (void) tsleep(&chan->chan_complete, PRIBIO, 2053 "sccomp", 0); 2054 splx(s); 2055 continue; 2056 } 2057 if (chan->chan_tflags & SCSIPI_CHANT_CALLBACK) { 2058 /* call chan_callback from thread context */ 2059 chan->chan_tflags &= ~SCSIPI_CHANT_CALLBACK; 2060 chan->chan_callback(chan, chan->chan_callback_arg); 2061 splx(s); 2062 continue; 2063 } 2064 if (chan->chan_tflags & SCSIPI_CHANT_GROWRES) { 2065 /* attempt to get more openings for this channel */ 2066 chan->chan_tflags &= ~SCSIPI_CHANT_GROWRES; 2067 scsipi_adapter_request(chan, 2068 ADAPTER_REQ_GROW_RESOURCES, NULL); 2069 scsipi_channel_thaw(chan, 1); 2070 splx(s); 2071 if (chan->chan_tflags & SCSIPI_CHANT_GROWRES) 2072 kpause("scsizzz", FALSE, hz/10, NULL); 2073 continue; 2074 } 2075 if (chan->chan_tflags & SCSIPI_CHANT_KICK) { 2076 /* explicitly run the queues for this channel */ 2077 chan->chan_tflags &= ~SCSIPI_CHANT_KICK; 2078 scsipi_run_queue(chan); 2079 splx(s); 2080 continue; 2081 } 2082 if (chan->chan_tflags & SCSIPI_CHANT_SHUTDOWN) { 2083 splx(s); 2084 break; 2085 } 2086 if (xs) { 2087 TAILQ_REMOVE(&chan->chan_complete, xs, channel_q); 2088 splx(s); 2089 2090 /* 2091 * Have an xfer with an error; process it. 2092 */ 2093 (void) scsipi_complete(xs); 2094 2095 /* 2096 * Kick the queue; keep it running if it was stopped 2097 * for some reason. 2098 */ 2099 scsipi_run_queue(chan); 2100 } else { 2101 splx(s); 2102 } 2103 } 2104 2105 chan->chan_thread = NULL; 2106 2107 /* In case parent is waiting for us to exit. */ 2108 wakeup(&chan->chan_thread); 2109 2110 kthread_exit(0); 2111 } 2112 /* 2113 * scsipi_thread_call_callback: 2114 * 2115 * request to call a callback from the completion thread 2116 */ 2117 int 2118 scsipi_thread_call_callback(struct scsipi_channel *chan, 2119 void (*callback)(struct scsipi_channel *, void *), void *arg) 2120 { 2121 int s; 2122 2123 s = splbio(); 2124 if ((chan->chan_flags & SCSIPI_CHAN_TACTIVE) == 0) { 2125 /* kernel thread doesn't exist yet */ 2126 splx(s); 2127 return ESRCH; 2128 } 2129 if (chan->chan_tflags & SCSIPI_CHANT_CALLBACK) { 2130 splx(s); 2131 return EBUSY; 2132 } 2133 scsipi_channel_freeze(chan, 1); 2134 chan->chan_callback = callback; 2135 chan->chan_callback_arg = arg; 2136 chan->chan_tflags |= SCSIPI_CHANT_CALLBACK; 2137 wakeup(&chan->chan_complete); 2138 splx(s); 2139 return(0); 2140 } 2141 2142 /* 2143 * scsipi_async_event: 2144 * 2145 * Handle an asynchronous event from an adapter. 2146 */ 2147 void 2148 scsipi_async_event(struct scsipi_channel *chan, scsipi_async_event_t event, 2149 void *arg) 2150 { 2151 int s; 2152 2153 s = splbio(); 2154 switch (event) { 2155 case ASYNC_EVENT_MAX_OPENINGS: 2156 scsipi_async_event_max_openings(chan, 2157 (struct scsipi_max_openings *)arg); 2158 break; 2159 2160 case ASYNC_EVENT_XFER_MODE: 2161 scsipi_async_event_xfer_mode(chan, 2162 (struct scsipi_xfer_mode *)arg); 2163 break; 2164 case ASYNC_EVENT_RESET: 2165 scsipi_async_event_channel_reset(chan); 2166 break; 2167 } 2168 splx(s); 2169 } 2170 2171 /* 2172 * scsipi_print_xfer_mode: 2173 * 2174 * Print a periph's capabilities. 2175 */ 2176 void 2177 scsipi_print_xfer_mode(struct scsipi_periph *periph) 2178 { 2179 int period, freq, speed, mbs; 2180 2181 if ((periph->periph_flags & PERIPH_MODE_VALID) == 0) 2182 return; 2183 2184 aprint_normal_dev(periph->periph_dev, ""); 2185 if (periph->periph_mode & (PERIPH_CAP_SYNC | PERIPH_CAP_DT)) { 2186 period = scsipi_sync_factor_to_period(periph->periph_period); 2187 aprint_normal("sync (%d.%02dns offset %d)", 2188 period / 100, period % 100, periph->periph_offset); 2189 } else 2190 aprint_normal("async"); 2191 2192 if (periph->periph_mode & PERIPH_CAP_WIDE32) 2193 aprint_normal(", 32-bit"); 2194 else if (periph->periph_mode & (PERIPH_CAP_WIDE16 | PERIPH_CAP_DT)) 2195 aprint_normal(", 16-bit"); 2196 else 2197 aprint_normal(", 8-bit"); 2198 2199 if (periph->periph_mode & (PERIPH_CAP_SYNC | PERIPH_CAP_DT)) { 2200 freq = scsipi_sync_factor_to_freq(periph->periph_period); 2201 speed = freq; 2202 if (periph->periph_mode & PERIPH_CAP_WIDE32) 2203 speed *= 4; 2204 else if (periph->periph_mode & 2205 (PERIPH_CAP_WIDE16 | PERIPH_CAP_DT)) 2206 speed *= 2; 2207 mbs = speed / 1000; 2208 if (mbs > 0) 2209 aprint_normal(" (%d.%03dMB/s)", mbs, speed % 1000); 2210 else 2211 aprint_normal(" (%dKB/s)", speed % 1000); 2212 } 2213 2214 aprint_normal(" transfers"); 2215 2216 if (periph->periph_mode & PERIPH_CAP_TQING) 2217 aprint_normal(", tagged queueing"); 2218 2219 aprint_normal("\n"); 2220 } 2221 2222 /* 2223 * scsipi_async_event_max_openings: 2224 * 2225 * Update the maximum number of outstanding commands a 2226 * device may have. 2227 */ 2228 static void 2229 scsipi_async_event_max_openings(struct scsipi_channel *chan, 2230 struct scsipi_max_openings *mo) 2231 { 2232 struct scsipi_periph *periph; 2233 int minlun, maxlun; 2234 2235 if (mo->mo_lun == -1) { 2236 /* 2237 * Wildcarded; apply it to all LUNs. 2238 */ 2239 minlun = 0; 2240 maxlun = chan->chan_nluns - 1; 2241 } else 2242 minlun = maxlun = mo->mo_lun; 2243 2244 /* XXX This could really suck with a large LUN space. */ 2245 for (; minlun <= maxlun; minlun++) { 2246 periph = scsipi_lookup_periph(chan, mo->mo_target, minlun); 2247 if (periph == NULL) 2248 continue; 2249 2250 if (mo->mo_openings < periph->periph_openings) 2251 periph->periph_openings = mo->mo_openings; 2252 else if (mo->mo_openings > periph->periph_openings && 2253 (periph->periph_flags & PERIPH_GROW_OPENINGS) != 0) 2254 periph->periph_openings = mo->mo_openings; 2255 } 2256 } 2257 2258 /* 2259 * scsipi_async_event_xfer_mode: 2260 * 2261 * Update the xfer mode for all periphs sharing the 2262 * specified I_T Nexus. 2263 */ 2264 static void 2265 scsipi_async_event_xfer_mode(struct scsipi_channel *chan, 2266 struct scsipi_xfer_mode *xm) 2267 { 2268 struct scsipi_periph *periph; 2269 int lun, announce, mode, period, offset; 2270 2271 for (lun = 0; lun < chan->chan_nluns; lun++) { 2272 periph = scsipi_lookup_periph(chan, xm->xm_target, lun); 2273 if (periph == NULL) 2274 continue; 2275 announce = 0; 2276 2277 /* 2278 * Clamp the xfer mode down to this periph's capabilities. 2279 */ 2280 mode = xm->xm_mode & periph->periph_cap; 2281 if (mode & PERIPH_CAP_SYNC) { 2282 period = xm->xm_period; 2283 offset = xm->xm_offset; 2284 } else { 2285 period = 0; 2286 offset = 0; 2287 } 2288 2289 /* 2290 * If we do not have a valid xfer mode yet, or the parameters 2291 * are different, announce them. 2292 */ 2293 if ((periph->periph_flags & PERIPH_MODE_VALID) == 0 || 2294 periph->periph_mode != mode || 2295 periph->periph_period != period || 2296 periph->periph_offset != offset) 2297 announce = 1; 2298 2299 periph->periph_mode = mode; 2300 periph->periph_period = period; 2301 periph->periph_offset = offset; 2302 periph->periph_flags |= PERIPH_MODE_VALID; 2303 2304 if (announce) 2305 scsipi_print_xfer_mode(periph); 2306 } 2307 } 2308 2309 /* 2310 * scsipi_set_xfer_mode: 2311 * 2312 * Set the xfer mode for the specified I_T Nexus. 2313 */ 2314 void 2315 scsipi_set_xfer_mode(struct scsipi_channel *chan, int target, int immed) 2316 { 2317 struct scsipi_xfer_mode xm; 2318 struct scsipi_periph *itperiph; 2319 int lun, s; 2320 2321 /* 2322 * Go to the minimal xfer mode. 2323 */ 2324 xm.xm_target = target; 2325 xm.xm_mode = 0; 2326 xm.xm_period = 0; /* ignored */ 2327 xm.xm_offset = 0; /* ignored */ 2328 2329 /* 2330 * Find the first LUN we know about on this I_T Nexus. 2331 */ 2332 for (itperiph = NULL, lun = 0; lun < chan->chan_nluns; lun++) { 2333 itperiph = scsipi_lookup_periph(chan, target, lun); 2334 if (itperiph != NULL) 2335 break; 2336 } 2337 if (itperiph != NULL) { 2338 xm.xm_mode = itperiph->periph_cap; 2339 /* 2340 * Now issue the request to the adapter. 2341 */ 2342 s = splbio(); 2343 scsipi_adapter_request(chan, ADAPTER_REQ_SET_XFER_MODE, &xm); 2344 splx(s); 2345 /* 2346 * If we want this to happen immediately, issue a dummy 2347 * command, since most adapters can't really negotiate unless 2348 * they're executing a job. 2349 */ 2350 if (immed != 0) { 2351 (void) scsipi_test_unit_ready(itperiph, 2352 XS_CTL_DISCOVERY | XS_CTL_IGNORE_ILLEGAL_REQUEST | 2353 XS_CTL_IGNORE_NOT_READY | 2354 XS_CTL_IGNORE_MEDIA_CHANGE); 2355 } 2356 } 2357 } 2358 2359 /* 2360 * scsipi_channel_reset: 2361 * 2362 * handle scsi bus reset 2363 * called at splbio 2364 */ 2365 static void 2366 scsipi_async_event_channel_reset(struct scsipi_channel *chan) 2367 { 2368 struct scsipi_xfer *xs, *xs_next; 2369 struct scsipi_periph *periph; 2370 int target, lun; 2371 2372 /* 2373 * Channel has been reset. Also mark as reset pending REQUEST_SENSE 2374 * commands; as the sense is not available any more. 2375 * can't call scsipi_done() from here, as the command has not been 2376 * sent to the adapter yet (this would corrupt accounting). 2377 */ 2378 2379 for (xs = TAILQ_FIRST(&chan->chan_queue); xs != NULL; xs = xs_next) { 2380 xs_next = TAILQ_NEXT(xs, channel_q); 2381 if (xs->xs_control & XS_CTL_REQSENSE) { 2382 TAILQ_REMOVE(&chan->chan_queue, xs, channel_q); 2383 xs->error = XS_RESET; 2384 if ((xs->xs_control & XS_CTL_ASYNC) != 0) 2385 TAILQ_INSERT_TAIL(&chan->chan_complete, xs, 2386 channel_q); 2387 } 2388 } 2389 wakeup(&chan->chan_complete); 2390 /* Catch xs with pending sense which may not have a REQSENSE xs yet */ 2391 for (target = 0; target < chan->chan_ntargets; target++) { 2392 if (target == chan->chan_id) 2393 continue; 2394 for (lun = 0; lun < chan->chan_nluns; lun++) { 2395 periph = scsipi_lookup_periph(chan, target, lun); 2396 if (periph) { 2397 xs = periph->periph_xscheck; 2398 if (xs) 2399 xs->error = XS_RESET; 2400 } 2401 } 2402 } 2403 } 2404 2405 /* 2406 * scsipi_target_detach: 2407 * 2408 * detach all periph associated with a I_T 2409 * must be called from valid thread context 2410 */ 2411 int 2412 scsipi_target_detach(struct scsipi_channel *chan, int target, int lun, 2413 int flags) 2414 { 2415 struct scsipi_periph *periph; 2416 int ctarget, mintarget, maxtarget; 2417 int clun, minlun, maxlun; 2418 int error; 2419 2420 if (target == -1) { 2421 mintarget = 0; 2422 maxtarget = chan->chan_ntargets; 2423 } else { 2424 if (target == chan->chan_id) 2425 return EINVAL; 2426 if (target < 0 || target >= chan->chan_ntargets) 2427 return EINVAL; 2428 mintarget = target; 2429 maxtarget = target + 1; 2430 } 2431 2432 if (lun == -1) { 2433 minlun = 0; 2434 maxlun = chan->chan_nluns; 2435 } else { 2436 if (lun < 0 || lun >= chan->chan_nluns) 2437 return EINVAL; 2438 minlun = lun; 2439 maxlun = lun + 1; 2440 } 2441 2442 for (ctarget = mintarget; ctarget < maxtarget; ctarget++) { 2443 if (ctarget == chan->chan_id) 2444 continue; 2445 2446 for (clun = minlun; clun < maxlun; clun++) { 2447 periph = scsipi_lookup_periph(chan, ctarget, clun); 2448 if (periph == NULL) 2449 continue; 2450 error = config_detach(periph->periph_dev, flags); 2451 if (error) 2452 return (error); 2453 } 2454 } 2455 return(0); 2456 } 2457 2458 /* 2459 * scsipi_adapter_addref: 2460 * 2461 * Add a reference to the adapter pointed to by the provided 2462 * link, enabling the adapter if necessary. 2463 */ 2464 int 2465 scsipi_adapter_addref(struct scsipi_adapter *adapt) 2466 { 2467 int s, error = 0; 2468 2469 s = splbio(); 2470 if (adapt->adapt_refcnt++ == 0 && adapt->adapt_enable != NULL) { 2471 error = (*adapt->adapt_enable)(adapt->adapt_dev, 1); 2472 if (error) 2473 adapt->adapt_refcnt--; 2474 } 2475 splx(s); 2476 return (error); 2477 } 2478 2479 /* 2480 * scsipi_adapter_delref: 2481 * 2482 * Delete a reference to the adapter pointed to by the provided 2483 * link, disabling the adapter if possible. 2484 */ 2485 void 2486 scsipi_adapter_delref(struct scsipi_adapter *adapt) 2487 { 2488 int s; 2489 2490 s = splbio(); 2491 if (adapt->adapt_refcnt-- == 1 && adapt->adapt_enable != NULL) 2492 (void) (*adapt->adapt_enable)(adapt->adapt_dev, 0); 2493 splx(s); 2494 } 2495 2496 static struct scsipi_syncparam { 2497 int ss_factor; 2498 int ss_period; /* ns * 100 */ 2499 } scsipi_syncparams[] = { 2500 { 0x08, 625 }, /* FAST-160 (Ultra320) */ 2501 { 0x09, 1250 }, /* FAST-80 (Ultra160) */ 2502 { 0x0a, 2500 }, /* FAST-40 40MHz (Ultra2) */ 2503 { 0x0b, 3030 }, /* FAST-40 33MHz (Ultra2) */ 2504 { 0x0c, 5000 }, /* FAST-20 (Ultra) */ 2505 }; 2506 static const int scsipi_nsyncparams = 2507 sizeof(scsipi_syncparams) / sizeof(scsipi_syncparams[0]); 2508 2509 int 2510 scsipi_sync_period_to_factor(int period /* ns * 100 */) 2511 { 2512 int i; 2513 2514 for (i = 0; i < scsipi_nsyncparams; i++) { 2515 if (period <= scsipi_syncparams[i].ss_period) 2516 return (scsipi_syncparams[i].ss_factor); 2517 } 2518 2519 return ((period / 100) / 4); 2520 } 2521 2522 int 2523 scsipi_sync_factor_to_period(int factor) 2524 { 2525 int i; 2526 2527 for (i = 0; i < scsipi_nsyncparams; i++) { 2528 if (factor == scsipi_syncparams[i].ss_factor) 2529 return (scsipi_syncparams[i].ss_period); 2530 } 2531 2532 return ((factor * 4) * 100); 2533 } 2534 2535 int 2536 scsipi_sync_factor_to_freq(int factor) 2537 { 2538 int i; 2539 2540 for (i = 0; i < scsipi_nsyncparams; i++) { 2541 if (factor == scsipi_syncparams[i].ss_factor) 2542 return (100000000 / scsipi_syncparams[i].ss_period); 2543 } 2544 2545 return (10000000 / ((factor * 4) * 10)); 2546 } 2547 2548 #ifdef SCSIPI_DEBUG 2549 /* 2550 * Given a scsipi_xfer, dump the request, in all it's glory 2551 */ 2552 void 2553 show_scsipi_xs(struct scsipi_xfer *xs) 2554 { 2555 2556 printf("xs(%p): ", xs); 2557 printf("xs_control(0x%08x)", xs->xs_control); 2558 printf("xs_status(0x%08x)", xs->xs_status); 2559 printf("periph(%p)", xs->xs_periph); 2560 printf("retr(0x%x)", xs->xs_retries); 2561 printf("timo(0x%x)", xs->timeout); 2562 printf("cmd(%p)", xs->cmd); 2563 printf("len(0x%x)", xs->cmdlen); 2564 printf("data(%p)", xs->data); 2565 printf("len(0x%x)", xs->datalen); 2566 printf("res(0x%x)", xs->resid); 2567 printf("err(0x%x)", xs->error); 2568 printf("bp(%p)", xs->bp); 2569 show_scsipi_cmd(xs); 2570 } 2571 2572 void 2573 show_scsipi_cmd(struct scsipi_xfer *xs) 2574 { 2575 u_char *b = (u_char *) xs->cmd; 2576 int i = 0; 2577 2578 scsipi_printaddr(xs->xs_periph); 2579 printf(" command: "); 2580 2581 if ((xs->xs_control & XS_CTL_RESET) == 0) { 2582 while (i < xs->cmdlen) { 2583 if (i) 2584 printf(","); 2585 printf("0x%x", b[i++]); 2586 } 2587 printf("-[%d bytes]\n", xs->datalen); 2588 if (xs->datalen) 2589 show_mem(xs->data, min(64, xs->datalen)); 2590 } else 2591 printf("-RESET-\n"); 2592 } 2593 2594 void 2595 show_mem(u_char *address, int num) 2596 { 2597 int x; 2598 2599 printf("------------------------------"); 2600 for (x = 0; x < num; x++) { 2601 if ((x % 16) == 0) 2602 printf("\n%03d: ", x); 2603 printf("%02x ", *address++); 2604 } 2605 printf("\n------------------------------\n"); 2606 } 2607 #endif /* SCSIPI_DEBUG */ 2608