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