Merge remote-tracking branch 'moduleh/module.h-split'
[linux-2.6/next.git] / drivers / ata / libata-scsi.c
blobed2c73b23386f192242984a69d239a818fd683cd
1 /*
2 * libata-scsi.c - helper library for ATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
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/DocBook/libata.*
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
36 #include <linux/slab.h>
37 #include <linux/kernel.h>
38 #include <linux/blkdev.h>
39 #include <linux/spinlock.h>
40 #include <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>
54 #include "libata.h"
55 #include "libata-transport.h"
57 #define ATA_SCSI_RBUF_SIZE 4096
59 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
60 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
62 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
64 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
65 const struct scsi_device *scsidev);
66 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
67 const struct scsi_device *scsidev);
69 #define RW_RECOVERY_MPAGE 0x1
70 #define RW_RECOVERY_MPAGE_LEN 12
71 #define CACHE_MPAGE 0x8
72 #define CACHE_MPAGE_LEN 20
73 #define CONTROL_MPAGE 0xa
74 #define CONTROL_MPAGE_LEN 12
75 #define ALL_MPAGES 0x3f
76 #define ALL_SUB_MPAGES 0xff
79 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
80 RW_RECOVERY_MPAGE,
81 RW_RECOVERY_MPAGE_LEN - 2,
82 (1 << 7), /* AWRE */
83 0, /* read retry count */
84 0, 0, 0, 0,
85 0, /* write retry count */
86 0, 0, 0
89 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
90 CACHE_MPAGE,
91 CACHE_MPAGE_LEN - 2,
92 0, /* contains WCE, needs to be 0 for logic */
93 0, 0, 0, 0, 0, 0, 0, 0, 0,
94 0, /* contains DRA, needs to be 0 for logic */
95 0, 0, 0, 0, 0, 0, 0
98 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
99 CONTROL_MPAGE,
100 CONTROL_MPAGE_LEN - 2,
101 2, /* DSENSE=0, GLTSD=1 */
102 0, /* [QAM+QERR may be 1, see 05-359r1] */
103 0, 0, 0, 0, 0xff, 0xff,
104 0, 30 /* extended self test time, see 05-359r1 */
107 static const char *ata_lpm_policy_names[] = {
108 [ATA_LPM_UNKNOWN] = "max_performance",
109 [ATA_LPM_MAX_POWER] = "max_performance",
110 [ATA_LPM_MED_POWER] = "medium_power",
111 [ATA_LPM_MIN_POWER] = "min_power",
114 static ssize_t ata_scsi_lpm_store(struct device *dev,
115 struct device_attribute *attr,
116 const char *buf, size_t count)
118 struct Scsi_Host *shost = class_to_shost(dev);
119 struct ata_port *ap = ata_shost_to_port(shost);
120 enum ata_lpm_policy policy;
121 unsigned long flags;
123 /* UNKNOWN is internal state, iterate from MAX_POWER */
124 for (policy = ATA_LPM_MAX_POWER;
125 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
126 const char *name = ata_lpm_policy_names[policy];
128 if (strncmp(name, buf, strlen(name)) == 0)
129 break;
131 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
132 return -EINVAL;
134 spin_lock_irqsave(ap->lock, flags);
135 ap->target_lpm_policy = policy;
136 ata_port_schedule_eh(ap);
137 spin_unlock_irqrestore(ap->lock, flags);
139 return count;
142 static ssize_t ata_scsi_lpm_show(struct device *dev,
143 struct device_attribute *attr, char *buf)
145 struct Scsi_Host *shost = class_to_shost(dev);
146 struct ata_port *ap = ata_shost_to_port(shost);
148 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
149 return -EINVAL;
151 return snprintf(buf, PAGE_SIZE, "%s\n",
152 ata_lpm_policy_names[ap->target_lpm_policy]);
154 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
155 ata_scsi_lpm_show, ata_scsi_lpm_store);
156 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
158 static ssize_t ata_scsi_park_show(struct device *device,
159 struct device_attribute *attr, char *buf)
161 struct scsi_device *sdev = to_scsi_device(device);
162 struct ata_port *ap;
163 struct ata_link *link;
164 struct ata_device *dev;
165 unsigned long flags, now;
166 unsigned int uninitialized_var(msecs);
167 int rc = 0;
169 ap = ata_shost_to_port(sdev->host);
171 spin_lock_irqsave(ap->lock, flags);
172 dev = ata_scsi_find_dev(ap, sdev);
173 if (!dev) {
174 rc = -ENODEV;
175 goto unlock;
177 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
178 rc = -EOPNOTSUPP;
179 goto unlock;
182 link = dev->link;
183 now = jiffies;
184 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
185 link->eh_context.unloaded_mask & (1 << dev->devno) &&
186 time_after(dev->unpark_deadline, now))
187 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
188 else
189 msecs = 0;
191 unlock:
192 spin_unlock_irq(ap->lock);
194 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
197 static ssize_t ata_scsi_park_store(struct device *device,
198 struct device_attribute *attr,
199 const char *buf, size_t len)
201 struct scsi_device *sdev = to_scsi_device(device);
202 struct ata_port *ap;
203 struct ata_device *dev;
204 long int input;
205 unsigned long flags;
206 int rc;
208 rc = strict_strtol(buf, 10, &input);
209 if (rc || input < -2)
210 return -EINVAL;
211 if (input > ATA_TMOUT_MAX_PARK) {
212 rc = -EOVERFLOW;
213 input = ATA_TMOUT_MAX_PARK;
216 ap = ata_shost_to_port(sdev->host);
218 spin_lock_irqsave(ap->lock, flags);
219 dev = ata_scsi_find_dev(ap, sdev);
220 if (unlikely(!dev)) {
221 rc = -ENODEV;
222 goto unlock;
224 if (dev->class != ATA_DEV_ATA) {
225 rc = -EOPNOTSUPP;
226 goto unlock;
229 if (input >= 0) {
230 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
231 rc = -EOPNOTSUPP;
232 goto unlock;
235 dev->unpark_deadline = ata_deadline(jiffies, input);
236 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
237 ata_port_schedule_eh(ap);
238 complete(&ap->park_req_pending);
239 } else {
240 switch (input) {
241 case -1:
242 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
243 break;
244 case -2:
245 dev->flags |= ATA_DFLAG_NO_UNLOAD;
246 break;
249 unlock:
250 spin_unlock_irqrestore(ap->lock, flags);
252 return rc ? rc : len;
254 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
255 ata_scsi_park_show, ata_scsi_park_store);
256 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
258 static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
260 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
262 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
265 static ssize_t
266 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
267 const char *buf, size_t count)
269 struct Scsi_Host *shost = class_to_shost(dev);
270 struct ata_port *ap = ata_shost_to_port(shost);
271 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
272 return ap->ops->em_store(ap, buf, count);
273 return -EINVAL;
276 static ssize_t
277 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
278 char *buf)
280 struct Scsi_Host *shost = class_to_shost(dev);
281 struct ata_port *ap = ata_shost_to_port(shost);
283 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
284 return ap->ops->em_show(ap, buf);
285 return -EINVAL;
287 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
288 ata_scsi_em_message_show, ata_scsi_em_message_store);
289 EXPORT_SYMBOL_GPL(dev_attr_em_message);
291 static ssize_t
292 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
293 char *buf)
295 struct Scsi_Host *shost = class_to_shost(dev);
296 struct ata_port *ap = ata_shost_to_port(shost);
298 return snprintf(buf, 23, "%d\n", ap->em_message_type);
300 DEVICE_ATTR(em_message_type, S_IRUGO,
301 ata_scsi_em_message_type_show, NULL);
302 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
304 static ssize_t
305 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
306 char *buf)
308 struct scsi_device *sdev = to_scsi_device(dev);
309 struct ata_port *ap = ata_shost_to_port(sdev->host);
310 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
312 if (ap->ops->sw_activity_show && (ap->flags & ATA_FLAG_SW_ACTIVITY))
313 return ap->ops->sw_activity_show(atadev, buf);
314 return -EINVAL;
317 static ssize_t
318 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
319 const char *buf, size_t count)
321 struct scsi_device *sdev = to_scsi_device(dev);
322 struct ata_port *ap = ata_shost_to_port(sdev->host);
323 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
324 enum sw_activity val;
325 int rc;
327 if (ap->ops->sw_activity_store && (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
328 val = simple_strtoul(buf, NULL, 0);
329 switch (val) {
330 case OFF: case BLINK_ON: case BLINK_OFF:
331 rc = ap->ops->sw_activity_store(atadev, val);
332 if (!rc)
333 return count;
334 else
335 return rc;
338 return -EINVAL;
340 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
341 ata_scsi_activity_store);
342 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
344 struct device_attribute *ata_common_sdev_attrs[] = {
345 &dev_attr_unload_heads,
346 NULL
348 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
350 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd)
352 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
353 /* "Invalid field in cbd" */
354 cmd->scsi_done(cmd);
358 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
359 * @sdev: SCSI device for which BIOS geometry is to be determined
360 * @bdev: block device associated with @sdev
361 * @capacity: capacity of SCSI device
362 * @geom: location to which geometry will be output
364 * Generic bios head/sector/cylinder calculator
365 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
366 * mapping. Some situations may arise where the disk is not
367 * bootable if this is not used.
369 * LOCKING:
370 * Defined by the SCSI layer. We don't really care.
372 * RETURNS:
373 * Zero.
375 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
376 sector_t capacity, int geom[])
378 geom[0] = 255;
379 geom[1] = 63;
380 sector_div(capacity, 255*63);
381 geom[2] = capacity;
383 return 0;
387 * ata_scsi_unlock_native_capacity - unlock native capacity
388 * @sdev: SCSI device to adjust device capacity for
390 * This function is called if a partition on @sdev extends beyond
391 * the end of the device. It requests EH to unlock HPA.
393 * LOCKING:
394 * Defined by the SCSI layer. Might sleep.
396 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
398 struct ata_port *ap = ata_shost_to_port(sdev->host);
399 struct ata_device *dev;
400 unsigned long flags;
402 spin_lock_irqsave(ap->lock, flags);
404 dev = ata_scsi_find_dev(ap, sdev);
405 if (dev && dev->n_sectors < dev->n_native_sectors) {
406 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
407 dev->link->eh_info.action |= ATA_EH_RESET;
408 ata_port_schedule_eh(ap);
411 spin_unlock_irqrestore(ap->lock, flags);
412 ata_port_wait_eh(ap);
416 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
417 * @ap: target port
418 * @sdev: SCSI device to get identify data for
419 * @arg: User buffer area for identify data
421 * LOCKING:
422 * Defined by the SCSI layer. We don't really care.
424 * RETURNS:
425 * Zero on success, negative errno on error.
427 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
428 void __user *arg)
430 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
431 u16 __user *dst = arg;
432 char buf[40];
434 if (!dev)
435 return -ENOMSG;
437 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
438 return -EFAULT;
440 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
441 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
442 return -EFAULT;
444 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
445 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
446 return -EFAULT;
448 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
449 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
450 return -EFAULT;
452 return 0;
456 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
457 * @scsidev: Device to which we are issuing command
458 * @arg: User provided data for issuing command
460 * LOCKING:
461 * Defined by the SCSI layer. We don't really care.
463 * RETURNS:
464 * Zero on success, negative errno on error.
466 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
468 int rc = 0;
469 u8 scsi_cmd[MAX_COMMAND_SIZE];
470 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
471 int argsize = 0;
472 enum dma_data_direction data_dir;
473 int cmd_result;
475 if (arg == NULL)
476 return -EINVAL;
478 if (copy_from_user(args, arg, sizeof(args)))
479 return -EFAULT;
481 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
482 if (!sensebuf)
483 return -ENOMEM;
485 memset(scsi_cmd, 0, sizeof(scsi_cmd));
487 if (args[3]) {
488 argsize = ATA_SECT_SIZE * args[3];
489 argbuf = kmalloc(argsize, GFP_KERNEL);
490 if (argbuf == NULL) {
491 rc = -ENOMEM;
492 goto error;
495 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
496 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
497 block count in sector count field */
498 data_dir = DMA_FROM_DEVICE;
499 } else {
500 scsi_cmd[1] = (3 << 1); /* Non-data */
501 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
502 data_dir = DMA_NONE;
505 scsi_cmd[0] = ATA_16;
507 scsi_cmd[4] = args[2];
508 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
509 scsi_cmd[6] = args[3];
510 scsi_cmd[8] = args[1];
511 scsi_cmd[10] = 0x4f;
512 scsi_cmd[12] = 0xc2;
513 } else {
514 scsi_cmd[6] = args[1];
516 scsi_cmd[14] = args[0];
518 /* Good values for timeout and retries? Values below
519 from scsi_ioctl_send_command() for default case... */
520 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
521 sensebuf, (10*HZ), 5, 0, NULL);
523 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
524 u8 *desc = sensebuf + 8;
525 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
527 /* If we set cc then ATA pass-through will cause a
528 * check condition even if no error. Filter that. */
529 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
530 struct scsi_sense_hdr sshdr;
531 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
532 &sshdr);
533 if (sshdr.sense_key == 0 &&
534 sshdr.asc == 0 && sshdr.ascq == 0)
535 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
538 /* Send userspace a few ATA registers (same as drivers/ide) */
539 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
540 desc[0] == 0x09) { /* code is "ATA Descriptor" */
541 args[0] = desc[13]; /* status */
542 args[1] = desc[3]; /* error */
543 args[2] = desc[5]; /* sector count (0:7) */
544 if (copy_to_user(arg, args, sizeof(args)))
545 rc = -EFAULT;
550 if (cmd_result) {
551 rc = -EIO;
552 goto error;
555 if ((argbuf)
556 && copy_to_user(arg + sizeof(args), argbuf, argsize))
557 rc = -EFAULT;
558 error:
559 kfree(sensebuf);
560 kfree(argbuf);
561 return rc;
565 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
566 * @scsidev: Device to which we are issuing command
567 * @arg: User provided data for issuing command
569 * LOCKING:
570 * Defined by the SCSI layer. We don't really care.
572 * RETURNS:
573 * Zero on success, negative errno on error.
575 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
577 int rc = 0;
578 u8 scsi_cmd[MAX_COMMAND_SIZE];
579 u8 args[7], *sensebuf = NULL;
580 int cmd_result;
582 if (arg == NULL)
583 return -EINVAL;
585 if (copy_from_user(args, arg, sizeof(args)))
586 return -EFAULT;
588 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
589 if (!sensebuf)
590 return -ENOMEM;
592 memset(scsi_cmd, 0, sizeof(scsi_cmd));
593 scsi_cmd[0] = ATA_16;
594 scsi_cmd[1] = (3 << 1); /* Non-data */
595 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
596 scsi_cmd[4] = args[1];
597 scsi_cmd[6] = args[2];
598 scsi_cmd[8] = args[3];
599 scsi_cmd[10] = args[4];
600 scsi_cmd[12] = args[5];
601 scsi_cmd[13] = args[6] & 0x4f;
602 scsi_cmd[14] = args[0];
604 /* Good values for timeout and retries? Values below
605 from scsi_ioctl_send_command() for default case... */
606 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
607 sensebuf, (10*HZ), 5, 0, NULL);
609 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
610 u8 *desc = sensebuf + 8;
611 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
613 /* If we set cc then ATA pass-through will cause a
614 * check condition even if no error. Filter that. */
615 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
616 struct scsi_sense_hdr sshdr;
617 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
618 &sshdr);
619 if (sshdr.sense_key == 0 &&
620 sshdr.asc == 0 && sshdr.ascq == 0)
621 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
624 /* Send userspace ATA registers */
625 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
626 desc[0] == 0x09) {/* code is "ATA Descriptor" */
627 args[0] = desc[13]; /* status */
628 args[1] = desc[3]; /* error */
629 args[2] = desc[5]; /* sector count (0:7) */
630 args[3] = desc[7]; /* lbal */
631 args[4] = desc[9]; /* lbam */
632 args[5] = desc[11]; /* lbah */
633 args[6] = desc[12]; /* select */
634 if (copy_to_user(arg, args, sizeof(args)))
635 rc = -EFAULT;
639 if (cmd_result) {
640 rc = -EIO;
641 goto error;
644 error:
645 kfree(sensebuf);
646 return rc;
649 static int ata_ioc32(struct ata_port *ap)
651 if (ap->flags & ATA_FLAG_PIO_DMA)
652 return 1;
653 if (ap->pflags & ATA_PFLAG_PIO32)
654 return 1;
655 return 0;
658 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
659 int cmd, void __user *arg)
661 int val = -EINVAL, rc = -EINVAL;
662 unsigned long flags;
664 switch (cmd) {
665 case ATA_IOC_GET_IO32:
666 spin_lock_irqsave(ap->lock, flags);
667 val = ata_ioc32(ap);
668 spin_unlock_irqrestore(ap->lock, flags);
669 if (copy_to_user(arg, &val, 1))
670 return -EFAULT;
671 return 0;
673 case ATA_IOC_SET_IO32:
674 val = (unsigned long) arg;
675 rc = 0;
676 spin_lock_irqsave(ap->lock, flags);
677 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
678 if (val)
679 ap->pflags |= ATA_PFLAG_PIO32;
680 else
681 ap->pflags &= ~ATA_PFLAG_PIO32;
682 } else {
683 if (val != ata_ioc32(ap))
684 rc = -EINVAL;
686 spin_unlock_irqrestore(ap->lock, flags);
687 return rc;
689 case HDIO_GET_IDENTITY:
690 return ata_get_identity(ap, scsidev, arg);
692 case HDIO_DRIVE_CMD:
693 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
694 return -EACCES;
695 return ata_cmd_ioctl(scsidev, arg);
697 case HDIO_DRIVE_TASK:
698 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
699 return -EACCES;
700 return ata_task_ioctl(scsidev, arg);
702 default:
703 rc = -ENOTTY;
704 break;
707 return rc;
709 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
711 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
713 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
714 scsidev, cmd, arg);
716 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
719 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
720 * @dev: ATA device to which the new command is attached
721 * @cmd: SCSI command that originated this ATA command
723 * Obtain a reference to an unused ata_queued_cmd structure,
724 * which is the basic libata structure representing a single
725 * ATA command sent to the hardware.
727 * If a command was available, fill in the SCSI-specific
728 * portions of the structure with information on the
729 * current command.
731 * LOCKING:
732 * spin_lock_irqsave(host lock)
734 * RETURNS:
735 * Command allocated, or %NULL if none available.
737 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
738 struct scsi_cmnd *cmd)
740 struct ata_queued_cmd *qc;
742 qc = ata_qc_new_init(dev);
743 if (qc) {
744 qc->scsicmd = cmd;
745 qc->scsidone = cmd->scsi_done;
747 qc->sg = scsi_sglist(cmd);
748 qc->n_elem = scsi_sg_count(cmd);
749 } else {
750 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
751 cmd->scsi_done(cmd);
754 return qc;
757 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
759 struct scsi_cmnd *scmd = qc->scsicmd;
761 qc->extrabytes = scmd->request->extra_len;
762 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
766 * ata_dump_status - user friendly display of error info
767 * @id: id of the port in question
768 * @tf: ptr to filled out taskfile
770 * Decode and dump the ATA error/status registers for the user so
771 * that they have some idea what really happened at the non
772 * make-believe layer.
774 * LOCKING:
775 * inherited from caller
777 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
779 u8 stat = tf->command, err = tf->feature;
781 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
782 if (stat & ATA_BUSY) {
783 printk("Busy }\n"); /* Data is not valid in this case */
784 } else {
785 if (stat & 0x40) printk("DriveReady ");
786 if (stat & 0x20) printk("DeviceFault ");
787 if (stat & 0x10) printk("SeekComplete ");
788 if (stat & 0x08) printk("DataRequest ");
789 if (stat & 0x04) printk("CorrectedError ");
790 if (stat & 0x02) printk("Index ");
791 if (stat & 0x01) printk("Error ");
792 printk("}\n");
794 if (err) {
795 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
796 if (err & 0x04) printk("DriveStatusError ");
797 if (err & 0x80) {
798 if (err & 0x04) printk("BadCRC ");
799 else printk("Sector ");
801 if (err & 0x40) printk("UncorrectableError ");
802 if (err & 0x10) printk("SectorIdNotFound ");
803 if (err & 0x02) printk("TrackZeroNotFound ");
804 if (err & 0x01) printk("AddrMarkNotFound ");
805 printk("}\n");
811 * ata_to_sense_error - convert ATA error to SCSI error
812 * @id: ATA device number
813 * @drv_stat: value contained in ATA status register
814 * @drv_err: value contained in ATA error register
815 * @sk: the sense key we'll fill out
816 * @asc: the additional sense code we'll fill out
817 * @ascq: the additional sense code qualifier we'll fill out
818 * @verbose: be verbose
820 * Converts an ATA error into a SCSI error. Fill out pointers to
821 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
822 * format sense blocks.
824 * LOCKING:
825 * spin_lock_irqsave(host lock)
827 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
828 u8 *asc, u8 *ascq, int verbose)
830 int i;
832 /* Based on the 3ware driver translation table */
833 static const unsigned char sense_table[][4] = {
834 /* BBD|ECC|ID|MAR */
835 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
836 /* BBD|ECC|ID */
837 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
838 /* ECC|MC|MARK */
839 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
840 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
841 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
842 /* MC|ID|ABRT|TRK0|MARK */
843 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
844 /* MCR|MARK */
845 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
846 /* Bad address mark */
847 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
848 /* TRK0 */
849 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
850 /* Abort & !ICRC */
851 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
852 /* Media change request */
853 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
854 /* SRV */
855 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
856 /* Media change */
857 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
858 /* ECC */
859 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
860 /* BBD - block marked bad */
861 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
862 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
864 static const unsigned char stat_table[][4] = {
865 /* Must be first because BUSY means no other bits valid */
866 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
867 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
868 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
869 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
870 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
874 * Is this an error we can process/parse
876 if (drv_stat & ATA_BUSY) {
877 drv_err = 0; /* Ignore the err bits, they're invalid */
880 if (drv_err) {
881 /* Look for drv_err */
882 for (i = 0; sense_table[i][0] != 0xFF; i++) {
883 /* Look for best matches first */
884 if ((sense_table[i][0] & drv_err) ==
885 sense_table[i][0]) {
886 *sk = sense_table[i][1];
887 *asc = sense_table[i][2];
888 *ascq = sense_table[i][3];
889 goto translate_done;
892 /* No immediate match */
893 if (verbose)
894 printk(KERN_WARNING "ata%u: no sense translation for "
895 "error 0x%02x\n", id, drv_err);
898 /* Fall back to interpreting status bits */
899 for (i = 0; stat_table[i][0] != 0xFF; i++) {
900 if (stat_table[i][0] & drv_stat) {
901 *sk = stat_table[i][1];
902 *asc = stat_table[i][2];
903 *ascq = stat_table[i][3];
904 goto translate_done;
907 /* No error? Undecoded? */
908 if (verbose)
909 printk(KERN_WARNING "ata%u: no sense translation for "
910 "status: 0x%02x\n", id, drv_stat);
912 /* We need a sensible error return here, which is tricky, and one
913 that won't cause people to do things like return a disk wrongly */
914 *sk = ABORTED_COMMAND;
915 *asc = 0x00;
916 *ascq = 0x00;
918 translate_done:
919 if (verbose)
920 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
921 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
922 id, drv_stat, drv_err, *sk, *asc, *ascq);
923 return;
927 * ata_gen_passthru_sense - Generate check condition sense block.
928 * @qc: Command that completed.
930 * This function is specific to the ATA descriptor format sense
931 * block specified for the ATA pass through commands. Regardless
932 * of whether the command errored or not, return a sense
933 * block. Copy all controller registers into the sense
934 * block. Clear sense key, ASC & ASCQ if there is no error.
936 * LOCKING:
937 * None.
939 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
941 struct scsi_cmnd *cmd = qc->scsicmd;
942 struct ata_taskfile *tf = &qc->result_tf;
943 unsigned char *sb = cmd->sense_buffer;
944 unsigned char *desc = sb + 8;
945 int verbose = qc->ap->ops->error_handler == NULL;
947 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
949 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
952 * Use ata_to_sense_error() to map status register bits
953 * onto sense key, asc & ascq.
955 if (qc->err_mask ||
956 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
957 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
958 &sb[1], &sb[2], &sb[3], verbose);
959 sb[1] &= 0x0f;
963 * Sense data is current and format is descriptor.
965 sb[0] = 0x72;
967 desc[0] = 0x09;
969 /* set length of additional sense data */
970 sb[7] = 14;
971 desc[1] = 12;
974 * Copy registers into sense buffer.
976 desc[2] = 0x00;
977 desc[3] = tf->feature; /* == error reg */
978 desc[5] = tf->nsect;
979 desc[7] = tf->lbal;
980 desc[9] = tf->lbam;
981 desc[11] = tf->lbah;
982 desc[12] = tf->device;
983 desc[13] = tf->command; /* == status reg */
986 * Fill in Extend bit, and the high order bytes
987 * if applicable.
989 if (tf->flags & ATA_TFLAG_LBA48) {
990 desc[2] |= 0x01;
991 desc[4] = tf->hob_nsect;
992 desc[6] = tf->hob_lbal;
993 desc[8] = tf->hob_lbam;
994 desc[10] = tf->hob_lbah;
999 * ata_gen_ata_sense - generate a SCSI fixed sense block
1000 * @qc: Command that we are erroring out
1002 * Generate sense block for a failed ATA command @qc. Descriptor
1003 * format is used to accommodate LBA48 block address.
1005 * LOCKING:
1006 * None.
1008 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1010 struct ata_device *dev = qc->dev;
1011 struct scsi_cmnd *cmd = qc->scsicmd;
1012 struct ata_taskfile *tf = &qc->result_tf;
1013 unsigned char *sb = cmd->sense_buffer;
1014 unsigned char *desc = sb + 8;
1015 int verbose = qc->ap->ops->error_handler == NULL;
1016 u64 block;
1018 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1020 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1022 /* sense data is current and format is descriptor */
1023 sb[0] = 0x72;
1025 /* Use ata_to_sense_error() to map status register bits
1026 * onto sense key, asc & ascq.
1028 if (qc->err_mask ||
1029 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1030 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1031 &sb[1], &sb[2], &sb[3], verbose);
1032 sb[1] &= 0x0f;
1035 block = ata_tf_read_block(&qc->result_tf, dev);
1037 /* information sense data descriptor */
1038 sb[7] = 12;
1039 desc[0] = 0x00;
1040 desc[1] = 10;
1042 desc[2] |= 0x80; /* valid */
1043 desc[6] = block >> 40;
1044 desc[7] = block >> 32;
1045 desc[8] = block >> 24;
1046 desc[9] = block >> 16;
1047 desc[10] = block >> 8;
1048 desc[11] = block;
1051 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1053 sdev->use_10_for_rw = 1;
1054 sdev->use_10_for_ms = 1;
1056 /* Schedule policy is determined by ->qc_defer() callback and
1057 * it needs to see every deferred qc. Set dev_blocked to 1 to
1058 * prevent SCSI midlayer from automatically deferring
1059 * requests.
1061 sdev->max_device_blocked = 1;
1065 * atapi_drain_needed - Check whether data transfer may overflow
1066 * @rq: request to be checked
1068 * ATAPI commands which transfer variable length data to host
1069 * might overflow due to application error or hardare bug. This
1070 * function checks whether overflow should be drained and ignored
1071 * for @request.
1073 * LOCKING:
1074 * None.
1076 * RETURNS:
1077 * 1 if ; otherwise, 0.
1079 static int atapi_drain_needed(struct request *rq)
1081 if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
1082 return 0;
1084 if (!blk_rq_bytes(rq) || (rq->cmd_flags & REQ_WRITE))
1085 return 0;
1087 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1090 static int ata_scsi_dev_config(struct scsi_device *sdev,
1091 struct ata_device *dev)
1093 struct request_queue *q = sdev->request_queue;
1095 if (!ata_id_has_unload(dev->id))
1096 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1098 /* configure max sectors */
1099 blk_queue_max_hw_sectors(q, dev->max_sectors);
1101 if (dev->class == ATA_DEV_ATAPI) {
1102 void *buf;
1104 sdev->sector_size = ATA_SECT_SIZE;
1106 /* set DMA padding */
1107 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1109 /* configure draining */
1110 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1111 if (!buf) {
1112 ata_dev_err(dev, "drain buffer allocation failed\n");
1113 return -ENOMEM;
1116 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1117 } else {
1118 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1119 sdev->manage_start_stop = 1;
1123 * ata_pio_sectors() expects buffer for each sector to not cross
1124 * page boundary. Enforce it by requiring buffers to be sector
1125 * aligned, which works iff sector_size is not larger than
1126 * PAGE_SIZE. ATAPI devices also need the alignment as
1127 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1129 if (sdev->sector_size > PAGE_SIZE)
1130 ata_dev_warn(dev,
1131 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1132 sdev->sector_size);
1134 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1136 if (dev->flags & ATA_DFLAG_AN)
1137 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1139 if (dev->flags & ATA_DFLAG_NCQ) {
1140 int depth;
1142 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1143 depth = min(ATA_MAX_QUEUE - 1, depth);
1144 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1147 blk_queue_flush_queueable(q, false);
1149 dev->sdev = sdev;
1150 return 0;
1154 * ata_scsi_slave_config - Set SCSI device attributes
1155 * @sdev: SCSI device to examine
1157 * This is called before we actually start reading
1158 * and writing to the device, to configure certain
1159 * SCSI mid-layer behaviors.
1161 * LOCKING:
1162 * Defined by SCSI layer. We don't really care.
1165 int ata_scsi_slave_config(struct scsi_device *sdev)
1167 struct ata_port *ap = ata_shost_to_port(sdev->host);
1168 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1169 int rc = 0;
1171 ata_scsi_sdev_config(sdev);
1173 if (dev)
1174 rc = ata_scsi_dev_config(sdev, dev);
1176 return rc;
1180 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1181 * @sdev: SCSI device to be destroyed
1183 * @sdev is about to be destroyed for hot/warm unplugging. If
1184 * this unplugging was initiated by libata as indicated by NULL
1185 * dev->sdev, this function doesn't have to do anything.
1186 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1187 * Clear dev->sdev, schedule the device for ATA detach and invoke
1188 * EH.
1190 * LOCKING:
1191 * Defined by SCSI layer. We don't really care.
1193 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1195 struct ata_port *ap = ata_shost_to_port(sdev->host);
1196 struct request_queue *q = sdev->request_queue;
1197 unsigned long flags;
1198 struct ata_device *dev;
1200 if (!ap->ops->error_handler)
1201 return;
1203 spin_lock_irqsave(ap->lock, flags);
1204 dev = __ata_scsi_find_dev(ap, sdev);
1205 if (dev && dev->sdev) {
1206 /* SCSI device already in CANCEL state, no need to offline it */
1207 dev->sdev = NULL;
1208 dev->flags |= ATA_DFLAG_DETACH;
1209 ata_port_schedule_eh(ap);
1211 spin_unlock_irqrestore(ap->lock, flags);
1213 kfree(q->dma_drain_buffer);
1214 q->dma_drain_buffer = NULL;
1215 q->dma_drain_size = 0;
1219 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1220 * @sdev: SCSI device to configure queue depth for
1221 * @queue_depth: new queue depth
1222 * @reason: calling context
1224 * This is libata standard hostt->change_queue_depth callback.
1225 * SCSI will call into this callback when user tries to set queue
1226 * depth via sysfs.
1228 * LOCKING:
1229 * SCSI layer (we don't care)
1231 * RETURNS:
1232 * Newly configured queue depth.
1234 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth,
1235 int reason)
1237 struct ata_port *ap = ata_shost_to_port(sdev->host);
1238 struct ata_device *dev;
1239 unsigned long flags;
1241 if (reason != SCSI_QDEPTH_DEFAULT)
1242 return -EOPNOTSUPP;
1244 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1245 return sdev->queue_depth;
1247 dev = ata_scsi_find_dev(ap, sdev);
1248 if (!dev || !ata_dev_enabled(dev))
1249 return sdev->queue_depth;
1251 /* NCQ enabled? */
1252 spin_lock_irqsave(ap->lock, flags);
1253 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1254 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1255 dev->flags |= ATA_DFLAG_NCQ_OFF;
1256 queue_depth = 1;
1258 spin_unlock_irqrestore(ap->lock, flags);
1260 /* limit and apply queue depth */
1261 queue_depth = min(queue_depth, sdev->host->can_queue);
1262 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1263 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1265 if (sdev->queue_depth == queue_depth)
1266 return -EINVAL;
1268 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1269 return queue_depth;
1273 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1274 * @qc: Storage for translated ATA taskfile
1276 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1277 * (to start). Perhaps these commands should be preceded by
1278 * CHECK POWER MODE to see what power mode the device is already in.
1279 * [See SAT revision 5 at www.t10.org]
1281 * LOCKING:
1282 * spin_lock_irqsave(host lock)
1284 * RETURNS:
1285 * Zero on success, non-zero on error.
1287 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1289 struct scsi_cmnd *scmd = qc->scsicmd;
1290 struct ata_taskfile *tf = &qc->tf;
1291 const u8 *cdb = scmd->cmnd;
1293 if (scmd->cmd_len < 5)
1294 goto invalid_fld;
1296 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1297 tf->protocol = ATA_PROT_NODATA;
1298 if (cdb[1] & 0x1) {
1299 ; /* ignore IMMED bit, violates sat-r05 */
1301 if (cdb[4] & 0x2)
1302 goto invalid_fld; /* LOEJ bit set not supported */
1303 if (((cdb[4] >> 4) & 0xf) != 0)
1304 goto invalid_fld; /* power conditions not supported */
1306 if (cdb[4] & 0x1) {
1307 tf->nsect = 1; /* 1 sector, lba=0 */
1309 if (qc->dev->flags & ATA_DFLAG_LBA) {
1310 tf->flags |= ATA_TFLAG_LBA;
1312 tf->lbah = 0x0;
1313 tf->lbam = 0x0;
1314 tf->lbal = 0x0;
1315 tf->device |= ATA_LBA;
1316 } else {
1317 /* CHS */
1318 tf->lbal = 0x1; /* sect */
1319 tf->lbam = 0x0; /* cyl low */
1320 tf->lbah = 0x0; /* cyl high */
1323 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1324 } else {
1325 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1326 * or S5) causing some drives to spin up and down again.
1328 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1329 system_state == SYSTEM_POWER_OFF)
1330 goto skip;
1332 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1333 system_entering_hibernation())
1334 goto skip;
1336 /* Issue ATA STANDBY IMMEDIATE command */
1337 tf->command = ATA_CMD_STANDBYNOW1;
1341 * Standby and Idle condition timers could be implemented but that
1342 * would require libata to implement the Power condition mode page
1343 * and allow the user to change it. Changing mode pages requires
1344 * MODE SELECT to be implemented.
1347 return 0;
1349 invalid_fld:
1350 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1351 /* "Invalid field in cbd" */
1352 return 1;
1353 skip:
1354 scmd->result = SAM_STAT_GOOD;
1355 return 1;
1360 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1361 * @qc: Storage for translated ATA taskfile
1363 * Sets up an ATA taskfile to issue FLUSH CACHE or
1364 * FLUSH CACHE EXT.
1366 * LOCKING:
1367 * spin_lock_irqsave(host lock)
1369 * RETURNS:
1370 * Zero on success, non-zero on error.
1372 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1374 struct ata_taskfile *tf = &qc->tf;
1376 tf->flags |= ATA_TFLAG_DEVICE;
1377 tf->protocol = ATA_PROT_NODATA;
1379 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1380 tf->command = ATA_CMD_FLUSH_EXT;
1381 else
1382 tf->command = ATA_CMD_FLUSH;
1384 /* flush is critical for IO integrity, consider it an IO command */
1385 qc->flags |= ATA_QCFLAG_IO;
1387 return 0;
1391 * scsi_6_lba_len - Get LBA and transfer length
1392 * @cdb: SCSI command to translate
1394 * Calculate LBA and transfer length for 6-byte commands.
1396 * RETURNS:
1397 * @plba: the LBA
1398 * @plen: the transfer length
1400 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1402 u64 lba = 0;
1403 u32 len;
1405 VPRINTK("six-byte command\n");
1407 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1408 lba |= ((u64)cdb[2]) << 8;
1409 lba |= ((u64)cdb[3]);
1411 len = cdb[4];
1413 *plba = lba;
1414 *plen = len;
1418 * scsi_10_lba_len - Get LBA and transfer length
1419 * @cdb: SCSI command to translate
1421 * Calculate LBA and transfer length for 10-byte commands.
1423 * RETURNS:
1424 * @plba: the LBA
1425 * @plen: the transfer length
1427 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1429 u64 lba = 0;
1430 u32 len = 0;
1432 VPRINTK("ten-byte command\n");
1434 lba |= ((u64)cdb[2]) << 24;
1435 lba |= ((u64)cdb[3]) << 16;
1436 lba |= ((u64)cdb[4]) << 8;
1437 lba |= ((u64)cdb[5]);
1439 len |= ((u32)cdb[7]) << 8;
1440 len |= ((u32)cdb[8]);
1442 *plba = lba;
1443 *plen = len;
1447 * scsi_16_lba_len - Get LBA and transfer length
1448 * @cdb: SCSI command to translate
1450 * Calculate LBA and transfer length for 16-byte commands.
1452 * RETURNS:
1453 * @plba: the LBA
1454 * @plen: the transfer length
1456 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1458 u64 lba = 0;
1459 u32 len = 0;
1461 VPRINTK("sixteen-byte command\n");
1463 lba |= ((u64)cdb[2]) << 56;
1464 lba |= ((u64)cdb[3]) << 48;
1465 lba |= ((u64)cdb[4]) << 40;
1466 lba |= ((u64)cdb[5]) << 32;
1467 lba |= ((u64)cdb[6]) << 24;
1468 lba |= ((u64)cdb[7]) << 16;
1469 lba |= ((u64)cdb[8]) << 8;
1470 lba |= ((u64)cdb[9]);
1472 len |= ((u32)cdb[10]) << 24;
1473 len |= ((u32)cdb[11]) << 16;
1474 len |= ((u32)cdb[12]) << 8;
1475 len |= ((u32)cdb[13]);
1477 *plba = lba;
1478 *plen = len;
1482 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1483 * @qc: Storage for translated ATA taskfile
1485 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1487 * LOCKING:
1488 * spin_lock_irqsave(host lock)
1490 * RETURNS:
1491 * Zero on success, non-zero on error.
1493 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1495 struct scsi_cmnd *scmd = qc->scsicmd;
1496 struct ata_taskfile *tf = &qc->tf;
1497 struct ata_device *dev = qc->dev;
1498 u64 dev_sectors = qc->dev->n_sectors;
1499 const u8 *cdb = scmd->cmnd;
1500 u64 block;
1501 u32 n_block;
1503 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1504 tf->protocol = ATA_PROT_NODATA;
1506 if (cdb[0] == VERIFY) {
1507 if (scmd->cmd_len < 10)
1508 goto invalid_fld;
1509 scsi_10_lba_len(cdb, &block, &n_block);
1510 } else if (cdb[0] == VERIFY_16) {
1511 if (scmd->cmd_len < 16)
1512 goto invalid_fld;
1513 scsi_16_lba_len(cdb, &block, &n_block);
1514 } else
1515 goto invalid_fld;
1517 if (!n_block)
1518 goto nothing_to_do;
1519 if (block >= dev_sectors)
1520 goto out_of_range;
1521 if ((block + n_block) > dev_sectors)
1522 goto out_of_range;
1524 if (dev->flags & ATA_DFLAG_LBA) {
1525 tf->flags |= ATA_TFLAG_LBA;
1527 if (lba_28_ok(block, n_block)) {
1528 /* use LBA28 */
1529 tf->command = ATA_CMD_VERIFY;
1530 tf->device |= (block >> 24) & 0xf;
1531 } else if (lba_48_ok(block, n_block)) {
1532 if (!(dev->flags & ATA_DFLAG_LBA48))
1533 goto out_of_range;
1535 /* use LBA48 */
1536 tf->flags |= ATA_TFLAG_LBA48;
1537 tf->command = ATA_CMD_VERIFY_EXT;
1539 tf->hob_nsect = (n_block >> 8) & 0xff;
1541 tf->hob_lbah = (block >> 40) & 0xff;
1542 tf->hob_lbam = (block >> 32) & 0xff;
1543 tf->hob_lbal = (block >> 24) & 0xff;
1544 } else
1545 /* request too large even for LBA48 */
1546 goto out_of_range;
1548 tf->nsect = n_block & 0xff;
1550 tf->lbah = (block >> 16) & 0xff;
1551 tf->lbam = (block >> 8) & 0xff;
1552 tf->lbal = block & 0xff;
1554 tf->device |= ATA_LBA;
1555 } else {
1556 /* CHS */
1557 u32 sect, head, cyl, track;
1559 if (!lba_28_ok(block, n_block))
1560 goto out_of_range;
1562 /* Convert LBA to CHS */
1563 track = (u32)block / dev->sectors;
1564 cyl = track / dev->heads;
1565 head = track % dev->heads;
1566 sect = (u32)block % dev->sectors + 1;
1568 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1569 (u32)block, track, cyl, head, sect);
1571 /* Check whether the converted CHS can fit.
1572 Cylinder: 0-65535
1573 Head: 0-15
1574 Sector: 1-255*/
1575 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1576 goto out_of_range;
1578 tf->command = ATA_CMD_VERIFY;
1579 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1580 tf->lbal = sect;
1581 tf->lbam = cyl;
1582 tf->lbah = cyl >> 8;
1583 tf->device |= head;
1586 return 0;
1588 invalid_fld:
1589 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1590 /* "Invalid field in cbd" */
1591 return 1;
1593 out_of_range:
1594 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1595 /* "Logical Block Address out of range" */
1596 return 1;
1598 nothing_to_do:
1599 scmd->result = SAM_STAT_GOOD;
1600 return 1;
1604 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1605 * @qc: Storage for translated ATA taskfile
1607 * Converts any of six SCSI read/write commands into the
1608 * ATA counterpart, including starting sector (LBA),
1609 * sector count, and taking into account the device's LBA48
1610 * support.
1612 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1613 * %WRITE_16 are currently supported.
1615 * LOCKING:
1616 * spin_lock_irqsave(host lock)
1618 * RETURNS:
1619 * Zero on success, non-zero on error.
1621 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1623 struct scsi_cmnd *scmd = qc->scsicmd;
1624 const u8 *cdb = scmd->cmnd;
1625 unsigned int tf_flags = 0;
1626 u64 block;
1627 u32 n_block;
1628 int rc;
1630 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1631 tf_flags |= ATA_TFLAG_WRITE;
1633 /* Calculate the SCSI LBA, transfer length and FUA. */
1634 switch (cdb[0]) {
1635 case READ_10:
1636 case WRITE_10:
1637 if (unlikely(scmd->cmd_len < 10))
1638 goto invalid_fld;
1639 scsi_10_lba_len(cdb, &block, &n_block);
1640 if (unlikely(cdb[1] & (1 << 3)))
1641 tf_flags |= ATA_TFLAG_FUA;
1642 break;
1643 case READ_6:
1644 case WRITE_6:
1645 if (unlikely(scmd->cmd_len < 6))
1646 goto invalid_fld;
1647 scsi_6_lba_len(cdb, &block, &n_block);
1649 /* for 6-byte r/w commands, transfer length 0
1650 * means 256 blocks of data, not 0 block.
1652 if (!n_block)
1653 n_block = 256;
1654 break;
1655 case READ_16:
1656 case WRITE_16:
1657 if (unlikely(scmd->cmd_len < 16))
1658 goto invalid_fld;
1659 scsi_16_lba_len(cdb, &block, &n_block);
1660 if (unlikely(cdb[1] & (1 << 3)))
1661 tf_flags |= ATA_TFLAG_FUA;
1662 break;
1663 default:
1664 DPRINTK("no-byte command\n");
1665 goto invalid_fld;
1668 /* Check and compose ATA command */
1669 if (!n_block)
1670 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1671 * length 0 means transfer 0 block of data.
1672 * However, for ATA R/W commands, sector count 0 means
1673 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1675 * WARNING: one or two older ATA drives treat 0 as 0...
1677 goto nothing_to_do;
1679 qc->flags |= ATA_QCFLAG_IO;
1680 qc->nbytes = n_block * scmd->device->sector_size;
1682 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1683 qc->tag);
1684 if (likely(rc == 0))
1685 return 0;
1687 if (rc == -ERANGE)
1688 goto out_of_range;
1689 /* treat all other errors as -EINVAL, fall through */
1690 invalid_fld:
1691 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1692 /* "Invalid field in cbd" */
1693 return 1;
1695 out_of_range:
1696 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1697 /* "Logical Block Address out of range" */
1698 return 1;
1700 nothing_to_do:
1701 scmd->result = SAM_STAT_GOOD;
1702 return 1;
1705 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1707 struct ata_port *ap = qc->ap;
1708 struct scsi_cmnd *cmd = qc->scsicmd;
1709 u8 *cdb = cmd->cmnd;
1710 int need_sense = (qc->err_mask != 0);
1712 /* For ATA pass thru (SAT) commands, generate a sense block if
1713 * user mandated it or if there's an error. Note that if we
1714 * generate because the user forced us to, a check condition
1715 * is generated and the ATA register values are returned
1716 * whether the command completed successfully or not. If there
1717 * was no error, SK, ASC and ASCQ will all be zero.
1719 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1720 ((cdb[2] & 0x20) || need_sense)) {
1721 ata_gen_passthru_sense(qc);
1722 } else {
1723 if (!need_sense) {
1724 cmd->result = SAM_STAT_GOOD;
1725 } else {
1726 /* TODO: decide which descriptor format to use
1727 * for 48b LBA devices and call that here
1728 * instead of the fixed desc, which is only
1729 * good for smaller LBA (and maybe CHS?)
1730 * devices.
1732 ata_gen_ata_sense(qc);
1736 if (need_sense && !ap->ops->error_handler)
1737 ata_dump_status(ap->print_id, &qc->result_tf);
1739 qc->scsidone(cmd);
1741 ata_qc_free(qc);
1745 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1746 * @dev: ATA device to which the command is addressed
1747 * @cmd: SCSI command to execute
1748 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1750 * Our ->queuecommand() function has decided that the SCSI
1751 * command issued can be directly translated into an ATA
1752 * command, rather than handled internally.
1754 * This function sets up an ata_queued_cmd structure for the
1755 * SCSI command, and sends that ata_queued_cmd to the hardware.
1757 * The xlat_func argument (actor) returns 0 if ready to execute
1758 * ATA command, else 1 to finish translation. If 1 is returned
1759 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1760 * to be set reflecting an error condition or clean (early)
1761 * termination.
1763 * LOCKING:
1764 * spin_lock_irqsave(host lock)
1766 * RETURNS:
1767 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1768 * needs to be deferred.
1770 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1771 ata_xlat_func_t xlat_func)
1773 struct ata_port *ap = dev->link->ap;
1774 struct ata_queued_cmd *qc;
1775 int rc;
1777 VPRINTK("ENTER\n");
1779 qc = ata_scsi_qc_new(dev, cmd);
1780 if (!qc)
1781 goto err_mem;
1783 /* data is present; dma-map it */
1784 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1785 cmd->sc_data_direction == DMA_TO_DEVICE) {
1786 if (unlikely(scsi_bufflen(cmd) < 1)) {
1787 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1788 goto err_did;
1791 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1793 qc->dma_dir = cmd->sc_data_direction;
1796 qc->complete_fn = ata_scsi_qc_complete;
1798 if (xlat_func(qc))
1799 goto early_finish;
1801 if (ap->ops->qc_defer) {
1802 if ((rc = ap->ops->qc_defer(qc)))
1803 goto defer;
1806 /* select device, send command to hardware */
1807 ata_qc_issue(qc);
1809 VPRINTK("EXIT\n");
1810 return 0;
1812 early_finish:
1813 ata_qc_free(qc);
1814 cmd->scsi_done(cmd);
1815 DPRINTK("EXIT - early finish (good or error)\n");
1816 return 0;
1818 err_did:
1819 ata_qc_free(qc);
1820 cmd->result = (DID_ERROR << 16);
1821 cmd->scsi_done(cmd);
1822 err_mem:
1823 DPRINTK("EXIT - internal\n");
1824 return 0;
1826 defer:
1827 ata_qc_free(qc);
1828 DPRINTK("EXIT - defer\n");
1829 if (rc == ATA_DEFER_LINK)
1830 return SCSI_MLQUEUE_DEVICE_BUSY;
1831 else
1832 return SCSI_MLQUEUE_HOST_BUSY;
1836 * ata_scsi_rbuf_get - Map response buffer.
1837 * @cmd: SCSI command containing buffer to be mapped.
1838 * @flags: unsigned long variable to store irq enable status
1839 * @copy_in: copy in from user buffer
1841 * Prepare buffer for simulated SCSI commands.
1843 * LOCKING:
1844 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1846 * RETURNS:
1847 * Pointer to response buffer.
1849 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1850 unsigned long *flags)
1852 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1854 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1855 if (copy_in)
1856 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1857 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1858 return ata_scsi_rbuf;
1862 * ata_scsi_rbuf_put - Unmap response buffer.
1863 * @cmd: SCSI command containing buffer to be unmapped.
1864 * @copy_out: copy out result
1865 * @flags: @flags passed to ata_scsi_rbuf_get()
1867 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1868 * @copy_back is true.
1870 * LOCKING:
1871 * Unlocks ata_scsi_rbuf_lock.
1873 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1874 unsigned long *flags)
1876 if (copy_out)
1877 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1878 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1879 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1883 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1884 * @args: device IDENTIFY data / SCSI command of interest.
1885 * @actor: Callback hook for desired SCSI command simulator
1887 * Takes care of the hard work of simulating a SCSI command...
1888 * Mapping the response buffer, calling the command's handler,
1889 * and handling the handler's return value. This return value
1890 * indicates whether the handler wishes the SCSI command to be
1891 * completed successfully (0), or not (in which case cmd->result
1892 * and sense buffer are assumed to be set).
1894 * LOCKING:
1895 * spin_lock_irqsave(host lock)
1897 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1898 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1900 u8 *rbuf;
1901 unsigned int rc;
1902 struct scsi_cmnd *cmd = args->cmd;
1903 unsigned long flags;
1905 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1906 rc = actor(args, rbuf);
1907 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1909 if (rc == 0)
1910 cmd->result = SAM_STAT_GOOD;
1911 args->done(cmd);
1915 * ata_scsiop_inq_std - Simulate INQUIRY command
1916 * @args: device IDENTIFY data / SCSI command of interest.
1917 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1919 * Returns standard device identification data associated
1920 * with non-VPD INQUIRY command output.
1922 * LOCKING:
1923 * spin_lock_irqsave(host lock)
1925 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1927 const u8 versions[] = {
1928 0x60, /* SAM-3 (no version claimed) */
1930 0x03,
1931 0x20, /* SBC-2 (no version claimed) */
1933 0x02,
1934 0x60 /* SPC-3 (no version claimed) */
1936 u8 hdr[] = {
1937 TYPE_DISK,
1939 0x5, /* claim SPC-3 version compatibility */
1941 95 - 4
1944 VPRINTK("ENTER\n");
1946 /* set scsi removeable (RMB) bit per ata bit */
1947 if (ata_id_removeable(args->id))
1948 hdr[1] |= (1 << 7);
1950 memcpy(rbuf, hdr, sizeof(hdr));
1951 memcpy(&rbuf[8], "ATA ", 8);
1952 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1953 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1955 if (rbuf[32] == 0 || rbuf[32] == ' ')
1956 memcpy(&rbuf[32], "n/a ", 4);
1958 memcpy(rbuf + 59, versions, sizeof(versions));
1960 return 0;
1964 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1965 * @args: device IDENTIFY data / SCSI command of interest.
1966 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1968 * Returns list of inquiry VPD pages available.
1970 * LOCKING:
1971 * spin_lock_irqsave(host lock)
1973 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1975 const u8 pages[] = {
1976 0x00, /* page 0x00, this page */
1977 0x80, /* page 0x80, unit serial no page */
1978 0x83, /* page 0x83, device ident page */
1979 0x89, /* page 0x89, ata info page */
1980 0xb0, /* page 0xb0, block limits page */
1981 0xb1, /* page 0xb1, block device characteristics page */
1982 0xb2, /* page 0xb2, thin provisioning page */
1985 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1986 memcpy(rbuf + 4, pages, sizeof(pages));
1987 return 0;
1991 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1992 * @args: device IDENTIFY data / SCSI command of interest.
1993 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1995 * Returns ATA device serial number.
1997 * LOCKING:
1998 * spin_lock_irqsave(host lock)
2000 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2002 const u8 hdr[] = {
2004 0x80, /* this page code */
2006 ATA_ID_SERNO_LEN, /* page len */
2009 memcpy(rbuf, hdr, sizeof(hdr));
2010 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2011 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2012 return 0;
2016 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2017 * @args: device IDENTIFY data / SCSI command of interest.
2018 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2020 * Yields two logical unit device identification designators:
2021 * - vendor specific ASCII containing the ATA serial number
2022 * - SAT defined "t10 vendor id based" containing ASCII vendor
2023 * name ("ATA "), model and serial numbers.
2025 * LOCKING:
2026 * spin_lock_irqsave(host lock)
2028 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2030 const int sat_model_serial_desc_len = 68;
2031 int num;
2033 rbuf[1] = 0x83; /* this page code */
2034 num = 4;
2036 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2037 rbuf[num + 0] = 2;
2038 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2039 num += 4;
2040 ata_id_string(args->id, (unsigned char *) rbuf + num,
2041 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2042 num += ATA_ID_SERNO_LEN;
2044 /* SAT defined lu model and serial numbers descriptor */
2045 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2046 rbuf[num + 0] = 2;
2047 rbuf[num + 1] = 1;
2048 rbuf[num + 3] = sat_model_serial_desc_len;
2049 num += 4;
2050 memcpy(rbuf + num, "ATA ", 8);
2051 num += 8;
2052 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2053 ATA_ID_PROD_LEN);
2054 num += ATA_ID_PROD_LEN;
2055 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2056 ATA_ID_SERNO_LEN);
2057 num += ATA_ID_SERNO_LEN;
2059 if (ata_id_has_wwn(args->id)) {
2060 /* SAT defined lu world wide name */
2061 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2062 rbuf[num + 0] = 1;
2063 rbuf[num + 1] = 3;
2064 rbuf[num + 3] = ATA_ID_WWN_LEN;
2065 num += 4;
2066 ata_id_string(args->id, (unsigned char *) rbuf + num,
2067 ATA_ID_WWN, ATA_ID_WWN_LEN);
2068 num += ATA_ID_WWN_LEN;
2070 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2071 return 0;
2075 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2076 * @args: device IDENTIFY data / SCSI command of interest.
2077 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2079 * Yields SAT-specified ATA VPD page.
2081 * LOCKING:
2082 * spin_lock_irqsave(host lock)
2084 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2086 struct ata_taskfile tf;
2088 memset(&tf, 0, sizeof(tf));
2090 rbuf[1] = 0x89; /* our page code */
2091 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2092 rbuf[3] = (0x238 & 0xff);
2094 memcpy(&rbuf[8], "linux ", 8);
2095 memcpy(&rbuf[16], "libata ", 16);
2096 memcpy(&rbuf[32], DRV_VERSION, 4);
2097 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2099 /* we don't store the ATA device signature, so we fake it */
2101 tf.command = ATA_DRDY; /* really, this is Status reg */
2102 tf.lbal = 0x1;
2103 tf.nsect = 0x1;
2105 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2106 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2108 rbuf[56] = ATA_CMD_ID_ATA;
2110 memcpy(&rbuf[60], &args->id[0], 512);
2111 return 0;
2114 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2116 u16 min_io_sectors;
2118 rbuf[1] = 0xb0;
2119 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2122 * Optimal transfer length granularity.
2124 * This is always one physical block, but for disks with a smaller
2125 * logical than physical sector size we need to figure out what the
2126 * latter is.
2128 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2129 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2132 * Optimal unmap granularity.
2134 * The ATA spec doesn't even know about a granularity or alignment
2135 * for the TRIM command. We can leave away most of the unmap related
2136 * VPD page entries, but we have specifify a granularity to signal
2137 * that we support some form of unmap - in thise case via WRITE SAME
2138 * with the unmap bit set.
2140 if (ata_id_has_trim(args->id)) {
2141 put_unaligned_be64(65535 * 512 / 8, &rbuf[36]);
2142 put_unaligned_be32(1, &rbuf[28]);
2145 return 0;
2148 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2150 int form_factor = ata_id_form_factor(args->id);
2151 int media_rotation_rate = ata_id_rotation_rate(args->id);
2153 rbuf[1] = 0xb1;
2154 rbuf[3] = 0x3c;
2155 rbuf[4] = media_rotation_rate >> 8;
2156 rbuf[5] = media_rotation_rate;
2157 rbuf[7] = form_factor;
2159 return 0;
2162 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2164 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2165 rbuf[1] = 0xb2;
2166 rbuf[3] = 0x4;
2167 rbuf[5] = 1 << 6; /* TPWS */
2169 return 0;
2173 * ata_scsiop_noop - Command handler that simply returns success.
2174 * @args: device IDENTIFY data / SCSI command of interest.
2175 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2177 * No operation. Simply returns success to caller, to indicate
2178 * that the caller should successfully complete this SCSI command.
2180 * LOCKING:
2181 * spin_lock_irqsave(host lock)
2183 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2185 VPRINTK("ENTER\n");
2186 return 0;
2190 * ata_msense_caching - Simulate MODE SENSE caching info page
2191 * @id: device IDENTIFY data
2192 * @buf: output buffer
2194 * Generate a caching info page, which conditionally indicates
2195 * write caching to the SCSI layer, depending on device
2196 * capabilities.
2198 * LOCKING:
2199 * None.
2201 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2203 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2204 if (ata_id_wcache_enabled(id))
2205 buf[2] |= (1 << 2); /* write cache enable */
2206 if (!ata_id_rahead_enabled(id))
2207 buf[12] |= (1 << 5); /* disable read ahead */
2208 return sizeof(def_cache_mpage);
2212 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2213 * @buf: output buffer
2215 * Generate a generic MODE SENSE control mode page.
2217 * LOCKING:
2218 * None.
2220 static unsigned int ata_msense_ctl_mode(u8 *buf)
2222 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2223 return sizeof(def_control_mpage);
2227 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2228 * @buf: output buffer
2230 * Generate a generic MODE SENSE r/w error recovery page.
2232 * LOCKING:
2233 * None.
2235 static unsigned int ata_msense_rw_recovery(u8 *buf)
2237 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2238 return sizeof(def_rw_recovery_mpage);
2242 * We can turn this into a real blacklist if it's needed, for now just
2243 * blacklist any Maxtor BANC1G10 revision firmware
2245 static int ata_dev_supports_fua(u16 *id)
2247 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2249 if (!libata_fua)
2250 return 0;
2251 if (!ata_id_has_fua(id))
2252 return 0;
2254 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2255 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2257 if (strcmp(model, "Maxtor"))
2258 return 1;
2259 if (strcmp(fw, "BANC1G10"))
2260 return 1;
2262 return 0; /* blacklisted */
2266 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2267 * @args: device IDENTIFY data / SCSI command of interest.
2268 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2270 * Simulate MODE SENSE commands. Assume this is invoked for direct
2271 * access devices (e.g. disks) only. There should be no block
2272 * descriptor for other device types.
2274 * LOCKING:
2275 * spin_lock_irqsave(host lock)
2277 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2279 struct ata_device *dev = args->dev;
2280 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2281 const u8 sat_blk_desc[] = {
2282 0, 0, 0, 0, /* number of blocks: sat unspecified */
2284 0, 0x2, 0x0 /* block length: 512 bytes */
2286 u8 pg, spg;
2287 unsigned int ebd, page_control, six_byte;
2288 u8 dpofua;
2290 VPRINTK("ENTER\n");
2292 six_byte = (scsicmd[0] == MODE_SENSE);
2293 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2295 * LLBA bit in msense(10) ignored (compliant)
2298 page_control = scsicmd[2] >> 6;
2299 switch (page_control) {
2300 case 0: /* current */
2301 break; /* supported */
2302 case 3: /* saved */
2303 goto saving_not_supp;
2304 case 1: /* changeable */
2305 case 2: /* defaults */
2306 default:
2307 goto invalid_fld;
2310 if (six_byte)
2311 p += 4 + (ebd ? 8 : 0);
2312 else
2313 p += 8 + (ebd ? 8 : 0);
2315 pg = scsicmd[2] & 0x3f;
2316 spg = scsicmd[3];
2318 * No mode subpages supported (yet) but asking for _all_
2319 * subpages may be valid
2321 if (spg && (spg != ALL_SUB_MPAGES))
2322 goto invalid_fld;
2324 switch(pg) {
2325 case RW_RECOVERY_MPAGE:
2326 p += ata_msense_rw_recovery(p);
2327 break;
2329 case CACHE_MPAGE:
2330 p += ata_msense_caching(args->id, p);
2331 break;
2333 case CONTROL_MPAGE:
2334 p += ata_msense_ctl_mode(p);
2335 break;
2337 case ALL_MPAGES:
2338 p += ata_msense_rw_recovery(p);
2339 p += ata_msense_caching(args->id, p);
2340 p += ata_msense_ctl_mode(p);
2341 break;
2343 default: /* invalid page code */
2344 goto invalid_fld;
2347 dpofua = 0;
2348 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2349 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2350 dpofua = 1 << 4;
2352 if (six_byte) {
2353 rbuf[0] = p - rbuf - 1;
2354 rbuf[2] |= dpofua;
2355 if (ebd) {
2356 rbuf[3] = sizeof(sat_blk_desc);
2357 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2359 } else {
2360 unsigned int output_len = p - rbuf - 2;
2362 rbuf[0] = output_len >> 8;
2363 rbuf[1] = output_len;
2364 rbuf[3] |= dpofua;
2365 if (ebd) {
2366 rbuf[7] = sizeof(sat_blk_desc);
2367 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2370 return 0;
2372 invalid_fld:
2373 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2374 /* "Invalid field in cbd" */
2375 return 1;
2377 saving_not_supp:
2378 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2379 /* "Saving parameters not supported" */
2380 return 1;
2384 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2385 * @args: device IDENTIFY data / SCSI command of interest.
2386 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2388 * Simulate READ CAPACITY commands.
2390 * LOCKING:
2391 * None.
2393 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2395 struct ata_device *dev = args->dev;
2396 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2397 u32 sector_size; /* physical sector size in bytes */
2398 u8 log2_per_phys;
2399 u16 lowest_aligned;
2401 sector_size = ata_id_logical_sector_size(dev->id);
2402 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2403 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2405 VPRINTK("ENTER\n");
2407 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2408 if (last_lba >= 0xffffffffULL)
2409 last_lba = 0xffffffff;
2411 /* sector count, 32-bit */
2412 rbuf[0] = last_lba >> (8 * 3);
2413 rbuf[1] = last_lba >> (8 * 2);
2414 rbuf[2] = last_lba >> (8 * 1);
2415 rbuf[3] = last_lba;
2417 /* sector size */
2418 rbuf[4] = sector_size >> (8 * 3);
2419 rbuf[5] = sector_size >> (8 * 2);
2420 rbuf[6] = sector_size >> (8 * 1);
2421 rbuf[7] = sector_size;
2422 } else {
2423 /* sector count, 64-bit */
2424 rbuf[0] = last_lba >> (8 * 7);
2425 rbuf[1] = last_lba >> (8 * 6);
2426 rbuf[2] = last_lba >> (8 * 5);
2427 rbuf[3] = last_lba >> (8 * 4);
2428 rbuf[4] = last_lba >> (8 * 3);
2429 rbuf[5] = last_lba >> (8 * 2);
2430 rbuf[6] = last_lba >> (8 * 1);
2431 rbuf[7] = last_lba;
2433 /* sector size */
2434 rbuf[ 8] = sector_size >> (8 * 3);
2435 rbuf[ 9] = sector_size >> (8 * 2);
2436 rbuf[10] = sector_size >> (8 * 1);
2437 rbuf[11] = sector_size;
2439 rbuf[12] = 0;
2440 rbuf[13] = log2_per_phys;
2441 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2442 rbuf[15] = lowest_aligned;
2444 if (ata_id_has_trim(args->id)) {
2445 rbuf[14] |= 0x80; /* TPE */
2447 if (ata_id_has_zero_after_trim(args->id))
2448 rbuf[14] |= 0x40; /* TPRZ */
2452 return 0;
2456 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2457 * @args: device IDENTIFY data / SCSI command of interest.
2458 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2460 * Simulate REPORT LUNS command.
2462 * LOCKING:
2463 * spin_lock_irqsave(host lock)
2465 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2467 VPRINTK("ENTER\n");
2468 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2470 return 0;
2473 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2475 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2476 /* FIXME: not quite right; we don't want the
2477 * translation of taskfile registers into
2478 * a sense descriptors, since that's only
2479 * correct for ATA, not ATAPI
2481 ata_gen_passthru_sense(qc);
2484 qc->scsidone(qc->scsicmd);
2485 ata_qc_free(qc);
2488 /* is it pointless to prefer PIO for "safety reasons"? */
2489 static inline int ata_pio_use_silly(struct ata_port *ap)
2491 return (ap->flags & ATA_FLAG_PIO_DMA);
2494 static void atapi_request_sense(struct ata_queued_cmd *qc)
2496 struct ata_port *ap = qc->ap;
2497 struct scsi_cmnd *cmd = qc->scsicmd;
2499 DPRINTK("ATAPI request sense\n");
2501 /* FIXME: is this needed? */
2502 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2504 #ifdef CONFIG_ATA_SFF
2505 if (ap->ops->sff_tf_read)
2506 ap->ops->sff_tf_read(ap, &qc->tf);
2507 #endif
2509 /* fill these in, for the case where they are -not- overwritten */
2510 cmd->sense_buffer[0] = 0x70;
2511 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2513 ata_qc_reinit(qc);
2515 /* setup sg table and init transfer direction */
2516 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2517 ata_sg_init(qc, &qc->sgent, 1);
2518 qc->dma_dir = DMA_FROM_DEVICE;
2520 memset(&qc->cdb, 0, qc->dev->cdb_len);
2521 qc->cdb[0] = REQUEST_SENSE;
2522 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2524 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2525 qc->tf.command = ATA_CMD_PACKET;
2527 if (ata_pio_use_silly(ap)) {
2528 qc->tf.protocol = ATAPI_PROT_DMA;
2529 qc->tf.feature |= ATAPI_PKT_DMA;
2530 } else {
2531 qc->tf.protocol = ATAPI_PROT_PIO;
2532 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2533 qc->tf.lbah = 0;
2535 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2537 qc->complete_fn = atapi_sense_complete;
2539 ata_qc_issue(qc);
2541 DPRINTK("EXIT\n");
2544 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2546 struct scsi_cmnd *cmd = qc->scsicmd;
2547 unsigned int err_mask = qc->err_mask;
2549 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2551 /* handle completion from new EH */
2552 if (unlikely(qc->ap->ops->error_handler &&
2553 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2555 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2556 /* FIXME: not quite right; we don't want the
2557 * translation of taskfile registers into a
2558 * sense descriptors, since that's only
2559 * correct for ATA, not ATAPI
2561 ata_gen_passthru_sense(qc);
2564 /* SCSI EH automatically locks door if sdev->locked is
2565 * set. Sometimes door lock request continues to
2566 * fail, for example, when no media is present. This
2567 * creates a loop - SCSI EH issues door lock which
2568 * fails and gets invoked again to acquire sense data
2569 * for the failed command.
2571 * If door lock fails, always clear sdev->locked to
2572 * avoid this infinite loop.
2574 * This may happen before SCSI scan is complete. Make
2575 * sure qc->dev->sdev isn't NULL before dereferencing.
2577 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2578 qc->dev->sdev->locked = 0;
2580 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2581 qc->scsidone(cmd);
2582 ata_qc_free(qc);
2583 return;
2586 /* successful completion or old EH failure path */
2587 if (unlikely(err_mask & AC_ERR_DEV)) {
2588 cmd->result = SAM_STAT_CHECK_CONDITION;
2589 atapi_request_sense(qc);
2590 return;
2591 } else if (unlikely(err_mask)) {
2592 /* FIXME: not quite right; we don't want the
2593 * translation of taskfile registers into
2594 * a sense descriptors, since that's only
2595 * correct for ATA, not ATAPI
2597 ata_gen_passthru_sense(qc);
2598 } else {
2599 u8 *scsicmd = cmd->cmnd;
2601 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2602 unsigned long flags;
2603 u8 *buf;
2605 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2607 /* ATAPI devices typically report zero for their SCSI version,
2608 * and sometimes deviate from the spec WRT response data
2609 * format. If SCSI version is reported as zero like normal,
2610 * then we make the following fixups: 1) Fake MMC-5 version,
2611 * to indicate to the Linux scsi midlayer this is a modern
2612 * device. 2) Ensure response data format / ATAPI information
2613 * are always correct.
2615 if (buf[2] == 0) {
2616 buf[2] = 0x5;
2617 buf[3] = 0x32;
2620 ata_scsi_rbuf_put(cmd, true, &flags);
2623 cmd->result = SAM_STAT_GOOD;
2626 qc->scsidone(cmd);
2627 ata_qc_free(qc);
2630 * atapi_xlat - Initialize PACKET taskfile
2631 * @qc: command structure to be initialized
2633 * LOCKING:
2634 * spin_lock_irqsave(host lock)
2636 * RETURNS:
2637 * Zero on success, non-zero on failure.
2639 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2641 struct scsi_cmnd *scmd = qc->scsicmd;
2642 struct ata_device *dev = qc->dev;
2643 int nodata = (scmd->sc_data_direction == DMA_NONE);
2644 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2645 unsigned int nbytes;
2647 memset(qc->cdb, 0, dev->cdb_len);
2648 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2650 qc->complete_fn = atapi_qc_complete;
2652 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2653 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2654 qc->tf.flags |= ATA_TFLAG_WRITE;
2655 DPRINTK("direction: write\n");
2658 qc->tf.command = ATA_CMD_PACKET;
2659 ata_qc_set_pc_nbytes(qc);
2661 /* check whether ATAPI DMA is safe */
2662 if (!nodata && !using_pio && atapi_check_dma(qc))
2663 using_pio = 1;
2665 /* Some controller variants snoop this value for Packet
2666 * transfers to do state machine and FIFO management. Thus we
2667 * want to set it properly, and for DMA where it is
2668 * effectively meaningless.
2670 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2672 /* Most ATAPI devices which honor transfer chunk size don't
2673 * behave according to the spec when odd chunk size which
2674 * matches the transfer length is specified. If the number of
2675 * bytes to transfer is 2n+1. According to the spec, what
2676 * should happen is to indicate that 2n+1 is going to be
2677 * transferred and transfer 2n+2 bytes where the last byte is
2678 * padding.
2680 * In practice, this doesn't happen. ATAPI devices first
2681 * indicate and transfer 2n bytes and then indicate and
2682 * transfer 2 bytes where the last byte is padding.
2684 * This inconsistency confuses several controllers which
2685 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2686 * These controllers use actual number of transferred bytes to
2687 * update DMA poitner and transfer of 4n+2 bytes make those
2688 * controller push DMA pointer by 4n+4 bytes because SATA data
2689 * FISes are aligned to 4 bytes. This causes data corruption
2690 * and buffer overrun.
2692 * Always setting nbytes to even number solves this problem
2693 * because then ATAPI devices don't have to split data at 2n
2694 * boundaries.
2696 if (nbytes & 0x1)
2697 nbytes++;
2699 qc->tf.lbam = (nbytes & 0xFF);
2700 qc->tf.lbah = (nbytes >> 8);
2702 if (nodata)
2703 qc->tf.protocol = ATAPI_PROT_NODATA;
2704 else if (using_pio)
2705 qc->tf.protocol = ATAPI_PROT_PIO;
2706 else {
2707 /* DMA data xfer */
2708 qc->tf.protocol = ATAPI_PROT_DMA;
2709 qc->tf.feature |= ATAPI_PKT_DMA;
2711 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2712 (scmd->sc_data_direction != DMA_TO_DEVICE))
2713 /* some SATA bridges need us to indicate data xfer direction */
2714 qc->tf.feature |= ATAPI_DMADIR;
2718 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2719 as ATAPI tape drives don't get this right otherwise */
2720 return 0;
2723 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2725 if (!sata_pmp_attached(ap)) {
2726 if (likely(devno < ata_link_max_devices(&ap->link)))
2727 return &ap->link.device[devno];
2728 } else {
2729 if (likely(devno < ap->nr_pmp_links))
2730 return &ap->pmp_link[devno].device[0];
2733 return NULL;
2736 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2737 const struct scsi_device *scsidev)
2739 int devno;
2741 /* skip commands not addressed to targets we simulate */
2742 if (!sata_pmp_attached(ap)) {
2743 if (unlikely(scsidev->channel || scsidev->lun))
2744 return NULL;
2745 devno = scsidev->id;
2746 } else {
2747 if (unlikely(scsidev->id || scsidev->lun))
2748 return NULL;
2749 devno = scsidev->channel;
2752 return ata_find_dev(ap, devno);
2756 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2757 * @ap: ATA port to which the device is attached
2758 * @scsidev: SCSI device from which we derive the ATA device
2760 * Given various information provided in struct scsi_cmnd,
2761 * map that onto an ATA bus, and using that mapping
2762 * determine which ata_device is associated with the
2763 * SCSI command to be sent.
2765 * LOCKING:
2766 * spin_lock_irqsave(host lock)
2768 * RETURNS:
2769 * Associated ATA device, or %NULL if not found.
2771 static struct ata_device *
2772 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2774 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2776 if (unlikely(!dev || !ata_dev_enabled(dev)))
2777 return NULL;
2779 return dev;
2783 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2784 * @byte1: Byte 1 from pass-thru CDB.
2786 * RETURNS:
2787 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2789 static u8
2790 ata_scsi_map_proto(u8 byte1)
2792 switch((byte1 & 0x1e) >> 1) {
2793 case 3: /* Non-data */
2794 return ATA_PROT_NODATA;
2796 case 6: /* DMA */
2797 case 10: /* UDMA Data-in */
2798 case 11: /* UDMA Data-Out */
2799 return ATA_PROT_DMA;
2801 case 4: /* PIO Data-in */
2802 case 5: /* PIO Data-out */
2803 return ATA_PROT_PIO;
2805 case 0: /* Hard Reset */
2806 case 1: /* SRST */
2807 case 8: /* Device Diagnostic */
2808 case 9: /* Device Reset */
2809 case 7: /* DMA Queued */
2810 case 12: /* FPDMA */
2811 case 15: /* Return Response Info */
2812 default: /* Reserved */
2813 break;
2816 return ATA_PROT_UNKNOWN;
2820 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2821 * @qc: command structure to be initialized
2823 * Handles either 12 or 16-byte versions of the CDB.
2825 * RETURNS:
2826 * Zero on success, non-zero on failure.
2828 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2830 struct ata_taskfile *tf = &(qc->tf);
2831 struct scsi_cmnd *scmd = qc->scsicmd;
2832 struct ata_device *dev = qc->dev;
2833 const u8 *cdb = scmd->cmnd;
2835 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2836 goto invalid_fld;
2839 * 12 and 16 byte CDBs use different offsets to
2840 * provide the various register values.
2842 if (cdb[0] == ATA_16) {
2844 * 16-byte CDB - may contain extended commands.
2846 * If that is the case, copy the upper byte register values.
2848 if (cdb[1] & 0x01) {
2849 tf->hob_feature = cdb[3];
2850 tf->hob_nsect = cdb[5];
2851 tf->hob_lbal = cdb[7];
2852 tf->hob_lbam = cdb[9];
2853 tf->hob_lbah = cdb[11];
2854 tf->flags |= ATA_TFLAG_LBA48;
2855 } else
2856 tf->flags &= ~ATA_TFLAG_LBA48;
2859 * Always copy low byte, device and command registers.
2861 tf->feature = cdb[4];
2862 tf->nsect = cdb[6];
2863 tf->lbal = cdb[8];
2864 tf->lbam = cdb[10];
2865 tf->lbah = cdb[12];
2866 tf->device = cdb[13];
2867 tf->command = cdb[14];
2868 } else {
2870 * 12-byte CDB - incapable of extended commands.
2872 tf->flags &= ~ATA_TFLAG_LBA48;
2874 tf->feature = cdb[3];
2875 tf->nsect = cdb[4];
2876 tf->lbal = cdb[5];
2877 tf->lbam = cdb[6];
2878 tf->lbah = cdb[7];
2879 tf->device = cdb[8];
2880 tf->command = cdb[9];
2883 /* enforce correct master/slave bit */
2884 tf->device = dev->devno ?
2885 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2887 switch (tf->command) {
2888 /* READ/WRITE LONG use a non-standard sect_size */
2889 case ATA_CMD_READ_LONG:
2890 case ATA_CMD_READ_LONG_ONCE:
2891 case ATA_CMD_WRITE_LONG:
2892 case ATA_CMD_WRITE_LONG_ONCE:
2893 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2894 goto invalid_fld;
2895 qc->sect_size = scsi_bufflen(scmd);
2896 break;
2898 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2899 case ATA_CMD_CFA_WRITE_NE:
2900 case ATA_CMD_CFA_TRANS_SECT:
2901 case ATA_CMD_CFA_WRITE_MULT_NE:
2902 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2903 case ATA_CMD_READ:
2904 case ATA_CMD_READ_EXT:
2905 case ATA_CMD_READ_QUEUED:
2906 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2907 case ATA_CMD_FPDMA_READ:
2908 case ATA_CMD_READ_MULTI:
2909 case ATA_CMD_READ_MULTI_EXT:
2910 case ATA_CMD_PIO_READ:
2911 case ATA_CMD_PIO_READ_EXT:
2912 case ATA_CMD_READ_STREAM_DMA_EXT:
2913 case ATA_CMD_READ_STREAM_EXT:
2914 case ATA_CMD_VERIFY:
2915 case ATA_CMD_VERIFY_EXT:
2916 case ATA_CMD_WRITE:
2917 case ATA_CMD_WRITE_EXT:
2918 case ATA_CMD_WRITE_FUA_EXT:
2919 case ATA_CMD_WRITE_QUEUED:
2920 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2921 case ATA_CMD_FPDMA_WRITE:
2922 case ATA_CMD_WRITE_MULTI:
2923 case ATA_CMD_WRITE_MULTI_EXT:
2924 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2925 case ATA_CMD_PIO_WRITE:
2926 case ATA_CMD_PIO_WRITE_EXT:
2927 case ATA_CMD_WRITE_STREAM_DMA_EXT:
2928 case ATA_CMD_WRITE_STREAM_EXT:
2929 qc->sect_size = scmd->device->sector_size;
2930 break;
2932 /* Everything else uses 512 byte "sectors" */
2933 default:
2934 qc->sect_size = ATA_SECT_SIZE;
2938 * Set flags so that all registers will be written, pass on
2939 * write indication (used for PIO/DMA setup), result TF is
2940 * copied back and we don't whine too much about its failure.
2942 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2943 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2944 tf->flags |= ATA_TFLAG_WRITE;
2946 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2949 * Set transfer length.
2951 * TODO: find out if we need to do more here to
2952 * cover scatter/gather case.
2954 ata_qc_set_pc_nbytes(qc);
2956 /* We may not issue DMA commands if no DMA mode is set */
2957 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2958 goto invalid_fld;
2960 /* sanity check for pio multi commands */
2961 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2962 goto invalid_fld;
2964 if (is_multi_taskfile(tf)) {
2965 unsigned int multi_count = 1 << (cdb[1] >> 5);
2967 /* compare the passed through multi_count
2968 * with the cached multi_count of libata
2970 if (multi_count != dev->multi_count)
2971 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
2972 multi_count);
2976 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2977 * SET_FEATURES - XFER MODE must be preceded/succeeded
2978 * by an update to hardware-specific registers for each
2979 * controller (i.e. the reason for ->set_piomode(),
2980 * ->set_dmamode(), and ->post_set_mode() hooks).
2982 if (tf->command == ATA_CMD_SET_FEATURES &&
2983 tf->feature == SETFEATURES_XFER)
2984 goto invalid_fld;
2987 * Filter TPM commands by default. These provide an
2988 * essentially uncontrolled encrypted "back door" between
2989 * applications and the disk. Set libata.allow_tpm=1 if you
2990 * have a real reason for wanting to use them. This ensures
2991 * that installed software cannot easily mess stuff up without
2992 * user intent. DVR type users will probably ship with this enabled
2993 * for movie content management.
2995 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2996 * for this and should do in future but that it is not sufficient as
2997 * DCS is an optional feature set. Thus we also do the software filter
2998 * so that we comply with the TC consortium stated goal that the user
2999 * can turn off TC features of their system.
3001 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
3002 goto invalid_fld;
3004 return 0;
3006 invalid_fld:
3007 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3008 /* "Invalid field in cdb" */
3009 return 1;
3012 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3014 struct ata_taskfile *tf = &qc->tf;
3015 struct scsi_cmnd *scmd = qc->scsicmd;
3016 struct ata_device *dev = qc->dev;
3017 const u8 *cdb = scmd->cmnd;
3018 u64 block;
3019 u32 n_block;
3020 u32 size;
3021 void *buf;
3023 /* we may not issue DMA commands if no DMA mode is set */
3024 if (unlikely(!dev->dma_mode))
3025 goto invalid_fld;
3027 if (unlikely(scmd->cmd_len < 16))
3028 goto invalid_fld;
3029 scsi_16_lba_len(cdb, &block, &n_block);
3031 /* for now we only support WRITE SAME with the unmap bit set */
3032 if (unlikely(!(cdb[1] & 0x8)))
3033 goto invalid_fld;
3036 * WRITE SAME always has a sector sized buffer as payload, this
3037 * should never be a multiple entry S/G list.
3039 if (!scsi_sg_count(scmd))
3040 goto invalid_fld;
3042 buf = page_address(sg_page(scsi_sglist(scmd)));
3043 size = ata_set_lba_range_entries(buf, 512, block, n_block);
3045 tf->protocol = ATA_PROT_DMA;
3046 tf->hob_feature = 0;
3047 tf->feature = ATA_DSM_TRIM;
3048 tf->hob_nsect = (size / 512) >> 8;
3049 tf->nsect = size / 512;
3050 tf->command = ATA_CMD_DSM;
3051 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3052 ATA_TFLAG_WRITE;
3054 ata_qc_set_pc_nbytes(qc);
3056 return 0;
3058 invalid_fld:
3059 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3060 /* "Invalid field in cdb" */
3061 return 1;
3065 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3066 * @dev: ATA device
3067 * @cmd: SCSI command opcode to consider
3069 * Look up the SCSI command given, and determine whether the
3070 * SCSI command is to be translated or simulated.
3072 * RETURNS:
3073 * Pointer to translation function if possible, %NULL if not.
3076 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3078 switch (cmd) {
3079 case READ_6:
3080 case READ_10:
3081 case READ_16:
3083 case WRITE_6:
3084 case WRITE_10:
3085 case WRITE_16:
3086 return ata_scsi_rw_xlat;
3088 case WRITE_SAME_16:
3089 return ata_scsi_write_same_xlat;
3091 case SYNCHRONIZE_CACHE:
3092 if (ata_try_flush_cache(dev))
3093 return ata_scsi_flush_xlat;
3094 break;
3096 case VERIFY:
3097 case VERIFY_16:
3098 return ata_scsi_verify_xlat;
3100 case ATA_12:
3101 case ATA_16:
3102 return ata_scsi_pass_thru;
3104 case START_STOP:
3105 return ata_scsi_start_stop_xlat;
3108 return NULL;
3112 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3113 * @ap: ATA port to which the command was being sent
3114 * @cmd: SCSI command to dump
3116 * Prints the contents of a SCSI command via printk().
3119 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3120 struct scsi_cmnd *cmd)
3122 #ifdef ATA_DEBUG
3123 struct scsi_device *scsidev = cmd->device;
3124 u8 *scsicmd = cmd->cmnd;
3126 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3127 ap->print_id,
3128 scsidev->channel, scsidev->id, scsidev->lun,
3129 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3130 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3131 scsicmd[8]);
3132 #endif
3135 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3136 struct ata_device *dev)
3138 u8 scsi_op = scmd->cmnd[0];
3139 ata_xlat_func_t xlat_func;
3140 int rc = 0;
3142 if (dev->class == ATA_DEV_ATA) {
3143 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3144 goto bad_cdb_len;
3146 xlat_func = ata_get_xlat_func(dev, scsi_op);
3147 } else {
3148 if (unlikely(!scmd->cmd_len))
3149 goto bad_cdb_len;
3151 xlat_func = NULL;
3152 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3153 /* relay SCSI command to ATAPI device */
3154 int len = COMMAND_SIZE(scsi_op);
3155 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3156 goto bad_cdb_len;
3158 xlat_func = atapi_xlat;
3159 } else {
3160 /* ATA_16 passthru, treat as an ATA command */
3161 if (unlikely(scmd->cmd_len > 16))
3162 goto bad_cdb_len;
3164 xlat_func = ata_get_xlat_func(dev, scsi_op);
3168 if (xlat_func)
3169 rc = ata_scsi_translate(dev, scmd, xlat_func);
3170 else
3171 ata_scsi_simulate(dev, scmd);
3173 return rc;
3175 bad_cdb_len:
3176 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3177 scmd->cmd_len, scsi_op, dev->cdb_len);
3178 scmd->result = DID_ERROR << 16;
3179 scmd->scsi_done(scmd);
3180 return 0;
3184 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3185 * @shost: SCSI host of command to be sent
3186 * @cmd: SCSI command to be sent
3188 * In some cases, this function translates SCSI commands into
3189 * ATA taskfiles, and queues the taskfiles to be sent to
3190 * hardware. In other cases, this function simulates a
3191 * SCSI device by evaluating and responding to certain
3192 * SCSI commands. This creates the overall effect of
3193 * ATA and ATAPI devices appearing as SCSI devices.
3195 * LOCKING:
3196 * ATA host lock
3198 * RETURNS:
3199 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3200 * 0 otherwise.
3202 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
3204 struct ata_port *ap;
3205 struct ata_device *dev;
3206 struct scsi_device *scsidev = cmd->device;
3207 int rc = 0;
3208 unsigned long irq_flags;
3210 ap = ata_shost_to_port(shost);
3212 spin_lock_irqsave(ap->lock, irq_flags);
3214 ata_scsi_dump_cdb(ap, cmd);
3216 dev = ata_scsi_find_dev(ap, scsidev);
3217 if (likely(dev))
3218 rc = __ata_scsi_queuecmd(cmd, dev);
3219 else {
3220 cmd->result = (DID_BAD_TARGET << 16);
3221 cmd->scsi_done(cmd);
3224 spin_unlock_irqrestore(ap->lock, irq_flags);
3226 return rc;
3230 * ata_scsi_simulate - simulate SCSI command on ATA device
3231 * @dev: the target device
3232 * @cmd: SCSI command being sent to device.
3234 * Interprets and directly executes a select list of SCSI commands
3235 * that can be handled internally.
3237 * LOCKING:
3238 * spin_lock_irqsave(host lock)
3241 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
3243 struct ata_scsi_args args;
3244 const u8 *scsicmd = cmd->cmnd;
3245 u8 tmp8;
3247 args.dev = dev;
3248 args.id = dev->id;
3249 args.cmd = cmd;
3250 args.done = cmd->scsi_done;
3252 switch(scsicmd[0]) {
3253 /* TODO: worth improving? */
3254 case FORMAT_UNIT:
3255 ata_scsi_invalid_field(cmd);
3256 break;
3258 case INQUIRY:
3259 if (scsicmd[1] & 2) /* is CmdDt set? */
3260 ata_scsi_invalid_field(cmd);
3261 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3262 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3263 else switch (scsicmd[2]) {
3264 case 0x00:
3265 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3266 break;
3267 case 0x80:
3268 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3269 break;
3270 case 0x83:
3271 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3272 break;
3273 case 0x89:
3274 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3275 break;
3276 case 0xb0:
3277 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3278 break;
3279 case 0xb1:
3280 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3281 break;
3282 case 0xb2:
3283 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
3284 break;
3285 default:
3286 ata_scsi_invalid_field(cmd);
3287 break;
3289 break;
3291 case MODE_SENSE:
3292 case MODE_SENSE_10:
3293 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3294 break;
3296 case MODE_SELECT: /* unconditionally return */
3297 case MODE_SELECT_10: /* bad-field-in-cdb */
3298 ata_scsi_invalid_field(cmd);
3299 break;
3301 case READ_CAPACITY:
3302 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3303 break;
3305 case SERVICE_ACTION_IN:
3306 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3307 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3308 else
3309 ata_scsi_invalid_field(cmd);
3310 break;
3312 case REPORT_LUNS:
3313 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3314 break;
3316 case REQUEST_SENSE:
3317 ata_scsi_set_sense(cmd, 0, 0, 0);
3318 cmd->result = (DRIVER_SENSE << 24);
3319 cmd->scsi_done(cmd);
3320 break;
3322 /* if we reach this, then writeback caching is disabled,
3323 * turning this into a no-op.
3325 case SYNCHRONIZE_CACHE:
3326 /* fall through */
3328 /* no-op's, complete with success */
3329 case REZERO_UNIT:
3330 case SEEK_6:
3331 case SEEK_10:
3332 case TEST_UNIT_READY:
3333 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3334 break;
3336 case SEND_DIAGNOSTIC:
3337 tmp8 = scsicmd[1] & ~(1 << 3);
3338 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3339 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3340 else
3341 ata_scsi_invalid_field(cmd);
3342 break;
3344 /* all other commands */
3345 default:
3346 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3347 /* "Invalid command operation code" */
3348 cmd->scsi_done(cmd);
3349 break;
3353 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3355 int i, rc;
3357 for (i = 0; i < host->n_ports; i++) {
3358 struct ata_port *ap = host->ports[i];
3359 struct Scsi_Host *shost;
3361 rc = -ENOMEM;
3362 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3363 if (!shost)
3364 goto err_alloc;
3366 *(struct ata_port **)&shost->hostdata[0] = ap;
3367 ap->scsi_host = shost;
3369 shost->transportt = ata_scsi_transport_template;
3370 shost->unique_id = ap->print_id;
3371 shost->max_id = 16;
3372 shost->max_lun = 1;
3373 shost->max_channel = 1;
3374 shost->max_cmd_len = 16;
3376 /* Schedule policy is determined by ->qc_defer()
3377 * callback and it needs to see every deferred qc.
3378 * Set host_blocked to 1 to prevent SCSI midlayer from
3379 * automatically deferring requests.
3381 shost->max_host_blocked = 1;
3383 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3384 if (rc)
3385 goto err_add;
3388 return 0;
3390 err_add:
3391 scsi_host_put(host->ports[i]->scsi_host);
3392 err_alloc:
3393 while (--i >= 0) {
3394 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3396 scsi_remove_host(shost);
3397 scsi_host_put(shost);
3399 return rc;
3402 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3404 int tries = 5;
3405 struct ata_device *last_failed_dev = NULL;
3406 struct ata_link *link;
3407 struct ata_device *dev;
3409 repeat:
3410 ata_for_each_link(link, ap, EDGE) {
3411 ata_for_each_dev(dev, link, ENABLED) {
3412 struct scsi_device *sdev;
3413 int channel = 0, id = 0;
3415 if (dev->sdev)
3416 continue;
3418 if (ata_is_host_link(link))
3419 id = dev->devno;
3420 else
3421 channel = link->pmp;
3423 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3424 NULL);
3425 if (!IS_ERR(sdev)) {
3426 dev->sdev = sdev;
3427 scsi_device_put(sdev);
3428 } else {
3429 dev->sdev = NULL;
3434 /* If we scanned while EH was in progress or allocation
3435 * failure occurred, scan would have failed silently. Check
3436 * whether all devices are attached.
3438 ata_for_each_link(link, ap, EDGE) {
3439 ata_for_each_dev(dev, link, ENABLED) {
3440 if (!dev->sdev)
3441 goto exit_loop;
3444 exit_loop:
3445 if (!link)
3446 return;
3448 /* we're missing some SCSI devices */
3449 if (sync) {
3450 /* If caller requested synchrnous scan && we've made
3451 * any progress, sleep briefly and repeat.
3453 if (dev != last_failed_dev) {
3454 msleep(100);
3455 last_failed_dev = dev;
3456 goto repeat;
3459 /* We might be failing to detect boot device, give it
3460 * a few more chances.
3462 if (--tries) {
3463 msleep(100);
3464 goto repeat;
3467 ata_port_err(ap,
3468 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
3471 queue_delayed_work(system_long_wq, &ap->hotplug_task,
3472 round_jiffies_relative(HZ));
3476 * ata_scsi_offline_dev - offline attached SCSI device
3477 * @dev: ATA device to offline attached SCSI device for
3479 * This function is called from ata_eh_hotplug() and responsible
3480 * for taking the SCSI device attached to @dev offline. This
3481 * function is called with host lock which protects dev->sdev
3482 * against clearing.
3484 * LOCKING:
3485 * spin_lock_irqsave(host lock)
3487 * RETURNS:
3488 * 1 if attached SCSI device exists, 0 otherwise.
3490 int ata_scsi_offline_dev(struct ata_device *dev)
3492 if (dev->sdev) {
3493 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3494 return 1;
3496 return 0;
3500 * ata_scsi_remove_dev - remove attached SCSI device
3501 * @dev: ATA device to remove attached SCSI device for
3503 * This function is called from ata_eh_scsi_hotplug() and
3504 * responsible for removing the SCSI device attached to @dev.
3506 * LOCKING:
3507 * Kernel thread context (may sleep).
3509 static void ata_scsi_remove_dev(struct ata_device *dev)
3511 struct ata_port *ap = dev->link->ap;
3512 struct scsi_device *sdev;
3513 unsigned long flags;
3515 /* Alas, we need to grab scan_mutex to ensure SCSI device
3516 * state doesn't change underneath us and thus
3517 * scsi_device_get() always succeeds. The mutex locking can
3518 * be removed if there is __scsi_device_get() interface which
3519 * increments reference counts regardless of device state.
3521 mutex_lock(&ap->scsi_host->scan_mutex);
3522 spin_lock_irqsave(ap->lock, flags);
3524 /* clearing dev->sdev is protected by host lock */
3525 sdev = dev->sdev;
3526 dev->sdev = NULL;
3528 if (sdev) {
3529 /* If user initiated unplug races with us, sdev can go
3530 * away underneath us after the host lock and
3531 * scan_mutex are released. Hold onto it.
3533 if (scsi_device_get(sdev) == 0) {
3534 /* The following ensures the attached sdev is
3535 * offline on return from ata_scsi_offline_dev()
3536 * regardless it wins or loses the race
3537 * against this function.
3539 scsi_device_set_state(sdev, SDEV_OFFLINE);
3540 } else {
3541 WARN_ON(1);
3542 sdev = NULL;
3546 spin_unlock_irqrestore(ap->lock, flags);
3547 mutex_unlock(&ap->scsi_host->scan_mutex);
3549 if (sdev) {
3550 ata_dev_info(dev, "detaching (SCSI %s)\n",
3551 dev_name(&sdev->sdev_gendev));
3553 scsi_remove_device(sdev);
3554 scsi_device_put(sdev);
3558 static void ata_scsi_handle_link_detach(struct ata_link *link)
3560 struct ata_port *ap = link->ap;
3561 struct ata_device *dev;
3563 ata_for_each_dev(dev, link, ALL) {
3564 unsigned long flags;
3566 if (!(dev->flags & ATA_DFLAG_DETACHED))
3567 continue;
3569 spin_lock_irqsave(ap->lock, flags);
3570 dev->flags &= ~ATA_DFLAG_DETACHED;
3571 spin_unlock_irqrestore(ap->lock, flags);
3573 ata_scsi_remove_dev(dev);
3578 * ata_scsi_media_change_notify - send media change event
3579 * @dev: Pointer to the disk device with media change event
3581 * Tell the block layer to send a media change notification
3582 * event.
3584 * LOCKING:
3585 * spin_lock_irqsave(host lock)
3587 void ata_scsi_media_change_notify(struct ata_device *dev)
3589 if (dev->sdev)
3590 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3591 GFP_ATOMIC);
3595 * ata_scsi_hotplug - SCSI part of hotplug
3596 * @work: Pointer to ATA port to perform SCSI hotplug on
3598 * Perform SCSI part of hotplug. It's executed from a separate
3599 * workqueue after EH completes. This is necessary because SCSI
3600 * hot plugging requires working EH and hot unplugging is
3601 * synchronized with hot plugging with a mutex.
3603 * LOCKING:
3604 * Kernel thread context (may sleep).
3606 void ata_scsi_hotplug(struct work_struct *work)
3608 struct ata_port *ap =
3609 container_of(work, struct ata_port, hotplug_task.work);
3610 int i;
3612 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3613 DPRINTK("ENTER/EXIT - unloading\n");
3614 return;
3617 DPRINTK("ENTER\n");
3618 mutex_lock(&ap->scsi_scan_mutex);
3620 /* Unplug detached devices. We cannot use link iterator here
3621 * because PMP links have to be scanned even if PMP is
3622 * currently not attached. Iterate manually.
3624 ata_scsi_handle_link_detach(&ap->link);
3625 if (ap->pmp_link)
3626 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3627 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3629 /* scan for new ones */
3630 ata_scsi_scan_host(ap, 0);
3632 mutex_unlock(&ap->scsi_scan_mutex);
3633 DPRINTK("EXIT\n");
3637 * ata_scsi_user_scan - indication for user-initiated bus scan
3638 * @shost: SCSI host to scan
3639 * @channel: Channel to scan
3640 * @id: ID to scan
3641 * @lun: LUN to scan
3643 * This function is called when user explicitly requests bus
3644 * scan. Set probe pending flag and invoke EH.
3646 * LOCKING:
3647 * SCSI layer (we don't care)
3649 * RETURNS:
3650 * Zero.
3652 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3653 unsigned int id, unsigned int lun)
3655 struct ata_port *ap = ata_shost_to_port(shost);
3656 unsigned long flags;
3657 int devno, rc = 0;
3659 if (!ap->ops->error_handler)
3660 return -EOPNOTSUPP;
3662 if (lun != SCAN_WILD_CARD && lun)
3663 return -EINVAL;
3665 if (!sata_pmp_attached(ap)) {
3666 if (channel != SCAN_WILD_CARD && channel)
3667 return -EINVAL;
3668 devno = id;
3669 } else {
3670 if (id != SCAN_WILD_CARD && id)
3671 return -EINVAL;
3672 devno = channel;
3675 spin_lock_irqsave(ap->lock, flags);
3677 if (devno == SCAN_WILD_CARD) {
3678 struct ata_link *link;
3680 ata_for_each_link(link, ap, EDGE) {
3681 struct ata_eh_info *ehi = &link->eh_info;
3682 ehi->probe_mask |= ATA_ALL_DEVICES;
3683 ehi->action |= ATA_EH_RESET;
3685 } else {
3686 struct ata_device *dev = ata_find_dev(ap, devno);
3688 if (dev) {
3689 struct ata_eh_info *ehi = &dev->link->eh_info;
3690 ehi->probe_mask |= 1 << dev->devno;
3691 ehi->action |= ATA_EH_RESET;
3692 } else
3693 rc = -EINVAL;
3696 if (rc == 0) {
3697 ata_port_schedule_eh(ap);
3698 spin_unlock_irqrestore(ap->lock, flags);
3699 ata_port_wait_eh(ap);
3700 } else
3701 spin_unlock_irqrestore(ap->lock, flags);
3703 return rc;
3707 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3708 * @work: Pointer to ATA port to perform scsi_rescan_device()
3710 * After ATA pass thru (SAT) commands are executed successfully,
3711 * libata need to propagate the changes to SCSI layer.
3713 * LOCKING:
3714 * Kernel thread context (may sleep).
3716 void ata_scsi_dev_rescan(struct work_struct *work)
3718 struct ata_port *ap =
3719 container_of(work, struct ata_port, scsi_rescan_task);
3720 struct ata_link *link;
3721 struct ata_device *dev;
3722 unsigned long flags;
3724 mutex_lock(&ap->scsi_scan_mutex);
3725 spin_lock_irqsave(ap->lock, flags);
3727 ata_for_each_link(link, ap, EDGE) {
3728 ata_for_each_dev(dev, link, ENABLED) {
3729 struct scsi_device *sdev = dev->sdev;
3731 if (!sdev)
3732 continue;
3733 if (scsi_device_get(sdev))
3734 continue;
3736 spin_unlock_irqrestore(ap->lock, flags);
3737 scsi_rescan_device(&(sdev->sdev_gendev));
3738 scsi_device_put(sdev);
3739 spin_lock_irqsave(ap->lock, flags);
3743 spin_unlock_irqrestore(ap->lock, flags);
3744 mutex_unlock(&ap->scsi_scan_mutex);
3748 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3749 * @host: ATA host container for all SAS ports
3750 * @port_info: Information from low-level host driver
3751 * @shost: SCSI host that the scsi device is attached to
3753 * LOCKING:
3754 * PCI/etc. bus probe sem.
3756 * RETURNS:
3757 * ata_port pointer on success / NULL on failure.
3760 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3761 struct ata_port_info *port_info,
3762 struct Scsi_Host *shost)
3764 struct ata_port *ap;
3766 ap = ata_port_alloc(host);
3767 if (!ap)
3768 return NULL;
3770 ap->port_no = 0;
3771 ap->lock = &host->lock;
3772 ap->pio_mask = port_info->pio_mask;
3773 ap->mwdma_mask = port_info->mwdma_mask;
3774 ap->udma_mask = port_info->udma_mask;
3775 ap->flags |= port_info->flags;
3776 ap->ops = port_info->port_ops;
3777 ap->cbl = ATA_CBL_SATA;
3779 return ap;
3781 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3784 * ata_sas_port_start - Set port up for dma.
3785 * @ap: Port to initialize
3787 * Called just after data structures for each port are
3788 * initialized.
3790 * May be used as the port_start() entry in ata_port_operations.
3792 * LOCKING:
3793 * Inherited from caller.
3795 int ata_sas_port_start(struct ata_port *ap)
3798 * the port is marked as frozen at allocation time, but if we don't
3799 * have new eh, we won't thaw it
3801 if (!ap->ops->error_handler)
3802 ap->pflags &= ~ATA_PFLAG_FROZEN;
3803 return 0;
3805 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3808 * ata_port_stop - Undo ata_sas_port_start()
3809 * @ap: Port to shut down
3811 * May be used as the port_stop() entry in ata_port_operations.
3813 * LOCKING:
3814 * Inherited from caller.
3817 void ata_sas_port_stop(struct ata_port *ap)
3820 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3823 * ata_sas_port_init - Initialize a SATA device
3824 * @ap: SATA port to initialize
3826 * LOCKING:
3827 * PCI/etc. bus probe sem.
3829 * RETURNS:
3830 * Zero on success, non-zero on error.
3833 int ata_sas_port_init(struct ata_port *ap)
3835 int rc = ap->ops->port_start(ap);
3837 if (!rc) {
3838 ap->print_id = ata_print_id++;
3839 rc = ata_port_probe(ap);
3842 return rc;
3844 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3847 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3848 * @ap: SATA port to destroy
3852 void ata_sas_port_destroy(struct ata_port *ap)
3854 if (ap->ops->port_stop)
3855 ap->ops->port_stop(ap);
3856 kfree(ap);
3858 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3861 * ata_sas_slave_configure - Default slave_config routine for libata devices
3862 * @sdev: SCSI device to configure
3863 * @ap: ATA port to which SCSI device is attached
3865 * RETURNS:
3866 * Zero.
3869 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3871 ata_scsi_sdev_config(sdev);
3872 ata_scsi_dev_config(sdev, ap->link.device);
3873 return 0;
3875 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3878 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3879 * @cmd: SCSI command to be sent
3880 * @ap: ATA port to which the command is being sent
3882 * RETURNS:
3883 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3884 * 0 otherwise.
3887 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
3889 int rc = 0;
3891 ata_scsi_dump_cdb(ap, cmd);
3893 if (likely(ata_dev_enabled(ap->link.device)))
3894 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
3895 else {
3896 cmd->result = (DID_BAD_TARGET << 16);
3897 cmd->scsi_done(cmd);
3899 return rc;
3901 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);