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