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