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