drivers/ata/libata-scsi.c

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