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