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