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_eh.h>
42 #include <scsi/scsi_device.h>
43 #include <scsi/scsi_request.h>
44 #include <scsi/scsi_transport.h>
45 #include <linux/libata.h>
46 #include <linux/hdreg.h>
47 #include <asm/uaccess.h>
51 #define SECTOR_SIZE 512
53 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
54 static struct ata_device *
55 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
56 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
58 #define RW_RECOVERY_MPAGE 0x1
59 #define RW_RECOVERY_MPAGE_LEN 12
60 #define CACHE_MPAGE 0x8
61 #define CACHE_MPAGE_LEN 20
62 #define CONTROL_MPAGE 0xa
63 #define CONTROL_MPAGE_LEN 12
64 #define ALL_MPAGES 0x3f
65 #define ALL_SUB_MPAGES 0xff
68 static const u8 def_rw_recovery_mpage[] = {
70 RW_RECOVERY_MPAGE_LEN - 2,
71 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
72 (1 << 6), /* ARRE (auto read reallocation) */
73 0, /* read retry count */
75 0, /* write retry count */
79 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
82 0, /* contains WCE, needs to be 0 for logic */
83 0, 0, 0, 0, 0, 0, 0, 0, 0,
84 0, /* contains DRA, needs to be 0 for logic */
88 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
90 CONTROL_MPAGE_LEN - 2,
91 2, /* DSENSE=0, GLTSD=1 */
92 0, /* [QAM+QERR may be 1, see 05-359r1] */
93 0, 0, 0, 0, 0xff, 0xff,
94 0, 30 /* extended self test time, see 05-359r1 */
98 * libata transport template. libata doesn't do real transport stuff.
99 * It just needs the eh_timed_out hook.
101 struct scsi_transport_template ata_scsi_transport_template = {
102 .eh_timed_out = ata_scsi_timed_out,
106 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
107 void (*done)(struct scsi_cmnd *))
109 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
110 /* "Invalid field in cbd" */
115 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
116 * @sdev: SCSI device for which BIOS geometry is to be determined
117 * @bdev: block device associated with @sdev
118 * @capacity: capacity of SCSI device
119 * @geom: location to which geometry will be output
121 * Generic bios head/sector/cylinder calculator
122 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
123 * mapping. Some situations may arise where the disk is not
124 * bootable if this is not used.
127 * Defined by the SCSI layer. We don't really care.
132 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
133 sector_t capacity, int geom[])
137 sector_div(capacity, 255*63);
144 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
145 * @scsidev: Device to which we are issuing command
146 * @arg: User provided data for issuing command
149 * Defined by the SCSI layer. We don't really care.
152 * Zero on success, negative errno on error.
155 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
158 u8 scsi_cmd[MAX_COMMAND_SIZE];
159 u8 args[4], *argbuf = NULL;
161 struct scsi_sense_hdr sshdr;
162 enum dma_data_direction data_dir;
167 if (copy_from_user(args, arg, sizeof(args)))
170 memset(scsi_cmd, 0, sizeof(scsi_cmd));
173 argsize = SECTOR_SIZE * args[3];
174 argbuf = kmalloc(argsize, GFP_KERNEL);
175 if (argbuf == NULL) {
180 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
181 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
182 block count in sector count field */
183 data_dir = DMA_FROM_DEVICE;
185 scsi_cmd[1] = (3 << 1); /* Non-data */
186 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
190 scsi_cmd[0] = ATA_16;
192 scsi_cmd[4] = args[2];
193 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
194 scsi_cmd[6] = args[3];
195 scsi_cmd[8] = args[1];
199 scsi_cmd[6] = args[1];
201 scsi_cmd[14] = args[0];
203 /* Good values for timeout and retries? Values below
204 from scsi_ioctl_send_command() for default case... */
205 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
206 &sshdr, (10*HZ), 5)) {
211 /* Need code to retrieve data from check condition? */
214 && copy_to_user(arg + sizeof(args), argbuf, argsize))
224 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
225 * @scsidev: Device to which we are issuing command
226 * @arg: User provided data for issuing command
229 * Defined by the SCSI layer. We don't really care.
232 * Zero on success, negative errno on error.
234 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
237 u8 scsi_cmd[MAX_COMMAND_SIZE];
239 struct scsi_sense_hdr sshdr;
244 if (copy_from_user(args, arg, sizeof(args)))
247 memset(scsi_cmd, 0, sizeof(scsi_cmd));
248 scsi_cmd[0] = ATA_16;
249 scsi_cmd[1] = (3 << 1); /* Non-data */
250 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
251 scsi_cmd[4] = args[1];
252 scsi_cmd[6] = args[2];
253 scsi_cmd[8] = args[3];
254 scsi_cmd[10] = args[4];
255 scsi_cmd[12] = args[5];
256 scsi_cmd[14] = args[0];
258 /* Good values for timeout and retries? Values below
259 from scsi_ioctl_send_command() for default case... */
260 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
264 /* Need code to retrieve data from check condition? */
268 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
270 int val = -EINVAL, rc = -EINVAL;
273 case ATA_IOC_GET_IO32:
275 if (copy_to_user(arg, &val, 1))
279 case ATA_IOC_SET_IO32:
280 val = (unsigned long) arg;
286 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
288 return ata_cmd_ioctl(scsidev, arg);
290 case HDIO_DRIVE_TASK:
291 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
293 return ata_task_ioctl(scsidev, arg);
304 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
305 * @ap: ATA port to which the new command is attached
306 * @dev: ATA device to which the new command is attached
307 * @cmd: SCSI command that originated this ATA command
308 * @done: SCSI command completion function
310 * Obtain a reference to an unused ata_queued_cmd structure,
311 * which is the basic libata structure representing a single
312 * ATA command sent to the hardware.
314 * If a command was available, fill in the SCSI-specific
315 * portions of the structure with information on the
319 * spin_lock_irqsave(host_set lock)
322 * Command allocated, or %NULL if none available.
324 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
325 struct ata_device *dev,
326 struct scsi_cmnd *cmd,
327 void (*done)(struct scsi_cmnd *))
329 struct ata_queued_cmd *qc;
331 qc = ata_qc_new_init(ap, dev);
337 qc->__sg = (struct scatterlist *) cmd->request_buffer;
338 qc->n_elem = cmd->use_sg;
340 qc->__sg = &qc->sgent;
344 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
352 * ata_dump_status - user friendly display of error info
353 * @id: id of the port in question
354 * @tf: ptr to filled out taskfile
356 * Decode and dump the ATA error/status registers for the user so
357 * that they have some idea what really happened at the non
358 * make-believe layer.
361 * inherited from caller
363 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
365 u8 stat = tf->command, err = tf->feature;
367 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
368 if (stat & ATA_BUSY) {
369 printk("Busy }\n"); /* Data is not valid in this case */
371 if (stat & 0x40) printk("DriveReady ");
372 if (stat & 0x20) printk("DeviceFault ");
373 if (stat & 0x10) printk("SeekComplete ");
374 if (stat & 0x08) printk("DataRequest ");
375 if (stat & 0x04) printk("CorrectedError ");
376 if (stat & 0x02) printk("Index ");
377 if (stat & 0x01) printk("Error ");
381 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
382 if (err & 0x04) printk("DriveStatusError ");
384 if (err & 0x04) printk("BadCRC ");
385 else printk("Sector ");
387 if (err & 0x40) printk("UncorrectableError ");
388 if (err & 0x10) printk("SectorIdNotFound ");
389 if (err & 0x02) printk("TrackZeroNotFound ");
390 if (err & 0x01) printk("AddrMarkNotFound ");
396 int ata_scsi_device_resume(struct scsi_device *sdev)
398 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
399 struct ata_device *dev = &ap->device[sdev->id];
401 return ata_device_resume(ap, dev);
404 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
406 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
407 struct ata_device *dev = &ap->device[sdev->id];
409 return ata_device_suspend(ap, dev, state);
413 * ata_to_sense_error - convert ATA error to SCSI error
414 * @id: ATA device number
415 * @drv_stat: value contained in ATA status register
416 * @drv_err: value contained in ATA error register
417 * @sk: the sense key we'll fill out
418 * @asc: the additional sense code we'll fill out
419 * @ascq: the additional sense code qualifier we'll fill out
421 * Converts an ATA error into a SCSI error. Fill out pointers to
422 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
423 * format sense blocks.
426 * spin_lock_irqsave(host_set lock)
428 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
433 /* Based on the 3ware driver translation table */
434 static const unsigned char sense_table[][4] = {
436 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
438 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
440 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
441 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
442 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
443 /* MC|ID|ABRT|TRK0|MARK */
444 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
446 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
447 /* Bad address mark */
448 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
450 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
452 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
453 /* Media change request */
454 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
456 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
458 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
460 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
461 /* BBD - block marked bad */
462 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
463 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
465 static const unsigned char stat_table[][4] = {
466 /* Must be first because BUSY means no other bits valid */
467 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
468 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
469 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
470 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
471 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
475 * Is this an error we can process/parse
477 if (drv_stat & ATA_BUSY) {
478 drv_err = 0; /* Ignore the err bits, they're invalid */
482 /* Look for drv_err */
483 for (i = 0; sense_table[i][0] != 0xFF; i++) {
484 /* Look for best matches first */
485 if ((sense_table[i][0] & drv_err) ==
487 *sk = sense_table[i][1];
488 *asc = sense_table[i][2];
489 *ascq = sense_table[i][3];
493 /* No immediate match */
494 printk(KERN_WARNING "ata%u: no sense translation for "
495 "error 0x%02x\n", id, drv_err);
498 /* Fall back to interpreting status bits */
499 for (i = 0; stat_table[i][0] != 0xFF; i++) {
500 if (stat_table[i][0] & drv_stat) {
501 *sk = stat_table[i][1];
502 *asc = stat_table[i][2];
503 *ascq = stat_table[i][3];
507 /* No error? Undecoded? */
508 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
511 /* We need a sensible error return here, which is tricky, and one
512 that won't cause people to do things like return a disk wrongly */
513 *sk = ABORTED_COMMAND;
518 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
519 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
525 * ata_gen_ata_desc_sense - Generate check condition sense block.
526 * @qc: Command that completed.
528 * This function is specific to the ATA descriptor format sense
529 * block specified for the ATA pass through commands. Regardless
530 * of whether the command errored or not, return a sense
531 * block. Copy all controller registers into the sense
532 * block. Clear sense key, ASC & ASCQ if there is no error.
535 * spin_lock_irqsave(host_set lock)
537 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
539 struct scsi_cmnd *cmd = qc->scsicmd;
540 struct ata_taskfile *tf = &qc->tf;
541 unsigned char *sb = cmd->sense_buffer;
542 unsigned char *desc = sb + 8;
544 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
546 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
549 * Read the controller registers.
551 WARN_ON(qc->ap->ops->tf_read == NULL);
552 qc->ap->ops->tf_read(qc->ap, tf);
555 * Use ata_to_sense_error() to map status register bits
556 * onto sense key, asc & ascq.
559 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
560 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
561 &sb[1], &sb[2], &sb[3]);
566 * Sense data is current and format is descriptor.
573 * Set length of additional sense data.
574 * Since we only populate descriptor 0, the total
575 * length is the same (fixed) length as descriptor 0.
577 desc[1] = sb[7] = 14;
580 * Copy registers into sense buffer.
583 desc[3] = tf->feature; /* == error reg */
588 desc[12] = tf->device;
589 desc[13] = tf->command; /* == status reg */
592 * Fill in Extend bit, and the high order bytes
595 if (tf->flags & ATA_TFLAG_LBA48) {
597 desc[4] = tf->hob_nsect;
598 desc[6] = tf->hob_lbal;
599 desc[8] = tf->hob_lbam;
600 desc[10] = tf->hob_lbah;
605 * ata_gen_fixed_sense - generate a SCSI fixed sense block
606 * @qc: Command that we are erroring out
608 * Leverage ata_to_sense_error() to give us the codes. Fit our
609 * LBA in here if there's room.
612 * inherited from caller
614 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
616 struct scsi_cmnd *cmd = qc->scsicmd;
617 struct ata_taskfile *tf = &qc->tf;
618 unsigned char *sb = cmd->sense_buffer;
620 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
622 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
625 * Read the controller registers.
627 WARN_ON(qc->ap->ops->tf_read == NULL);
628 qc->ap->ops->tf_read(qc->ap, tf);
631 * Use ata_to_sense_error() to map status register bits
632 * onto sense key, asc & ascq.
635 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
636 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
637 &sb[2], &sb[12], &sb[13]);
644 if (tf->flags & ATA_TFLAG_LBA48) {
645 /* TODO: find solution for LBA48 descriptors */
648 else if (tf->flags & ATA_TFLAG_LBA) {
649 /* A small (28b) LBA will fit in the 32b info field */
650 sb[0] |= 0x80; /* set valid bit */
651 sb[3] = tf->device & 0x0f;
662 static void ata_scsi_sdev_config(struct scsi_device *sdev)
664 sdev->use_10_for_rw = 1;
665 sdev->use_10_for_ms = 1;
668 static void ata_scsi_dev_config(struct scsi_device *sdev,
669 struct ata_device *dev)
671 unsigned int max_sectors;
673 /* TODO: 2048 is an arbitrary number, not the
674 * hardware maximum. This should be increased to
675 * 65534 when Jens Axboe's patch for dynamically
676 * determining max_sectors is merged.
678 max_sectors = ATA_MAX_SECTORS;
679 if (dev->flags & ATA_DFLAG_LBA48)
681 if (dev->max_sectors)
682 max_sectors = dev->max_sectors;
684 blk_queue_max_sectors(sdev->request_queue, max_sectors);
687 * SATA DMA transfers must be multiples of 4 byte, so
688 * we need to pad ATAPI transfers using an extra sg.
689 * Decrement max hw segments accordingly.
691 if (dev->class == ATA_DEV_ATAPI) {
692 request_queue_t *q = sdev->request_queue;
693 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
698 * ata_scsi_slave_config - Set SCSI device attributes
699 * @sdev: SCSI device to examine
701 * This is called before we actually start reading
702 * and writing to the device, to configure certain
703 * SCSI mid-layer behaviors.
706 * Defined by SCSI layer. We don't really care.
709 int ata_scsi_slave_config(struct scsi_device *sdev)
711 ata_scsi_sdev_config(sdev);
713 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
715 if (sdev->id < ATA_MAX_DEVICES) {
717 struct ata_device *dev;
719 ap = (struct ata_port *) &sdev->host->hostdata[0];
720 dev = &ap->device[sdev->id];
722 ata_scsi_dev_config(sdev, dev);
725 return 0; /* scsi layer doesn't check return value, sigh */
729 * ata_scsi_timed_out - SCSI layer time out callback
730 * @cmd: timed out SCSI command
732 * Handles SCSI layer timeout. We race with normal completion of
733 * the qc for @cmd. If the qc is already gone, we lose and let
734 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
735 * timed out and EH should be invoked. Prevent ata_qc_complete()
736 * from finishing it by setting EH_SCHEDULED and return
740 * Called from timer context
743 * EH_HANDLED or EH_NOT_HANDLED
745 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
747 struct Scsi_Host *host = cmd->device->host;
748 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
750 struct ata_queued_cmd *qc;
751 enum scsi_eh_timer_return ret = EH_HANDLED;
755 spin_lock_irqsave(&ap->host_set->lock, flags);
756 qc = ata_qc_from_tag(ap, ap->active_tag);
758 WARN_ON(qc->scsicmd != cmd);
759 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
760 qc->err_mask |= AC_ERR_TIMEOUT;
761 ret = EH_NOT_HANDLED;
763 spin_unlock_irqrestore(&ap->host_set->lock, flags);
765 DPRINTK("EXIT, ret=%d\n", ret);
770 * ata_scsi_error - SCSI layer error handler callback
771 * @host: SCSI host on which error occurred
773 * Handles SCSI-layer-thrown error events.
776 * Inherited from SCSI layer (none, can sleep)
782 int ata_scsi_error(struct Scsi_Host *host)
784 struct ata_port *ap = (struct ata_port *)&host->hostdata[0];
788 /* synchronize with IRQ handler and port task */
789 spin_unlock_wait(&ap->host_set->lock);
790 ata_port_flush_task(ap);
792 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
794 ap->ops->eng_timeout(ap);
796 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
798 scsi_eh_flush_done_q(&ap->eh_done_q);
804 static void ata_eh_scsidone(struct scsi_cmnd *scmd)
809 static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
811 struct ata_port *ap = qc->ap;
812 struct scsi_cmnd *scmd = qc->scsicmd;
815 spin_lock_irqsave(&ap->host_set->lock, flags);
816 qc->scsidone = ata_eh_scsidone;
817 __ata_qc_complete(qc);
818 WARN_ON(ata_tag_valid(qc->tag));
819 spin_unlock_irqrestore(&ap->host_set->lock, flags);
821 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
825 * ata_eh_qc_complete - Complete an active ATA command from EH
826 * @qc: Command to complete
828 * Indicate to the mid and upper layers that an ATA command has
829 * completed. To be used from EH.
831 void ata_eh_qc_complete(struct ata_queued_cmd *qc)
833 struct scsi_cmnd *scmd = qc->scsicmd;
834 scmd->retries = scmd->allowed;
835 __ata_eh_qc_complete(qc);
839 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
840 * @qc: Command to retry
842 * Indicate to the mid and upper layers that an ATA command
843 * should be retried. To be used from EH.
845 * SCSI midlayer limits the number of retries to scmd->allowed.
846 * This function might need to adjust scmd->retries for commands
847 * which get retried due to unrelated NCQ failures.
849 void ata_eh_qc_retry(struct ata_queued_cmd *qc)
851 __ata_eh_qc_complete(qc);
855 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
856 * @qc: Storage for translated ATA taskfile
857 * @scsicmd: SCSI command to translate
859 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
860 * (to start). Perhaps these commands should be preceded by
861 * CHECK POWER MODE to see what power mode the device is already in.
862 * [See SAT revision 5 at www.t10.org]
865 * spin_lock_irqsave(host_set lock)
868 * Zero on success, non-zero on error.
871 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
874 struct ata_taskfile *tf = &qc->tf;
876 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
877 tf->protocol = ATA_PROT_NODATA;
878 if (scsicmd[1] & 0x1) {
879 ; /* ignore IMMED bit, violates sat-r05 */
881 if (scsicmd[4] & 0x2)
882 goto invalid_fld; /* LOEJ bit set not supported */
883 if (((scsicmd[4] >> 4) & 0xf) != 0)
884 goto invalid_fld; /* power conditions not supported */
885 if (scsicmd[4] & 0x1) {
886 tf->nsect = 1; /* 1 sector, lba=0 */
888 if (qc->dev->flags & ATA_DFLAG_LBA) {
889 qc->tf.flags |= ATA_TFLAG_LBA;
894 tf->device |= ATA_LBA;
897 tf->lbal = 0x1; /* sect */
898 tf->lbam = 0x0; /* cyl low */
899 tf->lbah = 0x0; /* cyl high */
902 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
904 tf->nsect = 0; /* time period value (0 implies now) */
905 tf->command = ATA_CMD_STANDBY;
906 /* Consider: ATA STANDBY IMMEDIATE command */
909 * Standby and Idle condition timers could be implemented but that
910 * would require libata to implement the Power condition mode page
911 * and allow the user to change it. Changing mode pages requires
912 * MODE SELECT to be implemented.
918 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
919 /* "Invalid field in cbd" */
925 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
926 * @qc: Storage for translated ATA taskfile
927 * @scsicmd: SCSI command to translate (ignored)
929 * Sets up an ATA taskfile to issue FLUSH CACHE or
933 * spin_lock_irqsave(host_set lock)
936 * Zero on success, non-zero on error.
939 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
941 struct ata_taskfile *tf = &qc->tf;
943 tf->flags |= ATA_TFLAG_DEVICE;
944 tf->protocol = ATA_PROT_NODATA;
946 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
947 (ata_id_has_flush_ext(qc->dev->id)))
948 tf->command = ATA_CMD_FLUSH_EXT;
950 tf->command = ATA_CMD_FLUSH;
956 * scsi_6_lba_len - Get LBA and transfer length
957 * @scsicmd: SCSI command to translate
959 * Calculate LBA and transfer length for 6-byte commands.
963 * @plen: the transfer length
966 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
971 VPRINTK("six-byte command\n");
973 lba |= ((u64)scsicmd[2]) << 8;
974 lba |= ((u64)scsicmd[3]);
976 len |= ((u32)scsicmd[4]);
983 * scsi_10_lba_len - Get LBA and transfer length
984 * @scsicmd: SCSI command to translate
986 * Calculate LBA and transfer length for 10-byte commands.
990 * @plen: the transfer length
993 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
998 VPRINTK("ten-byte command\n");
1000 lba |= ((u64)scsicmd[2]) << 24;
1001 lba |= ((u64)scsicmd[3]) << 16;
1002 lba |= ((u64)scsicmd[4]) << 8;
1003 lba |= ((u64)scsicmd[5]);
1005 len |= ((u32)scsicmd[7]) << 8;
1006 len |= ((u32)scsicmd[8]);
1013 * scsi_16_lba_len - Get LBA and transfer length
1014 * @scsicmd: SCSI command to translate
1016 * Calculate LBA and transfer length for 16-byte commands.
1020 * @plen: the transfer length
1023 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1028 VPRINTK("sixteen-byte command\n");
1030 lba |= ((u64)scsicmd[2]) << 56;
1031 lba |= ((u64)scsicmd[3]) << 48;
1032 lba |= ((u64)scsicmd[4]) << 40;
1033 lba |= ((u64)scsicmd[5]) << 32;
1034 lba |= ((u64)scsicmd[6]) << 24;
1035 lba |= ((u64)scsicmd[7]) << 16;
1036 lba |= ((u64)scsicmd[8]) << 8;
1037 lba |= ((u64)scsicmd[9]);
1039 len |= ((u32)scsicmd[10]) << 24;
1040 len |= ((u32)scsicmd[11]) << 16;
1041 len |= ((u32)scsicmd[12]) << 8;
1042 len |= ((u32)scsicmd[13]);
1049 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1050 * @qc: Storage for translated ATA taskfile
1051 * @scsicmd: SCSI command to translate
1053 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1056 * spin_lock_irqsave(host_set lock)
1059 * Zero on success, non-zero on error.
1062 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1064 struct ata_taskfile *tf = &qc->tf;
1065 struct ata_device *dev = qc->dev;
1066 u64 dev_sectors = qc->dev->n_sectors;
1070 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1071 tf->protocol = ATA_PROT_NODATA;
1073 if (scsicmd[0] == VERIFY)
1074 scsi_10_lba_len(scsicmd, &block, &n_block);
1075 else if (scsicmd[0] == VERIFY_16)
1076 scsi_16_lba_len(scsicmd, &block, &n_block);
1082 if (block >= dev_sectors)
1084 if ((block + n_block) > dev_sectors)
1087 if (dev->flags & ATA_DFLAG_LBA) {
1088 tf->flags |= ATA_TFLAG_LBA;
1090 if (lba_28_ok(block, n_block)) {
1092 tf->command = ATA_CMD_VERIFY;
1093 tf->device |= (block >> 24) & 0xf;
1094 } else if (lba_48_ok(block, n_block)) {
1095 if (!(dev->flags & ATA_DFLAG_LBA48))
1099 tf->flags |= ATA_TFLAG_LBA48;
1100 tf->command = ATA_CMD_VERIFY_EXT;
1102 tf->hob_nsect = (n_block >> 8) & 0xff;
1104 tf->hob_lbah = (block >> 40) & 0xff;
1105 tf->hob_lbam = (block >> 32) & 0xff;
1106 tf->hob_lbal = (block >> 24) & 0xff;
1108 /* request too large even for LBA48 */
1111 tf->nsect = n_block & 0xff;
1113 tf->lbah = (block >> 16) & 0xff;
1114 tf->lbam = (block >> 8) & 0xff;
1115 tf->lbal = block & 0xff;
1117 tf->device |= ATA_LBA;
1120 u32 sect, head, cyl, track;
1122 if (!lba_28_ok(block, n_block))
1125 /* Convert LBA to CHS */
1126 track = (u32)block / dev->sectors;
1127 cyl = track / dev->heads;
1128 head = track % dev->heads;
1129 sect = (u32)block % dev->sectors + 1;
1131 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1132 (u32)block, track, cyl, head, sect);
1134 /* Check whether the converted CHS can fit.
1138 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1141 tf->command = ATA_CMD_VERIFY;
1142 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1145 tf->lbah = cyl >> 8;
1152 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1153 /* "Invalid field in cbd" */
1157 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1158 /* "Logical Block Address out of range" */
1162 qc->scsicmd->result = SAM_STAT_GOOD;
1167 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1168 * @qc: Storage for translated ATA taskfile
1169 * @scsicmd: SCSI command to translate
1171 * Converts any of six SCSI read/write commands into the
1172 * ATA counterpart, including starting sector (LBA),
1173 * sector count, and taking into account the device's LBA48
1176 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1177 * %WRITE_16 are currently supported.
1180 * spin_lock_irqsave(host_set lock)
1183 * Zero on success, non-zero on error.
1186 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1188 struct ata_taskfile *tf = &qc->tf;
1189 struct ata_device *dev = qc->dev;
1193 qc->flags |= ATA_QCFLAG_IO;
1194 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1196 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1197 scsicmd[0] == WRITE_16)
1198 tf->flags |= ATA_TFLAG_WRITE;
1200 /* Calculate the SCSI LBA, transfer length and FUA. */
1201 switch (scsicmd[0]) {
1204 scsi_10_lba_len(scsicmd, &block, &n_block);
1205 if (unlikely(scsicmd[1] & (1 << 3)))
1206 tf->flags |= ATA_TFLAG_FUA;
1210 scsi_6_lba_len(scsicmd, &block, &n_block);
1212 /* for 6-byte r/w commands, transfer length 0
1213 * means 256 blocks of data, not 0 block.
1220 scsi_16_lba_len(scsicmd, &block, &n_block);
1221 if (unlikely(scsicmd[1] & (1 << 3)))
1222 tf->flags |= ATA_TFLAG_FUA;
1225 DPRINTK("no-byte command\n");
1229 /* Check and compose ATA command */
1231 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1232 * length 0 means transfer 0 block of data.
1233 * However, for ATA R/W commands, sector count 0 means
1234 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1236 * WARNING: one or two older ATA drives treat 0 as 0...
1240 if (dev->flags & ATA_DFLAG_LBA) {
1241 tf->flags |= ATA_TFLAG_LBA;
1243 if (lba_28_ok(block, n_block)) {
1245 tf->device |= (block >> 24) & 0xf;
1246 } else if (lba_48_ok(block, n_block)) {
1247 if (!(dev->flags & ATA_DFLAG_LBA48))
1251 tf->flags |= ATA_TFLAG_LBA48;
1253 tf->hob_nsect = (n_block >> 8) & 0xff;
1255 tf->hob_lbah = (block >> 40) & 0xff;
1256 tf->hob_lbam = (block >> 32) & 0xff;
1257 tf->hob_lbal = (block >> 24) & 0xff;
1259 /* request too large even for LBA48 */
1262 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1265 qc->nsect = n_block;
1266 tf->nsect = n_block & 0xff;
1268 tf->lbah = (block >> 16) & 0xff;
1269 tf->lbam = (block >> 8) & 0xff;
1270 tf->lbal = block & 0xff;
1272 tf->device |= ATA_LBA;
1275 u32 sect, head, cyl, track;
1277 /* The request -may- be too large for CHS addressing. */
1278 if (!lba_28_ok(block, n_block))
1281 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1284 /* Convert LBA to CHS */
1285 track = (u32)block / dev->sectors;
1286 cyl = track / dev->heads;
1287 head = track % dev->heads;
1288 sect = (u32)block % dev->sectors + 1;
1290 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1291 (u32)block, track, cyl, head, sect);
1293 /* Check whether the converted CHS can fit.
1297 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1300 qc->nsect = n_block;
1301 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1304 tf->lbah = cyl >> 8;
1311 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1312 /* "Invalid field in cbd" */
1316 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1317 /* "Logical Block Address out of range" */
1321 qc->scsicmd->result = SAM_STAT_GOOD;
1325 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1327 struct scsi_cmnd *cmd = qc->scsicmd;
1328 u8 *cdb = cmd->cmnd;
1329 int need_sense = (qc->err_mask != 0);
1331 /* For ATA pass thru (SAT) commands, generate a sense block if
1332 * user mandated it or if there's an error. Note that if we
1333 * generate because the user forced us to, a check condition
1334 * is generated and the ATA register values are returned
1335 * whether the command completed successfully or not. If there
1336 * was no error, SK, ASC and ASCQ will all be zero.
1338 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1339 ((cdb[2] & 0x20) || need_sense)) {
1340 ata_gen_ata_desc_sense(qc);
1343 cmd->result = SAM_STAT_GOOD;
1345 /* TODO: decide which descriptor format to use
1346 * for 48b LBA devices and call that here
1347 * instead of the fixed desc, which is only
1348 * good for smaller LBA (and maybe CHS?)
1351 ata_gen_fixed_sense(qc);
1356 /* The ata_gen_..._sense routines fill in tf */
1357 ata_dump_status(qc->ap->id, &qc->tf);
1366 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1367 * @ap: ATA port to which the command is addressed
1368 * @dev: ATA device to which the command is addressed
1369 * @cmd: SCSI command to execute
1370 * @done: SCSI command completion function
1371 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1373 * Our ->queuecommand() function has decided that the SCSI
1374 * command issued can be directly translated into an ATA
1375 * command, rather than handled internally.
1377 * This function sets up an ata_queued_cmd structure for the
1378 * SCSI command, and sends that ata_queued_cmd to the hardware.
1380 * The xlat_func argument (actor) returns 0 if ready to execute
1381 * ATA command, else 1 to finish translation. If 1 is returned
1382 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1383 * to be set reflecting an error condition or clean (early)
1387 * spin_lock_irqsave(host_set lock)
1390 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1391 struct scsi_cmnd *cmd,
1392 void (*done)(struct scsi_cmnd *),
1393 ata_xlat_func_t xlat_func)
1395 struct ata_queued_cmd *qc;
1396 u8 *scsicmd = cmd->cmnd;
1400 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1404 /* data is present; dma-map it */
1405 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1406 cmd->sc_data_direction == DMA_TO_DEVICE) {
1407 if (unlikely(cmd->request_bufflen < 1)) {
1408 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1409 ap->id, dev->devno);
1414 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1416 ata_sg_init_one(qc, cmd->request_buffer,
1417 cmd->request_bufflen);
1419 qc->dma_dir = cmd->sc_data_direction;
1422 qc->complete_fn = ata_scsi_qc_complete;
1424 if (xlat_func(qc, scsicmd))
1427 /* select device, send command to hardware */
1436 DPRINTK("EXIT - early finish (good or error)\n");
1442 cmd->result = (DID_ERROR << 16);
1444 DPRINTK("EXIT - internal\n");
1449 * ata_scsi_rbuf_get - Map response buffer.
1450 * @cmd: SCSI command containing buffer to be mapped.
1451 * @buf_out: Pointer to mapped area.
1453 * Maps buffer contained within SCSI command @cmd.
1456 * spin_lock_irqsave(host_set lock)
1459 * Length of response buffer.
1462 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1465 unsigned int buflen;
1468 struct scatterlist *sg;
1470 sg = (struct scatterlist *) cmd->request_buffer;
1471 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1472 buflen = sg->length;
1474 buf = cmd->request_buffer;
1475 buflen = cmd->request_bufflen;
1483 * ata_scsi_rbuf_put - Unmap response buffer.
1484 * @cmd: SCSI command containing buffer to be unmapped.
1485 * @buf: buffer to unmap
1487 * Unmaps response buffer contained within @cmd.
1490 * spin_lock_irqsave(host_set lock)
1493 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1496 struct scatterlist *sg;
1498 sg = (struct scatterlist *) cmd->request_buffer;
1499 kunmap_atomic(buf - sg->offset, KM_USER0);
1504 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1505 * @args: device IDENTIFY data / SCSI command of interest.
1506 * @actor: Callback hook for desired SCSI command simulator
1508 * Takes care of the hard work of simulating a SCSI command...
1509 * Mapping the response buffer, calling the command's handler,
1510 * and handling the handler's return value. This return value
1511 * indicates whether the handler wishes the SCSI command to be
1512 * completed successfully (0), or not (in which case cmd->result
1513 * and sense buffer are assumed to be set).
1516 * spin_lock_irqsave(host_set lock)
1519 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1520 unsigned int (*actor) (struct ata_scsi_args *args,
1521 u8 *rbuf, unsigned int buflen))
1524 unsigned int buflen, rc;
1525 struct scsi_cmnd *cmd = args->cmd;
1527 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1528 memset(rbuf, 0, buflen);
1529 rc = actor(args, rbuf, buflen);
1530 ata_scsi_rbuf_put(cmd, rbuf);
1533 cmd->result = SAM_STAT_GOOD;
1538 * ata_scsiop_inq_std - Simulate INQUIRY command
1539 * @args: device IDENTIFY data / SCSI command of interest.
1540 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1541 * @buflen: Response buffer length.
1543 * Returns standard device identification data associated
1544 * with non-VPD INQUIRY command output.
1547 * spin_lock_irqsave(host_set lock)
1550 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1551 unsigned int buflen)
1556 0x5, /* claim SPC-3 version compatibility */
1561 /* set scsi removeable (RMB) bit per ata bit */
1562 if (ata_id_removeable(args->id))
1567 memcpy(rbuf, hdr, sizeof(hdr));
1570 memcpy(&rbuf[8], "ATA ", 8);
1571 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1572 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1573 if (rbuf[32] == 0 || rbuf[32] == ' ')
1574 memcpy(&rbuf[32], "n/a ", 4);
1578 const u8 versions[] = {
1579 0x60, /* SAM-3 (no version claimed) */
1582 0x20, /* SBC-2 (no version claimed) */
1585 0x60 /* SPC-3 (no version claimed) */
1588 memcpy(rbuf + 59, versions, sizeof(versions));
1595 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1596 * @args: device IDENTIFY data / SCSI command of interest.
1597 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1598 * @buflen: Response buffer length.
1600 * Returns list of inquiry VPD pages available.
1603 * spin_lock_irqsave(host_set lock)
1606 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1607 unsigned int buflen)
1609 const u8 pages[] = {
1610 0x00, /* page 0x00, this page */
1611 0x80, /* page 0x80, unit serial no page */
1612 0x83 /* page 0x83, device ident page */
1614 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1617 memcpy(rbuf + 4, pages, sizeof(pages));
1623 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1624 * @args: device IDENTIFY data / SCSI command of interest.
1625 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1626 * @buflen: Response buffer length.
1628 * Returns ATA device serial number.
1631 * spin_lock_irqsave(host_set lock)
1634 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1635 unsigned int buflen)
1639 0x80, /* this page code */
1641 ATA_SERNO_LEN, /* page len */
1643 memcpy(rbuf, hdr, sizeof(hdr));
1645 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1646 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1647 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1653 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1654 * @args: device IDENTIFY data / SCSI command of interest.
1655 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1656 * @buflen: Response buffer length.
1658 * Yields two logical unit device identification designators:
1659 * - vendor specific ASCII containing the ATA serial number
1660 * - SAT defined "t10 vendor id based" containing ASCII vendor
1661 * name ("ATA "), model and serial numbers.
1664 * spin_lock_irqsave(host_set lock)
1667 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1668 unsigned int buflen)
1671 const int sat_model_serial_desc_len = 68;
1672 const int ata_model_byte_len = 40;
1674 rbuf[1] = 0x83; /* this page code */
1677 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1678 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1680 rbuf[num + 3] = ATA_SERNO_LEN;
1682 ata_id_string(args->id, (unsigned char *) rbuf + num,
1683 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1684 num += ATA_SERNO_LEN;
1686 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1687 /* SAT defined lu model and serial numbers descriptor */
1688 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1691 rbuf[num + 3] = sat_model_serial_desc_len;
1693 memcpy(rbuf + num, "ATA ", 8);
1695 ata_id_string(args->id, (unsigned char *) rbuf + num,
1696 ATA_ID_PROD_OFS, ata_model_byte_len);
1697 num += ata_model_byte_len;
1698 ata_id_string(args->id, (unsigned char *) rbuf + num,
1699 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1700 num += ATA_SERNO_LEN;
1702 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1707 * ata_scsiop_noop - Command handler that simply returns success.
1708 * @args: device IDENTIFY data / SCSI command of interest.
1709 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1710 * @buflen: Response buffer length.
1712 * No operation. Simply returns success to caller, to indicate
1713 * that the caller should successfully complete this SCSI command.
1716 * spin_lock_irqsave(host_set lock)
1719 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1720 unsigned int buflen)
1727 * ata_msense_push - Push data onto MODE SENSE data output buffer
1728 * @ptr_io: (input/output) Location to store more output data
1729 * @last: End of output data buffer
1730 * @buf: Pointer to BLOB being added to output buffer
1731 * @buflen: Length of BLOB
1733 * Store MODE SENSE data on an output buffer.
1739 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1740 const u8 *buf, unsigned int buflen)
1744 if ((ptr + buflen - 1) > last)
1747 memcpy(ptr, buf, buflen);
1755 * ata_msense_caching - Simulate MODE SENSE caching info page
1756 * @id: device IDENTIFY data
1757 * @ptr_io: (input/output) Location to store more output data
1758 * @last: End of output data buffer
1760 * Generate a caching info page, which conditionally indicates
1761 * write caching to the SCSI layer, depending on device
1768 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1771 u8 page[CACHE_MPAGE_LEN];
1773 memcpy(page, def_cache_mpage, sizeof(page));
1774 if (ata_id_wcache_enabled(id))
1775 page[2] |= (1 << 2); /* write cache enable */
1776 if (!ata_id_rahead_enabled(id))
1777 page[12] |= (1 << 5); /* disable read ahead */
1779 ata_msense_push(ptr_io, last, page, sizeof(page));
1780 return sizeof(page);
1784 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1785 * @dev: Device associated with this MODE SENSE command
1786 * @ptr_io: (input/output) Location to store more output data
1787 * @last: End of output data buffer
1789 * Generate a generic MODE SENSE control mode page.
1795 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1797 ata_msense_push(ptr_io, last, def_control_mpage,
1798 sizeof(def_control_mpage));
1799 return sizeof(def_control_mpage);
1803 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1804 * @dev: Device associated with this MODE SENSE command
1805 * @ptr_io: (input/output) Location to store more output data
1806 * @last: End of output data buffer
1808 * Generate a generic MODE SENSE r/w error recovery page.
1814 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1817 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1818 sizeof(def_rw_recovery_mpage));
1819 return sizeof(def_rw_recovery_mpage);
1823 * We can turn this into a real blacklist if it's needed, for now just
1824 * blacklist any Maxtor BANC1G10 revision firmware
1826 static int ata_dev_supports_fua(u16 *id)
1828 unsigned char model[41], fw[9];
1832 if (!ata_id_has_fua(id))
1835 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1836 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1838 if (strcmp(model, "Maxtor"))
1840 if (strcmp(fw, "BANC1G10"))
1843 return 0; /* blacklisted */
1847 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1848 * @args: device IDENTIFY data / SCSI command of interest.
1849 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1850 * @buflen: Response buffer length.
1852 * Simulate MODE SENSE commands. Assume this is invoked for direct
1853 * access devices (e.g. disks) only. There should be no block
1854 * descriptor for other device types.
1857 * spin_lock_irqsave(host_set lock)
1860 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1861 unsigned int buflen)
1863 struct ata_device *dev = args->dev;
1864 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1865 const u8 sat_blk_desc[] = {
1866 0, 0, 0, 0, /* number of blocks: sat unspecified */
1868 0, 0x2, 0x0 /* block length: 512 bytes */
1871 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1876 six_byte = (scsicmd[0] == MODE_SENSE);
1877 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1879 * LLBA bit in msense(10) ignored (compliant)
1882 page_control = scsicmd[2] >> 6;
1883 switch (page_control) {
1884 case 0: /* current */
1885 break; /* supported */
1887 goto saving_not_supp;
1888 case 1: /* changeable */
1889 case 2: /* defaults */
1895 output_len = 4 + (ebd ? 8 : 0);
1896 alloc_len = scsicmd[4];
1898 output_len = 8 + (ebd ? 8 : 0);
1899 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1901 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1903 p = rbuf + output_len;
1904 last = rbuf + minlen - 1;
1906 pg = scsicmd[2] & 0x3f;
1909 * No mode subpages supported (yet) but asking for _all_
1910 * subpages may be valid
1912 if (spg && (spg != ALL_SUB_MPAGES))
1916 case RW_RECOVERY_MPAGE:
1917 output_len += ata_msense_rw_recovery(&p, last);
1921 output_len += ata_msense_caching(args->id, &p, last);
1924 case CONTROL_MPAGE: {
1925 output_len += ata_msense_ctl_mode(&p, last);
1930 output_len += ata_msense_rw_recovery(&p, last);
1931 output_len += ata_msense_caching(args->id, &p, last);
1932 output_len += ata_msense_ctl_mode(&p, last);
1935 default: /* invalid page code */
1943 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1944 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1949 rbuf[0] = output_len;
1954 rbuf[3] = sizeof(sat_blk_desc);
1956 memcpy(rbuf + 4, sat_blk_desc,
1957 sizeof(sat_blk_desc));
1961 rbuf[0] = output_len >> 8;
1963 rbuf[1] = output_len;
1968 rbuf[7] = sizeof(sat_blk_desc);
1970 memcpy(rbuf + 8, sat_blk_desc,
1971 sizeof(sat_blk_desc));
1977 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1978 /* "Invalid field in cbd" */
1982 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1983 /* "Saving parameters not supported" */
1988 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1989 * @args: device IDENTIFY data / SCSI command of interest.
1990 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1991 * @buflen: Response buffer length.
1993 * Simulate READ CAPACITY commands.
1996 * spin_lock_irqsave(host_set lock)
1999 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2000 unsigned int buflen)
2007 if (ata_id_has_lba(args->id)) {
2008 if (ata_id_has_lba48(args->id))
2009 n_sectors = ata_id_u64(args->id, 100);
2011 n_sectors = ata_id_u32(args->id, 60);
2013 /* CHS default translation */
2014 n_sectors = args->id[1] * args->id[3] * args->id[6];
2016 if (ata_id_current_chs_valid(args->id))
2017 /* CHS current translation */
2018 n_sectors = ata_id_u32(args->id, 57);
2021 n_sectors--; /* ATA TotalUserSectors - 1 */
2023 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2024 if( n_sectors >= 0xffffffffULL )
2025 tmp = 0xffffffff ; /* Return max count on overflow */
2029 /* sector count, 32-bit */
2030 rbuf[0] = tmp >> (8 * 3);
2031 rbuf[1] = tmp >> (8 * 2);
2032 rbuf[2] = tmp >> (8 * 1);
2036 tmp = ATA_SECT_SIZE;
2041 /* sector count, 64-bit */
2042 tmp = n_sectors >> (8 * 4);
2043 rbuf[2] = tmp >> (8 * 3);
2044 rbuf[3] = tmp >> (8 * 2);
2045 rbuf[4] = tmp >> (8 * 1);
2048 rbuf[6] = tmp >> (8 * 3);
2049 rbuf[7] = tmp >> (8 * 2);
2050 rbuf[8] = tmp >> (8 * 1);
2054 tmp = ATA_SECT_SIZE;
2055 rbuf[12] = tmp >> 8;
2063 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2064 * @args: device IDENTIFY data / SCSI command of interest.
2065 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2066 * @buflen: Response buffer length.
2068 * Simulate REPORT LUNS command.
2071 * spin_lock_irqsave(host_set lock)
2074 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2075 unsigned int buflen)
2078 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2084 * ata_scsi_set_sense - Set SCSI sense data and status
2085 * @cmd: SCSI request to be handled
2086 * @sk: SCSI-defined sense key
2087 * @asc: SCSI-defined additional sense code
2088 * @ascq: SCSI-defined additional sense code qualifier
2090 * Helper function that builds a valid fixed format, current
2091 * response code and the given sense key (sk), additional sense
2092 * code (asc) and additional sense code qualifier (ascq) with
2093 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2094 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2100 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2102 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2104 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2105 cmd->sense_buffer[2] = sk;
2106 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2107 cmd->sense_buffer[12] = asc;
2108 cmd->sense_buffer[13] = ascq;
2112 * ata_scsi_badcmd - End a SCSI request with an error
2113 * @cmd: SCSI request to be handled
2114 * @done: SCSI command completion function
2115 * @asc: SCSI-defined additional sense code
2116 * @ascq: SCSI-defined additional sense code qualifier
2118 * Helper function that completes a SCSI command with
2119 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2120 * and the specified additional sense codes.
2123 * spin_lock_irqsave(host_set lock)
2126 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2129 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2134 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2136 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
2137 /* FIXME: not quite right; we don't want the
2138 * translation of taskfile registers into
2139 * a sense descriptors, since that's only
2140 * correct for ATA, not ATAPI
2142 ata_gen_ata_desc_sense(qc);
2144 qc->scsidone(qc->scsicmd);
2148 /* is it pointless to prefer PIO for "safety reasons"? */
2149 static inline int ata_pio_use_silly(struct ata_port *ap)
2151 return (ap->flags & ATA_FLAG_PIO_DMA);
2154 static void atapi_request_sense(struct ata_queued_cmd *qc)
2156 struct ata_port *ap = qc->ap;
2157 struct scsi_cmnd *cmd = qc->scsicmd;
2159 DPRINTK("ATAPI request sense\n");
2161 /* FIXME: is this needed? */
2162 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2164 ap->ops->tf_read(ap, &qc->tf);
2166 /* fill these in, for the case where they are -not- overwritten */
2167 cmd->sense_buffer[0] = 0x70;
2168 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2172 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2173 qc->dma_dir = DMA_FROM_DEVICE;
2175 memset(&qc->cdb, 0, qc->dev->cdb_len);
2176 qc->cdb[0] = REQUEST_SENSE;
2177 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2179 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2180 qc->tf.command = ATA_CMD_PACKET;
2182 if (ata_pio_use_silly(ap)) {
2183 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2184 qc->tf.feature |= ATAPI_PKT_DMA;
2186 qc->tf.protocol = ATA_PROT_ATAPI;
2187 qc->tf.lbam = (8 * 1024) & 0xff;
2188 qc->tf.lbah = (8 * 1024) >> 8;
2190 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2192 qc->complete_fn = atapi_sense_complete;
2199 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2201 struct scsi_cmnd *cmd = qc->scsicmd;
2202 unsigned int err_mask = qc->err_mask;
2204 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2206 if (unlikely(err_mask & AC_ERR_DEV)) {
2207 cmd->result = SAM_STAT_CHECK_CONDITION;
2208 atapi_request_sense(qc);
2212 else if (unlikely(err_mask))
2213 /* FIXME: not quite right; we don't want the
2214 * translation of taskfile registers into
2215 * a sense descriptors, since that's only
2216 * correct for ATA, not ATAPI
2218 ata_gen_ata_desc_sense(qc);
2221 u8 *scsicmd = cmd->cmnd;
2223 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2225 unsigned int buflen;
2227 buflen = ata_scsi_rbuf_get(cmd, &buf);
2229 /* ATAPI devices typically report zero for their SCSI version,
2230 * and sometimes deviate from the spec WRT response data
2231 * format. If SCSI version is reported as zero like normal,
2232 * then we make the following fixups: 1) Fake MMC-5 version,
2233 * to indicate to the Linux scsi midlayer this is a modern
2234 * device. 2) Ensure response data format / ATAPI information
2235 * are always correct.
2242 ata_scsi_rbuf_put(cmd, buf);
2245 cmd->result = SAM_STAT_GOOD;
2252 * atapi_xlat - Initialize PACKET taskfile
2253 * @qc: command structure to be initialized
2254 * @scsicmd: SCSI CDB associated with this PACKET command
2257 * spin_lock_irqsave(host_set lock)
2260 * Zero on success, non-zero on failure.
2263 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2265 struct scsi_cmnd *cmd = qc->scsicmd;
2266 struct ata_device *dev = qc->dev;
2267 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2268 int nodata = (cmd->sc_data_direction == DMA_NONE);
2271 /* Check whether ATAPI DMA is safe */
2272 if (ata_check_atapi_dma(qc))
2275 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2277 qc->complete_fn = atapi_qc_complete;
2279 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2280 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2281 qc->tf.flags |= ATA_TFLAG_WRITE;
2282 DPRINTK("direction: write\n");
2285 qc->tf.command = ATA_CMD_PACKET;
2287 /* no data, or PIO data xfer */
2288 if (using_pio || nodata) {
2290 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2292 qc->tf.protocol = ATA_PROT_ATAPI;
2293 qc->tf.lbam = (8 * 1024) & 0xff;
2294 qc->tf.lbah = (8 * 1024) >> 8;
2299 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2300 qc->tf.feature |= ATAPI_PKT_DMA;
2302 #ifdef ATAPI_ENABLE_DMADIR
2303 /* some SATA bridges need us to indicate data xfer direction */
2304 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2305 qc->tf.feature |= ATAPI_DMADIR;
2309 qc->nbytes = cmd->bufflen;
2315 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2316 * @ap: ATA port to which the device is attached
2317 * @scsidev: SCSI device from which we derive the ATA device
2319 * Given various information provided in struct scsi_cmnd,
2320 * map that onto an ATA bus, and using that mapping
2321 * determine which ata_device is associated with the
2322 * SCSI command to be sent.
2325 * spin_lock_irqsave(host_set lock)
2328 * Associated ATA device, or %NULL if not found.
2331 static struct ata_device *
2332 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2334 struct ata_device *dev;
2336 /* skip commands not addressed to targets we simulate */
2337 if (likely(scsidev->id < ATA_MAX_DEVICES))
2338 dev = &ap->device[scsidev->id];
2342 if (unlikely((scsidev->channel != 0) ||
2343 (scsidev->lun != 0)))
2346 if (unlikely(!ata_dev_enabled(dev)))
2349 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2350 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2351 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2352 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
2361 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2362 * @byte1: Byte 1 from pass-thru CDB.
2365 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2368 ata_scsi_map_proto(u8 byte1)
2370 switch((byte1 & 0x1e) >> 1) {
2371 case 3: /* Non-data */
2372 return ATA_PROT_NODATA;
2375 return ATA_PROT_DMA;
2377 case 4: /* PIO Data-in */
2378 case 5: /* PIO Data-out */
2379 return ATA_PROT_PIO;
2381 case 10: /* Device Reset */
2382 case 0: /* Hard Reset */
2384 case 2: /* Bus Idle */
2385 case 7: /* Packet */
2386 case 8: /* DMA Queued */
2387 case 9: /* Device Diagnostic */
2388 case 11: /* UDMA Data-in */
2389 case 12: /* UDMA Data-Out */
2390 case 13: /* FPDMA */
2391 default: /* Reserved */
2395 return ATA_PROT_UNKNOWN;
2399 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2400 * @qc: command structure to be initialized
2401 * @scsicmd: SCSI command to convert
2403 * Handles either 12 or 16-byte versions of the CDB.
2406 * Zero on success, non-zero on failure.
2409 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2411 struct ata_taskfile *tf = &(qc->tf);
2412 struct scsi_cmnd *cmd = qc->scsicmd;
2414 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2417 if (scsicmd[1] & 0xe0)
2418 /* PIO multi not supported yet */
2422 * 12 and 16 byte CDBs use different offsets to
2423 * provide the various register values.
2425 if (scsicmd[0] == ATA_16) {
2427 * 16-byte CDB - may contain extended commands.
2429 * If that is the case, copy the upper byte register values.
2431 if (scsicmd[1] & 0x01) {
2432 tf->hob_feature = scsicmd[3];
2433 tf->hob_nsect = scsicmd[5];
2434 tf->hob_lbal = scsicmd[7];
2435 tf->hob_lbam = scsicmd[9];
2436 tf->hob_lbah = scsicmd[11];
2437 tf->flags |= ATA_TFLAG_LBA48;
2439 tf->flags &= ~ATA_TFLAG_LBA48;
2442 * Always copy low byte, device and command registers.
2444 tf->feature = scsicmd[4];
2445 tf->nsect = scsicmd[6];
2446 tf->lbal = scsicmd[8];
2447 tf->lbam = scsicmd[10];
2448 tf->lbah = scsicmd[12];
2449 tf->device = scsicmd[13];
2450 tf->command = scsicmd[14];
2453 * 12-byte CDB - incapable of extended commands.
2455 tf->flags &= ~ATA_TFLAG_LBA48;
2457 tf->feature = scsicmd[3];
2458 tf->nsect = scsicmd[4];
2459 tf->lbal = scsicmd[5];
2460 tf->lbam = scsicmd[6];
2461 tf->lbah = scsicmd[7];
2462 tf->device = scsicmd[8];
2463 tf->command = scsicmd[9];
2466 * If slave is possible, enforce correct master/slave bit
2468 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2469 tf->device = qc->dev->devno ?
2470 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2473 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2474 * SET_FEATURES - XFER MODE must be preceded/succeeded
2475 * by an update to hardware-specific registers for each
2476 * controller (i.e. the reason for ->set_piomode(),
2477 * ->set_dmamode(), and ->post_set_mode() hooks).
2479 if ((tf->command == ATA_CMD_SET_FEATURES)
2480 && (tf->feature == SETFEATURES_XFER))
2484 * Set flags so that all registers will be written,
2485 * and pass on write indication (used for PIO/DMA
2488 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2490 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2491 tf->flags |= ATA_TFLAG_WRITE;
2494 * Set transfer length.
2496 * TODO: find out if we need to do more here to
2497 * cover scatter/gather case.
2499 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2504 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2505 /* "Invalid field in cdb" */
2510 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2512 * @cmd: SCSI command opcode to consider
2514 * Look up the SCSI command given, and determine whether the
2515 * SCSI command is to be translated or simulated.
2518 * Pointer to translation function if possible, %NULL if not.
2521 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2531 return ata_scsi_rw_xlat;
2533 case SYNCHRONIZE_CACHE:
2534 if (ata_try_flush_cache(dev))
2535 return ata_scsi_flush_xlat;
2540 return ata_scsi_verify_xlat;
2544 return ata_scsi_pass_thru;
2547 return ata_scsi_start_stop_xlat;
2554 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2555 * @ap: ATA port to which the command was being sent
2556 * @cmd: SCSI command to dump
2558 * Prints the contents of a SCSI command via printk().
2561 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2562 struct scsi_cmnd *cmd)
2565 struct scsi_device *scsidev = cmd->device;
2566 u8 *scsicmd = cmd->cmnd;
2568 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2570 scsidev->channel, scsidev->id, scsidev->lun,
2571 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2572 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2577 static inline void __ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
2578 struct ata_port *ap, struct ata_device *dev)
2580 if (dev->class == ATA_DEV_ATA) {
2581 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2585 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2587 ata_scsi_simulate(ap, dev, cmd, done);
2589 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2593 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2594 * @cmd: SCSI command to be sent
2595 * @done: Completion function, called when command is complete
2597 * In some cases, this function translates SCSI commands into
2598 * ATA taskfiles, and queues the taskfiles to be sent to
2599 * hardware. In other cases, this function simulates a
2600 * SCSI device by evaluating and responding to certain
2601 * SCSI commands. This creates the overall effect of
2602 * ATA and ATAPI devices appearing as SCSI devices.
2605 * Releases scsi-layer-held lock, and obtains host_set lock.
2611 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2613 struct ata_port *ap;
2614 struct ata_device *dev;
2615 struct scsi_device *scsidev = cmd->device;
2616 struct Scsi_Host *shost = scsidev->host;
2618 ap = (struct ata_port *) &shost->hostdata[0];
2620 spin_unlock(shost->host_lock);
2621 spin_lock(&ap->host_set->lock);
2623 ata_scsi_dump_cdb(ap, cmd);
2625 dev = ata_scsi_find_dev(ap, scsidev);
2627 __ata_scsi_queuecmd(cmd, done, ap, dev);
2629 cmd->result = (DID_BAD_TARGET << 16);
2633 spin_unlock(&ap->host_set->lock);
2634 spin_lock(shost->host_lock);
2639 * ata_scsi_simulate - simulate SCSI command on ATA device
2640 * @ap: port the device is connected to
2641 * @dev: the target device
2642 * @cmd: SCSI command being sent to device.
2643 * @done: SCSI command completion function.
2645 * Interprets and directly executes a select list of SCSI commands
2646 * that can be handled internally.
2649 * spin_lock_irqsave(host_set lock)
2652 void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
2653 struct scsi_cmnd *cmd,
2654 void (*done)(struct scsi_cmnd *))
2656 struct ata_scsi_args args;
2657 const u8 *scsicmd = cmd->cmnd;
2665 switch(scsicmd[0]) {
2666 /* no-op's, complete with success */
2667 case SYNCHRONIZE_CACHE:
2671 case TEST_UNIT_READY:
2672 case FORMAT_UNIT: /* FIXME: correct? */
2673 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2674 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2678 if (scsicmd[1] & 2) /* is CmdDt set? */
2679 ata_scsi_invalid_field(cmd, done);
2680 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2681 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2682 else if (scsicmd[2] == 0x00)
2683 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2684 else if (scsicmd[2] == 0x80)
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2686 else if (scsicmd[2] == 0x83)
2687 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2689 ata_scsi_invalid_field(cmd, done);
2694 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2697 case MODE_SELECT: /* unconditionally return */
2698 case MODE_SELECT_10: /* bad-field-in-cdb */
2699 ata_scsi_invalid_field(cmd, done);
2703 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2706 case SERVICE_ACTION_IN:
2707 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2708 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2710 ata_scsi_invalid_field(cmd, done);
2714 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2717 /* mandatory commands we haven't implemented yet */
2720 /* all other commands */
2722 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2723 /* "Invalid command operation code" */
2729 void ata_scsi_scan_host(struct ata_port *ap)
2731 struct ata_device *dev;
2734 if (ap->flags & ATA_FLAG_DISABLED)
2737 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2738 dev = &ap->device[i];
2740 if (ata_dev_enabled(dev))
2741 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);