tty/serial: atmel_serial: whitespace and braces modifications
[zen-stable.git] / drivers / ata / libata-scsi.c
blob46d087f086075f0d2eb5aae43b3e5e6f4d231f4c
1 /*
2 * libata-scsi.c - helper library for ATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
36 #include <linux/slab.h>
37 #include <linux/kernel.h>
38 #include <linux/blkdev.h>
39 #include <linux/spinlock.h>
40 #include <scsi/scsi.h>
41 #include <scsi/scsi_host.h>
42 #include <scsi/scsi_cmnd.h>
43 #include <scsi/scsi_eh.h>
44 #include <scsi/scsi_device.h>
45 #include <scsi/scsi_tcq.h>
46 #include <scsi/scsi_transport.h>
47 #include <linux/libata.h>
48 #include <linux/hdreg.h>
49 #include <linux/uaccess.h>
50 #include <linux/suspend.h>
51 #include <asm/unaligned.h>
53 #include "libata.h"
54 #include "libata-transport.h"
56 #define ATA_SCSI_RBUF_SIZE 4096
58 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
59 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
61 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
63 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
64 const struct scsi_device *scsidev);
65 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
66 const struct scsi_device *scsidev);
68 #define RW_RECOVERY_MPAGE 0x1
69 #define RW_RECOVERY_MPAGE_LEN 12
70 #define CACHE_MPAGE 0x8
71 #define CACHE_MPAGE_LEN 20
72 #define CONTROL_MPAGE 0xa
73 #define CONTROL_MPAGE_LEN 12
74 #define ALL_MPAGES 0x3f
75 #define ALL_SUB_MPAGES 0xff
78 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
79 RW_RECOVERY_MPAGE,
80 RW_RECOVERY_MPAGE_LEN - 2,
81 (1 << 7), /* AWRE */
82 0, /* read retry count */
83 0, 0, 0, 0,
84 0, /* write retry count */
85 0, 0, 0
88 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
89 CACHE_MPAGE,
90 CACHE_MPAGE_LEN - 2,
91 0, /* contains WCE, needs to be 0 for logic */
92 0, 0, 0, 0, 0, 0, 0, 0, 0,
93 0, /* contains DRA, needs to be 0 for logic */
94 0, 0, 0, 0, 0, 0, 0
97 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
98 CONTROL_MPAGE,
99 CONTROL_MPAGE_LEN - 2,
100 2, /* DSENSE=0, GLTSD=1 */
101 0, /* [QAM+QERR may be 1, see 05-359r1] */
102 0, 0, 0, 0, 0xff, 0xff,
103 0, 30 /* extended self test time, see 05-359r1 */
106 static const char *ata_lpm_policy_names[] = {
107 [ATA_LPM_UNKNOWN] = "max_performance",
108 [ATA_LPM_MAX_POWER] = "max_performance",
109 [ATA_LPM_MED_POWER] = "medium_power",
110 [ATA_LPM_MIN_POWER] = "min_power",
113 static ssize_t ata_scsi_lpm_store(struct device *dev,
114 struct device_attribute *attr,
115 const char *buf, size_t count)
117 struct Scsi_Host *shost = class_to_shost(dev);
118 struct ata_port *ap = ata_shost_to_port(shost);
119 enum ata_lpm_policy policy;
120 unsigned long flags;
122 /* UNKNOWN is internal state, iterate from MAX_POWER */
123 for (policy = ATA_LPM_MAX_POWER;
124 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
125 const char *name = ata_lpm_policy_names[policy];
127 if (strncmp(name, buf, strlen(name)) == 0)
128 break;
130 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
131 return -EINVAL;
133 spin_lock_irqsave(ap->lock, flags);
134 ap->target_lpm_policy = policy;
135 ata_port_schedule_eh(ap);
136 spin_unlock_irqrestore(ap->lock, flags);
138 return count;
141 static ssize_t ata_scsi_lpm_show(struct device *dev,
142 struct device_attribute *attr, char *buf)
144 struct Scsi_Host *shost = class_to_shost(dev);
145 struct ata_port *ap = ata_shost_to_port(shost);
147 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
148 return -EINVAL;
150 return snprintf(buf, PAGE_SIZE, "%s\n",
151 ata_lpm_policy_names[ap->target_lpm_policy]);
153 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
154 ata_scsi_lpm_show, ata_scsi_lpm_store);
155 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
157 static ssize_t ata_scsi_park_show(struct device *device,
158 struct device_attribute *attr, char *buf)
160 struct scsi_device *sdev = to_scsi_device(device);
161 struct ata_port *ap;
162 struct ata_link *link;
163 struct ata_device *dev;
164 unsigned long flags, now;
165 unsigned int uninitialized_var(msecs);
166 int rc = 0;
168 ap = ata_shost_to_port(sdev->host);
170 spin_lock_irqsave(ap->lock, flags);
171 dev = ata_scsi_find_dev(ap, sdev);
172 if (!dev) {
173 rc = -ENODEV;
174 goto unlock;
176 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
177 rc = -EOPNOTSUPP;
178 goto unlock;
181 link = dev->link;
182 now = jiffies;
183 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
184 link->eh_context.unloaded_mask & (1 << dev->devno) &&
185 time_after(dev->unpark_deadline, now))
186 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
187 else
188 msecs = 0;
190 unlock:
191 spin_unlock_irq(ap->lock);
193 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
196 static ssize_t ata_scsi_park_store(struct device *device,
197 struct device_attribute *attr,
198 const char *buf, size_t len)
200 struct scsi_device *sdev = to_scsi_device(device);
201 struct ata_port *ap;
202 struct ata_device *dev;
203 long int input;
204 unsigned long flags;
205 int rc;
207 rc = strict_strtol(buf, 10, &input);
208 if (rc || input < -2)
209 return -EINVAL;
210 if (input > ATA_TMOUT_MAX_PARK) {
211 rc = -EOVERFLOW;
212 input = ATA_TMOUT_MAX_PARK;
215 ap = ata_shost_to_port(sdev->host);
217 spin_lock_irqsave(ap->lock, flags);
218 dev = ata_scsi_find_dev(ap, sdev);
219 if (unlikely(!dev)) {
220 rc = -ENODEV;
221 goto unlock;
223 if (dev->class != ATA_DEV_ATA) {
224 rc = -EOPNOTSUPP;
225 goto unlock;
228 if (input >= 0) {
229 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
230 rc = -EOPNOTSUPP;
231 goto unlock;
234 dev->unpark_deadline = ata_deadline(jiffies, input);
235 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
236 ata_port_schedule_eh(ap);
237 complete(&ap->park_req_pending);
238 } else {
239 switch (input) {
240 case -1:
241 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
242 break;
243 case -2:
244 dev->flags |= ATA_DFLAG_NO_UNLOAD;
245 break;
248 unlock:
249 spin_unlock_irqrestore(ap->lock, flags);
251 return rc ? rc : len;
253 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
254 ata_scsi_park_show, ata_scsi_park_store);
255 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
257 static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
259 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
261 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
264 static ssize_t
265 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
266 const char *buf, size_t count)
268 struct Scsi_Host *shost = class_to_shost(dev);
269 struct ata_port *ap = ata_shost_to_port(shost);
270 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
271 return ap->ops->em_store(ap, buf, count);
272 return -EINVAL;
275 static ssize_t
276 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
277 char *buf)
279 struct Scsi_Host *shost = class_to_shost(dev);
280 struct ata_port *ap = ata_shost_to_port(shost);
282 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
283 return ap->ops->em_show(ap, buf);
284 return -EINVAL;
286 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
287 ata_scsi_em_message_show, ata_scsi_em_message_store);
288 EXPORT_SYMBOL_GPL(dev_attr_em_message);
290 static ssize_t
291 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
292 char *buf)
294 struct Scsi_Host *shost = class_to_shost(dev);
295 struct ata_port *ap = ata_shost_to_port(shost);
297 return snprintf(buf, 23, "%d\n", ap->em_message_type);
299 DEVICE_ATTR(em_message_type, S_IRUGO,
300 ata_scsi_em_message_type_show, NULL);
301 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
303 static ssize_t
304 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
305 char *buf)
307 struct scsi_device *sdev = to_scsi_device(dev);
308 struct ata_port *ap = ata_shost_to_port(sdev->host);
309 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
311 if (ap->ops->sw_activity_show && (ap->flags & ATA_FLAG_SW_ACTIVITY))
312 return ap->ops->sw_activity_show(atadev, buf);
313 return -EINVAL;
316 static ssize_t
317 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
318 const char *buf, size_t count)
320 struct scsi_device *sdev = to_scsi_device(dev);
321 struct ata_port *ap = ata_shost_to_port(sdev->host);
322 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
323 enum sw_activity val;
324 int rc;
326 if (ap->ops->sw_activity_store && (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
327 val = simple_strtoul(buf, NULL, 0);
328 switch (val) {
329 case OFF: case BLINK_ON: case BLINK_OFF:
330 rc = ap->ops->sw_activity_store(atadev, val);
331 if (!rc)
332 return count;
333 else
334 return rc;
337 return -EINVAL;
339 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
340 ata_scsi_activity_store);
341 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
343 struct device_attribute *ata_common_sdev_attrs[] = {
344 &dev_attr_unload_heads,
345 NULL
347 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
349 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd)
351 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
352 /* "Invalid field in cbd" */
353 cmd->scsi_done(cmd);
357 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
358 * @sdev: SCSI device for which BIOS geometry is to be determined
359 * @bdev: block device associated with @sdev
360 * @capacity: capacity of SCSI device
361 * @geom: location to which geometry will be output
363 * Generic bios head/sector/cylinder calculator
364 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
365 * mapping. Some situations may arise where the disk is not
366 * bootable if this is not used.
368 * LOCKING:
369 * Defined by the SCSI layer. We don't really care.
371 * RETURNS:
372 * Zero.
374 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
375 sector_t capacity, int geom[])
377 geom[0] = 255;
378 geom[1] = 63;
379 sector_div(capacity, 255*63);
380 geom[2] = capacity;
382 return 0;
386 * ata_scsi_unlock_native_capacity - unlock native capacity
387 * @sdev: SCSI device to adjust device capacity for
389 * This function is called if a partition on @sdev extends beyond
390 * the end of the device. It requests EH to unlock HPA.
392 * LOCKING:
393 * Defined by the SCSI layer. Might sleep.
395 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
397 struct ata_port *ap = ata_shost_to_port(sdev->host);
398 struct ata_device *dev;
399 unsigned long flags;
401 spin_lock_irqsave(ap->lock, flags);
403 dev = ata_scsi_find_dev(ap, sdev);
404 if (dev && dev->n_sectors < dev->n_native_sectors) {
405 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
406 dev->link->eh_info.action |= ATA_EH_RESET;
407 ata_port_schedule_eh(ap);
410 spin_unlock_irqrestore(ap->lock, flags);
411 ata_port_wait_eh(ap);
415 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
416 * @ap: target port
417 * @sdev: SCSI device to get identify data for
418 * @arg: User buffer area for identify data
420 * LOCKING:
421 * Defined by the SCSI layer. We don't really care.
423 * RETURNS:
424 * Zero on success, negative errno on error.
426 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
427 void __user *arg)
429 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
430 u16 __user *dst = arg;
431 char buf[40];
433 if (!dev)
434 return -ENOMSG;
436 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
437 return -EFAULT;
439 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
440 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
441 return -EFAULT;
443 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
444 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
445 return -EFAULT;
447 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
448 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
449 return -EFAULT;
451 return 0;
455 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
456 * @scsidev: Device to which we are issuing command
457 * @arg: User provided data for issuing command
459 * LOCKING:
460 * Defined by the SCSI layer. We don't really care.
462 * RETURNS:
463 * Zero on success, negative errno on error.
465 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
467 int rc = 0;
468 u8 scsi_cmd[MAX_COMMAND_SIZE];
469 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
470 int argsize = 0;
471 enum dma_data_direction data_dir;
472 int cmd_result;
474 if (arg == NULL)
475 return -EINVAL;
477 if (copy_from_user(args, arg, sizeof(args)))
478 return -EFAULT;
480 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
481 if (!sensebuf)
482 return -ENOMEM;
484 memset(scsi_cmd, 0, sizeof(scsi_cmd));
486 if (args[3]) {
487 argsize = ATA_SECT_SIZE * args[3];
488 argbuf = kmalloc(argsize, GFP_KERNEL);
489 if (argbuf == NULL) {
490 rc = -ENOMEM;
491 goto error;
494 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
495 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
496 block count in sector count field */
497 data_dir = DMA_FROM_DEVICE;
498 } else {
499 scsi_cmd[1] = (3 << 1); /* Non-data */
500 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
501 data_dir = DMA_NONE;
504 scsi_cmd[0] = ATA_16;
506 scsi_cmd[4] = args[2];
507 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
508 scsi_cmd[6] = args[3];
509 scsi_cmd[8] = args[1];
510 scsi_cmd[10] = 0x4f;
511 scsi_cmd[12] = 0xc2;
512 } else {
513 scsi_cmd[6] = args[1];
515 scsi_cmd[14] = args[0];
517 /* Good values for timeout and retries? Values below
518 from scsi_ioctl_send_command() for default case... */
519 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
520 sensebuf, (10*HZ), 5, 0, NULL);
522 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
523 u8 *desc = sensebuf + 8;
524 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
526 /* If we set cc then ATA pass-through will cause a
527 * check condition even if no error. Filter that. */
528 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
529 struct scsi_sense_hdr sshdr;
530 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
531 &sshdr);
532 if (sshdr.sense_key == 0 &&
533 sshdr.asc == 0 && sshdr.ascq == 0)
534 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
537 /* Send userspace a few ATA registers (same as drivers/ide) */
538 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
539 desc[0] == 0x09) { /* code is "ATA Descriptor" */
540 args[0] = desc[13]; /* status */
541 args[1] = desc[3]; /* error */
542 args[2] = desc[5]; /* sector count (0:7) */
543 if (copy_to_user(arg, args, sizeof(args)))
544 rc = -EFAULT;
549 if (cmd_result) {
550 rc = -EIO;
551 goto error;
554 if ((argbuf)
555 && copy_to_user(arg + sizeof(args), argbuf, argsize))
556 rc = -EFAULT;
557 error:
558 kfree(sensebuf);
559 kfree(argbuf);
560 return rc;
564 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
565 * @scsidev: Device to which we are issuing command
566 * @arg: User provided data for issuing command
568 * LOCKING:
569 * Defined by the SCSI layer. We don't really care.
571 * RETURNS:
572 * Zero on success, negative errno on error.
574 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
576 int rc = 0;
577 u8 scsi_cmd[MAX_COMMAND_SIZE];
578 u8 args[7], *sensebuf = NULL;
579 int cmd_result;
581 if (arg == NULL)
582 return -EINVAL;
584 if (copy_from_user(args, arg, sizeof(args)))
585 return -EFAULT;
587 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
588 if (!sensebuf)
589 return -ENOMEM;
591 memset(scsi_cmd, 0, sizeof(scsi_cmd));
592 scsi_cmd[0] = ATA_16;
593 scsi_cmd[1] = (3 << 1); /* Non-data */
594 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
595 scsi_cmd[4] = args[1];
596 scsi_cmd[6] = args[2];
597 scsi_cmd[8] = args[3];
598 scsi_cmd[10] = args[4];
599 scsi_cmd[12] = args[5];
600 scsi_cmd[13] = args[6] & 0x4f;
601 scsi_cmd[14] = args[0];
603 /* Good values for timeout and retries? Values below
604 from scsi_ioctl_send_command() for default case... */
605 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
606 sensebuf, (10*HZ), 5, 0, NULL);
608 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
609 u8 *desc = sensebuf + 8;
610 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
612 /* If we set cc then ATA pass-through will cause a
613 * check condition even if no error. Filter that. */
614 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
615 struct scsi_sense_hdr sshdr;
616 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
617 &sshdr);
618 if (sshdr.sense_key == 0 &&
619 sshdr.asc == 0 && sshdr.ascq == 0)
620 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
623 /* Send userspace ATA registers */
624 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
625 desc[0] == 0x09) {/* code is "ATA Descriptor" */
626 args[0] = desc[13]; /* status */
627 args[1] = desc[3]; /* error */
628 args[2] = desc[5]; /* sector count (0:7) */
629 args[3] = desc[7]; /* lbal */
630 args[4] = desc[9]; /* lbam */
631 args[5] = desc[11]; /* lbah */
632 args[6] = desc[12]; /* select */
633 if (copy_to_user(arg, args, sizeof(args)))
634 rc = -EFAULT;
638 if (cmd_result) {
639 rc = -EIO;
640 goto error;
643 error:
644 kfree(sensebuf);
645 return rc;
648 static int ata_ioc32(struct ata_port *ap)
650 if (ap->flags & ATA_FLAG_PIO_DMA)
651 return 1;
652 if (ap->pflags & ATA_PFLAG_PIO32)
653 return 1;
654 return 0;
657 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
658 int cmd, void __user *arg)
660 int val = -EINVAL, rc = -EINVAL;
661 unsigned long flags;
663 switch (cmd) {
664 case ATA_IOC_GET_IO32:
665 spin_lock_irqsave(ap->lock, flags);
666 val = ata_ioc32(ap);
667 spin_unlock_irqrestore(ap->lock, flags);
668 if (copy_to_user(arg, &val, 1))
669 return -EFAULT;
670 return 0;
672 case ATA_IOC_SET_IO32:
673 val = (unsigned long) arg;
674 rc = 0;
675 spin_lock_irqsave(ap->lock, flags);
676 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
677 if (val)
678 ap->pflags |= ATA_PFLAG_PIO32;
679 else
680 ap->pflags &= ~ATA_PFLAG_PIO32;
681 } else {
682 if (val != ata_ioc32(ap))
683 rc = -EINVAL;
685 spin_unlock_irqrestore(ap->lock, flags);
686 return rc;
688 case HDIO_GET_IDENTITY:
689 return ata_get_identity(ap, scsidev, arg);
691 case HDIO_DRIVE_CMD:
692 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
693 return -EACCES;
694 return ata_cmd_ioctl(scsidev, arg);
696 case HDIO_DRIVE_TASK:
697 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
698 return -EACCES;
699 return ata_task_ioctl(scsidev, arg);
701 default:
702 rc = -ENOTTY;
703 break;
706 return rc;
708 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
710 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
712 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
713 scsidev, cmd, arg);
715 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
718 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
719 * @dev: ATA device to which the new command is attached
720 * @cmd: SCSI command that originated this ATA command
722 * Obtain a reference to an unused ata_queued_cmd structure,
723 * which is the basic libata structure representing a single
724 * ATA command sent to the hardware.
726 * If a command was available, fill in the SCSI-specific
727 * portions of the structure with information on the
728 * current command.
730 * LOCKING:
731 * spin_lock_irqsave(host lock)
733 * RETURNS:
734 * Command allocated, or %NULL if none available.
736 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
737 struct scsi_cmnd *cmd)
739 struct ata_queued_cmd *qc;
741 qc = ata_qc_new_init(dev);
742 if (qc) {
743 qc->scsicmd = cmd;
744 qc->scsidone = cmd->scsi_done;
746 qc->sg = scsi_sglist(cmd);
747 qc->n_elem = scsi_sg_count(cmd);
748 } else {
749 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
750 cmd->scsi_done(cmd);
753 return qc;
756 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
758 struct scsi_cmnd *scmd = qc->scsicmd;
760 qc->extrabytes = scmd->request->extra_len;
761 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
765 * ata_dump_status - user friendly display of error info
766 * @id: id of the port in question
767 * @tf: ptr to filled out taskfile
769 * Decode and dump the ATA error/status registers for the user so
770 * that they have some idea what really happened at the non
771 * make-believe layer.
773 * LOCKING:
774 * inherited from caller
776 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
778 u8 stat = tf->command, err = tf->feature;
780 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
781 if (stat & ATA_BUSY) {
782 printk("Busy }\n"); /* Data is not valid in this case */
783 } else {
784 if (stat & 0x40) printk("DriveReady ");
785 if (stat & 0x20) printk("DeviceFault ");
786 if (stat & 0x10) printk("SeekComplete ");
787 if (stat & 0x08) printk("DataRequest ");
788 if (stat & 0x04) printk("CorrectedError ");
789 if (stat & 0x02) printk("Index ");
790 if (stat & 0x01) printk("Error ");
791 printk("}\n");
793 if (err) {
794 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
795 if (err & 0x04) printk("DriveStatusError ");
796 if (err & 0x80) {
797 if (err & 0x04) printk("BadCRC ");
798 else printk("Sector ");
800 if (err & 0x40) printk("UncorrectableError ");
801 if (err & 0x10) printk("SectorIdNotFound ");
802 if (err & 0x02) printk("TrackZeroNotFound ");
803 if (err & 0x01) printk("AddrMarkNotFound ");
804 printk("}\n");
810 * ata_to_sense_error - convert ATA error to SCSI error
811 * @id: ATA device number
812 * @drv_stat: value contained in ATA status register
813 * @drv_err: value contained in ATA error register
814 * @sk: the sense key we'll fill out
815 * @asc: the additional sense code we'll fill out
816 * @ascq: the additional sense code qualifier we'll fill out
817 * @verbose: be verbose
819 * Converts an ATA error into a SCSI error. Fill out pointers to
820 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
821 * format sense blocks.
823 * LOCKING:
824 * spin_lock_irqsave(host lock)
826 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
827 u8 *asc, u8 *ascq, int verbose)
829 int i;
831 /* Based on the 3ware driver translation table */
832 static const unsigned char sense_table[][4] = {
833 /* BBD|ECC|ID|MAR */
834 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
835 /* BBD|ECC|ID */
836 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
837 /* ECC|MC|MARK */
838 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
839 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
840 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
841 /* MC|ID|ABRT|TRK0|MARK */
842 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
843 /* MCR|MARK */
844 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
845 /* Bad address mark */
846 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
847 /* TRK0 */
848 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
849 /* Abort & !ICRC */
850 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
851 /* Media change request */
852 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
853 /* SRV */
854 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
855 /* Media change */
856 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
857 /* ECC */
858 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
859 /* BBD - block marked bad */
860 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
861 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
863 static const unsigned char stat_table[][4] = {
864 /* Must be first because BUSY means no other bits valid */
865 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
866 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
867 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
868 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
869 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
873 * Is this an error we can process/parse
875 if (drv_stat & ATA_BUSY) {
876 drv_err = 0; /* Ignore the err bits, they're invalid */
879 if (drv_err) {
880 /* Look for drv_err */
881 for (i = 0; sense_table[i][0] != 0xFF; i++) {
882 /* Look for best matches first */
883 if ((sense_table[i][0] & drv_err) ==
884 sense_table[i][0]) {
885 *sk = sense_table[i][1];
886 *asc = sense_table[i][2];
887 *ascq = sense_table[i][3];
888 goto translate_done;
891 /* No immediate match */
892 if (verbose)
893 printk(KERN_WARNING "ata%u: no sense translation for "
894 "error 0x%02x\n", id, drv_err);
897 /* Fall back to interpreting status bits */
898 for (i = 0; stat_table[i][0] != 0xFF; i++) {
899 if (stat_table[i][0] & drv_stat) {
900 *sk = stat_table[i][1];
901 *asc = stat_table[i][2];
902 *ascq = stat_table[i][3];
903 goto translate_done;
906 /* No error? Undecoded? */
907 if (verbose)
908 printk(KERN_WARNING "ata%u: no sense translation for "
909 "status: 0x%02x\n", id, drv_stat);
911 /* We need a sensible error return here, which is tricky, and one
912 that won't cause people to do things like return a disk wrongly */
913 *sk = ABORTED_COMMAND;
914 *asc = 0x00;
915 *ascq = 0x00;
917 translate_done:
918 if (verbose)
919 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
920 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
921 id, drv_stat, drv_err, *sk, *asc, *ascq);
922 return;
926 * ata_gen_passthru_sense - Generate check condition sense block.
927 * @qc: Command that completed.
929 * This function is specific to the ATA descriptor format sense
930 * block specified for the ATA pass through commands. Regardless
931 * of whether the command errored or not, return a sense
932 * block. Copy all controller registers into the sense
933 * block. Clear sense key, ASC & ASCQ if there is no error.
935 * LOCKING:
936 * None.
938 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
940 struct scsi_cmnd *cmd = qc->scsicmd;
941 struct ata_taskfile *tf = &qc->result_tf;
942 unsigned char *sb = cmd->sense_buffer;
943 unsigned char *desc = sb + 8;
944 int verbose = qc->ap->ops->error_handler == NULL;
946 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
948 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
951 * Use ata_to_sense_error() to map status register bits
952 * onto sense key, asc & ascq.
954 if (qc->err_mask ||
955 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
956 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
957 &sb[1], &sb[2], &sb[3], verbose);
958 sb[1] &= 0x0f;
962 * Sense data is current and format is descriptor.
964 sb[0] = 0x72;
966 desc[0] = 0x09;
968 /* set length of additional sense data */
969 sb[7] = 14;
970 desc[1] = 12;
973 * Copy registers into sense buffer.
975 desc[2] = 0x00;
976 desc[3] = tf->feature; /* == error reg */
977 desc[5] = tf->nsect;
978 desc[7] = tf->lbal;
979 desc[9] = tf->lbam;
980 desc[11] = tf->lbah;
981 desc[12] = tf->device;
982 desc[13] = tf->command; /* == status reg */
985 * Fill in Extend bit, and the high order bytes
986 * if applicable.
988 if (tf->flags & ATA_TFLAG_LBA48) {
989 desc[2] |= 0x01;
990 desc[4] = tf->hob_nsect;
991 desc[6] = tf->hob_lbal;
992 desc[8] = tf->hob_lbam;
993 desc[10] = tf->hob_lbah;
998 * ata_gen_ata_sense - generate a SCSI fixed sense block
999 * @qc: Command that we are erroring out
1001 * Generate sense block for a failed ATA command @qc. Descriptor
1002 * format is used to accommodate LBA48 block address.
1004 * LOCKING:
1005 * None.
1007 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1009 struct ata_device *dev = qc->dev;
1010 struct scsi_cmnd *cmd = qc->scsicmd;
1011 struct ata_taskfile *tf = &qc->result_tf;
1012 unsigned char *sb = cmd->sense_buffer;
1013 unsigned char *desc = sb + 8;
1014 int verbose = qc->ap->ops->error_handler == NULL;
1015 u64 block;
1017 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1019 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1021 /* sense data is current and format is descriptor */
1022 sb[0] = 0x72;
1024 /* Use ata_to_sense_error() to map status register bits
1025 * onto sense key, asc & ascq.
1027 if (qc->err_mask ||
1028 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1029 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1030 &sb[1], &sb[2], &sb[3], verbose);
1031 sb[1] &= 0x0f;
1034 block = ata_tf_read_block(&qc->result_tf, dev);
1036 /* information sense data descriptor */
1037 sb[7] = 12;
1038 desc[0] = 0x00;
1039 desc[1] = 10;
1041 desc[2] |= 0x80; /* valid */
1042 desc[6] = block >> 40;
1043 desc[7] = block >> 32;
1044 desc[8] = block >> 24;
1045 desc[9] = block >> 16;
1046 desc[10] = block >> 8;
1047 desc[11] = block;
1050 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1052 sdev->use_10_for_rw = 1;
1053 sdev->use_10_for_ms = 1;
1055 /* Schedule policy is determined by ->qc_defer() callback and
1056 * it needs to see every deferred qc. Set dev_blocked to 1 to
1057 * prevent SCSI midlayer from automatically deferring
1058 * requests.
1060 sdev->max_device_blocked = 1;
1064 * atapi_drain_needed - Check whether data transfer may overflow
1065 * @rq: request to be checked
1067 * ATAPI commands which transfer variable length data to host
1068 * might overflow due to application error or hardare bug. This
1069 * function checks whether overflow should be drained and ignored
1070 * for @request.
1072 * LOCKING:
1073 * None.
1075 * RETURNS:
1076 * 1 if ; otherwise, 0.
1078 static int atapi_drain_needed(struct request *rq)
1080 if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
1081 return 0;
1083 if (!blk_rq_bytes(rq) || (rq->cmd_flags & REQ_WRITE))
1084 return 0;
1086 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1089 static int ata_scsi_dev_config(struct scsi_device *sdev,
1090 struct ata_device *dev)
1092 struct request_queue *q = sdev->request_queue;
1094 if (!ata_id_has_unload(dev->id))
1095 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1097 /* configure max sectors */
1098 blk_queue_max_hw_sectors(q, dev->max_sectors);
1100 if (dev->class == ATA_DEV_ATAPI) {
1101 void *buf;
1103 sdev->sector_size = ATA_SECT_SIZE;
1105 /* set DMA padding */
1106 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1108 /* configure draining */
1109 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1110 if (!buf) {
1111 ata_dev_err(dev, "drain buffer allocation failed\n");
1112 return -ENOMEM;
1115 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1116 } else {
1117 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1118 sdev->manage_start_stop = 1;
1122 * ata_pio_sectors() expects buffer for each sector to not cross
1123 * page boundary. Enforce it by requiring buffers to be sector
1124 * aligned, which works iff sector_size is not larger than
1125 * PAGE_SIZE. ATAPI devices also need the alignment as
1126 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1128 if (sdev->sector_size > PAGE_SIZE)
1129 ata_dev_warn(dev,
1130 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1131 sdev->sector_size);
1133 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1135 if (dev->flags & ATA_DFLAG_AN)
1136 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1138 if (dev->flags & ATA_DFLAG_NCQ) {
1139 int depth;
1141 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1142 depth = min(ATA_MAX_QUEUE - 1, depth);
1143 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1146 blk_queue_flush_queueable(q, false);
1148 dev->sdev = sdev;
1149 return 0;
1153 * ata_scsi_slave_config - Set SCSI device attributes
1154 * @sdev: SCSI device to examine
1156 * This is called before we actually start reading
1157 * and writing to the device, to configure certain
1158 * SCSI mid-layer behaviors.
1160 * LOCKING:
1161 * Defined by SCSI layer. We don't really care.
1164 int ata_scsi_slave_config(struct scsi_device *sdev)
1166 struct ata_port *ap = ata_shost_to_port(sdev->host);
1167 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1168 int rc = 0;
1170 ata_scsi_sdev_config(sdev);
1172 if (dev)
1173 rc = ata_scsi_dev_config(sdev, dev);
1175 return rc;
1179 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1180 * @sdev: SCSI device to be destroyed
1182 * @sdev is about to be destroyed for hot/warm unplugging. If
1183 * this unplugging was initiated by libata as indicated by NULL
1184 * dev->sdev, this function doesn't have to do anything.
1185 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1186 * Clear dev->sdev, schedule the device for ATA detach and invoke
1187 * EH.
1189 * LOCKING:
1190 * Defined by SCSI layer. We don't really care.
1192 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1194 struct ata_port *ap = ata_shost_to_port(sdev->host);
1195 struct request_queue *q = sdev->request_queue;
1196 unsigned long flags;
1197 struct ata_device *dev;
1199 if (!ap->ops->error_handler)
1200 return;
1202 spin_lock_irqsave(ap->lock, flags);
1203 dev = __ata_scsi_find_dev(ap, sdev);
1204 if (dev && dev->sdev) {
1205 /* SCSI device already in CANCEL state, no need to offline it */
1206 dev->sdev = NULL;
1207 dev->flags |= ATA_DFLAG_DETACH;
1208 ata_port_schedule_eh(ap);
1210 spin_unlock_irqrestore(ap->lock, flags);
1212 kfree(q->dma_drain_buffer);
1213 q->dma_drain_buffer = NULL;
1214 q->dma_drain_size = 0;
1218 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1219 * @sdev: SCSI device to configure queue depth for
1220 * @queue_depth: new queue depth
1221 * @reason: calling context
1223 * This is libata standard hostt->change_queue_depth callback.
1224 * SCSI will call into this callback when user tries to set queue
1225 * depth via sysfs.
1227 * LOCKING:
1228 * SCSI layer (we don't care)
1230 * RETURNS:
1231 * Newly configured queue depth.
1233 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth,
1234 int reason)
1236 struct ata_port *ap = ata_shost_to_port(sdev->host);
1237 struct ata_device *dev;
1238 unsigned long flags;
1240 if (reason != SCSI_QDEPTH_DEFAULT)
1241 return -EOPNOTSUPP;
1243 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1244 return sdev->queue_depth;
1246 dev = ata_scsi_find_dev(ap, sdev);
1247 if (!dev || !ata_dev_enabled(dev))
1248 return sdev->queue_depth;
1250 /* NCQ enabled? */
1251 spin_lock_irqsave(ap->lock, flags);
1252 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1253 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1254 dev->flags |= ATA_DFLAG_NCQ_OFF;
1255 queue_depth = 1;
1257 spin_unlock_irqrestore(ap->lock, flags);
1259 /* limit and apply queue depth */
1260 queue_depth = min(queue_depth, sdev->host->can_queue);
1261 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1262 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1264 if (sdev->queue_depth == queue_depth)
1265 return -EINVAL;
1267 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1268 return queue_depth;
1272 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1273 * @qc: Storage for translated ATA taskfile
1275 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1276 * (to start). Perhaps these commands should be preceded by
1277 * CHECK POWER MODE to see what power mode the device is already in.
1278 * [See SAT revision 5 at www.t10.org]
1280 * LOCKING:
1281 * spin_lock_irqsave(host lock)
1283 * RETURNS:
1284 * Zero on success, non-zero on error.
1286 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1288 struct scsi_cmnd *scmd = qc->scsicmd;
1289 struct ata_taskfile *tf = &qc->tf;
1290 const u8 *cdb = scmd->cmnd;
1292 if (scmd->cmd_len < 5)
1293 goto invalid_fld;
1295 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1296 tf->protocol = ATA_PROT_NODATA;
1297 if (cdb[1] & 0x1) {
1298 ; /* ignore IMMED bit, violates sat-r05 */
1300 if (cdb[4] & 0x2)
1301 goto invalid_fld; /* LOEJ bit set not supported */
1302 if (((cdb[4] >> 4) & 0xf) != 0)
1303 goto invalid_fld; /* power conditions not supported */
1305 if (cdb[4] & 0x1) {
1306 tf->nsect = 1; /* 1 sector, lba=0 */
1308 if (qc->dev->flags & ATA_DFLAG_LBA) {
1309 tf->flags |= ATA_TFLAG_LBA;
1311 tf->lbah = 0x0;
1312 tf->lbam = 0x0;
1313 tf->lbal = 0x0;
1314 tf->device |= ATA_LBA;
1315 } else {
1316 /* CHS */
1317 tf->lbal = 0x1; /* sect */
1318 tf->lbam = 0x0; /* cyl low */
1319 tf->lbah = 0x0; /* cyl high */
1322 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1323 } else {
1324 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1325 * or S5) causing some drives to spin up and down again.
1327 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1328 system_state == SYSTEM_POWER_OFF)
1329 goto skip;
1331 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1332 system_entering_hibernation())
1333 goto skip;
1335 /* Issue ATA STANDBY IMMEDIATE command */
1336 tf->command = ATA_CMD_STANDBYNOW1;
1340 * Standby and Idle condition timers could be implemented but that
1341 * would require libata to implement the Power condition mode page
1342 * and allow the user to change it. Changing mode pages requires
1343 * MODE SELECT to be implemented.
1346 return 0;
1348 invalid_fld:
1349 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1350 /* "Invalid field in cbd" */
1351 return 1;
1352 skip:
1353 scmd->result = SAM_STAT_GOOD;
1354 return 1;
1359 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1360 * @qc: Storage for translated ATA taskfile
1362 * Sets up an ATA taskfile to issue FLUSH CACHE or
1363 * FLUSH CACHE EXT.
1365 * LOCKING:
1366 * spin_lock_irqsave(host lock)
1368 * RETURNS:
1369 * Zero on success, non-zero on error.
1371 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1373 struct ata_taskfile *tf = &qc->tf;
1375 tf->flags |= ATA_TFLAG_DEVICE;
1376 tf->protocol = ATA_PROT_NODATA;
1378 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1379 tf->command = ATA_CMD_FLUSH_EXT;
1380 else
1381 tf->command = ATA_CMD_FLUSH;
1383 /* flush is critical for IO integrity, consider it an IO command */
1384 qc->flags |= ATA_QCFLAG_IO;
1386 return 0;
1390 * scsi_6_lba_len - Get LBA and transfer length
1391 * @cdb: SCSI command to translate
1393 * Calculate LBA and transfer length for 6-byte commands.
1395 * RETURNS:
1396 * @plba: the LBA
1397 * @plen: the transfer length
1399 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1401 u64 lba = 0;
1402 u32 len;
1404 VPRINTK("six-byte command\n");
1406 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1407 lba |= ((u64)cdb[2]) << 8;
1408 lba |= ((u64)cdb[3]);
1410 len = cdb[4];
1412 *plba = lba;
1413 *plen = len;
1417 * scsi_10_lba_len - Get LBA and transfer length
1418 * @cdb: SCSI command to translate
1420 * Calculate LBA and transfer length for 10-byte commands.
1422 * RETURNS:
1423 * @plba: the LBA
1424 * @plen: the transfer length
1426 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1428 u64 lba = 0;
1429 u32 len = 0;
1431 VPRINTK("ten-byte command\n");
1433 lba |= ((u64)cdb[2]) << 24;
1434 lba |= ((u64)cdb[3]) << 16;
1435 lba |= ((u64)cdb[4]) << 8;
1436 lba |= ((u64)cdb[5]);
1438 len |= ((u32)cdb[7]) << 8;
1439 len |= ((u32)cdb[8]);
1441 *plba = lba;
1442 *plen = len;
1446 * scsi_16_lba_len - Get LBA and transfer length
1447 * @cdb: SCSI command to translate
1449 * Calculate LBA and transfer length for 16-byte commands.
1451 * RETURNS:
1452 * @plba: the LBA
1453 * @plen: the transfer length
1455 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1457 u64 lba = 0;
1458 u32 len = 0;
1460 VPRINTK("sixteen-byte command\n");
1462 lba |= ((u64)cdb[2]) << 56;
1463 lba |= ((u64)cdb[3]) << 48;
1464 lba |= ((u64)cdb[4]) << 40;
1465 lba |= ((u64)cdb[5]) << 32;
1466 lba |= ((u64)cdb[6]) << 24;
1467 lba |= ((u64)cdb[7]) << 16;
1468 lba |= ((u64)cdb[8]) << 8;
1469 lba |= ((u64)cdb[9]);
1471 len |= ((u32)cdb[10]) << 24;
1472 len |= ((u32)cdb[11]) << 16;
1473 len |= ((u32)cdb[12]) << 8;
1474 len |= ((u32)cdb[13]);
1476 *plba = lba;
1477 *plen = len;
1481 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1482 * @qc: Storage for translated ATA taskfile
1484 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1486 * LOCKING:
1487 * spin_lock_irqsave(host lock)
1489 * RETURNS:
1490 * Zero on success, non-zero on error.
1492 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1494 struct scsi_cmnd *scmd = qc->scsicmd;
1495 struct ata_taskfile *tf = &qc->tf;
1496 struct ata_device *dev = qc->dev;
1497 u64 dev_sectors = qc->dev->n_sectors;
1498 const u8 *cdb = scmd->cmnd;
1499 u64 block;
1500 u32 n_block;
1502 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1503 tf->protocol = ATA_PROT_NODATA;
1505 if (cdb[0] == VERIFY) {
1506 if (scmd->cmd_len < 10)
1507 goto invalid_fld;
1508 scsi_10_lba_len(cdb, &block, &n_block);
1509 } else if (cdb[0] == VERIFY_16) {
1510 if (scmd->cmd_len < 16)
1511 goto invalid_fld;
1512 scsi_16_lba_len(cdb, &block, &n_block);
1513 } else
1514 goto invalid_fld;
1516 if (!n_block)
1517 goto nothing_to_do;
1518 if (block >= dev_sectors)
1519 goto out_of_range;
1520 if ((block + n_block) > dev_sectors)
1521 goto out_of_range;
1523 if (dev->flags & ATA_DFLAG_LBA) {
1524 tf->flags |= ATA_TFLAG_LBA;
1526 if (lba_28_ok(block, n_block)) {
1527 /* use LBA28 */
1528 tf->command = ATA_CMD_VERIFY;
1529 tf->device |= (block >> 24) & 0xf;
1530 } else if (lba_48_ok(block, n_block)) {
1531 if (!(dev->flags & ATA_DFLAG_LBA48))
1532 goto out_of_range;
1534 /* use LBA48 */
1535 tf->flags |= ATA_TFLAG_LBA48;
1536 tf->command = ATA_CMD_VERIFY_EXT;
1538 tf->hob_nsect = (n_block >> 8) & 0xff;
1540 tf->hob_lbah = (block >> 40) & 0xff;
1541 tf->hob_lbam = (block >> 32) & 0xff;
1542 tf->hob_lbal = (block >> 24) & 0xff;
1543 } else
1544 /* request too large even for LBA48 */
1545 goto out_of_range;
1547 tf->nsect = n_block & 0xff;
1549 tf->lbah = (block >> 16) & 0xff;
1550 tf->lbam = (block >> 8) & 0xff;
1551 tf->lbal = block & 0xff;
1553 tf->device |= ATA_LBA;
1554 } else {
1555 /* CHS */
1556 u32 sect, head, cyl, track;
1558 if (!lba_28_ok(block, n_block))
1559 goto out_of_range;
1561 /* Convert LBA to CHS */
1562 track = (u32)block / dev->sectors;
1563 cyl = track / dev->heads;
1564 head = track % dev->heads;
1565 sect = (u32)block % dev->sectors + 1;
1567 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1568 (u32)block, track, cyl, head, sect);
1570 /* Check whether the converted CHS can fit.
1571 Cylinder: 0-65535
1572 Head: 0-15
1573 Sector: 1-255*/
1574 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1575 goto out_of_range;
1577 tf->command = ATA_CMD_VERIFY;
1578 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1579 tf->lbal = sect;
1580 tf->lbam = cyl;
1581 tf->lbah = cyl >> 8;
1582 tf->device |= head;
1585 return 0;
1587 invalid_fld:
1588 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1589 /* "Invalid field in cbd" */
1590 return 1;
1592 out_of_range:
1593 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1594 /* "Logical Block Address out of range" */
1595 return 1;
1597 nothing_to_do:
1598 scmd->result = SAM_STAT_GOOD;
1599 return 1;
1603 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1604 * @qc: Storage for translated ATA taskfile
1606 * Converts any of six SCSI read/write commands into the
1607 * ATA counterpart, including starting sector (LBA),
1608 * sector count, and taking into account the device's LBA48
1609 * support.
1611 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1612 * %WRITE_16 are currently supported.
1614 * LOCKING:
1615 * spin_lock_irqsave(host lock)
1617 * RETURNS:
1618 * Zero on success, non-zero on error.
1620 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1622 struct scsi_cmnd *scmd = qc->scsicmd;
1623 const u8 *cdb = scmd->cmnd;
1624 unsigned int tf_flags = 0;
1625 u64 block;
1626 u32 n_block;
1627 int rc;
1629 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1630 tf_flags |= ATA_TFLAG_WRITE;
1632 /* Calculate the SCSI LBA, transfer length and FUA. */
1633 switch (cdb[0]) {
1634 case READ_10:
1635 case WRITE_10:
1636 if (unlikely(scmd->cmd_len < 10))
1637 goto invalid_fld;
1638 scsi_10_lba_len(cdb, &block, &n_block);
1639 if (unlikely(cdb[1] & (1 << 3)))
1640 tf_flags |= ATA_TFLAG_FUA;
1641 break;
1642 case READ_6:
1643 case WRITE_6:
1644 if (unlikely(scmd->cmd_len < 6))
1645 goto invalid_fld;
1646 scsi_6_lba_len(cdb, &block, &n_block);
1648 /* for 6-byte r/w commands, transfer length 0
1649 * means 256 blocks of data, not 0 block.
1651 if (!n_block)
1652 n_block = 256;
1653 break;
1654 case READ_16:
1655 case WRITE_16:
1656 if (unlikely(scmd->cmd_len < 16))
1657 goto invalid_fld;
1658 scsi_16_lba_len(cdb, &block, &n_block);
1659 if (unlikely(cdb[1] & (1 << 3)))
1660 tf_flags |= ATA_TFLAG_FUA;
1661 break;
1662 default:
1663 DPRINTK("no-byte command\n");
1664 goto invalid_fld;
1667 /* Check and compose ATA command */
1668 if (!n_block)
1669 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1670 * length 0 means transfer 0 block of data.
1671 * However, for ATA R/W commands, sector count 0 means
1672 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1674 * WARNING: one or two older ATA drives treat 0 as 0...
1676 goto nothing_to_do;
1678 qc->flags |= ATA_QCFLAG_IO;
1679 qc->nbytes = n_block * scmd->device->sector_size;
1681 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1682 qc->tag);
1683 if (likely(rc == 0))
1684 return 0;
1686 if (rc == -ERANGE)
1687 goto out_of_range;
1688 /* treat all other errors as -EINVAL, fall through */
1689 invalid_fld:
1690 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1691 /* "Invalid field in cbd" */
1692 return 1;
1694 out_of_range:
1695 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1696 /* "Logical Block Address out of range" */
1697 return 1;
1699 nothing_to_do:
1700 scmd->result = SAM_STAT_GOOD;
1701 return 1;
1704 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1706 struct ata_port *ap = qc->ap;
1707 struct scsi_cmnd *cmd = qc->scsicmd;
1708 u8 *cdb = cmd->cmnd;
1709 int need_sense = (qc->err_mask != 0);
1711 /* For ATA pass thru (SAT) commands, generate a sense block if
1712 * user mandated it or if there's an error. Note that if we
1713 * generate because the user forced us to, a check condition
1714 * is generated and the ATA register values are returned
1715 * whether the command completed successfully or not. If there
1716 * was no error, SK, ASC and ASCQ will all be zero.
1718 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1719 ((cdb[2] & 0x20) || need_sense)) {
1720 ata_gen_passthru_sense(qc);
1721 } else {
1722 if (!need_sense) {
1723 cmd->result = SAM_STAT_GOOD;
1724 } else {
1725 /* TODO: decide which descriptor format to use
1726 * for 48b LBA devices and call that here
1727 * instead of the fixed desc, which is only
1728 * good for smaller LBA (and maybe CHS?)
1729 * devices.
1731 ata_gen_ata_sense(qc);
1735 if (need_sense && !ap->ops->error_handler)
1736 ata_dump_status(ap->print_id, &qc->result_tf);
1738 qc->scsidone(cmd);
1740 ata_qc_free(qc);
1744 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1745 * @dev: ATA device to which the command is addressed
1746 * @cmd: SCSI command to execute
1747 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1749 * Our ->queuecommand() function has decided that the SCSI
1750 * command issued can be directly translated into an ATA
1751 * command, rather than handled internally.
1753 * This function sets up an ata_queued_cmd structure for the
1754 * SCSI command, and sends that ata_queued_cmd to the hardware.
1756 * The xlat_func argument (actor) returns 0 if ready to execute
1757 * ATA command, else 1 to finish translation. If 1 is returned
1758 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1759 * to be set reflecting an error condition or clean (early)
1760 * termination.
1762 * LOCKING:
1763 * spin_lock_irqsave(host lock)
1765 * RETURNS:
1766 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1767 * needs to be deferred.
1769 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1770 ata_xlat_func_t xlat_func)
1772 struct ata_port *ap = dev->link->ap;
1773 struct ata_queued_cmd *qc;
1774 int rc;
1776 VPRINTK("ENTER\n");
1778 qc = ata_scsi_qc_new(dev, cmd);
1779 if (!qc)
1780 goto err_mem;
1782 /* data is present; dma-map it */
1783 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1784 cmd->sc_data_direction == DMA_TO_DEVICE) {
1785 if (unlikely(scsi_bufflen(cmd) < 1)) {
1786 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1787 goto err_did;
1790 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1792 qc->dma_dir = cmd->sc_data_direction;
1795 qc->complete_fn = ata_scsi_qc_complete;
1797 if (xlat_func(qc))
1798 goto early_finish;
1800 if (ap->ops->qc_defer) {
1801 if ((rc = ap->ops->qc_defer(qc)))
1802 goto defer;
1805 /* select device, send command to hardware */
1806 ata_qc_issue(qc);
1808 VPRINTK("EXIT\n");
1809 return 0;
1811 early_finish:
1812 ata_qc_free(qc);
1813 cmd->scsi_done(cmd);
1814 DPRINTK("EXIT - early finish (good or error)\n");
1815 return 0;
1817 err_did:
1818 ata_qc_free(qc);
1819 cmd->result = (DID_ERROR << 16);
1820 cmd->scsi_done(cmd);
1821 err_mem:
1822 DPRINTK("EXIT - internal\n");
1823 return 0;
1825 defer:
1826 ata_qc_free(qc);
1827 DPRINTK("EXIT - defer\n");
1828 if (rc == ATA_DEFER_LINK)
1829 return SCSI_MLQUEUE_DEVICE_BUSY;
1830 else
1831 return SCSI_MLQUEUE_HOST_BUSY;
1835 * ata_scsi_rbuf_get - Map response buffer.
1836 * @cmd: SCSI command containing buffer to be mapped.
1837 * @flags: unsigned long variable to store irq enable status
1838 * @copy_in: copy in from user buffer
1840 * Prepare buffer for simulated SCSI commands.
1842 * LOCKING:
1843 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1845 * RETURNS:
1846 * Pointer to response buffer.
1848 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1849 unsigned long *flags)
1851 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1853 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1854 if (copy_in)
1855 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1856 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1857 return ata_scsi_rbuf;
1861 * ata_scsi_rbuf_put - Unmap response buffer.
1862 * @cmd: SCSI command containing buffer to be unmapped.
1863 * @copy_out: copy out result
1864 * @flags: @flags passed to ata_scsi_rbuf_get()
1866 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1867 * @copy_back is true.
1869 * LOCKING:
1870 * Unlocks ata_scsi_rbuf_lock.
1872 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1873 unsigned long *flags)
1875 if (copy_out)
1876 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1877 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1878 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1882 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1883 * @args: device IDENTIFY data / SCSI command of interest.
1884 * @actor: Callback hook for desired SCSI command simulator
1886 * Takes care of the hard work of simulating a SCSI command...
1887 * Mapping the response buffer, calling the command's handler,
1888 * and handling the handler's return value. This return value
1889 * indicates whether the handler wishes the SCSI command to be
1890 * completed successfully (0), or not (in which case cmd->result
1891 * and sense buffer are assumed to be set).
1893 * LOCKING:
1894 * spin_lock_irqsave(host lock)
1896 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1897 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1899 u8 *rbuf;
1900 unsigned int rc;
1901 struct scsi_cmnd *cmd = args->cmd;
1902 unsigned long flags;
1904 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1905 rc = actor(args, rbuf);
1906 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1908 if (rc == 0)
1909 cmd->result = SAM_STAT_GOOD;
1910 args->done(cmd);
1914 * ata_scsiop_inq_std - Simulate INQUIRY command
1915 * @args: device IDENTIFY data / SCSI command of interest.
1916 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1918 * Returns standard device identification data associated
1919 * with non-VPD INQUIRY command output.
1921 * LOCKING:
1922 * spin_lock_irqsave(host lock)
1924 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1926 const u8 versions[] = {
1927 0x60, /* SAM-3 (no version claimed) */
1929 0x03,
1930 0x20, /* SBC-2 (no version claimed) */
1932 0x02,
1933 0x60 /* SPC-3 (no version claimed) */
1935 u8 hdr[] = {
1936 TYPE_DISK,
1938 0x5, /* claim SPC-3 version compatibility */
1940 95 - 4
1943 VPRINTK("ENTER\n");
1945 /* set scsi removeable (RMB) bit per ata bit */
1946 if (ata_id_removeable(args->id))
1947 hdr[1] |= (1 << 7);
1949 memcpy(rbuf, hdr, sizeof(hdr));
1950 memcpy(&rbuf[8], "ATA ", 8);
1951 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1952 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1954 if (rbuf[32] == 0 || rbuf[32] == ' ')
1955 memcpy(&rbuf[32], "n/a ", 4);
1957 memcpy(rbuf + 59, versions, sizeof(versions));
1959 return 0;
1963 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1964 * @args: device IDENTIFY data / SCSI command of interest.
1965 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1967 * Returns list of inquiry VPD pages available.
1969 * LOCKING:
1970 * spin_lock_irqsave(host lock)
1972 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1974 const u8 pages[] = {
1975 0x00, /* page 0x00, this page */
1976 0x80, /* page 0x80, unit serial no page */
1977 0x83, /* page 0x83, device ident page */
1978 0x89, /* page 0x89, ata info page */
1979 0xb0, /* page 0xb0, block limits page */
1980 0xb1, /* page 0xb1, block device characteristics page */
1981 0xb2, /* page 0xb2, thin provisioning page */
1984 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1985 memcpy(rbuf + 4, pages, sizeof(pages));
1986 return 0;
1990 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1991 * @args: device IDENTIFY data / SCSI command of interest.
1992 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1994 * Returns ATA device serial number.
1996 * LOCKING:
1997 * spin_lock_irqsave(host lock)
1999 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2001 const u8 hdr[] = {
2003 0x80, /* this page code */
2005 ATA_ID_SERNO_LEN, /* page len */
2008 memcpy(rbuf, hdr, sizeof(hdr));
2009 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2010 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2011 return 0;
2015 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2016 * @args: device IDENTIFY data / SCSI command of interest.
2017 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2019 * Yields two logical unit device identification designators:
2020 * - vendor specific ASCII containing the ATA serial number
2021 * - SAT defined "t10 vendor id based" containing ASCII vendor
2022 * name ("ATA "), model and serial numbers.
2024 * LOCKING:
2025 * spin_lock_irqsave(host lock)
2027 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2029 const int sat_model_serial_desc_len = 68;
2030 int num;
2032 rbuf[1] = 0x83; /* this page code */
2033 num = 4;
2035 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2036 rbuf[num + 0] = 2;
2037 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2038 num += 4;
2039 ata_id_string(args->id, (unsigned char *) rbuf + num,
2040 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2041 num += ATA_ID_SERNO_LEN;
2043 /* SAT defined lu model and serial numbers descriptor */
2044 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2045 rbuf[num + 0] = 2;
2046 rbuf[num + 1] = 1;
2047 rbuf[num + 3] = sat_model_serial_desc_len;
2048 num += 4;
2049 memcpy(rbuf + num, "ATA ", 8);
2050 num += 8;
2051 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2052 ATA_ID_PROD_LEN);
2053 num += ATA_ID_PROD_LEN;
2054 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2055 ATA_ID_SERNO_LEN);
2056 num += ATA_ID_SERNO_LEN;
2058 if (ata_id_has_wwn(args->id)) {
2059 /* SAT defined lu world wide name */
2060 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2061 rbuf[num + 0] = 1;
2062 rbuf[num + 1] = 3;
2063 rbuf[num + 3] = ATA_ID_WWN_LEN;
2064 num += 4;
2065 ata_id_string(args->id, (unsigned char *) rbuf + num,
2066 ATA_ID_WWN, ATA_ID_WWN_LEN);
2067 num += ATA_ID_WWN_LEN;
2069 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2070 return 0;
2074 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2075 * @args: device IDENTIFY data / SCSI command of interest.
2076 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2078 * Yields SAT-specified ATA VPD page.
2080 * LOCKING:
2081 * spin_lock_irqsave(host lock)
2083 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2085 struct ata_taskfile tf;
2087 memset(&tf, 0, sizeof(tf));
2089 rbuf[1] = 0x89; /* our page code */
2090 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2091 rbuf[3] = (0x238 & 0xff);
2093 memcpy(&rbuf[8], "linux ", 8);
2094 memcpy(&rbuf[16], "libata ", 16);
2095 memcpy(&rbuf[32], DRV_VERSION, 4);
2096 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2098 /* we don't store the ATA device signature, so we fake it */
2100 tf.command = ATA_DRDY; /* really, this is Status reg */
2101 tf.lbal = 0x1;
2102 tf.nsect = 0x1;
2104 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2105 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2107 rbuf[56] = ATA_CMD_ID_ATA;
2109 memcpy(&rbuf[60], &args->id[0], 512);
2110 return 0;
2113 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2115 u16 min_io_sectors;
2117 rbuf[1] = 0xb0;
2118 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2121 * Optimal transfer length granularity.
2123 * This is always one physical block, but for disks with a smaller
2124 * logical than physical sector size we need to figure out what the
2125 * latter is.
2127 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2128 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2131 * Optimal unmap granularity.
2133 * The ATA spec doesn't even know about a granularity or alignment
2134 * for the TRIM command. We can leave away most of the unmap related
2135 * VPD page entries, but we have specifify a granularity to signal
2136 * that we support some form of unmap - in thise case via WRITE SAME
2137 * with the unmap bit set.
2139 if (ata_id_has_trim(args->id)) {
2140 put_unaligned_be64(65535 * 512 / 8, &rbuf[36]);
2141 put_unaligned_be32(1, &rbuf[28]);
2144 return 0;
2147 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2149 int form_factor = ata_id_form_factor(args->id);
2150 int media_rotation_rate = ata_id_rotation_rate(args->id);
2152 rbuf[1] = 0xb1;
2153 rbuf[3] = 0x3c;
2154 rbuf[4] = media_rotation_rate >> 8;
2155 rbuf[5] = media_rotation_rate;
2156 rbuf[7] = form_factor;
2158 return 0;
2161 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2163 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2164 rbuf[1] = 0xb2;
2165 rbuf[3] = 0x4;
2166 rbuf[5] = 1 << 6; /* TPWS */
2168 return 0;
2172 * ata_scsiop_noop - Command handler that simply returns success.
2173 * @args: device IDENTIFY data / SCSI command of interest.
2174 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2176 * No operation. Simply returns success to caller, to indicate
2177 * that the caller should successfully complete this SCSI command.
2179 * LOCKING:
2180 * spin_lock_irqsave(host lock)
2182 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2184 VPRINTK("ENTER\n");
2185 return 0;
2189 * ata_msense_caching - Simulate MODE SENSE caching info page
2190 * @id: device IDENTIFY data
2191 * @buf: output buffer
2193 * Generate a caching info page, which conditionally indicates
2194 * write caching to the SCSI layer, depending on device
2195 * capabilities.
2197 * LOCKING:
2198 * None.
2200 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2202 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2203 if (ata_id_wcache_enabled(id))
2204 buf[2] |= (1 << 2); /* write cache enable */
2205 if (!ata_id_rahead_enabled(id))
2206 buf[12] |= (1 << 5); /* disable read ahead */
2207 return sizeof(def_cache_mpage);
2211 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2212 * @buf: output buffer
2214 * Generate a generic MODE SENSE control mode page.
2216 * LOCKING:
2217 * None.
2219 static unsigned int ata_msense_ctl_mode(u8 *buf)
2221 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2222 return sizeof(def_control_mpage);
2226 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2227 * @buf: output buffer
2229 * Generate a generic MODE SENSE r/w error recovery page.
2231 * LOCKING:
2232 * None.
2234 static unsigned int ata_msense_rw_recovery(u8 *buf)
2236 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2237 return sizeof(def_rw_recovery_mpage);
2241 * We can turn this into a real blacklist if it's needed, for now just
2242 * blacklist any Maxtor BANC1G10 revision firmware
2244 static int ata_dev_supports_fua(u16 *id)
2246 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2248 if (!libata_fua)
2249 return 0;
2250 if (!ata_id_has_fua(id))
2251 return 0;
2253 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2254 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2256 if (strcmp(model, "Maxtor"))
2257 return 1;
2258 if (strcmp(fw, "BANC1G10"))
2259 return 1;
2261 return 0; /* blacklisted */
2265 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2266 * @args: device IDENTIFY data / SCSI command of interest.
2267 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2269 * Simulate MODE SENSE commands. Assume this is invoked for direct
2270 * access devices (e.g. disks) only. There should be no block
2271 * descriptor for other device types.
2273 * LOCKING:
2274 * spin_lock_irqsave(host lock)
2276 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2278 struct ata_device *dev = args->dev;
2279 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2280 const u8 sat_blk_desc[] = {
2281 0, 0, 0, 0, /* number of blocks: sat unspecified */
2283 0, 0x2, 0x0 /* block length: 512 bytes */
2285 u8 pg, spg;
2286 unsigned int ebd, page_control, six_byte;
2287 u8 dpofua;
2289 VPRINTK("ENTER\n");
2291 six_byte = (scsicmd[0] == MODE_SENSE);
2292 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2294 * LLBA bit in msense(10) ignored (compliant)
2297 page_control = scsicmd[2] >> 6;
2298 switch (page_control) {
2299 case 0: /* current */
2300 break; /* supported */
2301 case 3: /* saved */
2302 goto saving_not_supp;
2303 case 1: /* changeable */
2304 case 2: /* defaults */
2305 default:
2306 goto invalid_fld;
2309 if (six_byte)
2310 p += 4 + (ebd ? 8 : 0);
2311 else
2312 p += 8 + (ebd ? 8 : 0);
2314 pg = scsicmd[2] & 0x3f;
2315 spg = scsicmd[3];
2317 * No mode subpages supported (yet) but asking for _all_
2318 * subpages may be valid
2320 if (spg && (spg != ALL_SUB_MPAGES))
2321 goto invalid_fld;
2323 switch(pg) {
2324 case RW_RECOVERY_MPAGE:
2325 p += ata_msense_rw_recovery(p);
2326 break;
2328 case CACHE_MPAGE:
2329 p += ata_msense_caching(args->id, p);
2330 break;
2332 case CONTROL_MPAGE:
2333 p += ata_msense_ctl_mode(p);
2334 break;
2336 case ALL_MPAGES:
2337 p += ata_msense_rw_recovery(p);
2338 p += ata_msense_caching(args->id, p);
2339 p += ata_msense_ctl_mode(p);
2340 break;
2342 default: /* invalid page code */
2343 goto invalid_fld;
2346 dpofua = 0;
2347 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2348 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2349 dpofua = 1 << 4;
2351 if (six_byte) {
2352 rbuf[0] = p - rbuf - 1;
2353 rbuf[2] |= dpofua;
2354 if (ebd) {
2355 rbuf[3] = sizeof(sat_blk_desc);
2356 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2358 } else {
2359 unsigned int output_len = p - rbuf - 2;
2361 rbuf[0] = output_len >> 8;
2362 rbuf[1] = output_len;
2363 rbuf[3] |= dpofua;
2364 if (ebd) {
2365 rbuf[7] = sizeof(sat_blk_desc);
2366 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2369 return 0;
2371 invalid_fld:
2372 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2373 /* "Invalid field in cbd" */
2374 return 1;
2376 saving_not_supp:
2377 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2378 /* "Saving parameters not supported" */
2379 return 1;
2383 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2384 * @args: device IDENTIFY data / SCSI command of interest.
2385 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2387 * Simulate READ CAPACITY commands.
2389 * LOCKING:
2390 * None.
2392 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2394 struct ata_device *dev = args->dev;
2395 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2396 u32 sector_size; /* physical sector size in bytes */
2397 u8 log2_per_phys;
2398 u16 lowest_aligned;
2400 sector_size = ata_id_logical_sector_size(dev->id);
2401 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2402 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2404 VPRINTK("ENTER\n");
2406 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2407 if (last_lba >= 0xffffffffULL)
2408 last_lba = 0xffffffff;
2410 /* sector count, 32-bit */
2411 rbuf[0] = last_lba >> (8 * 3);
2412 rbuf[1] = last_lba >> (8 * 2);
2413 rbuf[2] = last_lba >> (8 * 1);
2414 rbuf[3] = last_lba;
2416 /* sector size */
2417 rbuf[4] = sector_size >> (8 * 3);
2418 rbuf[5] = sector_size >> (8 * 2);
2419 rbuf[6] = sector_size >> (8 * 1);
2420 rbuf[7] = sector_size;
2421 } else {
2422 /* sector count, 64-bit */
2423 rbuf[0] = last_lba >> (8 * 7);
2424 rbuf[1] = last_lba >> (8 * 6);
2425 rbuf[2] = last_lba >> (8 * 5);
2426 rbuf[3] = last_lba >> (8 * 4);
2427 rbuf[4] = last_lba >> (8 * 3);
2428 rbuf[5] = last_lba >> (8 * 2);
2429 rbuf[6] = last_lba >> (8 * 1);
2430 rbuf[7] = last_lba;
2432 /* sector size */
2433 rbuf[ 8] = sector_size >> (8 * 3);
2434 rbuf[ 9] = sector_size >> (8 * 2);
2435 rbuf[10] = sector_size >> (8 * 1);
2436 rbuf[11] = sector_size;
2438 rbuf[12] = 0;
2439 rbuf[13] = log2_per_phys;
2440 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2441 rbuf[15] = lowest_aligned;
2443 if (ata_id_has_trim(args->id)) {
2444 rbuf[14] |= 0x80; /* TPE */
2446 if (ata_id_has_zero_after_trim(args->id))
2447 rbuf[14] |= 0x40; /* TPRZ */
2451 return 0;
2455 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2456 * @args: device IDENTIFY data / SCSI command of interest.
2457 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2459 * Simulate REPORT LUNS command.
2461 * LOCKING:
2462 * spin_lock_irqsave(host lock)
2464 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2466 VPRINTK("ENTER\n");
2467 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2469 return 0;
2472 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2474 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2475 /* FIXME: not quite right; we don't want the
2476 * translation of taskfile registers into
2477 * a sense descriptors, since that's only
2478 * correct for ATA, not ATAPI
2480 ata_gen_passthru_sense(qc);
2483 qc->scsidone(qc->scsicmd);
2484 ata_qc_free(qc);
2487 /* is it pointless to prefer PIO for "safety reasons"? */
2488 static inline int ata_pio_use_silly(struct ata_port *ap)
2490 return (ap->flags & ATA_FLAG_PIO_DMA);
2493 static void atapi_request_sense(struct ata_queued_cmd *qc)
2495 struct ata_port *ap = qc->ap;
2496 struct scsi_cmnd *cmd = qc->scsicmd;
2498 DPRINTK("ATAPI request sense\n");
2500 /* FIXME: is this needed? */
2501 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2503 #ifdef CONFIG_ATA_SFF
2504 if (ap->ops->sff_tf_read)
2505 ap->ops->sff_tf_read(ap, &qc->tf);
2506 #endif
2508 /* fill these in, for the case where they are -not- overwritten */
2509 cmd->sense_buffer[0] = 0x70;
2510 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2512 ata_qc_reinit(qc);
2514 /* setup sg table and init transfer direction */
2515 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2516 ata_sg_init(qc, &qc->sgent, 1);
2517 qc->dma_dir = DMA_FROM_DEVICE;
2519 memset(&qc->cdb, 0, qc->dev->cdb_len);
2520 qc->cdb[0] = REQUEST_SENSE;
2521 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2523 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2524 qc->tf.command = ATA_CMD_PACKET;
2526 if (ata_pio_use_silly(ap)) {
2527 qc->tf.protocol = ATAPI_PROT_DMA;
2528 qc->tf.feature |= ATAPI_PKT_DMA;
2529 } else {
2530 qc->tf.protocol = ATAPI_PROT_PIO;
2531 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2532 qc->tf.lbah = 0;
2534 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2536 qc->complete_fn = atapi_sense_complete;
2538 ata_qc_issue(qc);
2540 DPRINTK("EXIT\n");
2543 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2545 struct scsi_cmnd *cmd = qc->scsicmd;
2546 unsigned int err_mask = qc->err_mask;
2548 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2550 /* handle completion from new EH */
2551 if (unlikely(qc->ap->ops->error_handler &&
2552 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2554 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2555 /* FIXME: not quite right; we don't want the
2556 * translation of taskfile registers into a
2557 * sense descriptors, since that's only
2558 * correct for ATA, not ATAPI
2560 ata_gen_passthru_sense(qc);
2563 /* SCSI EH automatically locks door if sdev->locked is
2564 * set. Sometimes door lock request continues to
2565 * fail, for example, when no media is present. This
2566 * creates a loop - SCSI EH issues door lock which
2567 * fails and gets invoked again to acquire sense data
2568 * for the failed command.
2570 * If door lock fails, always clear sdev->locked to
2571 * avoid this infinite loop.
2573 * This may happen before SCSI scan is complete. Make
2574 * sure qc->dev->sdev isn't NULL before dereferencing.
2576 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2577 qc->dev->sdev->locked = 0;
2579 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2580 qc->scsidone(cmd);
2581 ata_qc_free(qc);
2582 return;
2585 /* successful completion or old EH failure path */
2586 if (unlikely(err_mask & AC_ERR_DEV)) {
2587 cmd->result = SAM_STAT_CHECK_CONDITION;
2588 atapi_request_sense(qc);
2589 return;
2590 } else if (unlikely(err_mask)) {
2591 /* FIXME: not quite right; we don't want the
2592 * translation of taskfile registers into
2593 * a sense descriptors, since that's only
2594 * correct for ATA, not ATAPI
2596 ata_gen_passthru_sense(qc);
2597 } else {
2598 u8 *scsicmd = cmd->cmnd;
2600 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2601 unsigned long flags;
2602 u8 *buf;
2604 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2606 /* ATAPI devices typically report zero for their SCSI version,
2607 * and sometimes deviate from the spec WRT response data
2608 * format. If SCSI version is reported as zero like normal,
2609 * then we make the following fixups: 1) Fake MMC-5 version,
2610 * to indicate to the Linux scsi midlayer this is a modern
2611 * device. 2) Ensure response data format / ATAPI information
2612 * are always correct.
2614 if (buf[2] == 0) {
2615 buf[2] = 0x5;
2616 buf[3] = 0x32;
2619 ata_scsi_rbuf_put(cmd, true, &flags);
2622 cmd->result = SAM_STAT_GOOD;
2625 qc->scsidone(cmd);
2626 ata_qc_free(qc);
2629 * atapi_xlat - Initialize PACKET taskfile
2630 * @qc: command structure to be initialized
2632 * LOCKING:
2633 * spin_lock_irqsave(host lock)
2635 * RETURNS:
2636 * Zero on success, non-zero on failure.
2638 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2640 struct scsi_cmnd *scmd = qc->scsicmd;
2641 struct ata_device *dev = qc->dev;
2642 int nodata = (scmd->sc_data_direction == DMA_NONE);
2643 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2644 unsigned int nbytes;
2646 memset(qc->cdb, 0, dev->cdb_len);
2647 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2649 qc->complete_fn = atapi_qc_complete;
2651 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2652 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2653 qc->tf.flags |= ATA_TFLAG_WRITE;
2654 DPRINTK("direction: write\n");
2657 qc->tf.command = ATA_CMD_PACKET;
2658 ata_qc_set_pc_nbytes(qc);
2660 /* check whether ATAPI DMA is safe */
2661 if (!nodata && !using_pio && atapi_check_dma(qc))
2662 using_pio = 1;
2664 /* Some controller variants snoop this value for Packet
2665 * transfers to do state machine and FIFO management. Thus we
2666 * want to set it properly, and for DMA where it is
2667 * effectively meaningless.
2669 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2671 /* Most ATAPI devices which honor transfer chunk size don't
2672 * behave according to the spec when odd chunk size which
2673 * matches the transfer length is specified. If the number of
2674 * bytes to transfer is 2n+1. According to the spec, what
2675 * should happen is to indicate that 2n+1 is going to be
2676 * transferred and transfer 2n+2 bytes where the last byte is
2677 * padding.
2679 * In practice, this doesn't happen. ATAPI devices first
2680 * indicate and transfer 2n bytes and then indicate and
2681 * transfer 2 bytes where the last byte is padding.
2683 * This inconsistency confuses several controllers which
2684 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2685 * These controllers use actual number of transferred bytes to
2686 * update DMA poitner and transfer of 4n+2 bytes make those
2687 * controller push DMA pointer by 4n+4 bytes because SATA data
2688 * FISes are aligned to 4 bytes. This causes data corruption
2689 * and buffer overrun.
2691 * Always setting nbytes to even number solves this problem
2692 * because then ATAPI devices don't have to split data at 2n
2693 * boundaries.
2695 if (nbytes & 0x1)
2696 nbytes++;
2698 qc->tf.lbam = (nbytes & 0xFF);
2699 qc->tf.lbah = (nbytes >> 8);
2701 if (nodata)
2702 qc->tf.protocol = ATAPI_PROT_NODATA;
2703 else if (using_pio)
2704 qc->tf.protocol = ATAPI_PROT_PIO;
2705 else {
2706 /* DMA data xfer */
2707 qc->tf.protocol = ATAPI_PROT_DMA;
2708 qc->tf.feature |= ATAPI_PKT_DMA;
2710 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2711 (scmd->sc_data_direction != DMA_TO_DEVICE))
2712 /* some SATA bridges need us to indicate data xfer direction */
2713 qc->tf.feature |= ATAPI_DMADIR;
2717 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2718 as ATAPI tape drives don't get this right otherwise */
2719 return 0;
2722 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2724 if (!sata_pmp_attached(ap)) {
2725 if (likely(devno < ata_link_max_devices(&ap->link)))
2726 return &ap->link.device[devno];
2727 } else {
2728 if (likely(devno < ap->nr_pmp_links))
2729 return &ap->pmp_link[devno].device[0];
2732 return NULL;
2735 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2736 const struct scsi_device *scsidev)
2738 int devno;
2740 /* skip commands not addressed to targets we simulate */
2741 if (!sata_pmp_attached(ap)) {
2742 if (unlikely(scsidev->channel || scsidev->lun))
2743 return NULL;
2744 devno = scsidev->id;
2745 } else {
2746 if (unlikely(scsidev->id || scsidev->lun))
2747 return NULL;
2748 devno = scsidev->channel;
2751 return ata_find_dev(ap, devno);
2755 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2756 * @ap: ATA port to which the device is attached
2757 * @scsidev: SCSI device from which we derive the ATA device
2759 * Given various information provided in struct scsi_cmnd,
2760 * map that onto an ATA bus, and using that mapping
2761 * determine which ata_device is associated with the
2762 * SCSI command to be sent.
2764 * LOCKING:
2765 * spin_lock_irqsave(host lock)
2767 * RETURNS:
2768 * Associated ATA device, or %NULL if not found.
2770 static struct ata_device *
2771 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2773 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2775 if (unlikely(!dev || !ata_dev_enabled(dev)))
2776 return NULL;
2778 return dev;
2782 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2783 * @byte1: Byte 1 from pass-thru CDB.
2785 * RETURNS:
2786 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2788 static u8
2789 ata_scsi_map_proto(u8 byte1)
2791 switch((byte1 & 0x1e) >> 1) {
2792 case 3: /* Non-data */
2793 return ATA_PROT_NODATA;
2795 case 6: /* DMA */
2796 case 10: /* UDMA Data-in */
2797 case 11: /* UDMA Data-Out */
2798 return ATA_PROT_DMA;
2800 case 4: /* PIO Data-in */
2801 case 5: /* PIO Data-out */
2802 return ATA_PROT_PIO;
2804 case 0: /* Hard Reset */
2805 case 1: /* SRST */
2806 case 8: /* Device Diagnostic */
2807 case 9: /* Device Reset */
2808 case 7: /* DMA Queued */
2809 case 12: /* FPDMA */
2810 case 15: /* Return Response Info */
2811 default: /* Reserved */
2812 break;
2815 return ATA_PROT_UNKNOWN;
2819 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2820 * @qc: command structure to be initialized
2822 * Handles either 12 or 16-byte versions of the CDB.
2824 * RETURNS:
2825 * Zero on success, non-zero on failure.
2827 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2829 struct ata_taskfile *tf = &(qc->tf);
2830 struct scsi_cmnd *scmd = qc->scsicmd;
2831 struct ata_device *dev = qc->dev;
2832 const u8 *cdb = scmd->cmnd;
2834 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2835 goto invalid_fld;
2838 * 12 and 16 byte CDBs use different offsets to
2839 * provide the various register values.
2841 if (cdb[0] == ATA_16) {
2843 * 16-byte CDB - may contain extended commands.
2845 * If that is the case, copy the upper byte register values.
2847 if (cdb[1] & 0x01) {
2848 tf->hob_feature = cdb[3];
2849 tf->hob_nsect = cdb[5];
2850 tf->hob_lbal = cdb[7];
2851 tf->hob_lbam = cdb[9];
2852 tf->hob_lbah = cdb[11];
2853 tf->flags |= ATA_TFLAG_LBA48;
2854 } else
2855 tf->flags &= ~ATA_TFLAG_LBA48;
2858 * Always copy low byte, device and command registers.
2860 tf->feature = cdb[4];
2861 tf->nsect = cdb[6];
2862 tf->lbal = cdb[8];
2863 tf->lbam = cdb[10];
2864 tf->lbah = cdb[12];
2865 tf->device = cdb[13];
2866 tf->command = cdb[14];
2867 } else {
2869 * 12-byte CDB - incapable of extended commands.
2871 tf->flags &= ~ATA_TFLAG_LBA48;
2873 tf->feature = cdb[3];
2874 tf->nsect = cdb[4];
2875 tf->lbal = cdb[5];
2876 tf->lbam = cdb[6];
2877 tf->lbah = cdb[7];
2878 tf->device = cdb[8];
2879 tf->command = cdb[9];
2882 /* enforce correct master/slave bit */
2883 tf->device = dev->devno ?
2884 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2886 switch (tf->command) {
2887 /* READ/WRITE LONG use a non-standard sect_size */
2888 case ATA_CMD_READ_LONG:
2889 case ATA_CMD_READ_LONG_ONCE:
2890 case ATA_CMD_WRITE_LONG:
2891 case ATA_CMD_WRITE_LONG_ONCE:
2892 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2893 goto invalid_fld;
2894 qc->sect_size = scsi_bufflen(scmd);
2895 break;
2897 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2898 case ATA_CMD_CFA_WRITE_NE:
2899 case ATA_CMD_CFA_TRANS_SECT:
2900 case ATA_CMD_CFA_WRITE_MULT_NE:
2901 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2902 case ATA_CMD_READ:
2903 case ATA_CMD_READ_EXT:
2904 case ATA_CMD_READ_QUEUED:
2905 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2906 case ATA_CMD_FPDMA_READ:
2907 case ATA_CMD_READ_MULTI:
2908 case ATA_CMD_READ_MULTI_EXT:
2909 case ATA_CMD_PIO_READ:
2910 case ATA_CMD_PIO_READ_EXT:
2911 case ATA_CMD_READ_STREAM_DMA_EXT:
2912 case ATA_CMD_READ_STREAM_EXT:
2913 case ATA_CMD_VERIFY:
2914 case ATA_CMD_VERIFY_EXT:
2915 case ATA_CMD_WRITE:
2916 case ATA_CMD_WRITE_EXT:
2917 case ATA_CMD_WRITE_FUA_EXT:
2918 case ATA_CMD_WRITE_QUEUED:
2919 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2920 case ATA_CMD_FPDMA_WRITE:
2921 case ATA_CMD_WRITE_MULTI:
2922 case ATA_CMD_WRITE_MULTI_EXT:
2923 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2924 case ATA_CMD_PIO_WRITE:
2925 case ATA_CMD_PIO_WRITE_EXT:
2926 case ATA_CMD_WRITE_STREAM_DMA_EXT:
2927 case ATA_CMD_WRITE_STREAM_EXT:
2928 qc->sect_size = scmd->device->sector_size;
2929 break;
2931 /* Everything else uses 512 byte "sectors" */
2932 default:
2933 qc->sect_size = ATA_SECT_SIZE;
2937 * Set flags so that all registers will be written, pass on
2938 * write indication (used for PIO/DMA setup), result TF is
2939 * copied back and we don't whine too much about its failure.
2941 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2942 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2943 tf->flags |= ATA_TFLAG_WRITE;
2945 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2948 * Set transfer length.
2950 * TODO: find out if we need to do more here to
2951 * cover scatter/gather case.
2953 ata_qc_set_pc_nbytes(qc);
2955 /* We may not issue DMA commands if no DMA mode is set */
2956 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2957 goto invalid_fld;
2959 /* sanity check for pio multi commands */
2960 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2961 goto invalid_fld;
2963 if (is_multi_taskfile(tf)) {
2964 unsigned int multi_count = 1 << (cdb[1] >> 5);
2966 /* compare the passed through multi_count
2967 * with the cached multi_count of libata
2969 if (multi_count != dev->multi_count)
2970 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
2971 multi_count);
2975 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2976 * SET_FEATURES - XFER MODE must be preceded/succeeded
2977 * by an update to hardware-specific registers for each
2978 * controller (i.e. the reason for ->set_piomode(),
2979 * ->set_dmamode(), and ->post_set_mode() hooks).
2981 if (tf->command == ATA_CMD_SET_FEATURES &&
2982 tf->feature == SETFEATURES_XFER)
2983 goto invalid_fld;
2986 * Filter TPM commands by default. These provide an
2987 * essentially uncontrolled encrypted "back door" between
2988 * applications and the disk. Set libata.allow_tpm=1 if you
2989 * have a real reason for wanting to use them. This ensures
2990 * that installed software cannot easily mess stuff up without
2991 * user intent. DVR type users will probably ship with this enabled
2992 * for movie content management.
2994 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2995 * for this and should do in future but that it is not sufficient as
2996 * DCS is an optional feature set. Thus we also do the software filter
2997 * so that we comply with the TC consortium stated goal that the user
2998 * can turn off TC features of their system.
3000 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
3001 goto invalid_fld;
3003 return 0;
3005 invalid_fld:
3006 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3007 /* "Invalid field in cdb" */
3008 return 1;
3011 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3013 struct ata_taskfile *tf = &qc->tf;
3014 struct scsi_cmnd *scmd = qc->scsicmd;
3015 struct ata_device *dev = qc->dev;
3016 const u8 *cdb = scmd->cmnd;
3017 u64 block;
3018 u32 n_block;
3019 u32 size;
3020 void *buf;
3022 /* we may not issue DMA commands if no DMA mode is set */
3023 if (unlikely(!dev->dma_mode))
3024 goto invalid_fld;
3026 if (unlikely(scmd->cmd_len < 16))
3027 goto invalid_fld;
3028 scsi_16_lba_len(cdb, &block, &n_block);
3030 /* for now we only support WRITE SAME with the unmap bit set */
3031 if (unlikely(!(cdb[1] & 0x8)))
3032 goto invalid_fld;
3035 * WRITE SAME always has a sector sized buffer as payload, this
3036 * should never be a multiple entry S/G list.
3038 if (!scsi_sg_count(scmd))
3039 goto invalid_fld;
3041 buf = page_address(sg_page(scsi_sglist(scmd)));
3042 size = ata_set_lba_range_entries(buf, 512, block, n_block);
3044 tf->protocol = ATA_PROT_DMA;
3045 tf->hob_feature = 0;
3046 tf->feature = ATA_DSM_TRIM;
3047 tf->hob_nsect = (size / 512) >> 8;
3048 tf->nsect = size / 512;
3049 tf->command = ATA_CMD_DSM;
3050 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3051 ATA_TFLAG_WRITE;
3053 ata_qc_set_pc_nbytes(qc);
3055 return 0;
3057 invalid_fld:
3058 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
3059 /* "Invalid field in cdb" */
3060 return 1;
3064 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3065 * @dev: ATA device
3066 * @cmd: SCSI command opcode to consider
3068 * Look up the SCSI command given, and determine whether the
3069 * SCSI command is to be translated or simulated.
3071 * RETURNS:
3072 * Pointer to translation function if possible, %NULL if not.
3075 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3077 switch (cmd) {
3078 case READ_6:
3079 case READ_10:
3080 case READ_16:
3082 case WRITE_6:
3083 case WRITE_10:
3084 case WRITE_16:
3085 return ata_scsi_rw_xlat;
3087 case WRITE_SAME_16:
3088 return ata_scsi_write_same_xlat;
3090 case SYNCHRONIZE_CACHE:
3091 if (ata_try_flush_cache(dev))
3092 return ata_scsi_flush_xlat;
3093 break;
3095 case VERIFY:
3096 case VERIFY_16:
3097 return ata_scsi_verify_xlat;
3099 case ATA_12:
3100 case ATA_16:
3101 return ata_scsi_pass_thru;
3103 case START_STOP:
3104 return ata_scsi_start_stop_xlat;
3107 return NULL;
3111 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3112 * @ap: ATA port to which the command was being sent
3113 * @cmd: SCSI command to dump
3115 * Prints the contents of a SCSI command via printk().
3118 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3119 struct scsi_cmnd *cmd)
3121 #ifdef ATA_DEBUG
3122 struct scsi_device *scsidev = cmd->device;
3123 u8 *scsicmd = cmd->cmnd;
3125 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3126 ap->print_id,
3127 scsidev->channel, scsidev->id, scsidev->lun,
3128 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3129 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3130 scsicmd[8]);
3131 #endif
3134 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3135 struct ata_device *dev)
3137 u8 scsi_op = scmd->cmnd[0];
3138 ata_xlat_func_t xlat_func;
3139 int rc = 0;
3141 if (dev->class == ATA_DEV_ATA) {
3142 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3143 goto bad_cdb_len;
3145 xlat_func = ata_get_xlat_func(dev, scsi_op);
3146 } else {
3147 if (unlikely(!scmd->cmd_len))
3148 goto bad_cdb_len;
3150 xlat_func = NULL;
3151 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3152 /* relay SCSI command to ATAPI device */
3153 int len = COMMAND_SIZE(scsi_op);
3154 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3155 goto bad_cdb_len;
3157 xlat_func = atapi_xlat;
3158 } else {
3159 /* ATA_16 passthru, treat as an ATA command */
3160 if (unlikely(scmd->cmd_len > 16))
3161 goto bad_cdb_len;
3163 xlat_func = ata_get_xlat_func(dev, scsi_op);
3167 if (xlat_func)
3168 rc = ata_scsi_translate(dev, scmd, xlat_func);
3169 else
3170 ata_scsi_simulate(dev, scmd);
3172 return rc;
3174 bad_cdb_len:
3175 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3176 scmd->cmd_len, scsi_op, dev->cdb_len);
3177 scmd->result = DID_ERROR << 16;
3178 scmd->scsi_done(scmd);
3179 return 0;
3183 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3184 * @shost: SCSI host of command to be sent
3185 * @cmd: SCSI command to be sent
3187 * In some cases, this function translates SCSI commands into
3188 * ATA taskfiles, and queues the taskfiles to be sent to
3189 * hardware. In other cases, this function simulates a
3190 * SCSI device by evaluating and responding to certain
3191 * SCSI commands. This creates the overall effect of
3192 * ATA and ATAPI devices appearing as SCSI devices.
3194 * LOCKING:
3195 * ATA host lock
3197 * RETURNS:
3198 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3199 * 0 otherwise.
3201 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
3203 struct ata_port *ap;
3204 struct ata_device *dev;
3205 struct scsi_device *scsidev = cmd->device;
3206 int rc = 0;
3207 unsigned long irq_flags;
3209 ap = ata_shost_to_port(shost);
3211 spin_lock_irqsave(ap->lock, irq_flags);
3213 ata_scsi_dump_cdb(ap, cmd);
3215 dev = ata_scsi_find_dev(ap, scsidev);
3216 if (likely(dev))
3217 rc = __ata_scsi_queuecmd(cmd, dev);
3218 else {
3219 cmd->result = (DID_BAD_TARGET << 16);
3220 cmd->scsi_done(cmd);
3223 spin_unlock_irqrestore(ap->lock, irq_flags);
3225 return rc;
3229 * ata_scsi_simulate - simulate SCSI command on ATA device
3230 * @dev: the target device
3231 * @cmd: SCSI command being sent to device.
3233 * Interprets and directly executes a select list of SCSI commands
3234 * that can be handled internally.
3236 * LOCKING:
3237 * spin_lock_irqsave(host lock)
3240 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
3242 struct ata_scsi_args args;
3243 const u8 *scsicmd = cmd->cmnd;
3244 u8 tmp8;
3246 args.dev = dev;
3247 args.id = dev->id;
3248 args.cmd = cmd;
3249 args.done = cmd->scsi_done;
3251 switch(scsicmd[0]) {
3252 /* TODO: worth improving? */
3253 case FORMAT_UNIT:
3254 ata_scsi_invalid_field(cmd);
3255 break;
3257 case INQUIRY:
3258 if (scsicmd[1] & 2) /* is CmdDt set? */
3259 ata_scsi_invalid_field(cmd);
3260 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3261 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3262 else switch (scsicmd[2]) {
3263 case 0x00:
3264 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3265 break;
3266 case 0x80:
3267 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3268 break;
3269 case 0x83:
3270 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3271 break;
3272 case 0x89:
3273 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3274 break;
3275 case 0xb0:
3276 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3277 break;
3278 case 0xb1:
3279 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3280 break;
3281 case 0xb2:
3282 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
3283 break;
3284 default:
3285 ata_scsi_invalid_field(cmd);
3286 break;
3288 break;
3290 case MODE_SENSE:
3291 case MODE_SENSE_10:
3292 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3293 break;
3295 case MODE_SELECT: /* unconditionally return */
3296 case MODE_SELECT_10: /* bad-field-in-cdb */
3297 ata_scsi_invalid_field(cmd);
3298 break;
3300 case READ_CAPACITY:
3301 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3302 break;
3304 case SERVICE_ACTION_IN:
3305 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3306 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3307 else
3308 ata_scsi_invalid_field(cmd);
3309 break;
3311 case REPORT_LUNS:
3312 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3313 break;
3315 case REQUEST_SENSE:
3316 ata_scsi_set_sense(cmd, 0, 0, 0);
3317 cmd->result = (DRIVER_SENSE << 24);
3318 cmd->scsi_done(cmd);
3319 break;
3321 /* if we reach this, then writeback caching is disabled,
3322 * turning this into a no-op.
3324 case SYNCHRONIZE_CACHE:
3325 /* fall through */
3327 /* no-op's, complete with success */
3328 case REZERO_UNIT:
3329 case SEEK_6:
3330 case SEEK_10:
3331 case TEST_UNIT_READY:
3332 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3333 break;
3335 case SEND_DIAGNOSTIC:
3336 tmp8 = scsicmd[1] & ~(1 << 3);
3337 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3338 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3339 else
3340 ata_scsi_invalid_field(cmd);
3341 break;
3343 /* all other commands */
3344 default:
3345 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3346 /* "Invalid command operation code" */
3347 cmd->scsi_done(cmd);
3348 break;
3352 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3354 int i, rc;
3356 for (i = 0; i < host->n_ports; i++) {
3357 struct ata_port *ap = host->ports[i];
3358 struct Scsi_Host *shost;
3360 rc = -ENOMEM;
3361 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3362 if (!shost)
3363 goto err_alloc;
3365 *(struct ata_port **)&shost->hostdata[0] = ap;
3366 ap->scsi_host = shost;
3368 shost->transportt = ata_scsi_transport_template;
3369 shost->unique_id = ap->print_id;
3370 shost->max_id = 16;
3371 shost->max_lun = 1;
3372 shost->max_channel = 1;
3373 shost->max_cmd_len = 16;
3375 /* Schedule policy is determined by ->qc_defer()
3376 * callback and it needs to see every deferred qc.
3377 * Set host_blocked to 1 to prevent SCSI midlayer from
3378 * automatically deferring requests.
3380 shost->max_host_blocked = 1;
3382 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3383 if (rc)
3384 goto err_add;
3387 return 0;
3389 err_add:
3390 scsi_host_put(host->ports[i]->scsi_host);
3391 err_alloc:
3392 while (--i >= 0) {
3393 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3395 scsi_remove_host(shost);
3396 scsi_host_put(shost);
3398 return rc;
3401 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3403 int tries = 5;
3404 struct ata_device *last_failed_dev = NULL;
3405 struct ata_link *link;
3406 struct ata_device *dev;
3408 repeat:
3409 ata_for_each_link(link, ap, EDGE) {
3410 ata_for_each_dev(dev, link, ENABLED) {
3411 struct scsi_device *sdev;
3412 int channel = 0, id = 0;
3414 if (dev->sdev)
3415 continue;
3417 if (ata_is_host_link(link))
3418 id = dev->devno;
3419 else
3420 channel = link->pmp;
3422 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3423 NULL);
3424 if (!IS_ERR(sdev)) {
3425 dev->sdev = sdev;
3426 scsi_device_put(sdev);
3427 } else {
3428 dev->sdev = NULL;
3433 /* If we scanned while EH was in progress or allocation
3434 * failure occurred, scan would have failed silently. Check
3435 * whether all devices are attached.
3437 ata_for_each_link(link, ap, EDGE) {
3438 ata_for_each_dev(dev, link, ENABLED) {
3439 if (!dev->sdev)
3440 goto exit_loop;
3443 exit_loop:
3444 if (!link)
3445 return;
3447 /* we're missing some SCSI devices */
3448 if (sync) {
3449 /* If caller requested synchrnous scan && we've made
3450 * any progress, sleep briefly and repeat.
3452 if (dev != last_failed_dev) {
3453 msleep(100);
3454 last_failed_dev = dev;
3455 goto repeat;
3458 /* We might be failing to detect boot device, give it
3459 * a few more chances.
3461 if (--tries) {
3462 msleep(100);
3463 goto repeat;
3466 ata_port_err(ap,
3467 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
3470 queue_delayed_work(system_long_wq, &ap->hotplug_task,
3471 round_jiffies_relative(HZ));
3475 * ata_scsi_offline_dev - offline attached SCSI device
3476 * @dev: ATA device to offline attached SCSI device for
3478 * This function is called from ata_eh_hotplug() and responsible
3479 * for taking the SCSI device attached to @dev offline. This
3480 * function is called with host lock which protects dev->sdev
3481 * against clearing.
3483 * LOCKING:
3484 * spin_lock_irqsave(host lock)
3486 * RETURNS:
3487 * 1 if attached SCSI device exists, 0 otherwise.
3489 int ata_scsi_offline_dev(struct ata_device *dev)
3491 if (dev->sdev) {
3492 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3493 return 1;
3495 return 0;
3499 * ata_scsi_remove_dev - remove attached SCSI device
3500 * @dev: ATA device to remove attached SCSI device for
3502 * This function is called from ata_eh_scsi_hotplug() and
3503 * responsible for removing the SCSI device attached to @dev.
3505 * LOCKING:
3506 * Kernel thread context (may sleep).
3508 static void ata_scsi_remove_dev(struct ata_device *dev)
3510 struct ata_port *ap = dev->link->ap;
3511 struct scsi_device *sdev;
3512 unsigned long flags;
3514 /* Alas, we need to grab scan_mutex to ensure SCSI device
3515 * state doesn't change underneath us and thus
3516 * scsi_device_get() always succeeds. The mutex locking can
3517 * be removed if there is __scsi_device_get() interface which
3518 * increments reference counts regardless of device state.
3520 mutex_lock(&ap->scsi_host->scan_mutex);
3521 spin_lock_irqsave(ap->lock, flags);
3523 /* clearing dev->sdev is protected by host lock */
3524 sdev = dev->sdev;
3525 dev->sdev = NULL;
3527 if (sdev) {
3528 /* If user initiated unplug races with us, sdev can go
3529 * away underneath us after the host lock and
3530 * scan_mutex are released. Hold onto it.
3532 if (scsi_device_get(sdev) == 0) {
3533 /* The following ensures the attached sdev is
3534 * offline on return from ata_scsi_offline_dev()
3535 * regardless it wins or loses the race
3536 * against this function.
3538 scsi_device_set_state(sdev, SDEV_OFFLINE);
3539 } else {
3540 WARN_ON(1);
3541 sdev = NULL;
3545 spin_unlock_irqrestore(ap->lock, flags);
3546 mutex_unlock(&ap->scsi_host->scan_mutex);
3548 if (sdev) {
3549 ata_dev_info(dev, "detaching (SCSI %s)\n",
3550 dev_name(&sdev->sdev_gendev));
3552 scsi_remove_device(sdev);
3553 scsi_device_put(sdev);
3557 static void ata_scsi_handle_link_detach(struct ata_link *link)
3559 struct ata_port *ap = link->ap;
3560 struct ata_device *dev;
3562 ata_for_each_dev(dev, link, ALL) {
3563 unsigned long flags;
3565 if (!(dev->flags & ATA_DFLAG_DETACHED))
3566 continue;
3568 spin_lock_irqsave(ap->lock, flags);
3569 dev->flags &= ~ATA_DFLAG_DETACHED;
3570 spin_unlock_irqrestore(ap->lock, flags);
3572 ata_scsi_remove_dev(dev);
3577 * ata_scsi_media_change_notify - send media change event
3578 * @dev: Pointer to the disk device with media change event
3580 * Tell the block layer to send a media change notification
3581 * event.
3583 * LOCKING:
3584 * spin_lock_irqsave(host lock)
3586 void ata_scsi_media_change_notify(struct ata_device *dev)
3588 if (dev->sdev)
3589 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3590 GFP_ATOMIC);
3594 * ata_scsi_hotplug - SCSI part of hotplug
3595 * @work: Pointer to ATA port to perform SCSI hotplug on
3597 * Perform SCSI part of hotplug. It's executed from a separate
3598 * workqueue after EH completes. This is necessary because SCSI
3599 * hot plugging requires working EH and hot unplugging is
3600 * synchronized with hot plugging with a mutex.
3602 * LOCKING:
3603 * Kernel thread context (may sleep).
3605 void ata_scsi_hotplug(struct work_struct *work)
3607 struct ata_port *ap =
3608 container_of(work, struct ata_port, hotplug_task.work);
3609 int i;
3611 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3612 DPRINTK("ENTER/EXIT - unloading\n");
3613 return;
3616 DPRINTK("ENTER\n");
3617 mutex_lock(&ap->scsi_scan_mutex);
3619 /* Unplug detached devices. We cannot use link iterator here
3620 * because PMP links have to be scanned even if PMP is
3621 * currently not attached. Iterate manually.
3623 ata_scsi_handle_link_detach(&ap->link);
3624 if (ap->pmp_link)
3625 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3626 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3628 /* scan for new ones */
3629 ata_scsi_scan_host(ap, 0);
3631 mutex_unlock(&ap->scsi_scan_mutex);
3632 DPRINTK("EXIT\n");
3636 * ata_scsi_user_scan - indication for user-initiated bus scan
3637 * @shost: SCSI host to scan
3638 * @channel: Channel to scan
3639 * @id: ID to scan
3640 * @lun: LUN to scan
3642 * This function is called when user explicitly requests bus
3643 * scan. Set probe pending flag and invoke EH.
3645 * LOCKING:
3646 * SCSI layer (we don't care)
3648 * RETURNS:
3649 * Zero.
3651 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3652 unsigned int id, unsigned int lun)
3654 struct ata_port *ap = ata_shost_to_port(shost);
3655 unsigned long flags;
3656 int devno, rc = 0;
3658 if (!ap->ops->error_handler)
3659 return -EOPNOTSUPP;
3661 if (lun != SCAN_WILD_CARD && lun)
3662 return -EINVAL;
3664 if (!sata_pmp_attached(ap)) {
3665 if (channel != SCAN_WILD_CARD && channel)
3666 return -EINVAL;
3667 devno = id;
3668 } else {
3669 if (id != SCAN_WILD_CARD && id)
3670 return -EINVAL;
3671 devno = channel;
3674 spin_lock_irqsave(ap->lock, flags);
3676 if (devno == SCAN_WILD_CARD) {
3677 struct ata_link *link;
3679 ata_for_each_link(link, ap, EDGE) {
3680 struct ata_eh_info *ehi = &link->eh_info;
3681 ehi->probe_mask |= ATA_ALL_DEVICES;
3682 ehi->action |= ATA_EH_RESET;
3684 } else {
3685 struct ata_device *dev = ata_find_dev(ap, devno);
3687 if (dev) {
3688 struct ata_eh_info *ehi = &dev->link->eh_info;
3689 ehi->probe_mask |= 1 << dev->devno;
3690 ehi->action |= ATA_EH_RESET;
3691 } else
3692 rc = -EINVAL;
3695 if (rc == 0) {
3696 ata_port_schedule_eh(ap);
3697 spin_unlock_irqrestore(ap->lock, flags);
3698 ata_port_wait_eh(ap);
3699 } else
3700 spin_unlock_irqrestore(ap->lock, flags);
3702 return rc;
3706 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3707 * @work: Pointer to ATA port to perform scsi_rescan_device()
3709 * After ATA pass thru (SAT) commands are executed successfully,
3710 * libata need to propagate the changes to SCSI layer.
3712 * LOCKING:
3713 * Kernel thread context (may sleep).
3715 void ata_scsi_dev_rescan(struct work_struct *work)
3717 struct ata_port *ap =
3718 container_of(work, struct ata_port, scsi_rescan_task);
3719 struct ata_link *link;
3720 struct ata_device *dev;
3721 unsigned long flags;
3723 mutex_lock(&ap->scsi_scan_mutex);
3724 spin_lock_irqsave(ap->lock, flags);
3726 ata_for_each_link(link, ap, EDGE) {
3727 ata_for_each_dev(dev, link, ENABLED) {
3728 struct scsi_device *sdev = dev->sdev;
3730 if (!sdev)
3731 continue;
3732 if (scsi_device_get(sdev))
3733 continue;
3735 spin_unlock_irqrestore(ap->lock, flags);
3736 scsi_rescan_device(&(sdev->sdev_gendev));
3737 scsi_device_put(sdev);
3738 spin_lock_irqsave(ap->lock, flags);
3742 spin_unlock_irqrestore(ap->lock, flags);
3743 mutex_unlock(&ap->scsi_scan_mutex);
3747 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3748 * @host: ATA host container for all SAS ports
3749 * @port_info: Information from low-level host driver
3750 * @shost: SCSI host that the scsi device is attached to
3752 * LOCKING:
3753 * PCI/etc. bus probe sem.
3755 * RETURNS:
3756 * ata_port pointer on success / NULL on failure.
3759 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3760 struct ata_port_info *port_info,
3761 struct Scsi_Host *shost)
3763 struct ata_port *ap;
3765 ap = ata_port_alloc(host);
3766 if (!ap)
3767 return NULL;
3769 ap->port_no = 0;
3770 ap->lock = &host->lock;
3771 ap->pio_mask = port_info->pio_mask;
3772 ap->mwdma_mask = port_info->mwdma_mask;
3773 ap->udma_mask = port_info->udma_mask;
3774 ap->flags |= port_info->flags;
3775 ap->ops = port_info->port_ops;
3776 ap->cbl = ATA_CBL_SATA;
3778 return ap;
3780 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3783 * ata_sas_port_start - Set port up for dma.
3784 * @ap: Port to initialize
3786 * Called just after data structures for each port are
3787 * initialized.
3789 * May be used as the port_start() entry in ata_port_operations.
3791 * LOCKING:
3792 * Inherited from caller.
3794 int ata_sas_port_start(struct ata_port *ap)
3797 * the port is marked as frozen at allocation time, but if we don't
3798 * have new eh, we won't thaw it
3800 if (!ap->ops->error_handler)
3801 ap->pflags &= ~ATA_PFLAG_FROZEN;
3802 return 0;
3804 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3807 * ata_port_stop - Undo ata_sas_port_start()
3808 * @ap: Port to shut down
3810 * May be used as the port_stop() entry in ata_port_operations.
3812 * LOCKING:
3813 * Inherited from caller.
3816 void ata_sas_port_stop(struct ata_port *ap)
3819 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3822 * ata_sas_port_init - Initialize a SATA device
3823 * @ap: SATA port to initialize
3825 * LOCKING:
3826 * PCI/etc. bus probe sem.
3828 * RETURNS:
3829 * Zero on success, non-zero on error.
3832 int ata_sas_port_init(struct ata_port *ap)
3834 int rc = ap->ops->port_start(ap);
3836 if (!rc) {
3837 ap->print_id = ata_print_id++;
3838 rc = ata_port_probe(ap);
3841 return rc;
3843 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3846 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3847 * @ap: SATA port to destroy
3851 void ata_sas_port_destroy(struct ata_port *ap)
3853 if (ap->ops->port_stop)
3854 ap->ops->port_stop(ap);
3855 kfree(ap);
3857 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3860 * ata_sas_slave_configure - Default slave_config routine for libata devices
3861 * @sdev: SCSI device to configure
3862 * @ap: ATA port to which SCSI device is attached
3864 * RETURNS:
3865 * Zero.
3868 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3870 ata_scsi_sdev_config(sdev);
3871 ata_scsi_dev_config(sdev, ap->link.device);
3872 return 0;
3874 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3877 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3878 * @cmd: SCSI command to be sent
3879 * @ap: ATA port to which the command is being sent
3881 * RETURNS:
3882 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3883 * 0 otherwise.
3886 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
3888 int rc = 0;
3890 ata_scsi_dump_cdb(ap, cmd);
3892 if (likely(ata_dev_enabled(ap->link.device)))
3893 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
3894 else {
3895 cmd->result = (DID_BAD_TARGET << 16);
3896 cmd->scsi_done(cmd);
3898 return rc;
3900 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);