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