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/slab.h>
37 #include <linux/kernel.h>
38 #include <linux/blkdev.h>
39 #include <linux/spinlock.h>
40 #include <scsi/scsi.h>
41 #include <scsi/scsi_host.h>
42 #include <scsi/scsi_cmnd.h>
43 #include <scsi/scsi_eh.h>
44 #include <scsi/scsi_device.h>
45 #include <scsi/scsi_tcq.h>
46 #include <scsi/scsi_transport.h>
47 #include <linux/libata.h>
48 #include <linux/hdreg.h>
49 #include <linux/uaccess.h>
50 #include <linux/suspend.h>
51 #include <asm/unaligned.h>
54 #include "libata-transport.h"
56 #define ATA_SCSI_RBUF_SIZE 4096
58 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
59 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
61 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
63 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
64 const struct scsi_device *scsidev);
65 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
66 const struct scsi_device *scsidev);
68 #define RW_RECOVERY_MPAGE 0x1
69 #define RW_RECOVERY_MPAGE_LEN 12
70 #define CACHE_MPAGE 0x8
71 #define CACHE_MPAGE_LEN 20
72 #define CONTROL_MPAGE 0xa
73 #define CONTROL_MPAGE_LEN 12
74 #define ALL_MPAGES 0x3f
75 #define ALL_SUB_MPAGES 0xff
78 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
80 RW_RECOVERY_MPAGE_LEN - 2,
82 0, /* read retry count */
84 0, /* write retry count */
88 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
91 0, /* contains WCE, needs to be 0 for logic */
92 0, 0, 0, 0, 0, 0, 0, 0, 0,
93 0, /* contains DRA, needs to be 0 for logic */
97 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
99 CONTROL_MPAGE_LEN - 2,
100 2, /* DSENSE=0, GLTSD=1 */
101 0, /* [QAM+QERR may be 1, see 05-359r1] */
102 0, 0, 0, 0, 0xff, 0xff,
103 0, 30 /* extended self test time, see 05-359r1 */
106 static const char *ata_lpm_policy_names[] = {
107 [ATA_LPM_UNKNOWN] = "max_performance",
108 [ATA_LPM_MAX_POWER] = "max_performance",
109 [ATA_LPM_MED_POWER] = "medium_power",
110 [ATA_LPM_MIN_POWER] = "min_power",
113 static ssize_t ata_scsi_lpm_store(struct device *dev,
114 struct device_attribute *attr,
115 const char *buf, size_t count)
117 struct Scsi_Host *shost = class_to_shost(dev);
118 struct ata_port *ap = ata_shost_to_port(shost);
119 enum ata_lpm_policy policy;
122 /* UNKNOWN is internal state, iterate from MAX_POWER */
123 for (policy = ATA_LPM_MAX_POWER;
124 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
125 const char *name = ata_lpm_policy_names[policy];
127 if (strncmp(name, buf, strlen(name)) == 0)
130 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
133 spin_lock_irqsave(ap->lock, flags);
134 ap->target_lpm_policy = policy;
135 ata_port_schedule_eh(ap);
136 spin_unlock_irqrestore(ap->lock, flags);
141 static ssize_t ata_scsi_lpm_show(struct device *dev,
142 struct device_attribute *attr, char *buf)
144 struct Scsi_Host *shost = class_to_shost(dev);
145 struct ata_port *ap = ata_shost_to_port(shost);
147 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
150 return snprintf(buf, PAGE_SIZE, "%s\n",
151 ata_lpm_policy_names[ap->target_lpm_policy]);
153 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
154 ata_scsi_lpm_show, ata_scsi_lpm_store);
155 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
157 static ssize_t ata_scsi_park_show(struct device *device,
158 struct device_attribute *attr, char *buf)
160 struct scsi_device *sdev = to_scsi_device(device);
162 struct ata_link *link;
163 struct ata_device *dev;
164 unsigned long flags, now;
165 unsigned int uninitialized_var(msecs);
168 ap = ata_shost_to_port(sdev->host);
170 spin_lock_irqsave(ap->lock, flags);
171 dev = ata_scsi_find_dev(ap, sdev);
176 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
183 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
184 link->eh_context.unloaded_mask & (1 << dev->devno) &&
185 time_after(dev->unpark_deadline, now))
186 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
191 spin_unlock_irq(ap->lock);
193 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
196 static ssize_t ata_scsi_park_store(struct device *device,
197 struct device_attribute *attr,
198 const char *buf, size_t len)
200 struct scsi_device *sdev = to_scsi_device(device);
202 struct ata_device *dev;
207 rc = strict_strtol(buf, 10, &input);
208 if (rc || input < -2)
210 if (input > ATA_TMOUT_MAX_PARK) {
212 input = ATA_TMOUT_MAX_PARK;
215 ap = ata_shost_to_port(sdev->host);
217 spin_lock_irqsave(ap->lock, flags);
218 dev = ata_scsi_find_dev(ap, sdev);
219 if (unlikely(!dev)) {
223 if (dev->class != ATA_DEV_ATA) {
229 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
234 dev->unpark_deadline = ata_deadline(jiffies, input);
235 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
236 ata_port_schedule_eh(ap);
237 complete(&ap->park_req_pending);
241 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
244 dev->flags |= ATA_DFLAG_NO_UNLOAD;
249 spin_unlock_irqrestore(ap->lock, flags);
251 return rc ? rc : len;
253 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
254 ata_scsi_park_show, ata_scsi_park_store);
255 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
257 static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
259 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
261 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
265 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
266 const char *buf, size_t count)
268 struct Scsi_Host *shost = class_to_shost(dev);
269 struct ata_port *ap = ata_shost_to_port(shost);
270 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
271 return ap->ops->em_store(ap, buf, count);
276 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
279 struct Scsi_Host *shost = class_to_shost(dev);
280 struct ata_port *ap = ata_shost_to_port(shost);
282 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
283 return ap->ops->em_show(ap, buf);
286 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
287 ata_scsi_em_message_show, ata_scsi_em_message_store);
288 EXPORT_SYMBOL_GPL(dev_attr_em_message);
291 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
294 struct Scsi_Host *shost = class_to_shost(dev);
295 struct ata_port *ap = ata_shost_to_port(shost);
297 return snprintf(buf, 23, "%d\n", ap->em_message_type);
299 DEVICE_ATTR(em_message_type, S_IRUGO,
300 ata_scsi_em_message_type_show, NULL);
301 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
304 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
307 struct scsi_device *sdev = to_scsi_device(dev);
308 struct ata_port *ap = ata_shost_to_port(sdev->host);
309 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
311 if (ap->ops->sw_activity_show && (ap->flags & ATA_FLAG_SW_ACTIVITY))
312 return ap->ops->sw_activity_show(atadev, buf);
317 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
318 const char *buf, size_t count)
320 struct scsi_device *sdev = to_scsi_device(dev);
321 struct ata_port *ap = ata_shost_to_port(sdev->host);
322 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
323 enum sw_activity val;
326 if (ap->ops->sw_activity_store && (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
327 val = simple_strtoul(buf, NULL, 0);
329 case OFF: case BLINK_ON: case BLINK_OFF:
330 rc = ap->ops->sw_activity_store(atadev, val);
339 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
340 ata_scsi_activity_store);
341 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
343 struct device_attribute *ata_common_sdev_attrs[] = {
344 &dev_attr_unload_heads,
347 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
349 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
350 void (*done)(struct scsi_cmnd *))
352 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
353 /* "Invalid field in cbd" */
358 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
359 * @sdev: SCSI device for which BIOS geometry is to be determined
360 * @bdev: block device associated with @sdev
361 * @capacity: capacity of SCSI device
362 * @geom: location to which geometry will be output
364 * Generic bios head/sector/cylinder calculator
365 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
366 * mapping. Some situations may arise where the disk is not
367 * bootable if this is not used.
370 * Defined by the SCSI layer. We don't really care.
375 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
376 sector_t capacity, int geom[])
380 sector_div(capacity, 255*63);
387 * ata_scsi_unlock_native_capacity - unlock native capacity
388 * @sdev: SCSI device to adjust device capacity for
390 * This function is called if a partition on @sdev extends beyond
391 * the end of the device. It requests EH to unlock HPA.
394 * Defined by the SCSI layer. Might sleep.
396 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
398 struct ata_port *ap = ata_shost_to_port(sdev->host);
399 struct ata_device *dev;
402 spin_lock_irqsave(ap->lock, flags);
404 dev = ata_scsi_find_dev(ap, sdev);
405 if (dev && dev->n_sectors < dev->n_native_sectors) {
406 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
407 dev->link->eh_info.action |= ATA_EH_RESET;
408 ata_port_schedule_eh(ap);
411 spin_unlock_irqrestore(ap->lock, flags);
412 ata_port_wait_eh(ap);
416 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
418 * @sdev: SCSI device to get identify data for
419 * @arg: User buffer area for identify data
422 * Defined by the SCSI layer. We don't really care.
425 * Zero on success, negative errno on error.
427 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
430 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
431 u16 __user *dst = arg;
437 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
440 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
441 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
444 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
445 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
448 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
449 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
456 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
457 * @scsidev: Device to which we are issuing command
458 * @arg: User provided data for issuing command
461 * Defined by the SCSI layer. We don't really care.
464 * Zero on success, negative errno on error.
466 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
469 u8 scsi_cmd[MAX_COMMAND_SIZE];
470 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
472 enum dma_data_direction data_dir;
478 if (copy_from_user(args, arg, sizeof(args)))
481 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
485 memset(scsi_cmd, 0, sizeof(scsi_cmd));
488 argsize = ATA_SECT_SIZE * args[3];
489 argbuf = kmalloc(argsize, GFP_KERNEL);
490 if (argbuf == NULL) {
495 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
496 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
497 block count in sector count field */
498 data_dir = DMA_FROM_DEVICE;
500 scsi_cmd[1] = (3 << 1); /* Non-data */
501 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
505 scsi_cmd[0] = ATA_16;
507 scsi_cmd[4] = args[2];
508 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
509 scsi_cmd[6] = args[3];
510 scsi_cmd[8] = args[1];
514 scsi_cmd[6] = args[1];
516 scsi_cmd[14] = args[0];
518 /* Good values for timeout and retries? Values below
519 from scsi_ioctl_send_command() for default case... */
520 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
521 sensebuf, (10*HZ), 5, 0, NULL);
523 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
524 u8 *desc = sensebuf + 8;
525 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
527 /* If we set cc then ATA pass-through will cause a
528 * check condition even if no error. Filter that. */
529 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
530 struct scsi_sense_hdr sshdr;
531 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
533 if (sshdr.sense_key == 0 &&
534 sshdr.asc == 0 && sshdr.ascq == 0)
535 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
538 /* Send userspace a few ATA registers (same as drivers/ide) */
539 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
540 desc[0] == 0x09) { /* code is "ATA Descriptor" */
541 args[0] = desc[13]; /* status */
542 args[1] = desc[3]; /* error */
543 args[2] = desc[5]; /* sector count (0:7) */
544 if (copy_to_user(arg, args, sizeof(args)))
556 && copy_to_user(arg + sizeof(args), argbuf, argsize))
565 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
566 * @scsidev: Device to which we are issuing command
567 * @arg: User provided data for issuing command
570 * Defined by the SCSI layer. We don't really care.
573 * Zero on success, negative errno on error.
575 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
578 u8 scsi_cmd[MAX_COMMAND_SIZE];
579 u8 args[7], *sensebuf = NULL;
585 if (copy_from_user(args, arg, sizeof(args)))
588 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
592 memset(scsi_cmd, 0, sizeof(scsi_cmd));
593 scsi_cmd[0] = ATA_16;
594 scsi_cmd[1] = (3 << 1); /* Non-data */
595 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
596 scsi_cmd[4] = args[1];
597 scsi_cmd[6] = args[2];
598 scsi_cmd[8] = args[3];
599 scsi_cmd[10] = args[4];
600 scsi_cmd[12] = args[5];
601 scsi_cmd[13] = args[6] & 0x4f;
602 scsi_cmd[14] = args[0];
604 /* Good values for timeout and retries? Values below
605 from scsi_ioctl_send_command() for default case... */
606 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
607 sensebuf, (10*HZ), 5, 0, NULL);
609 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
610 u8 *desc = sensebuf + 8;
611 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
613 /* If we set cc then ATA pass-through will cause a
614 * check condition even if no error. Filter that. */
615 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
616 struct scsi_sense_hdr sshdr;
617 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
619 if (sshdr.sense_key == 0 &&
620 sshdr.asc == 0 && sshdr.ascq == 0)
621 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
624 /* Send userspace ATA registers */
625 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
626 desc[0] == 0x09) {/* code is "ATA Descriptor" */
627 args[0] = desc[13]; /* status */
628 args[1] = desc[3]; /* error */
629 args[2] = desc[5]; /* sector count (0:7) */
630 args[3] = desc[7]; /* lbal */
631 args[4] = desc[9]; /* lbam */
632 args[5] = desc[11]; /* lbah */
633 args[6] = desc[12]; /* select */
634 if (copy_to_user(arg, args, sizeof(args)))
649 static int ata_ioc32(struct ata_port *ap)
651 if (ap->flags & ATA_FLAG_PIO_DMA)
653 if (ap->pflags & ATA_PFLAG_PIO32)
658 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
659 int cmd, void __user *arg)
661 int val = -EINVAL, rc = -EINVAL;
665 case ATA_IOC_GET_IO32:
666 spin_lock_irqsave(ap->lock, flags);
668 spin_unlock_irqrestore(ap->lock, flags);
669 if (copy_to_user(arg, &val, 1))
673 case ATA_IOC_SET_IO32:
674 val = (unsigned long) arg;
676 spin_lock_irqsave(ap->lock, flags);
677 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
679 ap->pflags |= ATA_PFLAG_PIO32;
681 ap->pflags &= ~ATA_PFLAG_PIO32;
683 if (val != ata_ioc32(ap))
686 spin_unlock_irqrestore(ap->lock, flags);
689 case HDIO_GET_IDENTITY:
690 return ata_get_identity(ap, scsidev, arg);
693 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
695 return ata_cmd_ioctl(scsidev, arg);
697 case HDIO_DRIVE_TASK:
698 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
700 return ata_task_ioctl(scsidev, arg);
709 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
711 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
713 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
716 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
719 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
720 * @dev: ATA device to which the new command is attached
721 * @cmd: SCSI command that originated this ATA command
722 * @done: SCSI command completion function
724 * Obtain a reference to an unused ata_queued_cmd structure,
725 * which is the basic libata structure representing a single
726 * ATA command sent to the hardware.
728 * If a command was available, fill in the SCSI-specific
729 * portions of the structure with information on the
733 * spin_lock_irqsave(host lock)
736 * Command allocated, or %NULL if none available.
738 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
739 struct scsi_cmnd *cmd,
740 void (*done)(struct scsi_cmnd *))
742 struct ata_queued_cmd *qc;
744 qc = ata_qc_new_init(dev);
749 qc->sg = scsi_sglist(cmd);
750 qc->n_elem = scsi_sg_count(cmd);
752 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
759 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
761 struct scsi_cmnd *scmd = qc->scsicmd;
763 qc->extrabytes = scmd->request->extra_len;
764 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
768 * ata_dump_status - user friendly display of error info
769 * @id: id of the port in question
770 * @tf: ptr to filled out taskfile
772 * Decode and dump the ATA error/status registers for the user so
773 * that they have some idea what really happened at the non
774 * make-believe layer.
777 * inherited from caller
779 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
781 u8 stat = tf->command, err = tf->feature;
783 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
784 if (stat & ATA_BUSY) {
785 printk("Busy }\n"); /* Data is not valid in this case */
787 if (stat & 0x40) printk("DriveReady ");
788 if (stat & 0x20) printk("DeviceFault ");
789 if (stat & 0x10) printk("SeekComplete ");
790 if (stat & 0x08) printk("DataRequest ");
791 if (stat & 0x04) printk("CorrectedError ");
792 if (stat & 0x02) printk("Index ");
793 if (stat & 0x01) printk("Error ");
797 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
798 if (err & 0x04) printk("DriveStatusError ");
800 if (err & 0x04) printk("BadCRC ");
801 else printk("Sector ");
803 if (err & 0x40) printk("UncorrectableError ");
804 if (err & 0x10) printk("SectorIdNotFound ");
805 if (err & 0x02) printk("TrackZeroNotFound ");
806 if (err & 0x01) printk("AddrMarkNotFound ");
813 * ata_to_sense_error - convert ATA error to SCSI error
814 * @id: ATA device number
815 * @drv_stat: value contained in ATA status register
816 * @drv_err: value contained in ATA error register
817 * @sk: the sense key we'll fill out
818 * @asc: the additional sense code we'll fill out
819 * @ascq: the additional sense code qualifier we'll fill out
820 * @verbose: be verbose
822 * Converts an ATA error into a SCSI error. Fill out pointers to
823 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
824 * format sense blocks.
827 * spin_lock_irqsave(host lock)
829 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
830 u8 *asc, u8 *ascq, int verbose)
834 /* Based on the 3ware driver translation table */
835 static const unsigned char sense_table[][4] = {
837 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
839 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
841 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
842 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
843 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
844 /* MC|ID|ABRT|TRK0|MARK */
845 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
847 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
848 /* Bad address mark */
849 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
851 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
853 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
854 /* Media change request */
855 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
857 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
859 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
861 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
862 /* BBD - block marked bad */
863 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
864 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
866 static const unsigned char stat_table[][4] = {
867 /* Must be first because BUSY means no other bits valid */
868 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
869 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
870 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
871 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
872 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
876 * Is this an error we can process/parse
878 if (drv_stat & ATA_BUSY) {
879 drv_err = 0; /* Ignore the err bits, they're invalid */
883 /* Look for drv_err */
884 for (i = 0; sense_table[i][0] != 0xFF; i++) {
885 /* Look for best matches first */
886 if ((sense_table[i][0] & drv_err) ==
888 *sk = sense_table[i][1];
889 *asc = sense_table[i][2];
890 *ascq = sense_table[i][3];
894 /* No immediate match */
896 printk(KERN_WARNING "ata%u: no sense translation for "
897 "error 0x%02x\n", id, drv_err);
900 /* Fall back to interpreting status bits */
901 for (i = 0; stat_table[i][0] != 0xFF; i++) {
902 if (stat_table[i][0] & drv_stat) {
903 *sk = stat_table[i][1];
904 *asc = stat_table[i][2];
905 *ascq = stat_table[i][3];
909 /* No error? Undecoded? */
911 printk(KERN_WARNING "ata%u: no sense translation for "
912 "status: 0x%02x\n", id, drv_stat);
914 /* We need a sensible error return here, which is tricky, and one
915 that won't cause people to do things like return a disk wrongly */
916 *sk = ABORTED_COMMAND;
922 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
923 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
924 id, drv_stat, drv_err, *sk, *asc, *ascq);
929 * ata_gen_passthru_sense - Generate check condition sense block.
930 * @qc: Command that completed.
932 * This function is specific to the ATA descriptor format sense
933 * block specified for the ATA pass through commands. Regardless
934 * of whether the command errored or not, return a sense
935 * block. Copy all controller registers into the sense
936 * block. Clear sense key, ASC & ASCQ if there is no error.
941 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
943 struct scsi_cmnd *cmd = qc->scsicmd;
944 struct ata_taskfile *tf = &qc->result_tf;
945 unsigned char *sb = cmd->sense_buffer;
946 unsigned char *desc = sb + 8;
947 int verbose = qc->ap->ops->error_handler == NULL;
949 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
951 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
954 * Use ata_to_sense_error() to map status register bits
955 * onto sense key, asc & ascq.
958 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
959 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
960 &sb[1], &sb[2], &sb[3], verbose);
965 * Sense data is current and format is descriptor.
971 /* set length of additional sense data */
976 * Copy registers into sense buffer.
979 desc[3] = tf->feature; /* == error reg */
984 desc[12] = tf->device;
985 desc[13] = tf->command; /* == status reg */
988 * Fill in Extend bit, and the high order bytes
991 if (tf->flags & ATA_TFLAG_LBA48) {
993 desc[4] = tf->hob_nsect;
994 desc[6] = tf->hob_lbal;
995 desc[8] = tf->hob_lbam;
996 desc[10] = tf->hob_lbah;
1001 * ata_gen_ata_sense - generate a SCSI fixed sense block
1002 * @qc: Command that we are erroring out
1004 * Generate sense block for a failed ATA command @qc. Descriptor
1005 * format is used to accomodate LBA48 block address.
1010 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1012 struct ata_device *dev = qc->dev;
1013 struct scsi_cmnd *cmd = qc->scsicmd;
1014 struct ata_taskfile *tf = &qc->result_tf;
1015 unsigned char *sb = cmd->sense_buffer;
1016 unsigned char *desc = sb + 8;
1017 int verbose = qc->ap->ops->error_handler == NULL;
1020 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1022 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1024 /* sense data is current and format is descriptor */
1027 /* Use ata_to_sense_error() to map status register bits
1028 * onto sense key, asc & ascq.
1031 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1032 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1033 &sb[1], &sb[2], &sb[3], verbose);
1037 block = ata_tf_read_block(&qc->result_tf, dev);
1039 /* information sense data descriptor */
1044 desc[2] |= 0x80; /* valid */
1045 desc[6] = block >> 40;
1046 desc[7] = block >> 32;
1047 desc[8] = block >> 24;
1048 desc[9] = block >> 16;
1049 desc[10] = block >> 8;
1053 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1055 sdev->use_10_for_rw = 1;
1056 sdev->use_10_for_ms = 1;
1058 /* Schedule policy is determined by ->qc_defer() callback and
1059 * it needs to see every deferred qc. Set dev_blocked to 1 to
1060 * prevent SCSI midlayer from automatically deferring
1063 sdev->max_device_blocked = 1;
1067 * atapi_drain_needed - Check whether data transfer may overflow
1068 * @rq: request to be checked
1070 * ATAPI commands which transfer variable length data to host
1071 * might overflow due to application error or hardare bug. This
1072 * function checks whether overflow should be drained and ignored
1079 * 1 if ; otherwise, 0.
1081 static int atapi_drain_needed(struct request *rq)
1083 if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
1086 if (!blk_rq_bytes(rq) || (rq->cmd_flags & REQ_WRITE))
1089 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1092 static int ata_scsi_dev_config(struct scsi_device *sdev,
1093 struct ata_device *dev)
1095 if (!ata_id_has_unload(dev->id))
1096 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1098 /* configure max sectors */
1099 blk_queue_max_hw_sectors(sdev->request_queue, dev->max_sectors);
1101 if (dev->class == ATA_DEV_ATAPI) {
1102 struct request_queue *q = sdev->request_queue;
1105 /* set the min alignment and padding */
1106 blk_queue_update_dma_alignment(sdev->request_queue,
1107 ATA_DMA_PAD_SZ - 1);
1108 blk_queue_update_dma_pad(sdev->request_queue,
1109 ATA_DMA_PAD_SZ - 1);
1111 /* configure draining */
1112 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1114 ata_dev_printk(dev, KERN_ERR,
1115 "drain buffer allocation failed\n");
1119 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1121 /* ATA devices must be sector aligned */
1122 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1123 blk_queue_update_dma_alignment(sdev->request_queue,
1124 sdev->sector_size - 1);
1125 sdev->manage_start_stop = 1;
1128 if (dev->flags & ATA_DFLAG_AN)
1129 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1131 if (dev->flags & ATA_DFLAG_NCQ) {
1134 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1135 depth = min(ATA_MAX_QUEUE - 1, depth);
1136 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1144 * ata_scsi_slave_config - Set SCSI device attributes
1145 * @sdev: SCSI device to examine
1147 * This is called before we actually start reading
1148 * and writing to the device, to configure certain
1149 * SCSI mid-layer behaviors.
1152 * Defined by SCSI layer. We don't really care.
1155 int ata_scsi_slave_config(struct scsi_device *sdev)
1157 struct ata_port *ap = ata_shost_to_port(sdev->host);
1158 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1161 ata_scsi_sdev_config(sdev);
1164 rc = ata_scsi_dev_config(sdev, dev);
1170 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1171 * @sdev: SCSI device to be destroyed
1173 * @sdev is about to be destroyed for hot/warm unplugging. If
1174 * this unplugging was initiated by libata as indicated by NULL
1175 * dev->sdev, this function doesn't have to do anything.
1176 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1177 * Clear dev->sdev, schedule the device for ATA detach and invoke
1181 * Defined by SCSI layer. We don't really care.
1183 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1185 struct ata_port *ap = ata_shost_to_port(sdev->host);
1186 struct request_queue *q = sdev->request_queue;
1187 unsigned long flags;
1188 struct ata_device *dev;
1190 if (!ap->ops->error_handler)
1193 spin_lock_irqsave(ap->lock, flags);
1194 dev = __ata_scsi_find_dev(ap, sdev);
1195 if (dev && dev->sdev) {
1196 /* SCSI device already in CANCEL state, no need to offline it */
1198 dev->flags |= ATA_DFLAG_DETACH;
1199 ata_port_schedule_eh(ap);
1201 spin_unlock_irqrestore(ap->lock, flags);
1203 kfree(q->dma_drain_buffer);
1204 q->dma_drain_buffer = NULL;
1205 q->dma_drain_size = 0;
1209 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1210 * @sdev: SCSI device to configure queue depth for
1211 * @queue_depth: new queue depth
1212 * @reason: calling context
1214 * This is libata standard hostt->change_queue_depth callback.
1215 * SCSI will call into this callback when user tries to set queue
1219 * SCSI layer (we don't care)
1222 * Newly configured queue depth.
1224 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth,
1227 struct ata_port *ap = ata_shost_to_port(sdev->host);
1228 struct ata_device *dev;
1229 unsigned long flags;
1231 if (reason != SCSI_QDEPTH_DEFAULT)
1234 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1235 return sdev->queue_depth;
1237 dev = ata_scsi_find_dev(ap, sdev);
1238 if (!dev || !ata_dev_enabled(dev))
1239 return sdev->queue_depth;
1242 spin_lock_irqsave(ap->lock, flags);
1243 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1244 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1245 dev->flags |= ATA_DFLAG_NCQ_OFF;
1248 spin_unlock_irqrestore(ap->lock, flags);
1250 /* limit and apply queue depth */
1251 queue_depth = min(queue_depth, sdev->host->can_queue);
1252 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1253 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1255 if (sdev->queue_depth == queue_depth)
1258 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1263 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1264 * @qc: Storage for translated ATA taskfile
1266 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1267 * (to start). Perhaps these commands should be preceded by
1268 * CHECK POWER MODE to see what power mode the device is already in.
1269 * [See SAT revision 5 at www.t10.org]
1272 * spin_lock_irqsave(host lock)
1275 * Zero on success, non-zero on error.
1277 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1279 struct scsi_cmnd *scmd = qc->scsicmd;
1280 struct ata_taskfile *tf = &qc->tf;
1281 const u8 *cdb = scmd->cmnd;
1283 if (scmd->cmd_len < 5)
1286 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1287 tf->protocol = ATA_PROT_NODATA;
1289 ; /* ignore IMMED bit, violates sat-r05 */
1292 goto invalid_fld; /* LOEJ bit set not supported */
1293 if (((cdb[4] >> 4) & 0xf) != 0)
1294 goto invalid_fld; /* power conditions not supported */
1297 tf->nsect = 1; /* 1 sector, lba=0 */
1299 if (qc->dev->flags & ATA_DFLAG_LBA) {
1300 tf->flags |= ATA_TFLAG_LBA;
1305 tf->device |= ATA_LBA;
1308 tf->lbal = 0x1; /* sect */
1309 tf->lbam = 0x0; /* cyl low */
1310 tf->lbah = 0x0; /* cyl high */
1313 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1315 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1316 * or S5) causing some drives to spin up and down again.
1318 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1319 system_state == SYSTEM_POWER_OFF)
1322 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1323 system_entering_hibernation())
1326 /* Issue ATA STANDBY IMMEDIATE command */
1327 tf->command = ATA_CMD_STANDBYNOW1;
1331 * Standby and Idle condition timers could be implemented but that
1332 * would require libata to implement the Power condition mode page
1333 * and allow the user to change it. Changing mode pages requires
1334 * MODE SELECT to be implemented.
1340 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1341 /* "Invalid field in cbd" */
1344 scmd->result = SAM_STAT_GOOD;
1350 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1351 * @qc: Storage for translated ATA taskfile
1353 * Sets up an ATA taskfile to issue FLUSH CACHE or
1357 * spin_lock_irqsave(host lock)
1360 * Zero on success, non-zero on error.
1362 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1364 struct ata_taskfile *tf = &qc->tf;
1366 tf->flags |= ATA_TFLAG_DEVICE;
1367 tf->protocol = ATA_PROT_NODATA;
1369 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1370 tf->command = ATA_CMD_FLUSH_EXT;
1372 tf->command = ATA_CMD_FLUSH;
1374 /* flush is critical for IO integrity, consider it an IO command */
1375 qc->flags |= ATA_QCFLAG_IO;
1381 * scsi_6_lba_len - Get LBA and transfer length
1382 * @cdb: SCSI command to translate
1384 * Calculate LBA and transfer length for 6-byte commands.
1388 * @plen: the transfer length
1390 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1395 VPRINTK("six-byte command\n");
1397 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1398 lba |= ((u64)cdb[2]) << 8;
1399 lba |= ((u64)cdb[3]);
1408 * scsi_10_lba_len - Get LBA and transfer length
1409 * @cdb: SCSI command to translate
1411 * Calculate LBA and transfer length for 10-byte commands.
1415 * @plen: the transfer length
1417 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1422 VPRINTK("ten-byte command\n");
1424 lba |= ((u64)cdb[2]) << 24;
1425 lba |= ((u64)cdb[3]) << 16;
1426 lba |= ((u64)cdb[4]) << 8;
1427 lba |= ((u64)cdb[5]);
1429 len |= ((u32)cdb[7]) << 8;
1430 len |= ((u32)cdb[8]);
1437 * scsi_16_lba_len - Get LBA and transfer length
1438 * @cdb: SCSI command to translate
1440 * Calculate LBA and transfer length for 16-byte commands.
1444 * @plen: the transfer length
1446 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1451 VPRINTK("sixteen-byte command\n");
1453 lba |= ((u64)cdb[2]) << 56;
1454 lba |= ((u64)cdb[3]) << 48;
1455 lba |= ((u64)cdb[4]) << 40;
1456 lba |= ((u64)cdb[5]) << 32;
1457 lba |= ((u64)cdb[6]) << 24;
1458 lba |= ((u64)cdb[7]) << 16;
1459 lba |= ((u64)cdb[8]) << 8;
1460 lba |= ((u64)cdb[9]);
1462 len |= ((u32)cdb[10]) << 24;
1463 len |= ((u32)cdb[11]) << 16;
1464 len |= ((u32)cdb[12]) << 8;
1465 len |= ((u32)cdb[13]);
1472 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1473 * @qc: Storage for translated ATA taskfile
1475 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1478 * spin_lock_irqsave(host lock)
1481 * Zero on success, non-zero on error.
1483 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1485 struct scsi_cmnd *scmd = qc->scsicmd;
1486 struct ata_taskfile *tf = &qc->tf;
1487 struct ata_device *dev = qc->dev;
1488 u64 dev_sectors = qc->dev->n_sectors;
1489 const u8 *cdb = scmd->cmnd;
1493 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1494 tf->protocol = ATA_PROT_NODATA;
1496 if (cdb[0] == VERIFY) {
1497 if (scmd->cmd_len < 10)
1499 scsi_10_lba_len(cdb, &block, &n_block);
1500 } else if (cdb[0] == VERIFY_16) {
1501 if (scmd->cmd_len < 16)
1503 scsi_16_lba_len(cdb, &block, &n_block);
1509 if (block >= dev_sectors)
1511 if ((block + n_block) > dev_sectors)
1514 if (dev->flags & ATA_DFLAG_LBA) {
1515 tf->flags |= ATA_TFLAG_LBA;
1517 if (lba_28_ok(block, n_block)) {
1519 tf->command = ATA_CMD_VERIFY;
1520 tf->device |= (block >> 24) & 0xf;
1521 } else if (lba_48_ok(block, n_block)) {
1522 if (!(dev->flags & ATA_DFLAG_LBA48))
1526 tf->flags |= ATA_TFLAG_LBA48;
1527 tf->command = ATA_CMD_VERIFY_EXT;
1529 tf->hob_nsect = (n_block >> 8) & 0xff;
1531 tf->hob_lbah = (block >> 40) & 0xff;
1532 tf->hob_lbam = (block >> 32) & 0xff;
1533 tf->hob_lbal = (block >> 24) & 0xff;
1535 /* request too large even for LBA48 */
1538 tf->nsect = n_block & 0xff;
1540 tf->lbah = (block >> 16) & 0xff;
1541 tf->lbam = (block >> 8) & 0xff;
1542 tf->lbal = block & 0xff;
1544 tf->device |= ATA_LBA;
1547 u32 sect, head, cyl, track;
1549 if (!lba_28_ok(block, n_block))
1552 /* Convert LBA to CHS */
1553 track = (u32)block / dev->sectors;
1554 cyl = track / dev->heads;
1555 head = track % dev->heads;
1556 sect = (u32)block % dev->sectors + 1;
1558 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1559 (u32)block, track, cyl, head, sect);
1561 /* Check whether the converted CHS can fit.
1565 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1568 tf->command = ATA_CMD_VERIFY;
1569 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1572 tf->lbah = cyl >> 8;
1579 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1580 /* "Invalid field in cbd" */
1584 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1585 /* "Logical Block Address out of range" */
1589 scmd->result = SAM_STAT_GOOD;
1594 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1595 * @qc: Storage for translated ATA taskfile
1597 * Converts any of six SCSI read/write commands into the
1598 * ATA counterpart, including starting sector (LBA),
1599 * sector count, and taking into account the device's LBA48
1602 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1603 * %WRITE_16 are currently supported.
1606 * spin_lock_irqsave(host lock)
1609 * Zero on success, non-zero on error.
1611 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1613 struct scsi_cmnd *scmd = qc->scsicmd;
1614 const u8 *cdb = scmd->cmnd;
1615 unsigned int tf_flags = 0;
1620 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1621 tf_flags |= ATA_TFLAG_WRITE;
1623 /* Calculate the SCSI LBA, transfer length and FUA. */
1627 if (unlikely(scmd->cmd_len < 10))
1629 scsi_10_lba_len(cdb, &block, &n_block);
1630 if (unlikely(cdb[1] & (1 << 3)))
1631 tf_flags |= ATA_TFLAG_FUA;
1635 if (unlikely(scmd->cmd_len < 6))
1637 scsi_6_lba_len(cdb, &block, &n_block);
1639 /* for 6-byte r/w commands, transfer length 0
1640 * means 256 blocks of data, not 0 block.
1647 if (unlikely(scmd->cmd_len < 16))
1649 scsi_16_lba_len(cdb, &block, &n_block);
1650 if (unlikely(cdb[1] & (1 << 3)))
1651 tf_flags |= ATA_TFLAG_FUA;
1654 DPRINTK("no-byte command\n");
1658 /* Check and compose ATA command */
1660 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1661 * length 0 means transfer 0 block of data.
1662 * However, for ATA R/W commands, sector count 0 means
1663 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1665 * WARNING: one or two older ATA drives treat 0 as 0...
1669 qc->flags |= ATA_QCFLAG_IO;
1670 qc->nbytes = n_block * scmd->device->sector_size;
1672 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1674 if (likely(rc == 0))
1679 /* treat all other errors as -EINVAL, fall through */
1681 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1682 /* "Invalid field in cbd" */
1686 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1687 /* "Logical Block Address out of range" */
1691 scmd->result = SAM_STAT_GOOD;
1695 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1697 struct ata_port *ap = qc->ap;
1698 struct scsi_cmnd *cmd = qc->scsicmd;
1699 u8 *cdb = cmd->cmnd;
1700 int need_sense = (qc->err_mask != 0);
1702 /* For ATA pass thru (SAT) commands, generate a sense block if
1703 * user mandated it or if there's an error. Note that if we
1704 * generate because the user forced us to, a check condition
1705 * is generated and the ATA register values are returned
1706 * whether the command completed successfully or not. If there
1707 * was no error, SK, ASC and ASCQ will all be zero.
1709 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1710 ((cdb[2] & 0x20) || need_sense)) {
1711 ata_gen_passthru_sense(qc);
1714 cmd->result = SAM_STAT_GOOD;
1716 /* TODO: decide which descriptor format to use
1717 * for 48b LBA devices and call that here
1718 * instead of the fixed desc, which is only
1719 * good for smaller LBA (and maybe CHS?)
1722 ata_gen_ata_sense(qc);
1726 if (need_sense && !ap->ops->error_handler)
1727 ata_dump_status(ap->print_id, &qc->result_tf);
1735 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1736 * @dev: ATA device to which the command is addressed
1737 * @cmd: SCSI command to execute
1738 * @done: SCSI command completion function
1739 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1741 * Our ->queuecommand() function has decided that the SCSI
1742 * command issued can be directly translated into an ATA
1743 * command, rather than handled internally.
1745 * This function sets up an ata_queued_cmd structure for the
1746 * SCSI command, and sends that ata_queued_cmd to the hardware.
1748 * The xlat_func argument (actor) returns 0 if ready to execute
1749 * ATA command, else 1 to finish translation. If 1 is returned
1750 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1751 * to be set reflecting an error condition or clean (early)
1755 * spin_lock_irqsave(host lock)
1758 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1759 * needs to be deferred.
1761 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1762 void (*done)(struct scsi_cmnd *),
1763 ata_xlat_func_t xlat_func)
1765 struct ata_port *ap = dev->link->ap;
1766 struct ata_queued_cmd *qc;
1771 qc = ata_scsi_qc_new(dev, cmd, done);
1775 /* data is present; dma-map it */
1776 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1777 cmd->sc_data_direction == DMA_TO_DEVICE) {
1778 if (unlikely(scsi_bufflen(cmd) < 1)) {
1779 ata_dev_printk(dev, KERN_WARNING,
1780 "WARNING: zero len r/w req\n");
1784 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1786 qc->dma_dir = cmd->sc_data_direction;
1789 qc->complete_fn = ata_scsi_qc_complete;
1794 if (ap->ops->qc_defer) {
1795 if ((rc = ap->ops->qc_defer(qc)))
1799 /* select device, send command to hardware */
1808 DPRINTK("EXIT - early finish (good or error)\n");
1813 cmd->result = (DID_ERROR << 16);
1816 DPRINTK("EXIT - internal\n");
1821 DPRINTK("EXIT - defer\n");
1822 if (rc == ATA_DEFER_LINK)
1823 return SCSI_MLQUEUE_DEVICE_BUSY;
1825 return SCSI_MLQUEUE_HOST_BUSY;
1829 * ata_scsi_rbuf_get - Map response buffer.
1830 * @cmd: SCSI command containing buffer to be mapped.
1831 * @flags: unsigned long variable to store irq enable status
1832 * @copy_in: copy in from user buffer
1834 * Prepare buffer for simulated SCSI commands.
1837 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1840 * Pointer to response buffer.
1842 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1843 unsigned long *flags)
1845 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1847 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1849 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1850 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1851 return ata_scsi_rbuf;
1855 * ata_scsi_rbuf_put - Unmap response buffer.
1856 * @cmd: SCSI command containing buffer to be unmapped.
1857 * @copy_out: copy out result
1858 * @flags: @flags passed to ata_scsi_rbuf_get()
1860 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1861 * @copy_back is true.
1864 * Unlocks ata_scsi_rbuf_lock.
1866 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1867 unsigned long *flags)
1870 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1871 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1872 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1876 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1877 * @args: device IDENTIFY data / SCSI command of interest.
1878 * @actor: Callback hook for desired SCSI command simulator
1880 * Takes care of the hard work of simulating a SCSI command...
1881 * Mapping the response buffer, calling the command's handler,
1882 * and handling the handler's return value. This return value
1883 * indicates whether the handler wishes the SCSI command to be
1884 * completed successfully (0), or not (in which case cmd->result
1885 * and sense buffer are assumed to be set).
1888 * spin_lock_irqsave(host lock)
1890 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1891 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1895 struct scsi_cmnd *cmd = args->cmd;
1896 unsigned long flags;
1898 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1899 rc = actor(args, rbuf);
1900 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1903 cmd->result = SAM_STAT_GOOD;
1908 * ata_scsiop_inq_std - Simulate INQUIRY command
1909 * @args: device IDENTIFY data / SCSI command of interest.
1910 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1912 * Returns standard device identification data associated
1913 * with non-VPD INQUIRY command output.
1916 * spin_lock_irqsave(host lock)
1918 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1920 const u8 versions[] = {
1921 0x60, /* SAM-3 (no version claimed) */
1924 0x20, /* SBC-2 (no version claimed) */
1927 0x60 /* SPC-3 (no version claimed) */
1932 0x5, /* claim SPC-3 version compatibility */
1939 /* set scsi removeable (RMB) bit per ata bit */
1940 if (ata_id_removeable(args->id))
1943 memcpy(rbuf, hdr, sizeof(hdr));
1944 memcpy(&rbuf[8], "ATA ", 8);
1945 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1946 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1948 if (rbuf[32] == 0 || rbuf[32] == ' ')
1949 memcpy(&rbuf[32], "n/a ", 4);
1951 memcpy(rbuf + 59, versions, sizeof(versions));
1957 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1958 * @args: device IDENTIFY data / SCSI command of interest.
1959 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1961 * Returns list of inquiry VPD pages available.
1964 * spin_lock_irqsave(host lock)
1966 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1968 const u8 pages[] = {
1969 0x00, /* page 0x00, this page */
1970 0x80, /* page 0x80, unit serial no page */
1971 0x83, /* page 0x83, device ident page */
1972 0x89, /* page 0x89, ata info page */
1973 0xb0, /* page 0xb0, block limits page */
1974 0xb1, /* page 0xb1, block device characteristics page */
1977 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1978 memcpy(rbuf + 4, pages, sizeof(pages));
1983 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1984 * @args: device IDENTIFY data / SCSI command of interest.
1985 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1987 * Returns ATA device serial number.
1990 * spin_lock_irqsave(host lock)
1992 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1996 0x80, /* this page code */
1998 ATA_ID_SERNO_LEN, /* page len */
2001 memcpy(rbuf, hdr, sizeof(hdr));
2002 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2003 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2008 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2009 * @args: device IDENTIFY data / SCSI command of interest.
2010 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2012 * Yields two logical unit device identification designators:
2013 * - vendor specific ASCII containing the ATA serial number
2014 * - SAT defined "t10 vendor id based" containing ASCII vendor
2015 * name ("ATA "), model and serial numbers.
2018 * spin_lock_irqsave(host lock)
2020 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2022 const int sat_model_serial_desc_len = 68;
2025 rbuf[1] = 0x83; /* this page code */
2028 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2030 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2032 ata_id_string(args->id, (unsigned char *) rbuf + num,
2033 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2034 num += ATA_ID_SERNO_LEN;
2036 /* SAT defined lu model and serial numbers descriptor */
2037 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2040 rbuf[num + 3] = sat_model_serial_desc_len;
2042 memcpy(rbuf + num, "ATA ", 8);
2044 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2046 num += ATA_ID_PROD_LEN;
2047 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2049 num += ATA_ID_SERNO_LEN;
2051 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2056 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2057 * @args: device IDENTIFY data / SCSI command of interest.
2058 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2060 * Yields SAT-specified ATA VPD page.
2063 * spin_lock_irqsave(host lock)
2065 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2067 struct ata_taskfile tf;
2069 memset(&tf, 0, sizeof(tf));
2071 rbuf[1] = 0x89; /* our page code */
2072 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2073 rbuf[3] = (0x238 & 0xff);
2075 memcpy(&rbuf[8], "linux ", 8);
2076 memcpy(&rbuf[16], "libata ", 16);
2077 memcpy(&rbuf[32], DRV_VERSION, 4);
2078 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2080 /* we don't store the ATA device signature, so we fake it */
2082 tf.command = ATA_DRDY; /* really, this is Status reg */
2086 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2087 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2089 rbuf[56] = ATA_CMD_ID_ATA;
2091 memcpy(&rbuf[60], &args->id[0], 512);
2095 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2100 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2103 * Optimal transfer length granularity.
2105 * This is always one physical block, but for disks with a smaller
2106 * logical than physical sector size we need to figure out what the
2109 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2110 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2113 * Optimal unmap granularity.
2115 * The ATA spec doesn't even know about a granularity or alignment
2116 * for the TRIM command. We can leave away most of the unmap related
2117 * VPD page entries, but we have specifify a granularity to signal
2118 * that we support some form of unmap - in thise case via WRITE SAME
2119 * with the unmap bit set.
2121 if (ata_id_has_trim(args->id)) {
2122 put_unaligned_be32(65535 * 512 / 8, &rbuf[20]);
2123 put_unaligned_be32(1, &rbuf[28]);
2129 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2131 int form_factor = ata_id_form_factor(args->id);
2132 int media_rotation_rate = ata_id_rotation_rate(args->id);
2136 rbuf[4] = media_rotation_rate >> 8;
2137 rbuf[5] = media_rotation_rate;
2138 rbuf[7] = form_factor;
2144 * ata_scsiop_noop - Command handler that simply returns success.
2145 * @args: device IDENTIFY data / SCSI command of interest.
2146 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2148 * No operation. Simply returns success to caller, to indicate
2149 * that the caller should successfully complete this SCSI command.
2152 * spin_lock_irqsave(host lock)
2154 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2161 * ata_msense_caching - Simulate MODE SENSE caching info page
2162 * @id: device IDENTIFY data
2163 * @buf: output buffer
2165 * Generate a caching info page, which conditionally indicates
2166 * write caching to the SCSI layer, depending on device
2172 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2174 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2175 if (ata_id_wcache_enabled(id))
2176 buf[2] |= (1 << 2); /* write cache enable */
2177 if (!ata_id_rahead_enabled(id))
2178 buf[12] |= (1 << 5); /* disable read ahead */
2179 return sizeof(def_cache_mpage);
2183 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2184 * @buf: output buffer
2186 * Generate a generic MODE SENSE control mode page.
2191 static unsigned int ata_msense_ctl_mode(u8 *buf)
2193 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2194 return sizeof(def_control_mpage);
2198 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2199 * @buf: output buffer
2201 * Generate a generic MODE SENSE r/w error recovery page.
2206 static unsigned int ata_msense_rw_recovery(u8 *buf)
2208 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2209 return sizeof(def_rw_recovery_mpage);
2213 * We can turn this into a real blacklist if it's needed, for now just
2214 * blacklist any Maxtor BANC1G10 revision firmware
2216 static int ata_dev_supports_fua(u16 *id)
2218 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2222 if (!ata_id_has_fua(id))
2225 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2226 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2228 if (strcmp(model, "Maxtor"))
2230 if (strcmp(fw, "BANC1G10"))
2233 return 0; /* blacklisted */
2237 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2238 * @args: device IDENTIFY data / SCSI command of interest.
2239 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2241 * Simulate MODE SENSE commands. Assume this is invoked for direct
2242 * access devices (e.g. disks) only. There should be no block
2243 * descriptor for other device types.
2246 * spin_lock_irqsave(host lock)
2248 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2250 struct ata_device *dev = args->dev;
2251 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2252 const u8 sat_blk_desc[] = {
2253 0, 0, 0, 0, /* number of blocks: sat unspecified */
2255 0, 0x2, 0x0 /* block length: 512 bytes */
2258 unsigned int ebd, page_control, six_byte;
2263 six_byte = (scsicmd[0] == MODE_SENSE);
2264 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2266 * LLBA bit in msense(10) ignored (compliant)
2269 page_control = scsicmd[2] >> 6;
2270 switch (page_control) {
2271 case 0: /* current */
2272 break; /* supported */
2274 goto saving_not_supp;
2275 case 1: /* changeable */
2276 case 2: /* defaults */
2282 p += 4 + (ebd ? 8 : 0);
2284 p += 8 + (ebd ? 8 : 0);
2286 pg = scsicmd[2] & 0x3f;
2289 * No mode subpages supported (yet) but asking for _all_
2290 * subpages may be valid
2292 if (spg && (spg != ALL_SUB_MPAGES))
2296 case RW_RECOVERY_MPAGE:
2297 p += ata_msense_rw_recovery(p);
2301 p += ata_msense_caching(args->id, p);
2305 p += ata_msense_ctl_mode(p);
2309 p += ata_msense_rw_recovery(p);
2310 p += ata_msense_caching(args->id, p);
2311 p += ata_msense_ctl_mode(p);
2314 default: /* invalid page code */
2319 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2320 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2324 rbuf[0] = p - rbuf - 1;
2327 rbuf[3] = sizeof(sat_blk_desc);
2328 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2331 unsigned int output_len = p - rbuf - 2;
2333 rbuf[0] = output_len >> 8;
2334 rbuf[1] = output_len;
2337 rbuf[7] = sizeof(sat_blk_desc);
2338 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2344 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2345 /* "Invalid field in cbd" */
2349 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2350 /* "Saving parameters not supported" */
2355 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2356 * @args: device IDENTIFY data / SCSI command of interest.
2357 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2359 * Simulate READ CAPACITY commands.
2364 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2366 struct ata_device *dev = args->dev;
2367 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2368 u32 sector_size; /* physical sector size in bytes */
2372 sector_size = ata_id_logical_sector_size(dev->id);
2373 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2374 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2378 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2379 if (last_lba >= 0xffffffffULL)
2380 last_lba = 0xffffffff;
2382 /* sector count, 32-bit */
2383 rbuf[0] = last_lba >> (8 * 3);
2384 rbuf[1] = last_lba >> (8 * 2);
2385 rbuf[2] = last_lba >> (8 * 1);
2389 rbuf[4] = sector_size >> (8 * 3);
2390 rbuf[5] = sector_size >> (8 * 2);
2391 rbuf[6] = sector_size >> (8 * 1);
2392 rbuf[7] = sector_size;
2394 /* sector count, 64-bit */
2395 rbuf[0] = last_lba >> (8 * 7);
2396 rbuf[1] = last_lba >> (8 * 6);
2397 rbuf[2] = last_lba >> (8 * 5);
2398 rbuf[3] = last_lba >> (8 * 4);
2399 rbuf[4] = last_lba >> (8 * 3);
2400 rbuf[5] = last_lba >> (8 * 2);
2401 rbuf[6] = last_lba >> (8 * 1);
2405 rbuf[ 8] = sector_size >> (8 * 3);
2406 rbuf[ 9] = sector_size >> (8 * 2);
2407 rbuf[10] = sector_size >> (8 * 1);
2408 rbuf[11] = sector_size;
2411 rbuf[13] = log2_per_phys;
2412 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2413 rbuf[15] = lowest_aligned;
2415 if (ata_id_has_trim(args->id)) {
2416 rbuf[14] |= 0x80; /* TPE */
2418 if (ata_id_has_zero_after_trim(args->id))
2419 rbuf[14] |= 0x40; /* TPRZ */
2427 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2428 * @args: device IDENTIFY data / SCSI command of interest.
2429 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2431 * Simulate REPORT LUNS command.
2434 * spin_lock_irqsave(host lock)
2436 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2439 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2444 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2446 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2447 /* FIXME: not quite right; we don't want the
2448 * translation of taskfile registers into
2449 * a sense descriptors, since that's only
2450 * correct for ATA, not ATAPI
2452 ata_gen_passthru_sense(qc);
2455 qc->scsidone(qc->scsicmd);
2459 /* is it pointless to prefer PIO for "safety reasons"? */
2460 static inline int ata_pio_use_silly(struct ata_port *ap)
2462 return (ap->flags & ATA_FLAG_PIO_DMA);
2465 static void atapi_request_sense(struct ata_queued_cmd *qc)
2467 struct ata_port *ap = qc->ap;
2468 struct scsi_cmnd *cmd = qc->scsicmd;
2470 DPRINTK("ATAPI request sense\n");
2472 /* FIXME: is this needed? */
2473 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2475 #ifdef CONFIG_ATA_SFF
2476 if (ap->ops->sff_tf_read)
2477 ap->ops->sff_tf_read(ap, &qc->tf);
2480 /* fill these in, for the case where they are -not- overwritten */
2481 cmd->sense_buffer[0] = 0x70;
2482 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2486 /* setup sg table and init transfer direction */
2487 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2488 ata_sg_init(qc, &qc->sgent, 1);
2489 qc->dma_dir = DMA_FROM_DEVICE;
2491 memset(&qc->cdb, 0, qc->dev->cdb_len);
2492 qc->cdb[0] = REQUEST_SENSE;
2493 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2495 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2496 qc->tf.command = ATA_CMD_PACKET;
2498 if (ata_pio_use_silly(ap)) {
2499 qc->tf.protocol = ATAPI_PROT_DMA;
2500 qc->tf.feature |= ATAPI_PKT_DMA;
2502 qc->tf.protocol = ATAPI_PROT_PIO;
2503 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2506 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2508 qc->complete_fn = atapi_sense_complete;
2515 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2517 struct scsi_cmnd *cmd = qc->scsicmd;
2518 unsigned int err_mask = qc->err_mask;
2520 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2522 /* handle completion from new EH */
2523 if (unlikely(qc->ap->ops->error_handler &&
2524 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2526 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2527 /* FIXME: not quite right; we don't want the
2528 * translation of taskfile registers into a
2529 * sense descriptors, since that's only
2530 * correct for ATA, not ATAPI
2532 ata_gen_passthru_sense(qc);
2535 /* SCSI EH automatically locks door if sdev->locked is
2536 * set. Sometimes door lock request continues to
2537 * fail, for example, when no media is present. This
2538 * creates a loop - SCSI EH issues door lock which
2539 * fails and gets invoked again to acquire sense data
2540 * for the failed command.
2542 * If door lock fails, always clear sdev->locked to
2543 * avoid this infinite loop.
2545 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2546 qc->dev->sdev->locked = 0;
2548 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2554 /* successful completion or old EH failure path */
2555 if (unlikely(err_mask & AC_ERR_DEV)) {
2556 cmd->result = SAM_STAT_CHECK_CONDITION;
2557 atapi_request_sense(qc);
2559 } else if (unlikely(err_mask)) {
2560 /* FIXME: not quite right; we don't want the
2561 * translation of taskfile registers into
2562 * a sense descriptors, since that's only
2563 * correct for ATA, not ATAPI
2565 ata_gen_passthru_sense(qc);
2567 u8 *scsicmd = cmd->cmnd;
2569 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2570 unsigned long flags;
2573 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2575 /* ATAPI devices typically report zero for their SCSI version,
2576 * and sometimes deviate from the spec WRT response data
2577 * format. If SCSI version is reported as zero like normal,
2578 * then we make the following fixups: 1) Fake MMC-5 version,
2579 * to indicate to the Linux scsi midlayer this is a modern
2580 * device. 2) Ensure response data format / ATAPI information
2581 * are always correct.
2588 ata_scsi_rbuf_put(cmd, true, &flags);
2591 cmd->result = SAM_STAT_GOOD;
2598 * atapi_xlat - Initialize PACKET taskfile
2599 * @qc: command structure to be initialized
2602 * spin_lock_irqsave(host lock)
2605 * Zero on success, non-zero on failure.
2607 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2609 struct scsi_cmnd *scmd = qc->scsicmd;
2610 struct ata_device *dev = qc->dev;
2611 int nodata = (scmd->sc_data_direction == DMA_NONE);
2612 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2613 unsigned int nbytes;
2615 memset(qc->cdb, 0, dev->cdb_len);
2616 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2618 qc->complete_fn = atapi_qc_complete;
2620 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2621 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2622 qc->tf.flags |= ATA_TFLAG_WRITE;
2623 DPRINTK("direction: write\n");
2626 qc->tf.command = ATA_CMD_PACKET;
2627 ata_qc_set_pc_nbytes(qc);
2629 /* check whether ATAPI DMA is safe */
2630 if (!nodata && !using_pio && atapi_check_dma(qc))
2633 /* Some controller variants snoop this value for Packet
2634 * transfers to do state machine and FIFO management. Thus we
2635 * want to set it properly, and for DMA where it is
2636 * effectively meaningless.
2638 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2640 /* Most ATAPI devices which honor transfer chunk size don't
2641 * behave according to the spec when odd chunk size which
2642 * matches the transfer length is specified. If the number of
2643 * bytes to transfer is 2n+1. According to the spec, what
2644 * should happen is to indicate that 2n+1 is going to be
2645 * transferred and transfer 2n+2 bytes where the last byte is
2648 * In practice, this doesn't happen. ATAPI devices first
2649 * indicate and transfer 2n bytes and then indicate and
2650 * transfer 2 bytes where the last byte is padding.
2652 * This inconsistency confuses several controllers which
2653 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2654 * These controllers use actual number of transferred bytes to
2655 * update DMA poitner and transfer of 4n+2 bytes make those
2656 * controller push DMA pointer by 4n+4 bytes because SATA data
2657 * FISes are aligned to 4 bytes. This causes data corruption
2658 * and buffer overrun.
2660 * Always setting nbytes to even number solves this problem
2661 * because then ATAPI devices don't have to split data at 2n
2667 qc->tf.lbam = (nbytes & 0xFF);
2668 qc->tf.lbah = (nbytes >> 8);
2671 qc->tf.protocol = ATAPI_PROT_NODATA;
2673 qc->tf.protocol = ATAPI_PROT_PIO;
2676 qc->tf.protocol = ATAPI_PROT_DMA;
2677 qc->tf.feature |= ATAPI_PKT_DMA;
2679 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2680 (scmd->sc_data_direction != DMA_TO_DEVICE))
2681 /* some SATA bridges need us to indicate data xfer direction */
2682 qc->tf.feature |= ATAPI_DMADIR;
2686 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2687 as ATAPI tape drives don't get this right otherwise */
2691 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2693 if (!sata_pmp_attached(ap)) {
2694 if (likely(devno < ata_link_max_devices(&ap->link)))
2695 return &ap->link.device[devno];
2697 if (likely(devno < ap->nr_pmp_links))
2698 return &ap->pmp_link[devno].device[0];
2704 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2705 const struct scsi_device *scsidev)
2709 /* skip commands not addressed to targets we simulate */
2710 if (!sata_pmp_attached(ap)) {
2711 if (unlikely(scsidev->channel || scsidev->lun))
2713 devno = scsidev->id;
2715 if (unlikely(scsidev->id || scsidev->lun))
2717 devno = scsidev->channel;
2720 return ata_find_dev(ap, devno);
2724 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2725 * @ap: ATA port to which the device is attached
2726 * @scsidev: SCSI device from which we derive the ATA device
2728 * Given various information provided in struct scsi_cmnd,
2729 * map that onto an ATA bus, and using that mapping
2730 * determine which ata_device is associated with the
2731 * SCSI command to be sent.
2734 * spin_lock_irqsave(host lock)
2737 * Associated ATA device, or %NULL if not found.
2739 static struct ata_device *
2740 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2742 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2744 if (unlikely(!dev || !ata_dev_enabled(dev)))
2751 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2752 * @byte1: Byte 1 from pass-thru CDB.
2755 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2758 ata_scsi_map_proto(u8 byte1)
2760 switch((byte1 & 0x1e) >> 1) {
2761 case 3: /* Non-data */
2762 return ATA_PROT_NODATA;
2765 case 10: /* UDMA Data-in */
2766 case 11: /* UDMA Data-Out */
2767 return ATA_PROT_DMA;
2769 case 4: /* PIO Data-in */
2770 case 5: /* PIO Data-out */
2771 return ATA_PROT_PIO;
2773 case 0: /* Hard Reset */
2775 case 8: /* Device Diagnostic */
2776 case 9: /* Device Reset */
2777 case 7: /* DMA Queued */
2778 case 12: /* FPDMA */
2779 case 15: /* Return Response Info */
2780 default: /* Reserved */
2784 return ATA_PROT_UNKNOWN;
2788 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2789 * @qc: command structure to be initialized
2791 * Handles either 12 or 16-byte versions of the CDB.
2794 * Zero on success, non-zero on failure.
2796 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2798 struct ata_taskfile *tf = &(qc->tf);
2799 struct scsi_cmnd *scmd = qc->scsicmd;
2800 struct ata_device *dev = qc->dev;
2801 const u8 *cdb = scmd->cmnd;
2803 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2807 * 12 and 16 byte CDBs use different offsets to
2808 * provide the various register values.
2810 if (cdb[0] == ATA_16) {
2812 * 16-byte CDB - may contain extended commands.
2814 * If that is the case, copy the upper byte register values.
2816 if (cdb[1] & 0x01) {
2817 tf->hob_feature = cdb[3];
2818 tf->hob_nsect = cdb[5];
2819 tf->hob_lbal = cdb[7];
2820 tf->hob_lbam = cdb[9];
2821 tf->hob_lbah = cdb[11];
2822 tf->flags |= ATA_TFLAG_LBA48;
2824 tf->flags &= ~ATA_TFLAG_LBA48;
2827 * Always copy low byte, device and command registers.
2829 tf->feature = cdb[4];
2834 tf->device = cdb[13];
2835 tf->command = cdb[14];
2838 * 12-byte CDB - incapable of extended commands.
2840 tf->flags &= ~ATA_TFLAG_LBA48;
2842 tf->feature = cdb[3];
2847 tf->device = cdb[8];
2848 tf->command = cdb[9];
2851 /* enforce correct master/slave bit */
2852 tf->device = dev->devno ?
2853 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2855 switch (tf->command) {
2856 /* READ/WRITE LONG use a non-standard sect_size */
2857 case ATA_CMD_READ_LONG:
2858 case ATA_CMD_READ_LONG_ONCE:
2859 case ATA_CMD_WRITE_LONG:
2860 case ATA_CMD_WRITE_LONG_ONCE:
2861 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2863 qc->sect_size = scsi_bufflen(scmd);
2866 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2867 case ATA_CMD_CFA_WRITE_NE:
2868 case ATA_CMD_CFA_TRANS_SECT:
2869 case ATA_CMD_CFA_WRITE_MULT_NE:
2870 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2872 case ATA_CMD_READ_EXT:
2873 case ATA_CMD_READ_QUEUED:
2874 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2875 case ATA_CMD_FPDMA_READ:
2876 case ATA_CMD_READ_MULTI:
2877 case ATA_CMD_READ_MULTI_EXT:
2878 case ATA_CMD_PIO_READ:
2879 case ATA_CMD_PIO_READ_EXT:
2880 case ATA_CMD_READ_STREAM_DMA_EXT:
2881 case ATA_CMD_READ_STREAM_EXT:
2882 case ATA_CMD_VERIFY:
2883 case ATA_CMD_VERIFY_EXT:
2885 case ATA_CMD_WRITE_EXT:
2886 case ATA_CMD_WRITE_FUA_EXT:
2887 case ATA_CMD_WRITE_QUEUED:
2888 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2889 case ATA_CMD_FPDMA_WRITE:
2890 case ATA_CMD_WRITE_MULTI:
2891 case ATA_CMD_WRITE_MULTI_EXT:
2892 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2893 case ATA_CMD_PIO_WRITE:
2894 case ATA_CMD_PIO_WRITE_EXT:
2895 case ATA_CMD_WRITE_STREAM_DMA_EXT:
2896 case ATA_CMD_WRITE_STREAM_EXT:
2897 qc->sect_size = scmd->device->sector_size;
2900 /* Everything else uses 512 byte "sectors" */
2902 qc->sect_size = ATA_SECT_SIZE;
2906 * Set flags so that all registers will be written, pass on
2907 * write indication (used for PIO/DMA setup), result TF is
2908 * copied back and we don't whine too much about its failure.
2910 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2911 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2912 tf->flags |= ATA_TFLAG_WRITE;
2914 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2917 * Set transfer length.
2919 * TODO: find out if we need to do more here to
2920 * cover scatter/gather case.
2922 ata_qc_set_pc_nbytes(qc);
2924 /* We may not issue DMA commands if no DMA mode is set */
2925 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2928 /* sanity check for pio multi commands */
2929 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2932 if (is_multi_taskfile(tf)) {
2933 unsigned int multi_count = 1 << (cdb[1] >> 5);
2935 /* compare the passed through multi_count
2936 * with the cached multi_count of libata
2938 if (multi_count != dev->multi_count)
2939 ata_dev_printk(dev, KERN_WARNING,
2940 "invalid multi_count %u ignored\n",
2945 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2946 * SET_FEATURES - XFER MODE must be preceded/succeeded
2947 * by an update to hardware-specific registers for each
2948 * controller (i.e. the reason for ->set_piomode(),
2949 * ->set_dmamode(), and ->post_set_mode() hooks).
2951 if (tf->command == ATA_CMD_SET_FEATURES &&
2952 tf->feature == SETFEATURES_XFER)
2956 * Filter TPM commands by default. These provide an
2957 * essentially uncontrolled encrypted "back door" between
2958 * applications and the disk. Set libata.allow_tpm=1 if you
2959 * have a real reason for wanting to use them. This ensures
2960 * that installed software cannot easily mess stuff up without
2961 * user intent. DVR type users will probably ship with this enabled
2962 * for movie content management.
2964 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2965 * for this and should do in future but that it is not sufficient as
2966 * DCS is an optional feature set. Thus we also do the software filter
2967 * so that we comply with the TC consortium stated goal that the user
2968 * can turn off TC features of their system.
2970 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2976 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2977 /* "Invalid field in cdb" */
2981 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
2983 struct ata_taskfile *tf = &qc->tf;
2984 struct scsi_cmnd *scmd = qc->scsicmd;
2985 struct ata_device *dev = qc->dev;
2986 const u8 *cdb = scmd->cmnd;
2992 /* we may not issue DMA commands if no DMA mode is set */
2993 if (unlikely(!dev->dma_mode))
2996 if (unlikely(scmd->cmd_len < 16))
2998 scsi_16_lba_len(cdb, &block, &n_block);
3000 /* for now we only support WRITE SAME with the unmap bit set */
3001 if (unlikely(!(cdb[1] & 0x8)))
3005 * WRITE SAME always has a sector sized buffer as payload, this
3006 * should never be a multiple entry S/G list.
3008 if (!scsi_sg_count(scmd))
3011 buf = page_address(sg_page(scsi_sglist(scmd)));
3012 size = ata_set_lba_range_entries(buf, 512, block, n_block);
3014 tf->protocol = ATA_PROT_DMA;
3015 tf->hob_feature = 0;
3016 tf->feature = ATA_DSM_TRIM;
3017 tf->hob_nsect = (size / 512) >> 8;
3018 tf->nsect = size / 512;
3019 tf->command = ATA_CMD_DSM;
3020 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3023 ata_qc_set_pc_nbytes(qc);
3028 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3029 /* "Invalid field in cdb" */
3034 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3036 * @cmd: SCSI command opcode to consider
3038 * Look up the SCSI command given, and determine whether the
3039 * SCSI command is to be translated or simulated.
3042 * Pointer to translation function if possible, %NULL if not.
3045 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3055 return ata_scsi_rw_xlat;
3058 return ata_scsi_write_same_xlat;
3060 case SYNCHRONIZE_CACHE:
3061 if (ata_try_flush_cache(dev))
3062 return ata_scsi_flush_xlat;
3067 return ata_scsi_verify_xlat;
3071 return ata_scsi_pass_thru;
3074 return ata_scsi_start_stop_xlat;
3081 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3082 * @ap: ATA port to which the command was being sent
3083 * @cmd: SCSI command to dump
3085 * Prints the contents of a SCSI command via printk().
3088 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3089 struct scsi_cmnd *cmd)
3092 struct scsi_device *scsidev = cmd->device;
3093 u8 *scsicmd = cmd->cmnd;
3095 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3097 scsidev->channel, scsidev->id, scsidev->lun,
3098 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3099 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3104 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3105 void (*done)(struct scsi_cmnd *),
3106 struct ata_device *dev)
3108 u8 scsi_op = scmd->cmnd[0];
3109 ata_xlat_func_t xlat_func;
3112 if (dev->class == ATA_DEV_ATA) {
3113 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3116 xlat_func = ata_get_xlat_func(dev, scsi_op);
3118 if (unlikely(!scmd->cmd_len))
3122 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3123 /* relay SCSI command to ATAPI device */
3124 int len = COMMAND_SIZE(scsi_op);
3125 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3128 xlat_func = atapi_xlat;
3130 /* ATA_16 passthru, treat as an ATA command */
3131 if (unlikely(scmd->cmd_len > 16))
3134 xlat_func = ata_get_xlat_func(dev, scsi_op);
3139 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
3141 ata_scsi_simulate(dev, scmd, done);
3146 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3147 scmd->cmd_len, scsi_op, dev->cdb_len);
3148 scmd->result = DID_ERROR << 16;
3154 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3155 * @cmd: SCSI command to be sent
3156 * @done: Completion function, called when command is complete
3158 * In some cases, this function translates SCSI commands into
3159 * ATA taskfiles, and queues the taskfiles to be sent to
3160 * hardware. In other cases, this function simulates a
3161 * SCSI device by evaluating and responding to certain
3162 * SCSI commands. This creates the overall effect of
3163 * ATA and ATAPI devices appearing as SCSI devices.
3166 * Releases scsi-layer-held lock, and obtains host lock.
3169 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3172 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3174 struct ata_port *ap;
3175 struct ata_device *dev;
3176 struct scsi_device *scsidev = cmd->device;
3177 struct Scsi_Host *shost = scsidev->host;
3180 ap = ata_shost_to_port(shost);
3182 spin_unlock(shost->host_lock);
3183 spin_lock(ap->lock);
3185 ata_scsi_dump_cdb(ap, cmd);
3187 dev = ata_scsi_find_dev(ap, scsidev);
3189 rc = __ata_scsi_queuecmd(cmd, done, dev);
3191 cmd->result = (DID_BAD_TARGET << 16);
3195 spin_unlock(ap->lock);
3196 spin_lock(shost->host_lock);
3201 * ata_scsi_simulate - simulate SCSI command on ATA device
3202 * @dev: the target device
3203 * @cmd: SCSI command being sent to device.
3204 * @done: SCSI command completion function.
3206 * Interprets and directly executes a select list of SCSI commands
3207 * that can be handled internally.
3210 * spin_lock_irqsave(host lock)
3213 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3214 void (*done)(struct scsi_cmnd *))
3216 struct ata_scsi_args args;
3217 const u8 *scsicmd = cmd->cmnd;
3225 switch(scsicmd[0]) {
3226 /* TODO: worth improving? */
3228 ata_scsi_invalid_field(cmd, done);
3232 if (scsicmd[1] & 2) /* is CmdDt set? */
3233 ata_scsi_invalid_field(cmd, done);
3234 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3235 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3236 else switch (scsicmd[2]) {
3238 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3241 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3244 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3247 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3250 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3253 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3256 ata_scsi_invalid_field(cmd, done);
3263 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3266 case MODE_SELECT: /* unconditionally return */
3267 case MODE_SELECT_10: /* bad-field-in-cdb */
3268 ata_scsi_invalid_field(cmd, done);
3272 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3275 case SERVICE_ACTION_IN:
3276 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3277 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3279 ata_scsi_invalid_field(cmd, done);
3283 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3287 ata_scsi_set_sense(cmd, 0, 0, 0);
3288 cmd->result = (DRIVER_SENSE << 24);
3292 /* if we reach this, then writeback caching is disabled,
3293 * turning this into a no-op.
3295 case SYNCHRONIZE_CACHE:
3298 /* no-op's, complete with success */
3302 case TEST_UNIT_READY:
3303 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3306 case SEND_DIAGNOSTIC:
3307 tmp8 = scsicmd[1] & ~(1 << 3);
3308 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3309 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3311 ata_scsi_invalid_field(cmd, done);
3314 /* all other commands */
3316 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3317 /* "Invalid command operation code" */
3323 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3327 for (i = 0; i < host->n_ports; i++) {
3328 struct ata_port *ap = host->ports[i];
3329 struct Scsi_Host *shost;
3332 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3336 *(struct ata_port **)&shost->hostdata[0] = ap;
3337 ap->scsi_host = shost;
3339 shost->transportt = ata_scsi_transport_template;
3340 shost->unique_id = ap->print_id;
3343 shost->max_channel = 1;
3344 shost->max_cmd_len = 16;
3346 /* Schedule policy is determined by ->qc_defer()
3347 * callback and it needs to see every deferred qc.
3348 * Set host_blocked to 1 to prevent SCSI midlayer from
3349 * automatically deferring requests.
3351 shost->max_host_blocked = 1;
3353 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3361 scsi_host_put(host->ports[i]->scsi_host);
3364 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3366 scsi_remove_host(shost);
3367 scsi_host_put(shost);
3372 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3375 struct ata_device *last_failed_dev = NULL;
3376 struct ata_link *link;
3377 struct ata_device *dev;
3380 ata_for_each_link(link, ap, EDGE) {
3381 ata_for_each_dev(dev, link, ENABLED) {
3382 struct scsi_device *sdev;
3383 int channel = 0, id = 0;
3388 if (ata_is_host_link(link))
3391 channel = link->pmp;
3393 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3395 if (!IS_ERR(sdev)) {
3397 scsi_device_put(sdev);
3404 /* If we scanned while EH was in progress or allocation
3405 * failure occurred, scan would have failed silently. Check
3406 * whether all devices are attached.
3408 ata_for_each_link(link, ap, EDGE) {
3409 ata_for_each_dev(dev, link, ENABLED) {
3418 /* we're missing some SCSI devices */
3420 /* If caller requested synchrnous scan && we've made
3421 * any progress, sleep briefly and repeat.
3423 if (dev != last_failed_dev) {
3425 last_failed_dev = dev;
3429 /* We might be failing to detect boot device, give it
3430 * a few more chances.
3437 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3438 "failed without making any progress,\n"
3439 " switching to async\n");
3442 queue_delayed_work(system_long_wq, &ap->hotplug_task,
3443 round_jiffies_relative(HZ));
3447 * ata_scsi_offline_dev - offline attached SCSI device
3448 * @dev: ATA device to offline attached SCSI device for
3450 * This function is called from ata_eh_hotplug() and responsible
3451 * for taking the SCSI device attached to @dev offline. This
3452 * function is called with host lock which protects dev->sdev
3456 * spin_lock_irqsave(host lock)
3459 * 1 if attached SCSI device exists, 0 otherwise.
3461 int ata_scsi_offline_dev(struct ata_device *dev)
3464 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3471 * ata_scsi_remove_dev - remove attached SCSI device
3472 * @dev: ATA device to remove attached SCSI device for
3474 * This function is called from ata_eh_scsi_hotplug() and
3475 * responsible for removing the SCSI device attached to @dev.
3478 * Kernel thread context (may sleep).
3480 static void ata_scsi_remove_dev(struct ata_device *dev)
3482 struct ata_port *ap = dev->link->ap;
3483 struct scsi_device *sdev;
3484 unsigned long flags;
3486 /* Alas, we need to grab scan_mutex to ensure SCSI device
3487 * state doesn't change underneath us and thus
3488 * scsi_device_get() always succeeds. The mutex locking can
3489 * be removed if there is __scsi_device_get() interface which
3490 * increments reference counts regardless of device state.
3492 mutex_lock(&ap->scsi_host->scan_mutex);
3493 spin_lock_irqsave(ap->lock, flags);
3495 /* clearing dev->sdev is protected by host lock */
3500 /* If user initiated unplug races with us, sdev can go
3501 * away underneath us after the host lock and
3502 * scan_mutex are released. Hold onto it.
3504 if (scsi_device_get(sdev) == 0) {
3505 /* The following ensures the attached sdev is
3506 * offline on return from ata_scsi_offline_dev()
3507 * regardless it wins or loses the race
3508 * against this function.
3510 scsi_device_set_state(sdev, SDEV_OFFLINE);
3517 spin_unlock_irqrestore(ap->lock, flags);
3518 mutex_unlock(&ap->scsi_host->scan_mutex);
3521 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3522 dev_name(&sdev->sdev_gendev));
3524 scsi_remove_device(sdev);
3525 scsi_device_put(sdev);
3529 static void ata_scsi_handle_link_detach(struct ata_link *link)
3531 struct ata_port *ap = link->ap;
3532 struct ata_device *dev;
3534 ata_for_each_dev(dev, link, ALL) {
3535 unsigned long flags;
3537 if (!(dev->flags & ATA_DFLAG_DETACHED))
3540 spin_lock_irqsave(ap->lock, flags);
3541 dev->flags &= ~ATA_DFLAG_DETACHED;
3542 spin_unlock_irqrestore(ap->lock, flags);
3544 ata_scsi_remove_dev(dev);
3549 * ata_scsi_media_change_notify - send media change event
3550 * @dev: Pointer to the disk device with media change event
3552 * Tell the block layer to send a media change notification
3556 * spin_lock_irqsave(host lock)
3558 void ata_scsi_media_change_notify(struct ata_device *dev)
3561 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3566 * ata_scsi_hotplug - SCSI part of hotplug
3567 * @work: Pointer to ATA port to perform SCSI hotplug on
3569 * Perform SCSI part of hotplug. It's executed from a separate
3570 * workqueue after EH completes. This is necessary because SCSI
3571 * hot plugging requires working EH and hot unplugging is
3572 * synchronized with hot plugging with a mutex.
3575 * Kernel thread context (may sleep).
3577 void ata_scsi_hotplug(struct work_struct *work)
3579 struct ata_port *ap =
3580 container_of(work, struct ata_port, hotplug_task.work);
3583 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3584 DPRINTK("ENTER/EXIT - unloading\n");
3589 mutex_lock(&ap->scsi_scan_mutex);
3591 /* Unplug detached devices. We cannot use link iterator here
3592 * because PMP links have to be scanned even if PMP is
3593 * currently not attached. Iterate manually.
3595 ata_scsi_handle_link_detach(&ap->link);
3597 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3598 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3600 /* scan for new ones */
3601 ata_scsi_scan_host(ap, 0);
3603 mutex_unlock(&ap->scsi_scan_mutex);
3608 * ata_scsi_user_scan - indication for user-initiated bus scan
3609 * @shost: SCSI host to scan
3610 * @channel: Channel to scan
3614 * This function is called when user explicitly requests bus
3615 * scan. Set probe pending flag and invoke EH.
3618 * SCSI layer (we don't care)
3623 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3624 unsigned int id, unsigned int lun)
3626 struct ata_port *ap = ata_shost_to_port(shost);
3627 unsigned long flags;
3630 if (!ap->ops->error_handler)
3633 if (lun != SCAN_WILD_CARD && lun)
3636 if (!sata_pmp_attached(ap)) {
3637 if (channel != SCAN_WILD_CARD && channel)
3641 if (id != SCAN_WILD_CARD && id)
3646 spin_lock_irqsave(ap->lock, flags);
3648 if (devno == SCAN_WILD_CARD) {
3649 struct ata_link *link;
3651 ata_for_each_link(link, ap, EDGE) {
3652 struct ata_eh_info *ehi = &link->eh_info;
3653 ehi->probe_mask |= ATA_ALL_DEVICES;
3654 ehi->action |= ATA_EH_RESET;
3657 struct ata_device *dev = ata_find_dev(ap, devno);
3660 struct ata_eh_info *ehi = &dev->link->eh_info;
3661 ehi->probe_mask |= 1 << dev->devno;
3662 ehi->action |= ATA_EH_RESET;
3668 ata_port_schedule_eh(ap);
3669 spin_unlock_irqrestore(ap->lock, flags);
3670 ata_port_wait_eh(ap);
3672 spin_unlock_irqrestore(ap->lock, flags);
3678 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3679 * @work: Pointer to ATA port to perform scsi_rescan_device()
3681 * After ATA pass thru (SAT) commands are executed successfully,
3682 * libata need to propagate the changes to SCSI layer.
3685 * Kernel thread context (may sleep).
3687 void ata_scsi_dev_rescan(struct work_struct *work)
3689 struct ata_port *ap =
3690 container_of(work, struct ata_port, scsi_rescan_task);
3691 struct ata_link *link;
3692 struct ata_device *dev;
3693 unsigned long flags;
3695 mutex_lock(&ap->scsi_scan_mutex);
3696 spin_lock_irqsave(ap->lock, flags);
3698 ata_for_each_link(link, ap, EDGE) {
3699 ata_for_each_dev(dev, link, ENABLED) {
3700 struct scsi_device *sdev = dev->sdev;
3704 if (scsi_device_get(sdev))
3707 spin_unlock_irqrestore(ap->lock, flags);
3708 scsi_rescan_device(&(sdev->sdev_gendev));
3709 scsi_device_put(sdev);
3710 spin_lock_irqsave(ap->lock, flags);
3714 spin_unlock_irqrestore(ap->lock, flags);
3715 mutex_unlock(&ap->scsi_scan_mutex);
3719 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3720 * @host: ATA host container for all SAS ports
3721 * @port_info: Information from low-level host driver
3722 * @shost: SCSI host that the scsi device is attached to
3725 * PCI/etc. bus probe sem.
3728 * ata_port pointer on success / NULL on failure.
3731 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3732 struct ata_port_info *port_info,
3733 struct Scsi_Host *shost)
3735 struct ata_port *ap;
3737 ap = ata_port_alloc(host);
3742 ap->lock = shost->host_lock;
3743 ap->pio_mask = port_info->pio_mask;
3744 ap->mwdma_mask = port_info->mwdma_mask;
3745 ap->udma_mask = port_info->udma_mask;
3746 ap->flags |= port_info->flags;
3747 ap->ops = port_info->port_ops;
3748 ap->cbl = ATA_CBL_SATA;
3752 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3755 * ata_sas_port_start - Set port up for dma.
3756 * @ap: Port to initialize
3758 * Called just after data structures for each port are
3761 * May be used as the port_start() entry in ata_port_operations.
3764 * Inherited from caller.
3766 int ata_sas_port_start(struct ata_port *ap)
3770 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3773 * ata_port_stop - Undo ata_sas_port_start()
3774 * @ap: Port to shut down
3776 * May be used as the port_stop() entry in ata_port_operations.
3779 * Inherited from caller.
3782 void ata_sas_port_stop(struct ata_port *ap)
3785 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3788 * ata_sas_port_init - Initialize a SATA device
3789 * @ap: SATA port to initialize
3792 * PCI/etc. bus probe sem.
3795 * Zero on success, non-zero on error.
3798 int ata_sas_port_init(struct ata_port *ap)
3800 int rc = ap->ops->port_start(ap);
3803 ap->print_id = ata_print_id++;
3804 rc = ata_bus_probe(ap);
3809 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3812 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3813 * @ap: SATA port to destroy
3817 void ata_sas_port_destroy(struct ata_port *ap)
3819 if (ap->ops->port_stop)
3820 ap->ops->port_stop(ap);
3823 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3826 * ata_sas_slave_configure - Default slave_config routine for libata devices
3827 * @sdev: SCSI device to configure
3828 * @ap: ATA port to which SCSI device is attached
3834 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3836 ata_scsi_sdev_config(sdev);
3837 ata_scsi_dev_config(sdev, ap->link.device);
3840 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3843 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3844 * @cmd: SCSI command to be sent
3845 * @done: Completion function, called when command is complete
3846 * @ap: ATA port to which the command is being sent
3849 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3853 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3854 struct ata_port *ap)
3858 ata_scsi_dump_cdb(ap, cmd);
3860 if (likely(ata_dev_enabled(ap->link.device)))
3861 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3863 cmd->result = (DID_BAD_TARGET << 16);
3868 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);