Merge tag 'gpio-for-v3.11-3' of git://git.kernel.org/pub/scm/linux/kernel/git/linusw...
[linux-2.6.git] / drivers / ata / libata-scsi.c
blobb1e880a3c3dabb9b5bd253da522c8879632d993c
1 /*
2 * libata-scsi.c - helper library for ATA
4 * Maintained by: Tejun Heo <tj@kernel.org>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
36 #include <linux/slab.h>
37 #include <linux/kernel.h>
38 #include <linux/blkdev.h>
39 #include <linux/spinlock.h>
40 #include <linux/export.h>
41 #include <scsi/scsi.h>
42 #include <scsi/scsi_host.h>
43 #include <scsi/scsi_cmnd.h>
44 #include <scsi/scsi_eh.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_tcq.h>
47 #include <scsi/scsi_transport.h>
48 #include <linux/libata.h>
49 #include <linux/hdreg.h>
50 #include <linux/uaccess.h>
51 #include <linux/suspend.h>
52 #include <linux/pm_qos.h>
53 #include <asm/unaligned.h>
55 #include "libata.h"
56 #include "libata-transport.h"
58 #define ATA_SCSI_RBUF_SIZE 4096
60 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
61 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
63 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
65 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
66 const struct scsi_device *scsidev);
67 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
68 const struct scsi_device *scsidev);
70 #define RW_RECOVERY_MPAGE 0x1
71 #define RW_RECOVERY_MPAGE_LEN 12
72 #define CACHE_MPAGE 0x8
73 #define CACHE_MPAGE_LEN 20
74 #define CONTROL_MPAGE 0xa
75 #define CONTROL_MPAGE_LEN 12
76 #define ALL_MPAGES 0x3f
77 #define ALL_SUB_MPAGES 0xff
80 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
81 RW_RECOVERY_MPAGE,
82 RW_RECOVERY_MPAGE_LEN - 2,
83 (1 << 7), /* AWRE */
84 0, /* read retry count */
85 0, 0, 0, 0,
86 0, /* write retry count */
87 0, 0, 0
90 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
91 CACHE_MPAGE,
92 CACHE_MPAGE_LEN - 2,
93 0, /* contains WCE, needs to be 0 for logic */
94 0, 0, 0, 0, 0, 0, 0, 0, 0,
95 0, /* contains DRA, needs to be 0 for logic */
96 0, 0, 0, 0, 0, 0, 0
99 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
100 CONTROL_MPAGE,
101 CONTROL_MPAGE_LEN - 2,
102 2, /* DSENSE=0, GLTSD=1 */
103 0, /* [QAM+QERR may be 1, see 05-359r1] */
104 0, 0, 0, 0, 0xff, 0xff,
105 0, 30 /* extended self test time, see 05-359r1 */
108 static const char *ata_lpm_policy_names[] = {
109 [ATA_LPM_UNKNOWN] = "max_performance",
110 [ATA_LPM_MAX_POWER] = "max_performance",
111 [ATA_LPM_MED_POWER] = "medium_power",
112 [ATA_LPM_MIN_POWER] = "min_power",
115 static ssize_t ata_scsi_lpm_store(struct device *dev,
116 struct device_attribute *attr,
117 const char *buf, size_t count)
119 struct Scsi_Host *shost = class_to_shost(dev);
120 struct ata_port *ap = ata_shost_to_port(shost);
121 enum ata_lpm_policy policy;
122 unsigned long flags;
124 /* UNKNOWN is internal state, iterate from MAX_POWER */
125 for (policy = ATA_LPM_MAX_POWER;
126 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
127 const char *name = ata_lpm_policy_names[policy];
129 if (strncmp(name, buf, strlen(name)) == 0)
130 break;
132 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
133 return -EINVAL;
135 spin_lock_irqsave(ap->lock, flags);
136 ap->target_lpm_policy = policy;
137 ata_port_schedule_eh(ap);
138 spin_unlock_irqrestore(ap->lock, flags);
140 return count;
143 static ssize_t ata_scsi_lpm_show(struct device *dev,
144 struct device_attribute *attr, char *buf)
146 struct Scsi_Host *shost = class_to_shost(dev);
147 struct ata_port *ap = ata_shost_to_port(shost);
149 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
150 return -EINVAL;
152 return snprintf(buf, PAGE_SIZE, "%s\n",
153 ata_lpm_policy_names[ap->target_lpm_policy]);
155 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
156 ata_scsi_lpm_show, ata_scsi_lpm_store);
157 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
159 static ssize_t ata_scsi_park_show(struct device *device,
160 struct device_attribute *attr, char *buf)
162 struct scsi_device *sdev = to_scsi_device(device);
163 struct ata_port *ap;
164 struct ata_link *link;
165 struct ata_device *dev;
166 unsigned long flags, now;
167 unsigned int uninitialized_var(msecs);
168 int rc = 0;
170 ap = ata_shost_to_port(sdev->host);
172 spin_lock_irqsave(ap->lock, flags);
173 dev = ata_scsi_find_dev(ap, sdev);
174 if (!dev) {
175 rc = -ENODEV;
176 goto unlock;
178 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
179 rc = -EOPNOTSUPP;
180 goto unlock;
183 link = dev->link;
184 now = jiffies;
185 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
186 link->eh_context.unloaded_mask & (1 << dev->devno) &&
187 time_after(dev->unpark_deadline, now))
188 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
189 else
190 msecs = 0;
192 unlock:
193 spin_unlock_irq(ap->lock);
195 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
198 static ssize_t ata_scsi_park_store(struct device *device,
199 struct device_attribute *attr,
200 const char *buf, size_t len)
202 struct scsi_device *sdev = to_scsi_device(device);
203 struct ata_port *ap;
204 struct ata_device *dev;
205 long int input;
206 unsigned long flags;
207 int rc;
209 rc = kstrtol(buf, 10, &input);
210 if (rc)
211 return rc;
212 if (input < -2)
213 return -EINVAL;
214 if (input > ATA_TMOUT_MAX_PARK) {
215 rc = -EOVERFLOW;
216 input = ATA_TMOUT_MAX_PARK;
219 ap = ata_shost_to_port(sdev->host);
221 spin_lock_irqsave(ap->lock, flags);
222 dev = ata_scsi_find_dev(ap, sdev);
223 if (unlikely(!dev)) {
224 rc = -ENODEV;
225 goto unlock;
227 if (dev->class != ATA_DEV_ATA) {
228 rc = -EOPNOTSUPP;
229 goto unlock;
232 if (input >= 0) {
233 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
234 rc = -EOPNOTSUPP;
235 goto unlock;
238 dev->unpark_deadline = ata_deadline(jiffies, input);
239 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
240 ata_port_schedule_eh(ap);
241 complete(&ap->park_req_pending);
242 } else {
243 switch (input) {
244 case -1:
245 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
246 break;
247 case -2:
248 dev->flags |= ATA_DFLAG_NO_UNLOAD;
249 break;
252 unlock:
253 spin_unlock_irqrestore(ap->lock, flags);
255 return rc ? rc : len;
257 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
258 ata_scsi_park_show, ata_scsi_park_store);
259 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
261 static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
263 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
265 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
268 static ssize_t
269 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
270 const char *buf, size_t count)
272 struct Scsi_Host *shost = class_to_shost(dev);
273 struct ata_port *ap = ata_shost_to_port(shost);
274 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
275 return ap->ops->em_store(ap, buf, count);
276 return -EINVAL;
279 static ssize_t
280 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
281 char *buf)
283 struct Scsi_Host *shost = class_to_shost(dev);
284 struct ata_port *ap = ata_shost_to_port(shost);
286 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
287 return ap->ops->em_show(ap, buf);
288 return -EINVAL;
290 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
291 ata_scsi_em_message_show, ata_scsi_em_message_store);
292 EXPORT_SYMBOL_GPL(dev_attr_em_message);
294 static ssize_t
295 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
296 char *buf)
298 struct Scsi_Host *shost = class_to_shost(dev);
299 struct ata_port *ap = ata_shost_to_port(shost);
301 return snprintf(buf, 23, "%d\n", ap->em_message_type);
303 DEVICE_ATTR(em_message_type, S_IRUGO,
304 ata_scsi_em_message_type_show, NULL);
305 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
307 static ssize_t
308 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
309 char *buf)
311 struct scsi_device *sdev = to_scsi_device(dev);
312 struct ata_port *ap = ata_shost_to_port(sdev->host);
313 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
315 if (atadev && ap->ops->sw_activity_show &&
316 (ap->flags & ATA_FLAG_SW_ACTIVITY))
317 return ap->ops->sw_activity_show(atadev, buf);
318 return -EINVAL;
321 static ssize_t
322 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
323 const char *buf, size_t count)
325 struct scsi_device *sdev = to_scsi_device(dev);
326 struct ata_port *ap = ata_shost_to_port(sdev->host);
327 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
328 enum sw_activity val;
329 int rc;
331 if (atadev && ap->ops->sw_activity_store &&
332 (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
333 val = simple_strtoul(buf, NULL, 0);
334 switch (val) {
335 case OFF: case BLINK_ON: case BLINK_OFF:
336 rc = ap->ops->sw_activity_store(atadev, val);
337 if (!rc)
338 return count;
339 else
340 return rc;
343 return -EINVAL;
345 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
346 ata_scsi_activity_store);
347 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
349 struct device_attribute *ata_common_sdev_attrs[] = {
350 &dev_attr_unload_heads,
351 NULL
353 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
355 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd)
357 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
358 /* "Invalid field in cbd" */
359 cmd->scsi_done(cmd);
363 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
364 * @sdev: SCSI device for which BIOS geometry is to be determined
365 * @bdev: block device associated with @sdev
366 * @capacity: capacity of SCSI device
367 * @geom: location to which geometry will be output
369 * Generic bios head/sector/cylinder calculator
370 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
371 * mapping. Some situations may arise where the disk is not
372 * bootable if this is not used.
374 * LOCKING:
375 * Defined by the SCSI layer. We don't really care.
377 * RETURNS:
378 * Zero.
380 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
381 sector_t capacity, int geom[])
383 geom[0] = 255;
384 geom[1] = 63;
385 sector_div(capacity, 255*63);
386 geom[2] = capacity;
388 return 0;
392 * ata_scsi_unlock_native_capacity - unlock native capacity
393 * @sdev: SCSI device to adjust device capacity for
395 * This function is called if a partition on @sdev extends beyond
396 * the end of the device. It requests EH to unlock HPA.
398 * LOCKING:
399 * Defined by the SCSI layer. Might sleep.
401 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
403 struct ata_port *ap = ata_shost_to_port(sdev->host);
404 struct ata_device *dev;
405 unsigned long flags;
407 spin_lock_irqsave(ap->lock, flags);
409 dev = ata_scsi_find_dev(ap, sdev);
410 if (dev && dev->n_sectors < dev->n_native_sectors) {
411 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
412 dev->link->eh_info.action |= ATA_EH_RESET;
413 ata_port_schedule_eh(ap);
416 spin_unlock_irqrestore(ap->lock, flags);
417 ata_port_wait_eh(ap);
421 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
422 * @ap: target port
423 * @sdev: SCSI device to get identify data for
424 * @arg: User buffer area for identify data
426 * LOCKING:
427 * Defined by the SCSI layer. We don't really care.
429 * RETURNS:
430 * Zero on success, negative errno on error.
432 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
433 void __user *arg)
435 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
436 u16 __user *dst = arg;
437 char buf[40];
439 if (!dev)
440 return -ENOMSG;
442 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
443 return -EFAULT;
445 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
446 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
447 return -EFAULT;
449 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
450 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
451 return -EFAULT;
453 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
454 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
455 return -EFAULT;
457 return 0;
461 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
462 * @scsidev: Device to which we are issuing command
463 * @arg: User provided data for issuing command
465 * LOCKING:
466 * Defined by the SCSI layer. We don't really care.
468 * RETURNS:
469 * Zero on success, negative errno on error.
471 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
473 int rc = 0;
474 u8 scsi_cmd[MAX_COMMAND_SIZE];
475 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
476 int argsize = 0;
477 enum dma_data_direction data_dir;
478 int cmd_result;
480 if (arg == NULL)
481 return -EINVAL;
483 if (copy_from_user(args, arg, sizeof(args)))
484 return -EFAULT;
486 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
487 if (!sensebuf)
488 return -ENOMEM;
490 memset(scsi_cmd, 0, sizeof(scsi_cmd));
492 if (args[3]) {
493 argsize = ATA_SECT_SIZE * args[3];
494 argbuf = kmalloc(argsize, GFP_KERNEL);
495 if (argbuf == NULL) {
496 rc = -ENOMEM;
497 goto error;
500 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
501 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
502 block count in sector count field */
503 data_dir = DMA_FROM_DEVICE;
504 } else {
505 scsi_cmd[1] = (3 << 1); /* Non-data */
506 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
507 data_dir = DMA_NONE;
510 scsi_cmd[0] = ATA_16;
512 scsi_cmd[4] = args[2];
513 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
514 scsi_cmd[6] = args[3];
515 scsi_cmd[8] = args[1];
516 scsi_cmd[10] = 0x4f;
517 scsi_cmd[12] = 0xc2;
518 } else {
519 scsi_cmd[6] = args[1];
521 scsi_cmd[14] = args[0];
523 /* Good values for timeout and retries? Values below
524 from scsi_ioctl_send_command() for default case... */
525 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
526 sensebuf, (10*HZ), 5, 0, NULL);
528 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
529 u8 *desc = sensebuf + 8;
530 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
532 /* If we set cc then ATA pass-through will cause a
533 * check condition even if no error. Filter that. */
534 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
535 struct scsi_sense_hdr sshdr;
536 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
537 &sshdr);
538 if (sshdr.sense_key == RECOVERED_ERROR &&
539 sshdr.asc == 0 && sshdr.ascq == 0x1d)
540 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
543 /* Send userspace a few ATA registers (same as drivers/ide) */
544 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
545 desc[0] == 0x09) { /* code is "ATA Descriptor" */
546 args[0] = desc[13]; /* status */
547 args[1] = desc[3]; /* error */
548 args[2] = desc[5]; /* sector count (0:7) */
549 if (copy_to_user(arg, args, sizeof(args)))
550 rc = -EFAULT;
555 if (cmd_result) {
556 rc = -EIO;
557 goto error;
560 if ((argbuf)
561 && copy_to_user(arg + sizeof(args), argbuf, argsize))
562 rc = -EFAULT;
563 error:
564 kfree(sensebuf);
565 kfree(argbuf);
566 return rc;
570 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
571 * @scsidev: Device to which we are issuing command
572 * @arg: User provided data for issuing command
574 * LOCKING:
575 * Defined by the SCSI layer. We don't really care.
577 * RETURNS:
578 * Zero on success, negative errno on error.
580 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
582 int rc = 0;
583 u8 scsi_cmd[MAX_COMMAND_SIZE];
584 u8 args[7], *sensebuf = NULL;
585 int cmd_result;
587 if (arg == NULL)
588 return -EINVAL;
590 if (copy_from_user(args, arg, sizeof(args)))
591 return -EFAULT;
593 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
594 if (!sensebuf)
595 return -ENOMEM;
597 memset(scsi_cmd, 0, sizeof(scsi_cmd));
598 scsi_cmd[0] = ATA_16;
599 scsi_cmd[1] = (3 << 1); /* Non-data */
600 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
601 scsi_cmd[4] = args[1];
602 scsi_cmd[6] = args[2];
603 scsi_cmd[8] = args[3];
604 scsi_cmd[10] = args[4];
605 scsi_cmd[12] = args[5];
606 scsi_cmd[13] = args[6] & 0x4f;
607 scsi_cmd[14] = args[0];
609 /* Good values for timeout and retries? Values below
610 from scsi_ioctl_send_command() for default case... */
611 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
612 sensebuf, (10*HZ), 5, 0, NULL);
614 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
615 u8 *desc = sensebuf + 8;
616 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
618 /* If we set cc then ATA pass-through will cause a
619 * check condition even if no error. Filter that. */
620 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
621 struct scsi_sense_hdr sshdr;
622 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
623 &sshdr);
624 if (sshdr.sense_key == RECOVERED_ERROR &&
625 sshdr.asc == 0 && sshdr.ascq == 0x1d)
626 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
629 /* Send userspace ATA registers */
630 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
631 desc[0] == 0x09) {/* code is "ATA Descriptor" */
632 args[0] = desc[13]; /* status */
633 args[1] = desc[3]; /* error */
634 args[2] = desc[5]; /* sector count (0:7) */
635 args[3] = desc[7]; /* lbal */
636 args[4] = desc[9]; /* lbam */
637 args[5] = desc[11]; /* lbah */
638 args[6] = desc[12]; /* select */
639 if (copy_to_user(arg, args, sizeof(args)))
640 rc = -EFAULT;
644 if (cmd_result) {
645 rc = -EIO;
646 goto error;
649 error:
650 kfree(sensebuf);
651 return rc;
654 static int ata_ioc32(struct ata_port *ap)
656 if (ap->flags & ATA_FLAG_PIO_DMA)
657 return 1;
658 if (ap->pflags & ATA_PFLAG_PIO32)
659 return 1;
660 return 0;
663 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
664 int cmd, void __user *arg)
666 int val = -EINVAL, rc = -EINVAL;
667 unsigned long flags;
669 switch (cmd) {
670 case ATA_IOC_GET_IO32:
671 spin_lock_irqsave(ap->lock, flags);
672 val = ata_ioc32(ap);
673 spin_unlock_irqrestore(ap->lock, flags);
674 if (copy_to_user(arg, &val, 1))
675 return -EFAULT;
676 return 0;
678 case ATA_IOC_SET_IO32:
679 val = (unsigned long) arg;
680 rc = 0;
681 spin_lock_irqsave(ap->lock, flags);
682 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
683 if (val)
684 ap->pflags |= ATA_PFLAG_PIO32;
685 else
686 ap->pflags &= ~ATA_PFLAG_PIO32;
687 } else {
688 if (val != ata_ioc32(ap))
689 rc = -EINVAL;
691 spin_unlock_irqrestore(ap->lock, flags);
692 return rc;
694 case HDIO_GET_IDENTITY:
695 return ata_get_identity(ap, scsidev, arg);
697 case HDIO_DRIVE_CMD:
698 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
699 return -EACCES;
700 return ata_cmd_ioctl(scsidev, arg);
702 case HDIO_DRIVE_TASK:
703 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
704 return -EACCES;
705 return ata_task_ioctl(scsidev, arg);
707 default:
708 rc = -ENOTTY;
709 break;
712 return rc;
714 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
716 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
718 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
719 scsidev, cmd, arg);
721 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
724 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
725 * @dev: ATA device to which the new command is attached
726 * @cmd: SCSI command that originated this ATA command
728 * Obtain a reference to an unused ata_queued_cmd structure,
729 * which is the basic libata structure representing a single
730 * ATA command sent to the hardware.
732 * If a command was available, fill in the SCSI-specific
733 * portions of the structure with information on the
734 * current command.
736 * LOCKING:
737 * spin_lock_irqsave(host lock)
739 * RETURNS:
740 * Command allocated, or %NULL if none available.
742 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
743 struct scsi_cmnd *cmd)
745 struct ata_queued_cmd *qc;
747 qc = ata_qc_new_init(dev);
748 if (qc) {
749 qc->scsicmd = cmd;
750 qc->scsidone = cmd->scsi_done;
752 qc->sg = scsi_sglist(cmd);
753 qc->n_elem = scsi_sg_count(cmd);
754 } else {
755 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
756 cmd->scsi_done(cmd);
759 return qc;
762 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
764 struct scsi_cmnd *scmd = qc->scsicmd;
766 qc->extrabytes = scmd->request->extra_len;
767 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
771 * ata_dump_status - user friendly display of error info
772 * @id: id of the port in question
773 * @tf: ptr to filled out taskfile
775 * Decode and dump the ATA error/status registers for the user so
776 * that they have some idea what really happened at the non
777 * make-believe layer.
779 * LOCKING:
780 * inherited from caller
782 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
784 u8 stat = tf->command, err = tf->feature;
786 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
787 if (stat & ATA_BUSY) {
788 printk("Busy }\n"); /* Data is not valid in this case */
789 } else {
790 if (stat & 0x40) printk("DriveReady ");
791 if (stat & 0x20) printk("DeviceFault ");
792 if (stat & 0x10) printk("SeekComplete ");
793 if (stat & 0x08) printk("DataRequest ");
794 if (stat & 0x04) printk("CorrectedError ");
795 if (stat & 0x02) printk("Index ");
796 if (stat & 0x01) printk("Error ");
797 printk("}\n");
799 if (err) {
800 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
801 if (err & 0x04) printk("DriveStatusError ");
802 if (err & 0x80) {
803 if (err & 0x04) printk("BadCRC ");
804 else printk("Sector ");
806 if (err & 0x40) printk("UncorrectableError ");
807 if (err & 0x10) printk("SectorIdNotFound ");
808 if (err & 0x02) printk("TrackZeroNotFound ");
809 if (err & 0x01) printk("AddrMarkNotFound ");
810 printk("}\n");
816 * ata_to_sense_error - convert ATA error to SCSI error
817 * @id: ATA device number
818 * @drv_stat: value contained in ATA status register
819 * @drv_err: value contained in ATA error register
820 * @sk: the sense key we'll fill out
821 * @asc: the additional sense code we'll fill out
822 * @ascq: the additional sense code qualifier we'll fill out
823 * @verbose: be verbose
825 * Converts an ATA error into a SCSI error. Fill out pointers to
826 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
827 * format sense blocks.
829 * LOCKING:
830 * spin_lock_irqsave(host lock)
832 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
833 u8 *asc, u8 *ascq, int verbose)
835 int i;
837 /* Based on the 3ware driver translation table */
838 static const unsigned char sense_table[][4] = {
839 /* BBD|ECC|ID|MAR */
840 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
841 /* BBD|ECC|ID */
842 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
843 /* ECC|MC|MARK */
844 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
845 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
846 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
847 /* MC|ID|ABRT|TRK0|MARK */
848 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
849 /* MCR|MARK */
850 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
851 /* Bad address mark */
852 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
853 /* TRK0 */
854 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
855 /* Abort: 0x04 is not translated here, see below */
856 /* Media change request */
857 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
858 /* SRV/IDNF */
859 {0x10, ILLEGAL_REQUEST, 0x21, 0x00}, // ID not found Logical address out of range
860 /* MC */
861 {0x20, UNIT_ATTENTION, 0x28, 0x00}, // Media Changed Not ready to ready change, medium may have changed
862 /* ECC */
863 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
864 /* BBD - block marked bad */
865 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
866 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
868 static const unsigned char stat_table[][4] = {
869 /* Must be first because BUSY means no other bits valid */
870 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
871 {0x20, HARDWARE_ERROR, 0x44, 0x00}, // Device fault, internal target failure
872 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
873 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
874 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
878 * Is this an error we can process/parse
880 if (drv_stat & ATA_BUSY) {
881 drv_err = 0; /* Ignore the err bits, they're invalid */
884 if (drv_err) {
885 /* Look for drv_err */
886 for (i = 0; sense_table[i][0] != 0xFF; i++) {
887 /* Look for best matches first */
888 if ((sense_table[i][0] & drv_err) ==
889 sense_table[i][0]) {
890 *sk = sense_table[i][1];
891 *asc = sense_table[i][2];
892 *ascq = sense_table[i][3];
893 goto translate_done;
899 * Fall back to interpreting status bits. Note that if the drv_err
900 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
901 * is not descriptive enough.
903 for (i = 0; stat_table[i][0] != 0xFF; i++) {
904 if (stat_table[i][0] & drv_stat) {
905 *sk = stat_table[i][1];
906 *asc = stat_table[i][2];
907 *ascq = stat_table[i][3];
908 goto translate_done;
913 * We need a sensible error return here, which is tricky, and one
914 * that won't cause people to do things like return a disk wrongly.
916 *sk = ABORTED_COMMAND;
917 *asc = 0x00;
918 *ascq = 0x00;
920 translate_done:
921 if (verbose)
922 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
923 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
924 id, drv_stat, drv_err, *sk, *asc, *ascq);
925 return;
929 * ata_gen_passthru_sense - Generate check condition sense block.
930 * @qc: Command that completed.
932 * This function is specific to the ATA descriptor format sense
933 * block specified for the ATA pass through commands. Regardless
934 * of whether the command errored or not, return a sense
935 * block. Copy all controller registers into the sense
936 * block. If there was no error, we get the request from an ATA
937 * passthrough command, so we use the following sense data:
938 * sk = RECOVERED ERROR
939 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
942 * LOCKING:
943 * None.
945 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
947 struct scsi_cmnd *cmd = qc->scsicmd;
948 struct ata_taskfile *tf = &qc->result_tf;
949 unsigned char *sb = cmd->sense_buffer;
950 unsigned char *desc = sb + 8;
951 int verbose = qc->ap->ops->error_handler == NULL;
953 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
955 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
958 * Use ata_to_sense_error() to map status register bits
959 * onto sense key, asc & ascq.
961 if (qc->err_mask ||
962 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
963 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
964 &sb[1], &sb[2], &sb[3], verbose);
965 sb[1] &= 0x0f;
966 } else {
967 sb[1] = RECOVERED_ERROR;
968 sb[2] = 0;
969 sb[3] = 0x1D;
973 * Sense data is current and format is descriptor.
975 sb[0] = 0x72;
977 desc[0] = 0x09;
979 /* set length of additional sense data */
980 sb[7] = 14;
981 desc[1] = 12;
984 * Copy registers into sense buffer.
986 desc[2] = 0x00;
987 desc[3] = tf->feature; /* == error reg */
988 desc[5] = tf->nsect;
989 desc[7] = tf->lbal;
990 desc[9] = tf->lbam;
991 desc[11] = tf->lbah;
992 desc[12] = tf->device;
993 desc[13] = tf->command; /* == status reg */
996 * Fill in Extend bit, and the high order bytes
997 * if applicable.
999 if (tf->flags & ATA_TFLAG_LBA48) {
1000 desc[2] |= 0x01;
1001 desc[4] = tf->hob_nsect;
1002 desc[6] = tf->hob_lbal;
1003 desc[8] = tf->hob_lbam;
1004 desc[10] = tf->hob_lbah;
1009 * ata_gen_ata_sense - generate a SCSI fixed sense block
1010 * @qc: Command that we are erroring out
1012 * Generate sense block for a failed ATA command @qc. Descriptor
1013 * format is used to accommodate LBA48 block address.
1015 * LOCKING:
1016 * None.
1018 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1020 struct ata_device *dev = qc->dev;
1021 struct scsi_cmnd *cmd = qc->scsicmd;
1022 struct ata_taskfile *tf = &qc->result_tf;
1023 unsigned char *sb = cmd->sense_buffer;
1024 unsigned char *desc = sb + 8;
1025 int verbose = qc->ap->ops->error_handler == NULL;
1026 u64 block;
1028 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1030 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1032 /* sense data is current and format is descriptor */
1033 sb[0] = 0x72;
1035 /* Use ata_to_sense_error() to map status register bits
1036 * onto sense key, asc & ascq.
1038 if (qc->err_mask ||
1039 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1040 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1041 &sb[1], &sb[2], &sb[3], verbose);
1042 sb[1] &= 0x0f;
1045 block = ata_tf_read_block(&qc->result_tf, dev);
1047 /* information sense data descriptor */
1048 sb[7] = 12;
1049 desc[0] = 0x00;
1050 desc[1] = 10;
1052 desc[2] |= 0x80; /* valid */
1053 desc[6] = block >> 40;
1054 desc[7] = block >> 32;
1055 desc[8] = block >> 24;
1056 desc[9] = block >> 16;
1057 desc[10] = block >> 8;
1058 desc[11] = block;
1061 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1063 sdev->use_10_for_rw = 1;
1064 sdev->use_10_for_ms = 1;
1065 sdev->no_report_opcodes = 1;
1066 sdev->no_write_same = 1;
1068 /* Schedule policy is determined by ->qc_defer() callback and
1069 * it needs to see every deferred qc. Set dev_blocked to 1 to
1070 * prevent SCSI midlayer from automatically deferring
1071 * requests.
1073 sdev->max_device_blocked = 1;
1077 * atapi_drain_needed - Check whether data transfer may overflow
1078 * @rq: request to be checked
1080 * ATAPI commands which transfer variable length data to host
1081 * might overflow due to application error or hardare bug. This
1082 * function checks whether overflow should be drained and ignored
1083 * for @request.
1085 * LOCKING:
1086 * None.
1088 * RETURNS:
1089 * 1 if ; otherwise, 0.
1091 static int atapi_drain_needed(struct request *rq)
1093 if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
1094 return 0;
1096 if (!blk_rq_bytes(rq) || (rq->cmd_flags & REQ_WRITE))
1097 return 0;
1099 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1102 static int ata_scsi_dev_config(struct scsi_device *sdev,
1103 struct ata_device *dev)
1105 struct request_queue *q = sdev->request_queue;
1107 if (!ata_id_has_unload(dev->id))
1108 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1110 /* configure max sectors */
1111 blk_queue_max_hw_sectors(q, dev->max_sectors);
1113 if (dev->class == ATA_DEV_ATAPI) {
1114 void *buf;
1116 sdev->sector_size = ATA_SECT_SIZE;
1118 /* set DMA padding */
1119 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1121 /* configure draining */
1122 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1123 if (!buf) {
1124 ata_dev_err(dev, "drain buffer allocation failed\n");
1125 return -ENOMEM;
1128 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1129 } else {
1130 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1131 sdev->manage_start_stop = 1;
1135 * ata_pio_sectors() expects buffer for each sector to not cross
1136 * page boundary. Enforce it by requiring buffers to be sector
1137 * aligned, which works iff sector_size is not larger than
1138 * PAGE_SIZE. ATAPI devices also need the alignment as
1139 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1141 if (sdev->sector_size > PAGE_SIZE)
1142 ata_dev_warn(dev,
1143 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1144 sdev->sector_size);
1146 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1148 if (dev->flags & ATA_DFLAG_AN)
1149 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1151 if (dev->flags & ATA_DFLAG_NCQ) {
1152 int depth;
1154 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1155 depth = min(ATA_MAX_QUEUE - 1, depth);
1156 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1159 blk_queue_flush_queueable(q, false);
1161 dev->sdev = sdev;
1162 return 0;
1166 * ata_scsi_slave_config - Set SCSI device attributes
1167 * @sdev: SCSI device to examine
1169 * This is called before we actually start reading
1170 * and writing to the device, to configure certain
1171 * SCSI mid-layer behaviors.
1173 * LOCKING:
1174 * Defined by SCSI layer. We don't really care.
1177 int ata_scsi_slave_config(struct scsi_device *sdev)
1179 struct ata_port *ap = ata_shost_to_port(sdev->host);
1180 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1181 int rc = 0;
1183 ata_scsi_sdev_config(sdev);
1185 if (dev)
1186 rc = ata_scsi_dev_config(sdev, dev);
1188 return rc;
1192 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1193 * @sdev: SCSI device to be destroyed
1195 * @sdev is about to be destroyed for hot/warm unplugging. If
1196 * this unplugging was initiated by libata as indicated by NULL
1197 * dev->sdev, this function doesn't have to do anything.
1198 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1199 * Clear dev->sdev, schedule the device for ATA detach and invoke
1200 * EH.
1202 * LOCKING:
1203 * Defined by SCSI layer. We don't really care.
1205 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1207 struct ata_port *ap = ata_shost_to_port(sdev->host);
1208 struct request_queue *q = sdev->request_queue;
1209 unsigned long flags;
1210 struct ata_device *dev;
1212 if (!ap->ops->error_handler)
1213 return;
1215 spin_lock_irqsave(ap->lock, flags);
1216 dev = __ata_scsi_find_dev(ap, sdev);
1217 if (dev && dev->sdev) {
1218 /* SCSI device already in CANCEL state, no need to offline it */
1219 dev->sdev = NULL;
1220 dev->flags |= ATA_DFLAG_DETACH;
1221 ata_port_schedule_eh(ap);
1223 spin_unlock_irqrestore(ap->lock, flags);
1225 kfree(q->dma_drain_buffer);
1226 q->dma_drain_buffer = NULL;
1227 q->dma_drain_size = 0;
1231 * __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
1232 * @ap: ATA port to which the device change the queue depth
1233 * @sdev: SCSI device to configure queue depth for
1234 * @queue_depth: new queue depth
1235 * @reason: calling context
1237 * libsas and libata have different approaches for associating a sdev to
1238 * its ata_port.
1241 int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1242 int queue_depth, int reason)
1244 struct ata_device *dev;
1245 unsigned long flags;
1247 if (reason != SCSI_QDEPTH_DEFAULT)
1248 return -EOPNOTSUPP;
1250 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1251 return sdev->queue_depth;
1253 dev = ata_scsi_find_dev(ap, sdev);
1254 if (!dev || !ata_dev_enabled(dev))
1255 return sdev->queue_depth;
1257 /* NCQ enabled? */
1258 spin_lock_irqsave(ap->lock, flags);
1259 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1260 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1261 dev->flags |= ATA_DFLAG_NCQ_OFF;
1262 queue_depth = 1;
1264 spin_unlock_irqrestore(ap->lock, flags);
1266 /* limit and apply queue depth */
1267 queue_depth = min(queue_depth, sdev->host->can_queue);
1268 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1269 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1271 if (sdev->queue_depth == queue_depth)
1272 return -EINVAL;
1274 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1275 return queue_depth;
1279 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1280 * @sdev: SCSI device to configure queue depth for
1281 * @queue_depth: new queue depth
1282 * @reason: calling context
1284 * This is libata standard hostt->change_queue_depth callback.
1285 * SCSI will call into this callback when user tries to set queue
1286 * depth via sysfs.
1288 * LOCKING:
1289 * SCSI layer (we don't care)
1291 * RETURNS:
1292 * Newly configured queue depth.
1294 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth,
1295 int reason)
1297 struct ata_port *ap = ata_shost_to_port(sdev->host);
1299 return __ata_change_queue_depth(ap, sdev, queue_depth, reason);
1303 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1304 * @qc: Storage for translated ATA taskfile
1306 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1307 * (to start). Perhaps these commands should be preceded by
1308 * CHECK POWER MODE to see what power mode the device is already in.
1309 * [See SAT revision 5 at www.t10.org]
1311 * LOCKING:
1312 * spin_lock_irqsave(host lock)
1314 * RETURNS:
1315 * Zero on success, non-zero on error.
1317 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1319 struct scsi_cmnd *scmd = qc->scsicmd;
1320 struct ata_taskfile *tf = &qc->tf;
1321 const u8 *cdb = scmd->cmnd;
1323 if (scmd->cmd_len < 5)
1324 goto invalid_fld;
1326 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1327 tf->protocol = ATA_PROT_NODATA;
1328 if (cdb[1] & 0x1) {
1329 ; /* ignore IMMED bit, violates sat-r05 */
1331 if (cdb[4] & 0x2)
1332 goto invalid_fld; /* LOEJ bit set not supported */
1333 if (((cdb[4] >> 4) & 0xf) != 0)
1334 goto invalid_fld; /* power conditions not supported */
1336 if (cdb[4] & 0x1) {
1337 tf->nsect = 1; /* 1 sector, lba=0 */
1339 if (qc->dev->flags & ATA_DFLAG_LBA) {
1340 tf->flags |= ATA_TFLAG_LBA;
1342 tf->lbah = 0x0;
1343 tf->lbam = 0x0;
1344 tf->lbal = 0x0;
1345 tf->device |= ATA_LBA;
1346 } else {
1347 /* CHS */
1348 tf->lbal = 0x1; /* sect */
1349 tf->lbam = 0x0; /* cyl low */
1350 tf->lbah = 0x0; /* cyl high */
1353 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1354 } else {
1355 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1356 * or S5) causing some drives to spin up and down again.
1358 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1359 system_state == SYSTEM_POWER_OFF)
1360 goto skip;
1362 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1363 system_entering_hibernation())
1364 goto skip;
1366 /* Issue ATA STANDBY IMMEDIATE command */
1367 tf->command = ATA_CMD_STANDBYNOW1;
1371 * Standby and Idle condition timers could be implemented but that
1372 * would require libata to implement the Power condition mode page
1373 * and allow the user to change it. Changing mode pages requires
1374 * MODE SELECT to be implemented.
1377 return 0;
1379 invalid_fld:
1380 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1381 /* "Invalid field in cbd" */
1382 return 1;
1383 skip:
1384 scmd->result = SAM_STAT_GOOD;
1385 return 1;
1390 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1391 * @qc: Storage for translated ATA taskfile
1393 * Sets up an ATA taskfile to issue FLUSH CACHE or
1394 * FLUSH CACHE EXT.
1396 * LOCKING:
1397 * spin_lock_irqsave(host lock)
1399 * RETURNS:
1400 * Zero on success, non-zero on error.
1402 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1404 struct ata_taskfile *tf = &qc->tf;
1406 tf->flags |= ATA_TFLAG_DEVICE;
1407 tf->protocol = ATA_PROT_NODATA;
1409 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1410 tf->command = ATA_CMD_FLUSH_EXT;
1411 else
1412 tf->command = ATA_CMD_FLUSH;
1414 /* flush is critical for IO integrity, consider it an IO command */
1415 qc->flags |= ATA_QCFLAG_IO;
1417 return 0;
1421 * scsi_6_lba_len - Get LBA and transfer length
1422 * @cdb: SCSI command to translate
1424 * Calculate LBA and transfer length for 6-byte commands.
1426 * RETURNS:
1427 * @plba: the LBA
1428 * @plen: the transfer length
1430 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1432 u64 lba = 0;
1433 u32 len;
1435 VPRINTK("six-byte command\n");
1437 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1438 lba |= ((u64)cdb[2]) << 8;
1439 lba |= ((u64)cdb[3]);
1441 len = cdb[4];
1443 *plba = lba;
1444 *plen = len;
1448 * scsi_10_lba_len - Get LBA and transfer length
1449 * @cdb: SCSI command to translate
1451 * Calculate LBA and transfer length for 10-byte commands.
1453 * RETURNS:
1454 * @plba: the LBA
1455 * @plen: the transfer length
1457 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1459 u64 lba = 0;
1460 u32 len = 0;
1462 VPRINTK("ten-byte command\n");
1464 lba |= ((u64)cdb[2]) << 24;
1465 lba |= ((u64)cdb[3]) << 16;
1466 lba |= ((u64)cdb[4]) << 8;
1467 lba |= ((u64)cdb[5]);
1469 len |= ((u32)cdb[7]) << 8;
1470 len |= ((u32)cdb[8]);
1472 *plba = lba;
1473 *plen = len;
1477 * scsi_16_lba_len - Get LBA and transfer length
1478 * @cdb: SCSI command to translate
1480 * Calculate LBA and transfer length for 16-byte commands.
1482 * RETURNS:
1483 * @plba: the LBA
1484 * @plen: the transfer length
1486 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1488 u64 lba = 0;
1489 u32 len = 0;
1491 VPRINTK("sixteen-byte command\n");
1493 lba |= ((u64)cdb[2]) << 56;
1494 lba |= ((u64)cdb[3]) << 48;
1495 lba |= ((u64)cdb[4]) << 40;
1496 lba |= ((u64)cdb[5]) << 32;
1497 lba |= ((u64)cdb[6]) << 24;
1498 lba |= ((u64)cdb[7]) << 16;
1499 lba |= ((u64)cdb[8]) << 8;
1500 lba |= ((u64)cdb[9]);
1502 len |= ((u32)cdb[10]) << 24;
1503 len |= ((u32)cdb[11]) << 16;
1504 len |= ((u32)cdb[12]) << 8;
1505 len |= ((u32)cdb[13]);
1507 *plba = lba;
1508 *plen = len;
1512 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1513 * @qc: Storage for translated ATA taskfile
1515 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1517 * LOCKING:
1518 * spin_lock_irqsave(host lock)
1520 * RETURNS:
1521 * Zero on success, non-zero on error.
1523 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1525 struct scsi_cmnd *scmd = qc->scsicmd;
1526 struct ata_taskfile *tf = &qc->tf;
1527 struct ata_device *dev = qc->dev;
1528 u64 dev_sectors = qc->dev->n_sectors;
1529 const u8 *cdb = scmd->cmnd;
1530 u64 block;
1531 u32 n_block;
1533 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1534 tf->protocol = ATA_PROT_NODATA;
1536 if (cdb[0] == VERIFY) {
1537 if (scmd->cmd_len < 10)
1538 goto invalid_fld;
1539 scsi_10_lba_len(cdb, &block, &n_block);
1540 } else if (cdb[0] == VERIFY_16) {
1541 if (scmd->cmd_len < 16)
1542 goto invalid_fld;
1543 scsi_16_lba_len(cdb, &block, &n_block);
1544 } else
1545 goto invalid_fld;
1547 if (!n_block)
1548 goto nothing_to_do;
1549 if (block >= dev_sectors)
1550 goto out_of_range;
1551 if ((block + n_block) > dev_sectors)
1552 goto out_of_range;
1554 if (dev->flags & ATA_DFLAG_LBA) {
1555 tf->flags |= ATA_TFLAG_LBA;
1557 if (lba_28_ok(block, n_block)) {
1558 /* use LBA28 */
1559 tf->command = ATA_CMD_VERIFY;
1560 tf->device |= (block >> 24) & 0xf;
1561 } else if (lba_48_ok(block, n_block)) {
1562 if (!(dev->flags & ATA_DFLAG_LBA48))
1563 goto out_of_range;
1565 /* use LBA48 */
1566 tf->flags |= ATA_TFLAG_LBA48;
1567 tf->command = ATA_CMD_VERIFY_EXT;
1569 tf->hob_nsect = (n_block >> 8) & 0xff;
1571 tf->hob_lbah = (block >> 40) & 0xff;
1572 tf->hob_lbam = (block >> 32) & 0xff;
1573 tf->hob_lbal = (block >> 24) & 0xff;
1574 } else
1575 /* request too large even for LBA48 */
1576 goto out_of_range;
1578 tf->nsect = n_block & 0xff;
1580 tf->lbah = (block >> 16) & 0xff;
1581 tf->lbam = (block >> 8) & 0xff;
1582 tf->lbal = block & 0xff;
1584 tf->device |= ATA_LBA;
1585 } else {
1586 /* CHS */
1587 u32 sect, head, cyl, track;
1589 if (!lba_28_ok(block, n_block))
1590 goto out_of_range;
1592 /* Convert LBA to CHS */
1593 track = (u32)block / dev->sectors;
1594 cyl = track / dev->heads;
1595 head = track % dev->heads;
1596 sect = (u32)block % dev->sectors + 1;
1598 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1599 (u32)block, track, cyl, head, sect);
1601 /* Check whether the converted CHS can fit.
1602 Cylinder: 0-65535
1603 Head: 0-15
1604 Sector: 1-255*/
1605 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1606 goto out_of_range;
1608 tf->command = ATA_CMD_VERIFY;
1609 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1610 tf->lbal = sect;
1611 tf->lbam = cyl;
1612 tf->lbah = cyl >> 8;
1613 tf->device |= head;
1616 return 0;
1618 invalid_fld:
1619 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1620 /* "Invalid field in cbd" */
1621 return 1;
1623 out_of_range:
1624 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1625 /* "Logical Block Address out of range" */
1626 return 1;
1628 nothing_to_do:
1629 scmd->result = SAM_STAT_GOOD;
1630 return 1;
1634 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1635 * @qc: Storage for translated ATA taskfile
1637 * Converts any of six SCSI read/write commands into the
1638 * ATA counterpart, including starting sector (LBA),
1639 * sector count, and taking into account the device's LBA48
1640 * support.
1642 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1643 * %WRITE_16 are currently supported.
1645 * LOCKING:
1646 * spin_lock_irqsave(host lock)
1648 * RETURNS:
1649 * Zero on success, non-zero on error.
1651 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1653 struct scsi_cmnd *scmd = qc->scsicmd;
1654 const u8 *cdb = scmd->cmnd;
1655 unsigned int tf_flags = 0;
1656 u64 block;
1657 u32 n_block;
1658 int rc;
1660 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1661 tf_flags |= ATA_TFLAG_WRITE;
1663 /* Calculate the SCSI LBA, transfer length and FUA. */
1664 switch (cdb[0]) {
1665 case READ_10:
1666 case WRITE_10:
1667 if (unlikely(scmd->cmd_len < 10))
1668 goto invalid_fld;
1669 scsi_10_lba_len(cdb, &block, &n_block);
1670 if (cdb[1] & (1 << 3))
1671 tf_flags |= ATA_TFLAG_FUA;
1672 break;
1673 case READ_6:
1674 case WRITE_6:
1675 if (unlikely(scmd->cmd_len < 6))
1676 goto invalid_fld;
1677 scsi_6_lba_len(cdb, &block, &n_block);
1679 /* for 6-byte r/w commands, transfer length 0
1680 * means 256 blocks of data, not 0 block.
1682 if (!n_block)
1683 n_block = 256;
1684 break;
1685 case READ_16:
1686 case WRITE_16:
1687 if (unlikely(scmd->cmd_len < 16))
1688 goto invalid_fld;
1689 scsi_16_lba_len(cdb, &block, &n_block);
1690 if (cdb[1] & (1 << 3))
1691 tf_flags |= ATA_TFLAG_FUA;
1692 break;
1693 default:
1694 DPRINTK("no-byte command\n");
1695 goto invalid_fld;
1698 /* Check and compose ATA command */
1699 if (!n_block)
1700 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1701 * length 0 means transfer 0 block of data.
1702 * However, for ATA R/W commands, sector count 0 means
1703 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1705 * WARNING: one or two older ATA drives treat 0 as 0...
1707 goto nothing_to_do;
1709 qc->flags |= ATA_QCFLAG_IO;
1710 qc->nbytes = n_block * scmd->device->sector_size;
1712 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1713 qc->tag);
1714 if (likely(rc == 0))
1715 return 0;
1717 if (rc == -ERANGE)
1718 goto out_of_range;
1719 /* treat all other errors as -EINVAL, fall through */
1720 invalid_fld:
1721 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1722 /* "Invalid field in cbd" */
1723 return 1;
1725 out_of_range:
1726 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1727 /* "Logical Block Address out of range" */
1728 return 1;
1730 nothing_to_do:
1731 scmd->result = SAM_STAT_GOOD;
1732 return 1;
1735 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1737 struct ata_port *ap = qc->ap;
1738 struct scsi_cmnd *cmd = qc->scsicmd;
1739 u8 *cdb = cmd->cmnd;
1740 int need_sense = (qc->err_mask != 0);
1742 /* For ATA pass thru (SAT) commands, generate a sense block if
1743 * user mandated it or if there's an error. Note that if we
1744 * generate because the user forced us to [CK_COND =1], a check
1745 * condition is generated and the ATA register values are returned
1746 * whether the command completed successfully or not. If there
1747 * was no error, we use the following sense data:
1748 * sk = RECOVERED ERROR
1749 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1751 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1752 ((cdb[2] & 0x20) || need_sense)) {
1753 ata_gen_passthru_sense(qc);
1754 } else {
1755 if (!need_sense) {
1756 cmd->result = SAM_STAT_GOOD;
1757 } else {
1758 /* TODO: decide which descriptor format to use
1759 * for 48b LBA devices and call that here
1760 * instead of the fixed desc, which is only
1761 * good for smaller LBA (and maybe CHS?)
1762 * devices.
1764 ata_gen_ata_sense(qc);
1768 if (need_sense && !ap->ops->error_handler)
1769 ata_dump_status(ap->print_id, &qc->result_tf);
1771 qc->scsidone(cmd);
1773 ata_qc_free(qc);
1777 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1778 * @dev: ATA device to which the command is addressed
1779 * @cmd: SCSI command to execute
1780 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1782 * Our ->queuecommand() function has decided that the SCSI
1783 * command issued can be directly translated into an ATA
1784 * command, rather than handled internally.
1786 * This function sets up an ata_queued_cmd structure for the
1787 * SCSI command, and sends that ata_queued_cmd to the hardware.
1789 * The xlat_func argument (actor) returns 0 if ready to execute
1790 * ATA command, else 1 to finish translation. If 1 is returned
1791 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1792 * to be set reflecting an error condition or clean (early)
1793 * termination.
1795 * LOCKING:
1796 * spin_lock_irqsave(host lock)
1798 * RETURNS:
1799 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1800 * needs to be deferred.
1802 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1803 ata_xlat_func_t xlat_func)
1805 struct ata_port *ap = dev->link->ap;
1806 struct ata_queued_cmd *qc;
1807 int rc;
1809 VPRINTK("ENTER\n");
1811 qc = ata_scsi_qc_new(dev, cmd);
1812 if (!qc)
1813 goto err_mem;
1815 /* data is present; dma-map it */
1816 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1817 cmd->sc_data_direction == DMA_TO_DEVICE) {
1818 if (unlikely(scsi_bufflen(cmd) < 1)) {
1819 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1820 goto err_did;
1823 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1825 qc->dma_dir = cmd->sc_data_direction;
1828 qc->complete_fn = ata_scsi_qc_complete;
1830 if (xlat_func(qc))
1831 goto early_finish;
1833 if (ap->ops->qc_defer) {
1834 if ((rc = ap->ops->qc_defer(qc)))
1835 goto defer;
1838 /* select device, send command to hardware */
1839 ata_qc_issue(qc);
1841 VPRINTK("EXIT\n");
1842 return 0;
1844 early_finish:
1845 ata_qc_free(qc);
1846 cmd->scsi_done(cmd);
1847 DPRINTK("EXIT - early finish (good or error)\n");
1848 return 0;
1850 err_did:
1851 ata_qc_free(qc);
1852 cmd->result = (DID_ERROR << 16);
1853 cmd->scsi_done(cmd);
1854 err_mem:
1855 DPRINTK("EXIT - internal\n");
1856 return 0;
1858 defer:
1859 ata_qc_free(qc);
1860 DPRINTK("EXIT - defer\n");
1861 if (rc == ATA_DEFER_LINK)
1862 return SCSI_MLQUEUE_DEVICE_BUSY;
1863 else
1864 return SCSI_MLQUEUE_HOST_BUSY;
1868 * ata_scsi_rbuf_get - Map response buffer.
1869 * @cmd: SCSI command containing buffer to be mapped.
1870 * @flags: unsigned long variable to store irq enable status
1871 * @copy_in: copy in from user buffer
1873 * Prepare buffer for simulated SCSI commands.
1875 * LOCKING:
1876 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1878 * RETURNS:
1879 * Pointer to response buffer.
1881 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1882 unsigned long *flags)
1884 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1886 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1887 if (copy_in)
1888 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1889 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1890 return ata_scsi_rbuf;
1894 * ata_scsi_rbuf_put - Unmap response buffer.
1895 * @cmd: SCSI command containing buffer to be unmapped.
1896 * @copy_out: copy out result
1897 * @flags: @flags passed to ata_scsi_rbuf_get()
1899 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1900 * @copy_back is true.
1902 * LOCKING:
1903 * Unlocks ata_scsi_rbuf_lock.
1905 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1906 unsigned long *flags)
1908 if (copy_out)
1909 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1910 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1911 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1915 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1916 * @args: device IDENTIFY data / SCSI command of interest.
1917 * @actor: Callback hook for desired SCSI command simulator
1919 * Takes care of the hard work of simulating a SCSI command...
1920 * Mapping the response buffer, calling the command's handler,
1921 * and handling the handler's return value. This return value
1922 * indicates whether the handler wishes the SCSI command to be
1923 * completed successfully (0), or not (in which case cmd->result
1924 * and sense buffer are assumed to be set).
1926 * LOCKING:
1927 * spin_lock_irqsave(host lock)
1929 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1930 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1932 u8 *rbuf;
1933 unsigned int rc;
1934 struct scsi_cmnd *cmd = args->cmd;
1935 unsigned long flags;
1937 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1938 rc = actor(args, rbuf);
1939 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1941 if (rc == 0)
1942 cmd->result = SAM_STAT_GOOD;
1943 args->done(cmd);
1947 * ata_scsiop_inq_std - Simulate INQUIRY command
1948 * @args: device IDENTIFY data / SCSI command of interest.
1949 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1951 * Returns standard device identification data associated
1952 * with non-VPD INQUIRY command output.
1954 * LOCKING:
1955 * spin_lock_irqsave(host lock)
1957 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1959 const u8 versions[] = {
1960 0x60, /* SAM-3 (no version claimed) */
1962 0x03,
1963 0x20, /* SBC-2 (no version claimed) */
1965 0x02,
1966 0x60 /* SPC-3 (no version claimed) */
1968 u8 hdr[] = {
1969 TYPE_DISK,
1971 0x5, /* claim SPC-3 version compatibility */
1973 95 - 4
1976 VPRINTK("ENTER\n");
1978 /* set scsi removeable (RMB) bit per ata bit */
1979 if (ata_id_removeable(args->id))
1980 hdr[1] |= (1 << 7);
1982 memcpy(rbuf, hdr, sizeof(hdr));
1983 memcpy(&rbuf[8], "ATA ", 8);
1984 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1985 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1987 if (rbuf[32] == 0 || rbuf[32] == ' ')
1988 memcpy(&rbuf[32], "n/a ", 4);
1990 memcpy(rbuf + 59, versions, sizeof(versions));
1992 return 0;
1996 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1997 * @args: device IDENTIFY data / SCSI command of interest.
1998 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2000 * Returns list of inquiry VPD pages available.
2002 * LOCKING:
2003 * spin_lock_irqsave(host lock)
2005 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2007 const u8 pages[] = {
2008 0x00, /* page 0x00, this page */
2009 0x80, /* page 0x80, unit serial no page */
2010 0x83, /* page 0x83, device ident page */
2011 0x89, /* page 0x89, ata info page */
2012 0xb0, /* page 0xb0, block limits page */
2013 0xb1, /* page 0xb1, block device characteristics page */
2014 0xb2, /* page 0xb2, thin provisioning page */
2017 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
2018 memcpy(rbuf + 4, pages, sizeof(pages));
2019 return 0;
2023 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2024 * @args: device IDENTIFY data / SCSI command of interest.
2025 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2027 * Returns ATA device serial number.
2029 * LOCKING:
2030 * spin_lock_irqsave(host lock)
2032 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2034 const u8 hdr[] = {
2036 0x80, /* this page code */
2038 ATA_ID_SERNO_LEN, /* page len */
2041 memcpy(rbuf, hdr, sizeof(hdr));
2042 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2043 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2044 return 0;
2048 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2049 * @args: device IDENTIFY data / SCSI command of interest.
2050 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2052 * Yields two logical unit device identification designators:
2053 * - vendor specific ASCII containing the ATA serial number
2054 * - SAT defined "t10 vendor id based" containing ASCII vendor
2055 * name ("ATA "), model and serial numbers.
2057 * LOCKING:
2058 * spin_lock_irqsave(host lock)
2060 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2062 const int sat_model_serial_desc_len = 68;
2063 int num;
2065 rbuf[1] = 0x83; /* this page code */
2066 num = 4;
2068 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2069 rbuf[num + 0] = 2;
2070 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2071 num += 4;
2072 ata_id_string(args->id, (unsigned char *) rbuf + num,
2073 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2074 num += ATA_ID_SERNO_LEN;
2076 /* SAT defined lu model and serial numbers descriptor */
2077 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2078 rbuf[num + 0] = 2;
2079 rbuf[num + 1] = 1;
2080 rbuf[num + 3] = sat_model_serial_desc_len;
2081 num += 4;
2082 memcpy(rbuf + num, "ATA ", 8);
2083 num += 8;
2084 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2085 ATA_ID_PROD_LEN);
2086 num += ATA_ID_PROD_LEN;
2087 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2088 ATA_ID_SERNO_LEN);
2089 num += ATA_ID_SERNO_LEN;
2091 if (ata_id_has_wwn(args->id)) {
2092 /* SAT defined lu world wide name */
2093 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2094 rbuf[num + 0] = 1;
2095 rbuf[num + 1] = 3;
2096 rbuf[num + 3] = ATA_ID_WWN_LEN;
2097 num += 4;
2098 ata_id_string(args->id, (unsigned char *) rbuf + num,
2099 ATA_ID_WWN, ATA_ID_WWN_LEN);
2100 num += ATA_ID_WWN_LEN;
2102 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2103 return 0;
2107 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2108 * @args: device IDENTIFY data / SCSI command of interest.
2109 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2111 * Yields SAT-specified ATA VPD page.
2113 * LOCKING:
2114 * spin_lock_irqsave(host lock)
2116 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2118 struct ata_taskfile tf;
2120 memset(&tf, 0, sizeof(tf));
2122 rbuf[1] = 0x89; /* our page code */
2123 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2124 rbuf[3] = (0x238 & 0xff);
2126 memcpy(&rbuf[8], "linux ", 8);
2127 memcpy(&rbuf[16], "libata ", 16);
2128 memcpy(&rbuf[32], DRV_VERSION, 4);
2130 /* we don't store the ATA device signature, so we fake it */
2132 tf.command = ATA_DRDY; /* really, this is Status reg */
2133 tf.lbal = 0x1;
2134 tf.nsect = 0x1;
2136 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2137 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2139 rbuf[56] = ATA_CMD_ID_ATA;
2141 memcpy(&rbuf[60], &args->id[0], 512);
2142 return 0;
2145 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2147 u16 min_io_sectors;
2149 rbuf[1] = 0xb0;
2150 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2153 * Optimal transfer length granularity.
2155 * This is always one physical block, but for disks with a smaller
2156 * logical than physical sector size we need to figure out what the
2157 * latter is.
2159 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2160 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2163 * Optimal unmap granularity.
2165 * The ATA spec doesn't even know about a granularity or alignment
2166 * for the TRIM command. We can leave away most of the unmap related
2167 * VPD page entries, but we have specifify a granularity to signal
2168 * that we support some form of unmap - in thise case via WRITE SAME
2169 * with the unmap bit set.
2171 if (ata_id_has_trim(args->id)) {
2172 put_unaligned_be64(65535 * 512 / 8, &rbuf[36]);
2173 put_unaligned_be32(1, &rbuf[28]);
2176 return 0;
2179 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2181 int form_factor = ata_id_form_factor(args->id);
2182 int media_rotation_rate = ata_id_rotation_rate(args->id);
2184 rbuf[1] = 0xb1;
2185 rbuf[3] = 0x3c;
2186 rbuf[4] = media_rotation_rate >> 8;
2187 rbuf[5] = media_rotation_rate;
2188 rbuf[7] = form_factor;
2190 return 0;
2193 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2195 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2196 rbuf[1] = 0xb2;
2197 rbuf[3] = 0x4;
2198 rbuf[5] = 1 << 6; /* TPWS */
2200 return 0;
2204 * ata_scsiop_noop - Command handler that simply returns success.
2205 * @args: device IDENTIFY data / SCSI command of interest.
2206 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2208 * No operation. Simply returns success to caller, to indicate
2209 * that the caller should successfully complete this SCSI command.
2211 * LOCKING:
2212 * spin_lock_irqsave(host lock)
2214 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2216 VPRINTK("ENTER\n");
2217 return 0;
2221 * modecpy - Prepare response for MODE SENSE
2222 * @dest: output buffer
2223 * @src: data being copied
2224 * @n: length of mode page
2225 * @changeable: whether changeable parameters are requested
2227 * Generate a generic MODE SENSE page for either current or changeable
2228 * parameters.
2230 * LOCKING:
2231 * None.
2233 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2235 if (changeable) {
2236 memcpy(dest, src, 2);
2237 memset(dest + 2, 0, n - 2);
2238 } else {
2239 memcpy(dest, src, n);
2244 * ata_msense_caching - Simulate MODE SENSE caching info page
2245 * @id: device IDENTIFY data
2246 * @buf: output buffer
2247 * @changeable: whether changeable parameters are requested
2249 * Generate a caching info page, which conditionally indicates
2250 * write caching to the SCSI layer, depending on device
2251 * capabilities.
2253 * LOCKING:
2254 * None.
2256 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2258 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2259 if (changeable || ata_id_wcache_enabled(id))
2260 buf[2] |= (1 << 2); /* write cache enable */
2261 if (!changeable && !ata_id_rahead_enabled(id))
2262 buf[12] |= (1 << 5); /* disable read ahead */
2263 return sizeof(def_cache_mpage);
2267 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2268 * @buf: output buffer
2269 * @changeable: whether changeable parameters are requested
2271 * Generate a generic MODE SENSE control mode page.
2273 * LOCKING:
2274 * None.
2276 static unsigned int ata_msense_ctl_mode(u8 *buf, bool changeable)
2278 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2279 return sizeof(def_control_mpage);
2283 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2284 * @buf: output buffer
2285 * @changeable: whether changeable parameters are requested
2287 * Generate a generic MODE SENSE r/w error recovery page.
2289 * LOCKING:
2290 * None.
2292 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2294 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2295 changeable);
2296 return sizeof(def_rw_recovery_mpage);
2300 * We can turn this into a real blacklist if it's needed, for now just
2301 * blacklist any Maxtor BANC1G10 revision firmware
2303 static int ata_dev_supports_fua(u16 *id)
2305 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2307 if (!libata_fua)
2308 return 0;
2309 if (!ata_id_has_fua(id))
2310 return 0;
2312 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2313 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2315 if (strcmp(model, "Maxtor"))
2316 return 1;
2317 if (strcmp(fw, "BANC1G10"))
2318 return 1;
2320 return 0; /* blacklisted */
2324 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2325 * @args: device IDENTIFY data / SCSI command of interest.
2326 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2328 * Simulate MODE SENSE commands. Assume this is invoked for direct
2329 * access devices (e.g. disks) only. There should be no block
2330 * descriptor for other device types.
2332 * LOCKING:
2333 * spin_lock_irqsave(host lock)
2335 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2337 struct ata_device *dev = args->dev;
2338 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2339 const u8 sat_blk_desc[] = {
2340 0, 0, 0, 0, /* number of blocks: sat unspecified */
2342 0, 0x2, 0x0 /* block length: 512 bytes */
2344 u8 pg, spg;
2345 unsigned int ebd, page_control, six_byte;
2346 u8 dpofua;
2348 VPRINTK("ENTER\n");
2350 six_byte = (scsicmd[0] == MODE_SENSE);
2351 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2353 * LLBA bit in msense(10) ignored (compliant)
2356 page_control = scsicmd[2] >> 6;
2357 switch (page_control) {
2358 case 0: /* current */
2359 case 1: /* changeable */
2360 case 2: /* defaults */
2361 break; /* supported */
2362 case 3: /* saved */
2363 goto saving_not_supp;
2364 default:
2365 goto invalid_fld;
2368 if (six_byte)
2369 p += 4 + (ebd ? 8 : 0);
2370 else
2371 p += 8 + (ebd ? 8 : 0);
2373 pg = scsicmd[2] & 0x3f;
2374 spg = scsicmd[3];
2376 * No mode subpages supported (yet) but asking for _all_
2377 * subpages may be valid
2379 if (spg && (spg != ALL_SUB_MPAGES))
2380 goto invalid_fld;
2382 switch(pg) {
2383 case RW_RECOVERY_MPAGE:
2384 p += ata_msense_rw_recovery(p, page_control == 1);
2385 break;
2387 case CACHE_MPAGE:
2388 p += ata_msense_caching(args->id, p, page_control == 1);
2389 break;
2391 case CONTROL_MPAGE:
2392 p += ata_msense_ctl_mode(p, page_control == 1);
2393 break;
2395 case ALL_MPAGES:
2396 p += ata_msense_rw_recovery(p, page_control == 1);
2397 p += ata_msense_caching(args->id, p, page_control == 1);
2398 p += ata_msense_ctl_mode(p, page_control == 1);
2399 break;
2401 default: /* invalid page code */
2402 goto invalid_fld;
2405 dpofua = 0;
2406 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2407 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2408 dpofua = 1 << 4;
2410 if (six_byte) {
2411 rbuf[0] = p - rbuf - 1;
2412 rbuf[2] |= dpofua;
2413 if (ebd) {
2414 rbuf[3] = sizeof(sat_blk_desc);
2415 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2417 } else {
2418 unsigned int output_len = p - rbuf - 2;
2420 rbuf[0] = output_len >> 8;
2421 rbuf[1] = output_len;
2422 rbuf[3] |= dpofua;
2423 if (ebd) {
2424 rbuf[7] = sizeof(sat_blk_desc);
2425 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2428 return 0;
2430 invalid_fld:
2431 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2432 /* "Invalid field in cbd" */
2433 return 1;
2435 saving_not_supp:
2436 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2437 /* "Saving parameters not supported" */
2438 return 1;
2442 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2443 * @args: device IDENTIFY data / SCSI command of interest.
2444 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2446 * Simulate READ CAPACITY commands.
2448 * LOCKING:
2449 * None.
2451 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2453 struct ata_device *dev = args->dev;
2454 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2455 u32 sector_size; /* physical sector size in bytes */
2456 u8 log2_per_phys;
2457 u16 lowest_aligned;
2459 sector_size = ata_id_logical_sector_size(dev->id);
2460 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2461 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2463 VPRINTK("ENTER\n");
2465 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2466 if (last_lba >= 0xffffffffULL)
2467 last_lba = 0xffffffff;
2469 /* sector count, 32-bit */
2470 rbuf[0] = last_lba >> (8 * 3);
2471 rbuf[1] = last_lba >> (8 * 2);
2472 rbuf[2] = last_lba >> (8 * 1);
2473 rbuf[3] = last_lba;
2475 /* sector size */
2476 rbuf[4] = sector_size >> (8 * 3);
2477 rbuf[5] = sector_size >> (8 * 2);
2478 rbuf[6] = sector_size >> (8 * 1);
2479 rbuf[7] = sector_size;
2480 } else {
2481 /* sector count, 64-bit */
2482 rbuf[0] = last_lba >> (8 * 7);
2483 rbuf[1] = last_lba >> (8 * 6);
2484 rbuf[2] = last_lba >> (8 * 5);
2485 rbuf[3] = last_lba >> (8 * 4);
2486 rbuf[4] = last_lba >> (8 * 3);
2487 rbuf[5] = last_lba >> (8 * 2);
2488 rbuf[6] = last_lba >> (8 * 1);
2489 rbuf[7] = last_lba;
2491 /* sector size */
2492 rbuf[ 8] = sector_size >> (8 * 3);
2493 rbuf[ 9] = sector_size >> (8 * 2);
2494 rbuf[10] = sector_size >> (8 * 1);
2495 rbuf[11] = sector_size;
2497 rbuf[12] = 0;
2498 rbuf[13] = log2_per_phys;
2499 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2500 rbuf[15] = lowest_aligned;
2502 if (ata_id_has_trim(args->id)) {
2503 rbuf[14] |= 0x80; /* TPE */
2505 if (ata_id_has_zero_after_trim(args->id))
2506 rbuf[14] |= 0x40; /* TPRZ */
2510 return 0;
2514 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2515 * @args: device IDENTIFY data / SCSI command of interest.
2516 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2518 * Simulate REPORT LUNS command.
2520 * LOCKING:
2521 * spin_lock_irqsave(host lock)
2523 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2525 VPRINTK("ENTER\n");
2526 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2528 return 0;
2531 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2533 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2534 /* FIXME: not quite right; we don't want the
2535 * translation of taskfile registers into
2536 * a sense descriptors, since that's only
2537 * correct for ATA, not ATAPI
2539 ata_gen_passthru_sense(qc);
2542 qc->scsidone(qc->scsicmd);
2543 ata_qc_free(qc);
2546 /* is it pointless to prefer PIO for "safety reasons"? */
2547 static inline int ata_pio_use_silly(struct ata_port *ap)
2549 return (ap->flags & ATA_FLAG_PIO_DMA);
2552 static void atapi_request_sense(struct ata_queued_cmd *qc)
2554 struct ata_port *ap = qc->ap;
2555 struct scsi_cmnd *cmd = qc->scsicmd;
2557 DPRINTK("ATAPI request sense\n");
2559 /* FIXME: is this needed? */
2560 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2562 #ifdef CONFIG_ATA_SFF
2563 if (ap->ops->sff_tf_read)
2564 ap->ops->sff_tf_read(ap, &qc->tf);
2565 #endif
2567 /* fill these in, for the case where they are -not- overwritten */
2568 cmd->sense_buffer[0] = 0x70;
2569 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2571 ata_qc_reinit(qc);
2573 /* setup sg table and init transfer direction */
2574 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2575 ata_sg_init(qc, &qc->sgent, 1);
2576 qc->dma_dir = DMA_FROM_DEVICE;
2578 memset(&qc->cdb, 0, qc->dev->cdb_len);
2579 qc->cdb[0] = REQUEST_SENSE;
2580 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2582 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2583 qc->tf.command = ATA_CMD_PACKET;
2585 if (ata_pio_use_silly(ap)) {
2586 qc->tf.protocol = ATAPI_PROT_DMA;
2587 qc->tf.feature |= ATAPI_PKT_DMA;
2588 } else {
2589 qc->tf.protocol = ATAPI_PROT_PIO;
2590 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2591 qc->tf.lbah = 0;
2593 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2595 qc->complete_fn = atapi_sense_complete;
2597 ata_qc_issue(qc);
2599 DPRINTK("EXIT\n");
2602 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2604 struct scsi_cmnd *cmd = qc->scsicmd;
2605 unsigned int err_mask = qc->err_mask;
2607 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2609 /* handle completion from new EH */
2610 if (unlikely(qc->ap->ops->error_handler &&
2611 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2613 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2614 /* FIXME: not quite right; we don't want the
2615 * translation of taskfile registers into a
2616 * sense descriptors, since that's only
2617 * correct for ATA, not ATAPI
2619 ata_gen_passthru_sense(qc);
2622 /* SCSI EH automatically locks door if sdev->locked is
2623 * set. Sometimes door lock request continues to
2624 * fail, for example, when no media is present. This
2625 * creates a loop - SCSI EH issues door lock which
2626 * fails and gets invoked again to acquire sense data
2627 * for the failed command.
2629 * If door lock fails, always clear sdev->locked to
2630 * avoid this infinite loop.
2632 * This may happen before SCSI scan is complete. Make
2633 * sure qc->dev->sdev isn't NULL before dereferencing.
2635 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2636 qc->dev->sdev->locked = 0;
2638 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2639 qc->scsidone(cmd);
2640 ata_qc_free(qc);
2641 return;
2644 /* successful completion or old EH failure path */
2645 if (unlikely(err_mask & AC_ERR_DEV)) {
2646 cmd->result = SAM_STAT_CHECK_CONDITION;
2647 atapi_request_sense(qc);
2648 return;
2649 } else if (unlikely(err_mask)) {
2650 /* FIXME: not quite right; we don't want the
2651 * translation of taskfile registers into
2652 * a sense descriptors, since that's only
2653 * correct for ATA, not ATAPI
2655 ata_gen_passthru_sense(qc);
2656 } else {
2657 u8 *scsicmd = cmd->cmnd;
2659 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2660 unsigned long flags;
2661 u8 *buf;
2663 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2665 /* ATAPI devices typically report zero for their SCSI version,
2666 * and sometimes deviate from the spec WRT response data
2667 * format. If SCSI version is reported as zero like normal,
2668 * then we make the following fixups: 1) Fake MMC-5 version,
2669 * to indicate to the Linux scsi midlayer this is a modern
2670 * device. 2) Ensure response data format / ATAPI information
2671 * are always correct.
2673 if (buf[2] == 0) {
2674 buf[2] = 0x5;
2675 buf[3] = 0x32;
2678 ata_scsi_rbuf_put(cmd, true, &flags);
2681 cmd->result = SAM_STAT_GOOD;
2684 qc->scsidone(cmd);
2685 ata_qc_free(qc);
2688 * atapi_xlat - Initialize PACKET taskfile
2689 * @qc: command structure to be initialized
2691 * LOCKING:
2692 * spin_lock_irqsave(host lock)
2694 * RETURNS:
2695 * Zero on success, non-zero on failure.
2697 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2699 struct scsi_cmnd *scmd = qc->scsicmd;
2700 struct ata_device *dev = qc->dev;
2701 int nodata = (scmd->sc_data_direction == DMA_NONE);
2702 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2703 unsigned int nbytes;
2705 memset(qc->cdb, 0, dev->cdb_len);
2706 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2708 qc->complete_fn = atapi_qc_complete;
2710 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2711 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2712 qc->tf.flags |= ATA_TFLAG_WRITE;
2713 DPRINTK("direction: write\n");
2716 qc->tf.command = ATA_CMD_PACKET;
2717 ata_qc_set_pc_nbytes(qc);
2719 /* check whether ATAPI DMA is safe */
2720 if (!nodata && !using_pio && atapi_check_dma(qc))
2721 using_pio = 1;
2723 /* Some controller variants snoop this value for Packet
2724 * transfers to do state machine and FIFO management. Thus we
2725 * want to set it properly, and for DMA where it is
2726 * effectively meaningless.
2728 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2730 /* Most ATAPI devices which honor transfer chunk size don't
2731 * behave according to the spec when odd chunk size which
2732 * matches the transfer length is specified. If the number of
2733 * bytes to transfer is 2n+1. According to the spec, what
2734 * should happen is to indicate that 2n+1 is going to be
2735 * transferred and transfer 2n+2 bytes where the last byte is
2736 * padding.
2738 * In practice, this doesn't happen. ATAPI devices first
2739 * indicate and transfer 2n bytes and then indicate and
2740 * transfer 2 bytes where the last byte is padding.
2742 * This inconsistency confuses several controllers which
2743 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2744 * These controllers use actual number of transferred bytes to
2745 * update DMA poitner and transfer of 4n+2 bytes make those
2746 * controller push DMA pointer by 4n+4 bytes because SATA data
2747 * FISes are aligned to 4 bytes. This causes data corruption
2748 * and buffer overrun.
2750 * Always setting nbytes to even number solves this problem
2751 * because then ATAPI devices don't have to split data at 2n
2752 * boundaries.
2754 if (nbytes & 0x1)
2755 nbytes++;
2757 qc->tf.lbam = (nbytes & 0xFF);
2758 qc->tf.lbah = (nbytes >> 8);
2760 if (nodata)
2761 qc->tf.protocol = ATAPI_PROT_NODATA;
2762 else if (using_pio)
2763 qc->tf.protocol = ATAPI_PROT_PIO;
2764 else {
2765 /* DMA data xfer */
2766 qc->tf.protocol = ATAPI_PROT_DMA;
2767 qc->tf.feature |= ATAPI_PKT_DMA;
2769 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2770 (scmd->sc_data_direction != DMA_TO_DEVICE))
2771 /* some SATA bridges need us to indicate data xfer direction */
2772 qc->tf.feature |= ATAPI_DMADIR;
2776 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2777 as ATAPI tape drives don't get this right otherwise */
2778 return 0;
2781 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2783 if (!sata_pmp_attached(ap)) {
2784 if (likely(devno < ata_link_max_devices(&ap->link)))
2785 return &ap->link.device[devno];
2786 } else {
2787 if (likely(devno < ap->nr_pmp_links))
2788 return &ap->pmp_link[devno].device[0];
2791 return NULL;
2794 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2795 const struct scsi_device *scsidev)
2797 int devno;
2799 /* skip commands not addressed to targets we simulate */
2800 if (!sata_pmp_attached(ap)) {
2801 if (unlikely(scsidev->channel || scsidev->lun))
2802 return NULL;
2803 devno = scsidev->id;
2804 } else {
2805 if (unlikely(scsidev->id || scsidev->lun))
2806 return NULL;
2807 devno = scsidev->channel;
2810 return ata_find_dev(ap, devno);
2814 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2815 * @ap: ATA port to which the device is attached
2816 * @scsidev: SCSI device from which we derive the ATA device
2818 * Given various information provided in struct scsi_cmnd,
2819 * map that onto an ATA bus, and using that mapping
2820 * determine which ata_device is associated with the
2821 * SCSI command to be sent.
2823 * LOCKING:
2824 * spin_lock_irqsave(host lock)
2826 * RETURNS:
2827 * Associated ATA device, or %NULL if not found.
2829 static struct ata_device *
2830 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2832 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2834 if (unlikely(!dev || !ata_dev_enabled(dev)))
2835 return NULL;
2837 return dev;
2841 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2842 * @byte1: Byte 1 from pass-thru CDB.
2844 * RETURNS:
2845 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2847 static u8
2848 ata_scsi_map_proto(u8 byte1)
2850 switch((byte1 & 0x1e) >> 1) {
2851 case 3: /* Non-data */
2852 return ATA_PROT_NODATA;
2854 case 6: /* DMA */
2855 case 10: /* UDMA Data-in */
2856 case 11: /* UDMA Data-Out */
2857 return ATA_PROT_DMA;
2859 case 4: /* PIO Data-in */
2860 case 5: /* PIO Data-out */
2861 return ATA_PROT_PIO;
2863 case 0: /* Hard Reset */
2864 case 1: /* SRST */
2865 case 8: /* Device Diagnostic */
2866 case 9: /* Device Reset */
2867 case 7: /* DMA Queued */
2868 case 12: /* FPDMA */
2869 case 15: /* Return Response Info */
2870 default: /* Reserved */
2871 break;
2874 return ATA_PROT_UNKNOWN;
2878 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2879 * @qc: command structure to be initialized
2881 * Handles either 12 or 16-byte versions of the CDB.
2883 * RETURNS:
2884 * Zero on success, non-zero on failure.
2886 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2888 struct ata_taskfile *tf = &(qc->tf);
2889 struct scsi_cmnd *scmd = qc->scsicmd;
2890 struct ata_device *dev = qc->dev;
2891 const u8 *cdb = scmd->cmnd;
2893 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2894 goto invalid_fld;
2897 * 12 and 16 byte CDBs use different offsets to
2898 * provide the various register values.
2900 if (cdb[0] == ATA_16) {
2902 * 16-byte CDB - may contain extended commands.
2904 * If that is the case, copy the upper byte register values.
2906 if (cdb[1] & 0x01) {
2907 tf->hob_feature = cdb[3];
2908 tf->hob_nsect = cdb[5];
2909 tf->hob_lbal = cdb[7];
2910 tf->hob_lbam = cdb[9];
2911 tf->hob_lbah = cdb[11];
2912 tf->flags |= ATA_TFLAG_LBA48;
2913 } else
2914 tf->flags &= ~ATA_TFLAG_LBA48;
2917 * Always copy low byte, device and command registers.
2919 tf->feature = cdb[4];
2920 tf->nsect = cdb[6];
2921 tf->lbal = cdb[8];
2922 tf->lbam = cdb[10];
2923 tf->lbah = cdb[12];
2924 tf->device = cdb[13];
2925 tf->command = cdb[14];
2926 } else {
2928 * 12-byte CDB - incapable of extended commands.
2930 tf->flags &= ~ATA_TFLAG_LBA48;
2932 tf->feature = cdb[3];
2933 tf->nsect = cdb[4];
2934 tf->lbal = cdb[5];
2935 tf->lbam = cdb[6];
2936 tf->lbah = cdb[7];
2937 tf->device = cdb[8];
2938 tf->command = cdb[9];
2941 /* enforce correct master/slave bit */
2942 tf->device = dev->devno ?
2943 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2945 switch (tf->command) {
2946 /* READ/WRITE LONG use a non-standard sect_size */
2947 case ATA_CMD_READ_LONG:
2948 case ATA_CMD_READ_LONG_ONCE:
2949 case ATA_CMD_WRITE_LONG:
2950 case ATA_CMD_WRITE_LONG_ONCE:
2951 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2952 goto invalid_fld;
2953 qc->sect_size = scsi_bufflen(scmd);
2954 break;
2956 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2957 case ATA_CMD_CFA_WRITE_NE:
2958 case ATA_CMD_CFA_TRANS_SECT:
2959 case ATA_CMD_CFA_WRITE_MULT_NE:
2960 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2961 case ATA_CMD_READ:
2962 case ATA_CMD_READ_EXT:
2963 case ATA_CMD_READ_QUEUED:
2964 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2965 case ATA_CMD_FPDMA_READ:
2966 case ATA_CMD_READ_MULTI:
2967 case ATA_CMD_READ_MULTI_EXT:
2968 case ATA_CMD_PIO_READ:
2969 case ATA_CMD_PIO_READ_EXT:
2970 case ATA_CMD_READ_STREAM_DMA_EXT:
2971 case ATA_CMD_READ_STREAM_EXT:
2972 case ATA_CMD_VERIFY:
2973 case ATA_CMD_VERIFY_EXT:
2974 case ATA_CMD_WRITE:
2975 case ATA_CMD_WRITE_EXT:
2976 case ATA_CMD_WRITE_FUA_EXT:
2977 case ATA_CMD_WRITE_QUEUED:
2978 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2979 case ATA_CMD_FPDMA_WRITE:
2980 case ATA_CMD_WRITE_MULTI:
2981 case ATA_CMD_WRITE_MULTI_EXT:
2982 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2983 case ATA_CMD_PIO_WRITE:
2984 case ATA_CMD_PIO_WRITE_EXT:
2985 case ATA_CMD_WRITE_STREAM_DMA_EXT:
2986 case ATA_CMD_WRITE_STREAM_EXT:
2987 qc->sect_size = scmd->device->sector_size;
2988 break;
2990 /* Everything else uses 512 byte "sectors" */
2991 default:
2992 qc->sect_size = ATA_SECT_SIZE;
2996 * Set flags so that all registers will be written, pass on
2997 * write indication (used for PIO/DMA setup), result TF is
2998 * copied back and we don't whine too much about its failure.
3000 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3001 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3002 tf->flags |= ATA_TFLAG_WRITE;
3004 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3007 * Set transfer length.
3009 * TODO: find out if we need to do more here to
3010 * cover scatter/gather case.
3012 ata_qc_set_pc_nbytes(qc);
3014 /* We may not issue DMA commands if no DMA mode is set */
3015 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
3016 goto invalid_fld;
3018 /* sanity check for pio multi commands */
3019 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
3020 goto invalid_fld;
3022 if (is_multi_taskfile(tf)) {
3023 unsigned int multi_count = 1 << (cdb[1] >> 5);
3025 /* compare the passed through multi_count
3026 * with the cached multi_count of libata
3028 if (multi_count != dev->multi_count)
3029 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3030 multi_count);
3034 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3035 * SET_FEATURES - XFER MODE must be preceded/succeeded
3036 * by an update to hardware-specific registers for each
3037 * controller (i.e. the reason for ->set_piomode(),
3038 * ->set_dmamode(), and ->post_set_mode() hooks).
3040 if (tf->command == ATA_CMD_SET_FEATURES &&
3041 tf->feature == SETFEATURES_XFER)
3042 goto invalid_fld;
3045 * Filter TPM commands by default. These provide an
3046 * essentially uncontrolled encrypted "back door" between
3047 * applications and the disk. Set libata.allow_tpm=1 if you
3048 * have a real reason for wanting to use them. This ensures
3049 * that installed software cannot easily mess stuff up without
3050 * user intent. DVR type users will probably ship with this enabled
3051 * for movie content management.
3053 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3054 * for this and should do in future but that it is not sufficient as
3055 * DCS is an optional feature set. Thus we also do the software filter
3056 * so that we comply with the TC consortium stated goal that the user
3057 * can turn off TC features of their system.
3059 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
3060 goto invalid_fld;
3062 return 0;
3064 invalid_fld:
3065 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3066 /* "Invalid field in cdb" */
3067 return 1;
3070 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3072 struct ata_taskfile *tf = &qc->tf;
3073 struct scsi_cmnd *scmd = qc->scsicmd;
3074 struct ata_device *dev = qc->dev;
3075 const u8 *cdb = scmd->cmnd;
3076 u64 block;
3077 u32 n_block;
3078 u32 size;
3079 void *buf;
3081 /* we may not issue DMA commands if no DMA mode is set */
3082 if (unlikely(!dev->dma_mode))
3083 goto invalid_fld;
3085 if (unlikely(scmd->cmd_len < 16))
3086 goto invalid_fld;
3087 scsi_16_lba_len(cdb, &block, &n_block);
3089 /* for now we only support WRITE SAME with the unmap bit set */
3090 if (unlikely(!(cdb[1] & 0x8)))
3091 goto invalid_fld;
3094 * WRITE SAME always has a sector sized buffer as payload, this
3095 * should never be a multiple entry S/G list.
3097 if (!scsi_sg_count(scmd))
3098 goto invalid_fld;
3100 buf = page_address(sg_page(scsi_sglist(scmd)));
3101 size = ata_set_lba_range_entries(buf, 512, block, n_block);
3103 tf->protocol = ATA_PROT_DMA;
3104 tf->hob_feature = 0;
3105 tf->feature = ATA_DSM_TRIM;
3106 tf->hob_nsect = (size / 512) >> 8;
3107 tf->nsect = size / 512;
3108 tf->command = ATA_CMD_DSM;
3109 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3110 ATA_TFLAG_WRITE;
3112 ata_qc_set_pc_nbytes(qc);
3114 return 0;
3116 invalid_fld:
3117 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3118 /* "Invalid field in cdb" */
3119 return 1;
3123 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3124 * @qc: Storage for translated ATA taskfile
3125 * @buf: input buffer
3126 * @len: number of valid bytes in the input buffer
3128 * Prepare a taskfile to modify caching information for the device.
3130 * LOCKING:
3131 * None.
3133 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3134 const u8 *buf, int len)
3136 struct ata_taskfile *tf = &qc->tf;
3137 struct ata_device *dev = qc->dev;
3138 char mpage[CACHE_MPAGE_LEN];
3139 u8 wce;
3142 * The first two bytes of def_cache_mpage are a header, so offsets
3143 * in mpage are off by 2 compared to buf. Same for len.
3146 if (len != CACHE_MPAGE_LEN - 2)
3147 return -EINVAL;
3149 wce = buf[0] & (1 << 2);
3152 * Check that read-only bits are not modified.
3154 ata_msense_caching(dev->id, mpage, false);
3155 mpage[2] &= ~(1 << 2);
3156 mpage[2] |= wce;
3157 if (memcmp(mpage + 2, buf, CACHE_MPAGE_LEN - 2) != 0)
3158 return -EINVAL;
3160 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3161 tf->protocol = ATA_PROT_NODATA;
3162 tf->nsect = 0;
3163 tf->command = ATA_CMD_SET_FEATURES;
3164 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3165 return 0;
3169 * ata_scsiop_mode_select - Simulate MODE SELECT 6, 10 commands
3170 * @qc: Storage for translated ATA taskfile
3172 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3173 * Assume this is invoked for direct access devices (e.g. disks) only.
3174 * There should be no block descriptor for other device types.
3176 * LOCKING:
3177 * spin_lock_irqsave(host lock)
3179 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3181 struct scsi_cmnd *scmd = qc->scsicmd;
3182 const u8 *cdb = scmd->cmnd;
3183 const u8 *p;
3184 u8 pg, spg;
3185 unsigned six_byte, pg_len, hdr_len, bd_len;
3186 int len;
3188 VPRINTK("ENTER\n");
3190 six_byte = (cdb[0] == MODE_SELECT);
3191 if (six_byte) {
3192 if (scmd->cmd_len < 5)
3193 goto invalid_fld;
3195 len = cdb[4];
3196 hdr_len = 4;
3197 } else {
3198 if (scmd->cmd_len < 9)
3199 goto invalid_fld;
3201 len = (cdb[7] << 8) + cdb[8];
3202 hdr_len = 8;
3205 /* We only support PF=1, SP=0. */
3206 if ((cdb[1] & 0x11) != 0x10)
3207 goto invalid_fld;
3209 /* Test early for possible overrun. */
3210 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3211 goto invalid_param_len;
3213 p = page_address(sg_page(scsi_sglist(scmd)));
3215 /* Move past header and block descriptors. */
3216 if (len < hdr_len)
3217 goto invalid_param_len;
3219 if (six_byte)
3220 bd_len = p[3];
3221 else
3222 bd_len = (p[6] << 8) + p[7];
3224 len -= hdr_len;
3225 p += hdr_len;
3226 if (len < bd_len)
3227 goto invalid_param_len;
3228 if (bd_len != 0 && bd_len != 8)
3229 goto invalid_param;
3231 len -= bd_len;
3232 p += bd_len;
3233 if (len == 0)
3234 goto skip;
3236 /* Parse both possible formats for the mode page headers. */
3237 pg = p[0] & 0x3f;
3238 if (p[0] & 0x40) {
3239 if (len < 4)
3240 goto invalid_param_len;
3242 spg = p[1];
3243 pg_len = (p[2] << 8) | p[3];
3244 p += 4;
3245 len -= 4;
3246 } else {
3247 if (len < 2)
3248 goto invalid_param_len;
3250 spg = 0;
3251 pg_len = p[1];
3252 p += 2;
3253 len -= 2;
3257 * No mode subpages supported (yet) but asking for _all_
3258 * subpages may be valid
3260 if (spg && (spg != ALL_SUB_MPAGES))
3261 goto invalid_param;
3262 if (pg_len > len)
3263 goto invalid_param_len;
3265 switch (pg) {
3266 case CACHE_MPAGE:
3267 if (ata_mselect_caching(qc, p, pg_len) < 0)
3268 goto invalid_param;
3269 break;
3271 default: /* invalid page code */
3272 goto invalid_param;
3276 * Only one page has changeable data, so we only support setting one
3277 * page at a time.
3279 if (len > pg_len)
3280 goto invalid_param;
3282 return 0;
3284 invalid_fld:
3285 /* "Invalid field in CDB" */
3286 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
3287 return 1;
3289 invalid_param:
3290 /* "Invalid field in parameter list" */
3291 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x26, 0x0);
3292 return 1;
3294 invalid_param_len:
3295 /* "Parameter list length error" */
3296 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3297 return 1;
3299 skip:
3300 scmd->result = SAM_STAT_GOOD;
3301 return 1;
3305 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3306 * @dev: ATA device
3307 * @cmd: SCSI command opcode to consider
3309 * Look up the SCSI command given, and determine whether the
3310 * SCSI command is to be translated or simulated.
3312 * RETURNS:
3313 * Pointer to translation function if possible, %NULL if not.
3316 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3318 switch (cmd) {
3319 case READ_6:
3320 case READ_10:
3321 case READ_16:
3323 case WRITE_6:
3324 case WRITE_10:
3325 case WRITE_16:
3326 return ata_scsi_rw_xlat;
3328 case WRITE_SAME_16:
3329 return ata_scsi_write_same_xlat;
3331 case SYNCHRONIZE_CACHE:
3332 if (ata_try_flush_cache(dev))
3333 return ata_scsi_flush_xlat;
3334 break;
3336 case VERIFY:
3337 case VERIFY_16:
3338 return ata_scsi_verify_xlat;
3340 case ATA_12:
3341 case ATA_16:
3342 return ata_scsi_pass_thru;
3344 case MODE_SELECT:
3345 case MODE_SELECT_10:
3346 return ata_scsi_mode_select_xlat;
3347 break;
3349 case START_STOP:
3350 return ata_scsi_start_stop_xlat;
3353 return NULL;
3357 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3358 * @ap: ATA port to which the command was being sent
3359 * @cmd: SCSI command to dump
3361 * Prints the contents of a SCSI command via printk().
3364 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3365 struct scsi_cmnd *cmd)
3367 #ifdef ATA_DEBUG
3368 struct scsi_device *scsidev = cmd->device;
3369 u8 *scsicmd = cmd->cmnd;
3371 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3372 ap->print_id,
3373 scsidev->channel, scsidev->id, scsidev->lun,
3374 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3375 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3376 scsicmd[8]);
3377 #endif
3380 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3381 struct ata_device *dev)
3383 u8 scsi_op = scmd->cmnd[0];
3384 ata_xlat_func_t xlat_func;
3385 int rc = 0;
3387 if (dev->class == ATA_DEV_ATA) {
3388 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3389 goto bad_cdb_len;
3391 xlat_func = ata_get_xlat_func(dev, scsi_op);
3392 } else {
3393 if (unlikely(!scmd->cmd_len))
3394 goto bad_cdb_len;
3396 xlat_func = NULL;
3397 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3398 /* relay SCSI command to ATAPI device */
3399 int len = COMMAND_SIZE(scsi_op);
3400 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3401 goto bad_cdb_len;
3403 xlat_func = atapi_xlat;
3404 } else {
3405 /* ATA_16 passthru, treat as an ATA command */
3406 if (unlikely(scmd->cmd_len > 16))
3407 goto bad_cdb_len;
3409 xlat_func = ata_get_xlat_func(dev, scsi_op);
3413 if (xlat_func)
3414 rc = ata_scsi_translate(dev, scmd, xlat_func);
3415 else
3416 ata_scsi_simulate(dev, scmd);
3418 return rc;
3420 bad_cdb_len:
3421 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3422 scmd->cmd_len, scsi_op, dev->cdb_len);
3423 scmd->result = DID_ERROR << 16;
3424 scmd->scsi_done(scmd);
3425 return 0;
3429 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3430 * @shost: SCSI host of command to be sent
3431 * @cmd: SCSI command to be sent
3433 * In some cases, this function translates SCSI commands into
3434 * ATA taskfiles, and queues the taskfiles to be sent to
3435 * hardware. In other cases, this function simulates a
3436 * SCSI device by evaluating and responding to certain
3437 * SCSI commands. This creates the overall effect of
3438 * ATA and ATAPI devices appearing as SCSI devices.
3440 * LOCKING:
3441 * ATA host lock
3443 * RETURNS:
3444 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3445 * 0 otherwise.
3447 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
3449 struct ata_port *ap;
3450 struct ata_device *dev;
3451 struct scsi_device *scsidev = cmd->device;
3452 int rc = 0;
3453 unsigned long irq_flags;
3455 ap = ata_shost_to_port(shost);
3457 spin_lock_irqsave(ap->lock, irq_flags);
3459 ata_scsi_dump_cdb(ap, cmd);
3461 dev = ata_scsi_find_dev(ap, scsidev);
3462 if (likely(dev))
3463 rc = __ata_scsi_queuecmd(cmd, dev);
3464 else {
3465 cmd->result = (DID_BAD_TARGET << 16);
3466 cmd->scsi_done(cmd);
3469 spin_unlock_irqrestore(ap->lock, irq_flags);
3471 return rc;
3475 * ata_scsi_simulate - simulate SCSI command on ATA device
3476 * @dev: the target device
3477 * @cmd: SCSI command being sent to device.
3479 * Interprets and directly executes a select list of SCSI commands
3480 * that can be handled internally.
3482 * LOCKING:
3483 * spin_lock_irqsave(host lock)
3486 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
3488 struct ata_scsi_args args;
3489 const u8 *scsicmd = cmd->cmnd;
3490 u8 tmp8;
3492 args.dev = dev;
3493 args.id = dev->id;
3494 args.cmd = cmd;
3495 args.done = cmd->scsi_done;
3497 switch(scsicmd[0]) {
3498 /* TODO: worth improving? */
3499 case FORMAT_UNIT:
3500 ata_scsi_invalid_field(cmd);
3501 break;
3503 case INQUIRY:
3504 if (scsicmd[1] & 2) /* is CmdDt set? */
3505 ata_scsi_invalid_field(cmd);
3506 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3507 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3508 else switch (scsicmd[2]) {
3509 case 0x00:
3510 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3511 break;
3512 case 0x80:
3513 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3514 break;
3515 case 0x83:
3516 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3517 break;
3518 case 0x89:
3519 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3520 break;
3521 case 0xb0:
3522 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3523 break;
3524 case 0xb1:
3525 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3526 break;
3527 case 0xb2:
3528 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
3529 break;
3530 default:
3531 ata_scsi_invalid_field(cmd);
3532 break;
3534 break;
3536 case MODE_SENSE:
3537 case MODE_SENSE_10:
3538 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3539 break;
3541 case READ_CAPACITY:
3542 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3543 break;
3545 case SERVICE_ACTION_IN:
3546 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3547 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3548 else
3549 ata_scsi_invalid_field(cmd);
3550 break;
3552 case REPORT_LUNS:
3553 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3554 break;
3556 case REQUEST_SENSE:
3557 ata_scsi_set_sense(cmd, 0, 0, 0);
3558 cmd->result = (DRIVER_SENSE << 24);
3559 cmd->scsi_done(cmd);
3560 break;
3562 /* if we reach this, then writeback caching is disabled,
3563 * turning this into a no-op.
3565 case SYNCHRONIZE_CACHE:
3566 /* fall through */
3568 /* no-op's, complete with success */
3569 case REZERO_UNIT:
3570 case SEEK_6:
3571 case SEEK_10:
3572 case TEST_UNIT_READY:
3573 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3574 break;
3576 case SEND_DIAGNOSTIC:
3577 tmp8 = scsicmd[1] & ~(1 << 3);
3578 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3579 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3580 else
3581 ata_scsi_invalid_field(cmd);
3582 break;
3584 /* all other commands */
3585 default:
3586 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3587 /* "Invalid command operation code" */
3588 cmd->scsi_done(cmd);
3589 break;
3593 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3595 int i, rc;
3597 for (i = 0; i < host->n_ports; i++) {
3598 struct ata_port *ap = host->ports[i];
3599 struct Scsi_Host *shost;
3601 rc = -ENOMEM;
3602 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3603 if (!shost)
3604 goto err_alloc;
3606 shost->eh_noresume = 1;
3607 *(struct ata_port **)&shost->hostdata[0] = ap;
3608 ap->scsi_host = shost;
3610 shost->transportt = ata_scsi_transport_template;
3611 shost->unique_id = ap->print_id;
3612 shost->max_id = 16;
3613 shost->max_lun = 1;
3614 shost->max_channel = 1;
3615 shost->max_cmd_len = 16;
3617 /* Schedule policy is determined by ->qc_defer()
3618 * callback and it needs to see every deferred qc.
3619 * Set host_blocked to 1 to prevent SCSI midlayer from
3620 * automatically deferring requests.
3622 shost->max_host_blocked = 1;
3624 rc = scsi_add_host_with_dma(ap->scsi_host,
3625 &ap->tdev, ap->host->dev);
3626 if (rc)
3627 goto err_add;
3630 return 0;
3632 err_add:
3633 scsi_host_put(host->ports[i]->scsi_host);
3634 err_alloc:
3635 while (--i >= 0) {
3636 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3638 scsi_remove_host(shost);
3639 scsi_host_put(shost);
3641 return rc;
3644 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3646 int tries = 5;
3647 struct ata_device *last_failed_dev = NULL;
3648 struct ata_link *link;
3649 struct ata_device *dev;
3651 repeat:
3652 ata_for_each_link(link, ap, EDGE) {
3653 ata_for_each_dev(dev, link, ENABLED) {
3654 struct scsi_device *sdev;
3655 int channel = 0, id = 0;
3657 if (dev->sdev)
3658 continue;
3660 if (ata_is_host_link(link))
3661 id = dev->devno;
3662 else
3663 channel = link->pmp;
3665 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3666 NULL);
3667 if (!IS_ERR(sdev)) {
3668 dev->sdev = sdev;
3669 scsi_device_put(sdev);
3670 if (zpodd_dev_enabled(dev))
3671 dev_pm_qos_expose_flags(
3672 &sdev->sdev_gendev, 0);
3673 } else {
3674 dev->sdev = NULL;
3679 /* If we scanned while EH was in progress or allocation
3680 * failure occurred, scan would have failed silently. Check
3681 * whether all devices are attached.
3683 ata_for_each_link(link, ap, EDGE) {
3684 ata_for_each_dev(dev, link, ENABLED) {
3685 if (!dev->sdev)
3686 goto exit_loop;
3689 exit_loop:
3690 if (!link)
3691 return;
3693 /* we're missing some SCSI devices */
3694 if (sync) {
3695 /* If caller requested synchrnous scan && we've made
3696 * any progress, sleep briefly and repeat.
3698 if (dev != last_failed_dev) {
3699 msleep(100);
3700 last_failed_dev = dev;
3701 goto repeat;
3704 /* We might be failing to detect boot device, give it
3705 * a few more chances.
3707 if (--tries) {
3708 msleep(100);
3709 goto repeat;
3712 ata_port_err(ap,
3713 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
3716 queue_delayed_work(system_long_wq, &ap->hotplug_task,
3717 round_jiffies_relative(HZ));
3721 * ata_scsi_offline_dev - offline attached SCSI device
3722 * @dev: ATA device to offline attached SCSI device for
3724 * This function is called from ata_eh_hotplug() and responsible
3725 * for taking the SCSI device attached to @dev offline. This
3726 * function is called with host lock which protects dev->sdev
3727 * against clearing.
3729 * LOCKING:
3730 * spin_lock_irqsave(host lock)
3732 * RETURNS:
3733 * 1 if attached SCSI device exists, 0 otherwise.
3735 int ata_scsi_offline_dev(struct ata_device *dev)
3737 if (dev->sdev) {
3738 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3739 return 1;
3741 return 0;
3745 * ata_scsi_remove_dev - remove attached SCSI device
3746 * @dev: ATA device to remove attached SCSI device for
3748 * This function is called from ata_eh_scsi_hotplug() and
3749 * responsible for removing the SCSI device attached to @dev.
3751 * LOCKING:
3752 * Kernel thread context (may sleep).
3754 static void ata_scsi_remove_dev(struct ata_device *dev)
3756 struct ata_port *ap = dev->link->ap;
3757 struct scsi_device *sdev;
3758 unsigned long flags;
3760 /* Alas, we need to grab scan_mutex to ensure SCSI device
3761 * state doesn't change underneath us and thus
3762 * scsi_device_get() always succeeds. The mutex locking can
3763 * be removed if there is __scsi_device_get() interface which
3764 * increments reference counts regardless of device state.
3766 mutex_lock(&ap->scsi_host->scan_mutex);
3767 spin_lock_irqsave(ap->lock, flags);
3769 if (zpodd_dev_enabled(dev))
3770 zpodd_exit(dev);
3772 /* clearing dev->sdev is protected by host lock */
3773 sdev = dev->sdev;
3774 dev->sdev = NULL;
3776 if (sdev) {
3777 /* If user initiated unplug races with us, sdev can go
3778 * away underneath us after the host lock and
3779 * scan_mutex are released. Hold onto it.
3781 if (scsi_device_get(sdev) == 0) {
3782 /* The following ensures the attached sdev is
3783 * offline on return from ata_scsi_offline_dev()
3784 * regardless it wins or loses the race
3785 * against this function.
3787 scsi_device_set_state(sdev, SDEV_OFFLINE);
3788 } else {
3789 WARN_ON(1);
3790 sdev = NULL;
3794 spin_unlock_irqrestore(ap->lock, flags);
3795 mutex_unlock(&ap->scsi_host->scan_mutex);
3797 if (sdev) {
3798 ata_dev_info(dev, "detaching (SCSI %s)\n",
3799 dev_name(&sdev->sdev_gendev));
3801 scsi_remove_device(sdev);
3802 scsi_device_put(sdev);
3806 static void ata_scsi_handle_link_detach(struct ata_link *link)
3808 struct ata_port *ap = link->ap;
3809 struct ata_device *dev;
3811 ata_for_each_dev(dev, link, ALL) {
3812 unsigned long flags;
3814 if (!(dev->flags & ATA_DFLAG_DETACHED))
3815 continue;
3817 spin_lock_irqsave(ap->lock, flags);
3818 dev->flags &= ~ATA_DFLAG_DETACHED;
3819 spin_unlock_irqrestore(ap->lock, flags);
3821 ata_scsi_remove_dev(dev);
3826 * ata_scsi_media_change_notify - send media change event
3827 * @dev: Pointer to the disk device with media change event
3829 * Tell the block layer to send a media change notification
3830 * event.
3832 * LOCKING:
3833 * spin_lock_irqsave(host lock)
3835 void ata_scsi_media_change_notify(struct ata_device *dev)
3837 if (dev->sdev)
3838 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3839 GFP_ATOMIC);
3843 * ata_scsi_hotplug - SCSI part of hotplug
3844 * @work: Pointer to ATA port to perform SCSI hotplug on
3846 * Perform SCSI part of hotplug. It's executed from a separate
3847 * workqueue after EH completes. This is necessary because SCSI
3848 * hot plugging requires working EH and hot unplugging is
3849 * synchronized with hot plugging with a mutex.
3851 * LOCKING:
3852 * Kernel thread context (may sleep).
3854 void ata_scsi_hotplug(struct work_struct *work)
3856 struct ata_port *ap =
3857 container_of(work, struct ata_port, hotplug_task.work);
3858 int i;
3860 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3861 DPRINTK("ENTER/EXIT - unloading\n");
3862 return;
3865 DPRINTK("ENTER\n");
3866 mutex_lock(&ap->scsi_scan_mutex);
3868 /* Unplug detached devices. We cannot use link iterator here
3869 * because PMP links have to be scanned even if PMP is
3870 * currently not attached. Iterate manually.
3872 ata_scsi_handle_link_detach(&ap->link);
3873 if (ap->pmp_link)
3874 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3875 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3877 /* scan for new ones */
3878 ata_scsi_scan_host(ap, 0);
3880 mutex_unlock(&ap->scsi_scan_mutex);
3881 DPRINTK("EXIT\n");
3885 * ata_scsi_user_scan - indication for user-initiated bus scan
3886 * @shost: SCSI host to scan
3887 * @channel: Channel to scan
3888 * @id: ID to scan
3889 * @lun: LUN to scan
3891 * This function is called when user explicitly requests bus
3892 * scan. Set probe pending flag and invoke EH.
3894 * LOCKING:
3895 * SCSI layer (we don't care)
3897 * RETURNS:
3898 * Zero.
3900 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3901 unsigned int id, unsigned int lun)
3903 struct ata_port *ap = ata_shost_to_port(shost);
3904 unsigned long flags;
3905 int devno, rc = 0;
3907 if (!ap->ops->error_handler)
3908 return -EOPNOTSUPP;
3910 if (lun != SCAN_WILD_CARD && lun)
3911 return -EINVAL;
3913 if (!sata_pmp_attached(ap)) {
3914 if (channel != SCAN_WILD_CARD && channel)
3915 return -EINVAL;
3916 devno = id;
3917 } else {
3918 if (id != SCAN_WILD_CARD && id)
3919 return -EINVAL;
3920 devno = channel;
3923 spin_lock_irqsave(ap->lock, flags);
3925 if (devno == SCAN_WILD_CARD) {
3926 struct ata_link *link;
3928 ata_for_each_link(link, ap, EDGE) {
3929 struct ata_eh_info *ehi = &link->eh_info;
3930 ehi->probe_mask |= ATA_ALL_DEVICES;
3931 ehi->action |= ATA_EH_RESET;
3933 } else {
3934 struct ata_device *dev = ata_find_dev(ap, devno);
3936 if (dev) {
3937 struct ata_eh_info *ehi = &dev->link->eh_info;
3938 ehi->probe_mask |= 1 << dev->devno;
3939 ehi->action |= ATA_EH_RESET;
3940 } else
3941 rc = -EINVAL;
3944 if (rc == 0) {
3945 ata_port_schedule_eh(ap);
3946 spin_unlock_irqrestore(ap->lock, flags);
3947 ata_port_wait_eh(ap);
3948 } else
3949 spin_unlock_irqrestore(ap->lock, flags);
3951 return rc;
3955 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3956 * @work: Pointer to ATA port to perform scsi_rescan_device()
3958 * After ATA pass thru (SAT) commands are executed successfully,
3959 * libata need to propagate the changes to SCSI layer.
3961 * LOCKING:
3962 * Kernel thread context (may sleep).
3964 void ata_scsi_dev_rescan(struct work_struct *work)
3966 struct ata_port *ap =
3967 container_of(work, struct ata_port, scsi_rescan_task);
3968 struct ata_link *link;
3969 struct ata_device *dev;
3970 unsigned long flags;
3972 mutex_lock(&ap->scsi_scan_mutex);
3973 spin_lock_irqsave(ap->lock, flags);
3975 ata_for_each_link(link, ap, EDGE) {
3976 ata_for_each_dev(dev, link, ENABLED) {
3977 struct scsi_device *sdev = dev->sdev;
3979 if (!sdev)
3980 continue;
3981 if (scsi_device_get(sdev))
3982 continue;
3984 spin_unlock_irqrestore(ap->lock, flags);
3985 scsi_rescan_device(&(sdev->sdev_gendev));
3986 scsi_device_put(sdev);
3987 spin_lock_irqsave(ap->lock, flags);
3991 spin_unlock_irqrestore(ap->lock, flags);
3992 mutex_unlock(&ap->scsi_scan_mutex);
3996 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3997 * @host: ATA host container for all SAS ports
3998 * @port_info: Information from low-level host driver
3999 * @shost: SCSI host that the scsi device is attached to
4001 * LOCKING:
4002 * PCI/etc. bus probe sem.
4004 * RETURNS:
4005 * ata_port pointer on success / NULL on failure.
4008 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
4009 struct ata_port_info *port_info,
4010 struct Scsi_Host *shost)
4012 struct ata_port *ap;
4014 ap = ata_port_alloc(host);
4015 if (!ap)
4016 return NULL;
4018 ap->port_no = 0;
4019 ap->lock = &host->lock;
4020 ap->pio_mask = port_info->pio_mask;
4021 ap->mwdma_mask = port_info->mwdma_mask;
4022 ap->udma_mask = port_info->udma_mask;
4023 ap->flags |= port_info->flags;
4024 ap->ops = port_info->port_ops;
4025 ap->cbl = ATA_CBL_SATA;
4027 return ap;
4029 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4032 * ata_sas_port_start - Set port up for dma.
4033 * @ap: Port to initialize
4035 * Called just after data structures for each port are
4036 * initialized.
4038 * May be used as the port_start() entry in ata_port_operations.
4040 * LOCKING:
4041 * Inherited from caller.
4043 int ata_sas_port_start(struct ata_port *ap)
4046 * the port is marked as frozen at allocation time, but if we don't
4047 * have new eh, we won't thaw it
4049 if (!ap->ops->error_handler)
4050 ap->pflags &= ~ATA_PFLAG_FROZEN;
4051 return 0;
4053 EXPORT_SYMBOL_GPL(ata_sas_port_start);
4056 * ata_port_stop - Undo ata_sas_port_start()
4057 * @ap: Port to shut down
4059 * May be used as the port_stop() entry in ata_port_operations.
4061 * LOCKING:
4062 * Inherited from caller.
4065 void ata_sas_port_stop(struct ata_port *ap)
4068 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
4071 * ata_sas_async_probe - simply schedule probing and return
4072 * @ap: Port to probe
4074 * For batch scheduling of probe for sas attached ata devices, assumes
4075 * the port has already been through ata_sas_port_init()
4077 void ata_sas_async_probe(struct ata_port *ap)
4079 __ata_port_probe(ap);
4081 EXPORT_SYMBOL_GPL(ata_sas_async_probe);
4083 int ata_sas_sync_probe(struct ata_port *ap)
4085 return ata_port_probe(ap);
4087 EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
4091 * ata_sas_port_init - Initialize a SATA device
4092 * @ap: SATA port to initialize
4094 * LOCKING:
4095 * PCI/etc. bus probe sem.
4097 * RETURNS:
4098 * Zero on success, non-zero on error.
4101 int ata_sas_port_init(struct ata_port *ap)
4103 int rc = ap->ops->port_start(ap);
4105 if (rc)
4106 return rc;
4107 ap->print_id = atomic_inc_return(&ata_print_id);
4108 return 0;
4110 EXPORT_SYMBOL_GPL(ata_sas_port_init);
4113 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
4114 * @ap: SATA port to destroy
4118 void ata_sas_port_destroy(struct ata_port *ap)
4120 if (ap->ops->port_stop)
4121 ap->ops->port_stop(ap);
4122 kfree(ap);
4124 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
4127 * ata_sas_slave_configure - Default slave_config routine for libata devices
4128 * @sdev: SCSI device to configure
4129 * @ap: ATA port to which SCSI device is attached
4131 * RETURNS:
4132 * Zero.
4135 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
4137 ata_scsi_sdev_config(sdev);
4138 ata_scsi_dev_config(sdev, ap->link.device);
4139 return 0;
4141 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
4144 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
4145 * @cmd: SCSI command to be sent
4146 * @ap: ATA port to which the command is being sent
4148 * RETURNS:
4149 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4150 * 0 otherwise.
4153 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
4155 int rc = 0;
4157 ata_scsi_dump_cdb(ap, cmd);
4159 if (likely(ata_dev_enabled(ap->link.device)))
4160 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
4161 else {
4162 cmd->result = (DID_BAD_TARGET << 16);
4163 cmd->scsi_done(cmd);
4165 return rc;
4167 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);