drivers/scsi/scsi_error.c

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