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 <linux/hdreg.h>
44 #include <asm/uaccess.h>
48 #define SECTOR_SIZE 512
50 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
51 static struct ata_device *
52 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
55 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
56 void (*done)(struct scsi_cmnd *))
58 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
59 /* "Invalid field in cbd" */
64 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
65 * @sdev: SCSI device for which BIOS geometry is to be determined
66 * @bdev: block device associated with @sdev
67 * @capacity: capacity of SCSI device
68 * @geom: location to which geometry will be output
70 * Generic bios head/sector/cylinder calculator
71 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
72 * mapping. Some situations may arise where the disk is not
73 * bootable if this is not used.
76 * Defined by the SCSI layer. We don't really care.
81 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
82 sector_t capacity, int geom[])
86 sector_div(capacity, 255*63);
93 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
94 * @dev: Device to whom we are issuing command
95 * @arg: User provided data for issuing command
98 * Defined by the SCSI layer. We don't really care.
101 * Zero on success, negative errno on error.
104 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
107 u8 scsi_cmd[MAX_COMMAND_SIZE];
108 u8 args[4], *argbuf = NULL;
110 struct scsi_request *sreq;
112 if (NULL == (void *)arg)
115 if (copy_from_user(args, arg, sizeof(args)))
118 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
122 memset(scsi_cmd, 0, sizeof(scsi_cmd));
125 argsize = SECTOR_SIZE * args[3];
126 argbuf = kmalloc(argsize, GFP_KERNEL);
127 if (argbuf == NULL) {
132 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
133 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
134 block count in sector count field */
135 sreq->sr_data_direction = DMA_FROM_DEVICE;
137 scsi_cmd[1] = (3 << 1); /* Non-data */
138 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
139 sreq->sr_data_direction = DMA_NONE;
142 scsi_cmd[0] = ATA_16;
144 scsi_cmd[4] = args[2];
145 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
146 scsi_cmd[6] = args[3];
147 scsi_cmd[8] = args[1];
151 scsi_cmd[6] = args[1];
153 scsi_cmd[14] = args[0];
155 /* Good values for timeout and retries? Values below
156 from scsi_ioctl_send_command() for default case... */
157 scsi_wait_req(sreq, scsi_cmd, argbuf, argsize, (10*HZ), 5);
159 if (sreq->sr_result) {
164 /* Need code to retrieve data from check condition? */
167 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
170 scsi_release_request(sreq);
179 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
180 * @dev: Device to whom we are issuing command
181 * @arg: User provided data for issuing command
184 * Defined by the SCSI layer. We don't really care.
187 * Zero on success, negative errno on error.
189 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
192 u8 scsi_cmd[MAX_COMMAND_SIZE];
194 struct scsi_request *sreq;
196 if (NULL == (void *)arg)
199 if (copy_from_user(args, arg, sizeof(args)))
202 memset(scsi_cmd, 0, sizeof(scsi_cmd));
203 scsi_cmd[0] = ATA_16;
204 scsi_cmd[1] = (3 << 1); /* Non-data */
205 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
206 scsi_cmd[4] = args[1];
207 scsi_cmd[6] = args[2];
208 scsi_cmd[8] = args[3];
209 scsi_cmd[10] = args[4];
210 scsi_cmd[12] = args[5];
211 scsi_cmd[14] = args[0];
213 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
219 sreq->sr_data_direction = DMA_NONE;
220 /* Good values for timeout and retries? Values below
221 from scsi_ioctl_send_command() for default case... */
222 scsi_wait_req(sreq, scsi_cmd, NULL, 0, (10*HZ), 5);
224 if (sreq->sr_result) {
229 /* Need code to retrieve data from check condition? */
232 scsi_release_request(sreq);
236 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
239 struct ata_device *dev;
240 int val = -EINVAL, rc = -EINVAL;
242 ap = (struct ata_port *) &scsidev->host->hostdata[0];
246 dev = ata_scsi_find_dev(ap, scsidev);
253 case ATA_IOC_GET_IO32:
255 if (copy_to_user(arg, &val, 1))
259 case ATA_IOC_SET_IO32:
260 val = (unsigned long) arg;
266 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
268 return ata_cmd_ioctl(scsidev, arg);
270 case HDIO_DRIVE_TASK:
271 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
273 return ata_task_ioctl(scsidev, arg);
285 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
286 * @ap: ATA port to which the new command is attached
287 * @dev: ATA device to which the new command is attached
288 * @cmd: SCSI command that originated this ATA command
289 * @done: SCSI command completion function
291 * Obtain a reference to an unused ata_queued_cmd structure,
292 * which is the basic libata structure representing a single
293 * ATA command sent to the hardware.
295 * If a command was available, fill in the SCSI-specific
296 * portions of the structure with information on the
300 * spin_lock_irqsave(host_set lock)
303 * Command allocated, or %NULL if none available.
305 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
306 struct ata_device *dev,
307 struct scsi_cmnd *cmd,
308 void (*done)(struct scsi_cmnd *))
310 struct ata_queued_cmd *qc;
312 qc = ata_qc_new_init(ap, dev);
318 qc->sg = (struct scatterlist *) cmd->request_buffer;
319 qc->n_elem = cmd->use_sg;
325 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
333 * ata_dump_status - user friendly display of error info
334 * @id: id of the port in question
335 * @tf: ptr to filled out taskfile
337 * Decode and dump the ATA error/status registers for the user so
338 * that they have some idea what really happened at the non
339 * make-believe layer.
342 * inherited from caller
344 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
346 u8 stat = tf->command, err = tf->feature;
348 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
349 if (stat & ATA_BUSY) {
350 printk("Busy }\n"); /* Data is not valid in this case */
352 if (stat & 0x40) printk("DriveReady ");
353 if (stat & 0x20) printk("DeviceFault ");
354 if (stat & 0x10) printk("SeekComplete ");
355 if (stat & 0x08) printk("DataRequest ");
356 if (stat & 0x04) printk("CorrectedError ");
357 if (stat & 0x02) printk("Index ");
358 if (stat & 0x01) printk("Error ");
362 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
363 if (err & 0x04) printk("DriveStatusError ");
365 if (err & 0x04) printk("BadCRC ");
366 else printk("Sector ");
368 if (err & 0x40) printk("UncorrectableError ");
369 if (err & 0x10) printk("SectorIdNotFound ");
370 if (err & 0x02) printk("TrackZeroNotFound ");
371 if (err & 0x01) printk("AddrMarkNotFound ");
378 * ata_to_sense_error - convert ATA error to SCSI error
379 * @drv_stat: value contained in ATA status register
380 * @drv_err: value contained in ATA error register
381 * @sk: the sense key we'll fill out
382 * @asc: the additional sense code we'll fill out
383 * @ascq: the additional sense code qualifier we'll fill out
385 * Converts an ATA error into a SCSI error. Fill out pointers to
386 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
387 * format sense blocks.
390 * spin_lock_irqsave(host_set lock)
392 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
397 /* Based on the 3ware driver translation table */
398 static unsigned char sense_table[][4] = {
400 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
402 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
404 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
405 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
406 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
407 /* MC|ID|ABRT|TRK0|MARK */
408 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
410 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
411 /* Bad address mark */
412 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
414 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
416 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
417 /* Media change request */
418 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
420 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
422 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
424 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
425 /* BBD - block marked bad */
426 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
427 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
429 static unsigned char stat_table[][4] = {
430 /* Must be first because BUSY means no other bits valid */
431 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
432 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
433 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
434 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
435 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
439 * Is this an error we can process/parse
441 if (drv_stat & ATA_BUSY) {
442 drv_err = 0; /* Ignore the err bits, they're invalid */
446 /* Look for drv_err */
447 for (i = 0; sense_table[i][0] != 0xFF; i++) {
448 /* Look for best matches first */
449 if ((sense_table[i][0] & drv_err) ==
451 *sk = sense_table[i][1];
452 *asc = sense_table[i][2];
453 *ascq = sense_table[i][3];
457 /* No immediate match */
458 printk(KERN_WARNING "ata%u: no sense translation for "
459 "error 0x%02x\n", id, drv_err);
462 /* Fall back to interpreting status bits */
463 for (i = 0; stat_table[i][0] != 0xFF; i++) {
464 if (stat_table[i][0] & drv_stat) {
465 *sk = stat_table[i][1];
466 *asc = stat_table[i][2];
467 *ascq = stat_table[i][3];
471 /* No error? Undecoded? */
472 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
475 /* For our last chance pick, use medium read error because
476 * it's much more common than an ATA drive telling you a write
480 *asc = 0x11; /* "unrecovered read error" */
481 *ascq = 0x04; /* "auto-reallocation failed" */
484 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
485 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
491 * ata_gen_ata_desc_sense - Generate check condition sense block.
492 * @qc: Command that completed.
494 * This function is specific to the ATA descriptor format sense
495 * block specified for the ATA pass through commands. Regardless
496 * of whether the command errored or not, return a sense
497 * block. Copy all controller registers into the sense
498 * block. Clear sense key, ASC & ASCQ if there is no error.
501 * spin_lock_irqsave(host_set lock)
503 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
505 struct scsi_cmnd *cmd = qc->scsicmd;
506 struct ata_taskfile *tf = &qc->tf;
507 unsigned char *sb = cmd->sense_buffer;
508 unsigned char *desc = sb + 8;
510 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
512 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
515 * Read the controller registers.
517 assert(NULL != qc->ap->ops->tf_read);
518 qc->ap->ops->tf_read(qc->ap, tf);
521 * Use ata_to_sense_error() to map status register bits
522 * onto sense key, asc & ascq.
524 if (unlikely(tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ))) {
525 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
526 &sb[1], &sb[2], &sb[3]);
531 * Sense data is current and format is descriptor.
538 * Set length of additional sense data.
539 * Since we only populate descriptor 0, the total
540 * length is the same (fixed) length as descriptor 0.
542 desc[1] = sb[7] = 14;
545 * Copy registers into sense buffer.
548 desc[3] = tf->feature; /* == error reg */
553 desc[12] = tf->device;
554 desc[13] = tf->command; /* == status reg */
557 * Fill in Extend bit, and the high order bytes
560 if (tf->flags & ATA_TFLAG_LBA48) {
562 desc[4] = tf->hob_nsect;
563 desc[6] = tf->hob_lbal;
564 desc[8] = tf->hob_lbam;
565 desc[10] = tf->hob_lbah;
570 * ata_gen_fixed_sense - generate a SCSI fixed sense block
571 * @qc: Command that we are erroring out
573 * Leverage ata_to_sense_error() to give us the codes. Fit our
574 * LBA in here if there's room.
577 * inherited from caller
579 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
581 struct scsi_cmnd *cmd = qc->scsicmd;
582 struct ata_taskfile *tf = &qc->tf;
583 unsigned char *sb = cmd->sense_buffer;
585 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
587 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
590 * Read the controller registers.
592 assert(NULL != qc->ap->ops->tf_read);
593 qc->ap->ops->tf_read(qc->ap, tf);
596 * Use ata_to_sense_error() to map status register bits
597 * onto sense key, asc & ascq.
599 if (unlikely(tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ))) {
600 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
601 &sb[2], &sb[12], &sb[13]);
608 if (tf->flags & ATA_TFLAG_LBA && !(tf->flags & ATA_TFLAG_LBA48)) {
609 /* A small (28b) LBA will fit in the 32b info field */
610 sb[0] |= 0x80; /* set valid bit */
611 sb[3] = tf->device & 0x0f;
619 * ata_scsi_slave_config - Set SCSI device attributes
620 * @sdev: SCSI device to examine
622 * This is called before we actually start reading
623 * and writing to the device, to configure certain
624 * SCSI mid-layer behaviors.
627 * Defined by SCSI layer. We don't really care.
630 int ata_scsi_slave_config(struct scsi_device *sdev)
632 sdev->use_10_for_rw = 1;
633 sdev->use_10_for_ms = 1;
635 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
637 if (sdev->id < ATA_MAX_DEVICES) {
639 struct ata_device *dev;
641 ap = (struct ata_port *) &sdev->host->hostdata[0];
642 dev = &ap->device[sdev->id];
644 /* TODO: 1024 is an arbitrary number, not the
645 * hardware maximum. This should be increased to
646 * 65534 when Jens Axboe's patch for dynamically
647 * determining max_sectors is merged.
649 if ((dev->flags & ATA_DFLAG_LBA48) &&
650 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
652 * do not overwrite sdev->host->max_sectors, since
653 * other drives on this host may not support LBA48
655 blk_queue_max_sectors(sdev->request_queue, 2048);
659 return 0; /* scsi layer doesn't check return value, sigh */
663 * ata_scsi_error - SCSI layer error handler callback
664 * @host: SCSI host on which error occurred
666 * Handles SCSI-layer-thrown error events.
669 * Inherited from SCSI layer (none, can sleep)
675 int ata_scsi_error(struct Scsi_Host *host)
681 ap = (struct ata_port *) &host->hostdata[0];
682 ap->ops->eng_timeout(ap);
684 /* TODO: this is per-command; when queueing is supported
685 * this code will either change or move to a more
689 INIT_LIST_HEAD(&host->eh_cmd_q);
696 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
697 * @qc: Storage for translated ATA taskfile
698 * @scsicmd: SCSI command to translate
700 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
701 * (to start). Perhaps these commands should be preceded by
702 * CHECK POWER MODE to see what power mode the device is already in.
703 * [See SAT revision 5 at www.t10.org]
706 * spin_lock_irqsave(host_set lock)
709 * Zero on success, non-zero on error.
712 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
715 struct ata_taskfile *tf = &qc->tf;
717 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
718 tf->protocol = ATA_PROT_NODATA;
719 if (scsicmd[1] & 0x1) {
720 ; /* ignore IMMED bit, violates sat-r05 */
722 if (scsicmd[4] & 0x2)
723 goto invalid_fld; /* LOEJ bit set not supported */
724 if (((scsicmd[4] >> 4) & 0xf) != 0)
725 goto invalid_fld; /* power conditions not supported */
726 if (scsicmd[4] & 0x1) {
727 tf->nsect = 1; /* 1 sector, lba=0 */
729 if (qc->dev->flags & ATA_DFLAG_LBA) {
730 qc->tf.flags |= ATA_TFLAG_LBA;
735 tf->device |= ATA_LBA;
738 tf->lbal = 0x1; /* sect */
739 tf->lbam = 0x0; /* cyl low */
740 tf->lbah = 0x0; /* cyl high */
743 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
745 tf->nsect = 0; /* time period value (0 implies now) */
746 tf->command = ATA_CMD_STANDBY;
747 /* Consider: ATA STANDBY IMMEDIATE command */
750 * Standby and Idle condition timers could be implemented but that
751 * would require libata to implement the Power condition mode page
752 * and allow the user to change it. Changing mode pages requires
753 * MODE SELECT to be implemented.
759 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
760 /* "Invalid field in cbd" */
766 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
767 * @qc: Storage for translated ATA taskfile
768 * @scsicmd: SCSI command to translate (ignored)
770 * Sets up an ATA taskfile to issue FLUSH CACHE or
774 * spin_lock_irqsave(host_set lock)
777 * Zero on success, non-zero on error.
780 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
782 struct ata_taskfile *tf = &qc->tf;
784 tf->flags |= ATA_TFLAG_DEVICE;
785 tf->protocol = ATA_PROT_NODATA;
787 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
788 (ata_id_has_flush_ext(qc->dev->id)))
789 tf->command = ATA_CMD_FLUSH_EXT;
791 tf->command = ATA_CMD_FLUSH;
797 * scsi_6_lba_len - Get LBA and transfer length
798 * @scsicmd: SCSI command to translate
800 * Calculate LBA and transfer length for 6-byte commands.
804 * @plen: the transfer length
807 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
812 VPRINTK("six-byte command\n");
814 lba |= ((u64)scsicmd[2]) << 8;
815 lba |= ((u64)scsicmd[3]);
817 len |= ((u32)scsicmd[4]);
824 * scsi_10_lba_len - Get LBA and transfer length
825 * @scsicmd: SCSI command to translate
827 * Calculate LBA and transfer length for 10-byte commands.
831 * @plen: the transfer length
834 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
839 VPRINTK("ten-byte command\n");
841 lba |= ((u64)scsicmd[2]) << 24;
842 lba |= ((u64)scsicmd[3]) << 16;
843 lba |= ((u64)scsicmd[4]) << 8;
844 lba |= ((u64)scsicmd[5]);
846 len |= ((u32)scsicmd[7]) << 8;
847 len |= ((u32)scsicmd[8]);
854 * scsi_16_lba_len - Get LBA and transfer length
855 * @scsicmd: SCSI command to translate
857 * Calculate LBA and transfer length for 16-byte commands.
861 * @plen: the transfer length
864 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
869 VPRINTK("sixteen-byte command\n");
871 lba |= ((u64)scsicmd[2]) << 56;
872 lba |= ((u64)scsicmd[3]) << 48;
873 lba |= ((u64)scsicmd[4]) << 40;
874 lba |= ((u64)scsicmd[5]) << 32;
875 lba |= ((u64)scsicmd[6]) << 24;
876 lba |= ((u64)scsicmd[7]) << 16;
877 lba |= ((u64)scsicmd[8]) << 8;
878 lba |= ((u64)scsicmd[9]);
880 len |= ((u32)scsicmd[10]) << 24;
881 len |= ((u32)scsicmd[11]) << 16;
882 len |= ((u32)scsicmd[12]) << 8;
883 len |= ((u32)scsicmd[13]);
890 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
891 * @qc: Storage for translated ATA taskfile
892 * @scsicmd: SCSI command to translate
894 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
897 * spin_lock_irqsave(host_set lock)
900 * Zero on success, non-zero on error.
903 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
905 struct ata_taskfile *tf = &qc->tf;
906 struct ata_device *dev = qc->dev;
907 u64 dev_sectors = qc->dev->n_sectors;
911 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
912 tf->protocol = ATA_PROT_NODATA;
914 if (scsicmd[0] == VERIFY)
915 scsi_10_lba_len(scsicmd, &block, &n_block);
916 else if (scsicmd[0] == VERIFY_16)
917 scsi_16_lba_len(scsicmd, &block, &n_block);
923 if (block >= dev_sectors)
925 if ((block + n_block) > dev_sectors)
928 if (dev->flags & ATA_DFLAG_LBA) {
929 tf->flags |= ATA_TFLAG_LBA;
931 if (dev->flags & ATA_DFLAG_LBA48) {
932 if (n_block > (64 * 1024))
936 tf->flags |= ATA_TFLAG_LBA48;
937 tf->command = ATA_CMD_VERIFY_EXT;
939 tf->hob_nsect = (n_block >> 8) & 0xff;
941 tf->hob_lbah = (block >> 40) & 0xff;
942 tf->hob_lbam = (block >> 32) & 0xff;
943 tf->hob_lbal = (block >> 24) & 0xff;
949 tf->command = ATA_CMD_VERIFY;
951 tf->device |= (block >> 24) & 0xf;
954 tf->nsect = n_block & 0xff;
956 tf->lbah = (block >> 16) & 0xff;
957 tf->lbam = (block >> 8) & 0xff;
958 tf->lbal = block & 0xff;
960 tf->device |= ATA_LBA;
963 u32 sect, head, cyl, track;
968 /* Convert LBA to CHS */
969 track = (u32)block / dev->sectors;
970 cyl = track / dev->heads;
971 head = track % dev->heads;
972 sect = (u32)block % dev->sectors + 1;
974 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
975 (u32)block, track, cyl, head, sect);
977 /* Check whether the converted CHS can fit.
981 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
984 tf->command = ATA_CMD_VERIFY;
985 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
995 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
996 /* "Invalid field in cbd" */
1000 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1001 /* "Logical Block Address out of range" */
1005 qc->scsicmd->result = SAM_STAT_GOOD;
1010 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1011 * @qc: Storage for translated ATA taskfile
1012 * @scsicmd: SCSI command to translate
1014 * Converts any of six SCSI read/write commands into the
1015 * ATA counterpart, including starting sector (LBA),
1016 * sector count, and taking into account the device's LBA48
1019 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1020 * %WRITE_16 are currently supported.
1023 * spin_lock_irqsave(host_set lock)
1026 * Zero on success, non-zero on error.
1029 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1031 struct ata_taskfile *tf = &qc->tf;
1032 struct ata_device *dev = qc->dev;
1036 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1038 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1039 scsicmd[0] == WRITE_16)
1040 tf->flags |= ATA_TFLAG_WRITE;
1042 /* Calculate the SCSI LBA and transfer length. */
1043 switch (scsicmd[0]) {
1046 scsi_10_lba_len(scsicmd, &block, &n_block);
1050 scsi_6_lba_len(scsicmd, &block, &n_block);
1052 /* for 6-byte r/w commands, transfer length 0
1053 * means 256 blocks of data, not 0 block.
1060 scsi_16_lba_len(scsicmd, &block, &n_block);
1063 DPRINTK("no-byte command\n");
1067 /* Check and compose ATA command */
1069 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1070 * length 0 means transfer 0 block of data.
1071 * However, for ATA R/W commands, sector count 0 means
1072 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1076 if (dev->flags & ATA_DFLAG_LBA) {
1077 tf->flags |= ATA_TFLAG_LBA;
1079 if (dev->flags & ATA_DFLAG_LBA48) {
1080 /* The request -may- be too large for LBA48. */
1081 if ((block >> 48) || (n_block > 65536))
1085 tf->flags |= ATA_TFLAG_LBA48;
1087 tf->hob_nsect = (n_block >> 8) & 0xff;
1089 tf->hob_lbah = (block >> 40) & 0xff;
1090 tf->hob_lbam = (block >> 32) & 0xff;
1091 tf->hob_lbal = (block >> 24) & 0xff;
1095 /* The request -may- be too large for LBA28. */
1096 if ((block >> 28) || (n_block > 256))
1099 tf->device |= (block >> 24) & 0xf;
1102 ata_rwcmd_protocol(qc);
1104 qc->nsect = n_block;
1105 tf->nsect = n_block & 0xff;
1107 tf->lbah = (block >> 16) & 0xff;
1108 tf->lbam = (block >> 8) & 0xff;
1109 tf->lbal = block & 0xff;
1111 tf->device |= ATA_LBA;
1114 u32 sect, head, cyl, track;
1116 /* The request -may- be too large for CHS addressing. */
1117 if ((block >> 28) || (n_block > 256))
1120 ata_rwcmd_protocol(qc);
1122 /* Convert LBA to CHS */
1123 track = (u32)block / dev->sectors;
1124 cyl = track / dev->heads;
1125 head = track % dev->heads;
1126 sect = (u32)block % dev->sectors + 1;
1128 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1129 (u32)block, track, cyl, head, sect);
1131 /* Check whether the converted CHS can fit.
1135 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1138 qc->nsect = n_block;
1139 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1142 tf->lbah = cyl >> 8;
1149 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1150 /* "Invalid field in cbd" */
1154 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1155 /* "Logical Block Address out of range" */
1159 qc->scsicmd->result = SAM_STAT_GOOD;
1163 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1165 struct scsi_cmnd *cmd = qc->scsicmd;
1166 int need_sense = drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ);
1168 /* For ATA pass thru (SAT) commands, generate a sense block if
1169 * user mandated it or if there's an error. Note that if we
1170 * generate because the user forced us to, a check condition
1171 * is generated and the ATA register values are returned
1172 * whether the command completed successfully or not. If there
1173 * was no error, SK, ASC and ASCQ will all be zero.
1175 if (((cmd->cmnd[0] == ATA_16) || (cmd->cmnd[0] == ATA_12)) &&
1176 ((cmd->cmnd[2] & 0x20) || need_sense)) {
1177 ata_gen_ata_desc_sense(qc);
1180 cmd->result = SAM_STAT_GOOD;
1182 /* TODO: decide which descriptor format to use
1183 * for 48b LBA devices and call that here
1184 * instead of the fixed desc, which is only
1185 * good for smaller LBA (and maybe CHS?)
1188 ata_gen_fixed_sense(qc);
1193 /* The ata_gen_..._sense routines fill in tf */
1194 ata_dump_status(qc->ap->id, &qc->tf);
1203 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1204 * @ap: ATA port to which the command is addressed
1205 * @dev: ATA device to which the command is addressed
1206 * @cmd: SCSI command to execute
1207 * @done: SCSI command completion function
1208 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1210 * Our ->queuecommand() function has decided that the SCSI
1211 * command issued can be directly translated into an ATA
1212 * command, rather than handled internally.
1214 * This function sets up an ata_queued_cmd structure for the
1215 * SCSI command, and sends that ata_queued_cmd to the hardware.
1217 * The xlat_func argument (actor) returns 0 if ready to execute
1218 * ATA command, else 1 to finish translation. If 1 is returned
1219 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1220 * to be set reflecting an error condition or clean (early)
1224 * spin_lock_irqsave(host_set lock)
1227 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1228 struct scsi_cmnd *cmd,
1229 void (*done)(struct scsi_cmnd *),
1230 ata_xlat_func_t xlat_func)
1232 struct ata_queued_cmd *qc;
1233 u8 *scsicmd = cmd->cmnd;
1237 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1241 /* data is present; dma-map it */
1242 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1243 cmd->sc_data_direction == DMA_TO_DEVICE) {
1244 if (unlikely(cmd->request_bufflen < 1)) {
1245 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1246 ap->id, dev->devno);
1251 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1253 ata_sg_init_one(qc, cmd->request_buffer,
1254 cmd->request_bufflen);
1256 qc->dma_dir = cmd->sc_data_direction;
1259 qc->complete_fn = ata_scsi_qc_complete;
1261 if (xlat_func(qc, scsicmd))
1264 /* select device, send command to hardware */
1265 if (ata_qc_issue(qc))
1274 DPRINTK("EXIT - early finish (good or error)\n");
1280 cmd->result = (DID_ERROR << 16);
1282 DPRINTK("EXIT - internal\n");
1287 * ata_scsi_rbuf_get - Map response buffer.
1288 * @cmd: SCSI command containing buffer to be mapped.
1289 * @buf_out: Pointer to mapped area.
1291 * Maps buffer contained within SCSI command @cmd.
1294 * spin_lock_irqsave(host_set lock)
1297 * Length of response buffer.
1300 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1303 unsigned int buflen;
1306 struct scatterlist *sg;
1308 sg = (struct scatterlist *) cmd->request_buffer;
1309 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1310 buflen = sg->length;
1312 buf = cmd->request_buffer;
1313 buflen = cmd->request_bufflen;
1321 * ata_scsi_rbuf_put - Unmap response buffer.
1322 * @cmd: SCSI command containing buffer to be unmapped.
1323 * @buf: buffer to unmap
1325 * Unmaps response buffer contained within @cmd.
1328 * spin_lock_irqsave(host_set lock)
1331 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1334 struct scatterlist *sg;
1336 sg = (struct scatterlist *) cmd->request_buffer;
1337 kunmap_atomic(buf - sg->offset, KM_USER0);
1342 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1343 * @args: device IDENTIFY data / SCSI command of interest.
1344 * @actor: Callback hook for desired SCSI command simulator
1346 * Takes care of the hard work of simulating a SCSI command...
1347 * Mapping the response buffer, calling the command's handler,
1348 * and handling the handler's return value. This return value
1349 * indicates whether the handler wishes the SCSI command to be
1350 * completed successfully (0), or not (in which case cmd->result
1351 * and sense buffer are assumed to be set).
1354 * spin_lock_irqsave(host_set lock)
1357 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1358 unsigned int (*actor) (struct ata_scsi_args *args,
1359 u8 *rbuf, unsigned int buflen))
1362 unsigned int buflen, rc;
1363 struct scsi_cmnd *cmd = args->cmd;
1365 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1366 memset(rbuf, 0, buflen);
1367 rc = actor(args, rbuf, buflen);
1368 ata_scsi_rbuf_put(cmd, rbuf);
1371 cmd->result = SAM_STAT_GOOD;
1376 * ata_scsiop_inq_std - Simulate INQUIRY command
1377 * @args: device IDENTIFY data / SCSI command of interest.
1378 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1379 * @buflen: Response buffer length.
1381 * Returns standard device identification data associated
1382 * with non-EVPD INQUIRY command output.
1385 * spin_lock_irqsave(host_set lock)
1388 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1389 unsigned int buflen)
1394 0x5, /* claim SPC-3 version compatibility */
1399 /* set scsi removeable (RMB) bit per ata bit */
1400 if (ata_id_removeable(args->id))
1405 memcpy(rbuf, hdr, sizeof(hdr));
1408 memcpy(&rbuf[8], "ATA ", 8);
1409 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1410 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1411 if (rbuf[32] == 0 || rbuf[32] == ' ')
1412 memcpy(&rbuf[32], "n/a ", 4);
1416 const u8 versions[] = {
1417 0x60, /* SAM-3 (no version claimed) */
1420 0x20, /* SBC-2 (no version claimed) */
1423 0x60 /* SPC-3 (no version claimed) */
1426 memcpy(rbuf + 59, versions, sizeof(versions));
1433 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1434 * @args: device IDENTIFY data / SCSI command of interest.
1435 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1436 * @buflen: Response buffer length.
1438 * Returns list of inquiry EVPD pages available.
1441 * spin_lock_irqsave(host_set lock)
1444 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1445 unsigned int buflen)
1447 const u8 pages[] = {
1448 0x00, /* page 0x00, this page */
1449 0x80, /* page 0x80, unit serial no page */
1450 0x83 /* page 0x83, device ident page */
1452 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1455 memcpy(rbuf + 4, pages, sizeof(pages));
1461 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1462 * @args: device IDENTIFY data / SCSI command of interest.
1463 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1464 * @buflen: Response buffer length.
1466 * Returns ATA device serial number.
1469 * spin_lock_irqsave(host_set lock)
1472 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1473 unsigned int buflen)
1477 0x80, /* this page code */
1479 ATA_SERNO_LEN, /* page len */
1481 memcpy(rbuf, hdr, sizeof(hdr));
1483 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1484 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1485 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1490 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1493 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1494 * @args: device IDENTIFY data / SCSI command of interest.
1495 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1496 * @buflen: Response buffer length.
1498 * Returns device identification. Currently hardcoded to
1499 * return "Linux ATA-SCSI simulator".
1502 * spin_lock_irqsave(host_set lock)
1505 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1506 unsigned int buflen)
1508 rbuf[1] = 0x83; /* this page code */
1509 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1511 /* our one and only identification descriptor (vendor-specific) */
1512 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1513 rbuf[4 + 0] = 2; /* code set: ASCII */
1514 rbuf[4 + 3] = strlen(inq_83_str);
1515 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1522 * ata_scsiop_noop - Command handler that simply returns success.
1523 * @args: device IDENTIFY data / SCSI command of interest.
1524 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1525 * @buflen: Response buffer length.
1527 * No operation. Simply returns success to caller, to indicate
1528 * that the caller should successfully complete this SCSI command.
1531 * spin_lock_irqsave(host_set lock)
1534 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1535 unsigned int buflen)
1542 * ata_msense_push - Push data onto MODE SENSE data output buffer
1543 * @ptr_io: (input/output) Location to store more output data
1544 * @last: End of output data buffer
1545 * @buf: Pointer to BLOB being added to output buffer
1546 * @buflen: Length of BLOB
1548 * Store MODE SENSE data on an output buffer.
1554 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1555 const u8 *buf, unsigned int buflen)
1559 if ((ptr + buflen - 1) > last)
1562 memcpy(ptr, buf, buflen);
1570 * ata_msense_caching - Simulate MODE SENSE caching info page
1571 * @id: device IDENTIFY data
1572 * @ptr_io: (input/output) Location to store more output data
1573 * @last: End of output data buffer
1575 * Generate a caching info page, which conditionally indicates
1576 * write caching to the SCSI layer, depending on device
1583 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1587 0x8, /* page code */
1588 0x12, /* page length */
1589 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 10 zeroes */
1590 0, 0, 0, 0, 0, 0, 0, 0 /* 8 zeroes */
1593 if (ata_id_wcache_enabled(id))
1594 page[2] |= (1 << 2); /* write cache enable */
1595 if (!ata_id_rahead_enabled(id))
1596 page[12] |= (1 << 5); /* disable read ahead */
1598 ata_msense_push(ptr_io, last, page, sizeof(page));
1599 return sizeof(page);
1603 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1604 * @dev: Device associated with this MODE SENSE command
1605 * @ptr_io: (input/output) Location to store more output data
1606 * @last: End of output data buffer
1608 * Generate a generic MODE SENSE control mode page.
1614 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1616 const u8 page[] = {0xa, 0xa, 6, 0, 0, 0, 0, 0, 0xff, 0xff, 0, 30};
1618 /* byte 2: set the descriptor format sense data bit (bit 2)
1619 * since we need to support returning this format for SAT
1620 * commands and any SCSI commands against a 48b LBA device.
1623 ata_msense_push(ptr_io, last, page, sizeof(page));
1624 return sizeof(page);
1628 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1629 * @dev: Device associated with this MODE SENSE command
1630 * @ptr_io: (input/output) Location to store more output data
1631 * @last: End of output data buffer
1633 * Generate a generic MODE SENSE r/w error recovery page.
1639 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1642 0x1, /* page code */
1643 0xa, /* page length */
1644 (1 << 7) | (1 << 6), /* note auto r/w reallocation */
1645 0, 0, 0, 0, 0, 0, 0, 0, 0 /* 9 zeroes */
1648 ata_msense_push(ptr_io, last, page, sizeof(page));
1649 return sizeof(page);
1653 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1654 * @args: device IDENTIFY data / SCSI command of interest.
1655 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1656 * @buflen: Response buffer length.
1658 * Simulate MODE SENSE commands.
1661 * spin_lock_irqsave(host_set lock)
1664 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1665 unsigned int buflen)
1667 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1668 unsigned int page_control, six_byte, output_len;
1672 six_byte = (scsicmd[0] == MODE_SENSE);
1674 /* we only support saved and current values (which we treat
1675 * in the same manner)
1677 page_control = scsicmd[2] >> 6;
1678 switch (page_control) {
1679 case 0: /* current */
1680 break; /* supported */
1682 goto saving_not_supp;
1683 case 1: /* changeable */
1684 case 2: /* defaults */
1694 p = rbuf + output_len;
1695 last = rbuf + buflen - 1;
1697 switch(scsicmd[2] & 0x3f) {
1698 case 0x01: /* r/w error recovery */
1699 output_len += ata_msense_rw_recovery(&p, last);
1702 case 0x08: /* caching */
1703 output_len += ata_msense_caching(args->id, &p, last);
1706 case 0x0a: { /* control mode */
1707 output_len += ata_msense_ctl_mode(&p, last);
1711 case 0x3f: /* all pages */
1712 output_len += ata_msense_rw_recovery(&p, last);
1713 output_len += ata_msense_caching(args->id, &p, last);
1714 output_len += ata_msense_ctl_mode(&p, last);
1717 default: /* invalid page code */
1723 rbuf[0] = output_len;
1726 rbuf[0] = output_len >> 8;
1727 rbuf[1] = output_len;
1733 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1734 /* "Invalid field in cbd" */
1738 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1739 /* "Saving parameters not supported" */
1744 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1745 * @args: device IDENTIFY data / SCSI command of interest.
1746 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1747 * @buflen: Response buffer length.
1749 * Simulate READ CAPACITY commands.
1752 * spin_lock_irqsave(host_set lock)
1755 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1756 unsigned int buflen)
1763 if (ata_id_has_lba(args->id)) {
1764 if (ata_id_has_lba48(args->id))
1765 n_sectors = ata_id_u64(args->id, 100);
1767 n_sectors = ata_id_u32(args->id, 60);
1769 /* CHS default translation */
1770 n_sectors = args->id[1] * args->id[3] * args->id[6];
1772 if (ata_id_current_chs_valid(args->id))
1773 /* CHS current translation */
1774 n_sectors = ata_id_u32(args->id, 57);
1777 n_sectors--; /* ATA TotalUserSectors - 1 */
1779 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1780 if( n_sectors >= 0xffffffffULL )
1781 tmp = 0xffffffff ; /* Return max count on overflow */
1785 /* sector count, 32-bit */
1786 rbuf[0] = tmp >> (8 * 3);
1787 rbuf[1] = tmp >> (8 * 2);
1788 rbuf[2] = tmp >> (8 * 1);
1792 tmp = ATA_SECT_SIZE;
1797 /* sector count, 64-bit */
1798 tmp = n_sectors >> (8 * 4);
1799 rbuf[2] = tmp >> (8 * 3);
1800 rbuf[3] = tmp >> (8 * 2);
1801 rbuf[4] = tmp >> (8 * 1);
1804 rbuf[6] = tmp >> (8 * 3);
1805 rbuf[7] = tmp >> (8 * 2);
1806 rbuf[8] = tmp >> (8 * 1);
1810 tmp = ATA_SECT_SIZE;
1811 rbuf[12] = tmp >> 8;
1819 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1820 * @args: device IDENTIFY data / SCSI command of interest.
1821 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1822 * @buflen: Response buffer length.
1824 * Simulate REPORT LUNS command.
1827 * spin_lock_irqsave(host_set lock)
1830 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1831 unsigned int buflen)
1834 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1840 * ata_scsi_set_sense - Set SCSI sense data and status
1841 * @cmd: SCSI request to be handled
1842 * @sk: SCSI-defined sense key
1843 * @asc: SCSI-defined additional sense code
1844 * @ascq: SCSI-defined additional sense code qualifier
1846 * Helper function that builds a valid fixed format, current
1847 * response code and the given sense key (sk), additional sense
1848 * code (asc) and additional sense code qualifier (ascq) with
1849 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1850 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1856 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1858 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1860 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1861 cmd->sense_buffer[2] = sk;
1862 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1863 cmd->sense_buffer[12] = asc;
1864 cmd->sense_buffer[13] = ascq;
1868 * ata_scsi_badcmd - End a SCSI request with an error
1869 * @cmd: SCSI request to be handled
1870 * @done: SCSI command completion function
1871 * @asc: SCSI-defined additional sense code
1872 * @ascq: SCSI-defined additional sense code qualifier
1874 * Helper function that completes a SCSI command with
1875 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1876 * and the specified additional sense codes.
1879 * spin_lock_irqsave(host_set lock)
1882 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1885 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1890 void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1891 struct scsi_cmnd *cmd)
1893 DECLARE_COMPLETION(wait);
1894 struct ata_queued_cmd *qc;
1895 unsigned long flags;
1898 DPRINTK("ATAPI request sense\n");
1900 qc = ata_qc_new_init(ap, dev);
1903 /* FIXME: is this needed? */
1904 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1906 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1907 qc->dma_dir = DMA_FROM_DEVICE;
1909 memset(&qc->cdb, 0, ap->cdb_len);
1910 qc->cdb[0] = REQUEST_SENSE;
1911 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1913 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1914 qc->tf.command = ATA_CMD_PACKET;
1916 qc->tf.protocol = ATA_PROT_ATAPI;
1917 qc->tf.lbam = (8 * 1024) & 0xff;
1918 qc->tf.lbah = (8 * 1024) >> 8;
1919 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
1921 qc->waiting = &wait;
1922 qc->complete_fn = ata_qc_complete_noop;
1924 spin_lock_irqsave(&ap->host_set->lock, flags);
1925 rc = ata_qc_issue(qc);
1926 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1929 ata_port_disable(ap);
1931 wait_for_completion(&wait);
1936 static int atapi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1938 struct scsi_cmnd *cmd = qc->scsicmd;
1940 VPRINTK("ENTER, drv_stat == 0x%x\n", drv_stat);
1942 if (unlikely(drv_stat & (ATA_BUSY | ATA_DRQ)))
1943 /* FIXME: not quite right; we don't want the
1944 * translation of taskfile registers into
1945 * a sense descriptors, since that's only
1946 * correct for ATA, not ATAPI
1948 ata_gen_ata_desc_sense(qc);
1950 else if (unlikely(drv_stat & ATA_ERR)) {
1951 DPRINTK("request check condition\n");
1953 /* FIXME: command completion with check condition
1954 * but no sense causes the error handler to run,
1955 * which then issues REQUEST SENSE, fills in the sense
1956 * buffer, and completes the command (for the second
1957 * time). We need to issue REQUEST SENSE some other
1958 * way, to avoid completing the command twice.
1960 cmd->result = SAM_STAT_CHECK_CONDITION;
1968 u8 *scsicmd = cmd->cmnd;
1970 if (scsicmd[0] == INQUIRY) {
1972 unsigned int buflen;
1974 buflen = ata_scsi_rbuf_get(cmd, &buf);
1976 /* ATAPI devices typically report zero for their SCSI version,
1977 * and sometimes deviate from the spec WRT response data
1978 * format. If SCSI version is reported as zero like normal,
1979 * then we make the following fixups: 1) Fake MMC-5 version,
1980 * to indicate to the Linux scsi midlayer this is a modern
1981 * device. 2) Ensure response data format / ATAPI information
1982 * are always correct.
1984 /* FIXME: do we ever override EVPD pages and the like, with
1992 ata_scsi_rbuf_put(cmd, buf);
1995 cmd->result = SAM_STAT_GOOD;
2002 * atapi_xlat - Initialize PACKET taskfile
2003 * @qc: command structure to be initialized
2004 * @scsicmd: SCSI CDB associated with this PACKET command
2007 * spin_lock_irqsave(host_set lock)
2010 * Zero on success, non-zero on failure.
2013 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2015 struct scsi_cmnd *cmd = qc->scsicmd;
2016 struct ata_device *dev = qc->dev;
2017 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2018 int nodata = (cmd->sc_data_direction == DMA_NONE);
2021 /* Check whether ATAPI DMA is safe */
2022 if (ata_check_atapi_dma(qc))
2025 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2027 qc->complete_fn = atapi_qc_complete;
2029 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2030 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2031 qc->tf.flags |= ATA_TFLAG_WRITE;
2032 DPRINTK("direction: write\n");
2035 qc->tf.command = ATA_CMD_PACKET;
2037 /* no data, or PIO data xfer */
2038 if (using_pio || nodata) {
2040 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2042 qc->tf.protocol = ATA_PROT_ATAPI;
2043 qc->tf.lbam = (8 * 1024) & 0xff;
2044 qc->tf.lbah = (8 * 1024) >> 8;
2049 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2050 qc->tf.feature |= ATAPI_PKT_DMA;
2052 #ifdef ATAPI_ENABLE_DMADIR
2053 /* some SATA bridges need us to indicate data xfer direction */
2054 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2055 qc->tf.feature |= ATAPI_DMADIR;
2059 qc->nbytes = cmd->bufflen;
2065 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2066 * @ap: ATA port to which the device is attached
2067 * @scsidev: SCSI device from which we derive the ATA device
2069 * Given various information provided in struct scsi_cmnd,
2070 * map that onto an ATA bus, and using that mapping
2071 * determine which ata_device is associated with the
2072 * SCSI command to be sent.
2075 * spin_lock_irqsave(host_set lock)
2078 * Associated ATA device, or %NULL if not found.
2081 static struct ata_device *
2082 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2084 struct ata_device *dev;
2086 /* skip commands not addressed to targets we simulate */
2087 if (likely(scsidev->id < ATA_MAX_DEVICES))
2088 dev = &ap->device[scsidev->id];
2092 if (unlikely((scsidev->channel != 0) ||
2093 (scsidev->lun != 0)))
2096 if (unlikely(!ata_dev_present(dev)))
2099 if (!atapi_enabled) {
2100 if (unlikely(dev->class == ATA_DEV_ATAPI))
2108 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2109 * @byte1: Byte 1 from pass-thru CDB.
2112 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2115 ata_scsi_map_proto(u8 byte1)
2117 switch((byte1 & 0x1e) >> 1) {
2118 case 3: /* Non-data */
2119 return ATA_PROT_NODATA;
2122 return ATA_PROT_DMA;
2124 case 4: /* PIO Data-in */
2125 case 5: /* PIO Data-out */
2127 return ATA_PROT_PIO_MULT;
2129 return ATA_PROT_PIO;
2131 case 10: /* Device Reset */
2132 case 0: /* Hard Reset */
2134 case 2: /* Bus Idle */
2135 case 7: /* Packet */
2136 case 8: /* DMA Queued */
2137 case 9: /* Device Diagnostic */
2138 case 11: /* UDMA Data-in */
2139 case 12: /* UDMA Data-Out */
2140 case 13: /* FPDMA */
2141 default: /* Reserved */
2145 return ATA_PROT_UNKNOWN;
2149 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2150 * @qc: command structure to be initialized
2151 * @cmd: SCSI command to convert
2153 * Handles either 12 or 16-byte versions of the CDB.
2156 * Zero on success, non-zero on failure.
2159 ata_scsi_pass_thru(struct ata_queued_cmd *qc, u8 *scsicmd)
2161 struct ata_taskfile *tf = &(qc->tf);
2162 struct scsi_cmnd *cmd = qc->scsicmd;
2164 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2168 * 12 and 16 byte CDBs use different offsets to
2169 * provide the various register values.
2171 if (scsicmd[0] == ATA_16) {
2173 * 16-byte CDB - may contain extended commands.
2175 * If that is the case, copy the upper byte register values.
2177 if (scsicmd[1] & 0x01) {
2178 tf->hob_feature = scsicmd[3];
2179 tf->hob_nsect = scsicmd[5];
2180 tf->hob_lbal = scsicmd[7];
2181 tf->hob_lbam = scsicmd[9];
2182 tf->hob_lbah = scsicmd[11];
2183 tf->flags |= ATA_TFLAG_LBA48;
2185 tf->flags &= ~ATA_TFLAG_LBA48;
2188 * Always copy low byte, device and command registers.
2190 tf->feature = scsicmd[4];
2191 tf->nsect = scsicmd[6];
2192 tf->lbal = scsicmd[8];
2193 tf->lbam = scsicmd[10];
2194 tf->lbah = scsicmd[12];
2195 tf->device = scsicmd[13];
2196 tf->command = scsicmd[14];
2199 * 12-byte CDB - incapable of extended commands.
2201 tf->flags &= ~ATA_TFLAG_LBA48;
2203 tf->feature = scsicmd[3];
2204 tf->nsect = scsicmd[4];
2205 tf->lbal = scsicmd[5];
2206 tf->lbam = scsicmd[6];
2207 tf->lbah = scsicmd[7];
2208 tf->device = scsicmd[8];
2209 tf->command = scsicmd[9];
2213 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2214 * SET_FEATURES - XFER MODE must be preceded/succeeded
2215 * by an update to hardware-specific registers for each
2216 * controller (i.e. the reason for ->set_piomode(),
2217 * ->set_dmamode(), and ->post_set_mode() hooks).
2219 if ((tf->command == ATA_CMD_SET_FEATURES)
2220 && (tf->feature == SETFEATURES_XFER))
2224 * Set flags so that all registers will be written,
2225 * and pass on write indication (used for PIO/DMA
2228 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2230 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2231 tf->flags |= ATA_TFLAG_WRITE;
2234 * Set transfer length.
2236 * TODO: find out if we need to do more here to
2237 * cover scatter/gather case.
2239 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2245 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2247 * @cmd: SCSI command opcode to consider
2249 * Look up the SCSI command given, and determine whether the
2250 * SCSI command is to be translated or simulated.
2253 * Pointer to translation function if possible, %NULL if not.
2256 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2266 return ata_scsi_rw_xlat;
2268 case SYNCHRONIZE_CACHE:
2269 if (ata_try_flush_cache(dev))
2270 return ata_scsi_flush_xlat;
2275 return ata_scsi_verify_xlat;
2279 return ata_scsi_pass_thru;
2282 return ata_scsi_start_stop_xlat;
2289 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2290 * @ap: ATA port to which the command was being sent
2291 * @cmd: SCSI command to dump
2293 * Prints the contents of a SCSI command via printk().
2296 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2297 struct scsi_cmnd *cmd)
2300 struct scsi_device *scsidev = cmd->device;
2301 u8 *scsicmd = cmd->cmnd;
2303 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2305 scsidev->channel, scsidev->id, scsidev->lun,
2306 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2307 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2313 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2314 * @cmd: SCSI command to be sent
2315 * @done: Completion function, called when command is complete
2317 * In some cases, this function translates SCSI commands into
2318 * ATA taskfiles, and queues the taskfiles to be sent to
2319 * hardware. In other cases, this function simulates a
2320 * SCSI device by evaluating and responding to certain
2321 * SCSI commands. This creates the overall effect of
2322 * ATA and ATAPI devices appearing as SCSI devices.
2325 * Releases scsi-layer-held lock, and obtains host_set lock.
2331 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2333 struct ata_port *ap;
2334 struct ata_device *dev;
2335 struct scsi_device *scsidev = cmd->device;
2337 ap = (struct ata_port *) &scsidev->host->hostdata[0];
2339 ata_scsi_dump_cdb(ap, cmd);
2341 dev = ata_scsi_find_dev(ap, scsidev);
2342 if (unlikely(!dev)) {
2343 cmd->result = (DID_BAD_TARGET << 16);
2348 if (dev->class == ATA_DEV_ATA) {
2349 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2353 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2355 ata_scsi_simulate(dev->id, cmd, done);
2357 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2364 * ata_scsi_simulate - simulate SCSI command on ATA device
2365 * @id: current IDENTIFY data for target device.
2366 * @cmd: SCSI command being sent to device.
2367 * @done: SCSI command completion function.
2369 * Interprets and directly executes a select list of SCSI commands
2370 * that can be handled internally.
2373 * spin_lock_irqsave(host_set lock)
2376 void ata_scsi_simulate(u16 *id,
2377 struct scsi_cmnd *cmd,
2378 void (*done)(struct scsi_cmnd *))
2380 struct ata_scsi_args args;
2381 const u8 *scsicmd = cmd->cmnd;
2387 switch(scsicmd[0]) {
2388 /* no-op's, complete with success */
2389 case SYNCHRONIZE_CACHE:
2393 case TEST_UNIT_READY:
2394 case FORMAT_UNIT: /* FIXME: correct? */
2395 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2396 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2400 if (scsicmd[1] & 2) /* is CmdDt set? */
2401 ata_scsi_invalid_field(cmd, done);
2402 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2403 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2404 else if (scsicmd[2] == 0x00)
2405 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2406 else if (scsicmd[2] == 0x80)
2407 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2408 else if (scsicmd[2] == 0x83)
2409 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2411 ata_scsi_invalid_field(cmd, done);
2416 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2419 case MODE_SELECT: /* unconditionally return */
2420 case MODE_SELECT_10: /* bad-field-in-cdb */
2421 ata_scsi_invalid_field(cmd, done);
2425 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2428 case SERVICE_ACTION_IN:
2429 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2430 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2432 ata_scsi_invalid_field(cmd, done);
2436 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2439 /* mandatory commands we haven't implemented yet */
2442 /* all other commands */
2444 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2445 /* "Invalid command operation code" */
2451 void ata_scsi_scan_host(struct ata_port *ap)
2453 struct ata_device *dev;
2456 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2459 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2460 dev = &ap->device[i];
2462 if (ata_dev_present(dev))
2463 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);