Linux 4.16.11
[linux/fpc-iii.git] / drivers / ata / libata-scsi.c
blob89a9d4a2efc8a56a76407611a30d4079363fdfe9
1 /*
2 * libata-scsi.c - helper library for ATA
4 * Maintained by: Tejun Heo <tj@kernel.org>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/driver-api/libata.rst
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
36 #include <linux/slab.h>
37 #include <linux/kernel.h>
38 #include <linux/blkdev.h>
39 #include <linux/spinlock.h>
40 #include <linux/export.h>
41 #include <scsi/scsi.h>
42 #include <scsi/scsi_host.h>
43 #include <scsi/scsi_cmnd.h>
44 #include <scsi/scsi_eh.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_tcq.h>
47 #include <scsi/scsi_transport.h>
48 #include <linux/libata.h>
49 #include <linux/hdreg.h>
50 #include <linux/uaccess.h>
51 #include <linux/suspend.h>
52 #include <asm/unaligned.h>
53 #include <linux/ioprio.h>
55 #include "libata.h"
56 #include "libata-transport.h"
58 #define ATA_SCSI_RBUF_SIZE 4096
60 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
61 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
63 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
65 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
66 const struct scsi_device *scsidev);
67 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
68 const struct scsi_device *scsidev);
70 #define RW_RECOVERY_MPAGE 0x1
71 #define RW_RECOVERY_MPAGE_LEN 12
72 #define CACHE_MPAGE 0x8
73 #define CACHE_MPAGE_LEN 20
74 #define CONTROL_MPAGE 0xa
75 #define CONTROL_MPAGE_LEN 12
76 #define ALL_MPAGES 0x3f
77 #define ALL_SUB_MPAGES 0xff
80 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
81 RW_RECOVERY_MPAGE,
82 RW_RECOVERY_MPAGE_LEN - 2,
83 (1 << 7), /* AWRE */
84 0, /* read retry count */
85 0, 0, 0, 0,
86 0, /* write retry count */
87 0, 0, 0
90 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
91 CACHE_MPAGE,
92 CACHE_MPAGE_LEN - 2,
93 0, /* contains WCE, needs to be 0 for logic */
94 0, 0, 0, 0, 0, 0, 0, 0, 0,
95 0, /* contains DRA, needs to be 0 for logic */
96 0, 0, 0, 0, 0, 0, 0
99 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
100 CONTROL_MPAGE,
101 CONTROL_MPAGE_LEN - 2,
102 2, /* DSENSE=0, GLTSD=1 */
103 0, /* [QAM+QERR may be 1, see 05-359r1] */
104 0, 0, 0, 0, 0xff, 0xff,
105 0, 30 /* extended self test time, see 05-359r1 */
108 static const char *ata_lpm_policy_names[] = {
109 [ATA_LPM_UNKNOWN] = "max_performance",
110 [ATA_LPM_MAX_POWER] = "max_performance",
111 [ATA_LPM_MED_POWER] = "medium_power",
112 [ATA_LPM_MED_POWER_WITH_DIPM] = "med_power_with_dipm",
113 [ATA_LPM_MIN_POWER] = "min_power",
116 static ssize_t ata_scsi_lpm_store(struct device *device,
117 struct device_attribute *attr,
118 const char *buf, size_t count)
120 struct Scsi_Host *shost = class_to_shost(device);
121 struct ata_port *ap = ata_shost_to_port(shost);
122 struct ata_link *link;
123 struct ata_device *dev;
124 enum ata_lpm_policy policy;
125 unsigned long flags;
127 /* UNKNOWN is internal state, iterate from MAX_POWER */
128 for (policy = ATA_LPM_MAX_POWER;
129 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
130 const char *name = ata_lpm_policy_names[policy];
132 if (strncmp(name, buf, strlen(name)) == 0)
133 break;
135 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
136 return -EINVAL;
138 spin_lock_irqsave(ap->lock, flags);
140 ata_for_each_link(link, ap, EDGE) {
141 ata_for_each_dev(dev, &ap->link, ENABLED) {
142 if (dev->horkage & ATA_HORKAGE_NOLPM) {
143 count = -EOPNOTSUPP;
144 goto out_unlock;
149 ap->target_lpm_policy = policy;
150 ata_port_schedule_eh(ap);
151 out_unlock:
152 spin_unlock_irqrestore(ap->lock, flags);
153 return count;
156 static ssize_t ata_scsi_lpm_show(struct device *dev,
157 struct device_attribute *attr, char *buf)
159 struct Scsi_Host *shost = class_to_shost(dev);
160 struct ata_port *ap = ata_shost_to_port(shost);
162 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
163 return -EINVAL;
165 return snprintf(buf, PAGE_SIZE, "%s\n",
166 ata_lpm_policy_names[ap->target_lpm_policy]);
168 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
169 ata_scsi_lpm_show, ata_scsi_lpm_store);
170 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
172 static ssize_t ata_scsi_park_show(struct device *device,
173 struct device_attribute *attr, char *buf)
175 struct scsi_device *sdev = to_scsi_device(device);
176 struct ata_port *ap;
177 struct ata_link *link;
178 struct ata_device *dev;
179 unsigned long now;
180 unsigned int uninitialized_var(msecs);
181 int rc = 0;
183 ap = ata_shost_to_port(sdev->host);
185 spin_lock_irq(ap->lock);
186 dev = ata_scsi_find_dev(ap, sdev);
187 if (!dev) {
188 rc = -ENODEV;
189 goto unlock;
191 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
192 rc = -EOPNOTSUPP;
193 goto unlock;
196 link = dev->link;
197 now = jiffies;
198 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
199 link->eh_context.unloaded_mask & (1 << dev->devno) &&
200 time_after(dev->unpark_deadline, now))
201 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
202 else
203 msecs = 0;
205 unlock:
206 spin_unlock_irq(ap->lock);
208 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
211 static ssize_t ata_scsi_park_store(struct device *device,
212 struct device_attribute *attr,
213 const char *buf, size_t len)
215 struct scsi_device *sdev = to_scsi_device(device);
216 struct ata_port *ap;
217 struct ata_device *dev;
218 long int input;
219 unsigned long flags;
220 int rc;
222 rc = kstrtol(buf, 10, &input);
223 if (rc)
224 return rc;
225 if (input < -2)
226 return -EINVAL;
227 if (input > ATA_TMOUT_MAX_PARK) {
228 rc = -EOVERFLOW;
229 input = ATA_TMOUT_MAX_PARK;
232 ap = ata_shost_to_port(sdev->host);
234 spin_lock_irqsave(ap->lock, flags);
235 dev = ata_scsi_find_dev(ap, sdev);
236 if (unlikely(!dev)) {
237 rc = -ENODEV;
238 goto unlock;
240 if (dev->class != ATA_DEV_ATA &&
241 dev->class != ATA_DEV_ZAC) {
242 rc = -EOPNOTSUPP;
243 goto unlock;
246 if (input >= 0) {
247 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
248 rc = -EOPNOTSUPP;
249 goto unlock;
252 dev->unpark_deadline = ata_deadline(jiffies, input);
253 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
254 ata_port_schedule_eh(ap);
255 complete(&ap->park_req_pending);
256 } else {
257 switch (input) {
258 case -1:
259 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
260 break;
261 case -2:
262 dev->flags |= ATA_DFLAG_NO_UNLOAD;
263 break;
266 unlock:
267 spin_unlock_irqrestore(ap->lock, flags);
269 return rc ? rc : len;
271 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
272 ata_scsi_park_show, ata_scsi_park_store);
273 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
275 static ssize_t ata_ncq_prio_enable_show(struct device *device,
276 struct device_attribute *attr,
277 char *buf)
279 struct scsi_device *sdev = to_scsi_device(device);
280 struct ata_port *ap;
281 struct ata_device *dev;
282 bool ncq_prio_enable;
283 int rc = 0;
285 ap = ata_shost_to_port(sdev->host);
287 spin_lock_irq(ap->lock);
288 dev = ata_scsi_find_dev(ap, sdev);
289 if (!dev) {
290 rc = -ENODEV;
291 goto unlock;
294 ncq_prio_enable = dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLE;
296 unlock:
297 spin_unlock_irq(ap->lock);
299 return rc ? rc : snprintf(buf, 20, "%u\n", ncq_prio_enable);
302 static ssize_t ata_ncq_prio_enable_store(struct device *device,
303 struct device_attribute *attr,
304 const char *buf, size_t len)
306 struct scsi_device *sdev = to_scsi_device(device);
307 struct ata_port *ap;
308 struct ata_device *dev;
309 long int input;
310 int rc;
312 rc = kstrtol(buf, 10, &input);
313 if (rc)
314 return rc;
315 if ((input < 0) || (input > 1))
316 return -EINVAL;
318 ap = ata_shost_to_port(sdev->host);
319 dev = ata_scsi_find_dev(ap, sdev);
320 if (unlikely(!dev))
321 return -ENODEV;
323 spin_lock_irq(ap->lock);
324 if (input)
325 dev->flags |= ATA_DFLAG_NCQ_PRIO_ENABLE;
326 else
327 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
329 dev->link->eh_info.action |= ATA_EH_REVALIDATE;
330 dev->link->eh_info.flags |= ATA_EHI_QUIET;
331 ata_port_schedule_eh(ap);
332 spin_unlock_irq(ap->lock);
334 ata_port_wait_eh(ap);
336 if (input) {
337 spin_lock_irq(ap->lock);
338 if (!(dev->flags & ATA_DFLAG_NCQ_PRIO)) {
339 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
340 rc = -EIO;
342 spin_unlock_irq(ap->lock);
345 return rc ? rc : len;
348 DEVICE_ATTR(ncq_prio_enable, S_IRUGO | S_IWUSR,
349 ata_ncq_prio_enable_show, ata_ncq_prio_enable_store);
350 EXPORT_SYMBOL_GPL(dev_attr_ncq_prio_enable);
352 void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
353 u8 sk, u8 asc, u8 ascq)
355 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
357 if (!cmd)
358 return;
360 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
362 scsi_build_sense_buffer(d_sense, cmd->sense_buffer, sk, asc, ascq);
365 void ata_scsi_set_sense_information(struct ata_device *dev,
366 struct scsi_cmnd *cmd,
367 const struct ata_taskfile *tf)
369 u64 information;
371 if (!cmd)
372 return;
374 information = ata_tf_read_block(tf, dev);
375 if (information == U64_MAX)
376 return;
378 scsi_set_sense_information(cmd->sense_buffer,
379 SCSI_SENSE_BUFFERSIZE, information);
382 static void ata_scsi_set_invalid_field(struct ata_device *dev,
383 struct scsi_cmnd *cmd, u16 field, u8 bit)
385 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
386 /* "Invalid field in CDB" */
387 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
388 field, bit, 1);
391 static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
392 struct scsi_cmnd *cmd, u16 field)
394 /* "Invalid field in parameter list" */
395 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
396 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
397 field, 0xff, 0);
400 static ssize_t
401 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
402 const char *buf, size_t count)
404 struct Scsi_Host *shost = class_to_shost(dev);
405 struct ata_port *ap = ata_shost_to_port(shost);
406 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
407 return ap->ops->em_store(ap, buf, count);
408 return -EINVAL;
411 static ssize_t
412 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
413 char *buf)
415 struct Scsi_Host *shost = class_to_shost(dev);
416 struct ata_port *ap = ata_shost_to_port(shost);
418 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
419 return ap->ops->em_show(ap, buf);
420 return -EINVAL;
422 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
423 ata_scsi_em_message_show, ata_scsi_em_message_store);
424 EXPORT_SYMBOL_GPL(dev_attr_em_message);
426 static ssize_t
427 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
428 char *buf)
430 struct Scsi_Host *shost = class_to_shost(dev);
431 struct ata_port *ap = ata_shost_to_port(shost);
433 return snprintf(buf, 23, "%d\n", ap->em_message_type);
435 DEVICE_ATTR(em_message_type, S_IRUGO,
436 ata_scsi_em_message_type_show, NULL);
437 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
439 static ssize_t
440 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
441 char *buf)
443 struct scsi_device *sdev = to_scsi_device(dev);
444 struct ata_port *ap = ata_shost_to_port(sdev->host);
445 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
447 if (atadev && ap->ops->sw_activity_show &&
448 (ap->flags & ATA_FLAG_SW_ACTIVITY))
449 return ap->ops->sw_activity_show(atadev, buf);
450 return -EINVAL;
453 static ssize_t
454 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
455 const char *buf, size_t count)
457 struct scsi_device *sdev = to_scsi_device(dev);
458 struct ata_port *ap = ata_shost_to_port(sdev->host);
459 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
460 enum sw_activity val;
461 int rc;
463 if (atadev && ap->ops->sw_activity_store &&
464 (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
465 val = simple_strtoul(buf, NULL, 0);
466 switch (val) {
467 case OFF: case BLINK_ON: case BLINK_OFF:
468 rc = ap->ops->sw_activity_store(atadev, val);
469 if (!rc)
470 return count;
471 else
472 return rc;
475 return -EINVAL;
477 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
478 ata_scsi_activity_store);
479 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
481 struct device_attribute *ata_common_sdev_attrs[] = {
482 &dev_attr_unload_heads,
483 &dev_attr_ncq_prio_enable,
484 NULL
486 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
489 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
490 * @sdev: SCSI device for which BIOS geometry is to be determined
491 * @bdev: block device associated with @sdev
492 * @capacity: capacity of SCSI device
493 * @geom: location to which geometry will be output
495 * Generic bios head/sector/cylinder calculator
496 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
497 * mapping. Some situations may arise where the disk is not
498 * bootable if this is not used.
500 * LOCKING:
501 * Defined by the SCSI layer. We don't really care.
503 * RETURNS:
504 * Zero.
506 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
507 sector_t capacity, int geom[])
509 geom[0] = 255;
510 geom[1] = 63;
511 sector_div(capacity, 255*63);
512 geom[2] = capacity;
514 return 0;
518 * ata_scsi_unlock_native_capacity - unlock native capacity
519 * @sdev: SCSI device to adjust device capacity for
521 * This function is called if a partition on @sdev extends beyond
522 * the end of the device. It requests EH to unlock HPA.
524 * LOCKING:
525 * Defined by the SCSI layer. Might sleep.
527 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
529 struct ata_port *ap = ata_shost_to_port(sdev->host);
530 struct ata_device *dev;
531 unsigned long flags;
533 spin_lock_irqsave(ap->lock, flags);
535 dev = ata_scsi_find_dev(ap, sdev);
536 if (dev && dev->n_sectors < dev->n_native_sectors) {
537 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
538 dev->link->eh_info.action |= ATA_EH_RESET;
539 ata_port_schedule_eh(ap);
542 spin_unlock_irqrestore(ap->lock, flags);
543 ata_port_wait_eh(ap);
547 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
548 * @ap: target port
549 * @sdev: SCSI device to get identify data for
550 * @arg: User buffer area for identify data
552 * LOCKING:
553 * Defined by the SCSI layer. We don't really care.
555 * RETURNS:
556 * Zero on success, negative errno on error.
558 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
559 void __user *arg)
561 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
562 u16 __user *dst = arg;
563 char buf[40];
565 if (!dev)
566 return -ENOMSG;
568 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
569 return -EFAULT;
571 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
572 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
573 return -EFAULT;
575 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
576 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
577 return -EFAULT;
579 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
580 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
581 return -EFAULT;
583 return 0;
587 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
588 * @scsidev: Device to which we are issuing command
589 * @arg: User provided data for issuing command
591 * LOCKING:
592 * Defined by the SCSI layer. We don't really care.
594 * RETURNS:
595 * Zero on success, negative errno on error.
597 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
599 int rc = 0;
600 u8 scsi_cmd[MAX_COMMAND_SIZE];
601 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
602 int argsize = 0;
603 enum dma_data_direction data_dir;
604 struct scsi_sense_hdr sshdr;
605 int cmd_result;
607 if (arg == NULL)
608 return -EINVAL;
610 if (copy_from_user(args, arg, sizeof(args)))
611 return -EFAULT;
613 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
614 if (!sensebuf)
615 return -ENOMEM;
617 memset(scsi_cmd, 0, sizeof(scsi_cmd));
619 if (args[3]) {
620 argsize = ATA_SECT_SIZE * args[3];
621 argbuf = kmalloc(argsize, GFP_KERNEL);
622 if (argbuf == NULL) {
623 rc = -ENOMEM;
624 goto error;
627 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
628 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
629 block count in sector count field */
630 data_dir = DMA_FROM_DEVICE;
631 } else {
632 scsi_cmd[1] = (3 << 1); /* Non-data */
633 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
634 data_dir = DMA_NONE;
637 scsi_cmd[0] = ATA_16;
639 scsi_cmd[4] = args[2];
640 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
641 scsi_cmd[6] = args[3];
642 scsi_cmd[8] = args[1];
643 scsi_cmd[10] = 0x4f;
644 scsi_cmd[12] = 0xc2;
645 } else {
646 scsi_cmd[6] = args[1];
648 scsi_cmd[14] = args[0];
650 /* Good values for timeout and retries? Values below
651 from scsi_ioctl_send_command() for default case... */
652 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
653 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
655 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
656 u8 *desc = sensebuf + 8;
657 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
659 /* If we set cc then ATA pass-through will cause a
660 * check condition even if no error. Filter that. */
661 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
662 if (sshdr.sense_key == RECOVERED_ERROR &&
663 sshdr.asc == 0 && sshdr.ascq == 0x1d)
664 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
667 /* Send userspace a few ATA registers (same as drivers/ide) */
668 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
669 desc[0] == 0x09) { /* code is "ATA Descriptor" */
670 args[0] = desc[13]; /* status */
671 args[1] = desc[3]; /* error */
672 args[2] = desc[5]; /* sector count (0:7) */
673 if (copy_to_user(arg, args, sizeof(args)))
674 rc = -EFAULT;
679 if (cmd_result) {
680 rc = -EIO;
681 goto error;
684 if ((argbuf)
685 && copy_to_user(arg + sizeof(args), argbuf, argsize))
686 rc = -EFAULT;
687 error:
688 kfree(sensebuf);
689 kfree(argbuf);
690 return rc;
694 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
695 * @scsidev: Device to which we are issuing command
696 * @arg: User provided data for issuing command
698 * LOCKING:
699 * Defined by the SCSI layer. We don't really care.
701 * RETURNS:
702 * Zero on success, negative errno on error.
704 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
706 int rc = 0;
707 u8 scsi_cmd[MAX_COMMAND_SIZE];
708 u8 args[7], *sensebuf = NULL;
709 struct scsi_sense_hdr sshdr;
710 int cmd_result;
712 if (arg == NULL)
713 return -EINVAL;
715 if (copy_from_user(args, arg, sizeof(args)))
716 return -EFAULT;
718 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
719 if (!sensebuf)
720 return -ENOMEM;
722 memset(scsi_cmd, 0, sizeof(scsi_cmd));
723 scsi_cmd[0] = ATA_16;
724 scsi_cmd[1] = (3 << 1); /* Non-data */
725 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
726 scsi_cmd[4] = args[1];
727 scsi_cmd[6] = args[2];
728 scsi_cmd[8] = args[3];
729 scsi_cmd[10] = args[4];
730 scsi_cmd[12] = args[5];
731 scsi_cmd[13] = args[6] & 0x4f;
732 scsi_cmd[14] = args[0];
734 /* Good values for timeout and retries? Values below
735 from scsi_ioctl_send_command() for default case... */
736 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
737 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
739 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
740 u8 *desc = sensebuf + 8;
741 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
743 /* If we set cc then ATA pass-through will cause a
744 * check condition even if no error. Filter that. */
745 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
746 if (sshdr.sense_key == RECOVERED_ERROR &&
747 sshdr.asc == 0 && sshdr.ascq == 0x1d)
748 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
751 /* Send userspace ATA registers */
752 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
753 desc[0] == 0x09) {/* code is "ATA Descriptor" */
754 args[0] = desc[13]; /* status */
755 args[1] = desc[3]; /* error */
756 args[2] = desc[5]; /* sector count (0:7) */
757 args[3] = desc[7]; /* lbal */
758 args[4] = desc[9]; /* lbam */
759 args[5] = desc[11]; /* lbah */
760 args[6] = desc[12]; /* select */
761 if (copy_to_user(arg, args, sizeof(args)))
762 rc = -EFAULT;
766 if (cmd_result) {
767 rc = -EIO;
768 goto error;
771 error:
772 kfree(sensebuf);
773 return rc;
776 static int ata_ioc32(struct ata_port *ap)
778 if (ap->flags & ATA_FLAG_PIO_DMA)
779 return 1;
780 if (ap->pflags & ATA_PFLAG_PIO32)
781 return 1;
782 return 0;
785 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
786 int cmd, void __user *arg)
788 unsigned long val;
789 int rc = -EINVAL;
790 unsigned long flags;
792 switch (cmd) {
793 case HDIO_GET_32BIT:
794 spin_lock_irqsave(ap->lock, flags);
795 val = ata_ioc32(ap);
796 spin_unlock_irqrestore(ap->lock, flags);
797 return put_user(val, (unsigned long __user *)arg);
799 case HDIO_SET_32BIT:
800 val = (unsigned long) arg;
801 rc = 0;
802 spin_lock_irqsave(ap->lock, flags);
803 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
804 if (val)
805 ap->pflags |= ATA_PFLAG_PIO32;
806 else
807 ap->pflags &= ~ATA_PFLAG_PIO32;
808 } else {
809 if (val != ata_ioc32(ap))
810 rc = -EINVAL;
812 spin_unlock_irqrestore(ap->lock, flags);
813 return rc;
815 case HDIO_GET_IDENTITY:
816 return ata_get_identity(ap, scsidev, arg);
818 case HDIO_DRIVE_CMD:
819 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
820 return -EACCES;
821 return ata_cmd_ioctl(scsidev, arg);
823 case HDIO_DRIVE_TASK:
824 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
825 return -EACCES;
826 return ata_task_ioctl(scsidev, arg);
828 default:
829 rc = -ENOTTY;
830 break;
833 return rc;
835 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
837 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
839 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
840 scsidev, cmd, arg);
842 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
845 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
846 * @dev: ATA device to which the new command is attached
847 * @cmd: SCSI command that originated this ATA command
849 * Obtain a reference to an unused ata_queued_cmd structure,
850 * which is the basic libata structure representing a single
851 * ATA command sent to the hardware.
853 * If a command was available, fill in the SCSI-specific
854 * portions of the structure with information on the
855 * current command.
857 * LOCKING:
858 * spin_lock_irqsave(host lock)
860 * RETURNS:
861 * Command allocated, or %NULL if none available.
863 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
864 struct scsi_cmnd *cmd)
866 struct ata_queued_cmd *qc;
868 qc = ata_qc_new_init(dev, cmd->request->tag);
869 if (qc) {
870 qc->scsicmd = cmd;
871 qc->scsidone = cmd->scsi_done;
873 qc->sg = scsi_sglist(cmd);
874 qc->n_elem = scsi_sg_count(cmd);
875 } else {
876 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
877 cmd->scsi_done(cmd);
880 return qc;
883 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
885 struct scsi_cmnd *scmd = qc->scsicmd;
887 qc->extrabytes = scmd->request->extra_len;
888 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
892 * ata_dump_status - user friendly display of error info
893 * @id: id of the port in question
894 * @tf: ptr to filled out taskfile
896 * Decode and dump the ATA error/status registers for the user so
897 * that they have some idea what really happened at the non
898 * make-believe layer.
900 * LOCKING:
901 * inherited from caller
903 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
905 u8 stat = tf->command, err = tf->feature;
907 pr_warn("ata%u: status=0x%02x { ", id, stat);
908 if (stat & ATA_BUSY) {
909 pr_cont("Busy }\n"); /* Data is not valid in this case */
910 } else {
911 if (stat & ATA_DRDY) pr_cont("DriveReady ");
912 if (stat & ATA_DF) pr_cont("DeviceFault ");
913 if (stat & ATA_DSC) pr_cont("SeekComplete ");
914 if (stat & ATA_DRQ) pr_cont("DataRequest ");
915 if (stat & ATA_CORR) pr_cont("CorrectedError ");
916 if (stat & ATA_SENSE) pr_cont("Sense ");
917 if (stat & ATA_ERR) pr_cont("Error ");
918 pr_cont("}\n");
920 if (err) {
921 pr_warn("ata%u: error=0x%02x { ", id, err);
922 if (err & ATA_ABORTED) pr_cont("DriveStatusError ");
923 if (err & ATA_ICRC) {
924 if (err & ATA_ABORTED)
925 pr_cont("BadCRC ");
926 else pr_cont("Sector ");
928 if (err & ATA_UNC) pr_cont("UncorrectableError ");
929 if (err & ATA_IDNF) pr_cont("SectorIdNotFound ");
930 if (err & ATA_TRK0NF) pr_cont("TrackZeroNotFound ");
931 if (err & ATA_AMNF) pr_cont("AddrMarkNotFound ");
932 pr_cont("}\n");
938 * ata_to_sense_error - convert ATA error to SCSI error
939 * @id: ATA device number
940 * @drv_stat: value contained in ATA status register
941 * @drv_err: value contained in ATA error register
942 * @sk: the sense key we'll fill out
943 * @asc: the additional sense code we'll fill out
944 * @ascq: the additional sense code qualifier we'll fill out
945 * @verbose: be verbose
947 * Converts an ATA error into a SCSI error. Fill out pointers to
948 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
949 * format sense blocks.
951 * LOCKING:
952 * spin_lock_irqsave(host lock)
954 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
955 u8 *asc, u8 *ascq, int verbose)
957 int i;
959 /* Based on the 3ware driver translation table */
960 static const unsigned char sense_table[][4] = {
961 /* BBD|ECC|ID|MAR */
962 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
963 // Device busy Aborted command
964 /* BBD|ECC|ID */
965 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
966 // Device busy Aborted command
967 /* ECC|MC|MARK */
968 {0x61, HARDWARE_ERROR, 0x00, 0x00},
969 // Device fault Hardware error
970 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
971 {0x84, ABORTED_COMMAND, 0x47, 0x00},
972 // Data CRC error SCSI parity error
973 /* MC|ID|ABRT|TRK0|MARK */
974 {0x37, NOT_READY, 0x04, 0x00},
975 // Unit offline Not ready
976 /* MCR|MARK */
977 {0x09, NOT_READY, 0x04, 0x00},
978 // Unrecovered disk error Not ready
979 /* Bad address mark */
980 {0x01, MEDIUM_ERROR, 0x13, 0x00},
981 // Address mark not found for data field
982 /* TRK0 - Track 0 not found */
983 {0x02, HARDWARE_ERROR, 0x00, 0x00},
984 // Hardware error
985 /* Abort: 0x04 is not translated here, see below */
986 /* Media change request */
987 {0x08, NOT_READY, 0x04, 0x00},
988 // FIXME: faking offline
989 /* SRV/IDNF - ID not found */
990 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
991 // Logical address out of range
992 /* MC - Media Changed */
993 {0x20, UNIT_ATTENTION, 0x28, 0x00},
994 // Not ready to ready change, medium may have changed
995 /* ECC - Uncorrectable ECC error */
996 {0x40, MEDIUM_ERROR, 0x11, 0x04},
997 // Unrecovered read error
998 /* BBD - block marked bad */
999 {0x80, MEDIUM_ERROR, 0x11, 0x04},
1000 // Block marked bad Medium error, unrecovered read error
1001 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1003 static const unsigned char stat_table[][4] = {
1004 /* Must be first because BUSY means no other bits valid */
1005 {0x80, ABORTED_COMMAND, 0x47, 0x00},
1006 // Busy, fake parity for now
1007 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
1008 // Device ready, unaligned write command
1009 {0x20, HARDWARE_ERROR, 0x44, 0x00},
1010 // Device fault, internal target failure
1011 {0x08, ABORTED_COMMAND, 0x47, 0x00},
1012 // Timed out in xfer, fake parity for now
1013 {0x04, RECOVERED_ERROR, 0x11, 0x00},
1014 // Recovered ECC error Medium error, recovered
1015 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1019 * Is this an error we can process/parse
1021 if (drv_stat & ATA_BUSY) {
1022 drv_err = 0; /* Ignore the err bits, they're invalid */
1025 if (drv_err) {
1026 /* Look for drv_err */
1027 for (i = 0; sense_table[i][0] != 0xFF; i++) {
1028 /* Look for best matches first */
1029 if ((sense_table[i][0] & drv_err) ==
1030 sense_table[i][0]) {
1031 *sk = sense_table[i][1];
1032 *asc = sense_table[i][2];
1033 *ascq = sense_table[i][3];
1034 goto translate_done;
1040 * Fall back to interpreting status bits. Note that if the drv_err
1041 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
1042 * is not descriptive enough.
1044 for (i = 0; stat_table[i][0] != 0xFF; i++) {
1045 if (stat_table[i][0] & drv_stat) {
1046 *sk = stat_table[i][1];
1047 *asc = stat_table[i][2];
1048 *ascq = stat_table[i][3];
1049 goto translate_done;
1054 * We need a sensible error return here, which is tricky, and one
1055 * that won't cause people to do things like return a disk wrongly.
1057 *sk = ABORTED_COMMAND;
1058 *asc = 0x00;
1059 *ascq = 0x00;
1061 translate_done:
1062 if (verbose)
1063 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
1064 id, drv_stat, drv_err, *sk, *asc, *ascq);
1065 return;
1069 * ata_gen_passthru_sense - Generate check condition sense block.
1070 * @qc: Command that completed.
1072 * This function is specific to the ATA descriptor format sense
1073 * block specified for the ATA pass through commands. Regardless
1074 * of whether the command errored or not, return a sense
1075 * block. Copy all controller registers into the sense
1076 * block. If there was no error, we get the request from an ATA
1077 * passthrough command, so we use the following sense data:
1078 * sk = RECOVERED ERROR
1079 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1082 * LOCKING:
1083 * None.
1085 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
1087 struct scsi_cmnd *cmd = qc->scsicmd;
1088 struct ata_taskfile *tf = &qc->result_tf;
1089 unsigned char *sb = cmd->sense_buffer;
1090 unsigned char *desc = sb + 8;
1091 int verbose = qc->ap->ops->error_handler == NULL;
1092 u8 sense_key, asc, ascq;
1094 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1096 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1099 * Use ata_to_sense_error() to map status register bits
1100 * onto sense key, asc & ascq.
1102 if (qc->err_mask ||
1103 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1104 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1105 &sense_key, &asc, &ascq, verbose);
1106 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
1107 } else {
1109 * ATA PASS-THROUGH INFORMATION AVAILABLE
1110 * Always in descriptor format sense.
1112 scsi_build_sense_buffer(1, cmd->sense_buffer,
1113 RECOVERED_ERROR, 0, 0x1D);
1116 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
1117 u8 len;
1119 /* descriptor format */
1120 len = sb[7];
1121 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
1122 if (!desc) {
1123 if (SCSI_SENSE_BUFFERSIZE < len + 14)
1124 return;
1125 sb[7] = len + 14;
1126 desc = sb + 8 + len;
1128 desc[0] = 9;
1129 desc[1] = 12;
1131 * Copy registers into sense buffer.
1133 desc[2] = 0x00;
1134 desc[3] = tf->feature; /* == error reg */
1135 desc[5] = tf->nsect;
1136 desc[7] = tf->lbal;
1137 desc[9] = tf->lbam;
1138 desc[11] = tf->lbah;
1139 desc[12] = tf->device;
1140 desc[13] = tf->command; /* == status reg */
1143 * Fill in Extend bit, and the high order bytes
1144 * if applicable.
1146 if (tf->flags & ATA_TFLAG_LBA48) {
1147 desc[2] |= 0x01;
1148 desc[4] = tf->hob_nsect;
1149 desc[6] = tf->hob_lbal;
1150 desc[8] = tf->hob_lbam;
1151 desc[10] = tf->hob_lbah;
1153 } else {
1154 /* Fixed sense format */
1155 desc[0] = tf->feature;
1156 desc[1] = tf->command; /* status */
1157 desc[2] = tf->device;
1158 desc[3] = tf->nsect;
1159 desc[7] = 0;
1160 if (tf->flags & ATA_TFLAG_LBA48) {
1161 desc[8] |= 0x80;
1162 if (tf->hob_nsect)
1163 desc[8] |= 0x40;
1164 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
1165 desc[8] |= 0x20;
1167 desc[9] = tf->lbal;
1168 desc[10] = tf->lbam;
1169 desc[11] = tf->lbah;
1174 * ata_gen_ata_sense - generate a SCSI fixed sense block
1175 * @qc: Command that we are erroring out
1177 * Generate sense block for a failed ATA command @qc. Descriptor
1178 * format is used to accommodate LBA48 block address.
1180 * LOCKING:
1181 * None.
1183 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1185 struct ata_device *dev = qc->dev;
1186 struct scsi_cmnd *cmd = qc->scsicmd;
1187 struct ata_taskfile *tf = &qc->result_tf;
1188 unsigned char *sb = cmd->sense_buffer;
1189 int verbose = qc->ap->ops->error_handler == NULL;
1190 u64 block;
1191 u8 sense_key, asc, ascq;
1193 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1195 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1197 if (ata_dev_disabled(dev)) {
1198 /* Device disabled after error recovery */
1199 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
1200 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
1201 return;
1203 /* Use ata_to_sense_error() to map status register bits
1204 * onto sense key, asc & ascq.
1206 if (qc->err_mask ||
1207 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1208 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1209 &sense_key, &asc, &ascq, verbose);
1210 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1211 } else {
1212 /* Could not decode error */
1213 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
1214 tf->command, qc->err_mask);
1215 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1216 return;
1219 block = ata_tf_read_block(&qc->result_tf, dev);
1220 if (block == U64_MAX)
1221 return;
1223 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
1226 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1228 sdev->use_10_for_rw = 1;
1229 sdev->use_10_for_ms = 1;
1230 sdev->no_write_same = 1;
1232 /* Schedule policy is determined by ->qc_defer() callback and
1233 * it needs to see every deferred qc. Set dev_blocked to 1 to
1234 * prevent SCSI midlayer from automatically deferring
1235 * requests.
1237 sdev->max_device_blocked = 1;
1241 * atapi_drain_needed - Check whether data transfer may overflow
1242 * @rq: request to be checked
1244 * ATAPI commands which transfer variable length data to host
1245 * might overflow due to application error or hardware bug. This
1246 * function checks whether overflow should be drained and ignored
1247 * for @request.
1249 * LOCKING:
1250 * None.
1252 * RETURNS:
1253 * 1 if ; otherwise, 0.
1255 static int atapi_drain_needed(struct request *rq)
1257 if (likely(!blk_rq_is_passthrough(rq)))
1258 return 0;
1260 if (!blk_rq_bytes(rq) || op_is_write(req_op(rq)))
1261 return 0;
1263 return atapi_cmd_type(scsi_req(rq)->cmd[0]) == ATAPI_MISC;
1266 static int ata_scsi_dev_config(struct scsi_device *sdev,
1267 struct ata_device *dev)
1269 struct request_queue *q = sdev->request_queue;
1271 if (!ata_id_has_unload(dev->id))
1272 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1274 /* configure max sectors */
1275 blk_queue_max_hw_sectors(q, dev->max_sectors);
1277 if (dev->class == ATA_DEV_ATAPI) {
1278 void *buf;
1280 sdev->sector_size = ATA_SECT_SIZE;
1282 /* set DMA padding */
1283 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1285 /* configure draining */
1286 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1287 if (!buf) {
1288 ata_dev_err(dev, "drain buffer allocation failed\n");
1289 return -ENOMEM;
1292 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1293 } else {
1294 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1295 sdev->manage_start_stop = 1;
1299 * ata_pio_sectors() expects buffer for each sector to not cross
1300 * page boundary. Enforce it by requiring buffers to be sector
1301 * aligned, which works iff sector_size is not larger than
1302 * PAGE_SIZE. ATAPI devices also need the alignment as
1303 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1305 if (sdev->sector_size > PAGE_SIZE)
1306 ata_dev_warn(dev,
1307 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1308 sdev->sector_size);
1310 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1312 if (dev->flags & ATA_DFLAG_AN)
1313 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1315 if (dev->flags & ATA_DFLAG_NCQ) {
1316 int depth;
1318 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1319 depth = min(ATA_MAX_QUEUE - 1, depth);
1320 scsi_change_queue_depth(sdev, depth);
1323 blk_queue_flush_queueable(q, false);
1325 if (dev->flags & ATA_DFLAG_TRUSTED)
1326 sdev->security_supported = 1;
1328 dev->sdev = sdev;
1329 return 0;
1333 * ata_scsi_slave_config - Set SCSI device attributes
1334 * @sdev: SCSI device to examine
1336 * This is called before we actually start reading
1337 * and writing to the device, to configure certain
1338 * SCSI mid-layer behaviors.
1340 * LOCKING:
1341 * Defined by SCSI layer. We don't really care.
1344 int ata_scsi_slave_config(struct scsi_device *sdev)
1346 struct ata_port *ap = ata_shost_to_port(sdev->host);
1347 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1348 int rc = 0;
1350 ata_scsi_sdev_config(sdev);
1352 if (dev)
1353 rc = ata_scsi_dev_config(sdev, dev);
1355 return rc;
1359 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1360 * @sdev: SCSI device to be destroyed
1362 * @sdev is about to be destroyed for hot/warm unplugging. If
1363 * this unplugging was initiated by libata as indicated by NULL
1364 * dev->sdev, this function doesn't have to do anything.
1365 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1366 * Clear dev->sdev, schedule the device for ATA detach and invoke
1367 * EH.
1369 * LOCKING:
1370 * Defined by SCSI layer. We don't really care.
1372 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1374 struct ata_port *ap = ata_shost_to_port(sdev->host);
1375 struct request_queue *q = sdev->request_queue;
1376 unsigned long flags;
1377 struct ata_device *dev;
1379 if (!ap->ops->error_handler)
1380 return;
1382 spin_lock_irqsave(ap->lock, flags);
1383 dev = __ata_scsi_find_dev(ap, sdev);
1384 if (dev && dev->sdev) {
1385 /* SCSI device already in CANCEL state, no need to offline it */
1386 dev->sdev = NULL;
1387 dev->flags |= ATA_DFLAG_DETACH;
1388 ata_port_schedule_eh(ap);
1390 spin_unlock_irqrestore(ap->lock, flags);
1392 kfree(q->dma_drain_buffer);
1393 q->dma_drain_buffer = NULL;
1394 q->dma_drain_size = 0;
1398 * __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
1399 * @ap: ATA port to which the device change the queue depth
1400 * @sdev: SCSI device to configure queue depth for
1401 * @queue_depth: new queue depth
1403 * libsas and libata have different approaches for associating a sdev to
1404 * its ata_port.
1407 int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1408 int queue_depth)
1410 struct ata_device *dev;
1411 unsigned long flags;
1413 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1414 return sdev->queue_depth;
1416 dev = ata_scsi_find_dev(ap, sdev);
1417 if (!dev || !ata_dev_enabled(dev))
1418 return sdev->queue_depth;
1420 /* NCQ enabled? */
1421 spin_lock_irqsave(ap->lock, flags);
1422 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1423 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1424 dev->flags |= ATA_DFLAG_NCQ_OFF;
1425 queue_depth = 1;
1427 spin_unlock_irqrestore(ap->lock, flags);
1429 /* limit and apply queue depth */
1430 queue_depth = min(queue_depth, sdev->host->can_queue);
1431 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1432 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1434 if (sdev->queue_depth == queue_depth)
1435 return -EINVAL;
1437 return scsi_change_queue_depth(sdev, queue_depth);
1441 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1442 * @sdev: SCSI device to configure queue depth for
1443 * @queue_depth: new queue depth
1445 * This is libata standard hostt->change_queue_depth callback.
1446 * SCSI will call into this callback when user tries to set queue
1447 * depth via sysfs.
1449 * LOCKING:
1450 * SCSI layer (we don't care)
1452 * RETURNS:
1453 * Newly configured queue depth.
1455 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1457 struct ata_port *ap = ata_shost_to_port(sdev->host);
1459 return __ata_change_queue_depth(ap, sdev, queue_depth);
1463 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1464 * @qc: Storage for translated ATA taskfile
1466 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1467 * (to start). Perhaps these commands should be preceded by
1468 * CHECK POWER MODE to see what power mode the device is already in.
1469 * [See SAT revision 5 at www.t10.org]
1471 * LOCKING:
1472 * spin_lock_irqsave(host lock)
1474 * RETURNS:
1475 * Zero on success, non-zero on error.
1477 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1479 struct scsi_cmnd *scmd = qc->scsicmd;
1480 struct ata_taskfile *tf = &qc->tf;
1481 const u8 *cdb = scmd->cmnd;
1482 u16 fp;
1483 u8 bp = 0xff;
1485 if (scmd->cmd_len < 5) {
1486 fp = 4;
1487 goto invalid_fld;
1490 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1491 tf->protocol = ATA_PROT_NODATA;
1492 if (cdb[1] & 0x1) {
1493 ; /* ignore IMMED bit, violates sat-r05 */
1495 if (cdb[4] & 0x2) {
1496 fp = 4;
1497 bp = 1;
1498 goto invalid_fld; /* LOEJ bit set not supported */
1500 if (((cdb[4] >> 4) & 0xf) != 0) {
1501 fp = 4;
1502 bp = 3;
1503 goto invalid_fld; /* power conditions not supported */
1506 if (cdb[4] & 0x1) {
1507 tf->nsect = 1; /* 1 sector, lba=0 */
1509 if (qc->dev->flags & ATA_DFLAG_LBA) {
1510 tf->flags |= ATA_TFLAG_LBA;
1512 tf->lbah = 0x0;
1513 tf->lbam = 0x0;
1514 tf->lbal = 0x0;
1515 tf->device |= ATA_LBA;
1516 } else {
1517 /* CHS */
1518 tf->lbal = 0x1; /* sect */
1519 tf->lbam = 0x0; /* cyl low */
1520 tf->lbah = 0x0; /* cyl high */
1523 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1524 } else {
1525 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1526 * or S5) causing some drives to spin up and down again.
1528 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1529 system_state == SYSTEM_POWER_OFF)
1530 goto skip;
1532 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1533 system_entering_hibernation())
1534 goto skip;
1536 /* Issue ATA STANDBY IMMEDIATE command */
1537 tf->command = ATA_CMD_STANDBYNOW1;
1541 * Standby and Idle condition timers could be implemented but that
1542 * would require libata to implement the Power condition mode page
1543 * and allow the user to change it. Changing mode pages requires
1544 * MODE SELECT to be implemented.
1547 return 0;
1549 invalid_fld:
1550 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1551 return 1;
1552 skip:
1553 scmd->result = SAM_STAT_GOOD;
1554 return 1;
1559 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1560 * @qc: Storage for translated ATA taskfile
1562 * Sets up an ATA taskfile to issue FLUSH CACHE or
1563 * FLUSH CACHE EXT.
1565 * LOCKING:
1566 * spin_lock_irqsave(host lock)
1568 * RETURNS:
1569 * Zero on success, non-zero on error.
1571 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1573 struct ata_taskfile *tf = &qc->tf;
1575 tf->flags |= ATA_TFLAG_DEVICE;
1576 tf->protocol = ATA_PROT_NODATA;
1578 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1579 tf->command = ATA_CMD_FLUSH_EXT;
1580 else
1581 tf->command = ATA_CMD_FLUSH;
1583 /* flush is critical for IO integrity, consider it an IO command */
1584 qc->flags |= ATA_QCFLAG_IO;
1586 return 0;
1590 * scsi_6_lba_len - Get LBA and transfer length
1591 * @cdb: SCSI command to translate
1593 * Calculate LBA and transfer length for 6-byte commands.
1595 * RETURNS:
1596 * @plba: the LBA
1597 * @plen: the transfer length
1599 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1601 u64 lba = 0;
1602 u32 len;
1604 VPRINTK("six-byte command\n");
1606 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1607 lba |= ((u64)cdb[2]) << 8;
1608 lba |= ((u64)cdb[3]);
1610 len = cdb[4];
1612 *plba = lba;
1613 *plen = len;
1617 * scsi_10_lba_len - Get LBA and transfer length
1618 * @cdb: SCSI command to translate
1620 * Calculate LBA and transfer length for 10-byte commands.
1622 * RETURNS:
1623 * @plba: the LBA
1624 * @plen: the transfer length
1626 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1628 u64 lba = 0;
1629 u32 len = 0;
1631 VPRINTK("ten-byte command\n");
1633 lba |= ((u64)cdb[2]) << 24;
1634 lba |= ((u64)cdb[3]) << 16;
1635 lba |= ((u64)cdb[4]) << 8;
1636 lba |= ((u64)cdb[5]);
1638 len |= ((u32)cdb[7]) << 8;
1639 len |= ((u32)cdb[8]);
1641 *plba = lba;
1642 *plen = len;
1646 * scsi_16_lba_len - Get LBA and transfer length
1647 * @cdb: SCSI command to translate
1649 * Calculate LBA and transfer length for 16-byte commands.
1651 * RETURNS:
1652 * @plba: the LBA
1653 * @plen: the transfer length
1655 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1657 u64 lba = 0;
1658 u32 len = 0;
1660 VPRINTK("sixteen-byte command\n");
1662 lba |= ((u64)cdb[2]) << 56;
1663 lba |= ((u64)cdb[3]) << 48;
1664 lba |= ((u64)cdb[4]) << 40;
1665 lba |= ((u64)cdb[5]) << 32;
1666 lba |= ((u64)cdb[6]) << 24;
1667 lba |= ((u64)cdb[7]) << 16;
1668 lba |= ((u64)cdb[8]) << 8;
1669 lba |= ((u64)cdb[9]);
1671 len |= ((u32)cdb[10]) << 24;
1672 len |= ((u32)cdb[11]) << 16;
1673 len |= ((u32)cdb[12]) << 8;
1674 len |= ((u32)cdb[13]);
1676 *plba = lba;
1677 *plen = len;
1681 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1682 * @qc: Storage for translated ATA taskfile
1684 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1686 * LOCKING:
1687 * spin_lock_irqsave(host lock)
1689 * RETURNS:
1690 * Zero on success, non-zero on error.
1692 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1694 struct scsi_cmnd *scmd = qc->scsicmd;
1695 struct ata_taskfile *tf = &qc->tf;
1696 struct ata_device *dev = qc->dev;
1697 u64 dev_sectors = qc->dev->n_sectors;
1698 const u8 *cdb = scmd->cmnd;
1699 u64 block;
1700 u32 n_block;
1701 u16 fp;
1703 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1704 tf->protocol = ATA_PROT_NODATA;
1706 if (cdb[0] == VERIFY) {
1707 if (scmd->cmd_len < 10) {
1708 fp = 9;
1709 goto invalid_fld;
1711 scsi_10_lba_len(cdb, &block, &n_block);
1712 } else if (cdb[0] == VERIFY_16) {
1713 if (scmd->cmd_len < 16) {
1714 fp = 15;
1715 goto invalid_fld;
1717 scsi_16_lba_len(cdb, &block, &n_block);
1718 } else {
1719 fp = 0;
1720 goto invalid_fld;
1723 if (!n_block)
1724 goto nothing_to_do;
1725 if (block >= dev_sectors)
1726 goto out_of_range;
1727 if ((block + n_block) > dev_sectors)
1728 goto out_of_range;
1730 if (dev->flags & ATA_DFLAG_LBA) {
1731 tf->flags |= ATA_TFLAG_LBA;
1733 if (lba_28_ok(block, n_block)) {
1734 /* use LBA28 */
1735 tf->command = ATA_CMD_VERIFY;
1736 tf->device |= (block >> 24) & 0xf;
1737 } else if (lba_48_ok(block, n_block)) {
1738 if (!(dev->flags & ATA_DFLAG_LBA48))
1739 goto out_of_range;
1741 /* use LBA48 */
1742 tf->flags |= ATA_TFLAG_LBA48;
1743 tf->command = ATA_CMD_VERIFY_EXT;
1745 tf->hob_nsect = (n_block >> 8) & 0xff;
1747 tf->hob_lbah = (block >> 40) & 0xff;
1748 tf->hob_lbam = (block >> 32) & 0xff;
1749 tf->hob_lbal = (block >> 24) & 0xff;
1750 } else
1751 /* request too large even for LBA48 */
1752 goto out_of_range;
1754 tf->nsect = n_block & 0xff;
1756 tf->lbah = (block >> 16) & 0xff;
1757 tf->lbam = (block >> 8) & 0xff;
1758 tf->lbal = block & 0xff;
1760 tf->device |= ATA_LBA;
1761 } else {
1762 /* CHS */
1763 u32 sect, head, cyl, track;
1765 if (!lba_28_ok(block, n_block))
1766 goto out_of_range;
1768 /* Convert LBA to CHS */
1769 track = (u32)block / dev->sectors;
1770 cyl = track / dev->heads;
1771 head = track % dev->heads;
1772 sect = (u32)block % dev->sectors + 1;
1774 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1775 (u32)block, track, cyl, head, sect);
1777 /* Check whether the converted CHS can fit.
1778 Cylinder: 0-65535
1779 Head: 0-15
1780 Sector: 1-255*/
1781 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1782 goto out_of_range;
1784 tf->command = ATA_CMD_VERIFY;
1785 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1786 tf->lbal = sect;
1787 tf->lbam = cyl;
1788 tf->lbah = cyl >> 8;
1789 tf->device |= head;
1792 return 0;
1794 invalid_fld:
1795 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1796 return 1;
1798 out_of_range:
1799 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1800 /* "Logical Block Address out of range" */
1801 return 1;
1803 nothing_to_do:
1804 scmd->result = SAM_STAT_GOOD;
1805 return 1;
1809 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1810 * @qc: Storage for translated ATA taskfile
1812 * Converts any of six SCSI read/write commands into the
1813 * ATA counterpart, including starting sector (LBA),
1814 * sector count, and taking into account the device's LBA48
1815 * support.
1817 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1818 * %WRITE_16 are currently supported.
1820 * LOCKING:
1821 * spin_lock_irqsave(host lock)
1823 * RETURNS:
1824 * Zero on success, non-zero on error.
1826 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1828 struct scsi_cmnd *scmd = qc->scsicmd;
1829 const u8 *cdb = scmd->cmnd;
1830 struct request *rq = scmd->request;
1831 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1832 unsigned int tf_flags = 0;
1833 u64 block;
1834 u32 n_block;
1835 int rc;
1836 u16 fp = 0;
1838 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1839 tf_flags |= ATA_TFLAG_WRITE;
1841 /* Calculate the SCSI LBA, transfer length and FUA. */
1842 switch (cdb[0]) {
1843 case READ_10:
1844 case WRITE_10:
1845 if (unlikely(scmd->cmd_len < 10)) {
1846 fp = 9;
1847 goto invalid_fld;
1849 scsi_10_lba_len(cdb, &block, &n_block);
1850 if (cdb[1] & (1 << 3))
1851 tf_flags |= ATA_TFLAG_FUA;
1852 break;
1853 case READ_6:
1854 case WRITE_6:
1855 if (unlikely(scmd->cmd_len < 6)) {
1856 fp = 5;
1857 goto invalid_fld;
1859 scsi_6_lba_len(cdb, &block, &n_block);
1861 /* for 6-byte r/w commands, transfer length 0
1862 * means 256 blocks of data, not 0 block.
1864 if (!n_block)
1865 n_block = 256;
1866 break;
1867 case READ_16:
1868 case WRITE_16:
1869 if (unlikely(scmd->cmd_len < 16)) {
1870 fp = 15;
1871 goto invalid_fld;
1873 scsi_16_lba_len(cdb, &block, &n_block);
1874 if (cdb[1] & (1 << 3))
1875 tf_flags |= ATA_TFLAG_FUA;
1876 break;
1877 default:
1878 DPRINTK("no-byte command\n");
1879 fp = 0;
1880 goto invalid_fld;
1883 /* Check and compose ATA command */
1884 if (!n_block)
1885 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1886 * length 0 means transfer 0 block of data.
1887 * However, for ATA R/W commands, sector count 0 means
1888 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1890 * WARNING: one or two older ATA drives treat 0 as 0...
1892 goto nothing_to_do;
1894 qc->flags |= ATA_QCFLAG_IO;
1895 qc->nbytes = n_block * scmd->device->sector_size;
1897 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1898 qc->tag, class);
1900 if (likely(rc == 0))
1901 return 0;
1903 if (rc == -ERANGE)
1904 goto out_of_range;
1905 /* treat all other errors as -EINVAL, fall through */
1906 invalid_fld:
1907 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1908 return 1;
1910 out_of_range:
1911 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1912 /* "Logical Block Address out of range" */
1913 return 1;
1915 nothing_to_do:
1916 scmd->result = SAM_STAT_GOOD;
1917 return 1;
1920 static void ata_qc_done(struct ata_queued_cmd *qc)
1922 struct scsi_cmnd *cmd = qc->scsicmd;
1923 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1925 ata_qc_free(qc);
1926 done(cmd);
1929 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1931 struct ata_port *ap = qc->ap;
1932 struct scsi_cmnd *cmd = qc->scsicmd;
1933 u8 *cdb = cmd->cmnd;
1934 int need_sense = (qc->err_mask != 0);
1936 /* For ATA pass thru (SAT) commands, generate a sense block if
1937 * user mandated it or if there's an error. Note that if we
1938 * generate because the user forced us to [CK_COND =1], a check
1939 * condition is generated and the ATA register values are returned
1940 * whether the command completed successfully or not. If there
1941 * was no error, we use the following sense data:
1942 * sk = RECOVERED ERROR
1943 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1945 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1946 ((cdb[2] & 0x20) || need_sense))
1947 ata_gen_passthru_sense(qc);
1948 else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1949 cmd->result = SAM_STAT_CHECK_CONDITION;
1950 else if (need_sense)
1951 ata_gen_ata_sense(qc);
1952 else
1953 cmd->result = SAM_STAT_GOOD;
1955 if (need_sense && !ap->ops->error_handler)
1956 ata_dump_status(ap->print_id, &qc->result_tf);
1958 ata_qc_done(qc);
1962 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1963 * @dev: ATA device to which the command is addressed
1964 * @cmd: SCSI command to execute
1965 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1967 * Our ->queuecommand() function has decided that the SCSI
1968 * command issued can be directly translated into an ATA
1969 * command, rather than handled internally.
1971 * This function sets up an ata_queued_cmd structure for the
1972 * SCSI command, and sends that ata_queued_cmd to the hardware.
1974 * The xlat_func argument (actor) returns 0 if ready to execute
1975 * ATA command, else 1 to finish translation. If 1 is returned
1976 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1977 * to be set reflecting an error condition or clean (early)
1978 * termination.
1980 * LOCKING:
1981 * spin_lock_irqsave(host lock)
1983 * RETURNS:
1984 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1985 * needs to be deferred.
1987 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1988 ata_xlat_func_t xlat_func)
1990 struct ata_port *ap = dev->link->ap;
1991 struct ata_queued_cmd *qc;
1992 int rc;
1994 VPRINTK("ENTER\n");
1996 qc = ata_scsi_qc_new(dev, cmd);
1997 if (!qc)
1998 goto err_mem;
2000 /* data is present; dma-map it */
2001 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
2002 cmd->sc_data_direction == DMA_TO_DEVICE) {
2003 if (unlikely(scsi_bufflen(cmd) < 1)) {
2004 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
2005 goto err_did;
2008 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
2010 qc->dma_dir = cmd->sc_data_direction;
2013 qc->complete_fn = ata_scsi_qc_complete;
2015 if (xlat_func(qc))
2016 goto early_finish;
2018 if (ap->ops->qc_defer) {
2019 if ((rc = ap->ops->qc_defer(qc)))
2020 goto defer;
2023 /* select device, send command to hardware */
2024 ata_qc_issue(qc);
2026 VPRINTK("EXIT\n");
2027 return 0;
2029 early_finish:
2030 ata_qc_free(qc);
2031 cmd->scsi_done(cmd);
2032 DPRINTK("EXIT - early finish (good or error)\n");
2033 return 0;
2035 err_did:
2036 ata_qc_free(qc);
2037 cmd->result = (DID_ERROR << 16);
2038 cmd->scsi_done(cmd);
2039 err_mem:
2040 DPRINTK("EXIT - internal\n");
2041 return 0;
2043 defer:
2044 ata_qc_free(qc);
2045 DPRINTK("EXIT - defer\n");
2046 if (rc == ATA_DEFER_LINK)
2047 return SCSI_MLQUEUE_DEVICE_BUSY;
2048 else
2049 return SCSI_MLQUEUE_HOST_BUSY;
2052 struct ata_scsi_args {
2053 struct ata_device *dev;
2054 u16 *id;
2055 struct scsi_cmnd *cmd;
2059 * ata_scsi_rbuf_get - Map response buffer.
2060 * @cmd: SCSI command containing buffer to be mapped.
2061 * @flags: unsigned long variable to store irq enable status
2062 * @copy_in: copy in from user buffer
2064 * Prepare buffer for simulated SCSI commands.
2066 * LOCKING:
2067 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
2069 * RETURNS:
2070 * Pointer to response buffer.
2072 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
2073 unsigned long *flags)
2075 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
2077 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
2078 if (copy_in)
2079 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2080 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2081 return ata_scsi_rbuf;
2085 * ata_scsi_rbuf_put - Unmap response buffer.
2086 * @cmd: SCSI command containing buffer to be unmapped.
2087 * @copy_out: copy out result
2088 * @flags: @flags passed to ata_scsi_rbuf_get()
2090 * Returns rbuf buffer. The result is copied to @cmd's buffer if
2091 * @copy_back is true.
2093 * LOCKING:
2094 * Unlocks ata_scsi_rbuf_lock.
2096 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
2097 unsigned long *flags)
2099 if (copy_out)
2100 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2101 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2102 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
2106 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
2107 * @args: device IDENTIFY data / SCSI command of interest.
2108 * @actor: Callback hook for desired SCSI command simulator
2110 * Takes care of the hard work of simulating a SCSI command...
2111 * Mapping the response buffer, calling the command's handler,
2112 * and handling the handler's return value. This return value
2113 * indicates whether the handler wishes the SCSI command to be
2114 * completed successfully (0), or not (in which case cmd->result
2115 * and sense buffer are assumed to be set).
2117 * LOCKING:
2118 * spin_lock_irqsave(host lock)
2120 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
2121 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
2123 u8 *rbuf;
2124 unsigned int rc;
2125 struct scsi_cmnd *cmd = args->cmd;
2126 unsigned long flags;
2128 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
2129 rc = actor(args, rbuf);
2130 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
2132 if (rc == 0)
2133 cmd->result = SAM_STAT_GOOD;
2137 * ata_scsiop_inq_std - Simulate INQUIRY command
2138 * @args: device IDENTIFY data / SCSI command of interest.
2139 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2141 * Returns standard device identification data associated
2142 * with non-VPD INQUIRY command output.
2144 * LOCKING:
2145 * spin_lock_irqsave(host lock)
2147 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
2149 static const u8 versions[] = {
2150 0x00,
2151 0x60, /* SAM-3 (no version claimed) */
2153 0x03,
2154 0x20, /* SBC-2 (no version claimed) */
2156 0x03,
2157 0x00 /* SPC-3 (no version claimed) */
2159 static const u8 versions_zbc[] = {
2160 0x00,
2161 0xA0, /* SAM-5 (no version claimed) */
2163 0x06,
2164 0x00, /* SBC-4 (no version claimed) */
2166 0x05,
2167 0xC0, /* SPC-5 (no version claimed) */
2169 0x60,
2170 0x24, /* ZBC r05 */
2173 u8 hdr[] = {
2174 TYPE_DISK,
2176 0x5, /* claim SPC-3 version compatibility */
2178 95 - 4,
2184 VPRINTK("ENTER\n");
2186 /* set scsi removable (RMB) bit per ata bit, or if the
2187 * AHCI port says it's external (Hotplug-capable, eSATA).
2189 if (ata_id_removable(args->id) ||
2190 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
2191 hdr[1] |= (1 << 7);
2193 if (args->dev->class == ATA_DEV_ZAC) {
2194 hdr[0] = TYPE_ZBC;
2195 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
2198 memcpy(rbuf, hdr, sizeof(hdr));
2199 memcpy(&rbuf[8], "ATA ", 8);
2200 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
2202 /* From SAT, use last 2 words from fw rev unless they are spaces */
2203 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2204 if (strncmp(&rbuf[32], " ", 4) == 0)
2205 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2207 if (rbuf[32] == 0 || rbuf[32] == ' ')
2208 memcpy(&rbuf[32], "n/a ", 4);
2210 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
2211 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2212 else
2213 memcpy(rbuf + 58, versions, sizeof(versions));
2215 return 0;
2219 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2220 * @args: device IDENTIFY data / SCSI command of interest.
2221 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2223 * Returns list of inquiry VPD pages available.
2225 * LOCKING:
2226 * spin_lock_irqsave(host lock)
2228 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2230 int num_pages;
2231 static const u8 pages[] = {
2232 0x00, /* page 0x00, this page */
2233 0x80, /* page 0x80, unit serial no page */
2234 0x83, /* page 0x83, device ident page */
2235 0x89, /* page 0x89, ata info page */
2236 0xb0, /* page 0xb0, block limits page */
2237 0xb1, /* page 0xb1, block device characteristics page */
2238 0xb2, /* page 0xb2, thin provisioning page */
2239 0xb6, /* page 0xb6, zoned block device characteristics */
2242 num_pages = sizeof(pages);
2243 if (!(args->dev->flags & ATA_DFLAG_ZAC))
2244 num_pages--;
2245 rbuf[3] = num_pages; /* number of supported VPD pages */
2246 memcpy(rbuf + 4, pages, num_pages);
2247 return 0;
2251 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2252 * @args: device IDENTIFY data / SCSI command of interest.
2253 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2255 * Returns ATA device serial number.
2257 * LOCKING:
2258 * spin_lock_irqsave(host lock)
2260 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2262 static const u8 hdr[] = {
2264 0x80, /* this page code */
2266 ATA_ID_SERNO_LEN, /* page len */
2269 memcpy(rbuf, hdr, sizeof(hdr));
2270 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2271 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2272 return 0;
2276 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2277 * @args: device IDENTIFY data / SCSI command of interest.
2278 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2280 * Yields two logical unit device identification designators:
2281 * - vendor specific ASCII containing the ATA serial number
2282 * - SAT defined "t10 vendor id based" containing ASCII vendor
2283 * name ("ATA "), model and serial numbers.
2285 * LOCKING:
2286 * spin_lock_irqsave(host lock)
2288 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2290 const int sat_model_serial_desc_len = 68;
2291 int num;
2293 rbuf[1] = 0x83; /* this page code */
2294 num = 4;
2296 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2297 rbuf[num + 0] = 2;
2298 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2299 num += 4;
2300 ata_id_string(args->id, (unsigned char *) rbuf + num,
2301 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2302 num += ATA_ID_SERNO_LEN;
2304 /* SAT defined lu model and serial numbers descriptor */
2305 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2306 rbuf[num + 0] = 2;
2307 rbuf[num + 1] = 1;
2308 rbuf[num + 3] = sat_model_serial_desc_len;
2309 num += 4;
2310 memcpy(rbuf + num, "ATA ", 8);
2311 num += 8;
2312 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2313 ATA_ID_PROD_LEN);
2314 num += ATA_ID_PROD_LEN;
2315 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2316 ATA_ID_SERNO_LEN);
2317 num += ATA_ID_SERNO_LEN;
2319 if (ata_id_has_wwn(args->id)) {
2320 /* SAT defined lu world wide name */
2321 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2322 rbuf[num + 0] = 1;
2323 rbuf[num + 1] = 3;
2324 rbuf[num + 3] = ATA_ID_WWN_LEN;
2325 num += 4;
2326 ata_id_string(args->id, (unsigned char *) rbuf + num,
2327 ATA_ID_WWN, ATA_ID_WWN_LEN);
2328 num += ATA_ID_WWN_LEN;
2330 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2331 return 0;
2335 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2336 * @args: device IDENTIFY data / SCSI command of interest.
2337 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2339 * Yields SAT-specified ATA VPD page.
2341 * LOCKING:
2342 * spin_lock_irqsave(host lock)
2344 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2346 struct ata_taskfile tf;
2348 memset(&tf, 0, sizeof(tf));
2350 rbuf[1] = 0x89; /* our page code */
2351 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2352 rbuf[3] = (0x238 & 0xff);
2354 memcpy(&rbuf[8], "linux ", 8);
2355 memcpy(&rbuf[16], "libata ", 16);
2356 memcpy(&rbuf[32], DRV_VERSION, 4);
2358 /* we don't store the ATA device signature, so we fake it */
2360 tf.command = ATA_DRDY; /* really, this is Status reg */
2361 tf.lbal = 0x1;
2362 tf.nsect = 0x1;
2364 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2365 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2367 rbuf[56] = ATA_CMD_ID_ATA;
2369 memcpy(&rbuf[60], &args->id[0], 512);
2370 return 0;
2373 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2375 u16 min_io_sectors;
2377 rbuf[1] = 0xb0;
2378 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2381 * Optimal transfer length granularity.
2383 * This is always one physical block, but for disks with a smaller
2384 * logical than physical sector size we need to figure out what the
2385 * latter is.
2387 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2388 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2391 * Optimal unmap granularity.
2393 * The ATA spec doesn't even know about a granularity or alignment
2394 * for the TRIM command. We can leave away most of the unmap related
2395 * VPD page entries, but we have specifify a granularity to signal
2396 * that we support some form of unmap - in thise case via WRITE SAME
2397 * with the unmap bit set.
2399 if (ata_id_has_trim(args->id)) {
2400 put_unaligned_be64(65535 * ATA_MAX_TRIM_RNUM, &rbuf[36]);
2401 put_unaligned_be32(1, &rbuf[28]);
2404 return 0;
2407 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2409 int form_factor = ata_id_form_factor(args->id);
2410 int media_rotation_rate = ata_id_rotation_rate(args->id);
2411 u8 zoned = ata_id_zoned_cap(args->id);
2413 rbuf[1] = 0xb1;
2414 rbuf[3] = 0x3c;
2415 rbuf[4] = media_rotation_rate >> 8;
2416 rbuf[5] = media_rotation_rate;
2417 rbuf[7] = form_factor;
2418 if (zoned)
2419 rbuf[8] = (zoned << 4);
2421 return 0;
2424 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2426 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2427 rbuf[1] = 0xb2;
2428 rbuf[3] = 0x4;
2429 rbuf[5] = 1 << 6; /* TPWS */
2431 return 0;
2434 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2437 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2439 rbuf[1] = 0xb6;
2440 rbuf[3] = 0x3C;
2443 * URSWRZ bit is only meaningful for host-managed ZAC drives
2445 if (args->dev->zac_zoned_cap & 1)
2446 rbuf[4] |= 1;
2447 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2448 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2449 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2451 return 0;
2455 * modecpy - Prepare response for MODE SENSE
2456 * @dest: output buffer
2457 * @src: data being copied
2458 * @n: length of mode page
2459 * @changeable: whether changeable parameters are requested
2461 * Generate a generic MODE SENSE page for either current or changeable
2462 * parameters.
2464 * LOCKING:
2465 * None.
2467 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2469 if (changeable) {
2470 memcpy(dest, src, 2);
2471 memset(dest + 2, 0, n - 2);
2472 } else {
2473 memcpy(dest, src, n);
2478 * ata_msense_caching - Simulate MODE SENSE caching info page
2479 * @id: device IDENTIFY data
2480 * @buf: output buffer
2481 * @changeable: whether changeable parameters are requested
2483 * Generate a caching info page, which conditionally indicates
2484 * write caching to the SCSI layer, depending on device
2485 * capabilities.
2487 * LOCKING:
2488 * None.
2490 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2492 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2493 if (changeable) {
2494 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2495 } else {
2496 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2497 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2499 return sizeof(def_cache_mpage);
2503 * ata_msense_control - Simulate MODE SENSE control mode page
2504 * @dev: ATA device of interest
2505 * @buf: output buffer
2506 * @changeable: whether changeable parameters are requested
2508 * Generate a generic MODE SENSE control mode page.
2510 * LOCKING:
2511 * None.
2513 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2514 bool changeable)
2516 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2517 if (changeable) {
2518 buf[2] |= (1 << 2); /* ata_mselect_control() */
2519 } else {
2520 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2522 buf[2] |= (d_sense << 2); /* descriptor format sense data */
2524 return sizeof(def_control_mpage);
2528 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2529 * @buf: output buffer
2530 * @changeable: whether changeable parameters are requested
2532 * Generate a generic MODE SENSE r/w error recovery page.
2534 * LOCKING:
2535 * None.
2537 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2539 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2540 changeable);
2541 return sizeof(def_rw_recovery_mpage);
2545 * We can turn this into a real blacklist if it's needed, for now just
2546 * blacklist any Maxtor BANC1G10 revision firmware
2548 static int ata_dev_supports_fua(u16 *id)
2550 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2552 if (!libata_fua)
2553 return 0;
2554 if (!ata_id_has_fua(id))
2555 return 0;
2557 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2558 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2560 if (strcmp(model, "Maxtor"))
2561 return 1;
2562 if (strcmp(fw, "BANC1G10"))
2563 return 1;
2565 return 0; /* blacklisted */
2569 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2570 * @args: device IDENTIFY data / SCSI command of interest.
2571 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2573 * Simulate MODE SENSE commands. Assume this is invoked for direct
2574 * access devices (e.g. disks) only. There should be no block
2575 * descriptor for other device types.
2577 * LOCKING:
2578 * spin_lock_irqsave(host lock)
2580 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2582 struct ata_device *dev = args->dev;
2583 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2584 static const u8 sat_blk_desc[] = {
2585 0, 0, 0, 0, /* number of blocks: sat unspecified */
2587 0, 0x2, 0x0 /* block length: 512 bytes */
2589 u8 pg, spg;
2590 unsigned int ebd, page_control, six_byte;
2591 u8 dpofua, bp = 0xff;
2592 u16 fp;
2594 VPRINTK("ENTER\n");
2596 six_byte = (scsicmd[0] == MODE_SENSE);
2597 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2599 * LLBA bit in msense(10) ignored (compliant)
2602 page_control = scsicmd[2] >> 6;
2603 switch (page_control) {
2604 case 0: /* current */
2605 case 1: /* changeable */
2606 case 2: /* defaults */
2607 break; /* supported */
2608 case 3: /* saved */
2609 goto saving_not_supp;
2610 default:
2611 fp = 2;
2612 bp = 6;
2613 goto invalid_fld;
2616 if (six_byte)
2617 p += 4 + (ebd ? 8 : 0);
2618 else
2619 p += 8 + (ebd ? 8 : 0);
2621 pg = scsicmd[2] & 0x3f;
2622 spg = scsicmd[3];
2624 * No mode subpages supported (yet) but asking for _all_
2625 * subpages may be valid
2627 if (spg && (spg != ALL_SUB_MPAGES)) {
2628 fp = 3;
2629 goto invalid_fld;
2632 switch(pg) {
2633 case RW_RECOVERY_MPAGE:
2634 p += ata_msense_rw_recovery(p, page_control == 1);
2635 break;
2637 case CACHE_MPAGE:
2638 p += ata_msense_caching(args->id, p, page_control == 1);
2639 break;
2641 case CONTROL_MPAGE:
2642 p += ata_msense_control(args->dev, p, page_control == 1);
2643 break;
2645 case ALL_MPAGES:
2646 p += ata_msense_rw_recovery(p, page_control == 1);
2647 p += ata_msense_caching(args->id, p, page_control == 1);
2648 p += ata_msense_control(args->dev, p, page_control == 1);
2649 break;
2651 default: /* invalid page code */
2652 fp = 2;
2653 goto invalid_fld;
2656 dpofua = 0;
2657 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2658 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2659 dpofua = 1 << 4;
2661 if (six_byte) {
2662 rbuf[0] = p - rbuf - 1;
2663 rbuf[2] |= dpofua;
2664 if (ebd) {
2665 rbuf[3] = sizeof(sat_blk_desc);
2666 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2668 } else {
2669 unsigned int output_len = p - rbuf - 2;
2671 rbuf[0] = output_len >> 8;
2672 rbuf[1] = output_len;
2673 rbuf[3] |= dpofua;
2674 if (ebd) {
2675 rbuf[7] = sizeof(sat_blk_desc);
2676 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2679 return 0;
2681 invalid_fld:
2682 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2683 return 1;
2685 saving_not_supp:
2686 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2687 /* "Saving parameters not supported" */
2688 return 1;
2692 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2693 * @args: device IDENTIFY data / SCSI command of interest.
2694 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2696 * Simulate READ CAPACITY commands.
2698 * LOCKING:
2699 * None.
2701 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2703 struct ata_device *dev = args->dev;
2704 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2705 u32 sector_size; /* physical sector size in bytes */
2706 u8 log2_per_phys;
2707 u16 lowest_aligned;
2709 sector_size = ata_id_logical_sector_size(dev->id);
2710 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2711 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2713 VPRINTK("ENTER\n");
2715 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2716 if (last_lba >= 0xffffffffULL)
2717 last_lba = 0xffffffff;
2719 /* sector count, 32-bit */
2720 rbuf[0] = last_lba >> (8 * 3);
2721 rbuf[1] = last_lba >> (8 * 2);
2722 rbuf[2] = last_lba >> (8 * 1);
2723 rbuf[3] = last_lba;
2725 /* sector size */
2726 rbuf[4] = sector_size >> (8 * 3);
2727 rbuf[5] = sector_size >> (8 * 2);
2728 rbuf[6] = sector_size >> (8 * 1);
2729 rbuf[7] = sector_size;
2730 } else {
2731 /* sector count, 64-bit */
2732 rbuf[0] = last_lba >> (8 * 7);
2733 rbuf[1] = last_lba >> (8 * 6);
2734 rbuf[2] = last_lba >> (8 * 5);
2735 rbuf[3] = last_lba >> (8 * 4);
2736 rbuf[4] = last_lba >> (8 * 3);
2737 rbuf[5] = last_lba >> (8 * 2);
2738 rbuf[6] = last_lba >> (8 * 1);
2739 rbuf[7] = last_lba;
2741 /* sector size */
2742 rbuf[ 8] = sector_size >> (8 * 3);
2743 rbuf[ 9] = sector_size >> (8 * 2);
2744 rbuf[10] = sector_size >> (8 * 1);
2745 rbuf[11] = sector_size;
2747 rbuf[12] = 0;
2748 rbuf[13] = log2_per_phys;
2749 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2750 rbuf[15] = lowest_aligned;
2752 if (ata_id_has_trim(args->id) &&
2753 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2754 rbuf[14] |= 0x80; /* LBPME */
2756 if (ata_id_has_zero_after_trim(args->id) &&
2757 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2758 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2759 rbuf[14] |= 0x40; /* LBPRZ */
2762 if (ata_id_zoned_cap(args->id) ||
2763 args->dev->class == ATA_DEV_ZAC)
2764 rbuf[12] = (1 << 4); /* RC_BASIS */
2766 return 0;
2770 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2771 * @args: device IDENTIFY data / SCSI command of interest.
2772 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2774 * Simulate REPORT LUNS command.
2776 * LOCKING:
2777 * spin_lock_irqsave(host lock)
2779 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2781 VPRINTK("ENTER\n");
2782 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2784 return 0;
2787 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2789 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2790 /* FIXME: not quite right; we don't want the
2791 * translation of taskfile registers into
2792 * a sense descriptors, since that's only
2793 * correct for ATA, not ATAPI
2795 ata_gen_passthru_sense(qc);
2798 ata_qc_done(qc);
2801 /* is it pointless to prefer PIO for "safety reasons"? */
2802 static inline int ata_pio_use_silly(struct ata_port *ap)
2804 return (ap->flags & ATA_FLAG_PIO_DMA);
2807 static void atapi_request_sense(struct ata_queued_cmd *qc)
2809 struct ata_port *ap = qc->ap;
2810 struct scsi_cmnd *cmd = qc->scsicmd;
2812 DPRINTK("ATAPI request sense\n");
2814 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2816 #ifdef CONFIG_ATA_SFF
2817 if (ap->ops->sff_tf_read)
2818 ap->ops->sff_tf_read(ap, &qc->tf);
2819 #endif
2821 /* fill these in, for the case where they are -not- overwritten */
2822 cmd->sense_buffer[0] = 0x70;
2823 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2825 ata_qc_reinit(qc);
2827 /* setup sg table and init transfer direction */
2828 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2829 ata_sg_init(qc, &qc->sgent, 1);
2830 qc->dma_dir = DMA_FROM_DEVICE;
2832 memset(&qc->cdb, 0, qc->dev->cdb_len);
2833 qc->cdb[0] = REQUEST_SENSE;
2834 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2836 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2837 qc->tf.command = ATA_CMD_PACKET;
2839 if (ata_pio_use_silly(ap)) {
2840 qc->tf.protocol = ATAPI_PROT_DMA;
2841 qc->tf.feature |= ATAPI_PKT_DMA;
2842 } else {
2843 qc->tf.protocol = ATAPI_PROT_PIO;
2844 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2845 qc->tf.lbah = 0;
2847 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2849 qc->complete_fn = atapi_sense_complete;
2851 ata_qc_issue(qc);
2853 DPRINTK("EXIT\n");
2857 * ATAPI devices typically report zero for their SCSI version, and sometimes
2858 * deviate from the spec WRT response data format. If SCSI version is
2859 * reported as zero like normal, then we make the following fixups:
2860 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2861 * modern device.
2862 * 2) Ensure response data format / ATAPI information are always correct.
2864 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2866 u8 buf[4];
2868 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2869 if (buf[2] == 0) {
2870 buf[2] = 0x5;
2871 buf[3] = 0x32;
2873 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2876 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2878 struct scsi_cmnd *cmd = qc->scsicmd;
2879 unsigned int err_mask = qc->err_mask;
2881 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2883 /* handle completion from new EH */
2884 if (unlikely(qc->ap->ops->error_handler &&
2885 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2887 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2888 /* FIXME: not quite right; we don't want the
2889 * translation of taskfile registers into a
2890 * sense descriptors, since that's only
2891 * correct for ATA, not ATAPI
2893 ata_gen_passthru_sense(qc);
2896 /* SCSI EH automatically locks door if sdev->locked is
2897 * set. Sometimes door lock request continues to
2898 * fail, for example, when no media is present. This
2899 * creates a loop - SCSI EH issues door lock which
2900 * fails and gets invoked again to acquire sense data
2901 * for the failed command.
2903 * If door lock fails, always clear sdev->locked to
2904 * avoid this infinite loop.
2906 * This may happen before SCSI scan is complete. Make
2907 * sure qc->dev->sdev isn't NULL before dereferencing.
2909 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2910 qc->dev->sdev->locked = 0;
2912 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2913 ata_qc_done(qc);
2914 return;
2917 /* successful completion or old EH failure path */
2918 if (unlikely(err_mask & AC_ERR_DEV)) {
2919 cmd->result = SAM_STAT_CHECK_CONDITION;
2920 atapi_request_sense(qc);
2921 return;
2922 } else if (unlikely(err_mask)) {
2923 /* FIXME: not quite right; we don't want the
2924 * translation of taskfile registers into
2925 * a sense descriptors, since that's only
2926 * correct for ATA, not ATAPI
2928 ata_gen_passthru_sense(qc);
2929 } else {
2930 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2931 atapi_fixup_inquiry(cmd);
2932 cmd->result = SAM_STAT_GOOD;
2935 ata_qc_done(qc);
2938 * atapi_xlat - Initialize PACKET taskfile
2939 * @qc: command structure to be initialized
2941 * LOCKING:
2942 * spin_lock_irqsave(host lock)
2944 * RETURNS:
2945 * Zero on success, non-zero on failure.
2947 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2949 struct scsi_cmnd *scmd = qc->scsicmd;
2950 struct ata_device *dev = qc->dev;
2951 int nodata = (scmd->sc_data_direction == DMA_NONE);
2952 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2953 unsigned int nbytes;
2955 memset(qc->cdb, 0, dev->cdb_len);
2956 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2958 qc->complete_fn = atapi_qc_complete;
2960 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2961 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2962 qc->tf.flags |= ATA_TFLAG_WRITE;
2963 DPRINTK("direction: write\n");
2966 qc->tf.command = ATA_CMD_PACKET;
2967 ata_qc_set_pc_nbytes(qc);
2969 /* check whether ATAPI DMA is safe */
2970 if (!nodata && !using_pio && atapi_check_dma(qc))
2971 using_pio = 1;
2973 /* Some controller variants snoop this value for Packet
2974 * transfers to do state machine and FIFO management. Thus we
2975 * want to set it properly, and for DMA where it is
2976 * effectively meaningless.
2978 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2980 /* Most ATAPI devices which honor transfer chunk size don't
2981 * behave according to the spec when odd chunk size which
2982 * matches the transfer length is specified. If the number of
2983 * bytes to transfer is 2n+1. According to the spec, what
2984 * should happen is to indicate that 2n+1 is going to be
2985 * transferred and transfer 2n+2 bytes where the last byte is
2986 * padding.
2988 * In practice, this doesn't happen. ATAPI devices first
2989 * indicate and transfer 2n bytes and then indicate and
2990 * transfer 2 bytes where the last byte is padding.
2992 * This inconsistency confuses several controllers which
2993 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2994 * These controllers use actual number of transferred bytes to
2995 * update DMA poitner and transfer of 4n+2 bytes make those
2996 * controller push DMA pointer by 4n+4 bytes because SATA data
2997 * FISes are aligned to 4 bytes. This causes data corruption
2998 * and buffer overrun.
3000 * Always setting nbytes to even number solves this problem
3001 * because then ATAPI devices don't have to split data at 2n
3002 * boundaries.
3004 if (nbytes & 0x1)
3005 nbytes++;
3007 qc->tf.lbam = (nbytes & 0xFF);
3008 qc->tf.lbah = (nbytes >> 8);
3010 if (nodata)
3011 qc->tf.protocol = ATAPI_PROT_NODATA;
3012 else if (using_pio)
3013 qc->tf.protocol = ATAPI_PROT_PIO;
3014 else {
3015 /* DMA data xfer */
3016 qc->tf.protocol = ATAPI_PROT_DMA;
3017 qc->tf.feature |= ATAPI_PKT_DMA;
3019 if ((dev->flags & ATA_DFLAG_DMADIR) &&
3020 (scmd->sc_data_direction != DMA_TO_DEVICE))
3021 /* some SATA bridges need us to indicate data xfer direction */
3022 qc->tf.feature |= ATAPI_DMADIR;
3026 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
3027 as ATAPI tape drives don't get this right otherwise */
3028 return 0;
3031 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
3033 if (!sata_pmp_attached(ap)) {
3034 if (likely(devno >= 0 &&
3035 devno < ata_link_max_devices(&ap->link)))
3036 return &ap->link.device[devno];
3037 } else {
3038 if (likely(devno >= 0 &&
3039 devno < ap->nr_pmp_links))
3040 return &ap->pmp_link[devno].device[0];
3043 return NULL;
3046 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
3047 const struct scsi_device *scsidev)
3049 int devno;
3051 /* skip commands not addressed to targets we simulate */
3052 if (!sata_pmp_attached(ap)) {
3053 if (unlikely(scsidev->channel || scsidev->lun))
3054 return NULL;
3055 devno = scsidev->id;
3056 } else {
3057 if (unlikely(scsidev->id || scsidev->lun))
3058 return NULL;
3059 devno = scsidev->channel;
3062 return ata_find_dev(ap, devno);
3066 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
3067 * @ap: ATA port to which the device is attached
3068 * @scsidev: SCSI device from which we derive the ATA device
3070 * Given various information provided in struct scsi_cmnd,
3071 * map that onto an ATA bus, and using that mapping
3072 * determine which ata_device is associated with the
3073 * SCSI command to be sent.
3075 * LOCKING:
3076 * spin_lock_irqsave(host lock)
3078 * RETURNS:
3079 * Associated ATA device, or %NULL if not found.
3081 static struct ata_device *
3082 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
3084 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
3086 if (unlikely(!dev || !ata_dev_enabled(dev)))
3087 return NULL;
3089 return dev;
3093 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
3094 * @byte1: Byte 1 from pass-thru CDB.
3096 * RETURNS:
3097 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
3099 static u8
3100 ata_scsi_map_proto(u8 byte1)
3102 switch((byte1 & 0x1e) >> 1) {
3103 case 3: /* Non-data */
3104 return ATA_PROT_NODATA;
3106 case 6: /* DMA */
3107 case 10: /* UDMA Data-in */
3108 case 11: /* UDMA Data-Out */
3109 return ATA_PROT_DMA;
3111 case 4: /* PIO Data-in */
3112 case 5: /* PIO Data-out */
3113 return ATA_PROT_PIO;
3115 case 12: /* FPDMA */
3116 return ATA_PROT_NCQ;
3118 case 0: /* Hard Reset */
3119 case 1: /* SRST */
3120 case 8: /* Device Diagnostic */
3121 case 9: /* Device Reset */
3122 case 7: /* DMA Queued */
3123 case 15: /* Return Response Info */
3124 default: /* Reserved */
3125 break;
3128 return ATA_PROT_UNKNOWN;
3132 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
3133 * @qc: command structure to be initialized
3135 * Handles either 12, 16, or 32-byte versions of the CDB.
3137 * RETURNS:
3138 * Zero on success, non-zero on failure.
3140 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
3142 struct ata_taskfile *tf = &(qc->tf);
3143 struct scsi_cmnd *scmd = qc->scsicmd;
3144 struct ata_device *dev = qc->dev;
3145 const u8 *cdb = scmd->cmnd;
3146 u16 fp;
3147 u16 cdb_offset = 0;
3149 /* 7Fh variable length cmd means a ata pass-thru(32) */
3150 if (cdb[0] == VARIABLE_LENGTH_CMD)
3151 cdb_offset = 9;
3153 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
3154 if (tf->protocol == ATA_PROT_UNKNOWN) {
3155 fp = 1;
3156 goto invalid_fld;
3159 if (ata_is_ncq(tf->protocol) && (cdb[2 + cdb_offset] & 0x3) == 0)
3160 tf->protocol = ATA_PROT_NCQ_NODATA;
3162 /* enable LBA */
3163 tf->flags |= ATA_TFLAG_LBA;
3166 * 12 and 16 byte CDBs use different offsets to
3167 * provide the various register values.
3169 if (cdb[0] == ATA_16) {
3171 * 16-byte CDB - may contain extended commands.
3173 * If that is the case, copy the upper byte register values.
3175 if (cdb[1] & 0x01) {
3176 tf->hob_feature = cdb[3];
3177 tf->hob_nsect = cdb[5];
3178 tf->hob_lbal = cdb[7];
3179 tf->hob_lbam = cdb[9];
3180 tf->hob_lbah = cdb[11];
3181 tf->flags |= ATA_TFLAG_LBA48;
3182 } else
3183 tf->flags &= ~ATA_TFLAG_LBA48;
3186 * Always copy low byte, device and command registers.
3188 tf->feature = cdb[4];
3189 tf->nsect = cdb[6];
3190 tf->lbal = cdb[8];
3191 tf->lbam = cdb[10];
3192 tf->lbah = cdb[12];
3193 tf->device = cdb[13];
3194 tf->command = cdb[14];
3195 } else if (cdb[0] == ATA_12) {
3197 * 12-byte CDB - incapable of extended commands.
3199 tf->flags &= ~ATA_TFLAG_LBA48;
3201 tf->feature = cdb[3];
3202 tf->nsect = cdb[4];
3203 tf->lbal = cdb[5];
3204 tf->lbam = cdb[6];
3205 tf->lbah = cdb[7];
3206 tf->device = cdb[8];
3207 tf->command = cdb[9];
3208 } else {
3210 * 32-byte CDB - may contain extended command fields.
3212 * If that is the case, copy the upper byte register values.
3214 if (cdb[10] & 0x01) {
3215 tf->hob_feature = cdb[20];
3216 tf->hob_nsect = cdb[22];
3217 tf->hob_lbal = cdb[16];
3218 tf->hob_lbam = cdb[15];
3219 tf->hob_lbah = cdb[14];
3220 tf->flags |= ATA_TFLAG_LBA48;
3221 } else
3222 tf->flags &= ~ATA_TFLAG_LBA48;
3224 tf->feature = cdb[21];
3225 tf->nsect = cdb[23];
3226 tf->lbal = cdb[19];
3227 tf->lbam = cdb[18];
3228 tf->lbah = cdb[17];
3229 tf->device = cdb[24];
3230 tf->command = cdb[25];
3231 tf->auxiliary = get_unaligned_be32(&cdb[28]);
3234 /* For NCQ commands copy the tag value */
3235 if (ata_is_ncq(tf->protocol))
3236 tf->nsect = qc->tag << 3;
3238 /* enforce correct master/slave bit */
3239 tf->device = dev->devno ?
3240 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3242 switch (tf->command) {
3243 /* READ/WRITE LONG use a non-standard sect_size */
3244 case ATA_CMD_READ_LONG:
3245 case ATA_CMD_READ_LONG_ONCE:
3246 case ATA_CMD_WRITE_LONG:
3247 case ATA_CMD_WRITE_LONG_ONCE:
3248 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3249 fp = 1;
3250 goto invalid_fld;
3252 qc->sect_size = scsi_bufflen(scmd);
3253 break;
3255 /* commands using reported Logical Block size (e.g. 512 or 4K) */
3256 case ATA_CMD_CFA_WRITE_NE:
3257 case ATA_CMD_CFA_TRANS_SECT:
3258 case ATA_CMD_CFA_WRITE_MULT_NE:
3259 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3260 case ATA_CMD_READ:
3261 case ATA_CMD_READ_EXT:
3262 case ATA_CMD_READ_QUEUED:
3263 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3264 case ATA_CMD_FPDMA_READ:
3265 case ATA_CMD_READ_MULTI:
3266 case ATA_CMD_READ_MULTI_EXT:
3267 case ATA_CMD_PIO_READ:
3268 case ATA_CMD_PIO_READ_EXT:
3269 case ATA_CMD_READ_STREAM_DMA_EXT:
3270 case ATA_CMD_READ_STREAM_EXT:
3271 case ATA_CMD_VERIFY:
3272 case ATA_CMD_VERIFY_EXT:
3273 case ATA_CMD_WRITE:
3274 case ATA_CMD_WRITE_EXT:
3275 case ATA_CMD_WRITE_FUA_EXT:
3276 case ATA_CMD_WRITE_QUEUED:
3277 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3278 case ATA_CMD_FPDMA_WRITE:
3279 case ATA_CMD_WRITE_MULTI:
3280 case ATA_CMD_WRITE_MULTI_EXT:
3281 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3282 case ATA_CMD_PIO_WRITE:
3283 case ATA_CMD_PIO_WRITE_EXT:
3284 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3285 case ATA_CMD_WRITE_STREAM_EXT:
3286 qc->sect_size = scmd->device->sector_size;
3287 break;
3289 /* Everything else uses 512 byte "sectors" */
3290 default:
3291 qc->sect_size = ATA_SECT_SIZE;
3295 * Set flags so that all registers will be written, pass on
3296 * write indication (used for PIO/DMA setup), result TF is
3297 * copied back and we don't whine too much about its failure.
3299 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3300 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3301 tf->flags |= ATA_TFLAG_WRITE;
3303 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3306 * Set transfer length.
3308 * TODO: find out if we need to do more here to
3309 * cover scatter/gather case.
3311 ata_qc_set_pc_nbytes(qc);
3313 /* We may not issue DMA commands if no DMA mode is set */
3314 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3315 fp = 1;
3316 goto invalid_fld;
3319 /* We may not issue NCQ commands to devices not supporting NCQ */
3320 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3321 fp = 1;
3322 goto invalid_fld;
3325 /* sanity check for pio multi commands */
3326 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3327 fp = 1;
3328 goto invalid_fld;
3331 if (is_multi_taskfile(tf)) {
3332 unsigned int multi_count = 1 << (cdb[1] >> 5);
3334 /* compare the passed through multi_count
3335 * with the cached multi_count of libata
3337 if (multi_count != dev->multi_count)
3338 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3339 multi_count);
3343 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3344 * SET_FEATURES - XFER MODE must be preceded/succeeded
3345 * by an update to hardware-specific registers for each
3346 * controller (i.e. the reason for ->set_piomode(),
3347 * ->set_dmamode(), and ->post_set_mode() hooks).
3349 if (tf->command == ATA_CMD_SET_FEATURES &&
3350 tf->feature == SETFEATURES_XFER) {
3351 fp = (cdb[0] == ATA_16) ? 4 : 3;
3352 goto invalid_fld;
3356 * Filter TPM commands by default. These provide an
3357 * essentially uncontrolled encrypted "back door" between
3358 * applications and the disk. Set libata.allow_tpm=1 if you
3359 * have a real reason for wanting to use them. This ensures
3360 * that installed software cannot easily mess stuff up without
3361 * user intent. DVR type users will probably ship with this enabled
3362 * for movie content management.
3364 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3365 * for this and should do in future but that it is not sufficient as
3366 * DCS is an optional feature set. Thus we also do the software filter
3367 * so that we comply with the TC consortium stated goal that the user
3368 * can turn off TC features of their system.
3370 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3371 fp = (cdb[0] == ATA_16) ? 14 : 9;
3372 goto invalid_fld;
3375 return 0;
3377 invalid_fld:
3378 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3379 return 1;
3383 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3384 * @cmd: SCSI command being translated
3385 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3386 * @sector: Starting sector
3387 * @count: Total Range of request in logical sectors
3389 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3390 * descriptor.
3392 * Upto 64 entries of the format:
3393 * 63:48 Range Length
3394 * 47:0 LBA
3396 * Range Length of 0 is ignored.
3397 * LBA's should be sorted order and not overlap.
3399 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3401 * Return: Number of bytes copied into sglist.
3403 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3404 u64 sector, u32 count)
3406 struct scsi_device *sdp = cmd->device;
3407 size_t len = sdp->sector_size;
3408 size_t r;
3409 __le64 *buf;
3410 u32 i = 0;
3411 unsigned long flags;
3413 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3415 if (len > ATA_SCSI_RBUF_SIZE)
3416 len = ATA_SCSI_RBUF_SIZE;
3418 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3419 buf = ((void *)ata_scsi_rbuf);
3420 memset(buf, 0, len);
3421 while (i < trmax) {
3422 u64 entry = sector |
3423 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3424 buf[i++] = __cpu_to_le64(entry);
3425 if (count <= 0xffff)
3426 break;
3427 count -= 0xffff;
3428 sector += 0xffff;
3430 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3431 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3433 return r;
3437 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3438 * @qc: Command to be translated
3440 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3441 * an SCT Write Same command.
3442 * Based on WRITE SAME has the UNMAP flag:
3444 * - When set translate to DSM TRIM
3445 * - When clear translate to SCT Write Same
3447 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3449 struct ata_taskfile *tf = &qc->tf;
3450 struct scsi_cmnd *scmd = qc->scsicmd;
3451 struct scsi_device *sdp = scmd->device;
3452 size_t len = sdp->sector_size;
3453 struct ata_device *dev = qc->dev;
3454 const u8 *cdb = scmd->cmnd;
3455 u64 block;
3456 u32 n_block;
3457 const u32 trmax = len >> 3;
3458 u32 size;
3459 u16 fp;
3460 u8 bp = 0xff;
3461 u8 unmap = cdb[1] & 0x8;
3463 /* we may not issue DMA commands if no DMA mode is set */
3464 if (unlikely(!dev->dma_mode))
3465 goto invalid_opcode;
3468 * We only allow sending this command through the block layer,
3469 * as it modifies the DATA OUT buffer, which would corrupt user
3470 * memory for SG_IO commands.
3472 if (unlikely(blk_rq_is_passthrough(scmd->request)))
3473 goto invalid_opcode;
3475 if (unlikely(scmd->cmd_len < 16)) {
3476 fp = 15;
3477 goto invalid_fld;
3479 scsi_16_lba_len(cdb, &block, &n_block);
3481 if (!unmap ||
3482 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3483 !ata_id_has_trim(dev->id)) {
3484 fp = 1;
3485 bp = 3;
3486 goto invalid_fld;
3488 /* If the request is too large the cmd is invalid */
3489 if (n_block > 0xffff * trmax) {
3490 fp = 2;
3491 goto invalid_fld;
3495 * WRITE SAME always has a sector sized buffer as payload, this
3496 * should never be a multiple entry S/G list.
3498 if (!scsi_sg_count(scmd))
3499 goto invalid_param_len;
3502 * size must match sector size in bytes
3503 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3504 * is defined as number of 512 byte blocks to be transferred.
3507 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3508 if (size != len)
3509 goto invalid_param_len;
3511 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3512 /* Newer devices support queued TRIM commands */
3513 tf->protocol = ATA_PROT_NCQ;
3514 tf->command = ATA_CMD_FPDMA_SEND;
3515 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3516 tf->nsect = qc->tag << 3;
3517 tf->hob_feature = (size / 512) >> 8;
3518 tf->feature = size / 512;
3520 tf->auxiliary = 1;
3521 } else {
3522 tf->protocol = ATA_PROT_DMA;
3523 tf->hob_feature = 0;
3524 tf->feature = ATA_DSM_TRIM;
3525 tf->hob_nsect = (size / 512) >> 8;
3526 tf->nsect = size / 512;
3527 tf->command = ATA_CMD_DSM;
3530 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3531 ATA_TFLAG_WRITE;
3533 ata_qc_set_pc_nbytes(qc);
3535 return 0;
3537 invalid_fld:
3538 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3539 return 1;
3540 invalid_param_len:
3541 /* "Parameter list length error" */
3542 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3543 return 1;
3544 invalid_opcode:
3545 /* "Invalid command operation code" */
3546 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3547 return 1;
3551 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3552 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3553 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3555 * Yields a subset to satisfy scsi_report_opcode()
3557 * LOCKING:
3558 * spin_lock_irqsave(host lock)
3560 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3562 struct ata_device *dev = args->dev;
3563 u8 *cdb = args->cmd->cmnd;
3564 u8 supported = 0;
3565 unsigned int err = 0;
3567 if (cdb[2] != 1) {
3568 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3569 err = 2;
3570 goto out;
3572 switch (cdb[3]) {
3573 case INQUIRY:
3574 case MODE_SENSE:
3575 case MODE_SENSE_10:
3576 case READ_CAPACITY:
3577 case SERVICE_ACTION_IN_16:
3578 case REPORT_LUNS:
3579 case REQUEST_SENSE:
3580 case SYNCHRONIZE_CACHE:
3581 case REZERO_UNIT:
3582 case SEEK_6:
3583 case SEEK_10:
3584 case TEST_UNIT_READY:
3585 case SEND_DIAGNOSTIC:
3586 case MAINTENANCE_IN:
3587 case READ_6:
3588 case READ_10:
3589 case READ_16:
3590 case WRITE_6:
3591 case WRITE_10:
3592 case WRITE_16:
3593 case ATA_12:
3594 case ATA_16:
3595 case VERIFY:
3596 case VERIFY_16:
3597 case MODE_SELECT:
3598 case MODE_SELECT_10:
3599 case START_STOP:
3600 supported = 3;
3601 break;
3602 case ZBC_IN:
3603 case ZBC_OUT:
3604 if (ata_id_zoned_cap(dev->id) ||
3605 dev->class == ATA_DEV_ZAC)
3606 supported = 3;
3607 break;
3608 case SECURITY_PROTOCOL_IN:
3609 case SECURITY_PROTOCOL_OUT:
3610 if (dev->flags & ATA_DFLAG_TRUSTED)
3611 supported = 3;
3612 break;
3613 default:
3614 break;
3616 out:
3617 rbuf[1] = supported; /* supported */
3618 return err;
3622 * ata_scsi_report_zones_complete - convert ATA output
3623 * @qc: command structure returning the data
3625 * Convert T-13 little-endian field representation into
3626 * T-10 big-endian field representation.
3627 * What a mess.
3629 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3631 struct scsi_cmnd *scmd = qc->scsicmd;
3632 struct sg_mapping_iter miter;
3633 unsigned long flags;
3634 unsigned int bytes = 0;
3636 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3637 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3639 local_irq_save(flags);
3640 while (sg_miter_next(&miter)) {
3641 unsigned int offset = 0;
3643 if (bytes == 0) {
3644 char *hdr;
3645 u32 list_length;
3646 u64 max_lba, opt_lba;
3647 u16 same;
3649 /* Swizzle header */
3650 hdr = miter.addr;
3651 list_length = get_unaligned_le32(&hdr[0]);
3652 same = get_unaligned_le16(&hdr[4]);
3653 max_lba = get_unaligned_le64(&hdr[8]);
3654 opt_lba = get_unaligned_le64(&hdr[16]);
3655 put_unaligned_be32(list_length, &hdr[0]);
3656 hdr[4] = same & 0xf;
3657 put_unaligned_be64(max_lba, &hdr[8]);
3658 put_unaligned_be64(opt_lba, &hdr[16]);
3659 offset += 64;
3660 bytes += 64;
3662 while (offset < miter.length) {
3663 char *rec;
3664 u8 cond, type, non_seq, reset;
3665 u64 size, start, wp;
3667 /* Swizzle zone descriptor */
3668 rec = miter.addr + offset;
3669 type = rec[0] & 0xf;
3670 cond = (rec[1] >> 4) & 0xf;
3671 non_seq = (rec[1] & 2);
3672 reset = (rec[1] & 1);
3673 size = get_unaligned_le64(&rec[8]);
3674 start = get_unaligned_le64(&rec[16]);
3675 wp = get_unaligned_le64(&rec[24]);
3676 rec[0] = type;
3677 rec[1] = (cond << 4) | non_seq | reset;
3678 put_unaligned_be64(size, &rec[8]);
3679 put_unaligned_be64(start, &rec[16]);
3680 put_unaligned_be64(wp, &rec[24]);
3681 WARN_ON(offset + 64 > miter.length);
3682 offset += 64;
3683 bytes += 64;
3686 sg_miter_stop(&miter);
3687 local_irq_restore(flags);
3689 ata_scsi_qc_complete(qc);
3692 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3694 struct ata_taskfile *tf = &qc->tf;
3695 struct scsi_cmnd *scmd = qc->scsicmd;
3696 const u8 *cdb = scmd->cmnd;
3697 u16 sect, fp = (u16)-1;
3698 u8 sa, options, bp = 0xff;
3699 u64 block;
3700 u32 n_block;
3702 if (unlikely(scmd->cmd_len < 16)) {
3703 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3704 scmd->cmd_len);
3705 fp = 15;
3706 goto invalid_fld;
3708 scsi_16_lba_len(cdb, &block, &n_block);
3709 if (n_block != scsi_bufflen(scmd)) {
3710 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3711 n_block, scsi_bufflen(scmd));
3712 goto invalid_param_len;
3714 sa = cdb[1] & 0x1f;
3715 if (sa != ZI_REPORT_ZONES) {
3716 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3717 fp = 1;
3718 goto invalid_fld;
3721 * ZAC allows only for transfers in 512 byte blocks,
3722 * and uses a 16 bit value for the transfer count.
3724 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3725 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3726 goto invalid_param_len;
3728 sect = n_block / 512;
3729 options = cdb[14] & 0xbf;
3731 if (ata_ncq_enabled(qc->dev) &&
3732 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3733 tf->protocol = ATA_PROT_NCQ;
3734 tf->command = ATA_CMD_FPDMA_RECV;
3735 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3736 tf->nsect = qc->tag << 3;
3737 tf->feature = sect & 0xff;
3738 tf->hob_feature = (sect >> 8) & 0xff;
3739 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3740 } else {
3741 tf->command = ATA_CMD_ZAC_MGMT_IN;
3742 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3743 tf->protocol = ATA_PROT_DMA;
3744 tf->hob_feature = options;
3745 tf->hob_nsect = (sect >> 8) & 0xff;
3746 tf->nsect = sect & 0xff;
3748 tf->device = ATA_LBA;
3749 tf->lbah = (block >> 16) & 0xff;
3750 tf->lbam = (block >> 8) & 0xff;
3751 tf->lbal = block & 0xff;
3752 tf->hob_lbah = (block >> 40) & 0xff;
3753 tf->hob_lbam = (block >> 32) & 0xff;
3754 tf->hob_lbal = (block >> 24) & 0xff;
3756 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3757 qc->flags |= ATA_QCFLAG_RESULT_TF;
3759 ata_qc_set_pc_nbytes(qc);
3761 qc->complete_fn = ata_scsi_report_zones_complete;
3763 return 0;
3765 invalid_fld:
3766 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3767 return 1;
3769 invalid_param_len:
3770 /* "Parameter list length error" */
3771 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3772 return 1;
3775 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3777 struct ata_taskfile *tf = &qc->tf;
3778 struct scsi_cmnd *scmd = qc->scsicmd;
3779 struct ata_device *dev = qc->dev;
3780 const u8 *cdb = scmd->cmnd;
3781 u8 all, sa;
3782 u64 block;
3783 u32 n_block;
3784 u16 fp = (u16)-1;
3786 if (unlikely(scmd->cmd_len < 16)) {
3787 fp = 15;
3788 goto invalid_fld;
3791 sa = cdb[1] & 0x1f;
3792 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3793 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3794 fp = 1;
3795 goto invalid_fld;
3798 scsi_16_lba_len(cdb, &block, &n_block);
3799 if (n_block) {
3801 * ZAC MANAGEMENT OUT doesn't define any length
3803 goto invalid_param_len;
3805 if (block > dev->n_sectors)
3806 goto out_of_range;
3808 all = cdb[14] & 0x1;
3810 if (ata_ncq_enabled(qc->dev) &&
3811 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3812 tf->protocol = ATA_PROT_NCQ_NODATA;
3813 tf->command = ATA_CMD_NCQ_NON_DATA;
3814 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3815 tf->nsect = qc->tag << 3;
3816 tf->auxiliary = sa | ((u16)all << 8);
3817 } else {
3818 tf->protocol = ATA_PROT_NODATA;
3819 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3820 tf->feature = sa;
3821 tf->hob_feature = all;
3823 tf->lbah = (block >> 16) & 0xff;
3824 tf->lbam = (block >> 8) & 0xff;
3825 tf->lbal = block & 0xff;
3826 tf->hob_lbah = (block >> 40) & 0xff;
3827 tf->hob_lbam = (block >> 32) & 0xff;
3828 tf->hob_lbal = (block >> 24) & 0xff;
3829 tf->device = ATA_LBA;
3830 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3832 return 0;
3834 invalid_fld:
3835 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3836 return 1;
3837 out_of_range:
3838 /* "Logical Block Address out of range" */
3839 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x00);
3840 return 1;
3841 invalid_param_len:
3842 /* "Parameter list length error" */
3843 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3844 return 1;
3848 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3849 * @qc: Storage for translated ATA taskfile
3850 * @buf: input buffer
3851 * @len: number of valid bytes in the input buffer
3852 * @fp: out parameter for the failed field on error
3854 * Prepare a taskfile to modify caching information for the device.
3856 * LOCKING:
3857 * None.
3859 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3860 const u8 *buf, int len, u16 *fp)
3862 struct ata_taskfile *tf = &qc->tf;
3863 struct ata_device *dev = qc->dev;
3864 u8 mpage[CACHE_MPAGE_LEN];
3865 u8 wce;
3866 int i;
3869 * The first two bytes of def_cache_mpage are a header, so offsets
3870 * in mpage are off by 2 compared to buf. Same for len.
3873 if (len != CACHE_MPAGE_LEN - 2) {
3874 if (len < CACHE_MPAGE_LEN - 2)
3875 *fp = len;
3876 else
3877 *fp = CACHE_MPAGE_LEN - 2;
3878 return -EINVAL;
3881 wce = buf[0] & (1 << 2);
3884 * Check that read-only bits are not modified.
3886 ata_msense_caching(dev->id, mpage, false);
3887 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3888 if (i == 0)
3889 continue;
3890 if (mpage[i + 2] != buf[i]) {
3891 *fp = i;
3892 return -EINVAL;
3896 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3897 tf->protocol = ATA_PROT_NODATA;
3898 tf->nsect = 0;
3899 tf->command = ATA_CMD_SET_FEATURES;
3900 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3901 return 0;
3905 * ata_mselect_control - Simulate MODE SELECT for control page
3906 * @qc: Storage for translated ATA taskfile
3907 * @buf: input buffer
3908 * @len: number of valid bytes in the input buffer
3909 * @fp: out parameter for the failed field on error
3911 * Prepare a taskfile to modify caching information for the device.
3913 * LOCKING:
3914 * None.
3916 static int ata_mselect_control(struct ata_queued_cmd *qc,
3917 const u8 *buf, int len, u16 *fp)
3919 struct ata_device *dev = qc->dev;
3920 u8 mpage[CONTROL_MPAGE_LEN];
3921 u8 d_sense;
3922 int i;
3925 * The first two bytes of def_control_mpage are a header, so offsets
3926 * in mpage are off by 2 compared to buf. Same for len.
3929 if (len != CONTROL_MPAGE_LEN - 2) {
3930 if (len < CONTROL_MPAGE_LEN - 2)
3931 *fp = len;
3932 else
3933 *fp = CONTROL_MPAGE_LEN - 2;
3934 return -EINVAL;
3937 d_sense = buf[0] & (1 << 2);
3940 * Check that read-only bits are not modified.
3942 ata_msense_control(dev, mpage, false);
3943 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3944 if (i == 0)
3945 continue;
3946 if (mpage[2 + i] != buf[i]) {
3947 *fp = i;
3948 return -EINVAL;
3951 if (d_sense & (1 << 2))
3952 dev->flags |= ATA_DFLAG_D_SENSE;
3953 else
3954 dev->flags &= ~ATA_DFLAG_D_SENSE;
3955 return 0;
3959 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3960 * @qc: Storage for translated ATA taskfile
3962 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3963 * Assume this is invoked for direct access devices (e.g. disks) only.
3964 * There should be no block descriptor for other device types.
3966 * LOCKING:
3967 * spin_lock_irqsave(host lock)
3969 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3971 struct scsi_cmnd *scmd = qc->scsicmd;
3972 const u8 *cdb = scmd->cmnd;
3973 const u8 *p;
3974 u8 pg, spg;
3975 unsigned six_byte, pg_len, hdr_len, bd_len;
3976 int len;
3977 u16 fp = (u16)-1;
3978 u8 bp = 0xff;
3980 VPRINTK("ENTER\n");
3982 six_byte = (cdb[0] == MODE_SELECT);
3983 if (six_byte) {
3984 if (scmd->cmd_len < 5) {
3985 fp = 4;
3986 goto invalid_fld;
3989 len = cdb[4];
3990 hdr_len = 4;
3991 } else {
3992 if (scmd->cmd_len < 9) {
3993 fp = 8;
3994 goto invalid_fld;
3997 len = (cdb[7] << 8) + cdb[8];
3998 hdr_len = 8;
4001 /* We only support PF=1, SP=0. */
4002 if ((cdb[1] & 0x11) != 0x10) {
4003 fp = 1;
4004 bp = (cdb[1] & 0x01) ? 1 : 5;
4005 goto invalid_fld;
4008 /* Test early for possible overrun. */
4009 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
4010 goto invalid_param_len;
4012 p = page_address(sg_page(scsi_sglist(scmd)));
4014 /* Move past header and block descriptors. */
4015 if (len < hdr_len)
4016 goto invalid_param_len;
4018 if (six_byte)
4019 bd_len = p[3];
4020 else
4021 bd_len = (p[6] << 8) + p[7];
4023 len -= hdr_len;
4024 p += hdr_len;
4025 if (len < bd_len)
4026 goto invalid_param_len;
4027 if (bd_len != 0 && bd_len != 8) {
4028 fp = (six_byte) ? 3 : 6;
4029 fp += bd_len + hdr_len;
4030 goto invalid_param;
4033 len -= bd_len;
4034 p += bd_len;
4035 if (len == 0)
4036 goto skip;
4038 /* Parse both possible formats for the mode page headers. */
4039 pg = p[0] & 0x3f;
4040 if (p[0] & 0x40) {
4041 if (len < 4)
4042 goto invalid_param_len;
4044 spg = p[1];
4045 pg_len = (p[2] << 8) | p[3];
4046 p += 4;
4047 len -= 4;
4048 } else {
4049 if (len < 2)
4050 goto invalid_param_len;
4052 spg = 0;
4053 pg_len = p[1];
4054 p += 2;
4055 len -= 2;
4059 * No mode subpages supported (yet) but asking for _all_
4060 * subpages may be valid
4062 if (spg && (spg != ALL_SUB_MPAGES)) {
4063 fp = (p[0] & 0x40) ? 1 : 0;
4064 fp += hdr_len + bd_len;
4065 goto invalid_param;
4067 if (pg_len > len)
4068 goto invalid_param_len;
4070 switch (pg) {
4071 case CACHE_MPAGE:
4072 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4073 fp += hdr_len + bd_len;
4074 goto invalid_param;
4076 break;
4077 case CONTROL_MPAGE:
4078 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
4079 fp += hdr_len + bd_len;
4080 goto invalid_param;
4081 } else {
4082 goto skip; /* No ATA command to send */
4084 break;
4085 default: /* invalid page code */
4086 fp = bd_len + hdr_len;
4087 goto invalid_param;
4091 * Only one page has changeable data, so we only support setting one
4092 * page at a time.
4094 if (len > pg_len)
4095 goto invalid_param;
4097 return 0;
4099 invalid_fld:
4100 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4101 return 1;
4103 invalid_param:
4104 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4105 return 1;
4107 invalid_param_len:
4108 /* "Parameter list length error" */
4109 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4110 return 1;
4112 skip:
4113 scmd->result = SAM_STAT_GOOD;
4114 return 1;
4117 static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
4119 if (len == 0)
4120 return ATA_CMD_TRUSTED_NONDATA;
4121 else if (send)
4122 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
4123 else
4124 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
4127 static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
4129 struct scsi_cmnd *scmd = qc->scsicmd;
4130 const u8 *cdb = scmd->cmnd;
4131 struct ata_taskfile *tf = &qc->tf;
4132 u8 secp = cdb[1];
4133 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
4134 u16 spsp = get_unaligned_be16(&cdb[2]);
4135 u32 len = get_unaligned_be32(&cdb[6]);
4136 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
4139 * We don't support the ATA "security" protocol.
4141 if (secp == 0xef) {
4142 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
4143 return 1;
4146 if (cdb[4] & 7) { /* INC_512 */
4147 if (len > 0xffff) {
4148 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4149 return 1;
4151 } else {
4152 if (len > 0x01fffe00) {
4153 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4154 return 1;
4157 /* convert to the sector-based ATA addressing */
4158 len = (len + 511) / 512;
4161 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
4162 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
4163 if (send)
4164 tf->flags |= ATA_TFLAG_WRITE;
4165 tf->command = ata_scsi_trusted_op(len, send, dma);
4166 tf->feature = secp;
4167 tf->lbam = spsp & 0xff;
4168 tf->lbah = spsp >> 8;
4170 if (len) {
4171 tf->nsect = len & 0xff;
4172 tf->lbal = len >> 8;
4173 } else {
4174 if (!send)
4175 tf->lbah = (1 << 7);
4178 ata_qc_set_pc_nbytes(qc);
4179 return 0;
4183 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
4184 * @qc: Command to be translated
4186 * Translate a SCSI variable length CDB to specified commands.
4187 * It checks a service action value in CDB to call corresponding handler.
4189 * RETURNS:
4190 * Zero on success, non-zero on failure
4193 static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
4195 struct scsi_cmnd *scmd = qc->scsicmd;
4196 const u8 *cdb = scmd->cmnd;
4197 const u16 sa = get_unaligned_be16(&cdb[8]);
4200 * if service action represents a ata pass-thru(32) command,
4201 * then pass it to ata_scsi_pass_thru handler.
4203 if (sa == ATA_32)
4204 return ata_scsi_pass_thru(qc);
4206 /* unsupported service action */
4207 return 1;
4211 * ata_get_xlat_func - check if SCSI to ATA translation is possible
4212 * @dev: ATA device
4213 * @cmd: SCSI command opcode to consider
4215 * Look up the SCSI command given, and determine whether the
4216 * SCSI command is to be translated or simulated.
4218 * RETURNS:
4219 * Pointer to translation function if possible, %NULL if not.
4222 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4224 switch (cmd) {
4225 case READ_6:
4226 case READ_10:
4227 case READ_16:
4229 case WRITE_6:
4230 case WRITE_10:
4231 case WRITE_16:
4232 return ata_scsi_rw_xlat;
4234 case WRITE_SAME_16:
4235 return ata_scsi_write_same_xlat;
4237 case SYNCHRONIZE_CACHE:
4238 if (ata_try_flush_cache(dev))
4239 return ata_scsi_flush_xlat;
4240 break;
4242 case VERIFY:
4243 case VERIFY_16:
4244 return ata_scsi_verify_xlat;
4246 case ATA_12:
4247 case ATA_16:
4248 return ata_scsi_pass_thru;
4250 case VARIABLE_LENGTH_CMD:
4251 return ata_scsi_var_len_cdb_xlat;
4253 case MODE_SELECT:
4254 case MODE_SELECT_10:
4255 return ata_scsi_mode_select_xlat;
4256 break;
4258 case ZBC_IN:
4259 return ata_scsi_zbc_in_xlat;
4261 case ZBC_OUT:
4262 return ata_scsi_zbc_out_xlat;
4264 case SECURITY_PROTOCOL_IN:
4265 case SECURITY_PROTOCOL_OUT:
4266 if (!(dev->flags & ATA_DFLAG_TRUSTED))
4267 break;
4268 return ata_scsi_security_inout_xlat;
4270 case START_STOP:
4271 return ata_scsi_start_stop_xlat;
4274 return NULL;
4278 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
4279 * @ap: ATA port to which the command was being sent
4280 * @cmd: SCSI command to dump
4282 * Prints the contents of a SCSI command via printk().
4285 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
4286 struct scsi_cmnd *cmd)
4288 #ifdef ATA_DEBUG
4289 struct scsi_device *scsidev = cmd->device;
4291 DPRINTK("CDB (%u:%d,%d,%lld) %9ph\n",
4292 ap->print_id,
4293 scsidev->channel, scsidev->id, scsidev->lun,
4294 cmd->cmnd);
4295 #endif
4298 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
4299 struct ata_device *dev)
4301 u8 scsi_op = scmd->cmnd[0];
4302 ata_xlat_func_t xlat_func;
4303 int rc = 0;
4305 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4306 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4307 goto bad_cdb_len;
4309 xlat_func = ata_get_xlat_func(dev, scsi_op);
4310 } else {
4311 if (unlikely(!scmd->cmd_len))
4312 goto bad_cdb_len;
4314 xlat_func = NULL;
4315 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4316 /* relay SCSI command to ATAPI device */
4317 int len = COMMAND_SIZE(scsi_op);
4318 if (unlikely(len > scmd->cmd_len ||
4319 len > dev->cdb_len ||
4320 scmd->cmd_len > ATAPI_CDB_LEN))
4321 goto bad_cdb_len;
4323 xlat_func = atapi_xlat;
4324 } else {
4325 /* ATA_16 passthru, treat as an ATA command */
4326 if (unlikely(scmd->cmd_len > 16))
4327 goto bad_cdb_len;
4329 xlat_func = ata_get_xlat_func(dev, scsi_op);
4333 if (xlat_func)
4334 rc = ata_scsi_translate(dev, scmd, xlat_func);
4335 else
4336 ata_scsi_simulate(dev, scmd);
4338 return rc;
4340 bad_cdb_len:
4341 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4342 scmd->cmd_len, scsi_op, dev->cdb_len);
4343 scmd->result = DID_ERROR << 16;
4344 scmd->scsi_done(scmd);
4345 return 0;
4349 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4350 * @shost: SCSI host of command to be sent
4351 * @cmd: SCSI command to be sent
4353 * In some cases, this function translates SCSI commands into
4354 * ATA taskfiles, and queues the taskfiles to be sent to
4355 * hardware. In other cases, this function simulates a
4356 * SCSI device by evaluating and responding to certain
4357 * SCSI commands. This creates the overall effect of
4358 * ATA and ATAPI devices appearing as SCSI devices.
4360 * LOCKING:
4361 * ATA host lock
4363 * RETURNS:
4364 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4365 * 0 otherwise.
4367 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4369 struct ata_port *ap;
4370 struct ata_device *dev;
4371 struct scsi_device *scsidev = cmd->device;
4372 int rc = 0;
4373 unsigned long irq_flags;
4375 ap = ata_shost_to_port(shost);
4377 spin_lock_irqsave(ap->lock, irq_flags);
4379 ata_scsi_dump_cdb(ap, cmd);
4381 dev = ata_scsi_find_dev(ap, scsidev);
4382 if (likely(dev))
4383 rc = __ata_scsi_queuecmd(cmd, dev);
4384 else {
4385 cmd->result = (DID_BAD_TARGET << 16);
4386 cmd->scsi_done(cmd);
4389 spin_unlock_irqrestore(ap->lock, irq_flags);
4391 return rc;
4395 * ata_scsi_simulate - simulate SCSI command on ATA device
4396 * @dev: the target device
4397 * @cmd: SCSI command being sent to device.
4399 * Interprets and directly executes a select list of SCSI commands
4400 * that can be handled internally.
4402 * LOCKING:
4403 * spin_lock_irqsave(host lock)
4406 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4408 struct ata_scsi_args args;
4409 const u8 *scsicmd = cmd->cmnd;
4410 u8 tmp8;
4412 args.dev = dev;
4413 args.id = dev->id;
4414 args.cmd = cmd;
4416 switch(scsicmd[0]) {
4417 case INQUIRY:
4418 if (scsicmd[1] & 2) /* is CmdDt set? */
4419 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4420 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4421 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4422 else switch (scsicmd[2]) {
4423 case 0x00:
4424 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4425 break;
4426 case 0x80:
4427 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4428 break;
4429 case 0x83:
4430 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4431 break;
4432 case 0x89:
4433 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4434 break;
4435 case 0xb0:
4436 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4437 break;
4438 case 0xb1:
4439 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4440 break;
4441 case 0xb2:
4442 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4443 break;
4444 case 0xb6:
4445 if (dev->flags & ATA_DFLAG_ZAC) {
4446 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4447 break;
4449 /* Fallthrough */
4450 default:
4451 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4452 break;
4454 break;
4456 case MODE_SENSE:
4457 case MODE_SENSE_10:
4458 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4459 break;
4461 case READ_CAPACITY:
4462 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4463 break;
4465 case SERVICE_ACTION_IN_16:
4466 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4467 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4468 else
4469 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4470 break;
4472 case REPORT_LUNS:
4473 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4474 break;
4476 case REQUEST_SENSE:
4477 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4478 cmd->result = (DRIVER_SENSE << 24);
4479 break;
4481 /* if we reach this, then writeback caching is disabled,
4482 * turning this into a no-op.
4484 case SYNCHRONIZE_CACHE:
4485 /* fall through */
4487 /* no-op's, complete with success */
4488 case REZERO_UNIT:
4489 case SEEK_6:
4490 case SEEK_10:
4491 case TEST_UNIT_READY:
4492 break;
4494 case SEND_DIAGNOSTIC:
4495 tmp8 = scsicmd[1] & ~(1 << 3);
4496 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4497 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4498 break;
4500 case MAINTENANCE_IN:
4501 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4502 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4503 else
4504 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4505 break;
4507 /* all other commands */
4508 default:
4509 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4510 /* "Invalid command operation code" */
4511 break;
4514 cmd->scsi_done(cmd);
4517 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4519 int i, rc;
4521 for (i = 0; i < host->n_ports; i++) {
4522 struct ata_port *ap = host->ports[i];
4523 struct Scsi_Host *shost;
4525 rc = -ENOMEM;
4526 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4527 if (!shost)
4528 goto err_alloc;
4530 shost->eh_noresume = 1;
4531 *(struct ata_port **)&shost->hostdata[0] = ap;
4532 ap->scsi_host = shost;
4534 shost->transportt = ata_scsi_transport_template;
4535 shost->unique_id = ap->print_id;
4536 shost->max_id = 16;
4537 shost->max_lun = 1;
4538 shost->max_channel = 1;
4539 shost->max_cmd_len = 32;
4541 /* Schedule policy is determined by ->qc_defer()
4542 * callback and it needs to see every deferred qc.
4543 * Set host_blocked to 1 to prevent SCSI midlayer from
4544 * automatically deferring requests.
4546 shost->max_host_blocked = 1;
4548 rc = scsi_add_host_with_dma(ap->scsi_host,
4549 &ap->tdev, ap->host->dev);
4550 if (rc)
4551 goto err_add;
4554 return 0;
4556 err_add:
4557 scsi_host_put(host->ports[i]->scsi_host);
4558 err_alloc:
4559 while (--i >= 0) {
4560 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4562 scsi_remove_host(shost);
4563 scsi_host_put(shost);
4565 return rc;
4568 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4570 int tries = 5;
4571 struct ata_device *last_failed_dev = NULL;
4572 struct ata_link *link;
4573 struct ata_device *dev;
4575 repeat:
4576 ata_for_each_link(link, ap, EDGE) {
4577 ata_for_each_dev(dev, link, ENABLED) {
4578 struct scsi_device *sdev;
4579 int channel = 0, id = 0;
4581 if (dev->sdev)
4582 continue;
4584 if (ata_is_host_link(link))
4585 id = dev->devno;
4586 else
4587 channel = link->pmp;
4589 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4590 NULL);
4591 if (!IS_ERR(sdev)) {
4592 dev->sdev = sdev;
4593 scsi_device_put(sdev);
4594 } else {
4595 dev->sdev = NULL;
4600 /* If we scanned while EH was in progress or allocation
4601 * failure occurred, scan would have failed silently. Check
4602 * whether all devices are attached.
4604 ata_for_each_link(link, ap, EDGE) {
4605 ata_for_each_dev(dev, link, ENABLED) {
4606 if (!dev->sdev)
4607 goto exit_loop;
4610 exit_loop:
4611 if (!link)
4612 return;
4614 /* we're missing some SCSI devices */
4615 if (sync) {
4616 /* If caller requested synchrnous scan && we've made
4617 * any progress, sleep briefly and repeat.
4619 if (dev != last_failed_dev) {
4620 msleep(100);
4621 last_failed_dev = dev;
4622 goto repeat;
4625 /* We might be failing to detect boot device, give it
4626 * a few more chances.
4628 if (--tries) {
4629 msleep(100);
4630 goto repeat;
4633 ata_port_err(ap,
4634 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4637 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4638 round_jiffies_relative(HZ));
4642 * ata_scsi_offline_dev - offline attached SCSI device
4643 * @dev: ATA device to offline attached SCSI device for
4645 * This function is called from ata_eh_hotplug() and responsible
4646 * for taking the SCSI device attached to @dev offline. This
4647 * function is called with host lock which protects dev->sdev
4648 * against clearing.
4650 * LOCKING:
4651 * spin_lock_irqsave(host lock)
4653 * RETURNS:
4654 * 1 if attached SCSI device exists, 0 otherwise.
4656 int ata_scsi_offline_dev(struct ata_device *dev)
4658 if (dev->sdev) {
4659 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4660 return 1;
4662 return 0;
4666 * ata_scsi_remove_dev - remove attached SCSI device
4667 * @dev: ATA device to remove attached SCSI device for
4669 * This function is called from ata_eh_scsi_hotplug() and
4670 * responsible for removing the SCSI device attached to @dev.
4672 * LOCKING:
4673 * Kernel thread context (may sleep).
4675 static void ata_scsi_remove_dev(struct ata_device *dev)
4677 struct ata_port *ap = dev->link->ap;
4678 struct scsi_device *sdev;
4679 unsigned long flags;
4681 /* Alas, we need to grab scan_mutex to ensure SCSI device
4682 * state doesn't change underneath us and thus
4683 * scsi_device_get() always succeeds. The mutex locking can
4684 * be removed if there is __scsi_device_get() interface which
4685 * increments reference counts regardless of device state.
4687 mutex_lock(&ap->scsi_host->scan_mutex);
4688 spin_lock_irqsave(ap->lock, flags);
4690 /* clearing dev->sdev is protected by host lock */
4691 sdev = dev->sdev;
4692 dev->sdev = NULL;
4694 if (sdev) {
4695 /* If user initiated unplug races with us, sdev can go
4696 * away underneath us after the host lock and
4697 * scan_mutex are released. Hold onto it.
4699 if (scsi_device_get(sdev) == 0) {
4700 /* The following ensures the attached sdev is
4701 * offline on return from ata_scsi_offline_dev()
4702 * regardless it wins or loses the race
4703 * against this function.
4705 scsi_device_set_state(sdev, SDEV_OFFLINE);
4706 } else {
4707 WARN_ON(1);
4708 sdev = NULL;
4712 spin_unlock_irqrestore(ap->lock, flags);
4713 mutex_unlock(&ap->scsi_host->scan_mutex);
4715 if (sdev) {
4716 ata_dev_info(dev, "detaching (SCSI %s)\n",
4717 dev_name(&sdev->sdev_gendev));
4719 scsi_remove_device(sdev);
4720 scsi_device_put(sdev);
4724 static void ata_scsi_handle_link_detach(struct ata_link *link)
4726 struct ata_port *ap = link->ap;
4727 struct ata_device *dev;
4729 ata_for_each_dev(dev, link, ALL) {
4730 unsigned long flags;
4732 if (!(dev->flags & ATA_DFLAG_DETACHED))
4733 continue;
4735 spin_lock_irqsave(ap->lock, flags);
4736 dev->flags &= ~ATA_DFLAG_DETACHED;
4737 spin_unlock_irqrestore(ap->lock, flags);
4739 if (zpodd_dev_enabled(dev))
4740 zpodd_exit(dev);
4742 ata_scsi_remove_dev(dev);
4747 * ata_scsi_media_change_notify - send media change event
4748 * @dev: Pointer to the disk device with media change event
4750 * Tell the block layer to send a media change notification
4751 * event.
4753 * LOCKING:
4754 * spin_lock_irqsave(host lock)
4756 void ata_scsi_media_change_notify(struct ata_device *dev)
4758 if (dev->sdev)
4759 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4760 GFP_ATOMIC);
4764 * ata_scsi_hotplug - SCSI part of hotplug
4765 * @work: Pointer to ATA port to perform SCSI hotplug on
4767 * Perform SCSI part of hotplug. It's executed from a separate
4768 * workqueue after EH completes. This is necessary because SCSI
4769 * hot plugging requires working EH and hot unplugging is
4770 * synchronized with hot plugging with a mutex.
4772 * LOCKING:
4773 * Kernel thread context (may sleep).
4775 void ata_scsi_hotplug(struct work_struct *work)
4777 struct ata_port *ap =
4778 container_of(work, struct ata_port, hotplug_task.work);
4779 int i;
4781 if (ap->pflags & ATA_PFLAG_UNLOADING) {
4782 DPRINTK("ENTER/EXIT - unloading\n");
4783 return;
4787 * XXX - UGLY HACK
4789 * The block layer suspend/resume path is fundamentally broken due
4790 * to freezable kthreads and workqueue and may deadlock if a block
4791 * device gets removed while resume is in progress. I don't know
4792 * what the solution is short of removing freezable kthreads and
4793 * workqueues altogether.
4795 * The following is an ugly hack to avoid kicking off device
4796 * removal while freezer is active. This is a joke but does avoid
4797 * this particular deadlock scenario.
4799 * https://bugzilla.kernel.org/show_bug.cgi?id=62801
4800 * http://marc.info/?l=linux-kernel&m=138695698516487
4802 #ifdef CONFIG_FREEZER
4803 while (pm_freezing)
4804 msleep(10);
4805 #endif
4807 DPRINTK("ENTER\n");
4808 mutex_lock(&ap->scsi_scan_mutex);
4810 /* Unplug detached devices. We cannot use link iterator here
4811 * because PMP links have to be scanned even if PMP is
4812 * currently not attached. Iterate manually.
4814 ata_scsi_handle_link_detach(&ap->link);
4815 if (ap->pmp_link)
4816 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4817 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4819 /* scan for new ones */
4820 ata_scsi_scan_host(ap, 0);
4822 mutex_unlock(&ap->scsi_scan_mutex);
4823 DPRINTK("EXIT\n");
4827 * ata_scsi_user_scan - indication for user-initiated bus scan
4828 * @shost: SCSI host to scan
4829 * @channel: Channel to scan
4830 * @id: ID to scan
4831 * @lun: LUN to scan
4833 * This function is called when user explicitly requests bus
4834 * scan. Set probe pending flag and invoke EH.
4836 * LOCKING:
4837 * SCSI layer (we don't care)
4839 * RETURNS:
4840 * Zero.
4842 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4843 unsigned int id, u64 lun)
4845 struct ata_port *ap = ata_shost_to_port(shost);
4846 unsigned long flags;
4847 int devno, rc = 0;
4849 if (!ap->ops->error_handler)
4850 return -EOPNOTSUPP;
4852 if (lun != SCAN_WILD_CARD && lun)
4853 return -EINVAL;
4855 if (!sata_pmp_attached(ap)) {
4856 if (channel != SCAN_WILD_CARD && channel)
4857 return -EINVAL;
4858 devno = id;
4859 } else {
4860 if (id != SCAN_WILD_CARD && id)
4861 return -EINVAL;
4862 devno = channel;
4865 spin_lock_irqsave(ap->lock, flags);
4867 if (devno == SCAN_WILD_CARD) {
4868 struct ata_link *link;
4870 ata_for_each_link(link, ap, EDGE) {
4871 struct ata_eh_info *ehi = &link->eh_info;
4872 ehi->probe_mask |= ATA_ALL_DEVICES;
4873 ehi->action |= ATA_EH_RESET;
4875 } else {
4876 struct ata_device *dev = ata_find_dev(ap, devno);
4878 if (dev) {
4879 struct ata_eh_info *ehi = &dev->link->eh_info;
4880 ehi->probe_mask |= 1 << dev->devno;
4881 ehi->action |= ATA_EH_RESET;
4882 } else
4883 rc = -EINVAL;
4886 if (rc == 0) {
4887 ata_port_schedule_eh(ap);
4888 spin_unlock_irqrestore(ap->lock, flags);
4889 ata_port_wait_eh(ap);
4890 } else
4891 spin_unlock_irqrestore(ap->lock, flags);
4893 return rc;
4897 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4898 * @work: Pointer to ATA port to perform scsi_rescan_device()
4900 * After ATA pass thru (SAT) commands are executed successfully,
4901 * libata need to propagate the changes to SCSI layer.
4903 * LOCKING:
4904 * Kernel thread context (may sleep).
4906 void ata_scsi_dev_rescan(struct work_struct *work)
4908 struct ata_port *ap =
4909 container_of(work, struct ata_port, scsi_rescan_task);
4910 struct ata_link *link;
4911 struct ata_device *dev;
4912 unsigned long flags;
4914 mutex_lock(&ap->scsi_scan_mutex);
4915 spin_lock_irqsave(ap->lock, flags);
4917 ata_for_each_link(link, ap, EDGE) {
4918 ata_for_each_dev(dev, link, ENABLED) {
4919 struct scsi_device *sdev = dev->sdev;
4921 if (!sdev)
4922 continue;
4923 if (scsi_device_get(sdev))
4924 continue;
4926 spin_unlock_irqrestore(ap->lock, flags);
4927 scsi_rescan_device(&(sdev->sdev_gendev));
4928 scsi_device_put(sdev);
4929 spin_lock_irqsave(ap->lock, flags);
4933 spin_unlock_irqrestore(ap->lock, flags);
4934 mutex_unlock(&ap->scsi_scan_mutex);
4938 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4939 * @host: ATA host container for all SAS ports
4940 * @port_info: Information from low-level host driver
4941 * @shost: SCSI host that the scsi device is attached to
4943 * LOCKING:
4944 * PCI/etc. bus probe sem.
4946 * RETURNS:
4947 * ata_port pointer on success / NULL on failure.
4950 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
4951 struct ata_port_info *port_info,
4952 struct Scsi_Host *shost)
4954 struct ata_port *ap;
4956 ap = ata_port_alloc(host);
4957 if (!ap)
4958 return NULL;
4960 ap->port_no = 0;
4961 ap->lock = &host->lock;
4962 ap->pio_mask = port_info->pio_mask;
4963 ap->mwdma_mask = port_info->mwdma_mask;
4964 ap->udma_mask = port_info->udma_mask;
4965 ap->flags |= port_info->flags;
4966 ap->ops = port_info->port_ops;
4967 ap->cbl = ATA_CBL_SATA;
4969 return ap;
4971 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4974 * ata_sas_port_start - Set port up for dma.
4975 * @ap: Port to initialize
4977 * Called just after data structures for each port are
4978 * initialized.
4980 * May be used as the port_start() entry in ata_port_operations.
4982 * LOCKING:
4983 * Inherited from caller.
4985 int ata_sas_port_start(struct ata_port *ap)
4988 * the port is marked as frozen at allocation time, but if we don't
4989 * have new eh, we won't thaw it
4991 if (!ap->ops->error_handler)
4992 ap->pflags &= ~ATA_PFLAG_FROZEN;
4993 return 0;
4995 EXPORT_SYMBOL_GPL(ata_sas_port_start);
4998 * ata_port_stop - Undo ata_sas_port_start()
4999 * @ap: Port to shut down
5001 * May be used as the port_stop() entry in ata_port_operations.
5003 * LOCKING:
5004 * Inherited from caller.
5007 void ata_sas_port_stop(struct ata_port *ap)
5010 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
5013 * ata_sas_async_probe - simply schedule probing and return
5014 * @ap: Port to probe
5016 * For batch scheduling of probe for sas attached ata devices, assumes
5017 * the port has already been through ata_sas_port_init()
5019 void ata_sas_async_probe(struct ata_port *ap)
5021 __ata_port_probe(ap);
5023 EXPORT_SYMBOL_GPL(ata_sas_async_probe);
5025 int ata_sas_sync_probe(struct ata_port *ap)
5027 return ata_port_probe(ap);
5029 EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
5033 * ata_sas_port_init - Initialize a SATA device
5034 * @ap: SATA port to initialize
5036 * LOCKING:
5037 * PCI/etc. bus probe sem.
5039 * RETURNS:
5040 * Zero on success, non-zero on error.
5043 int ata_sas_port_init(struct ata_port *ap)
5045 int rc = ap->ops->port_start(ap);
5047 if (rc)
5048 return rc;
5049 ap->print_id = atomic_inc_return(&ata_print_id);
5050 return 0;
5052 EXPORT_SYMBOL_GPL(ata_sas_port_init);
5055 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
5056 * @ap: SATA port to destroy
5060 void ata_sas_port_destroy(struct ata_port *ap)
5062 if (ap->ops->port_stop)
5063 ap->ops->port_stop(ap);
5064 kfree(ap);
5066 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
5069 * ata_sas_slave_configure - Default slave_config routine for libata devices
5070 * @sdev: SCSI device to configure
5071 * @ap: ATA port to which SCSI device is attached
5073 * RETURNS:
5074 * Zero.
5077 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
5079 ata_scsi_sdev_config(sdev);
5080 ata_scsi_dev_config(sdev, ap->link.device);
5081 return 0;
5083 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
5086 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
5087 * @cmd: SCSI command to be sent
5088 * @ap: ATA port to which the command is being sent
5090 * RETURNS:
5091 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
5092 * 0 otherwise.
5095 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
5097 int rc = 0;
5099 ata_scsi_dump_cdb(ap, cmd);
5101 if (likely(ata_dev_enabled(ap->link.device)))
5102 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
5103 else {
5104 cmd->result = (DID_BAD_TARGET << 16);
5105 cmd->scsi_done(cmd);
5107 return rc;
5109 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
5111 int ata_sas_allocate_tag(struct ata_port *ap)
5113 unsigned int max_queue = ap->host->n_tags;
5114 unsigned int i, tag;
5116 for (i = 0, tag = ap->sas_last_tag + 1; i < max_queue; i++, tag++) {
5117 tag = tag < max_queue ? tag : 0;
5119 /* the last tag is reserved for internal command. */
5120 if (tag == ATA_TAG_INTERNAL)
5121 continue;
5123 if (!test_and_set_bit(tag, &ap->sas_tag_allocated)) {
5124 ap->sas_last_tag = tag;
5125 return tag;
5128 return -1;
5131 void ata_sas_free_tag(unsigned int tag, struct ata_port *ap)
5133 clear_bit(tag, &ap->sas_tag_allocated);