drivers/ata/libata-scsi.c

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