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 scsi_cmd[MAX_COMMAND_SIZE];
 601         u8 args[4], *argbuf = NULL, *sensebuf = NULL;
 602         int argsize = 0;
 603         enum dma_data_direction data_dir;
 604         struct scsi_sense_hdr sshdr;
 605         int cmd_result;
 606
 607         if (arg == NULL)
 608                 return -EINVAL;
 609
 610         if (copy_from_user(args, arg, sizeof(args)))
 611                 return -EFAULT;
 612
 613         sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
 614         if (!sensebuf)
 615                 return -ENOMEM;
 616
 617         memset(scsi_cmd, 0, sizeof(scsi_cmd));
 618
 619         if (args[3]) {
 620                 argsize = ATA_SECT_SIZE * args[3];
 621                 argbuf = kmalloc(argsize, GFP_KERNEL);
 622                 if (argbuf == NULL) {
 623                         rc = -ENOMEM;
 624                         goto error;
 625                 }
 626
 627                 scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
 628                 scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
 629                                             block count in sector count field */
 630                 data_dir = DMA_FROM_DEVICE;
 631         } else {
 632                 scsi_cmd[1]  = (3 << 1); /* Non-data */
 633                 scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
 634                 data_dir = DMA_NONE;
 635         }
 636
 637         scsi_cmd[0] = ATA_16;
 638
 639         scsi_cmd[4] = args[2];
 640         if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
 641                 scsi_cmd[6]  = args[3];
 642                 scsi_cmd[8]  = args[1];
 643                 scsi_cmd[10] = 0x4f;
 644                 scsi_cmd[12] = 0xc2;
 645         } else {
 646                 scsi_cmd[6]  = args[1];
 647         }
 648         scsi_cmd[14] = args[0];
 649
 650         /* Good values for timeout and retries?  Values below
 651            from scsi_ioctl_send_command() for default case... */
 652         cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
 653                                   sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
 654
 655         if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
 656                 u8 *desc = sensebuf + 8;
 657                 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
 658
 659                 /* If we set cc then ATA pass-through will cause a
 660                  * check condition even if no error. Filter that. */
 661                 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
 662                         if (sshdr.sense_key == RECOVERED_ERROR &&
 663                             sshdr.asc == 0 && sshdr.ascq == 0x1d)
 664                                 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
 665                 }
 666
 667                 /* Send userspace a few ATA registers (same as drivers/ide) */
 668                 if (sensebuf[0] == 0x72 &&      /* format is "descriptor" */
 669                     desc[0] == 0x09) {          /* code is "ATA Descriptor" */
 670                         args[0] = desc[13];     /* status */
 671                         args[1] = desc[3];      /* error */
 672                         args[2] = desc[5];      /* sector count (0:7) */
 673                         if (copy_to_user(arg, args, sizeof(args)))
 674                                 rc = -EFAULT;
 675                 }
 676         }
 677
 678
 679         if (cmd_result) {
 680                 rc = -EIO;
 681                 goto error;
 682         }
 683
 684         if ((argbuf)
 685          && copy_to_user(arg + sizeof(args), argbuf, argsize))
 686                 rc = -EFAULT;
 687 error:
 688         kfree(sensebuf);
 689         kfree(argbuf);
 690         return rc;
 691 }
 692
 693 /**
 694  *      ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
 695  *      @scsidev: Device to which we are issuing command
 696  *      @arg: User provided data for issuing command
 697  *
 698  *      LOCKING:
 699  *      Defined by the SCSI layer.  We don't really care.
 700  *
 701  *      RETURNS:
 702  *      Zero on success, negative errno on error.
 703  */
 704 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
 705 {
 706         int rc = 0;
 707         u8 scsi_cmd[MAX_COMMAND_SIZE];
 708         u8 args[7], *sensebuf = NULL;
 709         struct scsi_sense_hdr sshdr;
 710         int cmd_result;
 711
 712         if (arg == NULL)
 713                 return -EINVAL;
 714
 715         if (copy_from_user(args, arg, sizeof(args)))
 716                 return -EFAULT;
 717
 718         sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
 719         if (!sensebuf)
 720                 return -ENOMEM;
 721
 722         memset(scsi_cmd, 0, sizeof(scsi_cmd));
 723         scsi_cmd[0]  = ATA_16;
 724         scsi_cmd[1]  = (3 << 1); /* Non-data */
 725         scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
 726         scsi_cmd[4]  = args[1];
 727         scsi_cmd[6]  = args[2];
 728         scsi_cmd[8]  = args[3];
 729         scsi_cmd[10] = args[4];
 730         scsi_cmd[12] = args[5];
 731         scsi_cmd[13] = args[6] & 0x4f;
 732         scsi_cmd[14] = args[0];
 733
 734         /* Good values for timeout and retries?  Values below
 735            from scsi_ioctl_send_command() for default case... */
 736         cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
 737                                 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
 738
 739         if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
 740                 u8 *desc = sensebuf + 8;
 741                 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
 742
 743                 /* If we set cc then ATA pass-through will cause a
 744                  * check condition even if no error. Filter that. */
 745                 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
 746                         if (sshdr.sense_key == RECOVERED_ERROR &&
 747                             sshdr.asc == 0 && sshdr.ascq == 0x1d)
 748                                 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
 749                 }
 750
 751                 /* Send userspace ATA registers */
 752                 if (sensebuf[0] == 0x72 &&      /* format is "descriptor" */
 753                                 desc[0] == 0x09) {/* code is "ATA Descriptor" */
 754                         args[0] = desc[13];     /* status */
 755                         args[1] = desc[3];      /* error */
 756                         args[2] = desc[5];      /* sector count (0:7) */
 757                         args[3] = desc[7];      /* lbal */
 758                         args[4] = desc[9];      /* lbam */
 759                         args[5] = desc[11];     /* lbah */
 760                         args[6] = desc[12];     /* select */
 761                         if (copy_to_user(arg, args, sizeof(args)))
 762                                 rc = -EFAULT;
 763                 }
 764         }
 765
 766         if (cmd_result) {
 767                 rc = -EIO;
 768                 goto error;
 769         }
 770
 771  error:
 772         kfree(sensebuf);
 773         return rc;
 774 }
 775
 776 static int ata_ioc32(struct ata_port *ap)
 777 {
 778         if (ap->flags & ATA_FLAG_PIO_DMA)
 779                 return 1;
 780         if (ap->pflags & ATA_PFLAG_PIO32)
 781                 return 1;
 782         return 0;
 783 }
 784
 785 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
 786                      int cmd, void __user *arg)
 787 {
 788         unsigned long val;
 789         int rc = -EINVAL;
 790         unsigned long flags;
 791
 792         switch (cmd) {
 793         case HDIO_GET_32BIT:
 794                 spin_lock_irqsave(ap->lock, flags);
 795                 val = ata_ioc32(ap);
 796                 spin_unlock_irqrestore(ap->lock, flags);
 797                 return put_user(val, (unsigned long __user *)arg);
 798
 799         case HDIO_SET_32BIT:
 800                 val = (unsigned long) arg;
 801                 rc = 0;
 802                 spin_lock_irqsave(ap->lock, flags);
 803                 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
 804                         if (val)
 805                                 ap->pflags |= ATA_PFLAG_PIO32;
 806                         else
 807                                 ap->pflags &= ~ATA_PFLAG_PIO32;
 808                 } else {
 809                         if (val != ata_ioc32(ap))
 810                                 rc = -EINVAL;
 811                 }
 812                 spin_unlock_irqrestore(ap->lock, flags);
 813                 return rc;
 814
 815         case HDIO_GET_IDENTITY:
 816                 return ata_get_identity(ap, scsidev, arg);
 817
 818         case HDIO_DRIVE_CMD:
 819                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 820                         return -EACCES;
 821                 return ata_cmd_ioctl(scsidev, arg);
 822
 823         case HDIO_DRIVE_TASK:
 824                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 825                         return -EACCES;
 826                 return ata_task_ioctl(scsidev, arg);
 827
 828         default:
 829                 rc = -ENOTTY;
 830                 break;
 831         }
 832
 833         return rc;
 834 }
 835 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
 836
 837 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
 838 {
 839         return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
 840                                 scsidev, cmd, arg);
 841 }
 842 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
 843
 844 /**
 845  *      ata_scsi_qc_new - acquire new ata_queued_cmd reference
 846  *      @dev: ATA device to which the new command is attached
 847  *      @cmd: SCSI command that originated this ATA command
 848  *
 849  *      Obtain a reference to an unused ata_queued_cmd structure,
 850  *      which is the basic libata structure representing a single
 851  *      ATA command sent to the hardware.
 852  *
 853  *      If a command was available, fill in the SCSI-specific
 854  *      portions of the structure with information on the
 855  *      current command.
 856  *
 857  *      LOCKING:
 858  *      spin_lock_irqsave(host lock)
 859  *
 860  *      RETURNS:
 861  *      Command allocated, or %NULL if none available.
 862  */
 863 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
 864                                               struct scsi_cmnd *cmd)
 865 {
 866         struct ata_queued_cmd *qc;
 867
 868         qc = ata_qc_new_init(dev, cmd->request->tag);
 869         if (qc) {
 870                 qc->scsicmd = cmd;
 871                 qc->scsidone = cmd->scsi_done;
 872
 873                 qc->sg = scsi_sglist(cmd);
 874                 qc->n_elem = scsi_sg_count(cmd);
 875
 876                 if (cmd->request->rq_flags & RQF_QUIET)
 877                         qc->flags |= ATA_QCFLAG_QUIET;
 878         } else {
 879                 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
 880                 cmd->scsi_done(cmd);
 881         }
 882
 883         return qc;
 884 }
 885
 886 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
 887 {
 888         struct scsi_cmnd *scmd = qc->scsicmd;
 889
 890         qc->extrabytes = scmd->request->extra_len;
 891         qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
 892 }
 893
 894 /**
 895  *      ata_dump_status - user friendly display of error info
 896  *      @id: id of the port in question
 897  *      @tf: ptr to filled out taskfile
 898  *
 899  *      Decode and dump the ATA error/status registers for the user so
 900  *      that they have some idea what really happened at the non
 901  *      make-believe layer.
 902  *
 903  *      LOCKING:
 904  *      inherited from caller
 905  */
 906 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
 907 {
 908         u8 stat = tf->command, err = tf->feature;
 909
 910         pr_warn("ata%u: status=0x%02x { ", id, stat);
 911         if (stat & ATA_BUSY) {
 912                 pr_cont("Busy }\n");    /* Data is not valid in this case */
 913         } else {
 914                 if (stat & ATA_DRDY)    pr_cont("DriveReady ");
 915                 if (stat & ATA_DF)      pr_cont("DeviceFault ");
 916                 if (stat & ATA_DSC)     pr_cont("SeekComplete ");
 917                 if (stat & ATA_DRQ)     pr_cont("DataRequest ");
 918                 if (stat & ATA_CORR)    pr_cont("CorrectedError ");
 919                 if (stat & ATA_SENSE)   pr_cont("Sense ");
 920                 if (stat & ATA_ERR)     pr_cont("Error ");
 921                 pr_cont("}\n");
 922
 923                 if (err) {
 924                         pr_warn("ata%u: error=0x%02x { ", id, err);
 925                         if (err & ATA_ABORTED)  pr_cont("DriveStatusError ");
 926                         if (err & ATA_ICRC) {
 927                                 if (err & ATA_ABORTED)
 928                                                 pr_cont("BadCRC ");
 929                                 else            pr_cont("Sector ");
 930                         }
 931                         if (err & ATA_UNC)      pr_cont("UncorrectableError ");
 932                         if (err & ATA_IDNF)     pr_cont("SectorIdNotFound ");
 933                         if (err & ATA_TRK0NF)   pr_cont("TrackZeroNotFound ");
 934                         if (err & ATA_AMNF)     pr_cont("AddrMarkNotFound ");
 935                         pr_cont("}\n");
 936                 }
 937         }
 938 }
 939
 940 /**
 941  *      ata_to_sense_error - convert ATA error to SCSI error
 942  *      @id: ATA device number
 943  *      @drv_stat: value contained in ATA status register
 944  *      @drv_err: value contained in ATA error register
 945  *      @sk: the sense key we'll fill out
 946  *      @asc: the additional sense code we'll fill out
 947  *      @ascq: the additional sense code qualifier we'll fill out
 948  *      @verbose: be verbose
 949  *
 950  *      Converts an ATA error into a SCSI error.  Fill out pointers to
 951  *      SK, ASC, and ASCQ bytes for later use in fixed or descriptor
 952  *      format sense blocks.
 953  *
 954  *      LOCKING:
 955  *      spin_lock_irqsave(host lock)
 956  */
 957 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
 958                                u8 *asc, u8 *ascq, int verbose)
 959 {
 960         int i;
 961
 962         /* Based on the 3ware driver translation table */
 963         static const unsigned char sense_table[][4] = {
 964                 /* BBD|ECC|ID|MAR */
 965                 {0xd1,          ABORTED_COMMAND, 0x00, 0x00},
 966                         // Device busy                  Aborted command
 967                 /* BBD|ECC|ID */
 968                 {0xd0,          ABORTED_COMMAND, 0x00, 0x00},
 969                         // Device busy                  Aborted command
 970                 /* ECC|MC|MARK */
 971                 {0x61,          HARDWARE_ERROR, 0x00, 0x00},
 972                         // Device fault                 Hardware error
 973                 /* ICRC|ABRT */         /* NB: ICRC & !ABRT is BBD */
 974                 {0x84,          ABORTED_COMMAND, 0x47, 0x00},
 975                         // Data CRC error               SCSI parity error
 976                 /* MC|ID|ABRT|TRK0|MARK */
 977                 {0x37,          NOT_READY, 0x04, 0x00},
 978                         // Unit offline                 Not ready
 979                 /* MCR|MARK */
 980                 {0x09,          NOT_READY, 0x04, 0x00},
 981                         // Unrecovered disk error       Not ready
 982                 /*  Bad address mark */
 983                 {0x01,          MEDIUM_ERROR, 0x13, 0x00},
 984                         // Address mark not found for data field
 985                 /* TRK0 - Track 0 not found */
 986                 {0x02,          HARDWARE_ERROR, 0x00, 0x00},
 987                         // Hardware error
 988                 /* Abort: 0x04 is not translated here, see below */
 989                 /* Media change request */
 990                 {0x08,          NOT_READY, 0x04, 0x00},
 991                         // FIXME: faking offline
 992                 /* SRV/IDNF - ID not found */
 993                 {0x10,          ILLEGAL_REQUEST, 0x21, 0x00},
 994                         // Logical address out of range
 995                 /* MC - Media Changed */
 996                 {0x20,          UNIT_ATTENTION, 0x28, 0x00},
 997                         // Not ready to ready change, medium may have changed
 998                 /* ECC - Uncorrectable ECC error */
 999                 {0x40,          MEDIUM_ERROR, 0x11, 0x04},
1000                         // Unrecovered read error
1001                 /* BBD - block marked bad */
1002                 {0x80,          MEDIUM_ERROR, 0x11, 0x04},
1003                         // Block marked bad     Medium error, unrecovered read error
1004                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1005         };
1006         static const unsigned char stat_table[][4] = {
1007                 /* Must be first because BUSY means no other bits valid */
1008                 {0x80,          ABORTED_COMMAND, 0x47, 0x00},
1009                 // Busy, fake parity for now
1010                 {0x40,          ILLEGAL_REQUEST, 0x21, 0x04},
1011                 // Device ready, unaligned write command
1012                 {0x20,          HARDWARE_ERROR,  0x44, 0x00},
1013                 // Device fault, internal target failure
1014                 {0x08,          ABORTED_COMMAND, 0x47, 0x00},
1015                 // Timed out in xfer, fake parity for now
1016                 {0x04,          RECOVERED_ERROR, 0x11, 0x00},
1017                 // Recovered ECC error    Medium error, recovered
1018                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1019         };
1020
1021         /*
1022          *      Is this an error we can process/parse
1023          */
1024         if (drv_stat & ATA_BUSY) {
1025                 drv_err = 0;    /* Ignore the err bits, they're invalid */
1026         }
1027
1028         if (drv_err) {
1029                 /* Look for drv_err */
1030                 for (i = 0; sense_table[i][0] != 0xFF; i++) {
1031                         /* Look for best matches first */
1032                         if ((sense_table[i][0] & drv_err) ==
1033                             sense_table[i][0]) {
1034                                 *sk = sense_table[i][1];
1035                                 *asc = sense_table[i][2];
1036                                 *ascq = sense_table[i][3];
1037                                 goto translate_done;
1038                         }
1039                 }
1040         }
1041
1042         /*
1043          * Fall back to interpreting status bits.  Note that if the drv_err
1044          * has only the ABRT bit set, we decode drv_stat.  ABRT by itself
1045          * is not descriptive enough.
1046          */
1047         for (i = 0; stat_table[i][0] != 0xFF; i++) {
1048                 if (stat_table[i][0] & drv_stat) {
1049                         *sk = stat_table[i][1];
1050                         *asc = stat_table[i][2];
1051                         *ascq = stat_table[i][3];
1052                         goto translate_done;
1053                 }
1054         }
1055
1056         /*
1057          * We need a sensible error return here, which is tricky, and one
1058          * that won't cause people to do things like return a disk wrongly.
1059          */
1060         *sk = ABORTED_COMMAND;
1061         *asc = 0x00;
1062         *ascq = 0x00;
1063
1064  translate_done:
1065         if (verbose)
1066                 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
1067                        id, drv_stat, drv_err, *sk, *asc, *ascq);
1068         return;
1069 }
1070
1071 /*
1072  *      ata_gen_passthru_sense - Generate check condition sense block.
1073  *      @qc: Command that completed.
1074  *
1075  *      This function is specific to the ATA descriptor format sense
1076  *      block specified for the ATA pass through commands.  Regardless
1077  *      of whether the command errored or not, return a sense
1078  *      block. Copy all controller registers into the sense
1079  *      block. If there was no error, we get the request from an ATA
1080  *      passthrough command, so we use the following sense data:
1081  *      sk = RECOVERED ERROR
1082  *      asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1083  *
1084  *
1085  *      LOCKING:
1086  *      None.
1087  */
1088 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
1089 {
1090         struct scsi_cmnd *cmd = qc->scsicmd;
1091         struct ata_taskfile *tf = &qc->result_tf;
1092         unsigned char *sb = cmd->sense_buffer;
1093         unsigned char *desc = sb + 8;
1094         int verbose = qc->ap->ops->error_handler == NULL;
1095         u8 sense_key, asc, ascq;
1096
1097         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1098
1099         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1100
1101         /*
1102          * Use ata_to_sense_error() to map status register bits
1103          * onto sense key, asc & ascq.
1104          */
1105         if (qc->err_mask ||
1106             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1107                 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1108                                    &sense_key, &asc, &ascq, verbose);
1109                 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
1110         } else {
1111                 /*
1112                  * ATA PASS-THROUGH INFORMATION AVAILABLE
1113                  * Always in descriptor format sense.
1114                  */
1115                 scsi_build_sense_buffer(1, cmd->sense_buffer,
1116                                         RECOVERED_ERROR, 0, 0x1D);
1117         }
1118
1119         if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
1120                 u8 len;
1121
1122                 /* descriptor format */
1123                 len = sb[7];
1124                 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
1125                 if (!desc) {
1126                         if (SCSI_SENSE_BUFFERSIZE < len + 14)
1127                                 return;
1128                         sb[7] = len + 14;
1129                         desc = sb + 8 + len;
1130                 }
1131                 desc[0] = 9;
1132                 desc[1] = 12;
1133                 /*
1134                  * Copy registers into sense buffer.
1135                  */
1136                 desc[2] = 0x00;
1137                 desc[3] = tf->feature;  /* == error reg */
1138                 desc[5] = tf->nsect;
1139                 desc[7] = tf->lbal;
1140                 desc[9] = tf->lbam;
1141                 desc[11] = tf->lbah;
1142                 desc[12] = tf->device;
1143                 desc[13] = tf->command; /* == status reg */
1144
1145                 /*
1146                  * Fill in Extend bit, and the high order bytes
1147                  * if applicable.
1148                  */
1149                 if (tf->flags & ATA_TFLAG_LBA48) {
1150                         desc[2] |= 0x01;
1151                         desc[4] = tf->hob_nsect;
1152                         desc[6] = tf->hob_lbal;
1153                         desc[8] = tf->hob_lbam;
1154                         desc[10] = tf->hob_lbah;
1155                 }
1156         } else {
1157                 /* Fixed sense format */
1158                 desc[0] = tf->feature;
1159                 desc[1] = tf->command; /* status */
1160                 desc[2] = tf->device;
1161                 desc[3] = tf->nsect;
1162                 desc[7] = 0;
1163                 if (tf->flags & ATA_TFLAG_LBA48)  {
1164                         desc[8] |= 0x80;
1165                         if (tf->hob_nsect)
1166                                 desc[8] |= 0x40;
1167                         if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
1168                                 desc[8] |= 0x20;
1169                 }
1170                 desc[9] = tf->lbal;
1171                 desc[10] = tf->lbam;
1172                 desc[11] = tf->lbah;
1173         }
1174 }
1175
1176 /**
1177  *      ata_gen_ata_sense - generate a SCSI fixed sense block
1178  *      @qc: Command that we are erroring out
1179  *
1180  *      Generate sense block for a failed ATA command @qc.  Descriptor
1181  *      format is used to accommodate LBA48 block address.
1182  *
1183  *      LOCKING:
1184  *      None.
1185  */
1186 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1187 {
1188         struct ata_device *dev = qc->dev;
1189         struct scsi_cmnd *cmd = qc->scsicmd;
1190         struct ata_taskfile *tf = &qc->result_tf;
1191         unsigned char *sb = cmd->sense_buffer;
1192         int verbose = qc->ap->ops->error_handler == NULL;
1193         u64 block;
1194         u8 sense_key, asc, ascq;
1195
1196         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1197
1198         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1199
1200         if (ata_dev_disabled(dev)) {
1201                 /* Device disabled after error recovery */
1202                 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
1203                 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
1204                 return;
1205         }
1206         /* Use ata_to_sense_error() to map status register bits
1207          * onto sense key, asc & ascq.
1208          */
1209         if (qc->err_mask ||
1210             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1211                 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1212                                    &sense_key, &asc, &ascq, verbose);
1213                 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1214         } else {
1215                 /* Could not decode error */
1216                 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
1217                              tf->command, qc->err_mask);
1218                 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1219                 return;
1220         }
1221
1222         block = ata_tf_read_block(&qc->result_tf, dev);
1223         if (block == U64_MAX)
1224                 return;
1225
1226         scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
1227 }
1228
1229 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1230 {
1231         sdev->use_10_for_rw = 1;
1232         sdev->use_10_for_ms = 1;
1233         sdev->no_write_same = 1;
1234
1235         /* Schedule policy is determined by ->qc_defer() callback and
1236          * it needs to see every deferred qc.  Set dev_blocked to 1 to
1237          * prevent SCSI midlayer from automatically deferring
1238          * requests.
1239          */
1240         sdev->max_device_blocked = 1;
1241 }
1242
1243 /**
1244  *      atapi_drain_needed - Check whether data transfer may overflow
1245  *      @rq: request to be checked
1246  *
1247  *      ATAPI commands which transfer variable length data to host
1248  *      might overflow due to application error or hardware bug.  This
1249  *      function checks whether overflow should be drained and ignored
1250  *      for @request.
1251  *
1252  *      LOCKING:
1253  *      None.
1254  *
1255  *      RETURNS:
1256  *      1 if ; otherwise, 0.
1257  */
1258 static int atapi_drain_needed(struct request *rq)
1259 {
1260         if (likely(!blk_rq_is_passthrough(rq)))
1261                 return 0;
1262
1263         if (!blk_rq_bytes(rq) || op_is_write(req_op(rq)))
1264                 return 0;
1265
1266         return atapi_cmd_type(scsi_req(rq)->cmd[0]) == ATAPI_MISC;
1267 }
1268
1269 static int ata_scsi_dev_config(struct scsi_device *sdev,
1270                                struct ata_device *dev)
1271 {
1272         struct request_queue *q = sdev->request_queue;
1273
1274         if (!ata_id_has_unload(dev->id))
1275                 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1276
1277         /* configure max sectors */
1278         blk_queue_max_hw_sectors(q, dev->max_sectors);
1279
1280         if (dev->class == ATA_DEV_ATAPI) {
1281                 void *buf;
1282
1283                 sdev->sector_size = ATA_SECT_SIZE;
1284
1285                 /* set DMA padding */
1286                 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1287
1288                 /* configure draining */
1289                 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1290                 if (!buf) {
1291                         ata_dev_err(dev, "drain buffer allocation failed\n");
1292                         return -ENOMEM;
1293                 }
1294
1295                 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1296         } else {
1297                 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1298                 sdev->manage_start_stop = 1;
1299         }
1300
1301         /*
1302          * ata_pio_sectors() expects buffer for each sector to not cross
1303          * page boundary.  Enforce it by requiring buffers to be sector
1304          * aligned, which works iff sector_size is not larger than
1305          * PAGE_SIZE.  ATAPI devices also need the alignment as
1306          * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1307          */
1308         if (sdev->sector_size > PAGE_SIZE)
1309                 ata_dev_warn(dev,
1310                         "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1311                         sdev->sector_size);
1312
1313         blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1314
1315         if (dev->flags & ATA_DFLAG_AN)
1316                 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1317
1318         if (dev->flags & ATA_DFLAG_NCQ) {
1319                 int depth;
1320
1321                 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1322                 depth = min(ATA_MAX_QUEUE, depth);
1323                 scsi_change_queue_depth(sdev, depth);
1324         }
1325
1326         blk_queue_flush_queueable(q, false);
1327
1328         if (dev->flags & ATA_DFLAG_TRUSTED)
1329                 sdev->security_supported = 1;
1330
1331         dev->sdev = sdev;
1332         return 0;
1333 }
1334
1335 /**
1336  *      ata_scsi_slave_config - Set SCSI device attributes
1337  *      @sdev: SCSI device to examine
1338  *
1339  *      This is called before we actually start reading
1340  *      and writing to the device, to configure certain
1341  *      SCSI mid-layer behaviors.
1342  *
1343  *      LOCKING:
1344  *      Defined by SCSI layer.  We don't really care.
1345  */
1346
1347 int ata_scsi_slave_config(struct scsi_device *sdev)
1348 {
1349         struct ata_port *ap = ata_shost_to_port(sdev->host);
1350         struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1351         int rc = 0;
1352
1353         ata_scsi_sdev_config(sdev);
1354
1355         if (dev)
1356                 rc = ata_scsi_dev_config(sdev, dev);
1357
1358         return rc;
1359 }
1360
1361 /**
1362  *      ata_scsi_slave_destroy - SCSI device is about to be destroyed
1363  *      @sdev: SCSI device to be destroyed
1364  *
1365  *      @sdev is about to be destroyed for hot/warm unplugging.  If
1366  *      this unplugging was initiated by libata as indicated by NULL
1367  *      dev->sdev, this function doesn't have to do anything.
1368  *      Otherwise, SCSI layer initiated warm-unplug is in progress.
1369  *      Clear dev->sdev, schedule the device for ATA detach and invoke
1370  *      EH.
1371  *
1372  *      LOCKING:
1373  *      Defined by SCSI layer.  We don't really care.
1374  */
1375 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1376 {
1377         struct ata_port *ap = ata_shost_to_port(sdev->host);
1378         struct request_queue *q = sdev->request_queue;
1379         unsigned long flags;
1380         struct ata_device *dev;
1381
1382         if (!ap->ops->error_handler)
1383                 return;
1384
1385         spin_lock_irqsave(ap->lock, flags);
1386         dev = __ata_scsi_find_dev(ap, sdev);
1387         if (dev && dev->sdev) {
1388                 /* SCSI device already in CANCEL state, no need to offline it */
1389                 dev->sdev = NULL;
1390                 dev->flags |= ATA_DFLAG_DETACH;
1391                 ata_port_schedule_eh(ap);
1392         }
1393         spin_unlock_irqrestore(ap->lock, flags);
1394
1395         kfree(q->dma_drain_buffer);
1396         q->dma_drain_buffer = NULL;
1397         q->dma_drain_size = 0;
1398 }
1399
1400 /**
1401  *      __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
1402  *      @ap: ATA port to which the device change the queue depth
1403  *      @sdev: SCSI device to configure queue depth for
1404  *      @queue_depth: new queue depth
1405  *
1406  *      libsas and libata have different approaches for associating a sdev to
1407  *      its ata_port.
1408  *
1409  */
1410 int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1411                              int queue_depth)
1412 {
1413         struct ata_device *dev;
1414         unsigned long flags;
1415
1416         if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1417                 return sdev->queue_depth;
1418
1419         dev = ata_scsi_find_dev(ap, sdev);
1420         if (!dev || !ata_dev_enabled(dev))
1421                 return sdev->queue_depth;
1422
1423         /* NCQ enabled? */
1424         spin_lock_irqsave(ap->lock, flags);
1425         dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1426         if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1427                 dev->flags |= ATA_DFLAG_NCQ_OFF;
1428                 queue_depth = 1;
1429         }
1430         spin_unlock_irqrestore(ap->lock, flags);
1431
1432         /* limit and apply queue depth */
1433         queue_depth = min(queue_depth, sdev->host->can_queue);
1434         queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1435         queue_depth = min(queue_depth, ATA_MAX_QUEUE);
1436
1437         if (sdev->queue_depth == queue_depth)
1438                 return -EINVAL;
1439
1440         return scsi_change_queue_depth(sdev, queue_depth);
1441 }
1442
1443 /**
1444  *      ata_scsi_change_queue_depth - SCSI callback for queue depth config
1445  *      @sdev: SCSI device to configure queue depth for
1446  *      @queue_depth: new queue depth
1447  *
1448  *      This is libata standard hostt->change_queue_depth callback.
1449  *      SCSI will call into this callback when user tries to set queue
1450  *      depth via sysfs.
1451  *
1452  *      LOCKING:
1453  *      SCSI layer (we don't care)
1454  *
1455  *      RETURNS:
1456  *      Newly configured queue depth.
1457  */
1458 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1459 {
1460         struct ata_port *ap = ata_shost_to_port(sdev->host);
1461
1462         return __ata_change_queue_depth(ap, sdev, queue_depth);
1463 }
1464
1465 /**
1466  *      ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1467  *      @qc: Storage for translated ATA taskfile
1468  *
1469  *      Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1470  *      (to start). Perhaps these commands should be preceded by
1471  *      CHECK POWER MODE to see what power mode the device is already in.
1472  *      [See SAT revision 5 at www.t10.org]
1473  *
1474  *      LOCKING:
1475  *      spin_lock_irqsave(host lock)
1476  *
1477  *      RETURNS:
1478  *      Zero on success, non-zero on error.
1479  */
1480 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1481 {
1482         struct scsi_cmnd *scmd = qc->scsicmd;
1483         struct ata_taskfile *tf = &qc->tf;
1484         const u8 *cdb = scmd->cmnd;
1485         u16 fp;
1486         u8 bp = 0xff;
1487
1488         if (scmd->cmd_len < 5) {
1489                 fp = 4;
1490                 goto invalid_fld;
1491         }
1492
1493         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1494         tf->protocol = ATA_PROT_NODATA;
1495         if (cdb[1] & 0x1) {
1496                 ;       /* ignore IMMED bit, violates sat-r05 */
1497         }
1498         if (cdb[4] & 0x2) {
1499                 fp = 4;
1500                 bp = 1;
1501                 goto invalid_fld;       /* LOEJ bit set not supported */
1502         }
1503         if (((cdb[4] >> 4) & 0xf) != 0) {
1504                 fp = 4;
1505                 bp = 3;
1506                 goto invalid_fld;       /* power conditions not supported */
1507         }
1508
1509         if (cdb[4] & 0x1) {
1510                 tf->nsect = 1;  /* 1 sector, lba=0 */
1511
1512                 if (qc->dev->flags & ATA_DFLAG_LBA) {
1513                         tf->flags |= ATA_TFLAG_LBA;
1514
1515                         tf->lbah = 0x0;
1516                         tf->lbam = 0x0;
1517                         tf->lbal = 0x0;
1518                         tf->device |= ATA_LBA;
1519                 } else {
1520                         /* CHS */
1521                         tf->lbal = 0x1; /* sect */
1522                         tf->lbam = 0x0; /* cyl low */
1523                         tf->lbah = 0x0; /* cyl high */
1524                 }
1525
1526                 tf->command = ATA_CMD_VERIFY;   /* READ VERIFY */
1527         } else {
1528                 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1529                  * or S5) causing some drives to spin up and down again.
1530                  */
1531                 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1532                     system_state == SYSTEM_POWER_OFF)
1533                         goto skip;
1534
1535                 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1536                      system_entering_hibernation())
1537                         goto skip;
1538
1539                 /* Issue ATA STANDBY IMMEDIATE command */
1540                 tf->command = ATA_CMD_STANDBYNOW1;
1541         }
1542
1543         /*
1544          * Standby and Idle condition timers could be implemented but that
1545          * would require libata to implement the Power condition mode page
1546          * and allow the user to change it. Changing mode pages requires
1547          * MODE SELECT to be implemented.
1548          */
1549
1550         return 0;
1551
1552  invalid_fld:
1553         ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1554         return 1;
1555  skip:
1556         scmd->result = SAM_STAT_GOOD;
1557         return 1;
1558 }
1559
1560
1561 /**
1562  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1563  *      @qc: Storage for translated ATA taskfile
1564  *
1565  *      Sets up an ATA taskfile to issue FLUSH CACHE or
1566  *      FLUSH CACHE EXT.
1567  *
1568  *      LOCKING:
1569  *      spin_lock_irqsave(host lock)
1570  *
1571  *      RETURNS:
1572  *      Zero on success, non-zero on error.
1573  */
1574 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1575 {
1576         struct ata_taskfile *tf = &qc->tf;
1577
1578         tf->flags |= ATA_TFLAG_DEVICE;
1579         tf->protocol = ATA_PROT_NODATA;
1580
1581         if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1582                 tf->command = ATA_CMD_FLUSH_EXT;
1583         else
1584                 tf->command = ATA_CMD_FLUSH;
1585
1586         /* flush is critical for IO integrity, consider it an IO command */
1587         qc->flags |= ATA_QCFLAG_IO;
1588
1589         return 0;
1590 }
1591
1592 /**
1593  *      scsi_6_lba_len - Get LBA and transfer length
1594  *      @cdb: SCSI command to translate
1595  *
1596  *      Calculate LBA and transfer length for 6-byte commands.
1597  *
1598  *      RETURNS:
1599  *      @plba: the LBA
1600  *      @plen: the transfer length
1601  */
1602 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1603 {
1604         u64 lba = 0;
1605         u32 len;
1606
1607         VPRINTK("six-byte command\n");
1608
1609         lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1610         lba |= ((u64)cdb[2]) << 8;
1611         lba |= ((u64)cdb[3]);
1612
1613         len = cdb[4];
1614
1615         *plba = lba;
1616         *plen = len;
1617 }
1618
1619 /**
1620  *      scsi_10_lba_len - Get LBA and transfer length
1621  *      @cdb: SCSI command to translate
1622  *
1623  *      Calculate LBA and transfer length for 10-byte commands.
1624  *
1625  *      RETURNS:
1626  *      @plba: the LBA
1627  *      @plen: the transfer length
1628  */
1629 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1630 {
1631         u64 lba = 0;
1632         u32 len = 0;
1633
1634         VPRINTK("ten-byte command\n");
1635
1636         lba |= ((u64)cdb[2]) << 24;
1637         lba |= ((u64)cdb[3]) << 16;
1638         lba |= ((u64)cdb[4]) << 8;
1639         lba |= ((u64)cdb[5]);
1640
1641         len |= ((u32)cdb[7]) << 8;
1642         len |= ((u32)cdb[8]);
1643
1644         *plba = lba;
1645         *plen = len;
1646 }
1647
1648 /**
1649  *      scsi_16_lba_len - Get LBA and transfer length
1650  *      @cdb: SCSI command to translate
1651  *
1652  *      Calculate LBA and transfer length for 16-byte commands.
1653  *
1654  *      RETURNS:
1655  *      @plba: the LBA
1656  *      @plen: the transfer length
1657  */
1658 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1659 {
1660         u64 lba = 0;
1661         u32 len = 0;
1662
1663         VPRINTK("sixteen-byte command\n");
1664
1665         lba |= ((u64)cdb[2]) << 56;
1666         lba |= ((u64)cdb[3]) << 48;
1667         lba |= ((u64)cdb[4]) << 40;
1668         lba |= ((u64)cdb[5]) << 32;
1669         lba |= ((u64)cdb[6]) << 24;
1670         lba |= ((u64)cdb[7]) << 16;
1671         lba |= ((u64)cdb[8]) << 8;
1672         lba |= ((u64)cdb[9]);
1673
1674         len |= ((u32)cdb[10]) << 24;
1675         len |= ((u32)cdb[11]) << 16;
1676         len |= ((u32)cdb[12]) << 8;
1677         len |= ((u32)cdb[13]);
1678
1679         *plba = lba;
1680         *plen = len;
1681 }
1682
1683 /**
1684  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1685  *      @qc: Storage for translated ATA taskfile
1686  *
1687  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
1688  *
1689  *      LOCKING:
1690  *      spin_lock_irqsave(host lock)
1691  *
1692  *      RETURNS:
1693  *      Zero on success, non-zero on error.
1694  */
1695 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1696 {
1697         struct scsi_cmnd *scmd = qc->scsicmd;
1698         struct ata_taskfile *tf = &qc->tf;
1699         struct ata_device *dev = qc->dev;
1700         u64 dev_sectors = qc->dev->n_sectors;
1701         const u8 *cdb = scmd->cmnd;
1702         u64 block;
1703         u32 n_block;
1704         u16 fp;
1705
1706         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1707         tf->protocol = ATA_PROT_NODATA;
1708
1709         if (cdb[0] == VERIFY) {
1710                 if (scmd->cmd_len < 10) {
1711                         fp = 9;
1712                         goto invalid_fld;
1713                 }
1714                 scsi_10_lba_len(cdb, &block, &n_block);
1715         } else if (cdb[0] == VERIFY_16) {
1716                 if (scmd->cmd_len < 16) {
1717                         fp = 15;
1718                         goto invalid_fld;
1719                 }
1720                 scsi_16_lba_len(cdb, &block, &n_block);
1721         } else {
1722                 fp = 0;
1723                 goto invalid_fld;
1724         }
1725
1726         if (!n_block)
1727                 goto nothing_to_do;
1728         if (block >= dev_sectors)
1729                 goto out_of_range;
1730         if ((block + n_block) > dev_sectors)
1731                 goto out_of_range;
1732
1733         if (dev->flags & ATA_DFLAG_LBA) {
1734                 tf->flags |= ATA_TFLAG_LBA;
1735
1736                 if (lba_28_ok(block, n_block)) {
1737                         /* use LBA28 */
1738                         tf->command = ATA_CMD_VERIFY;
1739                         tf->device |= (block >> 24) & 0xf;
1740                 } else if (lba_48_ok(block, n_block)) {
1741                         if (!(dev->flags & ATA_DFLAG_LBA48))
1742                                 goto out_of_range;
1743
1744                         /* use LBA48 */
1745                         tf->flags |= ATA_TFLAG_LBA48;
1746                         tf->command = ATA_CMD_VERIFY_EXT;
1747
1748                         tf->hob_nsect = (n_block >> 8) & 0xff;
1749
1750                         tf->hob_lbah = (block >> 40) & 0xff;
1751                         tf->hob_lbam = (block >> 32) & 0xff;
1752                         tf->hob_lbal = (block >> 24) & 0xff;
1753                 } else
1754                         /* request too large even for LBA48 */
1755                         goto out_of_range;
1756
1757                 tf->nsect = n_block & 0xff;
1758
1759                 tf->lbah = (block >> 16) & 0xff;
1760                 tf->lbam = (block >> 8) & 0xff;
1761                 tf->lbal = block & 0xff;
1762
1763                 tf->device |= ATA_LBA;
1764         } else {
1765                 /* CHS */
1766                 u32 sect, head, cyl, track;
1767
1768                 if (!lba_28_ok(block, n_block))
1769                         goto out_of_range;
1770
1771                 /* Convert LBA to CHS */
1772                 track = (u32)block / dev->sectors;
1773                 cyl   = track / dev->heads;
1774                 head  = track % dev->heads;
1775                 sect  = (u32)block % dev->sectors + 1;
1776
1777                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1778                         (u32)block, track, cyl, head, sect);
1779
1780                 /* Check whether the converted CHS can fit.
1781                    Cylinder: 0-65535
1782                    Head: 0-15
1783                    Sector: 1-255*/
1784                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1785                         goto out_of_range;
1786
1787                 tf->command = ATA_CMD_VERIFY;
1788                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1789                 tf->lbal = sect;
1790                 tf->lbam = cyl;
1791                 tf->lbah = cyl >> 8;
1792                 tf->device |= head;
1793         }
1794
1795         return 0;
1796
1797 invalid_fld:
1798         ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1799         return 1;
1800
1801 out_of_range:
1802         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1803         /* "Logical Block Address out of range" */
1804         return 1;
1805
1806 nothing_to_do:
1807         scmd->result = SAM_STAT_GOOD;
1808         return 1;
1809 }
1810
1811 /**
1812  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1813  *      @qc: Storage for translated ATA taskfile
1814  *
1815  *      Converts any of six SCSI read/write commands into the
1816  *      ATA counterpart, including starting sector (LBA),
1817  *      sector count, and taking into account the device's LBA48
1818  *      support.
1819  *
1820  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1821  *      %WRITE_16 are currently supported.
1822  *
1823  *      LOCKING:
1824  *      spin_lock_irqsave(host lock)
1825  *
1826  *      RETURNS:
1827  *      Zero on success, non-zero on error.
1828  */
1829 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1830 {
1831         struct scsi_cmnd *scmd = qc->scsicmd;
1832         const u8 *cdb = scmd->cmnd;
1833         struct request *rq = scmd->request;
1834         int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1835         unsigned int tf_flags = 0;
1836         u64 block;
1837         u32 n_block;
1838         int rc;
1839         u16 fp = 0;
1840
1841         if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1842                 tf_flags |= ATA_TFLAG_WRITE;
1843
1844         /* Calculate the SCSI LBA, transfer length and FUA. */
1845         switch (cdb[0]) {
1846         case READ_10:
1847         case WRITE_10:
1848                 if (unlikely(scmd->cmd_len < 10)) {
1849                         fp = 9;
1850                         goto invalid_fld;
1851                 }
1852                 scsi_10_lba_len(cdb, &block, &n_block);
1853                 if (cdb[1] & (1 << 3))
1854                         tf_flags |= ATA_TFLAG_FUA;
1855                 break;
1856         case READ_6:
1857         case WRITE_6:
1858                 if (unlikely(scmd->cmd_len < 6)) {
1859                         fp = 5;
1860                         goto invalid_fld;
1861                 }
1862                 scsi_6_lba_len(cdb, &block, &n_block);
1863
1864                 /* for 6-byte r/w commands, transfer length 0
1865                  * means 256 blocks of data, not 0 block.
1866                  */
1867                 if (!n_block)
1868                         n_block = 256;
1869                 break;
1870         case READ_16:
1871         case WRITE_16:
1872                 if (unlikely(scmd->cmd_len < 16)) {
1873                         fp = 15;
1874                         goto invalid_fld;
1875                 }
1876                 scsi_16_lba_len(cdb, &block, &n_block);
1877                 if (cdb[1] & (1 << 3))
1878                         tf_flags |= ATA_TFLAG_FUA;
1879                 break;
1880         default:
1881                 DPRINTK("no-byte command\n");
1882                 fp = 0;
1883                 goto invalid_fld;
1884         }
1885
1886         /* Check and compose ATA command */
1887         if (!n_block)
1888                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1889                  * length 0 means transfer 0 block of data.
1890                  * However, for ATA R/W commands, sector count 0 means
1891                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
1892                  *
1893                  * WARNING: one or two older ATA drives treat 0 as 0...
1894                  */
1895                 goto nothing_to_do;
1896
1897         qc->flags |= ATA_QCFLAG_IO;
1898         qc->nbytes = n_block * scmd->device->sector_size;
1899
1900         rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1901                              qc->hw_tag, class);
1902
1903         if (likely(rc == 0))
1904                 return 0;
1905
1906         if (rc == -ERANGE)
1907                 goto out_of_range;
1908         /* treat all other errors as -EINVAL, fall through */
1909 invalid_fld:
1910         ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1911         return 1;
1912
1913 out_of_range:
1914         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1915         /* "Logical Block Address out of range" */
1916         return 1;
1917
1918 nothing_to_do:
1919         scmd->result = SAM_STAT_GOOD;
1920         return 1;
1921 }
1922
1923 static void ata_qc_done(struct ata_queued_cmd *qc)
1924 {
1925         struct scsi_cmnd *cmd = qc->scsicmd;
1926         void (*done)(struct scsi_cmnd *) = qc->scsidone;
1927
1928         ata_qc_free(qc);
1929         done(cmd);
1930 }
1931
1932 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1933 {
1934         struct ata_port *ap = qc->ap;
1935         struct scsi_cmnd *cmd = qc->scsicmd;
1936         u8 *cdb = cmd->cmnd;
1937         int need_sense = (qc->err_mask != 0);
1938
1939         /* For ATA pass thru (SAT) commands, generate a sense block if
1940          * user mandated it or if there's an error.  Note that if we
1941          * generate because the user forced us to [CK_COND =1], a check
1942          * condition is generated and the ATA register values are returned
1943          * whether the command completed successfully or not. If there
1944          * was no error, we use the following sense data:
1945          * sk = RECOVERED ERROR
1946          * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1947          */
1948         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1949             ((cdb[2] & 0x20) || need_sense))
1950                 ata_gen_passthru_sense(qc);
1951         else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1952                 cmd->result = SAM_STAT_CHECK_CONDITION;
1953         else if (need_sense)
1954                 ata_gen_ata_sense(qc);
1955         else
1956                 cmd->result = SAM_STAT_GOOD;
1957
1958         if (need_sense && !ap->ops->error_handler)
1959                 ata_dump_status(ap->print_id, &qc->result_tf);
1960
1961         ata_qc_done(qc);
1962 }
1963
1964 /**
1965  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1966  *      @dev: ATA device to which the command is addressed
1967  *      @cmd: SCSI command to execute
1968  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1969  *
1970  *      Our ->queuecommand() function has decided that the SCSI
1971  *      command issued can be directly translated into an ATA
1972  *      command, rather than handled internally.
1973  *
1974  *      This function sets up an ata_queued_cmd structure for the
1975  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1976  *
1977  *      The xlat_func argument (actor) returns 0 if ready to execute
1978  *      ATA command, else 1 to finish translation. If 1 is returned
1979  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1980  *      to be set reflecting an error condition or clean (early)
1981  *      termination.
1982  *
1983  *      LOCKING:
1984  *      spin_lock_irqsave(host lock)
1985  *
1986  *      RETURNS:
1987  *      0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1988  *      needs to be deferred.
1989  */
1990 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1991                               ata_xlat_func_t xlat_func)
1992 {
1993         struct ata_port *ap = dev->link->ap;
1994         struct ata_queued_cmd *qc;
1995         int rc;
1996
1997         VPRINTK("ENTER\n");
1998
1999         qc = ata_scsi_qc_new(dev, cmd);
2000         if (!qc)
2001                 goto err_mem;
2002
2003         /* data is present; dma-map it */
2004         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
2005             cmd->sc_data_direction == DMA_TO_DEVICE) {
2006                 if (unlikely(scsi_bufflen(cmd) < 1)) {
2007                         ata_dev_warn(dev, "WARNING: zero len r/w req\n");
2008                         goto err_did;
2009                 }
2010
2011                 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
2012
2013                 qc->dma_dir = cmd->sc_data_direction;
2014         }
2015
2016         qc->complete_fn = ata_scsi_qc_complete;
2017
2018         if (xlat_func(qc))
2019                 goto early_finish;
2020
2021         if (ap->ops->qc_defer) {
2022                 if ((rc = ap->ops->qc_defer(qc)))
2023                         goto defer;
2024         }
2025
2026         /* select device, send command to hardware */
2027         ata_qc_issue(qc);
2028
2029         VPRINTK("EXIT\n");
2030         return 0;
2031
2032 early_finish:
2033         ata_qc_free(qc);
2034         cmd->scsi_done(cmd);
2035         DPRINTK("EXIT - early finish (good or error)\n");
2036         return 0;
2037
2038 err_did:
2039         ata_qc_free(qc);
2040         cmd->result = (DID_ERROR << 16);
2041         cmd->scsi_done(cmd);
2042 err_mem:
2043         DPRINTK("EXIT - internal\n");
2044         return 0;
2045
2046 defer:
2047         ata_qc_free(qc);
2048         DPRINTK("EXIT - defer\n");
2049         if (rc == ATA_DEFER_LINK)
2050                 return SCSI_MLQUEUE_DEVICE_BUSY;
2051         else
2052                 return SCSI_MLQUEUE_HOST_BUSY;
2053 }
2054
2055 struct ata_scsi_args {
2056         struct ata_device       *dev;
2057         u16                     *id;
2058         struct scsi_cmnd        *cmd;
2059 };
2060
2061 /**
2062  *      ata_scsi_rbuf_get - Map response buffer.
2063  *      @cmd: SCSI command containing buffer to be mapped.
2064  *      @flags: unsigned long variable to store irq enable status
2065  *      @copy_in: copy in from user buffer
2066  *
2067  *      Prepare buffer for simulated SCSI commands.
2068  *
2069  *      LOCKING:
2070  *      spin_lock_irqsave(ata_scsi_rbuf_lock) on success
2071  *
2072  *      RETURNS:
2073  *      Pointer to response buffer.
2074  */
2075 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
2076                                unsigned long *flags)
2077 {
2078         spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
2079
2080         memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
2081         if (copy_in)
2082                 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2083                                   ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2084         return ata_scsi_rbuf;
2085 }
2086
2087 /**
2088  *      ata_scsi_rbuf_put - Unmap response buffer.
2089  *      @cmd: SCSI command containing buffer to be unmapped.
2090  *      @copy_out: copy out result
2091  *      @flags: @flags passed to ata_scsi_rbuf_get()
2092  *
2093  *      Returns rbuf buffer.  The result is copied to @cmd's buffer if
2094  *      @copy_back is true.
2095  *
2096  *      LOCKING:
2097  *      Unlocks ata_scsi_rbuf_lock.
2098  */
2099 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
2100                                      unsigned long *flags)
2101 {
2102         if (copy_out)
2103                 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2104                                     ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2105         spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
2106 }
2107
2108 /**
2109  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
2110  *      @args: device IDENTIFY data / SCSI command of interest.
2111  *      @actor: Callback hook for desired SCSI command simulator
2112  *
2113  *      Takes care of the hard work of simulating a SCSI command...
2114  *      Mapping the response buffer, calling the command's handler,
2115  *      and handling the handler's return value.  This return value
2116  *      indicates whether the handler wishes the SCSI command to be
2117  *      completed successfully (0), or not (in which case cmd->result
2118  *      and sense buffer are assumed to be set).
2119  *
2120  *      LOCKING:
2121  *      spin_lock_irqsave(host lock)
2122  */
2123 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
2124                 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
2125 {
2126         u8 *rbuf;
2127         unsigned int rc;
2128         struct scsi_cmnd *cmd = args->cmd;
2129         unsigned long flags;
2130
2131         rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
2132         rc = actor(args, rbuf);
2133         ata_scsi_rbuf_put(cmd, rc == 0, &flags);
2134
2135         if (rc == 0)
2136                 cmd->result = SAM_STAT_GOOD;
2137 }
2138
2139 /**
2140  *      ata_scsiop_inq_std - Simulate INQUIRY command
2141  *      @args: device IDENTIFY data / SCSI command of interest.
2142  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2143  *
2144  *      Returns standard device identification data associated
2145  *      with non-VPD INQUIRY command output.
2146  *
2147  *      LOCKING:
2148  *      spin_lock_irqsave(host lock)
2149  */
2150 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
2151 {
2152         static const u8 versions[] = {
2153                 0x00,
2154                 0x60,   /* SAM-3 (no version claimed) */
2155
2156                 0x03,
2157                 0x20,   /* SBC-2 (no version claimed) */
2158
2159                 0x03,
2160                 0x00    /* SPC-3 (no version claimed) */
2161         };
2162         static const u8 versions_zbc[] = {
2163                 0x00,
2164                 0xA0,   /* SAM-5 (no version claimed) */
2165
2166                 0x06,
2167                 0x00,   /* SBC-4 (no version claimed) */
2168
2169                 0x05,
2170                 0xC0,   /* SPC-5 (no version claimed) */
2171
2172                 0x60,
2173                 0x24,   /* ZBC r05 */
2174         };
2175
2176         u8 hdr[] = {
2177                 TYPE_DISK,
2178                 0,
2179                 0x5,    /* claim SPC-3 version compatibility */
2180                 2,
2181                 95 - 4,
2182                 0,
2183                 0,
2184                 2
2185         };
2186
2187         VPRINTK("ENTER\n");
2188
2189         /* set scsi removable (RMB) bit per ata bit, or if the
2190          * AHCI port says it's external (Hotplug-capable, eSATA).
2191          */
2192         if (ata_id_removable(args->id) ||
2193             (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
2194                 hdr[1] |= (1 << 7);
2195
2196         if (args->dev->class == ATA_DEV_ZAC) {
2197                 hdr[0] = TYPE_ZBC;
2198                 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
2199         }
2200
2201         memcpy(rbuf, hdr, sizeof(hdr));
2202         memcpy(&rbuf[8], "ATA     ", 8);
2203         ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
2204
2205         /* From SAT, use last 2 words from fw rev unless they are spaces */
2206         ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2207         if (strncmp(&rbuf[32], "    ", 4) == 0)
2208                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2209
2210         if (rbuf[32] == 0 || rbuf[32] == ' ')
2211                 memcpy(&rbuf[32], "n/a ", 4);
2212
2213         if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
2214                 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2215         else
2216                 memcpy(rbuf + 58, versions, sizeof(versions));
2217
2218         return 0;
2219 }
2220
2221 /**
2222  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2223  *      @args: device IDENTIFY data / SCSI command of interest.
2224  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2225  *
2226  *      Returns list of inquiry VPD pages available.
2227  *
2228  *      LOCKING:
2229  *      spin_lock_irqsave(host lock)
2230  */
2231 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2232 {
2233         int num_pages;
2234         static const u8 pages[] = {
2235                 0x00,   /* page 0x00, this page */
2236                 0x80,   /* page 0x80, unit serial no page */
2237                 0x83,   /* page 0x83, device ident page */
2238                 0x89,   /* page 0x89, ata info page */
2239                 0xb0,   /* page 0xb0, block limits page */
2240                 0xb1,   /* page 0xb1, block device characteristics page */
2241                 0xb2,   /* page 0xb2, thin provisioning page */
2242                 0xb6,   /* page 0xb6, zoned block device characteristics */
2243         };
2244
2245         num_pages = sizeof(pages);
2246         if (!(args->dev->flags & ATA_DFLAG_ZAC))
2247                 num_pages--;
2248         rbuf[3] = num_pages;    /* number of supported VPD pages */
2249         memcpy(rbuf + 4, pages, num_pages);
2250         return 0;
2251 }
2252
2253 /**
2254  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2255  *      @args: device IDENTIFY data / SCSI command of interest.
2256  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2257  *
2258  *      Returns ATA device serial number.
2259  *
2260  *      LOCKING:
2261  *      spin_lock_irqsave(host lock)
2262  */
2263 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2264 {
2265         static const u8 hdr[] = {
2266                 0,
2267                 0x80,                   /* this page code */
2268                 0,
2269                 ATA_ID_SERNO_LEN,       /* page len */
2270         };
2271
2272         memcpy(rbuf, hdr, sizeof(hdr));
2273         ata_id_string(args->id, (unsigned char *) &rbuf[4],
2274                       ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2275         return 0;
2276 }
2277
2278 /**
2279  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2280  *      @args: device IDENTIFY data / SCSI command of interest.
2281  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2282  *
2283  *      Yields two logical unit device identification designators:
2284  *       - vendor specific ASCII containing the ATA serial number
2285  *       - SAT defined "t10 vendor id based" containing ASCII vendor
2286  *         name ("ATA     "), model and serial numbers.
2287  *
2288  *      LOCKING:
2289  *      spin_lock_irqsave(host lock)
2290  */
2291 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2292 {
2293         const int sat_model_serial_desc_len = 68;
2294         int num;
2295
2296         rbuf[1] = 0x83;                 /* this page code */
2297         num = 4;
2298
2299         /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2300         rbuf[num + 0] = 2;
2301         rbuf[num + 3] = ATA_ID_SERNO_LEN;
2302         num += 4;
2303         ata_id_string(args->id, (unsigned char *) rbuf + num,
2304                       ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2305         num += ATA_ID_SERNO_LEN;
2306
2307         /* SAT defined lu model and serial numbers descriptor */
2308         /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2309         rbuf[num + 0] = 2;
2310         rbuf[num + 1] = 1;
2311         rbuf[num + 3] = sat_model_serial_desc_len;
2312         num += 4;
2313         memcpy(rbuf + num, "ATA     ", 8);
2314         num += 8;
2315         ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2316                       ATA_ID_PROD_LEN);
2317         num += ATA_ID_PROD_LEN;
2318         ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2319                       ATA_ID_SERNO_LEN);
2320         num += ATA_ID_SERNO_LEN;
2321
2322         if (ata_id_has_wwn(args->id)) {
2323                 /* SAT defined lu world wide name */
2324                 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2325                 rbuf[num + 0] = 1;
2326                 rbuf[num + 1] = 3;
2327                 rbuf[num + 3] = ATA_ID_WWN_LEN;
2328                 num += 4;
2329                 ata_id_string(args->id, (unsigned char *) rbuf + num,
2330                               ATA_ID_WWN, ATA_ID_WWN_LEN);
2331                 num += ATA_ID_WWN_LEN;
2332         }
2333         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
2334         return 0;
2335 }
2336
2337 /**
2338  *      ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2339  *      @args: device IDENTIFY data / SCSI command of interest.
2340  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2341  *
2342  *      Yields SAT-specified ATA VPD page.
2343  *
2344  *      LOCKING:
2345  *      spin_lock_irqsave(host lock)
2346  */
2347 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2348 {
2349         struct ata_taskfile tf;
2350
2351         memset(&tf, 0, sizeof(tf));
2352
2353         rbuf[1] = 0x89;                 /* our page code */
2354         rbuf[2] = (0x238 >> 8);         /* page size fixed at 238h */
2355         rbuf[3] = (0x238 & 0xff);
2356
2357         memcpy(&rbuf[8], "linux   ", 8);
2358         memcpy(&rbuf[16], "libata          ", 16);
2359         memcpy(&rbuf[32], DRV_VERSION, 4);
2360
2361         /* we don't store the ATA device signature, so we fake it */
2362
2363         tf.command = ATA_DRDY;          /* really, this is Status reg */
2364         tf.lbal = 0x1;
2365         tf.nsect = 0x1;
2366
2367         ata_tf_to_fis(&tf, 0, 1, &rbuf[36]);    /* TODO: PMP? */
2368         rbuf[36] = 0x34;                /* force D2H Reg FIS (34h) */
2369
2370         rbuf[56] = ATA_CMD_ID_ATA;
2371
2372         memcpy(&rbuf[60], &args->id[0], 512);
2373         return 0;
2374 }
2375
2376 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2377 {
2378         u16 min_io_sectors;
2379
2380         rbuf[1] = 0xb0;
2381         rbuf[3] = 0x3c;         /* required VPD size with unmap support */
2382
2383         /*
2384          * Optimal transfer length granularity.
2385          *
2386          * This is always one physical block, but for disks with a smaller
2387          * logical than physical sector size we need to figure out what the
2388          * latter is.
2389          */
2390         min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2391         put_unaligned_be16(min_io_sectors, &rbuf[6]);
2392
2393         /*
2394          * Optimal unmap granularity.
2395          *
2396          * The ATA spec doesn't even know about a granularity or alignment
2397          * for the TRIM command.  We can leave away most of the unmap related
2398          * VPD page entries, but we have specifify a granularity to signal
2399          * that we support some form of unmap - in thise case via WRITE SAME
2400          * with the unmap bit set.
2401          */
2402         if (ata_id_has_trim(args->id)) {
2403                 put_unaligned_be64(65535 * ATA_MAX_TRIM_RNUM, &rbuf[36]);
2404                 put_unaligned_be32(1, &rbuf[28]);
2405         }
2406
2407         return 0;
2408 }
2409
2410 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2411 {
2412         int form_factor = ata_id_form_factor(args->id);
2413         int media_rotation_rate = ata_id_rotation_rate(args->id);
2414         u8 zoned = ata_id_zoned_cap(args->id);
2415
2416         rbuf[1] = 0xb1;
2417         rbuf[3] = 0x3c;
2418         rbuf[4] = media_rotation_rate >> 8;
2419         rbuf[5] = media_rotation_rate;
2420         rbuf[7] = form_factor;
2421         if (zoned)
2422                 rbuf[8] = (zoned << 4);
2423
2424         return 0;
2425 }
2426
2427 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2428 {
2429         /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2430         rbuf[1] = 0xb2;
2431         rbuf[3] = 0x4;
2432         rbuf[5] = 1 << 6;       /* TPWS */
2433
2434         return 0;
2435 }
2436
2437 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2438 {
2439         /*
2440          * zbc-r05 SCSI Zoned Block device characteristics VPD page
2441          */
2442         rbuf[1] = 0xb6;
2443         rbuf[3] = 0x3C;
2444
2445         /*
2446          * URSWRZ bit is only meaningful for host-managed ZAC drives
2447          */
2448         if (args->dev->zac_zoned_cap & 1)
2449                 rbuf[4] |= 1;
2450         put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2451         put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2452         put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2453
2454         return 0;
2455 }
2456
2457 /**
2458  *      modecpy - Prepare response for MODE SENSE
2459  *      @dest: output buffer
2460  *      @src: data being copied
2461  *      @n: length of mode page
2462  *      @changeable: whether changeable parameters are requested
2463  *
2464  *      Generate a generic MODE SENSE page for either current or changeable
2465  *      parameters.
2466  *
2467  *      LOCKING:
2468  *      None.
2469  */
2470 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2471 {
2472         if (changeable) {
2473                 memcpy(dest, src, 2);
2474                 memset(dest + 2, 0, n - 2);
2475         } else {
2476                 memcpy(dest, src, n);
2477         }
2478 }
2479
2480 /**
2481  *      ata_msense_caching - Simulate MODE SENSE caching info page
2482  *      @id: device IDENTIFY data
2483  *      @buf: output buffer
2484  *      @changeable: whether changeable parameters are requested
2485  *
2486  *      Generate a caching info page, which conditionally indicates
2487  *      write caching to the SCSI layer, depending on device
2488  *      capabilities.
2489  *
2490  *      LOCKING:
2491  *      None.
2492  */
2493 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2494 {
2495         modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2496         if (changeable) {
2497                 buf[2] |= (1 << 2);     /* ata_mselect_caching() */
2498         } else {
2499                 buf[2] |= (ata_id_wcache_enabled(id) << 2);     /* write cache enable */
2500                 buf[12] |= (!ata_id_rahead_enabled(id) << 5);   /* disable read ahead */
2501         }
2502         return sizeof(def_cache_mpage);
2503 }
2504
2505 /**
2506  *      ata_msense_control - Simulate MODE SENSE control mode page
2507  *      @dev: ATA device of interest
2508  *      @buf: output buffer
2509  *      @changeable: whether changeable parameters are requested
2510  *
2511  *      Generate a generic MODE SENSE control mode page.
2512  *
2513  *      LOCKING:
2514  *      None.
2515  */
2516 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2517                                         bool changeable)
2518 {
2519         modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2520         if (changeable) {
2521                 buf[2] |= (1 << 2);     /* ata_mselect_control() */
2522         } else {
2523                 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2524
2525                 buf[2] |= (d_sense << 2);       /* descriptor format sense data */
2526         }
2527         return sizeof(def_control_mpage);
2528 }
2529
2530 /**
2531  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2532  *      @buf: output buffer
2533  *      @changeable: whether changeable parameters are requested
2534  *
2535  *      Generate a generic MODE SENSE r/w error recovery page.
2536  *
2537  *      LOCKING:
2538  *      None.
2539  */
2540 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2541 {
2542         modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2543                 changeable);
2544         return sizeof(def_rw_recovery_mpage);
2545 }
2546
2547 /*
2548  * We can turn this into a real blacklist if it's needed, for now just
2549  * blacklist any Maxtor BANC1G10 revision firmware
2550  */
2551 static int ata_dev_supports_fua(u16 *id)
2552 {
2553         unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2554
2555         if (!libata_fua)
2556                 return 0;
2557         if (!ata_id_has_fua(id))
2558                 return 0;
2559
2560         ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2561         ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2562
2563         if (strcmp(model, "Maxtor"))
2564                 return 1;
2565         if (strcmp(fw, "BANC1G10"))
2566                 return 1;
2567
2568         return 0; /* blacklisted */
2569 }
2570
2571 /**
2572  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2573  *      @args: device IDENTIFY data / SCSI command of interest.
2574  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2575  *
2576  *      Simulate MODE SENSE commands. Assume this is invoked for direct
2577  *      access devices (e.g. disks) only. There should be no block
2578  *      descriptor for other device types.
2579  *
2580  *      LOCKING:
2581  *      spin_lock_irqsave(host lock)
2582  */
2583 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2584 {
2585         struct ata_device *dev = args->dev;
2586         u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2587         static const u8 sat_blk_desc[] = {
2588                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
2589                 0,
2590                 0, 0x2, 0x0     /* block length: 512 bytes */
2591         };
2592         u8 pg, spg;
2593         unsigned int ebd, page_control, six_byte;
2594         u8 dpofua, bp = 0xff;
2595         u16 fp;
2596
2597         VPRINTK("ENTER\n");
2598
2599         six_byte = (scsicmd[0] == MODE_SENSE);
2600         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
2601         /*
2602          * LLBA bit in msense(10) ignored (compliant)
2603          */
2604
2605         page_control = scsicmd[2] >> 6;
2606         switch (page_control) {
2607         case 0: /* current */
2608         case 1: /* changeable */
2609         case 2: /* defaults */
2610                 break;  /* supported */
2611         case 3: /* saved */
2612                 goto saving_not_supp;
2613         default:
2614                 fp = 2;
2615                 bp = 6;
2616                 goto invalid_fld;
2617         }
2618
2619         if (six_byte)
2620                 p += 4 + (ebd ? 8 : 0);
2621         else
2622                 p += 8 + (ebd ? 8 : 0);
2623
2624         pg = scsicmd[2] & 0x3f;
2625         spg = scsicmd[3];
2626         /*
2627          * No mode subpages supported (yet) but asking for _all_
2628          * subpages may be valid
2629          */
2630         if (spg && (spg != ALL_SUB_MPAGES)) {
2631                 fp = 3;
2632                 goto invalid_fld;
2633         }
2634
2635         switch(pg) {
2636         case RW_RECOVERY_MPAGE:
2637                 p += ata_msense_rw_recovery(p, page_control == 1);
2638                 break;
2639
2640         case CACHE_MPAGE:
2641                 p += ata_msense_caching(args->id, p, page_control == 1);
2642                 break;
2643
2644         case CONTROL_MPAGE:
2645                 p += ata_msense_control(args->dev, p, page_control == 1);
2646                 break;
2647
2648         case ALL_MPAGES:
2649                 p += ata_msense_rw_recovery(p, page_control == 1);
2650                 p += ata_msense_caching(args->id, p, page_control == 1);
2651                 p += ata_msense_control(args->dev, p, page_control == 1);
2652                 break;
2653
2654         default:                /* invalid page code */
2655                 fp = 2;
2656                 goto invalid_fld;
2657         }
2658
2659         dpofua = 0;
2660         if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2661             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2662                 dpofua = 1 << 4;
2663
2664         if (six_byte) {
2665                 rbuf[0] = p - rbuf - 1;
2666                 rbuf[2] |= dpofua;
2667                 if (ebd) {
2668                         rbuf[3] = sizeof(sat_blk_desc);
2669                         memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2670                 }
2671         } else {
2672                 unsigned int output_len = p - rbuf - 2;
2673
2674                 rbuf[0] = output_len >> 8;
2675                 rbuf[1] = output_len;
2676                 rbuf[3] |= dpofua;
2677                 if (ebd) {
2678                         rbuf[7] = sizeof(sat_blk_desc);
2679                         memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2680                 }
2681         }
2682         return 0;
2683
2684 invalid_fld:
2685         ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2686         return 1;
2687
2688 saving_not_supp:
2689         ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2690          /* "Saving parameters not supported" */
2691         return 1;
2692 }
2693
2694 /**
2695  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2696  *      @args: device IDENTIFY data / SCSI command of interest.
2697  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2698  *
2699  *      Simulate READ CAPACITY commands.
2700  *
2701  *      LOCKING:
2702  *      None.
2703  */
2704 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2705 {
2706         struct ata_device *dev = args->dev;
2707         u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2708         u32 sector_size; /* physical sector size in bytes */
2709         u8 log2_per_phys;
2710         u16 lowest_aligned;
2711
2712         sector_size = ata_id_logical_sector_size(dev->id);
2713         log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2714         lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2715
2716         VPRINTK("ENTER\n");
2717
2718         if (args->cmd->cmnd[0] == READ_CAPACITY) {
2719                 if (last_lba >= 0xffffffffULL)
2720                         last_lba = 0xffffffff;
2721
2722                 /* sector count, 32-bit */
2723                 rbuf[0] = last_lba >> (8 * 3);
2724                 rbuf[1] = last_lba >> (8 * 2);
2725                 rbuf[2] = last_lba >> (8 * 1);
2726                 rbuf[3] = last_lba;
2727
2728                 /* sector size */
2729                 rbuf[4] = sector_size >> (8 * 3);
2730                 rbuf[5] = sector_size >> (8 * 2);
2731                 rbuf[6] = sector_size >> (8 * 1);
2732                 rbuf[7] = sector_size;
2733         } else {
2734                 /* sector count, 64-bit */
2735                 rbuf[0] = last_lba >> (8 * 7);
2736                 rbuf[1] = last_lba >> (8 * 6);
2737                 rbuf[2] = last_lba >> (8 * 5);
2738                 rbuf[3] = last_lba >> (8 * 4);
2739                 rbuf[4] = last_lba >> (8 * 3);
2740                 rbuf[5] = last_lba >> (8 * 2);
2741                 rbuf[6] = last_lba >> (8 * 1);
2742                 rbuf[7] = last_lba;
2743
2744                 /* sector size */
2745                 rbuf[ 8] = sector_size >> (8 * 3);
2746                 rbuf[ 9] = sector_size >> (8 * 2);
2747                 rbuf[10] = sector_size >> (8 * 1);
2748                 rbuf[11] = sector_size;
2749
2750                 rbuf[12] = 0;
2751                 rbuf[13] = log2_per_phys;
2752                 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2753                 rbuf[15] = lowest_aligned;
2754
2755                 if (ata_id_has_trim(args->id) &&
2756                     !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2757                         rbuf[14] |= 0x80; /* LBPME */
2758
2759                         if (ata_id_has_zero_after_trim(args->id) &&
2760                             dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2761                                 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2762                                 rbuf[14] |= 0x40; /* LBPRZ */
2763                         }
2764                 }
2765                 if (ata_id_zoned_cap(args->id) ||
2766                     args->dev->class == ATA_DEV_ZAC)
2767                         rbuf[12] = (1 << 4); /* RC_BASIS */
2768         }
2769         return 0;
2770 }
2771
2772 /**
2773  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
2774  *      @args: device IDENTIFY data / SCSI command of interest.
2775  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2776  *
2777  *      Simulate REPORT LUNS command.
2778  *
2779  *      LOCKING:
2780  *      spin_lock_irqsave(host lock)
2781  */
2782 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2783 {
2784         VPRINTK("ENTER\n");
2785         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2786
2787         return 0;
2788 }
2789
2790 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2791 {
2792         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2793                 /* FIXME: not quite right; we don't want the
2794                  * translation of taskfile registers into
2795                  * a sense descriptors, since that's only
2796                  * correct for ATA, not ATAPI
2797                  */
2798                 ata_gen_passthru_sense(qc);
2799         }
2800
2801         ata_qc_done(qc);
2802 }
2803
2804 /* is it pointless to prefer PIO for "safety reasons"? */
2805 static inline int ata_pio_use_silly(struct ata_port *ap)
2806 {
2807         return (ap->flags & ATA_FLAG_PIO_DMA);
2808 }
2809
2810 static void atapi_request_sense(struct ata_queued_cmd *qc)
2811 {
2812         struct ata_port *ap = qc->ap;
2813         struct scsi_cmnd *cmd = qc->scsicmd;
2814
2815         DPRINTK("ATAPI request sense\n");
2816
2817         memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2818
2819 #ifdef CONFIG_ATA_SFF
2820         if (ap->ops->sff_tf_read)
2821                 ap->ops->sff_tf_read(ap, &qc->tf);
2822 #endif
2823
2824         /* fill these in, for the case where they are -not- overwritten */
2825         cmd->sense_buffer[0] = 0x70;
2826         cmd->sense_buffer[2] = qc->tf.feature >> 4;
2827
2828         ata_qc_reinit(qc);
2829
2830         /* setup sg table and init transfer direction */
2831         sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2832         ata_sg_init(qc, &qc->sgent, 1);
2833         qc->dma_dir = DMA_FROM_DEVICE;
2834
2835         memset(&qc->cdb, 0, qc->dev->cdb_len);
2836         qc->cdb[0] = REQUEST_SENSE;
2837         qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2838
2839         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2840         qc->tf.command = ATA_CMD_PACKET;
2841
2842         if (ata_pio_use_silly(ap)) {
2843                 qc->tf.protocol = ATAPI_PROT_DMA;
2844                 qc->tf.feature |= ATAPI_PKT_DMA;
2845         } else {
2846                 qc->tf.protocol = ATAPI_PROT_PIO;
2847                 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2848                 qc->tf.lbah = 0;
2849         }
2850         qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2851
2852         qc->complete_fn = atapi_sense_complete;
2853
2854         ata_qc_issue(qc);
2855
2856         DPRINTK("EXIT\n");
2857 }
2858
2859 /*
2860  * ATAPI devices typically report zero for their SCSI version, and sometimes
2861  * deviate from the spec WRT response data format.  If SCSI version is
2862  * reported as zero like normal, then we make the following fixups:
2863  *   1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2864  *      modern device.
2865  *   2) Ensure response data format / ATAPI information are always correct.
2866  */
2867 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2868 {
2869         u8 buf[4];
2870
2871         sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2872         if (buf[2] == 0) {
2873                 buf[2] = 0x5;
2874                 buf[3] = 0x32;
2875         }
2876         sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2877 }
2878
2879 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2880 {
2881         struct scsi_cmnd *cmd = qc->scsicmd;
2882         unsigned int err_mask = qc->err_mask;
2883
2884         VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2885
2886         /* handle completion from new EH */
2887         if (unlikely(qc->ap->ops->error_handler &&
2888                      (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2889
2890                 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2891                         /* FIXME: not quite right; we don't want the
2892                          * translation of taskfile registers into a
2893                          * sense descriptors, since that's only
2894                          * correct for ATA, not ATAPI
2895                          */
2896                         ata_gen_passthru_sense(qc);
2897                 }
2898
2899                 /* SCSI EH automatically locks door if sdev->locked is
2900                  * set.  Sometimes door lock request continues to
2901                  * fail, for example, when no media is present.  This
2902                  * creates a loop - SCSI EH issues door lock which
2903                  * fails and gets invoked again to acquire sense data
2904                  * for the failed command.
2905                  *
2906                  * If door lock fails, always clear sdev->locked to
2907                  * avoid this infinite loop.
2908                  *
2909                  * This may happen before SCSI scan is complete.  Make
2910                  * sure qc->dev->sdev isn't NULL before dereferencing.
2911                  */
2912                 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2913                         qc->dev->sdev->locked = 0;
2914
2915                 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2916                 ata_qc_done(qc);
2917                 return;
2918         }
2919
2920         /* successful completion or old EH failure path */
2921         if (unlikely(err_mask & AC_ERR_DEV)) {
2922                 cmd->result = SAM_STAT_CHECK_CONDITION;
2923                 atapi_request_sense(qc);
2924                 return;
2925         } else if (unlikely(err_mask)) {
2926                 /* FIXME: not quite right; we don't want the
2927                  * translation of taskfile registers into
2928                  * a sense descriptors, since that's only
2929                  * correct for ATA, not ATAPI
2930                  */
2931                 ata_gen_passthru_sense(qc);
2932         } else {
2933                 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2934                         atapi_fixup_inquiry(cmd);
2935                 cmd->result = SAM_STAT_GOOD;
2936         }
2937
2938         ata_qc_done(qc);
2939 }
2940 /**
2941  *      atapi_xlat - Initialize PACKET taskfile
2942  *      @qc: command structure to be initialized
2943  *
2944  *      LOCKING:
2945  *      spin_lock_irqsave(host lock)
2946  *
2947  *      RETURNS:
2948  *      Zero on success, non-zero on failure.
2949  */
2950 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2951 {
2952         struct scsi_cmnd *scmd = qc->scsicmd;
2953         struct ata_device *dev = qc->dev;
2954         int nodata = (scmd->sc_data_direction == DMA_NONE);
2955         int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2956         unsigned int nbytes;
2957
2958         memset(qc->cdb, 0, dev->cdb_len);
2959         memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2960
2961         qc->complete_fn = atapi_qc_complete;
2962
2963         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2964         if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2965                 qc->tf.flags |= ATA_TFLAG_WRITE;
2966                 DPRINTK("direction: write\n");
2967         }
2968
2969         qc->tf.command = ATA_CMD_PACKET;
2970         ata_qc_set_pc_nbytes(qc);
2971
2972         /* check whether ATAPI DMA is safe */
2973         if (!nodata && !using_pio && atapi_check_dma(qc))
2974                 using_pio = 1;
2975
2976         /* Some controller variants snoop this value for Packet
2977          * transfers to do state machine and FIFO management.  Thus we
2978          * want to set it properly, and for DMA where it is
2979          * effectively meaningless.
2980          */
2981         nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2982
2983         /* Most ATAPI devices which honor transfer chunk size don't
2984          * behave according to the spec when odd chunk size which
2985          * matches the transfer length is specified.  If the number of
2986          * bytes to transfer is 2n+1.  According to the spec, what
2987          * should happen is to indicate that 2n+1 is going to be
2988          * transferred and transfer 2n+2 bytes where the last byte is
2989          * padding.
2990          *
2991          * In practice, this doesn't happen.  ATAPI devices first
2992          * indicate and transfer 2n bytes and then indicate and
2993          * transfer 2 bytes where the last byte is padding.
2994          *
2995          * This inconsistency confuses several controllers which
2996          * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2997          * These controllers use actual number of transferred bytes to
2998          * update DMA poitner and transfer of 4n+2 bytes make those
2999          * controller push DMA pointer by 4n+4 bytes because SATA data
3000          * FISes are aligned to 4 bytes.  This causes data corruption
3001          * and buffer overrun.
3002          *
3003          * Always setting nbytes to even number solves this problem
3004          * because then ATAPI devices don't have to split data at 2n
3005          * boundaries.
3006          */
3007         if (nbytes & 0x1)
3008                 nbytes++;
3009
3010         qc->tf.lbam = (nbytes & 0xFF);
3011         qc->tf.lbah = (nbytes >> 8);
3012
3013         if (nodata)
3014                 qc->tf.protocol = ATAPI_PROT_NODATA;
3015         else if (using_pio)
3016                 qc->tf.protocol = ATAPI_PROT_PIO;
3017         else {
3018                 /* DMA data xfer */
3019                 qc->tf.protocol = ATAPI_PROT_DMA;
3020                 qc->tf.feature |= ATAPI_PKT_DMA;
3021
3022                 if ((dev->flags & ATA_DFLAG_DMADIR) &&
3023                     (scmd->sc_data_direction != DMA_TO_DEVICE))
3024                         /* some SATA bridges need us to indicate data xfer direction */
3025                         qc->tf.feature |= ATAPI_DMADIR;
3026         }
3027
3028
3029         /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
3030            as ATAPI tape drives don't get this right otherwise */
3031         return 0;
3032 }
3033
3034 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
3035 {
3036         if (!sata_pmp_attached(ap)) {
3037                 if (likely(devno >= 0 &&
3038                            devno < ata_link_max_devices(&ap->link)))
3039                         return &ap->link.device[devno];
3040         } else {
3041                 if (likely(devno >= 0 &&
3042                            devno < ap->nr_pmp_links))
3043                         return &ap->pmp_link[devno].device[0];
3044         }
3045
3046         return NULL;
3047 }
3048
3049 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
3050                                               const struct scsi_device *scsidev)
3051 {
3052         int devno;
3053
3054         /* skip commands not addressed to targets we simulate */
3055         if (!sata_pmp_attached(ap)) {
3056                 if (unlikely(scsidev->channel || scsidev->lun))
3057                         return NULL;
3058                 devno = scsidev->id;
3059         } else {
3060                 if (unlikely(scsidev->id || scsidev->lun))
3061                         return NULL;
3062                 devno = scsidev->channel;
3063         }
3064
3065         return ata_find_dev(ap, devno);
3066 }
3067
3068 /**
3069  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
3070  *      @ap: ATA port to which the device is attached
3071  *      @scsidev: SCSI device from which we derive the ATA device
3072  *
3073  *      Given various information provided in struct scsi_cmnd,
3074  *      map that onto an ATA bus, and using that mapping
3075  *      determine which ata_device is associated with the
3076  *      SCSI command to be sent.
3077  *
3078  *      LOCKING:
3079  *      spin_lock_irqsave(host lock)
3080  *
3081  *      RETURNS:
3082  *      Associated ATA device, or %NULL if not found.
3083  */
3084 static struct ata_device *
3085 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
3086 {
3087         struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
3088
3089         if (unlikely(!dev || !ata_dev_enabled(dev)))
3090                 return NULL;
3091
3092         return dev;
3093 }
3094
3095 /*
3096  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
3097  *      @byte1: Byte 1 from pass-thru CDB.
3098  *
3099  *      RETURNS:
3100  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
3101  */
3102 static u8
3103 ata_scsi_map_proto(u8 byte1)
3104 {
3105         switch((byte1 & 0x1e) >> 1) {
3106         case 3:         /* Non-data */
3107                 return ATA_PROT_NODATA;
3108
3109         case 6:         /* DMA */
3110         case 10:        /* UDMA Data-in */
3111         case 11:        /* UDMA Data-Out */
3112                 return ATA_PROT_DMA;
3113
3114         case 4:         /* PIO Data-in */
3115         case 5:         /* PIO Data-out */
3116                 return ATA_PROT_PIO;
3117
3118         case 12:        /* FPDMA */
3119                 return ATA_PROT_NCQ;
3120
3121         case 0:         /* Hard Reset */
3122         case 1:         /* SRST */
3123         case 8:         /* Device Diagnostic */
3124         case 9:         /* Device Reset */
3125         case 7:         /* DMA Queued */
3126         case 15:        /* Return Response Info */
3127         default:        /* Reserved */
3128                 break;
3129         }
3130
3131         return ATA_PROT_UNKNOWN;
3132 }
3133
3134 /**
3135  *      ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
3136  *      @qc: command structure to be initialized
3137  *
3138  *      Handles either 12, 16, or 32-byte versions of the CDB.
3139  *
3140  *      RETURNS:
3141  *      Zero on success, non-zero on failure.
3142  */
3143 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
3144 {
3145         struct ata_taskfile *tf = &(qc->tf);
3146         struct scsi_cmnd *scmd = qc->scsicmd;
3147         struct ata_device *dev = qc->dev;
3148         const u8 *cdb = scmd->cmnd;
3149         u16 fp;
3150         u16 cdb_offset = 0;
3151
3152         /* 7Fh variable length cmd means a ata pass-thru(32) */
3153         if (cdb[0] == VARIABLE_LENGTH_CMD)
3154                 cdb_offset = 9;
3155
3156         tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
3157         if (tf->protocol == ATA_PROT_UNKNOWN) {
3158                 fp = 1;
3159                 goto invalid_fld;
3160         }
3161
3162         if (ata_is_ncq(tf->protocol) && (cdb[2 + cdb_offset] & 0x3) == 0)
3163                 tf->protocol = ATA_PROT_NCQ_NODATA;
3164
3165         /* enable LBA */
3166         tf->flags |= ATA_TFLAG_LBA;
3167
3168         /*
3169          * 12 and 16 byte CDBs use different offsets to
3170          * provide the various register values.
3171          */
3172         if (cdb[0] == ATA_16) {
3173                 /*
3174                  * 16-byte CDB - may contain extended commands.
3175                  *
3176                  * If that is the case, copy the upper byte register values.
3177                  */
3178                 if (cdb[1] & 0x01) {
3179                         tf->hob_feature = cdb[3];
3180                         tf->hob_nsect = cdb[5];
3181                         tf->hob_lbal = cdb[7];
3182                         tf->hob_lbam = cdb[9];
3183                         tf->hob_lbah = cdb[11];
3184                         tf->flags |= ATA_TFLAG_LBA48;
3185                 } else
3186                         tf->flags &= ~ATA_TFLAG_LBA48;
3187
3188                 /*
3189                  * Always copy low byte, device and command registers.
3190                  */
3191                 tf->feature = cdb[4];
3192                 tf->nsect = cdb[6];
3193                 tf->lbal = cdb[8];
3194                 tf->lbam = cdb[10];
3195                 tf->lbah = cdb[12];
3196                 tf->device = cdb[13];
3197                 tf->command = cdb[14];
3198         } else if (cdb[0] == ATA_12) {
3199                 /*
3200                  * 12-byte CDB - incapable of extended commands.
3201                  */
3202                 tf->flags &= ~ATA_TFLAG_LBA48;
3203
3204                 tf->feature = cdb[3];
3205                 tf->nsect = cdb[4];
3206                 tf->lbal = cdb[5];
3207                 tf->lbam = cdb[6];
3208                 tf->lbah = cdb[7];
3209                 tf->device = cdb[8];
3210                 tf->command = cdb[9];
3211         } else {
3212                 /*
3213                  * 32-byte CDB - may contain extended command fields.
3214                  *
3215                  * If that is the case, copy the upper byte register values.
3216                  */
3217                 if (cdb[10] & 0x01) {
3218                         tf->hob_feature = cdb[20];
3219                         tf->hob_nsect = cdb[22];
3220                         tf->hob_lbal = cdb[16];
3221                         tf->hob_lbam = cdb[15];
3222                         tf->hob_lbah = cdb[14];
3223                         tf->flags |= ATA_TFLAG_LBA48;
3224                 } else
3225                         tf->flags &= ~ATA_TFLAG_LBA48;
3226
3227                 tf->feature = cdb[21];
3228                 tf->nsect = cdb[23];
3229                 tf->lbal = cdb[19];
3230                 tf->lbam = cdb[18];
3231                 tf->lbah = cdb[17];
3232                 tf->device = cdb[24];
3233                 tf->command = cdb[25];
3234                 tf->auxiliary = get_unaligned_be32(&cdb[28]);
3235         }
3236
3237         /* For NCQ commands copy the tag value */
3238         if (ata_is_ncq(tf->protocol))
3239                 tf->nsect = qc->hw_tag << 3;
3240
3241         /* enforce correct master/slave bit */
3242         tf->device = dev->devno ?
3243                 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3244
3245         switch (tf->command) {
3246         /* READ/WRITE LONG use a non-standard sect_size */
3247         case ATA_CMD_READ_LONG:
3248         case ATA_CMD_READ_LONG_ONCE:
3249         case ATA_CMD_WRITE_LONG:
3250         case ATA_CMD_WRITE_LONG_ONCE:
3251                 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3252                         fp = 1;
3253                         goto invalid_fld;
3254                 }
3255                 qc->sect_size = scsi_bufflen(scmd);
3256                 break;
3257
3258         /* commands using reported Logical Block size (e.g. 512 or 4K) */
3259         case ATA_CMD_CFA_WRITE_NE:
3260         case ATA_CMD_CFA_TRANS_SECT:
3261         case ATA_CMD_CFA_WRITE_MULT_NE:
3262         /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3263         case ATA_CMD_READ:
3264         case ATA_CMD_READ_EXT:
3265         case ATA_CMD_READ_QUEUED:
3266         /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3267         case ATA_CMD_FPDMA_READ:
3268         case ATA_CMD_READ_MULTI:
3269         case ATA_CMD_READ_MULTI_EXT:
3270         case ATA_CMD_PIO_READ:
3271         case ATA_CMD_PIO_READ_EXT:
3272         case ATA_CMD_READ_STREAM_DMA_EXT:
3273         case ATA_CMD_READ_STREAM_EXT:
3274         case ATA_CMD_VERIFY:
3275         case ATA_CMD_VERIFY_EXT:
3276         case ATA_CMD_WRITE:
3277         case ATA_CMD_WRITE_EXT:
3278         case ATA_CMD_WRITE_FUA_EXT:
3279         case ATA_CMD_WRITE_QUEUED:
3280         case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3281         case ATA_CMD_FPDMA_WRITE:
3282         case ATA_CMD_WRITE_MULTI:
3283         case ATA_CMD_WRITE_MULTI_EXT:
3284         case ATA_CMD_WRITE_MULTI_FUA_EXT:
3285         case ATA_CMD_PIO_WRITE:
3286         case ATA_CMD_PIO_WRITE_EXT:
3287         case ATA_CMD_WRITE_STREAM_DMA_EXT:
3288         case ATA_CMD_WRITE_STREAM_EXT:
3289                 qc->sect_size = scmd->device->sector_size;
3290                 break;
3291
3292         /* Everything else uses 512 byte "sectors" */
3293         default:
3294                 qc->sect_size = ATA_SECT_SIZE;
3295         }
3296
3297         /*
3298          * Set flags so that all registers will be written, pass on
3299          * write indication (used for PIO/DMA setup), result TF is
3300          * copied back and we don't whine too much about its failure.
3301          */
3302         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3303         if (scmd->sc_data_direction == DMA_TO_DEVICE)
3304                 tf->flags |= ATA_TFLAG_WRITE;
3305
3306         qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3307
3308         /*
3309          * Set transfer length.
3310          *
3311          * TODO: find out if we need to do more here to
3312          *       cover scatter/gather case.
3313          */
3314         ata_qc_set_pc_nbytes(qc);
3315
3316         /* We may not issue DMA commands if no DMA mode is set */
3317         if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3318                 fp = 1;
3319                 goto invalid_fld;
3320         }
3321
3322         /* We may not issue NCQ commands to devices not supporting NCQ */
3323         if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3324                 fp = 1;
3325                 goto invalid_fld;
3326         }
3327
3328         /* sanity check for pio multi commands */
3329         if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3330                 fp = 1;
3331                 goto invalid_fld;
3332         }
3333
3334         if (is_multi_taskfile(tf)) {
3335                 unsigned int multi_count = 1 << (cdb[1] >> 5);
3336
3337                 /* compare the passed through multi_count
3338                  * with the cached multi_count of libata
3339                  */
3340                 if (multi_count != dev->multi_count)
3341                         ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3342                                      multi_count);
3343         }
3344
3345         /*
3346          * Filter SET_FEATURES - XFER MODE command -- otherwise,
3347          * SET_FEATURES - XFER MODE must be preceded/succeeded
3348          * by an update to hardware-specific registers for each
3349          * controller (i.e. the reason for ->set_piomode(),
3350          * ->set_dmamode(), and ->post_set_mode() hooks).
3351          */
3352         if (tf->command == ATA_CMD_SET_FEATURES &&
3353             tf->feature == SETFEATURES_XFER) {
3354                 fp = (cdb[0] == ATA_16) ? 4 : 3;
3355                 goto invalid_fld;
3356         }
3357
3358         /*
3359          * Filter TPM commands by default. These provide an
3360          * essentially uncontrolled encrypted "back door" between
3361          * applications and the disk. Set libata.allow_tpm=1 if you
3362          * have a real reason for wanting to use them. This ensures
3363          * that installed software cannot easily mess stuff up without
3364          * user intent. DVR type users will probably ship with this enabled
3365          * for movie content management.
3366          *
3367          * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3368          * for this and should do in future but that it is not sufficient as
3369          * DCS is an optional feature set. Thus we also do the software filter
3370          * so that we comply with the TC consortium stated goal that the user
3371          * can turn off TC features of their system.
3372          */
3373         if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3374                 fp = (cdb[0] == ATA_16) ? 14 : 9;
3375                 goto invalid_fld;
3376         }
3377
3378         return 0;
3379
3380  invalid_fld:
3381         ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3382         return 1;
3383 }
3384
3385 /**
3386  * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3387  * @cmd: SCSI command being translated
3388  * @trmax: Maximum number of entries that will fit in sector_size bytes.
3389  * @sector: Starting sector
3390  * @count: Total Range of request in logical sectors
3391  *
3392  * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3393  * descriptor.
3394  *
3395  * Upto 64 entries of the format:
3396  *   63:48 Range Length
3397  *   47:0  LBA
3398  *
3399  *  Range Length of 0 is ignored.
3400  *  LBA's should be sorted order and not overlap.
3401  *
3402  * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3403  *
3404  * Return: Number of bytes copied into sglist.
3405  */
3406 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3407                                         u64 sector, u32 count)
3408 {
3409         struct scsi_device *sdp = cmd->device;
3410         size_t len = sdp->sector_size;
3411         size_t r;
3412         __le64 *buf;
3413         u32 i = 0;
3414         unsigned long flags;
3415
3416         WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3417
3418         if (len > ATA_SCSI_RBUF_SIZE)
3419                 len = ATA_SCSI_RBUF_SIZE;
3420
3421         spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3422         buf = ((void *)ata_scsi_rbuf);
3423         memset(buf, 0, len);
3424         while (i < trmax) {
3425                 u64 entry = sector |
3426                         ((u64)(count > 0xffff ? 0xffff : count) << 48);
3427                 buf[i++] = __cpu_to_le64(entry);
3428                 if (count <= 0xffff)
3429                         break;
3430                 count -= 0xffff;
3431                 sector += 0xffff;
3432         }
3433         r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3434         spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3435
3436         return r;
3437 }
3438
3439 /**
3440  * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3441  * @qc: Command to be translated
3442  *
3443  * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3444  * an SCT Write Same command.
3445  * Based on WRITE SAME has the UNMAP flag:
3446  *
3447  *   - When set translate to DSM TRIM
3448  *   - When clear translate to SCT Write Same
3449  */
3450 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3451 {
3452         struct ata_taskfile *tf = &qc->tf;
3453         struct scsi_cmnd *scmd = qc->scsicmd;
3454         struct scsi_device *sdp = scmd->device;
3455         size_t len = sdp->sector_size;
3456         struct ata_device *dev = qc->dev;
3457         const u8 *cdb = scmd->cmnd;
3458         u64 block;
3459         u32 n_block;
3460         const u32 trmax = len >> 3;
3461         u32 size;
3462         u16 fp;
3463         u8 bp = 0xff;
3464         u8 unmap = cdb[1] & 0x8;
3465
3466         /* we may not issue DMA commands if no DMA mode is set */
3467         if (unlikely(!dev->dma_mode))
3468                 goto invalid_opcode;
3469
3470         /*
3471          * We only allow sending this command through the block layer,
3472          * as it modifies the DATA OUT buffer, which would corrupt user
3473          * memory for SG_IO commands.
3474          */
3475         if (unlikely(blk_rq_is_passthrough(scmd->request)))
3476                 goto invalid_opcode;
3477
3478         if (unlikely(scmd->cmd_len < 16)) {
3479                 fp = 15;
3480                 goto invalid_fld;
3481         }
3482         scsi_16_lba_len(cdb, &block, &n_block);
3483
3484         if (!unmap ||
3485             (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3486             !ata_id_has_trim(dev->id)) {
3487                 fp = 1;
3488                 bp = 3;
3489                 goto invalid_fld;
3490         }
3491         /* If the request is too large the cmd is invalid */
3492         if (n_block > 0xffff * trmax) {
3493                 fp = 2;
3494                 goto invalid_fld;
3495         }
3496
3497         /*
3498          * WRITE SAME always has a sector sized buffer as payload, this
3499          * should never be a multiple entry S/G list.
3500          */
3501         if (!scsi_sg_count(scmd))
3502                 goto invalid_param_len;
3503
3504         /*
3505          * size must match sector size in bytes
3506          * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3507          * is defined as number of 512 byte blocks to be transferred.
3508          */
3509
3510         size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3511         if (size != len)
3512                 goto invalid_param_len;
3513
3514         if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3515                 /* Newer devices support queued TRIM commands */
3516                 tf->protocol = ATA_PROT_NCQ;
3517                 tf->command = ATA_CMD_FPDMA_SEND;
3518                 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3519                 tf->nsect = qc->hw_tag << 3;
3520                 tf->hob_feature = (size / 512) >> 8;
3521                 tf->feature = size / 512;
3522
3523                 tf->auxiliary = 1;
3524         } else {
3525                 tf->protocol = ATA_PROT_DMA;
3526                 tf->hob_feature = 0;
3527                 tf->feature = ATA_DSM_TRIM;
3528                 tf->hob_nsect = (size / 512) >> 8;
3529                 tf->nsect = size / 512;
3530                 tf->command = ATA_CMD_DSM;
3531         }
3532
3533         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3534                      ATA_TFLAG_WRITE;
3535
3536         ata_qc_set_pc_nbytes(qc);
3537
3538         return 0;
3539
3540 invalid_fld:
3541         ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3542         return 1;
3543 invalid_param_len:
3544         /* "Parameter list length error" */
3545         ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3546         return 1;
3547 invalid_opcode:
3548         /* "Invalid command operation code" */
3549         ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3550         return 1;
3551 }
3552
3553 /**
3554  *      ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3555  *      @args: device MAINTENANCE_IN data / SCSI command of interest.
3556  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3557  *
3558  *      Yields a subset to satisfy scsi_report_opcode()
3559  *
3560  *      LOCKING:
3561  *      spin_lock_irqsave(host lock)
3562  */
3563 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3564 {
3565         struct ata_device *dev = args->dev;
3566         u8 *cdb = args->cmd->cmnd;
3567         u8 supported = 0;
3568         unsigned int err = 0;
3569
3570         if (cdb[2] != 1) {
3571                 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3572                 err = 2;
3573                 goto out;
3574         }
3575         switch (cdb[3]) {
3576         case INQUIRY:
3577         case MODE_SENSE:
3578         case MODE_SENSE_10:
3579         case READ_CAPACITY:
3580         case SERVICE_ACTION_IN_16:
3581         case REPORT_LUNS:
3582         case REQUEST_SENSE:
3583         case SYNCHRONIZE_CACHE:
3584         case REZERO_UNIT:
3585         case SEEK_6:
3586         case SEEK_10:
3587         case TEST_UNIT_READY:
3588         case SEND_DIAGNOSTIC:
3589         case MAINTENANCE_IN:
3590         case READ_6:
3591         case READ_10:
3592         case READ_16:
3593         case WRITE_6:
3594         case WRITE_10:
3595         case WRITE_16:
3596         case ATA_12:
3597         case ATA_16:
3598         case VERIFY:
3599         case VERIFY_16:
3600         case MODE_SELECT:
3601         case MODE_SELECT_10:
3602         case START_STOP:
3603                 supported = 3;
3604                 break;
3605         case ZBC_IN:
3606         case ZBC_OUT:
3607                 if (ata_id_zoned_cap(dev->id) ||
3608                     dev->class == ATA_DEV_ZAC)
3609                         supported = 3;
3610                 break;
3611         case SECURITY_PROTOCOL_IN:
3612         case SECURITY_PROTOCOL_OUT:
3613                 if (dev->flags & ATA_DFLAG_TRUSTED)
3614                         supported = 3;
3615                 break;
3616         default:
3617                 break;
3618         }
3619 out:
3620         rbuf[1] = supported; /* supported */
3621         return err;
3622 }
3623
3624 /**
3625  *      ata_scsi_report_zones_complete - convert ATA output
3626  *      @qc: command structure returning the data
3627  *
3628  *      Convert T-13 little-endian field representation into
3629  *      T-10 big-endian field representation.
3630  *      What a mess.
3631  */
3632 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3633 {
3634         struct scsi_cmnd *scmd = qc->scsicmd;
3635         struct sg_mapping_iter miter;
3636         unsigned long flags;
3637         unsigned int bytes = 0;
3638
3639         sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3640                        SG_MITER_TO_SG | SG_MITER_ATOMIC);
3641
3642         local_irq_save(flags);
3643         while (sg_miter_next(&miter)) {
3644                 unsigned int offset = 0;
3645
3646                 if (bytes == 0) {
3647                         char *hdr;
3648                         u32 list_length;
3649                         u64 max_lba, opt_lba;
3650                         u16 same;
3651
3652                         /* Swizzle header */
3653                         hdr = miter.addr;
3654                         list_length = get_unaligned_le32(&hdr[0]);
3655                         same = get_unaligned_le16(&hdr[4]);
3656                         max_lba = get_unaligned_le64(&hdr[8]);
3657                         opt_lba = get_unaligned_le64(&hdr[16]);
3658                         put_unaligned_be32(list_length, &hdr[0]);
3659                         hdr[4] = same & 0xf;
3660                         put_unaligned_be64(max_lba, &hdr[8]);
3661                         put_unaligned_be64(opt_lba, &hdr[16]);
3662                         offset += 64;
3663                         bytes += 64;
3664                 }
3665                 while (offset < miter.length) {
3666                         char *rec;
3667                         u8 cond, type, non_seq, reset;
3668                         u64 size, start, wp;
3669
3670                         /* Swizzle zone descriptor */
3671                         rec = miter.addr + offset;
3672                         type = rec[0] & 0xf;
3673                         cond = (rec[1] >> 4) & 0xf;
3674                         non_seq = (rec[1] & 2);
3675                         reset = (rec[1] & 1);
3676                         size = get_unaligned_le64(&rec[8]);
3677                         start = get_unaligned_le64(&rec[16]);
3678                         wp = get_unaligned_le64(&rec[24]);
3679                         rec[0] = type;
3680                         rec[1] = (cond << 4) | non_seq | reset;
3681                         put_unaligned_be64(size, &rec[8]);
3682                         put_unaligned_be64(start, &rec[16]);
3683                         put_unaligned_be64(wp, &rec[24]);
3684                         WARN_ON(offset + 64 > miter.length);
3685                         offset += 64;
3686                         bytes += 64;
3687                 }
3688         }
3689         sg_miter_stop(&miter);
3690         local_irq_restore(flags);
3691
3692         ata_scsi_qc_complete(qc);
3693 }
3694
3695 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3696 {
3697         struct ata_taskfile *tf = &qc->tf;
3698         struct scsi_cmnd *scmd = qc->scsicmd;
3699         const u8 *cdb = scmd->cmnd;
3700         u16 sect, fp = (u16)-1;
3701         u8 sa, options, bp = 0xff;
3702         u64 block;
3703         u32 n_block;
3704
3705         if (unlikely(scmd->cmd_len < 16)) {
3706                 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3707                              scmd->cmd_len);
3708                 fp = 15;
3709                 goto invalid_fld;
3710         }
3711         scsi_16_lba_len(cdb, &block, &n_block);
3712         if (n_block != scsi_bufflen(scmd)) {
3713                 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3714                              n_block, scsi_bufflen(scmd));
3715                 goto invalid_param_len;
3716         }
3717         sa = cdb[1] & 0x1f;
3718         if (sa != ZI_REPORT_ZONES) {
3719                 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3720                 fp = 1;
3721                 goto invalid_fld;
3722         }
3723         /*
3724          * ZAC allows only for transfers in 512 byte blocks,
3725          * and uses a 16 bit value for the transfer count.
3726          */
3727         if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3728                 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3729                 goto invalid_param_len;
3730         }
3731         sect = n_block / 512;
3732         options = cdb[14] & 0xbf;
3733
3734         if (ata_ncq_enabled(qc->dev) &&
3735             ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3736                 tf->protocol = ATA_PROT_NCQ;
3737                 tf->command = ATA_CMD_FPDMA_RECV;
3738                 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3739                 tf->nsect = qc->hw_tag << 3;
3740                 tf->feature = sect & 0xff;
3741                 tf->hob_feature = (sect >> 8) & 0xff;
3742                 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3743         } else {
3744                 tf->command = ATA_CMD_ZAC_MGMT_IN;
3745                 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3746                 tf->protocol = ATA_PROT_DMA;
3747                 tf->hob_feature = options;
3748                 tf->hob_nsect = (sect >> 8) & 0xff;
3749                 tf->nsect = sect & 0xff;
3750         }
3751         tf->device = ATA_LBA;
3752         tf->lbah = (block >> 16) & 0xff;
3753         tf->lbam = (block >> 8) & 0xff;
3754         tf->lbal = block & 0xff;
3755         tf->hob_lbah = (block >> 40) & 0xff;
3756         tf->hob_lbam = (block >> 32) & 0xff;
3757         tf->hob_lbal = (block >> 24) & 0xff;
3758
3759         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3760         qc->flags |= ATA_QCFLAG_RESULT_TF;
3761
3762         ata_qc_set_pc_nbytes(qc);
3763
3764         qc->complete_fn = ata_scsi_report_zones_complete;
3765
3766         return 0;
3767
3768 invalid_fld:
3769         ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3770         return 1;
3771
3772 invalid_param_len:
3773         /* "Parameter list length error" */
3774         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3775         return 1;
3776 }
3777
3778 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3779 {
3780         struct ata_taskfile *tf = &qc->tf;
3781         struct scsi_cmnd *scmd = qc->scsicmd;
3782         struct ata_device *dev = qc->dev;
3783         const u8 *cdb = scmd->cmnd;
3784         u8 all, sa;
3785         u64 block;
3786         u32 n_block;
3787         u16 fp = (u16)-1;
3788
3789         if (unlikely(scmd->cmd_len < 16)) {
3790                 fp = 15;
3791                 goto invalid_fld;
3792         }
3793
3794         sa = cdb[1] & 0x1f;
3795         if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3796             (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3797                 fp = 1;
3798                 goto invalid_fld;
3799         }
3800
3801         scsi_16_lba_len(cdb, &block, &n_block);
3802         if (n_block) {
3803                 /*
3804                  * ZAC MANAGEMENT OUT doesn't define any length
3805                  */
3806                 goto invalid_param_len;
3807         }
3808         if (block > dev->n_sectors)
3809                 goto out_of_range;
3810
3811         all = cdb[14] & 0x1;
3812
3813         if (ata_ncq_enabled(qc->dev) &&
3814             ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3815                 tf->protocol = ATA_PROT_NCQ_NODATA;
3816                 tf->command = ATA_CMD_NCQ_NON_DATA;
3817                 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3818                 tf->nsect = qc->hw_tag << 3;
3819                 tf->auxiliary = sa | ((u16)all << 8);
3820         } else {
3821                 tf->protocol = ATA_PROT_NODATA;
3822                 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3823                 tf->feature = sa;
3824                 tf->hob_feature = all;
3825         }
3826         tf->lbah = (block >> 16) & 0xff;
3827         tf->lbam = (block >> 8) & 0xff;
3828         tf->lbal = block & 0xff;
3829         tf->hob_lbah = (block >> 40) & 0xff;
3830         tf->hob_lbam = (block >> 32) & 0xff;
3831         tf->hob_lbal = (block >> 24) & 0xff;
3832         tf->device = ATA_LBA;
3833         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3834
3835         return 0;
3836
3837  invalid_fld:
3838         ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3839         return 1;
3840  out_of_range:
3841         /* "Logical Block Address out of range" */
3842         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x00);
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 }