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_cmnd.h>
42 #include <scsi/scsi_eh.h>
43 #include <scsi/scsi_device.h>
44 #include <scsi/scsi_tcq.h>
45 #include <scsi/scsi_transport.h>
46 #include <linux/libata.h>
47 #include <linux/hdreg.h>
48 #include <linux/uaccess.h>
49 #include <linux/suspend.h>
50 #include <asm/unaligned.h>
54 #define SECTOR_SIZE 512
55 #define ATA_SCSI_RBUF_SIZE 4096
57 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
58 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
60 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
62 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
63 const struct scsi_device *scsidev);
64 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
65 const struct scsi_device *scsidev);
66 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
67 unsigned int id, unsigned int lun);
70 #define RW_RECOVERY_MPAGE 0x1
71 #define RW_RECOVERY_MPAGE_LEN 12
72 #define CACHE_MPAGE 0x8
73 #define CACHE_MPAGE_LEN 20
74 #define CONTROL_MPAGE 0xa
75 #define CONTROL_MPAGE_LEN 12
76 #define ALL_MPAGES 0x3f
77 #define ALL_SUB_MPAGES 0xff
80 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
82 RW_RECOVERY_MPAGE_LEN - 2,
84 0, /* read retry count */
86 0, /* write retry count */
90 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
93 0, /* contains WCE, needs to be 0 for logic */
94 0, 0, 0, 0, 0, 0, 0, 0, 0,
95 0, /* contains DRA, needs to be 0 for logic */
99 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
101 CONTROL_MPAGE_LEN - 2,
102 2, /* DSENSE=0, GLTSD=1 */
103 0, /* [QAM+QERR may be 1, see 05-359r1] */
104 0, 0, 0, 0, 0xff, 0xff,
105 0, 30 /* extended self test time, see 05-359r1 */
109 * libata transport template. libata doesn't do real transport stuff.
110 * It just needs the eh_timed_out hook.
112 static struct scsi_transport_template ata_scsi_transport_template = {
113 .eh_strategy_handler = ata_scsi_error,
114 .eh_timed_out = ata_scsi_timed_out,
115 .user_scan = ata_scsi_user_scan,
119 static const struct {
122 } link_pm_policy[] = {
123 { NOT_AVAILABLE, "max_performance" },
124 { MIN_POWER, "min_power" },
125 { MAX_PERFORMANCE, "max_performance" },
126 { MEDIUM_POWER, "medium_power" },
129 static const char *ata_scsi_lpm_get(enum link_pm policy)
133 for (i = 0; i < ARRAY_SIZE(link_pm_policy); i++)
134 if (link_pm_policy[i].value == policy)
135 return link_pm_policy[i].name;
140 static ssize_t ata_scsi_lpm_put(struct device *dev,
141 struct device_attribute *attr,
142 const char *buf, size_t count)
144 struct Scsi_Host *shost = class_to_shost(dev);
145 struct ata_port *ap = ata_shost_to_port(shost);
146 enum link_pm policy = 0;
150 * we are skipping array location 0 on purpose - this
151 * is because a value of NOT_AVAILABLE is displayed
152 * to the user as max_performance, but when the user
153 * writes "max_performance", they actually want the
154 * value to match MAX_PERFORMANCE.
156 for (i = 1; i < ARRAY_SIZE(link_pm_policy); i++) {
157 const int len = strlen(link_pm_policy[i].name);
158 if (strncmp(link_pm_policy[i].name, buf, len) == 0) {
159 policy = link_pm_policy[i].value;
166 ata_lpm_schedule(ap, policy);
171 ata_scsi_lpm_show(struct device *dev, struct device_attribute *attr, char *buf)
173 struct Scsi_Host *shost = class_to_shost(dev);
174 struct ata_port *ap = ata_shost_to_port(shost);
176 ata_scsi_lpm_get(ap->pm_policy);
181 return snprintf(buf, 23, "%s\n", policy);
183 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
184 ata_scsi_lpm_show, ata_scsi_lpm_put);
185 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
187 static ssize_t ata_scsi_park_show(struct device *device,
188 struct device_attribute *attr, char *buf)
190 struct scsi_device *sdev = to_scsi_device(device);
192 struct ata_link *link;
193 struct ata_device *dev;
194 unsigned long flags, now;
195 unsigned int uninitialized_var(msecs);
198 ap = ata_shost_to_port(sdev->host);
200 spin_lock_irqsave(ap->lock, flags);
201 dev = ata_scsi_find_dev(ap, sdev);
206 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
213 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
214 link->eh_context.unloaded_mask & (1 << dev->devno) &&
215 time_after(dev->unpark_deadline, now))
216 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
221 spin_unlock_irq(ap->lock);
223 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
226 static ssize_t ata_scsi_park_store(struct device *device,
227 struct device_attribute *attr,
228 const char *buf, size_t len)
230 struct scsi_device *sdev = to_scsi_device(device);
232 struct ata_device *dev;
237 rc = strict_strtol(buf, 10, &input);
238 if (rc || input < -2)
240 if (input > ATA_TMOUT_MAX_PARK) {
242 input = ATA_TMOUT_MAX_PARK;
245 ap = ata_shost_to_port(sdev->host);
247 spin_lock_irqsave(ap->lock, flags);
248 dev = ata_scsi_find_dev(ap, sdev);
249 if (unlikely(!dev)) {
253 if (dev->class != ATA_DEV_ATA) {
259 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
264 dev->unpark_deadline = ata_deadline(jiffies, input);
265 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
266 ata_port_schedule_eh(ap);
267 complete(&ap->park_req_pending);
271 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
274 dev->flags |= ATA_DFLAG_NO_UNLOAD;
279 spin_unlock_irqrestore(ap->lock, flags);
281 return rc ? rc : len;
283 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
284 ata_scsi_park_show, ata_scsi_park_store);
285 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
287 static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
289 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
291 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
295 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
296 const char *buf, size_t count)
298 struct Scsi_Host *shost = class_to_shost(dev);
299 struct ata_port *ap = ata_shost_to_port(shost);
300 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
301 return ap->ops->em_store(ap, buf, count);
306 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
309 struct Scsi_Host *shost = class_to_shost(dev);
310 struct ata_port *ap = ata_shost_to_port(shost);
312 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
313 return ap->ops->em_show(ap, buf);
316 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
317 ata_scsi_em_message_show, ata_scsi_em_message_store);
318 EXPORT_SYMBOL_GPL(dev_attr_em_message);
321 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
324 struct Scsi_Host *shost = class_to_shost(dev);
325 struct ata_port *ap = ata_shost_to_port(shost);
327 return snprintf(buf, 23, "%d\n", ap->em_message_type);
329 DEVICE_ATTR(em_message_type, S_IRUGO,
330 ata_scsi_em_message_type_show, NULL);
331 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
334 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
337 struct scsi_device *sdev = to_scsi_device(dev);
338 struct ata_port *ap = ata_shost_to_port(sdev->host);
339 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
341 if (ap->ops->sw_activity_show && (ap->flags & ATA_FLAG_SW_ACTIVITY))
342 return ap->ops->sw_activity_show(atadev, buf);
347 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
348 const char *buf, size_t count)
350 struct scsi_device *sdev = to_scsi_device(dev);
351 struct ata_port *ap = ata_shost_to_port(sdev->host);
352 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
353 enum sw_activity val;
356 if (ap->ops->sw_activity_store && (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
357 val = simple_strtoul(buf, NULL, 0);
359 case OFF: case BLINK_ON: case BLINK_OFF:
360 rc = ap->ops->sw_activity_store(atadev, val);
369 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
370 ata_scsi_activity_store);
371 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
373 struct device_attribute *ata_common_sdev_attrs[] = {
374 &dev_attr_unload_heads,
377 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
379 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
380 void (*done)(struct scsi_cmnd *))
382 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
383 /* "Invalid field in cbd" */
388 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
389 * @sdev: SCSI device for which BIOS geometry is to be determined
390 * @bdev: block device associated with @sdev
391 * @capacity: capacity of SCSI device
392 * @geom: location to which geometry will be output
394 * Generic bios head/sector/cylinder calculator
395 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
396 * mapping. Some situations may arise where the disk is not
397 * bootable if this is not used.
400 * Defined by the SCSI layer. We don't really care.
405 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
406 sector_t capacity, int geom[])
410 sector_div(capacity, 255*63);
417 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
419 * @sdev: SCSI device to get identify data for
420 * @arg: User buffer area for identify data
423 * Defined by the SCSI layer. We don't really care.
426 * Zero on success, negative errno on error.
428 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
431 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
432 u16 __user *dst = arg;
438 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
441 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
442 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
445 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
446 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
449 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
450 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
457 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
458 * @scsidev: Device to which we are issuing command
459 * @arg: User provided data for issuing command
462 * Defined by the SCSI layer. We don't really care.
465 * Zero on success, negative errno on error.
467 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
470 u8 scsi_cmd[MAX_COMMAND_SIZE];
471 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
473 enum dma_data_direction data_dir;
479 if (copy_from_user(args, arg, sizeof(args)))
482 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
486 memset(scsi_cmd, 0, sizeof(scsi_cmd));
489 argsize = SECTOR_SIZE * args[3];
490 argbuf = kmalloc(argsize, GFP_KERNEL);
491 if (argbuf == NULL) {
496 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
497 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
498 block count in sector count field */
499 data_dir = DMA_FROM_DEVICE;
501 scsi_cmd[1] = (3 << 1); /* Non-data */
502 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
506 scsi_cmd[0] = ATA_16;
508 scsi_cmd[4] = args[2];
509 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
510 scsi_cmd[6] = args[3];
511 scsi_cmd[8] = args[1];
515 scsi_cmd[6] = args[1];
517 scsi_cmd[14] = args[0];
519 /* Good values for timeout and retries? Values below
520 from scsi_ioctl_send_command() for default case... */
521 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
522 sensebuf, (10*HZ), 5, 0, NULL);
524 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
525 u8 *desc = sensebuf + 8;
526 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
528 /* If we set cc then ATA pass-through will cause a
529 * check condition even if no error. Filter that. */
530 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
531 struct scsi_sense_hdr sshdr;
532 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
534 if (sshdr.sense_key == 0 &&
535 sshdr.asc == 0 && sshdr.ascq == 0)
536 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
539 /* Send userspace a few ATA registers (same as drivers/ide) */
540 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
541 desc[0] == 0x09) { /* code is "ATA Descriptor" */
542 args[0] = desc[13]; /* status */
543 args[1] = desc[3]; /* error */
544 args[2] = desc[5]; /* sector count (0:7) */
545 if (copy_to_user(arg, args, sizeof(args)))
557 && copy_to_user(arg + sizeof(args), argbuf, argsize))
566 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
567 * @scsidev: Device to which we are issuing command
568 * @arg: User provided data for issuing command
571 * Defined by the SCSI layer. We don't really care.
574 * Zero on success, negative errno on error.
576 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
579 u8 scsi_cmd[MAX_COMMAND_SIZE];
580 u8 args[7], *sensebuf = NULL;
586 if (copy_from_user(args, arg, sizeof(args)))
589 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
593 memset(scsi_cmd, 0, sizeof(scsi_cmd));
594 scsi_cmd[0] = ATA_16;
595 scsi_cmd[1] = (3 << 1); /* Non-data */
596 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
597 scsi_cmd[4] = args[1];
598 scsi_cmd[6] = args[2];
599 scsi_cmd[8] = args[3];
600 scsi_cmd[10] = args[4];
601 scsi_cmd[12] = args[5];
602 scsi_cmd[13] = args[6] & 0x4f;
603 scsi_cmd[14] = args[0];
605 /* Good values for timeout and retries? Values below
606 from scsi_ioctl_send_command() for default case... */
607 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
608 sensebuf, (10*HZ), 5, 0, NULL);
610 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
611 u8 *desc = sensebuf + 8;
612 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
614 /* If we set cc then ATA pass-through will cause a
615 * check condition even if no error. Filter that. */
616 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
617 struct scsi_sense_hdr sshdr;
618 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
620 if (sshdr.sense_key == 0 &&
621 sshdr.asc == 0 && sshdr.ascq == 0)
622 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
625 /* Send userspace ATA registers */
626 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
627 desc[0] == 0x09) {/* code is "ATA Descriptor" */
628 args[0] = desc[13]; /* status */
629 args[1] = desc[3]; /* error */
630 args[2] = desc[5]; /* sector count (0:7) */
631 args[3] = desc[7]; /* lbal */
632 args[4] = desc[9]; /* lbam */
633 args[5] = desc[11]; /* lbah */
634 args[6] = desc[12]; /* select */
635 if (copy_to_user(arg, args, sizeof(args)))
650 static int ata_ioc32(struct ata_port *ap)
652 if (ap->flags & ATA_FLAG_PIO_DMA)
654 if (ap->pflags & ATA_PFLAG_PIO32)
659 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
660 int cmd, void __user *arg)
662 int val = -EINVAL, rc = -EINVAL;
666 case ATA_IOC_GET_IO32:
667 spin_lock_irqsave(ap->lock, flags);
669 spin_unlock_irqrestore(ap->lock, flags);
670 if (copy_to_user(arg, &val, 1))
674 case ATA_IOC_SET_IO32:
675 val = (unsigned long) arg;
677 spin_lock_irqsave(ap->lock, flags);
678 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
680 ap->pflags |= ATA_PFLAG_PIO32;
682 ap->pflags &= ~ATA_PFLAG_PIO32;
684 if (val != ata_ioc32(ap))
687 spin_unlock_irqrestore(ap->lock, flags);
690 case HDIO_GET_IDENTITY:
691 return ata_get_identity(ap, scsidev, arg);
694 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
696 return ata_cmd_ioctl(scsidev, arg);
698 case HDIO_DRIVE_TASK:
699 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
701 return ata_task_ioctl(scsidev, arg);
710 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
712 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
714 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
717 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
720 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
721 * @dev: ATA device to which the new command is attached
722 * @cmd: SCSI command that originated this ATA command
723 * @done: SCSI command completion function
725 * Obtain a reference to an unused ata_queued_cmd structure,
726 * which is the basic libata structure representing a single
727 * ATA command sent to the hardware.
729 * If a command was available, fill in the SCSI-specific
730 * portions of the structure with information on the
734 * spin_lock_irqsave(host lock)
737 * Command allocated, or %NULL if none available.
739 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
740 struct scsi_cmnd *cmd,
741 void (*done)(struct scsi_cmnd *))
743 struct ata_queued_cmd *qc;
745 qc = ata_qc_new_init(dev);
750 qc->sg = scsi_sglist(cmd);
751 qc->n_elem = scsi_sg_count(cmd);
753 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
760 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
762 struct scsi_cmnd *scmd = qc->scsicmd;
764 qc->extrabytes = scmd->request->extra_len;
765 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
769 * ata_dump_status - user friendly display of error info
770 * @id: id of the port in question
771 * @tf: ptr to filled out taskfile
773 * Decode and dump the ATA error/status registers for the user so
774 * that they have some idea what really happened at the non
775 * make-believe layer.
778 * inherited from caller
780 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
782 u8 stat = tf->command, err = tf->feature;
784 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
785 if (stat & ATA_BUSY) {
786 printk("Busy }\n"); /* Data is not valid in this case */
788 if (stat & 0x40) printk("DriveReady ");
789 if (stat & 0x20) printk("DeviceFault ");
790 if (stat & 0x10) printk("SeekComplete ");
791 if (stat & 0x08) printk("DataRequest ");
792 if (stat & 0x04) printk("CorrectedError ");
793 if (stat & 0x02) printk("Index ");
794 if (stat & 0x01) printk("Error ");
798 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
799 if (err & 0x04) printk("DriveStatusError ");
801 if (err & 0x04) printk("BadCRC ");
802 else printk("Sector ");
804 if (err & 0x40) printk("UncorrectableError ");
805 if (err & 0x10) printk("SectorIdNotFound ");
806 if (err & 0x02) printk("TrackZeroNotFound ");
807 if (err & 0x01) printk("AddrMarkNotFound ");
814 * ata_to_sense_error - convert ATA error to SCSI error
815 * @id: ATA device number
816 * @drv_stat: value contained in ATA status register
817 * @drv_err: value contained in ATA error register
818 * @sk: the sense key we'll fill out
819 * @asc: the additional sense code we'll fill out
820 * @ascq: the additional sense code qualifier we'll fill out
821 * @verbose: be verbose
823 * Converts an ATA error into a SCSI error. Fill out pointers to
824 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
825 * format sense blocks.
828 * spin_lock_irqsave(host lock)
830 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
831 u8 *asc, u8 *ascq, int verbose)
835 /* Based on the 3ware driver translation table */
836 static const unsigned char sense_table[][4] = {
838 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
840 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
842 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
843 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
844 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
845 /* MC|ID|ABRT|TRK0|MARK */
846 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
848 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
849 /* Bad address mark */
850 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
852 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
854 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
855 /* Media change request */
856 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
858 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
860 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
862 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
863 /* BBD - block marked bad */
864 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
865 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
867 static const unsigned char stat_table[][4] = {
868 /* Must be first because BUSY means no other bits valid */
869 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
870 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
871 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
872 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
873 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
877 * Is this an error we can process/parse
879 if (drv_stat & ATA_BUSY) {
880 drv_err = 0; /* Ignore the err bits, they're invalid */
884 /* Look for drv_err */
885 for (i = 0; sense_table[i][0] != 0xFF; i++) {
886 /* Look for best matches first */
887 if ((sense_table[i][0] & drv_err) ==
889 *sk = sense_table[i][1];
890 *asc = sense_table[i][2];
891 *ascq = sense_table[i][3];
895 /* No immediate match */
897 printk(KERN_WARNING "ata%u: no sense translation for "
898 "error 0x%02x\n", id, drv_err);
901 /* Fall back to interpreting status bits */
902 for (i = 0; stat_table[i][0] != 0xFF; i++) {
903 if (stat_table[i][0] & drv_stat) {
904 *sk = stat_table[i][1];
905 *asc = stat_table[i][2];
906 *ascq = stat_table[i][3];
910 /* No error? Undecoded? */
912 printk(KERN_WARNING "ata%u: no sense translation for "
913 "status: 0x%02x\n", id, drv_stat);
915 /* We need a sensible error return here, which is tricky, and one
916 that won't cause people to do things like return a disk wrongly */
917 *sk = ABORTED_COMMAND;
923 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
924 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
925 id, drv_stat, drv_err, *sk, *asc, *ascq);
930 * ata_gen_passthru_sense - Generate check condition sense block.
931 * @qc: Command that completed.
933 * This function is specific to the ATA descriptor format sense
934 * block specified for the ATA pass through commands. Regardless
935 * of whether the command errored or not, return a sense
936 * block. Copy all controller registers into the sense
937 * block. Clear sense key, ASC & ASCQ if there is no error.
942 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
944 struct scsi_cmnd *cmd = qc->scsicmd;
945 struct ata_taskfile *tf = &qc->result_tf;
946 unsigned char *sb = cmd->sense_buffer;
947 unsigned char *desc = sb + 8;
948 int verbose = qc->ap->ops->error_handler == NULL;
950 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
952 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
955 * Use ata_to_sense_error() to map status register bits
956 * onto sense key, asc & ascq.
959 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
960 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
961 &sb[1], &sb[2], &sb[3], verbose);
966 * Sense data is current and format is descriptor.
972 /* set length of additional sense data */
977 * Copy registers into sense buffer.
980 desc[3] = tf->feature; /* == error reg */
985 desc[12] = tf->device;
986 desc[13] = tf->command; /* == status reg */
989 * Fill in Extend bit, and the high order bytes
992 if (tf->flags & ATA_TFLAG_LBA48) {
994 desc[4] = tf->hob_nsect;
995 desc[6] = tf->hob_lbal;
996 desc[8] = tf->hob_lbam;
997 desc[10] = tf->hob_lbah;
1002 * ata_gen_ata_sense - generate a SCSI fixed sense block
1003 * @qc: Command that we are erroring out
1005 * Generate sense block for a failed ATA command @qc. Descriptor
1006 * format is used to accomodate LBA48 block address.
1011 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1013 struct ata_device *dev = qc->dev;
1014 struct scsi_cmnd *cmd = qc->scsicmd;
1015 struct ata_taskfile *tf = &qc->result_tf;
1016 unsigned char *sb = cmd->sense_buffer;
1017 unsigned char *desc = sb + 8;
1018 int verbose = qc->ap->ops->error_handler == NULL;
1021 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1023 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1025 /* sense data is current and format is descriptor */
1028 /* Use ata_to_sense_error() to map status register bits
1029 * onto sense key, asc & ascq.
1032 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1033 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1034 &sb[1], &sb[2], &sb[3], verbose);
1038 block = ata_tf_read_block(&qc->result_tf, dev);
1040 /* information sense data descriptor */
1045 desc[2] |= 0x80; /* valid */
1046 desc[6] = block >> 40;
1047 desc[7] = block >> 32;
1048 desc[8] = block >> 24;
1049 desc[9] = block >> 16;
1050 desc[10] = block >> 8;
1054 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1056 sdev->use_10_for_rw = 1;
1057 sdev->use_10_for_ms = 1;
1059 /* Schedule policy is determined by ->qc_defer() callback and
1060 * it needs to see every deferred qc. Set dev_blocked to 1 to
1061 * prevent SCSI midlayer from automatically deferring
1064 sdev->max_device_blocked = 1;
1068 * atapi_drain_needed - Check whether data transfer may overflow
1069 * @rq: request to be checked
1071 * ATAPI commands which transfer variable length data to host
1072 * might overflow due to application error or hardare bug. This
1073 * function checks whether overflow should be drained and ignored
1080 * 1 if ; otherwise, 0.
1082 static int atapi_drain_needed(struct request *rq)
1084 if (likely(!blk_pc_request(rq)))
1087 if (!blk_rq_bytes(rq) || (rq->cmd_flags & REQ_RW))
1090 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1093 static int ata_scsi_dev_config(struct scsi_device *sdev,
1094 struct ata_device *dev)
1096 if (!ata_id_has_unload(dev->id))
1097 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1099 /* configure max sectors */
1100 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
1102 if (dev->class == ATA_DEV_ATAPI) {
1103 struct request_queue *q = sdev->request_queue;
1106 /* set the min alignment and padding */
1107 blk_queue_update_dma_alignment(sdev->request_queue,
1108 ATA_DMA_PAD_SZ - 1);
1109 blk_queue_update_dma_pad(sdev->request_queue,
1110 ATA_DMA_PAD_SZ - 1);
1112 /* configure draining */
1113 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1115 ata_dev_printk(dev, KERN_ERR,
1116 "drain buffer allocation failed\n");
1120 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1122 /* ATA devices must be sector aligned */
1123 blk_queue_update_dma_alignment(sdev->request_queue,
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);
1143 * ata_scsi_slave_config - Set SCSI device attributes
1144 * @sdev: SCSI device to examine
1146 * This is called before we actually start reading
1147 * and writing to the device, to configure certain
1148 * SCSI mid-layer behaviors.
1151 * Defined by SCSI layer. We don't really care.
1154 int ata_scsi_slave_config(struct scsi_device *sdev)
1156 struct ata_port *ap = ata_shost_to_port(sdev->host);
1157 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1160 ata_scsi_sdev_config(sdev);
1163 rc = ata_scsi_dev_config(sdev, dev);
1169 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1170 * @sdev: SCSI device to be destroyed
1172 * @sdev is about to be destroyed for hot/warm unplugging. If
1173 * this unplugging was initiated by libata as indicated by NULL
1174 * dev->sdev, this function doesn't have to do anything.
1175 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1176 * Clear dev->sdev, schedule the device for ATA detach and invoke
1180 * Defined by SCSI layer. We don't really care.
1182 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1184 struct ata_port *ap = ata_shost_to_port(sdev->host);
1185 struct request_queue *q = sdev->request_queue;
1186 unsigned long flags;
1187 struct ata_device *dev;
1189 if (!ap->ops->error_handler)
1192 spin_lock_irqsave(ap->lock, flags);
1193 dev = __ata_scsi_find_dev(ap, sdev);
1194 if (dev && dev->sdev) {
1195 /* SCSI device already in CANCEL state, no need to offline it */
1197 dev->flags |= ATA_DFLAG_DETACH;
1198 ata_port_schedule_eh(ap);
1200 spin_unlock_irqrestore(ap->lock, flags);
1202 kfree(q->dma_drain_buffer);
1203 q->dma_drain_buffer = NULL;
1204 q->dma_drain_size = 0;
1208 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1209 * @sdev: SCSI device to configure queue depth for
1210 * @queue_depth: new queue depth
1212 * This is libata standard hostt->change_queue_depth callback.
1213 * SCSI will call into this callback when user tries to set queue
1217 * SCSI layer (we don't care)
1220 * Newly configured queue depth.
1222 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1224 struct ata_port *ap = ata_shost_to_port(sdev->host);
1225 struct ata_device *dev;
1226 unsigned long flags;
1228 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1229 return sdev->queue_depth;
1231 dev = ata_scsi_find_dev(ap, sdev);
1232 if (!dev || !ata_dev_enabled(dev))
1233 return sdev->queue_depth;
1236 spin_lock_irqsave(ap->lock, flags);
1237 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1238 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1239 dev->flags |= ATA_DFLAG_NCQ_OFF;
1242 spin_unlock_irqrestore(ap->lock, flags);
1244 /* limit and apply queue depth */
1245 queue_depth = min(queue_depth, sdev->host->can_queue);
1246 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1247 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1249 if (sdev->queue_depth == queue_depth)
1252 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1257 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1258 * @qc: Storage for translated ATA taskfile
1260 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1261 * (to start). Perhaps these commands should be preceded by
1262 * CHECK POWER MODE to see what power mode the device is already in.
1263 * [See SAT revision 5 at www.t10.org]
1266 * spin_lock_irqsave(host lock)
1269 * Zero on success, non-zero on error.
1271 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1273 struct scsi_cmnd *scmd = qc->scsicmd;
1274 struct ata_taskfile *tf = &qc->tf;
1275 const u8 *cdb = scmd->cmnd;
1277 if (scmd->cmd_len < 5)
1280 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1281 tf->protocol = ATA_PROT_NODATA;
1283 ; /* ignore IMMED bit, violates sat-r05 */
1286 goto invalid_fld; /* LOEJ bit set not supported */
1287 if (((cdb[4] >> 4) & 0xf) != 0)
1288 goto invalid_fld; /* power conditions not supported */
1291 tf->nsect = 1; /* 1 sector, lba=0 */
1293 if (qc->dev->flags & ATA_DFLAG_LBA) {
1294 tf->flags |= ATA_TFLAG_LBA;
1299 tf->device |= ATA_LBA;
1302 tf->lbal = 0x1; /* sect */
1303 tf->lbam = 0x0; /* cyl low */
1304 tf->lbah = 0x0; /* cyl high */
1307 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1309 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1310 * or S5) causing some drives to spin up and down again.
1312 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1313 system_state == SYSTEM_POWER_OFF)
1316 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1317 system_entering_hibernation())
1320 /* Issue ATA STANDBY IMMEDIATE command */
1321 tf->command = ATA_CMD_STANDBYNOW1;
1325 * Standby and Idle condition timers could be implemented but that
1326 * would require libata to implement the Power condition mode page
1327 * and allow the user to change it. Changing mode pages requires
1328 * MODE SELECT to be implemented.
1334 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1335 /* "Invalid field in cbd" */
1338 scmd->result = SAM_STAT_GOOD;
1344 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1345 * @qc: Storage for translated ATA taskfile
1347 * Sets up an ATA taskfile to issue FLUSH CACHE or
1351 * spin_lock_irqsave(host lock)
1354 * Zero on success, non-zero on error.
1356 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1358 struct ata_taskfile *tf = &qc->tf;
1360 tf->flags |= ATA_TFLAG_DEVICE;
1361 tf->protocol = ATA_PROT_NODATA;
1363 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1364 tf->command = ATA_CMD_FLUSH_EXT;
1366 tf->command = ATA_CMD_FLUSH;
1368 /* flush is critical for IO integrity, consider it an IO command */
1369 qc->flags |= ATA_QCFLAG_IO;
1375 * scsi_6_lba_len - Get LBA and transfer length
1376 * @cdb: SCSI command to translate
1378 * Calculate LBA and transfer length for 6-byte commands.
1382 * @plen: the transfer length
1384 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1389 VPRINTK("six-byte command\n");
1391 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1392 lba |= ((u64)cdb[2]) << 8;
1393 lba |= ((u64)cdb[3]);
1402 * scsi_10_lba_len - Get LBA and transfer length
1403 * @cdb: SCSI command to translate
1405 * Calculate LBA and transfer length for 10-byte commands.
1409 * @plen: the transfer length
1411 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1416 VPRINTK("ten-byte command\n");
1418 lba |= ((u64)cdb[2]) << 24;
1419 lba |= ((u64)cdb[3]) << 16;
1420 lba |= ((u64)cdb[4]) << 8;
1421 lba |= ((u64)cdb[5]);
1423 len |= ((u32)cdb[7]) << 8;
1424 len |= ((u32)cdb[8]);
1431 * scsi_16_lba_len - Get LBA and transfer length
1432 * @cdb: SCSI command to translate
1434 * Calculate LBA and transfer length for 16-byte commands.
1438 * @plen: the transfer length
1440 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1445 VPRINTK("sixteen-byte command\n");
1447 lba |= ((u64)cdb[2]) << 56;
1448 lba |= ((u64)cdb[3]) << 48;
1449 lba |= ((u64)cdb[4]) << 40;
1450 lba |= ((u64)cdb[5]) << 32;
1451 lba |= ((u64)cdb[6]) << 24;
1452 lba |= ((u64)cdb[7]) << 16;
1453 lba |= ((u64)cdb[8]) << 8;
1454 lba |= ((u64)cdb[9]);
1456 len |= ((u32)cdb[10]) << 24;
1457 len |= ((u32)cdb[11]) << 16;
1458 len |= ((u32)cdb[12]) << 8;
1459 len |= ((u32)cdb[13]);
1466 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1467 * @qc: Storage for translated ATA taskfile
1469 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1472 * spin_lock_irqsave(host lock)
1475 * Zero on success, non-zero on error.
1477 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1479 struct scsi_cmnd *scmd = qc->scsicmd;
1480 struct ata_taskfile *tf = &qc->tf;
1481 struct ata_device *dev = qc->dev;
1482 u64 dev_sectors = qc->dev->n_sectors;
1483 const u8 *cdb = scmd->cmnd;
1487 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1488 tf->protocol = ATA_PROT_NODATA;
1490 if (cdb[0] == VERIFY) {
1491 if (scmd->cmd_len < 10)
1493 scsi_10_lba_len(cdb, &block, &n_block);
1494 } else if (cdb[0] == VERIFY_16) {
1495 if (scmd->cmd_len < 16)
1497 scsi_16_lba_len(cdb, &block, &n_block);
1503 if (block >= dev_sectors)
1505 if ((block + n_block) > dev_sectors)
1508 if (dev->flags & ATA_DFLAG_LBA) {
1509 tf->flags |= ATA_TFLAG_LBA;
1511 if (lba_28_ok(block, n_block)) {
1513 tf->command = ATA_CMD_VERIFY;
1514 tf->device |= (block >> 24) & 0xf;
1515 } else if (lba_48_ok(block, n_block)) {
1516 if (!(dev->flags & ATA_DFLAG_LBA48))
1520 tf->flags |= ATA_TFLAG_LBA48;
1521 tf->command = ATA_CMD_VERIFY_EXT;
1523 tf->hob_nsect = (n_block >> 8) & 0xff;
1525 tf->hob_lbah = (block >> 40) & 0xff;
1526 tf->hob_lbam = (block >> 32) & 0xff;
1527 tf->hob_lbal = (block >> 24) & 0xff;
1529 /* request too large even for LBA48 */
1532 tf->nsect = n_block & 0xff;
1534 tf->lbah = (block >> 16) & 0xff;
1535 tf->lbam = (block >> 8) & 0xff;
1536 tf->lbal = block & 0xff;
1538 tf->device |= ATA_LBA;
1541 u32 sect, head, cyl, track;
1543 if (!lba_28_ok(block, n_block))
1546 /* Convert LBA to CHS */
1547 track = (u32)block / dev->sectors;
1548 cyl = track / dev->heads;
1549 head = track % dev->heads;
1550 sect = (u32)block % dev->sectors + 1;
1552 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1553 (u32)block, track, cyl, head, sect);
1555 /* Check whether the converted CHS can fit.
1559 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1562 tf->command = ATA_CMD_VERIFY;
1563 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1566 tf->lbah = cyl >> 8;
1573 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1574 /* "Invalid field in cbd" */
1578 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1579 /* "Logical Block Address out of range" */
1583 scmd->result = SAM_STAT_GOOD;
1588 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1589 * @qc: Storage for translated ATA taskfile
1591 * Converts any of six SCSI read/write commands into the
1592 * ATA counterpart, including starting sector (LBA),
1593 * sector count, and taking into account the device's LBA48
1596 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1597 * %WRITE_16 are currently supported.
1600 * spin_lock_irqsave(host lock)
1603 * Zero on success, non-zero on error.
1605 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1607 struct scsi_cmnd *scmd = qc->scsicmd;
1608 const u8 *cdb = scmd->cmnd;
1609 unsigned int tf_flags = 0;
1614 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1615 tf_flags |= ATA_TFLAG_WRITE;
1617 /* Calculate the SCSI LBA, transfer length and FUA. */
1621 if (unlikely(scmd->cmd_len < 10))
1623 scsi_10_lba_len(cdb, &block, &n_block);
1624 if (unlikely(cdb[1] & (1 << 3)))
1625 tf_flags |= ATA_TFLAG_FUA;
1629 if (unlikely(scmd->cmd_len < 6))
1631 scsi_6_lba_len(cdb, &block, &n_block);
1633 /* for 6-byte r/w commands, transfer length 0
1634 * means 256 blocks of data, not 0 block.
1641 if (unlikely(scmd->cmd_len < 16))
1643 scsi_16_lba_len(cdb, &block, &n_block);
1644 if (unlikely(cdb[1] & (1 << 3)))
1645 tf_flags |= ATA_TFLAG_FUA;
1648 DPRINTK("no-byte command\n");
1652 /* Check and compose ATA command */
1654 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1655 * length 0 means transfer 0 block of data.
1656 * However, for ATA R/W commands, sector count 0 means
1657 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1659 * WARNING: one or two older ATA drives treat 0 as 0...
1663 qc->flags |= ATA_QCFLAG_IO;
1664 qc->nbytes = n_block * ATA_SECT_SIZE;
1666 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1668 if (likely(rc == 0))
1673 /* treat all other errors as -EINVAL, fall through */
1675 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1676 /* "Invalid field in cbd" */
1680 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1681 /* "Logical Block Address out of range" */
1685 scmd->result = SAM_STAT_GOOD;
1689 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1691 struct ata_port *ap = qc->ap;
1692 struct scsi_cmnd *cmd = qc->scsicmd;
1693 u8 *cdb = cmd->cmnd;
1694 int need_sense = (qc->err_mask != 0);
1696 /* For ATA pass thru (SAT) commands, generate a sense block if
1697 * user mandated it or if there's an error. Note that if we
1698 * generate because the user forced us to, a check condition
1699 * is generated and the ATA register values are returned
1700 * whether the command completed successfully or not. If there
1701 * was no error, SK, ASC and ASCQ will all be zero.
1703 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1704 ((cdb[2] & 0x20) || need_sense)) {
1705 ata_gen_passthru_sense(qc);
1708 cmd->result = SAM_STAT_GOOD;
1710 /* TODO: decide which descriptor format to use
1711 * for 48b LBA devices and call that here
1712 * instead of the fixed desc, which is only
1713 * good for smaller LBA (and maybe CHS?)
1716 ata_gen_ata_sense(qc);
1720 if (need_sense && !ap->ops->error_handler)
1721 ata_dump_status(ap->print_id, &qc->result_tf);
1729 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1730 * @dev: ATA device to which the command is addressed
1731 * @cmd: SCSI command to execute
1732 * @done: SCSI command completion function
1733 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1735 * Our ->queuecommand() function has decided that the SCSI
1736 * command issued can be directly translated into an ATA
1737 * command, rather than handled internally.
1739 * This function sets up an ata_queued_cmd structure for the
1740 * SCSI command, and sends that ata_queued_cmd to the hardware.
1742 * The xlat_func argument (actor) returns 0 if ready to execute
1743 * ATA command, else 1 to finish translation. If 1 is returned
1744 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1745 * to be set reflecting an error condition or clean (early)
1749 * spin_lock_irqsave(host lock)
1752 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1753 * needs to be deferred.
1755 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1756 void (*done)(struct scsi_cmnd *),
1757 ata_xlat_func_t xlat_func)
1759 struct ata_port *ap = dev->link->ap;
1760 struct ata_queued_cmd *qc;
1765 qc = ata_scsi_qc_new(dev, cmd, done);
1769 /* data is present; dma-map it */
1770 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1771 cmd->sc_data_direction == DMA_TO_DEVICE) {
1772 if (unlikely(scsi_bufflen(cmd) < 1)) {
1773 ata_dev_printk(dev, KERN_WARNING,
1774 "WARNING: zero len r/w req\n");
1778 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1780 qc->dma_dir = cmd->sc_data_direction;
1783 qc->complete_fn = ata_scsi_qc_complete;
1788 if (ap->ops->qc_defer) {
1789 if ((rc = ap->ops->qc_defer(qc)))
1793 /* select device, send command to hardware */
1802 DPRINTK("EXIT - early finish (good or error)\n");
1807 cmd->result = (DID_ERROR << 16);
1810 DPRINTK("EXIT - internal\n");
1815 DPRINTK("EXIT - defer\n");
1816 if (rc == ATA_DEFER_LINK)
1817 return SCSI_MLQUEUE_DEVICE_BUSY;
1819 return SCSI_MLQUEUE_HOST_BUSY;
1823 * ata_scsi_rbuf_get - Map response buffer.
1824 * @cmd: SCSI command containing buffer to be mapped.
1825 * @flags: unsigned long variable to store irq enable status
1826 * @copy_in: copy in from user buffer
1828 * Prepare buffer for simulated SCSI commands.
1831 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1834 * Pointer to response buffer.
1836 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1837 unsigned long *flags)
1839 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1841 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1843 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1844 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1845 return ata_scsi_rbuf;
1849 * ata_scsi_rbuf_put - Unmap response buffer.
1850 * @cmd: SCSI command containing buffer to be unmapped.
1851 * @copy_out: copy out result
1852 * @flags: @flags passed to ata_scsi_rbuf_get()
1854 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1855 * @copy_back is true.
1858 * Unlocks ata_scsi_rbuf_lock.
1860 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1861 unsigned long *flags)
1864 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1865 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1866 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1870 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1871 * @args: device IDENTIFY data / SCSI command of interest.
1872 * @actor: Callback hook for desired SCSI command simulator
1874 * Takes care of the hard work of simulating a SCSI command...
1875 * Mapping the response buffer, calling the command's handler,
1876 * and handling the handler's return value. This return value
1877 * indicates whether the handler wishes the SCSI command to be
1878 * completed successfully (0), or not (in which case cmd->result
1879 * and sense buffer are assumed to be set).
1882 * spin_lock_irqsave(host lock)
1884 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1885 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1889 struct scsi_cmnd *cmd = args->cmd;
1890 unsigned long flags;
1892 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1893 rc = actor(args, rbuf);
1894 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1897 cmd->result = SAM_STAT_GOOD;
1902 * ata_scsiop_inq_std - Simulate INQUIRY command
1903 * @args: device IDENTIFY data / SCSI command of interest.
1904 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1906 * Returns standard device identification data associated
1907 * with non-VPD INQUIRY command output.
1910 * spin_lock_irqsave(host lock)
1912 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1914 const u8 versions[] = {
1915 0x60, /* SAM-3 (no version claimed) */
1918 0x20, /* SBC-2 (no version claimed) */
1921 0x60 /* SPC-3 (no version claimed) */
1926 0x5, /* claim SPC-3 version compatibility */
1933 /* set scsi removeable (RMB) bit per ata bit */
1934 if (ata_id_removeable(args->id))
1937 memcpy(rbuf, hdr, sizeof(hdr));
1938 memcpy(&rbuf[8], "ATA ", 8);
1939 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1940 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1942 if (rbuf[32] == 0 || rbuf[32] == ' ')
1943 memcpy(&rbuf[32], "n/a ", 4);
1945 memcpy(rbuf + 59, versions, sizeof(versions));
1951 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1952 * @args: device IDENTIFY data / SCSI command of interest.
1953 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1955 * Returns list of inquiry VPD pages available.
1958 * spin_lock_irqsave(host lock)
1960 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1962 const u8 pages[] = {
1963 0x00, /* page 0x00, this page */
1964 0x80, /* page 0x80, unit serial no page */
1965 0x83, /* page 0x83, device ident page */
1966 0x89, /* page 0x89, ata info page */
1967 0xb0, /* page 0xb0, block limits page */
1968 0xb1, /* page 0xb1, block device characteristics page */
1971 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1972 memcpy(rbuf + 4, pages, sizeof(pages));
1977 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1978 * @args: device IDENTIFY data / SCSI command of interest.
1979 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1981 * Returns ATA device serial number.
1984 * spin_lock_irqsave(host lock)
1986 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1990 0x80, /* this page code */
1992 ATA_ID_SERNO_LEN, /* page len */
1995 memcpy(rbuf, hdr, sizeof(hdr));
1996 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1997 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2002 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2003 * @args: device IDENTIFY data / SCSI command of interest.
2004 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2006 * Yields two logical unit device identification designators:
2007 * - vendor specific ASCII containing the ATA serial number
2008 * - SAT defined "t10 vendor id based" containing ASCII vendor
2009 * name ("ATA "), model and serial numbers.
2012 * spin_lock_irqsave(host lock)
2014 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2016 const int sat_model_serial_desc_len = 68;
2019 rbuf[1] = 0x83; /* this page code */
2022 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2024 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2026 ata_id_string(args->id, (unsigned char *) rbuf + num,
2027 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2028 num += ATA_ID_SERNO_LEN;
2030 /* SAT defined lu model and serial numbers descriptor */
2031 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2034 rbuf[num + 3] = sat_model_serial_desc_len;
2036 memcpy(rbuf + num, "ATA ", 8);
2038 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2040 num += ATA_ID_PROD_LEN;
2041 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2043 num += ATA_ID_SERNO_LEN;
2045 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2050 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2051 * @args: device IDENTIFY data / SCSI command of interest.
2052 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2054 * Yields SAT-specified ATA VPD page.
2057 * spin_lock_irqsave(host lock)
2059 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2061 struct ata_taskfile tf;
2063 memset(&tf, 0, sizeof(tf));
2065 rbuf[1] = 0x89; /* our page code */
2066 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2067 rbuf[3] = (0x238 & 0xff);
2069 memcpy(&rbuf[8], "linux ", 8);
2070 memcpy(&rbuf[16], "libata ", 16);
2071 memcpy(&rbuf[32], DRV_VERSION, 4);
2072 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2074 /* we don't store the ATA device signature, so we fake it */
2076 tf.command = ATA_DRDY; /* really, this is Status reg */
2080 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2081 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2083 rbuf[56] = ATA_CMD_ID_ATA;
2085 memcpy(&rbuf[60], &args->id[0], 512);
2089 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2094 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2097 * Optimal transfer length granularity.
2099 * This is always one physical block, but for disks with a smaller
2100 * logical than physical sector size we need to figure out what the
2103 if (ata_id_has_large_logical_sectors(args->id))
2104 min_io_sectors = ata_id_logical_per_physical_sectors(args->id);
2107 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2110 * Optimal unmap granularity.
2112 * The ATA spec doesn't even know about a granularity or alignment
2113 * for the TRIM command. We can leave away most of the unmap related
2114 * VPD page entries, but we have specifify a granularity to signal
2115 * that we support some form of unmap - in thise case via WRITE SAME
2116 * with the unmap bit set.
2118 if (ata_id_has_trim(args->id)) {
2119 put_unaligned_be32(65535 * 512 / 8, &rbuf[20]);
2120 put_unaligned_be32(1, &rbuf[28]);
2126 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2128 int form_factor = ata_id_form_factor(args->id);
2129 int media_rotation_rate = ata_id_rotation_rate(args->id);
2133 rbuf[4] = media_rotation_rate >> 8;
2134 rbuf[5] = media_rotation_rate;
2135 rbuf[7] = form_factor;
2141 * ata_scsiop_noop - Command handler that simply returns success.
2142 * @args: device IDENTIFY data / SCSI command of interest.
2143 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2145 * No operation. Simply returns success to caller, to indicate
2146 * that the caller should successfully complete this SCSI command.
2149 * spin_lock_irqsave(host lock)
2151 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2158 * ata_msense_caching - Simulate MODE SENSE caching info page
2159 * @id: device IDENTIFY data
2160 * @buf: output buffer
2162 * Generate a caching info page, which conditionally indicates
2163 * write caching to the SCSI layer, depending on device
2169 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2171 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2172 if (ata_id_wcache_enabled(id))
2173 buf[2] |= (1 << 2); /* write cache enable */
2174 if (!ata_id_rahead_enabled(id))
2175 buf[12] |= (1 << 5); /* disable read ahead */
2176 return sizeof(def_cache_mpage);
2180 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2181 * @buf: output buffer
2183 * Generate a generic MODE SENSE control mode page.
2188 static unsigned int ata_msense_ctl_mode(u8 *buf)
2190 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2191 return sizeof(def_control_mpage);
2195 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2196 * @buf: output buffer
2198 * Generate a generic MODE SENSE r/w error recovery page.
2203 static unsigned int ata_msense_rw_recovery(u8 *buf)
2205 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2206 return sizeof(def_rw_recovery_mpage);
2210 * We can turn this into a real blacklist if it's needed, for now just
2211 * blacklist any Maxtor BANC1G10 revision firmware
2213 static int ata_dev_supports_fua(u16 *id)
2215 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2219 if (!ata_id_has_fua(id))
2222 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2223 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2225 if (strcmp(model, "Maxtor"))
2227 if (strcmp(fw, "BANC1G10"))
2230 return 0; /* blacklisted */
2234 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2235 * @args: device IDENTIFY data / SCSI command of interest.
2236 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2238 * Simulate MODE SENSE commands. Assume this is invoked for direct
2239 * access devices (e.g. disks) only. There should be no block
2240 * descriptor for other device types.
2243 * spin_lock_irqsave(host lock)
2245 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2247 struct ata_device *dev = args->dev;
2248 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2249 const u8 sat_blk_desc[] = {
2250 0, 0, 0, 0, /* number of blocks: sat unspecified */
2252 0, 0x2, 0x0 /* block length: 512 bytes */
2255 unsigned int ebd, page_control, six_byte;
2260 six_byte = (scsicmd[0] == MODE_SENSE);
2261 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2263 * LLBA bit in msense(10) ignored (compliant)
2266 page_control = scsicmd[2] >> 6;
2267 switch (page_control) {
2268 case 0: /* current */
2269 break; /* supported */
2271 goto saving_not_supp;
2272 case 1: /* changeable */
2273 case 2: /* defaults */
2279 p += 4 + (ebd ? 8 : 0);
2281 p += 8 + (ebd ? 8 : 0);
2283 pg = scsicmd[2] & 0x3f;
2286 * No mode subpages supported (yet) but asking for _all_
2287 * subpages may be valid
2289 if (spg && (spg != ALL_SUB_MPAGES))
2293 case RW_RECOVERY_MPAGE:
2294 p += ata_msense_rw_recovery(p);
2298 p += ata_msense_caching(args->id, p);
2302 p += ata_msense_ctl_mode(p);
2306 p += ata_msense_rw_recovery(p);
2307 p += ata_msense_caching(args->id, p);
2308 p += ata_msense_ctl_mode(p);
2311 default: /* invalid page code */
2316 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2317 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2321 rbuf[0] = p - rbuf - 1;
2324 rbuf[3] = sizeof(sat_blk_desc);
2325 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2328 unsigned int output_len = p - rbuf - 2;
2330 rbuf[0] = output_len >> 8;
2331 rbuf[1] = output_len;
2334 rbuf[7] = sizeof(sat_blk_desc);
2335 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2341 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2342 /* "Invalid field in cbd" */
2346 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2347 /* "Saving parameters not supported" */
2352 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2353 * @args: device IDENTIFY data / SCSI command of interest.
2354 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2356 * Simulate READ CAPACITY commands.
2361 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2363 struct ata_device *dev = args->dev;
2364 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2365 u8 log_per_phys = 0;
2366 u16 lowest_aligned = 0;
2367 u16 word_106 = dev->id[106];
2368 u16 word_209 = dev->id[209];
2370 if ((word_106 & 0xc000) == 0x4000) {
2371 /* Number and offset of logical sectors per physical sector */
2372 if (word_106 & (1 << 13))
2373 log_per_phys = word_106 & 0xf;
2374 if ((word_209 & 0xc000) == 0x4000) {
2375 u16 first = dev->id[209] & 0x3fff;
2377 lowest_aligned = (1 << log_per_phys) - first;
2383 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2384 if (last_lba >= 0xffffffffULL)
2385 last_lba = 0xffffffff;
2387 /* sector count, 32-bit */
2388 rbuf[0] = last_lba >> (8 * 3);
2389 rbuf[1] = last_lba >> (8 * 2);
2390 rbuf[2] = last_lba >> (8 * 1);
2394 rbuf[6] = ATA_SECT_SIZE >> 8;
2395 rbuf[7] = ATA_SECT_SIZE & 0xff;
2397 /* sector count, 64-bit */
2398 rbuf[0] = last_lba >> (8 * 7);
2399 rbuf[1] = last_lba >> (8 * 6);
2400 rbuf[2] = last_lba >> (8 * 5);
2401 rbuf[3] = last_lba >> (8 * 4);
2402 rbuf[4] = last_lba >> (8 * 3);
2403 rbuf[5] = last_lba >> (8 * 2);
2404 rbuf[6] = last_lba >> (8 * 1);
2408 rbuf[10] = ATA_SECT_SIZE >> 8;
2409 rbuf[11] = ATA_SECT_SIZE & 0xff;
2412 rbuf[13] = log_per_phys;
2413 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2414 rbuf[15] = lowest_aligned;
2416 if (ata_id_has_trim(args->id)) {
2417 rbuf[14] |= 0x80; /* TPE */
2419 if (ata_id_has_zero_after_trim(args->id))
2420 rbuf[14] |= 0x40; /* TPRZ */
2428 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2429 * @args: device IDENTIFY data / SCSI command of interest.
2430 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2432 * Simulate REPORT LUNS command.
2435 * spin_lock_irqsave(host lock)
2437 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2440 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2445 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2447 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2448 /* FIXME: not quite right; we don't want the
2449 * translation of taskfile registers into
2450 * a sense descriptors, since that's only
2451 * correct for ATA, not ATAPI
2453 ata_gen_passthru_sense(qc);
2456 qc->scsidone(qc->scsicmd);
2460 /* is it pointless to prefer PIO for "safety reasons"? */
2461 static inline int ata_pio_use_silly(struct ata_port *ap)
2463 return (ap->flags & ATA_FLAG_PIO_DMA);
2466 static void atapi_request_sense(struct ata_queued_cmd *qc)
2468 struct ata_port *ap = qc->ap;
2469 struct scsi_cmnd *cmd = qc->scsicmd;
2471 DPRINTK("ATAPI request sense\n");
2473 /* FIXME: is this needed? */
2474 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2476 #ifdef CONFIG_ATA_SFF
2477 if (ap->ops->sff_tf_read)
2478 ap->ops->sff_tf_read(ap, &qc->tf);
2481 /* fill these in, for the case where they are -not- overwritten */
2482 cmd->sense_buffer[0] = 0x70;
2483 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2487 /* setup sg table and init transfer direction */
2488 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2489 ata_sg_init(qc, &qc->sgent, 1);
2490 qc->dma_dir = DMA_FROM_DEVICE;
2492 memset(&qc->cdb, 0, qc->dev->cdb_len);
2493 qc->cdb[0] = REQUEST_SENSE;
2494 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2496 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2497 qc->tf.command = ATA_CMD_PACKET;
2499 if (ata_pio_use_silly(ap)) {
2500 qc->tf.protocol = ATAPI_PROT_DMA;
2501 qc->tf.feature |= ATAPI_PKT_DMA;
2503 qc->tf.protocol = ATAPI_PROT_PIO;
2504 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2507 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2509 qc->complete_fn = atapi_sense_complete;
2516 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2518 struct scsi_cmnd *cmd = qc->scsicmd;
2519 unsigned int err_mask = qc->err_mask;
2521 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2523 /* handle completion from new EH */
2524 if (unlikely(qc->ap->ops->error_handler &&
2525 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2527 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2528 /* FIXME: not quite right; we don't want the
2529 * translation of taskfile registers into a
2530 * sense descriptors, since that's only
2531 * correct for ATA, not ATAPI
2533 ata_gen_passthru_sense(qc);
2536 /* SCSI EH automatically locks door if sdev->locked is
2537 * set. Sometimes door lock request continues to
2538 * fail, for example, when no media is present. This
2539 * creates a loop - SCSI EH issues door lock which
2540 * fails and gets invoked again to acquire sense data
2541 * for the failed command.
2543 * If door lock fails, always clear sdev->locked to
2544 * avoid this infinite loop.
2546 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2547 qc->dev->sdev->locked = 0;
2549 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2555 /* successful completion or old EH failure path */
2556 if (unlikely(err_mask & AC_ERR_DEV)) {
2557 cmd->result = SAM_STAT_CHECK_CONDITION;
2558 atapi_request_sense(qc);
2560 } else if (unlikely(err_mask)) {
2561 /* FIXME: not quite right; we don't want the
2562 * translation of taskfile registers into
2563 * a sense descriptors, since that's only
2564 * correct for ATA, not ATAPI
2566 ata_gen_passthru_sense(qc);
2568 u8 *scsicmd = cmd->cmnd;
2570 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2571 unsigned long flags;
2574 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2576 /* ATAPI devices typically report zero for their SCSI version,
2577 * and sometimes deviate from the spec WRT response data
2578 * format. If SCSI version is reported as zero like normal,
2579 * then we make the following fixups: 1) Fake MMC-5 version,
2580 * to indicate to the Linux scsi midlayer this is a modern
2581 * device. 2) Ensure response data format / ATAPI information
2582 * are always correct.
2589 ata_scsi_rbuf_put(cmd, true, &flags);
2592 cmd->result = SAM_STAT_GOOD;
2599 * atapi_xlat - Initialize PACKET taskfile
2600 * @qc: command structure to be initialized
2603 * spin_lock_irqsave(host lock)
2606 * Zero on success, non-zero on failure.
2608 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2610 struct scsi_cmnd *scmd = qc->scsicmd;
2611 struct ata_device *dev = qc->dev;
2612 int nodata = (scmd->sc_data_direction == DMA_NONE);
2613 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2614 unsigned int nbytes;
2616 memset(qc->cdb, 0, dev->cdb_len);
2617 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2619 qc->complete_fn = atapi_qc_complete;
2621 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2622 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2623 qc->tf.flags |= ATA_TFLAG_WRITE;
2624 DPRINTK("direction: write\n");
2627 qc->tf.command = ATA_CMD_PACKET;
2628 ata_qc_set_pc_nbytes(qc);
2630 /* check whether ATAPI DMA is safe */
2631 if (!nodata && !using_pio && atapi_check_dma(qc))
2634 /* Some controller variants snoop this value for Packet
2635 * transfers to do state machine and FIFO management. Thus we
2636 * want to set it properly, and for DMA where it is
2637 * effectively meaningless.
2639 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2641 /* Most ATAPI devices which honor transfer chunk size don't
2642 * behave according to the spec when odd chunk size which
2643 * matches the transfer length is specified. If the number of
2644 * bytes to transfer is 2n+1. According to the spec, what
2645 * should happen is to indicate that 2n+1 is going to be
2646 * transferred and transfer 2n+2 bytes where the last byte is
2649 * In practice, this doesn't happen. ATAPI devices first
2650 * indicate and transfer 2n bytes and then indicate and
2651 * transfer 2 bytes where the last byte is padding.
2653 * This inconsistency confuses several controllers which
2654 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2655 * These controllers use actual number of transferred bytes to
2656 * update DMA poitner and transfer of 4n+2 bytes make those
2657 * controller push DMA pointer by 4n+4 bytes because SATA data
2658 * FISes are aligned to 4 bytes. This causes data corruption
2659 * and buffer overrun.
2661 * Always setting nbytes to even number solves this problem
2662 * because then ATAPI devices don't have to split data at 2n
2668 qc->tf.lbam = (nbytes & 0xFF);
2669 qc->tf.lbah = (nbytes >> 8);
2672 qc->tf.protocol = ATAPI_PROT_NODATA;
2674 qc->tf.protocol = ATAPI_PROT_PIO;
2677 qc->tf.protocol = ATAPI_PROT_DMA;
2678 qc->tf.feature |= ATAPI_PKT_DMA;
2680 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2681 (scmd->sc_data_direction != DMA_TO_DEVICE))
2682 /* some SATA bridges need us to indicate data xfer direction */
2683 qc->tf.feature |= ATAPI_DMADIR;
2687 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2688 as ATAPI tape drives don't get this right otherwise */
2692 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2694 if (!sata_pmp_attached(ap)) {
2695 if (likely(devno < ata_link_max_devices(&ap->link)))
2696 return &ap->link.device[devno];
2698 if (likely(devno < ap->nr_pmp_links))
2699 return &ap->pmp_link[devno].device[0];
2705 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2706 const struct scsi_device *scsidev)
2710 /* skip commands not addressed to targets we simulate */
2711 if (!sata_pmp_attached(ap)) {
2712 if (unlikely(scsidev->channel || scsidev->lun))
2714 devno = scsidev->id;
2716 if (unlikely(scsidev->id || scsidev->lun))
2718 devno = scsidev->channel;
2721 return ata_find_dev(ap, devno);
2725 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2726 * @ap: ATA port to which the device is attached
2727 * @scsidev: SCSI device from which we derive the ATA device
2729 * Given various information provided in struct scsi_cmnd,
2730 * map that onto an ATA bus, and using that mapping
2731 * determine which ata_device is associated with the
2732 * SCSI command to be sent.
2735 * spin_lock_irqsave(host lock)
2738 * Associated ATA device, or %NULL if not found.
2740 static struct ata_device *
2741 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2743 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2745 if (unlikely(!dev || !ata_dev_enabled(dev)))
2752 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2753 * @byte1: Byte 1 from pass-thru CDB.
2756 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2759 ata_scsi_map_proto(u8 byte1)
2761 switch((byte1 & 0x1e) >> 1) {
2762 case 3: /* Non-data */
2763 return ATA_PROT_NODATA;
2766 case 10: /* UDMA Data-in */
2767 case 11: /* UDMA Data-Out */
2768 return ATA_PROT_DMA;
2770 case 4: /* PIO Data-in */
2771 case 5: /* PIO Data-out */
2772 return ATA_PROT_PIO;
2774 case 0: /* Hard Reset */
2776 case 8: /* Device Diagnostic */
2777 case 9: /* Device Reset */
2778 case 7: /* DMA Queued */
2779 case 12: /* FPDMA */
2780 case 15: /* Return Response Info */
2781 default: /* Reserved */
2785 return ATA_PROT_UNKNOWN;
2789 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2790 * @qc: command structure to be initialized
2792 * Handles either 12 or 16-byte versions of the CDB.
2795 * Zero on success, non-zero on failure.
2797 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2799 struct ata_taskfile *tf = &(qc->tf);
2800 struct scsi_cmnd *scmd = qc->scsicmd;
2801 struct ata_device *dev = qc->dev;
2802 const u8 *cdb = scmd->cmnd;
2804 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2808 * 12 and 16 byte CDBs use different offsets to
2809 * provide the various register values.
2811 if (cdb[0] == ATA_16) {
2813 * 16-byte CDB - may contain extended commands.
2815 * If that is the case, copy the upper byte register values.
2817 if (cdb[1] & 0x01) {
2818 tf->hob_feature = cdb[3];
2819 tf->hob_nsect = cdb[5];
2820 tf->hob_lbal = cdb[7];
2821 tf->hob_lbam = cdb[9];
2822 tf->hob_lbah = cdb[11];
2823 tf->flags |= ATA_TFLAG_LBA48;
2825 tf->flags &= ~ATA_TFLAG_LBA48;
2828 * Always copy low byte, device and command registers.
2830 tf->feature = cdb[4];
2835 tf->device = cdb[13];
2836 tf->command = cdb[14];
2839 * 12-byte CDB - incapable of extended commands.
2841 tf->flags &= ~ATA_TFLAG_LBA48;
2843 tf->feature = cdb[3];
2848 tf->device = cdb[8];
2849 tf->command = cdb[9];
2852 /* enforce correct master/slave bit */
2853 tf->device = dev->devno ?
2854 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2856 /* READ/WRITE LONG use a non-standard sect_size */
2857 qc->sect_size = ATA_SECT_SIZE;
2858 switch (tf->command) {
2859 case ATA_CMD_READ_LONG:
2860 case ATA_CMD_READ_LONG_ONCE:
2861 case ATA_CMD_WRITE_LONG:
2862 case ATA_CMD_WRITE_LONG_ONCE:
2863 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2865 qc->sect_size = scsi_bufflen(scmd);
2869 * Set flags so that all registers will be written, pass on
2870 * write indication (used for PIO/DMA setup), result TF is
2871 * copied back and we don't whine too much about its failure.
2873 tf->flags = ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2874 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2875 tf->flags |= ATA_TFLAG_WRITE;
2877 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2880 * Set transfer length.
2882 * TODO: find out if we need to do more here to
2883 * cover scatter/gather case.
2885 ata_qc_set_pc_nbytes(qc);
2887 /* We may not issue DMA commands if no DMA mode is set */
2888 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2891 /* sanity check for pio multi commands */
2892 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2895 if (is_multi_taskfile(tf)) {
2896 unsigned int multi_count = 1 << (cdb[1] >> 5);
2898 /* compare the passed through multi_count
2899 * with the cached multi_count of libata
2901 if (multi_count != dev->multi_count)
2902 ata_dev_printk(dev, KERN_WARNING,
2903 "invalid multi_count %u ignored\n",
2908 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2909 * SET_FEATURES - XFER MODE must be preceded/succeeded
2910 * by an update to hardware-specific registers for each
2911 * controller (i.e. the reason for ->set_piomode(),
2912 * ->set_dmamode(), and ->post_set_mode() hooks).
2914 if (tf->command == ATA_CMD_SET_FEATURES &&
2915 tf->feature == SETFEATURES_XFER)
2919 * Filter TPM commands by default. These provide an
2920 * essentially uncontrolled encrypted "back door" between
2921 * applications and the disk. Set libata.allow_tpm=1 if you
2922 * have a real reason for wanting to use them. This ensures
2923 * that installed software cannot easily mess stuff up without
2924 * user intent. DVR type users will probably ship with this enabled
2925 * for movie content management.
2927 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2928 * for this and should do in future but that it is not sufficient as
2929 * DCS is an optional feature set. Thus we also do the software filter
2930 * so that we comply with the TC consortium stated goal that the user
2931 * can turn off TC features of their system.
2933 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2939 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2940 /* "Invalid field in cdb" */
2944 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
2946 struct ata_taskfile *tf = &qc->tf;
2947 struct scsi_cmnd *scmd = qc->scsicmd;
2948 struct ata_device *dev = qc->dev;
2949 const u8 *cdb = scmd->cmnd;
2955 /* we may not issue DMA commands if no DMA mode is set */
2956 if (unlikely(!dev->dma_mode))
2959 if (unlikely(scmd->cmd_len < 16))
2961 scsi_16_lba_len(cdb, &block, &n_block);
2963 /* for now we only support WRITE SAME with the unmap bit set */
2964 if (unlikely(!(cdb[1] & 0x8)))
2968 * WRITE SAME always has a sector sized buffer as payload, this
2969 * should never be a multiple entry S/G list.
2971 if (!scsi_sg_count(scmd))
2974 buf = page_address(sg_page(scsi_sglist(scmd)));
2975 size = ata_set_lba_range_entries(buf, 512, block, n_block);
2977 tf->protocol = ATA_PROT_DMA;
2978 tf->hob_feature = 0;
2979 tf->feature = ATA_DSM_TRIM;
2980 tf->hob_nsect = (size / 512) >> 8;
2981 tf->nsect = size / 512;
2982 tf->command = ATA_CMD_DSM;
2983 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
2986 ata_qc_set_pc_nbytes(qc);
2991 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2992 /* "Invalid field in cdb" */
2997 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2999 * @cmd: SCSI command opcode to consider
3001 * Look up the SCSI command given, and determine whether the
3002 * SCSI command is to be translated or simulated.
3005 * Pointer to translation function if possible, %NULL if not.
3008 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3018 return ata_scsi_rw_xlat;
3020 case 0x93 /*WRITE_SAME_16*/:
3021 return ata_scsi_write_same_xlat;
3023 case SYNCHRONIZE_CACHE:
3024 if (ata_try_flush_cache(dev))
3025 return ata_scsi_flush_xlat;
3030 return ata_scsi_verify_xlat;
3034 return ata_scsi_pass_thru;
3037 return ata_scsi_start_stop_xlat;
3044 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3045 * @ap: ATA port to which the command was being sent
3046 * @cmd: SCSI command to dump
3048 * Prints the contents of a SCSI command via printk().
3051 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3052 struct scsi_cmnd *cmd)
3055 struct scsi_device *scsidev = cmd->device;
3056 u8 *scsicmd = cmd->cmnd;
3058 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3060 scsidev->channel, scsidev->id, scsidev->lun,
3061 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3062 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3067 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3068 void (*done)(struct scsi_cmnd *),
3069 struct ata_device *dev)
3071 u8 scsi_op = scmd->cmnd[0];
3072 ata_xlat_func_t xlat_func;
3075 if (dev->class == ATA_DEV_ATA) {
3076 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3079 xlat_func = ata_get_xlat_func(dev, scsi_op);
3081 if (unlikely(!scmd->cmd_len))
3085 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3086 /* relay SCSI command to ATAPI device */
3087 int len = COMMAND_SIZE(scsi_op);
3088 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3091 xlat_func = atapi_xlat;
3093 /* ATA_16 passthru, treat as an ATA command */
3094 if (unlikely(scmd->cmd_len > 16))
3097 xlat_func = ata_get_xlat_func(dev, scsi_op);
3102 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
3104 ata_scsi_simulate(dev, scmd, done);
3109 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3110 scmd->cmd_len, scsi_op, dev->cdb_len);
3111 scmd->result = DID_ERROR << 16;
3117 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3118 * @cmd: SCSI command to be sent
3119 * @done: Completion function, called when command is complete
3121 * In some cases, this function translates SCSI commands into
3122 * ATA taskfiles, and queues the taskfiles to be sent to
3123 * hardware. In other cases, this function simulates a
3124 * SCSI device by evaluating and responding to certain
3125 * SCSI commands. This creates the overall effect of
3126 * ATA and ATAPI devices appearing as SCSI devices.
3129 * Releases scsi-layer-held lock, and obtains host lock.
3132 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3135 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3137 struct ata_port *ap;
3138 struct ata_device *dev;
3139 struct scsi_device *scsidev = cmd->device;
3140 struct Scsi_Host *shost = scsidev->host;
3143 ap = ata_shost_to_port(shost);
3145 spin_unlock(shost->host_lock);
3146 spin_lock(ap->lock);
3148 ata_scsi_dump_cdb(ap, cmd);
3150 dev = ata_scsi_find_dev(ap, scsidev);
3152 rc = __ata_scsi_queuecmd(cmd, done, dev);
3154 cmd->result = (DID_BAD_TARGET << 16);
3158 spin_unlock(ap->lock);
3159 spin_lock(shost->host_lock);
3164 * ata_scsi_simulate - simulate SCSI command on ATA device
3165 * @dev: the target device
3166 * @cmd: SCSI command being sent to device.
3167 * @done: SCSI command completion function.
3169 * Interprets and directly executes a select list of SCSI commands
3170 * that can be handled internally.
3173 * spin_lock_irqsave(host lock)
3176 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3177 void (*done)(struct scsi_cmnd *))
3179 struct ata_scsi_args args;
3180 const u8 *scsicmd = cmd->cmnd;
3188 switch(scsicmd[0]) {
3189 /* TODO: worth improving? */
3191 ata_scsi_invalid_field(cmd, done);
3195 if (scsicmd[1] & 2) /* is CmdDt set? */
3196 ata_scsi_invalid_field(cmd, done);
3197 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3198 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3199 else switch (scsicmd[2]) {
3201 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3204 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3207 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3210 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3213 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3216 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3219 ata_scsi_invalid_field(cmd, done);
3226 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3229 case MODE_SELECT: /* unconditionally return */
3230 case MODE_SELECT_10: /* bad-field-in-cdb */
3231 ata_scsi_invalid_field(cmd, done);
3235 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3238 case SERVICE_ACTION_IN:
3239 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3240 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3242 ata_scsi_invalid_field(cmd, done);
3246 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3250 ata_scsi_set_sense(cmd, 0, 0, 0);
3251 cmd->result = (DRIVER_SENSE << 24);
3255 /* if we reach this, then writeback caching is disabled,
3256 * turning this into a no-op.
3258 case SYNCHRONIZE_CACHE:
3261 /* no-op's, complete with success */
3265 case TEST_UNIT_READY:
3266 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3269 case SEND_DIAGNOSTIC:
3270 tmp8 = scsicmd[1] & ~(1 << 3);
3271 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3272 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3274 ata_scsi_invalid_field(cmd, done);
3277 /* all other commands */
3279 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3280 /* "Invalid command operation code" */
3286 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3290 for (i = 0; i < host->n_ports; i++) {
3291 struct ata_port *ap = host->ports[i];
3292 struct Scsi_Host *shost;
3295 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3299 *(struct ata_port **)&shost->hostdata[0] = ap;
3300 ap->scsi_host = shost;
3302 shost->transportt = &ata_scsi_transport_template;
3303 shost->unique_id = ap->print_id;
3306 shost->max_channel = 1;
3307 shost->max_cmd_len = 16;
3309 /* Schedule policy is determined by ->qc_defer()
3310 * callback and it needs to see every deferred qc.
3311 * Set host_blocked to 1 to prevent SCSI midlayer from
3312 * automatically deferring requests.
3314 shost->max_host_blocked = 1;
3316 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3324 scsi_host_put(host->ports[i]->scsi_host);
3327 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3329 scsi_remove_host(shost);
3330 scsi_host_put(shost);
3335 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3338 struct ata_device *last_failed_dev = NULL;
3339 struct ata_link *link;
3340 struct ata_device *dev;
3342 if (ap->flags & ATA_FLAG_DISABLED)
3346 ata_for_each_link(link, ap, EDGE) {
3347 ata_for_each_dev(dev, link, ENABLED) {
3348 struct scsi_device *sdev;
3349 int channel = 0, id = 0;
3354 if (ata_is_host_link(link))
3357 channel = link->pmp;
3359 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3361 if (!IS_ERR(sdev)) {
3363 scsi_device_put(sdev);
3368 /* If we scanned while EH was in progress or allocation
3369 * failure occurred, scan would have failed silently. Check
3370 * whether all devices are attached.
3372 ata_for_each_link(link, ap, EDGE) {
3373 ata_for_each_dev(dev, link, ENABLED) {
3382 /* we're missing some SCSI devices */
3384 /* If caller requested synchrnous scan && we've made
3385 * any progress, sleep briefly and repeat.
3387 if (dev != last_failed_dev) {
3389 last_failed_dev = dev;
3393 /* We might be failing to detect boot device, give it
3394 * a few more chances.
3401 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3402 "failed without making any progress,\n"
3403 " switching to async\n");
3406 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3407 round_jiffies_relative(HZ));
3411 * ata_scsi_offline_dev - offline attached SCSI device
3412 * @dev: ATA device to offline attached SCSI device for
3414 * This function is called from ata_eh_hotplug() and responsible
3415 * for taking the SCSI device attached to @dev offline. This
3416 * function is called with host lock which protects dev->sdev
3420 * spin_lock_irqsave(host lock)
3423 * 1 if attached SCSI device exists, 0 otherwise.
3425 int ata_scsi_offline_dev(struct ata_device *dev)
3428 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3435 * ata_scsi_remove_dev - remove attached SCSI device
3436 * @dev: ATA device to remove attached SCSI device for
3438 * This function is called from ata_eh_scsi_hotplug() and
3439 * responsible for removing the SCSI device attached to @dev.
3442 * Kernel thread context (may sleep).
3444 static void ata_scsi_remove_dev(struct ata_device *dev)
3446 struct ata_port *ap = dev->link->ap;
3447 struct scsi_device *sdev;
3448 unsigned long flags;
3450 /* Alas, we need to grab scan_mutex to ensure SCSI device
3451 * state doesn't change underneath us and thus
3452 * scsi_device_get() always succeeds. The mutex locking can
3453 * be removed if there is __scsi_device_get() interface which
3454 * increments reference counts regardless of device state.
3456 mutex_lock(&ap->scsi_host->scan_mutex);
3457 spin_lock_irqsave(ap->lock, flags);
3459 /* clearing dev->sdev is protected by host lock */
3464 /* If user initiated unplug races with us, sdev can go
3465 * away underneath us after the host lock and
3466 * scan_mutex are released. Hold onto it.
3468 if (scsi_device_get(sdev) == 0) {
3469 /* The following ensures the attached sdev is
3470 * offline on return from ata_scsi_offline_dev()
3471 * regardless it wins or loses the race
3472 * against this function.
3474 scsi_device_set_state(sdev, SDEV_OFFLINE);
3481 spin_unlock_irqrestore(ap->lock, flags);
3482 mutex_unlock(&ap->scsi_host->scan_mutex);
3485 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3486 dev_name(&sdev->sdev_gendev));
3488 scsi_remove_device(sdev);
3489 scsi_device_put(sdev);
3493 static void ata_scsi_handle_link_detach(struct ata_link *link)
3495 struct ata_port *ap = link->ap;
3496 struct ata_device *dev;
3498 ata_for_each_dev(dev, link, ALL) {
3499 unsigned long flags;
3501 if (!(dev->flags & ATA_DFLAG_DETACHED))
3504 spin_lock_irqsave(ap->lock, flags);
3505 dev->flags &= ~ATA_DFLAG_DETACHED;
3506 spin_unlock_irqrestore(ap->lock, flags);
3508 ata_scsi_remove_dev(dev);
3513 * ata_scsi_media_change_notify - send media change event
3514 * @dev: Pointer to the disk device with media change event
3516 * Tell the block layer to send a media change notification
3520 * spin_lock_irqsave(host lock)
3522 void ata_scsi_media_change_notify(struct ata_device *dev)
3525 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3530 * ata_scsi_hotplug - SCSI part of hotplug
3531 * @work: Pointer to ATA port to perform SCSI hotplug on
3533 * Perform SCSI part of hotplug. It's executed from a separate
3534 * workqueue after EH completes. This is necessary because SCSI
3535 * hot plugging requires working EH and hot unplugging is
3536 * synchronized with hot plugging with a mutex.
3539 * Kernel thread context (may sleep).
3541 void ata_scsi_hotplug(struct work_struct *work)
3543 struct ata_port *ap =
3544 container_of(work, struct ata_port, hotplug_task.work);
3547 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3548 DPRINTK("ENTER/EXIT - unloading\n");
3554 /* Unplug detached devices. We cannot use link iterator here
3555 * because PMP links have to be scanned even if PMP is
3556 * currently not attached. Iterate manually.
3558 ata_scsi_handle_link_detach(&ap->link);
3560 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3561 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3563 /* scan for new ones */
3564 ata_scsi_scan_host(ap, 0);
3570 * ata_scsi_user_scan - indication for user-initiated bus scan
3571 * @shost: SCSI host to scan
3572 * @channel: Channel to scan
3576 * This function is called when user explicitly requests bus
3577 * scan. Set probe pending flag and invoke EH.
3580 * SCSI layer (we don't care)
3585 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3586 unsigned int id, unsigned int lun)
3588 struct ata_port *ap = ata_shost_to_port(shost);
3589 unsigned long flags;
3592 if (!ap->ops->error_handler)
3595 if (lun != SCAN_WILD_CARD && lun)
3598 if (!sata_pmp_attached(ap)) {
3599 if (channel != SCAN_WILD_CARD && channel)
3603 if (id != SCAN_WILD_CARD && id)
3608 spin_lock_irqsave(ap->lock, flags);
3610 if (devno == SCAN_WILD_CARD) {
3611 struct ata_link *link;
3613 ata_for_each_link(link, ap, EDGE) {
3614 struct ata_eh_info *ehi = &link->eh_info;
3615 ehi->probe_mask |= ATA_ALL_DEVICES;
3616 ehi->action |= ATA_EH_RESET;
3619 struct ata_device *dev = ata_find_dev(ap, devno);
3622 struct ata_eh_info *ehi = &dev->link->eh_info;
3623 ehi->probe_mask |= 1 << dev->devno;
3624 ehi->action |= ATA_EH_RESET;
3630 ata_port_schedule_eh(ap);
3631 spin_unlock_irqrestore(ap->lock, flags);
3632 ata_port_wait_eh(ap);
3634 spin_unlock_irqrestore(ap->lock, flags);
3640 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3641 * @work: Pointer to ATA port to perform scsi_rescan_device()
3643 * After ATA pass thru (SAT) commands are executed successfully,
3644 * libata need to propagate the changes to SCSI layer. This
3645 * function must be executed from ata_aux_wq such that sdev
3646 * attach/detach don't race with rescan.
3649 * Kernel thread context (may sleep).
3651 void ata_scsi_dev_rescan(struct work_struct *work)
3653 struct ata_port *ap =
3654 container_of(work, struct ata_port, scsi_rescan_task);
3655 struct ata_link *link;
3656 struct ata_device *dev;
3657 unsigned long flags;
3659 spin_lock_irqsave(ap->lock, flags);
3661 ata_for_each_link(link, ap, EDGE) {
3662 ata_for_each_dev(dev, link, ENABLED) {
3663 struct scsi_device *sdev = dev->sdev;
3667 if (scsi_device_get(sdev))
3670 spin_unlock_irqrestore(ap->lock, flags);
3671 scsi_rescan_device(&(sdev->sdev_gendev));
3672 scsi_device_put(sdev);
3673 spin_lock_irqsave(ap->lock, flags);
3677 spin_unlock_irqrestore(ap->lock, flags);
3681 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3682 * @host: ATA host container for all SAS ports
3683 * @port_info: Information from low-level host driver
3684 * @shost: SCSI host that the scsi device is attached to
3687 * PCI/etc. bus probe sem.
3690 * ata_port pointer on success / NULL on failure.
3693 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3694 struct ata_port_info *port_info,
3695 struct Scsi_Host *shost)
3697 struct ata_port *ap;
3699 ap = ata_port_alloc(host);
3704 ap->lock = shost->host_lock;
3705 ap->pio_mask = port_info->pio_mask;
3706 ap->mwdma_mask = port_info->mwdma_mask;
3707 ap->udma_mask = port_info->udma_mask;
3708 ap->flags |= port_info->flags;
3709 ap->ops = port_info->port_ops;
3710 ap->cbl = ATA_CBL_SATA;
3714 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3717 * ata_sas_port_start - Set port up for dma.
3718 * @ap: Port to initialize
3720 * Called just after data structures for each port are
3723 * May be used as the port_start() entry in ata_port_operations.
3726 * Inherited from caller.
3728 int ata_sas_port_start(struct ata_port *ap)
3732 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3735 * ata_port_stop - Undo ata_sas_port_start()
3736 * @ap: Port to shut down
3738 * May be used as the port_stop() entry in ata_port_operations.
3741 * Inherited from caller.
3744 void ata_sas_port_stop(struct ata_port *ap)
3747 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3750 * ata_sas_port_init - Initialize a SATA device
3751 * @ap: SATA port to initialize
3754 * PCI/etc. bus probe sem.
3757 * Zero on success, non-zero on error.
3760 int ata_sas_port_init(struct ata_port *ap)
3762 int rc = ap->ops->port_start(ap);
3765 ap->print_id = ata_print_id++;
3766 rc = ata_bus_probe(ap);
3771 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3774 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3775 * @ap: SATA port to destroy
3779 void ata_sas_port_destroy(struct ata_port *ap)
3781 if (ap->ops->port_stop)
3782 ap->ops->port_stop(ap);
3785 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3788 * ata_sas_slave_configure - Default slave_config routine for libata devices
3789 * @sdev: SCSI device to configure
3790 * @ap: ATA port to which SCSI device is attached
3796 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3798 ata_scsi_sdev_config(sdev);
3799 ata_scsi_dev_config(sdev, ap->link.device);
3802 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3805 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3806 * @cmd: SCSI command to be sent
3807 * @done: Completion function, called when command is complete
3808 * @ap: ATA port to which the command is being sent
3811 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3815 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3816 struct ata_port *ap)
3820 ata_scsi_dump_cdb(ap, cmd);
3822 if (likely(ata_dev_enabled(ap->link.device)))
3823 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3825 cmd->result = (DID_BAD_TARGET << 16);
3830 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);