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