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