drivers/ata/libata-scsi.c

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