Loading...
1/*
2 * scsi_error.c Copyright (C) 1997 Eric Youngdale
3 *
4 * SCSI error/timeout handling
5 * Initial versions: Eric Youngdale. Based upon conversations with
6 * Leonard Zubkoff and David Miller at Linux Expo,
7 * ideas originating from all over the place.
8 *
9 * Restructured scsi_unjam_host and associated functions.
10 * September 04, 2002 Mike Anderson (andmike@us.ibm.com)
11 *
12 * Forward port of Russell King's (rmk@arm.linux.org.uk) changes and
13 * minor cleanups.
14 * September 30, 2002 Mike Anderson (andmike@us.ibm.com)
15 */
16
17#include <linux/module.h>
18#include <linux/sched.h>
19#include <linux/gfp.h>
20#include <linux/timer.h>
21#include <linux/string.h>
22#include <linux/kernel.h>
23#include <linux/freezer.h>
24#include <linux/kthread.h>
25#include <linux/interrupt.h>
26#include <linux/blkdev.h>
27#include <linux/delay.h>
28
29#include <scsi/scsi.h>
30#include <scsi/scsi_cmnd.h>
31#include <scsi/scsi_dbg.h>
32#include <scsi/scsi_device.h>
33#include <scsi/scsi_driver.h>
34#include <scsi/scsi_eh.h>
35#include <scsi/scsi_transport.h>
36#include <scsi/scsi_host.h>
37#include <scsi/scsi_ioctl.h>
38
39#include "scsi_priv.h"
40#include "scsi_logging.h"
41#include "scsi_transport_api.h"
42
43#include <trace/events/scsi.h>
44
45static void scsi_eh_done(struct scsi_cmnd *scmd);
46
47#define SENSE_TIMEOUT (10*HZ)
48
49/*
50 * These should *probably* be handled by the host itself.
51 * Since it is allowed to sleep, it probably should.
52 */
53#define BUS_RESET_SETTLE_TIME (10)
54#define HOST_RESET_SETTLE_TIME (10)
55
56static int scsi_eh_try_stu(struct scsi_cmnd *scmd);
57
58/* called with shost->host_lock held */
59void scsi_eh_wakeup(struct Scsi_Host *shost)
60{
61 if (shost->host_busy == shost->host_failed) {
62 trace_scsi_eh_wakeup(shost);
63 wake_up_process(shost->ehandler);
64 SCSI_LOG_ERROR_RECOVERY(5,
65 printk("Waking error handler thread\n"));
66 }
67}
68
69/**
70 * scsi_schedule_eh - schedule EH for SCSI host
71 * @shost: SCSI host to invoke error handling on.
72 *
73 * Schedule SCSI EH without scmd.
74 */
75void scsi_schedule_eh(struct Scsi_Host *shost)
76{
77 unsigned long flags;
78
79 spin_lock_irqsave(shost->host_lock, flags);
80
81 if (scsi_host_set_state(shost, SHOST_RECOVERY) == 0 ||
82 scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY) == 0) {
83 shost->host_eh_scheduled++;
84 scsi_eh_wakeup(shost);
85 }
86
87 spin_unlock_irqrestore(shost->host_lock, flags);
88}
89EXPORT_SYMBOL_GPL(scsi_schedule_eh);
90
91/**
92 * scsi_eh_scmd_add - add scsi cmd to error handling.
93 * @scmd: scmd to run eh on.
94 * @eh_flag: optional SCSI_EH flag.
95 *
96 * Return value:
97 * 0 on failure.
98 */
99int scsi_eh_scmd_add(struct scsi_cmnd *scmd, int eh_flag)
100{
101 struct Scsi_Host *shost = scmd->device->host;
102 unsigned long flags;
103 int ret = 0;
104
105 if (!shost->ehandler)
106 return 0;
107
108 spin_lock_irqsave(shost->host_lock, flags);
109 if (scsi_host_set_state(shost, SHOST_RECOVERY))
110 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY))
111 goto out_unlock;
112
113 ret = 1;
114 scmd->eh_eflags |= eh_flag;
115 list_add_tail(&scmd->eh_entry, &shost->eh_cmd_q);
116 shost->host_failed++;
117 scsi_eh_wakeup(shost);
118 out_unlock:
119 spin_unlock_irqrestore(shost->host_lock, flags);
120 return ret;
121}
122
123/**
124 * scsi_times_out - Timeout function for normal scsi commands.
125 * @req: request that is timing out.
126 *
127 * Notes:
128 * We do not need to lock this. There is the potential for a race
129 * only in that the normal completion handling might run, but if the
130 * normal completion function determines that the timer has already
131 * fired, then it mustn't do anything.
132 */
133enum blk_eh_timer_return scsi_times_out(struct request *req)
134{
135 struct scsi_cmnd *scmd = req->special;
136 enum blk_eh_timer_return rtn = BLK_EH_NOT_HANDLED;
137 struct Scsi_Host *host = scmd->device->host;
138
139 trace_scsi_dispatch_cmd_timeout(scmd);
140 scsi_log_completion(scmd, TIMEOUT_ERROR);
141
142 if (host->transportt->eh_timed_out)
143 rtn = host->transportt->eh_timed_out(scmd);
144 else if (host->hostt->eh_timed_out)
145 rtn = host->hostt->eh_timed_out(scmd);
146
147 scmd->result |= DID_TIME_OUT << 16;
148
149 if (unlikely(rtn == BLK_EH_NOT_HANDLED &&
150 !scsi_eh_scmd_add(scmd, SCSI_EH_CANCEL_CMD)))
151 rtn = BLK_EH_HANDLED;
152
153 return rtn;
154}
155
156/**
157 * scsi_block_when_processing_errors - Prevent cmds from being queued.
158 * @sdev: Device on which we are performing recovery.
159 *
160 * Description:
161 * We block until the host is out of error recovery, and then check to
162 * see whether the host or the device is offline.
163 *
164 * Return value:
165 * 0 when dev was taken offline by error recovery. 1 OK to proceed.
166 */
167int scsi_block_when_processing_errors(struct scsi_device *sdev)
168{
169 int online;
170
171 wait_event(sdev->host->host_wait, !scsi_host_in_recovery(sdev->host));
172
173 online = scsi_device_online(sdev);
174
175 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: rtn: %d\n", __func__,
176 online));
177
178 return online;
179}
180EXPORT_SYMBOL(scsi_block_when_processing_errors);
181
182#ifdef CONFIG_SCSI_LOGGING
183/**
184 * scsi_eh_prt_fail_stats - Log info on failures.
185 * @shost: scsi host being recovered.
186 * @work_q: Queue of scsi cmds to process.
187 */
188static inline void scsi_eh_prt_fail_stats(struct Scsi_Host *shost,
189 struct list_head *work_q)
190{
191 struct scsi_cmnd *scmd;
192 struct scsi_device *sdev;
193 int total_failures = 0;
194 int cmd_failed = 0;
195 int cmd_cancel = 0;
196 int devices_failed = 0;
197
198 shost_for_each_device(sdev, shost) {
199 list_for_each_entry(scmd, work_q, eh_entry) {
200 if (scmd->device == sdev) {
201 ++total_failures;
202 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD)
203 ++cmd_cancel;
204 else
205 ++cmd_failed;
206 }
207 }
208
209 if (cmd_cancel || cmd_failed) {
210 SCSI_LOG_ERROR_RECOVERY(3,
211 sdev_printk(KERN_INFO, sdev,
212 "%s: cmds failed: %d, cancel: %d\n",
213 __func__, cmd_failed,
214 cmd_cancel));
215 cmd_cancel = 0;
216 cmd_failed = 0;
217 ++devices_failed;
218 }
219 }
220
221 SCSI_LOG_ERROR_RECOVERY(2, printk("Total of %d commands on %d"
222 " devices require eh work\n",
223 total_failures, devices_failed));
224}
225#endif
226
227/**
228 * scsi_check_sense - Examine scsi cmd sense
229 * @scmd: Cmd to have sense checked.
230 *
231 * Return value:
232 * SUCCESS or FAILED or NEEDS_RETRY or TARGET_ERROR
233 *
234 * Notes:
235 * When a deferred error is detected the current command has
236 * not been executed and needs retrying.
237 */
238static int scsi_check_sense(struct scsi_cmnd *scmd)
239{
240 struct scsi_device *sdev = scmd->device;
241 struct scsi_sense_hdr sshdr;
242
243 if (! scsi_command_normalize_sense(scmd, &sshdr))
244 return FAILED; /* no valid sense data */
245
246 if (scmd->cmnd[0] == TEST_UNIT_READY && scmd->scsi_done != scsi_eh_done)
247 /*
248 * nasty: for mid-layer issued TURs, we need to return the
249 * actual sense data without any recovery attempt. For eh
250 * issued ones, we need to try to recover and interpret
251 */
252 return SUCCESS;
253
254 if (scsi_sense_is_deferred(&sshdr))
255 return NEEDS_RETRY;
256
257 if (sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh &&
258 sdev->scsi_dh_data->scsi_dh->check_sense) {
259 int rc;
260
261 rc = sdev->scsi_dh_data->scsi_dh->check_sense(sdev, &sshdr);
262 if (rc != SCSI_RETURN_NOT_HANDLED)
263 return rc;
264 /* handler does not care. Drop down to default handling */
265 }
266
267 /*
268 * Previous logic looked for FILEMARK, EOM or ILI which are
269 * mainly associated with tapes and returned SUCCESS.
270 */
271 if (sshdr.response_code == 0x70) {
272 /* fixed format */
273 if (scmd->sense_buffer[2] & 0xe0)
274 return SUCCESS;
275 } else {
276 /*
277 * descriptor format: look for "stream commands sense data
278 * descriptor" (see SSC-3). Assume single sense data
279 * descriptor. Ignore ILI from SBC-2 READ LONG and WRITE LONG.
280 */
281 if ((sshdr.additional_length > 3) &&
282 (scmd->sense_buffer[8] == 0x4) &&
283 (scmd->sense_buffer[11] & 0xe0))
284 return SUCCESS;
285 }
286
287 switch (sshdr.sense_key) {
288 case NO_SENSE:
289 return SUCCESS;
290 case RECOVERED_ERROR:
291 return /* soft_error */ SUCCESS;
292
293 case ABORTED_COMMAND:
294 if (sshdr.asc == 0x10) /* DIF */
295 return SUCCESS;
296
297 return NEEDS_RETRY;
298 case NOT_READY:
299 case UNIT_ATTENTION:
300 /*
301 * if we are expecting a cc/ua because of a bus reset that we
302 * performed, treat this just as a retry. otherwise this is
303 * information that we should pass up to the upper-level driver
304 * so that we can deal with it there.
305 */
306 if (scmd->device->expecting_cc_ua) {
307 /*
308 * Because some device does not queue unit
309 * attentions correctly, we carefully check
310 * additional sense code and qualifier so as
311 * not to squash media change unit attention.
312 */
313 if (sshdr.asc != 0x28 || sshdr.ascq != 0x00) {
314 scmd->device->expecting_cc_ua = 0;
315 return NEEDS_RETRY;
316 }
317 }
318 /*
319 * if the device is in the process of becoming ready, we
320 * should retry.
321 */
322 if ((sshdr.asc == 0x04) && (sshdr.ascq == 0x01))
323 return NEEDS_RETRY;
324 /*
325 * if the device is not started, we need to wake
326 * the error handler to start the motor
327 */
328 if (scmd->device->allow_restart &&
329 (sshdr.asc == 0x04) && (sshdr.ascq == 0x02))
330 return FAILED;
331
332 if (sshdr.asc == 0x3f && sshdr.ascq == 0x0e)
333 scmd_printk(KERN_WARNING, scmd,
334 "Warning! Received an indication that the "
335 "LUN assignments on this target have "
336 "changed. The Linux SCSI layer does not "
337 "automatically remap LUN assignments.\n");
338 else if (sshdr.asc == 0x3f)
339 scmd_printk(KERN_WARNING, scmd,
340 "Warning! Received an indication that the "
341 "operating parameters on this target have "
342 "changed. The Linux SCSI layer does not "
343 "automatically adjust these parameters.\n");
344
345 if (sshdr.asc == 0x38 && sshdr.ascq == 0x07)
346 scmd_printk(KERN_WARNING, scmd,
347 "Warning! Received an indication that the "
348 "LUN reached a thin provisioning soft "
349 "threshold.\n");
350
351 /*
352 * Pass the UA upwards for a determination in the completion
353 * functions.
354 */
355 return SUCCESS;
356
357 /* these are not supported */
358 case COPY_ABORTED:
359 case VOLUME_OVERFLOW:
360 case MISCOMPARE:
361 case BLANK_CHECK:
362 case DATA_PROTECT:
363 return TARGET_ERROR;
364
365 case MEDIUM_ERROR:
366 if (sshdr.asc == 0x11 || /* UNRECOVERED READ ERR */
367 sshdr.asc == 0x13 || /* AMNF DATA FIELD */
368 sshdr.asc == 0x14) { /* RECORD NOT FOUND */
369 return TARGET_ERROR;
370 }
371 return NEEDS_RETRY;
372
373 case HARDWARE_ERROR:
374 if (scmd->device->retry_hwerror)
375 return ADD_TO_MLQUEUE;
376 else
377 return TARGET_ERROR;
378
379 case ILLEGAL_REQUEST:
380 if (sshdr.asc == 0x20 || /* Invalid command operation code */
381 sshdr.asc == 0x21 || /* Logical block address out of range */
382 sshdr.asc == 0x24 || /* Invalid field in cdb */
383 sshdr.asc == 0x26) { /* Parameter value invalid */
384 return TARGET_ERROR;
385 }
386 return SUCCESS;
387
388 default:
389 return SUCCESS;
390 }
391}
392
393static void scsi_handle_queue_ramp_up(struct scsi_device *sdev)
394{
395 struct scsi_host_template *sht = sdev->host->hostt;
396 struct scsi_device *tmp_sdev;
397
398 if (!sht->change_queue_depth ||
399 sdev->queue_depth >= sdev->max_queue_depth)
400 return;
401
402 if (time_before(jiffies,
403 sdev->last_queue_ramp_up + sdev->queue_ramp_up_period))
404 return;
405
406 if (time_before(jiffies,
407 sdev->last_queue_full_time + sdev->queue_ramp_up_period))
408 return;
409
410 /*
411 * Walk all devices of a target and do
412 * ramp up on them.
413 */
414 shost_for_each_device(tmp_sdev, sdev->host) {
415 if (tmp_sdev->channel != sdev->channel ||
416 tmp_sdev->id != sdev->id ||
417 tmp_sdev->queue_depth == sdev->max_queue_depth)
418 continue;
419 /*
420 * call back into LLD to increase queue_depth by one
421 * with ramp up reason code.
422 */
423 sht->change_queue_depth(tmp_sdev, tmp_sdev->queue_depth + 1,
424 SCSI_QDEPTH_RAMP_UP);
425 sdev->last_queue_ramp_up = jiffies;
426 }
427}
428
429static void scsi_handle_queue_full(struct scsi_device *sdev)
430{
431 struct scsi_host_template *sht = sdev->host->hostt;
432 struct scsi_device *tmp_sdev;
433
434 if (!sht->change_queue_depth)
435 return;
436
437 shost_for_each_device(tmp_sdev, sdev->host) {
438 if (tmp_sdev->channel != sdev->channel ||
439 tmp_sdev->id != sdev->id)
440 continue;
441 /*
442 * We do not know the number of commands that were at
443 * the device when we got the queue full so we start
444 * from the highest possible value and work our way down.
445 */
446 sht->change_queue_depth(tmp_sdev, tmp_sdev->queue_depth - 1,
447 SCSI_QDEPTH_QFULL);
448 }
449}
450
451/**
452 * scsi_eh_completed_normally - Disposition a eh cmd on return from LLD.
453 * @scmd: SCSI cmd to examine.
454 *
455 * Notes:
456 * This is *only* called when we are examining the status of commands
457 * queued during error recovery. the main difference here is that we
458 * don't allow for the possibility of retries here, and we are a lot
459 * more restrictive about what we consider acceptable.
460 */
461static int scsi_eh_completed_normally(struct scsi_cmnd *scmd)
462{
463 /*
464 * first check the host byte, to see if there is anything in there
465 * that would indicate what we need to do.
466 */
467 if (host_byte(scmd->result) == DID_RESET) {
468 /*
469 * rats. we are already in the error handler, so we now
470 * get to try and figure out what to do next. if the sense
471 * is valid, we have a pretty good idea of what to do.
472 * if not, we mark it as FAILED.
473 */
474 return scsi_check_sense(scmd);
475 }
476 if (host_byte(scmd->result) != DID_OK)
477 return FAILED;
478
479 /*
480 * next, check the message byte.
481 */
482 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
483 return FAILED;
484
485 /*
486 * now, check the status byte to see if this indicates
487 * anything special.
488 */
489 switch (status_byte(scmd->result)) {
490 case GOOD:
491 scsi_handle_queue_ramp_up(scmd->device);
492 case COMMAND_TERMINATED:
493 return SUCCESS;
494 case CHECK_CONDITION:
495 return scsi_check_sense(scmd);
496 case CONDITION_GOOD:
497 case INTERMEDIATE_GOOD:
498 case INTERMEDIATE_C_GOOD:
499 /*
500 * who knows? FIXME(eric)
501 */
502 return SUCCESS;
503 case RESERVATION_CONFLICT:
504 if (scmd->cmnd[0] == TEST_UNIT_READY)
505 /* it is a success, we probed the device and
506 * found it */
507 return SUCCESS;
508 /* otherwise, we failed to send the command */
509 return FAILED;
510 case QUEUE_FULL:
511 scsi_handle_queue_full(scmd->device);
512 /* fall through */
513 case BUSY:
514 return NEEDS_RETRY;
515 default:
516 return FAILED;
517 }
518 return FAILED;
519}
520
521/**
522 * scsi_eh_done - Completion function for error handling.
523 * @scmd: Cmd that is done.
524 */
525static void scsi_eh_done(struct scsi_cmnd *scmd)
526{
527 struct completion *eh_action;
528
529 SCSI_LOG_ERROR_RECOVERY(3,
530 printk("%s scmd: %p result: %x\n",
531 __func__, scmd, scmd->result));
532
533 eh_action = scmd->device->host->eh_action;
534 if (eh_action)
535 complete(eh_action);
536}
537
538/**
539 * scsi_try_host_reset - ask host adapter to reset itself
540 * @scmd: SCSI cmd to send hsot reset.
541 */
542static int scsi_try_host_reset(struct scsi_cmnd *scmd)
543{
544 unsigned long flags;
545 int rtn;
546 struct Scsi_Host *host = scmd->device->host;
547 struct scsi_host_template *hostt = host->hostt;
548
549 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Snd Host RST\n",
550 __func__));
551
552 if (!hostt->eh_host_reset_handler)
553 return FAILED;
554
555 rtn = hostt->eh_host_reset_handler(scmd);
556
557 if (rtn == SUCCESS) {
558 if (!hostt->skip_settle_delay)
559 ssleep(HOST_RESET_SETTLE_TIME);
560 spin_lock_irqsave(host->host_lock, flags);
561 scsi_report_bus_reset(host, scmd_channel(scmd));
562 spin_unlock_irqrestore(host->host_lock, flags);
563 }
564
565 return rtn;
566}
567
568/**
569 * scsi_try_bus_reset - ask host to perform a bus reset
570 * @scmd: SCSI cmd to send bus reset.
571 */
572static int scsi_try_bus_reset(struct scsi_cmnd *scmd)
573{
574 unsigned long flags;
575 int rtn;
576 struct Scsi_Host *host = scmd->device->host;
577 struct scsi_host_template *hostt = host->hostt;
578
579 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Snd Bus RST\n",
580 __func__));
581
582 if (!hostt->eh_bus_reset_handler)
583 return FAILED;
584
585 rtn = hostt->eh_bus_reset_handler(scmd);
586
587 if (rtn == SUCCESS) {
588 if (!hostt->skip_settle_delay)
589 ssleep(BUS_RESET_SETTLE_TIME);
590 spin_lock_irqsave(host->host_lock, flags);
591 scsi_report_bus_reset(host, scmd_channel(scmd));
592 spin_unlock_irqrestore(host->host_lock, flags);
593 }
594
595 return rtn;
596}
597
598static void __scsi_report_device_reset(struct scsi_device *sdev, void *data)
599{
600 sdev->was_reset = 1;
601 sdev->expecting_cc_ua = 1;
602}
603
604/**
605 * scsi_try_target_reset - Ask host to perform a target reset
606 * @scmd: SCSI cmd used to send a target reset
607 *
608 * Notes:
609 * There is no timeout for this operation. if this operation is
610 * unreliable for a given host, then the host itself needs to put a
611 * timer on it, and set the host back to a consistent state prior to
612 * returning.
613 */
614static int scsi_try_target_reset(struct scsi_cmnd *scmd)
615{
616 unsigned long flags;
617 int rtn;
618 struct Scsi_Host *host = scmd->device->host;
619 struct scsi_host_template *hostt = host->hostt;
620
621 if (!hostt->eh_target_reset_handler)
622 return FAILED;
623
624 rtn = hostt->eh_target_reset_handler(scmd);
625 if (rtn == SUCCESS) {
626 spin_lock_irqsave(host->host_lock, flags);
627 __starget_for_each_device(scsi_target(scmd->device), NULL,
628 __scsi_report_device_reset);
629 spin_unlock_irqrestore(host->host_lock, flags);
630 }
631
632 return rtn;
633}
634
635/**
636 * scsi_try_bus_device_reset - Ask host to perform a BDR on a dev
637 * @scmd: SCSI cmd used to send BDR
638 *
639 * Notes:
640 * There is no timeout for this operation. if this operation is
641 * unreliable for a given host, then the host itself needs to put a
642 * timer on it, and set the host back to a consistent state prior to
643 * returning.
644 */
645static int scsi_try_bus_device_reset(struct scsi_cmnd *scmd)
646{
647 int rtn;
648 struct scsi_host_template *hostt = scmd->device->host->hostt;
649
650 if (!hostt->eh_device_reset_handler)
651 return FAILED;
652
653 rtn = hostt->eh_device_reset_handler(scmd);
654 if (rtn == SUCCESS)
655 __scsi_report_device_reset(scmd->device, NULL);
656 return rtn;
657}
658
659static int scsi_try_to_abort_cmd(struct scsi_host_template *hostt, struct scsi_cmnd *scmd)
660{
661 if (!hostt->eh_abort_handler)
662 return FAILED;
663
664 return hostt->eh_abort_handler(scmd);
665}
666
667static void scsi_abort_eh_cmnd(struct scsi_cmnd *scmd)
668{
669 if (scsi_try_to_abort_cmd(scmd->device->host->hostt, scmd) != SUCCESS)
670 if (scsi_try_bus_device_reset(scmd) != SUCCESS)
671 if (scsi_try_target_reset(scmd) != SUCCESS)
672 if (scsi_try_bus_reset(scmd) != SUCCESS)
673 scsi_try_host_reset(scmd);
674}
675
676/**
677 * scsi_eh_prep_cmnd - Save a scsi command info as part of error recovery
678 * @scmd: SCSI command structure to hijack
679 * @ses: structure to save restore information
680 * @cmnd: CDB to send. Can be NULL if no new cmnd is needed
681 * @cmnd_size: size in bytes of @cmnd (must be <= BLK_MAX_CDB)
682 * @sense_bytes: size of sense data to copy. or 0 (if != 0 @cmnd is ignored)
683 *
684 * This function is used to save a scsi command information before re-execution
685 * as part of the error recovery process. If @sense_bytes is 0 the command
686 * sent must be one that does not transfer any data. If @sense_bytes != 0
687 * @cmnd is ignored and this functions sets up a REQUEST_SENSE command
688 * and cmnd buffers to read @sense_bytes into @scmd->sense_buffer.
689 */
690void scsi_eh_prep_cmnd(struct scsi_cmnd *scmd, struct scsi_eh_save *ses,
691 unsigned char *cmnd, int cmnd_size, unsigned sense_bytes)
692{
693 struct scsi_device *sdev = scmd->device;
694
695 /*
696 * We need saved copies of a number of fields - this is because
697 * error handling may need to overwrite these with different values
698 * to run different commands, and once error handling is complete,
699 * we will need to restore these values prior to running the actual
700 * command.
701 */
702 ses->cmd_len = scmd->cmd_len;
703 ses->cmnd = scmd->cmnd;
704 ses->data_direction = scmd->sc_data_direction;
705 ses->sdb = scmd->sdb;
706 ses->next_rq = scmd->request->next_rq;
707 ses->result = scmd->result;
708 ses->underflow = scmd->underflow;
709 ses->prot_op = scmd->prot_op;
710
711 scmd->prot_op = SCSI_PROT_NORMAL;
712 scmd->cmnd = ses->eh_cmnd;
713 memset(scmd->cmnd, 0, BLK_MAX_CDB);
714 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
715 scmd->request->next_rq = NULL;
716
717 if (sense_bytes) {
718 scmd->sdb.length = min_t(unsigned, SCSI_SENSE_BUFFERSIZE,
719 sense_bytes);
720 sg_init_one(&ses->sense_sgl, scmd->sense_buffer,
721 scmd->sdb.length);
722 scmd->sdb.table.sgl = &ses->sense_sgl;
723 scmd->sc_data_direction = DMA_FROM_DEVICE;
724 scmd->sdb.table.nents = 1;
725 scmd->cmnd[0] = REQUEST_SENSE;
726 scmd->cmnd[4] = scmd->sdb.length;
727 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
728 } else {
729 scmd->sc_data_direction = DMA_NONE;
730 if (cmnd) {
731 BUG_ON(cmnd_size > BLK_MAX_CDB);
732 memcpy(scmd->cmnd, cmnd, cmnd_size);
733 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
734 }
735 }
736
737 scmd->underflow = 0;
738
739 if (sdev->scsi_level <= SCSI_2 && sdev->scsi_level != SCSI_UNKNOWN)
740 scmd->cmnd[1] = (scmd->cmnd[1] & 0x1f) |
741 (sdev->lun << 5 & 0xe0);
742
743 /*
744 * Zero the sense buffer. The scsi spec mandates that any
745 * untransferred sense data should be interpreted as being zero.
746 */
747 memset(scmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
748}
749EXPORT_SYMBOL(scsi_eh_prep_cmnd);
750
751/**
752 * scsi_eh_restore_cmnd - Restore a scsi command info as part of error recovery
753 * @scmd: SCSI command structure to restore
754 * @ses: saved information from a coresponding call to scsi_eh_prep_cmnd
755 *
756 * Undo any damage done by above scsi_eh_prep_cmnd().
757 */
758void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd, struct scsi_eh_save *ses)
759{
760 /*
761 * Restore original data
762 */
763 scmd->cmd_len = ses->cmd_len;
764 scmd->cmnd = ses->cmnd;
765 scmd->sc_data_direction = ses->data_direction;
766 scmd->sdb = ses->sdb;
767 scmd->request->next_rq = ses->next_rq;
768 scmd->result = ses->result;
769 scmd->underflow = ses->underflow;
770 scmd->prot_op = ses->prot_op;
771}
772EXPORT_SYMBOL(scsi_eh_restore_cmnd);
773
774/**
775 * scsi_send_eh_cmnd - submit a scsi command as part of error recovery
776 * @scmd: SCSI command structure to hijack
777 * @cmnd: CDB to send
778 * @cmnd_size: size in bytes of @cmnd
779 * @timeout: timeout for this request
780 * @sense_bytes: size of sense data to copy or 0
781 *
782 * This function is used to send a scsi command down to a target device
783 * as part of the error recovery process. See also scsi_eh_prep_cmnd() above.
784 *
785 * Return value:
786 * SUCCESS or FAILED or NEEDS_RETRY
787 */
788static int scsi_send_eh_cmnd(struct scsi_cmnd *scmd, unsigned char *cmnd,
789 int cmnd_size, int timeout, unsigned sense_bytes)
790{
791 struct scsi_device *sdev = scmd->device;
792 struct scsi_driver *sdrv = scsi_cmd_to_driver(scmd);
793 struct Scsi_Host *shost = sdev->host;
794 DECLARE_COMPLETION_ONSTACK(done);
795 unsigned long timeleft;
796 struct scsi_eh_save ses;
797 int rtn;
798
799 scsi_eh_prep_cmnd(scmd, &ses, cmnd, cmnd_size, sense_bytes);
800 shost->eh_action = &done;
801
802 scsi_log_send(scmd);
803 scmd->scsi_done = scsi_eh_done;
804 shost->hostt->queuecommand(shost, scmd);
805
806 timeleft = wait_for_completion_timeout(&done, timeout);
807
808 shost->eh_action = NULL;
809
810 scsi_log_completion(scmd, SUCCESS);
811
812 SCSI_LOG_ERROR_RECOVERY(3,
813 printk("%s: scmd: %p, timeleft: %ld\n",
814 __func__, scmd, timeleft));
815
816 /*
817 * If there is time left scsi_eh_done got called, and we will
818 * examine the actual status codes to see whether the command
819 * actually did complete normally, else tell the host to forget
820 * about this command.
821 */
822 if (timeleft) {
823 rtn = scsi_eh_completed_normally(scmd);
824 SCSI_LOG_ERROR_RECOVERY(3,
825 printk("%s: scsi_eh_completed_normally %x\n",
826 __func__, rtn));
827
828 switch (rtn) {
829 case SUCCESS:
830 case NEEDS_RETRY:
831 case FAILED:
832 case TARGET_ERROR:
833 break;
834 case ADD_TO_MLQUEUE:
835 rtn = NEEDS_RETRY;
836 break;
837 default:
838 rtn = FAILED;
839 break;
840 }
841 } else {
842 scsi_abort_eh_cmnd(scmd);
843 rtn = FAILED;
844 }
845
846 scsi_eh_restore_cmnd(scmd, &ses);
847
848 if (sdrv && sdrv->eh_action)
849 rtn = sdrv->eh_action(scmd, cmnd, cmnd_size, rtn);
850
851 return rtn;
852}
853
854/**
855 * scsi_request_sense - Request sense data from a particular target.
856 * @scmd: SCSI cmd for request sense.
857 *
858 * Notes:
859 * Some hosts automatically obtain this information, others require
860 * that we obtain it on our own. This function will *not* return until
861 * the command either times out, or it completes.
862 */
863static int scsi_request_sense(struct scsi_cmnd *scmd)
864{
865 return scsi_send_eh_cmnd(scmd, NULL, 0, SENSE_TIMEOUT, ~0);
866}
867
868/**
869 * scsi_eh_finish_cmd - Handle a cmd that eh is finished with.
870 * @scmd: Original SCSI cmd that eh has finished.
871 * @done_q: Queue for processed commands.
872 *
873 * Notes:
874 * We don't want to use the normal command completion while we are are
875 * still handling errors - it may cause other commands to be queued,
876 * and that would disturb what we are doing. Thus we really want to
877 * keep a list of pending commands for final completion, and once we
878 * are ready to leave error handling we handle completion for real.
879 */
880void scsi_eh_finish_cmd(struct scsi_cmnd *scmd, struct list_head *done_q)
881{
882 scmd->device->host->host_failed--;
883 scmd->eh_eflags = 0;
884 list_move_tail(&scmd->eh_entry, done_q);
885}
886EXPORT_SYMBOL(scsi_eh_finish_cmd);
887
888/**
889 * scsi_eh_get_sense - Get device sense data.
890 * @work_q: Queue of commands to process.
891 * @done_q: Queue of processed commands.
892 *
893 * Description:
894 * See if we need to request sense information. if so, then get it
895 * now, so we have a better idea of what to do.
896 *
897 * Notes:
898 * This has the unfortunate side effect that if a shost adapter does
899 * not automatically request sense information, we end up shutting
900 * it down before we request it.
901 *
902 * All drivers should request sense information internally these days,
903 * so for now all I have to say is tough noogies if you end up in here.
904 *
905 * XXX: Long term this code should go away, but that needs an audit of
906 * all LLDDs first.
907 */
908int scsi_eh_get_sense(struct list_head *work_q,
909 struct list_head *done_q)
910{
911 struct scsi_cmnd *scmd, *next;
912 int rtn;
913
914 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
915 if ((scmd->eh_eflags & SCSI_EH_CANCEL_CMD) ||
916 SCSI_SENSE_VALID(scmd))
917 continue;
918
919 SCSI_LOG_ERROR_RECOVERY(2, scmd_printk(KERN_INFO, scmd,
920 "%s: requesting sense\n",
921 current->comm));
922 rtn = scsi_request_sense(scmd);
923 if (rtn != SUCCESS)
924 continue;
925
926 SCSI_LOG_ERROR_RECOVERY(3, printk("sense requested for %p"
927 " result %x\n", scmd,
928 scmd->result));
929 SCSI_LOG_ERROR_RECOVERY(3, scsi_print_sense("bh", scmd));
930
931 rtn = scsi_decide_disposition(scmd);
932
933 /*
934 * if the result was normal, then just pass it along to the
935 * upper level.
936 */
937 if (rtn == SUCCESS)
938 /* we don't want this command reissued, just
939 * finished with the sense data, so set
940 * retries to the max allowed to ensure it
941 * won't get reissued */
942 scmd->retries = scmd->allowed;
943 else if (rtn != NEEDS_RETRY)
944 continue;
945
946 scsi_eh_finish_cmd(scmd, done_q);
947 }
948
949 return list_empty(work_q);
950}
951EXPORT_SYMBOL_GPL(scsi_eh_get_sense);
952
953/**
954 * scsi_eh_tur - Send TUR to device.
955 * @scmd: &scsi_cmnd to send TUR
956 *
957 * Return value:
958 * 0 - Device is ready. 1 - Device NOT ready.
959 */
960static int scsi_eh_tur(struct scsi_cmnd *scmd)
961{
962 static unsigned char tur_command[6] = {TEST_UNIT_READY, 0, 0, 0, 0, 0};
963 int retry_cnt = 1, rtn;
964
965retry_tur:
966 rtn = scsi_send_eh_cmnd(scmd, tur_command, 6, SENSE_TIMEOUT, 0);
967
968 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: scmd %p rtn %x\n",
969 __func__, scmd, rtn));
970
971 switch (rtn) {
972 case NEEDS_RETRY:
973 if (retry_cnt--)
974 goto retry_tur;
975 /*FALLTHRU*/
976 case SUCCESS:
977 return 0;
978 default:
979 return 1;
980 }
981}
982
983/**
984 * scsi_eh_test_devices - check if devices are responding from error recovery.
985 * @cmd_list: scsi commands in error recovery.
986 * @work_q: queue for commands which still need more error recovery
987 * @done_q: queue for commands which are finished
988 * @try_stu: boolean on if a STU command should be tried in addition to TUR.
989 *
990 * Decription:
991 * Tests if devices are in a working state. Commands to devices now in
992 * a working state are sent to the done_q while commands to devices which
993 * are still failing to respond are returned to the work_q for more
994 * processing.
995 **/
996static int scsi_eh_test_devices(struct list_head *cmd_list,
997 struct list_head *work_q,
998 struct list_head *done_q, int try_stu)
999{
1000 struct scsi_cmnd *scmd, *next;
1001 struct scsi_device *sdev;
1002 int finish_cmds;
1003
1004 while (!list_empty(cmd_list)) {
1005 scmd = list_entry(cmd_list->next, struct scsi_cmnd, eh_entry);
1006 sdev = scmd->device;
1007
1008 finish_cmds = !scsi_device_online(scmd->device) ||
1009 (try_stu && !scsi_eh_try_stu(scmd) &&
1010 !scsi_eh_tur(scmd)) ||
1011 !scsi_eh_tur(scmd);
1012
1013 list_for_each_entry_safe(scmd, next, cmd_list, eh_entry)
1014 if (scmd->device == sdev) {
1015 if (finish_cmds)
1016 scsi_eh_finish_cmd(scmd, done_q);
1017 else
1018 list_move_tail(&scmd->eh_entry, work_q);
1019 }
1020 }
1021 return list_empty(work_q);
1022}
1023
1024
1025/**
1026 * scsi_eh_abort_cmds - abort pending commands.
1027 * @work_q: &list_head for pending commands.
1028 * @done_q: &list_head for processed commands.
1029 *
1030 * Decription:
1031 * Try and see whether or not it makes sense to try and abort the
1032 * running command. This only works out to be the case if we have one
1033 * command that has timed out. If the command simply failed, it makes
1034 * no sense to try and abort the command, since as far as the shost
1035 * adapter is concerned, it isn't running.
1036 */
1037static int scsi_eh_abort_cmds(struct list_head *work_q,
1038 struct list_head *done_q)
1039{
1040 struct scsi_cmnd *scmd, *next;
1041 LIST_HEAD(check_list);
1042 int rtn;
1043
1044 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1045 if (!(scmd->eh_eflags & SCSI_EH_CANCEL_CMD))
1046 continue;
1047 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: aborting cmd:"
1048 "0x%p\n", current->comm,
1049 scmd));
1050 rtn = scsi_try_to_abort_cmd(scmd->device->host->hostt, scmd);
1051 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
1052 scmd->eh_eflags &= ~SCSI_EH_CANCEL_CMD;
1053 if (rtn == FAST_IO_FAIL)
1054 scsi_eh_finish_cmd(scmd, done_q);
1055 else
1056 list_move_tail(&scmd->eh_entry, &check_list);
1057 } else
1058 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: aborting"
1059 " cmd failed:"
1060 "0x%p\n",
1061 current->comm,
1062 scmd));
1063 }
1064
1065 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1066}
1067
1068/**
1069 * scsi_eh_try_stu - Send START_UNIT to device.
1070 * @scmd: &scsi_cmnd to send START_UNIT
1071 *
1072 * Return value:
1073 * 0 - Device is ready. 1 - Device NOT ready.
1074 */
1075static int scsi_eh_try_stu(struct scsi_cmnd *scmd)
1076{
1077 static unsigned char stu_command[6] = {START_STOP, 0, 0, 0, 1, 0};
1078
1079 if (scmd->device->allow_restart) {
1080 int i, rtn = NEEDS_RETRY;
1081
1082 for (i = 0; rtn == NEEDS_RETRY && i < 2; i++)
1083 rtn = scsi_send_eh_cmnd(scmd, stu_command, 6, scmd->device->request_queue->rq_timeout, 0);
1084
1085 if (rtn == SUCCESS)
1086 return 0;
1087 }
1088
1089 return 1;
1090}
1091
1092 /**
1093 * scsi_eh_stu - send START_UNIT if needed
1094 * @shost: &scsi host being recovered.
1095 * @work_q: &list_head for pending commands.
1096 * @done_q: &list_head for processed commands.
1097 *
1098 * Notes:
1099 * If commands are failing due to not ready, initializing command required,
1100 * try revalidating the device, which will end up sending a start unit.
1101 */
1102static int scsi_eh_stu(struct Scsi_Host *shost,
1103 struct list_head *work_q,
1104 struct list_head *done_q)
1105{
1106 struct scsi_cmnd *scmd, *stu_scmd, *next;
1107 struct scsi_device *sdev;
1108
1109 shost_for_each_device(sdev, shost) {
1110 stu_scmd = NULL;
1111 list_for_each_entry(scmd, work_q, eh_entry)
1112 if (scmd->device == sdev && SCSI_SENSE_VALID(scmd) &&
1113 scsi_check_sense(scmd) == FAILED ) {
1114 stu_scmd = scmd;
1115 break;
1116 }
1117
1118 if (!stu_scmd)
1119 continue;
1120
1121 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending START_UNIT to sdev:"
1122 " 0x%p\n", current->comm, sdev));
1123
1124 if (!scsi_eh_try_stu(stu_scmd)) {
1125 if (!scsi_device_online(sdev) ||
1126 !scsi_eh_tur(stu_scmd)) {
1127 list_for_each_entry_safe(scmd, next,
1128 work_q, eh_entry) {
1129 if (scmd->device == sdev)
1130 scsi_eh_finish_cmd(scmd, done_q);
1131 }
1132 }
1133 } else {
1134 SCSI_LOG_ERROR_RECOVERY(3,
1135 printk("%s: START_UNIT failed to sdev:"
1136 " 0x%p\n", current->comm, sdev));
1137 }
1138 }
1139
1140 return list_empty(work_q);
1141}
1142
1143
1144/**
1145 * scsi_eh_bus_device_reset - send bdr if needed
1146 * @shost: scsi host being recovered.
1147 * @work_q: &list_head for pending commands.
1148 * @done_q: &list_head for processed commands.
1149 *
1150 * Notes:
1151 * Try a bus device reset. Still, look to see whether we have multiple
1152 * devices that are jammed or not - if we have multiple devices, it
1153 * makes no sense to try bus_device_reset - we really would need to try
1154 * a bus_reset instead.
1155 */
1156static int scsi_eh_bus_device_reset(struct Scsi_Host *shost,
1157 struct list_head *work_q,
1158 struct list_head *done_q)
1159{
1160 struct scsi_cmnd *scmd, *bdr_scmd, *next;
1161 struct scsi_device *sdev;
1162 int rtn;
1163
1164 shost_for_each_device(sdev, shost) {
1165 bdr_scmd = NULL;
1166 list_for_each_entry(scmd, work_q, eh_entry)
1167 if (scmd->device == sdev) {
1168 bdr_scmd = scmd;
1169 break;
1170 }
1171
1172 if (!bdr_scmd)
1173 continue;
1174
1175 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending BDR sdev:"
1176 " 0x%p\n", current->comm,
1177 sdev));
1178 rtn = scsi_try_bus_device_reset(bdr_scmd);
1179 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
1180 if (!scsi_device_online(sdev) ||
1181 rtn == FAST_IO_FAIL ||
1182 !scsi_eh_tur(bdr_scmd)) {
1183 list_for_each_entry_safe(scmd, next,
1184 work_q, eh_entry) {
1185 if (scmd->device == sdev)
1186 scsi_eh_finish_cmd(scmd,
1187 done_q);
1188 }
1189 }
1190 } else {
1191 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: BDR"
1192 " failed sdev:"
1193 "0x%p\n",
1194 current->comm,
1195 sdev));
1196 }
1197 }
1198
1199 return list_empty(work_q);
1200}
1201
1202/**
1203 * scsi_eh_target_reset - send target reset if needed
1204 * @shost: scsi host being recovered.
1205 * @work_q: &list_head for pending commands.
1206 * @done_q: &list_head for processed commands.
1207 *
1208 * Notes:
1209 * Try a target reset.
1210 */
1211static int scsi_eh_target_reset(struct Scsi_Host *shost,
1212 struct list_head *work_q,
1213 struct list_head *done_q)
1214{
1215 LIST_HEAD(tmp_list);
1216 LIST_HEAD(check_list);
1217
1218 list_splice_init(work_q, &tmp_list);
1219
1220 while (!list_empty(&tmp_list)) {
1221 struct scsi_cmnd *next, *scmd;
1222 int rtn;
1223 unsigned int id;
1224
1225 scmd = list_entry(tmp_list.next, struct scsi_cmnd, eh_entry);
1226 id = scmd_id(scmd);
1227
1228 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending target reset "
1229 "to target %d\n",
1230 current->comm, id));
1231 rtn = scsi_try_target_reset(scmd);
1232 if (rtn != SUCCESS && rtn != FAST_IO_FAIL)
1233 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Target reset"
1234 " failed target: "
1235 "%d\n",
1236 current->comm, id));
1237 list_for_each_entry_safe(scmd, next, &tmp_list, eh_entry) {
1238 if (scmd_id(scmd) != id)
1239 continue;
1240
1241 if (rtn == SUCCESS)
1242 list_move_tail(&scmd->eh_entry, &check_list);
1243 else if (rtn == FAST_IO_FAIL)
1244 scsi_eh_finish_cmd(scmd, done_q);
1245 else
1246 /* push back on work queue for further processing */
1247 list_move(&scmd->eh_entry, work_q);
1248 }
1249 }
1250
1251 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1252}
1253
1254/**
1255 * scsi_eh_bus_reset - send a bus reset
1256 * @shost: &scsi host being recovered.
1257 * @work_q: &list_head for pending commands.
1258 * @done_q: &list_head for processed commands.
1259 */
1260static int scsi_eh_bus_reset(struct Scsi_Host *shost,
1261 struct list_head *work_q,
1262 struct list_head *done_q)
1263{
1264 struct scsi_cmnd *scmd, *chan_scmd, *next;
1265 LIST_HEAD(check_list);
1266 unsigned int channel;
1267 int rtn;
1268
1269 /*
1270 * we really want to loop over the various channels, and do this on
1271 * a channel by channel basis. we should also check to see if any
1272 * of the failed commands are on soft_reset devices, and if so, skip
1273 * the reset.
1274 */
1275
1276 for (channel = 0; channel <= shost->max_channel; channel++) {
1277 chan_scmd = NULL;
1278 list_for_each_entry(scmd, work_q, eh_entry) {
1279 if (channel == scmd_channel(scmd)) {
1280 chan_scmd = scmd;
1281 break;
1282 /*
1283 * FIXME add back in some support for
1284 * soft_reset devices.
1285 */
1286 }
1287 }
1288
1289 if (!chan_scmd)
1290 continue;
1291 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending BRST chan:"
1292 " %d\n", current->comm,
1293 channel));
1294 rtn = scsi_try_bus_reset(chan_scmd);
1295 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
1296 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1297 if (channel == scmd_channel(scmd)) {
1298 if (rtn == FAST_IO_FAIL)
1299 scsi_eh_finish_cmd(scmd,
1300 done_q);
1301 else
1302 list_move_tail(&scmd->eh_entry,
1303 &check_list);
1304 }
1305 }
1306 } else {
1307 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: BRST"
1308 " failed chan: %d\n",
1309 current->comm,
1310 channel));
1311 }
1312 }
1313 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1314}
1315
1316/**
1317 * scsi_eh_host_reset - send a host reset
1318 * @work_q: list_head for processed commands.
1319 * @done_q: list_head for processed commands.
1320 */
1321static int scsi_eh_host_reset(struct list_head *work_q,
1322 struct list_head *done_q)
1323{
1324 struct scsi_cmnd *scmd, *next;
1325 LIST_HEAD(check_list);
1326 int rtn;
1327
1328 if (!list_empty(work_q)) {
1329 scmd = list_entry(work_q->next,
1330 struct scsi_cmnd, eh_entry);
1331
1332 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending HRST\n"
1333 , current->comm));
1334
1335 rtn = scsi_try_host_reset(scmd);
1336 if (rtn == SUCCESS) {
1337 list_splice_init(work_q, &check_list);
1338 } else if (rtn == FAST_IO_FAIL) {
1339 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1340 scsi_eh_finish_cmd(scmd, done_q);
1341 }
1342 } else {
1343 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: HRST"
1344 " failed\n",
1345 current->comm));
1346 }
1347 }
1348 return scsi_eh_test_devices(&check_list, work_q, done_q, 1);
1349}
1350
1351/**
1352 * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
1353 * @work_q: list_head for processed commands.
1354 * @done_q: list_head for processed commands.
1355 */
1356static void scsi_eh_offline_sdevs(struct list_head *work_q,
1357 struct list_head *done_q)
1358{
1359 struct scsi_cmnd *scmd, *next;
1360
1361 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1362 sdev_printk(KERN_INFO, scmd->device, "Device offlined - "
1363 "not ready after error recovery\n");
1364 scsi_device_set_state(scmd->device, SDEV_OFFLINE);
1365 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD) {
1366 /*
1367 * FIXME: Handle lost cmds.
1368 */
1369 }
1370 scsi_eh_finish_cmd(scmd, done_q);
1371 }
1372 return;
1373}
1374
1375/**
1376 * scsi_noretry_cmd - determinte if command should be failed fast
1377 * @scmd: SCSI cmd to examine.
1378 */
1379int scsi_noretry_cmd(struct scsi_cmnd *scmd)
1380{
1381 switch (host_byte(scmd->result)) {
1382 case DID_OK:
1383 break;
1384 case DID_BUS_BUSY:
1385 return (scmd->request->cmd_flags & REQ_FAILFAST_TRANSPORT);
1386 case DID_PARITY:
1387 return (scmd->request->cmd_flags & REQ_FAILFAST_DEV);
1388 case DID_ERROR:
1389 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1390 status_byte(scmd->result) == RESERVATION_CONFLICT)
1391 return 0;
1392 /* fall through */
1393 case DID_SOFT_ERROR:
1394 return (scmd->request->cmd_flags & REQ_FAILFAST_DRIVER);
1395 }
1396
1397 switch (status_byte(scmd->result)) {
1398 case CHECK_CONDITION:
1399 /*
1400 * assume caller has checked sense and determinted
1401 * the check condition was retryable.
1402 */
1403 if (scmd->request->cmd_flags & REQ_FAILFAST_DEV ||
1404 scmd->request->cmd_type == REQ_TYPE_BLOCK_PC)
1405 return 1;
1406 }
1407
1408 return 0;
1409}
1410
1411/**
1412 * scsi_decide_disposition - Disposition a cmd on return from LLD.
1413 * @scmd: SCSI cmd to examine.
1414 *
1415 * Notes:
1416 * This is *only* called when we are examining the status after sending
1417 * out the actual data command. any commands that are queued for error
1418 * recovery (e.g. test_unit_ready) do *not* come through here.
1419 *
1420 * When this routine returns failed, it means the error handler thread
1421 * is woken. In cases where the error code indicates an error that
1422 * doesn't require the error handler read (i.e. we don't need to
1423 * abort/reset), this function should return SUCCESS.
1424 */
1425int scsi_decide_disposition(struct scsi_cmnd *scmd)
1426{
1427 int rtn;
1428
1429 /*
1430 * if the device is offline, then we clearly just pass the result back
1431 * up to the top level.
1432 */
1433 if (!scsi_device_online(scmd->device)) {
1434 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: device offline - report"
1435 " as SUCCESS\n",
1436 __func__));
1437 return SUCCESS;
1438 }
1439
1440 /*
1441 * first check the host byte, to see if there is anything in there
1442 * that would indicate what we need to do.
1443 */
1444 switch (host_byte(scmd->result)) {
1445 case DID_PASSTHROUGH:
1446 /*
1447 * no matter what, pass this through to the upper layer.
1448 * nuke this special code so that it looks like we are saying
1449 * did_ok.
1450 */
1451 scmd->result &= 0xff00ffff;
1452 return SUCCESS;
1453 case DID_OK:
1454 /*
1455 * looks good. drop through, and check the next byte.
1456 */
1457 break;
1458 case DID_NO_CONNECT:
1459 case DID_BAD_TARGET:
1460 case DID_ABORT:
1461 /*
1462 * note - this means that we just report the status back
1463 * to the top level driver, not that we actually think
1464 * that it indicates SUCCESS.
1465 */
1466 return SUCCESS;
1467 /*
1468 * when the low level driver returns did_soft_error,
1469 * it is responsible for keeping an internal retry counter
1470 * in order to avoid endless loops (db)
1471 *
1472 * actually this is a bug in this function here. we should
1473 * be mindful of the maximum number of retries specified
1474 * and not get stuck in a loop.
1475 */
1476 case DID_SOFT_ERROR:
1477 goto maybe_retry;
1478 case DID_IMM_RETRY:
1479 return NEEDS_RETRY;
1480
1481 case DID_REQUEUE:
1482 return ADD_TO_MLQUEUE;
1483 case DID_TRANSPORT_DISRUPTED:
1484 /*
1485 * LLD/transport was disrupted during processing of the IO.
1486 * The transport class is now blocked/blocking,
1487 * and the transport will decide what to do with the IO
1488 * based on its timers and recovery capablilities if
1489 * there are enough retries.
1490 */
1491 goto maybe_retry;
1492 case DID_TRANSPORT_FAILFAST:
1493 /*
1494 * The transport decided to failfast the IO (most likely
1495 * the fast io fail tmo fired), so send IO directly upwards.
1496 */
1497 return SUCCESS;
1498 case DID_ERROR:
1499 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1500 status_byte(scmd->result) == RESERVATION_CONFLICT)
1501 /*
1502 * execute reservation conflict processing code
1503 * lower down
1504 */
1505 break;
1506 /* fallthrough */
1507 case DID_BUS_BUSY:
1508 case DID_PARITY:
1509 goto maybe_retry;
1510 case DID_TIME_OUT:
1511 /*
1512 * when we scan the bus, we get timeout messages for
1513 * these commands if there is no device available.
1514 * other hosts report did_no_connect for the same thing.
1515 */
1516 if ((scmd->cmnd[0] == TEST_UNIT_READY ||
1517 scmd->cmnd[0] == INQUIRY)) {
1518 return SUCCESS;
1519 } else {
1520 return FAILED;
1521 }
1522 case DID_RESET:
1523 return SUCCESS;
1524 default:
1525 return FAILED;
1526 }
1527
1528 /*
1529 * next, check the message byte.
1530 */
1531 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
1532 return FAILED;
1533
1534 /*
1535 * check the status byte to see if this indicates anything special.
1536 */
1537 switch (status_byte(scmd->result)) {
1538 case QUEUE_FULL:
1539 scsi_handle_queue_full(scmd->device);
1540 /*
1541 * the case of trying to send too many commands to a
1542 * tagged queueing device.
1543 */
1544 case BUSY:
1545 /*
1546 * device can't talk to us at the moment. Should only
1547 * occur (SAM-3) when the task queue is empty, so will cause
1548 * the empty queue handling to trigger a stall in the
1549 * device.
1550 */
1551 return ADD_TO_MLQUEUE;
1552 case GOOD:
1553 scsi_handle_queue_ramp_up(scmd->device);
1554 case COMMAND_TERMINATED:
1555 return SUCCESS;
1556 case TASK_ABORTED:
1557 goto maybe_retry;
1558 case CHECK_CONDITION:
1559 rtn = scsi_check_sense(scmd);
1560 if (rtn == NEEDS_RETRY)
1561 goto maybe_retry;
1562 else if (rtn == TARGET_ERROR) {
1563 /*
1564 * Need to modify host byte to signal a
1565 * permanent target failure
1566 */
1567 set_host_byte(scmd, DID_TARGET_FAILURE);
1568 rtn = SUCCESS;
1569 }
1570 /* if rtn == FAILED, we have no sense information;
1571 * returning FAILED will wake the error handler thread
1572 * to collect the sense and redo the decide
1573 * disposition */
1574 return rtn;
1575 case CONDITION_GOOD:
1576 case INTERMEDIATE_GOOD:
1577 case INTERMEDIATE_C_GOOD:
1578 case ACA_ACTIVE:
1579 /*
1580 * who knows? FIXME(eric)
1581 */
1582 return SUCCESS;
1583
1584 case RESERVATION_CONFLICT:
1585 sdev_printk(KERN_INFO, scmd->device,
1586 "reservation conflict\n");
1587 set_host_byte(scmd, DID_NEXUS_FAILURE);
1588 return SUCCESS; /* causes immediate i/o error */
1589 default:
1590 return FAILED;
1591 }
1592 return FAILED;
1593
1594 maybe_retry:
1595
1596 /* we requeue for retry because the error was retryable, and
1597 * the request was not marked fast fail. Note that above,
1598 * even if the request is marked fast fail, we still requeue
1599 * for queue congestion conditions (QUEUE_FULL or BUSY) */
1600 if ((++scmd->retries) <= scmd->allowed
1601 && !scsi_noretry_cmd(scmd)) {
1602 return NEEDS_RETRY;
1603 } else {
1604 /*
1605 * no more retries - report this one back to upper level.
1606 */
1607 return SUCCESS;
1608 }
1609}
1610
1611static void eh_lock_door_done(struct request *req, int uptodate)
1612{
1613 __blk_put_request(req->q, req);
1614}
1615
1616/**
1617 * scsi_eh_lock_door - Prevent medium removal for the specified device
1618 * @sdev: SCSI device to prevent medium removal
1619 *
1620 * Locking:
1621 * We must be called from process context.
1622 *
1623 * Notes:
1624 * We queue up an asynchronous "ALLOW MEDIUM REMOVAL" request on the
1625 * head of the devices request queue, and continue.
1626 */
1627static void scsi_eh_lock_door(struct scsi_device *sdev)
1628{
1629 struct request *req;
1630
1631 /*
1632 * blk_get_request with GFP_KERNEL (__GFP_WAIT) sleeps until a
1633 * request becomes available
1634 */
1635 req = blk_get_request(sdev->request_queue, READ, GFP_KERNEL);
1636
1637 req->cmd[0] = ALLOW_MEDIUM_REMOVAL;
1638 req->cmd[1] = 0;
1639 req->cmd[2] = 0;
1640 req->cmd[3] = 0;
1641 req->cmd[4] = SCSI_REMOVAL_PREVENT;
1642 req->cmd[5] = 0;
1643
1644 req->cmd_len = COMMAND_SIZE(req->cmd[0]);
1645
1646 req->cmd_type = REQ_TYPE_BLOCK_PC;
1647 req->cmd_flags |= REQ_QUIET;
1648 req->timeout = 10 * HZ;
1649 req->retries = 5;
1650
1651 blk_execute_rq_nowait(req->q, NULL, req, 1, eh_lock_door_done);
1652}
1653
1654/**
1655 * scsi_restart_operations - restart io operations to the specified host.
1656 * @shost: Host we are restarting.
1657 *
1658 * Notes:
1659 * When we entered the error handler, we blocked all further i/o to
1660 * this device. we need to 'reverse' this process.
1661 */
1662static void scsi_restart_operations(struct Scsi_Host *shost)
1663{
1664 struct scsi_device *sdev;
1665 unsigned long flags;
1666
1667 /*
1668 * If the door was locked, we need to insert a door lock request
1669 * onto the head of the SCSI request queue for the device. There
1670 * is no point trying to lock the door of an off-line device.
1671 */
1672 shost_for_each_device(sdev, shost) {
1673 if (scsi_device_online(sdev) && sdev->locked)
1674 scsi_eh_lock_door(sdev);
1675 }
1676
1677 /*
1678 * next free up anything directly waiting upon the host. this
1679 * will be requests for character device operations, and also for
1680 * ioctls to queued block devices.
1681 */
1682 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: waking up host to restart\n",
1683 __func__));
1684
1685 spin_lock_irqsave(shost->host_lock, flags);
1686 if (scsi_host_set_state(shost, SHOST_RUNNING))
1687 if (scsi_host_set_state(shost, SHOST_CANCEL))
1688 BUG_ON(scsi_host_set_state(shost, SHOST_DEL));
1689 spin_unlock_irqrestore(shost->host_lock, flags);
1690
1691 wake_up(&shost->host_wait);
1692
1693 /*
1694 * finally we need to re-initiate requests that may be pending. we will
1695 * have had everything blocked while error handling is taking place, and
1696 * now that error recovery is done, we will need to ensure that these
1697 * requests are started.
1698 */
1699 scsi_run_host_queues(shost);
1700
1701 /*
1702 * if eh is active and host_eh_scheduled is pending we need to re-run
1703 * recovery. we do this check after scsi_run_host_queues() to allow
1704 * everything pent up since the last eh run a chance to make forward
1705 * progress before we sync again. Either we'll immediately re-run
1706 * recovery or scsi_device_unbusy() will wake us again when these
1707 * pending commands complete.
1708 */
1709 spin_lock_irqsave(shost->host_lock, flags);
1710 if (shost->host_eh_scheduled)
1711 if (scsi_host_set_state(shost, SHOST_RECOVERY))
1712 WARN_ON(scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY));
1713 spin_unlock_irqrestore(shost->host_lock, flags);
1714}
1715
1716/**
1717 * scsi_eh_ready_devs - check device ready state and recover if not.
1718 * @shost: host to be recovered.
1719 * @work_q: &list_head for pending commands.
1720 * @done_q: &list_head for processed commands.
1721 */
1722void scsi_eh_ready_devs(struct Scsi_Host *shost,
1723 struct list_head *work_q,
1724 struct list_head *done_q)
1725{
1726 if (!scsi_eh_stu(shost, work_q, done_q))
1727 if (!scsi_eh_bus_device_reset(shost, work_q, done_q))
1728 if (!scsi_eh_target_reset(shost, work_q, done_q))
1729 if (!scsi_eh_bus_reset(shost, work_q, done_q))
1730 if (!scsi_eh_host_reset(work_q, done_q))
1731 scsi_eh_offline_sdevs(work_q,
1732 done_q);
1733}
1734EXPORT_SYMBOL_GPL(scsi_eh_ready_devs);
1735
1736/**
1737 * scsi_eh_flush_done_q - finish processed commands or retry them.
1738 * @done_q: list_head of processed commands.
1739 */
1740void scsi_eh_flush_done_q(struct list_head *done_q)
1741{
1742 struct scsi_cmnd *scmd, *next;
1743
1744 list_for_each_entry_safe(scmd, next, done_q, eh_entry) {
1745 list_del_init(&scmd->eh_entry);
1746 if (scsi_device_online(scmd->device) &&
1747 !scsi_noretry_cmd(scmd) &&
1748 (++scmd->retries <= scmd->allowed)) {
1749 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: flush"
1750 " retry cmd: %p\n",
1751 current->comm,
1752 scmd));
1753 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
1754 } else {
1755 /*
1756 * If just we got sense for the device (called
1757 * scsi_eh_get_sense), scmd->result is already
1758 * set, do not set DRIVER_TIMEOUT.
1759 */
1760 if (!scmd->result)
1761 scmd->result |= (DRIVER_TIMEOUT << 24);
1762 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: flush finish"
1763 " cmd: %p\n",
1764 current->comm, scmd));
1765 scsi_finish_command(scmd);
1766 }
1767 }
1768}
1769EXPORT_SYMBOL(scsi_eh_flush_done_q);
1770
1771/**
1772 * scsi_unjam_host - Attempt to fix a host which has a cmd that failed.
1773 * @shost: Host to unjam.
1774 *
1775 * Notes:
1776 * When we come in here, we *know* that all commands on the bus have
1777 * either completed, failed or timed out. we also know that no further
1778 * commands are being sent to the host, so things are relatively quiet
1779 * and we have freedom to fiddle with things as we wish.
1780 *
1781 * This is only the *default* implementation. it is possible for
1782 * individual drivers to supply their own version of this function, and
1783 * if the maintainer wishes to do this, it is strongly suggested that
1784 * this function be taken as a template and modified. this function
1785 * was designed to correctly handle problems for about 95% of the
1786 * different cases out there, and it should always provide at least a
1787 * reasonable amount of error recovery.
1788 *
1789 * Any command marked 'failed' or 'timeout' must eventually have
1790 * scsi_finish_cmd() called for it. we do all of the retry stuff
1791 * here, so when we restart the host after we return it should have an
1792 * empty queue.
1793 */
1794static void scsi_unjam_host(struct Scsi_Host *shost)
1795{
1796 unsigned long flags;
1797 LIST_HEAD(eh_work_q);
1798 LIST_HEAD(eh_done_q);
1799
1800 spin_lock_irqsave(shost->host_lock, flags);
1801 list_splice_init(&shost->eh_cmd_q, &eh_work_q);
1802 spin_unlock_irqrestore(shost->host_lock, flags);
1803
1804 SCSI_LOG_ERROR_RECOVERY(1, scsi_eh_prt_fail_stats(shost, &eh_work_q));
1805
1806 if (!scsi_eh_get_sense(&eh_work_q, &eh_done_q))
1807 if (!scsi_eh_abort_cmds(&eh_work_q, &eh_done_q))
1808 scsi_eh_ready_devs(shost, &eh_work_q, &eh_done_q);
1809
1810 scsi_eh_flush_done_q(&eh_done_q);
1811}
1812
1813/**
1814 * scsi_error_handler - SCSI error handler thread
1815 * @data: Host for which we are running.
1816 *
1817 * Notes:
1818 * This is the main error handling loop. This is run as a kernel thread
1819 * for every SCSI host and handles all error handling activity.
1820 */
1821int scsi_error_handler(void *data)
1822{
1823 struct Scsi_Host *shost = data;
1824
1825 /*
1826 * We use TASK_INTERRUPTIBLE so that the thread is not
1827 * counted against the load average as a running process.
1828 * We never actually get interrupted because kthread_run
1829 * disables signal delivery for the created thread.
1830 */
1831 set_current_state(TASK_INTERRUPTIBLE);
1832 while (!kthread_should_stop()) {
1833 if ((shost->host_failed == 0 && shost->host_eh_scheduled == 0) ||
1834 shost->host_failed != shost->host_busy) {
1835 SCSI_LOG_ERROR_RECOVERY(1,
1836 printk("Error handler scsi_eh_%d sleeping\n",
1837 shost->host_no));
1838 schedule();
1839 set_current_state(TASK_INTERRUPTIBLE);
1840 continue;
1841 }
1842
1843 __set_current_state(TASK_RUNNING);
1844 SCSI_LOG_ERROR_RECOVERY(1,
1845 printk("Error handler scsi_eh_%d waking up\n",
1846 shost->host_no));
1847
1848 /*
1849 * We have a host that is failing for some reason. Figure out
1850 * what we need to do to get it up and online again (if we can).
1851 * If we fail, we end up taking the thing offline.
1852 */
1853 if (!shost->eh_noresume && scsi_autopm_get_host(shost) != 0) {
1854 SCSI_LOG_ERROR_RECOVERY(1,
1855 printk(KERN_ERR "Error handler scsi_eh_%d "
1856 "unable to autoresume\n",
1857 shost->host_no));
1858 continue;
1859 }
1860
1861 if (shost->transportt->eh_strategy_handler)
1862 shost->transportt->eh_strategy_handler(shost);
1863 else
1864 scsi_unjam_host(shost);
1865
1866 /*
1867 * Note - if the above fails completely, the action is to take
1868 * individual devices offline and flush the queue of any
1869 * outstanding requests that may have been pending. When we
1870 * restart, we restart any I/O to any other devices on the bus
1871 * which are still online.
1872 */
1873 scsi_restart_operations(shost);
1874 if (!shost->eh_noresume)
1875 scsi_autopm_put_host(shost);
1876 set_current_state(TASK_INTERRUPTIBLE);
1877 }
1878 __set_current_state(TASK_RUNNING);
1879
1880 SCSI_LOG_ERROR_RECOVERY(1,
1881 printk("Error handler scsi_eh_%d exiting\n", shost->host_no));
1882 shost->ehandler = NULL;
1883 return 0;
1884}
1885
1886/*
1887 * Function: scsi_report_bus_reset()
1888 *
1889 * Purpose: Utility function used by low-level drivers to report that
1890 * they have observed a bus reset on the bus being handled.
1891 *
1892 * Arguments: shost - Host in question
1893 * channel - channel on which reset was observed.
1894 *
1895 * Returns: Nothing
1896 *
1897 * Lock status: Host lock must be held.
1898 *
1899 * Notes: This only needs to be called if the reset is one which
1900 * originates from an unknown location. Resets originated
1901 * by the mid-level itself don't need to call this, but there
1902 * should be no harm.
1903 *
1904 * The main purpose of this is to make sure that a CHECK_CONDITION
1905 * is properly treated.
1906 */
1907void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
1908{
1909 struct scsi_device *sdev;
1910
1911 __shost_for_each_device(sdev, shost) {
1912 if (channel == sdev_channel(sdev))
1913 __scsi_report_device_reset(sdev, NULL);
1914 }
1915}
1916EXPORT_SYMBOL(scsi_report_bus_reset);
1917
1918/*
1919 * Function: scsi_report_device_reset()
1920 *
1921 * Purpose: Utility function used by low-level drivers to report that
1922 * they have observed a device reset on the device being handled.
1923 *
1924 * Arguments: shost - Host in question
1925 * channel - channel on which reset was observed
1926 * target - target on which reset was observed
1927 *
1928 * Returns: Nothing
1929 *
1930 * Lock status: Host lock must be held
1931 *
1932 * Notes: This only needs to be called if the reset is one which
1933 * originates from an unknown location. Resets originated
1934 * by the mid-level itself don't need to call this, but there
1935 * should be no harm.
1936 *
1937 * The main purpose of this is to make sure that a CHECK_CONDITION
1938 * is properly treated.
1939 */
1940void scsi_report_device_reset(struct Scsi_Host *shost, int channel, int target)
1941{
1942 struct scsi_device *sdev;
1943
1944 __shost_for_each_device(sdev, shost) {
1945 if (channel == sdev_channel(sdev) &&
1946 target == sdev_id(sdev))
1947 __scsi_report_device_reset(sdev, NULL);
1948 }
1949}
1950EXPORT_SYMBOL(scsi_report_device_reset);
1951
1952static void
1953scsi_reset_provider_done_command(struct scsi_cmnd *scmd)
1954{
1955}
1956
1957/*
1958 * Function: scsi_reset_provider
1959 *
1960 * Purpose: Send requested reset to a bus or device at any phase.
1961 *
1962 * Arguments: device - device to send reset to
1963 * flag - reset type (see scsi.h)
1964 *
1965 * Returns: SUCCESS/FAILURE.
1966 *
1967 * Notes: This is used by the SCSI Generic driver to provide
1968 * Bus/Device reset capability.
1969 */
1970int
1971scsi_reset_provider(struct scsi_device *dev, int flag)
1972{
1973 struct scsi_cmnd *scmd;
1974 struct Scsi_Host *shost = dev->host;
1975 struct request req;
1976 unsigned long flags;
1977 int rtn;
1978
1979 if (scsi_autopm_get_host(shost) < 0)
1980 return FAILED;
1981
1982 scmd = scsi_get_command(dev, GFP_KERNEL);
1983 blk_rq_init(NULL, &req);
1984 scmd->request = &req;
1985
1986 scmd->cmnd = req.cmd;
1987
1988 scmd->scsi_done = scsi_reset_provider_done_command;
1989 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
1990
1991 scmd->cmd_len = 0;
1992
1993 scmd->sc_data_direction = DMA_BIDIRECTIONAL;
1994
1995 spin_lock_irqsave(shost->host_lock, flags);
1996 shost->tmf_in_progress = 1;
1997 spin_unlock_irqrestore(shost->host_lock, flags);
1998
1999 switch (flag) {
2000 case SCSI_TRY_RESET_DEVICE:
2001 rtn = scsi_try_bus_device_reset(scmd);
2002 if (rtn == SUCCESS)
2003 break;
2004 /* FALLTHROUGH */
2005 case SCSI_TRY_RESET_TARGET:
2006 rtn = scsi_try_target_reset(scmd);
2007 if (rtn == SUCCESS)
2008 break;
2009 /* FALLTHROUGH */
2010 case SCSI_TRY_RESET_BUS:
2011 rtn = scsi_try_bus_reset(scmd);
2012 if (rtn == SUCCESS)
2013 break;
2014 /* FALLTHROUGH */
2015 case SCSI_TRY_RESET_HOST:
2016 rtn = scsi_try_host_reset(scmd);
2017 break;
2018 default:
2019 rtn = FAILED;
2020 }
2021
2022 spin_lock_irqsave(shost->host_lock, flags);
2023 shost->tmf_in_progress = 0;
2024 spin_unlock_irqrestore(shost->host_lock, flags);
2025
2026 /*
2027 * be sure to wake up anyone who was sleeping or had their queue
2028 * suspended while we performed the TMF.
2029 */
2030 SCSI_LOG_ERROR_RECOVERY(3,
2031 printk("%s: waking up host to restart after TMF\n",
2032 __func__));
2033
2034 wake_up(&shost->host_wait);
2035
2036 scsi_run_host_queues(shost);
2037
2038 scsi_next_command(scmd);
2039 scsi_autopm_put_host(shost);
2040 return rtn;
2041}
2042EXPORT_SYMBOL(scsi_reset_provider);
2043
2044/**
2045 * scsi_normalize_sense - normalize main elements from either fixed or
2046 * descriptor sense data format into a common format.
2047 *
2048 * @sense_buffer: byte array containing sense data returned by device
2049 * @sb_len: number of valid bytes in sense_buffer
2050 * @sshdr: pointer to instance of structure that common
2051 * elements are written to.
2052 *
2053 * Notes:
2054 * The "main elements" from sense data are: response_code, sense_key,
2055 * asc, ascq and additional_length (only for descriptor format).
2056 *
2057 * Typically this function can be called after a device has
2058 * responded to a SCSI command with the CHECK_CONDITION status.
2059 *
2060 * Return value:
2061 * 1 if valid sense data information found, else 0;
2062 */
2063int scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
2064 struct scsi_sense_hdr *sshdr)
2065{
2066 if (!sense_buffer || !sb_len)
2067 return 0;
2068
2069 memset(sshdr, 0, sizeof(struct scsi_sense_hdr));
2070
2071 sshdr->response_code = (sense_buffer[0] & 0x7f);
2072
2073 if (!scsi_sense_valid(sshdr))
2074 return 0;
2075
2076 if (sshdr->response_code >= 0x72) {
2077 /*
2078 * descriptor format
2079 */
2080 if (sb_len > 1)
2081 sshdr->sense_key = (sense_buffer[1] & 0xf);
2082 if (sb_len > 2)
2083 sshdr->asc = sense_buffer[2];
2084 if (sb_len > 3)
2085 sshdr->ascq = sense_buffer[3];
2086 if (sb_len > 7)
2087 sshdr->additional_length = sense_buffer[7];
2088 } else {
2089 /*
2090 * fixed format
2091 */
2092 if (sb_len > 2)
2093 sshdr->sense_key = (sense_buffer[2] & 0xf);
2094 if (sb_len > 7) {
2095 sb_len = (sb_len < (sense_buffer[7] + 8)) ?
2096 sb_len : (sense_buffer[7] + 8);
2097 if (sb_len > 12)
2098 sshdr->asc = sense_buffer[12];
2099 if (sb_len > 13)
2100 sshdr->ascq = sense_buffer[13];
2101 }
2102 }
2103
2104 return 1;
2105}
2106EXPORT_SYMBOL(scsi_normalize_sense);
2107
2108int scsi_command_normalize_sense(struct scsi_cmnd *cmd,
2109 struct scsi_sense_hdr *sshdr)
2110{
2111 return scsi_normalize_sense(cmd->sense_buffer,
2112 SCSI_SENSE_BUFFERSIZE, sshdr);
2113}
2114EXPORT_SYMBOL(scsi_command_normalize_sense);
2115
2116/**
2117 * scsi_sense_desc_find - search for a given descriptor type in descriptor sense data format.
2118 * @sense_buffer: byte array of descriptor format sense data
2119 * @sb_len: number of valid bytes in sense_buffer
2120 * @desc_type: value of descriptor type to find
2121 * (e.g. 0 -> information)
2122 *
2123 * Notes:
2124 * only valid when sense data is in descriptor format
2125 *
2126 * Return value:
2127 * pointer to start of (first) descriptor if found else NULL
2128 */
2129const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
2130 int desc_type)
2131{
2132 int add_sen_len, add_len, desc_len, k;
2133 const u8 * descp;
2134
2135 if ((sb_len < 8) || (0 == (add_sen_len = sense_buffer[7])))
2136 return NULL;
2137 if ((sense_buffer[0] < 0x72) || (sense_buffer[0] > 0x73))
2138 return NULL;
2139 add_sen_len = (add_sen_len < (sb_len - 8)) ?
2140 add_sen_len : (sb_len - 8);
2141 descp = &sense_buffer[8];
2142 for (desc_len = 0, k = 0; k < add_sen_len; k += desc_len) {
2143 descp += desc_len;
2144 add_len = (k < (add_sen_len - 1)) ? descp[1]: -1;
2145 desc_len = add_len + 2;
2146 if (descp[0] == desc_type)
2147 return descp;
2148 if (add_len < 0) // short descriptor ??
2149 break;
2150 }
2151 return NULL;
2152}
2153EXPORT_SYMBOL(scsi_sense_desc_find);
2154
2155/**
2156 * scsi_get_sense_info_fld - get information field from sense data (either fixed or descriptor format)
2157 * @sense_buffer: byte array of sense data
2158 * @sb_len: number of valid bytes in sense_buffer
2159 * @info_out: pointer to 64 integer where 8 or 4 byte information
2160 * field will be placed if found.
2161 *
2162 * Return value:
2163 * 1 if information field found, 0 if not found.
2164 */
2165int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
2166 u64 * info_out)
2167{
2168 int j;
2169 const u8 * ucp;
2170 u64 ull;
2171
2172 if (sb_len < 7)
2173 return 0;
2174 switch (sense_buffer[0] & 0x7f) {
2175 case 0x70:
2176 case 0x71:
2177 if (sense_buffer[0] & 0x80) {
2178 *info_out = (sense_buffer[3] << 24) +
2179 (sense_buffer[4] << 16) +
2180 (sense_buffer[5] << 8) + sense_buffer[6];
2181 return 1;
2182 } else
2183 return 0;
2184 case 0x72:
2185 case 0x73:
2186 ucp = scsi_sense_desc_find(sense_buffer, sb_len,
2187 0 /* info desc */);
2188 if (ucp && (0xa == ucp[1])) {
2189 ull = 0;
2190 for (j = 0; j < 8; ++j) {
2191 if (j > 0)
2192 ull <<= 8;
2193 ull |= ucp[4 + j];
2194 }
2195 *info_out = ull;
2196 return 1;
2197 } else
2198 return 0;
2199 default:
2200 return 0;
2201 }
2202}
2203EXPORT_SYMBOL(scsi_get_sense_info_fld);
2204
2205/**
2206 * scsi_build_sense_buffer - build sense data in a buffer
2207 * @desc: Sense format (non zero == descriptor format,
2208 * 0 == fixed format)
2209 * @buf: Where to build sense data
2210 * @key: Sense key
2211 * @asc: Additional sense code
2212 * @ascq: Additional sense code qualifier
2213 *
2214 **/
2215void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq)
2216{
2217 if (desc) {
2218 buf[0] = 0x72; /* descriptor, current */
2219 buf[1] = key;
2220 buf[2] = asc;
2221 buf[3] = ascq;
2222 buf[7] = 0;
2223 } else {
2224 buf[0] = 0x70; /* fixed, current */
2225 buf[2] = key;
2226 buf[7] = 0xa;
2227 buf[12] = asc;
2228 buf[13] = ascq;
2229 }
2230}
2231EXPORT_SYMBOL(scsi_build_sense_buffer);
1/*
2 * scsi_error.c Copyright (C) 1997 Eric Youngdale
3 *
4 * SCSI error/timeout handling
5 * Initial versions: Eric Youngdale. Based upon conversations with
6 * Leonard Zubkoff and David Miller at Linux Expo,
7 * ideas originating from all over the place.
8 *
9 * Restructured scsi_unjam_host and associated functions.
10 * September 04, 2002 Mike Anderson (andmike@us.ibm.com)
11 *
12 * Forward port of Russell King's (rmk@arm.linux.org.uk) changes and
13 * minor cleanups.
14 * September 30, 2002 Mike Anderson (andmike@us.ibm.com)
15 */
16
17#include <linux/module.h>
18#include <linux/sched.h>
19#include <linux/gfp.h>
20#include <linux/timer.h>
21#include <linux/string.h>
22#include <linux/kernel.h>
23#include <linux/freezer.h>
24#include <linux/kthread.h>
25#include <linux/interrupt.h>
26#include <linux/blkdev.h>
27#include <linux/delay.h>
28#include <linux/jiffies.h>
29
30#include <scsi/scsi.h>
31#include <scsi/scsi_cmnd.h>
32#include <scsi/scsi_dbg.h>
33#include <scsi/scsi_device.h>
34#include <scsi/scsi_driver.h>
35#include <scsi/scsi_eh.h>
36#include <scsi/scsi_transport.h>
37#include <scsi/scsi_host.h>
38#include <scsi/scsi_ioctl.h>
39
40#include "scsi_priv.h"
41#include "scsi_logging.h"
42#include "scsi_transport_api.h"
43
44#include <trace/events/scsi.h>
45
46static void scsi_eh_done(struct scsi_cmnd *scmd);
47
48/*
49 * These should *probably* be handled by the host itself.
50 * Since it is allowed to sleep, it probably should.
51 */
52#define BUS_RESET_SETTLE_TIME (10)
53#define HOST_RESET_SETTLE_TIME (10)
54
55static int scsi_eh_try_stu(struct scsi_cmnd *scmd);
56static int scsi_try_to_abort_cmd(struct scsi_host_template *,
57 struct scsi_cmnd *);
58
59/* called with shost->host_lock held */
60void scsi_eh_wakeup(struct Scsi_Host *shost)
61{
62 if (shost->host_busy == shost->host_failed) {
63 trace_scsi_eh_wakeup(shost);
64 wake_up_process(shost->ehandler);
65 SCSI_LOG_ERROR_RECOVERY(5,
66 printk("Waking error handler thread\n"));
67 }
68}
69
70/**
71 * scsi_schedule_eh - schedule EH for SCSI host
72 * @shost: SCSI host to invoke error handling on.
73 *
74 * Schedule SCSI EH without scmd.
75 */
76void scsi_schedule_eh(struct Scsi_Host *shost)
77{
78 unsigned long flags;
79
80 spin_lock_irqsave(shost->host_lock, flags);
81
82 if (scsi_host_set_state(shost, SHOST_RECOVERY) == 0 ||
83 scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY) == 0) {
84 shost->host_eh_scheduled++;
85 scsi_eh_wakeup(shost);
86 }
87
88 spin_unlock_irqrestore(shost->host_lock, flags);
89}
90EXPORT_SYMBOL_GPL(scsi_schedule_eh);
91
92static int scsi_host_eh_past_deadline(struct Scsi_Host *shost)
93{
94 if (!shost->last_reset || shost->eh_deadline == -1)
95 return 0;
96
97 /*
98 * 32bit accesses are guaranteed to be atomic
99 * (on all supported architectures), so instead
100 * of using a spinlock we can as well double check
101 * if eh_deadline has been set to 'off' during the
102 * time_before call.
103 */
104 if (time_before(jiffies, shost->last_reset + shost->eh_deadline) &&
105 shost->eh_deadline > -1)
106 return 0;
107
108 return 1;
109}
110
111/**
112 * scmd_eh_abort_handler - Handle command aborts
113 * @work: command to be aborted.
114 */
115void
116scmd_eh_abort_handler(struct work_struct *work)
117{
118 struct scsi_cmnd *scmd =
119 container_of(work, struct scsi_cmnd, abort_work.work);
120 struct scsi_device *sdev = scmd->device;
121 int rtn;
122
123 if (scsi_host_eh_past_deadline(sdev->host)) {
124 SCSI_LOG_ERROR_RECOVERY(3,
125 scmd_printk(KERN_INFO, scmd,
126 "scmd %p eh timeout, not aborting\n",
127 scmd));
128 } else {
129 SCSI_LOG_ERROR_RECOVERY(3,
130 scmd_printk(KERN_INFO, scmd,
131 "aborting command %p\n", scmd));
132 rtn = scsi_try_to_abort_cmd(sdev->host->hostt, scmd);
133 if (rtn == SUCCESS) {
134 scmd->result |= DID_TIME_OUT << 16;
135 if (scsi_host_eh_past_deadline(sdev->host)) {
136 SCSI_LOG_ERROR_RECOVERY(3,
137 scmd_printk(KERN_INFO, scmd,
138 "scmd %p eh timeout, "
139 "not retrying aborted "
140 "command\n", scmd));
141 } else if (!scsi_noretry_cmd(scmd) &&
142 (++scmd->retries <= scmd->allowed)) {
143 SCSI_LOG_ERROR_RECOVERY(3,
144 scmd_printk(KERN_WARNING, scmd,
145 "scmd %p retry "
146 "aborted command\n", scmd));
147 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
148 return;
149 } else {
150 SCSI_LOG_ERROR_RECOVERY(3,
151 scmd_printk(KERN_WARNING, scmd,
152 "scmd %p finish "
153 "aborted command\n", scmd));
154 scsi_finish_command(scmd);
155 return;
156 }
157 } else {
158 SCSI_LOG_ERROR_RECOVERY(3,
159 scmd_printk(KERN_INFO, scmd,
160 "scmd %p abort failed, rtn %d\n",
161 scmd, rtn));
162 }
163 }
164
165 if (!scsi_eh_scmd_add(scmd, 0)) {
166 SCSI_LOG_ERROR_RECOVERY(3,
167 scmd_printk(KERN_WARNING, scmd,
168 "scmd %p terminate "
169 "aborted command\n", scmd));
170 scmd->result |= DID_TIME_OUT << 16;
171 scsi_finish_command(scmd);
172 }
173}
174
175/**
176 * scsi_abort_command - schedule a command abort
177 * @scmd: scmd to abort.
178 *
179 * We only need to abort commands after a command timeout
180 */
181static int
182scsi_abort_command(struct scsi_cmnd *scmd)
183{
184 struct scsi_device *sdev = scmd->device;
185 struct Scsi_Host *shost = sdev->host;
186 unsigned long flags;
187
188 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
189 /*
190 * Retry after abort failed, escalate to next level.
191 */
192 scmd->eh_eflags &= ~SCSI_EH_ABORT_SCHEDULED;
193 SCSI_LOG_ERROR_RECOVERY(3,
194 scmd_printk(KERN_INFO, scmd,
195 "scmd %p previous abort failed\n", scmd));
196 cancel_delayed_work(&scmd->abort_work);
197 return FAILED;
198 }
199
200 /*
201 * Do not try a command abort if
202 * SCSI EH has already started.
203 */
204 spin_lock_irqsave(shost->host_lock, flags);
205 if (scsi_host_in_recovery(shost)) {
206 spin_unlock_irqrestore(shost->host_lock, flags);
207 SCSI_LOG_ERROR_RECOVERY(3,
208 scmd_printk(KERN_INFO, scmd,
209 "scmd %p not aborting, host in recovery\n",
210 scmd));
211 return FAILED;
212 }
213
214 if (shost->eh_deadline != -1 && !shost->last_reset)
215 shost->last_reset = jiffies;
216 spin_unlock_irqrestore(shost->host_lock, flags);
217
218 scmd->eh_eflags |= SCSI_EH_ABORT_SCHEDULED;
219 SCSI_LOG_ERROR_RECOVERY(3,
220 scmd_printk(KERN_INFO, scmd,
221 "scmd %p abort scheduled\n", scmd));
222 queue_delayed_work(shost->tmf_work_q, &scmd->abort_work, HZ / 100);
223 return SUCCESS;
224}
225
226/**
227 * scsi_eh_scmd_add - add scsi cmd to error handling.
228 * @scmd: scmd to run eh on.
229 * @eh_flag: optional SCSI_EH flag.
230 *
231 * Return value:
232 * 0 on failure.
233 */
234int scsi_eh_scmd_add(struct scsi_cmnd *scmd, int eh_flag)
235{
236 struct Scsi_Host *shost = scmd->device->host;
237 unsigned long flags;
238 int ret = 0;
239
240 if (!shost->ehandler)
241 return 0;
242
243 spin_lock_irqsave(shost->host_lock, flags);
244 if (scsi_host_set_state(shost, SHOST_RECOVERY))
245 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY))
246 goto out_unlock;
247
248 if (shost->eh_deadline != -1 && !shost->last_reset)
249 shost->last_reset = jiffies;
250
251 ret = 1;
252 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED)
253 eh_flag &= ~SCSI_EH_CANCEL_CMD;
254 scmd->eh_eflags |= eh_flag;
255 list_add_tail(&scmd->eh_entry, &shost->eh_cmd_q);
256 shost->host_failed++;
257 scsi_eh_wakeup(shost);
258 out_unlock:
259 spin_unlock_irqrestore(shost->host_lock, flags);
260 return ret;
261}
262
263/**
264 * scsi_times_out - Timeout function for normal scsi commands.
265 * @req: request that is timing out.
266 *
267 * Notes:
268 * We do not need to lock this. There is the potential for a race
269 * only in that the normal completion handling might run, but if the
270 * normal completion function determines that the timer has already
271 * fired, then it mustn't do anything.
272 */
273enum blk_eh_timer_return scsi_times_out(struct request *req)
274{
275 struct scsi_cmnd *scmd = req->special;
276 enum blk_eh_timer_return rtn = BLK_EH_NOT_HANDLED;
277 struct Scsi_Host *host = scmd->device->host;
278
279 trace_scsi_dispatch_cmd_timeout(scmd);
280 scsi_log_completion(scmd, TIMEOUT_ERROR);
281
282 if (host->eh_deadline != -1 && !host->last_reset)
283 host->last_reset = jiffies;
284
285 if (host->transportt->eh_timed_out)
286 rtn = host->transportt->eh_timed_out(scmd);
287 else if (host->hostt->eh_timed_out)
288 rtn = host->hostt->eh_timed_out(scmd);
289
290 if (rtn == BLK_EH_NOT_HANDLED && !host->hostt->no_async_abort)
291 if (scsi_abort_command(scmd) == SUCCESS)
292 return BLK_EH_NOT_HANDLED;
293
294 scmd->result |= DID_TIME_OUT << 16;
295
296 if (unlikely(rtn == BLK_EH_NOT_HANDLED &&
297 !scsi_eh_scmd_add(scmd, SCSI_EH_CANCEL_CMD)))
298 rtn = BLK_EH_HANDLED;
299
300 return rtn;
301}
302
303/**
304 * scsi_block_when_processing_errors - Prevent cmds from being queued.
305 * @sdev: Device on which we are performing recovery.
306 *
307 * Description:
308 * We block until the host is out of error recovery, and then check to
309 * see whether the host or the device is offline.
310 *
311 * Return value:
312 * 0 when dev was taken offline by error recovery. 1 OK to proceed.
313 */
314int scsi_block_when_processing_errors(struct scsi_device *sdev)
315{
316 int online;
317
318 wait_event(sdev->host->host_wait, !scsi_host_in_recovery(sdev->host));
319
320 online = scsi_device_online(sdev);
321
322 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: rtn: %d\n", __func__,
323 online));
324
325 return online;
326}
327EXPORT_SYMBOL(scsi_block_when_processing_errors);
328
329#ifdef CONFIG_SCSI_LOGGING
330/**
331 * scsi_eh_prt_fail_stats - Log info on failures.
332 * @shost: scsi host being recovered.
333 * @work_q: Queue of scsi cmds to process.
334 */
335static inline void scsi_eh_prt_fail_stats(struct Scsi_Host *shost,
336 struct list_head *work_q)
337{
338 struct scsi_cmnd *scmd;
339 struct scsi_device *sdev;
340 int total_failures = 0;
341 int cmd_failed = 0;
342 int cmd_cancel = 0;
343 int devices_failed = 0;
344
345 shost_for_each_device(sdev, shost) {
346 list_for_each_entry(scmd, work_q, eh_entry) {
347 if (scmd->device == sdev) {
348 ++total_failures;
349 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD)
350 ++cmd_cancel;
351 else
352 ++cmd_failed;
353 }
354 }
355
356 if (cmd_cancel || cmd_failed) {
357 SCSI_LOG_ERROR_RECOVERY(3,
358 sdev_printk(KERN_INFO, sdev,
359 "%s: cmds failed: %d, cancel: %d\n",
360 __func__, cmd_failed,
361 cmd_cancel));
362 cmd_cancel = 0;
363 cmd_failed = 0;
364 ++devices_failed;
365 }
366 }
367
368 SCSI_LOG_ERROR_RECOVERY(2, printk("Total of %d commands on %d"
369 " devices require eh work\n",
370 total_failures, devices_failed));
371}
372#endif
373
374 /**
375 * scsi_report_lun_change - Set flag on all *other* devices on the same target
376 * to indicate that a UNIT ATTENTION is expected.
377 * @sdev: Device reporting the UNIT ATTENTION
378 */
379static void scsi_report_lun_change(struct scsi_device *sdev)
380{
381 sdev->sdev_target->expecting_lun_change = 1;
382}
383
384/**
385 * scsi_report_sense - Examine scsi sense information and log messages for
386 * certain conditions, also issue uevents for some of them.
387 * @sdev: Device reporting the sense code
388 * @sshdr: sshdr to be examined
389 */
390static void scsi_report_sense(struct scsi_device *sdev,
391 struct scsi_sense_hdr *sshdr)
392{
393 enum scsi_device_event evt_type = SDEV_EVT_MAXBITS; /* i.e. none */
394
395 if (sshdr->sense_key == UNIT_ATTENTION) {
396 if (sshdr->asc == 0x3f && sshdr->ascq == 0x03) {
397 evt_type = SDEV_EVT_INQUIRY_CHANGE_REPORTED;
398 sdev_printk(KERN_WARNING, sdev,
399 "Inquiry data has changed");
400 } else if (sshdr->asc == 0x3f && sshdr->ascq == 0x0e) {
401 evt_type = SDEV_EVT_LUN_CHANGE_REPORTED;
402 scsi_report_lun_change(sdev);
403 sdev_printk(KERN_WARNING, sdev,
404 "Warning! Received an indication that the "
405 "LUN assignments on this target have "
406 "changed. The Linux SCSI layer does not "
407 "automatically remap LUN assignments.\n");
408 } else if (sshdr->asc == 0x3f)
409 sdev_printk(KERN_WARNING, sdev,
410 "Warning! Received an indication that the "
411 "operating parameters on this target have "
412 "changed. The Linux SCSI layer does not "
413 "automatically adjust these parameters.\n");
414
415 if (sshdr->asc == 0x38 && sshdr->ascq == 0x07) {
416 evt_type = SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED;
417 sdev_printk(KERN_WARNING, sdev,
418 "Warning! Received an indication that the "
419 "LUN reached a thin provisioning soft "
420 "threshold.\n");
421 }
422
423 if (sshdr->asc == 0x2a && sshdr->ascq == 0x01) {
424 evt_type = SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED;
425 sdev_printk(KERN_WARNING, sdev,
426 "Mode parameters changed");
427 } else if (sshdr->asc == 0x2a && sshdr->ascq == 0x09) {
428 evt_type = SDEV_EVT_CAPACITY_CHANGE_REPORTED;
429 sdev_printk(KERN_WARNING, sdev,
430 "Capacity data has changed");
431 } else if (sshdr->asc == 0x2a)
432 sdev_printk(KERN_WARNING, sdev,
433 "Parameters changed");
434 }
435
436 if (evt_type != SDEV_EVT_MAXBITS) {
437 set_bit(evt_type, sdev->pending_events);
438 schedule_work(&sdev->event_work);
439 }
440}
441
442/**
443 * scsi_check_sense - Examine scsi cmd sense
444 * @scmd: Cmd to have sense checked.
445 *
446 * Return value:
447 * SUCCESS or FAILED or NEEDS_RETRY or ADD_TO_MLQUEUE
448 *
449 * Notes:
450 * When a deferred error is detected the current command has
451 * not been executed and needs retrying.
452 */
453static int scsi_check_sense(struct scsi_cmnd *scmd)
454{
455 struct scsi_device *sdev = scmd->device;
456 struct scsi_sense_hdr sshdr;
457
458 if (! scsi_command_normalize_sense(scmd, &sshdr))
459 return FAILED; /* no valid sense data */
460
461 if (scmd->cmnd[0] == TEST_UNIT_READY && scmd->scsi_done != scsi_eh_done)
462 /*
463 * nasty: for mid-layer issued TURs, we need to return the
464 * actual sense data without any recovery attempt. For eh
465 * issued ones, we need to try to recover and interpret
466 */
467 return SUCCESS;
468
469 scsi_report_sense(sdev, &sshdr);
470
471 if (scsi_sense_is_deferred(&sshdr))
472 return NEEDS_RETRY;
473
474 if (sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh &&
475 sdev->scsi_dh_data->scsi_dh->check_sense) {
476 int rc;
477
478 rc = sdev->scsi_dh_data->scsi_dh->check_sense(sdev, &sshdr);
479 if (rc != SCSI_RETURN_NOT_HANDLED)
480 return rc;
481 /* handler does not care. Drop down to default handling */
482 }
483
484 /*
485 * Previous logic looked for FILEMARK, EOM or ILI which are
486 * mainly associated with tapes and returned SUCCESS.
487 */
488 if (sshdr.response_code == 0x70) {
489 /* fixed format */
490 if (scmd->sense_buffer[2] & 0xe0)
491 return SUCCESS;
492 } else {
493 /*
494 * descriptor format: look for "stream commands sense data
495 * descriptor" (see SSC-3). Assume single sense data
496 * descriptor. Ignore ILI from SBC-2 READ LONG and WRITE LONG.
497 */
498 if ((sshdr.additional_length > 3) &&
499 (scmd->sense_buffer[8] == 0x4) &&
500 (scmd->sense_buffer[11] & 0xe0))
501 return SUCCESS;
502 }
503
504 switch (sshdr.sense_key) {
505 case NO_SENSE:
506 return SUCCESS;
507 case RECOVERED_ERROR:
508 return /* soft_error */ SUCCESS;
509
510 case ABORTED_COMMAND:
511 if (sshdr.asc == 0x10) /* DIF */
512 return SUCCESS;
513
514 return NEEDS_RETRY;
515 case NOT_READY:
516 case UNIT_ATTENTION:
517 /*
518 * if we are expecting a cc/ua because of a bus reset that we
519 * performed, treat this just as a retry. otherwise this is
520 * information that we should pass up to the upper-level driver
521 * so that we can deal with it there.
522 */
523 if (scmd->device->expecting_cc_ua) {
524 /*
525 * Because some device does not queue unit
526 * attentions correctly, we carefully check
527 * additional sense code and qualifier so as
528 * not to squash media change unit attention.
529 */
530 if (sshdr.asc != 0x28 || sshdr.ascq != 0x00) {
531 scmd->device->expecting_cc_ua = 0;
532 return NEEDS_RETRY;
533 }
534 }
535 /*
536 * we might also expect a cc/ua if another LUN on the target
537 * reported a UA with an ASC/ASCQ of 3F 0E -
538 * REPORTED LUNS DATA HAS CHANGED.
539 */
540 if (scmd->device->sdev_target->expecting_lun_change &&
541 sshdr.asc == 0x3f && sshdr.ascq == 0x0e)
542 return NEEDS_RETRY;
543 /*
544 * if the device is in the process of becoming ready, we
545 * should retry.
546 */
547 if ((sshdr.asc == 0x04) && (sshdr.ascq == 0x01))
548 return NEEDS_RETRY;
549 /*
550 * if the device is not started, we need to wake
551 * the error handler to start the motor
552 */
553 if (scmd->device->allow_restart &&
554 (sshdr.asc == 0x04) && (sshdr.ascq == 0x02))
555 return FAILED;
556 /*
557 * Pass the UA upwards for a determination in the completion
558 * functions.
559 */
560 return SUCCESS;
561
562 /* these are not supported */
563 case DATA_PROTECT:
564 if (sshdr.asc == 0x27 && sshdr.ascq == 0x07) {
565 /* Thin provisioning hard threshold reached */
566 set_host_byte(scmd, DID_ALLOC_FAILURE);
567 return SUCCESS;
568 }
569 case COPY_ABORTED:
570 case VOLUME_OVERFLOW:
571 case MISCOMPARE:
572 case BLANK_CHECK:
573 set_host_byte(scmd, DID_TARGET_FAILURE);
574 return SUCCESS;
575
576 case MEDIUM_ERROR:
577 if (sshdr.asc == 0x11 || /* UNRECOVERED READ ERR */
578 sshdr.asc == 0x13 || /* AMNF DATA FIELD */
579 sshdr.asc == 0x14) { /* RECORD NOT FOUND */
580 set_host_byte(scmd, DID_MEDIUM_ERROR);
581 return SUCCESS;
582 }
583 return NEEDS_RETRY;
584
585 case HARDWARE_ERROR:
586 if (scmd->device->retry_hwerror)
587 return ADD_TO_MLQUEUE;
588 else
589 set_host_byte(scmd, DID_TARGET_FAILURE);
590
591 case ILLEGAL_REQUEST:
592 if (sshdr.asc == 0x20 || /* Invalid command operation code */
593 sshdr.asc == 0x21 || /* Logical block address out of range */
594 sshdr.asc == 0x24 || /* Invalid field in cdb */
595 sshdr.asc == 0x26) { /* Parameter value invalid */
596 set_host_byte(scmd, DID_TARGET_FAILURE);
597 }
598 return SUCCESS;
599
600 default:
601 return SUCCESS;
602 }
603}
604
605static void scsi_handle_queue_ramp_up(struct scsi_device *sdev)
606{
607 struct scsi_host_template *sht = sdev->host->hostt;
608 struct scsi_device *tmp_sdev;
609
610 if (!sht->change_queue_depth ||
611 sdev->queue_depth >= sdev->max_queue_depth)
612 return;
613
614 if (time_before(jiffies,
615 sdev->last_queue_ramp_up + sdev->queue_ramp_up_period))
616 return;
617
618 if (time_before(jiffies,
619 sdev->last_queue_full_time + sdev->queue_ramp_up_period))
620 return;
621
622 /*
623 * Walk all devices of a target and do
624 * ramp up on them.
625 */
626 shost_for_each_device(tmp_sdev, sdev->host) {
627 if (tmp_sdev->channel != sdev->channel ||
628 tmp_sdev->id != sdev->id ||
629 tmp_sdev->queue_depth == sdev->max_queue_depth)
630 continue;
631 /*
632 * call back into LLD to increase queue_depth by one
633 * with ramp up reason code.
634 */
635 sht->change_queue_depth(tmp_sdev, tmp_sdev->queue_depth + 1,
636 SCSI_QDEPTH_RAMP_UP);
637 sdev->last_queue_ramp_up = jiffies;
638 }
639}
640
641static void scsi_handle_queue_full(struct scsi_device *sdev)
642{
643 struct scsi_host_template *sht = sdev->host->hostt;
644 struct scsi_device *tmp_sdev;
645
646 if (!sht->change_queue_depth)
647 return;
648
649 shost_for_each_device(tmp_sdev, sdev->host) {
650 if (tmp_sdev->channel != sdev->channel ||
651 tmp_sdev->id != sdev->id)
652 continue;
653 /*
654 * We do not know the number of commands that were at
655 * the device when we got the queue full so we start
656 * from the highest possible value and work our way down.
657 */
658 sht->change_queue_depth(tmp_sdev, tmp_sdev->queue_depth - 1,
659 SCSI_QDEPTH_QFULL);
660 }
661}
662
663/**
664 * scsi_eh_completed_normally - Disposition a eh cmd on return from LLD.
665 * @scmd: SCSI cmd to examine.
666 *
667 * Notes:
668 * This is *only* called when we are examining the status of commands
669 * queued during error recovery. the main difference here is that we
670 * don't allow for the possibility of retries here, and we are a lot
671 * more restrictive about what we consider acceptable.
672 */
673static int scsi_eh_completed_normally(struct scsi_cmnd *scmd)
674{
675 /*
676 * first check the host byte, to see if there is anything in there
677 * that would indicate what we need to do.
678 */
679 if (host_byte(scmd->result) == DID_RESET) {
680 /*
681 * rats. we are already in the error handler, so we now
682 * get to try and figure out what to do next. if the sense
683 * is valid, we have a pretty good idea of what to do.
684 * if not, we mark it as FAILED.
685 */
686 return scsi_check_sense(scmd);
687 }
688 if (host_byte(scmd->result) != DID_OK)
689 return FAILED;
690
691 /*
692 * next, check the message byte.
693 */
694 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
695 return FAILED;
696
697 /*
698 * now, check the status byte to see if this indicates
699 * anything special.
700 */
701 switch (status_byte(scmd->result)) {
702 case GOOD:
703 scsi_handle_queue_ramp_up(scmd->device);
704 case COMMAND_TERMINATED:
705 return SUCCESS;
706 case CHECK_CONDITION:
707 return scsi_check_sense(scmd);
708 case CONDITION_GOOD:
709 case INTERMEDIATE_GOOD:
710 case INTERMEDIATE_C_GOOD:
711 /*
712 * who knows? FIXME(eric)
713 */
714 return SUCCESS;
715 case RESERVATION_CONFLICT:
716 if (scmd->cmnd[0] == TEST_UNIT_READY)
717 /* it is a success, we probed the device and
718 * found it */
719 return SUCCESS;
720 /* otherwise, we failed to send the command */
721 return FAILED;
722 case QUEUE_FULL:
723 scsi_handle_queue_full(scmd->device);
724 /* fall through */
725 case BUSY:
726 return NEEDS_RETRY;
727 default:
728 return FAILED;
729 }
730 return FAILED;
731}
732
733/**
734 * scsi_eh_done - Completion function for error handling.
735 * @scmd: Cmd that is done.
736 */
737static void scsi_eh_done(struct scsi_cmnd *scmd)
738{
739 struct completion *eh_action;
740
741 SCSI_LOG_ERROR_RECOVERY(3,
742 printk("%s scmd: %p result: %x\n",
743 __func__, scmd, scmd->result));
744
745 eh_action = scmd->device->host->eh_action;
746 if (eh_action)
747 complete(eh_action);
748}
749
750/**
751 * scsi_try_host_reset - ask host adapter to reset itself
752 * @scmd: SCSI cmd to send host reset.
753 */
754static int scsi_try_host_reset(struct scsi_cmnd *scmd)
755{
756 unsigned long flags;
757 int rtn;
758 struct Scsi_Host *host = scmd->device->host;
759 struct scsi_host_template *hostt = host->hostt;
760
761 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Snd Host RST\n",
762 __func__));
763
764 if (!hostt->eh_host_reset_handler)
765 return FAILED;
766
767 rtn = hostt->eh_host_reset_handler(scmd);
768
769 if (rtn == SUCCESS) {
770 if (!hostt->skip_settle_delay)
771 ssleep(HOST_RESET_SETTLE_TIME);
772 spin_lock_irqsave(host->host_lock, flags);
773 scsi_report_bus_reset(host, scmd_channel(scmd));
774 spin_unlock_irqrestore(host->host_lock, flags);
775 }
776
777 return rtn;
778}
779
780/**
781 * scsi_try_bus_reset - ask host to perform a bus reset
782 * @scmd: SCSI cmd to send bus reset.
783 */
784static int scsi_try_bus_reset(struct scsi_cmnd *scmd)
785{
786 unsigned long flags;
787 int rtn;
788 struct Scsi_Host *host = scmd->device->host;
789 struct scsi_host_template *hostt = host->hostt;
790
791 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Snd Bus RST\n",
792 __func__));
793
794 if (!hostt->eh_bus_reset_handler)
795 return FAILED;
796
797 rtn = hostt->eh_bus_reset_handler(scmd);
798
799 if (rtn == SUCCESS) {
800 if (!hostt->skip_settle_delay)
801 ssleep(BUS_RESET_SETTLE_TIME);
802 spin_lock_irqsave(host->host_lock, flags);
803 scsi_report_bus_reset(host, scmd_channel(scmd));
804 spin_unlock_irqrestore(host->host_lock, flags);
805 }
806
807 return rtn;
808}
809
810static void __scsi_report_device_reset(struct scsi_device *sdev, void *data)
811{
812 sdev->was_reset = 1;
813 sdev->expecting_cc_ua = 1;
814}
815
816/**
817 * scsi_try_target_reset - Ask host to perform a target reset
818 * @scmd: SCSI cmd used to send a target reset
819 *
820 * Notes:
821 * There is no timeout for this operation. if this operation is
822 * unreliable for a given host, then the host itself needs to put a
823 * timer on it, and set the host back to a consistent state prior to
824 * returning.
825 */
826static int scsi_try_target_reset(struct scsi_cmnd *scmd)
827{
828 unsigned long flags;
829 int rtn;
830 struct Scsi_Host *host = scmd->device->host;
831 struct scsi_host_template *hostt = host->hostt;
832
833 if (!hostt->eh_target_reset_handler)
834 return FAILED;
835
836 rtn = hostt->eh_target_reset_handler(scmd);
837 if (rtn == SUCCESS) {
838 spin_lock_irqsave(host->host_lock, flags);
839 __starget_for_each_device(scsi_target(scmd->device), NULL,
840 __scsi_report_device_reset);
841 spin_unlock_irqrestore(host->host_lock, flags);
842 }
843
844 return rtn;
845}
846
847/**
848 * scsi_try_bus_device_reset - Ask host to perform a BDR on a dev
849 * @scmd: SCSI cmd used to send BDR
850 *
851 * Notes:
852 * There is no timeout for this operation. if this operation is
853 * unreliable for a given host, then the host itself needs to put a
854 * timer on it, and set the host back to a consistent state prior to
855 * returning.
856 */
857static int scsi_try_bus_device_reset(struct scsi_cmnd *scmd)
858{
859 int rtn;
860 struct scsi_host_template *hostt = scmd->device->host->hostt;
861
862 if (!hostt->eh_device_reset_handler)
863 return FAILED;
864
865 rtn = hostt->eh_device_reset_handler(scmd);
866 if (rtn == SUCCESS)
867 __scsi_report_device_reset(scmd->device, NULL);
868 return rtn;
869}
870
871static int scsi_try_to_abort_cmd(struct scsi_host_template *hostt, struct scsi_cmnd *scmd)
872{
873 if (!hostt->eh_abort_handler)
874 return FAILED;
875
876 return hostt->eh_abort_handler(scmd);
877}
878
879static void scsi_abort_eh_cmnd(struct scsi_cmnd *scmd)
880{
881 if (scsi_try_to_abort_cmd(scmd->device->host->hostt, scmd) != SUCCESS)
882 if (scsi_try_bus_device_reset(scmd) != SUCCESS)
883 if (scsi_try_target_reset(scmd) != SUCCESS)
884 if (scsi_try_bus_reset(scmd) != SUCCESS)
885 scsi_try_host_reset(scmd);
886}
887
888/**
889 * scsi_eh_prep_cmnd - Save a scsi command info as part of error recovery
890 * @scmd: SCSI command structure to hijack
891 * @ses: structure to save restore information
892 * @cmnd: CDB to send. Can be NULL if no new cmnd is needed
893 * @cmnd_size: size in bytes of @cmnd (must be <= BLK_MAX_CDB)
894 * @sense_bytes: size of sense data to copy. or 0 (if != 0 @cmnd is ignored)
895 *
896 * This function is used to save a scsi command information before re-execution
897 * as part of the error recovery process. If @sense_bytes is 0 the command
898 * sent must be one that does not transfer any data. If @sense_bytes != 0
899 * @cmnd is ignored and this functions sets up a REQUEST_SENSE command
900 * and cmnd buffers to read @sense_bytes into @scmd->sense_buffer.
901 */
902void scsi_eh_prep_cmnd(struct scsi_cmnd *scmd, struct scsi_eh_save *ses,
903 unsigned char *cmnd, int cmnd_size, unsigned sense_bytes)
904{
905 struct scsi_device *sdev = scmd->device;
906
907 /*
908 * We need saved copies of a number of fields - this is because
909 * error handling may need to overwrite these with different values
910 * to run different commands, and once error handling is complete,
911 * we will need to restore these values prior to running the actual
912 * command.
913 */
914 ses->cmd_len = scmd->cmd_len;
915 ses->cmnd = scmd->cmnd;
916 ses->data_direction = scmd->sc_data_direction;
917 ses->sdb = scmd->sdb;
918 ses->next_rq = scmd->request->next_rq;
919 ses->result = scmd->result;
920 ses->underflow = scmd->underflow;
921 ses->prot_op = scmd->prot_op;
922
923 scmd->prot_op = SCSI_PROT_NORMAL;
924 scmd->eh_eflags = 0;
925 scmd->cmnd = ses->eh_cmnd;
926 memset(scmd->cmnd, 0, BLK_MAX_CDB);
927 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
928 scmd->request->next_rq = NULL;
929 scmd->result = 0;
930
931 if (sense_bytes) {
932 scmd->sdb.length = min_t(unsigned, SCSI_SENSE_BUFFERSIZE,
933 sense_bytes);
934 sg_init_one(&ses->sense_sgl, scmd->sense_buffer,
935 scmd->sdb.length);
936 scmd->sdb.table.sgl = &ses->sense_sgl;
937 scmd->sc_data_direction = DMA_FROM_DEVICE;
938 scmd->sdb.table.nents = 1;
939 scmd->cmnd[0] = REQUEST_SENSE;
940 scmd->cmnd[4] = scmd->sdb.length;
941 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
942 } else {
943 scmd->sc_data_direction = DMA_NONE;
944 if (cmnd) {
945 BUG_ON(cmnd_size > BLK_MAX_CDB);
946 memcpy(scmd->cmnd, cmnd, cmnd_size);
947 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
948 }
949 }
950
951 scmd->underflow = 0;
952
953 if (sdev->scsi_level <= SCSI_2 && sdev->scsi_level != SCSI_UNKNOWN)
954 scmd->cmnd[1] = (scmd->cmnd[1] & 0x1f) |
955 (sdev->lun << 5 & 0xe0);
956
957 /*
958 * Zero the sense buffer. The scsi spec mandates that any
959 * untransferred sense data should be interpreted as being zero.
960 */
961 memset(scmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
962}
963EXPORT_SYMBOL(scsi_eh_prep_cmnd);
964
965/**
966 * scsi_eh_restore_cmnd - Restore a scsi command info as part of error recovery
967 * @scmd: SCSI command structure to restore
968 * @ses: saved information from a coresponding call to scsi_eh_prep_cmnd
969 *
970 * Undo any damage done by above scsi_eh_prep_cmnd().
971 */
972void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd, struct scsi_eh_save *ses)
973{
974 /*
975 * Restore original data
976 */
977 scmd->cmd_len = ses->cmd_len;
978 scmd->cmnd = ses->cmnd;
979 scmd->sc_data_direction = ses->data_direction;
980 scmd->sdb = ses->sdb;
981 scmd->request->next_rq = ses->next_rq;
982 scmd->result = ses->result;
983 scmd->underflow = ses->underflow;
984 scmd->prot_op = ses->prot_op;
985}
986EXPORT_SYMBOL(scsi_eh_restore_cmnd);
987
988/**
989 * scsi_send_eh_cmnd - submit a scsi command as part of error recovery
990 * @scmd: SCSI command structure to hijack
991 * @cmnd: CDB to send
992 * @cmnd_size: size in bytes of @cmnd
993 * @timeout: timeout for this request
994 * @sense_bytes: size of sense data to copy or 0
995 *
996 * This function is used to send a scsi command down to a target device
997 * as part of the error recovery process. See also scsi_eh_prep_cmnd() above.
998 *
999 * Return value:
1000 * SUCCESS or FAILED or NEEDS_RETRY
1001 */
1002static int scsi_send_eh_cmnd(struct scsi_cmnd *scmd, unsigned char *cmnd,
1003 int cmnd_size, int timeout, unsigned sense_bytes)
1004{
1005 struct scsi_device *sdev = scmd->device;
1006 struct Scsi_Host *shost = sdev->host;
1007 DECLARE_COMPLETION_ONSTACK(done);
1008 unsigned long timeleft = timeout;
1009 struct scsi_eh_save ses;
1010 const unsigned long stall_for = msecs_to_jiffies(100);
1011 int rtn;
1012
1013retry:
1014 scsi_eh_prep_cmnd(scmd, &ses, cmnd, cmnd_size, sense_bytes);
1015 shost->eh_action = &done;
1016
1017 scsi_log_send(scmd);
1018 scmd->scsi_done = scsi_eh_done;
1019 rtn = shost->hostt->queuecommand(shost, scmd);
1020 if (rtn) {
1021 if (timeleft > stall_for) {
1022 scsi_eh_restore_cmnd(scmd, &ses);
1023 timeleft -= stall_for;
1024 msleep(jiffies_to_msecs(stall_for));
1025 goto retry;
1026 }
1027 /* signal not to enter either branch of the if () below */
1028 timeleft = 0;
1029 rtn = NEEDS_RETRY;
1030 } else {
1031 timeleft = wait_for_completion_timeout(&done, timeout);
1032 }
1033
1034 shost->eh_action = NULL;
1035
1036 scsi_log_completion(scmd, rtn);
1037
1038 SCSI_LOG_ERROR_RECOVERY(3,
1039 printk("%s: scmd: %p, timeleft: %ld\n",
1040 __func__, scmd, timeleft));
1041
1042 /*
1043 * If there is time left scsi_eh_done got called, and we will examine
1044 * the actual status codes to see whether the command actually did
1045 * complete normally, else if we have a zero return and no time left,
1046 * the command must still be pending, so abort it and return FAILED.
1047 * If we never actually managed to issue the command, because
1048 * ->queuecommand() kept returning non zero, use the rtn = FAILED
1049 * value above (so don't execute either branch of the if)
1050 */
1051 if (timeleft) {
1052 rtn = scsi_eh_completed_normally(scmd);
1053 SCSI_LOG_ERROR_RECOVERY(3,
1054 printk("%s: scsi_eh_completed_normally %x\n",
1055 __func__, rtn));
1056
1057 switch (rtn) {
1058 case SUCCESS:
1059 case NEEDS_RETRY:
1060 case FAILED:
1061 break;
1062 case ADD_TO_MLQUEUE:
1063 rtn = NEEDS_RETRY;
1064 break;
1065 default:
1066 rtn = FAILED;
1067 break;
1068 }
1069 } else if (!rtn) {
1070 scsi_abort_eh_cmnd(scmd);
1071 rtn = FAILED;
1072 }
1073
1074 scsi_eh_restore_cmnd(scmd, &ses);
1075
1076 return rtn;
1077}
1078
1079/**
1080 * scsi_request_sense - Request sense data from a particular target.
1081 * @scmd: SCSI cmd for request sense.
1082 *
1083 * Notes:
1084 * Some hosts automatically obtain this information, others require
1085 * that we obtain it on our own. This function will *not* return until
1086 * the command either times out, or it completes.
1087 */
1088static int scsi_request_sense(struct scsi_cmnd *scmd)
1089{
1090 return scsi_send_eh_cmnd(scmd, NULL, 0, scmd->device->eh_timeout, ~0);
1091}
1092
1093static int scsi_eh_action(struct scsi_cmnd *scmd, int rtn)
1094{
1095 if (scmd->request->cmd_type != REQ_TYPE_BLOCK_PC) {
1096 struct scsi_driver *sdrv = scsi_cmd_to_driver(scmd);
1097 if (sdrv->eh_action)
1098 rtn = sdrv->eh_action(scmd, rtn);
1099 }
1100 return rtn;
1101}
1102
1103/**
1104 * scsi_eh_finish_cmd - Handle a cmd that eh is finished with.
1105 * @scmd: Original SCSI cmd that eh has finished.
1106 * @done_q: Queue for processed commands.
1107 *
1108 * Notes:
1109 * We don't want to use the normal command completion while we are are
1110 * still handling errors - it may cause other commands to be queued,
1111 * and that would disturb what we are doing. Thus we really want to
1112 * keep a list of pending commands for final completion, and once we
1113 * are ready to leave error handling we handle completion for real.
1114 */
1115void scsi_eh_finish_cmd(struct scsi_cmnd *scmd, struct list_head *done_q)
1116{
1117 scmd->device->host->host_failed--;
1118 scmd->eh_eflags = 0;
1119 list_move_tail(&scmd->eh_entry, done_q);
1120}
1121EXPORT_SYMBOL(scsi_eh_finish_cmd);
1122
1123/**
1124 * scsi_eh_get_sense - Get device sense data.
1125 * @work_q: Queue of commands to process.
1126 * @done_q: Queue of processed commands.
1127 *
1128 * Description:
1129 * See if we need to request sense information. if so, then get it
1130 * now, so we have a better idea of what to do.
1131 *
1132 * Notes:
1133 * This has the unfortunate side effect that if a shost adapter does
1134 * not automatically request sense information, we end up shutting
1135 * it down before we request it.
1136 *
1137 * All drivers should request sense information internally these days,
1138 * so for now all I have to say is tough noogies if you end up in here.
1139 *
1140 * XXX: Long term this code should go away, but that needs an audit of
1141 * all LLDDs first.
1142 */
1143int scsi_eh_get_sense(struct list_head *work_q,
1144 struct list_head *done_q)
1145{
1146 struct scsi_cmnd *scmd, *next;
1147 struct Scsi_Host *shost;
1148 int rtn;
1149
1150 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1151 if ((scmd->eh_eflags & SCSI_EH_CANCEL_CMD) ||
1152 SCSI_SENSE_VALID(scmd))
1153 continue;
1154
1155 shost = scmd->device->host;
1156 if (scsi_host_eh_past_deadline(shost)) {
1157 SCSI_LOG_ERROR_RECOVERY(3,
1158 shost_printk(KERN_INFO, shost,
1159 "skip %s, past eh deadline\n",
1160 __func__));
1161 break;
1162 }
1163 if (status_byte(scmd->result) != CHECK_CONDITION)
1164 /*
1165 * don't request sense if there's no check condition
1166 * status because the error we're processing isn't one
1167 * that has a sense code (and some devices get
1168 * confused by sense requests out of the blue)
1169 */
1170 continue;
1171
1172 SCSI_LOG_ERROR_RECOVERY(2, scmd_printk(KERN_INFO, scmd,
1173 "%s: requesting sense\n",
1174 current->comm));
1175 rtn = scsi_request_sense(scmd);
1176 if (rtn != SUCCESS)
1177 continue;
1178
1179 SCSI_LOG_ERROR_RECOVERY(3, printk("sense requested for %p"
1180 " result %x\n", scmd,
1181 scmd->result));
1182 SCSI_LOG_ERROR_RECOVERY(3, scsi_print_sense("bh", scmd));
1183
1184 rtn = scsi_decide_disposition(scmd);
1185
1186 /*
1187 * if the result was normal, then just pass it along to the
1188 * upper level.
1189 */
1190 if (rtn == SUCCESS)
1191 /* we don't want this command reissued, just
1192 * finished with the sense data, so set
1193 * retries to the max allowed to ensure it
1194 * won't get reissued */
1195 scmd->retries = scmd->allowed;
1196 else if (rtn != NEEDS_RETRY)
1197 continue;
1198
1199 scsi_eh_finish_cmd(scmd, done_q);
1200 }
1201
1202 return list_empty(work_q);
1203}
1204EXPORT_SYMBOL_GPL(scsi_eh_get_sense);
1205
1206/**
1207 * scsi_eh_tur - Send TUR to device.
1208 * @scmd: &scsi_cmnd to send TUR
1209 *
1210 * Return value:
1211 * 0 - Device is ready. 1 - Device NOT ready.
1212 */
1213static int scsi_eh_tur(struct scsi_cmnd *scmd)
1214{
1215 static unsigned char tur_command[6] = {TEST_UNIT_READY, 0, 0, 0, 0, 0};
1216 int retry_cnt = 1, rtn;
1217
1218retry_tur:
1219 rtn = scsi_send_eh_cmnd(scmd, tur_command, 6,
1220 scmd->device->eh_timeout, 0);
1221
1222 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: scmd %p rtn %x\n",
1223 __func__, scmd, rtn));
1224
1225 switch (rtn) {
1226 case NEEDS_RETRY:
1227 if (retry_cnt--)
1228 goto retry_tur;
1229 /*FALLTHRU*/
1230 case SUCCESS:
1231 return 0;
1232 default:
1233 return 1;
1234 }
1235}
1236
1237/**
1238 * scsi_eh_test_devices - check if devices are responding from error recovery.
1239 * @cmd_list: scsi commands in error recovery.
1240 * @work_q: queue for commands which still need more error recovery
1241 * @done_q: queue for commands which are finished
1242 * @try_stu: boolean on if a STU command should be tried in addition to TUR.
1243 *
1244 * Decription:
1245 * Tests if devices are in a working state. Commands to devices now in
1246 * a working state are sent to the done_q while commands to devices which
1247 * are still failing to respond are returned to the work_q for more
1248 * processing.
1249 **/
1250static int scsi_eh_test_devices(struct list_head *cmd_list,
1251 struct list_head *work_q,
1252 struct list_head *done_q, int try_stu)
1253{
1254 struct scsi_cmnd *scmd, *next;
1255 struct scsi_device *sdev;
1256 int finish_cmds;
1257
1258 while (!list_empty(cmd_list)) {
1259 scmd = list_entry(cmd_list->next, struct scsi_cmnd, eh_entry);
1260 sdev = scmd->device;
1261
1262 if (!try_stu) {
1263 if (scsi_host_eh_past_deadline(sdev->host)) {
1264 /* Push items back onto work_q */
1265 list_splice_init(cmd_list, work_q);
1266 SCSI_LOG_ERROR_RECOVERY(3,
1267 shost_printk(KERN_INFO, sdev->host,
1268 "skip %s, past eh deadline",
1269 __func__));
1270 break;
1271 }
1272 }
1273
1274 finish_cmds = !scsi_device_online(scmd->device) ||
1275 (try_stu && !scsi_eh_try_stu(scmd) &&
1276 !scsi_eh_tur(scmd)) ||
1277 !scsi_eh_tur(scmd);
1278
1279 list_for_each_entry_safe(scmd, next, cmd_list, eh_entry)
1280 if (scmd->device == sdev) {
1281 if (finish_cmds &&
1282 (try_stu ||
1283 scsi_eh_action(scmd, SUCCESS) == SUCCESS))
1284 scsi_eh_finish_cmd(scmd, done_q);
1285 else
1286 list_move_tail(&scmd->eh_entry, work_q);
1287 }
1288 }
1289 return list_empty(work_q);
1290}
1291
1292
1293/**
1294 * scsi_eh_abort_cmds - abort pending commands.
1295 * @work_q: &list_head for pending commands.
1296 * @done_q: &list_head for processed commands.
1297 *
1298 * Decription:
1299 * Try and see whether or not it makes sense to try and abort the
1300 * running command. This only works out to be the case if we have one
1301 * command that has timed out. If the command simply failed, it makes
1302 * no sense to try and abort the command, since as far as the shost
1303 * adapter is concerned, it isn't running.
1304 */
1305static int scsi_eh_abort_cmds(struct list_head *work_q,
1306 struct list_head *done_q)
1307{
1308 struct scsi_cmnd *scmd, *next;
1309 LIST_HEAD(check_list);
1310 int rtn;
1311 struct Scsi_Host *shost;
1312
1313 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1314 if (!(scmd->eh_eflags & SCSI_EH_CANCEL_CMD))
1315 continue;
1316 shost = scmd->device->host;
1317 if (scsi_host_eh_past_deadline(shost)) {
1318 list_splice_init(&check_list, work_q);
1319 SCSI_LOG_ERROR_RECOVERY(3,
1320 shost_printk(KERN_INFO, shost,
1321 "skip %s, past eh deadline\n",
1322 __func__));
1323 return list_empty(work_q);
1324 }
1325 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: aborting cmd:"
1326 "0x%p\n", current->comm,
1327 scmd));
1328 rtn = scsi_try_to_abort_cmd(shost->hostt, scmd);
1329 if (rtn == FAILED) {
1330 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: aborting"
1331 " cmd failed:"
1332 "0x%p\n",
1333 current->comm,
1334 scmd));
1335 list_splice_init(&check_list, work_q);
1336 return list_empty(work_q);
1337 }
1338 scmd->eh_eflags &= ~SCSI_EH_CANCEL_CMD;
1339 if (rtn == FAST_IO_FAIL)
1340 scsi_eh_finish_cmd(scmd, done_q);
1341 else
1342 list_move_tail(&scmd->eh_entry, &check_list);
1343 }
1344
1345 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1346}
1347
1348/**
1349 * scsi_eh_try_stu - Send START_UNIT to device.
1350 * @scmd: &scsi_cmnd to send START_UNIT
1351 *
1352 * Return value:
1353 * 0 - Device is ready. 1 - Device NOT ready.
1354 */
1355static int scsi_eh_try_stu(struct scsi_cmnd *scmd)
1356{
1357 static unsigned char stu_command[6] = {START_STOP, 0, 0, 0, 1, 0};
1358
1359 if (scmd->device->allow_restart) {
1360 int i, rtn = NEEDS_RETRY;
1361
1362 for (i = 0; rtn == NEEDS_RETRY && i < 2; i++)
1363 rtn = scsi_send_eh_cmnd(scmd, stu_command, 6, scmd->device->request_queue->rq_timeout, 0);
1364
1365 if (rtn == SUCCESS)
1366 return 0;
1367 }
1368
1369 return 1;
1370}
1371
1372 /**
1373 * scsi_eh_stu - send START_UNIT if needed
1374 * @shost: &scsi host being recovered.
1375 * @work_q: &list_head for pending commands.
1376 * @done_q: &list_head for processed commands.
1377 *
1378 * Notes:
1379 * If commands are failing due to not ready, initializing command required,
1380 * try revalidating the device, which will end up sending a start unit.
1381 */
1382static int scsi_eh_stu(struct Scsi_Host *shost,
1383 struct list_head *work_q,
1384 struct list_head *done_q)
1385{
1386 struct scsi_cmnd *scmd, *stu_scmd, *next;
1387 struct scsi_device *sdev;
1388
1389 shost_for_each_device(sdev, shost) {
1390 if (scsi_host_eh_past_deadline(shost)) {
1391 SCSI_LOG_ERROR_RECOVERY(3,
1392 shost_printk(KERN_INFO, shost,
1393 "skip %s, past eh deadline\n",
1394 __func__));
1395 break;
1396 }
1397 stu_scmd = NULL;
1398 list_for_each_entry(scmd, work_q, eh_entry)
1399 if (scmd->device == sdev && SCSI_SENSE_VALID(scmd) &&
1400 scsi_check_sense(scmd) == FAILED ) {
1401 stu_scmd = scmd;
1402 break;
1403 }
1404
1405 if (!stu_scmd)
1406 continue;
1407
1408 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending START_UNIT to sdev:"
1409 " 0x%p\n", current->comm, sdev));
1410
1411 if (!scsi_eh_try_stu(stu_scmd)) {
1412 if (!scsi_device_online(sdev) ||
1413 !scsi_eh_tur(stu_scmd)) {
1414 list_for_each_entry_safe(scmd, next,
1415 work_q, eh_entry) {
1416 if (scmd->device == sdev &&
1417 scsi_eh_action(scmd, SUCCESS) == SUCCESS)
1418 scsi_eh_finish_cmd(scmd, done_q);
1419 }
1420 }
1421 } else {
1422 SCSI_LOG_ERROR_RECOVERY(3,
1423 printk("%s: START_UNIT failed to sdev:"
1424 " 0x%p\n", current->comm, sdev));
1425 }
1426 }
1427
1428 return list_empty(work_q);
1429}
1430
1431
1432/**
1433 * scsi_eh_bus_device_reset - send bdr if needed
1434 * @shost: scsi host being recovered.
1435 * @work_q: &list_head for pending commands.
1436 * @done_q: &list_head for processed commands.
1437 *
1438 * Notes:
1439 * Try a bus device reset. Still, look to see whether we have multiple
1440 * devices that are jammed or not - if we have multiple devices, it
1441 * makes no sense to try bus_device_reset - we really would need to try
1442 * a bus_reset instead.
1443 */
1444static int scsi_eh_bus_device_reset(struct Scsi_Host *shost,
1445 struct list_head *work_q,
1446 struct list_head *done_q)
1447{
1448 struct scsi_cmnd *scmd, *bdr_scmd, *next;
1449 struct scsi_device *sdev;
1450 int rtn;
1451
1452 shost_for_each_device(sdev, shost) {
1453 if (scsi_host_eh_past_deadline(shost)) {
1454 SCSI_LOG_ERROR_RECOVERY(3,
1455 shost_printk(KERN_INFO, shost,
1456 "skip %s, past eh deadline\n",
1457 __func__));
1458 break;
1459 }
1460 bdr_scmd = NULL;
1461 list_for_each_entry(scmd, work_q, eh_entry)
1462 if (scmd->device == sdev) {
1463 bdr_scmd = scmd;
1464 break;
1465 }
1466
1467 if (!bdr_scmd)
1468 continue;
1469
1470 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending BDR sdev:"
1471 " 0x%p\n", current->comm,
1472 sdev));
1473 rtn = scsi_try_bus_device_reset(bdr_scmd);
1474 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
1475 if (!scsi_device_online(sdev) ||
1476 rtn == FAST_IO_FAIL ||
1477 !scsi_eh_tur(bdr_scmd)) {
1478 list_for_each_entry_safe(scmd, next,
1479 work_q, eh_entry) {
1480 if (scmd->device == sdev &&
1481 scsi_eh_action(scmd, rtn) != FAILED)
1482 scsi_eh_finish_cmd(scmd,
1483 done_q);
1484 }
1485 }
1486 } else {
1487 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: BDR"
1488 " failed sdev:"
1489 "0x%p\n",
1490 current->comm,
1491 sdev));
1492 }
1493 }
1494
1495 return list_empty(work_q);
1496}
1497
1498/**
1499 * scsi_eh_target_reset - send target reset if needed
1500 * @shost: scsi host being recovered.
1501 * @work_q: &list_head for pending commands.
1502 * @done_q: &list_head for processed commands.
1503 *
1504 * Notes:
1505 * Try a target reset.
1506 */
1507static int scsi_eh_target_reset(struct Scsi_Host *shost,
1508 struct list_head *work_q,
1509 struct list_head *done_q)
1510{
1511 LIST_HEAD(tmp_list);
1512 LIST_HEAD(check_list);
1513
1514 list_splice_init(work_q, &tmp_list);
1515
1516 while (!list_empty(&tmp_list)) {
1517 struct scsi_cmnd *next, *scmd;
1518 int rtn;
1519 unsigned int id;
1520
1521 if (scsi_host_eh_past_deadline(shost)) {
1522 /* push back on work queue for further processing */
1523 list_splice_init(&check_list, work_q);
1524 list_splice_init(&tmp_list, work_q);
1525 SCSI_LOG_ERROR_RECOVERY(3,
1526 shost_printk(KERN_INFO, shost,
1527 "skip %s, past eh deadline\n",
1528 __func__));
1529 return list_empty(work_q);
1530 }
1531
1532 scmd = list_entry(tmp_list.next, struct scsi_cmnd, eh_entry);
1533 id = scmd_id(scmd);
1534
1535 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending target reset "
1536 "to target %d\n",
1537 current->comm, id));
1538 rtn = scsi_try_target_reset(scmd);
1539 if (rtn != SUCCESS && rtn != FAST_IO_FAIL)
1540 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Target reset"
1541 " failed target: "
1542 "%d\n",
1543 current->comm, id));
1544 list_for_each_entry_safe(scmd, next, &tmp_list, eh_entry) {
1545 if (scmd_id(scmd) != id)
1546 continue;
1547
1548 if (rtn == SUCCESS)
1549 list_move_tail(&scmd->eh_entry, &check_list);
1550 else if (rtn == FAST_IO_FAIL)
1551 scsi_eh_finish_cmd(scmd, done_q);
1552 else
1553 /* push back on work queue for further processing */
1554 list_move(&scmd->eh_entry, work_q);
1555 }
1556 }
1557
1558 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1559}
1560
1561/**
1562 * scsi_eh_bus_reset - send a bus reset
1563 * @shost: &scsi host being recovered.
1564 * @work_q: &list_head for pending commands.
1565 * @done_q: &list_head for processed commands.
1566 */
1567static int scsi_eh_bus_reset(struct Scsi_Host *shost,
1568 struct list_head *work_q,
1569 struct list_head *done_q)
1570{
1571 struct scsi_cmnd *scmd, *chan_scmd, *next;
1572 LIST_HEAD(check_list);
1573 unsigned int channel;
1574 int rtn;
1575
1576 /*
1577 * we really want to loop over the various channels, and do this on
1578 * a channel by channel basis. we should also check to see if any
1579 * of the failed commands are on soft_reset devices, and if so, skip
1580 * the reset.
1581 */
1582
1583 for (channel = 0; channel <= shost->max_channel; channel++) {
1584 if (scsi_host_eh_past_deadline(shost)) {
1585 list_splice_init(&check_list, work_q);
1586 SCSI_LOG_ERROR_RECOVERY(3,
1587 shost_printk(KERN_INFO, shost,
1588 "skip %s, past eh deadline\n",
1589 __func__));
1590 return list_empty(work_q);
1591 }
1592
1593 chan_scmd = NULL;
1594 list_for_each_entry(scmd, work_q, eh_entry) {
1595 if (channel == scmd_channel(scmd)) {
1596 chan_scmd = scmd;
1597 break;
1598 /*
1599 * FIXME add back in some support for
1600 * soft_reset devices.
1601 */
1602 }
1603 }
1604
1605 if (!chan_scmd)
1606 continue;
1607 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending BRST chan:"
1608 " %d\n", current->comm,
1609 channel));
1610 rtn = scsi_try_bus_reset(chan_scmd);
1611 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
1612 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1613 if (channel == scmd_channel(scmd)) {
1614 if (rtn == FAST_IO_FAIL)
1615 scsi_eh_finish_cmd(scmd,
1616 done_q);
1617 else
1618 list_move_tail(&scmd->eh_entry,
1619 &check_list);
1620 }
1621 }
1622 } else {
1623 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: BRST"
1624 " failed chan: %d\n",
1625 current->comm,
1626 channel));
1627 }
1628 }
1629 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1630}
1631
1632/**
1633 * scsi_eh_host_reset - send a host reset
1634 * @work_q: list_head for processed commands.
1635 * @done_q: list_head for processed commands.
1636 */
1637static int scsi_eh_host_reset(struct list_head *work_q,
1638 struct list_head *done_q)
1639{
1640 struct scsi_cmnd *scmd, *next;
1641 LIST_HEAD(check_list);
1642 int rtn;
1643
1644 if (!list_empty(work_q)) {
1645 scmd = list_entry(work_q->next,
1646 struct scsi_cmnd, eh_entry);
1647
1648 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending HRST\n"
1649 , current->comm));
1650
1651 rtn = scsi_try_host_reset(scmd);
1652 if (rtn == SUCCESS) {
1653 list_splice_init(work_q, &check_list);
1654 } else if (rtn == FAST_IO_FAIL) {
1655 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1656 scsi_eh_finish_cmd(scmd, done_q);
1657 }
1658 } else {
1659 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: HRST"
1660 " failed\n",
1661 current->comm));
1662 }
1663 }
1664 return scsi_eh_test_devices(&check_list, work_q, done_q, 1);
1665}
1666
1667/**
1668 * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
1669 * @work_q: list_head for processed commands.
1670 * @done_q: list_head for processed commands.
1671 */
1672static void scsi_eh_offline_sdevs(struct list_head *work_q,
1673 struct list_head *done_q)
1674{
1675 struct scsi_cmnd *scmd, *next;
1676
1677 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1678 sdev_printk(KERN_INFO, scmd->device, "Device offlined - "
1679 "not ready after error recovery\n");
1680 scsi_device_set_state(scmd->device, SDEV_OFFLINE);
1681 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD) {
1682 /*
1683 * FIXME: Handle lost cmds.
1684 */
1685 }
1686 scsi_eh_finish_cmd(scmd, done_q);
1687 }
1688 return;
1689}
1690
1691/**
1692 * scsi_noretry_cmd - determine if command should be failed fast
1693 * @scmd: SCSI cmd to examine.
1694 */
1695int scsi_noretry_cmd(struct scsi_cmnd *scmd)
1696{
1697 switch (host_byte(scmd->result)) {
1698 case DID_OK:
1699 break;
1700 case DID_TIME_OUT:
1701 goto check_type;
1702 case DID_BUS_BUSY:
1703 return (scmd->request->cmd_flags & REQ_FAILFAST_TRANSPORT);
1704 case DID_PARITY:
1705 return (scmd->request->cmd_flags & REQ_FAILFAST_DEV);
1706 case DID_ERROR:
1707 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1708 status_byte(scmd->result) == RESERVATION_CONFLICT)
1709 return 0;
1710 /* fall through */
1711 case DID_SOFT_ERROR:
1712 return (scmd->request->cmd_flags & REQ_FAILFAST_DRIVER);
1713 }
1714
1715 if (status_byte(scmd->result) != CHECK_CONDITION)
1716 return 0;
1717
1718check_type:
1719 /*
1720 * assume caller has checked sense and determined
1721 * the check condition was retryable.
1722 */
1723 if (scmd->request->cmd_flags & REQ_FAILFAST_DEV ||
1724 scmd->request->cmd_type == REQ_TYPE_BLOCK_PC)
1725 return 1;
1726 else
1727 return 0;
1728}
1729
1730/**
1731 * scsi_decide_disposition - Disposition a cmd on return from LLD.
1732 * @scmd: SCSI cmd to examine.
1733 *
1734 * Notes:
1735 * This is *only* called when we are examining the status after sending
1736 * out the actual data command. any commands that are queued for error
1737 * recovery (e.g. test_unit_ready) do *not* come through here.
1738 *
1739 * When this routine returns failed, it means the error handler thread
1740 * is woken. In cases where the error code indicates an error that
1741 * doesn't require the error handler read (i.e. we don't need to
1742 * abort/reset), this function should return SUCCESS.
1743 */
1744int scsi_decide_disposition(struct scsi_cmnd *scmd)
1745{
1746 int rtn;
1747
1748 /*
1749 * if the device is offline, then we clearly just pass the result back
1750 * up to the top level.
1751 */
1752 if (!scsi_device_online(scmd->device)) {
1753 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: device offline - report"
1754 " as SUCCESS\n",
1755 __func__));
1756 return SUCCESS;
1757 }
1758
1759 /*
1760 * first check the host byte, to see if there is anything in there
1761 * that would indicate what we need to do.
1762 */
1763 switch (host_byte(scmd->result)) {
1764 case DID_PASSTHROUGH:
1765 /*
1766 * no matter what, pass this through to the upper layer.
1767 * nuke this special code so that it looks like we are saying
1768 * did_ok.
1769 */
1770 scmd->result &= 0xff00ffff;
1771 return SUCCESS;
1772 case DID_OK:
1773 /*
1774 * looks good. drop through, and check the next byte.
1775 */
1776 break;
1777 case DID_ABORT:
1778 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
1779 scmd->result |= DID_TIME_OUT << 16;
1780 return SUCCESS;
1781 }
1782 case DID_NO_CONNECT:
1783 case DID_BAD_TARGET:
1784 /*
1785 * note - this means that we just report the status back
1786 * to the top level driver, not that we actually think
1787 * that it indicates SUCCESS.
1788 */
1789 return SUCCESS;
1790 /*
1791 * when the low level driver returns did_soft_error,
1792 * it is responsible for keeping an internal retry counter
1793 * in order to avoid endless loops (db)
1794 *
1795 * actually this is a bug in this function here. we should
1796 * be mindful of the maximum number of retries specified
1797 * and not get stuck in a loop.
1798 */
1799 case DID_SOFT_ERROR:
1800 goto maybe_retry;
1801 case DID_IMM_RETRY:
1802 return NEEDS_RETRY;
1803
1804 case DID_REQUEUE:
1805 return ADD_TO_MLQUEUE;
1806 case DID_TRANSPORT_DISRUPTED:
1807 /*
1808 * LLD/transport was disrupted during processing of the IO.
1809 * The transport class is now blocked/blocking,
1810 * and the transport will decide what to do with the IO
1811 * based on its timers and recovery capablilities if
1812 * there are enough retries.
1813 */
1814 goto maybe_retry;
1815 case DID_TRANSPORT_FAILFAST:
1816 /*
1817 * The transport decided to failfast the IO (most likely
1818 * the fast io fail tmo fired), so send IO directly upwards.
1819 */
1820 return SUCCESS;
1821 case DID_ERROR:
1822 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1823 status_byte(scmd->result) == RESERVATION_CONFLICT)
1824 /*
1825 * execute reservation conflict processing code
1826 * lower down
1827 */
1828 break;
1829 /* fallthrough */
1830 case DID_BUS_BUSY:
1831 case DID_PARITY:
1832 goto maybe_retry;
1833 case DID_TIME_OUT:
1834 /*
1835 * when we scan the bus, we get timeout messages for
1836 * these commands if there is no device available.
1837 * other hosts report did_no_connect for the same thing.
1838 */
1839 if ((scmd->cmnd[0] == TEST_UNIT_READY ||
1840 scmd->cmnd[0] == INQUIRY)) {
1841 return SUCCESS;
1842 } else {
1843 return FAILED;
1844 }
1845 case DID_RESET:
1846 return SUCCESS;
1847 default:
1848 return FAILED;
1849 }
1850
1851 /*
1852 * next, check the message byte.
1853 */
1854 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
1855 return FAILED;
1856
1857 /*
1858 * check the status byte to see if this indicates anything special.
1859 */
1860 switch (status_byte(scmd->result)) {
1861 case QUEUE_FULL:
1862 scsi_handle_queue_full(scmd->device);
1863 /*
1864 * the case of trying to send too many commands to a
1865 * tagged queueing device.
1866 */
1867 case BUSY:
1868 /*
1869 * device can't talk to us at the moment. Should only
1870 * occur (SAM-3) when the task queue is empty, so will cause
1871 * the empty queue handling to trigger a stall in the
1872 * device.
1873 */
1874 return ADD_TO_MLQUEUE;
1875 case GOOD:
1876 if (scmd->cmnd[0] == REPORT_LUNS)
1877 scmd->device->sdev_target->expecting_lun_change = 0;
1878 scsi_handle_queue_ramp_up(scmd->device);
1879 case COMMAND_TERMINATED:
1880 return SUCCESS;
1881 case TASK_ABORTED:
1882 goto maybe_retry;
1883 case CHECK_CONDITION:
1884 rtn = scsi_check_sense(scmd);
1885 if (rtn == NEEDS_RETRY)
1886 goto maybe_retry;
1887 /* if rtn == FAILED, we have no sense information;
1888 * returning FAILED will wake the error handler thread
1889 * to collect the sense and redo the decide
1890 * disposition */
1891 return rtn;
1892 case CONDITION_GOOD:
1893 case INTERMEDIATE_GOOD:
1894 case INTERMEDIATE_C_GOOD:
1895 case ACA_ACTIVE:
1896 /*
1897 * who knows? FIXME(eric)
1898 */
1899 return SUCCESS;
1900
1901 case RESERVATION_CONFLICT:
1902 sdev_printk(KERN_INFO, scmd->device,
1903 "reservation conflict\n");
1904 set_host_byte(scmd, DID_NEXUS_FAILURE);
1905 return SUCCESS; /* causes immediate i/o error */
1906 default:
1907 return FAILED;
1908 }
1909 return FAILED;
1910
1911 maybe_retry:
1912
1913 /* we requeue for retry because the error was retryable, and
1914 * the request was not marked fast fail. Note that above,
1915 * even if the request is marked fast fail, we still requeue
1916 * for queue congestion conditions (QUEUE_FULL or BUSY) */
1917 if ((++scmd->retries) <= scmd->allowed
1918 && !scsi_noretry_cmd(scmd)) {
1919 return NEEDS_RETRY;
1920 } else {
1921 /*
1922 * no more retries - report this one back to upper level.
1923 */
1924 return SUCCESS;
1925 }
1926}
1927
1928static void eh_lock_door_done(struct request *req, int uptodate)
1929{
1930 __blk_put_request(req->q, req);
1931}
1932
1933/**
1934 * scsi_eh_lock_door - Prevent medium removal for the specified device
1935 * @sdev: SCSI device to prevent medium removal
1936 *
1937 * Locking:
1938 * We must be called from process context.
1939 *
1940 * Notes:
1941 * We queue up an asynchronous "ALLOW MEDIUM REMOVAL" request on the
1942 * head of the devices request queue, and continue.
1943 */
1944static void scsi_eh_lock_door(struct scsi_device *sdev)
1945{
1946 struct request *req;
1947
1948 /*
1949 * blk_get_request with GFP_KERNEL (__GFP_WAIT) sleeps until a
1950 * request becomes available
1951 */
1952 req = blk_get_request(sdev->request_queue, READ, GFP_KERNEL);
1953
1954 req->cmd[0] = ALLOW_MEDIUM_REMOVAL;
1955 req->cmd[1] = 0;
1956 req->cmd[2] = 0;
1957 req->cmd[3] = 0;
1958 req->cmd[4] = SCSI_REMOVAL_PREVENT;
1959 req->cmd[5] = 0;
1960
1961 req->cmd_len = COMMAND_SIZE(req->cmd[0]);
1962
1963 req->cmd_type = REQ_TYPE_BLOCK_PC;
1964 req->cmd_flags |= REQ_QUIET;
1965 req->timeout = 10 * HZ;
1966 req->retries = 5;
1967
1968 blk_execute_rq_nowait(req->q, NULL, req, 1, eh_lock_door_done);
1969}
1970
1971/**
1972 * scsi_restart_operations - restart io operations to the specified host.
1973 * @shost: Host we are restarting.
1974 *
1975 * Notes:
1976 * When we entered the error handler, we blocked all further i/o to
1977 * this device. we need to 'reverse' this process.
1978 */
1979static void scsi_restart_operations(struct Scsi_Host *shost)
1980{
1981 struct scsi_device *sdev;
1982 unsigned long flags;
1983
1984 /*
1985 * If the door was locked, we need to insert a door lock request
1986 * onto the head of the SCSI request queue for the device. There
1987 * is no point trying to lock the door of an off-line device.
1988 */
1989 shost_for_each_device(sdev, shost) {
1990 if (scsi_device_online(sdev) && sdev->locked)
1991 scsi_eh_lock_door(sdev);
1992 }
1993
1994 /*
1995 * next free up anything directly waiting upon the host. this
1996 * will be requests for character device operations, and also for
1997 * ioctls to queued block devices.
1998 */
1999 SCSI_LOG_ERROR_RECOVERY(3,
2000 printk("scsi_eh_%d waking up host to restart\n",
2001 shost->host_no));
2002
2003 spin_lock_irqsave(shost->host_lock, flags);
2004 if (scsi_host_set_state(shost, SHOST_RUNNING))
2005 if (scsi_host_set_state(shost, SHOST_CANCEL))
2006 BUG_ON(scsi_host_set_state(shost, SHOST_DEL));
2007 spin_unlock_irqrestore(shost->host_lock, flags);
2008
2009 wake_up(&shost->host_wait);
2010
2011 /*
2012 * finally we need to re-initiate requests that may be pending. we will
2013 * have had everything blocked while error handling is taking place, and
2014 * now that error recovery is done, we will need to ensure that these
2015 * requests are started.
2016 */
2017 scsi_run_host_queues(shost);
2018
2019 /*
2020 * if eh is active and host_eh_scheduled is pending we need to re-run
2021 * recovery. we do this check after scsi_run_host_queues() to allow
2022 * everything pent up since the last eh run a chance to make forward
2023 * progress before we sync again. Either we'll immediately re-run
2024 * recovery or scsi_device_unbusy() will wake us again when these
2025 * pending commands complete.
2026 */
2027 spin_lock_irqsave(shost->host_lock, flags);
2028 if (shost->host_eh_scheduled)
2029 if (scsi_host_set_state(shost, SHOST_RECOVERY))
2030 WARN_ON(scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY));
2031 spin_unlock_irqrestore(shost->host_lock, flags);
2032}
2033
2034/**
2035 * scsi_eh_ready_devs - check device ready state and recover if not.
2036 * @shost: host to be recovered.
2037 * @work_q: &list_head for pending commands.
2038 * @done_q: &list_head for processed commands.
2039 */
2040void scsi_eh_ready_devs(struct Scsi_Host *shost,
2041 struct list_head *work_q,
2042 struct list_head *done_q)
2043{
2044 if (!scsi_eh_stu(shost, work_q, done_q))
2045 if (!scsi_eh_bus_device_reset(shost, work_q, done_q))
2046 if (!scsi_eh_target_reset(shost, work_q, done_q))
2047 if (!scsi_eh_bus_reset(shost, work_q, done_q))
2048 if (!scsi_eh_host_reset(work_q, done_q))
2049 scsi_eh_offline_sdevs(work_q,
2050 done_q);
2051}
2052EXPORT_SYMBOL_GPL(scsi_eh_ready_devs);
2053
2054/**
2055 * scsi_eh_flush_done_q - finish processed commands or retry them.
2056 * @done_q: list_head of processed commands.
2057 */
2058void scsi_eh_flush_done_q(struct list_head *done_q)
2059{
2060 struct scsi_cmnd *scmd, *next;
2061
2062 list_for_each_entry_safe(scmd, next, done_q, eh_entry) {
2063 list_del_init(&scmd->eh_entry);
2064 if (scsi_device_online(scmd->device) &&
2065 !scsi_noretry_cmd(scmd) &&
2066 (++scmd->retries <= scmd->allowed)) {
2067 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: flush"
2068 " retry cmd: %p\n",
2069 current->comm,
2070 scmd));
2071 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
2072 } else {
2073 /*
2074 * If just we got sense for the device (called
2075 * scsi_eh_get_sense), scmd->result is already
2076 * set, do not set DRIVER_TIMEOUT.
2077 */
2078 if (!scmd->result)
2079 scmd->result |= (DRIVER_TIMEOUT << 24);
2080 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: flush finish"
2081 " cmd: %p\n",
2082 current->comm, scmd));
2083 scsi_finish_command(scmd);
2084 }
2085 }
2086}
2087EXPORT_SYMBOL(scsi_eh_flush_done_q);
2088
2089/**
2090 * scsi_unjam_host - Attempt to fix a host which has a cmd that failed.
2091 * @shost: Host to unjam.
2092 *
2093 * Notes:
2094 * When we come in here, we *know* that all commands on the bus have
2095 * either completed, failed or timed out. we also know that no further
2096 * commands are being sent to the host, so things are relatively quiet
2097 * and we have freedom to fiddle with things as we wish.
2098 *
2099 * This is only the *default* implementation. it is possible for
2100 * individual drivers to supply their own version of this function, and
2101 * if the maintainer wishes to do this, it is strongly suggested that
2102 * this function be taken as a template and modified. this function
2103 * was designed to correctly handle problems for about 95% of the
2104 * different cases out there, and it should always provide at least a
2105 * reasonable amount of error recovery.
2106 *
2107 * Any command marked 'failed' or 'timeout' must eventually have
2108 * scsi_finish_cmd() called for it. we do all of the retry stuff
2109 * here, so when we restart the host after we return it should have an
2110 * empty queue.
2111 */
2112static void scsi_unjam_host(struct Scsi_Host *shost)
2113{
2114 unsigned long flags;
2115 LIST_HEAD(eh_work_q);
2116 LIST_HEAD(eh_done_q);
2117
2118 spin_lock_irqsave(shost->host_lock, flags);
2119 list_splice_init(&shost->eh_cmd_q, &eh_work_q);
2120 spin_unlock_irqrestore(shost->host_lock, flags);
2121
2122 SCSI_LOG_ERROR_RECOVERY(1, scsi_eh_prt_fail_stats(shost, &eh_work_q));
2123
2124 if (!scsi_eh_get_sense(&eh_work_q, &eh_done_q))
2125 if (!scsi_eh_abort_cmds(&eh_work_q, &eh_done_q))
2126 scsi_eh_ready_devs(shost, &eh_work_q, &eh_done_q);
2127
2128 spin_lock_irqsave(shost->host_lock, flags);
2129 if (shost->eh_deadline != -1)
2130 shost->last_reset = 0;
2131 spin_unlock_irqrestore(shost->host_lock, flags);
2132 scsi_eh_flush_done_q(&eh_done_q);
2133}
2134
2135/**
2136 * scsi_error_handler - SCSI error handler thread
2137 * @data: Host for which we are running.
2138 *
2139 * Notes:
2140 * This is the main error handling loop. This is run as a kernel thread
2141 * for every SCSI host and handles all error handling activity.
2142 */
2143int scsi_error_handler(void *data)
2144{
2145 struct Scsi_Host *shost = data;
2146
2147 /*
2148 * We use TASK_INTERRUPTIBLE so that the thread is not
2149 * counted against the load average as a running process.
2150 * We never actually get interrupted because kthread_run
2151 * disables signal delivery for the created thread.
2152 */
2153 while (!kthread_should_stop()) {
2154 set_current_state(TASK_INTERRUPTIBLE);
2155 if ((shost->host_failed == 0 && shost->host_eh_scheduled == 0) ||
2156 shost->host_failed != shost->host_busy) {
2157 SCSI_LOG_ERROR_RECOVERY(1,
2158 printk("scsi_eh_%d: sleeping\n",
2159 shost->host_no));
2160 schedule();
2161 continue;
2162 }
2163
2164 __set_current_state(TASK_RUNNING);
2165 SCSI_LOG_ERROR_RECOVERY(1,
2166 printk("scsi_eh_%d: waking up %d/%d/%d\n",
2167 shost->host_no, shost->host_eh_scheduled,
2168 shost->host_failed, shost->host_busy));
2169
2170 /*
2171 * We have a host that is failing for some reason. Figure out
2172 * what we need to do to get it up and online again (if we can).
2173 * If we fail, we end up taking the thing offline.
2174 */
2175 if (!shost->eh_noresume && scsi_autopm_get_host(shost) != 0) {
2176 SCSI_LOG_ERROR_RECOVERY(1,
2177 printk(KERN_ERR "Error handler scsi_eh_%d "
2178 "unable to autoresume\n",
2179 shost->host_no));
2180 continue;
2181 }
2182
2183 if (shost->transportt->eh_strategy_handler)
2184 shost->transportt->eh_strategy_handler(shost);
2185 else
2186 scsi_unjam_host(shost);
2187
2188 /*
2189 * Note - if the above fails completely, the action is to take
2190 * individual devices offline and flush the queue of any
2191 * outstanding requests that may have been pending. When we
2192 * restart, we restart any I/O to any other devices on the bus
2193 * which are still online.
2194 */
2195 scsi_restart_operations(shost);
2196 if (!shost->eh_noresume)
2197 scsi_autopm_put_host(shost);
2198 }
2199 __set_current_state(TASK_RUNNING);
2200
2201 SCSI_LOG_ERROR_RECOVERY(1,
2202 printk("Error handler scsi_eh_%d exiting\n", shost->host_no));
2203 shost->ehandler = NULL;
2204 return 0;
2205}
2206
2207/*
2208 * Function: scsi_report_bus_reset()
2209 *
2210 * Purpose: Utility function used by low-level drivers to report that
2211 * they have observed a bus reset on the bus being handled.
2212 *
2213 * Arguments: shost - Host in question
2214 * channel - channel on which reset was observed.
2215 *
2216 * Returns: Nothing
2217 *
2218 * Lock status: Host lock must be held.
2219 *
2220 * Notes: This only needs to be called if the reset is one which
2221 * originates from an unknown location. Resets originated
2222 * by the mid-level itself don't need to call this, but there
2223 * should be no harm.
2224 *
2225 * The main purpose of this is to make sure that a CHECK_CONDITION
2226 * is properly treated.
2227 */
2228void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
2229{
2230 struct scsi_device *sdev;
2231
2232 __shost_for_each_device(sdev, shost) {
2233 if (channel == sdev_channel(sdev))
2234 __scsi_report_device_reset(sdev, NULL);
2235 }
2236}
2237EXPORT_SYMBOL(scsi_report_bus_reset);
2238
2239/*
2240 * Function: scsi_report_device_reset()
2241 *
2242 * Purpose: Utility function used by low-level drivers to report that
2243 * they have observed a device reset on the device being handled.
2244 *
2245 * Arguments: shost - Host in question
2246 * channel - channel on which reset was observed
2247 * target - target on which reset was observed
2248 *
2249 * Returns: Nothing
2250 *
2251 * Lock status: Host lock must be held
2252 *
2253 * Notes: This only needs to be called if the reset is one which
2254 * originates from an unknown location. Resets originated
2255 * by the mid-level itself don't need to call this, but there
2256 * should be no harm.
2257 *
2258 * The main purpose of this is to make sure that a CHECK_CONDITION
2259 * is properly treated.
2260 */
2261void scsi_report_device_reset(struct Scsi_Host *shost, int channel, int target)
2262{
2263 struct scsi_device *sdev;
2264
2265 __shost_for_each_device(sdev, shost) {
2266 if (channel == sdev_channel(sdev) &&
2267 target == sdev_id(sdev))
2268 __scsi_report_device_reset(sdev, NULL);
2269 }
2270}
2271EXPORT_SYMBOL(scsi_report_device_reset);
2272
2273static void
2274scsi_reset_provider_done_command(struct scsi_cmnd *scmd)
2275{
2276}
2277
2278/*
2279 * Function: scsi_reset_provider
2280 *
2281 * Purpose: Send requested reset to a bus or device at any phase.
2282 *
2283 * Arguments: device - device to send reset to
2284 * flag - reset type (see scsi.h)
2285 *
2286 * Returns: SUCCESS/FAILURE.
2287 *
2288 * Notes: This is used by the SCSI Generic driver to provide
2289 * Bus/Device reset capability.
2290 */
2291int
2292scsi_reset_provider(struct scsi_device *dev, int flag)
2293{
2294 struct scsi_cmnd *scmd;
2295 struct Scsi_Host *shost = dev->host;
2296 struct request req;
2297 unsigned long flags;
2298 int rtn;
2299
2300 if (scsi_autopm_get_host(shost) < 0)
2301 return FAILED;
2302
2303 if (!get_device(&dev->sdev_gendev)) {
2304 rtn = FAILED;
2305 goto out_put_autopm_host;
2306 }
2307
2308 scmd = scsi_get_command(dev, GFP_KERNEL);
2309 blk_rq_init(NULL, &req);
2310 scmd->request = &req;
2311
2312 scmd->cmnd = req.cmd;
2313
2314 scmd->scsi_done = scsi_reset_provider_done_command;
2315 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
2316
2317 scmd->cmd_len = 0;
2318
2319 scmd->sc_data_direction = DMA_BIDIRECTIONAL;
2320
2321 spin_lock_irqsave(shost->host_lock, flags);
2322 shost->tmf_in_progress = 1;
2323 spin_unlock_irqrestore(shost->host_lock, flags);
2324
2325 switch (flag) {
2326 case SCSI_TRY_RESET_DEVICE:
2327 rtn = scsi_try_bus_device_reset(scmd);
2328 if (rtn == SUCCESS)
2329 break;
2330 /* FALLTHROUGH */
2331 case SCSI_TRY_RESET_TARGET:
2332 rtn = scsi_try_target_reset(scmd);
2333 if (rtn == SUCCESS)
2334 break;
2335 /* FALLTHROUGH */
2336 case SCSI_TRY_RESET_BUS:
2337 rtn = scsi_try_bus_reset(scmd);
2338 if (rtn == SUCCESS)
2339 break;
2340 /* FALLTHROUGH */
2341 case SCSI_TRY_RESET_HOST:
2342 rtn = scsi_try_host_reset(scmd);
2343 break;
2344 default:
2345 rtn = FAILED;
2346 }
2347
2348 spin_lock_irqsave(shost->host_lock, flags);
2349 shost->tmf_in_progress = 0;
2350 spin_unlock_irqrestore(shost->host_lock, flags);
2351
2352 /*
2353 * be sure to wake up anyone who was sleeping or had their queue
2354 * suspended while we performed the TMF.
2355 */
2356 SCSI_LOG_ERROR_RECOVERY(3,
2357 printk("%s: waking up host to restart after TMF\n",
2358 __func__));
2359
2360 wake_up(&shost->host_wait);
2361
2362 scsi_run_host_queues(shost);
2363
2364 scsi_next_command(scmd);
2365out_put_autopm_host:
2366 scsi_autopm_put_host(shost);
2367 return rtn;
2368}
2369EXPORT_SYMBOL(scsi_reset_provider);
2370
2371/**
2372 * scsi_normalize_sense - normalize main elements from either fixed or
2373 * descriptor sense data format into a common format.
2374 *
2375 * @sense_buffer: byte array containing sense data returned by device
2376 * @sb_len: number of valid bytes in sense_buffer
2377 * @sshdr: pointer to instance of structure that common
2378 * elements are written to.
2379 *
2380 * Notes:
2381 * The "main elements" from sense data are: response_code, sense_key,
2382 * asc, ascq and additional_length (only for descriptor format).
2383 *
2384 * Typically this function can be called after a device has
2385 * responded to a SCSI command with the CHECK_CONDITION status.
2386 *
2387 * Return value:
2388 * 1 if valid sense data information found, else 0;
2389 */
2390int scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
2391 struct scsi_sense_hdr *sshdr)
2392{
2393 if (!sense_buffer || !sb_len)
2394 return 0;
2395
2396 memset(sshdr, 0, sizeof(struct scsi_sense_hdr));
2397
2398 sshdr->response_code = (sense_buffer[0] & 0x7f);
2399
2400 if (!scsi_sense_valid(sshdr))
2401 return 0;
2402
2403 if (sshdr->response_code >= 0x72) {
2404 /*
2405 * descriptor format
2406 */
2407 if (sb_len > 1)
2408 sshdr->sense_key = (sense_buffer[1] & 0xf);
2409 if (sb_len > 2)
2410 sshdr->asc = sense_buffer[2];
2411 if (sb_len > 3)
2412 sshdr->ascq = sense_buffer[3];
2413 if (sb_len > 7)
2414 sshdr->additional_length = sense_buffer[7];
2415 } else {
2416 /*
2417 * fixed format
2418 */
2419 if (sb_len > 2)
2420 sshdr->sense_key = (sense_buffer[2] & 0xf);
2421 if (sb_len > 7) {
2422 sb_len = (sb_len < (sense_buffer[7] + 8)) ?
2423 sb_len : (sense_buffer[7] + 8);
2424 if (sb_len > 12)
2425 sshdr->asc = sense_buffer[12];
2426 if (sb_len > 13)
2427 sshdr->ascq = sense_buffer[13];
2428 }
2429 }
2430
2431 return 1;
2432}
2433EXPORT_SYMBOL(scsi_normalize_sense);
2434
2435int scsi_command_normalize_sense(struct scsi_cmnd *cmd,
2436 struct scsi_sense_hdr *sshdr)
2437{
2438 return scsi_normalize_sense(cmd->sense_buffer,
2439 SCSI_SENSE_BUFFERSIZE, sshdr);
2440}
2441EXPORT_SYMBOL(scsi_command_normalize_sense);
2442
2443/**
2444 * scsi_sense_desc_find - search for a given descriptor type in descriptor sense data format.
2445 * @sense_buffer: byte array of descriptor format sense data
2446 * @sb_len: number of valid bytes in sense_buffer
2447 * @desc_type: value of descriptor type to find
2448 * (e.g. 0 -> information)
2449 *
2450 * Notes:
2451 * only valid when sense data is in descriptor format
2452 *
2453 * Return value:
2454 * pointer to start of (first) descriptor if found else NULL
2455 */
2456const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
2457 int desc_type)
2458{
2459 int add_sen_len, add_len, desc_len, k;
2460 const u8 * descp;
2461
2462 if ((sb_len < 8) || (0 == (add_sen_len = sense_buffer[7])))
2463 return NULL;
2464 if ((sense_buffer[0] < 0x72) || (sense_buffer[0] > 0x73))
2465 return NULL;
2466 add_sen_len = (add_sen_len < (sb_len - 8)) ?
2467 add_sen_len : (sb_len - 8);
2468 descp = &sense_buffer[8];
2469 for (desc_len = 0, k = 0; k < add_sen_len; k += desc_len) {
2470 descp += desc_len;
2471 add_len = (k < (add_sen_len - 1)) ? descp[1]: -1;
2472 desc_len = add_len + 2;
2473 if (descp[0] == desc_type)
2474 return descp;
2475 if (add_len < 0) // short descriptor ??
2476 break;
2477 }
2478 return NULL;
2479}
2480EXPORT_SYMBOL(scsi_sense_desc_find);
2481
2482/**
2483 * scsi_get_sense_info_fld - get information field from sense data (either fixed or descriptor format)
2484 * @sense_buffer: byte array of sense data
2485 * @sb_len: number of valid bytes in sense_buffer
2486 * @info_out: pointer to 64 integer where 8 or 4 byte information
2487 * field will be placed if found.
2488 *
2489 * Return value:
2490 * 1 if information field found, 0 if not found.
2491 */
2492int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
2493 u64 * info_out)
2494{
2495 int j;
2496 const u8 * ucp;
2497 u64 ull;
2498
2499 if (sb_len < 7)
2500 return 0;
2501 switch (sense_buffer[0] & 0x7f) {
2502 case 0x70:
2503 case 0x71:
2504 if (sense_buffer[0] & 0x80) {
2505 *info_out = (sense_buffer[3] << 24) +
2506 (sense_buffer[4] << 16) +
2507 (sense_buffer[5] << 8) + sense_buffer[6];
2508 return 1;
2509 } else
2510 return 0;
2511 case 0x72:
2512 case 0x73:
2513 ucp = scsi_sense_desc_find(sense_buffer, sb_len,
2514 0 /* info desc */);
2515 if (ucp && (0xa == ucp[1])) {
2516 ull = 0;
2517 for (j = 0; j < 8; ++j) {
2518 if (j > 0)
2519 ull <<= 8;
2520 ull |= ucp[4 + j];
2521 }
2522 *info_out = ull;
2523 return 1;
2524 } else
2525 return 0;
2526 default:
2527 return 0;
2528 }
2529}
2530EXPORT_SYMBOL(scsi_get_sense_info_fld);
2531
2532/**
2533 * scsi_build_sense_buffer - build sense data in a buffer
2534 * @desc: Sense format (non zero == descriptor format,
2535 * 0 == fixed format)
2536 * @buf: Where to build sense data
2537 * @key: Sense key
2538 * @asc: Additional sense code
2539 * @ascq: Additional sense code qualifier
2540 *
2541 **/
2542void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq)
2543{
2544 if (desc) {
2545 buf[0] = 0x72; /* descriptor, current */
2546 buf[1] = key;
2547 buf[2] = asc;
2548 buf[3] = ascq;
2549 buf[7] = 0;
2550 } else {
2551 buf[0] = 0x70; /* fixed, current */
2552 buf[2] = key;
2553 buf[7] = 0xa;
2554 buf[12] = asc;
2555 buf[13] = ascq;
2556 }
2557}
2558EXPORT_SYMBOL(scsi_build_sense_buffer);