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 (unlikely(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 (unlikely(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_LBA && !(tf->flags & ATA_TFLAG_LBA48)) {
648 /* A small (28b) LBA will fit in the 32b info field */
649 sb[0] |= 0x80; /* set valid bit */
650 sb[3] = tf->device & 0x0f;
658 * ata_scsi_slave_config - Set SCSI device attributes
659 * @sdev: SCSI device to examine
661 * This is called before we actually start reading
662 * and writing to the device, to configure certain
663 * SCSI mid-layer behaviors.
666 * Defined by SCSI layer. We don't really care.
669 int ata_scsi_slave_config(struct scsi_device *sdev)
671 sdev->use_10_for_rw = 1;
672 sdev->use_10_for_ms = 1;
674 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
676 if (sdev->id < ATA_MAX_DEVICES) {
678 struct ata_device *dev;
680 ap = (struct ata_port *) &sdev->host->hostdata[0];
681 dev = &ap->device[sdev->id];
683 /* TODO: 1024 is an arbitrary number, not the
684 * hardware maximum. This should be increased to
685 * 65534 when Jens Axboe's patch for dynamically
686 * determining max_sectors is merged.
688 if ((dev->flags & ATA_DFLAG_LBA48) &&
689 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
691 * do not overwrite sdev->host->max_sectors, since
692 * other drives on this host may not support LBA48
694 blk_queue_max_sectors(sdev->request_queue, 2048);
698 return 0; /* scsi layer doesn't check return value, sigh */
702 * ata_scsi_error - SCSI layer error handler callback
703 * @host: SCSI host on which error occurred
705 * Handles SCSI-layer-thrown error events.
708 * Inherited from SCSI layer (none, can sleep)
714 int ata_scsi_error(struct Scsi_Host *host)
720 ap = (struct ata_port *) &host->hostdata[0];
721 ap->ops->eng_timeout(ap);
723 /* TODO: this is per-command; when queueing is supported
724 * this code will either change or move to a more
728 INIT_LIST_HEAD(&host->eh_cmd_q);
735 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
736 * @qc: Storage for translated ATA taskfile
737 * @scsicmd: SCSI command to translate
739 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
740 * (to start). Perhaps these commands should be preceded by
741 * CHECK POWER MODE to see what power mode the device is already in.
742 * [See SAT revision 5 at www.t10.org]
745 * spin_lock_irqsave(host_set lock)
748 * Zero on success, non-zero on error.
751 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
754 struct ata_taskfile *tf = &qc->tf;
756 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
757 tf->protocol = ATA_PROT_NODATA;
758 if (scsicmd[1] & 0x1) {
759 ; /* ignore IMMED bit, violates sat-r05 */
761 if (scsicmd[4] & 0x2)
762 goto invalid_fld; /* LOEJ bit set not supported */
763 if (((scsicmd[4] >> 4) & 0xf) != 0)
764 goto invalid_fld; /* power conditions not supported */
765 if (scsicmd[4] & 0x1) {
766 tf->nsect = 1; /* 1 sector, lba=0 */
768 if (qc->dev->flags & ATA_DFLAG_LBA) {
769 qc->tf.flags |= ATA_TFLAG_LBA;
774 tf->device |= ATA_LBA;
777 tf->lbal = 0x1; /* sect */
778 tf->lbam = 0x0; /* cyl low */
779 tf->lbah = 0x0; /* cyl high */
782 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
784 tf->nsect = 0; /* time period value (0 implies now) */
785 tf->command = ATA_CMD_STANDBY;
786 /* Consider: ATA STANDBY IMMEDIATE command */
789 * Standby and Idle condition timers could be implemented but that
790 * would require libata to implement the Power condition mode page
791 * and allow the user to change it. Changing mode pages requires
792 * MODE SELECT to be implemented.
798 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
799 /* "Invalid field in cbd" */
805 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
806 * @qc: Storage for translated ATA taskfile
807 * @scsicmd: SCSI command to translate (ignored)
809 * Sets up an ATA taskfile to issue FLUSH CACHE or
813 * spin_lock_irqsave(host_set lock)
816 * Zero on success, non-zero on error.
819 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
821 struct ata_taskfile *tf = &qc->tf;
823 tf->flags |= ATA_TFLAG_DEVICE;
824 tf->protocol = ATA_PROT_NODATA;
826 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
827 (ata_id_has_flush_ext(qc->dev->id)))
828 tf->command = ATA_CMD_FLUSH_EXT;
830 tf->command = ATA_CMD_FLUSH;
836 * scsi_6_lba_len - Get LBA and transfer length
837 * @scsicmd: SCSI command to translate
839 * Calculate LBA and transfer length for 6-byte commands.
843 * @plen: the transfer length
846 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
851 VPRINTK("six-byte command\n");
853 lba |= ((u64)scsicmd[2]) << 8;
854 lba |= ((u64)scsicmd[3]);
856 len |= ((u32)scsicmd[4]);
863 * scsi_10_lba_len - Get LBA and transfer length
864 * @scsicmd: SCSI command to translate
866 * Calculate LBA and transfer length for 10-byte commands.
870 * @plen: the transfer length
873 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
878 VPRINTK("ten-byte command\n");
880 lba |= ((u64)scsicmd[2]) << 24;
881 lba |= ((u64)scsicmd[3]) << 16;
882 lba |= ((u64)scsicmd[4]) << 8;
883 lba |= ((u64)scsicmd[5]);
885 len |= ((u32)scsicmd[7]) << 8;
886 len |= ((u32)scsicmd[8]);
893 * scsi_16_lba_len - Get LBA and transfer length
894 * @scsicmd: SCSI command to translate
896 * Calculate LBA and transfer length for 16-byte commands.
900 * @plen: the transfer length
903 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
908 VPRINTK("sixteen-byte command\n");
910 lba |= ((u64)scsicmd[2]) << 56;
911 lba |= ((u64)scsicmd[3]) << 48;
912 lba |= ((u64)scsicmd[4]) << 40;
913 lba |= ((u64)scsicmd[5]) << 32;
914 lba |= ((u64)scsicmd[6]) << 24;
915 lba |= ((u64)scsicmd[7]) << 16;
916 lba |= ((u64)scsicmd[8]) << 8;
917 lba |= ((u64)scsicmd[9]);
919 len |= ((u32)scsicmd[10]) << 24;
920 len |= ((u32)scsicmd[11]) << 16;
921 len |= ((u32)scsicmd[12]) << 8;
922 len |= ((u32)scsicmd[13]);
929 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
930 * @qc: Storage for translated ATA taskfile
931 * @scsicmd: SCSI command to translate
933 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
936 * spin_lock_irqsave(host_set lock)
939 * Zero on success, non-zero on error.
942 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
944 struct ata_taskfile *tf = &qc->tf;
945 struct ata_device *dev = qc->dev;
946 u64 dev_sectors = qc->dev->n_sectors;
950 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
951 tf->protocol = ATA_PROT_NODATA;
953 if (scsicmd[0] == VERIFY)
954 scsi_10_lba_len(scsicmd, &block, &n_block);
955 else if (scsicmd[0] == VERIFY_16)
956 scsi_16_lba_len(scsicmd, &block, &n_block);
962 if (block >= dev_sectors)
964 if ((block + n_block) > dev_sectors)
967 if (dev->flags & ATA_DFLAG_LBA) {
968 tf->flags |= ATA_TFLAG_LBA;
970 if (dev->flags & ATA_DFLAG_LBA48) {
971 if (n_block > (64 * 1024))
975 tf->flags |= ATA_TFLAG_LBA48;
976 tf->command = ATA_CMD_VERIFY_EXT;
978 tf->hob_nsect = (n_block >> 8) & 0xff;
980 tf->hob_lbah = (block >> 40) & 0xff;
981 tf->hob_lbam = (block >> 32) & 0xff;
982 tf->hob_lbal = (block >> 24) & 0xff;
988 tf->command = ATA_CMD_VERIFY;
990 tf->device |= (block >> 24) & 0xf;
993 tf->nsect = n_block & 0xff;
995 tf->lbah = (block >> 16) & 0xff;
996 tf->lbam = (block >> 8) & 0xff;
997 tf->lbal = block & 0xff;
999 tf->device |= ATA_LBA;
1002 u32 sect, head, cyl, track;
1007 /* Convert LBA to CHS */
1008 track = (u32)block / dev->sectors;
1009 cyl = track / dev->heads;
1010 head = track % dev->heads;
1011 sect = (u32)block % dev->sectors + 1;
1013 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1014 (u32)block, track, cyl, head, sect);
1016 /* Check whether the converted CHS can fit.
1020 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1023 tf->command = ATA_CMD_VERIFY;
1024 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1027 tf->lbah = cyl >> 8;
1034 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1035 /* "Invalid field in cbd" */
1039 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1040 /* "Logical Block Address out of range" */
1044 qc->scsicmd->result = SAM_STAT_GOOD;
1049 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1050 * @qc: Storage for translated ATA taskfile
1051 * @scsicmd: SCSI command to translate
1053 * Converts any of six SCSI read/write commands into the
1054 * ATA counterpart, including starting sector (LBA),
1055 * sector count, and taking into account the device's LBA48
1058 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1059 * %WRITE_16 are currently supported.
1062 * spin_lock_irqsave(host_set lock)
1065 * Zero on success, non-zero on error.
1068 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1070 struct ata_taskfile *tf = &qc->tf;
1071 struct ata_device *dev = qc->dev;
1075 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1077 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1078 scsicmd[0] == WRITE_16)
1079 tf->flags |= ATA_TFLAG_WRITE;
1081 /* Calculate the SCSI LBA and transfer length. */
1082 switch (scsicmd[0]) {
1085 scsi_10_lba_len(scsicmd, &block, &n_block);
1089 scsi_6_lba_len(scsicmd, &block, &n_block);
1091 /* for 6-byte r/w commands, transfer length 0
1092 * means 256 blocks of data, not 0 block.
1099 scsi_16_lba_len(scsicmd, &block, &n_block);
1102 DPRINTK("no-byte command\n");
1106 /* Check and compose ATA command */
1108 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1109 * length 0 means transfer 0 block of data.
1110 * However, for ATA R/W commands, sector count 0 means
1111 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1115 if (dev->flags & ATA_DFLAG_LBA) {
1116 tf->flags |= ATA_TFLAG_LBA;
1118 if (dev->flags & ATA_DFLAG_LBA48) {
1119 /* The request -may- be too large for LBA48. */
1120 if ((block >> 48) || (n_block > 65536))
1124 tf->flags |= ATA_TFLAG_LBA48;
1126 tf->hob_nsect = (n_block >> 8) & 0xff;
1128 tf->hob_lbah = (block >> 40) & 0xff;
1129 tf->hob_lbam = (block >> 32) & 0xff;
1130 tf->hob_lbal = (block >> 24) & 0xff;
1134 /* The request -may- be too large for LBA28. */
1135 if ((block >> 28) || (n_block > 256))
1138 tf->device |= (block >> 24) & 0xf;
1141 ata_rwcmd_protocol(qc);
1143 qc->nsect = n_block;
1144 tf->nsect = n_block & 0xff;
1146 tf->lbah = (block >> 16) & 0xff;
1147 tf->lbam = (block >> 8) & 0xff;
1148 tf->lbal = block & 0xff;
1150 tf->device |= ATA_LBA;
1153 u32 sect, head, cyl, track;
1155 /* The request -may- be too large for CHS addressing. */
1156 if ((block >> 28) || (n_block > 256))
1159 ata_rwcmd_protocol(qc);
1161 /* Convert LBA to CHS */
1162 track = (u32)block / dev->sectors;
1163 cyl = track / dev->heads;
1164 head = track % dev->heads;
1165 sect = (u32)block % dev->sectors + 1;
1167 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1168 (u32)block, track, cyl, head, sect);
1170 /* Check whether the converted CHS can fit.
1174 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1177 qc->nsect = n_block;
1178 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1181 tf->lbah = cyl >> 8;
1188 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1189 /* "Invalid field in cbd" */
1193 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1194 /* "Logical Block Address out of range" */
1198 qc->scsicmd->result = SAM_STAT_GOOD;
1202 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1204 struct scsi_cmnd *cmd = qc->scsicmd;
1205 int need_sense = drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ);
1207 /* For ATA pass thru (SAT) commands, generate a sense block if
1208 * user mandated it or if there's an error. Note that if we
1209 * generate because the user forced us to, a check condition
1210 * is generated and the ATA register values are returned
1211 * whether the command completed successfully or not. If there
1212 * was no error, SK, ASC and ASCQ will all be zero.
1214 if (((cmd->cmnd[0] == ATA_16) || (cmd->cmnd[0] == ATA_12)) &&
1215 ((cmd->cmnd[2] & 0x20) || need_sense)) {
1216 ata_gen_ata_desc_sense(qc);
1219 cmd->result = SAM_STAT_GOOD;
1221 /* TODO: decide which descriptor format to use
1222 * for 48b LBA devices and call that here
1223 * instead of the fixed desc, which is only
1224 * good for smaller LBA (and maybe CHS?)
1227 ata_gen_fixed_sense(qc);
1232 /* The ata_gen_..._sense routines fill in tf */
1233 ata_dump_status(qc->ap->id, &qc->tf);
1242 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1243 * @ap: ATA port to which the command is addressed
1244 * @dev: ATA device to which the command is addressed
1245 * @cmd: SCSI command to execute
1246 * @done: SCSI command completion function
1247 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1249 * Our ->queuecommand() function has decided that the SCSI
1250 * command issued can be directly translated into an ATA
1251 * command, rather than handled internally.
1253 * This function sets up an ata_queued_cmd structure for the
1254 * SCSI command, and sends that ata_queued_cmd to the hardware.
1256 * The xlat_func argument (actor) returns 0 if ready to execute
1257 * ATA command, else 1 to finish translation. If 1 is returned
1258 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1259 * to be set reflecting an error condition or clean (early)
1263 * spin_lock_irqsave(host_set lock)
1266 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1267 struct scsi_cmnd *cmd,
1268 void (*done)(struct scsi_cmnd *),
1269 ata_xlat_func_t xlat_func)
1271 struct ata_queued_cmd *qc;
1272 u8 *scsicmd = cmd->cmnd;
1276 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1280 /* data is present; dma-map it */
1281 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1282 cmd->sc_data_direction == DMA_TO_DEVICE) {
1283 if (unlikely(cmd->request_bufflen < 1)) {
1284 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1285 ap->id, dev->devno);
1290 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1292 ata_sg_init_one(qc, cmd->request_buffer,
1293 cmd->request_bufflen);
1295 qc->dma_dir = cmd->sc_data_direction;
1298 qc->complete_fn = ata_scsi_qc_complete;
1300 if (xlat_func(qc, scsicmd))
1303 /* select device, send command to hardware */
1304 if (ata_qc_issue(qc))
1313 DPRINTK("EXIT - early finish (good or error)\n");
1319 cmd->result = (DID_ERROR << 16);
1321 DPRINTK("EXIT - internal\n");
1326 * ata_scsi_rbuf_get - Map response buffer.
1327 * @cmd: SCSI command containing buffer to be mapped.
1328 * @buf_out: Pointer to mapped area.
1330 * Maps buffer contained within SCSI command @cmd.
1333 * spin_lock_irqsave(host_set lock)
1336 * Length of response buffer.
1339 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1342 unsigned int buflen;
1345 struct scatterlist *sg;
1347 sg = (struct scatterlist *) cmd->request_buffer;
1348 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1349 buflen = sg->length;
1351 buf = cmd->request_buffer;
1352 buflen = cmd->request_bufflen;
1360 * ata_scsi_rbuf_put - Unmap response buffer.
1361 * @cmd: SCSI command containing buffer to be unmapped.
1362 * @buf: buffer to unmap
1364 * Unmaps response buffer contained within @cmd.
1367 * spin_lock_irqsave(host_set lock)
1370 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1373 struct scatterlist *sg;
1375 sg = (struct scatterlist *) cmd->request_buffer;
1376 kunmap_atomic(buf - sg->offset, KM_USER0);
1381 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1382 * @args: device IDENTIFY data / SCSI command of interest.
1383 * @actor: Callback hook for desired SCSI command simulator
1385 * Takes care of the hard work of simulating a SCSI command...
1386 * Mapping the response buffer, calling the command's handler,
1387 * and handling the handler's return value. This return value
1388 * indicates whether the handler wishes the SCSI command to be
1389 * completed successfully (0), or not (in which case cmd->result
1390 * and sense buffer are assumed to be set).
1393 * spin_lock_irqsave(host_set lock)
1396 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1397 unsigned int (*actor) (struct ata_scsi_args *args,
1398 u8 *rbuf, unsigned int buflen))
1401 unsigned int buflen, rc;
1402 struct scsi_cmnd *cmd = args->cmd;
1404 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1405 memset(rbuf, 0, buflen);
1406 rc = actor(args, rbuf, buflen);
1407 ata_scsi_rbuf_put(cmd, rbuf);
1410 cmd->result = SAM_STAT_GOOD;
1415 * ata_scsiop_inq_std - Simulate INQUIRY command
1416 * @args: device IDENTIFY data / SCSI command of interest.
1417 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1418 * @buflen: Response buffer length.
1420 * Returns standard device identification data associated
1421 * with non-EVPD INQUIRY command output.
1424 * spin_lock_irqsave(host_set lock)
1427 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1428 unsigned int buflen)
1433 0x5, /* claim SPC-3 version compatibility */
1438 /* set scsi removeable (RMB) bit per ata bit */
1439 if (ata_id_removeable(args->id))
1444 memcpy(rbuf, hdr, sizeof(hdr));
1447 memcpy(&rbuf[8], "ATA ", 8);
1448 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1449 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1450 if (rbuf[32] == 0 || rbuf[32] == ' ')
1451 memcpy(&rbuf[32], "n/a ", 4);
1455 const u8 versions[] = {
1456 0x60, /* SAM-3 (no version claimed) */
1459 0x20, /* SBC-2 (no version claimed) */
1462 0x60 /* SPC-3 (no version claimed) */
1465 memcpy(rbuf + 59, versions, sizeof(versions));
1472 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1473 * @args: device IDENTIFY data / SCSI command of interest.
1474 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1475 * @buflen: Response buffer length.
1477 * Returns list of inquiry EVPD pages available.
1480 * spin_lock_irqsave(host_set lock)
1483 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1484 unsigned int buflen)
1486 const u8 pages[] = {
1487 0x00, /* page 0x00, this page */
1488 0x80, /* page 0x80, unit serial no page */
1489 0x83 /* page 0x83, device ident page */
1491 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1494 memcpy(rbuf + 4, pages, sizeof(pages));
1500 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1501 * @args: device IDENTIFY data / SCSI command of interest.
1502 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1503 * @buflen: Response buffer length.
1505 * Returns ATA device serial number.
1508 * spin_lock_irqsave(host_set lock)
1511 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1512 unsigned int buflen)
1516 0x80, /* this page code */
1518 ATA_SERNO_LEN, /* page len */
1520 memcpy(rbuf, hdr, sizeof(hdr));
1522 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1523 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1524 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1529 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1532 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1533 * @args: device IDENTIFY data / SCSI command of interest.
1534 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1535 * @buflen: Response buffer length.
1537 * Returns device identification. Currently hardcoded to
1538 * return "Linux ATA-SCSI simulator".
1541 * spin_lock_irqsave(host_set lock)
1544 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1545 unsigned int buflen)
1547 rbuf[1] = 0x83; /* this page code */
1548 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1550 /* our one and only identification descriptor (vendor-specific) */
1551 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1552 rbuf[4 + 0] = 2; /* code set: ASCII */
1553 rbuf[4 + 3] = strlen(inq_83_str);
1554 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1561 * ata_scsiop_noop - Command handler that simply returns success.
1562 * @args: device IDENTIFY data / SCSI command of interest.
1563 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1564 * @buflen: Response buffer length.
1566 * No operation. Simply returns success to caller, to indicate
1567 * that the caller should successfully complete this SCSI command.
1570 * spin_lock_irqsave(host_set lock)
1573 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1574 unsigned int buflen)
1581 * ata_msense_push - Push data onto MODE SENSE data output buffer
1582 * @ptr_io: (input/output) Location to store more output data
1583 * @last: End of output data buffer
1584 * @buf: Pointer to BLOB being added to output buffer
1585 * @buflen: Length of BLOB
1587 * Store MODE SENSE data on an output buffer.
1593 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1594 const u8 *buf, unsigned int buflen)
1598 if ((ptr + buflen - 1) > last)
1601 memcpy(ptr, buf, buflen);
1609 * ata_msense_caching - Simulate MODE SENSE caching info page
1610 * @id: device IDENTIFY data
1611 * @ptr_io: (input/output) Location to store more output data
1612 * @last: End of output data buffer
1614 * Generate a caching info page, which conditionally indicates
1615 * write caching to the SCSI layer, depending on device
1622 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1625 u8 page[CACHE_MPAGE_LEN];
1627 memcpy(page, def_cache_mpage, sizeof(page));
1628 if (ata_id_wcache_enabled(id))
1629 page[2] |= (1 << 2); /* write cache enable */
1630 if (!ata_id_rahead_enabled(id))
1631 page[12] |= (1 << 5); /* disable read ahead */
1633 ata_msense_push(ptr_io, last, page, sizeof(page));
1634 return sizeof(page);
1638 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1639 * @dev: Device associated with this MODE SENSE command
1640 * @ptr_io: (input/output) Location to store more output data
1641 * @last: End of output data buffer
1643 * Generate a generic MODE SENSE control mode page.
1649 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1651 ata_msense_push(ptr_io, last, def_control_mpage,
1652 sizeof(def_control_mpage));
1653 return sizeof(def_control_mpage);
1657 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1658 * @dev: Device associated with this MODE SENSE command
1659 * @ptr_io: (input/output) Location to store more output data
1660 * @last: End of output data buffer
1662 * Generate a generic MODE SENSE r/w error recovery page.
1668 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1671 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1672 sizeof(def_rw_recovery_mpage));
1673 return sizeof(def_rw_recovery_mpage);
1677 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1678 * @args: device IDENTIFY data / SCSI command of interest.
1679 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1680 * @buflen: Response buffer length.
1682 * Simulate MODE SENSE commands. Assume this is invoked for direct
1683 * access devices (e.g. disks) only. There should be no block
1684 * descriptor for other device types.
1687 * spin_lock_irqsave(host_set lock)
1690 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1691 unsigned int buflen)
1693 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1694 const u8 sat_blk_desc[] = {
1695 0, 0, 0, 0, /* number of blocks: sat unspecified */
1697 0, 0x2, 0x0 /* block length: 512 bytes */
1700 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1704 six_byte = (scsicmd[0] == MODE_SENSE);
1705 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1707 * LLBA bit in msense(10) ignored (compliant)
1710 page_control = scsicmd[2] >> 6;
1711 switch (page_control) {
1712 case 0: /* current */
1713 break; /* supported */
1715 goto saving_not_supp;
1716 case 1: /* changeable */
1717 case 2: /* defaults */
1723 output_len = 4 + (ebd ? 8 : 0);
1724 alloc_len = scsicmd[4];
1726 output_len = 8 + (ebd ? 8 : 0);
1727 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1729 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1731 p = rbuf + output_len;
1732 last = rbuf + minlen - 1;
1734 pg = scsicmd[2] & 0x3f;
1737 * No mode subpages supported (yet) but asking for _all_
1738 * subpages may be valid
1740 if (spg && (spg != ALL_SUB_MPAGES))
1744 case RW_RECOVERY_MPAGE:
1745 output_len += ata_msense_rw_recovery(&p, last);
1749 output_len += ata_msense_caching(args->id, &p, last);
1752 case CONTROL_MPAGE: {
1753 output_len += ata_msense_ctl_mode(&p, last);
1758 output_len += ata_msense_rw_recovery(&p, last);
1759 output_len += ata_msense_caching(args->id, &p, last);
1760 output_len += ata_msense_ctl_mode(&p, last);
1763 default: /* invalid page code */
1771 rbuf[0] = output_len;
1774 rbuf[3] = sizeof(sat_blk_desc);
1776 memcpy(rbuf + 4, sat_blk_desc,
1777 sizeof(sat_blk_desc));
1781 rbuf[0] = output_len >> 8;
1783 rbuf[1] = output_len;
1786 rbuf[7] = sizeof(sat_blk_desc);
1788 memcpy(rbuf + 8, sat_blk_desc,
1789 sizeof(sat_blk_desc));
1795 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1796 /* "Invalid field in cbd" */
1800 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1801 /* "Saving parameters not supported" */
1806 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1807 * @args: device IDENTIFY data / SCSI command of interest.
1808 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1809 * @buflen: Response buffer length.
1811 * Simulate READ CAPACITY commands.
1814 * spin_lock_irqsave(host_set lock)
1817 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1818 unsigned int buflen)
1825 if (ata_id_has_lba(args->id)) {
1826 if (ata_id_has_lba48(args->id))
1827 n_sectors = ata_id_u64(args->id, 100);
1829 n_sectors = ata_id_u32(args->id, 60);
1831 /* CHS default translation */
1832 n_sectors = args->id[1] * args->id[3] * args->id[6];
1834 if (ata_id_current_chs_valid(args->id))
1835 /* CHS current translation */
1836 n_sectors = ata_id_u32(args->id, 57);
1839 n_sectors--; /* ATA TotalUserSectors - 1 */
1841 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1842 if( n_sectors >= 0xffffffffULL )
1843 tmp = 0xffffffff ; /* Return max count on overflow */
1847 /* sector count, 32-bit */
1848 rbuf[0] = tmp >> (8 * 3);
1849 rbuf[1] = tmp >> (8 * 2);
1850 rbuf[2] = tmp >> (8 * 1);
1854 tmp = ATA_SECT_SIZE;
1859 /* sector count, 64-bit */
1860 tmp = n_sectors >> (8 * 4);
1861 rbuf[2] = tmp >> (8 * 3);
1862 rbuf[3] = tmp >> (8 * 2);
1863 rbuf[4] = tmp >> (8 * 1);
1866 rbuf[6] = tmp >> (8 * 3);
1867 rbuf[7] = tmp >> (8 * 2);
1868 rbuf[8] = tmp >> (8 * 1);
1872 tmp = ATA_SECT_SIZE;
1873 rbuf[12] = tmp >> 8;
1881 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1882 * @args: device IDENTIFY data / SCSI command of interest.
1883 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1884 * @buflen: Response buffer length.
1886 * Simulate REPORT LUNS command.
1889 * spin_lock_irqsave(host_set lock)
1892 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1893 unsigned int buflen)
1896 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1902 * ata_scsi_set_sense - Set SCSI sense data and status
1903 * @cmd: SCSI request to be handled
1904 * @sk: SCSI-defined sense key
1905 * @asc: SCSI-defined additional sense code
1906 * @ascq: SCSI-defined additional sense code qualifier
1908 * Helper function that builds a valid fixed format, current
1909 * response code and the given sense key (sk), additional sense
1910 * code (asc) and additional sense code qualifier (ascq) with
1911 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1912 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1918 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1920 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1922 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1923 cmd->sense_buffer[2] = sk;
1924 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1925 cmd->sense_buffer[12] = asc;
1926 cmd->sense_buffer[13] = ascq;
1930 * ata_scsi_badcmd - End a SCSI request with an error
1931 * @cmd: SCSI request to be handled
1932 * @done: SCSI command completion function
1933 * @asc: SCSI-defined additional sense code
1934 * @ascq: SCSI-defined additional sense code qualifier
1936 * Helper function that completes a SCSI command with
1937 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1938 * and the specified additional sense codes.
1941 * spin_lock_irqsave(host_set lock)
1944 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1947 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1952 void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1953 struct scsi_cmnd *cmd)
1955 DECLARE_COMPLETION(wait);
1956 struct ata_queued_cmd *qc;
1957 unsigned long flags;
1960 DPRINTK("ATAPI request sense\n");
1962 qc = ata_qc_new_init(ap, dev);
1965 /* FIXME: is this needed? */
1966 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1968 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1969 qc->dma_dir = DMA_FROM_DEVICE;
1971 memset(&qc->cdb, 0, ap->cdb_len);
1972 qc->cdb[0] = REQUEST_SENSE;
1973 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1975 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1976 qc->tf.command = ATA_CMD_PACKET;
1978 qc->tf.protocol = ATA_PROT_ATAPI;
1979 qc->tf.lbam = (8 * 1024) & 0xff;
1980 qc->tf.lbah = (8 * 1024) >> 8;
1981 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
1983 qc->waiting = &wait;
1984 qc->complete_fn = ata_qc_complete_noop;
1986 spin_lock_irqsave(&ap->host_set->lock, flags);
1987 rc = ata_qc_issue(qc);
1988 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1991 ata_port_disable(ap);
1993 wait_for_completion(&wait);
1998 static int atapi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
2000 struct scsi_cmnd *cmd = qc->scsicmd;
2002 VPRINTK("ENTER, drv_stat == 0x%x\n", drv_stat);
2004 if (unlikely(drv_stat & (ATA_BUSY | ATA_DRQ)))
2005 /* FIXME: not quite right; we don't want the
2006 * translation of taskfile registers into
2007 * a sense descriptors, since that's only
2008 * correct for ATA, not ATAPI
2010 ata_gen_ata_desc_sense(qc);
2012 else if (unlikely(drv_stat & ATA_ERR)) {
2013 DPRINTK("request check condition\n");
2015 /* FIXME: command completion with check condition
2016 * but no sense causes the error handler to run,
2017 * which then issues REQUEST SENSE, fills in the sense
2018 * buffer, and completes the command (for the second
2019 * time). We need to issue REQUEST SENSE some other
2020 * way, to avoid completing the command twice.
2022 cmd->result = SAM_STAT_CHECK_CONDITION;
2030 u8 *scsicmd = cmd->cmnd;
2032 if (scsicmd[0] == INQUIRY) {
2034 unsigned int buflen;
2036 buflen = ata_scsi_rbuf_get(cmd, &buf);
2038 /* ATAPI devices typically report zero for their SCSI version,
2039 * and sometimes deviate from the spec WRT response data
2040 * format. If SCSI version is reported as zero like normal,
2041 * then we make the following fixups: 1) Fake MMC-5 version,
2042 * to indicate to the Linux scsi midlayer this is a modern
2043 * device. 2) Ensure response data format / ATAPI information
2044 * are always correct.
2046 /* FIXME: do we ever override EVPD pages and the like, with
2054 ata_scsi_rbuf_put(cmd, buf);
2057 cmd->result = SAM_STAT_GOOD;
2064 * atapi_xlat - Initialize PACKET taskfile
2065 * @qc: command structure to be initialized
2066 * @scsicmd: SCSI CDB associated with this PACKET command
2069 * spin_lock_irqsave(host_set lock)
2072 * Zero on success, non-zero on failure.
2075 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2077 struct scsi_cmnd *cmd = qc->scsicmd;
2078 struct ata_device *dev = qc->dev;
2079 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2080 int nodata = (cmd->sc_data_direction == DMA_NONE);
2083 /* Check whether ATAPI DMA is safe */
2084 if (ata_check_atapi_dma(qc))
2087 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2089 qc->complete_fn = atapi_qc_complete;
2091 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2092 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2093 qc->tf.flags |= ATA_TFLAG_WRITE;
2094 DPRINTK("direction: write\n");
2097 qc->tf.command = ATA_CMD_PACKET;
2099 /* no data, or PIO data xfer */
2100 if (using_pio || nodata) {
2102 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2104 qc->tf.protocol = ATA_PROT_ATAPI;
2105 qc->tf.lbam = (8 * 1024) & 0xff;
2106 qc->tf.lbah = (8 * 1024) >> 8;
2111 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2112 qc->tf.feature |= ATAPI_PKT_DMA;
2114 #ifdef ATAPI_ENABLE_DMADIR
2115 /* some SATA bridges need us to indicate data xfer direction */
2116 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2117 qc->tf.feature |= ATAPI_DMADIR;
2121 qc->nbytes = cmd->bufflen;
2127 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2128 * @ap: ATA port to which the device is attached
2129 * @scsidev: SCSI device from which we derive the ATA device
2131 * Given various information provided in struct scsi_cmnd,
2132 * map that onto an ATA bus, and using that mapping
2133 * determine which ata_device is associated with the
2134 * SCSI command to be sent.
2137 * spin_lock_irqsave(host_set lock)
2140 * Associated ATA device, or %NULL if not found.
2143 static struct ata_device *
2144 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2146 struct ata_device *dev;
2148 /* skip commands not addressed to targets we simulate */
2149 if (likely(scsidev->id < ATA_MAX_DEVICES))
2150 dev = &ap->device[scsidev->id];
2154 if (unlikely((scsidev->channel != 0) ||
2155 (scsidev->lun != 0)))
2158 if (unlikely(!ata_dev_present(dev)))
2161 if (!atapi_enabled) {
2162 if (unlikely(dev->class == ATA_DEV_ATAPI))
2170 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2171 * @byte1: Byte 1 from pass-thru CDB.
2174 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2177 ata_scsi_map_proto(u8 byte1)
2179 switch((byte1 & 0x1e) >> 1) {
2180 case 3: /* Non-data */
2181 return ATA_PROT_NODATA;
2184 return ATA_PROT_DMA;
2186 case 4: /* PIO Data-in */
2187 case 5: /* PIO Data-out */
2189 return ATA_PROT_PIO_MULT;
2191 return ATA_PROT_PIO;
2193 case 10: /* Device Reset */
2194 case 0: /* Hard Reset */
2196 case 2: /* Bus Idle */
2197 case 7: /* Packet */
2198 case 8: /* DMA Queued */
2199 case 9: /* Device Diagnostic */
2200 case 11: /* UDMA Data-in */
2201 case 12: /* UDMA Data-Out */
2202 case 13: /* FPDMA */
2203 default: /* Reserved */
2207 return ATA_PROT_UNKNOWN;
2211 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2212 * @qc: command structure to be initialized
2213 * @cmd: SCSI command to convert
2215 * Handles either 12 or 16-byte versions of the CDB.
2218 * Zero on success, non-zero on failure.
2221 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2223 struct ata_taskfile *tf = &(qc->tf);
2224 struct scsi_cmnd *cmd = qc->scsicmd;
2226 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2230 * 12 and 16 byte CDBs use different offsets to
2231 * provide the various register values.
2233 if (scsicmd[0] == ATA_16) {
2235 * 16-byte CDB - may contain extended commands.
2237 * If that is the case, copy the upper byte register values.
2239 if (scsicmd[1] & 0x01) {
2240 tf->hob_feature = scsicmd[3];
2241 tf->hob_nsect = scsicmd[5];
2242 tf->hob_lbal = scsicmd[7];
2243 tf->hob_lbam = scsicmd[9];
2244 tf->hob_lbah = scsicmd[11];
2245 tf->flags |= ATA_TFLAG_LBA48;
2247 tf->flags &= ~ATA_TFLAG_LBA48;
2250 * Always copy low byte, device and command registers.
2252 tf->feature = scsicmd[4];
2253 tf->nsect = scsicmd[6];
2254 tf->lbal = scsicmd[8];
2255 tf->lbam = scsicmd[10];
2256 tf->lbah = scsicmd[12];
2257 tf->device = scsicmd[13];
2258 tf->command = scsicmd[14];
2261 * 12-byte CDB - incapable of extended commands.
2263 tf->flags &= ~ATA_TFLAG_LBA48;
2265 tf->feature = scsicmd[3];
2266 tf->nsect = scsicmd[4];
2267 tf->lbal = scsicmd[5];
2268 tf->lbam = scsicmd[6];
2269 tf->lbah = scsicmd[7];
2270 tf->device = scsicmd[8];
2271 tf->command = scsicmd[9];
2275 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2276 * SET_FEATURES - XFER MODE must be preceded/succeeded
2277 * by an update to hardware-specific registers for each
2278 * controller (i.e. the reason for ->set_piomode(),
2279 * ->set_dmamode(), and ->post_set_mode() hooks).
2281 if ((tf->command == ATA_CMD_SET_FEATURES)
2282 && (tf->feature == SETFEATURES_XFER))
2286 * Set flags so that all registers will be written,
2287 * and pass on write indication (used for PIO/DMA
2290 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2292 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2293 tf->flags |= ATA_TFLAG_WRITE;
2296 * Set transfer length.
2298 * TODO: find out if we need to do more here to
2299 * cover scatter/gather case.
2301 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2307 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2309 * @cmd: SCSI command opcode to consider
2311 * Look up the SCSI command given, and determine whether the
2312 * SCSI command is to be translated or simulated.
2315 * Pointer to translation function if possible, %NULL if not.
2318 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2328 return ata_scsi_rw_xlat;
2330 case SYNCHRONIZE_CACHE:
2331 if (ata_try_flush_cache(dev))
2332 return ata_scsi_flush_xlat;
2337 return ata_scsi_verify_xlat;
2341 return ata_scsi_pass_thru;
2344 return ata_scsi_start_stop_xlat;
2351 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2352 * @ap: ATA port to which the command was being sent
2353 * @cmd: SCSI command to dump
2355 * Prints the contents of a SCSI command via printk().
2358 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2359 struct scsi_cmnd *cmd)
2362 struct scsi_device *scsidev = cmd->device;
2363 u8 *scsicmd = cmd->cmnd;
2365 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2367 scsidev->channel, scsidev->id, scsidev->lun,
2368 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2369 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2375 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2376 * @cmd: SCSI command to be sent
2377 * @done: Completion function, called when command is complete
2379 * In some cases, this function translates SCSI commands into
2380 * ATA taskfiles, and queues the taskfiles to be sent to
2381 * hardware. In other cases, this function simulates a
2382 * SCSI device by evaluating and responding to certain
2383 * SCSI commands. This creates the overall effect of
2384 * ATA and ATAPI devices appearing as SCSI devices.
2387 * Releases scsi-layer-held lock, and obtains host_set lock.
2393 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2395 struct ata_port *ap;
2396 struct ata_device *dev;
2397 struct scsi_device *scsidev = cmd->device;
2399 ap = (struct ata_port *) &scsidev->host->hostdata[0];
2401 ata_scsi_dump_cdb(ap, cmd);
2403 dev = ata_scsi_find_dev(ap, scsidev);
2404 if (unlikely(!dev)) {
2405 cmd->result = (DID_BAD_TARGET << 16);
2410 if (dev->class == ATA_DEV_ATA) {
2411 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2415 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2417 ata_scsi_simulate(dev->id, cmd, done);
2419 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2426 * ata_scsi_simulate - simulate SCSI command on ATA device
2427 * @id: current IDENTIFY data for target device.
2428 * @cmd: SCSI command being sent to device.
2429 * @done: SCSI command completion function.
2431 * Interprets and directly executes a select list of SCSI commands
2432 * that can be handled internally.
2435 * spin_lock_irqsave(host_set lock)
2438 void ata_scsi_simulate(u16 *id,
2439 struct scsi_cmnd *cmd,
2440 void (*done)(struct scsi_cmnd *))
2442 struct ata_scsi_args args;
2443 const u8 *scsicmd = cmd->cmnd;
2449 switch(scsicmd[0]) {
2450 /* no-op's, complete with success */
2451 case SYNCHRONIZE_CACHE:
2455 case TEST_UNIT_READY:
2456 case FORMAT_UNIT: /* FIXME: correct? */
2457 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2458 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2462 if (scsicmd[1] & 2) /* is CmdDt set? */
2463 ata_scsi_invalid_field(cmd, done);
2464 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2465 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2466 else if (scsicmd[2] == 0x00)
2467 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2468 else if (scsicmd[2] == 0x80)
2469 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2470 else if (scsicmd[2] == 0x83)
2471 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2473 ata_scsi_invalid_field(cmd, done);
2478 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2481 case MODE_SELECT: /* unconditionally return */
2482 case MODE_SELECT_10: /* bad-field-in-cdb */
2483 ata_scsi_invalid_field(cmd, done);
2487 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2490 case SERVICE_ACTION_IN:
2491 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2492 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2494 ata_scsi_invalid_field(cmd, done);
2498 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2501 /* mandatory commands we haven't implemented yet */
2504 /* all other commands */
2506 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2507 /* "Invalid command operation code" */
2513 void ata_scsi_scan_host(struct ata_port *ap)
2515 struct ata_device *dev;
2518 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2521 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2522 dev = &ap->device[i];
2524 if (ata_dev_present(dev))
2525 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);