blob: 2dce06a58c08292ab42dc001b8f84aac4605d600 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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/timer.h>
20#include <linux/string.h>
21#include <linux/slab.h>
22#include <linux/kernel.h>
Christoph Hellwigc5478de2005-09-06 14:04:26 +020023#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/interrupt.h>
25#include <linux/blkdev.h>
26#include <linux/delay.h>
27
28#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020029#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <scsi/scsi_dbg.h>
31#include <scsi/scsi_device.h>
32#include <scsi/scsi_eh.h>
James Smartc829c392006-03-13 08:28:57 -050033#include <scsi/scsi_transport.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <scsi/scsi_host.h>
35#include <scsi/scsi_ioctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37#include "scsi_priv.h"
38#include "scsi_logging.h"
39
40#define SENSE_TIMEOUT (10*HZ)
41#define START_UNIT_TIMEOUT (30*HZ)
42
43/*
44 * These should *probably* be handled by the host itself.
45 * Since it is allowed to sleep, it probably should.
46 */
47#define BUS_RESET_SETTLE_TIME (10)
48#define HOST_RESET_SETTLE_TIME (10)
49
50/* called with shost->host_lock held */
51void scsi_eh_wakeup(struct Scsi_Host *shost)
52{
53 if (shost->host_busy == shost->host_failed) {
James Bottomley3ed7a472005-09-19 09:50:04 -050054 wake_up_process(shost->ehandler);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 SCSI_LOG_ERROR_RECOVERY(5,
56 printk("Waking error handler thread\n"));
57 }
58}
Tejun Heof8bbfc22006-05-19 21:07:05 +090059
60/**
61 * scsi_schedule_eh - schedule EH for SCSI host
62 * @shost: SCSI host to invoke error handling on.
63 *
64 * Schedule SCSI EH without scmd.
65 **/
66void scsi_schedule_eh(struct Scsi_Host *shost)
67{
68 unsigned long flags;
69
70 spin_lock_irqsave(shost->host_lock, flags);
71
72 if (scsi_host_set_state(shost, SHOST_RECOVERY) == 0 ||
73 scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY) == 0) {
74 shost->host_eh_scheduled++;
75 scsi_eh_wakeup(shost);
76 }
77
78 spin_unlock_irqrestore(shost->host_lock, flags);
79}
80EXPORT_SYMBOL_GPL(scsi_schedule_eh);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82/**
83 * scsi_eh_scmd_add - add scsi cmd to error handling.
84 * @scmd: scmd to run eh on.
85 * @eh_flag: optional SCSI_EH flag.
86 *
87 * Return value:
88 * 0 on failure.
89 **/
90int scsi_eh_scmd_add(struct scsi_cmnd *scmd, int eh_flag)
91{
92 struct Scsi_Host *shost = scmd->device->host;
93 unsigned long flags;
James Bottomley939647e2005-09-18 15:05:20 -050094 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
James Bottomley3ed7a472005-09-19 09:50:04 -050096 if (!shost->ehandler)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 return 0;
98
99 spin_lock_irqsave(shost->host_lock, flags);
James Bottomley939647e2005-09-18 15:05:20 -0500100 if (scsi_host_set_state(shost, SHOST_RECOVERY))
101 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY))
102 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
James Bottomley939647e2005-09-18 15:05:20 -0500104 ret = 1;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200105 scmd->eh_eflags |= eh_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 list_add_tail(&scmd->eh_entry, &shost->eh_cmd_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 shost->host_failed++;
108 scsi_eh_wakeup(shost);
James Bottomley939647e2005-09-18 15:05:20 -0500109 out_unlock:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomley939647e2005-09-18 15:05:20 -0500111 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112}
113
114/**
115 * scsi_add_timer - Start timeout timer for a single scsi command.
116 * @scmd: scsi command that is about to start running.
117 * @timeout: amount of time to allow this command to run.
118 * @complete: timeout function to call if timer isn't canceled.
119 *
120 * Notes:
121 * This should be turned into an inline function. Each scsi command
122 * has its own timer, and as it is added to the queue, we set up the
123 * timer. When the command completes, we cancel the timer.
124 **/
125void scsi_add_timer(struct scsi_cmnd *scmd, int timeout,
126 void (*complete)(struct scsi_cmnd *))
127{
128
129 /*
130 * If the clock was already running for this command, then
131 * first delete the timer. The timer handling code gets rather
132 * confused if we don't do this.
133 */
134 if (scmd->eh_timeout.function)
135 del_timer(&scmd->eh_timeout);
136
137 scmd->eh_timeout.data = (unsigned long)scmd;
138 scmd->eh_timeout.expires = jiffies + timeout;
139 scmd->eh_timeout.function = (void (*)(unsigned long)) complete;
140
141 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: scmd: %p, time:"
142 " %d, (%p)\n", __FUNCTION__,
143 scmd, timeout, complete));
144
145 add_timer(&scmd->eh_timeout);
146}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148/**
149 * scsi_delete_timer - Delete/cancel timer for a given function.
150 * @scmd: Cmd that we are canceling timer for
151 *
152 * Notes:
153 * This should be turned into an inline function.
154 *
155 * Return value:
156 * 1 if we were able to detach the timer. 0 if we blew it, and the
157 * timer function has already started to run.
158 **/
159int scsi_delete_timer(struct scsi_cmnd *scmd)
160{
161 int rtn;
162
163 rtn = del_timer(&scmd->eh_timeout);
164
165 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: scmd: %p,"
166 " rtn: %d\n", __FUNCTION__,
167 scmd, rtn));
168
169 scmd->eh_timeout.data = (unsigned long)NULL;
170 scmd->eh_timeout.function = NULL;
171
172 return rtn;
173}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175/**
176 * scsi_times_out - Timeout function for normal scsi commands.
177 * @scmd: Cmd that is timing out.
178 *
179 * Notes:
180 * We do not need to lock this. There is the potential for a race
181 * only in that the normal completion handling might run, but if the
182 * normal completion function determines that the timer has already
183 * fired, then it mustn't do anything.
184 **/
185void scsi_times_out(struct scsi_cmnd *scmd)
186{
187 scsi_log_completion(scmd, TIMEOUT_ERROR);
188
James Smartc829c392006-03-13 08:28:57 -0500189 if (scmd->device->host->transportt->eh_timed_out)
190 switch (scmd->device->host->transportt->eh_timed_out(scmd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 case EH_HANDLED:
192 __scsi_done(scmd);
193 return;
194 case EH_RESET_TIMER:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 scsi_add_timer(scmd, scmd->timeout_per_command,
196 scsi_times_out);
197 return;
198 case EH_NOT_HANDLED:
199 break;
200 }
201
202 if (unlikely(!scsi_eh_scmd_add(scmd, SCSI_EH_CANCEL_CMD))) {
James Bottomley939647e2005-09-18 15:05:20 -0500203 scmd->result |= DID_TIME_OUT << 16;
204 __scsi_done(scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 }
206}
207
208/**
209 * scsi_block_when_processing_errors - Prevent cmds from being queued.
210 * @sdev: Device on which we are performing recovery.
211 *
212 * Description:
213 * We block until the host is out of error recovery, and then check to
214 * see whether the host or the device is offline.
215 *
216 * Return value:
217 * 0 when dev was taken offline by error recovery. 1 OK to proceed.
218 **/
219int scsi_block_when_processing_errors(struct scsi_device *sdev)
220{
221 int online;
222
James Bottomley939647e2005-09-18 15:05:20 -0500223 wait_event(sdev->host->host_wait, !scsi_host_in_recovery(sdev->host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225 online = scsi_device_online(sdev);
226
227 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: rtn: %d\n", __FUNCTION__,
228 online));
229
230 return online;
231}
232EXPORT_SYMBOL(scsi_block_when_processing_errors);
233
234#ifdef CONFIG_SCSI_LOGGING
235/**
236 * scsi_eh_prt_fail_stats - Log info on failures.
237 * @shost: scsi host being recovered.
238 * @work_q: Queue of scsi cmds to process.
239 **/
240static inline void scsi_eh_prt_fail_stats(struct Scsi_Host *shost,
241 struct list_head *work_q)
242{
243 struct scsi_cmnd *scmd;
244 struct scsi_device *sdev;
245 int total_failures = 0;
246 int cmd_failed = 0;
247 int cmd_cancel = 0;
248 int devices_failed = 0;
249
250 shost_for_each_device(sdev, shost) {
251 list_for_each_entry(scmd, work_q, eh_entry) {
252 if (scmd->device == sdev) {
253 ++total_failures;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200254 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 ++cmd_cancel;
256 else
257 ++cmd_failed;
258 }
259 }
260
261 if (cmd_cancel || cmd_failed) {
262 SCSI_LOG_ERROR_RECOVERY(3,
James Bottomley9ccfc752005-10-02 11:45:08 -0500263 sdev_printk(KERN_INFO, sdev,
264 "%s: cmds failed: %d, cancel: %d\n",
265 __FUNCTION__, cmd_failed,
266 cmd_cancel));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 cmd_cancel = 0;
268 cmd_failed = 0;
269 ++devices_failed;
270 }
271 }
272
273 SCSI_LOG_ERROR_RECOVERY(2, printk("Total of %d commands on %d"
274 " devices require eh work\n",
275 total_failures, devices_failed));
276}
277#endif
278
279/**
280 * scsi_check_sense - Examine scsi cmd sense
281 * @scmd: Cmd to have sense checked.
282 *
283 * Return value:
284 * SUCCESS or FAILED or NEEDS_RETRY
285 *
286 * Notes:
287 * When a deferred error is detected the current command has
288 * not been executed and needs retrying.
289 **/
290static int scsi_check_sense(struct scsi_cmnd *scmd)
291{
292 struct scsi_sense_hdr sshdr;
293
294 if (! scsi_command_normalize_sense(scmd, &sshdr))
295 return FAILED; /* no valid sense data */
296
297 if (scsi_sense_is_deferred(&sshdr))
298 return NEEDS_RETRY;
299
300 /*
301 * Previous logic looked for FILEMARK, EOM or ILI which are
302 * mainly associated with tapes and returned SUCCESS.
303 */
304 if (sshdr.response_code == 0x70) {
305 /* fixed format */
306 if (scmd->sense_buffer[2] & 0xe0)
307 return SUCCESS;
308 } else {
309 /*
310 * descriptor format: look for "stream commands sense data
311 * descriptor" (see SSC-3). Assume single sense data
312 * descriptor. Ignore ILI from SBC-2 READ LONG and WRITE LONG.
313 */
314 if ((sshdr.additional_length > 3) &&
315 (scmd->sense_buffer[8] == 0x4) &&
316 (scmd->sense_buffer[11] & 0xe0))
317 return SUCCESS;
318 }
319
320 switch (sshdr.sense_key) {
321 case NO_SENSE:
322 return SUCCESS;
323 case RECOVERED_ERROR:
324 return /* soft_error */ SUCCESS;
325
326 case ABORTED_COMMAND:
327 return NEEDS_RETRY;
328 case NOT_READY:
329 case UNIT_ATTENTION:
330 /*
331 * if we are expecting a cc/ua because of a bus reset that we
332 * performed, treat this just as a retry. otherwise this is
333 * information that we should pass up to the upper-level driver
334 * so that we can deal with it there.
335 */
336 if (scmd->device->expecting_cc_ua) {
337 scmd->device->expecting_cc_ua = 0;
338 return NEEDS_RETRY;
339 }
340 /*
341 * if the device is in the process of becoming ready, we
342 * should retry.
343 */
344 if ((sshdr.asc == 0x04) && (sshdr.ascq == 0x01))
345 return NEEDS_RETRY;
346 /*
347 * if the device is not started, we need to wake
348 * the error handler to start the motor
349 */
350 if (scmd->device->allow_restart &&
351 (sshdr.asc == 0x04) && (sshdr.ascq == 0x02))
352 return FAILED;
353 return SUCCESS;
354
355 /* these three are not supported */
356 case COPY_ABORTED:
357 case VOLUME_OVERFLOW:
358 case MISCOMPARE:
359 return SUCCESS;
360
361 case MEDIUM_ERROR:
Luben Tuikovfd1b4942006-11-29 19:45:23 -0800362 if (sshdr.asc == 0x11 || /* UNRECOVERED READ ERR */
363 sshdr.asc == 0x13 || /* AMNF DATA FIELD */
364 sshdr.asc == 0x14) { /* RECORD NOT FOUND */
365 return SUCCESS;
366 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 return NEEDS_RETRY;
368
369 case HARDWARE_ERROR:
370 if (scmd->device->retry_hwerror)
371 return NEEDS_RETRY;
372 else
373 return SUCCESS;
374
375 case ILLEGAL_REQUEST:
376 case BLANK_CHECK:
377 case DATA_PROTECT:
378 default:
379 return SUCCESS;
380 }
381}
382
383/**
384 * scsi_eh_completed_normally - Disposition a eh cmd on return from LLD.
385 * @scmd: SCSI cmd to examine.
386 *
387 * Notes:
388 * This is *only* called when we are examining the status of commands
389 * queued during error recovery. the main difference here is that we
390 * don't allow for the possibility of retries here, and we are a lot
391 * more restrictive about what we consider acceptable.
392 **/
393static int scsi_eh_completed_normally(struct scsi_cmnd *scmd)
394{
395 /*
396 * first check the host byte, to see if there is anything in there
397 * that would indicate what we need to do.
398 */
399 if (host_byte(scmd->result) == DID_RESET) {
400 /*
401 * rats. we are already in the error handler, so we now
402 * get to try and figure out what to do next. if the sense
403 * is valid, we have a pretty good idea of what to do.
404 * if not, we mark it as FAILED.
405 */
406 return scsi_check_sense(scmd);
407 }
408 if (host_byte(scmd->result) != DID_OK)
409 return FAILED;
410
411 /*
412 * next, check the message byte.
413 */
414 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
415 return FAILED;
416
417 /*
418 * now, check the status byte to see if this indicates
419 * anything special.
420 */
421 switch (status_byte(scmd->result)) {
422 case GOOD:
423 case COMMAND_TERMINATED:
424 return SUCCESS;
425 case CHECK_CONDITION:
426 return scsi_check_sense(scmd);
427 case CONDITION_GOOD:
428 case INTERMEDIATE_GOOD:
429 case INTERMEDIATE_C_GOOD:
430 /*
431 * who knows? FIXME(eric)
432 */
433 return SUCCESS;
434 case BUSY:
435 case QUEUE_FULL:
436 case RESERVATION_CONFLICT:
437 default:
438 return FAILED;
439 }
440 return FAILED;
441}
442
443/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 * scsi_eh_done - Completion function for error handling.
445 * @scmd: Cmd that is done.
446 **/
447static void scsi_eh_done(struct scsi_cmnd *scmd)
448{
Michael Reed85631672005-12-07 21:46:27 -0600449 struct completion *eh_action;
450
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100451 SCSI_LOG_ERROR_RECOVERY(3,
452 printk("%s scmd: %p result: %x\n",
453 __FUNCTION__, scmd, scmd->result));
Michael Reed85631672005-12-07 21:46:27 -0600454
455 eh_action = scmd->device->host->eh_action;
456 if (eh_action)
457 complete(eh_action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458}
459
460/**
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100461 * scsi_send_eh_cmnd - submit a scsi command as part of error recory
462 * @scmd: SCSI command structure to hijack
463 * @cmnd: CDB to send
464 * @cmnd_size: size in bytes of @cmnd
465 * @timeout: timeout for this request
466 * @copy_sense: request sense data if set to 1
467 *
468 * This function is used to send a scsi command down to a target device
469 * as part of the error recovery process. If @copy_sense is 0 the command
470 * sent must be one that does not transfer any data. If @copy_sense is 1
471 * the command must be REQUEST_SENSE and this functions copies out the
472 * sense buffer it got into @scmd->sense_buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 * Return value:
475 * SUCCESS or FAILED or NEEDS_RETRY
476 **/
Mike Christie0db99e32006-08-26 03:00:22 -0400477static int scsi_send_eh_cmnd(struct scsi_cmnd *scmd, unsigned char *cmnd,
478 int cmnd_size, int timeout, int copy_sense)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479{
f59114b2005-04-17 15:00:23 -0500480 struct scsi_device *sdev = scmd->device;
481 struct Scsi_Host *shost = sdev->host;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200482 int old_result = scmd->result;
Stefan Richter7fbb3642006-09-12 20:35:54 -0700483 DECLARE_COMPLETION_ONSTACK(done);
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100484 unsigned long timeleft;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 unsigned long flags;
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100486 struct scatterlist sgl;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200487 unsigned char old_cmnd[MAX_COMMAND_SIZE];
488 enum dma_data_direction old_data_direction;
489 unsigned short old_use_sg;
490 unsigned char old_cmd_len;
491 unsigned old_bufflen;
492 void *old_buffer;
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100493 int rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
Christoph Hellwig631c2282006-07-08 20:42:15 +0200495 /*
496 * We need saved copies of a number of fields - this is because
497 * error handling may need to overwrite these with different values
498 * to run different commands, and once error handling is complete,
499 * we will need to restore these values prior to running the actual
500 * command.
501 */
502 old_buffer = scmd->request_buffer;
503 old_bufflen = scmd->request_bufflen;
504 memcpy(old_cmnd, scmd->cmnd, sizeof(scmd->cmnd));
505 old_data_direction = scmd->sc_data_direction;
506 old_cmd_len = scmd->cmd_len;
507 old_use_sg = scmd->use_sg;
508
Mike Christie0db99e32006-08-26 03:00:22 -0400509 memset(scmd->cmnd, 0, sizeof(scmd->cmnd));
510 memcpy(scmd->cmnd, cmnd, cmnd_size);
511
Christoph Hellwig631c2282006-07-08 20:42:15 +0200512 if (copy_sense) {
Al Virofa1f5ea2006-10-10 22:47:47 +0100513 gfp_t gfp_mask = GFP_ATOMIC;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200514
515 if (shost->hostt->unchecked_isa_dma)
516 gfp_mask |= __GFP_DMA;
517
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100518 sgl.page = alloc_page(gfp_mask);
519 if (!sgl.page)
Christoph Hellwig631c2282006-07-08 20:42:15 +0200520 return FAILED;
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100521 sgl.offset = 0;
522 sgl.length = 252;
523
524 scmd->sc_data_direction = DMA_FROM_DEVICE;
525 scmd->request_bufflen = sgl.length;
526 scmd->request_buffer = &sgl;
527 scmd->use_sg = 1;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200528 } else {
529 scmd->request_buffer = NULL;
530 scmd->request_bufflen = 0;
531 scmd->sc_data_direction = DMA_NONE;
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100532 scmd->use_sg = 0;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200533 }
534
535 scmd->underflow = 0;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200536 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
537
f59114b2005-04-17 15:00:23 -0500538 if (sdev->scsi_level <= SCSI_2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 scmd->cmnd[1] = (scmd->cmnd[1] & 0x1f) |
f59114b2005-04-17 15:00:23 -0500540 (sdev->lun << 5 & 0xe0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
Christoph Hellwig631c2282006-07-08 20:42:15 +0200542 /*
543 * Zero the sense buffer. The scsi spec mandates that any
544 * untransferred sense data should be interpreted as being zero.
545 */
546 memset(scmd->sense_buffer, 0, sizeof(scmd->sense_buffer));
547
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100548 shost->eh_action = &done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
f59114b2005-04-17 15:00:23 -0500550 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 scsi_log_send(scmd);
f59114b2005-04-17 15:00:23 -0500552 shost->hostt->queuecommand(scmd, scsi_eh_done);
553 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100555 timeleft = wait_for_completion_timeout(&done, timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
f59114b2005-04-17 15:00:23 -0500557 shost->eh_action = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100559 scsi_log_completion(scmd, SUCCESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100561 SCSI_LOG_ERROR_RECOVERY(3,
562 printk("%s: scmd: %p, timeleft: %ld\n",
563 __FUNCTION__, scmd, timeleft));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
565 /*
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100566 * If there is time left scsi_eh_done got called, and we will
567 * examine the actual status codes to see whether the command
568 * actually did complete normally, else tell the host to forget
569 * about this command.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 */
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100571 if (timeleft) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 rtn = scsi_eh_completed_normally(scmd);
573 SCSI_LOG_ERROR_RECOVERY(3,
574 printk("%s: scsi_eh_completed_normally %x\n",
575 __FUNCTION__, rtn));
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 switch (rtn) {
578 case SUCCESS:
579 case NEEDS_RETRY:
580 case FAILED:
581 break;
582 default:
583 rtn = FAILED;
584 break;
585 }
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100586 } else {
587 /*
588 * FIXME(eric) - we are not tracking whether we could
589 * abort a timed out command or not. not sure how
590 * we should treat them differently anyways.
591 */
592 if (shost->hostt->eh_abort_handler)
593 shost->hostt->eh_abort_handler(scmd);
594 rtn = FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 }
596
Christoph Hellwig631c2282006-07-08 20:42:15 +0200597
598 /*
599 * Last chance to have valid sense data.
600 */
601 if (copy_sense) {
602 if (!SCSI_SENSE_VALID(scmd)) {
603 memcpy(scmd->sense_buffer, scmd->request_buffer,
604 sizeof(scmd->sense_buffer));
605 }
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100606 __free_page(sgl.page);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200607 }
608
609
610 /*
611 * Restore original data
612 */
613 scmd->request_buffer = old_buffer;
614 scmd->request_bufflen = old_bufflen;
615 memcpy(scmd->cmnd, old_cmnd, sizeof(scmd->cmnd));
616 scmd->sc_data_direction = old_data_direction;
617 scmd->cmd_len = old_cmd_len;
618 scmd->use_sg = old_use_sg;
619 scmd->result = old_result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 return rtn;
621}
622
623/**
624 * scsi_request_sense - Request sense data from a particular target.
625 * @scmd: SCSI cmd for request sense.
626 *
627 * Notes:
628 * Some hosts automatically obtain this information, others require
629 * that we obtain it on our own. This function will *not* return until
630 * the command either times out, or it completes.
631 **/
632static int scsi_request_sense(struct scsi_cmnd *scmd)
633{
634 static unsigned char generic_sense[6] =
Christoph Hellwig631c2282006-07-08 20:42:15 +0200635 {REQUEST_SENSE, 0, 0, 0, 252, 0};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Mike Christie0db99e32006-08-26 03:00:22 -0400637 return scsi_send_eh_cmnd(scmd, generic_sense, 6, SENSE_TIMEOUT, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638}
639
640/**
641 * scsi_eh_finish_cmd - Handle a cmd that eh is finished with.
642 * @scmd: Original SCSI cmd that eh has finished.
643 * @done_q: Queue for processed commands.
644 *
645 * Notes:
646 * We don't want to use the normal command completion while we are are
647 * still handling errors - it may cause other commands to be queued,
648 * and that would disturb what we are doing. thus we really want to
649 * keep a list of pending commands for final completion, and once we
650 * are ready to leave error handling we handle completion for real.
651 **/
Tejun Heo041c5fc2006-01-23 13:09:36 +0900652void scsi_eh_finish_cmd(struct scsi_cmnd *scmd, struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653{
654 scmd->device->host->host_failed--;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200655 scmd->eh_eflags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 list_move_tail(&scmd->eh_entry, done_q);
657}
Tejun Heo041c5fc2006-01-23 13:09:36 +0900658EXPORT_SYMBOL(scsi_eh_finish_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
660/**
661 * scsi_eh_get_sense - Get device sense data.
662 * @work_q: Queue of commands to process.
663 * @done_q: Queue of proccessed commands..
664 *
665 * Description:
666 * See if we need to request sense information. if so, then get it
667 * now, so we have a better idea of what to do.
668 *
669 * Notes:
670 * This has the unfortunate side effect that if a shost adapter does
671 * not automatically request sense information, that we end up shutting
672 * it down before we request it.
673 *
674 * All drivers should request sense information internally these days,
675 * so for now all I have to say is tough noogies if you end up in here.
676 *
677 * XXX: Long term this code should go away, but that needs an audit of
678 * all LLDDs first.
679 **/
Darrick J. Wongdca84e42007-01-26 14:08:49 -0800680int scsi_eh_get_sense(struct list_head *work_q,
681 struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200683 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 int rtn;
685
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200686 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200687 if ((scmd->eh_eflags & SCSI_EH_CANCEL_CMD) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 SCSI_SENSE_VALID(scmd))
689 continue;
690
Jeff Garzik3bf743e2005-10-24 18:04:06 -0400691 SCSI_LOG_ERROR_RECOVERY(2, scmd_printk(KERN_INFO, scmd,
692 "%s: requesting sense\n",
693 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 rtn = scsi_request_sense(scmd);
695 if (rtn != SUCCESS)
696 continue;
697
698 SCSI_LOG_ERROR_RECOVERY(3, printk("sense requested for %p"
699 " result %x\n", scmd,
700 scmd->result));
701 SCSI_LOG_ERROR_RECOVERY(3, scsi_print_sense("bh", scmd));
702
703 rtn = scsi_decide_disposition(scmd);
704
705 /*
706 * if the result was normal, then just pass it along to the
707 * upper level.
708 */
709 if (rtn == SUCCESS)
710 /* we don't want this command reissued, just
711 * finished with the sense data, so set
712 * retries to the max allowed to ensure it
713 * won't get reissued */
714 scmd->retries = scmd->allowed;
715 else if (rtn != NEEDS_RETRY)
716 continue;
717
718 scsi_eh_finish_cmd(scmd, done_q);
719 }
720
721 return list_empty(work_q);
722}
Darrick J. Wongdca84e42007-01-26 14:08:49 -0800723EXPORT_SYMBOL_GPL(scsi_eh_get_sense);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
725/**
726 * scsi_try_to_abort_cmd - Ask host to abort a running command.
727 * @scmd: SCSI cmd to abort from Lower Level.
728 *
729 * Notes:
730 * This function will not return until the user's completion function
731 * has been called. there is no timeout on this operation. if the
732 * author of the low-level driver wishes this operation to be timed,
733 * they can provide this facility themselves. helper functions in
734 * scsi_error.c can be supplied to make this easier to do.
735 **/
736static int scsi_try_to_abort_cmd(struct scsi_cmnd *scmd)
737{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 if (!scmd->device->host->hostt->eh_abort_handler)
Jeff Garzik 8fa728a2005-05-28 07:54:40 -0400739 return FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
741 /*
742 * scsi_done was called just after the command timed out and before
743 * we had a chance to process it. (db)
744 */
745 if (scmd->serial_number == 0)
746 return SUCCESS;
Jeff Garzik 8fa728a2005-05-28 07:54:40 -0400747 return scmd->device->host->hostt->eh_abort_handler(scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748}
749
750/**
751 * scsi_eh_tur - Send TUR to device.
752 * @scmd: Scsi cmd to send TUR
753 *
754 * Return value:
755 * 0 - Device is ready. 1 - Device NOT ready.
756 **/
757static int scsi_eh_tur(struct scsi_cmnd *scmd)
758{
759 static unsigned char tur_command[6] = {TEST_UNIT_READY, 0, 0, 0, 0, 0};
760 int retry_cnt = 1, rtn;
761
762retry_tur:
Mike Christie0db99e32006-08-26 03:00:22 -0400763 rtn = scsi_send_eh_cmnd(scmd, tur_command, 6, SENSE_TIMEOUT, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: scmd %p rtn %x\n",
766 __FUNCTION__, scmd, rtn));
Christoph Hellwig631c2282006-07-08 20:42:15 +0200767
768 switch (rtn) {
769 case NEEDS_RETRY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (retry_cnt--)
771 goto retry_tur;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200772 /*FALLTHRU*/
773 case SUCCESS:
Alan Sterne47373e2005-03-30 15:05:45 -0500774 return 0;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200775 default:
776 return 1;
Alan Sterne47373e2005-03-30 15:05:45 -0500777 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778}
779
780/**
781 * scsi_eh_abort_cmds - abort canceled commands.
782 * @shost: scsi host being recovered.
783 * @eh_done_q: list_head for processed commands.
784 *
785 * Decription:
786 * Try and see whether or not it makes sense to try and abort the
787 * running command. this only works out to be the case if we have one
788 * command that has timed out. if the command simply failed, it makes
789 * no sense to try and abort the command, since as far as the shost
790 * adapter is concerned, it isn't running.
791 **/
792static int scsi_eh_abort_cmds(struct list_head *work_q,
793 struct list_head *done_q)
794{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200795 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 int rtn;
797
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200798 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200799 if (!(scmd->eh_eflags & SCSI_EH_CANCEL_CMD))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 continue;
801 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: aborting cmd:"
802 "0x%p\n", current->comm,
803 scmd));
804 rtn = scsi_try_to_abort_cmd(scmd);
805 if (rtn == SUCCESS) {
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200806 scmd->eh_eflags &= ~SCSI_EH_CANCEL_CMD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 if (!scsi_device_online(scmd->device) ||
808 !scsi_eh_tur(scmd)) {
809 scsi_eh_finish_cmd(scmd, done_q);
810 }
811
812 } else
813 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: aborting"
814 " cmd failed:"
815 "0x%p\n",
816 current->comm,
817 scmd));
818 }
819
820 return list_empty(work_q);
821}
822
823/**
824 * scsi_try_bus_device_reset - Ask host to perform a BDR on a dev
825 * @scmd: SCSI cmd used to send BDR
826 *
827 * Notes:
828 * There is no timeout for this operation. if this operation is
829 * unreliable for a given host, then the host itself needs to put a
830 * timer on it, and set the host back to a consistent state prior to
831 * returning.
832 **/
833static int scsi_try_bus_device_reset(struct scsi_cmnd *scmd)
834{
Jeff Garzik 94d0e7b82005-05-28 07:55:48 -0400835 int rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
837 if (!scmd->device->host->hostt->eh_device_reset_handler)
Jeff Garzik 94d0e7b82005-05-28 07:55:48 -0400838 return FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 rtn = scmd->device->host->hostt->eh_device_reset_handler(scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 if (rtn == SUCCESS) {
842 scmd->device->was_reset = 1;
843 scmd->device->expecting_cc_ua = 1;
844 }
845
846 return rtn;
847}
848
849/**
850 * scsi_eh_try_stu - Send START_UNIT to device.
851 * @scmd: Scsi cmd to send START_UNIT
852 *
853 * Return value:
854 * 0 - Device is ready. 1 - Device NOT ready.
855 **/
856static int scsi_eh_try_stu(struct scsi_cmnd *scmd)
857{
858 static unsigned char stu_command[6] = {START_STOP, 0, 0, 0, 1, 0};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Christoph Hellwig631c2282006-07-08 20:42:15 +0200860 if (scmd->device->allow_restart) {
861 int rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
Mike Christie0db99e32006-08-26 03:00:22 -0400863 rtn = scsi_send_eh_cmnd(scmd, stu_command, 6,
864 START_UNIT_TIMEOUT, 0);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200865 if (rtn == SUCCESS)
866 return 0;
867 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 return 1;
870}
871
872 /**
873 * scsi_eh_stu - send START_UNIT if needed
874 * @shost: scsi host being recovered.
875 * @eh_done_q: list_head for processed commands.
876 *
877 * Notes:
878 * If commands are failing due to not ready, initializing command required,
879 * try revalidating the device, which will end up sending a start unit.
880 **/
881static int scsi_eh_stu(struct Scsi_Host *shost,
882 struct list_head *work_q,
883 struct list_head *done_q)
884{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200885 struct scsi_cmnd *scmd, *stu_scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 struct scsi_device *sdev;
887
888 shost_for_each_device(sdev, shost) {
889 stu_scmd = NULL;
890 list_for_each_entry(scmd, work_q, eh_entry)
891 if (scmd->device == sdev && SCSI_SENSE_VALID(scmd) &&
892 scsi_check_sense(scmd) == FAILED ) {
893 stu_scmd = scmd;
894 break;
895 }
896
897 if (!stu_scmd)
898 continue;
899
900 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending START_UNIT to sdev:"
901 " 0x%p\n", current->comm, sdev));
902
903 if (!scsi_eh_try_stu(stu_scmd)) {
904 if (!scsi_device_online(sdev) ||
905 !scsi_eh_tur(stu_scmd)) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200906 list_for_each_entry_safe(scmd, next,
907 work_q, eh_entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 if (scmd->device == sdev)
909 scsi_eh_finish_cmd(scmd, done_q);
910 }
911 }
912 } else {
913 SCSI_LOG_ERROR_RECOVERY(3,
914 printk("%s: START_UNIT failed to sdev:"
915 " 0x%p\n", current->comm, sdev));
916 }
917 }
918
919 return list_empty(work_q);
920}
921
922
923/**
924 * scsi_eh_bus_device_reset - send bdr if needed
925 * @shost: scsi host being recovered.
926 * @eh_done_q: list_head for processed commands.
927 *
928 * Notes:
929 * Try a bus device reset. still, look to see whether we have multiple
930 * devices that are jammed or not - if we have multiple devices, it
931 * makes no sense to try bus_device_reset - we really would need to try
932 * a bus_reset instead.
933 **/
934static int scsi_eh_bus_device_reset(struct Scsi_Host *shost,
935 struct list_head *work_q,
936 struct list_head *done_q)
937{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200938 struct scsi_cmnd *scmd, *bdr_scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 struct scsi_device *sdev;
940 int rtn;
941
942 shost_for_each_device(sdev, shost) {
943 bdr_scmd = NULL;
944 list_for_each_entry(scmd, work_q, eh_entry)
945 if (scmd->device == sdev) {
946 bdr_scmd = scmd;
947 break;
948 }
949
950 if (!bdr_scmd)
951 continue;
952
953 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending BDR sdev:"
954 " 0x%p\n", current->comm,
955 sdev));
956 rtn = scsi_try_bus_device_reset(bdr_scmd);
957 if (rtn == SUCCESS) {
958 if (!scsi_device_online(sdev) ||
959 !scsi_eh_tur(bdr_scmd)) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +0200960 list_for_each_entry_safe(scmd, next,
961 work_q, eh_entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 if (scmd->device == sdev)
963 scsi_eh_finish_cmd(scmd,
964 done_q);
965 }
966 }
967 } else {
968 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: BDR"
969 " failed sdev:"
970 "0x%p\n",
971 current->comm,
972 sdev));
973 }
974 }
975
976 return list_empty(work_q);
977}
978
979/**
980 * scsi_try_bus_reset - ask host to perform a bus reset
981 * @scmd: SCSI cmd to send bus reset.
982 **/
983static int scsi_try_bus_reset(struct scsi_cmnd *scmd)
984{
985 unsigned long flags;
986 int rtn;
987
988 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Snd Bus RST\n",
989 __FUNCTION__));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
991 if (!scmd->device->host->hostt->eh_bus_reset_handler)
992 return FAILED;
993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 rtn = scmd->device->host->hostt->eh_bus_reset_handler(scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
996 if (rtn == SUCCESS) {
997 if (!scmd->device->host->hostt->skip_settle_delay)
998 ssleep(BUS_RESET_SETTLE_TIME);
999 spin_lock_irqsave(scmd->device->host->host_lock, flags);
Jeff Garzik422c0d62005-10-24 18:05:09 -04001000 scsi_report_bus_reset(scmd->device->host,
1001 scmd_channel(scmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 spin_unlock_irqrestore(scmd->device->host->host_lock, flags);
1003 }
1004
1005 return rtn;
1006}
1007
1008/**
1009 * scsi_try_host_reset - ask host adapter to reset itself
1010 * @scmd: SCSI cmd to send hsot reset.
1011 **/
1012static int scsi_try_host_reset(struct scsi_cmnd *scmd)
1013{
1014 unsigned long flags;
1015 int rtn;
1016
1017 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Snd Host RST\n",
1018 __FUNCTION__));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
1020 if (!scmd->device->host->hostt->eh_host_reset_handler)
1021 return FAILED;
1022
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 rtn = scmd->device->host->hostt->eh_host_reset_handler(scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
1025 if (rtn == SUCCESS) {
1026 if (!scmd->device->host->hostt->skip_settle_delay)
1027 ssleep(HOST_RESET_SETTLE_TIME);
1028 spin_lock_irqsave(scmd->device->host->host_lock, flags);
Jeff Garzik422c0d62005-10-24 18:05:09 -04001029 scsi_report_bus_reset(scmd->device->host,
1030 scmd_channel(scmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 spin_unlock_irqrestore(scmd->device->host->host_lock, flags);
1032 }
1033
1034 return rtn;
1035}
1036
1037/**
1038 * scsi_eh_bus_reset - send a bus reset
1039 * @shost: scsi host being recovered.
1040 * @eh_done_q: list_head for processed commands.
1041 **/
1042static int scsi_eh_bus_reset(struct Scsi_Host *shost,
1043 struct list_head *work_q,
1044 struct list_head *done_q)
1045{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001046 struct scsi_cmnd *scmd, *chan_scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 unsigned int channel;
1048 int rtn;
1049
1050 /*
1051 * we really want to loop over the various channels, and do this on
1052 * a channel by channel basis. we should also check to see if any
1053 * of the failed commands are on soft_reset devices, and if so, skip
1054 * the reset.
1055 */
1056
1057 for (channel = 0; channel <= shost->max_channel; channel++) {
1058 chan_scmd = NULL;
1059 list_for_each_entry(scmd, work_q, eh_entry) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04001060 if (channel == scmd_channel(scmd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 chan_scmd = scmd;
1062 break;
1063 /*
1064 * FIXME add back in some support for
1065 * soft_reset devices.
1066 */
1067 }
1068 }
1069
1070 if (!chan_scmd)
1071 continue;
1072 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending BRST chan:"
1073 " %d\n", current->comm,
1074 channel));
1075 rtn = scsi_try_bus_reset(chan_scmd);
1076 if (rtn == SUCCESS) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001077 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04001078 if (channel == scmd_channel(scmd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 if (!scsi_device_online(scmd->device) ||
1080 !scsi_eh_tur(scmd))
1081 scsi_eh_finish_cmd(scmd,
1082 done_q);
1083 }
1084 } else {
1085 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: BRST"
1086 " failed chan: %d\n",
1087 current->comm,
1088 channel));
1089 }
1090 }
1091 return list_empty(work_q);
1092}
1093
1094/**
1095 * scsi_eh_host_reset - send a host reset
1096 * @work_q: list_head for processed commands.
1097 * @done_q: list_head for processed commands.
1098 **/
1099static int scsi_eh_host_reset(struct list_head *work_q,
1100 struct list_head *done_q)
1101{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001102 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 int rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104
1105 if (!list_empty(work_q)) {
1106 scmd = list_entry(work_q->next,
1107 struct scsi_cmnd, eh_entry);
1108
1109 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: Sending HRST\n"
1110 , current->comm));
1111
1112 rtn = scsi_try_host_reset(scmd);
1113 if (rtn == SUCCESS) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001114 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 if (!scsi_device_online(scmd->device) ||
1116 (!scsi_eh_try_stu(scmd) && !scsi_eh_tur(scmd)) ||
1117 !scsi_eh_tur(scmd))
1118 scsi_eh_finish_cmd(scmd, done_q);
1119 }
1120 } else {
1121 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: HRST"
1122 " failed\n",
1123 current->comm));
1124 }
1125 }
1126 return list_empty(work_q);
1127}
1128
1129/**
1130 * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
1131 * @work_q: list_head for processed commands.
1132 * @done_q: list_head for processed commands.
1133 *
1134 **/
1135static void scsi_eh_offline_sdevs(struct list_head *work_q,
1136 struct list_head *done_q)
1137{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001138 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001140 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001141 sdev_printk(KERN_INFO, scmd->device,
1142 "scsi: Device offlined - not"
1143 " ready after error recovery\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 scsi_device_set_state(scmd->device, SDEV_OFFLINE);
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001145 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 /*
1147 * FIXME: Handle lost cmds.
1148 */
1149 }
1150 scsi_eh_finish_cmd(scmd, done_q);
1151 }
1152 return;
1153}
1154
1155/**
1156 * scsi_decide_disposition - Disposition a cmd on return from LLD.
1157 * @scmd: SCSI cmd to examine.
1158 *
1159 * Notes:
1160 * This is *only* called when we are examining the status after sending
1161 * out the actual data command. any commands that are queued for error
1162 * recovery (e.g. test_unit_ready) do *not* come through here.
1163 *
1164 * When this routine returns failed, it means the error handler thread
1165 * is woken. In cases where the error code indicates an error that
1166 * doesn't require the error handler read (i.e. we don't need to
1167 * abort/reset), this function should return SUCCESS.
1168 **/
1169int scsi_decide_disposition(struct scsi_cmnd *scmd)
1170{
1171 int rtn;
1172
1173 /*
1174 * if the device is offline, then we clearly just pass the result back
1175 * up to the top level.
1176 */
1177 if (!scsi_device_online(scmd->device)) {
1178 SCSI_LOG_ERROR_RECOVERY(5, printk("%s: device offline - report"
1179 " as SUCCESS\n",
1180 __FUNCTION__));
1181 return SUCCESS;
1182 }
1183
1184 /*
1185 * first check the host byte, to see if there is anything in there
1186 * that would indicate what we need to do.
1187 */
1188 switch (host_byte(scmd->result)) {
1189 case DID_PASSTHROUGH:
1190 /*
1191 * no matter what, pass this through to the upper layer.
1192 * nuke this special code so that it looks like we are saying
1193 * did_ok.
1194 */
1195 scmd->result &= 0xff00ffff;
1196 return SUCCESS;
1197 case DID_OK:
1198 /*
1199 * looks good. drop through, and check the next byte.
1200 */
1201 break;
1202 case DID_NO_CONNECT:
1203 case DID_BAD_TARGET:
1204 case DID_ABORT:
1205 /*
1206 * note - this means that we just report the status back
1207 * to the top level driver, not that we actually think
1208 * that it indicates SUCCESS.
1209 */
1210 return SUCCESS;
1211 /*
1212 * when the low level driver returns did_soft_error,
1213 * it is responsible for keeping an internal retry counter
1214 * in order to avoid endless loops (db)
1215 *
1216 * actually this is a bug in this function here. we should
1217 * be mindful of the maximum number of retries specified
1218 * and not get stuck in a loop.
1219 */
1220 case DID_SOFT_ERROR:
1221 goto maybe_retry;
1222 case DID_IMM_RETRY:
1223 return NEEDS_RETRY;
1224
bf341912005-04-12 17:49:09 -05001225 case DID_REQUEUE:
1226 return ADD_TO_MLQUEUE;
1227
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 case DID_ERROR:
1229 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1230 status_byte(scmd->result) == RESERVATION_CONFLICT)
1231 /*
1232 * execute reservation conflict processing code
1233 * lower down
1234 */
1235 break;
1236 /* fallthrough */
1237
1238 case DID_BUS_BUSY:
1239 case DID_PARITY:
1240 goto maybe_retry;
1241 case DID_TIME_OUT:
1242 /*
1243 * when we scan the bus, we get timeout messages for
1244 * these commands if there is no device available.
1245 * other hosts report did_no_connect for the same thing.
1246 */
1247 if ((scmd->cmnd[0] == TEST_UNIT_READY ||
1248 scmd->cmnd[0] == INQUIRY)) {
1249 return SUCCESS;
1250 } else {
1251 return FAILED;
1252 }
1253 case DID_RESET:
1254 return SUCCESS;
1255 default:
1256 return FAILED;
1257 }
1258
1259 /*
1260 * next, check the message byte.
1261 */
1262 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
1263 return FAILED;
1264
1265 /*
1266 * check the status byte to see if this indicates anything special.
1267 */
1268 switch (status_byte(scmd->result)) {
1269 case QUEUE_FULL:
1270 /*
1271 * the case of trying to send too many commands to a
1272 * tagged queueing device.
1273 */
1274 case BUSY:
1275 /*
1276 * device can't talk to us at the moment. Should only
1277 * occur (SAM-3) when the task queue is empty, so will cause
1278 * the empty queue handling to trigger a stall in the
1279 * device.
1280 */
1281 return ADD_TO_MLQUEUE;
1282 case GOOD:
1283 case COMMAND_TERMINATED:
1284 case TASK_ABORTED:
1285 return SUCCESS;
1286 case CHECK_CONDITION:
1287 rtn = scsi_check_sense(scmd);
1288 if (rtn == NEEDS_RETRY)
1289 goto maybe_retry;
1290 /* if rtn == FAILED, we have no sense information;
1291 * returning FAILED will wake the error handler thread
1292 * to collect the sense and redo the decide
1293 * disposition */
1294 return rtn;
1295 case CONDITION_GOOD:
1296 case INTERMEDIATE_GOOD:
1297 case INTERMEDIATE_C_GOOD:
1298 case ACA_ACTIVE:
1299 /*
1300 * who knows? FIXME(eric)
1301 */
1302 return SUCCESS;
1303
1304 case RESERVATION_CONFLICT:
James Bottomley9ccfc752005-10-02 11:45:08 -05001305 sdev_printk(KERN_INFO, scmd->device,
1306 "reservation conflict\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 return SUCCESS; /* causes immediate i/o error */
1308 default:
1309 return FAILED;
1310 }
1311 return FAILED;
1312
1313 maybe_retry:
1314
1315 /* we requeue for retry because the error was retryable, and
1316 * the request was not marked fast fail. Note that above,
1317 * even if the request is marked fast fail, we still requeue
1318 * for queue congestion conditions (QUEUE_FULL or BUSY) */
Brian King8884efa2006-02-24 17:10:04 -06001319 if ((++scmd->retries) <= scmd->allowed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 && !blk_noretry_request(scmd->request)) {
1321 return NEEDS_RETRY;
1322 } else {
1323 /*
1324 * no more retries - report this one back to upper level.
1325 */
1326 return SUCCESS;
1327 }
1328}
1329
1330/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 * scsi_eh_lock_door - Prevent medium removal for the specified device
1332 * @sdev: SCSI device to prevent medium removal
1333 *
1334 * Locking:
1335 * We must be called from process context; scsi_allocate_request()
1336 * may sleep.
1337 *
1338 * Notes:
1339 * We queue up an asynchronous "ALLOW MEDIUM REMOVAL" request on the
1340 * head of the devices request queue, and continue.
1341 *
1342 * Bugs:
1343 * scsi_allocate_request() may sleep waiting for existing requests to
1344 * be processed. However, since we haven't kicked off any request
1345 * processing for this host, this may deadlock.
1346 *
1347 * If scsi_allocate_request() fails for what ever reason, we
1348 * completely forget to lock the door.
1349 **/
1350static void scsi_eh_lock_door(struct scsi_device *sdev)
1351{
Mike Christie6e68af62005-11-11 05:30:27 -06001352 unsigned char cmnd[MAX_COMMAND_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
Mike Christie6e68af62005-11-11 05:30:27 -06001354 cmnd[0] = ALLOW_MEDIUM_REMOVAL;
1355 cmnd[1] = 0;
1356 cmnd[2] = 0;
1357 cmnd[3] = 0;
1358 cmnd[4] = SCSI_REMOVAL_PREVENT;
1359 cmnd[5] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
brking@us.ibm.combb1d1072006-01-23 15:03:22 -06001361 scsi_execute_async(sdev, cmnd, 6, DMA_NONE, NULL, 0, 0, 10 * HZ,
Mike Christie6e68af62005-11-11 05:30:27 -06001362 5, NULL, NULL, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363}
1364
1365
1366/**
1367 * scsi_restart_operations - restart io operations to the specified host.
1368 * @shost: Host we are restarting.
1369 *
1370 * Notes:
1371 * When we entered the error handler, we blocked all further i/o to
1372 * this device. we need to 'reverse' this process.
1373 **/
1374static void scsi_restart_operations(struct Scsi_Host *shost)
1375{
1376 struct scsi_device *sdev;
James Bottomley939647e2005-09-18 15:05:20 -05001377 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
1379 /*
1380 * If the door was locked, we need to insert a door lock request
1381 * onto the head of the SCSI request queue for the device. There
1382 * is no point trying to lock the door of an off-line device.
1383 */
1384 shost_for_each_device(sdev, shost) {
1385 if (scsi_device_online(sdev) && sdev->locked)
1386 scsi_eh_lock_door(sdev);
1387 }
1388
1389 /*
1390 * next free up anything directly waiting upon the host. this
1391 * will be requests for character device operations, and also for
1392 * ioctls to queued block devices.
1393 */
1394 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: waking up host to restart\n",
1395 __FUNCTION__));
1396
James Bottomley939647e2005-09-18 15:05:20 -05001397 spin_lock_irqsave(shost->host_lock, flags);
1398 if (scsi_host_set_state(shost, SHOST_RUNNING))
1399 if (scsi_host_set_state(shost, SHOST_CANCEL))
1400 BUG_ON(scsi_host_set_state(shost, SHOST_DEL));
1401 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
1403 wake_up(&shost->host_wait);
1404
1405 /*
1406 * finally we need to re-initiate requests that may be pending. we will
1407 * have had everything blocked while error handling is taking place, and
1408 * now that error recovery is done, we will need to ensure that these
1409 * requests are started.
1410 */
1411 scsi_run_host_queues(shost);
1412}
1413
1414/**
1415 * scsi_eh_ready_devs - check device ready state and recover if not.
1416 * @shost: host to be recovered.
1417 * @eh_done_q: list_head for processed commands.
1418 *
1419 **/
Darrick J. Wongdca84e42007-01-26 14:08:49 -08001420void scsi_eh_ready_devs(struct Scsi_Host *shost,
1421 struct list_head *work_q,
1422 struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423{
1424 if (!scsi_eh_stu(shost, work_q, done_q))
1425 if (!scsi_eh_bus_device_reset(shost, work_q, done_q))
1426 if (!scsi_eh_bus_reset(shost, work_q, done_q))
1427 if (!scsi_eh_host_reset(work_q, done_q))
1428 scsi_eh_offline_sdevs(work_q, done_q);
1429}
Darrick J. Wongdca84e42007-01-26 14:08:49 -08001430EXPORT_SYMBOL_GPL(scsi_eh_ready_devs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
1432/**
1433 * scsi_eh_flush_done_q - finish processed commands or retry them.
1434 * @done_q: list_head of processed commands.
1435 *
1436 **/
Tejun Heo041c5fc2006-01-23 13:09:36 +09001437void scsi_eh_flush_done_q(struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001439 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001441 list_for_each_entry_safe(scmd, next, done_q, eh_entry) {
1442 list_del_init(&scmd->eh_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 if (scsi_device_online(scmd->device) &&
1444 !blk_noretry_request(scmd->request) &&
Brian King8884efa2006-02-24 17:10:04 -06001445 (++scmd->retries <= scmd->allowed)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: flush"
1447 " retry cmd: %p\n",
1448 current->comm,
1449 scmd));
1450 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
1451 } else {
Patrick Mansfield 793698c2005-05-16 17:42:15 -07001452 /*
1453 * If just we got sense for the device (called
1454 * scsi_eh_get_sense), scmd->result is already
1455 * set, do not set DRIVER_TIMEOUT.
1456 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 if (!scmd->result)
1458 scmd->result |= (DRIVER_TIMEOUT << 24);
1459 SCSI_LOG_ERROR_RECOVERY(3, printk("%s: flush finish"
1460 " cmd: %p\n",
1461 current->comm, scmd));
1462 scsi_finish_command(scmd);
1463 }
1464 }
1465}
Tejun Heo041c5fc2006-01-23 13:09:36 +09001466EXPORT_SYMBOL(scsi_eh_flush_done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
1468/**
1469 * scsi_unjam_host - Attempt to fix a host which has a cmd that failed.
1470 * @shost: Host to unjam.
1471 *
1472 * Notes:
1473 * When we come in here, we *know* that all commands on the bus have
1474 * either completed, failed or timed out. we also know that no further
1475 * commands are being sent to the host, so things are relatively quiet
1476 * and we have freedom to fiddle with things as we wish.
1477 *
1478 * This is only the *default* implementation. it is possible for
1479 * individual drivers to supply their own version of this function, and
1480 * if the maintainer wishes to do this, it is strongly suggested that
1481 * this function be taken as a template and modified. this function
1482 * was designed to correctly handle problems for about 95% of the
1483 * different cases out there, and it should always provide at least a
1484 * reasonable amount of error recovery.
1485 *
1486 * Any command marked 'failed' or 'timeout' must eventually have
1487 * scsi_finish_cmd() called for it. we do all of the retry stuff
1488 * here, so when we restart the host after we return it should have an
1489 * empty queue.
1490 **/
1491static void scsi_unjam_host(struct Scsi_Host *shost)
1492{
1493 unsigned long flags;
1494 LIST_HEAD(eh_work_q);
1495 LIST_HEAD(eh_done_q);
1496
1497 spin_lock_irqsave(shost->host_lock, flags);
1498 list_splice_init(&shost->eh_cmd_q, &eh_work_q);
1499 spin_unlock_irqrestore(shost->host_lock, flags);
1500
1501 SCSI_LOG_ERROR_RECOVERY(1, scsi_eh_prt_fail_stats(shost, &eh_work_q));
1502
1503 if (!scsi_eh_get_sense(&eh_work_q, &eh_done_q))
1504 if (!scsi_eh_abort_cmds(&eh_work_q, &eh_done_q))
1505 scsi_eh_ready_devs(shost, &eh_work_q, &eh_done_q);
1506
1507 scsi_eh_flush_done_q(&eh_done_q);
1508}
1509
1510/**
Christoph Hellwigad42eb12005-10-29 01:01:55 +02001511 * scsi_error_handler - SCSI error handler thread
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 * @data: Host for which we are running.
1513 *
1514 * Notes:
Christoph Hellwigad42eb12005-10-29 01:01:55 +02001515 * This is the main error handling loop. This is run as a kernel thread
1516 * for every SCSI host and handles all error handling activity.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 **/
1518int scsi_error_handler(void *data)
1519{
Christoph Hellwigad42eb12005-10-29 01:01:55 +02001520 struct Scsi_Host *shost = data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 current->flags |= PF_NOFREEZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
1524 /*
Christoph Hellwigad42eb12005-10-29 01:01:55 +02001525 * We use TASK_INTERRUPTIBLE so that the thread is not
1526 * counted against the load average as a running process.
1527 * We never actually get interrupted because kthread_run
1528 * disables singal delivery for the created thread.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 */
James Bottomley3ed7a472005-09-19 09:50:04 -05001530 set_current_state(TASK_INTERRUPTIBLE);
1531 while (!kthread_should_stop()) {
Tejun Heoee7863b2006-05-15 20:57:20 +09001532 if ((shost->host_failed == 0 && shost->host_eh_scheduled == 0) ||
James Bottomley3ed7a472005-09-19 09:50:04 -05001533 shost->host_failed != shost->host_busy) {
Christoph Hellwigad42eb12005-10-29 01:01:55 +02001534 SCSI_LOG_ERROR_RECOVERY(1,
1535 printk("Error handler scsi_eh_%d sleeping\n",
1536 shost->host_no));
James Bottomley3ed7a472005-09-19 09:50:04 -05001537 schedule();
1538 set_current_state(TASK_INTERRUPTIBLE);
1539 continue;
1540 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
James Bottomley3ed7a472005-09-19 09:50:04 -05001542 __set_current_state(TASK_RUNNING);
Christoph Hellwigad42eb12005-10-29 01:01:55 +02001543 SCSI_LOG_ERROR_RECOVERY(1,
1544 printk("Error handler scsi_eh_%d waking up\n",
1545 shost->host_no));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 /*
1548 * We have a host that is failing for some reason. Figure out
1549 * what we need to do to get it up and online again (if we can).
1550 * If we fail, we end up taking the thing offline.
1551 */
Christoph Hellwig9227c332006-04-01 19:21:04 +02001552 if (shost->transportt->eh_strategy_handler)
1553 shost->transportt->eh_strategy_handler(shost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 else
1555 scsi_unjam_host(shost);
1556
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 /*
1558 * Note - if the above fails completely, the action is to take
1559 * individual devices offline and flush the queue of any
1560 * outstanding requests that may have been pending. When we
1561 * restart, we restart any I/O to any other devices on the bus
1562 * which are still online.
1563 */
1564 scsi_restart_operations(shost);
James Bottomley3ed7a472005-09-19 09:50:04 -05001565 set_current_state(TASK_INTERRUPTIBLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 }
Steven Rostedt461a0ff2005-10-19 08:22:13 -04001567 __set_current_state(TASK_RUNNING);
1568
Christoph Hellwigad42eb12005-10-29 01:01:55 +02001569 SCSI_LOG_ERROR_RECOVERY(1,
1570 printk("Error handler scsi_eh_%d exiting\n", shost->host_no));
James Bottomley3ed7a472005-09-19 09:50:04 -05001571 shost->ehandler = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 return 0;
1573}
1574
1575/*
1576 * Function: scsi_report_bus_reset()
1577 *
1578 * Purpose: Utility function used by low-level drivers to report that
1579 * they have observed a bus reset on the bus being handled.
1580 *
1581 * Arguments: shost - Host in question
1582 * channel - channel on which reset was observed.
1583 *
1584 * Returns: Nothing
1585 *
1586 * Lock status: Host lock must be held.
1587 *
1588 * Notes: This only needs to be called if the reset is one which
1589 * originates from an unknown location. Resets originated
1590 * by the mid-level itself don't need to call this, but there
1591 * should be no harm.
1592 *
1593 * The main purpose of this is to make sure that a CHECK_CONDITION
1594 * is properly treated.
1595 */
1596void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
1597{
1598 struct scsi_device *sdev;
1599
1600 __shost_for_each_device(sdev, shost) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04001601 if (channel == sdev_channel(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 sdev->was_reset = 1;
1603 sdev->expecting_cc_ua = 1;
1604 }
1605 }
1606}
1607EXPORT_SYMBOL(scsi_report_bus_reset);
1608
1609/*
1610 * Function: scsi_report_device_reset()
1611 *
1612 * Purpose: Utility function used by low-level drivers to report that
1613 * they have observed a device reset on the device being handled.
1614 *
1615 * Arguments: shost - Host in question
1616 * channel - channel on which reset was observed
1617 * target - target on which reset was observed
1618 *
1619 * Returns: Nothing
1620 *
1621 * Lock status: Host lock must be held
1622 *
1623 * Notes: This only needs to be called if the reset is one which
1624 * originates from an unknown location. Resets originated
1625 * by the mid-level itself don't need to call this, but there
1626 * should be no harm.
1627 *
1628 * The main purpose of this is to make sure that a CHECK_CONDITION
1629 * is properly treated.
1630 */
1631void scsi_report_device_reset(struct Scsi_Host *shost, int channel, int target)
1632{
1633 struct scsi_device *sdev;
1634
1635 __shost_for_each_device(sdev, shost) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04001636 if (channel == sdev_channel(sdev) &&
1637 target == sdev_id(sdev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 sdev->was_reset = 1;
1639 sdev->expecting_cc_ua = 1;
1640 }
1641 }
1642}
1643EXPORT_SYMBOL(scsi_report_device_reset);
1644
1645static void
1646scsi_reset_provider_done_command(struct scsi_cmnd *scmd)
1647{
1648}
1649
1650/*
1651 * Function: scsi_reset_provider
1652 *
1653 * Purpose: Send requested reset to a bus or device at any phase.
1654 *
1655 * Arguments: device - device to send reset to
1656 * flag - reset type (see scsi.h)
1657 *
1658 * Returns: SUCCESS/FAILURE.
1659 *
1660 * Notes: This is used by the SCSI Generic driver to provide
1661 * Bus/Device reset capability.
1662 */
1663int
1664scsi_reset_provider(struct scsi_device *dev, int flag)
1665{
1666 struct scsi_cmnd *scmd = scsi_get_command(dev, GFP_KERNEL);
James Smartd7a1bb02006-03-08 14:50:12 -05001667 struct Scsi_Host *shost = dev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 struct request req;
James Smartd7a1bb02006-03-08 14:50:12 -05001669 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 int rtn;
1671
1672 scmd->request = &req;
1673 memset(&scmd->eh_timeout, 0, sizeof(scmd->eh_timeout));
Christoph Hellwigb4edcbc2005-06-19 13:40:52 +02001674
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 memset(&scmd->cmnd, '\0', sizeof(scmd->cmnd));
1676
1677 scmd->scsi_done = scsi_reset_provider_done_command;
1678 scmd->done = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 scmd->request_buffer = NULL;
1680 scmd->request_bufflen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
1682 scmd->cmd_len = 0;
1683
1684 scmd->sc_data_direction = DMA_BIDIRECTIONAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
1686 init_timer(&scmd->eh_timeout);
1687
1688 /*
1689 * Sometimes the command can get back into the timer chain,
1690 * so use the pid as an identifier.
1691 */
1692 scmd->pid = 0;
1693
James Smartd7a1bb02006-03-08 14:50:12 -05001694 spin_lock_irqsave(shost->host_lock, flags);
1695 shost->tmf_in_progress = 1;
1696 spin_unlock_irqrestore(shost->host_lock, flags);
1697
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 switch (flag) {
1699 case SCSI_TRY_RESET_DEVICE:
1700 rtn = scsi_try_bus_device_reset(scmd);
1701 if (rtn == SUCCESS)
1702 break;
1703 /* FALLTHROUGH */
1704 case SCSI_TRY_RESET_BUS:
1705 rtn = scsi_try_bus_reset(scmd);
1706 if (rtn == SUCCESS)
1707 break;
1708 /* FALLTHROUGH */
1709 case SCSI_TRY_RESET_HOST:
1710 rtn = scsi_try_host_reset(scmd);
1711 break;
1712 default:
1713 rtn = FAILED;
1714 }
1715
James Smartd7a1bb02006-03-08 14:50:12 -05001716 spin_lock_irqsave(shost->host_lock, flags);
1717 shost->tmf_in_progress = 0;
1718 spin_unlock_irqrestore(shost->host_lock, flags);
1719
1720 /*
1721 * be sure to wake up anyone who was sleeping or had their queue
1722 * suspended while we performed the TMF.
1723 */
1724 SCSI_LOG_ERROR_RECOVERY(3,
1725 printk("%s: waking up host to restart after TMF\n",
1726 __FUNCTION__));
1727
1728 wake_up(&shost->host_wait);
1729
1730 scsi_run_host_queues(shost);
1731
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 scsi_next_command(scmd);
1733 return rtn;
1734}
1735EXPORT_SYMBOL(scsi_reset_provider);
1736
1737/**
1738 * scsi_normalize_sense - normalize main elements from either fixed or
1739 * descriptor sense data format into a common format.
1740 *
1741 * @sense_buffer: byte array containing sense data returned by device
1742 * @sb_len: number of valid bytes in sense_buffer
1743 * @sshdr: pointer to instance of structure that common
1744 * elements are written to.
1745 *
1746 * Notes:
1747 * The "main elements" from sense data are: response_code, sense_key,
1748 * asc, ascq and additional_length (only for descriptor format).
1749 *
1750 * Typically this function can be called after a device has
1751 * responded to a SCSI command with the CHECK_CONDITION status.
1752 *
1753 * Return value:
1754 * 1 if valid sense data information found, else 0;
1755 **/
1756int scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
1757 struct scsi_sense_hdr *sshdr)
1758{
James Bottomley33aa6872005-08-28 11:31:14 -05001759 if (!sense_buffer || !sb_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 return 0;
1761
1762 memset(sshdr, 0, sizeof(struct scsi_sense_hdr));
1763
1764 sshdr->response_code = (sense_buffer[0] & 0x7f);
James Bottomley33aa6872005-08-28 11:31:14 -05001765
1766 if (!scsi_sense_valid(sshdr))
1767 return 0;
1768
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 if (sshdr->response_code >= 0x72) {
1770 /*
1771 * descriptor format
1772 */
1773 if (sb_len > 1)
1774 sshdr->sense_key = (sense_buffer[1] & 0xf);
1775 if (sb_len > 2)
1776 sshdr->asc = sense_buffer[2];
1777 if (sb_len > 3)
1778 sshdr->ascq = sense_buffer[3];
1779 if (sb_len > 7)
1780 sshdr->additional_length = sense_buffer[7];
1781 } else {
1782 /*
1783 * fixed format
1784 */
1785 if (sb_len > 2)
1786 sshdr->sense_key = (sense_buffer[2] & 0xf);
1787 if (sb_len > 7) {
1788 sb_len = (sb_len < (sense_buffer[7] + 8)) ?
1789 sb_len : (sense_buffer[7] + 8);
1790 if (sb_len > 12)
1791 sshdr->asc = sense_buffer[12];
1792 if (sb_len > 13)
1793 sshdr->ascq = sense_buffer[13];
1794 }
1795 }
1796
1797 return 1;
1798}
1799EXPORT_SYMBOL(scsi_normalize_sense);
1800
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801int scsi_command_normalize_sense(struct scsi_cmnd *cmd,
1802 struct scsi_sense_hdr *sshdr)
1803{
1804 return scsi_normalize_sense(cmd->sense_buffer,
1805 sizeof(cmd->sense_buffer), sshdr);
1806}
1807EXPORT_SYMBOL(scsi_command_normalize_sense);
1808
1809/**
1810 * scsi_sense_desc_find - search for a given descriptor type in
1811 * descriptor sense data format.
1812 *
1813 * @sense_buffer: byte array of descriptor format sense data
1814 * @sb_len: number of valid bytes in sense_buffer
1815 * @desc_type: value of descriptor type to find
1816 * (e.g. 0 -> information)
1817 *
1818 * Notes:
1819 * only valid when sense data is in descriptor format
1820 *
1821 * Return value:
1822 * pointer to start of (first) descriptor if found else NULL
1823 **/
1824const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
1825 int desc_type)
1826{
1827 int add_sen_len, add_len, desc_len, k;
1828 const u8 * descp;
1829
1830 if ((sb_len < 8) || (0 == (add_sen_len = sense_buffer[7])))
1831 return NULL;
1832 if ((sense_buffer[0] < 0x72) || (sense_buffer[0] > 0x73))
1833 return NULL;
1834 add_sen_len = (add_sen_len < (sb_len - 8)) ?
1835 add_sen_len : (sb_len - 8);
1836 descp = &sense_buffer[8];
1837 for (desc_len = 0, k = 0; k < add_sen_len; k += desc_len) {
1838 descp += desc_len;
1839 add_len = (k < (add_sen_len - 1)) ? descp[1]: -1;
1840 desc_len = add_len + 2;
1841 if (descp[0] == desc_type)
1842 return descp;
1843 if (add_len < 0) // short descriptor ??
1844 break;
1845 }
1846 return NULL;
1847}
1848EXPORT_SYMBOL(scsi_sense_desc_find);
1849
1850/**
1851 * scsi_get_sense_info_fld - attempts to get information field from
1852 * sense data (either fixed or descriptor format)
1853 *
1854 * @sense_buffer: byte array of sense data
1855 * @sb_len: number of valid bytes in sense_buffer
1856 * @info_out: pointer to 64 integer where 8 or 4 byte information
1857 * field will be placed if found.
1858 *
1859 * Return value:
1860 * 1 if information field found, 0 if not found.
1861 **/
1862int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
1863 u64 * info_out)
1864{
1865 int j;
1866 const u8 * ucp;
1867 u64 ull;
1868
1869 if (sb_len < 7)
1870 return 0;
1871 switch (sense_buffer[0] & 0x7f) {
1872 case 0x70:
1873 case 0x71:
1874 if (sense_buffer[0] & 0x80) {
1875 *info_out = (sense_buffer[3] << 24) +
1876 (sense_buffer[4] << 16) +
1877 (sense_buffer[5] << 8) + sense_buffer[6];
1878 return 1;
1879 } else
1880 return 0;
1881 case 0x72:
1882 case 0x73:
1883 ucp = scsi_sense_desc_find(sense_buffer, sb_len,
1884 0 /* info desc */);
1885 if (ucp && (0xa == ucp[1])) {
1886 ull = 0;
1887 for (j = 0; j < 8; ++j) {
1888 if (j > 0)
1889 ull <<= 8;
1890 ull |= ucp[4 + j];
1891 }
1892 *info_out = ull;
1893 return 1;
1894 } else
1895 return 0;
1896 default:
1897 return 0;
1898 }
1899}
1900EXPORT_SYMBOL(scsi_get_sense_info_fld);