2 libata-scsi.c - helper library for ATA
4 Copyright 2003-2004 Red Hat, Inc. All rights reserved.
5 Copyright 2003-2004 Jeff Garzik
7 The contents of this file are subject to the Open
8 Software License version 1.1 that can be found at
9 http://www.opensource.org/licenses/osl-1.1.txt and is included herein
12 Alternatively, the contents of this file may be used under the terms
13 of the GNU General Public License version 2 (the "GPL") as distributed
14 in the kernel source COPYING file, in which case the provisions of
15 the GPL are applicable instead of the above. If you wish to allow
16 the use of your version of this file only under the terms of the
17 GPL and not to allow others to use your version of this file under
18 the OSL, indicate your decision by deleting the provisions above and
19 replace them with the notice and other provisions required by the GPL.
20 If you do not delete the provisions above, a recipient may use your
21 version of this file under either the OSL or the GPL.
25 #include <linux/kernel.h>
26 #include <linux/blkdev.h>
27 #include <linux/spinlock.h>
28 #include <scsi/scsi.h>
30 #include <scsi/scsi_host.h>
31 #include <linux/libata.h>
32 #include <asm/uaccess.h>
36 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, u8 *scsicmd);
37 static struct ata_device *
38 ata_scsi_find_dev(struct ata_port *ap, struct scsi_device *scsidev);
42 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
43 * @sdev: SCSI device for which BIOS geometry is to be determined
44 * @bdev: block device associated with @sdev
45 * @capacity: capacity of SCSI device
46 * @geom: location to which geometry will be output
48 * Generic bios head/sector/cylinder calculator
49 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
50 * mapping. Some situations may arise where the disk is not
51 * bootable if this is not used.
54 * Defined by the SCSI layer. We don't really care.
59 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
60 sector_t capacity, int geom[])
64 sector_div(capacity, 255*63);
70 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
73 struct ata_device *dev;
74 int val = -EINVAL, rc = -EINVAL;
76 ap = (struct ata_port *) &scsidev->host->hostdata[0];
80 dev = ata_scsi_find_dev(ap, scsidev);
87 case ATA_IOC_GET_IO32:
89 if (copy_to_user(arg, &val, 1))
93 case ATA_IOC_SET_IO32:
94 val = (unsigned long) arg;
109 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
110 * @ap: ATA port to which the new command is attached
111 * @dev: ATA device to which the new command is attached
112 * @cmd: SCSI command that originated this ATA command
113 * @done: SCSI command completion function
115 * Obtain a reference to an unused ata_queued_cmd structure,
116 * which is the basic libata structure representing a single
117 * ATA command sent to the hardware.
119 * If a command was available, fill in the SCSI-specific
120 * portions of the structure with information on the
124 * spin_lock_irqsave(host_set lock)
127 * Command allocated, or %NULL if none available.
129 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
130 struct ata_device *dev,
131 struct scsi_cmnd *cmd,
132 void (*done)(struct scsi_cmnd *))
134 struct ata_queued_cmd *qc;
136 qc = ata_qc_new_init(ap, dev);
142 qc->sg = (struct scatterlist *) cmd->request_buffer;
143 qc->n_elem = cmd->use_sg;
149 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
157 * ata_to_sense_error - convert ATA error to SCSI error
158 * @qc: Command that we are erroring out
159 * @drv_stat: value contained in ATA status register
161 * Converts an ATA error into a SCSI error. While we are at it
162 * we decode and dump the ATA error for the user so that they
163 * have some idea what really happened at the non make-believe
167 * spin_lock_irqsave(host_set lock)
170 void ata_to_sense_error(struct ata_queued_cmd *qc, u8 drv_stat)
172 struct scsi_cmnd *cmd = qc->scsicmd;
174 unsigned char *sb = cmd->sense_buffer;
175 /* Based on the 3ware driver translation table */
176 static unsigned char sense_table[][4] = {
178 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
180 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
182 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
183 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
184 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
185 /* MC|ID|ABRT|TRK0|MARK */
186 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
188 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
189 /* Bad address mark */
190 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
192 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
194 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
195 /* Media change request */
196 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
198 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
200 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
202 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
203 /* BBD - block marked bad */
204 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
205 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
207 static unsigned char stat_table[][4] = {
208 /* Must be first because BUSY means no other bits valid */
209 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
210 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
211 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
212 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
213 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
217 cmd->result = SAM_STAT_CHECK_CONDITION;
220 * Is this an error we can process/parse
223 if(drv_stat & ATA_ERR)
224 /* Read the err bits */
225 err = ata_chk_err(qc->ap);
227 /* Display the ATA level error info */
229 printk(KERN_WARNING "ata%u: status=0x%02x { ", qc->ap->id, drv_stat);
233 err = 0; /* Data is not valid in this case */
236 if(drv_stat & 0x40) printk("DriveReady ");
237 if(drv_stat & 0x20) printk("DeviceFault ");
238 if(drv_stat & 0x10) printk("SeekComplete ");
239 if(drv_stat & 0x08) printk("DataRequest ");
240 if(drv_stat & 0x04) printk("CorrectedError ");
241 if(drv_stat & 0x02) printk("Index ");
242 if(drv_stat & 0x01) printk("Error ");
248 printk(KERN_WARNING "ata%u: error=0x%02x { ", qc->ap->id, err);
249 if(err & 0x04) printk("DriveStatusError ");
257 if(err & 0x40) printk("UncorrectableError ");
258 if(err & 0x10) printk("SectorIdNotFound ");
259 if(err & 0x02) printk("TrackZeroNotFound ");
260 if(err & 0x01) printk("AddrMarkNotFound ");
263 /* Should we dump sector info here too ?? */
268 while(sense_table[i][0] != 0xFF)
270 /* Look for best matches first */
271 if((sense_table[i][0] & err) == sense_table[i][0])
274 sb[2] = sense_table[i][1];
276 sb[12] = sense_table[i][2];
277 sb[13] = sense_table[i][3];
282 /* No immediate match */
284 printk(KERN_DEBUG "ata%u: no sense translation for 0x%02x\n", qc->ap->id, err);
287 /* Fall back to interpreting status bits */
288 while(stat_table[i][0] != 0xFF)
290 if(stat_table[i][0] & drv_stat)
293 sb[2] = stat_table[i][1];
295 sb[12] = stat_table[i][2];
296 sb[13] = stat_table[i][3];
302 printk(KERN_ERR "ata%u: called with no error (%02X)!\n", qc->ap->id, drv_stat);
303 /* additional-sense-code[-qualifier] */
306 sb[2] = MEDIUM_ERROR;
308 if (cmd->sc_data_direction == DMA_FROM_DEVICE) {
309 sb[12] = 0x11; /* "unrecovered read error" */
312 sb[12] = 0x0C; /* "write error - */
313 sb[13] = 0x02; /* auto-reallocation failed" */
318 * ata_scsi_slave_config - Set SCSI device attributes
319 * @sdev: SCSI device to examine
321 * This is called before we actually start reading
322 * and writing to the device, to configure certain
323 * SCSI mid-layer behaviors.
326 * Defined by SCSI layer. We don't really care.
329 int ata_scsi_slave_config(struct scsi_device *sdev)
331 sdev->use_10_for_rw = 1;
332 sdev->use_10_for_ms = 1;
334 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
336 if (sdev->id < ATA_MAX_DEVICES) {
338 struct ata_device *dev;
340 ap = (struct ata_port *) &sdev->host->hostdata[0];
341 dev = &ap->device[sdev->id];
343 /* TODO: 1024 is an arbitrary number, not the
344 * hardware maximum. This should be increased to
345 * 65534 when Jens Axboe's patch for dynamically
346 * determining max_sectors is merged.
348 if ((dev->flags & ATA_DFLAG_LBA48) &&
349 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
351 * do not overwrite sdev->host->max_sectors, since
352 * other drives on this host may not support LBA48
354 blk_queue_max_sectors(sdev->request_queue, 2048);
358 return 0; /* scsi layer doesn't check return value, sigh */
362 * ata_scsi_error - SCSI layer error handler callback
363 * @host: SCSI host on which error occurred
365 * Handles SCSI-layer-thrown error events.
368 * Inherited from SCSI layer (none, can sleep)
374 int ata_scsi_error(struct Scsi_Host *host)
380 ap = (struct ata_port *) &host->hostdata[0];
381 ap->ops->eng_timeout(ap);
383 /* TODO: this is per-command; when queueing is supported
384 * this code will either change or move to a more
394 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
395 * @qc: Storage for translated ATA taskfile
396 * @scsicmd: SCSI command to translate (ignored)
398 * Sets up an ATA taskfile to issue FLUSH CACHE or
402 * spin_lock_irqsave(host_set lock)
405 * Zero on success, non-zero on error.
408 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
410 struct ata_taskfile *tf = &qc->tf;
412 tf->flags |= ATA_TFLAG_DEVICE;
413 tf->protocol = ATA_PROT_NODATA;
415 if ((tf->flags & ATA_TFLAG_LBA48) &&
416 (ata_id_has_flush_ext(qc->dev->id)))
417 tf->command = ATA_CMD_FLUSH_EXT;
419 tf->command = ATA_CMD_FLUSH;
425 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
426 * @qc: Storage for translated ATA taskfile
427 * @scsicmd: SCSI command to translate
429 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
432 * spin_lock_irqsave(host_set lock)
435 * Zero on success, non-zero on error.
438 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
440 struct ata_taskfile *tf = &qc->tf;
441 unsigned int lba48 = tf->flags & ATA_TFLAG_LBA48;
442 u64 dev_sectors = qc->dev->n_sectors;
446 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
447 tf->protocol = ATA_PROT_NODATA;
448 tf->device |= ATA_LBA;
450 if (scsicmd[0] == VERIFY) {
451 sect |= ((u64)scsicmd[2]) << 24;
452 sect |= ((u64)scsicmd[3]) << 16;
453 sect |= ((u64)scsicmd[4]) << 8;
454 sect |= ((u64)scsicmd[5]);
456 n_sect |= ((u32)scsicmd[7]) << 8;
457 n_sect |= ((u32)scsicmd[8]);
460 else if (scsicmd[0] == VERIFY_16) {
461 sect |= ((u64)scsicmd[2]) << 56;
462 sect |= ((u64)scsicmd[3]) << 48;
463 sect |= ((u64)scsicmd[4]) << 40;
464 sect |= ((u64)scsicmd[5]) << 32;
465 sect |= ((u64)scsicmd[6]) << 24;
466 sect |= ((u64)scsicmd[7]) << 16;
467 sect |= ((u64)scsicmd[8]) << 8;
468 sect |= ((u64)scsicmd[9]);
470 n_sect |= ((u32)scsicmd[10]) << 24;
471 n_sect |= ((u32)scsicmd[11]) << 16;
472 n_sect |= ((u32)scsicmd[12]) << 8;
473 n_sect |= ((u32)scsicmd[13]);
481 if (sect >= dev_sectors)
483 if ((sect + n_sect) > dev_sectors)
486 if (n_sect > (64 * 1024))
494 tf->command = ATA_CMD_VERIFY_EXT;
496 tf->hob_nsect = (n_sect >> 8) & 0xff;
498 tf->hob_lbah = (sect >> 40) & 0xff;
499 tf->hob_lbam = (sect >> 32) & 0xff;
500 tf->hob_lbal = (sect >> 24) & 0xff;
502 tf->command = ATA_CMD_VERIFY;
504 tf->device |= (sect >> 24) & 0xf;
507 tf->nsect = n_sect & 0xff;
509 tf->lbah = (sect >> 16) & 0xff;
510 tf->lbam = (sect >> 8) & 0xff;
511 tf->lbal = sect & 0xff;
517 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
518 * @qc: Storage for translated ATA taskfile
519 * @scsicmd: SCSI command to translate
521 * Converts any of six SCSI read/write commands into the
522 * ATA counterpart, including starting sector (LBA),
523 * sector count, and taking into account the device's LBA48
526 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
527 * %WRITE_16 are currently supported.
530 * spin_lock_irqsave(host_set lock)
533 * Zero on success, non-zero on error.
536 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
538 struct ata_taskfile *tf = &qc->tf;
539 unsigned int lba48 = tf->flags & ATA_TFLAG_LBA48;
541 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
542 tf->protocol = qc->dev->xfer_protocol;
543 tf->device |= ATA_LBA;
545 if (scsicmd[0] == READ_10 || scsicmd[0] == READ_6 ||
546 scsicmd[0] == READ_16) {
547 tf->command = qc->dev->read_cmd;
549 tf->command = qc->dev->write_cmd;
550 tf->flags |= ATA_TFLAG_WRITE;
553 if (scsicmd[0] == READ_10 || scsicmd[0] == WRITE_10) {
555 tf->hob_nsect = scsicmd[7];
556 tf->hob_lbal = scsicmd[2];
558 qc->nsect = ((unsigned int)scsicmd[7] << 8) |
561 /* if we don't support LBA48 addressing, the request
562 * -may- be too large. */
563 if ((scsicmd[2] & 0xf0) || scsicmd[7])
566 /* stores LBA27:24 in lower 4 bits of device reg */
567 tf->device |= scsicmd[2];
569 qc->nsect = scsicmd[8];
572 tf->nsect = scsicmd[8];
573 tf->lbal = scsicmd[5];
574 tf->lbam = scsicmd[4];
575 tf->lbah = scsicmd[3];
577 VPRINTK("ten-byte command\n");
581 if (scsicmd[0] == READ_6 || scsicmd[0] == WRITE_6) {
582 qc->nsect = tf->nsect = scsicmd[4];
583 tf->lbal = scsicmd[3];
584 tf->lbam = scsicmd[2];
585 tf->lbah = scsicmd[1] & 0x1f; /* mask out reserved bits */
587 VPRINTK("six-byte command\n");
591 if (scsicmd[0] == READ_16 || scsicmd[0] == WRITE_16) {
592 /* rule out impossible LBAs and sector counts */
593 if (scsicmd[2] || scsicmd[3] || scsicmd[10] || scsicmd[11])
597 tf->hob_nsect = scsicmd[12];
598 tf->hob_lbal = scsicmd[6];
599 tf->hob_lbam = scsicmd[5];
600 tf->hob_lbah = scsicmd[4];
602 qc->nsect = ((unsigned int)scsicmd[12] << 8) |
605 /* once again, filter out impossible non-zero values */
606 if (scsicmd[4] || scsicmd[5] || scsicmd[12] ||
610 /* stores LBA27:24 in lower 4 bits of device reg */
611 tf->device |= scsicmd[6];
613 qc->nsect = scsicmd[13];
616 tf->nsect = scsicmd[13];
617 tf->lbal = scsicmd[9];
618 tf->lbam = scsicmd[8];
619 tf->lbah = scsicmd[7];
621 VPRINTK("sixteen-byte command\n");
625 DPRINTK("no-byte command\n");
629 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
631 struct scsi_cmnd *cmd = qc->scsicmd;
633 if (unlikely(drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ)))
634 ata_to_sense_error(qc, drv_stat);
636 cmd->result = SAM_STAT_GOOD;
644 * ata_scsi_translate - Translate then issue SCSI command to ATA device
645 * @ap: ATA port to which the command is addressed
646 * @dev: ATA device to which the command is addressed
647 * @cmd: SCSI command to execute
648 * @done: SCSI command completion function
649 * @xlat_func: Actor which translates @cmd to an ATA taskfile
651 * Our ->queuecommand() function has decided that the SCSI
652 * command issued can be directly translated into an ATA
653 * command, rather than handled internally.
655 * This function sets up an ata_queued_cmd structure for the
656 * SCSI command, and sends that ata_queued_cmd to the hardware.
659 * spin_lock_irqsave(host_set lock)
662 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
663 struct scsi_cmnd *cmd,
664 void (*done)(struct scsi_cmnd *),
665 ata_xlat_func_t xlat_func)
667 struct ata_queued_cmd *qc;
668 u8 *scsicmd = cmd->cmnd;
672 qc = ata_scsi_qc_new(ap, dev, cmd, done);
676 /* data is present; dma-map it */
677 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
678 cmd->sc_data_direction == DMA_TO_DEVICE) {
679 if (unlikely(cmd->request_bufflen < 1)) {
680 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
686 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
688 ata_sg_init_one(qc, cmd->request_buffer,
689 cmd->request_bufflen);
691 qc->dma_dir = cmd->sc_data_direction;
694 qc->complete_fn = ata_scsi_qc_complete;
696 if (xlat_func(qc, scsicmd))
699 /* select device, send command to hardware */
700 if (ata_qc_issue(qc))
708 ata_bad_cdb(cmd, done);
709 DPRINTK("EXIT - badcmd\n");
713 * ata_scsi_rbuf_get - Map response buffer.
714 * @cmd: SCSI command containing buffer to be mapped.
715 * @buf_out: Pointer to mapped area.
717 * Maps buffer contained within SCSI command @cmd.
720 * spin_lock_irqsave(host_set lock)
723 * Length of response buffer.
726 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
732 struct scatterlist *sg;
734 sg = (struct scatterlist *) cmd->request_buffer;
735 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
738 buf = cmd->request_buffer;
739 buflen = cmd->request_bufflen;
747 * ata_scsi_rbuf_put - Unmap response buffer.
748 * @cmd: SCSI command containing buffer to be unmapped.
749 * @buf: buffer to unmap
751 * Unmaps response buffer contained within @cmd.
754 * spin_lock_irqsave(host_set lock)
757 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
760 struct scatterlist *sg;
762 sg = (struct scatterlist *) cmd->request_buffer;
763 kunmap_atomic(buf - sg->offset, KM_USER0);
768 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
769 * @args: device IDENTIFY data / SCSI command of interest.
770 * @actor: Callback hook for desired SCSI command simulator
772 * Takes care of the hard work of simulating a SCSI command...
773 * Mapping the response buffer, calling the command's handler,
774 * and handling the handler's return value. This return value
775 * indicates whether the handler wishes the SCSI command to be
776 * completed successfully, or not.
779 * spin_lock_irqsave(host_set lock)
782 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
783 unsigned int (*actor) (struct ata_scsi_args *args,
784 u8 *rbuf, unsigned int buflen))
787 unsigned int buflen, rc;
788 struct scsi_cmnd *cmd = args->cmd;
790 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
791 memset(rbuf, 0, buflen);
792 rc = actor(args, rbuf, buflen);
793 ata_scsi_rbuf_put(cmd, rbuf);
796 ata_bad_cdb(cmd, args->done);
798 cmd->result = SAM_STAT_GOOD;
804 * ata_scsiop_inq_std - Simulate INQUIRY command
805 * @args: device IDENTIFY data / SCSI command of interest.
806 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
807 * @buflen: Response buffer length.
809 * Returns standard device identification data associated
810 * with non-EVPD INQUIRY command output.
813 * spin_lock_irqsave(host_set lock)
816 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
822 0x5, /* claim SPC-3 version compatibility */
827 /* set scsi removeable (RMB) bit per ata bit */
828 if (ata_id_removeable(args->id))
833 memcpy(rbuf, hdr, sizeof(hdr));
836 memcpy(&rbuf[8], "ATA ", 8);
837 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
838 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
839 if (rbuf[32] == 0 || rbuf[32] == ' ')
840 memcpy(&rbuf[32], "n/a ", 4);
844 const u8 versions[] = {
845 0x60, /* SAM-3 (no version claimed) */
848 0x20, /* SBC-2 (no version claimed) */
851 0x60 /* SPC-3 (no version claimed) */
854 memcpy(rbuf + 59, versions, sizeof(versions));
861 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
862 * @args: device IDENTIFY data / SCSI command of interest.
863 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
864 * @buflen: Response buffer length.
866 * Returns list of inquiry EVPD pages available.
869 * spin_lock_irqsave(host_set lock)
872 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
876 0x00, /* page 0x00, this page */
877 0x80, /* page 0x80, unit serial no page */
878 0x83 /* page 0x83, device ident page */
880 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
883 memcpy(rbuf + 4, pages, sizeof(pages));
889 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
890 * @args: device IDENTIFY data / SCSI command of interest.
891 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
892 * @buflen: Response buffer length.
894 * Returns ATA device serial number.
897 * spin_lock_irqsave(host_set lock)
900 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
905 0x80, /* this page code */
907 ATA_SERNO_LEN, /* page len */
909 memcpy(rbuf, hdr, sizeof(hdr));
911 if (buflen > (ATA_SERNO_LEN + 4 - 1))
912 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
913 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
918 static const char *inq_83_str = "Linux ATA-SCSI simulator";
921 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
922 * @args: device IDENTIFY data / SCSI command of interest.
923 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
924 * @buflen: Response buffer length.
926 * Returns device identification. Currently hardcoded to
927 * return "Linux ATA-SCSI simulator".
930 * spin_lock_irqsave(host_set lock)
933 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
936 rbuf[1] = 0x83; /* this page code */
937 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
939 /* our one and only identification descriptor (vendor-specific) */
940 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
941 rbuf[4 + 0] = 2; /* code set: ASCII */
942 rbuf[4 + 3] = strlen(inq_83_str);
943 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
950 * ata_scsiop_noop - Command handler that simply returns success.
951 * @args: device IDENTIFY data / SCSI command of interest.
952 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
953 * @buflen: Response buffer length.
955 * No operation. Simply returns success to caller, to indicate
956 * that the caller should successfully complete this SCSI command.
959 * spin_lock_irqsave(host_set lock)
962 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
970 * ata_msense_push - Push data onto MODE SENSE data output buffer
971 * @ptr_io: (input/output) Location to store more output data
972 * @last: End of output data buffer
973 * @buf: Pointer to BLOB being added to output buffer
974 * @buflen: Length of BLOB
976 * Store MODE SENSE data on an output buffer.
982 static void ata_msense_push(u8 **ptr_io, const u8 *last,
983 const u8 *buf, unsigned int buflen)
987 if ((ptr + buflen - 1) > last)
990 memcpy(ptr, buf, buflen);
998 * ata_msense_caching - Simulate MODE SENSE caching info page
999 * @id: device IDENTIFY data
1000 * @ptr_io: (input/output) Location to store more output data
1001 * @last: End of output data buffer
1003 * Generate a caching info page, which conditionally indicates
1004 * write caching to the SCSI layer, depending on device
1011 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1015 0x8, /* page code */
1016 0x12, /* page length */
1017 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 10 zeroes */
1018 0, 0, 0, 0, 0, 0, 0, 0 /* 8 zeroes */
1021 if (ata_id_wcache_enabled(id))
1022 page[2] |= (1 << 2); /* write cache enable */
1023 if (!ata_id_rahead_enabled(id))
1024 page[12] |= (1 << 5); /* disable read ahead */
1026 ata_msense_push(ptr_io, last, page, sizeof(page));
1027 return sizeof(page);
1031 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1032 * @dev: Device associated with this MODE SENSE command
1033 * @ptr_io: (input/output) Location to store more output data
1034 * @last: End of output data buffer
1036 * Generate a generic MODE SENSE control mode page.
1042 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1044 const u8 page[] = {0xa, 0xa, 6, 0, 0, 0, 0, 0, 0xff, 0xff, 0, 30};
1046 /* byte 2: set the descriptor format sense data bit (bit 2)
1047 * since we need to support returning this format for SAT
1048 * commands and any SCSI commands against a 48b LBA device.
1051 ata_msense_push(ptr_io, last, page, sizeof(page));
1052 return sizeof(page);
1056 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1057 * @dev: Device associated with this MODE SENSE command
1058 * @ptr_io: (input/output) Location to store more output data
1059 * @last: End of output data buffer
1061 * Generate a generic MODE SENSE r/w error recovery page.
1067 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1070 0x1, /* page code */
1071 0xa, /* page length */
1072 (1 << 7) | (1 << 6), /* note auto r/w reallocation */
1073 0, 0, 0, 0, 0, 0, 0, 0, 0 /* 9 zeroes */
1076 ata_msense_push(ptr_io, last, page, sizeof(page));
1077 return sizeof(page);
1081 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1082 * @args: device IDENTIFY data / SCSI command of interest.
1083 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1084 * @buflen: Response buffer length.
1086 * Simulate MODE SENSE commands.
1089 * spin_lock_irqsave(host_set lock)
1092 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1093 unsigned int buflen)
1095 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1096 unsigned int page_control, six_byte, output_len;
1100 six_byte = (scsicmd[0] == MODE_SENSE);
1102 /* we only support saved and current values (which we treat
1103 * in the same manner)
1105 page_control = scsicmd[2] >> 6;
1106 if ((page_control != 0) && (page_control != 3))
1114 p = rbuf + output_len;
1115 last = rbuf + buflen - 1;
1117 switch(scsicmd[2] & 0x3f) {
1118 case 0x01: /* r/w error recovery */
1119 output_len += ata_msense_rw_recovery(&p, last);
1122 case 0x08: /* caching */
1123 output_len += ata_msense_caching(args->id, &p, last);
1126 case 0x0a: { /* control mode */
1127 output_len += ata_msense_ctl_mode(&p, last);
1131 case 0x3f: /* all pages */
1132 output_len += ata_msense_rw_recovery(&p, last);
1133 output_len += ata_msense_caching(args->id, &p, last);
1134 output_len += ata_msense_ctl_mode(&p, last);
1137 default: /* invalid page code */
1143 rbuf[0] = output_len;
1146 rbuf[0] = output_len >> 8;
1147 rbuf[1] = output_len;
1154 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1155 * @args: device IDENTIFY data / SCSI command of interest.
1156 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1157 * @buflen: Response buffer length.
1159 * Simulate READ CAPACITY commands.
1162 * spin_lock_irqsave(host_set lock)
1165 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1166 unsigned int buflen)
1173 if (ata_id_has_lba48(args->id))
1174 n_sectors = ata_id_u64(args->id, 100);
1176 n_sectors = ata_id_u32(args->id, 60);
1177 n_sectors--; /* ATA TotalUserSectors - 1 */
1179 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1180 if( n_sectors >= 0xffffffffULL )
1181 tmp = 0xffffffff ; /* Return max count on overflow */
1185 /* sector count, 32-bit */
1186 rbuf[0] = tmp >> (8 * 3);
1187 rbuf[1] = tmp >> (8 * 2);
1188 rbuf[2] = tmp >> (8 * 1);
1192 tmp = ATA_SECT_SIZE;
1197 /* sector count, 64-bit */
1198 tmp = n_sectors >> (8 * 4);
1199 rbuf[2] = tmp >> (8 * 3);
1200 rbuf[3] = tmp >> (8 * 2);
1201 rbuf[4] = tmp >> (8 * 1);
1204 rbuf[6] = tmp >> (8 * 3);
1205 rbuf[7] = tmp >> (8 * 2);
1206 rbuf[8] = tmp >> (8 * 1);
1210 tmp = ATA_SECT_SIZE;
1211 rbuf[12] = tmp >> 8;
1219 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1220 * @args: device IDENTIFY data / SCSI command of interest.
1221 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1222 * @buflen: Response buffer length.
1224 * Simulate REPORT LUNS command.
1227 * spin_lock_irqsave(host_set lock)
1230 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1231 unsigned int buflen)
1234 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1240 * ata_scsi_badcmd - End a SCSI request with an error
1241 * @cmd: SCSI request to be handled
1242 * @done: SCSI command completion function
1243 * @asc: SCSI-defined additional sense code
1244 * @ascq: SCSI-defined additional sense code qualifier
1246 * Helper function that completes a SCSI command with
1247 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1248 * and the specified additional sense codes.
1251 * spin_lock_irqsave(host_set lock)
1254 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1257 cmd->result = SAM_STAT_CHECK_CONDITION;
1259 cmd->sense_buffer[0] = 0x70;
1260 cmd->sense_buffer[2] = ILLEGAL_REQUEST;
1261 cmd->sense_buffer[7] = 14 - 8; /* addnl. sense len. FIXME: correct? */
1262 cmd->sense_buffer[12] = asc;
1263 cmd->sense_buffer[13] = ascq;
1268 static int atapi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1270 struct scsi_cmnd *cmd = qc->scsicmd;
1272 if (unlikely(drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ))) {
1273 DPRINTK("request check condition\n");
1275 cmd->result = SAM_STAT_CHECK_CONDITION;
1281 u8 *scsicmd = cmd->cmnd;
1283 if (scsicmd[0] == INQUIRY) {
1285 unsigned int buflen;
1287 buflen = ata_scsi_rbuf_get(cmd, &buf);
1289 buf[3] = (buf[3] & 0xf0) | 2;
1290 ata_scsi_rbuf_put(cmd, buf);
1292 cmd->result = SAM_STAT_GOOD;
1300 * atapi_xlat - Initialize PACKET taskfile
1301 * @qc: command structure to be initialized
1302 * @scsicmd: SCSI CDB associated with this PACKET command
1305 * spin_lock_irqsave(host_set lock)
1308 * Zero on success, non-zero on failure.
1311 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
1313 struct scsi_cmnd *cmd = qc->scsicmd;
1314 struct ata_device *dev = qc->dev;
1315 int using_pio = (dev->flags & ATA_DFLAG_PIO);
1316 int nodata = (cmd->sc_data_direction == DMA_NONE);
1319 /* Check whether ATAPI DMA is safe */
1320 if (ata_check_atapi_dma(qc))
1323 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
1325 qc->complete_fn = atapi_qc_complete;
1327 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1328 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
1329 qc->tf.flags |= ATA_TFLAG_WRITE;
1330 DPRINTK("direction: write\n");
1333 qc->tf.command = ATA_CMD_PACKET;
1335 /* no data, or PIO data xfer */
1336 if (using_pio || nodata) {
1338 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
1340 qc->tf.protocol = ATA_PROT_ATAPI;
1341 qc->tf.lbam = (8 * 1024) & 0xff;
1342 qc->tf.lbah = (8 * 1024) >> 8;
1347 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
1348 qc->tf.feature |= ATAPI_PKT_DMA;
1350 #ifdef ATAPI_ENABLE_DMADIR
1351 /* some SATA bridges need us to indicate data xfer direction */
1352 if (cmd->sc_data_direction != DMA_TO_DEVICE)
1353 qc->tf.feature |= ATAPI_DMADIR;
1357 qc->nbytes = cmd->bufflen;
1363 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
1364 * @ap: ATA port to which the device is attached
1365 * @scsidev: SCSI device from which we derive the ATA device
1367 * Given various information provided in struct scsi_cmnd,
1368 * map that onto an ATA bus, and using that mapping
1369 * determine which ata_device is associated with the
1370 * SCSI command to be sent.
1373 * spin_lock_irqsave(host_set lock)
1376 * Associated ATA device, or %NULL if not found.
1379 static struct ata_device *
1380 ata_scsi_find_dev(struct ata_port *ap, struct scsi_device *scsidev)
1382 struct ata_device *dev;
1384 /* skip commands not addressed to targets we simulate */
1385 if (likely(scsidev->id < ATA_MAX_DEVICES))
1386 dev = &ap->device[scsidev->id];
1390 if (unlikely((scsidev->channel != 0) ||
1391 (scsidev->lun != 0)))
1394 if (unlikely(!ata_dev_present(dev)))
1397 #ifndef ATA_ENABLE_ATAPI
1398 if (unlikely(dev->class == ATA_DEV_ATAPI))
1406 * ata_get_xlat_func - check if SCSI to ATA translation is possible
1408 * @cmd: SCSI command opcode to consider
1410 * Look up the SCSI command given, and determine whether the
1411 * SCSI command is to be translated or simulated.
1414 * Pointer to translation function if possible, %NULL if not.
1417 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
1427 return ata_scsi_rw_xlat;
1429 case SYNCHRONIZE_CACHE:
1430 if (ata_try_flush_cache(dev))
1431 return ata_scsi_flush_xlat;
1436 return ata_scsi_verify_xlat;
1443 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
1444 * @ap: ATA port to which the command was being sent
1445 * @cmd: SCSI command to dump
1447 * Prints the contents of a SCSI command via printk().
1450 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
1451 struct scsi_cmnd *cmd)
1454 struct scsi_device *scsidev = cmd->device;
1455 u8 *scsicmd = cmd->cmnd;
1457 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
1459 scsidev->channel, scsidev->id, scsidev->lun,
1460 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
1461 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
1467 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
1468 * @cmd: SCSI command to be sent
1469 * @done: Completion function, called when command is complete
1471 * In some cases, this function translates SCSI commands into
1472 * ATA taskfiles, and queues the taskfiles to be sent to
1473 * hardware. In other cases, this function simulates a
1474 * SCSI device by evaluating and responding to certain
1475 * SCSI commands. This creates the overall effect of
1476 * ATA and ATAPI devices appearing as SCSI devices.
1479 * Releases scsi-layer-held lock, and obtains host_set lock.
1485 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
1487 struct ata_port *ap;
1488 struct ata_device *dev;
1489 struct scsi_device *scsidev = cmd->device;
1491 ap = (struct ata_port *) &scsidev->host->hostdata[0];
1493 ata_scsi_dump_cdb(ap, cmd);
1495 dev = ata_scsi_find_dev(ap, scsidev);
1496 if (unlikely(!dev)) {
1497 cmd->result = (DID_BAD_TARGET << 16);
1502 if (dev->class == ATA_DEV_ATA) {
1503 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
1507 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
1509 ata_scsi_simulate(dev->id, cmd, done);
1511 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
1518 * ata_scsi_simulate - simulate SCSI command on ATA device
1519 * @id: current IDENTIFY data for target device.
1520 * @cmd: SCSI command being sent to device.
1521 * @done: SCSI command completion function.
1523 * Interprets and directly executes a select list of SCSI commands
1524 * that can be handled internally.
1527 * spin_lock_irqsave(host_set lock)
1530 void ata_scsi_simulate(u16 *id,
1531 struct scsi_cmnd *cmd,
1532 void (*done)(struct scsi_cmnd *))
1534 struct ata_scsi_args args;
1535 u8 *scsicmd = cmd->cmnd;
1541 switch(scsicmd[0]) {
1542 /* no-op's, complete with success */
1543 case SYNCHRONIZE_CACHE:
1547 case TEST_UNIT_READY:
1548 case FORMAT_UNIT: /* FIXME: correct? */
1549 case SEND_DIAGNOSTIC: /* FIXME: correct? */
1550 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
1554 if (scsicmd[1] & 2) /* is CmdDt set? */
1555 ata_bad_cdb(cmd, done);
1556 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
1557 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
1558 else if (scsicmd[2] == 0x00)
1559 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
1560 else if (scsicmd[2] == 0x80)
1561 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
1562 else if (scsicmd[2] == 0x83)
1563 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
1565 ata_bad_cdb(cmd, done);
1570 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
1573 case MODE_SELECT: /* unconditionally return */
1574 case MODE_SELECT_10: /* bad-field-in-cdb */
1575 ata_bad_cdb(cmd, done);
1579 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1582 case SERVICE_ACTION_IN:
1583 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
1584 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1586 ata_bad_cdb(cmd, done);
1590 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
1593 /* mandantory commands we haven't implemented yet */
1596 /* all other commands */
1598 ata_bad_scsiop(cmd, done);