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