2 * scsi_error.c Copyright (C) 1997 Eric Youngdale
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.
9 * Restructured scsi_unjam_host and associated functions.
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>
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>
40 #include "scsi_priv.h"
41 #include "scsi_logging.h"
42 #include "scsi_transport_api.h"
44 #include <trace/events/scsi.h>
46 static void scsi_eh_done(struct scsi_cmnd *scmd);
49 * These should *probably* be handled by the host itself.
50 * Since it is allowed to sleep, it probably should.
52 #define BUS_RESET_SETTLE_TIME (10)
53 #define HOST_RESET_SETTLE_TIME (10)
55 static int scsi_eh_try_stu(struct scsi_cmnd *scmd);
56 static int scsi_try_to_abort_cmd(struct scsi_host_template *,
59 /* called with shost->host_lock held */
60 void scsi_eh_wakeup(struct Scsi_Host *shost)
62 if (atomic_read(&shost->host_busy) == shost->host_failed) {
63 trace_scsi_eh_wakeup(shost);
64 wake_up_process(shost->ehandler);
65 SCSI_LOG_ERROR_RECOVERY(5, shost_printk(KERN_INFO, shost,
66 "Waking error handler thread\n"));
71 * scsi_schedule_eh - schedule EH for SCSI host
72 * @shost: SCSI host to invoke error handling on.
74 * Schedule SCSI EH without scmd.
76 void scsi_schedule_eh(struct Scsi_Host *shost)
80 spin_lock_irqsave(shost->host_lock, flags);
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);
88 spin_unlock_irqrestore(shost->host_lock, flags);
90 EXPORT_SYMBOL_GPL(scsi_schedule_eh);
92 static int scsi_host_eh_past_deadline(struct Scsi_Host *shost)
94 if (!shost->last_reset || shost->eh_deadline == -1)
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
104 if (time_before(jiffies, shost->last_reset + shost->eh_deadline) &&
105 shost->eh_deadline > -1)
112 * scmd_eh_abort_handler - Handle command aborts
113 * @work: command to be aborted.
116 scmd_eh_abort_handler(struct work_struct *work)
118 struct scsi_cmnd *scmd =
119 container_of(work, struct scsi_cmnd, abort_work.work);
120 struct scsi_device *sdev = scmd->device;
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",
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 set_host_byte(scmd, DID_TIME_OUT);
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 "
141 } else if (!scsi_noretry_cmd(scmd) &&
142 (++scmd->retries <= scmd->allowed)) {
143 SCSI_LOG_ERROR_RECOVERY(3,
144 scmd_printk(KERN_WARNING, scmd,
146 "aborted command\n", scmd));
147 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
150 SCSI_LOG_ERROR_RECOVERY(3,
151 scmd_printk(KERN_WARNING, scmd,
153 "aborted command\n", scmd));
154 scsi_finish_command(scmd);
158 SCSI_LOG_ERROR_RECOVERY(3,
159 scmd_printk(KERN_INFO, scmd,
160 "scmd %p abort failed, rtn %d\n",
165 if (!scsi_eh_scmd_add(scmd, 0)) {
166 SCSI_LOG_ERROR_RECOVERY(3,
167 scmd_printk(KERN_WARNING, scmd,
169 "aborted command\n", scmd));
170 set_host_byte(scmd, DID_TIME_OUT);
171 scsi_finish_command(scmd);
176 * scsi_abort_command - schedule a command abort
177 * @scmd: scmd to abort.
179 * We only need to abort commands after a command timeout
182 scsi_abort_command(struct scsi_cmnd *scmd)
184 struct scsi_device *sdev = scmd->device;
185 struct Scsi_Host *shost = sdev->host;
188 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
190 * Retry after abort failed, escalate to next level.
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 BUG_ON(delayed_work_pending(&scmd->abort_work));
201 * Do not try a command abort if
202 * SCSI EH has already started.
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",
214 if (shost->eh_deadline != -1 && !shost->last_reset)
215 shost->last_reset = jiffies;
216 spin_unlock_irqrestore(shost->host_lock, flags);
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);
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.
234 int scsi_eh_scmd_add(struct scsi_cmnd *scmd, int eh_flag)
236 struct Scsi_Host *shost = scmd->device->host;
240 if (!shost->ehandler)
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))
248 if (shost->eh_deadline != -1 && !shost->last_reset)
249 shost->last_reset = jiffies;
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);
259 spin_unlock_irqrestore(shost->host_lock, flags);
264 * scsi_times_out - Timeout function for normal scsi commands.
265 * @req: request that is timing out.
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.
273 enum blk_eh_timer_return scsi_times_out(struct request *req)
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;
279 trace_scsi_dispatch_cmd_timeout(scmd);
280 scsi_log_completion(scmd, TIMEOUT_ERROR);
282 if (host->eh_deadline != -1 && !host->last_reset)
283 host->last_reset = jiffies;
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);
290 if (rtn == BLK_EH_NOT_HANDLED) {
291 if (!host->hostt->no_async_abort &&
292 scsi_abort_command(scmd) == SUCCESS)
293 return BLK_EH_NOT_HANDLED;
295 set_host_byte(scmd, DID_TIME_OUT);
296 if (!scsi_eh_scmd_add(scmd, SCSI_EH_CANCEL_CMD))
297 rtn = BLK_EH_HANDLED;
304 * scsi_block_when_processing_errors - Prevent cmds from being queued.
305 * @sdev: Device on which we are performing recovery.
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.
312 * 0 when dev was taken offline by error recovery. 1 OK to proceed.
314 int scsi_block_when_processing_errors(struct scsi_device *sdev)
318 wait_event(sdev->host->host_wait, !scsi_host_in_recovery(sdev->host));
320 online = scsi_device_online(sdev);
322 SCSI_LOG_ERROR_RECOVERY(5, sdev_printk(KERN_INFO, sdev,
323 "%s: rtn: %d\n", __func__, online));
327 EXPORT_SYMBOL(scsi_block_when_processing_errors);
329 #ifdef CONFIG_SCSI_LOGGING
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.
335 static inline void scsi_eh_prt_fail_stats(struct Scsi_Host *shost,
336 struct list_head *work_q)
338 struct scsi_cmnd *scmd;
339 struct scsi_device *sdev;
340 int total_failures = 0;
343 int devices_failed = 0;
345 shost_for_each_device(sdev, shost) {
346 list_for_each_entry(scmd, work_q, eh_entry) {
347 if (scmd->device == sdev) {
349 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD)
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,
368 SCSI_LOG_ERROR_RECOVERY(2, shost_printk(KERN_INFO, shost,
369 "Total of %d commands on %d"
370 " devices require eh work\n",
371 total_failures, devices_failed));
376 * scsi_report_lun_change - Set flag on all *other* devices on the same target
377 * to indicate that a UNIT ATTENTION is expected.
378 * @sdev: Device reporting the UNIT ATTENTION
380 static void scsi_report_lun_change(struct scsi_device *sdev)
382 sdev->sdev_target->expecting_lun_change = 1;
386 * scsi_report_sense - Examine scsi sense information and log messages for
387 * certain conditions, also issue uevents for some of them.
388 * @sdev: Device reporting the sense code
389 * @sshdr: sshdr to be examined
391 static void scsi_report_sense(struct scsi_device *sdev,
392 struct scsi_sense_hdr *sshdr)
394 enum scsi_device_event evt_type = SDEV_EVT_MAXBITS; /* i.e. none */
396 if (sshdr->sense_key == UNIT_ATTENTION) {
397 if (sshdr->asc == 0x3f && sshdr->ascq == 0x03) {
398 evt_type = SDEV_EVT_INQUIRY_CHANGE_REPORTED;
399 sdev_printk(KERN_WARNING, sdev,
400 "Inquiry data has changed");
401 } else if (sshdr->asc == 0x3f && sshdr->ascq == 0x0e) {
402 evt_type = SDEV_EVT_LUN_CHANGE_REPORTED;
403 scsi_report_lun_change(sdev);
404 sdev_printk(KERN_WARNING, sdev,
405 "Warning! Received an indication that the "
406 "LUN assignments on this target have "
407 "changed. The Linux SCSI layer does not "
408 "automatically remap LUN assignments.\n");
409 } else if (sshdr->asc == 0x3f)
410 sdev_printk(KERN_WARNING, sdev,
411 "Warning! Received an indication that the "
412 "operating parameters on this target have "
413 "changed. The Linux SCSI layer does not "
414 "automatically adjust these parameters.\n");
416 if (sshdr->asc == 0x38 && sshdr->ascq == 0x07) {
417 evt_type = SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED;
418 sdev_printk(KERN_WARNING, sdev,
419 "Warning! Received an indication that the "
420 "LUN reached a thin provisioning soft "
424 if (sshdr->asc == 0x2a && sshdr->ascq == 0x01) {
425 evt_type = SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED;
426 sdev_printk(KERN_WARNING, sdev,
427 "Mode parameters changed");
428 } else if (sshdr->asc == 0x2a && sshdr->ascq == 0x09) {
429 evt_type = SDEV_EVT_CAPACITY_CHANGE_REPORTED;
430 sdev_printk(KERN_WARNING, sdev,
431 "Capacity data has changed");
432 } else if (sshdr->asc == 0x2a)
433 sdev_printk(KERN_WARNING, sdev,
434 "Parameters changed");
437 if (evt_type != SDEV_EVT_MAXBITS) {
438 set_bit(evt_type, sdev->pending_events);
439 schedule_work(&sdev->event_work);
444 * scsi_check_sense - Examine scsi cmd sense
445 * @scmd: Cmd to have sense checked.
448 * SUCCESS or FAILED or NEEDS_RETRY or ADD_TO_MLQUEUE
451 * When a deferred error is detected the current command has
452 * not been executed and needs retrying.
454 static int scsi_check_sense(struct scsi_cmnd *scmd)
456 struct scsi_device *sdev = scmd->device;
457 struct scsi_sense_hdr sshdr;
459 if (! scsi_command_normalize_sense(scmd, &sshdr))
460 return FAILED; /* no valid sense data */
462 if (scmd->cmnd[0] == TEST_UNIT_READY && scmd->scsi_done != scsi_eh_done)
464 * nasty: for mid-layer issued TURs, we need to return the
465 * actual sense data without any recovery attempt. For eh
466 * issued ones, we need to try to recover and interpret
470 scsi_report_sense(sdev, &sshdr);
472 if (scsi_sense_is_deferred(&sshdr))
475 if (sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh &&
476 sdev->scsi_dh_data->scsi_dh->check_sense) {
479 rc = sdev->scsi_dh_data->scsi_dh->check_sense(sdev, &sshdr);
480 if (rc != SCSI_RETURN_NOT_HANDLED)
482 /* handler does not care. Drop down to default handling */
486 * Previous logic looked for FILEMARK, EOM or ILI which are
487 * mainly associated with tapes and returned SUCCESS.
489 if (sshdr.response_code == 0x70) {
491 if (scmd->sense_buffer[2] & 0xe0)
495 * descriptor format: look for "stream commands sense data
496 * descriptor" (see SSC-3). Assume single sense data
497 * descriptor. Ignore ILI from SBC-2 READ LONG and WRITE LONG.
499 if ((sshdr.additional_length > 3) &&
500 (scmd->sense_buffer[8] == 0x4) &&
501 (scmd->sense_buffer[11] & 0xe0))
505 switch (sshdr.sense_key) {
508 case RECOVERED_ERROR:
509 return /* soft_error */ SUCCESS;
511 case ABORTED_COMMAND:
512 if (sshdr.asc == 0x10) /* DIF */
519 * if we are expecting a cc/ua because of a bus reset that we
520 * performed, treat this just as a retry. otherwise this is
521 * information that we should pass up to the upper-level driver
522 * so that we can deal with it there.
524 if (scmd->device->expecting_cc_ua) {
526 * Because some device does not queue unit
527 * attentions correctly, we carefully check
528 * additional sense code and qualifier so as
529 * not to squash media change unit attention.
531 if (sshdr.asc != 0x28 || sshdr.ascq != 0x00) {
532 scmd->device->expecting_cc_ua = 0;
537 * we might also expect a cc/ua if another LUN on the target
538 * reported a UA with an ASC/ASCQ of 3F 0E -
539 * REPORTED LUNS DATA HAS CHANGED.
541 if (scmd->device->sdev_target->expecting_lun_change &&
542 sshdr.asc == 0x3f && sshdr.ascq == 0x0e)
545 * if the device is in the process of becoming ready, we
548 if ((sshdr.asc == 0x04) && (sshdr.ascq == 0x01))
551 * if the device is not started, we need to wake
552 * the error handler to start the motor
554 if (scmd->device->allow_restart &&
555 (sshdr.asc == 0x04) && (sshdr.ascq == 0x02))
558 * Pass the UA upwards for a determination in the completion
563 /* these are not supported */
565 if (sshdr.asc == 0x27 && sshdr.ascq == 0x07) {
566 /* Thin provisioning hard threshold reached */
567 set_host_byte(scmd, DID_ALLOC_FAILURE);
571 case VOLUME_OVERFLOW:
574 set_host_byte(scmd, DID_TARGET_FAILURE);
578 if (sshdr.asc == 0x11 || /* UNRECOVERED READ ERR */
579 sshdr.asc == 0x13 || /* AMNF DATA FIELD */
580 sshdr.asc == 0x14) { /* RECORD NOT FOUND */
581 set_host_byte(scmd, DID_MEDIUM_ERROR);
587 if (scmd->device->retry_hwerror)
588 return ADD_TO_MLQUEUE;
590 set_host_byte(scmd, DID_TARGET_FAILURE);
592 case ILLEGAL_REQUEST:
593 if (sshdr.asc == 0x20 || /* Invalid command operation code */
594 sshdr.asc == 0x21 || /* Logical block address out of range */
595 sshdr.asc == 0x24 || /* Invalid field in cdb */
596 sshdr.asc == 0x26) { /* Parameter value invalid */
597 set_host_byte(scmd, DID_TARGET_FAILURE);
606 static void scsi_handle_queue_ramp_up(struct scsi_device *sdev)
608 struct scsi_host_template *sht = sdev->host->hostt;
609 struct scsi_device *tmp_sdev;
611 if (!sht->change_queue_depth ||
612 sdev->queue_depth >= sdev->max_queue_depth)
615 if (time_before(jiffies,
616 sdev->last_queue_ramp_up + sdev->queue_ramp_up_period))
619 if (time_before(jiffies,
620 sdev->last_queue_full_time + sdev->queue_ramp_up_period))
624 * Walk all devices of a target and do
627 shost_for_each_device(tmp_sdev, sdev->host) {
628 if (tmp_sdev->channel != sdev->channel ||
629 tmp_sdev->id != sdev->id ||
630 tmp_sdev->queue_depth == sdev->max_queue_depth)
633 * call back into LLD to increase queue_depth by one
634 * with ramp up reason code.
636 sht->change_queue_depth(tmp_sdev, tmp_sdev->queue_depth + 1,
637 SCSI_QDEPTH_RAMP_UP);
638 sdev->last_queue_ramp_up = jiffies;
642 static void scsi_handle_queue_full(struct scsi_device *sdev)
644 struct scsi_host_template *sht = sdev->host->hostt;
645 struct scsi_device *tmp_sdev;
647 if (!sht->change_queue_depth)
650 shost_for_each_device(tmp_sdev, sdev->host) {
651 if (tmp_sdev->channel != sdev->channel ||
652 tmp_sdev->id != sdev->id)
655 * We do not know the number of commands that were at
656 * the device when we got the queue full so we start
657 * from the highest possible value and work our way down.
659 sht->change_queue_depth(tmp_sdev, tmp_sdev->queue_depth - 1,
665 * scsi_eh_completed_normally - Disposition a eh cmd on return from LLD.
666 * @scmd: SCSI cmd to examine.
669 * This is *only* called when we are examining the status of commands
670 * queued during error recovery. the main difference here is that we
671 * don't allow for the possibility of retries here, and we are a lot
672 * more restrictive about what we consider acceptable.
674 static int scsi_eh_completed_normally(struct scsi_cmnd *scmd)
677 * first check the host byte, to see if there is anything in there
678 * that would indicate what we need to do.
680 if (host_byte(scmd->result) == DID_RESET) {
682 * rats. we are already in the error handler, so we now
683 * get to try and figure out what to do next. if the sense
684 * is valid, we have a pretty good idea of what to do.
685 * if not, we mark it as FAILED.
687 return scsi_check_sense(scmd);
689 if (host_byte(scmd->result) != DID_OK)
693 * next, check the message byte.
695 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
699 * now, check the status byte to see if this indicates
702 switch (status_byte(scmd->result)) {
704 scsi_handle_queue_ramp_up(scmd->device);
705 case COMMAND_TERMINATED:
707 case CHECK_CONDITION:
708 return scsi_check_sense(scmd);
710 case INTERMEDIATE_GOOD:
711 case INTERMEDIATE_C_GOOD:
713 * who knows? FIXME(eric)
716 case RESERVATION_CONFLICT:
717 if (scmd->cmnd[0] == TEST_UNIT_READY)
718 /* it is a success, we probed the device and
721 /* otherwise, we failed to send the command */
724 scsi_handle_queue_full(scmd->device);
735 * scsi_eh_done - Completion function for error handling.
736 * @scmd: Cmd that is done.
738 static void scsi_eh_done(struct scsi_cmnd *scmd)
740 struct completion *eh_action;
742 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
743 "%s scmd: %p result: %x\n",
744 __func__, scmd, scmd->result));
746 eh_action = scmd->device->host->eh_action;
752 * scsi_try_host_reset - ask host adapter to reset itself
753 * @scmd: SCSI cmd to send host reset.
755 static int scsi_try_host_reset(struct scsi_cmnd *scmd)
759 struct Scsi_Host *host = scmd->device->host;
760 struct scsi_host_template *hostt = host->hostt;
762 SCSI_LOG_ERROR_RECOVERY(3,
763 shost_printk(KERN_INFO, host, "Snd Host RST\n"));
765 if (!hostt->eh_host_reset_handler)
768 rtn = hostt->eh_host_reset_handler(scmd);
770 if (rtn == SUCCESS) {
771 if (!hostt->skip_settle_delay)
772 ssleep(HOST_RESET_SETTLE_TIME);
773 spin_lock_irqsave(host->host_lock, flags);
774 scsi_report_bus_reset(host, scmd_channel(scmd));
775 spin_unlock_irqrestore(host->host_lock, flags);
782 * scsi_try_bus_reset - ask host to perform a bus reset
783 * @scmd: SCSI cmd to send bus reset.
785 static int scsi_try_bus_reset(struct scsi_cmnd *scmd)
789 struct Scsi_Host *host = scmd->device->host;
790 struct scsi_host_template *hostt = host->hostt;
792 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
793 "%s: Snd Bus RST\n", __func__));
795 if (!hostt->eh_bus_reset_handler)
798 rtn = hostt->eh_bus_reset_handler(scmd);
800 if (rtn == SUCCESS) {
801 if (!hostt->skip_settle_delay)
802 ssleep(BUS_RESET_SETTLE_TIME);
803 spin_lock_irqsave(host->host_lock, flags);
804 scsi_report_bus_reset(host, scmd_channel(scmd));
805 spin_unlock_irqrestore(host->host_lock, flags);
811 static void __scsi_report_device_reset(struct scsi_device *sdev, void *data)
814 sdev->expecting_cc_ua = 1;
818 * scsi_try_target_reset - Ask host to perform a target reset
819 * @scmd: SCSI cmd used to send a target reset
822 * There is no timeout for this operation. if this operation is
823 * unreliable for a given host, then the host itself needs to put a
824 * timer on it, and set the host back to a consistent state prior to
827 static int scsi_try_target_reset(struct scsi_cmnd *scmd)
831 struct Scsi_Host *host = scmd->device->host;
832 struct scsi_host_template *hostt = host->hostt;
834 if (!hostt->eh_target_reset_handler)
837 rtn = hostt->eh_target_reset_handler(scmd);
838 if (rtn == SUCCESS) {
839 spin_lock_irqsave(host->host_lock, flags);
840 __starget_for_each_device(scsi_target(scmd->device), NULL,
841 __scsi_report_device_reset);
842 spin_unlock_irqrestore(host->host_lock, flags);
849 * scsi_try_bus_device_reset - Ask host to perform a BDR on a dev
850 * @scmd: SCSI cmd used to send BDR
853 * There is no timeout for this operation. if this operation is
854 * unreliable for a given host, then the host itself needs to put a
855 * timer on it, and set the host back to a consistent state prior to
858 static int scsi_try_bus_device_reset(struct scsi_cmnd *scmd)
861 struct scsi_host_template *hostt = scmd->device->host->hostt;
863 if (!hostt->eh_device_reset_handler)
866 rtn = hostt->eh_device_reset_handler(scmd);
868 __scsi_report_device_reset(scmd->device, NULL);
872 static int scsi_try_to_abort_cmd(struct scsi_host_template *hostt, struct scsi_cmnd *scmd)
874 if (!hostt->eh_abort_handler)
877 return hostt->eh_abort_handler(scmd);
880 static void scsi_abort_eh_cmnd(struct scsi_cmnd *scmd)
882 if (scsi_try_to_abort_cmd(scmd->device->host->hostt, scmd) != SUCCESS)
883 if (scsi_try_bus_device_reset(scmd) != SUCCESS)
884 if (scsi_try_target_reset(scmd) != SUCCESS)
885 if (scsi_try_bus_reset(scmd) != SUCCESS)
886 scsi_try_host_reset(scmd);
890 * scsi_eh_prep_cmnd - Save a scsi command info as part of error recovery
891 * @scmd: SCSI command structure to hijack
892 * @ses: structure to save restore information
893 * @cmnd: CDB to send. Can be NULL if no new cmnd is needed
894 * @cmnd_size: size in bytes of @cmnd (must be <= BLK_MAX_CDB)
895 * @sense_bytes: size of sense data to copy. or 0 (if != 0 @cmnd is ignored)
897 * This function is used to save a scsi command information before re-execution
898 * as part of the error recovery process. If @sense_bytes is 0 the command
899 * sent must be one that does not transfer any data. If @sense_bytes != 0
900 * @cmnd is ignored and this functions sets up a REQUEST_SENSE command
901 * and cmnd buffers to read @sense_bytes into @scmd->sense_buffer.
903 void scsi_eh_prep_cmnd(struct scsi_cmnd *scmd, struct scsi_eh_save *ses,
904 unsigned char *cmnd, int cmnd_size, unsigned sense_bytes)
906 struct scsi_device *sdev = scmd->device;
909 * We need saved copies of a number of fields - this is because
910 * error handling may need to overwrite these with different values
911 * to run different commands, and once error handling is complete,
912 * we will need to restore these values prior to running the actual
915 ses->cmd_len = scmd->cmd_len;
916 ses->cmnd = scmd->cmnd;
917 ses->data_direction = scmd->sc_data_direction;
918 ses->sdb = scmd->sdb;
919 ses->next_rq = scmd->request->next_rq;
920 ses->result = scmd->result;
921 ses->underflow = scmd->underflow;
922 ses->prot_op = scmd->prot_op;
924 scmd->prot_op = SCSI_PROT_NORMAL;
926 scmd->cmnd = ses->eh_cmnd;
927 memset(scmd->cmnd, 0, BLK_MAX_CDB);
928 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
929 scmd->request->next_rq = NULL;
933 scmd->sdb.length = min_t(unsigned, SCSI_SENSE_BUFFERSIZE,
935 sg_init_one(&ses->sense_sgl, scmd->sense_buffer,
937 scmd->sdb.table.sgl = &ses->sense_sgl;
938 scmd->sc_data_direction = DMA_FROM_DEVICE;
939 scmd->sdb.table.nents = 1;
940 scmd->cmnd[0] = REQUEST_SENSE;
941 scmd->cmnd[4] = scmd->sdb.length;
942 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
944 scmd->sc_data_direction = DMA_NONE;
946 BUG_ON(cmnd_size > BLK_MAX_CDB);
947 memcpy(scmd->cmnd, cmnd, cmnd_size);
948 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
954 if (sdev->scsi_level <= SCSI_2 && sdev->scsi_level != SCSI_UNKNOWN)
955 scmd->cmnd[1] = (scmd->cmnd[1] & 0x1f) |
956 (sdev->lun << 5 & 0xe0);
959 * Zero the sense buffer. The scsi spec mandates that any
960 * untransferred sense data should be interpreted as being zero.
962 memset(scmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
964 EXPORT_SYMBOL(scsi_eh_prep_cmnd);
967 * scsi_eh_restore_cmnd - Restore a scsi command info as part of error recovery
968 * @scmd: SCSI command structure to restore
969 * @ses: saved information from a coresponding call to scsi_eh_prep_cmnd
971 * Undo any damage done by above scsi_eh_prep_cmnd().
973 void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd, struct scsi_eh_save *ses)
976 * Restore original data
978 scmd->cmd_len = ses->cmd_len;
979 scmd->cmnd = ses->cmnd;
980 scmd->sc_data_direction = ses->data_direction;
981 scmd->sdb = ses->sdb;
982 scmd->request->next_rq = ses->next_rq;
983 scmd->result = ses->result;
984 scmd->underflow = ses->underflow;
985 scmd->prot_op = ses->prot_op;
987 EXPORT_SYMBOL(scsi_eh_restore_cmnd);
990 * scsi_send_eh_cmnd - submit a scsi command as part of error recovery
991 * @scmd: SCSI command structure to hijack
993 * @cmnd_size: size in bytes of @cmnd
994 * @timeout: timeout for this request
995 * @sense_bytes: size of sense data to copy or 0
997 * This function is used to send a scsi command down to a target device
998 * as part of the error recovery process. See also scsi_eh_prep_cmnd() above.
1001 * SUCCESS or FAILED or NEEDS_RETRY
1003 static int scsi_send_eh_cmnd(struct scsi_cmnd *scmd, unsigned char *cmnd,
1004 int cmnd_size, int timeout, unsigned sense_bytes)
1006 struct scsi_device *sdev = scmd->device;
1007 struct Scsi_Host *shost = sdev->host;
1008 DECLARE_COMPLETION_ONSTACK(done);
1009 unsigned long timeleft = timeout;
1010 struct scsi_eh_save ses;
1011 const unsigned long stall_for = msecs_to_jiffies(100);
1015 scsi_eh_prep_cmnd(scmd, &ses, cmnd, cmnd_size, sense_bytes);
1016 shost->eh_action = &done;
1018 scsi_log_send(scmd);
1019 scmd->scsi_done = scsi_eh_done;
1020 rtn = shost->hostt->queuecommand(shost, scmd);
1022 if (timeleft > stall_for) {
1023 scsi_eh_restore_cmnd(scmd, &ses);
1024 timeleft -= stall_for;
1025 msleep(jiffies_to_msecs(stall_for));
1028 /* signal not to enter either branch of the if () below */
1032 timeleft = wait_for_completion_timeout(&done, timeout);
1036 shost->eh_action = NULL;
1038 scsi_log_completion(scmd, rtn);
1040 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1041 "%s: scmd: %p, timeleft: %ld\n",
1042 __func__, scmd, timeleft));
1045 * If there is time left scsi_eh_done got called, and we will examine
1046 * the actual status codes to see whether the command actually did
1047 * complete normally, else if we have a zero return and no time left,
1048 * the command must still be pending, so abort it and return FAILED.
1049 * If we never actually managed to issue the command, because
1050 * ->queuecommand() kept returning non zero, use the rtn = FAILED
1051 * value above (so don't execute either branch of the if)
1054 rtn = scsi_eh_completed_normally(scmd);
1055 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1056 "%s: scsi_eh_completed_normally %x\n", __func__, rtn));
1063 case ADD_TO_MLQUEUE:
1071 scsi_abort_eh_cmnd(scmd);
1075 scsi_eh_restore_cmnd(scmd, &ses);
1081 * scsi_request_sense - Request sense data from a particular target.
1082 * @scmd: SCSI cmd for request sense.
1085 * Some hosts automatically obtain this information, others require
1086 * that we obtain it on our own. This function will *not* return until
1087 * the command either times out, or it completes.
1089 static int scsi_request_sense(struct scsi_cmnd *scmd)
1091 return scsi_send_eh_cmnd(scmd, NULL, 0, scmd->device->eh_timeout, ~0);
1094 static int scsi_eh_action(struct scsi_cmnd *scmd, int rtn)
1096 if (scmd->request->cmd_type != REQ_TYPE_BLOCK_PC) {
1097 struct scsi_driver *sdrv = scsi_cmd_to_driver(scmd);
1098 if (sdrv->eh_action)
1099 rtn = sdrv->eh_action(scmd, rtn);
1105 * scsi_eh_finish_cmd - Handle a cmd that eh is finished with.
1106 * @scmd: Original SCSI cmd that eh has finished.
1107 * @done_q: Queue for processed commands.
1110 * We don't want to use the normal command completion while we are are
1111 * still handling errors - it may cause other commands to be queued,
1112 * and that would disturb what we are doing. Thus we really want to
1113 * keep a list of pending commands for final completion, and once we
1114 * are ready to leave error handling we handle completion for real.
1116 void scsi_eh_finish_cmd(struct scsi_cmnd *scmd, struct list_head *done_q)
1118 scmd->device->host->host_failed--;
1119 scmd->eh_eflags = 0;
1120 list_move_tail(&scmd->eh_entry, done_q);
1122 EXPORT_SYMBOL(scsi_eh_finish_cmd);
1125 * scsi_eh_get_sense - Get device sense data.
1126 * @work_q: Queue of commands to process.
1127 * @done_q: Queue of processed commands.
1130 * See if we need to request sense information. if so, then get it
1131 * now, so we have a better idea of what to do.
1134 * This has the unfortunate side effect that if a shost adapter does
1135 * not automatically request sense information, we end up shutting
1136 * it down before we request it.
1138 * All drivers should request sense information internally these days,
1139 * so for now all I have to say is tough noogies if you end up in here.
1141 * XXX: Long term this code should go away, but that needs an audit of
1144 int scsi_eh_get_sense(struct list_head *work_q,
1145 struct list_head *done_q)
1147 struct scsi_cmnd *scmd, *next;
1148 struct Scsi_Host *shost;
1151 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1152 if ((scmd->eh_eflags & SCSI_EH_CANCEL_CMD) ||
1153 SCSI_SENSE_VALID(scmd))
1156 shost = scmd->device->host;
1157 if (scsi_host_eh_past_deadline(shost)) {
1158 SCSI_LOG_ERROR_RECOVERY(3,
1159 shost_printk(KERN_INFO, shost,
1160 "skip %s, past eh deadline\n",
1164 if (status_byte(scmd->result) != CHECK_CONDITION)
1166 * don't request sense if there's no check condition
1167 * status because the error we're processing isn't one
1168 * that has a sense code (and some devices get
1169 * confused by sense requests out of the blue)
1173 SCSI_LOG_ERROR_RECOVERY(2, scmd_printk(KERN_INFO, scmd,
1174 "%s: requesting sense\n",
1176 rtn = scsi_request_sense(scmd);
1180 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1181 "sense requested for %p result %x\n",
1182 scmd, scmd->result));
1183 SCSI_LOG_ERROR_RECOVERY(3, scsi_print_sense("bh", scmd));
1185 rtn = scsi_decide_disposition(scmd);
1188 * if the result was normal, then just pass it along to the
1192 /* we don't want this command reissued, just
1193 * finished with the sense data, so set
1194 * retries to the max allowed to ensure it
1195 * won't get reissued */
1196 scmd->retries = scmd->allowed;
1197 else if (rtn != NEEDS_RETRY)
1200 scsi_eh_finish_cmd(scmd, done_q);
1203 return list_empty(work_q);
1205 EXPORT_SYMBOL_GPL(scsi_eh_get_sense);
1208 * scsi_eh_tur - Send TUR to device.
1209 * @scmd: &scsi_cmnd to send TUR
1212 * 0 - Device is ready. 1 - Device NOT ready.
1214 static int scsi_eh_tur(struct scsi_cmnd *scmd)
1216 static unsigned char tur_command[6] = {TEST_UNIT_READY, 0, 0, 0, 0, 0};
1217 int retry_cnt = 1, rtn;
1220 rtn = scsi_send_eh_cmnd(scmd, tur_command, 6,
1221 scmd->device->eh_timeout, 0);
1223 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1224 "%s: scmd %p rtn %x\n", __func__, scmd, rtn));
1239 * scsi_eh_test_devices - check if devices are responding from error recovery.
1240 * @cmd_list: scsi commands in error recovery.
1241 * @work_q: queue for commands which still need more error recovery
1242 * @done_q: queue for commands which are finished
1243 * @try_stu: boolean on if a STU command should be tried in addition to TUR.
1246 * Tests if devices are in a working state. Commands to devices now in
1247 * a working state are sent to the done_q while commands to devices which
1248 * are still failing to respond are returned to the work_q for more
1251 static int scsi_eh_test_devices(struct list_head *cmd_list,
1252 struct list_head *work_q,
1253 struct list_head *done_q, int try_stu)
1255 struct scsi_cmnd *scmd, *next;
1256 struct scsi_device *sdev;
1259 while (!list_empty(cmd_list)) {
1260 scmd = list_entry(cmd_list->next, struct scsi_cmnd, eh_entry);
1261 sdev = scmd->device;
1264 if (scsi_host_eh_past_deadline(sdev->host)) {
1265 /* Push items back onto work_q */
1266 list_splice_init(cmd_list, work_q);
1267 SCSI_LOG_ERROR_RECOVERY(3,
1268 shost_printk(KERN_INFO, sdev->host,
1269 "skip %s, past eh deadline",
1275 finish_cmds = !scsi_device_online(scmd->device) ||
1276 (try_stu && !scsi_eh_try_stu(scmd) &&
1277 !scsi_eh_tur(scmd)) ||
1280 list_for_each_entry_safe(scmd, next, cmd_list, eh_entry)
1281 if (scmd->device == sdev) {
1284 scsi_eh_action(scmd, SUCCESS) == SUCCESS))
1285 scsi_eh_finish_cmd(scmd, done_q);
1287 list_move_tail(&scmd->eh_entry, work_q);
1290 return list_empty(work_q);
1295 * scsi_eh_abort_cmds - abort pending commands.
1296 * @work_q: &list_head for pending commands.
1297 * @done_q: &list_head for processed commands.
1300 * Try and see whether or not it makes sense to try and abort the
1301 * running command. This only works out to be the case if we have one
1302 * command that has timed out. If the command simply failed, it makes
1303 * no sense to try and abort the command, since as far as the shost
1304 * adapter is concerned, it isn't running.
1306 static int scsi_eh_abort_cmds(struct list_head *work_q,
1307 struct list_head *done_q)
1309 struct scsi_cmnd *scmd, *next;
1310 LIST_HEAD(check_list);
1312 struct Scsi_Host *shost;
1314 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1315 if (!(scmd->eh_eflags & SCSI_EH_CANCEL_CMD))
1317 shost = scmd->device->host;
1318 if (scsi_host_eh_past_deadline(shost)) {
1319 list_splice_init(&check_list, work_q);
1320 SCSI_LOG_ERROR_RECOVERY(3,
1321 shost_printk(KERN_INFO, shost,
1322 "skip %s, past eh deadline\n",
1324 return list_empty(work_q);
1326 SCSI_LOG_ERROR_RECOVERY(3,
1327 shost_printk(KERN_INFO, shost,
1328 "%s: aborting cmd: 0x%p\n",
1329 current->comm, scmd));
1330 rtn = scsi_try_to_abort_cmd(shost->hostt, scmd);
1331 if (rtn == FAILED) {
1332 SCSI_LOG_ERROR_RECOVERY(3,
1333 shost_printk(KERN_INFO, shost,
1334 "%s: aborting cmd failed: 0x%p\n",
1335 current->comm, scmd));
1336 list_splice_init(&check_list, work_q);
1337 return list_empty(work_q);
1339 scmd->eh_eflags &= ~SCSI_EH_CANCEL_CMD;
1340 if (rtn == FAST_IO_FAIL)
1341 scsi_eh_finish_cmd(scmd, done_q);
1343 list_move_tail(&scmd->eh_entry, &check_list);
1346 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1350 * scsi_eh_try_stu - Send START_UNIT to device.
1351 * @scmd: &scsi_cmnd to send START_UNIT
1354 * 0 - Device is ready. 1 - Device NOT ready.
1356 static int scsi_eh_try_stu(struct scsi_cmnd *scmd)
1358 static unsigned char stu_command[6] = {START_STOP, 0, 0, 0, 1, 0};
1360 if (scmd->device->allow_restart) {
1361 int i, rtn = NEEDS_RETRY;
1363 for (i = 0; rtn == NEEDS_RETRY && i < 2; i++)
1364 rtn = scsi_send_eh_cmnd(scmd, stu_command, 6, scmd->device->request_queue->rq_timeout, 0);
1374 * scsi_eh_stu - send START_UNIT if needed
1375 * @shost: &scsi host being recovered.
1376 * @work_q: &list_head for pending commands.
1377 * @done_q: &list_head for processed commands.
1380 * If commands are failing due to not ready, initializing command required,
1381 * try revalidating the device, which will end up sending a start unit.
1383 static int scsi_eh_stu(struct Scsi_Host *shost,
1384 struct list_head *work_q,
1385 struct list_head *done_q)
1387 struct scsi_cmnd *scmd, *stu_scmd, *next;
1388 struct scsi_device *sdev;
1390 shost_for_each_device(sdev, shost) {
1391 if (scsi_host_eh_past_deadline(shost)) {
1392 SCSI_LOG_ERROR_RECOVERY(3,
1393 shost_printk(KERN_INFO, shost,
1394 "skip %s, past eh deadline\n",
1399 list_for_each_entry(scmd, work_q, eh_entry)
1400 if (scmd->device == sdev && SCSI_SENSE_VALID(scmd) &&
1401 scsi_check_sense(scmd) == FAILED ) {
1409 SCSI_LOG_ERROR_RECOVERY(3,
1410 shost_printk(KERN_INFO, shost,
1411 "%s: Sending START_UNIT to sdev: 0x%p\n",
1412 current->comm, sdev));
1414 if (!scsi_eh_try_stu(stu_scmd)) {
1415 if (!scsi_device_online(sdev) ||
1416 !scsi_eh_tur(stu_scmd)) {
1417 list_for_each_entry_safe(scmd, next,
1419 if (scmd->device == sdev &&
1420 scsi_eh_action(scmd, SUCCESS) == SUCCESS)
1421 scsi_eh_finish_cmd(scmd, done_q);
1425 SCSI_LOG_ERROR_RECOVERY(3,
1426 shost_printk(KERN_INFO, shost,
1427 "%s: START_UNIT failed to sdev:"
1428 " 0x%p\n", current->comm, sdev));
1432 return list_empty(work_q);
1437 * scsi_eh_bus_device_reset - send bdr if needed
1438 * @shost: scsi host being recovered.
1439 * @work_q: &list_head for pending commands.
1440 * @done_q: &list_head for processed commands.
1443 * Try a bus device reset. Still, look to see whether we have multiple
1444 * devices that are jammed or not - if we have multiple devices, it
1445 * makes no sense to try bus_device_reset - we really would need to try
1446 * a bus_reset instead.
1448 static int scsi_eh_bus_device_reset(struct Scsi_Host *shost,
1449 struct list_head *work_q,
1450 struct list_head *done_q)
1452 struct scsi_cmnd *scmd, *bdr_scmd, *next;
1453 struct scsi_device *sdev;
1456 shost_for_each_device(sdev, shost) {
1457 if (scsi_host_eh_past_deadline(shost)) {
1458 SCSI_LOG_ERROR_RECOVERY(3,
1459 shost_printk(KERN_INFO, shost,
1460 "skip %s, past eh deadline\n",
1465 list_for_each_entry(scmd, work_q, eh_entry)
1466 if (scmd->device == sdev) {
1474 SCSI_LOG_ERROR_RECOVERY(3,
1475 shost_printk(KERN_INFO, shost,
1476 "%s: Sending BDR sdev: 0x%p\n",
1477 current->comm, sdev));
1478 rtn = scsi_try_bus_device_reset(bdr_scmd);
1479 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
1480 if (!scsi_device_online(sdev) ||
1481 rtn == FAST_IO_FAIL ||
1482 !scsi_eh_tur(bdr_scmd)) {
1483 list_for_each_entry_safe(scmd, next,
1485 if (scmd->device == sdev &&
1486 scsi_eh_action(scmd, rtn) != FAILED)
1487 scsi_eh_finish_cmd(scmd,
1492 SCSI_LOG_ERROR_RECOVERY(3,
1493 shost_printk(KERN_INFO, shost,
1494 "%s: BDR failed sdev: 0x%p\n",
1495 current->comm, sdev));
1499 return list_empty(work_q);
1503 * scsi_eh_target_reset - send target reset if needed
1504 * @shost: scsi host being recovered.
1505 * @work_q: &list_head for pending commands.
1506 * @done_q: &list_head for processed commands.
1509 * Try a target reset.
1511 static int scsi_eh_target_reset(struct Scsi_Host *shost,
1512 struct list_head *work_q,
1513 struct list_head *done_q)
1515 LIST_HEAD(tmp_list);
1516 LIST_HEAD(check_list);
1518 list_splice_init(work_q, &tmp_list);
1520 while (!list_empty(&tmp_list)) {
1521 struct scsi_cmnd *next, *scmd;
1525 if (scsi_host_eh_past_deadline(shost)) {
1526 /* push back on work queue for further processing */
1527 list_splice_init(&check_list, work_q);
1528 list_splice_init(&tmp_list, work_q);
1529 SCSI_LOG_ERROR_RECOVERY(3,
1530 shost_printk(KERN_INFO, shost,
1531 "skip %s, past eh deadline\n",
1533 return list_empty(work_q);
1536 scmd = list_entry(tmp_list.next, struct scsi_cmnd, eh_entry);
1539 SCSI_LOG_ERROR_RECOVERY(3,
1540 shost_printk(KERN_INFO, shost,
1541 "%s: Sending target reset to target %d\n",
1542 current->comm, id));
1543 rtn = scsi_try_target_reset(scmd);
1544 if (rtn != SUCCESS && rtn != FAST_IO_FAIL)
1545 SCSI_LOG_ERROR_RECOVERY(3,
1546 shost_printk(KERN_INFO, shost,
1547 "%s: Target reset failed"
1549 current->comm, id));
1550 list_for_each_entry_safe(scmd, next, &tmp_list, eh_entry) {
1551 if (scmd_id(scmd) != id)
1555 list_move_tail(&scmd->eh_entry, &check_list);
1556 else if (rtn == FAST_IO_FAIL)
1557 scsi_eh_finish_cmd(scmd, done_q);
1559 /* push back on work queue for further processing */
1560 list_move(&scmd->eh_entry, work_q);
1564 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1568 * scsi_eh_bus_reset - send a bus reset
1569 * @shost: &scsi host being recovered.
1570 * @work_q: &list_head for pending commands.
1571 * @done_q: &list_head for processed commands.
1573 static int scsi_eh_bus_reset(struct Scsi_Host *shost,
1574 struct list_head *work_q,
1575 struct list_head *done_q)
1577 struct scsi_cmnd *scmd, *chan_scmd, *next;
1578 LIST_HEAD(check_list);
1579 unsigned int channel;
1583 * we really want to loop over the various channels, and do this on
1584 * a channel by channel basis. we should also check to see if any
1585 * of the failed commands are on soft_reset devices, and if so, skip
1589 for (channel = 0; channel <= shost->max_channel; channel++) {
1590 if (scsi_host_eh_past_deadline(shost)) {
1591 list_splice_init(&check_list, work_q);
1592 SCSI_LOG_ERROR_RECOVERY(3,
1593 shost_printk(KERN_INFO, shost,
1594 "skip %s, past eh deadline\n",
1596 return list_empty(work_q);
1600 list_for_each_entry(scmd, work_q, eh_entry) {
1601 if (channel == scmd_channel(scmd)) {
1605 * FIXME add back in some support for
1606 * soft_reset devices.
1613 SCSI_LOG_ERROR_RECOVERY(3,
1614 shost_printk(KERN_INFO, shost,
1615 "%s: Sending BRST chan: %d\n",
1616 current->comm, channel));
1617 rtn = scsi_try_bus_reset(chan_scmd);
1618 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
1619 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1620 if (channel == scmd_channel(scmd)) {
1621 if (rtn == FAST_IO_FAIL)
1622 scsi_eh_finish_cmd(scmd,
1625 list_move_tail(&scmd->eh_entry,
1630 SCSI_LOG_ERROR_RECOVERY(3,
1631 shost_printk(KERN_INFO, shost,
1632 "%s: BRST failed chan: %d\n",
1633 current->comm, channel));
1636 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
1640 * scsi_eh_host_reset - send a host reset
1641 * @shost: host to be reset.
1642 * @work_q: &list_head for pending commands.
1643 * @done_q: &list_head for processed commands.
1645 static int scsi_eh_host_reset(struct Scsi_Host *shost,
1646 struct list_head *work_q,
1647 struct list_head *done_q)
1649 struct scsi_cmnd *scmd, *next;
1650 LIST_HEAD(check_list);
1653 if (!list_empty(work_q)) {
1654 scmd = list_entry(work_q->next,
1655 struct scsi_cmnd, eh_entry);
1657 SCSI_LOG_ERROR_RECOVERY(3,
1658 shost_printk(KERN_INFO, shost,
1659 "%s: Sending HRST\n",
1662 rtn = scsi_try_host_reset(scmd);
1663 if (rtn == SUCCESS) {
1664 list_splice_init(work_q, &check_list);
1665 } else if (rtn == FAST_IO_FAIL) {
1666 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1667 scsi_eh_finish_cmd(scmd, done_q);
1670 SCSI_LOG_ERROR_RECOVERY(3,
1671 shost_printk(KERN_INFO, shost,
1672 "%s: HRST failed\n",
1676 return scsi_eh_test_devices(&check_list, work_q, done_q, 1);
1680 * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
1681 * @work_q: &list_head for pending commands.
1682 * @done_q: &list_head for processed commands.
1684 static void scsi_eh_offline_sdevs(struct list_head *work_q,
1685 struct list_head *done_q)
1687 struct scsi_cmnd *scmd, *next;
1689 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
1690 sdev_printk(KERN_INFO, scmd->device, "Device offlined - "
1691 "not ready after error recovery\n");
1692 scsi_device_set_state(scmd->device, SDEV_OFFLINE);
1693 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD) {
1695 * FIXME: Handle lost cmds.
1698 scsi_eh_finish_cmd(scmd, done_q);
1704 * scsi_noretry_cmd - determine if command should be failed fast
1705 * @scmd: SCSI cmd to examine.
1707 int scsi_noretry_cmd(struct scsi_cmnd *scmd)
1709 switch (host_byte(scmd->result)) {
1715 return (scmd->request->cmd_flags & REQ_FAILFAST_TRANSPORT);
1717 return (scmd->request->cmd_flags & REQ_FAILFAST_DEV);
1719 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1720 status_byte(scmd->result) == RESERVATION_CONFLICT)
1723 case DID_SOFT_ERROR:
1724 return (scmd->request->cmd_flags & REQ_FAILFAST_DRIVER);
1727 if (status_byte(scmd->result) != CHECK_CONDITION)
1732 * assume caller has checked sense and determined
1733 * the check condition was retryable.
1735 if (scmd->request->cmd_flags & REQ_FAILFAST_DEV ||
1736 scmd->request->cmd_type == REQ_TYPE_BLOCK_PC)
1743 * scsi_decide_disposition - Disposition a cmd on return from LLD.
1744 * @scmd: SCSI cmd to examine.
1747 * This is *only* called when we are examining the status after sending
1748 * out the actual data command. any commands that are queued for error
1749 * recovery (e.g. test_unit_ready) do *not* come through here.
1751 * When this routine returns failed, it means the error handler thread
1752 * is woken. In cases where the error code indicates an error that
1753 * doesn't require the error handler read (i.e. we don't need to
1754 * abort/reset), this function should return SUCCESS.
1756 int scsi_decide_disposition(struct scsi_cmnd *scmd)
1761 * if the device is offline, then we clearly just pass the result back
1762 * up to the top level.
1764 if (!scsi_device_online(scmd->device)) {
1765 SCSI_LOG_ERROR_RECOVERY(5, scmd_printk(KERN_INFO, scmd,
1766 "%s: device offline - report as SUCCESS\n", __func__));
1771 * first check the host byte, to see if there is anything in there
1772 * that would indicate what we need to do.
1774 switch (host_byte(scmd->result)) {
1775 case DID_PASSTHROUGH:
1777 * no matter what, pass this through to the upper layer.
1778 * nuke this special code so that it looks like we are saying
1781 scmd->result &= 0xff00ffff;
1785 * looks good. drop through, and check the next byte.
1789 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
1790 set_host_byte(scmd, DID_TIME_OUT);
1793 case DID_NO_CONNECT:
1794 case DID_BAD_TARGET:
1796 * note - this means that we just report the status back
1797 * to the top level driver, not that we actually think
1798 * that it indicates SUCCESS.
1802 * when the low level driver returns did_soft_error,
1803 * it is responsible for keeping an internal retry counter
1804 * in order to avoid endless loops (db)
1806 * actually this is a bug in this function here. we should
1807 * be mindful of the maximum number of retries specified
1808 * and not get stuck in a loop.
1810 case DID_SOFT_ERROR:
1816 return ADD_TO_MLQUEUE;
1817 case DID_TRANSPORT_DISRUPTED:
1819 * LLD/transport was disrupted during processing of the IO.
1820 * The transport class is now blocked/blocking,
1821 * and the transport will decide what to do with the IO
1822 * based on its timers and recovery capablilities if
1823 * there are enough retries.
1826 case DID_TRANSPORT_FAILFAST:
1828 * The transport decided to failfast the IO (most likely
1829 * the fast io fail tmo fired), so send IO directly upwards.
1833 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1834 status_byte(scmd->result) == RESERVATION_CONFLICT)
1836 * execute reservation conflict processing code
1846 * when we scan the bus, we get timeout messages for
1847 * these commands if there is no device available.
1848 * other hosts report did_no_connect for the same thing.
1850 if ((scmd->cmnd[0] == TEST_UNIT_READY ||
1851 scmd->cmnd[0] == INQUIRY)) {
1863 * next, check the message byte.
1865 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
1869 * check the status byte to see if this indicates anything special.
1871 switch (status_byte(scmd->result)) {
1873 scsi_handle_queue_full(scmd->device);
1875 * the case of trying to send too many commands to a
1876 * tagged queueing device.
1880 * device can't talk to us at the moment. Should only
1881 * occur (SAM-3) when the task queue is empty, so will cause
1882 * the empty queue handling to trigger a stall in the
1885 return ADD_TO_MLQUEUE;
1887 if (scmd->cmnd[0] == REPORT_LUNS)
1888 scmd->device->sdev_target->expecting_lun_change = 0;
1889 scsi_handle_queue_ramp_up(scmd->device);
1890 case COMMAND_TERMINATED:
1894 case CHECK_CONDITION:
1895 rtn = scsi_check_sense(scmd);
1896 if (rtn == NEEDS_RETRY)
1898 /* if rtn == FAILED, we have no sense information;
1899 * returning FAILED will wake the error handler thread
1900 * to collect the sense and redo the decide
1903 case CONDITION_GOOD:
1904 case INTERMEDIATE_GOOD:
1905 case INTERMEDIATE_C_GOOD:
1908 * who knows? FIXME(eric)
1912 case RESERVATION_CONFLICT:
1913 sdev_printk(KERN_INFO, scmd->device,
1914 "reservation conflict\n");
1915 set_host_byte(scmd, DID_NEXUS_FAILURE);
1916 return SUCCESS; /* causes immediate i/o error */
1924 /* we requeue for retry because the error was retryable, and
1925 * the request was not marked fast fail. Note that above,
1926 * even if the request is marked fast fail, we still requeue
1927 * for queue congestion conditions (QUEUE_FULL or BUSY) */
1928 if ((++scmd->retries) <= scmd->allowed
1929 && !scsi_noretry_cmd(scmd)) {
1933 * no more retries - report this one back to upper level.
1939 static void eh_lock_door_done(struct request *req, int uptodate)
1941 __blk_put_request(req->q, req);
1945 * scsi_eh_lock_door - Prevent medium removal for the specified device
1946 * @sdev: SCSI device to prevent medium removal
1949 * We must be called from process context.
1952 * We queue up an asynchronous "ALLOW MEDIUM REMOVAL" request on the
1953 * head of the devices request queue, and continue.
1955 static void scsi_eh_lock_door(struct scsi_device *sdev)
1957 struct request *req;
1960 * blk_get_request with GFP_KERNEL (__GFP_WAIT) sleeps until a
1961 * request becomes available
1963 req = blk_get_request(sdev->request_queue, READ, GFP_KERNEL);
1967 blk_rq_set_block_pc(req);
1969 req->cmd[0] = ALLOW_MEDIUM_REMOVAL;
1973 req->cmd[4] = SCSI_REMOVAL_PREVENT;
1976 req->cmd_len = COMMAND_SIZE(req->cmd[0]);
1978 req->cmd_flags |= REQ_QUIET;
1979 req->timeout = 10 * HZ;
1982 blk_execute_rq_nowait(req->q, NULL, req, 1, eh_lock_door_done);
1986 * scsi_restart_operations - restart io operations to the specified host.
1987 * @shost: Host we are restarting.
1990 * When we entered the error handler, we blocked all further i/o to
1991 * this device. we need to 'reverse' this process.
1993 static void scsi_restart_operations(struct Scsi_Host *shost)
1995 struct scsi_device *sdev;
1996 unsigned long flags;
1999 * If the door was locked, we need to insert a door lock request
2000 * onto the head of the SCSI request queue for the device. There
2001 * is no point trying to lock the door of an off-line device.
2003 shost_for_each_device(sdev, shost) {
2004 if (scsi_device_online(sdev) && sdev->locked)
2005 scsi_eh_lock_door(sdev);
2009 * next free up anything directly waiting upon the host. this
2010 * will be requests for character device operations, and also for
2011 * ioctls to queued block devices.
2013 SCSI_LOG_ERROR_RECOVERY(3,
2014 shost_printk(KERN_INFO, shost, "waking up host to restart\n"));
2016 spin_lock_irqsave(shost->host_lock, flags);
2017 if (scsi_host_set_state(shost, SHOST_RUNNING))
2018 if (scsi_host_set_state(shost, SHOST_CANCEL))
2019 BUG_ON(scsi_host_set_state(shost, SHOST_DEL));
2020 spin_unlock_irqrestore(shost->host_lock, flags);
2022 wake_up(&shost->host_wait);
2025 * finally we need to re-initiate requests that may be pending. we will
2026 * have had everything blocked while error handling is taking place, and
2027 * now that error recovery is done, we will need to ensure that these
2028 * requests are started.
2030 scsi_run_host_queues(shost);
2033 * if eh is active and host_eh_scheduled is pending we need to re-run
2034 * recovery. we do this check after scsi_run_host_queues() to allow
2035 * everything pent up since the last eh run a chance to make forward
2036 * progress before we sync again. Either we'll immediately re-run
2037 * recovery or scsi_device_unbusy() will wake us again when these
2038 * pending commands complete.
2040 spin_lock_irqsave(shost->host_lock, flags);
2041 if (shost->host_eh_scheduled)
2042 if (scsi_host_set_state(shost, SHOST_RECOVERY))
2043 WARN_ON(scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY));
2044 spin_unlock_irqrestore(shost->host_lock, flags);
2048 * scsi_eh_ready_devs - check device ready state and recover if not.
2049 * @shost: host to be recovered.
2050 * @work_q: &list_head for pending commands.
2051 * @done_q: &list_head for processed commands.
2053 void scsi_eh_ready_devs(struct Scsi_Host *shost,
2054 struct list_head *work_q,
2055 struct list_head *done_q)
2057 if (!scsi_eh_stu(shost, work_q, done_q))
2058 if (!scsi_eh_bus_device_reset(shost, work_q, done_q))
2059 if (!scsi_eh_target_reset(shost, work_q, done_q))
2060 if (!scsi_eh_bus_reset(shost, work_q, done_q))
2061 if (!scsi_eh_host_reset(shost, work_q, done_q))
2062 scsi_eh_offline_sdevs(work_q,
2065 EXPORT_SYMBOL_GPL(scsi_eh_ready_devs);
2068 * scsi_eh_flush_done_q - finish processed commands or retry them.
2069 * @done_q: list_head of processed commands.
2071 void scsi_eh_flush_done_q(struct list_head *done_q)
2073 struct scsi_cmnd *scmd, *next;
2075 list_for_each_entry_safe(scmd, next, done_q, eh_entry) {
2076 list_del_init(&scmd->eh_entry);
2077 if (scsi_device_online(scmd->device) &&
2078 !scsi_noretry_cmd(scmd) &&
2079 (++scmd->retries <= scmd->allowed)) {
2080 SCSI_LOG_ERROR_RECOVERY(3,
2081 scmd_printk(KERN_INFO, scmd,
2082 "%s: flush retry cmd: %p\n",
2083 current->comm, scmd));
2084 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
2087 * If just we got sense for the device (called
2088 * scsi_eh_get_sense), scmd->result is already
2089 * set, do not set DRIVER_TIMEOUT.
2092 scmd->result |= (DRIVER_TIMEOUT << 24);
2093 SCSI_LOG_ERROR_RECOVERY(3,
2094 scmd_printk(KERN_INFO, scmd,
2095 "%s: flush finish cmd: %p\n",
2096 current->comm, scmd));
2097 scsi_finish_command(scmd);
2101 EXPORT_SYMBOL(scsi_eh_flush_done_q);
2104 * scsi_unjam_host - Attempt to fix a host which has a cmd that failed.
2105 * @shost: Host to unjam.
2108 * When we come in here, we *know* that all commands on the bus have
2109 * either completed, failed or timed out. we also know that no further
2110 * commands are being sent to the host, so things are relatively quiet
2111 * and we have freedom to fiddle with things as we wish.
2113 * This is only the *default* implementation. it is possible for
2114 * individual drivers to supply their own version of this function, and
2115 * if the maintainer wishes to do this, it is strongly suggested that
2116 * this function be taken as a template and modified. this function
2117 * was designed to correctly handle problems for about 95% of the
2118 * different cases out there, and it should always provide at least a
2119 * reasonable amount of error recovery.
2121 * Any command marked 'failed' or 'timeout' must eventually have
2122 * scsi_finish_cmd() called for it. we do all of the retry stuff
2123 * here, so when we restart the host after we return it should have an
2126 static void scsi_unjam_host(struct Scsi_Host *shost)
2128 unsigned long flags;
2129 LIST_HEAD(eh_work_q);
2130 LIST_HEAD(eh_done_q);
2132 spin_lock_irqsave(shost->host_lock, flags);
2133 list_splice_init(&shost->eh_cmd_q, &eh_work_q);
2134 spin_unlock_irqrestore(shost->host_lock, flags);
2136 SCSI_LOG_ERROR_RECOVERY(1, scsi_eh_prt_fail_stats(shost, &eh_work_q));
2138 if (!scsi_eh_get_sense(&eh_work_q, &eh_done_q))
2139 if (!scsi_eh_abort_cmds(&eh_work_q, &eh_done_q))
2140 scsi_eh_ready_devs(shost, &eh_work_q, &eh_done_q);
2142 spin_lock_irqsave(shost->host_lock, flags);
2143 if (shost->eh_deadline != -1)
2144 shost->last_reset = 0;
2145 spin_unlock_irqrestore(shost->host_lock, flags);
2146 scsi_eh_flush_done_q(&eh_done_q);
2150 * scsi_error_handler - SCSI error handler thread
2151 * @data: Host for which we are running.
2154 * This is the main error handling loop. This is run as a kernel thread
2155 * for every SCSI host and handles all error handling activity.
2157 int scsi_error_handler(void *data)
2159 struct Scsi_Host *shost = data;
2162 * We use TASK_INTERRUPTIBLE so that the thread is not
2163 * counted against the load average as a running process.
2164 * We never actually get interrupted because kthread_run
2165 * disables signal delivery for the created thread.
2167 while (!kthread_should_stop()) {
2168 set_current_state(TASK_INTERRUPTIBLE);
2169 if ((shost->host_failed == 0 && shost->host_eh_scheduled == 0) ||
2170 shost->host_failed != atomic_read(&shost->host_busy)) {
2171 SCSI_LOG_ERROR_RECOVERY(1,
2172 shost_printk(KERN_INFO, shost,
2173 "scsi_eh_%d: sleeping\n",
2179 __set_current_state(TASK_RUNNING);
2180 SCSI_LOG_ERROR_RECOVERY(1,
2181 shost_printk(KERN_INFO, shost,
2182 "scsi_eh_%d: waking up %d/%d/%d\n",
2183 shost->host_no, shost->host_eh_scheduled,
2185 atomic_read(&shost->host_busy)));
2188 * We have a host that is failing for some reason. Figure out
2189 * what we need to do to get it up and online again (if we can).
2190 * If we fail, we end up taking the thing offline.
2192 if (!shost->eh_noresume && scsi_autopm_get_host(shost) != 0) {
2193 SCSI_LOG_ERROR_RECOVERY(1,
2194 printk(KERN_ERR "Error handler scsi_eh_%d "
2195 "unable to autoresume\n",
2200 if (shost->transportt->eh_strategy_handler)
2201 shost->transportt->eh_strategy_handler(shost);
2203 scsi_unjam_host(shost);
2206 * Note - if the above fails completely, the action is to take
2207 * individual devices offline and flush the queue of any
2208 * outstanding requests that may have been pending. When we
2209 * restart, we restart any I/O to any other devices on the bus
2210 * which are still online.
2212 scsi_restart_operations(shost);
2213 if (!shost->eh_noresume)
2214 scsi_autopm_put_host(shost);
2216 __set_current_state(TASK_RUNNING);
2218 SCSI_LOG_ERROR_RECOVERY(1,
2219 shost_printk(KERN_INFO, shost,
2220 "Error handler scsi_eh_%d exiting\n",
2222 shost->ehandler = NULL;
2227 * Function: scsi_report_bus_reset()
2229 * Purpose: Utility function used by low-level drivers to report that
2230 * they have observed a bus reset on the bus being handled.
2232 * Arguments: shost - Host in question
2233 * channel - channel on which reset was observed.
2237 * Lock status: Host lock must be held.
2239 * Notes: This only needs to be called if the reset is one which
2240 * originates from an unknown location. Resets originated
2241 * by the mid-level itself don't need to call this, but there
2242 * should be no harm.
2244 * The main purpose of this is to make sure that a CHECK_CONDITION
2245 * is properly treated.
2247 void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
2249 struct scsi_device *sdev;
2251 __shost_for_each_device(sdev, shost) {
2252 if (channel == sdev_channel(sdev))
2253 __scsi_report_device_reset(sdev, NULL);
2256 EXPORT_SYMBOL(scsi_report_bus_reset);
2259 * Function: scsi_report_device_reset()
2261 * Purpose: Utility function used by low-level drivers to report that
2262 * they have observed a device reset on the device being handled.
2264 * Arguments: shost - Host in question
2265 * channel - channel on which reset was observed
2266 * target - target on which reset was observed
2270 * Lock status: Host lock must be held
2272 * Notes: This only needs to be called if the reset is one which
2273 * originates from an unknown location. Resets originated
2274 * by the mid-level itself don't need to call this, but there
2275 * should be no harm.
2277 * The main purpose of this is to make sure that a CHECK_CONDITION
2278 * is properly treated.
2280 void scsi_report_device_reset(struct Scsi_Host *shost, int channel, int target)
2282 struct scsi_device *sdev;
2284 __shost_for_each_device(sdev, shost) {
2285 if (channel == sdev_channel(sdev) &&
2286 target == sdev_id(sdev))
2287 __scsi_report_device_reset(sdev, NULL);
2290 EXPORT_SYMBOL(scsi_report_device_reset);
2293 scsi_reset_provider_done_command(struct scsi_cmnd *scmd)
2298 * Function: scsi_reset_provider
2300 * Purpose: Send requested reset to a bus or device at any phase.
2302 * Arguments: device - device to send reset to
2303 * flag - reset type (see scsi.h)
2305 * Returns: SUCCESS/FAILURE.
2307 * Notes: This is used by the SCSI Generic driver to provide
2308 * Bus/Device reset capability.
2311 scsi_reset_provider(struct scsi_device *dev, int flag)
2313 struct scsi_cmnd *scmd;
2314 struct Scsi_Host *shost = dev->host;
2316 unsigned long flags;
2319 if (scsi_autopm_get_host(shost) < 0)
2322 if (!get_device(&dev->sdev_gendev)) {
2324 goto out_put_autopm_host;
2327 scmd = scsi_get_command(dev, GFP_KERNEL);
2330 put_device(&dev->sdev_gendev);
2331 goto out_put_autopm_host;
2334 blk_rq_init(NULL, &req);
2335 scmd->request = &req;
2337 scmd->cmnd = req.cmd;
2339 scmd->scsi_done = scsi_reset_provider_done_command;
2340 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
2344 scmd->sc_data_direction = DMA_BIDIRECTIONAL;
2346 spin_lock_irqsave(shost->host_lock, flags);
2347 shost->tmf_in_progress = 1;
2348 spin_unlock_irqrestore(shost->host_lock, flags);
2351 case SCSI_TRY_RESET_DEVICE:
2352 rtn = scsi_try_bus_device_reset(scmd);
2356 case SCSI_TRY_RESET_TARGET:
2357 rtn = scsi_try_target_reset(scmd);
2361 case SCSI_TRY_RESET_BUS:
2362 rtn = scsi_try_bus_reset(scmd);
2366 case SCSI_TRY_RESET_HOST:
2367 rtn = scsi_try_host_reset(scmd);
2373 spin_lock_irqsave(shost->host_lock, flags);
2374 shost->tmf_in_progress = 0;
2375 spin_unlock_irqrestore(shost->host_lock, flags);
2378 * be sure to wake up anyone who was sleeping or had their queue
2379 * suspended while we performed the TMF.
2381 SCSI_LOG_ERROR_RECOVERY(3,
2382 shost_printk(KERN_INFO, shost,
2383 "waking up host to restart after TMF\n"));
2385 wake_up(&shost->host_wait);
2387 scsi_run_host_queues(shost);
2389 scsi_next_command(scmd);
2390 out_put_autopm_host:
2391 scsi_autopm_put_host(shost);
2394 EXPORT_SYMBOL(scsi_reset_provider);
2397 * scsi_normalize_sense - normalize main elements from either fixed or
2398 * descriptor sense data format into a common format.
2400 * @sense_buffer: byte array containing sense data returned by device
2401 * @sb_len: number of valid bytes in sense_buffer
2402 * @sshdr: pointer to instance of structure that common
2403 * elements are written to.
2406 * The "main elements" from sense data are: response_code, sense_key,
2407 * asc, ascq and additional_length (only for descriptor format).
2409 * Typically this function can be called after a device has
2410 * responded to a SCSI command with the CHECK_CONDITION status.
2413 * 1 if valid sense data information found, else 0;
2415 int scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
2416 struct scsi_sense_hdr *sshdr)
2418 if (!sense_buffer || !sb_len)
2421 memset(sshdr, 0, sizeof(struct scsi_sense_hdr));
2423 sshdr->response_code = (sense_buffer[0] & 0x7f);
2425 if (!scsi_sense_valid(sshdr))
2428 if (sshdr->response_code >= 0x72) {
2433 sshdr->sense_key = (sense_buffer[1] & 0xf);
2435 sshdr->asc = sense_buffer[2];
2437 sshdr->ascq = sense_buffer[3];
2439 sshdr->additional_length = sense_buffer[7];
2445 sshdr->sense_key = (sense_buffer[2] & 0xf);
2447 sb_len = (sb_len < (sense_buffer[7] + 8)) ?
2448 sb_len : (sense_buffer[7] + 8);
2450 sshdr->asc = sense_buffer[12];
2452 sshdr->ascq = sense_buffer[13];
2458 EXPORT_SYMBOL(scsi_normalize_sense);
2460 int scsi_command_normalize_sense(struct scsi_cmnd *cmd,
2461 struct scsi_sense_hdr *sshdr)
2463 return scsi_normalize_sense(cmd->sense_buffer,
2464 SCSI_SENSE_BUFFERSIZE, sshdr);
2466 EXPORT_SYMBOL(scsi_command_normalize_sense);
2469 * scsi_sense_desc_find - search for a given descriptor type in descriptor sense data format.
2470 * @sense_buffer: byte array of descriptor format sense data
2471 * @sb_len: number of valid bytes in sense_buffer
2472 * @desc_type: value of descriptor type to find
2473 * (e.g. 0 -> information)
2476 * only valid when sense data is in descriptor format
2479 * pointer to start of (first) descriptor if found else NULL
2481 const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
2484 int add_sen_len, add_len, desc_len, k;
2487 if ((sb_len < 8) || (0 == (add_sen_len = sense_buffer[7])))
2489 if ((sense_buffer[0] < 0x72) || (sense_buffer[0] > 0x73))
2491 add_sen_len = (add_sen_len < (sb_len - 8)) ?
2492 add_sen_len : (sb_len - 8);
2493 descp = &sense_buffer[8];
2494 for (desc_len = 0, k = 0; k < add_sen_len; k += desc_len) {
2496 add_len = (k < (add_sen_len - 1)) ? descp[1]: -1;
2497 desc_len = add_len + 2;
2498 if (descp[0] == desc_type)
2500 if (add_len < 0) // short descriptor ??
2505 EXPORT_SYMBOL(scsi_sense_desc_find);
2508 * scsi_get_sense_info_fld - get information field from sense data (either fixed or descriptor format)
2509 * @sense_buffer: byte array of sense data
2510 * @sb_len: number of valid bytes in sense_buffer
2511 * @info_out: pointer to 64 integer where 8 or 4 byte information
2512 * field will be placed if found.
2515 * 1 if information field found, 0 if not found.
2517 int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
2526 switch (sense_buffer[0] & 0x7f) {
2529 if (sense_buffer[0] & 0x80) {
2530 *info_out = (sense_buffer[3] << 24) +
2531 (sense_buffer[4] << 16) +
2532 (sense_buffer[5] << 8) + sense_buffer[6];
2538 ucp = scsi_sense_desc_find(sense_buffer, sb_len,
2540 if (ucp && (0xa == ucp[1])) {
2542 for (j = 0; j < 8; ++j) {
2555 EXPORT_SYMBOL(scsi_get_sense_info_fld);
2558 * scsi_build_sense_buffer - build sense data in a buffer
2559 * @desc: Sense format (non zero == descriptor format,
2560 * 0 == fixed format)
2561 * @buf: Where to build sense data
2563 * @asc: Additional sense code
2564 * @ascq: Additional sense code qualifier
2567 void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq)
2570 buf[0] = 0x72; /* descriptor, current */
2576 buf[0] = 0x70; /* fixed, current */
2583 EXPORT_SYMBOL(scsi_build_sense_buffer);