drivers/scsi/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_eh.h>
  42 #include <scsi/scsi_device.h>
  43 #include <scsi/scsi_request.h>
  44 #include <scsi/scsi_transport.h>
  45 #include <linux/libata.h>
  46 #include <linux/hdreg.h>
  47 #include <asm/uaccess.h>
  48
  49 #include "libata.h"
  50
  51 #define SECTOR_SIZE     512
  52
  53 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
  54 static struct ata_device *
  55 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
  56 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
  57
  58 #define RW_RECOVERY_MPAGE 0x1
  59 #define RW_RECOVERY_MPAGE_LEN 12
  60 #define CACHE_MPAGE 0x8
  61 #define CACHE_MPAGE_LEN 20
  62 #define CONTROL_MPAGE 0xa
  63 #define CONTROL_MPAGE_LEN 12
  64 #define ALL_MPAGES 0x3f
  65 #define ALL_SUB_MPAGES 0xff
  66
  67
  68 static const u8 def_rw_recovery_mpage[] = {
  69         RW_RECOVERY_MPAGE,
  70         RW_RECOVERY_MPAGE_LEN - 2,
  71         (1 << 7) |      /* AWRE, sat-r06 say it shall be 0 */
  72             (1 << 6),   /* ARRE (auto read reallocation) */
  73         0,              /* read retry count */
  74         0, 0, 0, 0,
  75         0,              /* write retry count */
  76         0, 0, 0
  77 };
  78
  79 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
  80         CACHE_MPAGE,
  81         CACHE_MPAGE_LEN - 2,
  82         0,              /* contains WCE, needs to be 0 for logic */
  83         0, 0, 0, 0, 0, 0, 0, 0, 0,
  84         0,              /* contains DRA, needs to be 0 for logic */
  85         0, 0, 0, 0, 0, 0, 0
  86 };
  87
  88 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
  89         CONTROL_MPAGE,
  90         CONTROL_MPAGE_LEN - 2,
  91         2,      /* DSENSE=0, GLTSD=1 */
  92         0,      /* [QAM+QERR may be 1, see 05-359r1] */
  93         0, 0, 0, 0, 0xff, 0xff,
  94         0, 30   /* extended self test time, see 05-359r1 */
  95 };
  96
  97 /*
  98  * libata transport template.  libata doesn't do real transport stuff.
  99  * It just needs the eh_timed_out hook.
 100  */
 101 struct scsi_transport_template ata_scsi_transport_template = {
 102         .eh_timed_out           = ata_scsi_timed_out,
 103 };
 104
 105
 106 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
 107                                    void (*done)(struct scsi_cmnd *))
 108 {
 109         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
 110         /* "Invalid field in cbd" */
 111         done(cmd);
 112 }
 113
 114 /**
 115  *      ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
 116  *      @sdev: SCSI device for which BIOS geometry is to be determined
 117  *      @bdev: block device associated with @sdev
 118  *      @capacity: capacity of SCSI device
 119  *      @geom: location to which geometry will be output
 120  *
 121  *      Generic bios head/sector/cylinder calculator
 122  *      used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
 123  *      mapping. Some situations may arise where the disk is not
 124  *      bootable if this is not used.
 125  *
 126  *      LOCKING:
 127  *      Defined by the SCSI layer.  We don't really care.
 128  *
 129  *      RETURNS:
 130  *      Zero.
 131  */
 132 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
 133                        sector_t capacity, int geom[])
 134 {
 135         geom[0] = 255;
 136         geom[1] = 63;
 137         sector_div(capacity, 255*63);
 138         geom[2] = capacity;
 139
 140         return 0;
 141 }
 142
 143 /**
 144  *      ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
 145  *      @scsidev: Device to which we are issuing command
 146  *      @arg: User provided data for issuing command
 147  *
 148  *      LOCKING:
 149  *      Defined by the SCSI layer.  We don't really care.
 150  *
 151  *      RETURNS:
 152  *      Zero on success, negative errno on error.
 153  */
 154
 155 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
 156 {
 157         int rc = 0;
 158         u8 scsi_cmd[MAX_COMMAND_SIZE];
 159         u8 args[4], *argbuf = NULL;
 160         int argsize = 0;
 161         struct scsi_sense_hdr sshdr;
 162         enum dma_data_direction data_dir;
 163
 164         if (arg == NULL)
 165                 return -EINVAL;
 166
 167         if (copy_from_user(args, arg, sizeof(args)))
 168                 return -EFAULT;
 169
 170         memset(scsi_cmd, 0, sizeof(scsi_cmd));
 171
 172         if (args[3]) {
 173                 argsize = SECTOR_SIZE * args[3];
 174                 argbuf = kmalloc(argsize, GFP_KERNEL);
 175                 if (argbuf == NULL) {
 176                         rc = -ENOMEM;
 177                         goto error;
 178                 }
 179
 180                 scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
 181                 scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
 182                                             block count in sector count field */
 183                 data_dir = DMA_FROM_DEVICE;
 184         } else {
 185                 scsi_cmd[1]  = (3 << 1); /* Non-data */
 186                 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
 187                 data_dir = DMA_NONE;
 188         }
 189
 190         scsi_cmd[0] = ATA_16;
 191
 192         scsi_cmd[4] = args[2];
 193         if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
 194                 scsi_cmd[6]  = args[3];
 195                 scsi_cmd[8]  = args[1];
 196                 scsi_cmd[10] = 0x4f;
 197                 scsi_cmd[12] = 0xc2;
 198         } else {
 199                 scsi_cmd[6]  = args[1];
 200         }
 201         scsi_cmd[14] = args[0];
 202
 203         /* Good values for timeout and retries?  Values below
 204            from scsi_ioctl_send_command() for default case... */
 205         if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
 206                              &sshdr, (10*HZ), 5)) {
 207                 rc = -EIO;
 208                 goto error;
 209         }
 210
 211         /* Need code to retrieve data from check condition? */
 212
 213         if ((argbuf)
 214          && copy_to_user(arg + sizeof(args), argbuf, argsize))
 215                 rc = -EFAULT;
 216 error:
 217         if (argbuf)
 218                 kfree(argbuf);
 219
 220         return rc;
 221 }
 222
 223 /**
 224  *      ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
 225  *      @scsidev: Device to which we are issuing command
 226  *      @arg: User provided data for issuing command
 227  *
 228  *      LOCKING:
 229  *      Defined by the SCSI layer.  We don't really care.
 230  *
 231  *      RETURNS:
 232  *      Zero on success, negative errno on error.
 233  */
 234 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
 235 {
 236         int rc = 0;
 237         u8 scsi_cmd[MAX_COMMAND_SIZE];
 238         u8 args[7];
 239         struct scsi_sense_hdr sshdr;
 240
 241         if (arg == NULL)
 242                 return -EINVAL;
 243
 244         if (copy_from_user(args, arg, sizeof(args)))
 245                 return -EFAULT;
 246
 247         memset(scsi_cmd, 0, sizeof(scsi_cmd));
 248         scsi_cmd[0]  = ATA_16;
 249         scsi_cmd[1]  = (3 << 1); /* Non-data */
 250         /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
 251         scsi_cmd[4]  = args[1];
 252         scsi_cmd[6]  = args[2];
 253         scsi_cmd[8]  = args[3];
 254         scsi_cmd[10] = args[4];
 255         scsi_cmd[12] = args[5];
 256         scsi_cmd[14] = args[0];
 257
 258         /* Good values for timeout and retries?  Values below
 259            from scsi_ioctl_send_command() for default case... */
 260         if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
 261                              (10*HZ), 5))
 262                 rc = -EIO;
 263
 264         /* Need code to retrieve data from check condition? */
 265         return rc;
 266 }
 267
 268 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
 269 {
 270         int val = -EINVAL, rc = -EINVAL;
 271
 272         switch (cmd) {
 273         case ATA_IOC_GET_IO32:
 274                 val = 0;
 275                 if (copy_to_user(arg, &val, 1))
 276                         return -EFAULT;
 277                 return 0;
 278
 279         case ATA_IOC_SET_IO32:
 280                 val = (unsigned long) arg;
 281                 if (val != 0)
 282                         return -EINVAL;
 283                 return 0;
 284
 285         case HDIO_DRIVE_CMD:
 286                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 287                         return -EACCES;
 288                 return ata_cmd_ioctl(scsidev, arg);
 289
 290         case HDIO_DRIVE_TASK:
 291                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 292                         return -EACCES;
 293                 return ata_task_ioctl(scsidev, arg);
 294
 295         default:
 296                 rc = -ENOTTY;
 297                 break;
 298         }
 299
 300         return rc;
 301 }
 302
 303 /**
 304  *      ata_scsi_qc_new - acquire new ata_queued_cmd reference
 305  *      @ap: ATA port to which the new command is attached
 306  *      @dev: ATA device to which the new command is attached
 307  *      @cmd: SCSI command that originated this ATA command
 308  *      @done: SCSI command completion function
 309  *
 310  *      Obtain a reference to an unused ata_queued_cmd structure,
 311  *      which is the basic libata structure representing a single
 312  *      ATA command sent to the hardware.
 313  *
 314  *      If a command was available, fill in the SCSI-specific
 315  *      portions of the structure with information on the
 316  *      current command.
 317  *
 318  *      LOCKING:
 319  *      spin_lock_irqsave(host_set lock)
 320  *
 321  *      RETURNS:
 322  *      Command allocated, or %NULL if none available.
 323  */
 324 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
 325                                        struct ata_device *dev,
 326                                        struct scsi_cmnd *cmd,
 327                                        void (*done)(struct scsi_cmnd *))
 328 {
 329         struct ata_queued_cmd *qc;
 330
 331         qc = ata_qc_new_init(ap, dev);
 332         if (qc) {
 333                 qc->scsicmd = cmd;
 334                 qc->scsidone = done;
 335
 336                 if (cmd->use_sg) {
 337                         qc->__sg = (struct scatterlist *) cmd->request_buffer;
 338                         qc->n_elem = cmd->use_sg;
 339                 } else {
 340                         qc->__sg = &qc->sgent;
 341                         qc->n_elem = 1;
 342                 }
 343         } else {
 344                 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
 345                 done(cmd);
 346         }
 347
 348         return qc;
 349 }
 350
 351 /**
 352  *      ata_dump_status - user friendly display of error info
 353  *      @id: id of the port in question
 354  *      @tf: ptr to filled out taskfile
 355  *
 356  *      Decode and dump the ATA error/status registers for the user so
 357  *      that they have some idea what really happened at the non
 358  *      make-believe layer.
 359  *
 360  *      LOCKING:
 361  *      inherited from caller
 362  */
 363 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
 364 {
 365         u8 stat = tf->command, err = tf->feature;
 366
 367         printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
 368         if (stat & ATA_BUSY) {
 369                 printk("Busy }\n");     /* Data is not valid in this case */
 370         } else {
 371                 if (stat & 0x40)        printk("DriveReady ");
 372                 if (stat & 0x20)        printk("DeviceFault ");
 373                 if (stat & 0x10)        printk("SeekComplete ");
 374                 if (stat & 0x08)        printk("DataRequest ");
 375                 if (stat & 0x04)        printk("CorrectedError ");
 376                 if (stat & 0x02)        printk("Index ");
 377                 if (stat & 0x01)        printk("Error ");
 378                 printk("}\n");
 379
 380                 if (err) {
 381                         printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
 382                         if (err & 0x04)         printk("DriveStatusError ");
 383                         if (err & 0x80) {
 384                                 if (err & 0x04) printk("BadCRC ");
 385                                 else            printk("Sector ");
 386                         }
 387                         if (err & 0x40)         printk("UncorrectableError ");
 388                         if (err & 0x10)         printk("SectorIdNotFound ");
 389                         if (err & 0x02)         printk("TrackZeroNotFound ");
 390                         if (err & 0x01)         printk("AddrMarkNotFound ");
 391                         printk("}\n");
 392                 }
 393         }
 394 }
 395
 396 int ata_scsi_device_resume(struct scsi_device *sdev)
 397 {
 398         struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
 399         struct ata_device *dev = &ap->device[sdev->id];
 400
 401         return ata_device_resume(ap, dev);
 402 }
 403
 404 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
 405 {
 406         struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
 407         struct ata_device *dev = &ap->device[sdev->id];
 408
 409         return ata_device_suspend(ap, dev, state);
 410 }
 411
 412 /**
 413  *      ata_to_sense_error - convert ATA error to SCSI error
 414  *      @id: ATA device number
 415  *      @drv_stat: value contained in ATA status register
 416  *      @drv_err: value contained in ATA error register
 417  *      @sk: the sense key we'll fill out
 418  *      @asc: the additional sense code we'll fill out
 419  *      @ascq: the additional sense code qualifier we'll fill out
 420  *
 421  *      Converts an ATA error into a SCSI error.  Fill out pointers to
 422  *      SK, ASC, and ASCQ bytes for later use in fixed or descriptor
 423  *      format sense blocks.
 424  *
 425  *      LOCKING:
 426  *      spin_lock_irqsave(host_set lock)
 427  */
 428 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
 429                         u8 *ascq)
 430 {
 431         int i;
 432
 433         /* Based on the 3ware driver translation table */
 434         static const unsigned char sense_table[][4] = {
 435                 /* BBD|ECC|ID|MAR */
 436                 {0xd1,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
 437                 /* BBD|ECC|ID */
 438                 {0xd0,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
 439                 /* ECC|MC|MARK */
 440                 {0x61,          HARDWARE_ERROR, 0x00, 0x00},    // Device fault                 Hardware error
 441                 /* ICRC|ABRT */         /* NB: ICRC & !ABRT is BBD */
 442                 {0x84,          ABORTED_COMMAND, 0x47, 0x00},   // Data CRC error               SCSI parity error
 443                 /* MC|ID|ABRT|TRK0|MARK */
 444                 {0x37,          NOT_READY, 0x04, 0x00},         // Unit offline                 Not ready
 445                 /* MCR|MARK */
 446                 {0x09,          NOT_READY, 0x04, 0x00},         // Unrecovered disk error       Not ready
 447                 /*  Bad address mark */
 448                 {0x01,          MEDIUM_ERROR, 0x13, 0x00},      // Address mark not found       Address mark not found for data field
 449                 /* TRK0 */
 450                 {0x02,          HARDWARE_ERROR, 0x00, 0x00},    // Track 0 not found              Hardware error
 451                 /* Abort & !ICRC */
 452                 {0x04,          ABORTED_COMMAND, 0x00, 0x00},   // Aborted command              Aborted command
 453                 /* Media change request */
 454                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change request   FIXME: faking offline
 455                 /* SRV */
 456                 {0x10,          ABORTED_COMMAND, 0x14, 0x00},   // ID not found                 Recorded entity not found
 457                 /* Media change */
 458                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change           FIXME: faking offline
 459                 /* ECC */
 460                 {0x40,          MEDIUM_ERROR, 0x11, 0x04},      // Uncorrectable ECC error      Unrecovered read error
 461                 /* BBD - block marked bad */
 462                 {0x80,          MEDIUM_ERROR, 0x11, 0x04},      // Block marked bad               Medium error, unrecovered read error
 463                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
 464         };
 465         static const unsigned char stat_table[][4] = {
 466                 /* Must be first because BUSY means no other bits valid */
 467                 {0x80,          ABORTED_COMMAND, 0x47, 0x00},   // Busy, fake parity for now
 468                 {0x20,          HARDWARE_ERROR,  0x00, 0x00},   // Device fault
 469                 {0x08,          ABORTED_COMMAND, 0x47, 0x00},   // Timed out in xfer, fake parity for now
 470                 {0x04,          RECOVERED_ERROR, 0x11, 0x00},   // Recovered ECC error    Medium error, recovered
 471                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
 472         };
 473
 474         /*
 475          *      Is this an error we can process/parse
 476          */
 477         if (drv_stat & ATA_BUSY) {
 478                 drv_err = 0;    /* Ignore the err bits, they're invalid */
 479         }
 480
 481         if (drv_err) {
 482                 /* Look for drv_err */
 483                 for (i = 0; sense_table[i][0] != 0xFF; i++) {
 484                         /* Look for best matches first */
 485                         if ((sense_table[i][0] & drv_err) ==
 486                             sense_table[i][0]) {
 487                                 *sk = sense_table[i][1];
 488                                 *asc = sense_table[i][2];
 489                                 *ascq = sense_table[i][3];
 490                                 goto translate_done;
 491                         }
 492                 }
 493                 /* No immediate match */
 494                 printk(KERN_WARNING "ata%u: no sense translation for "
 495                        "error 0x%02x\n", id, drv_err);
 496         }
 497
 498         /* Fall back to interpreting status bits */
 499         for (i = 0; stat_table[i][0] != 0xFF; i++) {
 500                 if (stat_table[i][0] & drv_stat) {
 501                         *sk = stat_table[i][1];
 502                         *asc = stat_table[i][2];
 503                         *ascq = stat_table[i][3];
 504                         goto translate_done;
 505                 }
 506         }
 507         /* No error?  Undecoded? */
 508         printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
 509                id, drv_stat);
 510
 511         /* We need a sensible error return here, which is tricky, and one
 512            that won't cause people to do things like return a disk wrongly */
 513         *sk = ABORTED_COMMAND;
 514         *asc = 0x00;
 515         *ascq = 0x00;
 516
 517  translate_done:
 518         printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
 519                "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
 520                *sk, *asc, *ascq);
 521         return;
 522 }
 523
 524 /*
 525  *      ata_gen_ata_desc_sense - Generate check condition sense block.
 526  *      @qc: Command that completed.
 527  *
 528  *      This function is specific to the ATA descriptor format sense
 529  *      block specified for the ATA pass through commands.  Regardless
 530  *      of whether the command errored or not, return a sense
 531  *      block. Copy all controller registers into the sense
 532  *      block. Clear sense key, ASC & ASCQ if there is no error.
 533  *
 534  *      LOCKING:
 535  *      spin_lock_irqsave(host_set lock)
 536  */
 537 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
 538 {
 539         struct scsi_cmnd *cmd = qc->scsicmd;
 540         struct ata_taskfile *tf = &qc->tf;
 541         unsigned char *sb = cmd->sense_buffer;
 542         unsigned char *desc = sb + 8;
 543
 544         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
 545
 546         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
 547
 548         /*
 549          * Read the controller registers.
 550          */
 551         WARN_ON(qc->ap->ops->tf_read == NULL);
 552         qc->ap->ops->tf_read(qc->ap, tf);
 553
 554         /*
 555          * Use ata_to_sense_error() to map status register bits
 556          * onto sense key, asc & ascq.
 557          */
 558         if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
 559                 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
 560                                    &sb[1], &sb[2], &sb[3]);
 561                 sb[1] &= 0x0f;
 562         }
 563
 564         /*
 565          * Sense data is current and format is descriptor.
 566          */
 567         sb[0] = 0x72;
 568
 569         desc[0] = 0x09;
 570
 571         /*
 572          * Set length of additional sense data.
 573          * Since we only populate descriptor 0, the total
 574          * length is the same (fixed) length as descriptor 0.
 575          */
 576         desc[1] = sb[7] = 14;
 577
 578         /*
 579          * Copy registers into sense buffer.
 580          */
 581         desc[2] = 0x00;
 582         desc[3] = tf->feature;  /* == error reg */
 583         desc[5] = tf->nsect;
 584         desc[7] = tf->lbal;
 585         desc[9] = tf->lbam;
 586         desc[11] = tf->lbah;
 587         desc[12] = tf->device;
 588         desc[13] = tf->command; /* == status reg */
 589
 590         /*
 591          * Fill in Extend bit, and the high order bytes
 592          * if applicable.
 593          */
 594         if (tf->flags & ATA_TFLAG_LBA48) {
 595                 desc[2] |= 0x01;
 596                 desc[4] = tf->hob_nsect;
 597                 desc[6] = tf->hob_lbal;
 598                 desc[8] = tf->hob_lbam;
 599                 desc[10] = tf->hob_lbah;
 600         }
 601 }
 602
 603 /**
 604  *      ata_gen_fixed_sense - generate a SCSI fixed sense block
 605  *      @qc: Command that we are erroring out
 606  *
 607  *      Leverage ata_to_sense_error() to give us the codes.  Fit our
 608  *      LBA in here if there's room.
 609  *
 610  *      LOCKING:
 611  *      inherited from caller
 612  */
 613 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
 614 {
 615         struct scsi_cmnd *cmd = qc->scsicmd;
 616         struct ata_taskfile *tf = &qc->tf;
 617         unsigned char *sb = cmd->sense_buffer;
 618
 619         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
 620
 621         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
 622
 623         /*
 624          * Read the controller registers.
 625          */
 626         WARN_ON(qc->ap->ops->tf_read == NULL);
 627         qc->ap->ops->tf_read(qc->ap, tf);
 628
 629         /*
 630          * Use ata_to_sense_error() to map status register bits
 631          * onto sense key, asc & ascq.
 632          */
 633         if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
 634                 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
 635                                    &sb[2], &sb[12], &sb[13]);
 636                 sb[2] &= 0x0f;
 637         }
 638
 639         sb[0] = 0x70;
 640         sb[7] = 0x0a;
 641
 642         if (tf->flags & ATA_TFLAG_LBA48) {
 643                 /* TODO: find solution for LBA48 descriptors */
 644         }
 645
 646         else if (tf->flags & ATA_TFLAG_LBA) {
 647                 /* A small (28b) LBA will fit in the 32b info field */
 648                 sb[0] |= 0x80;          /* set valid bit */
 649                 sb[3] = tf->device & 0x0f;
 650                 sb[4] = tf->lbah;
 651                 sb[5] = tf->lbam;
 652                 sb[6] = tf->lbal;
 653         }
 654
 655         else {
 656                 /* TODO: C/H/S */
 657         }
 658 }
 659
 660 static void ata_scsi_sdev_config(struct scsi_device *sdev)
 661 {
 662         sdev->use_10_for_rw = 1;
 663         sdev->use_10_for_ms = 1;
 664 }
 665
 666 static void ata_scsi_dev_config(struct scsi_device *sdev,
 667                                 struct ata_device *dev)
 668 {
 669         unsigned int max_sectors;
 670
 671         /* TODO: 2048 is an arbitrary number, not the
 672          * hardware maximum.  This should be increased to
 673          * 65534 when Jens Axboe's patch for dynamically
 674          * determining max_sectors is merged.
 675          */
 676         max_sectors = ATA_MAX_SECTORS;
 677         if (dev->flags & ATA_DFLAG_LBA48)
 678                 max_sectors = ATA_MAX_SECTORS_LBA48;
 679         if (dev->max_sectors)
 680                 max_sectors = dev->max_sectors;
 681
 682         blk_queue_max_sectors(sdev->request_queue, max_sectors);
 683
 684         /*
 685          * SATA DMA transfers must be multiples of 4 byte, so
 686          * we need to pad ATAPI transfers using an extra sg.
 687          * Decrement max hw segments accordingly.
 688          */
 689         if (dev->class == ATA_DEV_ATAPI) {
 690                 request_queue_t *q = sdev->request_queue;
 691                 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
 692         }
 693 }
 694
 695 /**
 696  *      ata_scsi_slave_config - Set SCSI device attributes
 697  *      @sdev: SCSI device to examine
 698  *
 699  *      This is called before we actually start reading
 700  *      and writing to the device, to configure certain
 701  *      SCSI mid-layer behaviors.
 702  *
 703  *      LOCKING:
 704  *      Defined by SCSI layer.  We don't really care.
 705  */
 706
 707 int ata_scsi_slave_config(struct scsi_device *sdev)
 708 {
 709         ata_scsi_sdev_config(sdev);
 710
 711         blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
 712
 713         if (sdev->id < ATA_MAX_DEVICES) {
 714                 struct ata_port *ap;
 715                 struct ata_device *dev;
 716
 717                 ap = (struct ata_port *) &sdev->host->hostdata[0];
 718                 dev = &ap->device[sdev->id];
 719
 720                 ata_scsi_dev_config(sdev, dev);
 721         }
 722
 723         return 0;       /* scsi layer doesn't check return value, sigh */
 724 }
 725
 726 /**
 727  *      ata_scsi_timed_out - SCSI layer time out callback
 728  *      @cmd: timed out SCSI command
 729  *
 730  *      Handles SCSI layer timeout.  We race with normal completion of
 731  *      the qc for @cmd.  If the qc is already gone, we lose and let
 732  *      the scsi command finish (EH_HANDLED).  Otherwise, the qc has
 733  *      timed out and EH should be invoked.  Prevent ata_qc_complete()
 734  *      from finishing it by setting EH_SCHEDULED and return
 735  *      EH_NOT_HANDLED.
 736  *
 737  *      LOCKING:
 738  *      Called from timer context
 739  *
 740  *      RETURNS:
 741  *      EH_HANDLED or EH_NOT_HANDLED
 742  */
 743 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
 744 {
 745         struct Scsi_Host *host = cmd->device->host;
 746         struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
 747         unsigned long flags;
 748         struct ata_queued_cmd *qc;
 749         enum scsi_eh_timer_return ret = EH_HANDLED;
 750
 751         DPRINTK("ENTER\n");
 752
 753         spin_lock_irqsave(&ap->host_set->lock, flags);
 754         qc = ata_qc_from_tag(ap, ap->active_tag);
 755         if (qc) {
 756                 WARN_ON(qc->scsicmd != cmd);
 757                 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
 758                 qc->err_mask |= AC_ERR_TIMEOUT;
 759                 ret = EH_NOT_HANDLED;
 760         }
 761         spin_unlock_irqrestore(&ap->host_set->lock, flags);
 762
 763         DPRINTK("EXIT, ret=%d\n", ret);
 764         return ret;
 765 }
 766
 767 /**
 768  *      ata_scsi_error - SCSI layer error handler callback
 769  *      @host: SCSI host on which error occurred
 770  *
 771  *      Handles SCSI-layer-thrown error events.
 772  *
 773  *      LOCKING:
 774  *      Inherited from SCSI layer (none, can sleep)
 775  *
 776  *      RETURNS:
 777  *      Zero.
 778  */
 779
 780 int ata_scsi_error(struct Scsi_Host *host)
 781 {
 782         struct ata_port *ap;
 783         unsigned long flags;
 784
 785         DPRINTK("ENTER\n");
 786
 787         ap = (struct ata_port *) &host->hostdata[0];
 788
 789         spin_lock_irqsave(&ap->host_set->lock, flags);
 790         WARN_ON(ap->flags & ATA_FLAG_IN_EH);
 791         ap->flags |= ATA_FLAG_IN_EH;
 792         WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
 793         spin_unlock_irqrestore(&ap->host_set->lock, flags);
 794
 795         ata_port_flush_task(ap);
 796
 797         ap->ops->eng_timeout(ap);
 798
 799         WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
 800
 801         scsi_eh_flush_done_q(&ap->eh_done_q);
 802
 803         spin_lock_irqsave(&ap->host_set->lock, flags);
 804         ap->flags &= ~ATA_FLAG_IN_EH;
 805         spin_unlock_irqrestore(&ap->host_set->lock, flags);
 806
 807         DPRINTK("EXIT\n");
 808         return 0;
 809 }
 810
 811 static void ata_eh_scsidone(struct scsi_cmnd *scmd)
 812 {
 813         /* nada */
 814 }
 815
 816 static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
 817 {
 818         struct ata_port *ap = qc->ap;
 819         struct scsi_cmnd *scmd = qc->scsicmd;
 820         unsigned long flags;
 821
 822         spin_lock_irqsave(&ap->host_set->lock, flags);
 823         qc->scsidone = ata_eh_scsidone;
 824         __ata_qc_complete(qc);
 825         WARN_ON(ata_tag_valid(qc->tag));
 826         spin_unlock_irqrestore(&ap->host_set->lock, flags);
 827
 828         scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
 829 }
 830
 831 /**
 832  *      ata_eh_qc_complete - Complete an active ATA command from EH
 833  *      @qc: Command to complete
 834  *
 835  *      Indicate to the mid and upper layers that an ATA command has
 836  *      completed.  To be used from EH.
 837  */
 838 void ata_eh_qc_complete(struct ata_queued_cmd *qc)
 839 {
 840         struct scsi_cmnd *scmd = qc->scsicmd;
 841         scmd->retries = scmd->allowed;
 842         __ata_eh_qc_complete(qc);
 843 }
 844
 845 /**
 846  *      ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
 847  *      @qc: Command to retry
 848  *
 849  *      Indicate to the mid and upper layers that an ATA command
 850  *      should be retried.  To be used from EH.
 851  *
 852  *      SCSI midlayer limits the number of retries to scmd->allowed.
 853  *      This function might need to adjust scmd->retries for commands
 854  *      which get retried due to unrelated NCQ failures.
 855  */
 856 void ata_eh_qc_retry(struct ata_queued_cmd *qc)
 857 {
 858         __ata_eh_qc_complete(qc);
 859 }
 860
 861 /**
 862  *      ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
 863  *      @qc: Storage for translated ATA taskfile
 864  *      @scsicmd: SCSI command to translate
 865  *
 866  *      Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
 867  *      (to start). Perhaps these commands should be preceded by
 868  *      CHECK POWER MODE to see what power mode the device is already in.
 869  *      [See SAT revision 5 at www.t10.org]
 870  *
 871  *      LOCKING:
 872  *      spin_lock_irqsave(host_set lock)
 873  *
 874  *      RETURNS:
 875  *      Zero on success, non-zero on error.
 876  */
 877
 878 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
 879                                              const u8 *scsicmd)
 880 {
 881         struct ata_taskfile *tf = &qc->tf;
 882
 883         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
 884         tf->protocol = ATA_PROT_NODATA;
 885         if (scsicmd[1] & 0x1) {
 886                 ;       /* ignore IMMED bit, violates sat-r05 */
 887         }
 888         if (scsicmd[4] & 0x2)
 889                 goto invalid_fld;       /* LOEJ bit set not supported */
 890         if (((scsicmd[4] >> 4) & 0xf) != 0)
 891                 goto invalid_fld;       /* power conditions not supported */
 892         if (scsicmd[4] & 0x1) {
 893                 tf->nsect = 1;  /* 1 sector, lba=0 */
 894
 895                 if (qc->dev->flags & ATA_DFLAG_LBA) {
 896                         qc->tf.flags |= ATA_TFLAG_LBA;
 897
 898                         tf->lbah = 0x0;
 899                         tf->lbam = 0x0;
 900                         tf->lbal = 0x0;
 901                         tf->device |= ATA_LBA;
 902                 } else {
 903                         /* CHS */
 904                         tf->lbal = 0x1; /* sect */
 905                         tf->lbam = 0x0; /* cyl low */
 906                         tf->lbah = 0x0; /* cyl high */
 907                 }
 908
 909                 tf->command = ATA_CMD_VERIFY;   /* READ VERIFY */
 910         } else {
 911                 tf->nsect = 0;  /* time period value (0 implies now) */
 912                 tf->command = ATA_CMD_STANDBY;
 913                 /* Consider: ATA STANDBY IMMEDIATE command */
 914         }
 915         /*
 916          * Standby and Idle condition timers could be implemented but that
 917          * would require libata to implement the Power condition mode page
 918          * and allow the user to change it. Changing mode pages requires
 919          * MODE SELECT to be implemented.
 920          */
 921
 922         return 0;
 923
 924 invalid_fld:
 925         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
 926         /* "Invalid field in cbd" */
 927         return 1;
 928 }
 929
 930
 931 /**
 932  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
 933  *      @qc: Storage for translated ATA taskfile
 934  *      @scsicmd: SCSI command to translate (ignored)
 935  *
 936  *      Sets up an ATA taskfile to issue FLUSH CACHE or
 937  *      FLUSH CACHE EXT.
 938  *
 939  *      LOCKING:
 940  *      spin_lock_irqsave(host_set lock)
 941  *
 942  *      RETURNS:
 943  *      Zero on success, non-zero on error.
 944  */
 945
 946 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
 947 {
 948         struct ata_taskfile *tf = &qc->tf;
 949
 950         tf->flags |= ATA_TFLAG_DEVICE;
 951         tf->protocol = ATA_PROT_NODATA;
 952
 953         if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
 954             (ata_id_has_flush_ext(qc->dev->id)))
 955                 tf->command = ATA_CMD_FLUSH_EXT;
 956         else
 957                 tf->command = ATA_CMD_FLUSH;
 958
 959         return 0;
 960 }
 961
 962 /**
 963  *      scsi_6_lba_len - Get LBA and transfer length
 964  *      @scsicmd: SCSI command to translate
 965  *
 966  *      Calculate LBA and transfer length for 6-byte commands.
 967  *
 968  *      RETURNS:
 969  *      @plba: the LBA
 970  *      @plen: the transfer length
 971  */
 972
 973 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
 974 {
 975         u64 lba = 0;
 976         u32 len = 0;
 977
 978         VPRINTK("six-byte command\n");
 979
 980         lba |= ((u64)scsicmd[2]) << 8;
 981         lba |= ((u64)scsicmd[3]);
 982
 983         len |= ((u32)scsicmd[4]);
 984
 985         *plba = lba;
 986         *plen = len;
 987 }
 988
 989 /**
 990  *      scsi_10_lba_len - Get LBA and transfer length
 991  *      @scsicmd: SCSI command to translate
 992  *
 993  *      Calculate LBA and transfer length for 10-byte commands.
 994  *
 995  *      RETURNS:
 996  *      @plba: the LBA
 997  *      @plen: the transfer length
 998  */
 999
1000 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1001 {
1002         u64 lba = 0;
1003         u32 len = 0;
1004
1005         VPRINTK("ten-byte command\n");
1006
1007         lba |= ((u64)scsicmd[2]) << 24;
1008         lba |= ((u64)scsicmd[3]) << 16;
1009         lba |= ((u64)scsicmd[4]) << 8;
1010         lba |= ((u64)scsicmd[5]);
1011
1012         len |= ((u32)scsicmd[7]) << 8;
1013         len |= ((u32)scsicmd[8]);
1014
1015         *plba = lba;
1016         *plen = len;
1017 }
1018
1019 /**
1020  *      scsi_16_lba_len - Get LBA and transfer length
1021  *      @scsicmd: SCSI command to translate
1022  *
1023  *      Calculate LBA and transfer length for 16-byte commands.
1024  *
1025  *      RETURNS:
1026  *      @plba: the LBA
1027  *      @plen: the transfer length
1028  */
1029
1030 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1031 {
1032         u64 lba = 0;
1033         u32 len = 0;
1034
1035         VPRINTK("sixteen-byte command\n");
1036
1037         lba |= ((u64)scsicmd[2]) << 56;
1038         lba |= ((u64)scsicmd[3]) << 48;
1039         lba |= ((u64)scsicmd[4]) << 40;
1040         lba |= ((u64)scsicmd[5]) << 32;
1041         lba |= ((u64)scsicmd[6]) << 24;
1042         lba |= ((u64)scsicmd[7]) << 16;
1043         lba |= ((u64)scsicmd[8]) << 8;
1044         lba |= ((u64)scsicmd[9]);
1045
1046         len |= ((u32)scsicmd[10]) << 24;
1047         len |= ((u32)scsicmd[11]) << 16;
1048         len |= ((u32)scsicmd[12]) << 8;
1049         len |= ((u32)scsicmd[13]);
1050
1051         *plba = lba;
1052         *plen = len;
1053 }
1054
1055 /**
1056  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1057  *      @qc: Storage for translated ATA taskfile
1058  *      @scsicmd: SCSI command to translate
1059  *
1060  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
1061  *
1062  *      LOCKING:
1063  *      spin_lock_irqsave(host_set lock)
1064  *
1065  *      RETURNS:
1066  *      Zero on success, non-zero on error.
1067  */
1068
1069 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1070 {
1071         struct ata_taskfile *tf = &qc->tf;
1072         struct ata_device *dev = qc->dev;
1073         u64 dev_sectors = qc->dev->n_sectors;
1074         u64 block;
1075         u32 n_block;
1076
1077         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1078         tf->protocol = ATA_PROT_NODATA;
1079
1080         if (scsicmd[0] == VERIFY)
1081                 scsi_10_lba_len(scsicmd, &block, &n_block);
1082         else if (scsicmd[0] == VERIFY_16)
1083                 scsi_16_lba_len(scsicmd, &block, &n_block);
1084         else
1085                 goto invalid_fld;
1086
1087         if (!n_block)
1088                 goto nothing_to_do;
1089         if (block >= dev_sectors)
1090                 goto out_of_range;
1091         if ((block + n_block) > dev_sectors)
1092                 goto out_of_range;
1093
1094         if (dev->flags & ATA_DFLAG_LBA) {
1095                 tf->flags |= ATA_TFLAG_LBA;
1096
1097                 if (lba_28_ok(block, n_block)) {
1098                         /* use LBA28 */
1099                         tf->command = ATA_CMD_VERIFY;
1100                         tf->device |= (block >> 24) & 0xf;
1101                 } else if (lba_48_ok(block, n_block)) {
1102                         if (!(dev->flags & ATA_DFLAG_LBA48))
1103                                 goto out_of_range;
1104
1105                         /* use LBA48 */
1106                         tf->flags |= ATA_TFLAG_LBA48;
1107                         tf->command = ATA_CMD_VERIFY_EXT;
1108
1109                         tf->hob_nsect = (n_block >> 8) & 0xff;
1110
1111                         tf->hob_lbah = (block >> 40) & 0xff;
1112                         tf->hob_lbam = (block >> 32) & 0xff;
1113                         tf->hob_lbal = (block >> 24) & 0xff;
1114                 } else
1115                         /* request too large even for LBA48 */
1116                         goto out_of_range;
1117
1118                 tf->nsect = n_block & 0xff;
1119
1120                 tf->lbah = (block >> 16) & 0xff;
1121                 tf->lbam = (block >> 8) & 0xff;
1122                 tf->lbal = block & 0xff;
1123
1124                 tf->device |= ATA_LBA;
1125         } else {
1126                 /* CHS */
1127                 u32 sect, head, cyl, track;
1128
1129                 if (!lba_28_ok(block, n_block))
1130                         goto out_of_range;
1131
1132                 /* Convert LBA to CHS */
1133                 track = (u32)block / dev->sectors;
1134                 cyl   = track / dev->heads;
1135                 head  = track % dev->heads;
1136                 sect  = (u32)block % dev->sectors + 1;
1137
1138                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1139                         (u32)block, track, cyl, head, sect);
1140
1141                 /* Check whether the converted CHS can fit.
1142                    Cylinder: 0-65535
1143                    Head: 0-15
1144                    Sector: 1-255*/
1145                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1146                         goto out_of_range;
1147
1148                 tf->command = ATA_CMD_VERIFY;
1149                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1150                 tf->lbal = sect;
1151                 tf->lbam = cyl;
1152                 tf->lbah = cyl >> 8;
1153                 tf->device |= head;
1154         }
1155
1156         return 0;
1157
1158 invalid_fld:
1159         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1160         /* "Invalid field in cbd" */
1161         return 1;
1162
1163 out_of_range:
1164         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1165         /* "Logical Block Address out of range" */
1166         return 1;
1167
1168 nothing_to_do:
1169         qc->scsicmd->result = SAM_STAT_GOOD;
1170         return 1;
1171 }
1172
1173 /**
1174  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1175  *      @qc: Storage for translated ATA taskfile
1176  *      @scsicmd: SCSI command to translate
1177  *
1178  *      Converts any of six SCSI read/write commands into the
1179  *      ATA counterpart, including starting sector (LBA),
1180  *      sector count, and taking into account the device's LBA48
1181  *      support.
1182  *
1183  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1184  *      %WRITE_16 are currently supported.
1185  *
1186  *      LOCKING:
1187  *      spin_lock_irqsave(host_set lock)
1188  *
1189  *      RETURNS:
1190  *      Zero on success, non-zero on error.
1191  */
1192
1193 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1194 {
1195         struct ata_taskfile *tf = &qc->tf;
1196         struct ata_device *dev = qc->dev;
1197         u64 block;
1198         u32 n_block;
1199
1200         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1201
1202         if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1203             scsicmd[0] == WRITE_16)
1204                 tf->flags |= ATA_TFLAG_WRITE;
1205
1206         /* Calculate the SCSI LBA, transfer length and FUA. */
1207         switch (scsicmd[0]) {
1208         case READ_10:
1209         case WRITE_10:
1210                 scsi_10_lba_len(scsicmd, &block, &n_block);
1211                 if (unlikely(scsicmd[1] & (1 << 3)))
1212                         tf->flags |= ATA_TFLAG_FUA;
1213                 break;
1214         case READ_6:
1215         case WRITE_6:
1216                 scsi_6_lba_len(scsicmd, &block, &n_block);
1217
1218                 /* for 6-byte r/w commands, transfer length 0
1219                  * means 256 blocks of data, not 0 block.
1220                  */
1221                 if (!n_block)
1222                         n_block = 256;
1223                 break;
1224         case READ_16:
1225         case WRITE_16:
1226                 scsi_16_lba_len(scsicmd, &block, &n_block);
1227                 if (unlikely(scsicmd[1] & (1 << 3)))
1228                         tf->flags |= ATA_TFLAG_FUA;
1229                 break;
1230         default:
1231                 DPRINTK("no-byte command\n");
1232                 goto invalid_fld;
1233         }
1234
1235         /* Check and compose ATA command */
1236         if (!n_block)
1237                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1238                  * length 0 means transfer 0 block of data.
1239                  * However, for ATA R/W commands, sector count 0 means
1240                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
1241                  *
1242                  * WARNING: one or two older ATA drives treat 0 as 0...
1243                  */
1244                 goto nothing_to_do;
1245
1246         if (dev->flags & ATA_DFLAG_LBA) {
1247                 tf->flags |= ATA_TFLAG_LBA;
1248
1249                 if (lba_28_ok(block, n_block)) {
1250                         /* use LBA28 */
1251                         tf->device |= (block >> 24) & 0xf;
1252                 } else if (lba_48_ok(block, n_block)) {
1253                         if (!(dev->flags & ATA_DFLAG_LBA48))
1254                                 goto out_of_range;
1255
1256                         /* use LBA48 */
1257                         tf->flags |= ATA_TFLAG_LBA48;
1258
1259                         tf->hob_nsect = (n_block >> 8) & 0xff;
1260
1261                         tf->hob_lbah = (block >> 40) & 0xff;
1262                         tf->hob_lbam = (block >> 32) & 0xff;
1263                         tf->hob_lbal = (block >> 24) & 0xff;
1264                 } else
1265                         /* request too large even for LBA48 */
1266                         goto out_of_range;
1267
1268                 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1269                         goto invalid_fld;
1270
1271                 qc->nsect = n_block;
1272                 tf->nsect = n_block & 0xff;
1273
1274                 tf->lbah = (block >> 16) & 0xff;
1275                 tf->lbam = (block >> 8) & 0xff;
1276                 tf->lbal = block & 0xff;
1277
1278                 tf->device |= ATA_LBA;
1279         } else {
1280                 /* CHS */
1281                 u32 sect, head, cyl, track;
1282
1283                 /* The request -may- be too large for CHS addressing. */
1284                 if (!lba_28_ok(block, n_block))
1285                         goto out_of_range;
1286
1287                 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1288                         goto invalid_fld;
1289
1290                 /* Convert LBA to CHS */
1291                 track = (u32)block / dev->sectors;
1292                 cyl   = track / dev->heads;
1293                 head  = track % dev->heads;
1294                 sect  = (u32)block % dev->sectors + 1;
1295
1296                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1297                         (u32)block, track, cyl, head, sect);
1298
1299                 /* Check whether the converted CHS can fit.
1300                    Cylinder: 0-65535
1301                    Head: 0-15
1302                    Sector: 1-255*/
1303                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1304                         goto out_of_range;
1305
1306                 qc->nsect = n_block;
1307                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1308                 tf->lbal = sect;
1309                 tf->lbam = cyl;
1310                 tf->lbah = cyl >> 8;
1311                 tf->device |= head;
1312         }
1313
1314         return 0;
1315
1316 invalid_fld:
1317         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1318         /* "Invalid field in cbd" */
1319         return 1;
1320
1321 out_of_range:
1322         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1323         /* "Logical Block Address out of range" */
1324         return 1;
1325
1326 nothing_to_do:
1327         qc->scsicmd->result = SAM_STAT_GOOD;
1328         return 1;
1329 }
1330
1331 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1332 {
1333         struct scsi_cmnd *cmd = qc->scsicmd;
1334         u8 *cdb = cmd->cmnd;
1335         int need_sense = (qc->err_mask != 0);
1336
1337         /* For ATA pass thru (SAT) commands, generate a sense block if
1338          * user mandated it or if there's an error.  Note that if we
1339          * generate because the user forced us to, a check condition
1340          * is generated and the ATA register values are returned
1341          * whether the command completed successfully or not. If there
1342          * was no error, SK, ASC and ASCQ will all be zero.
1343          */
1344         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1345             ((cdb[2] & 0x20) || need_sense)) {
1346                 ata_gen_ata_desc_sense(qc);
1347         } else {
1348                 if (!need_sense) {
1349                         cmd->result = SAM_STAT_GOOD;
1350                 } else {
1351                         /* TODO: decide which descriptor format to use
1352                          * for 48b LBA devices and call that here
1353                          * instead of the fixed desc, which is only
1354                          * good for smaller LBA (and maybe CHS?)
1355                          * devices.
1356                          */
1357                         ata_gen_fixed_sense(qc);
1358                 }
1359         }
1360
1361         if (need_sense) {
1362                 /* The ata_gen_..._sense routines fill in tf */
1363                 ata_dump_status(qc->ap->id, &qc->tf);
1364         }
1365
1366         qc->scsidone(cmd);
1367
1368         ata_qc_free(qc);
1369 }
1370
1371 /**
1372  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1373  *      @ap: ATA port to which the command is addressed
1374  *      @dev: ATA device to which the command is addressed
1375  *      @cmd: SCSI command to execute
1376  *      @done: SCSI command completion function
1377  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1378  *
1379  *      Our ->queuecommand() function has decided that the SCSI
1380  *      command issued can be directly translated into an ATA
1381  *      command, rather than handled internally.
1382  *
1383  *      This function sets up an ata_queued_cmd structure for the
1384  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1385  *
1386  *      The xlat_func argument (actor) returns 0 if ready to execute
1387  *      ATA command, else 1 to finish translation. If 1 is returned
1388  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1389  *      to be set reflecting an error condition or clean (early)
1390  *      termination.
1391  *
1392  *      LOCKING:
1393  *      spin_lock_irqsave(host_set lock)
1394  */
1395
1396 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1397                               struct scsi_cmnd *cmd,
1398                               void (*done)(struct scsi_cmnd *),
1399                               ata_xlat_func_t xlat_func)
1400 {
1401         struct ata_queued_cmd *qc;
1402         u8 *scsicmd = cmd->cmnd;
1403
1404         VPRINTK("ENTER\n");
1405
1406         qc = ata_scsi_qc_new(ap, dev, cmd, done);
1407         if (!qc)
1408                 goto err_mem;
1409
1410         /* data is present; dma-map it */
1411         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1412             cmd->sc_data_direction == DMA_TO_DEVICE) {
1413                 if (unlikely(cmd->request_bufflen < 1)) {
1414                         printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1415                                ap->id, dev->devno);
1416                         goto err_did;
1417                 }
1418
1419                 if (cmd->use_sg)
1420                         ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1421                 else
1422                         ata_sg_init_one(qc, cmd->request_buffer,
1423                                         cmd->request_bufflen);
1424
1425                 qc->dma_dir = cmd->sc_data_direction;
1426         }
1427
1428         qc->complete_fn = ata_scsi_qc_complete;
1429
1430         if (xlat_func(qc, scsicmd))
1431                 goto early_finish;
1432
1433         /* select device, send command to hardware */
1434         qc->err_mask = ata_qc_issue(qc);
1435         if (qc->err_mask)
1436                 ata_qc_complete(qc);
1437
1438         VPRINTK("EXIT\n");
1439         return;
1440
1441 early_finish:
1442         ata_qc_free(qc);
1443         done(cmd);
1444         DPRINTK("EXIT - early finish (good or error)\n");
1445         return;
1446
1447 err_did:
1448         ata_qc_free(qc);
1449 err_mem:
1450         cmd->result = (DID_ERROR << 16);
1451         done(cmd);
1452         DPRINTK("EXIT - internal\n");
1453         return;
1454 }
1455
1456 /**
1457  *      ata_scsi_rbuf_get - Map response buffer.
1458  *      @cmd: SCSI command containing buffer to be mapped.
1459  *      @buf_out: Pointer to mapped area.
1460  *
1461  *      Maps buffer contained within SCSI command @cmd.
1462  *
1463  *      LOCKING:
1464  *      spin_lock_irqsave(host_set lock)
1465  *
1466  *      RETURNS:
1467  *      Length of response buffer.
1468  */
1469
1470 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1471 {
1472         u8 *buf;
1473         unsigned int buflen;
1474
1475         if (cmd->use_sg) {
1476                 struct scatterlist *sg;
1477
1478                 sg = (struct scatterlist *) cmd->request_buffer;
1479                 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1480                 buflen = sg->length;
1481         } else {
1482                 buf = cmd->request_buffer;
1483                 buflen = cmd->request_bufflen;
1484         }
1485
1486         *buf_out = buf;
1487         return buflen;
1488 }
1489
1490 /**
1491  *      ata_scsi_rbuf_put - Unmap response buffer.
1492  *      @cmd: SCSI command containing buffer to be unmapped.
1493  *      @buf: buffer to unmap
1494  *
1495  *      Unmaps response buffer contained within @cmd.
1496  *
1497  *      LOCKING:
1498  *      spin_lock_irqsave(host_set lock)
1499  */
1500
1501 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1502 {
1503         if (cmd->use_sg) {
1504                 struct scatterlist *sg;
1505
1506                 sg = (struct scatterlist *) cmd->request_buffer;
1507                 kunmap_atomic(buf - sg->offset, KM_USER0);
1508         }
1509 }
1510
1511 /**
1512  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1513  *      @args: device IDENTIFY data / SCSI command of interest.
1514  *      @actor: Callback hook for desired SCSI command simulator
1515  *
1516  *      Takes care of the hard work of simulating a SCSI command...
1517  *      Mapping the response buffer, calling the command's handler,
1518  *      and handling the handler's return value.  This return value
1519  *      indicates whether the handler wishes the SCSI command to be
1520  *      completed successfully (0), or not (in which case cmd->result
1521  *      and sense buffer are assumed to be set).
1522  *
1523  *      LOCKING:
1524  *      spin_lock_irqsave(host_set lock)
1525  */
1526
1527 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1528                         unsigned int (*actor) (struct ata_scsi_args *args,
1529                                            u8 *rbuf, unsigned int buflen))
1530 {
1531         u8 *rbuf;
1532         unsigned int buflen, rc;
1533         struct scsi_cmnd *cmd = args->cmd;
1534
1535         buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1536         memset(rbuf, 0, buflen);
1537         rc = actor(args, rbuf, buflen);
1538         ata_scsi_rbuf_put(cmd, rbuf);
1539
1540         if (rc == 0)
1541                 cmd->result = SAM_STAT_GOOD;
1542         args->done(cmd);
1543 }
1544
1545 /**
1546  *      ata_scsiop_inq_std - Simulate INQUIRY command
1547  *      @args: device IDENTIFY data / SCSI command of interest.
1548  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1549  *      @buflen: Response buffer length.
1550  *
1551  *      Returns standard device identification data associated
1552  *      with non-VPD INQUIRY command output.
1553  *
1554  *      LOCKING:
1555  *      spin_lock_irqsave(host_set lock)
1556  */
1557
1558 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1559                                unsigned int buflen)
1560 {
1561         u8 hdr[] = {
1562                 TYPE_DISK,
1563                 0,
1564                 0x5,    /* claim SPC-3 version compatibility */
1565                 2,
1566                 95 - 4
1567         };
1568
1569         /* set scsi removeable (RMB) bit per ata bit */
1570         if (ata_id_removeable(args->id))
1571                 hdr[1] |= (1 << 7);
1572
1573         VPRINTK("ENTER\n");
1574
1575         memcpy(rbuf, hdr, sizeof(hdr));
1576
1577         if (buflen > 35) {
1578                 memcpy(&rbuf[8], "ATA     ", 8);
1579                 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1580                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1581                 if (rbuf[32] == 0 || rbuf[32] == ' ')
1582                         memcpy(&rbuf[32], "n/a ", 4);
1583         }
1584
1585         if (buflen > 63) {
1586                 const u8 versions[] = {
1587                         0x60,   /* SAM-3 (no version claimed) */
1588
1589                         0x03,
1590                         0x20,   /* SBC-2 (no version claimed) */
1591
1592                         0x02,
1593                         0x60    /* SPC-3 (no version claimed) */
1594                 };
1595
1596                 memcpy(rbuf + 59, versions, sizeof(versions));
1597         }
1598
1599         return 0;
1600 }
1601
1602 /**
1603  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1604  *      @args: device IDENTIFY data / SCSI command of interest.
1605  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1606  *      @buflen: Response buffer length.
1607  *
1608  *      Returns list of inquiry VPD pages available.
1609  *
1610  *      LOCKING:
1611  *      spin_lock_irqsave(host_set lock)
1612  */
1613
1614 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1615                               unsigned int buflen)
1616 {
1617         const u8 pages[] = {
1618                 0x00,   /* page 0x00, this page */
1619                 0x80,   /* page 0x80, unit serial no page */
1620                 0x83    /* page 0x83, device ident page */
1621         };
1622         rbuf[3] = sizeof(pages);        /* number of supported VPD pages */
1623
1624         if (buflen > 6)
1625                 memcpy(rbuf + 4, pages, sizeof(pages));
1626
1627         return 0;
1628 }
1629
1630 /**
1631  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1632  *      @args: device IDENTIFY data / SCSI command of interest.
1633  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1634  *      @buflen: Response buffer length.
1635  *
1636  *      Returns ATA device serial number.
1637  *
1638  *      LOCKING:
1639  *      spin_lock_irqsave(host_set lock)
1640  */
1641
1642 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1643                               unsigned int buflen)
1644 {
1645         const u8 hdr[] = {
1646                 0,
1647                 0x80,                   /* this page code */
1648                 0,
1649                 ATA_SERNO_LEN,          /* page len */
1650         };
1651         memcpy(rbuf, hdr, sizeof(hdr));
1652
1653         if (buflen > (ATA_SERNO_LEN + 4 - 1))
1654                 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1655                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1656
1657         return 0;
1658 }
1659
1660 /**
1661  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1662  *      @args: device IDENTIFY data / SCSI command of interest.
1663  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1664  *      @buflen: Response buffer length.
1665  *
1666  *      Yields two logical unit device identification designators:
1667  *       - vendor specific ASCII containing the ATA serial number
1668  *       - SAT defined "t10 vendor id based" containing ASCII vendor
1669  *         name ("ATA     "), model and serial numbers.
1670  *
1671  *      LOCKING:
1672  *      spin_lock_irqsave(host_set lock)
1673  */
1674
1675 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1676                               unsigned int buflen)
1677 {
1678         int num;
1679         const int sat_model_serial_desc_len = 68;
1680         const int ata_model_byte_len = 40;
1681
1682         rbuf[1] = 0x83;                 /* this page code */
1683         num = 4;
1684
1685         if (buflen > (ATA_SERNO_LEN + num + 3)) {
1686                 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1687                 rbuf[num + 0] = 2;
1688                 rbuf[num + 3] = ATA_SERNO_LEN;
1689                 num += 4;
1690                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1691                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1692                 num += ATA_SERNO_LEN;
1693         }
1694         if (buflen > (sat_model_serial_desc_len + num + 3)) {
1695                 /* SAT defined lu model and serial numbers descriptor */
1696                 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1697                 rbuf[num + 0] = 2;
1698                 rbuf[num + 1] = 1;
1699                 rbuf[num + 3] = sat_model_serial_desc_len;
1700                 num += 4;
1701                 memcpy(rbuf + num, "ATA     ", 8);
1702                 num += 8;
1703                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1704                               ATA_ID_PROD_OFS, ata_model_byte_len);
1705                 num += ata_model_byte_len;
1706                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1707                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1708                 num += ATA_SERNO_LEN;
1709         }
1710         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
1711         return 0;
1712 }
1713
1714 /**
1715  *      ata_scsiop_noop - Command handler that simply returns success.
1716  *      @args: device IDENTIFY data / SCSI command of interest.
1717  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1718  *      @buflen: Response buffer length.
1719  *
1720  *      No operation.  Simply returns success to caller, to indicate
1721  *      that the caller should successfully complete this SCSI command.
1722  *
1723  *      LOCKING:
1724  *      spin_lock_irqsave(host_set lock)
1725  */
1726
1727 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1728                             unsigned int buflen)
1729 {
1730         VPRINTK("ENTER\n");
1731         return 0;
1732 }
1733
1734 /**
1735  *      ata_msense_push - Push data onto MODE SENSE data output buffer
1736  *      @ptr_io: (input/output) Location to store more output data
1737  *      @last: End of output data buffer
1738  *      @buf: Pointer to BLOB being added to output buffer
1739  *      @buflen: Length of BLOB
1740  *
1741  *      Store MODE SENSE data on an output buffer.
1742  *
1743  *      LOCKING:
1744  *      None.
1745  */
1746
1747 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1748                             const u8 *buf, unsigned int buflen)
1749 {
1750         u8 *ptr = *ptr_io;
1751
1752         if ((ptr + buflen - 1) > last)
1753                 return;
1754
1755         memcpy(ptr, buf, buflen);
1756
1757         ptr += buflen;
1758
1759         *ptr_io = ptr;
1760 }
1761
1762 /**
1763  *      ata_msense_caching - Simulate MODE SENSE caching info page
1764  *      @id: device IDENTIFY data
1765  *      @ptr_io: (input/output) Location to store more output data
1766  *      @last: End of output data buffer
1767  *
1768  *      Generate a caching info page, which conditionally indicates
1769  *      write caching to the SCSI layer, depending on device
1770  *      capabilities.
1771  *
1772  *      LOCKING:
1773  *      None.
1774  */
1775
1776 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1777                                        const u8 *last)
1778 {
1779         u8 page[CACHE_MPAGE_LEN];
1780
1781         memcpy(page, def_cache_mpage, sizeof(page));
1782         if (ata_id_wcache_enabled(id))
1783                 page[2] |= (1 << 2);    /* write cache enable */
1784         if (!ata_id_rahead_enabled(id))
1785                 page[12] |= (1 << 5);   /* disable read ahead */
1786
1787         ata_msense_push(ptr_io, last, page, sizeof(page));
1788         return sizeof(page);
1789 }
1790
1791 /**
1792  *      ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1793  *      @dev: Device associated with this MODE SENSE command
1794  *      @ptr_io: (input/output) Location to store more output data
1795  *      @last: End of output data buffer
1796  *
1797  *      Generate a generic MODE SENSE control mode page.
1798  *
1799  *      LOCKING:
1800  *      None.
1801  */
1802
1803 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1804 {
1805         ata_msense_push(ptr_io, last, def_control_mpage,
1806                         sizeof(def_control_mpage));
1807         return sizeof(def_control_mpage);
1808 }
1809
1810 /**
1811  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1812  *      @dev: Device associated with this MODE SENSE command
1813  *      @ptr_io: (input/output) Location to store more output data
1814  *      @last: End of output data buffer
1815  *
1816  *      Generate a generic MODE SENSE r/w error recovery page.
1817  *
1818  *      LOCKING:
1819  *      None.
1820  */
1821
1822 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1823 {
1824
1825         ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1826                         sizeof(def_rw_recovery_mpage));
1827         return sizeof(def_rw_recovery_mpage);
1828 }
1829
1830 /*
1831  * We can turn this into a real blacklist if it's needed, for now just
1832  * blacklist any Maxtor BANC1G10 revision firmware
1833  */
1834 static int ata_dev_supports_fua(u16 *id)
1835 {
1836         unsigned char model[41], fw[9];
1837
1838         if (!libata_fua)
1839                 return 0;
1840         if (!ata_id_has_fua(id))
1841                 return 0;
1842
1843         ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1844         ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1845
1846         if (strcmp(model, "Maxtor"))
1847                 return 1;
1848         if (strcmp(fw, "BANC1G10"))
1849                 return 1;
1850
1851         return 0; /* blacklisted */
1852 }
1853
1854 /**
1855  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1856  *      @args: device IDENTIFY data / SCSI command of interest.
1857  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1858  *      @buflen: Response buffer length.
1859  *
1860  *      Simulate MODE SENSE commands. Assume this is invoked for direct
1861  *      access devices (e.g. disks) only. There should be no block
1862  *      descriptor for other device types.
1863  *
1864  *      LOCKING:
1865  *      spin_lock_irqsave(host_set lock)
1866  */
1867
1868 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1869                                   unsigned int buflen)
1870 {
1871         struct ata_device *dev = args->dev;
1872         u8 *scsicmd = args->cmd->cmnd, *p, *last;
1873         const u8 sat_blk_desc[] = {
1874                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
1875                 0,
1876                 0, 0x2, 0x0     /* block length: 512 bytes */
1877         };
1878         u8 pg, spg;
1879         unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1880         u8 dpofua;
1881
1882         VPRINTK("ENTER\n");
1883
1884         six_byte = (scsicmd[0] == MODE_SENSE);
1885         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
1886         /*
1887          * LLBA bit in msense(10) ignored (compliant)
1888          */
1889
1890         page_control = scsicmd[2] >> 6;
1891         switch (page_control) {
1892         case 0: /* current */
1893                 break;  /* supported */
1894         case 3: /* saved */
1895                 goto saving_not_supp;
1896         case 1: /* changeable */
1897         case 2: /* defaults */
1898         default:
1899                 goto invalid_fld;
1900         }
1901
1902         if (six_byte) {
1903                 output_len = 4 + (ebd ? 8 : 0);
1904                 alloc_len = scsicmd[4];
1905         } else {
1906                 output_len = 8 + (ebd ? 8 : 0);
1907                 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1908         }
1909         minlen = (alloc_len < buflen) ? alloc_len : buflen;
1910
1911         p = rbuf + output_len;
1912         last = rbuf + minlen - 1;
1913
1914         pg = scsicmd[2] & 0x3f;
1915         spg = scsicmd[3];
1916         /*
1917          * No mode subpages supported (yet) but asking for _all_
1918          * subpages may be valid
1919          */
1920         if (spg && (spg != ALL_SUB_MPAGES))
1921                 goto invalid_fld;
1922
1923         switch(pg) {
1924         case RW_RECOVERY_MPAGE:
1925                 output_len += ata_msense_rw_recovery(&p, last);
1926                 break;
1927
1928         case CACHE_MPAGE:
1929                 output_len += ata_msense_caching(args->id, &p, last);
1930                 break;
1931
1932         case CONTROL_MPAGE: {
1933                 output_len += ata_msense_ctl_mode(&p, last);
1934                 break;
1935                 }
1936
1937         case ALL_MPAGES:
1938                 output_len += ata_msense_rw_recovery(&p, last);
1939                 output_len += ata_msense_caching(args->id, &p, last);
1940                 output_len += ata_msense_ctl_mode(&p, last);
1941                 break;
1942
1943         default:                /* invalid page code */
1944                 goto invalid_fld;
1945         }
1946
1947         if (minlen < 1)
1948                 return 0;
1949
1950         dpofua = 0;
1951         if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1952             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1953                 dpofua = 1 << 4;
1954
1955         if (six_byte) {
1956                 output_len--;
1957                 rbuf[0] = output_len;
1958                 if (minlen > 2)
1959                         rbuf[2] |= dpofua;
1960                 if (ebd) {
1961                         if (minlen > 3)
1962                                 rbuf[3] = sizeof(sat_blk_desc);
1963                         if (minlen > 11)
1964                                 memcpy(rbuf + 4, sat_blk_desc,
1965                                        sizeof(sat_blk_desc));
1966                 }
1967         } else {
1968                 output_len -= 2;
1969                 rbuf[0] = output_len >> 8;
1970                 if (minlen > 1)
1971                         rbuf[1] = output_len;
1972                 if (minlen > 3)
1973                         rbuf[3] |= dpofua;
1974                 if (ebd) {
1975                         if (minlen > 7)
1976                                 rbuf[7] = sizeof(sat_blk_desc);
1977                         if (minlen > 15)
1978                                 memcpy(rbuf + 8, sat_blk_desc,
1979                                        sizeof(sat_blk_desc));
1980                 }
1981         }
1982         return 0;
1983
1984 invalid_fld:
1985         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1986         /* "Invalid field in cbd" */
1987         return 1;
1988
1989 saving_not_supp:
1990         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1991          /* "Saving parameters not supported" */
1992         return 1;
1993 }
1994
1995 /**
1996  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1997  *      @args: device IDENTIFY data / SCSI command of interest.
1998  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1999  *      @buflen: Response buffer length.
2000  *
2001  *      Simulate READ CAPACITY commands.
2002  *
2003  *      LOCKING:
2004  *      spin_lock_irqsave(host_set lock)
2005  */
2006
2007 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2008                                 unsigned int buflen)
2009 {
2010         u64 n_sectors;
2011         u32 tmp;
2012
2013         VPRINTK("ENTER\n");
2014
2015         if (ata_id_has_lba(args->id)) {
2016                 if (ata_id_has_lba48(args->id))
2017                         n_sectors = ata_id_u64(args->id, 100);
2018                 else
2019                         n_sectors = ata_id_u32(args->id, 60);
2020         } else {
2021                 /* CHS default translation */
2022                 n_sectors = args->id[1] * args->id[3] * args->id[6];
2023
2024                 if (ata_id_current_chs_valid(args->id))
2025                         /* CHS current translation */
2026                         n_sectors = ata_id_u32(args->id, 57);
2027         }
2028
2029         n_sectors--;            /* ATA TotalUserSectors - 1 */
2030
2031         if (args->cmd->cmnd[0] == READ_CAPACITY) {
2032                 if( n_sectors >= 0xffffffffULL )
2033                         tmp = 0xffffffff ;  /* Return max count on overflow */
2034                 else
2035                         tmp = n_sectors ;
2036
2037                 /* sector count, 32-bit */
2038                 rbuf[0] = tmp >> (8 * 3);
2039                 rbuf[1] = tmp >> (8 * 2);
2040                 rbuf[2] = tmp >> (8 * 1);
2041                 rbuf[3] = tmp;
2042
2043                 /* sector size */
2044                 tmp = ATA_SECT_SIZE;
2045                 rbuf[6] = tmp >> 8;
2046                 rbuf[7] = tmp;
2047
2048         } else {
2049                 /* sector count, 64-bit */
2050                 tmp = n_sectors >> (8 * 4);
2051                 rbuf[2] = tmp >> (8 * 3);
2052                 rbuf[3] = tmp >> (8 * 2);
2053                 rbuf[4] = tmp >> (8 * 1);
2054                 rbuf[5] = tmp;
2055                 tmp = n_sectors;
2056                 rbuf[6] = tmp >> (8 * 3);
2057                 rbuf[7] = tmp >> (8 * 2);
2058                 rbuf[8] = tmp >> (8 * 1);
2059                 rbuf[9] = tmp;
2060
2061                 /* sector size */
2062                 tmp = ATA_SECT_SIZE;
2063                 rbuf[12] = tmp >> 8;
2064                 rbuf[13] = tmp;
2065         }
2066
2067         return 0;
2068 }
2069
2070 /**
2071  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
2072  *      @args: device IDENTIFY data / SCSI command of interest.
2073  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2074  *      @buflen: Response buffer length.
2075  *
2076  *      Simulate REPORT LUNS command.
2077  *
2078  *      LOCKING:
2079  *      spin_lock_irqsave(host_set lock)
2080  */
2081
2082 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2083                                    unsigned int buflen)
2084 {
2085         VPRINTK("ENTER\n");
2086         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2087
2088         return 0;
2089 }
2090
2091 /**
2092  *      ata_scsi_set_sense - Set SCSI sense data and status
2093  *      @cmd: SCSI request to be handled
2094  *      @sk: SCSI-defined sense key
2095  *      @asc: SCSI-defined additional sense code
2096  *      @ascq: SCSI-defined additional sense code qualifier
2097  *
2098  *      Helper function that builds a valid fixed format, current
2099  *      response code and the given sense key (sk), additional sense
2100  *      code (asc) and additional sense code qualifier (ascq) with
2101  *      a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2102  *      DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2103  *
2104  *      LOCKING:
2105  *      Not required
2106  */
2107
2108 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2109 {
2110         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2111
2112         cmd->sense_buffer[0] = 0x70;    /* fixed format, current */
2113         cmd->sense_buffer[2] = sk;
2114         cmd->sense_buffer[7] = 18 - 8;  /* additional sense length */
2115         cmd->sense_buffer[12] = asc;
2116         cmd->sense_buffer[13] = ascq;
2117 }
2118
2119 /**
2120  *      ata_scsi_badcmd - End a SCSI request with an error
2121  *      @cmd: SCSI request to be handled
2122  *      @done: SCSI command completion function
2123  *      @asc: SCSI-defined additional sense code
2124  *      @ascq: SCSI-defined additional sense code qualifier
2125  *
2126  *      Helper function that completes a SCSI command with
2127  *      %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2128  *      and the specified additional sense codes.
2129  *
2130  *      LOCKING:
2131  *      spin_lock_irqsave(host_set lock)
2132  */
2133
2134 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2135 {
2136         DPRINTK("ENTER\n");
2137         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2138
2139         done(cmd);
2140 }
2141
2142 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2143 {
2144         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
2145                 /* FIXME: not quite right; we don't want the
2146                  * translation of taskfile registers into
2147                  * a sense descriptors, since that's only
2148                  * correct for ATA, not ATAPI
2149                  */
2150                 ata_gen_ata_desc_sense(qc);
2151
2152         qc->scsidone(qc->scsicmd);
2153         ata_qc_free(qc);
2154 }
2155
2156 /* is it pointless to prefer PIO for "safety reasons"? */
2157 static inline int ata_pio_use_silly(struct ata_port *ap)
2158 {
2159         return (ap->flags & ATA_FLAG_PIO_DMA);
2160 }
2161
2162 static void atapi_request_sense(struct ata_queued_cmd *qc)
2163 {
2164         struct ata_port *ap = qc->ap;
2165         struct scsi_cmnd *cmd = qc->scsicmd;
2166
2167         DPRINTK("ATAPI request sense\n");
2168
2169         /* FIXME: is this needed? */
2170         memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2171
2172         ap->ops->tf_read(ap, &qc->tf);
2173
2174         /* fill these in, for the case where they are -not- overwritten */
2175         cmd->sense_buffer[0] = 0x70;
2176         cmd->sense_buffer[2] = qc->tf.feature >> 4;
2177
2178         ata_qc_reinit(qc);
2179
2180         ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2181         qc->dma_dir = DMA_FROM_DEVICE;
2182
2183         memset(&qc->cdb, 0, qc->dev->cdb_len);
2184         qc->cdb[0] = REQUEST_SENSE;
2185         qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2186
2187         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2188         qc->tf.command = ATA_CMD_PACKET;
2189
2190         if (ata_pio_use_silly(ap)) {
2191                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2192                 qc->tf.feature |= ATAPI_PKT_DMA;
2193         } else {
2194                 qc->tf.protocol = ATA_PROT_ATAPI;
2195                 qc->tf.lbam = (8 * 1024) & 0xff;
2196                 qc->tf.lbah = (8 * 1024) >> 8;
2197         }
2198         qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2199
2200         qc->complete_fn = atapi_sense_complete;
2201
2202         qc->err_mask = ata_qc_issue(qc);
2203         if (qc->err_mask)
2204                 ata_qc_complete(qc);
2205
2206         DPRINTK("EXIT\n");
2207 }
2208
2209 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2210 {
2211         struct scsi_cmnd *cmd = qc->scsicmd;
2212         unsigned int err_mask = qc->err_mask;
2213
2214         VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2215
2216         if (unlikely(err_mask & AC_ERR_DEV)) {
2217                 cmd->result = SAM_STAT_CHECK_CONDITION;
2218                 atapi_request_sense(qc);
2219                 return;
2220         }
2221
2222         else if (unlikely(err_mask))
2223                 /* FIXME: not quite right; we don't want the
2224                  * translation of taskfile registers into
2225                  * a sense descriptors, since that's only
2226                  * correct for ATA, not ATAPI
2227                  */
2228                 ata_gen_ata_desc_sense(qc);
2229
2230         else {
2231                 u8 *scsicmd = cmd->cmnd;
2232
2233                 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2234                         u8 *buf = NULL;
2235                         unsigned int buflen;
2236
2237                         buflen = ata_scsi_rbuf_get(cmd, &buf);
2238
2239         /* ATAPI devices typically report zero for their SCSI version,
2240          * and sometimes deviate from the spec WRT response data
2241          * format.  If SCSI version is reported as zero like normal,
2242          * then we make the following fixups:  1) Fake MMC-5 version,
2243          * to indicate to the Linux scsi midlayer this is a modern
2244          * device.  2) Ensure response data format / ATAPI information
2245          * are always correct.
2246          */
2247                         if (buf[2] == 0) {
2248                                 buf[2] = 0x5;
2249                                 buf[3] = 0x32;
2250                         }
2251
2252                         ata_scsi_rbuf_put(cmd, buf);
2253                 }
2254
2255                 cmd->result = SAM_STAT_GOOD;
2256         }
2257
2258         qc->scsidone(cmd);
2259         ata_qc_free(qc);
2260 }
2261 /**
2262  *      atapi_xlat - Initialize PACKET taskfile
2263  *      @qc: command structure to be initialized
2264  *      @scsicmd: SCSI CDB associated with this PACKET command
2265  *
2266  *      LOCKING:
2267  *      spin_lock_irqsave(host_set lock)
2268  *
2269  *      RETURNS:
2270  *      Zero on success, non-zero on failure.
2271  */
2272
2273 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2274 {
2275         struct scsi_cmnd *cmd = qc->scsicmd;
2276         struct ata_device *dev = qc->dev;
2277         int using_pio = (dev->flags & ATA_DFLAG_PIO);
2278         int nodata = (cmd->sc_data_direction == DMA_NONE);
2279
2280         if (!using_pio)
2281                 /* Check whether ATAPI DMA is safe */
2282                 if (ata_check_atapi_dma(qc))
2283                         using_pio = 1;
2284
2285         memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2286
2287         qc->complete_fn = atapi_qc_complete;
2288
2289         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2290         if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2291                 qc->tf.flags |= ATA_TFLAG_WRITE;
2292                 DPRINTK("direction: write\n");
2293         }
2294
2295         qc->tf.command = ATA_CMD_PACKET;
2296
2297         /* no data, or PIO data xfer */
2298         if (using_pio || nodata) {
2299                 if (nodata)
2300                         qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2301                 else
2302                         qc->tf.protocol = ATA_PROT_ATAPI;
2303                 qc->tf.lbam = (8 * 1024) & 0xff;
2304                 qc->tf.lbah = (8 * 1024) >> 8;
2305         }
2306
2307         /* DMA data xfer */
2308         else {
2309                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2310                 qc->tf.feature |= ATAPI_PKT_DMA;
2311
2312 #ifdef ATAPI_ENABLE_DMADIR
2313                 /* some SATA bridges need us to indicate data xfer direction */
2314                 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2315                         qc->tf.feature |= ATAPI_DMADIR;
2316 #endif
2317         }
2318
2319         qc->nbytes = cmd->bufflen;
2320
2321         return 0;
2322 }
2323
2324 /**
2325  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2326  *      @ap: ATA port to which the device is attached
2327  *      @scsidev: SCSI device from which we derive the ATA device
2328  *
2329  *      Given various information provided in struct scsi_cmnd,
2330  *      map that onto an ATA bus, and using that mapping
2331  *      determine which ata_device is associated with the
2332  *      SCSI command to be sent.
2333  *
2334  *      LOCKING:
2335  *      spin_lock_irqsave(host_set lock)
2336  *
2337  *      RETURNS:
2338  *      Associated ATA device, or %NULL if not found.
2339  */
2340
2341 static struct ata_device *
2342 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2343 {
2344         struct ata_device *dev;
2345
2346         /* skip commands not addressed to targets we simulate */
2347         if (likely(scsidev->id < ATA_MAX_DEVICES))
2348                 dev = &ap->device[scsidev->id];
2349         else
2350                 return NULL;
2351
2352         if (unlikely((scsidev->channel != 0) ||
2353                      (scsidev->lun != 0)))
2354                 return NULL;
2355
2356         if (unlikely(!ata_dev_present(dev)))
2357                 return NULL;
2358
2359         if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2360                 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2361                         printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2362                                ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
2363                         return NULL;
2364                 }
2365         }
2366
2367         return dev;
2368 }
2369
2370 /*
2371  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2372  *      @byte1: Byte 1 from pass-thru CDB.
2373  *
2374  *      RETURNS:
2375  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2376  */
2377 static u8
2378 ata_scsi_map_proto(u8 byte1)
2379 {
2380         switch((byte1 & 0x1e) >> 1) {
2381                 case 3:         /* Non-data */
2382                         return ATA_PROT_NODATA;
2383
2384                 case 6:         /* DMA */
2385                         return ATA_PROT_DMA;
2386
2387                 case 4:         /* PIO Data-in */
2388                 case 5:         /* PIO Data-out */
2389                         return ATA_PROT_PIO;
2390
2391                 case 10:        /* Device Reset */
2392                 case 0:         /* Hard Reset */
2393                 case 1:         /* SRST */
2394                 case 2:         /* Bus Idle */
2395                 case 7:         /* Packet */
2396                 case 8:         /* DMA Queued */
2397                 case 9:         /* Device Diagnostic */
2398                 case 11:        /* UDMA Data-in */
2399                 case 12:        /* UDMA Data-Out */
2400                 case 13:        /* FPDMA */
2401                 default:        /* Reserved */
2402                         break;
2403         }
2404
2405         return ATA_PROT_UNKNOWN;
2406 }
2407
2408 /**
2409  *      ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2410  *      @qc: command structure to be initialized
2411  *      @scsicmd: SCSI command to convert
2412  *
2413  *      Handles either 12 or 16-byte versions of the CDB.
2414  *
2415  *      RETURNS:
2416  *      Zero on success, non-zero on failure.
2417  */
2418 static unsigned int
2419 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2420 {
2421         struct ata_taskfile *tf = &(qc->tf);
2422         struct scsi_cmnd *cmd = qc->scsicmd;
2423
2424         if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2425                 goto invalid_fld;
2426
2427         if (scsicmd[1] & 0xe0)
2428                 /* PIO multi not supported yet */
2429                 goto invalid_fld;
2430
2431         /*
2432          * 12 and 16 byte CDBs use different offsets to
2433          * provide the various register values.
2434          */
2435         if (scsicmd[0] == ATA_16) {
2436                 /*
2437                  * 16-byte CDB - may contain extended commands.
2438                  *
2439                  * If that is the case, copy the upper byte register values.
2440                  */
2441                 if (scsicmd[1] & 0x01) {
2442                         tf->hob_feature = scsicmd[3];
2443                         tf->hob_nsect = scsicmd[5];
2444                         tf->hob_lbal = scsicmd[7];
2445                         tf->hob_lbam = scsicmd[9];
2446                         tf->hob_lbah = scsicmd[11];
2447                         tf->flags |= ATA_TFLAG_LBA48;
2448                 } else
2449                         tf->flags &= ~ATA_TFLAG_LBA48;
2450
2451                 /*
2452                  * Always copy low byte, device and command registers.
2453                  */
2454                 tf->feature = scsicmd[4];
2455                 tf->nsect = scsicmd[6];
2456                 tf->lbal = scsicmd[8];
2457                 tf->lbam = scsicmd[10];
2458                 tf->lbah = scsicmd[12];
2459                 tf->device = scsicmd[13];
2460                 tf->command = scsicmd[14];
2461         } else {
2462                 /*
2463                  * 12-byte CDB - incapable of extended commands.
2464                  */
2465                 tf->flags &= ~ATA_TFLAG_LBA48;
2466
2467                 tf->feature = scsicmd[3];
2468                 tf->nsect = scsicmd[4];
2469                 tf->lbal = scsicmd[5];
2470                 tf->lbam = scsicmd[6];
2471                 tf->lbah = scsicmd[7];
2472                 tf->device = scsicmd[8];
2473                 tf->command = scsicmd[9];
2474         }
2475         /*
2476          * If slave is possible, enforce correct master/slave bit
2477         */
2478         if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2479                 tf->device = qc->dev->devno ?
2480                         tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2481
2482         /*
2483          * Filter SET_FEATURES - XFER MODE command -- otherwise,
2484          * SET_FEATURES - XFER MODE must be preceded/succeeded
2485          * by an update to hardware-specific registers for each
2486          * controller (i.e. the reason for ->set_piomode(),
2487          * ->set_dmamode(), and ->post_set_mode() hooks).
2488          */
2489         if ((tf->command == ATA_CMD_SET_FEATURES)
2490          && (tf->feature == SETFEATURES_XFER))
2491                 goto invalid_fld;
2492
2493         /*
2494          * Set flags so that all registers will be written,
2495          * and pass on write indication (used for PIO/DMA
2496          * setup.)
2497          */
2498         tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2499
2500         if (cmd->sc_data_direction == DMA_TO_DEVICE)
2501                 tf->flags |= ATA_TFLAG_WRITE;
2502
2503         /*
2504          * Set transfer length.
2505          *
2506          * TODO: find out if we need to do more here to
2507          *       cover scatter/gather case.
2508          */
2509         qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2510
2511         return 0;
2512
2513  invalid_fld:
2514         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2515         /* "Invalid field in cdb" */
2516         return 1;
2517 }
2518
2519 /**
2520  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
2521  *      @dev: ATA device
2522  *      @cmd: SCSI command opcode to consider
2523  *
2524  *      Look up the SCSI command given, and determine whether the
2525  *      SCSI command is to be translated or simulated.
2526  *
2527  *      RETURNS:
2528  *      Pointer to translation function if possible, %NULL if not.
2529  */
2530
2531 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2532 {
2533         switch (cmd) {
2534         case READ_6:
2535         case READ_10:
2536         case READ_16:
2537
2538         case WRITE_6:
2539         case WRITE_10:
2540         case WRITE_16:
2541                 return ata_scsi_rw_xlat;
2542
2543         case SYNCHRONIZE_CACHE:
2544                 if (ata_try_flush_cache(dev))
2545                         return ata_scsi_flush_xlat;
2546                 break;
2547
2548         case VERIFY:
2549         case VERIFY_16:
2550                 return ata_scsi_verify_xlat;
2551
2552         case ATA_12:
2553         case ATA_16:
2554                 return ata_scsi_pass_thru;
2555
2556         case START_STOP:
2557                 return ata_scsi_start_stop_xlat;
2558         }
2559
2560         return NULL;
2561 }
2562
2563 /**
2564  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2565  *      @ap: ATA port to which the command was being sent
2566  *      @cmd: SCSI command to dump
2567  *
2568  *      Prints the contents of a SCSI command via printk().
2569  */
2570
2571 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2572                                      struct scsi_cmnd *cmd)
2573 {
2574 #ifdef ATA_DEBUG
2575         struct scsi_device *scsidev = cmd->device;
2576         u8 *scsicmd = cmd->cmnd;
2577
2578         DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2579                 ap->id,
2580                 scsidev->channel, scsidev->id, scsidev->lun,
2581                 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2582                 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2583                 scsicmd[8]);
2584 #endif
2585 }
2586
2587 static inline void __ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
2588                                        struct ata_port *ap, struct ata_device *dev)
2589 {
2590         if (dev->class == ATA_DEV_ATA) {
2591                 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2592                                                               cmd->cmnd[0]);
2593
2594                 if (xlat_func)
2595                         ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2596                 else
2597                         ata_scsi_simulate(ap, dev, cmd, done);
2598         } else
2599                 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2600 }
2601
2602 /**
2603  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2604  *      @cmd: SCSI command to be sent
2605  *      @done: Completion function, called when command is complete
2606  *
2607  *      In some cases, this function translates SCSI commands into
2608  *      ATA taskfiles, and queues the taskfiles to be sent to
2609  *      hardware.  In other cases, this function simulates a
2610  *      SCSI device by evaluating and responding to certain
2611  *      SCSI commands.  This creates the overall effect of
2612  *      ATA and ATAPI devices appearing as SCSI devices.
2613  *
2614  *      LOCKING:
2615  *      Releases scsi-layer-held lock, and obtains host_set lock.
2616  *
2617  *      RETURNS:
2618  *      Zero.
2619  */
2620
2621 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2622 {
2623         struct ata_port *ap;
2624         struct ata_device *dev;
2625         struct scsi_device *scsidev = cmd->device;
2626         struct Scsi_Host *shost = scsidev->host;
2627
2628         ap = (struct ata_port *) &shost->hostdata[0];
2629
2630         spin_unlock(shost->host_lock);
2631         spin_lock(&ap->host_set->lock);
2632
2633         ata_scsi_dump_cdb(ap, cmd);
2634
2635         dev = ata_scsi_find_dev(ap, scsidev);
2636         if (likely(dev))
2637                 __ata_scsi_queuecmd(cmd, done, ap, dev);
2638         else {
2639                 cmd->result = (DID_BAD_TARGET << 16);
2640                 done(cmd);
2641         }
2642
2643         spin_unlock(&ap->host_set->lock);
2644         spin_lock(shost->host_lock);
2645         return 0;
2646 }
2647
2648 /**
2649  *      ata_scsi_simulate - simulate SCSI command on ATA device
2650  *      @ap: port the device is connected to
2651  *      @dev: the target device
2652  *      @cmd: SCSI command being sent to device.
2653  *      @done: SCSI command completion function.
2654  *
2655  *      Interprets and directly executes a select list of SCSI commands
2656  *      that can be handled internally.
2657  *
2658  *      LOCKING:
2659  *      spin_lock_irqsave(host_set lock)
2660  */
2661
2662 void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
2663                       struct scsi_cmnd *cmd,
2664                       void (*done)(struct scsi_cmnd *))
2665 {
2666         struct ata_scsi_args args;
2667         const u8 *scsicmd = cmd->cmnd;
2668
2669         args.ap = ap;
2670         args.dev = dev;
2671         args.id = dev->id;
2672         args.cmd = cmd;
2673         args.done = done;
2674
2675         switch(scsicmd[0]) {
2676                 /* no-op's, complete with success */
2677                 case SYNCHRONIZE_CACHE:
2678                 case REZERO_UNIT:
2679                 case SEEK_6:
2680                 case SEEK_10:
2681                 case TEST_UNIT_READY:
2682                 case FORMAT_UNIT:               /* FIXME: correct? */
2683                 case SEND_DIAGNOSTIC:           /* FIXME: correct? */
2684                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2685                         break;
2686
2687                 case INQUIRY:
2688                         if (scsicmd[1] & 2)                /* is CmdDt set?  */
2689                                 ata_scsi_invalid_field(cmd, done);
2690                         else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
2691                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2692                         else if (scsicmd[2] == 0x00)
2693                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2694                         else if (scsicmd[2] == 0x80)
2695                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2696                         else if (scsicmd[2] == 0x83)
2697                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2698                         else
2699                                 ata_scsi_invalid_field(cmd, done);
2700                         break;
2701
2702                 case MODE_SENSE:
2703                 case MODE_SENSE_10:
2704                         ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2705                         break;
2706
2707                 case MODE_SELECT:       /* unconditionally return */
2708                 case MODE_SELECT_10:    /* bad-field-in-cdb */
2709                         ata_scsi_invalid_field(cmd, done);
2710                         break;
2711
2712                 case READ_CAPACITY:
2713                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2714                         break;
2715
2716                 case SERVICE_ACTION_IN:
2717                         if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2718                                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2719                         else
2720                                 ata_scsi_invalid_field(cmd, done);
2721                         break;
2722
2723                 case REPORT_LUNS:
2724                         ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2725                         break;
2726
2727                 /* mandatory commands we haven't implemented yet */
2728                 case REQUEST_SENSE:
2729
2730                 /* all other commands */
2731                 default:
2732                         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2733                         /* "Invalid command operation code" */
2734                         done(cmd);
2735                         break;
2736         }
2737 }
2738
2739 void ata_scsi_scan_host(struct ata_port *ap)
2740 {
2741         struct ata_device *dev;
2742         unsigned int i;
2743
2744         if (ap->flags & ATA_FLAG_PORT_DISABLED)
2745                 return;
2746
2747         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2748                 dev = &ap->device[i];
2749
2750                 if (ata_dev_present(dev))
2751                         scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2752         }
2753 }
2754