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