2 * libata-scsi.c - helper library for ATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
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)
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.
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.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
36 #include <linux/kernel.h>
37 #include <linux/blkdev.h>
38 #include <linux/spinlock.h>
39 #include <scsi/scsi.h>
41 #include <scsi/scsi_host.h>
42 #include <linux/libata.h>
43 #include <asm/uaccess.h>
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);
52 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
53 void (*done)(struct scsi_cmnd *))
55 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
56 /* "Invalid field in cbd" */
61 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
62 * @sdev: SCSI device for which BIOS geometry is to be determined
63 * @bdev: block device associated with @sdev
64 * @capacity: capacity of SCSI device
65 * @geom: location to which geometry will be output
67 * Generic bios head/sector/cylinder calculator
68 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
69 * mapping. Some situations may arise where the disk is not
70 * bootable if this is not used.
73 * Defined by the SCSI layer. We don't really care.
78 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
79 sector_t capacity, int geom[])
83 sector_div(capacity, 255*63);
89 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
92 struct ata_device *dev;
93 int val = -EINVAL, rc = -EINVAL;
95 ap = (struct ata_port *) &scsidev->host->hostdata[0];
99 dev = ata_scsi_find_dev(ap, scsidev);
106 case ATA_IOC_GET_IO32:
108 if (copy_to_user(arg, &val, 1))
112 case ATA_IOC_SET_IO32:
113 val = (unsigned long) arg;
128 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
129 * @ap: ATA port to which the new command is attached
130 * @dev: ATA device to which the new command is attached
131 * @cmd: SCSI command that originated this ATA command
132 * @done: SCSI command completion function
134 * Obtain a reference to an unused ata_queued_cmd structure,
135 * which is the basic libata structure representing a single
136 * ATA command sent to the hardware.
138 * If a command was available, fill in the SCSI-specific
139 * portions of the structure with information on the
143 * spin_lock_irqsave(host_set lock)
146 * Command allocated, or %NULL if none available.
148 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
149 struct ata_device *dev,
150 struct scsi_cmnd *cmd,
151 void (*done)(struct scsi_cmnd *))
153 struct ata_queued_cmd *qc;
155 qc = ata_qc_new_init(ap, dev);
161 qc->sg = (struct scatterlist *) cmd->request_buffer;
162 qc->n_elem = cmd->use_sg;
168 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
176 * ata_to_sense_error - convert ATA error to SCSI error
177 * @qc: Command that we are erroring out
178 * @drv_stat: value contained in ATA status register
180 * Converts an ATA error into a SCSI error. While we are at it
181 * we decode and dump the ATA error for the user so that they
182 * have some idea what really happened at the non make-believe
186 * spin_lock_irqsave(host_set lock)
189 void ata_to_sense_error(struct ata_queued_cmd *qc, u8 drv_stat)
191 struct scsi_cmnd *cmd = qc->scsicmd;
193 /* Based on the 3ware driver translation table */
194 static unsigned char sense_table[][4] = {
196 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
198 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
200 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
201 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
202 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
203 /* MC|ID|ABRT|TRK0|MARK */
204 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
206 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
207 /* Bad address mark */
208 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
210 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
212 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
213 /* Media change request */
214 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
216 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
218 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
220 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
221 /* BBD - block marked bad */
222 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
223 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
225 static unsigned char stat_table[][4] = {
226 /* Must be first because BUSY means no other bits valid */
227 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
228 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
229 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
230 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
231 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
236 * Is this an error we can process/parse
239 if(drv_stat & ATA_ERR)
240 /* Read the err bits */
241 err = ata_chk_err(qc->ap);
243 /* Display the ATA level error info */
245 printk(KERN_WARNING "ata%u: status=0x%02x { ", qc->ap->id, drv_stat);
249 err = 0; /* Data is not valid in this case */
252 if(drv_stat & 0x40) printk("DriveReady ");
253 if(drv_stat & 0x20) printk("DeviceFault ");
254 if(drv_stat & 0x10) printk("SeekComplete ");
255 if(drv_stat & 0x08) printk("DataRequest ");
256 if(drv_stat & 0x04) printk("CorrectedError ");
257 if(drv_stat & 0x02) printk("Index ");
258 if(drv_stat & 0x01) printk("Error ");
264 printk(KERN_WARNING "ata%u: error=0x%02x { ", qc->ap->id, err);
265 if(err & 0x04) printk("DriveStatusError ");
273 if(err & 0x40) printk("UncorrectableError ");
274 if(err & 0x10) printk("SectorIdNotFound ");
275 if(err & 0x02) printk("TrackZeroNotFound ");
276 if(err & 0x01) printk("AddrMarkNotFound ");
279 /* Should we dump sector info here too ?? */
284 while(sense_table[i][0] != 0xFF)
286 /* Look for best matches first */
287 if((sense_table[i][0] & err) == sense_table[i][0])
289 ata_scsi_set_sense(cmd, sense_table[i][1] /* sk */,
290 sense_table[i][2] /* asc */,
291 sense_table[i][3] /* ascq */ );
296 /* No immediate match */
298 printk(KERN_DEBUG "ata%u: no sense translation for 0x%02x\n", qc->ap->id, err);
301 /* Fall back to interpreting status bits */
302 while(stat_table[i][0] != 0xFF)
304 if(stat_table[i][0] & drv_stat)
306 ata_scsi_set_sense(cmd, sense_table[i][1] /* sk */,
307 sense_table[i][2] /* asc */,
308 sense_table[i][3] /* ascq */ );
314 printk(KERN_ERR "ata%u: called with no error (%02X)!\n", qc->ap->id, drv_stat);
315 /* additional-sense-code[-qualifier] */
317 if (cmd->sc_data_direction == DMA_FROM_DEVICE) {
318 ata_scsi_set_sense(cmd, MEDIUM_ERROR, 0x11, 0x4);
319 /* "unrecovered read error" */
321 ata_scsi_set_sense(cmd, MEDIUM_ERROR, 0xc, 0x2);
322 /* "write error - auto-reallocation failed" */
327 * ata_scsi_slave_config - Set SCSI device attributes
328 * @sdev: SCSI device to examine
330 * This is called before we actually start reading
331 * and writing to the device, to configure certain
332 * SCSI mid-layer behaviors.
335 * Defined by SCSI layer. We don't really care.
338 int ata_scsi_slave_config(struct scsi_device *sdev)
340 sdev->use_10_for_rw = 1;
341 sdev->use_10_for_ms = 1;
343 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
345 if (sdev->id < ATA_MAX_DEVICES) {
347 struct ata_device *dev;
349 ap = (struct ata_port *) &sdev->host->hostdata[0];
350 dev = &ap->device[sdev->id];
352 /* TODO: 1024 is an arbitrary number, not the
353 * hardware maximum. This should be increased to
354 * 65534 when Jens Axboe's patch for dynamically
355 * determining max_sectors is merged.
357 if ((dev->flags & ATA_DFLAG_LBA48) &&
358 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
360 * do not overwrite sdev->host->max_sectors, since
361 * other drives on this host may not support LBA48
363 blk_queue_max_sectors(sdev->request_queue, 2048);
367 return 0; /* scsi layer doesn't check return value, sigh */
371 * ata_scsi_error - SCSI layer error handler callback
372 * @host: SCSI host on which error occurred
374 * Handles SCSI-layer-thrown error events.
377 * Inherited from SCSI layer (none, can sleep)
383 int ata_scsi_error(struct Scsi_Host *host)
389 ap = (struct ata_port *) &host->hostdata[0];
390 ap->ops->eng_timeout(ap);
392 /* TODO: this is per-command; when queueing is supported
393 * this code will either change or move to a more
397 INIT_LIST_HEAD(&host->eh_cmd_q);
404 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
405 * @qc: Storage for translated ATA taskfile
406 * @scsicmd: SCSI command to translate
408 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
409 * (to start). Perhaps these commands should be preceded by
410 * CHECK POWER MODE to see what power mode the device is already in.
411 * [See SAT revision 5 at www.t10.org]
414 * spin_lock_irqsave(host_set lock)
417 * Zero on success, non-zero on error.
420 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
423 struct ata_taskfile *tf = &qc->tf;
425 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
426 tf->protocol = ATA_PROT_NODATA;
427 if (scsicmd[1] & 0x1) {
428 ; /* ignore IMMED bit, violates sat-r05 */
430 if (scsicmd[4] & 0x2)
431 goto invalid_fld; /* LOEJ bit set not supported */
432 if (((scsicmd[4] >> 4) & 0xf) != 0)
433 goto invalid_fld; /* power conditions not supported */
434 if (scsicmd[4] & 0x1) {
435 tf->nsect = 1; /* 1 sector, lba=0 */
437 if (qc->dev->flags & ATA_DFLAG_LBA) {
438 qc->tf.flags |= ATA_TFLAG_LBA;
443 tf->device |= ATA_LBA;
446 tf->lbal = 0x1; /* sect */
447 tf->lbam = 0x0; /* cyl low */
448 tf->lbah = 0x0; /* cyl high */
451 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
453 tf->nsect = 0; /* time period value (0 implies now) */
454 tf->command = ATA_CMD_STANDBY;
455 /* Consider: ATA STANDBY IMMEDIATE command */
458 * Standby and Idle condition timers could be implemented but that
459 * would require libata to implement the Power condition mode page
460 * and allow the user to change it. Changing mode pages requires
461 * MODE SELECT to be implemented.
467 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
468 /* "Invalid field in cbd" */
474 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
475 * @qc: Storage for translated ATA taskfile
476 * @scsicmd: SCSI command to translate (ignored)
478 * Sets up an ATA taskfile to issue FLUSH CACHE or
482 * spin_lock_irqsave(host_set lock)
485 * Zero on success, non-zero on error.
488 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
490 struct ata_taskfile *tf = &qc->tf;
492 tf->flags |= ATA_TFLAG_DEVICE;
493 tf->protocol = ATA_PROT_NODATA;
495 if ((tf->flags & ATA_TFLAG_LBA48) &&
496 (ata_id_has_flush_ext(qc->dev->id)))
497 tf->command = ATA_CMD_FLUSH_EXT;
499 tf->command = ATA_CMD_FLUSH;
505 * scsi_6_lba_len - Get LBA and transfer length
506 * @scsicmd: SCSI command to translate
508 * Calculate LBA and transfer length for 6-byte commands.
512 * @plen: the transfer length
515 static void scsi_6_lba_len(u8 *scsicmd, u64 *plba, u32 *plen)
520 VPRINTK("six-byte command\n");
522 lba |= ((u64)scsicmd[2]) << 8;
523 lba |= ((u64)scsicmd[3]);
525 len |= ((u32)scsicmd[4]);
532 * scsi_10_lba_len - Get LBA and transfer length
533 * @scsicmd: SCSI command to translate
535 * Calculate LBA and transfer length for 10-byte commands.
539 * @plen: the transfer length
542 static void scsi_10_lba_len(u8 *scsicmd, u64 *plba, u32 *plen)
547 VPRINTK("ten-byte command\n");
549 lba |= ((u64)scsicmd[2]) << 24;
550 lba |= ((u64)scsicmd[3]) << 16;
551 lba |= ((u64)scsicmd[4]) << 8;
552 lba |= ((u64)scsicmd[5]);
554 len |= ((u32)scsicmd[7]) << 8;
555 len |= ((u32)scsicmd[8]);
562 * scsi_16_lba_len - Get LBA and transfer length
563 * @scsicmd: SCSI command to translate
565 * Calculate LBA and transfer length for 16-byte commands.
569 * @plen: the transfer length
572 static void scsi_16_lba_len(u8 *scsicmd, u64 *plba, u32 *plen)
577 VPRINTK("sixteen-byte command\n");
579 lba |= ((u64)scsicmd[2]) << 56;
580 lba |= ((u64)scsicmd[3]) << 48;
581 lba |= ((u64)scsicmd[4]) << 40;
582 lba |= ((u64)scsicmd[5]) << 32;
583 lba |= ((u64)scsicmd[6]) << 24;
584 lba |= ((u64)scsicmd[7]) << 16;
585 lba |= ((u64)scsicmd[8]) << 8;
586 lba |= ((u64)scsicmd[9]);
588 len |= ((u32)scsicmd[10]) << 24;
589 len |= ((u32)scsicmd[11]) << 16;
590 len |= ((u32)scsicmd[12]) << 8;
591 len |= ((u32)scsicmd[13]);
598 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
599 * @qc: Storage for translated ATA taskfile
600 * @scsicmd: SCSI command to translate
602 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
605 * spin_lock_irqsave(host_set lock)
608 * Zero on success, non-zero on error.
611 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
613 struct ata_taskfile *tf = &qc->tf;
614 struct ata_device *dev = qc->dev;
615 unsigned int lba = tf->flags & ATA_TFLAG_LBA;
616 unsigned int lba48 = tf->flags & ATA_TFLAG_LBA48;
617 u64 dev_sectors = qc->dev->n_sectors;
621 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
622 tf->protocol = ATA_PROT_NODATA;
624 if (scsicmd[0] == VERIFY)
625 scsi_10_lba_len(scsicmd, &block, &n_block);
626 else if (scsicmd[0] == VERIFY_16)
627 scsi_16_lba_len(scsicmd, &block, &n_block);
633 if (block >= dev_sectors)
635 if ((block + n_block) > dev_sectors)
638 if (n_block > (64 * 1024))
647 tf->command = ATA_CMD_VERIFY_EXT;
649 tf->hob_nsect = (n_block >> 8) & 0xff;
651 tf->hob_lbah = (block >> 40) & 0xff;
652 tf->hob_lbam = (block >> 32) & 0xff;
653 tf->hob_lbal = (block >> 24) & 0xff;
655 tf->command = ATA_CMD_VERIFY;
657 tf->device |= (block >> 24) & 0xf;
660 tf->nsect = n_block & 0xff;
662 tf->lbah = (block >> 16) & 0xff;
663 tf->lbam = (block >> 8) & 0xff;
664 tf->lbal = block & 0xff;
666 tf->device |= ATA_LBA;
669 u32 sect, head, cyl, track;
671 /* Convert LBA to CHS */
672 track = (u32)block / dev->sectors;
673 cyl = track / dev->heads;
674 head = track % dev->heads;
675 sect = (u32)block % dev->sectors + 1;
677 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
678 (u32)block, track, cyl, head, sect);
680 /* Check whether the converted CHS can fit.
684 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
687 tf->command = ATA_CMD_VERIFY;
688 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
698 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
699 /* "Invalid field in cbd" */
703 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
704 /* "Logical Block Address out of range" */
708 qc->scsicmd->result = SAM_STAT_GOOD;
713 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
714 * @qc: Storage for translated ATA taskfile
715 * @scsicmd: SCSI command to translate
717 * Converts any of six SCSI read/write commands into the
718 * ATA counterpart, including starting sector (LBA),
719 * sector count, and taking into account the device's LBA48
722 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
723 * %WRITE_16 are currently supported.
726 * spin_lock_irqsave(host_set lock)
729 * Zero on success, non-zero on error.
732 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
734 struct ata_taskfile *tf = &qc->tf;
735 struct ata_device *dev = qc->dev;
736 unsigned int lba = tf->flags & ATA_TFLAG_LBA;
737 unsigned int lba48 = tf->flags & ATA_TFLAG_LBA48;
741 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
742 tf->protocol = qc->dev->xfer_protocol;
744 if (scsicmd[0] == READ_10 || scsicmd[0] == READ_6 ||
745 scsicmd[0] == READ_16) {
746 tf->command = qc->dev->read_cmd;
748 tf->command = qc->dev->write_cmd;
749 tf->flags |= ATA_TFLAG_WRITE;
752 /* Calculate the SCSI LBA and transfer length. */
753 switch (scsicmd[0]) {
756 scsi_10_lba_len(scsicmd, &block, &n_block);
760 scsi_6_lba_len(scsicmd, &block, &n_block);
762 /* for 6-byte r/w commands, transfer length 0
763 * means 256 blocks of data, not 0 block.
770 scsi_16_lba_len(scsicmd, &block, &n_block);
773 DPRINTK("no-byte command\n");
777 /* Check and compose ATA command */
779 /* For 10-byte and 16-byte SCSI R/W commands, transfer
780 * length 0 means transfer 0 block of data.
781 * However, for ATA R/W commands, sector count 0 means
782 * 256 or 65536 sectors, not 0 sectors as in SCSI.
788 /* The request -may- be too large for LBA48. */
789 if ((block >> 48) || (n_block > 65536))
792 tf->hob_nsect = (n_block >> 8) & 0xff;
794 tf->hob_lbah = (block >> 40) & 0xff;
795 tf->hob_lbam = (block >> 32) & 0xff;
796 tf->hob_lbal = (block >> 24) & 0xff;
800 /* The request -may- be too large for LBA28. */
801 if ((block >> 28) || (n_block > 256))
804 tf->device |= (block >> 24) & 0xf;
808 tf->nsect = n_block & 0xff;
810 tf->lbah = (block >> 16) & 0xff;
811 tf->lbam = (block >> 8) & 0xff;
812 tf->lbal = block & 0xff;
814 tf->device |= ATA_LBA;
817 u32 sect, head, cyl, track;
819 /* The request -may- be too large for CHS addressing. */
820 if ((block >> 28) || (n_block > 256))
823 /* Convert LBA to CHS */
824 track = (u32)block / dev->sectors;
825 cyl = track / dev->heads;
826 head = track % dev->heads;
827 sect = (u32)block % dev->sectors + 1;
829 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
830 (u32)block, track, cyl, head, sect);
832 /* Check whether the converted CHS can fit.
836 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
840 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
850 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
851 /* "Invalid field in cbd" */
855 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
856 /* "Logical Block Address out of range" */
860 qc->scsicmd->result = SAM_STAT_GOOD;
864 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
866 struct scsi_cmnd *cmd = qc->scsicmd;
868 if (unlikely(drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ)))
869 ata_to_sense_error(qc, drv_stat);
871 cmd->result = SAM_STAT_GOOD;
879 * ata_scsi_translate - Translate then issue SCSI command to ATA device
880 * @ap: ATA port to which the command is addressed
881 * @dev: ATA device to which the command is addressed
882 * @cmd: SCSI command to execute
883 * @done: SCSI command completion function
884 * @xlat_func: Actor which translates @cmd to an ATA taskfile
886 * Our ->queuecommand() function has decided that the SCSI
887 * command issued can be directly translated into an ATA
888 * command, rather than handled internally.
890 * This function sets up an ata_queued_cmd structure for the
891 * SCSI command, and sends that ata_queued_cmd to the hardware.
893 * The xlat_func argument (actor) returns 0 if ready to execute
894 * ATA command, else 1 to finish translation. If 1 is returned
895 * then cmd->result (and possibly cmd->sense_buffer) are assumed
896 * to be set reflecting an error condition or clean (early)
900 * spin_lock_irqsave(host_set lock)
903 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
904 struct scsi_cmnd *cmd,
905 void (*done)(struct scsi_cmnd *),
906 ata_xlat_func_t xlat_func)
908 struct ata_queued_cmd *qc;
909 u8 *scsicmd = cmd->cmnd;
913 qc = ata_scsi_qc_new(ap, dev, cmd, done);
917 /* data is present; dma-map it */
918 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
919 cmd->sc_data_direction == DMA_TO_DEVICE) {
920 if (unlikely(cmd->request_bufflen < 1)) {
921 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
927 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
929 ata_sg_init_one(qc, cmd->request_buffer,
930 cmd->request_bufflen);
932 qc->dma_dir = cmd->sc_data_direction;
935 qc->complete_fn = ata_scsi_qc_complete;
937 if (xlat_func(qc, scsicmd))
940 /* select device, send command to hardware */
941 if (ata_qc_issue(qc))
950 DPRINTK("EXIT - early finish (good or error)\n");
956 cmd->result = (DID_ERROR << 16);
958 DPRINTK("EXIT - internal\n");
963 * ata_scsi_rbuf_get - Map response buffer.
964 * @cmd: SCSI command containing buffer to be mapped.
965 * @buf_out: Pointer to mapped area.
967 * Maps buffer contained within SCSI command @cmd.
970 * spin_lock_irqsave(host_set lock)
973 * Length of response buffer.
976 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
982 struct scatterlist *sg;
984 sg = (struct scatterlist *) cmd->request_buffer;
985 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
988 buf = cmd->request_buffer;
989 buflen = cmd->request_bufflen;
997 * ata_scsi_rbuf_put - Unmap response buffer.
998 * @cmd: SCSI command containing buffer to be unmapped.
999 * @buf: buffer to unmap
1001 * Unmaps response buffer contained within @cmd.
1004 * spin_lock_irqsave(host_set lock)
1007 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1010 struct scatterlist *sg;
1012 sg = (struct scatterlist *) cmd->request_buffer;
1013 kunmap_atomic(buf - sg->offset, KM_USER0);
1018 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1019 * @args: device IDENTIFY data / SCSI command of interest.
1020 * @actor: Callback hook for desired SCSI command simulator
1022 * Takes care of the hard work of simulating a SCSI command...
1023 * Mapping the response buffer, calling the command's handler,
1024 * and handling the handler's return value. This return value
1025 * indicates whether the handler wishes the SCSI command to be
1026 * completed successfully (0), or not (in which case cmd->result
1027 * and sense buffer are assumed to be set).
1030 * spin_lock_irqsave(host_set lock)
1033 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1034 unsigned int (*actor) (struct ata_scsi_args *args,
1035 u8 *rbuf, unsigned int buflen))
1038 unsigned int buflen, rc;
1039 struct scsi_cmnd *cmd = args->cmd;
1041 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1042 memset(rbuf, 0, buflen);
1043 rc = actor(args, rbuf, buflen);
1044 ata_scsi_rbuf_put(cmd, rbuf);
1047 cmd->result = SAM_STAT_GOOD;
1052 * ata_scsiop_inq_std - Simulate INQUIRY command
1053 * @args: device IDENTIFY data / SCSI command of interest.
1054 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1055 * @buflen: Response buffer length.
1057 * Returns standard device identification data associated
1058 * with non-EVPD INQUIRY command output.
1061 * spin_lock_irqsave(host_set lock)
1064 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1065 unsigned int buflen)
1070 0x5, /* claim SPC-3 version compatibility */
1075 /* set scsi removeable (RMB) bit per ata bit */
1076 if (ata_id_removeable(args->id))
1081 memcpy(rbuf, hdr, sizeof(hdr));
1084 memcpy(&rbuf[8], "ATA ", 8);
1085 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1086 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1087 if (rbuf[32] == 0 || rbuf[32] == ' ')
1088 memcpy(&rbuf[32], "n/a ", 4);
1092 const u8 versions[] = {
1093 0x60, /* SAM-3 (no version claimed) */
1096 0x20, /* SBC-2 (no version claimed) */
1099 0x60 /* SPC-3 (no version claimed) */
1102 memcpy(rbuf + 59, versions, sizeof(versions));
1109 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1110 * @args: device IDENTIFY data / SCSI command of interest.
1111 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1112 * @buflen: Response buffer length.
1114 * Returns list of inquiry EVPD pages available.
1117 * spin_lock_irqsave(host_set lock)
1120 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1121 unsigned int buflen)
1123 const u8 pages[] = {
1124 0x00, /* page 0x00, this page */
1125 0x80, /* page 0x80, unit serial no page */
1126 0x83 /* page 0x83, device ident page */
1128 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1131 memcpy(rbuf + 4, pages, sizeof(pages));
1137 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1138 * @args: device IDENTIFY data / SCSI command of interest.
1139 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1140 * @buflen: Response buffer length.
1142 * Returns ATA device serial number.
1145 * spin_lock_irqsave(host_set lock)
1148 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1149 unsigned int buflen)
1153 0x80, /* this page code */
1155 ATA_SERNO_LEN, /* page len */
1157 memcpy(rbuf, hdr, sizeof(hdr));
1159 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1160 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1161 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1166 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1169 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1170 * @args: device IDENTIFY data / SCSI command of interest.
1171 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1172 * @buflen: Response buffer length.
1174 * Returns device identification. Currently hardcoded to
1175 * return "Linux ATA-SCSI simulator".
1178 * spin_lock_irqsave(host_set lock)
1181 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1182 unsigned int buflen)
1184 rbuf[1] = 0x83; /* this page code */
1185 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1187 /* our one and only identification descriptor (vendor-specific) */
1188 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1189 rbuf[4 + 0] = 2; /* code set: ASCII */
1190 rbuf[4 + 3] = strlen(inq_83_str);
1191 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1198 * ata_scsiop_noop - Command handler that simply returns success.
1199 * @args: device IDENTIFY data / SCSI command of interest.
1200 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1201 * @buflen: Response buffer length.
1203 * No operation. Simply returns success to caller, to indicate
1204 * that the caller should successfully complete this SCSI command.
1207 * spin_lock_irqsave(host_set lock)
1210 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1211 unsigned int buflen)
1218 * ata_msense_push - Push data onto MODE SENSE data output buffer
1219 * @ptr_io: (input/output) Location to store more output data
1220 * @last: End of output data buffer
1221 * @buf: Pointer to BLOB being added to output buffer
1222 * @buflen: Length of BLOB
1224 * Store MODE SENSE data on an output buffer.
1230 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1231 const u8 *buf, unsigned int buflen)
1235 if ((ptr + buflen - 1) > last)
1238 memcpy(ptr, buf, buflen);
1246 * ata_msense_caching - Simulate MODE SENSE caching info page
1247 * @id: device IDENTIFY data
1248 * @ptr_io: (input/output) Location to store more output data
1249 * @last: End of output data buffer
1251 * Generate a caching info page, which conditionally indicates
1252 * write caching to the SCSI layer, depending on device
1259 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1263 0x8, /* page code */
1264 0x12, /* page length */
1265 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 10 zeroes */
1266 0, 0, 0, 0, 0, 0, 0, 0 /* 8 zeroes */
1269 if (ata_id_wcache_enabled(id))
1270 page[2] |= (1 << 2); /* write cache enable */
1271 if (!ata_id_rahead_enabled(id))
1272 page[12] |= (1 << 5); /* disable read ahead */
1274 ata_msense_push(ptr_io, last, page, sizeof(page));
1275 return sizeof(page);
1279 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1280 * @dev: Device associated with this MODE SENSE command
1281 * @ptr_io: (input/output) Location to store more output data
1282 * @last: End of output data buffer
1284 * Generate a generic MODE SENSE control mode page.
1290 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1292 const u8 page[] = {0xa, 0xa, 6, 0, 0, 0, 0, 0, 0xff, 0xff, 0, 30};
1294 /* byte 2: set the descriptor format sense data bit (bit 2)
1295 * since we need to support returning this format for SAT
1296 * commands and any SCSI commands against a 48b LBA device.
1299 ata_msense_push(ptr_io, last, page, sizeof(page));
1300 return sizeof(page);
1304 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1305 * @dev: Device associated with this MODE SENSE command
1306 * @ptr_io: (input/output) Location to store more output data
1307 * @last: End of output data buffer
1309 * Generate a generic MODE SENSE r/w error recovery page.
1315 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1318 0x1, /* page code */
1319 0xa, /* page length */
1320 (1 << 7) | (1 << 6), /* note auto r/w reallocation */
1321 0, 0, 0, 0, 0, 0, 0, 0, 0 /* 9 zeroes */
1324 ata_msense_push(ptr_io, last, page, sizeof(page));
1325 return sizeof(page);
1329 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1330 * @args: device IDENTIFY data / SCSI command of interest.
1331 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1332 * @buflen: Response buffer length.
1334 * Simulate MODE SENSE commands.
1337 * spin_lock_irqsave(host_set lock)
1340 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1341 unsigned int buflen)
1343 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1344 unsigned int page_control, six_byte, output_len;
1348 six_byte = (scsicmd[0] == MODE_SENSE);
1350 /* we only support saved and current values (which we treat
1351 * in the same manner)
1353 page_control = scsicmd[2] >> 6;
1354 switch (page_control) {
1355 case 0: /* current */
1356 break; /* supported */
1358 goto saving_not_supp;
1359 case 1: /* changeable */
1360 case 2: /* defaults */
1370 p = rbuf + output_len;
1371 last = rbuf + buflen - 1;
1373 switch(scsicmd[2] & 0x3f) {
1374 case 0x01: /* r/w error recovery */
1375 output_len += ata_msense_rw_recovery(&p, last);
1378 case 0x08: /* caching */
1379 output_len += ata_msense_caching(args->id, &p, last);
1382 case 0x0a: { /* control mode */
1383 output_len += ata_msense_ctl_mode(&p, last);
1387 case 0x3f: /* all pages */
1388 output_len += ata_msense_rw_recovery(&p, last);
1389 output_len += ata_msense_caching(args->id, &p, last);
1390 output_len += ata_msense_ctl_mode(&p, last);
1393 default: /* invalid page code */
1399 rbuf[0] = output_len;
1402 rbuf[0] = output_len >> 8;
1403 rbuf[1] = output_len;
1409 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1410 /* "Invalid field in cbd" */
1414 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1415 /* "Saving parameters not supported" */
1420 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1421 * @args: device IDENTIFY data / SCSI command of interest.
1422 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1423 * @buflen: Response buffer length.
1425 * Simulate READ CAPACITY commands.
1428 * spin_lock_irqsave(host_set lock)
1431 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1432 unsigned int buflen)
1439 if (ata_id_has_lba(args->id)) {
1440 if (ata_id_has_lba48(args->id))
1441 n_sectors = ata_id_u64(args->id, 100);
1443 n_sectors = ata_id_u32(args->id, 60);
1445 /* CHS default translation */
1446 n_sectors = args->id[1] * args->id[3] * args->id[6];
1448 if (ata_id_current_chs_valid(args->id))
1449 /* CHS current translation */
1450 n_sectors = ata_id_u32(args->id, 57);
1453 n_sectors--; /* ATA TotalUserSectors - 1 */
1455 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1456 if( n_sectors >= 0xffffffffULL )
1457 tmp = 0xffffffff ; /* Return max count on overflow */
1461 /* sector count, 32-bit */
1462 rbuf[0] = tmp >> (8 * 3);
1463 rbuf[1] = tmp >> (8 * 2);
1464 rbuf[2] = tmp >> (8 * 1);
1468 tmp = ATA_SECT_SIZE;
1473 /* sector count, 64-bit */
1474 tmp = n_sectors >> (8 * 4);
1475 rbuf[2] = tmp >> (8 * 3);
1476 rbuf[3] = tmp >> (8 * 2);
1477 rbuf[4] = tmp >> (8 * 1);
1480 rbuf[6] = tmp >> (8 * 3);
1481 rbuf[7] = tmp >> (8 * 2);
1482 rbuf[8] = tmp >> (8 * 1);
1486 tmp = ATA_SECT_SIZE;
1487 rbuf[12] = tmp >> 8;
1495 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1496 * @args: device IDENTIFY data / SCSI command of interest.
1497 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1498 * @buflen: Response buffer length.
1500 * Simulate REPORT LUNS command.
1503 * spin_lock_irqsave(host_set lock)
1506 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1507 unsigned int buflen)
1510 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1516 * ata_scsi_set_sense - Set SCSI sense data and status
1517 * @cmd: SCSI request to be handled
1518 * @sk: SCSI-defined sense key
1519 * @asc: SCSI-defined additional sense code
1520 * @ascq: SCSI-defined additional sense code qualifier
1522 * Helper function that builds a valid fixed format, current
1523 * response code and the given sense key (sk), additional sense
1524 * code (asc) and additional sense code qualifier (ascq) with
1525 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1526 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1532 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1534 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1536 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1537 cmd->sense_buffer[2] = sk;
1538 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1539 cmd->sense_buffer[12] = asc;
1540 cmd->sense_buffer[13] = ascq;
1544 * ata_scsi_badcmd - End a SCSI request with an error
1545 * @cmd: SCSI request to be handled
1546 * @done: SCSI command completion function
1547 * @asc: SCSI-defined additional sense code
1548 * @ascq: SCSI-defined additional sense code qualifier
1550 * Helper function that completes a SCSI command with
1551 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1552 * and the specified additional sense codes.
1555 * spin_lock_irqsave(host_set lock)
1558 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1561 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1566 void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1567 struct scsi_cmnd *cmd)
1569 DECLARE_COMPLETION(wait);
1570 struct ata_queued_cmd *qc;
1571 unsigned long flags;
1574 DPRINTK("ATAPI request sense\n");
1576 qc = ata_qc_new_init(ap, dev);
1579 /* FIXME: is this needed? */
1580 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1582 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1583 qc->dma_dir = DMA_FROM_DEVICE;
1585 memset(&qc->cdb, 0, ap->cdb_len);
1586 qc->cdb[0] = REQUEST_SENSE;
1587 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1589 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1590 qc->tf.command = ATA_CMD_PACKET;
1592 qc->tf.protocol = ATA_PROT_ATAPI;
1593 qc->tf.lbam = (8 * 1024) & 0xff;
1594 qc->tf.lbah = (8 * 1024) >> 8;
1595 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
1597 qc->waiting = &wait;
1598 qc->complete_fn = ata_qc_complete_noop;
1600 spin_lock_irqsave(&ap->host_set->lock, flags);
1601 rc = ata_qc_issue(qc);
1602 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1605 ata_port_disable(ap);
1607 wait_for_completion(&wait);
1612 static int atapi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1614 struct scsi_cmnd *cmd = qc->scsicmd;
1616 VPRINTK("ENTER, drv_stat == 0x%x\n", drv_stat);
1618 if (unlikely(drv_stat & (ATA_BUSY | ATA_DRQ)))
1619 ata_to_sense_error(qc, drv_stat);
1621 else if (unlikely(drv_stat & ATA_ERR)) {
1622 DPRINTK("request check condition\n");
1624 /* FIXME: command completion with check condition
1625 * but no sense causes the error handler to run,
1626 * which then issues REQUEST SENSE, fills in the sense
1627 * buffer, and completes the command (for the second
1628 * time). We need to issue REQUEST SENSE some other
1629 * way, to avoid completing the command twice.
1631 cmd->result = SAM_STAT_CHECK_CONDITION;
1639 u8 *scsicmd = cmd->cmnd;
1641 if (scsicmd[0] == INQUIRY) {
1643 unsigned int buflen;
1645 buflen = ata_scsi_rbuf_get(cmd, &buf);
1647 /* ATAPI devices typically report zero for their SCSI version,
1648 * and sometimes deviate from the spec WRT response data
1649 * format. If SCSI version is reported as zero like normal,
1650 * then we make the following fixups: 1) Fake MMC-5 version,
1651 * to indicate to the Linux scsi midlayer this is a modern
1652 * device. 2) Ensure response data format / ATAPI information
1653 * are always correct.
1655 /* FIXME: do we ever override EVPD pages and the like, with
1663 ata_scsi_rbuf_put(cmd, buf);
1666 cmd->result = SAM_STAT_GOOD;
1673 * atapi_xlat - Initialize PACKET taskfile
1674 * @qc: command structure to be initialized
1675 * @scsicmd: SCSI CDB associated with this PACKET command
1678 * spin_lock_irqsave(host_set lock)
1681 * Zero on success, non-zero on failure.
1684 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
1686 struct scsi_cmnd *cmd = qc->scsicmd;
1687 struct ata_device *dev = qc->dev;
1688 int using_pio = (dev->flags & ATA_DFLAG_PIO);
1689 int nodata = (cmd->sc_data_direction == DMA_NONE);
1692 /* Check whether ATAPI DMA is safe */
1693 if (ata_check_atapi_dma(qc))
1696 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
1698 qc->complete_fn = atapi_qc_complete;
1700 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1701 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
1702 qc->tf.flags |= ATA_TFLAG_WRITE;
1703 DPRINTK("direction: write\n");
1706 qc->tf.command = ATA_CMD_PACKET;
1708 /* no data, or PIO data xfer */
1709 if (using_pio || nodata) {
1711 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
1713 qc->tf.protocol = ATA_PROT_ATAPI;
1714 qc->tf.lbam = (8 * 1024) & 0xff;
1715 qc->tf.lbah = (8 * 1024) >> 8;
1720 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
1721 qc->tf.feature |= ATAPI_PKT_DMA;
1723 #ifdef ATAPI_ENABLE_DMADIR
1724 /* some SATA bridges need us to indicate data xfer direction */
1725 if (cmd->sc_data_direction != DMA_TO_DEVICE)
1726 qc->tf.feature |= ATAPI_DMADIR;
1730 qc->nbytes = cmd->bufflen;
1736 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
1737 * @ap: ATA port to which the device is attached
1738 * @scsidev: SCSI device from which we derive the ATA device
1740 * Given various information provided in struct scsi_cmnd,
1741 * map that onto an ATA bus, and using that mapping
1742 * determine which ata_device is associated with the
1743 * SCSI command to be sent.
1746 * spin_lock_irqsave(host_set lock)
1749 * Associated ATA device, or %NULL if not found.
1752 static struct ata_device *
1753 ata_scsi_find_dev(struct ata_port *ap, struct scsi_device *scsidev)
1755 struct ata_device *dev;
1757 /* skip commands not addressed to targets we simulate */
1758 if (likely(scsidev->id < ATA_MAX_DEVICES))
1759 dev = &ap->device[scsidev->id];
1763 if (unlikely((scsidev->channel != 0) ||
1764 (scsidev->lun != 0)))
1767 if (unlikely(!ata_dev_present(dev)))
1770 if (!atapi_enabled) {
1771 if (unlikely(dev->class == ATA_DEV_ATAPI))
1779 * ata_get_xlat_func - check if SCSI to ATA translation is possible
1781 * @cmd: SCSI command opcode to consider
1783 * Look up the SCSI command given, and determine whether the
1784 * SCSI command is to be translated or simulated.
1787 * Pointer to translation function if possible, %NULL if not.
1790 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
1800 return ata_scsi_rw_xlat;
1802 case SYNCHRONIZE_CACHE:
1803 if (ata_try_flush_cache(dev))
1804 return ata_scsi_flush_xlat;
1809 return ata_scsi_verify_xlat;
1811 return ata_scsi_start_stop_xlat;
1818 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
1819 * @ap: ATA port to which the command was being sent
1820 * @cmd: SCSI command to dump
1822 * Prints the contents of a SCSI command via printk().
1825 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
1826 struct scsi_cmnd *cmd)
1829 struct scsi_device *scsidev = cmd->device;
1830 u8 *scsicmd = cmd->cmnd;
1832 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
1834 scsidev->channel, scsidev->id, scsidev->lun,
1835 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
1836 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
1842 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
1843 * @cmd: SCSI command to be sent
1844 * @done: Completion function, called when command is complete
1846 * In some cases, this function translates SCSI commands into
1847 * ATA taskfiles, and queues the taskfiles to be sent to
1848 * hardware. In other cases, this function simulates a
1849 * SCSI device by evaluating and responding to certain
1850 * SCSI commands. This creates the overall effect of
1851 * ATA and ATAPI devices appearing as SCSI devices.
1854 * Releases scsi-layer-held lock, and obtains host_set lock.
1860 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
1862 struct ata_port *ap;
1863 struct ata_device *dev;
1864 struct scsi_device *scsidev = cmd->device;
1866 ap = (struct ata_port *) &scsidev->host->hostdata[0];
1868 ata_scsi_dump_cdb(ap, cmd);
1870 dev = ata_scsi_find_dev(ap, scsidev);
1871 if (unlikely(!dev)) {
1872 cmd->result = (DID_BAD_TARGET << 16);
1877 if (dev->class == ATA_DEV_ATA) {
1878 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
1882 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
1884 ata_scsi_simulate(dev->id, cmd, done);
1886 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
1893 * ata_scsi_simulate - simulate SCSI command on ATA device
1894 * @id: current IDENTIFY data for target device.
1895 * @cmd: SCSI command being sent to device.
1896 * @done: SCSI command completion function.
1898 * Interprets and directly executes a select list of SCSI commands
1899 * that can be handled internally.
1902 * spin_lock_irqsave(host_set lock)
1905 void ata_scsi_simulate(u16 *id,
1906 struct scsi_cmnd *cmd,
1907 void (*done)(struct scsi_cmnd *))
1909 struct ata_scsi_args args;
1910 u8 *scsicmd = cmd->cmnd;
1916 switch(scsicmd[0]) {
1917 /* no-op's, complete with success */
1918 case SYNCHRONIZE_CACHE:
1922 case TEST_UNIT_READY:
1923 case FORMAT_UNIT: /* FIXME: correct? */
1924 case SEND_DIAGNOSTIC: /* FIXME: correct? */
1925 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
1929 if (scsicmd[1] & 2) /* is CmdDt set? */
1930 ata_scsi_invalid_field(cmd, done);
1931 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
1932 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
1933 else if (scsicmd[2] == 0x00)
1934 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
1935 else if (scsicmd[2] == 0x80)
1936 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
1937 else if (scsicmd[2] == 0x83)
1938 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
1940 ata_scsi_invalid_field(cmd, done);
1945 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
1948 case MODE_SELECT: /* unconditionally return */
1949 case MODE_SELECT_10: /* bad-field-in-cdb */
1950 ata_scsi_invalid_field(cmd, done);
1954 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1957 case SERVICE_ACTION_IN:
1958 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
1959 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1961 ata_scsi_invalid_field(cmd, done);
1965 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
1968 /* mandantory commands we haven't implemented yet */
1971 /* all other commands */
1973 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
1974 /* "Invalid command operation code" */
1980 void ata_scsi_scan_host(struct ata_port *ap)
1982 struct ata_device *dev;
1985 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1988 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1989 dev = &ap->device[i];
1991 if (ata_dev_present(dev))
1992 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);