drivers/scsi/libata-scsi.c

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