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