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