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