drivers/ata/libata-scsi.c

   1 /*
   2  *  libata-scsi.c - helper library for ATA
   3  *
   4  *  Maintained by:  Jeff Garzik <jgarzik@pobox.com>
   5  *                  Please ALWAYS copy linux-ide@vger.kernel.org
   6  *                  on emails.
   7  *
   8  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
   9  *  Copyright 2003-2004 Jeff Garzik
  10  *
  11  *
  12  *  This program is free software; you can redistribute it and/or modify
  13  *  it under the terms of the GNU General Public License as published by
  14  *  the Free Software Foundation; either version 2, or (at your option)
  15  *  any later version.
  16  *
  17  *  This program is distributed in the hope that it will be useful,
  18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  *  GNU General Public License for more details.
  21  *
  22  *  You should have received a copy of the GNU General Public License
  23  *  along with this program; see the file COPYING.  If not, write to
  24  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  25  *
  26  *
  27  *  libata documentation is available via 'make {ps|pdf}docs',
  28  *  as Documentation/DocBook/libata.*
  29  *
  30  *  Hardware documentation available from
  31  *  - http://www.t10.org/
  32  *  - http://www.t13.org/
  33  *
  34  */
  35
  36 #include <linux/kernel.h>
  37 #include <linux/blkdev.h>
  38 #include <linux/spinlock.h>
  39 #include <scsi/scsi.h>
  40 #include <scsi/scsi_host.h>
  41 #include <scsi/scsi_cmnd.h>
  42 #include <scsi/scsi_eh.h>
  43 #include <scsi/scsi_device.h>
  44 #include <scsi/scsi_tcq.h>
  45 #include <scsi/scsi_transport.h>
  46 #include <linux/libata.h>
  47 #include <linux/hdreg.h>
  48 #include <asm/uaccess.h>
  49
  50 #include "libata.h"
  51
  52 #define SECTOR_SIZE     512
  53
  54 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
  55
  56 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
  57                                         const struct scsi_device *scsidev);
  58 static struct ata_device * ata_scsi_find_dev(struct ata_port *ap,
  59                                             const struct scsi_device *scsidev);
  60 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
  61                               unsigned int id, unsigned int lun);
  62
  63
  64 #define RW_RECOVERY_MPAGE 0x1
  65 #define RW_RECOVERY_MPAGE_LEN 12
  66 #define CACHE_MPAGE 0x8
  67 #define CACHE_MPAGE_LEN 20
  68 #define CONTROL_MPAGE 0xa
  69 #define CONTROL_MPAGE_LEN 12
  70 #define ALL_MPAGES 0x3f
  71 #define ALL_SUB_MPAGES 0xff
  72
  73
  74 static const u8 def_rw_recovery_mpage[] = {
  75         RW_RECOVERY_MPAGE,
  76         RW_RECOVERY_MPAGE_LEN - 2,
  77         (1 << 7) |      /* AWRE, sat-r06 say it shall be 0 */
  78             (1 << 6),   /* ARRE (auto read reallocation) */
  79         0,              /* read retry count */
  80         0, 0, 0, 0,
  81         0,              /* write retry count */
  82         0, 0, 0
  83 };
  84
  85 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
  86         CACHE_MPAGE,
  87         CACHE_MPAGE_LEN - 2,
  88         0,              /* contains WCE, needs to be 0 for logic */
  89         0, 0, 0, 0, 0, 0, 0, 0, 0,
  90         0,              /* contains DRA, needs to be 0 for logic */
  91         0, 0, 0, 0, 0, 0, 0
  92 };
  93
  94 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
  95         CONTROL_MPAGE,
  96         CONTROL_MPAGE_LEN - 2,
  97         2,      /* DSENSE=0, GLTSD=1 */
  98         0,      /* [QAM+QERR may be 1, see 05-359r1] */
  99         0, 0, 0, 0, 0xff, 0xff,
 100         0, 30   /* extended self test time, see 05-359r1 */
 101 };
 102
 103 /*
 104  * libata transport template.  libata doesn't do real transport stuff.
 105  * It just needs the eh_timed_out hook.
 106  */
 107 static struct scsi_transport_template ata_scsi_transport_template = {
 108         .eh_strategy_handler    = ata_scsi_error,
 109         .eh_timed_out           = ata_scsi_timed_out,
 110         .user_scan              = ata_scsi_user_scan,
 111 };
 112
 113
 114 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
 115                                    void (*done)(struct scsi_cmnd *))
 116 {
 117         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
 118         /* "Invalid field in cbd" */
 119         done(cmd);
 120 }
 121
 122 /**
 123  *      ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
 124  *      @sdev: SCSI device for which BIOS geometry is to be determined
 125  *      @bdev: block device associated with @sdev
 126  *      @capacity: capacity of SCSI device
 127  *      @geom: location to which geometry will be output
 128  *
 129  *      Generic bios head/sector/cylinder calculator
 130  *      used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
 131  *      mapping. Some situations may arise where the disk is not
 132  *      bootable if this is not used.
 133  *
 134  *      LOCKING:
 135  *      Defined by the SCSI layer.  We don't really care.
 136  *
 137  *      RETURNS:
 138  *      Zero.
 139  */
 140 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
 141                        sector_t capacity, int geom[])
 142 {
 143         geom[0] = 255;
 144         geom[1] = 63;
 145         sector_div(capacity, 255*63);
 146         geom[2] = capacity;
 147
 148         return 0;
 149 }
 150
 151 /**
 152  *      ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
 153  *      @sdev: SCSI device to get identify data for
 154  *      @arg: User buffer area for identify data
 155  *
 156  *      LOCKING:
 157  *      Defined by the SCSI layer.  We don't really care.
 158  *
 159  *      RETURNS:
 160  *      Zero on success, negative errno on error.
 161  */
 162 static int ata_get_identity(struct scsi_device *sdev, void __user *arg)
 163 {
 164         struct ata_port *ap = ata_shost_to_port(sdev->host);
 165         struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
 166         u16 __user *dst = arg;
 167         char buf[40];
 168
 169         if (!dev)
 170                 return -ENOMSG;
 171
 172         if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
 173                 return -EFAULT;
 174
 175         ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
 176         if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
 177                 return -EFAULT;
 178
 179         ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
 180         if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
 181                 return -EFAULT;
 182
 183         ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
 184         if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
 185                 return -EFAULT;
 186
 187         return 0;
 188 }
 189
 190 /**
 191  *      ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
 192  *      @scsidev: Device to which we are issuing command
 193  *      @arg: User provided data for issuing command
 194  *
 195  *      LOCKING:
 196  *      Defined by the SCSI layer.  We don't really care.
 197  *
 198  *      RETURNS:
 199  *      Zero on success, negative errno on error.
 200  */
 201 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
 202 {
 203         int rc = 0;
 204         u8 scsi_cmd[MAX_COMMAND_SIZE];
 205         u8 args[4], *argbuf = NULL, *sensebuf = NULL;
 206         int argsize = 0;
 207         enum dma_data_direction data_dir;
 208         int cmd_result;
 209
 210         if (arg == NULL)
 211                 return -EINVAL;
 212
 213         if (copy_from_user(args, arg, sizeof(args)))
 214                 return -EFAULT;
 215
 216         sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
 217         if (!sensebuf)
 218                 return -ENOMEM;
 219
 220         memset(scsi_cmd, 0, sizeof(scsi_cmd));
 221
 222         if (args[3]) {
 223                 argsize = SECTOR_SIZE * args[3];
 224                 argbuf = kmalloc(argsize, GFP_KERNEL);
 225                 if (argbuf == NULL) {
 226                         rc = -ENOMEM;
 227                         goto error;
 228                 }
 229
 230                 scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
 231                 scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
 232                                             block count in sector count field */
 233                 data_dir = DMA_FROM_DEVICE;
 234         } else {
 235                 scsi_cmd[1]  = (3 << 1); /* Non-data */
 236                 scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
 237                 data_dir = DMA_NONE;
 238         }
 239
 240         scsi_cmd[0] = ATA_16;
 241
 242         scsi_cmd[4] = args[2];
 243         if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
 244                 scsi_cmd[6]  = args[3];
 245                 scsi_cmd[8]  = args[1];
 246                 scsi_cmd[10] = 0x4f;
 247                 scsi_cmd[12] = 0xc2;
 248         } else {
 249                 scsi_cmd[6]  = args[1];
 250         }
 251         scsi_cmd[14] = args[0];
 252
 253         /* Good values for timeout and retries?  Values below
 254            from scsi_ioctl_send_command() for default case... */
 255         cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
 256                                   sensebuf, (10*HZ), 5, 0);
 257
 258         if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
 259                 u8 *desc = sensebuf + 8;
 260                 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
 261
 262                 /* If we set cc then ATA pass-through will cause a
 263                  * check condition even if no error. Filter that. */
 264                 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
 265                         struct scsi_sense_hdr sshdr;
 266                         scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
 267                                               &sshdr);
 268                         if (sshdr.sense_key==0 &&
 269                             sshdr.asc==0 && sshdr.ascq==0)
 270                                 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
 271                 }
 272
 273                 /* Send userspace a few ATA registers (same as drivers/ide) */
 274                 if (sensebuf[0] == 0x72 &&     /* format is "descriptor" */
 275                     desc[0] == 0x09 ) {        /* code is "ATA Descriptor" */
 276                         args[0] = desc[13];    /* status */
 277                         args[1] = desc[3];     /* error */
 278                         args[2] = desc[5];     /* sector count (0:7) */
 279                         if (copy_to_user(arg, args, sizeof(args)))
 280                                 rc = -EFAULT;
 281                 }
 282         }
 283
 284
 285         if (cmd_result) {
 286                 rc = -EIO;
 287                 goto error;
 288         }
 289
 290         if ((argbuf)
 291          && copy_to_user(arg + sizeof(args), argbuf, argsize))
 292                 rc = -EFAULT;
 293 error:
 294         kfree(sensebuf);
 295         kfree(argbuf);
 296         return rc;
 297 }
 298
 299 /**
 300  *      ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
 301  *      @scsidev: Device to which we are issuing command
 302  *      @arg: User provided data for issuing command
 303  *
 304  *      LOCKING:
 305  *      Defined by the SCSI layer.  We don't really care.
 306  *
 307  *      RETURNS:
 308  *      Zero on success, negative errno on error.
 309  */
 310 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
 311 {
 312         int rc = 0;
 313         u8 scsi_cmd[MAX_COMMAND_SIZE];
 314         u8 args[7], *sensebuf = NULL;
 315         int cmd_result;
 316
 317         if (arg == NULL)
 318                 return -EINVAL;
 319
 320         if (copy_from_user(args, arg, sizeof(args)))
 321                 return -EFAULT;
 322
 323         sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
 324         if (!sensebuf)
 325                 return -ENOMEM;
 326
 327         memset(scsi_cmd, 0, sizeof(scsi_cmd));
 328         scsi_cmd[0]  = ATA_16;
 329         scsi_cmd[1]  = (3 << 1); /* Non-data */
 330         scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
 331         scsi_cmd[4]  = args[1];
 332         scsi_cmd[6]  = args[2];
 333         scsi_cmd[8]  = args[3];
 334         scsi_cmd[10] = args[4];
 335         scsi_cmd[12] = args[5];
 336         scsi_cmd[13] = args[6] & 0x4f;
 337         scsi_cmd[14] = args[0];
 338
 339         /* Good values for timeout and retries?  Values below
 340            from scsi_ioctl_send_command() for default case... */
 341         cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
 342                                 sensebuf, (10*HZ), 5, 0);
 343
 344         if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
 345                 u8 *desc = sensebuf + 8;
 346                 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
 347
 348                 /* If we set cc then ATA pass-through will cause a
 349                  * check condition even if no error. Filter that. */
 350                 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
 351                         struct scsi_sense_hdr sshdr;
 352                         scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
 353                                                 &sshdr);
 354                         if (sshdr.sense_key==0 &&
 355                                 sshdr.asc==0 && sshdr.ascq==0)
 356                                 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
 357                 }
 358
 359                 /* Send userspace ATA registers */
 360                 if (sensebuf[0] == 0x72 &&      /* format is "descriptor" */
 361                                 desc[0] == 0x09) {/* code is "ATA Descriptor" */
 362                         args[0] = desc[13];     /* status */
 363                         args[1] = desc[3];      /* error */
 364                         args[2] = desc[5];      /* sector count (0:7) */
 365                         args[3] = desc[7];      /* lbal */
 366                         args[4] = desc[9];      /* lbam */
 367                         args[5] = desc[11];     /* lbah */
 368                         args[6] = desc[12];     /* select */
 369                         if (copy_to_user(arg, args, sizeof(args)))
 370                                 rc = -EFAULT;
 371                 }
 372         }
 373
 374         if (cmd_result) {
 375                 rc = -EIO;
 376                 goto error;
 377         }
 378
 379  error:
 380         kfree(sensebuf);
 381         return rc;
 382 }
 383
 384 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
 385 {
 386         int val = -EINVAL, rc = -EINVAL;
 387
 388         switch (cmd) {
 389         case ATA_IOC_GET_IO32:
 390                 val = 0;
 391                 if (copy_to_user(arg, &val, 1))
 392                         return -EFAULT;
 393                 return 0;
 394
 395         case ATA_IOC_SET_IO32:
 396                 val = (unsigned long) arg;
 397                 if (val != 0)
 398                         return -EINVAL;
 399                 return 0;
 400
 401         case HDIO_GET_IDENTITY:
 402                 return ata_get_identity(scsidev, arg);
 403
 404         case HDIO_DRIVE_CMD:
 405                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 406                         return -EACCES;
 407                 return ata_cmd_ioctl(scsidev, arg);
 408
 409         case HDIO_DRIVE_TASK:
 410                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 411                         return -EACCES;
 412                 return ata_task_ioctl(scsidev, arg);
 413
 414         default:
 415                 rc = -ENOTTY;
 416                 break;
 417         }
 418
 419         return rc;
 420 }
 421
 422 /**
 423  *      ata_scsi_qc_new - acquire new ata_queued_cmd reference
 424  *      @dev: ATA device to which the new command is attached
 425  *      @cmd: SCSI command that originated this ATA command
 426  *      @done: SCSI command completion function
 427  *
 428  *      Obtain a reference to an unused ata_queued_cmd structure,
 429  *      which is the basic libata structure representing a single
 430  *      ATA command sent to the hardware.
 431  *
 432  *      If a command was available, fill in the SCSI-specific
 433  *      portions of the structure with information on the
 434  *      current command.
 435  *
 436  *      LOCKING:
 437  *      spin_lock_irqsave(host lock)
 438  *
 439  *      RETURNS:
 440  *      Command allocated, or %NULL if none available.
 441  */
 442 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
 443                                               struct scsi_cmnd *cmd,
 444                                               void (*done)(struct scsi_cmnd *))
 445 {
 446         struct ata_queued_cmd *qc;
 447
 448         qc = ata_qc_new_init(dev);
 449         if (qc) {
 450                 qc->scsicmd = cmd;
 451                 qc->scsidone = done;
 452
 453                 if (cmd->use_sg) {
 454                         qc->__sg = (struct scatterlist *) cmd->request_buffer;
 455                         qc->n_elem = cmd->use_sg;
 456                 } else if (cmd->request_bufflen) {
 457                         qc->__sg = &qc->sgent;
 458                         qc->n_elem = 1;
 459                 }
 460         } else {
 461                 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
 462                 done(cmd);
 463         }
 464
 465         return qc;
 466 }
 467
 468 /**
 469  *      ata_dump_status - user friendly display of error info
 470  *      @id: id of the port in question
 471  *      @tf: ptr to filled out taskfile
 472  *
 473  *      Decode and dump the ATA error/status registers for the user so
 474  *      that they have some idea what really happened at the non
 475  *      make-believe layer.
 476  *
 477  *      LOCKING:
 478  *      inherited from caller
 479  */
 480 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
 481 {
 482         u8 stat = tf->command, err = tf->feature;
 483
 484         printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
 485         if (stat & ATA_BUSY) {
 486                 printk("Busy }\n");     /* Data is not valid in this case */
 487         } else {
 488                 if (stat & 0x40)        printk("DriveReady ");
 489                 if (stat & 0x20)        printk("DeviceFault ");
 490                 if (stat & 0x10)        printk("SeekComplete ");
 491                 if (stat & 0x08)        printk("DataRequest ");
 492                 if (stat & 0x04)        printk("CorrectedError ");
 493                 if (stat & 0x02)        printk("Index ");
 494                 if (stat & 0x01)        printk("Error ");
 495                 printk("}\n");
 496
 497                 if (err) {
 498                         printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
 499                         if (err & 0x04)         printk("DriveStatusError ");
 500                         if (err & 0x80) {
 501                                 if (err & 0x04) printk("BadCRC ");
 502                                 else            printk("Sector ");
 503                         }
 504                         if (err & 0x40)         printk("UncorrectableError ");
 505                         if (err & 0x10)         printk("SectorIdNotFound ");
 506                         if (err & 0x02)         printk("TrackZeroNotFound ");
 507                         if (err & 0x01)         printk("AddrMarkNotFound ");
 508                         printk("}\n");
 509                 }
 510         }
 511 }
 512
 513 /**
 514  *      ata_to_sense_error - convert ATA error to SCSI error
 515  *      @id: ATA device number
 516  *      @drv_stat: value contained in ATA status register
 517  *      @drv_err: value contained in ATA error register
 518  *      @sk: the sense key we'll fill out
 519  *      @asc: the additional sense code we'll fill out
 520  *      @ascq: the additional sense code qualifier we'll fill out
 521  *      @verbose: be verbose
 522  *
 523  *      Converts an ATA error into a SCSI error.  Fill out pointers to
 524  *      SK, ASC, and ASCQ bytes for later use in fixed or descriptor
 525  *      format sense blocks.
 526  *
 527  *      LOCKING:
 528  *      spin_lock_irqsave(host lock)
 529  */
 530 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
 531                                u8 *asc, u8 *ascq, int verbose)
 532 {
 533         int i;
 534
 535         /* Based on the 3ware driver translation table */
 536         static const unsigned char sense_table[][4] = {
 537                 /* BBD|ECC|ID|MAR */
 538                 {0xd1,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
 539                 /* BBD|ECC|ID */
 540                 {0xd0,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
 541                 /* ECC|MC|MARK */
 542                 {0x61,          HARDWARE_ERROR, 0x00, 0x00},    // Device fault                 Hardware error
 543                 /* ICRC|ABRT */         /* NB: ICRC & !ABRT is BBD */
 544                 {0x84,          ABORTED_COMMAND, 0x47, 0x00},   // Data CRC error               SCSI parity error
 545                 /* MC|ID|ABRT|TRK0|MARK */
 546                 {0x37,          NOT_READY, 0x04, 0x00},         // Unit offline                 Not ready
 547                 /* MCR|MARK */
 548                 {0x09,          NOT_READY, 0x04, 0x00},         // Unrecovered disk error       Not ready
 549                 /*  Bad address mark */
 550                 {0x01,          MEDIUM_ERROR, 0x13, 0x00},      // Address mark not found       Address mark not found for data field
 551                 /* TRK0 */
 552                 {0x02,          HARDWARE_ERROR, 0x00, 0x00},    // Track 0 not found              Hardware error
 553                 /* Abort & !ICRC */
 554                 {0x04,          ABORTED_COMMAND, 0x00, 0x00},   // Aborted command              Aborted command
 555                 /* Media change request */
 556                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change request   FIXME: faking offline
 557                 /* SRV */
 558                 {0x10,          ABORTED_COMMAND, 0x14, 0x00},   // ID not found                 Recorded entity not found
 559                 /* Media change */
 560                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change           FIXME: faking offline
 561                 /* ECC */
 562                 {0x40,          MEDIUM_ERROR, 0x11, 0x04},      // Uncorrectable ECC error      Unrecovered read error
 563                 /* BBD - block marked bad */
 564                 {0x80,          MEDIUM_ERROR, 0x11, 0x04},      // Block marked bad               Medium error, unrecovered read error
 565                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
 566         };
 567         static const unsigned char stat_table[][4] = {
 568                 /* Must be first because BUSY means no other bits valid */
 569                 {0x80,          ABORTED_COMMAND, 0x47, 0x00},   // Busy, fake parity for now
 570                 {0x20,          HARDWARE_ERROR,  0x00, 0x00},   // Device fault
 571                 {0x08,          ABORTED_COMMAND, 0x47, 0x00},   // Timed out in xfer, fake parity for now
 572                 {0x04,          RECOVERED_ERROR, 0x11, 0x00},   // Recovered ECC error    Medium error, recovered
 573                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
 574         };
 575
 576         /*
 577          *      Is this an error we can process/parse
 578          */
 579         if (drv_stat & ATA_BUSY) {
 580                 drv_err = 0;    /* Ignore the err bits, they're invalid */
 581         }
 582
 583         if (drv_err) {
 584                 /* Look for drv_err */
 585                 for (i = 0; sense_table[i][0] != 0xFF; i++) {
 586                         /* Look for best matches first */
 587                         if ((sense_table[i][0] & drv_err) ==
 588                             sense_table[i][0]) {
 589                                 *sk = sense_table[i][1];
 590                                 *asc = sense_table[i][2];
 591                                 *ascq = sense_table[i][3];
 592                                 goto translate_done;
 593                         }
 594                 }
 595                 /* No immediate match */
 596                 if (verbose)
 597                         printk(KERN_WARNING "ata%u: no sense translation for "
 598                                "error 0x%02x\n", id, drv_err);
 599         }
 600
 601         /* Fall back to interpreting status bits */
 602         for (i = 0; stat_table[i][0] != 0xFF; i++) {
 603                 if (stat_table[i][0] & drv_stat) {
 604                         *sk = stat_table[i][1];
 605                         *asc = stat_table[i][2];
 606                         *ascq = stat_table[i][3];
 607                         goto translate_done;
 608                 }
 609         }
 610         /* No error?  Undecoded? */
 611         if (verbose)
 612                 printk(KERN_WARNING "ata%u: no sense translation for "
 613                        "status: 0x%02x\n", id, drv_stat);
 614
 615         /* We need a sensible error return here, which is tricky, and one
 616            that won't cause people to do things like return a disk wrongly */
 617         *sk = ABORTED_COMMAND;
 618         *asc = 0x00;
 619         *ascq = 0x00;
 620
 621  translate_done:
 622         if (verbose)
 623                 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
 624                        "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
 625                        id, drv_stat, drv_err, *sk, *asc, *ascq);
 626         return;
 627 }
 628
 629 /*
 630  *      ata_gen_passthru_sense - Generate check condition sense block.
 631  *      @qc: Command that completed.
 632  *
 633  *      This function is specific to the ATA descriptor format sense
 634  *      block specified for the ATA pass through commands.  Regardless
 635  *      of whether the command errored or not, return a sense
 636  *      block. Copy all controller registers into the sense
 637  *      block. Clear sense key, ASC & ASCQ if there is no error.
 638  *
 639  *      LOCKING:
 640  *      None.
 641  */
 642 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
 643 {
 644         struct scsi_cmnd *cmd = qc->scsicmd;
 645         struct ata_taskfile *tf = &qc->result_tf;
 646         unsigned char *sb = cmd->sense_buffer;
 647         unsigned char *desc = sb + 8;
 648         int verbose = qc->ap->ops->error_handler == NULL;
 649
 650         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
 651
 652         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
 653
 654         /*
 655          * Use ata_to_sense_error() to map status register bits
 656          * onto sense key, asc & ascq.
 657          */
 658         if (qc->err_mask ||
 659             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
 660                 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
 661                                    &sb[1], &sb[2], &sb[3], verbose);
 662                 sb[1] &= 0x0f;
 663         }
 664
 665         /*
 666          * Sense data is current and format is descriptor.
 667          */
 668         sb[0] = 0x72;
 669
 670         desc[0] = 0x09;
 671
 672         /* set length of additional sense data */
 673         sb[7] = 14;
 674         desc[1] = 12;
 675
 676         /*
 677          * Copy registers into sense buffer.
 678          */
 679         desc[2] = 0x00;
 680         desc[3] = tf->feature;  /* == error reg */
 681         desc[5] = tf->nsect;
 682         desc[7] = tf->lbal;
 683         desc[9] = tf->lbam;
 684         desc[11] = tf->lbah;
 685         desc[12] = tf->device;
 686         desc[13] = tf->command; /* == status reg */
 687
 688         /*
 689          * Fill in Extend bit, and the high order bytes
 690          * if applicable.
 691          */
 692         if (tf->flags & ATA_TFLAG_LBA48) {
 693                 desc[2] |= 0x01;
 694                 desc[4] = tf->hob_nsect;
 695                 desc[6] = tf->hob_lbal;
 696                 desc[8] = tf->hob_lbam;
 697                 desc[10] = tf->hob_lbah;
 698         }
 699 }
 700
 701 /**
 702  *      ata_gen_ata_sense - generate a SCSI fixed sense block
 703  *      @qc: Command that we are erroring out
 704  *
 705  *      Generate sense block for a failed ATA command @qc.  Descriptor
 706  *      format is used to accomodate LBA48 block address.
 707  *
 708  *      LOCKING:
 709  *      None.
 710  */
 711 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
 712 {
 713         struct ata_device *dev = qc->dev;
 714         struct scsi_cmnd *cmd = qc->scsicmd;
 715         struct ata_taskfile *tf = &qc->result_tf;
 716         unsigned char *sb = cmd->sense_buffer;
 717         unsigned char *desc = sb + 8;
 718         int verbose = qc->ap->ops->error_handler == NULL;
 719         u64 block;
 720
 721         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
 722
 723         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
 724
 725         /* sense data is current and format is descriptor */
 726         sb[0] = 0x72;
 727
 728         /* Use ata_to_sense_error() to map status register bits
 729          * onto sense key, asc & ascq.
 730          */
 731         if (qc->err_mask ||
 732             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
 733                 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
 734                                    &sb[1], &sb[2], &sb[3], verbose);
 735                 sb[1] &= 0x0f;
 736         }
 737
 738         block = ata_tf_read_block(&qc->result_tf, dev);
 739
 740         /* information sense data descriptor */
 741         sb[7] = 12;
 742         desc[0] = 0x00;
 743         desc[1] = 10;
 744
 745         desc[2] |= 0x80;        /* valid */
 746         desc[6] = block >> 40;
 747         desc[7] = block >> 32;
 748         desc[8] = block >> 24;
 749         desc[9] = block >> 16;
 750         desc[10] = block >> 8;
 751         desc[11] = block;
 752 }
 753
 754 static void ata_scsi_sdev_config(struct scsi_device *sdev)
 755 {
 756         sdev->use_10_for_rw = 1;
 757         sdev->use_10_for_ms = 1;
 758 }
 759
 760 static void ata_scsi_dev_config(struct scsi_device *sdev,
 761                                 struct ata_device *dev)
 762 {
 763         /* configure max sectors */
 764         blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
 765
 766         /* SATA DMA transfers must be multiples of 4 byte, so
 767          * we need to pad ATAPI transfers using an extra sg.
 768          * Decrement max hw segments accordingly.
 769          */
 770         if (dev->class == ATA_DEV_ATAPI) {
 771                 request_queue_t *q = sdev->request_queue;
 772                 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
 773         }
 774
 775         if (dev->flags & ATA_DFLAG_NCQ) {
 776                 int depth;
 777
 778                 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
 779                 depth = min(ATA_MAX_QUEUE - 1, depth);
 780                 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
 781         }
 782 }
 783
 784 /**
 785  *      ata_scsi_slave_config - Set SCSI device attributes
 786  *      @sdev: SCSI device to examine
 787  *
 788  *      This is called before we actually start reading
 789  *      and writing to the device, to configure certain
 790  *      SCSI mid-layer behaviors.
 791  *
 792  *      LOCKING:
 793  *      Defined by SCSI layer.  We don't really care.
 794  */
 795
 796 int ata_scsi_slave_config(struct scsi_device *sdev)
 797 {
 798         struct ata_port *ap = ata_shost_to_port(sdev->host);
 799         struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
 800
 801         ata_scsi_sdev_config(sdev);
 802
 803         blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
 804
 805         sdev->manage_start_stop = 1;
 806
 807         if (dev)
 808                 ata_scsi_dev_config(sdev, dev);
 809
 810         return 0;       /* scsi layer doesn't check return value, sigh */
 811 }
 812
 813 /**
 814  *      ata_scsi_slave_destroy - SCSI device is about to be destroyed
 815  *      @sdev: SCSI device to be destroyed
 816  *
 817  *      @sdev is about to be destroyed for hot/warm unplugging.  If
 818  *      this unplugging was initiated by libata as indicated by NULL
 819  *      dev->sdev, this function doesn't have to do anything.
 820  *      Otherwise, SCSI layer initiated warm-unplug is in progress.
 821  *      Clear dev->sdev, schedule the device for ATA detach and invoke
 822  *      EH.
 823  *
 824  *      LOCKING:
 825  *      Defined by SCSI layer.  We don't really care.
 826  */
 827 void ata_scsi_slave_destroy(struct scsi_device *sdev)
 828 {
 829         struct ata_port *ap = ata_shost_to_port(sdev->host);
 830         unsigned long flags;
 831         struct ata_device *dev;
 832
 833         if (!ap->ops->error_handler)
 834                 return;
 835
 836         spin_lock_irqsave(ap->lock, flags);
 837         dev = __ata_scsi_find_dev(ap, sdev);
 838         if (dev && dev->sdev) {
 839                 /* SCSI device already in CANCEL state, no need to offline it */
 840                 dev->sdev = NULL;
 841                 dev->flags |= ATA_DFLAG_DETACH;
 842                 ata_port_schedule_eh(ap);
 843         }
 844         spin_unlock_irqrestore(ap->lock, flags);
 845 }
 846
 847 /**
 848  *      ata_scsi_change_queue_depth - SCSI callback for queue depth config
 849  *      @sdev: SCSI device to configure queue depth for
 850  *      @queue_depth: new queue depth
 851  *
 852  *      This is libata standard hostt->change_queue_depth callback.
 853  *      SCSI will call into this callback when user tries to set queue
 854  *      depth via sysfs.
 855  *
 856  *      LOCKING:
 857  *      SCSI layer (we don't care)
 858  *
 859  *      RETURNS:
 860  *      Newly configured queue depth.
 861  */
 862 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
 863 {
 864         struct ata_port *ap = ata_shost_to_port(sdev->host);
 865         struct ata_device *dev;
 866         unsigned long flags;
 867
 868         if (queue_depth < 1 || queue_depth == sdev->queue_depth)
 869                 return sdev->queue_depth;
 870
 871         dev = ata_scsi_find_dev(ap, sdev);
 872         if (!dev || !ata_dev_enabled(dev))
 873                 return sdev->queue_depth;
 874
 875         /* NCQ enabled? */
 876         spin_lock_irqsave(ap->lock, flags);
 877         dev->flags &= ~ATA_DFLAG_NCQ_OFF;
 878         if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
 879                 dev->flags |= ATA_DFLAG_NCQ_OFF;
 880                 queue_depth = 1;
 881         }
 882         spin_unlock_irqrestore(ap->lock, flags);
 883
 884         /* limit and apply queue depth */
 885         queue_depth = min(queue_depth, sdev->host->can_queue);
 886         queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
 887         queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
 888
 889         if (sdev->queue_depth == queue_depth)
 890                 return -EINVAL;
 891
 892         scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
 893         return queue_depth;
 894 }
 895
 896 /* XXX: for spindown warning */
 897 static void ata_delayed_done_timerfn(unsigned long arg)
 898 {
 899         struct scsi_cmnd *scmd = (void *)arg;
 900
 901         scmd->scsi_done(scmd);
 902 }
 903
 904 /* XXX: for spindown warning */
 905 static void ata_delayed_done(struct scsi_cmnd *scmd)
 906 {
 907         static struct timer_list timer;
 908
 909         setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
 910         mod_timer(&timer, jiffies + 5 * HZ);
 911 }
 912
 913 /**
 914  *      ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
 915  *      @qc: Storage for translated ATA taskfile
 916  *
 917  *      Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
 918  *      (to start). Perhaps these commands should be preceded by
 919  *      CHECK POWER MODE to see what power mode the device is already in.
 920  *      [See SAT revision 5 at www.t10.org]
 921  *
 922  *      LOCKING:
 923  *      spin_lock_irqsave(host lock)
 924  *
 925  *      RETURNS:
 926  *      Zero on success, non-zero on error.
 927  */
 928 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
 929 {
 930         struct scsi_cmnd *scmd = qc->scsicmd;
 931         struct ata_taskfile *tf = &qc->tf;
 932         const u8 *cdb = scmd->cmnd;
 933
 934         if (scmd->cmd_len < 5)
 935                 goto invalid_fld;
 936
 937         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
 938         tf->protocol = ATA_PROT_NODATA;
 939         if (cdb[1] & 0x1) {
 940                 ;       /* ignore IMMED bit, violates sat-r05 */
 941         }
 942         if (cdb[4] & 0x2)
 943                 goto invalid_fld;       /* LOEJ bit set not supported */
 944         if (((cdb[4] >> 4) & 0xf) != 0)
 945                 goto invalid_fld;       /* power conditions not supported */
 946         if (cdb[4] & 0x1) {
 947                 tf->nsect = 1;  /* 1 sector, lba=0 */
 948
 949                 if (qc->dev->flags & ATA_DFLAG_LBA) {
 950                         tf->flags |= ATA_TFLAG_LBA;
 951
 952                         tf->lbah = 0x0;
 953                         tf->lbam = 0x0;
 954                         tf->lbal = 0x0;
 955                         tf->device |= ATA_LBA;
 956                 } else {
 957                         /* CHS */
 958                         tf->lbal = 0x1; /* sect */
 959                         tf->lbam = 0x0; /* cyl low */
 960                         tf->lbah = 0x0; /* cyl high */
 961                 }
 962
 963                 tf->command = ATA_CMD_VERIFY;   /* READ VERIFY */
 964         } else {
 965                 /* XXX: This is for backward compatibility, will be
 966                  * removed.  Read Documentation/feature-removal-schedule.txt
 967                  * for more info.
 968                  */
 969                 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
 970                     (system_state == SYSTEM_HALT ||
 971                      system_state == SYSTEM_POWER_OFF)) {
 972                         static unsigned long warned = 0;
 973
 974                         if (!test_and_set_bit(0, &warned)) {
 975                                 ata_dev_printk(qc->dev, KERN_WARNING,
 976                                         "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
 977                                         "UPDATE SHUTDOWN UTILITY\n");
 978                                 ata_dev_printk(qc->dev, KERN_WARNING,
 979                                         "For more info, visit "
 980                                         "http://linux-ata.org/shutdown.html\n");
 981
 982                                 /* ->scsi_done is not used, use it for
 983                                  * delayed completion.
 984                                  */
 985                                 scmd->scsi_done = qc->scsidone;
 986                                 qc->scsidone = ata_delayed_done;
 987                         }
 988                         scmd->result = SAM_STAT_GOOD;
 989                         return 1;
 990                 }
 991
 992                 /* Issue ATA STANDBY IMMEDIATE command */
 993                 tf->command = ATA_CMD_STANDBYNOW1;
 994         }
 995
 996         /*
 997          * Standby and Idle condition timers could be implemented but that
 998          * would require libata to implement the Power condition mode page
 999          * and allow the user to change it. Changing mode pages requires
1000          * MODE SELECT to be implemented.
1001          */
1002
1003         return 0;
1004
1005 invalid_fld:
1006         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1007         /* "Invalid field in cbd" */
1008         return 1;
1009 }
1010
1011
1012 /**
1013  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1014  *      @qc: Storage for translated ATA taskfile
1015  *
1016  *      Sets up an ATA taskfile to issue FLUSH CACHE or
1017  *      FLUSH CACHE EXT.
1018  *
1019  *      LOCKING:
1020  *      spin_lock_irqsave(host lock)
1021  *
1022  *      RETURNS:
1023  *      Zero on success, non-zero on error.
1024  */
1025 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1026 {
1027         struct ata_taskfile *tf = &qc->tf;
1028
1029         tf->flags |= ATA_TFLAG_DEVICE;
1030         tf->protocol = ATA_PROT_NODATA;
1031
1032         if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1033                 tf->command = ATA_CMD_FLUSH_EXT;
1034         else
1035                 tf->command = ATA_CMD_FLUSH;
1036
1037         return 0;
1038 }
1039
1040 /**
1041  *      scsi_6_lba_len - Get LBA and transfer length
1042  *      @cdb: SCSI command to translate
1043  *
1044  *      Calculate LBA and transfer length for 6-byte commands.
1045  *
1046  *      RETURNS:
1047  *      @plba: the LBA
1048  *      @plen: the transfer length
1049  */
1050 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1051 {
1052         u64 lba = 0;
1053         u32 len = 0;
1054
1055         VPRINTK("six-byte command\n");
1056
1057         lba |= ((u64)cdb[2]) << 8;
1058         lba |= ((u64)cdb[3]);
1059
1060         len |= ((u32)cdb[4]);
1061
1062         *plba = lba;
1063         *plen = len;
1064 }
1065
1066 /**
1067  *      scsi_10_lba_len - Get LBA and transfer length
1068  *      @cdb: SCSI command to translate
1069  *
1070  *      Calculate LBA and transfer length for 10-byte commands.
1071  *
1072  *      RETURNS:
1073  *      @plba: the LBA
1074  *      @plen: the transfer length
1075  */
1076 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1077 {
1078         u64 lba = 0;
1079         u32 len = 0;
1080
1081         VPRINTK("ten-byte command\n");
1082
1083         lba |= ((u64)cdb[2]) << 24;
1084         lba |= ((u64)cdb[3]) << 16;
1085         lba |= ((u64)cdb[4]) << 8;
1086         lba |= ((u64)cdb[5]);
1087
1088         len |= ((u32)cdb[7]) << 8;
1089         len |= ((u32)cdb[8]);
1090
1091         *plba = lba;
1092         *plen = len;
1093 }
1094
1095 /**
1096  *      scsi_16_lba_len - Get LBA and transfer length
1097  *      @cdb: SCSI command to translate
1098  *
1099  *      Calculate LBA and transfer length for 16-byte commands.
1100  *
1101  *      RETURNS:
1102  *      @plba: the LBA
1103  *      @plen: the transfer length
1104  */
1105 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1106 {
1107         u64 lba = 0;
1108         u32 len = 0;
1109
1110         VPRINTK("sixteen-byte command\n");
1111
1112         lba |= ((u64)cdb[2]) << 56;
1113         lba |= ((u64)cdb[3]) << 48;
1114         lba |= ((u64)cdb[4]) << 40;
1115         lba |= ((u64)cdb[5]) << 32;
1116         lba |= ((u64)cdb[6]) << 24;
1117         lba |= ((u64)cdb[7]) << 16;
1118         lba |= ((u64)cdb[8]) << 8;
1119         lba |= ((u64)cdb[9]);
1120
1121         len |= ((u32)cdb[10]) << 24;
1122         len |= ((u32)cdb[11]) << 16;
1123         len |= ((u32)cdb[12]) << 8;
1124         len |= ((u32)cdb[13]);
1125
1126         *plba = lba;
1127         *plen = len;
1128 }
1129
1130 /**
1131  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1132  *      @qc: Storage for translated ATA taskfile
1133  *
1134  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
1135  *
1136  *      LOCKING:
1137  *      spin_lock_irqsave(host lock)
1138  *
1139  *      RETURNS:
1140  *      Zero on success, non-zero on error.
1141  */
1142 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1143 {
1144         struct scsi_cmnd *scmd = qc->scsicmd;
1145         struct ata_taskfile *tf = &qc->tf;
1146         struct ata_device *dev = qc->dev;
1147         u64 dev_sectors = qc->dev->n_sectors;
1148         const u8 *cdb = scmd->cmnd;
1149         u64 block;
1150         u32 n_block;
1151
1152         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1153         tf->protocol = ATA_PROT_NODATA;
1154
1155         if (cdb[0] == VERIFY) {
1156                 if (scmd->cmd_len < 10)
1157                         goto invalid_fld;
1158                 scsi_10_lba_len(cdb, &block, &n_block);
1159         } else if (cdb[0] == VERIFY_16) {
1160                 if (scmd->cmd_len < 16)
1161                         goto invalid_fld;
1162                 scsi_16_lba_len(cdb, &block, &n_block);
1163         } else
1164                 goto invalid_fld;
1165
1166         if (!n_block)
1167                 goto nothing_to_do;
1168         if (block >= dev_sectors)
1169                 goto out_of_range;
1170         if ((block + n_block) > dev_sectors)
1171                 goto out_of_range;
1172
1173         if (dev->flags & ATA_DFLAG_LBA) {
1174                 tf->flags |= ATA_TFLAG_LBA;
1175
1176                 if (lba_28_ok(block, n_block)) {
1177                         /* use LBA28 */
1178                         tf->command = ATA_CMD_VERIFY;
1179                         tf->device |= (block >> 24) & 0xf;
1180                 } else if (lba_48_ok(block, n_block)) {
1181                         if (!(dev->flags & ATA_DFLAG_LBA48))
1182                                 goto out_of_range;
1183
1184                         /* use LBA48 */
1185                         tf->flags |= ATA_TFLAG_LBA48;
1186                         tf->command = ATA_CMD_VERIFY_EXT;
1187
1188                         tf->hob_nsect = (n_block >> 8) & 0xff;
1189
1190                         tf->hob_lbah = (block >> 40) & 0xff;
1191                         tf->hob_lbam = (block >> 32) & 0xff;
1192                         tf->hob_lbal = (block >> 24) & 0xff;
1193                 } else
1194                         /* request too large even for LBA48 */
1195                         goto out_of_range;
1196
1197                 tf->nsect = n_block & 0xff;
1198
1199                 tf->lbah = (block >> 16) & 0xff;
1200                 tf->lbam = (block >> 8) & 0xff;
1201                 tf->lbal = block & 0xff;
1202
1203                 tf->device |= ATA_LBA;
1204         } else {
1205                 /* CHS */
1206                 u32 sect, head, cyl, track;
1207
1208                 if (!lba_28_ok(block, n_block))
1209                         goto out_of_range;
1210
1211                 /* Convert LBA to CHS */
1212                 track = (u32)block / dev->sectors;
1213                 cyl   = track / dev->heads;
1214                 head  = track % dev->heads;
1215                 sect  = (u32)block % dev->sectors + 1;
1216
1217                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1218                         (u32)block, track, cyl, head, sect);
1219
1220                 /* Check whether the converted CHS can fit.
1221                    Cylinder: 0-65535
1222                    Head: 0-15
1223                    Sector: 1-255*/
1224                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1225                         goto out_of_range;
1226
1227                 tf->command = ATA_CMD_VERIFY;
1228                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1229                 tf->lbal = sect;
1230                 tf->lbam = cyl;
1231                 tf->lbah = cyl >> 8;
1232                 tf->device |= head;
1233         }
1234
1235         return 0;
1236
1237 invalid_fld:
1238         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1239         /* "Invalid field in cbd" */
1240         return 1;
1241
1242 out_of_range:
1243         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1244         /* "Logical Block Address out of range" */
1245         return 1;
1246
1247 nothing_to_do:
1248         scmd->result = SAM_STAT_GOOD;
1249         return 1;
1250 }
1251
1252 /**
1253  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1254  *      @qc: Storage for translated ATA taskfile
1255  *
1256  *      Converts any of six SCSI read/write commands into the
1257  *      ATA counterpart, including starting sector (LBA),
1258  *      sector count, and taking into account the device's LBA48
1259  *      support.
1260  *
1261  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1262  *      %WRITE_16 are currently supported.
1263  *
1264  *      LOCKING:
1265  *      spin_lock_irqsave(host lock)
1266  *
1267  *      RETURNS:
1268  *      Zero on success, non-zero on error.
1269  */
1270 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1271 {
1272         struct scsi_cmnd *scmd = qc->scsicmd;
1273         const u8 *cdb = scmd->cmnd;
1274         unsigned int tf_flags = 0;
1275         u64 block;
1276         u32 n_block;
1277         int rc;
1278
1279         if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1280                 tf_flags |= ATA_TFLAG_WRITE;
1281
1282         /* Calculate the SCSI LBA, transfer length and FUA. */
1283         switch (cdb[0]) {
1284         case READ_10:
1285         case WRITE_10:
1286                 if (unlikely(scmd->cmd_len < 10))
1287                         goto invalid_fld;
1288                 scsi_10_lba_len(cdb, &block, &n_block);
1289                 if (unlikely(cdb[1] & (1 << 3)))
1290                         tf_flags |= ATA_TFLAG_FUA;
1291                 break;
1292         case READ_6:
1293         case WRITE_6:
1294                 if (unlikely(scmd->cmd_len < 6))
1295                         goto invalid_fld;
1296                 scsi_6_lba_len(cdb, &block, &n_block);
1297
1298                 /* for 6-byte r/w commands, transfer length 0
1299                  * means 256 blocks of data, not 0 block.
1300                  */
1301                 if (!n_block)
1302                         n_block = 256;
1303                 break;
1304         case READ_16:
1305         case WRITE_16:
1306                 if (unlikely(scmd->cmd_len < 16))
1307                         goto invalid_fld;
1308                 scsi_16_lba_len(cdb, &block, &n_block);
1309                 if (unlikely(cdb[1] & (1 << 3)))
1310                         tf_flags |= ATA_TFLAG_FUA;
1311                 break;
1312         default:
1313                 DPRINTK("no-byte command\n");
1314                 goto invalid_fld;
1315         }
1316
1317         /* Check and compose ATA command */
1318         if (!n_block)
1319                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1320                  * length 0 means transfer 0 block of data.
1321                  * However, for ATA R/W commands, sector count 0 means
1322                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
1323                  *
1324                  * WARNING: one or two older ATA drives treat 0 as 0...
1325                  */
1326                 goto nothing_to_do;
1327
1328         qc->flags |= ATA_QCFLAG_IO;
1329         qc->nbytes = n_block * ATA_SECT_SIZE;
1330
1331         rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1332                              qc->tag);
1333         if (likely(rc == 0))
1334                 return 0;
1335
1336         if (rc == -ERANGE)
1337                 goto out_of_range;
1338         /* treat all other errors as -EINVAL, fall through */
1339 invalid_fld:
1340         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1341         /* "Invalid field in cbd" */
1342         return 1;
1343
1344 out_of_range:
1345         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1346         /* "Logical Block Address out of range" */
1347         return 1;
1348
1349 nothing_to_do:
1350         scmd->result = SAM_STAT_GOOD;
1351         return 1;
1352 }
1353
1354 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1355 {
1356         struct ata_port *ap = qc->ap;
1357         struct scsi_cmnd *cmd = qc->scsicmd;
1358         u8 *cdb = cmd->cmnd;
1359         int need_sense = (qc->err_mask != 0);
1360
1361         /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1362          * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1363          * cache
1364          */
1365         if (ap->ops->error_handler &&
1366             !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1367             ((qc->tf.feature == SETFEATURES_WC_ON) ||
1368              (qc->tf.feature == SETFEATURES_WC_OFF))) {
1369                 ap->eh_info.action |= ATA_EH_REVALIDATE;
1370                 ata_port_schedule_eh(ap);
1371         }
1372
1373         /* For ATA pass thru (SAT) commands, generate a sense block if
1374          * user mandated it or if there's an error.  Note that if we
1375          * generate because the user forced us to, a check condition
1376          * is generated and the ATA register values are returned
1377          * whether the command completed successfully or not. If there
1378          * was no error, SK, ASC and ASCQ will all be zero.
1379          */
1380         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1381             ((cdb[2] & 0x20) || need_sense)) {
1382                 ata_gen_passthru_sense(qc);
1383         } else {
1384                 if (!need_sense) {
1385                         cmd->result = SAM_STAT_GOOD;
1386                 } else {
1387                         /* TODO: decide which descriptor format to use
1388                          * for 48b LBA devices and call that here
1389                          * instead of the fixed desc, which is only
1390                          * good for smaller LBA (and maybe CHS?)
1391                          * devices.
1392                          */
1393                         ata_gen_ata_sense(qc);
1394                 }
1395         }
1396
1397         /* XXX: track spindown state for spindown skipping and warning */
1398         if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1399                      qc->tf.command == ATA_CMD_STANDBYNOW1))
1400                 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1401         else if (likely(system_state != SYSTEM_HALT &&
1402                         system_state != SYSTEM_POWER_OFF))
1403                 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1404
1405         if (need_sense && !ap->ops->error_handler)
1406                 ata_dump_status(ap->print_id, &qc->result_tf);
1407
1408         qc->scsidone(cmd);
1409
1410         ata_qc_free(qc);
1411 }
1412
1413 /**
1414  *      ata_scmd_need_defer - Check whether we need to defer scmd
1415  *      @dev: ATA device to which the command is addressed
1416  *      @is_io: Is the command IO (and thus possibly NCQ)?
1417  *
1418  *      NCQ and non-NCQ commands cannot run together.  As upper layer
1419  *      only knows the queue depth, we are responsible for maintaining
1420  *      exclusion.  This function checks whether a new command can be
1421  *      issued to @dev.
1422  *
1423  *      LOCKING:
1424  *      spin_lock_irqsave(host lock)
1425  *
1426  *      RETURNS:
1427  *      1 if deferring is needed, 0 otherwise.
1428  */
1429 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1430 {
1431         struct ata_port *ap = dev->ap;
1432         int is_ncq = is_io && ata_ncq_enabled(dev);
1433
1434         if (is_ncq) {
1435                 if (!ata_tag_valid(ap->active_tag))
1436                         return 0;
1437         } else {
1438                 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1439                         return 0;
1440         }
1441         return 1;
1442 }
1443
1444 /**
1445  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1446  *      @dev: ATA device to which the command is addressed
1447  *      @cmd: SCSI command to execute
1448  *      @done: SCSI command completion function
1449  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1450  *
1451  *      Our ->queuecommand() function has decided that the SCSI
1452  *      command issued can be directly translated into an ATA
1453  *      command, rather than handled internally.
1454  *
1455  *      This function sets up an ata_queued_cmd structure for the
1456  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1457  *
1458  *      The xlat_func argument (actor) returns 0 if ready to execute
1459  *      ATA command, else 1 to finish translation. If 1 is returned
1460  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1461  *      to be set reflecting an error condition or clean (early)
1462  *      termination.
1463  *
1464  *      LOCKING:
1465  *      spin_lock_irqsave(host lock)
1466  *
1467  *      RETURNS:
1468  *      0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1469  *      needs to be deferred.
1470  */
1471 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1472                               void (*done)(struct scsi_cmnd *),
1473                               ata_xlat_func_t xlat_func)
1474 {
1475         struct ata_queued_cmd *qc;
1476         int is_io = xlat_func == ata_scsi_rw_xlat;
1477
1478         VPRINTK("ENTER\n");
1479
1480         if (unlikely(ata_scmd_need_defer(dev, is_io)))
1481                 goto defer;
1482
1483         qc = ata_scsi_qc_new(dev, cmd, done);
1484         if (!qc)
1485                 goto err_mem;
1486
1487         /* data is present; dma-map it */
1488         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1489             cmd->sc_data_direction == DMA_TO_DEVICE) {
1490                 if (unlikely(cmd->request_bufflen < 1)) {
1491                         ata_dev_printk(dev, KERN_WARNING,
1492                                        "WARNING: zero len r/w req\n");
1493                         goto err_did;
1494                 }
1495
1496                 if (cmd->use_sg)
1497                         ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1498                 else
1499                         ata_sg_init_one(qc, cmd->request_buffer,
1500                                         cmd->request_bufflen);
1501
1502                 qc->dma_dir = cmd->sc_data_direction;
1503         }
1504
1505         qc->complete_fn = ata_scsi_qc_complete;
1506
1507         if (xlat_func(qc))
1508                 goto early_finish;
1509
1510         /* select device, send command to hardware */
1511         ata_qc_issue(qc);
1512
1513         VPRINTK("EXIT\n");
1514         return 0;
1515
1516 early_finish:
1517         ata_qc_free(qc);
1518         qc->scsidone(cmd);
1519         DPRINTK("EXIT - early finish (good or error)\n");
1520         return 0;
1521
1522 err_did:
1523         ata_qc_free(qc);
1524         cmd->result = (DID_ERROR << 16);
1525         qc->scsidone(cmd);
1526 err_mem:
1527         DPRINTK("EXIT - internal\n");
1528         return 0;
1529
1530 defer:
1531         DPRINTK("EXIT - defer\n");
1532         return SCSI_MLQUEUE_DEVICE_BUSY;
1533 }
1534
1535 /**
1536  *      ata_scsi_rbuf_get - Map response buffer.
1537  *      @cmd: SCSI command containing buffer to be mapped.
1538  *      @buf_out: Pointer to mapped area.
1539  *
1540  *      Maps buffer contained within SCSI command @cmd.
1541  *
1542  *      LOCKING:
1543  *      spin_lock_irqsave(host lock)
1544  *
1545  *      RETURNS:
1546  *      Length of response buffer.
1547  */
1548
1549 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1550 {
1551         u8 *buf;
1552         unsigned int buflen;
1553
1554         if (cmd->use_sg) {
1555                 struct scatterlist *sg;
1556
1557                 sg = (struct scatterlist *) cmd->request_buffer;
1558                 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1559                 buflen = sg->length;
1560         } else {
1561                 buf = cmd->request_buffer;
1562                 buflen = cmd->request_bufflen;
1563         }
1564
1565         *buf_out = buf;
1566         return buflen;
1567 }
1568
1569 /**
1570  *      ata_scsi_rbuf_put - Unmap response buffer.
1571  *      @cmd: SCSI command containing buffer to be unmapped.
1572  *      @buf: buffer to unmap
1573  *
1574  *      Unmaps response buffer contained within @cmd.
1575  *
1576  *      LOCKING:
1577  *      spin_lock_irqsave(host lock)
1578  */
1579
1580 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1581 {
1582         if (cmd->use_sg) {
1583                 struct scatterlist *sg;
1584
1585                 sg = (struct scatterlist *) cmd->request_buffer;
1586                 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1587         }
1588 }
1589
1590 /**
1591  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1592  *      @args: device IDENTIFY data / SCSI command of interest.
1593  *      @actor: Callback hook for desired SCSI command simulator
1594  *
1595  *      Takes care of the hard work of simulating a SCSI command...
1596  *      Mapping the response buffer, calling the command's handler,
1597  *      and handling the handler's return value.  This return value
1598  *      indicates whether the handler wishes the SCSI command to be
1599  *      completed successfully (0), or not (in which case cmd->result
1600  *      and sense buffer are assumed to be set).
1601  *
1602  *      LOCKING:
1603  *      spin_lock_irqsave(host lock)
1604  */
1605
1606 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1607                         unsigned int (*actor) (struct ata_scsi_args *args,
1608                                            u8 *rbuf, unsigned int buflen))
1609 {
1610         u8 *rbuf;
1611         unsigned int buflen, rc;
1612         struct scsi_cmnd *cmd = args->cmd;
1613
1614         buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1615         memset(rbuf, 0, buflen);
1616         rc = actor(args, rbuf, buflen);
1617         ata_scsi_rbuf_put(cmd, rbuf);
1618
1619         if (rc == 0)
1620                 cmd->result = SAM_STAT_GOOD;
1621         args->done(cmd);
1622 }
1623
1624 /**
1625  *      ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1626  *      @idx: byte index into SCSI response buffer
1627  *      @val: value to set
1628  *
1629  *      To be used by SCSI command simulator functions.  This macros
1630  *      expects two local variables, u8 *rbuf and unsigned int buflen,
1631  *      are in scope.
1632  *
1633  *      LOCKING:
1634  *      None.
1635  */
1636 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1637                 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1638         } while (0)
1639
1640 /**
1641  *      ata_scsiop_inq_std - Simulate INQUIRY command
1642  *      @args: device IDENTIFY data / SCSI command of interest.
1643  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1644  *      @buflen: Response buffer length.
1645  *
1646  *      Returns standard device identification data associated
1647  *      with non-VPD INQUIRY command output.
1648  *
1649  *      LOCKING:
1650  *      spin_lock_irqsave(host lock)
1651  */
1652
1653 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1654                                unsigned int buflen)
1655 {
1656         u8 hdr[] = {
1657                 TYPE_DISK,
1658                 0,
1659                 0x5,    /* claim SPC-3 version compatibility */
1660                 2,
1661                 95 - 4
1662         };
1663
1664         /* set scsi removeable (RMB) bit per ata bit */
1665         if (ata_id_removeable(args->id))
1666                 hdr[1] |= (1 << 7);
1667
1668         VPRINTK("ENTER\n");
1669
1670         memcpy(rbuf, hdr, sizeof(hdr));
1671
1672         if (buflen > 35) {
1673                 memcpy(&rbuf[8], "ATA     ", 8);
1674                 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1675                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1676                 if (rbuf[32] == 0 || rbuf[32] == ' ')
1677                         memcpy(&rbuf[32], "n/a ", 4);
1678         }
1679
1680         if (buflen > 63) {
1681                 const u8 versions[] = {
1682                         0x60,   /* SAM-3 (no version claimed) */
1683
1684                         0x03,
1685                         0x20,   /* SBC-2 (no version claimed) */
1686
1687                         0x02,
1688                         0x60    /* SPC-3 (no version claimed) */
1689                 };
1690
1691                 memcpy(rbuf + 59, versions, sizeof(versions));
1692         }
1693
1694         return 0;
1695 }
1696
1697 /**
1698  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1699  *      @args: device IDENTIFY data / SCSI command of interest.
1700  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1701  *      @buflen: Response buffer length.
1702  *
1703  *      Returns list of inquiry VPD pages available.
1704  *
1705  *      LOCKING:
1706  *      spin_lock_irqsave(host lock)
1707  */
1708
1709 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1710                               unsigned int buflen)
1711 {
1712         const u8 pages[] = {
1713                 0x00,   /* page 0x00, this page */
1714                 0x80,   /* page 0x80, unit serial no page */
1715                 0x83    /* page 0x83, device ident page */
1716         };
1717         rbuf[3] = sizeof(pages);        /* number of supported VPD pages */
1718
1719         if (buflen > 6)
1720                 memcpy(rbuf + 4, pages, sizeof(pages));
1721
1722         return 0;
1723 }
1724
1725 /**
1726  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1727  *      @args: device IDENTIFY data / SCSI command of interest.
1728  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1729  *      @buflen: Response buffer length.
1730  *
1731  *      Returns ATA device serial number.
1732  *
1733  *      LOCKING:
1734  *      spin_lock_irqsave(host lock)
1735  */
1736
1737 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1738                               unsigned int buflen)
1739 {
1740         const u8 hdr[] = {
1741                 0,
1742                 0x80,                   /* this page code */
1743                 0,
1744                 ATA_ID_SERNO_LEN,       /* page len */
1745         };
1746         memcpy(rbuf, hdr, sizeof(hdr));
1747
1748         if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1749                 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1750                               ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1751
1752         return 0;
1753 }
1754
1755 /**
1756  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1757  *      @args: device IDENTIFY data / SCSI command of interest.
1758  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1759  *      @buflen: Response buffer length.
1760  *
1761  *      Yields two logical unit device identification designators:
1762  *       - vendor specific ASCII containing the ATA serial number
1763  *       - SAT defined "t10 vendor id based" containing ASCII vendor
1764  *         name ("ATA     "), model and serial numbers.
1765  *
1766  *      LOCKING:
1767  *      spin_lock_irqsave(host lock)
1768  */
1769
1770 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1771                               unsigned int buflen)
1772 {
1773         int num;
1774         const int sat_model_serial_desc_len = 68;
1775
1776         rbuf[1] = 0x83;                 /* this page code */
1777         num = 4;
1778
1779         if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1780                 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1781                 rbuf[num + 0] = 2;
1782                 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1783                 num += 4;
1784                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1785                               ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1786                 num += ATA_ID_SERNO_LEN;
1787         }
1788         if (buflen > (sat_model_serial_desc_len + num + 3)) {
1789                 /* SAT defined lu model and serial numbers descriptor */
1790                 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1791                 rbuf[num + 0] = 2;
1792                 rbuf[num + 1] = 1;
1793                 rbuf[num + 3] = sat_model_serial_desc_len;
1794                 num += 4;
1795                 memcpy(rbuf + num, "ATA     ", 8);
1796                 num += 8;
1797                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1798                               ATA_ID_PROD, ATA_ID_PROD_LEN);
1799                 num += ATA_ID_PROD_LEN;
1800                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1801                               ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1802                 num += ATA_ID_SERNO_LEN;
1803         }
1804         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
1805         return 0;
1806 }
1807
1808 /**
1809  *      ata_scsiop_noop - Command handler that simply returns success.
1810  *      @args: device IDENTIFY data / SCSI command of interest.
1811  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1812  *      @buflen: Response buffer length.
1813  *
1814  *      No operation.  Simply returns success to caller, to indicate
1815  *      that the caller should successfully complete this SCSI command.
1816  *
1817  *      LOCKING:
1818  *      spin_lock_irqsave(host lock)
1819  */
1820
1821 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1822                             unsigned int buflen)
1823 {
1824         VPRINTK("ENTER\n");
1825         return 0;
1826 }
1827
1828 /**
1829  *      ata_msense_push - Push data onto MODE SENSE data output buffer
1830  *      @ptr_io: (input/output) Location to store more output data
1831  *      @last: End of output data buffer
1832  *      @buf: Pointer to BLOB being added to output buffer
1833  *      @buflen: Length of BLOB
1834  *
1835  *      Store MODE SENSE data on an output buffer.
1836  *
1837  *      LOCKING:
1838  *      None.
1839  */
1840
1841 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1842                             const u8 *buf, unsigned int buflen)
1843 {
1844         u8 *ptr = *ptr_io;
1845
1846         if ((ptr + buflen - 1) > last)
1847                 return;
1848
1849         memcpy(ptr, buf, buflen);
1850
1851         ptr += buflen;
1852
1853         *ptr_io = ptr;
1854 }
1855
1856 /**
1857  *      ata_msense_caching - Simulate MODE SENSE caching info page
1858  *      @id: device IDENTIFY data
1859  *      @ptr_io: (input/output) Location to store more output data
1860  *      @last: End of output data buffer
1861  *
1862  *      Generate a caching info page, which conditionally indicates
1863  *      write caching to the SCSI layer, depending on device
1864  *      capabilities.
1865  *
1866  *      LOCKING:
1867  *      None.
1868  */
1869
1870 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1871                                        const u8 *last)
1872 {
1873         u8 page[CACHE_MPAGE_LEN];
1874
1875         memcpy(page, def_cache_mpage, sizeof(page));
1876         if (ata_id_wcache_enabled(id))
1877                 page[2] |= (1 << 2);    /* write cache enable */
1878         if (!ata_id_rahead_enabled(id))
1879                 page[12] |= (1 << 5);   /* disable read ahead */
1880
1881         ata_msense_push(ptr_io, last, page, sizeof(page));
1882         return sizeof(page);
1883 }
1884
1885 /**
1886  *      ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1887  *      @dev: Device associated with this MODE SENSE command
1888  *      @ptr_io: (input/output) Location to store more output data
1889  *      @last: End of output data buffer
1890  *
1891  *      Generate a generic MODE SENSE control mode page.
1892  *
1893  *      LOCKING:
1894  *      None.
1895  */
1896
1897 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1898 {
1899         ata_msense_push(ptr_io, last, def_control_mpage,
1900                         sizeof(def_control_mpage));
1901         return sizeof(def_control_mpage);
1902 }
1903
1904 /**
1905  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1906  *      @dev: Device associated with this MODE SENSE command
1907  *      @ptr_io: (input/output) Location to store more output data
1908  *      @last: End of output data buffer
1909  *
1910  *      Generate a generic MODE SENSE r/w error recovery page.
1911  *
1912  *      LOCKING:
1913  *      None.
1914  */
1915
1916 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1917 {
1918
1919         ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1920                         sizeof(def_rw_recovery_mpage));
1921         return sizeof(def_rw_recovery_mpage);
1922 }
1923
1924 /*
1925  * We can turn this into a real blacklist if it's needed, for now just
1926  * blacklist any Maxtor BANC1G10 revision firmware
1927  */
1928 static int ata_dev_supports_fua(u16 *id)
1929 {
1930         unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
1931
1932         if (!libata_fua)
1933                 return 0;
1934         if (!ata_id_has_fua(id))
1935                 return 0;
1936
1937         ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
1938         ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
1939
1940         if (strcmp(model, "Maxtor"))
1941                 return 1;
1942         if (strcmp(fw, "BANC1G10"))
1943                 return 1;
1944
1945         return 0; /* blacklisted */
1946 }
1947
1948 /**
1949  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1950  *      @args: device IDENTIFY data / SCSI command of interest.
1951  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1952  *      @buflen: Response buffer length.
1953  *
1954  *      Simulate MODE SENSE commands. Assume this is invoked for direct
1955  *      access devices (e.g. disks) only. There should be no block
1956  *      descriptor for other device types.
1957  *
1958  *      LOCKING:
1959  *      spin_lock_irqsave(host lock)
1960  */
1961
1962 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1963                                   unsigned int buflen)
1964 {
1965         struct ata_device *dev = args->dev;
1966         u8 *scsicmd = args->cmd->cmnd, *p, *last;
1967         const u8 sat_blk_desc[] = {
1968                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
1969                 0,
1970                 0, 0x2, 0x0     /* block length: 512 bytes */
1971         };
1972         u8 pg, spg;
1973         unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1974         u8 dpofua;
1975
1976         VPRINTK("ENTER\n");
1977
1978         six_byte = (scsicmd[0] == MODE_SENSE);
1979         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
1980         /*
1981          * LLBA bit in msense(10) ignored (compliant)
1982          */
1983
1984         page_control = scsicmd[2] >> 6;
1985         switch (page_control) {
1986         case 0: /* current */
1987                 break;  /* supported */
1988         case 3: /* saved */
1989                 goto saving_not_supp;
1990         case 1: /* changeable */
1991         case 2: /* defaults */
1992         default:
1993                 goto invalid_fld;
1994         }
1995
1996         if (six_byte) {
1997                 output_len = 4 + (ebd ? 8 : 0);
1998                 alloc_len = scsicmd[4];
1999         } else {
2000                 output_len = 8 + (ebd ? 8 : 0);
2001                 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2002         }
2003         minlen = (alloc_len < buflen) ? alloc_len : buflen;
2004
2005         p = rbuf + output_len;
2006         last = rbuf + minlen - 1;
2007
2008         pg = scsicmd[2] & 0x3f;
2009         spg = scsicmd[3];
2010         /*
2011          * No mode subpages supported (yet) but asking for _all_
2012          * subpages may be valid
2013          */
2014         if (spg && (spg != ALL_SUB_MPAGES))
2015                 goto invalid_fld;
2016
2017         switch(pg) {
2018         case RW_RECOVERY_MPAGE:
2019                 output_len += ata_msense_rw_recovery(&p, last);
2020                 break;
2021
2022         case CACHE_MPAGE:
2023                 output_len += ata_msense_caching(args->id, &p, last);
2024                 break;
2025
2026         case CONTROL_MPAGE: {
2027                 output_len += ata_msense_ctl_mode(&p, last);
2028                 break;
2029                 }
2030
2031         case ALL_MPAGES:
2032                 output_len += ata_msense_rw_recovery(&p, last);
2033                 output_len += ata_msense_caching(args->id, &p, last);
2034                 output_len += ata_msense_ctl_mode(&p, last);
2035                 break;
2036
2037         default:                /* invalid page code */
2038                 goto invalid_fld;
2039         }
2040
2041         if (minlen < 1)
2042                 return 0;
2043
2044         dpofua = 0;
2045         if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2046             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2047                 dpofua = 1 << 4;
2048
2049         if (six_byte) {
2050                 output_len--;
2051                 rbuf[0] = output_len;
2052                 if (minlen > 2)
2053                         rbuf[2] |= dpofua;
2054                 if (ebd) {
2055                         if (minlen > 3)
2056                                 rbuf[3] = sizeof(sat_blk_desc);
2057                         if (minlen > 11)
2058                                 memcpy(rbuf + 4, sat_blk_desc,
2059                                        sizeof(sat_blk_desc));
2060                 }
2061         } else {
2062                 output_len -= 2;
2063                 rbuf[0] = output_len >> 8;
2064                 if (minlen > 1)
2065                         rbuf[1] = output_len;
2066                 if (minlen > 3)
2067                         rbuf[3] |= dpofua;
2068                 if (ebd) {
2069                         if (minlen > 7)
2070                                 rbuf[7] = sizeof(sat_blk_desc);
2071                         if (minlen > 15)
2072                                 memcpy(rbuf + 8, sat_blk_desc,
2073                                        sizeof(sat_blk_desc));
2074                 }
2075         }
2076         return 0;
2077
2078 invalid_fld:
2079         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2080         /* "Invalid field in cbd" */
2081         return 1;
2082
2083 saving_not_supp:
2084         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2085          /* "Saving parameters not supported" */
2086         return 1;
2087 }
2088
2089 /**
2090  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2091  *      @args: device IDENTIFY data / SCSI command of interest.
2092  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2093  *      @buflen: Response buffer length.
2094  *
2095  *      Simulate READ CAPACITY commands.
2096  *
2097  *      LOCKING:
2098  *      None.
2099  */
2100 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2101                                 unsigned int buflen)
2102 {
2103         u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2104
2105         VPRINTK("ENTER\n");
2106
2107         if (args->cmd->cmnd[0] == READ_CAPACITY) {
2108                 if (last_lba >= 0xffffffffULL)
2109                         last_lba = 0xffffffff;
2110
2111                 /* sector count, 32-bit */
2112                 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2113                 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2114                 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2115                 ATA_SCSI_RBUF_SET(3, last_lba);
2116
2117                 /* sector size */
2118                 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2119                 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2120         } else {
2121                 /* sector count, 64-bit */
2122                 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2123                 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2124                 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2125                 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2126                 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2127                 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2128                 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2129                 ATA_SCSI_RBUF_SET(7, last_lba);
2130
2131                 /* sector size */
2132                 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2133                 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2134         }
2135
2136         return 0;
2137 }
2138
2139 /**
2140  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
2141  *      @args: device IDENTIFY data / SCSI command of interest.
2142  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2143  *      @buflen: Response buffer length.
2144  *
2145  *      Simulate REPORT LUNS command.
2146  *
2147  *      LOCKING:
2148  *      spin_lock_irqsave(host lock)
2149  */
2150
2151 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2152                                    unsigned int buflen)
2153 {
2154         VPRINTK("ENTER\n");
2155         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2156
2157         return 0;
2158 }
2159
2160 /**
2161  *      ata_scsi_set_sense - Set SCSI sense data and status
2162  *      @cmd: SCSI request to be handled
2163  *      @sk: SCSI-defined sense key
2164  *      @asc: SCSI-defined additional sense code
2165  *      @ascq: SCSI-defined additional sense code qualifier
2166  *
2167  *      Helper function that builds a valid fixed format, current
2168  *      response code and the given sense key (sk), additional sense
2169  *      code (asc) and additional sense code qualifier (ascq) with
2170  *      a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2171  *      DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2172  *
2173  *      LOCKING:
2174  *      Not required
2175  */
2176
2177 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2178 {
2179         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2180
2181         cmd->sense_buffer[0] = 0x70;    /* fixed format, current */
2182         cmd->sense_buffer[2] = sk;
2183         cmd->sense_buffer[7] = 18 - 8;  /* additional sense length */
2184         cmd->sense_buffer[12] = asc;
2185         cmd->sense_buffer[13] = ascq;
2186 }
2187
2188 /**
2189  *      ata_scsi_badcmd - End a SCSI request with an error
2190  *      @cmd: SCSI request to be handled
2191  *      @done: SCSI command completion function
2192  *      @asc: SCSI-defined additional sense code
2193  *      @ascq: SCSI-defined additional sense code qualifier
2194  *
2195  *      Helper function that completes a SCSI command with
2196  *      %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2197  *      and the specified additional sense codes.
2198  *
2199  *      LOCKING:
2200  *      spin_lock_irqsave(host lock)
2201  */
2202
2203 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2204 {
2205         DPRINTK("ENTER\n");
2206         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2207
2208         done(cmd);
2209 }
2210
2211 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2212 {
2213         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2214                 /* FIXME: not quite right; we don't want the
2215                  * translation of taskfile registers into
2216                  * a sense descriptors, since that's only
2217                  * correct for ATA, not ATAPI
2218                  */
2219                 ata_gen_passthru_sense(qc);
2220         }
2221
2222         qc->scsidone(qc->scsicmd);
2223         ata_qc_free(qc);
2224 }
2225
2226 /* is it pointless to prefer PIO for "safety reasons"? */
2227 static inline int ata_pio_use_silly(struct ata_port *ap)
2228 {
2229         return (ap->flags & ATA_FLAG_PIO_DMA);
2230 }
2231
2232 static void atapi_request_sense(struct ata_queued_cmd *qc)
2233 {
2234         struct ata_port *ap = qc->ap;
2235         struct scsi_cmnd *cmd = qc->scsicmd;
2236
2237         DPRINTK("ATAPI request sense\n");
2238
2239         /* FIXME: is this needed? */
2240         memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2241
2242         ap->ops->tf_read(ap, &qc->tf);
2243
2244         /* fill these in, for the case where they are -not- overwritten */
2245         cmd->sense_buffer[0] = 0x70;
2246         cmd->sense_buffer[2] = qc->tf.feature >> 4;
2247
2248         ata_qc_reinit(qc);
2249
2250         ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2251         qc->dma_dir = DMA_FROM_DEVICE;
2252
2253         memset(&qc->cdb, 0, qc->dev->cdb_len);
2254         qc->cdb[0] = REQUEST_SENSE;
2255         qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2256
2257         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2258         qc->tf.command = ATA_CMD_PACKET;
2259
2260         if (ata_pio_use_silly(ap)) {
2261                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2262                 qc->tf.feature |= ATAPI_PKT_DMA;
2263         } else {
2264                 qc->tf.protocol = ATA_PROT_ATAPI;
2265                 qc->tf.lbam = (8 * 1024) & 0xff;
2266                 qc->tf.lbah = (8 * 1024) >> 8;
2267         }
2268         qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2269
2270         qc->complete_fn = atapi_sense_complete;
2271
2272         ata_qc_issue(qc);
2273
2274         DPRINTK("EXIT\n");
2275 }
2276
2277 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2278 {
2279         struct scsi_cmnd *cmd = qc->scsicmd;
2280         unsigned int err_mask = qc->err_mask;
2281
2282         VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2283
2284         /* handle completion from new EH */
2285         if (unlikely(qc->ap->ops->error_handler &&
2286                      (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2287
2288                 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2289                         /* FIXME: not quite right; we don't want the
2290                          * translation of taskfile registers into a
2291                          * sense descriptors, since that's only
2292                          * correct for ATA, not ATAPI
2293                          */
2294                         ata_gen_passthru_sense(qc);
2295                 }
2296
2297                 /* SCSI EH automatically locks door if sdev->locked is
2298                  * set.  Sometimes door lock request continues to
2299                  * fail, for example, when no media is present.  This
2300                  * creates a loop - SCSI EH issues door lock which
2301                  * fails and gets invoked again to acquire sense data
2302                  * for the failed command.
2303                  *
2304                  * If door lock fails, always clear sdev->locked to
2305                  * avoid this infinite loop.
2306                  */
2307                 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2308                         qc->dev->sdev->locked = 0;
2309
2310                 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2311                 qc->scsidone(cmd);
2312                 ata_qc_free(qc);
2313                 return;
2314         }
2315
2316         /* successful completion or old EH failure path */
2317         if (unlikely(err_mask & AC_ERR_DEV)) {
2318                 cmd->result = SAM_STAT_CHECK_CONDITION;
2319                 atapi_request_sense(qc);
2320                 return;
2321         } else if (unlikely(err_mask)) {
2322                 /* FIXME: not quite right; we don't want the
2323                  * translation of taskfile registers into
2324                  * a sense descriptors, since that's only
2325                  * correct for ATA, not ATAPI
2326                  */
2327                 ata_gen_passthru_sense(qc);
2328         } else {
2329                 u8 *scsicmd = cmd->cmnd;
2330
2331                 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2332                         u8 *buf = NULL;
2333                         unsigned int buflen;
2334
2335                         buflen = ata_scsi_rbuf_get(cmd, &buf);
2336
2337         /* ATAPI devices typically report zero for their SCSI version,
2338          * and sometimes deviate from the spec WRT response data
2339          * format.  If SCSI version is reported as zero like normal,
2340          * then we make the following fixups:  1) Fake MMC-5 version,
2341          * to indicate to the Linux scsi midlayer this is a modern
2342          * device.  2) Ensure response data format / ATAPI information
2343          * are always correct.
2344          */
2345                         if (buf[2] == 0) {
2346                                 buf[2] = 0x5;
2347                                 buf[3] = 0x32;
2348                         }
2349
2350                         ata_scsi_rbuf_put(cmd, buf);
2351                 }
2352
2353                 cmd->result = SAM_STAT_GOOD;
2354         }
2355
2356         qc->scsidone(cmd);
2357         ata_qc_free(qc);
2358 }
2359 /**
2360  *      atapi_xlat - Initialize PACKET taskfile
2361  *      @qc: command structure to be initialized
2362  *
2363  *      LOCKING:
2364  *      spin_lock_irqsave(host lock)
2365  *
2366  *      RETURNS:
2367  *      Zero on success, non-zero on failure.
2368  */
2369 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2370 {
2371         struct scsi_cmnd *scmd = qc->scsicmd;
2372         struct ata_device *dev = qc->dev;
2373         int using_pio = (dev->flags & ATA_DFLAG_PIO);
2374         int nodata = (scmd->sc_data_direction == DMA_NONE);
2375
2376         if (!using_pio)
2377                 /* Check whether ATAPI DMA is safe */
2378                 if (ata_check_atapi_dma(qc))
2379                         using_pio = 1;
2380
2381         memset(qc->cdb, 0, dev->cdb_len);
2382         memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2383
2384         qc->complete_fn = atapi_qc_complete;
2385
2386         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2387         if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2388                 qc->tf.flags |= ATA_TFLAG_WRITE;
2389                 DPRINTK("direction: write\n");
2390         }
2391
2392         qc->tf.command = ATA_CMD_PACKET;
2393
2394         /* no data, or PIO data xfer */
2395         if (using_pio || nodata) {
2396                 if (nodata)
2397                         qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2398                 else
2399                         qc->tf.protocol = ATA_PROT_ATAPI;
2400                 qc->tf.lbam = (8 * 1024) & 0xff;
2401                 qc->tf.lbah = (8 * 1024) >> 8;
2402         }
2403
2404         /* DMA data xfer */
2405         else {
2406                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2407                 qc->tf.feature |= ATAPI_PKT_DMA;
2408
2409                 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2410                         /* some SATA bridges need us to indicate data xfer direction */
2411                         qc->tf.feature |= ATAPI_DMADIR;
2412         }
2413
2414         qc->nbytes = scmd->request_bufflen;
2415
2416         return 0;
2417 }
2418
2419 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2420 {
2421         if (likely(id < ATA_MAX_DEVICES))
2422                 return &ap->device[id];
2423         return NULL;
2424 }
2425
2426 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2427                                         const struct scsi_device *scsidev)
2428 {
2429         /* skip commands not addressed to targets we simulate */
2430         if (unlikely(scsidev->channel || scsidev->lun))
2431                 return NULL;
2432
2433         return ata_find_dev(ap, scsidev->id);
2434 }
2435
2436 /**
2437  *      ata_scsi_dev_enabled - determine if device is enabled
2438  *      @dev: ATA device
2439  *
2440  *      Determine if commands should be sent to the specified device.
2441  *
2442  *      LOCKING:
2443  *      spin_lock_irqsave(host lock)
2444  *
2445  *      RETURNS:
2446  *      0 if commands are not allowed / 1 if commands are allowed
2447  */
2448
2449 static int ata_scsi_dev_enabled(struct ata_device *dev)
2450 {
2451         if (unlikely(!ata_dev_enabled(dev)))
2452                 return 0;
2453
2454         if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2455                 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2456                         ata_dev_printk(dev, KERN_WARNING,
2457                                        "WARNING: ATAPI is %s, device ignored.\n",
2458                                        atapi_enabled ? "not supported with this driver" : "disabled");
2459                         return 0;
2460                 }
2461         }
2462
2463         return 1;
2464 }
2465
2466 /**
2467  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2468  *      @ap: ATA port to which the device is attached
2469  *      @scsidev: SCSI device from which we derive the ATA device
2470  *
2471  *      Given various information provided in struct scsi_cmnd,
2472  *      map that onto an ATA bus, and using that mapping
2473  *      determine which ata_device is associated with the
2474  *      SCSI command to be sent.
2475  *
2476  *      LOCKING:
2477  *      spin_lock_irqsave(host lock)
2478  *
2479  *      RETURNS:
2480  *      Associated ATA device, or %NULL if not found.
2481  */
2482 static struct ata_device *
2483 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2484 {
2485         struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2486
2487         if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2488                 return NULL;
2489
2490         return dev;
2491 }
2492
2493 /*
2494  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2495  *      @byte1: Byte 1 from pass-thru CDB.
2496  *
2497  *      RETURNS:
2498  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2499  */
2500 static u8
2501 ata_scsi_map_proto(u8 byte1)
2502 {
2503         switch((byte1 & 0x1e) >> 1) {
2504                 case 3:         /* Non-data */
2505                         return ATA_PROT_NODATA;
2506
2507                 case 6:         /* DMA */
2508                         return ATA_PROT_DMA;
2509
2510                 case 4:         /* PIO Data-in */
2511                 case 5:         /* PIO Data-out */
2512                         return ATA_PROT_PIO;
2513
2514                 case 10:        /* Device Reset */
2515                 case 0:         /* Hard Reset */
2516                 case 1:         /* SRST */
2517                 case 2:         /* Bus Idle */
2518                 case 7:         /* Packet */
2519                 case 8:         /* DMA Queued */
2520                 case 9:         /* Device Diagnostic */
2521                 case 11:        /* UDMA Data-in */
2522                 case 12:        /* UDMA Data-Out */
2523                 case 13:        /* FPDMA */
2524                 default:        /* Reserved */
2525                         break;
2526         }
2527
2528         return ATA_PROT_UNKNOWN;
2529 }
2530
2531 /**
2532  *      ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2533  *      @qc: command structure to be initialized
2534  *
2535  *      Handles either 12 or 16-byte versions of the CDB.
2536  *
2537  *      RETURNS:
2538  *      Zero on success, non-zero on failure.
2539  */
2540 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2541 {
2542         struct ata_taskfile *tf = &(qc->tf);
2543         struct scsi_cmnd *scmd = qc->scsicmd;
2544         struct ata_device *dev = qc->dev;
2545         const u8 *cdb = scmd->cmnd;
2546
2547         if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2548                 goto invalid_fld;
2549
2550         /* We may not issue DMA commands if no DMA mode is set */
2551         if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2552                 goto invalid_fld;
2553
2554         if (cdb[1] & 0xe0)
2555                 /* PIO multi not supported yet */
2556                 goto invalid_fld;
2557
2558         /*
2559          * 12 and 16 byte CDBs use different offsets to
2560          * provide the various register values.
2561          */
2562         if (cdb[0] == ATA_16) {
2563                 /*
2564                  * 16-byte CDB - may contain extended commands.
2565                  *
2566                  * If that is the case, copy the upper byte register values.
2567                  */
2568                 if (cdb[1] & 0x01) {
2569                         tf->hob_feature = cdb[3];
2570                         tf->hob_nsect = cdb[5];
2571                         tf->hob_lbal = cdb[7];
2572                         tf->hob_lbam = cdb[9];
2573                         tf->hob_lbah = cdb[11];
2574                         tf->flags |= ATA_TFLAG_LBA48;
2575                 } else
2576                         tf->flags &= ~ATA_TFLAG_LBA48;
2577
2578                 /*
2579                  * Always copy low byte, device and command registers.
2580                  */
2581                 tf->feature = cdb[4];
2582                 tf->nsect = cdb[6];
2583                 tf->lbal = cdb[8];
2584                 tf->lbam = cdb[10];
2585                 tf->lbah = cdb[12];
2586                 tf->device = cdb[13];
2587                 tf->command = cdb[14];
2588         } else {
2589                 /*
2590                  * 12-byte CDB - incapable of extended commands.
2591                  */
2592                 tf->flags &= ~ATA_TFLAG_LBA48;
2593
2594                 tf->feature = cdb[3];
2595                 tf->nsect = cdb[4];
2596                 tf->lbal = cdb[5];
2597                 tf->lbam = cdb[6];
2598                 tf->lbah = cdb[7];
2599                 tf->device = cdb[8];
2600                 tf->command = cdb[9];
2601         }
2602         /*
2603          * If slave is possible, enforce correct master/slave bit
2604         */
2605         if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2606                 tf->device = qc->dev->devno ?
2607                         tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2608
2609         /* READ/WRITE LONG use a non-standard sect_size */
2610         qc->sect_size = ATA_SECT_SIZE;
2611         switch (tf->command) {
2612         case ATA_CMD_READ_LONG:
2613         case ATA_CMD_READ_LONG_ONCE:
2614         case ATA_CMD_WRITE_LONG:
2615         case ATA_CMD_WRITE_LONG_ONCE:
2616                 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2617                         goto invalid_fld;
2618                 qc->sect_size = scmd->request_bufflen;
2619         }
2620
2621         /*
2622          * Filter SET_FEATURES - XFER MODE command -- otherwise,
2623          * SET_FEATURES - XFER MODE must be preceded/succeeded
2624          * by an update to hardware-specific registers for each
2625          * controller (i.e. the reason for ->set_piomode(),
2626          * ->set_dmamode(), and ->post_set_mode() hooks).
2627          */
2628         if ((tf->command == ATA_CMD_SET_FEATURES)
2629          && (tf->feature == SETFEATURES_XFER))
2630                 goto invalid_fld;
2631
2632         /*
2633          * Set flags so that all registers will be written,
2634          * and pass on write indication (used for PIO/DMA
2635          * setup.)
2636          */
2637         tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2638
2639         if (scmd->sc_data_direction == DMA_TO_DEVICE)
2640                 tf->flags |= ATA_TFLAG_WRITE;
2641
2642         /*
2643          * Set transfer length.
2644          *
2645          * TODO: find out if we need to do more here to
2646          *       cover scatter/gather case.
2647          */
2648         qc->nbytes = scmd->request_bufflen;
2649
2650         /* request result TF */
2651         qc->flags |= ATA_QCFLAG_RESULT_TF;
2652
2653         return 0;
2654
2655  invalid_fld:
2656         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2657         /* "Invalid field in cdb" */
2658         return 1;
2659 }
2660
2661 /**
2662  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
2663  *      @dev: ATA device
2664  *      @cmd: SCSI command opcode to consider
2665  *
2666  *      Look up the SCSI command given, and determine whether the
2667  *      SCSI command is to be translated or simulated.
2668  *
2669  *      RETURNS:
2670  *      Pointer to translation function if possible, %NULL if not.
2671  */
2672
2673 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2674 {
2675         switch (cmd) {
2676         case READ_6:
2677         case READ_10:
2678         case READ_16:
2679
2680         case WRITE_6:
2681         case WRITE_10:
2682         case WRITE_16:
2683                 return ata_scsi_rw_xlat;
2684
2685         case SYNCHRONIZE_CACHE:
2686                 if (ata_try_flush_cache(dev))
2687                         return ata_scsi_flush_xlat;
2688                 break;
2689
2690         case VERIFY:
2691         case VERIFY_16:
2692                 return ata_scsi_verify_xlat;
2693
2694         case ATA_12:
2695         case ATA_16:
2696                 return ata_scsi_pass_thru;
2697
2698         case START_STOP:
2699                 return ata_scsi_start_stop_xlat;
2700         }
2701
2702         return NULL;
2703 }
2704
2705 /**
2706  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2707  *      @ap: ATA port to which the command was being sent
2708  *      @cmd: SCSI command to dump
2709  *
2710  *      Prints the contents of a SCSI command via printk().
2711  */
2712
2713 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2714                                      struct scsi_cmnd *cmd)
2715 {
2716 #ifdef ATA_DEBUG
2717         struct scsi_device *scsidev = cmd->device;
2718         u8 *scsicmd = cmd->cmnd;
2719
2720         DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2721                 ap->print_id,
2722                 scsidev->channel, scsidev->id, scsidev->lun,
2723                 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2724                 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2725                 scsicmd[8]);
2726 #endif
2727 }
2728
2729 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2730                                       void (*done)(struct scsi_cmnd *),
2731                                       struct ata_device *dev)
2732 {
2733         int rc = 0;
2734
2735         if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len)) {
2736                 DPRINTK("bad CDB len=%u, max=%u\n",
2737                         scmd->cmd_len, dev->cdb_len);
2738                 scmd->result = DID_ERROR << 16;
2739                 done(scmd);
2740                 return 0;
2741         }
2742
2743         if (dev->class == ATA_DEV_ATA) {
2744                 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2745                                                               scmd->cmnd[0]);
2746
2747                 if (xlat_func)
2748                         rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2749                 else
2750                         ata_scsi_simulate(dev, scmd, done);
2751         } else
2752                 rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2753
2754         return rc;
2755 }
2756
2757 /**
2758  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2759  *      @cmd: SCSI command to be sent
2760  *      @done: Completion function, called when command is complete
2761  *
2762  *      In some cases, this function translates SCSI commands into
2763  *      ATA taskfiles, and queues the taskfiles to be sent to
2764  *      hardware.  In other cases, this function simulates a
2765  *      SCSI device by evaluating and responding to certain
2766  *      SCSI commands.  This creates the overall effect of
2767  *      ATA and ATAPI devices appearing as SCSI devices.
2768  *
2769  *      LOCKING:
2770  *      Releases scsi-layer-held lock, and obtains host lock.
2771  *
2772  *      RETURNS:
2773  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2774  *      0 otherwise.
2775  */
2776 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2777 {
2778         struct ata_port *ap;
2779         struct ata_device *dev;
2780         struct scsi_device *scsidev = cmd->device;
2781         struct Scsi_Host *shost = scsidev->host;
2782         int rc = 0;
2783
2784         ap = ata_shost_to_port(shost);
2785
2786         spin_unlock(shost->host_lock);
2787         spin_lock(ap->lock);
2788
2789         ata_scsi_dump_cdb(ap, cmd);
2790
2791         dev = ata_scsi_find_dev(ap, scsidev);
2792         if (likely(dev))
2793                 rc = __ata_scsi_queuecmd(cmd, done, dev);
2794         else {
2795                 cmd->result = (DID_BAD_TARGET << 16);
2796                 done(cmd);
2797         }
2798
2799         spin_unlock(ap->lock);
2800         spin_lock(shost->host_lock);
2801         return rc;
2802 }
2803
2804 /**
2805  *      ata_scsi_simulate - simulate SCSI command on ATA device
2806  *      @dev: the target device
2807  *      @cmd: SCSI command being sent to device.
2808  *      @done: SCSI command completion function.
2809  *
2810  *      Interprets and directly executes a select list of SCSI commands
2811  *      that can be handled internally.
2812  *
2813  *      LOCKING:
2814  *      spin_lock_irqsave(host lock)
2815  */
2816
2817 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2818                       void (*done)(struct scsi_cmnd *))
2819 {
2820         struct ata_scsi_args args;
2821         const u8 *scsicmd = cmd->cmnd;
2822
2823         args.dev = dev;
2824         args.id = dev->id;
2825         args.cmd = cmd;
2826         args.done = done;
2827
2828         switch(scsicmd[0]) {
2829                 /* no-op's, complete with success */
2830                 case SYNCHRONIZE_CACHE:
2831                 case REZERO_UNIT:
2832                 case SEEK_6:
2833                 case SEEK_10:
2834                 case TEST_UNIT_READY:
2835                 case FORMAT_UNIT:               /* FIXME: correct? */
2836                 case SEND_DIAGNOSTIC:           /* FIXME: correct? */
2837                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2838                         break;
2839
2840                 case INQUIRY:
2841                         if (scsicmd[1] & 2)                /* is CmdDt set?  */
2842                                 ata_scsi_invalid_field(cmd, done);
2843                         else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
2844                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2845                         else if (scsicmd[2] == 0x00)
2846                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2847                         else if (scsicmd[2] == 0x80)
2848                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2849                         else if (scsicmd[2] == 0x83)
2850                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2851                         else
2852                                 ata_scsi_invalid_field(cmd, done);
2853                         break;
2854
2855                 case MODE_SENSE:
2856                 case MODE_SENSE_10:
2857                         ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2858                         break;
2859
2860                 case MODE_SELECT:       /* unconditionally return */
2861                 case MODE_SELECT_10:    /* bad-field-in-cdb */
2862                         ata_scsi_invalid_field(cmd, done);
2863                         break;
2864
2865                 case READ_CAPACITY:
2866                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2867                         break;
2868
2869                 case SERVICE_ACTION_IN:
2870                         if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2871                                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2872                         else
2873                                 ata_scsi_invalid_field(cmd, done);
2874                         break;
2875
2876                 case REPORT_LUNS:
2877                         ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2878                         break;
2879
2880                 /* mandatory commands we haven't implemented yet */
2881                 case REQUEST_SENSE:
2882
2883                 /* all other commands */
2884                 default:
2885                         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2886                         /* "Invalid command operation code" */
2887                         done(cmd);
2888                         break;
2889         }
2890 }
2891
2892 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
2893 {
2894         int i, rc;
2895
2896         for (i = 0; i < host->n_ports; i++) {
2897                 struct ata_port *ap = host->ports[i];
2898                 struct Scsi_Host *shost;
2899
2900                 rc = -ENOMEM;
2901                 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
2902                 if (!shost)
2903                         goto err_alloc;
2904
2905                 *(struct ata_port **)&shost->hostdata[0] = ap;
2906                 ap->scsi_host = shost;
2907
2908                 shost->transportt = &ata_scsi_transport_template;
2909                 shost->unique_id = ap->print_id;
2910                 shost->max_id = 16;
2911                 shost->max_lun = 1;
2912                 shost->max_channel = 1;
2913                 shost->max_cmd_len = 16;
2914
2915                 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
2916                 if (rc)
2917                         goto err_add;
2918         }
2919
2920         return 0;
2921
2922  err_add:
2923         scsi_host_put(host->ports[i]->scsi_host);
2924  err_alloc:
2925         while (--i >= 0) {
2926                 struct Scsi_Host *shost = host->ports[i]->scsi_host;
2927
2928                 scsi_remove_host(shost);
2929                 scsi_host_put(shost);
2930         }
2931         return rc;
2932 }
2933
2934 void ata_scsi_scan_host(struct ata_port *ap)
2935 {
2936         unsigned int i;
2937
2938         if (ap->flags & ATA_FLAG_DISABLED)
2939                 return;
2940
2941         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2942                 struct ata_device *dev = &ap->device[i];
2943                 struct scsi_device *sdev;
2944
2945                 if (!ata_dev_enabled(dev) || dev->sdev)
2946                         continue;
2947
2948                 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2949                 if (!IS_ERR(sdev)) {
2950                         dev->sdev = sdev;
2951                         scsi_device_put(sdev);
2952                 }
2953         }
2954 }
2955
2956 /**
2957  *      ata_scsi_offline_dev - offline attached SCSI device
2958  *      @dev: ATA device to offline attached SCSI device for
2959  *
2960  *      This function is called from ata_eh_hotplug() and responsible
2961  *      for taking the SCSI device attached to @dev offline.  This
2962  *      function is called with host lock which protects dev->sdev
2963  *      against clearing.
2964  *
2965  *      LOCKING:
2966  *      spin_lock_irqsave(host lock)
2967  *
2968  *      RETURNS:
2969  *      1 if attached SCSI device exists, 0 otherwise.
2970  */
2971 int ata_scsi_offline_dev(struct ata_device *dev)
2972 {
2973         if (dev->sdev) {
2974                 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2975                 return 1;
2976         }
2977         return 0;
2978 }
2979
2980 /**
2981  *      ata_scsi_remove_dev - remove attached SCSI device
2982  *      @dev: ATA device to remove attached SCSI device for
2983  *
2984  *      This function is called from ata_eh_scsi_hotplug() and
2985  *      responsible for removing the SCSI device attached to @dev.
2986  *
2987  *      LOCKING:
2988  *      Kernel thread context (may sleep).
2989  */
2990 static void ata_scsi_remove_dev(struct ata_device *dev)
2991 {
2992         struct ata_port *ap = dev->ap;
2993         struct scsi_device *sdev;
2994         unsigned long flags;
2995
2996         /* Alas, we need to grab scan_mutex to ensure SCSI device
2997          * state doesn't change underneath us and thus
2998          * scsi_device_get() always succeeds.  The mutex locking can
2999          * be removed if there is __scsi_device_get() interface which
3000          * increments reference counts regardless of device state.
3001          */
3002         mutex_lock(&ap->scsi_host->scan_mutex);
3003         spin_lock_irqsave(ap->lock, flags);
3004
3005         /* clearing dev->sdev is protected by host lock */
3006         sdev = dev->sdev;
3007         dev->sdev = NULL;
3008
3009         if (sdev) {
3010                 /* If user initiated unplug races with us, sdev can go
3011                  * away underneath us after the host lock and
3012                  * scan_mutex are released.  Hold onto it.
3013                  */
3014                 if (scsi_device_get(sdev) == 0) {
3015                         /* The following ensures the attached sdev is
3016                          * offline on return from ata_scsi_offline_dev()
3017                          * regardless it wins or loses the race
3018                          * against this function.
3019                          */
3020                         scsi_device_set_state(sdev, SDEV_OFFLINE);
3021                 } else {
3022                         WARN_ON(1);
3023                         sdev = NULL;
3024                 }
3025         }
3026
3027         spin_unlock_irqrestore(ap->lock, flags);
3028         mutex_unlock(&ap->scsi_host->scan_mutex);
3029
3030         if (sdev) {
3031                 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3032                                sdev->sdev_gendev.bus_id);
3033
3034                 scsi_remove_device(sdev);
3035                 scsi_device_put(sdev);
3036         }
3037 }
3038
3039 /**
3040  *      ata_scsi_hotplug - SCSI part of hotplug
3041  *      @work: Pointer to ATA port to perform SCSI hotplug on
3042  *
3043  *      Perform SCSI part of hotplug.  It's executed from a separate
3044  *      workqueue after EH completes.  This is necessary because SCSI
3045  *      hot plugging requires working EH and hot unplugging is
3046  *      synchronized with hot plugging with a mutex.
3047  *
3048  *      LOCKING:
3049  *      Kernel thread context (may sleep).
3050  */
3051 void ata_scsi_hotplug(struct work_struct *work)
3052 {
3053         struct ata_port *ap =
3054                 container_of(work, struct ata_port, hotplug_task.work);
3055         int i;
3056
3057         if (ap->pflags & ATA_PFLAG_UNLOADING) {
3058                 DPRINTK("ENTER/EXIT - unloading\n");
3059                 return;
3060         }
3061
3062         DPRINTK("ENTER\n");
3063
3064         /* unplug detached devices */
3065         for (i = 0; i < ATA_MAX_DEVICES; i++) {
3066                 struct ata_device *dev = &ap->device[i];
3067                 unsigned long flags;
3068
3069                 if (!(dev->flags & ATA_DFLAG_DETACHED))
3070                         continue;
3071
3072                 spin_lock_irqsave(ap->lock, flags);
3073                 dev->flags &= ~ATA_DFLAG_DETACHED;
3074                 spin_unlock_irqrestore(ap->lock, flags);
3075
3076                 ata_scsi_remove_dev(dev);
3077         }
3078
3079         /* scan for new ones */
3080         ata_scsi_scan_host(ap);
3081
3082         /* If we scanned while EH was in progress, scan would have
3083          * failed silently.  Requeue if there are enabled but
3084          * unattached devices.
3085          */
3086         for (i = 0; i < ATA_MAX_DEVICES; i++) {
3087                 struct ata_device *dev = &ap->device[i];
3088                 if (ata_dev_enabled(dev) && !dev->sdev) {
3089                         queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3090                                 round_jiffies_relative(HZ));
3091                         break;
3092                 }
3093         }
3094
3095         DPRINTK("EXIT\n");
3096 }
3097
3098 /**
3099  *      ata_scsi_user_scan - indication for user-initiated bus scan
3100  *      @shost: SCSI host to scan
3101  *      @channel: Channel to scan
3102  *      @id: ID to scan
3103  *      @lun: LUN to scan
3104  *
3105  *      This function is called when user explicitly requests bus
3106  *      scan.  Set probe pending flag and invoke EH.
3107  *
3108  *      LOCKING:
3109  *      SCSI layer (we don't care)
3110  *
3111  *      RETURNS:
3112  *      Zero.
3113  */
3114 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3115                               unsigned int id, unsigned int lun)
3116 {
3117         struct ata_port *ap = ata_shost_to_port(shost);
3118         unsigned long flags;
3119         int rc = 0;
3120
3121         if (!ap->ops->error_handler)
3122                 return -EOPNOTSUPP;
3123
3124         if ((channel != SCAN_WILD_CARD && channel != 0) ||
3125             (lun != SCAN_WILD_CARD && lun != 0))
3126                 return -EINVAL;
3127
3128         spin_lock_irqsave(ap->lock, flags);
3129
3130         if (id == SCAN_WILD_CARD) {
3131                 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3132                 ap->eh_info.action |= ATA_EH_SOFTRESET;
3133         } else {
3134                 struct ata_device *dev = ata_find_dev(ap, id);
3135
3136                 if (dev) {
3137                         ap->eh_info.probe_mask |= 1 << dev->devno;
3138                         ap->eh_info.action |= ATA_EH_SOFTRESET;
3139                         ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3140                 } else
3141                         rc = -EINVAL;
3142         }
3143
3144         if (rc == 0) {
3145                 ata_port_schedule_eh(ap);
3146                 spin_unlock_irqrestore(ap->lock, flags);
3147                 ata_port_wait_eh(ap);
3148         } else
3149                 spin_unlock_irqrestore(ap->lock, flags);
3150
3151         return rc;
3152 }
3153
3154 /**
3155  *      ata_scsi_dev_rescan - initiate scsi_rescan_device()
3156  *      @work: Pointer to ATA port to perform scsi_rescan_device()
3157  *
3158  *      After ATA pass thru (SAT) commands are executed successfully,
3159  *      libata need to propagate the changes to SCSI layer.  This
3160  *      function must be executed from ata_aux_wq such that sdev
3161  *      attach/detach don't race with rescan.
3162  *
3163  *      LOCKING:
3164  *      Kernel thread context (may sleep).
3165  */
3166 void ata_scsi_dev_rescan(struct work_struct *work)
3167 {
3168         struct ata_port *ap =
3169                 container_of(work, struct ata_port, scsi_rescan_task);
3170         unsigned long flags;
3171         unsigned int i;
3172
3173         spin_lock_irqsave(ap->lock, flags);
3174
3175         for (i = 0; i < ATA_MAX_DEVICES; i++) {
3176                 struct ata_device *dev = &ap->device[i];
3177                 struct scsi_device *sdev = dev->sdev;
3178
3179                 if (!ata_dev_enabled(dev) || !sdev)
3180                         continue;
3181                 if (scsi_device_get(sdev))
3182                         continue;
3183
3184                 spin_unlock_irqrestore(ap->lock, flags);
3185                 scsi_rescan_device(&(sdev->sdev_gendev));
3186                 scsi_device_put(sdev);
3187                 spin_lock_irqsave(ap->lock, flags);
3188         }
3189
3190         spin_unlock_irqrestore(ap->lock, flags);
3191 }
3192
3193 /**
3194  *      ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3195  *      @host: ATA host container for all SAS ports
3196  *      @port_info: Information from low-level host driver
3197  *      @shost: SCSI host that the scsi device is attached to
3198  *
3199  *      LOCKING:
3200  *      PCI/etc. bus probe sem.
3201  *
3202  *      RETURNS:
3203  *      ata_port pointer on success / NULL on failure.
3204  */
3205
3206 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3207                                     struct ata_port_info *port_info,
3208                                     struct Scsi_Host *shost)
3209 {
3210         struct ata_port *ap;
3211
3212         ap = ata_port_alloc(host);
3213         if (!ap)
3214                 return NULL;
3215
3216         ap->port_no = 0;
3217         ap->lock = shost->host_lock;
3218         ap->pio_mask = port_info->pio_mask;
3219         ap->mwdma_mask = port_info->mwdma_mask;
3220         ap->udma_mask = port_info->udma_mask;
3221         ap->flags |= port_info->flags;
3222         ap->ops = port_info->port_ops;
3223         ap->cbl = ATA_CBL_SATA;
3224
3225         return ap;
3226 }
3227 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3228
3229 /**
3230  *      ata_sas_port_start - Set port up for dma.
3231  *      @ap: Port to initialize
3232  *
3233  *      Called just after data structures for each port are
3234  *      initialized.  Allocates DMA pad.
3235  *
3236  *      May be used as the port_start() entry in ata_port_operations.
3237  *
3238  *      LOCKING:
3239  *      Inherited from caller.
3240  */
3241 int ata_sas_port_start(struct ata_port *ap)
3242 {
3243         return ata_pad_alloc(ap, ap->dev);
3244 }
3245 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3246
3247 /**
3248  *      ata_port_stop - Undo ata_sas_port_start()
3249  *      @ap: Port to shut down
3250  *
3251  *      Frees the DMA pad.
3252  *
3253  *      May be used as the port_stop() entry in ata_port_operations.
3254  *
3255  *      LOCKING:
3256  *      Inherited from caller.
3257  */
3258
3259 void ata_sas_port_stop(struct ata_port *ap)
3260 {
3261         ata_pad_free(ap, ap->dev);
3262 }
3263 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3264
3265 /**
3266  *      ata_sas_port_init - Initialize a SATA device
3267  *      @ap: SATA port to initialize
3268  *
3269  *      LOCKING:
3270  *      PCI/etc. bus probe sem.
3271  *
3272  *      RETURNS:
3273  *      Zero on success, non-zero on error.
3274  */
3275
3276 int ata_sas_port_init(struct ata_port *ap)
3277 {
3278         int rc = ap->ops->port_start(ap);
3279
3280         if (!rc) {
3281                 ap->print_id = ata_print_id++;
3282                 rc = ata_bus_probe(ap);
3283         }
3284
3285         return rc;
3286 }
3287 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3288
3289 /**
3290  *      ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3291  *      @ap: SATA port to destroy
3292  *
3293  */
3294
3295 void ata_sas_port_destroy(struct ata_port *ap)
3296 {
3297         if (ap->ops->port_stop)
3298                 ap->ops->port_stop(ap);
3299         kfree(ap);
3300 }
3301 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3302
3303 /**
3304  *      ata_sas_slave_configure - Default slave_config routine for libata devices
3305  *      @sdev: SCSI device to configure
3306  *      @ap: ATA port to which SCSI device is attached
3307  *
3308  *      RETURNS:
3309  *      Zero.
3310  */
3311
3312 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3313 {
3314         ata_scsi_sdev_config(sdev);
3315         ata_scsi_dev_config(sdev, ap->device);
3316         return 0;
3317 }
3318 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3319
3320 /**
3321  *      ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3322  *      @cmd: SCSI command to be sent
3323  *      @done: Completion function, called when command is complete
3324  *      @ap:    ATA port to which the command is being sent
3325  *
3326  *      RETURNS:
3327  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3328  *      0 otherwise.
3329  */
3330
3331 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3332                      struct ata_port *ap)
3333 {
3334         int rc = 0;
3335
3336         ata_scsi_dump_cdb(ap, cmd);
3337
3338         if (likely(ata_scsi_dev_enabled(ap->device)))
3339                 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3340         else {
3341                 cmd->result = (DID_BAD_TARGET << 16);
3342                 done(cmd);
3343         }
3344         return rc;
3345 }
3346 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);