drivers/ata/libata-scsi.c

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