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