xfs: remove unused XBT_FORCE_SLEEP bit
[linux-2.6/cjktty.git] / drivers / ata / libata-scsi.c
blob72a9770ac42f51e95db81f318d6aa30acdc690d2
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_change_queue_depth - helper for ata_scsi_change_queue_depth
1221 * libsas and libata have different approaches for associating a sdev to
1222 * its ata_port.
1225 int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1226 int queue_depth, int reason)
1228 struct ata_device *dev;
1229 unsigned long flags;
1231 if (reason != SCSI_QDEPTH_DEFAULT)
1232 return -EOPNOTSUPP;
1234 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1235 return sdev->queue_depth;
1237 dev = ata_scsi_find_dev(ap, sdev);
1238 if (!dev || !ata_dev_enabled(dev))
1239 return sdev->queue_depth;
1241 /* NCQ enabled? */
1242 spin_lock_irqsave(ap->lock, flags);
1243 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1244 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1245 dev->flags |= ATA_DFLAG_NCQ_OFF;
1246 queue_depth = 1;
1248 spin_unlock_irqrestore(ap->lock, flags);
1250 /* limit and apply queue depth */
1251 queue_depth = min(queue_depth, sdev->host->can_queue);
1252 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1253 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1255 if (sdev->queue_depth == queue_depth)
1256 return -EINVAL;
1258 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1259 return queue_depth;
1263 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1264 * @sdev: SCSI device to configure queue depth for
1265 * @queue_depth: new queue depth
1266 * @reason: calling context
1268 * This is libata standard hostt->change_queue_depth callback.
1269 * SCSI will call into this callback when user tries to set queue
1270 * depth via sysfs.
1272 * LOCKING:
1273 * SCSI layer (we don't care)
1275 * RETURNS:
1276 * Newly configured queue depth.
1278 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth,
1279 int reason)
1281 struct ata_port *ap = ata_shost_to_port(sdev->host);
1283 return __ata_change_queue_depth(ap, sdev, queue_depth, reason);
1287 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1288 * @qc: Storage for translated ATA taskfile
1290 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1291 * (to start). Perhaps these commands should be preceded by
1292 * CHECK POWER MODE to see what power mode the device is already in.
1293 * [See SAT revision 5 at www.t10.org]
1295 * LOCKING:
1296 * spin_lock_irqsave(host lock)
1298 * RETURNS:
1299 * Zero on success, non-zero on error.
1301 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1303 struct scsi_cmnd *scmd = qc->scsicmd;
1304 struct ata_taskfile *tf = &qc->tf;
1305 const u8 *cdb = scmd->cmnd;
1307 if (scmd->cmd_len < 5)
1308 goto invalid_fld;
1310 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1311 tf->protocol = ATA_PROT_NODATA;
1312 if (cdb[1] & 0x1) {
1313 ; /* ignore IMMED bit, violates sat-r05 */
1315 if (cdb[4] & 0x2)
1316 goto invalid_fld; /* LOEJ bit set not supported */
1317 if (((cdb[4] >> 4) & 0xf) != 0)
1318 goto invalid_fld; /* power conditions not supported */
1320 if (cdb[4] & 0x1) {
1321 tf->nsect = 1; /* 1 sector, lba=0 */
1323 if (qc->dev->flags & ATA_DFLAG_LBA) {
1324 tf->flags |= ATA_TFLAG_LBA;
1326 tf->lbah = 0x0;
1327 tf->lbam = 0x0;
1328 tf->lbal = 0x0;
1329 tf->device |= ATA_LBA;
1330 } else {
1331 /* CHS */
1332 tf->lbal = 0x1; /* sect */
1333 tf->lbam = 0x0; /* cyl low */
1334 tf->lbah = 0x0; /* cyl high */
1337 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1338 } else {
1339 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1340 * or S5) causing some drives to spin up and down again.
1342 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1343 system_state == SYSTEM_POWER_OFF)
1344 goto skip;
1346 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1347 system_entering_hibernation())
1348 goto skip;
1350 /* Issue ATA STANDBY IMMEDIATE command */
1351 tf->command = ATA_CMD_STANDBYNOW1;
1355 * Standby and Idle condition timers could be implemented but that
1356 * would require libata to implement the Power condition mode page
1357 * and allow the user to change it. Changing mode pages requires
1358 * MODE SELECT to be implemented.
1361 return 0;
1363 invalid_fld:
1364 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1365 /* "Invalid field in cbd" */
1366 return 1;
1367 skip:
1368 scmd->result = SAM_STAT_GOOD;
1369 return 1;
1374 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1375 * @qc: Storage for translated ATA taskfile
1377 * Sets up an ATA taskfile to issue FLUSH CACHE or
1378 * FLUSH CACHE EXT.
1380 * LOCKING:
1381 * spin_lock_irqsave(host lock)
1383 * RETURNS:
1384 * Zero on success, non-zero on error.
1386 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1388 struct ata_taskfile *tf = &qc->tf;
1390 tf->flags |= ATA_TFLAG_DEVICE;
1391 tf->protocol = ATA_PROT_NODATA;
1393 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1394 tf->command = ATA_CMD_FLUSH_EXT;
1395 else
1396 tf->command = ATA_CMD_FLUSH;
1398 /* flush is critical for IO integrity, consider it an IO command */
1399 qc->flags |= ATA_QCFLAG_IO;
1401 return 0;
1405 * scsi_6_lba_len - Get LBA and transfer length
1406 * @cdb: SCSI command to translate
1408 * Calculate LBA and transfer length for 6-byte commands.
1410 * RETURNS:
1411 * @plba: the LBA
1412 * @plen: the transfer length
1414 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1416 u64 lba = 0;
1417 u32 len;
1419 VPRINTK("six-byte command\n");
1421 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1422 lba |= ((u64)cdb[2]) << 8;
1423 lba |= ((u64)cdb[3]);
1425 len = cdb[4];
1427 *plba = lba;
1428 *plen = len;
1432 * scsi_10_lba_len - Get LBA and transfer length
1433 * @cdb: SCSI command to translate
1435 * Calculate LBA and transfer length for 10-byte commands.
1437 * RETURNS:
1438 * @plba: the LBA
1439 * @plen: the transfer length
1441 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1443 u64 lba = 0;
1444 u32 len = 0;
1446 VPRINTK("ten-byte command\n");
1448 lba |= ((u64)cdb[2]) << 24;
1449 lba |= ((u64)cdb[3]) << 16;
1450 lba |= ((u64)cdb[4]) << 8;
1451 lba |= ((u64)cdb[5]);
1453 len |= ((u32)cdb[7]) << 8;
1454 len |= ((u32)cdb[8]);
1456 *plba = lba;
1457 *plen = len;
1461 * scsi_16_lba_len - Get LBA and transfer length
1462 * @cdb: SCSI command to translate
1464 * Calculate LBA and transfer length for 16-byte commands.
1466 * RETURNS:
1467 * @plba: the LBA
1468 * @plen: the transfer length
1470 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1472 u64 lba = 0;
1473 u32 len = 0;
1475 VPRINTK("sixteen-byte command\n");
1477 lba |= ((u64)cdb[2]) << 56;
1478 lba |= ((u64)cdb[3]) << 48;
1479 lba |= ((u64)cdb[4]) << 40;
1480 lba |= ((u64)cdb[5]) << 32;
1481 lba |= ((u64)cdb[6]) << 24;
1482 lba |= ((u64)cdb[7]) << 16;
1483 lba |= ((u64)cdb[8]) << 8;
1484 lba |= ((u64)cdb[9]);
1486 len |= ((u32)cdb[10]) << 24;
1487 len |= ((u32)cdb[11]) << 16;
1488 len |= ((u32)cdb[12]) << 8;
1489 len |= ((u32)cdb[13]);
1491 *plba = lba;
1492 *plen = len;
1496 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1497 * @qc: Storage for translated ATA taskfile
1499 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1501 * LOCKING:
1502 * spin_lock_irqsave(host lock)
1504 * RETURNS:
1505 * Zero on success, non-zero on error.
1507 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1509 struct scsi_cmnd *scmd = qc->scsicmd;
1510 struct ata_taskfile *tf = &qc->tf;
1511 struct ata_device *dev = qc->dev;
1512 u64 dev_sectors = qc->dev->n_sectors;
1513 const u8 *cdb = scmd->cmnd;
1514 u64 block;
1515 u32 n_block;
1517 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1518 tf->protocol = ATA_PROT_NODATA;
1520 if (cdb[0] == VERIFY) {
1521 if (scmd->cmd_len < 10)
1522 goto invalid_fld;
1523 scsi_10_lba_len(cdb, &block, &n_block);
1524 } else if (cdb[0] == VERIFY_16) {
1525 if (scmd->cmd_len < 16)
1526 goto invalid_fld;
1527 scsi_16_lba_len(cdb, &block, &n_block);
1528 } else
1529 goto invalid_fld;
1531 if (!n_block)
1532 goto nothing_to_do;
1533 if (block >= dev_sectors)
1534 goto out_of_range;
1535 if ((block + n_block) > dev_sectors)
1536 goto out_of_range;
1538 if (dev->flags & ATA_DFLAG_LBA) {
1539 tf->flags |= ATA_TFLAG_LBA;
1541 if (lba_28_ok(block, n_block)) {
1542 /* use LBA28 */
1543 tf->command = ATA_CMD_VERIFY;
1544 tf->device |= (block >> 24) & 0xf;
1545 } else if (lba_48_ok(block, n_block)) {
1546 if (!(dev->flags & ATA_DFLAG_LBA48))
1547 goto out_of_range;
1549 /* use LBA48 */
1550 tf->flags |= ATA_TFLAG_LBA48;
1551 tf->command = ATA_CMD_VERIFY_EXT;
1553 tf->hob_nsect = (n_block >> 8) & 0xff;
1555 tf->hob_lbah = (block >> 40) & 0xff;
1556 tf->hob_lbam = (block >> 32) & 0xff;
1557 tf->hob_lbal = (block >> 24) & 0xff;
1558 } else
1559 /* request too large even for LBA48 */
1560 goto out_of_range;
1562 tf->nsect = n_block & 0xff;
1564 tf->lbah = (block >> 16) & 0xff;
1565 tf->lbam = (block >> 8) & 0xff;
1566 tf->lbal = block & 0xff;
1568 tf->device |= ATA_LBA;
1569 } else {
1570 /* CHS */
1571 u32 sect, head, cyl, track;
1573 if (!lba_28_ok(block, n_block))
1574 goto out_of_range;
1576 /* Convert LBA to CHS */
1577 track = (u32)block / dev->sectors;
1578 cyl = track / dev->heads;
1579 head = track % dev->heads;
1580 sect = (u32)block % dev->sectors + 1;
1582 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1583 (u32)block, track, cyl, head, sect);
1585 /* Check whether the converted CHS can fit.
1586 Cylinder: 0-65535
1587 Head: 0-15
1588 Sector: 1-255*/
1589 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1590 goto out_of_range;
1592 tf->command = ATA_CMD_VERIFY;
1593 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1594 tf->lbal = sect;
1595 tf->lbam = cyl;
1596 tf->lbah = cyl >> 8;
1597 tf->device |= head;
1600 return 0;
1602 invalid_fld:
1603 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1604 /* "Invalid field in cbd" */
1605 return 1;
1607 out_of_range:
1608 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1609 /* "Logical Block Address out of range" */
1610 return 1;
1612 nothing_to_do:
1613 scmd->result = SAM_STAT_GOOD;
1614 return 1;
1618 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1619 * @qc: Storage for translated ATA taskfile
1621 * Converts any of six SCSI read/write commands into the
1622 * ATA counterpart, including starting sector (LBA),
1623 * sector count, and taking into account the device's LBA48
1624 * support.
1626 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1627 * %WRITE_16 are currently supported.
1629 * LOCKING:
1630 * spin_lock_irqsave(host lock)
1632 * RETURNS:
1633 * Zero on success, non-zero on error.
1635 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1637 struct scsi_cmnd *scmd = qc->scsicmd;
1638 const u8 *cdb = scmd->cmnd;
1639 unsigned int tf_flags = 0;
1640 u64 block;
1641 u32 n_block;
1642 int rc;
1644 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1645 tf_flags |= ATA_TFLAG_WRITE;
1647 /* Calculate the SCSI LBA, transfer length and FUA. */
1648 switch (cdb[0]) {
1649 case READ_10:
1650 case WRITE_10:
1651 if (unlikely(scmd->cmd_len < 10))
1652 goto invalid_fld;
1653 scsi_10_lba_len(cdb, &block, &n_block);
1654 if (unlikely(cdb[1] & (1 << 3)))
1655 tf_flags |= ATA_TFLAG_FUA;
1656 break;
1657 case READ_6:
1658 case WRITE_6:
1659 if (unlikely(scmd->cmd_len < 6))
1660 goto invalid_fld;
1661 scsi_6_lba_len(cdb, &block, &n_block);
1663 /* for 6-byte r/w commands, transfer length 0
1664 * means 256 blocks of data, not 0 block.
1666 if (!n_block)
1667 n_block = 256;
1668 break;
1669 case READ_16:
1670 case WRITE_16:
1671 if (unlikely(scmd->cmd_len < 16))
1672 goto invalid_fld;
1673 scsi_16_lba_len(cdb, &block, &n_block);
1674 if (unlikely(cdb[1] & (1 << 3)))
1675 tf_flags |= ATA_TFLAG_FUA;
1676 break;
1677 default:
1678 DPRINTK("no-byte command\n");
1679 goto invalid_fld;
1682 /* Check and compose ATA command */
1683 if (!n_block)
1684 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1685 * length 0 means transfer 0 block of data.
1686 * However, for ATA R/W commands, sector count 0 means
1687 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1689 * WARNING: one or two older ATA drives treat 0 as 0...
1691 goto nothing_to_do;
1693 qc->flags |= ATA_QCFLAG_IO;
1694 qc->nbytes = n_block * scmd->device->sector_size;
1696 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1697 qc->tag);
1698 if (likely(rc == 0))
1699 return 0;
1701 if (rc == -ERANGE)
1702 goto out_of_range;
1703 /* treat all other errors as -EINVAL, fall through */
1704 invalid_fld:
1705 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1706 /* "Invalid field in cbd" */
1707 return 1;
1709 out_of_range:
1710 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1711 /* "Logical Block Address out of range" */
1712 return 1;
1714 nothing_to_do:
1715 scmd->result = SAM_STAT_GOOD;
1716 return 1;
1719 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1721 struct ata_port *ap = qc->ap;
1722 struct scsi_cmnd *cmd = qc->scsicmd;
1723 u8 *cdb = cmd->cmnd;
1724 int need_sense = (qc->err_mask != 0);
1726 /* For ATA pass thru (SAT) commands, generate a sense block if
1727 * user mandated it or if there's an error. Note that if we
1728 * generate because the user forced us to, a check condition
1729 * is generated and the ATA register values are returned
1730 * whether the command completed successfully or not. If there
1731 * was no error, SK, ASC and ASCQ will all be zero.
1733 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1734 ((cdb[2] & 0x20) || need_sense)) {
1735 ata_gen_passthru_sense(qc);
1736 } else {
1737 if (!need_sense) {
1738 cmd->result = SAM_STAT_GOOD;
1739 } else {
1740 /* TODO: decide which descriptor format to use
1741 * for 48b LBA devices and call that here
1742 * instead of the fixed desc, which is only
1743 * good for smaller LBA (and maybe CHS?)
1744 * devices.
1746 ata_gen_ata_sense(qc);
1750 if (need_sense && !ap->ops->error_handler)
1751 ata_dump_status(ap->print_id, &qc->result_tf);
1753 qc->scsidone(cmd);
1755 ata_qc_free(qc);
1759 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1760 * @dev: ATA device to which the command is addressed
1761 * @cmd: SCSI command to execute
1762 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1764 * Our ->queuecommand() function has decided that the SCSI
1765 * command issued can be directly translated into an ATA
1766 * command, rather than handled internally.
1768 * This function sets up an ata_queued_cmd structure for the
1769 * SCSI command, and sends that ata_queued_cmd to the hardware.
1771 * The xlat_func argument (actor) returns 0 if ready to execute
1772 * ATA command, else 1 to finish translation. If 1 is returned
1773 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1774 * to be set reflecting an error condition or clean (early)
1775 * termination.
1777 * LOCKING:
1778 * spin_lock_irqsave(host lock)
1780 * RETURNS:
1781 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1782 * needs to be deferred.
1784 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1785 ata_xlat_func_t xlat_func)
1787 struct ata_port *ap = dev->link->ap;
1788 struct ata_queued_cmd *qc;
1789 int rc;
1791 VPRINTK("ENTER\n");
1793 qc = ata_scsi_qc_new(dev, cmd);
1794 if (!qc)
1795 goto err_mem;
1797 /* data is present; dma-map it */
1798 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1799 cmd->sc_data_direction == DMA_TO_DEVICE) {
1800 if (unlikely(scsi_bufflen(cmd) < 1)) {
1801 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1802 goto err_did;
1805 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1807 qc->dma_dir = cmd->sc_data_direction;
1810 qc->complete_fn = ata_scsi_qc_complete;
1812 if (xlat_func(qc))
1813 goto early_finish;
1815 if (ap->ops->qc_defer) {
1816 if ((rc = ap->ops->qc_defer(qc)))
1817 goto defer;
1820 /* select device, send command to hardware */
1821 ata_qc_issue(qc);
1823 VPRINTK("EXIT\n");
1824 return 0;
1826 early_finish:
1827 ata_qc_free(qc);
1828 cmd->scsi_done(cmd);
1829 DPRINTK("EXIT - early finish (good or error)\n");
1830 return 0;
1832 err_did:
1833 ata_qc_free(qc);
1834 cmd->result = (DID_ERROR << 16);
1835 cmd->scsi_done(cmd);
1836 err_mem:
1837 DPRINTK("EXIT - internal\n");
1838 return 0;
1840 defer:
1841 ata_qc_free(qc);
1842 DPRINTK("EXIT - defer\n");
1843 if (rc == ATA_DEFER_LINK)
1844 return SCSI_MLQUEUE_DEVICE_BUSY;
1845 else
1846 return SCSI_MLQUEUE_HOST_BUSY;
1850 * ata_scsi_rbuf_get - Map response buffer.
1851 * @cmd: SCSI command containing buffer to be mapped.
1852 * @flags: unsigned long variable to store irq enable status
1853 * @copy_in: copy in from user buffer
1855 * Prepare buffer for simulated SCSI commands.
1857 * LOCKING:
1858 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1860 * RETURNS:
1861 * Pointer to response buffer.
1863 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1864 unsigned long *flags)
1866 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1868 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1869 if (copy_in)
1870 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1871 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1872 return ata_scsi_rbuf;
1876 * ata_scsi_rbuf_put - Unmap response buffer.
1877 * @cmd: SCSI command containing buffer to be unmapped.
1878 * @copy_out: copy out result
1879 * @flags: @flags passed to ata_scsi_rbuf_get()
1881 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1882 * @copy_back is true.
1884 * LOCKING:
1885 * Unlocks ata_scsi_rbuf_lock.
1887 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1888 unsigned long *flags)
1890 if (copy_out)
1891 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1892 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1893 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1897 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1898 * @args: device IDENTIFY data / SCSI command of interest.
1899 * @actor: Callback hook for desired SCSI command simulator
1901 * Takes care of the hard work of simulating a SCSI command...
1902 * Mapping the response buffer, calling the command's handler,
1903 * and handling the handler's return value. This return value
1904 * indicates whether the handler wishes the SCSI command to be
1905 * completed successfully (0), or not (in which case cmd->result
1906 * and sense buffer are assumed to be set).
1908 * LOCKING:
1909 * spin_lock_irqsave(host lock)
1911 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1912 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1914 u8 *rbuf;
1915 unsigned int rc;
1916 struct scsi_cmnd *cmd = args->cmd;
1917 unsigned long flags;
1919 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1920 rc = actor(args, rbuf);
1921 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1923 if (rc == 0)
1924 cmd->result = SAM_STAT_GOOD;
1925 args->done(cmd);
1929 * ata_scsiop_inq_std - Simulate INQUIRY command
1930 * @args: device IDENTIFY data / SCSI command of interest.
1931 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1933 * Returns standard device identification data associated
1934 * with non-VPD INQUIRY command output.
1936 * LOCKING:
1937 * spin_lock_irqsave(host lock)
1939 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1941 const u8 versions[] = {
1942 0x60, /* SAM-3 (no version claimed) */
1944 0x03,
1945 0x20, /* SBC-2 (no version claimed) */
1947 0x02,
1948 0x60 /* SPC-3 (no version claimed) */
1950 u8 hdr[] = {
1951 TYPE_DISK,
1953 0x5, /* claim SPC-3 version compatibility */
1955 95 - 4
1958 VPRINTK("ENTER\n");
1960 /* set scsi removeable (RMB) bit per ata bit */
1961 if (ata_id_removeable(args->id))
1962 hdr[1] |= (1 << 7);
1964 memcpy(rbuf, hdr, sizeof(hdr));
1965 memcpy(&rbuf[8], "ATA ", 8);
1966 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1967 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1969 if (rbuf[32] == 0 || rbuf[32] == ' ')
1970 memcpy(&rbuf[32], "n/a ", 4);
1972 memcpy(rbuf + 59, versions, sizeof(versions));
1974 return 0;
1978 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1979 * @args: device IDENTIFY data / SCSI command of interest.
1980 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1982 * Returns list of inquiry VPD pages available.
1984 * LOCKING:
1985 * spin_lock_irqsave(host lock)
1987 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1989 const u8 pages[] = {
1990 0x00, /* page 0x00, this page */
1991 0x80, /* page 0x80, unit serial no page */
1992 0x83, /* page 0x83, device ident page */
1993 0x89, /* page 0x89, ata info page */
1994 0xb0, /* page 0xb0, block limits page */
1995 0xb1, /* page 0xb1, block device characteristics page */
1996 0xb2, /* page 0xb2, thin provisioning page */
1999 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
2000 memcpy(rbuf + 4, pages, sizeof(pages));
2001 return 0;
2005 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2006 * @args: device IDENTIFY data / SCSI command of interest.
2007 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2009 * Returns ATA device serial number.
2011 * LOCKING:
2012 * spin_lock_irqsave(host lock)
2014 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2016 const u8 hdr[] = {
2018 0x80, /* this page code */
2020 ATA_ID_SERNO_LEN, /* page len */
2023 memcpy(rbuf, hdr, sizeof(hdr));
2024 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2025 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2026 return 0;
2030 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2031 * @args: device IDENTIFY data / SCSI command of interest.
2032 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2034 * Yields two logical unit device identification designators:
2035 * - vendor specific ASCII containing the ATA serial number
2036 * - SAT defined "t10 vendor id based" containing ASCII vendor
2037 * name ("ATA "), model and serial numbers.
2039 * LOCKING:
2040 * spin_lock_irqsave(host lock)
2042 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2044 const int sat_model_serial_desc_len = 68;
2045 int num;
2047 rbuf[1] = 0x83; /* this page code */
2048 num = 4;
2050 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2051 rbuf[num + 0] = 2;
2052 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2053 num += 4;
2054 ata_id_string(args->id, (unsigned char *) rbuf + num,
2055 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2056 num += ATA_ID_SERNO_LEN;
2058 /* SAT defined lu model and serial numbers descriptor */
2059 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2060 rbuf[num + 0] = 2;
2061 rbuf[num + 1] = 1;
2062 rbuf[num + 3] = sat_model_serial_desc_len;
2063 num += 4;
2064 memcpy(rbuf + num, "ATA ", 8);
2065 num += 8;
2066 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2067 ATA_ID_PROD_LEN);
2068 num += ATA_ID_PROD_LEN;
2069 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2070 ATA_ID_SERNO_LEN);
2071 num += ATA_ID_SERNO_LEN;
2073 if (ata_id_has_wwn(args->id)) {
2074 /* SAT defined lu world wide name */
2075 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2076 rbuf[num + 0] = 1;
2077 rbuf[num + 1] = 3;
2078 rbuf[num + 3] = ATA_ID_WWN_LEN;
2079 num += 4;
2080 ata_id_string(args->id, (unsigned char *) rbuf + num,
2081 ATA_ID_WWN, ATA_ID_WWN_LEN);
2082 num += ATA_ID_WWN_LEN;
2084 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2085 return 0;
2089 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2090 * @args: device IDENTIFY data / SCSI command of interest.
2091 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2093 * Yields SAT-specified ATA VPD page.
2095 * LOCKING:
2096 * spin_lock_irqsave(host lock)
2098 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2100 struct ata_taskfile tf;
2102 memset(&tf, 0, sizeof(tf));
2104 rbuf[1] = 0x89; /* our page code */
2105 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2106 rbuf[3] = (0x238 & 0xff);
2108 memcpy(&rbuf[8], "linux ", 8);
2109 memcpy(&rbuf[16], "libata ", 16);
2110 memcpy(&rbuf[32], DRV_VERSION, 4);
2111 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2113 /* we don't store the ATA device signature, so we fake it */
2115 tf.command = ATA_DRDY; /* really, this is Status reg */
2116 tf.lbal = 0x1;
2117 tf.nsect = 0x1;
2119 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2120 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2122 rbuf[56] = ATA_CMD_ID_ATA;
2124 memcpy(&rbuf[60], &args->id[0], 512);
2125 return 0;
2128 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2130 u16 min_io_sectors;
2132 rbuf[1] = 0xb0;
2133 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2136 * Optimal transfer length granularity.
2138 * This is always one physical block, but for disks with a smaller
2139 * logical than physical sector size we need to figure out what the
2140 * latter is.
2142 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2143 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2146 * Optimal unmap granularity.
2148 * The ATA spec doesn't even know about a granularity or alignment
2149 * for the TRIM command. We can leave away most of the unmap related
2150 * VPD page entries, but we have specifify a granularity to signal
2151 * that we support some form of unmap - in thise case via WRITE SAME
2152 * with the unmap bit set.
2154 if (ata_id_has_trim(args->id)) {
2155 put_unaligned_be64(65535 * 512 / 8, &rbuf[36]);
2156 put_unaligned_be32(1, &rbuf[28]);
2159 return 0;
2162 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2164 int form_factor = ata_id_form_factor(args->id);
2165 int media_rotation_rate = ata_id_rotation_rate(args->id);
2167 rbuf[1] = 0xb1;
2168 rbuf[3] = 0x3c;
2169 rbuf[4] = media_rotation_rate >> 8;
2170 rbuf[5] = media_rotation_rate;
2171 rbuf[7] = form_factor;
2173 return 0;
2176 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2178 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2179 rbuf[1] = 0xb2;
2180 rbuf[3] = 0x4;
2181 rbuf[5] = 1 << 6; /* TPWS */
2183 return 0;
2187 * ata_scsiop_noop - Command handler that simply returns success.
2188 * @args: device IDENTIFY data / SCSI command of interest.
2189 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2191 * No operation. Simply returns success to caller, to indicate
2192 * that the caller should successfully complete this SCSI command.
2194 * LOCKING:
2195 * spin_lock_irqsave(host lock)
2197 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2199 VPRINTK("ENTER\n");
2200 return 0;
2204 * ata_msense_caching - Simulate MODE SENSE caching info page
2205 * @id: device IDENTIFY data
2206 * @buf: output buffer
2208 * Generate a caching info page, which conditionally indicates
2209 * write caching to the SCSI layer, depending on device
2210 * capabilities.
2212 * LOCKING:
2213 * None.
2215 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2217 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2218 if (ata_id_wcache_enabled(id))
2219 buf[2] |= (1 << 2); /* write cache enable */
2220 if (!ata_id_rahead_enabled(id))
2221 buf[12] |= (1 << 5); /* disable read ahead */
2222 return sizeof(def_cache_mpage);
2226 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2227 * @buf: output buffer
2229 * Generate a generic MODE SENSE control mode page.
2231 * LOCKING:
2232 * None.
2234 static unsigned int ata_msense_ctl_mode(u8 *buf)
2236 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2237 return sizeof(def_control_mpage);
2241 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2242 * @buf: output buffer
2244 * Generate a generic MODE SENSE r/w error recovery page.
2246 * LOCKING:
2247 * None.
2249 static unsigned int ata_msense_rw_recovery(u8 *buf)
2251 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2252 return sizeof(def_rw_recovery_mpage);
2256 * We can turn this into a real blacklist if it's needed, for now just
2257 * blacklist any Maxtor BANC1G10 revision firmware
2259 static int ata_dev_supports_fua(u16 *id)
2261 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2263 if (!libata_fua)
2264 return 0;
2265 if (!ata_id_has_fua(id))
2266 return 0;
2268 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2269 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2271 if (strcmp(model, "Maxtor"))
2272 return 1;
2273 if (strcmp(fw, "BANC1G10"))
2274 return 1;
2276 return 0; /* blacklisted */
2280 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2281 * @args: device IDENTIFY data / SCSI command of interest.
2282 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2284 * Simulate MODE SENSE commands. Assume this is invoked for direct
2285 * access devices (e.g. disks) only. There should be no block
2286 * descriptor for other device types.
2288 * LOCKING:
2289 * spin_lock_irqsave(host lock)
2291 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2293 struct ata_device *dev = args->dev;
2294 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2295 const u8 sat_blk_desc[] = {
2296 0, 0, 0, 0, /* number of blocks: sat unspecified */
2298 0, 0x2, 0x0 /* block length: 512 bytes */
2300 u8 pg, spg;
2301 unsigned int ebd, page_control, six_byte;
2302 u8 dpofua;
2304 VPRINTK("ENTER\n");
2306 six_byte = (scsicmd[0] == MODE_SENSE);
2307 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2309 * LLBA bit in msense(10) ignored (compliant)
2312 page_control = scsicmd[2] >> 6;
2313 switch (page_control) {
2314 case 0: /* current */
2315 break; /* supported */
2316 case 3: /* saved */
2317 goto saving_not_supp;
2318 case 1: /* changeable */
2319 case 2: /* defaults */
2320 default:
2321 goto invalid_fld;
2324 if (six_byte)
2325 p += 4 + (ebd ? 8 : 0);
2326 else
2327 p += 8 + (ebd ? 8 : 0);
2329 pg = scsicmd[2] & 0x3f;
2330 spg = scsicmd[3];
2332 * No mode subpages supported (yet) but asking for _all_
2333 * subpages may be valid
2335 if (spg && (spg != ALL_SUB_MPAGES))
2336 goto invalid_fld;
2338 switch(pg) {
2339 case RW_RECOVERY_MPAGE:
2340 p += ata_msense_rw_recovery(p);
2341 break;
2343 case CACHE_MPAGE:
2344 p += ata_msense_caching(args->id, p);
2345 break;
2347 case CONTROL_MPAGE:
2348 p += ata_msense_ctl_mode(p);
2349 break;
2351 case ALL_MPAGES:
2352 p += ata_msense_rw_recovery(p);
2353 p += ata_msense_caching(args->id, p);
2354 p += ata_msense_ctl_mode(p);
2355 break;
2357 default: /* invalid page code */
2358 goto invalid_fld;
2361 dpofua = 0;
2362 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2363 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2364 dpofua = 1 << 4;
2366 if (six_byte) {
2367 rbuf[0] = p - rbuf - 1;
2368 rbuf[2] |= dpofua;
2369 if (ebd) {
2370 rbuf[3] = sizeof(sat_blk_desc);
2371 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2373 } else {
2374 unsigned int output_len = p - rbuf - 2;
2376 rbuf[0] = output_len >> 8;
2377 rbuf[1] = output_len;
2378 rbuf[3] |= dpofua;
2379 if (ebd) {
2380 rbuf[7] = sizeof(sat_blk_desc);
2381 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2384 return 0;
2386 invalid_fld:
2387 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2388 /* "Invalid field in cbd" */
2389 return 1;
2391 saving_not_supp:
2392 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2393 /* "Saving parameters not supported" */
2394 return 1;
2398 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2399 * @args: device IDENTIFY data / SCSI command of interest.
2400 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2402 * Simulate READ CAPACITY commands.
2404 * LOCKING:
2405 * None.
2407 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2409 struct ata_device *dev = args->dev;
2410 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2411 u32 sector_size; /* physical sector size in bytes */
2412 u8 log2_per_phys;
2413 u16 lowest_aligned;
2415 sector_size = ata_id_logical_sector_size(dev->id);
2416 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2417 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2419 VPRINTK("ENTER\n");
2421 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2422 if (last_lba >= 0xffffffffULL)
2423 last_lba = 0xffffffff;
2425 /* sector count, 32-bit */
2426 rbuf[0] = last_lba >> (8 * 3);
2427 rbuf[1] = last_lba >> (8 * 2);
2428 rbuf[2] = last_lba >> (8 * 1);
2429 rbuf[3] = last_lba;
2431 /* sector size */
2432 rbuf[4] = sector_size >> (8 * 3);
2433 rbuf[5] = sector_size >> (8 * 2);
2434 rbuf[6] = sector_size >> (8 * 1);
2435 rbuf[7] = sector_size;
2436 } else {
2437 /* sector count, 64-bit */
2438 rbuf[0] = last_lba >> (8 * 7);
2439 rbuf[1] = last_lba >> (8 * 6);
2440 rbuf[2] = last_lba >> (8 * 5);
2441 rbuf[3] = last_lba >> (8 * 4);
2442 rbuf[4] = last_lba >> (8 * 3);
2443 rbuf[5] = last_lba >> (8 * 2);
2444 rbuf[6] = last_lba >> (8 * 1);
2445 rbuf[7] = last_lba;
2447 /* sector size */
2448 rbuf[ 8] = sector_size >> (8 * 3);
2449 rbuf[ 9] = sector_size >> (8 * 2);
2450 rbuf[10] = sector_size >> (8 * 1);
2451 rbuf[11] = sector_size;
2453 rbuf[12] = 0;
2454 rbuf[13] = log2_per_phys;
2455 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2456 rbuf[15] = lowest_aligned;
2458 if (ata_id_has_trim(args->id)) {
2459 rbuf[14] |= 0x80; /* TPE */
2461 if (ata_id_has_zero_after_trim(args->id))
2462 rbuf[14] |= 0x40; /* TPRZ */
2466 return 0;
2470 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2471 * @args: device IDENTIFY data / SCSI command of interest.
2472 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2474 * Simulate REPORT LUNS command.
2476 * LOCKING:
2477 * spin_lock_irqsave(host lock)
2479 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2481 VPRINTK("ENTER\n");
2482 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2484 return 0;
2487 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2489 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2490 /* FIXME: not quite right; we don't want the
2491 * translation of taskfile registers into
2492 * a sense descriptors, since that's only
2493 * correct for ATA, not ATAPI
2495 ata_gen_passthru_sense(qc);
2498 qc->scsidone(qc->scsicmd);
2499 ata_qc_free(qc);
2502 /* is it pointless to prefer PIO for "safety reasons"? */
2503 static inline int ata_pio_use_silly(struct ata_port *ap)
2505 return (ap->flags & ATA_FLAG_PIO_DMA);
2508 static void atapi_request_sense(struct ata_queued_cmd *qc)
2510 struct ata_port *ap = qc->ap;
2511 struct scsi_cmnd *cmd = qc->scsicmd;
2513 DPRINTK("ATAPI request sense\n");
2515 /* FIXME: is this needed? */
2516 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2518 #ifdef CONFIG_ATA_SFF
2519 if (ap->ops->sff_tf_read)
2520 ap->ops->sff_tf_read(ap, &qc->tf);
2521 #endif
2523 /* fill these in, for the case where they are -not- overwritten */
2524 cmd->sense_buffer[0] = 0x70;
2525 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2527 ata_qc_reinit(qc);
2529 /* setup sg table and init transfer direction */
2530 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2531 ata_sg_init(qc, &qc->sgent, 1);
2532 qc->dma_dir = DMA_FROM_DEVICE;
2534 memset(&qc->cdb, 0, qc->dev->cdb_len);
2535 qc->cdb[0] = REQUEST_SENSE;
2536 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2538 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2539 qc->tf.command = ATA_CMD_PACKET;
2541 if (ata_pio_use_silly(ap)) {
2542 qc->tf.protocol = ATAPI_PROT_DMA;
2543 qc->tf.feature |= ATAPI_PKT_DMA;
2544 } else {
2545 qc->tf.protocol = ATAPI_PROT_PIO;
2546 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2547 qc->tf.lbah = 0;
2549 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2551 qc->complete_fn = atapi_sense_complete;
2553 ata_qc_issue(qc);
2555 DPRINTK("EXIT\n");
2558 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2560 struct scsi_cmnd *cmd = qc->scsicmd;
2561 unsigned int err_mask = qc->err_mask;
2563 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2565 /* handle completion from new EH */
2566 if (unlikely(qc->ap->ops->error_handler &&
2567 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2569 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2570 /* FIXME: not quite right; we don't want the
2571 * translation of taskfile registers into a
2572 * sense descriptors, since that's only
2573 * correct for ATA, not ATAPI
2575 ata_gen_passthru_sense(qc);
2578 /* SCSI EH automatically locks door if sdev->locked is
2579 * set. Sometimes door lock request continues to
2580 * fail, for example, when no media is present. This
2581 * creates a loop - SCSI EH issues door lock which
2582 * fails and gets invoked again to acquire sense data
2583 * for the failed command.
2585 * If door lock fails, always clear sdev->locked to
2586 * avoid this infinite loop.
2588 * This may happen before SCSI scan is complete. Make
2589 * sure qc->dev->sdev isn't NULL before dereferencing.
2591 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2592 qc->dev->sdev->locked = 0;
2594 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2595 qc->scsidone(cmd);
2596 ata_qc_free(qc);
2597 return;
2600 /* successful completion or old EH failure path */
2601 if (unlikely(err_mask & AC_ERR_DEV)) {
2602 cmd->result = SAM_STAT_CHECK_CONDITION;
2603 atapi_request_sense(qc);
2604 return;
2605 } else if (unlikely(err_mask)) {
2606 /* FIXME: not quite right; we don't want the
2607 * translation of taskfile registers into
2608 * a sense descriptors, since that's only
2609 * correct for ATA, not ATAPI
2611 ata_gen_passthru_sense(qc);
2612 } else {
2613 u8 *scsicmd = cmd->cmnd;
2615 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2616 unsigned long flags;
2617 u8 *buf;
2619 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2621 /* ATAPI devices typically report zero for their SCSI version,
2622 * and sometimes deviate from the spec WRT response data
2623 * format. If SCSI version is reported as zero like normal,
2624 * then we make the following fixups: 1) Fake MMC-5 version,
2625 * to indicate to the Linux scsi midlayer this is a modern
2626 * device. 2) Ensure response data format / ATAPI information
2627 * are always correct.
2629 if (buf[2] == 0) {
2630 buf[2] = 0x5;
2631 buf[3] = 0x32;
2634 ata_scsi_rbuf_put(cmd, true, &flags);
2637 cmd->result = SAM_STAT_GOOD;
2640 qc->scsidone(cmd);
2641 ata_qc_free(qc);
2644 * atapi_xlat - Initialize PACKET taskfile
2645 * @qc: command structure to be initialized
2647 * LOCKING:
2648 * spin_lock_irqsave(host lock)
2650 * RETURNS:
2651 * Zero on success, non-zero on failure.
2653 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2655 struct scsi_cmnd *scmd = qc->scsicmd;
2656 struct ata_device *dev = qc->dev;
2657 int nodata = (scmd->sc_data_direction == DMA_NONE);
2658 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2659 unsigned int nbytes;
2661 memset(qc->cdb, 0, dev->cdb_len);
2662 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2664 qc->complete_fn = atapi_qc_complete;
2666 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2667 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2668 qc->tf.flags |= ATA_TFLAG_WRITE;
2669 DPRINTK("direction: write\n");
2672 qc->tf.command = ATA_CMD_PACKET;
2673 ata_qc_set_pc_nbytes(qc);
2675 /* check whether ATAPI DMA is safe */
2676 if (!nodata && !using_pio && atapi_check_dma(qc))
2677 using_pio = 1;
2679 /* Some controller variants snoop this value for Packet
2680 * transfers to do state machine and FIFO management. Thus we
2681 * want to set it properly, and for DMA where it is
2682 * effectively meaningless.
2684 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2686 /* Most ATAPI devices which honor transfer chunk size don't
2687 * behave according to the spec when odd chunk size which
2688 * matches the transfer length is specified. If the number of
2689 * bytes to transfer is 2n+1. According to the spec, what
2690 * should happen is to indicate that 2n+1 is going to be
2691 * transferred and transfer 2n+2 bytes where the last byte is
2692 * padding.
2694 * In practice, this doesn't happen. ATAPI devices first
2695 * indicate and transfer 2n bytes and then indicate and
2696 * transfer 2 bytes where the last byte is padding.
2698 * This inconsistency confuses several controllers which
2699 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2700 * These controllers use actual number of transferred bytes to
2701 * update DMA poitner and transfer of 4n+2 bytes make those
2702 * controller push DMA pointer by 4n+4 bytes because SATA data
2703 * FISes are aligned to 4 bytes. This causes data corruption
2704 * and buffer overrun.
2706 * Always setting nbytes to even number solves this problem
2707 * because then ATAPI devices don't have to split data at 2n
2708 * boundaries.
2710 if (nbytes & 0x1)
2711 nbytes++;
2713 qc->tf.lbam = (nbytes & 0xFF);
2714 qc->tf.lbah = (nbytes >> 8);
2716 if (nodata)
2717 qc->tf.protocol = ATAPI_PROT_NODATA;
2718 else if (using_pio)
2719 qc->tf.protocol = ATAPI_PROT_PIO;
2720 else {
2721 /* DMA data xfer */
2722 qc->tf.protocol = ATAPI_PROT_DMA;
2723 qc->tf.feature |= ATAPI_PKT_DMA;
2725 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2726 (scmd->sc_data_direction != DMA_TO_DEVICE))
2727 /* some SATA bridges need us to indicate data xfer direction */
2728 qc->tf.feature |= ATAPI_DMADIR;
2732 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2733 as ATAPI tape drives don't get this right otherwise */
2734 return 0;
2737 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2739 if (!sata_pmp_attached(ap)) {
2740 if (likely(devno < ata_link_max_devices(&ap->link)))
2741 return &ap->link.device[devno];
2742 } else {
2743 if (likely(devno < ap->nr_pmp_links))
2744 return &ap->pmp_link[devno].device[0];
2747 return NULL;
2750 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2751 const struct scsi_device *scsidev)
2753 int devno;
2755 /* skip commands not addressed to targets we simulate */
2756 if (!sata_pmp_attached(ap)) {
2757 if (unlikely(scsidev->channel || scsidev->lun))
2758 return NULL;
2759 devno = scsidev->id;
2760 } else {
2761 if (unlikely(scsidev->id || scsidev->lun))
2762 return NULL;
2763 devno = scsidev->channel;
2766 return ata_find_dev(ap, devno);
2770 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2771 * @ap: ATA port to which the device is attached
2772 * @scsidev: SCSI device from which we derive the ATA device
2774 * Given various information provided in struct scsi_cmnd,
2775 * map that onto an ATA bus, and using that mapping
2776 * determine which ata_device is associated with the
2777 * SCSI command to be sent.
2779 * LOCKING:
2780 * spin_lock_irqsave(host lock)
2782 * RETURNS:
2783 * Associated ATA device, or %NULL if not found.
2785 static struct ata_device *
2786 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2788 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2790 if (unlikely(!dev || !ata_dev_enabled(dev)))
2791 return NULL;
2793 return dev;
2797 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2798 * @byte1: Byte 1 from pass-thru CDB.
2800 * RETURNS:
2801 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2803 static u8
2804 ata_scsi_map_proto(u8 byte1)
2806 switch((byte1 & 0x1e) >> 1) {
2807 case 3: /* Non-data */
2808 return ATA_PROT_NODATA;
2810 case 6: /* DMA */
2811 case 10: /* UDMA Data-in */
2812 case 11: /* UDMA Data-Out */
2813 return ATA_PROT_DMA;
2815 case 4: /* PIO Data-in */
2816 case 5: /* PIO Data-out */
2817 return ATA_PROT_PIO;
2819 case 0: /* Hard Reset */
2820 case 1: /* SRST */
2821 case 8: /* Device Diagnostic */
2822 case 9: /* Device Reset */
2823 case 7: /* DMA Queued */
2824 case 12: /* FPDMA */
2825 case 15: /* Return Response Info */
2826 default: /* Reserved */
2827 break;
2830 return ATA_PROT_UNKNOWN;
2834 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2835 * @qc: command structure to be initialized
2837 * Handles either 12 or 16-byte versions of the CDB.
2839 * RETURNS:
2840 * Zero on success, non-zero on failure.
2842 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2844 struct ata_taskfile *tf = &(qc->tf);
2845 struct scsi_cmnd *scmd = qc->scsicmd;
2846 struct ata_device *dev = qc->dev;
2847 const u8 *cdb = scmd->cmnd;
2849 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2850 goto invalid_fld;
2853 * 12 and 16 byte CDBs use different offsets to
2854 * provide the various register values.
2856 if (cdb[0] == ATA_16) {
2858 * 16-byte CDB - may contain extended commands.
2860 * If that is the case, copy the upper byte register values.
2862 if (cdb[1] & 0x01) {
2863 tf->hob_feature = cdb[3];
2864 tf->hob_nsect = cdb[5];
2865 tf->hob_lbal = cdb[7];
2866 tf->hob_lbam = cdb[9];
2867 tf->hob_lbah = cdb[11];
2868 tf->flags |= ATA_TFLAG_LBA48;
2869 } else
2870 tf->flags &= ~ATA_TFLAG_LBA48;
2873 * Always copy low byte, device and command registers.
2875 tf->feature = cdb[4];
2876 tf->nsect = cdb[6];
2877 tf->lbal = cdb[8];
2878 tf->lbam = cdb[10];
2879 tf->lbah = cdb[12];
2880 tf->device = cdb[13];
2881 tf->command = cdb[14];
2882 } else {
2884 * 12-byte CDB - incapable of extended commands.
2886 tf->flags &= ~ATA_TFLAG_LBA48;
2888 tf->feature = cdb[3];
2889 tf->nsect = cdb[4];
2890 tf->lbal = cdb[5];
2891 tf->lbam = cdb[6];
2892 tf->lbah = cdb[7];
2893 tf->device = cdb[8];
2894 tf->command = cdb[9];
2897 /* enforce correct master/slave bit */
2898 tf->device = dev->devno ?
2899 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2901 switch (tf->command) {
2902 /* READ/WRITE LONG use a non-standard sect_size */
2903 case ATA_CMD_READ_LONG:
2904 case ATA_CMD_READ_LONG_ONCE:
2905 case ATA_CMD_WRITE_LONG:
2906 case ATA_CMD_WRITE_LONG_ONCE:
2907 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2908 goto invalid_fld;
2909 qc->sect_size = scsi_bufflen(scmd);
2910 break;
2912 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2913 case ATA_CMD_CFA_WRITE_NE:
2914 case ATA_CMD_CFA_TRANS_SECT:
2915 case ATA_CMD_CFA_WRITE_MULT_NE:
2916 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2917 case ATA_CMD_READ:
2918 case ATA_CMD_READ_EXT:
2919 case ATA_CMD_READ_QUEUED:
2920 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2921 case ATA_CMD_FPDMA_READ:
2922 case ATA_CMD_READ_MULTI:
2923 case ATA_CMD_READ_MULTI_EXT:
2924 case ATA_CMD_PIO_READ:
2925 case ATA_CMD_PIO_READ_EXT:
2926 case ATA_CMD_READ_STREAM_DMA_EXT:
2927 case ATA_CMD_READ_STREAM_EXT:
2928 case ATA_CMD_VERIFY:
2929 case ATA_CMD_VERIFY_EXT:
2930 case ATA_CMD_WRITE:
2931 case ATA_CMD_WRITE_EXT:
2932 case ATA_CMD_WRITE_FUA_EXT:
2933 case ATA_CMD_WRITE_QUEUED:
2934 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2935 case ATA_CMD_FPDMA_WRITE:
2936 case ATA_CMD_WRITE_MULTI:
2937 case ATA_CMD_WRITE_MULTI_EXT:
2938 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2939 case ATA_CMD_PIO_WRITE:
2940 case ATA_CMD_PIO_WRITE_EXT:
2941 case ATA_CMD_WRITE_STREAM_DMA_EXT:
2942 case ATA_CMD_WRITE_STREAM_EXT:
2943 qc->sect_size = scmd->device->sector_size;
2944 break;
2946 /* Everything else uses 512 byte "sectors" */
2947 default:
2948 qc->sect_size = ATA_SECT_SIZE;
2952 * Set flags so that all registers will be written, pass on
2953 * write indication (used for PIO/DMA setup), result TF is
2954 * copied back and we don't whine too much about its failure.
2956 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2957 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2958 tf->flags |= ATA_TFLAG_WRITE;
2960 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2963 * Set transfer length.
2965 * TODO: find out if we need to do more here to
2966 * cover scatter/gather case.
2968 ata_qc_set_pc_nbytes(qc);
2970 /* We may not issue DMA commands if no DMA mode is set */
2971 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2972 goto invalid_fld;
2974 /* sanity check for pio multi commands */
2975 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2976 goto invalid_fld;
2978 if (is_multi_taskfile(tf)) {
2979 unsigned int multi_count = 1 << (cdb[1] >> 5);
2981 /* compare the passed through multi_count
2982 * with the cached multi_count of libata
2984 if (multi_count != dev->multi_count)
2985 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
2986 multi_count);
2990 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2991 * SET_FEATURES - XFER MODE must be preceded/succeeded
2992 * by an update to hardware-specific registers for each
2993 * controller (i.e. the reason for ->set_piomode(),
2994 * ->set_dmamode(), and ->post_set_mode() hooks).
2996 if (tf->command == ATA_CMD_SET_FEATURES &&
2997 tf->feature == SETFEATURES_XFER)
2998 goto invalid_fld;
3001 * Filter TPM commands by default. These provide an
3002 * essentially uncontrolled encrypted "back door" between
3003 * applications and the disk. Set libata.allow_tpm=1 if you
3004 * have a real reason for wanting to use them. This ensures
3005 * that installed software cannot easily mess stuff up without
3006 * user intent. DVR type users will probably ship with this enabled
3007 * for movie content management.
3009 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3010 * for this and should do in future but that it is not sufficient as
3011 * DCS is an optional feature set. Thus we also do the software filter
3012 * so that we comply with the TC consortium stated goal that the user
3013 * can turn off TC features of their system.
3015 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
3016 goto invalid_fld;
3018 return 0;
3020 invalid_fld:
3021 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3022 /* "Invalid field in cdb" */
3023 return 1;
3026 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3028 struct ata_taskfile *tf = &qc->tf;
3029 struct scsi_cmnd *scmd = qc->scsicmd;
3030 struct ata_device *dev = qc->dev;
3031 const u8 *cdb = scmd->cmnd;
3032 u64 block;
3033 u32 n_block;
3034 u32 size;
3035 void *buf;
3037 /* we may not issue DMA commands if no DMA mode is set */
3038 if (unlikely(!dev->dma_mode))
3039 goto invalid_fld;
3041 if (unlikely(scmd->cmd_len < 16))
3042 goto invalid_fld;
3043 scsi_16_lba_len(cdb, &block, &n_block);
3045 /* for now we only support WRITE SAME with the unmap bit set */
3046 if (unlikely(!(cdb[1] & 0x8)))
3047 goto invalid_fld;
3050 * WRITE SAME always has a sector sized buffer as payload, this
3051 * should never be a multiple entry S/G list.
3053 if (!scsi_sg_count(scmd))
3054 goto invalid_fld;
3056 buf = page_address(sg_page(scsi_sglist(scmd)));
3057 size = ata_set_lba_range_entries(buf, 512, block, n_block);
3059 tf->protocol = ATA_PROT_DMA;
3060 tf->hob_feature = 0;
3061 tf->feature = ATA_DSM_TRIM;
3062 tf->hob_nsect = (size / 512) >> 8;
3063 tf->nsect = size / 512;
3064 tf->command = ATA_CMD_DSM;
3065 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3066 ATA_TFLAG_WRITE;
3068 ata_qc_set_pc_nbytes(qc);
3070 return 0;
3072 invalid_fld:
3073 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3074 /* "Invalid field in cdb" */
3075 return 1;
3079 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3080 * @dev: ATA device
3081 * @cmd: SCSI command opcode to consider
3083 * Look up the SCSI command given, and determine whether the
3084 * SCSI command is to be translated or simulated.
3086 * RETURNS:
3087 * Pointer to translation function if possible, %NULL if not.
3090 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3092 switch (cmd) {
3093 case READ_6:
3094 case READ_10:
3095 case READ_16:
3097 case WRITE_6:
3098 case WRITE_10:
3099 case WRITE_16:
3100 return ata_scsi_rw_xlat;
3102 case WRITE_SAME_16:
3103 return ata_scsi_write_same_xlat;
3105 case SYNCHRONIZE_CACHE:
3106 if (ata_try_flush_cache(dev))
3107 return ata_scsi_flush_xlat;
3108 break;
3110 case VERIFY:
3111 case VERIFY_16:
3112 return ata_scsi_verify_xlat;
3114 case ATA_12:
3115 case ATA_16:
3116 return ata_scsi_pass_thru;
3118 case START_STOP:
3119 return ata_scsi_start_stop_xlat;
3122 return NULL;
3126 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3127 * @ap: ATA port to which the command was being sent
3128 * @cmd: SCSI command to dump
3130 * Prints the contents of a SCSI command via printk().
3133 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3134 struct scsi_cmnd *cmd)
3136 #ifdef ATA_DEBUG
3137 struct scsi_device *scsidev = cmd->device;
3138 u8 *scsicmd = cmd->cmnd;
3140 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3141 ap->print_id,
3142 scsidev->channel, scsidev->id, scsidev->lun,
3143 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3144 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3145 scsicmd[8]);
3146 #endif
3149 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3150 struct ata_device *dev)
3152 u8 scsi_op = scmd->cmnd[0];
3153 ata_xlat_func_t xlat_func;
3154 int rc = 0;
3156 if (dev->class == ATA_DEV_ATA) {
3157 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3158 goto bad_cdb_len;
3160 xlat_func = ata_get_xlat_func(dev, scsi_op);
3161 } else {
3162 if (unlikely(!scmd->cmd_len))
3163 goto bad_cdb_len;
3165 xlat_func = NULL;
3166 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3167 /* relay SCSI command to ATAPI device */
3168 int len = COMMAND_SIZE(scsi_op);
3169 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3170 goto bad_cdb_len;
3172 xlat_func = atapi_xlat;
3173 } else {
3174 /* ATA_16 passthru, treat as an ATA command */
3175 if (unlikely(scmd->cmd_len > 16))
3176 goto bad_cdb_len;
3178 xlat_func = ata_get_xlat_func(dev, scsi_op);
3182 if (xlat_func)
3183 rc = ata_scsi_translate(dev, scmd, xlat_func);
3184 else
3185 ata_scsi_simulate(dev, scmd);
3187 return rc;
3189 bad_cdb_len:
3190 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3191 scmd->cmd_len, scsi_op, dev->cdb_len);
3192 scmd->result = DID_ERROR << 16;
3193 scmd->scsi_done(scmd);
3194 return 0;
3198 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3199 * @shost: SCSI host of command to be sent
3200 * @cmd: SCSI command to be sent
3202 * In some cases, this function translates SCSI commands into
3203 * ATA taskfiles, and queues the taskfiles to be sent to
3204 * hardware. In other cases, this function simulates a
3205 * SCSI device by evaluating and responding to certain
3206 * SCSI commands. This creates the overall effect of
3207 * ATA and ATAPI devices appearing as SCSI devices.
3209 * LOCKING:
3210 * ATA host lock
3212 * RETURNS:
3213 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3214 * 0 otherwise.
3216 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
3218 struct ata_port *ap;
3219 struct ata_device *dev;
3220 struct scsi_device *scsidev = cmd->device;
3221 int rc = 0;
3222 unsigned long irq_flags;
3224 ap = ata_shost_to_port(shost);
3226 spin_lock_irqsave(ap->lock, irq_flags);
3228 ata_scsi_dump_cdb(ap, cmd);
3230 dev = ata_scsi_find_dev(ap, scsidev);
3231 if (likely(dev))
3232 rc = __ata_scsi_queuecmd(cmd, dev);
3233 else {
3234 cmd->result = (DID_BAD_TARGET << 16);
3235 cmd->scsi_done(cmd);
3238 spin_unlock_irqrestore(ap->lock, irq_flags);
3240 return rc;
3244 * ata_scsi_simulate - simulate SCSI command on ATA device
3245 * @dev: the target device
3246 * @cmd: SCSI command being sent to device.
3248 * Interprets and directly executes a select list of SCSI commands
3249 * that can be handled internally.
3251 * LOCKING:
3252 * spin_lock_irqsave(host lock)
3255 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
3257 struct ata_scsi_args args;
3258 const u8 *scsicmd = cmd->cmnd;
3259 u8 tmp8;
3261 args.dev = dev;
3262 args.id = dev->id;
3263 args.cmd = cmd;
3264 args.done = cmd->scsi_done;
3266 switch(scsicmd[0]) {
3267 /* TODO: worth improving? */
3268 case FORMAT_UNIT:
3269 ata_scsi_invalid_field(cmd);
3270 break;
3272 case INQUIRY:
3273 if (scsicmd[1] & 2) /* is CmdDt set? */
3274 ata_scsi_invalid_field(cmd);
3275 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3276 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3277 else switch (scsicmd[2]) {
3278 case 0x00:
3279 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3280 break;
3281 case 0x80:
3282 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3283 break;
3284 case 0x83:
3285 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3286 break;
3287 case 0x89:
3288 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3289 break;
3290 case 0xb0:
3291 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3292 break;
3293 case 0xb1:
3294 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3295 break;
3296 case 0xb2:
3297 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
3298 break;
3299 default:
3300 ata_scsi_invalid_field(cmd);
3301 break;
3303 break;
3305 case MODE_SENSE:
3306 case MODE_SENSE_10:
3307 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3308 break;
3310 case MODE_SELECT: /* unconditionally return */
3311 case MODE_SELECT_10: /* bad-field-in-cdb */
3312 ata_scsi_invalid_field(cmd);
3313 break;
3315 case READ_CAPACITY:
3316 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3317 break;
3319 case SERVICE_ACTION_IN:
3320 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3321 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3322 else
3323 ata_scsi_invalid_field(cmd);
3324 break;
3326 case REPORT_LUNS:
3327 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3328 break;
3330 case REQUEST_SENSE:
3331 ata_scsi_set_sense(cmd, 0, 0, 0);
3332 cmd->result = (DRIVER_SENSE << 24);
3333 cmd->scsi_done(cmd);
3334 break;
3336 /* if we reach this, then writeback caching is disabled,
3337 * turning this into a no-op.
3339 case SYNCHRONIZE_CACHE:
3340 /* fall through */
3342 /* no-op's, complete with success */
3343 case REZERO_UNIT:
3344 case SEEK_6:
3345 case SEEK_10:
3346 case TEST_UNIT_READY:
3347 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3348 break;
3350 case SEND_DIAGNOSTIC:
3351 tmp8 = scsicmd[1] & ~(1 << 3);
3352 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3353 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3354 else
3355 ata_scsi_invalid_field(cmd);
3356 break;
3358 /* all other commands */
3359 default:
3360 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3361 /* "Invalid command operation code" */
3362 cmd->scsi_done(cmd);
3363 break;
3367 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3369 int i, rc;
3371 for (i = 0; i < host->n_ports; i++) {
3372 struct ata_port *ap = host->ports[i];
3373 struct Scsi_Host *shost;
3375 rc = -ENOMEM;
3376 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3377 if (!shost)
3378 goto err_alloc;
3380 *(struct ata_port **)&shost->hostdata[0] = ap;
3381 ap->scsi_host = shost;
3383 shost->transportt = ata_scsi_transport_template;
3384 shost->unique_id = ap->print_id;
3385 shost->max_id = 16;
3386 shost->max_lun = 1;
3387 shost->max_channel = 1;
3388 shost->max_cmd_len = 16;
3390 /* Schedule policy is determined by ->qc_defer()
3391 * callback and it needs to see every deferred qc.
3392 * Set host_blocked to 1 to prevent SCSI midlayer from
3393 * automatically deferring requests.
3395 shost->max_host_blocked = 1;
3397 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3398 if (rc)
3399 goto err_add;
3402 return 0;
3404 err_add:
3405 scsi_host_put(host->ports[i]->scsi_host);
3406 err_alloc:
3407 while (--i >= 0) {
3408 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3410 scsi_remove_host(shost);
3411 scsi_host_put(shost);
3413 return rc;
3416 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3418 int tries = 5;
3419 struct ata_device *last_failed_dev = NULL;
3420 struct ata_link *link;
3421 struct ata_device *dev;
3423 repeat:
3424 ata_for_each_link(link, ap, EDGE) {
3425 ata_for_each_dev(dev, link, ENABLED) {
3426 struct scsi_device *sdev;
3427 int channel = 0, id = 0;
3429 if (dev->sdev)
3430 continue;
3432 if (ata_is_host_link(link))
3433 id = dev->devno;
3434 else
3435 channel = link->pmp;
3437 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3438 NULL);
3439 if (!IS_ERR(sdev)) {
3440 dev->sdev = sdev;
3441 scsi_device_put(sdev);
3442 } else {
3443 dev->sdev = NULL;
3448 /* If we scanned while EH was in progress or allocation
3449 * failure occurred, scan would have failed silently. Check
3450 * whether all devices are attached.
3452 ata_for_each_link(link, ap, EDGE) {
3453 ata_for_each_dev(dev, link, ENABLED) {
3454 if (!dev->sdev)
3455 goto exit_loop;
3458 exit_loop:
3459 if (!link)
3460 return;
3462 /* we're missing some SCSI devices */
3463 if (sync) {
3464 /* If caller requested synchrnous scan && we've made
3465 * any progress, sleep briefly and repeat.
3467 if (dev != last_failed_dev) {
3468 msleep(100);
3469 last_failed_dev = dev;
3470 goto repeat;
3473 /* We might be failing to detect boot device, give it
3474 * a few more chances.
3476 if (--tries) {
3477 msleep(100);
3478 goto repeat;
3481 ata_port_err(ap,
3482 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
3485 queue_delayed_work(system_long_wq, &ap->hotplug_task,
3486 round_jiffies_relative(HZ));
3490 * ata_scsi_offline_dev - offline attached SCSI device
3491 * @dev: ATA device to offline attached SCSI device for
3493 * This function is called from ata_eh_hotplug() and responsible
3494 * for taking the SCSI device attached to @dev offline. This
3495 * function is called with host lock which protects dev->sdev
3496 * against clearing.
3498 * LOCKING:
3499 * spin_lock_irqsave(host lock)
3501 * RETURNS:
3502 * 1 if attached SCSI device exists, 0 otherwise.
3504 int ata_scsi_offline_dev(struct ata_device *dev)
3506 if (dev->sdev) {
3507 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3508 return 1;
3510 return 0;
3514 * ata_scsi_remove_dev - remove attached SCSI device
3515 * @dev: ATA device to remove attached SCSI device for
3517 * This function is called from ata_eh_scsi_hotplug() and
3518 * responsible for removing the SCSI device attached to @dev.
3520 * LOCKING:
3521 * Kernel thread context (may sleep).
3523 static void ata_scsi_remove_dev(struct ata_device *dev)
3525 struct ata_port *ap = dev->link->ap;
3526 struct scsi_device *sdev;
3527 unsigned long flags;
3529 /* Alas, we need to grab scan_mutex to ensure SCSI device
3530 * state doesn't change underneath us and thus
3531 * scsi_device_get() always succeeds. The mutex locking can
3532 * be removed if there is __scsi_device_get() interface which
3533 * increments reference counts regardless of device state.
3535 mutex_lock(&ap->scsi_host->scan_mutex);
3536 spin_lock_irqsave(ap->lock, flags);
3538 /* clearing dev->sdev is protected by host lock */
3539 sdev = dev->sdev;
3540 dev->sdev = NULL;
3542 if (sdev) {
3543 /* If user initiated unplug races with us, sdev can go
3544 * away underneath us after the host lock and
3545 * scan_mutex are released. Hold onto it.
3547 if (scsi_device_get(sdev) == 0) {
3548 /* The following ensures the attached sdev is
3549 * offline on return from ata_scsi_offline_dev()
3550 * regardless it wins or loses the race
3551 * against this function.
3553 scsi_device_set_state(sdev, SDEV_OFFLINE);
3554 } else {
3555 WARN_ON(1);
3556 sdev = NULL;
3560 spin_unlock_irqrestore(ap->lock, flags);
3561 mutex_unlock(&ap->scsi_host->scan_mutex);
3563 if (sdev) {
3564 ata_dev_info(dev, "detaching (SCSI %s)\n",
3565 dev_name(&sdev->sdev_gendev));
3567 scsi_remove_device(sdev);
3568 scsi_device_put(sdev);
3572 static void ata_scsi_handle_link_detach(struct ata_link *link)
3574 struct ata_port *ap = link->ap;
3575 struct ata_device *dev;
3577 ata_for_each_dev(dev, link, ALL) {
3578 unsigned long flags;
3580 if (!(dev->flags & ATA_DFLAG_DETACHED))
3581 continue;
3583 spin_lock_irqsave(ap->lock, flags);
3584 dev->flags &= ~ATA_DFLAG_DETACHED;
3585 spin_unlock_irqrestore(ap->lock, flags);
3587 ata_scsi_remove_dev(dev);
3592 * ata_scsi_media_change_notify - send media change event
3593 * @dev: Pointer to the disk device with media change event
3595 * Tell the block layer to send a media change notification
3596 * event.
3598 * LOCKING:
3599 * spin_lock_irqsave(host lock)
3601 void ata_scsi_media_change_notify(struct ata_device *dev)
3603 if (dev->sdev)
3604 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3605 GFP_ATOMIC);
3609 * ata_scsi_hotplug - SCSI part of hotplug
3610 * @work: Pointer to ATA port to perform SCSI hotplug on
3612 * Perform SCSI part of hotplug. It's executed from a separate
3613 * workqueue after EH completes. This is necessary because SCSI
3614 * hot plugging requires working EH and hot unplugging is
3615 * synchronized with hot plugging with a mutex.
3617 * LOCKING:
3618 * Kernel thread context (may sleep).
3620 void ata_scsi_hotplug(struct work_struct *work)
3622 struct ata_port *ap =
3623 container_of(work, struct ata_port, hotplug_task.work);
3624 int i;
3626 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3627 DPRINTK("ENTER/EXIT - unloading\n");
3628 return;
3631 DPRINTK("ENTER\n");
3632 mutex_lock(&ap->scsi_scan_mutex);
3634 /* Unplug detached devices. We cannot use link iterator here
3635 * because PMP links have to be scanned even if PMP is
3636 * currently not attached. Iterate manually.
3638 ata_scsi_handle_link_detach(&ap->link);
3639 if (ap->pmp_link)
3640 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3641 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3643 /* scan for new ones */
3644 ata_scsi_scan_host(ap, 0);
3646 mutex_unlock(&ap->scsi_scan_mutex);
3647 DPRINTK("EXIT\n");
3651 * ata_scsi_user_scan - indication for user-initiated bus scan
3652 * @shost: SCSI host to scan
3653 * @channel: Channel to scan
3654 * @id: ID to scan
3655 * @lun: LUN to scan
3657 * This function is called when user explicitly requests bus
3658 * scan. Set probe pending flag and invoke EH.
3660 * LOCKING:
3661 * SCSI layer (we don't care)
3663 * RETURNS:
3664 * Zero.
3666 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3667 unsigned int id, unsigned int lun)
3669 struct ata_port *ap = ata_shost_to_port(shost);
3670 unsigned long flags;
3671 int devno, rc = 0;
3673 if (!ap->ops->error_handler)
3674 return -EOPNOTSUPP;
3676 if (lun != SCAN_WILD_CARD && lun)
3677 return -EINVAL;
3679 if (!sata_pmp_attached(ap)) {
3680 if (channel != SCAN_WILD_CARD && channel)
3681 return -EINVAL;
3682 devno = id;
3683 } else {
3684 if (id != SCAN_WILD_CARD && id)
3685 return -EINVAL;
3686 devno = channel;
3689 spin_lock_irqsave(ap->lock, flags);
3691 if (devno == SCAN_WILD_CARD) {
3692 struct ata_link *link;
3694 ata_for_each_link(link, ap, EDGE) {
3695 struct ata_eh_info *ehi = &link->eh_info;
3696 ehi->probe_mask |= ATA_ALL_DEVICES;
3697 ehi->action |= ATA_EH_RESET;
3699 } else {
3700 struct ata_device *dev = ata_find_dev(ap, devno);
3702 if (dev) {
3703 struct ata_eh_info *ehi = &dev->link->eh_info;
3704 ehi->probe_mask |= 1 << dev->devno;
3705 ehi->action |= ATA_EH_RESET;
3706 } else
3707 rc = -EINVAL;
3710 if (rc == 0) {
3711 ata_port_schedule_eh(ap);
3712 spin_unlock_irqrestore(ap->lock, flags);
3713 ata_port_wait_eh(ap);
3714 } else
3715 spin_unlock_irqrestore(ap->lock, flags);
3717 return rc;
3721 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3722 * @work: Pointer to ATA port to perform scsi_rescan_device()
3724 * After ATA pass thru (SAT) commands are executed successfully,
3725 * libata need to propagate the changes to SCSI layer.
3727 * LOCKING:
3728 * Kernel thread context (may sleep).
3730 void ata_scsi_dev_rescan(struct work_struct *work)
3732 struct ata_port *ap =
3733 container_of(work, struct ata_port, scsi_rescan_task);
3734 struct ata_link *link;
3735 struct ata_device *dev;
3736 unsigned long flags;
3738 mutex_lock(&ap->scsi_scan_mutex);
3739 spin_lock_irqsave(ap->lock, flags);
3741 ata_for_each_link(link, ap, EDGE) {
3742 ata_for_each_dev(dev, link, ENABLED) {
3743 struct scsi_device *sdev = dev->sdev;
3745 if (!sdev)
3746 continue;
3747 if (scsi_device_get(sdev))
3748 continue;
3750 spin_unlock_irqrestore(ap->lock, flags);
3751 scsi_rescan_device(&(sdev->sdev_gendev));
3752 scsi_device_put(sdev);
3753 spin_lock_irqsave(ap->lock, flags);
3757 spin_unlock_irqrestore(ap->lock, flags);
3758 mutex_unlock(&ap->scsi_scan_mutex);
3762 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3763 * @host: ATA host container for all SAS ports
3764 * @port_info: Information from low-level host driver
3765 * @shost: SCSI host that the scsi device is attached to
3767 * LOCKING:
3768 * PCI/etc. bus probe sem.
3770 * RETURNS:
3771 * ata_port pointer on success / NULL on failure.
3774 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3775 struct ata_port_info *port_info,
3776 struct Scsi_Host *shost)
3778 struct ata_port *ap;
3780 ap = ata_port_alloc(host);
3781 if (!ap)
3782 return NULL;
3784 ap->port_no = 0;
3785 ap->lock = &host->lock;
3786 ap->pio_mask = port_info->pio_mask;
3787 ap->mwdma_mask = port_info->mwdma_mask;
3788 ap->udma_mask = port_info->udma_mask;
3789 ap->flags |= port_info->flags;
3790 ap->ops = port_info->port_ops;
3791 ap->cbl = ATA_CBL_SATA;
3793 return ap;
3795 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3798 * ata_sas_port_start - Set port up for dma.
3799 * @ap: Port to initialize
3801 * Called just after data structures for each port are
3802 * initialized.
3804 * May be used as the port_start() entry in ata_port_operations.
3806 * LOCKING:
3807 * Inherited from caller.
3809 int ata_sas_port_start(struct ata_port *ap)
3812 * the port is marked as frozen at allocation time, but if we don't
3813 * have new eh, we won't thaw it
3815 if (!ap->ops->error_handler)
3816 ap->pflags &= ~ATA_PFLAG_FROZEN;
3817 return 0;
3819 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3822 * ata_port_stop - Undo ata_sas_port_start()
3823 * @ap: Port to shut down
3825 * May be used as the port_stop() entry in ata_port_operations.
3827 * LOCKING:
3828 * Inherited from caller.
3831 void ata_sas_port_stop(struct ata_port *ap)
3834 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3837 * ata_sas_port_init - Initialize a SATA device
3838 * @ap: SATA port to initialize
3840 * LOCKING:
3841 * PCI/etc. bus probe sem.
3843 * RETURNS:
3844 * Zero on success, non-zero on error.
3847 int ata_sas_port_init(struct ata_port *ap)
3849 int rc = ap->ops->port_start(ap);
3851 if (!rc) {
3852 ap->print_id = ata_print_id++;
3853 rc = ata_port_probe(ap);
3856 return rc;
3858 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3861 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3862 * @ap: SATA port to destroy
3866 void ata_sas_port_destroy(struct ata_port *ap)
3868 if (ap->ops->port_stop)
3869 ap->ops->port_stop(ap);
3870 kfree(ap);
3872 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3875 * ata_sas_slave_configure - Default slave_config routine for libata devices
3876 * @sdev: SCSI device to configure
3877 * @ap: ATA port to which SCSI device is attached
3879 * RETURNS:
3880 * Zero.
3883 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3885 ata_scsi_sdev_config(sdev);
3886 ata_scsi_dev_config(sdev, ap->link.device);
3887 return 0;
3889 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3892 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3893 * @cmd: SCSI command to be sent
3894 * @ap: ATA port to which the command is being sent
3896 * RETURNS:
3897 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3898 * 0 otherwise.
3901 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
3903 int rc = 0;
3905 ata_scsi_dump_cdb(ap, cmd);
3907 if (likely(ata_dev_enabled(ap->link.device)))
3908 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
3909 else {
3910 cmd->result = (DID_BAD_TARGET << 16);
3911 cmd->scsi_done(cmd);
3913 return rc;
3915 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);