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