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                 /* Issue ATA STANDBY IMMEDIATE command */
 949                 tf->command = ATA_CMD_STANDBYNOW1;
 950
 951         /*
 952          * Standby and Idle condition timers could be implemented but that
 953          * would require libata to implement the Power condition mode page
 954          * and allow the user to change it. Changing mode pages requires
 955          * MODE SELECT to be implemented.
 956          */
 957
 958         return 0;
 959
 960 invalid_fld:
 961         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
 962         /* "Invalid field in cbd" */
 963         return 1;
 964 }
 965
 966
 967 /**
 968  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
 969  *      @qc: Storage for translated ATA taskfile
 970  *
 971  *      Sets up an ATA taskfile to issue FLUSH CACHE or
 972  *      FLUSH CACHE EXT.
 973  *
 974  *      LOCKING:
 975  *      spin_lock_irqsave(host lock)
 976  *
 977  *      RETURNS:
 978  *      Zero on success, non-zero on error.
 979  */
 980 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
 981 {
 982         struct ata_taskfile *tf = &qc->tf;
 983
 984         tf->flags |= ATA_TFLAG_DEVICE;
 985         tf->protocol = ATA_PROT_NODATA;
 986
 987         if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
 988                 tf->command = ATA_CMD_FLUSH_EXT;
 989         else
 990                 tf->command = ATA_CMD_FLUSH;
 991
 992         return 0;
 993 }
 994
 995 /**
 996  *      scsi_6_lba_len - Get LBA and transfer length
 997  *      @cdb: SCSI command to translate
 998  *
 999  *      Calculate LBA and transfer length for 6-byte commands.
1000  *
1001  *      RETURNS:
1002  *      @plba: the LBA
1003  *      @plen: the transfer length
1004  */
1005 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1006 {
1007         u64 lba = 0;
1008         u32 len = 0;
1009
1010         VPRINTK("six-byte command\n");
1011
1012         lba |= ((u64)cdb[2]) << 8;
1013         lba |= ((u64)cdb[3]);
1014
1015         len |= ((u32)cdb[4]);
1016
1017         *plba = lba;
1018         *plen = len;
1019 }
1020
1021 /**
1022  *      scsi_10_lba_len - Get LBA and transfer length
1023  *      @cdb: SCSI command to translate
1024  *
1025  *      Calculate LBA and transfer length for 10-byte commands.
1026  *
1027  *      RETURNS:
1028  *      @plba: the LBA
1029  *      @plen: the transfer length
1030  */
1031 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1032 {
1033         u64 lba = 0;
1034         u32 len = 0;
1035
1036         VPRINTK("ten-byte command\n");
1037
1038         lba |= ((u64)cdb[2]) << 24;
1039         lba |= ((u64)cdb[3]) << 16;
1040         lba |= ((u64)cdb[4]) << 8;
1041         lba |= ((u64)cdb[5]);
1042
1043         len |= ((u32)cdb[7]) << 8;
1044         len |= ((u32)cdb[8]);
1045
1046         *plba = lba;
1047         *plen = len;
1048 }
1049
1050 /**
1051  *      scsi_16_lba_len - Get LBA and transfer length
1052  *      @cdb: SCSI command to translate
1053  *
1054  *      Calculate LBA and transfer length for 16-byte commands.
1055  *
1056  *      RETURNS:
1057  *      @plba: the LBA
1058  *      @plen: the transfer length
1059  */
1060 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1061 {
1062         u64 lba = 0;
1063         u32 len = 0;
1064
1065         VPRINTK("sixteen-byte command\n");
1066
1067         lba |= ((u64)cdb[2]) << 56;
1068         lba |= ((u64)cdb[3]) << 48;
1069         lba |= ((u64)cdb[4]) << 40;
1070         lba |= ((u64)cdb[5]) << 32;
1071         lba |= ((u64)cdb[6]) << 24;
1072         lba |= ((u64)cdb[7]) << 16;
1073         lba |= ((u64)cdb[8]) << 8;
1074         lba |= ((u64)cdb[9]);
1075
1076         len |= ((u32)cdb[10]) << 24;
1077         len |= ((u32)cdb[11]) << 16;
1078         len |= ((u32)cdb[12]) << 8;
1079         len |= ((u32)cdb[13]);
1080
1081         *plba = lba;
1082         *plen = len;
1083 }
1084
1085 /**
1086  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1087  *      @qc: Storage for translated ATA taskfile
1088  *
1089  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
1090  *
1091  *      LOCKING:
1092  *      spin_lock_irqsave(host lock)
1093  *
1094  *      RETURNS:
1095  *      Zero on success, non-zero on error.
1096  */
1097 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1098 {
1099         struct scsi_cmnd *scmd = qc->scsicmd;
1100         struct ata_taskfile *tf = &qc->tf;
1101         struct ata_device *dev = qc->dev;
1102         u64 dev_sectors = qc->dev->n_sectors;
1103         const u8 *cdb = scmd->cmnd;
1104         u64 block;
1105         u32 n_block;
1106
1107         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1108         tf->protocol = ATA_PROT_NODATA;
1109
1110         if (cdb[0] == VERIFY) {
1111                 if (scmd->cmd_len < 10)
1112                         goto invalid_fld;
1113                 scsi_10_lba_len(cdb, &block, &n_block);
1114         } else if (cdb[0] == VERIFY_16) {
1115                 if (scmd->cmd_len < 16)
1116                         goto invalid_fld;
1117                 scsi_16_lba_len(cdb, &block, &n_block);
1118         } else
1119                 goto invalid_fld;
1120
1121         if (!n_block)
1122                 goto nothing_to_do;
1123         if (block >= dev_sectors)
1124                 goto out_of_range;
1125         if ((block + n_block) > dev_sectors)
1126                 goto out_of_range;
1127
1128         if (dev->flags & ATA_DFLAG_LBA) {
1129                 tf->flags |= ATA_TFLAG_LBA;
1130
1131                 if (lba_28_ok(block, n_block)) {
1132                         /* use LBA28 */
1133                         tf->command = ATA_CMD_VERIFY;
1134                         tf->device |= (block >> 24) & 0xf;
1135                 } else if (lba_48_ok(block, n_block)) {
1136                         if (!(dev->flags & ATA_DFLAG_LBA48))
1137                                 goto out_of_range;
1138
1139                         /* use LBA48 */
1140                         tf->flags |= ATA_TFLAG_LBA48;
1141                         tf->command = ATA_CMD_VERIFY_EXT;
1142
1143                         tf->hob_nsect = (n_block >> 8) & 0xff;
1144
1145                         tf->hob_lbah = (block >> 40) & 0xff;
1146                         tf->hob_lbam = (block >> 32) & 0xff;
1147                         tf->hob_lbal = (block >> 24) & 0xff;
1148                 } else
1149                         /* request too large even for LBA48 */
1150                         goto out_of_range;
1151
1152                 tf->nsect = n_block & 0xff;
1153
1154                 tf->lbah = (block >> 16) & 0xff;
1155                 tf->lbam = (block >> 8) & 0xff;
1156                 tf->lbal = block & 0xff;
1157
1158                 tf->device |= ATA_LBA;
1159         } else {
1160                 /* CHS */
1161                 u32 sect, head, cyl, track;
1162
1163                 if (!lba_28_ok(block, n_block))
1164                         goto out_of_range;
1165
1166                 /* Convert LBA to CHS */
1167                 track = (u32)block / dev->sectors;
1168                 cyl   = track / dev->heads;
1169                 head  = track % dev->heads;
1170                 sect  = (u32)block % dev->sectors + 1;
1171
1172                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1173                         (u32)block, track, cyl, head, sect);
1174
1175                 /* Check whether the converted CHS can fit.
1176                    Cylinder: 0-65535
1177                    Head: 0-15
1178                    Sector: 1-255*/
1179                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1180                         goto out_of_range;
1181
1182                 tf->command = ATA_CMD_VERIFY;
1183                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1184                 tf->lbal = sect;
1185                 tf->lbam = cyl;
1186                 tf->lbah = cyl >> 8;
1187                 tf->device |= head;
1188         }
1189
1190         return 0;
1191
1192 invalid_fld:
1193         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1194         /* "Invalid field in cbd" */
1195         return 1;
1196
1197 out_of_range:
1198         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1199         /* "Logical Block Address out of range" */
1200         return 1;
1201
1202 nothing_to_do:
1203         scmd->result = SAM_STAT_GOOD;
1204         return 1;
1205 }
1206
1207 /**
1208  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1209  *      @qc: Storage for translated ATA taskfile
1210  *
1211  *      Converts any of six SCSI read/write commands into the
1212  *      ATA counterpart, including starting sector (LBA),
1213  *      sector count, and taking into account the device's LBA48
1214  *      support.
1215  *
1216  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1217  *      %WRITE_16 are currently supported.
1218  *
1219  *      LOCKING:
1220  *      spin_lock_irqsave(host lock)
1221  *
1222  *      RETURNS:
1223  *      Zero on success, non-zero on error.
1224  */
1225 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1226 {
1227         struct scsi_cmnd *scmd = qc->scsicmd;
1228         const u8 *cdb = scmd->cmnd;
1229         unsigned int tf_flags = 0;
1230         u64 block;
1231         u32 n_block;
1232         int rc;
1233
1234         if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1235                 tf_flags |= ATA_TFLAG_WRITE;
1236
1237         /* Calculate the SCSI LBA, transfer length and FUA. */
1238         switch (cdb[0]) {
1239         case READ_10:
1240         case WRITE_10:
1241                 if (unlikely(scmd->cmd_len < 10))
1242                         goto invalid_fld;
1243                 scsi_10_lba_len(cdb, &block, &n_block);
1244                 if (unlikely(cdb[1] & (1 << 3)))
1245                         tf_flags |= ATA_TFLAG_FUA;
1246                 break;
1247         case READ_6:
1248         case WRITE_6:
1249                 if (unlikely(scmd->cmd_len < 6))
1250                         goto invalid_fld;
1251                 scsi_6_lba_len(cdb, &block, &n_block);
1252
1253                 /* for 6-byte r/w commands, transfer length 0
1254                  * means 256 blocks of data, not 0 block.
1255                  */
1256                 if (!n_block)
1257                         n_block = 256;
1258                 break;
1259         case READ_16:
1260         case WRITE_16:
1261                 if (unlikely(scmd->cmd_len < 16))
1262                         goto invalid_fld;
1263                 scsi_16_lba_len(cdb, &block, &n_block);
1264                 if (unlikely(cdb[1] & (1 << 3)))
1265                         tf_flags |= ATA_TFLAG_FUA;
1266                 break;
1267         default:
1268                 DPRINTK("no-byte command\n");
1269                 goto invalid_fld;
1270         }
1271
1272         /* Check and compose ATA command */
1273         if (!n_block)
1274                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1275                  * length 0 means transfer 0 block of data.
1276                  * However, for ATA R/W commands, sector count 0 means
1277                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
1278                  *
1279                  * WARNING: one or two older ATA drives treat 0 as 0...
1280                  */
1281                 goto nothing_to_do;
1282
1283         qc->flags |= ATA_QCFLAG_IO;
1284         qc->nbytes = n_block * ATA_SECT_SIZE;
1285
1286         rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1287                              qc->tag);
1288         if (likely(rc == 0))
1289                 return 0;
1290
1291         if (rc == -ERANGE)
1292                 goto out_of_range;
1293         /* treat all other errors as -EINVAL, fall through */
1294 invalid_fld:
1295         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1296         /* "Invalid field in cbd" */
1297         return 1;
1298
1299 out_of_range:
1300         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1301         /* "Logical Block Address out of range" */
1302         return 1;
1303
1304 nothing_to_do:
1305         scmd->result = SAM_STAT_GOOD;
1306         return 1;
1307 }
1308
1309 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1310 {
1311         struct ata_port *ap = qc->ap;
1312         struct scsi_cmnd *cmd = qc->scsicmd;
1313         u8 *cdb = cmd->cmnd;
1314         int need_sense = (qc->err_mask != 0);
1315
1316         /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1317          * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1318          * cache
1319          */
1320         if (ap->ops->error_handler &&
1321             !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1322             ((qc->tf.feature == SETFEATURES_WC_ON) ||
1323              (qc->tf.feature == SETFEATURES_WC_OFF))) {
1324                 ap->eh_info.action |= ATA_EH_REVALIDATE;
1325                 ata_port_schedule_eh(ap);
1326         }
1327
1328         /* For ATA pass thru (SAT) commands, generate a sense block if
1329          * user mandated it or if there's an error.  Note that if we
1330          * generate because the user forced us to, a check condition
1331          * is generated and the ATA register values are returned
1332          * whether the command completed successfully or not. If there
1333          * was no error, SK, ASC and ASCQ will all be zero.
1334          */
1335         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1336             ((cdb[2] & 0x20) || need_sense)) {
1337                 ata_gen_passthru_sense(qc);
1338         } else {
1339                 if (!need_sense) {
1340                         cmd->result = SAM_STAT_GOOD;
1341                 } else {
1342                         /* TODO: decide which descriptor format to use
1343                          * for 48b LBA devices and call that here
1344                          * instead of the fixed desc, which is only
1345                          * good for smaller LBA (and maybe CHS?)
1346                          * devices.
1347                          */
1348                         ata_gen_ata_sense(qc);
1349                 }
1350         }
1351
1352         if (need_sense && !ap->ops->error_handler)
1353                 ata_dump_status(ap->print_id, &qc->result_tf);
1354
1355         qc->scsidone(cmd);
1356
1357         ata_qc_free(qc);
1358 }
1359
1360 /**
1361  *      ata_scmd_need_defer - Check whether we need to defer scmd
1362  *      @dev: ATA device to which the command is addressed
1363  *      @is_io: Is the command IO (and thus possibly NCQ)?
1364  *
1365  *      NCQ and non-NCQ commands cannot run together.  As upper layer
1366  *      only knows the queue depth, we are responsible for maintaining
1367  *      exclusion.  This function checks whether a new command can be
1368  *      issued to @dev.
1369  *
1370  *      LOCKING:
1371  *      spin_lock_irqsave(host lock)
1372  *
1373  *      RETURNS:
1374  *      1 if deferring is needed, 0 otherwise.
1375  */
1376 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1377 {
1378         struct ata_port *ap = dev->ap;
1379         int is_ncq = is_io && ata_ncq_enabled(dev);
1380
1381         if (is_ncq) {
1382                 if (!ata_tag_valid(ap->active_tag))
1383                         return 0;
1384         } else {
1385                 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1386                         return 0;
1387         }
1388         return 1;
1389 }
1390
1391 /**
1392  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1393  *      @dev: ATA device to which the command is addressed
1394  *      @cmd: SCSI command to execute
1395  *      @done: SCSI command completion function
1396  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1397  *
1398  *      Our ->queuecommand() function has decided that the SCSI
1399  *      command issued can be directly translated into an ATA
1400  *      command, rather than handled internally.
1401  *
1402  *      This function sets up an ata_queued_cmd structure for the
1403  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1404  *
1405  *      The xlat_func argument (actor) returns 0 if ready to execute
1406  *      ATA command, else 1 to finish translation. If 1 is returned
1407  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1408  *      to be set reflecting an error condition or clean (early)
1409  *      termination.
1410  *
1411  *      LOCKING:
1412  *      spin_lock_irqsave(host lock)
1413  *
1414  *      RETURNS:
1415  *      0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1416  *      needs to be deferred.
1417  */
1418 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1419                               void (*done)(struct scsi_cmnd *),
1420                               ata_xlat_func_t xlat_func)
1421 {
1422         struct ata_queued_cmd *qc;
1423         int is_io = xlat_func == ata_scsi_rw_xlat;
1424
1425         VPRINTK("ENTER\n");
1426
1427         if (unlikely(ata_scmd_need_defer(dev, is_io)))
1428                 goto defer;
1429
1430         qc = ata_scsi_qc_new(dev, cmd, done);
1431         if (!qc)
1432                 goto err_mem;
1433
1434         /* data is present; dma-map it */
1435         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1436             cmd->sc_data_direction == DMA_TO_DEVICE) {
1437                 if (unlikely(cmd->request_bufflen < 1)) {
1438                         ata_dev_printk(dev, KERN_WARNING,
1439                                        "WARNING: zero len r/w req\n");
1440                         goto err_did;
1441                 }
1442
1443                 if (cmd->use_sg)
1444                         ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1445                 else
1446                         ata_sg_init_one(qc, cmd->request_buffer,
1447                                         cmd->request_bufflen);
1448
1449                 qc->dma_dir = cmd->sc_data_direction;
1450         }
1451
1452         qc->complete_fn = ata_scsi_qc_complete;
1453
1454         if (xlat_func(qc))
1455                 goto early_finish;
1456
1457         /* select device, send command to hardware */
1458         ata_qc_issue(qc);
1459
1460         VPRINTK("EXIT\n");
1461         return 0;
1462
1463 early_finish:
1464         ata_qc_free(qc);
1465         done(cmd);
1466         DPRINTK("EXIT - early finish (good or error)\n");
1467         return 0;
1468
1469 err_did:
1470         ata_qc_free(qc);
1471         cmd->result = (DID_ERROR << 16);
1472         done(cmd);
1473 err_mem:
1474         DPRINTK("EXIT - internal\n");
1475         return 0;
1476
1477 defer:
1478         DPRINTK("EXIT - defer\n");
1479         return SCSI_MLQUEUE_DEVICE_BUSY;
1480 }
1481
1482 /**
1483  *      ata_scsi_rbuf_get - Map response buffer.
1484  *      @cmd: SCSI command containing buffer to be mapped.
1485  *      @buf_out: Pointer to mapped area.
1486  *
1487  *      Maps buffer contained within SCSI command @cmd.
1488  *
1489  *      LOCKING:
1490  *      spin_lock_irqsave(host lock)
1491  *
1492  *      RETURNS:
1493  *      Length of response buffer.
1494  */
1495
1496 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1497 {
1498         u8 *buf;
1499         unsigned int buflen;
1500
1501         if (cmd->use_sg) {
1502                 struct scatterlist *sg;
1503
1504                 sg = (struct scatterlist *) cmd->request_buffer;
1505                 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1506                 buflen = sg->length;
1507         } else {
1508                 buf = cmd->request_buffer;
1509                 buflen = cmd->request_bufflen;
1510         }
1511
1512         *buf_out = buf;
1513         return buflen;
1514 }
1515
1516 /**
1517  *      ata_scsi_rbuf_put - Unmap response buffer.
1518  *      @cmd: SCSI command containing buffer to be unmapped.
1519  *      @buf: buffer to unmap
1520  *
1521  *      Unmaps response buffer contained within @cmd.
1522  *
1523  *      LOCKING:
1524  *      spin_lock_irqsave(host lock)
1525  */
1526
1527 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1528 {
1529         if (cmd->use_sg) {
1530                 struct scatterlist *sg;
1531
1532                 sg = (struct scatterlist *) cmd->request_buffer;
1533                 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1534         }
1535 }
1536
1537 /**
1538  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1539  *      @args: device IDENTIFY data / SCSI command of interest.
1540  *      @actor: Callback hook for desired SCSI command simulator
1541  *
1542  *      Takes care of the hard work of simulating a SCSI command...
1543  *      Mapping the response buffer, calling the command's handler,
1544  *      and handling the handler's return value.  This return value
1545  *      indicates whether the handler wishes the SCSI command to be
1546  *      completed successfully (0), or not (in which case cmd->result
1547  *      and sense buffer are assumed to be set).
1548  *
1549  *      LOCKING:
1550  *      spin_lock_irqsave(host lock)
1551  */
1552
1553 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1554                         unsigned int (*actor) (struct ata_scsi_args *args,
1555                                            u8 *rbuf, unsigned int buflen))
1556 {
1557         u8 *rbuf;
1558         unsigned int buflen, rc;
1559         struct scsi_cmnd *cmd = args->cmd;
1560
1561         buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1562         memset(rbuf, 0, buflen);
1563         rc = actor(args, rbuf, buflen);
1564         ata_scsi_rbuf_put(cmd, rbuf);
1565
1566         if (rc == 0)
1567                 cmd->result = SAM_STAT_GOOD;
1568         args->done(cmd);
1569 }
1570
1571 /**
1572  *      ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1573  *      @idx: byte index into SCSI response buffer
1574  *      @val: value to set
1575  *
1576  *      To be used by SCSI command simulator functions.  This macros
1577  *      expects two local variables, u8 *rbuf and unsigned int buflen,
1578  *      are in scope.
1579  *
1580  *      LOCKING:
1581  *      None.
1582  */
1583 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1584                 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1585         } while (0)
1586
1587 /**
1588  *      ata_scsiop_inq_std - Simulate INQUIRY command
1589  *      @args: device IDENTIFY data / SCSI command of interest.
1590  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1591  *      @buflen: Response buffer length.
1592  *
1593  *      Returns standard device identification data associated
1594  *      with non-VPD INQUIRY command output.
1595  *
1596  *      LOCKING:
1597  *      spin_lock_irqsave(host lock)
1598  */
1599
1600 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1601                                unsigned int buflen)
1602 {
1603         u8 hdr[] = {
1604                 TYPE_DISK,
1605                 0,
1606                 0x5,    /* claim SPC-3 version compatibility */
1607                 2,
1608                 95 - 4
1609         };
1610
1611         /* set scsi removeable (RMB) bit per ata bit */
1612         if (ata_id_removeable(args->id))
1613                 hdr[1] |= (1 << 7);
1614
1615         VPRINTK("ENTER\n");
1616
1617         memcpy(rbuf, hdr, sizeof(hdr));
1618
1619         if (buflen > 35) {
1620                 memcpy(&rbuf[8], "ATA     ", 8);
1621                 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1622                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1623                 if (rbuf[32] == 0 || rbuf[32] == ' ')
1624                         memcpy(&rbuf[32], "n/a ", 4);
1625         }
1626
1627         if (buflen > 63) {
1628                 const u8 versions[] = {
1629                         0x60,   /* SAM-3 (no version claimed) */
1630
1631                         0x03,
1632                         0x20,   /* SBC-2 (no version claimed) */
1633
1634                         0x02,
1635                         0x60    /* SPC-3 (no version claimed) */
1636                 };
1637
1638                 memcpy(rbuf + 59, versions, sizeof(versions));
1639         }
1640
1641         return 0;
1642 }
1643
1644 /**
1645  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1646  *      @args: device IDENTIFY data / SCSI command of interest.
1647  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1648  *      @buflen: Response buffer length.
1649  *
1650  *      Returns list of inquiry VPD pages available.
1651  *
1652  *      LOCKING:
1653  *      spin_lock_irqsave(host lock)
1654  */
1655
1656 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1657                               unsigned int buflen)
1658 {
1659         const u8 pages[] = {
1660                 0x00,   /* page 0x00, this page */
1661                 0x80,   /* page 0x80, unit serial no page */
1662                 0x83    /* page 0x83, device ident page */
1663         };
1664         rbuf[3] = sizeof(pages);        /* number of supported VPD pages */
1665
1666         if (buflen > 6)
1667                 memcpy(rbuf + 4, pages, sizeof(pages));
1668
1669         return 0;
1670 }
1671
1672 /**
1673  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1674  *      @args: device IDENTIFY data / SCSI command of interest.
1675  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1676  *      @buflen: Response buffer length.
1677  *
1678  *      Returns ATA device serial number.
1679  *
1680  *      LOCKING:
1681  *      spin_lock_irqsave(host lock)
1682  */
1683
1684 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1685                               unsigned int buflen)
1686 {
1687         const u8 hdr[] = {
1688                 0,
1689                 0x80,                   /* this page code */
1690                 0,
1691                 ATA_ID_SERNO_LEN,       /* page len */
1692         };
1693         memcpy(rbuf, hdr, sizeof(hdr));
1694
1695         if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1696                 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1697                               ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1698
1699         return 0;
1700 }
1701
1702 /**
1703  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1704  *      @args: device IDENTIFY data / SCSI command of interest.
1705  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1706  *      @buflen: Response buffer length.
1707  *
1708  *      Yields two logical unit device identification designators:
1709  *       - vendor specific ASCII containing the ATA serial number
1710  *       - SAT defined "t10 vendor id based" containing ASCII vendor
1711  *         name ("ATA     "), model and serial numbers.
1712  *
1713  *      LOCKING:
1714  *      spin_lock_irqsave(host lock)
1715  */
1716
1717 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1718                               unsigned int buflen)
1719 {
1720         int num;
1721         const int sat_model_serial_desc_len = 68;
1722
1723         rbuf[1] = 0x83;                 /* this page code */
1724         num = 4;
1725
1726         if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1727                 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1728                 rbuf[num + 0] = 2;
1729                 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1730                 num += 4;
1731                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1732                               ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1733                 num += ATA_ID_SERNO_LEN;
1734         }
1735         if (buflen > (sat_model_serial_desc_len + num + 3)) {
1736                 /* SAT defined lu model and serial numbers descriptor */
1737                 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1738                 rbuf[num + 0] = 2;
1739                 rbuf[num + 1] = 1;
1740                 rbuf[num + 3] = sat_model_serial_desc_len;
1741                 num += 4;
1742                 memcpy(rbuf + num, "ATA     ", 8);
1743                 num += 8;
1744                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1745                               ATA_ID_PROD, ATA_ID_PROD_LEN);
1746                 num += ATA_ID_PROD_LEN;
1747                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1748                               ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1749                 num += ATA_ID_SERNO_LEN;
1750         }
1751         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
1752         return 0;
1753 }
1754
1755 /**
1756  *      ata_scsiop_noop - Command handler that simply returns success.
1757  *      @args: device IDENTIFY data / SCSI command of interest.
1758  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1759  *      @buflen: Response buffer length.
1760  *
1761  *      No operation.  Simply returns success to caller, to indicate
1762  *      that the caller should successfully complete this SCSI command.
1763  *
1764  *      LOCKING:
1765  *      spin_lock_irqsave(host lock)
1766  */
1767
1768 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1769                             unsigned int buflen)
1770 {
1771         VPRINTK("ENTER\n");
1772         return 0;
1773 }
1774
1775 /**
1776  *      ata_msense_push - Push data onto MODE SENSE data output buffer
1777  *      @ptr_io: (input/output) Location to store more output data
1778  *      @last: End of output data buffer
1779  *      @buf: Pointer to BLOB being added to output buffer
1780  *      @buflen: Length of BLOB
1781  *
1782  *      Store MODE SENSE data on an output buffer.
1783  *
1784  *      LOCKING:
1785  *      None.
1786  */
1787
1788 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1789                             const u8 *buf, unsigned int buflen)
1790 {
1791         u8 *ptr = *ptr_io;
1792
1793         if ((ptr + buflen - 1) > last)
1794                 return;
1795
1796         memcpy(ptr, buf, buflen);
1797
1798         ptr += buflen;
1799
1800         *ptr_io = ptr;
1801 }
1802
1803 /**
1804  *      ata_msense_caching - Simulate MODE SENSE caching info page
1805  *      @id: device IDENTIFY data
1806  *      @ptr_io: (input/output) Location to store more output data
1807  *      @last: End of output data buffer
1808  *
1809  *      Generate a caching info page, which conditionally indicates
1810  *      write caching to the SCSI layer, depending on device
1811  *      capabilities.
1812  *
1813  *      LOCKING:
1814  *      None.
1815  */
1816
1817 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1818                                        const u8 *last)
1819 {
1820         u8 page[CACHE_MPAGE_LEN];
1821
1822         memcpy(page, def_cache_mpage, sizeof(page));
1823         if (ata_id_wcache_enabled(id))
1824                 page[2] |= (1 << 2);    /* write cache enable */
1825         if (!ata_id_rahead_enabled(id))
1826                 page[12] |= (1 << 5);   /* disable read ahead */
1827
1828         ata_msense_push(ptr_io, last, page, sizeof(page));
1829         return sizeof(page);
1830 }
1831
1832 /**
1833  *      ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1834  *      @dev: Device associated with this MODE SENSE command
1835  *      @ptr_io: (input/output) Location to store more output data
1836  *      @last: End of output data buffer
1837  *
1838  *      Generate a generic MODE SENSE control mode page.
1839  *
1840  *      LOCKING:
1841  *      None.
1842  */
1843
1844 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1845 {
1846         ata_msense_push(ptr_io, last, def_control_mpage,
1847                         sizeof(def_control_mpage));
1848         return sizeof(def_control_mpage);
1849 }
1850
1851 /**
1852  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1853  *      @dev: Device associated with this MODE SENSE command
1854  *      @ptr_io: (input/output) Location to store more output data
1855  *      @last: End of output data buffer
1856  *
1857  *      Generate a generic MODE SENSE r/w error recovery page.
1858  *
1859  *      LOCKING:
1860  *      None.
1861  */
1862
1863 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1864 {
1865
1866         ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1867                         sizeof(def_rw_recovery_mpage));
1868         return sizeof(def_rw_recovery_mpage);
1869 }
1870
1871 /*
1872  * We can turn this into a real blacklist if it's needed, for now just
1873  * blacklist any Maxtor BANC1G10 revision firmware
1874  */
1875 static int ata_dev_supports_fua(u16 *id)
1876 {
1877         unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
1878
1879         if (!libata_fua)
1880                 return 0;
1881         if (!ata_id_has_fua(id))
1882                 return 0;
1883
1884         ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
1885         ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
1886
1887         if (strcmp(model, "Maxtor"))
1888                 return 1;
1889         if (strcmp(fw, "BANC1G10"))
1890                 return 1;
1891
1892         return 0; /* blacklisted */
1893 }
1894
1895 /**
1896  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1897  *      @args: device IDENTIFY data / SCSI command of interest.
1898  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1899  *      @buflen: Response buffer length.
1900  *
1901  *      Simulate MODE SENSE commands. Assume this is invoked for direct
1902  *      access devices (e.g. disks) only. There should be no block
1903  *      descriptor for other device types.
1904  *
1905  *      LOCKING:
1906  *      spin_lock_irqsave(host lock)
1907  */
1908
1909 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1910                                   unsigned int buflen)
1911 {
1912         struct ata_device *dev = args->dev;
1913         u8 *scsicmd = args->cmd->cmnd, *p, *last;
1914         const u8 sat_blk_desc[] = {
1915                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
1916                 0,
1917                 0, 0x2, 0x0     /* block length: 512 bytes */
1918         };
1919         u8 pg, spg;
1920         unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1921         u8 dpofua;
1922
1923         VPRINTK("ENTER\n");
1924
1925         six_byte = (scsicmd[0] == MODE_SENSE);
1926         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
1927         /*
1928          * LLBA bit in msense(10) ignored (compliant)
1929          */
1930
1931         page_control = scsicmd[2] >> 6;
1932         switch (page_control) {
1933         case 0: /* current */
1934                 break;  /* supported */
1935         case 3: /* saved */
1936                 goto saving_not_supp;
1937         case 1: /* changeable */
1938         case 2: /* defaults */
1939         default:
1940                 goto invalid_fld;
1941         }
1942
1943         if (six_byte) {
1944                 output_len = 4 + (ebd ? 8 : 0);
1945                 alloc_len = scsicmd[4];
1946         } else {
1947                 output_len = 8 + (ebd ? 8 : 0);
1948                 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1949         }
1950         minlen = (alloc_len < buflen) ? alloc_len : buflen;
1951
1952         p = rbuf + output_len;
1953         last = rbuf + minlen - 1;
1954
1955         pg = scsicmd[2] & 0x3f;
1956         spg = scsicmd[3];
1957         /*
1958          * No mode subpages supported (yet) but asking for _all_
1959          * subpages may be valid
1960          */
1961         if (spg && (spg != ALL_SUB_MPAGES))
1962                 goto invalid_fld;
1963
1964         switch(pg) {
1965         case RW_RECOVERY_MPAGE:
1966                 output_len += ata_msense_rw_recovery(&p, last);
1967                 break;
1968
1969         case CACHE_MPAGE:
1970                 output_len += ata_msense_caching(args->id, &p, last);
1971                 break;
1972
1973         case CONTROL_MPAGE: {
1974                 output_len += ata_msense_ctl_mode(&p, last);
1975                 break;
1976                 }
1977
1978         case ALL_MPAGES:
1979                 output_len += ata_msense_rw_recovery(&p, last);
1980                 output_len += ata_msense_caching(args->id, &p, last);
1981                 output_len += ata_msense_ctl_mode(&p, last);
1982                 break;
1983
1984         default:                /* invalid page code */
1985                 goto invalid_fld;
1986         }
1987
1988         if (minlen < 1)
1989                 return 0;
1990
1991         dpofua = 0;
1992         if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
1993             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1994                 dpofua = 1 << 4;
1995
1996         if (six_byte) {
1997                 output_len--;
1998                 rbuf[0] = output_len;
1999                 if (minlen > 2)
2000                         rbuf[2] |= dpofua;
2001                 if (ebd) {
2002                         if (minlen > 3)
2003                                 rbuf[3] = sizeof(sat_blk_desc);
2004                         if (minlen > 11)
2005                                 memcpy(rbuf + 4, sat_blk_desc,
2006                                        sizeof(sat_blk_desc));
2007                 }
2008         } else {
2009                 output_len -= 2;
2010                 rbuf[0] = output_len >> 8;
2011                 if (minlen > 1)
2012                         rbuf[1] = output_len;
2013                 if (minlen > 3)
2014                         rbuf[3] |= dpofua;
2015                 if (ebd) {
2016                         if (minlen > 7)
2017                                 rbuf[7] = sizeof(sat_blk_desc);
2018                         if (minlen > 15)
2019                                 memcpy(rbuf + 8, sat_blk_desc,
2020                                        sizeof(sat_blk_desc));
2021                 }
2022         }
2023         return 0;
2024
2025 invalid_fld:
2026         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2027         /* "Invalid field in cbd" */
2028         return 1;
2029
2030 saving_not_supp:
2031         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2032          /* "Saving parameters not supported" */
2033         return 1;
2034 }
2035
2036 /**
2037  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2038  *      @args: device IDENTIFY data / SCSI command of interest.
2039  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2040  *      @buflen: Response buffer length.
2041  *
2042  *      Simulate READ CAPACITY commands.
2043  *
2044  *      LOCKING:
2045  *      None.
2046  */
2047 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2048                                 unsigned int buflen)
2049 {
2050         u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2051
2052         VPRINTK("ENTER\n");
2053
2054         if (args->cmd->cmnd[0] == READ_CAPACITY) {
2055                 if (last_lba >= 0xffffffffULL)
2056                         last_lba = 0xffffffff;
2057
2058                 /* sector count, 32-bit */
2059                 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2060                 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2061                 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2062                 ATA_SCSI_RBUF_SET(3, last_lba);
2063
2064                 /* sector size */
2065                 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2066                 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2067         } else {
2068                 /* sector count, 64-bit */
2069                 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2070                 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2071                 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2072                 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2073                 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2074                 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2075                 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2076                 ATA_SCSI_RBUF_SET(7, last_lba);
2077
2078                 /* sector size */
2079                 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2080                 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2081         }
2082
2083         return 0;
2084 }
2085
2086 /**
2087  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
2088  *      @args: device IDENTIFY data / SCSI command of interest.
2089  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2090  *      @buflen: Response buffer length.
2091  *
2092  *      Simulate REPORT LUNS command.
2093  *
2094  *      LOCKING:
2095  *      spin_lock_irqsave(host lock)
2096  */
2097
2098 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2099                                    unsigned int buflen)
2100 {
2101         VPRINTK("ENTER\n");
2102         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2103
2104         return 0;
2105 }
2106
2107 /**
2108  *      ata_scsi_set_sense - Set SCSI sense data and status
2109  *      @cmd: SCSI request to be handled
2110  *      @sk: SCSI-defined sense key
2111  *      @asc: SCSI-defined additional sense code
2112  *      @ascq: SCSI-defined additional sense code qualifier
2113  *
2114  *      Helper function that builds a valid fixed format, current
2115  *      response code and the given sense key (sk), additional sense
2116  *      code (asc) and additional sense code qualifier (ascq) with
2117  *      a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2118  *      DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2119  *
2120  *      LOCKING:
2121  *      Not required
2122  */
2123
2124 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2125 {
2126         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2127
2128         cmd->sense_buffer[0] = 0x70;    /* fixed format, current */
2129         cmd->sense_buffer[2] = sk;
2130         cmd->sense_buffer[7] = 18 - 8;  /* additional sense length */
2131         cmd->sense_buffer[12] = asc;
2132         cmd->sense_buffer[13] = ascq;
2133 }
2134
2135 /**
2136  *      ata_scsi_badcmd - End a SCSI request with an error
2137  *      @cmd: SCSI request to be handled
2138  *      @done: SCSI command completion function
2139  *      @asc: SCSI-defined additional sense code
2140  *      @ascq: SCSI-defined additional sense code qualifier
2141  *
2142  *      Helper function that completes a SCSI command with
2143  *      %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2144  *      and the specified additional sense codes.
2145  *
2146  *      LOCKING:
2147  *      spin_lock_irqsave(host lock)
2148  */
2149
2150 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2151 {
2152         DPRINTK("ENTER\n");
2153         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2154
2155         done(cmd);
2156 }
2157
2158 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2159 {
2160         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2161                 /* FIXME: not quite right; we don't want the
2162                  * translation of taskfile registers into
2163                  * a sense descriptors, since that's only
2164                  * correct for ATA, not ATAPI
2165                  */
2166                 ata_gen_passthru_sense(qc);
2167         }
2168
2169         qc->scsidone(qc->scsicmd);
2170         ata_qc_free(qc);
2171 }
2172
2173 /* is it pointless to prefer PIO for "safety reasons"? */
2174 static inline int ata_pio_use_silly(struct ata_port *ap)
2175 {
2176         return (ap->flags & ATA_FLAG_PIO_DMA);
2177 }
2178
2179 static void atapi_request_sense(struct ata_queued_cmd *qc)
2180 {
2181         struct ata_port *ap = qc->ap;
2182         struct scsi_cmnd *cmd = qc->scsicmd;
2183
2184         DPRINTK("ATAPI request sense\n");
2185
2186         /* FIXME: is this needed? */
2187         memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2188
2189         ap->ops->tf_read(ap, &qc->tf);
2190
2191         /* fill these in, for the case where they are -not- overwritten */
2192         cmd->sense_buffer[0] = 0x70;
2193         cmd->sense_buffer[2] = qc->tf.feature >> 4;
2194
2195         ata_qc_reinit(qc);
2196
2197         ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2198         qc->dma_dir = DMA_FROM_DEVICE;
2199
2200         memset(&qc->cdb, 0, qc->dev->cdb_len);
2201         qc->cdb[0] = REQUEST_SENSE;
2202         qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2203
2204         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2205         qc->tf.command = ATA_CMD_PACKET;
2206
2207         if (ata_pio_use_silly(ap)) {
2208                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2209                 qc->tf.feature |= ATAPI_PKT_DMA;
2210         } else {
2211                 qc->tf.protocol = ATA_PROT_ATAPI;
2212                 qc->tf.lbam = (8 * 1024) & 0xff;
2213                 qc->tf.lbah = (8 * 1024) >> 8;
2214         }
2215         qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2216
2217         qc->complete_fn = atapi_sense_complete;
2218
2219         ata_qc_issue(qc);
2220
2221         DPRINTK("EXIT\n");
2222 }
2223
2224 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2225 {
2226         struct scsi_cmnd *cmd = qc->scsicmd;
2227         unsigned int err_mask = qc->err_mask;
2228
2229         VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2230
2231         /* handle completion from new EH */
2232         if (unlikely(qc->ap->ops->error_handler &&
2233                      (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2234
2235                 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2236                         /* FIXME: not quite right; we don't want the
2237                          * translation of taskfile registers into a
2238                          * sense descriptors, since that's only
2239                          * correct for ATA, not ATAPI
2240                          */
2241                         ata_gen_passthru_sense(qc);
2242                 }
2243
2244                 /* SCSI EH automatically locks door if sdev->locked is
2245                  * set.  Sometimes door lock request continues to
2246                  * fail, for example, when no media is present.  This
2247                  * creates a loop - SCSI EH issues door lock which
2248                  * fails and gets invoked again to acquire sense data
2249                  * for the failed command.
2250                  *
2251                  * If door lock fails, always clear sdev->locked to
2252                  * avoid this infinite loop.
2253                  */
2254                 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2255                         qc->dev->sdev->locked = 0;
2256
2257                 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2258                 qc->scsidone(cmd);
2259                 ata_qc_free(qc);
2260                 return;
2261         }
2262
2263         /* successful completion or old EH failure path */
2264         if (unlikely(err_mask & AC_ERR_DEV)) {
2265                 cmd->result = SAM_STAT_CHECK_CONDITION;
2266                 atapi_request_sense(qc);
2267                 return;
2268         } else if (unlikely(err_mask)) {
2269                 /* FIXME: not quite right; we don't want the
2270                  * translation of taskfile registers into
2271                  * a sense descriptors, since that's only
2272                  * correct for ATA, not ATAPI
2273                  */
2274                 ata_gen_passthru_sense(qc);
2275         } else {
2276                 u8 *scsicmd = cmd->cmnd;
2277
2278                 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2279                         u8 *buf = NULL;
2280                         unsigned int buflen;
2281
2282                         buflen = ata_scsi_rbuf_get(cmd, &buf);
2283
2284         /* ATAPI devices typically report zero for their SCSI version,
2285          * and sometimes deviate from the spec WRT response data
2286          * format.  If SCSI version is reported as zero like normal,
2287          * then we make the following fixups:  1) Fake MMC-5 version,
2288          * to indicate to the Linux scsi midlayer this is a modern
2289          * device.  2) Ensure response data format / ATAPI information
2290          * are always correct.
2291          */
2292                         if (buf[2] == 0) {
2293                                 buf[2] = 0x5;
2294                                 buf[3] = 0x32;
2295                         }
2296
2297                         ata_scsi_rbuf_put(cmd, buf);
2298                 }
2299
2300                 cmd->result = SAM_STAT_GOOD;
2301         }
2302
2303         qc->scsidone(cmd);
2304         ata_qc_free(qc);
2305 }
2306 /**
2307  *      atapi_xlat - Initialize PACKET taskfile
2308  *      @qc: command structure to be initialized
2309  *
2310  *      LOCKING:
2311  *      spin_lock_irqsave(host lock)
2312  *
2313  *      RETURNS:
2314  *      Zero on success, non-zero on failure.
2315  */
2316 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2317 {
2318         struct scsi_cmnd *scmd = qc->scsicmd;
2319         struct ata_device *dev = qc->dev;
2320         int using_pio = (dev->flags & ATA_DFLAG_PIO);
2321         int nodata = (scmd->sc_data_direction == DMA_NONE);
2322
2323         if (!using_pio)
2324                 /* Check whether ATAPI DMA is safe */
2325                 if (ata_check_atapi_dma(qc))
2326                         using_pio = 1;
2327
2328         memset(qc->cdb, 0, dev->cdb_len);
2329         memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2330
2331         qc->complete_fn = atapi_qc_complete;
2332
2333         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2334         if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2335                 qc->tf.flags |= ATA_TFLAG_WRITE;
2336                 DPRINTK("direction: write\n");
2337         }
2338
2339         qc->tf.command = ATA_CMD_PACKET;
2340
2341         /* no data, or PIO data xfer */
2342         if (using_pio || nodata) {
2343                 if (nodata)
2344                         qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2345                 else
2346                         qc->tf.protocol = ATA_PROT_ATAPI;
2347                 qc->tf.lbam = (8 * 1024) & 0xff;
2348                 qc->tf.lbah = (8 * 1024) >> 8;
2349         }
2350
2351         /* DMA data xfer */
2352         else {
2353                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2354                 qc->tf.feature |= ATAPI_PKT_DMA;
2355
2356                 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2357                         /* some SATA bridges need us to indicate data xfer direction */
2358                         qc->tf.feature |= ATAPI_DMADIR;
2359         }
2360
2361         qc->nbytes = scmd->request_bufflen;
2362
2363         return 0;
2364 }
2365
2366 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2367 {
2368         if (likely(id < ATA_MAX_DEVICES))
2369                 return &ap->device[id];
2370         return NULL;
2371 }
2372
2373 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2374                                         const struct scsi_device *scsidev)
2375 {
2376         /* skip commands not addressed to targets we simulate */
2377         if (unlikely(scsidev->channel || scsidev->lun))
2378                 return NULL;
2379
2380         return ata_find_dev(ap, scsidev->id);
2381 }
2382
2383 /**
2384  *      ata_scsi_dev_enabled - determine if device is enabled
2385  *      @dev: ATA device
2386  *
2387  *      Determine if commands should be sent to the specified device.
2388  *
2389  *      LOCKING:
2390  *      spin_lock_irqsave(host lock)
2391  *
2392  *      RETURNS:
2393  *      0 if commands are not allowed / 1 if commands are allowed
2394  */
2395
2396 static int ata_scsi_dev_enabled(struct ata_device *dev)
2397 {
2398         if (unlikely(!ata_dev_enabled(dev)))
2399                 return 0;
2400
2401         if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2402                 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2403                         ata_dev_printk(dev, KERN_WARNING,
2404                                        "WARNING: ATAPI is %s, device ignored.\n",
2405                                        atapi_enabled ? "not supported with this driver" : "disabled");
2406                         return 0;
2407                 }
2408         }
2409
2410         return 1;
2411 }
2412
2413 /**
2414  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2415  *      @ap: ATA port to which the device is attached
2416  *      @scsidev: SCSI device from which we derive the ATA device
2417  *
2418  *      Given various information provided in struct scsi_cmnd,
2419  *      map that onto an ATA bus, and using that mapping
2420  *      determine which ata_device is associated with the
2421  *      SCSI command to be sent.
2422  *
2423  *      LOCKING:
2424  *      spin_lock_irqsave(host lock)
2425  *
2426  *      RETURNS:
2427  *      Associated ATA device, or %NULL if not found.
2428  */
2429 static struct ata_device *
2430 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2431 {
2432         struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2433
2434         if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2435                 return NULL;
2436
2437         return dev;
2438 }
2439
2440 /*
2441  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2442  *      @byte1: Byte 1 from pass-thru CDB.
2443  *
2444  *      RETURNS:
2445  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2446  */
2447 static u8
2448 ata_scsi_map_proto(u8 byte1)
2449 {
2450         switch((byte1 & 0x1e) >> 1) {
2451                 case 3:         /* Non-data */
2452                         return ATA_PROT_NODATA;
2453
2454                 case 6:         /* DMA */
2455                         return ATA_PROT_DMA;
2456
2457                 case 4:         /* PIO Data-in */
2458                 case 5:         /* PIO Data-out */
2459                         return ATA_PROT_PIO;
2460
2461                 case 10:        /* Device Reset */
2462                 case 0:         /* Hard Reset */
2463                 case 1:         /* SRST */
2464                 case 2:         /* Bus Idle */
2465                 case 7:         /* Packet */
2466                 case 8:         /* DMA Queued */
2467                 case 9:         /* Device Diagnostic */
2468                 case 11:        /* UDMA Data-in */
2469                 case 12:        /* UDMA Data-Out */
2470                 case 13:        /* FPDMA */
2471                 default:        /* Reserved */
2472                         break;
2473         }
2474
2475         return ATA_PROT_UNKNOWN;
2476 }
2477
2478 /**
2479  *      ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2480  *      @qc: command structure to be initialized
2481  *
2482  *      Handles either 12 or 16-byte versions of the CDB.
2483  *
2484  *      RETURNS:
2485  *      Zero on success, non-zero on failure.
2486  */
2487 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2488 {
2489         struct ata_taskfile *tf = &(qc->tf);
2490         struct scsi_cmnd *scmd = qc->scsicmd;
2491         struct ata_device *dev = qc->dev;
2492         const u8 *cdb = scmd->cmnd;
2493
2494         if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2495                 goto invalid_fld;
2496
2497         /* We may not issue DMA commands if no DMA mode is set */
2498         if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2499                 goto invalid_fld;
2500
2501         if (cdb[1] & 0xe0)
2502                 /* PIO multi not supported yet */
2503                 goto invalid_fld;
2504
2505         /*
2506          * 12 and 16 byte CDBs use different offsets to
2507          * provide the various register values.
2508          */
2509         if (cdb[0] == ATA_16) {
2510                 /*
2511                  * 16-byte CDB - may contain extended commands.
2512                  *
2513                  * If that is the case, copy the upper byte register values.
2514                  */
2515                 if (cdb[1] & 0x01) {
2516                         tf->hob_feature = cdb[3];
2517                         tf->hob_nsect = cdb[5];
2518                         tf->hob_lbal = cdb[7];
2519                         tf->hob_lbam = cdb[9];
2520                         tf->hob_lbah = cdb[11];
2521                         tf->flags |= ATA_TFLAG_LBA48;
2522                 } else
2523                         tf->flags &= ~ATA_TFLAG_LBA48;
2524
2525                 /*
2526                  * Always copy low byte, device and command registers.
2527                  */
2528                 tf->feature = cdb[4];
2529                 tf->nsect = cdb[6];
2530                 tf->lbal = cdb[8];
2531                 tf->lbam = cdb[10];
2532                 tf->lbah = cdb[12];
2533                 tf->device = cdb[13];
2534                 tf->command = cdb[14];
2535         } else {
2536                 /*
2537                  * 12-byte CDB - incapable of extended commands.
2538                  */
2539                 tf->flags &= ~ATA_TFLAG_LBA48;
2540
2541                 tf->feature = cdb[3];
2542                 tf->nsect = cdb[4];
2543                 tf->lbal = cdb[5];
2544                 tf->lbam = cdb[6];
2545                 tf->lbah = cdb[7];
2546                 tf->device = cdb[8];
2547                 tf->command = cdb[9];
2548         }
2549         /*
2550          * If slave is possible, enforce correct master/slave bit
2551         */
2552         if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2553                 tf->device = qc->dev->devno ?
2554                         tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2555
2556         /* READ/WRITE LONG use a non-standard sect_size */
2557         qc->sect_size = ATA_SECT_SIZE;
2558         switch (tf->command) {
2559         case ATA_CMD_READ_LONG:
2560         case ATA_CMD_READ_LONG_ONCE:
2561         case ATA_CMD_WRITE_LONG:
2562         case ATA_CMD_WRITE_LONG_ONCE:
2563                 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2564                         goto invalid_fld;
2565                 qc->sect_size = scmd->request_bufflen;
2566         }
2567
2568         /*
2569          * Filter SET_FEATURES - XFER MODE command -- otherwise,
2570          * SET_FEATURES - XFER MODE must be preceded/succeeded
2571          * by an update to hardware-specific registers for each
2572          * controller (i.e. the reason for ->set_piomode(),
2573          * ->set_dmamode(), and ->post_set_mode() hooks).
2574          */
2575         if ((tf->command == ATA_CMD_SET_FEATURES)
2576          && (tf->feature == SETFEATURES_XFER))
2577                 goto invalid_fld;
2578
2579         /*
2580          * Set flags so that all registers will be written,
2581          * and pass on write indication (used for PIO/DMA
2582          * setup.)
2583          */
2584         tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2585
2586         if (scmd->sc_data_direction == DMA_TO_DEVICE)
2587                 tf->flags |= ATA_TFLAG_WRITE;
2588
2589         /*
2590          * Set transfer length.
2591          *
2592          * TODO: find out if we need to do more here to
2593          *       cover scatter/gather case.
2594          */
2595         qc->nbytes = scmd->request_bufflen;
2596
2597         /* request result TF */
2598         qc->flags |= ATA_QCFLAG_RESULT_TF;
2599
2600         return 0;
2601
2602  invalid_fld:
2603         ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2604         /* "Invalid field in cdb" */
2605         return 1;
2606 }
2607
2608 /**
2609  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
2610  *      @dev: ATA device
2611  *      @cmd: SCSI command opcode to consider
2612  *
2613  *      Look up the SCSI command given, and determine whether the
2614  *      SCSI command is to be translated or simulated.
2615  *
2616  *      RETURNS:
2617  *      Pointer to translation function if possible, %NULL if not.
2618  */
2619
2620 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2621 {
2622         switch (cmd) {
2623         case READ_6:
2624         case READ_10:
2625         case READ_16:
2626
2627         case WRITE_6:
2628         case WRITE_10:
2629         case WRITE_16:
2630                 return ata_scsi_rw_xlat;
2631
2632         case SYNCHRONIZE_CACHE:
2633                 if (ata_try_flush_cache(dev))
2634                         return ata_scsi_flush_xlat;
2635                 break;
2636
2637         case VERIFY:
2638         case VERIFY_16:
2639                 return ata_scsi_verify_xlat;
2640
2641         case ATA_12:
2642         case ATA_16:
2643                 return ata_scsi_pass_thru;
2644
2645         case START_STOP:
2646                 return ata_scsi_start_stop_xlat;
2647         }
2648
2649         return NULL;
2650 }
2651
2652 /**
2653  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2654  *      @ap: ATA port to which the command was being sent
2655  *      @cmd: SCSI command to dump
2656  *
2657  *      Prints the contents of a SCSI command via printk().
2658  */
2659
2660 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2661                                      struct scsi_cmnd *cmd)
2662 {
2663 #ifdef ATA_DEBUG
2664         struct scsi_device *scsidev = cmd->device;
2665         u8 *scsicmd = cmd->cmnd;
2666
2667         DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2668                 ap->print_id,
2669                 scsidev->channel, scsidev->id, scsidev->lun,
2670                 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2671                 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2672                 scsicmd[8]);
2673 #endif
2674 }
2675
2676 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2677                                       void (*done)(struct scsi_cmnd *),
2678                                       struct ata_device *dev)
2679 {
2680         int rc = 0;
2681
2682         if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len)) {
2683                 DPRINTK("bad CDB len=%u, max=%u\n",
2684                         scmd->cmd_len, dev->cdb_len);
2685                 scmd->result = DID_ERROR << 16;
2686                 done(scmd);
2687                 return 0;
2688         }
2689
2690         if (dev->class == ATA_DEV_ATA) {
2691                 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2692                                                               scmd->cmnd[0]);
2693
2694                 if (xlat_func)
2695                         rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2696                 else
2697                         ata_scsi_simulate(dev, scmd, done);
2698         } else
2699                 rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2700
2701         return rc;
2702 }
2703
2704 /**
2705  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2706  *      @cmd: SCSI command to be sent
2707  *      @done: Completion function, called when command is complete
2708  *
2709  *      In some cases, this function translates SCSI commands into
2710  *      ATA taskfiles, and queues the taskfiles to be sent to
2711  *      hardware.  In other cases, this function simulates a
2712  *      SCSI device by evaluating and responding to certain
2713  *      SCSI commands.  This creates the overall effect of
2714  *      ATA and ATAPI devices appearing as SCSI devices.
2715  *
2716  *      LOCKING:
2717  *      Releases scsi-layer-held lock, and obtains host lock.
2718  *
2719  *      RETURNS:
2720  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2721  *      0 otherwise.
2722  */
2723 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2724 {
2725         struct ata_port *ap;
2726         struct ata_device *dev;
2727         struct scsi_device *scsidev = cmd->device;
2728         struct Scsi_Host *shost = scsidev->host;
2729         int rc = 0;
2730
2731         ap = ata_shost_to_port(shost);
2732
2733         spin_unlock(shost->host_lock);
2734         spin_lock(ap->lock);
2735
2736         ata_scsi_dump_cdb(ap, cmd);
2737
2738         dev = ata_scsi_find_dev(ap, scsidev);
2739         if (likely(dev))
2740                 rc = __ata_scsi_queuecmd(cmd, done, dev);
2741         else {
2742                 cmd->result = (DID_BAD_TARGET << 16);
2743                 done(cmd);
2744         }
2745
2746         spin_unlock(ap->lock);
2747         spin_lock(shost->host_lock);
2748         return rc;
2749 }
2750
2751 /**
2752  *      ata_scsi_simulate - simulate SCSI command on ATA device
2753  *      @dev: the target device
2754  *      @cmd: SCSI command being sent to device.
2755  *      @done: SCSI command completion function.
2756  *
2757  *      Interprets and directly executes a select list of SCSI commands
2758  *      that can be handled internally.
2759  *
2760  *      LOCKING:
2761  *      spin_lock_irqsave(host lock)
2762  */
2763
2764 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2765                       void (*done)(struct scsi_cmnd *))
2766 {
2767         struct ata_scsi_args args;
2768         const u8 *scsicmd = cmd->cmnd;
2769
2770         args.dev = dev;
2771         args.id = dev->id;
2772         args.cmd = cmd;
2773         args.done = done;
2774
2775         switch(scsicmd[0]) {
2776                 /* no-op's, complete with success */
2777                 case SYNCHRONIZE_CACHE:
2778                 case REZERO_UNIT:
2779                 case SEEK_6:
2780                 case SEEK_10:
2781                 case TEST_UNIT_READY:
2782                 case FORMAT_UNIT:               /* FIXME: correct? */
2783                 case SEND_DIAGNOSTIC:           /* FIXME: correct? */
2784                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2785                         break;
2786
2787                 case INQUIRY:
2788                         if (scsicmd[1] & 2)                /* is CmdDt set?  */
2789                                 ata_scsi_invalid_field(cmd, done);
2790                         else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
2791                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2792                         else if (scsicmd[2] == 0x00)
2793                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2794                         else if (scsicmd[2] == 0x80)
2795                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2796                         else if (scsicmd[2] == 0x83)
2797                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2798                         else
2799                                 ata_scsi_invalid_field(cmd, done);
2800                         break;
2801
2802                 case MODE_SENSE:
2803                 case MODE_SENSE_10:
2804                         ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2805                         break;
2806
2807                 case MODE_SELECT:       /* unconditionally return */
2808                 case MODE_SELECT_10:    /* bad-field-in-cdb */
2809                         ata_scsi_invalid_field(cmd, done);
2810                         break;
2811
2812                 case READ_CAPACITY:
2813                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2814                         break;
2815
2816                 case SERVICE_ACTION_IN:
2817                         if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2818                                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2819                         else
2820                                 ata_scsi_invalid_field(cmd, done);
2821                         break;
2822
2823                 case REPORT_LUNS:
2824                         ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2825                         break;
2826
2827                 /* mandatory commands we haven't implemented yet */
2828                 case REQUEST_SENSE:
2829
2830                 /* all other commands */
2831                 default:
2832                         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2833                         /* "Invalid command operation code" */
2834                         done(cmd);
2835                         break;
2836         }
2837 }
2838
2839 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
2840 {
2841         int i, rc;
2842
2843         for (i = 0; i < host->n_ports; i++) {
2844                 struct ata_port *ap = host->ports[i];
2845                 struct Scsi_Host *shost;
2846
2847                 rc = -ENOMEM;
2848                 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
2849                 if (!shost)
2850                         goto err_alloc;
2851
2852                 *(struct ata_port **)&shost->hostdata[0] = ap;
2853                 ap->scsi_host = shost;
2854
2855                 shost->transportt = &ata_scsi_transport_template;
2856                 shost->unique_id = ap->print_id;
2857                 shost->max_id = 16;
2858                 shost->max_lun = 1;
2859                 shost->max_channel = 1;
2860                 shost->max_cmd_len = 16;
2861
2862                 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
2863                 if (rc)
2864                         goto err_add;
2865         }
2866
2867         return 0;
2868
2869  err_add:
2870         scsi_host_put(host->ports[i]->scsi_host);
2871  err_alloc:
2872         while (--i >= 0) {
2873                 struct Scsi_Host *shost = host->ports[i]->scsi_host;
2874
2875                 scsi_remove_host(shost);
2876                 scsi_host_put(shost);
2877         }
2878         return rc;
2879 }
2880
2881 void ata_scsi_scan_host(struct ata_port *ap)
2882 {
2883         unsigned int i;
2884
2885         if (ap->flags & ATA_FLAG_DISABLED)
2886                 return;
2887
2888         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2889                 struct ata_device *dev = &ap->device[i];
2890                 struct scsi_device *sdev;
2891
2892                 if (!ata_dev_enabled(dev) || dev->sdev)
2893                         continue;
2894
2895                 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2896                 if (!IS_ERR(sdev)) {
2897                         dev->sdev = sdev;
2898                         scsi_device_put(sdev);
2899                 }
2900         }
2901 }
2902
2903 /**
2904  *      ata_scsi_offline_dev - offline attached SCSI device
2905  *      @dev: ATA device to offline attached SCSI device for
2906  *
2907  *      This function is called from ata_eh_hotplug() and responsible
2908  *      for taking the SCSI device attached to @dev offline.  This
2909  *      function is called with host lock which protects dev->sdev
2910  *      against clearing.
2911  *
2912  *      LOCKING:
2913  *      spin_lock_irqsave(host lock)
2914  *
2915  *      RETURNS:
2916  *      1 if attached SCSI device exists, 0 otherwise.
2917  */
2918 int ata_scsi_offline_dev(struct ata_device *dev)
2919 {
2920         if (dev->sdev) {
2921                 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2922                 return 1;
2923         }
2924         return 0;
2925 }
2926
2927 /**
2928  *      ata_scsi_remove_dev - remove attached SCSI device
2929  *      @dev: ATA device to remove attached SCSI device for
2930  *
2931  *      This function is called from ata_eh_scsi_hotplug() and
2932  *      responsible for removing the SCSI device attached to @dev.
2933  *
2934  *      LOCKING:
2935  *      Kernel thread context (may sleep).
2936  */
2937 static void ata_scsi_remove_dev(struct ata_device *dev)
2938 {
2939         struct ata_port *ap = dev->ap;
2940         struct scsi_device *sdev;
2941         unsigned long flags;
2942
2943         /* Alas, we need to grab scan_mutex to ensure SCSI device
2944          * state doesn't change underneath us and thus
2945          * scsi_device_get() always succeeds.  The mutex locking can
2946          * be removed if there is __scsi_device_get() interface which
2947          * increments reference counts regardless of device state.
2948          */
2949         mutex_lock(&ap->scsi_host->scan_mutex);
2950         spin_lock_irqsave(ap->lock, flags);
2951
2952         /* clearing dev->sdev is protected by host lock */
2953         sdev = dev->sdev;
2954         dev->sdev = NULL;
2955
2956         if (sdev) {
2957                 /* If user initiated unplug races with us, sdev can go
2958                  * away underneath us after the host lock and
2959                  * scan_mutex are released.  Hold onto it.
2960                  */
2961                 if (scsi_device_get(sdev) == 0) {
2962                         /* The following ensures the attached sdev is
2963                          * offline on return from ata_scsi_offline_dev()
2964                          * regardless it wins or loses the race
2965                          * against this function.
2966                          */
2967                         scsi_device_set_state(sdev, SDEV_OFFLINE);
2968                 } else {
2969                         WARN_ON(1);
2970                         sdev = NULL;
2971                 }
2972         }
2973
2974         spin_unlock_irqrestore(ap->lock, flags);
2975         mutex_unlock(&ap->scsi_host->scan_mutex);
2976
2977         if (sdev) {
2978                 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
2979                                sdev->sdev_gendev.bus_id);
2980
2981                 scsi_remove_device(sdev);
2982                 scsi_device_put(sdev);
2983         }
2984 }
2985
2986 /**
2987  *      ata_scsi_hotplug - SCSI part of hotplug
2988  *      @work: Pointer to ATA port to perform SCSI hotplug on
2989  *
2990  *      Perform SCSI part of hotplug.  It's executed from a separate
2991  *      workqueue after EH completes.  This is necessary because SCSI
2992  *      hot plugging requires working EH and hot unplugging is
2993  *      synchronized with hot plugging with a mutex.
2994  *
2995  *      LOCKING:
2996  *      Kernel thread context (may sleep).
2997  */
2998 void ata_scsi_hotplug(struct work_struct *work)
2999 {
3000         struct ata_port *ap =
3001                 container_of(work, struct ata_port, hotplug_task.work);
3002         int i;
3003
3004         if (ap->pflags & ATA_PFLAG_UNLOADING) {
3005                 DPRINTK("ENTER/EXIT - unloading\n");
3006                 return;
3007         }
3008
3009         DPRINTK("ENTER\n");
3010
3011         /* unplug detached devices */
3012         for (i = 0; i < ATA_MAX_DEVICES; i++) {
3013                 struct ata_device *dev = &ap->device[i];
3014                 unsigned long flags;
3015
3016                 if (!(dev->flags & ATA_DFLAG_DETACHED))
3017                         continue;
3018
3019                 spin_lock_irqsave(ap->lock, flags);
3020                 dev->flags &= ~ATA_DFLAG_DETACHED;
3021                 spin_unlock_irqrestore(ap->lock, flags);
3022
3023                 ata_scsi_remove_dev(dev);
3024         }
3025
3026         /* scan for new ones */
3027         ata_scsi_scan_host(ap);
3028
3029         /* If we scanned while EH was in progress, scan would have
3030          * failed silently.  Requeue if there are enabled but
3031          * unattached devices.
3032          */
3033         for (i = 0; i < ATA_MAX_DEVICES; i++) {
3034                 struct ata_device *dev = &ap->device[i];
3035                 if (ata_dev_enabled(dev) && !dev->sdev) {
3036                         queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3037                                 round_jiffies_relative(HZ));
3038                         break;
3039                 }
3040         }
3041
3042         DPRINTK("EXIT\n");
3043 }
3044
3045 /**
3046  *      ata_scsi_user_scan - indication for user-initiated bus scan
3047  *      @shost: SCSI host to scan
3048  *      @channel: Channel to scan
3049  *      @id: ID to scan
3050  *      @lun: LUN to scan
3051  *
3052  *      This function is called when user explicitly requests bus
3053  *      scan.  Set probe pending flag and invoke EH.
3054  *
3055  *      LOCKING:
3056  *      SCSI layer (we don't care)
3057  *
3058  *      RETURNS:
3059  *      Zero.
3060  */
3061 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3062                               unsigned int id, unsigned int lun)
3063 {
3064         struct ata_port *ap = ata_shost_to_port(shost);
3065         unsigned long flags;
3066         int rc = 0;
3067
3068         if (!ap->ops->error_handler)
3069                 return -EOPNOTSUPP;
3070
3071         if ((channel != SCAN_WILD_CARD && channel != 0) ||
3072             (lun != SCAN_WILD_CARD && lun != 0))
3073                 return -EINVAL;
3074
3075         spin_lock_irqsave(ap->lock, flags);
3076
3077         if (id == SCAN_WILD_CARD) {
3078                 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3079                 ap->eh_info.action |= ATA_EH_SOFTRESET;
3080         } else {
3081                 struct ata_device *dev = ata_find_dev(ap, id);
3082
3083                 if (dev) {
3084                         ap->eh_info.probe_mask |= 1 << dev->devno;
3085                         ap->eh_info.action |= ATA_EH_SOFTRESET;
3086                         ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3087                 } else
3088                         rc = -EINVAL;
3089         }
3090
3091         if (rc == 0) {
3092                 ata_port_schedule_eh(ap);
3093                 spin_unlock_irqrestore(ap->lock, flags);
3094                 ata_port_wait_eh(ap);
3095         } else
3096                 spin_unlock_irqrestore(ap->lock, flags);
3097
3098         return rc;
3099 }
3100
3101 /**
3102  *      ata_scsi_dev_rescan - initiate scsi_rescan_device()
3103  *      @work: Pointer to ATA port to perform scsi_rescan_device()
3104  *
3105  *      After ATA pass thru (SAT) commands are executed successfully,
3106  *      libata need to propagate the changes to SCSI layer.  This
3107  *      function must be executed from ata_aux_wq such that sdev
3108  *      attach/detach don't race with rescan.
3109  *
3110  *      LOCKING:
3111  *      Kernel thread context (may sleep).
3112  */
3113 void ata_scsi_dev_rescan(struct work_struct *work)
3114 {
3115         struct ata_port *ap =
3116                 container_of(work, struct ata_port, scsi_rescan_task);
3117         unsigned long flags;
3118         unsigned int i;
3119
3120         spin_lock_irqsave(ap->lock, flags);
3121
3122         for (i = 0; i < ATA_MAX_DEVICES; i++) {
3123                 struct ata_device *dev = &ap->device[i];
3124                 struct scsi_device *sdev = dev->sdev;
3125
3126                 if (!ata_dev_enabled(dev) || !sdev)
3127                         continue;
3128                 if (scsi_device_get(sdev))
3129                         continue;
3130
3131                 spin_unlock_irqrestore(ap->lock, flags);
3132                 scsi_rescan_device(&(sdev->sdev_gendev));
3133                 scsi_device_put(sdev);
3134                 spin_lock_irqsave(ap->lock, flags);
3135         }
3136
3137         spin_unlock_irqrestore(ap->lock, flags);
3138 }
3139
3140 /**
3141  *      ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3142  *      @host: ATA host container for all SAS ports
3143  *      @port_info: Information from low-level host driver
3144  *      @shost: SCSI host that the scsi device is attached to
3145  *
3146  *      LOCKING:
3147  *      PCI/etc. bus probe sem.
3148  *
3149  *      RETURNS:
3150  *      ata_port pointer on success / NULL on failure.
3151  */
3152
3153 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3154                                     struct ata_port_info *port_info,
3155                                     struct Scsi_Host *shost)
3156 {
3157         struct ata_port *ap;
3158
3159         ap = ata_port_alloc(host);
3160         if (!ap)
3161                 return NULL;
3162
3163         ap->port_no = 0;
3164         ap->lock = shost->host_lock;
3165         ap->pio_mask = port_info->pio_mask;
3166         ap->mwdma_mask = port_info->mwdma_mask;
3167         ap->udma_mask = port_info->udma_mask;
3168         ap->flags |= port_info->flags;
3169         ap->ops = port_info->port_ops;
3170         ap->cbl = ATA_CBL_SATA;
3171
3172         return ap;
3173 }
3174 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3175
3176 /**
3177  *      ata_sas_port_start - Set port up for dma.
3178  *      @ap: Port to initialize
3179  *
3180  *      Called just after data structures for each port are
3181  *      initialized.  Allocates DMA pad.
3182  *
3183  *      May be used as the port_start() entry in ata_port_operations.
3184  *
3185  *      LOCKING:
3186  *      Inherited from caller.
3187  */
3188 int ata_sas_port_start(struct ata_port *ap)
3189 {
3190         return ata_pad_alloc(ap, ap->dev);
3191 }
3192 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3193
3194 /**
3195  *      ata_port_stop - Undo ata_sas_port_start()
3196  *      @ap: Port to shut down
3197  *
3198  *      Frees the DMA pad.
3199  *
3200  *      May be used as the port_stop() entry in ata_port_operations.
3201  *
3202  *      LOCKING:
3203  *      Inherited from caller.
3204  */
3205
3206 void ata_sas_port_stop(struct ata_port *ap)
3207 {
3208         ata_pad_free(ap, ap->dev);
3209 }
3210 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3211
3212 /**
3213  *      ata_sas_port_init - Initialize a SATA device
3214  *      @ap: SATA port to initialize
3215  *
3216  *      LOCKING:
3217  *      PCI/etc. bus probe sem.
3218  *
3219  *      RETURNS:
3220  *      Zero on success, non-zero on error.
3221  */
3222
3223 int ata_sas_port_init(struct ata_port *ap)
3224 {
3225         int rc = ap->ops->port_start(ap);
3226
3227         if (!rc) {
3228                 ap->print_id = ata_print_id++;
3229                 rc = ata_bus_probe(ap);
3230         }
3231
3232         return rc;
3233 }
3234 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3235
3236 /**
3237  *      ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3238  *      @ap: SATA port to destroy
3239  *
3240  */
3241
3242 void ata_sas_port_destroy(struct ata_port *ap)
3243 {
3244         if (ap->ops->port_stop)
3245                 ap->ops->port_stop(ap);
3246         kfree(ap);
3247 }
3248 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3249
3250 /**
3251  *      ata_sas_slave_configure - Default slave_config routine for libata devices
3252  *      @sdev: SCSI device to configure
3253  *      @ap: ATA port to which SCSI device is attached
3254  *
3255  *      RETURNS:
3256  *      Zero.
3257  */
3258
3259 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3260 {
3261         ata_scsi_sdev_config(sdev);
3262         ata_scsi_dev_config(sdev, ap->device);
3263         return 0;
3264 }
3265 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3266
3267 /**
3268  *      ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3269  *      @cmd: SCSI command to be sent
3270  *      @done: Completion function, called when command is complete
3271  *      @ap:    ATA port to which the command is being sent
3272  *
3273  *      RETURNS:
3274  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3275  *      0 otherwise.
3276  */
3277
3278 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3279                      struct ata_port *ap)
3280 {
3281         int rc = 0;
3282
3283         ata_scsi_dump_cdb(ap, cmd);
3284
3285         if (likely(ata_scsi_dev_enabled(ap->device)))
3286                 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3287         else {
3288                 cmd->result = (DID_BAD_TARGET << 16);
3289                 done(cmd);
3290         }
3291         return rc;
3292 }
3293 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);