Merge commit '9f4c899c0d90e1b51b6864834f3877b47c161a0e' into devel
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / ata / libata-scsi.c
blobb9747fa59e542866e4659c6648d2f448beb9f9a7
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 * @ap: target port
419 * @sdev: SCSI device to get identify data for
420 * @arg: User buffer area for identify data
422 * LOCKING:
423 * Defined by the SCSI layer. We don't really care.
425 * RETURNS:
426 * Zero on success, negative errno on error.
428 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
429 void __user *arg)
431 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
432 u16 __user *dst = arg;
433 char buf[40];
435 if (!dev)
436 return -ENOMSG;
438 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
439 return -EFAULT;
441 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
442 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
443 return -EFAULT;
445 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
446 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
447 return -EFAULT;
449 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
450 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
451 return -EFAULT;
453 return 0;
457 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
458 * @scsidev: Device to which we are issuing command
459 * @arg: User provided data for issuing command
461 * LOCKING:
462 * Defined by the SCSI layer. We don't really care.
464 * RETURNS:
465 * Zero on success, negative errno on error.
467 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
469 int rc = 0;
470 u8 scsi_cmd[MAX_COMMAND_SIZE];
471 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
472 int argsize = 0;
473 enum dma_data_direction data_dir;
474 int cmd_result;
476 if (arg == NULL)
477 return -EINVAL;
479 if (copy_from_user(args, arg, sizeof(args)))
480 return -EFAULT;
482 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
483 if (!sensebuf)
484 return -ENOMEM;
486 memset(scsi_cmd, 0, sizeof(scsi_cmd));
488 if (args[3]) {
489 argsize = SECTOR_SIZE * args[3];
490 argbuf = kmalloc(argsize, GFP_KERNEL);
491 if (argbuf == NULL) {
492 rc = -ENOMEM;
493 goto error;
496 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
497 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
498 block count in sector count field */
499 data_dir = DMA_FROM_DEVICE;
500 } else {
501 scsi_cmd[1] = (3 << 1); /* Non-data */
502 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
503 data_dir = DMA_NONE;
506 scsi_cmd[0] = ATA_16;
508 scsi_cmd[4] = args[2];
509 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
510 scsi_cmd[6] = args[3];
511 scsi_cmd[8] = args[1];
512 scsi_cmd[10] = 0x4f;
513 scsi_cmd[12] = 0xc2;
514 } else {
515 scsi_cmd[6] = args[1];
517 scsi_cmd[14] = args[0];
519 /* Good values for timeout and retries? Values below
520 from scsi_ioctl_send_command() for default case... */
521 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
522 sensebuf, (10*HZ), 5, 0, NULL);
524 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
525 u8 *desc = sensebuf + 8;
526 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
528 /* If we set cc then ATA pass-through will cause a
529 * check condition even if no error. Filter that. */
530 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
531 struct scsi_sense_hdr sshdr;
532 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
533 &sshdr);
534 if (sshdr.sense_key == 0 &&
535 sshdr.asc == 0 && sshdr.ascq == 0)
536 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
539 /* Send userspace a few ATA registers (same as drivers/ide) */
540 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
541 desc[0] == 0x09) { /* code is "ATA Descriptor" */
542 args[0] = desc[13]; /* status */
543 args[1] = desc[3]; /* error */
544 args[2] = desc[5]; /* sector count (0:7) */
545 if (copy_to_user(arg, args, sizeof(args)))
546 rc = -EFAULT;
551 if (cmd_result) {
552 rc = -EIO;
553 goto error;
556 if ((argbuf)
557 && copy_to_user(arg + sizeof(args), argbuf, argsize))
558 rc = -EFAULT;
559 error:
560 kfree(sensebuf);
561 kfree(argbuf);
562 return rc;
566 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
567 * @scsidev: Device to which we are issuing command
568 * @arg: User provided data for issuing command
570 * LOCKING:
571 * Defined by the SCSI layer. We don't really care.
573 * RETURNS:
574 * Zero on success, negative errno on error.
576 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
578 int rc = 0;
579 u8 scsi_cmd[MAX_COMMAND_SIZE];
580 u8 args[7], *sensebuf = NULL;
581 int cmd_result;
583 if (arg == NULL)
584 return -EINVAL;
586 if (copy_from_user(args, arg, sizeof(args)))
587 return -EFAULT;
589 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
590 if (!sensebuf)
591 return -ENOMEM;
593 memset(scsi_cmd, 0, sizeof(scsi_cmd));
594 scsi_cmd[0] = ATA_16;
595 scsi_cmd[1] = (3 << 1); /* Non-data */
596 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
597 scsi_cmd[4] = args[1];
598 scsi_cmd[6] = args[2];
599 scsi_cmd[8] = args[3];
600 scsi_cmd[10] = args[4];
601 scsi_cmd[12] = args[5];
602 scsi_cmd[13] = args[6] & 0x4f;
603 scsi_cmd[14] = args[0];
605 /* Good values for timeout and retries? Values below
606 from scsi_ioctl_send_command() for default case... */
607 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
608 sensebuf, (10*HZ), 5, 0, NULL);
610 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
611 u8 *desc = sensebuf + 8;
612 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
614 /* If we set cc then ATA pass-through will cause a
615 * check condition even if no error. Filter that. */
616 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
617 struct scsi_sense_hdr sshdr;
618 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
619 &sshdr);
620 if (sshdr.sense_key == 0 &&
621 sshdr.asc == 0 && sshdr.ascq == 0)
622 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
625 /* Send userspace ATA registers */
626 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
627 desc[0] == 0x09) {/* code is "ATA Descriptor" */
628 args[0] = desc[13]; /* status */
629 args[1] = desc[3]; /* error */
630 args[2] = desc[5]; /* sector count (0:7) */
631 args[3] = desc[7]; /* lbal */
632 args[4] = desc[9]; /* lbam */
633 args[5] = desc[11]; /* lbah */
634 args[6] = desc[12]; /* select */
635 if (copy_to_user(arg, args, sizeof(args)))
636 rc = -EFAULT;
640 if (cmd_result) {
641 rc = -EIO;
642 goto error;
645 error:
646 kfree(sensebuf);
647 return rc;
650 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
651 int cmd, void __user *arg)
653 int val = -EINVAL, rc = -EINVAL;
655 switch (cmd) {
656 case ATA_IOC_GET_IO32:
657 val = 0;
658 if (copy_to_user(arg, &val, 1))
659 return -EFAULT;
660 return 0;
662 case ATA_IOC_SET_IO32:
663 val = (unsigned long) arg;
664 if (val != 0)
665 return -EINVAL;
666 return 0;
668 case HDIO_GET_IDENTITY:
669 return ata_get_identity(ap, scsidev, arg);
671 case HDIO_DRIVE_CMD:
672 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
673 return -EACCES;
674 return ata_cmd_ioctl(scsidev, arg);
676 case HDIO_DRIVE_TASK:
677 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
678 return -EACCES;
679 return ata_task_ioctl(scsidev, arg);
681 default:
682 rc = -ENOTTY;
683 break;
686 return rc;
688 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
690 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
692 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
693 scsidev, cmd, arg);
695 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
698 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
699 * @dev: ATA device to which the new command is attached
700 * @cmd: SCSI command that originated this ATA command
701 * @done: SCSI command completion function
703 * Obtain a reference to an unused ata_queued_cmd structure,
704 * which is the basic libata structure representing a single
705 * ATA command sent to the hardware.
707 * If a command was available, fill in the SCSI-specific
708 * portions of the structure with information on the
709 * current command.
711 * LOCKING:
712 * spin_lock_irqsave(host lock)
714 * RETURNS:
715 * Command allocated, or %NULL if none available.
717 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
718 struct scsi_cmnd *cmd,
719 void (*done)(struct scsi_cmnd *))
721 struct ata_queued_cmd *qc;
723 qc = ata_qc_new_init(dev);
724 if (qc) {
725 qc->scsicmd = cmd;
726 qc->scsidone = done;
728 qc->sg = scsi_sglist(cmd);
729 qc->n_elem = scsi_sg_count(cmd);
730 } else {
731 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
732 done(cmd);
735 return qc;
738 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
740 struct scsi_cmnd *scmd = qc->scsicmd;
742 qc->extrabytes = scmd->request->extra_len;
743 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
747 * ata_dump_status - user friendly display of error info
748 * @id: id of the port in question
749 * @tf: ptr to filled out taskfile
751 * Decode and dump the ATA error/status registers for the user so
752 * that they have some idea what really happened at the non
753 * make-believe layer.
755 * LOCKING:
756 * inherited from caller
758 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
760 u8 stat = tf->command, err = tf->feature;
762 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
763 if (stat & ATA_BUSY) {
764 printk("Busy }\n"); /* Data is not valid in this case */
765 } else {
766 if (stat & 0x40) printk("DriveReady ");
767 if (stat & 0x20) printk("DeviceFault ");
768 if (stat & 0x10) printk("SeekComplete ");
769 if (stat & 0x08) printk("DataRequest ");
770 if (stat & 0x04) printk("CorrectedError ");
771 if (stat & 0x02) printk("Index ");
772 if (stat & 0x01) printk("Error ");
773 printk("}\n");
775 if (err) {
776 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
777 if (err & 0x04) printk("DriveStatusError ");
778 if (err & 0x80) {
779 if (err & 0x04) printk("BadCRC ");
780 else printk("Sector ");
782 if (err & 0x40) printk("UncorrectableError ");
783 if (err & 0x10) printk("SectorIdNotFound ");
784 if (err & 0x02) printk("TrackZeroNotFound ");
785 if (err & 0x01) printk("AddrMarkNotFound ");
786 printk("}\n");
792 * ata_to_sense_error - convert ATA error to SCSI error
793 * @id: ATA device number
794 * @drv_stat: value contained in ATA status register
795 * @drv_err: value contained in ATA error register
796 * @sk: the sense key we'll fill out
797 * @asc: the additional sense code we'll fill out
798 * @ascq: the additional sense code qualifier we'll fill out
799 * @verbose: be verbose
801 * Converts an ATA error into a SCSI error. Fill out pointers to
802 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
803 * format sense blocks.
805 * LOCKING:
806 * spin_lock_irqsave(host lock)
808 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
809 u8 *asc, u8 *ascq, int verbose)
811 int i;
813 /* Based on the 3ware driver translation table */
814 static const unsigned char sense_table[][4] = {
815 /* BBD|ECC|ID|MAR */
816 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
817 /* BBD|ECC|ID */
818 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
819 /* ECC|MC|MARK */
820 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
821 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
822 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
823 /* MC|ID|ABRT|TRK0|MARK */
824 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
825 /* MCR|MARK */
826 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
827 /* Bad address mark */
828 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
829 /* TRK0 */
830 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
831 /* Abort & !ICRC */
832 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
833 /* Media change request */
834 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
835 /* SRV */
836 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
837 /* Media change */
838 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
839 /* ECC */
840 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
841 /* BBD - block marked bad */
842 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
843 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
845 static const unsigned char stat_table[][4] = {
846 /* Must be first because BUSY means no other bits valid */
847 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
848 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
849 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
850 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
851 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
855 * Is this an error we can process/parse
857 if (drv_stat & ATA_BUSY) {
858 drv_err = 0; /* Ignore the err bits, they're invalid */
861 if (drv_err) {
862 /* Look for drv_err */
863 for (i = 0; sense_table[i][0] != 0xFF; i++) {
864 /* Look for best matches first */
865 if ((sense_table[i][0] & drv_err) ==
866 sense_table[i][0]) {
867 *sk = sense_table[i][1];
868 *asc = sense_table[i][2];
869 *ascq = sense_table[i][3];
870 goto translate_done;
873 /* No immediate match */
874 if (verbose)
875 printk(KERN_WARNING "ata%u: no sense translation for "
876 "error 0x%02x\n", id, drv_err);
879 /* Fall back to interpreting status bits */
880 for (i = 0; stat_table[i][0] != 0xFF; i++) {
881 if (stat_table[i][0] & drv_stat) {
882 *sk = stat_table[i][1];
883 *asc = stat_table[i][2];
884 *ascq = stat_table[i][3];
885 goto translate_done;
888 /* No error? Undecoded? */
889 if (verbose)
890 printk(KERN_WARNING "ata%u: no sense translation for "
891 "status: 0x%02x\n", id, drv_stat);
893 /* We need a sensible error return here, which is tricky, and one
894 that won't cause people to do things like return a disk wrongly */
895 *sk = ABORTED_COMMAND;
896 *asc = 0x00;
897 *ascq = 0x00;
899 translate_done:
900 if (verbose)
901 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
902 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
903 id, drv_stat, drv_err, *sk, *asc, *ascq);
904 return;
908 * ata_gen_passthru_sense - Generate check condition sense block.
909 * @qc: Command that completed.
911 * This function is specific to the ATA descriptor format sense
912 * block specified for the ATA pass through commands. Regardless
913 * of whether the command errored or not, return a sense
914 * block. Copy all controller registers into the sense
915 * block. Clear sense key, ASC & ASCQ if there is no error.
917 * LOCKING:
918 * None.
920 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
922 struct scsi_cmnd *cmd = qc->scsicmd;
923 struct ata_taskfile *tf = &qc->result_tf;
924 unsigned char *sb = cmd->sense_buffer;
925 unsigned char *desc = sb + 8;
926 int verbose = qc->ap->ops->error_handler == NULL;
928 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
930 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
933 * Use ata_to_sense_error() to map status register bits
934 * onto sense key, asc & ascq.
936 if (qc->err_mask ||
937 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
938 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
939 &sb[1], &sb[2], &sb[3], verbose);
940 sb[1] &= 0x0f;
944 * Sense data is current and format is descriptor.
946 sb[0] = 0x72;
948 desc[0] = 0x09;
950 /* set length of additional sense data */
951 sb[7] = 14;
952 desc[1] = 12;
955 * Copy registers into sense buffer.
957 desc[2] = 0x00;
958 desc[3] = tf->feature; /* == error reg */
959 desc[5] = tf->nsect;
960 desc[7] = tf->lbal;
961 desc[9] = tf->lbam;
962 desc[11] = tf->lbah;
963 desc[12] = tf->device;
964 desc[13] = tf->command; /* == status reg */
967 * Fill in Extend bit, and the high order bytes
968 * if applicable.
970 if (tf->flags & ATA_TFLAG_LBA48) {
971 desc[2] |= 0x01;
972 desc[4] = tf->hob_nsect;
973 desc[6] = tf->hob_lbal;
974 desc[8] = tf->hob_lbam;
975 desc[10] = tf->hob_lbah;
980 * ata_gen_ata_sense - generate a SCSI fixed sense block
981 * @qc: Command that we are erroring out
983 * Generate sense block for a failed ATA command @qc. Descriptor
984 * format is used to accomodate LBA48 block address.
986 * LOCKING:
987 * None.
989 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
991 struct ata_device *dev = qc->dev;
992 struct scsi_cmnd *cmd = qc->scsicmd;
993 struct ata_taskfile *tf = &qc->result_tf;
994 unsigned char *sb = cmd->sense_buffer;
995 unsigned char *desc = sb + 8;
996 int verbose = qc->ap->ops->error_handler == NULL;
997 u64 block;
999 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1001 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1003 /* sense data is current and format is descriptor */
1004 sb[0] = 0x72;
1006 /* Use ata_to_sense_error() to map status register bits
1007 * onto sense key, asc & ascq.
1009 if (qc->err_mask ||
1010 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1011 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1012 &sb[1], &sb[2], &sb[3], verbose);
1013 sb[1] &= 0x0f;
1016 block = ata_tf_read_block(&qc->result_tf, dev);
1018 /* information sense data descriptor */
1019 sb[7] = 12;
1020 desc[0] = 0x00;
1021 desc[1] = 10;
1023 desc[2] |= 0x80; /* valid */
1024 desc[6] = block >> 40;
1025 desc[7] = block >> 32;
1026 desc[8] = block >> 24;
1027 desc[9] = block >> 16;
1028 desc[10] = block >> 8;
1029 desc[11] = block;
1032 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1034 sdev->use_10_for_rw = 1;
1035 sdev->use_10_for_ms = 1;
1037 /* Schedule policy is determined by ->qc_defer() callback and
1038 * it needs to see every deferred qc. Set dev_blocked to 1 to
1039 * prevent SCSI midlayer from automatically deferring
1040 * requests.
1042 sdev->max_device_blocked = 1;
1046 * atapi_drain_needed - Check whether data transfer may overflow
1047 * @rq: request to be checked
1049 * ATAPI commands which transfer variable length data to host
1050 * might overflow due to application error or hardare bug. This
1051 * function checks whether overflow should be drained and ignored
1052 * for @request.
1054 * LOCKING:
1055 * None.
1057 * RETURNS:
1058 * 1 if ; otherwise, 0.
1060 static int atapi_drain_needed(struct request *rq)
1062 if (likely(!blk_pc_request(rq)))
1063 return 0;
1065 if (!rq->data_len || (rq->cmd_flags & REQ_RW))
1066 return 0;
1068 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1071 static int ata_scsi_dev_config(struct scsi_device *sdev,
1072 struct ata_device *dev)
1074 if (!ata_id_has_unload(dev->id))
1075 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1077 /* configure max sectors */
1078 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
1080 if (dev->class == ATA_DEV_ATAPI) {
1081 struct request_queue *q = sdev->request_queue;
1082 void *buf;
1084 /* set the min alignment and padding */
1085 blk_queue_update_dma_alignment(sdev->request_queue,
1086 ATA_DMA_PAD_SZ - 1);
1087 blk_queue_update_dma_pad(sdev->request_queue,
1088 ATA_DMA_PAD_SZ - 1);
1090 /* configure draining */
1091 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1092 if (!buf) {
1093 ata_dev_printk(dev, KERN_ERR,
1094 "drain buffer allocation failed\n");
1095 return -ENOMEM;
1098 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1099 } else {
1100 if (ata_id_is_ssd(dev->id))
1101 queue_flag_set_unlocked(QUEUE_FLAG_NONROT,
1102 sdev->request_queue);
1104 /* ATA devices must be sector aligned */
1105 blk_queue_update_dma_alignment(sdev->request_queue,
1106 ATA_SECT_SIZE - 1);
1107 sdev->manage_start_stop = 1;
1110 if (dev->flags & ATA_DFLAG_AN)
1111 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1113 if (dev->flags & ATA_DFLAG_NCQ) {
1114 int depth;
1116 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1117 depth = min(ATA_MAX_QUEUE - 1, depth);
1118 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1121 return 0;
1125 * ata_scsi_slave_config - Set SCSI device attributes
1126 * @sdev: SCSI device to examine
1128 * This is called before we actually start reading
1129 * and writing to the device, to configure certain
1130 * SCSI mid-layer behaviors.
1132 * LOCKING:
1133 * Defined by SCSI layer. We don't really care.
1136 int ata_scsi_slave_config(struct scsi_device *sdev)
1138 struct ata_port *ap = ata_shost_to_port(sdev->host);
1139 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1140 int rc = 0;
1142 ata_scsi_sdev_config(sdev);
1144 if (dev)
1145 rc = ata_scsi_dev_config(sdev, dev);
1147 return rc;
1151 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1152 * @sdev: SCSI device to be destroyed
1154 * @sdev is about to be destroyed for hot/warm unplugging. If
1155 * this unplugging was initiated by libata as indicated by NULL
1156 * dev->sdev, this function doesn't have to do anything.
1157 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1158 * Clear dev->sdev, schedule the device for ATA detach and invoke
1159 * EH.
1161 * LOCKING:
1162 * Defined by SCSI layer. We don't really care.
1164 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1166 struct ata_port *ap = ata_shost_to_port(sdev->host);
1167 struct request_queue *q = sdev->request_queue;
1168 unsigned long flags;
1169 struct ata_device *dev;
1171 if (!ap->ops->error_handler)
1172 return;
1174 spin_lock_irqsave(ap->lock, flags);
1175 dev = __ata_scsi_find_dev(ap, sdev);
1176 if (dev && dev->sdev) {
1177 /* SCSI device already in CANCEL state, no need to offline it */
1178 dev->sdev = NULL;
1179 dev->flags |= ATA_DFLAG_DETACH;
1180 ata_port_schedule_eh(ap);
1182 spin_unlock_irqrestore(ap->lock, flags);
1184 kfree(q->dma_drain_buffer);
1185 q->dma_drain_buffer = NULL;
1186 q->dma_drain_size = 0;
1190 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1191 * @sdev: SCSI device to configure queue depth for
1192 * @queue_depth: new queue depth
1194 * This is libata standard hostt->change_queue_depth callback.
1195 * SCSI will call into this callback when user tries to set queue
1196 * depth via sysfs.
1198 * LOCKING:
1199 * SCSI layer (we don't care)
1201 * RETURNS:
1202 * Newly configured queue depth.
1204 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1206 struct ata_port *ap = ata_shost_to_port(sdev->host);
1207 struct ata_device *dev;
1208 unsigned long flags;
1210 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1211 return sdev->queue_depth;
1213 dev = ata_scsi_find_dev(ap, sdev);
1214 if (!dev || !ata_dev_enabled(dev))
1215 return sdev->queue_depth;
1217 /* NCQ enabled? */
1218 spin_lock_irqsave(ap->lock, flags);
1219 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1220 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1221 dev->flags |= ATA_DFLAG_NCQ_OFF;
1222 queue_depth = 1;
1224 spin_unlock_irqrestore(ap->lock, flags);
1226 /* limit and apply queue depth */
1227 queue_depth = min(queue_depth, sdev->host->can_queue);
1228 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1229 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1231 if (sdev->queue_depth == queue_depth)
1232 return -EINVAL;
1234 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1235 return queue_depth;
1238 /* XXX: for spindown warning */
1239 static void ata_delayed_done_timerfn(unsigned long arg)
1241 struct scsi_cmnd *scmd = (void *)arg;
1243 scmd->scsi_done(scmd);
1246 /* XXX: for spindown warning */
1247 static void ata_delayed_done(struct scsi_cmnd *scmd)
1249 static struct timer_list timer;
1251 setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
1252 mod_timer(&timer, jiffies + 5 * HZ);
1256 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1257 * @qc: Storage for translated ATA taskfile
1259 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1260 * (to start). Perhaps these commands should be preceded by
1261 * CHECK POWER MODE to see what power mode the device is already in.
1262 * [See SAT revision 5 at www.t10.org]
1264 * LOCKING:
1265 * spin_lock_irqsave(host lock)
1267 * RETURNS:
1268 * Zero on success, non-zero on error.
1270 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1272 struct scsi_cmnd *scmd = qc->scsicmd;
1273 struct ata_taskfile *tf = &qc->tf;
1274 const u8 *cdb = scmd->cmnd;
1276 if (scmd->cmd_len < 5)
1277 goto invalid_fld;
1279 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1280 tf->protocol = ATA_PROT_NODATA;
1281 if (cdb[1] & 0x1) {
1282 ; /* ignore IMMED bit, violates sat-r05 */
1284 if (cdb[4] & 0x2)
1285 goto invalid_fld; /* LOEJ bit set not supported */
1286 if (((cdb[4] >> 4) & 0xf) != 0)
1287 goto invalid_fld; /* power conditions not supported */
1289 if (cdb[4] & 0x1) {
1290 tf->nsect = 1; /* 1 sector, lba=0 */
1292 if (qc->dev->flags & ATA_DFLAG_LBA) {
1293 tf->flags |= ATA_TFLAG_LBA;
1295 tf->lbah = 0x0;
1296 tf->lbam = 0x0;
1297 tf->lbal = 0x0;
1298 tf->device |= ATA_LBA;
1299 } else {
1300 /* CHS */
1301 tf->lbal = 0x1; /* sect */
1302 tf->lbam = 0x0; /* cyl low */
1303 tf->lbah = 0x0; /* cyl high */
1306 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1307 } else {
1308 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1309 * or S5) causing some drives to spin up and down again.
1311 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1312 system_state == SYSTEM_POWER_OFF)
1313 goto skip;
1315 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1316 system_entering_hibernation())
1317 goto skip;
1319 /* XXX: This is for backward compatibility, will be
1320 * removed. Read Documentation/feature-removal-schedule.txt
1321 * for more info.
1323 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
1324 (system_state == SYSTEM_HALT ||
1325 system_state == SYSTEM_POWER_OFF)) {
1326 static unsigned long warned;
1328 if (!test_and_set_bit(0, &warned)) {
1329 ata_dev_printk(qc->dev, KERN_WARNING,
1330 "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
1331 "UPDATE SHUTDOWN UTILITY\n");
1332 ata_dev_printk(qc->dev, KERN_WARNING,
1333 "For more info, visit "
1334 "http://linux-ata.org/shutdown.html\n");
1336 /* ->scsi_done is not used, use it for
1337 * delayed completion.
1339 scmd->scsi_done = qc->scsidone;
1340 qc->scsidone = ata_delayed_done;
1342 goto skip;
1345 /* Issue ATA STANDBY IMMEDIATE command */
1346 tf->command = ATA_CMD_STANDBYNOW1;
1350 * Standby and Idle condition timers could be implemented but that
1351 * would require libata to implement the Power condition mode page
1352 * and allow the user to change it. Changing mode pages requires
1353 * MODE SELECT to be implemented.
1356 return 0;
1358 invalid_fld:
1359 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1360 /* "Invalid field in cbd" */
1361 return 1;
1362 skip:
1363 scmd->result = SAM_STAT_GOOD;
1364 return 1;
1369 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1370 * @qc: Storage for translated ATA taskfile
1372 * Sets up an ATA taskfile to issue FLUSH CACHE or
1373 * FLUSH CACHE EXT.
1375 * LOCKING:
1376 * spin_lock_irqsave(host lock)
1378 * RETURNS:
1379 * Zero on success, non-zero on error.
1381 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1383 struct ata_taskfile *tf = &qc->tf;
1385 tf->flags |= ATA_TFLAG_DEVICE;
1386 tf->protocol = ATA_PROT_NODATA;
1388 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1389 tf->command = ATA_CMD_FLUSH_EXT;
1390 else
1391 tf->command = ATA_CMD_FLUSH;
1393 /* flush is critical for IO integrity, consider it an IO command */
1394 qc->flags |= ATA_QCFLAG_IO;
1396 return 0;
1400 * scsi_6_lba_len - Get LBA and transfer length
1401 * @cdb: SCSI command to translate
1403 * Calculate LBA and transfer length for 6-byte commands.
1405 * RETURNS:
1406 * @plba: the LBA
1407 * @plen: the transfer length
1409 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1411 u64 lba = 0;
1412 u32 len;
1414 VPRINTK("six-byte command\n");
1416 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1417 lba |= ((u64)cdb[2]) << 8;
1418 lba |= ((u64)cdb[3]);
1420 len = cdb[4];
1422 *plba = lba;
1423 *plen = len;
1427 * scsi_10_lba_len - Get LBA and transfer length
1428 * @cdb: SCSI command to translate
1430 * Calculate LBA and transfer length for 10-byte commands.
1432 * RETURNS:
1433 * @plba: the LBA
1434 * @plen: the transfer length
1436 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1438 u64 lba = 0;
1439 u32 len = 0;
1441 VPRINTK("ten-byte command\n");
1443 lba |= ((u64)cdb[2]) << 24;
1444 lba |= ((u64)cdb[3]) << 16;
1445 lba |= ((u64)cdb[4]) << 8;
1446 lba |= ((u64)cdb[5]);
1448 len |= ((u32)cdb[7]) << 8;
1449 len |= ((u32)cdb[8]);
1451 *plba = lba;
1452 *plen = len;
1456 * scsi_16_lba_len - Get LBA and transfer length
1457 * @cdb: SCSI command to translate
1459 * Calculate LBA and transfer length for 16-byte commands.
1461 * RETURNS:
1462 * @plba: the LBA
1463 * @plen: the transfer length
1465 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1467 u64 lba = 0;
1468 u32 len = 0;
1470 VPRINTK("sixteen-byte command\n");
1472 lba |= ((u64)cdb[2]) << 56;
1473 lba |= ((u64)cdb[3]) << 48;
1474 lba |= ((u64)cdb[4]) << 40;
1475 lba |= ((u64)cdb[5]) << 32;
1476 lba |= ((u64)cdb[6]) << 24;
1477 lba |= ((u64)cdb[7]) << 16;
1478 lba |= ((u64)cdb[8]) << 8;
1479 lba |= ((u64)cdb[9]);
1481 len |= ((u32)cdb[10]) << 24;
1482 len |= ((u32)cdb[11]) << 16;
1483 len |= ((u32)cdb[12]) << 8;
1484 len |= ((u32)cdb[13]);
1486 *plba = lba;
1487 *plen = len;
1491 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1492 * @qc: Storage for translated ATA taskfile
1494 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1496 * LOCKING:
1497 * spin_lock_irqsave(host lock)
1499 * RETURNS:
1500 * Zero on success, non-zero on error.
1502 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1504 struct scsi_cmnd *scmd = qc->scsicmd;
1505 struct ata_taskfile *tf = &qc->tf;
1506 struct ata_device *dev = qc->dev;
1507 u64 dev_sectors = qc->dev->n_sectors;
1508 const u8 *cdb = scmd->cmnd;
1509 u64 block;
1510 u32 n_block;
1512 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1513 tf->protocol = ATA_PROT_NODATA;
1515 if (cdb[0] == VERIFY) {
1516 if (scmd->cmd_len < 10)
1517 goto invalid_fld;
1518 scsi_10_lba_len(cdb, &block, &n_block);
1519 } else if (cdb[0] == VERIFY_16) {
1520 if (scmd->cmd_len < 16)
1521 goto invalid_fld;
1522 scsi_16_lba_len(cdb, &block, &n_block);
1523 } else
1524 goto invalid_fld;
1526 if (!n_block)
1527 goto nothing_to_do;
1528 if (block >= dev_sectors)
1529 goto out_of_range;
1530 if ((block + n_block) > dev_sectors)
1531 goto out_of_range;
1533 if (dev->flags & ATA_DFLAG_LBA) {
1534 tf->flags |= ATA_TFLAG_LBA;
1536 if (lba_28_ok(block, n_block)) {
1537 /* use LBA28 */
1538 tf->command = ATA_CMD_VERIFY;
1539 tf->device |= (block >> 24) & 0xf;
1540 } else if (lba_48_ok(block, n_block)) {
1541 if (!(dev->flags & ATA_DFLAG_LBA48))
1542 goto out_of_range;
1544 /* use LBA48 */
1545 tf->flags |= ATA_TFLAG_LBA48;
1546 tf->command = ATA_CMD_VERIFY_EXT;
1548 tf->hob_nsect = (n_block >> 8) & 0xff;
1550 tf->hob_lbah = (block >> 40) & 0xff;
1551 tf->hob_lbam = (block >> 32) & 0xff;
1552 tf->hob_lbal = (block >> 24) & 0xff;
1553 } else
1554 /* request too large even for LBA48 */
1555 goto out_of_range;
1557 tf->nsect = n_block & 0xff;
1559 tf->lbah = (block >> 16) & 0xff;
1560 tf->lbam = (block >> 8) & 0xff;
1561 tf->lbal = block & 0xff;
1563 tf->device |= ATA_LBA;
1564 } else {
1565 /* CHS */
1566 u32 sect, head, cyl, track;
1568 if (!lba_28_ok(block, n_block))
1569 goto out_of_range;
1571 /* Convert LBA to CHS */
1572 track = (u32)block / dev->sectors;
1573 cyl = track / dev->heads;
1574 head = track % dev->heads;
1575 sect = (u32)block % dev->sectors + 1;
1577 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1578 (u32)block, track, cyl, head, sect);
1580 /* Check whether the converted CHS can fit.
1581 Cylinder: 0-65535
1582 Head: 0-15
1583 Sector: 1-255*/
1584 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1585 goto out_of_range;
1587 tf->command = ATA_CMD_VERIFY;
1588 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1589 tf->lbal = sect;
1590 tf->lbam = cyl;
1591 tf->lbah = cyl >> 8;
1592 tf->device |= head;
1595 return 0;
1597 invalid_fld:
1598 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1599 /* "Invalid field in cbd" */
1600 return 1;
1602 out_of_range:
1603 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1604 /* "Logical Block Address out of range" */
1605 return 1;
1607 nothing_to_do:
1608 scmd->result = SAM_STAT_GOOD;
1609 return 1;
1613 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1614 * @qc: Storage for translated ATA taskfile
1616 * Converts any of six SCSI read/write commands into the
1617 * ATA counterpart, including starting sector (LBA),
1618 * sector count, and taking into account the device's LBA48
1619 * support.
1621 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1622 * %WRITE_16 are currently supported.
1624 * LOCKING:
1625 * spin_lock_irqsave(host lock)
1627 * RETURNS:
1628 * Zero on success, non-zero on error.
1630 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1632 struct scsi_cmnd *scmd = qc->scsicmd;
1633 const u8 *cdb = scmd->cmnd;
1634 unsigned int tf_flags = 0;
1635 u64 block;
1636 u32 n_block;
1637 int rc;
1639 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1640 tf_flags |= ATA_TFLAG_WRITE;
1642 /* Calculate the SCSI LBA, transfer length and FUA. */
1643 switch (cdb[0]) {
1644 case READ_10:
1645 case WRITE_10:
1646 if (unlikely(scmd->cmd_len < 10))
1647 goto invalid_fld;
1648 scsi_10_lba_len(cdb, &block, &n_block);
1649 if (unlikely(cdb[1] & (1 << 3)))
1650 tf_flags |= ATA_TFLAG_FUA;
1651 break;
1652 case READ_6:
1653 case WRITE_6:
1654 if (unlikely(scmd->cmd_len < 6))
1655 goto invalid_fld;
1656 scsi_6_lba_len(cdb, &block, &n_block);
1658 /* for 6-byte r/w commands, transfer length 0
1659 * means 256 blocks of data, not 0 block.
1661 if (!n_block)
1662 n_block = 256;
1663 break;
1664 case READ_16:
1665 case WRITE_16:
1666 if (unlikely(scmd->cmd_len < 16))
1667 goto invalid_fld;
1668 scsi_16_lba_len(cdb, &block, &n_block);
1669 if (unlikely(cdb[1] & (1 << 3)))
1670 tf_flags |= ATA_TFLAG_FUA;
1671 break;
1672 default:
1673 DPRINTK("no-byte command\n");
1674 goto invalid_fld;
1677 /* Check and compose ATA command */
1678 if (!n_block)
1679 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1680 * length 0 means transfer 0 block of data.
1681 * However, for ATA R/W commands, sector count 0 means
1682 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1684 * WARNING: one or two older ATA drives treat 0 as 0...
1686 goto nothing_to_do;
1688 qc->flags |= ATA_QCFLAG_IO;
1689 qc->nbytes = n_block * ATA_SECT_SIZE;
1691 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1692 qc->tag);
1693 if (likely(rc == 0))
1694 return 0;
1696 if (rc == -ERANGE)
1697 goto out_of_range;
1698 /* treat all other errors as -EINVAL, fall through */
1699 invalid_fld:
1700 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1701 /* "Invalid field in cbd" */
1702 return 1;
1704 out_of_range:
1705 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1706 /* "Logical Block Address out of range" */
1707 return 1;
1709 nothing_to_do:
1710 scmd->result = SAM_STAT_GOOD;
1711 return 1;
1714 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1716 struct ata_port *ap = qc->ap;
1717 struct scsi_cmnd *cmd = qc->scsicmd;
1718 u8 *cdb = cmd->cmnd;
1719 int need_sense = (qc->err_mask != 0);
1721 /* For ATA pass thru (SAT) commands, generate a sense block if
1722 * user mandated it or if there's an error. Note that if we
1723 * generate because the user forced us to, a check condition
1724 * is generated and the ATA register values are returned
1725 * whether the command completed successfully or not. If there
1726 * was no error, SK, ASC and ASCQ will all be zero.
1728 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1729 ((cdb[2] & 0x20) || need_sense)) {
1730 ata_gen_passthru_sense(qc);
1731 } else {
1732 if (!need_sense) {
1733 cmd->result = SAM_STAT_GOOD;
1734 } else {
1735 /* TODO: decide which descriptor format to use
1736 * for 48b LBA devices and call that here
1737 * instead of the fixed desc, which is only
1738 * good for smaller LBA (and maybe CHS?)
1739 * devices.
1741 ata_gen_ata_sense(qc);
1745 /* XXX: track spindown state for spindown skipping and warning */
1746 if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1747 qc->tf.command == ATA_CMD_STANDBYNOW1))
1748 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1749 else if (likely(system_state != SYSTEM_HALT &&
1750 system_state != SYSTEM_POWER_OFF))
1751 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1753 if (need_sense && !ap->ops->error_handler)
1754 ata_dump_status(ap->print_id, &qc->result_tf);
1756 qc->scsidone(cmd);
1758 ata_qc_free(qc);
1762 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1763 * @dev: ATA device to which the command is addressed
1764 * @cmd: SCSI command to execute
1765 * @done: SCSI command completion function
1766 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1768 * Our ->queuecommand() function has decided that the SCSI
1769 * command issued can be directly translated into an ATA
1770 * command, rather than handled internally.
1772 * This function sets up an ata_queued_cmd structure for the
1773 * SCSI command, and sends that ata_queued_cmd to the hardware.
1775 * The xlat_func argument (actor) returns 0 if ready to execute
1776 * ATA command, else 1 to finish translation. If 1 is returned
1777 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1778 * to be set reflecting an error condition or clean (early)
1779 * termination.
1781 * LOCKING:
1782 * spin_lock_irqsave(host lock)
1784 * RETURNS:
1785 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1786 * needs to be deferred.
1788 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1789 void (*done)(struct scsi_cmnd *),
1790 ata_xlat_func_t xlat_func)
1792 struct ata_port *ap = dev->link->ap;
1793 struct ata_queued_cmd *qc;
1794 int rc;
1796 VPRINTK("ENTER\n");
1798 qc = ata_scsi_qc_new(dev, cmd, done);
1799 if (!qc)
1800 goto err_mem;
1802 /* data is present; dma-map it */
1803 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1804 cmd->sc_data_direction == DMA_TO_DEVICE) {
1805 if (unlikely(scsi_bufflen(cmd) < 1)) {
1806 ata_dev_printk(dev, KERN_WARNING,
1807 "WARNING: zero len r/w req\n");
1808 goto err_did;
1811 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1813 qc->dma_dir = cmd->sc_data_direction;
1816 qc->complete_fn = ata_scsi_qc_complete;
1818 if (xlat_func(qc))
1819 goto early_finish;
1821 if (ap->ops->qc_defer) {
1822 if ((rc = ap->ops->qc_defer(qc)))
1823 goto defer;
1826 /* select device, send command to hardware */
1827 ata_qc_issue(qc);
1829 VPRINTK("EXIT\n");
1830 return 0;
1832 early_finish:
1833 ata_qc_free(qc);
1834 qc->scsidone(cmd);
1835 DPRINTK("EXIT - early finish (good or error)\n");
1836 return 0;
1838 err_did:
1839 ata_qc_free(qc);
1840 cmd->result = (DID_ERROR << 16);
1841 qc->scsidone(cmd);
1842 err_mem:
1843 DPRINTK("EXIT - internal\n");
1844 return 0;
1846 defer:
1847 ata_qc_free(qc);
1848 DPRINTK("EXIT - defer\n");
1849 if (rc == ATA_DEFER_LINK)
1850 return SCSI_MLQUEUE_DEVICE_BUSY;
1851 else
1852 return SCSI_MLQUEUE_HOST_BUSY;
1856 * ata_scsi_rbuf_get - Map response buffer.
1857 * @cmd: SCSI command containing buffer to be mapped.
1858 * @flags: unsigned long variable to store irq enable status
1859 * @copy_in: copy in from user buffer
1861 * Prepare buffer for simulated SCSI commands.
1863 * LOCKING:
1864 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1866 * RETURNS:
1867 * Pointer to response buffer.
1869 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1870 unsigned long *flags)
1872 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1874 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1875 if (copy_in)
1876 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1877 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1878 return ata_scsi_rbuf;
1882 * ata_scsi_rbuf_put - Unmap response buffer.
1883 * @cmd: SCSI command containing buffer to be unmapped.
1884 * @copy_out: copy out result
1885 * @flags: @flags passed to ata_scsi_rbuf_get()
1887 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1888 * @copy_back is true.
1890 * LOCKING:
1891 * Unlocks ata_scsi_rbuf_lock.
1893 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1894 unsigned long *flags)
1896 if (copy_out)
1897 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1898 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1899 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1903 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1904 * @args: device IDENTIFY data / SCSI command of interest.
1905 * @actor: Callback hook for desired SCSI command simulator
1907 * Takes care of the hard work of simulating a SCSI command...
1908 * Mapping the response buffer, calling the command's handler,
1909 * and handling the handler's return value. This return value
1910 * indicates whether the handler wishes the SCSI command to be
1911 * completed successfully (0), or not (in which case cmd->result
1912 * and sense buffer are assumed to be set).
1914 * LOCKING:
1915 * spin_lock_irqsave(host lock)
1917 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1918 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1920 u8 *rbuf;
1921 unsigned int rc;
1922 struct scsi_cmnd *cmd = args->cmd;
1923 unsigned long flags;
1925 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1926 rc = actor(args, rbuf);
1927 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1929 if (rc == 0)
1930 cmd->result = SAM_STAT_GOOD;
1931 args->done(cmd);
1935 * ata_scsiop_inq_std - Simulate INQUIRY command
1936 * @args: device IDENTIFY data / SCSI command of interest.
1937 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1939 * Returns standard device identification data associated
1940 * with non-VPD INQUIRY command output.
1942 * LOCKING:
1943 * spin_lock_irqsave(host lock)
1945 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1947 const u8 versions[] = {
1948 0x60, /* SAM-3 (no version claimed) */
1950 0x03,
1951 0x20, /* SBC-2 (no version claimed) */
1953 0x02,
1954 0x60 /* SPC-3 (no version claimed) */
1956 u8 hdr[] = {
1957 TYPE_DISK,
1959 0x5, /* claim SPC-3 version compatibility */
1961 95 - 4
1964 VPRINTK("ENTER\n");
1966 /* set scsi removeable (RMB) bit per ata bit */
1967 if (ata_id_removeable(args->id))
1968 hdr[1] |= (1 << 7);
1970 memcpy(rbuf, hdr, sizeof(hdr));
1971 memcpy(&rbuf[8], "ATA ", 8);
1972 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1973 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1975 if (rbuf[32] == 0 || rbuf[32] == ' ')
1976 memcpy(&rbuf[32], "n/a ", 4);
1978 memcpy(rbuf + 59, versions, sizeof(versions));
1980 return 0;
1984 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1985 * @args: device IDENTIFY data / SCSI command of interest.
1986 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1988 * Returns list of inquiry VPD pages available.
1990 * LOCKING:
1991 * spin_lock_irqsave(host lock)
1993 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1995 const u8 pages[] = {
1996 0x00, /* page 0x00, this page */
1997 0x80, /* page 0x80, unit serial no page */
1998 0x83, /* page 0x83, device ident page */
1999 0x89, /* page 0x89, ata info page */
2000 0xb1, /* page 0xb1, block device characteristics page */
2003 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
2004 memcpy(rbuf + 4, pages, sizeof(pages));
2005 return 0;
2009 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2010 * @args: device IDENTIFY data / SCSI command of interest.
2011 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2013 * Returns ATA device serial number.
2015 * LOCKING:
2016 * spin_lock_irqsave(host lock)
2018 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2020 const u8 hdr[] = {
2022 0x80, /* this page code */
2024 ATA_ID_SERNO_LEN, /* page len */
2027 memcpy(rbuf, hdr, sizeof(hdr));
2028 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2029 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2030 return 0;
2034 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2035 * @args: device IDENTIFY data / SCSI command of interest.
2036 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2038 * Yields two logical unit device identification designators:
2039 * - vendor specific ASCII containing the ATA serial number
2040 * - SAT defined "t10 vendor id based" containing ASCII vendor
2041 * name ("ATA "), model and serial numbers.
2043 * LOCKING:
2044 * spin_lock_irqsave(host lock)
2046 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2048 const int sat_model_serial_desc_len = 68;
2049 int num;
2051 rbuf[1] = 0x83; /* this page code */
2052 num = 4;
2054 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2055 rbuf[num + 0] = 2;
2056 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2057 num += 4;
2058 ata_id_string(args->id, (unsigned char *) rbuf + num,
2059 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2060 num += ATA_ID_SERNO_LEN;
2062 /* SAT defined lu model and serial numbers descriptor */
2063 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2064 rbuf[num + 0] = 2;
2065 rbuf[num + 1] = 1;
2066 rbuf[num + 3] = sat_model_serial_desc_len;
2067 num += 4;
2068 memcpy(rbuf + num, "ATA ", 8);
2069 num += 8;
2070 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2071 ATA_ID_PROD_LEN);
2072 num += ATA_ID_PROD_LEN;
2073 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2074 ATA_ID_SERNO_LEN);
2075 num += ATA_ID_SERNO_LEN;
2077 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2078 return 0;
2082 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2083 * @args: device IDENTIFY data / SCSI command of interest.
2084 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2086 * Yields SAT-specified ATA VPD page.
2088 * LOCKING:
2089 * spin_lock_irqsave(host lock)
2091 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2093 struct ata_taskfile tf;
2095 memset(&tf, 0, sizeof(tf));
2097 rbuf[1] = 0x89; /* our page code */
2098 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2099 rbuf[3] = (0x238 & 0xff);
2101 memcpy(&rbuf[8], "linux ", 8);
2102 memcpy(&rbuf[16], "libata ", 16);
2103 memcpy(&rbuf[32], DRV_VERSION, 4);
2104 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2106 /* we don't store the ATA device signature, so we fake it */
2108 tf.command = ATA_DRDY; /* really, this is Status reg */
2109 tf.lbal = 0x1;
2110 tf.nsect = 0x1;
2112 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2113 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2115 rbuf[56] = ATA_CMD_ID_ATA;
2117 memcpy(&rbuf[60], &args->id[0], 512);
2118 return 0;
2121 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2123 rbuf[1] = 0xb1;
2124 rbuf[3] = 0x3c;
2125 if (ata_id_major_version(args->id) > 7) {
2126 rbuf[4] = args->id[217] >> 8;
2127 rbuf[5] = args->id[217];
2128 rbuf[7] = args->id[168] & 0xf;
2131 return 0;
2135 * ata_scsiop_noop - Command handler that simply returns success.
2136 * @args: device IDENTIFY data / SCSI command of interest.
2137 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2139 * No operation. Simply returns success to caller, to indicate
2140 * that the caller should successfully complete this SCSI command.
2142 * LOCKING:
2143 * spin_lock_irqsave(host lock)
2145 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2147 VPRINTK("ENTER\n");
2148 return 0;
2152 * ata_msense_caching - Simulate MODE SENSE caching info page
2153 * @id: device IDENTIFY data
2154 * @buf: output buffer
2156 * Generate a caching info page, which conditionally indicates
2157 * write caching to the SCSI layer, depending on device
2158 * capabilities.
2160 * LOCKING:
2161 * None.
2163 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2165 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2166 if (ata_id_wcache_enabled(id))
2167 buf[2] |= (1 << 2); /* write cache enable */
2168 if (!ata_id_rahead_enabled(id))
2169 buf[12] |= (1 << 5); /* disable read ahead */
2170 return sizeof(def_cache_mpage);
2174 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2175 * @buf: output buffer
2177 * Generate a generic MODE SENSE control mode page.
2179 * LOCKING:
2180 * None.
2182 static unsigned int ata_msense_ctl_mode(u8 *buf)
2184 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2185 return sizeof(def_control_mpage);
2189 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2190 * @buf: output buffer
2192 * Generate a generic MODE SENSE r/w error recovery page.
2194 * LOCKING:
2195 * None.
2197 static unsigned int ata_msense_rw_recovery(u8 *buf)
2199 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2200 return sizeof(def_rw_recovery_mpage);
2204 * We can turn this into a real blacklist if it's needed, for now just
2205 * blacklist any Maxtor BANC1G10 revision firmware
2207 static int ata_dev_supports_fua(u16 *id)
2209 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2211 if (!libata_fua)
2212 return 0;
2213 if (!ata_id_has_fua(id))
2214 return 0;
2216 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2217 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2219 if (strcmp(model, "Maxtor"))
2220 return 1;
2221 if (strcmp(fw, "BANC1G10"))
2222 return 1;
2224 return 0; /* blacklisted */
2228 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2229 * @args: device IDENTIFY data / SCSI command of interest.
2230 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2232 * Simulate MODE SENSE commands. Assume this is invoked for direct
2233 * access devices (e.g. disks) only. There should be no block
2234 * descriptor for other device types.
2236 * LOCKING:
2237 * spin_lock_irqsave(host lock)
2239 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2241 struct ata_device *dev = args->dev;
2242 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2243 const u8 sat_blk_desc[] = {
2244 0, 0, 0, 0, /* number of blocks: sat unspecified */
2246 0, 0x2, 0x0 /* block length: 512 bytes */
2248 u8 pg, spg;
2249 unsigned int ebd, page_control, six_byte;
2250 u8 dpofua;
2252 VPRINTK("ENTER\n");
2254 six_byte = (scsicmd[0] == MODE_SENSE);
2255 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2257 * LLBA bit in msense(10) ignored (compliant)
2260 page_control = scsicmd[2] >> 6;
2261 switch (page_control) {
2262 case 0: /* current */
2263 break; /* supported */
2264 case 3: /* saved */
2265 goto saving_not_supp;
2266 case 1: /* changeable */
2267 case 2: /* defaults */
2268 default:
2269 goto invalid_fld;
2272 if (six_byte)
2273 p += 4 + (ebd ? 8 : 0);
2274 else
2275 p += 8 + (ebd ? 8 : 0);
2277 pg = scsicmd[2] & 0x3f;
2278 spg = scsicmd[3];
2280 * No mode subpages supported (yet) but asking for _all_
2281 * subpages may be valid
2283 if (spg && (spg != ALL_SUB_MPAGES))
2284 goto invalid_fld;
2286 switch(pg) {
2287 case RW_RECOVERY_MPAGE:
2288 p += ata_msense_rw_recovery(p);
2289 break;
2291 case CACHE_MPAGE:
2292 p += ata_msense_caching(args->id, p);
2293 break;
2295 case CONTROL_MPAGE:
2296 p += ata_msense_ctl_mode(p);
2297 break;
2299 case ALL_MPAGES:
2300 p += ata_msense_rw_recovery(p);
2301 p += ata_msense_caching(args->id, p);
2302 p += ata_msense_ctl_mode(p);
2303 break;
2305 default: /* invalid page code */
2306 goto invalid_fld;
2309 dpofua = 0;
2310 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2311 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2312 dpofua = 1 << 4;
2314 if (six_byte) {
2315 rbuf[0] = p - rbuf - 1;
2316 rbuf[2] |= dpofua;
2317 if (ebd) {
2318 rbuf[3] = sizeof(sat_blk_desc);
2319 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2321 } else {
2322 unsigned int output_len = p - rbuf - 2;
2324 rbuf[0] = output_len >> 8;
2325 rbuf[1] = output_len;
2326 rbuf[3] |= dpofua;
2327 if (ebd) {
2328 rbuf[7] = sizeof(sat_blk_desc);
2329 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2332 return 0;
2334 invalid_fld:
2335 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2336 /* "Invalid field in cbd" */
2337 return 1;
2339 saving_not_supp:
2340 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2341 /* "Saving parameters not supported" */
2342 return 1;
2346 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2347 * @args: device IDENTIFY data / SCSI command of interest.
2348 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2350 * Simulate READ CAPACITY commands.
2352 * LOCKING:
2353 * None.
2355 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2357 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2359 VPRINTK("ENTER\n");
2361 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2362 if (last_lba >= 0xffffffffULL)
2363 last_lba = 0xffffffff;
2365 /* sector count, 32-bit */
2366 rbuf[0] = last_lba >> (8 * 3);
2367 rbuf[1] = last_lba >> (8 * 2);
2368 rbuf[2] = last_lba >> (8 * 1);
2369 rbuf[3] = last_lba;
2371 /* sector size */
2372 rbuf[6] = ATA_SECT_SIZE >> 8;
2373 rbuf[7] = ATA_SECT_SIZE & 0xff;
2374 } else {
2375 /* sector count, 64-bit */
2376 rbuf[0] = last_lba >> (8 * 7);
2377 rbuf[1] = last_lba >> (8 * 6);
2378 rbuf[2] = last_lba >> (8 * 5);
2379 rbuf[3] = last_lba >> (8 * 4);
2380 rbuf[4] = last_lba >> (8 * 3);
2381 rbuf[5] = last_lba >> (8 * 2);
2382 rbuf[6] = last_lba >> (8 * 1);
2383 rbuf[7] = last_lba;
2385 /* sector size */
2386 rbuf[10] = ATA_SECT_SIZE >> 8;
2387 rbuf[11] = ATA_SECT_SIZE & 0xff;
2390 return 0;
2394 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2395 * @args: device IDENTIFY data / SCSI command of interest.
2396 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2398 * Simulate REPORT LUNS command.
2400 * LOCKING:
2401 * spin_lock_irqsave(host lock)
2403 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2405 VPRINTK("ENTER\n");
2406 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2408 return 0;
2411 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2413 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2414 /* FIXME: not quite right; we don't want the
2415 * translation of taskfile registers into
2416 * a sense descriptors, since that's only
2417 * correct for ATA, not ATAPI
2419 ata_gen_passthru_sense(qc);
2422 qc->scsidone(qc->scsicmd);
2423 ata_qc_free(qc);
2426 /* is it pointless to prefer PIO for "safety reasons"? */
2427 static inline int ata_pio_use_silly(struct ata_port *ap)
2429 return (ap->flags & ATA_FLAG_PIO_DMA);
2432 static void atapi_request_sense(struct ata_queued_cmd *qc)
2434 struct ata_port *ap = qc->ap;
2435 struct scsi_cmnd *cmd = qc->scsicmd;
2437 DPRINTK("ATAPI request sense\n");
2439 /* FIXME: is this needed? */
2440 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2442 #ifdef CONFIG_ATA_SFF
2443 if (ap->ops->sff_tf_read)
2444 ap->ops->sff_tf_read(ap, &qc->tf);
2445 #endif
2447 /* fill these in, for the case where they are -not- overwritten */
2448 cmd->sense_buffer[0] = 0x70;
2449 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2451 ata_qc_reinit(qc);
2453 /* setup sg table and init transfer direction */
2454 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2455 ata_sg_init(qc, &qc->sgent, 1);
2456 qc->dma_dir = DMA_FROM_DEVICE;
2458 memset(&qc->cdb, 0, qc->dev->cdb_len);
2459 qc->cdb[0] = REQUEST_SENSE;
2460 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2462 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2463 qc->tf.command = ATA_CMD_PACKET;
2465 if (ata_pio_use_silly(ap)) {
2466 qc->tf.protocol = ATAPI_PROT_DMA;
2467 qc->tf.feature |= ATAPI_PKT_DMA;
2468 } else {
2469 qc->tf.protocol = ATAPI_PROT_PIO;
2470 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2471 qc->tf.lbah = 0;
2473 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2475 qc->complete_fn = atapi_sense_complete;
2477 ata_qc_issue(qc);
2479 DPRINTK("EXIT\n");
2482 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2484 struct scsi_cmnd *cmd = qc->scsicmd;
2485 unsigned int err_mask = qc->err_mask;
2487 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2489 /* handle completion from new EH */
2490 if (unlikely(qc->ap->ops->error_handler &&
2491 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2493 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2494 /* FIXME: not quite right; we don't want the
2495 * translation of taskfile registers into a
2496 * sense descriptors, since that's only
2497 * correct for ATA, not ATAPI
2499 ata_gen_passthru_sense(qc);
2502 /* SCSI EH automatically locks door if sdev->locked is
2503 * set. Sometimes door lock request continues to
2504 * fail, for example, when no media is present. This
2505 * creates a loop - SCSI EH issues door lock which
2506 * fails and gets invoked again to acquire sense data
2507 * for the failed command.
2509 * If door lock fails, always clear sdev->locked to
2510 * avoid this infinite loop.
2512 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2513 qc->dev->sdev->locked = 0;
2515 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2516 qc->scsidone(cmd);
2517 ata_qc_free(qc);
2518 return;
2521 /* successful completion or old EH failure path */
2522 if (unlikely(err_mask & AC_ERR_DEV)) {
2523 cmd->result = SAM_STAT_CHECK_CONDITION;
2524 atapi_request_sense(qc);
2525 return;
2526 } else if (unlikely(err_mask)) {
2527 /* FIXME: not quite right; we don't want the
2528 * translation of taskfile registers into
2529 * a sense descriptors, since that's only
2530 * correct for ATA, not ATAPI
2532 ata_gen_passthru_sense(qc);
2533 } else {
2534 u8 *scsicmd = cmd->cmnd;
2536 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2537 unsigned long flags;
2538 u8 *buf;
2540 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2542 /* ATAPI devices typically report zero for their SCSI version,
2543 * and sometimes deviate from the spec WRT response data
2544 * format. If SCSI version is reported as zero like normal,
2545 * then we make the following fixups: 1) Fake MMC-5 version,
2546 * to indicate to the Linux scsi midlayer this is a modern
2547 * device. 2) Ensure response data format / ATAPI information
2548 * are always correct.
2550 if (buf[2] == 0) {
2551 buf[2] = 0x5;
2552 buf[3] = 0x32;
2555 ata_scsi_rbuf_put(cmd, true, &flags);
2558 cmd->result = SAM_STAT_GOOD;
2561 qc->scsidone(cmd);
2562 ata_qc_free(qc);
2565 * atapi_xlat - Initialize PACKET taskfile
2566 * @qc: command structure to be initialized
2568 * LOCKING:
2569 * spin_lock_irqsave(host lock)
2571 * RETURNS:
2572 * Zero on success, non-zero on failure.
2574 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2576 struct scsi_cmnd *scmd = qc->scsicmd;
2577 struct ata_device *dev = qc->dev;
2578 int nodata = (scmd->sc_data_direction == DMA_NONE);
2579 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2580 unsigned int nbytes;
2582 memset(qc->cdb, 0, dev->cdb_len);
2583 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2585 qc->complete_fn = atapi_qc_complete;
2587 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2588 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2589 qc->tf.flags |= ATA_TFLAG_WRITE;
2590 DPRINTK("direction: write\n");
2593 qc->tf.command = ATA_CMD_PACKET;
2594 ata_qc_set_pc_nbytes(qc);
2596 /* check whether ATAPI DMA is safe */
2597 if (!nodata && !using_pio && atapi_check_dma(qc))
2598 using_pio = 1;
2600 /* Some controller variants snoop this value for Packet
2601 * transfers to do state machine and FIFO management. Thus we
2602 * want to set it properly, and for DMA where it is
2603 * effectively meaningless.
2605 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2607 /* Most ATAPI devices which honor transfer chunk size don't
2608 * behave according to the spec when odd chunk size which
2609 * matches the transfer length is specified. If the number of
2610 * bytes to transfer is 2n+1. According to the spec, what
2611 * should happen is to indicate that 2n+1 is going to be
2612 * transferred and transfer 2n+2 bytes where the last byte is
2613 * padding.
2615 * In practice, this doesn't happen. ATAPI devices first
2616 * indicate and transfer 2n bytes and then indicate and
2617 * transfer 2 bytes where the last byte is padding.
2619 * This inconsistency confuses several controllers which
2620 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2621 * These controllers use actual number of transferred bytes to
2622 * update DMA poitner and transfer of 4n+2 bytes make those
2623 * controller push DMA pointer by 4n+4 bytes because SATA data
2624 * FISes are aligned to 4 bytes. This causes data corruption
2625 * and buffer overrun.
2627 * Always setting nbytes to even number solves this problem
2628 * because then ATAPI devices don't have to split data at 2n
2629 * boundaries.
2631 if (nbytes & 0x1)
2632 nbytes++;
2634 qc->tf.lbam = (nbytes & 0xFF);
2635 qc->tf.lbah = (nbytes >> 8);
2637 if (nodata)
2638 qc->tf.protocol = ATAPI_PROT_NODATA;
2639 else if (using_pio)
2640 qc->tf.protocol = ATAPI_PROT_PIO;
2641 else {
2642 /* DMA data xfer */
2643 qc->tf.protocol = ATAPI_PROT_DMA;
2644 qc->tf.feature |= ATAPI_PKT_DMA;
2646 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2647 (scmd->sc_data_direction != DMA_TO_DEVICE))
2648 /* some SATA bridges need us to indicate data xfer direction */
2649 qc->tf.feature |= ATAPI_DMADIR;
2653 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2654 as ATAPI tape drives don't get this right otherwise */
2655 return 0;
2658 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2660 if (!sata_pmp_attached(ap)) {
2661 if (likely(devno < ata_link_max_devices(&ap->link)))
2662 return &ap->link.device[devno];
2663 } else {
2664 if (likely(devno < ap->nr_pmp_links))
2665 return &ap->pmp_link[devno].device[0];
2668 return NULL;
2671 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2672 const struct scsi_device *scsidev)
2674 int devno;
2676 /* skip commands not addressed to targets we simulate */
2677 if (!sata_pmp_attached(ap)) {
2678 if (unlikely(scsidev->channel || scsidev->lun))
2679 return NULL;
2680 devno = scsidev->id;
2681 } else {
2682 if (unlikely(scsidev->id || scsidev->lun))
2683 return NULL;
2684 devno = scsidev->channel;
2687 return ata_find_dev(ap, devno);
2691 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2692 * @ap: ATA port to which the device is attached
2693 * @scsidev: SCSI device from which we derive the ATA device
2695 * Given various information provided in struct scsi_cmnd,
2696 * map that onto an ATA bus, and using that mapping
2697 * determine which ata_device is associated with the
2698 * SCSI command to be sent.
2700 * LOCKING:
2701 * spin_lock_irqsave(host lock)
2703 * RETURNS:
2704 * Associated ATA device, or %NULL if not found.
2706 static struct ata_device *
2707 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2709 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2711 if (unlikely(!dev || !ata_dev_enabled(dev)))
2712 return NULL;
2714 return dev;
2718 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2719 * @byte1: Byte 1 from pass-thru CDB.
2721 * RETURNS:
2722 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2724 static u8
2725 ata_scsi_map_proto(u8 byte1)
2727 switch((byte1 & 0x1e) >> 1) {
2728 case 3: /* Non-data */
2729 return ATA_PROT_NODATA;
2731 case 6: /* DMA */
2732 case 10: /* UDMA Data-in */
2733 case 11: /* UDMA Data-Out */
2734 return ATA_PROT_DMA;
2736 case 4: /* PIO Data-in */
2737 case 5: /* PIO Data-out */
2738 return ATA_PROT_PIO;
2740 case 0: /* Hard Reset */
2741 case 1: /* SRST */
2742 case 8: /* Device Diagnostic */
2743 case 9: /* Device Reset */
2744 case 7: /* DMA Queued */
2745 case 12: /* FPDMA */
2746 case 15: /* Return Response Info */
2747 default: /* Reserved */
2748 break;
2751 return ATA_PROT_UNKNOWN;
2755 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2756 * @qc: command structure to be initialized
2758 * Handles either 12 or 16-byte versions of the CDB.
2760 * RETURNS:
2761 * Zero on success, non-zero on failure.
2763 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2765 struct ata_taskfile *tf = &(qc->tf);
2766 struct scsi_cmnd *scmd = qc->scsicmd;
2767 struct ata_device *dev = qc->dev;
2768 const u8 *cdb = scmd->cmnd;
2770 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2771 goto invalid_fld;
2774 * Filter TPM commands by default. These provide an
2775 * essentially uncontrolled encrypted "back door" between
2776 * applications and the disk. Set libata.allow_tpm=1 if you
2777 * have a real reason for wanting to use them. This ensures
2778 * that installed software cannot easily mess stuff up without
2779 * user intent. DVR type users will probably ship with this enabled
2780 * for movie content management.
2782 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2783 * for this and should do in future but that it is not sufficient as
2784 * DCS is an optional feature set. Thus we also do the software filter
2785 * so that we comply with the TC consortium stated goal that the user
2786 * can turn off TC features of their system.
2788 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2789 goto invalid_fld;
2791 /* We may not issue DMA commands if no DMA mode is set */
2792 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2793 goto invalid_fld;
2796 * 12 and 16 byte CDBs use different offsets to
2797 * provide the various register values.
2799 if (cdb[0] == ATA_16) {
2801 * 16-byte CDB - may contain extended commands.
2803 * If that is the case, copy the upper byte register values.
2805 if (cdb[1] & 0x01) {
2806 tf->hob_feature = cdb[3];
2807 tf->hob_nsect = cdb[5];
2808 tf->hob_lbal = cdb[7];
2809 tf->hob_lbam = cdb[9];
2810 tf->hob_lbah = cdb[11];
2811 tf->flags |= ATA_TFLAG_LBA48;
2812 } else
2813 tf->flags &= ~ATA_TFLAG_LBA48;
2816 * Always copy low byte, device and command registers.
2818 tf->feature = cdb[4];
2819 tf->nsect = cdb[6];
2820 tf->lbal = cdb[8];
2821 tf->lbam = cdb[10];
2822 tf->lbah = cdb[12];
2823 tf->device = cdb[13];
2824 tf->command = cdb[14];
2825 } else {
2827 * 12-byte CDB - incapable of extended commands.
2829 tf->flags &= ~ATA_TFLAG_LBA48;
2831 tf->feature = cdb[3];
2832 tf->nsect = cdb[4];
2833 tf->lbal = cdb[5];
2834 tf->lbam = cdb[6];
2835 tf->lbah = cdb[7];
2836 tf->device = cdb[8];
2837 tf->command = cdb[9];
2840 /* enforce correct master/slave bit */
2841 tf->device = dev->devno ?
2842 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2844 /* sanity check for pio multi commands */
2845 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2846 goto invalid_fld;
2848 if (is_multi_taskfile(tf)) {
2849 unsigned int multi_count = 1 << (cdb[1] >> 5);
2851 /* compare the passed through multi_count
2852 * with the cached multi_count of libata
2854 if (multi_count != dev->multi_count)
2855 ata_dev_printk(dev, KERN_WARNING,
2856 "invalid multi_count %u ignored\n",
2857 multi_count);
2860 /* READ/WRITE LONG use a non-standard sect_size */
2861 qc->sect_size = ATA_SECT_SIZE;
2862 switch (tf->command) {
2863 case ATA_CMD_READ_LONG:
2864 case ATA_CMD_READ_LONG_ONCE:
2865 case ATA_CMD_WRITE_LONG:
2866 case ATA_CMD_WRITE_LONG_ONCE:
2867 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2868 goto invalid_fld;
2869 qc->sect_size = scsi_bufflen(scmd);
2873 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2874 * SET_FEATURES - XFER MODE must be preceded/succeeded
2875 * by an update to hardware-specific registers for each
2876 * controller (i.e. the reason for ->set_piomode(),
2877 * ->set_dmamode(), and ->post_set_mode() hooks).
2879 if ((tf->command == ATA_CMD_SET_FEATURES)
2880 && (tf->feature == SETFEATURES_XFER))
2881 goto invalid_fld;
2884 * Set flags so that all registers will be written,
2885 * and pass on write indication (used for PIO/DMA
2886 * setup.)
2888 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2890 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2891 tf->flags |= ATA_TFLAG_WRITE;
2894 * Set transfer length.
2896 * TODO: find out if we need to do more here to
2897 * cover scatter/gather case.
2899 ata_qc_set_pc_nbytes(qc);
2901 /* request result TF and be quiet about device error */
2902 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2904 return 0;
2906 invalid_fld:
2907 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2908 /* "Invalid field in cdb" */
2909 return 1;
2913 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2914 * @dev: ATA device
2915 * @cmd: SCSI command opcode to consider
2917 * Look up the SCSI command given, and determine whether the
2918 * SCSI command is to be translated or simulated.
2920 * RETURNS:
2921 * Pointer to translation function if possible, %NULL if not.
2924 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2926 switch (cmd) {
2927 case READ_6:
2928 case READ_10:
2929 case READ_16:
2931 case WRITE_6:
2932 case WRITE_10:
2933 case WRITE_16:
2934 return ata_scsi_rw_xlat;
2936 case SYNCHRONIZE_CACHE:
2937 if (ata_try_flush_cache(dev))
2938 return ata_scsi_flush_xlat;
2939 break;
2941 case VERIFY:
2942 case VERIFY_16:
2943 return ata_scsi_verify_xlat;
2945 case ATA_12:
2946 case ATA_16:
2947 return ata_scsi_pass_thru;
2949 case START_STOP:
2950 return ata_scsi_start_stop_xlat;
2953 return NULL;
2957 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2958 * @ap: ATA port to which the command was being sent
2959 * @cmd: SCSI command to dump
2961 * Prints the contents of a SCSI command via printk().
2964 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2965 struct scsi_cmnd *cmd)
2967 #ifdef ATA_DEBUG
2968 struct scsi_device *scsidev = cmd->device;
2969 u8 *scsicmd = cmd->cmnd;
2971 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2972 ap->print_id,
2973 scsidev->channel, scsidev->id, scsidev->lun,
2974 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2975 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2976 scsicmd[8]);
2977 #endif
2980 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2981 void (*done)(struct scsi_cmnd *),
2982 struct ata_device *dev)
2984 u8 scsi_op = scmd->cmnd[0];
2985 ata_xlat_func_t xlat_func;
2986 int rc = 0;
2988 if (dev->class == ATA_DEV_ATA) {
2989 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
2990 goto bad_cdb_len;
2992 xlat_func = ata_get_xlat_func(dev, scsi_op);
2993 } else {
2994 if (unlikely(!scmd->cmd_len))
2995 goto bad_cdb_len;
2997 xlat_func = NULL;
2998 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
2999 /* relay SCSI command to ATAPI device */
3000 int len = COMMAND_SIZE(scsi_op);
3001 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3002 goto bad_cdb_len;
3004 xlat_func = atapi_xlat;
3005 } else {
3006 /* ATA_16 passthru, treat as an ATA command */
3007 if (unlikely(scmd->cmd_len > 16))
3008 goto bad_cdb_len;
3010 xlat_func = ata_get_xlat_func(dev, scsi_op);
3014 if (xlat_func)
3015 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
3016 else
3017 ata_scsi_simulate(dev, scmd, done);
3019 return rc;
3021 bad_cdb_len:
3022 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3023 scmd->cmd_len, scsi_op, dev->cdb_len);
3024 scmd->result = DID_ERROR << 16;
3025 done(scmd);
3026 return 0;
3030 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3031 * @cmd: SCSI command to be sent
3032 * @done: Completion function, called when command is complete
3034 * In some cases, this function translates SCSI commands into
3035 * ATA taskfiles, and queues the taskfiles to be sent to
3036 * hardware. In other cases, this function simulates a
3037 * SCSI device by evaluating and responding to certain
3038 * SCSI commands. This creates the overall effect of
3039 * ATA and ATAPI devices appearing as SCSI devices.
3041 * LOCKING:
3042 * Releases scsi-layer-held lock, and obtains host lock.
3044 * RETURNS:
3045 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3046 * 0 otherwise.
3048 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3050 struct ata_port *ap;
3051 struct ata_device *dev;
3052 struct scsi_device *scsidev = cmd->device;
3053 struct Scsi_Host *shost = scsidev->host;
3054 int rc = 0;
3056 ap = ata_shost_to_port(shost);
3058 spin_unlock(shost->host_lock);
3059 spin_lock(ap->lock);
3061 ata_scsi_dump_cdb(ap, cmd);
3063 dev = ata_scsi_find_dev(ap, scsidev);
3064 if (likely(dev))
3065 rc = __ata_scsi_queuecmd(cmd, done, dev);
3066 else {
3067 cmd->result = (DID_BAD_TARGET << 16);
3068 done(cmd);
3071 spin_unlock(ap->lock);
3072 spin_lock(shost->host_lock);
3073 return rc;
3077 * ata_scsi_simulate - simulate SCSI command on ATA device
3078 * @dev: the target device
3079 * @cmd: SCSI command being sent to device.
3080 * @done: SCSI command completion function.
3082 * Interprets and directly executes a select list of SCSI commands
3083 * that can be handled internally.
3085 * LOCKING:
3086 * spin_lock_irqsave(host lock)
3089 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3090 void (*done)(struct scsi_cmnd *))
3092 struct ata_scsi_args args;
3093 const u8 *scsicmd = cmd->cmnd;
3094 u8 tmp8;
3096 args.dev = dev;
3097 args.id = dev->id;
3098 args.cmd = cmd;
3099 args.done = done;
3101 switch(scsicmd[0]) {
3102 /* TODO: worth improving? */
3103 case FORMAT_UNIT:
3104 ata_scsi_invalid_field(cmd, done);
3105 break;
3107 case INQUIRY:
3108 if (scsicmd[1] & 2) /* is CmdDt set? */
3109 ata_scsi_invalid_field(cmd, done);
3110 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3111 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3112 else switch (scsicmd[2]) {
3113 case 0x00:
3114 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3115 break;
3116 case 0x80:
3117 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3118 break;
3119 case 0x83:
3120 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3121 break;
3122 case 0x89:
3123 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3124 break;
3125 case 0xb1:
3126 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3127 break;
3128 default:
3129 ata_scsi_invalid_field(cmd, done);
3130 break;
3132 break;
3134 case MODE_SENSE:
3135 case MODE_SENSE_10:
3136 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3137 break;
3139 case MODE_SELECT: /* unconditionally return */
3140 case MODE_SELECT_10: /* bad-field-in-cdb */
3141 ata_scsi_invalid_field(cmd, done);
3142 break;
3144 case READ_CAPACITY:
3145 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3146 break;
3148 case SERVICE_ACTION_IN:
3149 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3150 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3151 else
3152 ata_scsi_invalid_field(cmd, done);
3153 break;
3155 case REPORT_LUNS:
3156 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3157 break;
3159 case REQUEST_SENSE:
3160 ata_scsi_set_sense(cmd, 0, 0, 0);
3161 cmd->result = (DRIVER_SENSE << 24);
3162 done(cmd);
3163 break;
3165 /* if we reach this, then writeback caching is disabled,
3166 * turning this into a no-op.
3168 case SYNCHRONIZE_CACHE:
3169 /* fall through */
3171 /* no-op's, complete with success */
3172 case REZERO_UNIT:
3173 case SEEK_6:
3174 case SEEK_10:
3175 case TEST_UNIT_READY:
3176 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3177 break;
3179 case SEND_DIAGNOSTIC:
3180 tmp8 = scsicmd[1] & ~(1 << 3);
3181 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3182 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3183 else
3184 ata_scsi_invalid_field(cmd, done);
3185 break;
3187 /* all other commands */
3188 default:
3189 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3190 /* "Invalid command operation code" */
3191 done(cmd);
3192 break;
3196 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3198 int i, rc;
3200 for (i = 0; i < host->n_ports; i++) {
3201 struct ata_port *ap = host->ports[i];
3202 struct Scsi_Host *shost;
3204 rc = -ENOMEM;
3205 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3206 if (!shost)
3207 goto err_alloc;
3209 *(struct ata_port **)&shost->hostdata[0] = ap;
3210 ap->scsi_host = shost;
3212 shost->transportt = &ata_scsi_transport_template;
3213 shost->unique_id = ap->print_id;
3214 shost->max_id = 16;
3215 shost->max_lun = 1;
3216 shost->max_channel = 1;
3217 shost->max_cmd_len = 16;
3219 /* Schedule policy is determined by ->qc_defer()
3220 * callback and it needs to see every deferred qc.
3221 * Set host_blocked to 1 to prevent SCSI midlayer from
3222 * automatically deferring requests.
3224 shost->max_host_blocked = 1;
3226 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3227 if (rc)
3228 goto err_add;
3231 return 0;
3233 err_add:
3234 scsi_host_put(host->ports[i]->scsi_host);
3235 err_alloc:
3236 while (--i >= 0) {
3237 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3239 scsi_remove_host(shost);
3240 scsi_host_put(shost);
3242 return rc;
3245 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3247 int tries = 5;
3248 struct ata_device *last_failed_dev = NULL;
3249 struct ata_link *link;
3250 struct ata_device *dev;
3252 if (ap->flags & ATA_FLAG_DISABLED)
3253 return;
3255 repeat:
3256 ata_for_each_link(link, ap, EDGE) {
3257 ata_for_each_dev(dev, link, ENABLED) {
3258 struct scsi_device *sdev;
3259 int channel = 0, id = 0;
3261 if (dev->sdev)
3262 continue;
3264 if (ata_is_host_link(link))
3265 id = dev->devno;
3266 else
3267 channel = link->pmp;
3269 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3270 NULL);
3271 if (!IS_ERR(sdev)) {
3272 dev->sdev = sdev;
3273 scsi_device_put(sdev);
3278 /* If we scanned while EH was in progress or allocation
3279 * failure occurred, scan would have failed silently. Check
3280 * whether all devices are attached.
3282 ata_for_each_link(link, ap, EDGE) {
3283 ata_for_each_dev(dev, link, ENABLED) {
3284 if (!dev->sdev)
3285 goto exit_loop;
3288 exit_loop:
3289 if (!link)
3290 return;
3292 /* we're missing some SCSI devices */
3293 if (sync) {
3294 /* If caller requested synchrnous scan && we've made
3295 * any progress, sleep briefly and repeat.
3297 if (dev != last_failed_dev) {
3298 msleep(100);
3299 last_failed_dev = dev;
3300 goto repeat;
3303 /* We might be failing to detect boot device, give it
3304 * a few more chances.
3306 if (--tries) {
3307 msleep(100);
3308 goto repeat;
3311 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3312 "failed without making any progress,\n"
3313 " switching to async\n");
3316 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3317 round_jiffies_relative(HZ));
3321 * ata_scsi_offline_dev - offline attached SCSI device
3322 * @dev: ATA device to offline attached SCSI device for
3324 * This function is called from ata_eh_hotplug() and responsible
3325 * for taking the SCSI device attached to @dev offline. This
3326 * function is called with host lock which protects dev->sdev
3327 * against clearing.
3329 * LOCKING:
3330 * spin_lock_irqsave(host lock)
3332 * RETURNS:
3333 * 1 if attached SCSI device exists, 0 otherwise.
3335 int ata_scsi_offline_dev(struct ata_device *dev)
3337 if (dev->sdev) {
3338 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3339 return 1;
3341 return 0;
3345 * ata_scsi_remove_dev - remove attached SCSI device
3346 * @dev: ATA device to remove attached SCSI device for
3348 * This function is called from ata_eh_scsi_hotplug() and
3349 * responsible for removing the SCSI device attached to @dev.
3351 * LOCKING:
3352 * Kernel thread context (may sleep).
3354 static void ata_scsi_remove_dev(struct ata_device *dev)
3356 struct ata_port *ap = dev->link->ap;
3357 struct scsi_device *sdev;
3358 unsigned long flags;
3360 /* Alas, we need to grab scan_mutex to ensure SCSI device
3361 * state doesn't change underneath us and thus
3362 * scsi_device_get() always succeeds. The mutex locking can
3363 * be removed if there is __scsi_device_get() interface which
3364 * increments reference counts regardless of device state.
3366 mutex_lock(&ap->scsi_host->scan_mutex);
3367 spin_lock_irqsave(ap->lock, flags);
3369 /* clearing dev->sdev is protected by host lock */
3370 sdev = dev->sdev;
3371 dev->sdev = NULL;
3373 if (sdev) {
3374 /* If user initiated unplug races with us, sdev can go
3375 * away underneath us after the host lock and
3376 * scan_mutex are released. Hold onto it.
3378 if (scsi_device_get(sdev) == 0) {
3379 /* The following ensures the attached sdev is
3380 * offline on return from ata_scsi_offline_dev()
3381 * regardless it wins or loses the race
3382 * against this function.
3384 scsi_device_set_state(sdev, SDEV_OFFLINE);
3385 } else {
3386 WARN_ON(1);
3387 sdev = NULL;
3391 spin_unlock_irqrestore(ap->lock, flags);
3392 mutex_unlock(&ap->scsi_host->scan_mutex);
3394 if (sdev) {
3395 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3396 dev_name(&sdev->sdev_gendev));
3398 scsi_remove_device(sdev);
3399 scsi_device_put(sdev);
3403 static void ata_scsi_handle_link_detach(struct ata_link *link)
3405 struct ata_port *ap = link->ap;
3406 struct ata_device *dev;
3408 ata_for_each_dev(dev, link, ALL) {
3409 unsigned long flags;
3411 if (!(dev->flags & ATA_DFLAG_DETACHED))
3412 continue;
3414 spin_lock_irqsave(ap->lock, flags);
3415 dev->flags &= ~ATA_DFLAG_DETACHED;
3416 spin_unlock_irqrestore(ap->lock, flags);
3418 ata_scsi_remove_dev(dev);
3423 * ata_scsi_media_change_notify - send media change event
3424 * @dev: Pointer to the disk device with media change event
3426 * Tell the block layer to send a media change notification
3427 * event.
3429 * LOCKING:
3430 * spin_lock_irqsave(host lock)
3432 void ata_scsi_media_change_notify(struct ata_device *dev)
3434 if (dev->sdev)
3435 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3436 GFP_ATOMIC);
3440 * ata_scsi_hotplug - SCSI part of hotplug
3441 * @work: Pointer to ATA port to perform SCSI hotplug on
3443 * Perform SCSI part of hotplug. It's executed from a separate
3444 * workqueue after EH completes. This is necessary because SCSI
3445 * hot plugging requires working EH and hot unplugging is
3446 * synchronized with hot plugging with a mutex.
3448 * LOCKING:
3449 * Kernel thread context (may sleep).
3451 void ata_scsi_hotplug(struct work_struct *work)
3453 struct ata_port *ap =
3454 container_of(work, struct ata_port, hotplug_task.work);
3455 int i;
3457 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3458 DPRINTK("ENTER/EXIT - unloading\n");
3459 return;
3462 DPRINTK("ENTER\n");
3464 /* Unplug detached devices. We cannot use link iterator here
3465 * because PMP links have to be scanned even if PMP is
3466 * currently not attached. Iterate manually.
3468 ata_scsi_handle_link_detach(&ap->link);
3469 if (ap->pmp_link)
3470 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3471 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3473 /* scan for new ones */
3474 ata_scsi_scan_host(ap, 0);
3476 DPRINTK("EXIT\n");
3480 * ata_scsi_user_scan - indication for user-initiated bus scan
3481 * @shost: SCSI host to scan
3482 * @channel: Channel to scan
3483 * @id: ID to scan
3484 * @lun: LUN to scan
3486 * This function is called when user explicitly requests bus
3487 * scan. Set probe pending flag and invoke EH.
3489 * LOCKING:
3490 * SCSI layer (we don't care)
3492 * RETURNS:
3493 * Zero.
3495 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3496 unsigned int id, unsigned int lun)
3498 struct ata_port *ap = ata_shost_to_port(shost);
3499 unsigned long flags;
3500 int devno, rc = 0;
3502 if (!ap->ops->error_handler)
3503 return -EOPNOTSUPP;
3505 if (lun != SCAN_WILD_CARD && lun)
3506 return -EINVAL;
3508 if (!sata_pmp_attached(ap)) {
3509 if (channel != SCAN_WILD_CARD && channel)
3510 return -EINVAL;
3511 devno = id;
3512 } else {
3513 if (id != SCAN_WILD_CARD && id)
3514 return -EINVAL;
3515 devno = channel;
3518 spin_lock_irqsave(ap->lock, flags);
3520 if (devno == SCAN_WILD_CARD) {
3521 struct ata_link *link;
3523 ata_for_each_link(link, ap, EDGE) {
3524 struct ata_eh_info *ehi = &link->eh_info;
3525 ehi->probe_mask |= ATA_ALL_DEVICES;
3526 ehi->action |= ATA_EH_RESET;
3528 } else {
3529 struct ata_device *dev = ata_find_dev(ap, devno);
3531 if (dev) {
3532 struct ata_eh_info *ehi = &dev->link->eh_info;
3533 ehi->probe_mask |= 1 << dev->devno;
3534 ehi->action |= ATA_EH_RESET;
3535 } else
3536 rc = -EINVAL;
3539 if (rc == 0) {
3540 ata_port_schedule_eh(ap);
3541 spin_unlock_irqrestore(ap->lock, flags);
3542 ata_port_wait_eh(ap);
3543 } else
3544 spin_unlock_irqrestore(ap->lock, flags);
3546 return rc;
3550 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3551 * @work: Pointer to ATA port to perform scsi_rescan_device()
3553 * After ATA pass thru (SAT) commands are executed successfully,
3554 * libata need to propagate the changes to SCSI layer. This
3555 * function must be executed from ata_aux_wq such that sdev
3556 * attach/detach don't race with rescan.
3558 * LOCKING:
3559 * Kernel thread context (may sleep).
3561 void ata_scsi_dev_rescan(struct work_struct *work)
3563 struct ata_port *ap =
3564 container_of(work, struct ata_port, scsi_rescan_task);
3565 struct ata_link *link;
3566 struct ata_device *dev;
3567 unsigned long flags;
3569 spin_lock_irqsave(ap->lock, flags);
3571 ata_for_each_link(link, ap, EDGE) {
3572 ata_for_each_dev(dev, link, ENABLED) {
3573 struct scsi_device *sdev = dev->sdev;
3575 if (!sdev)
3576 continue;
3577 if (scsi_device_get(sdev))
3578 continue;
3580 spin_unlock_irqrestore(ap->lock, flags);
3581 scsi_rescan_device(&(sdev->sdev_gendev));
3582 scsi_device_put(sdev);
3583 spin_lock_irqsave(ap->lock, flags);
3587 spin_unlock_irqrestore(ap->lock, flags);
3591 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3592 * @host: ATA host container for all SAS ports
3593 * @port_info: Information from low-level host driver
3594 * @shost: SCSI host that the scsi device is attached to
3596 * LOCKING:
3597 * PCI/etc. bus probe sem.
3599 * RETURNS:
3600 * ata_port pointer on success / NULL on failure.
3603 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3604 struct ata_port_info *port_info,
3605 struct Scsi_Host *shost)
3607 struct ata_port *ap;
3609 ap = ata_port_alloc(host);
3610 if (!ap)
3611 return NULL;
3613 ap->port_no = 0;
3614 ap->lock = shost->host_lock;
3615 ap->pio_mask = port_info->pio_mask;
3616 ap->mwdma_mask = port_info->mwdma_mask;
3617 ap->udma_mask = port_info->udma_mask;
3618 ap->flags |= port_info->flags;
3619 ap->ops = port_info->port_ops;
3620 ap->cbl = ATA_CBL_SATA;
3622 return ap;
3624 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3627 * ata_sas_port_start - Set port up for dma.
3628 * @ap: Port to initialize
3630 * Called just after data structures for each port are
3631 * initialized.
3633 * May be used as the port_start() entry in ata_port_operations.
3635 * LOCKING:
3636 * Inherited from caller.
3638 int ata_sas_port_start(struct ata_port *ap)
3640 return 0;
3642 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3645 * ata_port_stop - Undo ata_sas_port_start()
3646 * @ap: Port to shut down
3648 * May be used as the port_stop() entry in ata_port_operations.
3650 * LOCKING:
3651 * Inherited from caller.
3654 void ata_sas_port_stop(struct ata_port *ap)
3657 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3660 * ata_sas_port_init - Initialize a SATA device
3661 * @ap: SATA port to initialize
3663 * LOCKING:
3664 * PCI/etc. bus probe sem.
3666 * RETURNS:
3667 * Zero on success, non-zero on error.
3670 int ata_sas_port_init(struct ata_port *ap)
3672 int rc = ap->ops->port_start(ap);
3674 if (!rc) {
3675 ap->print_id = ata_print_id++;
3676 rc = ata_bus_probe(ap);
3679 return rc;
3681 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3684 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3685 * @ap: SATA port to destroy
3689 void ata_sas_port_destroy(struct ata_port *ap)
3691 if (ap->ops->port_stop)
3692 ap->ops->port_stop(ap);
3693 kfree(ap);
3695 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3698 * ata_sas_slave_configure - Default slave_config routine for libata devices
3699 * @sdev: SCSI device to configure
3700 * @ap: ATA port to which SCSI device is attached
3702 * RETURNS:
3703 * Zero.
3706 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3708 ata_scsi_sdev_config(sdev);
3709 ata_scsi_dev_config(sdev, ap->link.device);
3710 return 0;
3712 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3715 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3716 * @cmd: SCSI command to be sent
3717 * @done: Completion function, called when command is complete
3718 * @ap: ATA port to which the command is being sent
3720 * RETURNS:
3721 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3722 * 0 otherwise.
3725 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3726 struct ata_port *ap)
3728 int rc = 0;
3730 ata_scsi_dump_cdb(ap, cmd);
3732 if (likely(ata_dev_enabled(ap->link.device)))
3733 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3734 else {
3735 cmd->result = (DID_BAD_TARGET << 16);
3736 done(cmd);
3738 return rc;
3740 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);