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);
54 #define RW_RECOVERY_MPAGE 0x1
55 #define RW_RECOVERY_MPAGE_LEN 12
56 #define CACHE_MPAGE 0x8
57 #define CACHE_MPAGE_LEN 20
58 #define CONTROL_MPAGE 0xa
59 #define CONTROL_MPAGE_LEN 12
60 #define ALL_MPAGES 0x3f
61 #define ALL_SUB_MPAGES 0xff
64 static const u8 def_rw_recovery_mpage[] = {
66 RW_RECOVERY_MPAGE_LEN - 2,
67 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
68 (1 << 6), /* ARRE (auto read reallocation) */
69 0, /* read retry count */
71 0, /* write retry count */
75 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
78 0, /* contains WCE, needs to be 0 for logic */
79 0, 0, 0, 0, 0, 0, 0, 0, 0,
80 0, /* contains DRA, needs to be 0 for logic */
84 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
86 CONTROL_MPAGE_LEN - 2,
87 2, /* DSENSE=0, GLTSD=1 */
88 0, /* [QAM+QERR may be 1, see 05-359r1] */
89 0, 0, 0, 0, 0xff, 0xff,
90 0, 30 /* extended self test time, see 05-359r1 */
94 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
95 void (*done)(struct scsi_cmnd *))
97 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
98 /* "Invalid field in cbd" */
103 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
104 * @sdev: SCSI device for which BIOS geometry is to be determined
105 * @bdev: block device associated with @sdev
106 * @capacity: capacity of SCSI device
107 * @geom: location to which geometry will be output
109 * Generic bios head/sector/cylinder calculator
110 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
111 * mapping. Some situations may arise where the disk is not
112 * bootable if this is not used.
115 * Defined by the SCSI layer. We don't really care.
120 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
121 sector_t capacity, int geom[])
125 sector_div(capacity, 255*63);
132 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
133 * @dev: Device to whom we are issuing command
134 * @arg: User provided data for issuing command
137 * Defined by the SCSI layer. We don't really care.
140 * Zero on success, negative errno on error.
143 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
146 u8 scsi_cmd[MAX_COMMAND_SIZE];
147 u8 args[4], *argbuf = NULL;
149 struct scsi_request *sreq;
151 if (NULL == (void *)arg)
154 if (copy_from_user(args, arg, sizeof(args)))
157 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
161 memset(scsi_cmd, 0, sizeof(scsi_cmd));
164 argsize = SECTOR_SIZE * args[3];
165 argbuf = kmalloc(argsize, GFP_KERNEL);
166 if (argbuf == NULL) {
171 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
172 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
173 block count in sector count field */
174 sreq->sr_data_direction = DMA_FROM_DEVICE;
176 scsi_cmd[1] = (3 << 1); /* Non-data */
177 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
178 sreq->sr_data_direction = DMA_NONE;
181 scsi_cmd[0] = ATA_16;
183 scsi_cmd[4] = args[2];
184 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
185 scsi_cmd[6] = args[3];
186 scsi_cmd[8] = args[1];
190 scsi_cmd[6] = args[1];
192 scsi_cmd[14] = args[0];
194 /* Good values for timeout and retries? Values below
195 from scsi_ioctl_send_command() for default case... */
196 scsi_wait_req(sreq, scsi_cmd, argbuf, argsize, (10*HZ), 5);
198 if (sreq->sr_result) {
203 /* Need code to retrieve data from check condition? */
206 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
209 scsi_release_request(sreq);
218 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
219 * @dev: Device to whom we are issuing command
220 * @arg: User provided data for issuing command
223 * Defined by the SCSI layer. We don't really care.
226 * Zero on success, negative errno on error.
228 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
231 u8 scsi_cmd[MAX_COMMAND_SIZE];
233 struct scsi_request *sreq;
235 if (NULL == (void *)arg)
238 if (copy_from_user(args, arg, sizeof(args)))
241 memset(scsi_cmd, 0, sizeof(scsi_cmd));
242 scsi_cmd[0] = ATA_16;
243 scsi_cmd[1] = (3 << 1); /* Non-data */
244 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
245 scsi_cmd[4] = args[1];
246 scsi_cmd[6] = args[2];
247 scsi_cmd[8] = args[3];
248 scsi_cmd[10] = args[4];
249 scsi_cmd[12] = args[5];
250 scsi_cmd[14] = args[0];
252 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
258 sreq->sr_data_direction = DMA_NONE;
259 /* Good values for timeout and retries? Values below
260 from scsi_ioctl_send_command() for default case... */
261 scsi_wait_req(sreq, scsi_cmd, NULL, 0, (10*HZ), 5);
263 if (sreq->sr_result) {
268 /* Need code to retrieve data from check condition? */
271 scsi_release_request(sreq);
275 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
278 struct ata_device *dev;
279 int val = -EINVAL, rc = -EINVAL;
281 ap = (struct ata_port *) &scsidev->host->hostdata[0];
285 dev = ata_scsi_find_dev(ap, scsidev);
292 case ATA_IOC_GET_IO32:
294 if (copy_to_user(arg, &val, 1))
298 case ATA_IOC_SET_IO32:
299 val = (unsigned long) arg;
305 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
307 return ata_cmd_ioctl(scsidev, arg);
309 case HDIO_DRIVE_TASK:
310 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
312 return ata_task_ioctl(scsidev, arg);
324 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
325 * @ap: ATA port to which the new command is attached
326 * @dev: ATA device to which the new command is attached
327 * @cmd: SCSI command that originated this ATA command
328 * @done: SCSI command completion function
330 * Obtain a reference to an unused ata_queued_cmd structure,
331 * which is the basic libata structure representing a single
332 * ATA command sent to the hardware.
334 * If a command was available, fill in the SCSI-specific
335 * portions of the structure with information on the
339 * spin_lock_irqsave(host_set lock)
342 * Command allocated, or %NULL if none available.
344 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
345 struct ata_device *dev,
346 struct scsi_cmnd *cmd,
347 void (*done)(struct scsi_cmnd *))
349 struct ata_queued_cmd *qc;
351 qc = ata_qc_new_init(ap, dev);
357 qc->sg = (struct scatterlist *) cmd->request_buffer;
358 qc->n_elem = cmd->use_sg;
364 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
372 * ata_dump_status - user friendly display of error info
373 * @id: id of the port in question
374 * @tf: ptr to filled out taskfile
376 * Decode and dump the ATA error/status registers for the user so
377 * that they have some idea what really happened at the non
378 * make-believe layer.
381 * inherited from caller
383 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
385 u8 stat = tf->command, err = tf->feature;
387 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
388 if (stat & ATA_BUSY) {
389 printk("Busy }\n"); /* Data is not valid in this case */
391 if (stat & 0x40) printk("DriveReady ");
392 if (stat & 0x20) printk("DeviceFault ");
393 if (stat & 0x10) printk("SeekComplete ");
394 if (stat & 0x08) printk("DataRequest ");
395 if (stat & 0x04) printk("CorrectedError ");
396 if (stat & 0x02) printk("Index ");
397 if (stat & 0x01) printk("Error ");
401 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
402 if (err & 0x04) printk("DriveStatusError ");
404 if (err & 0x04) printk("BadCRC ");
405 else printk("Sector ");
407 if (err & 0x40) printk("UncorrectableError ");
408 if (err & 0x10) printk("SectorIdNotFound ");
409 if (err & 0x02) printk("TrackZeroNotFound ");
410 if (err & 0x01) printk("AddrMarkNotFound ");
417 * ata_to_sense_error - convert ATA error to SCSI error
418 * @drv_stat: value contained in ATA status register
419 * @drv_err: value contained in ATA error register
420 * @sk: the sense key we'll fill out
421 * @asc: the additional sense code we'll fill out
422 * @ascq: the additional sense code qualifier we'll fill out
424 * Converts an ATA error into a SCSI error. Fill out pointers to
425 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
426 * format sense blocks.
429 * spin_lock_irqsave(host_set lock)
431 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
436 /* Based on the 3ware driver translation table */
437 static unsigned char sense_table[][4] = {
439 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
441 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
443 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
444 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
445 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
446 /* MC|ID|ABRT|TRK0|MARK */
447 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
449 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
450 /* Bad address mark */
451 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
453 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
455 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
456 /* Media change request */
457 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
459 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
461 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
463 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
464 /* BBD - block marked bad */
465 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
466 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
468 static unsigned char stat_table[][4] = {
469 /* Must be first because BUSY means no other bits valid */
470 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
471 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
472 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
473 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
474 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
478 * Is this an error we can process/parse
480 if (drv_stat & ATA_BUSY) {
481 drv_err = 0; /* Ignore the err bits, they're invalid */
485 /* Look for drv_err */
486 for (i = 0; sense_table[i][0] != 0xFF; i++) {
487 /* Look for best matches first */
488 if ((sense_table[i][0] & drv_err) ==
490 *sk = sense_table[i][1];
491 *asc = sense_table[i][2];
492 *ascq = sense_table[i][3];
496 /* No immediate match */
497 printk(KERN_WARNING "ata%u: no sense translation for "
498 "error 0x%02x\n", id, drv_err);
501 /* Fall back to interpreting status bits */
502 for (i = 0; stat_table[i][0] != 0xFF; i++) {
503 if (stat_table[i][0] & drv_stat) {
504 *sk = stat_table[i][1];
505 *asc = stat_table[i][2];
506 *ascq = stat_table[i][3];
510 /* No error? Undecoded? */
511 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
514 /* For our last chance pick, use medium read error because
515 * it's much more common than an ATA drive telling you a write
519 *asc = 0x11; /* "unrecovered read error" */
520 *ascq = 0x04; /* "auto-reallocation failed" */
523 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
524 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
530 * ata_gen_ata_desc_sense - Generate check condition sense block.
531 * @qc: Command that completed.
533 * This function is specific to the ATA descriptor format sense
534 * block specified for the ATA pass through commands. Regardless
535 * of whether the command errored or not, return a sense
536 * block. Copy all controller registers into the sense
537 * block. Clear sense key, ASC & ASCQ if there is no error.
540 * spin_lock_irqsave(host_set lock)
542 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
544 struct scsi_cmnd *cmd = qc->scsicmd;
545 struct ata_taskfile *tf = &qc->tf;
546 unsigned char *sb = cmd->sense_buffer;
547 unsigned char *desc = sb + 8;
549 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
551 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
554 * Read the controller registers.
556 assert(NULL != qc->ap->ops->tf_read);
557 qc->ap->ops->tf_read(qc->ap, tf);
560 * Use ata_to_sense_error() to map status register bits
561 * onto sense key, asc & ascq.
563 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
564 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
565 &sb[1], &sb[2], &sb[3]);
570 * Sense data is current and format is descriptor.
577 * Set length of additional sense data.
578 * Since we only populate descriptor 0, the total
579 * length is the same (fixed) length as descriptor 0.
581 desc[1] = sb[7] = 14;
584 * Copy registers into sense buffer.
587 desc[3] = tf->feature; /* == error reg */
592 desc[12] = tf->device;
593 desc[13] = tf->command; /* == status reg */
596 * Fill in Extend bit, and the high order bytes
599 if (tf->flags & ATA_TFLAG_LBA48) {
601 desc[4] = tf->hob_nsect;
602 desc[6] = tf->hob_lbal;
603 desc[8] = tf->hob_lbam;
604 desc[10] = tf->hob_lbah;
609 * ata_gen_fixed_sense - generate a SCSI fixed sense block
610 * @qc: Command that we are erroring out
612 * Leverage ata_to_sense_error() to give us the codes. Fit our
613 * LBA in here if there's room.
616 * inherited from caller
618 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
620 struct scsi_cmnd *cmd = qc->scsicmd;
621 struct ata_taskfile *tf = &qc->tf;
622 unsigned char *sb = cmd->sense_buffer;
624 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
626 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
629 * Read the controller registers.
631 assert(NULL != qc->ap->ops->tf_read);
632 qc->ap->ops->tf_read(qc->ap, tf);
635 * Use ata_to_sense_error() to map status register bits
636 * onto sense key, asc & ascq.
638 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
639 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
640 &sb[2], &sb[12], &sb[13]);
647 if (tf->flags & ATA_TFLAG_LBA48) {
648 /* TODO: find solution for LBA48 descriptors */
651 else if (tf->flags & ATA_TFLAG_LBA) {
652 /* A small (28b) LBA will fit in the 32b info field */
653 sb[0] |= 0x80; /* set valid bit */
654 sb[3] = tf->device & 0x0f;
666 * ata_scsi_slave_config - Set SCSI device attributes
667 * @sdev: SCSI device to examine
669 * This is called before we actually start reading
670 * and writing to the device, to configure certain
671 * SCSI mid-layer behaviors.
674 * Defined by SCSI layer. We don't really care.
677 int ata_scsi_slave_config(struct scsi_device *sdev)
679 sdev->use_10_for_rw = 1;
680 sdev->use_10_for_ms = 1;
682 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
684 if (sdev->id < ATA_MAX_DEVICES) {
686 struct ata_device *dev;
688 ap = (struct ata_port *) &sdev->host->hostdata[0];
689 dev = &ap->device[sdev->id];
691 /* TODO: 1024 is an arbitrary number, not the
692 * hardware maximum. This should be increased to
693 * 65534 when Jens Axboe's patch for dynamically
694 * determining max_sectors is merged.
696 if ((dev->flags & ATA_DFLAG_LBA48) &&
697 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
699 * do not overwrite sdev->host->max_sectors, since
700 * other drives on this host may not support LBA48
702 blk_queue_max_sectors(sdev->request_queue, 2048);
706 return 0; /* scsi layer doesn't check return value, sigh */
710 * ata_scsi_error - SCSI layer error handler callback
711 * @host: SCSI host on which error occurred
713 * Handles SCSI-layer-thrown error events.
716 * Inherited from SCSI layer (none, can sleep)
722 int ata_scsi_error(struct Scsi_Host *host)
728 ap = (struct ata_port *) &host->hostdata[0];
729 ap->ops->eng_timeout(ap);
731 /* TODO: this is per-command; when queueing is supported
732 * this code will either change or move to a more
736 INIT_LIST_HEAD(&host->eh_cmd_q);
743 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
744 * @qc: Storage for translated ATA taskfile
745 * @scsicmd: SCSI command to translate
747 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
748 * (to start). Perhaps these commands should be preceded by
749 * CHECK POWER MODE to see what power mode the device is already in.
750 * [See SAT revision 5 at www.t10.org]
753 * spin_lock_irqsave(host_set lock)
756 * Zero on success, non-zero on error.
759 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
762 struct ata_taskfile *tf = &qc->tf;
764 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
765 tf->protocol = ATA_PROT_NODATA;
766 if (scsicmd[1] & 0x1) {
767 ; /* ignore IMMED bit, violates sat-r05 */
769 if (scsicmd[4] & 0x2)
770 goto invalid_fld; /* LOEJ bit set not supported */
771 if (((scsicmd[4] >> 4) & 0xf) != 0)
772 goto invalid_fld; /* power conditions not supported */
773 if (scsicmd[4] & 0x1) {
774 tf->nsect = 1; /* 1 sector, lba=0 */
776 if (qc->dev->flags & ATA_DFLAG_LBA) {
777 qc->tf.flags |= ATA_TFLAG_LBA;
782 tf->device |= ATA_LBA;
785 tf->lbal = 0x1; /* sect */
786 tf->lbam = 0x0; /* cyl low */
787 tf->lbah = 0x0; /* cyl high */
790 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
792 tf->nsect = 0; /* time period value (0 implies now) */
793 tf->command = ATA_CMD_STANDBY;
794 /* Consider: ATA STANDBY IMMEDIATE command */
797 * Standby and Idle condition timers could be implemented but that
798 * would require libata to implement the Power condition mode page
799 * and allow the user to change it. Changing mode pages requires
800 * MODE SELECT to be implemented.
806 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
807 /* "Invalid field in cbd" */
813 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
814 * @qc: Storage for translated ATA taskfile
815 * @scsicmd: SCSI command to translate (ignored)
817 * Sets up an ATA taskfile to issue FLUSH CACHE or
821 * spin_lock_irqsave(host_set lock)
824 * Zero on success, non-zero on error.
827 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
829 struct ata_taskfile *tf = &qc->tf;
831 tf->flags |= ATA_TFLAG_DEVICE;
832 tf->protocol = ATA_PROT_NODATA;
834 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
835 (ata_id_has_flush_ext(qc->dev->id)))
836 tf->command = ATA_CMD_FLUSH_EXT;
838 tf->command = ATA_CMD_FLUSH;
844 * scsi_6_lba_len - Get LBA and transfer length
845 * @scsicmd: SCSI command to translate
847 * Calculate LBA and transfer length for 6-byte commands.
851 * @plen: the transfer length
854 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
859 VPRINTK("six-byte command\n");
861 lba |= ((u64)scsicmd[2]) << 8;
862 lba |= ((u64)scsicmd[3]);
864 len |= ((u32)scsicmd[4]);
871 * scsi_10_lba_len - Get LBA and transfer length
872 * @scsicmd: SCSI command to translate
874 * Calculate LBA and transfer length for 10-byte commands.
878 * @plen: the transfer length
881 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
886 VPRINTK("ten-byte command\n");
888 lba |= ((u64)scsicmd[2]) << 24;
889 lba |= ((u64)scsicmd[3]) << 16;
890 lba |= ((u64)scsicmd[4]) << 8;
891 lba |= ((u64)scsicmd[5]);
893 len |= ((u32)scsicmd[7]) << 8;
894 len |= ((u32)scsicmd[8]);
901 * scsi_16_lba_len - Get LBA and transfer length
902 * @scsicmd: SCSI command to translate
904 * Calculate LBA and transfer length for 16-byte commands.
908 * @plen: the transfer length
911 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
916 VPRINTK("sixteen-byte command\n");
918 lba |= ((u64)scsicmd[2]) << 56;
919 lba |= ((u64)scsicmd[3]) << 48;
920 lba |= ((u64)scsicmd[4]) << 40;
921 lba |= ((u64)scsicmd[5]) << 32;
922 lba |= ((u64)scsicmd[6]) << 24;
923 lba |= ((u64)scsicmd[7]) << 16;
924 lba |= ((u64)scsicmd[8]) << 8;
925 lba |= ((u64)scsicmd[9]);
927 len |= ((u32)scsicmd[10]) << 24;
928 len |= ((u32)scsicmd[11]) << 16;
929 len |= ((u32)scsicmd[12]) << 8;
930 len |= ((u32)scsicmd[13]);
937 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
938 * @qc: Storage for translated ATA taskfile
939 * @scsicmd: SCSI command to translate
941 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
944 * spin_lock_irqsave(host_set lock)
947 * Zero on success, non-zero on error.
950 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
952 struct ata_taskfile *tf = &qc->tf;
953 struct ata_device *dev = qc->dev;
954 u64 dev_sectors = qc->dev->n_sectors;
958 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
959 tf->protocol = ATA_PROT_NODATA;
961 if (scsicmd[0] == VERIFY)
962 scsi_10_lba_len(scsicmd, &block, &n_block);
963 else if (scsicmd[0] == VERIFY_16)
964 scsi_16_lba_len(scsicmd, &block, &n_block);
970 if (block >= dev_sectors)
972 if ((block + n_block) > dev_sectors)
975 if (dev->flags & ATA_DFLAG_LBA) {
976 tf->flags |= ATA_TFLAG_LBA;
978 if (dev->flags & ATA_DFLAG_LBA48) {
979 if (n_block > (64 * 1024))
983 tf->flags |= ATA_TFLAG_LBA48;
984 tf->command = ATA_CMD_VERIFY_EXT;
986 tf->hob_nsect = (n_block >> 8) & 0xff;
988 tf->hob_lbah = (block >> 40) & 0xff;
989 tf->hob_lbam = (block >> 32) & 0xff;
990 tf->hob_lbal = (block >> 24) & 0xff;
996 tf->command = ATA_CMD_VERIFY;
998 tf->device |= (block >> 24) & 0xf;
1001 tf->nsect = n_block & 0xff;
1003 tf->lbah = (block >> 16) & 0xff;
1004 tf->lbam = (block >> 8) & 0xff;
1005 tf->lbal = block & 0xff;
1007 tf->device |= ATA_LBA;
1010 u32 sect, head, cyl, track;
1015 /* Convert LBA to CHS */
1016 track = (u32)block / dev->sectors;
1017 cyl = track / dev->heads;
1018 head = track % dev->heads;
1019 sect = (u32)block % dev->sectors + 1;
1021 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1022 (u32)block, track, cyl, head, sect);
1024 /* Check whether the converted CHS can fit.
1028 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1031 tf->command = ATA_CMD_VERIFY;
1032 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1035 tf->lbah = cyl >> 8;
1042 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1043 /* "Invalid field in cbd" */
1047 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1048 /* "Logical Block Address out of range" */
1052 qc->scsicmd->result = SAM_STAT_GOOD;
1057 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1058 * @qc: Storage for translated ATA taskfile
1059 * @scsicmd: SCSI command to translate
1061 * Converts any of six SCSI read/write commands into the
1062 * ATA counterpart, including starting sector (LBA),
1063 * sector count, and taking into account the device's LBA48
1066 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1067 * %WRITE_16 are currently supported.
1070 * spin_lock_irqsave(host_set lock)
1073 * Zero on success, non-zero on error.
1076 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1078 struct ata_taskfile *tf = &qc->tf;
1079 struct ata_device *dev = qc->dev;
1083 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1085 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1086 scsicmd[0] == WRITE_16)
1087 tf->flags |= ATA_TFLAG_WRITE;
1089 /* Calculate the SCSI LBA and transfer length. */
1090 switch (scsicmd[0]) {
1093 scsi_10_lba_len(scsicmd, &block, &n_block);
1097 scsi_6_lba_len(scsicmd, &block, &n_block);
1099 /* for 6-byte r/w commands, transfer length 0
1100 * means 256 blocks of data, not 0 block.
1107 scsi_16_lba_len(scsicmd, &block, &n_block);
1110 DPRINTK("no-byte command\n");
1114 /* Check and compose ATA command */
1116 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1117 * length 0 means transfer 0 block of data.
1118 * However, for ATA R/W commands, sector count 0 means
1119 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1123 if (dev->flags & ATA_DFLAG_LBA) {
1124 tf->flags |= ATA_TFLAG_LBA;
1126 if (dev->flags & ATA_DFLAG_LBA48) {
1127 /* The request -may- be too large for LBA48. */
1128 if ((block >> 48) || (n_block > 65536))
1132 tf->flags |= ATA_TFLAG_LBA48;
1134 tf->hob_nsect = (n_block >> 8) & 0xff;
1136 tf->hob_lbah = (block >> 40) & 0xff;
1137 tf->hob_lbam = (block >> 32) & 0xff;
1138 tf->hob_lbal = (block >> 24) & 0xff;
1142 /* The request -may- be too large for LBA28. */
1143 if ((block >> 28) || (n_block > 256))
1146 tf->device |= (block >> 24) & 0xf;
1149 ata_rwcmd_protocol(qc);
1151 qc->nsect = n_block;
1152 tf->nsect = n_block & 0xff;
1154 tf->lbah = (block >> 16) & 0xff;
1155 tf->lbam = (block >> 8) & 0xff;
1156 tf->lbal = block & 0xff;
1158 tf->device |= ATA_LBA;
1161 u32 sect, head, cyl, track;
1163 /* The request -may- be too large for CHS addressing. */
1164 if ((block >> 28) || (n_block > 256))
1167 ata_rwcmd_protocol(qc);
1169 /* Convert LBA to CHS */
1170 track = (u32)block / dev->sectors;
1171 cyl = track / dev->heads;
1172 head = track % dev->heads;
1173 sect = (u32)block % dev->sectors + 1;
1175 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1176 (u32)block, track, cyl, head, sect);
1178 /* Check whether the converted CHS can fit.
1182 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1185 qc->nsect = n_block;
1186 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1189 tf->lbah = cyl >> 8;
1196 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1197 /* "Invalid field in cbd" */
1201 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1202 /* "Logical Block Address out of range" */
1206 qc->scsicmd->result = SAM_STAT_GOOD;
1210 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc,
1211 unsigned int err_mask)
1213 struct scsi_cmnd *cmd = qc->scsicmd;
1214 u8 *cdb = cmd->cmnd;
1215 int need_sense = (err_mask != 0);
1217 /* For ATA pass thru (SAT) commands, generate a sense block if
1218 * user mandated it or if there's an error. Note that if we
1219 * generate because the user forced us to, a check condition
1220 * is generated and the ATA register values are returned
1221 * whether the command completed successfully or not. If there
1222 * was no error, SK, ASC and ASCQ will all be zero.
1224 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1225 ((cdb[2] & 0x20) || need_sense)) {
1226 ata_gen_ata_desc_sense(qc);
1229 cmd->result = SAM_STAT_GOOD;
1231 /* TODO: decide which descriptor format to use
1232 * for 48b LBA devices and call that here
1233 * instead of the fixed desc, which is only
1234 * good for smaller LBA (and maybe CHS?)
1237 ata_gen_fixed_sense(qc);
1242 /* The ata_gen_..._sense routines fill in tf */
1243 ata_dump_status(qc->ap->id, &qc->tf);
1252 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1253 * @ap: ATA port to which the command is addressed
1254 * @dev: ATA device to which the command is addressed
1255 * @cmd: SCSI command to execute
1256 * @done: SCSI command completion function
1257 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1259 * Our ->queuecommand() function has decided that the SCSI
1260 * command issued can be directly translated into an ATA
1261 * command, rather than handled internally.
1263 * This function sets up an ata_queued_cmd structure for the
1264 * SCSI command, and sends that ata_queued_cmd to the hardware.
1266 * The xlat_func argument (actor) returns 0 if ready to execute
1267 * ATA command, else 1 to finish translation. If 1 is returned
1268 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1269 * to be set reflecting an error condition or clean (early)
1273 * spin_lock_irqsave(host_set lock)
1276 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1277 struct scsi_cmnd *cmd,
1278 void (*done)(struct scsi_cmnd *),
1279 ata_xlat_func_t xlat_func)
1281 struct ata_queued_cmd *qc;
1282 u8 *scsicmd = cmd->cmnd;
1286 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1290 /* data is present; dma-map it */
1291 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1292 cmd->sc_data_direction == DMA_TO_DEVICE) {
1293 if (unlikely(cmd->request_bufflen < 1)) {
1294 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1295 ap->id, dev->devno);
1300 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1302 ata_sg_init_one(qc, cmd->request_buffer,
1303 cmd->request_bufflen);
1305 qc->dma_dir = cmd->sc_data_direction;
1308 qc->complete_fn = ata_scsi_qc_complete;
1310 if (xlat_func(qc, scsicmd))
1313 /* select device, send command to hardware */
1314 if (ata_qc_issue(qc))
1323 DPRINTK("EXIT - early finish (good or error)\n");
1329 cmd->result = (DID_ERROR << 16);
1331 DPRINTK("EXIT - internal\n");
1336 * ata_scsi_rbuf_get - Map response buffer.
1337 * @cmd: SCSI command containing buffer to be mapped.
1338 * @buf_out: Pointer to mapped area.
1340 * Maps buffer contained within SCSI command @cmd.
1343 * spin_lock_irqsave(host_set lock)
1346 * Length of response buffer.
1349 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1352 unsigned int buflen;
1355 struct scatterlist *sg;
1357 sg = (struct scatterlist *) cmd->request_buffer;
1358 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1359 buflen = sg->length;
1361 buf = cmd->request_buffer;
1362 buflen = cmd->request_bufflen;
1370 * ata_scsi_rbuf_put - Unmap response buffer.
1371 * @cmd: SCSI command containing buffer to be unmapped.
1372 * @buf: buffer to unmap
1374 * Unmaps response buffer contained within @cmd.
1377 * spin_lock_irqsave(host_set lock)
1380 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1383 struct scatterlist *sg;
1385 sg = (struct scatterlist *) cmd->request_buffer;
1386 kunmap_atomic(buf - sg->offset, KM_USER0);
1391 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1392 * @args: device IDENTIFY data / SCSI command of interest.
1393 * @actor: Callback hook for desired SCSI command simulator
1395 * Takes care of the hard work of simulating a SCSI command...
1396 * Mapping the response buffer, calling the command's handler,
1397 * and handling the handler's return value. This return value
1398 * indicates whether the handler wishes the SCSI command to be
1399 * completed successfully (0), or not (in which case cmd->result
1400 * and sense buffer are assumed to be set).
1403 * spin_lock_irqsave(host_set lock)
1406 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1407 unsigned int (*actor) (struct ata_scsi_args *args,
1408 u8 *rbuf, unsigned int buflen))
1411 unsigned int buflen, rc;
1412 struct scsi_cmnd *cmd = args->cmd;
1414 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1415 memset(rbuf, 0, buflen);
1416 rc = actor(args, rbuf, buflen);
1417 ata_scsi_rbuf_put(cmd, rbuf);
1420 cmd->result = SAM_STAT_GOOD;
1425 * ata_scsiop_inq_std - Simulate INQUIRY command
1426 * @args: device IDENTIFY data / SCSI command of interest.
1427 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1428 * @buflen: Response buffer length.
1430 * Returns standard device identification data associated
1431 * with non-EVPD INQUIRY command output.
1434 * spin_lock_irqsave(host_set lock)
1437 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1438 unsigned int buflen)
1443 0x5, /* claim SPC-3 version compatibility */
1448 /* set scsi removeable (RMB) bit per ata bit */
1449 if (ata_id_removeable(args->id))
1454 memcpy(rbuf, hdr, sizeof(hdr));
1457 memcpy(&rbuf[8], "ATA ", 8);
1458 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1459 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1460 if (rbuf[32] == 0 || rbuf[32] == ' ')
1461 memcpy(&rbuf[32], "n/a ", 4);
1465 const u8 versions[] = {
1466 0x60, /* SAM-3 (no version claimed) */
1469 0x20, /* SBC-2 (no version claimed) */
1472 0x60 /* SPC-3 (no version claimed) */
1475 memcpy(rbuf + 59, versions, sizeof(versions));
1482 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1483 * @args: device IDENTIFY data / SCSI command of interest.
1484 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1485 * @buflen: Response buffer length.
1487 * Returns list of inquiry EVPD pages available.
1490 * spin_lock_irqsave(host_set lock)
1493 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1494 unsigned int buflen)
1496 const u8 pages[] = {
1497 0x00, /* page 0x00, this page */
1498 0x80, /* page 0x80, unit serial no page */
1499 0x83 /* page 0x83, device ident page */
1501 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1504 memcpy(rbuf + 4, pages, sizeof(pages));
1510 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1511 * @args: device IDENTIFY data / SCSI command of interest.
1512 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1513 * @buflen: Response buffer length.
1515 * Returns ATA device serial number.
1518 * spin_lock_irqsave(host_set lock)
1521 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1522 unsigned int buflen)
1526 0x80, /* this page code */
1528 ATA_SERNO_LEN, /* page len */
1530 memcpy(rbuf, hdr, sizeof(hdr));
1532 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1533 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1534 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1539 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1542 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1543 * @args: device IDENTIFY data / SCSI command of interest.
1544 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1545 * @buflen: Response buffer length.
1547 * Returns device identification. Currently hardcoded to
1548 * return "Linux ATA-SCSI simulator".
1551 * spin_lock_irqsave(host_set lock)
1554 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1555 unsigned int buflen)
1557 rbuf[1] = 0x83; /* this page code */
1558 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1560 /* our one and only identification descriptor (vendor-specific) */
1561 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1562 rbuf[4 + 0] = 2; /* code set: ASCII */
1563 rbuf[4 + 3] = strlen(inq_83_str);
1564 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1571 * ata_scsiop_noop - Command handler that simply returns success.
1572 * @args: device IDENTIFY data / SCSI command of interest.
1573 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1574 * @buflen: Response buffer length.
1576 * No operation. Simply returns success to caller, to indicate
1577 * that the caller should successfully complete this SCSI command.
1580 * spin_lock_irqsave(host_set lock)
1583 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1584 unsigned int buflen)
1591 * ata_msense_push - Push data onto MODE SENSE data output buffer
1592 * @ptr_io: (input/output) Location to store more output data
1593 * @last: End of output data buffer
1594 * @buf: Pointer to BLOB being added to output buffer
1595 * @buflen: Length of BLOB
1597 * Store MODE SENSE data on an output buffer.
1603 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1604 const u8 *buf, unsigned int buflen)
1608 if ((ptr + buflen - 1) > last)
1611 memcpy(ptr, buf, buflen);
1619 * ata_msense_caching - Simulate MODE SENSE caching info page
1620 * @id: device IDENTIFY data
1621 * @ptr_io: (input/output) Location to store more output data
1622 * @last: End of output data buffer
1624 * Generate a caching info page, which conditionally indicates
1625 * write caching to the SCSI layer, depending on device
1632 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1635 u8 page[CACHE_MPAGE_LEN];
1637 memcpy(page, def_cache_mpage, sizeof(page));
1638 if (ata_id_wcache_enabled(id))
1639 page[2] |= (1 << 2); /* write cache enable */
1640 if (!ata_id_rahead_enabled(id))
1641 page[12] |= (1 << 5); /* disable read ahead */
1643 ata_msense_push(ptr_io, last, page, sizeof(page));
1644 return sizeof(page);
1648 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1649 * @dev: Device associated with this MODE SENSE command
1650 * @ptr_io: (input/output) Location to store more output data
1651 * @last: End of output data buffer
1653 * Generate a generic MODE SENSE control mode page.
1659 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1661 ata_msense_push(ptr_io, last, def_control_mpage,
1662 sizeof(def_control_mpage));
1663 return sizeof(def_control_mpage);
1667 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1668 * @dev: Device associated with this MODE SENSE command
1669 * @ptr_io: (input/output) Location to store more output data
1670 * @last: End of output data buffer
1672 * Generate a generic MODE SENSE r/w error recovery page.
1678 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1681 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1682 sizeof(def_rw_recovery_mpage));
1683 return sizeof(def_rw_recovery_mpage);
1687 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1688 * @args: device IDENTIFY data / SCSI command of interest.
1689 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1690 * @buflen: Response buffer length.
1692 * Simulate MODE SENSE commands. Assume this is invoked for direct
1693 * access devices (e.g. disks) only. There should be no block
1694 * descriptor for other device types.
1697 * spin_lock_irqsave(host_set lock)
1700 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1701 unsigned int buflen)
1703 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1704 const u8 sat_blk_desc[] = {
1705 0, 0, 0, 0, /* number of blocks: sat unspecified */
1707 0, 0x2, 0x0 /* block length: 512 bytes */
1710 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1714 six_byte = (scsicmd[0] == MODE_SENSE);
1715 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1717 * LLBA bit in msense(10) ignored (compliant)
1720 page_control = scsicmd[2] >> 6;
1721 switch (page_control) {
1722 case 0: /* current */
1723 break; /* supported */
1725 goto saving_not_supp;
1726 case 1: /* changeable */
1727 case 2: /* defaults */
1733 output_len = 4 + (ebd ? 8 : 0);
1734 alloc_len = scsicmd[4];
1736 output_len = 8 + (ebd ? 8 : 0);
1737 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1739 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1741 p = rbuf + output_len;
1742 last = rbuf + minlen - 1;
1744 pg = scsicmd[2] & 0x3f;
1747 * No mode subpages supported (yet) but asking for _all_
1748 * subpages may be valid
1750 if (spg && (spg != ALL_SUB_MPAGES))
1754 case RW_RECOVERY_MPAGE:
1755 output_len += ata_msense_rw_recovery(&p, last);
1759 output_len += ata_msense_caching(args->id, &p, last);
1762 case CONTROL_MPAGE: {
1763 output_len += ata_msense_ctl_mode(&p, last);
1768 output_len += ata_msense_rw_recovery(&p, last);
1769 output_len += ata_msense_caching(args->id, &p, last);
1770 output_len += ata_msense_ctl_mode(&p, last);
1773 default: /* invalid page code */
1781 rbuf[0] = output_len;
1784 rbuf[3] = sizeof(sat_blk_desc);
1786 memcpy(rbuf + 4, sat_blk_desc,
1787 sizeof(sat_blk_desc));
1791 rbuf[0] = output_len >> 8;
1793 rbuf[1] = output_len;
1796 rbuf[7] = sizeof(sat_blk_desc);
1798 memcpy(rbuf + 8, sat_blk_desc,
1799 sizeof(sat_blk_desc));
1805 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1806 /* "Invalid field in cbd" */
1810 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1811 /* "Saving parameters not supported" */
1816 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1817 * @args: device IDENTIFY data / SCSI command of interest.
1818 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1819 * @buflen: Response buffer length.
1821 * Simulate READ CAPACITY commands.
1824 * spin_lock_irqsave(host_set lock)
1827 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1828 unsigned int buflen)
1835 if (ata_id_has_lba(args->id)) {
1836 if (ata_id_has_lba48(args->id))
1837 n_sectors = ata_id_u64(args->id, 100);
1839 n_sectors = ata_id_u32(args->id, 60);
1841 /* CHS default translation */
1842 n_sectors = args->id[1] * args->id[3] * args->id[6];
1844 if (ata_id_current_chs_valid(args->id))
1845 /* CHS current translation */
1846 n_sectors = ata_id_u32(args->id, 57);
1849 n_sectors--; /* ATA TotalUserSectors - 1 */
1851 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1852 if( n_sectors >= 0xffffffffULL )
1853 tmp = 0xffffffff ; /* Return max count on overflow */
1857 /* sector count, 32-bit */
1858 rbuf[0] = tmp >> (8 * 3);
1859 rbuf[1] = tmp >> (8 * 2);
1860 rbuf[2] = tmp >> (8 * 1);
1864 tmp = ATA_SECT_SIZE;
1869 /* sector count, 64-bit */
1870 tmp = n_sectors >> (8 * 4);
1871 rbuf[2] = tmp >> (8 * 3);
1872 rbuf[3] = tmp >> (8 * 2);
1873 rbuf[4] = tmp >> (8 * 1);
1876 rbuf[6] = tmp >> (8 * 3);
1877 rbuf[7] = tmp >> (8 * 2);
1878 rbuf[8] = tmp >> (8 * 1);
1882 tmp = ATA_SECT_SIZE;
1883 rbuf[12] = tmp >> 8;
1891 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1892 * @args: device IDENTIFY data / SCSI command of interest.
1893 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1894 * @buflen: Response buffer length.
1896 * Simulate REPORT LUNS command.
1899 * spin_lock_irqsave(host_set lock)
1902 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1903 unsigned int buflen)
1906 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1912 * ata_scsi_set_sense - Set SCSI sense data and status
1913 * @cmd: SCSI request to be handled
1914 * @sk: SCSI-defined sense key
1915 * @asc: SCSI-defined additional sense code
1916 * @ascq: SCSI-defined additional sense code qualifier
1918 * Helper function that builds a valid fixed format, current
1919 * response code and the given sense key (sk), additional sense
1920 * code (asc) and additional sense code qualifier (ascq) with
1921 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1922 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1928 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1930 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1932 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1933 cmd->sense_buffer[2] = sk;
1934 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1935 cmd->sense_buffer[12] = asc;
1936 cmd->sense_buffer[13] = ascq;
1940 * ata_scsi_badcmd - End a SCSI request with an error
1941 * @cmd: SCSI request to be handled
1942 * @done: SCSI command completion function
1943 * @asc: SCSI-defined additional sense code
1944 * @ascq: SCSI-defined additional sense code qualifier
1946 * Helper function that completes a SCSI command with
1947 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1948 * and the specified additional sense codes.
1951 * spin_lock_irqsave(host_set lock)
1954 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1957 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1962 void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1963 struct scsi_cmnd *cmd)
1965 DECLARE_COMPLETION(wait);
1966 struct ata_queued_cmd *qc;
1967 unsigned long flags;
1970 DPRINTK("ATAPI request sense\n");
1972 qc = ata_qc_new_init(ap, dev);
1975 /* FIXME: is this needed? */
1976 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1978 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1979 qc->dma_dir = DMA_FROM_DEVICE;
1981 memset(&qc->cdb, 0, ap->cdb_len);
1982 qc->cdb[0] = REQUEST_SENSE;
1983 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1985 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1986 qc->tf.command = ATA_CMD_PACKET;
1988 qc->tf.protocol = ATA_PROT_ATAPI;
1989 qc->tf.lbam = (8 * 1024) & 0xff;
1990 qc->tf.lbah = (8 * 1024) >> 8;
1991 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
1993 qc->waiting = &wait;
1994 qc->complete_fn = ata_qc_complete_noop;
1996 spin_lock_irqsave(&ap->host_set->lock, flags);
1997 rc = ata_qc_issue(qc);
1998 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2001 ata_port_disable(ap);
2003 wait_for_completion(&wait);
2008 static int atapi_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask)
2010 struct scsi_cmnd *cmd = qc->scsicmd;
2012 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2014 if (unlikely(err_mask & AC_ERR_DEV)) {
2015 DPRINTK("request check condition\n");
2017 /* FIXME: command completion with check condition
2018 * but no sense causes the error handler to run,
2019 * which then issues REQUEST SENSE, fills in the sense
2020 * buffer, and completes the command (for the second
2021 * time). We need to issue REQUEST SENSE some other
2022 * way, to avoid completing the command twice.
2024 cmd->result = SAM_STAT_CHECK_CONDITION;
2031 else if (unlikely(err_mask))
2032 /* FIXME: not quite right; we don't want the
2033 * translation of taskfile registers into
2034 * a sense descriptors, since that's only
2035 * correct for ATA, not ATAPI
2037 ata_gen_ata_desc_sense(qc);
2040 u8 *scsicmd = cmd->cmnd;
2042 if (scsicmd[0] == INQUIRY) {
2044 unsigned int buflen;
2046 buflen = ata_scsi_rbuf_get(cmd, &buf);
2048 /* ATAPI devices typically report zero for their SCSI version,
2049 * and sometimes deviate from the spec WRT response data
2050 * format. If SCSI version is reported as zero like normal,
2051 * then we make the following fixups: 1) Fake MMC-5 version,
2052 * to indicate to the Linux scsi midlayer this is a modern
2053 * device. 2) Ensure response data format / ATAPI information
2054 * are always correct.
2056 /* FIXME: do we ever override EVPD pages and the like, with
2064 ata_scsi_rbuf_put(cmd, buf);
2067 cmd->result = SAM_STAT_GOOD;
2074 * atapi_xlat - Initialize PACKET taskfile
2075 * @qc: command structure to be initialized
2076 * @scsicmd: SCSI CDB associated with this PACKET command
2079 * spin_lock_irqsave(host_set lock)
2082 * Zero on success, non-zero on failure.
2085 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2087 struct scsi_cmnd *cmd = qc->scsicmd;
2088 struct ata_device *dev = qc->dev;
2089 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2090 int nodata = (cmd->sc_data_direction == DMA_NONE);
2093 /* Check whether ATAPI DMA is safe */
2094 if (ata_check_atapi_dma(qc))
2097 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2099 qc->complete_fn = atapi_qc_complete;
2101 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2102 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2103 qc->tf.flags |= ATA_TFLAG_WRITE;
2104 DPRINTK("direction: write\n");
2107 qc->tf.command = ATA_CMD_PACKET;
2109 /* no data, or PIO data xfer */
2110 if (using_pio || nodata) {
2112 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2114 qc->tf.protocol = ATA_PROT_ATAPI;
2115 qc->tf.lbam = (8 * 1024) & 0xff;
2116 qc->tf.lbah = (8 * 1024) >> 8;
2121 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2122 qc->tf.feature |= ATAPI_PKT_DMA;
2124 #ifdef ATAPI_ENABLE_DMADIR
2125 /* some SATA bridges need us to indicate data xfer direction */
2126 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2127 qc->tf.feature |= ATAPI_DMADIR;
2131 qc->nbytes = cmd->bufflen;
2137 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2138 * @ap: ATA port to which the device is attached
2139 * @scsidev: SCSI device from which we derive the ATA device
2141 * Given various information provided in struct scsi_cmnd,
2142 * map that onto an ATA bus, and using that mapping
2143 * determine which ata_device is associated with the
2144 * SCSI command to be sent.
2147 * spin_lock_irqsave(host_set lock)
2150 * Associated ATA device, or %NULL if not found.
2153 static struct ata_device *
2154 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2156 struct ata_device *dev;
2158 /* skip commands not addressed to targets we simulate */
2159 if (likely(scsidev->id < ATA_MAX_DEVICES))
2160 dev = &ap->device[scsidev->id];
2164 if (unlikely((scsidev->channel != 0) ||
2165 (scsidev->lun != 0)))
2168 if (unlikely(!ata_dev_present(dev)))
2171 if (!atapi_enabled) {
2172 if (unlikely(dev->class == ATA_DEV_ATAPI))
2180 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2181 * @byte1: Byte 1 from pass-thru CDB.
2184 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2187 ata_scsi_map_proto(u8 byte1)
2189 switch((byte1 & 0x1e) >> 1) {
2190 case 3: /* Non-data */
2191 return ATA_PROT_NODATA;
2194 return ATA_PROT_DMA;
2196 case 4: /* PIO Data-in */
2197 case 5: /* PIO Data-out */
2199 return ATA_PROT_PIO_MULT;
2201 return ATA_PROT_PIO;
2203 case 10: /* Device Reset */
2204 case 0: /* Hard Reset */
2206 case 2: /* Bus Idle */
2207 case 7: /* Packet */
2208 case 8: /* DMA Queued */
2209 case 9: /* Device Diagnostic */
2210 case 11: /* UDMA Data-in */
2211 case 12: /* UDMA Data-Out */
2212 case 13: /* FPDMA */
2213 default: /* Reserved */
2217 return ATA_PROT_UNKNOWN;
2221 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2222 * @qc: command structure to be initialized
2223 * @cmd: SCSI command to convert
2225 * Handles either 12 or 16-byte versions of the CDB.
2228 * Zero on success, non-zero on failure.
2231 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2233 struct ata_taskfile *tf = &(qc->tf);
2234 struct scsi_cmnd *cmd = qc->scsicmd;
2236 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2240 * 12 and 16 byte CDBs use different offsets to
2241 * provide the various register values.
2243 if (scsicmd[0] == ATA_16) {
2245 * 16-byte CDB - may contain extended commands.
2247 * If that is the case, copy the upper byte register values.
2249 if (scsicmd[1] & 0x01) {
2250 tf->hob_feature = scsicmd[3];
2251 tf->hob_nsect = scsicmd[5];
2252 tf->hob_lbal = scsicmd[7];
2253 tf->hob_lbam = scsicmd[9];
2254 tf->hob_lbah = scsicmd[11];
2255 tf->flags |= ATA_TFLAG_LBA48;
2257 tf->flags &= ~ATA_TFLAG_LBA48;
2260 * Always copy low byte, device and command registers.
2262 tf->feature = scsicmd[4];
2263 tf->nsect = scsicmd[6];
2264 tf->lbal = scsicmd[8];
2265 tf->lbam = scsicmd[10];
2266 tf->lbah = scsicmd[12];
2267 tf->device = scsicmd[13];
2268 tf->command = scsicmd[14];
2271 * 12-byte CDB - incapable of extended commands.
2273 tf->flags &= ~ATA_TFLAG_LBA48;
2275 tf->feature = scsicmd[3];
2276 tf->nsect = scsicmd[4];
2277 tf->lbal = scsicmd[5];
2278 tf->lbam = scsicmd[6];
2279 tf->lbah = scsicmd[7];
2280 tf->device = scsicmd[8];
2281 tf->command = scsicmd[9];
2285 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2286 * SET_FEATURES - XFER MODE must be preceded/succeeded
2287 * by an update to hardware-specific registers for each
2288 * controller (i.e. the reason for ->set_piomode(),
2289 * ->set_dmamode(), and ->post_set_mode() hooks).
2291 if ((tf->command == ATA_CMD_SET_FEATURES)
2292 && (tf->feature == SETFEATURES_XFER))
2296 * Set flags so that all registers will be written,
2297 * and pass on write indication (used for PIO/DMA
2300 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2302 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2303 tf->flags |= ATA_TFLAG_WRITE;
2306 * Set transfer length.
2308 * TODO: find out if we need to do more here to
2309 * cover scatter/gather case.
2311 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2317 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2319 * @cmd: SCSI command opcode to consider
2321 * Look up the SCSI command given, and determine whether the
2322 * SCSI command is to be translated or simulated.
2325 * Pointer to translation function if possible, %NULL if not.
2328 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2338 return ata_scsi_rw_xlat;
2340 case SYNCHRONIZE_CACHE:
2341 if (ata_try_flush_cache(dev))
2342 return ata_scsi_flush_xlat;
2347 return ata_scsi_verify_xlat;
2351 return ata_scsi_pass_thru;
2354 return ata_scsi_start_stop_xlat;
2361 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2362 * @ap: ATA port to which the command was being sent
2363 * @cmd: SCSI command to dump
2365 * Prints the contents of a SCSI command via printk().
2368 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2369 struct scsi_cmnd *cmd)
2372 struct scsi_device *scsidev = cmd->device;
2373 u8 *scsicmd = cmd->cmnd;
2375 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2377 scsidev->channel, scsidev->id, scsidev->lun,
2378 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2379 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2385 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2386 * @cmd: SCSI command to be sent
2387 * @done: Completion function, called when command is complete
2389 * In some cases, this function translates SCSI commands into
2390 * ATA taskfiles, and queues the taskfiles to be sent to
2391 * hardware. In other cases, this function simulates a
2392 * SCSI device by evaluating and responding to certain
2393 * SCSI commands. This creates the overall effect of
2394 * ATA and ATAPI devices appearing as SCSI devices.
2397 * Releases scsi-layer-held lock, and obtains host_set lock.
2403 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2405 struct ata_port *ap;
2406 struct ata_device *dev;
2407 struct scsi_device *scsidev = cmd->device;
2409 ap = (struct ata_port *) &scsidev->host->hostdata[0];
2411 ata_scsi_dump_cdb(ap, cmd);
2413 dev = ata_scsi_find_dev(ap, scsidev);
2414 if (unlikely(!dev)) {
2415 cmd->result = (DID_BAD_TARGET << 16);
2420 if (dev->class == ATA_DEV_ATA) {
2421 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2425 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2427 ata_scsi_simulate(dev->id, cmd, done);
2429 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2436 * ata_scsi_simulate - simulate SCSI command on ATA device
2437 * @id: current IDENTIFY data for target device.
2438 * @cmd: SCSI command being sent to device.
2439 * @done: SCSI command completion function.
2441 * Interprets and directly executes a select list of SCSI commands
2442 * that can be handled internally.
2445 * spin_lock_irqsave(host_set lock)
2448 void ata_scsi_simulate(u16 *id,
2449 struct scsi_cmnd *cmd,
2450 void (*done)(struct scsi_cmnd *))
2452 struct ata_scsi_args args;
2453 const u8 *scsicmd = cmd->cmnd;
2459 switch(scsicmd[0]) {
2460 /* no-op's, complete with success */
2461 case SYNCHRONIZE_CACHE:
2465 case TEST_UNIT_READY:
2466 case FORMAT_UNIT: /* FIXME: correct? */
2467 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2468 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2472 if (scsicmd[1] & 2) /* is CmdDt set? */
2473 ata_scsi_invalid_field(cmd, done);
2474 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2475 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2476 else if (scsicmd[2] == 0x00)
2477 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2478 else if (scsicmd[2] == 0x80)
2479 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2480 else if (scsicmd[2] == 0x83)
2481 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2483 ata_scsi_invalid_field(cmd, done);
2488 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2491 case MODE_SELECT: /* unconditionally return */
2492 case MODE_SELECT_10: /* bad-field-in-cdb */
2493 ata_scsi_invalid_field(cmd, done);
2497 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2500 case SERVICE_ACTION_IN:
2501 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2502 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2504 ata_scsi_invalid_field(cmd, done);
2508 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2511 /* mandatory commands we haven't implemented yet */
2514 /* all other commands */
2516 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2517 /* "Invalid command operation code" */
2523 void ata_scsi_scan_host(struct ata_port *ap)
2525 struct ata_device *dev;
2528 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2531 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2532 dev = &ap->device[i];
2534 if (ata_dev_present(dev))
2535 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);