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.
558 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
559 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
560 &sb[1], &sb[2], &sb[3]);
565 * Sense data is current and format is descriptor.
572 * Set length of additional sense data.
573 * Since we only populate descriptor 0, the total
574 * length is the same (fixed) length as descriptor 0.
576 desc[1] = sb[7] = 14;
579 * Copy registers into sense buffer.
582 desc[3] = tf->feature; /* == error reg */
587 desc[12] = tf->device;
588 desc[13] = tf->command; /* == status reg */
591 * Fill in Extend bit, and the high order bytes
594 if (tf->flags & ATA_TFLAG_LBA48) {
596 desc[4] = tf->hob_nsect;
597 desc[6] = tf->hob_lbal;
598 desc[8] = tf->hob_lbam;
599 desc[10] = tf->hob_lbah;
604 * ata_gen_fixed_sense - generate a SCSI fixed sense block
605 * @qc: Command that we are erroring out
607 * Leverage ata_to_sense_error() to give us the codes. Fit our
608 * LBA in here if there's room.
611 * inherited from caller
613 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
615 struct scsi_cmnd *cmd = qc->scsicmd;
616 struct ata_taskfile *tf = &qc->tf;
617 unsigned char *sb = cmd->sense_buffer;
619 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
621 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
624 * Read the controller registers.
626 WARN_ON(qc->ap->ops->tf_read == NULL);
627 qc->ap->ops->tf_read(qc->ap, tf);
630 * Use ata_to_sense_error() to map status register bits
631 * onto sense key, asc & ascq.
633 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
634 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
635 &sb[2], &sb[12], &sb[13]);
642 if (tf->flags & ATA_TFLAG_LBA48) {
643 /* TODO: find solution for LBA48 descriptors */
646 else if (tf->flags & ATA_TFLAG_LBA) {
647 /* A small (28b) LBA will fit in the 32b info field */
648 sb[0] |= 0x80; /* set valid bit */
649 sb[3] = tf->device & 0x0f;
660 static void ata_scsi_sdev_config(struct scsi_device *sdev)
662 sdev->use_10_for_rw = 1;
663 sdev->use_10_for_ms = 1;
666 static void ata_scsi_dev_config(struct scsi_device *sdev,
667 struct ata_device *dev)
669 unsigned int max_sectors;
671 /* TODO: 2048 is an arbitrary number, not the
672 * hardware maximum. This should be increased to
673 * 65534 when Jens Axboe's patch for dynamically
674 * determining max_sectors is merged.
676 max_sectors = ATA_MAX_SECTORS;
677 if (dev->flags & ATA_DFLAG_LBA48)
679 if (dev->max_sectors)
680 max_sectors = dev->max_sectors;
682 blk_queue_max_sectors(sdev->request_queue, max_sectors);
685 * SATA DMA transfers must be multiples of 4 byte, so
686 * we need to pad ATAPI transfers using an extra sg.
687 * Decrement max hw segments accordingly.
689 if (dev->class == ATA_DEV_ATAPI) {
690 request_queue_t *q = sdev->request_queue;
691 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
696 * ata_scsi_slave_config - Set SCSI device attributes
697 * @sdev: SCSI device to examine
699 * This is called before we actually start reading
700 * and writing to the device, to configure certain
701 * SCSI mid-layer behaviors.
704 * Defined by SCSI layer. We don't really care.
707 int ata_scsi_slave_config(struct scsi_device *sdev)
709 ata_scsi_sdev_config(sdev);
711 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
713 if (sdev->id < ATA_MAX_DEVICES) {
715 struct ata_device *dev;
717 ap = (struct ata_port *) &sdev->host->hostdata[0];
718 dev = &ap->device[sdev->id];
720 ata_scsi_dev_config(sdev, dev);
723 return 0; /* scsi layer doesn't check return value, sigh */
727 * ata_scsi_timed_out - SCSI layer time out callback
728 * @cmd: timed out SCSI command
730 * Handles SCSI layer timeout. We race with normal completion of
731 * the qc for @cmd. If the qc is already gone, we lose and let
732 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
733 * timed out and EH should be invoked. Prevent ata_qc_complete()
734 * from finishing it by setting EH_SCHEDULED and return
738 * Called from timer context
741 * EH_HANDLED or EH_NOT_HANDLED
743 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
745 struct Scsi_Host *host = cmd->device->host;
746 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
748 struct ata_queued_cmd *qc;
749 enum scsi_eh_timer_return ret = EH_HANDLED;
753 spin_lock_irqsave(&ap->host_set->lock, flags);
754 qc = ata_qc_from_tag(ap, ap->active_tag);
756 WARN_ON(qc->scsicmd != cmd);
757 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
758 qc->err_mask |= AC_ERR_TIMEOUT;
759 ret = EH_NOT_HANDLED;
761 spin_unlock_irqrestore(&ap->host_set->lock, flags);
763 DPRINTK("EXIT, ret=%d\n", ret);
768 * ata_scsi_error - SCSI layer error handler callback
769 * @host: SCSI host on which error occurred
771 * Handles SCSI-layer-thrown error events.
774 * Inherited from SCSI layer (none, can sleep)
780 int ata_scsi_error(struct Scsi_Host *host)
782 struct ata_port *ap = (struct ata_port *)&host->hostdata[0];
786 /* synchronize with IRQ handler and port task */
787 spin_unlock_wait(&ap->host_set->lock);
788 ata_port_flush_task(ap);
790 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
792 ap->ops->eng_timeout(ap);
794 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
796 scsi_eh_flush_done_q(&ap->eh_done_q);
802 static void ata_eh_scsidone(struct scsi_cmnd *scmd)
807 static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
809 struct ata_port *ap = qc->ap;
810 struct scsi_cmnd *scmd = qc->scsicmd;
813 spin_lock_irqsave(&ap->host_set->lock, flags);
814 qc->scsidone = ata_eh_scsidone;
815 __ata_qc_complete(qc);
816 WARN_ON(ata_tag_valid(qc->tag));
817 spin_unlock_irqrestore(&ap->host_set->lock, flags);
819 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
823 * ata_eh_qc_complete - Complete an active ATA command from EH
824 * @qc: Command to complete
826 * Indicate to the mid and upper layers that an ATA command has
827 * completed. To be used from EH.
829 void ata_eh_qc_complete(struct ata_queued_cmd *qc)
831 struct scsi_cmnd *scmd = qc->scsicmd;
832 scmd->retries = scmd->allowed;
833 __ata_eh_qc_complete(qc);
837 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
838 * @qc: Command to retry
840 * Indicate to the mid and upper layers that an ATA command
841 * should be retried. To be used from EH.
843 * SCSI midlayer limits the number of retries to scmd->allowed.
844 * This function might need to adjust scmd->retries for commands
845 * which get retried due to unrelated NCQ failures.
847 void ata_eh_qc_retry(struct ata_queued_cmd *qc)
849 __ata_eh_qc_complete(qc);
853 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
854 * @qc: Storage for translated ATA taskfile
855 * @scsicmd: SCSI command to translate
857 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
858 * (to start). Perhaps these commands should be preceded by
859 * CHECK POWER MODE to see what power mode the device is already in.
860 * [See SAT revision 5 at www.t10.org]
863 * spin_lock_irqsave(host_set lock)
866 * Zero on success, non-zero on error.
869 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
872 struct ata_taskfile *tf = &qc->tf;
874 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
875 tf->protocol = ATA_PROT_NODATA;
876 if (scsicmd[1] & 0x1) {
877 ; /* ignore IMMED bit, violates sat-r05 */
879 if (scsicmd[4] & 0x2)
880 goto invalid_fld; /* LOEJ bit set not supported */
881 if (((scsicmd[4] >> 4) & 0xf) != 0)
882 goto invalid_fld; /* power conditions not supported */
883 if (scsicmd[4] & 0x1) {
884 tf->nsect = 1; /* 1 sector, lba=0 */
886 if (qc->dev->flags & ATA_DFLAG_LBA) {
887 qc->tf.flags |= ATA_TFLAG_LBA;
892 tf->device |= ATA_LBA;
895 tf->lbal = 0x1; /* sect */
896 tf->lbam = 0x0; /* cyl low */
897 tf->lbah = 0x0; /* cyl high */
900 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
902 tf->nsect = 0; /* time period value (0 implies now) */
903 tf->command = ATA_CMD_STANDBY;
904 /* Consider: ATA STANDBY IMMEDIATE command */
907 * Standby and Idle condition timers could be implemented but that
908 * would require libata to implement the Power condition mode page
909 * and allow the user to change it. Changing mode pages requires
910 * MODE SELECT to be implemented.
916 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
917 /* "Invalid field in cbd" */
923 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
924 * @qc: Storage for translated ATA taskfile
925 * @scsicmd: SCSI command to translate (ignored)
927 * Sets up an ATA taskfile to issue FLUSH CACHE or
931 * spin_lock_irqsave(host_set lock)
934 * Zero on success, non-zero on error.
937 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
939 struct ata_taskfile *tf = &qc->tf;
941 tf->flags |= ATA_TFLAG_DEVICE;
942 tf->protocol = ATA_PROT_NODATA;
944 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
945 (ata_id_has_flush_ext(qc->dev->id)))
946 tf->command = ATA_CMD_FLUSH_EXT;
948 tf->command = ATA_CMD_FLUSH;
954 * scsi_6_lba_len - Get LBA and transfer length
955 * @scsicmd: SCSI command to translate
957 * Calculate LBA and transfer length for 6-byte commands.
961 * @plen: the transfer length
964 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
969 VPRINTK("six-byte command\n");
971 lba |= ((u64)scsicmd[2]) << 8;
972 lba |= ((u64)scsicmd[3]);
974 len |= ((u32)scsicmd[4]);
981 * scsi_10_lba_len - Get LBA and transfer length
982 * @scsicmd: SCSI command to translate
984 * Calculate LBA and transfer length for 10-byte commands.
988 * @plen: the transfer length
991 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
996 VPRINTK("ten-byte command\n");
998 lba |= ((u64)scsicmd[2]) << 24;
999 lba |= ((u64)scsicmd[3]) << 16;
1000 lba |= ((u64)scsicmd[4]) << 8;
1001 lba |= ((u64)scsicmd[5]);
1003 len |= ((u32)scsicmd[7]) << 8;
1004 len |= ((u32)scsicmd[8]);
1011 * scsi_16_lba_len - Get LBA and transfer length
1012 * @scsicmd: SCSI command to translate
1014 * Calculate LBA and transfer length for 16-byte commands.
1018 * @plen: the transfer length
1021 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1026 VPRINTK("sixteen-byte command\n");
1028 lba |= ((u64)scsicmd[2]) << 56;
1029 lba |= ((u64)scsicmd[3]) << 48;
1030 lba |= ((u64)scsicmd[4]) << 40;
1031 lba |= ((u64)scsicmd[5]) << 32;
1032 lba |= ((u64)scsicmd[6]) << 24;
1033 lba |= ((u64)scsicmd[7]) << 16;
1034 lba |= ((u64)scsicmd[8]) << 8;
1035 lba |= ((u64)scsicmd[9]);
1037 len |= ((u32)scsicmd[10]) << 24;
1038 len |= ((u32)scsicmd[11]) << 16;
1039 len |= ((u32)scsicmd[12]) << 8;
1040 len |= ((u32)scsicmd[13]);
1047 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1048 * @qc: Storage for translated ATA taskfile
1049 * @scsicmd: SCSI command to translate
1051 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1054 * spin_lock_irqsave(host_set lock)
1057 * Zero on success, non-zero on error.
1060 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1062 struct ata_taskfile *tf = &qc->tf;
1063 struct ata_device *dev = qc->dev;
1064 u64 dev_sectors = qc->dev->n_sectors;
1068 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1069 tf->protocol = ATA_PROT_NODATA;
1071 if (scsicmd[0] == VERIFY)
1072 scsi_10_lba_len(scsicmd, &block, &n_block);
1073 else if (scsicmd[0] == VERIFY_16)
1074 scsi_16_lba_len(scsicmd, &block, &n_block);
1080 if (block >= dev_sectors)
1082 if ((block + n_block) > dev_sectors)
1085 if (dev->flags & ATA_DFLAG_LBA) {
1086 tf->flags |= ATA_TFLAG_LBA;
1088 if (lba_28_ok(block, n_block)) {
1090 tf->command = ATA_CMD_VERIFY;
1091 tf->device |= (block >> 24) & 0xf;
1092 } else if (lba_48_ok(block, n_block)) {
1093 if (!(dev->flags & ATA_DFLAG_LBA48))
1097 tf->flags |= ATA_TFLAG_LBA48;
1098 tf->command = ATA_CMD_VERIFY_EXT;
1100 tf->hob_nsect = (n_block >> 8) & 0xff;
1102 tf->hob_lbah = (block >> 40) & 0xff;
1103 tf->hob_lbam = (block >> 32) & 0xff;
1104 tf->hob_lbal = (block >> 24) & 0xff;
1106 /* request too large even for LBA48 */
1109 tf->nsect = n_block & 0xff;
1111 tf->lbah = (block >> 16) & 0xff;
1112 tf->lbam = (block >> 8) & 0xff;
1113 tf->lbal = block & 0xff;
1115 tf->device |= ATA_LBA;
1118 u32 sect, head, cyl, track;
1120 if (!lba_28_ok(block, n_block))
1123 /* Convert LBA to CHS */
1124 track = (u32)block / dev->sectors;
1125 cyl = track / dev->heads;
1126 head = track % dev->heads;
1127 sect = (u32)block % dev->sectors + 1;
1129 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1130 (u32)block, track, cyl, head, sect);
1132 /* Check whether the converted CHS can fit.
1136 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1139 tf->command = ATA_CMD_VERIFY;
1140 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1143 tf->lbah = cyl >> 8;
1150 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1151 /* "Invalid field in cbd" */
1155 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1156 /* "Logical Block Address out of range" */
1160 qc->scsicmd->result = SAM_STAT_GOOD;
1165 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1166 * @qc: Storage for translated ATA taskfile
1167 * @scsicmd: SCSI command to translate
1169 * Converts any of six SCSI read/write commands into the
1170 * ATA counterpart, including starting sector (LBA),
1171 * sector count, and taking into account the device's LBA48
1174 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1175 * %WRITE_16 are currently supported.
1178 * spin_lock_irqsave(host_set lock)
1181 * Zero on success, non-zero on error.
1184 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1186 struct ata_taskfile *tf = &qc->tf;
1187 struct ata_device *dev = qc->dev;
1191 qc->flags |= ATA_QCFLAG_IO;
1192 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1194 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1195 scsicmd[0] == WRITE_16)
1196 tf->flags |= ATA_TFLAG_WRITE;
1198 /* Calculate the SCSI LBA, transfer length and FUA. */
1199 switch (scsicmd[0]) {
1202 scsi_10_lba_len(scsicmd, &block, &n_block);
1203 if (unlikely(scsicmd[1] & (1 << 3)))
1204 tf->flags |= ATA_TFLAG_FUA;
1208 scsi_6_lba_len(scsicmd, &block, &n_block);
1210 /* for 6-byte r/w commands, transfer length 0
1211 * means 256 blocks of data, not 0 block.
1218 scsi_16_lba_len(scsicmd, &block, &n_block);
1219 if (unlikely(scsicmd[1] & (1 << 3)))
1220 tf->flags |= ATA_TFLAG_FUA;
1223 DPRINTK("no-byte command\n");
1227 /* Check and compose ATA command */
1229 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1230 * length 0 means transfer 0 block of data.
1231 * However, for ATA R/W commands, sector count 0 means
1232 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1234 * WARNING: one or two older ATA drives treat 0 as 0...
1238 if (dev->flags & ATA_DFLAG_LBA) {
1239 tf->flags |= ATA_TFLAG_LBA;
1241 if (lba_28_ok(block, n_block)) {
1243 tf->device |= (block >> 24) & 0xf;
1244 } else if (lba_48_ok(block, n_block)) {
1245 if (!(dev->flags & ATA_DFLAG_LBA48))
1249 tf->flags |= ATA_TFLAG_LBA48;
1251 tf->hob_nsect = (n_block >> 8) & 0xff;
1253 tf->hob_lbah = (block >> 40) & 0xff;
1254 tf->hob_lbam = (block >> 32) & 0xff;
1255 tf->hob_lbal = (block >> 24) & 0xff;
1257 /* request too large even for LBA48 */
1260 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1263 qc->nsect = n_block;
1264 tf->nsect = n_block & 0xff;
1266 tf->lbah = (block >> 16) & 0xff;
1267 tf->lbam = (block >> 8) & 0xff;
1268 tf->lbal = block & 0xff;
1270 tf->device |= ATA_LBA;
1273 u32 sect, head, cyl, track;
1275 /* The request -may- be too large for CHS addressing. */
1276 if (!lba_28_ok(block, n_block))
1279 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1282 /* Convert LBA to CHS */
1283 track = (u32)block / dev->sectors;
1284 cyl = track / dev->heads;
1285 head = track % dev->heads;
1286 sect = (u32)block % dev->sectors + 1;
1288 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1289 (u32)block, track, cyl, head, sect);
1291 /* Check whether the converted CHS can fit.
1295 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1298 qc->nsect = n_block;
1299 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1302 tf->lbah = cyl >> 8;
1309 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1310 /* "Invalid field in cbd" */
1314 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1315 /* "Logical Block Address out of range" */
1319 qc->scsicmd->result = SAM_STAT_GOOD;
1323 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1325 struct scsi_cmnd *cmd = qc->scsicmd;
1326 u8 *cdb = cmd->cmnd;
1327 int need_sense = (qc->err_mask != 0);
1329 /* For ATA pass thru (SAT) commands, generate a sense block if
1330 * user mandated it or if there's an error. Note that if we
1331 * generate because the user forced us to, a check condition
1332 * is generated and the ATA register values are returned
1333 * whether the command completed successfully or not. If there
1334 * was no error, SK, ASC and ASCQ will all be zero.
1336 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1337 ((cdb[2] & 0x20) || need_sense)) {
1338 ata_gen_ata_desc_sense(qc);
1341 cmd->result = SAM_STAT_GOOD;
1343 /* TODO: decide which descriptor format to use
1344 * for 48b LBA devices and call that here
1345 * instead of the fixed desc, which is only
1346 * good for smaller LBA (and maybe CHS?)
1349 ata_gen_fixed_sense(qc);
1354 /* The ata_gen_..._sense routines fill in tf */
1355 ata_dump_status(qc->ap->id, &qc->tf);
1364 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1365 * @ap: ATA port to which the command is addressed
1366 * @dev: ATA device to which the command is addressed
1367 * @cmd: SCSI command to execute
1368 * @done: SCSI command completion function
1369 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1371 * Our ->queuecommand() function has decided that the SCSI
1372 * command issued can be directly translated into an ATA
1373 * command, rather than handled internally.
1375 * This function sets up an ata_queued_cmd structure for the
1376 * SCSI command, and sends that ata_queued_cmd to the hardware.
1378 * The xlat_func argument (actor) returns 0 if ready to execute
1379 * ATA command, else 1 to finish translation. If 1 is returned
1380 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1381 * to be set reflecting an error condition or clean (early)
1385 * spin_lock_irqsave(host_set lock)
1388 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1389 struct scsi_cmnd *cmd,
1390 void (*done)(struct scsi_cmnd *),
1391 ata_xlat_func_t xlat_func)
1393 struct ata_queued_cmd *qc;
1394 u8 *scsicmd = cmd->cmnd;
1398 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1402 /* data is present; dma-map it */
1403 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1404 cmd->sc_data_direction == DMA_TO_DEVICE) {
1405 if (unlikely(cmd->request_bufflen < 1)) {
1406 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1407 ap->id, dev->devno);
1412 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1414 ata_sg_init_one(qc, cmd->request_buffer,
1415 cmd->request_bufflen);
1417 qc->dma_dir = cmd->sc_data_direction;
1420 qc->complete_fn = ata_scsi_qc_complete;
1422 if (xlat_func(qc, scsicmd))
1425 /* select device, send command to hardware */
1434 DPRINTK("EXIT - early finish (good or error)\n");
1440 cmd->result = (DID_ERROR << 16);
1442 DPRINTK("EXIT - internal\n");
1447 * ata_scsi_rbuf_get - Map response buffer.
1448 * @cmd: SCSI command containing buffer to be mapped.
1449 * @buf_out: Pointer to mapped area.
1451 * Maps buffer contained within SCSI command @cmd.
1454 * spin_lock_irqsave(host_set lock)
1457 * Length of response buffer.
1460 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1463 unsigned int buflen;
1466 struct scatterlist *sg;
1468 sg = (struct scatterlist *) cmd->request_buffer;
1469 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1470 buflen = sg->length;
1472 buf = cmd->request_buffer;
1473 buflen = cmd->request_bufflen;
1481 * ata_scsi_rbuf_put - Unmap response buffer.
1482 * @cmd: SCSI command containing buffer to be unmapped.
1483 * @buf: buffer to unmap
1485 * Unmaps response buffer contained within @cmd.
1488 * spin_lock_irqsave(host_set lock)
1491 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1494 struct scatterlist *sg;
1496 sg = (struct scatterlist *) cmd->request_buffer;
1497 kunmap_atomic(buf - sg->offset, KM_USER0);
1502 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1503 * @args: device IDENTIFY data / SCSI command of interest.
1504 * @actor: Callback hook for desired SCSI command simulator
1506 * Takes care of the hard work of simulating a SCSI command...
1507 * Mapping the response buffer, calling the command's handler,
1508 * and handling the handler's return value. This return value
1509 * indicates whether the handler wishes the SCSI command to be
1510 * completed successfully (0), or not (in which case cmd->result
1511 * and sense buffer are assumed to be set).
1514 * spin_lock_irqsave(host_set lock)
1517 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1518 unsigned int (*actor) (struct ata_scsi_args *args,
1519 u8 *rbuf, unsigned int buflen))
1522 unsigned int buflen, rc;
1523 struct scsi_cmnd *cmd = args->cmd;
1525 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1526 memset(rbuf, 0, buflen);
1527 rc = actor(args, rbuf, buflen);
1528 ata_scsi_rbuf_put(cmd, rbuf);
1531 cmd->result = SAM_STAT_GOOD;
1536 * ata_scsiop_inq_std - Simulate INQUIRY command
1537 * @args: device IDENTIFY data / SCSI command of interest.
1538 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1539 * @buflen: Response buffer length.
1541 * Returns standard device identification data associated
1542 * with non-VPD INQUIRY command output.
1545 * spin_lock_irqsave(host_set lock)
1548 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1549 unsigned int buflen)
1554 0x5, /* claim SPC-3 version compatibility */
1559 /* set scsi removeable (RMB) bit per ata bit */
1560 if (ata_id_removeable(args->id))
1565 memcpy(rbuf, hdr, sizeof(hdr));
1568 memcpy(&rbuf[8], "ATA ", 8);
1569 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1570 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1571 if (rbuf[32] == 0 || rbuf[32] == ' ')
1572 memcpy(&rbuf[32], "n/a ", 4);
1576 const u8 versions[] = {
1577 0x60, /* SAM-3 (no version claimed) */
1580 0x20, /* SBC-2 (no version claimed) */
1583 0x60 /* SPC-3 (no version claimed) */
1586 memcpy(rbuf + 59, versions, sizeof(versions));
1593 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1594 * @args: device IDENTIFY data / SCSI command of interest.
1595 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1596 * @buflen: Response buffer length.
1598 * Returns list of inquiry VPD pages available.
1601 * spin_lock_irqsave(host_set lock)
1604 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1605 unsigned int buflen)
1607 const u8 pages[] = {
1608 0x00, /* page 0x00, this page */
1609 0x80, /* page 0x80, unit serial no page */
1610 0x83 /* page 0x83, device ident page */
1612 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1615 memcpy(rbuf + 4, pages, sizeof(pages));
1621 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1622 * @args: device IDENTIFY data / SCSI command of interest.
1623 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1624 * @buflen: Response buffer length.
1626 * Returns ATA device serial number.
1629 * spin_lock_irqsave(host_set lock)
1632 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1633 unsigned int buflen)
1637 0x80, /* this page code */
1639 ATA_SERNO_LEN, /* page len */
1641 memcpy(rbuf, hdr, sizeof(hdr));
1643 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1644 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1645 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1651 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1652 * @args: device IDENTIFY data / SCSI command of interest.
1653 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1654 * @buflen: Response buffer length.
1656 * Yields two logical unit device identification designators:
1657 * - vendor specific ASCII containing the ATA serial number
1658 * - SAT defined "t10 vendor id based" containing ASCII vendor
1659 * name ("ATA "), model and serial numbers.
1662 * spin_lock_irqsave(host_set lock)
1665 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1666 unsigned int buflen)
1669 const int sat_model_serial_desc_len = 68;
1670 const int ata_model_byte_len = 40;
1672 rbuf[1] = 0x83; /* this page code */
1675 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1676 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1678 rbuf[num + 3] = ATA_SERNO_LEN;
1680 ata_id_string(args->id, (unsigned char *) rbuf + num,
1681 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1682 num += ATA_SERNO_LEN;
1684 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1685 /* SAT defined lu model and serial numbers descriptor */
1686 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1689 rbuf[num + 3] = sat_model_serial_desc_len;
1691 memcpy(rbuf + num, "ATA ", 8);
1693 ata_id_string(args->id, (unsigned char *) rbuf + num,
1694 ATA_ID_PROD_OFS, ata_model_byte_len);
1695 num += ata_model_byte_len;
1696 ata_id_string(args->id, (unsigned char *) rbuf + num,
1697 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1698 num += ATA_SERNO_LEN;
1700 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1705 * ata_scsiop_noop - Command handler that simply returns success.
1706 * @args: device IDENTIFY data / SCSI command of interest.
1707 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1708 * @buflen: Response buffer length.
1710 * No operation. Simply returns success to caller, to indicate
1711 * that the caller should successfully complete this SCSI command.
1714 * spin_lock_irqsave(host_set lock)
1717 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1718 unsigned int buflen)
1725 * ata_msense_push - Push data onto MODE SENSE data output buffer
1726 * @ptr_io: (input/output) Location to store more output data
1727 * @last: End of output data buffer
1728 * @buf: Pointer to BLOB being added to output buffer
1729 * @buflen: Length of BLOB
1731 * Store MODE SENSE data on an output buffer.
1737 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1738 const u8 *buf, unsigned int buflen)
1742 if ((ptr + buflen - 1) > last)
1745 memcpy(ptr, buf, buflen);
1753 * ata_msense_caching - Simulate MODE SENSE caching info page
1754 * @id: device IDENTIFY data
1755 * @ptr_io: (input/output) Location to store more output data
1756 * @last: End of output data buffer
1758 * Generate a caching info page, which conditionally indicates
1759 * write caching to the SCSI layer, depending on device
1766 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1769 u8 page[CACHE_MPAGE_LEN];
1771 memcpy(page, def_cache_mpage, sizeof(page));
1772 if (ata_id_wcache_enabled(id))
1773 page[2] |= (1 << 2); /* write cache enable */
1774 if (!ata_id_rahead_enabled(id))
1775 page[12] |= (1 << 5); /* disable read ahead */
1777 ata_msense_push(ptr_io, last, page, sizeof(page));
1778 return sizeof(page);
1782 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1783 * @dev: Device associated with this MODE SENSE command
1784 * @ptr_io: (input/output) Location to store more output data
1785 * @last: End of output data buffer
1787 * Generate a generic MODE SENSE control mode page.
1793 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1795 ata_msense_push(ptr_io, last, def_control_mpage,
1796 sizeof(def_control_mpage));
1797 return sizeof(def_control_mpage);
1801 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1802 * @dev: Device associated with this MODE SENSE command
1803 * @ptr_io: (input/output) Location to store more output data
1804 * @last: End of output data buffer
1806 * Generate a generic MODE SENSE r/w error recovery page.
1812 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1815 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1816 sizeof(def_rw_recovery_mpage));
1817 return sizeof(def_rw_recovery_mpage);
1821 * We can turn this into a real blacklist if it's needed, for now just
1822 * blacklist any Maxtor BANC1G10 revision firmware
1824 static int ata_dev_supports_fua(u16 *id)
1826 unsigned char model[41], fw[9];
1830 if (!ata_id_has_fua(id))
1833 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1834 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1836 if (strcmp(model, "Maxtor"))
1838 if (strcmp(fw, "BANC1G10"))
1841 return 0; /* blacklisted */
1845 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1846 * @args: device IDENTIFY data / SCSI command of interest.
1847 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1848 * @buflen: Response buffer length.
1850 * Simulate MODE SENSE commands. Assume this is invoked for direct
1851 * access devices (e.g. disks) only. There should be no block
1852 * descriptor for other device types.
1855 * spin_lock_irqsave(host_set lock)
1858 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1859 unsigned int buflen)
1861 struct ata_device *dev = args->dev;
1862 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1863 const u8 sat_blk_desc[] = {
1864 0, 0, 0, 0, /* number of blocks: sat unspecified */
1866 0, 0x2, 0x0 /* block length: 512 bytes */
1869 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1874 six_byte = (scsicmd[0] == MODE_SENSE);
1875 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1877 * LLBA bit in msense(10) ignored (compliant)
1880 page_control = scsicmd[2] >> 6;
1881 switch (page_control) {
1882 case 0: /* current */
1883 break; /* supported */
1885 goto saving_not_supp;
1886 case 1: /* changeable */
1887 case 2: /* defaults */
1893 output_len = 4 + (ebd ? 8 : 0);
1894 alloc_len = scsicmd[4];
1896 output_len = 8 + (ebd ? 8 : 0);
1897 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1899 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1901 p = rbuf + output_len;
1902 last = rbuf + minlen - 1;
1904 pg = scsicmd[2] & 0x3f;
1907 * No mode subpages supported (yet) but asking for _all_
1908 * subpages may be valid
1910 if (spg && (spg != ALL_SUB_MPAGES))
1914 case RW_RECOVERY_MPAGE:
1915 output_len += ata_msense_rw_recovery(&p, last);
1919 output_len += ata_msense_caching(args->id, &p, last);
1922 case CONTROL_MPAGE: {
1923 output_len += ata_msense_ctl_mode(&p, last);
1928 output_len += ata_msense_rw_recovery(&p, last);
1929 output_len += ata_msense_caching(args->id, &p, last);
1930 output_len += ata_msense_ctl_mode(&p, last);
1933 default: /* invalid page code */
1941 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1942 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1947 rbuf[0] = output_len;
1952 rbuf[3] = sizeof(sat_blk_desc);
1954 memcpy(rbuf + 4, sat_blk_desc,
1955 sizeof(sat_blk_desc));
1959 rbuf[0] = output_len >> 8;
1961 rbuf[1] = output_len;
1966 rbuf[7] = sizeof(sat_blk_desc);
1968 memcpy(rbuf + 8, sat_blk_desc,
1969 sizeof(sat_blk_desc));
1975 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1976 /* "Invalid field in cbd" */
1980 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1981 /* "Saving parameters not supported" */
1986 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1987 * @args: device IDENTIFY data / SCSI command of interest.
1988 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1989 * @buflen: Response buffer length.
1991 * Simulate READ CAPACITY commands.
1994 * spin_lock_irqsave(host_set lock)
1997 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1998 unsigned int buflen)
2005 if (ata_id_has_lba(args->id)) {
2006 if (ata_id_has_lba48(args->id))
2007 n_sectors = ata_id_u64(args->id, 100);
2009 n_sectors = ata_id_u32(args->id, 60);
2011 /* CHS default translation */
2012 n_sectors = args->id[1] * args->id[3] * args->id[6];
2014 if (ata_id_current_chs_valid(args->id))
2015 /* CHS current translation */
2016 n_sectors = ata_id_u32(args->id, 57);
2019 n_sectors--; /* ATA TotalUserSectors - 1 */
2021 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2022 if( n_sectors >= 0xffffffffULL )
2023 tmp = 0xffffffff ; /* Return max count on overflow */
2027 /* sector count, 32-bit */
2028 rbuf[0] = tmp >> (8 * 3);
2029 rbuf[1] = tmp >> (8 * 2);
2030 rbuf[2] = tmp >> (8 * 1);
2034 tmp = ATA_SECT_SIZE;
2039 /* sector count, 64-bit */
2040 tmp = n_sectors >> (8 * 4);
2041 rbuf[2] = tmp >> (8 * 3);
2042 rbuf[3] = tmp >> (8 * 2);
2043 rbuf[4] = tmp >> (8 * 1);
2046 rbuf[6] = tmp >> (8 * 3);
2047 rbuf[7] = tmp >> (8 * 2);
2048 rbuf[8] = tmp >> (8 * 1);
2052 tmp = ATA_SECT_SIZE;
2053 rbuf[12] = tmp >> 8;
2061 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2062 * @args: device IDENTIFY data / SCSI command of interest.
2063 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2064 * @buflen: Response buffer length.
2066 * Simulate REPORT LUNS command.
2069 * spin_lock_irqsave(host_set lock)
2072 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2073 unsigned int buflen)
2076 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2082 * ata_scsi_set_sense - Set SCSI sense data and status
2083 * @cmd: SCSI request to be handled
2084 * @sk: SCSI-defined sense key
2085 * @asc: SCSI-defined additional sense code
2086 * @ascq: SCSI-defined additional sense code qualifier
2088 * Helper function that builds a valid fixed format, current
2089 * response code and the given sense key (sk), additional sense
2090 * code (asc) and additional sense code qualifier (ascq) with
2091 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2092 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2098 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2100 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2102 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2103 cmd->sense_buffer[2] = sk;
2104 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2105 cmd->sense_buffer[12] = asc;
2106 cmd->sense_buffer[13] = ascq;
2110 * ata_scsi_badcmd - End a SCSI request with an error
2111 * @cmd: SCSI request to be handled
2112 * @done: SCSI command completion function
2113 * @asc: SCSI-defined additional sense code
2114 * @ascq: SCSI-defined additional sense code qualifier
2116 * Helper function that completes a SCSI command with
2117 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2118 * and the specified additional sense codes.
2121 * spin_lock_irqsave(host_set lock)
2124 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2127 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2132 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2134 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
2135 /* FIXME: not quite right; we don't want the
2136 * translation of taskfile registers into
2137 * a sense descriptors, since that's only
2138 * correct for ATA, not ATAPI
2140 ata_gen_ata_desc_sense(qc);
2142 qc->scsidone(qc->scsicmd);
2146 /* is it pointless to prefer PIO for "safety reasons"? */
2147 static inline int ata_pio_use_silly(struct ata_port *ap)
2149 return (ap->flags & ATA_FLAG_PIO_DMA);
2152 static void atapi_request_sense(struct ata_queued_cmd *qc)
2154 struct ata_port *ap = qc->ap;
2155 struct scsi_cmnd *cmd = qc->scsicmd;
2157 DPRINTK("ATAPI request sense\n");
2159 /* FIXME: is this needed? */
2160 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2162 ap->ops->tf_read(ap, &qc->tf);
2164 /* fill these in, for the case where they are -not- overwritten */
2165 cmd->sense_buffer[0] = 0x70;
2166 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2170 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2171 qc->dma_dir = DMA_FROM_DEVICE;
2173 memset(&qc->cdb, 0, qc->dev->cdb_len);
2174 qc->cdb[0] = REQUEST_SENSE;
2175 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2177 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2178 qc->tf.command = ATA_CMD_PACKET;
2180 if (ata_pio_use_silly(ap)) {
2181 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2182 qc->tf.feature |= ATAPI_PKT_DMA;
2184 qc->tf.protocol = ATA_PROT_ATAPI;
2185 qc->tf.lbam = (8 * 1024) & 0xff;
2186 qc->tf.lbah = (8 * 1024) >> 8;
2188 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2190 qc->complete_fn = atapi_sense_complete;
2197 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2199 struct scsi_cmnd *cmd = qc->scsicmd;
2200 unsigned int err_mask = qc->err_mask;
2202 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2204 if (unlikely(err_mask & AC_ERR_DEV)) {
2205 cmd->result = SAM_STAT_CHECK_CONDITION;
2206 atapi_request_sense(qc);
2210 else if (unlikely(err_mask))
2211 /* FIXME: not quite right; we don't want the
2212 * translation of taskfile registers into
2213 * a sense descriptors, since that's only
2214 * correct for ATA, not ATAPI
2216 ata_gen_ata_desc_sense(qc);
2219 u8 *scsicmd = cmd->cmnd;
2221 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2223 unsigned int buflen;
2225 buflen = ata_scsi_rbuf_get(cmd, &buf);
2227 /* ATAPI devices typically report zero for their SCSI version,
2228 * and sometimes deviate from the spec WRT response data
2229 * format. If SCSI version is reported as zero like normal,
2230 * then we make the following fixups: 1) Fake MMC-5 version,
2231 * to indicate to the Linux scsi midlayer this is a modern
2232 * device. 2) Ensure response data format / ATAPI information
2233 * are always correct.
2240 ata_scsi_rbuf_put(cmd, buf);
2243 cmd->result = SAM_STAT_GOOD;
2250 * atapi_xlat - Initialize PACKET taskfile
2251 * @qc: command structure to be initialized
2252 * @scsicmd: SCSI CDB associated with this PACKET command
2255 * spin_lock_irqsave(host_set lock)
2258 * Zero on success, non-zero on failure.
2261 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2263 struct scsi_cmnd *cmd = qc->scsicmd;
2264 struct ata_device *dev = qc->dev;
2265 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2266 int nodata = (cmd->sc_data_direction == DMA_NONE);
2269 /* Check whether ATAPI DMA is safe */
2270 if (ata_check_atapi_dma(qc))
2273 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2275 qc->complete_fn = atapi_qc_complete;
2277 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2278 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2279 qc->tf.flags |= ATA_TFLAG_WRITE;
2280 DPRINTK("direction: write\n");
2283 qc->tf.command = ATA_CMD_PACKET;
2285 /* no data, or PIO data xfer */
2286 if (using_pio || nodata) {
2288 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2290 qc->tf.protocol = ATA_PROT_ATAPI;
2291 qc->tf.lbam = (8 * 1024) & 0xff;
2292 qc->tf.lbah = (8 * 1024) >> 8;
2297 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2298 qc->tf.feature |= ATAPI_PKT_DMA;
2300 #ifdef ATAPI_ENABLE_DMADIR
2301 /* some SATA bridges need us to indicate data xfer direction */
2302 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2303 qc->tf.feature |= ATAPI_DMADIR;
2307 qc->nbytes = cmd->bufflen;
2313 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2314 * @ap: ATA port to which the device is attached
2315 * @scsidev: SCSI device from which we derive the ATA device
2317 * Given various information provided in struct scsi_cmnd,
2318 * map that onto an ATA bus, and using that mapping
2319 * determine which ata_device is associated with the
2320 * SCSI command to be sent.
2323 * spin_lock_irqsave(host_set lock)
2326 * Associated ATA device, or %NULL if not found.
2329 static struct ata_device *
2330 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2332 struct ata_device *dev;
2334 /* skip commands not addressed to targets we simulate */
2335 if (likely(scsidev->id < ATA_MAX_DEVICES))
2336 dev = &ap->device[scsidev->id];
2340 if (unlikely((scsidev->channel != 0) ||
2341 (scsidev->lun != 0)))
2344 if (unlikely(!ata_dev_enabled(dev)))
2347 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2348 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2349 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2350 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
2359 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2360 * @byte1: Byte 1 from pass-thru CDB.
2363 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2366 ata_scsi_map_proto(u8 byte1)
2368 switch((byte1 & 0x1e) >> 1) {
2369 case 3: /* Non-data */
2370 return ATA_PROT_NODATA;
2373 return ATA_PROT_DMA;
2375 case 4: /* PIO Data-in */
2376 case 5: /* PIO Data-out */
2377 return ATA_PROT_PIO;
2379 case 10: /* Device Reset */
2380 case 0: /* Hard Reset */
2382 case 2: /* Bus Idle */
2383 case 7: /* Packet */
2384 case 8: /* DMA Queued */
2385 case 9: /* Device Diagnostic */
2386 case 11: /* UDMA Data-in */
2387 case 12: /* UDMA Data-Out */
2388 case 13: /* FPDMA */
2389 default: /* Reserved */
2393 return ATA_PROT_UNKNOWN;
2397 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2398 * @qc: command structure to be initialized
2399 * @scsicmd: SCSI command to convert
2401 * Handles either 12 or 16-byte versions of the CDB.
2404 * Zero on success, non-zero on failure.
2407 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2409 struct ata_taskfile *tf = &(qc->tf);
2410 struct scsi_cmnd *cmd = qc->scsicmd;
2412 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2415 if (scsicmd[1] & 0xe0)
2416 /* PIO multi not supported yet */
2420 * 12 and 16 byte CDBs use different offsets to
2421 * provide the various register values.
2423 if (scsicmd[0] == ATA_16) {
2425 * 16-byte CDB - may contain extended commands.
2427 * If that is the case, copy the upper byte register values.
2429 if (scsicmd[1] & 0x01) {
2430 tf->hob_feature = scsicmd[3];
2431 tf->hob_nsect = scsicmd[5];
2432 tf->hob_lbal = scsicmd[7];
2433 tf->hob_lbam = scsicmd[9];
2434 tf->hob_lbah = scsicmd[11];
2435 tf->flags |= ATA_TFLAG_LBA48;
2437 tf->flags &= ~ATA_TFLAG_LBA48;
2440 * Always copy low byte, device and command registers.
2442 tf->feature = scsicmd[4];
2443 tf->nsect = scsicmd[6];
2444 tf->lbal = scsicmd[8];
2445 tf->lbam = scsicmd[10];
2446 tf->lbah = scsicmd[12];
2447 tf->device = scsicmd[13];
2448 tf->command = scsicmd[14];
2451 * 12-byte CDB - incapable of extended commands.
2453 tf->flags &= ~ATA_TFLAG_LBA48;
2455 tf->feature = scsicmd[3];
2456 tf->nsect = scsicmd[4];
2457 tf->lbal = scsicmd[5];
2458 tf->lbam = scsicmd[6];
2459 tf->lbah = scsicmd[7];
2460 tf->device = scsicmd[8];
2461 tf->command = scsicmd[9];
2464 * If slave is possible, enforce correct master/slave bit
2466 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2467 tf->device = qc->dev->devno ?
2468 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2471 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2472 * SET_FEATURES - XFER MODE must be preceded/succeeded
2473 * by an update to hardware-specific registers for each
2474 * controller (i.e. the reason for ->set_piomode(),
2475 * ->set_dmamode(), and ->post_set_mode() hooks).
2477 if ((tf->command == ATA_CMD_SET_FEATURES)
2478 && (tf->feature == SETFEATURES_XFER))
2482 * Set flags so that all registers will be written,
2483 * and pass on write indication (used for PIO/DMA
2486 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2488 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2489 tf->flags |= ATA_TFLAG_WRITE;
2492 * Set transfer length.
2494 * TODO: find out if we need to do more here to
2495 * cover scatter/gather case.
2497 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2502 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2503 /* "Invalid field in cdb" */
2508 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2510 * @cmd: SCSI command opcode to consider
2512 * Look up the SCSI command given, and determine whether the
2513 * SCSI command is to be translated or simulated.
2516 * Pointer to translation function if possible, %NULL if not.
2519 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2529 return ata_scsi_rw_xlat;
2531 case SYNCHRONIZE_CACHE:
2532 if (ata_try_flush_cache(dev))
2533 return ata_scsi_flush_xlat;
2538 return ata_scsi_verify_xlat;
2542 return ata_scsi_pass_thru;
2545 return ata_scsi_start_stop_xlat;
2552 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2553 * @ap: ATA port to which the command was being sent
2554 * @cmd: SCSI command to dump
2556 * Prints the contents of a SCSI command via printk().
2559 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2560 struct scsi_cmnd *cmd)
2563 struct scsi_device *scsidev = cmd->device;
2564 u8 *scsicmd = cmd->cmnd;
2566 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2568 scsidev->channel, scsidev->id, scsidev->lun,
2569 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2570 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2575 static inline void __ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
2576 struct ata_port *ap, struct ata_device *dev)
2578 if (dev->class == ATA_DEV_ATA) {
2579 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2583 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2585 ata_scsi_simulate(ap, dev, cmd, done);
2587 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2591 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2592 * @cmd: SCSI command to be sent
2593 * @done: Completion function, called when command is complete
2595 * In some cases, this function translates SCSI commands into
2596 * ATA taskfiles, and queues the taskfiles to be sent to
2597 * hardware. In other cases, this function simulates a
2598 * SCSI device by evaluating and responding to certain
2599 * SCSI commands. This creates the overall effect of
2600 * ATA and ATAPI devices appearing as SCSI devices.
2603 * Releases scsi-layer-held lock, and obtains host_set lock.
2609 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2611 struct ata_port *ap;
2612 struct ata_device *dev;
2613 struct scsi_device *scsidev = cmd->device;
2614 struct Scsi_Host *shost = scsidev->host;
2616 ap = (struct ata_port *) &shost->hostdata[0];
2618 spin_unlock(shost->host_lock);
2619 spin_lock(&ap->host_set->lock);
2621 ata_scsi_dump_cdb(ap, cmd);
2623 dev = ata_scsi_find_dev(ap, scsidev);
2625 __ata_scsi_queuecmd(cmd, done, ap, dev);
2627 cmd->result = (DID_BAD_TARGET << 16);
2631 spin_unlock(&ap->host_set->lock);
2632 spin_lock(shost->host_lock);
2637 * ata_scsi_simulate - simulate SCSI command on ATA device
2638 * @ap: port the device is connected to
2639 * @dev: the target device
2640 * @cmd: SCSI command being sent to device.
2641 * @done: SCSI command completion function.
2643 * Interprets and directly executes a select list of SCSI commands
2644 * that can be handled internally.
2647 * spin_lock_irqsave(host_set lock)
2650 void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
2651 struct scsi_cmnd *cmd,
2652 void (*done)(struct scsi_cmnd *))
2654 struct ata_scsi_args args;
2655 const u8 *scsicmd = cmd->cmnd;
2663 switch(scsicmd[0]) {
2664 /* no-op's, complete with success */
2665 case SYNCHRONIZE_CACHE:
2669 case TEST_UNIT_READY:
2670 case FORMAT_UNIT: /* FIXME: correct? */
2671 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2672 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2676 if (scsicmd[1] & 2) /* is CmdDt set? */
2677 ata_scsi_invalid_field(cmd, done);
2678 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2679 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2680 else if (scsicmd[2] == 0x00)
2681 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2682 else if (scsicmd[2] == 0x80)
2683 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2684 else if (scsicmd[2] == 0x83)
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2687 ata_scsi_invalid_field(cmd, done);
2692 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2695 case MODE_SELECT: /* unconditionally return */
2696 case MODE_SELECT_10: /* bad-field-in-cdb */
2697 ata_scsi_invalid_field(cmd, done);
2701 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2704 case SERVICE_ACTION_IN:
2705 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2706 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2708 ata_scsi_invalid_field(cmd, done);
2712 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2715 /* mandatory commands we haven't implemented yet */
2718 /* all other commands */
2720 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2721 /* "Invalid command operation code" */
2727 void ata_scsi_scan_host(struct ata_port *ap)
2729 struct ata_device *dev;
2732 if (ap->flags & ATA_FLAG_DISABLED)
2735 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2736 dev = &ap->device[i];
2738 if (ata_dev_enabled(dev))
2739 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);