SATA: Blacklisting of systems that spin off disks during ACPI power off
[linux-2.6/verdex.git] / drivers / ata / libata-scsi.c
blob3c4c5ae277ba583074a2f407fe5cf25caf2b0320
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/kernel.h>
37 #include <linux/blkdev.h>
38 #include <linux/spinlock.h>
39 #include <scsi/scsi.h>
40 #include <scsi/scsi_host.h>
41 #include <scsi/scsi_cmnd.h>
42 #include <scsi/scsi_eh.h>
43 #include <scsi/scsi_device.h>
44 #include <scsi/scsi_tcq.h>
45 #include <scsi/scsi_transport.h>
46 #include <linux/libata.h>
47 #include <linux/hdreg.h>
48 #include <linux/uaccess.h>
49 #include <linux/suspend.h>
51 #include "libata.h"
53 #define SECTOR_SIZE 512
54 #define ATA_SCSI_RBUF_SIZE 4096
56 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
57 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
59 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
61 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
62 const struct scsi_device *scsidev);
63 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
64 const struct scsi_device *scsidev);
65 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
66 unsigned int id, unsigned int lun);
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 */
108 * libata transport template. libata doesn't do real transport stuff.
109 * It just needs the eh_timed_out hook.
111 static struct scsi_transport_template ata_scsi_transport_template = {
112 .eh_strategy_handler = ata_scsi_error,
113 .eh_timed_out = ata_scsi_timed_out,
114 .user_scan = ata_scsi_user_scan,
118 static const struct {
119 enum link_pm value;
120 const char *name;
121 } link_pm_policy[] = {
122 { NOT_AVAILABLE, "max_performance" },
123 { MIN_POWER, "min_power" },
124 { MAX_PERFORMANCE, "max_performance" },
125 { MEDIUM_POWER, "medium_power" },
128 static const char *ata_scsi_lpm_get(enum link_pm policy)
130 int i;
132 for (i = 0; i < ARRAY_SIZE(link_pm_policy); i++)
133 if (link_pm_policy[i].value == policy)
134 return link_pm_policy[i].name;
136 return NULL;
139 static ssize_t ata_scsi_lpm_put(struct device *dev,
140 struct device_attribute *attr,
141 const char *buf, size_t count)
143 struct Scsi_Host *shost = class_to_shost(dev);
144 struct ata_port *ap = ata_shost_to_port(shost);
145 enum link_pm policy = 0;
146 int i;
149 * we are skipping array location 0 on purpose - this
150 * is because a value of NOT_AVAILABLE is displayed
151 * to the user as max_performance, but when the user
152 * writes "max_performance", they actually want the
153 * value to match MAX_PERFORMANCE.
155 for (i = 1; i < ARRAY_SIZE(link_pm_policy); i++) {
156 const int len = strlen(link_pm_policy[i].name);
157 if (strncmp(link_pm_policy[i].name, buf, len) == 0 &&
158 buf[len] == '\n') {
159 policy = link_pm_policy[i].value;
160 break;
163 if (!policy)
164 return -EINVAL;
166 ata_lpm_schedule(ap, policy);
167 return count;
170 static ssize_t
171 ata_scsi_lpm_show(struct device *dev, struct device_attribute *attr, char *buf)
173 struct Scsi_Host *shost = class_to_shost(dev);
174 struct ata_port *ap = ata_shost_to_port(shost);
175 const char *policy =
176 ata_scsi_lpm_get(ap->pm_policy);
178 if (!policy)
179 return -EINVAL;
181 return snprintf(buf, 23, "%s\n", policy);
183 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
184 ata_scsi_lpm_show, ata_scsi_lpm_put);
185 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
187 static ssize_t ata_scsi_park_show(struct device *device,
188 struct device_attribute *attr, char *buf)
190 struct scsi_device *sdev = to_scsi_device(device);
191 struct ata_port *ap;
192 struct ata_link *link;
193 struct ata_device *dev;
194 unsigned long flags, now;
195 unsigned int uninitialized_var(msecs);
196 int rc = 0;
198 ap = ata_shost_to_port(sdev->host);
200 spin_lock_irqsave(ap->lock, flags);
201 dev = ata_scsi_find_dev(ap, sdev);
202 if (!dev) {
203 rc = -ENODEV;
204 goto unlock;
206 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
207 rc = -EOPNOTSUPP;
208 goto unlock;
211 link = dev->link;
212 now = jiffies;
213 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
214 link->eh_context.unloaded_mask & (1 << dev->devno) &&
215 time_after(dev->unpark_deadline, now))
216 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
217 else
218 msecs = 0;
220 unlock:
221 spin_unlock_irq(ap->lock);
223 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
226 static ssize_t ata_scsi_park_store(struct device *device,
227 struct device_attribute *attr,
228 const char *buf, size_t len)
230 struct scsi_device *sdev = to_scsi_device(device);
231 struct ata_port *ap;
232 struct ata_device *dev;
233 long int input;
234 unsigned long flags;
235 int rc;
237 rc = strict_strtol(buf, 10, &input);
238 if (rc || input < -2)
239 return -EINVAL;
240 if (input > ATA_TMOUT_MAX_PARK) {
241 rc = -EOVERFLOW;
242 input = ATA_TMOUT_MAX_PARK;
245 ap = ata_shost_to_port(sdev->host);
247 spin_lock_irqsave(ap->lock, flags);
248 dev = ata_scsi_find_dev(ap, sdev);
249 if (unlikely(!dev)) {
250 rc = -ENODEV;
251 goto unlock;
253 if (dev->class != ATA_DEV_ATA) {
254 rc = -EOPNOTSUPP;
255 goto unlock;
258 if (input >= 0) {
259 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
260 rc = -EOPNOTSUPP;
261 goto unlock;
264 dev->unpark_deadline = ata_deadline(jiffies, input);
265 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
266 ata_port_schedule_eh(ap);
267 complete(&ap->park_req_pending);
268 } else {
269 switch (input) {
270 case -1:
271 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
272 break;
273 case -2:
274 dev->flags |= ATA_DFLAG_NO_UNLOAD;
275 break;
278 unlock:
279 spin_unlock_irqrestore(ap->lock, flags);
281 return rc ? rc : len;
283 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
284 ata_scsi_park_show, ata_scsi_park_store);
285 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
287 static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
289 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
291 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
294 static ssize_t
295 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
296 const char *buf, size_t count)
298 struct Scsi_Host *shost = class_to_shost(dev);
299 struct ata_port *ap = ata_shost_to_port(shost);
300 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
301 return ap->ops->em_store(ap, buf, count);
302 return -EINVAL;
305 static ssize_t
306 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
307 char *buf)
309 struct Scsi_Host *shost = class_to_shost(dev);
310 struct ata_port *ap = ata_shost_to_port(shost);
312 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
313 return ap->ops->em_show(ap, buf);
314 return -EINVAL;
316 DEVICE_ATTR(em_message, S_IRUGO | S_IWUGO,
317 ata_scsi_em_message_show, ata_scsi_em_message_store);
318 EXPORT_SYMBOL_GPL(dev_attr_em_message);
320 static ssize_t
321 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
322 char *buf)
324 struct Scsi_Host *shost = class_to_shost(dev);
325 struct ata_port *ap = ata_shost_to_port(shost);
327 return snprintf(buf, 23, "%d\n", ap->em_message_type);
329 DEVICE_ATTR(em_message_type, S_IRUGO,
330 ata_scsi_em_message_type_show, NULL);
331 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
333 static ssize_t
334 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
335 char *buf)
337 struct scsi_device *sdev = to_scsi_device(dev);
338 struct ata_port *ap = ata_shost_to_port(sdev->host);
339 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
341 if (ap->ops->sw_activity_show && (ap->flags & ATA_FLAG_SW_ACTIVITY))
342 return ap->ops->sw_activity_show(atadev, buf);
343 return -EINVAL;
346 static ssize_t
347 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
348 const char *buf, size_t count)
350 struct scsi_device *sdev = to_scsi_device(dev);
351 struct ata_port *ap = ata_shost_to_port(sdev->host);
352 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
353 enum sw_activity val;
354 int rc;
356 if (ap->ops->sw_activity_store && (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
357 val = simple_strtoul(buf, NULL, 0);
358 switch (val) {
359 case OFF: case BLINK_ON: case BLINK_OFF:
360 rc = ap->ops->sw_activity_store(atadev, val);
361 if (!rc)
362 return count;
363 else
364 return rc;
367 return -EINVAL;
369 DEVICE_ATTR(sw_activity, S_IWUGO | S_IRUGO, ata_scsi_activity_show,
370 ata_scsi_activity_store);
371 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
373 struct device_attribute *ata_common_sdev_attrs[] = {
374 &dev_attr_unload_heads,
375 NULL
377 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
379 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
380 void (*done)(struct scsi_cmnd *))
382 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
383 /* "Invalid field in cbd" */
384 done(cmd);
388 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
389 * @sdev: SCSI device for which BIOS geometry is to be determined
390 * @bdev: block device associated with @sdev
391 * @capacity: capacity of SCSI device
392 * @geom: location to which geometry will be output
394 * Generic bios head/sector/cylinder calculator
395 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
396 * mapping. Some situations may arise where the disk is not
397 * bootable if this is not used.
399 * LOCKING:
400 * Defined by the SCSI layer. We don't really care.
402 * RETURNS:
403 * Zero.
405 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
406 sector_t capacity, int geom[])
408 geom[0] = 255;
409 geom[1] = 63;
410 sector_div(capacity, 255*63);
411 geom[2] = capacity;
413 return 0;
417 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
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 = SECTOR_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 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
650 int cmd, void __user *arg)
652 int val = -EINVAL, rc = -EINVAL;
654 switch (cmd) {
655 case ATA_IOC_GET_IO32:
656 val = 0;
657 if (copy_to_user(arg, &val, 1))
658 return -EFAULT;
659 return 0;
661 case ATA_IOC_SET_IO32:
662 val = (unsigned long) arg;
663 if (val != 0)
664 return -EINVAL;
665 return 0;
667 case HDIO_GET_IDENTITY:
668 return ata_get_identity(ap, scsidev, arg);
670 case HDIO_DRIVE_CMD:
671 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
672 return -EACCES;
673 return ata_cmd_ioctl(scsidev, arg);
675 case HDIO_DRIVE_TASK:
676 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
677 return -EACCES;
678 return ata_task_ioctl(scsidev, arg);
680 default:
681 rc = -ENOTTY;
682 break;
685 return rc;
687 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
689 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
691 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
692 scsidev, cmd, arg);
694 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
697 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
698 * @dev: ATA device to which the new command is attached
699 * @cmd: SCSI command that originated this ATA command
700 * @done: SCSI command completion function
702 * Obtain a reference to an unused ata_queued_cmd structure,
703 * which is the basic libata structure representing a single
704 * ATA command sent to the hardware.
706 * If a command was available, fill in the SCSI-specific
707 * portions of the structure with information on the
708 * current command.
710 * LOCKING:
711 * spin_lock_irqsave(host lock)
713 * RETURNS:
714 * Command allocated, or %NULL if none available.
716 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
717 struct scsi_cmnd *cmd,
718 void (*done)(struct scsi_cmnd *))
720 struct ata_queued_cmd *qc;
722 qc = ata_qc_new_init(dev);
723 if (qc) {
724 qc->scsicmd = cmd;
725 qc->scsidone = done;
727 qc->sg = scsi_sglist(cmd);
728 qc->n_elem = scsi_sg_count(cmd);
729 } else {
730 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
731 done(cmd);
734 return qc;
737 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
739 struct scsi_cmnd *scmd = qc->scsicmd;
741 qc->extrabytes = scmd->request->extra_len;
742 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
746 * ata_dump_status - user friendly display of error info
747 * @id: id of the port in question
748 * @tf: ptr to filled out taskfile
750 * Decode and dump the ATA error/status registers for the user so
751 * that they have some idea what really happened at the non
752 * make-believe layer.
754 * LOCKING:
755 * inherited from caller
757 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
759 u8 stat = tf->command, err = tf->feature;
761 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
762 if (stat & ATA_BUSY) {
763 printk("Busy }\n"); /* Data is not valid in this case */
764 } else {
765 if (stat & 0x40) printk("DriveReady ");
766 if (stat & 0x20) printk("DeviceFault ");
767 if (stat & 0x10) printk("SeekComplete ");
768 if (stat & 0x08) printk("DataRequest ");
769 if (stat & 0x04) printk("CorrectedError ");
770 if (stat & 0x02) printk("Index ");
771 if (stat & 0x01) printk("Error ");
772 printk("}\n");
774 if (err) {
775 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
776 if (err & 0x04) printk("DriveStatusError ");
777 if (err & 0x80) {
778 if (err & 0x04) printk("BadCRC ");
779 else printk("Sector ");
781 if (err & 0x40) printk("UncorrectableError ");
782 if (err & 0x10) printk("SectorIdNotFound ");
783 if (err & 0x02) printk("TrackZeroNotFound ");
784 if (err & 0x01) printk("AddrMarkNotFound ");
785 printk("}\n");
791 * ata_to_sense_error - convert ATA error to SCSI error
792 * @id: ATA device number
793 * @drv_stat: value contained in ATA status register
794 * @drv_err: value contained in ATA error register
795 * @sk: the sense key we'll fill out
796 * @asc: the additional sense code we'll fill out
797 * @ascq: the additional sense code qualifier we'll fill out
798 * @verbose: be verbose
800 * Converts an ATA error into a SCSI error. Fill out pointers to
801 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
802 * format sense blocks.
804 * LOCKING:
805 * spin_lock_irqsave(host lock)
807 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
808 u8 *asc, u8 *ascq, int verbose)
810 int i;
812 /* Based on the 3ware driver translation table */
813 static const unsigned char sense_table[][4] = {
814 /* BBD|ECC|ID|MAR */
815 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
816 /* BBD|ECC|ID */
817 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
818 /* ECC|MC|MARK */
819 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
820 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
821 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
822 /* MC|ID|ABRT|TRK0|MARK */
823 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
824 /* MCR|MARK */
825 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
826 /* Bad address mark */
827 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
828 /* TRK0 */
829 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
830 /* Abort & !ICRC */
831 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
832 /* Media change request */
833 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
834 /* SRV */
835 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
836 /* Media change */
837 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
838 /* ECC */
839 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
840 /* BBD - block marked bad */
841 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
842 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
844 static const unsigned char stat_table[][4] = {
845 /* Must be first because BUSY means no other bits valid */
846 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
847 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
848 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
849 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
850 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
854 * Is this an error we can process/parse
856 if (drv_stat & ATA_BUSY) {
857 drv_err = 0; /* Ignore the err bits, they're invalid */
860 if (drv_err) {
861 /* Look for drv_err */
862 for (i = 0; sense_table[i][0] != 0xFF; i++) {
863 /* Look for best matches first */
864 if ((sense_table[i][0] & drv_err) ==
865 sense_table[i][0]) {
866 *sk = sense_table[i][1];
867 *asc = sense_table[i][2];
868 *ascq = sense_table[i][3];
869 goto translate_done;
872 /* No immediate match */
873 if (verbose)
874 printk(KERN_WARNING "ata%u: no sense translation for "
875 "error 0x%02x\n", id, drv_err);
878 /* Fall back to interpreting status bits */
879 for (i = 0; stat_table[i][0] != 0xFF; i++) {
880 if (stat_table[i][0] & drv_stat) {
881 *sk = stat_table[i][1];
882 *asc = stat_table[i][2];
883 *ascq = stat_table[i][3];
884 goto translate_done;
887 /* No error? Undecoded? */
888 if (verbose)
889 printk(KERN_WARNING "ata%u: no sense translation for "
890 "status: 0x%02x\n", id, drv_stat);
892 /* We need a sensible error return here, which is tricky, and one
893 that won't cause people to do things like return a disk wrongly */
894 *sk = ABORTED_COMMAND;
895 *asc = 0x00;
896 *ascq = 0x00;
898 translate_done:
899 if (verbose)
900 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
901 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
902 id, drv_stat, drv_err, *sk, *asc, *ascq);
903 return;
907 * ata_gen_passthru_sense - Generate check condition sense block.
908 * @qc: Command that completed.
910 * This function is specific to the ATA descriptor format sense
911 * block specified for the ATA pass through commands. Regardless
912 * of whether the command errored or not, return a sense
913 * block. Copy all controller registers into the sense
914 * block. Clear sense key, ASC & ASCQ if there is no error.
916 * LOCKING:
917 * None.
919 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
921 struct scsi_cmnd *cmd = qc->scsicmd;
922 struct ata_taskfile *tf = &qc->result_tf;
923 unsigned char *sb = cmd->sense_buffer;
924 unsigned char *desc = sb + 8;
925 int verbose = qc->ap->ops->error_handler == NULL;
927 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
929 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
932 * Use ata_to_sense_error() to map status register bits
933 * onto sense key, asc & ascq.
935 if (qc->err_mask ||
936 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
937 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
938 &sb[1], &sb[2], &sb[3], verbose);
939 sb[1] &= 0x0f;
943 * Sense data is current and format is descriptor.
945 sb[0] = 0x72;
947 desc[0] = 0x09;
949 /* set length of additional sense data */
950 sb[7] = 14;
951 desc[1] = 12;
954 * Copy registers into sense buffer.
956 desc[2] = 0x00;
957 desc[3] = tf->feature; /* == error reg */
958 desc[5] = tf->nsect;
959 desc[7] = tf->lbal;
960 desc[9] = tf->lbam;
961 desc[11] = tf->lbah;
962 desc[12] = tf->device;
963 desc[13] = tf->command; /* == status reg */
966 * Fill in Extend bit, and the high order bytes
967 * if applicable.
969 if (tf->flags & ATA_TFLAG_LBA48) {
970 desc[2] |= 0x01;
971 desc[4] = tf->hob_nsect;
972 desc[6] = tf->hob_lbal;
973 desc[8] = tf->hob_lbam;
974 desc[10] = tf->hob_lbah;
979 * ata_gen_ata_sense - generate a SCSI fixed sense block
980 * @qc: Command that we are erroring out
982 * Generate sense block for a failed ATA command @qc. Descriptor
983 * format is used to accomodate LBA48 block address.
985 * LOCKING:
986 * None.
988 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
990 struct ata_device *dev = qc->dev;
991 struct scsi_cmnd *cmd = qc->scsicmd;
992 struct ata_taskfile *tf = &qc->result_tf;
993 unsigned char *sb = cmd->sense_buffer;
994 unsigned char *desc = sb + 8;
995 int verbose = qc->ap->ops->error_handler == NULL;
996 u64 block;
998 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1000 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1002 /* sense data is current and format is descriptor */
1003 sb[0] = 0x72;
1005 /* Use ata_to_sense_error() to map status register bits
1006 * onto sense key, asc & ascq.
1008 if (qc->err_mask ||
1009 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1010 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1011 &sb[1], &sb[2], &sb[3], verbose);
1012 sb[1] &= 0x0f;
1015 block = ata_tf_read_block(&qc->result_tf, dev);
1017 /* information sense data descriptor */
1018 sb[7] = 12;
1019 desc[0] = 0x00;
1020 desc[1] = 10;
1022 desc[2] |= 0x80; /* valid */
1023 desc[6] = block >> 40;
1024 desc[7] = block >> 32;
1025 desc[8] = block >> 24;
1026 desc[9] = block >> 16;
1027 desc[10] = block >> 8;
1028 desc[11] = block;
1031 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1033 sdev->use_10_for_rw = 1;
1034 sdev->use_10_for_ms = 1;
1036 /* Schedule policy is determined by ->qc_defer() callback and
1037 * it needs to see every deferred qc. Set dev_blocked to 1 to
1038 * prevent SCSI midlayer from automatically deferring
1039 * requests.
1041 sdev->max_device_blocked = 1;
1045 * atapi_drain_needed - Check whether data transfer may overflow
1046 * @rq: request to be checked
1048 * ATAPI commands which transfer variable length data to host
1049 * might overflow due to application error or hardare bug. This
1050 * function checks whether overflow should be drained and ignored
1051 * for @request.
1053 * LOCKING:
1054 * None.
1056 * RETURNS:
1057 * 1 if ; otherwise, 0.
1059 static int atapi_drain_needed(struct request *rq)
1061 if (likely(!blk_pc_request(rq)))
1062 return 0;
1064 if (!rq->data_len || (rq->cmd_flags & REQ_RW))
1065 return 0;
1067 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1070 static int ata_scsi_dev_config(struct scsi_device *sdev,
1071 struct ata_device *dev)
1073 if (!ata_id_has_unload(dev->id))
1074 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1076 /* configure max sectors */
1077 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
1079 if (dev->class == ATA_DEV_ATAPI) {
1080 struct request_queue *q = sdev->request_queue;
1081 void *buf;
1083 /* set the min alignment and padding */
1084 blk_queue_update_dma_alignment(sdev->request_queue,
1085 ATA_DMA_PAD_SZ - 1);
1086 blk_queue_update_dma_pad(sdev->request_queue,
1087 ATA_DMA_PAD_SZ - 1);
1089 /* configure draining */
1090 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1091 if (!buf) {
1092 ata_dev_printk(dev, KERN_ERR,
1093 "drain buffer allocation failed\n");
1094 return -ENOMEM;
1097 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1098 } else {
1099 if (ata_id_is_ssd(dev->id))
1100 queue_flag_set_unlocked(QUEUE_FLAG_NONROT,
1101 sdev->request_queue);
1103 /* ATA devices must be sector aligned */
1104 blk_queue_update_dma_alignment(sdev->request_queue,
1105 ATA_SECT_SIZE - 1);
1106 sdev->manage_start_stop = 1;
1109 if (dev->flags & ATA_DFLAG_AN)
1110 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1112 if (dev->flags & ATA_DFLAG_NCQ) {
1113 int depth;
1115 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1116 depth = min(ATA_MAX_QUEUE - 1, depth);
1117 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1120 return 0;
1124 * ata_scsi_slave_config - Set SCSI device attributes
1125 * @sdev: SCSI device to examine
1127 * This is called before we actually start reading
1128 * and writing to the device, to configure certain
1129 * SCSI mid-layer behaviors.
1131 * LOCKING:
1132 * Defined by SCSI layer. We don't really care.
1135 int ata_scsi_slave_config(struct scsi_device *sdev)
1137 struct ata_port *ap = ata_shost_to_port(sdev->host);
1138 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1139 int rc = 0;
1141 ata_scsi_sdev_config(sdev);
1143 if (dev)
1144 rc = ata_scsi_dev_config(sdev, dev);
1146 return rc;
1150 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1151 * @sdev: SCSI device to be destroyed
1153 * @sdev is about to be destroyed for hot/warm unplugging. If
1154 * this unplugging was initiated by libata as indicated by NULL
1155 * dev->sdev, this function doesn't have to do anything.
1156 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1157 * Clear dev->sdev, schedule the device for ATA detach and invoke
1158 * EH.
1160 * LOCKING:
1161 * Defined by SCSI layer. We don't really care.
1163 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1165 struct ata_port *ap = ata_shost_to_port(sdev->host);
1166 struct request_queue *q = sdev->request_queue;
1167 unsigned long flags;
1168 struct ata_device *dev;
1170 if (!ap->ops->error_handler)
1171 return;
1173 spin_lock_irqsave(ap->lock, flags);
1174 dev = __ata_scsi_find_dev(ap, sdev);
1175 if (dev && dev->sdev) {
1176 /* SCSI device already in CANCEL state, no need to offline it */
1177 dev->sdev = NULL;
1178 dev->flags |= ATA_DFLAG_DETACH;
1179 ata_port_schedule_eh(ap);
1181 spin_unlock_irqrestore(ap->lock, flags);
1183 kfree(q->dma_drain_buffer);
1184 q->dma_drain_buffer = NULL;
1185 q->dma_drain_size = 0;
1189 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1190 * @sdev: SCSI device to configure queue depth for
1191 * @queue_depth: new queue depth
1193 * This is libata standard hostt->change_queue_depth callback.
1194 * SCSI will call into this callback when user tries to set queue
1195 * depth via sysfs.
1197 * LOCKING:
1198 * SCSI layer (we don't care)
1200 * RETURNS:
1201 * Newly configured queue depth.
1203 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1205 struct ata_port *ap = ata_shost_to_port(sdev->host);
1206 struct ata_device *dev;
1207 unsigned long flags;
1209 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1210 return sdev->queue_depth;
1212 dev = ata_scsi_find_dev(ap, sdev);
1213 if (!dev || !ata_dev_enabled(dev))
1214 return sdev->queue_depth;
1216 /* NCQ enabled? */
1217 spin_lock_irqsave(ap->lock, flags);
1218 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1219 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1220 dev->flags |= ATA_DFLAG_NCQ_OFF;
1221 queue_depth = 1;
1223 spin_unlock_irqrestore(ap->lock, flags);
1225 /* limit and apply queue depth */
1226 queue_depth = min(queue_depth, sdev->host->can_queue);
1227 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1228 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1230 if (sdev->queue_depth == queue_depth)
1231 return -EINVAL;
1233 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1234 return queue_depth;
1237 /* XXX: for spindown warning */
1238 static void ata_delayed_done_timerfn(unsigned long arg)
1240 struct scsi_cmnd *scmd = (void *)arg;
1242 scmd->scsi_done(scmd);
1245 /* XXX: for spindown warning */
1246 static void ata_delayed_done(struct scsi_cmnd *scmd)
1248 static struct timer_list timer;
1250 setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
1251 mod_timer(&timer, jiffies + 5 * HZ);
1255 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1256 * @qc: Storage for translated ATA taskfile
1258 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1259 * (to start). Perhaps these commands should be preceded by
1260 * CHECK POWER MODE to see what power mode the device is already in.
1261 * [See SAT revision 5 at www.t10.org]
1263 * LOCKING:
1264 * spin_lock_irqsave(host lock)
1266 * RETURNS:
1267 * Zero on success, non-zero on error.
1269 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1271 struct scsi_cmnd *scmd = qc->scsicmd;
1272 struct ata_taskfile *tf = &qc->tf;
1273 const u8 *cdb = scmd->cmnd;
1275 if (scmd->cmd_len < 5)
1276 goto invalid_fld;
1278 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1279 tf->protocol = ATA_PROT_NODATA;
1280 if (cdb[1] & 0x1) {
1281 ; /* ignore IMMED bit, violates sat-r05 */
1283 if (cdb[4] & 0x2)
1284 goto invalid_fld; /* LOEJ bit set not supported */
1285 if (((cdb[4] >> 4) & 0xf) != 0)
1286 goto invalid_fld; /* power conditions not supported */
1288 if (cdb[4] & 0x1) {
1289 tf->nsect = 1; /* 1 sector, lba=0 */
1291 if (qc->dev->flags & ATA_DFLAG_LBA) {
1292 tf->flags |= ATA_TFLAG_LBA;
1294 tf->lbah = 0x0;
1295 tf->lbam = 0x0;
1296 tf->lbal = 0x0;
1297 tf->device |= ATA_LBA;
1298 } else {
1299 /* CHS */
1300 tf->lbal = 0x1; /* sect */
1301 tf->lbam = 0x0; /* cyl low */
1302 tf->lbah = 0x0; /* cyl high */
1305 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1306 } else {
1307 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1308 * or S5) causing some drives to spin up and down again.
1310 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1311 system_state == SYSTEM_POWER_OFF)
1312 goto skip;
1314 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1315 system_entering_hibernation())
1316 goto skip;
1318 /* XXX: This is for backward compatibility, will be
1319 * removed. Read Documentation/feature-removal-schedule.txt
1320 * for more info.
1322 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
1323 (system_state == SYSTEM_HALT ||
1324 system_state == SYSTEM_POWER_OFF)) {
1325 static unsigned long warned;
1327 if (!test_and_set_bit(0, &warned)) {
1328 ata_dev_printk(qc->dev, KERN_WARNING,
1329 "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
1330 "UPDATE SHUTDOWN UTILITY\n");
1331 ata_dev_printk(qc->dev, KERN_WARNING,
1332 "For more info, visit "
1333 "http://linux-ata.org/shutdown.html\n");
1335 /* ->scsi_done is not used, use it for
1336 * delayed completion.
1338 scmd->scsi_done = qc->scsidone;
1339 qc->scsidone = ata_delayed_done;
1341 goto skip;
1344 /* Issue ATA STANDBY IMMEDIATE command */
1345 tf->command = ATA_CMD_STANDBYNOW1;
1349 * Standby and Idle condition timers could be implemented but that
1350 * would require libata to implement the Power condition mode page
1351 * and allow the user to change it. Changing mode pages requires
1352 * MODE SELECT to be implemented.
1355 return 0;
1357 invalid_fld:
1358 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1359 /* "Invalid field in cbd" */
1360 return 1;
1361 skip:
1362 scmd->result = SAM_STAT_GOOD;
1363 return 1;
1368 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1369 * @qc: Storage for translated ATA taskfile
1371 * Sets up an ATA taskfile to issue FLUSH CACHE or
1372 * FLUSH CACHE EXT.
1374 * LOCKING:
1375 * spin_lock_irqsave(host lock)
1377 * RETURNS:
1378 * Zero on success, non-zero on error.
1380 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1382 struct ata_taskfile *tf = &qc->tf;
1384 tf->flags |= ATA_TFLAG_DEVICE;
1385 tf->protocol = ATA_PROT_NODATA;
1387 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1388 tf->command = ATA_CMD_FLUSH_EXT;
1389 else
1390 tf->command = ATA_CMD_FLUSH;
1392 /* flush is critical for IO integrity, consider it an IO command */
1393 qc->flags |= ATA_QCFLAG_IO;
1395 return 0;
1399 * scsi_6_lba_len - Get LBA and transfer length
1400 * @cdb: SCSI command to translate
1402 * Calculate LBA and transfer length for 6-byte commands.
1404 * RETURNS:
1405 * @plba: the LBA
1406 * @plen: the transfer length
1408 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1410 u64 lba = 0;
1411 u32 len;
1413 VPRINTK("six-byte command\n");
1415 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1416 lba |= ((u64)cdb[2]) << 8;
1417 lba |= ((u64)cdb[3]);
1419 len = cdb[4];
1421 *plba = lba;
1422 *plen = len;
1426 * scsi_10_lba_len - Get LBA and transfer length
1427 * @cdb: SCSI command to translate
1429 * Calculate LBA and transfer length for 10-byte commands.
1431 * RETURNS:
1432 * @plba: the LBA
1433 * @plen: the transfer length
1435 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1437 u64 lba = 0;
1438 u32 len = 0;
1440 VPRINTK("ten-byte command\n");
1442 lba |= ((u64)cdb[2]) << 24;
1443 lba |= ((u64)cdb[3]) << 16;
1444 lba |= ((u64)cdb[4]) << 8;
1445 lba |= ((u64)cdb[5]);
1447 len |= ((u32)cdb[7]) << 8;
1448 len |= ((u32)cdb[8]);
1450 *plba = lba;
1451 *plen = len;
1455 * scsi_16_lba_len - Get LBA and transfer length
1456 * @cdb: SCSI command to translate
1458 * Calculate LBA and transfer length for 16-byte commands.
1460 * RETURNS:
1461 * @plba: the LBA
1462 * @plen: the transfer length
1464 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1466 u64 lba = 0;
1467 u32 len = 0;
1469 VPRINTK("sixteen-byte command\n");
1471 lba |= ((u64)cdb[2]) << 56;
1472 lba |= ((u64)cdb[3]) << 48;
1473 lba |= ((u64)cdb[4]) << 40;
1474 lba |= ((u64)cdb[5]) << 32;
1475 lba |= ((u64)cdb[6]) << 24;
1476 lba |= ((u64)cdb[7]) << 16;
1477 lba |= ((u64)cdb[8]) << 8;
1478 lba |= ((u64)cdb[9]);
1480 len |= ((u32)cdb[10]) << 24;
1481 len |= ((u32)cdb[11]) << 16;
1482 len |= ((u32)cdb[12]) << 8;
1483 len |= ((u32)cdb[13]);
1485 *plba = lba;
1486 *plen = len;
1490 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1491 * @qc: Storage for translated ATA taskfile
1493 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1495 * LOCKING:
1496 * spin_lock_irqsave(host lock)
1498 * RETURNS:
1499 * Zero on success, non-zero on error.
1501 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1503 struct scsi_cmnd *scmd = qc->scsicmd;
1504 struct ata_taskfile *tf = &qc->tf;
1505 struct ata_device *dev = qc->dev;
1506 u64 dev_sectors = qc->dev->n_sectors;
1507 const u8 *cdb = scmd->cmnd;
1508 u64 block;
1509 u32 n_block;
1511 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1512 tf->protocol = ATA_PROT_NODATA;
1514 if (cdb[0] == VERIFY) {
1515 if (scmd->cmd_len < 10)
1516 goto invalid_fld;
1517 scsi_10_lba_len(cdb, &block, &n_block);
1518 } else if (cdb[0] == VERIFY_16) {
1519 if (scmd->cmd_len < 16)
1520 goto invalid_fld;
1521 scsi_16_lba_len(cdb, &block, &n_block);
1522 } else
1523 goto invalid_fld;
1525 if (!n_block)
1526 goto nothing_to_do;
1527 if (block >= dev_sectors)
1528 goto out_of_range;
1529 if ((block + n_block) > dev_sectors)
1530 goto out_of_range;
1532 if (dev->flags & ATA_DFLAG_LBA) {
1533 tf->flags |= ATA_TFLAG_LBA;
1535 if (lba_28_ok(block, n_block)) {
1536 /* use LBA28 */
1537 tf->command = ATA_CMD_VERIFY;
1538 tf->device |= (block >> 24) & 0xf;
1539 } else if (lba_48_ok(block, n_block)) {
1540 if (!(dev->flags & ATA_DFLAG_LBA48))
1541 goto out_of_range;
1543 /* use LBA48 */
1544 tf->flags |= ATA_TFLAG_LBA48;
1545 tf->command = ATA_CMD_VERIFY_EXT;
1547 tf->hob_nsect = (n_block >> 8) & 0xff;
1549 tf->hob_lbah = (block >> 40) & 0xff;
1550 tf->hob_lbam = (block >> 32) & 0xff;
1551 tf->hob_lbal = (block >> 24) & 0xff;
1552 } else
1553 /* request too large even for LBA48 */
1554 goto out_of_range;
1556 tf->nsect = n_block & 0xff;
1558 tf->lbah = (block >> 16) & 0xff;
1559 tf->lbam = (block >> 8) & 0xff;
1560 tf->lbal = block & 0xff;
1562 tf->device |= ATA_LBA;
1563 } else {
1564 /* CHS */
1565 u32 sect, head, cyl, track;
1567 if (!lba_28_ok(block, n_block))
1568 goto out_of_range;
1570 /* Convert LBA to CHS */
1571 track = (u32)block / dev->sectors;
1572 cyl = track / dev->heads;
1573 head = track % dev->heads;
1574 sect = (u32)block % dev->sectors + 1;
1576 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1577 (u32)block, track, cyl, head, sect);
1579 /* Check whether the converted CHS can fit.
1580 Cylinder: 0-65535
1581 Head: 0-15
1582 Sector: 1-255*/
1583 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1584 goto out_of_range;
1586 tf->command = ATA_CMD_VERIFY;
1587 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1588 tf->lbal = sect;
1589 tf->lbam = cyl;
1590 tf->lbah = cyl >> 8;
1591 tf->device |= head;
1594 return 0;
1596 invalid_fld:
1597 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1598 /* "Invalid field in cbd" */
1599 return 1;
1601 out_of_range:
1602 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1603 /* "Logical Block Address out of range" */
1604 return 1;
1606 nothing_to_do:
1607 scmd->result = SAM_STAT_GOOD;
1608 return 1;
1612 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1613 * @qc: Storage for translated ATA taskfile
1615 * Converts any of six SCSI read/write commands into the
1616 * ATA counterpart, including starting sector (LBA),
1617 * sector count, and taking into account the device's LBA48
1618 * support.
1620 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1621 * %WRITE_16 are currently supported.
1623 * LOCKING:
1624 * spin_lock_irqsave(host lock)
1626 * RETURNS:
1627 * Zero on success, non-zero on error.
1629 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1631 struct scsi_cmnd *scmd = qc->scsicmd;
1632 const u8 *cdb = scmd->cmnd;
1633 unsigned int tf_flags = 0;
1634 u64 block;
1635 u32 n_block;
1636 int rc;
1638 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1639 tf_flags |= ATA_TFLAG_WRITE;
1641 /* Calculate the SCSI LBA, transfer length and FUA. */
1642 switch (cdb[0]) {
1643 case READ_10:
1644 case WRITE_10:
1645 if (unlikely(scmd->cmd_len < 10))
1646 goto invalid_fld;
1647 scsi_10_lba_len(cdb, &block, &n_block);
1648 if (unlikely(cdb[1] & (1 << 3)))
1649 tf_flags |= ATA_TFLAG_FUA;
1650 break;
1651 case READ_6:
1652 case WRITE_6:
1653 if (unlikely(scmd->cmd_len < 6))
1654 goto invalid_fld;
1655 scsi_6_lba_len(cdb, &block, &n_block);
1657 /* for 6-byte r/w commands, transfer length 0
1658 * means 256 blocks of data, not 0 block.
1660 if (!n_block)
1661 n_block = 256;
1662 break;
1663 case READ_16:
1664 case WRITE_16:
1665 if (unlikely(scmd->cmd_len < 16))
1666 goto invalid_fld;
1667 scsi_16_lba_len(cdb, &block, &n_block);
1668 if (unlikely(cdb[1] & (1 << 3)))
1669 tf_flags |= ATA_TFLAG_FUA;
1670 break;
1671 default:
1672 DPRINTK("no-byte command\n");
1673 goto invalid_fld;
1676 /* Check and compose ATA command */
1677 if (!n_block)
1678 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1679 * length 0 means transfer 0 block of data.
1680 * However, for ATA R/W commands, sector count 0 means
1681 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1683 * WARNING: one or two older ATA drives treat 0 as 0...
1685 goto nothing_to_do;
1687 qc->flags |= ATA_QCFLAG_IO;
1688 qc->nbytes = n_block * ATA_SECT_SIZE;
1690 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1691 qc->tag);
1692 if (likely(rc == 0))
1693 return 0;
1695 if (rc == -ERANGE)
1696 goto out_of_range;
1697 /* treat all other errors as -EINVAL, fall through */
1698 invalid_fld:
1699 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1700 /* "Invalid field in cbd" */
1701 return 1;
1703 out_of_range:
1704 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1705 /* "Logical Block Address out of range" */
1706 return 1;
1708 nothing_to_do:
1709 scmd->result = SAM_STAT_GOOD;
1710 return 1;
1713 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1715 struct ata_port *ap = qc->ap;
1716 struct scsi_cmnd *cmd = qc->scsicmd;
1717 u8 *cdb = cmd->cmnd;
1718 int need_sense = (qc->err_mask != 0);
1720 /* For ATA pass thru (SAT) commands, generate a sense block if
1721 * user mandated it or if there's an error. Note that if we
1722 * generate because the user forced us to, a check condition
1723 * is generated and the ATA register values are returned
1724 * whether the command completed successfully or not. If there
1725 * was no error, SK, ASC and ASCQ will all be zero.
1727 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1728 ((cdb[2] & 0x20) || need_sense)) {
1729 ata_gen_passthru_sense(qc);
1730 } else {
1731 if (!need_sense) {
1732 cmd->result = SAM_STAT_GOOD;
1733 } else {
1734 /* TODO: decide which descriptor format to use
1735 * for 48b LBA devices and call that here
1736 * instead of the fixed desc, which is only
1737 * good for smaller LBA (and maybe CHS?)
1738 * devices.
1740 ata_gen_ata_sense(qc);
1744 /* XXX: track spindown state for spindown skipping and warning */
1745 if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1746 qc->tf.command == ATA_CMD_STANDBYNOW1))
1747 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1748 else if (likely(system_state != SYSTEM_HALT &&
1749 system_state != SYSTEM_POWER_OFF))
1750 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1752 if (need_sense && !ap->ops->error_handler)
1753 ata_dump_status(ap->print_id, &qc->result_tf);
1755 qc->scsidone(cmd);
1757 ata_qc_free(qc);
1761 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1762 * @dev: ATA device to which the command is addressed
1763 * @cmd: SCSI command to execute
1764 * @done: SCSI command completion function
1765 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1767 * Our ->queuecommand() function has decided that the SCSI
1768 * command issued can be directly translated into an ATA
1769 * command, rather than handled internally.
1771 * This function sets up an ata_queued_cmd structure for the
1772 * SCSI command, and sends that ata_queued_cmd to the hardware.
1774 * The xlat_func argument (actor) returns 0 if ready to execute
1775 * ATA command, else 1 to finish translation. If 1 is returned
1776 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1777 * to be set reflecting an error condition or clean (early)
1778 * termination.
1780 * LOCKING:
1781 * spin_lock_irqsave(host lock)
1783 * RETURNS:
1784 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1785 * needs to be deferred.
1787 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1788 void (*done)(struct scsi_cmnd *),
1789 ata_xlat_func_t xlat_func)
1791 struct ata_port *ap = dev->link->ap;
1792 struct ata_queued_cmd *qc;
1793 int rc;
1795 VPRINTK("ENTER\n");
1797 qc = ata_scsi_qc_new(dev, cmd, done);
1798 if (!qc)
1799 goto err_mem;
1801 /* data is present; dma-map it */
1802 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1803 cmd->sc_data_direction == DMA_TO_DEVICE) {
1804 if (unlikely(scsi_bufflen(cmd) < 1)) {
1805 ata_dev_printk(dev, KERN_WARNING,
1806 "WARNING: zero len r/w req\n");
1807 goto err_did;
1810 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1812 qc->dma_dir = cmd->sc_data_direction;
1815 qc->complete_fn = ata_scsi_qc_complete;
1817 if (xlat_func(qc))
1818 goto early_finish;
1820 if (ap->ops->qc_defer) {
1821 if ((rc = ap->ops->qc_defer(qc)))
1822 goto defer;
1825 /* select device, send command to hardware */
1826 ata_qc_issue(qc);
1828 VPRINTK("EXIT\n");
1829 return 0;
1831 early_finish:
1832 ata_qc_free(qc);
1833 qc->scsidone(cmd);
1834 DPRINTK("EXIT - early finish (good or error)\n");
1835 return 0;
1837 err_did:
1838 ata_qc_free(qc);
1839 cmd->result = (DID_ERROR << 16);
1840 qc->scsidone(cmd);
1841 err_mem:
1842 DPRINTK("EXIT - internal\n");
1843 return 0;
1845 defer:
1846 ata_qc_free(qc);
1847 DPRINTK("EXIT - defer\n");
1848 if (rc == ATA_DEFER_LINK)
1849 return SCSI_MLQUEUE_DEVICE_BUSY;
1850 else
1851 return SCSI_MLQUEUE_HOST_BUSY;
1855 * ata_scsi_rbuf_get - Map response buffer.
1856 * @cmd: SCSI command containing buffer to be mapped.
1857 * @flags: unsigned long variable to store irq enable status
1858 * @copy_in: copy in from user buffer
1860 * Prepare buffer for simulated SCSI commands.
1862 * LOCKING:
1863 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1865 * RETURNS:
1866 * Pointer to response buffer.
1868 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1869 unsigned long *flags)
1871 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1873 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1874 if (copy_in)
1875 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1876 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1877 return ata_scsi_rbuf;
1881 * ata_scsi_rbuf_put - Unmap response buffer.
1882 * @cmd: SCSI command containing buffer to be unmapped.
1883 * @copy_out: copy out result
1884 * @flags: @flags passed to ata_scsi_rbuf_get()
1886 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1887 * @copy_back is true.
1889 * LOCKING:
1890 * Unlocks ata_scsi_rbuf_lock.
1892 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1893 unsigned long *flags)
1895 if (copy_out)
1896 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1897 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1898 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1902 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1903 * @args: device IDENTIFY data / SCSI command of interest.
1904 * @actor: Callback hook for desired SCSI command simulator
1906 * Takes care of the hard work of simulating a SCSI command...
1907 * Mapping the response buffer, calling the command's handler,
1908 * and handling the handler's return value. This return value
1909 * indicates whether the handler wishes the SCSI command to be
1910 * completed successfully (0), or not (in which case cmd->result
1911 * and sense buffer are assumed to be set).
1913 * LOCKING:
1914 * spin_lock_irqsave(host lock)
1916 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1917 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1919 u8 *rbuf;
1920 unsigned int rc;
1921 struct scsi_cmnd *cmd = args->cmd;
1922 unsigned long flags;
1924 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1925 rc = actor(args, rbuf);
1926 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1928 if (rc == 0)
1929 cmd->result = SAM_STAT_GOOD;
1930 args->done(cmd);
1934 * ata_scsiop_inq_std - Simulate INQUIRY command
1935 * @args: device IDENTIFY data / SCSI command of interest.
1936 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1938 * Returns standard device identification data associated
1939 * with non-VPD INQUIRY command output.
1941 * LOCKING:
1942 * spin_lock_irqsave(host lock)
1944 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1946 const u8 versions[] = {
1947 0x60, /* SAM-3 (no version claimed) */
1949 0x03,
1950 0x20, /* SBC-2 (no version claimed) */
1952 0x02,
1953 0x60 /* SPC-3 (no version claimed) */
1955 u8 hdr[] = {
1956 TYPE_DISK,
1958 0x5, /* claim SPC-3 version compatibility */
1960 95 - 4
1963 VPRINTK("ENTER\n");
1965 /* set scsi removeable (RMB) bit per ata bit */
1966 if (ata_id_removeable(args->id))
1967 hdr[1] |= (1 << 7);
1969 memcpy(rbuf, hdr, sizeof(hdr));
1970 memcpy(&rbuf[8], "ATA ", 8);
1971 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1972 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1974 if (rbuf[32] == 0 || rbuf[32] == ' ')
1975 memcpy(&rbuf[32], "n/a ", 4);
1977 memcpy(rbuf + 59, versions, sizeof(versions));
1979 return 0;
1983 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1984 * @args: device IDENTIFY data / SCSI command of interest.
1985 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1987 * Returns list of inquiry VPD pages available.
1989 * LOCKING:
1990 * spin_lock_irqsave(host lock)
1992 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1994 const u8 pages[] = {
1995 0x00, /* page 0x00, this page */
1996 0x80, /* page 0x80, unit serial no page */
1997 0x83, /* page 0x83, device ident page */
1998 0x89, /* page 0x89, ata info page */
1999 0xb1, /* page 0xb1, block device characteristics page */
2002 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
2003 memcpy(rbuf + 4, pages, sizeof(pages));
2004 return 0;
2008 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2009 * @args: device IDENTIFY data / SCSI command of interest.
2010 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2012 * Returns ATA device serial number.
2014 * LOCKING:
2015 * spin_lock_irqsave(host lock)
2017 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2019 const u8 hdr[] = {
2021 0x80, /* this page code */
2023 ATA_ID_SERNO_LEN, /* page len */
2026 memcpy(rbuf, hdr, sizeof(hdr));
2027 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2028 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2029 return 0;
2033 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2034 * @args: device IDENTIFY data / SCSI command of interest.
2035 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2037 * Yields two logical unit device identification designators:
2038 * - vendor specific ASCII containing the ATA serial number
2039 * - SAT defined "t10 vendor id based" containing ASCII vendor
2040 * name ("ATA "), model and serial numbers.
2042 * LOCKING:
2043 * spin_lock_irqsave(host lock)
2045 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2047 const int sat_model_serial_desc_len = 68;
2048 int num;
2050 rbuf[1] = 0x83; /* this page code */
2051 num = 4;
2053 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2054 rbuf[num + 0] = 2;
2055 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2056 num += 4;
2057 ata_id_string(args->id, (unsigned char *) rbuf + num,
2058 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2059 num += ATA_ID_SERNO_LEN;
2061 /* SAT defined lu model and serial numbers descriptor */
2062 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2063 rbuf[num + 0] = 2;
2064 rbuf[num + 1] = 1;
2065 rbuf[num + 3] = sat_model_serial_desc_len;
2066 num += 4;
2067 memcpy(rbuf + num, "ATA ", 8);
2068 num += 8;
2069 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2070 ATA_ID_PROD_LEN);
2071 num += ATA_ID_PROD_LEN;
2072 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2073 ATA_ID_SERNO_LEN);
2074 num += ATA_ID_SERNO_LEN;
2076 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2077 return 0;
2081 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2082 * @args: device IDENTIFY data / SCSI command of interest.
2083 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2085 * Yields SAT-specified ATA VPD page.
2087 * LOCKING:
2088 * spin_lock_irqsave(host lock)
2090 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2092 struct ata_taskfile tf;
2094 memset(&tf, 0, sizeof(tf));
2096 rbuf[1] = 0x89; /* our page code */
2097 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2098 rbuf[3] = (0x238 & 0xff);
2100 memcpy(&rbuf[8], "linux ", 8);
2101 memcpy(&rbuf[16], "libata ", 16);
2102 memcpy(&rbuf[32], DRV_VERSION, 4);
2103 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2105 /* we don't store the ATA device signature, so we fake it */
2107 tf.command = ATA_DRDY; /* really, this is Status reg */
2108 tf.lbal = 0x1;
2109 tf.nsect = 0x1;
2111 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2112 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2114 rbuf[56] = ATA_CMD_ID_ATA;
2116 memcpy(&rbuf[60], &args->id[0], 512);
2117 return 0;
2120 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2122 rbuf[1] = 0xb1;
2123 rbuf[3] = 0x3c;
2124 if (ata_id_major_version(args->id) > 7) {
2125 rbuf[4] = args->id[217] >> 8;
2126 rbuf[5] = args->id[217];
2127 rbuf[7] = args->id[168] & 0xf;
2130 return 0;
2134 * ata_scsiop_noop - Command handler that simply returns success.
2135 * @args: device IDENTIFY data / SCSI command of interest.
2136 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2138 * No operation. Simply returns success to caller, to indicate
2139 * that the caller should successfully complete this SCSI command.
2141 * LOCKING:
2142 * spin_lock_irqsave(host lock)
2144 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2146 VPRINTK("ENTER\n");
2147 return 0;
2151 * ata_msense_caching - Simulate MODE SENSE caching info page
2152 * @id: device IDENTIFY data
2153 * @buf: output buffer
2155 * Generate a caching info page, which conditionally indicates
2156 * write caching to the SCSI layer, depending on device
2157 * capabilities.
2159 * LOCKING:
2160 * None.
2162 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2164 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2165 if (ata_id_wcache_enabled(id))
2166 buf[2] |= (1 << 2); /* write cache enable */
2167 if (!ata_id_rahead_enabled(id))
2168 buf[12] |= (1 << 5); /* disable read ahead */
2169 return sizeof(def_cache_mpage);
2173 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2174 * @buf: output buffer
2176 * Generate a generic MODE SENSE control mode page.
2178 * LOCKING:
2179 * None.
2181 static unsigned int ata_msense_ctl_mode(u8 *buf)
2183 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2184 return sizeof(def_control_mpage);
2188 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2189 * @buf: output buffer
2191 * Generate a generic MODE SENSE r/w error recovery page.
2193 * LOCKING:
2194 * None.
2196 static unsigned int ata_msense_rw_recovery(u8 *buf)
2198 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2199 return sizeof(def_rw_recovery_mpage);
2203 * We can turn this into a real blacklist if it's needed, for now just
2204 * blacklist any Maxtor BANC1G10 revision firmware
2206 static int ata_dev_supports_fua(u16 *id)
2208 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2210 if (!libata_fua)
2211 return 0;
2212 if (!ata_id_has_fua(id))
2213 return 0;
2215 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2216 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2218 if (strcmp(model, "Maxtor"))
2219 return 1;
2220 if (strcmp(fw, "BANC1G10"))
2221 return 1;
2223 return 0; /* blacklisted */
2227 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2228 * @args: device IDENTIFY data / SCSI command of interest.
2229 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2231 * Simulate MODE SENSE commands. Assume this is invoked for direct
2232 * access devices (e.g. disks) only. There should be no block
2233 * descriptor for other device types.
2235 * LOCKING:
2236 * spin_lock_irqsave(host lock)
2238 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2240 struct ata_device *dev = args->dev;
2241 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2242 const u8 sat_blk_desc[] = {
2243 0, 0, 0, 0, /* number of blocks: sat unspecified */
2245 0, 0x2, 0x0 /* block length: 512 bytes */
2247 u8 pg, spg;
2248 unsigned int ebd, page_control, six_byte;
2249 u8 dpofua;
2251 VPRINTK("ENTER\n");
2253 six_byte = (scsicmd[0] == MODE_SENSE);
2254 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2256 * LLBA bit in msense(10) ignored (compliant)
2259 page_control = scsicmd[2] >> 6;
2260 switch (page_control) {
2261 case 0: /* current */
2262 break; /* supported */
2263 case 3: /* saved */
2264 goto saving_not_supp;
2265 case 1: /* changeable */
2266 case 2: /* defaults */
2267 default:
2268 goto invalid_fld;
2271 if (six_byte)
2272 p += 4 + (ebd ? 8 : 0);
2273 else
2274 p += 8 + (ebd ? 8 : 0);
2276 pg = scsicmd[2] & 0x3f;
2277 spg = scsicmd[3];
2279 * No mode subpages supported (yet) but asking for _all_
2280 * subpages may be valid
2282 if (spg && (spg != ALL_SUB_MPAGES))
2283 goto invalid_fld;
2285 switch(pg) {
2286 case RW_RECOVERY_MPAGE:
2287 p += ata_msense_rw_recovery(p);
2288 break;
2290 case CACHE_MPAGE:
2291 p += ata_msense_caching(args->id, p);
2292 break;
2294 case CONTROL_MPAGE:
2295 p += ata_msense_ctl_mode(p);
2296 break;
2298 case ALL_MPAGES:
2299 p += ata_msense_rw_recovery(p);
2300 p += ata_msense_caching(args->id, p);
2301 p += ata_msense_ctl_mode(p);
2302 break;
2304 default: /* invalid page code */
2305 goto invalid_fld;
2308 dpofua = 0;
2309 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2310 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2311 dpofua = 1 << 4;
2313 if (six_byte) {
2314 rbuf[0] = p - rbuf - 1;
2315 rbuf[2] |= dpofua;
2316 if (ebd) {
2317 rbuf[3] = sizeof(sat_blk_desc);
2318 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2320 } else {
2321 unsigned int output_len = p - rbuf - 2;
2323 rbuf[0] = output_len >> 8;
2324 rbuf[1] = output_len;
2325 rbuf[3] |= dpofua;
2326 if (ebd) {
2327 rbuf[7] = sizeof(sat_blk_desc);
2328 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2331 return 0;
2333 invalid_fld:
2334 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2335 /* "Invalid field in cbd" */
2336 return 1;
2338 saving_not_supp:
2339 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2340 /* "Saving parameters not supported" */
2341 return 1;
2345 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2346 * @args: device IDENTIFY data / SCSI command of interest.
2347 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2349 * Simulate READ CAPACITY commands.
2351 * LOCKING:
2352 * None.
2354 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2356 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2358 VPRINTK("ENTER\n");
2360 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2361 if (last_lba >= 0xffffffffULL)
2362 last_lba = 0xffffffff;
2364 /* sector count, 32-bit */
2365 rbuf[0] = last_lba >> (8 * 3);
2366 rbuf[1] = last_lba >> (8 * 2);
2367 rbuf[2] = last_lba >> (8 * 1);
2368 rbuf[3] = last_lba;
2370 /* sector size */
2371 rbuf[6] = ATA_SECT_SIZE >> 8;
2372 rbuf[7] = ATA_SECT_SIZE & 0xff;
2373 } else {
2374 /* sector count, 64-bit */
2375 rbuf[0] = last_lba >> (8 * 7);
2376 rbuf[1] = last_lba >> (8 * 6);
2377 rbuf[2] = last_lba >> (8 * 5);
2378 rbuf[3] = last_lba >> (8 * 4);
2379 rbuf[4] = last_lba >> (8 * 3);
2380 rbuf[5] = last_lba >> (8 * 2);
2381 rbuf[6] = last_lba >> (8 * 1);
2382 rbuf[7] = last_lba;
2384 /* sector size */
2385 rbuf[10] = ATA_SECT_SIZE >> 8;
2386 rbuf[11] = ATA_SECT_SIZE & 0xff;
2389 return 0;
2393 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2394 * @args: device IDENTIFY data / SCSI command of interest.
2395 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2397 * Simulate REPORT LUNS command.
2399 * LOCKING:
2400 * spin_lock_irqsave(host lock)
2402 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2404 VPRINTK("ENTER\n");
2405 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2407 return 0;
2410 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2412 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2413 /* FIXME: not quite right; we don't want the
2414 * translation of taskfile registers into
2415 * a sense descriptors, since that's only
2416 * correct for ATA, not ATAPI
2418 ata_gen_passthru_sense(qc);
2421 qc->scsidone(qc->scsicmd);
2422 ata_qc_free(qc);
2425 /* is it pointless to prefer PIO for "safety reasons"? */
2426 static inline int ata_pio_use_silly(struct ata_port *ap)
2428 return (ap->flags & ATA_FLAG_PIO_DMA);
2431 static void atapi_request_sense(struct ata_queued_cmd *qc)
2433 struct ata_port *ap = qc->ap;
2434 struct scsi_cmnd *cmd = qc->scsicmd;
2436 DPRINTK("ATAPI request sense\n");
2438 /* FIXME: is this needed? */
2439 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2441 #ifdef CONFIG_ATA_SFF
2442 if (ap->ops->sff_tf_read)
2443 ap->ops->sff_tf_read(ap, &qc->tf);
2444 #endif
2446 /* fill these in, for the case where they are -not- overwritten */
2447 cmd->sense_buffer[0] = 0x70;
2448 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2450 ata_qc_reinit(qc);
2452 /* setup sg table and init transfer direction */
2453 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2454 ata_sg_init(qc, &qc->sgent, 1);
2455 qc->dma_dir = DMA_FROM_DEVICE;
2457 memset(&qc->cdb, 0, qc->dev->cdb_len);
2458 qc->cdb[0] = REQUEST_SENSE;
2459 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2461 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2462 qc->tf.command = ATA_CMD_PACKET;
2464 if (ata_pio_use_silly(ap)) {
2465 qc->tf.protocol = ATAPI_PROT_DMA;
2466 qc->tf.feature |= ATAPI_PKT_DMA;
2467 } else {
2468 qc->tf.protocol = ATAPI_PROT_PIO;
2469 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2470 qc->tf.lbah = 0;
2472 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2474 qc->complete_fn = atapi_sense_complete;
2476 ata_qc_issue(qc);
2478 DPRINTK("EXIT\n");
2481 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2483 struct scsi_cmnd *cmd = qc->scsicmd;
2484 unsigned int err_mask = qc->err_mask;
2486 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2488 /* handle completion from new EH */
2489 if (unlikely(qc->ap->ops->error_handler &&
2490 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2492 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2493 /* FIXME: not quite right; we don't want the
2494 * translation of taskfile registers into a
2495 * sense descriptors, since that's only
2496 * correct for ATA, not ATAPI
2498 ata_gen_passthru_sense(qc);
2501 /* SCSI EH automatically locks door if sdev->locked is
2502 * set. Sometimes door lock request continues to
2503 * fail, for example, when no media is present. This
2504 * creates a loop - SCSI EH issues door lock which
2505 * fails and gets invoked again to acquire sense data
2506 * for the failed command.
2508 * If door lock fails, always clear sdev->locked to
2509 * avoid this infinite loop.
2511 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2512 qc->dev->sdev->locked = 0;
2514 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2515 qc->scsidone(cmd);
2516 ata_qc_free(qc);
2517 return;
2520 /* successful completion or old EH failure path */
2521 if (unlikely(err_mask & AC_ERR_DEV)) {
2522 cmd->result = SAM_STAT_CHECK_CONDITION;
2523 atapi_request_sense(qc);
2524 return;
2525 } else if (unlikely(err_mask)) {
2526 /* FIXME: not quite right; we don't want the
2527 * translation of taskfile registers into
2528 * a sense descriptors, since that's only
2529 * correct for ATA, not ATAPI
2531 ata_gen_passthru_sense(qc);
2532 } else {
2533 u8 *scsicmd = cmd->cmnd;
2535 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2536 unsigned long flags;
2537 u8 *buf;
2539 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2541 /* ATAPI devices typically report zero for their SCSI version,
2542 * and sometimes deviate from the spec WRT response data
2543 * format. If SCSI version is reported as zero like normal,
2544 * then we make the following fixups: 1) Fake MMC-5 version,
2545 * to indicate to the Linux scsi midlayer this is a modern
2546 * device. 2) Ensure response data format / ATAPI information
2547 * are always correct.
2549 if (buf[2] == 0) {
2550 buf[2] = 0x5;
2551 buf[3] = 0x32;
2554 ata_scsi_rbuf_put(cmd, true, &flags);
2557 cmd->result = SAM_STAT_GOOD;
2560 qc->scsidone(cmd);
2561 ata_qc_free(qc);
2564 * atapi_xlat - Initialize PACKET taskfile
2565 * @qc: command structure to be initialized
2567 * LOCKING:
2568 * spin_lock_irqsave(host lock)
2570 * RETURNS:
2571 * Zero on success, non-zero on failure.
2573 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2575 struct scsi_cmnd *scmd = qc->scsicmd;
2576 struct ata_device *dev = qc->dev;
2577 int nodata = (scmd->sc_data_direction == DMA_NONE);
2578 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2579 unsigned int nbytes;
2581 memset(qc->cdb, 0, dev->cdb_len);
2582 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2584 qc->complete_fn = atapi_qc_complete;
2586 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2587 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2588 qc->tf.flags |= ATA_TFLAG_WRITE;
2589 DPRINTK("direction: write\n");
2592 qc->tf.command = ATA_CMD_PACKET;
2593 ata_qc_set_pc_nbytes(qc);
2595 /* check whether ATAPI DMA is safe */
2596 if (!nodata && !using_pio && atapi_check_dma(qc))
2597 using_pio = 1;
2599 /* Some controller variants snoop this value for Packet
2600 * transfers to do state machine and FIFO management. Thus we
2601 * want to set it properly, and for DMA where it is
2602 * effectively meaningless.
2604 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2606 /* Most ATAPI devices which honor transfer chunk size don't
2607 * behave according to the spec when odd chunk size which
2608 * matches the transfer length is specified. If the number of
2609 * bytes to transfer is 2n+1. According to the spec, what
2610 * should happen is to indicate that 2n+1 is going to be
2611 * transferred and transfer 2n+2 bytes where the last byte is
2612 * padding.
2614 * In practice, this doesn't happen. ATAPI devices first
2615 * indicate and transfer 2n bytes and then indicate and
2616 * transfer 2 bytes where the last byte is padding.
2618 * This inconsistency confuses several controllers which
2619 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2620 * These controllers use actual number of transferred bytes to
2621 * update DMA poitner and transfer of 4n+2 bytes make those
2622 * controller push DMA pointer by 4n+4 bytes because SATA data
2623 * FISes are aligned to 4 bytes. This causes data corruption
2624 * and buffer overrun.
2626 * Always setting nbytes to even number solves this problem
2627 * because then ATAPI devices don't have to split data at 2n
2628 * boundaries.
2630 if (nbytes & 0x1)
2631 nbytes++;
2633 qc->tf.lbam = (nbytes & 0xFF);
2634 qc->tf.lbah = (nbytes >> 8);
2636 if (nodata)
2637 qc->tf.protocol = ATAPI_PROT_NODATA;
2638 else if (using_pio)
2639 qc->tf.protocol = ATAPI_PROT_PIO;
2640 else {
2641 /* DMA data xfer */
2642 qc->tf.protocol = ATAPI_PROT_DMA;
2643 qc->tf.feature |= ATAPI_PKT_DMA;
2645 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2646 (scmd->sc_data_direction != DMA_TO_DEVICE))
2647 /* some SATA bridges need us to indicate data xfer direction */
2648 qc->tf.feature |= ATAPI_DMADIR;
2652 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2653 as ATAPI tape drives don't get this right otherwise */
2654 return 0;
2657 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2659 if (!sata_pmp_attached(ap)) {
2660 if (likely(devno < ata_link_max_devices(&ap->link)))
2661 return &ap->link.device[devno];
2662 } else {
2663 if (likely(devno < ap->nr_pmp_links))
2664 return &ap->pmp_link[devno].device[0];
2667 return NULL;
2670 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2671 const struct scsi_device *scsidev)
2673 int devno;
2675 /* skip commands not addressed to targets we simulate */
2676 if (!sata_pmp_attached(ap)) {
2677 if (unlikely(scsidev->channel || scsidev->lun))
2678 return NULL;
2679 devno = scsidev->id;
2680 } else {
2681 if (unlikely(scsidev->id || scsidev->lun))
2682 return NULL;
2683 devno = scsidev->channel;
2686 return ata_find_dev(ap, devno);
2690 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2691 * @ap: ATA port to which the device is attached
2692 * @scsidev: SCSI device from which we derive the ATA device
2694 * Given various information provided in struct scsi_cmnd,
2695 * map that onto an ATA bus, and using that mapping
2696 * determine which ata_device is associated with the
2697 * SCSI command to be sent.
2699 * LOCKING:
2700 * spin_lock_irqsave(host lock)
2702 * RETURNS:
2703 * Associated ATA device, or %NULL if not found.
2705 static struct ata_device *
2706 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2708 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2710 if (unlikely(!dev || !ata_dev_enabled(dev)))
2711 return NULL;
2713 return dev;
2717 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2718 * @byte1: Byte 1 from pass-thru CDB.
2720 * RETURNS:
2721 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2723 static u8
2724 ata_scsi_map_proto(u8 byte1)
2726 switch((byte1 & 0x1e) >> 1) {
2727 case 3: /* Non-data */
2728 return ATA_PROT_NODATA;
2730 case 6: /* DMA */
2731 case 10: /* UDMA Data-in */
2732 case 11: /* UDMA Data-Out */
2733 return ATA_PROT_DMA;
2735 case 4: /* PIO Data-in */
2736 case 5: /* PIO Data-out */
2737 return ATA_PROT_PIO;
2739 case 0: /* Hard Reset */
2740 case 1: /* SRST */
2741 case 8: /* Device Diagnostic */
2742 case 9: /* Device Reset */
2743 case 7: /* DMA Queued */
2744 case 12: /* FPDMA */
2745 case 15: /* Return Response Info */
2746 default: /* Reserved */
2747 break;
2750 return ATA_PROT_UNKNOWN;
2754 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2755 * @qc: command structure to be initialized
2757 * Handles either 12 or 16-byte versions of the CDB.
2759 * RETURNS:
2760 * Zero on success, non-zero on failure.
2762 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2764 struct ata_taskfile *tf = &(qc->tf);
2765 struct scsi_cmnd *scmd = qc->scsicmd;
2766 struct ata_device *dev = qc->dev;
2767 const u8 *cdb = scmd->cmnd;
2769 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2770 goto invalid_fld;
2773 * Filter TPM commands by default. These provide an
2774 * essentially uncontrolled encrypted "back door" between
2775 * applications and the disk. Set libata.allow_tpm=1 if you
2776 * have a real reason for wanting to use them. This ensures
2777 * that installed software cannot easily mess stuff up without
2778 * user intent. DVR type users will probably ship with this enabled
2779 * for movie content management.
2781 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2782 * for this and should do in future but that it is not sufficient as
2783 * DCS is an optional feature set. Thus we also do the software filter
2784 * so that we comply with the TC consortium stated goal that the user
2785 * can turn off TC features of their system.
2787 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2788 goto invalid_fld;
2790 /* We may not issue DMA commands if no DMA mode is set */
2791 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2792 goto invalid_fld;
2795 * 12 and 16 byte CDBs use different offsets to
2796 * provide the various register values.
2798 if (cdb[0] == ATA_16) {
2800 * 16-byte CDB - may contain extended commands.
2802 * If that is the case, copy the upper byte register values.
2804 if (cdb[1] & 0x01) {
2805 tf->hob_feature = cdb[3];
2806 tf->hob_nsect = cdb[5];
2807 tf->hob_lbal = cdb[7];
2808 tf->hob_lbam = cdb[9];
2809 tf->hob_lbah = cdb[11];
2810 tf->flags |= ATA_TFLAG_LBA48;
2811 } else
2812 tf->flags &= ~ATA_TFLAG_LBA48;
2815 * Always copy low byte, device and command registers.
2817 tf->feature = cdb[4];
2818 tf->nsect = cdb[6];
2819 tf->lbal = cdb[8];
2820 tf->lbam = cdb[10];
2821 tf->lbah = cdb[12];
2822 tf->device = cdb[13];
2823 tf->command = cdb[14];
2824 } else {
2826 * 12-byte CDB - incapable of extended commands.
2828 tf->flags &= ~ATA_TFLAG_LBA48;
2830 tf->feature = cdb[3];
2831 tf->nsect = cdb[4];
2832 tf->lbal = cdb[5];
2833 tf->lbam = cdb[6];
2834 tf->lbah = cdb[7];
2835 tf->device = cdb[8];
2836 tf->command = cdb[9];
2839 /* enforce correct master/slave bit */
2840 tf->device = dev->devno ?
2841 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2843 /* sanity check for pio multi commands */
2844 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2845 goto invalid_fld;
2847 if (is_multi_taskfile(tf)) {
2848 unsigned int multi_count = 1 << (cdb[1] >> 5);
2850 /* compare the passed through multi_count
2851 * with the cached multi_count of libata
2853 if (multi_count != dev->multi_count)
2854 ata_dev_printk(dev, KERN_WARNING,
2855 "invalid multi_count %u ignored\n",
2856 multi_count);
2859 /* READ/WRITE LONG use a non-standard sect_size */
2860 qc->sect_size = ATA_SECT_SIZE;
2861 switch (tf->command) {
2862 case ATA_CMD_READ_LONG:
2863 case ATA_CMD_READ_LONG_ONCE:
2864 case ATA_CMD_WRITE_LONG:
2865 case ATA_CMD_WRITE_LONG_ONCE:
2866 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2867 goto invalid_fld;
2868 qc->sect_size = scsi_bufflen(scmd);
2872 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2873 * SET_FEATURES - XFER MODE must be preceded/succeeded
2874 * by an update to hardware-specific registers for each
2875 * controller (i.e. the reason for ->set_piomode(),
2876 * ->set_dmamode(), and ->post_set_mode() hooks).
2878 if ((tf->command == ATA_CMD_SET_FEATURES)
2879 && (tf->feature == SETFEATURES_XFER))
2880 goto invalid_fld;
2883 * Set flags so that all registers will be written,
2884 * and pass on write indication (used for PIO/DMA
2885 * setup.)
2887 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2889 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2890 tf->flags |= ATA_TFLAG_WRITE;
2893 * Set transfer length.
2895 * TODO: find out if we need to do more here to
2896 * cover scatter/gather case.
2898 ata_qc_set_pc_nbytes(qc);
2900 /* request result TF and be quiet about device error */
2901 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2903 return 0;
2905 invalid_fld:
2906 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2907 /* "Invalid field in cdb" */
2908 return 1;
2912 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2913 * @dev: ATA device
2914 * @cmd: SCSI command opcode to consider
2916 * Look up the SCSI command given, and determine whether the
2917 * SCSI command is to be translated or simulated.
2919 * RETURNS:
2920 * Pointer to translation function if possible, %NULL if not.
2923 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2925 switch (cmd) {
2926 case READ_6:
2927 case READ_10:
2928 case READ_16:
2930 case WRITE_6:
2931 case WRITE_10:
2932 case WRITE_16:
2933 return ata_scsi_rw_xlat;
2935 case SYNCHRONIZE_CACHE:
2936 if (ata_try_flush_cache(dev))
2937 return ata_scsi_flush_xlat;
2938 break;
2940 case VERIFY:
2941 case VERIFY_16:
2942 return ata_scsi_verify_xlat;
2944 case ATA_12:
2945 case ATA_16:
2946 return ata_scsi_pass_thru;
2948 case START_STOP:
2949 return ata_scsi_start_stop_xlat;
2952 return NULL;
2956 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2957 * @ap: ATA port to which the command was being sent
2958 * @cmd: SCSI command to dump
2960 * Prints the contents of a SCSI command via printk().
2963 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2964 struct scsi_cmnd *cmd)
2966 #ifdef ATA_DEBUG
2967 struct scsi_device *scsidev = cmd->device;
2968 u8 *scsicmd = cmd->cmnd;
2970 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2971 ap->print_id,
2972 scsidev->channel, scsidev->id, scsidev->lun,
2973 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2974 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2975 scsicmd[8]);
2976 #endif
2979 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2980 void (*done)(struct scsi_cmnd *),
2981 struct ata_device *dev)
2983 u8 scsi_op = scmd->cmnd[0];
2984 ata_xlat_func_t xlat_func;
2985 int rc = 0;
2987 if (dev->class == ATA_DEV_ATA) {
2988 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
2989 goto bad_cdb_len;
2991 xlat_func = ata_get_xlat_func(dev, scsi_op);
2992 } else {
2993 if (unlikely(!scmd->cmd_len))
2994 goto bad_cdb_len;
2996 xlat_func = NULL;
2997 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
2998 /* relay SCSI command to ATAPI device */
2999 int len = COMMAND_SIZE(scsi_op);
3000 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3001 goto bad_cdb_len;
3003 xlat_func = atapi_xlat;
3004 } else {
3005 /* ATA_16 passthru, treat as an ATA command */
3006 if (unlikely(scmd->cmd_len > 16))
3007 goto bad_cdb_len;
3009 xlat_func = ata_get_xlat_func(dev, scsi_op);
3013 if (xlat_func)
3014 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
3015 else
3016 ata_scsi_simulate(dev, scmd, done);
3018 return rc;
3020 bad_cdb_len:
3021 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3022 scmd->cmd_len, scsi_op, dev->cdb_len);
3023 scmd->result = DID_ERROR << 16;
3024 done(scmd);
3025 return 0;
3029 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3030 * @cmd: SCSI command to be sent
3031 * @done: Completion function, called when command is complete
3033 * In some cases, this function translates SCSI commands into
3034 * ATA taskfiles, and queues the taskfiles to be sent to
3035 * hardware. In other cases, this function simulates a
3036 * SCSI device by evaluating and responding to certain
3037 * SCSI commands. This creates the overall effect of
3038 * ATA and ATAPI devices appearing as SCSI devices.
3040 * LOCKING:
3041 * Releases scsi-layer-held lock, and obtains host lock.
3043 * RETURNS:
3044 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3045 * 0 otherwise.
3047 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3049 struct ata_port *ap;
3050 struct ata_device *dev;
3051 struct scsi_device *scsidev = cmd->device;
3052 struct Scsi_Host *shost = scsidev->host;
3053 int rc = 0;
3055 ap = ata_shost_to_port(shost);
3057 spin_unlock(shost->host_lock);
3058 spin_lock(ap->lock);
3060 ata_scsi_dump_cdb(ap, cmd);
3062 dev = ata_scsi_find_dev(ap, scsidev);
3063 if (likely(dev))
3064 rc = __ata_scsi_queuecmd(cmd, done, dev);
3065 else {
3066 cmd->result = (DID_BAD_TARGET << 16);
3067 done(cmd);
3070 spin_unlock(ap->lock);
3071 spin_lock(shost->host_lock);
3072 return rc;
3076 * ata_scsi_simulate - simulate SCSI command on ATA device
3077 * @dev: the target device
3078 * @cmd: SCSI command being sent to device.
3079 * @done: SCSI command completion function.
3081 * Interprets and directly executes a select list of SCSI commands
3082 * that can be handled internally.
3084 * LOCKING:
3085 * spin_lock_irqsave(host lock)
3088 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3089 void (*done)(struct scsi_cmnd *))
3091 struct ata_scsi_args args;
3092 const u8 *scsicmd = cmd->cmnd;
3093 u8 tmp8;
3095 args.dev = dev;
3096 args.id = dev->id;
3097 args.cmd = cmd;
3098 args.done = done;
3100 switch(scsicmd[0]) {
3101 /* TODO: worth improving? */
3102 case FORMAT_UNIT:
3103 ata_scsi_invalid_field(cmd, done);
3104 break;
3106 case INQUIRY:
3107 if (scsicmd[1] & 2) /* is CmdDt set? */
3108 ata_scsi_invalid_field(cmd, done);
3109 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3110 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3111 else switch (scsicmd[2]) {
3112 case 0x00:
3113 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3114 break;
3115 case 0x80:
3116 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3117 break;
3118 case 0x83:
3119 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3120 break;
3121 case 0x89:
3122 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3123 break;
3124 case 0xb1:
3125 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3126 break;
3127 default:
3128 ata_scsi_invalid_field(cmd, done);
3129 break;
3131 break;
3133 case MODE_SENSE:
3134 case MODE_SENSE_10:
3135 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3136 break;
3138 case MODE_SELECT: /* unconditionally return */
3139 case MODE_SELECT_10: /* bad-field-in-cdb */
3140 ata_scsi_invalid_field(cmd, done);
3141 break;
3143 case READ_CAPACITY:
3144 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3145 break;
3147 case SERVICE_ACTION_IN:
3148 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3149 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3150 else
3151 ata_scsi_invalid_field(cmd, done);
3152 break;
3154 case REPORT_LUNS:
3155 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3156 break;
3158 case REQUEST_SENSE:
3159 ata_scsi_set_sense(cmd, 0, 0, 0);
3160 cmd->result = (DRIVER_SENSE << 24);
3161 done(cmd);
3162 break;
3164 /* if we reach this, then writeback caching is disabled,
3165 * turning this into a no-op.
3167 case SYNCHRONIZE_CACHE:
3168 /* fall through */
3170 /* no-op's, complete with success */
3171 case REZERO_UNIT:
3172 case SEEK_6:
3173 case SEEK_10:
3174 case TEST_UNIT_READY:
3175 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3176 break;
3178 case SEND_DIAGNOSTIC:
3179 tmp8 = scsicmd[1] & ~(1 << 3);
3180 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3181 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3182 else
3183 ata_scsi_invalid_field(cmd, done);
3184 break;
3186 /* all other commands */
3187 default:
3188 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3189 /* "Invalid command operation code" */
3190 done(cmd);
3191 break;
3195 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3197 int i, rc;
3199 for (i = 0; i < host->n_ports; i++) {
3200 struct ata_port *ap = host->ports[i];
3201 struct Scsi_Host *shost;
3203 rc = -ENOMEM;
3204 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3205 if (!shost)
3206 goto err_alloc;
3208 *(struct ata_port **)&shost->hostdata[0] = ap;
3209 ap->scsi_host = shost;
3211 shost->transportt = &ata_scsi_transport_template;
3212 shost->unique_id = ap->print_id;
3213 shost->max_id = 16;
3214 shost->max_lun = 1;
3215 shost->max_channel = 1;
3216 shost->max_cmd_len = 16;
3218 /* Schedule policy is determined by ->qc_defer()
3219 * callback and it needs to see every deferred qc.
3220 * Set host_blocked to 1 to prevent SCSI midlayer from
3221 * automatically deferring requests.
3223 shost->max_host_blocked = 1;
3225 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3226 if (rc)
3227 goto err_add;
3230 return 0;
3232 err_add:
3233 scsi_host_put(host->ports[i]->scsi_host);
3234 err_alloc:
3235 while (--i >= 0) {
3236 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3238 scsi_remove_host(shost);
3239 scsi_host_put(shost);
3241 return rc;
3244 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3246 int tries = 5;
3247 struct ata_device *last_failed_dev = NULL;
3248 struct ata_link *link;
3249 struct ata_device *dev;
3251 if (ap->flags & ATA_FLAG_DISABLED)
3252 return;
3254 repeat:
3255 ata_for_each_link(link, ap, EDGE) {
3256 ata_for_each_dev(dev, link, ENABLED) {
3257 struct scsi_device *sdev;
3258 int channel = 0, id = 0;
3260 if (dev->sdev)
3261 continue;
3263 if (ata_is_host_link(link))
3264 id = dev->devno;
3265 else
3266 channel = link->pmp;
3268 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3269 NULL);
3270 if (!IS_ERR(sdev)) {
3271 dev->sdev = sdev;
3272 scsi_device_put(sdev);
3277 /* If we scanned while EH was in progress or allocation
3278 * failure occurred, scan would have failed silently. Check
3279 * whether all devices are attached.
3281 ata_for_each_link(link, ap, EDGE) {
3282 ata_for_each_dev(dev, link, ENABLED) {
3283 if (!dev->sdev)
3284 goto exit_loop;
3287 exit_loop:
3288 if (!link)
3289 return;
3291 /* we're missing some SCSI devices */
3292 if (sync) {
3293 /* If caller requested synchrnous scan && we've made
3294 * any progress, sleep briefly and repeat.
3296 if (dev != last_failed_dev) {
3297 msleep(100);
3298 last_failed_dev = dev;
3299 goto repeat;
3302 /* We might be failing to detect boot device, give it
3303 * a few more chances.
3305 if (--tries) {
3306 msleep(100);
3307 goto repeat;
3310 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3311 "failed without making any progress,\n"
3312 " switching to async\n");
3315 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3316 round_jiffies_relative(HZ));
3320 * ata_scsi_offline_dev - offline attached SCSI device
3321 * @dev: ATA device to offline attached SCSI device for
3323 * This function is called from ata_eh_hotplug() and responsible
3324 * for taking the SCSI device attached to @dev offline. This
3325 * function is called with host lock which protects dev->sdev
3326 * against clearing.
3328 * LOCKING:
3329 * spin_lock_irqsave(host lock)
3331 * RETURNS:
3332 * 1 if attached SCSI device exists, 0 otherwise.
3334 int ata_scsi_offline_dev(struct ata_device *dev)
3336 if (dev->sdev) {
3337 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3338 return 1;
3340 return 0;
3344 * ata_scsi_remove_dev - remove attached SCSI device
3345 * @dev: ATA device to remove attached SCSI device for
3347 * This function is called from ata_eh_scsi_hotplug() and
3348 * responsible for removing the SCSI device attached to @dev.
3350 * LOCKING:
3351 * Kernel thread context (may sleep).
3353 static void ata_scsi_remove_dev(struct ata_device *dev)
3355 struct ata_port *ap = dev->link->ap;
3356 struct scsi_device *sdev;
3357 unsigned long flags;
3359 /* Alas, we need to grab scan_mutex to ensure SCSI device
3360 * state doesn't change underneath us and thus
3361 * scsi_device_get() always succeeds. The mutex locking can
3362 * be removed if there is __scsi_device_get() interface which
3363 * increments reference counts regardless of device state.
3365 mutex_lock(&ap->scsi_host->scan_mutex);
3366 spin_lock_irqsave(ap->lock, flags);
3368 /* clearing dev->sdev is protected by host lock */
3369 sdev = dev->sdev;
3370 dev->sdev = NULL;
3372 if (sdev) {
3373 /* If user initiated unplug races with us, sdev can go
3374 * away underneath us after the host lock and
3375 * scan_mutex are released. Hold onto it.
3377 if (scsi_device_get(sdev) == 0) {
3378 /* The following ensures the attached sdev is
3379 * offline on return from ata_scsi_offline_dev()
3380 * regardless it wins or loses the race
3381 * against this function.
3383 scsi_device_set_state(sdev, SDEV_OFFLINE);
3384 } else {
3385 WARN_ON(1);
3386 sdev = NULL;
3390 spin_unlock_irqrestore(ap->lock, flags);
3391 mutex_unlock(&ap->scsi_host->scan_mutex);
3393 if (sdev) {
3394 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3395 dev_name(&sdev->sdev_gendev));
3397 scsi_remove_device(sdev);
3398 scsi_device_put(sdev);
3402 static void ata_scsi_handle_link_detach(struct ata_link *link)
3404 struct ata_port *ap = link->ap;
3405 struct ata_device *dev;
3407 ata_for_each_dev(dev, link, ALL) {
3408 unsigned long flags;
3410 if (!(dev->flags & ATA_DFLAG_DETACHED))
3411 continue;
3413 spin_lock_irqsave(ap->lock, flags);
3414 dev->flags &= ~ATA_DFLAG_DETACHED;
3415 spin_unlock_irqrestore(ap->lock, flags);
3417 ata_scsi_remove_dev(dev);
3422 * ata_scsi_media_change_notify - send media change event
3423 * @dev: Pointer to the disk device with media change event
3425 * Tell the block layer to send a media change notification
3426 * event.
3428 * LOCKING:
3429 * spin_lock_irqsave(host lock)
3431 void ata_scsi_media_change_notify(struct ata_device *dev)
3433 if (dev->sdev)
3434 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3435 GFP_ATOMIC);
3439 * ata_scsi_hotplug - SCSI part of hotplug
3440 * @work: Pointer to ATA port to perform SCSI hotplug on
3442 * Perform SCSI part of hotplug. It's executed from a separate
3443 * workqueue after EH completes. This is necessary because SCSI
3444 * hot plugging requires working EH and hot unplugging is
3445 * synchronized with hot plugging with a mutex.
3447 * LOCKING:
3448 * Kernel thread context (may sleep).
3450 void ata_scsi_hotplug(struct work_struct *work)
3452 struct ata_port *ap =
3453 container_of(work, struct ata_port, hotplug_task.work);
3454 int i;
3456 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3457 DPRINTK("ENTER/EXIT - unloading\n");
3458 return;
3461 DPRINTK("ENTER\n");
3463 /* Unplug detached devices. We cannot use link iterator here
3464 * because PMP links have to be scanned even if PMP is
3465 * currently not attached. Iterate manually.
3467 ata_scsi_handle_link_detach(&ap->link);
3468 if (ap->pmp_link)
3469 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3470 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3472 /* scan for new ones */
3473 ata_scsi_scan_host(ap, 0);
3475 DPRINTK("EXIT\n");
3479 * ata_scsi_user_scan - indication for user-initiated bus scan
3480 * @shost: SCSI host to scan
3481 * @channel: Channel to scan
3482 * @id: ID to scan
3483 * @lun: LUN to scan
3485 * This function is called when user explicitly requests bus
3486 * scan. Set probe pending flag and invoke EH.
3488 * LOCKING:
3489 * SCSI layer (we don't care)
3491 * RETURNS:
3492 * Zero.
3494 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3495 unsigned int id, unsigned int lun)
3497 struct ata_port *ap = ata_shost_to_port(shost);
3498 unsigned long flags;
3499 int devno, rc = 0;
3501 if (!ap->ops->error_handler)
3502 return -EOPNOTSUPP;
3504 if (lun != SCAN_WILD_CARD && lun)
3505 return -EINVAL;
3507 if (!sata_pmp_attached(ap)) {
3508 if (channel != SCAN_WILD_CARD && channel)
3509 return -EINVAL;
3510 devno = id;
3511 } else {
3512 if (id != SCAN_WILD_CARD && id)
3513 return -EINVAL;
3514 devno = channel;
3517 spin_lock_irqsave(ap->lock, flags);
3519 if (devno == SCAN_WILD_CARD) {
3520 struct ata_link *link;
3522 ata_for_each_link(link, ap, EDGE) {
3523 struct ata_eh_info *ehi = &link->eh_info;
3524 ehi->probe_mask |= ATA_ALL_DEVICES;
3525 ehi->action |= ATA_EH_RESET;
3527 } else {
3528 struct ata_device *dev = ata_find_dev(ap, devno);
3530 if (dev) {
3531 struct ata_eh_info *ehi = &dev->link->eh_info;
3532 ehi->probe_mask |= 1 << dev->devno;
3533 ehi->action |= ATA_EH_RESET;
3534 } else
3535 rc = -EINVAL;
3538 if (rc == 0) {
3539 ata_port_schedule_eh(ap);
3540 spin_unlock_irqrestore(ap->lock, flags);
3541 ata_port_wait_eh(ap);
3542 } else
3543 spin_unlock_irqrestore(ap->lock, flags);
3545 return rc;
3549 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3550 * @work: Pointer to ATA port to perform scsi_rescan_device()
3552 * After ATA pass thru (SAT) commands are executed successfully,
3553 * libata need to propagate the changes to SCSI layer. This
3554 * function must be executed from ata_aux_wq such that sdev
3555 * attach/detach don't race with rescan.
3557 * LOCKING:
3558 * Kernel thread context (may sleep).
3560 void ata_scsi_dev_rescan(struct work_struct *work)
3562 struct ata_port *ap =
3563 container_of(work, struct ata_port, scsi_rescan_task);
3564 struct ata_link *link;
3565 struct ata_device *dev;
3566 unsigned long flags;
3568 spin_lock_irqsave(ap->lock, flags);
3570 ata_for_each_link(link, ap, EDGE) {
3571 ata_for_each_dev(dev, link, ENABLED) {
3572 struct scsi_device *sdev = dev->sdev;
3574 if (!sdev)
3575 continue;
3576 if (scsi_device_get(sdev))
3577 continue;
3579 spin_unlock_irqrestore(ap->lock, flags);
3580 scsi_rescan_device(&(sdev->sdev_gendev));
3581 scsi_device_put(sdev);
3582 spin_lock_irqsave(ap->lock, flags);
3586 spin_unlock_irqrestore(ap->lock, flags);
3590 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3591 * @host: ATA host container for all SAS ports
3592 * @port_info: Information from low-level host driver
3593 * @shost: SCSI host that the scsi device is attached to
3595 * LOCKING:
3596 * PCI/etc. bus probe sem.
3598 * RETURNS:
3599 * ata_port pointer on success / NULL on failure.
3602 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3603 struct ata_port_info *port_info,
3604 struct Scsi_Host *shost)
3606 struct ata_port *ap;
3608 ap = ata_port_alloc(host);
3609 if (!ap)
3610 return NULL;
3612 ap->port_no = 0;
3613 ap->lock = shost->host_lock;
3614 ap->pio_mask = port_info->pio_mask;
3615 ap->mwdma_mask = port_info->mwdma_mask;
3616 ap->udma_mask = port_info->udma_mask;
3617 ap->flags |= port_info->flags;
3618 ap->ops = port_info->port_ops;
3619 ap->cbl = ATA_CBL_SATA;
3621 return ap;
3623 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3626 * ata_sas_port_start - Set port up for dma.
3627 * @ap: Port to initialize
3629 * Called just after data structures for each port are
3630 * initialized.
3632 * May be used as the port_start() entry in ata_port_operations.
3634 * LOCKING:
3635 * Inherited from caller.
3637 int ata_sas_port_start(struct ata_port *ap)
3639 return 0;
3641 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3644 * ata_port_stop - Undo ata_sas_port_start()
3645 * @ap: Port to shut down
3647 * May be used as the port_stop() entry in ata_port_operations.
3649 * LOCKING:
3650 * Inherited from caller.
3653 void ata_sas_port_stop(struct ata_port *ap)
3656 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3659 * ata_sas_port_init - Initialize a SATA device
3660 * @ap: SATA port to initialize
3662 * LOCKING:
3663 * PCI/etc. bus probe sem.
3665 * RETURNS:
3666 * Zero on success, non-zero on error.
3669 int ata_sas_port_init(struct ata_port *ap)
3671 int rc = ap->ops->port_start(ap);
3673 if (!rc) {
3674 ap->print_id = ata_print_id++;
3675 rc = ata_bus_probe(ap);
3678 return rc;
3680 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3683 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3684 * @ap: SATA port to destroy
3688 void ata_sas_port_destroy(struct ata_port *ap)
3690 if (ap->ops->port_stop)
3691 ap->ops->port_stop(ap);
3692 kfree(ap);
3694 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3697 * ata_sas_slave_configure - Default slave_config routine for libata devices
3698 * @sdev: SCSI device to configure
3699 * @ap: ATA port to which SCSI device is attached
3701 * RETURNS:
3702 * Zero.
3705 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3707 ata_scsi_sdev_config(sdev);
3708 ata_scsi_dev_config(sdev, ap->link.device);
3709 return 0;
3711 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3714 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3715 * @cmd: SCSI command to be sent
3716 * @done: Completion function, called when command is complete
3717 * @ap: ATA port to which the command is being sent
3719 * RETURNS:
3720 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3721 * 0 otherwise.
3724 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3725 struct ata_port *ap)
3727 int rc = 0;
3729 ata_scsi_dump_cdb(ap, cmd);
3731 if (likely(ata_dev_enabled(ap->link.device)))
3732 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3733 else {
3734 cmd->result = (DID_BAD_TARGET << 16);
3735 done(cmd);
3737 return rc;
3739 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);