drivers/ata/libata-scsi.c

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