kernel/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_scsi_qc_complete(struct ata_queued_cmd *qc)
1761 {
1762         struct ata_port *ap = qc->ap;
1763         struct scsi_cmnd *cmd = qc->scsicmd;
1764         u8 *cdb = cmd->cmnd;
1765         int need_sense = (qc->err_mask != 0);
1766
1767         /* For ATA pass thru (SAT) commands, generate a sense block if
1768          * user mandated it or if there's an error.  Note that if we
1769          * generate because the user forced us to [CK_COND =1], a check
1770          * condition is generated and the ATA register values are returned
1771          * whether the command completed successfully or not. If there
1772          * was no error, we use the following sense data:
1773          * sk = RECOVERED ERROR
1774          * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1775          */
1776         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1777             ((cdb[2] & 0x20) || need_sense)) {
1778                 ata_gen_passthru_sense(qc);
1779         } else {
1780                 if (!need_sense) {
1781                         cmd->result = SAM_STAT_GOOD;
1782                 } else {
1783                         /* TODO: decide which descriptor format to use
1784                          * for 48b LBA devices and call that here
1785                          * instead of the fixed desc, which is only
1786                          * good for smaller LBA (and maybe CHS?)
1787                          * devices.
1788                          */
1789                         ata_gen_ata_sense(qc);
1790                 }
1791         }
1792
1793         if (need_sense && !ap->ops->error_handler)
1794                 ata_dump_status(ap->print_id, &qc->result_tf);
1795
1796         qc->scsidone(cmd);
1797
1798         ata_qc_free(qc);
1799 }
1800
1801 /**
1802  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1803  *      @dev: ATA device to which the command is addressed
1804  *      @cmd: SCSI command to execute
1805  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1806  *
1807  *      Our ->queuecommand() function has decided that the SCSI
1808  *      command issued can be directly translated into an ATA
1809  *      command, rather than handled internally.
1810  *
1811  *      This function sets up an ata_queued_cmd structure for the
1812  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1813  *
1814  *      The xlat_func argument (actor) returns 0 if ready to execute
1815  *      ATA command, else 1 to finish translation. If 1 is returned
1816  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1817  *      to be set reflecting an error condition or clean (early)
1818  *      termination.
1819  *
1820  *      LOCKING:
1821  *      spin_lock_irqsave(host lock)
1822  *
1823  *      RETURNS:
1824  *      0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1825  *      needs to be deferred.
1826  */
1827 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1828                               ata_xlat_func_t xlat_func)
1829 {
1830         struct ata_port *ap = dev->link->ap;
1831         struct ata_queued_cmd *qc;
1832         int rc;
1833
1834         VPRINTK("ENTER\n");
1835
1836         qc = ata_scsi_qc_new(dev, cmd);
1837         if (!qc)
1838                 goto err_mem;
1839
1840         /* data is present; dma-map it */
1841         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1842             cmd->sc_data_direction == DMA_TO_DEVICE) {
1843                 if (unlikely(scsi_bufflen(cmd) < 1)) {
1844                         ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1845                         goto err_did;
1846                 }
1847
1848                 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1849
1850                 qc->dma_dir = cmd->sc_data_direction;
1851         }
1852
1853         qc->complete_fn = ata_scsi_qc_complete;
1854
1855         if (xlat_func(qc))
1856                 goto early_finish;
1857
1858         if (ap->ops->qc_defer) {
1859                 if ((rc = ap->ops->qc_defer(qc)))
1860                         goto defer;
1861         }
1862
1863         /* select device, send command to hardware */
1864         ata_qc_issue(qc);
1865
1866         VPRINTK("EXIT\n");
1867         return 0;
1868
1869 early_finish:
1870         ata_qc_free(qc);
1871         cmd->scsi_done(cmd);
1872         DPRINTK("EXIT - early finish (good or error)\n");
1873         return 0;
1874
1875 err_did:
1876         ata_qc_free(qc);
1877         cmd->result = (DID_ERROR << 16);
1878         cmd->scsi_done(cmd);
1879 err_mem:
1880         DPRINTK("EXIT - internal\n");
1881         return 0;
1882
1883 defer:
1884         ata_qc_free(qc);
1885         DPRINTK("EXIT - defer\n");
1886         if (rc == ATA_DEFER_LINK)
1887                 return SCSI_MLQUEUE_DEVICE_BUSY;
1888         else
1889                 return SCSI_MLQUEUE_HOST_BUSY;
1890 }
1891
1892 /**
1893  *      ata_scsi_rbuf_get - Map response buffer.
1894  *      @cmd: SCSI command containing buffer to be mapped.
1895  *      @flags: unsigned long variable to store irq enable status
1896  *      @copy_in: copy in from user buffer
1897  *
1898  *      Prepare buffer for simulated SCSI commands.
1899  *
1900  *      LOCKING:
1901  *      spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1902  *
1903  *      RETURNS:
1904  *      Pointer to response buffer.
1905  */
1906 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1907                                unsigned long *flags)
1908 {
1909         spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1910
1911         memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1912         if (copy_in)
1913                 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1914                                   ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1915         return ata_scsi_rbuf;
1916 }
1917
1918 /**
1919  *      ata_scsi_rbuf_put - Unmap response buffer.
1920  *      @cmd: SCSI command containing buffer to be unmapped.
1921  *      @copy_out: copy out result
1922  *      @flags: @flags passed to ata_scsi_rbuf_get()
1923  *
1924  *      Returns rbuf buffer.  The result is copied to @cmd's buffer if
1925  *      @copy_back is true.
1926  *
1927  *      LOCKING:
1928  *      Unlocks ata_scsi_rbuf_lock.
1929  */
1930 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1931                                      unsigned long *flags)
1932 {
1933         if (copy_out)
1934                 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1935                                     ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1936         spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1937 }
1938
1939 /**
1940  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1941  *      @args: device IDENTIFY data / SCSI command of interest.
1942  *      @actor: Callback hook for desired SCSI command simulator
1943  *
1944  *      Takes care of the hard work of simulating a SCSI command...
1945  *      Mapping the response buffer, calling the command's handler,
1946  *      and handling the handler's return value.  This return value
1947  *      indicates whether the handler wishes the SCSI command to be
1948  *      completed successfully (0), or not (in which case cmd->result
1949  *      and sense buffer are assumed to be set).
1950  *
1951  *      LOCKING:
1952  *      spin_lock_irqsave(host lock)
1953  */
1954 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1955                 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1956 {
1957         u8 *rbuf;
1958         unsigned int rc;
1959         struct scsi_cmnd *cmd = args->cmd;
1960         unsigned long flags;
1961
1962         rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1963         rc = actor(args, rbuf);
1964         ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1965
1966         if (rc == 0)
1967                 cmd->result = SAM_STAT_GOOD;
1968         args->done(cmd);
1969 }
1970
1971 /**
1972  *      ata_scsiop_inq_std - Simulate INQUIRY command
1973  *      @args: device IDENTIFY data / SCSI command of interest.
1974  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1975  *
1976  *      Returns standard device identification data associated
1977  *      with non-VPD INQUIRY command output.
1978  *
1979  *      LOCKING:
1980  *      spin_lock_irqsave(host lock)
1981  */
1982 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1983 {
1984         const u8 versions[] = {
1985                 0x00,
1986                 0x60,   /* SAM-3 (no version claimed) */
1987
1988                 0x03,
1989                 0x20,   /* SBC-2 (no version claimed) */
1990
1991                 0x02,
1992                 0x60    /* SPC-3 (no version claimed) */
1993         };
1994         const u8 versions_zbc[] = {
1995                 0x00,
1996                 0xA0,   /* SAM-5 (no version claimed) */
1997
1998                 0x04,
1999                 0xC0,   /* SBC-3 (no version claimed) */
2000
2001                 0x04,
2002                 0x60,   /* SPC-4 (no version claimed) */
2003
2004                 0x60,
2005                 0x20,   /* ZBC (no version claimed) */
2006         };
2007
2008         u8 hdr[] = {
2009                 TYPE_DISK,
2010                 0,
2011                 0x5,    /* claim SPC-3 version compatibility */
2012                 2,
2013                 95 - 4
2014         };
2015
2016         VPRINTK("ENTER\n");
2017
2018         /* set scsi removable (RMB) bit per ata bit */
2019         if (ata_id_removable(args->id))
2020                 hdr[1] |= (1 << 7);
2021
2022         if (args->dev->class == ATA_DEV_ZAC) {
2023                 hdr[0] = TYPE_ZBC;
2024                 hdr[2] = 0x6; /* ZBC is defined in SPC-4 */
2025         }
2026
2027         memcpy(rbuf, hdr, sizeof(hdr));
2028         memcpy(&rbuf[8], "ATA     ", 8);
2029         ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
2030
2031         /* From SAT, use last 2 words from fw rev unless they are spaces */
2032         ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2033         if (strncmp(&rbuf[32], "    ", 4) == 0)
2034                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2035
2036         if (rbuf[32] == 0 || rbuf[32] == ' ')
2037                 memcpy(&rbuf[32], "n/a ", 4);
2038
2039         if (args->dev->class == ATA_DEV_ZAC)
2040                 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2041         else
2042                 memcpy(rbuf + 58, versions, sizeof(versions));
2043
2044         return 0;
2045 }
2046
2047 /**
2048  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2049  *      @args: device IDENTIFY data / SCSI command of interest.
2050  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2051  *
2052  *      Returns list of inquiry VPD pages available.
2053  *
2054  *      LOCKING:
2055  *      spin_lock_irqsave(host lock)
2056  */
2057 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2058 {
2059         const u8 pages[] = {
2060                 0x00,   /* page 0x00, this page */
2061                 0x80,   /* page 0x80, unit serial no page */
2062                 0x83,   /* page 0x83, device ident page */
2063                 0x89,   /* page 0x89, ata info page */
2064                 0xb0,   /* page 0xb0, block limits page */
2065                 0xb1,   /* page 0xb1, block device characteristics page */
2066                 0xb2,   /* page 0xb2, thin provisioning page */
2067         };
2068
2069         rbuf[3] = sizeof(pages);        /* number of supported VPD pages */
2070         memcpy(rbuf + 4, pages, sizeof(pages));
2071         return 0;
2072 }
2073
2074 /**
2075  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2076  *      @args: device IDENTIFY data / SCSI command of interest.
2077  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2078  *
2079  *      Returns ATA device serial number.
2080  *
2081  *      LOCKING:
2082  *      spin_lock_irqsave(host lock)
2083  */
2084 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2085 {
2086         const u8 hdr[] = {
2087                 0,
2088                 0x80,                   /* this page code */
2089                 0,
2090                 ATA_ID_SERNO_LEN,       /* page len */
2091         };
2092
2093         memcpy(rbuf, hdr, sizeof(hdr));
2094         ata_id_string(args->id, (unsigned char *) &rbuf[4],
2095                       ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2096         return 0;
2097 }
2098
2099 /**
2100  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2101  *      @args: device IDENTIFY data / SCSI command of interest.
2102  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2103  *
2104  *      Yields two logical unit device identification designators:
2105  *       - vendor specific ASCII containing the ATA serial number
2106  *       - SAT defined "t10 vendor id based" containing ASCII vendor
2107  *         name ("ATA     "), model and serial numbers.
2108  *
2109  *      LOCKING:
2110  *      spin_lock_irqsave(host lock)
2111  */
2112 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2113 {
2114         const int sat_model_serial_desc_len = 68;
2115         int num;
2116
2117         rbuf[1] = 0x83;                 /* this page code */
2118         num = 4;
2119
2120         /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2121         rbuf[num + 0] = 2;
2122         rbuf[num + 3] = ATA_ID_SERNO_LEN;
2123         num += 4;
2124         ata_id_string(args->id, (unsigned char *) rbuf + num,
2125                       ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2126         num += ATA_ID_SERNO_LEN;
2127
2128         /* SAT defined lu model and serial numbers descriptor */
2129         /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2130         rbuf[num + 0] = 2;
2131         rbuf[num + 1] = 1;
2132         rbuf[num + 3] = sat_model_serial_desc_len;
2133         num += 4;
2134         memcpy(rbuf + num, "ATA     ", 8);
2135         num += 8;
2136         ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2137                       ATA_ID_PROD_LEN);
2138         num += ATA_ID_PROD_LEN;
2139         ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2140                       ATA_ID_SERNO_LEN);
2141         num += ATA_ID_SERNO_LEN;
2142
2143         if (ata_id_has_wwn(args->id)) {
2144                 /* SAT defined lu world wide name */
2145                 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2146                 rbuf[num + 0] = 1;
2147                 rbuf[num + 1] = 3;
2148                 rbuf[num + 3] = ATA_ID_WWN_LEN;
2149                 num += 4;
2150                 ata_id_string(args->id, (unsigned char *) rbuf + num,
2151                               ATA_ID_WWN, ATA_ID_WWN_LEN);
2152                 num += ATA_ID_WWN_LEN;
2153         }
2154         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
2155         return 0;
2156 }
2157
2158 /**
2159  *      ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2160  *      @args: device IDENTIFY data / SCSI command of interest.
2161  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2162  *
2163  *      Yields SAT-specified ATA VPD page.
2164  *
2165  *      LOCKING:
2166  *      spin_lock_irqsave(host lock)
2167  */
2168 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2169 {
2170         struct ata_taskfile tf;
2171
2172         memset(&tf, 0, sizeof(tf));
2173
2174         rbuf[1] = 0x89;                 /* our page code */
2175         rbuf[2] = (0x238 >> 8);         /* page size fixed at 238h */
2176         rbuf[3] = (0x238 & 0xff);
2177
2178         memcpy(&rbuf[8], "linux   ", 8);
2179         memcpy(&rbuf[16], "libata          ", 16);
2180         memcpy(&rbuf[32], DRV_VERSION, 4);
2181
2182         /* we don't store the ATA device signature, so we fake it */
2183
2184         tf.command = ATA_DRDY;          /* really, this is Status reg */
2185         tf.lbal = 0x1;
2186         tf.nsect = 0x1;
2187
2188         ata_tf_to_fis(&tf, 0, 1, &rbuf[36]);    /* TODO: PMP? */
2189         rbuf[36] = 0x34;                /* force D2H Reg FIS (34h) */
2190
2191         rbuf[56] = ATA_CMD_ID_ATA;
2192
2193         memcpy(&rbuf[60], &args->id[0], 512);
2194         return 0;
2195 }
2196
2197 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2198 {
2199         u16 min_io_sectors;
2200
2201         rbuf[1] = 0xb0;
2202         rbuf[3] = 0x3c;         /* required VPD size with unmap support */
2203
2204         /*
2205          * Optimal transfer length granularity.
2206          *
2207          * This is always one physical block, but for disks with a smaller
2208          * logical than physical sector size we need to figure out what the
2209          * latter is.
2210          */
2211         min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2212         put_unaligned_be16(min_io_sectors, &rbuf[6]);
2213
2214         /*
2215          * Optimal unmap granularity.
2216          *
2217          * The ATA spec doesn't even know about a granularity or alignment
2218          * for the TRIM command.  We can leave away most of the unmap related
2219          * VPD page entries, but we have specifify a granularity to signal
2220          * that we support some form of unmap - in thise case via WRITE SAME
2221          * with the unmap bit set.
2222          */
2223         if (ata_id_has_trim(args->id)) {
2224                 put_unaligned_be64(65535 * 512 / 8, &rbuf[36]);
2225                 put_unaligned_be32(1, &rbuf[28]);
2226         }
2227
2228         return 0;
2229 }
2230
2231 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2232 {
2233         int form_factor = ata_id_form_factor(args->id);
2234         int media_rotation_rate = ata_id_rotation_rate(args->id);
2235
2236         rbuf[1] = 0xb1;
2237         rbuf[3] = 0x3c;
2238         rbuf[4] = media_rotation_rate >> 8;
2239         rbuf[5] = media_rotation_rate;
2240         rbuf[7] = form_factor;
2241
2242         return 0;
2243 }
2244
2245 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2246 {
2247         /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2248         rbuf[1] = 0xb2;
2249         rbuf[3] = 0x4;
2250         rbuf[5] = 1 << 6;       /* TPWS */
2251
2252         return 0;
2253 }
2254
2255 /**
2256  *      ata_scsiop_noop - Command handler that simply returns success.
2257  *      @args: device IDENTIFY data / SCSI command of interest.
2258  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2259  *
2260  *      No operation.  Simply returns success to caller, to indicate
2261  *      that the caller should successfully complete this SCSI command.
2262  *
2263  *      LOCKING:
2264  *      spin_lock_irqsave(host lock)
2265  */
2266 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2267 {
2268         VPRINTK("ENTER\n");
2269         return 0;
2270 }
2271
2272 /**
2273  *      modecpy - Prepare response for MODE SENSE
2274  *      @dest: output buffer
2275  *      @src: data being copied
2276  *      @n: length of mode page
2277  *      @changeable: whether changeable parameters are requested
2278  *
2279  *      Generate a generic MODE SENSE page for either current or changeable
2280  *      parameters.
2281  *
2282  *      LOCKING:
2283  *      None.
2284  */
2285 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2286 {
2287         if (changeable) {
2288                 memcpy(dest, src, 2);
2289                 memset(dest + 2, 0, n - 2);
2290         } else {
2291                 memcpy(dest, src, n);
2292         }
2293 }
2294
2295 /**
2296  *      ata_msense_caching - Simulate MODE SENSE caching info page
2297  *      @id: device IDENTIFY data
2298  *      @buf: output buffer
2299  *      @changeable: whether changeable parameters are requested
2300  *
2301  *      Generate a caching info page, which conditionally indicates
2302  *      write caching to the SCSI layer, depending on device
2303  *      capabilities.
2304  *
2305  *      LOCKING:
2306  *      None.
2307  */
2308 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2309 {
2310         modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2311         if (changeable || ata_id_wcache_enabled(id))
2312                 buf[2] |= (1 << 2);     /* write cache enable */
2313         if (!changeable && !ata_id_rahead_enabled(id))
2314                 buf[12] |= (1 << 5);    /* disable read ahead */
2315         return sizeof(def_cache_mpage);
2316 }
2317
2318 /**
2319  *      ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2320  *      @buf: output buffer
2321  *      @changeable: whether changeable parameters are requested
2322  *
2323  *      Generate a generic MODE SENSE control mode page.
2324  *
2325  *      LOCKING:
2326  *      None.
2327  */
2328 static unsigned int ata_msense_ctl_mode(u8 *buf, bool changeable)
2329 {
2330         modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2331         return sizeof(def_control_mpage);
2332 }
2333
2334 /**
2335  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2336  *      @buf: output buffer
2337  *      @changeable: whether changeable parameters are requested
2338  *
2339  *      Generate a generic MODE SENSE r/w error recovery page.
2340  *
2341  *      LOCKING:
2342  *      None.
2343  */
2344 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2345 {
2346         modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2347                 changeable);
2348         return sizeof(def_rw_recovery_mpage);
2349 }
2350
2351 /*
2352  * We can turn this into a real blacklist if it's needed, for now just
2353  * blacklist any Maxtor BANC1G10 revision firmware
2354  */
2355 static int ata_dev_supports_fua(u16 *id)
2356 {
2357         unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2358
2359         if (!libata_fua)
2360                 return 0;
2361         if (!ata_id_has_fua(id))
2362                 return 0;
2363
2364         ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2365         ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2366
2367         if (strcmp(model, "Maxtor"))
2368                 return 1;
2369         if (strcmp(fw, "BANC1G10"))
2370                 return 1;
2371
2372         return 0; /* blacklisted */
2373 }
2374
2375 /**
2376  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2377  *      @args: device IDENTIFY data / SCSI command of interest.
2378  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2379  *
2380  *      Simulate MODE SENSE commands. Assume this is invoked for direct
2381  *      access devices (e.g. disks) only. There should be no block
2382  *      descriptor for other device types.
2383  *
2384  *      LOCKING:
2385  *      spin_lock_irqsave(host lock)
2386  */
2387 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2388 {
2389         struct ata_device *dev = args->dev;
2390         u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2391         const u8 sat_blk_desc[] = {
2392                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
2393                 0,
2394                 0, 0x2, 0x0     /* block length: 512 bytes */
2395         };
2396         u8 pg, spg;
2397         unsigned int ebd, page_control, six_byte;
2398         u8 dpofua;
2399
2400         VPRINTK("ENTER\n");
2401
2402         six_byte = (scsicmd[0] == MODE_SENSE);
2403         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
2404         /*
2405          * LLBA bit in msense(10) ignored (compliant)
2406          */
2407
2408         page_control = scsicmd[2] >> 6;
2409         switch (page_control) {
2410         case 0: /* current */
2411         case 1: /* changeable */
2412         case 2: /* defaults */
2413                 break;  /* supported */
2414         case 3: /* saved */
2415                 goto saving_not_supp;
2416         default:
2417                 goto invalid_fld;
2418         }
2419
2420         if (six_byte)
2421                 p += 4 + (ebd ? 8 : 0);
2422         else
2423                 p += 8 + (ebd ? 8 : 0);
2424
2425         pg = scsicmd[2] & 0x3f;
2426         spg = scsicmd[3];
2427         /*
2428          * No mode subpages supported (yet) but asking for _all_
2429          * subpages may be valid
2430          */
2431         if (spg && (spg != ALL_SUB_MPAGES))
2432                 goto invalid_fld;
2433
2434         switch(pg) {
2435         case RW_RECOVERY_MPAGE:
2436                 p += ata_msense_rw_recovery(p, page_control == 1);
2437                 break;
2438
2439         case CACHE_MPAGE:
2440                 p += ata_msense_caching(args->id, p, page_control == 1);
2441                 break;
2442
2443         case CONTROL_MPAGE:
2444                 p += ata_msense_ctl_mode(p, page_control == 1);
2445                 break;
2446
2447         case ALL_MPAGES:
2448                 p += ata_msense_rw_recovery(p, page_control == 1);
2449                 p += ata_msense_caching(args->id, p, page_control == 1);
2450                 p += ata_msense_ctl_mode(p, page_control == 1);
2451                 break;
2452
2453         default:                /* invalid page code */
2454                 goto invalid_fld;
2455         }
2456
2457         dpofua = 0;
2458         if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2459             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2460                 dpofua = 1 << 4;
2461
2462         if (six_byte) {
2463                 rbuf[0] = p - rbuf - 1;
2464                 rbuf[2] |= dpofua;
2465                 if (ebd) {
2466                         rbuf[3] = sizeof(sat_blk_desc);
2467                         memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2468                 }
2469         } else {
2470                 unsigned int output_len = p - rbuf - 2;
2471
2472                 rbuf[0] = output_len >> 8;
2473                 rbuf[1] = output_len;
2474                 rbuf[3] |= dpofua;
2475                 if (ebd) {
2476                         rbuf[7] = sizeof(sat_blk_desc);
2477                         memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2478                 }
2479         }
2480         return 0;
2481
2482 invalid_fld:
2483         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2484         /* "Invalid field in cbd" */
2485         return 1;
2486
2487 saving_not_supp:
2488         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2489          /* "Saving parameters not supported" */
2490         return 1;
2491 }
2492
2493 /**
2494  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2495  *      @args: device IDENTIFY data / SCSI command of interest.
2496  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2497  *
2498  *      Simulate READ CAPACITY commands.
2499  *
2500  *      LOCKING:
2501  *      None.
2502  */
2503 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2504 {
2505         struct ata_device *dev = args->dev;
2506         u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2507         u32 sector_size; /* physical sector size in bytes */
2508         u8 log2_per_phys;
2509         u16 lowest_aligned;
2510
2511         sector_size = ata_id_logical_sector_size(dev->id);
2512         log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2513         lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2514
2515         VPRINTK("ENTER\n");
2516
2517         if (args->cmd->cmnd[0] == READ_CAPACITY) {
2518                 if (last_lba >= 0xffffffffULL)
2519                         last_lba = 0xffffffff;
2520
2521                 /* sector count, 32-bit */
2522                 rbuf[0] = last_lba >> (8 * 3);
2523                 rbuf[1] = last_lba >> (8 * 2);
2524                 rbuf[2] = last_lba >> (8 * 1);
2525                 rbuf[3] = last_lba;
2526
2527                 /* sector size */
2528                 rbuf[4] = sector_size >> (8 * 3);
2529                 rbuf[5] = sector_size >> (8 * 2);
2530                 rbuf[6] = sector_size >> (8 * 1);
2531                 rbuf[7] = sector_size;
2532         } else {
2533                 /* sector count, 64-bit */
2534                 rbuf[0] = last_lba >> (8 * 7);
2535                 rbuf[1] = last_lba >> (8 * 6);
2536                 rbuf[2] = last_lba >> (8 * 5);
2537                 rbuf[3] = last_lba >> (8 * 4);
2538                 rbuf[4] = last_lba >> (8 * 3);
2539                 rbuf[5] = last_lba >> (8 * 2);
2540                 rbuf[6] = last_lba >> (8 * 1);
2541                 rbuf[7] = last_lba;
2542
2543                 /* sector size */
2544                 rbuf[ 8] = sector_size >> (8 * 3);
2545                 rbuf[ 9] = sector_size >> (8 * 2);
2546                 rbuf[10] = sector_size >> (8 * 1);
2547                 rbuf[11] = sector_size;
2548
2549                 rbuf[12] = 0;
2550                 rbuf[13] = log2_per_phys;
2551                 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2552                 rbuf[15] = lowest_aligned;
2553
2554                 if (ata_id_has_trim(args->id) &&
2555                     !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2556                         rbuf[14] |= 0x80; /* LBPME */
2557
2558                         if (ata_id_has_zero_after_trim(args->id) &&
2559                             dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2560                                 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2561                                 rbuf[14] |= 0x40; /* LBPRZ */
2562                         }
2563                 }
2564         }
2565         return 0;
2566 }
2567
2568 /**
2569  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
2570  *      @args: device IDENTIFY data / SCSI command of interest.
2571  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2572  *
2573  *      Simulate REPORT LUNS command.
2574  *
2575  *      LOCKING:
2576  *      spin_lock_irqsave(host lock)
2577  */
2578 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2579 {
2580         VPRINTK("ENTER\n");
2581         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2582
2583         return 0;
2584 }
2585
2586 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2587 {
2588         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2589                 /* FIXME: not quite right; we don't want the
2590                  * translation of taskfile registers into
2591                  * a sense descriptors, since that's only
2592                  * correct for ATA, not ATAPI
2593                  */
2594                 ata_gen_passthru_sense(qc);
2595         }
2596
2597         qc->scsidone(qc->scsicmd);
2598         ata_qc_free(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                 qc->scsidone(cmd);
2694                 ata_qc_free(qc);
2695                 return;
2696         }
2697
2698         /* successful completion or old EH failure path */
2699         if (unlikely(err_mask & AC_ERR_DEV)) {
2700                 cmd->result = SAM_STAT_CHECK_CONDITION;
2701                 atapi_request_sense(qc);
2702                 return;
2703         } else if (unlikely(err_mask)) {
2704                 /* FIXME: not quite right; we don't want the
2705                  * translation of taskfile registers into
2706                  * a sense descriptors, since that's only
2707                  * correct for ATA, not ATAPI
2708                  */
2709                 ata_gen_passthru_sense(qc);
2710         } else {
2711                 u8 *scsicmd = cmd->cmnd;
2712
2713                 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2714                         unsigned long flags;
2715                         u8 *buf;
2716
2717                         buf = ata_scsi_rbuf_get(cmd, true, &flags);
2718
2719         /* ATAPI devices typically report zero for their SCSI version,
2720          * and sometimes deviate from the spec WRT response data
2721          * format.  If SCSI version is reported as zero like normal,
2722          * then we make the following fixups:  1) Fake MMC-5 version,
2723          * to indicate to the Linux scsi midlayer this is a modern
2724          * device.  2) Ensure response data format / ATAPI information
2725          * are always correct.
2726          */
2727                         if (buf[2] == 0) {
2728                                 buf[2] = 0x5;
2729                                 buf[3] = 0x32;
2730                         }
2731
2732                         ata_scsi_rbuf_put(cmd, true, &flags);
2733                 }
2734
2735                 cmd->result = SAM_STAT_GOOD;
2736         }
2737
2738         qc->scsidone(cmd);
2739         ata_qc_free(qc);
2740 }
2741 /**
2742  *      atapi_xlat - Initialize PACKET taskfile
2743  *      @qc: command structure to be initialized
2744  *
2745  *      LOCKING:
2746  *      spin_lock_irqsave(host lock)
2747  *
2748  *      RETURNS:
2749  *      Zero on success, non-zero on failure.
2750  */
2751 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2752 {
2753         struct scsi_cmnd *scmd = qc->scsicmd;
2754         struct ata_device *dev = qc->dev;
2755         int nodata = (scmd->sc_data_direction == DMA_NONE);
2756         int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2757         unsigned int nbytes;
2758
2759         memset(qc->cdb, 0, dev->cdb_len);
2760         memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2761
2762         qc->complete_fn = atapi_qc_complete;
2763
2764         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2765         if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2766                 qc->tf.flags |= ATA_TFLAG_WRITE;
2767                 DPRINTK("direction: write\n");
2768         }
2769
2770         qc->tf.command = ATA_CMD_PACKET;
2771         ata_qc_set_pc_nbytes(qc);
2772
2773         /* check whether ATAPI DMA is safe */
2774         if (!nodata && !using_pio && atapi_check_dma(qc))
2775                 using_pio = 1;
2776
2777         /* Some controller variants snoop this value for Packet
2778          * transfers to do state machine and FIFO management.  Thus we
2779          * want to set it properly, and for DMA where it is
2780          * effectively meaningless.
2781          */
2782         nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2783
2784         /* Most ATAPI devices which honor transfer chunk size don't
2785          * behave according to the spec when odd chunk size which
2786          * matches the transfer length is specified.  If the number of
2787          * bytes to transfer is 2n+1.  According to the spec, what
2788          * should happen is to indicate that 2n+1 is going to be
2789          * transferred and transfer 2n+2 bytes where the last byte is
2790          * padding.
2791          *
2792          * In practice, this doesn't happen.  ATAPI devices first
2793          * indicate and transfer 2n bytes and then indicate and
2794          * transfer 2 bytes where the last byte is padding.
2795          *
2796          * This inconsistency confuses several controllers which
2797          * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2798          * These controllers use actual number of transferred bytes to
2799          * update DMA poitner and transfer of 4n+2 bytes make those
2800          * controller push DMA pointer by 4n+4 bytes because SATA data
2801          * FISes are aligned to 4 bytes.  This causes data corruption
2802          * and buffer overrun.
2803          *
2804          * Always setting nbytes to even number solves this problem
2805          * because then ATAPI devices don't have to split data at 2n
2806          * boundaries.
2807          */
2808         if (nbytes & 0x1)
2809                 nbytes++;
2810
2811         qc->tf.lbam = (nbytes & 0xFF);
2812         qc->tf.lbah = (nbytes >> 8);
2813
2814         if (nodata)
2815                 qc->tf.protocol = ATAPI_PROT_NODATA;
2816         else if (using_pio)
2817                 qc->tf.protocol = ATAPI_PROT_PIO;
2818         else {
2819                 /* DMA data xfer */
2820                 qc->tf.protocol = ATAPI_PROT_DMA;
2821                 qc->tf.feature |= ATAPI_PKT_DMA;
2822
2823                 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2824                     (scmd->sc_data_direction != DMA_TO_DEVICE))
2825                         /* some SATA bridges need us to indicate data xfer direction */
2826                         qc->tf.feature |= ATAPI_DMADIR;
2827         }
2828
2829
2830         /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2831            as ATAPI tape drives don't get this right otherwise */
2832         return 0;
2833 }
2834
2835 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2836 {
2837         if (!sata_pmp_attached(ap)) {
2838                 if (likely(devno < ata_link_max_devices(&ap->link)))
2839                         return &ap->link.device[devno];
2840         } else {
2841                 if (likely(devno < ap->nr_pmp_links))
2842                         return &ap->pmp_link[devno].device[0];
2843         }
2844
2845         return NULL;
2846 }
2847
2848 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2849                                               const struct scsi_device *scsidev)
2850 {
2851         int devno;
2852
2853         /* skip commands not addressed to targets we simulate */
2854         if (!sata_pmp_attached(ap)) {
2855                 if (unlikely(scsidev->channel || scsidev->lun))
2856                         return NULL;
2857                 devno = scsidev->id;
2858         } else {
2859                 if (unlikely(scsidev->id || scsidev->lun))
2860                         return NULL;
2861                 devno = scsidev->channel;
2862         }
2863
2864         return ata_find_dev(ap, devno);
2865 }
2866
2867 /**
2868  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2869  *      @ap: ATA port to which the device is attached
2870  *      @scsidev: SCSI device from which we derive the ATA device
2871  *
2872  *      Given various information provided in struct scsi_cmnd,
2873  *      map that onto an ATA bus, and using that mapping
2874  *      determine which ata_device is associated with the
2875  *      SCSI command to be sent.
2876  *
2877  *      LOCKING:
2878  *      spin_lock_irqsave(host lock)
2879  *
2880  *      RETURNS:
2881  *      Associated ATA device, or %NULL if not found.
2882  */
2883 static struct ata_device *
2884 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2885 {
2886         struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2887
2888         if (unlikely(!dev || !ata_dev_enabled(dev)))
2889                 return NULL;
2890
2891         return dev;
2892 }
2893
2894 /*
2895  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2896  *      @byte1: Byte 1 from pass-thru CDB.
2897  *
2898  *      RETURNS:
2899  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2900  */
2901 static u8
2902 ata_scsi_map_proto(u8 byte1)
2903 {
2904         switch((byte1 & 0x1e) >> 1) {
2905         case 3:         /* Non-data */
2906                 return ATA_PROT_NODATA;
2907
2908         case 6:         /* DMA */
2909         case 10:        /* UDMA Data-in */
2910         case 11:        /* UDMA Data-Out */
2911                 return ATA_PROT_DMA;
2912
2913         case 4:         /* PIO Data-in */
2914         case 5:         /* PIO Data-out */
2915                 return ATA_PROT_PIO;
2916
2917         case 0:         /* Hard Reset */
2918         case 1:         /* SRST */
2919         case 8:         /* Device Diagnostic */
2920         case 9:         /* Device Reset */
2921         case 7:         /* DMA Queued */
2922         case 12:        /* FPDMA */
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         /*
2951          * 12 and 16 byte CDBs use different offsets to
2952          * provide the various register values.
2953          */
2954         if (cdb[0] == ATA_16) {
2955                 /*
2956                  * 16-byte CDB - may contain extended commands.
2957                  *
2958                  * If that is the case, copy the upper byte register values.
2959                  */
2960                 if (cdb[1] & 0x01) {
2961                         tf->hob_feature = cdb[3];
2962                         tf->hob_nsect = cdb[5];
2963                         tf->hob_lbal = cdb[7];
2964                         tf->hob_lbam = cdb[9];
2965                         tf->hob_lbah = cdb[11];
2966                         tf->flags |= ATA_TFLAG_LBA48;
2967                 } else
2968                         tf->flags &= ~ATA_TFLAG_LBA48;
2969
2970                 /*
2971                  * Always copy low byte, device and command registers.
2972                  */
2973                 tf->feature = cdb[4];
2974                 tf->nsect = cdb[6];
2975                 tf->lbal = cdb[8];
2976                 tf->lbam = cdb[10];
2977                 tf->lbah = cdb[12];
2978                 tf->device = cdb[13];
2979                 tf->command = cdb[14];
2980         } else {
2981                 /*
2982                  * 12-byte CDB - incapable of extended commands.
2983                  */
2984                 tf->flags &= ~ATA_TFLAG_LBA48;
2985
2986                 tf->feature = cdb[3];
2987                 tf->nsect = cdb[4];
2988                 tf->lbal = cdb[5];
2989                 tf->lbam = cdb[6];
2990                 tf->lbah = cdb[7];
2991                 tf->device = cdb[8];
2992                 tf->command = cdb[9];
2993         }
2994
2995         /* enforce correct master/slave bit */
2996         tf->device = dev->devno ?
2997                 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2998
2999         switch (tf->command) {
3000         /* READ/WRITE LONG use a non-standard sect_size */
3001         case ATA_CMD_READ_LONG:
3002         case ATA_CMD_READ_LONG_ONCE:
3003         case ATA_CMD_WRITE_LONG:
3004         case ATA_CMD_WRITE_LONG_ONCE:
3005                 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
3006                         goto invalid_fld;
3007                 qc->sect_size = scsi_bufflen(scmd);
3008                 break;
3009
3010         /* commands using reported Logical Block size (e.g. 512 or 4K) */
3011         case ATA_CMD_CFA_WRITE_NE:
3012         case ATA_CMD_CFA_TRANS_SECT:
3013         case ATA_CMD_CFA_WRITE_MULT_NE:
3014         /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3015         case ATA_CMD_READ:
3016         case ATA_CMD_READ_EXT:
3017         case ATA_CMD_READ_QUEUED:
3018         /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3019         case ATA_CMD_FPDMA_READ:
3020         case ATA_CMD_READ_MULTI:
3021         case ATA_CMD_READ_MULTI_EXT:
3022         case ATA_CMD_PIO_READ:
3023         case ATA_CMD_PIO_READ_EXT:
3024         case ATA_CMD_READ_STREAM_DMA_EXT:
3025         case ATA_CMD_READ_STREAM_EXT:
3026         case ATA_CMD_VERIFY:
3027         case ATA_CMD_VERIFY_EXT:
3028         case ATA_CMD_WRITE:
3029         case ATA_CMD_WRITE_EXT:
3030         case ATA_CMD_WRITE_FUA_EXT:
3031         case ATA_CMD_WRITE_QUEUED:
3032         case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3033         case ATA_CMD_FPDMA_WRITE:
3034         case ATA_CMD_WRITE_MULTI:
3035         case ATA_CMD_WRITE_MULTI_EXT:
3036         case ATA_CMD_WRITE_MULTI_FUA_EXT:
3037         case ATA_CMD_PIO_WRITE:
3038         case ATA_CMD_PIO_WRITE_EXT:
3039         case ATA_CMD_WRITE_STREAM_DMA_EXT:
3040         case ATA_CMD_WRITE_STREAM_EXT:
3041                 qc->sect_size = scmd->device->sector_size;
3042                 break;
3043
3044         /* Everything else uses 512 byte "sectors" */
3045         default:
3046                 qc->sect_size = ATA_SECT_SIZE;
3047         }
3048
3049         /*
3050          * Set flags so that all registers will be written, pass on
3051          * write indication (used for PIO/DMA setup), result TF is
3052          * copied back and we don't whine too much about its failure.
3053          */
3054         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3055         if (scmd->sc_data_direction == DMA_TO_DEVICE)
3056                 tf->flags |= ATA_TFLAG_WRITE;
3057
3058         qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3059
3060         /*
3061          * Set transfer length.
3062          *
3063          * TODO: find out if we need to do more here to
3064          *       cover scatter/gather case.
3065          */
3066         ata_qc_set_pc_nbytes(qc);
3067
3068         /* We may not issue DMA commands if no DMA mode is set */
3069         if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
3070                 goto invalid_fld;
3071
3072         /* sanity check for pio multi commands */
3073         if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
3074                 goto invalid_fld;
3075
3076         if (is_multi_taskfile(tf)) {
3077                 unsigned int multi_count = 1 << (cdb[1] >> 5);
3078
3079                 /* compare the passed through multi_count
3080                  * with the cached multi_count of libata
3081                  */
3082                 if (multi_count != dev->multi_count)
3083                         ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3084                                      multi_count);
3085         }
3086
3087         /*
3088          * Filter SET_FEATURES - XFER MODE command -- otherwise,
3089          * SET_FEATURES - XFER MODE must be preceded/succeeded
3090          * by an update to hardware-specific registers for each
3091          * controller (i.e. the reason for ->set_piomode(),
3092          * ->set_dmamode(), and ->post_set_mode() hooks).
3093          */
3094         if (tf->command == ATA_CMD_SET_FEATURES &&
3095             tf->feature == SETFEATURES_XFER)
3096                 goto invalid_fld;
3097
3098         /*
3099          * Filter TPM commands by default. These provide an
3100          * essentially uncontrolled encrypted "back door" between
3101          * applications and the disk. Set libata.allow_tpm=1 if you
3102          * have a real reason for wanting to use them. This ensures
3103          * that installed software cannot easily mess stuff up without
3104          * user intent. DVR type users will probably ship with this enabled
3105          * for movie content management.
3106          *
3107          * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3108          * for this and should do in future but that it is not sufficient as
3109          * DCS is an optional feature set. Thus we also do the software filter
3110          * so that we comply with the TC consortium stated goal that the user
3111          * can turn off TC features of their system.
3112          */
3113         if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
3114                 goto invalid_fld;
3115
3116         return 0;
3117
3118  invalid_fld:
3119         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3120         /* "Invalid field in cdb" */
3121         return 1;
3122 }
3123
3124 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3125 {
3126         struct ata_taskfile *tf = &qc->tf;
3127         struct scsi_cmnd *scmd = qc->scsicmd;
3128         struct ata_device *dev = qc->dev;
3129         const u8 *cdb = scmd->cmnd;
3130         u64 block;
3131         u32 n_block;
3132         u32 size;
3133         void *buf;
3134
3135         /* we may not issue DMA commands if no DMA mode is set */
3136         if (unlikely(!dev->dma_mode))
3137                 goto invalid_fld;
3138
3139         if (unlikely(scmd->cmd_len < 16))
3140                 goto invalid_fld;
3141         scsi_16_lba_len(cdb, &block, &n_block);
3142
3143         /* for now we only support WRITE SAME with the unmap bit set */
3144         if (unlikely(!(cdb[1] & 0x8)))
3145                 goto invalid_fld;
3146
3147         /*
3148          * WRITE SAME always has a sector sized buffer as payload, this
3149          * should never be a multiple entry S/G list.
3150          */
3151         if (!scsi_sg_count(scmd))
3152                 goto invalid_fld;
3153
3154         buf = page_address(sg_page(scsi_sglist(scmd)));
3155         size = ata_set_lba_range_entries(buf, 512, block, n_block);
3156
3157         if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3158                 /* Newer devices support queued TRIM commands */
3159                 tf->protocol = ATA_PROT_NCQ;
3160                 tf->command = ATA_CMD_FPDMA_SEND;
3161                 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3162                 tf->nsect = qc->tag << 3;
3163                 tf->hob_feature = (size / 512) >> 8;
3164                 tf->feature = size / 512;
3165
3166                 tf->auxiliary = 1;
3167         } else {
3168                 tf->protocol = ATA_PROT_DMA;
3169                 tf->hob_feature = 0;
3170                 tf->feature = ATA_DSM_TRIM;
3171                 tf->hob_nsect = (size / 512) >> 8;
3172                 tf->nsect = size / 512;
3173                 tf->command = ATA_CMD_DSM;
3174         }
3175
3176         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3177                      ATA_TFLAG_WRITE;
3178
3179         ata_qc_set_pc_nbytes(qc);
3180
3181         return 0;
3182
3183  invalid_fld:
3184         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3185         /* "Invalid field in cdb" */
3186         return 1;
3187 }
3188
3189 /**
3190  *      ata_mselect_caching - Simulate MODE SELECT for caching info page
3191  *      @qc: Storage for translated ATA taskfile
3192  *      @buf: input buffer
3193  *      @len: number of valid bytes in the input buffer
3194  *
3195  *      Prepare a taskfile to modify caching information for the device.
3196  *
3197  *      LOCKING:
3198  *      None.
3199  */
3200 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3201                                const u8 *buf, int len)
3202 {
3203         struct ata_taskfile *tf = &qc->tf;
3204         struct ata_device *dev = qc->dev;
3205         char mpage[CACHE_MPAGE_LEN];
3206         u8 wce;
3207
3208         /*
3209          * The first two bytes of def_cache_mpage are a header, so offsets
3210          * in mpage are off by 2 compared to buf.  Same for len.
3211          */
3212
3213         if (len != CACHE_MPAGE_LEN - 2)
3214                 return -EINVAL;
3215
3216         wce = buf[0] & (1 << 2);
3217
3218         /*
3219          * Check that read-only bits are not modified.
3220          */
3221         ata_msense_caching(dev->id, mpage, false);
3222         mpage[2] &= ~(1 << 2);
3223         mpage[2] |= wce;
3224         if (memcmp(mpage + 2, buf, CACHE_MPAGE_LEN - 2) != 0)
3225                 return -EINVAL;
3226
3227         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3228         tf->protocol = ATA_PROT_NODATA;
3229         tf->nsect = 0;
3230         tf->command = ATA_CMD_SET_FEATURES;
3231         tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3232         return 0;
3233 }
3234
3235 /**
3236  *      ata_scsiop_mode_select - Simulate MODE SELECT 6, 10 commands
3237  *      @qc: Storage for translated ATA taskfile
3238  *
3239  *      Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3240  *      Assume this is invoked for direct access devices (e.g. disks) only.
3241  *      There should be no block descriptor for other device types.
3242  *
3243  *      LOCKING:
3244  *      spin_lock_irqsave(host lock)
3245  */
3246 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3247 {
3248         struct scsi_cmnd *scmd = qc->scsicmd;
3249         const u8 *cdb = scmd->cmnd;
3250         const u8 *p;
3251         u8 pg, spg;
3252         unsigned six_byte, pg_len, hdr_len, bd_len;
3253         int len;
3254
3255         VPRINTK("ENTER\n");
3256
3257         six_byte = (cdb[0] == MODE_SELECT);
3258         if (six_byte) {
3259                 if (scmd->cmd_len < 5)
3260                         goto invalid_fld;
3261
3262                 len = cdb[4];
3263                 hdr_len = 4;
3264         } else {
3265                 if (scmd->cmd_len < 9)
3266                         goto invalid_fld;
3267
3268                 len = (cdb[7] << 8) + cdb[8];
3269                 hdr_len = 8;
3270         }
3271
3272         /* We only support PF=1, SP=0.  */
3273         if ((cdb[1] & 0x11) != 0x10)
3274                 goto invalid_fld;
3275
3276         /* Test early for possible overrun.  */
3277         if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3278                 goto invalid_param_len;
3279
3280         p = page_address(sg_page(scsi_sglist(scmd)));
3281
3282         /* Move past header and block descriptors.  */
3283         if (len < hdr_len)
3284                 goto invalid_param_len;
3285
3286         if (six_byte)
3287                 bd_len = p[3];
3288         else
3289                 bd_len = (p[6] << 8) + p[7];
3290
3291         len -= hdr_len;
3292         p += hdr_len;
3293         if (len < bd_len)
3294                 goto invalid_param_len;
3295         if (bd_len != 0 && bd_len != 8)
3296                 goto invalid_param;
3297
3298         len -= bd_len;
3299         p += bd_len;
3300         if (len == 0)
3301                 goto skip;
3302
3303         /* Parse both possible formats for the mode page headers.  */
3304         pg = p[0] & 0x3f;
3305         if (p[0] & 0x40) {
3306                 if (len < 4)
3307                         goto invalid_param_len;
3308
3309                 spg = p[1];
3310                 pg_len = (p[2] << 8) | p[3];
3311                 p += 4;
3312                 len -= 4;
3313         } else {
3314                 if (len < 2)
3315                         goto invalid_param_len;
3316
3317                 spg = 0;
3318                 pg_len = p[1];
3319                 p += 2;
3320                 len -= 2;
3321         }
3322
3323         /*
3324          * No mode subpages supported (yet) but asking for _all_
3325          * subpages may be valid
3326          */
3327         if (spg && (spg != ALL_SUB_MPAGES))
3328                 goto invalid_param;
3329         if (pg_len > len)
3330                 goto invalid_param_len;
3331
3332         switch (pg) {
3333         case CACHE_MPAGE:
3334                 if (ata_mselect_caching(qc, p, pg_len) < 0)
3335                         goto invalid_param;
3336                 break;
3337
3338         default:                /* invalid page code */
3339                 goto invalid_param;
3340         }
3341
3342         /*
3343          * Only one page has changeable data, so we only support setting one
3344          * page at a time.
3345          */
3346         if (len > pg_len)
3347                 goto invalid_param;
3348
3349         return 0;
3350
3351  invalid_fld:
3352         /* "Invalid field in CDB" */
3353         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
3354         return 1;
3355
3356  invalid_param:
3357         /* "Invalid field in parameter list" */
3358         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x26, 0x0);
3359         return 1;
3360
3361  invalid_param_len:
3362         /* "Parameter list length error" */
3363         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3364         return 1;
3365
3366  skip:
3367         scmd->result = SAM_STAT_GOOD;
3368         return 1;
3369 }
3370
3371 /**
3372  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
3373  *      @dev: ATA device
3374  *      @cmd: SCSI command opcode to consider
3375  *
3376  *      Look up the SCSI command given, and determine whether the
3377  *      SCSI command is to be translated or simulated.
3378  *
3379  *      RETURNS:
3380  *      Pointer to translation function if possible, %NULL if not.
3381  */
3382
3383 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3384 {
3385         switch (cmd) {
3386         case READ_6:
3387         case READ_10:
3388         case READ_16:
3389
3390         case WRITE_6:
3391         case WRITE_10:
3392         case WRITE_16:
3393                 return ata_scsi_rw_xlat;
3394
3395         case WRITE_SAME_16:
3396                 return ata_scsi_write_same_xlat;
3397
3398         case SYNCHRONIZE_CACHE:
3399                 if (ata_try_flush_cache(dev))
3400                         return ata_scsi_flush_xlat;
3401                 break;
3402
3403         case VERIFY:
3404         case VERIFY_16:
3405                 return ata_scsi_verify_xlat;
3406
3407         case ATA_12:
3408         case ATA_16:
3409                 return ata_scsi_pass_thru;
3410
3411         case MODE_SELECT:
3412         case MODE_SELECT_10:
3413                 return ata_scsi_mode_select_xlat;
3414                 break;
3415
3416         case START_STOP:
3417                 return ata_scsi_start_stop_xlat;
3418         }
3419
3420         return NULL;
3421 }
3422
3423 /**
3424  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3425  *      @ap: ATA port to which the command was being sent
3426  *      @cmd: SCSI command to dump
3427  *
3428  *      Prints the contents of a SCSI command via printk().
3429  */
3430
3431 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3432                                      struct scsi_cmnd *cmd)
3433 {
3434 #ifdef ATA_DEBUG
3435         struct scsi_device *scsidev = cmd->device;
3436         u8 *scsicmd = cmd->cmnd;
3437
3438         DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3439                 ap->print_id,
3440                 scsidev->channel, scsidev->id, scsidev->lun,
3441                 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3442                 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3443                 scsicmd[8]);
3444 #endif
3445 }
3446
3447 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3448                                       struct ata_device *dev)
3449 {
3450         u8 scsi_op = scmd->cmnd[0];
3451         ata_xlat_func_t xlat_func;
3452         int rc = 0;
3453
3454         if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
3455                 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3456                         goto bad_cdb_len;
3457
3458                 xlat_func = ata_get_xlat_func(dev, scsi_op);
3459         } else {
3460                 if (unlikely(!scmd->cmd_len))
3461                         goto bad_cdb_len;
3462
3463                 xlat_func = NULL;
3464                 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3465                         /* relay SCSI command to ATAPI device */
3466                         int len = COMMAND_SIZE(scsi_op);
3467                         if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3468                                 goto bad_cdb_len;
3469
3470                         xlat_func = atapi_xlat;
3471                 } else {
3472                         /* ATA_16 passthru, treat as an ATA command */
3473                         if (unlikely(scmd->cmd_len > 16))
3474                                 goto bad_cdb_len;
3475
3476                         xlat_func = ata_get_xlat_func(dev, scsi_op);
3477                 }
3478         }
3479
3480         if (xlat_func)
3481                 rc = ata_scsi_translate(dev, scmd, xlat_func);
3482         else
3483                 ata_scsi_simulate(dev, scmd);
3484
3485         return rc;
3486
3487  bad_cdb_len:
3488         DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3489                 scmd->cmd_len, scsi_op, dev->cdb_len);
3490         scmd->result = DID_ERROR << 16;
3491         scmd->scsi_done(scmd);
3492         return 0;
3493 }
3494
3495 /**
3496  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3497  *      @shost: SCSI host of command to be sent
3498  *      @cmd: SCSI command to be sent
3499  *
3500  *      In some cases, this function translates SCSI commands into
3501  *      ATA taskfiles, and queues the taskfiles to be sent to
3502  *      hardware.  In other cases, this function simulates a
3503  *      SCSI device by evaluating and responding to certain
3504  *      SCSI commands.  This creates the overall effect of
3505  *      ATA and ATAPI devices appearing as SCSI devices.
3506  *
3507  *      LOCKING:
3508  *      ATA host lock
3509  *
3510  *      RETURNS:
3511  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3512  *      0 otherwise.
3513  */
3514 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
3515 {
3516         struct ata_port *ap;
3517         struct ata_device *dev;
3518         struct scsi_device *scsidev = cmd->device;
3519         int rc = 0;
3520         unsigned long irq_flags;
3521
3522         ap = ata_shost_to_port(shost);
3523
3524         spin_lock_irqsave(ap->lock, irq_flags);
3525
3526         ata_scsi_dump_cdb(ap, cmd);
3527
3528         dev = ata_scsi_find_dev(ap, scsidev);
3529         if (likely(dev))
3530                 rc = __ata_scsi_queuecmd(cmd, dev);
3531         else {
3532                 cmd->result = (DID_BAD_TARGET << 16);
3533                 cmd->scsi_done(cmd);
3534         }
3535
3536         spin_unlock_irqrestore(ap->lock, irq_flags);
3537
3538         return rc;
3539 }
3540
3541 /**
3542  *      ata_scsi_simulate - simulate SCSI command on ATA device
3543  *      @dev: the target device
3544  *      @cmd: SCSI command being sent to device.
3545  *
3546  *      Interprets and directly executes a select list of SCSI commands
3547  *      that can be handled internally.
3548  *
3549  *      LOCKING:
3550  *      spin_lock_irqsave(host lock)
3551  */
3552
3553 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
3554 {
3555         struct ata_scsi_args args;
3556         const u8 *scsicmd = cmd->cmnd;
3557         u8 tmp8;
3558
3559         args.dev = dev;
3560         args.id = dev->id;
3561         args.cmd = cmd;
3562         args.done = cmd->scsi_done;
3563
3564         switch(scsicmd[0]) {
3565         /* TODO: worth improving? */
3566         case FORMAT_UNIT:
3567                 ata_scsi_invalid_field(cmd);
3568                 break;
3569
3570         case INQUIRY:
3571                 if (scsicmd[1] & 2)                /* is CmdDt set?  */
3572                         ata_scsi_invalid_field(cmd);
3573                 else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
3574                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3575                 else switch (scsicmd[2]) {
3576                 case 0x00:
3577                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3578                         break;
3579                 case 0x80:
3580                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3581                         break;
3582                 case 0x83:
3583                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3584                         break;
3585                 case 0x89:
3586                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3587                         break;
3588                 case 0xb0:
3589                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3590                         break;
3591                 case 0xb1:
3592                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3593                         break;
3594                 case 0xb2:
3595                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
3596                         break;
3597                 default:
3598                         ata_scsi_invalid_field(cmd);
3599                         break;
3600                 }
3601                 break;
3602
3603         case MODE_SENSE:
3604         case MODE_SENSE_10:
3605                 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3606                 break;
3607
3608         case READ_CAPACITY:
3609                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3610                 break;
3611
3612         case SERVICE_ACTION_IN_16:
3613                 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3614                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3615                 else
3616                         ata_scsi_invalid_field(cmd);
3617                 break;
3618
3619         case REPORT_LUNS:
3620                 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3621                 break;
3622
3623         case REQUEST_SENSE:
3624                 ata_scsi_set_sense(cmd, 0, 0, 0);
3625                 cmd->result = (DRIVER_SENSE << 24);
3626                 cmd->scsi_done(cmd);
3627                 break;
3628
3629         /* if we reach this, then writeback caching is disabled,
3630          * turning this into a no-op.
3631          */
3632         case SYNCHRONIZE_CACHE:
3633                 /* fall through */
3634
3635         /* no-op's, complete with success */
3636         case REZERO_UNIT:
3637         case SEEK_6:
3638         case SEEK_10:
3639         case TEST_UNIT_READY:
3640                 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3641                 break;
3642
3643         case SEND_DIAGNOSTIC:
3644                 tmp8 = scsicmd[1] & ~(1 << 3);
3645                 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3646                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3647                 else
3648                         ata_scsi_invalid_field(cmd);
3649                 break;
3650
3651         /* all other commands */
3652         default:
3653                 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3654                 /* "Invalid command operation code" */
3655                 cmd->scsi_done(cmd);
3656                 break;
3657         }
3658 }
3659
3660 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3661 {
3662         int i, rc;
3663
3664         for (i = 0; i < host->n_ports; i++) {
3665                 struct ata_port *ap = host->ports[i];
3666                 struct Scsi_Host *shost;
3667
3668                 rc = -ENOMEM;
3669                 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3670                 if (!shost)
3671                         goto err_alloc;
3672
3673                 shost->eh_noresume = 1;
3674                 *(struct ata_port **)&shost->hostdata[0] = ap;
3675                 ap->scsi_host = shost;
3676
3677                 shost->transportt = ata_scsi_transport_template;
3678                 shost->unique_id = ap->print_id;
3679                 shost->max_id = 16;
3680                 shost->max_lun = 1;
3681                 shost->max_channel = 1;
3682                 shost->max_cmd_len = 16;
3683                 shost->no_write_same = 1;
3684
3685                 /* Schedule policy is determined by ->qc_defer()
3686                  * callback and it needs to see every deferred qc.
3687                  * Set host_blocked to 1 to prevent SCSI midlayer from
3688                  * automatically deferring requests.
3689                  */
3690                 shost->max_host_blocked = 1;
3691
3692                 if (scsi_init_shared_tag_map(shost, host->n_tags))
3693                         goto err_add;
3694
3695                 rc = scsi_add_host_with_dma(ap->scsi_host,
3696                                                 &ap->tdev, ap->host->dev);
3697                 if (rc)
3698                         goto err_add;
3699         }
3700
3701         return 0;
3702
3703  err_add:
3704         scsi_host_put(host->ports[i]->scsi_host);
3705  err_alloc:
3706         while (--i >= 0) {
3707                 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3708
3709                 scsi_remove_host(shost);
3710                 scsi_host_put(shost);
3711         }
3712         return rc;
3713 }
3714
3715 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3716 {
3717         int tries = 5;
3718         struct ata_device *last_failed_dev = NULL;
3719         struct ata_link *link;
3720         struct ata_device *dev;
3721
3722  repeat:
3723         ata_for_each_link(link, ap, EDGE) {
3724                 ata_for_each_dev(dev, link, ENABLED) {
3725                         struct scsi_device *sdev;
3726                         int channel = 0, id = 0;
3727
3728                         if (dev->sdev)
3729                                 continue;
3730
3731                         if (ata_is_host_link(link))
3732                                 id = dev->devno;
3733                         else
3734                                 channel = link->pmp;
3735
3736                         sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3737                                                  NULL);
3738                         if (!IS_ERR(sdev)) {
3739                                 dev->sdev = sdev;
3740                                 scsi_device_put(sdev);
3741                         } else {
3742                                 dev->sdev = NULL;
3743                         }
3744                 }
3745         }
3746
3747         /* If we scanned while EH was in progress or allocation
3748          * failure occurred, scan would have failed silently.  Check
3749          * whether all devices are attached.
3750          */
3751         ata_for_each_link(link, ap, EDGE) {
3752                 ata_for_each_dev(dev, link, ENABLED) {
3753                         if (!dev->sdev)
3754                                 goto exit_loop;
3755                 }
3756         }
3757  exit_loop:
3758         if (!link)
3759                 return;
3760
3761         /* we're missing some SCSI devices */
3762         if (sync) {
3763                 /* If caller requested synchrnous scan && we've made
3764                  * any progress, sleep briefly and repeat.
3765                  */
3766                 if (dev != last_failed_dev) {
3767                         msleep(100);
3768                         last_failed_dev = dev;
3769                         goto repeat;
3770                 }
3771
3772                 /* We might be failing to detect boot device, give it
3773                  * a few more chances.
3774                  */
3775                 if (--tries) {
3776                         msleep(100);
3777                         goto repeat;
3778                 }
3779
3780                 ata_port_err(ap,
3781                              "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
3782         }
3783
3784         queue_delayed_work(system_long_wq, &ap->hotplug_task,
3785                            round_jiffies_relative(HZ));
3786 }
3787
3788 /**
3789  *      ata_scsi_offline_dev - offline attached SCSI device
3790  *      @dev: ATA device to offline attached SCSI device for
3791  *
3792  *      This function is called from ata_eh_hotplug() and responsible
3793  *      for taking the SCSI device attached to @dev offline.  This
3794  *      function is called with host lock which protects dev->sdev
3795  *      against clearing.
3796  *
3797  *      LOCKING:
3798  *      spin_lock_irqsave(host lock)
3799  *
3800  *      RETURNS:
3801  *      1 if attached SCSI device exists, 0 otherwise.
3802  */
3803 int ata_scsi_offline_dev(struct ata_device *dev)
3804 {
3805         if (dev->sdev) {
3806                 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3807                 return 1;
3808         }
3809         return 0;
3810 }
3811
3812 /**
3813  *      ata_scsi_remove_dev - remove attached SCSI device
3814  *      @dev: ATA device to remove attached SCSI device for
3815  *
3816  *      This function is called from ata_eh_scsi_hotplug() and
3817  *      responsible for removing the SCSI device attached to @dev.
3818  *
3819  *      LOCKING:
3820  *      Kernel thread context (may sleep).
3821  */
3822 static void ata_scsi_remove_dev(struct ata_device *dev)
3823 {
3824         struct ata_port *ap = dev->link->ap;
3825         struct scsi_device *sdev;
3826         unsigned long flags;
3827
3828         /* Alas, we need to grab scan_mutex to ensure SCSI device
3829          * state doesn't change underneath us and thus
3830          * scsi_device_get() always succeeds.  The mutex locking can
3831          * be removed if there is __scsi_device_get() interface which
3832          * increments reference counts regardless of device state.
3833          */
3834         mutex_lock(&ap->scsi_host->scan_mutex);
3835         spin_lock_irqsave(ap->lock, flags);
3836
3837         /* clearing dev->sdev is protected by host lock */
3838         sdev = dev->sdev;
3839         dev->sdev = NULL;
3840
3841         if (sdev) {
3842                 /* If user initiated unplug races with us, sdev can go
3843                  * away underneath us after the host lock and
3844                  * scan_mutex are released.  Hold onto it.
3845                  */
3846                 if (scsi_device_get(sdev) == 0) {
3847                         /* The following ensures the attached sdev is
3848                          * offline on return from ata_scsi_offline_dev()
3849                          * regardless it wins or loses the race
3850                          * against this function.
3851                          */
3852                         scsi_device_set_state(sdev, SDEV_OFFLINE);
3853                 } else {
3854                         WARN_ON(1);
3855                         sdev = NULL;
3856                 }
3857         }
3858
3859         spin_unlock_irqrestore(ap->lock, flags);
3860         mutex_unlock(&ap->scsi_host->scan_mutex);
3861
3862         if (sdev) {
3863                 ata_dev_info(dev, "detaching (SCSI %s)\n",
3864                              dev_name(&sdev->sdev_gendev));
3865
3866                 scsi_remove_device(sdev);
3867                 scsi_device_put(sdev);
3868         }
3869 }
3870
3871 static void ata_scsi_handle_link_detach(struct ata_link *link)
3872 {
3873         struct ata_port *ap = link->ap;
3874         struct ata_device *dev;
3875
3876         ata_for_each_dev(dev, link, ALL) {
3877                 unsigned long flags;
3878
3879                 if (!(dev->flags & ATA_DFLAG_DETACHED))
3880                         continue;
3881
3882                 spin_lock_irqsave(ap->lock, flags);
3883                 dev->flags &= ~ATA_DFLAG_DETACHED;
3884                 spin_unlock_irqrestore(ap->lock, flags);
3885
3886                 if (zpodd_dev_enabled(dev))
3887                         zpodd_exit(dev);
3888
3889                 ata_scsi_remove_dev(dev);
3890         }
3891 }
3892
3893 /**
3894  *      ata_scsi_media_change_notify - send media change event
3895  *      @dev: Pointer to the disk device with media change event
3896  *
3897  *      Tell the block layer to send a media change notification
3898  *      event.
3899  *
3900  *      LOCKING:
3901  *      spin_lock_irqsave(host lock)
3902  */
3903 void ata_scsi_media_change_notify(struct ata_device *dev)
3904 {
3905         if (dev->sdev)
3906                 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3907                                      GFP_ATOMIC);
3908 }
3909
3910 /**
3911  *      ata_scsi_hotplug - SCSI part of hotplug
3912  *      @work: Pointer to ATA port to perform SCSI hotplug on
3913  *
3914  *      Perform SCSI part of hotplug.  It's executed from a separate
3915  *      workqueue after EH completes.  This is necessary because SCSI
3916  *      hot plugging requires working EH and hot unplugging is
3917  *      synchronized with hot plugging with a mutex.
3918  *
3919  *      LOCKING:
3920  *      Kernel thread context (may sleep).
3921  */
3922 void ata_scsi_hotplug(struct work_struct *work)
3923 {
3924         struct ata_port *ap =
3925                 container_of(work, struct ata_port, hotplug_task.work);
3926         int i;
3927
3928         if (ap->pflags & ATA_PFLAG_UNLOADING) {
3929                 DPRINTK("ENTER/EXIT - unloading\n");
3930                 return;
3931         }
3932
3933         /*
3934          * XXX - UGLY HACK
3935          *
3936          * The block layer suspend/resume path is fundamentally broken due
3937          * to freezable kthreads and workqueue and may deadlock if a block
3938          * device gets removed while resume is in progress.  I don't know
3939          * what the solution is short of removing freezable kthreads and
3940          * workqueues altogether.
3941          *
3942          * The following is an ugly hack to avoid kicking off device
3943          * removal while freezer is active.  This is a joke but does avoid
3944          * this particular deadlock scenario.
3945          *
3946          * https://bugzilla.kernel.org/show_bug.cgi?id=62801
3947          * http://marc.info/?l=linux-kernel&m=138695698516487
3948          */
3949 #ifdef CONFIG_FREEZER
3950         while (pm_freezing)
3951                 msleep(10);
3952 #endif
3953
3954         DPRINTK("ENTER\n");
3955         mutex_lock(&ap->scsi_scan_mutex);
3956
3957         /* Unplug detached devices.  We cannot use link iterator here
3958          * because PMP links have to be scanned even if PMP is
3959          * currently not attached.  Iterate manually.
3960          */
3961         ata_scsi_handle_link_detach(&ap->link);
3962         if (ap->pmp_link)
3963                 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3964                         ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3965
3966         /* scan for new ones */
3967         ata_scsi_scan_host(ap, 0);
3968
3969         mutex_unlock(&ap->scsi_scan_mutex);
3970         DPRINTK("EXIT\n");
3971 }
3972
3973 /**
3974  *      ata_scsi_user_scan - indication for user-initiated bus scan
3975  *      @shost: SCSI host to scan
3976  *      @channel: Channel to scan
3977  *      @id: ID to scan
3978  *      @lun: LUN to scan
3979  *
3980  *      This function is called when user explicitly requests bus
3981  *      scan.  Set probe pending flag and invoke EH.
3982  *
3983  *      LOCKING:
3984  *      SCSI layer (we don't care)
3985  *
3986  *      RETURNS:
3987  *      Zero.
3988  */
3989 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3990                        unsigned int id, u64 lun)
3991 {
3992         struct ata_port *ap = ata_shost_to_port(shost);
3993         unsigned long flags;
3994         int devno, rc = 0;
3995
3996         if (!ap->ops->error_handler)
3997                 return -EOPNOTSUPP;
3998
3999         if (lun != SCAN_WILD_CARD && lun)
4000                 return -EINVAL;
4001
4002         if (!sata_pmp_attached(ap)) {
4003                 if (channel != SCAN_WILD_CARD && channel)
4004                         return -EINVAL;
4005                 devno = id;
4006         } else {
4007                 if (id != SCAN_WILD_CARD && id)
4008                         return -EINVAL;
4009                 devno = channel;
4010         }
4011
4012         spin_lock_irqsave(ap->lock, flags);
4013
4014         if (devno == SCAN_WILD_CARD) {
4015                 struct ata_link *link;
4016
4017                 ata_for_each_link(link, ap, EDGE) {
4018                         struct ata_eh_info *ehi = &link->eh_info;
4019                         ehi->probe_mask |= ATA_ALL_DEVICES;
4020                         ehi->action |= ATA_EH_RESET;
4021                 }
4022         } else {
4023                 struct ata_device *dev = ata_find_dev(ap, devno);
4024
4025                 if (dev) {
4026                         struct ata_eh_info *ehi = &dev->link->eh_info;
4027                         ehi->probe_mask |= 1 << dev->devno;
4028                         ehi->action |= ATA_EH_RESET;
4029                 } else
4030                         rc = -EINVAL;
4031         }
4032
4033         if (rc == 0) {
4034                 ata_port_schedule_eh(ap);
4035                 spin_unlock_irqrestore(ap->lock, flags);
4036                 ata_port_wait_eh(ap);
4037         } else
4038                 spin_unlock_irqrestore(ap->lock, flags);
4039
4040         return rc;
4041 }
4042
4043 /**
4044  *      ata_scsi_dev_rescan - initiate scsi_rescan_device()
4045  *      @work: Pointer to ATA port to perform scsi_rescan_device()
4046  *
4047  *      After ATA pass thru (SAT) commands are executed successfully,
4048  *      libata need to propagate the changes to SCSI layer.
4049  *
4050  *      LOCKING:
4051  *      Kernel thread context (may sleep).
4052  */
4053 void ata_scsi_dev_rescan(struct work_struct *work)
4054 {
4055         struct ata_port *ap =
4056                 container_of(work, struct ata_port, scsi_rescan_task);
4057         struct ata_link *link;
4058         struct ata_device *dev;
4059         unsigned long flags;
4060
4061         mutex_lock(&ap->scsi_scan_mutex);
4062         spin_lock_irqsave(ap->lock, flags);
4063
4064         ata_for_each_link(link, ap, EDGE) {
4065                 ata_for_each_dev(dev, link, ENABLED) {
4066                         struct scsi_device *sdev = dev->sdev;
4067
4068                         if (!sdev)
4069                                 continue;
4070                         if (scsi_device_get(sdev))
4071                                 continue;
4072
4073                         spin_unlock_irqrestore(ap->lock, flags);
4074                         scsi_rescan_device(&(sdev->sdev_gendev));
4075                         scsi_device_put(sdev);
4076                         spin_lock_irqsave(ap->lock, flags);
4077                 }
4078         }
4079
4080         spin_unlock_irqrestore(ap->lock, flags);
4081         mutex_unlock(&ap->scsi_scan_mutex);
4082 }
4083
4084 /**
4085  *      ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4086  *      @host: ATA host container for all SAS ports
4087  *      @port_info: Information from low-level host driver
4088  *      @shost: SCSI host that the scsi device is attached to
4089  *
4090  *      LOCKING:
4091  *      PCI/etc. bus probe sem.
4092  *
4093  *      RETURNS:
4094  *      ata_port pointer on success / NULL on failure.
4095  */
4096
4097 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
4098                                     struct ata_port_info *port_info,
4099                                     struct Scsi_Host *shost)
4100 {
4101         struct ata_port *ap;
4102
4103         ap = ata_port_alloc(host);
4104         if (!ap)
4105                 return NULL;
4106
4107         ap->port_no = 0;
4108         ap->lock = &host->lock;
4109         ap->pio_mask = port_info->pio_mask;
4110         ap->mwdma_mask = port_info->mwdma_mask;
4111         ap->udma_mask = port_info->udma_mask;
4112         ap->flags |= port_info->flags;
4113         ap->ops = port_info->port_ops;
4114         ap->cbl = ATA_CBL_SATA;
4115
4116         return ap;
4117 }
4118 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4119
4120 /**
4121  *      ata_sas_port_start - Set port up for dma.
4122  *      @ap: Port to initialize
4123  *
4124  *      Called just after data structures for each port are
4125  *      initialized.
4126  *
4127  *      May be used as the port_start() entry in ata_port_operations.
4128  *
4129  *      LOCKING:
4130  *      Inherited from caller.
4131  */
4132 int ata_sas_port_start(struct ata_port *ap)
4133 {
4134         /*
4135          * the port is marked as frozen at allocation time, but if we don't
4136          * have new eh, we won't thaw it
4137          */
4138         if (!ap->ops->error_handler)
4139                 ap->pflags &= ~ATA_PFLAG_FROZEN;
4140         return 0;
4141 }
4142 EXPORT_SYMBOL_GPL(ata_sas_port_start);
4143
4144 /**
4145  *      ata_port_stop - Undo ata_sas_port_start()
4146  *      @ap: Port to shut down
4147  *
4148  *      May be used as the port_stop() entry in ata_port_operations.
4149  *
4150  *      LOCKING:
4151  *      Inherited from caller.
4152  */
4153
4154 void ata_sas_port_stop(struct ata_port *ap)
4155 {
4156 }
4157 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
4158
4159 /**
4160  * ata_sas_async_probe - simply schedule probing and return
4161  * @ap: Port to probe
4162  *
4163  * For batch scheduling of probe for sas attached ata devices, assumes
4164  * the port has already been through ata_sas_port_init()
4165  */
4166 void ata_sas_async_probe(struct ata_port *ap)
4167 {
4168         __ata_port_probe(ap);
4169 }
4170 EXPORT_SYMBOL_GPL(ata_sas_async_probe);
4171
4172 int ata_sas_sync_probe(struct ata_port *ap)
4173 {
4174         return ata_port_probe(ap);
4175 }
4176 EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
4177
4178
4179 /**
4180  *      ata_sas_port_init - Initialize a SATA device
4181  *      @ap: SATA port to initialize
4182  *
4183  *      LOCKING:
4184  *      PCI/etc. bus probe sem.
4185  *
4186  *      RETURNS:
4187  *      Zero on success, non-zero on error.
4188  */
4189
4190 int ata_sas_port_init(struct ata_port *ap)
4191 {
4192         int rc = ap->ops->port_start(ap);
4193
4194         if (rc)
4195                 return rc;
4196         ap->print_id = atomic_inc_return(&ata_print_id);
4197         return 0;
4198 }
4199 EXPORT_SYMBOL_GPL(ata_sas_port_init);
4200
4201 /**
4202  *      ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
4203  *      @ap: SATA port to destroy
4204  *
4205  */
4206
4207 void ata_sas_port_destroy(struct ata_port *ap)
4208 {
4209         if (ap->ops->port_stop)
4210                 ap->ops->port_stop(ap);
4211         kfree(ap);
4212 }
4213 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
4214
4215 /**
4216  *      ata_sas_slave_configure - Default slave_config routine for libata devices
4217  *      @sdev: SCSI device to configure
4218  *      @ap: ATA port to which SCSI device is attached
4219  *
4220  *      RETURNS:
4221  *      Zero.
4222  */
4223
4224 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
4225 {
4226         ata_scsi_sdev_config(sdev);
4227         ata_scsi_dev_config(sdev, ap->link.device);
4228         return 0;
4229 }
4230 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
4231
4232 /**
4233  *      ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
4234  *      @cmd: SCSI command to be sent
4235  *      @ap:    ATA port to which the command is being sent
4236  *
4237  *      RETURNS:
4238  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4239  *      0 otherwise.
4240  */
4241
4242 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
4243 {
4244         int rc = 0;
4245
4246         ata_scsi_dump_cdb(ap, cmd);
4247
4248         if (likely(ata_dev_enabled(ap->link.device)))
4249                 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
4250         else {
4251                 cmd->result = (DID_BAD_TARGET << 16);
4252                 cmd->scsi_done(cmd);
4253         }
4254         return rc;
4255 }
4256 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
4257
4258 int ata_sas_allocate_tag(struct ata_port *ap)
4259 {
4260         unsigned int max_queue = ap->host->n_tags;
4261         unsigned int i, tag;
4262
4263         for (i = 0, tag = ap->sas_last_tag + 1; i < max_queue; i++, tag++) {
4264                 tag = tag < max_queue ? tag : 0;
4265
4266                 /* the last tag is reserved for internal command. */
4267                 if (tag == ATA_TAG_INTERNAL)
4268                         continue;
4269
4270                 if (!test_and_set_bit(tag, &ap->sas_tag_allocated)) {
4271                         ap->sas_last_tag = tag;
4272                         return tag;
4273                 }
4274         }
4275         return -1;
4276 }
4277
4278 void ata_sas_free_tag(unsigned int tag, struct ata_port *ap)
4279 {
4280         clear_bit(tag, &ap->sas_tag_allocated);
4281 }