1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * libata-scsi.c - helper library for ATA
5 * Maintained by: Tejun Heo <tj@kernel.org>
6 * Please ALWAYS copy linux-ide@vger.kernel.org
9 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
10 * Copyright 2003-2004 Jeff Garzik
12 * libata documentation is available via 'make {ps|pdf}docs',
13 * as Documentation/driver-api/libata.rst
15 * Hardware documentation available from
16 * - http://www.t10.org/
17 * - http://www.t13.org/
20 #include <linux/slab.h>
21 #include <linux/kernel.h>
22 #include <linux/blkdev.h>
23 #include <linux/spinlock.h>
24 #include <linux/export.h>
25 #include <scsi/scsi.h>
26 #include <scsi/scsi_host.h>
27 #include <scsi/scsi_cmnd.h>
28 #include <scsi/scsi_eh.h>
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_tcq.h>
31 #include <scsi/scsi_transport.h>
32 #include <linux/libata.h>
33 #include <linux/hdreg.h>
34 #include <linux/uaccess.h>
35 #include <linux/suspend.h>
36 #include <asm/unaligned.h>
37 #include <linux/ioprio.h>
40 #include "libata-transport.h"
42 #define ATA_SCSI_RBUF_SIZE 4096
44 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
45 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
47 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
49 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
50 const struct scsi_device *scsidev);
51 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
52 const struct scsi_device *scsidev);
54 #define RW_RECOVERY_MPAGE 0x1
55 #define RW_RECOVERY_MPAGE_LEN 12
56 #define CACHE_MPAGE 0x8
57 #define CACHE_MPAGE_LEN 20
58 #define CONTROL_MPAGE 0xa
59 #define CONTROL_MPAGE_LEN 12
60 #define ALL_MPAGES 0x3f
61 #define ALL_SUB_MPAGES 0xff
64 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
66 RW_RECOVERY_MPAGE_LEN - 2,
68 0, /* read retry count */
70 0, /* write retry count */
74 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
77 0, /* contains WCE, needs to be 0 for logic */
78 0, 0, 0, 0, 0, 0, 0, 0, 0,
79 0, /* contains DRA, needs to be 0 for logic */
83 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
85 CONTROL_MPAGE_LEN - 2,
86 2, /* DSENSE=0, GLTSD=1 */
87 0, /* [QAM+QERR may be 1, see 05-359r1] */
88 0, 0, 0, 0, 0xff, 0xff,
89 0, 30 /* extended self test time, see 05-359r1 */
92 static const char *ata_lpm_policy_names[] = {
93 [ATA_LPM_UNKNOWN] = "max_performance",
94 [ATA_LPM_MAX_POWER] = "max_performance",
95 [ATA_LPM_MED_POWER] = "medium_power",
96 [ATA_LPM_MED_POWER_WITH_DIPM] = "med_power_with_dipm",
97 [ATA_LPM_MIN_POWER_WITH_PARTIAL] = "min_power_with_partial",
98 [ATA_LPM_MIN_POWER] = "min_power",
101 static ssize_t ata_scsi_lpm_store(struct device *device,
102 struct device_attribute *attr,
103 const char *buf, size_t count)
105 struct Scsi_Host *shost = class_to_shost(device);
106 struct ata_port *ap = ata_shost_to_port(shost);
107 struct ata_link *link;
108 struct ata_device *dev;
109 enum ata_lpm_policy policy;
112 /* UNKNOWN is internal state, iterate from MAX_POWER */
113 for (policy = ATA_LPM_MAX_POWER;
114 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
115 const char *name = ata_lpm_policy_names[policy];
117 if (strncmp(name, buf, strlen(name)) == 0)
120 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
123 spin_lock_irqsave(ap->lock, flags);
125 ata_for_each_link(link, ap, EDGE) {
126 ata_for_each_dev(dev, &ap->link, ENABLED) {
127 if (dev->horkage & ATA_HORKAGE_NOLPM) {
134 ap->target_lpm_policy = policy;
135 ata_port_schedule_eh(ap);
137 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;
165 unsigned int uninitialized_var(msecs);
168 ap = ata_shost_to_port(sdev->host);
170 spin_lock_irq(ap->lock);
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 = kstrtol(buf, 10, &input);
212 if (input > ATA_TMOUT_MAX_PARK) {
214 input = ATA_TMOUT_MAX_PARK;
217 ap = ata_shost_to_port(sdev->host);
219 spin_lock_irqsave(ap->lock, flags);
220 dev = ata_scsi_find_dev(ap, sdev);
221 if (unlikely(!dev)) {
225 if (dev->class != ATA_DEV_ATA &&
226 dev->class != ATA_DEV_ZAC) {
232 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
237 dev->unpark_deadline = ata_deadline(jiffies, input);
238 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
239 ata_port_schedule_eh(ap);
240 complete(&ap->park_req_pending);
244 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
247 dev->flags |= ATA_DFLAG_NO_UNLOAD;
252 spin_unlock_irqrestore(ap->lock, flags);
254 return rc ? rc : len;
256 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
257 ata_scsi_park_show, ata_scsi_park_store);
258 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
260 static ssize_t ata_ncq_prio_enable_show(struct device *device,
261 struct device_attribute *attr,
264 struct scsi_device *sdev = to_scsi_device(device);
266 struct ata_device *dev;
267 bool ncq_prio_enable;
270 ap = ata_shost_to_port(sdev->host);
272 spin_lock_irq(ap->lock);
273 dev = ata_scsi_find_dev(ap, sdev);
279 ncq_prio_enable = dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLE;
282 spin_unlock_irq(ap->lock);
284 return rc ? rc : snprintf(buf, 20, "%u\n", ncq_prio_enable);
287 static ssize_t ata_ncq_prio_enable_store(struct device *device,
288 struct device_attribute *attr,
289 const char *buf, size_t len)
291 struct scsi_device *sdev = to_scsi_device(device);
293 struct ata_device *dev;
297 rc = kstrtol(buf, 10, &input);
300 if ((input < 0) || (input > 1))
303 ap = ata_shost_to_port(sdev->host);
304 dev = ata_scsi_find_dev(ap, sdev);
308 spin_lock_irq(ap->lock);
310 dev->flags |= ATA_DFLAG_NCQ_PRIO_ENABLE;
312 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
314 dev->link->eh_info.action |= ATA_EH_REVALIDATE;
315 dev->link->eh_info.flags |= ATA_EHI_QUIET;
316 ata_port_schedule_eh(ap);
317 spin_unlock_irq(ap->lock);
319 ata_port_wait_eh(ap);
322 spin_lock_irq(ap->lock);
323 if (!(dev->flags & ATA_DFLAG_NCQ_PRIO)) {
324 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
327 spin_unlock_irq(ap->lock);
330 return rc ? rc : len;
333 DEVICE_ATTR(ncq_prio_enable, S_IRUGO | S_IWUSR,
334 ata_ncq_prio_enable_show, ata_ncq_prio_enable_store);
335 EXPORT_SYMBOL_GPL(dev_attr_ncq_prio_enable);
337 void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
338 u8 sk, u8 asc, u8 ascq)
340 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
345 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
347 scsi_build_sense_buffer(d_sense, cmd->sense_buffer, sk, asc, ascq);
350 void ata_scsi_set_sense_information(struct ata_device *dev,
351 struct scsi_cmnd *cmd,
352 const struct ata_taskfile *tf)
359 information = ata_tf_read_block(tf, dev);
360 if (information == U64_MAX)
363 scsi_set_sense_information(cmd->sense_buffer,
364 SCSI_SENSE_BUFFERSIZE, information);
367 static void ata_scsi_set_invalid_field(struct ata_device *dev,
368 struct scsi_cmnd *cmd, u16 field, u8 bit)
370 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
371 /* "Invalid field in CDB" */
372 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
376 static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
377 struct scsi_cmnd *cmd, u16 field)
379 /* "Invalid field in parameter list" */
380 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
381 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
386 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
387 const char *buf, size_t count)
389 struct Scsi_Host *shost = class_to_shost(dev);
390 struct ata_port *ap = ata_shost_to_port(shost);
391 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
392 return ap->ops->em_store(ap, buf, count);
397 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
400 struct Scsi_Host *shost = class_to_shost(dev);
401 struct ata_port *ap = ata_shost_to_port(shost);
403 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
404 return ap->ops->em_show(ap, buf);
407 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
408 ata_scsi_em_message_show, ata_scsi_em_message_store);
409 EXPORT_SYMBOL_GPL(dev_attr_em_message);
412 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
415 struct Scsi_Host *shost = class_to_shost(dev);
416 struct ata_port *ap = ata_shost_to_port(shost);
418 return snprintf(buf, 23, "%d\n", ap->em_message_type);
420 DEVICE_ATTR(em_message_type, S_IRUGO,
421 ata_scsi_em_message_type_show, NULL);
422 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
425 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
428 struct scsi_device *sdev = to_scsi_device(dev);
429 struct ata_port *ap = ata_shost_to_port(sdev->host);
430 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
432 if (atadev && ap->ops->sw_activity_show &&
433 (ap->flags & ATA_FLAG_SW_ACTIVITY))
434 return ap->ops->sw_activity_show(atadev, buf);
439 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
440 const char *buf, size_t count)
442 struct scsi_device *sdev = to_scsi_device(dev);
443 struct ata_port *ap = ata_shost_to_port(sdev->host);
444 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
445 enum sw_activity val;
448 if (atadev && ap->ops->sw_activity_store &&
449 (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
450 val = simple_strtoul(buf, NULL, 0);
452 case OFF: case BLINK_ON: case BLINK_OFF:
453 rc = ap->ops->sw_activity_store(atadev, val);
462 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
463 ata_scsi_activity_store);
464 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
466 struct device_attribute *ata_common_sdev_attrs[] = {
467 &dev_attr_unload_heads,
468 &dev_attr_ncq_prio_enable,
471 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
474 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
475 * @sdev: SCSI device for which BIOS geometry is to be determined
476 * @bdev: block device associated with @sdev
477 * @capacity: capacity of SCSI device
478 * @geom: location to which geometry will be output
480 * Generic bios head/sector/cylinder calculator
481 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
482 * mapping. Some situations may arise where the disk is not
483 * bootable if this is not used.
486 * Defined by the SCSI layer. We don't really care.
491 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
492 sector_t capacity, int geom[])
496 sector_div(capacity, 255*63);
503 * ata_scsi_unlock_native_capacity - unlock native capacity
504 * @sdev: SCSI device to adjust device capacity for
506 * This function is called if a partition on @sdev extends beyond
507 * the end of the device. It requests EH to unlock HPA.
510 * Defined by the SCSI layer. Might sleep.
512 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
514 struct ata_port *ap = ata_shost_to_port(sdev->host);
515 struct ata_device *dev;
518 spin_lock_irqsave(ap->lock, flags);
520 dev = ata_scsi_find_dev(ap, sdev);
521 if (dev && dev->n_sectors < dev->n_native_sectors) {
522 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
523 dev->link->eh_info.action |= ATA_EH_RESET;
524 ata_port_schedule_eh(ap);
527 spin_unlock_irqrestore(ap->lock, flags);
528 ata_port_wait_eh(ap);
532 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
534 * @sdev: SCSI device to get identify data for
535 * @arg: User buffer area for identify data
538 * Defined by the SCSI layer. We don't really care.
541 * Zero on success, negative errno on error.
543 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
546 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
547 u16 __user *dst = arg;
553 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
556 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
557 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
560 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
561 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
564 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
565 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
572 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
573 * @scsidev: Device to which we are issuing command
574 * @arg: User provided data for issuing command
577 * Defined by the SCSI layer. We don't really care.
580 * Zero on success, negative errno on error.
582 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
585 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
586 u8 scsi_cmd[MAX_COMMAND_SIZE];
587 u8 args[4], *argbuf = NULL;
589 enum dma_data_direction data_dir;
590 struct scsi_sense_hdr sshdr;
596 if (copy_from_user(args, arg, sizeof(args)))
599 memset(sensebuf, 0, sizeof(sensebuf));
600 memset(scsi_cmd, 0, sizeof(scsi_cmd));
603 argsize = ATA_SECT_SIZE * args[3];
604 argbuf = kmalloc(argsize, GFP_KERNEL);
605 if (argbuf == NULL) {
610 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
611 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
612 block count in sector count field */
613 data_dir = DMA_FROM_DEVICE;
615 scsi_cmd[1] = (3 << 1); /* Non-data */
616 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
620 scsi_cmd[0] = ATA_16;
622 scsi_cmd[4] = args[2];
623 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
624 scsi_cmd[6] = args[3];
625 scsi_cmd[8] = args[1];
626 scsi_cmd[10] = ATA_SMART_LBAM_PASS;
627 scsi_cmd[12] = ATA_SMART_LBAH_PASS;
629 scsi_cmd[6] = args[1];
631 scsi_cmd[14] = args[0];
633 /* Good values for timeout and retries? Values below
634 from scsi_ioctl_send_command() for default case... */
635 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
636 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
638 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
639 u8 *desc = sensebuf + 8;
640 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
642 /* If we set cc then ATA pass-through will cause a
643 * check condition even if no error. Filter that. */
644 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
645 if (sshdr.sense_key == RECOVERED_ERROR &&
646 sshdr.asc == 0 && sshdr.ascq == 0x1d)
647 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
650 /* Send userspace a few ATA registers (same as drivers/ide) */
651 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
652 desc[0] == 0x09) { /* code is "ATA Descriptor" */
653 args[0] = desc[13]; /* status */
654 args[1] = desc[3]; /* error */
655 args[2] = desc[5]; /* sector count (0:7) */
656 if (copy_to_user(arg, args, sizeof(args)))
668 && copy_to_user(arg + sizeof(args), argbuf, argsize))
676 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
677 * @scsidev: Device to which we are issuing command
678 * @arg: User provided data for issuing command
681 * Defined by the SCSI layer. We don't really care.
684 * Zero on success, negative errno on error.
686 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
689 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
690 u8 scsi_cmd[MAX_COMMAND_SIZE];
692 struct scsi_sense_hdr sshdr;
698 if (copy_from_user(args, arg, sizeof(args)))
701 memset(sensebuf, 0, sizeof(sensebuf));
702 memset(scsi_cmd, 0, sizeof(scsi_cmd));
703 scsi_cmd[0] = ATA_16;
704 scsi_cmd[1] = (3 << 1); /* Non-data */
705 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
706 scsi_cmd[4] = args[1];
707 scsi_cmd[6] = args[2];
708 scsi_cmd[8] = args[3];
709 scsi_cmd[10] = args[4];
710 scsi_cmd[12] = args[5];
711 scsi_cmd[13] = args[6] & 0x4f;
712 scsi_cmd[14] = args[0];
714 /* Good values for timeout and retries? Values below
715 from scsi_ioctl_send_command() for default case... */
716 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
717 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
719 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
720 u8 *desc = sensebuf + 8;
721 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
723 /* If we set cc then ATA pass-through will cause a
724 * check condition even if no error. Filter that. */
725 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
726 if (sshdr.sense_key == RECOVERED_ERROR &&
727 sshdr.asc == 0 && sshdr.ascq == 0x1d)
728 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
731 /* Send userspace ATA registers */
732 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
733 desc[0] == 0x09) {/* code is "ATA Descriptor" */
734 args[0] = desc[13]; /* status */
735 args[1] = desc[3]; /* error */
736 args[2] = desc[5]; /* sector count (0:7) */
737 args[3] = desc[7]; /* lbal */
738 args[4] = desc[9]; /* lbam */
739 args[5] = desc[11]; /* lbah */
740 args[6] = desc[12]; /* select */
741 if (copy_to_user(arg, args, sizeof(args)))
755 static int ata_ioc32(struct ata_port *ap)
757 if (ap->flags & ATA_FLAG_PIO_DMA)
759 if (ap->pflags & ATA_PFLAG_PIO32)
764 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
765 unsigned int cmd, void __user *arg)
773 spin_lock_irqsave(ap->lock, flags);
775 spin_unlock_irqrestore(ap->lock, flags);
776 return put_user(val, (unsigned long __user *)arg);
779 val = (unsigned long) arg;
781 spin_lock_irqsave(ap->lock, flags);
782 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
784 ap->pflags |= ATA_PFLAG_PIO32;
786 ap->pflags &= ~ATA_PFLAG_PIO32;
788 if (val != ata_ioc32(ap))
791 spin_unlock_irqrestore(ap->lock, flags);
794 case HDIO_GET_IDENTITY:
795 return ata_get_identity(ap, scsidev, arg);
798 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
800 return ata_cmd_ioctl(scsidev, arg);
802 case HDIO_DRIVE_TASK:
803 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
805 return ata_task_ioctl(scsidev, arg);
814 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
816 int ata_scsi_ioctl(struct scsi_device *scsidev, unsigned int cmd,
819 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
822 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
825 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
826 * @dev: ATA device to which the new command is attached
827 * @cmd: SCSI command that originated this ATA command
829 * Obtain a reference to an unused ata_queued_cmd structure,
830 * which is the basic libata structure representing a single
831 * ATA command sent to the hardware.
833 * If a command was available, fill in the SCSI-specific
834 * portions of the structure with information on the
838 * spin_lock_irqsave(host lock)
841 * Command allocated, or %NULL if none available.
843 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
844 struct scsi_cmnd *cmd)
846 struct ata_queued_cmd *qc;
848 qc = ata_qc_new_init(dev, cmd->request->tag);
851 qc->scsidone = cmd->scsi_done;
853 qc->sg = scsi_sglist(cmd);
854 qc->n_elem = scsi_sg_count(cmd);
856 if (cmd->request->rq_flags & RQF_QUIET)
857 qc->flags |= ATA_QCFLAG_QUIET;
859 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
866 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
868 struct scsi_cmnd *scmd = qc->scsicmd;
870 qc->extrabytes = scmd->request->extra_len;
871 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
875 * ata_dump_status - user friendly display of error info
876 * @id: id of the port in question
877 * @tf: ptr to filled out taskfile
879 * Decode and dump the ATA error/status registers for the user so
880 * that they have some idea what really happened at the non
881 * make-believe layer.
884 * inherited from caller
886 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
888 u8 stat = tf->command, err = tf->feature;
890 pr_warn("ata%u: status=0x%02x { ", id, stat);
891 if (stat & ATA_BUSY) {
892 pr_cont("Busy }\n"); /* Data is not valid in this case */
894 if (stat & ATA_DRDY) pr_cont("DriveReady ");
895 if (stat & ATA_DF) pr_cont("DeviceFault ");
896 if (stat & ATA_DSC) pr_cont("SeekComplete ");
897 if (stat & ATA_DRQ) pr_cont("DataRequest ");
898 if (stat & ATA_CORR) pr_cont("CorrectedError ");
899 if (stat & ATA_SENSE) pr_cont("Sense ");
900 if (stat & ATA_ERR) pr_cont("Error ");
904 pr_warn("ata%u: error=0x%02x { ", id, err);
905 if (err & ATA_ABORTED) pr_cont("DriveStatusError ");
906 if (err & ATA_ICRC) {
907 if (err & ATA_ABORTED)
909 else pr_cont("Sector ");
911 if (err & ATA_UNC) pr_cont("UncorrectableError ");
912 if (err & ATA_IDNF) pr_cont("SectorIdNotFound ");
913 if (err & ATA_TRK0NF) pr_cont("TrackZeroNotFound ");
914 if (err & ATA_AMNF) pr_cont("AddrMarkNotFound ");
921 * ata_to_sense_error - convert ATA error to SCSI error
922 * @id: ATA device number
923 * @drv_stat: value contained in ATA status register
924 * @drv_err: value contained in ATA error register
925 * @sk: the sense key we'll fill out
926 * @asc: the additional sense code we'll fill out
927 * @ascq: the additional sense code qualifier we'll fill out
928 * @verbose: be verbose
930 * Converts an ATA error into a SCSI error. Fill out pointers to
931 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
932 * format sense blocks.
935 * spin_lock_irqsave(host lock)
937 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
938 u8 *asc, u8 *ascq, int verbose)
942 /* Based on the 3ware driver translation table */
943 static const unsigned char sense_table[][4] = {
945 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
946 // Device busy Aborted command
948 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
949 // Device busy Aborted command
951 {0x61, HARDWARE_ERROR, 0x00, 0x00},
952 // Device fault Hardware error
953 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
954 {0x84, ABORTED_COMMAND, 0x47, 0x00},
955 // Data CRC error SCSI parity error
956 /* MC|ID|ABRT|TRK0|MARK */
957 {0x37, NOT_READY, 0x04, 0x00},
958 // Unit offline Not ready
960 {0x09, NOT_READY, 0x04, 0x00},
961 // Unrecovered disk error Not ready
962 /* Bad address mark */
963 {0x01, MEDIUM_ERROR, 0x13, 0x00},
964 // Address mark not found for data field
965 /* TRK0 - Track 0 not found */
966 {0x02, HARDWARE_ERROR, 0x00, 0x00},
968 /* Abort: 0x04 is not translated here, see below */
969 /* Media change request */
970 {0x08, NOT_READY, 0x04, 0x00},
971 // FIXME: faking offline
972 /* SRV/IDNF - ID not found */
973 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
974 // Logical address out of range
975 /* MC - Media Changed */
976 {0x20, UNIT_ATTENTION, 0x28, 0x00},
977 // Not ready to ready change, medium may have changed
978 /* ECC - Uncorrectable ECC error */
979 {0x40, MEDIUM_ERROR, 0x11, 0x04},
980 // Unrecovered read error
981 /* BBD - block marked bad */
982 {0x80, MEDIUM_ERROR, 0x11, 0x04},
983 // Block marked bad Medium error, unrecovered read error
984 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
986 static const unsigned char stat_table[][4] = {
987 /* Must be first because BUSY means no other bits valid */
988 {0x80, ABORTED_COMMAND, 0x47, 0x00},
989 // Busy, fake parity for now
990 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
991 // Device ready, unaligned write command
992 {0x20, HARDWARE_ERROR, 0x44, 0x00},
993 // Device fault, internal target failure
994 {0x08, ABORTED_COMMAND, 0x47, 0x00},
995 // Timed out in xfer, fake parity for now
996 {0x04, RECOVERED_ERROR, 0x11, 0x00},
997 // Recovered ECC error Medium error, recovered
998 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1002 * Is this an error we can process/parse
1004 if (drv_stat & ATA_BUSY) {
1005 drv_err = 0; /* Ignore the err bits, they're invalid */
1009 /* Look for drv_err */
1010 for (i = 0; sense_table[i][0] != 0xFF; i++) {
1011 /* Look for best matches first */
1012 if ((sense_table[i][0] & drv_err) ==
1013 sense_table[i][0]) {
1014 *sk = sense_table[i][1];
1015 *asc = sense_table[i][2];
1016 *ascq = sense_table[i][3];
1017 goto translate_done;
1023 * Fall back to interpreting status bits. Note that if the drv_err
1024 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
1025 * is not descriptive enough.
1027 for (i = 0; stat_table[i][0] != 0xFF; i++) {
1028 if (stat_table[i][0] & drv_stat) {
1029 *sk = stat_table[i][1];
1030 *asc = stat_table[i][2];
1031 *ascq = stat_table[i][3];
1032 goto translate_done;
1037 * We need a sensible error return here, which is tricky, and one
1038 * that won't cause people to do things like return a disk wrongly.
1040 *sk = ABORTED_COMMAND;
1046 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
1047 id, drv_stat, drv_err, *sk, *asc, *ascq);
1052 * ata_gen_passthru_sense - Generate check condition sense block.
1053 * @qc: Command that completed.
1055 * This function is specific to the ATA descriptor format sense
1056 * block specified for the ATA pass through commands. Regardless
1057 * of whether the command errored or not, return a sense
1058 * block. Copy all controller registers into the sense
1059 * block. If there was no error, we get the request from an ATA
1060 * passthrough command, so we use the following sense data:
1061 * sk = RECOVERED ERROR
1062 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1068 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
1070 struct scsi_cmnd *cmd = qc->scsicmd;
1071 struct ata_taskfile *tf = &qc->result_tf;
1072 unsigned char *sb = cmd->sense_buffer;
1073 unsigned char *desc = sb + 8;
1074 int verbose = qc->ap->ops->error_handler == NULL;
1075 u8 sense_key, asc, ascq;
1077 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1079 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1082 * Use ata_to_sense_error() to map status register bits
1083 * onto sense key, asc & ascq.
1086 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1087 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1088 &sense_key, &asc, &ascq, verbose);
1089 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
1092 * ATA PASS-THROUGH INFORMATION AVAILABLE
1093 * Always in descriptor format sense.
1095 scsi_build_sense_buffer(1, cmd->sense_buffer,
1096 RECOVERED_ERROR, 0, 0x1D);
1099 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
1102 /* descriptor format */
1104 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
1106 if (SCSI_SENSE_BUFFERSIZE < len + 14)
1109 desc = sb + 8 + len;
1114 * Copy registers into sense buffer.
1117 desc[3] = tf->feature; /* == error reg */
1118 desc[5] = tf->nsect;
1121 desc[11] = tf->lbah;
1122 desc[12] = tf->device;
1123 desc[13] = tf->command; /* == status reg */
1126 * Fill in Extend bit, and the high order bytes
1129 if (tf->flags & ATA_TFLAG_LBA48) {
1131 desc[4] = tf->hob_nsect;
1132 desc[6] = tf->hob_lbal;
1133 desc[8] = tf->hob_lbam;
1134 desc[10] = tf->hob_lbah;
1137 /* Fixed sense format */
1138 desc[0] = tf->feature;
1139 desc[1] = tf->command; /* status */
1140 desc[2] = tf->device;
1141 desc[3] = tf->nsect;
1143 if (tf->flags & ATA_TFLAG_LBA48) {
1147 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
1151 desc[10] = tf->lbam;
1152 desc[11] = tf->lbah;
1157 * ata_gen_ata_sense - generate a SCSI fixed sense block
1158 * @qc: Command that we are erroring out
1160 * Generate sense block for a failed ATA command @qc. Descriptor
1161 * format is used to accommodate LBA48 block address.
1166 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1168 struct ata_device *dev = qc->dev;
1169 struct scsi_cmnd *cmd = qc->scsicmd;
1170 struct ata_taskfile *tf = &qc->result_tf;
1171 unsigned char *sb = cmd->sense_buffer;
1172 int verbose = qc->ap->ops->error_handler == NULL;
1174 u8 sense_key, asc, ascq;
1176 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1178 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1180 if (ata_dev_disabled(dev)) {
1181 /* Device disabled after error recovery */
1182 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
1183 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
1186 /* Use ata_to_sense_error() to map status register bits
1187 * onto sense key, asc & ascq.
1190 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1191 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1192 &sense_key, &asc, &ascq, verbose);
1193 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1195 /* Could not decode error */
1196 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
1197 tf->command, qc->err_mask);
1198 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1202 block = ata_tf_read_block(&qc->result_tf, dev);
1203 if (block == U64_MAX)
1206 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
1209 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1211 sdev->use_10_for_rw = 1;
1212 sdev->use_10_for_ms = 1;
1213 sdev->no_write_same = 1;
1215 /* Schedule policy is determined by ->qc_defer() callback and
1216 * it needs to see every deferred qc. Set dev_blocked to 1 to
1217 * prevent SCSI midlayer from automatically deferring
1220 sdev->max_device_blocked = 1;
1224 * atapi_drain_needed - Check whether data transfer may overflow
1225 * @rq: request to be checked
1227 * ATAPI commands which transfer variable length data to host
1228 * might overflow due to application error or hardware bug. This
1229 * function checks whether overflow should be drained and ignored
1236 * 1 if ; otherwise, 0.
1238 static int atapi_drain_needed(struct request *rq)
1240 if (likely(!blk_rq_is_passthrough(rq)))
1243 if (!blk_rq_bytes(rq) || op_is_write(req_op(rq)))
1246 return atapi_cmd_type(scsi_req(rq)->cmd[0]) == ATAPI_MISC;
1249 static int ata_scsi_dev_config(struct scsi_device *sdev,
1250 struct ata_device *dev)
1252 struct request_queue *q = sdev->request_queue;
1254 if (!ata_id_has_unload(dev->id))
1255 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1257 /* configure max sectors */
1258 blk_queue_max_hw_sectors(q, dev->max_sectors);
1260 if (dev->class == ATA_DEV_ATAPI) {
1263 sdev->sector_size = ATA_SECT_SIZE;
1265 /* set DMA padding */
1266 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1268 /* configure draining */
1269 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1271 ata_dev_err(dev, "drain buffer allocation failed\n");
1275 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1277 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1278 sdev->manage_start_stop = 1;
1282 * ata_pio_sectors() expects buffer for each sector to not cross
1283 * page boundary. Enforce it by requiring buffers to be sector
1284 * aligned, which works iff sector_size is not larger than
1285 * PAGE_SIZE. ATAPI devices also need the alignment as
1286 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1288 if (sdev->sector_size > PAGE_SIZE)
1290 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1293 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1295 if (dev->flags & ATA_DFLAG_AN)
1296 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1298 if (dev->flags & ATA_DFLAG_NCQ) {
1301 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1302 depth = min(ATA_MAX_QUEUE, depth);
1303 scsi_change_queue_depth(sdev, depth);
1306 if (dev->flags & ATA_DFLAG_TRUSTED)
1307 sdev->security_supported = 1;
1314 * ata_scsi_slave_config - Set SCSI device attributes
1315 * @sdev: SCSI device to examine
1317 * This is called before we actually start reading
1318 * and writing to the device, to configure certain
1319 * SCSI mid-layer behaviors.
1322 * Defined by SCSI layer. We don't really care.
1325 int ata_scsi_slave_config(struct scsi_device *sdev)
1327 struct ata_port *ap = ata_shost_to_port(sdev->host);
1328 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1331 ata_scsi_sdev_config(sdev);
1334 rc = ata_scsi_dev_config(sdev, dev);
1340 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1341 * @sdev: SCSI device to be destroyed
1343 * @sdev is about to be destroyed for hot/warm unplugging. If
1344 * this unplugging was initiated by libata as indicated by NULL
1345 * dev->sdev, this function doesn't have to do anything.
1346 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1347 * Clear dev->sdev, schedule the device for ATA detach and invoke
1351 * Defined by SCSI layer. We don't really care.
1353 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1355 struct ata_port *ap = ata_shost_to_port(sdev->host);
1356 struct request_queue *q = sdev->request_queue;
1357 unsigned long flags;
1358 struct ata_device *dev;
1360 if (!ap->ops->error_handler)
1363 spin_lock_irqsave(ap->lock, flags);
1364 dev = __ata_scsi_find_dev(ap, sdev);
1365 if (dev && dev->sdev) {
1366 /* SCSI device already in CANCEL state, no need to offline it */
1368 dev->flags |= ATA_DFLAG_DETACH;
1369 ata_port_schedule_eh(ap);
1371 spin_unlock_irqrestore(ap->lock, flags);
1373 kfree(q->dma_drain_buffer);
1374 q->dma_drain_buffer = NULL;
1375 q->dma_drain_size = 0;
1379 * __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
1380 * @ap: ATA port to which the device change the queue depth
1381 * @sdev: SCSI device to configure queue depth for
1382 * @queue_depth: new queue depth
1384 * libsas and libata have different approaches for associating a sdev to
1388 int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1391 struct ata_device *dev;
1392 unsigned long flags;
1394 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1395 return sdev->queue_depth;
1397 dev = ata_scsi_find_dev(ap, sdev);
1398 if (!dev || !ata_dev_enabled(dev))
1399 return sdev->queue_depth;
1402 spin_lock_irqsave(ap->lock, flags);
1403 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1404 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1405 dev->flags |= ATA_DFLAG_NCQ_OFF;
1408 spin_unlock_irqrestore(ap->lock, flags);
1410 /* limit and apply queue depth */
1411 queue_depth = min(queue_depth, sdev->host->can_queue);
1412 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1413 queue_depth = min(queue_depth, ATA_MAX_QUEUE);
1415 if (sdev->queue_depth == queue_depth)
1418 return scsi_change_queue_depth(sdev, queue_depth);
1422 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1423 * @sdev: SCSI device to configure queue depth for
1424 * @queue_depth: new queue depth
1426 * This is libata standard hostt->change_queue_depth callback.
1427 * SCSI will call into this callback when user tries to set queue
1431 * SCSI layer (we don't care)
1434 * Newly configured queue depth.
1436 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1438 struct ata_port *ap = ata_shost_to_port(sdev->host);
1440 return __ata_change_queue_depth(ap, sdev, queue_depth);
1444 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1445 * @qc: Storage for translated ATA taskfile
1447 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1448 * (to start). Perhaps these commands should be preceded by
1449 * CHECK POWER MODE to see what power mode the device is already in.
1450 * [See SAT revision 5 at www.t10.org]
1453 * spin_lock_irqsave(host lock)
1456 * Zero on success, non-zero on error.
1458 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1460 struct scsi_cmnd *scmd = qc->scsicmd;
1461 struct ata_taskfile *tf = &qc->tf;
1462 const u8 *cdb = scmd->cmnd;
1466 if (scmd->cmd_len < 5) {
1471 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1472 tf->protocol = ATA_PROT_NODATA;
1474 ; /* ignore IMMED bit, violates sat-r05 */
1479 goto invalid_fld; /* LOEJ bit set not supported */
1481 if (((cdb[4] >> 4) & 0xf) != 0) {
1484 goto invalid_fld; /* power conditions not supported */
1488 tf->nsect = 1; /* 1 sector, lba=0 */
1490 if (qc->dev->flags & ATA_DFLAG_LBA) {
1491 tf->flags |= ATA_TFLAG_LBA;
1496 tf->device |= ATA_LBA;
1499 tf->lbal = 0x1; /* sect */
1500 tf->lbam = 0x0; /* cyl low */
1501 tf->lbah = 0x0; /* cyl high */
1504 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1506 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1507 * or S5) causing some drives to spin up and down again.
1509 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1510 system_state == SYSTEM_POWER_OFF)
1513 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1514 system_entering_hibernation())
1517 /* Issue ATA STANDBY IMMEDIATE command */
1518 tf->command = ATA_CMD_STANDBYNOW1;
1522 * Standby and Idle condition timers could be implemented but that
1523 * would require libata to implement the Power condition mode page
1524 * and allow the user to change it. Changing mode pages requires
1525 * MODE SELECT to be implemented.
1531 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1534 scmd->result = SAM_STAT_GOOD;
1540 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1541 * @qc: Storage for translated ATA taskfile
1543 * Sets up an ATA taskfile to issue FLUSH CACHE or
1547 * spin_lock_irqsave(host lock)
1550 * Zero on success, non-zero on error.
1552 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1554 struct ata_taskfile *tf = &qc->tf;
1556 tf->flags |= ATA_TFLAG_DEVICE;
1557 tf->protocol = ATA_PROT_NODATA;
1559 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1560 tf->command = ATA_CMD_FLUSH_EXT;
1562 tf->command = ATA_CMD_FLUSH;
1564 /* flush is critical for IO integrity, consider it an IO command */
1565 qc->flags |= ATA_QCFLAG_IO;
1571 * scsi_6_lba_len - Get LBA and transfer length
1572 * @cdb: SCSI command to translate
1574 * Calculate LBA and transfer length for 6-byte commands.
1578 * @plen: the transfer length
1580 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1585 VPRINTK("six-byte command\n");
1587 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1588 lba |= ((u64)cdb[2]) << 8;
1589 lba |= ((u64)cdb[3]);
1598 * scsi_10_lba_len - Get LBA and transfer length
1599 * @cdb: SCSI command to translate
1601 * Calculate LBA and transfer length for 10-byte commands.
1605 * @plen: the transfer length
1607 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1612 VPRINTK("ten-byte command\n");
1614 lba |= ((u64)cdb[2]) << 24;
1615 lba |= ((u64)cdb[3]) << 16;
1616 lba |= ((u64)cdb[4]) << 8;
1617 lba |= ((u64)cdb[5]);
1619 len |= ((u32)cdb[7]) << 8;
1620 len |= ((u32)cdb[8]);
1627 * scsi_16_lba_len - Get LBA and transfer length
1628 * @cdb: SCSI command to translate
1630 * Calculate LBA and transfer length for 16-byte commands.
1634 * @plen: the transfer length
1636 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1641 VPRINTK("sixteen-byte command\n");
1643 lba |= ((u64)cdb[2]) << 56;
1644 lba |= ((u64)cdb[3]) << 48;
1645 lba |= ((u64)cdb[4]) << 40;
1646 lba |= ((u64)cdb[5]) << 32;
1647 lba |= ((u64)cdb[6]) << 24;
1648 lba |= ((u64)cdb[7]) << 16;
1649 lba |= ((u64)cdb[8]) << 8;
1650 lba |= ((u64)cdb[9]);
1652 len |= ((u32)cdb[10]) << 24;
1653 len |= ((u32)cdb[11]) << 16;
1654 len |= ((u32)cdb[12]) << 8;
1655 len |= ((u32)cdb[13]);
1662 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1663 * @qc: Storage for translated ATA taskfile
1665 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1668 * spin_lock_irqsave(host lock)
1671 * Zero on success, non-zero on error.
1673 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1675 struct scsi_cmnd *scmd = qc->scsicmd;
1676 struct ata_taskfile *tf = &qc->tf;
1677 struct ata_device *dev = qc->dev;
1678 u64 dev_sectors = qc->dev->n_sectors;
1679 const u8 *cdb = scmd->cmnd;
1684 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1685 tf->protocol = ATA_PROT_NODATA;
1687 if (cdb[0] == VERIFY) {
1688 if (scmd->cmd_len < 10) {
1692 scsi_10_lba_len(cdb, &block, &n_block);
1693 } else if (cdb[0] == VERIFY_16) {
1694 if (scmd->cmd_len < 16) {
1698 scsi_16_lba_len(cdb, &block, &n_block);
1706 if (block >= dev_sectors)
1708 if ((block + n_block) > dev_sectors)
1711 if (dev->flags & ATA_DFLAG_LBA) {
1712 tf->flags |= ATA_TFLAG_LBA;
1714 if (lba_28_ok(block, n_block)) {
1716 tf->command = ATA_CMD_VERIFY;
1717 tf->device |= (block >> 24) & 0xf;
1718 } else if (lba_48_ok(block, n_block)) {
1719 if (!(dev->flags & ATA_DFLAG_LBA48))
1723 tf->flags |= ATA_TFLAG_LBA48;
1724 tf->command = ATA_CMD_VERIFY_EXT;
1726 tf->hob_nsect = (n_block >> 8) & 0xff;
1728 tf->hob_lbah = (block >> 40) & 0xff;
1729 tf->hob_lbam = (block >> 32) & 0xff;
1730 tf->hob_lbal = (block >> 24) & 0xff;
1732 /* request too large even for LBA48 */
1735 tf->nsect = n_block & 0xff;
1737 tf->lbah = (block >> 16) & 0xff;
1738 tf->lbam = (block >> 8) & 0xff;
1739 tf->lbal = block & 0xff;
1741 tf->device |= ATA_LBA;
1744 u32 sect, head, cyl, track;
1746 if (!lba_28_ok(block, n_block))
1749 /* Convert LBA to CHS */
1750 track = (u32)block / dev->sectors;
1751 cyl = track / dev->heads;
1752 head = track % dev->heads;
1753 sect = (u32)block % dev->sectors + 1;
1755 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1756 (u32)block, track, cyl, head, sect);
1758 /* Check whether the converted CHS can fit.
1762 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1765 tf->command = ATA_CMD_VERIFY;
1766 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1769 tf->lbah = cyl >> 8;
1776 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1780 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1781 /* "Logical Block Address out of range" */
1785 scmd->result = SAM_STAT_GOOD;
1789 static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1791 struct request *rq = scmd->request;
1794 if (!blk_rq_is_passthrough(rq))
1797 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1798 if (n_blocks > req_blocks)
1805 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1806 * @qc: Storage for translated ATA taskfile
1808 * Converts any of six SCSI read/write commands into the
1809 * ATA counterpart, including starting sector (LBA),
1810 * sector count, and taking into account the device's LBA48
1813 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1814 * %WRITE_16 are currently supported.
1817 * spin_lock_irqsave(host lock)
1820 * Zero on success, non-zero on error.
1822 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1824 struct scsi_cmnd *scmd = qc->scsicmd;
1825 const u8 *cdb = scmd->cmnd;
1826 struct request *rq = scmd->request;
1827 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1828 unsigned int tf_flags = 0;
1834 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1835 tf_flags |= ATA_TFLAG_WRITE;
1837 /* Calculate the SCSI LBA, transfer length and FUA. */
1841 if (unlikely(scmd->cmd_len < 10)) {
1845 scsi_10_lba_len(cdb, &block, &n_block);
1846 if (cdb[1] & (1 << 3))
1847 tf_flags |= ATA_TFLAG_FUA;
1848 if (!ata_check_nblocks(scmd, n_block))
1853 if (unlikely(scmd->cmd_len < 6)) {
1857 scsi_6_lba_len(cdb, &block, &n_block);
1859 /* for 6-byte r/w commands, transfer length 0
1860 * means 256 blocks of data, not 0 block.
1864 if (!ata_check_nblocks(scmd, n_block))
1869 if (unlikely(scmd->cmd_len < 16)) {
1873 scsi_16_lba_len(cdb, &block, &n_block);
1874 if (cdb[1] & (1 << 3))
1875 tf_flags |= ATA_TFLAG_FUA;
1876 if (!ata_check_nblocks(scmd, n_block))
1880 DPRINTK("no-byte command\n");
1885 /* Check and compose ATA command */
1887 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1888 * length 0 means transfer 0 block of data.
1889 * However, for ATA R/W commands, sector count 0 means
1890 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1892 * WARNING: one or two older ATA drives treat 0 as 0...
1896 qc->flags |= ATA_QCFLAG_IO;
1897 qc->nbytes = n_block * scmd->device->sector_size;
1899 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1902 if (likely(rc == 0))
1907 /* treat all other errors as -EINVAL, fall through */
1909 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1913 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1914 /* "Logical Block Address out of range" */
1918 scmd->result = SAM_STAT_GOOD;
1922 static void ata_qc_done(struct ata_queued_cmd *qc)
1924 struct scsi_cmnd *cmd = qc->scsicmd;
1925 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1931 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1933 struct ata_port *ap = qc->ap;
1934 struct scsi_cmnd *cmd = qc->scsicmd;
1935 u8 *cdb = cmd->cmnd;
1936 int need_sense = (qc->err_mask != 0);
1938 /* For ATA pass thru (SAT) commands, generate a sense block if
1939 * user mandated it or if there's an error. Note that if we
1940 * generate because the user forced us to [CK_COND =1], a check
1941 * condition is generated and the ATA register values are returned
1942 * whether the command completed successfully or not. If there
1943 * was no error, we use the following sense data:
1944 * sk = RECOVERED ERROR
1945 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1947 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1948 ((cdb[2] & 0x20) || need_sense))
1949 ata_gen_passthru_sense(qc);
1950 else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1951 cmd->result = SAM_STAT_CHECK_CONDITION;
1952 else if (need_sense)
1953 ata_gen_ata_sense(qc);
1955 cmd->result = SAM_STAT_GOOD;
1957 if (need_sense && !ap->ops->error_handler)
1958 ata_dump_status(ap->print_id, &qc->result_tf);
1964 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1965 * @dev: ATA device to which the command is addressed
1966 * @cmd: SCSI command to execute
1967 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1969 * Our ->queuecommand() function has decided that the SCSI
1970 * command issued can be directly translated into an ATA
1971 * command, rather than handled internally.
1973 * This function sets up an ata_queued_cmd structure for the
1974 * SCSI command, and sends that ata_queued_cmd to the hardware.
1976 * The xlat_func argument (actor) returns 0 if ready to execute
1977 * ATA command, else 1 to finish translation. If 1 is returned
1978 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1979 * to be set reflecting an error condition or clean (early)
1983 * spin_lock_irqsave(host lock)
1986 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1987 * needs to be deferred.
1989 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1990 ata_xlat_func_t xlat_func)
1992 struct ata_port *ap = dev->link->ap;
1993 struct ata_queued_cmd *qc;
1998 qc = ata_scsi_qc_new(dev, cmd);
2002 /* data is present; dma-map it */
2003 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
2004 cmd->sc_data_direction == DMA_TO_DEVICE) {
2005 if (unlikely(scsi_bufflen(cmd) < 1)) {
2006 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
2010 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
2012 qc->dma_dir = cmd->sc_data_direction;
2015 qc->complete_fn = ata_scsi_qc_complete;
2020 if (ap->ops->qc_defer) {
2021 if ((rc = ap->ops->qc_defer(qc)))
2025 /* select device, send command to hardware */
2033 cmd->scsi_done(cmd);
2034 DPRINTK("EXIT - early finish (good or error)\n");
2039 cmd->result = (DID_ERROR << 16);
2040 cmd->scsi_done(cmd);
2042 DPRINTK("EXIT - internal\n");
2047 DPRINTK("EXIT - defer\n");
2048 if (rc == ATA_DEFER_LINK)
2049 return SCSI_MLQUEUE_DEVICE_BUSY;
2051 return SCSI_MLQUEUE_HOST_BUSY;
2054 struct ata_scsi_args {
2055 struct ata_device *dev;
2057 struct scsi_cmnd *cmd;
2061 * ata_scsi_rbuf_get - Map response buffer.
2062 * @cmd: SCSI command containing buffer to be mapped.
2063 * @flags: unsigned long variable to store irq enable status
2064 * @copy_in: copy in from user buffer
2066 * Prepare buffer for simulated SCSI commands.
2069 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
2072 * Pointer to response buffer.
2074 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
2075 unsigned long *flags)
2077 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
2079 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
2081 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2082 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2083 return ata_scsi_rbuf;
2087 * ata_scsi_rbuf_put - Unmap response buffer.
2088 * @cmd: SCSI command containing buffer to be unmapped.
2089 * @copy_out: copy out result
2090 * @flags: @flags passed to ata_scsi_rbuf_get()
2092 * Returns rbuf buffer. The result is copied to @cmd's buffer if
2093 * @copy_back is true.
2096 * Unlocks ata_scsi_rbuf_lock.
2098 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
2099 unsigned long *flags)
2102 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2103 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2104 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
2108 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
2109 * @args: device IDENTIFY data / SCSI command of interest.
2110 * @actor: Callback hook for desired SCSI command simulator
2112 * Takes care of the hard work of simulating a SCSI command...
2113 * Mapping the response buffer, calling the command's handler,
2114 * and handling the handler's return value. This return value
2115 * indicates whether the handler wishes the SCSI command to be
2116 * completed successfully (0), or not (in which case cmd->result
2117 * and sense buffer are assumed to be set).
2120 * spin_lock_irqsave(host lock)
2122 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
2123 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
2127 struct scsi_cmnd *cmd = args->cmd;
2128 unsigned long flags;
2130 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
2131 rc = actor(args, rbuf);
2132 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
2135 cmd->result = SAM_STAT_GOOD;
2139 * ata_scsiop_inq_std - Simulate INQUIRY command
2140 * @args: device IDENTIFY data / SCSI command of interest.
2141 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2143 * Returns standard device identification data associated
2144 * with non-VPD INQUIRY command output.
2147 * spin_lock_irqsave(host lock)
2149 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
2151 static const u8 versions[] = {
2153 0x60, /* SAM-3 (no version claimed) */
2156 0x20, /* SBC-2 (no version claimed) */
2159 0x00 /* SPC-3 (no version claimed) */
2161 static const u8 versions_zbc[] = {
2163 0xA0, /* SAM-5 (no version claimed) */
2166 0x00, /* SBC-4 (no version claimed) */
2169 0xC0, /* SPC-5 (no version claimed) */
2178 0x5, /* claim SPC-3 version compatibility */
2188 /* set scsi removable (RMB) bit per ata bit, or if the
2189 * AHCI port says it's external (Hotplug-capable, eSATA).
2191 if (ata_id_removable(args->id) ||
2192 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
2195 if (args->dev->class == ATA_DEV_ZAC) {
2197 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
2200 memcpy(rbuf, hdr, sizeof(hdr));
2201 memcpy(&rbuf[8], "ATA ", 8);
2202 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
2204 /* From SAT, use last 2 words from fw rev unless they are spaces */
2205 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2206 if (strncmp(&rbuf[32], " ", 4) == 0)
2207 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2209 if (rbuf[32] == 0 || rbuf[32] == ' ')
2210 memcpy(&rbuf[32], "n/a ", 4);
2212 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
2213 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2215 memcpy(rbuf + 58, versions, sizeof(versions));
2221 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2222 * @args: device IDENTIFY data / SCSI command of interest.
2223 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2225 * Returns list of inquiry VPD pages available.
2228 * spin_lock_irqsave(host lock)
2230 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2233 static const u8 pages[] = {
2234 0x00, /* page 0x00, this page */
2235 0x80, /* page 0x80, unit serial no page */
2236 0x83, /* page 0x83, device ident page */
2237 0x89, /* page 0x89, ata info page */
2238 0xb0, /* page 0xb0, block limits page */
2239 0xb1, /* page 0xb1, block device characteristics page */
2240 0xb2, /* page 0xb2, thin provisioning page */
2241 0xb6, /* page 0xb6, zoned block device characteristics */
2244 num_pages = sizeof(pages);
2245 if (!(args->dev->flags & ATA_DFLAG_ZAC))
2247 rbuf[3] = num_pages; /* number of supported VPD pages */
2248 memcpy(rbuf + 4, pages, num_pages);
2253 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2254 * @args: device IDENTIFY data / SCSI command of interest.
2255 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2257 * Returns ATA device serial number.
2260 * spin_lock_irqsave(host lock)
2262 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2264 static const u8 hdr[] = {
2266 0x80, /* this page code */
2268 ATA_ID_SERNO_LEN, /* page len */
2271 memcpy(rbuf, hdr, sizeof(hdr));
2272 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2273 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2278 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2279 * @args: device IDENTIFY data / SCSI command of interest.
2280 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2282 * Yields two logical unit device identification designators:
2283 * - vendor specific ASCII containing the ATA serial number
2284 * - SAT defined "t10 vendor id based" containing ASCII vendor
2285 * name ("ATA "), model and serial numbers.
2288 * spin_lock_irqsave(host lock)
2290 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2292 const int sat_model_serial_desc_len = 68;
2295 rbuf[1] = 0x83; /* this page code */
2298 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2300 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2302 ata_id_string(args->id, (unsigned char *) rbuf + num,
2303 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2304 num += ATA_ID_SERNO_LEN;
2306 /* SAT defined lu model and serial numbers descriptor */
2307 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2310 rbuf[num + 3] = sat_model_serial_desc_len;
2312 memcpy(rbuf + num, "ATA ", 8);
2314 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2316 num += ATA_ID_PROD_LEN;
2317 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2319 num += ATA_ID_SERNO_LEN;
2321 if (ata_id_has_wwn(args->id)) {
2322 /* SAT defined lu world wide name */
2323 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2326 rbuf[num + 3] = ATA_ID_WWN_LEN;
2328 ata_id_string(args->id, (unsigned char *) rbuf + num,
2329 ATA_ID_WWN, ATA_ID_WWN_LEN);
2330 num += ATA_ID_WWN_LEN;
2332 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2337 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2338 * @args: device IDENTIFY data / SCSI command of interest.
2339 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2341 * Yields SAT-specified ATA VPD page.
2344 * spin_lock_irqsave(host lock)
2346 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2348 struct ata_taskfile tf;
2350 memset(&tf, 0, sizeof(tf));
2352 rbuf[1] = 0x89; /* our page code */
2353 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2354 rbuf[3] = (0x238 & 0xff);
2356 memcpy(&rbuf[8], "linux ", 8);
2357 memcpy(&rbuf[16], "libata ", 16);
2358 memcpy(&rbuf[32], DRV_VERSION, 4);
2360 /* we don't store the ATA device signature, so we fake it */
2362 tf.command = ATA_DRDY; /* really, this is Status reg */
2366 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2367 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2369 rbuf[56] = ATA_CMD_ID_ATA;
2371 memcpy(&rbuf[60], &args->id[0], 512);
2375 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2377 struct ata_device *dev = args->dev;
2381 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2384 * Optimal transfer length granularity.
2386 * This is always one physical block, but for disks with a smaller
2387 * logical than physical sector size we need to figure out what the
2390 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2391 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2394 * Optimal unmap granularity.
2396 * The ATA spec doesn't even know about a granularity or alignment
2397 * for the TRIM command. We can leave away most of the unmap related
2398 * VPD page entries, but we have specifify a granularity to signal
2399 * that we support some form of unmap - in thise case via WRITE SAME
2400 * with the unmap bit set.
2402 if (ata_id_has_trim(args->id)) {
2403 u64 max_blocks = 65535 * ATA_MAX_TRIM_RNUM;
2405 if (dev->horkage & ATA_HORKAGE_MAX_TRIM_128M)
2406 max_blocks = 128 << (20 - SECTOR_SHIFT);
2408 put_unaligned_be64(max_blocks, &rbuf[36]);
2409 put_unaligned_be32(1, &rbuf[28]);
2415 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2417 int form_factor = ata_id_form_factor(args->id);
2418 int media_rotation_rate = ata_id_rotation_rate(args->id);
2419 u8 zoned = ata_id_zoned_cap(args->id);
2423 rbuf[4] = media_rotation_rate >> 8;
2424 rbuf[5] = media_rotation_rate;
2425 rbuf[7] = form_factor;
2427 rbuf[8] = (zoned << 4);
2432 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2434 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2437 rbuf[5] = 1 << 6; /* TPWS */
2442 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2445 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2451 * URSWRZ bit is only meaningful for host-managed ZAC drives
2453 if (args->dev->zac_zoned_cap & 1)
2455 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2456 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2457 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2463 * modecpy - Prepare response for MODE SENSE
2464 * @dest: output buffer
2465 * @src: data being copied
2466 * @n: length of mode page
2467 * @changeable: whether changeable parameters are requested
2469 * Generate a generic MODE SENSE page for either current or changeable
2475 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2478 memcpy(dest, src, 2);
2479 memset(dest + 2, 0, n - 2);
2481 memcpy(dest, src, n);
2486 * ata_msense_caching - Simulate MODE SENSE caching info page
2487 * @id: device IDENTIFY data
2488 * @buf: output buffer
2489 * @changeable: whether changeable parameters are requested
2491 * Generate a caching info page, which conditionally indicates
2492 * write caching to the SCSI layer, depending on device
2498 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2500 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2502 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2504 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2505 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2507 return sizeof(def_cache_mpage);
2511 * ata_msense_control - Simulate MODE SENSE control mode page
2512 * @dev: ATA device of interest
2513 * @buf: output buffer
2514 * @changeable: whether changeable parameters are requested
2516 * Generate a generic MODE SENSE control mode page.
2521 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2524 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2526 buf[2] |= (1 << 2); /* ata_mselect_control() */
2528 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2530 buf[2] |= (d_sense << 2); /* descriptor format sense data */
2532 return sizeof(def_control_mpage);
2536 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2537 * @buf: output buffer
2538 * @changeable: whether changeable parameters are requested
2540 * Generate a generic MODE SENSE r/w error recovery page.
2545 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2547 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2549 return sizeof(def_rw_recovery_mpage);
2553 * We can turn this into a real blacklist if it's needed, for now just
2554 * blacklist any Maxtor BANC1G10 revision firmware
2556 static int ata_dev_supports_fua(u16 *id)
2558 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2562 if (!ata_id_has_fua(id))
2565 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2566 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2568 if (strcmp(model, "Maxtor"))
2570 if (strcmp(fw, "BANC1G10"))
2573 return 0; /* blacklisted */
2577 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2578 * @args: device IDENTIFY data / SCSI command of interest.
2579 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2581 * Simulate MODE SENSE commands. Assume this is invoked for direct
2582 * access devices (e.g. disks) only. There should be no block
2583 * descriptor for other device types.
2586 * spin_lock_irqsave(host lock)
2588 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2590 struct ata_device *dev = args->dev;
2591 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2592 static const u8 sat_blk_desc[] = {
2593 0, 0, 0, 0, /* number of blocks: sat unspecified */
2595 0, 0x2, 0x0 /* block length: 512 bytes */
2598 unsigned int ebd, page_control, six_byte;
2599 u8 dpofua, bp = 0xff;
2604 six_byte = (scsicmd[0] == MODE_SENSE);
2605 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2607 * LLBA bit in msense(10) ignored (compliant)
2610 page_control = scsicmd[2] >> 6;
2611 switch (page_control) {
2612 case 0: /* current */
2613 case 1: /* changeable */
2614 case 2: /* defaults */
2615 break; /* supported */
2617 goto saving_not_supp;
2625 p += 4 + (ebd ? 8 : 0);
2627 p += 8 + (ebd ? 8 : 0);
2629 pg = scsicmd[2] & 0x3f;
2632 * No mode subpages supported (yet) but asking for _all_
2633 * subpages may be valid
2635 if (spg && (spg != ALL_SUB_MPAGES)) {
2641 case RW_RECOVERY_MPAGE:
2642 p += ata_msense_rw_recovery(p, page_control == 1);
2646 p += ata_msense_caching(args->id, p, page_control == 1);
2650 p += ata_msense_control(args->dev, p, page_control == 1);
2654 p += ata_msense_rw_recovery(p, page_control == 1);
2655 p += ata_msense_caching(args->id, p, page_control == 1);
2656 p += ata_msense_control(args->dev, p, page_control == 1);
2659 default: /* invalid page code */
2665 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2666 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2670 rbuf[0] = p - rbuf - 1;
2673 rbuf[3] = sizeof(sat_blk_desc);
2674 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2677 unsigned int output_len = p - rbuf - 2;
2679 rbuf[0] = output_len >> 8;
2680 rbuf[1] = output_len;
2683 rbuf[7] = sizeof(sat_blk_desc);
2684 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2690 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2694 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2695 /* "Saving parameters not supported" */
2700 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2701 * @args: device IDENTIFY data / SCSI command of interest.
2702 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2704 * Simulate READ CAPACITY commands.
2709 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2711 struct ata_device *dev = args->dev;
2712 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2713 u32 sector_size; /* physical sector size in bytes */
2717 sector_size = ata_id_logical_sector_size(dev->id);
2718 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2719 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2723 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2724 if (last_lba >= 0xffffffffULL)
2725 last_lba = 0xffffffff;
2727 /* sector count, 32-bit */
2728 rbuf[0] = last_lba >> (8 * 3);
2729 rbuf[1] = last_lba >> (8 * 2);
2730 rbuf[2] = last_lba >> (8 * 1);
2734 rbuf[4] = sector_size >> (8 * 3);
2735 rbuf[5] = sector_size >> (8 * 2);
2736 rbuf[6] = sector_size >> (8 * 1);
2737 rbuf[7] = sector_size;
2739 /* sector count, 64-bit */
2740 rbuf[0] = last_lba >> (8 * 7);
2741 rbuf[1] = last_lba >> (8 * 6);
2742 rbuf[2] = last_lba >> (8 * 5);
2743 rbuf[3] = last_lba >> (8 * 4);
2744 rbuf[4] = last_lba >> (8 * 3);
2745 rbuf[5] = last_lba >> (8 * 2);
2746 rbuf[6] = last_lba >> (8 * 1);
2750 rbuf[ 8] = sector_size >> (8 * 3);
2751 rbuf[ 9] = sector_size >> (8 * 2);
2752 rbuf[10] = sector_size >> (8 * 1);
2753 rbuf[11] = sector_size;
2756 rbuf[13] = log2_per_phys;
2757 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2758 rbuf[15] = lowest_aligned;
2760 if (ata_id_has_trim(args->id) &&
2761 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2762 rbuf[14] |= 0x80; /* LBPME */
2764 if (ata_id_has_zero_after_trim(args->id) &&
2765 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2766 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2767 rbuf[14] |= 0x40; /* LBPRZ */
2770 if (ata_id_zoned_cap(args->id) ||
2771 args->dev->class == ATA_DEV_ZAC)
2772 rbuf[12] = (1 << 4); /* RC_BASIS */
2778 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2779 * @args: device IDENTIFY data / SCSI command of interest.
2780 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2782 * Simulate REPORT LUNS command.
2785 * spin_lock_irqsave(host lock)
2787 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2790 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2795 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2797 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2798 /* FIXME: not quite right; we don't want the
2799 * translation of taskfile registers into
2800 * a sense descriptors, since that's only
2801 * correct for ATA, not ATAPI
2803 ata_gen_passthru_sense(qc);
2809 /* is it pointless to prefer PIO for "safety reasons"? */
2810 static inline int ata_pio_use_silly(struct ata_port *ap)
2812 return (ap->flags & ATA_FLAG_PIO_DMA);
2815 static void atapi_request_sense(struct ata_queued_cmd *qc)
2817 struct ata_port *ap = qc->ap;
2818 struct scsi_cmnd *cmd = qc->scsicmd;
2820 DPRINTK("ATAPI request sense\n");
2822 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2824 #ifdef CONFIG_ATA_SFF
2825 if (ap->ops->sff_tf_read)
2826 ap->ops->sff_tf_read(ap, &qc->tf);
2829 /* fill these in, for the case where they are -not- overwritten */
2830 cmd->sense_buffer[0] = 0x70;
2831 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2835 /* setup sg table and init transfer direction */
2836 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2837 ata_sg_init(qc, &qc->sgent, 1);
2838 qc->dma_dir = DMA_FROM_DEVICE;
2840 memset(&qc->cdb, 0, qc->dev->cdb_len);
2841 qc->cdb[0] = REQUEST_SENSE;
2842 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2844 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2845 qc->tf.command = ATA_CMD_PACKET;
2847 if (ata_pio_use_silly(ap)) {
2848 qc->tf.protocol = ATAPI_PROT_DMA;
2849 qc->tf.feature |= ATAPI_PKT_DMA;
2851 qc->tf.protocol = ATAPI_PROT_PIO;
2852 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2855 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2857 qc->complete_fn = atapi_sense_complete;
2865 * ATAPI devices typically report zero for their SCSI version, and sometimes
2866 * deviate from the spec WRT response data format. If SCSI version is
2867 * reported as zero like normal, then we make the following fixups:
2868 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2870 * 2) Ensure response data format / ATAPI information are always correct.
2872 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2876 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2881 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2884 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2886 struct scsi_cmnd *cmd = qc->scsicmd;
2887 unsigned int err_mask = qc->err_mask;
2889 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2891 /* handle completion from new EH */
2892 if (unlikely(qc->ap->ops->error_handler &&
2893 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2895 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2896 /* FIXME: not quite right; we don't want the
2897 * translation of taskfile registers into a
2898 * sense descriptors, since that's only
2899 * correct for ATA, not ATAPI
2901 ata_gen_passthru_sense(qc);
2904 /* SCSI EH automatically locks door if sdev->locked is
2905 * set. Sometimes door lock request continues to
2906 * fail, for example, when no media is present. This
2907 * creates a loop - SCSI EH issues door lock which
2908 * fails and gets invoked again to acquire sense data
2909 * for the failed command.
2911 * If door lock fails, always clear sdev->locked to
2912 * avoid this infinite loop.
2914 * This may happen before SCSI scan is complete. Make
2915 * sure qc->dev->sdev isn't NULL before dereferencing.
2917 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2918 qc->dev->sdev->locked = 0;
2920 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2925 /* successful completion or old EH failure path */
2926 if (unlikely(err_mask & AC_ERR_DEV)) {
2927 cmd->result = SAM_STAT_CHECK_CONDITION;
2928 atapi_request_sense(qc);
2930 } else if (unlikely(err_mask)) {
2931 /* FIXME: not quite right; we don't want the
2932 * translation of taskfile registers into
2933 * a sense descriptors, since that's only
2934 * correct for ATA, not ATAPI
2936 ata_gen_passthru_sense(qc);
2938 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2939 atapi_fixup_inquiry(cmd);
2940 cmd->result = SAM_STAT_GOOD;
2946 * atapi_xlat - Initialize PACKET taskfile
2947 * @qc: command structure to be initialized
2950 * spin_lock_irqsave(host lock)
2953 * Zero on success, non-zero on failure.
2955 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2957 struct scsi_cmnd *scmd = qc->scsicmd;
2958 struct ata_device *dev = qc->dev;
2959 int nodata = (scmd->sc_data_direction == DMA_NONE);
2960 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2961 unsigned int nbytes;
2963 memset(qc->cdb, 0, dev->cdb_len);
2964 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2966 qc->complete_fn = atapi_qc_complete;
2968 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2969 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2970 qc->tf.flags |= ATA_TFLAG_WRITE;
2971 DPRINTK("direction: write\n");
2974 qc->tf.command = ATA_CMD_PACKET;
2975 ata_qc_set_pc_nbytes(qc);
2977 /* check whether ATAPI DMA is safe */
2978 if (!nodata && !using_pio && atapi_check_dma(qc))
2981 /* Some controller variants snoop this value for Packet
2982 * transfers to do state machine and FIFO management. Thus we
2983 * want to set it properly, and for DMA where it is
2984 * effectively meaningless.
2986 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2988 /* Most ATAPI devices which honor transfer chunk size don't
2989 * behave according to the spec when odd chunk size which
2990 * matches the transfer length is specified. If the number of
2991 * bytes to transfer is 2n+1. According to the spec, what
2992 * should happen is to indicate that 2n+1 is going to be
2993 * transferred and transfer 2n+2 bytes where the last byte is
2996 * In practice, this doesn't happen. ATAPI devices first
2997 * indicate and transfer 2n bytes and then indicate and
2998 * transfer 2 bytes where the last byte is padding.
3000 * This inconsistency confuses several controllers which
3001 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
3002 * These controllers use actual number of transferred bytes to
3003 * update DMA pointer and transfer of 4n+2 bytes make those
3004 * controller push DMA pointer by 4n+4 bytes because SATA data
3005 * FISes are aligned to 4 bytes. This causes data corruption
3006 * and buffer overrun.
3008 * Always setting nbytes to even number solves this problem
3009 * because then ATAPI devices don't have to split data at 2n
3015 qc->tf.lbam = (nbytes & 0xFF);
3016 qc->tf.lbah = (nbytes >> 8);
3019 qc->tf.protocol = ATAPI_PROT_NODATA;
3021 qc->tf.protocol = ATAPI_PROT_PIO;
3024 qc->tf.protocol = ATAPI_PROT_DMA;
3025 qc->tf.feature |= ATAPI_PKT_DMA;
3027 if ((dev->flags & ATA_DFLAG_DMADIR) &&
3028 (scmd->sc_data_direction != DMA_TO_DEVICE))
3029 /* some SATA bridges need us to indicate data xfer direction */
3030 qc->tf.feature |= ATAPI_DMADIR;
3034 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
3035 as ATAPI tape drives don't get this right otherwise */
3039 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
3041 if (!sata_pmp_attached(ap)) {
3042 if (likely(devno >= 0 &&
3043 devno < ata_link_max_devices(&ap->link)))
3044 return &ap->link.device[devno];
3046 if (likely(devno >= 0 &&
3047 devno < ap->nr_pmp_links))
3048 return &ap->pmp_link[devno].device[0];
3054 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
3055 const struct scsi_device *scsidev)
3059 /* skip commands not addressed to targets we simulate */
3060 if (!sata_pmp_attached(ap)) {
3061 if (unlikely(scsidev->channel || scsidev->lun))
3063 devno = scsidev->id;
3065 if (unlikely(scsidev->id || scsidev->lun))
3067 devno = scsidev->channel;
3070 return ata_find_dev(ap, devno);
3074 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
3075 * @ap: ATA port to which the device is attached
3076 * @scsidev: SCSI device from which we derive the ATA device
3078 * Given various information provided in struct scsi_cmnd,
3079 * map that onto an ATA bus, and using that mapping
3080 * determine which ata_device is associated with the
3081 * SCSI command to be sent.
3084 * spin_lock_irqsave(host lock)
3087 * Associated ATA device, or %NULL if not found.
3089 static struct ata_device *
3090 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
3092 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
3094 if (unlikely(!dev || !ata_dev_enabled(dev)))
3101 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
3102 * @byte1: Byte 1 from pass-thru CDB.
3105 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
3108 ata_scsi_map_proto(u8 byte1)
3110 switch((byte1 & 0x1e) >> 1) {
3111 case 3: /* Non-data */
3112 return ATA_PROT_NODATA;
3115 case 10: /* UDMA Data-in */
3116 case 11: /* UDMA Data-Out */
3117 return ATA_PROT_DMA;
3119 case 4: /* PIO Data-in */
3120 case 5: /* PIO Data-out */
3121 return ATA_PROT_PIO;
3123 case 12: /* FPDMA */
3124 return ATA_PROT_NCQ;
3126 case 0: /* Hard Reset */
3128 case 8: /* Device Diagnostic */
3129 case 9: /* Device Reset */
3130 case 7: /* DMA Queued */
3131 case 15: /* Return Response Info */
3132 default: /* Reserved */
3136 return ATA_PROT_UNKNOWN;
3140 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
3141 * @qc: command structure to be initialized
3143 * Handles either 12, 16, or 32-byte versions of the CDB.
3146 * Zero on success, non-zero on failure.
3148 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
3150 struct ata_taskfile *tf = &(qc->tf);
3151 struct scsi_cmnd *scmd = qc->scsicmd;
3152 struct ata_device *dev = qc->dev;
3153 const u8 *cdb = scmd->cmnd;
3157 /* 7Fh variable length cmd means a ata pass-thru(32) */
3158 if (cdb[0] == VARIABLE_LENGTH_CMD)
3161 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
3162 if (tf->protocol == ATA_PROT_UNKNOWN) {
3167 if ((cdb[2 + cdb_offset] & 0x3) == 0) {
3169 * When T_LENGTH is zero (No data is transferred), dir should
3172 if (scmd->sc_data_direction != DMA_NONE) {
3173 fp = 2 + cdb_offset;
3177 if (ata_is_ncq(tf->protocol))
3178 tf->protocol = ATA_PROT_NCQ_NODATA;
3182 tf->flags |= ATA_TFLAG_LBA;
3185 * 12 and 16 byte CDBs use different offsets to
3186 * provide the various register values.
3188 if (cdb[0] == ATA_16) {
3190 * 16-byte CDB - may contain extended commands.
3192 * If that is the case, copy the upper byte register values.
3194 if (cdb[1] & 0x01) {
3195 tf->hob_feature = cdb[3];
3196 tf->hob_nsect = cdb[5];
3197 tf->hob_lbal = cdb[7];
3198 tf->hob_lbam = cdb[9];
3199 tf->hob_lbah = cdb[11];
3200 tf->flags |= ATA_TFLAG_LBA48;
3202 tf->flags &= ~ATA_TFLAG_LBA48;
3205 * Always copy low byte, device and command registers.
3207 tf->feature = cdb[4];
3212 tf->device = cdb[13];
3213 tf->command = cdb[14];
3214 } else if (cdb[0] == ATA_12) {
3216 * 12-byte CDB - incapable of extended commands.
3218 tf->flags &= ~ATA_TFLAG_LBA48;
3220 tf->feature = cdb[3];
3225 tf->device = cdb[8];
3226 tf->command = cdb[9];
3229 * 32-byte CDB - may contain extended command fields.
3231 * If that is the case, copy the upper byte register values.
3233 if (cdb[10] & 0x01) {
3234 tf->hob_feature = cdb[20];
3235 tf->hob_nsect = cdb[22];
3236 tf->hob_lbal = cdb[16];
3237 tf->hob_lbam = cdb[15];
3238 tf->hob_lbah = cdb[14];
3239 tf->flags |= ATA_TFLAG_LBA48;
3241 tf->flags &= ~ATA_TFLAG_LBA48;
3243 tf->feature = cdb[21];
3244 tf->nsect = cdb[23];
3248 tf->device = cdb[24];
3249 tf->command = cdb[25];
3250 tf->auxiliary = get_unaligned_be32(&cdb[28]);
3253 /* For NCQ commands copy the tag value */
3254 if (ata_is_ncq(tf->protocol))
3255 tf->nsect = qc->hw_tag << 3;
3257 /* enforce correct master/slave bit */
3258 tf->device = dev->devno ?
3259 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3261 switch (tf->command) {
3262 /* READ/WRITE LONG use a non-standard sect_size */
3263 case ATA_CMD_READ_LONG:
3264 case ATA_CMD_READ_LONG_ONCE:
3265 case ATA_CMD_WRITE_LONG:
3266 case ATA_CMD_WRITE_LONG_ONCE:
3267 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3271 qc->sect_size = scsi_bufflen(scmd);
3274 /* commands using reported Logical Block size (e.g. 512 or 4K) */
3275 case ATA_CMD_CFA_WRITE_NE:
3276 case ATA_CMD_CFA_TRANS_SECT:
3277 case ATA_CMD_CFA_WRITE_MULT_NE:
3278 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3280 case ATA_CMD_READ_EXT:
3281 case ATA_CMD_READ_QUEUED:
3282 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3283 case ATA_CMD_FPDMA_READ:
3284 case ATA_CMD_READ_MULTI:
3285 case ATA_CMD_READ_MULTI_EXT:
3286 case ATA_CMD_PIO_READ:
3287 case ATA_CMD_PIO_READ_EXT:
3288 case ATA_CMD_READ_STREAM_DMA_EXT:
3289 case ATA_CMD_READ_STREAM_EXT:
3290 case ATA_CMD_VERIFY:
3291 case ATA_CMD_VERIFY_EXT:
3293 case ATA_CMD_WRITE_EXT:
3294 case ATA_CMD_WRITE_FUA_EXT:
3295 case ATA_CMD_WRITE_QUEUED:
3296 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3297 case ATA_CMD_FPDMA_WRITE:
3298 case ATA_CMD_WRITE_MULTI:
3299 case ATA_CMD_WRITE_MULTI_EXT:
3300 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3301 case ATA_CMD_PIO_WRITE:
3302 case ATA_CMD_PIO_WRITE_EXT:
3303 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3304 case ATA_CMD_WRITE_STREAM_EXT:
3305 qc->sect_size = scmd->device->sector_size;
3308 /* Everything else uses 512 byte "sectors" */
3310 qc->sect_size = ATA_SECT_SIZE;
3314 * Set flags so that all registers will be written, pass on
3315 * write indication (used for PIO/DMA setup), result TF is
3316 * copied back and we don't whine too much about its failure.
3318 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3319 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3320 tf->flags |= ATA_TFLAG_WRITE;
3322 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3325 * Set transfer length.
3327 * TODO: find out if we need to do more here to
3328 * cover scatter/gather case.
3330 ata_qc_set_pc_nbytes(qc);
3332 /* We may not issue DMA commands if no DMA mode is set */
3333 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3338 /* We may not issue NCQ commands to devices not supporting NCQ */
3339 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3344 /* sanity check for pio multi commands */
3345 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3350 if (is_multi_taskfile(tf)) {
3351 unsigned int multi_count = 1 << (cdb[1] >> 5);
3353 /* compare the passed through multi_count
3354 * with the cached multi_count of libata
3356 if (multi_count != dev->multi_count)
3357 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3362 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3363 * SET_FEATURES - XFER MODE must be preceded/succeeded
3364 * by an update to hardware-specific registers for each
3365 * controller (i.e. the reason for ->set_piomode(),
3366 * ->set_dmamode(), and ->post_set_mode() hooks).
3368 if (tf->command == ATA_CMD_SET_FEATURES &&
3369 tf->feature == SETFEATURES_XFER) {
3370 fp = (cdb[0] == ATA_16) ? 4 : 3;
3375 * Filter TPM commands by default. These provide an
3376 * essentially uncontrolled encrypted "back door" between
3377 * applications and the disk. Set libata.allow_tpm=1 if you
3378 * have a real reason for wanting to use them. This ensures
3379 * that installed software cannot easily mess stuff up without
3380 * user intent. DVR type users will probably ship with this enabled
3381 * for movie content management.
3383 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3384 * for this and should do in future but that it is not sufficient as
3385 * DCS is an optional feature set. Thus we also do the software filter
3386 * so that we comply with the TC consortium stated goal that the user
3387 * can turn off TC features of their system.
3389 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3390 fp = (cdb[0] == ATA_16) ? 14 : 9;
3397 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3402 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3403 * @cmd: SCSI command being translated
3404 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3405 * @sector: Starting sector
3406 * @count: Total Range of request in logical sectors
3408 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3411 * Upto 64 entries of the format:
3412 * 63:48 Range Length
3415 * Range Length of 0 is ignored.
3416 * LBA's should be sorted order and not overlap.
3418 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3420 * Return: Number of bytes copied into sglist.
3422 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3423 u64 sector, u32 count)
3425 struct scsi_device *sdp = cmd->device;
3426 size_t len = sdp->sector_size;
3430 unsigned long flags;
3432 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3434 if (len > ATA_SCSI_RBUF_SIZE)
3435 len = ATA_SCSI_RBUF_SIZE;
3437 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3438 buf = ((void *)ata_scsi_rbuf);
3439 memset(buf, 0, len);
3441 u64 entry = sector |
3442 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3443 buf[i++] = __cpu_to_le64(entry);
3444 if (count <= 0xffff)
3449 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3450 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3456 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3457 * @qc: Command to be translated
3459 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3460 * an SCT Write Same command.
3461 * Based on WRITE SAME has the UNMAP flag:
3463 * - When set translate to DSM TRIM
3464 * - When clear translate to SCT Write Same
3466 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3468 struct ata_taskfile *tf = &qc->tf;
3469 struct scsi_cmnd *scmd = qc->scsicmd;
3470 struct scsi_device *sdp = scmd->device;
3471 size_t len = sdp->sector_size;
3472 struct ata_device *dev = qc->dev;
3473 const u8 *cdb = scmd->cmnd;
3476 const u32 trmax = len >> 3;
3480 u8 unmap = cdb[1] & 0x8;
3482 /* we may not issue DMA commands if no DMA mode is set */
3483 if (unlikely(!dev->dma_mode))
3484 goto invalid_opcode;
3487 * We only allow sending this command through the block layer,
3488 * as it modifies the DATA OUT buffer, which would corrupt user
3489 * memory for SG_IO commands.
3491 if (unlikely(blk_rq_is_passthrough(scmd->request)))
3492 goto invalid_opcode;
3494 if (unlikely(scmd->cmd_len < 16)) {
3498 scsi_16_lba_len(cdb, &block, &n_block);
3501 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3502 !ata_id_has_trim(dev->id)) {
3507 /* If the request is too large the cmd is invalid */
3508 if (n_block > 0xffff * trmax) {
3514 * WRITE SAME always has a sector sized buffer as payload, this
3515 * should never be a multiple entry S/G list.
3517 if (!scsi_sg_count(scmd))
3518 goto invalid_param_len;
3521 * size must match sector size in bytes
3522 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3523 * is defined as number of 512 byte blocks to be transferred.
3526 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3528 goto invalid_param_len;
3530 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3531 /* Newer devices support queued TRIM commands */
3532 tf->protocol = ATA_PROT_NCQ;
3533 tf->command = ATA_CMD_FPDMA_SEND;
3534 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3535 tf->nsect = qc->hw_tag << 3;
3536 tf->hob_feature = (size / 512) >> 8;
3537 tf->feature = size / 512;
3541 tf->protocol = ATA_PROT_DMA;
3542 tf->hob_feature = 0;
3543 tf->feature = ATA_DSM_TRIM;
3544 tf->hob_nsect = (size / 512) >> 8;
3545 tf->nsect = size / 512;
3546 tf->command = ATA_CMD_DSM;
3549 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3552 ata_qc_set_pc_nbytes(qc);
3557 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3560 /* "Parameter list length error" */
3561 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3564 /* "Invalid command operation code" */
3565 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3570 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3571 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3572 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3574 * Yields a subset to satisfy scsi_report_opcode()
3577 * spin_lock_irqsave(host lock)
3579 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3581 struct ata_device *dev = args->dev;
3582 u8 *cdb = args->cmd->cmnd;
3584 unsigned int err = 0;
3587 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3596 case SERVICE_ACTION_IN_16:
3599 case SYNCHRONIZE_CACHE:
3603 case TEST_UNIT_READY:
3604 case SEND_DIAGNOSTIC:
3605 case MAINTENANCE_IN:
3617 case MODE_SELECT_10:
3623 if (ata_id_zoned_cap(dev->id) ||
3624 dev->class == ATA_DEV_ZAC)
3627 case SECURITY_PROTOCOL_IN:
3628 case SECURITY_PROTOCOL_OUT:
3629 if (dev->flags & ATA_DFLAG_TRUSTED)
3636 rbuf[1] = supported; /* supported */
3641 * ata_scsi_report_zones_complete - convert ATA output
3642 * @qc: command structure returning the data
3644 * Convert T-13 little-endian field representation into
3645 * T-10 big-endian field representation.
3648 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3650 struct scsi_cmnd *scmd = qc->scsicmd;
3651 struct sg_mapping_iter miter;
3652 unsigned long flags;
3653 unsigned int bytes = 0;
3655 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3656 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3658 local_irq_save(flags);
3659 while (sg_miter_next(&miter)) {
3660 unsigned int offset = 0;
3665 u64 max_lba, opt_lba;
3668 /* Swizzle header */
3670 list_length = get_unaligned_le32(&hdr[0]);
3671 same = get_unaligned_le16(&hdr[4]);
3672 max_lba = get_unaligned_le64(&hdr[8]);
3673 opt_lba = get_unaligned_le64(&hdr[16]);
3674 put_unaligned_be32(list_length, &hdr[0]);
3675 hdr[4] = same & 0xf;
3676 put_unaligned_be64(max_lba, &hdr[8]);
3677 put_unaligned_be64(opt_lba, &hdr[16]);
3681 while (offset < miter.length) {
3683 u8 cond, type, non_seq, reset;
3684 u64 size, start, wp;
3686 /* Swizzle zone descriptor */
3687 rec = miter.addr + offset;
3688 type = rec[0] & 0xf;
3689 cond = (rec[1] >> 4) & 0xf;
3690 non_seq = (rec[1] & 2);
3691 reset = (rec[1] & 1);
3692 size = get_unaligned_le64(&rec[8]);
3693 start = get_unaligned_le64(&rec[16]);
3694 wp = get_unaligned_le64(&rec[24]);
3696 rec[1] = (cond << 4) | non_seq | reset;
3697 put_unaligned_be64(size, &rec[8]);
3698 put_unaligned_be64(start, &rec[16]);
3699 put_unaligned_be64(wp, &rec[24]);
3700 WARN_ON(offset + 64 > miter.length);
3705 sg_miter_stop(&miter);
3706 local_irq_restore(flags);
3708 ata_scsi_qc_complete(qc);
3711 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3713 struct ata_taskfile *tf = &qc->tf;
3714 struct scsi_cmnd *scmd = qc->scsicmd;
3715 const u8 *cdb = scmd->cmnd;
3716 u16 sect, fp = (u16)-1;
3717 u8 sa, options, bp = 0xff;
3721 if (unlikely(scmd->cmd_len < 16)) {
3722 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3727 scsi_16_lba_len(cdb, &block, &n_block);
3728 if (n_block != scsi_bufflen(scmd)) {
3729 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3730 n_block, scsi_bufflen(scmd));
3731 goto invalid_param_len;
3734 if (sa != ZI_REPORT_ZONES) {
3735 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3740 * ZAC allows only for transfers in 512 byte blocks,
3741 * and uses a 16 bit value for the transfer count.
3743 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3744 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3745 goto invalid_param_len;
3747 sect = n_block / 512;
3748 options = cdb[14] & 0xbf;
3750 if (ata_ncq_enabled(qc->dev) &&
3751 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3752 tf->protocol = ATA_PROT_NCQ;
3753 tf->command = ATA_CMD_FPDMA_RECV;
3754 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3755 tf->nsect = qc->hw_tag << 3;
3756 tf->feature = sect & 0xff;
3757 tf->hob_feature = (sect >> 8) & 0xff;
3758 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3760 tf->command = ATA_CMD_ZAC_MGMT_IN;
3761 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3762 tf->protocol = ATA_PROT_DMA;
3763 tf->hob_feature = options;
3764 tf->hob_nsect = (sect >> 8) & 0xff;
3765 tf->nsect = sect & 0xff;
3767 tf->device = ATA_LBA;
3768 tf->lbah = (block >> 16) & 0xff;
3769 tf->lbam = (block >> 8) & 0xff;
3770 tf->lbal = block & 0xff;
3771 tf->hob_lbah = (block >> 40) & 0xff;
3772 tf->hob_lbam = (block >> 32) & 0xff;
3773 tf->hob_lbal = (block >> 24) & 0xff;
3775 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3776 qc->flags |= ATA_QCFLAG_RESULT_TF;
3778 ata_qc_set_pc_nbytes(qc);
3780 qc->complete_fn = ata_scsi_report_zones_complete;
3785 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3789 /* "Parameter list length error" */
3790 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3794 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3796 struct ata_taskfile *tf = &qc->tf;
3797 struct scsi_cmnd *scmd = qc->scsicmd;
3798 struct ata_device *dev = qc->dev;
3799 const u8 *cdb = scmd->cmnd;
3805 if (unlikely(scmd->cmd_len < 16)) {
3811 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3812 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3817 scsi_16_lba_len(cdb, &block, &n_block);
3820 * ZAC MANAGEMENT OUT doesn't define any length
3822 goto invalid_param_len;
3825 all = cdb[14] & 0x1;
3828 * Ignore the block address (zone ID) as defined by ZBC.
3831 } else if (block >= dev->n_sectors) {
3833 * Block must be a valid zone ID (a zone start LBA).
3839 if (ata_ncq_enabled(qc->dev) &&
3840 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3841 tf->protocol = ATA_PROT_NCQ_NODATA;
3842 tf->command = ATA_CMD_NCQ_NON_DATA;
3843 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3844 tf->nsect = qc->hw_tag << 3;
3845 tf->auxiliary = sa | ((u16)all << 8);
3847 tf->protocol = ATA_PROT_NODATA;
3848 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3850 tf->hob_feature = all;
3852 tf->lbah = (block >> 16) & 0xff;
3853 tf->lbam = (block >> 8) & 0xff;
3854 tf->lbal = block & 0xff;
3855 tf->hob_lbah = (block >> 40) & 0xff;
3856 tf->hob_lbam = (block >> 32) & 0xff;
3857 tf->hob_lbal = (block >> 24) & 0xff;
3858 tf->device = ATA_LBA;
3859 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3864 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3867 /* "Parameter list length error" */
3868 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3873 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3874 * @qc: Storage for translated ATA taskfile
3875 * @buf: input buffer
3876 * @len: number of valid bytes in the input buffer
3877 * @fp: out parameter for the failed field on error
3879 * Prepare a taskfile to modify caching information for the device.
3884 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3885 const u8 *buf, int len, u16 *fp)
3887 struct ata_taskfile *tf = &qc->tf;
3888 struct ata_device *dev = qc->dev;
3889 u8 mpage[CACHE_MPAGE_LEN];
3894 * The first two bytes of def_cache_mpage are a header, so offsets
3895 * in mpage are off by 2 compared to buf. Same for len.
3898 if (len != CACHE_MPAGE_LEN - 2) {
3899 if (len < CACHE_MPAGE_LEN - 2)
3902 *fp = CACHE_MPAGE_LEN - 2;
3906 wce = buf[0] & (1 << 2);
3909 * Check that read-only bits are not modified.
3911 ata_msense_caching(dev->id, mpage, false);
3912 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3915 if (mpage[i + 2] != buf[i]) {
3921 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3922 tf->protocol = ATA_PROT_NODATA;
3924 tf->command = ATA_CMD_SET_FEATURES;
3925 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3930 * ata_mselect_control - Simulate MODE SELECT for control page
3931 * @qc: Storage for translated ATA taskfile
3932 * @buf: input buffer
3933 * @len: number of valid bytes in the input buffer
3934 * @fp: out parameter for the failed field on error
3936 * Prepare a taskfile to modify caching information for the device.
3941 static int ata_mselect_control(struct ata_queued_cmd *qc,
3942 const u8 *buf, int len, u16 *fp)
3944 struct ata_device *dev = qc->dev;
3945 u8 mpage[CONTROL_MPAGE_LEN];
3950 * The first two bytes of def_control_mpage are a header, so offsets
3951 * in mpage are off by 2 compared to buf. Same for len.
3954 if (len != CONTROL_MPAGE_LEN - 2) {
3955 if (len < CONTROL_MPAGE_LEN - 2)
3958 *fp = CONTROL_MPAGE_LEN - 2;
3962 d_sense = buf[0] & (1 << 2);
3965 * Check that read-only bits are not modified.
3967 ata_msense_control(dev, mpage, false);
3968 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3971 if (mpage[2 + i] != buf[i]) {
3976 if (d_sense & (1 << 2))
3977 dev->flags |= ATA_DFLAG_D_SENSE;
3979 dev->flags &= ~ATA_DFLAG_D_SENSE;
3984 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3985 * @qc: Storage for translated ATA taskfile
3987 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3988 * Assume this is invoked for direct access devices (e.g. disks) only.
3989 * There should be no block descriptor for other device types.
3992 * spin_lock_irqsave(host lock)
3994 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3996 struct scsi_cmnd *scmd = qc->scsicmd;
3997 const u8 *cdb = scmd->cmnd;
3999 unsigned six_byte, pg_len, hdr_len, bd_len;
4004 const u8 *p = buffer;
4008 six_byte = (cdb[0] == MODE_SELECT);
4010 if (scmd->cmd_len < 5) {
4018 if (scmd->cmd_len < 9) {
4023 len = (cdb[7] << 8) + cdb[8];
4027 /* We only support PF=1, SP=0. */
4028 if ((cdb[1] & 0x11) != 0x10) {
4030 bp = (cdb[1] & 0x01) ? 1 : 5;
4034 /* Test early for possible overrun. */
4035 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
4036 goto invalid_param_len;
4038 /* Move past header and block descriptors. */
4040 goto invalid_param_len;
4042 if (!sg_copy_to_buffer(scsi_sglist(scmd), scsi_sg_count(scmd),
4043 buffer, sizeof(buffer)))
4044 goto invalid_param_len;
4049 bd_len = (p[6] << 8) + p[7];
4054 goto invalid_param_len;
4055 if (bd_len != 0 && bd_len != 8) {
4056 fp = (six_byte) ? 3 : 6;
4057 fp += bd_len + hdr_len;
4066 /* Parse both possible formats for the mode page headers. */
4070 goto invalid_param_len;
4073 pg_len = (p[2] << 8) | p[3];
4078 goto invalid_param_len;
4087 * No mode subpages supported (yet) but asking for _all_
4088 * subpages may be valid
4090 if (spg && (spg != ALL_SUB_MPAGES)) {
4091 fp = (p[0] & 0x40) ? 1 : 0;
4092 fp += hdr_len + bd_len;
4096 goto invalid_param_len;
4100 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4101 fp += hdr_len + bd_len;
4106 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
4107 fp += hdr_len + bd_len;
4110 goto skip; /* No ATA command to send */
4113 default: /* invalid page code */
4114 fp = bd_len + hdr_len;
4119 * Only one page has changeable data, so we only support setting one
4128 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4132 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4136 /* "Parameter list length error" */
4137 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4141 scmd->result = SAM_STAT_GOOD;
4145 static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
4148 return ATA_CMD_TRUSTED_NONDATA;
4150 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
4152 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
4155 static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
4157 struct scsi_cmnd *scmd = qc->scsicmd;
4158 const u8 *cdb = scmd->cmnd;
4159 struct ata_taskfile *tf = &qc->tf;
4161 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
4162 u16 spsp = get_unaligned_be16(&cdb[2]);
4163 u32 len = get_unaligned_be32(&cdb[6]);
4164 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
4167 * We don't support the ATA "security" protocol.
4170 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
4174 if (cdb[4] & 7) { /* INC_512 */
4176 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4180 if (len > 0x01fffe00) {
4181 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4185 /* convert to the sector-based ATA addressing */
4186 len = (len + 511) / 512;
4189 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
4190 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
4192 tf->flags |= ATA_TFLAG_WRITE;
4193 tf->command = ata_scsi_trusted_op(len, send, dma);
4195 tf->lbam = spsp & 0xff;
4196 tf->lbah = spsp >> 8;
4199 tf->nsect = len & 0xff;
4200 tf->lbal = len >> 8;
4203 tf->lbah = (1 << 7);
4206 ata_qc_set_pc_nbytes(qc);
4211 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
4212 * @qc: Command to be translated
4214 * Translate a SCSI variable length CDB to specified commands.
4215 * It checks a service action value in CDB to call corresponding handler.
4218 * Zero on success, non-zero on failure
4221 static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
4223 struct scsi_cmnd *scmd = qc->scsicmd;
4224 const u8 *cdb = scmd->cmnd;
4225 const u16 sa = get_unaligned_be16(&cdb[8]);
4228 * if service action represents a ata pass-thru(32) command,
4229 * then pass it to ata_scsi_pass_thru handler.
4232 return ata_scsi_pass_thru(qc);
4234 /* unsupported service action */
4239 * ata_get_xlat_func - check if SCSI to ATA translation is possible
4241 * @cmd: SCSI command opcode to consider
4243 * Look up the SCSI command given, and determine whether the
4244 * SCSI command is to be translated or simulated.
4247 * Pointer to translation function if possible, %NULL if not.
4250 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4260 return ata_scsi_rw_xlat;
4263 return ata_scsi_write_same_xlat;
4265 case SYNCHRONIZE_CACHE:
4266 if (ata_try_flush_cache(dev))
4267 return ata_scsi_flush_xlat;
4272 return ata_scsi_verify_xlat;
4276 return ata_scsi_pass_thru;
4278 case VARIABLE_LENGTH_CMD:
4279 return ata_scsi_var_len_cdb_xlat;
4282 case MODE_SELECT_10:
4283 return ata_scsi_mode_select_xlat;
4287 return ata_scsi_zbc_in_xlat;
4290 return ata_scsi_zbc_out_xlat;
4292 case SECURITY_PROTOCOL_IN:
4293 case SECURITY_PROTOCOL_OUT:
4294 if (!(dev->flags & ATA_DFLAG_TRUSTED))
4296 return ata_scsi_security_inout_xlat;
4299 return ata_scsi_start_stop_xlat;
4306 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
4307 * @ap: ATA port to which the command was being sent
4308 * @cmd: SCSI command to dump
4310 * Prints the contents of a SCSI command via printk().
4313 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
4314 struct scsi_cmnd *cmd)
4316 #ifdef ATA_VERBOSE_DEBUG
4317 struct scsi_device *scsidev = cmd->device;
4319 VPRINTK("CDB (%u:%d,%d,%lld) %9ph\n",
4321 scsidev->channel, scsidev->id, scsidev->lun,
4326 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
4327 struct ata_device *dev)
4329 u8 scsi_op = scmd->cmnd[0];
4330 ata_xlat_func_t xlat_func;
4333 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4334 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4337 xlat_func = ata_get_xlat_func(dev, scsi_op);
4339 if (unlikely(!scmd->cmd_len))
4343 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4344 /* relay SCSI command to ATAPI device */
4345 int len = COMMAND_SIZE(scsi_op);
4346 if (unlikely(len > scmd->cmd_len ||
4347 len > dev->cdb_len ||
4348 scmd->cmd_len > ATAPI_CDB_LEN))
4351 xlat_func = atapi_xlat;
4353 /* ATA_16 passthru, treat as an ATA command */
4354 if (unlikely(scmd->cmd_len > 16))
4357 xlat_func = ata_get_xlat_func(dev, scsi_op);
4362 rc = ata_scsi_translate(dev, scmd, xlat_func);
4364 ata_scsi_simulate(dev, scmd);
4369 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4370 scmd->cmd_len, scsi_op, dev->cdb_len);
4371 scmd->result = DID_ERROR << 16;
4372 scmd->scsi_done(scmd);
4377 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4378 * @shost: SCSI host of command to be sent
4379 * @cmd: SCSI command to be sent
4381 * In some cases, this function translates SCSI commands into
4382 * ATA taskfiles, and queues the taskfiles to be sent to
4383 * hardware. In other cases, this function simulates a
4384 * SCSI device by evaluating and responding to certain
4385 * SCSI commands. This creates the overall effect of
4386 * ATA and ATAPI devices appearing as SCSI devices.
4392 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4395 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4397 struct ata_port *ap;
4398 struct ata_device *dev;
4399 struct scsi_device *scsidev = cmd->device;
4401 unsigned long irq_flags;
4403 ap = ata_shost_to_port(shost);
4405 spin_lock_irqsave(ap->lock, irq_flags);
4407 ata_scsi_dump_cdb(ap, cmd);
4409 dev = ata_scsi_find_dev(ap, scsidev);
4411 rc = __ata_scsi_queuecmd(cmd, dev);
4413 cmd->result = (DID_BAD_TARGET << 16);
4414 cmd->scsi_done(cmd);
4417 spin_unlock_irqrestore(ap->lock, irq_flags);
4423 * ata_scsi_simulate - simulate SCSI command on ATA device
4424 * @dev: the target device
4425 * @cmd: SCSI command being sent to device.
4427 * Interprets and directly executes a select list of SCSI commands
4428 * that can be handled internally.
4431 * spin_lock_irqsave(host lock)
4434 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4436 struct ata_scsi_args args;
4437 const u8 *scsicmd = cmd->cmnd;
4444 switch(scsicmd[0]) {
4446 if (scsicmd[1] & 2) /* is CmdDt set? */
4447 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4448 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4449 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4450 else switch (scsicmd[2]) {
4452 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4455 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4458 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4461 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4464 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4467 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4470 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4473 if (dev->flags & ATA_DFLAG_ZAC) {
4474 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4479 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4486 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4490 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4493 case SERVICE_ACTION_IN_16:
4494 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4495 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4497 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4501 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4505 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4506 cmd->result = (DRIVER_SENSE << 24);
4509 /* if we reach this, then writeback caching is disabled,
4510 * turning this into a no-op.
4512 case SYNCHRONIZE_CACHE:
4515 /* no-op's, complete with success */
4519 case TEST_UNIT_READY:
4522 case SEND_DIAGNOSTIC:
4523 tmp8 = scsicmd[1] & ~(1 << 3);
4524 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4525 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4528 case MAINTENANCE_IN:
4529 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4530 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4532 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4535 /* all other commands */
4537 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4538 /* "Invalid command operation code" */
4542 cmd->scsi_done(cmd);
4545 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4549 for (i = 0; i < host->n_ports; i++) {
4550 struct ata_port *ap = host->ports[i];
4551 struct Scsi_Host *shost;
4554 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4558 shost->eh_noresume = 1;
4559 *(struct ata_port **)&shost->hostdata[0] = ap;
4560 ap->scsi_host = shost;
4562 shost->transportt = ata_scsi_transport_template;
4563 shost->unique_id = ap->print_id;
4566 shost->max_channel = 1;
4567 shost->max_cmd_len = 32;
4569 /* Schedule policy is determined by ->qc_defer()
4570 * callback and it needs to see every deferred qc.
4571 * Set host_blocked to 1 to prevent SCSI midlayer from
4572 * automatically deferring requests.
4574 shost->max_host_blocked = 1;
4576 rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
4585 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4587 /* scsi_host_put() is in ata_devres_release() */
4588 scsi_remove_host(shost);
4593 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4596 struct ata_device *last_failed_dev = NULL;
4597 struct ata_link *link;
4598 struct ata_device *dev;
4601 ata_for_each_link(link, ap, EDGE) {
4602 ata_for_each_dev(dev, link, ENABLED) {
4603 struct scsi_device *sdev;
4604 int channel = 0, id = 0;
4609 if (ata_is_host_link(link))
4612 channel = link->pmp;
4614 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4616 if (!IS_ERR(sdev)) {
4618 scsi_device_put(sdev);
4625 /* If we scanned while EH was in progress or allocation
4626 * failure occurred, scan would have failed silently. Check
4627 * whether all devices are attached.
4629 ata_for_each_link(link, ap, EDGE) {
4630 ata_for_each_dev(dev, link, ENABLED) {
4639 /* we're missing some SCSI devices */
4641 /* If caller requested synchrnous scan && we've made
4642 * any progress, sleep briefly and repeat.
4644 if (dev != last_failed_dev) {
4646 last_failed_dev = dev;
4650 /* We might be failing to detect boot device, give it
4651 * a few more chances.
4659 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4662 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4663 round_jiffies_relative(HZ));
4667 * ata_scsi_offline_dev - offline attached SCSI device
4668 * @dev: ATA device to offline attached SCSI device for
4670 * This function is called from ata_eh_hotplug() and responsible
4671 * for taking the SCSI device attached to @dev offline. This
4672 * function is called with host lock which protects dev->sdev
4676 * spin_lock_irqsave(host lock)
4679 * 1 if attached SCSI device exists, 0 otherwise.
4681 int ata_scsi_offline_dev(struct ata_device *dev)
4684 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4691 * ata_scsi_remove_dev - remove attached SCSI device
4692 * @dev: ATA device to remove attached SCSI device for
4694 * This function is called from ata_eh_scsi_hotplug() and
4695 * responsible for removing the SCSI device attached to @dev.
4698 * Kernel thread context (may sleep).
4700 static void ata_scsi_remove_dev(struct ata_device *dev)
4702 struct ata_port *ap = dev->link->ap;
4703 struct scsi_device *sdev;
4704 unsigned long flags;
4706 /* Alas, we need to grab scan_mutex to ensure SCSI device
4707 * state doesn't change underneath us and thus
4708 * scsi_device_get() always succeeds. The mutex locking can
4709 * be removed if there is __scsi_device_get() interface which
4710 * increments reference counts regardless of device state.
4712 mutex_lock(&ap->scsi_host->scan_mutex);
4713 spin_lock_irqsave(ap->lock, flags);
4715 /* clearing dev->sdev is protected by host lock */
4720 /* If user initiated unplug races with us, sdev can go
4721 * away underneath us after the host lock and
4722 * scan_mutex are released. Hold onto it.
4724 if (scsi_device_get(sdev) == 0) {
4725 /* The following ensures the attached sdev is
4726 * offline on return from ata_scsi_offline_dev()
4727 * regardless it wins or loses the race
4728 * against this function.
4730 scsi_device_set_state(sdev, SDEV_OFFLINE);
4737 spin_unlock_irqrestore(ap->lock, flags);
4738 mutex_unlock(&ap->scsi_host->scan_mutex);
4741 ata_dev_info(dev, "detaching (SCSI %s)\n",
4742 dev_name(&sdev->sdev_gendev));
4744 scsi_remove_device(sdev);
4745 scsi_device_put(sdev);
4749 static void ata_scsi_handle_link_detach(struct ata_link *link)
4751 struct ata_port *ap = link->ap;
4752 struct ata_device *dev;
4754 ata_for_each_dev(dev, link, ALL) {
4755 unsigned long flags;
4757 if (!(dev->flags & ATA_DFLAG_DETACHED))
4760 spin_lock_irqsave(ap->lock, flags);
4761 dev->flags &= ~ATA_DFLAG_DETACHED;
4762 spin_unlock_irqrestore(ap->lock, flags);
4764 if (zpodd_dev_enabled(dev))
4767 ata_scsi_remove_dev(dev);
4772 * ata_scsi_media_change_notify - send media change event
4773 * @dev: Pointer to the disk device with media change event
4775 * Tell the block layer to send a media change notification
4779 * spin_lock_irqsave(host lock)
4781 void ata_scsi_media_change_notify(struct ata_device *dev)
4784 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4789 * ata_scsi_hotplug - SCSI part of hotplug
4790 * @work: Pointer to ATA port to perform SCSI hotplug on
4792 * Perform SCSI part of hotplug. It's executed from a separate
4793 * workqueue after EH completes. This is necessary because SCSI
4794 * hot plugging requires working EH and hot unplugging is
4795 * synchronized with hot plugging with a mutex.
4798 * Kernel thread context (may sleep).
4800 void ata_scsi_hotplug(struct work_struct *work)
4802 struct ata_port *ap =
4803 container_of(work, struct ata_port, hotplug_task.work);
4806 if (ap->pflags & ATA_PFLAG_UNLOADING) {
4807 DPRINTK("ENTER/EXIT - unloading\n");
4812 mutex_lock(&ap->scsi_scan_mutex);
4814 /* Unplug detached devices. We cannot use link iterator here
4815 * because PMP links have to be scanned even if PMP is
4816 * currently not attached. Iterate manually.
4818 ata_scsi_handle_link_detach(&ap->link);
4820 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4821 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4823 /* scan for new ones */
4824 ata_scsi_scan_host(ap, 0);
4826 mutex_unlock(&ap->scsi_scan_mutex);
4831 * ata_scsi_user_scan - indication for user-initiated bus scan
4832 * @shost: SCSI host to scan
4833 * @channel: Channel to scan
4837 * This function is called when user explicitly requests bus
4838 * scan. Set probe pending flag and invoke EH.
4841 * SCSI layer (we don't care)
4846 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4847 unsigned int id, u64 lun)
4849 struct ata_port *ap = ata_shost_to_port(shost);
4850 unsigned long flags;
4853 if (!ap->ops->error_handler)
4856 if (lun != SCAN_WILD_CARD && lun)
4859 if (!sata_pmp_attached(ap)) {
4860 if (channel != SCAN_WILD_CARD && channel)
4864 if (id != SCAN_WILD_CARD && id)
4869 spin_lock_irqsave(ap->lock, flags);
4871 if (devno == SCAN_WILD_CARD) {
4872 struct ata_link *link;
4874 ata_for_each_link(link, ap, EDGE) {
4875 struct ata_eh_info *ehi = &link->eh_info;
4876 ehi->probe_mask |= ATA_ALL_DEVICES;
4877 ehi->action |= ATA_EH_RESET;
4880 struct ata_device *dev = ata_find_dev(ap, devno);
4883 struct ata_eh_info *ehi = &dev->link->eh_info;
4884 ehi->probe_mask |= 1 << dev->devno;
4885 ehi->action |= ATA_EH_RESET;
4891 ata_port_schedule_eh(ap);
4892 spin_unlock_irqrestore(ap->lock, flags);
4893 ata_port_wait_eh(ap);
4895 spin_unlock_irqrestore(ap->lock, flags);
4901 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4902 * @work: Pointer to ATA port to perform scsi_rescan_device()
4904 * After ATA pass thru (SAT) commands are executed successfully,
4905 * libata need to propagate the changes to SCSI layer.
4908 * Kernel thread context (may sleep).
4910 void ata_scsi_dev_rescan(struct work_struct *work)
4912 struct ata_port *ap =
4913 container_of(work, struct ata_port, scsi_rescan_task);
4914 struct ata_link *link;
4915 struct ata_device *dev;
4916 unsigned long flags;
4918 mutex_lock(&ap->scsi_scan_mutex);
4919 spin_lock_irqsave(ap->lock, flags);
4921 ata_for_each_link(link, ap, EDGE) {
4922 ata_for_each_dev(dev, link, ENABLED) {
4923 struct scsi_device *sdev = dev->sdev;
4927 if (scsi_device_get(sdev))
4930 spin_unlock_irqrestore(ap->lock, flags);
4931 scsi_rescan_device(&(sdev->sdev_gendev));
4932 scsi_device_put(sdev);
4933 spin_lock_irqsave(ap->lock, flags);
4937 spin_unlock_irqrestore(ap->lock, flags);
4938 mutex_unlock(&ap->scsi_scan_mutex);
4942 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4943 * @host: ATA host container for all SAS ports
4944 * @port_info: Information from low-level host driver
4945 * @shost: SCSI host that the scsi device is attached to
4948 * PCI/etc. bus probe sem.
4951 * ata_port pointer on success / NULL on failure.
4954 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
4955 struct ata_port_info *port_info,
4956 struct Scsi_Host *shost)
4958 struct ata_port *ap;
4960 ap = ata_port_alloc(host);
4965 ap->lock = &host->lock;
4966 ap->pio_mask = port_info->pio_mask;
4967 ap->mwdma_mask = port_info->mwdma_mask;
4968 ap->udma_mask = port_info->udma_mask;
4969 ap->flags |= port_info->flags;
4970 ap->ops = port_info->port_ops;
4971 ap->cbl = ATA_CBL_SATA;
4975 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4978 * ata_sas_port_start - Set port up for dma.
4979 * @ap: Port to initialize
4981 * Called just after data structures for each port are
4984 * May be used as the port_start() entry in ata_port_operations.
4987 * Inherited from caller.
4989 int ata_sas_port_start(struct ata_port *ap)
4992 * the port is marked as frozen at allocation time, but if we don't
4993 * have new eh, we won't thaw it
4995 if (!ap->ops->error_handler)
4996 ap->pflags &= ~ATA_PFLAG_FROZEN;
4999 EXPORT_SYMBOL_GPL(ata_sas_port_start);
5002 * ata_port_stop - Undo ata_sas_port_start()
5003 * @ap: Port to shut down
5005 * May be used as the port_stop() entry in ata_port_operations.
5008 * Inherited from caller.
5011 void ata_sas_port_stop(struct ata_port *ap)
5014 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
5017 * ata_sas_async_probe - simply schedule probing and return
5018 * @ap: Port to probe
5020 * For batch scheduling of probe for sas attached ata devices, assumes
5021 * the port has already been through ata_sas_port_init()
5023 void ata_sas_async_probe(struct ata_port *ap)
5025 __ata_port_probe(ap);
5027 EXPORT_SYMBOL_GPL(ata_sas_async_probe);
5029 int ata_sas_sync_probe(struct ata_port *ap)
5031 return ata_port_probe(ap);
5033 EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
5037 * ata_sas_port_init - Initialize a SATA device
5038 * @ap: SATA port to initialize
5041 * PCI/etc. bus probe sem.
5044 * Zero on success, non-zero on error.
5047 int ata_sas_port_init(struct ata_port *ap)
5049 int rc = ap->ops->port_start(ap);
5053 ap->print_id = atomic_inc_return(&ata_print_id);
5056 EXPORT_SYMBOL_GPL(ata_sas_port_init);
5058 int ata_sas_tport_add(struct device *parent, struct ata_port *ap)
5060 return ata_tport_add(parent, ap);
5062 EXPORT_SYMBOL_GPL(ata_sas_tport_add);
5064 void ata_sas_tport_delete(struct ata_port *ap)
5066 ata_tport_delete(ap);
5068 EXPORT_SYMBOL_GPL(ata_sas_tport_delete);
5071 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
5072 * @ap: SATA port to destroy
5076 void ata_sas_port_destroy(struct ata_port *ap)
5078 if (ap->ops->port_stop)
5079 ap->ops->port_stop(ap);
5082 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
5085 * ata_sas_slave_configure - Default slave_config routine for libata devices
5086 * @sdev: SCSI device to configure
5087 * @ap: ATA port to which SCSI device is attached
5093 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
5095 ata_scsi_sdev_config(sdev);
5096 ata_scsi_dev_config(sdev, ap->link.device);
5099 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
5102 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
5103 * @cmd: SCSI command to be sent
5104 * @ap: ATA port to which the command is being sent
5107 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
5111 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
5115 ata_scsi_dump_cdb(ap, cmd);
5117 if (likely(ata_dev_enabled(ap->link.device)))
5118 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
5120 cmd->result = (DID_BAD_TARGET << 16);
5121 cmd->scsi_done(cmd);
5125 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
5127 int ata_sas_allocate_tag(struct ata_port *ap)
5129 unsigned int max_queue = ap->host->n_tags;
5130 unsigned int i, tag;
5132 for (i = 0, tag = ap->sas_last_tag + 1; i < max_queue; i++, tag++) {
5133 tag = tag < max_queue ? tag : 0;
5135 /* the last tag is reserved for internal command. */
5136 if (ata_tag_internal(tag))
5139 if (!test_and_set_bit(tag, &ap->sas_tag_allocated)) {
5140 ap->sas_last_tag = tag;
5147 void ata_sas_free_tag(unsigned int tag, struct ata_port *ap)
5149 clear_bit(tag, &ap->sas_tag_allocated);