drivers/ata/libata-scsi.c

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