GUI: Fix Tomato RAF theme for all builds. Compilation typo.
[tomato.git] / release / src-rt-6.x.4708 / linux / linux-2.6.36 / drivers / ata / libata-scsi.c
blob6019afe40b9b87e298e1ee4dec270bc478a103e6
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"
55 #define SECTOR_SIZE 512
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);
67 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
68 unsigned int id, unsigned int lun);
71 #define RW_RECOVERY_MPAGE 0x1
72 #define RW_RECOVERY_MPAGE_LEN 12
73 #define CACHE_MPAGE 0x8
74 #define CACHE_MPAGE_LEN 20
75 #define CONTROL_MPAGE 0xa
76 #define CONTROL_MPAGE_LEN 12
77 #define ALL_MPAGES 0x3f
78 #define ALL_SUB_MPAGES 0xff
81 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
82 RW_RECOVERY_MPAGE,
83 RW_RECOVERY_MPAGE_LEN - 2,
84 (1 << 7), /* AWRE */
85 0, /* read retry count */
86 0, 0, 0, 0,
87 0, /* write retry count */
88 0, 0, 0
91 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
92 CACHE_MPAGE,
93 CACHE_MPAGE_LEN - 2,
94 0, /* contains WCE, needs to be 0 for logic */
95 0, 0, 0, 0, 0, 0, 0, 0, 0,
96 0, /* contains DRA, needs to be 0 for logic */
97 0, 0, 0, 0, 0, 0, 0
100 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
101 CONTROL_MPAGE,
102 CONTROL_MPAGE_LEN - 2,
103 2, /* DSENSE=0, GLTSD=1 */
104 0, /* [QAM+QERR may be 1, see 05-359r1] */
105 0, 0, 0, 0, 0xff, 0xff,
106 0, 30 /* extended self test time, see 05-359r1 */
110 * libata transport template. libata doesn't do real transport stuff.
111 * It just needs the eh_timed_out hook.
113 static struct scsi_transport_template ata_scsi_transport_template = {
114 .eh_strategy_handler = ata_scsi_error,
115 .eh_timed_out = ata_scsi_timed_out,
116 .user_scan = ata_scsi_user_scan,
120 static const struct {
121 enum link_pm value;
122 const char *name;
123 } link_pm_policy[] = {
124 { NOT_AVAILABLE, "max_performance" },
125 { MIN_POWER, "min_power" },
126 { MAX_PERFORMANCE, "max_performance" },
127 { MEDIUM_POWER, "medium_power" },
130 static const char *ata_scsi_lpm_get(enum link_pm policy)
132 int i;
134 for (i = 0; i < ARRAY_SIZE(link_pm_policy); i++)
135 if (link_pm_policy[i].value == policy)
136 return link_pm_policy[i].name;
138 return NULL;
141 static ssize_t ata_scsi_lpm_put(struct device *dev,
142 struct device_attribute *attr,
143 const char *buf, size_t count)
145 struct Scsi_Host *shost = class_to_shost(dev);
146 struct ata_port *ap = ata_shost_to_port(shost);
147 enum link_pm policy = 0;
148 int i;
151 * we are skipping array location 0 on purpose - this
152 * is because a value of NOT_AVAILABLE is displayed
153 * to the user as max_performance, but when the user
154 * writes "max_performance", they actually want the
155 * value to match MAX_PERFORMANCE.
157 for (i = 1; i < ARRAY_SIZE(link_pm_policy); i++) {
158 const int len = strlen(link_pm_policy[i].name);
159 if (strncmp(link_pm_policy[i].name, buf, len) == 0) {
160 policy = link_pm_policy[i].value;
161 break;
164 if (!policy)
165 return -EINVAL;
167 ata_lpm_schedule(ap, policy);
168 return count;
171 static ssize_t
172 ata_scsi_lpm_show(struct device *dev, struct device_attribute *attr, char *buf)
174 struct Scsi_Host *shost = class_to_shost(dev);
175 struct ata_port *ap = ata_shost_to_port(shost);
176 const char *policy =
177 ata_scsi_lpm_get(ap->pm_policy);
179 if (!policy)
180 return -EINVAL;
182 return snprintf(buf, 23, "%s\n", policy);
184 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
185 ata_scsi_lpm_show, ata_scsi_lpm_put);
186 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
188 static ssize_t ata_scsi_park_show(struct device *device,
189 struct device_attribute *attr, char *buf)
191 struct scsi_device *sdev = to_scsi_device(device);
192 struct ata_port *ap;
193 struct ata_link *link;
194 struct ata_device *dev;
195 unsigned long flags, now;
196 unsigned int uninitialized_var(msecs);
197 int rc = 0;
199 ap = ata_shost_to_port(sdev->host);
201 spin_lock_irqsave(ap->lock, flags);
202 dev = ata_scsi_find_dev(ap, sdev);
203 if (!dev) {
204 rc = -ENODEV;
205 goto unlock;
207 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
208 rc = -EOPNOTSUPP;
209 goto unlock;
212 link = dev->link;
213 now = jiffies;
214 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
215 link->eh_context.unloaded_mask & (1 << dev->devno) &&
216 time_after(dev->unpark_deadline, now))
217 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
218 else
219 msecs = 0;
221 unlock:
222 spin_unlock_irq(ap->lock);
224 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
227 static ssize_t ata_scsi_park_store(struct device *device,
228 struct device_attribute *attr,
229 const char *buf, size_t len)
231 struct scsi_device *sdev = to_scsi_device(device);
232 struct ata_port *ap;
233 struct ata_device *dev;
234 long int input;
235 unsigned long flags;
236 int rc;
238 rc = strict_strtol(buf, 10, &input);
239 if (rc || input < -2)
240 return -EINVAL;
241 if (input > ATA_TMOUT_MAX_PARK) {
242 rc = -EOVERFLOW;
243 input = ATA_TMOUT_MAX_PARK;
246 ap = ata_shost_to_port(sdev->host);
248 spin_lock_irqsave(ap->lock, flags);
249 dev = ata_scsi_find_dev(ap, sdev);
250 if (unlikely(!dev)) {
251 rc = -ENODEV;
252 goto unlock;
254 if (dev->class != ATA_DEV_ATA) {
255 rc = -EOPNOTSUPP;
256 goto unlock;
259 if (input >= 0) {
260 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
261 rc = -EOPNOTSUPP;
262 goto unlock;
265 dev->unpark_deadline = ata_deadline(jiffies, input);
266 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
267 ata_port_schedule_eh(ap);
268 complete(&ap->park_req_pending);
269 } else {
270 switch (input) {
271 case -1:
272 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
273 break;
274 case -2:
275 dev->flags |= ATA_DFLAG_NO_UNLOAD;
276 break;
279 unlock:
280 spin_unlock_irqrestore(ap->lock, flags);
282 return rc ? rc : len;
284 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
285 ata_scsi_park_show, ata_scsi_park_store);
286 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
288 static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
290 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
292 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
295 static ssize_t
296 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
297 const char *buf, size_t count)
299 struct Scsi_Host *shost = class_to_shost(dev);
300 struct ata_port *ap = ata_shost_to_port(shost);
301 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
302 return ap->ops->em_store(ap, buf, count);
303 return -EINVAL;
306 static ssize_t
307 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
308 char *buf)
310 struct Scsi_Host *shost = class_to_shost(dev);
311 struct ata_port *ap = ata_shost_to_port(shost);
313 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
314 return ap->ops->em_show(ap, buf);
315 return -EINVAL;
317 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
318 ata_scsi_em_message_show, ata_scsi_em_message_store);
319 EXPORT_SYMBOL_GPL(dev_attr_em_message);
321 static ssize_t
322 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
323 char *buf)
325 struct Scsi_Host *shost = class_to_shost(dev);
326 struct ata_port *ap = ata_shost_to_port(shost);
328 return snprintf(buf, 23, "%d\n", ap->em_message_type);
330 DEVICE_ATTR(em_message_type, S_IRUGO,
331 ata_scsi_em_message_type_show, NULL);
332 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
334 static ssize_t
335 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
336 char *buf)
338 struct scsi_device *sdev = to_scsi_device(dev);
339 struct ata_port *ap = ata_shost_to_port(sdev->host);
340 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
342 if (ap->ops->sw_activity_show && (ap->flags & ATA_FLAG_SW_ACTIVITY))
343 return ap->ops->sw_activity_show(atadev, buf);
344 return -EINVAL;
347 static ssize_t
348 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
349 const char *buf, size_t count)
351 struct scsi_device *sdev = to_scsi_device(dev);
352 struct ata_port *ap = ata_shost_to_port(sdev->host);
353 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
354 enum sw_activity val;
355 int rc;
357 if (ap->ops->sw_activity_store && (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
358 val = simple_strtoul(buf, NULL, 0);
359 switch (val) {
360 case OFF: case BLINK_ON: case BLINK_OFF:
361 rc = ap->ops->sw_activity_store(atadev, val);
362 if (!rc)
363 return count;
364 else
365 return rc;
368 return -EINVAL;
370 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
371 ata_scsi_activity_store);
372 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
374 struct device_attribute *ata_common_sdev_attrs[] = {
375 &dev_attr_unload_heads,
376 NULL
378 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
380 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
381 void (*done)(struct scsi_cmnd *))
383 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
384 /* "Invalid field in cbd" */
385 done(cmd);
388 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
389 sector_t capacity, int geom[])
391 geom[0] = 255;
392 geom[1] = 63;
393 sector_div(capacity, 255*63);
394 geom[2] = capacity;
396 return 0;
400 * ata_scsi_unlock_native_capacity - unlock native capacity
401 * @sdev: SCSI device to adjust device capacity for
403 * This function is called if a partition on @sdev extends beyond
404 * the end of the device. It requests EH to unlock HPA.
406 * LOCKING:
407 * Defined by the SCSI layer. Might sleep.
409 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
411 struct ata_port *ap = ata_shost_to_port(sdev->host);
412 struct ata_device *dev;
413 unsigned long flags;
415 spin_lock_irqsave(ap->lock, flags);
417 dev = ata_scsi_find_dev(ap, sdev);
418 if (dev && dev->n_sectors < dev->n_native_sectors) {
419 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
420 dev->link->eh_info.action |= ATA_EH_RESET;
421 ata_port_schedule_eh(ap);
424 spin_unlock_irqrestore(ap->lock, flags);
425 ata_port_wait_eh(ap);
429 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
430 * @ap: target port
431 * @sdev: SCSI device to get identify data for
432 * @arg: User buffer area for identify data
434 * LOCKING:
435 * Defined by the SCSI layer. We don't really care.
437 * RETURNS:
438 * Zero on success, negative errno on error.
440 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
441 void __user *arg)
443 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
444 u16 __user *dst = arg;
445 char buf[40];
447 if (!dev)
448 return -ENOMSG;
450 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
451 return -EFAULT;
453 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
454 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
455 return -EFAULT;
457 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
458 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
459 return -EFAULT;
461 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
462 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
463 return -EFAULT;
465 return 0;
469 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
470 * @scsidev: Device to which we are issuing command
471 * @arg: User provided data for issuing command
473 * LOCKING:
474 * Defined by the SCSI layer. We don't really care.
476 * RETURNS:
477 * Zero on success, negative errno on error.
479 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
481 int rc = 0;
482 u8 scsi_cmd[MAX_COMMAND_SIZE];
483 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
484 int argsize = 0;
485 enum dma_data_direction data_dir;
486 int cmd_result;
488 if (arg == NULL)
489 return -EINVAL;
491 if (copy_from_user(args, arg, sizeof(args)))
492 return -EFAULT;
494 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
495 if (!sensebuf)
496 return -ENOMEM;
498 memset(scsi_cmd, 0, sizeof(scsi_cmd));
500 if (args[3]) {
501 argsize = SECTOR_SIZE * args[3];
502 argbuf = kmalloc(argsize, GFP_KERNEL);
503 if (argbuf == NULL) {
504 rc = -ENOMEM;
505 goto error;
508 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
509 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
510 block count in sector count field */
511 data_dir = DMA_FROM_DEVICE;
512 } else {
513 scsi_cmd[1] = (3 << 1); /* Non-data */
514 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
515 data_dir = DMA_NONE;
518 scsi_cmd[0] = ATA_16;
520 scsi_cmd[4] = args[2];
521 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
522 scsi_cmd[6] = args[3];
523 scsi_cmd[8] = args[1];
524 scsi_cmd[10] = 0x4f;
525 scsi_cmd[12] = 0xc2;
526 } else {
527 scsi_cmd[6] = args[1];
529 scsi_cmd[14] = args[0];
531 /* Good values for timeout and retries? Values below
532 from scsi_ioctl_send_command() for default case... */
533 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
534 sensebuf, (10*HZ), 5, 0, NULL);
536 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
537 u8 *desc = sensebuf + 8;
538 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
540 /* If we set cc then ATA pass-through will cause a
541 * check condition even if no error. Filter that. */
542 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
543 struct scsi_sense_hdr sshdr;
544 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
545 &sshdr);
546 if (sshdr.sense_key == 0 &&
547 sshdr.asc == 0 && sshdr.ascq == 0)
548 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
551 /* Send userspace a few ATA registers (same as drivers/ide) */
552 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
553 desc[0] == 0x09) { /* code is "ATA Descriptor" */
554 args[0] = desc[13]; /* status */
555 args[1] = desc[3]; /* error */
556 args[2] = desc[5]; /* sector count (0:7) */
557 if (copy_to_user(arg, args, sizeof(args)))
558 rc = -EFAULT;
563 if (cmd_result) {
564 rc = -EIO;
565 goto error;
568 if ((argbuf)
569 && copy_to_user(arg + sizeof(args), argbuf, argsize))
570 rc = -EFAULT;
571 error:
572 kfree(sensebuf);
573 kfree(argbuf);
574 return rc;
578 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
579 * @scsidev: Device to which we are issuing command
580 * @arg: User provided data for issuing command
582 * LOCKING:
583 * Defined by the SCSI layer. We don't really care.
585 * RETURNS:
586 * Zero on success, negative errno on error.
588 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
590 int rc = 0;
591 u8 scsi_cmd[MAX_COMMAND_SIZE];
592 u8 args[7], *sensebuf = NULL;
593 int cmd_result;
595 if (arg == NULL)
596 return -EINVAL;
598 if (copy_from_user(args, arg, sizeof(args)))
599 return -EFAULT;
601 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
602 if (!sensebuf)
603 return -ENOMEM;
605 memset(scsi_cmd, 0, sizeof(scsi_cmd));
606 scsi_cmd[0] = ATA_16;
607 scsi_cmd[1] = (3 << 1); /* Non-data */
608 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
609 scsi_cmd[4] = args[1];
610 scsi_cmd[6] = args[2];
611 scsi_cmd[8] = args[3];
612 scsi_cmd[10] = args[4];
613 scsi_cmd[12] = args[5];
614 scsi_cmd[13] = args[6] & 0x4f;
615 scsi_cmd[14] = args[0];
617 /* Good values for timeout and retries? Values below
618 from scsi_ioctl_send_command() for default case... */
619 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
620 sensebuf, (10*HZ), 5, 0, NULL);
622 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
623 u8 *desc = sensebuf + 8;
624 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
626 /* If we set cc then ATA pass-through will cause a
627 * check condition even if no error. Filter that. */
628 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
629 struct scsi_sense_hdr sshdr;
630 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
631 &sshdr);
632 if (sshdr.sense_key == 0 &&
633 sshdr.asc == 0 && sshdr.ascq == 0)
634 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
637 /* Send userspace ATA registers */
638 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
639 desc[0] == 0x09) {/* code is "ATA Descriptor" */
640 args[0] = desc[13]; /* status */
641 args[1] = desc[3]; /* error */
642 args[2] = desc[5]; /* sector count (0:7) */
643 args[3] = desc[7]; /* lbal */
644 args[4] = desc[9]; /* lbam */
645 args[5] = desc[11]; /* lbah */
646 args[6] = desc[12]; /* select */
647 if (copy_to_user(arg, args, sizeof(args)))
648 rc = -EFAULT;
652 if (cmd_result) {
653 rc = -EIO;
654 goto error;
657 error:
658 kfree(sensebuf);
659 return rc;
662 static int ata_ioc32(struct ata_port *ap)
664 if (ap->flags & ATA_FLAG_PIO_DMA)
665 return 1;
666 if (ap->pflags & ATA_PFLAG_PIO32)
667 return 1;
668 return 0;
671 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
672 int cmd, void __user *arg)
674 int val = -EINVAL, rc = -EINVAL;
675 unsigned long flags;
677 switch (cmd) {
678 case ATA_IOC_GET_IO32:
679 spin_lock_irqsave(ap->lock, flags);
680 val = ata_ioc32(ap);
681 spin_unlock_irqrestore(ap->lock, flags);
682 if (copy_to_user(arg, &val, 1))
683 return -EFAULT;
684 return 0;
686 case ATA_IOC_SET_IO32:
687 val = (unsigned long) arg;
688 rc = 0;
689 spin_lock_irqsave(ap->lock, flags);
690 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
691 if (val)
692 ap->pflags |= ATA_PFLAG_PIO32;
693 else
694 ap->pflags &= ~ATA_PFLAG_PIO32;
695 } else {
696 if (val != ata_ioc32(ap))
697 rc = -EINVAL;
699 spin_unlock_irqrestore(ap->lock, flags);
700 return rc;
702 case HDIO_GET_IDENTITY:
703 return ata_get_identity(ap, scsidev, arg);
705 case HDIO_DRIVE_CMD:
706 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
707 return -EACCES;
708 return ata_cmd_ioctl(scsidev, arg);
710 case HDIO_DRIVE_TASK:
711 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
712 return -EACCES;
713 return ata_task_ioctl(scsidev, arg);
715 default:
716 rc = -ENOTTY;
717 break;
720 return rc;
722 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
724 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
726 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
727 scsidev, cmd, arg);
729 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
732 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
733 * @dev: ATA device to which the new command is attached
734 * @cmd: SCSI command that originated this ATA command
735 * @done: SCSI command completion function
737 * Obtain a reference to an unused ata_queued_cmd structure,
738 * which is the basic libata structure representing a single
739 * ATA command sent to the hardware.
741 * If a command was available, fill in the SCSI-specific
742 * portions of the structure with information on the
743 * current command.
745 * LOCKING:
746 * spin_lock_irqsave(host lock)
748 * RETURNS:
749 * Command allocated, or %NULL if none available.
751 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
752 struct scsi_cmnd *cmd,
753 void (*done)(struct scsi_cmnd *))
755 struct ata_queued_cmd *qc;
757 qc = ata_qc_new_init(dev);
758 if (qc) {
759 qc->scsicmd = cmd;
760 qc->scsidone = done;
762 qc->sg = scsi_sglist(cmd);
763 qc->n_elem = scsi_sg_count(cmd);
764 } else {
765 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
766 done(cmd);
769 return qc;
772 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
774 struct scsi_cmnd *scmd = qc->scsicmd;
776 qc->extrabytes = scmd->request->extra_len;
777 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
781 * ata_dump_status - user friendly display of error info
782 * @id: id of the port in question
783 * @tf: ptr to filled out taskfile
785 * Decode and dump the ATA error/status registers for the user so
786 * that they have some idea what really happened at the non
787 * make-believe layer.
789 * LOCKING:
790 * inherited from caller
792 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
794 u8 stat = tf->command, err = tf->feature;
796 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
797 if (stat & ATA_BUSY) {
798 printk("Busy }\n"); /* Data is not valid in this case */
799 } else {
800 if (stat & 0x40) printk("DriveReady ");
801 if (stat & 0x20) printk("DeviceFault ");
802 if (stat & 0x10) printk("SeekComplete ");
803 if (stat & 0x08) printk("DataRequest ");
804 if (stat & 0x04) printk("CorrectedError ");
805 if (stat & 0x02) printk("Index ");
806 if (stat & 0x01) printk("Error ");
807 printk("}\n");
809 if (err) {
810 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
811 if (err & 0x04) printk("DriveStatusError ");
812 if (err & 0x80) {
813 if (err & 0x04) printk("BadCRC ");
814 else printk("Sector ");
816 if (err & 0x40) printk("UncorrectableError ");
817 if (err & 0x10) printk("SectorIdNotFound ");
818 if (err & 0x02) printk("TrackZeroNotFound ");
819 if (err & 0x01) printk("AddrMarkNotFound ");
820 printk("}\n");
826 * ata_to_sense_error - convert ATA error to SCSI error
827 * @id: ATA device number
828 * @drv_stat: value contained in ATA status register
829 * @drv_err: value contained in ATA error register
830 * @sk: the sense key we'll fill out
831 * @asc: the additional sense code we'll fill out
832 * @ascq: the additional sense code qualifier we'll fill out
833 * @verbose: be verbose
835 * Converts an ATA error into a SCSI error. Fill out pointers to
836 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
837 * format sense blocks.
839 * LOCKING:
840 * spin_lock_irqsave(host lock)
842 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
843 u8 *asc, u8 *ascq, int verbose)
845 int i;
847 /* Based on the 3ware driver translation table */
848 static const unsigned char sense_table[][4] = {
849 /* BBD|ECC|ID|MAR */
850 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
851 /* BBD|ECC|ID */
852 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
853 /* ECC|MC|MARK */
854 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
855 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
856 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
857 /* MC|ID|ABRT|TRK0|MARK */
858 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
859 /* MCR|MARK */
860 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
861 /* Bad address mark */
862 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
863 /* TRK0 */
864 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
865 /* Abort & !ICRC */
866 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
867 /* Media change request */
868 {0x08, NOT_READY, 0x04, 0x00},
869 /* SRV */
870 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
871 /* Media change */
872 {0x08, NOT_READY, 0x04, 0x00},
873 /* ECC */
874 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
875 /* BBD - block marked bad */
876 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
877 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
879 static const unsigned char stat_table[][4] = {
880 /* Must be first because BUSY means no other bits valid */
881 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
882 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
883 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
884 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
885 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
889 * Is this an error we can process/parse
891 if (drv_stat & ATA_BUSY) {
892 drv_err = 0; /* Ignore the err bits, they're invalid */
895 if (drv_err) {
896 /* Look for drv_err */
897 for (i = 0; sense_table[i][0] != 0xFF; i++) {
898 /* Look for best matches first */
899 if ((sense_table[i][0] & drv_err) ==
900 sense_table[i][0]) {
901 *sk = sense_table[i][1];
902 *asc = sense_table[i][2];
903 *ascq = sense_table[i][3];
904 goto translate_done;
907 /* No immediate match */
908 if (verbose)
909 printk(KERN_WARNING "ata%u: no sense translation for "
910 "error 0x%02x\n", id, drv_err);
913 /* Fall back to interpreting status bits */
914 for (i = 0; stat_table[i][0] != 0xFF; i++) {
915 if (stat_table[i][0] & drv_stat) {
916 *sk = stat_table[i][1];
917 *asc = stat_table[i][2];
918 *ascq = stat_table[i][3];
919 goto translate_done;
922 /* No error? Undecoded? */
923 if (verbose)
924 printk(KERN_WARNING "ata%u: no sense translation for "
925 "status: 0x%02x\n", id, drv_stat);
927 /* We need a sensible error return here, which is tricky, and one
928 that won't cause people to do things like return a disk wrongly */
929 *sk = ABORTED_COMMAND;
930 *asc = 0x00;
931 *ascq = 0x00;
933 translate_done:
934 if (verbose)
935 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
936 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
937 id, drv_stat, drv_err, *sk, *asc, *ascq);
938 return;
942 * ata_gen_passthru_sense - Generate check condition sense block.
943 * @qc: Command that completed.
945 * This function is specific to the ATA descriptor format sense
946 * block specified for the ATA pass through commands. Regardless
947 * of whether the command errored or not, return a sense
948 * block. Copy all controller registers into the sense
949 * block. Clear sense key, ASC & ASCQ if there is no error.
951 * LOCKING:
952 * None.
954 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
956 struct scsi_cmnd *cmd = qc->scsicmd;
957 struct ata_taskfile *tf = &qc->result_tf;
958 unsigned char *sb = cmd->sense_buffer;
959 unsigned char *desc = sb + 8;
960 int verbose = qc->ap->ops->error_handler == NULL;
962 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
964 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
967 * Use ata_to_sense_error() to map status register bits
968 * onto sense key, asc & ascq.
970 if (qc->err_mask ||
971 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
972 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
973 &sb[1], &sb[2], &sb[3], verbose);
974 sb[1] &= 0x0f;
978 * Sense data is current and format is descriptor.
980 sb[0] = 0x72;
982 desc[0] = 0x09;
984 /* set length of additional sense data */
985 sb[7] = 14;
986 desc[1] = 12;
989 * Copy registers into sense buffer.
991 desc[2] = 0x00;
992 desc[3] = tf->feature; /* == error reg */
993 desc[5] = tf->nsect;
994 desc[7] = tf->lbal;
995 desc[9] = tf->lbam;
996 desc[11] = tf->lbah;
997 desc[12] = tf->device;
998 desc[13] = tf->command; /* == status reg */
1001 * Fill in Extend bit, and the high order bytes
1002 * if applicable.
1004 if (tf->flags & ATA_TFLAG_LBA48) {
1005 desc[2] |= 0x01;
1006 desc[4] = tf->hob_nsect;
1007 desc[6] = tf->hob_lbal;
1008 desc[8] = tf->hob_lbam;
1009 desc[10] = tf->hob_lbah;
1014 * ata_gen_ata_sense - generate a SCSI fixed sense block
1015 * @qc: Command that we are erroring out
1017 * Generate sense block for a failed ATA command @qc. Descriptor
1018 * format is used to accomodate LBA48 block address.
1020 * LOCKING:
1021 * None.
1023 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1025 struct ata_device *dev = qc->dev;
1026 struct scsi_cmnd *cmd = qc->scsicmd;
1027 struct ata_taskfile *tf = &qc->result_tf;
1028 unsigned char *sb = cmd->sense_buffer;
1029 unsigned char *desc = sb + 8;
1030 int verbose = qc->ap->ops->error_handler == NULL;
1031 u64 block;
1033 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1035 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1037 /* sense data is current and format is descriptor */
1038 sb[0] = 0x72;
1040 /* Use ata_to_sense_error() to map status register bits
1041 * onto sense key, asc & ascq.
1043 if (qc->err_mask ||
1044 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1045 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1046 &sb[1], &sb[2], &sb[3], verbose);
1047 sb[1] &= 0x0f;
1050 block = ata_tf_read_block(&qc->result_tf, dev);
1052 /* information sense data descriptor */
1053 sb[7] = 12;
1054 desc[0] = 0x00;
1055 desc[1] = 10;
1057 desc[2] |= 0x80; /* valid */
1058 desc[6] = block >> 40;
1059 desc[7] = block >> 32;
1060 desc[8] = block >> 24;
1061 desc[9] = block >> 16;
1062 desc[10] = block >> 8;
1063 desc[11] = block;
1066 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1068 sdev->use_10_for_rw = 1;
1069 sdev->use_10_for_ms = 1;
1071 /* Schedule policy is determined by ->qc_defer() callback and
1072 * it needs to see every deferred qc. Set dev_blocked to 1 to
1073 * prevent SCSI midlayer from automatically deferring
1074 * requests.
1076 sdev->max_device_blocked = 1;
1080 * atapi_drain_needed - Check whether data transfer may overflow
1081 * @rq: request to be checked
1083 * ATAPI commands which transfer variable length data to host
1084 * might overflow due to application error or hardare bug. This
1085 * function checks whether overflow should be drained and ignored
1086 * for @request.
1088 * LOCKING:
1089 * None.
1091 * RETURNS:
1092 * 1 if ; otherwise, 0.
1094 static int atapi_drain_needed(struct request *rq)
1096 if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
1097 return 0;
1099 if (!blk_rq_bytes(rq) || (rq->cmd_flags & REQ_WRITE))
1100 return 0;
1102 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1105 static int ata_scsi_dev_config(struct scsi_device *sdev,
1106 struct ata_device *dev)
1108 if (!ata_id_has_unload(dev->id))
1109 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1111 /* configure max sectors */
1112 blk_queue_max_hw_sectors(sdev->request_queue, dev->max_sectors);
1114 if (dev->class == ATA_DEV_ATAPI) {
1115 struct request_queue *q = sdev->request_queue;
1116 void *buf;
1118 /* set the min alignment and padding */
1119 blk_queue_update_dma_alignment(sdev->request_queue,
1120 ATA_DMA_PAD_SZ - 1);
1121 blk_queue_update_dma_pad(sdev->request_queue,
1122 ATA_DMA_PAD_SZ - 1);
1124 /* configure draining */
1125 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1126 if (!buf) {
1127 ata_dev_printk(dev, KERN_ERR,
1128 "drain buffer allocation failed\n");
1129 return -ENOMEM;
1132 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1133 } else {
1134 /* ATA devices must be sector aligned */
1135 blk_queue_update_dma_alignment(sdev->request_queue,
1136 ATA_SECT_SIZE - 1);
1137 sdev->manage_start_stop = 1;
1140 if (dev->flags & ATA_DFLAG_AN)
1141 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1143 if (dev->flags & ATA_DFLAG_NCQ) {
1144 int depth;
1146 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1147 depth = min(ATA_MAX_QUEUE - 1, depth);
1148 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1151 return 0;
1155 * ata_scsi_slave_config - Set SCSI device attributes
1156 * @sdev: SCSI device to examine
1158 * This is called before we actually start reading
1159 * and writing to the device, to configure certain
1160 * SCSI mid-layer behaviors.
1162 * LOCKING:
1163 * Defined by SCSI layer. We don't really care.
1166 int ata_scsi_slave_config(struct scsi_device *sdev)
1168 struct ata_port *ap = ata_shost_to_port(sdev->host);
1169 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1170 int rc = 0;
1172 ata_scsi_sdev_config(sdev);
1174 if (dev)
1175 rc = ata_scsi_dev_config(sdev, dev);
1177 return rc;
1181 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1182 * @sdev: SCSI device to be destroyed
1184 * @sdev is about to be destroyed for hot/warm unplugging. If
1185 * this unplugging was initiated by libata as indicated by NULL
1186 * dev->sdev, this function doesn't have to do anything.
1187 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1188 * Clear dev->sdev, schedule the device for ATA detach and invoke
1189 * EH.
1191 * LOCKING:
1192 * Defined by SCSI layer. We don't really care.
1194 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1196 struct ata_port *ap = ata_shost_to_port(sdev->host);
1197 struct request_queue *q = sdev->request_queue;
1198 unsigned long flags;
1199 struct ata_device *dev;
1201 if (!ap->ops->error_handler)
1202 return;
1204 spin_lock_irqsave(ap->lock, flags);
1205 dev = __ata_scsi_find_dev(ap, sdev);
1206 if (dev && dev->sdev) {
1207 /* SCSI device already in CANCEL state, no need to offline it */
1208 dev->sdev = NULL;
1209 dev->flags |= ATA_DFLAG_DETACH;
1210 ata_port_schedule_eh(ap);
1212 spin_unlock_irqrestore(ap->lock, flags);
1214 kfree(q->dma_drain_buffer);
1215 q->dma_drain_buffer = NULL;
1216 q->dma_drain_size = 0;
1220 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1221 * @sdev: SCSI device to configure queue depth for
1222 * @queue_depth: new queue depth
1223 * @reason: calling context
1225 * This is libata standard hostt->change_queue_depth callback.
1226 * SCSI will call into this callback when user tries to set queue
1227 * depth via sysfs.
1229 * LOCKING:
1230 * SCSI layer (we don't care)
1232 * RETURNS:
1233 * Newly configured queue depth.
1235 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth,
1236 int reason)
1238 struct ata_port *ap = ata_shost_to_port(sdev->host);
1239 struct ata_device *dev;
1240 unsigned long flags;
1242 if (reason != SCSI_QDEPTH_DEFAULT)
1243 return -EOPNOTSUPP;
1245 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1246 return sdev->queue_depth;
1248 dev = ata_scsi_find_dev(ap, sdev);
1249 if (!dev || !ata_dev_enabled(dev))
1250 return sdev->queue_depth;
1252 /* NCQ enabled? */
1253 spin_lock_irqsave(ap->lock, flags);
1254 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1255 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1256 dev->flags |= ATA_DFLAG_NCQ_OFF;
1257 queue_depth = 1;
1259 spin_unlock_irqrestore(ap->lock, flags);
1261 /* limit and apply queue depth */
1262 queue_depth = min(queue_depth, sdev->host->can_queue);
1263 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1264 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1266 if (sdev->queue_depth == queue_depth)
1267 return -EINVAL;
1269 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1270 return queue_depth;
1274 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1275 * @qc: Storage for translated ATA taskfile
1277 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1278 * (to start). Perhaps these commands should be preceded by
1279 * CHECK POWER MODE to see what power mode the device is already in.
1280 * [See SAT revision 5 at www.t10.org]
1282 * LOCKING:
1283 * spin_lock_irqsave(host lock)
1285 * RETURNS:
1286 * Zero on success, non-zero on error.
1288 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1290 struct scsi_cmnd *scmd = qc->scsicmd;
1291 struct ata_taskfile *tf = &qc->tf;
1292 const u8 *cdb = scmd->cmnd;
1294 if (scmd->cmd_len < 5)
1295 goto invalid_fld;
1297 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1298 tf->protocol = ATA_PROT_NODATA;
1299 if (cdb[1] & 0x1) {
1300 ; /* ignore IMMED bit, violates sat-r05 */
1302 if (cdb[4] & 0x2)
1303 goto invalid_fld; /* LOEJ bit set not supported */
1304 if (((cdb[4] >> 4) & 0xf) != 0)
1305 goto invalid_fld; /* power conditions not supported */
1307 if (cdb[4] & 0x1) {
1308 tf->nsect = 1; /* 1 sector, lba=0 */
1310 if (qc->dev->flags & ATA_DFLAG_LBA) {
1311 tf->flags |= ATA_TFLAG_LBA;
1313 tf->lbah = 0x0;
1314 tf->lbam = 0x0;
1315 tf->lbal = 0x0;
1316 tf->device |= ATA_LBA;
1317 } else {
1318 /* CHS */
1319 tf->lbal = 0x1; /* sect */
1320 tf->lbam = 0x0; /* cyl low */
1321 tf->lbah = 0x0; /* cyl high */
1324 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1325 } else {
1326 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1327 * or S5) causing some drives to spin up and down again.
1329 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1330 system_state == SYSTEM_POWER_OFF)
1331 goto skip;
1333 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1334 system_entering_hibernation())
1335 goto skip;
1337 /* Issue ATA STANDBY IMMEDIATE command */
1338 tf->command = ATA_CMD_STANDBYNOW1;
1342 * Standby and Idle condition timers could be implemented but that
1343 * would require libata to implement the Power condition mode page
1344 * and allow the user to change it. Changing mode pages requires
1345 * MODE SELECT to be implemented.
1348 return 0;
1350 invalid_fld:
1351 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1352 /* "Invalid field in cbd" */
1353 return 1;
1354 skip:
1355 scmd->result = SAM_STAT_GOOD;
1356 return 1;
1361 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1362 * @qc: Storage for translated ATA taskfile
1364 * Sets up an ATA taskfile to issue FLUSH CACHE or
1365 * FLUSH CACHE EXT.
1367 * LOCKING:
1368 * spin_lock_irqsave(host lock)
1370 * RETURNS:
1371 * Zero on success, non-zero on error.
1373 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1375 struct ata_taskfile *tf = &qc->tf;
1377 tf->flags |= ATA_TFLAG_DEVICE;
1378 tf->protocol = ATA_PROT_NODATA;
1380 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1381 tf->command = ATA_CMD_FLUSH_EXT;
1382 else
1383 tf->command = ATA_CMD_FLUSH;
1385 /* flush is critical for IO integrity, consider it an IO command */
1386 qc->flags |= ATA_QCFLAG_IO;
1388 return 0;
1392 * scsi_6_lba_len - Get LBA and transfer length
1393 * @cdb: SCSI command to translate
1395 * Calculate LBA and transfer length for 6-byte commands.
1397 * RETURNS:
1398 * @plba: the LBA
1399 * @plen: the transfer length
1401 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1403 u64 lba = 0;
1404 u32 len;
1406 VPRINTK("six-byte command\n");
1408 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1409 lba |= ((u64)cdb[2]) << 8;
1410 lba |= ((u64)cdb[3]);
1412 len = cdb[4];
1414 *plba = lba;
1415 *plen = len;
1419 * scsi_10_lba_len - Get LBA and transfer length
1420 * @cdb: SCSI command to translate
1422 * Calculate LBA and transfer length for 10-byte commands.
1424 * RETURNS:
1425 * @plba: the LBA
1426 * @plen: the transfer length
1428 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1430 u64 lba = 0;
1431 u32 len = 0;
1433 VPRINTK("ten-byte command\n");
1435 lba |= ((u64)cdb[2]) << 24;
1436 lba |= ((u64)cdb[3]) << 16;
1437 lba |= ((u64)cdb[4]) << 8;
1438 lba |= ((u64)cdb[5]);
1440 len |= ((u32)cdb[7]) << 8;
1441 len |= ((u32)cdb[8]);
1443 *plba = lba;
1444 *plen = len;
1448 * scsi_16_lba_len - Get LBA and transfer length
1449 * @cdb: SCSI command to translate
1451 * Calculate LBA and transfer length for 16-byte commands.
1453 * RETURNS:
1454 * @plba: the LBA
1455 * @plen: the transfer length
1457 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1459 u64 lba = 0;
1460 u32 len = 0;
1462 VPRINTK("sixteen-byte command\n");
1464 lba |= ((u64)cdb[2]) << 56;
1465 lba |= ((u64)cdb[3]) << 48;
1466 lba |= ((u64)cdb[4]) << 40;
1467 lba |= ((u64)cdb[5]) << 32;
1468 lba |= ((u64)cdb[6]) << 24;
1469 lba |= ((u64)cdb[7]) << 16;
1470 lba |= ((u64)cdb[8]) << 8;
1471 lba |= ((u64)cdb[9]);
1473 len |= ((u32)cdb[10]) << 24;
1474 len |= ((u32)cdb[11]) << 16;
1475 len |= ((u32)cdb[12]) << 8;
1476 len |= ((u32)cdb[13]);
1478 *plba = lba;
1479 *plen = len;
1483 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1484 * @qc: Storage for translated ATA taskfile
1486 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1488 * LOCKING:
1489 * spin_lock_irqsave(host lock)
1491 * RETURNS:
1492 * Zero on success, non-zero on error.
1494 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1496 struct scsi_cmnd *scmd = qc->scsicmd;
1497 struct ata_taskfile *tf = &qc->tf;
1498 struct ata_device *dev = qc->dev;
1499 u64 dev_sectors = qc->dev->n_sectors;
1500 const u8 *cdb = scmd->cmnd;
1501 u64 block;
1502 u32 n_block;
1504 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1505 tf->protocol = ATA_PROT_NODATA;
1507 if (cdb[0] == VERIFY) {
1508 if (scmd->cmd_len < 10)
1509 goto invalid_fld;
1510 scsi_10_lba_len(cdb, &block, &n_block);
1511 } else if (cdb[0] == VERIFY_16) {
1512 if (scmd->cmd_len < 16)
1513 goto invalid_fld;
1514 scsi_16_lba_len(cdb, &block, &n_block);
1515 } else
1516 goto invalid_fld;
1518 if (!n_block)
1519 goto nothing_to_do;
1520 if (block >= dev_sectors)
1521 goto out_of_range;
1522 if ((block + n_block) > dev_sectors)
1523 goto out_of_range;
1525 if (dev->flags & ATA_DFLAG_LBA) {
1526 tf->flags |= ATA_TFLAG_LBA;
1528 if (lba_28_ok(block, n_block)) {
1529 /* use LBA28 */
1530 tf->command = ATA_CMD_VERIFY;
1531 tf->device |= (block >> 24) & 0xf;
1532 } else if (lba_48_ok(block, n_block)) {
1533 if (!(dev->flags & ATA_DFLAG_LBA48))
1534 goto out_of_range;
1536 /* use LBA48 */
1537 tf->flags |= ATA_TFLAG_LBA48;
1538 tf->command = ATA_CMD_VERIFY_EXT;
1540 tf->hob_nsect = (n_block >> 8) & 0xff;
1542 tf->hob_lbah = (block >> 40) & 0xff;
1543 tf->hob_lbam = (block >> 32) & 0xff;
1544 tf->hob_lbal = (block >> 24) & 0xff;
1545 } else
1546 /* request too large even for LBA48 */
1547 goto out_of_range;
1549 tf->nsect = n_block & 0xff;
1551 tf->lbah = (block >> 16) & 0xff;
1552 tf->lbam = (block >> 8) & 0xff;
1553 tf->lbal = block & 0xff;
1555 tf->device |= ATA_LBA;
1556 } else {
1557 /* CHS */
1558 u32 sect, head, cyl, track;
1560 if (!lba_28_ok(block, n_block))
1561 goto out_of_range;
1563 /* Convert LBA to CHS */
1564 track = (u32)block / dev->sectors;
1565 cyl = track / dev->heads;
1566 head = track % dev->heads;
1567 sect = (u32)block % dev->sectors + 1;
1569 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1570 (u32)block, track, cyl, head, sect);
1572 /* Check whether the converted CHS can fit.
1573 Cylinder: 0-65535
1574 Head: 0-15
1575 Sector: 1-255*/
1576 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1577 goto out_of_range;
1579 tf->command = ATA_CMD_VERIFY;
1580 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1581 tf->lbal = sect;
1582 tf->lbam = cyl;
1583 tf->lbah = cyl >> 8;
1584 tf->device |= head;
1587 return 0;
1589 invalid_fld:
1590 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1591 /* "Invalid field in cbd" */
1592 return 1;
1594 out_of_range:
1595 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1596 /* "Logical Block Address out of range" */
1597 return 1;
1599 nothing_to_do:
1600 scmd->result = SAM_STAT_GOOD;
1601 return 1;
1605 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1606 * @qc: Storage for translated ATA taskfile
1608 * Converts any of six SCSI read/write commands into the
1609 * ATA counterpart, including starting sector (LBA),
1610 * sector count, and taking into account the device's LBA48
1611 * support.
1613 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1614 * %WRITE_16 are currently supported.
1616 * LOCKING:
1617 * spin_lock_irqsave(host lock)
1619 * RETURNS:
1620 * Zero on success, non-zero on error.
1622 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1624 struct scsi_cmnd *scmd = qc->scsicmd;
1625 const u8 *cdb = scmd->cmnd;
1626 unsigned int tf_flags = 0;
1627 u64 block;
1628 u32 n_block;
1629 int rc;
1631 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1632 tf_flags |= ATA_TFLAG_WRITE;
1634 /* Calculate the SCSI LBA, transfer length and FUA. */
1635 switch (cdb[0]) {
1636 case READ_10:
1637 case WRITE_10:
1638 if (unlikely(scmd->cmd_len < 10))
1639 goto invalid_fld;
1640 scsi_10_lba_len(cdb, &block, &n_block);
1641 if (unlikely(cdb[1] & (1 << 3)))
1642 tf_flags |= ATA_TFLAG_FUA;
1643 break;
1644 case READ_6:
1645 case WRITE_6:
1646 if (unlikely(scmd->cmd_len < 6))
1647 goto invalid_fld;
1648 scsi_6_lba_len(cdb, &block, &n_block);
1650 /* for 6-byte r/w commands, transfer length 0
1651 * means 256 blocks of data, not 0 block.
1653 if (!n_block)
1654 n_block = 256;
1655 break;
1656 case READ_16:
1657 case WRITE_16:
1658 if (unlikely(scmd->cmd_len < 16))
1659 goto invalid_fld;
1660 scsi_16_lba_len(cdb, &block, &n_block);
1661 if (unlikely(cdb[1] & (1 << 3)))
1662 tf_flags |= ATA_TFLAG_FUA;
1663 break;
1664 default:
1665 DPRINTK("no-byte command\n");
1666 goto invalid_fld;
1669 /* Check and compose ATA command */
1670 if (!n_block)
1671 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1672 * length 0 means transfer 0 block of data.
1673 * However, for ATA R/W commands, sector count 0 means
1674 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1676 * WARNING: one or two older ATA drives treat 0 as 0...
1678 goto nothing_to_do;
1680 qc->flags |= ATA_QCFLAG_IO;
1681 qc->nbytes = n_block * ATA_SECT_SIZE;
1683 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1684 qc->tag);
1685 if (likely(rc == 0))
1686 return 0;
1688 if (rc == -ERANGE)
1689 goto out_of_range;
1690 /* treat all other errors as -EINVAL, fall through */
1691 invalid_fld:
1692 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1693 /* "Invalid field in cbd" */
1694 return 1;
1696 out_of_range:
1697 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1698 /* "Logical Block Address out of range" */
1699 return 1;
1701 nothing_to_do:
1702 scmd->result = SAM_STAT_GOOD;
1703 return 1;
1706 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1708 struct ata_port *ap = qc->ap;
1709 struct scsi_cmnd *cmd = qc->scsicmd;
1710 u8 *cdb = cmd->cmnd;
1711 int need_sense = (qc->err_mask != 0);
1713 /* For ATA pass thru (SAT) commands, generate a sense block if
1714 * user mandated it or if there's an error. Note that if we
1715 * generate because the user forced us to, a check condition
1716 * is generated and the ATA register values are returned
1717 * whether the command completed successfully or not. If there
1718 * was no error, SK, ASC and ASCQ will all be zero.
1720 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1721 ((cdb[2] & 0x20) || need_sense)) {
1722 ata_gen_passthru_sense(qc);
1723 } else {
1724 if (!need_sense) {
1725 cmd->result = SAM_STAT_GOOD;
1726 } else {
1727 /* TODO: decide which descriptor format to use
1728 * for 48b LBA devices and call that here
1729 * instead of the fixed desc, which is only
1730 * good for smaller LBA (and maybe CHS?)
1731 * devices.
1733 ata_gen_ata_sense(qc);
1737 if (need_sense && !ap->ops->error_handler)
1738 ata_dump_status(ap->print_id, &qc->result_tf);
1740 qc->scsidone(cmd);
1742 ata_qc_free(qc);
1746 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1747 * @dev: ATA device to which the command is addressed
1748 * @cmd: SCSI command to execute
1749 * @done: SCSI command completion function
1750 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1752 * Our ->queuecommand() function has decided that the SCSI
1753 * command issued can be directly translated into an ATA
1754 * command, rather than handled internally.
1756 * This function sets up an ata_queued_cmd structure for the
1757 * SCSI command, and sends that ata_queued_cmd to the hardware.
1759 * The xlat_func argument (actor) returns 0 if ready to execute
1760 * ATA command, else 1 to finish translation. If 1 is returned
1761 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1762 * to be set reflecting an error condition or clean (early)
1763 * termination.
1765 * LOCKING:
1766 * spin_lock_irqsave(host lock)
1768 * RETURNS:
1769 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1770 * needs to be deferred.
1772 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1773 void (*done)(struct scsi_cmnd *),
1774 ata_xlat_func_t xlat_func)
1776 struct ata_port *ap = dev->link->ap;
1777 struct ata_queued_cmd *qc;
1778 int rc;
1780 VPRINTK("ENTER\n");
1782 qc = ata_scsi_qc_new(dev, cmd, done);
1783 if (!qc)
1784 goto err_mem;
1786 /* data is present; dma-map it */
1787 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1788 cmd->sc_data_direction == DMA_TO_DEVICE) {
1789 if (unlikely(scsi_bufflen(cmd) < 1)) {
1790 ata_dev_printk(dev, KERN_WARNING,
1791 "WARNING: zero len r/w req\n");
1792 goto err_did;
1795 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1797 qc->dma_dir = cmd->sc_data_direction;
1800 qc->complete_fn = ata_scsi_qc_complete;
1802 if (xlat_func(qc))
1803 goto early_finish;
1805 if (ap->ops->qc_defer) {
1806 if ((rc = ap->ops->qc_defer(qc)))
1807 goto defer;
1810 /* select device, send command to hardware */
1811 ata_qc_issue(qc);
1813 VPRINTK("EXIT\n");
1814 return 0;
1816 early_finish:
1817 ata_qc_free(qc);
1818 qc->scsidone(cmd);
1819 DPRINTK("EXIT - early finish (good or error)\n");
1820 return 0;
1822 err_did:
1823 ata_qc_free(qc);
1824 cmd->result = (DID_ERROR << 16);
1825 qc->scsidone(cmd);
1826 err_mem:
1827 DPRINTK("EXIT - internal\n");
1828 return 0;
1830 defer:
1831 ata_qc_free(qc);
1832 DPRINTK("EXIT - defer\n");
1833 if (rc == ATA_DEFER_LINK)
1834 return SCSI_MLQUEUE_DEVICE_BUSY;
1835 else
1836 return SCSI_MLQUEUE_HOST_BUSY;
1840 * ata_scsi_rbuf_get - Map response buffer.
1841 * @cmd: SCSI command containing buffer to be mapped.
1842 * @flags: unsigned long variable to store irq enable status
1843 * @copy_in: copy in from user buffer
1845 * Prepare buffer for simulated SCSI commands.
1847 * LOCKING:
1848 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1850 * RETURNS:
1851 * Pointer to response buffer.
1853 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1854 unsigned long *flags)
1856 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1858 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1859 if (copy_in)
1860 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1861 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1862 return ata_scsi_rbuf;
1866 * ata_scsi_rbuf_put - Unmap response buffer.
1867 * @cmd: SCSI command containing buffer to be unmapped.
1868 * @copy_out: copy out result
1869 * @flags: @flags passed to ata_scsi_rbuf_get()
1871 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1872 * @copy_back is true.
1874 * LOCKING:
1875 * Unlocks ata_scsi_rbuf_lock.
1877 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1878 unsigned long *flags)
1880 if (copy_out)
1881 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1882 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1883 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1887 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1888 * @args: device IDENTIFY data / SCSI command of interest.
1889 * @actor: Callback hook for desired SCSI command simulator
1891 * Takes care of the hard work of simulating a SCSI command...
1892 * Mapping the response buffer, calling the command's handler,
1893 * and handling the handler's return value. This return value
1894 * indicates whether the handler wishes the SCSI command to be
1895 * completed successfully (0), or not (in which case cmd->result
1896 * and sense buffer are assumed to be set).
1898 * LOCKING:
1899 * spin_lock_irqsave(host lock)
1901 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1902 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1904 u8 *rbuf;
1905 unsigned int rc;
1906 struct scsi_cmnd *cmd = args->cmd;
1907 unsigned long flags;
1909 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1910 rc = actor(args, rbuf);
1911 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1913 if (rc == 0)
1914 cmd->result = SAM_STAT_GOOD;
1915 args->done(cmd);
1919 * ata_scsiop_inq_std - Simulate INQUIRY command
1920 * @args: device IDENTIFY data / SCSI command of interest.
1921 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1923 * Returns standard device identification data associated
1924 * with non-VPD INQUIRY command output.
1926 * LOCKING:
1927 * spin_lock_irqsave(host lock)
1929 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1931 const u8 versions[] = {
1932 0x60, /* SAM-3 (no version claimed) */
1934 0x03,
1935 0x20, /* SBC-2 (no version claimed) */
1937 0x02,
1938 0x60 /* SPC-3 (no version claimed) */
1940 u8 hdr[] = {
1941 TYPE_DISK,
1943 0x5, /* claim SPC-3 version compatibility */
1945 95 - 4
1948 VPRINTK("ENTER\n");
1950 /* set scsi removeable (RMB) bit per ata bit */
1951 if (ata_id_removeable(args->id))
1952 hdr[1] |= (1 << 7);
1954 memcpy(rbuf, hdr, sizeof(hdr));
1955 memcpy(&rbuf[8], "ATA ", 8);
1956 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1957 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1959 if (rbuf[32] == 0 || rbuf[32] == ' ')
1960 memcpy(&rbuf[32], "n/a ", 4);
1962 memcpy(rbuf + 59, versions, sizeof(versions));
1964 return 0;
1968 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1969 * @args: device IDENTIFY data / SCSI command of interest.
1970 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1972 * Returns list of inquiry VPD pages available.
1974 * LOCKING:
1975 * spin_lock_irqsave(host lock)
1977 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1979 const u8 pages[] = {
1980 0x00, /* page 0x00, this page */
1981 0x80, /* page 0x80, unit serial no page */
1982 0x83, /* page 0x83, device ident page */
1983 0x89, /* page 0x89, ata info page */
1984 0xb0, /* page 0xb0, block limits page */
1985 0xb1, /* page 0xb1, block device characteristics page */
1988 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1989 memcpy(rbuf + 4, pages, sizeof(pages));
1990 return 0;
1994 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1995 * @args: device IDENTIFY data / SCSI command of interest.
1996 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1998 * Returns ATA device serial number.
2000 * LOCKING:
2001 * spin_lock_irqsave(host lock)
2003 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2005 const u8 hdr[] = {
2007 0x80, /* this page code */
2009 ATA_ID_SERNO_LEN, /* page len */
2012 memcpy(rbuf, hdr, sizeof(hdr));
2013 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2014 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2015 return 0;
2019 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2020 * @args: device IDENTIFY data / SCSI command of interest.
2021 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2023 * Yields two logical unit device identification designators:
2024 * - vendor specific ASCII containing the ATA serial number
2025 * - SAT defined "t10 vendor id based" containing ASCII vendor
2026 * name ("ATA "), model and serial numbers.
2028 * LOCKING:
2029 * spin_lock_irqsave(host lock)
2031 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2033 const int sat_model_serial_desc_len = 68;
2034 int num;
2036 rbuf[1] = 0x83; /* this page code */
2037 num = 4;
2039 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2040 rbuf[num + 0] = 2;
2041 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2042 num += 4;
2043 ata_id_string(args->id, (unsigned char *) rbuf + num,
2044 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2045 num += ATA_ID_SERNO_LEN;
2047 /* SAT defined lu model and serial numbers descriptor */
2048 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2049 rbuf[num + 0] = 2;
2050 rbuf[num + 1] = 1;
2051 rbuf[num + 3] = sat_model_serial_desc_len;
2052 num += 4;
2053 memcpy(rbuf + num, "ATA ", 8);
2054 num += 8;
2055 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2056 ATA_ID_PROD_LEN);
2057 num += ATA_ID_PROD_LEN;
2058 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2059 ATA_ID_SERNO_LEN);
2060 num += ATA_ID_SERNO_LEN;
2062 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2063 return 0;
2067 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2068 * @args: device IDENTIFY data / SCSI command of interest.
2069 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2071 * Yields SAT-specified ATA VPD page.
2073 * LOCKING:
2074 * spin_lock_irqsave(host lock)
2076 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2078 struct ata_taskfile tf;
2080 memset(&tf, 0, sizeof(tf));
2082 rbuf[1] = 0x89; /* our page code */
2083 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2084 rbuf[3] = (0x238 & 0xff);
2086 memcpy(&rbuf[8], "linux ", 8);
2087 memcpy(&rbuf[16], "libata ", 16);
2088 memcpy(&rbuf[32], DRV_VERSION, 4);
2089 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2091 /* we don't store the ATA device signature, so we fake it */
2093 tf.command = ATA_DRDY; /* really, this is Status reg */
2094 tf.lbal = 0x1;
2095 tf.nsect = 0x1;
2097 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2098 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2100 rbuf[56] = ATA_CMD_ID_ATA;
2102 memcpy(&rbuf[60], &args->id[0], 512);
2103 return 0;
2106 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2108 u32 min_io_sectors;
2110 rbuf[1] = 0xb0;
2111 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2114 * Optimal transfer length granularity.
2116 * This is always one physical block, but for disks with a smaller
2117 * logical than physical sector size we need to figure out what the
2118 * latter is.
2120 if (ata_id_has_large_logical_sectors(args->id))
2121 min_io_sectors = ata_id_logical_per_physical_sectors(args->id);
2122 else
2123 min_io_sectors = 1;
2124 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2127 * Optimal unmap granularity.
2129 * The ATA spec doesn't even know about a granularity or alignment
2130 * for the TRIM command. We can leave away most of the unmap related
2131 * VPD page entries, but we have specifify a granularity to signal
2132 * that we support some form of unmap - in thise case via WRITE SAME
2133 * with the unmap bit set.
2135 if (ata_id_has_trim(args->id)) {
2136 put_unaligned_be32(65535 * 512 / 8, &rbuf[20]);
2137 put_unaligned_be32(1, &rbuf[28]);
2140 return 0;
2143 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2145 int form_factor = ata_id_form_factor(args->id);
2146 int media_rotation_rate = ata_id_rotation_rate(args->id);
2148 rbuf[1] = 0xb1;
2149 rbuf[3] = 0x3c;
2150 rbuf[4] = media_rotation_rate >> 8;
2151 rbuf[5] = media_rotation_rate;
2152 rbuf[7] = form_factor;
2154 return 0;
2158 * ata_scsiop_noop - Command handler that simply returns success.
2159 * @args: device IDENTIFY data / SCSI command of interest.
2160 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2162 * No operation. Simply returns success to caller, to indicate
2163 * that the caller should successfully complete this SCSI command.
2165 * LOCKING:
2166 * spin_lock_irqsave(host lock)
2168 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2170 VPRINTK("ENTER\n");
2171 return 0;
2175 * ata_msense_caching - Simulate MODE SENSE caching info page
2176 * @id: device IDENTIFY data
2177 * @buf: output buffer
2179 * Generate a caching info page, which conditionally indicates
2180 * write caching to the SCSI layer, depending on device
2181 * capabilities.
2183 * LOCKING:
2184 * None.
2186 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2188 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2189 if (ata_id_wcache_enabled(id))
2190 buf[2] |= (1 << 2); /* write cache enable */
2191 if (!ata_id_rahead_enabled(id))
2192 buf[12] |= (1 << 5); /* disable read ahead */
2193 return sizeof(def_cache_mpage);
2197 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2198 * @buf: output buffer
2200 * Generate a generic MODE SENSE control mode page.
2202 * LOCKING:
2203 * None.
2205 static unsigned int ata_msense_ctl_mode(u8 *buf)
2207 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2208 return sizeof(def_control_mpage);
2212 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2213 * @buf: output buffer
2215 * Generate a generic MODE SENSE r/w error recovery page.
2217 * LOCKING:
2218 * None.
2220 static unsigned int ata_msense_rw_recovery(u8 *buf)
2222 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2223 return sizeof(def_rw_recovery_mpage);
2227 * We can turn this into a real blacklist if it's needed, for now just
2228 * blacklist any Maxtor BANC1G10 revision firmware
2230 static int ata_dev_supports_fua(u16 *id)
2232 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2234 if (!libata_fua)
2235 return 0;
2236 if (!ata_id_has_fua(id))
2237 return 0;
2239 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2240 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2242 if (strcmp(model, "Maxtor"))
2243 return 1;
2244 if (strcmp(fw, "BANC1G10"))
2245 return 1;
2247 return 0; /* blacklisted */
2251 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2252 * @args: device IDENTIFY data / SCSI command of interest.
2253 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2255 * Simulate MODE SENSE commands. Assume this is invoked for direct
2256 * access devices (e.g. disks) only. There should be no block
2257 * descriptor for other device types.
2259 * LOCKING:
2260 * spin_lock_irqsave(host lock)
2262 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2264 struct ata_device *dev = args->dev;
2265 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2266 const u8 sat_blk_desc[] = {
2267 0, 0, 0, 0, /* number of blocks: sat unspecified */
2269 0, 0x2, 0x0 /* block length: 512 bytes */
2271 u8 pg, spg;
2272 unsigned int ebd, page_control, six_byte;
2273 u8 dpofua;
2275 VPRINTK("ENTER\n");
2277 six_byte = (scsicmd[0] == MODE_SENSE);
2278 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2280 * LLBA bit in msense(10) ignored (compliant)
2283 page_control = scsicmd[2] >> 6;
2284 switch (page_control) {
2285 case 0: /* current */
2286 break; /* supported */
2287 case 3: /* saved */
2288 goto saving_not_supp;
2289 case 1: /* changeable */
2290 case 2: /* defaults */
2291 default:
2292 goto invalid_fld;
2295 if (six_byte)
2296 p += 4 + (ebd ? 8 : 0);
2297 else
2298 p += 8 + (ebd ? 8 : 0);
2300 pg = scsicmd[2] & 0x3f;
2301 spg = scsicmd[3];
2303 * No mode subpages supported (yet) but asking for _all_
2304 * subpages may be valid
2306 if (spg && (spg != ALL_SUB_MPAGES))
2307 goto invalid_fld;
2309 switch(pg) {
2310 case RW_RECOVERY_MPAGE:
2311 p += ata_msense_rw_recovery(p);
2312 break;
2314 case CACHE_MPAGE:
2315 p += ata_msense_caching(args->id, p);
2316 break;
2318 case CONTROL_MPAGE:
2319 p += ata_msense_ctl_mode(p);
2320 break;
2322 case ALL_MPAGES:
2323 p += ata_msense_rw_recovery(p);
2324 p += ata_msense_caching(args->id, p);
2325 p += ata_msense_ctl_mode(p);
2326 break;
2328 default: /* invalid page code */
2329 goto invalid_fld;
2332 dpofua = 0;
2333 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2334 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2335 dpofua = 1 << 4;
2337 if (six_byte) {
2338 rbuf[0] = p - rbuf - 1;
2339 rbuf[2] |= dpofua;
2340 if (ebd) {
2341 rbuf[3] = sizeof(sat_blk_desc);
2342 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2344 } else {
2345 unsigned int output_len = p - rbuf - 2;
2347 rbuf[0] = output_len >> 8;
2348 rbuf[1] = output_len;
2349 rbuf[3] |= dpofua;
2350 if (ebd) {
2351 rbuf[7] = sizeof(sat_blk_desc);
2352 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2355 return 0;
2357 invalid_fld:
2358 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2359 /* "Invalid field in cbd" */
2360 return 1;
2362 saving_not_supp:
2363 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2364 /* "Saving parameters not supported" */
2365 return 1;
2369 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2370 * @args: device IDENTIFY data / SCSI command of interest.
2371 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2373 * Simulate READ CAPACITY commands.
2375 * LOCKING:
2376 * None.
2378 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2380 struct ata_device *dev = args->dev;
2381 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2382 u8 log_per_phys = 0;
2383 u16 lowest_aligned = 0;
2384 u16 word_106 = dev->id[106];
2385 u16 word_209 = dev->id[209];
2387 if ((word_106 & 0xc000) == 0x4000) {
2388 /* Number and offset of logical sectors per physical sector */
2389 if (word_106 & (1 << 13))
2390 log_per_phys = word_106 & 0xf;
2391 if ((word_209 & 0xc000) == 0x4000) {
2392 u16 first = dev->id[209] & 0x3fff;
2393 if (first > 0)
2394 lowest_aligned = (1 << log_per_phys) - first;
2398 VPRINTK("ENTER\n");
2400 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2401 if (last_lba >= 0xffffffffULL)
2402 last_lba = 0xffffffff;
2404 /* sector count, 32-bit */
2405 rbuf[0] = last_lba >> (8 * 3);
2406 rbuf[1] = last_lba >> (8 * 2);
2407 rbuf[2] = last_lba >> (8 * 1);
2408 rbuf[3] = last_lba;
2410 /* sector size */
2411 rbuf[6] = ATA_SECT_SIZE >> 8;
2412 rbuf[7] = ATA_SECT_SIZE & 0xff;
2413 } else {
2414 /* sector count, 64-bit */
2415 rbuf[0] = last_lba >> (8 * 7);
2416 rbuf[1] = last_lba >> (8 * 6);
2417 rbuf[2] = last_lba >> (8 * 5);
2418 rbuf[3] = last_lba >> (8 * 4);
2419 rbuf[4] = last_lba >> (8 * 3);
2420 rbuf[5] = last_lba >> (8 * 2);
2421 rbuf[6] = last_lba >> (8 * 1);
2422 rbuf[7] = last_lba;
2424 /* sector size */
2425 rbuf[10] = ATA_SECT_SIZE >> 8;
2426 rbuf[11] = ATA_SECT_SIZE & 0xff;
2428 rbuf[12] = 0;
2429 rbuf[13] = log_per_phys;
2430 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2431 rbuf[15] = lowest_aligned;
2433 if (ata_id_has_trim(args->id)) {
2434 rbuf[14] |= 0x80; /* TPE */
2436 if (ata_id_has_zero_after_trim(args->id))
2437 rbuf[14] |= 0x40; /* TPRZ */
2441 return 0;
2445 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2446 * @args: device IDENTIFY data / SCSI command of interest.
2447 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2449 * Simulate REPORT LUNS command.
2451 * LOCKING:
2452 * spin_lock_irqsave(host lock)
2454 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2456 VPRINTK("ENTER\n");
2457 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2459 return 0;
2462 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2464 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2465 ata_gen_passthru_sense(qc);
2468 qc->scsidone(qc->scsicmd);
2469 ata_qc_free(qc);
2472 /* is it pointless to prefer PIO for "safety reasons"? */
2473 static inline int ata_pio_use_silly(struct ata_port *ap)
2475 return (ap->flags & ATA_FLAG_PIO_DMA);
2478 static void atapi_request_sense(struct ata_queued_cmd *qc)
2480 struct ata_port *ap = qc->ap;
2481 struct scsi_cmnd *cmd = qc->scsicmd;
2483 DPRINTK("ATAPI request sense\n");
2485 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2487 #ifdef CONFIG_ATA_SFF
2488 if (ap->ops->sff_tf_read)
2489 ap->ops->sff_tf_read(ap, &qc->tf);
2490 #endif
2492 /* fill these in, for the case where they are -not- overwritten */
2493 cmd->sense_buffer[0] = 0x70;
2494 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2496 ata_qc_reinit(qc);
2498 /* setup sg table and init transfer direction */
2499 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2500 ata_sg_init(qc, &qc->sgent, 1);
2501 qc->dma_dir = DMA_FROM_DEVICE;
2503 memset(&qc->cdb, 0, qc->dev->cdb_len);
2504 qc->cdb[0] = REQUEST_SENSE;
2505 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2507 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2508 qc->tf.command = ATA_CMD_PACKET;
2510 if (ata_pio_use_silly(ap)) {
2511 qc->tf.protocol = ATAPI_PROT_DMA;
2512 qc->tf.feature |= ATAPI_PKT_DMA;
2513 } else {
2514 qc->tf.protocol = ATAPI_PROT_PIO;
2515 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2516 qc->tf.lbah = 0;
2518 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2520 qc->complete_fn = atapi_sense_complete;
2522 ata_qc_issue(qc);
2524 DPRINTK("EXIT\n");
2527 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2529 struct scsi_cmnd *cmd = qc->scsicmd;
2530 unsigned int err_mask = qc->err_mask;
2532 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2534 /* handle completion from new EH */
2535 if (unlikely(qc->ap->ops->error_handler &&
2536 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2538 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2539 ata_gen_passthru_sense(qc);
2542 /* SCSI EH automatically locks door if sdev->locked is
2543 * set. Sometimes door lock request continues to
2544 * fail, for example, when no media is present. This
2545 * creates a loop - SCSI EH issues door lock which
2546 * fails and gets invoked again to acquire sense data
2547 * for the failed command.
2549 * If door lock fails, always clear sdev->locked to
2550 * avoid this infinite loop.
2552 * This may happen before SCSI scan is complete. Make
2553 * sure qc->dev->sdev isn't NULL before dereferencing.
2555 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2556 qc->dev->sdev->locked = 0;
2558 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2559 qc->scsidone(cmd);
2560 ata_qc_free(qc);
2561 return;
2564 /* successful completion or old EH failure path */
2565 if (unlikely(err_mask & AC_ERR_DEV)) {
2566 cmd->result = SAM_STAT_CHECK_CONDITION;
2567 atapi_request_sense(qc);
2568 return;
2569 } else if (unlikely(err_mask)) {
2570 ata_gen_passthru_sense(qc);
2571 } else {
2572 u8 *scsicmd = cmd->cmnd;
2574 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2575 unsigned long flags;
2576 u8 *buf;
2578 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2580 /* ATAPI devices typically report zero for their SCSI version,
2581 * and sometimes deviate from the spec WRT response data
2582 * format. If SCSI version is reported as zero like normal,
2583 * then we make the following fixups: 1) Fake MMC-5 version,
2584 * to indicate to the Linux scsi midlayer this is a modern
2585 * device. 2) Ensure response data format / ATAPI information
2586 * are always correct.
2588 if (buf[2] == 0) {
2589 buf[2] = 0x5;
2590 buf[3] = 0x32;
2593 ata_scsi_rbuf_put(cmd, true, &flags);
2596 cmd->result = SAM_STAT_GOOD;
2599 qc->scsidone(cmd);
2600 ata_qc_free(qc);
2603 * atapi_xlat - Initialize PACKET taskfile
2604 * @qc: command structure to be initialized
2606 * LOCKING:
2607 * spin_lock_irqsave(host lock)
2609 * RETURNS:
2610 * Zero on success, non-zero on failure.
2612 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2614 struct scsi_cmnd *scmd = qc->scsicmd;
2615 struct ata_device *dev = qc->dev;
2616 int nodata = (scmd->sc_data_direction == DMA_NONE);
2617 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2618 unsigned int nbytes;
2620 memset(qc->cdb, 0, dev->cdb_len);
2621 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2623 qc->complete_fn = atapi_qc_complete;
2625 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2626 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2627 qc->tf.flags |= ATA_TFLAG_WRITE;
2628 DPRINTK("direction: write\n");
2631 qc->tf.command = ATA_CMD_PACKET;
2632 ata_qc_set_pc_nbytes(qc);
2634 /* check whether ATAPI DMA is safe */
2635 if (!nodata && !using_pio && atapi_check_dma(qc))
2636 using_pio = 1;
2638 /* Some controller variants snoop this value for Packet
2639 * transfers to do state machine and FIFO management. Thus we
2640 * want to set it properly, and for DMA where it is
2641 * effectively meaningless.
2643 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2645 /* Most ATAPI devices which honor transfer chunk size don't
2646 * behave according to the spec when odd chunk size which
2647 * matches the transfer length is specified. If the number of
2648 * bytes to transfer is 2n+1. According to the spec, what
2649 * should happen is to indicate that 2n+1 is going to be
2650 * transferred and transfer 2n+2 bytes where the last byte is
2651 * padding.
2653 * In practice, this doesn't happen. ATAPI devices first
2654 * indicate and transfer 2n bytes and then indicate and
2655 * transfer 2 bytes where the last byte is padding.
2657 * This inconsistency confuses several controllers which
2658 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2659 * These controllers use actual number of transferred bytes to
2660 * update DMA poitner and transfer of 4n+2 bytes make those
2661 * controller push DMA pointer by 4n+4 bytes because SATA data
2662 * FISes are aligned to 4 bytes. This causes data corruption
2663 * and buffer overrun.
2665 * Always setting nbytes to even number solves this problem
2666 * because then ATAPI devices don't have to split data at 2n
2667 * boundaries.
2669 if (nbytes & 0x1)
2670 nbytes++;
2672 qc->tf.lbam = (nbytes & 0xFF);
2673 qc->tf.lbah = (nbytes >> 8);
2675 if (nodata)
2676 qc->tf.protocol = ATAPI_PROT_NODATA;
2677 else if (using_pio)
2678 qc->tf.protocol = ATAPI_PROT_PIO;
2679 else {
2680 /* DMA data xfer */
2681 qc->tf.protocol = ATAPI_PROT_DMA;
2682 qc->tf.feature |= ATAPI_PKT_DMA;
2684 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2685 (scmd->sc_data_direction != DMA_TO_DEVICE))
2686 /* some SATA bridges need us to indicate data xfer direction */
2687 qc->tf.feature |= ATAPI_DMADIR;
2691 return 0;
2694 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2696 if (!sata_pmp_attached(ap)) {
2697 if (likely(devno < ata_link_max_devices(&ap->link)))
2698 return &ap->link.device[devno];
2699 } else {
2700 if (likely(devno < ap->nr_pmp_links))
2701 return &ap->pmp_link[devno].device[0];
2704 return NULL;
2707 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2708 const struct scsi_device *scsidev)
2710 int devno;
2712 /* skip commands not addressed to targets we simulate */
2713 if (!sata_pmp_attached(ap)) {
2714 if (unlikely(scsidev->channel || scsidev->lun))
2715 return NULL;
2716 devno = scsidev->id;
2717 } else {
2718 if (unlikely(scsidev->id || scsidev->lun))
2719 return NULL;
2720 devno = scsidev->channel;
2723 return ata_find_dev(ap, devno);
2727 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2728 * @ap: ATA port to which the device is attached
2729 * @scsidev: SCSI device from which we derive the ATA device
2731 * Given various information provided in struct scsi_cmnd,
2732 * map that onto an ATA bus, and using that mapping
2733 * determine which ata_device is associated with the
2734 * SCSI command to be sent.
2736 * LOCKING:
2737 * spin_lock_irqsave(host lock)
2739 * RETURNS:
2740 * Associated ATA device, or %NULL if not found.
2742 static struct ata_device *
2743 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2745 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2747 if (unlikely(!dev || !ata_dev_enabled(dev)))
2748 return NULL;
2750 return dev;
2754 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2755 * @byte1: Byte 1 from pass-thru CDB.
2757 * RETURNS:
2758 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2760 static u8
2761 ata_scsi_map_proto(u8 byte1)
2763 switch((byte1 & 0x1e) >> 1) {
2764 case 3: /* Non-data */
2765 return ATA_PROT_NODATA;
2767 case 6: /* DMA */
2768 case 10: /* UDMA Data-in */
2769 case 11: /* UDMA Data-Out */
2770 return ATA_PROT_DMA;
2772 case 4: /* PIO Data-in */
2773 case 5: /* PIO Data-out */
2774 return ATA_PROT_PIO;
2776 case 0: /* Hard Reset */
2777 case 1: /* SRST */
2778 case 8: /* Device Diagnostic */
2779 case 9: /* Device Reset */
2780 case 7: /* DMA Queued */
2781 case 12: /* FPDMA */
2782 case 15: /* Return Response Info */
2783 default: /* Reserved */
2784 break;
2787 return ATA_PROT_UNKNOWN;
2791 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2792 * @qc: command structure to be initialized
2794 * Handles either 12 or 16-byte versions of the CDB.
2796 * RETURNS:
2797 * Zero on success, non-zero on failure.
2799 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2801 struct ata_taskfile *tf = &(qc->tf);
2802 struct scsi_cmnd *scmd = qc->scsicmd;
2803 struct ata_device *dev = qc->dev;
2804 const u8 *cdb = scmd->cmnd;
2806 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2807 goto invalid_fld;
2810 * 12 and 16 byte CDBs use different offsets to
2811 * provide the various register values.
2813 if (cdb[0] == ATA_16) {
2815 * 16-byte CDB - may contain extended commands.
2817 * If that is the case, copy the upper byte register values.
2819 if (cdb[1] & 0x01) {
2820 tf->hob_feature = cdb[3];
2821 tf->hob_nsect = cdb[5];
2822 tf->hob_lbal = cdb[7];
2823 tf->hob_lbam = cdb[9];
2824 tf->hob_lbah = cdb[11];
2825 tf->flags |= ATA_TFLAG_LBA48;
2826 } else
2827 tf->flags &= ~ATA_TFLAG_LBA48;
2830 * Always copy low byte, device and command registers.
2832 tf->feature = cdb[4];
2833 tf->nsect = cdb[6];
2834 tf->lbal = cdb[8];
2835 tf->lbam = cdb[10];
2836 tf->lbah = cdb[12];
2837 tf->device = cdb[13];
2838 tf->command = cdb[14];
2839 } else {
2841 * 12-byte CDB - incapable of extended commands.
2843 tf->flags &= ~ATA_TFLAG_LBA48;
2845 tf->feature = cdb[3];
2846 tf->nsect = cdb[4];
2847 tf->lbal = cdb[5];
2848 tf->lbam = cdb[6];
2849 tf->lbah = cdb[7];
2850 tf->device = cdb[8];
2851 tf->command = cdb[9];
2854 /* enforce correct master/slave bit */
2855 tf->device = dev->devno ?
2856 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2858 /* READ/WRITE LONG use a non-standard sect_size */
2859 qc->sect_size = ATA_SECT_SIZE;
2860 switch (tf->command) {
2861 case ATA_CMD_READ_LONG:
2862 case ATA_CMD_READ_LONG_ONCE:
2863 case ATA_CMD_WRITE_LONG:
2864 case ATA_CMD_WRITE_LONG_ONCE:
2865 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2866 goto invalid_fld;
2867 qc->sect_size = scsi_bufflen(scmd);
2871 * Set flags so that all registers will be written, pass on
2872 * write indication (used for PIO/DMA setup), result TF is
2873 * copied back and we don't whine too much about its failure.
2875 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2876 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2877 tf->flags |= ATA_TFLAG_WRITE;
2879 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2882 * Set transfer length.
2884 * TODO: find out if we need to do more here to
2885 * cover scatter/gather case.
2887 ata_qc_set_pc_nbytes(qc);
2889 /* We may not issue DMA commands if no DMA mode is set */
2890 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2891 goto invalid_fld;
2893 /* sanity check for pio multi commands */
2894 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2895 goto invalid_fld;
2897 if (is_multi_taskfile(tf)) {
2898 unsigned int multi_count = 1 << (cdb[1] >> 5);
2900 /* compare the passed through multi_count
2901 * with the cached multi_count of libata
2903 if (multi_count != dev->multi_count)
2904 ata_dev_printk(dev, KERN_WARNING,
2905 "invalid multi_count %u ignored\n",
2906 multi_count);
2910 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2911 * SET_FEATURES - XFER MODE must be preceded/succeeded
2912 * by an update to hardware-specific registers for each
2913 * controller (i.e. the reason for ->set_piomode(),
2914 * ->set_dmamode(), and ->post_set_mode() hooks).
2916 if (tf->command == ATA_CMD_SET_FEATURES &&
2917 tf->feature == SETFEATURES_XFER)
2918 goto invalid_fld;
2921 * Filter TPM commands by default. These provide an
2922 * essentially uncontrolled encrypted "back door" between
2923 * applications and the disk. Set libata.allow_tpm=1 if you
2924 * have a real reason for wanting to use them. This ensures
2925 * that installed software cannot easily mess stuff up without
2926 * user intent. DVR type users will probably ship with this enabled
2927 * for movie content management.
2929 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2930 * for this and should do in future but that it is not sufficient as
2931 * DCS is an optional feature set. Thus we also do the software filter
2932 * so that we comply with the TC consortium stated goal that the user
2933 * can turn off TC features of their system.
2935 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2936 goto invalid_fld;
2938 return 0;
2940 invalid_fld:
2941 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2942 /* "Invalid field in cdb" */
2943 return 1;
2946 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
2948 struct ata_taskfile *tf = &qc->tf;
2949 struct scsi_cmnd *scmd = qc->scsicmd;
2950 struct ata_device *dev = qc->dev;
2951 const u8 *cdb = scmd->cmnd;
2952 u64 block;
2953 u32 n_block;
2954 u32 size;
2955 void *buf;
2957 /* we may not issue DMA commands if no DMA mode is set */
2958 if (unlikely(!dev->dma_mode))
2959 goto invalid_fld;
2961 if (unlikely(scmd->cmd_len < 16))
2962 goto invalid_fld;
2963 scsi_16_lba_len(cdb, &block, &n_block);
2965 /* for now we only support WRITE SAME with the unmap bit set */
2966 if (unlikely(!(cdb[1] & 0x8)))
2967 goto invalid_fld;
2970 * WRITE SAME always has a sector sized buffer as payload, this
2971 * should never be a multiple entry S/G list.
2973 if (!scsi_sg_count(scmd))
2974 goto invalid_fld;
2976 buf = page_address(sg_page(scsi_sglist(scmd)));
2977 size = ata_set_lba_range_entries(buf, 512, block, n_block);
2979 tf->protocol = ATA_PROT_DMA;
2980 tf->hob_feature = 0;
2981 tf->feature = ATA_DSM_TRIM;
2982 tf->hob_nsect = (size / 512) >> 8;
2983 tf->nsect = size / 512;
2984 tf->command = ATA_CMD_DSM;
2985 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
2986 ATA_TFLAG_WRITE;
2988 ata_qc_set_pc_nbytes(qc);
2990 return 0;
2992 invalid_fld:
2993 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2994 /* "Invalid field in cdb" */
2995 return 1;
2999 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3000 * @dev: ATA device
3001 * @cmd: SCSI command opcode to consider
3003 * Look up the SCSI command given, and determine whether the
3004 * SCSI command is to be translated or simulated.
3006 * RETURNS:
3007 * Pointer to translation function if possible, %NULL if not.
3010 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3012 switch (cmd) {
3013 case READ_6:
3014 case READ_10:
3015 case READ_16:
3017 case WRITE_6:
3018 case WRITE_10:
3019 case WRITE_16:
3020 return ata_scsi_rw_xlat;
3022 case WRITE_SAME_16:
3023 return ata_scsi_write_same_xlat;
3025 case SYNCHRONIZE_CACHE:
3026 if (ata_try_flush_cache(dev))
3027 return ata_scsi_flush_xlat;
3028 break;
3030 case VERIFY:
3031 case VERIFY_16:
3032 return ata_scsi_verify_xlat;
3034 case ATA_12:
3035 case ATA_16:
3036 return ata_scsi_pass_thru;
3038 case START_STOP:
3039 return ata_scsi_start_stop_xlat;
3042 return NULL;
3046 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
3047 * @ap: ATA port to which the command was being sent
3048 * @cmd: SCSI command to dump
3050 * Prints the contents of a SCSI command via printk().
3053 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
3054 struct scsi_cmnd *cmd)
3056 #ifdef ATA_DEBUG
3057 struct scsi_device *scsidev = cmd->device;
3058 u8 *scsicmd = cmd->cmnd;
3060 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
3061 ap->print_id,
3062 scsidev->channel, scsidev->id, scsidev->lun,
3063 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
3064 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
3065 scsicmd[8]);
3066 #endif
3069 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
3070 void (*done)(struct scsi_cmnd *),
3071 struct ata_device *dev)
3073 u8 scsi_op = scmd->cmnd[0];
3074 ata_xlat_func_t xlat_func;
3075 int rc = 0;
3077 if (dev->class == ATA_DEV_ATA) {
3078 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
3079 goto bad_cdb_len;
3081 xlat_func = ata_get_xlat_func(dev, scsi_op);
3082 } else {
3083 if (unlikely(!scmd->cmd_len))
3084 goto bad_cdb_len;
3086 xlat_func = NULL;
3087 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
3088 /* relay SCSI command to ATAPI device */
3089 int len = COMMAND_SIZE(scsi_op);
3090 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
3091 goto bad_cdb_len;
3093 xlat_func = atapi_xlat;
3094 } else {
3095 /* ATA_16 passthru, treat as an ATA command */
3096 if (unlikely(scmd->cmd_len > 16))
3097 goto bad_cdb_len;
3099 xlat_func = ata_get_xlat_func(dev, scsi_op);
3103 if (xlat_func)
3104 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
3105 else
3106 ata_scsi_simulate(dev, scmd, done);
3108 return rc;
3110 bad_cdb_len:
3111 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3112 scmd->cmd_len, scsi_op, dev->cdb_len);
3113 scmd->result = DID_ERROR << 16;
3114 done(scmd);
3115 return 0;
3119 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3120 * @cmd: SCSI command to be sent
3121 * @done: Completion function, called when command is complete
3123 * In some cases, this function translates SCSI commands into
3124 * ATA taskfiles, and queues the taskfiles to be sent to
3125 * hardware. In other cases, this function simulates a
3126 * SCSI device by evaluating and responding to certain
3127 * SCSI commands. This creates the overall effect of
3128 * ATA and ATAPI devices appearing as SCSI devices.
3130 * LOCKING:
3131 * Releases scsi-layer-held lock, and obtains host lock.
3133 * RETURNS:
3134 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3135 * 0 otherwise.
3137 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3139 struct ata_port *ap;
3140 struct ata_device *dev;
3141 struct scsi_device *scsidev = cmd->device;
3142 struct Scsi_Host *shost = scsidev->host;
3143 int rc = 0;
3145 ap = ata_shost_to_port(shost);
3147 spin_unlock(shost->host_lock);
3148 spin_lock(ap->lock);
3150 ata_scsi_dump_cdb(ap, cmd);
3152 dev = ata_scsi_find_dev(ap, scsidev);
3153 if (likely(dev))
3154 rc = __ata_scsi_queuecmd(cmd, done, dev);
3155 else {
3156 cmd->result = (DID_BAD_TARGET << 16);
3157 done(cmd);
3160 spin_unlock(ap->lock);
3161 spin_lock(shost->host_lock);
3162 return rc;
3166 * ata_scsi_simulate - simulate SCSI command on ATA device
3167 * @dev: the target device
3168 * @cmd: SCSI command being sent to device.
3169 * @done: SCSI command completion function.
3171 * Interprets and directly executes a select list of SCSI commands
3172 * that can be handled internally.
3174 * LOCKING:
3175 * spin_lock_irqsave(host lock)
3178 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3179 void (*done)(struct scsi_cmnd *))
3181 struct ata_scsi_args args;
3182 const u8 *scsicmd = cmd->cmnd;
3183 u8 tmp8;
3185 args.dev = dev;
3186 args.id = dev->id;
3187 args.cmd = cmd;
3188 args.done = done;
3190 switch(scsicmd[0]) {
3191 /* TODO: worth improving? */
3192 case FORMAT_UNIT:
3193 ata_scsi_invalid_field(cmd, done);
3194 break;
3196 case INQUIRY:
3197 if (scsicmd[1] & 2) /* is CmdDt set? */
3198 ata_scsi_invalid_field(cmd, done);
3199 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3200 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3201 else switch (scsicmd[2]) {
3202 case 0x00:
3203 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3204 break;
3205 case 0x80:
3206 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3207 break;
3208 case 0x83:
3209 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3210 break;
3211 case 0x89:
3212 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3213 break;
3214 case 0xb0:
3215 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
3216 break;
3217 case 0xb1:
3218 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3219 break;
3220 default:
3221 ata_scsi_invalid_field(cmd, done);
3222 break;
3224 break;
3226 case MODE_SENSE:
3227 case MODE_SENSE_10:
3228 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3229 break;
3231 case MODE_SELECT: /* unconditionally return */
3232 case MODE_SELECT_10: /* bad-field-in-cdb */
3233 ata_scsi_invalid_field(cmd, done);
3234 break;
3236 case READ_CAPACITY:
3237 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3238 break;
3240 case SERVICE_ACTION_IN:
3241 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3242 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3243 else
3244 ata_scsi_invalid_field(cmd, done);
3245 break;
3247 case REPORT_LUNS:
3248 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3249 break;
3251 case REQUEST_SENSE:
3252 ata_scsi_set_sense(cmd, 0, 0, 0);
3253 cmd->result = (DRIVER_SENSE << 24);
3254 done(cmd);
3255 break;
3257 /* if we reach this, then writeback caching is disabled,
3258 * turning this into a no-op.
3260 case SYNCHRONIZE_CACHE:
3261 /* fall through */
3263 /* no-op's, complete with success */
3264 case REZERO_UNIT:
3265 case SEEK_6:
3266 case SEEK_10:
3267 case TEST_UNIT_READY:
3268 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3269 break;
3271 case SEND_DIAGNOSTIC:
3272 tmp8 = scsicmd[1] & ~(1 << 3);
3273 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3274 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3275 else
3276 ata_scsi_invalid_field(cmd, done);
3277 break;
3279 /* all other commands */
3280 default:
3281 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3282 /* "Invalid command operation code" */
3283 done(cmd);
3284 break;
3288 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3290 int i, rc;
3292 for (i = 0; i < host->n_ports; i++) {
3293 struct ata_port *ap = host->ports[i];
3294 struct Scsi_Host *shost;
3296 rc = -ENOMEM;
3297 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3298 if (!shost)
3299 goto err_alloc;
3301 *(struct ata_port **)&shost->hostdata[0] = ap;
3302 ap->scsi_host = shost;
3304 shost->transportt = &ata_scsi_transport_template;
3305 shost->unique_id = ap->print_id;
3306 shost->max_id = 16;
3307 shost->max_lun = 1;
3308 shost->max_channel = 1;
3309 shost->max_cmd_len = 16;
3311 /* Schedule policy is determined by ->qc_defer()
3312 * callback and it needs to see every deferred qc.
3313 * Set host_blocked to 1 to prevent SCSI midlayer from
3314 * automatically deferring requests.
3316 shost->max_host_blocked = 1;
3318 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3319 if (rc)
3320 goto err_add;
3323 return 0;
3325 err_add:
3326 scsi_host_put(host->ports[i]->scsi_host);
3327 err_alloc:
3328 while (--i >= 0) {
3329 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3331 scsi_remove_host(shost);
3332 scsi_host_put(shost);
3334 return rc;
3337 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3339 int tries = 5;
3340 struct ata_device *last_failed_dev = NULL;
3341 struct ata_link *link;
3342 struct ata_device *dev;
3344 repeat:
3345 ata_for_each_link(link, ap, EDGE) {
3346 ata_for_each_dev(dev, link, ENABLED) {
3347 struct scsi_device *sdev;
3348 int channel = 0, id = 0;
3350 if (dev->sdev)
3351 continue;
3353 if (ata_is_host_link(link))
3354 id = dev->devno;
3355 else
3356 channel = link->pmp;
3358 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3359 NULL);
3360 if (!IS_ERR(sdev)) {
3361 dev->sdev = sdev;
3362 scsi_device_put(sdev);
3367 /* If we scanned while EH was in progress or allocation
3368 * failure occurred, scan would have failed silently. Check
3369 * whether all devices are attached.
3371 ata_for_each_link(link, ap, EDGE) {
3372 ata_for_each_dev(dev, link, ENABLED) {
3373 if (!dev->sdev)
3374 goto exit_loop;
3377 exit_loop:
3378 if (!link)
3379 return;
3381 /* we're missing some SCSI devices */
3382 if (sync) {
3383 /* If caller requested synchrnous scan && we've made
3384 * any progress, sleep briefly and repeat.
3386 if (dev != last_failed_dev) {
3387 msleep(100);
3388 last_failed_dev = dev;
3389 goto repeat;
3392 /* We might be failing to detect boot device, give it
3393 * a few more chances.
3395 if (--tries) {
3396 msleep(100);
3397 goto repeat;
3400 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3401 "failed without making any progress,\n"
3402 " switching to async\n");
3405 queue_delayed_work(system_long_wq, &ap->hotplug_task,
3406 round_jiffies_relative(HZ));
3410 * ata_scsi_offline_dev - offline attached SCSI device
3411 * @dev: ATA device to offline attached SCSI device for
3413 * This function is called from ata_eh_hotplug() and responsible
3414 * for taking the SCSI device attached to @dev offline. This
3415 * function is called with host lock which protects dev->sdev
3416 * against clearing.
3418 * LOCKING:
3419 * spin_lock_irqsave(host lock)
3421 * RETURNS:
3422 * 1 if attached SCSI device exists, 0 otherwise.
3424 int ata_scsi_offline_dev(struct ata_device *dev)
3426 if (dev->sdev) {
3427 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3428 return 1;
3430 return 0;
3434 * ata_scsi_remove_dev - remove attached SCSI device
3435 * @dev: ATA device to remove attached SCSI device for
3437 * This function is called from ata_eh_scsi_hotplug() and
3438 * responsible for removing the SCSI device attached to @dev.
3440 * LOCKING:
3441 * Kernel thread context (may sleep).
3443 static void ata_scsi_remove_dev(struct ata_device *dev)
3445 struct ata_port *ap = dev->link->ap;
3446 struct scsi_device *sdev;
3447 unsigned long flags;
3449 /* Alas, we need to grab scan_mutex to ensure SCSI device
3450 * state doesn't change underneath us and thus
3451 * scsi_device_get() always succeeds. The mutex locking can
3452 * be removed if there is __scsi_device_get() interface which
3453 * increments reference counts regardless of device state.
3455 mutex_lock(&ap->scsi_host->scan_mutex);
3456 spin_lock_irqsave(ap->lock, flags);
3458 /* clearing dev->sdev is protected by host lock */
3459 sdev = dev->sdev;
3460 dev->sdev = NULL;
3462 if (sdev) {
3463 /* If user initiated unplug races with us, sdev can go
3464 * away underneath us after the host lock and
3465 * scan_mutex are released. Hold onto it.
3467 if (scsi_device_get(sdev) == 0) {
3468 /* The following ensures the attached sdev is
3469 * offline on return from ata_scsi_offline_dev()
3470 * regardless it wins or loses the race
3471 * against this function.
3473 scsi_device_set_state(sdev, SDEV_OFFLINE);
3474 } else {
3475 WARN_ON(1);
3476 sdev = NULL;
3480 spin_unlock_irqrestore(ap->lock, flags);
3481 mutex_unlock(&ap->scsi_host->scan_mutex);
3483 if (sdev) {
3484 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3485 dev_name(&sdev->sdev_gendev));
3487 scsi_remove_device(sdev);
3488 scsi_device_put(sdev);
3492 static void ata_scsi_handle_link_detach(struct ata_link *link)
3494 struct ata_port *ap = link->ap;
3495 struct ata_device *dev;
3497 ata_for_each_dev(dev, link, ALL) {
3498 unsigned long flags;
3500 if (!(dev->flags & ATA_DFLAG_DETACHED))
3501 continue;
3503 spin_lock_irqsave(ap->lock, flags);
3504 dev->flags &= ~ATA_DFLAG_DETACHED;
3505 spin_unlock_irqrestore(ap->lock, flags);
3507 ata_scsi_remove_dev(dev);
3512 * ata_scsi_media_change_notify - send media change event
3513 * @dev: Pointer to the disk device with media change event
3515 * Tell the block layer to send a media change notification
3516 * event.
3518 * LOCKING:
3519 * spin_lock_irqsave(host lock)
3521 void ata_scsi_media_change_notify(struct ata_device *dev)
3523 if (dev->sdev)
3524 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3525 GFP_ATOMIC);
3529 * ata_scsi_hotplug - SCSI part of hotplug
3530 * @work: Pointer to ATA port to perform SCSI hotplug on
3532 * Perform SCSI part of hotplug. It's executed from a separate
3533 * workqueue after EH completes. This is necessary because SCSI
3534 * hot plugging requires working EH and hot unplugging is
3535 * synchronized with hot plugging with a mutex.
3537 * LOCKING:
3538 * Kernel thread context (may sleep).
3540 void ata_scsi_hotplug(struct work_struct *work)
3542 struct ata_port *ap =
3543 container_of(work, struct ata_port, hotplug_task.work);
3544 int i;
3546 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3547 DPRINTK("ENTER/EXIT - unloading\n");
3548 return;
3551 DPRINTK("ENTER\n");
3552 mutex_lock(&ap->scsi_scan_mutex);
3554 /* Unplug detached devices. We cannot use link iterator here
3555 * because PMP links have to be scanned even if PMP is
3556 * currently not attached. Iterate manually.
3558 ata_scsi_handle_link_detach(&ap->link);
3559 if (ap->pmp_link)
3560 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3561 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3563 /* scan for new ones */
3564 ata_scsi_scan_host(ap, 0);
3566 mutex_unlock(&ap->scsi_scan_mutex);
3567 DPRINTK("EXIT\n");
3571 * ata_scsi_user_scan - indication for user-initiated bus scan
3572 * @shost: SCSI host to scan
3573 * @channel: Channel to scan
3574 * @id: ID to scan
3575 * @lun: LUN to scan
3577 * This function is called when user explicitly requests bus
3578 * scan. Set probe pending flag and invoke EH.
3580 * LOCKING:
3581 * SCSI layer (we don't care)
3583 * RETURNS:
3584 * Zero.
3586 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3587 unsigned int id, unsigned int lun)
3589 struct ata_port *ap = ata_shost_to_port(shost);
3590 unsigned long flags;
3591 int devno, rc = 0;
3593 if (!ap->ops->error_handler)
3594 return -EOPNOTSUPP;
3596 if (lun != SCAN_WILD_CARD && lun)
3597 return -EINVAL;
3599 if (!sata_pmp_attached(ap)) {
3600 if (channel != SCAN_WILD_CARD && channel)
3601 return -EINVAL;
3602 devno = id;
3603 } else {
3604 if (id != SCAN_WILD_CARD && id)
3605 return -EINVAL;
3606 devno = channel;
3609 spin_lock_irqsave(ap->lock, flags);
3611 if (devno == SCAN_WILD_CARD) {
3612 struct ata_link *link;
3614 ata_for_each_link(link, ap, EDGE) {
3615 struct ata_eh_info *ehi = &link->eh_info;
3616 ehi->probe_mask |= ATA_ALL_DEVICES;
3617 ehi->action |= ATA_EH_RESET;
3619 } else {
3620 struct ata_device *dev = ata_find_dev(ap, devno);
3622 if (dev) {
3623 struct ata_eh_info *ehi = &dev->link->eh_info;
3624 ehi->probe_mask |= 1 << dev->devno;
3625 ehi->action |= ATA_EH_RESET;
3626 } else
3627 rc = -EINVAL;
3630 if (rc == 0) {
3631 ata_port_schedule_eh(ap);
3632 spin_unlock_irqrestore(ap->lock, flags);
3633 ata_port_wait_eh(ap);
3634 } else
3635 spin_unlock_irqrestore(ap->lock, flags);
3637 return rc;
3641 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3642 * @work: Pointer to ATA port to perform scsi_rescan_device()
3644 * After ATA pass thru (SAT) commands are executed successfully,
3645 * libata need to propagate the changes to SCSI layer.
3647 * LOCKING:
3648 * Kernel thread context (may sleep).
3650 void ata_scsi_dev_rescan(struct work_struct *work)
3652 struct ata_port *ap =
3653 container_of(work, struct ata_port, scsi_rescan_task);
3654 struct ata_link *link;
3655 struct ata_device *dev;
3656 unsigned long flags;
3658 mutex_lock(&ap->scsi_scan_mutex);
3659 spin_lock_irqsave(ap->lock, flags);
3661 ata_for_each_link(link, ap, EDGE) {
3662 ata_for_each_dev(dev, link, ENABLED) {
3663 struct scsi_device *sdev = dev->sdev;
3665 if (!sdev)
3666 continue;
3667 if (scsi_device_get(sdev))
3668 continue;
3670 spin_unlock_irqrestore(ap->lock, flags);
3671 scsi_rescan_device(&(sdev->sdev_gendev));
3672 scsi_device_put(sdev);
3673 spin_lock_irqsave(ap->lock, flags);
3677 spin_unlock_irqrestore(ap->lock, flags);
3678 mutex_unlock(&ap->scsi_scan_mutex);
3682 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3683 * @host: ATA host container for all SAS ports
3684 * @port_info: Information from low-level host driver
3685 * @shost: SCSI host that the scsi device is attached to
3687 * LOCKING:
3688 * PCI/etc. bus probe sem.
3690 * RETURNS:
3691 * ata_port pointer on success / NULL on failure.
3694 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3695 struct ata_port_info *port_info,
3696 struct Scsi_Host *shost)
3698 struct ata_port *ap;
3700 ap = ata_port_alloc(host);
3701 if (!ap)
3702 return NULL;
3704 ap->port_no = 0;
3705 ap->lock = shost->host_lock;
3706 ap->pio_mask = port_info->pio_mask;
3707 ap->mwdma_mask = port_info->mwdma_mask;
3708 ap->udma_mask = port_info->udma_mask;
3709 ap->flags |= port_info->flags;
3710 ap->ops = port_info->port_ops;
3711 ap->cbl = ATA_CBL_SATA;
3713 return ap;
3715 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3718 * ata_sas_port_start - Set port up for dma.
3719 * @ap: Port to initialize
3721 * Called just after data structures for each port are
3722 * initialized.
3724 * May be used as the port_start() entry in ata_port_operations.
3726 * LOCKING:
3727 * Inherited from caller.
3729 int ata_sas_port_start(struct ata_port *ap)
3731 return 0;
3733 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3736 * ata_port_stop - Undo ata_sas_port_start()
3737 * @ap: Port to shut down
3739 * May be used as the port_stop() entry in ata_port_operations.
3741 * LOCKING:
3742 * Inherited from caller.
3745 void ata_sas_port_stop(struct ata_port *ap)
3748 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3751 * ata_sas_port_init - Initialize a SATA device
3752 * @ap: SATA port to initialize
3754 * LOCKING:
3755 * PCI/etc. bus probe sem.
3757 * RETURNS:
3758 * Zero on success, non-zero on error.
3761 int ata_sas_port_init(struct ata_port *ap)
3763 int rc = ap->ops->port_start(ap);
3765 if (!rc) {
3766 ap->print_id = ata_print_id++;
3767 rc = ata_bus_probe(ap);
3770 return rc;
3772 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3775 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3776 * @ap: SATA port to destroy
3780 void ata_sas_port_destroy(struct ata_port *ap)
3782 if (ap->ops->port_stop)
3783 ap->ops->port_stop(ap);
3784 kfree(ap);
3786 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3789 * ata_sas_slave_configure - Default slave_config routine for libata devices
3790 * @sdev: SCSI device to configure
3791 * @ap: ATA port to which SCSI device is attached
3793 * RETURNS:
3794 * Zero.
3797 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3799 ata_scsi_sdev_config(sdev);
3800 ata_scsi_dev_config(sdev, ap->link.device);
3801 return 0;
3803 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3806 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3807 * @cmd: SCSI command to be sent
3808 * @done: Completion function, called when command is complete
3809 * @ap: ATA port to which the command is being sent
3811 * RETURNS:
3812 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3813 * 0 otherwise.
3816 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3817 struct ata_port *ap)
3819 int rc = 0;
3821 ata_scsi_dump_cdb(ap, cmd);
3823 if (likely(ata_dev_enabled(ap->link.device)))
3824 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3825 else {
3826 cmd->result = (DID_BAD_TARGET << 16);
3827 done(cmd);
3829 return rc;
3831 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);