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, const u8 *scsicmd);
48 static struct ata_device *
49 ata_scsi_find_dev(struct ata_port *ap, const 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, const u8 *scsicmd)
490 struct ata_taskfile *tf = &qc->tf;
492 tf->flags |= ATA_TFLAG_DEVICE;
493 tf->protocol = ATA_PROT_NODATA;
495 if ((qc->dev->flags & ATA_DFLAG_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(const 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(const 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(const 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, const u8 *scsicmd)
613 struct ata_taskfile *tf = &qc->tf;
614 struct ata_device *dev = qc->dev;
615 u64 dev_sectors = qc->dev->n_sectors;
619 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
620 tf->protocol = ATA_PROT_NODATA;
622 if (scsicmd[0] == VERIFY)
623 scsi_10_lba_len(scsicmd, &block, &n_block);
624 else if (scsicmd[0] == VERIFY_16)
625 scsi_16_lba_len(scsicmd, &block, &n_block);
631 if (block >= dev_sectors)
633 if ((block + n_block) > dev_sectors)
636 if (dev->flags & ATA_DFLAG_LBA) {
637 tf->flags |= ATA_TFLAG_LBA;
639 if (lba_28_ok(block, n_block)) {
641 tf->command = ATA_CMD_VERIFY;
642 tf->device |= (block >> 24) & 0xf;
643 } else if (lba_48_ok(block, n_block)) {
644 if (!(dev->flags & ATA_DFLAG_LBA48))
648 tf->flags |= ATA_TFLAG_LBA48;
649 tf->command = ATA_CMD_VERIFY_EXT;
651 tf->hob_nsect = (n_block >> 8) & 0xff;
653 tf->hob_lbah = (block >> 40) & 0xff;
654 tf->hob_lbam = (block >> 32) & 0xff;
655 tf->hob_lbal = (block >> 24) & 0xff;
657 /* request too large even for LBA48 */
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 if (!lba_28_ok(block, n_block))
674 /* Convert LBA to CHS */
675 track = (u32)block / dev->sectors;
676 cyl = track / dev->heads;
677 head = track % dev->heads;
678 sect = (u32)block % dev->sectors + 1;
680 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
681 (u32)block, track, cyl, head, sect);
683 /* Check whether the converted CHS can fit.
687 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
690 tf->command = ATA_CMD_VERIFY;
691 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
701 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
702 /* "Invalid field in cbd" */
706 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
707 /* "Logical Block Address out of range" */
711 qc->scsicmd->result = SAM_STAT_GOOD;
716 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
717 * @qc: Storage for translated ATA taskfile
718 * @scsicmd: SCSI command to translate
720 * Converts any of six SCSI read/write commands into the
721 * ATA counterpart, including starting sector (LBA),
722 * sector count, and taking into account the device's LBA48
725 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
726 * %WRITE_16 are currently supported.
729 * spin_lock_irqsave(host_set lock)
732 * Zero on success, non-zero on error.
735 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
737 struct ata_taskfile *tf = &qc->tf;
738 struct ata_device *dev = qc->dev;
742 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
744 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
745 scsicmd[0] == WRITE_16)
746 tf->flags |= ATA_TFLAG_WRITE;
748 /* Calculate the SCSI LBA and transfer length. */
749 switch (scsicmd[0]) {
752 scsi_10_lba_len(scsicmd, &block, &n_block);
756 scsi_6_lba_len(scsicmd, &block, &n_block);
758 /* for 6-byte r/w commands, transfer length 0
759 * means 256 blocks of data, not 0 block.
766 scsi_16_lba_len(scsicmd, &block, &n_block);
769 DPRINTK("no-byte command\n");
773 /* Check and compose ATA command */
775 /* For 10-byte and 16-byte SCSI R/W commands, transfer
776 * length 0 means transfer 0 block of data.
777 * However, for ATA R/W commands, sector count 0 means
778 * 256 or 65536 sectors, not 0 sectors as in SCSI.
782 if (dev->flags & ATA_DFLAG_LBA) {
783 tf->flags |= ATA_TFLAG_LBA;
785 if (lba_28_ok(block, n_block)) {
787 tf->device |= (block >> 24) & 0xf;
788 } else if (lba_48_ok(block, n_block)) {
789 if (!(dev->flags & ATA_DFLAG_LBA48))
793 tf->flags |= ATA_TFLAG_LBA48;
795 tf->hob_nsect = (n_block >> 8) & 0xff;
797 tf->hob_lbah = (block >> 40) & 0xff;
798 tf->hob_lbam = (block >> 32) & 0xff;
799 tf->hob_lbal = (block >> 24) & 0xff;
801 /* request too large even for LBA48 */
804 ata_rwcmd_protocol(qc);
807 tf->nsect = n_block & 0xff;
809 tf->lbah = (block >> 16) & 0xff;
810 tf->lbam = (block >> 8) & 0xff;
811 tf->lbal = block & 0xff;
813 tf->device |= ATA_LBA;
816 u32 sect, head, cyl, track;
818 /* The request -may- be too large for CHS addressing. */
819 if (!lba_28_ok(block, n_block))
822 ata_rwcmd_protocol(qc);
824 /* Convert LBA to CHS */
825 track = (u32)block / dev->sectors;
826 cyl = track / dev->heads;
827 head = track % dev->heads;
828 sect = (u32)block % dev->sectors + 1;
830 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
831 (u32)block, track, cyl, head, sect);
833 /* Check whether the converted CHS can fit.
837 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
841 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
851 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
852 /* "Invalid field in cbd" */
856 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
857 /* "Logical Block Address out of range" */
861 qc->scsicmd->result = SAM_STAT_GOOD;
865 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
867 struct scsi_cmnd *cmd = qc->scsicmd;
869 if (unlikely(drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ)))
870 ata_to_sense_error(qc, drv_stat);
872 cmd->result = SAM_STAT_GOOD;
880 * ata_scsi_translate - Translate then issue SCSI command to ATA device
881 * @ap: ATA port to which the command is addressed
882 * @dev: ATA device to which the command is addressed
883 * @cmd: SCSI command to execute
884 * @done: SCSI command completion function
885 * @xlat_func: Actor which translates @cmd to an ATA taskfile
887 * Our ->queuecommand() function has decided that the SCSI
888 * command issued can be directly translated into an ATA
889 * command, rather than handled internally.
891 * This function sets up an ata_queued_cmd structure for the
892 * SCSI command, and sends that ata_queued_cmd to the hardware.
894 * The xlat_func argument (actor) returns 0 if ready to execute
895 * ATA command, else 1 to finish translation. If 1 is returned
896 * then cmd->result (and possibly cmd->sense_buffer) are assumed
897 * to be set reflecting an error condition or clean (early)
901 * spin_lock_irqsave(host_set lock)
904 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
905 struct scsi_cmnd *cmd,
906 void (*done)(struct scsi_cmnd *),
907 ata_xlat_func_t xlat_func)
909 struct ata_queued_cmd *qc;
910 u8 *scsicmd = cmd->cmnd;
914 qc = ata_scsi_qc_new(ap, dev, cmd, done);
918 /* data is present; dma-map it */
919 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
920 cmd->sc_data_direction == DMA_TO_DEVICE) {
921 if (unlikely(cmd->request_bufflen < 1)) {
922 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
928 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
930 ata_sg_init_one(qc, cmd->request_buffer,
931 cmd->request_bufflen);
933 qc->dma_dir = cmd->sc_data_direction;
936 qc->complete_fn = ata_scsi_qc_complete;
938 if (xlat_func(qc, scsicmd))
941 /* select device, send command to hardware */
942 if (ata_qc_issue(qc))
951 DPRINTK("EXIT - early finish (good or error)\n");
957 cmd->result = (DID_ERROR << 16);
959 DPRINTK("EXIT - internal\n");
964 * ata_scsi_rbuf_get - Map response buffer.
965 * @cmd: SCSI command containing buffer to be mapped.
966 * @buf_out: Pointer to mapped area.
968 * Maps buffer contained within SCSI command @cmd.
971 * spin_lock_irqsave(host_set lock)
974 * Length of response buffer.
977 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
983 struct scatterlist *sg;
985 sg = (struct scatterlist *) cmd->request_buffer;
986 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
989 buf = cmd->request_buffer;
990 buflen = cmd->request_bufflen;
998 * ata_scsi_rbuf_put - Unmap response buffer.
999 * @cmd: SCSI command containing buffer to be unmapped.
1000 * @buf: buffer to unmap
1002 * Unmaps response buffer contained within @cmd.
1005 * spin_lock_irqsave(host_set lock)
1008 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1011 struct scatterlist *sg;
1013 sg = (struct scatterlist *) cmd->request_buffer;
1014 kunmap_atomic(buf - sg->offset, KM_USER0);
1019 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1020 * @args: device IDENTIFY data / SCSI command of interest.
1021 * @actor: Callback hook for desired SCSI command simulator
1023 * Takes care of the hard work of simulating a SCSI command...
1024 * Mapping the response buffer, calling the command's handler,
1025 * and handling the handler's return value. This return value
1026 * indicates whether the handler wishes the SCSI command to be
1027 * completed successfully (0), or not (in which case cmd->result
1028 * and sense buffer are assumed to be set).
1031 * spin_lock_irqsave(host_set lock)
1034 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1035 unsigned int (*actor) (struct ata_scsi_args *args,
1036 u8 *rbuf, unsigned int buflen))
1039 unsigned int buflen, rc;
1040 struct scsi_cmnd *cmd = args->cmd;
1042 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1043 memset(rbuf, 0, buflen);
1044 rc = actor(args, rbuf, buflen);
1045 ata_scsi_rbuf_put(cmd, rbuf);
1048 cmd->result = SAM_STAT_GOOD;
1053 * ata_scsiop_inq_std - Simulate INQUIRY command
1054 * @args: device IDENTIFY data / SCSI command of interest.
1055 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1056 * @buflen: Response buffer length.
1058 * Returns standard device identification data associated
1059 * with non-EVPD INQUIRY command output.
1062 * spin_lock_irqsave(host_set lock)
1065 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1066 unsigned int buflen)
1071 0x5, /* claim SPC-3 version compatibility */
1076 /* set scsi removeable (RMB) bit per ata bit */
1077 if (ata_id_removeable(args->id))
1082 memcpy(rbuf, hdr, sizeof(hdr));
1085 memcpy(&rbuf[8], "ATA ", 8);
1086 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1087 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1088 if (rbuf[32] == 0 || rbuf[32] == ' ')
1089 memcpy(&rbuf[32], "n/a ", 4);
1093 const u8 versions[] = {
1094 0x60, /* SAM-3 (no version claimed) */
1097 0x20, /* SBC-2 (no version claimed) */
1100 0x60 /* SPC-3 (no version claimed) */
1103 memcpy(rbuf + 59, versions, sizeof(versions));
1110 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1111 * @args: device IDENTIFY data / SCSI command of interest.
1112 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1113 * @buflen: Response buffer length.
1115 * Returns list of inquiry EVPD pages available.
1118 * spin_lock_irqsave(host_set lock)
1121 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1122 unsigned int buflen)
1124 const u8 pages[] = {
1125 0x00, /* page 0x00, this page */
1126 0x80, /* page 0x80, unit serial no page */
1127 0x83 /* page 0x83, device ident page */
1129 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1132 memcpy(rbuf + 4, pages, sizeof(pages));
1138 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1139 * @args: device IDENTIFY data / SCSI command of interest.
1140 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1141 * @buflen: Response buffer length.
1143 * Returns ATA device serial number.
1146 * spin_lock_irqsave(host_set lock)
1149 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1150 unsigned int buflen)
1154 0x80, /* this page code */
1156 ATA_SERNO_LEN, /* page len */
1158 memcpy(rbuf, hdr, sizeof(hdr));
1160 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1161 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1162 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1167 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1170 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1171 * @args: device IDENTIFY data / SCSI command of interest.
1172 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1173 * @buflen: Response buffer length.
1175 * Returns device identification. Currently hardcoded to
1176 * return "Linux ATA-SCSI simulator".
1179 * spin_lock_irqsave(host_set lock)
1182 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1183 unsigned int buflen)
1185 rbuf[1] = 0x83; /* this page code */
1186 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1188 /* our one and only identification descriptor (vendor-specific) */
1189 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1190 rbuf[4 + 0] = 2; /* code set: ASCII */
1191 rbuf[4 + 3] = strlen(inq_83_str);
1192 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1199 * ata_scsiop_noop - Command handler that simply returns success.
1200 * @args: device IDENTIFY data / SCSI command of interest.
1201 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1202 * @buflen: Response buffer length.
1204 * No operation. Simply returns success to caller, to indicate
1205 * that the caller should successfully complete this SCSI command.
1208 * spin_lock_irqsave(host_set lock)
1211 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1212 unsigned int buflen)
1219 * ata_msense_push - Push data onto MODE SENSE data output buffer
1220 * @ptr_io: (input/output) Location to store more output data
1221 * @last: End of output data buffer
1222 * @buf: Pointer to BLOB being added to output buffer
1223 * @buflen: Length of BLOB
1225 * Store MODE SENSE data on an output buffer.
1231 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1232 const u8 *buf, unsigned int buflen)
1236 if ((ptr + buflen - 1) > last)
1239 memcpy(ptr, buf, buflen);
1247 * ata_msense_caching - Simulate MODE SENSE caching info page
1248 * @id: device IDENTIFY data
1249 * @ptr_io: (input/output) Location to store more output data
1250 * @last: End of output data buffer
1252 * Generate a caching info page, which conditionally indicates
1253 * write caching to the SCSI layer, depending on device
1260 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1264 0x8, /* page code */
1265 0x12, /* page length */
1266 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 10 zeroes */
1267 0, 0, 0, 0, 0, 0, 0, 0 /* 8 zeroes */
1270 if (ata_id_wcache_enabled(id))
1271 page[2] |= (1 << 2); /* write cache enable */
1272 if (!ata_id_rahead_enabled(id))
1273 page[12] |= (1 << 5); /* disable read ahead */
1275 ata_msense_push(ptr_io, last, page, sizeof(page));
1276 return sizeof(page);
1280 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1281 * @dev: Device associated with this MODE SENSE command
1282 * @ptr_io: (input/output) Location to store more output data
1283 * @last: End of output data buffer
1285 * Generate a generic MODE SENSE control mode page.
1291 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1293 const u8 page[] = {0xa, 0xa, 6, 0, 0, 0, 0, 0, 0xff, 0xff, 0, 30};
1295 /* byte 2: set the descriptor format sense data bit (bit 2)
1296 * since we need to support returning this format for SAT
1297 * commands and any SCSI commands against a 48b LBA device.
1300 ata_msense_push(ptr_io, last, page, sizeof(page));
1301 return sizeof(page);
1305 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1306 * @dev: Device associated with this MODE SENSE command
1307 * @ptr_io: (input/output) Location to store more output data
1308 * @last: End of output data buffer
1310 * Generate a generic MODE SENSE r/w error recovery page.
1316 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1319 0x1, /* page code */
1320 0xa, /* page length */
1321 (1 << 7) | (1 << 6), /* note auto r/w reallocation */
1322 0, 0, 0, 0, 0, 0, 0, 0, 0 /* 9 zeroes */
1325 ata_msense_push(ptr_io, last, page, sizeof(page));
1326 return sizeof(page);
1330 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1331 * @args: device IDENTIFY data / SCSI command of interest.
1332 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1333 * @buflen: Response buffer length.
1335 * Simulate MODE SENSE commands.
1338 * spin_lock_irqsave(host_set lock)
1341 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1342 unsigned int buflen)
1344 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1345 unsigned int page_control, six_byte, output_len;
1349 six_byte = (scsicmd[0] == MODE_SENSE);
1351 /* we only support saved and current values (which we treat
1352 * in the same manner)
1354 page_control = scsicmd[2] >> 6;
1355 switch (page_control) {
1356 case 0: /* current */
1357 break; /* supported */
1359 goto saving_not_supp;
1360 case 1: /* changeable */
1361 case 2: /* defaults */
1371 p = rbuf + output_len;
1372 last = rbuf + buflen - 1;
1374 switch(scsicmd[2] & 0x3f) {
1375 case 0x01: /* r/w error recovery */
1376 output_len += ata_msense_rw_recovery(&p, last);
1379 case 0x08: /* caching */
1380 output_len += ata_msense_caching(args->id, &p, last);
1383 case 0x0a: { /* control mode */
1384 output_len += ata_msense_ctl_mode(&p, last);
1388 case 0x3f: /* all pages */
1389 output_len += ata_msense_rw_recovery(&p, last);
1390 output_len += ata_msense_caching(args->id, &p, last);
1391 output_len += ata_msense_ctl_mode(&p, last);
1394 default: /* invalid page code */
1400 rbuf[0] = output_len;
1403 rbuf[0] = output_len >> 8;
1404 rbuf[1] = output_len;
1410 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1411 /* "Invalid field in cbd" */
1415 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1416 /* "Saving parameters not supported" */
1421 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1422 * @args: device IDENTIFY data / SCSI command of interest.
1423 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1424 * @buflen: Response buffer length.
1426 * Simulate READ CAPACITY commands.
1429 * spin_lock_irqsave(host_set lock)
1432 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1433 unsigned int buflen)
1440 if (ata_id_has_lba(args->id)) {
1441 if (ata_id_has_lba48(args->id))
1442 n_sectors = ata_id_u64(args->id, 100);
1444 n_sectors = ata_id_u32(args->id, 60);
1446 /* CHS default translation */
1447 n_sectors = args->id[1] * args->id[3] * args->id[6];
1449 if (ata_id_current_chs_valid(args->id))
1450 /* CHS current translation */
1451 n_sectors = ata_id_u32(args->id, 57);
1454 n_sectors--; /* ATA TotalUserSectors - 1 */
1456 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1457 if( n_sectors >= 0xffffffffULL )
1458 tmp = 0xffffffff ; /* Return max count on overflow */
1462 /* sector count, 32-bit */
1463 rbuf[0] = tmp >> (8 * 3);
1464 rbuf[1] = tmp >> (8 * 2);
1465 rbuf[2] = tmp >> (8 * 1);
1469 tmp = ATA_SECT_SIZE;
1474 /* sector count, 64-bit */
1475 tmp = n_sectors >> (8 * 4);
1476 rbuf[2] = tmp >> (8 * 3);
1477 rbuf[3] = tmp >> (8 * 2);
1478 rbuf[4] = tmp >> (8 * 1);
1481 rbuf[6] = tmp >> (8 * 3);
1482 rbuf[7] = tmp >> (8 * 2);
1483 rbuf[8] = tmp >> (8 * 1);
1487 tmp = ATA_SECT_SIZE;
1488 rbuf[12] = tmp >> 8;
1496 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1497 * @args: device IDENTIFY data / SCSI command of interest.
1498 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1499 * @buflen: Response buffer length.
1501 * Simulate REPORT LUNS command.
1504 * spin_lock_irqsave(host_set lock)
1507 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1508 unsigned int buflen)
1511 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1517 * ata_scsi_set_sense - Set SCSI sense data and status
1518 * @cmd: SCSI request to be handled
1519 * @sk: SCSI-defined sense key
1520 * @asc: SCSI-defined additional sense code
1521 * @ascq: SCSI-defined additional sense code qualifier
1523 * Helper function that builds a valid fixed format, current
1524 * response code and the given sense key (sk), additional sense
1525 * code (asc) and additional sense code qualifier (ascq) with
1526 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1527 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1533 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1535 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1537 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1538 cmd->sense_buffer[2] = sk;
1539 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1540 cmd->sense_buffer[12] = asc;
1541 cmd->sense_buffer[13] = ascq;
1545 * ata_scsi_badcmd - End a SCSI request with an error
1546 * @cmd: SCSI request to be handled
1547 * @done: SCSI command completion function
1548 * @asc: SCSI-defined additional sense code
1549 * @ascq: SCSI-defined additional sense code qualifier
1551 * Helper function that completes a SCSI command with
1552 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1553 * and the specified additional sense codes.
1556 * spin_lock_irqsave(host_set lock)
1559 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1562 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1567 void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1568 struct scsi_cmnd *cmd)
1570 DECLARE_COMPLETION(wait);
1571 struct ata_queued_cmd *qc;
1572 unsigned long flags;
1575 DPRINTK("ATAPI request sense\n");
1577 qc = ata_qc_new_init(ap, dev);
1580 /* FIXME: is this needed? */
1581 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1583 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1584 qc->dma_dir = DMA_FROM_DEVICE;
1586 memset(&qc->cdb, 0, ap->cdb_len);
1587 qc->cdb[0] = REQUEST_SENSE;
1588 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1590 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1591 qc->tf.command = ATA_CMD_PACKET;
1593 qc->tf.protocol = ATA_PROT_ATAPI;
1594 qc->tf.lbam = (8 * 1024) & 0xff;
1595 qc->tf.lbah = (8 * 1024) >> 8;
1596 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
1598 qc->waiting = &wait;
1599 qc->complete_fn = ata_qc_complete_noop;
1601 spin_lock_irqsave(&ap->host_set->lock, flags);
1602 rc = ata_qc_issue(qc);
1603 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1606 ata_port_disable(ap);
1608 wait_for_completion(&wait);
1613 static int atapi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1615 struct scsi_cmnd *cmd = qc->scsicmd;
1617 VPRINTK("ENTER, drv_stat == 0x%x\n", drv_stat);
1619 if (unlikely(drv_stat & (ATA_BUSY | ATA_DRQ)))
1620 ata_to_sense_error(qc, drv_stat);
1622 else if (unlikely(drv_stat & ATA_ERR)) {
1623 DPRINTK("request check condition\n");
1625 /* FIXME: command completion with check condition
1626 * but no sense causes the error handler to run,
1627 * which then issues REQUEST SENSE, fills in the sense
1628 * buffer, and completes the command (for the second
1629 * time). We need to issue REQUEST SENSE some other
1630 * way, to avoid completing the command twice.
1632 cmd->result = SAM_STAT_CHECK_CONDITION;
1640 u8 *scsicmd = cmd->cmnd;
1642 if (scsicmd[0] == INQUIRY) {
1644 unsigned int buflen;
1646 buflen = ata_scsi_rbuf_get(cmd, &buf);
1648 /* ATAPI devices typically report zero for their SCSI version,
1649 * and sometimes deviate from the spec WRT response data
1650 * format. If SCSI version is reported as zero like normal,
1651 * then we make the following fixups: 1) Fake MMC-5 version,
1652 * to indicate to the Linux scsi midlayer this is a modern
1653 * device. 2) Ensure response data format / ATAPI information
1654 * are always correct.
1656 /* FIXME: do we ever override EVPD pages and the like, with
1664 ata_scsi_rbuf_put(cmd, buf);
1667 cmd->result = SAM_STAT_GOOD;
1674 * atapi_xlat - Initialize PACKET taskfile
1675 * @qc: command structure to be initialized
1676 * @scsicmd: SCSI CDB associated with this PACKET command
1679 * spin_lock_irqsave(host_set lock)
1682 * Zero on success, non-zero on failure.
1685 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1687 struct scsi_cmnd *cmd = qc->scsicmd;
1688 struct ata_device *dev = qc->dev;
1689 int using_pio = (dev->flags & ATA_DFLAG_PIO);
1690 int nodata = (cmd->sc_data_direction == DMA_NONE);
1693 /* Check whether ATAPI DMA is safe */
1694 if (ata_check_atapi_dma(qc))
1697 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
1699 qc->complete_fn = atapi_qc_complete;
1701 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1702 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
1703 qc->tf.flags |= ATA_TFLAG_WRITE;
1704 DPRINTK("direction: write\n");
1707 qc->tf.command = ATA_CMD_PACKET;
1709 /* no data, or PIO data xfer */
1710 if (using_pio || nodata) {
1712 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
1714 qc->tf.protocol = ATA_PROT_ATAPI;
1715 qc->tf.lbam = (8 * 1024) & 0xff;
1716 qc->tf.lbah = (8 * 1024) >> 8;
1721 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
1722 qc->tf.feature |= ATAPI_PKT_DMA;
1724 #ifdef ATAPI_ENABLE_DMADIR
1725 /* some SATA bridges need us to indicate data xfer direction */
1726 if (cmd->sc_data_direction != DMA_TO_DEVICE)
1727 qc->tf.feature |= ATAPI_DMADIR;
1731 qc->nbytes = cmd->bufflen;
1737 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
1738 * @ap: ATA port to which the device is attached
1739 * @scsidev: SCSI device from which we derive the ATA device
1741 * Given various information provided in struct scsi_cmnd,
1742 * map that onto an ATA bus, and using that mapping
1743 * determine which ata_device is associated with the
1744 * SCSI command to be sent.
1747 * spin_lock_irqsave(host_set lock)
1750 * Associated ATA device, or %NULL if not found.
1753 static struct ata_device *
1754 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
1756 struct ata_device *dev;
1758 /* skip commands not addressed to targets we simulate */
1759 if (likely(scsidev->id < ATA_MAX_DEVICES))
1760 dev = &ap->device[scsidev->id];
1764 if (unlikely((scsidev->channel != 0) ||
1765 (scsidev->lun != 0)))
1768 if (unlikely(!ata_dev_present(dev)))
1771 if (!atapi_enabled) {
1772 if (unlikely(dev->class == ATA_DEV_ATAPI))
1780 * ata_get_xlat_func - check if SCSI to ATA translation is possible
1782 * @cmd: SCSI command opcode to consider
1784 * Look up the SCSI command given, and determine whether the
1785 * SCSI command is to be translated or simulated.
1788 * Pointer to translation function if possible, %NULL if not.
1791 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
1801 return ata_scsi_rw_xlat;
1803 case SYNCHRONIZE_CACHE:
1804 if (ata_try_flush_cache(dev))
1805 return ata_scsi_flush_xlat;
1810 return ata_scsi_verify_xlat;
1812 return ata_scsi_start_stop_xlat;
1819 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
1820 * @ap: ATA port to which the command was being sent
1821 * @cmd: SCSI command to dump
1823 * Prints the contents of a SCSI command via printk().
1826 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
1827 struct scsi_cmnd *cmd)
1830 struct scsi_device *scsidev = cmd->device;
1831 u8 *scsicmd = cmd->cmnd;
1833 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
1835 scsidev->channel, scsidev->id, scsidev->lun,
1836 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
1837 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
1843 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
1844 * @cmd: SCSI command to be sent
1845 * @done: Completion function, called when command is complete
1847 * In some cases, this function translates SCSI commands into
1848 * ATA taskfiles, and queues the taskfiles to be sent to
1849 * hardware. In other cases, this function simulates a
1850 * SCSI device by evaluating and responding to certain
1851 * SCSI commands. This creates the overall effect of
1852 * ATA and ATAPI devices appearing as SCSI devices.
1855 * Releases scsi-layer-held lock, and obtains host_set lock.
1861 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
1863 struct ata_port *ap;
1864 struct ata_device *dev;
1865 struct scsi_device *scsidev = cmd->device;
1867 ap = (struct ata_port *) &scsidev->host->hostdata[0];
1869 ata_scsi_dump_cdb(ap, cmd);
1871 dev = ata_scsi_find_dev(ap, scsidev);
1872 if (unlikely(!dev)) {
1873 cmd->result = (DID_BAD_TARGET << 16);
1878 if (dev->class == ATA_DEV_ATA) {
1879 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
1883 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
1885 ata_scsi_simulate(dev->id, cmd, done);
1887 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
1894 * ata_scsi_simulate - simulate SCSI command on ATA device
1895 * @id: current IDENTIFY data for target device.
1896 * @cmd: SCSI command being sent to device.
1897 * @done: SCSI command completion function.
1899 * Interprets and directly executes a select list of SCSI commands
1900 * that can be handled internally.
1903 * spin_lock_irqsave(host_set lock)
1906 void ata_scsi_simulate(u16 *id,
1907 struct scsi_cmnd *cmd,
1908 void (*done)(struct scsi_cmnd *))
1910 struct ata_scsi_args args;
1911 const u8 *scsicmd = cmd->cmnd;
1917 switch(scsicmd[0]) {
1918 /* no-op's, complete with success */
1919 case SYNCHRONIZE_CACHE:
1923 case TEST_UNIT_READY:
1924 case FORMAT_UNIT: /* FIXME: correct? */
1925 case SEND_DIAGNOSTIC: /* FIXME: correct? */
1926 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
1930 if (scsicmd[1] & 2) /* is CmdDt set? */
1931 ata_scsi_invalid_field(cmd, done);
1932 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
1933 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
1934 else if (scsicmd[2] == 0x00)
1935 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
1936 else if (scsicmd[2] == 0x80)
1937 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
1938 else if (scsicmd[2] == 0x83)
1939 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
1941 ata_scsi_invalid_field(cmd, done);
1946 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
1949 case MODE_SELECT: /* unconditionally return */
1950 case MODE_SELECT_10: /* bad-field-in-cdb */
1951 ata_scsi_invalid_field(cmd, done);
1955 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1958 case SERVICE_ACTION_IN:
1959 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
1960 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1962 ata_scsi_invalid_field(cmd, done);
1966 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
1969 /* mandantory commands we haven't implemented yet */
1972 /* all other commands */
1974 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
1975 /* "Invalid command operation code" */
1981 void ata_scsi_scan_host(struct ata_port *ap)
1983 struct ata_device *dev;
1986 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1989 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1990 dev = &ap->device[i];
1992 if (ata_dev_present(dev))
1993 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);