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 <linux/libata.h>
  43 #include <asm/uaccess.h>
  44
  45 #include "libata.h"
  46
  47 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, u8 *scsicmd);
  48 static struct ata_device *
  49 ata_scsi_find_dev(struct ata_port *ap, struct scsi_device *scsidev);
  50
  51
  52 /**
  53  *      ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
  54  *      @sdev: SCSI device for which BIOS geometry is to be determined
  55  *      @bdev: block device associated with @sdev
  56  *      @capacity: capacity of SCSI device
  57  *      @geom: location to which geometry will be output
  58  *
  59  *      Generic bios head/sector/cylinder calculator
  60  *      used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
  61  *      mapping. Some situations may arise where the disk is not
  62  *      bootable if this is not used.
  63  *
  64  *      LOCKING:
  65  *      Defined by the SCSI layer.  We don't really care.
  66  *
  67  *      RETURNS:
  68  *      Zero.
  69  */
  70 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
  71                        sector_t capacity, int geom[])
  72 {
  73         geom[0] = 255;
  74         geom[1] = 63;
  75         sector_div(capacity, 255*63);
  76         geom[2] = capacity;
  77
  78         return 0;
  79 }
  80
  81 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
  82 {
  83         struct ata_port *ap;
  84         struct ata_device *dev;
  85         int val = -EINVAL, rc = -EINVAL;
  86
  87         ap = (struct ata_port *) &scsidev->host->hostdata[0];
  88         if (!ap)
  89                 goto out;
  90
  91         dev = ata_scsi_find_dev(ap, scsidev);
  92         if (!dev) {
  93                 rc = -ENODEV;
  94                 goto out;
  95         }
  96
  97         switch (cmd) {
  98         case ATA_IOC_GET_IO32:
  99                 val = 0;
 100                 if (copy_to_user(arg, &val, 1))
 101                         return -EFAULT;
 102                 return 0;
 103
 104         case ATA_IOC_SET_IO32:
 105                 val = (unsigned long) arg;
 106                 if (val != 0)
 107                         return -EINVAL;
 108                 return 0;
 109
 110         default:
 111                 rc = -ENOTTY;
 112                 break;
 113         }
 114
 115 out:
 116         return rc;
 117 }
 118
 119 /**
 120  *      ata_scsi_qc_new - acquire new ata_queued_cmd reference
 121  *      @ap: ATA port to which the new command is attached
 122  *      @dev: ATA device to which the new command is attached
 123  *      @cmd: SCSI command that originated this ATA command
 124  *      @done: SCSI command completion function
 125  *
 126  *      Obtain a reference to an unused ata_queued_cmd structure,
 127  *      which is the basic libata structure representing a single
 128  *      ATA command sent to the hardware.
 129  *
 130  *      If a command was available, fill in the SCSI-specific
 131  *      portions of the structure with information on the
 132  *      current command.
 133  *
 134  *      LOCKING:
 135  *      spin_lock_irqsave(host_set lock)
 136  *
 137  *      RETURNS:
 138  *      Command allocated, or %NULL if none available.
 139  */
 140 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
 141                                        struct ata_device *dev,
 142                                        struct scsi_cmnd *cmd,
 143                                        void (*done)(struct scsi_cmnd *))
 144 {
 145         struct ata_queued_cmd *qc;
 146
 147         qc = ata_qc_new_init(ap, dev);
 148         if (qc) {
 149                 qc->scsicmd = cmd;
 150                 qc->scsidone = done;
 151
 152                 if (cmd->use_sg) {
 153                         qc->sg = (struct scatterlist *) cmd->request_buffer;
 154                         qc->n_elem = cmd->use_sg;
 155                 } else {
 156                         qc->sg = &qc->sgent;
 157                         qc->n_elem = 1;
 158                 }
 159         } else {
 160                 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
 161                 done(cmd);
 162         }
 163
 164         return qc;
 165 }
 166
 167 /**
 168  *      ata_to_sense_error - convert ATA error to SCSI error
 169  *      @qc: Command that we are erroring out
 170  *      @drv_stat: value contained in ATA status register
 171  *
 172  *      Converts an ATA error into a SCSI error. While we are at it
 173  *      we decode and dump the ATA error for the user so that they
 174  *      have some idea what really happened at the non make-believe
 175  *      layer.
 176  *
 177  *      LOCKING:
 178  *      spin_lock_irqsave(host_set lock)
 179  */
 180
 181 void ata_to_sense_error(struct ata_queued_cmd *qc, u8 drv_stat)
 182 {
 183         struct scsi_cmnd *cmd = qc->scsicmd;
 184         u8 err = 0;
 185         unsigned char *sb = cmd->sense_buffer;
 186         /* Based on the 3ware driver translation table */
 187         static unsigned char sense_table[][4] = {
 188                 /* BBD|ECC|ID|MAR */
 189                 {0xd1,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
 190                 /* BBD|ECC|ID */
 191                 {0xd0,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
 192                 /* ECC|MC|MARK */
 193                 {0x61,          HARDWARE_ERROR, 0x00, 0x00},    // Device fault                 Hardware error
 194                 /* ICRC|ABRT */         /* NB: ICRC & !ABRT is BBD */
 195                 {0x84,          ABORTED_COMMAND, 0x47, 0x00},   // Data CRC error               SCSI parity error
 196                 /* MC|ID|ABRT|TRK0|MARK */
 197                 {0x37,          NOT_READY, 0x04, 0x00},         // Unit offline                 Not ready
 198                 /* MCR|MARK */
 199                 {0x09,          NOT_READY, 0x04, 0x00},         // Unrecovered disk error       Not ready
 200                 /*  Bad address mark */
 201                 {0x01,          MEDIUM_ERROR, 0x13, 0x00},      // Address mark not found       Address mark not found for data field
 202                 /* TRK0 */
 203                 {0x02,          HARDWARE_ERROR, 0x00, 0x00},    // Track 0 not found              Hardware error
 204                 /* Abort & !ICRC */
 205                 {0x04,          ABORTED_COMMAND, 0x00, 0x00},   // Aborted command              Aborted command
 206                 /* Media change request */
 207                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change request   FIXME: faking offline
 208                 /* SRV */
 209                 {0x10,          ABORTED_COMMAND, 0x14, 0x00},   // ID not found                 Recorded entity not found
 210                 /* Media change */
 211                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change           FIXME: faking offline
 212                 /* ECC */
 213                 {0x40,          MEDIUM_ERROR, 0x11, 0x04},      // Uncorrectable ECC error      Unrecovered read error
 214                 /* BBD - block marked bad */
 215                 {0x80,          MEDIUM_ERROR, 0x11, 0x04},      // Block marked bad               Medium error, unrecovered read error
 216                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
 217         };
 218         static unsigned char stat_table[][4] = {
 219                 /* Must be first because BUSY means no other bits valid */
 220                 {0x80,          ABORTED_COMMAND, 0x47, 0x00},   // Busy, fake parity for now
 221                 {0x20,          HARDWARE_ERROR,  0x00, 0x00},   // Device fault
 222                 {0x08,          ABORTED_COMMAND, 0x47, 0x00},   // Timed out in xfer, fake parity for now
 223                 {0x04,          RECOVERED_ERROR, 0x11, 0x00},   // Recovered ECC error    Medium error, recovered
 224                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
 225         };
 226         int i = 0;
 227
 228         cmd->result = SAM_STAT_CHECK_CONDITION;
 229
 230         /*
 231          *      Is this an error we can process/parse
 232          */
 233
 234         if(drv_stat & ATA_ERR)
 235                 /* Read the err bits */
 236                 err = ata_chk_err(qc->ap);
 237
 238         /* Display the ATA level error info */
 239
 240         printk(KERN_WARNING "ata%u: status=0x%02x { ", qc->ap->id, drv_stat);
 241         if(drv_stat & 0x80)
 242         {
 243                 printk("Busy ");
 244                 err = 0;        /* Data is not valid in this case */
 245         }
 246         else {
 247                 if(drv_stat & 0x40)     printk("DriveReady ");
 248                 if(drv_stat & 0x20)     printk("DeviceFault ");
 249                 if(drv_stat & 0x10)     printk("SeekComplete ");
 250                 if(drv_stat & 0x08)     printk("DataRequest ");
 251                 if(drv_stat & 0x04)     printk("CorrectedError ");
 252                 if(drv_stat & 0x02)     printk("Index ");
 253                 if(drv_stat & 0x01)     printk("Error ");
 254         }
 255         printk("}\n");
 256
 257         if(err)
 258         {
 259                 printk(KERN_WARNING "ata%u: error=0x%02x { ", qc->ap->id, err);
 260                 if(err & 0x04)          printk("DriveStatusError ");
 261                 if(err & 0x80)
 262                 {
 263                         if(err & 0x04)
 264                                 printk("BadCRC ");
 265                         else
 266                                 printk("Sector ");
 267                 }
 268                 if(err & 0x40)          printk("UncorrectableError ");
 269                 if(err & 0x10)          printk("SectorIdNotFound ");
 270                 if(err & 0x02)          printk("TrackZeroNotFound ");
 271                 if(err & 0x01)          printk("AddrMarkNotFound ");
 272                 printk("}\n");
 273
 274                 /* Should we dump sector info here too ?? */
 275         }
 276
 277
 278         /* Look for err */
 279         while(sense_table[i][0] != 0xFF)
 280         {
 281                 /* Look for best matches first */
 282                 if((sense_table[i][0] & err) == sense_table[i][0])
 283                 {
 284                         sb[0] = 0x70;
 285                         sb[2] = sense_table[i][1];
 286                         sb[7] = 0x0a;
 287                         sb[12] = sense_table[i][2];
 288                         sb[13] = sense_table[i][3];
 289                         return;
 290                 }
 291                 i++;
 292         }
 293         /* No immediate match */
 294         if(err)
 295                 printk(KERN_DEBUG "ata%u: no sense translation for 0x%02x\n", qc->ap->id, err);
 296
 297         i = 0;
 298         /* Fall back to interpreting status bits */
 299         while(stat_table[i][0] != 0xFF)
 300         {
 301                 if(stat_table[i][0] & drv_stat)
 302                 {
 303                         sb[0] = 0x70;
 304                         sb[2] = stat_table[i][1];
 305                         sb[7] = 0x0a;
 306                         sb[12] = stat_table[i][2];
 307                         sb[13] = stat_table[i][3];
 308                         return;
 309                 }
 310                 i++;
 311         }
 312         /* No error ?? */
 313         printk(KERN_ERR "ata%u: called with no error (%02X)!\n", qc->ap->id, drv_stat);
 314         /* additional-sense-code[-qualifier] */
 315
 316         sb[0] = 0x70;
 317         sb[2] = MEDIUM_ERROR;
 318         sb[7] = 0x0A;
 319         if (cmd->sc_data_direction == DMA_FROM_DEVICE) {
 320                 sb[12] = 0x11; /* "unrecovered read error" */
 321                 sb[13] = 0x04;
 322         } else {
 323                 sb[12] = 0x0C; /* "write error -             */
 324                 sb[13] = 0x02; /*  auto-reallocation failed" */
 325         }
 326 }
 327
 328 /**
 329  *      ata_scsi_slave_config - Set SCSI device attributes
 330  *      @sdev: SCSI device to examine
 331  *
 332  *      This is called before we actually start reading
 333  *      and writing to the device, to configure certain
 334  *      SCSI mid-layer behaviors.
 335  *
 336  *      LOCKING:
 337  *      Defined by SCSI layer.  We don't really care.
 338  */
 339
 340 int ata_scsi_slave_config(struct scsi_device *sdev)
 341 {
 342         sdev->use_10_for_rw = 1;
 343         sdev->use_10_for_ms = 1;
 344
 345         blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
 346
 347         if (sdev->id < ATA_MAX_DEVICES) {
 348                 struct ata_port *ap;
 349                 struct ata_device *dev;
 350
 351                 ap = (struct ata_port *) &sdev->host->hostdata[0];
 352                 dev = &ap->device[sdev->id];
 353
 354                 /* TODO: 1024 is an arbitrary number, not the
 355                  * hardware maximum.  This should be increased to
 356                  * 65534 when Jens Axboe's patch for dynamically
 357                  * determining max_sectors is merged.
 358                  */
 359                 if ((dev->flags & ATA_DFLAG_LBA48) &&
 360                     ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
 361                         /*
 362                          * do not overwrite sdev->host->max_sectors, since
 363                          * other drives on this host may not support LBA48
 364                          */
 365                         blk_queue_max_sectors(sdev->request_queue, 2048);
 366                 }
 367         }
 368
 369         return 0;       /* scsi layer doesn't check return value, sigh */
 370 }
 371
 372 /**
 373  *      ata_scsi_error - SCSI layer error handler callback
 374  *      @host: SCSI host on which error occurred
 375  *
 376  *      Handles SCSI-layer-thrown error events.
 377  *
 378  *      LOCKING:
 379  *      Inherited from SCSI layer (none, can sleep)
 380  *
 381  *      RETURNS:
 382  *      Zero.
 383  */
 384
 385 int ata_scsi_error(struct Scsi_Host *host)
 386 {
 387         struct ata_port *ap;
 388
 389         DPRINTK("ENTER\n");
 390
 391         ap = (struct ata_port *) &host->hostdata[0];
 392         ap->ops->eng_timeout(ap);
 393
 394         /* TODO: this is per-command; when queueing is supported
 395          * this code will either change or move to a more
 396          * appropriate place
 397          */
 398         host->host_failed--;
 399         INIT_LIST_HEAD(&host->eh_cmd_q);
 400
 401         DPRINTK("EXIT\n");
 402         return 0;
 403 }
 404
 405 /**
 406  *      ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
 407  *      @qc: Storage for translated ATA taskfile
 408  *      @scsicmd: SCSI command to translate
 409  *
 410  *      Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
 411  *      (to start). Perhaps these commands should be preceded by
 412  *      CHECK POWER MODE to see what power mode the device is already in.
 413  *      [See SAT revision 5 at www.t10.org]
 414  *
 415  *      LOCKING:
 416  *      spin_lock_irqsave(host_set lock)
 417  *
 418  *      RETURNS:
 419  *      Zero on success, non-zero on error.
 420  */
 421
 422 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
 423                                              u8 *scsicmd)
 424 {
 425         struct ata_taskfile *tf = &qc->tf;
 426
 427         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
 428         tf->protocol = ATA_PROT_NODATA;
 429         if (scsicmd[1] & 0x1) {
 430                 ;       /* ignore IMMED bit, violates sat-r05 */
 431         }
 432         if (scsicmd[4] & 0x2)
 433                 return 1;       /* LOEJ bit set not supported */
 434         if (((scsicmd[4] >> 4) & 0xf) != 0)
 435                 return 1;       /* power conditions not supported */
 436         if (scsicmd[4] & 0x1) {
 437                 tf->nsect = 1;  /* 1 sector, lba=0 */
 438                 tf->lbah = 0x0;
 439                 tf->lbam = 0x0;
 440                 tf->lbal = 0x0;
 441                 tf->device |= ATA_LBA;
 442                 tf->command = ATA_CMD_VERIFY;   /* READ VERIFY */
 443         } else {
 444                 tf->nsect = 0;  /* time period value (0 implies now) */
 445                 tf->command = ATA_CMD_STANDBY;
 446                 /* Consider: ATA STANDBY IMMEDIATE command */
 447         }
 448         /*
 449          * Standby and Idle condition timers could be implemented but that
 450          * would require libata to implement the Power condition mode page
 451          * and allow the user to change it. Changing mode pages requires
 452          * MODE SELECT to be implemented.
 453          */
 454
 455         return 0;
 456 }
 457
 458
 459 /**
 460  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
 461  *      @qc: Storage for translated ATA taskfile
 462  *      @scsicmd: SCSI command to translate (ignored)
 463  *
 464  *      Sets up an ATA taskfile to issue FLUSH CACHE or
 465  *      FLUSH CACHE EXT.
 466  *
 467  *      LOCKING:
 468  *      spin_lock_irqsave(host_set lock)
 469  *
 470  *      RETURNS:
 471  *      Zero on success, non-zero on error.
 472  */
 473
 474 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
 475 {
 476         struct ata_taskfile *tf = &qc->tf;
 477
 478         tf->flags |= ATA_TFLAG_DEVICE;
 479         tf->protocol = ATA_PROT_NODATA;
 480
 481         if ((tf->flags & ATA_TFLAG_LBA48) &&
 482             (ata_id_has_flush_ext(qc->dev->id)))
 483                 tf->command = ATA_CMD_FLUSH_EXT;
 484         else
 485                 tf->command = ATA_CMD_FLUSH;
 486
 487         return 0;
 488 }
 489
 490 /**
 491  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
 492  *      @qc: Storage for translated ATA taskfile
 493  *      @scsicmd: SCSI command to translate
 494  *
 495  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
 496  *
 497  *      LOCKING:
 498  *      spin_lock_irqsave(host_set lock)
 499  *
 500  *      RETURNS:
 501  *      Zero on success, non-zero on error.
 502  */
 503
 504 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
 505 {
 506         struct ata_taskfile *tf = &qc->tf;
 507         struct ata_device *dev = qc->dev;
 508         unsigned int lba   = tf->flags & ATA_TFLAG_LBA;
 509         unsigned int lba48 = tf->flags & ATA_TFLAG_LBA48;
 510         u64 dev_sectors = qc->dev->n_sectors;
 511         u64 block = 0;
 512         u32 n_block = 0;
 513
 514         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
 515         tf->protocol = ATA_PROT_NODATA;
 516
 517         if (scsicmd[0] == VERIFY) {
 518                 block |= ((u64)scsicmd[2]) << 24;
 519                 block |= ((u64)scsicmd[3]) << 16;
 520                 block |= ((u64)scsicmd[4]) << 8;
 521                 block |= ((u64)scsicmd[5]);
 522
 523                 n_block |= ((u32)scsicmd[7]) << 8;
 524                 n_block |= ((u32)scsicmd[8]);
 525         }
 526
 527         else if (scsicmd[0] == VERIFY_16) {
 528                 block |= ((u64)scsicmd[2]) << 56;
 529                 block |= ((u64)scsicmd[3]) << 48;
 530                 block |= ((u64)scsicmd[4]) << 40;
 531                 block |= ((u64)scsicmd[5]) << 32;
 532                 block |= ((u64)scsicmd[6]) << 24;
 533                 block |= ((u64)scsicmd[7]) << 16;
 534                 block |= ((u64)scsicmd[8]) << 8;
 535                 block |= ((u64)scsicmd[9]);
 536
 537                 n_block |= ((u32)scsicmd[10]) << 24;
 538                 n_block |= ((u32)scsicmd[11]) << 16;
 539                 n_block |= ((u32)scsicmd[12]) << 8;
 540                 n_block |= ((u32)scsicmd[13]);
 541         }
 542
 543         else
 544                 return 1;
 545
 546         if (!n_block)
 547                 return 1;
 548         if (block >= dev_sectors)
 549                 return 1;
 550         if ((block + n_block) > dev_sectors)
 551                 return 1;
 552         if (lba48) {
 553                 if (n_block > (64 * 1024))
 554                         return 1;
 555         } else {
 556                 if (n_block > 256)
 557                         return 1;
 558         }
 559
 560         if (lba) {
 561                 if (lba48) {
 562                         tf->command = ATA_CMD_VERIFY_EXT;
 563
 564                         tf->hob_nsect = (n_block >> 8) & 0xff;
 565
 566                         tf->hob_lbah = (block >> 40) & 0xff;
 567                         tf->hob_lbam = (block >> 32) & 0xff;
 568                         tf->hob_lbal = (block >> 24) & 0xff;
 569                 } else {
 570                         tf->command = ATA_CMD_VERIFY;
 571
 572                         tf->device |= (block >> 24) & 0xf;
 573                 }
 574
 575                 tf->nsect = n_block & 0xff;
 576
 577                 tf->lbah = (block >> 16) & 0xff;
 578                 tf->lbam = (block >> 8) & 0xff;
 579                 tf->lbal = block & 0xff;
 580
 581                 tf->device |= ATA_LBA;
 582         } else {
 583                 /* CHS */
 584                 u32 sect, head, cyl, track;
 585
 586                 /* Convert LBA to CHS */
 587                 track = (u32)block / dev->sectors;
 588                 cyl   = track / dev->heads;
 589                 head  = track % dev->heads;
 590                 sect  = (u32)block % dev->sectors + 1;
 591
 592                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
 593                         (u32)block, track, cyl, head, sect);
 594
 595                 /* Check whether the converted CHS can fit.
 596                    Cylinder: 0-65535
 597                    Head: 0-15
 598                    Sector: 1-255*/
 599                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
 600                         return 1;
 601
 602                 tf->command = ATA_CMD_VERIFY;
 603                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
 604                 tf->lbal = sect;
 605                 tf->lbam = cyl;
 606                 tf->lbah = cyl >> 8;
 607                 tf->device |= head;
 608         }
 609
 610         return 0;
 611 }
 612
 613 /**
 614  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
 615  *      @qc: Storage for translated ATA taskfile
 616  *      @scsicmd: SCSI command to translate
 617  *
 618  *      Converts any of six SCSI read/write commands into the
 619  *      ATA counterpart, including starting sector (LBA),
 620  *      sector count, and taking into account the device's LBA48
 621  *      support.
 622  *
 623  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
 624  *      %WRITE_16 are currently supported.
 625  *
 626  *      LOCKING:
 627  *      spin_lock_irqsave(host_set lock)
 628  *
 629  *      RETURNS:
 630  *      Zero on success, non-zero on error.
 631  */
 632
 633 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
 634 {
 635         struct ata_taskfile *tf = &qc->tf;
 636         struct ata_device *dev = qc->dev;
 637         unsigned int lba   = tf->flags & ATA_TFLAG_LBA;
 638         unsigned int lba48 = tf->flags & ATA_TFLAG_LBA48;
 639         u64 block = 0;
 640         u32 n_block = 0;
 641
 642         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
 643         tf->protocol = qc->dev->xfer_protocol;
 644
 645         if (scsicmd[0] == READ_10 || scsicmd[0] == READ_6 ||
 646             scsicmd[0] == READ_16) {
 647                 tf->command = qc->dev->read_cmd;
 648         } else {
 649                 tf->command = qc->dev->write_cmd;
 650                 tf->flags |= ATA_TFLAG_WRITE;
 651         }
 652
 653         /* Calculate the SCSI LBA and transfer length. */
 654         if (scsicmd[0] == READ_10 || scsicmd[0] == WRITE_10) {
 655                 block |= ((u64)scsicmd[2]) << 24;
 656                 block |= ((u64)scsicmd[3]) << 16;
 657                 block |= ((u64)scsicmd[4]) << 8;
 658                 block |= ((u64)scsicmd[5]);
 659
 660                 n_block |= ((u32)scsicmd[7]) << 8;
 661                 n_block |= ((u32)scsicmd[8]);
 662
 663                 VPRINTK("ten-byte command\n");
 664         } else if (scsicmd[0] == READ_6 || scsicmd[0] == WRITE_6) {
 665                 block |= ((u64)scsicmd[2]) << 8;
 666                 block |= ((u64)scsicmd[3]);
 667
 668                 n_block |= ((u32)scsicmd[4]);
 669
 670                 /* for 6-byte r/w commands, transfer length 0
 671                  * means 256 blocks of data, not 0 block.
 672                  */
 673                 if (!n_block)
 674                         n_block = 256;
 675
 676                 VPRINTK("six-byte command\n");
 677         } else if (scsicmd[0] == READ_16 || scsicmd[0] == WRITE_16) {
 678                 block |= ((u64)scsicmd[2]) << 56;
 679                 block |= ((u64)scsicmd[3]) << 48;
 680                 block |= ((u64)scsicmd[4]) << 40;
 681                 block |= ((u64)scsicmd[5]) << 32;
 682                 block |= ((u64)scsicmd[6]) << 24;
 683                 block |= ((u64)scsicmd[7]) << 16;
 684                 block |= ((u64)scsicmd[8]) << 8;
 685                 block |= ((u64)scsicmd[9]);
 686
 687                 n_block |= ((u32)scsicmd[10]) << 24;
 688                 n_block |= ((u32)scsicmd[11]) << 16;
 689                 n_block |= ((u32)scsicmd[12]) << 8;
 690                 n_block |= ((u32)scsicmd[13]);
 691
 692                 VPRINTK("sixteen-byte command\n");
 693         } else {
 694                 DPRINTK("no-byte command\n");
 695                 return 1;
 696         }
 697
 698         /* Check and compose ATA command */
 699         if (!n_block)
 700                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
 701                  * length 0 means transfer 0 block of data.
 702                  * However, for ATA R/W commands, sector count 0 means
 703                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
 704                  */
 705                 return 1;
 706
 707         if (lba) {
 708                 if (lba48) {
 709                         /* The request -may- be too large for LBA48. */
 710                         if ((block >> 48) || (n_block > 65536))
 711                                 return 1;
 712
 713                         tf->hob_nsect = (n_block >> 8) & 0xff;
 714
 715                         tf->hob_lbah = (block >> 40) & 0xff;
 716                         tf->hob_lbam = (block >> 32) & 0xff;
 717                         tf->hob_lbal = (block >> 24) & 0xff;
 718                 } else {
 719                         /* LBA28 */
 720
 721                         /* The request -may- be too large for LBA28. */
 722                         if ((block >> 28) || (n_block > 256))
 723                                 return 1;
 724
 725                         tf->device |= (block >> 24) & 0xf;
 726                 }
 727
 728                 qc->nsect = n_block;
 729                 tf->nsect = n_block & 0xff;
 730
 731                 tf->lbah = (block >> 16) & 0xff;
 732                 tf->lbam = (block >> 8) & 0xff;
 733                 tf->lbal = block & 0xff;
 734
 735                 tf->device |= ATA_LBA;
 736         } else {
 737                 /* CHS */
 738                 u32 sect, head, cyl, track;
 739
 740                 /* The request -may- be too large for CHS addressing. */
 741                 if ((block >> 28) || (n_block > 256))
 742                         return 1;
 743
 744                 /* Convert LBA to CHS */
 745                 track = (u32)block / dev->sectors;
 746                 cyl   = track / dev->heads;
 747                 head  = track % dev->heads;
 748                 sect  = (u32)block % dev->sectors + 1;
 749
 750                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
 751                         (u32)block, track, cyl, head, sect);
 752
 753                 /* Check whether the converted CHS can fit.
 754                    Cylinder: 0-65535
 755                    Head: 0-15
 756                    Sector: 1-255*/
 757                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
 758                         return 1;
 759
 760                 qc->nsect = n_block;
 761                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
 762                 tf->lbal = sect;
 763                 tf->lbam = cyl;
 764                 tf->lbah = cyl >> 8;
 765                 tf->device |= head;
 766         }
 767
 768         return 0;
 769 }
 770
 771 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
 772 {
 773         struct scsi_cmnd *cmd = qc->scsicmd;
 774
 775         if (unlikely(drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ)))
 776                 ata_to_sense_error(qc, drv_stat);
 777         else
 778                 cmd->result = SAM_STAT_GOOD;
 779
 780         qc->scsidone(cmd);
 781
 782         return 0;
 783 }
 784
 785 /**
 786  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
 787  *      @ap: ATA port to which the command is addressed
 788  *      @dev: ATA device to which the command is addressed
 789  *      @cmd: SCSI command to execute
 790  *      @done: SCSI command completion function
 791  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
 792  *
 793  *      Our ->queuecommand() function has decided that the SCSI
 794  *      command issued can be directly translated into an ATA
 795  *      command, rather than handled internally.
 796  *
 797  *      This function sets up an ata_queued_cmd structure for the
 798  *      SCSI command, and sends that ata_queued_cmd to the hardware.
 799  *
 800  *      LOCKING:
 801  *      spin_lock_irqsave(host_set lock)
 802  */
 803
 804 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
 805                               struct scsi_cmnd *cmd,
 806                               void (*done)(struct scsi_cmnd *),
 807                               ata_xlat_func_t xlat_func)
 808 {
 809         struct ata_queued_cmd *qc;
 810         u8 *scsicmd = cmd->cmnd;
 811
 812         VPRINTK("ENTER\n");
 813
 814         qc = ata_scsi_qc_new(ap, dev, cmd, done);
 815         if (!qc)
 816                 return;
 817
 818         /* data is present; dma-map it */
 819         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
 820             cmd->sc_data_direction == DMA_TO_DEVICE) {
 821                 if (unlikely(cmd->request_bufflen < 1)) {
 822                         printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
 823                                ap->id, dev->devno);
 824                         goto err_out;
 825                 }
 826
 827                 if (cmd->use_sg)
 828                         ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
 829                 else
 830                         ata_sg_init_one(qc, cmd->request_buffer,
 831                                         cmd->request_bufflen);
 832
 833                 qc->dma_dir = cmd->sc_data_direction;
 834         }
 835
 836         qc->complete_fn = ata_scsi_qc_complete;
 837
 838         if (xlat_func(qc, scsicmd))
 839                 goto err_out;
 840
 841         /* select device, send command to hardware */
 842         if (ata_qc_issue(qc))
 843                 goto err_out;
 844
 845         VPRINTK("EXIT\n");
 846         return;
 847
 848 err_out:
 849         ata_qc_free(qc);
 850         ata_bad_cdb(cmd, done);
 851         DPRINTK("EXIT - badcmd\n");
 852 }
 853
 854 /**
 855  *      ata_scsi_rbuf_get - Map response buffer.
 856  *      @cmd: SCSI command containing buffer to be mapped.
 857  *      @buf_out: Pointer to mapped area.
 858  *
 859  *      Maps buffer contained within SCSI command @cmd.
 860  *
 861  *      LOCKING:
 862  *      spin_lock_irqsave(host_set lock)
 863  *
 864  *      RETURNS:
 865  *      Length of response buffer.
 866  */
 867
 868 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
 869 {
 870         u8 *buf;
 871         unsigned int buflen;
 872
 873         if (cmd->use_sg) {
 874                 struct scatterlist *sg;
 875
 876                 sg = (struct scatterlist *) cmd->request_buffer;
 877                 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
 878                 buflen = sg->length;
 879         } else {
 880                 buf = cmd->request_buffer;
 881                 buflen = cmd->request_bufflen;
 882         }
 883
 884         *buf_out = buf;
 885         return buflen;
 886 }
 887
 888 /**
 889  *      ata_scsi_rbuf_put - Unmap response buffer.
 890  *      @cmd: SCSI command containing buffer to be unmapped.
 891  *      @buf: buffer to unmap
 892  *
 893  *      Unmaps response buffer contained within @cmd.
 894  *
 895  *      LOCKING:
 896  *      spin_lock_irqsave(host_set lock)
 897  */
 898
 899 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
 900 {
 901         if (cmd->use_sg) {
 902                 struct scatterlist *sg;
 903
 904                 sg = (struct scatterlist *) cmd->request_buffer;
 905                 kunmap_atomic(buf - sg->offset, KM_USER0);
 906         }
 907 }
 908
 909 /**
 910  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
 911  *      @args: device IDENTIFY data / SCSI command of interest.
 912  *      @actor: Callback hook for desired SCSI command simulator
 913  *
 914  *      Takes care of the hard work of simulating a SCSI command...
 915  *      Mapping the response buffer, calling the command's handler,
 916  *      and handling the handler's return value.  This return value
 917  *      indicates whether the handler wishes the SCSI command to be
 918  *      completed successfully, or not.
 919  *
 920  *      LOCKING:
 921  *      spin_lock_irqsave(host_set lock)
 922  */
 923
 924 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
 925                         unsigned int (*actor) (struct ata_scsi_args *args,
 926                                            u8 *rbuf, unsigned int buflen))
 927 {
 928         u8 *rbuf;
 929         unsigned int buflen, rc;
 930         struct scsi_cmnd *cmd = args->cmd;
 931
 932         buflen = ata_scsi_rbuf_get(cmd, &rbuf);
 933         memset(rbuf, 0, buflen);
 934         rc = actor(args, rbuf, buflen);
 935         ata_scsi_rbuf_put(cmd, rbuf);
 936
 937         if (rc)
 938                 ata_bad_cdb(cmd, args->done);
 939         else {
 940                 cmd->result = SAM_STAT_GOOD;
 941                 args->done(cmd);
 942         }
 943 }
 944
 945 /**
 946  *      ata_scsiop_inq_std - Simulate INQUIRY command
 947  *      @args: device IDENTIFY data / SCSI command of interest.
 948  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 949  *      @buflen: Response buffer length.
 950  *
 951  *      Returns standard device identification data associated
 952  *      with non-EVPD INQUIRY command output.
 953  *
 954  *      LOCKING:
 955  *      spin_lock_irqsave(host_set lock)
 956  */
 957
 958 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
 959                                unsigned int buflen)
 960 {
 961         u8 hdr[] = {
 962                 TYPE_DISK,
 963                 0,
 964                 0x5,    /* claim SPC-3 version compatibility */
 965                 2,
 966                 95 - 4
 967         };
 968
 969         /* set scsi removeable (RMB) bit per ata bit */
 970         if (ata_id_removeable(args->id))
 971                 hdr[1] |= (1 << 7);
 972
 973         VPRINTK("ENTER\n");
 974
 975         memcpy(rbuf, hdr, sizeof(hdr));
 976
 977         if (buflen > 35) {
 978                 memcpy(&rbuf[8], "ATA     ", 8);
 979                 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
 980                 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
 981                 if (rbuf[32] == 0 || rbuf[32] == ' ')
 982                         memcpy(&rbuf[32], "n/a ", 4);
 983         }
 984
 985         if (buflen > 63) {
 986                 const u8 versions[] = {
 987                         0x60,   /* SAM-3 (no version claimed) */
 988
 989                         0x03,
 990                         0x20,   /* SBC-2 (no version claimed) */
 991
 992                         0x02,
 993                         0x60    /* SPC-3 (no version claimed) */
 994                 };
 995
 996                 memcpy(rbuf + 59, versions, sizeof(versions));
 997         }
 998
 999         return 0;
1000 }
1001
1002 /**
1003  *      ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1004  *      @args: device IDENTIFY data / SCSI command of interest.
1005  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1006  *      @buflen: Response buffer length.
1007  *
1008  *      Returns list of inquiry EVPD pages available.
1009  *
1010  *      LOCKING:
1011  *      spin_lock_irqsave(host_set lock)
1012  */
1013
1014 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1015                               unsigned int buflen)
1016 {
1017         const u8 pages[] = {
1018                 0x00,   /* page 0x00, this page */
1019                 0x80,   /* page 0x80, unit serial no page */
1020                 0x83    /* page 0x83, device ident page */
1021         };
1022         rbuf[3] = sizeof(pages);        /* number of supported EVPD pages */
1023
1024         if (buflen > 6)
1025                 memcpy(rbuf + 4, pages, sizeof(pages));
1026
1027         return 0;
1028 }
1029
1030 /**
1031  *      ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1032  *      @args: device IDENTIFY data / SCSI command of interest.
1033  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1034  *      @buflen: Response buffer length.
1035  *
1036  *      Returns ATA device serial number.
1037  *
1038  *      LOCKING:
1039  *      spin_lock_irqsave(host_set lock)
1040  */
1041
1042 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1043                               unsigned int buflen)
1044 {
1045         const u8 hdr[] = {
1046                 0,
1047                 0x80,                   /* this page code */
1048                 0,
1049                 ATA_SERNO_LEN,          /* page len */
1050         };
1051         memcpy(rbuf, hdr, sizeof(hdr));
1052
1053         if (buflen > (ATA_SERNO_LEN + 4 - 1))
1054                 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1055                                   ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1056
1057         return 0;
1058 }
1059
1060 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1061
1062 /**
1063  *      ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1064  *      @args: device IDENTIFY data / SCSI command of interest.
1065  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1066  *      @buflen: Response buffer length.
1067  *
1068  *      Returns device identification.  Currently hardcoded to
1069  *      return "Linux ATA-SCSI simulator".
1070  *
1071  *      LOCKING:
1072  *      spin_lock_irqsave(host_set lock)
1073  */
1074
1075 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1076                               unsigned int buflen)
1077 {
1078         rbuf[1] = 0x83;                 /* this page code */
1079         rbuf[3] = 4 + strlen(inq_83_str);       /* page len */
1080
1081         /* our one and only identification descriptor (vendor-specific) */
1082         if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1083                 rbuf[4 + 0] = 2;        /* code set: ASCII */
1084                 rbuf[4 + 3] = strlen(inq_83_str);
1085                 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1086         }
1087
1088         return 0;
1089 }
1090
1091 /**
1092  *      ata_scsiop_noop - Command handler that simply returns success.
1093  *      @args: device IDENTIFY data / SCSI command of interest.
1094  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1095  *      @buflen: Response buffer length.
1096  *
1097  *      No operation.  Simply returns success to caller, to indicate
1098  *      that the caller should successfully complete this SCSI command.
1099  *
1100  *      LOCKING:
1101  *      spin_lock_irqsave(host_set lock)
1102  */
1103
1104 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1105                             unsigned int buflen)
1106 {
1107         VPRINTK("ENTER\n");
1108         return 0;
1109 }
1110
1111 /**
1112  *      ata_msense_push - Push data onto MODE SENSE data output buffer
1113  *      @ptr_io: (input/output) Location to store more output data
1114  *      @last: End of output data buffer
1115  *      @buf: Pointer to BLOB being added to output buffer
1116  *      @buflen: Length of BLOB
1117  *
1118  *      Store MODE SENSE data on an output buffer.
1119  *
1120  *      LOCKING:
1121  *      None.
1122  */
1123
1124 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1125                             const u8 *buf, unsigned int buflen)
1126 {
1127         u8 *ptr = *ptr_io;
1128
1129         if ((ptr + buflen - 1) > last)
1130                 return;
1131
1132         memcpy(ptr, buf, buflen);
1133
1134         ptr += buflen;
1135
1136         *ptr_io = ptr;
1137 }
1138
1139 /**
1140  *      ata_msense_caching - Simulate MODE SENSE caching info page
1141  *      @id: device IDENTIFY data
1142  *      @ptr_io: (input/output) Location to store more output data
1143  *      @last: End of output data buffer
1144  *
1145  *      Generate a caching info page, which conditionally indicates
1146  *      write caching to the SCSI layer, depending on device
1147  *      capabilities.
1148  *
1149  *      LOCKING:
1150  *      None.
1151  */
1152
1153 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1154                                        const u8 *last)
1155 {
1156         u8 page[] = {
1157                 0x8,                            /* page code */
1158                 0x12,                           /* page length */
1159                 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,   /* 10 zeroes */
1160                 0, 0, 0, 0, 0, 0, 0, 0          /* 8 zeroes */
1161         };
1162
1163         if (ata_id_wcache_enabled(id))
1164                 page[2] |= (1 << 2);    /* write cache enable */
1165         if (!ata_id_rahead_enabled(id))
1166                 page[12] |= (1 << 5);   /* disable read ahead */
1167
1168         ata_msense_push(ptr_io, last, page, sizeof(page));
1169         return sizeof(page);
1170 }
1171
1172 /**
1173  *      ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1174  *      @dev: Device associated with this MODE SENSE command
1175  *      @ptr_io: (input/output) Location to store more output data
1176  *      @last: End of output data buffer
1177  *
1178  *      Generate a generic MODE SENSE control mode page.
1179  *
1180  *      LOCKING:
1181  *      None.
1182  */
1183
1184 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1185 {
1186         const u8 page[] = {0xa, 0xa, 6, 0, 0, 0, 0, 0, 0xff, 0xff, 0, 30};
1187
1188         /* byte 2: set the descriptor format sense data bit (bit 2)
1189          * since we need to support returning this format for SAT
1190          * commands and any SCSI commands against a 48b LBA device.
1191          */
1192
1193         ata_msense_push(ptr_io, last, page, sizeof(page));
1194         return sizeof(page);
1195 }
1196
1197 /**
1198  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1199  *      @dev: Device associated with this MODE SENSE command
1200  *      @ptr_io: (input/output) Location to store more output data
1201  *      @last: End of output data buffer
1202  *
1203  *      Generate a generic MODE SENSE r/w error recovery page.
1204  *
1205  *      LOCKING:
1206  *      None.
1207  */
1208
1209 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1210 {
1211         const u8 page[] = {
1212                 0x1,                      /* page code */
1213                 0xa,                      /* page length */
1214                 (1 << 7) | (1 << 6),      /* note auto r/w reallocation */
1215                 0, 0, 0, 0, 0, 0, 0, 0, 0 /* 9 zeroes */
1216         };
1217
1218         ata_msense_push(ptr_io, last, page, sizeof(page));
1219         return sizeof(page);
1220 }
1221
1222 /**
1223  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1224  *      @args: device IDENTIFY data / SCSI command of interest.
1225  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1226  *      @buflen: Response buffer length.
1227  *
1228  *      Simulate MODE SENSE commands.
1229  *
1230  *      LOCKING:
1231  *      spin_lock_irqsave(host_set lock)
1232  */
1233
1234 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1235                                   unsigned int buflen)
1236 {
1237         u8 *scsicmd = args->cmd->cmnd, *p, *last;
1238         unsigned int page_control, six_byte, output_len;
1239
1240         VPRINTK("ENTER\n");
1241
1242         six_byte = (scsicmd[0] == MODE_SENSE);
1243
1244         /* we only support saved and current values (which we treat
1245          * in the same manner)
1246          */
1247         page_control = scsicmd[2] >> 6;
1248         if ((page_control != 0) && (page_control != 3))
1249                 return 1;
1250
1251         if (six_byte)
1252                 output_len = 4;
1253         else
1254                 output_len = 8;
1255
1256         p = rbuf + output_len;
1257         last = rbuf + buflen - 1;
1258
1259         switch(scsicmd[2] & 0x3f) {
1260         case 0x01:              /* r/w error recovery */
1261                 output_len += ata_msense_rw_recovery(&p, last);
1262                 break;
1263
1264         case 0x08:              /* caching */
1265                 output_len += ata_msense_caching(args->id, &p, last);
1266                 break;
1267
1268         case 0x0a: {            /* control mode */
1269                 output_len += ata_msense_ctl_mode(&p, last);
1270                 break;
1271                 }
1272
1273         case 0x3f:              /* all pages */
1274                 output_len += ata_msense_rw_recovery(&p, last);
1275                 output_len += ata_msense_caching(args->id, &p, last);
1276                 output_len += ata_msense_ctl_mode(&p, last);
1277                 break;
1278
1279         default:                /* invalid page code */
1280                 return 1;
1281         }
1282
1283         if (six_byte) {
1284                 output_len--;
1285                 rbuf[0] = output_len;
1286         } else {
1287                 output_len -= 2;
1288                 rbuf[0] = output_len >> 8;
1289                 rbuf[1] = output_len;
1290         }
1291
1292         return 0;
1293 }
1294
1295 /**
1296  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1297  *      @args: device IDENTIFY data / SCSI command of interest.
1298  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1299  *      @buflen: Response buffer length.
1300  *
1301  *      Simulate READ CAPACITY commands.
1302  *
1303  *      LOCKING:
1304  *      spin_lock_irqsave(host_set lock)
1305  */
1306
1307 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1308                                 unsigned int buflen)
1309 {
1310         u64 n_sectors;
1311         u32 tmp;
1312
1313         VPRINTK("ENTER\n");
1314
1315         if (ata_id_has_lba(args->id)) {
1316                 if (ata_id_has_lba48(args->id))
1317                         n_sectors = ata_id_u64(args->id, 100);
1318                 else
1319                         n_sectors = ata_id_u32(args->id, 60);
1320         } else {
1321                 /* CHS default translation */
1322                 n_sectors = args->id[1] * args->id[3] * args->id[6];
1323
1324                 if (ata_id_current_chs_valid(args->id))
1325                         /* CHS current translation */
1326                         n_sectors = ata_id_u32(args->id, 57);
1327         }
1328
1329         n_sectors--;            /* ATA TotalUserSectors - 1 */
1330
1331         if (args->cmd->cmnd[0] == READ_CAPACITY) {
1332                 if( n_sectors >= 0xffffffffULL )
1333                         tmp = 0xffffffff ;  /* Return max count on overflow */
1334                 else
1335                         tmp = n_sectors ;
1336
1337                 /* sector count, 32-bit */
1338                 rbuf[0] = tmp >> (8 * 3);
1339                 rbuf[1] = tmp >> (8 * 2);
1340                 rbuf[2] = tmp >> (8 * 1);
1341                 rbuf[3] = tmp;
1342
1343                 /* sector size */
1344                 tmp = ATA_SECT_SIZE;
1345                 rbuf[6] = tmp >> 8;
1346                 rbuf[7] = tmp;
1347
1348         } else {
1349                 /* sector count, 64-bit */
1350                 tmp = n_sectors >> (8 * 4);
1351                 rbuf[2] = tmp >> (8 * 3);
1352                 rbuf[3] = tmp >> (8 * 2);
1353                 rbuf[4] = tmp >> (8 * 1);
1354                 rbuf[5] = tmp;
1355                 tmp = n_sectors;
1356                 rbuf[6] = tmp >> (8 * 3);
1357                 rbuf[7] = tmp >> (8 * 2);
1358                 rbuf[8] = tmp >> (8 * 1);
1359                 rbuf[9] = tmp;
1360
1361                 /* sector size */
1362                 tmp = ATA_SECT_SIZE;
1363                 rbuf[12] = tmp >> 8;
1364                 rbuf[13] = tmp;
1365         }
1366
1367         return 0;
1368 }
1369
1370 /**
1371  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
1372  *      @args: device IDENTIFY data / SCSI command of interest.
1373  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1374  *      @buflen: Response buffer length.
1375  *
1376  *      Simulate REPORT LUNS command.
1377  *
1378  *      LOCKING:
1379  *      spin_lock_irqsave(host_set lock)
1380  */
1381
1382 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1383                                    unsigned int buflen)
1384 {
1385         VPRINTK("ENTER\n");
1386         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
1387
1388         return 0;
1389 }
1390
1391 /**
1392  *      ata_scsi_badcmd - End a SCSI request with an error
1393  *      @cmd: SCSI request to be handled
1394  *      @done: SCSI command completion function
1395  *      @asc: SCSI-defined additional sense code
1396  *      @ascq: SCSI-defined additional sense code qualifier
1397  *
1398  *      Helper function that completes a SCSI command with
1399  *      %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1400  *      and the specified additional sense codes.
1401  *
1402  *      LOCKING:
1403  *      spin_lock_irqsave(host_set lock)
1404  */
1405
1406 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1407 {
1408         DPRINTK("ENTER\n");
1409         cmd->result = SAM_STAT_CHECK_CONDITION;
1410
1411         cmd->sense_buffer[0] = 0x70;
1412         cmd->sense_buffer[2] = ILLEGAL_REQUEST;
1413         cmd->sense_buffer[7] = 14 - 8;  /* addnl. sense len. FIXME: correct? */
1414         cmd->sense_buffer[12] = asc;
1415         cmd->sense_buffer[13] = ascq;
1416
1417         done(cmd);
1418 }
1419
1420 static int atapi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1421 {
1422         struct scsi_cmnd *cmd = qc->scsicmd;
1423
1424         if (unlikely(drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ))) {
1425                 DPRINTK("request check condition\n");
1426
1427                 cmd->result = SAM_STAT_CHECK_CONDITION;
1428
1429                 qc->scsidone(cmd);
1430
1431                 return 1;
1432         } else {
1433                 u8 *scsicmd = cmd->cmnd;
1434
1435                 if (scsicmd[0] == INQUIRY) {
1436                         u8 *buf = NULL;
1437                         unsigned int buflen;
1438
1439                         buflen = ata_scsi_rbuf_get(cmd, &buf);
1440                         buf[2] = 0x5;
1441                         buf[3] = (buf[3] & 0xf0) | 2;
1442                         ata_scsi_rbuf_put(cmd, buf);
1443                 }
1444                 cmd->result = SAM_STAT_GOOD;
1445         }
1446
1447         qc->scsidone(cmd);
1448
1449         return 0;
1450 }
1451 /**
1452  *      atapi_xlat - Initialize PACKET taskfile
1453  *      @qc: command structure to be initialized
1454  *      @scsicmd: SCSI CDB associated with this PACKET command
1455  *
1456  *      LOCKING:
1457  *      spin_lock_irqsave(host_set lock)
1458  *
1459  *      RETURNS:
1460  *      Zero on success, non-zero on failure.
1461  */
1462
1463 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
1464 {
1465         struct scsi_cmnd *cmd = qc->scsicmd;
1466         struct ata_device *dev = qc->dev;
1467         int using_pio = (dev->flags & ATA_DFLAG_PIO);
1468         int nodata = (cmd->sc_data_direction == DMA_NONE);
1469
1470         if (!using_pio)
1471                 /* Check whether ATAPI DMA is safe */
1472                 if (ata_check_atapi_dma(qc))
1473                         using_pio = 1;
1474
1475         memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
1476
1477         qc->complete_fn = atapi_qc_complete;
1478
1479         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1480         if (cmd->sc_data_direction == DMA_TO_DEVICE) {
1481                 qc->tf.flags |= ATA_TFLAG_WRITE;
1482                 DPRINTK("direction: write\n");
1483         }
1484
1485         qc->tf.command = ATA_CMD_PACKET;
1486
1487         /* no data, or PIO data xfer */
1488         if (using_pio || nodata) {
1489                 if (nodata)
1490                         qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
1491                 else
1492                         qc->tf.protocol = ATA_PROT_ATAPI;
1493                 qc->tf.lbam = (8 * 1024) & 0xff;
1494                 qc->tf.lbah = (8 * 1024) >> 8;
1495         }
1496
1497         /* DMA data xfer */
1498         else {
1499                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
1500                 qc->tf.feature |= ATAPI_PKT_DMA;
1501
1502 #ifdef ATAPI_ENABLE_DMADIR
1503                 /* some SATA bridges need us to indicate data xfer direction */
1504                 if (cmd->sc_data_direction != DMA_TO_DEVICE)
1505                         qc->tf.feature |= ATAPI_DMADIR;
1506 #endif
1507         }
1508
1509         qc->nbytes = cmd->bufflen;
1510
1511         return 0;
1512 }
1513
1514 /**
1515  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
1516  *      @ap: ATA port to which the device is attached
1517  *      @scsidev: SCSI device from which we derive the ATA device
1518  *
1519  *      Given various information provided in struct scsi_cmnd,
1520  *      map that onto an ATA bus, and using that mapping
1521  *      determine which ata_device is associated with the
1522  *      SCSI command to be sent.
1523  *
1524  *      LOCKING:
1525  *      spin_lock_irqsave(host_set lock)
1526  *
1527  *      RETURNS:
1528  *      Associated ATA device, or %NULL if not found.
1529  */
1530
1531 static struct ata_device *
1532 ata_scsi_find_dev(struct ata_port *ap, struct scsi_device *scsidev)
1533 {
1534         struct ata_device *dev;
1535
1536         /* skip commands not addressed to targets we simulate */
1537         if (likely(scsidev->id < ATA_MAX_DEVICES))
1538                 dev = &ap->device[scsidev->id];
1539         else
1540                 return NULL;
1541
1542         if (unlikely((scsidev->channel != 0) ||
1543                      (scsidev->lun != 0)))
1544                 return NULL;
1545
1546         if (unlikely(!ata_dev_present(dev)))
1547                 return NULL;
1548
1549         if (!atapi_enabled) {
1550                 if (unlikely(dev->class == ATA_DEV_ATAPI))
1551                         return NULL;
1552         }
1553
1554         return dev;
1555 }
1556
1557 /**
1558  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
1559  *      @dev: ATA device
1560  *      @cmd: SCSI command opcode to consider
1561  *
1562  *      Look up the SCSI command given, and determine whether the
1563  *      SCSI command is to be translated or simulated.
1564  *
1565  *      RETURNS:
1566  *      Pointer to translation function if possible, %NULL if not.
1567  */
1568
1569 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
1570 {
1571         switch (cmd) {
1572         case READ_6:
1573         case READ_10:
1574         case READ_16:
1575
1576         case WRITE_6:
1577         case WRITE_10:
1578         case WRITE_16:
1579                 return ata_scsi_rw_xlat;
1580
1581         case SYNCHRONIZE_CACHE:
1582                 if (ata_try_flush_cache(dev))
1583                         return ata_scsi_flush_xlat;
1584                 break;
1585
1586         case VERIFY:
1587         case VERIFY_16:
1588                 return ata_scsi_verify_xlat;
1589         case START_STOP:
1590                 return ata_scsi_start_stop_xlat;
1591         }
1592
1593         return NULL;
1594 }
1595
1596 /**
1597  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
1598  *      @ap: ATA port to which the command was being sent
1599  *      @cmd: SCSI command to dump
1600  *
1601  *      Prints the contents of a SCSI command via printk().
1602  */
1603
1604 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
1605                                      struct scsi_cmnd *cmd)
1606 {
1607 #ifdef ATA_DEBUG
1608         struct scsi_device *scsidev = cmd->device;
1609         u8 *scsicmd = cmd->cmnd;
1610
1611         DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
1612                 ap->id,
1613                 scsidev->channel, scsidev->id, scsidev->lun,
1614                 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
1615                 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
1616                 scsicmd[8]);
1617 #endif
1618 }
1619
1620 /**
1621  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
1622  *      @cmd: SCSI command to be sent
1623  *      @done: Completion function, called when command is complete
1624  *
1625  *      In some cases, this function translates SCSI commands into
1626  *      ATA taskfiles, and queues the taskfiles to be sent to
1627  *      hardware.  In other cases, this function simulates a
1628  *      SCSI device by evaluating and responding to certain
1629  *      SCSI commands.  This creates the overall effect of
1630  *      ATA and ATAPI devices appearing as SCSI devices.
1631  *
1632  *      LOCKING:
1633  *      Releases scsi-layer-held lock, and obtains host_set lock.
1634  *
1635  *      RETURNS:
1636  *      Zero.
1637  */
1638
1639 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
1640 {
1641         struct ata_port *ap;
1642         struct ata_device *dev;
1643         struct scsi_device *scsidev = cmd->device;
1644
1645         ap = (struct ata_port *) &scsidev->host->hostdata[0];
1646
1647         ata_scsi_dump_cdb(ap, cmd);
1648
1649         dev = ata_scsi_find_dev(ap, scsidev);
1650         if (unlikely(!dev)) {
1651                 cmd->result = (DID_BAD_TARGET << 16);
1652                 done(cmd);
1653                 goto out_unlock;
1654         }
1655
1656         if (dev->class == ATA_DEV_ATA) {
1657                 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
1658                                                               cmd->cmnd[0]);
1659
1660                 if (xlat_func)
1661                         ata_scsi_translate(ap, dev, cmd, done, xlat_func);
1662                 else
1663                         ata_scsi_simulate(dev->id, cmd, done);
1664         } else
1665                 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
1666
1667 out_unlock:
1668         return 0;
1669 }
1670
1671 /**
1672  *      ata_scsi_simulate - simulate SCSI command on ATA device
1673  *      @id: current IDENTIFY data for target device.
1674  *      @cmd: SCSI command being sent to device.
1675  *      @done: SCSI command completion function.
1676  *
1677  *      Interprets and directly executes a select list of SCSI commands
1678  *      that can be handled internally.
1679  *
1680  *      LOCKING:
1681  *      spin_lock_irqsave(host_set lock)
1682  */
1683
1684 void ata_scsi_simulate(u16 *id,
1685                       struct scsi_cmnd *cmd,
1686                       void (*done)(struct scsi_cmnd *))
1687 {
1688         struct ata_scsi_args args;
1689         u8 *scsicmd = cmd->cmnd;
1690
1691         args.id = id;
1692         args.cmd = cmd;
1693         args.done = done;
1694
1695         switch(scsicmd[0]) {
1696                 /* no-op's, complete with success */
1697                 case SYNCHRONIZE_CACHE:
1698                 case REZERO_UNIT:
1699                 case SEEK_6:
1700                 case SEEK_10:
1701                 case TEST_UNIT_READY:
1702                 case FORMAT_UNIT:               /* FIXME: correct? */
1703                 case SEND_DIAGNOSTIC:           /* FIXME: correct? */
1704                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
1705                         break;
1706
1707                 case INQUIRY:
1708                         if (scsicmd[1] & 2)                /* is CmdDt set?  */
1709                                 ata_bad_cdb(cmd, done);
1710                         else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
1711                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
1712                         else if (scsicmd[2] == 0x00)
1713                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
1714                         else if (scsicmd[2] == 0x80)
1715                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
1716                         else if (scsicmd[2] == 0x83)
1717                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
1718                         else
1719                                 ata_bad_cdb(cmd, done);
1720                         break;
1721
1722                 case MODE_SENSE:
1723                 case MODE_SENSE_10:
1724                         ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
1725                         break;
1726
1727                 case MODE_SELECT:       /* unconditionally return */
1728                 case MODE_SELECT_10:    /* bad-field-in-cdb */
1729                         ata_bad_cdb(cmd, done);
1730                         break;
1731
1732                 case READ_CAPACITY:
1733                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1734                         break;
1735
1736                 case SERVICE_ACTION_IN:
1737                         if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
1738                                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1739                         else
1740                                 ata_bad_cdb(cmd, done);
1741                         break;
1742
1743                 case REPORT_LUNS:
1744                         ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
1745                         break;
1746
1747                 /* mandantory commands we haven't implemented yet */
1748                 case REQUEST_SENSE:
1749
1750                 /* all other commands */
1751                 default:
1752                         ata_bad_scsiop(cmd, done);
1753                         break;
1754         }
1755 }
1756