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>
40 #include <scsi/scsi_host.h>
41 #include <scsi/scsi_device.h>
42 #include <scsi/scsi_request.h>
43 #include <linux/libata.h>
44 #include <linux/hdreg.h>
45 #include <asm/uaccess.h>
49 #define SECTOR_SIZE 512
51 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
52 static struct ata_device *
53 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
55 #define RW_RECOVERY_MPAGE 0x1
56 #define RW_RECOVERY_MPAGE_LEN 12
57 #define CACHE_MPAGE 0x8
58 #define CACHE_MPAGE_LEN 20
59 #define CONTROL_MPAGE 0xa
60 #define CONTROL_MPAGE_LEN 12
61 #define ALL_MPAGES 0x3f
62 #define ALL_SUB_MPAGES 0xff
65 static const u8 def_rw_recovery_mpage[] = {
67 RW_RECOVERY_MPAGE_LEN - 2,
68 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
69 (1 << 6), /* ARRE (auto read reallocation) */
70 0, /* read retry count */
72 0, /* write retry count */
76 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
79 0, /* contains WCE, needs to be 0 for logic */
80 0, 0, 0, 0, 0, 0, 0, 0, 0,
81 0, /* contains DRA, needs to be 0 for logic */
85 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
87 CONTROL_MPAGE_LEN - 2,
88 2, /* DSENSE=0, GLTSD=1 */
89 0, /* [QAM+QERR may be 1, see 05-359r1] */
90 0, 0, 0, 0, 0xff, 0xff,
91 0, 30 /* extended self test time, see 05-359r1 */
95 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
96 void (*done)(struct scsi_cmnd *))
98 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
99 /* "Invalid field in cbd" */
104 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
105 * @sdev: SCSI device for which BIOS geometry is to be determined
106 * @bdev: block device associated with @sdev
107 * @capacity: capacity of SCSI device
108 * @geom: location to which geometry will be output
110 * Generic bios head/sector/cylinder calculator
111 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
112 * mapping. Some situations may arise where the disk is not
113 * bootable if this is not used.
116 * Defined by the SCSI layer. We don't really care.
121 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
122 sector_t capacity, int geom[])
126 sector_div(capacity, 255*63);
133 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
134 * @scsidev: Device to which we are issuing command
135 * @arg: User provided data for issuing command
138 * Defined by the SCSI layer. We don't really care.
141 * Zero on success, negative errno on error.
144 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
147 u8 scsi_cmd[MAX_COMMAND_SIZE];
148 u8 args[4], *argbuf = NULL;
150 struct scsi_request *sreq;
152 if (NULL == (void *)arg)
155 if (copy_from_user(args, arg, sizeof(args)))
158 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
162 memset(scsi_cmd, 0, sizeof(scsi_cmd));
165 argsize = SECTOR_SIZE * args[3];
166 argbuf = kmalloc(argsize, GFP_KERNEL);
167 if (argbuf == NULL) {
172 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
173 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
174 block count in sector count field */
175 sreq->sr_data_direction = DMA_FROM_DEVICE;
177 scsi_cmd[1] = (3 << 1); /* Non-data */
178 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
179 sreq->sr_data_direction = DMA_NONE;
182 scsi_cmd[0] = ATA_16;
184 scsi_cmd[4] = args[2];
185 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
186 scsi_cmd[6] = args[3];
187 scsi_cmd[8] = args[1];
191 scsi_cmd[6] = args[1];
193 scsi_cmd[14] = args[0];
195 /* Good values for timeout and retries? Values below
196 from scsi_ioctl_send_command() for default case... */
197 scsi_wait_req(sreq, scsi_cmd, argbuf, argsize, (10*HZ), 5);
199 if (sreq->sr_result) {
204 /* Need code to retrieve data from check condition? */
207 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
210 scsi_release_request(sreq);
219 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
220 * @scsidev: Device to which we are issuing command
221 * @arg: User provided data for issuing command
224 * Defined by the SCSI layer. We don't really care.
227 * Zero on success, negative errno on error.
229 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
232 u8 scsi_cmd[MAX_COMMAND_SIZE];
234 struct scsi_request *sreq;
236 if (NULL == (void *)arg)
239 if (copy_from_user(args, arg, sizeof(args)))
242 memset(scsi_cmd, 0, sizeof(scsi_cmd));
243 scsi_cmd[0] = ATA_16;
244 scsi_cmd[1] = (3 << 1); /* Non-data */
245 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
246 scsi_cmd[4] = args[1];
247 scsi_cmd[6] = args[2];
248 scsi_cmd[8] = args[3];
249 scsi_cmd[10] = args[4];
250 scsi_cmd[12] = args[5];
251 scsi_cmd[14] = args[0];
253 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
259 sreq->sr_data_direction = DMA_NONE;
260 /* Good values for timeout and retries? Values below
261 from scsi_ioctl_send_command() for default case... */
262 scsi_wait_req(sreq, scsi_cmd, NULL, 0, (10*HZ), 5);
264 if (sreq->sr_result) {
269 /* Need code to retrieve data from check condition? */
272 scsi_release_request(sreq);
276 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
279 struct ata_device *dev;
280 int val = -EINVAL, rc = -EINVAL;
282 ap = (struct ata_port *) &scsidev->host->hostdata[0];
286 dev = ata_scsi_find_dev(ap, scsidev);
293 case ATA_IOC_GET_IO32:
295 if (copy_to_user(arg, &val, 1))
299 case ATA_IOC_SET_IO32:
300 val = (unsigned long) arg;
306 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
308 return ata_cmd_ioctl(scsidev, arg);
310 case HDIO_DRIVE_TASK:
311 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
313 return ata_task_ioctl(scsidev, arg);
325 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
326 * @ap: ATA port to which the new command is attached
327 * @dev: ATA device to which the new command is attached
328 * @cmd: SCSI command that originated this ATA command
329 * @done: SCSI command completion function
331 * Obtain a reference to an unused ata_queued_cmd structure,
332 * which is the basic libata structure representing a single
333 * ATA command sent to the hardware.
335 * If a command was available, fill in the SCSI-specific
336 * portions of the structure with information on the
340 * spin_lock_irqsave(host_set lock)
343 * Command allocated, or %NULL if none available.
345 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
346 struct ata_device *dev,
347 struct scsi_cmnd *cmd,
348 void (*done)(struct scsi_cmnd *))
350 struct ata_queued_cmd *qc;
352 qc = ata_qc_new_init(ap, dev);
358 qc->__sg = (struct scatterlist *) cmd->request_buffer;
359 qc->n_elem = cmd->use_sg;
361 qc->__sg = &qc->sgent;
365 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
373 * ata_dump_status - user friendly display of error info
374 * @id: id of the port in question
375 * @tf: ptr to filled out taskfile
377 * Decode and dump the ATA error/status registers for the user so
378 * that they have some idea what really happened at the non
379 * make-believe layer.
382 * inherited from caller
384 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
386 u8 stat = tf->command, err = tf->feature;
388 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
389 if (stat & ATA_BUSY) {
390 printk("Busy }\n"); /* Data is not valid in this case */
392 if (stat & 0x40) printk("DriveReady ");
393 if (stat & 0x20) printk("DeviceFault ");
394 if (stat & 0x10) printk("SeekComplete ");
395 if (stat & 0x08) printk("DataRequest ");
396 if (stat & 0x04) printk("CorrectedError ");
397 if (stat & 0x02) printk("Index ");
398 if (stat & 0x01) printk("Error ");
402 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
403 if (err & 0x04) printk("DriveStatusError ");
405 if (err & 0x04) printk("BadCRC ");
406 else printk("Sector ");
408 if (err & 0x40) printk("UncorrectableError ");
409 if (err & 0x10) printk("SectorIdNotFound ");
410 if (err & 0x02) printk("TrackZeroNotFound ");
411 if (err & 0x01) printk("AddrMarkNotFound ");
418 * ata_to_sense_error - convert ATA error to SCSI error
419 * @id: ATA device number
420 * @drv_stat: value contained in ATA status register
421 * @drv_err: value contained in ATA error register
422 * @sk: the sense key we'll fill out
423 * @asc: the additional sense code we'll fill out
424 * @ascq: the additional sense code qualifier we'll fill out
426 * Converts an ATA error into a SCSI error. Fill out pointers to
427 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
428 * format sense blocks.
431 * spin_lock_irqsave(host_set lock)
433 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
438 /* Based on the 3ware driver translation table */
439 static unsigned char sense_table[][4] = {
441 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
443 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
445 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
446 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
447 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
448 /* MC|ID|ABRT|TRK0|MARK */
449 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
451 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
452 /* Bad address mark */
453 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
455 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
457 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
458 /* Media change request */
459 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
461 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
463 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
465 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
466 /* BBD - block marked bad */
467 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
468 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
470 static unsigned char stat_table[][4] = {
471 /* Must be first because BUSY means no other bits valid */
472 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
473 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
474 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
475 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
476 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
480 * Is this an error we can process/parse
482 if (drv_stat & ATA_BUSY) {
483 drv_err = 0; /* Ignore the err bits, they're invalid */
487 /* Look for drv_err */
488 for (i = 0; sense_table[i][0] != 0xFF; i++) {
489 /* Look for best matches first */
490 if ((sense_table[i][0] & drv_err) ==
492 *sk = sense_table[i][1];
493 *asc = sense_table[i][2];
494 *ascq = sense_table[i][3];
498 /* No immediate match */
499 printk(KERN_WARNING "ata%u: no sense translation for "
500 "error 0x%02x\n", id, drv_err);
503 /* Fall back to interpreting status bits */
504 for (i = 0; stat_table[i][0] != 0xFF; i++) {
505 if (stat_table[i][0] & drv_stat) {
506 *sk = stat_table[i][1];
507 *asc = stat_table[i][2];
508 *ascq = stat_table[i][3];
512 /* No error? Undecoded? */
513 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
516 /* For our last chance pick, use medium read error because
517 * it's much more common than an ATA drive telling you a write
521 *asc = 0x11; /* "unrecovered read error" */
522 *ascq = 0x04; /* "auto-reallocation failed" */
525 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
526 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
532 * ata_gen_ata_desc_sense - Generate check condition sense block.
533 * @qc: Command that completed.
535 * This function is specific to the ATA descriptor format sense
536 * block specified for the ATA pass through commands. Regardless
537 * of whether the command errored or not, return a sense
538 * block. Copy all controller registers into the sense
539 * block. Clear sense key, ASC & ASCQ if there is no error.
542 * spin_lock_irqsave(host_set lock)
544 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
546 struct scsi_cmnd *cmd = qc->scsicmd;
547 struct ata_taskfile *tf = &qc->tf;
548 unsigned char *sb = cmd->sense_buffer;
549 unsigned char *desc = sb + 8;
551 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
553 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
556 * Read the controller registers.
558 assert(NULL != qc->ap->ops->tf_read);
559 qc->ap->ops->tf_read(qc->ap, tf);
562 * Use ata_to_sense_error() to map status register bits
563 * onto sense key, asc & ascq.
565 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
566 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
567 &sb[1], &sb[2], &sb[3]);
572 * Sense data is current and format is descriptor.
579 * Set length of additional sense data.
580 * Since we only populate descriptor 0, the total
581 * length is the same (fixed) length as descriptor 0.
583 desc[1] = sb[7] = 14;
586 * Copy registers into sense buffer.
589 desc[3] = tf->feature; /* == error reg */
594 desc[12] = tf->device;
595 desc[13] = tf->command; /* == status reg */
598 * Fill in Extend bit, and the high order bytes
601 if (tf->flags & ATA_TFLAG_LBA48) {
603 desc[4] = tf->hob_nsect;
604 desc[6] = tf->hob_lbal;
605 desc[8] = tf->hob_lbam;
606 desc[10] = tf->hob_lbah;
611 * ata_gen_fixed_sense - generate a SCSI fixed sense block
612 * @qc: Command that we are erroring out
614 * Leverage ata_to_sense_error() to give us the codes. Fit our
615 * LBA in here if there's room.
618 * inherited from caller
620 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
622 struct scsi_cmnd *cmd = qc->scsicmd;
623 struct ata_taskfile *tf = &qc->tf;
624 unsigned char *sb = cmd->sense_buffer;
626 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
628 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
631 * Read the controller registers.
633 assert(NULL != qc->ap->ops->tf_read);
634 qc->ap->ops->tf_read(qc->ap, tf);
637 * Use ata_to_sense_error() to map status register bits
638 * onto sense key, asc & ascq.
640 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
641 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
642 &sb[2], &sb[12], &sb[13]);
649 if (tf->flags & ATA_TFLAG_LBA48) {
650 /* TODO: find solution for LBA48 descriptors */
653 else if (tf->flags & ATA_TFLAG_LBA) {
654 /* A small (28b) LBA will fit in the 32b info field */
655 sb[0] |= 0x80; /* set valid bit */
656 sb[3] = tf->device & 0x0f;
668 * ata_scsi_slave_config - Set SCSI device attributes
669 * @sdev: SCSI device to examine
671 * This is called before we actually start reading
672 * and writing to the device, to configure certain
673 * SCSI mid-layer behaviors.
676 * Defined by SCSI layer. We don't really care.
679 int ata_scsi_slave_config(struct scsi_device *sdev)
681 sdev->use_10_for_rw = 1;
682 sdev->use_10_for_ms = 1;
684 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
686 if (sdev->id < ATA_MAX_DEVICES) {
688 struct ata_device *dev;
690 ap = (struct ata_port *) &sdev->host->hostdata[0];
691 dev = &ap->device[sdev->id];
693 /* TODO: 1024 is an arbitrary number, not the
694 * hardware maximum. This should be increased to
695 * 65534 when Jens Axboe's patch for dynamically
696 * determining max_sectors is merged.
698 if ((dev->flags & ATA_DFLAG_LBA48) &&
699 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
701 * do not overwrite sdev->host->max_sectors, since
702 * other drives on this host may not support LBA48
704 blk_queue_max_sectors(sdev->request_queue, 2048);
708 * SATA DMA transfers must be multiples of 4 byte, so
709 * we need to pad ATAPI transfers using an extra sg.
710 * Decrement max hw segments accordingly.
712 if (dev->class == ATA_DEV_ATAPI) {
713 request_queue_t *q = sdev->request_queue;
714 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
718 return 0; /* scsi layer doesn't check return value, sigh */
722 * ata_scsi_error - SCSI layer error handler callback
723 * @host: SCSI host on which error occurred
725 * Handles SCSI-layer-thrown error events.
728 * Inherited from SCSI layer (none, can sleep)
734 int ata_scsi_error(struct Scsi_Host *host)
740 ap = (struct ata_port *) &host->hostdata[0];
741 ap->ops->eng_timeout(ap);
743 /* TODO: this is per-command; when queueing is supported
744 * this code will either change or move to a more
748 INIT_LIST_HEAD(&host->eh_cmd_q);
755 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
756 * @qc: Storage for translated ATA taskfile
757 * @scsicmd: SCSI command to translate
759 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
760 * (to start). Perhaps these commands should be preceded by
761 * CHECK POWER MODE to see what power mode the device is already in.
762 * [See SAT revision 5 at www.t10.org]
765 * spin_lock_irqsave(host_set lock)
768 * Zero on success, non-zero on error.
771 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
774 struct ata_taskfile *tf = &qc->tf;
776 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
777 tf->protocol = ATA_PROT_NODATA;
778 if (scsicmd[1] & 0x1) {
779 ; /* ignore IMMED bit, violates sat-r05 */
781 if (scsicmd[4] & 0x2)
782 goto invalid_fld; /* LOEJ bit set not supported */
783 if (((scsicmd[4] >> 4) & 0xf) != 0)
784 goto invalid_fld; /* power conditions not supported */
785 if (scsicmd[4] & 0x1) {
786 tf->nsect = 1; /* 1 sector, lba=0 */
788 if (qc->dev->flags & ATA_DFLAG_LBA) {
789 qc->tf.flags |= ATA_TFLAG_LBA;
794 tf->device |= ATA_LBA;
797 tf->lbal = 0x1; /* sect */
798 tf->lbam = 0x0; /* cyl low */
799 tf->lbah = 0x0; /* cyl high */
802 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
804 tf->nsect = 0; /* time period value (0 implies now) */
805 tf->command = ATA_CMD_STANDBY;
806 /* Consider: ATA STANDBY IMMEDIATE command */
809 * Standby and Idle condition timers could be implemented but that
810 * would require libata to implement the Power condition mode page
811 * and allow the user to change it. Changing mode pages requires
812 * MODE SELECT to be implemented.
818 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
819 /* "Invalid field in cbd" */
825 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
826 * @qc: Storage for translated ATA taskfile
827 * @scsicmd: SCSI command to translate (ignored)
829 * Sets up an ATA taskfile to issue FLUSH CACHE or
833 * spin_lock_irqsave(host_set lock)
836 * Zero on success, non-zero on error.
839 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
841 struct ata_taskfile *tf = &qc->tf;
843 tf->flags |= ATA_TFLAG_DEVICE;
844 tf->protocol = ATA_PROT_NODATA;
846 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
847 (ata_id_has_flush_ext(qc->dev->id)))
848 tf->command = ATA_CMD_FLUSH_EXT;
850 tf->command = ATA_CMD_FLUSH;
856 * scsi_6_lba_len - Get LBA and transfer length
857 * @scsicmd: SCSI command to translate
859 * Calculate LBA and transfer length for 6-byte commands.
863 * @plen: the transfer length
866 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
871 VPRINTK("six-byte command\n");
873 lba |= ((u64)scsicmd[2]) << 8;
874 lba |= ((u64)scsicmd[3]);
876 len |= ((u32)scsicmd[4]);
883 * scsi_10_lba_len - Get LBA and transfer length
884 * @scsicmd: SCSI command to translate
886 * Calculate LBA and transfer length for 10-byte commands.
890 * @plen: the transfer length
893 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
898 VPRINTK("ten-byte command\n");
900 lba |= ((u64)scsicmd[2]) << 24;
901 lba |= ((u64)scsicmd[3]) << 16;
902 lba |= ((u64)scsicmd[4]) << 8;
903 lba |= ((u64)scsicmd[5]);
905 len |= ((u32)scsicmd[7]) << 8;
906 len |= ((u32)scsicmd[8]);
913 * scsi_16_lba_len - Get LBA and transfer length
914 * @scsicmd: SCSI command to translate
916 * Calculate LBA and transfer length for 16-byte commands.
920 * @plen: the transfer length
923 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
928 VPRINTK("sixteen-byte command\n");
930 lba |= ((u64)scsicmd[2]) << 56;
931 lba |= ((u64)scsicmd[3]) << 48;
932 lba |= ((u64)scsicmd[4]) << 40;
933 lba |= ((u64)scsicmd[5]) << 32;
934 lba |= ((u64)scsicmd[6]) << 24;
935 lba |= ((u64)scsicmd[7]) << 16;
936 lba |= ((u64)scsicmd[8]) << 8;
937 lba |= ((u64)scsicmd[9]);
939 len |= ((u32)scsicmd[10]) << 24;
940 len |= ((u32)scsicmd[11]) << 16;
941 len |= ((u32)scsicmd[12]) << 8;
942 len |= ((u32)scsicmd[13]);
949 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
950 * @qc: Storage for translated ATA taskfile
951 * @scsicmd: SCSI command to translate
953 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
956 * spin_lock_irqsave(host_set lock)
959 * Zero on success, non-zero on error.
962 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
964 struct ata_taskfile *tf = &qc->tf;
965 struct ata_device *dev = qc->dev;
966 u64 dev_sectors = qc->dev->n_sectors;
970 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
971 tf->protocol = ATA_PROT_NODATA;
973 if (scsicmd[0] == VERIFY)
974 scsi_10_lba_len(scsicmd, &block, &n_block);
975 else if (scsicmd[0] == VERIFY_16)
976 scsi_16_lba_len(scsicmd, &block, &n_block);
982 if (block >= dev_sectors)
984 if ((block + n_block) > dev_sectors)
987 if (dev->flags & ATA_DFLAG_LBA) {
988 tf->flags |= ATA_TFLAG_LBA;
990 if (dev->flags & ATA_DFLAG_LBA48) {
991 if (n_block > (64 * 1024))
995 tf->flags |= ATA_TFLAG_LBA48;
996 tf->command = ATA_CMD_VERIFY_EXT;
998 tf->hob_nsect = (n_block >> 8) & 0xff;
1000 tf->hob_lbah = (block >> 40) & 0xff;
1001 tf->hob_lbam = (block >> 32) & 0xff;
1002 tf->hob_lbal = (block >> 24) & 0xff;
1008 tf->command = ATA_CMD_VERIFY;
1010 tf->device |= (block >> 24) & 0xf;
1013 tf->nsect = n_block & 0xff;
1015 tf->lbah = (block >> 16) & 0xff;
1016 tf->lbam = (block >> 8) & 0xff;
1017 tf->lbal = block & 0xff;
1019 tf->device |= ATA_LBA;
1022 u32 sect, head, cyl, track;
1027 /* Convert LBA to CHS */
1028 track = (u32)block / dev->sectors;
1029 cyl = track / dev->heads;
1030 head = track % dev->heads;
1031 sect = (u32)block % dev->sectors + 1;
1033 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1034 (u32)block, track, cyl, head, sect);
1036 /* Check whether the converted CHS can fit.
1040 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1043 tf->command = ATA_CMD_VERIFY;
1044 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1047 tf->lbah = cyl >> 8;
1054 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1055 /* "Invalid field in cbd" */
1059 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1060 /* "Logical Block Address out of range" */
1064 qc->scsicmd->result = SAM_STAT_GOOD;
1069 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1070 * @qc: Storage for translated ATA taskfile
1071 * @scsicmd: SCSI command to translate
1073 * Converts any of six SCSI read/write commands into the
1074 * ATA counterpart, including starting sector (LBA),
1075 * sector count, and taking into account the device's LBA48
1078 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1079 * %WRITE_16 are currently supported.
1082 * spin_lock_irqsave(host_set lock)
1085 * Zero on success, non-zero on error.
1088 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1090 struct ata_taskfile *tf = &qc->tf;
1091 struct ata_device *dev = qc->dev;
1095 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1097 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1098 scsicmd[0] == WRITE_16)
1099 tf->flags |= ATA_TFLAG_WRITE;
1101 /* Calculate the SCSI LBA and transfer length. */
1102 switch (scsicmd[0]) {
1105 scsi_10_lba_len(scsicmd, &block, &n_block);
1109 scsi_6_lba_len(scsicmd, &block, &n_block);
1111 /* for 6-byte r/w commands, transfer length 0
1112 * means 256 blocks of data, not 0 block.
1119 scsi_16_lba_len(scsicmd, &block, &n_block);
1122 DPRINTK("no-byte command\n");
1126 /* Check and compose ATA command */
1128 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1129 * length 0 means transfer 0 block of data.
1130 * However, for ATA R/W commands, sector count 0 means
1131 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1133 * WARNING: one or two older ATA drives treat 0 as 0...
1137 if (dev->flags & ATA_DFLAG_LBA) {
1138 tf->flags |= ATA_TFLAG_LBA;
1140 if (dev->flags & ATA_DFLAG_LBA48) {
1141 /* The request -may- be too large for LBA48. */
1142 if ((block >> 48) || (n_block > 65536))
1146 tf->flags |= ATA_TFLAG_LBA48;
1148 tf->hob_nsect = (n_block >> 8) & 0xff;
1150 tf->hob_lbah = (block >> 40) & 0xff;
1151 tf->hob_lbam = (block >> 32) & 0xff;
1152 tf->hob_lbal = (block >> 24) & 0xff;
1156 /* The request -may- be too large for LBA28. */
1157 if ((block >> 28) || (n_block > 256))
1160 tf->device |= (block >> 24) & 0xf;
1163 ata_rwcmd_protocol(qc);
1165 qc->nsect = n_block;
1166 tf->nsect = n_block & 0xff;
1168 tf->lbah = (block >> 16) & 0xff;
1169 tf->lbam = (block >> 8) & 0xff;
1170 tf->lbal = block & 0xff;
1172 tf->device |= ATA_LBA;
1175 u32 sect, head, cyl, track;
1177 /* The request -may- be too large for CHS addressing. */
1178 if ((block >> 28) || (n_block > 256))
1181 ata_rwcmd_protocol(qc);
1183 /* Convert LBA to CHS */
1184 track = (u32)block / dev->sectors;
1185 cyl = track / dev->heads;
1186 head = track % dev->heads;
1187 sect = (u32)block % dev->sectors + 1;
1189 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1190 (u32)block, track, cyl, head, sect);
1192 /* Check whether the converted CHS can fit.
1196 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1199 qc->nsect = n_block;
1200 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1203 tf->lbah = cyl >> 8;
1210 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1211 /* "Invalid field in cbd" */
1215 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1216 /* "Logical Block Address out of range" */
1220 qc->scsicmd->result = SAM_STAT_GOOD;
1224 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc,
1225 unsigned int err_mask)
1227 struct scsi_cmnd *cmd = qc->scsicmd;
1228 u8 *cdb = cmd->cmnd;
1229 int need_sense = (err_mask != 0);
1231 /* For ATA pass thru (SAT) commands, generate a sense block if
1232 * user mandated it or if there's an error. Note that if we
1233 * generate because the user forced us to, a check condition
1234 * is generated and the ATA register values are returned
1235 * whether the command completed successfully or not. If there
1236 * was no error, SK, ASC and ASCQ will all be zero.
1238 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1239 ((cdb[2] & 0x20) || need_sense)) {
1240 ata_gen_ata_desc_sense(qc);
1243 cmd->result = SAM_STAT_GOOD;
1245 /* TODO: decide which descriptor format to use
1246 * for 48b LBA devices and call that here
1247 * instead of the fixed desc, which is only
1248 * good for smaller LBA (and maybe CHS?)
1251 ata_gen_fixed_sense(qc);
1256 /* The ata_gen_..._sense routines fill in tf */
1257 ata_dump_status(qc->ap->id, &qc->tf);
1266 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1267 * @ap: ATA port to which the command is addressed
1268 * @dev: ATA device to which the command is addressed
1269 * @cmd: SCSI command to execute
1270 * @done: SCSI command completion function
1271 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1273 * Our ->queuecommand() function has decided that the SCSI
1274 * command issued can be directly translated into an ATA
1275 * command, rather than handled internally.
1277 * This function sets up an ata_queued_cmd structure for the
1278 * SCSI command, and sends that ata_queued_cmd to the hardware.
1280 * The xlat_func argument (actor) returns 0 if ready to execute
1281 * ATA command, else 1 to finish translation. If 1 is returned
1282 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1283 * to be set reflecting an error condition or clean (early)
1287 * spin_lock_irqsave(host_set lock)
1290 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1291 struct scsi_cmnd *cmd,
1292 void (*done)(struct scsi_cmnd *),
1293 ata_xlat_func_t xlat_func)
1295 struct ata_queued_cmd *qc;
1296 u8 *scsicmd = cmd->cmnd;
1300 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1304 /* data is present; dma-map it */
1305 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1306 cmd->sc_data_direction == DMA_TO_DEVICE) {
1307 if (unlikely(cmd->request_bufflen < 1)) {
1308 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1309 ap->id, dev->devno);
1314 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1316 ata_sg_init_one(qc, cmd->request_buffer,
1317 cmd->request_bufflen);
1319 qc->dma_dir = cmd->sc_data_direction;
1322 qc->complete_fn = ata_scsi_qc_complete;
1324 if (xlat_func(qc, scsicmd))
1327 /* select device, send command to hardware */
1328 if (ata_qc_issue(qc))
1337 DPRINTK("EXIT - early finish (good or error)\n");
1343 cmd->result = (DID_ERROR << 16);
1345 DPRINTK("EXIT - internal\n");
1350 * ata_scsi_rbuf_get - Map response buffer.
1351 * @cmd: SCSI command containing buffer to be mapped.
1352 * @buf_out: Pointer to mapped area.
1354 * Maps buffer contained within SCSI command @cmd.
1357 * spin_lock_irqsave(host_set lock)
1360 * Length of response buffer.
1363 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1366 unsigned int buflen;
1369 struct scatterlist *sg;
1371 sg = (struct scatterlist *) cmd->request_buffer;
1372 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1373 buflen = sg->length;
1375 buf = cmd->request_buffer;
1376 buflen = cmd->request_bufflen;
1384 * ata_scsi_rbuf_put - Unmap response buffer.
1385 * @cmd: SCSI command containing buffer to be unmapped.
1386 * @buf: buffer to unmap
1388 * Unmaps response buffer contained within @cmd.
1391 * spin_lock_irqsave(host_set lock)
1394 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1397 struct scatterlist *sg;
1399 sg = (struct scatterlist *) cmd->request_buffer;
1400 kunmap_atomic(buf - sg->offset, KM_USER0);
1405 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1406 * @args: device IDENTIFY data / SCSI command of interest.
1407 * @actor: Callback hook for desired SCSI command simulator
1409 * Takes care of the hard work of simulating a SCSI command...
1410 * Mapping the response buffer, calling the command's handler,
1411 * and handling the handler's return value. This return value
1412 * indicates whether the handler wishes the SCSI command to be
1413 * completed successfully (0), or not (in which case cmd->result
1414 * and sense buffer are assumed to be set).
1417 * spin_lock_irqsave(host_set lock)
1420 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1421 unsigned int (*actor) (struct ata_scsi_args *args,
1422 u8 *rbuf, unsigned int buflen))
1425 unsigned int buflen, rc;
1426 struct scsi_cmnd *cmd = args->cmd;
1428 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1429 memset(rbuf, 0, buflen);
1430 rc = actor(args, rbuf, buflen);
1431 ata_scsi_rbuf_put(cmd, rbuf);
1434 cmd->result = SAM_STAT_GOOD;
1439 * ata_scsiop_inq_std - Simulate INQUIRY command
1440 * @args: device IDENTIFY data / SCSI command of interest.
1441 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1442 * @buflen: Response buffer length.
1444 * Returns standard device identification data associated
1445 * with non-EVPD INQUIRY command output.
1448 * spin_lock_irqsave(host_set lock)
1451 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1452 unsigned int buflen)
1457 0x5, /* claim SPC-3 version compatibility */
1462 /* set scsi removeable (RMB) bit per ata bit */
1463 if (ata_id_removeable(args->id))
1468 memcpy(rbuf, hdr, sizeof(hdr));
1471 memcpy(&rbuf[8], "ATA ", 8);
1472 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1473 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1474 if (rbuf[32] == 0 || rbuf[32] == ' ')
1475 memcpy(&rbuf[32], "n/a ", 4);
1479 const u8 versions[] = {
1480 0x60, /* SAM-3 (no version claimed) */
1483 0x20, /* SBC-2 (no version claimed) */
1486 0x60 /* SPC-3 (no version claimed) */
1489 memcpy(rbuf + 59, versions, sizeof(versions));
1496 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1497 * @args: device IDENTIFY data / SCSI command of interest.
1498 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1499 * @buflen: Response buffer length.
1501 * Returns list of inquiry EVPD pages available.
1504 * spin_lock_irqsave(host_set lock)
1507 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1508 unsigned int buflen)
1510 const u8 pages[] = {
1511 0x00, /* page 0x00, this page */
1512 0x80, /* page 0x80, unit serial no page */
1513 0x83 /* page 0x83, device ident page */
1515 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1518 memcpy(rbuf + 4, pages, sizeof(pages));
1524 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1525 * @args: device IDENTIFY data / SCSI command of interest.
1526 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1527 * @buflen: Response buffer length.
1529 * Returns ATA device serial number.
1532 * spin_lock_irqsave(host_set lock)
1535 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1536 unsigned int buflen)
1540 0x80, /* this page code */
1542 ATA_SERNO_LEN, /* page len */
1544 memcpy(rbuf, hdr, sizeof(hdr));
1546 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1547 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1548 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1553 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1556 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1557 * @args: device IDENTIFY data / SCSI command of interest.
1558 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1559 * @buflen: Response buffer length.
1561 * Returns device identification. Currently hardcoded to
1562 * return "Linux ATA-SCSI simulator".
1565 * spin_lock_irqsave(host_set lock)
1568 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1569 unsigned int buflen)
1571 rbuf[1] = 0x83; /* this page code */
1572 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1574 /* our one and only identification descriptor (vendor-specific) */
1575 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1576 rbuf[4 + 0] = 2; /* code set: ASCII */
1577 rbuf[4 + 3] = strlen(inq_83_str);
1578 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1585 * ata_scsiop_noop - Command handler that simply returns success.
1586 * @args: device IDENTIFY data / SCSI command of interest.
1587 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1588 * @buflen: Response buffer length.
1590 * No operation. Simply returns success to caller, to indicate
1591 * that the caller should successfully complete this SCSI command.
1594 * spin_lock_irqsave(host_set lock)
1597 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1598 unsigned int buflen)
1605 * ata_msense_push - Push data onto MODE SENSE data output buffer
1606 * @ptr_io: (input/output) Location to store more output data
1607 * @last: End of output data buffer
1608 * @buf: Pointer to BLOB being added to output buffer
1609 * @buflen: Length of BLOB
1611 * Store MODE SENSE data on an output buffer.
1617 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1618 const u8 *buf, unsigned int buflen)
1622 if ((ptr + buflen - 1) > last)
1625 memcpy(ptr, buf, buflen);
1633 * ata_msense_caching - Simulate MODE SENSE caching info page
1634 * @id: device IDENTIFY data
1635 * @ptr_io: (input/output) Location to store more output data
1636 * @last: End of output data buffer
1638 * Generate a caching info page, which conditionally indicates
1639 * write caching to the SCSI layer, depending on device
1646 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1649 u8 page[CACHE_MPAGE_LEN];
1651 memcpy(page, def_cache_mpage, sizeof(page));
1652 if (ata_id_wcache_enabled(id))
1653 page[2] |= (1 << 2); /* write cache enable */
1654 if (!ata_id_rahead_enabled(id))
1655 page[12] |= (1 << 5); /* disable read ahead */
1657 ata_msense_push(ptr_io, last, page, sizeof(page));
1658 return sizeof(page);
1662 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1663 * @dev: Device associated with this MODE SENSE command
1664 * @ptr_io: (input/output) Location to store more output data
1665 * @last: End of output data buffer
1667 * Generate a generic MODE SENSE control mode page.
1673 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1675 ata_msense_push(ptr_io, last, def_control_mpage,
1676 sizeof(def_control_mpage));
1677 return sizeof(def_control_mpage);
1681 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1682 * @dev: Device associated with this MODE SENSE command
1683 * @ptr_io: (input/output) Location to store more output data
1684 * @last: End of output data buffer
1686 * Generate a generic MODE SENSE r/w error recovery page.
1692 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1695 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1696 sizeof(def_rw_recovery_mpage));
1697 return sizeof(def_rw_recovery_mpage);
1701 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1702 * @args: device IDENTIFY data / SCSI command of interest.
1703 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1704 * @buflen: Response buffer length.
1706 * Simulate MODE SENSE commands. Assume this is invoked for direct
1707 * access devices (e.g. disks) only. There should be no block
1708 * descriptor for other device types.
1711 * spin_lock_irqsave(host_set lock)
1714 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1715 unsigned int buflen)
1717 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1718 const u8 sat_blk_desc[] = {
1719 0, 0, 0, 0, /* number of blocks: sat unspecified */
1721 0, 0x2, 0x0 /* block length: 512 bytes */
1724 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1728 six_byte = (scsicmd[0] == MODE_SENSE);
1729 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1731 * LLBA bit in msense(10) ignored (compliant)
1734 page_control = scsicmd[2] >> 6;
1735 switch (page_control) {
1736 case 0: /* current */
1737 break; /* supported */
1739 goto saving_not_supp;
1740 case 1: /* changeable */
1741 case 2: /* defaults */
1747 output_len = 4 + (ebd ? 8 : 0);
1748 alloc_len = scsicmd[4];
1750 output_len = 8 + (ebd ? 8 : 0);
1751 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1753 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1755 p = rbuf + output_len;
1756 last = rbuf + minlen - 1;
1758 pg = scsicmd[2] & 0x3f;
1761 * No mode subpages supported (yet) but asking for _all_
1762 * subpages may be valid
1764 if (spg && (spg != ALL_SUB_MPAGES))
1768 case RW_RECOVERY_MPAGE:
1769 output_len += ata_msense_rw_recovery(&p, last);
1773 output_len += ata_msense_caching(args->id, &p, last);
1776 case CONTROL_MPAGE: {
1777 output_len += ata_msense_ctl_mode(&p, last);
1782 output_len += ata_msense_rw_recovery(&p, last);
1783 output_len += ata_msense_caching(args->id, &p, last);
1784 output_len += ata_msense_ctl_mode(&p, last);
1787 default: /* invalid page code */
1795 rbuf[0] = output_len;
1798 rbuf[3] = sizeof(sat_blk_desc);
1800 memcpy(rbuf + 4, sat_blk_desc,
1801 sizeof(sat_blk_desc));
1805 rbuf[0] = output_len >> 8;
1807 rbuf[1] = output_len;
1810 rbuf[7] = sizeof(sat_blk_desc);
1812 memcpy(rbuf + 8, sat_blk_desc,
1813 sizeof(sat_blk_desc));
1819 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1820 /* "Invalid field in cbd" */
1824 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1825 /* "Saving parameters not supported" */
1830 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1831 * @args: device IDENTIFY data / SCSI command of interest.
1832 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1833 * @buflen: Response buffer length.
1835 * Simulate READ CAPACITY commands.
1838 * spin_lock_irqsave(host_set lock)
1841 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1842 unsigned int buflen)
1849 if (ata_id_has_lba(args->id)) {
1850 if (ata_id_has_lba48(args->id))
1851 n_sectors = ata_id_u64(args->id, 100);
1853 n_sectors = ata_id_u32(args->id, 60);
1855 /* CHS default translation */
1856 n_sectors = args->id[1] * args->id[3] * args->id[6];
1858 if (ata_id_current_chs_valid(args->id))
1859 /* CHS current translation */
1860 n_sectors = ata_id_u32(args->id, 57);
1863 n_sectors--; /* ATA TotalUserSectors - 1 */
1865 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1866 if( n_sectors >= 0xffffffffULL )
1867 tmp = 0xffffffff ; /* Return max count on overflow */
1871 /* sector count, 32-bit */
1872 rbuf[0] = tmp >> (8 * 3);
1873 rbuf[1] = tmp >> (8 * 2);
1874 rbuf[2] = tmp >> (8 * 1);
1878 tmp = ATA_SECT_SIZE;
1883 /* sector count, 64-bit */
1884 tmp = n_sectors >> (8 * 4);
1885 rbuf[2] = tmp >> (8 * 3);
1886 rbuf[3] = tmp >> (8 * 2);
1887 rbuf[4] = tmp >> (8 * 1);
1890 rbuf[6] = tmp >> (8 * 3);
1891 rbuf[7] = tmp >> (8 * 2);
1892 rbuf[8] = tmp >> (8 * 1);
1896 tmp = ATA_SECT_SIZE;
1897 rbuf[12] = tmp >> 8;
1905 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1906 * @args: device IDENTIFY data / SCSI command of interest.
1907 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1908 * @buflen: Response buffer length.
1910 * Simulate REPORT LUNS command.
1913 * spin_lock_irqsave(host_set lock)
1916 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1917 unsigned int buflen)
1920 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1926 * ata_scsi_set_sense - Set SCSI sense data and status
1927 * @cmd: SCSI request to be handled
1928 * @sk: SCSI-defined sense key
1929 * @asc: SCSI-defined additional sense code
1930 * @ascq: SCSI-defined additional sense code qualifier
1932 * Helper function that builds a valid fixed format, current
1933 * response code and the given sense key (sk), additional sense
1934 * code (asc) and additional sense code qualifier (ascq) with
1935 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1936 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1942 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1944 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1946 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1947 cmd->sense_buffer[2] = sk;
1948 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1949 cmd->sense_buffer[12] = asc;
1950 cmd->sense_buffer[13] = ascq;
1954 * ata_scsi_badcmd - End a SCSI request with an error
1955 * @cmd: SCSI request to be handled
1956 * @done: SCSI command completion function
1957 * @asc: SCSI-defined additional sense code
1958 * @ascq: SCSI-defined additional sense code qualifier
1960 * Helper function that completes a SCSI command with
1961 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1962 * and the specified additional sense codes.
1965 * spin_lock_irqsave(host_set lock)
1968 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1971 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1976 void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1977 struct scsi_cmnd *cmd)
1979 DECLARE_COMPLETION(wait);
1980 struct ata_queued_cmd *qc;
1981 unsigned long flags;
1984 DPRINTK("ATAPI request sense\n");
1986 qc = ata_qc_new_init(ap, dev);
1989 /* FIXME: is this needed? */
1990 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1992 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1993 qc->dma_dir = DMA_FROM_DEVICE;
1995 memset(&qc->cdb, 0, ap->cdb_len);
1996 qc->cdb[0] = REQUEST_SENSE;
1997 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1999 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2000 qc->tf.command = ATA_CMD_PACKET;
2002 qc->tf.protocol = ATA_PROT_ATAPI;
2003 qc->tf.lbam = (8 * 1024) & 0xff;
2004 qc->tf.lbah = (8 * 1024) >> 8;
2005 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2007 qc->waiting = &wait;
2008 qc->complete_fn = ata_qc_complete_noop;
2010 spin_lock_irqsave(&ap->host_set->lock, flags);
2011 rc = ata_qc_issue(qc);
2012 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2015 ata_port_disable(ap);
2017 wait_for_completion(&wait);
2022 static int atapi_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask)
2024 struct scsi_cmnd *cmd = qc->scsicmd;
2026 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2028 if (unlikely(err_mask & AC_ERR_DEV)) {
2029 DPRINTK("request check condition\n");
2031 /* FIXME: command completion with check condition
2032 * but no sense causes the error handler to run,
2033 * which then issues REQUEST SENSE, fills in the sense
2034 * buffer, and completes the command (for the second
2035 * time). We need to issue REQUEST SENSE some other
2036 * way, to avoid completing the command twice.
2038 cmd->result = SAM_STAT_CHECK_CONDITION;
2045 else if (unlikely(err_mask))
2046 /* FIXME: not quite right; we don't want the
2047 * translation of taskfile registers into
2048 * a sense descriptors, since that's only
2049 * correct for ATA, not ATAPI
2051 ata_gen_ata_desc_sense(qc);
2054 u8 *scsicmd = cmd->cmnd;
2056 if (scsicmd[0] == INQUIRY) {
2058 unsigned int buflen;
2060 buflen = ata_scsi_rbuf_get(cmd, &buf);
2062 /* ATAPI devices typically report zero for their SCSI version,
2063 * and sometimes deviate from the spec WRT response data
2064 * format. If SCSI version is reported as zero like normal,
2065 * then we make the following fixups: 1) Fake MMC-5 version,
2066 * to indicate to the Linux scsi midlayer this is a modern
2067 * device. 2) Ensure response data format / ATAPI information
2068 * are always correct.
2070 /* FIXME: do we ever override EVPD pages and the like, with
2078 ata_scsi_rbuf_put(cmd, buf);
2081 cmd->result = SAM_STAT_GOOD;
2088 * atapi_xlat - Initialize PACKET taskfile
2089 * @qc: command structure to be initialized
2090 * @scsicmd: SCSI CDB associated with this PACKET command
2093 * spin_lock_irqsave(host_set lock)
2096 * Zero on success, non-zero on failure.
2099 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2101 struct scsi_cmnd *cmd = qc->scsicmd;
2102 struct ata_device *dev = qc->dev;
2103 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2104 int nodata = (cmd->sc_data_direction == DMA_NONE);
2107 /* Check whether ATAPI DMA is safe */
2108 if (ata_check_atapi_dma(qc))
2111 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2113 qc->complete_fn = atapi_qc_complete;
2115 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2116 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2117 qc->tf.flags |= ATA_TFLAG_WRITE;
2118 DPRINTK("direction: write\n");
2121 qc->tf.command = ATA_CMD_PACKET;
2123 /* no data, or PIO data xfer */
2124 if (using_pio || nodata) {
2126 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2128 qc->tf.protocol = ATA_PROT_ATAPI;
2129 qc->tf.lbam = (8 * 1024) & 0xff;
2130 qc->tf.lbah = (8 * 1024) >> 8;
2135 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2136 qc->tf.feature |= ATAPI_PKT_DMA;
2138 #ifdef ATAPI_ENABLE_DMADIR
2139 /* some SATA bridges need us to indicate data xfer direction */
2140 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2141 qc->tf.feature |= ATAPI_DMADIR;
2145 qc->nbytes = cmd->bufflen;
2151 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2152 * @ap: ATA port to which the device is attached
2153 * @scsidev: SCSI device from which we derive the ATA device
2155 * Given various information provided in struct scsi_cmnd,
2156 * map that onto an ATA bus, and using that mapping
2157 * determine which ata_device is associated with the
2158 * SCSI command to be sent.
2161 * spin_lock_irqsave(host_set lock)
2164 * Associated ATA device, or %NULL if not found.
2167 static struct ata_device *
2168 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2170 struct ata_device *dev;
2172 /* skip commands not addressed to targets we simulate */
2173 if (likely(scsidev->id < ATA_MAX_DEVICES))
2174 dev = &ap->device[scsidev->id];
2178 if (unlikely((scsidev->channel != 0) ||
2179 (scsidev->lun != 0)))
2182 if (unlikely(!ata_dev_present(dev)))
2185 if (!atapi_enabled) {
2186 if (unlikely(dev->class == ATA_DEV_ATAPI))
2194 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2195 * @byte1: Byte 1 from pass-thru CDB.
2198 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2201 ata_scsi_map_proto(u8 byte1)
2203 switch((byte1 & 0x1e) >> 1) {
2204 case 3: /* Non-data */
2205 return ATA_PROT_NODATA;
2208 return ATA_PROT_DMA;
2210 case 4: /* PIO Data-in */
2211 case 5: /* PIO Data-out */
2213 return ATA_PROT_PIO_MULT;
2215 return ATA_PROT_PIO;
2217 case 10: /* Device Reset */
2218 case 0: /* Hard Reset */
2220 case 2: /* Bus Idle */
2221 case 7: /* Packet */
2222 case 8: /* DMA Queued */
2223 case 9: /* Device Diagnostic */
2224 case 11: /* UDMA Data-in */
2225 case 12: /* UDMA Data-Out */
2226 case 13: /* FPDMA */
2227 default: /* Reserved */
2231 return ATA_PROT_UNKNOWN;
2235 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2236 * @qc: command structure to be initialized
2237 * @scsicmd: SCSI command to convert
2239 * Handles either 12 or 16-byte versions of the CDB.
2242 * Zero on success, non-zero on failure.
2245 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2247 struct ata_taskfile *tf = &(qc->tf);
2248 struct scsi_cmnd *cmd = qc->scsicmd;
2250 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2254 * 12 and 16 byte CDBs use different offsets to
2255 * provide the various register values.
2257 if (scsicmd[0] == ATA_16) {
2259 * 16-byte CDB - may contain extended commands.
2261 * If that is the case, copy the upper byte register values.
2263 if (scsicmd[1] & 0x01) {
2264 tf->hob_feature = scsicmd[3];
2265 tf->hob_nsect = scsicmd[5];
2266 tf->hob_lbal = scsicmd[7];
2267 tf->hob_lbam = scsicmd[9];
2268 tf->hob_lbah = scsicmd[11];
2269 tf->flags |= ATA_TFLAG_LBA48;
2271 tf->flags &= ~ATA_TFLAG_LBA48;
2274 * Always copy low byte, device and command registers.
2276 tf->feature = scsicmd[4];
2277 tf->nsect = scsicmd[6];
2278 tf->lbal = scsicmd[8];
2279 tf->lbam = scsicmd[10];
2280 tf->lbah = scsicmd[12];
2281 tf->device = scsicmd[13];
2282 tf->command = scsicmd[14];
2285 * 12-byte CDB - incapable of extended commands.
2287 tf->flags &= ~ATA_TFLAG_LBA48;
2289 tf->feature = scsicmd[3];
2290 tf->nsect = scsicmd[4];
2291 tf->lbal = scsicmd[5];
2292 tf->lbam = scsicmd[6];
2293 tf->lbah = scsicmd[7];
2294 tf->device = scsicmd[8];
2295 tf->command = scsicmd[9];
2299 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2300 * SET_FEATURES - XFER MODE must be preceded/succeeded
2301 * by an update to hardware-specific registers for each
2302 * controller (i.e. the reason for ->set_piomode(),
2303 * ->set_dmamode(), and ->post_set_mode() hooks).
2305 if ((tf->command == ATA_CMD_SET_FEATURES)
2306 && (tf->feature == SETFEATURES_XFER))
2310 * Set flags so that all registers will be written,
2311 * and pass on write indication (used for PIO/DMA
2314 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2316 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2317 tf->flags |= ATA_TFLAG_WRITE;
2320 * Set transfer length.
2322 * TODO: find out if we need to do more here to
2323 * cover scatter/gather case.
2325 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2331 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2333 * @cmd: SCSI command opcode to consider
2335 * Look up the SCSI command given, and determine whether the
2336 * SCSI command is to be translated or simulated.
2339 * Pointer to translation function if possible, %NULL if not.
2342 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2352 return ata_scsi_rw_xlat;
2354 case SYNCHRONIZE_CACHE:
2355 if (ata_try_flush_cache(dev))
2356 return ata_scsi_flush_xlat;
2361 return ata_scsi_verify_xlat;
2365 return ata_scsi_pass_thru;
2368 return ata_scsi_start_stop_xlat;
2375 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2376 * @ap: ATA port to which the command was being sent
2377 * @cmd: SCSI command to dump
2379 * Prints the contents of a SCSI command via printk().
2382 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2383 struct scsi_cmnd *cmd)
2386 struct scsi_device *scsidev = cmd->device;
2387 u8 *scsicmd = cmd->cmnd;
2389 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2391 scsidev->channel, scsidev->id, scsidev->lun,
2392 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2393 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2399 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2400 * @cmd: SCSI command to be sent
2401 * @done: Completion function, called when command is complete
2403 * In some cases, this function translates SCSI commands into
2404 * ATA taskfiles, and queues the taskfiles to be sent to
2405 * hardware. In other cases, this function simulates a
2406 * SCSI device by evaluating and responding to certain
2407 * SCSI commands. This creates the overall effect of
2408 * ATA and ATAPI devices appearing as SCSI devices.
2411 * Releases scsi-layer-held lock, and obtains host_set lock.
2417 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2419 struct ata_port *ap;
2420 struct ata_device *dev;
2421 struct scsi_device *scsidev = cmd->device;
2422 struct Scsi_Host *shost = scsidev->host;
2424 ap = (struct ata_port *) &shost->hostdata[0];
2426 spin_unlock(shost->host_lock);
2427 spin_lock(&ap->host_set->lock);
2429 ata_scsi_dump_cdb(ap, cmd);
2431 dev = ata_scsi_find_dev(ap, scsidev);
2432 if (unlikely(!dev)) {
2433 cmd->result = (DID_BAD_TARGET << 16);
2438 if (dev->class == ATA_DEV_ATA) {
2439 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2443 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2445 ata_scsi_simulate(dev->id, cmd, done);
2447 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2450 spin_unlock(&ap->host_set->lock);
2451 spin_lock(shost->host_lock);
2456 * ata_scsi_simulate - simulate SCSI command on ATA device
2457 * @id: current IDENTIFY data for target device.
2458 * @cmd: SCSI command being sent to device.
2459 * @done: SCSI command completion function.
2461 * Interprets and directly executes a select list of SCSI commands
2462 * that can be handled internally.
2465 * spin_lock_irqsave(host_set lock)
2468 void ata_scsi_simulate(u16 *id,
2469 struct scsi_cmnd *cmd,
2470 void (*done)(struct scsi_cmnd *))
2472 struct ata_scsi_args args;
2473 const u8 *scsicmd = cmd->cmnd;
2479 switch(scsicmd[0]) {
2480 /* no-op's, complete with success */
2481 case SYNCHRONIZE_CACHE:
2485 case TEST_UNIT_READY:
2486 case FORMAT_UNIT: /* FIXME: correct? */
2487 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2488 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2492 if (scsicmd[1] & 2) /* is CmdDt set? */
2493 ata_scsi_invalid_field(cmd, done);
2494 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2495 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2496 else if (scsicmd[2] == 0x00)
2497 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2498 else if (scsicmd[2] == 0x80)
2499 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2500 else if (scsicmd[2] == 0x83)
2501 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2503 ata_scsi_invalid_field(cmd, done);
2508 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2511 case MODE_SELECT: /* unconditionally return */
2512 case MODE_SELECT_10: /* bad-field-in-cdb */
2513 ata_scsi_invalid_field(cmd, done);
2517 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2520 case SERVICE_ACTION_IN:
2521 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2522 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2524 ata_scsi_invalid_field(cmd, done);
2528 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2531 /* mandatory commands we haven't implemented yet */
2534 /* all other commands */
2536 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2537 /* "Invalid command operation code" */
2543 void ata_scsi_scan_host(struct ata_port *ap)
2545 struct ata_device *dev;
2548 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2551 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2552 dev = &ap->device[i];
2554 if (ata_dev_present(dev))
2555 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);